From a42690b000d3778b74974d5ffc31f2e82c8ba7ff Mon Sep 17 00:00:00 2001 From: nathan Date: Thu, 15 Jun 2006 18:52:20 +0000 Subject: [PATCH] Branch b1_5 b=8216 man pages for mkfs.lustre, tunefs.lustre, mount.lustre, and Lustre --- lustre/doc/Makefile.am | 2 +- lustre/doc/lustre.7 | 76 ++++++++++++++++++++++++++++++++++++++++++++++ lustre/doc/mkfs.lustre.8 | 15 +++++---- lustre/doc/tunefs.lustre.8 | 9 ++++-- 4 files changed, 92 insertions(+), 10 deletions(-) create mode 100644 lustre/doc/lustre.7 diff --git a/lustre/doc/Makefile.am b/lustre/doc/Makefile.am index 07766a7..0ed46ec 100644 --- a/lustre/doc/Makefile.am +++ b/lustre/doc/Makefile.am @@ -15,7 +15,7 @@ TEXEXPAND = texexpand SUFFIXES = .lin .lyx .pdf .ps .sgml .html .txt .tex .fig .eps .dvi if UTILS -man_MANS = lfs.1 lctl.8 +man_MANS = lustre.7 lfs.1 mount.lustre.8 mkfs.lustre.8 tunefs.lustre.8 lctl.8 endif LYXFILES= $(filter-out $(patsubst %.lin,%.lyx,$(wildcard *.lin)),\ diff --git a/lustre/doc/lustre.7 b/lustre/doc/lustre.7 new file mode 100644 index 0000000..460df98 --- /dev/null +++ b/lustre/doc/lustre.7 @@ -0,0 +1,76 @@ +.\" -*- nroff -*- +.\" Copyright 2006 by Cluster FileSystems. All Rights Reserved. +.\" This file may be copied under the terms of the GNU Public License. +.\" +.TH Lustre 7 "2006 Jun 15" Lustre "A high-performance cluster file system" +.SH NAME +Lustre +.SH SYNOPSIS +A high-performance file system designed for clusters. +.SH DESCRIPTION +.B Lustre® +is a high-performance, massively-scalable, POSIX-compliant network file system +designed for the world's largest high-performance compute clusters. Lustre +is under active development from Cluster FileSystems (http://clusterfs.com). + +Lustre filesystems are made up of multiple servers typically distributed +across multiple nodes. Lustre clients can contact these server nodes over +multiple high-speed network fabrics via LNET, the Lustre NETworking +system. Clients then present the filesystem at a mount point. + +A filesystem is comprised of a +.I MDT +, MetaData Target, which stores directory and file meta-information, and a +series of +.I OSTs +, Object Storage Targets, which hold the file data. There is typically not +a 1:1 mapping of a file on disk and what is presented as a file on a Lustre client. + +Lustre and LNET are implemented as a series of kernel modules, for both +servers and clients. LNET networks are defined in the modprobe.conf file on +all nodes. Lustre and LNET make extensive use of /proc files for making +system data available, for example +.TP +.B /proc/sys/lnet/nis +to show the local LNET Network Interfaces. +.TP +.B /proc/fs/lustre/devices +to show locally running Lustre objects. + +.SH COMMANDS +.TP +.B mkfs.lustre(8) +Format a physical disk for use as a Lustre server's backend storage (aka +target). +.TP +.B tunefs.lustre(8) +Modify configuration information on a Lustre target disk. +.TP +.B mount.lustre(8) +A helper program for +.BR mount (8) +that starts Lustre servers and clients. +.TP +.B lctl(8) +A low-level interface to control various aspects of Lustre +.TP +.B lfs(1) +A user-level interface to control Lustre-specific information for +individual files. +.B lustre_config.sh +Format multiple Lustre targets simultaneously from definitions in a CSV +file. +.SH BUGS +Please report all bugs to Cluster FileSystems, support@clusterfs.com +.SH AVAILABILITY +.B The +.BR Lustre (7) +filesystem package is available from CFS +.br +http://clusterfs.com +.SH SEE ALSO +.BR mkfs.lustre (8), +.BR tunefs.lustre (8), +.BR mount.lustre (8), +.BR lctl (8), +.BR lfs (1) diff --git a/lustre/doc/mkfs.lustre.8 b/lustre/doc/mkfs.lustre.8 index 8d673db..58faab0 100644 --- a/lustre/doc/mkfs.lustre.8 +++ b/lustre/doc/mkfs.lustre.8 @@ -1,5 +1,5 @@ .\" -*- nroff -*- -.\" Copyright 2006 by ClusterFileSystems. All Rights Reserved. +.\" Copyright 2006 by Cluster FileSystems. 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" @@ -95,14 +95,17 @@ Standalone MGS on e.g. node cfs22 MDT for filesystem 'myfs1' on any node, using the above MGS .SH BUGS -Please report all bugs to ClusterFileSystems, support@clusterfs.com +Please report all bugs to Cluster FileSystems, support@clusterfs.com .SH AVAILABILITY .B mkfs.lustre -is part of the Lustre filesystem package and is available from CFS +is part of the +.BR Lustre (7) +filesystem package and is available from CFS +.br http://clusterfs.com .SH SEE ALSO -.BR Lustre -.BR tunefs.lustre (8), +.BR Lustre (7), .BR mount.lustre (8), +.BR tunefs.lustre (8), .BR lctl (8), -.BR lfs (8) +.BR lfs (1) diff --git a/lustre/doc/tunefs.lustre.8 b/lustre/doc/tunefs.lustre.8 index fb200de..b7ccb19 100644 --- a/lustre/doc/tunefs.lustre.8 +++ b/lustre/doc/tunefs.lustre.8 @@ -88,11 +88,14 @@ MDT for filesystem 'myfs1' on any node, using the above MGS 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 +is part of the +.BR Lustre (7) +filesystem package and is available from CFS +.br http://clusterfs.com .SH SEE ALSO -.BR Lustre +.BR Lustre (7), .BR mkfs.lustre (8), .BR mount.lustre (8), .BR lctl (8), -.BR lfs (8) +.BR lfs (1) -- 1.8.3.1