Keep up with recent mdoc(7) changes, that include:

- If no .Os call is made, don't print the OS info at all.
- Allow for multiple .Lb calls in the LIBRARY section.
- Improved documentation on punctuation characters.
This commit is contained in:
Ruslan Ermilov 2003-09-20 21:13:43 +00:00
parent 700a09db9e
commit cd060126ad
4 changed files with 57 additions and 11 deletions

View File

@ -339,12 +339,18 @@
.. ..
. .
. .
.\" NS doc-operating-system global string .\" NS doc-default-operating-system global string
.\" NS the exact version of the operating system .\" NS the exact (default) version of the operating system
.\" NS .\" NS
.\" NS override this in `mdoc.local', if necessary .\" NS override this in `mdoc.local', if necessary
. .
.ds doc-operating-system BSD .ds doc-default-operating-system BSD
.
.
.\" NS doc-operating-system global string
.\" NS the exact version of the operating system
.
.ds doc-operating-system
. .
. .
.\" NS Os user macro (not parsed, not callable) .\" NS Os user macro (not parsed, not callable)
@ -434,10 +440,9 @@
.ds doc-operating-system-FreeBSD-5.0 5.0 .ds doc-operating-system-FreeBSD-5.0 5.0
. .
.de Os .de Os
. if "\$1"" \ . ie "\$1"" \
. return . ds doc-operating-system "\*[doc-default-operating-system]
. . el \{ .ie "\$1"ATT" \{\
. ie "\$1"ATT" \{\
. ds doc-operating-system AT&T . ds doc-operating-system AT&T
. if \A\$2 \{\ . if \A\$2 \{\
. ie d doc-operating-system-ATT-\$2 \ . ie d doc-operating-system-ATT-\$2 \
@ -472,7 +477,7 @@
. ds doc-operating-system \$1 . ds doc-operating-system \$1
. if !"\$2"" \ . if !"\$2"" \
. as doc-operating-system " \$2 . as doc-operating-system " \$2
. \}\}\}\} . \}\}\}\}\}
.. ..
. .
. .
@ -696,6 +701,12 @@
.nr doc-in-synopsis-section 0 .nr doc-in-synopsis-section 0
. .
. .
.\" NS doc-in-library-section global register (bool)
.\" NS whether we are in the `library' section
.
.nr doc-in-library-section 0
.
.
.\" NS doc-in-see-also-section global register (bool) .\" NS doc-in-see-also-section global register (bool)
.\" NS whether we are in the `see also' section .\" NS whether we are in the `see also' section
. .
@ -733,6 +744,7 @@
.\" NS doc-func-count .\" NS doc-func-count
.\" NS doc-in-authors-section .\" NS doc-in-authors-section
.\" NS doc-in-files-section .\" NS doc-in-files-section
.\" NS doc-in-library-section
.\" NS doc-in-see-also-section .\" NS doc-in-see-also-section
.\" NS doc-in-synopsis-section .\" NS doc-in-synopsis-section
.\" NS doc-indent-synopsis .\" NS doc-indent-synopsis
@ -749,6 +761,7 @@
. .
.ds doc-section-name NAME .ds doc-section-name NAME
.ds doc-section-synopsis SYNOPSIS .ds doc-section-synopsis SYNOPSIS
.ds doc-section-library LIBRARY
.ds doc-section-description DESCRIPTION .ds doc-section-description DESCRIPTION
.ds doc-section-see-also SEE .ds doc-section-see-also SEE
.ds doc-section-files FILES .ds doc-section-files FILES
@ -795,6 +808,7 @@
. \} . \}
. el \{\ . el \{\
. nr doc-in-synopsis-section 0 . nr doc-in-synopsis-section 0
. nr doc-in-library-section 0
. nr doc-in-see-also-section 0 . nr doc-in-see-also-section 0
. nr doc-in-files-section 0 . nr doc-in-files-section 0
. nr doc-in-authors-section 0 . nr doc-in-authors-section 0
@ -806,6 +820,9 @@
. nr doc-indent-synopsis 0 . nr doc-indent-synopsis 0
. nr doc-indent-synopsis-active 0 . nr doc-indent-synopsis-active 0
. \} . \}
. el \{ .ie "\*[doc-str-dfp]"\*[doc-section-library]" \{\
. nr doc-in-library-section 1
. \}
. el \{ .ie "\*[doc-str-dfp]"\*[doc-section-description]" \{\ . el \{ .ie "\*[doc-str-dfp]"\*[doc-section-description]" \{\
. nr doc-is-func 0 . nr doc-is-func 0
. nr doc-func-count 0 . nr doc-func-count 0
@ -821,7 +838,7 @@
. nr doc-in-files-section 1 . nr doc-in-files-section 1
. el .if "\*[doc-str-dfp]"\*[doc-section-authors]" \ . el .if "\*[doc-str-dfp]"\*[doc-section-authors]" \
. nr doc-in-authors-section 1 . nr doc-in-authors-section 1
. \}\}\} . \}\}\}\}
. .
. in 0 . in 0
. nr doc-have-author 0 . nr doc-have-author 0
@ -1058,6 +1075,7 @@
. tm doc-display-vertical == \n[doc-display-vertical] . tm doc-display-vertical == \n[doc-display-vertical]
. tm doc-header-string == `\*[doc-header-string]' . tm doc-header-string == `\*[doc-header-string]'
. tm doc-in-synopsis-section == \n[doc-in-synopsis-section] . tm doc-in-synopsis-section == \n[doc-in-synopsis-section]
. tm doc-in-library-section == \n[doc-in-library-section]
. tm doc-in-see-also-section == \n[doc-in-see-also-section] . tm doc-in-see-also-section == \n[doc-in-see-also-section]
. tm doc-in-files-section == \n[doc-in-files-section] . tm doc-in-files-section == \n[doc-in-files-section]
. tm doc-in-authors-section == \n[doc-in-authors-section] . tm doc-in-authors-section == \n[doc-in-authors-section]

