openafs/doc/man-pages/pod8/bos_startup.pod
Ken Dreyer 1cc8feb6fc doc: replace hostnames with IETF example hostnames
There were several different real and made-up hostnames and company names used
throughout our documentation examples.

The IETF has reserved "example.com" and other "example" TLDs for use in
examples (RFC 2606). Replace almost all references to ABC Corporation, DEF
Corporation, and State University, as well as "abc.com", "bigcell.com",
"def.com", "def.gov", "ghi.com", "ghi.gov", "jkl.com", "mit.edu",
"stanford.edu", "state.edu", "stateu.edu", "uncc.edu", and "xyz.com".
Standardize on "Example Corporation", "Example Network", "Example
Organization" (example.com, example.net, and example.org).

The Scout documentation in the Admin Guide contains PNG images that contain
the old cell names, so I left those references until the images can be
replaced.

Change-Id: I4e44815b2d2ffe204810b7fd850842248f67c367
Reviewed-on: http://gerrit.openafs.org/6697
Reviewed-by: Jeffrey Altman <jaltman@secure-endpoints.com>
Tested-by: Jeffrey Altman <jaltman@secure-endpoints.com>
2012-02-17 20:51:58 -08:00

122 lines
3.3 KiB
Plaintext

=head1 NAME
bos_startup - Starts a process without changing its status flag
=head1 SYNOPSIS
=for html
<div class="synopsis">
B<bos startup> S<<< B<-server> <I<machine name>> >>> S<<< [B<-instance> <I<instances>>+] >>>
S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-help>]
B<bos startu> S<<< B<-s> <I<machine name>> >>> S<<< [B<-i> <I<instances>>+] >>>
S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-h>]
=for html
</div>
=head1 DESCRIPTION
The B<bos startup> command starts, on the server machine named by the
B<-server> argument, either:
=over 4
=item *
All AFS server processes not currently running but marked with the C<Run>
status flag in the F</usr/afs/local/BosConfig> file.
=item *
Each process specified by B<-instance> argument, even if its status flag
in the B<BosConfig> file is C<NotRun>.
=back
To start a process and set its F<BosConfig> status flag to C<Run>, use the
B<bos start> 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<instances>>+
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> 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 starts all processes marked with status flag C<Run>
in the F<BosConfig> file on the machine C<fs3.example.com> that are not
currently running.
% bos startup fs3.example.com
The following command starts the B<buserver>, B<kaserver>, B<ptserver>,
and B<vlserver> processes running on the machine C<db2.example.com>, even if
their status flags in the F<BosConfig> file are C<NotRun>.
% bos startup -server db2.example.com \
-instance buserver kaserver ptserver vlserver
=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_start(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.