.\" Man page generated from reStructuredText.
.
.TH "PLAINBOX-QML-SHELL" "1" "January 05, 2016" "0.25" "Plainbox"
.SH NAME
plainbox-qml-shell \- standalone qml-native shell
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
plainbox\-qml\-shell [\-h] [\-\-version] [\-v] [\-D] [\-C] [\-T LOGGER] [\-P] [\-I]
                   QML\-FILE
.ft P
.fi
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
Runs specified file as it would be a plainbox\(aq qml job.
Returns 0 if job returned \(aqpass\(aq, 1 if job returned \(aqfail\(aq, or
other value in case of an error.
.sp
This command runs qml job provided by specified file.
.sp
General purpose of this command is to make development of qml\-native jobs
faster, by making it easier to test qml file(s) that constitute to job
without resorting to installation of provider and running plainbox run.
Typical approach to the development of new qml job would be as follows:

\- have an idea for a job

\- create a qml file in Ubuntu\-SDK or Your Favourite Editor

\- hack on the file and iterate using qmlscene (or use plainbox\-qml\-shell
  immediately if you start with next point)

\- make it conformant to plainbox qml\-native API described in CEP\-5
  (calling test\-done at the end)

\- copy qml file over to data dir of a provider and add a job unit to it
.SH OPTIONS
.sp

\fBPositional arguments:\fP
.PP
.INDENT 0.0
.TP
.B
qml file with job to be run
.UNINDENT
.sp

\fBOptional arguments:\fP
.PP
.INDENT 0.0
.TP
.B \-\-version
show program\(aqs version number and exit
.TP
.B \-v\fP,\fB  \-\-verbose
be more verbose (same as \-\-log\-level=INFO)
.TP
.B \-D\fP,\fB  \-\-debug
enable DEBUG messages on the root logger
.TP
.B \-C\fP,\fB  \-\-debug\-console
display DEBUG messages in the console
.TP
.B \-T\fP,\fB  \-\-trace
enable DEBUG messages on the specified logger (can be used multiple times)
.TP
.B \-P\fP,\fB  \-\-pdb
jump into pdb (python debugger) when a command crashes
.TP
.B \-I\fP,\fB  \-\-debug\-interrupt
crash on SIGINT/KeyboardInterrupt, useful with \-\-pdb
.UNINDENT
.SH SEE ALSO
.sp
\fBplainbox\-run\fP
.SH AUTHOR
Zygmunt Krynicki & Checkbox Contributors
.SH COPYRIGHT
2012-2014 Canonical Ltd
.\" Generated by docutils manpage writer.
.