.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (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 .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . 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 .\" ======================================================================== .\" .IX Title "VOLINFO 8" .TH VOLINFO 8 2024-03-20 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 volinfo \- Produces detailed statistics about AFS volume headers .SH SYNOPSIS .IX Header "SYNOPSIS" \&\fBvolinfo\fR [\fB\-checkout\fR] [\fB\-vnode\fR] [\fB\-date\fR] [\fB\-inode\fR] [\fB\-itime\fR] [\fB\-part\fR\ <\fIAFS\ partition\ name\ (default\ current\ partition)\fR>+] [\fB\-volumeid\fR\ <\fIvolume\ id\fR>+] [\fB\-header\fR] [\fB\-sizeonly\fR] [\fB\-fixheader\fR] [\fB\-saveinodes\fR] [\fB\-orphaned\fR] [\fB\-filenames\fR] [\fB\-help\fR] .SH DESCRIPTION .IX Header "DESCRIPTION" The \fBvolinfo\fR command displays detailed statistics about one or more volume headers and the partition that houses them. The command must be issued on a file server machine and by default produces output for every volume on every AFS server partition on the machine. To display output for the volumes on one partition only, include the \fB\-part\fR argument. To display output for one volume only, include the \fB\-volumeid\fR argument. .SH OPTIONS .IX Header "OPTIONS" .IP \fB\-checkout\fR 4 .IX Item "-checkout" Checkout the specified volume from the running fileserver. This ensures that the fileserver or other processes will not be modifying volume metadata at the same time we are trying to read it, leading to invalid or incorrect results. .IP \fB\-vnode\fR 4 .IX Item "-vnode" Displays a table for each volume which lists the large (directory) and small (file) vnodes in it, in addition to the default output. .IP \fB\-date\fR 4 .IX Item "-date" When combined with the \fB\-vnode\fR flag, adds the \f(CW\*(C`ServerModTime\*(C'\fR field to each vnode entry in the large vnode and small vnode tables, reporting its most recent modification time. .IP \fB\-inode\fR 4 .IX Item "-inode" When combined with the \fB\-vnode\fR flag, adds the \f(CW\*(C`inode\*(C'\fR field to each vnode entry in the large vnode and small vnode tables, reporting the associated inode number. .IP \fB\-itime\fR 4 .IX Item "-itime" When combined with the \fB\-vnode\fR flag, displays a change, modification, and access timestamp for each of the large vnode and small vnode tables. .IP "\fB\-part\fR <\fIpartition name or id\fR>+" 4 .IX Item "-part +" Specifies the partition that houses each volume for which to produce output. Use the format \fI/vicepxx\fR or \fIxx\fR, where \fIxx\fR is one or two lowercase letters. This argument can be omitted if the current working directory is the mount location for an AFS server partition. If it is not the mount location for an AFS server partition, the command produces output for every volume on all local AFS server partitions. .IP "\fB\-volumeid\fR <\fIvolume id\fR>+" 4 .IX Item "-volumeid +" Specifies the ID number of one volume for which to produce output. The \&\fB\-part\fR argument must be provided along with this one unless the current working directory is the mount location for the AFS server partition that houses the volume. .IP \fB\-header\fR 4 .IX Item "-header" Displays statistics about the volume header of each volume, in addition to the default output. .IP \fB\-sizeonly\fR 4 .IX Item "-sizeonly" Displays a single line of output for each volume, reporting the size of various structures associated with it. The default output is suppressed and any flags that modify it (such as \fB\-vnode\fR) are ignored. .IP \fB\-fixheader\fR 4 .IX Item "-fixheader" Repairs damaged inodes in each volume if possible. If there are any, it reports the action it is taking to repair them. Otherwise, it produces no output in addition to the default output. .IP \fB\-saveinodes\fR 4 .IX Item "-saveinodes" Creates a file in the current working directory for each inode in each volume. Each file is called \fITmpInode.vnode_number\fR and contains the inode's contents. The default output is suppressed and any flags that modify it (such as \fB\-vnode\fR) are ignored. .IP \fB\-orphaned\fR 4 .IX Item "-orphaned" Displays a large vnode and small vnode table for each volume, which lists only orphaned vnodes (vnodes that have no parent). If there are none, the tables are empty (only the headers appear). .IP \fB\-filenames\fR 4 .IX Item "-filenames" When combined with the \fB\-vnode\fR flag, adds the full path and file name of the \&\f(CW\*(C`namei\*(C'\fR file which stores the vnode data to each vnode entry in the large vnode and small vnode tables. This option is only available on fileservers which use the \f(CW\*(C`namei\*(C'\fR storage format for storing data. .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" By default, the command produces several line of statistics for each volume. Adding other options produces or substitutes additional information as described in "OPTIONS". The output is intended for debugging purposes and is meaningful to someone familiar with the internal structure of volume headers. .SH "PRIVILEGE REQUIRED" .IX Header "PRIVILEGE REQUIRED" The issuer must be logged in as the local superuser \f(CW\*(C`root\*(C'\fR. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBvolscan\fR\|(8), \&\fBvldb.DB0\fR\|(5), \&\fBvolserver\fR\|(8) .SH COPYRIGHT .IX Header "COPYRIGHT" IBM Corporation 2000. All Rights Reserved. .PP 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.