From: nathan <nathan>
Date: Thu, 15 Jun 2006 00:05:44 +0000 (+0000)
Subject: Branch b1_5
X-Git-Tag: v1_7_100~1^90~8^2~125
X-Git-Url: https://git.whamcloud.com/?a=commitdiff_plain;h=9b0171b57ba5da228b9f582e005eed90a5279f2d;p=fs%2Flustre-release.git

Branch b1_5
b=8007
add a tunefs.lustre manpage
---

diff --git a/lustre/doc/mkfs.lustre.8 b/lustre/doc/mkfs.lustre.8
index 4c30327..8d673db 100644
--- a/lustre/doc/mkfs.lustre.8
+++ b/lustre/doc/mkfs.lustre.8
@@ -16,10 +16,10 @@ where
 is one of
 .TP
 .BI \--ost
-object storage service
+object storage target
 .TP
 .BI \--mdt
-metadata storage service
+metadata storage target
 .TP
 .BI \--mgs
 configuration management service - one per site.  This service can be
@@ -41,7 +41,7 @@ Force a particular format for the backing fs (ext3, ldiskfs)
 Set device size for loop devices
 .TP
 .BI \--failnode= nid,...  
-NID(s) of a failover partner. This option can be repeated as desired.
+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'
@@ -56,7 +56,7 @@ Format options for the backing fs. For example, ext3 options could be set here.
 Set permanent mount options, equivalent to setting in /etc/fstab
 .TP
 .BI \--mgsnode= nid,...  
-NID(s) of a the MGS node, required for all targets other than the MGS.
+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
diff --git a/lustre/doc/tunefs.lustre.8 b/lustre/doc/tunefs.lustre.8
new file mode 100644
index 0000000..fb200de
--- /dev/null
+++ b/lustre/doc/tunefs.lustre.8
@@ -0,0 +1,98 @@
+.\" -*- nroff -*-
+.\" Copyright 2006 by ClusterFileSystems.  All Rights Reserved.
+.\" This file may be copied under the terms of the GNU Public License.
+.\"
+.TH tunefs.lustre 8 "2006 Jun 15" Lustre "configuration utilities"
+.SH NAME
+tunefs.lustre \- modify the Lustre configuration information on a disk
+.SH SYNOPSIS
+.br
+.B tunefs.lustre
+[options] 
+.I device
+.br
+.SH DESCRIPTION
+.B tunefs.lustre
+is used to modify the configuration information on a Lustre target
+disk. This includes upgrading old (pre-Lustre 1.6) disks.  This does not
+reformat the disk or erase the target information, but modifying the
+configuration information can result in an unusable filesystem.  You have
+been warned.
+.br
+Changes made here will affect a filesystem only when the target is next
+mounted.
+
+.SH OPTIONS
+.TP
+.BI \--erase-params
+Remove all previous parameter info
+.TP
+.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'
+.TP
+.BI \--index= index
+Force a particular OST or MDT index 
+.TP
+.BI \--mountfsoptions= opts
+Set permanent mount options, equivalent to setting in /etc/fstab
+.TP
+.BI \--mgs
+add a configuration management service to this target
+.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 \--nomgs
+remove a configuration management service to this target
+.TP
+.BI \--param " key=value"
+Set permanent parameter 
+.I key 
+to value 
+.I value.
+This option can be repeated as desired.
+.TP
+.BI \--quiet
+Print less information.
+.TP
+.BI \--reformat 
+Reformat an existing Lustre disk
+.TP
+.BI \--verbose
+Print more information.
+.TP
+.BI \--writeconf
+Erase all config logs for the filesystem that this target is part of.
+
+.SH EXAMPLES
+.TP
+.B tunefs.lustre --fsname=testfs --mdt --mgs /dev/sda1
+Combined MGS and MDT for filesystem 'testfs' on node e.g. cfs21
+.TP
+.B tunefs.lustre --fsname=testfs --ost --mgsnode=cfs21@tcp0 /dev/sdb
+OST for filesystem 'testfs' on any node using the above MGS.
+.TP
+.B tunefs.lustre --mgs /dev/sda1
+Standalone MGS on e.g. node cfs22
+.TP
+.B tunefs.lustre --fsname=myfs1 --mdt --mgsnode=cfs22@tcp0 /dev/sda2
+MDT for filesystem 'myfs1' on any node, using the above MGS
+
+.SH BUGS
+Please report all bugs to ClusterFileSystems, support@clusterfs.com
+.SH AVAILABILITY
+.B tunefs.lustre
+is part of the Lustre filesystem package and is available from CFS
+http://clusterfs.com
+.SH SEE ALSO
+.BR Lustre
+.BR mkfs.lustre (8),
+.BR mount.lustre (8),
+.BR lctl (8),
+.BR lfs (8)