eee136a858d2a7c045f7cccc34fa749426e6f348
[openafs.git] / doc / man-pages / pod8 / bos_start.pod
1 =head1 NAME
2
3 bos_start - Starts a process after setting its status flag
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
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>]
13
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>]
16
17 =for html
18 </div>
19
20 =head1 DESCRIPTION
21
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.
28
29 To start a process without changing its status flag in the F<BosConfig>
30 file, use the B<bos startup> command instead.
31
32 =head1 OPTIONS
33
34 =over 4
35
36 =item B<-server> <I<machine name>>
37
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)>.
41
42 =item B<-instance> <I<server process name>>+
43
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.
47
48 =item B<-cell> <I<cell name>>
49
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)>.
52
53 =item B<-noauth>
54
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)>.
58
59 =item B<-localauth>
60
61 Constructs a server ticket using a key from the local
62 F</usr/afs/etc/KeyFile> file. The B<bos> command interpreter presents the
63 ticket to the BOS Server during mutual authentication. Do not combine this
64 flag with the B<-cell> or B<-noauth> options. For more details, see
65 L<bos(8)>.
66
67 =item B<-help>
68
69 Prints the online help for this command. All other valid options are
70 ignored.
71
72 =back
73
74 =head1 EXAMPLES
75
76 The following command changes the status flag for the C<upclientbin> and
77 C<upclientetc> processes to C<Run> in the F<BosConfig> file on the machine
78 C<fs6.example.com> and starts them running.
79
80    % bos start -server fs6.example.com -instance upclientbin upclientetc
81
82 =head1 PRIVILEGE REQUIRED
83
84 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
85 machine named by the B<-server> argument, or must be logged onto a server
86 machine as the local superuser C<root> if the B<-localauth> flag is
87 included.
88
89 =head1 SEE ALSO
90
91 L<BosConfig(5)>,
92 L<KeyFile(5)>,
93 L<UserList(5)>,
94 L<bos(8)>,
95 L<bos_create(8)>,
96 L<bos_startup(8)>,
97 L<bos_status(8)>
98
99 =head1 COPYRIGHT
100
101 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
102
103 This documentation is covered by the IBM Public License Version 1.0.  It was
104 converted from HTML to POD by software written by Chas Williams and Russ
105 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.