diff options
Diffstat (limited to 'contrib/groff/tmac/groff_man.man')
| -rw-r--r-- | contrib/groff/tmac/groff_man.man | 370 |
1 files changed, 320 insertions, 50 deletions
diff --git a/contrib/groff/tmac/groff_man.man b/contrib/groff/tmac/groff_man.man index 57eb9ec..14bd3b0 100644 --- a/contrib/groff/tmac/groff_man.man +++ b/contrib/groff/tmac/groff_man.man @@ -1,9 +1,34 @@ +.ig \"-*- nroff -*- +Copyright (C) 1999-2000 Free Software Foundation, Inc. + +Permission is granted to make and distribute verbatim copies of +this manual provided the copyright notice and this permission notice +are preserved on all copies. + +Permission is granted to copy and distribute modified versions of this +manual under the conditions for verbatim copying, provided that the +entire resulting derived work is distributed under the terms of a +permission notice identical to this one. + +Permission is granted to copy and distribute translations of this +manual into another language, under the above conditions for modified +versions, except that this permission notice may be included in +translations approved by the Free Software Foundation instead of in +the original English. +.. +.de TQ +.br +.ns +.TP \\$1 +.. .TH GROFF_MAN @MAN7EXT@ "@MDATE@" "Groff Version @VERSION@" . .SH NAME . -groff_man \- groff `an' macros to support generation of man pages +groff_man \- groff `man' macros to support generation of man pages +. .SH SYNOPSIS +. .B groff .B \-m@TMAC_AN_PREFIX@an [ @@ -16,14 +41,60 @@ groff_man \- groff `an' macros to support generation of man pages .SH DESCRIPTION . The -.B tmac.an +.B tmac.@TMAC_AN_PREFIX@an macros used to generate man pages with .I groff were written by James Clark. This document provides a brief summary of the use of each macro in that package. +. +.SH OPTIONS +. +The +.B man +macros understand the following command line options (which define various +registers). +.TP +.B \-rC1 +If more than one manual page is given on the command line, number the +pages continuously, rather than starting each at\ 1. +.TP +.B \-rD1 +Double-sided printing. +Footers for even and odd pages are formatted differently. +.TP +.BI \-rP nnn +Enumeration of pages will start with +.I nnn +rather than with\ 1. +.TP +.BI \-rS xx +Base document font size is +.I xx +points +.RI ( xx +can be 10, 11, or\ 12) rather than 10\ points. .TP -.BI .TP " title section " [ extra1 "] [" extra2 "] [" extra3 ] +.BI \-rX nnn +After page\ \c +.IR nnn , +number pages as +.IR nnn a, +.IR nnn b, +.IR nnn c, +etc. +For example, the option `\-rX2' will produce the following page numbers: +1, 2, 2a, 2b, 2c, etc. +. +.SH USAGE +. +This section describes the available macros for manual pages. +For further customization, put additional macros and requests into the file +.B man.local +which will be loaded immediately after +.BR tmac.@TMAC_AN_PREFIX@an . +.TP +.BI .TH " title section " [ extra1 "] [" extra2 "] [" extra3 ] Sets the title of the man page to .I title and the section to @@ -33,22 +104,60 @@ The value .I section may also have a string appended, e.g. `.pm', to indicate a specific subsection of the man pages. +Both +.I title +and +.I section +are positioned at the left and right in the header line (with +.I section +in parentheses immediately appended to +.IR title . +.I extra1 +will be positioned in the middle of the footer line. +.I extra2 +will be positioned at the left in the footer line (resp. at the left on +even pages and at the right on odd pages if double-sided printing is +active). +.I extra3 +is centered in the header line. +.IP +For HTML output, headers and footers are completely supressed. +.IP +Additionally, this macro starts a new page; the new line number is\ 1 again +(except if the `-rC1' option is given on the command line) -- this feature +is intended only for formatting multiple man pages; a single man page should +contain exactly one +.B TH +macro at the beginning of the file. .TP -.BI .SH " text for a heading" -Sets up an unindented and unnumbered section heading. -Prints out all the text following `.SH' up to the end of the line in bold -face, with a size slightly smaller than that for indented section headings. +.BI ".SH [" "text for a heading" ] +Sets up an unnumbered section heading sticking out to the left. +Prints out all the text following +.B SH +up to the end of the line (resp. the text in the next line if there is no +argument to +.BR SH ) +in bold face, one size larger than the base document size. +Additionally, the left margin for the following text is reset to its default +value. .TP -.BI .SS " text for a heading" -Sets up an indented section heading. -Prints out all the text following `.SS' up to the end of the line in bold -face, with a size slightly larger than that for unindented section headings. +.BI ".SS [" "text for a heading" ] +Sets up an secondary, unnumbered section heading. +Prints out all the text following +.B SS +up to the end of the line (resp. the text in the next line if there is no +argument to +.BR SS ) +in bold face, at the same size as the base document size. +Additionally, the left margin for the following text is reset to its default +value. .TP .BI ".TP [" nnn ] -Sets up an indented paragraph. +Sets up an indented paragraph with label. The indentation is set to .I nnn -if that argument is supplied. +if that argument is supplied (the default unit is `n' if omitted), otherwise +it is set to the default indentation value. The first line of text following this macro is interpreted as a string to be printed flush-left, as it is appropriate for a label. It is not interpreted as part of a paragraph, so there is no attempt to fill @@ -58,72 +167,149 @@ paragraph starts at the same line (but indented), continuing on the following lines. If the label is wider than the indentation, then the descriptive part of the paragraph begins on the line following the label, entirely indented. -The `.TP' macro is the macro used for the explanations you are just reading. +Note that neither font shape nor font size of the label is set to a default +value; on the other hand, the rest of the text will have default font +settings. +The +.B TP +macro is the macro used for the explanations you are just reading. .TP -.BR ".LP " or " .PP " or " .P" +.B .LP +.TQ +.B .PP +.TQ +.B .P These macros are mutual aliases. Any of them causes a line break at the current position, followed by a -vertical space downwards by the amount that is set in the `PD' counter. +vertical space downwards by the amount specified by the +.B PD +macro. +The font size and shape are reset to the default value (10pt resp. Roman). +Finally, the current left margin is restored. .TP .BI ".IP [" designator "] [" nnn ] Sets up an indented paragraph, using .I designator as a tag to mark its beginning. -The indentation is permanently set to +The indentation is set to .I nnn -if that argument is supplied. -To set the indentation back to the previous level, one must call some other -macro that uses indented paragraphs, and explicitly provide it with the -value of the previous indentation. +if that argument is supplied (default unit is `n'), otherwise the default +indentation value is used. +Font size and face of the paragraph (but not the designator) are reset to +its default values. +To start an indented paragraph with a particular indentation but without a +designator, use `""' (two doublequotes) as the second argument. .IP For example, the following paragraphs were all set up with bullets as the -designator, using `.IP \\(bu 4': +designator, using `.IP\ \\(bu\ 4': +.RS .IP \(bu 4 -`IP' is one of the three macros used in -.B tmac.an +.B IP +is one of the three macros used in +.B tmac.@TMAC_AN_PREFIX@an to format lists. .IP \(bu 4 -`HP' is another. +.B HP +is another. This macro produces a paragraph with a left hanging indentation. .IP \(bu 4 -`TP' is another. -This macro produces an unindented label (given by the text on the first line -following `TP'), followed by an indented paragraph with appropriately -descriptive text. +.B TP +is another. +This macro produces an unindented label followed by an indented paragraph. +.RE .TP .BI ".HP [" nnn ] -Sets up paragraphs with hanging left indentation. +Sets up a paragraph with hanging left indentation. The indentation is set to .I nnn -if that argument is supplied. -The following pargraph illustrates the effect of this macro with the hanging -indentation set to\ 2: -.HP 2 -This is a pagraph following an invocation of the `.HP' macro. +if that argument is supplied (default unit is `n'), otherwise the default +indentation value is used. +Font size and face are reset to its default values. +The following paragraph illustrates the effect of this macro with hanging +indentation set to\ 4: +.RS +.HP 4 +This is a paragraph following an invocation of the +.B HP +macro. As you can see, it produces a paragraph where all lines but the first are -flushed right and are shorter than the preceding lines. +indented. +.RE +.TP +.BI ".RS [" nnn ] +This macro moves the left margin to the right by the value +.I nnn +if specified (default unit is `n'); otherwise the default indentation value +is used. +Calls to the +.B RS +macro can be nested. +.TP +.BI ".RE [" nnn ] +This macro moves the left margin back to level +.IR nnn ; +if no argument is given, it moves one level back. +The first level (i.e., no call to +.B RS +yet) has number\ 1, and each call to +.B RS +increases the level by\ 1. +.PP +To summarize, the following macros cause a line break with the insertion of +vertical space (which amount can be changed with the +.B PD +macro): +.BR SH , +.BR SS , +.BR TP , +.B LP +.RB ( PP , +.BR P ), +.BR IP , +and +.BR HP . +The macros +.B RS +and +.B RE +also cause a break but no insertion of vertical space. . .SH "MACROS TO SET FONTS" . +The standard font is Roman; the default text size is 10\ point. .TP -.BI .SM +.BI ".SM [" text ] Causes the text on the same line or the text on the next line to appear in a font that is one point size smaller than the default font. .TP -.BI .SB +.BI ".SB [" text ] Causes the text on the same line or the text on the next line to appear in -small boldface font. +boldface font, one point size smaller than the default font. .TP .BI ".BI " text Causes text on the same line to appear alternately in bold face and italic. The text must be on the same line as the macro call. -Thus `.BI this word and that' would cause `this' and `and' to appear in bold -face, while `word' and `that' appear in italics. +Thus +.RS +.IP +\&.BI this "word and" that +.PP +would cause `this' and `that' to appear in bold face, while `word and' +appears in italics. +.RE .TP .BI ".IB " text Causes text to appear alternately in italic and bold face. The text must be on the same line as the macro call. .TP +.BI ".RI " text +Causes text on the same line to appear alternately in roman and italic. +The text must be on the same line as the macro call. +.TP +.BI ".IR " text +Causes text on the same line to appear alternately in italic and roman. +The text must be on the same line as the macro call. +.TP .BI ".BR " text Causes text on the same line to appear alternately in bold face and roman. The text must be on the same line as the macro call. @@ -132,40 +318,124 @@ The text must be on the same line as the macro call. Causes text on the same line to appear alternately in roman and bold face. The text must be on the same line as the macro call. .TP -.BI ".R " text -Causes text to appear in roman font. +.BI ".R [" text ] +Causes +.I text +to appear in roman font. If no text is present on the line where the macro is called, then the text of the next line appears in roman. This is the default font to which text is returned at the end of processing of the other macros. .TP -.BI ".B " text -Causes text to appear in bold face. +.BI ".B [" text ] +Causes +.I text +to appear in bold face. If no text is present on the line where the macro is called, then the text of the next line appears in bold face. .TP -.BI ".I " text -Causes text to appear in italic. +.BI ".I [" text ] +Causes +.I text +to appear in italic. If no text is present on the line where the macro is called, then the text of the next line appears in italic. . +.SH "MISCELLANEOUS" +. +The default indentation is 7.2n for all output devices except for +.B grohtml +which uses 1.2i instead. +.TP +.B .DT +Sets tabs every 0.5 inches. +Since this macro is always called during a +.B TH +request, it makes sense to call it only if the tab positions have been +changed. +.TP +.BI ".PD [" nnn ] +Adjusts the empty space before a new paragraph (resp. section). +The optional argument gives the amount of space (default units are `v'); +without parameter, the value is reset to its default value (1\ line for tty +devices, 0.4v\ otherwise). +This affects the macros +.BR SH , +.BR SS , +.BR TP , +.B LP +(resp.\& +.B PP +and +.BR P ), +.BR IP , +and +.BR HP . +.PP +The following strings are defined: +.TP +.B \e*S +Switch back to the default font size. +.TP +.B \e*R +The `registered' sign. +.TP +.B \e*(Tm +The `trademark' sign. +.TP +.B \e*(lq +.TQ +.B \e*(rq +Left and right quote. +This is equal to `\e(lq' and `\e(rq', respectively. +.PP +If a preprocessor like +.B @g@tbl +or +.B @g@eqn +is needed, it has become usage to make the first line of the man page look +like this: +.PP +.RS +.BI .\e"\ word +.RE +.PP +Note the single space character after the double quote. +.I word +consists of letters for the needed preprocessors: `e' for +.BR @g@eqn , +`r' for +.BR @g@refer , +and `t' for +.BR @g@tbl . +Modern implementations of the +.B man +program read this first line and automatically call the right +preprocessor(s). +. .SH "SEE ALSO" . Since the -.B tmac.an +.B tmac.@TMAC_AN_PREFIX@an macros consist of groups of .I groff requests, one can, in principle, supplement the functionality of the -.B tmac.an +.B tmac.@TMAC_AN_PREFIX@an macros with individual .I groff requests where necessary. A complete list of these requests is available on the WWW at +.PP .ce 1 http://www.cs.pdx.edu/~trent/gnu/groff/groff_toc.html +.PP +.BR @g@tbl (@MAN1EXT@), +.BR @g@eqn (@MAN1EXT@), +.BR @g@refer (@MAN1EXT@), +.BR man (1) . .SH AUTHOR . This manual page was originally written for the Debian GNU/Linux system by -Susan G. Kleinmann <sgk@debian.org>, corrected by Werner Lemberg +Susan G. Kleinmann <sgk@debian.org>, corrected and updated by Werner Lemberg <wl@gnu.org>, and is now part of the GNU troff distribution. |