View File

@ -716,7 +716,11 @@
. \" replacing argument with result . \" replacing argument with result
. ds doc-arg\n[doc-arg-ptr] "\*[doc-str-Lb] . ds doc-arg\n[doc-arg-ptr] "\*[doc-str-Lb]
. .
. if \n[doc-in-library-section] \
. br
. doc-print-recursive . doc-print-recursive
. if \n[doc-in-library-section] \
. br
. \} . \}
. el \{\ . el \{\
. tm Usage: .Lb library_name ... (#\n[.c]) . tm Usage: .Lb library_name ... (#\n[.c])

View File

@ -3321,6 +3321,7 @@
. nr doc-curr-font-saved \n[doc-curr-font] . nr doc-curr-font-saved \n[doc-curr-font]
. nr doc-curr-size-saved \n[doc-curr-size] . nr doc-curr-size-saved \n[doc-curr-size]
. nr doc-in-synopsis-section-saved \n[doc-in-synopsis-section] . nr doc-in-synopsis-section-saved \n[doc-in-synopsis-section]
. nr doc-in-library-section-saved \n[doc-in-library-section]
. nr doc-indent-synopsis-saved \n[doc-indent-synopsis] . nr doc-indent-synopsis-saved \n[doc-indent-synopsis]
. nr doc-indent-synopsis-active-saved \n[doc-indent-synopsis-active] . nr doc-indent-synopsis-active-saved \n[doc-indent-synopsis-active]
. nr doc-have-decl-saved \n[doc-have-decl] . nr doc-have-decl-saved \n[doc-have-decl]
@ -3460,6 +3461,7 @@
. nr doc-curr-font \n[doc-curr-font-saved] . nr doc-curr-font \n[doc-curr-font-saved]
. nr doc-curr-size \n[doc-curr-size-saved] . nr doc-curr-size \n[doc-curr-size-saved]
. nr doc-in-synopsis-section \n[doc-in-synopsis-section-saved] . nr doc-in-synopsis-section \n[doc-in-synopsis-section-saved]
. nr doc-in-library-section \n[doc-in-library-section-saved]
. nr doc-indent-synopsis \n[doc-indent-synopsis-saved] . nr doc-indent-synopsis \n[doc-indent-synopsis-saved]
. nr doc-indent-synopsis-active \n[doc-indent-synopsis-active-saved] . nr doc-indent-synopsis-active \n[doc-indent-synopsis-active-saved]
. nr doc-have-decl \n[doc-have-decl-saved] . nr doc-have-decl \n[doc-have-decl-saved]
@ -5164,11 +5166,14 @@
.\" NS doc-issue-count .\" NS doc-issue-count
.\" NS doc-issue-name .\" NS doc-issue-name
.\" NS doc-journal-count .\" NS doc-journal-count
.\" NS doc-journam-name .\" NS doc-journal-name
.\" NS doc-optional-count .\" NS doc-optional-count
.\" NS doc-optional-string .\" NS doc-optional-string
.\" NS doc-page-number-count .\" NS doc-page-number-count
.\" NS doc-page-number-string .\" NS doc-page-number-string
.\" NS doc-publisher-count
.\" NS doc-publisher-name
.\" NS doc-reference-count
.\" NS doc-reference-title-count .\" NS doc-reference-title-count
.\" NS doc-reference-title-name .\" NS doc-reference-title-name
.\" NS doc-reference-title-name-for-book .\" NS doc-reference-title-name-for-book
@ -5192,6 +5197,8 @@
. nr doc-date-count 0 . nr doc-date-count 0
. nr doc-page-number-count 0 . nr doc-page-number-count 0
. nr doc-book-count 0 . nr doc-book-count 0
. nr doc-publisher-count 0
. nr doc-reference-count 0
. .
. ds doc-journal-name . ds doc-journal-name
. ds doc-issue-name . ds doc-issue-name
@ -5204,6 +5211,7 @@
. ds doc-date . ds doc-date
. ds doc-page-number-string . ds doc-page-number-string
. ds doc-book-name . ds doc-book-name
. ds doc-publisher-name
.. ..
. .
. .

View File

@ -786,7 +786,7 @@ In the following examples, the left (which is identical to the right) and
the middle part of the manual page header strings are shown. the middle part of the manual page header strings are shown.
Note how Note how
.Ql \e& .Ql \e&
prevents the digit\~1 from being a valid numeric expression. prevents the digit\~7 from being a valid numeric expression.
. .
.Bd -ragged .Bd -ragged
.Bl -tag -width ".Li .Dt\ FOO\ 2\ i386" -compact -offset indent .Bl -tag -width ".Li .Dt\ FOO\ 2\ i386" -compact -offset indent
@ -1108,6 +1108,15 @@ distinguishing it from the argument strings.
To remove the special meaning from a punctuation character escape it with To remove the special meaning from a punctuation character escape it with
.Ql \e& . .Ql \e& .
.Pp .Pp
The following punctuation characters are recognized by
.Nm \-mdoc :
.
.Bl -column -offset indent-two XXXXXX XXXXXX XXXXXX XXXXXX
.It Li .\& Ta Li ,\& Ta Li :\& Ta Li ;\& Ta Li (\&
.It Li )\& Ta Li [\& Ta Li ]\& Ta Li ?\& Ta Li !\&
.El
.Pp
.
.Xr Troff .Xr Troff
is limited as a macro language, and has difficulty when presented with a is limited as a macro language, and has difficulty when presented with a
string containing a member of the mathematical, logical or quotation set: string containing a member of the mathematical, logical or quotation set:
@ -1693,6 +1702,13 @@ look for strings named
then denotes the keyword to be used with the then denotes the keyword to be used with the
.Ql .Lb .Ql .Lb
macro. macro.
.Pp
In the
.Sx LIBRARY
section an
.Ql .Lb
command causes a line break before and after its arguments are printed.
.Pp
. .
.Ss Literals .Ss Literals
. .