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