usr.sbin/devfsctl/devfsctl.8

   1 .\"
   2 .\" Copyright (c) 2009
   3 .\"     The DragonFly Project.  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 .\"
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in
  13 .\"    the documentation and/or other materials provided with the
  14 .\"    distribution.
  15 .\" 3. Neither the name of The DragonFly Project nor the names of its
  16 .\"    contributors may be used to endorse or promote products derived
  17 .\"    from this software without specific, prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  22 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  23 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  24 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  25 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  26 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  27 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  28 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  29 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .Dd August 12, 2009
  33 .Os
  34 .Dt DEVFSCTL 8
  35 .Sh NAME
  36 .Nm devfsctl
  37 .Nd manipulate devfs rules
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Fl a
  41 .Fl f Ar file
  42 .Op Fl m Ar mount_point
  43 .Nm
  44 .Fl d
  45 .Fl f Ar file
  46 .Nm
  47 .Fl c
  48 .Op Fl m Ar mount_point
  49 .Nm
  50 .Fl r
  51 .Op Fl m Ar mount_point
  52 .Nm
  53 .Fl h
  54 .Sh DESCRIPTION
  55 The
  56 .Nm
  57 provides an interface to manipulate the in-kernel
  58 .Xr devfs 5
  59 ruleset.
  60 .Pp
  61 The options are as follows:
  62 .Bl -tag -width indent
  63 .It Fl a
  64 Load the ruleset specified by
  65 .Fl f
  66 and apply it.
  67 It will not overwrite currently applied rules,
  68 but just append the new ones.
  69 .It Fl c
  70 Clear the current ruleset.
  71 This does not reset the device nodes, but only clear out all stored rules
  72 so that they are not applied to new nodes.
  73 It is therefore recommended to use this command in conjunction with
  74 .Fl r .
  75 .It Fl d
  76 Reads ruleset specified by
  77 .Fl f
  78 and then dumps its contents to stdout.
  79 The rules will not be applied.
  80 This option cannot be used in conjuction with any other option.
  81 It is useful for checking the correct syntax and order of the specified ruleset
  82 and will show the final interpretation as it would be applied.
  83 .It Fl f Ar file
  84 Specifies the file containing the ruleset to be loaded.
  85 See
  86 .Xr devfs.conf 5
  87 for more information on rule syntax.
  88 This option is a requirement for
  89 .Fl a
  90 and
  91 .Fl d .
  92 .It Fl h
  93 Shows a usage message with a short description of
  94 .Nm Ap s
  95 options.
  96 .It Fl m Ar mount_point
  97 Specifies the mount point to which the loaded rules shall apply.
  98 If this option is not specified, the rules will apply to all
  99 .Xr devfs 5
 100 mountpoints.
 101 The
 102 .Ar mount_point
 103 argument does not accept wildcards and must be an absolute path.
 104 .It Fl r
 105 Reset all
 106 .Xr devfs 5
 107 nodes to their original status.
 108 This does not clear the current ruleset and it is hence recommended
 109 to use this command together with
 110 .Fl c .
 111 .El
 112 .Sh FILES
 113 .Bl -tag -width ".Pa /etc/devfs" -compact
 114 .It Pa /etc/devfs
 115 devfs ruleset files
 116 .El
 117 .Sh SEE ALSO
 118 .Xr devfs 5 ,
 119 .Xr devfs.conf 5 ,
 120 .Xr mount_devfs 8
 121 .Sh HISTORY
 122 The
 123 .Nm
 124 utility appeared in
 125 .Dx 2.3 .
 126 .Sh AUTHORS
 127 .An Alex Hornung