GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  CEYLON-DOC-TOOL (1)

NAME

ceylon doc-tool - Generates documentation about a tool

CONTENTS

Synopsis
Description
Options

SYNOPSIS

ceylon doc-tool \kx [--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
Search for    or go to Top of page |  Section 1 |  Main Index


CEYLON DOC-TOOL (1) 10 February 2016

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.