summaryrefslogtreecommitdiff
path: root/dh_install
diff options
context:
space:
mode:
authorDavid Prévot <david@tilapin.org>2010-10-19 18:54:32 -0400
committerJoey Hess <joey@kitenet.net>2010-11-02 22:22:46 -0400
commit0952ac2e9995da8abe149f3e42b3b8d9d2797112 (patch)
tree06af28756b07653e12b9d2e425599080730eb763 /dh_install
parent4e30945a188944232cec97f8aac8902ec9d56530 (diff)
Apply manual pages conventions
As advised in man(1), always use: B<bold text> type exactly as shown. I<italic text> replace with appropriate argument. s/debian/Debian/ if needed. s/ / / also. s/perl/Perl/ s/python/Python/ and s/emacs/Emacs/ too.
Diffstat (limited to 'dh_install')
-rwxr-xr-xdh_install67
1 files changed, 34 insertions, 33 deletions
diff --git a/dh_install b/dh_install
index c35c892..1748fc2 100755
--- a/dh_install
+++ b/dh_install
@@ -12,28 +12,28 @@ use Debian::Debhelper::Dh_Lib;
=head1 SYNOPSIS
-B<dh_install> [B<-X>I<item>] [B<--autodest>] [B<--sourcedir=>I<dir>] [S<I<debhelper options>>] [S<I<file [...] dest>>]
+B<dh_install> [B<-X>I<item>] [B<--autodest>] [B<--sourcedir=>I<dir>] [S<I<debhelper options>>] [S<I<file> ... I<dest>>]
=head1 DESCRIPTION
-dh_install is a debhelper program that handles installing files into package
-build directories. There are many dh_install* commands that handle installing
+B<dh_install> is a debhelper program that handles installing files into package
+build directories. There are many B<dh_install>I<*> commands that handle installing
specific types of files such as documentation, examples, man pages, and so on,
and they should be used when possible as they often have extra intelligence for
-those particular tasks. dh_install, then, is useful for installing everything
+those particular tasks. B<dh_install>, then, is useful for installing everything
else, for which no particular intelligence is needed. It is a replacement for
-the old dh_movefiles command.
+the old B<dh_movefiles> command.
This program may be used in one of two ways. If you just have a file or two
-that the upstream Makefile does not install for you, you can run dh_install
+that the upstream Makefile does not install for you, you can run B<dh_install>
on them to move them into place. On the other hand, maybe you have a large
package that builds multiple binary packages. You can use the upstream
-Makefile to install it all into debian/tmp, and then use dh_install to copy
+F<Makefile> to install it all into F<debian/tmp>, and then use B<dh_install> to copy
directories and files from there into the proper package build directories.
-From debhelper compatibility level 7 on, dh_install will fall back to
-looking in debian/tmp for files, if it doesn't find them in the current
-directory (or whereever you've told it to look using --sourcedir).
+From debhelper compatibility level 7 on, B<dh_install> will fall back to
+looking in F<debian/tmp> for files, if it doesn't find them in the current
+directory (or whereever you've told it to look using B<--sourcedir>).
=head1 FILES
@@ -57,7 +57,7 @@ the files to install (in v3 mode and above).
=item B<--list-missing>
-This option makes dh_install keep track of the files it installs, and then at
+This option makes B<dh_install> keep track of the files it installs, and then at
the end, compare that list with the files in the source directory. If any of
the files (and symlinks) in the source directory were not installed to
somewhere, it will warn on stderr about that.
@@ -65,50 +65,51 @@ somewhere, it will warn on stderr about that.
This may be useful if you have a large package and want to make sure that
you don't miss installing newly added files in new upstream releases.
-Note that files that are excluded from being moved via the -X option are not
+Note that files that are excluded from being moved via the B<-X> option are not
warned about.
=item B<--fail-missing>
-This option is like --list-missing, except if a file was missed, it will
+This option is like B<--list-missing>, except if a file was missed, it will
not only list the missing files, but also fail with a nonzero exit code.
-=item B<-Xitem>, B<--exclude=item>
+=item B<-X>I<item>, B<--exclude=>I<item>
-Exclude files that contain "item" anywhere in their filename from
+Exclude files that contain I<item> anywhere in their filename from
being installed.
-=item B<--sourcedir=dir>
+=item B<--sourcedir=>I<dir>
Look in the specified directory for files to be installed.
-Note that this is not the same as the --sourcedirectory option used
-by the dh_auto_* commands. You rarely need to use this option, since
-dh_install automatically looks for files in debian/tmp in debhelper
+Note that this is not the same as the B<--sourcedirectory> option used
+by the B<dh_auto_>I<*> commands. You rarely need to use this option, since
+B<dh_install> automatically looks for files in F<debian/tmp> in debhelper
+
compatibility level 7 and above.
=item B<--autodest>
Guess as the destination directory to install things to. If this is
specified, you should not list destination directories in
-debian/package.install files or on the command line. Instead, dh_install
+F<debian/package.install> files or on the command line. Instead, B<dh_install>
will guess as follows:
-Strip off debian/tmp (or the sourcedir if one is given) from the front of
+Strip off F<debian/tmp> (or the sourcedir if one is given) from the front of
the filename, if it is present, and install into the dirname of the
-filename. So if the filename is debian/tmp/usr/bin, then that directory
-will be copied to debian/package/usr/. If the filename is
-debian/tmp/etc/passwd, it will be copied to debian/package/etc/.
+filename. So if the filename is F<debian/tmp/usr/bin>, then that directory
+will be copied to F<debian/package/usr/>. If the filename is
+F<debian/tmp/etc/passwd>, it will be copied to F<debian/package/etc/>.
Note that if you list exactly one filename or wildcard-pattern on a line by
itself in a
-debian/package.install file, with no explicit destination, then dh_install
+F<debian/package.install> file, with no explicit destination, then B<dh_install>
will automatically guess the destination even if this flag is not set.
-=item I<file [...] dest>
+=item I<file> ... I<dest>
Lists files (or directories) to install and where to install them to.
-The files will be installed into the first package dh_install acts on.
+The files will be installed into the first package F<dh_install> acts on.
=back
@@ -251,20 +252,20 @@ if ($dh{LIST_MISSING} || $dh{FAIL_MISSING}) {
=head1 EXAMPLE
-Suppose your package's upstream Makefile installs a binary, a man page, and
-a library into appropriate subdirectories of debian/tmp. You want to put
+Suppose your package's upstream F<Makefile> installs a binary, a man page, and
+a library into appropriate subdirectories of F<debian/tmp>. You want to put
the library into package libfoo, and the rest into package foo. Your rules
-file will run "dh_install --sourcedir=debian/tmp". Make debian/foo.install
+file will run "B<dh_install --sourcedir=debian/tmp>". Make F<debian/foo.install>
contain:
usr/bin
usr/share/man/man1
-While debian/libfoo.install contains:
+While F<debian/libfoo.install> contains:
usr/lib/libfoo*.so.*
-If you want a libfoo-dev package too, debian/libfoo-dev.install might contain:
+If you want a libfoo-dev package too, F<debian/libfoo-dev.install> might contain:
usr/include
usr/lib/libfoo*.so
@@ -272,7 +273,7 @@ If you want a libfoo-dev package too, debian/libfoo-dev.install might contain:
=head1 LIMITATIONS
-dh_install cannot rename files or directories, it can only install them
+B<dh_install> cannot rename files or directories, it can only install them
with the names they already have into wherever you want in the package
build tree.