Import Upstream version 1.8.5
[hcoop/debian/openafs.git] / doc / man-pages / pod8 / bos_uninstall.pod
CommitLineData
805e021f
CE
1=head1 NAME
2
3bos_uninstall - Reverts to the former version of a process's binary file
4
5=head1 SYNOPSIS
6
7=for html
8<div class="synopsis">
9
10B<bos uninstall> S<<< B<-server> <I<machine name>> >>>
11 S<<< B<-file> <I<files to uninstall>>+ >>> S<<< [B<-dir> <I<destination dir>>] >>>
12 S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-help>]
13
14B<bos u> S<<< B<-s> <I<machine name>> >>> S<<< B<-f> <I<files to uninstall>>+ >>>
15 S<<< [B<-d> <I<destination dir>>] >>> S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>]
16 [B<-h>]
17
18=for html
19</div>
20
21=head1 DESCRIPTION
22
23The B<bos uninstall> command replaces each binary file specified by the
24B<-file> argument with its C<.BAK> version on the server machine named by
25the B<-server> argument, which is normally the binary distribution machine
26for its CPU/operating system type. It also changes the extension on the
27current C<.OLD> version (if any) to C<.BAK>. Each binary file must reside
28in the local F</usr/afs/bin> directory unless the B<-dir> argument names
29an alternate directory.
30
31To start using the reverted binary immediately, issue the B<bos restart>
32command. Otherwise, the BOS Server automatically restarts the process at
33the time defined in the F</usr/afs/local/BosConfig> file; use the B<bos
34getrestart> command to display the time and the B<bos setrestart> time to
35set it.
36
37=head1 OPTIONS
38
39=over 4
40
41=item B<-server> <I<machine name>>
42
43Indicates the binary distribution machine on which to revert to the
44C<.BAK> version of binaries. Identify the machine by IP address or its
45host name (either fully-qualified or abbreviated unambiguously). For
46details, see L<bos(8)>.
47
48If the machine is not a binary distribution machine and is running an
49C<upclientbin> process, then the files are overwritten the next time the
50C<upclientbin> process fetches the corresponding file from the
51distribution machine (by default within five minutes).
52
53=item B<-file> <I<files to uninstall>>+
54
55Names each binary file to replace with its C<.BAK> version.
56
57=item B<-dir> <I<destinatino dir>>
58
59Provides the complete pathname of the local disk directory containing each
60file named by the B<-file> argument. It is necessary only if the binaries
61are not in the F</usr/afs/bin> directory.
62
63=item B<-cell> <I<cell name>>
64
65Names the cell in which to run the command. Do not combine this argument
66with the B<-localauth> flag. For more details, see L<bos(8)>.
67
68=item B<-noauth>
69
70Assigns the unprivileged identity C<anonymous> to the issuer. Do not
71combine this flag with the B<-localauth> flag. For more details, see
72L<bos(8)>.
73
74=item B<-localauth>
75
76Constructs a server ticket using a key from the local
77F</usr/afs/etc/KeyFile> or F</usr/afs/etc/KeyFileExt> file.
78The B<bos> command interpreter presents the
79ticket to the BOS Server during mutual authentication. Do not combine this
80flag with the B<-cell> or B<-noauth> options. For more details, see
81L<bos(8)>.
82
83=item B<-help>
84
85Prints the online help for this command. All other valid options are
86ignored.
87
88=back
89
90=head1 EXAMPLES
91
92The following example command overwrites the F</usr/afs/bin/kaserver> file
93on the machine C<fs4.example.com> with its C<.BAK> version, and the current
94C<.BAK> version by the C<.OLD> version.
95
96 % bos uninstall -server fs4.example.com -file kaserver
97
98=head1 PRIVILEGE REQUIRED
99
100The issuer must be listed in the F</usr/afs/etc/UserList> file on the
101machine named by the B<-server> argument, or must be logged onto a server
102machine as the local superuser C<root> if the B<-localauth> flag is
103included.
104
105The B<bos uninstall> command cannot be run against servers running in
106restricted mode.
107
108=head1 SEE ALSO
109
110L<BosConfig(5)>,
111L<KeyFile(5)>,
112L<KeyFileExt(5)>,
113L<UserList(5)>,
114L<bos(8)>,
115L<bos_getrestart(8)>,
116L<bos_restart(8)>,
117L<bos_setrestart(8)>,
118L<upclient(8)>
119
120=head1 COPYRIGHT
121
122IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
123
124This documentation is covered by the IBM Public License Version 1.0. It was
125converted from HTML to POD by software written by Chas Williams and Russ
126Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.