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