xref: /freebsd/share/man/man5/devfs.conf.5 (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1.\" Copyright (c) 2004 Roland Smith <rsmith@xs4all.nl>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
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.Dd May 25, 2019
28.Dt DEVFS.CONF 5
29.Os
30.Sh NAME
31.Nm devfs.conf
32.Nd boot-time devfs configuration information
33.Sh DESCRIPTION
34The
35.Nm
36file provides an easy way to set ownership and permissions, or create
37links for devices available at boot.
38.Pp
39It does not work for devices plugged in and out after the system is up
40and running, e.g.\& USB devices.
41See
42.Xr devfs.rules 5
43for setting ownership and permissions for all device nodes, and
44.Xr devd.conf 5
45for actions to be taken when devices are attached or detached.
46.Pp
47Lines starting with a hash sign
48.Pq Ql #
49and empty lines are ignored.
50The lines that specify
51.Nm
52rules consist of three parameters separated by whitespace:
53.Bl -tag -width indent
54.It Ar action
55The action to take for the device.
56The action names are only significant to the first unique character.
57.It Ar devname
58The name of the device created by
59.Xr devfs 5 .
60.It Ar arg
61The argument of the
62.Ar action .
63.El
64.Pp
65The actions currently supported are:
66.Bl -tag -width indent
67.It Ic link
68This action creates a symbolic link named
69.Ar arg
70that points to
71.Ar devname ,
72the name of the device created by
73.Xr devfs 5 .
74.It Ic own
75This action changes the ownership of
76.Ar devname .
77The
78.Ar arg
79parameter must be in the form of an
80.Ar owner Ns : Ns Ar group
81pair, in the same format used by
82.Xr chown 8 .
83.It Ic perm
84This action changes the permissions of
85.Ar devname .
86The
87.Ar arg
88parameter must be a
89.Ar mode
90as explained in
91.Xr chmod 1 .
92.El
93.Sh FILES
94.Bl -tag -compact -width Pa
95.It Pa /etc/devfs.conf
96.It Pa /usr/share/examples/etc/devfs.conf
97.El
98.Sh EXAMPLES
99To create a
100.Pa /dev/cdrom
101link that points to the first CD-ROM,
102the following may be added to
103.Nm :
104.Bd -literal -offset indent
105link	cd0	cdrom
106.Ed
107.Pp
108To set the owner of a device, the
109.Ic own
110action may be specified:
111.Bd -literal -offset indent
112own	cd0	root:cdrom
113.Ed
114.Pp
115To set the permissions of a device, a
116.Ic perm
117action should be used:
118.Bd -literal -offset indent
119perm	cd0	0660
120.Ed
121.Sh SEE ALSO
122.Xr chmod 1 ,
123.Xr devd.conf 5 ,
124.Xr devfs 5 ,
125.Xr devfs.rules 5 ,
126.Xr chown 8
127.Sh AUTHORS
128This manual page was written by
129.An Roland Smith Aq Mt rsmith@xs4all.nl .
130