Whamcloud - gitweb
ChangeLog, mke2fs.8.in, mke2fs.c, tune2fs.8.in, tune2fs.c:
[tools/e2fsprogs.git] / misc / tune2fs.8.in
1 .\" Revision 1.0 93/06/3 23:00  chk
2 .\" Initial revision
3 .\"
4 .\"
5 .TH TUNE2FS 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@"
6 .SH NAME
7 tune2fs \- adjust tunable filesystem parameters on second extended filesystems
8 .SH SYNOPSIS
9 .B tune2fs
10 [
11 .B \-l
12 ]
13 [
14 .B \-c
15 .I max-mount-counts
16 ]
17 [
18 .B \-e
19 .I errors-behavior
20 ]
21 [
22 .B \-i
23 .I interval-between-checks
24 ]
25 [
26 .B \-j
27 ]
28 [
29 .B \-J
30 .I journal-options
31 ]
32 [
33 .B \-m
34 .I reserved-blocks-percentage
35 ]
36 [
37 .B \-r
38 .I reserved-blocks-count
39 ]
40 [
41 .B \-s
42 .I sparse-super-flag
43 ]
44 [
45 .B \-u
46 .I user
47 ]
48 [
49 .B \-g
50 .I group
51 ]
52 [
53 .B \-C
54 .I mount-count
55 ]
56 [
57 .B \-L
58 .I volume-name
59 ]
60 [
61 .B \-M
62 .I last-mounted-directory
63 ]
64 [
65 .B \-O 
66 \fR[^]\fIfeature\fR[,...]
67 ]
68 [
69 .B \-U
70 .I UUID
71 ]
72 device
73 .SH DESCRIPTION
74 .BI tune2fs
75 adjusts tunable filesystem parameters on a Linux second extended filesystem.
76 .SH OPTIONS
77 .TP
78 .BI \-c " max-mount-counts"
79 adjust the maximal mounts count between two filesystem checks.  If 
80 .I max-mount-counts
81 is -1 then the number of times the filesystem is mounted will be disregarded
82 by e2fsck and the kernel.
83 .TP
84 .BI \-e " error-behavior"
85 change the behavior of the kernel code when errors are detected.
86 .I error-behavior
87 can be one of the following:
88 .br
89 \       continue\       \       Continue normal execution.
90 .br
91 \       remount-ro\     Remount filesystem read-only.
92 .br
93 \       panic\  \       Cause a kernel panic.
94 .TP
95 .BI \-g " group"
96 set the user group which can benefit from the reserved blocks.
97 .br
98 .I group
99 can be a numerical gid or a group name.  If a group name is given,
100 it is converted to a numerical gid before it is stored in the superblock.
101 .TP
102 .BI \-i " interval-between-checks\fR[\fBd\fR|\fBm\fR|\fBw\fR]"
103 adjust the maximal time between two filesystem checks. 
104 No postfix or
105 .B d
106 result in days,
107 .B m
108 in months, and
109 .B w
110 in weeks.  A value of zero will disable the timedependent checking.
111 .TP
112 .B -j
113 Add an ext3 journal to the filesystem.
114 If the 
115 .B \-J
116 option is not specified, the default journal parameters will used will create
117 an appropriately sized journal (given the size of the filesystem) 
118 stored within the filesystem.
119 .TP
120 .BR \-J " journal_options"
121 add a journal inode or device to the filesystem.  
122 Journal options are comma
123 separated, and may take an argument using the equals ('=')  sign.
124 Currently only two (mutually exclusive) options are supported,
125 .I size
126 and
127 .IR device .
128 .TP
129 .BI "\-J size=" journal-size
130 Create a journal stored in the filesystem of size
131 .IR journal-size .
132 The size of the journal must be between 1MB and 100MB and there 
133 must be sufficient free space in the filesystem to create a journal of
134 that size.
135 .TP
136 .BI "\-J device=" external-journal
137 Add an external journal found on a block device
138 named by 
139 .I external-journal 
140 to the filesystem.
141 The external 
142 journal must have been already created using the command
143 .B mke2fs -O journal_dev 
144 .IR journal-device.
145 .TP
146 .B \-l
147 list the contents of the filesystem superblock.
148 .TP
149 .BI \-m " reserved-blocks-percentage"
150 adjust the reserved blocks percentage on the given device.
151 .TP
152 .BI \-r " reserved-blocks-count"
153 adjust the reserved blocks count on the given device.
154 .TP
155 .BI \-s " sparse_super_flag"
156 set or reset the sparse_superblock flag.  The sparse_superblock feature
157 saves space on really big filesystems.
158 .B Warning:
159 The Linux 2.0 kernel does not properly support this feature.  Neither do
160 all Linux 2.1 kernels; please don't use this unless you know what you're
161 doing!
162 .TP
163 .BI \-u " user"
164 set the user who can benefit from the reserved blocks.
165 .I user
166 can be a numerical uid or a user name.  If a user name is given, it 
167 is converted to a numerical uid before it is stored in the superblock.
168 .TP
169 .BI \-C " mount-count"
170 set the number of times the filesystem has been mounted.
171 .TP
172 .BI \-L " volume-label"
173 set the volume label of the filesystem.  
174 Ext2 filesystem labels can be at most 16 characters long; if
175 .I volume-label 
176 is longer than 16 characters, 
177 .B tune2fs
178 will truncate it and print a warning message.  
179 .TP
180 .BI \-M " last-mounted-directory"
181 set the last-mounted directory for the filesystem.
182 .TP
183 .BI \-O " \fR[^]\fIfeature\fR[,...]"
184 set or clear the indicated filesystem features (options) in the filesystem.
185 .I Feature
186 can be one of the following supported filesystem options: 
187 .IR sparse_super ,
188 which will cause the filesystem to use sparse superblocks, and
189 .IR filetype ,
190 which will cause the filesystem to store file type information in 
191 directory entries.  After setting or clearing either filesystem feature,
192 e2fsck must be run on the filesystem.
193 .TP
194 .BI \-U " UUID"
195 set the UUID of the filesystem.  A sample UUID looks like this: 
196 "c1b9d5a2-f162-11cf-9ece-0020afc76f16".  The uuid may also be
197 .IR null ,
198 which will set the filesystem UUID to the null UUID (clearing it), 
199 .IR random ,
200 which will generate a new random-based UUID for the filesystem, or
201 .IR time ,
202 which will generate a new time-based UUID for the filesystem (see
203 .BR uuidgen (8)).
204 .SH BUGS
205 We haven't found any bugs yet.  That doesn't mean there aren't any...
206 .SH WARNING
207 Never use tune2fs to change parameters of a read/write mounted filesystem!
208 .B Use this utility
209 .B at your own risk.
210 You're modifying a filesystem!
211 .SH AUTHOR
212 .B tune2fs 
213 was written by Remy Card <Remy.Card@linux.org>.
214 .B tune2fs
215 uses the ext2fs library written by Theodore Ts'o <tytso@mit.edu>.
216 This manual page was written by Christian Kuhtz <chk@data-hh.Hanse.DE>.
217 Timedependent checking was added by Uwe Ohse <uwe@tirka.gun.de>.
218 .SH AVAILABILITY
219 .B tune2fs
220 is part of the e2fsprogs package and is available for anonymous 
221 ftp from tsx-11.mit.edu in /pub/linux/packages/ext2fs.
222 .SH SEE ALSO
223 .BR dumpe2fs (8),
224 .BR e2fsck (8),
225 .BR mke2fs (8)