From: kay.sievers@vrfy.org <kay.sievers@vrfy.org>
Date: Tue, 2 Mar 2004 06:38:44 +0000 (-0800)
Subject: [PATCH] udev - man page update
X-Git-Tag: 020~21
X-Git-Url: https://err.no/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=311e9ae68139083c801284a52f498c105d7c09f9;p=systemd

[PATCH] udev - man page update

Here is a small change to the udev man page:

  - clarify the use of the NAME{all_partitions} syntax
    and add a example to udev.rules.example
  - mention the empty NAME field to ignore the device
  - prepare a SYMLINK field for the addition of Andrey's
    "multiple symlinks" documentation :)
---

diff --git a/etc/udev/udev.rules.examples b/etc/udev/udev.rules.examples
index 0d619e37..a464b6ba 100644
--- a/etc/udev/udev.rules.examples
+++ b/etc/udev/udev.rules.examples
@@ -51,6 +51,10 @@ KERNEL="dm-[0-9]*", PROGRAM="/sbin/devmap_name %M %m", NAME="%k", SYMLINK="%c"
 # DRI devices always go into a subdirectory (as per the LSB spec)
 KERNEL="card*", NAME="dri/card%n"
 
+# create all 15 partitions of a USB flash card reader
+# note the trailing spaces in the attribute, use udevinfo(8) to examine your device
+BUS="scsi", SYSFS{model}="CF/MD           ", NAME{all_partitions}="compactflash"
+
 # alsa devices
 KERNEL="controlC[0-9]*", NAME="snd/%k"
 KERNEL="hw[CD0-9]*",     NAME="snd/%k"
diff --git a/udev.8 b/udev.8
index 21ec908b..9eeff96d 100644
--- a/udev.8
+++ b/udev.8
@@ -151,16 +151,15 @@ file.
 Every line in the rules file defines the mapping between device attributes
 and the device file name. One ore more keys are specified to match a rule
 with the current device. If all keys are matching, the rule will be applied
-and the name is used for the device node. One or more optional symlinks
-targeting the node may be specified.
+and the name is used for the device node.
 .br
 If no matching rule is found, the default kernel device name is used.
 .P
-The line format is:
+Every rule consists of a list a comma separated fields:
 .sp
-.I key,[key,...] name [, symlink]
+.IR "key " ,[ "key " ,...] " name " [, " symlink" ]
 .sp
-where keys are:
+where possible fields are:
 .TP
 .B BUS
 Match the bus type of the device.
@@ -196,13 +195,19 @@ Match the returned string of the last
 call. This key may used in any following rule after a
 .B PROGRAM
 call.
-.P
-The
+.TP
 .B NAME
-field given with the attribute
+The name of the node to be created. If the name field is omitted or its
+value is empty, the device will be ignored and no node will be created.
+.br
+If given with the attribute
 .BR NAME{ all_partitions }
-will  create all 15 partitions of a blockdevice.
+it will  create all 15 partitions of a blockdevice.
 This may be useful for removable media devices.
+.TP
+.B SYMLINK
+The name of a symlink targeting the node. Multiple symlinks may be
+specified by separating the names by the space character.
 .P
 .RB "The " NAME " ," SYMLINK " and " PROGRAM
 fields support simple printf-like string substitution: