Return to mx.doc CVS log

Up to [CSRG BSD Unix] / 43BSDReno / share / doc / usd / 29.refer

Annotation of 43BSDReno/share/doc/usd/29.refer/mx.doc, revision 1.1

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

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.