Mods from Al Longyear and Robert Geer to add REPORT stuff.
[ppp.git] / chat / chat.8
1 .\" -*- nroff -*-
2 .\" manual page [] for chat 1.8
3 .\" $Id: chat.8,v 1.2 1995/06/12 11:24:14 paulus Exp $
4 .\" SH section heading
5 .\" SS subsection heading
6 .\" LP paragraph
7 .\" IP indented paragraph
8 .\" TP hanging label
9 .TH CHAT 8 "5 May 1995" "Chat Version 1.9"
11 chat \- Automated conversational script with a modem
13 .B chat
14 [
15 .I options
16 ]
17 .I script
19 .LP
20 The \fIchat\fR program defines a conversational exchange between the
21 computer and the modem. Its primary purpose is to establish the
22 connection between the Point-to-Point Protocol Daemon (\fIpppd\fR) and
23 the remote's \fIpppd\fR process.
25 .TP
26 .B -f \fI<chat file>
27 Read the chat script from the chat \fIfile\fR. The use of this option
28 is mutually exclusive with the chat script parameters. The user must
29 have read access to the file. Multiple lines are permitted in the
30 file. Space or horizontal tab characters should be used to separate
31 the strings.
32 .TP
33 .B -t \fI<timeout>
34 Set the timeout for the expected string to be received. If the string
35 is not received within the time limit then the reply string is not
36 sent. An alternate reply may be sent or the script will fail if there
37 is no alternate reply string. A failed script will cause the
38 \fIchat\fR program to terminate with a non-zero error code.
39 .TP
40 .B -r \fI<report file>
41 Set the file for output of the report strings. If you use the keyword
42 \fIREPORT\fR, the resulting strings are written to this file. If this
43 option is not used and you still use \fIREPORT\fR keywords, the
44 \fIstderr\fR file is used for the report strings.
45 .TP
46 .B -v
47 Request that the \fIchat\fR script be executed in a verbose mode. The
48 \fIchat\fR program will then log all text received from the modem and
49 the output strings which it sends to the SYSLOG.
50 .TP
51 .B script
52 If the script is not specified in a file with the \fI-f\fR option then
53 the script is included as parameters to the \fIchat\fR program.
55 .LP
56 The \fIchat\fR script defines the communications.
57 .LP
58 A script consists of one or more "expect-send" pairs of strings,
59 separated by spaces, with an optional "subexpect-subsend" string pair,
60 separated by a dash as in the following example:
61 .IP
62 ogin:-BREAK-ogin: ppp ssword: hello2u2
63 .LP
64 This line indicates that the \fIchat\fR program should expect the string
65 "ogin:". If it fails to receive a login prompt within the time interval
66 allotted, it is to send a break sequence to the remote and then expect the
67 string "ogin:". If the first "ogin:" is received then the break sequence is
68 not generated.
69 .LP
70 Once it received the login prompt the \fIchat\fR program will send the
71 string ppp and then expect the prompt "ssword:". When it receives the
72 prompt for the password, it will send the password hello2u2.
73 .LP
74 A carriage return is normally sent following the reply string. It is not
75 expected in the "expect" string unless it is specifically requested by using
76 the \\r character sequence.
77 .LP
78 The expect sequence should contain only what is needed to identify the
79 string. Since it is normally stored on a disk file, it should not contain
80 variable information. It is generally not acceptable to look for time
81 strings, network identification strings, or other variable pieces of data as
82 an expect string.
83 .LP
84 To help correct for characters which may be corrupted during the initial
85 sequence, look for the string "ogin:" rather than "login:". It is possible
86 that the leading "l" character may be received in error and you may never
87 find the string even though it was sent by the system. For this reason,
88 scripts look for "ogin:" rather than "login:" and "ssword:" rather than
89 "password:".
90 .LP
91 A very simple script might look like this:
92 .IP
93 ogin: ppp ssword: hello2u2
94 .LP
95 In other words, expect ....ogin:, send ppp, expect ...ssword:, send hello2u2.
96 .LP
97 In actual practice, simple scripts are rare. At the vary least, you
98 should include sub-expect sequences should the original string not be
99 received. For example, consider the following script:
100 .IP
101 ogin:--ogin: ppp ssowrd: hello2u2
102 .LP
103 This would be a better script than the simple one used earlier. This would look
104 for the same login: prompt, however, if one was not received, a single
105 return sequence is sent and then it will look for login: again. Should line
106 noise obscure the first login prompt then sending the empty line will
107 usually generate a login prompt again.
109 Many modems will report the status of the call as a string. These
110 strings may be \fBCONNECTED\fR or \fBNO CARRIER\fR or \fBBUSY\fR. It
111 is often desirable to terminate the script should the modem fail to
112 connect to the remote. The difficulty is that a script would not know
113 exactly which modem string it may receive. On one attempt, it may
114 receive \fBBUSY\fR while the next time it may receive \fBNO CARRIER\fR.
115 .LP
116 These "abort" strings may be specified in the script using the \fIABORT\fR
117 sequence. It is written in the script as in the following example:
118 .IP
120 .LP
121 This sequence will expect nothing; and then send the string ATZ. The
122 expected response to this is the string \fIOK\fR. When it receives \fIOK\fR,
123 the string ATDT5551212 to dial the telephone. The expected string is
124 \fICONNECT\fR. If the string \fICONNECT\fR is received the remainder of the
125 script is executed. However, should the modem find a busy telephone, it will
126 send the string \fIBUSY\fR. This will cause the string to match the abort
127 character sequence. The script will then fail because it found a match to
128 the abort string. If it received the string \fINO CARRIER\fR, it will abort
129 for the same reason. Either string may be received. Either string will
130 terminate the \fIchat\fR script.
133 A \fBreport\fR string is similar to the ABORT string. The difference
134 is that the strings, and all characters to the next control character
135 such as a carriage return, are written to the report file.
136 .LP
137 The report strings may be used to isolate the transmission rate of the
138 modem's connect string and return the value to the chat user. The
139 analysis of the report string logic occurs in conjunction with the
140 other string processing such as looking for the expect string. The use
141 of the same string for a report and abort sequence is probably not
142 very useful, however, it is possible.
143 .LP
144 The report strings to no change the completion code of the program.
145 .LP
146 These "report" strings may be specified in the script using the \fIREPORT\fR
147 sequence. It is written in the script as in the following example:
148 .IP
149 REPORT CONNECT ABORT BUSY '' ATDT5551212 CONNECT '' ogin: account
150 .LP
151 This sequence will expect nothing; and then send the string
152 ATDT5551212 to dial the telephone. The expected string is
153 \fICONNECT\fR. If the string \fICONNECT\fR is received the remainder
154 of the script is executed. In addition the program will write to the
155 expect-file the string "CONNECT" plus any characters which follow it
156 such as the connection rate.
158 The initial timeout value is 45 seconds. This may be changed using the \fB-t\fR
159 parameter.
160 .LP
161 To change the timeout value for the next expect string, the following
162 example may be used:
163 .IP
164 ATZ OK ATDT5551212 CONNECT TIMEOUT 10 ogin:--ogin: TIMEOUT 5 assowrd: hello2u2
165 .LP
166 This will change the timeout to 10 seconds when it expects the login:
167 prompt. The timeout is then changed to 5 seconds when it looks for the
168 password prompt.
169 .LP
170 The timeout, once changed, remains in effect until it is changed again.
172 The special reply string of \fIEOT\fR indicates that the chat program
173 should send an EOT character to the remote. This is normally the
174 End-of-file character sequence. A return character is not sent
175 following the EOT.
176 .PR
177 The EOT sequence may be embedded into the send string using the
178 sequence \fI^D\fR.
180 The special reply string of \fIBREAK\fR will cause a break condition
181 to be sent. The break is a special signal on the transmitter. The
182 normal processing on the receiver is to change the transmission rate.
183 It may be used to cycle through the available transmission rates on
184 the remote until you are able to receive a valid login prompt.
185 .PR
186 The break sequence may be embedded into the send string using the
187 \fI\\K\fR sequence.
189 The expect and reply strings may contain escape sequences. All of the
190 sequences are legal in the reply string. Many are legal in the expect.
191 Those which are not valid in the expect sequence are so indicated.
192 .TP
193 .B ''
194 Expects or sends a null string. If you send a null string then it will still
195 send the return character. This sequence may either be a pair of apostrophe
196 or quote characters.
197 .TP
198 .B \\\\b
199 represents a backspace character.
200 .TP
201 .B \\\\c
202 Suppresses the newline at the end of the reply string. This is the only
203 method to send a string without a trailing return character. It must
204 be at the end of the send string. For example,
205 the sequence hello\\c will simply send the characters h, e, l, l, o.
206 .I (not valid in expect.)
207 .TP
208 .B \\\\d
209 Delay for one second. The program uses sleep(1) which will delay to a
210 maximum of one second.
211 .I (not valid in expect.)
212 .TP
213 .B \\\\K
214 Insert a BREAK
215 .I (not valid in expect.)
216 .TP
217 .B \\\\n
218 Send a newline or linefeed character.
219 .TP
220 .B \\\\N
221 Send a null character. The same sequence may be represented by \\0.
222 .I (not valid in expect.)
223 .TP
224 .B \\\\p
225 Pause for a fraction of a second. The delay is 1/10th of a second.
226 .I (not valid in expect.)
227 .TP
228 .B \\\\q
229 Suppress writing the string to the SYSLOG file. The string ?????? is
230 written to the log in its place.
231 .I (not valid in expect.)
232 .TP
233 .B \\\\r
234 Send or expect a carriage return.
235 .TP
236 .B \\\\s
237 Represents a space character in the string. This may be used when it
238 is not desirable to quote the strings which contains spaces. The
239 sequence 'HI TIM' and HI\\sTIM are the same.
240 .TP
241 .B \\\\t
242 Send or expect a tab character.
243 .TP
244 .B \\\\\\\\
245 Send or expect a backslash character.
246 .TP
247 .B \\\\ddd
248 Collapse the octal digits (ddd) into a single ASCII character and send that
249 character.
250 .I (some characters are not valid in expect.)
251 .TP
252 .B \^^C
253 Substitute the sequence with the control character represented by C.
254 For example, the character DC1 (17) is shown as \^^Q.
255 .I (some characters are not valid in expect.)
257 The \fIchat\fR program will terminate with the following completion
258 codes.
259 .TP
260 .B 0
261 The normal termination of the program. This indicates that the script
262 was executed without error to the normal conclusion.
263 .TP
264 .B 1
265 One or more of the parameters are invalid or an expect string was too
266 large for the internal buffers. This indicates that the program as not
267 properly executed.
268 .TP
269 .B 2
270 An error occurred during the execution of the program. This may be due
271 to a read or write operation failing for some reason or chat receiving
272 a signal such as SIGINT.
273 .TP
274 .B 3
275 A timeout event occurred when there was an \fIexpect\fR string without
276 having a "-subsend" string. This may mean that you did not program the
277 script correctly for the condition or that some unexpected event has
278 occurred and the expected string could not be found.
279 .TP
280 .B 4
281 The first string marked as an \fIABORT\fR condition occurred.
282 .TP
283 .B 5
284 The second string marked as an \fIABORT\fR condition occurred.
285 .TP
286 .B 6
287 The third string marked as an \fIABORT\fR condition occurred.
288 .TP
289 .B 7
290 The fourth string marked as an \fIABORT\fR condition occurred.
291 .TP
292 .B ...
293 The other termination codes are also strings marked as an \fIABORT\fR
294 condition.
295 .LP
296 Using the termination code, it is possible to determine which event
297 terminated the script. It is possible to decide if the string "BUSY"
298 was received from the modem as opposed to "NO DIAL TONE". While the
299 first event may be retried, the second will probably have little
300 chance of succeeding during a retry.
302 Additional information about \fIchat\fR scripts may be found with UUCP
303 documentation. The \fIchat\fR script was taken from the ideas proposed
304 by the scripts used by the \fIuucico\fR program.
305 .LP
306 uucico(1), uucp(1)
308 The \fIchat\fR program is in public domain. This is not the GNU public
309 license. If it breaks then you get to keep both pieces.