openafs/doc/man-pages/pod8/bos_stop.pod
Russ Allbery fc5acc0151 pretty-html-synopsis-20060228
Implement proper synopsis wrapping for HTML generation.

This was done in three pieces.  First, add HTML-specific tags to the POD to
mark the synopsis for HTML purposes so that we can apply style information
to it.  Second, update the style sheet to indent all lines except for the
first in the synopsis section.  Third, add the appropriate S<> tags around
option and argument pairs so that we don't wrap between the option and its
argument.

Unfortunately, due to the <I<foo>> style that looks nicer for other reasons,
we have to use the very verbose S<<< >>>.  Oh well.
2006-03-01 05:02:29 +00:00

109 lines
3.1 KiB
Plaintext

=head1 NAME
bos stop - Stops a process after changing its status flag
=head1 SYNOPSIS
=for html
<div class="synopsis">
B<bos stop> S<<< B<-server> <I<machine name>> >>>
S<<< B<-instance> <I<server process name>>+ >>> [B<-wait>]
S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-help>]
B<bos sto> S<<< B<-s> <I<machine name>> >>> S<<< B<-i> <I<server process name>>+ >>>
[B<-w>] S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-h>]
=for html
</div>
=head1 DESCRIPTION
The B<bos stop> command sets the status flag for each process specified
with the B<-instance> argument to C<NotRun> in the
F</usr/afs/local/BosConfig> file on the server machine named by the
B<-server> argument, then stops it.
To stop a process without changing its F<BosConfig> status flag, use the
B<bos shutdown> command instead.
=head1 OPTIONS
=over 4
=item B<-server> <I<machine name>>
Indicates the server machine on which to stop processes. Identify the
machine by IP address or its host name (either fully-qualified or
abbreviated unambiguously). For details, see L<bos(8)>.
=item B<-instance> <I<server process name>>+
Names each process to stop. Use the process name assigned with the
B<-instance> argument to the B<bos create> command. The output from the
B<bos status> command lists the names.
=item B<-wait>
Delays the return of the command shell prompt until all processes actually
stop. If this argument is omitted, the prompt returns almost immediately
even if all processes are not stopped.
=item B<-cell> <I<cell name>>
Names the cell in which to run the command. Do not combine this argument
with the B<-localauth> flag. For more details, see L<bos(8)>.
=item B<-noauth>
Assigns the unprivileged identity C<anonymous> to the issuer. Do not
combine this flag with the B<-localauth> flag. For more details, see
L<bos(8)>.
=item B<-localauth>
Constructs a server ticket using a key from the local
F</usr/afs/etc/KeyFile> file. The B<bos> command interpreter presents the
ticket to the BOS Server during mutual authentication. Do not combine this
flag with the B<-cell> or B<-noauth> options. For more details, see
L<bos(8)>.
=item B<-help>
Prints the online help for this command. All other valid options are
ignored.
=back
=head1 EXAMPLES
The following example command stops the B<upserver> and B<runntp>
processes on the machine C<fs7.abc.com>.
% bos stop -server fs7.abc.com -instance upserver runntp
=head1 PRIVILEGE REQUIRED
The issuer must be listed in the F</usr/afs/etc/UserList> file on the
machine named by the B<-server> argument, or must be logged onto a server
machine as the local superuser C<root> if the B<-localauth> flag is
included.
=head1 SEE ALSO
L<BosConfig(5)>,
L<KeyFile(5)>,
L<UserList(5)>,
L<bos(8)>,
L<bos_create(8)>,
L<bos_shutdown(8)>,
L<bos_status(8)>
=head1 COPYRIGHT
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
This documentation is covered by the IBM Public License Version 1.0. It was
converted from HTML to POD by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.