Fixup example files, man pages and phones parsing.

Make '/etc/remote' a working example, with some lengthy comments that
might help people trying to use it.

Remove untruths and beef up documentation for tip(1), remote(5) and
phones(5). In particular remove last reference to the 'cu' tip
interface since we use the 'cu' that comes with uucp, improve
documentation on phone numbers and flesh out documentation on
acu/modems supported. Document PHONES and REMOTE environment
variables.

Cleanup parsing of /etc/phones (so our example can be used) and ignore
lines with empty phone numbers instead of aborting the scan of the
file. This makes /etc/phones parsing consistant with ':pn:' capability
parsing. Don't try to dial empty phone numbers in either case.

ok millert@

1 files changed, 171 insertions, 125 deletions

diff --git a/usr.bin/tip/tip.1 b/usr.bin/tip/tip.1
index 91798ca533b..088e3feee5a 100644
--- a/usr.bin/tip/tip.1
+++ b/usr.bin/tip/tip.1
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: tip.1,v 1.13 2001/07/31 09:18:21 hugh Exp $
+.\"	$OpenBSD: tip.1,v 1.14 2001/08/11 00:05:53 krw Exp $
 .\"	$NetBSD: tip.1,v 1.7 1994/12/08 09:31:05 jtc Exp $
 .\"
 .\" Copyright (c) 1980, 1990, 1993
@@ -44,12 +44,8 @@
 .Sh SYNOPSIS
 .Nm tip
 .Op Fl nv
-.Fl Ns Ns Ar speed
-.Ar system\-name
-.Nm tip
-.Op Fl nv
-.Fl Ns Ns Ar speed
-.Ar phone\-number
+.Op Fl Ar speed
+.Op Ar system\-name
 .\" .Nm cu
 .\" .Ar phone\-number
 .\" .Op Fl t
@@ -61,11 +57,10 @@
 .Nm
 .\" and
 .\" .Nm cu
-establishes a full-duplex connection to another machine,
-giving the appearance of being logged in directly on the
-remote CPU.
-It goes without saying that you must have a login
-on the machine (or equivalent) to which you wish to connect.
+establishes a full-duplex connection to another machine, giving the
+appearance of being logged in directly on the remote CPU.
+It goes without saying that you must have a login on the machine (or
+equivalent) to which you wish to connect.
 .\" The preferred interface is
 .\" .Nm tip .
 .\" The
@@ -78,30 +73,57 @@ on the machine (or equivalent) to which you wish to connect.
 .\" .Nm tip .
 .Pp
 The options are as follows:
-.Bl -tag -width Ds
+.Bl -tag -offset indent -width 4n
 .It Fl v
 Set verbose mode.
 .It Fl n
 No escape (disable tilde).
 .El
 .Pp
+If
+.Ar speed
+is specified it will override any baudrate specified in the system
+description being used.
+.Pp
+If neither
+.Ar speed
+nor
+.Ar system-name
+are specified,
+.Ar system-name
+will be set to the value of the
+.Ev HOST
+environment variable.
+.Pp
+If
+.Ar speed
+is specified but
+.Ar system-name
+is not,
+.Ar system-name
+will be set to a value of 'tip' with
+.Ar speed
+appended.
+e.g.
+.Ic tip -1200
+will set
+.Ar system-name
+to 'tip1200'.
+.Pp
 Typed characters are normally transmitted directly to the remote
 machine (which does the echoing as well).
 A tilde
 .Pq Ql ~
-appearing
-as the first character of a line is an escape signal; the following
-are recognized:
-.Bl -tag -width flag
+appearing as the first character of a line is an escape signal; the
+following are recognized:
+.Bl -tag -offset indent -width Fl
 .It Ic \&~^D No or Ic \&~ .
-Drop the connection and exit
-(you may still be logged in on the
-remote machine).
+Drop the connection and exit (you may still be logged in on the remote
+machine).
 .It Ic \&~c Op Ar name
 Change directory to
 .Ar name
