mirror of
https://git.FreeBSD.org/src.git
synced 2024-12-14 10:09:48 +00:00
645 lines
17 KiB
Groff
645 lines
17 KiB
Groff
.\" $FreeBSD$
|
|
.Dd September 10, 2012
|
|
.Dt CHAT 8
|
|
.Os
|
|
.Sh NAME
|
|
.Nm chat
|
|
.Nd Automated conversational script with a modem
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Op Fl eSsVv
|
|
.Op Fl f Ar chat-file
|
|
.Op Fl r Ar report-file
|
|
.Op Fl T Ar phone-number
|
|
.Op Fl t Ar timeout
|
|
.Op Fl U Ar phone-number2
|
|
.Op Ar script
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm
|
|
program defines a conversational exchange between the
|
|
computer and the modem.
|
|
Its primary purpose is to establish the
|
|
connection between the Point-to-Point Protocol Daemon
|
|
.Pq pppd
|
|
and the remote's pppd process.
|
|
.Sh OPTIONS
|
|
.Bl -tag -width indent
|
|
.It Fl e
|
|
Start with the echo option turned on.
|
|
Echoing may also be turned on
|
|
or off at specific points in the chat script by using the ECHO
|
|
keyword.
|
|
When echoing is enabled, all output from the modem is echoed
|
|
to
|
|
.Em stderr .
|
|
.It Fl f Ar chat-file
|
|
Read the chat script from the chat file.
|
|
The use of this option
|
|
is mutually exclusive with the chat script parameters.
|
|
The user must
|
|
have read access to the file.
|
|
Multiple lines are permitted in the file.
|
|
Space or horizontal tab characters should be used to separate
|
|
the strings.
|
|
.It Fl r Ar report-file
|
|
Set the file for output of the report strings.
|
|
If you use the keyword
|
|
.Dv REPORT ,
|
|
the resulting strings are written to this file.
|
|
If this
|
|
option is not used and you still use
|
|
.Dv REPORT
|
|
keywords, the
|
|
.Pa stderr
|
|
file is used for the report strings.
|
|
.It Fl S
|
|
Do not use
|
|
.Xr syslog 3 .
|
|
By default, error messages are sent to
|
|
.Xr syslog 3 .
|
|
The use of
|
|
.Fl S
|
|
will prevent both log messages from
|
|
.Fl v
|
|
and error messages from being sent to
|
|
.Xr syslog 3 .
|
|
.It Fl s
|
|
Use
|
|
.Em stderr .
|
|
All log messages from
|
|
.Fl v
|
|
and all error messages will be
|
|
sent to
|
|
.Em stderr .
|
|
.It Fl T Ar phone-number
|
|
Pass in an arbitrary string, usually a phone number, that will be
|
|
substituted for the \\T substitution metacharacter in a send string.
|
|
.It Fl t Ar timeout
|
|
Set the timeout for the expected string to be received.
|
|
If the string
|
|
is not received within the time limit then the reply string is not
|
|
sent.
|
|
An alternate reply may be sent or the script will fail if there
|
|
is no alternate reply string.
|
|
A failed script will cause the
|
|
.Nm
|
|
program to terminate with a non-zero error code.
|
|
.It Fl U Ar phone-number2
|
|
Pass in a second string, usually a phone number, that will be
|
|
substituted for the \\U substitution metacharacter in a send string.
|
|
This is useful when dialing an ISDN terminal adapter that requires two
|
|
numbers.
|
|
.It Fl V
|
|
Request that the
|
|
.Nm
|
|
script be executed in a
|
|
.Em stderr
|
|
verbose mode.
|
|
The
|
|
.Nm
|
|
program will then log all text received from the
|
|
modem and the output strings sent to the modem to the stderr device.
|
|
This
|
|
device is usually the local console at the station running the chat or
|
|
pppd program.
|
|
.It Fl v
|
|
Request that the
|
|
.Nm
|
|
script be executed in a verbose mode.
|
|
The
|
|
.Nm
|
|
program will then log the execution state of the chat
|
|
script as well as all text received from the modem and the output
|
|
strings sent to the modem.
|
|
The default is to log through
|
|
.Xr syslog 3 ;
|
|
the logging method may be altered with the
|
|
.Fl S
|
|
and
|
|
.Fl s
|
|
flags.
|
|
Logging is done to the
|
|
.Em local2
|
|
facility at level
|
|
.Em info
|
|
for verbose tracing and level
|
|
.Em err
|
|
for some errors.
|
|
.El
|
|
.Sh CHAT SCRIPT
|
|
The
|
|
.Nm
|
|
script defines the communications.
|
|
A script consists of one or more "expect-send" pairs of strings,
|
|
separated by spaces, with an optional "subexpect-subsend" string pair,
|
|
separated by a dash as in the following example:
|
|
.Pp
|
|
.D1 ogin:-BREAK-ogin: ppp ssword: hello2u2
|
|
.Pp
|
|
This line indicates that the
|
|
.Nm
|
|
program should expect the string "ogin:".
|
|
If it fails to receive a login prompt within the time interval
|
|
allotted, it is to send a break sequence to the remote and then expect the
|
|
string "ogin:".
|
|
If the first "ogin:" is received then the break sequence is
|
|
not generated.
|
|
.Pp
|
|
Once it received the login prompt the
|
|
.Nm
|
|
program will send the
|
|
string ppp and then expect the prompt "ssword:".
|
|
When it receives the
|
|
prompt for the password, it will send the password hello2u2.
|
|
.Pp
|
|
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.
|
|
.Pp
|
|
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
|
|
variable information.
|
|
It is generally not acceptable to look for time
|
|
strings, network identification strings, or other variable pieces of data as
|
|
an expect string.
|
|
.Pp
|
|
To help correct for characters which may be corrupted during the initial
|
|
sequence, look for the string "ogin:" rather than "login:".
|
|
It is possible
|
|
that the leading "l" character may be received in error and you may never
|
|
find the string even though it was sent by the system.
|
|
For this reason,
|
|
scripts look for "ogin:" rather than "login:" and "ssword:" rather than
|
|
"password:".
|
|
.Pp
|
|
A very simple script might look like this:
|
|
.Pp
|
|
.D1 ogin: ppp ssword: hello2u2
|
|
.Pp
|
|
In other words, expect ....ogin:, send ppp, expect ...ssword:, send hello2u2.
|
|
.Pp
|
|
In actual practice, simple scripts are rare.
|
|
At the vary least, you
|
|
should include sub-expect sequences should the original string not be
|
|
received.
|
|
For example, consider the following script:
|
|
.Pp
|
|
.D1 ogin:--ogin: ppp ssword: hello2u2
|
|
.Pp
|
|
This would be a better script than the simple one used earlier.
|
|
This would look
|
|
for the same login: prompt, however, if one was not received, a single
|
|
return sequence is sent and then it will look for login: again.
|
|
Should line
|
|
noise obscure the first login prompt then sending the empty line will
|
|
usually generate a login prompt again.
|
|
.Sh COMMENTS
|
|
Comments can be embedded in the chat script.
|
|
A comment is a line which
|
|
starts with the # (hash) character in column 1.
|
|
Such comment
|
|
lines are just ignored by the chat program.
|
|
If a '#' character is to
|
|
be expected as the first character of the expect sequence, you should
|
|
quote the expect string.
|
|
If you want to wait for a prompt that starts with a # (hash)
|
|
character, you would have to write something like this:
|
|
.Bd -literal -offset indent
|
|
# Now wait for the prompt and send logout string
|
|
\&'# ' logout
|
|
.Ed
|
|
.Sh ABORT STRINGS
|
|
Many modems will report the status of the call as a string.
|
|
These strings may be
|
|
.Dv CONNECTED
|
|
or
|
|
.Dv NO CARRIER
|
|
or
|
|
.Dv BUSY .
|
|
It is often desirable to terminate the script should the modem fail to
|
|
connect to the remote.
|
|
The difficulty is that a script would not know
|
|
exactly which modem string it may receive.
|
|
On one attempt, it may receive
|
|
.Dv BUSY
|
|
while the next time it may receive
|
|
.Dv NO CARRIER .
|
|
.Pp
|
|
These "abort" strings may be specified in the script using the ABORT
|
|
sequence.
|
|
It is written in the script as in the following example:
|
|
.Pp
|
|
.D1 ABORT BUSY ABORT 'NO CARRIER' '' ATZ OK ATDT5551212 CONNECT
|
|
.Pp
|
|
This sequence will expect nothing; and then send the string ATZ.
|
|
The expected response to this is the string
|
|
.Dv OK .
|
|
When it receives
|
|
.Dv OK ,
|
|
the string ATDT5551212 to dial the telephone.
|
|
The expected string is
|
|
.Dv CONNECT .
|
|
If the string
|
|
.Dv CONNECT
|
|
is received the remainder of the
|
|
script is executed.
|
|
However, should the modem find a busy telephone, it will
|
|
send the string
|
|
.Dv BUSY .
|
|
This will cause the string to match the abort
|
|
character sequence.
|
|
The script will then fail because it found a match to
|
|
the abort string.
|
|
If it received the string
|
|
.Dv NO CARRIER ,
|
|
it will abort
|
|
for the same reason.
|
|
Either string may be received.
|
|
Either string will
|
|
terminate the
|
|
.Nm
|
|
script.
|
|
.Sh CLR_ABORT STRINGS
|
|
This sequence allows for clearing previously set
|
|
.Dv ABORT
|
|
strings.
|
|
.Dv ABORT
|
|
strings are kept in an array of a pre-determined size (at
|
|
compilation time); CLR_ABORT will reclaim the space for cleared
|
|
entries so that new strings can use that space.
|
|
.Sh SAY STRINGS
|
|
The
|
|
.Dv SAY
|
|
directive allows the script to send strings to the user
|
|
at the terminal via standard error.
|
|
If
|
|
.Nm
|
|
is being run by
|
|
pppd, and pppd is running as a daemon (detached from its controlling
|
|
terminal), standard error will normally be redirected to the file
|
|
.Pa /etc/ppp/connect-errors .
|
|
.Pp
|
|
.Dv SAY
|
|
strings must be enclosed in single or double quotes.
|
|
If carriage return and line feed are needed in the string to be output,
|
|
you must explicitly add them to your string.
|
|
.Pp
|
|
The
|
|
.Dv SAY
|
|
strings could be used to give progress messages in sections of
|
|
the script where you want to have 'ECHO OFF' but still let the user
|
|
know what is happening. An example is:
|
|
.Bd -literal -offset indent
|
|
ABORT BUSY
|
|
ECHO OFF
|
|
SAY "Dialling your ISP...\\n"
|
|
\&'' ATDT5551212
|
|
TIMEOUT 120
|
|
SAY "Waiting up to 2 minutes for connection ... "
|
|
CONNECT ''
|
|
SAY "Connected, now logging in ...\\n"
|
|
ogin: account
|
|
ssword: pass
|
|
$ SAY "Logged in OK ...\\n" \fIetc ...\fR
|
|
.Ed
|
|
.Pp
|
|
This sequence will only present the
|
|
.Dv SAY
|
|
strings to the user and all
|
|
the details of the script will remain hidden.
|
|
For example, if the
|
|
above script works, the user will see:
|
|
.Bd -literal -offset indent
|
|
Dialling your ISP...
|
|
Waiting up to 2 minutes for connection ... Connected, now logging in ...
|
|
Logged in OK ...
|
|
.Ed
|
|
.Sh REPORT STRINGS
|
|
A report string is similar to the
|
|
.Dv ABORT
|
|
string.
|
|
The difference
|
|
is that the strings, and all characters to the next control character
|
|
such as a carriage return, are written to the report file.
|
|
.Pp
|
|
The report strings may be used to isolate the transmission rate of the
|
|
modem's connect string and return the value to the chat user.
|
|
The
|
|
analysis of the report string logic occurs in conjunction with the
|
|
other string processing such as looking for the expect string.
|
|
The use
|
|
of the same string for a report and abort sequence is probably not
|
|
very useful, however, it is possible.
|
|
.Pp
|
|
The report strings to no change the completion code of the program.
|
|
.Pp
|
|
These "report" strings may be specified in the script using the
|
|
.Dv REPORT
|
|
sequence.
|
|
It is written in the script as in the following example:
|
|
.Pp
|
|
.D1 REPORT CONNECT ABORT BUSY '' ATDT5551212 CONNECT '' ogin: account
|
|
.Pp
|
|
This sequence will expect nothing; and then send the string
|
|
ATDT5551212 to dial the telephone.
|
|
The expected string is
|
|
.Dv CONNECT .
|
|
If the string
|
|
.Dv CONNECT
|
|
is received the remainder
|
|
of the script is executed.
|
|
In addition the program will write to the
|
|
expect-file the string "CONNECT" plus any characters which follow it
|
|
such as the connection rate.
|
|
.Sh CLR_REPORT STRINGS
|
|
This sequence allows for clearing previously set
|
|
.Dv REPORT
|
|
strings.
|
|
.Dv REPORT
|
|
strings are kept in an array of a pre-determined size (at
|
|
compilation time); CLR_REPORT will reclaim the space for cleared
|
|
entries so that new strings can use that space.
|
|
.Sh ECHO
|
|
The echo options controls whether the output from the modem is echoed
|
|
to
|
|
.Em stderr .
|
|
This option may be set with the
|
|
.Fl e
|
|
option, but
|
|
it can also be controlled by the
|
|
.Dv ECHO
|
|
keyword.
|
|
The "expect-send"
|
|
pair
|
|
.Dv ECHO ON
|
|
enables echoing, and
|
|
.Dv ECHO OFF
|
|
disables it.
|
|
With this keyword you can select which parts of the
|
|
conversation should be visible.
|
|
For instance, with the following
|
|
script:
|
|
.Bd -literal -offset indent
|
|
ABORT 'BUSY'
|
|
ABORT 'NO CARRIER'
|
|
\&'' ATZ
|
|
OK\\r\\n ATD1234567
|
|
\\r\\n \\c
|
|
ECHO ON
|
|
CONNECT \\c
|
|
ogin: account
|
|
.Ed
|
|
.Pp
|
|
all output resulting from modem configuration and dialing is not visible,
|
|
but starting with the
|
|
.Dv CONNECT
|
|
or
|
|
.Dv BUSY
|
|
message, everything
|
|
will be echoed.
|
|
.Sh HANGUP
|
|
The
|
|
.Dv HANGUP
|
|
options control whether a modem hangup should be considered
|
|
as an error or not.
|
|
This option is useful in scripts for dialling
|
|
systems which will hang up and call your system back.
|
|
The
|
|
.Dv HANGUP
|
|
options can be
|
|
.Dv ON
|
|
or
|
|
.Dv OFF .
|
|
.Pp
|
|
When
|
|
.Dv HANGUP
|
|
is set
|
|
.Dv OFF
|
|
and the modem hangs up (e.g., after the first
|
|
stage of logging in to a callback system),
|
|
.Nm
|
|
will continue
|
|
running the script (e.g., waiting for the incoming call and second
|
|
stage login prompt).
|
|
As soon as the incoming call is connected, you
|
|
should use the
|
|
.Dv HANGUP ON
|
|
directive to reinstall normal hang up
|
|
signal behavior.
|
|
Here is a (simple) example script:
|
|
.Bd -literal -offset indent
|
|
ABORT 'BUSY'
|
|
\&'' ATZ
|
|
OK\\r\\n ATD1234567
|
|
\\r\\n \\c
|
|
CONNECT \\c
|
|
\&'Callback login:' call_back_ID
|
|
HANGUP OFF
|
|
ABORT "Bad Login"
|
|
\&'Callback Password:' Call_back_password
|
|
TIMEOUT 120
|
|
CONNECT \\c
|
|
HANGUP ON
|
|
ABORT "NO CARRIER"
|
|
ogin:--BREAK--ogin: real_account
|
|
\fIetc ...\fR
|
|
.Ed
|
|
.Sh TIMEOUT
|
|
The initial timeout value is 45 seconds.
|
|
This may be changed using the
|
|
.Fl t
|
|
parameter.
|
|
.Pp
|
|
To change the timeout value for the next expect string, the following
|
|
example may be used:
|
|
.Bd -literal -offset indent
|
|
ATZ OK ATDT5551212 CONNECT TIMEOUT 10 ogin:--ogin: TIMEOUT 5 assword: hello2u2
|
|
.Ed
|
|
.Pp
|
|
This will change the timeout to 10 seconds when it expects the login:
|
|
prompt.
|
|
The timeout is then changed to 5 seconds when it looks for the
|
|
password prompt.
|
|
.Pp
|
|
The timeout, once changed, remains in effect until it is changed again.
|
|
.Sh SENDING EOT
|
|
The special reply string of
|
|
.Dv EOT
|
|
indicates that the chat program
|
|
should send an
|
|
.Dv EOT
|
|
character to the remote.
|
|
This is normally the
|
|
End-of-file character sequence.
|
|
A return character is not sent
|
|
following the
|
|
.Dv EOT .
|
|
.Pp
|
|
The
|
|
.Dv EOT
|
|
sequence may be embedded into the send string using the
|
|
sequence ^D.
|
|
.Sh GENERATING BREAK
|
|
The special reply string of
|
|
.Dv BREAK
|
|
will cause a break condition
|
|
to be sent.
|
|
The break is a special signal on the transmitter.
|
|
The
|
|
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.
|
|
.Pp
|
|
The break sequence may be embedded into the send string using the
|
|
\fI\\K\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.
|
|
Those which are not valid in the expect sequence are so indicated.
|
|
.Bl -tag -width indent
|
|
.It ''
|
|
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.
|
|
.It \eb
|
|
represents a backspace character.
|
|
.It \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
|
|
.Pq Em not valid in expect .
|
|
.It \ed
|
|
Delay for one second.
|
|
The program uses sleep(1) which will delay to a
|
|
maximum of one second
|
|
.Pq Em not valid in expect .
|
|
.It \eK
|
|
Insert a
|
|
.Dv BREAK
|
|
.Pq Em not valid in expect .
|
|
.It \en
|
|
Send a newline or linefeed character.
|
|
.It \eN
|
|
Send a null character.
|
|
The same sequence may be represented by \\0
|
|
.Pq Em not valid in expect .
|
|
.It \ep
|
|
Pause for a fraction of a second.
|
|
The delay is 1/10th of a second
|
|
.Pq Em not valid in expect .
|
|
.It \eq
|
|
Suppress writing the string to
|
|
.Xr syslogd 8 .
|
|
The string ?????? is
|
|
written to the log in its place
|
|
.Pq Em not valid in expect .
|
|
.It \er
|
|
Send or expect a carriage return.
|
|
.It \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.
|
|
.It \et
|
|
Send or expect a tab character.
|
|
.It \e
|
|
Send or expect a backslash character.
|
|
.It \eddd
|
|
Collapse the octal digits (ddd) into a single ASCII character and send that
|
|
character
|
|
.Pq Em some characters are not valid in expect .
|
|
.It \^^C
|
|
Substitute the sequence with the control character represented by C.
|
|
For example, the character DC1 (17) is shown as \^^Q
|
|
.Pq Em some characters are not valid in expect .
|
|
.El
|
|
.Sh TERMINATION CODES
|
|
The
|
|
.Nm
|
|
program will terminate with the following completion
|
|
codes.
|
|
.Bl -tag -width indent
|
|
.It 0
|
|
The normal termination of the program.
|
|
This indicates that the script
|
|
was executed without error to the normal conclusion.
|
|
.It 1
|
|
One or more of the parameters are invalid or an expect string was too
|
|
large for the internal buffers.
|
|
This indicates that the program as not
|
|
properly executed.
|
|
.It 2
|
|
An error occurred during the execution of the program.
|
|
This may be due
|
|
to a read or write operation failing for some reason or chat receiving
|
|
a signal such as
|
|
.Dv SIGINT .
|
|
.It 3
|
|
A timeout event occurred when there was an
|
|
.Em expect
|
|
string without
|
|
having a "-subsend" string.
|
|
This may mean that you did not program the
|
|
script correctly for the condition or that some unexpected event has
|
|
occurred and the expected string could not be found.
|
|
.It 4
|
|
The first string marked as an
|
|
.Dv ABORT
|
|
condition occurred.
|
|
.It 5
|
|
The second string marked as an
|
|
.Dv ABORT
|
|
condition occurred.
|
|
.It 6
|
|
The third string marked as an
|
|
.Dv ABORT
|
|
condition occurred.
|
|
.It 7
|
|
The fourth string marked as an
|
|
.Dv ABORT
|
|
condition occurred.
|
|
.It ...
|
|
The other termination codes are also strings marked as an
|
|
.Dv ABORT
|
|
condition.
|
|
.El
|
|
.Pp
|
|
Using the termination code, it is possible to determine which event
|
|
terminated the script.
|
|
It is possible to decide if the string "BUSY"
|
|
was received from the modem as opposed to "NO DIAL TONE".
|
|
While the
|
|
first event may be retried, the second will probably have little
|
|
chance of succeeding during a retry.
|
|
.Sh SEE ALSO
|
|
Additional information about
|
|
.Nm
|
|
scripts may be found with UUCP
|
|
documentation.
|
|
The
|
|
.Nm
|
|
script was taken from the ideas proposed
|
|
by the scripts used by the uucico program.
|
|
.Pp
|
|
.Xr syslog 3 ,
|
|
.Xr syslogd 8
|
|
.Sh COPYRIGHT
|
|
The
|
|
.Nm
|
|
program is in public domain.
|
|
This is not the GNU public
|
|
license.
|
|
If it breaks then you get to keep both pieces.
|