[Pkg-lustre-svn-commit] r417 - in /trunk/debian: TODO lfs.8
winnie at users.alioth.debian.org
winnie at users.alioth.debian.org
Wed Jan 9 13:08:33 UTC 2008
Author: winnie
Date: Wed Jan 9 13:08:33 2008
New Revision: 417
URL: http://svn.debian.org/wsvn/pkg-lustre/?sc=1&rev=417
Log:
Added wrongly written manpage and add TODO for manpages
Modified:
trunk/debian/TODO
trunk/debian/lfs.8
Modified: trunk/debian/TODO
URL: http://svn.debian.org/wsvn/pkg-lustre/trunk/debian/TODO?rev=417&op=diff
==============================================================================
--- trunk/debian/TODO (original)
+++ trunk/debian/TODO Wed Jan 9 13:08:33 2008
@@ -1,7 +1,12 @@
- fix lustre/build/update_oldconfig, so that we can have a build-process that should work
automatically on any arch, without debian/kernel-*-config
-- fix 2.6.23 ldiskfs patchset.. it's completly broken
+- this programms should get a manpage:
+ - lst
+ - loadgen
+ - llstat
+ - ptlctl
+ - all lc_* programms at once (maybe one and link al other to this one)
- I've had a look into the cfs bugzilla and this are bugs with patch arround
(which is landed in a future release, we should include most of them into our
Modified: trunk/debian/lfs.8
URL: http://svn.debian.org/wsvn/pkg-lustre/trunk/debian/lfs.8?rev=417&op=diff
==============================================================================
--- trunk/debian/lfs.8 (original)
+++ trunk/debian/lfs.8 Wed Jan 9 13:08:33 2008
@@ -1,8 +1,8 @@
.\" -*- nroff -*-
.\" Copyright 2007 by Patrick Winnertz <winnie at debian.org>.
-.\" 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 v2 or later.
.\"
-.TH lfs 8 "2006 Jun 15" Lustre "configuration utilities"
+.TH lfs 8 "2008 Jan 09" Lustre "configuration utilities"
.SH NAME
lfs \- helper utility to administrate lustre clusters
.SH SYNOPSIS
@@ -10,103 +10,203 @@
.B lfs
<options> [values]
.br
-where
-.B <options>
-is one of
-.TP
-.BI setstripe
-get stripe informations for a specific fs
-.TP
-.BI getstripe
-set stripe informations for a specific fs
-.TP
-.BI find
-.TP
-.BI check
-.TP
-.BI catinfo
-.TP
-.BI join
-.TP
-.BI osts
-.TP
-.BI df
-.TP
-.BI quotachown
-.TP
-.BI quotacheck
-.TP
-.BI quotaon
-.TP
-.BI quotaoff
-.TP
-.BI setquota
-.TP
-.BI quota
-.TP
-.BI help
-.TP
-.BI exit
-.TP
-.BI quit
-
.SH DESCRIPTION
-setstripe: Create a new file with a specific striping pattern or
+.B lfs
+lfs is used to administrate a lustre filesystem, you'll need it to get or set
+various informations concerning the filesystem usage (e.g. striping, quota, osts, ..)
+
+.B lfs
+can be invoked in interactive and non-interative mode. In order to use it interactive call lfs without arguments.
+The available commands in lfs are:
+.B setstripe
+,
+.B getstripe
+,
+.B find
+,
+.B check
+,
+.B catinfo
+,
+.B join
+,
+.B osts
+,
+.B df
+,
+.B quotachown
+,
+.B quotacheck
+,
+.B quotaon
+,
+.B quotaoff
+,
+.B setquota
+,
+.B quota
+,
+.B help
+,
+.B exit
+,
+.B quit
+.
+
+In order to get help type
+.I lfs help
+.br
+If you want more specific help on a command type
+.I lfs help $command
+.br
+where $command is one of the ones in the list above.
+
+.SH OPTIONS
+.TP
+.B setstripe:
+Create a new file with a specific striping pattern or
set the default striping pattern on an existing directory or
delete the default striping pattern from an existing directory
+.br
usage: setstripe <filename|dirname> <stripe_size> <stripe_index> <stripe_count>
or
setstripe <filename|dirname> [--size|-s stripe_size]
[--index|-i stripe_index]
[--count|-c stripe_count]
or
- setstripe -d <dirname> (to delete default striping)
- stripe_size: Number of bytes on each OST (0 filesystem default)
- Can be specified with k, m or g (in KB, MB and GB respectively)
- stripe_index: OST index of first stripe (-1 filesystem default)
- stripe_count: Number of OSTs to stripe over (0 default, -1 all)
-getstripe: To list the striping info for a given filename or files in a
+.br
+ setstripe -d <dirname> (to delete default striping)
+
+ stripe_size: Number of bytes on each OST (0 filesystem default)
+ Can be specified with k, m or g (in KB, MB and GB respectively)
+ stripe_index: OST index of first stripe (-1 filesystem default)
+ stripe_count: Number of OSTs to stripe over (0 default, -1 all)
+
+.TP
+.B getstripe:
+To list the striping info for a given filename or files in a
directory or recursively for all files in a directory tree.
+
usage: getstripe [--obd|-O <uuid>] [--quiet | -q] [--verbose | -v]
[--recursive | -r] <dir|file> ...
-find: To find files that match given parameters recursively in a directory tree.
+
+.TP
+.B find:
+.br
+To find files that match given parameters recursively in a directory tree.
+
usage: find <dir/file> ...
- [[!] --atime|-A [+-]N] [[!] --mtime|-M [+-]N] [[!] --ctime|-C [+-]N]
- [--maxdepth|-D N] [[!] --name|-n <pattern>] [--print0|-P]
- [--print|-p] [--obd|-O <uuid>] [[!] --type|-t <filetype>]
- !: used before an option indicates 'NOT' the requested attribute
- -: used before an value indicates 'AT MOST' the requested value
- +: used before an option indicates 'AT LEAST' the requested value
-
-check: Display the status of MDS or OSTs (as specified in the command)
+ [[!] --atime|-A [+-]N] [[!] --mtime|-M [+-]N] [[!] --ctime|-C [+-]N]
+ [--maxdepth|-D N] [[!] --name|-n <pattern>] [--print0|-P]
+ [--print|-p] [--obd|-O <uuid>] [[!] --type|-t <filetype>]
+ !: used before an option indicates 'NOT' the requested attribute
+ -: used before an value indicates 'AT MOST' the requested value
+ +: used before an option indicates 'AT LEAST' the requested value
+
+.TP
+.B check:
+.br
+Display the status of MDS or OSTs (as specified in the command)
or all the servers (MDS and OSTs).
+
usage: check <osts|mds|servers>
-catinfo: Show information of specified type logs.
+
+.TP
+.B catinfo:
+Show information of specified type logs.
+
usage: catinfo {keyword} [node name]
- keywords are one of followings: config, deletions.
- node name must be provided when use keyword config.
-join: join two lustre files into one - join A, B, will be like cat B >> A & del B
+ keywords are one of followings: config, deletions.
+ node name must be provided when use keyword config.
+
+.TP
+.B join:
+.br
+join two lustre files into one - join A, B, will be like cat B >> A & del B
+
usage: join <filename_A> <filename_B>
-osts: osts
-df: report filesystem disk space usage or inodes usageof each MDS/OSD.
-Usage: df [-i] [-h] [path]
-quotachown: Change files' owner or group on the specified filesystem.
+.TP
+.B osts:
+.br
+osts
+FIXME
+
+
+.TP
+.B df:
+.br
+report filesystem disk space usage or inodes usageof each MDS/OSD.
+
+usage: df [-i] [-h] [path]
+
+.TP
+.B quotachown:
+Change files' owner or group on the specified filesystem.
+
usage: quotachown [-i] <filesystem>
- -i: ignore error if file is not exist
-
-quotacheck: Scan the specified filesystem for disk usage, and create,
+ -i: ignore error if file is not exist
+
+.TP
+.B quotacheck:
+Scan the specified filesystem for disk usage, and create,
or update quota files.
+
usage: quotacheck [ -ug ] <filesystem>
-quotaon: Turn filesystem quotas on.
+
+.TP
+.B quotaon:
+Turn filesystem quotas on.
+
usage: quotaon [ -ugf ] <filesystem>
-quotaoff: Turn filesystem quotas off.
+
+.TP
+.B quotaoff:
+Turn filesystem quotas off.
+
usage: quotaoff [ -ug ] <filesystem>
-setquota: Set filesystem quotas.
-usage: setquota [ -u | -g ] <name> <block-softlimit> <block-hardlimit> <inode-softlimit> <inode-hardlimit> <filesystem>
- setquota -t [ -u | -g ] <block-grace> <inode-grace> <filesystem>
-quota: Display disk usage and limits.
+
+.TP
+.B setquota:
+Set filesystem quotas.
+
+usage: setquota [ -u | -g ] <name> <block-softlimit> <block-hardlimit> <inode-softlimit> <inode-hardlimit> <filesystem>
+ setquota -t [ -u | -g ] <block-grace> <inode-grace> <filesystem>
+
+.TP
+.B quota:
+.br
+Display disk usage and limits.
+
usage: quota [ -o obd_uuid ] [{-u|-g <name>}|-t] <filesystem>
-help: help
-exit: quit
-quit: quit
+
+.TP
+.B help:
+.br
+help
+
+.TP
+.B exit:
+.br
+quit
+
+.TP
+.B quit:
+.br
+quit
+
+.SH EXAMPLES
+
+.SH SEE ALSO
+.BR lustre(7)
+.BR Lustre (7),
+.BR mount (8),
+.BR mkfs.lustre (8),
+.BR tunefs.lustre (8),
+.BR lctl (8),
+
+.SH AUTHOR
+lustre was written by ClusterFileSystems <info at clusterfs.com>
+This manpage was written by Patrick Winnertz <patrick.winnertz at credativ.de> for the Debian GNU/Linux system (but may be used by others).
+Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License version 2 or any later version published by the Free Software Foundation.
+
More information about the Pkg-lustre-svn-commit
mailing list