dh_ocamldoc(1) [debian man page]

DH_OCAMLDOC(1)						User Contributed Perl Documentation					    DH_OCAMLDOC(1)

NAME

       dh_ocamldoc - Generates documentation for OCaml libraries

SYNOPSIS

       dh_ocamldoc [debhelper options]

DESCRIPTION

       dh_ocamldoc looks for all files matching "debian/$package.ocamldoc*" where it can find the flags that will be given to ocamldoc, which will
       be called with all the .mli files (or .ml if there is no matching .mli) found in debian/package/usr/lib/ocaml. Each ".ocamldoc*" file is
       used to generate a different documentation where the part coming after "ocamldoc" in the filename is used as document ID in the doc-base
       file.

       You can have several flags per line. Lines beginning with "--include" have a special meaning: whatever follows "--include" will be
       considered as a list of directories where .mli or .ml files will be searched for the documentation generation. The directories will also be
       added to ocamldoc library search path. This can be useful for generating the documentation in its own binary package. Note that, to that
       end, you should ensure that the package shipping the documentation is treated by dh_ocamldoc after the package shipping the actual objects.

       The "-d" flag is detected and used to generate the appropriate doc-base file.  It contains the path of the documentation directory and is
       relative to "/usr/share/doc/$package/". The default value is "html/api".

       dh_ocamldoc detects automatically if "ocamlfind ocamldoc" should be called instead of plain "ocamldoc" (it does so by looking for common
       ocamlfind options such as: -package, -predicates, etc.).

       Lines starting with "#" in *ocamldoc files are comments and hence ignored.

       If you want to install the documentation present in upstream's tarball (if any), you may add "--doc-base-generate" in your .ocamldoc file
       in order to tell dh_ocamldoc generate the .doc-base file only.

OPTIONS

       -X files
	   Exclude files from documentation processing.

       -u flags
	   Additional flags to "ocamldoc" or "ocamlfind ocamldoc".

SEE ALSO

       debhelper(7), dh(1), dh_ocaml(1)

       This program is meant to be used together with debhelper.

AUTHOR

       Mehdi Dogguy <mehdi@debian.org>

perl v5.14.2							    2013-01-06							    DH_OCAMLDOC(1)

DH_INSTALLDOCS(1)						     Debhelper							 DH_INSTALLDOCS(1)

NAME

       dh_installdocs - install documentation into package build directories

SYNOPSIS

       dh_installdocs [debhelperoptions] [-A] [-Xitem] [file...]

DESCRIPTION

       dh_installdocs is a debhelper program that is responsible for installing documentation into usr/share/doc/package in package build
       directories.

FILES

       debian/package.docs
	   List documentation files to be installed into package.

       debian/copyright
	   The copyright file is installed into all packages, unless a more specific copyright file is available.

       debian/package.copyright
       debian/package.README.Debian
       debian/package.TODO
	   Each of these files is automatically installed if present for a package.

       debian/README.Debian
       debian/TODO
	   These files are installed into the first binary package listed in debian/control.

	   Note that README.debian files are also installed as README.Debian, and TODO files will be installed as TODO.Debian in non-native
	   packages.

       debian/package.doc-base
	   Installed as doc-base control files. Note that the doc-id will be determined from the Document: entry in the doc-base control file in
	   question.

       debian/package.doc-base.*
	   If your package needs to register more than one document, you need multiple doc-base files, and can name them like this.

OPTIONS

       -A, --all
	   Install all files specified by command line parameters in ALL packages acted on.

       -Xitem, --exclude=item
	   Exclude files that contain item anywhere in their filename from being installed. Note that this includes doc-base files.

       --link-doc=package
	   Make the documentation directory of all packages acted on be a symlink to the documentation directory of package. This has no effect
	   when acting on package itself, or if the documentation directory to be created already exists when dh_installdocs is run. To comply
	   with policy, package must be a binary package that comes from the same source package.

	   debhelper will try to avoid installing files into linked documentation directories that would cause conflicts with the linked package.
	   The -A option will have no effect on packages with linked documentation directories, and copyright, changelog, README.Debian, and TODO
	   files will not be installed.

	   (An older method to accomplish the same thing, which is still supported, is to make the documentation directory of a package be a
	   dangling symlink, before calling dh_installdocs.)

       file ...
	   Install these files as documentation into the first package acted on. (Or in all packages if -A is specified).

EXAMPLES

       This is an example of a debian/package.docs file:

	 README
	 TODO
	 debian/notes-for-maintainers.txt
	 docs/manual.txt
	 docs/manual.pdf
	 docs/manual-html/

NOTES

       Note that dh_installdocs will happily copy entire directory hierarchies if you ask it to (similar to cp -a). If it is asked to install a
       directory, it will install the complete contents of the directory.

       Note that this command is not idempotent. dh_prep(1) should be called between invocations of this command. Otherwise, it may cause multiple
       instances of the same text to be added to maintainer scripts.

SEE ALSO

       debhelper(7)

       This program is a part of debhelper.

AUTHOR

       Joey Hess <joeyh@debian.org>

9.20120909							    2011-09-12							 DH_INSTALLDOCS(1)