.\" Man page generated from reStructuredText.
.
.TH "PLAINBOX.CONF" "5" "January 05, 2016" "0.25" "Plainbox"
.SH NAME
plainbox.conf \- plainbox configuration file
.
.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
\fB/etc/xdg/plainbox.conf\fP
.sp
\fB$XDG_CONFIG_HOME/plainbox.conf\fP
.SH DESCRIPTION
.sp
Plainbox (and its derivatives) uses a configuration system composed of
variables arranged in sections. All configuration files follow the well\-known
INI\-style syntax. While Plainbox itself is not really using any variables,
knowledge of where those can be defined is useful for working with derivative
applications, such as Checkbox.
.SS The [environment] section
.sp
The \fB[environment]\fP section deserves special attention. If a job advertises
usage of environment variable \fBFOO\fP (by using the \fIenviron: FOO\fP declaration)
and \fBFOO\fP is not available in the environment of the user starting plainbox,
then the value is obtained from the \fB[environment]\fP section. This mechanism
is useful for distributing both site\-wide and per\-user configuration for jobs.
.SH FILES
.sp
\fB/etc/xdg/plainbox.conf\fP
.INDENT 0.0
.INDENT 3.5
System\-wide configuration file (lowest priority).
.UNINDENT
.UNINDENT
.sp
\fB$XDG_CONFIG_HOME/plainbox.conf\fP
.INDENT 0.0
.INDENT 3.5
Per\-user configuration (highest priority).
.UNINDENT
.UNINDENT
.SH EXAMPLES
.sp
/etc/xdg/plainbox.conf:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[environment]
OPEN_BG_SSID=my\-ap\-ssid
.ft P
.fi
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
\fBplainbox\-check\-config\fP (1)
.SH AUTHOR
Zygmunt Krynicki & Checkbox Contributors
.SH COPYRIGHT
2012-2014 Canonical Ltd
.\" Generated by docutils manpage writer.
.