--- sh.version 2004/01/01 16:54:20 1.35
+++ sh.version 2004/02/12 16:06:27 1.36
@@ -1,7 +1,6 @@
##
## version -- Maintain a version information file
## Copyright (c) 1994-2004 Ralf S. Engelschall <rse@engelschall.com>
-## Originally written for ePerl, rewritten from scratch 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
@@ -304,3 +303,109 @@
esac
fi
+shtool_exit 0
+
+##
+## manual page
+##
+
+=pod
+
+=head1 NAME
+
+B<shtool version> - B<GNU shtool> maintain version information file
+
+=head1 SYNOPSIS
+
+B<shtool 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>
+
+=head1 DESCRIPTION
+
+This command displays and maintains version information in I<file>.
+
+The version is always described with a triple
+E<lt>I<version>,I<revision>,I<level>E<gt> and is represented
+by a string which always matches the regular expression
+"C<[0-9]+\.[0-9]+[sabp.][0-9]+>".
+
+The hexadecimal format for a version C<v.rtl> is C<VVRRTLL> where C<VV>
+and C<RR> directly correspond to C<v> and C<r>, C<T> encodes the level
+type as C<9>, C<2>, C<1>, C<0> (representing C<s>, C<p>/C<.>, C<b>, C<a>
+in this order) and C<LL> is either directly corresponding to C<l> or set
+to C<99> if level type is C<s>.
+
+=head1 OPTIONS
+
+The following command line options are available.
+
+=over 4
+
+=item B<-v>, B<--verbose>
+
+Print verbose information during processing.
+
+=item B<-l>, B<--language> I<lang>
+
+Choose format of version file I<file>. I<lang>="C<txt>", ANSI C
+(I<lang>="c"), Perl (I<lang>="perl") or Python (I<lang>="python").
+Default is C<txt>.
+
+=item B<-n>, B<--name> I<name>
+
+Name the program the version is maintained for. Default is C<unknown>.
+
+=item B<-p>, B<--prefix> I<prefix>
+=item B<-s>, B<--set> I<version>
+
+Set the version to I<version>.
+
+=item B<-e>, B<--edit>
+
+Interactively enter a new version.
+
+=item B<-i>, B<--increase> I<knob>
+
+When option ``B<-i>'' is used, the current version in I<file> is updated
+by increasing one element of the version where I<knob> can be one of
+the following: ``C<v>'' for increasing the version by 1 (and resetting
+revision and level to 0), ``C<r>'' for increasing the revision by 1 (and
+resetting level to 0) or ``C<l>'' for increasing the level by 1.
+
+=item B<-d>, B<--display> I<type>
+
+Control the display type: "C<short>" for a short version display,
+"C<long>" for a longer version display, "C<hex>" for a hexadecimal
+display of the version and "C<libtool>" for a format suitable for use
+with GNU libtool.
+
+=back
+
+=head1 EXAMPLE
+
+ # shell script
+ shtool version -l c -n FooBar -p foobar -s 1.2b3 version.c
+
+ # configure.in
+ V=`shtool version -l c -d long version.c`
+ echo "Configuring FooBar, Version $V"
+
+=head1 HISTORY
+
+The B<GNU shtool> B<version> command was originally written by Ralf S.
+Engelschall E<lt>rse@engelschall.comE<gt> in 1994 for B<OSSP eperl>. It
+was later rewritten from scratch for inclusion into B<GNU shtool>.
+
+=head1 SEE ALSO
+
+shtool(1).
+
+=cut
+
|
