Add man page for mdassemble

Signed-off-by: Neil Brown <neilb@cse.unsw.edu.au>

diff --git a/ChangeLog b/ChangeLog
index f2f1c1183b6af5d9f72627026c6fd57ddcd5e97d..0daf2181bc95177f529c8f98b6ab05c77a812f93 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -21,6 +21,7 @@ Changes Prior to this release
        stable aspect of the array
     -   Allow --force with --grow so '-Gfn1' works (on raid1)
     -   Replace sprintf calls with snprintf (to quiet diet-libc)
+    -   Add man page for mdassemble
        
 Changes Prior to 1.11.0 release
     -   Fix embarassing bug which causes --add to always fail.

diff --git a/Makefile b/Makefile
index fd086057782ab38ff10d35811fcf237f583ffc0e..77a4c2361406a361a423e0a2cdf346b1cfc04846 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -72,7 +72,7 @@ endif
 
 all : mdadm mdadm.man md.man mdadm.conf.man
 
-everything: all mdadm.static mdadm.tcc mdadm.uclibc
+everything: all mdadm.static mdadm.tcc mdadm.uclibc  mdassemble mdassemble.uclibc mdassemble.static mdassemble.man
 
 mdadm : $(OBJS)
        $(CC) $(LDFLAGS) -o mdadm $^
@@ -116,6 +116,9 @@ md.man : md.4
 mdadm.conf.man : mdadm.conf.5
        nroff -man mdadm.conf.5 > mdadm.conf.man
 
+mdassemble.man : mdassemble.8
+       nroff -man mdassemble.8 > mdassemble.man
+
 $(OBJS) : mdadm.h bitmap.h
 
 install : mdadm mdadm.8 md.4 mdadm.conf.5

diff --git a/mdassemble.8 b/mdassemble.8
new file mode 100644 (file)
index 0000000..f003196
--- /dev/null
+++ b/mdassemble.8
@@ -0,0 +1,59 @@
+.\" -*- nroff -*-
+.TH MDASSEMBLE 8 "" v1.11.0
+.SH NAME
+mdassemble \- assemble MD devices
+.I aka
+Linux Software Raid.
+
+.SH SYNOPSIS
+
+.BI mdassemble
+
+.SH DESCRIPTION 
+.B mdassemble
+is a tiny program that can be used to assemble MD devices inside an
+initial ramdisk (initrd) or initramfs, it is meant to replace the in-kernel
+automatic raid detection and activation.
+It can be built statically and linked against lightweight libc alternatives, like
+.B dietlibc,
+.B klibc
+or
+.B uClibc.
+
+.SH USAGE
+Invoking
+.B mdassemble
+has the same effect as invoking
+.B mdadm --assemble --scan.
+
+.SH OPTIONS
+
+There are no options to
+.B mdassemble.
+
+.SH FILES
+
+.SS /etc/mdadm.conf
+
+The config file lists which devices may be scanned to see if
+they contain MD super block, and gives identifying information
+(e.g. UUID) about known MD arrays.  See
+.BR mdadm.conf (5)
+for more details.
+
+.B mdassemble
+supports all configuration parameters defined in
+.B mdadm.conf
+with the exception of
+.B auto=
+which is supported only if mdadm was built with the 
+.B -DMDASSEMBLE_AUTO
+define.
+
+.SH SEE ALSO
+.PP
+.BR mdadm (8),
+.BR mdadm.conf (5),
+.BR md (4).
+.PP
+.BR diet (1).