docs/buxtonctl.1

   1 '\" t
   2 .TH "BUXTONCTL" "1" "" "buxton 1" "buxtonctl"
   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 buxtonctl \- Manipulates data stored in the buxton configuration
  24 system
  25
  26 .SH "SYNOPSIS"
  27 .HP \w'\fBbuxtonctl\fR\ 'u
  28 \fBbuxtonctl\fR [OPTIONS...] COMMAND ARGS
  29
  30 .SH "DESCRIPTION"
  31 .PP
  32 \fBbuxtonctl\fR
  33 is used to modify and query configuration, as managed by
  34 \fBbuxton\fR(7)\&.
  35
  36 .SH "OPTIONS"
  37 .PP
  38 The following options are understood:
  39 .PP
  40 \fB\-h\fR, \fB\-\-help\fR
  41 .RS 4
  42 Prints a help message\&.
  43 .RE
  44 .PP
  45 \fB\-d\fR, \fB\-\-direct\fR
  46 .RS 4
  47 Modifies the configuration directly, without connecting to
  48 \fBbuxtond\fR(8)\&. Note that this is a privileged operation\&.
  49 .RE
  50 .PP
  51 \fB\-c\fR FILE, \fB\-\-config\-file\fR FILE
  52 .RS 4
  53 Path to a buxton configuration file (see \fBbuxton\&.conf\fR(5))\&.
  54 .RE
  55
  56 .SH "COMMANDS"
  57 .PP
  58 The following commands are understood:
  59 .SS "Group manipulation"
  60 .PP
  61 \fBcreate\-group\fR LAYER GROUP
  62 .RS 4
  63 Creates a group within the specified layer\&.
  64 .RE
  65 .PP
  66 \fBset\-label\fR LAYER GROUP LABEL
  67 .RS 4
  68 Sets the Smack label for the group in the specified layer\&. Note
  69 that this is a privileged operation\&.
  70 .RE
  71 .PP
  72 \fBremove\-group\fR LAYER GROUP
  73 .RS 4
  74 Removes a group within the specified layer\&. Note that this
  75 operation recursively removes all keys within the given group\&.
  76 .RE
  77 .SS "Key manipulation"
  78 .PP
  79 Note that all "get" commands accept an optional LAYER argument\&.
  80 Without specifying the layer, the returned value will be taken from
  81 the layer with highest priority that the client has permission to
  82 read\&. With the layer argument, buxton will try to return the key
  83 value only from the given layer\&.
  84 .PP
  85 \fBget\-string\fR [LAYER] GROUP KEY
  86 .RS 4
  87 Gets a key value with string type\&.
  88 .RE
  89 .PP
  90 \fBset\-string\fR LAYER GROUP KEY VALUE
  91 .RS 4
  92 Sets a key value with string type\&.
  93 .RE
  94 .PP
  95 \fBget\-int32\fR [LAYER] GROUP KEY
  96 .RS 4
  97 Gets a key value with int32_t type\&.
  98 .RE
  99 .PP
 100 \fBset\-int32\fR LAYER GROUP KEY VALUE
 101 .RS 4
 102 Sets a key value with string type\&.
 103 .RE
 104 .PP
 105 \fBget\-uint32\fR [LAYER] GROUP KEY
 106 .RS 4
 107 Gets a key value with uint32_t type\&.
 108 .RE
 109 .PP
 110 \fBset\-uint32\fR LAYER GROUP KEY VALUE
 111 .RS 4
 112 Sets a key value with uint32_t type\&.
 113 .RE
 114 .PP
 115 \fBget\-int64\fR [LAYER] GROUP KEY
 116 .RS 4
 117 Gets a key value with int64_t type\&.
 118 .RE
 119 .PP
 120 \fBset\-int64\fR LAYER GROUP KEY VALUE
 121 .RS 4
 122 Sets a key value with int64_t type\&.
 123 .RE
 124 .PP
 125 \fBget\-uint64\fR [LAYER] GROUP KEY
 126 .RS 4
 127 Gets a key value with uint64_t type\&.
 128 .RE
 129 .PP
 130 \fBset\-uint64\fR LAYER GROUP KEY VALUE
 131 .RS 4
 132 Sets a key value with uint64_t type\&.
 133 .RE
 134 .PP
 135 \fBget\-float\fR [LAYER] GROUP KEY
 136 .RS 4
 137 Gets a key value with float type\&.
 138 .RE
 139 .PP
 140 \fBset\-float\fR LAYER GROUP KEY VALUE
 141 .RS 4
 142 Sets a key value with float type\&.
 143 .RE
 144 .PP
 145 \fBget\-double\fR [LAYER] GROUP KEY
 146 .RS 4
 147 Gets a key value with double type\&.
 148 .RE
 149 .PP
 150 \fBset\-double\fR LAYER GROUP KEY VALUE
 151 .RS 4
 152 Sets a key value with double type\&.
 153 .RE
 154 .PP
 155 \fBget\-bool\fR [LAYER] GROUP KEY
 156 .RS 4
 157 Gets a key value with boolean type\&.
 158 .RE
 159 .PP
 160 \fBset\-bool\fR LAYER GROUP KEY VALUE
 161 .RS 4
 162 Sets a key value with boolean type\&.
 163 .RE
 164 .PP
 165 \fBset\-label\fR LAYER GROUP KEY LABEL
 166 .RS 4
 167 Sets the Smack label on a key\&. Note that this is a privileged
 168 operation\&.
 169 .RE
 170 .PP
 171 \fBunset\-value\fR LAYER GROUP KEY
 172 .RS 4
 173 Unset the value on a key\&. This removes the key from the given
 174 group\&.
 175 .RE
 176
 177 .SH "ENVIRONMENT VARIABLES"
 178 .PP
 179 \fI$BUXTON_CONF_FILE\fR
 180 .RS 4
 181 The path to a buxton configuration file (see
 182 \fBbuxton\&.conf\fR(5))\&.
 183 .RE
 184 .PP
 185 \fI$BUXTON_MODULE_DIR\fR
 186 .RS 4
 187 The directory in which buxton's backend modules reside\&.
 188 .RE
 189 .PP
 190 \fI$BUXTON_DB_PATH\fR
 191 .RS 4
 192 The directory that buxtond will use for configuration storage\&.
 193 .RE
 194 .PP
 195 \fI$BUXTON_SMACK_LOAD_FILE\fR
 196 .RS 4
 197 The path to the Smack "load2" file, typically residing on the Smack
 198 virtual filesystem (smackfs)\&.
 199 .RE
 200 .PP
 201 \fI$BUXTON_BUXTON_SOCKET\fR
 202 .RS 4
 203 The path to the Unix Domain Socket used by buxton clients to
 204 communicate with buxtond\&.
 205 .RE
 206
 207 .SH "EXIT STATUS"
 208 .PP
 209 On success, 0 is returned, a non\-zero failure code otherwise\&.
 210
 211 .SH "COPYRIGHT"
 212 .PP
 213 Copyright 2014 Intel Corporation\&. License: Creative Commons
 214 Attribution\-ShareAlike 3.0 Unported\s-2\u[1]\d\s+2\&.
 215
 216 .SH "SEE ALSO"
 217 .PP
 218 \fBbuxton\fR(7),
 219 \fBbuxtond\fR(8),
 220 \fBbuxton\-api\fR(7),
 221 \fBbuxton\&.conf\fR(5)
 222
 223 .SH "NOTES"
 224 .IP " 1." 4
 225 Creative Commons Attribution\-ShareAlike 3.0 Unported
 226 .RS 4
 227 \%http://creativecommons.org/licenses/by-sa/3.0/
 228 .RE