![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to mandoc.1 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc|
Return to mandoc.1 CVS log | Up to [cvsweb.bsd.lv] / mandoc |
| version 1.19, 2009/06/15 09:35:16 | version 1.22, 2009/06/22 12:04:05 | ||
|---|---|---|---|
|
|
||
| .Pp | .Pp | ||
| .Ex -std mandoc | .Ex -std mandoc | ||
| .\" SUB-SECTION | .\" SUB-SECTION | ||
| .Ss Punctuation | .Ss Punctuation and Spacing | ||
| If punctuation is set apart from words, such as in the phrase | If punctuation is set apart from words, such as in the phrase | ||
| .Dq to be \&, or not to be , | .Dq to be \&, or not to be , | ||
| it's processed by | it's processed by | ||
| .Nm | .Nm | ||
| according to the following rules. Opening punctuation | according to the following rules: opening punctuation | ||
| .Po | .Po | ||
| .Sq \&( , | .Sq \&( , | ||
| .Sq \&[ , | .Sq \&[ , | ||
| and | and | ||
| .Sq \&{ | .Sq \&{ | ||
| .Pc | .Pc | ||
| is not followed by a space. Closing punctuation | is not followed by a space; closing punctuation | ||
| .Po | .Po | ||
| .Sq \&. , | .Sq \&. , | ||
| .Sq \&, , | .Sq \&, , | ||
|
|
||
| If the input is | If the input is | ||
| .Xr mdoc 7 , | .Xr mdoc 7 , | ||
| these rules are also applied to macro arguments when appropriate. | these rules are also applied to macro arguments when appropriate. | ||
| .Pp | |||
| White-space, in non-literal (normal) mode, is stripped from input and | |||
| replaced on output by a single space. Thus, if you wish to preserve | |||
| multiple spaces, they must be space-escaped | |||
| .Sq \e\ . | |||
| or used in a literal display mode, e.g., | |||
| .Sq \&.Bd \-literal | |||
| in | |||
| .Xr mdoc 7 . | |||
| .\" SUB-SECTION | .\" SUB-SECTION | ||
| .Ss Input Formats | .Ss Input Formats | ||
| The | The | ||
|
|
||
| When rewinding the scope of a block macro, forces the compiler to ignore | When rewinding the scope of a block macro, forces the compiler to ignore | ||
| scope violations. This can seriously mangle the resulting tree. | scope violations. This can seriously mangle the resulting tree. | ||
| .Pq mdoc only | .Pq mdoc only | ||
| .It Fl f Ns Ar ign-escape | .It Fl f Ns Ar no-ign-escape | ||
| Ignore invalid escape sequences. | Don't ignore invalid escape sequences. | ||
| .It Fl f Ns Ar ign-macro | |||
| Ignore unknown macros at the start of input lines (default for | |||
| .Xr man 7 | |||
| parsing). | |||
| .It Fl f Ns Ar no-ign-macro | .It Fl f Ns Ar no-ign-macro | ||
| Do not ignore unknown macros at the start of input lines (default for | Do not ignore unknown macros at the start of input lines. | ||
| .Xr mdoc 7 | .It Fl f Ns Ar no-ign-chars | ||
| parsing). | Do not ignore disallowed characters. | ||
| .It Fl f Ns Ar strict | |||
| Implies | |||
| .Fl f Ns Ar no-ign-escape , | |||
| .Fl f Ns Ar no-ign-macro | |||
| and | |||
| .Fl f Ns Ar no-ign-chars . | |||
| .El | .El | ||
| .\" PARAGRAPH | .\" PARAGRAPH | ||
| .Pp | .Pp | ||
|
|
||
| flag, multiple | flag, multiple | ||
| .Fl f | .Fl f | ||
| options may be grouped and delimited with a comma. Using | options may be grouped and delimited with a comma. Using | ||
| .Fl f Ns Ar ign-scope,ign-escape , | .Fl f Ns Ar ign-scope,no-ign-escape , | ||
| for example, will try to ignore scope and character-escape errors. | for example, will try to ignore scope and not ignore character-escape | ||
| errors. | |||
| .\" SECTION | .\" SECTION | ||
| .Sh EXAMPLES | .Sh EXAMPLES | ||
| To page manuals to the terminal: | To page manuals to the terminal: | ||
| .\" PARAGRAPH | .\" PARAGRAPH | ||
| .Pp | .Pp | ||
| .D1 % mandoc \-Wall,error mandoc.1 2>&1 | less | .D1 % mandoc \-Wall,error \-fstrict mandoc.1 2>&1 | less | ||
| .Pp | |||
| .D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less | .D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less | ||
| .\" SECTION | .\" SECTION | ||
| .Sh COMPATIBILITY | |||
| This section summarises | |||
| .Nm | |||
| compatibility with | |||
| .Xr groff 1 . | |||
| .Pp | |||
| .Bl -bullet -compact | |||
| .It | |||
| A list or display following | |||
| .Sq \&.Ss | |||
| does not assert a prior vertical break, just as it doesn't with | |||
| .Sq \&.Sh . | |||
| .It | |||
| The \-literal and \-unfilled | |||
| .Sq \&.Bd | |||
| displays types are synonyms, as are \-filled and \-ragged. | |||
| .It | |||
| Words aren't hyphenated. | |||
| .It | |||
| In normal mode (not a literal block), blocks of spaces aren't preserved, | |||
| so double spaces following sentence closure | |||
| .Pq Qq French spacing | |||
| are reduced to a single space. | |||
| .El | |||
| .\" SECTION | |||
| .Sh SEE ALSO | .Sh SEE ALSO | ||
| .Xr mandoc_char 7 , | .Xr mandoc_char 7 , | ||
| .Xr mdoc 7 , | .Xr mdoc 7 , | ||
| .Xr man 7 | .Xr man 7 | ||
| .\" | .\" SECTION | ||
| .Sh AUTHORS | .Sh AUTHORS | ||
| The | The | ||
| .Nm | .Nm | ||
|
|
||
| .Sh CAVEATS | .Sh CAVEATS | ||
| The | The | ||
| .Nm | .Nm | ||
| utility in | utility doesn't yet know how to display \-hang lists. | ||
| .Fl T Ns Ar ascii | |||
| mode doesn't yet know how to display the following: | |||
| .Pp | .Pp | ||
| .Bl -bullet -compact | |||
| .It | |||
| The \-hang | |||
| .Sq \&.Bl | |||
| list is not yet supported. | |||
| .El | |||
| .Pp | |||
| Other macros still aren't supported by virtue of nobody complaining | Other macros still aren't supported by virtue of nobody complaining | ||
| about their absence. Please report any omissions: this is a work in | about their absence. | ||
| progress. | |||
| .Pp | |||
| The following list documents differences between traditional | |||
| .Xr nroff 1 | |||
| output and | |||
| .Nm : | |||
| .Pp | |||
| .Bl -bullet -compact | |||
| .It | |||
| A list of display following | |||
| .Sq \&.Ss | |||
| does not assert a prior vertical break, just as it doesn't with | |||
| .Sq \&.Sh . | |||
| .It | |||
| Special characters don't follow the current font style. | |||
| .\" LIST-ITEM | |||
| .It | |||
| The \-literal and \-unfilled | |||
| .Sq \&.Bd | |||
| displays types are synonyms, as are \-filled and \-ragged. | |||
| .El |