monodoc1
Gui mono documentation browser
Usage
monodoc [options]
Overview
monodoc is a GTK#-based browser for viewing collected API documentation for CLI libraries installed on the system
Options
The following options are available for browsing documentation:
- TOPIC
-
Start the browser at TOPIC
-
(ex. N:System, T:System.Object, M:System.Object.Equals, and P: for properties, F: for fields, E: for events, etc.)
-
--help -
Print a brief instructions on usage
-
--about -
About the monodoc browser
-
--html TOPIC -
Print the HTML contents of TOPIC
-
--make-index -
Create the documentation index
-
--make-search-index -
Create the searchable documentation index
-
--engine -
Select a browser backend (Gecko, GtkHtml, WebKit, MonoWebBrowser)
The following options are available for authoring documentation:
-
--assemble -
Runs the doc assembler
--cs-to-ecmaDOCFILE ASSEMBLY OUTPUT LIBRARY-NAME-
Converts C# documentation to Monodoc format
-
--edit path -
Edit (unassembled) documentation at path
-
--get-sourcesdir -
Prints the location of monodoc sources
--merge-changes CHANGE_FILE [TARGET_DIR]
-
--normalize -
Format a documentation file consistently
-
--validate -
Validate the XML files
Releases
6 releases since Debian 4.0 (Etch); the text changed 1 time.
--about since Debian 6.0 (Squeeze);
--assemble since Debian 6.0 (Squeeze);
--edit since Debian 6.0 (Squeeze);
--engine since Debian 6.0 (Squeeze);
--get-sourcesdir since Debian 6.0 (Squeeze);
--help since Debian 6.0 (Squeeze);
--html since Debian 6.0 (Squeeze);
--make-index since Debian 6.0 (Squeeze);
--make-search-index since Debian 6.0 (Squeeze);
--normalize since Debian 6.0 (Squeeze);
--validate since Debian 6.0 (Squeeze).