From 389c403df31b1f63360478e85553bca29439d363 Mon Sep 17 00:00:00 2001 From: Neil Brown Date: Tue, 14 Jun 2005 00:55:05 +0000 Subject: Add man page for mdassemble Signed-off-by: Neil Brown --- ChangeLog | 1 + Makefile | 5 ++++- mdassemble.8 | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 64 insertions(+), 1 deletion(-) create mode 100644 mdassemble.8 diff --git a/ChangeLog b/ChangeLog index 3ce1b6f..0e1f61d 100644 --- a/ChangeLog +++ b/ChangeLog @@ -26,6 +26,7 @@ Changes Prior to 1.12.0 release add them to the list of known device name, so that assembling stacked devices has a better chance of working. - 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 8f0547b..aca9b40 100644 --- a/Makefile +++ b/Makefile @@ -69,7 +69,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 $^ @@ -113,6 +113,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 install : mdadm mdadm.8 md.4 mdadm.conf.5 diff --git a/mdassemble.8 b/mdassemble.8 new file mode 100644 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). -- cgit