Document lvm.conf fields

man/Makefile.in

@@ -20,16 +20,23 @@ srcdir = @srcdir@
 top_srcdir = @top_srcdir@
 VPATH = @srcdir@
 
-MANUALS=$(wildcard *.8)
+MAN5=lvm.conf.5
+MAN8=lvm.8
+MAN5DIR=${mandir}/man5
 MAN8DIR=${mandir}/man8
 
 include ../make.tmpl
 
 install:
 	@echo "*** Installing $(ALL_MANUALS) in $(DESTDIR)$(MAN8DIR) ***"
-	@for f in $(MANUALS); \
+	@for f in $(MAN8); \
 	do \
 	   $(RM) $(DESTDIR)$(MAN8DIR)/$$f; \
 	   @INSTALL@ -D -o $(OWNER) -g $(GROUP) -m 444 $$f $(DESTDIR)$(MAN8DIR)/$$f; \
 	done
 
+	@for f in $(MAN5); \
+	do \
+	   $(RM) $(DESTDIR)$(MAN5DIR)/$$f; \
+	   @INSTALL@ -D -o $(OWNER) -g $(GROUP) -m 444 $$f $(DESTDIR)$(MAN5DIR)/$$f; \
+	done

man/lvm.8

@@ -0,0 +1,13 @@
+.TH LVM 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*-
+.SH NAME
+lvm \- LVM2 tools
+.SH SYNOPSIS
+.B lvm
+.SH DESCRIPTION
+.SH FILES
+.I /etc/lvm/lvm.conf
+.br
+.I $HOME/.lvm_history
+.fi
+.SH SEE ALSO
+.BR lvm.conf(5)

man/lvm.conf.5

@@ -0,0 +1,61 @@
+.TH LVM.CONF 5 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*-
+.SH NAME
+lvm.conf \- Configuration file for LVM2
+.SH SYNOPSIS
+.B /etc/lvm/lvm.conf
+.SH DESCRIPTION
+lvm.conf is read during the initialisation phase of 
+\fBlvm\fP.
+.LP
+Syntax \(em To be written
+.LP
+The sections that may be present in the file are:
+.TP
+\fBdevices\fP \(em Device settings
+.IP
+\fBdir\fP \(em Directory in which to create volume group device nodes.
+Defaults to "/dev".
+.IP
+\fBscan\fP \(em List of directories to scan recursively for 
+LVM physical volumes.
+Devices in directories outside this hierarchy will be ignored.
+Defaults to "/dev".
+.IP
+\fBfilter\fP \(em List of patterns to apply to devices found by a scan.
+Patterns are regular expressions delimited by any character and preceded
+by \fBa\fP (for accept) or \fBr\fP (for reject).  The list is traversed
+in order, and the first regex that matches determines if the device
+will be accepted or rejected (ignored).  Devices that don't match
+any patterns are accepted.
+For example, to ignore /dev/cdrom you could use:
+\fBdevices { filter=["r|cdrom|"] }\fP 
+.TP
+\fBlog\fP \(em Default log settings
+.IP
+\fBfile\fP \(em Location of log file.  If this entry is not present, no
+log file is written.
+.IP
+\fBoverwrite\fP \(em Set to 1 to overwrite the log file each time a tool
+is invoked.  By default tools append messages to the log file.
+.IP
+\fBlevel\fP \(em Log level (0-9) of messages to write to the file.
+9 is the most verbose; 0 should produce no output.
+.IP
+\fBverbose\fP \(em Default level (0-3) of messages sent to stdout or stderr.
+3 is the most verbose; 0 should produce the least output.
+.TP
+\fBbackups\fP \(em Configuration for metadata backups
+.IP
+\fBdir\fP \(em Directory used for automatic metadata backups
+(defaults to "/etc/lvm")
+.TP
+\fBshell\fP \(em LVM2 built-in readline shell settings
+.IP
+\fBhistory_size\fP \(em Maximum number of lines of shell history to retain (default 100) in $HOME/.lvm_history
+.SH FILES
+.I /etc/lvm/lvm.conf
+.br
+.I $HOME/.lvm_history
+.fi
+.SH SEE ALSO
+.BR lvm(8)

man/pvdisplay.8

@@ -1,67 +0,0 @@
-.TH PVDISPLAY 8 "LVM TOOLS" "Heinz Mauelshagen" \" -*- nroff -*-
-.SH NAME
-pvdisplay \- display attributes of a physical volume
-.SH SYNOPSIS
-.B pvdisplay
-[\-c/\-\-colon] [\-d/\-\-debug] [\-h/\-?/\-\-help] [\-s/\-\-short]
-[\-v[v]/\-\-verbose [\-\-verbose]]
-PhysicalVolumePath [PhysicalVolumePath...]
-.SH DESCRIPTION
-pvdisplay allows you to see the attributes of one or more physical volumes
-like size, physical extent size, space used for the volume group descriptor
-area and so on.
-.SS OPTIONS
-.TP
-.I \-c, \-\-colon
-Generate colon seperated output for easier parsing in scripts or programs.
-.nf
-
-The values are:
-
-* physical volume device name
-* volume group name
-* physical volume size in kilobytes
-* internal physical volume number
-* physical volume status
-* physical volume (not) allocatable
-* current number of logical volumes on this physical volume
-* physical extent size in kilobytes
-* total number of physical extents
-* free number of physical extents
-* allocated number of physical extents
-
-.fi
-.TP
-.I \-d, \-\-debug
-Enables additional debugging output (if compiled with DEBUG).
-.TP
-.I \-h, \-?, \-\-help
-Print a usage message on standard output and exit successfully.
-.TP
-.I \-s, \-\-short
-Only display the size of the given physical volumes.
-.TP
-.I \-v, \-\-verbose
-Display the mapping of physical extents to logical volumes and
-logical extents.
-.TP
-.I \-vv, \-\-verbose \-\-verbose
-Like \-v with verbose runtime information about pvdisplay's activities.
-.SH DIAGNOSTICS
-pvdisplay returns an code state of 0 for success and > 0 for error:
-.nf
-
-1  no physical volume name on command line
-2  error checking consistency of physical volume
-3  error reading physical extent information from physical volume
-
-95 driver/module not in kernel
-96 invalid I/O protocol version
-97 error locking logical volume manager
-98 invalid lvmtab (run vgscan(8))
-99 invalid command line
-.fi
-.SH See also
-lvm(8), pvcreate(8), lvcreate(8), vgcreate(8)
-.SH AUTHOR
-Heinz Mauelshagen <Linux-LVM@Sistina.com>