=head1 NAME
-bos getlog - Prints a server process's log file
+bos_getlog - Prints a server process's log file
=head1 SYNOPSIS
-B<bos getlog -server> <I<machine name>> -file <I<log file to examine>>
-[B<-cell> <I<cell name>>] [B<-noauth>] [B<-localauth>] [B<-help>]
+=for html
+<div class="synopsis">
-B<bos getl -s> <I<machine name>> B<-f> <I<log file to examine>> [-c <I<cell name>>]
-[B<-n>] [B<-l>] [B<-h>]
+B<bos getlog> S<<< B<-server> <I<machine name>> >>> S<<< B<-file> <I<log file to examine>> >>>
+ S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-help>]
+
+B<bos getl> S<<< B<-s> <I<machine name>> >>> S<<< B<-f> <I<log file to examine>> >>>
+ S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-h>]
+
+=for html
+</div>
=head1 DESCRIPTION
-The bos getlog command displays on the standard output stream
-the specified log file from the machine named by the B<-server>
-argument. The BOS Server fetches the log file from the
-B</usr/afs/logs> directory unless an alternate pathname is provided as
-part of the B<-file> argument.
+The B<bos getlog> command displays on the standard output stream the
+specified log file from the machine named by the B<-server> argument. The
+BOS Server fetches the log file from the F</usr/afs/logs> directory unless
+an alternate pathname is provided as part of the B<-file> argument.
=head1 CAUTIONS
Log files can grow quite large, especially for the database server
-processes. To keep them to a manageable size, periodically either use
-the UNIX B<rm> command to truncate each log file, or use the B<bos
-restart> command to restart each process.
+processes. To keep them to a manageable size, periodically either use the
+UNIX B<rm> command to truncate each log file, or use the B<bos restart>
+command to restart each process.
It can take up to five minutes after the file is removed or process
restarted for the space occupied by a log file to become available.
=over 4
-=item -server
->
+=item B<-server> <I<machine name>>
Indicates the server machine from which to retrieve the log 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.
+Identify the machine by IP address or its host name (either
+fully-qualified or abbreviated unambiguously). For details, see L<bos(8)>.
-=item -file
->
+=item B<-file> <I<log file to examine>>
-Names the log file to display. If a filename only is provided, the
-BOS Server fetches the log file from the B</usr/afs/logs>
-directory; the standard values are:
+Names the log file to display. If a filename only is provided, the BOS
+Server fetches the log file from the F</usr/afs/logs> directory; the
+standard values are:
=over 4
-=item AuthLog
->
+=item F<AuthLog>
-The Authentication Server (kaserver) log file
+The Authentication Server (B<kaserver>) log file.
-=item BackupLog
->
+=item F<BackupLog>
-The Backup Server (buserver) log file
+The Backup Server (B<buserver>) log file.
-=item BosLog
->
+=item F<BosLog>
-The BOS Server (bosserver) log file
+The BOS Server (B<bosserver>) log file.
-=item FileLog
->
+=item F<FileLog>
-The File Server (fileserver) log file
+The File Server (B<fileserver>) log file.
-=item SalvageLog
->
+=item F<SalvageLog>
-The Salvager (salvager) log file
+The Salvager (B<salvager>) log file.
-=item VLLog
->
+=item F<VLLog>
-The Volume Location (VL) Server (vlserver) log file
+The Volume Location (VL) Server (B<vlserver>) log file.
-=item VolserLog
->
+=item F<VolserLog>
-The Volume Server (volserver) log file
+The Volume Server (B<volserver>) log file.
=back
-If a pathname and filename are provided, the log file is retrieved from the
-indicated directory. Partial pathnames are interpreted relative to the
-B</usr/afs/logs> directory.
+If a pathname and filename are provided, the log file is retrieved from
+the indicated directory. Partial pathnames are interpreted relative to the
+F</usr/afs/logs> directory.
-=item -cell
->
+=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 the
-introductory B<bos> reference page.
+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 -noauth
->
+=item B<-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.
+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 -localauth
->
+=item B<-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.
+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 -help
+=item B<-help>
-Prints the online help for this command. All other valid options
-are ignored.
+Prints the online help for this command. All other valid options are
+ignored.
=back
The output is preceded by the line
- Fetching log file 'I<filename>'...
+ Fetching log file '<filename>'...
The remainder of the output depends on the particular log file.
=head1 EXAMPLES
The following example displays the FileLog file from the machine
-B<fs3.abc.com>:
+C<fs3.example.com>:
- % bos getlog -server fs3.abc.com -file FileLog
+ % bos getlog -server fs3.example.com -file FileLog
Fetching log file 'FileLog'...
Sun Nov 8 04:00:34 1998 File server starting
- Sun Nov 8 04:00:39 1998 Partition /vicepa: attached 21 volumes;
+ Sun Nov 8 04:00:39 1998 Partition /vicepa: attached 21 volumes;
0 volumes not attached
- Sun Nov 8 04:00:40 1998 File Server started Sun Nov 8 04:00:40
+ Sun Nov 8 04:00:40 1998 File Server started Sun Nov 8 04:00:40
1998
- Mon Nov 9 21:45:06 1998 CB: RCallBack (zero fid probe in host.c)
+ Mon Nov 9 21:45:06 1998 CB: RCallBack (zero fid probe in host.c)
failed for host 28cf37c0.22811
=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.
+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.
+
+When a server is in restricted mode, B<bos getlog> B<-file> may only
+specify files from the logs directory.
=head1 SEE ALSO
-L<bos(1)>
+L<bos(8)>
=head1 COPYRIGHT