Update NEWS for 1.8.0pre3
[pkg-k5-afs_openafs.git] / doc / man-pages / pod1 / symlink.pod
blob2cd86753a37dc3ab7e72e937c4b66ca1591e31f4
1 =head1 NAME
3 symlink - Introduction to the symlink command suite [Windows only]
5 =head1 DESCRIPTION
7 The B<symlink> command creates, lists and removes Unix-style symbolic links
8 (symlinks) in OpenAFS filespace from a platform that does not support
9 symlinks, like Windows.  The L<B<symlink make>|symlink_make(1)> command is
10 equivalent to C<ln -s> on a Unix platform.  B<symlink> can manipulate
11 symlinks created by C<ln -s> on Unix and vice versa.
13 =head1 CAUTIONS
15 The B<symlink> commands are only available on Windows platforms.  On
16 other platforms, use the C<ln -s> command.
18 =head1 OPTIONS
20 =over 4
22 =item B<-help>
24 Prints the online help for this command.  All other valid options are
25 ignored.
27 =back
29 =head1 SEE ALSO
31 L<symlink_list(1)>,
32 L<symlink_make(1)>,
33 L<symlink_remove(1)>
35 =head1 COPYRIGHT
37 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
39 This documentation is covered by the BSD License as written in the
40 doc/LICENSE file. This man page was written by Jason Edgecombe for
41 OpenAFS.