Annotation of 43BSDReno/usr.bin/refer/OTHERS/roffbib.1, revision 1.1.1.1

1.1       root        1: .\" Copyright (c) 1983, 1990 Regents of the University of California.
                      2: .\" All rights reserved.
                      3: .\"
                      4: .\" Redistribution and use in source and binary forms are permitted provided
                      5: .\" that: (1) source distributions retain this entire copyright notice and
                      6: .\" comment, and (2) distributions including binaries display the following
                      7: .\" acknowledgement:  ``This product includes software developed by the
                      8: .\" University of California, Berkeley and its contributors'' in the
                      9: .\" documentation or other materials provided with the distribution and in
                     10: .\" all advertising materials mentioning features or use of this software.
                     11: .\" Neither the name of the University nor the names of its contributors may
                     12: .\" be used to endorse or promote products derived from this software without
                     13: .\" specific prior written permission.
                     14: .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
                     15: .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
                     16: .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
                     17: .\"
                     18: .\"     @(#)roffbib.1  6.3 (Berkeley) 7/24/90
                     19: .\"
                     20: .Dd July 24, 1990
                     21: .Dt ROFFBIB 1
                     22: .Os BSD 4.2
                     23: .Sh NAME
                     24: .Nm roffbib
                     25: .Nd run off bibliographic database
                     26: .Sh SYNOPSIS
                     27: .Nm roffbib
                     28: .Op Fl e
                     29: .Op Fl h
                     30: .Op Fl n
                     31: .Op Fl o
                     32: .Op Fl r
                     33: .Op Fl s
                     34: .Oo
                     35: .Op Fl T Ar term
                     36: .Oo
                     37: .Op Fl x
                     38: .Op Fl m Ar mac
                     39: .Op Fl V
                     40: .Op Fl Q
                     41: .Ar
                     42: .Sh DESCRIPTION
                     43: .Nm Roffbib
                     44: is a shell script which prints out all records in a bibliographic database,
                     45: in bibliography format rather than as footnotes or endnotes.
                     46: Generally it is used in conjunction with
                     47: .Xr sortbib  :
                     48: .Pp
                     49: .Dl sortbib  database \&| roffbib
                     50: .Pp
                     51: .Nm Roffbib
                     52: accepts most of the options understood by
                     53: .Xr nroff  1  ,
                     54: such as the
                     55: .Fl T
                     56: flag to specify terminal type.
                     57: .Pp
                     58: If abstracts or comments are entered in the database following the %X field key,
                     59: .Nm roffbib
                     60: will format them into paragraphs for an annotated bibliography.
                     61: Several %X fields may be given if several
                     62: annotation paragraphs are desired.
                     63: .Pp
                     64: Options exclusive to
                     65: .Nm roffbib :
                     66: .Tp Fl x
                     67: Suppresses the printing of %X abstracts.
                     68: .Tp Fl V
                     69: Send output to the Versatec (use vtroff).
                     70: .Tp Fl Q
                     71: Queue the output to the default troff device.
                     72: .Tp
                     73: .Pp
                     74: If neither the
                     75: .Fl Q
                     76: or
                     77: .Fl V
                     78: flags are given,
                     79: .Nm
                     80: sends the output to the standard output.
                     81: The default macros for
                     82: .Nm
                     83: are in 
                     84: .Pa /usr/share/tmac/tmac.bib .
                     85: These can be over ridden by
                     86: specifying a user-defined set with the
                     87: .Fl m
                     88: option.
                     89: .Pp
                     90: Four command-line registers control formatting style
                     91: of the bibliography, much like the number registers of
                     92: .Xr ms  7  .
                     93: The command-line argument
                     94: .Cx Fl r
                     95: .Ar N1
                     96: .Cx
                     97: will number
                     98: the references starting at one  1 .
                     99: The flag
                    100: .Cx Fl r
                    101: .Ar V2
                    102: .Cx
                    103: will double space the biblio\%graphy,
                    104: while
                    105: .Cx Fl r
                    106: .Ar V1
                    107: .Cx
                    108: will double space references
                    109: but single space annotation paragraphs.
                    110: The line length can be changed from the default 6.5 inches
                    111: to 6 inches with the
                    112: .Cx Fl r
                    113: .Ar L6i
                    114: .Cx
                    115: argument,
                    116: and the page offset can be set from the default of 0
                    117: to one inch by specifying
                    118: .Cx Fl r
                    119: .Ar O1i
                    120: .Cx
                    121: (capital O, not zero).
                    122: Note: with the
                    123: .Fl V
                    124: and
                    125: .Fl Q
                    126: flags
                    127: the default page offset is already one inch.
                    128: .Pp
                    129: .Nm Roffbib
                    130: is limited, but it is a good script to copy and adopt
                    131: for one's own needs, as it does demonstrate usage of
                    132: .Xr refer 1 .
                    133: .Sh FILES
                    134: .Dw /usr/share/tmac/tmac.bib
                    135: .Di L
                    136: .Dp Pa /usr/bin/roffbib
                    137: .Nm
                    138: script.
                    139: .Dp Pa /usr/share/tmac/tmac.bib
                    140: file of macros used by
                    141: .Xr nroff 1
                    142: and
                    143: .Xr troff 1
                    144: .Dp
                    145: .Sh SEE ALSO
                    146: .Xr refer 1 ,
                    147: .Xr addbib 1 ,
                    148: .Xr sortbib 1 ,
                    149: .Xr indxbib 1 ,
                    150: .Xr lookbib 1
                    151: .Sh HISTORY
                    152: .Nm Roffbib
                    153: appeared in 4.2 BSD.
                    154: .Sh BUGS
                    155: Users have to rewrite macros
                    156: to create customized formats.

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.