ossp-pkg/shtool/sh.mkln 1.17 -> 1.18
--- sh.mkln 2004/01/01 16:54:20 1.17
+++ sh.mkln 2004/02/12 16:06:27 1.18
@@ -1,7 +1,6 @@
##
## mkln -- Make link with calculation of relative paths
-## Copyright (c) 1999-2004 Ralf S. Engelschall <rse@engelschall.com>
-## Originally written for shtool
+## Copyright (c) 1998-2004 Ralf S. Engelschall <rse@engelschall.com>
##
## This file is part of shtool and free software; you can redistribute
## it and/or modify it under the terms of the GNU General Public
@@ -172,3 +171,70 @@
eval ln$lnopt $srcpre$srcdir$srcbase $dstpre$dstdir$dstbase
done
+shtool_exit 0
+
+##
+## manual page
+##
+
+=pod
+
+=head1 NAME
+
+B<shtool mkln> - B<GNU shtool> enhanced ln(1) replacement
+
+=head1 SYNOPSIS
+
+B<shtool mkln>
+[B<-t>|B<--trace>]
+[B<-f>|B<--force>]
+[B<-s>|B<--symbolic>]
+I<src-path> [I<src-path> ...]
+I<dst-path>
+
+=head1 DESCRIPTION
+
+This is a ln(1) style command. It is enhanced to provide automatic
+calculation and usage of relative links with the shortest possible path,
+if possible. Usually if I<src-path> and I<dst-path> are not absolute
+paths or at least they share a common prefix except the root directory
+(``C</>''). When more than one I<src-path> is specified, all of them are
+linked into I<dst-path>.
+
+=head1 OPTIONS
+
+The following command line options are available.
+
+=over 4
+
+=item B<-t>, B<--trace>
+
+Enable the output of the essential shell commands which are executed.
+
+=item B<-f>, B<--force>
+
+Force the creation of the link even if it exists. Default is to fail
+with error.
+
+=item B<-s>, B<--symbolic>
+
+Create a symbolic link instead of a hard-link.
+
+=back
+
+=head1 EXAMPLE
+
+ # shell script
+ shtool mkln -s foo/bar baz/quux
+
+=head1 HISTORY
+
+The B<GNU shtool> B<fixperm> command was originally written by Ralf S.
+Engelschall E<lt>rse@engelschall.comE<gt> in 1998 for I<ePerl>.
+
+=head1 SEE ALSO
+
+shtool(1), ln(1).
+
+=cut
+
|
|
