version 1.278, 2019/04/24 13:15:00 |
version 1.281, 2020/02/13 18:32:56 |
|
|
.\" $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-2018 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2010, 2011, 2013-2020 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 449 in the alphabetical |
|
Line 449 in the alphabetical |
|
.It Ic \&Ss Ta subsection header (one line) |
.It Ic \&Ss Ta subsection header (one line) |
.It Ic \&Sx Ta internal cross reference to a section or subsection |
.It Ic \&Sx Ta internal cross reference to a section or subsection |
.It Ic \&Xr Ta cross reference to another manual page: Ar name section |
.It Ic \&Xr Ta cross reference to another manual page: Ar name section |
|
.It Ic \&Tg Ta tag the definition of a Ar term Pq <= 1 arguments |
.It Ic \&Pp Ta start a text paragraph (no arguments) |
.It Ic \&Pp Ta start a text paragraph (no arguments) |
.El |
.El |
.Ss Displays and lists |
.Ss Displays and lists |
|
|
block. |
block. |
Does not have any tail arguments. |
Does not have any tail arguments. |
.It Ic \&Dd Cm $\&Mdocdate$ | Ar month day , year |
.It Ic \&Dd Cm $\&Mdocdate$ | Ar month day , year |
Document date for display in the page footer. |
Document date for display in the page footer, |
|
by convention the date of the last change. |
This is the mandatory first macro of any |
This is the mandatory first macro of any |
.Nm |
.Nm |
manual. |
manual. |
Line 2548 Table cell separator in |
|
Line 2550 Table cell separator in |
|
.Ic \&Bl Fl column |
.Ic \&Bl Fl column |
lists; can only be used below |
lists; can only be used below |
.Ic \&It . |
.Ic \&It . |
|
.It Ic \&Tg Op Ar term |
|
Announce that the next input line starts a definition of the |
|
.Ar term . |
|
This macro must appear alone on its own input line. |
|
The argument defaults to the first argument of the first macro |
|
on the next line. |
|
The argument may not contain whitespace characters, not even when it is quoted. |
|
This macro is a |
|
.Xr mandoc 1 |
|
extension and is typically ignored by other formatters. |
|
.Pp |
|
When viewing terminal output with |
|
.Xr less 1 , |
|
the interactive |
|
.Ic :t |
|
command can be used to go to the definition of the |
|
.Ar term |
|
as described for the |
|
.Ev MANPAGER |
|
variable in |
|
.Xr man 1 ; |
|
when producing HTML output, a fragment identifier |
|
.Pq Ic id No attribute |
|
is generated, to be used for deep linking to this place of the document. |
|
.Pp |
|
In most cases, adding a |
|
.Ic \&Tg |
|
macro would be redundant because |
|
.Xr mandoc 1 |
|
is able to automatically tag most definitions. |
|
This macro is intended for cases where automatic tagging of a |
|
.Ar term |
|
is unsatisfactory, for example if a definition is not tagged |
|
automatically (false negative) or if places are tagged that do |
|
not define the |
|
.Ar term |
|
(false positives). |
|
When there is at least one |
|
.Ic \&Tg |
|
macro for a |
|
.Ar term , |
|
no other places are automatically marked as definitions of that |
|
.Ar term . |
.It Ic \&Tn Ar word ... |
.It Ic \&Tn Ar word ... |
Supported only for compatibility, do not use this in new manuals. |
Supported only for compatibility, do not use this in new manuals. |
Even though the macro name |
Even though the macro name |
Line 2912 then the macro accepts an arbitrary number of argument |
|
Line 2957 then the macro accepts an arbitrary number of argument |
|
.It Ic \&St Ta \&No Ta Yes Ta 1 |
.It Ic \&St Ta \&No Ta Yes Ta 1 |
.It Ic \&Sx Ta Yes Ta Yes Ta >0 |
.It Ic \&Sx Ta Yes Ta Yes Ta >0 |
.It Ic \&Sy Ta Yes Ta Yes Ta >0 |
.It Ic \&Sy Ta Yes Ta Yes Ta >0 |
|
.It Ic \&Tg Ta \&No Ta \&No Ta <2 |
.It Ic \&Tn Ta Yes Ta Yes Ta >0 |
.It Ic \&Tn Ta Yes Ta Yes Ta >0 |
.It Ic \&Ud Ta \&No Ta \&No Ta 0 |
.It Ic \&Ud Ta \&No Ta \&No Ta 0 |
.It Ic \&Ux Ta Yes Ta Yes Ta n |
.It Ic \&Ux Ta Yes Ta Yes Ta n |
Line 3005 in the same way as a plain |
|
Line 3051 in the same way as a plain |
|
.Sq \&| |
.Sq \&| |
character. |
character. |
Using this predefined string is not recommended in new manuals. |
Using this predefined string is not recommended in new manuals. |
|
.Pp |
|
Appending a zero-width space |
|
.Pq Sq \e& |
|
to the end of an input line is also useful to prevent the interpretation |
|
of a trailing period, exclamation or question mark as the end of a |
|
sentence, for example when an abbreviation happens to occur |
|
at the end of a text or macro input line. |
.Ss Font handling |
.Ss Font handling |
In |
In |
.Nm |
.Nm |
Line 3032 The following problematic behaviour is found in groff: |
|
Line 3085 The following problematic behaviour is found in groff: |
|
.Pp |
.Pp |
.Bl -dash -compact |
.Bl -dash -compact |
.It |
.It |
.Ic \&Dd |
|
with non-standard arguments behaves very strangely. |
|
When there are three arguments, they are printed verbatim. |
|
Any other number of arguments is replaced by the current date, |
|
but without any arguments the string |
|
.Dq Epoch |
|
is printed. |
|
.It |
|
.Ic \&Lk |
|
only accepts a single link-name argument; the remainder is misformatted. |
|
.It |
|
.Ic \&Pa |
.Ic \&Pa |
does not format its arguments when used in the FILES section under |
does not format its arguments when used in the FILES section under |
certain list types. |
certain list types. |
.It |
.It |
.Ic \&Ta |
.Ic \&Ta |
can only be called by other macros, but not at the beginning of a line. |
can only be called by other macros, but not at the beginning of a line. |
.It |
|
.Ic \&%C |
|
is not implemented (up to and including groff-1.22.2). |
|
.It |
.It |
.Sq \ef |
.Sq \ef |
.Pq font face |
.Pq font face |