projects / unix-history / blame
| Commit | Line | Data |
|---|---|---|
| 7400223d KM |
1 | .\" Copyright (c) 1980 Regents of the University of California. |
| 2 | .\" All rights reserved. The Berkeley software License Agreement | |
| 3 | .\" specifies the terms and conditions for redistribution. | |
| 4 | .\" | |
| f81fb8aa | 5 | .\" @(#)man.1 5.1 (Berkeley) %G% |
| 7400223d | 6 | .\" |
| f81fb8aa | 7 | .TH MAN 1 "18 January 1983" |
| 7400223d KM |
8 | .UC 4 |
| 9 | .SH NAME | |
| 10 | man \- find manual information by keywords; print out the manual | |
| 11 | .SH SYNOPSIS | |
| 12 | .br | |
| 13 | .B man | |
| 14 | .B \-k | |
| 15 | keyword ... | |
| 16 | .br | |
| 17 | .B man | |
| 18 | .B \-f | |
| 19 | file ... | |
| 20 | .br | |
| 21 | .B man | |
| 22 | [ | |
| 23 | .B \- | |
| 24 | ] [ | |
| 25 | .B \-t | |
| 26 | ] [ | |
| 27 | section | |
| 28 | ] | |
| 29 | title ... | |
| 30 | .SH DESCRIPTION | |
| 31 | .I Man | |
| 32 | is a program which gives information from the programmers manual. | |
| f81fb8aa | 33 | It can be asked for one line descriptions of commands specified by |
| 7400223d KM |
34 | name, or for all commands whose description contains any of a set of |
| 35 | keywords. It can also provide on-line access to the sections of the | |
| 36 | printed manual. | |
| 37 | .PP | |
| 38 | When given the option | |
| 39 | .B \-k | |
| 40 | and a set of keywords, | |
| 41 | .I man | |
| 42 | prints out a one line synopsis of each manual sections whose | |
| 43 | listing in the table of contents contains that keyword. | |
| 44 | .PP | |
| 45 | When given the option | |
| 46 | .B \-f | |
| 47 | and a list of file names, \fIman\fR attempts to locate manual | |
| 48 | sections related to those files, printing out the table of contents | |
| 49 | lines for those sections. | |
| 50 | .PP | |
| 51 | When neither | |
| 52 | .B \-k | |
| 53 | nor | |
| 54 | .B \-f | |
| 55 | is specified, | |
| 56 | .I man | |
| 57 | formats a specified set of manual pages. | |
| 58 | If a section specifier is given | |
| 59 | .I man | |
| 60 | looks in the that section of the manual for the given | |
| 61 | .I titles. | |
| 62 | .I Section | |
| f81fb8aa KM |
63 | is an Arabic section number (3 for instance). The number may followed by |
| 64 | a single letter classifier (1g for instance) | |
| 65 | indicating a graphics program in section 1. If | |
| 7400223d KM |
66 | .I section |
| 67 | is omitted, | |
| 68 | .I man | |
| 69 | searches all sections of the manual, giving preference to commands | |
| 70 | over subroutines in system libraries, and printing the first section | |
| 71 | it finds, if any. | |
| 72 | .PP | |
| 73 | If the standard output is a teletype, or if the flag | |
| 74 | .B \- | |
| f81fb8aa | 75 | is given, |
| 7400223d KM |
76 | .I man |
| 77 | pipes its output through | |
| 78 | .IR cat (1) | |
| 79 | with the option | |
| 80 | .B \-s | |
| 81 | to crush out useless blank lines, | |
| 82 | .IR ul (1) | |
| f81fb8aa | 83 | to create proper underlines for different terminals, and through |
| 7400223d KM |
84 | .IR more (1) |
| 85 | to stop after each page on the screen. | |
| 86 | Hit a space to continue, | |
| 87 | a control-D to scroll 11 more lines when the output stops. | |
| 88 | .PP | |
| 89 | The | |
| 90 | .B \-t | |
| 91 | flag causes | |
| 92 | .I man | |
| 93 | to arrange for the specified section to be | |
| 94 | .I troff'ed | |
| 95 | to a suitable raster output device; see | |
| 96 | .IR vtroff (1). | |
| 97 | .SH FILES | |
| 98 | /usr/man/man?/* | |
| 99 | .br | |
| 100 | /usr/man/cat?/* | |
| 101 | .SH SEE\ ALSO | |
| 102 | more(1), ul(1), whereis(1), catman(8) | |
| 103 | .SH BUGS | |
| 104 | The manual is supposed to be reproducible either on the phototypesetter | |
| 105 | or on a typewriter. | |
| 106 | However, on a typewriter some information is necessarily lost. |