mandoc/man.1 - diff

Return to man.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/man.1 between version 1.27 and 1.35

version 1.27, 2017/03/27 14:40:39

version 1.35, 2019/03/09 15:55:01

Line 3

.\"

.\" Redistribution and use in source and binary forms, with or without

.\" modification, are permitted provided that the following conditions

Line 41

.Nm man

.Op Fl acfhklw

.Op Fl C Ar file

.Op Fl I Cm os Ns = Ns Ar name

.Op Fl K Ar encoding

.Op Fl M Ar path

.Op Fl m Ar path

.Op Fl O Ar option Ns = Ns Ar value

.Op Fl S Ar subsection

.Op Fl s Ar section

.Op Oo Fl s Oc Ar section

.Op Fl T Ar output

.Op Fl W Ar level

.Op Ar section

.Ar name ...

.Sh DESCRIPTION

The

Line 84 Copy the manual page to the standard output instead of

Line 78 Copy the manual page to the standard output instead of

.Xr more 1

to paginate it.

This is done by default if the standard output is not a terminal device.

.Pp

When using

.Fl c ,

most terminal devices are unable to show the markup.

To print the output of

.Nm

to the terminal with markup but without using a pager, pipe it to

.Xr ul 1 .

To remove the markup, pipe the output to

.Xr col 1

.Fl b

instead.

.It Fl f

A synonym for

.Xr whatis 1 .

Line 108 manual.

Line 114 manual.

By default, it displays the header lines of all matching pages.

.It Fl l

A synonym for

.Xr mandoc 1

.Xr mandoc 1 .

.Fl a .

The

.Ar name

arguments are interpreted as filenames.

Line 121 No search is done and

Line 126 No search is done and

and

.Fl w

are ignored.

This option implies

.Fl a .

.It Fl M Ar path

Override the list of standard directories which

.Nm

Line 211 Guidelines for writing

Line 218 Guidelines for writing

man pages can be found in

.Xr mdoc 7 .

.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,

for example

.Pa cat1/foo.0

and

.Pa man1/foo.1 ,

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

.Bl -tag -width MANPATHX

.It Ev MACHINE

Line 259 and

Line 278 and

can be used to move to the next and to the previous place providing

information about the term last searched for with

.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

The standard search path used by

.Nm

Line 268 environment variable.

Line 294 environment variable.

The format of the path is a colon

.Pq Ql \&:

separated list of directories.

Invalid paths, or paths without manual databases, are ignored.

Invalid paths are ignored.

Overridden by

.Fl M ,

ignored if

Line 291 If neither PAGER nor MANPAGER is defined,

Line 317 If neither PAGER nor MANPAGER is defined,

.Xr more 1

.Fl s

is used.

Only used if

.Fl a

.Fl l

is specified.

.El

.Sh FILES

.Bl -tag -width /etc/man.conf -compact

Line 307 default man configuration file

Line 328 default man configuration file

See

.Xr mandoc 1

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

.Xr apropos 1 ,

.Xr intro 1 ,

.Xr col 1 ,

.Xr mandoc 1 ,

.Xr ul 1 ,

.Xr whereis 1 ,

.Xr intro 2 ,

.Xr intro 3 ,

.Xr intro 4 ,

.Xr intro 5 ,

.Xr man.conf 5 ,

.Xr intro 6 ,

.Xr mdoc 7

.Xr intro 7 ,

.Xr mdoc 7 ,

.Xr intro 8 ,

.Xr intro 9

.Sh STANDARDS

The

.Nm

CVSweb