Debian Codegraph @

upstream/debian-trixie/man8/reiserfstune.8

raw
1 .\" -*- nroff -*-
2 .\" Copyright 1996-2004 Hans Reiser.
3 .\"
4 .TH REISERFSTUNE 8 "January 2009" "Reiserfsprogs-3.6.27"
5 .SH NAME
6 reiserfstune \- The tunning tool for the ReiserFS filesystem.
7 .SH SYNOPSIS
8 .B reiserfstune
9 [ \fB-f\fR ]
10 [ \fB-h\fR | \fB--help\fR ]
11 [ \fB-j\fR | \fB--journal-device\fR \fIFILE\fR ]
12 [ \fB--no-journal-available\fR ]
13 [ \fB--journal-new-device\fR \fIFILE\fR ] [ \fB--make-journal-standard\fR ]
14 [ \fB-s\fR | \fB--journal-new-size\fR \fIN\fR ]
15 [ \fB-o\fR | \fB--journal-new-offset\fR \fIN\fR ]
16 [ \fB-t\fR | \fB--max-transaction-size\fR \fIN\fR ]
17 [ \fB-b\fR | \fB--add-badblocks\fR \fIfile\fR ]
18 [ \fB-B\fR | \fB--badblocks\fR \fIfile\fR ]
19 [ \fB-u\fR | \fB--uuid \fIUUID\fR ]
20 [ \fB-l\fR | \fB--label \fILABEL\fR ]
21 [ \fB-c\fR | \fB--check-interval \fIinterval-in-days\fR ]
22 [ \fB-C\fR | \fB--time-last-checked \fItimestamp\fR ]
23 [ \fB-m\fR | \fB--max-mnt-count \fIcount\fR ]
24 [ \fB-M\fR | \fB--mnt-count \fIcount\fR ]
25 .I device
26 .SH DESCRIPTION
27 \fBreiserfstune\fR is used for tuning the ReiserFS. It can change two journal
28 parameters (the journal size and the maximum transaction size), and it can move
29 the journal's location to a new specified block device. (The old ReiserFS's
30 journal may be kept unused, or discarded at the user's option.) Besides that
31 \fBreiserfstune\fR can store the bad block list to the ReiserFS and set UUID
32 and LABEL.
33 Note: At the time of writing the relocated journal was implemented for a special
34 release of ReiserFS, and was not expected to be put into the mainstream kernel
35 until approximately Linux 2.5. This means that if you have the stock kernel you
36 must apply a special patch. Without this patch the kernel will refuse to mount
37 the newly modified file system. We will charge $25 to explain this to you if
38 you ask us why it doesn't work.
39 .PP
40 Perhaps the most interesting application of this code is to put the
41 journal on a solid state disk.
42 .TP
43 \fIdevice
44 is the special file corresponding to the newly specified block device (e.g
45 /dev/hdXX for IDE disk partition or /dev/sdXX for the SCSI disk partition).
46 .SH OPTIONS
47 .TP
48 \fB-h\fR | \fB--help\fR
49 Print usage information and exit.
50 .TP
51 \fB-j\fR | \fB--journal-device\fR \fIFILE
52 \fIFILE\fR is the file name of the block device the file system has
53 the current journal (the one prior to running reiserfstune) on. This option is required when the journal is
54 already on a separate device from the main data device (although it
55 can be avoided with \fB--no-journal-available\fR). If you don't
56 specify journal device by this option, reiserfstune suppose that
57 journal is on main device.
58 .TP
59 \fB--no-journal-available
60 allows \fBreiserfstune\fR to continue when the current journal's block
61 device is no longer available. This might happen if a disk goes bad
62 and you remove it (and run fsck).
63 .TP
64 \fB--journal-new-device \fIFILE
65 \fIFILE\fR is the file name of the block device which will contain the
66 new journal for the file system. If you don't specify this,
67 reiserfstune supposes that journal device remains the same.
68 .TP
69 \fB \-s\fR | \fB\--journal-new-size \fIN
70 \fIN\fR is the size parameter for the new journal. When journal is to
71 be on a separate device - its size defaults to number of blocks that
72 device has. When journal is to be on the same device as the filesytem - its size defaults
73 to amount of blocks allocated for journal by \fImkreiserfs\fR when it
74 created the filesystem. Minimum is 513 for
75 both cases.
76 .TP
77 \fB \-o\fR | \fB\--journal-new-offset \fIN
78 \fIN\fR is an offset in blocks where journal will starts from when journal is to
79 be on a separate device. Default is 0. Has no effect when journal is
80 to be on the same device as the filesystem. Most users have no need
81 to use this feature. It can be used when you want the journals from
82 multiple filesystems to reside on the same device, and you don't want
83 to or cannot partition that device.
84 .TP
85 \fB \-t\fR | \fB\--maximal-transaction-size \fIN
86 \fIN\fR is the maximum transaction size parameter for the new
87 journal. The default, and max possible, value is 1024 blocks. It
88 should be less than half the size of the journal. If specifed
89 incorrectly, it will be adjusted.
90 .TP
91 \fB \-b\fR | \fB\--add-badblocks\fR \fIfile\fR
92 \fIFile\fR is the file name of the file that contains the list of blocks to be marked
93 as bad on the fs. The list is added to the fs list of bad blocks.
94 .TP
95 \fB \-B\fR | \fB\--badblocks\fR \fIfile\fR
96 \fIFile\fR is the file name of the file that contains the list of blocks to be marked
97 as bad on the fs. The bad block list on the fs is cleared before the list specified
98 in the \fIFile\fR is added to the fs.
99 .TP
100 \fB\-f\fR | \fB--force\fR
101 Normally \fBreiserfstune\fR will refuse to change a journal of a
102 file system that was created before this journal relocation code. This
103 is because if you change the journal, you cannot go back (without special
104 option \fB--make-journal-standard\fR) to an old kernel that lacks this feature and be able to use your filesytem. This option forces it to do that. Specified more
105 than once it allows to avoid asking for confirmation.
106 .TP
107 \fB--make-journal-standard\fR
108 As it was mentioned above, if your file system has non-standard journal,
109 it can not be mounted on the kernel without journal relocation
110 code. The thing can be changed, the only condition is that there is reserved
111 area on main device of the standard journal size 8193 blocks (it will be so for
112 instance if you convert standard journal to non-standard). Just
113 specify this option when you relocate journal back, or without relocation
114 if you already have it on main device.
115 .TP
116 \fB-u\fR | \fB--uuid \fIUUID\fR
117 Set the universally unique identifier (\fB UUID \fR) of the filesystem to
118 \fIUUID\fR (see also \fBuuidgen(8)\fR). The format of the UUID is a
119 series of hex digits separated by hypthens, like this:
120 "c1b9d5a2-f162-11cf-9ece-0020afc76f16".
121 .TP
122 \fB-l\fR | \fB--label \fILABEL\fR
123 Set the volume label of the filesystem. \fILABEL\fR can be at most 16
124 characters long; if it is longer than 16 characters, reiserfstune will truncate it.
125 .TP
126 \fB-c\fR | \fB--check-interval \fIinterval-in-days\fR
127 Adjust the maximal time between two filesystem checks. A value of "disable"
128 will disable the time-dependent checking. A value of "default" will restore
129 the compile-time default.
130
131 It is strongly recommended that either
132 .B \-m
133 (mount-count dependent) or
134 .B \-c
135 (time-dependent) checking be enabled to force periodic full
136 .BR fsck.reiserfs(8)
137 checking of the filesystem. Failure to do so may lead to
138 filesystem corruption (due to bad disks, cables, memory, or kernel bugs)
139 going unnoticed, ultimately resulting in data loss or corruption.
140 .TP
141 \fB-C\fR | \fB--time-last-checked \fItimestamp\fR
142 Set the time the filesystem was last checked using fsck.reiserfs. This
143 can be useful in scripts which use a Logical Volume Manager to make a
144 consistent snapshot of a filesystem, and then check the filesystem during
145 off hours to make sure it hasn't been corrupted due to hardware problems,
146 etc. If the filesystem was clean, then this option can be used to set the
147 last checked time on the original filesystem. The format of time-last-checked
148 is the international date format, with an optional time specifier, i.e.
149 YYYYMMDD[HH[MM[SS]]]. The keyword
150 .B now
151 is also accepted, in which case the
152 last checked time will be set to the current time.
153 .TP
154 \fB-m\fR | \fB--max-mnt-count \fImax-mount-count\fR
155 Adjust the number of mounts after which the filesystem will be
156 checked by
157 .BR fsck.reiserfs(8).
158 If max-mount-count is "disable", the number of times the filesystem
159 is mounted will be disregarded by
160 .BR fsck.reiserfs(8)
161 and the kernel. A value of "default" will restore the compile-time default.
162
163 Staggering the mount-counts at which filesystems are forcibly
164 checked will avoid all filesystems being checked at one time
165 when using journaled filesystems.
166
167 You should strongly consider the consequences of disabling
168 mount-count-dependent checking entirely. Bad disk drives,
169 cables, memory, and kernel bugs could all corrupt a filesystem
170 without marking the filesystem dirty or in error. If you are
171 using journaling on your filesystem, your filesystem will never
172 be marked dirty, so it will not normally be checked. A filesys‐
173 tem error detected by the kernel will still force an fsck on the
174 next reboot, but it may already be too late to prevent data loss
175 at that point.
176
177 This option requires a kernel which supports incrementing the
178 count on each mount. This feature has not been incorporated into
179 kernel versions older than 2.6.25.
180
181 See also the
182 .B \-c
183 option for time-dependent checking.
184 .TP
185 \fB-M\fR | \fB--mnt-count \fIcount\fR
186 Set the number of times the filesystem has been mounted. If set
187 to a greater value than the max-mount-counts parameter set by
188 the
189 .B \-m
190 option,
191 .BR fsck.reiserfs(8)
192 will check the filesystem at the next
193 reboot.
194 .SH POSSIBLE SCENARIOS OF USING REISERFSTUNE:
195 1. You have ReiserFS on /dev/hda1, and you wish to have
196 it working with its journal on the device /dev/journal
197 .nf
198 .IP
199 boot kernel patched with special "relocatable journal support" patch
200 reiserfstune /dev/hda1 \-\-journal\-new\-device /dev/journal \-f
201 mount /dev/hda1 and use.
202 You would like to change max transaction size to 512 blocks
203 reiserfstune \-t 512 /dev/hda1
204 You would like to use your file system on another kernel that doesn't
205 contain relocatable journal support.
206 umount /dev/hda1
207 reiserfstune /dev/hda1 \-j /dev/journal \-\-journal\-new\-device /dev/hda1 \-\-make\-journal\-standard
208 mount /dev/hda1 and use.
209 .LP
210 2. You would like to have ReiserFS on /dev/hda1 and to be able to
211 switch between different journals including journal located on the
212 device containing the filesystem.
213 .nf
214 .IP
215 boot kernel patched with special "relocatable journal support" patch
216 mkreiserfs /dev/hda1
217 you got solid state disk (perhaps /dev/sda, they typically look like scsi disks)
218 reiserfstune \-\-journal\-new\-device /dev/sda1 \-f /dev/hda1
219 Your scsi device dies, it is three in the morning, you have an extra IDE device
220 lying around
221 reiserfsck \-\-no\-journal\-available /dev/hda1
222 or
223 reiserfsck \-\-rebuild-tree \-\-no\-journal\-available /dev/hda1
224 reiserfstune \-\-no\-journal\-available \-\-journal\-new\-device /dev/hda1 /dev/hda1
225 using /dev/hda1 under patched kernel
226 .SH AUTHOR
227 This version of \fBreiserfstune\fR has been written by Vladimir
228 Demidov <[email protected]> and Edward Shishkin <[email protected]>.
229 .SH BUGS
230 Please report bugs to the ReiserFS developers <[email protected]>, providing
231 as much information as possible--your hardware, kernel, patches, settings, all printed
232 messages; check the syslog file for any related information.
233 .SH SEE ALSO
234 .BR reiserfsck (8),
235 .BR debugreiserfs (8),
236 .BR mkreiserfs (8)
237
238