diff options
| author | Jan Luebbe <jluebbe@lasnet.de> | 2005-10-31 02:10:56 +0100 |
|---|---|---|
| committer | Kay Sievers <kay.sievers@suse.de> | 2005-10-31 02:10:56 +0100 |
| commit | 0c25d156b06259f4d0ba4cfafffc8c64c27a0baf (patch) | |
| tree | 94d65c80987b92bde6b5749365ced48da46cf36f /extras/volume_id | |
| parent | 2a4ce7092546039063fcf5aaa36760a89d8c9047 (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/volume_id')
| -rw-r--r-- | extras/volume_id/Makefile | 4 | ||||
| -rw-r--r-- | extras/volume_id/vol_id.8 | 41 |
2 files changed, 43 insertions, 2 deletions
diff --git a/extras/volume_id/Makefile b/extras/volume_id/Makefile index a936e43bb2..23de2ba091 100644 --- a/extras/volume_id/Makefile +++ b/extras/volume_id/Makefile @@ -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 index 0000000000..6ffe7ce220 --- /dev/null +++ b/extras/volume_id/vol_id.8 @@ -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>. + |