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