head	1.16;
access;
symbols
	SHTOOL_2_0_8:1.16
	SHTOOL_2_0_7:1.15
	SHTOOL_2_0_6:1.14
	SHTOOL_2_0_5:1.14
	SHTOOL_2_0_4:1.14
	SHTOOL_2_0_3:1.13
	SHTOOL_2_0_2:1.13
	SHTOOL_2_0_1:1.12
	SHTOOL_2_0_0:1.12
	SHTOOL_2_0b3:1.12
	SHTOOL_2_0b2:1.12
	SHTOOL_2_0b1:1.12
	SHTOOL_1_6:1.9.0.2
	SHTOOL_1_6_2:1.9
	SHTOOL_1_6_1:1.9
	SHTOOL_1_6_0:1.9
	SHTOOL_1_5:1.6.0.2
	SHTOOL_1_5_4:1.6
	SHTOOL_1_5_3:1.4
	SHTOOL_1_5_2:1.4
	SHTOOL_1_5_1:1.4
	SHTOOL_1_5_0:1.4
	SHTOOL_1_4_9:1.3
	SHTOOL_1_4_8:1.3
	SHTOOL_1_4_7:1.3
	SHTOOL_1_4_6:1.3
	SHTOOL_1_4_5:1.3
	SHTOOL_1_4_4:1.3
	SHTOOL_1_4_3:1.3
	SHTOOL_1_4_2:1.3
	SHTOOL_1_4_1:1.3;
locks; strict;
comment	@# @;


1.16
date	2008.04.02.20.13.44;	author rse;	state Exp;
branches;
next	1.15;
commitid	eB5Wirx8MdMyDzXs;

1.15
date	2007.05.19.19.09.39;	author rse;	state Exp;
branches;
next	1.14;
commitid	OPUF1UBbllBTwzis;

1.14
date	2006.02.04.09.43.26;	author rse;	state Exp;
branches;
next	1.13;
commitid	oWk7BmnyAitJtfkr;

1.13
date	2005.06.15.08.14.36;	author rse;	state Exp;
branches;
next	1.12;

1.12
date	2004.01.01.16.54.20;	author rse;	state Exp;
branches;
next	1.11;

1.11
date	2003.12.13.21.23.55;	author rse;	state Exp;
branches;
next	1.10;

1.10
date	2003.02.11.13.00.50;	author rse;	state Exp;
branches;
next	1.9;

1.9
date	2001.12.31.15.06.04;	author rse;	state Exp;
branches;
next	1.8;

1.8
date	2001.09.23.11.15.57;	author rse;	state Exp;
branches;
next	1.7;

1.7
date	2001.06.14.19.02.54;	author rse;	state Exp;
branches;
next	1.6;

1.6
date	2001.06.14.14.24.17;	author rse;	state Exp;
branches;
next	1.5;

1.5
date	2001.06.14.12.47.28;	author rse;	state Exp;
branches;
next	1.4;

1.4
date	2000.06.14.19.10.29;	author rse;	state Exp;
branches;
next	1.3;

1.3
date	99.07.07.14.29.09;	author rse;	state Exp;
branches;
next	1.2;

1.2
date	99.07.07.11.37.05;	author rse;	state Exp;
branches;
next	1.1;

1.1
date	99.07.07.06.43.04;	author rse;	state Exp;
branches;
next	;


desc
@@


1.16
log
@adjust copyright for year 2008
@
text
@##
##  shtoolize.pod -- Manual Page for shtoolize in POD format
##  Copyright (c) 1999-2008 Ralf S. Engelschall <rse@@engelschall.com>
##
##  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
##  License as published by the Free Software Foundation; either version
##  2 of the License, or (at your option) any later version.
##
##  This file is distributed in the hope that it will be useful,
##  but WITHOUT ANY WARRANTY; without even the implied warranty of
##  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
##  General Public License for more details.
##
##  You should have received a copy of the GNU General Public License
##  along with this program; if not, write to the Free Software
##  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
##  USA, or contact Ralf S. Engelschall <rse@@engelschall.com>.
##

=pod

=head1 NAME

B<shtoolize> - Build individual GNU shtool scripts

=head1 VERSION

GNU shtool SHTOOL_VERSION_STR

=head1 SYNOPSIS

B<shtoolize>
[B<-h>]
[B<-v>]
[B<-q>]
[B<-o> I<script>]
I<module>
[ I<module> ... ]

=head1 DESCRIPTION

The B<shtoolize> program builds individual GNU B<shtool> scripts (written to
the default output file C<shtool> or to the specified I<script>) out of one or
more B<shtool> ingredient I<module>s.  Available I<module>s are:

 echo       Print string with optional construct expansion
 mdate      Pretty-print modification time of a file or dir
 table      Pretty print a field-separated list as a table
 prop       Display progress with a running propeller
 move       Move files with simultan substitution
 install    Install a program, script or datafile
 mkdir      Make one or more directories
 mkln       Make link with calculation of relative paths
 mkshadow   Make a shadow tree
 fixperm    Fix file permissions inside a source tree
 rotate     Rotate a logfile
 tarball    Roll distribution tarballs
 subst      Apply sed(1) substitution operations
 platform   Platform identification utility
 arx        Extended archive command
 slo        Separate linker options by library class
 scpp       Sharing C Pre-Processor
 version    Generate and maintain a version information file
 path       Deal with program paths

