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