From b6f10c0bc1ead0518d6fecf946b698f46fb97c37 Mon Sep 17 00:00:00 2001 From: Ivailo Monev Date: Wed, 13 Mar 2024 22:00:04 +0200 Subject: [PATCH] update manual pages Signed-off-by: Ivailo Monev --- src/tools/moc/moc.1 | 46 +++++++++++----------------------- src/tools/qdbus/qdbus.1 | 36 ++++++++------------------ src/tools/qdbus/qdbuscpp2xml.1 | 40 +++++++++-------------------- src/tools/qdbus/qdbusxml2cpp.1 | 38 ++++++++-------------------- src/tools/trc/trc.1 | 36 ++++++++------------------ src/tools/uic/uic.1 | 42 ++++++++++--------------------- 6 files changed, 71 insertions(+), 167 deletions(-) diff --git a/src/tools/moc/moc.1 b/src/tools/moc/moc.1 index ebc6eed2f..445a41e82 100644 --- a/src/tools/moc/moc.1 +++ b/src/tools/moc/moc.1 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -71,24 +55,24 @@ .\" ======================================================================== .\" .IX Title "MOC 1" -.TH MOC 1 "2022-06-15" "Katie 4.14.0" "Katie Manual" +.TH MOC 1 2022-12-09 "Katie 4.14.0" "Katie Manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh -.SH "NAME" +.SH NAME moc \- Katie meta object support code generator -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" moc [options] [] ... -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" -moc reads one or more \*(C+ class declarations from a \*(C+ header or source file -and generates one \*(C+ source file containing meta object information for the -classes. The \*(C+ source file generated by the moc must be compiled and linked +moc reads one or more C++ class declarations from a C++ header or source file +and generates one C++ source file containing meta object information for the +classes. The C++ source file generated by the moc must be compiled and linked with the implementation of the class (or it can be #included into the class's source file). -.SH "OPTIONS" +.SH OPTIONS .IX Header "OPTIONS" .Vb 2 \& \-o @@ -130,13 +114,13 @@ source file). .SH "EXIT STATUS" .IX Header "EXIT STATUS" moc returns 0 on success and other on unexcepted failure. -.SH "BUGS" +.SH BUGS .IX Header "BUGS" The moc does not expand #include or #define, it simply skips any preprocessor directives it encounters. This is regrettable, but is normally not a problem in practice. .PP -The moc does not handle all of \*(C+. The main problem is that class +The moc does not handle all of C++. The main problem is that class templates cannot have signals or slots. This is an important bug. Here is an example: .PP @@ -321,9 +305,9 @@ limitations is not a high priority for us. \& ... \& }; .Ve -.SH "AUTHORS" +.SH AUTHORS .IX Header "AUTHORS" Copyright (C) 2015 The Qt Company Ltd. Copyright (C) 2016 Ivailo Monev .PP -Licensed through \s-1GNU\s0 Lesser General Public License. +Licensed through GNU Lesser General Public License. diff --git a/src/tools/qdbus/qdbus.1 b/src/tools/qdbus/qdbus.1 index 41093763a..be8857d2b 100644 --- a/src/tools/qdbus/qdbus.1 +++ b/src/tools/qdbus/qdbus.1 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -71,22 +55,22 @@ .\" ======================================================================== .\" .IX Title "QDBUS 1" -.TH QDBUS 1 "2022-06-15" "Katie 4.14.0" "Katie Manual" +.TH QDBUS 1 2022-12-09 "Katie 4.14.0" "Katie Manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh -.SH "NAME" +.SH NAME qdbus \- a communication\-interface for Katie\-based applications -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" qdbus [options] [servicename] [path] [method] [args] -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" qdbus provides an interface to Katie-based applications communicating over D\-Bus. See http://www.freedesktop.org/software/dbus/ for more information about the big picture. -.SH "OPTIONS" +.SH OPTIONS .IX Header "OPTIONS" .Vb 2 \& \-\-help @@ -117,12 +101,12 @@ and properties available on the object. .SH "EXIT STATUS" .IX Header "EXIT STATUS" qdbus returns 0 on success and other on unexcepted failure. -.SH "AUTHORS" +.SH AUTHORS .IX Header "AUTHORS" Copyright (C) 2015 The Qt Company Ltd. Copyright (C) 2016 Ivailo Monev .PP -Licensed through \s-1GNU\s0 Lesser General Public License. +Licensed through GNU Lesser General Public License. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBdbus\-cleanup\-sockets\fR\|(1), \fBdbus\-launch\fR\|(1), \fBdbus\-send\fR\|(1), \fBdbus\-daemon\fR\|(1), diff --git a/src/tools/qdbus/qdbuscpp2xml.1 b/src/tools/qdbus/qdbuscpp2xml.1 index 7a78880a1..2d6df90ab 100644 --- a/src/tools/qdbus/qdbuscpp2xml.1 +++ b/src/tools/qdbus/qdbuscpp2xml.1 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -71,21 +55,21 @@ .\" ======================================================================== .\" .IX Title "QDBUSCPP2XML 1" -.TH QDBUSCPP2XML 1 "2022-06-15" "Katie 4.14.0" "Katie Manual" +.TH QDBUSCPP2XML 1 2022-12-09 "Katie 4.14.0" "Katie Manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh -.SH "NAME" +.SH NAME qdbuscpp2xml \- a D\-Bus instropection generator for Qt\-based applications -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" qdbuscpp2xml [options...] [files...] -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" -qdbuscpp2xml parses the \*(C+ source or header file containing a QObject-derived -class and produces the D\-Bus Introspection \s-1XML.\s0 -.SH "OPTIONS" +qdbuscpp2xml parses the C++ source or header file containing a QObject-derived +class and produces the D\-Bus Introspection XML. +.SH OPTIONS .IX Header "OPTIONS" .Vb 2 \& \-p|\-s|\-m @@ -112,9 +96,9 @@ class and produces the D\-Bus Introspection \s-1XML.\s0 .SH "EXIT STATUS" .IX Header "EXIT STATUS" qdbuscpp2xml returns 0 on success and other on unexcepted failure. -.SH "AUTHORS" +.SH AUTHORS .IX Header "AUTHORS" Copyright (C) 2015 The Qt Company Ltd. Copyright (C) 2016 Ivailo Monev .PP -Licensed through \s-1GNU\s0 Lesser General Public License. +Licensed through GNU Lesser General Public License. diff --git a/src/tools/qdbus/qdbusxml2cpp.1 b/src/tools/qdbus/qdbusxml2cpp.1 index 875fabf54..be233858e 100644 --- a/src/tools/qdbus/qdbusxml2cpp.1 +++ b/src/tools/qdbus/qdbusxml2cpp.1 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -71,21 +55,21 @@ .\" ======================================================================== .\" .IX Title "QDBUSXML2CPP 1" -.TH QDBUSXML2CPP 1 "2022-06-15" "Katie 4.14.0" "Katie Manual" +.TH QDBUSXML2CPP 1 2022-12-09 "Katie 4.14.0" "Katie Manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh -.SH "NAME" +.SH NAME qdbusxml2cpp \- a D\-Bus interface generator for Qt\-based applications -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" qdbusxml2cpp [options] [servicename] [path] [method] [args] -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" -qdbusxml2cpp produces the \*(C+ code to implement the interfaces defined in the +qdbusxml2cpp produces the C++ code to implement the interfaces defined in the input file. -.SH "OPTIONS" +.SH OPTIONS .IX Header "OPTIONS" .Vb 2 \& \-a @@ -129,9 +113,9 @@ to the standard output. .SH "EXIT STATUS" .IX Header "EXIT STATUS" qdbusxml2cpp returns 0 on success and other on unexcepted failure. -.SH "AUTHORS" +.SH AUTHORS .IX Header "AUTHORS" Copyright (C) 2015 The Qt Company Ltd. Copyright (C) 2016 Ivailo Monev .PP -Licensed through \s-1GNU\s0 Lesser General Public License. +Licensed through GNU Lesser General Public License. diff --git a/src/tools/trc/trc.1 b/src/tools/trc/trc.1 index fc0ac51c1..627debb5c 100644 --- a/src/tools/trc/trc.1 +++ b/src/tools/trc/trc.1 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -71,20 +55,20 @@ .\" ======================================================================== .\" .IX Title "TRC 1" -.TH TRC 1 "2023-08-01" "Katie 4.14.0" "Katie Manual" +.TH TRC 1 2023-08-02 "Katie 4.14.0" "Katie Manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh -.SH "NAME" +.SH NAME trc \- Katie Translation Compiler -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" trc [options] -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" trc reads a program translation (.po) file and creates corresponding .tr file. -.SH "OPTIONS" +.SH OPTIONS .IX Header "OPTIONS" .Vb 3 \& \-f @@ -109,8 +93,8 @@ trc reads a program translation (.po) file and creates corresponding .tr file. .SH "EXIT STATUS" .IX Header "EXIT STATUS" trc returns 0 on success and other on unexcepted failure. -.SH "AUTHORS" +.SH AUTHORS .IX Header "AUTHORS" Copyright (C) 2022 Ivailo Monev .PP -Licensed through \s-1GNU\s0 Lesser General Public License. +Licensed through GNU Lesser General Public License. diff --git a/src/tools/uic/uic.1 b/src/tools/uic/uic.1 index 9d306ea20..222e9503b 100644 --- a/src/tools/uic/uic.1 +++ b/src/tools/uic/uic.1 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -71,22 +55,22 @@ .\" ======================================================================== .\" .IX Title "UIC 1" -.TH UIC 1 "2022-06-15" "Katie 4.14.0" "Katie Manual" +.TH UIC 1 2022-12-09 "Katie 4.14.0" "Katie Manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh -.SH "NAME" +.SH NAME uic \- Katie User Interface Compiler -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" uic [options] -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" -uic reads a user interface definition (.ui) file in \s-1XML\s0 as generated by -Katie Designer and creates corresponding \*(C+ header or source files. It also -generates an image file that embeds raw image data in \*(C+ source code. -.SH "OPTIONS" +uic reads a user interface definition (.ui) file in XML as generated by +Katie Designer and creates corresponding C++ header or source files. It also +generates an image file that embeds raw image data in C++ source code. +.SH OPTIONS .IX Header "OPTIONS" .Vb 3 \& \-h @@ -118,9 +102,9 @@ generates an image file that embeds raw image data in \*(C+ source code. .SH "EXIT STATUS" .IX Header "EXIT STATUS" uic returns 0 on success and other on unexcepted failure. -.SH "AUTHORS" +.SH AUTHORS .IX Header "AUTHORS" Copyright (C) 2015 The Qt Company Ltd. Copyright (C) 2016 Ivailo Monev .PP -Licensed through \s-1GNU\s0 Lesser General Public License. +Licensed through GNU Lesser General Public License.