ossp-pkg/shtool/sh.mkshadow 1.23 -> 1.24
--- sh.mkshadow 2004/01/01 16:54:20 1.23
+++ sh.mkshadow 2004/02/12 16:06:27 1.24
@@ -1,7 +1,6 @@
##
## mkshadow -- Make a shadow tree through symbolic links
## Copyright (c) 1998-2004 Ralf S. Engelschall <rse@engelschall.com>
-## Originally written for Apache
##
## 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
@@ -139,3 +138,70 @@
ln -s $from $to
done
+shtool_exit 0
+
+##
+## manual page
+##
+
+=pod
+
+=head1 NAME
+
+B<shtool mkshadow> - B<GNU shtool> create shadow tree using symlinks
+
+=head1 SYNOPSIS
+
+B<shtool mkshadow>
+[B<-v>|B<--verbose>]
+[B<-t>|B<--trace>]
+[B<-a>|B<--all>]
+I<src-dir>
+I<dst-dir>
+
+=head1 DESCRIPTION
+
+This command creates a shadow tree of I<src-dir> under I<dst-dir> by
+recreating the directory hierarchy of I<src-dir> under I<dst-dir> and by
+creating the files of I<src-dir> by linking them into the corresponding
+directories under I<dst-dir> via symbolic links. When I<src-dir> can
+be reached via relative paths from I<dst-dir>, relative symbolic links
+are used, too. This high-level functionality is originally designed for
+developers to create copies of source trees.
+
+=head1 OPTIONS
+
+The following command line options are available.
+
+=over 4
+
+=item B<-v>, B<--verbose>
+
+Display some processing information.
+
+=item B<-t>, B<--trace>
+
+Enable the output of the essential shell commands which are executed.
+
+=item B<-a>, B<--all>
+
+Really shadow all files and directories in I<src-dir>. Default is to
+skip CVS related files and directories, backup files, object files, etc.
+
+=head1 EXAMPLE
+
+ # shell script
+ shtool mkshadow -v -a . /tmp/shadow
+
+=head1 HISTORY
+
+The B<GNU shtool> B<mkshadow> command was originally written by Ralf S.
+Engelschall E<lt>rse@engelschall.comE<gt> in 1998 for B<Apache>. It was
+later revised and taken over into B<GNU shtool>.
+
+=head1 SEE ALSO
+
+shtool(1), ln(1).
+
+=cut
+
|
|
