From 1b9f025ce8a707be2a996fc2cc1e3b67aa3ac5bb Mon Sep 17 00:00:00 2001
From: radhika <radhika>
Date: Wed, 29 Oct 2003 22:47:06 +0000
Subject: [PATCH] Added a manpage for lfs and some formatting changes to the
 lctl manpage.

---
 lustre/doc/lctl.8 |  5 ++++-
 lustre/doc/lfs.1  | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 57 insertions(+), 1 deletion(-)
 create mode 100644 lustre/doc/lfs.1

diff --git a/lustre/doc/lctl.8 b/lustre/doc/lctl.8
index b47579f..1e112dd 100644
--- a/lustre/doc/lctl.8
+++ b/lustre/doc/lctl.8
@@ -226,13 +226,16 @@ Close the lctl session.
 
 .SH OPTIONS
 The following options can be used to invoke lctl. 
-.PP
+.TP
 .B --device 
 The device number to be used for the operation. The value of devno is an integer, normally found by calling lctl name2dev on a device name. 
+.TP
 .B --threads 
 How many threads should be forked doing the command specified. The numthreads variable is a strictly positive integer indicating how many threads should be started. The devno option is used as above.
+.TP
 .B --ignore_errors | ignore_errors 
 Ignore errors during script processing
+.TP
 .B dump 
 Save ioctls to a file 
 .SH EXAMPLES
diff --git a/lustre/doc/lfs.1 b/lustre/doc/lfs.1
new file mode 100644
index 0000000..5e676f2
--- /dev/null
+++ b/lustre/doc/lfs.1
@@ -0,0 +1,53 @@
+.TH lfs 1 "2003 Oct 29" Lustre "configuration utilities"
+.SH NAME
+lfs \- Lustre utility to create a file with specific striping pattern, find the striping pattern of exiting files
+.SH SYNOPSIS
+.br
+.B lfs
+.br
+.B lfs find [--obd <uuid>] [--quiet | --verbose] [--recursive] <dir|file>
+.br
+.B lfs getstripe <file-name> 
+.br
+.B lfs setstripe <filename> <stripe-size> <start-ost> <stripe-cnt>
+.SH DESCRIPTION
+.B lfs
+can be used to create a new file with a specific striping pattern, determine the default striping pattern, gather the extended attributes (object numbers and 
+location) for a specific file. It can be invoked interactively without any 
+arguments or in a non-interactive mode with one of the arguements supported. 
+.SH OPTIONS
+The various options supported by lctl are listed and explained below:
+.TP
+.B setstripe 
+To create a new file with a specific striping pattern
+.TP
+.B find 
+To list the extended attributes for a given filename or files in a directory or recursively for all files in a directory tree. It can also be used to list the files that have objects on a specific OST. 
+.TP
+.B getstripe 
+To list the striping pattern for given filename
+.TP
+.B help 
+Provides brief help on the various arguments
+.TP
+.B exit/quit 
+Quit the interactive lfs session
+
+.SH EXAMPLES
+.TP
+.B $lfs setstripe /mnt/lustre/file1 131072 0 1
+This creats a file striped on one OST
+.TP
+.B $lfs find /mnt/lustre/file1
+Lists the extended attributes of a given file
+.TP
+.B $lfs find /mnt/lustre/
+Lists the extended attributes of all files in a given directory
+.TP
+.B $lfs find -r /mnt/lustre/
+Recursively list the extended attributes of all files in a given directory tree
+.TP
+.B $lfs find -r --obd OST2-UUID /mnt/lustre/
+List all the files that have objects on a specific OST
+.SH BUGS
+None are known.
-- 
1.8.3.1