doc/neard.conf.5

   1 .\" neard.conf(5) manual page
   2 .\"
   3 .\" Copyright (C) 2013 Intel Corporation
   4 .\"
   5 .TH "neard.conf" "5" "7 March 2013" ""
   6 .SH NAME
   7 main.conf \- neard configuration file
   8 .SH SYNOPSIS
   9 /etc/neard/main.conf
  10 .br
  11 or
  12 .br
  13 \fI<SYSCONFDIR>\fP/neard/main.conf
  14 .br
  15 where <SYSCONFDIR> depends on your distribution or build.
  16 .SH DESCRIPTION
  17 .P
  18 .I main.conf
  19 is a configuration file for \fBneard\fP (8). The configuration file is
  20 optional but it can be used to set up various aspects of neard's
  21 behavior.
  22 .SH "FILE FORMAT"
  23 .P
  24 The configuration file format is key file format.
  25 It consists of sections (groups) of key-value pairs.
  26 Lines beginning with a '#' and blank lines are considered comments.
  27 Sections are started by a header line containing the section enclosed
  28 in '[' and ']', and ended implicitly by the start of the next section
  29 or the end of the file. Each key-value pair must be contained in a section.
  30 .P
  31 Description of sections and available keys follows:
  32 .SS [General]
  33 This section is the only mandatory section of the configuration file.
  34 .TP
  35 .B ConstantPoll=\fPtrue|false\fP
  36 Enable constant polling. Default is false. Constant polling will force neard
  37 into starting a new polling cycle whenever a target or a device are lost.
  38 .TP
  39 .B DefaultPowered=\fPtrue|false\fP
  40 Automatically turn an adapter on when being discovered.
  41 Default value is false.
  42 .SH "SEE ALSO"
  43 .BR neard (8)