[apple/network_cmds.git] / startslip.tproj / startslip.1

.\" Copyright (c) 1990, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)startslip.1	8.1 (Berkeley) 6/5/93
.\"
.Dd June 5, 1993
.Dt STARTSLIP 1
.Os BSD 4.4
.Sh NAME
.Nm startslip
.Nd dial up and login to a slip server
.Sh SYNOPSIS
.Nm startslip
.Op Fl d
.Op Fl s Ar string
.Op Fl A Ar annexname
.Op Fl F Ar flowcontrol
.Ar device user passwd
.Sh DESCRIPTION
.Nm Startslip
opens the specified
.Ar device .
.Pp
Once carrier is asserted
.Nm startslip
attempts to login as the specified
.Ar user
with the given
.Ar password .
If successful, it puts the device into the slip line discipline.
If carrier drops and a
.Dv SIGHUP
is sent to
.Nm startslip ,
it closes the device and attempts to repeat the dialup and login sequence.
.Pp
Available options:
.Bl -tag -width Ar
.It Fl d
.Nm Startslip
prints out debugging information about what it is trying to do.
.It Fl s Ar string
The optional
.Ar string
is written to
.Ar device .
For a dialup modem,
the string is used to specify a dial sequence.
.It Fl A Ar annexname
.Nm Startslip
assumes it is connecting to a Xylogics Annex box and engages in an
appropriate dialog using the
.Ar user
and
.Ar passwd
arguments.
The
.Ar annexname
argument is a string that is used to match against the Annex prompt
to determine when a connection has been established.
.It Fl F Ar flowcontrol
Determines the type of flow control used on
.Ar device .
Choices for
.Ar flowcontrol
are
``none'' for no flow control (the default),
``hw'' for hardware RTS/CTS flow control and
``sw'' for software XON/XOFF flow control.
.El
.Sh SEE ALSO
.Xr sliplogin 8
.Sh HISTORY
The
.Nm startslip
appeared in
.Bx 4.4 .
Commit	Line	Data
b7080c8e A	1	.\" Copyright (c) 1990, 1991, 1993
	2	.\" The Regents of the University of California. All rights reserved.
	3	.\"
	4	.\" Redistribution and use in source and binary forms, with or without
	5	.\" modification, are permitted provided that the following conditions
	6	.\" are met:
	7	.\" 1. Redistributions of source code must retain the above copyright
	8	.\" notice, this list of conditions and the following disclaimer.
	9	.\" 2. Redistributions in binary form must reproduce the above copyright
	10	.\" notice, this list of conditions and the following disclaimer in the
	11	.\" documentation and/or other materials provided with the distribution.
	12	.\" 3. All advertising materials mentioning features or use of this software
	13	.\" must display the following acknowledgement:
	14	.\" This product includes software developed by the University of
	15	.\" California, Berkeley and its contributors.
	16	.\" 4. Neither the name of the University nor the names of its contributors
	17	.\" may be used to endorse or promote products derived from this software
	18	.\" without specific prior written permission.
	19	.\"
	20	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	21	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	22	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	23	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	24	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	25	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	26	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	27	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	28	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	29	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	30	.\" SUCH DAMAGE.
	31	.\"
	32	.\" @(#)startslip.1 8.1 (Berkeley) 6/5/93
	33	.\"
	34	.Dd June 5, 1993
	35	.Dt STARTSLIP 1
	36	.Os BSD 4.4
	37	.Sh NAME
	38	.Nm startslip
	39	.Nd dial up and login to a slip server
	40	.Sh SYNOPSIS
	41	.Nm startslip
	42	.Op Fl d
	43	.Op Fl s Ar string
	44	.Op Fl A Ar annexname
	45	.Op Fl F Ar flowcontrol
	46	.Ar device user passwd
	47	.Sh DESCRIPTION
	48	.Nm Startslip
	49	opens the specified
	50	.Ar device .
	51	.Pp
	52	Once carrier is asserted
	53	.Nm startslip
	54	attempts to login as the specified
	55	.Ar user
	56	with the given
	57	.Ar password .
	58	If successful, it puts the device into the slip line discipline.
	59	If carrier drops and a
	60	.Dv SIGHUP
	61	is sent to
	62	.Nm startslip ,
	63	it closes the device and attempts to repeat the dialup and login sequence.
	64	.Pp
65	Available options:
66	.Bl -tag -width Ar
67	.It Fl d
68	.Nm Startslip
69	prints out debugging information about what it is trying to do.
70	.It Fl s Ar string
71	The optional
72	.Ar string
73	is written to
74	.Ar device .
75	For a dialup modem,
76	the string is used to specify a dial sequence.
77	.It Fl A Ar annexname
78	.Nm Startslip
79	assumes it is connecting to a Xylogics Annex box and engages in an
80	appropriate dialog using the
81	.Ar user
82	and
83	.Ar passwd
84	arguments.
85	The
86	.Ar annexname
87	argument is a string that is used to match against the Annex prompt
88	to determine when a connection has been established.
89	.It Fl F Ar flowcontrol
90	Determines the type of flow control used on
91	.Ar device .
92	Choices for
93	.Ar flowcontrol
94	are
95	``none'' for no flow control (the default),
96	``hw'' for hardware RTS/CTS flow control and
97	``sw'' for software XON/XOFF flow control.
98	.El
99	.Sh SEE ALSO
100	.Xr sliplogin 8
101	.Sh HISTORY
102	The
103	.Nm startslip
104	appeared in
105	.Bx 4.4 .