When in the POSIX locale, use the precise traditional format
.IP
.in +4n
-"real %f\\nuser %f\\nsys %f\\n"
+"real %f\enuser %f\ensys %f\en"
.in
.IP
(with numbers in seconds)
.SS "The format string"
The format is interpreted in the usual printf-like way.
Ordinary characters are directly copied, tab, newline
-and backslash are escaped using \\t, \\n and \\\\,
+and backslash are escaped using \et, \en and \e\e,
a percent sign is represented by %%, and otherwise %
indicates a conversion.
The program
void
bye(void)
{
- printf("That was all, folks\\n");
+ printf("That was all, folks\en");
}
int
int i;
a = sysconf(_SC_ATEXIT_MAX);
- printf("ATEXIT_MAX = %ld\\n", a);
+ printf("ATEXIT_MAX = %ld\en", a);
i = atexit(bye);
if (i != 0) {
- fprintf(stderr, "cannot set exit function\\n");
+ fprintf(stderr, "cannot set exit function\en");
exit(EXIT_FAILURE);
}
res = bsearch(&key, months, nr_of_months,
sizeof(struct mi), compmi);
if (res == NULL)
- printf("\(aq%s\(aq: unknown month\\n", argv[i]);
+ printf("\(aq%s\(aq: unknown month\en", argv[i]);
else
- printf("%s: month #%d\\n", res\->name, res\->nr);
+ printf("%s: month #%d\en", res\->name, res\->nr);
}
exit(EXIT_SUCCESS);
}
handle = dlopen("libm.so", RTLD_LAZY);
if (!handle) {
- fprintf(stderr, "%s\\n", dlerror());
+ fprintf(stderr, "%s\en", dlerror());
exit(EXIT_FAILURE);
}
.\" But in fact "gcc -O2 -Wall" will complain about the preceding cast.
if ((error = dlerror()) != NULL) {
- fprintf(stderr, "%s\\n", error);
+ fprintf(stderr, "%s\en", error);
exit(EXIT_FAILURE);
}
- printf("%f\\n", (*cosine)(2.0));
+ printf("%f\en", (*cosine)(2.0));
dlclose(handle);
exit(EXIT_SUCCESS);
}
e_len += strlen(envp[i]) + 1;
str = envz_entry(*envp, e_len, "HOME");
- printf("%s\\n", str);
+ printf("%s\en", str);
str = envz_get(*envp, e_len, "HOME");
- printf("%s\\n", str);
+ printf("%s\en", str);
exit(EXIT_SUCCESS);
}
.fi
.nf
if (somecall() == \-1) {
- printf("somecall() failed\\n");
+ printf("somecall() failed\en");
if (errno == ...) { ... }
}
if (somecall() == \-1) {
int errsv = errno;
- printf("somecall() failed\\n");
+ printf("somecall() failed\en");
if (errsv == ...) { ... }
}
.fi
case MM_OK:
break;
case MM_NOTOK:
- printf("Nothing printed\\n");
+ printf("Nothing printed\en");
break;
case MM_NOMSG:
- printf("Nothing printed to stderr\\n");
+ printf("Nothing printed to stderr\en");
break;
case MM_NOCON:
- printf("No console output\\n");
+ printf("No console output\en");
break;
default:
- printf("Unknown error from fmtmsg()\\n");
+ printf("Unknown error from fmtmsg()\en");
}
exit(EXIT_SUCCESS);
}
break;
printf(" %s", grpp\->gr_mem[i]);
}
- printf("\\n");
+ printf("\en");
}
endgrent();
exit(EXIT_SUCCESS);
exit(EXIT_FAILURE);
while ((read = getline(&line, &len, fp)) != \-1) {
- printf("Retrieved line of length %zu :\\n", read);
+ printf("Retrieved line of length %zu :\en", read);
printf("%s", line);
}
.in
Since fields in the mtab and fstab files are separated by whitespace,
-octal escapes are used to represent the four characters space (\\040),
-tab (\\011), newline (\\012) and backslash (\\134) in those files
+octal escapes are used to represent the four characters space (\e040),
+tab (\e011), newline (\e012) and backslash (\e134) in those files
when they occur in one of the four strings in a
.I mntent
structure.
if (getnameinfo(sa, len, hbuf, sizeof(hbuf), sbuf,
sizeof(sbuf), NI_NUMERICHOST | NI_NUMERICSERV) == 0)
- printf("host=%s, serv=%s\\n", hbuf, sbuf);
+ printf("host=%s, serv=%s\en", hbuf, sbuf);
.fi
.in
NULL, 0, NI_NAMEREQD))
printf("could not resolve hostname");
else
- printf("host=%s\\n", hbuf);
+ printf("host=%s\en", hbuf);
.fi
.in
.PP
.BR SIGSTOP ,
.BR SIGTSTP )
is disabled and the corresponding characters
-(usually control-C, control-\\, control-Z and control-Y)
+(usually control-C, control-\e, control-Z and control-Y)
are transmitted as part of the password.
Since libc 5.4.19 also line editing is disabled, so that also
backspace and the like will be seen as part of the password.
i = getpwent_r(&pw, buf, BUFLEN, &pwp);
if (i)
break;
- printf("%s (%d)\\tHOME %s\\tSHELL %s\\n", pwp\->pw_name,
+ printf("%s (%d)\etHOME %s\etSHELL %s\en", pwp\->pw_name,
pwp\->pw_uid, pwp\->pw_dir, pwp\->pw_shell);
}
endpwent();
.I s
until either a terminating newline or
.BR EOF ,
-which it replaces with a null byte (\(aq\\0\(aq).
+which it replaces with a null byte (\(aq\e0\(aq).
No check for buffer overrun is performed (see BUGS below).
.PP
.BR fgets ()
.B EOF
or a newline.
If a newline is read, it is stored into the buffer.
-A terminating null byte (\(aq\\0\(aq)
+A terminating null byte (\(aq\e0\(aq)
is stored after the last character in the buffer.
.PP
.BR ungetc ()
and
.B """POSIX"""
locales, these are: space, form-feed
-.RB ( \(aq\\f\(aq ),
+.RB ( \(aq\ef\(aq ),
newline
-.RB ( \(aq\\n\(aq ),
+.RB ( \(aq\en\(aq ),
carriage return
-.RB ( \(aq\\r\(aq ),
+.RB ( \(aq\er\(aq ),
horizontal tab
-.RB ( \(aq\\t\(aq ),
+.RB ( \(aq\et\(aq ),
and vertical tab
-.RB ( \(aq\\v\(aq ).
+.RB ( \(aq\ev\(aq ).
.TP
.BR isupper ()
checks for an uppercase letter.
.BR vsnprintf ()
write at most
.I size
-bytes (including the terminating null byte (\(aq\\0\(aq)) to
+bytes (including the terminating null byte (\(aq\e0\(aq)) to
.IR str .
.PP
The functions
.BR vsnprintf ()
do not write more than
.I size
-bytes (including the terminating null byte (\(aq\\0\(aq)).
+bytes (including the terminating null byte (\(aq\e0\(aq)).
If the output was truncated due to this limit then the return value
is the number of characters (excluding the terminating null byte)
which would have been written to the final string if enough space
#include <math.h>
#include <stdio.h>
-fprintf(stdout, "pi = %.5f\\n", 4 * atan(1.0));
+fprintf(stdout, "pi = %.5f\en", 4 * atan(1.0));
.fi
.in
.PP
.nf
#include <stdio.h>
-fprintf(stdout, "%s, %s %d, %.2d:%.2d\\n",
+fprintf(stdout, "%s, %s %d, %.2d:%.2d\en",
weekday, month, day, hour, min);
.fi
.in
.in +4n
.nf
-"%1$s, %3$d. %2$s, %4$d:%5$.2d\\n"
+"%1$s, %3$d. %2$s, %4$d:%5$.2d\en"
.fi
.in
.I s
to
.IR stream ,
-without its terminating null byte (\(aq\\0\(aq).
+without its terminating null byte (\(aq\e0\(aq).
.PP
.BR putc ()
is equivalent to
The delimiting byte to be used to mark the end of a record for
variable-length records, and the pad character for fixed-length
records.
-If no value is specified, newlines ("\\n") are used to mark the end
+If no value is specified, newlines ("\en") are used to mark the end
of variable-length records and fixed-length records are padded with
spaces.
.TP
perror("scandir");
else {
while (n\-\-) {
- printf("%s\\n", namelist[n]\->d_name);
+ printf("%s\en", namelist[n]\->d_name);
free(namelist[n]);
}
free(namelist);
switch (*fmt++) {
case \(aqs\(aq: /* string */
s = va_arg(ap, char *);
- printf("string %s\\n", s);
+ printf("string %s\en", s);
break;
case \(aqd\(aq: /* int */
d = va_arg(ap, int);
- printf("int %d\\n", d);
+ printf("int %d\en", d);
break;
case \(aqc\(aq: /* char */
/* need a cast here since va_arg only
takes fully promoted types */
c = (char) va_arg(ap, int);
- printf("char %c\\n", c);
+ printf("char %c\en", c);
break;
}
va_end(ap);
.BR RE_DUP_MAX " - " _SC_RE_DUP_MAX
The maximum number of repeated occurrences of a regular expression when
the interval notation
-.B \\{m,n\\}
+.B \e{m,n\e}
is used.
.TP
.BR POSIX2_VERSION " - " _SC_2_VERSION
Minimum number of characters for noncanonical read (MIN).
.TP
.B VQUIT
-(034, FS, Ctrl-\\)
+(034, FS, Ctrl-\e)
Quit character (QUIT).
Send
.B SIGQUIT
wordexp("[a\-c]*.c", &p, 0);
w = p.we_wordv;
for (i = 0; i < p.we_wordc; i++)
- printf("%s\\n", w[i]);
+ printf("%s\en", w[i]);
wordfree(&p);
exit(EXIT_SUCCESS);
}
Reads from the \fBnull\fP special file always return end of file (i.e.,
.BR read (2)
returns 0), whereas
-reads from \fBzero\fP always return bytes containing zero (\\0 characters).
+reads from \fBzero\fP always return bytes containing zero (\e0 characters).
.LP
\fBnull\fP and \fBzero\fP are typically created by:
.RS
.RB "$" " su"
Password:
.RB "#" " echo \(dq|$PWD/core_pattern_pipe_test %p \
-UID=%u GID=%g sig=%s\(dq > \\"
+UID=%u GID=%g sig=%s\(dq > \e"
.B " /proc/sys/kernel/core_pattern"
.RB "#" " exit"
.RB "$" " sleep 100"
-.BR "^\\" " # type control-backslash"
+.BR "^\e" " # type control-backslash"
Quit (core dumped)
.RB "$" " cat core.info"
argc=5
can, however, be specified, which would have the same effect.
.SS "Escape Sequences"
To specify control- or blank characters in the color sequences or
-filename extensions, either C-style \\-escaped notation or
+filename extensions, either C-style \e-escaped notation or
.BR stty \-style
^-notation can be used.
The C-style notation
.RS +.2i
.ta 1.0i
.nf
-\fB\\a\fR Bell (ASCII 7)
-\fB\\b\fR Backspace (ASCII 8)
-\fB\\e\fR Escape (ASCII 27)
-\fB\\f\fR Form feed (ASCII 12)
-\fB\\n\fR Newline (ASCII 10)
-\fB\\r\fR Carriage Return (ASCII 13)
-\fB\\t\fR Tab (ASCII 9)
-\fB\\v\fR Vertical Tab (ASCII 11)
-\fB\\?\fR Delete (ASCII 127)
-\fB\\\fInnn\fR Any character (octal notation)
-\fB\\x\fInnn\fR Any character (hexadecimal notation)
-\fB\\_\fR Space
-\fB\\\\\fR Backslash (\\)
-\fB\\^\fR Caret (^)
-\fB\\#\fR Hash mark (#)
+\fB\ea\fR Bell (ASCII 7)
+\fB\eb\fR Backspace (ASCII 8)
+\fB\ee\fR Escape (ASCII 27)
+\fB\ef\fR Form feed (ASCII 12)
+\fB\en\fR Newline (ASCII 10)
+\fB\er\fR Carriage Return (ASCII 13)
+\fB\et\fR Tab (ASCII 9)
+\fB\ev\fR Vertical Tab (ASCII 11)
+\fB\e?\fR Delete (ASCII 127)
+\fB\e\fInnn\fR Any character (octal notation)
+\fB\ex\fInnn\fR Any character (hexadecimal notation)
+\fB\e_\fR Space
+\fB\e\e\fR Backslash (\e)
+\fB\e^\fR Caret (^)
+\fB\e#\fR Hash mark (#)
.fi
.RE
.sp
.RS +.2i
.ta 1.0i
.nf
-\fBLEFTCODE\fR \\e[
+\fBLEFTCODE\fR \ee[
\fBRIGHTCODE\fR m
.fi
.RE
.SH DESCRIPTION
The file \fI/etc/issue\fP is a text file which contains a message or
system identification to be printed before the login prompt.
-It may contain various \fB@\fP\fIchar\fP and \fB\\\fP\fIchar\fP
+It may contain various \fB@\fP\fIchar\fP and \fB\e\fP\fIchar\fP
sequences, if supported by the
.BR getty -type
program employed on the system.
.nf
.ft CW
-.RB "$" " (cat /proc/1/environ; echo) | tr \(aq\\000\(aq \(aq\\n\(aq"
+.RB "$" " (cat /proc/1/environ; echo) | tr \(aq\e000\(aq \(aq\en\(aq"
.fi
.ft P
.in
.nf
Example for:
.sp
-Head line: vt|vt101|DEC VT 101 terminal in 80 character mode:\\
-Head line: Vt|vt101-w|DEC VT 101 terminal in (wide) 132 character mode:\\
-Boolean: :bs:\\
-Numeric: :co#80:\\
-String: :sr=\\E[H:\\
+Head line: vt|vt101|DEC VT 101 terminal in 80 character mode:\e
+Head line: Vt|vt101-w|DEC VT 101 terminal in (wide) 132 character mode:\e
+Boolean: :bs:\e
+Numeric: :co#80:\e
+String: :sr=\eE[H:\e
.fi
.SS "Boolean Capabilities"
.nf
There are several ways of defining the control codes for string capabilities:
.LP
Every normal character represents itself,
-except \(aq^\(aq, \(aq\\\(aq, and \(aq%\(aq.
+except \(aq^\(aq, \(aq\e\(aq, and \(aq%\(aq.
.LP
A \fB^x\fP means Control-x.
Control-A equals 1 decimal.
.LP
-\\x means a special code.
+\ex means a special code.
x can be one of the following characters:
.RS
E Escape (27)
f Form feed (12)
.br
0 Null character.
-A \\xxx specifies the octal character xxx.
+A \exxx specifies the octal character xxx.
.RE
.IP i
Increments parameters by one.
user's terminal, the user's login name, and the time of login in the form
of
.BR time (2).
-String fields are terminated by a null byte (\(aq\\0\(aq)
+String fields are terminated by a null byte (\(aq\e0\(aq)
if they are shorter than the size
of the field.
.PP
.LP
The following table contains the 128 ASCII characters.
.LP
-C program \f(CW\(aq\\X\(aq\fP escapes are noted.
+C program \f(CW\(aq\eX\(aq\fP escapes are noted.
.if t \{\
.ft CW
\}
l l l l l l l l.
Oct Dec Hex Char Oct Dec Hex Char
_
-000 0 00 NUL \(aq\\0\(aq 100 64 40 @
+000 0 00 NUL \(aq\e0\(aq 100 64 40 @
001 1 01 SOH (start of heading) 101 65 41 A
002 2 02 STX (start of text) 102 66 42 B
003 3 03 ETX (end of text) 103 67 43 C
004 4 04 EOT (end of transmission) 104 68 44 D
005 5 05 ENQ (enquiry) 105 69 45 E
006 6 06 ACK (acknowledge) 106 70 46 F
-007 7 07 BEL \(aq\\a\(aq (bell) 107 71 47 G
-010 8 08 BS \(aq\\b\(aq (backspace) 110 72 48 H
-011 9 09 HT \(aq\\t\(aq (horizontal tab) 111 73 49 I
-012 10 0A LF \(aq\\n\(aq (new line) 112 74 4A J
-013 11 0B VT \(aq\\v\(aq (vertical tab) 113 75 4B K
-014 12 0C FF \(aq\\f\(aq (form feed) 114 76 4C L
-015 13 0D CR \(aq\\r\(aq (carriage ret) 115 77 4D M
+007 7 07 BEL \(aq\ea\(aq (bell) 107 71 47 G
+010 8 08 BS \(aq\eb\(aq (backspace) 110 72 48 H
+011 9 09 HT \(aq\et\(aq (horizontal tab) 111 73 49 I
+012 10 0A LF \(aq\en\(aq (new line) 112 74 4A J
+013 11 0B VT \(aq\ev\(aq (vertical tab) 113 75 4B K
+014 12 0C FF \(aq\ef\(aq (form feed) 114 76 4C L
+015 13 0D CR \(aq\er\(aq (carriage ret) 115 77 4D M
016 14 0E SO (shift out) 116 78 4E N
017 15 0F SI (shift in) 117 79 4F O
020 16 10 DLE (data link escape) 120 80 50 P
031 25 19 EM (end of medium) 131 89 59 Y
032 26 1A SUB (substitute) 132 90 5A Z
033 27 1B ESC (escape) 133 91 5B [
-034 28 1C FS (file separator) 134 92 5C \\ \(aq\\\\\(aq
+034 28 1C FS (file separator) 134 92 5C \e \(aq\e\e\(aq
035 29 1D GS (group separator) 135 93 5D ]
036 30 1E RS (record separator) 136 94 5E ^
037 31 1F US (unit separator) 137 95 5F \&_
------------- ---------------------------------
0: 0 @ P \` p 0: ( 2 < F P Z d n x
1: ! 1 A Q a q 1: ) 3 = G Q [ e o y
-2: " 2 B R b r 2: * 4 > H R \\ f p z
+2: " 2 B R b r 2: * 4 > H R \e f p z
3: # 3 C S c s 3: ! + 5 ? I S ] g q {
4: $ 4 D T d t 4: " , 6 @ J T ^ h r |
5: % 5 E U e u 5: # \- 7 A K U _ i s }
9: ) 9 I Y i y 9: \' 1 ; E O Y c m w
A: * : J Z j z
B: + ; K [ k {
-C: , < L \\ l |
+C: , < L \e l |
D: \- = M ] m }
E: . > N ^ n ~
F: / ? O _ o DEL
.IR /dev/cpuset/memory_pressure_enabled ,
it is not computed for any cpuset, and reads from any
.I memory_pressure
-always return zero, as represented by the ASCII string "0\\n".
+always return zero, as represented by the ASCII string "0\en".
See the \fBWARNINGS\fR section, below.
.PP
A per-cpuset, running average is employed for the following reasons:
preceding them by a backslash, or, in case this is part of
a shell command line, enclosing them in quotes.
Between brackets these characters stand for themselves.
-Thus, "\fI[[?*\\]\fP" matches the
-four characters \(aq[\(aq, \(aq?\(aq, \(aq*\(aq and \(aq\\\(aq.
+Thus, "\fI[[?*\e]\fP" matches the
+four characters \(aq[\(aq, \(aq?\(aq, \(aq*\(aq and \(aq\e\(aq.
.SS Pathnames
Globbing is applied on each of the components of a pathname
separately.
in italic format, for example,
.IR "man 7 man-pages" .
In this case, it may be worth using nonbreaking spaces
-("\\\ ") at suitable places in the command.
+("\e\ ") at suitable places in the command.
Command options should be written in italics, e.g.,
.IR \-l .
.PP
following line).
If the tag is too long, the text after the tag will be moved down to the
next line (text will not be lost or garbled).
-For bulleted lists, use this macro with \\(bu (bullet) or \\(em (em dash)
+For bulleted lists, use this macro with \e(bu (bullet) or \e(em (em dash)
as the tag, and for numbered lists, use the number or letter followed by
a period as the tag;
this simplifies translation to other formats.
The
.B man
package has the following predefined strings:
-.IP \\*R
+.IP \e*R
Registration Symbol: \*R
-.IP \\*S
+.IP \e*S
Change to default font size
-.IP \\*(Tm
+.IP \e*(Tm
Trademark Symbol: \*(Tm
-.IP \\*(lq
+.IP \e*(lq
Left angled double quote: \*(lq
-.IP \\*(rq
+.IP \e*(rq
Right angled double quote: \*(rq
.SS "Safe Subset"
Although technically
Use simple commands that are easy to translate to other formats.
The following troff macros are believed to be safe (though in many cases
they will be ignored by translators):
-.BR \\" ,
+.BR \e" ,
.BR . ,
.BR ad ,
.BR bp ,
.BR tr .
.PP
You may also use many troff escape sequences (those sequences beginning
-with \\).
+with \e).
When you need to include the backslash character as normal text,
-use \\\\.
+use \ee.
Other sequences you may use, where x or xx are any characters and N
is any digit, include:
-.BR \\' ,
-.BR \\` ,
-.BR \\- ,
-.BR \\. ,
-.BR \\" ,
-.BR \\% ,
-.BR \\*x ,
-.BR \\*(xx ,
-.BR \\(xx ,
-.BR \\$N ,
-.BR \\nx ,
-.BR \\n(xx ,
-.BR \\fx ,
+.BR \e' ,
+.BR \e` ,
+.BR \e- ,
+.BR \e. ,
+.BR \e" ,
+.BR \e% ,
+.BR \e*x ,
+.BR \e*(xx ,
+.BR \e(xx ,
+.BR \e$N ,
+.BR \enx ,
+.BR \en(xx ,
+.BR \efx ,
and
-.BR \\f(xx .
+.BR \ef(xx .
Avoid using the escape sequences for drawing graphics.
.PP
Do not use the optional parameter for
that can be ignored should be used.
Font changes
.RB ( ft
-and the \fB\\f\fP escape sequence)
+and the \fB\ef\fP escape sequence)
should only have the values 1, 2, 3, 4, R, I, B, P, or CW
(the ft command may also have no parameters).
.PP
Anything else suggests simple ASCII
text (e.g., a "catman" result).
.PP
-Many man pages begin with \fB\'\\"\fP followed by a
+Many man pages begin with \fB\'\e"\fP followed by a
space and a list of characters,
indicating how the page is to be preprocessed.
For portability's sake to non-troff translators we recommend
and the previous argument (if any).
The special meaning of a punctuation character may be escaped
with the string
-.Ql \\& .
+.Ql \e& .
For example the following string,
.Bl -tag -width "&.Ar file1\ , file2\ , file3\ )\ ." -offset indent
.It Li "\&.Ar file1\ , file2\ , file3\ )\ ."
a macro invocation, precede the
.Ql \&\.
(dot) with the
-.Ql \\&
+.Ql \e&
escape sequence.
The
-.Ql \\&
+.Ql \e&
translates literally to a zero width space, and is never displayed in the
output.
.Pp
string from being interpreted as a macro name, precede
the string with the
escape sequence
-.Ql \\& :
+.Ql \e& :
.Bl -tag -width "\&.Op \&Fl s \&Ar bytes" -offset indent
.It Op \&Fl s \&Ar bytes
is produced by
-.Li \&.Op \\&Fl s \\&Ar bytes
+.Li \&.Op \e&Fl s \e&Ar bytes
.El
.Pp
Here the strings
.Pp
One way of passing a string
containing blank spaces is to use the hard or unpaddable space character
-.Ql \\\ ,
+.Ql \e\ ,
that is, a blank space preceded by the escape character
-.Ql \\ .
+.Ql \e .
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.
.Bl -tag -width "fetch(char *str)" -offset indent
.It Fn fetch char\ *str
is created by
-.Ql \&.Fn fetch char\\ *str
+.Ql \&.Fn fetch char\e *str
.It Fn fetch "char *str"
can also be created by
.Ql \&.Fn fetch "\\*qchar *str\\*q"
.El
.Pp
If the
-.Ql \\
+.Ql \e
or quotes
were omitted,
.Ql \&.Fn
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 \\&
+.Ql \e&
escape character.
For example,
-.Ql string\\\ \\& .
+.Ql string\e\ \e& .
.Ss Escaping Special Characters
Special characters
like the newline character
-.Ql \\n ,
+.Ql \en ,
are handled by replacing the
-.Ql \\
+.Ql \e
with
-.Ql \\e
+.Ql \ee
(e.g.,
-.Ql \\en )
+.Ql \een )
to preserve
the backslash.
.Sh THE ANATOMY OF A MAN PAGE
.Pp
.Ss A manual page template
.Bd -literal -offset indent
-\&.\\" The following requests are required for all man pages.
+\&.\e" The following requests are required for all man pages.
\&.Dd Month day, year
\&.Os OPERATING_SYSTEM [version/release]
\&.Dt DOCUMENT_TITLE [section number] [volume]
\&.Nd one line description of name
\&.Sh SYNOPSIS
\&.Sh DESCRIPTION
-\&.\\" 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
+\&.\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
.Ed
.Pp
The first items in the template are the macros
.Pp
To remove the special meaning from a punctuation character
escape it with
-.Ql \\& .
+.Ql \e& .
.Xr Troff
is limited as a macro language, and has difficulty
when presented with a string containing
or evaluation suggested by the characters. To prevent
the accidental evaluation of these characters,
escape them with
-.Ql \\& .
+.Ql \e& .
Typical syntax is shown in the first content macro displayed
below,
.Ql \&.Ad .
.Bl -tag -width "\&.Nm mdoc.sample" -compact -offset 14n
.It Li \&.Nm mdoc.sample
.Nm mdoc.sample
-.It Li \&.Nm \\-mdoc
+.It Li \&.Nm \e-mdoc
.Nm \-mdoc .
.It Li \&.Nm foo\ )\ )\ ,
.Nm foo ) ) ,
.Bd -literal -offset indent
\&.Sm off
\&.It Xo Sy I Ar operation
-\&.No \\en Ar count No \\en
+\&.No \een Ar count No \een
\&.Xc
\&.Sm on
.Ed
.Bl -tag -width flag -compact
.Sm off
.It Xo Sy I Ar operation
-.No \\n Ar count No \\n
+.No \en Ar count No \en
.Xc
.Sm on
.El
.Bd -literal -offset indent
\&.It Xo
\&.Ic .ifndef
-\&.Oo \\&! Oc Ns Ar variable
+\&.Oo \e&! Oc Ns Ar variable
\&.Op Ar operator variable ...
\&.Xc
.Ed
.\" around the
.\" .Li \&+
.\" signs were forced with
-.\" .Li \\ :
+.\" .Li \e :
.\" .Pp
.\" .Ds I
.\" .Cw (ax\ +\ bx\ +\ c) \ is\ produced\ by\ \&
.\" .Li \&.Sy x
.\" .Cx
.\" .Cl Cx \t\t
-.\" .Li \&.Cx \\\ +\\\ \\&
+.\" .Li \&.Cx \e\ +\e\ \e&
.\" .Cx
.\" .Cl Cx \&(\&
.\" .Va a
.\" .Li \&.Sy y
.\" .Cx
.\" .Cl Cx \t\t
-.\" .Li \&.Cx \\\ +\\\ \\&
+.\" .Li \&.Cx \e\ +\e\ \e&
.\" .Cx
.\" .Cl Cx \t\t
.\" .Li \&.Va c )
.\" .Cx \t
.\" .Em is produced by
.\" .Cx \t
-.\" .Li \&.Ar \\\ b1 e1 f1
+.\" .Li \&.Ar \e\ b1 e1 f1
.\" .Cx
.\" .Cl Cx \t\t
.\" .Li \&.Op Sy ?/
.Pp
.Dl Usage: .Li argument ... \*(Pu
.Bl -tag -width "\&.Li cntrl-D ) ," -compact -offset 14n
-.It Li \&.Li \\en
-.Li \\n
+.It Li \&.Li \een
+.Li \en
.It Li \&.Li M1 M2 M3\ ;
.Li M1 M2 M3 ;
.It Li \&.Li cntrl-D\ )\ ,
.Sh PREDEFINED STRINGS
The following strings are predefined as may be used by
preceding with the troff string interpreting sequence
-.Ql \&\\*(xx
+.Ql \&\e*(xx
where
.Em xx
is the name of the defined string or as
-.Ql \&\\*x
+.Ql \&\e*x
where
.Em x
is the name of the string.
The string named
.Ql q
should be written as
-.Ql \\*q
+.Ql \e*q
since it is only one char.
.Sh DIAGNOSTICS
The debugging facilities for
character.
In one of the introduction examples, it was shown how to
prevent the interpretation of a macro name with the escape sequence
-.Ql \\& .
+.Ql \e& .
This is sufficient for the internal register names also.
.Pp
.\" Every callable macro name has a corresponding register
artificially created problem (a flag argument
.Ql \&aC
which should be
-.Ql \\&aC
+.Ql \e&aC
in order to work):
.Bd -literal -offset indent
\&.Db on
is escaped:
.Bd -literal -offset indent
\&.Db on
-\&.Em An escaped \\&aC
+\&.Em An escaped \e&aC
\&.Db off
.Ed
.Bd -literal -offset indent
.Ed
.Pp
The argument
-.Ql \\&aC
+.Ql \e&aC
shows up with the same length of 2 as the
-.Ql \\&
+.Ql \e&
sequence produces a zero width, but a register
named
-.Ql \\&aC
+.Ql \e&aC
was not found and the type classified as string.
.Pp
Other diagnostics consist of usage statements and are self explanatory.
.\" boundary.
.\" to make sure a line boundary is crossed:
.\" .Bd -literal
-.\" \&.Fn struct\\\ dictionarytable\\\ *dictionarylookup struct\\\ dictionarytable\\\ *tab[]
+.\" \&.Fn struct\e\ dictionarytable\e\ *dictionarylookup struct\e\ dictionarytable\e\ *tab[]
.\" .Ed
.\" .Pp
.\" produces, nudge nudge,
a \fIbracket expression\fR (see below), \(aq.\(aq
(matching any single character), \(aq^\(aq (matching the null string at the
beginning of a line), \(aq$\(aq (matching the null string at the
-end of a line), a \(aq\\\(aq followed by one of the characters
-"\fI^.[$()|*+?{\\\fP"
+end of a line), a \(aq\e\(aq followed by one of the characters
+"\fI^.[$()|*+?{\e\fP"
(matching that character taken as an ordinary character),
-a \(aq\\\(aq followed by any other character\*(dg
+a \(aq\e\(aq followed by any other character\*(dg
(matching that character taken as an ordinary character,
-as if the \(aq\\\(aq had not been present\*(dg),
+as if the \(aq\e\(aq had not been present\*(dg),
or a single character with no other significance (matching that character).
A \(aq{\(aq followed by a character other than a digit is an ordinary
character, not the beginning of a bound\*(dg.
-It is illegal to end an RE with \(aq\\\(aq.
+It is illegal to end an RE with \(aq\e\(aq.
.PP
A \fIbracket expression\fR is a list of characters enclosed in "\fI[]\fP".
It normally matches any single character from the list (but see below).
enclose it in "\fI[.\fP" and "\fI.]\fP"
to make it a collating element (see below).
With the exception of these and some combinations using \(aq[\(aq (see next
-paragraphs), all other special characters, including \(aq\\\(aq, lose their
+paragraphs), all other special characters, including \(aq\e\(aq, lose their
special significance within a bracket expression.
.PP
Within a bracket expression, a collating element (a character,
\(aq|\(aq, \(aq+\(aq, and \(aq?\(aq are
ordinary characters and there is no equivalent
for their functionality.
-The delimiters for bounds are "\fI\\{\fP" and "\fI\\}\fP",
+The delimiters for bounds are "\fI\e{\fP" and "\fI\e}\fP",
with \(aq{\(aq and \(aq}\(aq by themselves ordinary characters.
-The parentheses for nested subexpressions are "\fI\\(\fP" and "\fI\\)\fP",
+The parentheses for nested subexpressions are "\fI\e(\fP" and "\fI\e)\fP",
with \(aq(\(aq and \(aq)\(aq by themselves ordinary characters.
\(aq^\(aq is an ordinary character except at the beginning of the
RE or\*(dg the beginning of a parenthesized subexpression,
(after a possible leading \(aq^\(aq).
.PP
Finally, there is one new type of atom, a \fIback reference\fR:
-\(aq\\\(aq followed by a nonzero decimal digit \fId\fR
+\(aq\e\(aq followed by a nonzero decimal digit \fId\fR
matches the same sequence of characters
matched by the \fId\fRth parenthesized subexpression
(numbering subexpressions by the positions of their opening parentheses,
left to right),
-so that, for example, "\fI\\([bc]\\)\\1\fP" matches "bb" or "cc" but not "bc".
+so that, for example, "\fI\e([bc]\e)\e1\fP" matches "bb" or "cc" but not "bc".
.SH BUGS
Having two kinds of REs is a botch.
.PP
posing major problems for efficient implementations.
They are also somewhat vaguely defined
(does
-"\fIa\\(\\(b\\)*\\2\\)*d\fP" match "abbbd"?).
+"\fIa\e(\e(b\e)*\e2\e)*d\fP" match "abbbd"?).
Avoid using them.
.PP
POSIX.2's specification of case-independent matching is vague.
projects / thirdparty / man-pages.git / commitdiff
