doc/xml/AdminReference/sect1/fs_diskfree.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="fs_diskfree1">
   3   <refmeta>
   4     <refentrytitle>fs diskfree</refentrytitle>
   5     <manvolnum>1</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>fs diskfree</refname>
   9     <refpurpose>Shows data about the partition housing a directory or file</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">fs diskfree</emphasis> [<emphasis role="bold">-path</emphasis> &lt;<emphasis>dir/file path</emphasis>&gt;+] [<emphasis role="bold">-help</emphasis>]</para>
  14
  15     <para><emphasis role="bold">fs df</emphasis> [<emphasis role="bold">-p</emphasis> &lt;<emphasis>dir/file path</emphasis>&gt;+] [<emphasis role="bold">-h</emphasis>]</para>
  16
  17     <para><emphasis role="bold">fs di</emphasis> [<emphasis role="bold">-p</emphasis> &lt;<emphasis>dir/file path</emphasis>&gt;+] [<emphasis role="bold">-h</emphasis>]</para>
  18
  19   </refsect1>
  20   <refsect1>
  21     <title>Description</title>
  22     <para>The <emphasis role="bold">fs diskfree</emphasis> command formats and displays information about the
  23     partition that houses the volume containing the specified directory or
  24     file, including its size and how much space is currently used.</para>
  25
  26     <para>To display information about the volume itself, use the <emphasis role="bold">fs examine</emphasis>
  27     command. The <emphasis role="bold">fs examine</emphasis> and <emphasis role="bold">fs quota</emphasis> commands also display
  28     information about a volume.</para>
  29
  30   </refsect1>
  31   <refsect1>
  32     <title>Cautions</title>
  33     <para>The partition-related statistics in this command's output do not always
  34     agree with the corresponding values in the output of the standard UNIX
  35     <emphasis role="bold">df</emphasis> command. The statistics reported by this command can be up to five
  36     minutes old, because the Cache Manager polls the File Server for partition
  37     information at that frequency. Also, on some operating systems, the <emphasis role="bold">df</emphasis>
  38     command's report of partition size includes reserved space not included in
  39     this command's calculation, and so is likely to be about 10% larger.</para>
  40
  41   </refsect1>
  42   <refsect1>
  43     <title>Options</title>
  44     <variablelist>
  45       <varlistentry>
  46         <term><emphasis role="bold">-path</emphasis> &lt;<emphasis>dir/file path</emphasis>&gt;+</term>
  47         <listitem>
  48           <para>Names a file or directory that resides on the partition about which to
  49           produce output. Partial pathnames are interpreted relative to the current
  50           working directory, which is also the default value if this argument is
  51           omitted.</para>
  52
  53         </listitem>
  54       </varlistentry>
  55       <varlistentry>
  56         <term><emphasis role="bold">-help</emphasis></term>
  57         <listitem>
  58           <para>Prints the online help for this command. All other valid options are
  59           ignored.</para>
  60
  61         </listitem>
  62       </varlistentry>
  63     </variablelist>
  64   </refsect1>
  65   <refsect1>
  66     <title>Output</title>
  67     <para>The output reports the following information about the volume and
  68     partition that houses each file or directory:</para>
  69
  70     <variablelist>
  71       <varlistentry>
  72         <term>Volume Name</term>
  73         <listitem>
  74           <para>The name of the volume.</para>
  75
  76         </listitem>
  77       </varlistentry>
  78       <varlistentry>
  79         <term>kbytes</term>
  80         <listitem>
  81           <para>The partition's total size in kilobytes.</para>
  82
  83         </listitem>
  84       </varlistentry>
  85       <varlistentry>
  86         <term>used</term>
  87         <listitem>
  88           <para>The number of kilobytes used on the partition.</para>
  89
  90         </listitem>
  91       </varlistentry>
  92       <varlistentry>
  93         <term>avail</term>
  94         <listitem>
  95           <para>The number of kilobytes available on the partition.</para>
  96
  97         </listitem>
  98       </varlistentry>
  99       <varlistentry>
 100         <term>%used</term>
 101         <listitem>
 102           <para>The percentage of the partition's total space that is used (the <computeroutput>used</computeroutput>
 103           statistic divided by the <computeroutput>kbytes</computeroutput> statistic, times 100).</para>
 104
 105         </listitem>
 106       </varlistentry>
 107     </variablelist>
 108     <para>If the <computeroutput>%used</computeroutput> statistic is greater than 90%, it is marked with the
 109     string <computeroutput>&lt;&lt;WARNING</computeroutput> at the right margin.</para>
 110
 111     <para>If the volume is a read-only volume, the output includes information about
 112     only one of the partitions that houses it, generally the one on the file
 113     server machine with the lowest preference rank. To verify which machine
 114     the output is referring to, use the <emphasis role="bold">vos listvldb</emphasis> command to list the
 115     volume's locations, and the <emphasis role="bold">vos partinfo</emphasis> command to display the size of
 116     each one.</para>
 117
 118   </refsect1>
 119   <refsect1>
 120     <title>Examples</title>
 121     <para>The following example shows the output for the partitions housing the
 122     volumes <computeroutput>user.smith</computeroutput> and <computeroutput>sun4x_56.bin</computeroutput>:</para>
 123
 124 <programlisting>
 125    % fs diskfree -path /afs/abc.com/usr/smith /afs/abc.com/sun4x_56/bin
 126    Volume Name     kbytes  used     avail     %used
 127    user.smith     4177920 3841258  336662       92% &amp;lt;&amp;lt;WARNING
 128    sun4x_56.bin   4423680 3174500 1249180       72%
 129
 130 </programlisting>
 131     </refsect1>
 132     <refsect1>
 133       <title>Privilege Required</title>
 134       <para>The issuer must have the <computeroutput>l</computeroutput> (lookup) permission on the ACL of the root
 135       directory of the volume that houses the file or directory named by the
 136       <emphasis role="bold">-path</emphasis> argument, and on the ACL of each directory that precedes it in
 137       the pathname.</para>
 138
 139     </refsect1>
 140     <refsect1>
 141       <title>See Also</title>
 142       <para><link linkend="fs_examine1">fs_examine(1)</link></para>
 143
 144     </refsect1>
 145     <refsect1>
 146       <title>Copyright</title>
 147       <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 148
 149       <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 150       converted from HTML to POD by software written by Chas Williams and Russ
 151       Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 152
 153     </refsect1>
 154   </refentry>