ossp-pkg/shtool/sh.arx 1.20 -> 1.21
--- sh.arx 2004/01/01 16:54:20 1.20
+++ sh.arx 2004/02/12 16:06:26 1.21
@@ -1,7 +1,6 @@
##
## arx -- Extended archive command
## 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
@@ -99,3 +98,80 @@
rm -rf $tmpdir
fi
+shtool_exit 0
+
+##
+## manual page
+##
+
+=pod
+
+=head1 NAME
+
+B<shtool arx> - B<GNU shtool> ar(1) extensional command
+
+=head1 SYNOPSIS
+
+B<shtool arx>
+[B<-t>|B<--trace>]
+[B<-C>|B<--command> I<cmd>]
+I<op>
+I<archive>
+I<file> [I<file> ...]
+
+=head1 DESCRIPTION
+
+B<shtool arx> is a wrapper around the archiving tool ar(1). It provides
+the ability to create archives out of existing archives, i.e., if one of
+I<file> matches "C<*.a>", the archive member files of I<file> are used
+instead of I<file> itself.
+
+The trick of this command is the automatic handling of archive members
+which is especially interesting if one wants to construct a (usually
+top-level) library archive out of pre-built sub-library archives
+(usually staying inside subdirs) in a large source tree. For B<GNU
+libtool> based projects, a similar functionality is provided by B<GNU
+libtool> internally, too.
+
+=head1 OPTIONS
+
+The following command line options are available.
+
+=over 4
+
+=item B<-t>, B<--trace>
+
+Shows the actually involved shell commands.
+
+=item B<-C>, B<--command> I<cmd>
+
+Set the used ar(1) command to I<cmd> instead of just "ar" (searched in C<$PATH>).
+
+=back
+
+=head1 EXAMPLE
+
+ # Makefile
+ AR=ar
+ RANLIB=ranlib
+ :
+ OBJS=foo.o bar.o
+ LIBS=baz/libbaz.a quux/libquux.a
+ :
+ libfoo.a: $(OBJS) $(LIBS)
+ shtool arx -C $(AR) rc libfoo.a $(OBJS) $(LIBS)
+ $(RANLIB) libfoo.a
+
+=head1 HISTORY
+
+The B<GNU shtool> B<arx> command was originally written by Ralf S.
+Engelschall E<lt>rse@engelschall.comE<gt> in 1999 for B<GNU shtool>. It
+was prompted by need to build libraries out of sub-libraries inside the
+B<OSSP> project.
+
+=head1 SEE ALSO
+
+shtool(1), ar(1).
+
+=cut
+
|
|