-(no argument
-implies change to your home directory).
+(no argument implies change to your home directory).
 .It Ic \&~!
 Escape to a shell (exiting the shell will return you to
 .Nm tip Ns ).
@@ -112,8 +134,8 @@ prompts for the name of a local file to transmit.
 .It Ic \&~<
 Copy file from remote to local.
 .Nm
-prompts first for the name of the file to be sent, then for
-a command to be executed on the remote machine.
+prompts first for the name of the file to be sent, then for a command
+to be executed on the remote machine.
 .It Ic \&~p Ar from Op Ar to
 Send a file to a remote
 .Ux
@@ -143,12 +165,10 @@ Take a file from a remote
 host.
 As in the put command the
 .Dq to
-file
-defaults to the
+file defaults to the
 .Dq from
 file name if it isn't specified.
-The remote host
-executes the command string
+The remote host executes the command string
 .Dq cat 'from';echo ^A
 to send the file to
 .Nm tip .
@@ -169,26 +189,23 @@ system is processed by the shell.
 .It Ic \&~C
 Fork a child process on the local system to perform special protocols
 such as \s-1XMODEM\s+1.
-The child program will be run with the following
-somewhat unusual arrangement of file descriptors:
-.nf
-.in +1i
+The child program will be run with the following somewhat unusual
+arrangement of file descriptors:
+.Bd -literal -offset indent
 0 <-> local tty in
 1 <-> local tty out
 2 <-> local tty out
 3 <-> remote tty in
 4 <-> remote tty out
-.in -1i
-.fi
+.Ed
 .It Ic \&~#
 Send a
 .Dv BREAK
 to the remote system.
-For systems which don't support the
-necessary
+For systems which don't support the necessary
 .Fn ioctl
-call the break is simulated by a sequence of line speed changes
-and DEL characters.
+call the break is simulated by a sequence of line speed changes and
+DEL characters.
 .It Ic \&~s
 Set a variable (see the discussion below).
 .It Ic \&~^Z
@@ -200,8 +217,7 @@ Stop only the
 .Dq local side
 of
 .Nm
-(only available with job control);
-the
+(only available with job control); the
 .Dq remote side
 of
 .Nm tip ,
@@ -210,43 +226,66 @@ the side that displays output from the remote host, is left running.
 Get a summary of the tilde escapes.
 .El
 .Pp
+To find the system description and thus the operating characteristics
+of
+.Ar system-name ,
 .Nm
-uses the file
-.Pa /etc/remote
-to find how to reach a particular
-system and to find out how it should operate while talking
-to the system;
-refer to
+searches for a system description with a name identical to
+.Ar system-name .
+The search order is
+.Bl -enum -offset indent
+.It
+If the environment variable
+.Ev REMOTE
+does not start with a
+.Ql \&/
+it is assumed to be a system description, and is considered first.
+.It
+If the environment variable
+.Ev REMOTE
+begins with a
+.Ql \&/
+it is assumed to be a path to a
 .Xr remote 5
-for a full description.
-Each system has a default baud rate with which to
-establish a connection.
-If this value is not suitable, the baud rate
-to be used may be specified on the command line, e.g.,
+database, and the specified database is searched.
+.It 
+The default
+.Xr remote 5
+database,
+.Pa /etc/remote ,
+is searched.
+.El
+.Pp
+See
+.Xr remote 5
+for full documentation on system descriptions.
+.Pp
+The
+.Ar ba
+capability is used in system descriptions to specify the baud rate
+with which to establish a connection.
+If the value specified is not suitable, the baud rate to be used may
+be given on the command line, e.g.,
 .Ql "tip -300 mds" .
 .Pp
 When
 .Nm
-establishes a connection it sends out a
-connection message to the remote system; the default value, if any,
-is defined in
-.Pa /etc/remote
-(see
-.Xr remote 5 ) .
+establishes a connection it sends out the connection message
+specified in the
+.Ar cm
+capability of the system description being used.
 .Pp
 When
 .Nm
