[unix-history] / usr / man / man1 / refer.1

.TH REFER 1
.SH NAME
refer, lookbib \- find and insert literature references in documents
.SH SYNOPSIS
.B refer
[ option ] ...
.PP
.B lookbib
[ file ] ...
.SH DESCRIPTION
.I Lookbib
accepts keywords from the standard input 
and searches a bibliographic data base for references
that contain those keywords anywhere in title, author,
journal name, etc.
Matching references are printed on the standard output.
Blank lines are taken as delimiters between queries.
.PP
.I Refer
is a preprocessor for
.I nroff
or
.IR troff (1)
that finds and formats references.
The input files (standard input default) are copied to the standard output,
except for lines between .[ and .]
command lines, which are assumed to contain keywords as for
.I lookbib,
and are replaced by information from the bibliographic data base.
The user may avoid the search, override fields from it, or
add new fields.
The reference data, from whatever source, are assigned to a set of
.I troff
strings.
Macro packages such as
.IR ms (7)
print the finished reference text from these strings.
A flag is placed in the text at the point of reference;
by default the references are indicated by numbers.
.br
.sp
The following options are available:
.TP 6
.BI \-a r
Reverse the first
.I r
author names (Jones, J. A. instead of J. A. Jones).
If
.I r
is omitted all author names are reversed.
.ns
.TP
.B \-b
Bare mode: do not put any flags in text (neither numbers nor labels).
.ns
.TP
.BI \-c string
Capitalize (with C\s-2APS\s0 S\s-2MALL\s+2 C\s-2APS\s0)
the fields whose key-letters are in
.IR string .
.ns
.TP
.B \-e
Instead of leaving the references where encountered,
accumulate them
until a sequence of the form
.nf
		.[
		$LIST$
		.]
.fi
is encountered, and then write out all references
collected so far.  Collapse references to the same source.
.ns
.TP
.BI \-k x
Instead of numbering references, use labels as specified in
a
reference data line
beginning
.I %x;
by default 
.I x
is
.B L.
.ns
.TP
.BI \-l m , n
Instead of numbering references, use labels made from
the senior author's last name and the year of publication.
Only the first
.I m
letters of the last name
and the last
.I n
digits of the date are used.
If either
.I m
or
.BI , n
is omitted the entire name or date respectively is used.
.ns
.TP
.B \-p
Take the next argument as a file of
references to be searched.
The default file is searched last.
.ns
.TP
.B \-n
Do not search the default file.
.ns
.TP
.BI \-s keys
Sort references by fields whose key-letters are in
the
.I keys
string;
permute
reference numbers in text accordingly.
Implies
.BR \-e .
The key-letters in
.I keys
may be followed by a number to indicate how many such fields
are used, with
.B +
taken as a very large number.
The default is
.B AD
which sorts on the senior author and then date; to sort, for example,
on all authors and then title use
.BR -sA+T .
.PP
To use your own references, put them in the format
described in
.IR pubindex (1)
They can be searched
more rapidly by running
.IR pubindex (1)
on them before using
.I refer;
failure to index results in a linear search.
.PP
When
.I refer
is used with
.I eqn,
.I neqn
or
.I tbl,
.I refer
should be first, to minimize the volume
of data passed through
pipes.
.SH FILES
.I /usr/dict/papers
directory of default publication lists and indexes
.br
.I /usr/lib/refer
directory of programs
.SH SEE ALSO
.br
Commit	Line	Data
e6817382 BJ	1	.TH REFER 1
	2	.SH NAME
	3	refer, lookbib \- find and insert literature references in documents
	4	.SH SYNOPSIS
	5	.B refer
	6	[ option ] ...
	7	.PP
	8	.B lookbib
	9	[ file ] ...
	10	.SH DESCRIPTION
	11	.I Lookbib
	12	accepts keywords from the standard input
	13	and searches a bibliographic data base for references
	14	that contain those keywords anywhere in title, author,
	15	journal name, etc.
	16	Matching references are printed on the standard output.
	17	Blank lines are taken as delimiters between queries.
	18	.PP
	19	.I Refer
	20	is a preprocessor for
	21	.I nroff
	22	or
	23	.IR troff (1)
	24	that finds and formats references.
	25	The input files (standard input default) are copied to the standard output,
	26	except for lines between .[ and .]
	27	command lines, which are assumed to contain keywords as for
	28	.I lookbib,
	29	and are replaced by information from the bibliographic data base.
	30	The user may avoid the search, override fields from it, or
	31	add new fields.
	32	The reference data, from whatever source, are assigned to a set of
	33	.I troff
	34	strings.
	35	Macro packages such as
	36	.IR ms (7)
	37	print the finished reference text from these strings.
	38	A flag is placed in the text at the point of reference;
	39	by default the references are indicated by numbers.
	40	.br
	41	.sp
	42	The following options are available:
	43	.TP 6
	44	.BI \-a r
	45	Reverse the first
	46	.I r
	47	author names (Jones, J. A. instead of J. A. Jones).
	48	If
	49	.I r
	50	is omitted all author names are reversed.
	51	.ns
	52	.TP
	53	.B \-b
	54	Bare mode: do not put any flags in text (neither numbers nor labels).
	55	.ns
	56	.TP
	57	.BI \-c string
	58	Capitalize (with C\s-2APS\s0 S\s-2MALL\s+2 C\s-2APS\s0)
	59	the fields whose key-letters are in
	60	.IR string .
	61	.ns
	62	.TP
	63	.B \-e
	64	Instead of leaving the references where encountered,
