fix-fs-error-string-printing-20010623
[openafs.git] / doc / html / AdminReference / auarf138.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
2 <HTML><HEAD>
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records  ========================================== -->
5 <!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
6 <!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
7 <META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
8 <META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
9 <META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
10 </HEAD><BODY>
11 <!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
12 <BODY bgcolor="ffffff"> 
13 <!-- End Header Records  ============================================ -->
14 <A NAME="Top_Of_Page"></A>
15 <H1>Administration Reference</H1>
16 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf137.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf139.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
17 <P>
18 <H2><A NAME="HDRFS_EXAMINE" HREF="auarf002.htm#ToC_152">fs examine</A></H2>
19 <A NAME="IDX4772"></A>
20 <A NAME="IDX4773"></A>
21 <A NAME="IDX4774"></A>
22 <A NAME="IDX4775"></A>
23 <A NAME="IDX4776"></A>
24 <A NAME="IDX4777"></A>
25 <A NAME="IDX4778"></A>
26 <A NAME="IDX4779"></A>
27 <A NAME="IDX4780"></A>
28 <A NAME="IDX4781"></A>
29 <A NAME="IDX4782"></A>
30 <A NAME="IDX4783"></A>
31 <A NAME="IDX4784"></A>
32 <A NAME="IDX4785"></A>
33 <A NAME="IDX4786"></A>
34 <A NAME="IDX4787"></A>
35 <A NAME="IDX4788"></A>
36 <A NAME="IDX4789"></A>
37 <A NAME="IDX4790"></A>
38 <A NAME="IDX4791"></A>
39 <A NAME="IDX4792"></A>
40 <A NAME="IDX4793"></A>
41 <A NAME="IDX4794"></A>
42 <A NAME="IDX4795"></A>
43 <P><STRONG>Purpose</STRONG>
44 <P>Displays information about the volume containing a directory or file
45 <P><STRONG>Synopsis</STRONG>
46 <PRE><B>fs examine</B> [<B>-path</B> &lt;<VAR>dir/file&nbsp;path</VAR>><SUP>+</SUP>]  [<B>-help</B>]
47    
48 <B>fs exa</B> [<B>-p</B> &lt;<VAR>dir/file&nbsp;path</VAR>><SUP>+</SUP>]  [<B>-h</B>] 
49          
50 <B>fs listvol</B> [<B>-p</B> &lt;<VAR>dir/file&nbsp;path</VAR>><SUP>+</SUP>]  [<B>-h</B>] 
51      
52 <B>fs listv</B> [<B>-p</B> &lt;<VAR>dir/file&nbsp;path</VAR>><SUP>+</SUP>]  [<B>-h</B>] 
53         
54 <B>fs lv</B> [<B>-p</B> &lt;<VAR>dir/file&nbsp;path</VAR>><SUP>+</SUP>]  [<B>-h</B>]
55 </PRE>
56 <P><STRONG>Description</STRONG>
57 <P>The <B>fs examine</B> command displays information about the volume
58 containing each specified directory or file, including its volume ID number,
59 quota and the percentage of its quota that is used.
60 <P>This command provides the most information about a volume, but the <B>fs
61 listquota</B> command displays similar information in tabular format, and
62 the <B>fs quota</B> command reports only the percentage of quota
63 used.
64 <P>To set volume quota, use the <B>fs setquota</B> or <B>fs setvol</B>
65 command.
66 <P><STRONG>Cautions</STRONG>
67 <P>The partition-related statistics in this command's output do not
68 always agree with the corresponding values in the output of the standard UNIX
69 <B>df</B> command. The statistics reported by this command can be
70 up to five minutes old, because the Cache Manager polls the File Server for
71 partition information at that frequency. Also, on some operating
72 systems, the <B>df</B> command's report of partition size includes
73 reserved space not included in this command's calculation, and so is
74 likely to be about 10% larger.
75 <P><STRONG>Options</STRONG>
76 <DL>
77 <P><DT><B>-path
78 </B><DD>Names a file or directory that resides in the volume about which to
79 produce output. Partial pathnames are interpreted relative to the
80 current working directory, which is also the default value if this argument is
81 omitted.
82 <P><DT><B>-help
83 </B><DD>Prints the online help for this command. All other valid options
84 are ignored.
85 </DL>
86 <P><STRONG>Output</STRONG>
87 <P>The output displays information about the volume that houses each specified
88 directory or file, in the following format
89 <PRE>   Volume status for vid = <VAR>volume ID</VAR> named <VAR>volume name</VAR>
90    Current offline message is <VAR>message</VAR>
91    Current disk quota is <VAR>quota in kilobytes</VAR>
92    Current blocks used are <VAR>volume size in kilobytes</VAR>
93    The partition has <VAR>available partition</VAR> blocks available out of
94       <VAR>partition size</VAR>
95    
96 </PRE>
97 <P>where the first line specifies the volume's ID number and name.
98 The <TT>Current</TT> <TT>offline</TT> <TT>message</TT> line appears only
99 if an administrator has included the <B>-offlinemsg</B> argument to the
100 <B>fs setvol</B> command. The remaining lines report, respectively,
101 <UL>
102 <P><LI>the volume's quota in kilobytes, or the string <TT>unlimited</TT>
103 to indicate an unlimited quota
104 <P><LI>the volume's current size in kilobytes
105 <P><LI>the number of blocks available and total size of the host partition, both
106 in kilobytes.
107 </UL>
108 <P><STRONG>Examples</STRONG>
109 <P>The following example shows the output for the volume
110 <B>user.smith</B> and the partition housing it:
111 <PRE>   % <B>fs examine -path /afs/abc.com/usr/smith</B>
112    Volume status for vid = 50489902 named user.smith
113    Current maximum quota is 15000
114    Current blocks used are 5073
115    The partition has 336662 blocks available out of 4177920 
116    
117 </PRE>
118 <P><STRONG>Privilege Required</STRONG>
119 <P>The issuer must have the <B>l</B> (<B>lookup</B>) permission on the
120 ACL of the root directory of the volume that houses the file or directory
121 named by the <B>-path</B> argument, and on the ACL of each directory that
122 precedes it in the pathname.
123 <P><STRONG>Related Information</STRONG>
124 <P><A HREF="auarf150.htm#HDRFS_LISTQUOTA">fs listquota</A>
125 <P><A HREF="auarf155.htm#HDRFS_QUOTA">fs quota</A>
126 <P><A HREF="auarf161.htm#HDRFS_SETQUOTA">fs setquota</A>
127 <P><A HREF="auarf163.htm#HDRFS_SETVOL">fs setvol</A>
128 <P>
129 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf137.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf139.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
130 <!-- Begin Footer Records  ========================================== -->
131 <P><HR><B> 
132 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
133 </B> 
134 <!-- End Footer Records  ============================================ -->
135 <A NAME="Bot_Of_Page"></A>
136 </BODY></HTML>