b=23428 Fix lustre built with --enable-lu_ref

[fs/lustre-release.git] / lustre / doc / mkfs.lustre.8

diff --git a/lustre/doc/mkfs.lustre.8 b/lustre/doc/mkfs.lustre.8
index b469034..6f17ddb 100644 (file)
--- a/lustre/doc/mkfs.lustre.8
+++ b/lustre/doc/mkfs.lustre.8
@@ -1,17 +1,16 @@
 .\" -*- nroff -*-
 .\" -*- nroff -*-

-.\" Copyright 2006 by Cluster FileSystems.  All Rights Reserved.
+.\" Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.

 .\" This file may be copied under the terms of the GNU Public License.
 .\"
 .\" This file may be copied under the terms of the GNU Public License.
 .\"

-.TH mkfs.lustre 8 "2006 Jun 15" Lustre "configuration utilities"
+.TH mkfs.lustre 8 "2008 Mar 15" Lustre "configuration utilities"

 .SH NAME
 mkfs.lustre \- format a disk for a Lustre service
 .SH SYNOPSIS
 .br
 .SH NAME
 mkfs.lustre \- format a disk for a Lustre service
 .SH SYNOPSIS
 .br

-.B mkfs.lustre
-<target_type> [options] 
+.BR mkfs.lustre { --ost | --mdt | --mgs }
+.I [options] 

 .I device
 .br
 .I device
 .br

-where

 .B <target_type>
 is one of
 .TP
 .B <target_type>
 is one of
 .TP


@@ -43,11 +42,15 @@ Set user comment about this disk, ignored by Lustre.
 .BI \--device-size= KB
 Set device size for loop devices
 .TP
 .BI \--device-size= KB
 Set device size for loop devices
 .TP

+.BI \--dryrun
+Only print what would be done; does not affect the disk
+.TP

 .BI \--failnode= nid,...  
 Set the NID(s) of a failover partner. This option can be repeated as desired.
 .TP
 .BI \--fsname= filesystem_name  
 .BI \--failnode= nid,...  
 Set the NID(s) of a failover partner. This option can be repeated as desired.
 .TP
 .BI \--fsname= filesystem_name  

-The Lustre filesystem this service will be part of.  Default is 'lustre'
+The Lustre filesystem this service will be part of.  The maximum
+filesystem_name length is 8 characters. Default is 'lustre'

 .TP
 .BI \--index= index
 Force a particular OST or MDT index 
 .TP
 .BI \--index= index
 Force a particular OST or MDT index 


@@ -56,36 +59,43 @@ Force a particular OST or MDT index
 Format options for the backing fs. For example, ext3 options could be set here.
 .TP
 .BI \--mountfsoptions= opts
 Format options for the backing fs. For example, ext3 options could be set here.
 .TP
 .BI \--mountfsoptions= opts

-Set permanent mount options, equivalent to setting in /etc/fstab
+Set the mount options that will be used when mounting the backing fs.
+WARNING: unlike earlier versions of \fBmkfs.lustre\fR, this version completely
+replaces the default mount options with those specified on the command line,
+issuing a warning on stderr if any of the default mount options are omitted.
+The defaults for \fIldiskfs\fR are
+OST: \fIerrors=remount-ro,mballoc,extents\fR;
+MGS/MDT: \fIerrors=remount-ro,iopen_nopriv,user_xattr\fR.
+\fBDO NOT\fR alter the default mount options unless you know what you are doing.
+.TP
+.BI \--network= net,...
+Network(s) to restrict this ost/mdt to. This option can be repeated as desired.

 .TP
 .BI \--mgsnode= nid,...  
 Set the NID(s) of the MGS node, required for all targets other than the MGS.
 .TP
 .TP
 .BI \--mgsnode= nid,...  
 Set the NID(s) of the MGS node, required for all targets other than the MGS.
 .TP

-.BI \--noformat 
-Only print what would be done; does not affect the disk
-.TP

 .BI \--param " key=value"
 Set permanent parameter 
 .I key 
 to value 
 .BI \--param " key=value"
 Set permanent parameter 
 .I key 
 to value 

-.I value.
+.IR value .

 This option can be repeated as desired.  Typical options might include:
 .RS
 This option can be repeated as desired.  Typical options might include:
 .RS

-.I \--param sys.timeout=40 
+.I \--param sys.timeout=40

 .RS
 System obd timeout
 .RE
 .RS
 System obd timeout
 .RE

-.I \--param lov.stripe.size=2097152
+.I \--param lov.stripesize=2M

 .RS
 Default stripe size
 .RE
 .RS
 Default stripe size
 .RE

-.I \--param lov.stripe.count=2       
+.I \--param lov.stripecount=2       

 .RS
 Default stripe count
 .RE
 .I \--param failover.mode=failout    
 .RS
 .RS
 Default stripe count
 .RE
 .I \--param failover.mode=failout    
 .RS

-Return errs instead of waiting for recovery
+Return errors instead of waiting for recovery

 .RE
 .RE
 .TP
 .RE
 .RE
 .TP


@@ -116,16 +126,16 @@ Standalone MGS on e.g. node cfs22
 MDT for filesystem 'myfs1' on any node, using the above MGS
 
 .SH BUGS
 MDT for filesystem 'myfs1' on any node, using the above MGS
 
 .SH BUGS

-Please report all bugs to Cluster FileSystems, support@clusterfs.com
+Please report all bugs to Sun Microsystems via http://bugzilla.lustre.org/

 .SH AVAILABILITY
 .B mkfs.lustre
 is part of the 
 .BR Lustre (7) 
 .SH AVAILABILITY
 .B mkfs.lustre
 is part of the 
 .BR Lustre (7) 

-filesystem package and is available from CFS
+filesystem package and is available from Sun Microsystems via

 .br
 .br

-http://clusterfs.com
+http://downloads.lustre.org/

 .SH SEE ALSO
 .SH SEE ALSO

-.BR Lustre (7),
+.BR lustre (7),

 .BR mount.lustre (8),
 .BR tunefs.lustre (8),
 .BR lctl (8),
 .BR mount.lustre (8),
 .BR tunefs.lustre (8),
 .BR lctl (8),