65	accumulate them
66	until a sequence of the form
67	.nf
68	.[
69	$LIST$
70	.]
71	.fi
72	is encountered, and then write out all references
73	collected so far. Collapse references to the same source.
74	.ns
75	.TP
76	.BI \-k x
77	Instead of numbering references, use labels as specified in
78	a
79	reference data line
80	beginning
81	.I %x;
82	by default
83	.I x
84	is
85	.B L.
86	.ns
87	.TP
88	.BI \-l m , n
89	Instead of numbering references, use labels made from
90	the senior author's last name and the year of publication.
91	Only the first
92	.I m
93	letters of the last name
94	and the last
95	.I n
96	digits of the date are used.
97	If either
98	.I m
99	or
100	.BI , n
101	is omitted the entire name or date respectively is used.
102	.ns
103	.TP
104	.B \-p
105	Take the next argument as a file of
106	references to be searched.
107	The default file is searched last.
108	.ns
109	.TP
110	.B \-n
111	Do not search the default file.
112	.ns
113	.TP
114	.BI \-s keys
115	Sort references by fields whose key-letters are in
116	the
117	.I keys
118	string;
119	permute
120	reference numbers in text accordingly.
121	Implies
122	.BR \-e .
123	The key-letters in
124	.I keys
125	may be followed by a number to indicate how many such fields
126	are used, with
127	.B +
128	taken as a very large number.
129	The default is
130	.B AD
131	which sorts on the senior author and then date; to sort, for example,
132	on all authors and then title use
133	.BR -sA+T .
134	.PP
135	To use your own references, put them in the format
136	described in
137	.IR pubindex (1)
138	They can be searched
139	more rapidly by running
140	.IR pubindex (1)
141	on them before using
142	.I refer;
143	failure to index results in a linear search.
144	.PP
145	When
146	.I refer
147	is used with
148	.I eqn,
149	.I neqn
150	or
151	.I tbl,
152	.I refer
153	should be first, to minimize the volume
154	of data passed through
155	pipes.
156	.SH FILES
157	.I /usr/dict/papers
158	directory of default publication lists and indexes
159	.br
160	.I /usr/lib/refer
161	directory of programs
162	.SH SEE ALSO
163	.br