doc/man-pages/pod1/symlink_make.pod

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