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

NAME

6       GNU shtool - The GNU Portable Shell Tool
7

VERSION

9       GNU shtool 2.0.8 (18-Jul-2008)
10

SYNOPSIS

12       shtool [ global_options ] command [ command_options ] [ command_args ]
13

DESCRIPTION

15       GNU shtool is a compilation of small but very stable and portable shell
16       scripts into a single shell tool. All ingredients were in successful
17       use over many years in various free software projects. The compiled
18       shtool script is intended to be used inside the source tree of those
19       free software packages.  There it can take over various (usually non-
20       portable) tasks related to the building and installation of such
21       packages.
22

GLOBAL OPTIONS

24       The following global options are available for shtool. Any commands are
25       ignored if one of them is present on the shtool command line.
26
27       -h, --help
28           Displays a short help page describing the usage of shtool and it's
29           ingredient commands in a compact way.
30
31       -v, --version
32           Displays the version number of shtool.
33
34       -d, --debug
35           Displays shell trace messages for debugging purposes.
36
37       -r, --recreate
38           Recreate the shtool script with its own individual shtoolize(1)
39           call.
40

COMMANDS

42       The following commands are provided by shtool. They are all called via
43       ""shtool" command". Any command options command_opts and arguments
44       command_args are specific to the particular command and are described
45       in the corresponding manual page shtool_command(1).  The commands are
46       listed here sorted by topic, i.e., related commands are listed side-by-
47       side.
48
49       echo            echo(1) style print command providing special expansion
50                       constructs (terminal bold mode, environment details,
51                       date) and newline control.
52
53       mdate           Pretty-printing of the last modification time of a file
54                       or directory.
55
56       table           Pretty-printing a field-separated list as a two-
57                       dimensional table.
58
59       prop            Displaying of a processing indication though a running
60                       terminal character propeller.
61
62       move            mv(1) style command for renaming/moving multiple files
63                       at once and allowing source files just to be deleted if
64                       contents did not change.
65
66       install         install(1) style command for installing a program,
67                       script or data file in a portable way.
68
69       mkdir           mkdir(1) style command providing support for
70                       automatical parent directory creation, directory
71                       permission control and smart skipping if directory
72                       already exists.
73
74       mkln            ln(1) style command providing automatic calculation and
75                       usage of relative links if possible.
76
77       mkshadow        Creation of a shadow filesystem tree by the help of
78                       symbolic links.
79
80       fixperm         Fixing of file permissions in a source tree by cleaning
81                       up the permission bits.
82
83       rotate          Rotate a logfile.
84
85       tarball         Roll standardized distribution tarballs.
86
87       subst           Apply sed(1) substitution operations.
88
89       platform        Determines platform identification information.
90
91       arx             Extended archive command which can even put existing
92                       archives into an archive.
93
94       slo             Separate linker options by library class.
95
96       scpp            An additional C source file pre-processor for sharing
97                       cpp(1) code, internal variables and internal functions.
98
99       version         Maintain a version information file in either Text,
100                       C/C++, Perl or Python.  format.
101
102       path            Deal with shell path variables.
103

SEE ALSO

105       shtoolize(1), shtool-arx(1), shtool-echo(1), shtool-fixperm(1),
106       shtool-install(1), shtool-mdate(1), shtool-mkdir(1), shtool-mkln(1),
107       shtool-mkshadow(1), shtool-move(1), shtool-path(1), shtool-platform(1),
108       shtool-prop(1), shtool-rotate(1), shtool-scpp(1), shtool-slo(1),
109       shtool-subst(1), shtool-table(1), shtool-tarball(1), shtool-version(1).
110

HISTORY

112       Some scripts contained in GNU shtool were already written in 1994 by
113       Ralf S. Engelschall for use inside some private source trees. Then they
114       evolved into more elaborated versions over the years and were used in
115       various free software projects like ePerl, WML, iSelect, gFONT, etc.
116       They were complemented with other scripts from the author which he
117       wrote in March 1998 for the ``Apache Autoconf-style Interface'' (APACI)
118       for Apache 1.3. In April 1999 the shtool package was created out of the
119       accumulated master versions of the scripts and in June 1999 it entered
120       the status of an official GNU program and this way finally joined the
121       group of GNU autoconf, GNU automake and GNU libtool.
122

AUTHOR

124        Ralf S. Engelschall
125        rse@engelschall.com
126        www.engelschall.com
127
128
129
13018-Jul-2008                      shtool 2.0.8                    SHTOOL.TMP(1)
Impressum