Whamcloud - gitweb
b=21244 add man page for ll_decode_filter_fid tool
[fs/lustre-release.git] / lustre / doc / lustre.7
1 .\" -*- nroff -*-
2 .\" Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
3 .\" This file may be copied under the terms of the GNU Public License.
4 .\"
5 .TH Lustre 7 "2006 Jun 15" Lustre "A high-performance cluster file system"
6 .SH NAME
7 Lustre
8 .SH SYNOPSIS
9 A high-performance file system designed for clusters.
10 .SH DESCRIPTION
11 .B LustreĀ®
12 is a high-performance, massively-scalable, POSIX-compliant network file system
13 designed for the world's largest high-performance compute clusters. Lustre
14 is under active development from Sun Microsystems (http://www.lustre.org).
15
16 Lustre filesystems are made up of multiple services typically distributed
17 across multiple nodes.  Lustre clients can contact these server nodes over
18 multiple high-speed network fabrics via LNET, the Lustre NETworking
19 system.  Clients then present the filesystem at a mount point to userspace.
20
21 A filesystem is comprised of a 
22 .I MDT
23 , MetaData Target, which stores directory and file meta-information such as
24 file ownership, timestamps, access permissions, etc, and a
25 series of 
26 .I OSTs
27 , Object Storage Targets, which hold the file data in one or more objects.
28 There is typically not a 1:1 mapping of OST objects and what is presented
29 as a file on a Lustre client.
30
31 Lustre and LNET are implemented as a series of kernel modules, for both
32 servers and clients.  LNET networks are defined in the modprobe.conf file on
33 all nodes.  Lustre is started on the clients and servers using the
34 .BR mount (8)
35 command.
36
37 .SH COMMANDS
38 .TP
39 .BR mkfs.lustre (8)
40 Format a physical disk for use as a Lustre server's backend storage (aka
41 target).
42 .TP
43 .BR tunefs.lustre (8)
44 Modify configuration information on a Lustre target disk.
45 .TP
46 .BR mount.lustre (8)
47 A helper program for
48 .BR mount (8)
49 that starts Lustre servers and clients mounts the client filesystem.
50 .TP
51 .BR lctl (8)
52 A low-level interface to control various aspects of Lustre
53 .TP
54 .BR lfs (1)
55 A user-level interface to control Lustre-specific information for
56 individual files. 
57 .B lustre_config.sh
58 Format multiple Lustre targets simultaneously from definitions in a CSV
59 file.
60 .SH BUGS
61 Please report all bugs to Sun Microsystems via http://bugzilla.lustre.org/
62 .SH AVAILABILITY
63 .B The
64 .BR Lustre (7) 
65 filesystem package is available from Sun Microsystems, Inc via
66 .br
67 http://downloads.lustre.org/
68 .SH SEE ALSO
69 .BR mkfs.lustre (8),
70 .BR tunefs.lustre (8),
71 .BR mount.lustre (8),
72 .BR lctl (8),
73 .BR lfs (1),
74 .BR lfs_migrate (1),
75 .BR liblustreapi (7),
76 .BR l_getgroups (8),
77 .BR llstat (8),
78 .BR ll_recover_lost_found_objs (8),
79 .BR llverdev (8),
80 .BR lst (8),
81 .BR llobdstat (8),
82 .BR ll_decode_filter_fid (8),
83 .BR llog_reader (8),
84 .BR lshowmount (8),
85 .BR lustre_rsync (8)