.lf 1 - .lf 1 ./rfcref.0 .\" Description: rfcref man page .\" $Id: ~|^` @(#)rfcref.0 1.13 2006/01/13 04:06:22 copyright 2005, 2006 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 ./rfcref.hw .hw up-to-date .lf 26 ./rfcref.0 .lg 0 .\" avoid groff's butt-ugly ligatures .ds ]W \" no 7th Edition designation .TH rfcref 1 "release 1.13" .\" .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 2005/04/17 14:29:02 .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 ./rfcref.0 .SH NAME \" 1 line name \- explanatory text .B rfcref \- look up RFC, BCP, FYI, STD references .SH SYNOPSIS .PP .B rfcref [files] .SH DESCRIPTION .PP .B Rfcref is a preprocessor for resolving numeric RFC, BCP, FYI, and STD references. .PP This software is OSI Certified Open Source Software. OSI Certified is a certification mark of the Open Source Initiative. .PP .B Rfcref recognizes four reference directives and replaces them with suitable rfc macro directives and text for formatting references to RFCs. Each directive takes up to three arguments. The first argument must be either I (for an informative reference) or N (for a normative reference). The second argument is the document series number, e.g. 1234 for RFC 1234. The optional third argument is a string name in which the reference tag will be saved by the formatter. .PP Because .B rfcref is a preprocessor, the numeric argument must be specified directly; one cannot refer to troff registers, etc. .SH EXAMPLES .PP .DS \&.BR I 18 .DE specifies an informative reference to BCP\ 18, with no string name specified. .PP .DS \&.FR I 3 .DE specifies an informative reference to FYI\ 3, with no string name specified. .PP .DS \&.SR N 3 .DE specifies a normative reference to STD\ 3, with no string name specified. .PP .DS \&.RR N 1234 r1 .DE specifies a normative reference to RFC\ 1234, with the reference tag saved in string r1. .SH RETURN VALUE .B Rfcref returns zero unless a serious error occurs. .SH BUGS and CAVEATS .PP Reference files bcp\-index.txt, fyi\-index.txt, std\-index.txt, and rfc\-index.txt, need to be kept up\-to\-date in order to refer to recent documents. .PP Some STD documents map to multiple RFCs. If a string name is specified, it will only hold the reference tag for the first RFC in such cases. .PP Some STD document numbers are reserved or no longer in use. .SH DIAGNOSTICS .PP .B Rfcref will produce warning and error messages during formatting when appropriate. Informative warnings include notifications about updated or obsoleted RFCs which are referenced. Error messages indicate a problem which has prevented processing of a directive, such as invalid syntax or a non\-existant document. .SH AUTHOR Bruce Lilly