Home
Main website
Display Sidebar
Hide Ads
Recent Changes
View Source:
groff_man(7)
Edit
PageHistory
Diff
Info
LikePages
GROFF_MAN !!!GROFF_MAN NAME SYNOPSIS DESCRIPTION OPTIONS USAGE MACROS TO SET FONTS MISCELLANEOUS FILES SEE ALSO AUTHOR ---- !!NAME groff_man - groff `man' macros to support generation of man pages !!SYNOPSIS __groff -man__ [[ ''options''... ] [[ ''files''... ]__ groff -m man__ [[ ''options''... ] [[ ''files''... ] !!DESCRIPTION The __man__ macros used to generate man pages with ''groff'' were written by James Clark. This document provides a brief summary of the use of each macro in that package. !!OPTIONS The __man__ macros understand the following command line options (which define various registers). __-rcR=1__ This option (the default if in nroff mode) will create a single, very long page instead of multiple pages. Say __-rcR=0__ to disable it. __-rC1__ If more than one manual page is given on the command line, number the pages continuously, rather than starting each at 1. __-rD1__ Double-sided printing. Footers for even and odd pages are formatted differently. __-rP__''nnn'' Enumeration of pages will start with ''nnn'' rather than with 1. __-rS__''xx'' Base document font size is ''xx'' points (''xx'' can be 10, 11, or 12) rather than 10 points. __-rX__''nnn'' After page ''nnn'', number pages as ''nnn''a, ''nnn''b, ''nnn''c, etc. For example, the option `-rX2' will produce the following page numbers: 1, 2, 2a, 2b, 2c, etc. !!USAGE This section describes the available macros for manual pages. For further customization, put additional macros and requests into the file __man.local__ which will be loaded immediately after the __man__ package. __.TH__ ''title section'' __[[__''extra1''__] [[__''extra2''__] [[__''extra3''__]__ Sets the title of the man page to ''title'' and the section to ''section'', which must take on a value between 1 and 8. The value ''section'' may also have a string appended, e.g. `.pm', to indicate a specific subsection of the man pages. Both ''title'' and ''section'' are positioned at the left and right in the header line (with ''section'' in parentheses immediately appended to ''title''. ''extra1'' will be positioned in the middle of the footer line. ''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). ''extra3'' is centered in the header line. For HTML output, headers and footers are completely supressed. 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 __TH__ macro at the beginning of the file. __.SH [[__''text for a heading''__]__ Sets up an unnumbered section heading sticking out to the left. Prints out all the text following __SH__ up to the end of the line (resp. the text in the next line if there is no argument to __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. __.SS [[__''text for a heading''__]__ Sets up an secondary, unnumbered section heading. Prints out all the text following __SS__ up to the end of the line (resp. the text in the next line if there is no argument to __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 [[__''nnn''__]__ Sets up an indented paragraph with label. The indentation is set to ''nnn'' 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 the first line with text from the following input lines. Nevertheless, if the label is not as wide as the indentation, then the 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. 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 __TP__ macro is the macro used for the explanations you are just reading. __.LP__ __.PP__ __.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 specified by the __PD__ macro. The font size and shape are reset to the default value (10pt resp. Roman). Finally, the current left margin is restored. __.IP [[__''designator''__] [[__''nnn''__]__ Sets up an indented paragraph, using ''designator'' as a tag to mark its beginning. The indentation is set to ''nnn'' 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 ` '' For example, the following paragraphs were all set up with bullets as the designator, using `.IP 4': __IP__ is one of the three macros used in the __man__ package to format lists. __HP__ is another. This macro produces a paragraph with a left hanging indentation. __TP__ is another. This macro produces an unindented label followed by an indented paragraph. __.HP [[__''nnn''__]__ Sets up a paragraph with hanging left indentation. The indentation is set to ''nnn'' 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: This is a paragraph following an invocation of the __HP__ macro. As you can see, it produces a paragraph where all lines but the first are indented. __.RS [[__''nnn''__]__ This macro moves the left margin to the right by the value ''nnn'' if specified (default unit is `n'); otherwise the default indentation value is used. Calls to the __RS__ macro can be nested. __.RE [[__''nnn''__]__ This macro moves the left margin back to level ''nnn''; if no argument is given, it moves one level back. The first level (i.e., no call to __RS__ yet) has number 1, and each call to __RS__ increases the level by 1. To summarize, the following macros cause a line break with the insertion of vertical space (which amount can be changed with the __PD__ macro): __SH__, __SS__, __TP__, __LP__ (__PP__, __P__), __IP__, and __HP__. The macros __RS__ and __RE__ also cause a break but no insertion of vertical space. !!MACROS TO SET FONTS The standard font is Roman; the default text size is 10 point. __.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. __.SB [[__''text''__]__ Causes the text on the same line or the text on the next line to appear in boldface font, one point size smaller than the default font. __.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 would cause `this' and `that' to appear in bold face, while `word and' appears in italics. __.IB__ ''text'' Causes text to appear alternately in italic and bold face. The text must be on the same line as the macro call. __.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. __.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. __.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. __.RB__ ''text'' 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. __.R [[__''text''__]__ Causes ''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. __.B [[__''text''__]__ Causes ''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. __.I [[__''text''__]__ Causes ''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. !!MISCELLANEOUS The default indentation is 7.2n for all output devices except for __grohtml__ which ignores indentation. __.DT__ Sets tabs every 0.5 inches. Since this macro is always called during a __TH__ request, it makes sense to call it only if the tab positions have been changed. __.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 __SH__, __SS__, __TP__, __LP__ (resp. __PP__ and __P__), __IP__, and __HP__. The following strings are defined: __*S__ Switch back to the default font size. __*R__ The `registered' sign. __*(Tm__ The `trademark' sign. __*(lq__ __*(rq__ Left and right quote. This is equal to ` and ` respectively. If a preprocessor like __tbl__ or __eqn__ is needed, it has become usage to make the first line of the man page look like this: __.__ ''word'' Note the single space character after the double quote. ''word'' consists of letters for the needed preprocessors: `e' for __eqn__, `r' for __refer__, and `t' for __tbl__. Modern implementations of the __man__ program read this first line and automatically call the right preprocessor(s). !!FILES __man.tmac__ __an.tmac__ These are wrapper files to call __andoc.tmac__. __andoc.tmac__ This file checks whether the __man__ macros or the __mdoc__ package should be used. __an-old.tmac__ All __man__ macros are contained in this file. __man.local__ Local changes and customizations should be put into this file. !!SEE ALSO Since the __man__ macros consist of groups of ''groff'' requests, one can, in principle, supplement the functionality of the __man__ macros with individual ''groff'' requests where necessary. A complete list of these requests is available on the WWW at http://www.cs.pdx.edu/~trent/gnu/groff/groff_toc.html tbl(1), eqn(1), refer(1), man(1) !!AUTHOR This manual page was originally written for the Debian GNU/Linux system by Susan G. Kleinmann ----
4 pages link to
groff_man(7)
:
Man7g
groff(1)
groff_tmac(5)
groff_mdoc(7)
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.
