Document KeyFileExt(5)
[openafs.git] / doc / man-pages / pod8 / bos_stop.pod
1 =head1 NAME
2
3 bos_stop - Stops a process after changing its status flag
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<bos stop> S<<< B<-server> <I<machine name>> >>>
11     S<<< B<-instance> <I<server process name>>+ >>> [B<-wait>]
12     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-help>]
13
14 B<bos sto> S<<< B<-s> <I<machine name>> >>> S<<< B<-i> <I<server process name>>+ >>>
15     [B<-w>] 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 stop> command sets the status flag for each process specified
23 with the B<-instance> argument to C<NotRun> in the
24 F</usr/afs/local/BosConfig> file on the server machine named by the
25 B<-server> argument, then stops it.
26
27 To stop a process without changing its F<BosConfig> status flag, use the
28 B<bos shutdown> command instead.
29
30 =head1 OPTIONS
31
32 =over 4
33
34 =item B<-server> <I<machine name>>
35
36 Indicates the server machine on which to stop processes. Identify the
37 machine by IP address or its host name (either fully-qualified or
38 abbreviated unambiguously). For details, see L<bos(8)>.
39
40 =item B<-instance> <I<server process name>>+
41
42 Names each process to stop. Use the process name assigned with the
43 B<-instance> argument to the B<bos create> command. The output from the
44 B<bos status> command lists the names.
45
46 =item B<-wait>
47
48 Delays the return of the command shell prompt until all processes actually
49 stop. If this argument is omitted, the prompt returns almost immediately
50 even if all processes are not stopped.
51
52 =item B<-cell> <I<cell name>>
53
54 Names the cell in which to run the command. Do not combine this argument
55 with the B<-localauth> flag. For more details, see L<bos(8)>.
56
57 =item B<-noauth>
58
59 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
60 combine this flag with the B<-localauth> flag. For more details, see
61 L<bos(8)>.
62
63 =item B<-localauth>
64
65 Constructs a server ticket using a key from the local
66 F</usr/afs/etc/KeyFile> or F</usr/afs/etc/KeyFileExt> file.
67 The B<bos> command interpreter presents the
68 ticket to the BOS Server during mutual authentication. Do not combine this
69 flag with the B<-cell> or B<-noauth> options. For more details, see
70 L<bos(8)>.
71
72 =item B<-help>
73
74 Prints the online help for this command. All other valid options are
75 ignored.
76
77 =back
78
79 =head1 EXAMPLES
80
81 The following example command stops the B<upserver> and B<vlserver>
82 processes on the machine C<fs7.example.com>.
83
84    % bos stop -server fs7.example.com -instance upserver vlserver
85
86 =head1 PRIVILEGE REQUIRED
87
88 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
89 machine named by the B<-server> argument, or must be logged onto a server
90 machine as the local superuser C<root> if the B<-localauth> flag is
91 included.
92
93 =head1 SEE ALSO
94
95 L<BosConfig(5)>,
96 L<KeyFile(5)>,
97 L<KeyFileExt(5)>,
98 L<UserList(5)>,
99 L<bos(8)>,
100 L<bos_create(8)>,
101 L<bos_shutdown(8)>,
102 L<bos_status(8)>
103
104 =head1 COPYRIGHT
105
106 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
107
108 This documentation is covered by the IBM Public License Version 1.0.  It was
109 converted from HTML to POD by software written by Chas Williams and Russ
110 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.