openafs/doc/man-pages/pod8/bos_delete.pod
Russ Allbery e3dfba8e6c man-page-conversion-20051208
This is the initial conversion of the AFS Adminstrators Reference into POD
for use as man pages.  The man pages are now generated via pod2man from
regen.sh so that only those working from CVS have to have pod2man
available.  The Makefile only installs.  The pages have also been sorted
out into pod1, pod5, and pod8 directories, making conversion to the right
section of man page easier without maintaining a separate list and allowing
for names to be duplicated between pod5 and pod1 or pod8 (which will likely
be needed in a few cases).

This reconversion is done with a new script based on work by Chas Williams.
In some cases, the output is worse than the previous POD pages, but this is
a more comprehensive conversion.

This is only the first step, and this initial conversion has various
problems.  In addition, the file man pages that didn't have simple names
have not been converted in this pass and will be added later.  Some of the
man pages have syntax problems and all of them have formatting errors.  The
next editing pass, coming shortly, will clean up most of the remaining
mess.
2005-12-08 12:14:33 +00:00

110 lines
3.0 KiB
Plaintext

=head1 NAME
bos delete - Deletes a server process from the /usr/afs/local/BosConfig file
=head1 SYNOPSIS
B<bos delete -server> <I<machine name>> -instance <I<server process name>>+
[B<-cell> <I<cell name>>] [B<-noauth>] [B<-localauth>] [B<-help>]
B<bos d -s> <I<machine name>> B<-i> <I<server process name>>+ [-c <I<cell name>>]
[B<-n>] [B<-l>] [B<-h>]
=head1 DESCRIPTION
The bos delete command removes the
B</usr/afs/local/BosConfig> entry for each process indicated by the
B<-instance> argument, on the server machine named by the
B<-server> argument.
Before issuing this command, issue the bos stop command to stop
the process and set its status flag in the B<BosConfig> file to
C<NotRun>. The B<bos delete> command fails with an
error message if a process's status flag is C<Run>.
=head1 OPTIONS
=over 4
=item -server
>
Indicates the server machine on which to delete the server process entry
from the B</usr/afs/local/BosConfig> file. Identify the machine
by IP address or its host name (either fully-qualified or abbreviated
unambiguously). For details, see the introductory reference page for
the B<bos> command suite.
=item -instance
>
Names each process to delete. Use the name assigned with the
B<-instance> argument to the B<bos create> command;
process names appear in the output of the B<bos status>
command.
=item -cell
>
Names the cell in which to run the command. Do not combine this
argument with the B<-localauth> flag. For more details, see the
introductory B<bos> reference page.
=item -noauth
>
Assigns the unprivileged identity anonymous to the
issuer. Do not combine this flag with the B<-localauth>
flag. For more details, see the introductory B<bos> reference
page.
=item -localauth
>
Constructs a server ticket using a key from the local
B</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 the introductory
B<bos> reference page.
=item -help
Prints the online help for this command. All other valid options
are ignored.
=back
=head1 EXAMPLES
The following command removes the B<buserver>, kaserver,
B<ptserver>, and B<vlserver> entries from the
B<BosConfig> file on B<db3.abc.com>, a database
server machine being decommissioned.
% bos delete -server db3.abc.com -instance buserver kaserver ptserver vlserver
=head1 PRIVILEGE REQUIRED
The issuer must be listed in the /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 B<root> if the
B<-localauth> flag is included.
=head1 SEE ALSO
L<BosConfig(1)>,
L<KeyFile(1)>,
L<UserList(1)>,
L<bos(1)>,
L<bos_create(1)>,
L<bos_status(1)>
=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.