manpages-fs-chown-chgrp-20090701
[openafs.git] / doc / man-pages / pod1 / symlink.pod
1 =head1 NAME
2
3 symlink - Introduction to the symlink command suite [Windows only]
4
5 =head1 DESCRIPTION
6
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 B<symlink make> command is equivalent to
10 C<ln -s> on a Unix platform.  B<symlink> can manipulate symlinks created
11 by C<ln -s> on Unix and vice versa.
12
13 =head1 CAUTIONS
14
15 The B<symlink> commands are only available on Windows platforms.  On
16 other platforms, use the C<ln -s> command.
17
18 =head1 OPTIONS
19
20 =over 4
21
22 =item B<-help>
23
24 Prints the online help for this command.  All other valid options are
25 ignored.
26
27 =back
28
29 =head1 SEE ALSO
30
31 L<symlink_list(1)>,
32 L<symlink_make(1)>,
33 L<symlink_remove(1)>
34
35 =head1 COPYRIGHT
36
37 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
38
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.