docs/buxton.conf.5

   1 '\" t
   2 .TH "BUXTON\&.CONF" "5" "" "buxton 1" "buxton\&.conf"
   3 .\" -----------------------------------------------------------------
   4 .\" * Define some portability stuff
   5 .\" -----------------------------------------------------------------
   6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   7 .\" http://bugs.debian.org/507673
   8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
   9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  10 .ie \n(.g .ds Aq \(aq
  11 .el       .ds Aq '
  12 .\" -----------------------------------------------------------------
  13 .\" * set default formatting
  14 .\" -----------------------------------------------------------------
  15 .\" disable hyphenation
  16 .nh
  17 .\" disable justification (adjust text to left margin only)
  18 .ad l
  19 .\" -----------------------------------------------------------------
  20 .\" * MAIN CONTENT STARTS HERE *
  21 .\" -----------------------------------------------------------------
  22 .SH "NAME"
  23 buxton\&.conf \- Configuration of Buxton settings and layer
  24 information
  25
  26 .SH "SYNOPSIS"
  27 .PP
  28 /etc/buxton\&.conf
  29
  30 .SH "DESCRIPTION"
  31 .PP
  32 The buxton configuration file can be used to override various paths
  33 used by \fBbuxtonctl\fR(1) and \fBbuxtond\fR(8), as well as the
  34 system\-wide definition of buxton layers\&.
  35
  36 .SH "OPTIONS"
  37 .PP
  38 Options that are specified in the
  39 "[Configuration]"
  40 section:
  41 .PP
  42 \fIModuleDirectory=\fR
  43 .RS 4
  44 Sets the directory where backend modules are stored\&. The path is
  45 used by \fBbuxtond\fR(8) to dynamically load the modules as
  46 needed\&.
  47 .RE
  48 .PP
  49 \fIDatabasePath=\fR
  50 .RS 4
  51 Sets the directory where \fBbuxtond\fR(8) (or \fBbuxtonctl\fR(1)
  52 in direct mode) will store configuration data\&.
  53 .RE
  54 .PP
  55 \fISmackLoadFile=\fR
  56 .RS 4
  57 Sets the location of the Smack "load2" file from the Smack virtual
  58 filesystem\&.
  59 .RE
  60 .PP
  61 \fISocketPath=\fR
  62 .RS 4
  63 Sets the path for the Unix Domain Socket used by buxton clients to
  64 communicate with \fBbuxtond\fR(8)\&.
  65 .RE
  66
  67 .PP
  68 Buxton layers are configured in individual sections of the config
  69 file, where each section name is equivalent to a layer name\&. For
  70 example, the "base" layer configuration is set in the "[base]"
  71 section\&.
  72
  73 .PP
  74 Options that are specified in each layer section:
  75 .PP
  76 \fIType=\fR
  77 .RS 4
  78 The type of the layer\&. Accepted values are "System" or "User"\&.
  79 .RE
  80 .PP
  81 \fIBackend=\fR
  82 .RS 4
  83 The backend to use for the layer\&. Accepted values are "gdbm" or
  84 "memory"\&.  Note that the "memory" backend is volatile, so
  85 key\-value pairs will be lost when the \fBbuxtond\fR(8) service
  86 exits\&.
  87 .RE
  88 .PP
  89 \fIPriority=\fR
  90 .RS 4
  91 The priority of the layer\&. Accepted values are integers greater
  92 than or equal to 0 (zero), where 0 is the lowest\-priority value\&.
  93 .RE
  94 .PP
  95 \fIAccess=\fR
  96 .RS 4
  97 The access type of the layer\&. Accepted values are "read\-write" and
  98 "read\-only"\&. This is an optional field that defaults to "read\-write"\&.
  99 .RE
 100 .PP
 101 \fIDescription=\fR
 102 .RS 4
 103 A human\-readable description for the given layer\&.
 104 .RE
 105
 106 .PP
 107 More details about buxton layers can be found in \fBbuxton\fR(7)\&.
 108
 109 .SH "COPYRIGHT"
 110 .PP
 111 Copyright 2014 Intel Corporation\&. License: Creative Commons
 112 Attribution\-ShareAlike 3.0 Unported\s-2\u[1]\d\s+2\&.
 113
 114 .SH "SEE ALSO"
 115 .PP
 116 \fBbuxton\fR(7),
 117 \fBbuxtonctl\fR(1),
 118 \fBbuxtond\fR(8),
 119 \fBbuxton\-api\fR(7)
 120
 121 .SH "NOTES"
 122 .IP " 1." 4
 123 Creative Commons Attribution\-ShareAlike 3.0 Unported
 124 .RS 4
 125 \%http://creativecommons.org/licenses/by-sa/3.0/
 126 .RE