JH_INSTALLJAVADOC(1)

💖 JH_INSTALLJAVADOC — the javahelper girlies' guide to yeeting javadoc into your packages 💖

okay bestie, so this one lives in the Javahelper manual set, section 1 (that's the "commands you actually type" section, slay). Buckle up, it's a short one but it's iconic.

---

✨ NAME ✨

jh_installjavadoc — install javadoc into packages

like. that's it. that's the whole job. no cap. 🎀

---

✨ SYNOPSIS ✨

jh_installjavadoc [debhelper options]

jh_installjavadoc [debhelper options] [-ppackage] [base-directory-of-
javadoc] [install-location]

two whole moods. pick your fighter. 💅

---

✨ DESCRIPTION ✨

so jh_installjavadoc is a javahelper program, and it's the one that installs your generated javadoc for you. it's basically your doc-handling bestie who shows up, does the thing, and registers it properly while you go touch grass. 🦋

if you've got javadoc that your build system already built, jh_installjavadoc will install it in the correct location and register it with doc-base for you. and you have two ways to tell it where that javadoc is:

• just run jh_installjavadoc with the directory containing the javadoc as a parameter, or
• let it read debian/package.javadoc or debian/javadoc, which should contain a single path to the javadoc for that package.

now if you've used jh_build(1), plot twist, that will have automatically created javadoc for you already. 🤯 to install that, you put the string "internal" in the javadoc file and it will be installed. yes, literally the word. iconic behavior.

the second parameter, or the second string on the line in the javadoc file, exists to override the install location — for example, so that a -doc package can install to /usr/share/doc/library/api. sometimes the default location just is not giving what it needs to give. 🙈

---

✨ FILES ✨

🌸 debian/package.javadoc, debian/javadoc

these get parsed to determine which javadoc directory should be processed for the given package.

⚠️ bestie, listen — unlike most other debhelper commands, jh_installjavadoc will use debian/javadoc as a fallback configuration file for all packages that it acts on. other debhelper commands usually only apply this fallback to the "main package". so this is not like the other girls, and that is by design. 💀

the file consists of a single line listing the javadoc directory (or the word "internal"). this is optionally followed path the path to the desired install location if the default location is incorrect. ✨

examples, as promised:

internal

build/javadoc /usr/share/doc/somewhere/libapi

---

✨ OPTIONS ✨

• -Aauthor, --author=author — here it is, the one option this page lists by its lonesome. (the manpage keeps the description to itself, so we're keeping it company without spilling any tea we don't have. 🫶)

beyond the above, jh_installjavadoc also accepts the shared debhelper options documented in debhelper(7). go read that one, it's a whole saga. 📚

---

✨ SEE ALSO ✨

• debhelper(7)

this program is a part of javahelper and uses debhelper as backend. there are also tutorials in /usr/share/doc/javahelper. ⭐

---

✨ AUTHOR ✨

Niels Thykier <niels@thykier.net> 👑

---

💜 THE SIGN-OFF 💜

and that's the whole page, bestie. this is version 0.82, dated 2026-05-17, from the Javahelper source. thanks for reading, go install some javadoc, and remember: doc-base registration is self-care. periodt. 💅✨🌈