summaryrefslogtreecommitdiffstats
path: root/share/man/man5/devfs.conf.5
diff options
context:
space:
mode:
authorkeramida <keramida@FreeBSD.org>2005-05-17 17:52:27 +0000
committerkeramida <keramida@FreeBSD.org>2005-05-17 17:52:27 +0000
commitf9c8ec5a2d9990e87346baa3a3b4f8e445ddf8b8 (patch)
tree6fc4e6e8181bfffa02b3a45186350a8d42d280aa /share/man/man5/devfs.conf.5
parentf9dc6611590b073a810a95bd111a17776f1e0f0f (diff)
downloadFreeBSD-src-f9c8ec5a2d9990e87346baa3a3b4f8e445ddf8b8.zip
FreeBSD-src-f9c8ec5a2d9990e87346baa3a3b4f8e445ddf8b8.tar.gz
Add manpages for devfs.conf and devfs.rules. These have been
initially written by Roland, but hacked for a while by me. Any good parts are the results of Roland's hard work. Any typos or style mistakes are mine. Submitted by: Roland Smith <rsmith@xs4all.nl> PR: docs/63808, docs/75433, docs/80458, docs/80459 MFC after: 2 weeks
Diffstat (limited to 'share/man/man5/devfs.conf.5')
-rw-r--r--share/man/man5/devfs.conf.5139
1 files changed, 139 insertions, 0 deletions
diff --git a/share/man/man5/devfs.conf.5 b/share/man/man5/devfs.conf.5
new file mode 100644
index 0000000..4b1acdc
--- /dev/null
+++ b/share/man/man5/devfs.conf.5
@@ -0,0 +1,139 @@
+.\" Copyright (c) 2004 Roland Smith <rsmith@xs4all.nl>
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd May 17, 2005
+.Dt DEVFS.CONF 5
+.Os
+.Sh NAME
+.Nm devfs.conf
+.Nd boot-time devfs configuration information
+.Sh DESCRIPTION
+The
+.Nm
+file provides an easy way to set ownership and permissions, or create
+links for devices available at boot.
+.Pp
+It does not work for devices plugged in and out after the system is up
+and running, e.g.\& USB devices.
+See
+.Xr devfs.rules 5
+for setting ownership and permissions for all device nodes, and
+.Xr usbd.conf 5
+for actions to be taken when USB devices are attached or detached.
+.Pp
+Lines starting with a hash sign
+.Pq Ql #
+and empty lines are ignored.
+The lines that specify
+.Nm
+rules consist of three parameters separated by whitespace:
+.Bl -tag -width indent
+.It Li action
+The action to take for the device.
+The action names are only significant to the first unique character.
+.It Li devname
+The name of the device created by
+.Xr devfs 5
+.It Li arg
+The argument of the
+.Dq Li action
+.El
+.Pp
+The actions currently supported are:
+.Bl -tag -width indent
+.It Li link
+This action creates a symbolic link named
+.Dq Li arg
+that points to
+Dq Li devname ,
+the name of the device created by
+.Xr devfs 5 .
+.It Li own
+This action changes the ownership of
+.Dq Li devname .
+The
+.Dq Li arg
+parameter must be in the form of an
+.Li "owner:group"
+pair, in the same format used by
+.Xr chown 8 .
+.It Li perm
+This action changes the permissions of
+.Dq Li devname .
+The
+.Dq Li arg
+paramater must be a
+.Pa mode
+as explained in
+.Xr chmod 1 .
+.El
+.Sh EXAMPLES
+To create a
+.Pa /dev/cdrom
+link that points to the first
+.Xr SCSI 4
+or
+.Xr atapicam 4
+CD-ROM,
+the following may be added to
+.Nm :
+.Bd -literal -offset indent
+link cd0 cdrom
+.Ed
+.Pp
+Similarly, to link
+.Pa /dev/cdrom
+to the first ATAPI CD-ROM device, the following action may be used:
+.Bd -literal -offset indent
+link acd0 cdrom
+.Ed
+.Pp
+To set the owner of a device, the
+.Dq Li own
+action may be specified:
+.Bd -literal -offset indent
+own cd0 root:cdrom
+.Ed
+.Pp
+To set the permissions of a device, a
+.Dq Li perm
+action should be used:
+.Bd -literal -offset indent
+perm cd0 0660
+.Ed
+.Sh FILES
+.Bl -tag -compact
+.It Pa /etc/devfs.conf
+.It Pa /usr/share/examples/etc/devfs.conf
+.El
+.Sh SEE ALSO
+.Xr chmod 1 ,
+.Xr devfs 5 ,
+.Xr devfs.rules 5 ,
+.Xr usbd.conf 5 ,
+.Xr chown 8
+.Sh AUTHORS
+.An "Roland Smith" Aq rsmith@xs4all.nl
OpenPOWER on IntegriCloud