correct whitespace errors in readme files
[openafs.git] / src / vol / test / README
1 Copyright 2000, International Business Machines Corporation and others.
2 All Rights Reserved.
3
4 This software has been released under the terms of the IBM Public
5 License.  For details, see the LICENSE file in the top-level source
6 directory or online at http://www.openafs.org/dl/license10.html
7
8 /* Tool for listing /vicepX partition
9 **
10 */
11 listVicepx -p < partitionName> -v <volumeName>
12               [-ls | -lsl | -ld | -dir <directoryInode> ]
13
14 Without any input options, it prints out the names of symlinks and
15 directory names where any of its file is mounted.
16
17 With the -ls option, it prints out the names of all file/symlinks
18 inside the volume.
19
20 With the -lsl option, it prints out metadata about all file/symlink.
21 This metadata includes the inode number(Ind), UNIX mode bits(Mod),
22 link count(Lnk), the owner(Own), the group(Grp) and the file size(Siz).
23
24 With the -ld option, it prints out metadata about all directories
25 in this volume. This metadata includes the directory inode(Ind) and
26 the directory vnode(Vnd) along with the directory name. The root
27 directory of the volume is indicated as ~.
28
29 With the -dir <directory inode> option, this tool prints out the
30 contents of this directory. The inode number has to be a directory inode.
31
32 COMPILATION:
33 mkdir  objvol/test
34 cd obj/vol/test
35 ln -s ../SRC/test SRC
36 ln -s ../DEST DEST
37 make install
38
39 The executable name is listVicepx.
40