[Pkg-mono-svn-commits] rev 4000 - mono-tools/trunk/debian

[Jo Shields]

Author: directhex-guest
Date: 2009-06-10 18:42:45 +0000 (Wed, 10 Jun 2009)
New Revision: 4000

Added:
   mono-tools/trunk/debian/monodoc-browser.manpages
   mono-tools/trunk/debian/monodoc.1
Modified:
   mono-tools/trunk/debian/changelog
Log:
  * debian/monodoc.1,
    debian/monodoc-browser.manpages:
    + Provide a manpage for the "monodoc" command


Modified: mono-tools/trunk/debian/changelog
===================================================================
--- mono-tools/trunk/debian/changelog	2009-06-05 06:30:26 UTC (rev 3999)
+++ mono-tools/trunk/debian/changelog	2009-06-10 18:42:45 UTC (rev 4000)
@@ -1,3 +1,11 @@
+mono-tools (2.0-4) UNRELEASED; urgency=low
+
+  * debian/monodoc.1,
+    debian/monodoc-browser.manpages:
+    + Provide a manpage for the "monodoc" command
+
+ -- Jo Shields <directhex at apebox.org>  Wed, 10 Jun 2009 19:42:00 +0100
+
 mono-tools (2.0-3) unstable; urgency=low
 
   [ Jo Shields ]

Added: mono-tools/trunk/debian/monodoc-browser.manpages
===================================================================
--- mono-tools/trunk/debian/monodoc-browser.manpages	                        (rev 0)
+++ mono-tools/trunk/debian/monodoc-browser.manpages	2009-06-10 18:42:45 UTC (rev 4000)
@@ -0,0 +1 @@
+debian/monodoc.1

Added: mono-tools/trunk/debian/monodoc.1
===================================================================
--- mono-tools/trunk/debian/monodoc.1	                        (rev 0)
+++ mono-tools/trunk/debian/monodoc.1	2009-06-10 18:42:45 UTC (rev 4000)
@@ -0,0 +1,61 @@
+.\" Generated by help2man 1.36.
+.\" Modified by Jo Shields <directhex at 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)