doc/man-pages/pod1/symlink_list.pod

   1 =head1 NAME
   2
   3 symlink_list - Show the file to which a symlink points
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<symlink list> S<<< [B<-name>] <I<file name>> >>> [B<-help>]
  11
  12 =for html
  13 </div>
  14
  15 =head1 DESCRIPTION
  16
  17 The B<symlink list> command shows if a file is a symbolic link and, if so,
  18 shows to which file the link points.
  19
  20 =head1 CAUTIONS
  21
  22 The B<symlink> commands are only available on Windows platforms.  On other
  23 platforms, use the B<readlink> command.
  24
  25 =head1 OPTIONS
  26
  27 =over 4
  28
  29 =item [B<-name>] <I<file name>>
  30
  31 Specify one or more symbolic links to list.  The C<-name> is optional, but
  32 the file name is not.
  33
  34 =item B<-help>
  35
  36 Prints the online help for this command.  All other valid options are
  37 ignored.
  38
  39 =back
  40
  41 =head1 OUTPUT
  42
  43 This command prints "'file' is a symlink to 'otherfile'" or "'file' is
  44 not a symlink."
  45
  46 =head1 EXAMPLES
  47
  48 Given that file C<mylink> is a link pointing to file C<myfile>, the
  49 following commands will list the files:
  50
  51    % symlink list -name mylink
  52    'mylink' is a symlink to 'myfile'
  53
  54    % symlink list mylink
  55    'mylink' is a symlink to 'myfile'
  56
  57    % symlink list -name myfile
  58    'myfile' is not a symlink.
  59
  60    % symlink list myfile
  61    'myfile' is not a symlink.
  62
  63 =head1 PRIVILEGE REQUIRED
  64
  65 The issuer must have the C<l> (look) and C<r> (read) permissions on the ACL
  66 of the directory that houses the symlink.
  67
  68 =head1 SEE ALSO
  69
  70 L<symlink(1)>,
  71 L<symlink_make(1)>,
  72 L<symlink_remove(1)>
  73
  74 =head1 COPYRIGHT
  75
  76 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
  77
  78 This documentation is covered by the IBM Public License Version 1.0. This
  79 man page was written by Jason Edgecombe for OpenAFS.