Add man pages for all the symlink commands (Windows-only).
--- /dev/null
+=head1 NAME
+
+symlink - Introduction to the symlink command suite
+
+=head1 DESCRIPTION
+
+The B<symlink> command creates, lists and removes Unix-style symbolic links
+(symlinks) in OpenAFS filespace from a platform that does not support
+symlinks, like Windows. The B<symlink make> command is equivalent to
+C<ln -s> on a Unix platform. B<symlink> can manipulate symlinks created
+by C<ln -s> on Unix and vice versa.
+
+=head1 CAUTIONS
+
+The B<symlink> commands are only available on Windows platforms. On
+other platforms, use the C<ln -s> command.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-help>
+
+Prints the online help for this command. All other valid options are
+ignored.
+
+=back
+
+=head1 SEE ALSO
+
+L<symlink_list(1)>,
+L<symlink_make(1)>,
+L<symlink_remove(1)>
+
+=head1 COPYRIGHT
+
+Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
+
+This documentation is covered by the IBM Public License Version 1.0. This
+man page was written by Jason Edgecombe for OpenAFS.
--- /dev/null
+=head1 NAME
+
+symlink_list - Show the file to which a symlink points
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<symlink list> S<<< [B<-name>] <I<file name>> >>> [B<-help>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<symlink list> command shows if a file is a symbolic link and, if so,
+shows to which file the link points.
+
+=head1 CAUTIONS
+
+The B<symlink> commands are only available on Windows platforms. On other
+platforms, use the B<readlink> command.
+
+=head1 OPTIONS
+
+=over 4
+
+=item [B<-name>] <I<file name>>
+
+Specify one or more symbolic links to list. The C<-name> is optional, but
+the file name is not.
+
+=item B<-help>
+
+Prints the online help for this command. All other valid options are
+ignored.
+
+=back
+
+=head1 OUTPUT
+
+This command prints "'file' is a symlink to 'otherfile'" or "'file' is
+not a symlink."
+
+=head1 EXAMPLES
+
+Given that file C<mylink> is a link pointing to file C<myfile>, the
+following commands will list the files:
+
+ % symlink list -name mylink
+ 'mylink' is a symlink to 'myfile'
+
+ % symlink list mylink
+ 'mylink' is a symlink to 'myfile'
+
+ % symlink list -name myfile
+ 'myfile' is not a symlink.
+
+ % symlink list myfile
+ 'myfile' is not a symlink.
+
+=head1 PRIVILEGE REQUIRED
+
+The issuer must have the C<l> (look) and C<r> (read) permissions on the ACL
+of the directory that houses the symlink.
+
+=head1 SEE ALSO
+
+L<symlink(1)>,
+L<symlink_make(1)>,
+L<symlink_remove(1)>
+
+=head1 COPYRIGHT
+
+Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
+
+This documentation is covered by the IBM Public License Version 1.0. This
+man page was written by Jason Edgecombe for OpenAFS.
--- /dev/null
+=head1 NAME
+
+symlink_make - Create a symbolic link
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<symlink make> S<<< [B<-name>] <I<file name>> >>>
+ S<<< [B<-to>] <I<file name>> >>> [B<-help>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<symlink make> command creates a new symbolic link to a file. The file
+to which the link points does not have to exist when the link is created.
+
+=head1 CAUTIONS
+
+The B<symlink> commands are only available on Windows platforms. On other
+platforms, use the C<ln -s> command.
+
+=head1 OPTIONS
+
+=over 4
+
+=item [B<-name>] <I<file name>>
+
+Specify the name of the new link. B<-name> is optional, but the file name
+is not.
+
+=item [B<-to>] <I<file name>>
+
+Specify the file to which the new link points. B<-to> is optional, but the
+file name is not.
+
+=item B<-help>
+
+Prints the online help for this command. All other valid options are
+ignored.
+
+=back
+
+=head1 OUTPUT
+
+Prints the online help for this command. All other valid options are
+ignored.
+
+=head1 EXAMPLES
+
+In order to create a link named C<mylink> pointing to the file C<myfile>,
+use one of the following commands:
+
+ % symlink make -name mylink -to myfile
+ % symlink make mylink myfile
+
+=head1 PRIVILEGE REQUIRED
+
+The issuer must have the C<l> (look) and C<i> (insert) permissions on the
+ACL of the directory that houses the symlink.
+
+=head1 SEE ALSO
+
+L<symlink(1)>,
+L<symlink_list(1)>,
+L<symlink_remove(1)>
+
+=head1 COPYRIGHT
+
+Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
+
+This documentation is covered by the IBM Public License Version 1.0. This
+man page was written by Jason Edgecombe for OpenAFS.
--- /dev/null
+=head1 NAME
+
+symlink_remove - Remove a symbolic link.
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<symlink remove> S<<< [B<-name>] <I<file name>> >>> [B<-help>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<symlink remove> command removes a symbolic link to a file.
+
+=head1 CAUTIONS
+
+The B<symlink> commands are only available on Windows platforms. On other
+platforms, use the B<rm> command.
+
+=head1 OPTIONS
+
+=over 4
+
+=item [B<-name>] <I<file name>>
+
+Specify one or more symbolic links to remove. The B<-name> is optional, but
+the file name is not.
+
+=item B<-help>
+
+Prints the online help for this command. All other valid options are
+ignored.
+
+=back
+
+=head1 OUTPUT
+
+This command has no output except error and help messages. If the command
+is passed a real file instead of a symlink, it prints "symlink: 'file name'
+is not a symlink" instead of removing the file.
+
+=head1 EXAMPLES
+
+Given that file C<mylink> is a link pointing to file C<myfile>, the
+following commands will remove the link C<mylink>:
+
+ % symlink remove -name mylink
+ % symlink remove mylink
+
+=head1 PRIVILEGE REQUIRED
+
+The issuer must have the C<l> (look) and C<d> (delete) permissions on
+the ACL of the directory that houses the symlink.
+
+=head1 SEE ALSO
+
+L<symlink(1)>,
+L<symlink_list(1)>,
+L<symlink_make(1)>
+
+=head1 COPYRIGHT
+
+Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
+
+This documentation is covered by the IBM Public License Version 1.0. This
+man page was written by Jason Edgecombe for OpenAFS.
git://git.openafs.org / openafs.git / commitdiff