Allow symlink creation to be disabled from command line or mdadm.conf

[thirdparty/mdadm.git] / mdadm.8

diff --git a/mdadm.8 b/mdadm.8
index 58152b753ff880274f3ab3ad0e42ba88477ee2db..3ebef842b3934f0e88d99f07b5acee1b50cb1b01 100644 (file)
--- a/mdadm.8
+++ b/mdadm.8
@@ -1,5 +1,11 @@
 .\" -*- nroff -*-
-.TH MDADM 8 "" v2.5
+''' Copyright Neil Brown and others.
+'''   This program is free software; you can redistribute it and/or modify
+'''   it under the terms of the GNU General Public License as published by
+'''   the Free Software Foundation; either version 2 of the License, or
+'''   (at your option) any later version.
+''' See file COPYING in distribution for details.
+.TH MDADM 8 "" v2.5.3
 .SH NAME
 mdadm \- manage MD devices
 .I aka
@@ -588,6 +594,28 @@ number will be considered unused if there is no active array for that
 number, and there is no entry in /dev for that number and with a
 non-standard name.
 
+.TP
+.BR --symlink = no
+Normally when
+.B --auto
+causes
+.I mdadm
+to create devices in
+.B /dev/md/
+it will also create symlinks from
+.B /dev/
+with names starting with
+.B md
+or
+.BR md_ .
+Use
+.B --symlink=no
+to suppress this, or
+.B --symlink=yes
+to enforce this even if it is suppressing
+.IR mdadm.conf .
+
+
 .SH For assemble:
 
 .TP
@@ -702,7 +730,7 @@ this adjustment automatically.
 The
 .B uuid
 option will change the uuid of the array.  If a UUID is given with the
-"--uuid" option that UUID will be used as a new UUID and with
+"--uuid" option that UUID will be used as a new UUID and will
 .B NOT
 be used to help identify the devices in the array.
 If no "--uuid" is given, a random uuid is chosen.