From 57df0207aa51216f6ed6ab54c04cc14c295490c5 Mon Sep 17 00:00:00 2001 From: Adam Buchbinder Date: Mon, 16 Mar 2009 16:22:51 -0400 Subject: [PATCH 1/1] usb_id: add manpage Signed-off-by: Adam Buchbinder --- extras/usb_id/Makefile.am | 3 +++ extras/usb_id/usb_id.8 | 38 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 41 insertions(+) create mode 100644 extras/usb_id/usb_id.8 diff --git a/extras/usb_id/Makefile.am b/extras/usb_id/Makefile.am index dfb52f17e..07b286d61 100644 --- a/extras/usb_id/Makefile.am +++ b/extras/usb_id/Makefile.am @@ -12,3 +12,6 @@ usb_id_SOURCES = \ ../../udev/lib/libudev-util.c \ ../../udev/lib/libudev-device.c \ ../../udev/lib/libudev-enumerate.c + +dist_man_MANS = \ + usb_id.8 diff --git a/extras/usb_id/usb_id.8 b/extras/usb_id/usb_id.8 new file mode 100644 index 000000000..0d5c0958b --- /dev/null +++ b/extras/usb_id/usb_id.8 @@ -0,0 +1,38 @@ +.TH USB_ID 8 "January 2009" "" "Linux Administrator's Manual" +.SH NAME +usb_id \- udev callout to read information from USB devices +.SH SYNOPSIS +.B usb_id +[\fB--usb-info\fP] [\fB--num-info\fP] [\fB--export\fP] [\fB--debug\fP] +.I devpath +.br +.B usb_id --help +.SH "DESCRIPTION" +.B usb_id +is normally called from a udev rule, to provide udev with a unique string and +additional information (uuid, label) for a USB device. Udev can use this +information to create symlinks in /dev to the real device node. +.SH USAGE +.B usb_id \fIdevpath\fP +opens the device node specified at the commandline and prints the +information chosen by the options. +.SH OPTIONS +The following commandline switches are supported to specify what usb_id +should print: +.TP +.B -u, --usb-info +print USB strings instead of, e.g. SCSI strings for a mass storage device +.TP +.B -n, --num-info +print numerical values instead of strings. Implies \fB--usb-info\fP. +.TP +.B -x, --export +print values as environment keys +.TP +.B -h, --help +print usage help +.RE +.SH SEE ALSO +.BR udev (7) +.SH AUTHORS +Developed by Hannes Reinecke . -- 2.30.2