diff options
Diffstat (limited to 'man/man7/man.html')
| -rw-r--r-- | man/man7/man.html | 292 |
1 files changed, 292 insertions, 0 deletions
diff --git a/man/man7/man.html b/man/man7/man.html new file mode 100644 index 00000000..4087e795 --- /dev/null +++ b/man/man7/man.html @@ -0,0 +1,292 @@ +<head> +<title>man(7) - Plan 9 from User Space</title> +<meta content="text/html; charset=utf-8" http-equiv=Content-Type> +</head> +<body bgcolor=#ffffff> +<table border=0 cellpadding=0 cellspacing=0 width=100%> +<tr height=10><td> +<tr><td width=20><td> +<tr><td width=20><td><b>MAN(7)</b><td align=right><b>MAN(7)</b> +<tr><td width=20><td colspan=2> + <br> +<p><font size=+1><b>NAME </b></font><br> + +<table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td> + + man – macros to typeset manual<br> + +</table> +<p><font size=+1><b>SYNOPSIS </b></font><br> + +<table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td> + + <tt><font size=+1>nroff −man</font></tt> <i>file ... + <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + </i> + <tt><font size=+1>troff −man</font></tt> <i>file ...<br> + </i> +</table> +<p><font size=+1><b>DESCRIPTION </b></font><br> + +<table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td> + + These macros are used to format pages of this manual. + <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + + Except in <tt><font size=+1>.LR</font></tt> and <tt><font size=+1>.RL</font></tt> requests, any text argument denoted <i>t</i> in + the request summary may be zero to six words. Quotes <tt><font size=+1>"</font></tt> ... <tt><font size=+1>"</font></tt> may + be used to include blanks in a ‘word’. If <i>t</i> is empty, the special + treatment is applied to the next text input line (the next line + that doesn’t begin with dot). In this way, for example, <tt><font size=+1>.I + </font></tt>may be used to italicize a line of more than 6 words, or <tt><font size=+1>.SM</font></tt> followed + by <tt><font size=+1>.B</font></tt> to make small letters in ‘bold’ font. + <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + + A prevailing indent distance is remembered between successive + indented paragraphs, and is reset to default value upon reaching + a non-indented paragraph. Default units for indents <i>i</i> are ens. + + <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + + The fonts are<br> + <tt><font size=+1>R</font></tt> roman, the main font, preferred for diagnostics<br> + <tt><font size=+1>I</font></tt> italic, preferred for parameters, short names of commands, names + of manual pages, and naked function names<br> + <tt><font size=+1>B</font></tt> ‘bold’, actually the constant width font, preferred for examples, + file names, declarations, keywords, names of <tt><font size=+1>struct</font></tt> members, and + literals (numbers are rarely literals)<br> + <tt><font size=+1>L</font></tt> also the constant width font. In <i>troff</i> <tt><font size=+1>L</font></tt>=<tt><font size=+1>B</font></tt>; in <i>nroff</i> arguments + of the macros <tt><font size=+1>.L</font></tt>, <tt><font size=+1>.LR</font></tt>, and <tt><font size=+1>.RL</font></tt> are printed in quotes; preferred + only where quotes really help (e.g. lower-case literals and punctuation). + + <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + + Type font and size are reset to default values before each paragraph, + and after processing font- or size-setting macros. + <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + + The <tt><font size=+1>−man</font></tt> macros admit equations and tables in the style of <a href="../man1/eqn.html"><i>eqn</i>(1)</a> + and <a href="../man1/tbl.html"><i>tbl</i>(1)</a>, but do not support arguments on <tt><font size=+1>.EQ</font></tt> and <tt><font size=+1>.TS</font></tt> macros. + + <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + + These strings are predefined by <tt><font size=+1>−man</font></tt>:<br> + <tt><font size=+1>\*R</font></tt> ‘®’, ‘(Reg)’ in <i>nroff</i>.<br> + <tt><font size=+1>\*S</font></tt> Change to default type size. <tt><font size=+1>\*9</font></tt> The root directory of the + Plan 9 installation.<br> + +</table> +<p><font size=+1><b>FILES </b></font><br> + +<table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td> + + <tt><font size=+1>/usr/local/plan9/tmac/tmac.an + <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + </font></tt> + <tt><font size=+1>/usr/local/plan9/tmac/tmac.antimes<br> + </font></tt> +</table> +<p><font size=+1><b>SEE ALSO </b></font><br> + +<table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td> + + <a href="../man1/troff.html"><i>troff</i>(1)</a>, <a href="../man1/man.html"><i>man</i>(1)</a><br> + +</table> +<p><font size=+1><b>REQUESTS </b></font><br> +Request Cause If no Explanation<br> + +<table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td> + + + <table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td> + + Break Argument<br> + + </table> + +</table> +<tt><font size=+1>.B</font></tt> <i>t </i> no +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +<tt><font size=+1> +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +</font></tt><i>t</i>=n.t.l.* Text <i>t</i> is ‘bold’.<br> +<tt><font size=+1>.BI</font></tt> <i>t </i> no +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +<tt><font size=+1> +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +</font></tt><i>t</i>=n.t.l. Join words of <i>t</i> alternating bold and italic.<br> +<tt><font size=+1>.BR</font></tt> <i>t </i> no +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +<tt><font size=+1> +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +</font></tt><i>t</i>=n.t.l. Join words of <i>t</i> alternating bold and Roman.<br> +<tt><font size=+1>.DT </font></tt> no Restore default tabs.<br> +<tt><font size=+1>.EE </font></tt> yes End displayed example<br> +<tt><font size=+1>.EX </font></tt> yes Begin displayed example<br> +<tt><font size=+1>.HP</font></tt> <i>i </i> yes +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +<tt><font size=+1> +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +</font></tt><i>i</i>=p.i.* Set prevailing indent to <i>i</i>. Begin paragraph with hanging +indent.<br> +<tt><font size=+1>.I</font></tt> <i>t </i> no +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +<tt><font size=+1> +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +</font></tt><i>t</i>=n.t.l. Text <i>t</i> is italic.<br> +<tt><font size=+1>.IB</font></tt> <i>t </i> no +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +<tt><font size=+1> +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +</font></tt><i>t</i>=n.t.l. Join words of <i>t</i> alternating italic and bold.<br> +<tt><font size=+1>.IP</font></tt> <i>x i</i> yes +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +<tt><font size=+1> +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +</font></tt><i>x</i>="" Same as <tt><font size=+1>.TP</font></tt> with tag <i>x</i>.<br> +<tt><font size=+1>.IR</font></tt> <i>t </i> no +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +<tt><font size=+1> +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +</font></tt><i>t</i>=n.t.l. Join words of <i>t</i> alternating italic and Roman.<br> +<tt><font size=+1>.L</font></tt> <i>t </i> no +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +<tt><font size=+1> +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +</font></tt><i>t</i>=n.t.l. Text <i>t</i> is literal.<br> +<tt><font size=+1>.LP </font></tt> yes Same as <tt><font size=+1>.PP</font></tt>.<br> +<tt><font size=+1>.LR</font></tt> <i>t </i> no Join 2 words of <i>t</i> alternating literal and Roman.<br> +<tt><font size=+1>.PD</font></tt> <i>d </i> no +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +<tt><font size=+1> +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +</font></tt><i>d</i>=<tt><font size=+1>.4v </font></tt> Interparagraph distance is <i>d</i>.<br> +<tt><font size=+1>.PP </font></tt> yes Begin paragraph. Set prevailing indent to default.<br> +<tt><font size=+1>.RE </font></tt> yes End of relative indent. Set prevailing indent to amount +of starting <tt><font size=+1>.RS</font></tt>.<br> +<tt><font size=+1>.RI</font></tt> <i>t </i> no +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +<tt><font size=+1> +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +</font></tt><i>t</i>=n.t.l. Join words of <i>t</i> alternating Roman and italic.<br> +<tt><font size=+1>.RL</font></tt> <i>t </i> no Join 2 or 3 words of <i>t</i> alternating Roman and literal.<br> +<tt><font size=+1>.RS</font></tt> <i>i </i> yes +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +<tt><font size=+1> +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +</font></tt><i>i</i>=p.i. Start relative indent, move left margin in distance <i>i</i>. +Set prevailing indent to default for nested indents.<br> +<tt><font size=+1>.SH</font></tt> <i>t </i> yes +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +<tt><font size=+1> +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +</font></tt><i>t</i>="" Subhead; reset paragraph distance.<br> +<tt><font size=+1>.SM</font></tt> <i>t </i> no +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +<tt><font size=+1> +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +</font></tt><i>t</i>=n.t.l. Text <i>t</i> is small.<br> +<tt><font size=+1>.SS</font></tt> <i>t </i> no +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +<tt><font size=+1> +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +</font></tt><i>t</i>="" Secondary subhead.<br> +<tt><font size=+1>.TF</font></tt> <i>s </i> yes Prevailing indent is wide as string <i>s</i> in font <tt><font size=+1>L</font></tt>; paragraph +distance is 0.<br> +<tt><font size=+1>.TH</font></tt> <i>n c x </i> yes Begin page named <i>n</i> of chapter <i>c;</i> <i>x</i> is extra commentary, +e.g. ‘local’, for page head. Set prevailing indent and tabs to +default.<br> +<tt><font size=+1>.TP</font></tt> <i>i </i> yes +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +<tt><font size=+1> +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> +</font></tt><i>i</i>=p.i. Set prevailing indent to <i>i</i>. Restore default indent if +<i>i</i>=0. Begin indented paragraph with hanging tag given by next text +line. If tag doesn’t fit, place it on separate line.<br> +<tt><font size=+1>.1C </font></tt> yes Equalize columns and return to 1-column output<br> +<tt><font size=+1>.2C </font></tt> yes Start 2-column nofill output +<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + +* n.t.l. = next text line; p.i. = prevailing indent<br> +<p><font size=+1><b>BUGS </b></font><br> + +<table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td> + + There’s no way to fool <i>troff</i> into handling literal double quote + marks <tt><font size=+1>"</font></tt> in font-alternation macros, such as <tt><font size=+1>.BI</font></tt>. + <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table> + + There is no direct way to suppress column widows in 2-column output; + the column lengths may be adjusted by inserting <tt><font size=+1>.sp</font></tt> requests before + the closing <tt><font size=+1>.1C</font></tt>.<br> + +</table> + +<td width=20> +<tr height=20><td> +</table> +<!-- TRAILER --> +<table border=0 cellpadding=0 cellspacing=0 width=100%> +<tr height=15><td width=10><td><td width=10> +<tr><td><td> +<center> +<a href="../../"><img src="../../dist/spaceglenda100.png" alt="Space Glenda" border=1></a> +</center> +</table> +<!-- TRAILER --> +</body></html> |