- Complete re-write of sasc.
[dragonfly.git] / crypto / heimdal / appl / rsh / rshd.8
1 .\" Things to fix:
2 .\"   * remove Op from mandatory flags
3 .\"   * use better macros for arguments (like .Pa for files)
4 .\"
5 .Dd July 31, 2001
6 .Dt RSHD 8
7 .Os HEIMDAL
8 .Sh NAME
9 .Nm rshd
10 .Nd
11 remote shell server
12 .Sh SYNOPSIS
13 .Nm
14 .Op Fl aiklnvxPL
15 .Op Fl p Ar port
16 .Sh DESCRIPTION
17 .Nm
18 is the server for
19 the
20 .Xr rsh 1
21 program. It provides an authenticated remote command execution
22 service.  Supported options are:
23 .Bl -tag -width Ds
24 .It Xo
25 .Fl n ,
26 .Fl -no-keepalive
27 .Xc
28 Disables keep-alive messages. Keep-alives are packets sent a certain
29 interval to make sure that the client is still there, even when it
30 doesn't send any data.
31 .It Xo
32 .Fl k ,
33 .Fl -kerberos
34 .Xc
35 Assume that clients connecting to this server will use some form of
36 Kerberos authentication. See the
37 .Sx EXAMPLES
38 section for a sample
39 .Xr inetd.conf 5
40 configuration.
41 .It Xo
42 .Fl x ,
43 .Fl -encrypt
44 .Xc
45 For Kerberos 4 this means that the connections are encrypted. Kerberos
46 5 will negotiate encryption inline. This option implies
47 .Fl k .
48 .\".It Xo
49 .\".Fl l ,
50 .\".Fl -no-rhosts
51 .\".Xc
52 .\"When using old port-based authentication, the user's
53 .\".Pa .rhosts
54 .\"files are normally checked. This options disables this.
55 .It Xo
56 .Fl v ,
57 .Fl -vacuous
58 .Xc
59 If the connecting client does not use any Kerberised authentication,
60 print a message that complains about this fact, and exit. This is
61 helpful if you want to move away from old port-based authentication.
62 .It Xo
63 .Fl P
64 .Xc
65 When using the AFS filesystem, users' authentication tokens are put in
66 something called a PAG (Process Authentication Group). Multiple
67 processes can share a PAG, but normally each login session has its own
68 PAG. This option disables the
69 .Fn setpag
70 call, so all tokens will be put in the default (uid-based) PAG, making
71 it possible to share tokens between sessions. This is only useful in
72 peculiar environments, such as some batch systems.
73 .It Xo
74 .Fl i ,
75 .Fl -no-inetd
76 .Xc
77 The
78 .Fl i
79 option will cause
80 .Nm
81 to create a socket, instead of assuming that its stdin came from
82 .Xr inetd 8 .
83 This is mostly useful for debugging.
84 .It Xo
85 .Fl p Ar port ,
86 .Fl -port= Ns Ar port
87 .Xc
88 Port to use with
89 .Fl i .
90 .It Xo
91 .Fl a
92 .Xc
93 This flag is for backwards compatibility only.
94 .It Xo
95 .Fl L
96 .Xc
97 This flag enables logging of connections to
98 .Xr syslogd 8 .
99 This option is always on in this implementation.
100 .El
101 .\".Sh ENVIRONMENT
102 .Sh FILES
103 .Bl -tag -width /etc/hosts.equiv -compact
104 .It Pa /etc/hosts.equiv
105 .It Pa ~/.rhosts
106 .El
107 .Sh EXAMPLES
108 The following can be used to enable Kerberised rsh in
109 .Xr inetd.cond 5 ,
110 while disabling non-Kerberised connections:
111 .Bd -literal
112 shell   stream  tcp  nowait  root  /usr/libexec/rshd  rshd -v
113 kshell  stream  tcp  nowait  root  /usr/libexec/rshd  rshd -k
114 ekshell stream  tcp  nowait  root  /usr/libexec/rshd  rshd -kx
115 .Ed
116 .\".Sh DIAGNOSTICS
117 .Sh SEE ALSO
118 .Xr rsh 1 ,
119 .Xr iruserok 3
120 .\".Sh STANDARDS
121 .Sh HISTORY
122 The
123 .Nm
124 command appeared in
125 .Bx 4.2 .
126 .Sh AUTHORS
127 This implementation of
128 .Nm
129 was written as part of the Heimdal Kerberos 5 implementation.
130 .\".Sh BUGS