1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
.\" Generated by help2man 1.36.
.\" Modified by Jo Shields <directhex@apebox.org>
.TH monodoc "1"
.SH NAME
monodoc \- GUI Mono documentation browser
.SH SYNOPSIS
monodoc [options]
.SH DESCRIPTION
\fImonodoc\fP is a GTK#-based browser for viewing collected API documentation
for CLI libraries installed on the system
.SH RUNTIME OPTIONS
.SS "The following options are available for browsing documentation:"
.TP
TOPIC
Start the browser at TOPIC
.IP
(ex. N:System, T:System.Object, M:System.Object.Equals,
and P: for properties, F: for fields, E: for events, etc.)
.TP
\fB\-\-help\fR
Print a brief instructions on usage
.TP
\fB\-\-about\fR
About the monodoc browser
.TP
\fB\-\-html\fR TOPIC
Print the HTML contents of TOPIC
.TP
\fB\-\-make\-index\fR
Create the documentation index
.TP
\fB\-\-make\-search\-index\fR
Create the searchable documentation index
.TP
\fB\-\-engine\fR
Select a browser backend
(Gecko, GtkHtml, WebKit, MonoWebBrowser)
.SS "The following options are available for authoring documentation:"
.TP
\fB\-\-assemble\fR
Runs the doc assembler
.TP
\fB\-\-cs\-to\-ecma\fR DOCFILE ASSEMBLY OUTPUT LIBRARY\-NAME
Converts C# documentation to Monodoc format
.TP
\fB\-\-edit\fR path
Edit (unassembled) documentation at path
.TP
\fB\-\-get\-sourcesdir\fR
Prints the location of monodoc sources
.HP
\fB\-\-merge\-changes\fR CHANGE_FILE [TARGET_DIR]
.TP
\fB\-\-normalize\fR
Format a documentation file consistently
.TP
\fB\-\-validate\fR
Validate the XML files
.TP
.SH SEE ALSO
mono(1), mdassembler(1), mdcs2ecma(1), mdnormalizer(1), mdvalidator(1), monodocs2html(1), monodocer(1)
|
