HCoop / hcoop / debian / openafs.git / blame
| Commit | Line | Data |
|---|---|---|
| 805e021f CE |
1 | =head1 NAME |
| 2 | ||
| 3 | symlink_remove - Remove a symbolic link [Windows only] | |
| 4 | ||
| 5 | =head1 SYNOPSIS | |
| 6 | ||
| 7 | =for html | |
| 8 | <div class="synopsis"> | |
| 9 | ||
| 10 | B<symlink remove> S<<< [B<-name>] <I<file name>> >>> [B<-help>] | |
| 11 | ||
| 12 | =for html | |
| 13 | </div> | |
| 14 | ||
| 15 | =head1 DESCRIPTION | |
| 16 | ||
| 17 | The B<symlink remove> command removes a symbolic link to a file. | |
| 18 | ||
| 19 | =head1 CAUTIONS | |
| 20 | ||
| 21 | The B<symlink> commands are only available on Windows platforms. On other | |
| 22 | platforms, use the B<rm> command. | |
| 23 | ||
| 24 | =head1 OPTIONS | |
| 25 | ||
| 26 | =over 4 | |
| 27 | ||
| 28 | =item [B<-name>] <I<file name>> | |
| 29 | ||
| 30 | Specify one or more symbolic links to remove. The B<-name> is optional, but | |
| 31 | the file name is not. | |
| 32 | ||
| 33 | =item B<-help> | |
| 34 | ||
| 35 | Prints the online help for this command. All other valid options are | |
| 36 | ignored. | |
| 37 | ||
| 38 | =back | |
| 39 | ||
| 40 | =head1 OUTPUT | |
| 41 | ||
| 42 | This command has no output except error and help messages. If the command | |
| 43 | is passed a real file instead of a symlink, it prints "symlink: 'file name' | |
| 44 | is not a symlink" instead of removing the file. | |
| 45 | ||
| 46 | =head1 EXAMPLES | |
| 47 | ||
| 48 | Given that file C<mylink> is a link pointing to file C<myfile>, the | |
| 49 | following commands will remove the link C<mylink>: | |
| 50 | ||
| 51 | % symlink remove -name mylink | |
| 52 | % symlink remove mylink | |
| 53 | ||
| 54 | =head1 PRIVILEGE REQUIRED | |
| 55 | ||
| 56 | The issuer must have the C<l> (look) and C<d> (delete) permissions on | |
| 57 | the ACL of the directory that houses the symlink. | |
| 58 | ||
| 59 | =head1 SEE ALSO | |
| 60 | ||
| 61 | L<symlink(1)>, | |
| 62 | L<symlink_list(1)>, | |
| 63 | L<symlink_make(1)> | |
| 64 | ||
| 65 | =head1 COPYRIGHT | |
| 66 | ||
| 67 | Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com> | |
| 68 | ||
| 69 | This documentation is covered by the BSD License as written in the | |
| 70 | doc/LICENSE file. This man page was written by Jason Edgecombe for | |
| 71 | OpenAFS. |