.\" Man page generated from reStructuredText.
.
.TH "PLAINBOX_PROVIDER_DATA" "7" "January 05, 2016" "0.25" "Plainbox"
.SH NAME
PLAINBOX_PROVIDER_DATA \- per-provider data directory
.
.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
.sp
\fBcommand: example\-command $PLAINBOX_PROVIDER_DATA/data\-file.dat\fP
.sp
Running an example\-command on a provider\-specific data file.
.SH DESCRIPTION
.sp
Plainbox providers can require arbitrary data files for successful testing.
The absolute path of the provider \fBdata/\fP directory is exposed as the
environment variable \fB$PLAINBOX_PROVIDER_DATA\fP\&. Job commands can use that
variable to refer to the data directory in an unambiguous way.
.SS Typical Use Cases
.sp
Typically the data file is used by the job command. For example, let\(aqs say that
an audio file \fBtest.wav\fP is stored in the \fBdata/\fP directory of the provider
and the intent is to have a job definition which plays that file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
id: play\-audio\-file
plugin: user\-verify
summary: play the test.wav file
command: paplay $PLAINBOX_PROVIDER_DATA/test.wav
description:
 Plays the test sound file (test.wav)

 Did the sound file play correctly?
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The job \fBplay\-audio\-file\fP will use the \fBpaplay\fP (1) executable to play an
audio file shipped by the provider. Since the actual location of the audio file
may vary, depending on environment and installation method, the test definition
uses the environment variable \fB$PLAINBOX_PROVIDER_DATA\fP to access it in an
uniform way.
.SS Checkbox Compatibility
.sp
Jobs designed to work with pre\-Plainbox\-based Checkbox may still refer to the
old, somewhat confusing, environment variable \fBCHECKBOX_SHARE\fP\&. It points
to the same directory.
.SH SEE ALSO
.sp
\fBPLAINBOX_PROVIDER_DATA\fP
.SH AUTHOR
Zygmunt Krynicki & Checkbox Contributors
.SH COPYRIGHT
2012-2014 Canonical Ltd
.\" Generated by docutils manpage writer.
.