path_id: add man page

diff --git a/extras/path_id/Makefile b/extras/path_id/Makefile
index 2f6890cb32469e84ef200bc54a238b5a48a3f87e..24b47b425a35c48b846558e904a18b6745a398a0 100644 (file)
--- a/extras/path_id/Makefile
+++ b/extras/path_id/Makefile
@@ -45,7 +45,7 @@ uninstall-bin:
 .PHONY: uninstall-bin
 
 install-man:
-       @echo "Please create a man page for this tool."
+       $(INSTALL_DATA) -D $(PROG).8 $(DESTDIR)$(mandir)/man8/$(PROG).8
 .PHONY: install-man
 
 uninstall-man:

diff --git a/extras/path_id/path_id.8 b/extras/path_id/path_id.8
new file mode 100644 (file)
index 0000000..e55914d
--- /dev/null
+++ b/extras/path_id/path_id.8
@@ -0,0 +1,26 @@
+.TH PATH_ID 8 "April 2007" "" "Linux Administrator's Manual"
+.SH NAME
+path_id \- udev callout to provide the shortest possible unique hardware path
+to a device for the Linux Persistent Device Naming scheme
+.SH SYNOPSIS
+DEVPATH=<devpath>; path_id
+
+path_id <devpath>
+.SH "DESCRIPTION"
+.B path_id
+is normally called from a udev rule, to provide udev a unique hardware path for
+a device. Udev can use this information to create symlinks in /dev/ to the real
+device node.
+.SH EXAMPLES
+For all block devices on a system:
+
+.nf
+for i in `find /sys/class/block`
+do
+       DEVPATH="`echo $i | sed -e 's@^/sys\|/dev@@g'`"; path_id
+done
+.fi
+.SH SEE ALSO
+.BR udev (7)
+.SH AUTHORS
+Developed by Hannes Reinecke <hare@suse.de>.