.\" Man page generated from reStructuredText.
.
.TH "PLAINBOX-SESSION-EXPORT" "1" "January 05, 2016" "0.25" "Plainbox"
.SH NAME
plainbox-session-export \- (re-)export an existing session
.
.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 session export [\-h] [\-\-flag FLAG] [\-f FORMAT] [\-p OPTIONS] [\-o FILE]
                        SESSION\-ID
.ft P
.fi
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
Export a single session
.sp
The \fIplainbox session export\fP command allows to export any existing session
(that can be still resumed) with any set of exporter / exporter option
combinations.
.sp
The exported session representation can be printed to stdout (default) or
saved to a specified file. You can pass a question mark (?) to both
\fB\-\-output\-format\fP and \fB\-\-output\-options\fP for a list of available
values.
.SH OPTIONS
.sp

\fBPositional arguments:\fP
.PP
.INDENT 0.0
.TP
.B
Identifier of the session to export
.UNINDENT
.sp

\fBOptional arguments:\fP
.PP
.INDENT 0.0
.TP
.B \-\-flag
pass this resume flag to the session resume code
.TP
.B \-f=text\fP,\fB  \-\-output\-format=text
save test results in the specified FORMAT (pass ? for a list of choices)
.sp
Possible choices: ?, 2013.com.canonical.plainbox::hexr, 2013.com.canonical.plainbox::html, 2013.com.canonical.plainbox::json, 2013.com.canonical.plainbox::rfc822, 2013.com.canonical.plainbox::text, 2013.com.canonical.plainbox::xlsx, xml, rfc822, xlsx, text, html, json
.TP
.B \-p=\fP,\fB  \-\-output\-options=
comma\-separated list of options for the export mechanism (pass ? for a list of choices)
.TP
.B \-o=\-\fP,\fB  \-\-output\-file=\-
save test results to the specified FILE (or to stdout if FILE is \-)
.UNINDENT
.SH LIMITATIONS
.sp
Sessions that cannot be resumed cannot be exported. Two common causes for that
are known.
.sp
First of all, a session can fail to resume because of missing or changed job
definitions. For that you need to re\-install the exact same provider version as
was available on the machine that generated the session you are trying to work
with.
.sp
The second case is when a session was copied from another machine and some of
the log files are pointing to a different users\(aq account. This can be worked
around by providing appropriate symbolic links from /home/some\-user/ to
/home/your\-user/
.SH AUTHOR
Zygmunt Krynicki & Checkbox Contributors
.SH COPYRIGHT
2012-2014 Canonical Ltd
.\" Generated by docutils manpage writer.
.