dh_undocumented.1

   1 .TH DH_UNDOCUMENTED 1
   2 .SH NAME
   3 dh_undocumented \- make symlinks to undocumented.7 man page
   4 .SH SYNOPSIS
   5 .B dh_undocumented
   6 .I "[-v] [-a] [-i] [-ppackage] [manpage ...]"
   7 .SH "DESCRIPTION"
   8 dh_undocumented is a debhelper program that is responsible for making
   9 symlinks to the
  10 .BR undocumented (7)
  11 man page for man pages that are not present in your package.
  12 .P
  13 The program takes a list of man pages that should be symlinked to
  14 .BR undocumented (7)
  15 It determines what directory the man pages should be placed in by examining
  16 their extentions - pages ending in "x" go into /usr/X11R6/man/, while pages
  17 that end in anything else go in /usr/man/. It also examines the extention to
  18 see what section the man page belongs in. After figuring this out, it
  19 generates the necessary symlinks to
  20 .BR undocumented (7)
  21 , placing the sylinks in the package build directory.
  22 .P
  23 The lists of man pages that need
  24 .BR undocumented (7)
  25 symlinks can be specified in two ways. Any man page names specified as
  26 parameters will be set up in the first binary package listed in
  27 debian/control, if dh_installdocs is acting on that package.
  28 Also, if a file named debian/undocumented (for the first binary package in
  29 debian/control), or debian/package.undocumented (for each additional package
  30 in debian/control) can list other man page names to set up.
  31 .SH OPTIONS
  32 .TP
  33 .B \-v
  34 Verbose mode; show all commands that modify the package build directory.
  35 .TP
  36 .B \-a
  37 Install undocumented man page symlinks for all architecture dependent packages.
  38 .TP
  39 .B \-i
  40 Install undocumented man page symlinks for all architecture independent packages.
  41 .TP
  42 .B \-ppackage
  43 Install undocumented man page symlinks for the package named "package".
  44 .TP
  45 .B manpage ...
  46 Install undocumented man page symlinks for each of these man pages
  47 into the first binary package listed in debian/control, if we are acting on
  48 that package.
  49 .SH NOTES
  50 The
  51 .B \-a
  52 .B \-i
  53 and
  54 .B \-p
  55 arguments are cumulative. If none are specified, then all packages listed in
  56 the control file will be effected.
  57 .SH ENVIRONMENT
  58 .TP
  59 .I DH_VERBOSE
  60 Enables verbose mode
  61 .SH "SEE ALSO"
  62 .BR /usr/doc/debhelper/README
  63 ,
  64 .BR undocumented (7)
  65 .SH "CONFORMS TO"
  66 Debian policy, version 2.3.0.0
  67 .SH AUTHOR
  68 Joey Hess <joeyh@master.debian.org>