← Back to branch summary

~ubuntu-branches/ubuntu/natty/debhelper/natty

« back to all changes in this revision

Viewing changes to dh_installman

  • Committer: Bazaar Package Importer
  • Author(s): أحمد المحمودي (Ahmed El-Mahmoudy)
  • Date: 2011-02-07 17:16:49 UTC
  • mfrom: (1.4.21 sid)
  • Revision ID: james.westby@ubuntu.com-20110207171649-v8k6uowavom83cxt
Tags: 8.1.0ubuntu1
https://launchpad.net/bugs/714705
* Merge with Debian (LP: #714705); remaining changes:
  - dh_installinit: Add --upstart-only and --onlyscripts-upstart modes.
  - Add various autoscripts for above: postinst-upstart,
    postinst-upstart-replace, postinst-upstart-restart,
    prerm-upstart, prerm-upstart-norestart, preinst-removeconffile.
  - dh_installudev: Change default init.d symlink priority to 40.
  - dh_installchangelogs: Do not install upstream changelog in compat level
    7. This floods packages with huge upstream changelogs which take
    precious CD space.
  - dh_strip, dh_makeshlibs: use triplet-objdump, triplet-objcopy and
    triplet-strip from cross-binutils when cross-compiling; Debian #412118.
  - add dh_apparmor and autoscripts
  - debian/rules: override build target to set executable bit for
    dh_apparmor before actually running dh build, that is in order to get
    the manpage built for dh_apparmor.

Show diffs side-by-side

added added

removed removed

Lines of Context:
dh_installman
12
12
 
13
13
=head1 SYNOPSIS
14
14
 
15
 
B<dh_installman> [S<I<debhelper options>>] [S<I<manpage ...>>]
 
15
B<dh_installman> [S<I<debhelper options>>] [S<I<manpage> ...>]
16
16
 
17
17
=head1 DESCRIPTION
18
18
 
19
 
dh_installman is a debhelper program that handles installing
 
19
B<dh_installman> is a debhelper program that handles installing
20
20
man pages into the correct locations in package build directories. You tell
21
21
it what man pages go in your packages, and it figures out where to
22
 
install them based on the section field in their .TH line. If you have a
23
 
properly formatted .TH line, your man page will be installed into the right
 
22
install them based on the section field in their B<.TH> line. If you have a
 
23
properly formatted B<.TH> line, your man page will be installed into the right
24
24
directory, with the right name (this includes proper handling of pages
25
 
with a subsection, like "3perl", which are placed in man3, and given an
26
 
extension of ".3perl"). If your .TH line is incorrect or missing, the program
 
25
with a subsection, like B<3perl>, which are placed in F<man3>, and given an
 
26
extension of F<.3perl>). If your B<.TH> line is incorrect or missing, the program
27
27
may guess wrong based on the file extension.
28
28
 
29
29
It also supports translated man pages, by looking for extensions
30
 
like .ll.8 and .ll_LL.8, or by use of the --language switch.
 
30
like F<.ll.8> and F<.ll_LL.8>, or by use of the B<--language> switch.
31
31
 
32
 
If dh_installman seems to install a man page into the wrong section or with
 
32
If B<dh_installman> seems to install a man page into the wrong section or with
33
33
the wrong extension, this is because the man page has the wrong section
34
 
listed in its .TH line. Edit the man page and correct the section, and
35
 
dh_installman will follow suit.  See L<man(7)> for details about the .TH
36
 
section. If dh_installman seems to install a man page into a directory
37
 
like /usr/share/man/pl/man1/, that is because your program has a
38
 
name like "foo.pl", and dh_installman assumes that means it is translated
39
 
into Polish. Use --language=C to avoid this.
 
34
listed in its B<.TH> line. Edit the man page and correct the section, and
 
35
B<dh_installman> will follow suit. See L<man(7)> for details about the B<.TH>
 
36
section. If B<dh_installman> seems to install a man page into a directory
 
37
like F</usr/share/man/pl/man1/>, that is because your program has a
 
38
name like F<foo.pl>, and B<dh_installman> assumes that means it is translated
 
39
into Polish. Use B<--language=C> to avoid this.
40
40
 
41
 
After the man page installation step, dh_installman will check to see if
 
41
After the man page installation step, B<dh_installman> will check to see if
42
42
any of the man pages in the temporary directories of any of the packages it
43
 
is acting on contain ".so" links. If so, it changes them to symlinks.
 
43
is acting on contain F<.so> links. If so, it changes them to symlinks.
44
44
 
45
 
Also, dh_installman will use man to guess the character encoding of each
 
45
Also, B<dh_installman> will use man to guess the character encoding of each
46
46
manual page and convert it to UTF-8. If the guesswork fails for some
47
47
reason, you can override it using an encoding declaration. See
48
48
L<manconv(1)> for details.
66
66
Install all files specified by command line parameters in ALL packages
67
67
acted on.
68
68
 
69
 
=item B<--language>=ll
 
69
=item B<--language=>I<ll>
70
70
 
71
71
Use this to specify that the man pages being acted on are written in the
72
72
specified language.
73
73
 
74
 
=item I<manpage ...>
 
74
=item I<manpage> ...
75
75
 
76
76
Install these man pages into the first package acted on. (Or in all
77
 
packages if -A is specified).
 
77
packages if B<-A> is specified).
78
78
 
79
79
=back
80
80