From 8d6942415d22f6ca4377340ca26e345c3f5fa5db Mon Sep 17 00:00:00 2001 From: Paul Mackerras Date: Mon, 10 Jun 2013 12:59:34 +1000 Subject: [PATCH] chat, pppd: Use \e instead of \\ in man pages This avoids the need to double up the backslashes in some places, and eliminates some errors reported by doclifter. Reported-by: Eric S. Raymond Signed-off-by: Paul Mackerras --- chat/chat.8 | 66 ++++++++++++++++++++++++++--------------------------- pppd/pppd.8 | 6 ++--- 2 files changed, 36 insertions(+), 36 deletions(-) diff --git a/chat/chat.8 b/chat/chat.8 index ddfe6b6..6d10836 100644 --- a/chat/chat.8 +++ b/chat/chat.8 @@ -78,11 +78,11 @@ error messages from being sent to the SYSLOG. .TP .B \-T \fI Pass in an arbitrary string, usually a phone number, that will be -substituted for the \\T substitution metacharacter in a send string. +substituted for the \eT substitution metacharacter in a send string. .TP .B \-U \fI Pass in a second string, usually a phone number, that will be -substituted for the \\U substitution metacharacter in a send string. +substituted for the \eU substitution metacharacter in a send string. This is useful when dialing an ISDN terminal adapter that requires two numbers. .TP @@ -111,7 +111,7 @@ prompt for the password, it will send the password hello2u2. .LP A carriage return is normally sent following the reply string. It is not expected in the "expect" string unless it is specifically requested by using -the \\r character sequence. +the \er character sequence. .LP The expect sequence should contain only what is needed to identify the string. Since it is normally stored on a disk file, it should not contain @@ -214,7 +214,7 @@ ABORT BUSY .br ECHO OFF .br -SAY "Dialling your ISP...\\n" +SAY "Dialling your ISP...\en" .br \&'' ATDT5551212 .br @@ -224,15 +224,15 @@ SAY "Waiting up to 2 minutes for connection ... " .br CONNECT '' .br -SAY "Connected, now logging in ...\\n" +SAY "Connected, now logging in ...\en" .br ogin: account .br ssword: pass .br -$ \\c +$ \ec .br -SAY "Logged in OK ...\\n" +SAY "Logged in OK ...\en" \fIetc ...\fR .LP This sequence will only present the SAY strings to the user and all @@ -291,13 +291,13 @@ ABORT 'NO CARRIER' .br \&'' ATZ .br -OK\\r\\n ATD1234567 +OK\er\en ATD1234567 .br -\\r\\n \\c +\er\en \ec .br ECHO ON .br -CONNECT \\c +CONNECT \ec .br ogin: account .LP @@ -321,11 +321,11 @@ ABORT 'BUSY' .br \&'' ATZ .br -OK\\r\\n ATD1234567 +OK\er\en ATD1234567 .br -\\r\\n \\c +\er\en \ec .br -CONNECT \\c +CONNECT \ec .br \&'Callback login:' call_back_ID .br @@ -337,7 +337,7 @@ ABORT "Bad Login" .br TIMEOUT 120 .br -CONNECT \\c +CONNECT \ec .br HANGUP ON .br @@ -375,7 +375,7 @@ normal processing on the receiver is to change the transmission rate. It may be used to cycle through the available transmission rates on the remote until you are able to receive a valid login prompt. The break sequence may be embedded into the send string using the -\fI\\K\fR sequence. +\fI\eK\fR sequence. .SH ESCAPE SEQUENCES The expect and reply strings may contain escape sequences. All of the sequences are legal in the reply string. Many are legal in the expect. @@ -386,64 +386,64 @@ Expects or sends a null string. If you send a null string then it will still send the return character. This sequence may either be a pair of apostrophe or quote characters. .TP -.B \\\\b +.B \eb represents a backspace character. .TP -.B \\\\c +.B \ec Suppresses the newline at the end of the reply string. This is the only method to send a string without a trailing return character. It must be at the end of the send string. For example, -the sequence hello\\c will simply send the characters h, e, l, l, o. +the sequence hello\ec will simply send the characters h, e, l, l, o. .I (not valid in expect.) .TP -.B \\\\d +.B \ed Delay for one second. The program uses sleep(1) which will delay to a maximum of one second. .I (not valid in expect.) .TP -.B \\\\K +.B \eK Insert a BREAK .I (not valid in expect.) .TP -.B \\\\n +.B \en Send a newline or linefeed character. .TP -.B \\\\N -Send a null character. The same sequence may be represented by \\0. +.B \eN +Send a null character. The same sequence may be represented by \e0. .I (not valid in expect.) .TP -.B \\\\p +.B \ep Pause for a fraction of a second. The delay is 1/10th of a second. .I (not valid in expect.) .TP -.B \\\\q +.B \eq Suppress writing the string to the SYSLOG file. The string ?????? is written to the log in its place. .I (not valid in expect.) .TP -.B \\\\r +.B \er Send or expect a carriage return. .TP -.B \\\\s +.B \es Represents a space character in the string. This may be used when it is not desirable to quote the strings which contains spaces. The -sequence 'HI TIM' and HI\\sTIM are the same. +sequence 'HI TIM' and HI\esTIM are the same. .TP -.B \\\\t +.B \et Send or expect a tab character. .TP -.B \\\\T +.B \eT Send the phone number string as specified with the \fI\-T\fR option .I (not valid in expect.) .TP -.B \\\\U +.B \eU Send the phone number 2 string as specified with the \fI\-U\fR option .I (not valid in expect.) .TP -.B \\\\\\\\ +.B \e\e Send or expect a backslash character. .TP -.B \\\\ddd +.B \eddd Collapse the octal digits (ddd) into a single ASCII character and send that character. .I (some characters are not valid in expect.) diff --git a/pppd/pppd.8 b/pppd/pppd.8 index f7954fa..e2768b1 100644 --- a/pppd/pppd.8 +++ b/pppd/pppd.8 @@ -1132,7 +1132,7 @@ the initial /dev/ is removed from the terminal name, and any remaining .PP An options file is parsed into a series of words, delimited by whitespace. Whitespace can be included in a word by enclosing the -word in double-quotes ("). A backslash (\\) quotes the following character. +word in double-quotes ("). A backslash (\e) quotes the following character. A hash (#) starts a comment, which continues until the end of the line. There is no restriction on using the \fIfile\fR or \fIcall\fR options within an options file. @@ -1444,9 +1444,9 @@ OK "atdt2468135" .br "name:" "^Umyuserid" .br -"word:" "\\qmypassword" +"word:" "\eqmypassword" .br -"ispts" "\\q^Uppp" +"ispts" "\eq^Uppp" .br "~\-^Uppp\-~" .LP -- 2.39.2