dh_undocumented.1

   1 .TH DH_UNDOCUMENTED 1 "" "Debhelper Commands" "Debhelper Commands"
   2 .SH NAME
   3 dh_undocumented \- make symlinks to undocumented.7.gz man page
   4 .SH SYNOPSIS
   5 .B dh_undocumented
   6 .I "[debhelper options [-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/share/man/. It also examines the extension
  18 to 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/package.undocumented can list other man page names
  31 to set up.
  32 .SH OPTIONS
  33 .TP
  34 .TP
  35 .B debhelper options
  36 See
  37 .BR debhelper (1)
  38 for a list of options common to all debhelper commands.
  39 .TP
  40 .B \-A, \--all
  41 Install undocumented man page symlinks for any man pages specified by
  42 command line parameters in ALL packages acted on. I doubt anyone will find
  43 this useful, it's here for consitency with other debhelper programs.
  44 .TP
  45 .B manpage ...
  46 Install undocumented man page symlinks for each of these man pages
  47 into the first package acted on. (Or in all packages acted on if -A is
  48 specified.)
  49 .SH ENVIRONMENT
  50 See
  51 .BR debhelper (1)
  52 for a list of environment variables that affect all debhelper commands.
  53 .SH "SEE ALSO"
  54 .TP
  55 .BR debhelper (1)
  56 .TP
  57 .BR undocumented (7)
  58 .SH "CONFORMS TO"
  59 Debian policy, version 3.0.1
  60 .SH AUTHOR
  61 Joey Hess <joeyh@debian.org>