mandoc/mdoc.7 - diff

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.270 and 1.273

version 1.270, 2017/10/23 13:54:41

version 1.273, 2018/12/23 16:55:34

Line 1

.\" $Id$

.\"

.\" Permission to use, copy, modify, and distribute this software for any

.\" purpose with or without fee is hereby granted, provided that the above

Line 449 in the alphabetical

.It Sx \&Ss Ta subsection header (one line)

.It Sx \&Sx Ta internal cross reference to a section or subsection

.It Sx \&Xr Ta cross reference to another manual page: Ar name section

.It Sx \&Pp , \&Lp Ta start a text paragraph (no arguments)

.It Sx \&Pp Ta start a text paragraph (no arguments)

.El

.Ss Displays and lists

.Bl -column "Brq, Bro, Brc" description

Line 522 in the alphabetical

.Bl -column "Brq, Bro, Brc" description

.It Sx \&Em Ta italic font or underline (emphasis) (>0 arguments)

.It Sx \&Sy Ta boldface font (symbolic) (>0 arguments)

.It Sx \&Li Ta typewriter font (literal) (>0 arguments)

.It Sx \&No Ta return to roman font (normal) (no arguments)

.It Sx \&Bf , \&Ef Ta font block:

.Op Fl Ar type | Cm \&Em | \&Li | \&Sy

Line 1234 The

Line 1233 The

.Ar month

is the full English month name, the

.Ar day

is an optionally zero-padded numeral, and the

is an integer number, and the

.Ar year

is the full four-digit year.

.Pp

Line 1264 If no date string is given, the current date is used.

Line 1263 If no date string is given, the current date is used.

.Pp

Examples:

.Dl \&.Dd $\&Mdocdate$

.Dl \&.Dd $\&Mdocdate: July 21 2007$

.Dl \&.Dd $\&Mdocdate: July 2 2018$

.Dl \&.Dd July 21, 2007

.Dl \&.Dd July 2, 2018

.Pp

See also

.Sx \&Dt

Line 1474 to save the pattern space for subsequent retrieval.

Line 1473 to save the pattern space for subsequent retrieval.

.Ed

.Pp

See also

.Sx \&Bf ,

.Sx \&Li ,

.Sx \&No ,

.Sx \&Ql ,

and

.Sx \&Sy .

.Ss \&En

Line 1776 Examples:

Line 1774 Examples:

.Dl \&.Ic alias

.Pp

Note that using

.Sx \&Bd Fl literal

.Sx \&Ql ,

.Sx \&Dl ,

.Sx \&D1

.Sx \&Bd Fl literal

is preferred for displaying code; the

is preferred for displaying code samples; the

.Sx \&Ic

macro is used when referring to specific instructions.

macro is used when referring to an individual command name.

.Ss \&In

The name of an include file.

This macro is most often used in section 2, 3, and 9 manual pages.

Line 1915 Examples:

Line 1914 Examples:

.Dl \&.Lb libz

.Dl \&.Lb libmandoc

.Ss \&Li

Denotes text that should be in a

Request a typewriter (literal) font.

.Li literal

Deprecated because on terminal output devices, this is usually

font mode.

indistinguishable from normal text.

Note that this is a presentation term and should not be used for

For literal displays, use

stylistically decorating technical terms.

.Sx \&Ql Pq in-line ,

.Pp

.Sx \&Dl Pq single line ,

On terminal output devices, this is often indistinguishable from

normal text.

.Sx \&Bd Fl literal Pq multi-line

.Pp

instead.

See also

.Sx \&Bf ,

.Sx \&Em ,

.Sx \&No ,

and

.Sx \&Sy .

.Ss \&Lk

Format a hyperlink.

Its syntax is as follows:

Line 1943 Examples:

Line 1936 Examples:

See also

.Sx \&Mt .

.Ss \&Lp

Synonym for

Deprecated synonym for

.Sx \&Pp .

.Ss \&Ms

Display a mathematical symbol.

Line 2046 Examples:

Line 2039 Examples:

.Pp

See also

.Sx \&Em ,

.Sx \&Li ,

.Sx \&Ql ,

and

.Sx \&Sy .

.Ss \&Ns

Line 2244 Close quoted context opened by

Line 2237 Close quoted context opened by

.Sx \&Qo .

.Ss \&Ql

In-line literal display.

This can for example be used for complete command invocations and

This can be used for complete command invocations and for multi-word

for multi-word code fragments when more specific markup is not

code examples when an indented display is not desired.

appropriate and an indented display is not desired.

While

.Xr mandoc 1

always encloses the arguments in single quotes, other formatters

usually omit the quotes on non-terminal output devices when the

arguments have three or more characters.

.Pp

See also

.Sx \&Dl

Line 2655 program.

Line 2642 program.

.Ed

.Pp

See also

.Sx \&Bf ,

.Sx \&Em ,

.Sx \&Li ,

.Sx \&No ,

and

.Sx \&No .

.Sx \&Ql .

.Ss \&Ta

Table cell separator in

.Sx \&Bl Fl column

CVSweb