udev.8

   1 .TH UDEV 8 "October 2003" "" "Linux Administrator's Manual"
   2 .SH NAME
   3 udev \- Linux configurable dynamic device naming support
   4 .SH SYNOPSIS
   5 .BI udev " hotplug-subsystem"
   6 .SH "DESCRIPTION"
   7 .B udev
   8 creates or removes device node files usually located in the /dev directory.
   9 Its goal is to provide a dynamic device directory that contains only the files
  10 for devices that are actually present.
  11 .P
  12 As part of the
  13 .B hotplug
  14 subsystem,
  15 .B udev
  16 is executed if a kernel device is added or removed from the system.
  17 On device creation,
  18 .B udev
  19 reads the sysfs directory of the given device to collect device attributes
  20 like label, serial number or bus device number.
  21 These attributes are treated as a key
  22 to determine a unique name for device file creation.
  23 .B udev
  24 maintains a database for devices present on the system.
  25 .br
  26 On device removal,
  27 .B udev
  28 queries the internal database for the name of the device file to be deleted.
  29 .SH "CONFIGURATION"
  30 .B udev
  31 expects its configuration at
  32 .I /etc/udev/udev.config.
  33 The file consists of a set of lines. All empty lines and
  34 lines beginning with a '#' will be ignored.
  35 .br
  36 Every line defines the mapping between device attributes and the device file
  37 name. It starts with a keyword defining the method used to match, followed by
  38 one ore more keys to compare and the filename for the device. If no matching
  39 configuration is found, the default kernel device name is used.
  40 .P
  41 The line format is:
  42 .RS
  43 .sp
  44 .I method, key,[key,...] name
  45 .sp
  46 .RE
  47 where valid methods with corresponding keys are:
  48 .TP
  49 .B LABEL
  50 device label or serial number, like USB serial number, SCSI UUID or
  51 file system label
  52 .br
  53 keys: \fBBUS\fP, \fIsysfs_attribute\fP
  54 .TP
  55 .B NUMBER
  56 device number on the bus, like PCI bus id
  57 .br
  58 keys: \fBBUS\fP, \fBID\fP
  59 .TP
  60 .B TOPOLOGY
  61 device position on bus, like physical port of USB device
  62 .br
  63 keys: \fBBUS\fP, \fBPLACE\fP
  64 .TP
  65 .B REPLACE
  66 string replacement of the kernel device name
  67 .br
  68 key: \fBKERNEL_NAME\fP
  69 .TP
  70 .B CALLOUT
  71 calling external program, that returns a string to match
  72 .br
  73 keys: \fBBUS\fP, \fBPROGRAM\fP, \fBID\fP
  74 .P
  75 The name field supports simple printf-like string subtitution:
  76 .RS
  77 .TP
  78 .B %n
  79 the "kernel number" of the device
  80 for example, 'sda3' has a "kernel number" of '3'
  81 .TP
  82 .B %M
  83 the kernel major number for the device
  84 .TP
  85 .B %m
  86 the kernel minor number for the device
  87 .TP
  88 .B %b
  89 the bus id for the device
  90 .RE
  91 .P
  92 A sample \fIudev.conf\fP might look like this:
  93 .sp
  94 .nf
  95 # USB printer to be called lp_color
  96 LABEL, BUS="usb", serial="W09090207101241330", NAME="lp_color"
  97
  98 # sound card with PCI bus id 00:0b.0 to be called dsp
  99 NUMBER, BUS="pci", ID="00:0b.0", NAME="dsp"
 100
 101 # USB mouse at third port of the second hub to be called mouse1
 102 TOPOLOGY, BUS="usb", PLACE="2.3", NAME="mouse1"
 103
 104 # ttyUSB1 should always be called pda
 105 REPLACE, KERNEL="ttyUSB1", NAME="pda"
 106
 107 # if /sbin/scsi_id returns "OEM 0815" device will be called disk1
 108 CALLOUT, PROGRAM="/sbin/scsi_id" BUS="scsi", ID="OEM 0815" NAME="disk1"
 109
 110 # USB webcams to be called webcam0, webcam1, ...
 111 LABEL, BUS="usb", model="WebCam Version 3", NAME="webcam%n"
 112 .fi
 113 .P
 114 Permissions and ownership for the created device files may specified at
 115 .I /etc/udev/udev.permissions.
 116 The file consists of a set of lines. All empty lines and
 117 lines beginning with a '#' will be ignored.
 118 .br
 119 Every line lists a device name followed by owner, group and permission mode. All values are separated by colons.
 120 .sp
 121 A sample \fIudev.permissions\fP might look like this:
 122 .sp
 123 .nf
 124 #name:user:group:mode
 125 ttyUSB1:root:uucp:0666
 126 dsp1:::0666
 127 .fi
 128
 129 .SH "FILES"
 130 .nf
 131 .ft B
 132 .ft
 133 /sbin/udev                           udev program
 134 /etc/udev/*                          udev config and database files
 135 /etc/hotplug.d/default/udev.hotplug  hotplug symlink to udev program
 136 .fi
 137 .LP
 138 .SH "SEE ALSO"
 139 .BR hotplug (8)
 140 .PP
 141 The
 142 .I http://linux-hotplug.sourceforge.net/
 143 web site.
 144 .SH AUTHORS
 145 .B udev
 146 was developed by Greg Kroah-Hartman <greg@kroah.com> with much help from
 147 Dan Stekloff <dsteklof@us.ibm.com> and many others.