-prompts for an argument (e.g., during setup of
-a file transfer) the line typed may be edited with the standard
-erase and kill characters.
-A null line in response to a prompt,
-or an interrupt, will abort the dialogue and return you to the
-remote machine.
+prompts for an argument (e.g., during setup of a file transfer) the
+line typed may be edited with the standard erase and kill characters.
+A null line in response to a prompt, or an interrupt, will abort the
+dialogue and return you to the remote machine.
 .Pp
 .Nm
-guards against multiple users connecting to a remote system
-by opening modems and terminal lines with exclusive access,
-and by honoring the locking protocol used by
+guards against multiple users connecting to a remote system by opening
+modems and terminal lines with exclusive access, and by honoring the
+locking protocol used by
 .Xr uucico 8 .
 .Pp
 During file transfers
@@ -260,8 +299,8 @@ commands, the
 .Dq eofread
 and
 .Dq eofwrite
-variables are used to recognize end-of-file when reading, and
-specify end-of-file when writing (see below).
+variables are used to recognize end-of-file when reading, and specify
+end-of-file when writing (see below).
 File transfers normally depend on tandem mode for flow control.
 If the remote system does not support tandem mode,
 .Dq echocheck
@@ -272,23 +311,29 @@ transmitted character.
 .Pp
 When
 .Nm
-must dial a phone number to connect to a system it will print
-various messages indicating its actions.
+must dial a phone number to connect to a system it will print various
+messages indicating its actions.
 .Nm
-supports the
-.Tn DEC DN Ns -11
-and
-Racal-Vadic 831 auto-call-units;
-the
-.Tn DEC DF Ns \&02
-and
-.Tn DF Ns \&03 ,
-Ventel 212+, Racal-Vadic 3451, and
-Bizcomp 1031 and 1032 integral call unit/modems.
+supports a variety of auto-call units and modems with the
+.Ar at
+capability in system descriptions.
+.Pp
+Support for Ventel 212+	(ventel), Hayes AT-style (hayes),
+USRobotics Courier (courier), Telebit T3000 (t3000) and
+Racal-Vadic 831 (vadic) units is enabled by default.
+.Pp
+Support for Bizcomp 1031[fw] (biz31[fw]), Bizcomp 1022[fw]
+(biz22[fw]), DEC DF0[23]-AC (df0[23]), DEC DN-11 (dn11) and
+Racal-Vadic 3451 (v3451) units can be added by recompiling
+.Xr tip 1
+with the appropriate defines.
+.Pp
+Note that if support for both the Racal-Vadic 831 and 3451 is enabled
+they are referred to as the v831 and v3451 respectively.
+If only one of the two is supported, it is referred to as vadic.
 .Ss VARIABLES
 .Nm
-maintains a set of variables
-which control its operation.
+maintains a set of variables which control its operation.
 Some of these variables are read-only to normal users (root is allowed
 to change anything of interest).
 Variables may be displayed and set through the
@@ -302,8 +347,8 @@ Supplying
 .Dq all
 as an argument to the set command displays all variables readable by
 the user.
-Alternatively, the user may request display of a particular
-variable by attaching a
+Alternatively, the user may request display of a particular variable
+by attaching a
 .Ql ?
 to the end.
 For example,
@@ -311,17 +356,16 @@ For example,
 displays the current escape character.
 .Pp
 Variables are numeric, string, character, or boolean values.
-Boolean
-variables are set merely by specifying their name; they may be reset
-by prepending a
+Boolean variables are set merely by specifying their name; they may be
+reset by prepending a
 .Ql !
 to the name.
 Other variable types are set by concatenating an
 .Ql =
 and the value.
 The entire assignment must not have any blanks in it.
