sbin/devd/devd.conf.5

   1 .\"
   2 .\" Copyright (c) 2002 M. Warner Losh
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. The name of the author may not be used to endorse or promote products
  11 .\"    derived from this software without specific prior written permission.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .\" The section on comments was taken from named.conf.5, which has the
  28 .\" following copyright:
  29 .\" Copyright (c) 1999-2000 by Internet Software Consortium
  30 .\"
  31 .\" Permission to use, copy, modify, and distribute this software for any
  32 .\" purpose with or without fee is hereby granted, provided that the above
  33 .\" copyright notice and this permission notice appear in all copies.
  34 .\"
  35 .\" THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
  36 .\" ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
  37 .\" OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
  38 .\" CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
  39 .\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  40 .\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
  41 .\" ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  42 .\" SOFTWARE.
  43 .\"
  44 .Dd October 17, 2002
  45 .Dt DEVD.CONF 5
  46 .Os
  47 .Sh NAME
  48 .Nm devd.conf
  49 .Nd configuration file for
  50 .Xr devd 8
  51 .Sh DESCRIPTION
  52 .Ss General Syntax
  53 A
  54 .Xr devd 8
  55 configuration consists of two general features, statements
  56 and comments.
  57 All statements end with a semicolon.
  58 Many statements can contain substatements, which are also
  59 terminated with a semicolon.
  60 .Pp
  61 The following statements are supported:
  62 .Bl -tag -width ".Ic options"
  63 .It Ic options
  64 specifies various options and parameters for the operation of
  65 .Xr devd 8 .
  66 .It Ic attach
  67 specifies various matching criteria and actions to perform when
  68 a newly attached device matches said criteria.
  69 .It Ic detach
  70 specifies various matching criteria and actions to perform when
  71 a newly detached device matches said criteria.
  72 .It Ic nomatch
  73 specifies various matching criteria and actions to perform when
  74 no device driver currently loaded in the kernel claims a (new)
  75 device.
  76 .El
  77 .Pp
  78 Statements may occur in any order in the configuration file, and may be
  79 repeated as often as required.
  80 Further details on the syntax and meaning of each statement and their
  81 substatements are explained below.
  82 .Pp
  83 Comments may appear anywhere that whitespace may appear in a
  84 configuration file.
  85 To appeal to programmers of all kinds, they can
  86 be written in C, C++, or shell/Perl constructs.
  87 .Pp
  88 C-style comments start with the two characters
  89 .Ql /*
  90 (slash, star) and end with
  91 .Ql */
  92 (star, slash).
  93 Because they are completely delimited with these characters,
  94 they can be used to comment only a portion of a line or to span
  95 multiple lines.
  96 .Pp
  97 C-style comments cannot be nested.
  98 For example, the following is
  99 not valid because the entire comment ends with the first
 100 .Ql */ :
 101 .Bd -literal -offset indent
 102 /* This is the start of a comment.
 103    This is still part of the comment.
 104 /* This is an incorrect attempt at nesting a comment. */
 105    This is no longer in any comment. */
 106 .Ed
 107 .Pp
 108 C++-style comments start with the two characters
 109 .Ql //
 110 (slash, slash) and continue to the end of the physical line.
 111 They cannot be continued across multiple physical lines; to have
 112 one logical comment span multiple lines, each line must use the
 113 .Ql //
 114 pair.
 115 For example:
 116 .Bd -literal -offset indent
 117 // This is the start of a comment.  The next line
 118 // is a new comment, even though it is logically
 119 // part of the previous comment.
 120 .Ed
 121 .Sh FILES
 122 .Bl -tag -width ".Pa /etc/devd.conf" -compact
 123 .It Pa /etc/devd.conf
 124 The
 125 .Xr devd 8
 126 configuration file.
 127 .El
 128 .Sh SEE ALSO
 129 .Xr devd 8