summaryrefslogtreecommitdiff
path: root/extras/ata_id
diff options
context:
space:
mode:
authorJan Luebbe <jluebbe@lasnet.de>2005-10-31 02:10:56 +0100
committerKay Sievers <kay.sievers@suse.de>2005-10-31 02:10:56 +0100
commit0c25d156b06259f4d0ba4cfafffc8c64c27a0baf (patch)
tree94d65c80987b92bde6b5749365ced48da46cf36f /extras/ata_id
parent2a4ce7092546039063fcf5aaa36760a89d8c9047 (diff)
add man pages for *_id programs
I've written manpages for the *_id binaries, which are attached to this mail.
Diffstat (limited to 'extras/ata_id')
-rw-r--r--extras/ata_id/Makefile4
-rw-r--r--extras/ata_id/ata_id.828
2 files changed, 30 insertions, 2 deletions
diff --git a/extras/ata_id/Makefile b/extras/ata_id/Makefile
index fba0d0b719..4080df1b42 100644
--- a/extras/ata_id/Makefile
+++ b/extras/ata_id/Makefile
@@ -57,11 +57,11 @@ 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: uninstall-man
uninstall-man:
- @echo "Please create a man page for this tool."
+ -rm -f $(DESTDIR)$(mandir)/man8/$(PROG).8
.PHONY: uninstall-man
install-config:
diff --git a/extras/ata_id/ata_id.8 b/extras/ata_id/ata_id.8
new file mode 100644
index 0000000000..0ef9e3ed84
--- /dev/null
+++ b/extras/ata_id/ata_id.8
@@ -0,0 +1,28 @@
+.TH ATA_ID 8 "November 2005" "" "Linux Administrator's Manual"
+.SH NAME
+ata_id \- udev callout to read product/serial number from ATA drives
+.SH SYNOPSIS
+.BI ata_id
+[\fI--export\fP] \fIblockdevice\fP
+.SH "DESCRIPTION"
+.B ata_id
+is normally called from a udev rule, to provide udev with a unique string and
+additional information (uuid, label) for an ATA drive. Udev can use this
+information to create symlinks in /dev/disk/by-id and /dev/disk/by-label
+to the real device node.
+.SH USAGE
+.B ata_id
+opens the blockdevice node specified at the commandline and prints the
+information chosen by the options.
+.SH OPTIONS
+The following commandline switches are supported to specify what ata_id
+should print:
+.TP
+.BI --export
+print all values (instead of only the id)
+.RE
+.SH SEE ALSO
+.BR udev (8)
+.SH AUTHORS
+Developed by Kay Sievers <kay.sievers@vrfy.org>.
+