.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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 "Debian::Javahelper::Java 3"
.TH Debian::Javahelper::Java 3 "2014-12-12" "0.48+deb8u1" "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"
Debian::Javahelper::Java \- Javahelper core library.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Debian::Javahelper::Java;
\& 
\& my @paths = scan_javadoc("/usr/share/doc/libfreemarker\-doc/api/");
\& print "Freemarker is linked to the following APIs: \en \- ",
\&       join("\en \- ", @paths), "\en";
\& my @packnames = find_package_for_existing_files("/bin/ls",
\&                 "/bin/bash");
\& print "/bin/ls and /bin/bash are installed via: ",
\&       join(", ", @packnames), "\en";
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module is used by various javahelpers to share common code.
.PP
Please note this \s-1API\s0 is not stable and backwards compatibility is not
guaranteed at the current time. Please contact the maintainers if you
are interested in a stable \s-1API.\s0
.SS "Methods"
.IX Subsection "Methods"
.IP "scan_javadoc($path)" 4
.IX Item "scan_javadoc($path)"
Scans the javadoc at \fB\f(CB$path\fB\fR and returns a list of javadocs it is
linked to on the system.
.Sp
Currently it ignores all javadocs linked via other locations than
\&\fI/usr/share/doc\fR and it also makes an assumption that the linked
javadoc is in /usr/share/doc/<package>/<dir\-or\-symlink>. Of course,
all Java Policy compliant packages provide their javadoc from there.
.Sp
If /usr/share/doc/<package>/<dir\-or\-symlink> appears to be a symlink,
then it is followed (except for default-jdk-doc).
.IP "find_package_for_existing_files(@files)" 4
.IX Item "find_package_for_existing_files(@files)"
Consults \fIdpkg\fR\|(1) to see which packages provides \fB\f(CB@files\fB\fR and
returns this list. All entries in \fB\f(CB@files\fB\fR must exists (but is
not required to be files) and should not be used on a directory.
.Sp
Furthermore all entries must be given with absolute path.
.ie n .IP "parse_manifest_fd($fd, $filename)" 4
.el .IP "parse_manifest_fd($fd, \f(CW$filename\fR)" 4
.IX Item "parse_manifest_fd($fd, $filename)"
Parses a manifest from \fB\f(CB$fd\fB\fR, which must be a readable filehandle,
and returns a
Debian::Javahelper::Manifest.
.Sp
\&\fB\f(CB$filename\fB\fR is only used to report parsing errors and should be
something that identifies the source of \fB\f(CB$fd\fB\fR.
.ie n .IP "write_manifest_fd($manifest, $fd, $filename)" 4
.el .IP "write_manifest_fd($manifest, \f(CW$fd\fR, \f(CW$filename\fR)" 4
.IX Item "write_manifest_fd($manifest, $fd, $filename)"
Writes \fB\f(CB$manifest\fB\fR to the writable filehandle \fB\f(CB$fd\fB\fR. \fB\f(CB$manifest\fB\fR
must be a
Debian::Javahelper::Manifest.
.Sp
\&\fB\f(CB$filename\fB\fR is only used to report errors and should be something
that identifies \fB\f(CB$fd\fB\fR.
.ie n .IP "write_manifest_section_fd($section, $fd, $filename)" 4
.el .IP "write_manifest_section_fd($section, \f(CW$fd\fR, \f(CW$filename\fR)" 4
.IX Item "write_manifest_section_fd($section, $fd, $filename)"
Writes \fB\f(CB$section\fB\fR to the writable filehandle \fB\f(CB$fd\fB\fR. \fB\f(CB$section\fB\fR
must be a
Debian::Javahelper::ManifestSection.
.Sp
\&\fB\f(CB$filename\fB\fR is only used to report errors and should be something
that identifies \fB\f(CB$fd\fB\fR.
.Sp
\&\s-1NB:\s0 Helper \- Not exported.
.IP "slurp_file($file)" 4
.IX Item "slurp_file($file)"
Reads all lines in \fB\f(CB$file\fB\fR and returns them as a list.
.Sp
\&\s-1NB:\s0 Helper \- Not exported.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIDebian::Javahelper::Manifest\fR\|(3)
\&\fIDebian::Javahelper::ManifestSection\fR\|(3)
.SH "AUTHOR"
.IX Header "AUTHOR"
Niels Thykier <niels@thykier.net>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2010 by Niels Thykier
.PP
This module is free software; you may redistribute it and/or modify
it under the terms of \s-1GNU GPL 2.\s0