qt2kdoc(1) [redhat man page]

QT2KDOC(1)						     KDOC Documentation System							QT2KDOC(1)

NAME

       qt2kdoc -- Generates cross-reference file suitable for use with KDOC from Qt Toolkit HTML documentation.

SYNOPSIS

	       qt2kdoc [-u URL] [-o <destdir>] [-z] <path to qt html>

DESCRIPTION

       qt2kdoc generates a kdoc(1) cross-reference file from  the classes.html file that is included with the Qt GUI Toolkit HTML documentation.

       The resulting file can be used to cross-reference documentation generated with KDOC for other classes with the Qt HTML documentation.

OPTIONS

       --url <url>, -u <url>
	   The URL  by	which  the  Qt	documentation  can  be accessed.  This	will allow other libraries to link to the Qt documentation.

       --outdir <path>, -o <path>
	   The directory where the generated index file will be written.

       --compress, -z
	   Compress the generated index with gzip. KDOC can read these compressed index files.

EXAMPLES

	       qt2kdoc -u "http://www.mydomain/src/qthtml/" 
		       $HOME/web/src/qthtml

ENVIRONMENT

       KDOCLIBS
	   If set, it is used as the default output path. It is overridden by the --outdir option.

FILES

       classes.html, functions.html
	   The files from which information about the Qt library is read. They are parsed by qt2kdoc.

       qt.kdoc
	   A kdoc(1) cross-reference file that will be	generated  by qt2kdoc and can be used to link documentation generated by kdoc with the Qt
	   documentation.

SEE ALSO

       This script is a utility for kdoc(1).

BUGS

       Dependent on format of Qt documentation.

AUTHOR

       Sirtaj S. Kang <taj@kde.org>, 1998.

2.0a54								    2002-03-18								QT2KDOC(1)

monodoc(1)                                                    General Commands Manual                                                   monodoc(1)

NAME

       monodoc - GUI Mono documentation browser

SYNOPSIS

       monodoc [options]

DESCRIPTION

       monodoc is a GTK#-based browser for viewing collected API documentation for CLI libraries installed on the system

RUNTIME 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-ecma DOCFILE 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

       SEE ALSO
              mono(1), mdassembler(1), mdcs2ecma(1), mdnormalizer(1), mdvalidator(1), monodocs2html(1), monodocer(1)

                                                                                                                                        monodoc(1)