summaryrefslogtreecommitdiffstats
path: root/doc/glusterfs.8
blob: c7dbbd81aa3ab6176278d698d6cd9a9ad0c95f52 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
.\"  Copyright (c) 2008-2009 Z RESEARCH, Inc. <http://www.zresearch.com>
.\"  This file is part of GlusterFS.
.\"
.\"  GlusterFS 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; either version 3 of the License,
.\"  or (at your option) any later version.
.\"
.\"  GlusterFS 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.
.\"
.\"  You should have received a copy of the GNU General Public License
.\"  long with this program.  If not, see
.\"  <http://www.gnu.org/licenses/>.
.\"
.\" :O
.\" 
.TH GlusterFS 8 ":O Cluster Filesystem" "07 December 2008" "Z Research Inc."
.SH NAME
GlusterFS \- Clustered Filesystem.
.SH SYNOPSYS
.B glusterfs 
.I [options] [mountpoint]
.PP
.SH DESCRIPTION
GlusterFS is a clustered file-system capable of scaling to several peta-bytes. It aggregates various storage bricks over Infiniband RDMA or TCP/IP interconnect into one large parallel network file system. Storage bricks can be made of any commodity hardware such as x86-64 server with SATA-II RAID and Infiniband HBA.
GlusterFS is fully POSIX compliant FileSystem. On client side, it has dependency on FUSE package, on server side, it works seemlessly on different OSes. (Currently supported on GNU/Linux, Mac OSX, FreeBSD, OpenSolaris).
.SH OPTIONS
.PP
Mandatory or optional arguments to long options are also mandatory or optional
for any corresponding short options.
.SS "Basic options"
.PP
.TP 

\fB\-f, \fB\-\-volfile=VOLUME-FILE\fR
File to use as VOLUME-FILE [default:/etc/glusterfs/glusterfs.vol]
.TP
\fB\-l, \fB\-\-log\-file=LOGFILE\fR
File to use for logging [default:/var/log/glusterfs/glusterfs.log]
.TP
\fB\-L, \fB\-\-log\-level=LOGLEVEL\fR   
Logging severity.  Valid options are DEBUG, WARNING, ERROR, CRITICAL 
and NONE [default: WARNING]
.TP
\fB\-s, \fB\-\-volfile\-server=SERVER\fR
Server to get the volume from.  This option overrides \fB\-\-volfile option

.SS "Advanced options"
.PP
.TP

\fB\-\-debug\fR
Run in debug mode.  This option sets \fB\-\-no\-daemon\fR, \fB\-\-log\-level\fR to DEBUG 
and \fB\-\-log\-file\fR to console
.TP
\fB\-N, \fB\-\-no\-daemon\fR
Run in foreground
.TP
\fB\-p, \fB\-\-pid\-file=PIDFILE\fR
File to use as pid file
.TP
\fB\-\-volfile\-id=KEY\fR
KEY of the volume file to be fetched from server
.TP
\fB\-\-volfile\-server\-port=PORT\fR
Port number of volfile server
.TP
\fB\-\-volfile\-server\-transport=TRANSPORT\fR
Transport type to get volume file from server [default: socket]
.TP
\fB\-\-volume\-name=VOLUME\-NAME\fR
Volume name to be used for MOUNT-POINT [default: top most volume in 
VOLUME-FILE]
.TP
\fB\-\-xlator\-option=VOLUME\-NAME.OPTION=VALUE\fR
Add/override a translator option for a volume with the specified value


.SS "Fuse options"
.PP
.TP

\fB\-\-attribute\-timeout=SECONDS\fR
Set attribute timeout to SECONDS for inodes in fuse kernel module [default: 1]
.TP
\fB\-\-entry\-timeout=SECONDS\fR
Set entry timeout to SECONDS in fuse kernel module [default: 1]
.TP
\fB\-\-disable\-direct\-io\-mode\fR 
Disable direct I/O mode in fuse kernel module
.TP

.SS "Miscellaneous Options"
.PP
.TP

\fB\-?, \fB\-\-help\fR
Give this help list
.TP
\fB\-\-usage\fR
Give a short usage message
.TP
\fB\-V, \fB\-\-version\fR
Print program version

.PP
.SH FILES
/etc/glusterfs/*.vol

.SH SEE ALSO
.nf
The full documentation for \fBGlusterFS\fR is maintained as a Texinfo manual. 
If the \fBinfo\fR and \fBglusterfs\fR are properly installed on your site, the command
            \fBinfo glusterfs\fR
should give you access to complete documentation.

.nf
\fBbison\fR(1) \fBflex\fR(1) \fBfusermount\fR(1) 
\fBhttp://www.glusterfs.org/ <URL:http://www.glusterfs.org/>
\fR
.fi
.SH SUPPORT
.nf
\fBhttp://support.gluster.com/ <URL:http://support.gluster.com/>
\fR
.fi
.SH AUTHORS
.nf
\fBhttp://www.gluster.org/core-team.php <URL:http://www.gluster.org/core-team.php>
\fR
.fi
.SH COPYRIGHT
.nf
\fBCopyright(c)2006-2009 Z RESEARCH, Inc. <http://www.zresearch.com>
\fR
.fi