version 1.30, 2017/08/09 12:49:04 |
version 1.35, 2019/03/09 15:55:01 |
|
|
.\" Copyright (c) 1989, 1990, 1993 |
.\" Copyright (c) 1989, 1990, 1993 |
.\" The Regents of the University of California. All rights reserved. |
.\" The Regents of the University of California. All rights reserved. |
.\" Copyright (c) 2003, 2007, 2008, 2014 Jason McIntyre <jmc@openbsd.org> |
.\" Copyright (c) 2003, 2007, 2008, 2014 Jason McIntyre <jmc@openbsd.org> |
.\" Copyright (c) 2010, 2011, 2014-2017 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2010, 2011, 2014-2018 Ingo Schwarze <schwarze@openbsd.org> |
.\" |
.\" |
.\" Redistribution and use in source and binary forms, with or without |
.\" Redistribution and use in source and binary forms, with or without |
.\" modification, are permitted provided that the following conditions |
.\" modification, are permitted provided that the following conditions |
|
|
By default, it displays the header lines of all matching pages. |
By default, it displays the header lines of all matching pages. |
.It Fl l |
.It Fl l |
A synonym for |
A synonym for |
.Xr mandoc 1 |
.Xr mandoc 1 . |
.Fl a . |
|
The |
The |
.Ar name |
.Ar name |
arguments are interpreted as filenames. |
arguments are interpreted as filenames. |
Line 127 No search is done and |
|
Line 126 No search is done and |
|
and |
and |
.Fl w |
.Fl w |
are ignored. |
are ignored. |
|
This option implies |
|
.Fl a . |
.It Fl M Ar path |
.It Fl M Ar path |
Override the list of standard directories which |
Override the list of standard directories which |
.Nm |
.Nm |
Line 217 Guidelines for writing |
|
Line 218 Guidelines for writing |
|
man pages can be found in |
man pages can be found in |
.Xr mdoc 7 . |
.Xr mdoc 7 . |
.Pp |
.Pp |
|
The |
|
.Xr mandoc.db 5 |
|
database is used for looking up manual page entries. |
|
In cases where the database is absent, outdated, or corrupt, |
|
.Nm |
|
falls back to looking for files called |
|
.Ar name . Ns Ar section . |
If both a formatted and an unformatted version of the same manual page, |
If both a formatted and an unformatted version of the same manual page, |
for example |
for example |
.Pa cat1/foo.0 |
.Pa cat1/foo.0 |
and |
and |
.Pa man1/foo.1 , |
.Pa man1/foo.1 , |
exist in the same directory, only the unformatted version is used. |
exist in the same directory, only the unformatted version is used. |
|
The database is kept up to date with |
|
.Xr makewhatis 8 , |
|
which is run by the |
|
.Xr weekly 8 |
|
maintenance script. |
.Sh ENVIRONMENT |
.Sh ENVIRONMENT |
.Bl -tag -width MANPATHX |
.Bl -tag -width MANPATHX |
.It Ev MACHINE |
.It Ev MACHINE |
|
|
can be used to move to the next and to the previous place providing |
can be used to move to the next and to the previous place providing |
information about the term last searched for with |
information about the term last searched for with |
.Ic :t . |
.Ic :t . |
|
The |
|
.Fl O Cm tag Ns Op = Ns Ar term |
|
option documented in the |
|
.Xr mandoc 1 |
|
manual opens a manual page at the definition of a specific |
|
.Ar term |
|
rather than at the beginning. |
.It Ev MANPATH |
.It Ev MANPATH |
The standard search path used by |
The standard search path used by |
.Nm |
.Nm |
Line 297 If neither PAGER nor MANPAGER is defined, |
|
Line 317 If neither PAGER nor MANPAGER is defined, |
|
.Xr more 1 |
.Xr more 1 |
.Fl s |
.Fl s |
is used. |
is used. |
Only used if |
|
.Fl a |
|
or |
|
.Fl l |
|
is specified. |
|
.El |
.El |
.Sh FILES |
.Sh FILES |
.Bl -tag -width /etc/man.conf -compact |
.Bl -tag -width /etc/man.conf -compact |
Line 313 default man configuration file |
|
Line 328 default man configuration file |
|
See |
See |
.Xr mandoc 1 |
.Xr mandoc 1 |
for details. |
for details. |
|
.Sh EXAMPLES |
|
Format a page for pasting extracts into an email message \(em |
|
avoid printing any UTF-8 characters, reduce the width to ease |
|
quoting in replies, and remove markup: |
|
.Pp |
|
.Dl $ man -T ascii -O width=65 pledge | col -b |
|
.Pp |
|
Read a typeset page in a PDF viewer: |
|
.Pp |
|
.Dl $ MANPAGER=mupdf man -T pdf lpd |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr apropos 1 , |
.Xr apropos 1 , |
.Xr col 1 , |
.Xr col 1 , |