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/poxml/CMakeLists.txt | 7 ++++++ doc/man/poxml/po2xml.1 | 40 +++++++++++++++++++++++++++++ doc/man/poxml/split2po.1 | 60 ++++++++++++++++++++++++++++++++++++++++++++ doc/man/poxml/swappo.1 | 44 ++++++++++++++++++++++++++++++++ doc/man/poxml/transxx.1 | 47 ++++++++++++++++++++++++++++++++++ doc/man/poxml/xml2pot.1 | 45 +++++++++++++++++++++++++++++++++ 6 files changed, 243 insertions(+) create mode 100644 doc/man/poxml/CMakeLists.txt create mode 100644 doc/man/poxml/po2xml.1 create mode 100644 doc/man/poxml/split2po.1 create mode 100644 doc/man/poxml/swappo.1 create mode 100644 doc/man/poxml/transxx.1 create mode 100644 doc/man/poxml/xml2pot.1 (limited to 'doc/man/poxml') diff --git a/doc/man/poxml/CMakeLists.txt b/doc/man/poxml/CMakeLists.txt new file mode 100644 index 00000000..24ccd704 --- /dev/null +++ b/doc/man/poxml/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/poxml/po2xml.1 b/doc/man/poxml/po2xml.1 new file mode 100644 index 00000000..d2f7fe5d --- /dev/null +++ b/doc/man/poxml/po2xml.1 @@ -0,0 +1,40 @@ +.\" 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 PO2XML 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 +po2xml \- translates a DocBook XML file using a PO-file +.SH SYNOPSIS +.B po2xml +.I original-XML translated-PO +.SH DESCRIPTION +\fBpo2xml\fP is a command-line tool that translates the DocBook +XML file \fIoriginal-XML\fP using the gettext message file +\fItranslated-PO\fP. The resulting translated XML file is sent to standard +output. +.PP +This utility is part of the TDE Software Development Kit. +.SH SEE ALSO +.BR split2po (1), +.BR swappo (1), +.BR transxx (1), +.BR xml2pot (1). +.SH AUTHOR +The PO-XML tools were written by Stephan Kulow and +Peter Wells . +.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/poxml/split2po.1 b/doc/man/poxml/split2po.1 new file mode 100644 index 00000000..539e2f6c --- /dev/null +++ b/doc/man/poxml/split2po.1 @@ -0,0 +1,60 @@ +.\" 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 SPLIT2PO 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 +split2po \- creates a PO-file from two DocBook XML files +.SH SYNOPSIS +.B split2po +.I original-XML translated-XML +.SH DESCRIPTION +\fBsplit2po\fP is a command-line tool that takes the two given DocBook +XML files and produces a gettext message file (PO-file) that represents +the changes between them. The resulting PO-file is sent to standard +output. +.PP +.I translated-XML +must be the result of translating +.I original-XML +into another language. It is this translation that the resulting +PO-file will represent. +.PP +This utility is part of the TDE Software Development Kit. +.SH ENVIRONMENT VARIABLES +.TP +NO_CREDITS +If set, the "ROLES_OF_TRANSLATORS" and "CREDIT_FOR_TRANSLATORS" messages +will be omitted. By default these are always included at the end of +the PO-file, with empty message strings. +.br +These messages are used with TDE documentation, so you may wish to set +NO_CREDITS if you are working with some other type of non-TDE documentation. +.TP +REPORT_MISMATCHES +Set this variable to "no" if you wish mismatch reporting to be +suppressed. By default, any apparent mismatches between the two XML +files will be noted on standard error. +.SH SEE ALSO +.BR po2xml (1), +.BR swappo (1), +.BR transxx (1), +.BR xml2pot (1). +.SH AUTHOR +The PO-XML tools were written by Stephan Kulow and +Peter Wells . +.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/poxml/swappo.1 b/doc/man/poxml/swappo.1 new file mode 100644 index 00000000..bb1289d9 --- /dev/null +++ b/doc/man/poxml/swappo.1 @@ -0,0 +1,44 @@ +.\" 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 SWAPPO 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 +swappo \- swap msgid and msgstr fields in a PO-file +.SH SYNOPSIS +.B swappo +.I PO-file +.SH DESCRIPTION +\fBswappo\fP reads the given PO-file and swaps the \fImsgid\fP and +\fImsgstr\fP fields for every message. The result is a new PO-file that +translates in the opposite direction. For example, if \fIPO-file\fP +translates from English to French, the new PO-file will translate from +French to English. +.PP +The new PO-file will be written to standard output. The old PO-file +will remain untouched. +.PP +This utility is part of the TDE Software Development Kit. +.SH SEE ALSO +.BR po2xml (1), +.BR split2po (1), +.BR transxx (1), +.BR xml2pot (1). +.SH AUTHOR +The PO-XML tools were written by Stephan Kulow and +Peter Wells . +.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/poxml/transxx.1 b/doc/man/poxml/transxx.1 new file mode 100644 index 00000000..6dba2239 --- /dev/null +++ b/doc/man/poxml/transxx.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 TRANSXX 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 +transxx \- create a basic fleshed-out PO-file from a PO-template file +.SH SYNOPSIS +.B transxx +[ \fB\-\-text\fP \fItranslation\fP ] +.I template +.SH DESCRIPTION +\fBtransxx\fP is a command-line tool that produces a basic fleshed-out +PO-file from a PO-template file. Some of the formatting and +structure of the \fImsgid\fP strings will be copied to the \fImsgstr\fP +strings, but otherwise text will be translated to "xx". +.PP +The fleshed-out PO-file is sent to standard output. +.PP +This utility is part of the TDE Software Development Kit. +.SH OPTIONS +.TP +\fB\-\-text\fP \fItranslation\fP +Use the given translation everywhere instead of "xx". +.SH SEE ALSO +.BR po2xml (1), +.BR split2po (1), +.BR swappo (1), +.BR xml2pot (1). +.SH AUTHOR +The PO-XML tools were written by Stephan Kulow and +Peter Wells . +.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/poxml/xml2pot.1 b/doc/man/poxml/xml2pot.1 new file mode 100644 index 00000000..0b1a293d --- /dev/null +++ b/doc/man/poxml/xml2pot.1 @@ -0,0 +1,45 @@ +.\" 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 XML2POT 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 +xml2pot \- creates a PO-template file from a DocBook XML file +.SH SYNOPSIS +.B xml2pot +.I original-XML +.SH DESCRIPTION +\fBxml2pot\fP is a command-line tool that produces a gettext message +template file from the DocBook XML file \fIoriginal-XML\fP. +The template file is sent to standard output. +.PP +The resulting template file can be used to create gettext message files +(PO-files) for a variety of languages. These can then be used in conjunction +with +.BR po2xml (1) +to translate the original XML file into these other languages. +.PP +This utility is part of the TDE Software Development Kit. +.SH SEE ALSO +.BR po2xml (1), +.BR split2po (1), +.BR swappo (1), +.BR transxx (1). +.SH AUTHOR +The PO-XML tools were written by Stephan Kulow and +Peter Wells . +.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