summaryrefslogtreecommitdiffstats
path: root/doc/man/rbuic.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/rbuic.1')
-rw-r--r--doc/man/rbuic.164
1 files changed, 64 insertions, 0 deletions
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)