Sync usage with man page.
[netbsd-mini2440.git] / crypto / dist / heimdal / appl / rsh / rshd.8
blobbfec040d2b507ebd8ee656377e012f68e270cfa3
1 .\" Copyright (c) 2001 - 2006 Kungliga Tekniska Högskolan
2 .\" (Royal Institute of Technology, Stockholm, Sweden). 
3 .\" All rights reserved. 
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without 
6 .\" modification, are permitted provided that the following conditions 
7 .\" are met: 
8 .\"
9 .\" 1. Redistributions of source code must retain the above copyright 
10 .\"    notice, this list of conditions and the following disclaimer. 
11 .\"
12 .\" 2. Redistributions in binary form must reproduce the above copyright 
13 .\"    notice, this list of conditions and the following disclaimer in the 
14 .\"    documentation and/or other materials provided with the distribution. 
15 .\"
16 .\" 3. Neither the name of the Institute 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 INSTITUTE 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 INSTITUTE 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 .\" $Heimdal: rshd.8 16764 2006-02-27 10:07:04Z joda $
33 .\" $NetBSD$
34 .\"
35 .Dd November 22, 2002
36 .Dt RSHD 8
37 .Os
38 .Sh NAME
39 .Nm rshd
40 .Nd
41 remote shell server
42 .Sh SYNOPSIS
43 .Nm
44 .Op Fl aiklnvxPL
45 .Op Fl p Ar port
46 .Sh DESCRIPTION
47 .Nm
48 is the server for
49 the
50 .Xr rsh 1
51 program. It provides an authenticated remote command execution
52 service.  Supported options are:
53 .Bl -tag -width Ds
54 .It Xo
55 .Fl n ,
56 .Fl -no-keepalive
57 .Xc
58 Disables keep-alive messages.
59 Keep-alives are packets sent at certain intervals to make sure that the
60 client is still there, even when it doesn't send any data.
61 .It Xo
62 .Fl k ,
63 .Fl -kerberos
64 .Xc
65 Assume that clients connecting to this server will use some form of
66 Kerberos authentication. See the
67 .Sx EXAMPLES
68 section for a sample
69 .Xr inetd.conf 5
70 configuration.
71 .It Xo
72 .Fl x ,
73 .Fl -encrypt
74 .Xc
75 For Kerberos 4 this means that the connections are encrypted. Kerberos
76 5 can negotiate encryption even without this option, but if it's
77 present
78 .Nm
79 will deny unencrypted connections. This option implies
80 .Fl k .
81 .\".It Xo
82 .\".Fl l ,
83 .\".Fl -no-rhosts
84 .\".Xc
85 .\"When using old port-based authentication, the user's
86 .\".Pa .rhosts
87 .\"files are normally checked. This option disables this.
88 .It Xo
89 .Fl v ,
90 .Fl -vacuous
91 .Xc
92 If the connecting client does not use any Kerberised authentication,
93 print a message that complains about this fact, and exit. This is
94 helpful if you want to move away from old port-based authentication.
95 .It Xo
96 .Fl P
97 .Xc
98 When using the AFS filesystem, users' authentication tokens are put in
99 something called a PAG (Process Authentication Group). Multiple
100 processes can share a PAG, but normally each login session has its own
101 PAG. This option disables the
102 .Fn setpag
103 call, so all tokens will be put in the default (uid-based) PAG, making
104 it possible to share tokens between sessions. This is only useful in
105 peculiar environments, such as some batch systems.
106 .It Xo
107 .Fl i ,
108 .Fl -no-inetd
111 .Fl i
112 option will cause
114 to create a socket, instead of assuming that its stdin came from
115 .Xr inetd 8 .
116 This is mostly useful for debugging.
117 .It Xo
118 .Fl p Ar port ,
119 .Fl -port= Ns Ar port
121 Port to use with
122 .Fl i .
123 .It Xo
124 .Fl a
126 This flag is for backwards compatibility only.
127 .It Xo
128 .Fl L
130 This flag enables logging of connections to
131 .Xr syslogd 8 .
132 This option is always on in this implementation.
134 .\".Sh ENVIRONMENT
135 .Sh FILES
136 .Bl -tag -width /etc/hosts.equiv -compact
137 .It Pa /etc/hosts.equiv
138 .It Pa ~/.rhosts
140 .Sh EXAMPLES
141 The following can be used to enable Kerberised rsh in
142 .Xr inetd.cond 5 ,
143 while disabling non-Kerberised connections:
144 .Bd -literal
145 shell   stream  tcp  nowait  root  /usr/libexec/rshd  rshd -v
146 kshell  stream  tcp  nowait  root  /usr/libexec/rshd  rshd -k
147 ekshell stream  tcp  nowait  root  /usr/libexec/rshd  rshd -kx
149 .\".Sh DIAGNOSTICS
150 .Sh SEE ALSO
151 .Xr rsh 1 ,
152 .Xr iruserok 3
153 .\".Sh STANDARDS
154 .Sh HISTORY
157 command appeared in
158 .Bx 4.2 .
159 .Sh AUTHORS
160 This implementation of
162 was written as part of the Heimdal Kerberos 5 implementation.
163 .\".Sh BUGS