katie/src/tools/qdbus/qdbusxml2cpp.1
Ivailo Monev 3c58788f05 various cleanups
Signed-off-by: Ivailo Monev <xakepa10@laimg.moc>
2018-07-10 14:31:23 +00:00

115 lines
3.7 KiB
Groff

.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.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'
.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\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
.\}
.\" ========================================================================
.\"
.IX Title "QDBUSXML2CPP 1"
.TH QDBUSXML2CPP 1 "2016-11-05" "Katie 4.9.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"
qdbusxml2cpp \- a D\-Bus interface generator for Qt\-based applications
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
qdbusxml2cpp [options] [servicename] [path] [method] [args]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
qdbusxml2cpp produces the \*(C+ code to implement the interfaces defined in the
input file.
.SH "OPTIONS"
.IX Header "OPTIONS"
.Vb 10
\& \-a <filename> Write the adaptor code to <filename>
\& \-c <classname> Use <classname> as the class name for the generated classes
\& \-h Show this information
\& \-i <filename> Add #include to the output
\& \-l <classname> When generating an adaptor, use <classname> as the parent class
\& \-m Generate #include "filename.moc" statements in the .cpp files
\& \-N Don\*(Aqt use namespaces
\& \-p <filename> Write the proxy code to <filename>
\& \-v Be verbose.
\& \-V Show the program version and quit.
.Ve
.PP
If the file name given to the options \-a and \-p does not end in .cpp or .h, the
program will automatically append the suffixes and produce both files.
You can also use a colon (:) to separate the header name from the source file
name, as in '\-a filename_p.h:filename.cpp'.
.PP
If you pass a dash (\-) as the argument to either \-p or \-a, the output is written
to the standard output.
.SH "EXIT STATUS"
.IX Header "EXIT STATUS"
qdbusxml2cpp returns 0 on success and other on unexcepted failure.
.SH "AUTHORS"
.IX Header "AUTHORS"
The Qt Company Ltd.
.PP
Copyright (C) 2015 The Qt Company Ltd.
.PP
Licensed through \s-1GNU\s0 Lesser General Public License/GNU General Public License.