projects / unix-history / blame
| Commit | Line | Data |
|---|---|---|
| b125ad51 BJ |
1 | .TH MAN UCB 2/24/79 UCB |
| 2 | .SH NAME | |
| 3 | man \- run of section of UNIX manual | |
| 4 | .SH SYNOPSIS | |
| 5 | .B man | |
| 6 | [ | |
| 7 | .B \- | |
| 8 | ] [ | |
| 9 | .B \-t | |
| 10 | ] [ | |
| 11 | section | |
| 12 | ] | |
| 13 | title ... | |
| 14 | .SH DESCRIPTION | |
| 15 | .I Man | |
| 16 | is a program which prints sections of the manual. | |
| 17 | .I Section | |
| 18 | is an option arabic section number, i.e. 3, | |
| 19 | which may be followed by a single letter classifier, i.e. 1m | |
| 20 | indicating a maintenance type program in section 1. | |
| 21 | It may also be | |
| 22 | ``ucb'', | |
| 23 | ``sccs'', | |
| 24 | or | |
| 25 | ``public''. | |
| 26 | If a section specifier is given | |
| 27 | .I man | |
| 28 | looks in the that section of the manual for the given | |
| 29 | .I titles. | |
| 30 | If | |
| 31 | .I section | |
| 32 | is omitted, | |
| 33 | .I man | |
| 34 | searches all sections of the manual, giving preference to commands | |
| 35 | over subroutines in system libraries, and printing the first section | |
| 36 | it finds, if any. | |
| 37 | The command | |
| 38 | .IR apropos (UCB) | |
| 39 | can help find a command whose name has been forgotten, | |
| 40 | looking it up by kewords in its ``one line'' description. | |
| 41 | .PP | |
| 42 | If the standard output is a teletype, or if the flag | |
| 43 | .B \- | |
| 44 | is given, then | |
| 45 | .I man | |
| 46 | pipes its output through | |
| 47 | .IR ssp (UCB) | |
| 48 | to crush out useless blank lines, | |
| 49 | and through | |
| 50 | .IR cr3 (UCB) | |
| 51 | to stop after each page on the screen. | |
| 52 | Hit a carriage return to continue, | |
| 53 | a control-D to scroll 12 more lines when the output stops. | |
| 54 | .PP | |
| 55 | The | |
| 56 | .B \-t | |
| 57 | flag causes | |
| 58 | .I man | |
| 59 | to arrange for the specified section to be | |
| 60 | .I troff'ed | |
| 61 | to the Versatec. | |
| 62 | .SH FILES | |
| 63 | /usr/man/man?/* | |
| 64 | .SH SEE\ ALSO | |
| 65 | apropos(UCB), cr3(UCB), ssp(UCB), whereis(UCB) | |
| 66 | .SH AUTHOR | |
| 67 | Bill Joy | |
| 68 | .SH BUGS | |
| 69 | The manual is supposed to be reproducible either on the phototypesetter | |
| 70 | or on a typewriter. | |
| 71 | However, on a typewriter some information is necessarily lost. | |
| 72 | .PP | |
| 73 | If multiple sections of the manual are to be | |
| 74 | .I troff'ed | |
| 75 | then it is better to run them off with | |
| 76 | .IR vtroff (UCB) using a sequence like | |
| 77 | .IP | |
| 78 | cd /usr/man/mann; vtroff -man mail.n msgs.n | |
| 79 | .PP | |
| 80 | since the pages will then be run in one Versatec job using less paper. |