Add man pages for TDE applications

Signed-off-by: Michele Calgaro <[email protected]>

2 files changed, 72 insertions, 0 deletions

diff --git a/doc/man/kuiviewer/CMakeLists.txt b/doc/man/kuiviewer/CMakeLists.txt
new file mode 100644
index 00000000..24ccd704
--- /dev/null
+++ b/doc/man/kuiviewer/CMakeLists.txt
@@ -0,0 +1,7 @@
+file( GLOB _man_files RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.1 )
+
+INSTALL(
+    FILES ${_man_files}
+    DESTINATION ${MAN_INSTALL_DIR}/man1
+    COMPONENT doc
+)
diff --git a/doc/man/kuiviewer/kuiviewer.1 b/doc/man/kuiviewer/kuiviewer.1
new file mode 100644
index 00000000..5439127a
--- /dev/null
+++ b/doc/man/kuiviewer/kuiviewer.1
@@ -0,0 +1,65 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH KUIVIEWER 1 "March 25, 2005"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+kuiviewer \- a viewer for Qt Designer user interface files
+.SH SYNOPSIS
+.B kuiviewer
+.RI "[ " generic-options " ]"
+.RI "[ " ui-file ... " ]"
+.PP
+.B kuiviewer
+.RI "[ " generic-options " ]"
+{ \fB\-s, \-\-takescreenshot\fP \fIfilename\fP }
+[ \fB\-w, \-\-screenshotwidth\fP \fIint\fP ]
+[ \fB\-h, \-\-screenshotheight\fP \fIint\fP ]
+.I ui-file
+.SH DESCRIPTION
+\fBKUIViewer\fP is a utility to display and test the user interface (.ui)
+files generated by \fBQt Designer\fP.  The interfaces can be displayed in a
+variety of different widget styles.
+.PP
+Normally KUIViewer launches a full GUI, allowing the user to interact with
+the given interface.
+By passing the \fB\-\-takescreenshot\fP option, you can make KUIViewer dump a
+screenshot of the interface instead and exit immediately.  Other options
+are available to control precisely how this screenshot is constructed.
+.PP
+This application is part of the TDE Software Development Kit.
+.SH OPTIONS
+Below are the kuiviewer-specific options.
+For a full summary of options, run \fIkuiviewer \-\-help\fP.
+.TP
+\fB\-s, \-\-takescreenshot\fP \fIfilename\fP
+Take a screenshot of the given interface and exit immediately.
+The \fIfilename\fP argument specifies where the screenshot will be saved.
+This screenshot will be saved in PNG format.
+.TP
+\fB\-w, \-\-screenshotwidth\fP \fIint\fP
+Before taking a screenshot, resize the interface to the given width.
+.TP
+\fB\-h, \-\-screenshotheight\fP \fIint\fP
+Before taking a screenshot, resize the interface to the given height.
+.SH SEE ALSO
+.BR designer (1).
+.SH AUTHOR
+KUIViewer was written by Richard Moore <[email protected]>,
+Ian Reinhart Geiser <[email protected]> and
+Benjamin C. Meyer <[email protected]>.
+.br
+This manual page was prepared by Ben Burton <[email protected]>
+for the Debian GNU/Linux system (but may be used by others).