Merge 1.8.0~pre4 packaging into master
[pkg-k5-afs_openafs.git] / doc / man-pages / pod8 / bos_start.pod
blobb2a3d1c756444a07e556d4bc250cc08dbe9583eb
1 =head1 NAME
3 bos_start - Starts a process after setting its status flag
5 =head1 SYNOPSIS
7 =for html
8 <div class="synopsis">
10 B<bos start> S<<< B<-server> <I<machine name>> >>>
11     S<<< B<-instance> <I<server process name>>+ >>> S<<< [B<-cell> <I<cell name>>] >>>
12     [B<-noauth>] [B<-localauth>] [B<-help>]
14 B<bos start> S<<< B<-s> <I<machine name>> >>> S<<< B<-i> <I<server process name>>+ >>>
15     S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-h>]
17 =for html
18 </div>
20 =head1 DESCRIPTION
22 The B<bos start> command sets the status flag for each process specified
23 by the B<-instance> argument to C<Run> in the F</usr/afs/local/BosConfig>
24 file and in the BOS Server's memory on the server machine named by the
25 B<-server> argument, then starts it. If the process is already running,
26 the command's only effect is to guarantee that the status flag is C<Run>;
27 it does not restart the process.
29 To start a process without changing its status flag in the F<BosConfig>
30 file, use the B<bos startup> command instead.
32 =head1 OPTIONS
34 =over 4
36 =item B<-server> <I<machine name>>
38 Indicates the server machine on which to start processes. Identify the
39 machine by IP address or its host name (either fully-qualified or
40 abbreviated unambiguously). For details, see L<bos(8)>.
42 =item B<-instance> <I<server process name>>+
44 Names each process to start. Use the process name assigned with the
45 B<-instance> argument to the B<bos create> command. The output from the
46 B<bos status> command lists the names.
48 =item B<-cell> <I<cell name>>
50 Names the cell in which to run the command. Do not combine this argument
51 with the B<-localauth> flag. For more details, see L<bos(8)>.
53 =item B<-noauth>
55 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
56 combine this flag with the B<-localauth> flag. For more details, see
57 L<bos(8)>.
59 =item B<-localauth>
61 Constructs a server ticket using a key from the local
62 F</usr/afs/etc/KeyFile> or F</usr/afs/etc/KeyFileExt> file.
63 The B<bos> command interpreter presents the
64 ticket to the BOS Server during mutual authentication. Do not combine this
65 flag with the B<-cell> or B<-noauth> options. For more details, see
66 L<bos(8)>.
68 =item B<-help>
70 Prints the online help for this command. All other valid options are
71 ignored.
73 =back
75 =head1 EXAMPLES
77 The following command changes the status flag for the C<upclientbin> and
78 C<upclientetc> processes to C<Run> in the F<BosConfig> file on the machine
79 C<fs6.example.com> and starts them running.
81    % bos start -server fs6.example.com -instance upclientbin upclientetc
83 =head1 PRIVILEGE REQUIRED
85 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
86 machine named by the B<-server> argument, or must be logged onto a server
87 machine as the local superuser C<root> if the B<-localauth> flag is
88 included.
90 =head1 SEE ALSO
92 L<BosConfig(5)>,
93 L<KeyFile(5)>,
94 L<KeyFileExt(5)>,
95 L<UserList(5)>,
96 L<bos(8)>,
97 L<bos_create(8)>,
98 L<bos_startup(8)>,
99 L<bos_status(8)>
101 =head1 COPYRIGHT
103 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
105 This documentation is covered by the IBM Public License Version 1.0.  It was
106 converted from HTML to POD by software written by Chas Williams and Russ
107 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.