source: web/old/remctl-2.14/docs/remctl.1 @ f6f3e91

web
Last change on this file since f6f3e91 was f6f3e91, checked in by Jessica B. Hamrick <jhamrick@…>, 15 years ago

Preserve directory hierarchy (not sure what happened to it)

  • Property mode set to 100644
File size: 9.0 KB
Line 
1.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sp \" Vertical space (when we can't use .PP)
6.if t .sp .5v
7.if n .sp
8..
9.de Vb \" Begin verbatim text
10.ft CW
11.nf
12.ne \\$1
13..
14.de Ve \" End verbatim text
15.ft R
16.fi
17..
18.\" Set up some character translations and predefined strings.  \*(-- will
19.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23.\" nothing in troff, for use with C<>.
24.tr \(*W-
25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26.ie n \{\
27.    ds -- \(*W-
28.    ds PI pi
29.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31.    ds L" ""
32.    ds R" ""
33.    ds C` ""
34.    ds C' ""
35'br\}
36.el\{\
37.    ds -- \|\(em\|
38.    ds PI \(*p
39.    ds L" ``
40.    ds R" ''
41'br\}
42.\"
43.\" Escape single quotes in literal strings from groff's Unicode transform.
44.ie \n(.g .ds Aq \(aq
45.el       .ds Aq '
46.\"
47.\" If the F register is turned on, we'll generate index entries on stderr for
48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49.\" entries marked with X<> in POD.  Of course, you'll have to process the
50.\" output yourself in some meaningful fashion.
51.ie \nF \{\
52.    de IX
53.    tm Index:\\$1\t\\n%\t"\\$2"
54..
55.    nr % 0
56.    rr F
57.\}
58.el \{\
59.    de IX
60..
61.\}
62.\"
63.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65.    \" fudge factors for nroff and troff
66.if n \{\
67.    ds #H 0
68.    ds #V .8m
69.    ds #F .3m
70.    ds #[ \f1
71.    ds #] \fP
72.\}
73.if t \{\
74.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75.    ds #V .6m
76.    ds #F 0
77.    ds #[ \&
78.    ds #] \&
79.\}
80.    \" simple accents for nroff and troff
81.if n \{\
82.    ds ' \&
83.    ds ` \&
84.    ds ^ \&
85.    ds , \&
86.    ds ~ ~
87.    ds /
88.\}
89.if t \{\
90.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96.\}
97.    \" troff and (daisy-wheel) nroff accents
98.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105.ds ae a\h'-(\w'a'u*4/10)'e
106.ds Ae A\h'-(\w'A'u*4/10)'E
107.    \" corrections for vroff
108.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110.    \" for low resolution devices (crt and lpr)
111.if \n(.H>23 .if \n(.V>19 \
112\{\
113.    ds : e
114.    ds 8 ss
115.    ds o a
116.    ds d- d\h'-1'\(ga
117.    ds D- D\h'-1'\(hy
118.    ds th \o'bp'
119.    ds Th \o'LP'
120.    ds ae ae
121.    ds Ae AE
122.\}
123.rm #[ #] #H #V #F C
124.\" ========================================================================
125.\"
126.IX Title "REMCTL 1"
127.TH REMCTL 1 "2009-05-22" "2.14" "remctl"
128.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents.
130.if n .ad l
131.nh
132.SH "NAME"
133remctl \- Remote execution tool
134.SH "SYNOPSIS"
135.IX Header "SYNOPSIS"
136remctl [\fB\-dhv\fR] [\fB\-p\fR \fIport\fR] [\fB\-s\fR \fIservice\fR] \fIhost\fR \fIcommand\fR
137    \fIsubcommand\fR [\fIparameters\fR ...]
138.SH "DESCRIPTION"
139.IX Header "DESCRIPTION"
140\&\fBremctl\fR is a program that allows a user to execute commands remotely on
141a server that is running the remctld daemon.  \fBremctl\fR does not interpret
142the commands given to it.  It passes them to the server and displays the
143return message.  The commands must be defined on the server-side before a
144\&\fBremctl\fR client can execute them, and the user running \fBremctl\fR must be
145authorized to execute the particular command on the server.
146.PP
147Access to remote commands is authenticated via Kerberos v5 GSS-API, so a
148user must have a ticket granting ticket to use \fBremctl\fR.  All
149transmissions to and from the remctld server are encrypted using GSS-API's
150security layer.
151.PP
152\&\fIhost\fR is the hostname of the target server.  \fIcommand\fR and
153\&\fIsubcommand\fR together specify the command to run and correspond to the
154command names in the configuration file on the server.  \fIparameters\fR are
155any additional command-line parameters to pass to the remote command.
156.SH "OPTIONS"
157.IX Header "OPTIONS"
158.IP "\fB\-d\fR" 4
159.IX Item "-d"
160Turn on extra debugging output of the client-server interaction.
161.IP "\fB\-h\fR" 4
162.IX Item "-h"
163Show a brief usage message and then exit.
164.IP "\fB\-p\fR \fIport\fR" 4
165.IX Item "-p port"
166Connect to the server on \fIport\fR.  If this option isn't given, the client
167first tries the registered remctl port (4373) and then falls back on the
168legacy port (4444) if that fails.
169.IP "\fB\-s\fR \fIservice\fR" 4
170.IX Item "-s service"
171Authenticate to the server with a service ticket for \fIservice\fR rather
172than the default server identity of host/\fIhostname\fR.  This may be
173necessary with, for instance, a server where \fBremctld\fR is not running as
174root.
175.IP "\fB\-v\fR" 4
176.IX Item "-v"
177Print the version of \fBremctl\fR and exit.
178.SH "EXIT STATUS"
179.IX Header "EXIT STATUS"
180\&\fBremctl\fR will exit with the exit status returned by the remote command.
181If some network or authentication error occurred and \fBremctl\fR was unable
182to run the remote command or retrieve its exit status, or if \fBremctl\fR was
183called with invalid arguments, \fBremctl\fR will exit with status 1.
184.SH "EXAMPLES"
185.IX Header "EXAMPLES"
186Release an \s-1AFS\s0 volume called ls.tripwire:
187.PP
188.Vb 1
189\&    remctl lsdb afs release ls.tripwire
190.Ve
191.SH "CAVEATS"
192.IX Header "CAVEATS"
193If no principal is specified with \fB\-s\fR, \fBremctl\fR canonicalizes the
194server host name using \s-1DNS\s0 before connecting.  This ensures that the
195network connection and the GSS-API authentication use the same server name
196even if some common DNS-based load-balancing schemes are in use.  To
197disable this canonicalization, specify the server principal using \fB\-s\fR.
198.PP
199The default behavior, when the port is not specified, of trying 4373 and
200falling back to 4444 will be removed in a future version of \fBremctl\fR in
201favor of using the \f(CW\*(C`remctl\*(C'\fR service in \fI/etc/services\fR if set and then
202falling back on only 4373.  4444 was the poorly-chosen original remctl
203port and should be phased out.
204.PP
205When using Heimdal with triple-DES keys and talking to old servers that
206only speak version one of the remctl protocol, \fBremctl\fR may have problems
207with \s-1MIC\s0 verification.  This doesn't affect new clients and servers since
208the version two protocol doesn't use MICs.  If you are using Heimdal and
209run into \s-1MIC\s0 verification problems, see the \s-1COMPATIBILITY\s0 section of
210\&\fIgssapi\fR\|(3).
211.SH "NOTES"
212.IX Header "NOTES"
213The remctl port number, 4373, was derived by tracing the diagonals of a
214\&\s-1QWERTY\s0 keyboard up from the letters \f(CW\*(C`remc\*(C'\fR to the number row.
215.SH "SEE ALSO"
216.IX Header "SEE ALSO"
217\&\fIkinit\fR\|(1), \fIremctld\fR\|(8)
218.PP
219The current version of this program is available from its web page at
220<http://www.eyrie.org/~eagle/software/remctl/>.
221.SH "AUTHOR"
222.IX Header "AUTHOR"
223Anton Ushakov <antonu@stanford.edu> is the original author.  Updates and
224current maintenance are done by Russ Allbery <rra@stanford.edu>.
225.SH "COPYRIGHT AND LICENSE"
226.IX Header "COPYRIGHT AND LICENSE"
227Copyright 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Board of
228Trustees, Leland Stanford Jr. University.  All rights reserved.
229.PP
230Permission to use, copy, modify, and distribute this software and its
231documentation for any purpose and without fee is hereby granted, provided
232that the above copyright notice appear in all copies and that both that
233copyright notice and this permission notice appear in supporting
234documentation, and that the name of Stanford University not be used in
235advertising or publicity pertaining to distribution of the software
236without specific, written prior permission.  Stanford University makes no
237representations about the suitability of this software for any purpose.
238It is provided \*(L"as is\*(R" without express or implied warranty.
239.PP
240\&\s-1THIS\s0 \s-1SOFTWARE\s0 \s-1IS\s0 \s-1PROVIDED\s0 \*(L"\s-1AS\s0 \s-1IS\s0\*(R" \s-1AND\s0 \s-1WITHOUT\s0 \s-1ANY\s0 \s-1EXPRESS\s0 \s-1OR\s0 \s-1IMPLIED\s0
241\&\s-1WARRANTIES\s0, \s-1INCLUDING\s0, \s-1WITHOUT\s0 \s-1LIMITATION\s0, \s-1THE\s0 \s-1IMPLIED\s0 \s-1WARRANTIES\s0 \s-1OF\s0
242\&\s-1MERCHANTABILITY\s0 \s-1AND\s0 \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0.
Note: See TracBrowser for help on using the repository browser.