openafs/doc/man-pages/pod8/bos_start.pod
Benjamin Kaduk 20d5760fe9 Document KeyFileExt(5)
Add a manual page for the KeyFileExt file.

Add cross-references from all places which currently reference
KeyFile(5), and update their body text accordingly.

Change-Id: Iab56847fcb59dda0c8a344a626ddb0ff35b98b26
Reviewed-on: http://gerrit.openafs.org/11770
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Benjamin Kaduk <kaduk@mit.edu>
2015-08-27 22:31:44 -04:00

108 lines
3.2 KiB
Plaintext

=head1 NAME
bos_start - Starts a process after setting its status flag
=head1 SYNOPSIS
=for html
<div class="synopsis">
B<bos start> S<<< B<-server> <I<machine name>> >>>
S<<< B<-instance> <I<server process name>>+ >>> S<<< [B<-cell> <I<cell name>>] >>>
[B<-noauth>] [B<-localauth>] [B<-help>]
B<bos start> S<<< B<-s> <I<machine name>> >>> S<<< B<-i> <I<server process name>>+ >>>
S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-h>]
=for html
</div>
=head1 DESCRIPTION
The B<bos start> command sets the status flag for each process specified
by the B<-instance> argument to C<Run> in the F</usr/afs/local/BosConfig>
file and in the BOS Server's memory on the server machine named by the
B<-server> argument, then starts it. If the process is already running,
the command's only effect is to guarantee that the status flag is C<Run>;
it does not restart the process.
To start a process without changing its status flag in the F<BosConfig>
file, use the B<bos startup> command instead.
=head1 OPTIONS
=over 4
=item B<-server> <I<machine name>>
Indicates the server machine on which to start 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 start. 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<-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> or F</usr/afs/etc/KeyFileExt> 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 command changes the status flag for the C<upclientbin> and
C<upclientetc> processes to C<Run> in the F<BosConfig> file on the machine
C<fs6.example.com> and starts them running.
% bos start -server fs6.example.com -instance upclientbin upclientetc
=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<KeyFileExt(5)>,
L<UserList(5)>,
L<bos(8)>,
L<bos_create(8)>,
L<bos_startup(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.