Annotation of 43BSDReno/share/doc/usd/21.msdiffs/ms.diffs, revision 1.1.1.1

1.1       root        1: .\" Copyright (c) 1983 Regents of the University of California.
                      2: .\" All rights reserved.  The Berkeley software License Agreement
                      3: .\" specifies the terms and conditions for redistribution.
                      4: .\"
                      5: .\"    @(#)ms.diffs    6.1 (Berkeley) 6/2/86
                      6: .\"
                      7: .nr LL 6.5i
                      8: .nr FL 6.0i
                      9: .if t .nr PD .5v
                     10: .if t .ds m \u\(ul\dm
                     11: .if n .ds m -m
                     12: .AM
                     13: .OH 'A Revised Version of \*ms''USD:21-%'
                     14: .EH 'USD:21-%''A Revised Version of \*ms'
                     15: .TL
                     16: A Revised Version of \*ms
                     17: .AU
                     18: Bill Tuthill
                     19: .AI
                     20: Computing Services
                     21: University of California
                     22: Berkeley, CA  94720
                     23: .PP
                     24: The \*ms macros have been slightly revised and re\%arranged for the
                     25: Berkeley Unix distribution.
                     26: Because of the rearrangement,
                     27: the new macros can be read by the computer
                     28: in about half the time required by the previous version of \*ms.
                     29: This means that output will begin to appear between ten seconds
                     30: and several minutes more quickly, depending on the system load.
                     31: On long files, however, the savings in total time are not substantial.
                     32: The old version of \*ms is still available as \*mos.
                     33: .PP
                     34: Several bugs in \*ms have been fixed, including
                     35: a bad problem with the .1C macro,
                     36: minor difficulties with boxed text,
                     37: a break induced by .EQ before initialization,
                     38: the failure to set tab stops in displays,
                     39: and several bothersome errors in the \fBrefer\fP macros.
                     40: Macros used only at Bell Laboratories have been removed.
                     41: There are a few extensions to previous \*ms macros,
                     42: and a number of new macros, but all the documented \*ms macros
                     43: still work exactly as they did before, and have the same names as before.
                     44: Output produced with \*ms should look like output produced with \*mos.
                     45: .PP
                     46: One important new feature is automatically numbered footnotes.
                     47: Footnote numbers are printed by means of a pre-defined string
                     48: (\e\(**\(**), which you invoke separately from .FS and .FE.
                     49: Each time it is used, this string increases the footnote number by one,
                     50: whether or not you use .FS and .FE in your text.
                     51: Footnote numbers will be superscripted on the phototypesetter
                     52: and on daisy-wheel terminals, but on low-resolution devices
                     53: (such as the lpr and a crt), they will be bracketed.
                     54: If you use \e\(**\(** to indicate numbered footnotes,
                     55: then the .FS macro will automatically include
                     56: the footnote number at the bottom of the page.
                     57: This footnote, for example, was produced as follows:\**
                     58: .DS
                     59: This footnote, for example, was produced as follows:\e\(**\(**
                     60: \&.FS
                     61: .sp -.2
                     62:        ...
                     63: \&.FE
                     64: .DE
                     65: .FS
                     66: If you never use the ``\e\(**\(**'' string,
                     67: no footnote numbers will appear anywhere in the text,
                     68: including down here.
                     69: The output footnotes will look exactly like
                     70: footnotes produced with \*mos.
                     71: .FE
                     72: If you are using \e\(**\(** to number footnotes,
                     73: but want a particular footnote to be marked with an asterisk or a dagger,
                     74: then give that mark as the first argument to .FS: \(dg
                     75: .DS
                     76: then give that mark as the first argument to .FS: \e(dg
                     77: \&.FS   \e(dg
                     78: .sp -.2
                     79:        ...
                     80: \&.FE
                     81: .DE
                     82: .FS \(dg
                     83: In the footnote, the dagger will appear where the footnote
                     84: number would otherwise appear, as on the left.
                     85: .FE
                     86: Footnote numbering will be temporarily suspended,
                     87: because the \e\(**\(** string is not used.
                     88: Instead of a dagger, you could use an asterisk *
                     89: or double dagger \(dd, represented as \|\e(dd.
                     90: .PP
                     91: Another new feature is a macro for printing theses
                     92: according to Berkeley standards.
                     93: This macro is called .TM, which stands for thesis mode.
                     94: (It is much like the .th macro in \*me.)
                     95: It will put page numbers in the upper right-hand corner;
                     96: number the first page; suppress the date;
                     97: and doublespace everything except quotes, displays, and keeps.
                     98: Use it at the top of each file making up your thesis.
                     99: Calling .TM defines the .CT macro for chapter titles,
                    100: which skips to a new page and moves the pagenumber to the center footer.
                    101: The .P1 (P one) macro can be used even without thesis mode
                    102: to print the header on page 1,
                    103: which is suppressed except in thesis mode.
                    104: If you want roman numeral page numbering,
                    105: use an ``.af\0PN\0i'' request.
                    106: .PP
                    107: There is a new macro especially for bibliography entries,
                    108: called .XP, which stands for exdented paragraph.
                    109: It will exdent the first line of the paragraph by \en(PI units,
                    110: usually 5n (the same as the indent for the first line of a .PP).
                    111: Most bibliographies are printed this way.
                    112: Here are some examples of exdented paragraphs:
                    113: .XP
                    114: Lumley, Lyle S., \fISex in Crustaceans: Shell Fish Habits,\fP\|
                    115: Harbinger Press, Tampa Bay and San Diego, October 1979.
                    116: 243 pages.
                    117: The pioneering work in this field.
                    118: .XP
                    119: Leffadinger, Harry A., ``Mollusk Mating Season: 52 Weeks, or All Year?''
                    120: in \fIActa Biologica,\fP\| vol. 42, no. 11, November 1980.
                    121: A provocative thesis, but the conclusions are wrong.
                    122: .LP
                    123: Of course, you will have to take care of
                    124: italicizing the book title and journal,
                    125: and quoting the title of the journal article.
                    126: Indentation or exdentation can be changed
                    127: by setting the value of number register PI.
                    128: .PP
                    129: If you need to produce endnotes rather than footnotes,
                    130: put the references in a file of their own.
                    131: This is similar to what you would do if you were
                    132: typing the paper on a conventional typewriter.
                    133: Note that you can use automatic footnote numbering
                    134: without actually having .FS and .FE pairs in your text.
                    135: If you place footnotes in a separate file,
                    136: you can use .IP macros with \e\(**\(**\| as a hanging tag;
                    137: this will give you numbers at the left-hand margin.
                    138: With some styles of endnotes,
                    139: you would want to use .PP rather then .IP macros,
                    140: and specify \e\(**\(** before the reference begins.
                    141: .PP
                    142: There are four new macros to help produce a table of contents.
                    143: Table of contents entries must be enclosed in .XS and .XE pairs,
                    144: with optional .XA macros for additional entries;
                    145: arguments to .XS and .XA specify the page number,
                    146: to be printed at the right.
                    147: A final .PX macro prints out the table of contents.
                    148: Here is a sample of typical input and output text:
                    149: .DS
                    150: \&.XS  ii
                    151: Introduction
                    152: \&.XA  1
                    153: Chapter 1: Review of the Literature
                    154: \&.XA  23
                    155: Chapter 2: Experimental Evidence
                    156: \&.XE
                    157: \&.PX
                    158: .sp .5
                    159: .lt 5.5i
                    160: .tl ''\fBTable of Contents\fP''
                    161: .ta 5i 5.5iR
                    162: .sp
                    163: Introduction  &        ii\|
                    164: Chapter 1: Review of the Literature &  1
                    165: Chapter 2: Experimental Evidence &     23
                    166: .sp .5
                    167: .DE
                    168: The .XS and .XE pairs may also be used in the text,
                    169: after a section header for instance,
                    170: in which case page numbers are supplied automatically.
                    171: However, most documents that require a table of contents
                    172: are too long to produce in one run,
                    173: which is necessary if this method is to work.
                    174: It is recommended that you do a table of contents
                    175: after finishing your document.
                    176: To print out the table of contents, use the .PX macro;
                    177: if you forget it, nothing will happen.
                    178: .PP
                    179: As an aid in producing text that will format correctly
                    180: with both \fBnroff\fP and \fBtroff\fP,
                    181: there are some new string definitions that define quotation marks
                    182: and dashes for each of these two formatting programs.
                    183: The \e\(**\^\u_\d string will yield two hyphens in \fBnroff\fP,
                    184: but in \fBtroff\fP it will produce an em dash\*-
                    185: like this one.
                    186: The \e\(**Q and \e\(**U strings will produce
                    187: `` and '' in \fBtroff\fP, but " in \fBnroff\fP.
                    188: (In typesetting, the double quote is traditionally considered bad form.)
                    189: .PP
                    190: There are now a large number of optional
                    191: foreign accent marks defined by the \*ms macros.
                    192: All the accent marks available in \*mos are present,
                    193: and they all work just as they always did.
                    194: However, there are better definitions available
                    195: by placing .AM at the beginning of your document.
                    196: Unlike the \*mos accent marks,
                    197: the accent strings should come \fIafter\fP\| the letter being accented.
                    198: Here is a list of the diacritical marks,
                    199: with examples of what they look like.
                    200: .DS
                    201: .ta 2i 3i
                    202: name of accent input           output
                    203: \l'3.5i'
                    204: acute accent   e\e\(**\'       e\*'
                    205: grave accent   e\e\(**\`       e\*`
                    206: circumflex     o\e\(**\d^\u    o\*^
                    207: cedilla        c\e\(**,        c\*,
                    208: tilde          n\e\(**\d~\u    n\*~
                    209: question       \e\(**?         \*?
                    210: exclamation    \e\(**!         \*!
                    211: umlaut         u\e\(**:        u\*:
                    212: digraph s      \e\(**8         \*8
                    213: hac\*vek       c\e\(**v        c\*v
                    214: macron         a\e\(**_        a\*_
                    215: underdot       s\e\(**.        s\*.
                    216: o-slash        o\e\(**/        o\*/
                    217: angstrom       a\e\(**o        a\*o
                    218: yogh           kni\e\(**3t     kni\*3t
                    219: Thorn          \e\(**(Th       \*(Th
                    220: thorn          \e\(**(th       \*(th
                    221: Eth            \e\(**(D-       \*(D-
                    222: eth            \e\(**(d-       \*(d-
                    223: hooked o       \e\(**q         \*q
                    224: ae ligature    \e\(**(ae       \*(ae
                    225: AE ligature    \e\(**(Ae       \*(Ae
                    226: oe ligature    \e\(**(oe       \*(oe
                    227: OE ligature    \e\(**(Oe       \*(Oe
                    228: .DE
                    229: If you want to use these new diacritical marks,
                    230: don't forget the .AM at the top of your file.
                    231: Without it, some will not print at all,
                    232: and others will be placed on the wrong letter.
                    233: .PP
                    234: It is also possible to produce custom headers and footers
                    235: that are different on even and odd pages.
                    236: The .OH and .EH macros define odd and even headers,
                    237: while .OF and .EF define odd and even footers.
                    238: Arguments to these four macros are specified as with .tl.
                    239: This document was produced with:
                    240: .DS
                    241: \&.OH  \'\ef\^IThe  -mx  Macros\'\'Page  %\ef\^P\'
                    242: \&.EH  \'\ef\^IPage  %\'\'The  -mx  Macros\ef\^P\'
                    243: .DE
                    244: Note that it would be a error to have an apostrophe in the header text;
                    245: if you need one, you will have to use a different delimiter
                    246: around the left, center, and right portions of the title.
                    247: You can use any character as a delimiter, provided it doesn't appear
                    248: elsewhere in the argument to .OH, .EH, .OF, or EF.
                    249: .PP
                    250: The \*ms macros work in conjunction with
                    251: the \fBtbl\fR, \fBeqn\fR, and \fBrefer\fR preprocessors.
                    252: Macros to deal with these items are read in only as needed,
                    253: as are the thesis macros (.TM),
                    254: the special accent mark definitions (.AM),
                    255: table of contents macros (.XS and .XE),
                    256: and macros to format the optional cover page.
                    257: The code for the \*ms package lives in /usr/lib/tmac/tmac.s,
                    258: and sourced files reside in the directory /usr/ucb/lib/ms.
                    259: .sp
                    260: .tl '''\*(DY'

unix.superglobalmegacorp.com

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