Apply manual pages conventions

[debhelper.git] / dh_movefiles

diff --git a/dh_movefiles b/dh_movefiles
index 5e1db0fc74f531ce2449c0dd50c03238ded3e839..b146b8e90f1d313e8c1a086091cc4efe5abdaf9b 100755 (executable)
--- a/dh_movefiles
+++ b/dh_movefiles
@@ -11,23 +11,29 @@ use Debian::Debhelper::Dh_Lib;
 
 =head1 SYNOPSIS
 
-B<dh_movefiles> [S<I<debhelper options>>] [B<--sourcedir=>I<dir>] [B<-X>I<item>] S<I<file ...>>]
+B<dh_movefiles> [S<I<debhelper options>>] [B<--sourcedir=>I<dir>] [B<-X>I<item>] S<I<file> ...>]
 
 =head1 DESCRIPTION
 
-dh_movefiles is a debhelper program that is responsible for moving files
-out of debian/tmp or some other directory and into other package build
-directories. This may be useful if your package has a Makefile that installs
-everything into debian/tmp, and you need to break that up into subpackages.
+B<dh_movefiles> is a debhelper program that is responsible for moving files
+out of F<debian/tmp> or some other directory and into other package build
+directories. This may be useful if your package has a F<Makefile> that installs
+everything into F<debian/tmp>, and you need to break that up into subpackages.
 
-Files named debian/package.files list the files to be moved, separated by
-whitespace. The filenames listed should be relative to debian/tmp/. You can
-also list directory names, and the whole directory will be moved. If you
-prefer, you can list the files to move on the command line and this will
-apply to the first package dh_movefiles is told to act on.
+Note: B<dh_install> is a much better program, and you are recommended to use
+it instead of B<dh_movefiles>.
 
-Note: dh_install is a much better program, and you are recommended to use
-it instead of dh_movefiles.
+=head1 FILES
+
+=over 4
+
+=item debian/I<package>.files
+
+Lists the files to be moved into a package, separated by whitespace. The
+filenames listed should be relative to F<debian/tmp/>. You can also list
+directory names, and the whole directory will be moved.
+
+=back
 
 =head1 OPTIONS
 
@@ -35,35 +41,35 @@ it instead of dh_movefiles.
 
 =item B<--sourcedir=>I<dir>
 
-Instead of moving files out of debian/tmp (the default), this option makes
+Instead of moving files out of F<debian/tmp> (the default), this option makes
 it move files out of some other directory. Since the entire contents of
-the sourcedir is moved, specifying something like --sourcedir=/ is very
+the sourcedir is moved, specifying something like B<--sourcedir=/> is very
 unsafe, so to prevent mistakes, the sourcedir must be a relative filename;
-it cannot begin with a `/'.
+it cannot begin with a `B</>'.
 
 =item B<-Xitem>, B<--exclude=item>
 
-Exclude files that contain "item" anywhere in their filename from
+Exclude files that contain B<item> anywhere in their filename from
 being installed.
 
-=item I<file ...>
+=item I<file> ...
 
 Lists files to move. The filenames listed should be relative to
-debian/tmp/. You can also list directory names, and the whole directory will
-be moved. It is an error to list files here unless you use -p, -i, or -a to
-tell dh_movefiles which subpackage to put them in.
+F<debian/tmp/>. You can also list directory names, and the whole directory will
+be moved. It is an error to list files here unless you use B<-p>, B<-i>, or B<-a> to
+tell B<dh_movefiles> which subpackage to put them in.
 
 =back
 
 =head1 NOTES
 
-Note that files are always moved out of debian/tmp by default (even if you
+Note that files are always moved out of F<debian/tmp> by default (even if you
 have instructed debhelper to use a compatibility level higher than one,
 which does not otherwise use debian/tmp for anything at all). The idea
 behind this is that the package that is being built can be told to install
-into debian/tmp, and then files can be moved by dh_movefiles from that
+into F<debian/tmp>, and then files can be moved by B<dh_movefiles> from that
 directory. Any files or directories that remain are ignored, and get
-deleted by dh_clean later.
+deleted by B<dh_clean> later.
 
 =cut