xref: /netbsd/usr.bin/rlogin/rlogin.1 (revision 00eed564)
1.\"	$NetBSD: rlogin.1,v 1.26 2013/03/02 16:35:17 christos Exp $
2.\"
3.\" Copyright (c) 1983, 1990, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. Neither the name of the University nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\"	@(#)rlogin.1	8.2 (Berkeley) 4/29/95
31.\"
32.Dd March 2, 2013
33.Dt RLOGIN 1
34.Os
35.Sh NAME
36.Nm rlogin
37.Nd remote login
38.Sh SYNOPSIS
39.Nm
40.Op Fl 468dEn
41.Op Fl e Ar char
42.Op Fl l Ar username
43.Op Fl p Ar port
44.Ar host
45.Nm
46.Op Fl 468dEn
47.Op Fl e Ar char
48.Op Fl p Ar port
49.Ar username@host
50.Sh DESCRIPTION
51.Nm
52starts a terminal session on a remote host
53.Ar host .
54.Pp
55.Nm
56first attempts to use the standard Berkeley
57.Em rhosts
58authorization mechanism.
59The options are as follows:
60.Bl -tag -width XlXusernameX
61.It Fl 4
62Use IPv4 addresses only.
63.It Fl 6
64Use IPv6 addresses only.
65.It Fl 8
66The
67.Fl 8
68option allows an eight-bit input data path at all times; otherwise
69parity bits are stripped except when the remote side's stop and start
70characters are other than
71.Sq \&^S/^Q .
72.It Fl d
73The
74.Fl d
75option turns on socket debugging (see
76.Xr setsockopt 2 )
77on the TCP sockets used for communication with the remote host.
78.It Fl E
79The
80.Fl E
81option stops any character from being recognized as an escape character.
82When used with the
83.Fl 8
84option, this provides a completely transparent connection.
85.It Fl e Ar char
86The
87.Fl e
88option allows user specification of the escape character, which is
89.Dq \&~
90by default.
91This specification may be as a literal character, or as an octal
92value in the form \ennn.
93.It Fl l Ar username
94the
95.Fl l
96option specifies an alternate
97.Ar username
98for the remote login.
99If this option is not specified, your local username will be used.
100.It Fl n
101Set the
102.Dv TCP_NODELAY
103socket option,
104which can improve interactive responsiveness at the possible downside of
105increased network load.
106.It Fl p Ar port
107Uses the given
108.Ar port
109instead of the one assigned to the service
110.Dq login .
111May be given either as symbolic name or as number.
112.El
113.Pp
114A line of the form
115.Dq Ao escape char Ac Ns \&.
116disconnects from the remote host.
117Similarly, the line
118.Dq Ao escape char Ac Ns ^Z
119will suspend the
120.Nm
121session, and
122.Dq Ao escape char Ac Ns Aq delayed-suspend char
123suspends the
124send portion of the rlogin, but allows output from the remote system.
125By default, the tilde
126.Pq Dq \&~
127character is the escape character, and normally control-Y
128.Pq Dq \&^Y
129is the delayed-suspend character.
130.Pp
131All echoing takes place at the remote site, so that (except for delays) the
132.Nm
133is transparent.
134Flow control via ^S/^Q and flushing of input and output on interrupts
135are handled properly.
136.Sh ENVIRONMENT
137The following environment variable is used by
138.Nm :
139.Bl -tag -width TERM
140.It Ev TERM
141Determines the user's terminal type.
142.El
143.Sh SEE ALSO
144.Xr rcmd 1 ,
145.Xr rsh 1 ,
146.Xr rcmd 3 ,
147.Xr hosts.equiv 5 ,
148.Xr rhosts 5 ,
149.Xr environ 7
150.Sh HISTORY
151The
152.Nm
153command appeared in
154.Bx 4.2 .
155.Sh BUGS
156More of the environment should be propagated.
157