--- sh.tarball 2004/01/01 16:54:20 1.20
+++ sh.tarball 2004/02/12 16:06:27 1.21
@@ -1,7 +1,6 @@
##
## tarball -- Roll distribution tarballs
## Copyright (c) 1999-2004 Ralf S. Engelschall <rse@engelschall.com>
-## Originally written for shtool
##
## 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
@@ -191,3 +190,96 @@
fi
rm -f $tmpfile.lst $tmpfile.out
+shtool_exit 0
+
+##
+## manual page
+##
+
+=pod
+
+=head1 NAME
+
+B<shtool tarball> - B<GNU shtool> command for rolling standardized tarballs
+
+=head1 SYNOPSIS
+
+B<shtool tarball>
+[B<-t>|B<--trace>]
+[B<-v>|B<--verbose>]
+[B<-o>|B<--output> I<tarball>]
+[B<-c>|B<--compress> I<prog>]
+[B<-u>|B<--user> I<user>]
+[B<-g>|B<--group> I<group>]
+[B<-e>|B<--exclude> I<pattern>]
+I<path> [I<path> ...]
+
+=head1 DESCRIPTION
+
+This command is for rolling input files under I<path> into a
+distribution tarballs which can be extracted by tar(1).
+
+The four important aspects of good open source software tarballs are:
+(1) unpack into a single top-level directory, (2) top-level directory
+corresponds to the tarball filename, (3) tarball should be sorted and
+(4) arbitrary names for file owner and group.
+
+=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<-o>, B<--output> I<tarball>
+
+Output tarball to file I<tarball>.
+
+=item B<-c>, B<--compress> I<prog>
+
+Pipe resulting tarball through compression program I<prog>.
+
+=item B<-u>, B<--user> I<user>
+
+The user (owner) of files and directories in the tarball to I<user>.
+
+=item B<-g>, B<--group> I<group>
+
+The group of files and directories in the tarball to I<group>.
+
+=item B<-e>, B<--exclude> I<pattern>
+
+Exclude files and directories matching comma-separated list of
+regex I<pattern> from the tarball. Directories are expanded
+before the filtering takes place. The default filter pattern is
+"C<CVS,\\.cvsignore,\\.[oa]\$>".
+
+=back
+
+=head1 EXAMPLE
+
+ # Makefile.in
+ dist:
+ ...
+ V=`shtool version -d short ...`; \
+ shtool tarball -o foobar-$$V.tar.gz -c 'gzip -9' \
+ -u bar -g gnu -e 'CVS,\.cvsignore' .
+
+=head1 HISTORY
+
+The B<GNU shtool> B<tarball> command was originally written by Ralf S.
+Engelschall E<lt>rse@engelschall.comE<gt> in 1999 for B<GNU shtool>.
+
+=head1 SEE ALSO
+
+shtool(1), tar(1), compress(1).
+
+=cut
+
|
