docs/buxton_set_conf_file.3

   1 '\" t
   2 .TH "BUXTON_SET_CONF_FILE" "3" "buxton 1" "buxton_set_conf_file"
   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_set_conf_file \- Set the path to the Buxton configuration file
  24
  25 .SH "SYNOPSIS"
  26 .nf
  27 \fB
  28 #include <buxton.h>
  29 \fR
  30 .sp
  31 \fB
  32 int buxton_set_conf_file(char *\fIpath\fB)
  33 \fR
  34 .fi
  35
  36 .SH "DESCRIPTION"
  37 .PP
  38 Clients may use a custom Buxton configuration file, referenced by \fIpath\fR\&.
  39 The settings from the new configuration file take effect immediately\&.
  40
  41 .SH "CODE EXAMPLE"
  42 .nf
  43 .sp
  44 #define _GNU_SOURCE
  45 #include <buxton.h>
  46
  47 int main(void)
  48 {
  49         BuxtonClient client;
  50         int fd;
  51
  52         if ((fd = buxton_open(&client)) < 0) {
  53                 printf("couldn't connect\\n");
  54                 return -1;
  55         }
  56
  57         if (!buxton_set_conf_file("/etc/buxton-custom.conf")) {
  58                 printf("failed to set conf file\\n");
  59                 return -1;
  60         }
  61
  62         buxton_close(client);
  63         return 0;
  64 }
  65
  66 .fi
  67
  68 .SH "RETURN VALUE"
  69 .PP
  70 Returns 0 on success, and a non\-zero value on failure\&.
  71
  72 .SH "COPYRIGHT"
  73 .PP
  74 Copyright 2014 Intel Corporation\&. License: Creative Commons
  75 Attribution\-ShareAlike 3.0 Unported\s-2\u[1]\d\s+2, with exception
  76 for code examples found in the \fBCODE EXAMPLE\fR section, which are
  77 licensed under the MIT license provided in the \fIdocs/LICENSE.MIT\fR
  78 file from this buxton distribution\&.
  79
  80 .SH "SEE ALSO"
  81 .PP
  82 \fBbuxton\&.conf\fR(5),
  83 \fBbuxton\fR(7),
  84 \fBbuxtond\fR(8),
  85 \fBbuxton\-api\fR(7)
  86
  87 .SH "NOTES"
  88 .IP " 1." 4
  89 Creative Commons Attribution\-ShareAlike 3.0 Unported
  90 .RS 4
  91 \%http://creativecommons.org/licenses/by-sa/3.0/
  92 .RE