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