![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to prefer.1 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [Research Unix] / researchv10dc / man / man1|
Return to prefer.1 CVS log | Up to [Research Unix] / researchv10dc / man / man1 |
1.1 ! root 1: .tr @| ! 2: .TH PREFER 1 ! 3: .CT 1 writing_troff ! 4: .SH NAME ! 5: prefer, pinvert, penter, plook, pconvert \- maintain and use bibliographic references ! 6: .SH SYNOPSIS ! 7: .B prefer ! 8: [ ! 9: .I option ... ! 10: ] ! 11: .PP ! 12: .B penter ! 13: [ ! 14: .I outfile ! 15: ] ! 16: .PP ! 17: .B pinvert ! 18: [ ! 19: .I option ... ! 20: ] ! 21: [ ! 22: .I file ... ! 23: ] ! 24: .PP ! 25: .B plook ! 26: [ ! 27: .B -p ! 28: .I dbfile ! 29: ] ! 30: [ ! 31: .I keyword ... ! 32: ] ! 33: .PP ! 34: .B pconvert ! 35: [ ! 36: .B -d ! 37: ] ! 38: .I file ! 39: .SH DESCRIPTION ! 40: .I Prefer ! 41: is a ! 42: .IR troff (1) ! 43: preprocessor for bibliographic references. ! 44: It copies a document from the standard input ! 45: to the standard output, using a bibliographic database to ! 46: change symbolic references ! 47: into full references ready for typesetting by ! 48: .IR troff (1). ! 49: Although symbolic references are in the style of ! 50: .IR monk (1), ! 51: .I prefer ! 52: does not depend on ! 53: .I monk. ! 54: The options are: ! 55: .TF dbfile ! 56: .TP ! 57: .B -n ! 58: Format for ! 59: .IR nroff . ! 60: .TP ! 61: .BI -o sortkey ! 62: Under the ! 63: .B @reference_list ! 64: command, sort according to ! 65: .IR sortkey , ! 66: any combinations of the letters ! 67: .LR a ! 68: (author) ! 69: .LR d ! 70: (date), and ! 71: .LR t ! 72: (title), ! 73: rather than ! 74: in database sequence. ! 75: If ! 76: .I sortkey is ! 77: .LR sort , ! 78: sort according to the current style. ! 79: .TP ! 80: .BI -p dbfile ! 81: Use ! 82: .I dbfile ! 83: as the bibliographic database (default ! 84: .FR prefer.out ). ! 85: .TP ! 86: .B -r ! 87: Format as a released paper ! 88: (technical memorandum default). ! 89: .TP ! 90: .BI -s style ! 91: Set the formatting ! 92: .I style , ! 93: one of ! 94: .LR att ! 95: (default), ! 96: .LR acm , ! 97: .LR apa , ! 98: .LR ieee , ! 99: .LR lsa , ! 100: .LR pami , ! 101: .LR spectrum . ! 102: .PD ! 103: .PP ! 104: .I Prefer ! 105: recognizes the following commands, ! 106: which may appear anywhere in a document. ! 107: Parentheses ! 108: .B () ! 109: in the commands ! 110: may be replaced by any of ! 111: .B "{} [] <>". ! 112: .TP ! 113: .BI @reference_style( " style arg ..." ) ! 114: Switch to a new formatting style. ! 115: All previous references are forgotten ! 116: and a new list of references is begun. ! 117: If ! 118: .I style ! 119: is ! 120: .B same ! 121: the current style remains (but all previous references are forgotten). ! 122: Optional ! 123: .IR args ! 124: are: ! 125: .RS ! 126: .TF sequence ! 127: .TP ! 128: .BR tm ! 129: Format as a technical memorandum. ! 130: .TP ! 131: .B rp ! 132: Format as a released paper. ! 133: .TP ! 134: .B nroff ! 135: Format for ! 136: .I nroff. ! 137: .TP ! 138: .B troff ! 139: Format for ! 140: .I troff. ! 141: .TP ! 142: .B sort ! 143: Print a ! 144: .B @reference_list ! 145: in an order appropriate for the current style. ! 146: .TP ! 147: .B sequence ! 148: Print a ! 149: .B @reference_list ! 150: in database sequence. ! 151: .TP ! 152: .I sortkey ! 153: Print a ! 154: .B @reference_list ! 155: according to the ! 156: .IR sortkey , ! 157: any combination of the letters ! 158: .LR a , ! 159: .LR d , ! 160: .LR t ! 161: as above. ! 162: .PD ! 163: .RE ! 164: .TP ! 165: .BI @reference( keywords ! 166: .I %ref_fields ! 167: .IB %flags ) ! 168: .br ! 169: Insert a citation mark ! 170: in the current style ! 171: (e.g. [7], \s-2\v'-0.4m'3\v'0.4m'\s+2, (Knuth, 1975)). ! 172: One or more ! 173: .I keywords ! 174: cause selection from the bibliographic database. ! 175: Each ! 176: .B % ! 177: argument must begin a new line. ! 178: .I %ref_field ! 179: lines override information from the database; ! 180: with no ! 181: .I keywords ! 182: a complete reference ! 183: may be given. ! 184: For the form of reference fields, see the output of ! 185: .I penter ! 186: or the paper in Volume 2. ! 187: The following ! 188: .I %flags ! 189: may modify the citation. ! 190: .RS ! 191: .TF posttextstring ! 192: .TP ! 193: .B %no_author ! 194: Exclude author information. ! 195: .TP ! 196: .B %no_date ! 197: Exclude date from the citation mark. ! 198: .TP ! 199: .B %no_cite ! 200: Omit the entire citation, but include the entry in the final reference list. ! 201: .TP ! 202: .BI %pre_text " string ! 203: Insert ! 204: .I string ! 205: before the citation mark. ! 206: .TP ! 207: .BI %post_text " string ! 208: Insert ! 209: .I string ! 210: after the citation mark ! 211: .PD ! 212: .RE ! 213: .TP ! 214: .BI @reference_include( " dbfile ..." ) ! 215: Include the contents of the database(s) ! 216: .I dbfile(s) ! 217: in the list of references, ! 218: treating them as ! 219: .B %no_cite ! 220: entries. ! 221: .TP ! 222: .B @reference_placement ! 223: Produce a list of all references specified in ! 224: .B @reference ! 225: or ! 226: .B @reference_include ! 227: commands since ! 228: the beginning of the document or the last ! 229: .B @reference_style ! 230: or ! 231: .BR @reference_placement . ! 232: .TP ! 233: .BI @reference_list( " dbfile ..." ) ! 234: Format the contents of the database(s) ! 235: .IR dbfile . ! 236: .TP ! 237: .BI @\^reference_database( " dbfile " ) ! 238: Switch to database ! 239: .I dbfile ! 240: .PP ! 241: .I Penter ! 242: helps build ! 243: .I prefer ! 244: bibliographic databses. ! 245: It prompts for a reference type, ! 246: and then for admissible attributes, such as author, date, etc. ! 247: A default value proposed in brackets ! 248: .B [] ! 249: may be accepted by typing a newline, ! 250: skipped by typing spaces before the newline, ! 251: or overridden by typing a new value. ! 252: The character ! 253: .L & ! 254: appended to an attribute causes ! 255: .I penter ! 256: to prompt for the attribute again ! 257: (to enter multiple authors, for example). ! 258: .PP ! 259: The answer ! 260: .L ? ! 261: to the initial prompt gets a list of all reference types. ! 262: The answer ! 263: .L help ! 264: gets a subprompt for a reference type ! 265: whose pertinent attributes will then be listed. ! 266: The answer ! 267: .L ? ! 268: to the subprompt gets attributes for every type. ! 269: .PP ! 270: The attribute ! 271: .B also ! 272: permits one entry to refer to another ! 273: by naming keywords for ! 274: the other reference. ! 275: An entire `also' citation may be included within a ! 276: .B @reference ! 277: thus: ! 278: .br ! 279: .ns ! 280: .IP ! 281: .EX ! 282: %also_begin \fItext\fP ! 283: \fI%ref_fields\fP ! 284: %also_end ! 285: .EE ! 286: .PP ! 287: The attribute ! 288: .B keywords ! 289: prompts for distinguishing keys for the current entry, in addition to ! 290: those already occurring within author, title, etc. ! 291: .PP ! 292: The `reference type' ! 293: .B quit ! 294: causes ! 295: .I penter ! 296: to exit, first appending the collected database information to ! 297: .I outfile ! 298: .RF ( prefer.out ! 299: by default). ! 300: .PP ! 301: The `attribute' ! 302: .B ~e ! 303: permits editing of the current reference with the editor ! 304: specified by environment variable ! 305: .BR EDITOR , ! 306: .IR ed (1) ! 307: by default; ! 308: .B ~v ! 309: gets the editor ! 310: .BR VISUAL , ! 311: .IR vi (1) ! 312: by default. ! 313: .PP ! 314: .I Pinvert ! 315: creates an inverted index to one or more bibliographic database ! 316: .I files. ! 317: The index is placed in ! 318: .IB file .i , ! 319: where ! 320: .I file ! 321: is the first input file. ! 322: An associated ! 323: .IB file .h ! 324: contains the names of the input files. ! 325: The options are: ! 326: .TF commmon ! 327: .TP ! 328: .BI -c common ! 329: Do not index words listed in file ! 330: .I common ! 331: (default ! 332: .FR /usr/lib/eign ). ! 333: .TP ! 334: .BI -i ignore ! 335: Do not index information about attributes listed in file ! 336: .I ignore. ! 337: (The default ! 338: .F /usr/lib/prefer/ignore ! 339: lists ! 340: .BR %volume , ! 341: .BR %number , ! 342: .BR %part , ! 343: .BR %pages , ! 344: .B %X ! 345: (location status), ! 346: .B %Y ! 347: (read status), ! 348: .B %Z ! 349: (comment).) ! 350: .TP ! 351: .BI -k i ! 352: Maximum number of keys kept per record (default 100). ! 353: .TP ! 354: .BI -l i ! 355: Maximum length of keywords (default 6, none is less than 3). ! 356: .TP ! 357: .BI -p file ! 358: The basename of the index is ! 359: .I file. ! 360: Prefer will write the index to ! 361: .IB file .i . ! 362: .TP ! 363: .B -v ! 364: Verbose. ! 365: Print statistics. ! 366: .PD ! 367: .PP ! 368: .I Plook ! 369: uses the inverted index to ! 370: retrieve bibliographic records by ! 371: .I keywords ! 372: from the command line ! 373: or the standard input. ! 374: Records that contain all the keywords in the request ! 375: are sent to ! 376: the standard output. ! 377: Option ! 378: .B -p ! 379: is the same as for ! 380: .I pinvert. ! 381: .PP ! 382: .I Pconvert ! 383: converts a ! 384: .IR refer (1) ! 385: database to ! 386: .I prefer ! 387: style. ! 388: Under option ! 389: .B -d ! 390: it converts ! 391: .IR refer -style ! 392: commands in a document to ! 393: .I prefer ! 394: style. ! 395: .ig ! 396: .SH EXAMPLES ! 397: .EX ! 398: @\^reference_style<apa> ! 399: A keyword citation@reference<awk tm 1985> in the middle of a line. ! 400: .br ! 401: A complete citation ! 402: .br ! 403: @reference( ! 404: .br ! 405: %post_text , Chapter 6 ! 406: .br ! 407: %type book ! 408: .br ! 409: %author Aho, Alfred V. ! 410: .br ! 411: %author Sethi, Ravi ! 412: .br ! 413: %author Ullman, Jeffrey D. ! 414: .br ! 415: %title Compilers, Principles, Techniques, and Tools ! 416: .br ! 417: %publisher Addison-Wesley ! 418: .br ! 419: %address Reading, Massachusetts ! 420: .br ! 421: %date 1986 ). ! 422: .br ! 423: \&.ce ! 424: Bibliography ! 425: @\^reference_placement ! 426: .. ! 427: .SH FILES ! 428: .TF /usr/lib/prefer/mypubenter ! 429: .TP ! 430: .F prefer.out ! 431: default database ! 432: .TP ! 433: .F prefer.out.i ! 434: default index file ! 435: .TP ! 436: .F prefer.out.h ! 437: default header file containing names of databases ! 438: .TP ! 439: .F /usr/lib/eign ! 440: default list of common words ! 441: .TP ! 442: .F /usr/lib/prefer/ignore ! 443: default list of ! 444: .I %ref_fields ! 445: to ignore for indexing ! 446: .TP ! 447: .F /usr/lib/prefer/styles/* ! 448: .I awk ! 449: scripts of formatting instructions for each style ! 450: .TP ! 451: .F /tmp/prefer* ! 452: scratch file ! 453: .TP ! 454: .F /usr/lib/prefer/ptemplate ! 455: reference type definitions, self-describing ! 456: .TP ! 457: .F /usr/lib/prefer/mypubenter ! 458: program executed by penter ! 459: .SH ! 460: .SH SEE ALSO ! 461: M. A. Derr, ! 462: `Formatting References with Prefer', ! 463: this manual, Volume 2 ! 464: .br ! 465: .IR refer (1), ! 466: .IR monk (1), ! 467: .IR troff (1) ! 468: .SH BUGS ! 469: .I Prefer ! 470: commands don't work immediately after certain ! 471: formatting macros, e.g. .SM, .I, .B. ! 472: .br ! 473: .I Plook ! 474: complains if the first key matches more references than it can store. ! 475: Try rearranging your request so a less common word comes first. ! 476: .br ! 477: .I Pinvert ! 478: does not record options ! 479: .B -c ! 480: and ! 481: .BR -l . ! 482: If you use them with ! 483: .I pinvert, ! 484: you will have to supply them for ! 485: .I prefer ! 486: and ! 487: .I plook ! 488: as well. ! 489: .tr @@
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.