Whamcloud - gitweb
b=15625
[fs/lustre-release.git] / lustre / doc / mount.lustre.8
index 69f1815..8254d88 100644 (file)
@@ -1,13 +1,14 @@
 .\" -*- nroff -*-
 .\" Copyright 2006 by Cluster FileSystems.  All Rights Reserved.
-.\" This file may be copied under the terms of the GNU Public License.
+.\" Copyright 2008 by Sun Microsystems.  All Rights Reserved.
+.\" This file may be copied under the terms of the GNU Public License v2.
 .\"
-.TH mount.lustre 8 "2006 Jun 15" Lustre "configuration utilities"
+.TH mount.lustre 8 "2008 Mar 15" Lustre "configuration utilities"
 .SH NAME
 mount.lustre \- start a Lustre client or target service 
 .SH SYNOPSIS
 .br
-.BI "mount \-t lustre [\-o " options "] " "device dir"
+.BI "mount \-t lustre [\-o " options "] " directory
 .SH DESCRIPTION
 .B mount.lustre
 is used to start a Lustre client or target service.  This program should not be
@@ -22,58 +23,87 @@ There are two forms for the
 .I device
 option, depending on whether a client or a target service is started:
 .TP
-.BI <mgsspec>:/<fsname>
-This is a client mount command to mount the Lustre filesystem named
-<fsname> by contacting the Management Service at <mgsspec>.  The format for
-<mgsspec> is defined below.
-.TP
-.BI <disk_device>
-This starts the target service defined by the 
+.IR <mgsspec> :/ <fsname>
+mounts the Lustre filesystem named
+.I fsname
+on the client by contacting the Management Service at 
+.IR mgsspec 
+on the pathname given by
+.IR directory .
+The format for
+.I mgsspec
+is defined below.  A mounted client filesystem appears in
+.BR fstab (5)
+and is usable like any local filesystem and provides a full
+POSIX-compilant interface.
+.TP
+.I disk_device
+starts the target service defined by the 
 .I mkfs.lustre
-command on the physical disk <disk_device>
+command on the physical disk
+.IR disk_device .  
+A mounted target service filesystem is only useful for
+.BR df (1)
+operations and appears in
+.BR fstab (5)
+to show the device is in use.
 .SH OPTIONS
 .TP
 .BI <mgsspec>:= <mgsnode>[:<mgsnode>]
-The mgs specification may be a colon-separated list of nodes...
+The mgs specification may be a colon-separated list of nodes:
 .TP
 .BI <mgsnode>:= <mgsnid>[,<mgsnid>]
- ...and each node may be specified by a comma-separated list of NIDs.
+each node may be specified by a comma-separated list of NIDs.
 .PP
-In addition to the standard mount options, Lustre understands the following
-.I client-specific
+In addition to the standard options listed in
+.BR mount (8),
+Lustre understands the following
+.B client-specific
 options:
 .TP
 .BI flock
-Enable flock support
+Enable full flock support, coherent across all client nodes.
+.TP
+.BI localflock
+Enable local flock support, using only client-local flock (faster, for applications that require flock but do not run on multiple nodes).
 .TP
 .BI noflock
-Disable flock support
+Disable flock support entirely.  Applications calling flock will get an error.
 .TP
 .BI user_xattr
-Enable get/set user xattr
+Enable get/set of extended attributes by regular users.  See the
+.BR attr (5)
+manual page.
 .TP
 .BI nouser_xattr
-Disable user xattr
+Disable use of extended attributes by regular users.  Root and system processes can still use extended attributes.
 .TP
 .BI acl
-Enable ACL support
+Enable POSIX Access Control List support.  See the
+.BR acl (5)
+manual page.
 .TP
 .BI noacl
-Disable ACL support
+Disable Access Control List support.
 .PP
 In addition to the standard mount options and backing disk type
-(e.g. LDISKFS) options, Lustre understands the following
-.I server-specific
+(e.g. ext3) options listed in
+.BR mount (8),
+Lustre understands the following
+.B server-specific
 options:
 .TP
 .BI nosvc
 Only start the MGC (and MGS, if co-located) for a target service, and not the actual service.
 .TP
+.BI nomgs
+Start a MDT with a co-located MGS without starting the MGS.
+.TP
 .BI exclude= ostlist
-Start a client or MDT with a (colon-separated) list of known inactive OSTs
+Start a client or MDT with a (colon-separated) list of known inactive OSTs.
 .TP
 .BI abort_recov
-Abort recovery (targets only)
+Abort client recovery and start the target service immediately.
 .SH EXAMPLES
 .TP
 .B mount -t lustre cfs21@tcp0:/testfs /mnt/myfilesystem
@@ -82,20 +112,34 @@ Start a client for the Lustre filesystem 'testfs' at the mount point
 from this client via the nid cfs21@tcp0.
 .TP
 .B mount -t lustre /dev/sda1 /mnt/test/mdt
-Start the Lustre target service on /dev/sda1.
+Start the Lustre metadata target service from /dev/sda1 on mountpoint /mnt/test/mdt.
 .TP
 .B mount -t lustre -L testfs-MDT0000 -o abort_recov /mnt/test/mdt
 Start the testfs-MDT0000 service (by using the disk label), but abort the
 recovery process.
+.SH NOTES
+If the Service Tags tool (from the sun-servicetag package) can be found in
+/opt/sun/servicetag/bin/stclient an inventory service tag will be created
+reflecting the Lustre service being provided.  If this tool cannot be found
+.B mount.lustre
+will silently ignore it and no service tag is created.  The
+.BR stclient (1)
+tool only creates the local service tag.  No information is sent to the asset
+management system until you run the Registration Client to collect the tags
+and then upload them to the inventory system using your inventory system account.
+See https://inventory.sun.com/ for more details on a web-based, free, IT asset
+management system.
 .SH BUGS
-Please report all bugs to Cluster FileSystems, support@clusterfs.com
+Not very many mount options can be changed with
+.BR "-o remount" .
+Please report all bugs to Sun Microsystems using http://bugzilla.lustre.org/
 .SH AVAILABILITY
 .B mount.lustre
 is part of the 
 .BR Lustre (7) 
-filesystem package and is available from CFS
+filesystem package and is available from Sun Microsystems, Inc.
 .br
-http://clusterfs.com
+http://downloads.lustre.org
 .SH SEE ALSO
 .BR Lustre (7),
 .BR mount (8),