.lf 1 -
.lf 1 ./idref.0
.\" Description: idref man page
.\" $Id: ~|^` @(#)idref.0 1.5 2005/05/24 16:34:17 copyright 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 ./idref.hw
.lf 26 ./idref.0
.lg 0	.\" avoid groff's butt-ugly ligatures
.ds ]W \" no 7th Edition designation
.TH idref 1 "release 1.5"
.\"	.DS .DE for -man	##############################################
.lf 1 ./keepmacro.s
.\"	.DS .DE for -man	##############################################
.\"	@(#) keepmacro.s 0.58.0.0 202004/04/25 19:14:21 Bruce Lilly extracted 202005/05/18 10:48:51
.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 ./idref.0
.SH NAME	\" 1 line	name \- explanatory text
.B idref
\- look up Internet\-Draft references
.SH SYNOPSIS
.PP
.B idref [files]
.SH DESCRIPTION
.PP
.B Idref
is a preprocessor
for resolving and formatting
Internet\-Draft references.
.PP
This software is OSI Certified Open Source Software.
OSI Certified is a certification mark of the Open Source Initiative.
.PP
.B Idref
recognizes a reference directive
and replaces it with suitable
rfc macro directives and text for
formatting references to Internet\-Drafts.
The directive takes up to four arguments.
The first argument must be either I
(for an informative reference) or
N (for a normative reference).
A reference designation is supplied as the
second argument,
and is used in the reference tag.
The third argument is the
draft file name without the trailing hyphen, version suffix, and format suffix.
The optional fourth argument is a string name in which
the reference tag will be saved by the formatter.
.SH EXAMPLES
.PP
.DS
\&.DR I Lilly draft\-lilly\-using\-troff r1
.DE
specifies an informative reference to the current version of
draft\-lilly\-using\-troff
using "Lilly" in the reference tag,
with the reference tag saved in string r1.
.SH RETURN VALUE
.B Idref
returns zero unless a serious error occurs.
.SH BUGS and CAVEATS
.PP
Reference file 1id\-index.txt
needs to be kept up\-to\-date
in order to refer to recent drafts,
and to use the current versions of drafts.
.SH DIAGNOSTICS
.PP
.B Idref
will produce warning and error messages during formatting
when appropriate.
Error messages indicate a problem which has
prevented processing of a directive,
such as invalid syntax or a non\-existant
draft.
.SH AUTHOR
Bruce Lilly <blilly@erols.com>