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