r433: this is getting *so* boring.

1 files changed, 90 insertions, 2 deletions

diff --git a/dh_makeshlibs b/dh_makeshlibs
index 20644d80..9d48cd8b 100755
--- a/dh_makeshlibs
+++ b/dh_makeshlibs
@@ -1,9 +1,85 @@
 #!/usr/bin/perl -w
-#
-# Automatically generate shlibs files.
+
+=head1 NAME
+
+dh_makeshlibs - automatically create shlibs file
+
+=cut
 
 use strict;
 use Debian::Debhelper::Dh_Lib;
+
+=head1 SYNOPSIS
+
+  dh_makeshlibs [debhelper options] [-mmajor] [-V[dependancies]] [-n]
+
+=head1 DESCRIPTION
+
+dh_makeshlibs is a debhelper program that automatically scans for shared
+libraries, and generates a shlibs file for the libraries it finds.
+
+It also adds a call to ldconfig in the postinst and postrm scripts (in
+DH_COMPAT=3 mode and above only).
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-m>I<major>, B<--major=>I<major>
+
+Instead of trying to guess the major number of the library from the
+filename of the library, use the major number specified after the -m parameter.
+
+=item B<-V>, B<-V>I<dependancies>
+
+=item B<--version-info>, B<--version-info=>I<dependancies>
+
+By default, the shlibs file generated by this program does not make packages
+depend on any particular version of the package containing the shared
+library. It may be necessary for you to add some version dependancy
+information to the shlibs file. If -V is specified with no dependancy
+information, the current version of the package is plugged into a
+dependancy that looks like "packagename (>= packageversion)". If -V is specified with
+parameters, the parameters can be used to specify the exact dependancy
+information needed (be sure to include the package name).
+
+=item B<-n>, B<--noscripts>
+
+Do not modify postinst/postrm scripts.
+
+=back
+
+=head1 EXAMPLES
+
+ dh_makeshlibs
+
+Assuming this is a package named libfoobar1, generates a shlibs file that
+looks something like:
+ libfoobar 1 libfoobar1
+
+ dh_makeshlibs -V
+
+Assuming the current version of the package is 1.0-3, generates a shlibs
+file that looks something like:
+ libfoobar 1 libfoobar1 (>= 1.0-3)
+
+ dh_makeshlibs -V 'libfoobar1 (>= 1.0)'
+
+Generates a shlibs file that looks something like:
+  libfoobar 1 libfoobar1 (>= 1.0)
+
+=back
+
+=head1 NOTES
+
+There is no guarantee that the program will get the shlibs file right. For
+example, it may not correctly guess the major number of your package. In
+cases like these (and perhaps in general, just to be safe), it is better to
+create a debian/shlibs file by hand, or force it to use the correct major
+number by specifying the -m parameter.
+
+=cut
+
 init();
 
 foreach my $package (@{$dh{DOPACKAGES}}) {
@@ -68,3 +144,15 @@ foreach my $package (@{$dh{DOPACKAGES}}) {
 		doit("chown","0.0","$tmp/DEBIAN/shlibs");
 	}
 }
+
+=head1 SEE ALSO
+
+L<debhelper(1)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
+
+=cut