Commit | Line | Data |
---|---|---|
0b3b654e | 1 | .\" @(#)man.7 6.3 (Berkeley) %G% |
a5468a26 | 2 | .\" |
4579a99c | 3 | .TH MAN 7 "" |
a5468a26 KM |
4 | .AT 3 |
5 | .SH NAME | |
6 | man \- macros to typeset manual | |
7 | .SH SYNOPSIS | |
8 | .B | |
9 | nroff \-man\ | |
10 | file ... | |
11 | .PP | |
12 | .B | |
13 | troff \-man\ | |
14 | file ... | |
15 | .SH DESCRIPTION | |
16 | These macros are used to lay out pages of this manual. | |
17 | A skeleton page may be found in the file | |
18 | /usr/man/man0/xx. | |
19 | .PP | |
20 | Any text argument | |
21 | .I t | |
22 | may be zero to six words. | |
23 | Quotes may be used to include blanks in a `word'. | |
24 | If | |
25 | .I text | |
26 | is empty, | |
8510b0c0 | 27 | special treatment is applied to |
a5468a26 KM |
28 | the next input line with text to be printed. |
29 | In this way | |
30 | .BR . I | |
31 | may be used to italicize a whole line, or | |
32 | .BR . SM | |
8510b0c0 | 33 | may be |
a5468a26 KM |
34 | followed by |
35 | .BR . B | |
36 | to make small bold letters. | |
37 | .PP | |
38 | A prevailing indent distance is remembered between | |
39 | successive indented paragraphs, | |
40 | and is reset to default value upon reaching a non-indented paragraph. | |
41 | Default units for indents | |
42 | .I i | |
43 | are ens. | |
44 | .PP | |
45 | Type font and size are reset to default values | |
46 | before each paragraph, and after processing | |
47 | font and size setting macros. | |
48 | .PP | |
49 | These strings are predefined by | |
50 | .BR \-man : | |
51 | .IP \e*R | |
52 | .if t `\*R', `(Reg)' in | |
53 | .if t .I nroff. | |
54 | .if n `(Reg)', trademark symbol in | |
55 | .if n .I troff. | |
56 | .IP \e*S | |
57 | Change to default type size. | |
58 | .SH FILES | |
59 | /usr/lib/tmac/tmac.an | |
60 | .br | |
61 | /usr/man/man0/xx | |
62 | .SH SEE ALSO | |
63 | troff(1), man(1) | |
64 | .SH BUGS | |
65 | Relative indents don't nest. | |
66 | .SH REQUESTS | |
d2418787 | 67 | .ta \w'.TH n c x v m'u +\w'Cause 'u +\w'Argument\ 'u |
a5468a26 KM |
68 | .di xx |
69 | \ka | |
70 | .br | |
71 | .di | |
72 | .in \nau | |
73 | .ti0 | |
74 | Request Cause If no Explanation | |
75 | .ti0 | |
76 | Break Argument | |
77 | .ti0 | |
0b3b654e KM |
78 | .tr ~. |
79 | ~B \fIt\fR no \fIt\fR=n.t.l.* Text | |
a5468a26 KM |
80 | .I t |
81 | is bold. | |
82 | .ti0 | |
0b3b654e | 83 | ~BI \fIt\fR no \fIt\fR=n.t.l. Join |
a5468a26 KM |
84 | words of |
85 | .I t | |
86 | alternating bold and italic. | |
87 | .ti0 | |
0b3b654e | 88 | ~BR \fIt\fR no \fIt\fR=n.t.l. Join |
a5468a26 KM |
89 | words of |
90 | .I t | |
91 | alternating bold and Roman. | |
92 | .ti0 | |
0b3b654e | 93 | ~DT no .5i 1i... Restore default tabs. |
a5468a26 | 94 | .ti0 |
0b3b654e | 95 | ~HP \fIi\fR yes \fIi\fR=p.i.* Set prevailing indent to |
a5468a26 KM |
96 | .I i. |
97 | Begin paragraph with hanging indent. | |
98 | .ti0 | |
0b3b654e | 99 | ~I \fIt\fR no \fIt\fR=n.t.l. Text |
a5468a26 KM |
100 | .I t |
101 | is italic. | |
102 | .ti0 | |
0b3b654e | 103 | ~IB \fIt\fR no \fIt\fR=n.t.l. Join |
a5468a26 KM |
104 | words of |
105 | .I t | |
106 | alternating italic and bold. | |
107 | .ti0 | |
0b3b654e | 108 | ~IP \fIx i\fR yes \fIx\fR="" Same as .TP with tag |
a5468a26 KM |
109 | .I x. |
110 | .ti0 | |
0b3b654e | 111 | ~IR \fIt\fR no \fIt\fR=n.t.l. Join |
a5468a26 KM |
112 | words of |
113 | .I t | |
114 | alternating italic and Roman. | |
115 | .ti0 | |
0b3b654e | 116 | ~LP yes - Same as .PP. |
a5468a26 | 117 | .ti0 |
0b3b654e | 118 | ~PD \fId\fR no \fId\fR=.4v Interparagraph distance is |
a5468a26 KM |
119 | .I d. |
120 | .ti0 | |
0b3b654e | 121 | ~PP yes - Begin paragraph. |
a5468a26 KM |
122 | Set prevailing indent to .5i. |
123 | .ti0 | |
0b3b654e | 124 | ~RE yes - End of relative indent. |
a5468a26 KM |
125 | Set prevailing indent to amount of starting .RS. |
126 | .ti0 | |
0b3b654e | 127 | ~RB \fIt\fR no \fIt\fR=n.t.l. Join |
a5468a26 KM |
128 | words of |
129 | .I t | |
130 | alternating Roman and bold. | |
131 | .ti0 | |
0b3b654e | 132 | ~RI \fIt\fR no \fIt\fR=n.t.l. Join |
a5468a26 KM |
133 | words of |
134 | .I t | |
135 | alternating Roman and italic. | |
136 | .ti0 | |
0b3b654e | 137 | ~RS \fIi\fR yes \fIi\fR=p.i. Start relative indent, |
a5468a26 KM |
138 | move left margin in distance |
139 | .I i. | |
140 | Set prevailing indent to .5i for nested indents. | |
141 | .ti0 | |
0b3b654e | 142 | ~SH \fIt\fR yes \fIt\fR=n.t.l. Subhead. |
a5468a26 | 143 | .ti0 |
0b3b654e | 144 | ~SM \fIt\fR no \fIt\fR=n.t.l. Text |
a5468a26 KM |
145 | .I t |
146 | is small. | |
147 | .ti0 | |
0b3b654e | 148 | ~TH \fIn c x v m\fR yes - Begin page named |
a5468a26 KM |
149 | .I n |
150 | of chapter | |
151 | .IR c; | |
152 | .I x | |
d2418787 KM |
153 | is extra commentary, e.g. `local', for page foot center; |
154 | .I v | |
155 | alters page foot left, e.g. `4th Berkeley Distribution'; | |
156 | .I m | |
157 | alters page head center, e.g. `Brand X Programmer's Manual'. | |
a5468a26 KM |
158 | Set prevailing indent and tabs to .5i. |
159 | .ti0 | |
0b3b654e | 160 | ~TP \fIi\fR yes \fIi\fR=p.i. Set prevailing indent to |
a5468a26 KM |
161 | .I i. |
162 | Begin indented paragraph | |
163 | with hanging tag given by next text line. | |
164 | If tag doesn't fit, place it on separate line. | |
165 | .PP | |
166 | .ti0 | |
167 | * n.t.l. = next text line; p.i. = prevailing indent |