From 0952ac2e9995da8abe149f3e42b3b8d9d2797112 Mon Sep 17 00:00:00 2001 From: =?utf8?q?David=20Pr=C3=A9vot?= Date: Tue, 19 Oct 2010 18:54:32 -0400 Subject: [PATCH] Apply manual pages conventions As advised in man(1), always use: B type exactly as shown. I replace with appropriate argument. s/debian/Debian/ if needed. s/ / / also. s/perl/Perl/ s/python/Python/ and s/emacs/Emacs/ too. --- debhelper.pod | 228 +++++++++++++++++++++---------------------- dh | 64 ++++++------ dh_auto_build | 16 +-- dh_auto_clean | 16 +-- dh_auto_configure | 18 ++-- dh_auto_install | 32 +++--- dh_auto_test | 16 +-- dh_bugfiles | 6 +- dh_builddeb | 8 +- dh_clean | 20 ++-- dh_compress | 24 ++--- dh_desktop | 6 +- dh_fixperms | 14 +-- dh_gconf | 20 ++-- dh_gencontrol | 8 +- dh_icons | 6 +- dh_install | 67 ++++++------- dh_installcatalogs | 14 +-- dh_installchangelogs | 38 ++++---- dh_installcron | 8 +- dh_installdeb | 12 +-- dh_installdebconf | 26 ++--- dh_installdirs | 8 +- dh_installdocs | 34 +++---- dh_installemacsen | 26 ++--- dh_installexamples | 18 ++-- dh_installifupdown | 8 +- dh_installinfo | 10 +- dh_installinit | 56 +++++------ dh_installlogcheck | 6 +- dh_installlogrotate | 10 +- dh_installman | 42 ++++---- dh_installmanpages | 22 ++--- dh_installmenu | 12 +-- dh_installmime | 8 +- dh_installmodules | 12 +-- dh_installpam | 2 +- dh_installppp | 6 +- dh_installudev | 16 +-- dh_installwm | 12 +-- dh_installxfonts | 20 ++-- dh_link | 30 +++--- dh_lintian | 4 +- dh_listpackages | 2 +- dh_makeshlibs | 32 +++--- dh_md5sums | 14 +-- dh_movefiles | 38 ++++---- dh_perl | 38 ++++---- dh_prep | 10 +- dh_python | 52 +++++----- dh_scrollkeeper | 2 +- dh_shlibdeps | 28 +++--- dh_strip | 24 ++--- dh_suidregister | 4 +- dh_testdir | 10 +- dh_testroot | 2 +- dh_undocumented | 4 +- dh_usrlocal | 14 +-- 58 files changed, 652 insertions(+), 651 deletions(-) diff --git a/debhelper.pod b/debhelper.pod index b2f130b..1a6e6cd 100644 --- a/debhelper.pod +++ b/debhelper.pod @@ -4,26 +4,26 @@ debhelper - the debhelper tool suite =head1 SYNOPSIS -BI<*> [B<-v>] [B<-a>] [B<-i>] [B<-s>] [B<--no-act>] [B<-ppackage>] [B<-Npackage] [-Ptmpdir>] +BI<*> [B<-v>] [B<-a>] [B<-i>] [B<-s>] [B<--no-act>] [B<-p>I] [B<-N>I] [B<-P>I] =head1 DESCRIPTION -Debhelper is used to help you build a debian package. The philosophy behind +Debhelper is used to help you build a Debian package. The philosophy behind debhelper is to provide a collection of small, simple, and easily -understood tools that are used in debian/rules to automate various common +understood tools that are used in F to automate various common aspects of building a package. This means less work for you, the packager. -It also, to some degree means that these tools can be changed if debian +It also, to some degree means that these tools can be changed if Debian policy changes, and packages that use them will require only a rebuild to comply with the new policy. -A typical debian/rules file that uses debhelper will call several debhelper +A typical F file that uses debhelper will call several debhelper commands in sequence, or use L to automate this process. Examples of rules files that use debhelper are in F -To create a new debian package using debhelper, you can just copy one of -the sample rules files and edit it by hand. Or you can try the dh-make +To create a new Debian package using debhelper, you can just copy one of +the sample rules files and edit it by hand. Or you can try the B package, which contains a L command that partially -automates the process. For a more gentle introduction, the maint-guide debian +automates the process. For a more gentle introduction, the B Debian package contains a tutorial about making your first package using debhelper. =head1 DEBHELPER COMMANDS @@ -49,7 +49,7 @@ A few debhelper commands are deprecated and should not be used. =head2 Other Commands -If a program's name starts with "dh_", and the program is not on the above +If a program's name starts with B, and the program is not on the above lists, then it is not part of the debhelper package, but it should still work like the other programs described on this page. @@ -59,10 +59,10 @@ Many debhelper commands make use of files in F to control what they do. Besides the common F and F, which are in all packages, not just those using debhelper, some additional files can be used to configure the behavior of specific debhelper commands. These -files are typically named debian/package.foo (where "package" of course, +files are typically named debian/I.foo (where I of course, is replaced with the package that is being acted on). -For example, dh_installdocs uses files named debian/package.docs to list +For example, B uses files named F to list the documentation files it will install. See the man pages of individual commands for details about the names and formats of the files they use. Generally, these files will list files to act on, one file per line. Some @@ -70,22 +70,22 @@ programs in debhelper use pairs of files and destinations or slightly more complicated formats. Note that if a package is the first (or only) binary package listed in -debian/control, debhelper will use debian/foo if no debian/package.foo +F, debhelper will use F if no F file can be found. In some rare cases, you may want to have different versions of these files -for different architectures or OSes. If files named debian/package.foo.ARCH -or debian/package.foo.OS exist, where "ARCH" and "OS" are the same as the -output of "dpkg-architecture -qDEB_HOST_ARCH" / -"dpkg-architecture -qDEB_HOST_ARCH_OS", +for different architectures or OSes. If files named debian/I.foo.I +or debian/I.foo.I exist, where I and I are the same as the +output of "B" / +"B", then they will be used in preference to other, more general files. In many cases, these config files are used to specify various types of files. Documentation or example files to install, files to move, and so on. When appropriate, in cases like these, you can use standard shell wildcard -characters ('?' and '*' and '[..]' character classes) in the files. +characters (B and B<*> and B<[>I<..>B<]> character classes) in the files. -You can also put comments in these files; lines beginning with "#" are +You can also put comments in these files; lines beginning with B<#> are ignored. =head1 SHARED DEBHELPER OPTIONS @@ -112,19 +112,19 @@ build architecture. Act on all architecture independent packages. -=item B<->I, B<--package=>I +=item B<-p>I, B<--package=>I -Act on the package named "package". This option may be specified multiple +Act on the package named I. This option may be specified multiple times to make debhelper operate on a given set of packages. =item B<-s>, B<--same-arch> -This used to be a smarter version of the -a flag, but the -a flag is now +This used to be a smarter version of the B<-a> flag, but the B<-a> flag is now equally smart. =item B<-N>I, B<--no-package=>I -Do not act on the specified package even if an -a, -i, or -p option lists +Do not act on the specified package even if an B<-a>, B<-i>, or B<-p> option lists the package as one that should be acted on. =item B<--remaining-packages> @@ -137,26 +137,26 @@ process the rest of packages with default settings. =item B<--ignore=>I -Ignore the specified file. This can be used if debian/ contains a debhelper +Ignore the specified file. This can be used if F contains a debhelper config file that a debhelper command should not act on. Note that -debian/compat, debian/control, and debian/changelog can't be ignored, but +F, F, and F can't be ignored, but then, there should never be a reason to ignore those files. -For example, if upstream ships a debian/init that you don't want -dh_installinit to install, use --ignore=debian/init +For example, if upstream ships a F that you don't want +B to install, use B<--ignore=debian/init> =item B<-P>I, B<--tmpdir=>I -Use "tmpdir" for package build directory. The default is debian/ +Use I for package build directory. The default is debian/I =item B<--mainpackage=>I This little-used option changes the package which debhelper considers the -"main package", that is, the first one listed in debian/control, and the -one for which debian/foo files can be used instead of the usual -debian/package.foo files. +"main package", that is, the first one listed in F, and the +one for which F files can be used instead of the usual +F files. -=item B<-O=>I +=item B<-O=>I