r273: * dh_installdocs.1: clarified how the doc-id is determined. Closes: #44864

[debhelper.git] / dh_makeshlibs.1

diff --git a/dh_makeshlibs.1 b/dh_makeshlibs.1
index 51ba8feeed2b9a12d13640f71d773383781b7328..443cc0cbbbcc925112c8212348d2e81ec008051a 100644 (file)
--- a/dh_makeshlibs.1
+++ b/dh_makeshlibs.1
@@ -1,47 +1,60 @@
-.TH DH_MAKESHLIBS 1
+.TH DH_MAKESHLIBS 1 "" "Debhelper Commands" "Debhelper Commands"
 .SH NAME
 dh_makeshlibs \- automatically create shlibs file
 .SH SYNOPSIS
 .B dh_makeshlibs
-.I "[-v] [-a] [-i] [-ppackage]"
+.I "[debhelper options] [-mmajor] [-V[dependancies]]"
 .SH "DESCRIPTION"
 dh_makeshlibs is a debhelper program that automatically scans for shared
 libraries, and generates a shlibs file for the libraries it finds.
-.P
-For this program to work, you cannot have already installed a DEBIAN/shlibs
-file. If such a file exits, the program will exit with an error.
 .SH OPTIONS
 .TP
-.B \-v
-Verbose mode; show all commands that modify the package build directory.
+.B debhelper options
+See
+.BR debhelper (1)
+for a list of options common to all debhelper commands.
 .TP
-.B \-a
-Generate shlibs files for all architecture dependent packages.
+.B \-mmajor, \--major=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.
 .TP
-.B \-i
-Generate shlibs files for all architecture independent packages.
+.B \-V[dependancies], \--version-info, \--version-info=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).
+.SH EXAMPLES
 .TP
-.B \-ppackage
-Generate shlibs file for the package named "package".
-.SH NOTES
-The
-.B \-a
-.B \-i
-and
-.B \-p
-arguments are cumulative. If none are specified, then all packages listed in
-the control file will be effected.
-.SH ENVIRONMENT
+.B dh_makeshlibs
+Assuming this is a package named libfoobar1, generates a shlibs file that
+looks something like:
+  libfoobar 1 libfoobar1
 .TP
-.I DH_VERBOSE
-Enables verbose mode
+.B 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)
+.TP
+.B dh_makeshlibs \-V "'libfoobar1 (>= 1.0)'"
+Generates a shlibs file that looks something like:
+  libfoobar 1 libfoobar1 (>= 1.0)
+.SH ENVIRONMENT
+See
+.BR debhelper (1)
+for a list of environment variables that affect all debhelper commands.
 .SH "SEE ALSO"
-.BR /usr/doc/debhelper/README
+.BR debhelper (1)
 .SH BUGS
-There is no guarentee that the program will get the shlibs file right. For
+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
-casews like these (and perhaps in general, just to be safe), it is better to
-create a debian/shlibs file by hand.
+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.
+.P
 This is a "do what I Mean" type program - you have been warned!
 .SH AUTHOR
 Joey Hess <joeyh@master.debian.org>