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