summaryrefslogtreecommitdiff
path: root/dh_installdocs.1
diff options
context:
space:
mode:
authorjoey <joey>1999-08-17 04:20:25 +0000
committerjoey <joey>1999-08-17 04:20:25 +0000
commitecff4e2941eefd33c368be7a0ee372406a6d0e94 (patch)
tree708fb3b1166f14d0c5a1ac89a024de71af289671 /dh_installdocs.1
parent938b66ee19e113785e6655b1c3e73e9003e6464c (diff)
downloaddebhelper-ecff4e2941eefd33c368be7a0ee372406a6d0e94.tar.gz
r3: Initial revision
Diffstat (limited to 'dh_installdocs.1')
-rw-r--r--dh_installdocs.159
1 files changed, 59 insertions, 0 deletions
diff --git a/dh_installdocs.1 b/dh_installdocs.1
new file mode 100644
index 00000000..f21563ca
--- /dev/null
+++ b/dh_installdocs.1
@@ -0,0 +1,59 @@
+.TH DH_INSTALLDOCS 1
+.SH NAME
+dh_installdocs \- install documentation into package build directories
+.SH SYNOPSIS
+.B dh_installdocs
+.I "[-v] [-a] [-i] [-ppackage] [file ...]"
+.SH "DESCRIPTION"
+dh_installdocs is a debhelper program that is responsible for installing
+documentation into usr/doc/package in package build directories.
+.P
+dh_installdocs automatically installs debian/copyright if it exists. If
+dh_installdocs is acting on multiple packages, debian/copyright files will be
+installed into all packages.
+.P
+Any filenames specified as parameters, as well as debian/README.debian and
+debian/TODO, if they exist, will be installed into the first binary
+package listed in debian/control, if dh_installdocs is acting on that
+package.
+.P
+A file named debian/docs (for the first binary package in debian/control),
+or debian/package.docs (for each additional package in debian/control) can
+list other files to be installed.
+.SH OPTIONS
+.TP
+.B \-v
+Verbose mode; show all commands that modify the package build directory.
+.TP
+.B \-a
+Install files for all architecture dependent packages.
+.TP
+.B \-i
+Install files for all architecture independent packages.
+.TP
+.B \-ppackage
+Install files for the package named "package".
+.TP
+.B file ...
+Install these files as documentation into the first binary package listed in
+debian/control, if we are acting on that package.
+.SH NOTES
+The
+.B \-a
+.B \-i
+and
+.B \-p
+arguments are cumulative. If none are specified, then all packages listed in
+the control file will be effected.
+.SH ENVIRONMENT
+.TP
+.I DH_VERBOSE
+Enables verbose mode
+.SH "SEE ALSO"
+.BR /usr/doc/debhelper/README
+.SH BUGS
+Filenames with spaces in them will not currently be installed.
+.SH "CONFORMS TO"
+Debian policy, version 2.3.0.0
+.SH AUTHOR
+Joey Hess <joeyh@master.debian.org>