imsm: fixup examine_brief to be more descriptive in the container only case

[thirdparty/mdadm.git] / mdassemble.8

diff --git a/mdassemble.8 b/mdassemble.8
index 710fd1dcebdf0a7b9d2ee4e8728aa6727a7b4f98..b9c6b48bc0696ff56f17a41abe24f811e8d4fba3 100644 (file)
--- a/mdassemble.8
+++ b/mdassemble.8
@@ -1,9 +1,9 @@
 .\" -*- nroff -*-
-.TH MDASSEMBLE 8 "" v2.2
+.TH MDASSEMBLE 8 "" v3.0
 .SH NAME
 mdassemble \- assemble MD devices
 .I aka
-Linux Software Raid.
+Linux Software RAID
 
 .SH SYNOPSIS
 
@@ -12,7 +12,7 @@ Linux Software Raid.
 .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
+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,
@@ -24,7 +24,14 @@ or
 Invoking
 .B mdassemble
 has the same effect as invoking
-.B mdadm --assemble --scan.
+.B mdadm \-\-assemble \-\-scan.
+.PP
+Invoking
+.B mdassemble
+a second time will make all defined arrays readwrite, this is useful if
+using the
+.B start_ro
+module parameter.
 
 .SH OPTIONS
 
@@ -47,13 +54,12 @@ supports all configuration parameters defined in
 with the exception of
 .B auto=
 which is supported only if mdadm was built with the 
-.B -DMDASSEMBLE_AUTO
+.B \-DMDASSEMBLE_AUTO
 define.
 
 .SH SEE ALSO
 .PP
 .BR mdadm (8),
 .BR mdadm.conf (5),
-.BR md (4).
-.PP
+.BR md (4),
 .BR diet (1).