diff options
Diffstat (limited to 'doc/man/kommander')
| -rw-r--r-- | doc/man/kommander/CMakeLists.txt | 11 | ||||
| -rw-r--r-- | doc/man/kommander/extractkmdr.1 | 53 | ||||
| -rw-r--r-- | doc/man/kommander/kmdr-editor.1 | 70 | ||||
| -rw-r--r-- | doc/man/kommander/kmdr-executor.1 | 87 | ||||
| -rw-r--r-- | doc/man/kommander/kmdr-plugins.1 | 71 | ||||
| -rw-r--r-- | doc/man/kommander/kmdr2po.1 | 47 |
6 files changed, 339 insertions, 0 deletions
diff --git a/doc/man/kommander/CMakeLists.txt b/doc/man/kommander/CMakeLists.txt new file mode 100644 index 00000000..92110a2d --- /dev/null +++ b/doc/man/kommander/CMakeLists.txt @@ -0,0 +1,11 @@ +INSTALL( + FILES + kmdr2po.1 + kmdr-executor.1 + extractkmdr.1 + kmdr-editor.1 + kmdr-plugins.1 + + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/kommander/extractkmdr.1 b/doc/man/kommander/extractkmdr.1 new file mode 100644 index 00000000..5dfad28d --- /dev/null +++ b/doc/man/kommander/extractkmdr.1 @@ -0,0 +1,53 @@ +.\" 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 EXTRACTKMDR 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 +extractkmdr \- extract message strings from Kommander dialogs +.SH SYNOPSIS +.B extractkmdr +[ \fB\-\-tag=\fP\fIname\fP ... ] +[ \fB\-\-context=\fP\fIname\fP ] +\fIfile\fP ... +.SH DESCRIPTION +\fBextractkmdr\fP finds all text tags and other message strings within the +given Kommander dialog (.kmdr) files. It then writes the corresponding +\fIi18n()\fP calls to standard output (usually redirected to rc.cpp) +so that xgettext can parse them. +.PP +To create a complete gettext message file (PO-file) from a Kommander +dialog, the +.BR kmdr2po (1) +utility is more convenient. +.PP +This utility is part of the TDE web development module. +.SH OPTIONS +.TP +\fB\-\-tag=\fP\fIname\fP +Extract also the contents of the tag \fIname\fP. +This option may be used multiple times +(e.g., \-\-tag=tag_one \-\-tag=tag_two). +.TP +\fB\-\-context=\fP\fIname\fP +Give all i18n() calls the given context: i18n("\fIname\fP", ...). +.SH SEE ALSO +.BR kmdr-editor (1), +.BR kmdr-executor (1), +.BR kmdr-plugins (1), +.BR kmdr2po (1). +.SH AUTHOR +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kommander/kmdr-editor.1 b/doc/man/kommander/kmdr-editor.1 new file mode 100644 index 00000000..5ecb637c --- /dev/null +++ b/doc/man/kommander/kmdr-editor.1 @@ -0,0 +1,70 @@ +.\" 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 KMDR-EDITOR 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 +kmdr-editor \- editor for the Kommander visual dialog building tool +.SH SYNOPSIS +.B kmdr-editor +[ \fIgeneric-options\fP ] +.SH DESCRIPTION +\fBKommander\fP is a visual dialog building tool whose +primary objective is to create +as much functionality as possible without using any scripting language. +.PP +More specifically, Kommander is a set of tools that allow you to create +dynamic GUI dialogs that generate, based on their state, a piece of text. +The piece of text can be a command line to a program, any piece of code, +business documents that contain a lot of repititious or templated text and so +on. The resulting generated text can then be executed as a command line +program (hence the name "Kommander"), written to a file, passed to a +script for extended processing, and literally anything else you can +think of. The best part of it all? You aren't required to write a single +line of code! +.PP +This editor (\fBkmdr-editor\fP) allows you to lay out your entire dialog +through a graphical +user interface. Once a dialog has been created by the editor, it is +saved as a file with extension \fI.kmdr\fP. The dialog that this XML file +represents can then be run instantly with the executor (\fBkmdr-executor\fP). +.PP +This application is part of the official TDE web development module. +.SH OPTIONS +For a full summary of options, run \fIkmdr-editor \-\-help\fP. +.SH SEE ALSO +.BR extractkmdr (1), +.BR kmdr-executor (1), +.BR kmdr-plugins (1), +.BR kmdr2po (1), +.BR quanta (1). +.PP +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kommander/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kommander/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdewebdev-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kommander/\fP. +.SH AUTHOR +Kommander was written by Marc Britton <consume@optusnet.com.au>, +Eric Laffoon <sequitur@kde.org>, Michal Rudolf <mrudolf@tdewebdev.org>, +Andras Mantia <amantia@kde.org> and Trolltech. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kommander/kmdr-executor.1 b/doc/man/kommander/kmdr-executor.1 new file mode 100644 index 00000000..cc197d69 --- /dev/null +++ b/doc/man/kommander/kmdr-executor.1 @@ -0,0 +1,87 @@ +.\" 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 KMDR-EXECUTOR 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 +kmdr-executor \- executor for the Kommander visual dialog building tool +.SH SYNOPSIS +.B kmdr-executor +[ \fIgeneric-options\fP ] +[ \fB\-c\fP \fIcatalog\fP ] +{ \fB\-\-stdin\fP | \fIfile\fP } +[ \fIarg\fP ... ] +.SH DESCRIPTION +\fBKommander\fP is a visual dialog building tool whose +primary objective is to create +as much functionality as possible without using any scripting language. +.PP +More specifically, Kommander is a set of tools that allow you to +create dynamic GUI dialogs +that generate, based on their state, a piece of text. The piece of text +can be a command line to a program, any piece of code, business +documents that contain a lot of repititious or templated text and so on. +The resulting generated text can then be executed as a command line +program (hence the name "Kommander"), written to a file, passed to a +script for extended processing, and literally anything else you can +think of. The best part of it all? You aren't required to write a single +line of code! +.PP +This executor (\fBkmdr-executor\fP) is used to run a dialog that has +been created by the +dialog editor (\fBkmdr-editor\fP). Either the dialog file (generally +a \fI.kmdr\fP file) should be passed on +the command-line, or else the option \-\-stdin should be passed and the +dialog description should be supplied as XML on standard input. +Additional arguments for the dialog itself may also be supplied. +.PP +This application is part of the official TDE web development module. +.SH OPTIONS +Below are the kommander-specific options. +For a full summary of options, run \fIkmdr-editor \-\-help\fP. +.TP +\fB\-c\fP \fIcatalog\fP +Use the given catalog for translation. +.TP +\fB\-\-stdin\fP +Read the XML dialog description from standard input instead of passing +a \fI.kmdr\fP file on the command-line. +.TP +\fIarg\fP ... +Additional arguments to be passed on to the dialog itself. +.SH SEE ALSO +.BR extractkmdr (1), +.BR kmdr-editor (1), +.BR kmdr-plugins (1), +.BR kmdr2po (1), +.BR quanta (1). +.PP +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kommander/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kommander/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdewebdev-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kommander/\fP. +.SH AUTHOR +Kommander was written by Marc Britton <consume@optusnet.com.au>, +Eric Laffoon <sequitur@kde.org>, Michal Rudolf <mrudolf@tdewebdev.org>, +Andras Mantia <amantia@kde.org> and Trolltech. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kommander/kmdr-plugins.1 b/doc/man/kommander/kmdr-plugins.1 new file mode 100644 index 00000000..5a8d222b --- /dev/null +++ b/doc/man/kommander/kmdr-plugins.1 @@ -0,0 +1,71 @@ +.\" 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 KMDR-PLUGINS 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 +kmdr-plugins \- plugin manager for the Kommander visual dialog building tool +.SH SYNOPSIS +.B kmdr-plugins +[ \fIgeneric-options\fP ] +.SH DESCRIPTION +\fBKommander\fP is a visual dialog building tool whose +primary objective is to create +as much functionality as possible without using any scripting language. +.PP +It is possible to extend Kommander by writing your own plugins. The +plugin manager +.B kmdr-plugins +is a simple user interface to Kommander's configuration file, and +can be used to select which external plugins Kommander should load. +Closing the plugin manager will automatically save any changes. +.PP +By loading a plugin, the custom widgets that it defines +will become available in Kommander's menus and toolbars, and these +custom widgets can be used in Kommander dialogs. +.PP +See +.BR kmdr-editor (1) +and +.BR kmdr-executor (1) +for a more detailed description of Kommander. +.PP +This application is part of the official TDE web development module. +.SH OPTIONS +For a full summary of options, run \fIkmdr-plugins \-\-help\fP. +.SH SEE ALSO +.BR extractkmdr (1), +.BR kmdr-editor (1), +.BR kmdr-executor (1), +.BR kmdr2po (1), +.BR quanta (1). +.PP +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kommander/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kommander/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdewebdev-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kommander/\fP. +.SH AUTHOR +Kommander was written by Marc Britton <consume@optusnet.com.au>, +Eric Laffoon <sequitur@kde.org>, Michal Rudolf <mrudolf@tdewebdev.org>, +Andras Mantia <amantia@kde.org> and Trolltech. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kommander/kmdr2po.1 b/doc/man/kommander/kmdr2po.1 new file mode 100644 index 00000000..4693644e --- /dev/null +++ b/doc/man/kommander/kmdr2po.1 @@ -0,0 +1,47 @@ +.\" 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 KMDR2PO 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 +kmdr2po \- create a PO-file from a Kommander dialog +.SH SYNOPSIS +.B kmdr2po +.I dialog +.SH DESCRIPTION +\fBkmdr2po\fP creates a gettext message file (PO-file) from the given +Kommander dialog (.kmdr) file. It does this by using +.BR extractkmdr (1) +to extract all text tags and other message strings, and then running +.BR xgettext (1) +to create the corresponding PO-file. +.PP +The final PO-file will be created in the current directory. Its name +will be derived from the dialog filename by replacing the suffix +\fI.kmdr\fP with \fI.po\fP. +.PP +This utility is part of the TDE web development module. +.SH WARNING +A temporary file named \fI_from_rc.cc\fP in the current directory +will be created and subsequently removed. +.SH SEE ALSO +.BR extractkmdr (1), +.BR kmdr-editor (1), +.BR kmdr-executor (1), +.BR kmdr-plugins (1), +.BR xgettext (1). +.SH AUTHOR +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). |