'\" t
.\"     Title: mfsmount
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 06/17/2017
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "MFSMOUNT" "1" "06/17/2017" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
mfsmount \- mount Lizard File System
.SH "SYNOPSIS"
.sp
.nf
\fBmfsmount\fR \fImountpoint\fR [\fB\-d\fR] [\fB\-f\fR] [\fB\-s\fR] [\fB\-m\fR] [\fB\-n\fR] [\fB\-p\fR]
         [\fB\-H\fR \fIHOST\fR] [\fB\-P\fR \fIPORT\fR] [\fB\-S\fR \fIPATH\fR] [\fB\-o\fR \fIopt\fR[,\fIopt\fR]\&...]
.fi
.sp
.nf
\fBmfsmount\fR \fB\-h\fR|\fB\-\-help\fR
.fi
.sp
.nf
\fBmfsmount\fR \fB\-V\fR|\fB\-\-version\fR
.fi
.SH "DESCRIPTION"
.sp
Mount Lizard File System\&.
.sp
General options:
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
display help and exit
.RE
.PP
\fB\-V\fR
.RS 4
display version information and exit
.RE
.sp
FUSE options:
.PP
\fB\-d\fR, \fB\-o debug\fR
.RS 4
enable debug mode (implies
\fB\-f\fR)
.RE
.PP
\fB\-f\fR
.RS 4
foreground operation
.RE
.PP
\fB\-s\fR
.RS 4
disable multi\-threaded operation
.RE
.sp
LizardFS options:
.PP
\fB\-c\fR \fICFGFILE\fR, \fB\-o mfscfgfile=\fR\fICFGFILE\fR
.RS 4
loads file with additional mount options
.RE
.PP
\fB\-m\fR, \fB\-\-meta\fR, \fB\-o mfsmeta\fR
.RS 4
mount MFSMETA companion filesystem instead of primary LizardFS
.RE
.PP
\fB\-n\fR
.RS 4
omit default mount options (\fB\-o allow_other,default_permissions\fR)
.RE
.PP
\fB\-p\fR, \fB\-o askpassword\fR
.RS 4
prompt for password (interactive version of
\fB\-o mfspassword=\fR\fIPASS\fR)
.RE
.PP
\fB\-H\fR \fIHOST\fR, \fB\-o mfsmaster=\fR\fIHOST\fR
.RS 4
connect with LizardFS master on
\fIHOST\fR
(default is mfsmaster)
.RE
.PP
\fB\-P\fR \fIPORT\fR, \fB\-o mfsport=\fR\fIPORT\fR
.RS 4
connect with LizardFS master on
\fIPORT\fR
(default is 9421)
.RE
.PP
\fB\-B\fR \fIHOST\fR, \fB\-o mfsbind=\fR\fIHOST\fR
.RS 4
local address to use for connecting with master instead of default one
.RE
.PP
\fB\-S\fR \fIPATH\fR, \fB\-o mfssubfolder=\fR\fIPATH\fR
.RS 4
mount specified LizardFS directory (default is /, i\&.e\&. whole filesystem)
.RE
.PP
\fB\-o enablefilelocks=\fR[0,1]
.RS 4
enables/disables global file locking (disabled by default)
.RE
.PP
\fB\-o mfspassword=\fR\fIPASSWORD\fR
.RS 4
authenticate to LizardFS master with
\fIPASSWORD\fR
.RE
.PP
\fB\-o mfsmd5pass=\fR\fIMD5\fR
.RS 4
authenticate to LizardFS master using directly given
\fIMD5\fR
(only if
\fBmfspassword\fR
option is not specified)
.RE
.PP
\fB\-o mfsdelayedinit\fR
.RS 4
connection with master is done in background \- with this option mount can be run without network (good for being run from fstab / init scripts etc\&.)
.RE
.PP
\fB\-o mfsacl\fR
.RS 4
enable ACL support (disabled by default)
.RE
.PP
\fB\-o mfsaclcacheto=\fR\fISEC\fR
.RS 4
set ACL cache timeout in seconds (default: 1\&.0)
.RE
.PP
\fB\-o mfsaclcachesize=\fR\fIN\fR
.RS 4
define ACL cache size in number of entries (0: no cache; default: 1000)
.RE
.PP
\fB\-o mfsrwlock=\fR\fI0|1\fR
.RS 4
when set to 1, parallel reads from the same descriptor are performed (default: 1)
.RE
.PP
\fB\-o mfsmkdircopysgid=\fR\fIN\fR
.RS 4
sgid bit should be copied during mkdir operation (on linux default: 1, otherwise: 0)
.RE
.PP
\fB\-o mfssugidclearmode=\fR\fISMODE\fR
.RS 4
set sugid clear mode (see below)
.RE
.PP
\fB\-o mfsdebug\fR
.RS 4
print some LizardFS\-specific debugging information
.RE
.PP
\fB\-o mfscachemode=\fR\fICACHEMODE\fR
.RS 4
set cache mode (see
\fBDATA CACHE MODES\fR; default is AUTO)
.RE
.PP
\fB\-o mfscachefiles\fR
.RS 4
(deprecated) preserve file data in cache (equivalent to
\fB\-o mfscachemode=\fR\fIYES\fR)
.RE
.PP
\fB\-o mfsattrcacheto=\fR\fISEC\fR
.RS 4
set attributes cache timeout in seconds (default: 1\&.0)
.RE
.PP
\fB\-o mfsentrycacheto=\fR\fISEC\fR
.RS 4
set file entry cache timeout in seconds (default: 0\&.0, i\&.e\&. no cache)
.RE
.PP
\fB\-o mfsdirentrycacheto=\fR\fISEC\fR
.RS 4
set directory entry cache timeout in seconds (default: 1\&.0)
.RE
.PP
\fB\-o mfswritecachesize=\fR\fIN\fR
.RS 4
specify write cache size in MiB (in range: 16\&.\&.2048 \- default: 128)
.RE
.PP
\fB\-o mfscacheperinodepercentage=\fR\fIN\fR
.RS 4
specify what part of the write cache non occupied by other inodes can a single inode occupy (measured in %)\&. E\&.g\&. When N=75 and the inode X uses 10 MiB, and all other inodes use 20 MiB out of 100 MiB cache, X can use 50 MiB more (since 75% of 80 MiB is 60 MiB)\&. Default: 25\&.
.RE
.PP
\fB\-o mfschunkserverreadto=\fR\fIMSEC\fR
.RS 4
set timeout for whole communication with a chunkserver during read operation in milliseconds (default: 2000)
.RE
.PP
\fB\-o mfschunkserverwriteto=\fR\fIMSEC\fR
.RS 4
set chunkserver response timeout during write operation in milliseconds (default: 5000)
.RE
.PP
\fB\-o mfschunkserverrtt=\fR\fIMSEC\fR
.RS 4
set timeout after which SYN packet is considered lost during the first retry of connecting a chunkserver (default: 200)
.RE
.PP
\fB\-o mfschunkserverconnectreadto=\fR\fIMSEC\fR
.RS 4
set timeout for connecting with chunkservers during read operation in milliseconds (default: 2000)
.RE
.PP
\fB\-o mfschunkserverwavereadto=\fR\fIMSEC\fR
.RS 4
set timeout for executing each wave of a read operation in milliseconds (default: 500)
.RE
.PP
\fB\-o mfschunkservertotalreadto=\fR\fIMSEC\fR
.RS 4
set timeout for the whole communication with chunkservers during a read operation in milliseconds (default: 2000)
.RE
.PP
\fB\-o cacheexpirationtime=\fR\fIMSEC\fR
.RS 4
set timeout for read cache entries to be considered valid in milliseconds (0 disables cache) (default: 0)
.RE
.PP
\fB\-o readaheadmaxwindowsize=\fR\fIKB\fR
.RS 4
set max value of readahead window per single descriptor in kibibytes (default: 4096)
.RE
.PP
\fB\-o mfsrlimitnofile=\fR\fIN\fR
.RS 4
try to change limit of simultaneously opened file descriptors on startup (default: 100000)
.RE
.PP
\fB\-o mfsnice=\fR\fILEVEL\fR
.RS 4
try to change nice level to specified value on startup (default: \-19)
.RE
.PP
\fB\-o mfswriteworkers=\fR\fIN\fR
.RS 4
define number of write workers (default: 10)
.RE
.PP
\fB\-o mfswritewindowsize=\fR\fIN\fR
.RS 4
define write window size (in blocks) for each chunk (default: 15)
.RE
.PP
\fB\-o mfsmemlock\fR
.RS 4
try to lock memory (must be enabled at build time)
.RE
.PP
\fB\-o mfsdonotrememberpassword\fR
.RS 4
do not remember password in memory \- more secure, but when session is lost then new session is created without password
.RE
.PP
\fB\-o mfsioretries=\fR\fIN\fR
.RS 4
specify number of retries before I/O error is returned (default: 30)
.RE
.PP
\fB\-o mfsreportreservedperiod=\fR\fIN\fR
.RS 4
specify interval of reporting reserved inodes in seconds (default: 60)
.RE
.PP
\fB\-o mfsiolimits=\fR\fIPATH\fR
.RS 4
specify local I/O limiting configuration file (default: no I/O limiting)
.RE
.sp
General mount options (see \fBmount\fR(8) manual):
.PP
\fB\-o rw\fR|\fB\-o ro\fR
.RS 4
Mount file\-system in read\-write (default) or read\-only mode respectively\&.
.RE
.PP
\fB\-o suid\fR|\fB\-o nosuid\fR
.RS 4
Enable or disable suid/sgid attributes to work\&.
.RE
.PP
\fB\-o dev\fR|\fB\-o nodev\fR
.RS 4
Enable or disable character or block special device files interpretation\&.
.RE
.PP
\fB\-o exec\fR|\fB\-o noexec\fR
.RS 4
Allow or disallow execution of binaries\&.
.RE
.PP
\fB\-o symlinkcachetimeout=\fR\fIN\fR
.RS 4
Set timeout value for symlink cache timeout in seconds\&. Default value is 3600\&.
.RE
.PP
\fB\-o bandwidthoveruse=\fR\fIN\fR
.RS 4
Define ratio of allowed bandwidth overuse when fetching data\&. Default value is 1\&.25\&. This option is effective only with N+M goals (xors and erasure codes)\&.
.RE
.SH "DATA CACHE MODES"
.sp
There are three cache modes: \fBNO\fR, \fBYES\fR and \fBAUTO\fR\&. Default option is \fBAUTO\fR and you shuldn\(cqt change it unless you really know what you are doing\&. In \fBAUTO\fR mode data cache is managed automatically by mfsmaster\&.
.PP
\fBNO\fR,\fBNONE\fR or \fBNEVER\fR
.RS 4
never allow files data to be kept in cache (safest but can reduce efficiency)
.RE
.PP
\fBYES\fR or \fBALWAYS\fR
.RS 4
always allow files data to be kept in cache (dangerous)
.RE
.PP
\fBAUTO\fR
.RS 4
file cache is managed by mfsmaster automatically (should be very safe and efficient)
.RE
.SH "SUGID CLEAR MODE"
.sp
SMODE can be set to:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBNEVER\fR
\- MFS will not change suid and sgid bit on chown
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBALWAYS\fR
\- clear suid and sgid on every chown \- safest operation
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBOSX\fR
\- standard behavior in OS X and Solaris (chown made by unprivileged user clear suid and sgid)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBBSD\fR
\- standard behavior in BSD systems (like in OSX, but only when something is really changed)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBEXT\fR
\- standard behavior in most file systems on Linux (directories not changed, others: suid cleared always, sgid only when group exec bit is set)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBXFS\fR
\- standard behavior in XFS on Linux (like EXT but directories are changed by unprivileged users)
.RE
.sp
SMODE extra info:
.sp
btrfs,ext2,ext3,ext4,hfs[+],jfs,ntfs and reiserfs on Linux work as \fIEXT\fR\&.
.sp
Only xfs on Linux works a little different\&. Beware that there is a strange operation \- chown(\-1,\-1) which is usually converted by a kernel into something like \fIchmod ug\-s\fR, and therefore can\(cqt be controlled by MFS as \fIchown\fR
.SH "REPORTING BUGS"
.sp
Report bugs to <contact@lizardfs\&.org>\&.
.SH "COPYRIGHT"
.sp
Copyright 2008\-2009 Gemius SA, 2013\-2015 Skytechnology sp\&. z o\&.o\&.
.sp
LizardFS is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3\&.
.sp
LizardFS is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\&. See the GNU General Public License for more details\&.
.sp
You should have received a copy of the GNU General Public License along with LizardFS\&. If not, see http://www\&.gnu\&.org/licenses/\&.
.SH "SEE ALSO"
.sp
mfsmaster(8), mfstools(1), moosefs(7), mount(8)