docs/90362: [patch] enhancement of devfs.rules manpage.

[Giorgos Keramidas]

The following reply was made to PR docs/90362; it has been noted by GNATS.

From: Giorgos Keramidas <keramida at freebsd.org>
To: Roland Smith <rsmith at xs4all.nl>
Cc: bug-followup at freebsd.org
Subject: Re: docs/90362: [patch] enhancement of devfs.rules manpage.
Date: Mon, 23 Jan 2006 03:30:02 +0200

 > --- devfs.rules.5	2005/12/13 19:59:29	1.6
 > +++ devfs.rules.5	2005/12/13 21:19:53
 
 >  .Pp
 > +.Dl "[localrules=10]"
 >  .Dl "add path 'da*s*' mode 0660 group usb"
 >  .Pp
 > +The first line declares and starts a new ruleset, with the name
 > +.Va localrules
 > +and the number 10. Rulesets should have a unique name and number.  All
 
 "Rulesets should have a unique name and number" is duplicated here,
 since it's also mentioned higher up, in the DESCRIPTION section.
 
 > +rules that follow a ruleset declaration belong to that ruleset, untill a
 
 "untill" is a minor typo.
 
 Overall this is a great idea though, but I'd probably move the general
 ruleset description items in the DESCRIPTION section.  If the following
 looks ok to you too Roland, it would be nice to have it committed I
 guess:
 
 %%%
 Index: devfs.rules.5
 ===================================================================
 RCS file: /home/ncvs/src/share/man/man5/devfs.rules.5,v
 retrieving revision 1.2
 diff -u -r1.2 devfs.rules.5
 --- devfs.rules.5	16 Jun 2005 18:46:17 -0000	1.2
 +++ devfs.rules.5	23 Jan 2006 01:29:23 -0000
 @@ -24,7 +24,7 @@
  .\"
  .\" $FreeBSD: src/share/man/man5/devfs.rules.5,v 1.2 2005/06/16 18:46:17 ru Exp $
  .\"
 -.Dd May 17, 2005
 +.Dd Jan 23, 2006
  .Dt DEVFS.RULES 5
  .Os
  .Sh NAME
 @@ -60,6 +60,27 @@
  It is important to put path elements that contain
  .Xr glob 3
  special characters between quotes.
 +.Pp
 +Rulesets should have a unique name and number.
 +.Pp
 +All rules that follow a ruleset declaration belong to that ruleset, until a
 +new ruleset is started.
 +.Pp
 +All custom rulesets have to be enabled in
 +.Pa /etc/rc.conf ,
 +otherwise they won't be applied to the
 +.Pa /dev
 +file system by the default system startup process.
 +For example, to enable a
 +.Dq Li localrules
 +ruleset for the
 +.Pa /dev
 +file system, you would have to use something like this in your
 +.Pa rc.conf
 +file:
 +.Bd -literal -offset indent
 +devfs_system_ruleset="localrules"
 +.Ed
  .Sh FILES
  .Bl -tag -compact
  .It Pa /etc/devfs.rules
 @@ -72,14 +93,20 @@
  .Dq Li usb
  group, the following rule may be used:
  .Pp
 +.Dl "[localrules=10]"
  .Dl "add path 'da*s*' mode 0660 group usb"
  .Pp
 +The first line declares and starts a new ruleset, with the name
 +.Va localrules
 +and the number 10.
 +.Pp
  To make all the
  .Xr uscanner 4
  devices accessible to their owner and the
  .Dq Li usb
  group, a similar rule may be used:
  .Pp
 +.Dl "[uscanner=20]"
  .Dl "add path 'uscanner*' mode 0660 group usb"
  .Sh SEE ALSO
  .Xr glob 3 ,
 %%%