OS Manuals

/usr/lib/jvm/java-1.8-adoptium/bin/javadoc

OpenJDK 8

From adoptium-openjdk-8 8.512.5-r3 (enterprise-packages), captured 2026-11-08 by running javadoc --help (exit 1). permalink

javadoc: error - invalid flag: --help
Usage: javadoc [options] [packagenames] [sourcefiles] [@files]
  -overview <file>                 Read overview documentation from HTML file
  -public                          Show only public classes and members
  -protected                       Show protected/public classes and members (default)
  -package                         Show package/protected/public classes and members
  -private                         Show all classes and members
  -help                            Display command line options and exit
  -doclet <class>                  Generate output via alternate doclet
  -docletpath <path>               Specify where to find doclet class files
  -sourcepath <pathlist>           Specify where to find source files
  -classpath <pathlist>            Specify where to find user class files
  -cp <pathlist>                   Specify where to find user class files
  -exclude <pkglist>               Specify a list of packages to exclude
  -subpackages <subpkglist>        Specify subpackages to recursively load
  -breakiterator                   Compute first sentence with BreakIterator
  -bootclasspath <pathlist>        Override location of class files loaded
                                   by the bootstrap class loader
  -source <release>                Provide source compatibility with specified release
  -extdirs <dirlist>               Override location of installed extensions
  -verbose                         Output messages about what Javadoc is doing
  -locale <name>                   Locale to be used, e.g. en_US or en_US_WIN
  -encoding <name>                 Source file encoding name
  -quiet                           Do not display status messages
  -J<flag>                         Pass <flag> directly to the runtime system
  -X                               Print a synopsis of nonstandard options and exit

Provided by Standard doclet:
  -d <directory>                   Destination directory for output files
  -use                             Create class and package usage pages
  -version                         Include @version paragraphs
  -author                          Include @author paragraphs
  -docfilessubdirs                 Recursively copy doc-file subdirectories
  -splitindex                      Split index into one file per letter
  -windowtitle <text>              Browser window title for the documentation
  -doctitle <html-code>            Include title for the overview page
  -header <html-code>              Include header text for each page
  -footer <html-code>              Include footer text for each page
  -top    <html-code>              Include top text for each page
  -bottom <html-code>              Include bottom text for each page
  -link <url>                      Create links to javadoc output at <url>
  -linkoffline <url> <url2>        Link to docs at <url> using package list at <url2>
  -excludedocfilessubdir <name1>:.. Exclude any doc-files subdirectories with given name.
  -group <name> <p1>:<p2>..        Group specified packages together in overview page
  -nocomment                       Suppress description and tags, generate only declarations.
  -nodeprecated                    Do not include @deprecated information
  -noqualifier <name1>:<name2>:... Exclude the list of qualifiers from the output.
  -nosince                         Do not include @since information
  -notimestamp                     Do not include hidden time stamp
  -nodeprecatedlist                Do not generate deprecated list
  -notree                          Do not generate class hierarchy
  -noindex                         Do not generate index
  -nohelp                          Do not generate help link
  -nonavbar                        Do not generate navigation bar
  -serialwarn                      Generate warning about @serial tag
  -tag <name>:<locations>:<header> Specify single argument custom tags
  -taglet                          The fully qualified name of Taglet to register
  -tagletpath                      The path to Taglets
  -charset <charset>               Charset for cross-platform viewing of generated documentation.
  -helpfile <file>                 Include file that help link links to
  -linksource                      Generate source in HTML
  -sourcetab <tab length>          Specify the number of spaces each tab takes up in the source
  -keywords                        Include HTML meta tags with package, class and member info
  -stylesheetfile <path>           File to change style of the generated documentation
  -docencoding <name>              Specify the character encoding for the output
