.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "BOS_GETLOG 8"
.TH BOS_GETLOG 8 "2023-12-24" "OpenAFS" "AFS Command Reference"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
bos_getlog \- Prints a server process's log file
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBbos getlog\fR \fB\-server\fR\ <\fImachine\ name\fR> \fB\-file\fR\ <\fIlog\ file\ to\ examine\fR>
    [\fB\-cell\fR\ <\fIcell\ name\fR>] [\fB\-noauth\fR] [\fB\-localauth\fR] [\fB\-help\fR]
.PP
\&\fBbos getl\fR \fB\-s\fR\ <\fImachine\ name\fR> \fB\-f\fR\ <\fIlog\ file\ to\ examine\fR>
    [\fB\-c\fR\ <\fIcell\ name\fR>] [\fB\-n\fR] [\fB\-l\fR] [\fB\-h\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \fBbos getlog\fR command displays on the standard output stream the
specified log file from the machine named by the \fB\-server\fR argument. The
\&\s-1BOS\s0 Server fetches the log file from the \fI/var/log/openafs\fR directory unless
an alternate pathname is provided as part of the \fB\-file\fR argument.
.SH "CAUTIONS"
.IX Header "CAUTIONS"
Log files can grow quite large, especially for the database server
processes. To keep them to a manageable size, periodically either use the
\&\s-1UNIX\s0 \fBrm\fR command to truncate each log file, or use the \fBbos restart\fR
command to restart each process.
.PP
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.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-server\fR <\fImachine name\fR>" 4
.IX Item "-server <machine name>"
Indicates the server machine from which to retrieve the log file.
Identify the machine by \s-1IP\s0 address or its host name (either
fully-qualified or abbreviated unambiguously). For details, see \fBbos\fR\|(8).
.IP "\fB\-file\fR <\fIlog file to examine\fR>" 4
.IX Item "-file <log file to examine>"
Names the log file to display. If a filename only is provided, the \s-1BOS\s0
Server fetches the log file from the \fI/var/log/openafs\fR directory; the
standard values are:
.RS 4
.IP "\fIAuthLog\fR" 4
.IX Item "AuthLog"
The Authentication Server (\fBkaserver\fR) log file.
.IP "\fIBackupLog\fR" 4
.IX Item "BackupLog"
The Backup Server (\fBbuserver\fR) log file.
.IP "\fIBosLog\fR" 4
.IX Item "BosLog"
The \s-1BOS\s0 Server (\fBbosserver\fR) log file.
.IP "\fIFileLog\fR" 4
.IX Item "FileLog"
The File Server (\fBfileserver\fR) log file.
.IP "\fIPtLog\fR" 4
.IX Item "PtLog"
The Protection Server (\fBptserver\fR) log file.
.IP "\fISalvageLog\fR" 4
.IX Item "SalvageLog"
The Salvager (\fBsalvager\fR) log file.
.IP "\fIVLLog\fR" 4
.IX Item "VLLog"
The Volume Location (\s-1VL\s0) Server (\fBvlserver\fR) log file.
.IP "\fIVolserLog\fR" 4
.IX Item "VolserLog"
The Volume Server (\fBvolserver\fR) log file.
.RE
.RS 4
.Sp
If a pathname and filename are provided, the log file is retrieved from
the indicated directory. Partial pathnames are interpreted relative to the
\&\fI/var/log/openafs\fR directory.
.RE
.IP "\fB\-cell\fR <\fIcell name\fR>" 4
.IX Item "-cell <cell name>"
Names the cell in which to run the command. Do not combine this argument
with the \fB\-localauth\fR flag. For more details, see \fBbos\fR\|(8).
.IP "\fB\-noauth\fR" 4
.IX Item "-noauth"
Assigns the unprivileged identity \f(CW\*(C`anonymous\*(C'\fR to the issuer. Do not
combine this flag with the \fB\-localauth\fR flag. For more details, see
\&\fBbos\fR\|(8).
.IP "\fB\-localauth\fR" 4
.IX Item "-localauth"
Constructs a server ticket using a key from the local
\&\fI/etc/openafs/server/KeyFile\fR file. The \fBbos\fR command interpreter presents the
ticket to the \s-1BOS\s0 Server during mutual authentication. Do not combine this
flag with the \fB\-cell\fR or \fB\-noauth\fR options. For more details, see
\&\fBbos\fR\|(8).
.IP "\fB\-help\fR" 4
.IX Item "-help"
Prints the online help for this command. All other valid options are
ignored.
.SH "OUTPUT"
.IX Header "OUTPUT"
The output is preceded by the line
.PP
.Vb 1
\&   Fetching log file \*(Aq<filename>\*(Aq...
.Ve
.PP
The remainder of the output depends on the particular log file.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
The following example displays the FileLog file from the machine
\&\f(CW\*(C`fs3.example.com\*(C'\fR:
.PP
.Vb 9
\&   % bos getlog \-server fs3.example.com \-file FileLog
\&   Fetching log file \*(AqFileLog\*(Aq...
\&   Sun Nov 8 04:00:34 1998 File server starting
\&   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
\&                           1998
\&   Mon Nov 9 21:45:06 1998 CB: RCallBack (zero fid probe in host.c)
\&                           failed for host 28cf37c0.22811
.Ve
.SH "PRIVILEGE REQUIRED"
.IX Header "PRIVILEGE REQUIRED"
The issuer must be listed in the \fI/etc/openafs/server/UserList\fR file on the
machine named by the \fB\-server\fR argument, or must be logged onto a server
machine as the local superuser \f(CW\*(C`root\*(C'\fR if the \fB\-localauth\fR flag is
included.
.PP
When a server is in restricted mode, \fBbos getlog\fR \fB\-file\fR may only
specify files from the logs directory.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBbos\fR\|(8)
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
\&\s-1IBM\s0 Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
.PP
This documentation is covered by the \s-1IBM\s0 Public License Version 1.0.  It was
converted from \s-1HTML\s0 to \s-1POD\s0 by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.