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