Additionally there is a pseudo-module ``C<all>'' which can be used as a
short-hand for ``C<echo mdate table prop move install mkdir mkln mkshadow
fixperm platform arx slo scpp version path>'', i.e. to build a B<shtool> script
with all modules in the standard order. An installed B<shtool> is usually
built this way via ``C<shtoolize -o shtool all>''.

Use the B<shtoolize> program to build individual B<shtool> scripts in case you
want a smaller sized script and you don't need all of the available B<shtool>
functionality.  For instance for the classical B<Autoconf> based free software
package a C<shtool> script build via ``C<shtoolize -o shtool install mkdir>''
might be sufficient.

=head1 OPTIONS

The following command line options exist:

=over 4

=item B<-h>

Displays a short help page describing the usage of B<shtoolize>.

=item B<-v>

Displays the version number of B<shtoolize>/B<shtool>.

=item B<-q>

Displays no processing information.

=item B<-o> I<script>

Writes the output to file I<script> instead to file ``C<shtool>''.

=back

=head1 EXAMPLE

The typical free software package which is based on GNU B<libtool> and GNU
B<shtool> one uses a C<Makefile> entry like the following:

 #   Makefile entry for upgrading GNU tools
 upgrade-tools:
     libtoolize -f -c
     shtoolize -q all

This upgrades the three files C<ltmain.sh>, C<ltconfig> and C<shtool> in the
current source tree to the latest versions.

=head1 SEE ALSO

shtool(1).

=head1 AUTHOR

 Ralf S. Engelschall
 rse@@engelschall.com
 www.engelschall.com

=cut

@


1.15
log
@Adjust copyright for year 2007.
@
text
@d3 1
a3 1
##  Copyright (c) 1999-2007 Ralf S. Engelschall <rse@@engelschall.com>
@


1.14
log
@Adjust copyright for year 2006
@
text
@d3 1
a3 1
##  Copyright (c) 1999-2006 Ralf S. Engelschall <rse@@engelschall.com>
@


1.13
log
@Adjust copyright for year 2005
@
text
@d3 1
a3 1
##  Copyright (c) 1999-2005 Ralf S. Engelschall <rse@@engelschall.com>
@


1.12
log
@Bump copyright year for 2004
@
text
@d3 1
a3 1
##  Copyright (c) 1999-2004 Ralf S. Engelschall <rse@@engelschall.com>
@


1.11
log
@Replaced old and inflexible "shtool guessos" command
with a completely new command "shtool platform" command.
It distinguishes a Unix platform according to its hardware
architecture and operating system. For both there is a class,
product and technology identification. For each of those six
identifications, there is a verbose, regular and concise version.
@
text
@d3 1
a3 1
##  Copyright (c) 1999-2003 Ralf S. Engelschall <rse@@engelschall.com>
@


1.10
log
@Bump year in copyright messages to cover new year 2003.
@
text
@d60 1
a60 1
 guessos    Simple OS/platform guesser
d69 1
a69 1
fixperm guessos arx slo scpp version path>'', i.e. to build a B<shtool> script
@


1.9
log
@bump copyright years
@
text
@d3 1
a3 1
##  Copyright (c) 1999-2002 Ralf S. Engelschall <rse@@engelschall.com>
@


1.8
log
@*** empty log message ***
@
text
@d3 1
@


1.7
log
@*** empty log message ***
@
text
@d56 1
@


1.6
log
@*** empty log message ***
@
text
@d57 1
@


1.5
log
@*** empty log message ***
@
text
@d32 1
a32 1
B<shtoolize> 
d37 2
a38 2
I<module> 
[ I<module> ... ] 
d106 1
a106 1
 upgrade-tools: 
@


1.4
log
@*** empty log message ***
@
text
@d56 1
@


1.3
log
@*** empty log message ***
@
text
@d24 1
a24 1
shtoolize - Build individual GNU shtool scripts
@


1.2
log
@*** empty log message ***
@
text
@d35 1
d75 24
d107 1
a107 1
     shtoolize -v all
@


1.1
log
@*** empty log message ***
@
text
@d2 1
a2 1
##  shtoolize.pod -- Manual Page in Plain Old Document (POD) format
d24 1
a24 1
shtoolize - Build GNU shtool scripts
d28 1
a28 1
SHTOOL_VERSION_STR
d32 6
a37 1
B<shtoolize> I<module> [ I<module> ... ] 
d41 20
a60 19
The B<shtoolize> utility builds individual GNU C<shtool> scripts out of one or
more ingredient I<modules>. Available I<modules> are:

   echo       Print string with optional construct expansion
   mdate      Pretty-print modification time of a file or dir
   table      Pretty print a field-separated list as a table
   prop       Display progress with a running propeller
   move       Move files with simultan substitution
   install    Install a program, script or datafile
   mkdir      Make one or more directories
   mkln       Make link with calculation of relative paths
   mkshadow   Make a shadow tree
   fixperm    Fix file permissions inside a source tree
   guessos    Simple OS/platform guesser
   arx        Extended archive command
   slo        Separate linker options by library class
   scpp       Sharing C Pre-Processor
   version    Generate and maintain a version information file
   path       Deal with program paths
d63 20
a82 3
short-hand for building a C<shtool> script with all modules.

=head1 EXAMPLES
d84 2
a85 2
 $ shtoolize all
 $ shtoolize move mkdir install
@