.lf 1 - .lf 1 ./ididrfcrfc.0 .\" Description: IDIDRFCRFC man page .\" $Id: ~|^` @(#)ididrfcrfc.0 2.7 2005/06/16 23:34:25 copyright 2001, 2002, 2003, 2004, 2005 Bruce Lilly $ .\" common man macros to V7, V10, DWB2 (unique ones omitted, differences noted) .\" .TH n c x V7,10 begin page n of chapter c; x is extra commentary .\" .TH t s c n DWB2 beg. pg. t of sect. s; c=extra comment, n=new man. name .\" c appears at bottom center of page, n at top center .\" .SH text subhead .\" .SS text sub-subhead .\" .B text make text bold .\" .I text make text italic .\" .SM text make text 1 point smaller than default .\" .RI a b concatenate and alternate Roman, Italic fonts <=6 args .\" .IR .RB .BR .IB .BI similar to .RI .\" .PP new paragraph .\" .HP in hanging paragraph with indent in .\" .TP in indented paragraph with hanging tag (on next line) .\" .IP t in indented paragraph with hanging tag t (arg 1) .\" .RS in increase relative indent by in .\" .RE k return to kth relative indent level (1-based) .\" .DT default tab settings .\" .PD v inter-paragraph spacing v (default 0.4v troff, 1v nroff) .\" \*R registered symbol (Reg.) .\" \*S change to default type size .\" prevent hyphenation of function names, etc. .lf 1 ./ididrfcrfc.hw .lf 26 ./ididrfcrfc.0 .lg 0 \" avoid groff's butt-ugly ligatures .ds ]W \" no 7th Edition designation .TH IDIDRFCRFC 1 "release 2.7" .\" .DS .DE for -man ############################################## .lf 1 ./keepmacro.s .\" .DS .DE for -man ############################################## .\" @(#) keepmacro.s 0.58.0.0 2004/04/25 19:14:21 Bruce Lilly extracted 2004/07/26 02:05:35 .nr dD 0 \" not in keep .de DS \" keep (display) start .ie \\n(dD .tm WARNING: \\n(.F line \\n(.c: nested .DS .el \{.nr dD 1 \" in keep .nr dI \\n(IN \" current indent .nr dL \\n(LL \" current line length .if !\\n(dL .nr dL 6.5i \" make sure line length is not zero (default is 6.5i) .br \" finish current output .ev 1 \" set new environment for keep .in \\n(dIu \" set environment indent .ll \\n(dLu \" and line length same as page .di dC\} \" divert content into diversion dC .. .de DE \" keep (display) end .ie !\\n(dD .tm WARNING: \\n(.F line \\n(.c: .DE without .DS .el \{.br .di \" end keep diversion .ev \" pop keep environment .nr dH \\n(dn \" diversion height .nr dD 0 \" not in keep 'ne \\n(dHu \" break page if diversion won't fit on current page .ev 2 \" new environment for interpolation .in 0i \" zero indent for interpolating formatted diversion .ll \\n(dLu \" line length same as page .nf \" no fill mode for interpolating formatted content 'dC \" interpolate diverted content .br \" finish output .rm dC \" finished with diverted content .ev\} \" pop interpolation environment .. .\" ########################### end of keep macros ########################### .lf 31 ./ididrfcrfc.0 .\" .TS [H], .TH [N] (redefinition), .TE for tables with -man ####### .lf 1 ./tblmacro.s .\" .TS [H], .TH [N] (redefinition), .TE for tables with -man ####### .\" @(#) tblmacro.s 1.5.0.0 2005/03/11 21:50:57 Bruce Lilly extracted 2005/03/11 21:53:59 .rm TS xH rH T& TE .de TS \" table start .rn TH tH \" move title heading out of way for table heading .rn xH TH \" table heading in effect for .TH .sp \\n(PDu \" inter-paragraph space (paragraph distance) .nr tI \\n(IN \" current indent .nr tL \\n(LL \" current line length .if !\\n(tL .nr tL 6.5i \" make sure line length is not zero (default is 6.5i) .if x\\$1xHx .wh 1i rH \" 1i page trap after new page header .ev 1 \" set new environment for table; avoid gtbl polluting page environment .in \\n(tIu \" set environment indent .ll \\n(tLu \" and line length same as page .ie x\\$1xHx \{'ne 5v .nr tH 1 \" .TS H .if \\n(dD .tm WARNING: \\n(.F line \\n(.c: .TS H within .DS .di hT\} \" divert heading into diversion hT .el .nr tH 0 \" not .TS H .. .de xH \" becomes TH for tables .br .di \" end diversion hT .nr tH 0 \" finished .TH .ev 2 \" new environment for interpolating formatted header .in 0i \" zero indent for interpolating formatted diversion .ll \\n(tLu \" line length same as page .nf \" no fill mode for interpolating formatted header .ie x\\$1xNx .if !\\n(tN .hT \" interpolate header if .TH N and 1st table on page .el .hT \" or if no N arg .br .ev \" pop environment .nr iT 1 \" in table (with header) .. .de rH \" repeat header via page trap .if \\n(iT \{.ev 2 \" do nothing if not in table .nr tN 0 \" no tables yet on new page .in 0i \" zero indent for interpolating formatted diversion .ev \" pop environment .ch rH 99i \" avoid retriggering page trap .ev 2 \" push environment back .sp |1i \" ensure correct position .nf \" no fill mode for interpolating formatted header .hT \" interpolate table header .ev \" pop environment .br .ch rH 1i \" restore page trap .\} \" pop environment .. .de TE \" table end .if \\n(tH \{.tm WARNING: \\n(.F line \\n(.c: .TS H without .TH .di\} .rn TH xH \" hide table heading macro .rn tH TH \" restore title heading macro for .TH .rm hT \" finished with diverted heading .nr iT 0 \" not in table .nr tN 1 \" at least 1 table output on this page .ev \" pop table environment .sp \\n(PDu \" inter-paragraph space (paragraph distance) .. .\" ########################### end of table macros ########################### .lf 33 ./ididrfcrfc.0 .SH NAME \" 1 line name \- explanatory text .B IDIDRFCRFC \- Indispensable, Detailed Internet-Draft/RFC Reviewer's Flaw Checklist .SH SYNOPSIS .PP .B nroff tmac.ididrfcrfc [file] .SH DESCRIPTION .PP .B IDIDRFCRFC is a set of troff/nroff macros and review checklist template used to generate reviews of RFCs and Internet Drafts. .SH "IDIDRFCRFC MACROS AND DOCUMENT FORMAT .PP A review document is generated by specifying document content and then processing with .BR nroff . First, one specifies which draft or RFC is being reviewed, and by whom. A draft is specified by setting the draft file name using the FN macro. The draft version suffix is specified with the NU macro, and is a negative number for drafts: -1 for draft version suffix -00, -2 for draft suffix -01, etc. For RFCs, use the NU macro to specify the RFC number as a positive integer. .PP The reviewer is specified with an AU macro, which takes 9 arguments: .TS H lw(0.8i) cw(4.7i). Argument Description .\" N.B. the following trick ensures consistent nroff/troff spacing for rules across the table .\" the idea is (in troff) to save the vertical position, space down to vertically center the rule (or double rule) in 1P .\" emit the rule, then move to a vertical position 1P below the saved position (to match nroff) .mk vP .if t .sp 0.33P _ .if t .sp |\n(vPu+1P .TH .T& c l. 1 T{ First initial and surname for first page heading T} 2 T{ First name and/or initials for Reviewer's Address section T} 3 T{ Surname for page footer and Reviewer's Address section T} 4 T{ Gender; one of m (male), f (female), or o (other or indeterminate) T} 5 Internet mailbox 6 Telephone Number 7 Fax Number 8 URL 9 Affiliation .TE .PP Text following the AU macro line until the next IDIDRFCRFC macro directive is taken as a postal mailing address. Multiple reviewers (up to 9) may be specified by using multiple AU macro directives. .PP Paragraphs of review text may be specified and included or excluded in the generated document by using the following macro directives: .TS H lw(0.8i) cw(4.7i). Directive Description .\" N.B. the following trick ensures consistent nroff/troff spacing for rules across the table .\" the idea is (in troff) to save the vertical position, space down to vertically center the rule (or double rule) in 1P .\" emit the rule, then move to a vertical position 1P below the saved position (to match nroff) .mk vP .if t .sp 0.33P _ .if t .sp |\n(vPu+1P .TH .T& c l. LP Left\-aligned block paragraph, output LX ignored (not output) IP Indented block paragraph, output IX ignored (not output) .TE .PP Lists of items may be specified with list macro directives: .TS H lw(0.8i) cw(4.7i). Directive Description .\" N.B. the following trick ensures consistent nroff/troff spacing for rules across the table .\" the idea is (in troff) to save the vertical position, space down to vertically center the rule (or double rule) in 1P .\" emit the rule, then move to a vertical position 1P below the saved position (to match nroff) .mk vP .if t .sp 0.33P _ .if t .sp |\n(vPu+1P .TH .T& c l. VL variable (checked, unchecked, or ignored) items BL bullet list NL numbered list .TE .PP Within a list, list items are specified with one of the following macro directives: .TS H lw(0.8i) cw(4.7i). Directive Description .\" N.B. the following trick ensures consistent nroff/troff spacing for rules across the table .\" the idea is (in troff) to save the vertical position, space down to vertically center the rule (or double rule) in 1P .\" emit the rule, then move to a vertical position 1P below the saved position (to match nroff) .mk vP .if t .sp 0.33P _ .if t .sp |\n(vPu+1P .TH .T& c l. LI ignored (not output) list item CI checked (in VL), bullet, or numbered item UI unchecked (in VL), bullet, or numbered item .TE .PP The LE macro directive terminates a list. Lists may be nested up to 9 levels deep. .PP Quoted material such as output from a validation suite may be included within a display. The DS and DE macro directives bracket material to be quoted. The DS macro directive takes and argument to indicate the type of display: .TS H lw(0.8i) cw(4.7i). Directive Description .\" N.B. the following trick ensures consistent nroff/troff spacing for rules across the table .\" the idea is (in troff) to save the vertical position, space down to vertically center the rule (or double rule) in 1P .\" emit the rule, then move to a vertical position 1P below the saved position (to match nroff) .mk vP .if t .sp 0.33P _ .if t .sp |\n(vPu+1P .TH .T& c l. DS B centered as a block DS C each line centered DS I each line indented DS L left justified .TE .PP Displays following an ignored paragraph or list item (LX, IX, or LI directives) are not output. .PP There are several mechanisms for indicating references. Three low-level mechanisms are provided: the IR/IE bracketing directives for a reference which is ignored (i.e. not output), NR/NE directives for normal (output) references which include an inline reference tag, and XR/XE directives which include a reference citation but no inline tag. The IR, NR, and XR directives take up to two optional arguments: a reference tag which follows the automatically numbered reference designation, and a string name for saving the reference tag. The .B rfcref preprocessor may be used to generate IR/IE, NR/NE, and XR/XE references from BR, FR, RR, and/or SR lines specifying BCP, FYI, RFC, and STD documents by document number. .PP The source document must end with an EM macro directive, which outputs the reference citations and reviewer's contact information. .PP Tables, graphs, mathematics (representable as text), etc. may be included in a review by using preprocessors. .SH "TEMPLATE DOCUMENT .PP IDIDRFCRFC includes a template document which can be easily modified to customize a review (by editing macro directives and adding text). .SH DIAGNOSTICS .PP .B IDIDRFCRFC emits warning and error messages on the standard error stream. It indicates errors if the input specification is faulty in a way that precludes sensible parsing; less serious issues result in warnings. .SH SEE ALSO .BR nroff(1) , .BR rfcref(1) , .BR tbl(1) , .BR abnff(1) , .BR pic(1) , .BR grap(1) , .BR eqn(1) . .SH AUTHOR Bruce Lilly