1 error
Options (68)
OptionDescriptionSource
-overview fileSpecifies that the javadoc command should retrieve the text for the overview documentation from the source file specified by the path/filenameand place it on the Overview page (overview-summary.html).help + man
-publicShows only public classes and members.help + man
-protectedShows only protected and public classes and members.help + man
-packageShows only package, protected, and public classes and members.help + man
-privateShows all classes and members.help + man
-helpDisplays the online help, which lists all of the javadoc and doclet command-line options.help + man
-doclet classSpecifies the class file that starts the doclet used in generating the documentation.help + man
-docletpath pathSpecifies the path to the doclet starting class file (specified with the -doclet option) and any JAR files it depends on.help + man
-sourcepath pathlistSpecifies the search paths for finding source files when passing package names or the -subpackages option into the javadoc command.help + man
-classpath pathlistSpecifies the paths where the javadoc command searches for referenced classes These are the documented classes plus any classes referenced by those classes.help + man
-cp pathlistSpecify where to find user class fileshelp
-exclude pkglistUnconditionally excludes the specified packages and their subpackages from the list formed by -subpackages.help + man
-subpackages subpkglistGenerates documentation from source files in the specified packages and recursively in their subpackages.help + man
-breakiteratorUses the internationalized sentence boundary of java.text.BreakIterator to determine the end of the first sentence in the main description of a package, class, or member for English.help + man
-bootclasspath pathlistOverride location of class files loaded by the bootstrap class loaderhelp + man
-source releaseProvide source compatibility with specified releasehelp + man
-extdirs dirlistSpecifies the directories where extension classes reside.help + man
-verboseProvides more detailed messages while the javadoc command runs.help + man
-locale nameSpecifies the locale that the javadoc command uses when it generates documentation.help + man
-encoding nameSpecifies the encoding name of the source files, such as EUCJIS/SJIS.help + man
-quietShuts off messages so that only the warnings and errors appear to make them easier to view.help + man
-J flagPass <flag> directly to the runtime systemhelp
-XPrint a synopsis of nonstandard options and exithelp
-d directorySpecifies the destination directory where the javadoc command saves the generated HTML files.help + man
-useIncludes one Use page for each documented class and package.help + man
-versionIncludes the @version text in the generated docs.help + man
-authorIncludes the @author text in the generated docs.help + man
-docfilessubdirsRecursively copy doc-file subdirectorieshelp
-splitindexSplits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical symbols.help + man
-windowtitle textSpecifies the title to be placed in the HTML <title> tag.help + man
-doctitle html-codeSpecifies the title to place near the top of the overview summary file.help + man
-header html-codeSpecifies the header text to be placed at the top of each output file.help + man
-footer html-codeSpecifies the footer text to be placed at the bottom of each output file.help + man
-topSpecifies the text to be placed at the top of each output file.help + man
-bottom html-codeSpecifies the text to be placed at the bottom of each output file.help + man
-link urlCreates links to existing Javadoc-generated documentation of externally referenced classes.help + man
-linkoffline urlLink to docs at <url> using package list at <url2>help + man
-group nameSeparates packages on the overview page into whatever groups you specify, one group per table.help + man
-nocommentSuppresses the entire comment body, including the main description and all tags, and generate only declarations.help + man
-nodeprecatedPrevents the generation of any deprecated API in the documentation.help + man
-nosinceOmits from the generated documents the Since sections associated with the @since tags.help + man
-notimestampSuppresses the time stamp, which is hidden in an HTML comment in the generated HTML near the top of each page.help + man
-nodeprecatedlistPrevents the generation of the file that contains the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.help + man
-notreeOmits the class/interface hierarchy pages from the generated documents.help + man
-noindexOmits the index from the generated documents.help + man
-nohelpOmits the HELP link in the navigation bars at the top and bottom of each page of output.help + man
-nonavbarPrevents the generation of the navigation bar, header, and footer, that are usually found at the top and bottom of the generated pages.help + man
-serialwarnGenerates compile-time warnings for missing @serial tags.help + man
-taglet classSpecifies the class file that starts the taglet used in generating the documentation for that tag.help + man
-tagletpath tagletpathlistSpecifies the search paths for finding taglet class files.help + man
-charset charsetCharset for cross-platform viewing of generated documentation.help + man
-helpfile fileSpecifies the path of an alternate help file pathfilename that the HELP link in the top and bottom navigation bars link to.help + man
-linksourceCreates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.help + man
-sourcetab tabSpecify the number of spaces each tab takes up in the sourcehelp + man
-keywordsAdds HTML keyword <META> tags to the generated file for each class.help + man
-stylesheetfile pathFile to change style of the generated documentationhelp
-docencoding nameSpecifies the encoding of the generated HTML files.help + man
-Xdoclint none• (in the manual page but not in --help)man
-Xdoclintgroup :• (in the manual page but not in --help)man
-1.1Removed from Javadoc 1.4 with no replacement. (in the manual page but not in --help)man
-JflagPasses flag directly to the Java Runtime Environment (JRE) that runs the javadoc command. (in the manual page but not in --help)man
-javafxGenerates HTML documentation using the JavaFX extensions to the standard doclet. (in the manual page but not in --help)man
-title titleNo longer exists. (in the manual page but not in --help)man
-stylesheet path/filenameSpecifies the path of an alternate HTML stylesheet file. (in the manual page but not in --help)man
-tag tagname:Xaoptcmf:"taghead"Enables the javadoc command to interpret a simple, one-argument @tagname custom block tag in documentation comments. (in the manual page but not in --help)man
-docfilesubdirsEnables deep copying of doc-files directories. (in the manual page but not in --help)man
-excludedocfilessubdir name1:name2Excludes any doc-files subdirectories with the specified names. (in the manual page but not in --help)man
-noqualifier allOmits qualifying package names from class names in output. (in the manual page but not in --help)man

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.