.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "JH_INSTALLJAVADOC 1"
.TH JH_INSTALLJAVADOC 1 "2020-09-06" "0.76" "Javahelper"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
jh_installjavadoc \- install javadoc into packages
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBjh_installjavadoc\fR [\fIdebhelper options\fR]
.PP
\&\fBjh_installjavadoc\fR [\fIdebhelper options\fR] [\fB\-p\fR\fIpackage\fR] [\fIbase-directory-of-javadoc\fR] [\fIinstall-location\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBjh_installjavadoc\fR is a javahelper program that can install generated
javadoc for you.
.PP
If you have javadoc which has been built by your build system, then
\&\fBjh_installjavadoc\fR will install it in the correct location and register
it with doc-base for you. Either run \fBjh_installjavadoc\fR with the
directory containing the javadoc as a parameter, or it will read
\&\fIdebian/\fIpackage\fI.javadoc\fR or \fIdebian/javadoc\fR, which should contain
a single path to the javadoc for that package.
.PP
If you have used \fBjh_build\fR\|(1) that will automatically have created
javadoc.  To install that put the string \*(L"internal\*(R" in the javadoc
file and it will be installed.
.PP
The second parameter, or the second string on the line in the javadoc
file, can be used to override the install location, for example, so
that a \-doc package can install to \fI/usr/share/doc/\fIlibrary\fI/api\fR.
.SH "FILES"
.IX Header "FILES"
.IP "\fIdebian/\fIpackage\fI.javadoc\fR, \fIdebian/javadoc\fR" 4
.IX Item "debian/package.javadoc, debian/javadoc"
Parsed to determine which javadoc directory should be processed for the
given package.  Note that unlike most other debhelper commands,
\&\fBjh_installjavadoc\fR will use \fIdebian/javadoc\fR as a fallback
configuration file for \fIall\fR packages that it acts on.  Other
debhelper commands usually only apply this fallback to the
\&\*(L"main package\*(R".
.Sp
The file consists a single line listing the javadoc directory (or
the word \*(L"internal\*(R").  This is optionally followed path the path
to the desired install location if the default location is
incorrect.
.Sp
Examples:
.Sp
.Vb 1
\&     internal
\&
\&     build/javadoc /usr/share/doc/somewhere/libapi
.Ve
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-A\fR\fIauthor\fR, \fB\-\-author=\fR\fIauthor\fR" 4
.IX Item "-Aauthor, --author=author"
.PP
Beyond the above, \fBjh_installjavadoc\fR also accepts the shared
debhelper options documented in \fBdebhelper\fR\|(7).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBdebhelper\fR\|(7)
.PP
This program is a part of javahelper and uses debhelper as backend. There are
also tutorials in /usr/share/doc/javahelper.
.SH "AUTHOR"
.IX Header "AUTHOR"
Niels Thykier <niels@thykier.net>