From 832e6f8b317553ebd764789470e7ea23bf07353b Mon Sep 17 00:00:00 2001 From: Jason Edgecombe Date: Thu, 29 Nov 2007 05:56:02 +0000 Subject: [PATCH] STABLE14-man-page-symlink-20071128 Add man pages for all the symlink commands (Windows-only). (cherry picked from commit 1ee37a57d3d343b8d7a1ab26b6783d396624c856) --- doc/man-pages/pod1/symlink.pod | 40 ++++++++++++++ doc/man-pages/pod1/symlink_list.pod | 79 +++++++++++++++++++++++++++ doc/man-pages/pod1/symlink_make.pod | 76 ++++++++++++++++++++++++++ doc/man-pages/pod1/symlink_remove.pod | 70 ++++++++++++++++++++++++ 4 files changed, 265 insertions(+) create mode 100644 doc/man-pages/pod1/symlink.pod create mode 100644 doc/man-pages/pod1/symlink_list.pod create mode 100644 doc/man-pages/pod1/symlink_make.pod create mode 100644 doc/man-pages/pod1/symlink_remove.pod diff --git a/doc/man-pages/pod1/symlink.pod b/doc/man-pages/pod1/symlink.pod new file mode 100644 index 000000000..04f8681c4 --- /dev/null +++ b/doc/man-pages/pod1/symlink.pod @@ -0,0 +1,40 @@ +=head1 NAME + +symlink - Introduction to the symlink command suite + +=head1 DESCRIPTION + +The B 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 command is equivalent to +C on a Unix platform. B can manipulate symlinks created +by C on Unix and vice versa. + +=head1 CAUTIONS + +The B commands are only available on Windows platforms. On +other platforms, use the C 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, +L, +L + +=head1 COPYRIGHT + +Copyright 2007 Jason Edgecombe + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Jason Edgecombe for OpenAFS. diff --git a/doc/man-pages/pod1/symlink_list.pod b/doc/man-pages/pod1/symlink_list.pod new file mode 100644 index 000000000..a56629d7b --- /dev/null +++ b/doc/man-pages/pod1/symlink_list.pod @@ -0,0 +1,79 @@ +=head1 NAME + +symlink_list - Show the file to which a symlink points + +=head1 SYNOPSIS + +=for html +
+ +B S<<< [B<-name>] > >>> [B<-help>] + +=for html +
+ +=head1 DESCRIPTION + +The B command shows if a file is a symbolic link and, if so, +shows to which file the link points. + +=head1 CAUTIONS + +The B commands are only available on Windows platforms. On other +platforms, use the B command. + +=head1 OPTIONS + +=over 4 + +=item [B<-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 is a link pointing to file C, 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 (look) and C (read) permissions on the ACL +of the directory that houses the symlink. + +=head1 SEE ALSO + +L, +L, +L + +=head1 COPYRIGHT + +Copyright 2007 Jason Edgecombe + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Jason Edgecombe for OpenAFS. diff --git a/doc/man-pages/pod1/symlink_make.pod b/doc/man-pages/pod1/symlink_make.pod new file mode 100644 index 000000000..d9d57336a --- /dev/null +++ b/doc/man-pages/pod1/symlink_make.pod @@ -0,0 +1,76 @@ +=head1 NAME + +symlink_make - Create a symbolic link + +=head1 SYNOPSIS + +=for html +
+ +B S<<< [B<-name>] > >>> + S<<< [B<-to>] > >>> [B<-help>] + +=for html +
+ +=head1 DESCRIPTION + +The B 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 commands are only available on Windows platforms. On other +platforms, use the C command. + +=head1 OPTIONS + +=over 4 + +=item [B<-name>] > + +Specify the name of the new link. B<-name> is optional, but the file name +is not. + +=item [B<-to>] > + +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 pointing to the file C, +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 (look) and C (insert) permissions on the +ACL of the directory that houses the symlink. + +=head1 SEE ALSO + +L, +L, +L + +=head1 COPYRIGHT + +Copyright 2007 Jason Edgecombe + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Jason Edgecombe for OpenAFS. diff --git a/doc/man-pages/pod1/symlink_remove.pod b/doc/man-pages/pod1/symlink_remove.pod new file mode 100644 index 000000000..917b317ea --- /dev/null +++ b/doc/man-pages/pod1/symlink_remove.pod @@ -0,0 +1,70 @@ +=head1 NAME + +symlink_remove - Remove a symbolic link. + +=head1 SYNOPSIS + +=for html +
+ +B S<<< [B<-name>] > >>> [B<-help>] + +=for html +
+ +=head1 DESCRIPTION + +The B command removes a symbolic link to a file. + +=head1 CAUTIONS + +The B commands are only available on Windows platforms. On other +platforms, use the B command. + +=head1 OPTIONS + +=over 4 + +=item [B<-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 is a link pointing to file C, the +following commands will remove the link C: + + % symlink remove -name mylink + % symlink remove mylink + +=head1 PRIVILEGE REQUIRED + +The issuer must have the C (look) and C (delete) permissions on +the ACL of the directory that houses the symlink. + +=head1 SEE ALSO + +L, +L, +L + +=head1 COPYRIGHT + +Copyright 2007 Jason Edgecombe + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Jason Edgecombe for OpenAFS. -- 2.39.5