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