.\" Man page generated from reStructuredText.
.
.TH "PLAINBOX-SESSION" "1" "January 05, 2016" "0.25" "Plainbox"
.SH NAME
plainbox-session \- session management sub-commands
.
.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 [\-h] {list,remove,show,archive,export} ...
.ft P
.fi
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
This command can be used to list, show and remove sessions owned by the
current user.
.sp
Each session has a small amount of meta\-data that is available for
inspection. Each session has an application identifier (set by the
application that created that session), a title, that is human readable
piece of text that helps to distinguish sessions, and a set of flags.

Flags are particularly useful for determining what is the overall state
of any particular session. Two flags are standardized (other flags can be
used by applications): incomplete and submitted. The \(aqincomplete\(aq flag is
removed after all desired jobs have been executed. The \(aqsubmitted\(aq flag
is set after a submission is made using any of the transport mechanisms.
.SH SUB-COMMANDS
.INDENT 0.0
.TP
.B \fBplainbox session list [\-h] [\-\-only\-ids]\fP
list available sessions
.TP
.B \fBplainbox session remove [\-h] SESSION\-ID [SESSION\-ID ...]\fP
remove one more more sessions
.TP
.B \fBplainbox session show [\-h] [\-r] [\-f FLAG] SESSION\-ID [SESSION\-ID ...]\fP
show a single session
.TP
.B \fBplainbox session archive [\-h] SESSION\-ID ARCHIVE\fP
archive a single session
.TP
.B \fBplainbox session export [\-h] [\-\-flag FLAG] [\-f FORMAT] [\-p OPTIONS] [\-o FILE]
                        SESSION\-ID\fP
export a single session
.UNINDENT
.SH SEE ALSO
.sp
\fBplainbox\-session\-list\fP, \fBplainbox\-session\-remove\fP,
\fBplainbox\-session\-show\fP, \fBplainbox\-session\-archive\fP
\fBplainbox\-session\-export\fP
.SH AUTHOR
Zygmunt Krynicki & Checkbox Contributors
.SH COPYRIGHT
2012-2014 Canonical Ltd
.\" Generated by docutils manpage writer.
.