From d8521af7be8cafc64525755758d25f0b70072ea5 Mon Sep 17 00:00:00 2001 From: Michele Calgaro Date: Mon, 13 Jun 2022 13:47:50 +0900 Subject: Add man pages for TDE applications Signed-off-by: Michele Calgaro --- doc/man/kbabel/CMakeLists.txt | 7 ++++ doc/man/kbabel/catalogmanager.1 | 66 ++++++++++++++++++++++++++++++++++++ doc/man/kbabel/kbabel.1 | 74 +++++++++++++++++++++++++++++++++++++++++ doc/man/kbabel/kbabeldict.1 | 66 ++++++++++++++++++++++++++++++++++++ 4 files changed, 213 insertions(+) create mode 100644 doc/man/kbabel/CMakeLists.txt create mode 100644 doc/man/kbabel/catalogmanager.1 create mode 100644 doc/man/kbabel/kbabel.1 create mode 100644 doc/man/kbabel/kbabeldict.1 (limited to 'doc/man/kbabel') diff --git a/doc/man/kbabel/CMakeLists.txt b/doc/man/kbabel/CMakeLists.txt new file mode 100644 index 00000000..24ccd704 --- /dev/null +++ b/doc/man/kbabel/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/kbabel/catalogmanager.1 b/doc/man/kbabel/catalogmanager.1 new file mode 100644 index 00000000..db8b1761 --- /dev/null +++ b/doc/man/kbabel/catalogmanager.1 @@ -0,0 +1,66 @@ +.\" 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 CATALOGMANAGER 1 "March 19, 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 insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +catalogmanager \- advanced catalog manager for KBabel +.SH SYNOPSIS +.B catalogmanager +.RI "[ " generic-options " ]" +[ \fB\-\-project\fP \fIconfig-file\fP ] +.SH DESCRIPTION +\fBCatalogManager\fP is part of a suite of programs for editing gettext +message files (PO-files). This suite is designed to help you translate fast +and consistently. +.PP +This suite includes KBabel, CatalogManager and KBabelDict. KBabel is an +advanced and easy to use PO-file editor with full navigational and editing +capabilities, syntax checking and statistics. CatalogManager (this program) +is a multi functional catalog manager which allows you to keep track of many +PO-files at once. KBabelDict is a dictionary to assist with searching +for common translations. +.PP +This utility is part of the TDE Software Development Kit. +.SH OPTIONS +Below are the catalogmanager-specific options. +For a full summary of options, run \fIcatalogmanager \-\-help\fP. +.TP +\fB\-\-project\fP \fIconfig-file\fP +Load the configuration from the given file. +.SH SEE ALSO +.BR kbabel (1), +.BR kbabeldict (1). +.PP +Full user documentation for KBabel is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kbabel/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kbabel/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdesdk-doc-html\fP and read this documentation in HTML format from +\fI/usr/share/doc/tde/HTML/en/kbabel/\fP. +.SH AUTHOR +KBabel was written by Matthias Kiefer , +Wolfram Diestel , Andrea Rizzi , +Stanislav Visnovsky , Marco Wegner , +Asgeir Frimannsson , +Dwayne Bailey , +Bram Schoenmakers and others. +.br +This manual page was prepared by Ben Burton +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kbabel/kbabel.1 b/doc/man/kbabel/kbabel.1 new file mode 100644 index 00000000..047e3626 --- /dev/null +++ b/doc/man/kbabel/kbabel.1 @@ -0,0 +1,74 @@ +.\" 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 KBABEL 1 "March 19, 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 insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +kbabel \- a PO-file editor for TDE +.SH SYNOPSIS +.B kbabel +.RI "[ " generic-options " ]" +[ \fB\-\-gotomsgid\fP \fImsgid\fP ] [ \fB\-\-nosplash\fP ] +[ \fB\-\-project\fP \fIconfig-file\fP ] +.RI "[ " file " ]" +.SH DESCRIPTION +\fBKBabel\fP is part of a suite of programs for editing gettext message +files (PO-files). It is designed to help you translate fast and +consistently. +.PP +This suite includes KBabel, CatalogManager and KBabelDict. KBabel (this +program) is an advanced and easy to use PO-file editor with full navigational +and editing capabilities, syntax checking and statistics. CatalogManager is +a multi functional catalog manager which allows you to keep track of many +PO-files at once. KBabelDict is a dictionary to assist with searching +for common translations. +.PP +This utility is part of the TDE Software Development Kit. +.SH OPTIONS +Below are the kbabel-specific options. +For a full summary of options, run \fIkbabel \-\-help\fP. +.TP +\fB\-\-gotomsgid\fP \fImsgid\fP +Go to the entry with the given message ID. +.TP +.B \-\-nosplash +Disable splashscreen at startup. +.TP +\fB\-\-project\fP \fIconfig-file\fP +Load the configuration from the given file. +.SH SEE ALSO +.BR catalogmanager (1), +.BR kbabeldict (1). +.PP +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kbabel/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kbabel/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdesdk-doc-html\fP and read this documentation in HTML format from +\fI/usr/share/doc/tde/HTML/en/kbabel/\fP. +.SH AUTHOR +KBabel was written by Matthias Kiefer , +Wolfram Diestel , Andrea Rizzi , +Stanislav Visnovsky , Marco Wegner , +Asgeir Frimannsson , +Dwayne Bailey , +Bram Schoenmakers and others. +.br +This manual page was prepared by Ben Burton +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kbabel/kbabeldict.1 b/doc/man/kbabel/kbabeldict.1 new file mode 100644 index 00000000..ffd9b465 --- /dev/null +++ b/doc/man/kbabel/kbabeldict.1 @@ -0,0 +1,66 @@ +.\" 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 KBABELDICT 1 "March 19, 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 insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +kbabeldict \- the KBabel dictionary for translators +.SH SYNOPSIS +.B kbabeldict +.RI "[ " generic-options " ]" +.RB "[ " \-\-nosplash " ]" +.SH DESCRIPTION +\fBKBabelDict\fP is part of a suite of programs for editing gettext message +files (PO-files). This suite is designed to help you translate fast and +consistently. +.PP +This suite includes KBabel, CatalogManager and KBabelDict. KBabel is an +advanced and easy to use PO-file editor with full navigational and editing +capabilities, syntax checking and statistics. CatalogManager is a multi +functional catalog manager which allows you to keep track of many +PO-files at once. KBabelDict (this program) is a dictionary to assist +with searching for common translations. +.PP +This utility is part of the TDE Software Development Kit. +.SH OPTIONS +Below are the kbabeldict-specific options. +For a full summary of options, run \fIkbabeldict \-\-help\fP. +.TP +.B \-\-nosplash +Disable splashscreen at startup. +.SH SEE ALSO +.BR kbabel (1), +.BR catalogmanager (1). +.PP +Full user documentation for KBabel is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kbabel/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kbabel/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdesdk-doc-html\fP and read this documentation in HTML format from +\fI/usr/share/doc/tde/HTML/en/kbabel/\fP. +.SH AUTHOR +KBabel was written by Matthias Kiefer , +Wolfram Diestel , Andrea Rizzi , +Stanislav Visnovsky , Marco Wegner , +Asgeir Frimannsson , +Dwayne Bailey , +Bram Schoenmakers and others. +.br +This manual page was prepared by Ben Burton +for the Debian GNU/Linux system (but may be used by others). -- cgit v1.2.1