share/doc/usd/18.msdiffs/ms.diffs

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