Annotation of src/share/tmac/README, Revision 1.1
1.1 ! deraadt 1: .\" Copyright (c) 1990 The Regents of the University of California.
! 2: .\" 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: .\" @(#)README 5.2 (Berkeley) 4/20/91
! 33: .\"
! 34:
! 35: -mdoc stuff
! 36: doc-* files are unstripped tmac.doc-* files
! 37:
! 38: Site specific string and register names (for doc-{common,nroff,ditroff})
! 39:
! 40: .\" tmac.doc-nroff
! 41: .\"
! 42: .\" Default fonts
! 43: .\" FONT DITROFF style TROFF Style NROFF Style
! 44: .\" Default Times Roman Times Roman Printer Dependent
! 45: .\" Default bold Times Bold Times Bold Printer Dependent
! 46: .\" Default italic Times Italic Times Italic Underline
! 47: .\" Const width lit Courier Times ? Printer Dependent
! 48: .\" Const width bold Courier Bold ? Printer Dependent
! 49: .\" Const width ital Courier Oblique ? Printer Dependent
! 50: .\"
! 51: .\" Default point size 10 (vs 12), Section Header point size 12 (vs 14)
! 52: .\"
! 53: .\" STRING CONSTANTS
! 54: .\" NS aD string (site) Address Style
! 55: .\" NS aR string (site) Argument Reference Style
! 56: .\" NS cM string (site) Interactive Comand Modifier (flag)
! 57: .\" NS eM string (site) Emphasis (in the English sense - usually italics)
! 58: .\" NS eR string (site) Errno Style
! 59: .\" NS eV string (site) Environment Variable Style
! 60: .\" NS fA string (site) Function Argument Style
! 61: .\" NS fL string (site) Command Line Flag Style
! 62: .\" NS fN string (site) Function Name Style
! 63: .\" NS Hs string (site) Header String Style
! 64: .\" NS iC string (site) Interactive Command Style
! 65: .\" NS lI string (site) Literal Style
! 66: .\" NS lp string (site) Left Function Parenthesis Style
! 67: .\" NS rp string (site) Right Function Parenthesis Style
! 68: .\" NS lP string (site) Left Parenthesis Style
! 69: .\" NS rP string (site) Right Parenthesis Style
! 70: .\" NS lB string (site) Bracket Open Style
! 71: .\" NS rB string (site) Bracket Close Style
! 72: .\" NS mL string (site) Diagnostic Message List Style
! 73: .\" NS nM string (site) Name (subject of manpage) Style
! 74: .\" NS nO string (site) normal font (default)
! 75: .\" NS lO string (site) Options Open Bracket Style
! 76: .\" NS rO string (site) Options Close Bracket Style
! 77: .\" NS pA string (site) Pathname Style
! 78: .\" NS Pu string (site) Accepted punctuation string for -mdoc syntax
! 79: .\" NS rA string (site) Reference Author Style
! 80: .\" NS rT string (site) Reference Title Style
! 81: .\" NS sH string (site) Section Header Style
! 82: .\" NS sY string (site) Symbolic Emphasis (boldface)
! 83: .\" NS sX string (site) Section Header Cross References
! 84: .\" NS tN string (site) Trade Name Style
! 85: .\" NS vA string (site) Generic Variable Style
! 86: .\" NS Vs string (site) Volume Title Style
! 87: .\" NS xR string (site) Cross Reference STyle (man page only)
! 88: .\" MISCELLANEOUS
! 89: .\" NS lS string (site) list-label-sep (list-types hang, number, bullet, diag)
! 90: .\" NS iV string soft space (can be split on a newline or padded in adjust mode)
! 91: .\" NS sV string manipulable space
! 92: .\" NS hV string hard space (cannot be split on newline or padded)
! 93: .\" NS tV string tab space (for column function)
! 94: .\" NS sI register (site) subheader indent
! 95: .\" NS tI register (site) text indent
! 96: .\" NS cR register nroff crt flag (1 for crt/online, 0 for printer)
! 97: .\" NS Pp register (site) paragraph vertical spacing
! 98: .\" NS dI register flag (Bd)
! 99: .\" INDENT WIDTHS (used for tag widths, and argument tests)
! 100: .\" NS Ad register (site) Width Needed for Address Tag (indented amount)
! 101: .\" NS Ac register (site) Angle Quote Close Value
! 102: .\" NS Ao register (site) Angle Quote Open Width
! 103: .\" NS Aq register (site) Angle Quote Width
! 104: .\" NS Bc register (site) Bracket Quote Close Value
! 105: .\" NS Bl register (site) Bullet List Macro Value
! 106: .\" NS Bo register (site) Bracket Quote Open Width
! 107: .\" NS Bq register (site) Bracket Quote Width
! 108: .\" NS Ar register (site) Width Needed for Argument
! 109: .\" NS Cm register (site) Width neeeded for Interactive Command Modifier
! 110: .\" NS Co register (site) Width Needed for Column offset
! 111: .\" NS Cx register (site) Width Needed for Complex Expressions
! 112: .\" NS Ds register (site) Width Needed for Display (right and left margins)
! 113: .\" NS Dc register (site) Double Quote Close Value
! 114: .\" NS Do register (site) Double Quote Open Width
! 115: .\" NS Dq register (site) Double Quote Width
! 116: .\" NS Dv register (site) Defined (#define) variable (markup)
! 117: .\" NS tI register (site) tI is dependent on Ds and used by .Dp
! 118: .\" NS Ec register (site) Enclose Quote Close Value
! 119: .\" NS El register (site) Enumerated List Macro Value
! 120: .\" NS Eo register (site) Enclose Quote Open Width
! 121: .\" NS Em register (site) Width Needed for Display
! 122: .\" NS Eq register (site) Enclose Quote Width
! 123: .\" NS Er register (site) Width Needed for Errno Types
! 124: .\" NS Ev register (site) Width Needed for Environment Variables
! 125: .\" NS Ex register (site) Width Needed for Example Indent
! 126: .\" NS Fa register (site) Width Needed for Function Argument
! 127: .\" NS Fl register (site) Width Needed for Flag
! 128: .\" NS Fc register (site) Funtion Quote Close Value
! 129: .\" NS Fn register (site) Width Needed for Function
! 130: .\" NS Fo register (site) Funtion Quote Open Width
! 131: .\" NS Hl register (site) Hypehnated List Macro Value (sub bullet list)
! 132: .\" NS I1, I2, I3 register (site) Indent values
! 133: .\" NS Ic register (site) Width neeeded for Interactive Command Name
! 134: .\" NS Li register (site) Width Needed for Literal Constant
! 135: .\" NS Ms register (site) Width Needed for Math Symbol ? not sure if needed
! 136: .\" NS Nm register (site) Width Needed for Name
! 137: .\" NS No register (site) Width Needed for Name
! 138: .\" NS Ns register (site) No Space Macro Value
! 139: .\" NS Oo register (site) Width Needed for Option Open
! 140: .\" NS Oc register (site) Width Needed for Option Close
! 141: .\" NS Op register (site) Width Needed for Option (one line)
! 142: .\" NS Pa register (site) Width Needed for Pathname
! 143: .\" NS Pf register (site) Prefix Macro Value
! 144: .\" NS Pq register (site) Parenthesis Quote Width
! 145: .\" NS Ql register (site) Width Needed for Quoted Literal
! 146: .\" NS Sc register (site) Single Quote Close Value
! 147: .\" NS So register (site) Single Quote Open Width
! 148: .\" NS Sq register (site) Single Quote Width
! 149: .\" NS Sy register (site) Width Needed for Symbols, Modes or Masks
! 150: .\" NS Sx register (site) Width Needed for Section Header Cross References
! 151: .\" NS Ra register (site) Reference Author
! 152: .\" NS Rj register (site) Reference Journal Name
! 153: .\" NS Rn register (site) Reference Issue Number
! 154: .\" NS Ro register (site) Reference Optional Information
! 155: .\" NS Rr register (site) Reference Technical Report Name
! 156: .\" NS Rt register (site) Reference Book or Article title Title
! 157: .\" NS Rv register (site) Reference Volume
! 158: .\" NS Ta register (site) Tab macro register
! 159: .\" NS Tn register (site) Trade Name Macro Value
! 160: .\" NS Tv register (site) Tab Macro Value
! 161: .\" NS Tx register (site) Width needed for default or unknown text width
! 162: .\" NS Va register (site) Width Needed for Generic Variable
! 163: .\" NS Xc register (site) Extended Argument List Close Value
! 164: .\" NS Xo register (site) Extended Argument List Open Width
! 165: .\" NS Xr register (site) Width Needed for Cross Reference.
! 166: .\" .nr %A 1
! 167: .\" .nr %J 1
! 168: .\" .nr %N 1
! 169: .\" .nr %O 1
! 170: .\" .nr %R 1
! 171: .\" .nr %T 1
! 172: .\" .nr %V 1
! 173: .\" PAGE LAYOUT
! 174: .\" NS pL macro - page layout
! 175: .\" NS Hm register header margin
! 176: .\" NS Fm register footer margin
! 177: .\" NS vV register vertical distance (from Section headers/Lists/Subsections)