Add man pages for TDE applications.

Signed-off-by: Michele Calgaro <michele.calgaro@yahoo.it>
(cherry picked from commit 98fd2a511b0216d502dc0de19c04e06c4b2dd1d2)

12 files changed, 313 insertions, 0 deletions

diff --git a/doc/Makefile.am b/doc/Makefile.am
new file mode 100644
index 00000000..5c0b20ee
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1,3 @@
+KDE_LANG = en
+KDE_DOCS = AUTO
+SUBDIRS = $(AUTODIRS)
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
new file mode 100644
index 00000000..ad36d631
--- /dev/null
+++ b/doc/man/Makefile.am
@@ -0,0 +1,4 @@
+tmpdir = $(mandir)/man1
+tmp_DATA = dcopidl2java.1 juic.1 kjscmd.1 krubyinit.1 qtrubyinit.1 \
+rbqtapi.1 rbqtsh.1 rbtdeapi.1 rbtdesh.1 rbuic.1
+EXTRA_DIST=$(tmp_DATA)
diff --git a/doc/man/dcopidl2java.1 b/doc/man/dcopidl2java.1
new file mode 100644
index 00000000..926d7839
--- /dev/null
+++ b/doc/man/dcopidl2java.1
@@ -0,0 +1,28 @@
+.TH LIBDCOP-JAVA 1 "July 31, 2002"
+.SH NAME
+dcopidl2java \- Convert a DCOP IDL file to Java language stubs
+.SH SYNOPSIS
+.B dcopidl2java
+.RI " [ " --no-skel " ]  [ " --no-stub " ]  [ " --package " " java-package " ] " file
+.SH DESCRIPTION
+This manual page documents briefly the
+.B dcopidl2java
+command.
+.PP
+\fBdcopidl2java\fP is a program that generates Java stubs from a DCOP IDL file,
+for use with the libdcop-java Java DCOP bindings.
+
+.SH OPTIONS
+A summary of options is included below.
+.TP
+.B --no-skel
+Do not generate skeleton code.
+.TP
+.B --no-stub
+Do not generate stub implementation code.
+.TP
+.B --package java-package 
+Set the name of the Java package to use in the generated code.
+.SH AUTHOR
+This manual page was written by Peter Hawkins <peterh@debian.org>
+for the Debian GNU/Linux system (but may be used by others).
diff --git a/doc/man/juic.1 b/doc/man/juic.1
new file mode 100644
index 00000000..9120f44d
--- /dev/null
+++ b/doc/man/juic.1
@@ -0,0 +1,39 @@
+.TH JUIC 1 "Apr 2004" "Trinity Desktop Environment" "Qt Java UI Compiler Manual"
+.SH NAME
+juic \- The Qt Java UI Compiler
+.SH SYNOPSIS
+.B juic
+[options] uifile
+.SH DESCRIPTION
+Juic is the Qt Java UI Compiler.  It generates Java\*(tm code from a
+XML UI Description file.  This XML UI Description file can be
+generated by Qt Designer, Qt's graphical UI designer.  Juic is the
+Java\*(tm equivalent for the C++ uic program.
+
+Juic generates Java code for the Qt UI Description File passed to it,
+and outputs it on standard output.
+.SH OPTIONS
+.TP
+.B \-proc   <xsltproc|xalan|saxon>
+Tells juic which xslt processor to use internally.  Possible values
+are "xsltproc", "xalan", "saxon".  The processor you specify must be
+available in the PATH or juic will give an error.  The default is to
+use xsltproc if it's available, and use saxon otherwise.
+.TP
+.B \-package   <the.package.for.the.class>
+Tells juic to add the given package declaration to the generated java
+class.
+.TP
+.B \-abstract   <true|false>
+Tells juic whether or not to define slots as abstract.
+.TP
+.B \-images   <dir>
+Tells juic where to find the images used in the given ui file.
+Default is "images".
+.TP
+.B \-os   <unix|msdos|mac>
+Tells juic what newline style to use in the generated java file.  Possible values are "unix", "msdos" and "mac", for UNIX, DOS and MacOS style newlines respectively.
+.SH AUTHOR
+Marco Ladermann
+.SH SEE ALSO
+uic(1)
diff --git a/doc/man/kjscmd.1 b/doc/man/kjscmd.1
new file mode 100644
index 00000000..c0765aeb
--- /dev/null
+++ b/doc/man/kjscmd.1
@@ -0,0 +1,34 @@
+.TH "kjscmd" 1
+.SH NAME
+kjscmd \- A tool for running KJSEmbed scripts from the command line
+.SH SYNOPSIS
+.B kjscmd
+kjscmd [Qt-options] [TDE-options] [options] [file]
+.SH DESCRIPTION
+kjscmd is a tool for launching KJSEmbed scripts from the command line, and
+can also provide a console for running commands interactively. It will run
+the named file using KJSEmbed (or read a file from stdin if '-' is
+specified).
+.SH OPTIONS
+.TP
+.B \-\-console \-c
+Enables the graphical console. The console will not be visible unless the
+script enters the event loop or the --exec parameter is used. If no script
+was specified on the command line then the event loop is entered
+automatically.
+.TP
+.B \-\-interactive \-i
+Enables the interactive command line prompt.
+.TP
+.B \-\-exec
+Tells kjscmd to enter the event loop after executing the script. This option
+is rarely used, but it can be handy if you want to use the console to examine
+the state of the interpreter after a non-graphical script has executed.
+.TP
+.B \-\-nogui
+Tells kjscmd not to create an X connection. This allows you to use scripts
+without needing an X server (though with reduced functionality).
+.SH BUGS
+There are probably lots of bugs. Use http://bugs.trinitydesktop.org/ to report them.
+
+
diff --git a/doc/man/krubyinit.1 b/doc/man/krubyinit.1
new file mode 100644
index 00000000..f8a40545
--- /dev/null
+++ b/doc/man/krubyinit.1
@@ -0,0 +1,25 @@
+.TH KRUBYINIT 1 "Aug 2004" "Trinity Desktop Environment" "KRubyInit Manual"
+.SH NAME
+krubyinit \- Start Korundum Ruby Scripts Faster
+.SH SYNOPSYS
+.B krubyinit
+[switches] [--] [programfile] [arguments]
+.SH DESCRIPTION
+Krubyinit is a wrapper around the ruby interpreter for executing Ruby
+scripts using the Korundum library ( the Ruby TDE bindings ).  It uses
+the tdeinit system to start the app so that they start a little bit
+faster when started in a running TDE session.
+
+The script takes exactly the same options as the ruby(1) program.
+Therefore, its options aren't documented here, please refer to the
+ruby(1) manpage.
+
+This script is part of Korundum, which is part of the TDE Bindings
+module.
+.SH OPTIONS
+Krubyinit takes exactly the same options as the ruby(1) program and
+they have exactly the same meaning.  Please refer to its manpage.
+.SH AUTHOR
+Alexander Kellett
+.SH SEE ALSO
+ruby(1)
diff --git a/doc/man/qtrubyinit.1 b/doc/man/qtrubyinit.1
new file mode 100644
index 00000000..1ab6e7f2
--- /dev/null
+++ b/doc/man/qtrubyinit.1
@@ -0,0 +1,25 @@
+.TH QTRUBYINIT 1 "Aug 2004" "Trinity Desktop Environment" "QtRubyInit Manual"
+.SH NAME
+qtrubyinit \- Start Qt Ruby Scripts Faster
+.SH SYNOPSYS
+.B qtrubyinit
+[switches] [--] [programfile] [arguments]
+.SH DESCRIPTION
+Qtrubyinit is a wrapper around the ruby interpreter for executing Ruby
+scripts using the QtRuby library.  It uses the tdeinit system to start
+the app so that they start a little bit faster when started in a
+running TDE session.
+
+The script takes exactly the same options as the ruby(1) program.
+Therefore, its options aren't documented here, please refer to the
+ruby(1) manpage.
+
+This script is part of QtRuby, which is part of the TDE Bindings
+module.
+.SH OPTIONS
+Qtrubyinit takes exactly the same options as the ruby(1) program and
+they have exactly the same meaning.  Please refer to its manpage.
+.SH AUTHOR
+Alexander Kellett
+.SH SEE ALSO
+ruby(1)
diff --git a/doc/man/rbqtapi.1 b/doc/man/rbqtapi.1
new file mode 100644
index 00000000..7cafb5b8
--- /dev/null
+++ b/doc/man/rbqtapi.1
@@ -0,0 +1,29 @@
+.TH RBQTAPI 1 "Aug 2004" "Trinity Desktop Environment" "Qt Ruby Bindings Manual"
+.SH NAME
+rbqtapi \- A QtRuby Introspection Tool
+.SH SYNOPSIS
+.B rbqtapi
+[options] [<class>]
+.SH DESCRIPTION
+Rbqtapi is a QtRuby Introspection Tool, similar to javap(1).  Use it
+to find a list of method for a certain QtRuby class.
+.SH OPTIONS
+.TP 
+.B \-r <re>
+Find all functions matching regular expression/keyword <re>
+.TP
+.B \-i
+Perform a case insensitive search ( only meaningful in combination with -r )
+.TP
+.B \-p
+Display also inherited methods.
+.TP
+.B \-v
+Print QtRuby and Qt versions.
+.TP
+.B \-h
+Print a help message.
+.SH AUTHOR
+Alexander Kellett
+.SH SEE ALSO
+rbtdeapi(1)
diff --git a/doc/man/rbqtsh.1 b/doc/man/rbqtsh.1
new file mode 100644
index 00000000..bda49d96
--- /dev/null
+++ b/doc/man/rbqtsh.1
@@ -0,0 +1,16 @@
+.TH RBQTSH 1 "Aug 2004" "Trinity Desktop Environment" "Qt Ruby Bindings Manual"
+.SH NAME
+rbqtsh \- An Interactive QtRuby Shell
+.SH SYNOPSIS
+.B rbqtsh
+[options]
+.SH DESCRIPTION
+Rbqtsh is an interactive QtRuby shell.  It shows a GUI dialog box
+where you can enter Ruby code using the QtRuby library.
+.SH OPTIONS
+This program takes no options.
+.SH AUTHOR
+Germain Garand
+Alexander Kellett
+.SH SEE ALSO
+rbtdesh(1)
diff --git a/doc/man/rbtdeapi.1 b/doc/man/rbtdeapi.1
new file mode 100644
index 00000000..e3d16622
--- /dev/null
+++ b/doc/man/rbtdeapi.1
@@ -0,0 +1,29 @@
+.TH RBTDEAPI 1 "Aug 2004" "Trinity Desktop Environment" "Korundum TDE Ruby Bindings Manual"
+.SH NAME
+rbtdeapi \- A Korundum TDE Ruby Introspection Tool
+.SH SYNOPSIS
+.B rbtdeapi
+[options] [<class>]
+.SH DESCRIPTION
+Rbtdeapi is a Korundum TDE Ruby Introspection Tool, similar to
+javap(1).  Use it to find a list of method for a certain Korundum class.
+.SH OPTIONS
+.TP 
+.B \-r <re>
+Find all functions matching regular expression/keyword <re>
+.TP
+.B \-i
+Perform a case insensitive search ( only meaningful in combination with -r )
+.TP
+.B \-p
+Display also inherited methods.
+.TP
+.B \-v
+Print QtRuby and Qt versions.
+.TP
+.B \-h
+Print a help message.
+.SH AUTHOR
+Alexander Kellett
+.SH SEE ALSO
+rbqtapi(1)
diff --git a/doc/man/rbtdesh.1 b/doc/man/rbtdesh.1
new file mode 100644
index 00000000..6e792e7f
--- /dev/null
+++ b/doc/man/rbtdesh.1
@@ -0,0 +1,17 @@
+.TH RBTDESH 1 "Aug 2004" "Trinity Desktop Environment" "Korundum TDE Ruby Bindings Manual"
+.SH NAME
+rbtdesh \- An Interactive Korundum Shell
+.SH SYNOPSIS
+.B rbtdesh
+[options]
+.SH DESCRIPTION
+Rbtdesh is an interactive Korundum shell.  It shows a GUI dialog box
+where you can enter Ruby code using the Korundum TDE Ruby bindings
+library.
+.SH OPTIONS
+This program takes no options.
+.SH AUTHOR
+Germain Garand
+Alexander Kellett
+.SH SEE ALSO
+rbqtsh(1)
diff --git a/doc/man/rbuic.1 b/doc/man/rbuic.1
new file mode 100644
index 00000000..d59caa1a
--- /dev/null
+++ b/doc/man/rbuic.1
@@ -0,0 +1,64 @@
+.TH RBUIC 1 "Apr 2004" "Trinity Desktop Environment" "Qt Ruby UI Compiler Manual"
+.SH NAME
+rbuic \- The Qt Ruby UI Compiler
+.SH SYNOPSIS
+Generate implementation:
+.B rbuic
+[options] uifile
+.LP
+Generate subclass implementation:
+.B rbuic
+[options] -subimpl <classname> <uifile>
+.LP
+Generate image collection:
+.B rbuic
+[options] -embed <project> <image1> <image2> <image3> ...
+.SH DESCRIPTION
+Rbuic is the Qt Ruby UI Compiler.  It generates Ruby code from a XML
+UI Description file.  This XML UI Description file can be generated by
+Qt Designer, Qt's graphical UI designer.  Rbuic is the Ruby equivalent
+for the C++ uic program.
+
+When invoked to generate an implementation, rbuic generates Ruby code
+for the Qt UI Description File passed to it, and outputs it on
+standard output.
+
+When invoked to generate a subclass implementation, rbuic generates
+template Ruby code for a subclass of the widget in the Qt UI
+Description File passed to it, and outputs it on standard output.
+
+When invoked to generate an image collection, rbuic generates Ruby
+code containing the image data in strings.  This is useful to avoid
+having to distribute image files along with your application.  It is
+arguably more useful for C++ ( where the image strings can be compiled
+into an executable ), but still, it is available for Ruby as well.
+.SH OPTIONS
+.TP
+.B \-o <file>
+Write output to file rather than stdout.
+.TP
+.B \-p <indent>
+Set the indent in spaces (0 to use a tab)
+.TP
+.B \-nofwd
+Omit imports of custom widgets
+.TP
+.B \-kde
+Use TDE widgets, require 'Korundum' extension
+.TP
+.B \-tr <func>
+Use func(...) rather than trUtf8(...) for i18n
+.TP
+.B \-x
+Generate extra code to test the class
+.TP
+.B \-version
+Print the Rbuic and Qt versions
+.TP
+.B \-help
+Display some help information.
+.SH AUTHOR
+Germain Garand
+Phil Thompson
+.SH SEE ALSO
+uic(1)