doc/man-pages/pod/fs_lsmount.pod

   1 =head1 NAME
   2
   3 fs lsmount - Reports the volume for which a directory is the mount point.
   4
   5 =head1 SYNOPSIS
   6
   7 fs lsmount B<-dir> I<directory> [I<directory> ...]  [B<-help>]
   8
   9 fs ls B<-d> I<directory> [I<directory> ...]  [B<-h>]
  10
  11 =head1 DESCRIPTION
  12
  13 The C<fs lsmount> command reports the volume for which each specified
  14 directory is a mount point, or indicates with an error message that a
  15 directory is not a mount point or is not in AFS.
  16
  17 To create a mount point, use the C<fs mkmount> command. To remove one,
  18 use the C<fs rmmount> command.
  19
  20 =head1 OPTIONS
  21
  22 =over 4
  23
  24 =item B<-dir> I<directory> [I<directory> ...]
  25
  26 Names the directory that serves as a mount point for a volume.
  27 The last element in the pathname provided must be an actual
  28 name, not a shorthand notation such as one or two periods (. or
  29 ..).
  30
  31 =item B<-help>
  32
  33 Prints the online help for this command. All other valid
  34 options are ignored.
  35
  36 =back
  37
  38 =head1 OUTPUT
  39
  40 If the specified directory is a mount point, the output is of the
  41 following form:
  42
  43 'I<directory>' is a mount point for volume 'I<volume name>'
  44
  45 where
  46
  47 =over
  48
  49 =item *
  50
  51 A number sign (#) precedes the I<volume name> string for a regular
  52 mount point.
  53
  54 =item *
  55
  56 A percent sign (%) precedes the I<volume name> string for a
  57 read/write mount point.
  58
  59 =item *
  60
  61 A cell name and colon (:) follow the number or percent sign and
  62 precede the I<volume name> string for a cellular mount point.
  63
  64 =back
  65
  66 The L<fs_mkmount(1)> reference page explains how the Cache Manager
  67 interprets each of the three types of mount points.
  68
  69 If the directory is a symbolic link to a mount point, the output is of
  70 the form:
  71
  72 'I<directory>' is a symbolic link, leading to a mount point for volume 'I<volume
  73 name>'
  74
  75 If the directory is not a mount point or is not in AFS, the output
  76 reads:
  77
  78 'I<directory>' is not a mount point.
  79
  80 If the output is garbled, it is possible that the mount point has
  81 become corrupted in the local AFS client cache. Use the C<fs flushmount>
  82 command to discard it, which forces the Cache Manager to refetch the
  83 mount point.
  84
  85 =head1 EXAMPLES
  86
  87 The following example shows the mount point for the home directory of
  88 user B<smith>:
  89
  90     fs lsmount /afs/abc.com/usr/smith
  91    '/afs/abc.com/usr/smith' is a mount point for volume '#user.smith'
  92
  93 The following example shows both the regular and read/write mount
  94 points for the ABC Corporation cell's C<root.cell> volume.
  95
  96     fs lsmount /afs/abc.com
  97    '/afs/abc.com' is a mount point for volume '#root.cell'
  98
  99     fs lsmount /afs/.abc.com
 100    '/afs/.abc.com' is a mount point for volume '%root.cell'
 101
 102 The following example shows a cellular mount point: the State
 103 University cell's C<root.cell> volume as mounted in the ABC Corporation
 104 cell's tree.
 105
 106     fs lsmount /afs/stateu.edu
 107    '/afs/stateu.edu' is a mount point for volume '#stateu.edu:root.cell'
 108
 109 =head1 PRIVILEGE REQUIRED
 110
 111 The issuer must have the B<l> (B<lookup>) permission on the ACL of the root
 112 directory of the volume that houses the file or directory named by the
 113 B<-dir> argument, and on the ACL of each directory that precedes it in
 114 the pathname.
 115
 116 =head1 COPYRIGHT
 117
 118 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 119
 120 Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
 121 and Elizabeth Cassell <e_a_c@mailsnare.net>, 2004,
 122 Stanford Linear Accelerator Center, a department of Stanford University.
 123
 124 =head1 SEE ALSO
 125
 126 L<fs_flushmount(1)>,
 127 L<fs_mkmount(1)>,
 128 L<fs_rmmount(1)>
 129
 130 =cut