-A single set command may be used to interrogate
-as well as set a number of variables.
+A single set command may be used to interrogate as well as set a
+number of variables.
 Variables may be initialized at run time by placing set commands
 (without the
 .Ql ~s
@@ -334,20 +378,20 @@ option causes
 .Nm
 to display the sets as they are made.
 Certain common variables have abbreviations.
-The following is a list of common variables,
-their abbreviations, and their default values:
+The following is a list of common variables, their abbreviations, and
+their default values:
 .Bl -tag -width Ar
 .It Ar beautify
-(bool) Discard unprintable characters when a session is being scripted;
-abbreviated
+(bool) Discard unprintable characters when a session is being
+scripted; abbreviated
 .Ar be .
 .It Ar baudrate
 (num) The baud rate at which the connection was established;
 abbreviated
 .Ar ba .
 .It Ar dialtimeout
-(num) When dialing a phone number, the time (in seconds)
-to wait for a connection to be established; abbreviated
+(num) When dialing a phone number, the time (in seconds) to wait for a
+connection to be established; abbreviated
 .Ar dial .
 .It Ar echocheck
 (bool) Synchronize with the remote host during file transfer by
@@ -374,8 +418,8 @@ will recognize escape characters only after an end-of-line.
 default value is
 .Ql ~ .
 .It Ar exceptions
-(str) The set of characters which should not be discarded
-due to the beautification switch; abbreviated
+(str) The set of characters which should not be discarded due to the
+beautification switch; abbreviated
 .Ar ex ;
 default value is
 .Dq \et\en\ef\eb .
@@ -399,8 +443,8 @@ host; abbreviated
 default value is
 .Ql \en .
 This value is used to synchronize during data transfers.
-The count of lines transferred during a file transfer
-command is based on receipt of this character.
+The count of lines transferred during a file transfer command is based
+on receipt of this character.
 .It Ar raise
 (bool) Upper case mapping mode; abbreviated
 .Ar ra ;
@@ -432,15 +476,15 @@ When
 is
 .Li true ,
 .Nm
-will record everything transmitted by the remote machine in
-the script record file specified in
+will record everything transmitted by the remote machine in the script
+record file specified in
 .Ar record .
 If the
 .Ar beautify
 switch is on, only printable
 .Tn ASCII
-characters will be included in
-the script file (those characters between 040 and 0177).
+characters will be included in the script file (those characters
+between 040 and 0177).
 The variable
 .Ar exceptions
 is used to indicate characters which are an exception to the normal
@@ -458,41 +502,43 @@ default is
 .Ar true .
 When verbose mode is enabled,
 .Nm
-prints messages while dialing, shows the current number
-of lines transferred during a file transfer operations,
-and more.
+prints messages while dialing, shows the current number of lines
+transferred during a file transfer operations, and more.
 .El
 .Sh ENVIRONMENT
 .Bl -tag -width Fl
 .It Ev SHELL
-(str) The name of the shell to use for the
+The name of the shell to use for the
 .Ic ~!
 command; default value is
-.Dq /bin/sh ,
-or taken from the environment.
+.Dq /bin/sh .
 .It Ev HOME
-(str) The home directory to use for the
+The home directory to use for the
 .Ic ~c
-command; default value is taken from the environment.
+command.
 .It Ev HOST
-Check for a default host if none specified.
+The default value for
+.Ar system-name
+if none is specified via the command line.
+.It Ev REMOTE
+A system description, or an absolute path to a
+.Xr remote 5
+system description database.
+.It Ev PHONES
+A path to a
+.Xr phones 5
+database.
 .El
-.Pp
-The variables
-.Ev ${REMOTE}
-and
-.Ev ${PHONES}
-are also exported.
 .Sh FILES
-.Bl -tag -width /var/spool/lock/LCK..* -compact
+.Bl -tag -width "/var/spool/lock/LCK..*" -compact
 .It Pa /etc/remote
-global system descriptions
+global
+.Xr remote 5
+database
 .It Pa /etc/phones
-global phone number database
-.It ${REMOTE}
-private system descriptions
-.It ${PHONES}
-private phone numbers
+default
+.Xr phones 5
+file
 .It Pa ~/.tiprc
 initialization file
 .It Pa tip.record