diff options
| author | Michael Kerrisk <mtk.manpages@gmail.com> | 2012-09-24 10:23:07 +0200 |
|---|---|---|
| committer | Michael Kerrisk <mtk.manpages@gmail.com> | 2012-09-24 10:23:07 +0200 |
| commit | 9f8e673e623dc6fbae517885f4161a29e9c24d1d (patch) | |
| tree | 640be3c83321e9a56832c4532bf0b1ba780cfba3 /man7/mdoc.samples.7 | |
| parent | 6c1544c1325437c9d1dc53c73c6c5fe72d3f62b3 (diff) | |
| download | man-pages-9f8e673e623dc6fbae517885f4161a29e9c24d1d.tar.gz | |
time.1, atexit.3, bsearch.3, dlopen.3, envz_add.3, errno.3, fmtmsg.3, getgrent_r.3, getline.3, getmntent.3, getnameinfo.3, getpass.3, getpwent_r.3, gets.3, isalpha.3, printf.3, puts.3, recno.3, scandir.3, stdarg.3, sysconf.3, termios.3, wordexp.3, null.4, core.5, dir_colors.5, issue.5, proc.5, termcap.5, utmp.5, ascii.7, cpuset.7, glob.7, man-pages.7, man.7, mdoc.7, mdoc.samples.7, regex.7: Global fix: use \\ rather than \e for literal backslash
Reported-by: Jan Engelhardt <jengelh@inai.de>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
Diffstat (limited to 'man7/mdoc.samples.7')
| -rw-r--r-- | man7/mdoc.samples.7 | 114 |
1 files changed, 57 insertions, 57 deletions
diff --git a/man7/mdoc.samples.7 b/man7/mdoc.samples.7 index 196b4b3c9e..3f68e18b1b 100644 --- a/man7/mdoc.samples.7 +++ b/man7/mdoc.samples.7 @@ -231,10 +231,10 @@ at the beginning of a line in some context other than a macro invocation, precede the .Ql \&\. (dot) with the -.Ql \e& +.Ql \\& escape sequence. The -.Ql \e& +.Ql \\& translates literally to a zero width space, and is never displayed in the output. .Pp @@ -289,11 +289,11 @@ To prevent a two character string from being interpreted as a macro name, precede the string with the escape sequence -.Ql \e& : +.Ql \\& : .Bl -tag -width "\&.Op \&Fl s \&Ar bytes" -offset indent .It Op \&Fl s \&Ar bytes is produced by -.Li \&.Op \e&Fl s \e&Ar bytes +.Li \&.Op \\&Fl s \\&Ar bytes .El .Pp Here the strings @@ -379,9 +379,9 @@ Title of article in a book or journal. .Pp One way of passing a string containing blank spaces is to use the hard or unpaddable space character -.Ql \e\ , +.Ql \\\ , that is, a blank space preceded by the escape character -.Ql \e . +.Ql \\ . This method may be used with any macro but has the side effect of interfering with the adjustment of text over the length of a line. @@ -395,14 +395,14 @@ For example: .Bl -tag -width "fetch(char *str)" -offset indent .It Fn fetch char\ *str is created by -.Ql \&.Fn fetch char\e *str +.Ql \&.Fn fetch char\\ *str .It Fn fetch "char *str" can also be created by .Ql \&.Fn fetch "\\*qchar *str\\*q" .El .Pp If the -.Ql \e +.Ql \\ or quotes were omitted, .Ql \&.Fn @@ -424,20 +424,20 @@ from <blank-space><end-of-line> character sequences. Should the need arise to force a blank character at the end of a line, it may be forced with an unpaddable space and the -.Ql \e& +.Ql \\& escape character. For example, -.Ql string\e\ \e& . +.Ql string\\\ \\& . .Ss Escaping Special Characters Special characters like the newline character -.Ql \en , +.Ql \\n , are handled by replacing the -.Ql \e +.Ql \\ with -.Ql \ee +.Ql \\e (e.g., -.Ql \een ) +.Ql \\en ) to preserve the backslash. .Sh THE ANATOMY OF A MAN PAGE @@ -450,7 +450,7 @@ in .Pp .Ss A manual page template .Bd -literal -offset indent -\&.\e" The following requests are required for all man pages. +\&.\\" The following requests are required for all man pages. \&.Dd Month day, year \&.Os OPERATING_SYSTEM [version/release] \&.Dt DOCUMENT_TITLE [section number] [volume] @@ -459,26 +459,26 @@ in \&.Nd one line description of name \&.Sh SYNOPSIS \&.Sh DESCRIPTION -\&.\e" The following requests should be uncommented and -\&.\e" used where appropriate. This next request is -\&.\e" for sections 2 and 3 function return values only. -\&.\e" .Sh RETURN VALUE -\&.\e" This next request is for sections 1, 6, 7 & 8 only -\&.\e" .Sh ENVIRONMENT -\&.\e" .Sh FILES -\&.\e" .Sh EXAMPLES -\&.\e" This next request is for sections 1, 6, 7 & 8 only -\&.\e" (command return values (to shell) and -\&.\e" fprintf/stderr type diagnostics) -\&.\e" .Sh DIAGNOSTICS -\&.\e" The next request is for sections 2 and 3 error -\&.\e" and signal handling only. -\&.\e" .Sh ERRORS -\&.\e" .Sh SEE ALSO -\&.\e" .Sh CONFORMING TO -\&.\e" .Sh HISTORY -\&.\e" .Sh AUTHORS -\&.\e" .Sh BUGS +\&.\\" The following requests should be uncommented and +\&.\\" used where appropriate. This next request is +\&.\\" for sections 2 and 3 function return values only. +\&.\\" .Sh RETURN VALUE +\&.\\" This next request is for sections 1, 6, 7 & 8 only +\&.\\" .Sh ENVIRONMENT +\&.\\" .Sh FILES +\&.\\" .Sh EXAMPLES +\&.\\" This next request is for sections 1, 6, 7 & 8 only +\&.\\" (command return values (to shell) and +\&.\\" fprintf/stderr type diagnostics) +\&.\\" .Sh DIAGNOSTICS +\&.\\" The next request is for sections 2 and 3 error +\&.\\" and signal handling only. +\&.\\" .Sh ERRORS +\&.\\" .Sh SEE ALSO +\&.\\" .Sh CONFORMING TO +\&.\\" .Sh HISTORY +\&.\\" .Sh AUTHORS +\&.\\" .Sh BUGS .Ed .Pp The first items in the template are the macros @@ -785,7 +785,7 @@ default font distinguishing it from the strings in literal font. .Pp To remove the special meaning from a punctuation character escape it with -.Ql \e& . +.Ql \\& . .Xr Troff is limited as a macro language, and has difficulty when presented with a string containing @@ -801,7 +801,7 @@ may assume it is supposed to actually perform the operation or evaluation suggested by the characters. To prevent the accidental evaluation of these characters, escape them with -.Ql \e& . +.Ql \\& . Typical syntax is shown in the first content macro displayed below, .Ql \&.Ad . @@ -1249,7 +1249,7 @@ it can not recall the first argument it was invoked with. .Bl -tag -width "\&.Nm mdoc.sample" -compact -offset 14n .It Li \&.Nm mdoc.sample .Nm mdoc.sample -.It Li \&.Nm \e-mdoc +.It Li \&.Nm \\-mdoc .Nm \-mdoc . .It Li \&.Nm foo\ )\ )\ , .Nm foo ) ) , @@ -1710,7 +1710,7 @@ using the space mode macro to turn spacing off: .Bd -literal -offset indent \&.Sm off \&.It Xo Sy I Ar operation -\&.No \een Ar count No \een +\&.No \\en Ar count No \\en \&.Xc \&.Sm on .Ed @@ -1720,7 +1720,7 @@ Produces .Bl -tag -width flag -compact .Sm off .It Xo Sy I Ar operation -.No \en Ar count No \en +.No \\n Ar count No \\n .Xc .Sm on .El @@ -1755,7 +1755,7 @@ Test the value of a variable. .Bd -literal -offset indent \&.It Xo \&.Ic .ifndef -\&.Oo \e&! Oc Ns Ar variable +\&.Oo \\&! Oc Ns Ar variable \&.Op Ar operator variable ... \&.Xc .Ed @@ -2076,7 +2076,7 @@ macro asserts a vertical distance unless the -compact flag is given). .\" around the .\" .Li \&+ .\" signs were forced with -.\" .Li \e : +.\" .Li \\ : .\" .Pp .\" .Ds I .\" .Cw (ax\ +\ bx\ +\ c) \ is\ produced\ by\ \& @@ -2091,7 +2091,7 @@ macro asserts a vertical distance unless the -compact flag is given). .\" .Li \&.Sy x .\" .Cx .\" .Cl Cx \t\t -.\" .Li \&.Cx \e\ +\e\ \e& +.\" .Li \&.Cx \\\ +\\\ \\& .\" .Cx .\" .Cl Cx \&(\& .\" .Va a @@ -2110,7 +2110,7 @@ macro asserts a vertical distance unless the -compact flag is given). .\" .Li \&.Sy y .\" .Cx .\" .Cl Cx \t\t -.\" .Li \&.Cx \e\ +\e\ \e& +.\" .Li \&.Cx \\\ +\\\ \\& .\" .Cx .\" .Cl Cx \t\t .\" .Li \&.Va c ) @@ -2141,7 +2141,7 @@ macro asserts a vertical distance unless the -compact flag is given). .\" .Cx \t .\" .Em is produced by .\" .Cx \t -.\" .Li \&.Ar \e\ b1 e1 f1 +.\" .Li \&.Ar \\\ b1 e1 f1 .\" .Cx .\" .Cl Cx \t\t .\" .Li \&.Op Sy ?/ @@ -2336,8 +2336,8 @@ would be typed. .Pp .Dl Usage: .Li argument ... \*(Pu .Bl -tag -width "\&.Li cntrl-D ) ," -compact -offset 14n -.It Li \&.Li \een -.Li \en +.It Li \&.Li \\en +.Li \\n .It Li \&.Li M1 M2 M3\ ; .Li M1 M2 M3 ; .It Li \&.Li cntrl-D\ )\ , @@ -2647,11 +2647,11 @@ macro name, a new and nested list is assumed. .Sh PREDEFINED STRINGS The following strings are predefined as may be used by preceding with the troff string interpreting sequence -.Ql \&\e*(xx +.Ql \&\\*(xx where .Em xx is the name of the defined string or as -.Ql \&\e*x +.Ql \&\\*x where .Em x is the name of the string. @@ -2685,7 +2685,7 @@ The interpreting sequence may be used any where in the text. The string named .Ql q should be written as -.Ql \e*q +.Ql \\*q since it is only one char. .Sh DIAGNOSTICS The debugging facilities for @@ -2718,7 +2718,7 @@ two lower case characters or a dot plus a letter or metacharacter character. In one of the introduction examples, it was shown how to prevent the interpretation of a macro name with the escape sequence -.Ql \e& . +.Ql \\& . This is sufficient for the internal register names also. .Pp .\" Every callable macro name has a corresponding register @@ -2767,7 +2767,7 @@ the debug macro placed above and below an artificially created problem (a flag argument .Ql \&aC which should be -.Ql \e&aC +.Ql \\&aC in order to work): .Bd -literal -offset indent \&.Db on @@ -2820,7 +2820,7 @@ In this next example, the offending is escaped: .Bd -literal -offset indent \&.Db on -\&.Em An escaped \e&aC +\&.Em An escaped \\&aC \&.Db off .Ed .Bd -literal -offset indent @@ -2837,12 +2837,12 @@ DEBUGGING OFF .Ed .Pp The argument -.Ql \e&aC +.Ql \\&aC shows up with the same length of 2 as the -.Ql \e& +.Ql \\& sequence produces a zero width, but a register named -.Ql \e&aC +.Ql \\&aC was not found and the type classified as string. .Pp Other diagnostics consist of usage statements and are self explanatory. @@ -2913,7 +2913,7 @@ and certainly should be able to. .\" boundary. .\" to make sure a line boundary is crossed: .\" .Bd -literal -.\" \&.Fn struct\e\ dictionarytable\e\ *dictionarylookup struct\e\ dictionarytable\e\ *tab[] +.\" \&.Fn struct\\\ dictionarytable\\\ *dictionarylookup struct\\\ dictionarytable\\\ *tab[] .\" .Ed .\" .Pp .\" produces, nudge nudge, |