4734061aabf1eabfb0322483b308484453e9cfb4
[openafs.git] / src / man / fs_examine.1
1 fs examine                 AFS Commands              fs examine
2
3
4 NAME
5
6    fs  examine -- show  information  about  volume  containing
7
8                        specified directory.
9
10
11                                      +
12    fs examine  [-path <dir/file path> ]  [-help]
13
14 ACCEPTABLE ABBREVIATIONS/ALIASES
15
16                               +
17    fs exa  [-p <dir/file path> ]  [-h]
18                                   +
19    fs listvol  [-p <dir/file path> ]  [-h]
20                              +
21    fs lv  [-p <dir/file path> ]  [-h]
22
23 DESCRIPTION
24
25    Displays  information  about  the  volume  containing   each
26    specified  directory  or file.  The information includes the
27    file's quota and current size.  See the OUTPUT section for a
28    complete  explanation  of  the  information provided.  While
29    this command provides the most information about  a  volume,
30    the fs listquota and fs quota commands are also available to
31    display information about a volume.
32
33 ARGUMENTS
34
35    -path specifies  each  file  and/or  directory   for   which
36          information  about  the  host volume is desired.  Omit
37          this switch to display information  about  the  volume
38          that contains the current working directory.
39
40    -help prints the online help entry for this command.  Do not
41          provide any other arguments or flags  with  this  one.
42          See  section  3.1  in  the  Reference  Manual for more
43          details.
44
45 OUTPUT
46
47    Note: The partition-related  numbers  that  appear  in  this
48    output  may  not always agree with the corresponding numbers
49    in the output of the standard UNIX df  command.    The  main
50    reason   is  that  the  df  output  reflects  the  state  of
51    partitions exactly when the command is issued.  The  numbers
52    in  this command's output may be up to 5 minutes old, as the
53    Cache  Manager  polls  the   File   Server   for   partition
54    information   at   that   frequency.      Another  potential
55    difference: the partition  size  reported  by  the  UNIX  df
56    command  includes  some reserved space that does not show up
57    in this report of partition size, and so  is  likely  to  be
58    about 10% larger.
59
60
61
62    The  output  reports  the  following  information about each
63    volume that contains a specified directory or file:
64
65       - the volumeID number (abbreviated in the output  as
66         "vid") of the volume
67
68       - the volume's name
69
70       - the  current "offline" message associated with the
71         volume, as set by a system administrator using the
72         fs setvol command
73
74       - the  current  "message of the day" associated with
75         the volume, as set by a system administrator using
76         the fs setvol command
77
78       - the  volume's  maximum  size  quota,  in  kilobyte
79         blocks
80
81       - its current size, in kilobyte blocks
82
83       - the number of kilobyte blocks still  available  on
84         the  disk partition that houses the volume and the
85         partition's total size
86
87 EXAMPLES
88
89    The following shows the output  for  the  volume  user.smith
90    (and  the  partition housing it) in the Transarc Corporation
91    cell:
92
93        % fs exa /afs/transarc.com/usr/smith
94        Volume status for vid = 50489902 named user.smith
95        Current maximum quota is 15000
96        Current blocks used are 5073
97        The partition has 46383 blocks available out of 333305
98
99 PRIVILEGE REQUIRED
100
101    None.
102
103 MORE INFORMATION
104
105    fs listquota
106
107    fs quota
108
109    fs setquota