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