$Header$ -> $Id$

Manpage formatting/grammatical fixes.
Check return value of malloc()
Add sccsid[], other minor source code cleanups

Submitted by:	Philippe Charnier

1 files changed, 45 insertions, 41 deletions

diff --git a/sbin/slattach/slattach.8 b/sbin/slattach/slattach.8
index 9afa051..b0a23c6 100644
--- a/sbin/slattach/slattach.8
+++ b/sbin/slattach/slattach.8
@@ -31,7 +31,7 @@
 .\"
 .\"     @(#)slattach.8	6.4 (Berkeley) 3/16/91
 .\"
-.\"	$Header: /home/ncvs/src/sbin/slattach/slattach.8,v 1.12 1997/01/13 00:25:46 wosch Exp $
+.\"	$Id$
 .\"
 .Dd April 4, 1993
 .Dt SLATTACH 8
@@ -61,35 +61,35 @@
 .Nm Slattach
 is used to assign a tty line to a network interface,
 and to define the network source and destination addresses.
-The following operands are supported by
-.Nm slattach :
-.Bl -tag -width Ar
+.Pp
+The following options are available:
+.Bl -tag -width indent
 .It Fl a
 Autoenable the VJ header compression option, if the other end of the link
 is capable of VJ header compression then it will be used otherwise normal
 headers will be used.
 .It Fl c
-Enables the VJ header compression option.  Note that both ends of the link
+Enable the VJ header compression option.  Note that both ends of the link
 must be able to use VJ header compression for this to work.
 .It Fl e Ar exit-command
-Specifies a command to be invoked within a shell
+Specify a command to be invoked within a shell
 .Ql sh \-c Ar exit-command
 before
-.Nm slattach
+.Nm
 exits.
 .It Fl f
-Disables the invocation of daemon() to run
-.Nm slattach
+Disable the invocation of daemon() to run
+.Nm
 in the background.
 .It Fl h
 Turn on cts/rts style flow control on the slip port, by default no flow
 control is done.
 .It Fl l
-disable modem control (CLOCAL) and ignore carrier detect on the slip
+Disable modem control (CLOCAL) and ignore carrier detect on the slip
 port.  By default the
 .Ar redial-command
 is invoked upon carrier drop and
-.Nm slattach
+.Nm
 aborts if no
 .Ar redial-command
 is specified.
@@ -97,49 +97,51 @@ is specified.
 Throw away ICMP packets.  The slip interface will ignore ICMP packets
 to prevent slow lines being saturated by ICMP responses.
 .It Fl r Ar redial-command
-Specifies a command to be invoked within a shell
+Specify a command to be invoked within a shell
 .Ql sh \-c Ar redial-command
 whenever carrier is lost on the modem line.
 Empty
 .Ar redial-command
-i.e.
-.Fl r Qq ""
+(i.e.
+.Fl r Qq "" )
 cause connection reestablishing on leased line
 without any external command invoked.
 .It Fl s Ar baudrate
-Specifies the speed of the connection. If not specified, the
+Specify the speed of the connection. If not specified, the
 default of 9600 is used.
 .It Fl u Ar unit-command
 When the line is switched to slip discipline, run
-.Ql Nm "sh -c" Ar unit-command <old> <new>
+.Ql Nm "sh -c" Ar unit-command old new
 where
-.Ar <old>
+.Ar old
 and
-.Ar <new>
+.Ar new
 are the slip unit numbers when the line was
 last opened and the unit number of the current slip connection
 respectively.  The unit number can change after redialing if you are
 using more than one slip line.
 When
-.Nm slattach
-connected first time, it run
-.Ql Nm "sh -c" Ar unit-command Nm \-1 Ar <new> .
+.Nm
+is connected for the first time,
+.Ql Nm "sh -c" Ar unit-command Nm \-1 Ar new
+is run.
 When
