From 196437da344e602af1e3e3b909950cc9d40cbd28 Mon Sep 17 00:00:00 2001
From: nathan <nathan>
Date: Wed, 14 Jun 2006 23:28:53 +0000
Subject: [PATCH] Branch b1_5 b=8007 oooh, a man page.

---
 lustre/doc/mkfs.lustre.8 | 108 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 108 insertions(+)
 create mode 100644 lustre/doc/mkfs.lustre.8

diff --git a/lustre/doc/mkfs.lustre.8 b/lustre/doc/mkfs.lustre.8
new file mode 100644
index 0000000..4c30327
--- /dev/null
+++ b/lustre/doc/mkfs.lustre.8
@@ -0,0 +1,108 @@
+.\" -*- nroff -*-
+.\" Copyright 2006 by ClusterFileSystems.  All Rights Reserved.
+.\" This file may be copied under the terms of the GNU Public License.
+.\"
+.TH mkfs.lustre 8 "2006 Jun 15" Lustre "configuration utilities"
+.SH NAME
+mkfs.lustre \- format a disk for a Lustre service
+.SH SYNOPSIS
+.br
+.B mkfs.lustre
+<target_type> [options] 
+.I device
+.br
+where
+.B <target_type>
+is one of
+.TP
+.BI \--ost
+object storage service
+.TP
+.BI \--mdt
+metadata storage service
+.TP
+.BI \--mgs
+configuration management service - one per site.  This service can be
+combined with one 
+.BI \--mdt
+service by specifying both types
+.SH DESCRIPTION
+.B mkfs.lustre
+is used to format a disk device for use as part of a Lustre
+filesystem. After formatting, a disk can be mounted to start the Lustre
+service defined by this command.
+
+.SH OPTIONS
+.TP
+.BI \--backfstype= fstype
+Force a particular format for the backing fs (ext3, ldiskfs)
+.TP
+.BI \--device-size= KB
+Set device size for loop devices
+.TP
+.BI \--failnode= nid,...  
+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 \--mkfsoptions= 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
+.TP
+.BI \--mgsnode= nid,...  
+NID(s) of a 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 
+.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 \--stripe-count-hint= stripes
+Used for optizing MDT inode size
+.TP
+.BI \--verbose
+Print more information.
+
+.SH EXAMPLES
+.TP
+.B mkfs.lustre --fsname=testfs --mdt --mgs /dev/sda1
+Combined MGS and MDT for filesystem 'testfs' on node e.g. cfs21
+.TP
+.B mkfs.lustre --fsname=testfs --ost --mgsnode=cfs21@tcp0 /dev/sdb
+OST for filesystem 'testfs' on any node using the above MGS.
+.TP
+.B mkfs.lustre --mgs /dev/sda1
+Standalone MGS on e.g. node cfs22
+.TP
+.B mkfs.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 mkfs.lustre
+is part of the Lustre filesystem package and is available from CFS
+http://clusterfs.com
+.SH SEE ALSO
+.BR Lustre
+.BR tunefs.lustre (8),
+.BR mount.lustre (8),
+.BR lctl (8),
+.BR lfs (8)
-- 
1.8.3.1