![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to man.6 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [Research Unix] / researchv10dc / man / adm / man6|
Return to man.6 CVS log | Up to [Research Unix] / researchv10dc / man / adm / man6 |
1.1 root 1: .TH MAN 6
2: .CT 1 inst_info
3: .SH NAME
4: man \(mi macros to typeset manual
5: .SH SYNOPSIS
6: .B nroff -man
7: .I file ...
8: .PP
9: .B troff -man
10: .I file ...
11: .SH DESCRIPTION
12: These macros are used to lay out pages of this manual.
13: .PP
14: Except in
15: .L .LR
16: and
17: .L .RL
18: requests, any text argument denoted
19: .I t
20: in the request summary may be zero to six words.
21: Quotes
22: \f5"\fP ... \f5"\fP
23: may be used to include blanks in a `word'.
24: If
25: .I t
26: is empty,
27: the special treatment is applied to
28: the next text input line (the next line that doesn't begin with dot).
29: In this way, for example,
30: .B .I
31: may be used to italicize a line of more than 6 words, or
32: .B .SM
33: followed by
34: .B .B
35: to make small letters in `bold' font.
36: .PP
37: A prevailing indent distance is remembered between
38: successive indented paragraphs,
39: and is reset to default value upon reaching a non-indented paragraph.
40: Default units for indents
41: .I i
42: are ens.
43: .PP
44: The fonts are
45: .TP
46: .B R
47: roman, the main font, preferred for diagnostics
48: .PD 0
49: .TP
50: .B I
51: italic, preferred for parameters, short names of commands
52: (use
53: .B F
54: for full path names),
55: names of manual pages,
56: and naked function names
57: .TP
58: .L B
59: `bold', actually the constant width font CW,
60: preferred for examples, declarations, keywords, names of
61: .B struct
62: members, and literals
63: (numbers are rarely literals)
64: .TP
65: .B F
66: also font CW;
67: used for filenames to help cross-indexing
68: .TP
69: .B L
70: also font CW.
71: In
72: .I troff
73: .BR L = B ;
74: in
75: .I nroff
76: arguments of the macros
77: .BR .L ,
78: .BR .LR ,
79: and
80: .B .RL
81: are printed in quotes;
82: preferred only where quotes really help (e.g. lower-case literals and
83: punctuation).
84: .PD
85: .LP
86: Type font and size are reset to default values
87: before each paragraph, and after processing
88: font- or size-setting macros.
89: .PP
90: The
91: .B -man
92: macros admit equations and tables in the style of
93: .IR eqn (1)
94: and
95: .IR tbl (1),
96: but do not support arguments on
97: .B .EQ
98: and
99: .B .TS
100: macros.
101: .PP
102: These strings are predefined by
103: .BR -man :
104: .TP
105: .B \e*R
106: .if t `\*R', `(Reg)' in
107: .if t .I nroff.
108: .if n `(Reg)', trademark symbol in
109: .if n .I troff.
110: .br
111: .ns
112: .TP
113: .B \e*S
114: Change to default type size.
115: .SH FILES
116: .F /usr/lib/tmac/tmac.an
117: .br
118: .F /usr/man/man0/xx
119: .SH SEE ALSO
120: .IR troff (1),
121: .IR man (1)
122: .SH REQUESTS
123: .ta \w'.TH n c x 'u +\w'Cause 'u +\w'Argument\ 'u
124: .di xx
125: \ka
126: .br
127: .di
128: .in \nau
129: .ti0
130: Request Cause If no Explanation
131: .ti0
132: Break Argument
133: .ti0
134: \&\f5.B\fR \fIt\fR no \fIt\fR=n.t.l.* Text
135: .I t
136: is `bold'.
137: .ti0
138: \&\f5.BI\fR \fIt\fR no \fIt\fR=n.t.l. Join
139: words of
140: .I t
141: alternating bold and italic.
142: .ti0
143: \&\f5.BR\fR \fIt\fR no \fIt\fR=n.t.l. Join
144: words of
145: .I t
146: alternating bold and Roman.
147: .ti0
148: \&\f5.CT\fR \fIc x...\fR no Chapter
149: .I c,
150: topics
151: .I x
152: in topic index; see
153: .F /usr/man
154: for topic codes.
155: .ti0
156: \&\f5.DT\fR no Restore default tabs.
157: .ti0
158: \&\f5.EE\fR yes End displayed example
159: .ti0
160: \&\f5.EX\fR yes Begin displayed example
161: .ti0
162: \&\f5.F\fR \fIt\fR no \fIt\fR=n.t.l. Text
163: .I t
164: is filename.
165: .ti0
166: \&\f5.FR\fR \fIt\fR no \fIt\fR=n.t.l. Join
167: words of
168: .I t
169: alternating filename and Roman.
170: .ti0
171: \&\f5.HP\fR \fIi\fR yes \fIi\fR=p.i.* Set prevailing indent to
172: .I i.
173: Begin paragraph with hanging indent.
174: .ti0
175: \&\f5.I\fR \fIt\fR no \fIt\fR=n.t.l. Text
176: .I t
177: is italic.
178: .ti0
179: \&\f5.IB\fR \fIt\fR no \fIt\fR=n.t.l. Join
180: words of
181: .I t
182: alternating italic and bold.
183: .ti0
184: \&\f5.IP\fR \fIx i\fR yes \fIx\fR="" Same as \f5.TP\fP with tag
185: .I x.
186: .ti0
187: \&\f5.IR\fR \fIt\fR no \fIt\fR=n.t.l. Join
188: words of
189: .I t
190: alternating italic and Roman.
191: .ti0
192: \&\f5.L\fR \fIt\fR no \fIt\fR=n.t.l. Text
193: .I t
194: is literal.
195: .ti0
196: \&\f5.LP\fR yes Same as \f5.PP\fP.
197: .ti0
198: \&\f5.LR\fR \fIt\fR no Join 2
199: words of
200: .I t
201: alternating literal and Roman.
202: .ti0
203: \&\f5.PD\fR \fId\fR no \fId\fR=\f5.4v\fP Interparagraph distance is
204: .I d.
205: .ti0
206: \&\f5.PP\fR yes Begin paragraph.
207: Set prevailing indent to default.
208: .ti0
209: \&\f5.RE\fR yes End of relative indent.
210: Set prevailing indent to amount of starting \f5.RS\fP.
211: .ti0
212: \&\f5.RF\fR \fIt\fR no \fIt\fR=n.t.l. Join
213: words of
214: .I t
215: alternating Roman and filename.
216: .ti0
217: \&\f5.RI\fR \fIt\fR no \fIt\fR=n.t.l. Join
218: words of
219: .I t
220: alternating Roman and italic.
221: .ti0
222: \&\f5.RL\fR \fIt\fR no Join 2 or 3
223: words of
224: .I t
225: alternating Roman and literal.
226: .ti0
227: \&\f5.RS\fR \fIi\fR yes \fIi\fR=p.i. Start relative indent,
228: move left margin in distance
229: .I i.
230: Set prevailing indent to default for nested indents.
231: .ti0
232: \&\f5.SH\fR \fIt\fR yes \fIt\fR="" Subhead; reset paragraph distance.
233: .ti0
234: \&\f5.SM\fR \fIt\fR no \fIt\fR=n.t.l. Text
235: .I t
236: is small.
237: .ti0
238: \&\f5.SS\fR \fIt\fR no \fIt\fR="" Secondary subhead.
239: .ti0
240: \&\f5.TF\fR \fIs\fR yes Prevailing indent is wide as
241: string
242: .I s
243: in font
244: .BR L ;
245: paragraph distance is 0.
246: .ti0
247: \&\f5.TH\fR \fIn c x\fR yes Begin page named
248: .I n
249: of chapter
250: .IR c;
251: .I x
252: is extra commentary, e.g. `local', for page head.
253: Set prevailing indent and tabs to default.
254: .ti0
255: \&\f5.TP\fR \fIi\fR yes \fIi\fR=p.i. Set prevailing indent to
256: .I i.
257: Restore default indent if
258: .IR i =0.
259: Begin indented paragraph
260: with hanging tag given by next text line.
261: If tag doesn't fit, place it on separate line.
262: .ti0
263: \&\f5.1C\fR yes Equalize columns and return to 1-column output
264: .ti0
265: \&\f5.2C\fR yes Start 2-column nofill output
266: .PP
267: .ti0
268: * n.t.l. = next text line; p.i. = prevailing indent
269: .SH BUGS
270: There's no way to fool
271: .I troff
272: into handling literal double quote marks
273: .B \&"
274: in font-alternation macros, such as
275: .LR .BI .
276: .br
277: There is no direct way to suppress column widows in 2-column
278: output; the column lengths may be adjusted by inserting
279: .L .sp
280: requests before the closing
281: .LR .1C .
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.