1SHTOOL-TARBALL.TMP(1)       GNU Portable Shell Tool      SHTOOL-TARBALL.TMP(1)
2
3
4

NAME

6       shtool tarball - GNU shtool command for rolling standardized tarballs
7

SYNOPSIS

9       shtool tarball [-t|--trace] [-v|--verbose] [-o|--output tarball]
10       [-c|--compress prog] [-d|--directory directory] [-u|--user user]
11       [-g|--group group] [-e|--exclude pattern] path [path ...]
12

DESCRIPTION

14       This command is for rolling input files under path into a distribution
15       tarballs which can be extracted by tar(1).
16
17       The four important aspects of good open source software tarballs are:
18       (1) unpack into a single top-level directory, (2) top-level directory
19       corresponds to the tarball filename, (3) tarball files should be sorted
20       and (4) arbitrary names for file owner and group.
21

OPTIONS

23       The following command line options are available.
24
25       -v, --verbose
26           Display some processing information.
27
28       -t, --trace
29           Enable the output of the essential shell commands which are
30           executed.
31
32       -o, --output tarball
33           Output tarball to file tarball.
34
35       -c, --compress prog
36           Pipe resulting tarball through compression program prog.
37
38       -d, --directory directory
39           Sets the top-level directory into which the tarball unpacks.  By
40           default it is tarball without the trailing ".tar.*" extension.
41
42       -u, --user user
43           The user (owner) of files and directories in the tarball to user.
44
45       -g, --group group
46           The group of files and directories in the tarball to group.
47
48       -e, --exclude pattern
49           Exclude files and directories matching comma-separated list of
50           regex pattern from the tarball. Directories are expanded before the
51           filtering takes place. The default filter pattern is
52           ""CVS,\\.cvsignore,\\.svn,\\.[oa]\$"".
53

EXAMPLE

55        #   Makefile.in
56        dist:
57            ...
58            V=`shtool version -d short ...`; \
59            shtool tarball -o foobar-$$V.tar.gz -c 'gzip -9' \
60                           -u bar -g gnu -e 'CVS,\.cvsignore' .
61

HISTORY

63       The GNU shtool tarball command was originally written by Ralf S.
64       Engelschall <rse@engelschall.com> in 1999 for GNU shtool.
65

SEE ALSO

67       shtool(1), tar(1), compress(1).
68
69
70
7118-Jul-2008                      shtool 2.0.8            SHTOOL-TARBALL.TMP(1)
Impressum