mandoc/mdoc.7 - diff - 1.271

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.268 and 1.271

version 1.268, 2017/07/05 12:25:17

version 1.271, 2018/07/28 18:34:15

Line 1

Line 1

.\" $Id$

.\" $Id$

.\"

.\"

.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>

.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>

.\" Copyright (c) 2010, 2011, 2013-2017 Ingo Schwarze <schwarze@openbsd.org>

.\" Copyright (c) 2010, 2011, 2013-2018 Ingo Schwarze <schwarze@openbsd.org>

.\"

.\"

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

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

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

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

Line 674 Examples:

Line 674 Examples:

.Ss \&Ao

.Ss \&Ao

Begin a block enclosed by angle brackets.

Begin a block enclosed by angle brackets.

Does not have any head arguments.

Does not have any head arguments.

.Pp

This macro is almost never useful.

Examples:

See

.Dl \&.Fl -key= \&Ns \&Ao \&Ar val \&Ac

.Sx \&Aq

.Pp

for more details.

See also

.Sx \&Aq .

.Ss \&Ap

.Ss \&Ap

Inserts an apostrophe without any surrounding whitespace.

Inserts an apostrophe without any surrounding whitespace.

This is generally used as a grammatical device when referring to the verb

This is generally used as a grammatical device when referring to the verb

Line 689 Examples:

Line 687 Examples:

.Dl \&.Fn execve \&Ap d

.Dl \&.Fn execve \&Ap d

.Ss \&Aq

.Ss \&Aq

Encloses its arguments in angle brackets.

Encloses its arguments in angle brackets.

The only important use case is for email addresses.

See

.Sx \&Mt

for an example.

.Pp

.Pp

Examples:

Occasionally, it is used for names of characters and keys, for example:

.Dl \&.Fl -key= \&Ns \&Aq \&Ar val

.Bd -literal -offset indent

Press the

\&.Aq escape

key to ...

.Ed

.Pp

.Pp

.Em Remarks :

For URIs, use

this macro is often abused for rendering URIs, which should instead use

.Sx \&Lk

.Sx \&Lk

instead, and

.Sx \&In

for

.Dq #include

directives.

Never wrap

.Sx \&Ar

in

.Sx \&Aq .

.Pp

Since

.Sx \&Aq

usually renders with non-ASCII characters in non-ASCII output modes,

do not use it where the ASCII characters

.Sq <

and

.Sq >

are required as syntax elements.

Instead, use these characters directly in such cases, combining them

with the macros

.Sx \&Pf ,

.Sx \&Ns ,

or

or

.Sx \&Mt ,

.Sx \&Eo

or to note pre-processor

as needed.

.Dq Li #include

statements, which should use

.Sx \&In .

.Pp

.Pp

See also

See also

.Sx \&Ao .

.Sx \&Ao .

Line 1210 The

Line 1234 The

.Ar month

.Ar month

is the full English month name, the

is the full English month name, the

.Ar day

.Ar day

is an optionally zero-padded numeral, and the

is an integer number, and the

.Ar year

.Ar year

is the full four-digit year.

is the full four-digit year.

.Pp

.Pp

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

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

.Pp

.Pp

Examples:

Examples:

.Dl \&.Dd $\&Mdocdate$

.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

.Pp

See also

See also

.Sx \&Dt

.Sx \&Dt

Line 3198 but produces large indentations.

Line 3222 but produces large indentations.

.Xr tbl 7

.Xr tbl 7

.Pp

.Pp

The web page

The web page

.Lk http://mdocml.bsd.lv/mdoc/ "extended documentation for the mdoc language"

.Lk http://mandoc.bsd.lv/mdoc/ "extended documentation for the mdoc language"

provides a few tutorial-style pages for beginners, an extensive style

provides a few tutorial-style pages for beginners, an extensive style

guide for advanced authors, and an alphabetic index helping to choose

guide for advanced authors, and an alphabetic index helping to choose

the best macros for various kinds of content.

the best macros for various kinds of content.