dh_undocumented.1

   1 .TH DH_UNDOCUMENTED 1
   2 .SH NAME
   3 dh_undocumented \- make symlinks to undocumented.7.gz man page
   4 .SH SYNOPSIS
   5 .B dh_undocumented
   6 .I "[-v] [-a] [-i] [-ppackage] [-Ptmpdir] [-A] [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 extensions - 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 package dh_undocumented is told
  27 to act on. By default, this is the first binary package in debian/control,
  28 but if you use -p, -i, or -a flags, it will be the first package specified
  29 by those flags.
  30 Also, a file named debian/undocumented (for the first binary package in
  31 debian/control), or debian/package.undocumented (for each additional package
  32 in debian/control) can list other man page names to set up.
  33 .SH OPTIONS
  34 .TP
  35 .B \-v
  36 Verbose mode; show all commands that modify the package build directory.
  37 .TP
  38 .B \-a
  39 Install undocumented man page symlinks for all architecture dependent packages.
  40 .TP
  41 .B \-i
  42 Install undocumented man page symlinks for all architecture independent packages.
  43 .TP
  44 .B \-ppackage
  45 Install undocumented man page symlinks for the package named "package".
  46 .TP
  47 .B \-Ptmpdir
  48 Use "tmpdir" for package build directory.
  49 .TP
  50 .B \-A
  51 Install undocumented man page symlinks for any man pages specified by
  52 command line parameters in ALL packages acted on. I doubt anyone will find
  53 this useful, it's here for consitency with other debhelper programs.
  54 .TP
  55 .B manpage ...
  56 Install undocumented man page symlinks for each of these man pages
  57 into the first package acted on. (Or in all packages acted on if -A is
  58 specified.)
  59 .SH NOTES
  60 The
  61 .B \-a
  62 .B \-i
  63 and
  64 .B \-p
  65 arguments are cumulative. If none are specified, then all packages listed in
  66 the control file will be effected.
  67 .SH ENVIRONMENT
  68 .TP
  69 .I DH_VERBOSE
  70 Enables verbose mode
  71 .SH "SEE ALSO"
  72 .BR /usr/doc/debhelper/README
  73 ,
  74 .BR undocumented (7)
  75 .SH "CONFORMS TO"
  76 Debian policy, version 2.3.0.0
  77 .SH AUTHOR
  78 Joey Hess <joeyh@master.debian.org>