DragonFly On-Line Manual Pages

ceylon doc-tool(1)                                          ceylon doc-tool(1)

NAME
       ceylon doc-tool - Generates documentation about a tool

SYNOPSIS
       ceylon doc-tool
[--all-plumbing] [--all-porcelain] [--cwd=dir] [--format=format] [--index]
[--omit-doctype] [--output=dir] [--verbose[=flags]] [--width=cols] [--]
[tool]...

DESCRIPTION
       Generates documentation about the named <tool>s in the directory named
       by the --output option.

OPTIONS
       --all-plumbing
              Generate documentation about all low level tools, in addition to
              the tools named by the <tool> argument

       --all-porcelain
              Generate documentation about all high level tools, in addition
              to the tools named by the <tool> argument

       --cwd=dir
              Specifies the current working directory for this tool. (default:
              the directory where the tool is run from)

       --format=format
              The format to generate the documentation in (allowable values:
              html, docbook or txt, default: html)

       --index
              Generate an index.html file when --format=html

       --omit-doctype
              Omit the doctype when outputting XML-based formats

       --output=dir, -o dir
              Directory to generate the output files in (default: The current
              directory)

       --verbose[=flags], -d
              Produce verbose output. If no flags are given then be verbose
              about everything, otherwise just be verbose about the flags
              which are present. Allowed flags include: all, loader.

       --width=cols
              The line length to use for word wrapping when --format=txt
              (default: 80)

SEE ALSO
       o ceylon help For generating help about ceylon tools at the command
         line

       o ceylon doc For generating API documentation about ceylon modules

                                28 October 2015             ceylon doc-tool(1)