-.Nm slattach
-disconnected, it run
-.Ql Nm "sh -c" Ar unit-command <old> Nm \-1 .
+.Nm
+is disconnected,
+.Ql Nm "sh -c" Ar unit-command old Nm \-1
+is run.
 .Nm Slattach
 will abort if the unit number
 changes and
 .Ql Fl u Ar \%unit-command
 was not specified.
 .It Fl z
-forces redial
+Force redial
 .Ar redial-command
 upon startup irrespective of carrier.
 .It Fl L
 Use uucp-style device locking. You need it unless you start
-.Nm slattach
+.Nm
 from external program which already does uucp locking.
 Default case is no uucp locking to satisfy such programs.
 .It Fl K Ar keepalive
@@ -156,7 +158,7 @@ Set the SLIP unit number directly. Use with caution, because no check is made
 for two interfaces with same number.
 By default sliplogin dynamically assigns the unit number.
 .It Ar ttyname
-Specifies the name of the tty device.
+Specify the name of the tty device.
 .Ar Ttyname
 should be a string of the form 
 .Ql ttyXX
@@ -169,15 +171,15 @@ Only the super-user may attach a network interface.
 To detach the interface, use
 .Dq Li ifconfig interface-name down
 after killing off the
-.Nm slattach
+.Nm
 process using
 .Ql kill -INT .
 .Ar Interface-name
 is the name that is shown by
-.Xr netstat 1
+.Xr netstat 1 .
 .Pp
 To setup
-.Nm slattach
+.Nm
 to redial the phone when carrier is lost, use the
 .Fl r Ar redial-command
 option to specify a script or executable that will reconnect the
@@ -199,7 +201,7 @@ than one line disconnect at the same time.  The first to succeed in
 reconnecting will get the lowest unit number.
 .Pp
 To kill
-.Nm slattach
+.Nm
 use
 .Ql kill -INT
 (SIGINT) which causes it to close the tty and exit.
@@ -207,13 +209,13 @@ use
 To force a redial, use
 .Ql kill -HUP
 (SIGHUP) which causes
-.Nm slattach
+.Nm
 to think carrier was lost and thus invoke
 .Ql sh \-c Ar redial-command
 to reconnect to the server.
 .Pp
 If you use a hard-wired connection rather than a modem, invoke
-.Nm slattach
+.Nm
 with the
 .Fl l
 option in order to ignore carrier on the slip line.
@@ -225,8 +227,9 @@ slattach \-c \-s 38400 /dev/cuaa1
 slattach \-r 'kermit -y dial.script >kermit.log 2>&1'
 .Ed
 .Sh DIAGNOSTICS
-Look for error messages in /var/log/messages (
-.Nm slattach
+Look for error messages in
+.Pa /var/log/messages
+.Pf ( Nm slattach
 is a daemon).
 Messages indicating the specified interface does not exit, the
 requested address is unknown, the user is not privileged and tried to
@@ -237,16 +240,18 @@ signal handlers.  Upon connection and redial the ttyname and baud rate
 are logged and on shutdown the ttyname is logged.
 .Pp
 .Sh FILES
-.Pa /var/run/slattach.<tty>.pid ,
-.Pp
+.Bl -tag -width /usr/share/examples/slattach/* -compact
+.It Pa /var/run/slattach.<tty>.pid
 with
 .Ar tty
 replaced by the terminal path name component of
 .Ar ttyname .
 This file contains the numerical process ID of the
-.Nm slattach
+.Nm
 process and can be examined by scripts in order to send a signal to
-.Nm slattach .
+.Nm
+.It Pa /usr/share/examples/slattach/*
+.El
 .Sh SEE ALSO
 .Xr netstat 1 ,
 .Xr startslip 1 ,
@@ -254,8 +259,7 @@ process and can be examined by scripts in order to send a signal to
 .Xr netintro 4 ,
 .Xr ifconfig 8 ,
 .Xr rc 8 ,
-.Xr sliplogin 8 ,
-/usr/share/examples/slattach
+.Xr sliplogin 8
 .Sh HISTORY
 The
 .Nm