groff_man.man revision 151497
179543Sru.ig 2151497SruCopyright (C) 1999-2000, 2001, 2002, 2003, 2004, 2005 3151497SruFree Software Foundation, Inc. 469626Sru 5151497SruPermission is granted to make and distribute verbatim copies of this 6151497Srumanual provided the copyright notice and this permission notice are 7151497Srupreserved on all copies. 869626Sru 969626SruPermission is granted to copy and distribute modified versions of this 1069626Srumanual under the conditions for verbatim copying, provided that the 1169626Sruentire resulting derived work is distributed under the terms of a 1269626Srupermission notice identical to this one. 1369626Sru 1469626SruPermission is granted to copy and distribute translations of this 1569626Srumanual into another language, under the above conditions for modified 1669626Sruversions, except that this permission notice may be included in 1769626Srutranslations approved by the Free Software Foundation instead of in 1869626Sruthe original English. 1969626Sru.. 20114402Sru. 2169626Sru.de TQ 22114402Sru. br 23114402Sru. ns 24114402Sru. TP \\$1 2569626Sru.. 26114402Sru. 27114402Sru. 2855839Sasmodai.TH GROFF_MAN @MAN7EXT@ "@MDATE@" "Groff Version @VERSION@" 2955839Sasmodai. 30114402Sru. 31114402Sru.\" ----------------------------------------------------------------- 32114402Sru. 3355839Sasmodai.SH NAME 3455839Sasmodai. 3569626Srugroff_man \- groff `man' macros to support generation of man pages 3669626Sru. 37114402Sru. 38114402Sru.\" ----------------------------------------------------------------- 39114402Sru. 4055839Sasmodai.SH SYNOPSIS 4169626Sru. 4255839Sasmodai.B groff 4375584Sru.B \-man 4455839Sasmodai[ 45104862Sru.IR options .\|.\|.\& 4655839Sasmodai] 4755839Sasmodai[ 48104862Sru.IR files .\|.\|.\& 4955839Sasmodai] 5075584Sru.br 5175584Sru.B groff 5275584Sru.B \-m\ man 5375584Sru[ 54104862Sru.IR options .\|.\|.\& 5575584Sru] 5675584Sru[ 57104862Sru.IR files .\|.\|.\& 5875584Sru] 5955839Sasmodai. 60114402Sru. 61114402Sru.\" ----------------------------------------------------------------- 62114402Sru. 6355839Sasmodai.SH DESCRIPTION 6455839Sasmodai. 6575584SruThe 6675584Sru.B man 67151497Srumacros used to generate 68151497Sru.I \%man\~pages 69151497Sruwith 7055839Sasmodai.I groff 7175584Sruwere written by James Clark. 72151497Sru. 7355839SasmodaiThis document provides a brief summary of the use of each macro in that 7455839Sasmodaipackage. 7569626Sru. 76114402Sru. 77114402Sru.\" ----------------------------------------------------------------- 78114402Sru. 7969626Sru.SH OPTIONS 8069626Sru. 8169626SruThe 8269626Sru.B man 83151497Srumacros understand the following command line options (which define 84151497Sruvarious registers). 85114402Sru. 8655839Sasmodai.TP 8775584Sru.B \-rcR=1 88151497SruThis option (the default if in nroff mode) will create a single, very 89151497Srulong page instead of multiple pages. 90151497Sru. 9175584SruSay 9275584Sru.B \-rcR=0 9375584Sruto disable it. 94114402Sru. 9575584Sru.TP 9669626Sru.B \-rC1 9769626SruIf more than one manual page is given on the command line, number the 9869626Srupages continuously, rather than starting each at\ 1. 99114402Sru. 10069626Sru.TP 10169626Sru.B \-rD1 10269626SruDouble-sided printing. 103151497Sru. 10469626SruFooters for even and odd pages are formatted differently. 105114402Sru. 10669626Sru.TP 107114402Sru.BI \-rFT= dist 108151497SruSet distance of the footer relative to the bottom of the page if 109151497Srunegative or relative to the top if positive. 110151497Sru. 111114402SruThe default is -0.5i. 112114402Sru. 113114402Sru.TP 114114402Sru.BI \-rHY= flags 115114402SruSet hyphenation flags. 116114402Sru. 117114402SruPossible values are 1\ to hyphenate without restrictions, 2\ to not 118114402Sruhyphenate the last word on a page, 4\ to not hyphenate the last two 119114402Srucharacters of a word, and 8\ to not hyphenate the first two characters 120114402Sruof a word. 121114402Sru. 122114402SruThese values are additive; the default is\ 14. 123114402Sru. 124114402Sru.TP 125114402Sru.BI \-rIN= width 126114402SruSet body text indentation to 127114402Sru.IR width . 128114402SruThe default is 7n for 129114402Sru.IR nroff , 130114402Sru7.2n for 131114402Sru.IR troff . 132114402SruFor 133114402Sru.IR nroff , 134114402Sruthis value should always be an integer multiple of unit `n' to get 135114402Sruconsistent indentation. 136114402Sru. 137114402Sru.TP 138114402Sru.BI \-rLL= line-length 139114402SruSet line length. 140114402Sru. 141151497SruIf this option is not given, 142151497Sruthe line length is set to respect any value set by a prior `.ll' request, 143151497Sru(which 144151497Sru.I must 145151497Srube in effect when the `.TH' macro is invoked), 146151497Sruif this differs from the built\-in default for the formatter; 147151497Sruotherwise it defaults to 78n in 148151497Sru.I nroff 149151497Srumode and 6.5i in 150151497Sru.I troff 151151497Srumode. 152151497Sru. 153151497Sru.IP 154151497SruNote that the use of a `.ll' request to initialize the line length 155151497Sruis supported for backward compatibility with some versions of the 156151497Sru.B man 157151497Sruprogram; 158151497Srudirect initialization of the `LL' register should 159151497Sru.I always 160151497Srube preferred to the use of such a request. 161151497SruIn particular, note that a `.ll\ 65n' request will 162151497Sru.I not 163151497Srupreserve the normal 164151497Sru.I nroff 165151497Srudefault line length, 166151497Sru(the 167151497Sru.B man 168151497Srudefault initialization to 78n will prevail), 169151497Sruwhereas, 170151497Sruthe `-rLL=65n' option, or an equivalent `.nr\ LL\ 65n' 171151497Srurequest preceding the use of the `TH' macro, 172151497Sru.I will 173151497Sruset a line length of 65n. 174151497Sru. 175114402Sru.TP 176114402Sru.BI \-rLT= title-length 177114402SruSet title length. 178114402Sru. 179151497SruIf this option is not given, the title length defaults to the line 180151497Srulength. 181151497Sru. 182114402Sru.TP 18369626Sru.BI \-rP nnn 18469626SruEnumeration of pages will start with 18569626Sru.I nnn 18669626Srurather than with\ 1. 187114402Sru. 18869626Sru.TP 18969626Sru.BI \-rS xx 19069626SruBase document font size is 19169626Sru.I xx 19269626Srupoints 19369626Sru.RI ( xx 19469626Srucan be 10, 11, or\ 12) rather than 10\ points. 195114402Sru. 19669626Sru.TP 197114402Sru.BI \-rSN= width 198114402SruSet sub-subheading indentation to 199114402Sru.IR width . 200114402SruThe default is 3n. 201114402Sru. 202114402Sru.TP 20369626Sru.BI \-rX nnn 20469626SruAfter page\ \c 20569626Sru.IR nnn , 20669626Srunumber pages as 20769626Sru.IR nnn a, 20869626Sru.IR nnn b, 20969626Sru.IR nnn c, 21069626Sruetc. 21169626Sru. 212151497SruFor example, the option `\-rX2' will produce the following page 213151497Srunumbers: 1, 2, 2a, 2b, 2c, etc. 214114402Sru. 215151497Sru. 216114402Sru.\" ----------------------------------------------------------------- 217114402Sru. 21869626Sru.SH USAGE 21969626Sru. 22069626SruThis section describes the available macros for manual pages. 221151497Sru. 222151497SruFor further customization, put additional macros and requests into the 223151497Srufile 22469626Sru.B man.local 22575584Sruwhich will be loaded immediately after the 22675584Sru.B man 22775584Srupackage. 228114402Sru. 22969626Sru.TP 230151497Sru.BI .TH " title section \fB[\fPextra1\fB]\fP \fB[\fPextra2\fB]\fP \fB[\fPextra3\fB]" 231151497SruSet the title of the 232151497Sru.I \man\~page 233151497Sruto 23455839Sasmodai.I title 23555839Sasmodaiand the section to 23655839Sasmodai.IR section , 23755839Sasmodaiwhich must take on a value between 1 and\ 8. 238151497Sru. 23955839SasmodaiThe value 24055839Sasmodai.I section 24155839Sasmodaimay also have a string appended, e.g. `.pm', to indicate a specific 242151497Srusubsection of the 243151497Sru.IR \%man\~pages . 24469626SruBoth 24569626Sru.I title 24669626Sruand 24769626Sru.I section 24869626Sruare positioned at the left and right in the header line (with 24969626Sru.I section 25069626Sruin parentheses immediately appended to 25169626Sru.IR title . 25269626Sru.I extra1 25369626Sruwill be positioned in the middle of the footer line. 25469626Sru.I extra2 255114402Sruwill be positioned at the left in the footer line (or at the left on 25669626Srueven pages and at the right on odd pages if double-sided printing is 25769626Sruactive). 25869626Sru.I extra3 25969626Sruis centered in the header line. 260114402Sru. 26169626Sru.IP 26269626SruFor HTML output, headers and footers are completely supressed. 263114402Sru. 26469626Sru.IP 265151497SruAdditionally, this macro starts a new page; the new line number is\ 1 266151497Sruagain (except if the `-rC1' option is given on the command line) -- 267151497Sruthis feature is intended only for formatting multiple 268151497Sru.IR \%man\~pages ; 269151497Srua single 270151497Sru.I \%man\~page 271151497Srushould contain exactly one 27269626Sru.B TH 27369626Srumacro at the beginning of the file. 274114402Sru. 27555839Sasmodai.TP 27669626Sru.BI ".SH [" "text for a heading" ] 277114402SruSet up an unnumbered section heading sticking out to the left. 278151497Sru. 27969626SruPrints out all the text following 28069626Sru.B SH 281151497Sruup to the end of the line (or the text in the next input line if there 282151497Sruis no argument to 28369626Sru.BR SH ) 284114402Sruin bold face 285114402Sru(or the font specified by the string 286114402Sru.BR HF ), 287114402Sruone size larger than the base document size. 288114402Sru. 289151497SruAdditionally, the left margin and the indentation for the following 290151497Srutext is reset to the default values. 291151497Sru. 29255839Sasmodai.TP 29369626Sru.BI ".SS [" "text for a heading" ] 294114402SruSet up a secondary, unnumbered section heading. 295151497Sru. 29669626SruPrints out all the text following 29769626Sru.B SS 298151497Sruup to the end of the line (or the text in the next input line if there 299151497Sruis no argument to 30069626Sru.BR SS ) 301114402Sruin bold face 302114402Sru(or the font specified by the string 303114402Sru.BR HF ), 304114402Sruat the same size as the base document size. 305114402Sru. 306151497SruAdditionally, the left margin and the indentation for the following 307151497Srutext is reset to the default values. 308151497Sru. 30955839Sasmodai.TP 31055839Sasmodai.BI ".TP [" nnn ] 311114402SruSet up an indented paragraph with label. 312151497Sru. 31375584SruThe indentation is set to 31455839Sasmodai.I nnn 315151497Sruif that argument is supplied (the default unit is `n' if omitted), 316151497Sruotherwise it is set to the previous indentation value specified with 317114402Sru.BR TP , 318114402Sru.BR IP , 319114402Sruor 320114402Sru.B HP 321114402Sru(or to the default value if none of them have been used yet). 322114402Sru. 323114402Sru.IP 324151497SruThe first input line of text following this macro is interpreted as a 325151497Srustring to be printed flush-left, as it is appropriate for a label. 326151497Sru. 327151497SruIt is not interpreted as part of a paragraph, so there is no attempt 328151497Sruto fill the first line with text from the following input lines. 329151497Sru. 330114402SruNevertheless, if the label is not as wide as the indentation the 33155839Sasmodaiparagraph starts at the same line (but indented), continuing on the 33255839Sasmodaifollowing lines. 333151497Sru. 334114402SruIf the label is wider than the indentation the descriptive part of the 33555839Sasmodaiparagraph begins on the line following the label, entirely indented. 336114402Sru. 337151497SruNote that neither font shape nor font size of the label is set to a 338151497Srudefault value; on the other hand, the rest of the text will have 339151497Srudefault font settings. 340151497Sru. 341114402Sru.IP 34269626SruThe 34369626Sru.B TP 34469626Srumacro is the macro used for the explanations you are just reading. 345114402Sru. 34655839Sasmodai.TP 34769626Sru.B .LP 34869626Sru.TQ 34969626Sru.B .PP 35069626Sru.TQ 35169626Sru.B .P 35255839SasmodaiThese macros are mutual aliases. 353151497Sru. 35455839SasmodaiAny of them causes a line break at the current position, followed by a 35569626Sruvertical space downwards by the amount specified by the 35669626Sru.B PD 35769626Srumacro. 358151497Sru. 359151497SruThe font size and shape are reset to the default value (10pt 360151497Sruresp. Roman). 361151497Sru. 362114402SruFinally, the current left margin and the indentation are restored. 363114402Sru. 36455839Sasmodai.TP 36555839Sasmodai.BI ".IP [" designator "] [" nnn ] 366114402SruSet up an indented paragraph, using 36775584Sru.I designator 36855839Sasmodaias a tag to mark its beginning. 369151497Sru. 37069626SruThe indentation is set to 37155839Sasmodai.I nnn 372151497Sruif that argument is supplied (the default unit is `n' if omitted), 373151497Sruotherwise it is set to the previous indentation value specified with 374114402Sru.BR TP , 375114402Sru.BR IP , 376114402Sruor 377114402Sru.B HP 378114402Sru(or to the default value if none of them have been used yet). 379114402Sru. 380151497SruFont size and face of the paragraph (but not the designator) are reset 381151497Sruto its default values. 382151497Sru. 383114402Sru.IP 384151497SruTo start an indented paragraph with a particular indentation but 385151497Sruwithout a designator, use `""' (two doublequotes) as the second 386151497Sruargument. 387114402Sru. 38855839Sasmodai.IP 389151497SruFor example, the following paragraphs were all set up with bullets as 390151497Sruthe designator, using `.IP\ \\(bu\ 4'. 391151497Sru. 392114402SruThe whole block has been enclosed with `.RS' and `.RE' to set the left 393114402Srumargin temporarily to the current indentation value. 394114402Sru. 39569626Sru.RS 39655839Sasmodai.IP \(bu 4 39769626Sru.B IP 39875584Sruis one of the three macros used in the 39975584Sru.B man 40075584Srupackage to format lists. 40155839Sasmodai.IP \(bu 4 40269626Sru.B HP 40369626Sruis another. 404151497Sru. 40555839SasmodaiThis macro produces a paragraph with a left hanging indentation. 40655839Sasmodai.IP \(bu 4 40769626Sru.B TP 40869626Sruis another. 409151497Sru. 410151497SruThis macro produces an unindented label followed by an indented 411151497Sruparagraph. 41269626Sru.RE 413114402Sru. 41455839Sasmodai.TP 41555839Sasmodai.BI ".HP [" nnn ] 416114402SruSet up a paragraph with hanging left indentation. 417151497Sru. 41855839SasmodaiThe indentation is set to 41955839Sasmodai.I nnn 420151497Sruif that argument is supplied (the default unit is `n' if omitted), 421151497Sruotherwise it is set to the previous indentation value specified with 422114402Sru.BR TP , 423114402Sru.BR IP , 424114402Sruor 425114402Sru.B HP 426114402Sru(or to the default value if none of them have been used yet). 427151497Sru. 42869626SruFont size and face are reset to its default values. 429114402Sru. 430151497SruThe following paragraph illustrates the effect of this macro with 431151497Sruhanging indentation set to\ 4 (enclosed by 432151497Sru.B .RS 433151497Sruand 434151497Sru.B .RE 435151497Sruto set the left margin temporarily to the current indentation): 436151497Sru. 43769626Sru.RS 43869626Sru.HP 4 43969626SruThis is a paragraph following an invocation of the 44069626Sru.B HP 44169626Srumacro. 442151497Sru. 443151497SruAs you can see, it produces a paragraph where all lines but the first 444151497Sruare indented. 44569626Sru.RE 446114402Sru. 44769626Sru.TP 44869626Sru.BI ".RS [" nnn ] 44969626SruThis macro moves the left margin to the right by the value 45069626Sru.I nnn 451151497Sruif specified (default unit is `n'); otherwise it is set to the 452151497Sruprevious indentation value specified with 453114402Sru.BR TP , 454114402Sru.BR IP , 455114402Sruor 456114402Sru.B HP 457114402Sru(or to the default value if none of them have been used yet). 458151497Sru. 459114402SruThe indentation value is then set to the default. 460114402Sru. 461114402Sru.IP 46269626SruCalls to the 46369626Sru.B RS 46469626Srumacro can be nested. 465114402Sru. 46669626Sru.TP 46769626Sru.BI ".RE [" nnn ] 46869626SruThis macro moves the left margin back to level 469114402Sru.IR nnn , 470114402Srurestoring the previous left margin. 471151497Sru. 472114402SruIf no argument is given, it moves one level back. 473151497Sru. 47469626SruThe first level (i.e., no call to 47569626Sru.B RS 47669626Sruyet) has number\ 1, and each call to 47769626Sru.B RS 47869626Sruincreases the level by\ 1. 479114402Sru. 48069626Sru.PP 481151497SruTo summarize, the following macros cause a line break with the 482151497Sruinsertion of vertical space (which amount can be changed with the 48369626Sru.B PD 48469626Srumacro): 48569626Sru.BR SH , 48669626Sru.BR SS , 48769626Sru.BR TP , 48869626Sru.B LP 48969626Sru.RB ( PP , 49069626Sru.BR P ), 49169626Sru.BR IP , 49269626Sruand 49369626Sru.BR HP . 49469626SruThe macros 49569626Sru.B RS 49669626Sruand 49769626Sru.B RE 49869626Srualso cause a break but no insertion of vertical space. 49955839Sasmodai. 500114402Sru. 501114402Sru.\" ----------------------------------------------------------------- 502114402Sru. 50355839Sasmodai.SH "MACROS TO SET FONTS" 50455839Sasmodai. 50569626SruThe standard font is Roman; the default text size is 10\ point. 506114402Sru. 50755839Sasmodai.TP 50869626Sru.BI ".SM [" text ] 509104862SruCauses the text on the same line or the text on the next input line to 510104862Sruappear in a font that is one point size smaller than the default font. 511114402Sru. 51255839Sasmodai.TP 51369626Sru.BI ".SB [" text ] 514104862SruCauses the text on the same line or the text on the next input line to 515104862Sruappear in boldface font, one point size smaller than the default font. 516114402Sru. 51755839Sasmodai.TP 51855839Sasmodai.BI ".BI " text 519151497SruCauses text on the same line to appear alternately in bold face and 520151497Sruitalic. 521151497Sru. 52255839SasmodaiThe text must be on the same line as the macro call. 523151497Sru. 52469626SruThus 52569626Sru.RS 52669626Sru.IP 52769626Sru\&.BI this "word and" that 52869626Sru.PP 52969626Sruwould cause `this' and `that' to appear in bold face, while `word and' 53069626Sruappears in italics. 53169626Sru.RE 532114402Sru. 53355839Sasmodai.TP 53455839Sasmodai.BI ".IB " text 53555839SasmodaiCauses text to appear alternately in italic and bold face. 536151497Sru. 53755839SasmodaiThe text must be on the same line as the macro call. 538114402Sru. 53955839Sasmodai.TP 54069626Sru.BI ".RI " text 541151497SruCauses text on the same line to appear alternately in roman and 542151497Sruitalic. 543151497Sru. 54469626SruThe text must be on the same line as the macro call. 545114402Sru. 54669626Sru.TP 54769626Sru.BI ".IR " text 548151497SruCauses text on the same line to appear alternately in italic and 549151497Sruroman. 550151497Sru. 55169626SruThe text must be on the same line as the macro call. 552114402Sru. 55369626Sru.TP 55455839Sasmodai.BI ".BR " text 555151497SruCauses text on the same line to appear alternately in bold face and 556151497Sruroman. 557151497Sru. 55855839SasmodaiThe text must be on the same line as the macro call. 559114402Sru. 56055839Sasmodai.TP 56155839Sasmodai.BI ".RB " text 562151497SruCauses text on the same line to appear alternately in roman and bold 563151497Sruface. 564151497Sru. 56555839SasmodaiThe text must be on the same line as the macro call. 566114402Sru. 56755839Sasmodai.TP 56869626Sru.BI ".B [" text ] 56969626SruCauses 57069626Sru.I text 57169626Sruto appear in bold face. 572151497Sru. 573114402SruIf no text is present on the line where the macro is called the text 574104862Sruof the next input line appears in bold face. 575114402Sru. 57655839Sasmodai.TP 57769626Sru.BI ".I [" text ] 57869626SruCauses 57969626Sru.I text 58069626Sruto appear in italic. 581151497Sru. 582114402SruIf no text is present on the line where the macro is called the text 583104862Sruof the next input line appears in italic. 58455839Sasmodai. 585114402Sru. 586114402Sru.\" ----------------------------------------------------------------- 587114402Sru. 58869626Sru.SH "MISCELLANEOUS" 58969626Sru. 590151497SruThe default indentation is 7.2n in troff mode and 7n in nroff mode 591151497Sruexcept for 59269626Sru.B grohtml 59375584Sruwhich ignores indentation. 594114402Sru. 59569626Sru.TP 59669626Sru.B .DT 597114402SruSet tabs every 0.5 inches. 598151497Sru. 59969626SruSince this macro is always called during a 60069626Sru.B TH 60169626Srurequest, it makes sense to call it only if the tab positions have been 60269626Sruchanged. 603114402Sru. 60469626Sru.TP 60569626Sru.BI ".PD [" nnn ] 606114402SruAdjust the empty space before a new paragraph or section. 607151497Sru. 608114402SruThe optional argument gives the amount of space (default unit is `v'); 609114402Sruwithout parameter, the value is reset to its default value (1\ line in 610114402Srunroff mode, 0.4v\ otherwise). 611151497Sru. 61269626SruThis affects the macros 61369626Sru.BR SH , 61469626Sru.BR SS , 61569626Sru.BR TP , 61669626Sru.B LP 61769626Sru(resp.\& 61869626Sru.B PP 61969626Sruand 62069626Sru.BR P ), 62169626Sru.BR IP , 62269626Sruand 62369626Sru.BR HP . 624114402Sru. 625114402Sru.TP 626114402Sru.BI ".AT [" system " [" release ]] 627151497SruAlter the footer for use with \f[CR]AT&T\f[] 628151497Sru.IR \%man\~pages . 629114402SruThis command exists only for compatibility; don't use it. 630114402Sru. 631151497SruSee the 632151497Sru.I groff 633151497Sruinfo manual for more. 634151497Sru. 635114402Sru.TP 636114402Sru.BI ".UC [" version ] 637151497SruAlter the footer for use with \f[CR]BSD\f[] 638151497Sru.IR \%man\~pages . 639114402SruThis command exists only for compatibility; don't use it. 640114402Sru. 641151497SruSee the 642151497Sru.I groff 643151497Sruinfo manual for more. 644151497Sru. 645114402Sru.TP 646114402Sru.B ".PT" 647114402SruPrint the header string. 648151497Sru. 649114402SruRedefine this macro to get control of the header. 650114402Sru. 651114402Sru.TP 652114402Sru.B ".BT" 653114402SruPrint the footer string. 654151497Sru. 655114402SruRedefine this macro to get control of the footer. 656114402Sru. 65769626Sru.PP 65869626SruThe following strings are defined: 65969626Sru.TP 66069626Sru.B \e*S 66169626SruSwitch back to the default font size. 662114402Sru. 66369626Sru.TP 66469626Sru.B \e*R 66569626SruThe `registered' sign. 666114402Sru. 66769626Sru.TP 66869626Sru.B \e*(Tm 66969626SruThe `trademark' sign. 670114402Sru. 67169626Sru.TP 67269626Sru.B \e*(lq 67369626Sru.TQ 67469626Sru.B \e*(rq 67569626SruLeft and right quote. 676151497Sru. 67769626SruThis is equal to `\e(lq' and `\e(rq', respectively. 678114402Sru. 679114402Sru.TP 680114402Sru.B \e*(HF 681114402SruThe typeface used to print headings and subheadings. 682151497Sru. 683114402SruThe default is `B'. 684114402Sru. 68569626Sru.PP 68669626SruIf a preprocessor like 68769626Sru.B @g@tbl 68869626Sruor 68969626Sru.B @g@eqn 690151497Sruis needed, it has become usage to make the first line of the 691151497Sru.I \%man\~page 692151497Srulook like this: 69369626Sru.PP 69469626Sru.RS 69569626Sru.BI .\e"\ word 69669626Sru.RE 69769626Sru.PP 69869626SruNote the single space character after the double quote. 69969626Sru.I word 70069626Sruconsists of letters for the needed preprocessors: `e' for 70169626Sru.BR @g@eqn , 70269626Sru`r' for 70369626Sru.BR @g@refer , 70469626Sruand `t' for 70569626Sru.BR @g@tbl . 70669626SruModern implementations of the 70769626Sru.B man 70869626Sruprogram read this first line and automatically call the right 70969626Srupreprocessor(s). 71069626Sru. 711114402Sru. 712114402Sru.\" ----------------------------------------------------------------- 713114402Sru. 71475584Sru.SH FILES 71575584Sru.TP 71675584Sru.B man.tmac 71775584Sru.TQ 71875584Sru.B an.tmac 71975584SruThese are wrapper files to call 72075584Sru.BR andoc.tmac . 72175584Sru.TP 72275584Sru.B andoc.tmac 72375584SruThis file checks whether the 72475584Sru.B man 72575584Srumacros or the 72675584Sru.B mdoc 72775584Srupackage should be used. 72875584Sru.TP 72975584Sru.B an-old.tmac 73075584SruAll 73175584Sru.B man 73275584Srumacros are contained in this file. 73375584Sru.TP 73475584Sru.B man.local 73575584SruLocal changes and customizations should be put into this file. 73675584Sru. 737114402Sru. 738114402Sru.\" ----------------------------------------------------------------- 739114402Sru. 74055839Sasmodai.SH "SEE ALSO" 74155839Sasmodai. 74275584SruSince the 74375584Sru.B man 74475584Srumacros consist of groups of 74575584Sru.I groff 74655839Sasmodairequests, one can, in principle, supplement the functionality of the 74775584Sru.B man 74875584Srumacros with individual 74955839Sasmodai.I groff 75055839Sasmodairequests where necessary. 751114402Sru. 752151497SruSee the 753151497Sru.I groff 754151497Sruinfo pages for a complete reference of all requests. 755151497Sru. 75669626Sru.PP 75769626Sru.BR @g@tbl (@MAN1EXT@), 75869626Sru.BR @g@eqn (@MAN1EXT@), 75969626Sru.BR @g@refer (@MAN1EXT@), 760151497Sru.BR man (1), 761151497Sru.BR man (7), 76255839Sasmodai. 763114402Sru. 764114402Sru.\" ----------------------------------------------------------------- 765114402Sru. 76655839Sasmodai.SH AUTHOR 76755839Sasmodai. 768151497SruThis manual page was originally written for the Debian GNU/Linux 769151497Srusystem by Susan G. Kleinmann <sgk@debian.org>, corrected and updated 770151497Sruby Werner Lemberg <wl@gnu.org>, and is now part of the GNU troff 771151497Srudistribution. 77279543Sru. 77379543Sru.\" Local Variables: 77479543Sru.\" mode: nroff 77579543Sru.\" End: 776