Debian Codegraph @

upstream/mageia-cauldron/man8/volume.reiser4.8

raw
1 .\" Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH volume.reiser4 8 "16 Aug, 2020" reiser4progs "reiser4progs manual"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh disable hyphenation
10 .\" .hy enable hyphenation
11 .\" .ad l left justify
12 .\" .ad b justify to both left and right margins
13 .\" .nf disable filling
14 .\" .fi enable filling
15 .\" .br insert line break
16 .\" .sp <n> insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .SH NAME
19 volume.reiser4 \- the program for managing reiser4 logical volumes.
20 .SH SYNOPSIS
21 .B volume.reiser4
22 [ options ] [ FILE ] [ MNT ]
23 .SH DESCRIPTION
24 .B volume.reiser4
25 is an utility to manage reiser4 logical (compound) volumes. It performs
26 operations on logical volumes like adding[removing] a brick to[from]
27 your volume, changing capacity of any brick of your volume, increasing
28 current upper limit on total number of bricks in your volume.
29 On-line options are applicable only to mounted volumes. Other options
30 don't have such restrictions. This program doesn't create initial volume.
31 Instead, it operates on bricks, which are formatted partitions. To
32 create a brick use mkfs.reiser4(8) utility. For more details see logical
33 volumes administration guide at
34 .nh
35 https://reiser4.wiki.kernel.org/index.php/Logical_Volumes_Administration
36 .hy
37 .SH COMMON OPTIONS
38 .TP
39 .B -V, --version
40 Prints program version.
41 .TP
42 .B -?, -h, --help
43 Prints program help.
44 .TP
45 .B -y, --yes
46 Assumes an answer 'yes' to all questions.
47 .SH OFF-LINE OPTIONS
48 .TP
49 .B -g, --register DEV
50 Register a brick associated with device DEV in the system.
51 .TP
52 .B -u, --unregister DEV
53 Unregister a brick associated with device DEV in the system.
54 .TP
55 .B -l, --list
56 Print list of all bricks registered in the system.
57 .SH ON-LINE OPTIONS
58 .TP
59 .B -p, --print N
60 Print information about a brick of serial number N in the volume mounted at MNT.
61 .TP
62 .B -b, --balance
63 Run a balancing procedure on a volume mounted at MNT.
64 .TP
65 .B -z, --resize DEV
66 Change data capacity of a brick associated with device DEV in the
67 volume mounted at MNT. The actual capacity has to be defined by the
68 option "-c (--capacity)".
69 .TP
70 .B -c, --capacity VALUE
71 Define new data capacity VALUE for a device specified by option
72 "-z (--resize)".
73 .TP
74 .B -a, --add DEV
75 Add a brick associated with device DEV to the volume mounted at MNT.
76 This operation makes the volume unbalanced. Using in conjunction with -B
77 (--with-balance) option, completes the operation with balancing.
78 .TP
79 .B -x, --add-proxy
80 Add a proxy brick associated with device DEV to the volume mounted at MNT.
81 .TP
82 .B -r, --remove
83 Remove a brick associated with device DEV from the volume mounted at MNT.
84 Automatically triggers balancing, which is considered as a part of the
85 removal operation. Being interrupted for some reasons, should be completed by
86 running the utility with the option -R (--finish-removal).
87 .TP
88 .B -q, --scale N
89 Increase 2^N times the upper limit for total number of bricks in the
90 volume mounted at MNT. This operation makes the volume unbalanced.
91 Using in conjunction with -B (--with-balance) option, completes the operation
92 with balancing.
93 .TP
94 .B -m, --migrate N
95 Move all data blocks of regular FILE to a brick of serial number N.
96 .TP
97 .B -i, --set-immobile
98 Set "immobile" property to regular FILE.
99 .TP
100 .B -e, --clear-immobile
101 Clear "immobile" property of regular FILE.
102 .TP
103 .B -B, --with-balance
104 Complete a volume operation with balancing procedure. Can be used only in
105 conjunction with options -a (--add), -z (--resize), -q (--scale).
106 .TP
107 .B -R, --finish-removal
108 Finish brick removal operation interrupted for various reasons.
109 .TP
110 .B -S, --restore-regular
111 Restore regular distribution on the volume mounted at MNT.
112 .sp 1
113 .SH Examples:
114 .sp 1
115 To create a volume, choose volume ID and stripe size. Then create a first
116 brick, that will be the meta-data brick of your volume:
117 .sp 1
118 VOL_ID=`uuidgen`
119 .sp 1
120 STRIPE=256K
121 .sp 1
122 mkfs.reiser4 -U $VOL_ID -t $STRIPE /dev/sdb1
123 .sp 1
124 To add a data brick to your initial volume, consisting of only one meta-data
125 brick, mount it e.g. at /mnt:
126 .sp 1
127 mount /dev/sdb1 /mnt
128 .sp 1
129 Choose a block device for your data brick (e.g. /dev/sdb2) and format it with
130 the same volume ID and stripe size:
131 .sp 1
132 mkfs.reiser4 -a -U $VOL_ID -t $STRIPE /dev/sdb2
133 .sp 1
134 Finally, using option "-a", add it to the volume:
135 .sp 1
136 volume.reiser4 -a /dev/sdb2 /mnt
137 .sp 1
138 After this, you might want to run balancing procedure on your volume. It will
139 distribute all your data among the bricks fairly, i.e. in a proportion with
140 bricks capacities. For this simply run the utility with the option -b (--balance):
141 .sp 1
142 volume.reiser4 -b /mnt
143 .sp 1
144 To remove a brick from your logical volume simply specify the block device that
145 the brick is associated with, using option "-r":
146 .sp 1
147 volume.reiser4 -r /dev/sdb2 /mnt
148 .sp 1
149 After successful removal completion your volume is always balanced.
150 If the operation of brick removal was interrupted for some reasons, then complete
151 the removal by running the utility with the option -R (--finish-removal):
152 .sp 1
153 volume.reiser4 -R /mnt
154 .RS
155 .SH REPORTING BUGS
156 Report bugs to <[email protected]>
157 .SH SEE ALSO
158 .BR mkfs.reiser4(8),
159 .BR debugfs.reiser4(8),
160 .br
161 Reiser4 logical volumes administration guide at
162 .nh
163 https://reiser4.wiki.kernel.org/index.php/Logical_Volumes_Administration
164 .hy
165 .SH AUTHOR
166 Written by Edward O. Shishkin