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