--- shtool.pod 2001/06/14 19:30:39 1.54
+++ shtool.pod 2001/09/23 10:58:10 1.55
@@ -290,7 +290,7 @@
=over 4
-=item B<echo> [B<-n>] [B<-e>] I<str>
+=item B<echo> [B<-n>|B<--newline>] [B<-e>|B<--expand>] I<str>
This is an echo(1) style print command which provides special expansion
constructs (terminal bold mode, environment details, date) and newline
@@ -320,7 +320,7 @@
shtool echo -e "Your Email address might be %u@%h%d"
shtool echo -e "The current date is %D-%m-%Y"
-=item B<mdate> [B<-n>] [B<-z>] [B<-s>] [B<-d>] [B<-f> I<str>] [B<-o> I<spec>] I<path>
+=item B<mdate> [B<-n>|B<--newline>] [B<-z>|B<--zero>] [B<-s>|B<--shorten>] [B<-d>|B<--digits>] [B<-f>|B<--field-sep> I<str>] [B<-o>|B<--order> I<spec>] I<path>
This command pretty-prints the last modification time of a file or directory
I<path>. Option ``B<-n>'' suppresses the output of a trailing newline
@@ -346,7 +346,7 @@
shtool mdate -f '/' -z -d -o ymd foo.txt
shtool mdate -f '-' -s foo.txt
-=item B<table> [B<-F> I<sep>] [B<-w> I<width>] [B<-c> I<cols>] [B<-s> I<strip>] I<str>B<sep>I<str>...
+=item B<table> [B<-F>|B<--field-sep> I<sep>] [B<-w>|B<--width> I<width>] [B<-c>|B<--columns> I<cols>] [B<-s>|B<--strip> I<strip>] I<str>B<sep>I<str>...
This pretty-prints a I<sep>-sperarated list of I<str>ings as a table. Per
default a colon-separated list (I<sep>=":") is pretty printed as a
@@ -362,7 +362,7 @@
# shell script
shtool table -F , -w 5 -c 4 "1,2,3,4,5,6,7,8,9,10,11,12"
-=item B<prop> [B<-p> I<str>]
+=item B<prop> [B<-p>|B<--prefix> I<str>]
This command displays a processing indication though a running propeller. The
option ``B<-p>'' can be used to set a particular prefix I<str> which is
@@ -382,7 +382,7 @@
tee logfile |\
shtool prop -p "Configuring sources"
-=item B<move> [-v] [-t] [-e] [-p] I<src-file> I<dst-file>
+=item B<move> [B<-v>|B<--verbose>] [B<-t>|B<--trace>] [B<-e>|B<--expand>] [B<-p>|B<--preserve>] I<src-file> I<dst-file>
This is a mv(1) style command, but with two special features: First if
option ``B<-e>'' (`expand') is used and an asterisk occurs somewhere in I<src>
@@ -409,7 +409,7 @@
lex scanner.l
shtool move -t -p lex.yy.c scanner.c
-=item B<install> [B<-v>] [B<-t>] [B<-c>] [B<-C>] [B<-s>] [B<-m> I<mode>] [B<-o> I<owner>] [B<-g> I<group>] [B<-e> I<sed-cmd>] I<file> I<path>
+=item B<install> [B<-v>|B<--verbose>] [B<-t>|B<--trace>] [B<-c>|B<--copy>] [B<-C>|B<--compare-copy>] [B<-s>|B<--strip>] [B<-m>|B<--mode> I<mode>] [B<-o>|B<--owner> I<owner>] [B<-g>|B<--group> I<group>] [B<-e>|B<--exec> I<sed-cmd>] I<file> I<path>
This command installs a program, script or datafile (dependent on I<mode>) in
a portable way while providing all important options of the BSD install(1)
@@ -440,14 +440,15 @@
shtool install -c -m 644 foo.man $(mandir)/man1/foo.1
shtool install -c -m 644 -e "s/@p@/$prefix/g" foo.conf $(etcdir)/
-=item B<mkdir> [B<-t>] [B<-f>] [B<-p>] [B<-m> I<mode>] I<dir> [I<dir> ...]
+=item B<mkdir> [B<-t>|B<--trace>] [B<-f>|B<--force>] [B<-p>|B<--parents>] [B<-m>|B<--mode> I<mode>] I<dir> [I<dir> ...]
-This is a mkdir(1) style command providing support for auto-parent-dir
-creation (if option ``B<-p>'' is used), directory permission control (with
-option ``B<-m> I<mode>'' where I<mode> can be in any of the formats specified
-to the chmod(1) command) and smart skipping if I<dir> already exists
-(triggered by the force option ``B<-f>''). Option ``B<-t>'' (trace) can be
-used to enable the output of the essential shell commands which are executed.
+This is a mkdir(1) style command providing support for automatic parent
+directory creation (if option ``B<-p>'' is used), directory permission
+control (with option ``B<-m> I<mode>'' where I<mode> can be in any of
+the formats specified to the chmod(1) command) and smart skipping if
+I<dir> already exists (triggered by the force option ``B<-f>''). Option
+``B<-t>'' (trace) can be used to enable the output of the essential
+shell commands which are executed.
The trick of this command is that it provides both a portable ``B<-p>''
functionality and the ability to be smart if the directory already exists
@@ -461,7 +462,7 @@
shtool mkdir -f -p -m 755 $(mandir)/man1
:
-=item B<mkln> [B<-t>] [B<-f>] [B<-s>] I<src-path> [I<src-path> ...] I<dst-path>
+=item B<mkln> [B<-t>|B<--trace>] [B<-f>|B<--force>] [B<-s>|B<--symbolic>] I<src-path> [I<src-path> ...] I<dst-path>
This is a ln(1) style command which provides automatic calculation and usage
of relative links if possible, i.e. usually if I<src-path> and I<dst-path>
@@ -481,7 +482,7 @@
# shell script
shtool mkln -s foo/bar baz/quux
-=item B<mkshadow> [B<-v>] [B<-t>] [B<-a>] I<src-dir> I<dst-dir>
+=item B<mkshadow> [B<-v>|B<--verbose>] [B<-t>|B<--trace>] [B<-a>|B<--all>] I<src-dir> I<dst-dir>
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
@@ -505,7 +506,7 @@
# shell script
shtool mkshadow -v -a . /tmp/shadow
-=item B<fixperm> [B<-v>] [B<-t>] I<path> [ I<path> ... ]
+=item B<fixperm> [B<-v>|B<--verbose>] [B<-t>|B<--trace>] I<path> [ I<path> ... ]
This command fixes file permissions inside a source tree under I<path> by
cleaning up the permission bits. It determines the cleaned up permission from
@@ -524,7 +525,7 @@
shtool fixperm -v *
...
-=item B<tarball> [B<-t>] [B<-v>] [B<-o> I<tarball>] [B<-c> I<prog>] [B<-u> I<user>] [B<-g> I<group>] [B<-e> I<pattern>] I<path> [I<path> ...]
+=item B<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> ...]
This command is for `rolling' distribution `tarballs', i.e. for the creation
of distribution files generated by `C<tar>'. The important aspects of
@@ -559,7 +560,7 @@
shtool tarball -o foobar-$$V.tar.gz -c 'gzip -9' \
-u bar -g gnu -e 'CVS,\.cvsignore' .
-=item B<subst> [B<-v>] [B<-t>] [B<-n>] [B<-s>] [B<-i>] [B<-b> I<ext>] [B<-e> I<cmd>] [B<-f> I<cmd-file>] [I<file>] [I<file> ...]
+=item B<subst> [B<-v>|B<--verbose>] [B<-t>|B<--trace>] [B<-n>|B<--nop>] [B<-s>|B<--stealth>] [B<-i>|B<--interactive>] [B<-b>|B<--backup> I<ext>] [B<-e>|B<--exec> I<cmd>] [B<-f>|B<--file> I<cmd-file>] [I<file>] [I<file> ...]
This command applies one or more sed(1) substitution operations to
F<stdin> or any number of files. The sed(1) operations are either
@@ -601,7 +602,7 @@
# configure.in
OS=`shtool guessos`
-=item B<arx> [B<-t>] [B<-C> I<cmd>] I<op> I<archive> I<file> [I<file> ...]
+=item B<arx> [B<-t>|B<--trace>] [B<-C>|B<--command> I<cmd>] I<op> I<archive> I<file> [I<file> ...]
This is a wrapper around the archive (``C<ar>'') tool. It provides the ability
to create archives out of existing archives, i.e. if one of I<file> matches
@@ -628,7 +629,7 @@
shtool arx -C $(AR) rc libfoo.a $(OBJS) $(LIBS)
$(RANLIB) libfoo.a
-=item B<slo> [B<-p> I<str>] -- B<-L>I<dir> B<-l>I<lib> [ B<-L>I<dir> B<-l>I<lib> ... ]
+=item B<slo> [B<-p>|B<--prefix> I<str>] -- B<-L>I<dir> B<-l>I<lib> [ B<-L>I<dir> B<-l>I<lib> ... ]
This command separates the linker options ``B<-L>'' and ``B<-l>'' by library
class. It's argument line can actually be an abitrary command line where those
@@ -660,7 +661,7 @@
LINK_DSO="$SLO_DIRS_OBJ $SLO_LIBS_OBJ $SLO_DIRS_PIC $SLO_LIBS_PIC"
:
-=item B<scpp> [B<-v>] [B<-p>] [B<-f>] I<filter>] [B<-o> I<ofile>] [B<-t> I<tfile>] [B<-M> I<mark>] [B<-D> I<dname>] [B<-C> I<cname>] I<file> [I<file> ...]
+=item B<scpp> [B<-v>|B<--verbose>] [B<-p>|B<--preserve>] [B<-f>|B<--filter> I<filter>] [B<-o>|B<--output> I<ofile>] [B<-t>|B<--template> I<tfile>] [B<-M>|B<--mark> I<mark>] [B<-D>|B<--define> I<dname>] [B<-C>|B<--class> I<cname>] I<file> [I<file> ...]
This command is an additional ANSI C source file pre-processor for sharing
cpp(1) code segments, internal variables and internal functions. The intention
@@ -741,7 +742,7 @@
return 0;
}
-=item B<version> [B<-l> I<lang>] [B<-n> I<name>] [B<-p> I<prefix>] [B<-s> I<version>] [B<-e>] [B<-i> I<knob>] [B<-d> I<type>] I<file>
+=item B<version> [B<-l>|B<--language> I<lang>] [B<-n>|B<--name> I<name>] [B<-p>|B<--prefix> I<prefix>] [B<-s>|B<--set> I<version>] [B<-e>|B<--edit>] [B<-i>|B<--increase> I<knob>] [B<-d>|B<--display> I<type>] I<file>
This command generates and maintains a version information
file I<file> for program name I<name> in either textual
@@ -780,7 +781,7 @@
V=`shtool version -l c -d long version.c`
echo "Configuring FooBar, Version $V"
-=item B<path> [B<-s>] [B<-r>] [B<-d>] [B<-b>] [B<-m>] [-p I<path>] I<str> [I<str> ...]
+=item B<path> [B<-s>|B<--suppress>] [B<-r>|B<--reverse>] [B<-d>|B<--dirname>] [B<-b>|B<--basename>] [B<-m>|B<--magic>] [B<-p>|B<--path> I<path>] I<str> [I<str> ...]
This command deals with shell C<$PATH> variables. It can find a program
executable in $PATH or I<path> through one or more filenames (given by one or
@@ -812,15 +813,16 @@
=head1 HISTORY
-Some scripts contained in B<shtool> were already written in 1994 by I<Ralf
-S. Engelschall> for use inside some private source trees. Then they evolved
-into more elaborated versions over the years and were used in various free
-software projects like ePerl, WML, iSelect, gFONT, etc. They were complemented
-with other scripts from the author which he wrote in March 1998 for the
-``Apache Autoconf-style Interface'' (APACI). In April 1999 the B<shtool>
-package was created out of the accumulated master versions of the scripts and
-in June 1999 it entered the status of an official GNU program and this way
-finally joined the group of B<autoconf>, B<automake> and B<libtool>.
+Some scripts contained in GNU B<shtool> were already written in 1994 by
+I<Ralf S. Engelschall> for use inside some private source trees. Then
+they evolved into more elaborated versions over the years and were used
+in various free software projects like ePerl, WML, iSelect, gFONT, etc.
+They were complemented with other scripts from the author which he wrote
+in March 1998 for the ``Apache Autoconf-style Interface'' (APACI) for
+Apache 1.3. In April 1999 the B<shtool> package was created out of the
+accumulated master versions of the scripts and in June 1999 it entered
+the status of an official GNU program and this way finally joined the
+group of GNU B<autoconf>, GNU B<automake> and GNU B<libtool>.
=head1 AUTHOR
|
