chiark / gitweb /
add man pages for *_id programs
authorJan Luebbe <jluebbe@lasnet.de>
Mon, 31 Oct 2005 01:10:56 +0000 (02:10 +0100)
committerKay Sievers <kay.sievers@suse.de>
Mon, 31 Oct 2005 01:10:56 +0000 (02:10 +0100)
I've written manpages for the *_id binaries, which are attached to this
mail.

extras/ata_id/Makefile
extras/ata_id/ata_id.8 [new file with mode: 0644]
extras/cdrom_id/Makefile
extras/cdrom_id/cdrom_id.8 [new file with mode: 0644]
extras/dasd_id/Makefile
extras/dasd_id/dasd_id.8 [new file with mode: 0644]
extras/edd_id/Makefile
extras/edd_id/edd_id.8 [new file with mode: 0644]
extras/volume_id/Makefile
extras/volume_id/vol_id.8 [new file with mode: 0644]

index fba0d0b..4080df1 100644 (file)
@@ -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 (file)
index 0000000..0ef9e3e
--- /dev/null
@@ -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>.
+
index f06d2c6..f112067 100644 (file)
@@ -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/cdrom_id/cdrom_id.8 b/extras/cdrom_id/cdrom_id.8
new file mode 100644 (file)
index 0000000..8c95e93
--- /dev/null
@@ -0,0 +1,27 @@
+.TH CDROM_ID 8 "November 2005" "" "Linux Administrator's Manual"
+.SH NAME
+cdrom_id \- udev callout to determine the capabilities of cd/dvd drives
+.SH SYNOPSIS
+.BI cdrom_id
+[\fI--export\fP] \fIblockdevice\fP
+.SH "DESCRIPTION"
+.B cdrom_id
+is normally called from a udev rule, to provide udev with the capabilities
+of a cdrom or dvdrom drive. Udev can use this information to create
+symlinks like /dev/cdrom or /dev/dvd to the real device node.
+.SH USAGE
+.B cdrom_id
+opens the blockdevice node specified at the commandline and prints the
+discovered capabilities.
+.SH OPTIONS
+The following commandline switches are supported to specify what cdrom_id
+should print:
+.TP
+.BI --export
+print all values (default)
+.RE
+.SH SEE ALSO
+.BR udev (8)
+.SH AUTHORS
+Developed by Greg Kroah\-Hartman <greg@kroah.com>.
+
index 698253a..a995c78 100644 (file)
@@ -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/dasd_id/dasd_id.8 b/extras/dasd_id/dasd_id.8
new file mode 100644 (file)
index 0000000..c3d4075
--- /dev/null
@@ -0,0 +1,28 @@
+.TH DASD_ID 8 "November 2005" "" "Linux Administrator's Manual"
+.SH NAME
+dasd_id \- udev callout to read label from s390 block device
+.SH SYNOPSIS
+.BI dasd_id
+[\fI--export\fP] \fIblockdevice\fP
+.SH "DESCRIPTION"
+.B dasd_id
+is normally called from a udev rule, to provide udev with a unique string and
+additional information (type, serial) for an S390 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 dasd_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 dasd_id
+should print:
+.TP
+.BI --export
+print all values (instead of only the serial)
+.RE
+.SH SEE ALSO
+.BR udev (8)
+.SH AUTHORS
+Developed by Arnd Bergmann <arnd@arndb.de> and Kay Sievers <kay.sievers@vrfy.org>.
+
index 65e023f..469d6d4 100644 (file)
@@ -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/edd_id/edd_id.8 b/extras/edd_id/edd_id.8
new file mode 100644 (file)
index 0000000..8d5fd4f
--- /dev/null
@@ -0,0 +1,27 @@
+.TH EDD_ID 8 "November 2005" "" "Linux Administrator's Manual"
+.SH NAME
+edd_id \- udev callout to identify BIOS disk drives via EDD
+.SH SYNOPSIS
+.BI edd_id
+[\fI--export\fP] \fIblockdevice\fP
+.SH "DESCRIPTION"
+.B edd_id
+is normally called from a udev rule, to provide udev with the edd id for
+a BIOS disk 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 edd_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 edd_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 John Hull <john_hull@dell.com> and Kay Sievers <kay.sievers@vrfy.org>.
+
index a936e43..23de2ba 100644 (file)
@@ -60,11 +60,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/volume_id/vol_id.8 b/extras/volume_id/vol_id.8
new file mode 100644 (file)
index 0000000..6ffe7ce
--- /dev/null
@@ -0,0 +1,41 @@
+.TH VOL_ID 8 "November 2005" "" "Linux Administrator's Manual"
+.SH NAME
+vol_id \- probe filesystem type and read label and uuid
+.SH SYNOPSIS
+.BI vol_id
+[\fI--export\fP|\fI-t\fP|\fI-l\fP|\fI-u\fP] \fIblockdevice\fP
+.SH "DESCRIPTION"
+.B vol_id
+is normally called from a udev rule, to provide udev with the
+label and uuid of a filesystem. vol_id supports all common
+filesystem formats and detects various raid setups to prevent
+the recognition of raid members as a filesystem.
+.SH USAGE
+.B vol_id
+opens the device node specified at the commandline.
+.SH OPTIONS
+The following commandline switches are supported to specify what vol_id
+should print:
+.TP
+.BI --export
+print all values in key/value format to import them into the environment.
+.TP
+.BI -l
+print the label of the partition
+.TP
+.BI -t
+print the type of the partition
+.TP
+.BI -u
+print the uuid of the partition
+.RE
+.SH EXIT STATUS
+.B vol_id
+will only return successful if the string asked for is not empty.
+All trailing whitespace will be removed, spaces replaced by underscore
+and slashes ignored.
+.SH SEE ALSO
+.BR udev (8)
+.SH AUTHORS
+Developed by Kay Sievers <kay.sievers@vrfy.org>.
+