Changeset View
Changeset View
Standalone View
Standalone View
usr.bin/man/man.1
Show All 19 Lines | |||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||
.\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||
.\" | .\" | ||||
.\" $FreeBSD$ | .\" $FreeBSD$ | ||||
.\" | .\" | ||||
.Dd January 9, 2021 | .Dd January 26, 2022 | ||||
.Dt MAN 1 | .Dt MAN 1 | ||||
.Os | .Os | ||||
.Sh NAME | .Sh NAME | ||||
.Nm man | .Nm man | ||||
.Nd display online manual documentation pages | .Nd display online manual documentation pages | ||||
.Sh SYNOPSIS | .Sh SYNOPSIS | ||||
.Nm | .Nm | ||||
.Op Fl adho | .Op Fl adho | ||||
.Op Fl t | w | .Op Fl t | w | ||||
.Op Fl M Ar manpath | .Op Fl M Ar manpath | ||||
.Op Fl P Ar pager | .Op Fl P Ar pager | ||||
.Op Fl S Ar mansect | .Op Fl S Ar mansect | ||||
.Op Fl m Ar arch Ns Op : Ns Ar machine | .Op Fl m Ar arch Ns Op : Ns Ar machine | ||||
.Op Fl p Op Ar eprtv | .Op Fl p Op Ar eprtv | ||||
.Op Ar mansect | .Op Ar mansect | ||||
.Ar page ... | .Ar page ... | ||||
.Nm | .Nm | ||||
.Fl K | |||||
.Ar regexp ... | |||||
pauamma_gundo.com: Does ... mean "one or more"? This looks inconsistent with the description below and the usage… | |||||
Not Done Inline Actions
The use of ellipsis here is compatible with the other uses of ellipses on this manual page, and in context mean that something has been left out which the user needs to fill out. debdrup: > Does ... mean "one or more"? This looks inconsistent with the description below and the usage… | |||||
.Nm | |||||
.Fl f | .Fl f | ||||
.Ar keyword ... | .Ar keyword ... | ||||
.Nm | .Nm | ||||
.Fl k | .Fl k | ||||
.Ar keyword ... | .Ar keyword ... | ||||
.Sh DESCRIPTION | .Sh DESCRIPTION | ||||
The | The | ||||
.Nm | .Nm | ||||
Show All 34 Lines | |||||
.Fx | .Fx | ||||
Kernel Developer's Manual | Kernel Developer's Manual | ||||
.El | .El | ||||
.Pp | .Pp | ||||
Options that | Options that | ||||
.Nm | .Nm | ||||
understands: | understands: | ||||
.Bl -tag -width indent | .Bl -tag -width indent | ||||
.It Fl K Ar regexp | |||||
Does a full text search in all manual pages. | |||||
.Ar regexp | |||||
is a regular expression as understood by | |||||
.Dq Li "grep -E" . | |||||
This option requires | |||||
.Xr mandoc 1 . | |||||
This is a slow operation. | |||||
.It Fl M Ar manpath | .It Fl M Ar manpath | ||||
Forces a specific colon separated manual path instead of the default | Forces a specific colon separated manual path instead of the default | ||||
search path. | search path. | ||||
See | See | ||||
.Xr manpath 1 . | .Xr manpath 1 . | ||||
Overrides the | Overrides the | ||||
.Ev MANPATH | .Ev MANPATH | ||||
environment variable. | environment variable. | ||||
▲ Show 20 Lines • Show All 283 Lines • ▼ Show 20 Lines | |||||
.Pp | .Pp | ||||
Show the location of the | Show the location of the | ||||
.Xr ls 1 | .Xr ls 1 | ||||
manual page: | manual page: | ||||
.Bd -literal -offset indent | .Bd -literal -offset indent | ||||
$ man -w ls | $ man -w ls | ||||
.Ed | .Ed | ||||
.Pp | .Pp | ||||
Show the location of manual pages in sections 1 and 8 which contain the word | |||||
.Ql arm : | |||||
.Bd -literal -offset indent | |||||
$ ./man -w -K '\e<arm\e>' -S 1:8 | |||||
.Ed | |||||
.Sh SEE ALSO | .Sh SEE ALSO | ||||
.Xr apropos 1 , | .Xr apropos 1 , | ||||
.Xr egrep 1 , | |||||
.Xr intro 1 , | .Xr intro 1 , | ||||
.Xr mandoc 1 , | .Xr mandoc 1 , | ||||
.Xr manpath 1 , | .Xr manpath 1 , | ||||
.Xr whatis 1 , | .Xr whatis 1 , | ||||
.Xr intro 2 , | .Xr intro 2 , | ||||
.Xr intro 3 , | .Xr intro 3 , | ||||
.Xr intro 3lua , | .Xr intro 3lua , | ||||
.Xr intro 4 , | .Xr intro 4 , | ||||
.Xr intro 5 , | .Xr intro 5 , | ||||
.Xr man.conf 5 , | .Xr man.conf 5 , | ||||
.Xr intro 6 , | .Xr intro 6 , | ||||
.Xr intro 7 , | .Xr intro 7 , | ||||
.Xr mdoc 7 , | .Xr mdoc 7 , | ||||
.Xr intro 8 , | .Xr intro 8 , | ||||
.Xr intro 9 | .Xr intro 9 |
Does ... mean "one or more"? This looks inconsistent with the description below and the usage line in the shell program, both of which only mention one.