Document KeyFileExt(5)
[openafs.git] / doc / man-pages / pod8 / bos_install.pod
1 =head1 NAME
2
3 bos_install - Installs a new version of a binary file
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<bos install> S<<< B<-server> <I<machine name>> >>> S<<< B<-file> <I<files to install>>+ >>>
11     S<<< [B<-dir> <I<destination dir>>] >>> S<<< [B<-cell> <I<cell name>>] >>>
12     [B<-noauth>] [B<-localauth>] [B<-help>]
13
14 B<bos i> S<<< B<-s> <I<machine name>> >>> S<<< B<-f> <I<files to install>>+ >>>
15     S<<< [B<-d> <I<destination dir>>] >>> S<<< [B<-c> <I<cell name>>] >>> [B<-n>]
16     [B<-l>] [B<-h>]
17
18 =for html
19 </div>
20
21 =head1 DESCRIPTION
22
23 The B<bos install> command copies each binary file specified with the
24 B<-file> argument to the local disk of the server machine named by the
25 B<-server> argument, which is normally the binary distribution machine for
26 its CPU/operating system type. The destination directory is
27 F</usr/afs/bin> unless the B<-dir> argument indicates an alternate
28 directory. The source file's UNIX mode bits are preserved in the transfer.
29
30 If there is already a file of the same name in the destination directory,
31 the BOS Server automatically saves it by adding a C<.BAK> extension. If
32 there is a current C<.BAK> version at least seven days old, it replaces
33 the current C<.OLD> version. If there is no current C<.OLD> version, the
34 current C<.BAK> version becomes the C<.OLD> version automatically. The
35 B<bos getdate> command displays the timestamps on the current versions of
36 the file.
37
38 To start using the new binary immediately, issue the bos restart
39 command. Otherwise, the BOS Server automatically restarts the process at
40 the time defined in the F</usr/afs/local/BosConfig> file; use the B<bos
41 getrestart> command to display the time and the B<bos setrestart> time to
42 set it.
43
44 =head1 OPTIONS
45
46 =over 4
47
48 =item B<-server> <I<machine name>>
49
50 Indicates the binary distribution machine on which to install the new
51 binaries. Identify the machine by IP address or its host name (either
52 fully-qualified or abbreviated unambiguously). For details, see L<bos(8)>.
53
54 If the machine is not a binary distribution machine and is running an
55 C<upclientbin> process, then the files are overwritten the next time the
56 C<upclientbin> process fetches the corresponding file from the
57 distribution machine (by default within five minutes).
58
59 =item B<-file> <I<files to install>>+
60
61 Specifies the complete pathname of each binary file to copy into the
62 destination directory. Each source directory can be on the local disk or
63 in AFS, in which case the issuer of the B<bos install> command must have
64 the necessary AFS access rights and the local machine must run the Cache
65 Manager. For the BOS Server to create C<.BAK> and C<.OLD> versions, the
66 last element in the pathname (the filename) must match the name of a file
67 in the destination directory.  L<bos_create(8)> lists the standard binary
68 file names.
69
70 =item B<-dir> <I<destination dir>>
71
72 Provides the complete pathname of the local disk directory in which to
73 install binary files. It is necessary only if the destination directory
74 is not F</usr/afs/bin>.
75
76 =item B<-cell> <I<cell name>>
77
78 Names the cell in which to run the command. Do not combine this argument
79 with the B<-localauth> flag. For more details, see L<bos(8)>.
80
81 =item B<-noauth>
82
83 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
84 combine this flag with the B<-localauth> flag. For more details, see
85 L<bos(8)>.
86
87 =item B<-localauth>
88
89 Constructs a server ticket using a key from the local
90 F</usr/afs/etc/KeyFile> or F</usr/afs/etc/KeyFileExt> file.
91 The B<bos> command interpreter presents the
92 ticket to the BOS Server during mutual authentication. Do not combine this
93 flag with the B<-cell> or B<-noauth> options. For more details, see
94 L<bos(8)>.
95
96 =item B<-help>
97
98 Prints the online help for this command. All other valid options are
99 ignored.
100
101 =back
102
103 =head1 EXAMPLES
104
105 The following command copies the file
106 F</afs/example.com/rs_aix42/usr/afs/bin/vlserver> to the file
107 F</usr/afs/bin/vlserver> on the machine C<fs3.example.com>, which is the
108 binary distribution machine for server machines running AIX 4.2 in the
109 C<example.com> cell. The current version of the F</usr/afs/bin/vlserver> file
110 is moved to F</usr/afs/bin/vlserver.BAK>.
111
112    % bos install -server fs3.example.com \
113                  -file /afs/example.com/rs_aix42/usr/afs/bin/vlserver
114
115 =head1 PRIVILEGE REQUIRED
116
117 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
118 machine named by the B<-server> argument, or must be logged onto a server
119 machine as the local superuser C<root> if the B<-localauth> flag is
120 included.
121
122 The B<bos install> command cannot be run against servers which are in
123 restricted mode.
124
125 =head1 SEE ALSO
126
127 L<BosConfig(5)>,
128 L<KeyFile(5)>,
129 L<KeyFileExt(5)>,
130 L<UserList(5)>,
131 L<bos(8)>,
132 L<bos_getdate(8)>,
133 L<bos_getrestart(8)>,
134 L<bos_restart(8)>,
135 L<bos_setrestart(8)>
136
137 =head1 COPYRIGHT
138
139 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
140
141 This documentation is covered by the IBM Public License Version 1.0.  It was
142 converted from HTML to POD by software written by Chas Williams and Russ
143 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.