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

.\" Copyright (c) 1983, 1990, 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.
.\"
.\"	@(#)rlogin.1	8.2 (Berkeley) 4/29/95
.\"
.Dd April 29, 1995
.Dt RLOGIN 1
.Os BSD 4.2
.Sh NAME
.Nm rlogin
.Nd remote login
.Sh SYNOPSIS
.Nm rlogin
.Op Fl 8ELd
.Op Fl e Ar char
.Op Fl k Ar realm
.Op Fl l Ar username
.Ar host
.Nm rlogin
.Op Fl 8ELd
.Op Fl e Ar char
.Ar username@host
.Sh DESCRIPTION
.Nm Rlogin
starts a terminal session on a remote host
.Ar host  .
.Pp
.Nm Rlogin
first attempts to use the standard Berkeley
.Pa rhosts
authorization mechanism.
The options are as follows:
.Bl -tag -width flag
.It Fl 8
The
.Fl 8
option allows an eight-bit input data path at all times; otherwise
parity bits are stripped except when the remote side's stop and start
characters are other than
^S/^Q .
.It Fl E
The
.Fl E
option stops any character from being recognized as an escape character.
When used with the
.Fl 8
option, this provides a completely transparent connection.
.It Fl L
The
.Fl L
option allows the rlogin session to be run in ``litout'' (see
.Xr tty 4 )
mode.
.It Fl d
The
.Fl d
option turns on socket debugging (see
.Xr setsockopt 2 )
on the TCP sockets used for communication with the remote host.
.It Fl e
The
.Fl e
option allows user specification of the escape character, which is
``~'' by default.
This specification may be as a literal character, or as an octal
value in the form \ennn.
.El
.Pp
A line of the form ``<escape char>.'' disconnects from the remote host.
Similarly, the line ``<escape char>^Z'' will suspend the
.Nm rlogin
session, and ``<escape char><delayed-suspend char>'' suspends the
send portion of the rlogin, but allows output from the remote system.
By default, the tilde (``~'') character is the escape character, and
normally control-Y (``^Y'') is the delayed-suspend character.
.Pp
All echoing takes place at the remote site, so that (except for delays)
the
.Nm rlogin
is transparent.
Flow control via ^S/^Q and flushing of input and output on interrupts
are handled properly.
.Sh ENVIRONMENT
The following environment variable is utilized by
.Nm rlogin :
.Bl -tag -width TERM
.It Ev TERM
Determines the user's terminal type.
.El
.Sh SEE ALSO
.Xr rsh 1 
.Sh HISTORY
The
.Nm rlogin
command appeared in
.Bx 4.2 .
.Sh BUGS
.Nm Rlogin
will be replaced by
.Xr telnet  1
in the near future.
.Pp
More of the environment should be propagated.
Commit	Line	Data
b7080c8e A	1	.\" Copyright (c) 1983, 1990, 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	.\" @(#)rlogin.1 8.2 (Berkeley) 4/29/95
	33	.\"
	34	.Dd April 29, 1995
	35	.Dt RLOGIN 1
	36	.Os BSD 4.2
	37	.Sh NAME
	38	.Nm rlogin
	39	.Nd remote login
	40	.Sh SYNOPSIS
	41	.Nm rlogin
07f47057	42	.Op Fl 8ELd
b7080c8e A	43	.Op Fl e Ar char
	44	.Op Fl k Ar realm
	45	.Op Fl l Ar username
	46	.Ar host
	47	.Nm rlogin
07f47057	48	.Op Fl 8ELd
b7080c8e	49	.Op Fl e Ar char
b7080c8e A	50	.Ar username@host
	51	.Sh DESCRIPTION
	52	.Nm Rlogin
	53	starts a terminal session on a remote host
	54	.Ar host .
	55	.Pp
	56	.Nm Rlogin
07f47057	57	first attempts to use the standard Berkeley
b7080c8e	58	.Pa rhosts
07f47057	59	authorization mechanism.
b7080c8e A	60	The options are as follows:
	61	.Bl -tag -width flag
	62	.It Fl 8
	63	The
	64	.Fl 8
	65	option allows an eight-bit input data path at all times; otherwise
	66	parity bits are stripped except when the remote side's stop and start
	67	characters are other than
	68	^S/^Q .
	69	.It Fl E
	70	The
	71	.Fl E
	72	option stops any character from being recognized as an escape character.
	73	When used with the
	74	.Fl 8
	75	option, this provides a completely transparent connection.
b7080c8e A	76	.It Fl L
	77	The
	78	.Fl L
	79	option allows the rlogin session to be run in ``litout'' (see
	80	.Xr tty 4 )
	81	mode.
	82	.It Fl d
	83	The
	84	.Fl d
	85	option turns on socket debugging (see
	86	.Xr setsockopt 2 )
	87	on the TCP sockets used for communication with the remote host.
	88	.It Fl e
	89	The
	90	.Fl e
	91	option allows user specification of the escape character, which is
	92	``~'' by default.
	93	This specification may be as a literal character, or as an octal
	94	value in the form \ennn.
b7080c8e A	95	.El
	96	.Pp
	97	A line of the form ``<escape char>.'' disconnects from the remote host.
	98	Similarly, the line ``<escape char>^Z'' will suspend the
	99	.Nm rlogin
	100	session, and ``<escape char><delayed-suspend char>'' suspends the
	101	send portion of the rlogin, but allows output from the remote system.
	102	By default, the tilde (``~'') character is the escape character, and
	103	normally control-Y (``^Y'') is the delayed-suspend character.
	104	.Pp
	105	All echoing takes place at the remote site, so that (except for delays)
	106	the
	107	.Nm rlogin
	108	is transparent.
	109	Flow control via ^S/^Q and flushing of input and output on interrupts
	110	are handled properly.
b7080c8e A	111	.Sh ENVIRONMENT
	112	The following environment variable is utilized by
	113	.Nm rlogin :
	114	.Bl -tag -width TERM
	115	.It Ev TERM
	116	Determines the user's terminal type.
	117	.El
	118	.Sh SEE ALSO
07f47057	119	.Xr rsh 1
b7080c8e A	120	.Sh HISTORY
	121	The
	122	.Nm rlogin
	123	command appeared in
	124	.Bx 4.2 .
	125	.Sh BUGS
	126	.Nm Rlogin
	127	will be replaced by
	128	.Xr telnet 1
	129	in the near future.
	130	.Pp
	131	More of the environment should be propagated.