ocaml: Fix bindings when a function takes more than 10 parameters.
[libguestfs.git] / po-docs / libguestfs-docs.pot
1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Red Hat Inc.
3 # This file is distributed under the same license as the libguestfs package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
5 #
6 #, fuzzy
7 msgid ""
8 msgstr ""
9 "Project-Id-Version: libguestfs 1.15.2\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-11-03 14:10+0000\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
15 "Language: \n"
16 "MIME-Version: 1.0\n"
17 "Content-Type: text/plain; charset=UTF-8\n"
18 "Content-Transfer-Encoding: 8bit\n"
19
20 #. type: =head1
21 #: ../align/virt-alignment-scan.pod:3 ../cat/virt-cat.pod:3 ../cat/virt-filesystems.pod:3 ../cat/virt-ls.pod:3 ../clone/virt-sysprep.pod:3 ../df/virt-df.pod:3 ../edit/virt-edit.pod:3 ../erlang/examples/guestfs-erlang.pod:3 ../examples/guestfs-examples.pod:3 ../examples/guestfs-recipes.pod:14 ../fish/guestfish.pod:3 ../fish/virt-copy-in.pod:3 ../fish/virt-copy-out.pod:3 ../fish/virt-tar-in.pod:3 ../fish/virt-tar-out.pod:3 ../fuse/guestmount.pod:3 ../inspector/virt-inspector.pod:3 ../java/examples/guestfs-java.pod:3 ../ocaml/examples/guestfs-ocaml.pod:3 ../perl/examples/guestfs-perl.pod:3 ../python/examples/guestfs-python.pod:3 ../rescue/virt-rescue.pod:3 ../resize/virt-resize.pod:3 ../ruby/examples/guestfs-ruby.pod:3 ../sparsify/virt-sparsify.pod:3 ../src/guestfs.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../tools/virt-list-filesystems.pl:30 ../tools/virt-list-partitions.pl:30 ../tools/virt-make-fs.pl:35 ../tools/virt-tar.pl:31 ../tools/virt-win-reg.pl:35
22 msgid "NAME"
23 msgstr ""
24
25 #. type: textblock
26 #: ../align/virt-alignment-scan.pod:5
27 msgid "virt-alignment-scan - Check alignment of virtual machine partitions"
28 msgstr ""
29
30 #. type: =head1
31 #: ../align/virt-alignment-scan.pod:7 ../cat/virt-cat.pod:7 ../cat/virt-filesystems.pod:7 ../cat/virt-ls.pod:7 ../clone/virt-sysprep.pod:7 ../df/virt-df.pod:7 ../edit/virt-edit.pod:7 ../erlang/examples/guestfs-erlang.pod:7 ../examples/guestfs-examples.pod:7 ../fish/guestfish.pod:7 ../fish/virt-copy-in.pod:7 ../fish/virt-copy-out.pod:7 ../fish/virt-tar-in.pod:7 ../fish/virt-tar-out.pod:7 ../fuse/guestmount.pod:7 ../inspector/virt-inspector.pod:7 ../java/examples/guestfs-java.pod:7 ../ocaml/examples/guestfs-ocaml.pod:7 ../perl/examples/guestfs-perl.pod:7 ../python/examples/guestfs-python.pod:7 ../rescue/virt-rescue.pod:7 ../resize/virt-resize.pod:7 ../ruby/examples/guestfs-ruby.pod:7 ../sparsify/virt-sparsify.pod:7 ../src/guestfs.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../tools/virt-list-filesystems.pl:34 ../tools/virt-list-partitions.pl:34 ../tools/virt-make-fs.pl:39 ../tools/virt-tar.pl:35 ../tools/virt-win-reg.pl:39
32 msgid "SYNOPSIS"
33 msgstr ""
34
35 #. type: verbatim
36 #: ../align/virt-alignment-scan.pod:9
37 #, no-wrap
38 msgid ""
39 " virt-alignment-scan [--options] -d domname\n"
40 "\n"
41 msgstr ""
42
43 #. type: verbatim
44 #: ../align/virt-alignment-scan.pod:11
45 #, no-wrap
46 msgid ""
47 " virt-alignment-scan [--options] -a disk.img [-a disk.img ...]\n"
48 "\n"
49 msgstr ""
50
51 #. type: =head1
52 #: ../align/virt-alignment-scan.pod:13 ../cat/virt-cat.pod:19 ../cat/virt-filesystems.pod:13 ../cat/virt-ls.pod:19 ../clone/virt-sysprep.pod:13 ../df/virt-df.pod:21 ../edit/virt-edit.pod:27 ../erlang/examples/guestfs-erlang.pod:16 ../examples/guestfs-examples.pod:19 ../examples/guestfs-recipes.pod:18 ../fish/guestfish.pod:30 ../fish/virt-copy-in.pod:19 ../fish/virt-copy-out.pod:13 ../fish/virt-tar-in.pod:21 ../fish/virt-tar-out.pod:15 ../fuse/guestmount.pod:20 ../inspector/virt-inspector.pod:19 ../java/examples/guestfs-java.pod:15 ../ocaml/examples/guestfs-ocaml.pod:25 ../perl/examples/guestfs-perl.pod:18 ../python/examples/guestfs-python.pod:14 ../rescue/virt-rescue.pod:31 ../resize/virt-resize.pod:13 ../ruby/examples/guestfs-ruby.pod:15 ../sparsify/virt-sparsify.pod:11 ../src/guestfs.pod:23 ../test-tool/libguestfs-test-tool.pod:11 ../tools/virt-list-filesystems.pl:40 ../tools/virt-list-partitions.pl:40 ../tools/virt-make-fs.pl:47 ../tools/virt-tar.pl:77 ../tools/virt-win-reg.pl:63
53 msgid "DESCRIPTION"
54 msgstr ""
55
56 #. type: textblock
57 #: ../align/virt-alignment-scan.pod:15
58 msgid ""
59 "When older operating systems install themselves, the partitioning tools "
60 "place partitions at a sector misaligned with the underlying storage "
61 "(commonly the first partition starts on sector C<63>).  Misaligned "
62 "partitions can result in an operating system issuing more I/O than should be "
63 "necessary."
64 msgstr ""
65
66 #. type: textblock
67 #: ../align/virt-alignment-scan.pod:21
68 msgid ""
69 "The virt-alignment-scan tool checks the alignment of partitions in virtual "
70 "machines and disk images and warns you if there are alignment problems."
71 msgstr ""
72
73 #. type: textblock
74 #: ../align/virt-alignment-scan.pod:25
75 msgid ""
76 "Currently there is no virt tool for fixing alignment problems.  You can only "
77 "reinstall the guest operating system.  The following NetApp document "
78 "summarises the problem and possible solutions: "
79 "L<http://media.netapp.com/documents/tr-3747.pdf>"
80 msgstr ""
81
82 #. type: =head1
83 #: ../align/virt-alignment-scan.pod:30
84 msgid "OUTPUT"
85 msgstr ""
86
87 #. type: textblock
88 #: ../align/virt-alignment-scan.pod:32
89 msgid "To run this tool on a disk image directly, use the I<-a> option:"
90 msgstr ""
91
92 #. type: verbatim
93 #: ../align/virt-alignment-scan.pod:34
94 #, no-wrap
95 msgid ""
96 " $ virt-alignment-scan -a winxp.img\n"
97 " /dev/sda1        32256          512    bad (alignment < 4K)\n"
98 "\n"
99 msgstr ""
100
101 #. type: verbatim
102 #: ../align/virt-alignment-scan.pod:37
103 #, no-wrap
104 msgid ""
105 " $ virt-alignment-scan -a fedora16.img\n"
106 " /dev/sda1      1048576         1024K   ok\n"
107 " /dev/sda2      2097152         2048K   ok\n"
108 " /dev/sda3    526385152         2048K   ok\n"
109 "\n"
110 msgstr ""
111
112 #. type: textblock
113 #: ../align/virt-alignment-scan.pod:42
114 msgid ""
115 "To run the tool on a guest known to libvirt, use the I<-d> option and "
116 "possibly the I<-c> option:"
117 msgstr ""
118
119 #. type: verbatim
120 #: ../align/virt-alignment-scan.pod:45
121 #, no-wrap
122 msgid ""
123 " # virt-alignment-scan -d RHEL5\n"
124 " /dev/sda1        32256          512    bad (alignment < 4K)\n"
125 " /dev/sda2    106928640          512    bad (alignment < 4K)\n"
126 "\n"
127 msgstr ""
128
129 #. type: verbatim
130 #: ../align/virt-alignment-scan.pod:49
131 #, no-wrap
132 msgid ""
133 " $ virt-alignment-scan -c qemu:///system -d Win7TwoDisks\n"
134 " /dev/sda1      1048576         1024K   ok\n"
135 " /dev/sda2    105906176         1024K   ok\n"
136 " /dev/sdb1        65536           64K   ok\n"
137 "\n"
138 msgstr ""
139
140 #. type: textblock
141 #: ../align/virt-alignment-scan.pod:54
142 msgid ""
143 "The output consists of 4 or more whitespace-separated columns.  Only the "
144 "first 4 columns are signficant if you want to parse this from a program.  "
145 "The columns are:"
146 msgstr ""
147
148 #. type: =item
149 #: ../align/virt-alignment-scan.pod:60
150 msgid "col 1"
151 msgstr ""
152
153 #. type: textblock
154 #: ../align/virt-alignment-scan.pod:62
155 msgid ""
156 "the device and partition name (eg. C</dev/sda1> meaning the first partition "
157 "on the first block device)"
158 msgstr ""
159
160 #. type: =item
161 #: ../align/virt-alignment-scan.pod:65
162 msgid "col 2"
163 msgstr ""
164
165 #. type: textblock
166 #: ../align/virt-alignment-scan.pod:67
167 msgid "the start of the partition in bytes"
168 msgstr ""
169
170 #. type: =item
171 #: ../align/virt-alignment-scan.pod:69
172 msgid "col 3"
173 msgstr ""
174
175 #. type: textblock
176 #: ../align/virt-alignment-scan.pod:71
177 msgid "the alignment in bytes or Kbytes (eg. C<512> or C<4K>)"
178 msgstr ""
179
180 #. type: =item
181 #: ../align/virt-alignment-scan.pod:73
182 msgid "col 4"
183 msgstr ""
184
185 #. type: textblock
186 #: ../align/virt-alignment-scan.pod:75
187 msgid ""
188 "C<ok> if the alignment is best for performance, or C<bad> if the alignment "
189 "can cause performance problems"
190 msgstr ""
191
192 #. type: =item
193 #: ../align/virt-alignment-scan.pod:78
194 msgid "cols 5+"
195 msgstr ""
196
197 #. type: textblock
198 #: ../align/virt-alignment-scan.pod:80
199 msgid "optional free-text explanation."
200 msgstr ""
201
202 #. type: textblock
203 #: ../align/virt-alignment-scan.pod:84
204 msgid ""
205 "The exit code from the program changes depending on whether poorly aligned "
206 "partitions were found.  See L</EXIT STATUS> below."
207 msgstr ""
208
209 #. type: textblock
210 #: ../align/virt-alignment-scan.pod:87
211 msgid "If you just want the exit code with no output, use the I<-q> option."
212 msgstr ""
213
214 #. type: =head1
215 #: ../align/virt-alignment-scan.pod:89 ../cat/virt-cat.pod:62 ../cat/virt-filesystems.pod:91 ../cat/virt-ls.pod:261 ../clone/virt-sysprep.pod:42 ../df/virt-df.pod:59 ../edit/virt-edit.pod:62 ../fish/guestfish.pod:148 ../fish/virt-copy-in.pod:45 ../fish/virt-copy-out.pod:34 ../fish/virt-tar-in.pod:42 ../fish/virt-tar-out.pod:36 ../fuse/guestmount.pod:92 ../inspector/virt-inspector.pod:55 ../rescue/virt-rescue.pod:112 ../resize/virt-resize.pod:262 ../sparsify/virt-sparsify.pod:99 ../test-tool/libguestfs-test-tool.pod:36 ../tools/virt-list-filesystems.pl:53 ../tools/virt-list-partitions.pl:54 ../tools/virt-make-fs.pl:153 ../tools/virt-tar.pl:103 ../tools/virt-win-reg.pl:96
216 msgid "OPTIONS"
217 msgstr ""
218
219 #. type: =item
220 #: ../align/virt-alignment-scan.pod:93 ../cat/virt-cat.pod:66 ../cat/virt-filesystems.pod:95 ../cat/virt-ls.pod:265 ../clone/virt-sysprep.pod:46 ../df/virt-df.pod:63 ../edit/virt-edit.pod:66 ../fish/guestfish.pod:152 ../fuse/guestmount.pod:160 ../inspector/virt-inspector.pod:59 ../rescue/virt-rescue.pod:116 ../resize/virt-resize.pod:266 ../sparsify/virt-sparsify.pod:103 ../test-tool/libguestfs-test-tool.pod:40 ../tools/virt-list-filesystems.pl:61 ../tools/virt-list-partitions.pl:62 ../tools/virt-make-fs.pl:161 ../tools/virt-tar.pl:111 ../tools/virt-win-reg.pl:104
221 msgid "B<--help>"
222 msgstr ""
223
224 #. type: textblock
225 #: ../align/virt-alignment-scan.pod:95 ../cat/virt-cat.pod:68 ../cat/virt-filesystems.pod:97 ../cat/virt-ls.pod:267 ../clone/virt-sysprep.pod:48 ../df/virt-df.pod:65 ../edit/virt-edit.pod:68 ../inspector/virt-inspector.pod:61 ../rescue/virt-rescue.pod:118 ../tools/virt-list-filesystems.pl:63 ../tools/virt-list-partitions.pl:64 ../tools/virt-make-fs.pl:163 ../tools/virt-tar.pl:113 ../tools/virt-win-reg.pl:106
226 msgid "Display brief help."
227 msgstr ""
228
229 #. type: =item
230 #: ../align/virt-alignment-scan.pod:97 ../cat/virt-cat.pod:70 ../cat/virt-filesystems.pod:99 ../cat/virt-ls.pod:269 ../clone/virt-sysprep.pod:50 ../df/virt-df.pod:67 ../edit/virt-edit.pod:70 ../inspector/virt-inspector.pod:63 ../rescue/virt-rescue.pod:120
231 msgid "B<-a> file"
232 msgstr ""
233
234 #. type: =item
235 #: ../align/virt-alignment-scan.pod:99 ../cat/virt-cat.pod:72 ../cat/virt-filesystems.pod:101 ../cat/virt-ls.pod:271 ../clone/virt-sysprep.pod:52 ../df/virt-df.pod:69 ../edit/virt-edit.pod:72 ../inspector/virt-inspector.pod:65 ../rescue/virt-rescue.pod:122
236 msgid "B<--add> file"
237 msgstr ""
238
239 #. type: textblock
240 #: ../align/virt-alignment-scan.pod:101 ../clone/virt-sysprep.pod:54
241 msgid "Add I<file> which should be a disk image from a virtual machine."
242 msgstr ""
243
244 #. type: textblock
245 #: ../align/virt-alignment-scan.pod:103 ../cat/virt-cat.pod:78 ../cat/virt-filesystems.pod:107 ../cat/virt-ls.pod:277 ../clone/virt-sysprep.pod:56 ../df/virt-df.pod:75 ../edit/virt-edit.pod:78 ../fish/guestfish.pod:174 ../fuse/guestmount.pod:102 ../inspector/virt-inspector.pod:71 ../rescue/virt-rescue.pod:128
246 msgid ""
247 "The format of the disk image is auto-detected.  To override this and force a "
248 "particular format use the I<--format=..> option."
249 msgstr ""
250
251 #. type: =item
252 #: ../align/virt-alignment-scan.pod:106 ../cat/virt-cat.pod:81 ../cat/virt-filesystems.pod:125 ../cat/virt-ls.pod:291 ../clone/virt-sysprep.pod:59 ../df/virt-df.pod:78 ../rescue/virt-rescue.pod:135
253 msgid "B<-c> URI"
254 msgstr ""
255
256 #. type: =item
257 #: ../align/virt-alignment-scan.pod:108 ../cat/virt-cat.pod:83 ../cat/virt-filesystems.pod:127 ../cat/virt-ls.pod:293 ../clone/virt-sysprep.pod:61 ../df/virt-df.pod:80 ../rescue/virt-rescue.pod:137
258 msgid "B<--connect> URI"
259 msgstr ""
260
261 #. type: textblock
262 #: ../align/virt-alignment-scan.pod:110 ../cat/virt-cat.pod:85 ../cat/virt-filesystems.pod:129 ../cat/virt-ls.pod:295 ../clone/virt-sysprep.pod:63 ../df/virt-df.pod:82 ../edit/virt-edit.pod:99 ../inspector/virt-inspector.pod:78 ../rescue/virt-rescue.pod:139 ../tools/virt-list-filesystems.pl:81 ../tools/virt-list-partitions.pl:82 ../tools/virt-tar.pl:131 ../tools/virt-win-reg.pl:132
263 msgid ""
264 "If using libvirt, connect to the given I<URI>.  If omitted, then we connect "
265 "to the default libvirt hypervisor."
266 msgstr ""
267
268 #. type: textblock
269 #: ../align/virt-alignment-scan.pod:113 ../cat/virt-cat.pod:88 ../cat/virt-filesystems.pod:132 ../cat/virt-ls.pod:298 ../clone/virt-sysprep.pod:66 ../df/virt-df.pod:85 ../rescue/virt-rescue.pod:142
270 msgid ""
271 "If you specify guest block devices directly (I<-a>), then libvirt is not "
272 "used at all."
273 msgstr ""
274
275 #. type: =item
276 #: ../align/virt-alignment-scan.pod:116 ../cat/virt-cat.pod:91 ../cat/virt-filesystems.pod:141 ../cat/virt-ls.pod:307 ../clone/virt-sysprep.pod:69 ../df/virt-df.pod:94 ../edit/virt-edit.pod:105 ../inspector/virt-inspector.pod:85 ../rescue/virt-rescue.pod:145
277 msgid "B<-d> guest"
278 msgstr ""
279
280 #. type: =item
281 #: ../align/virt-alignment-scan.pod:118 ../cat/virt-cat.pod:93 ../cat/virt-filesystems.pod:143 ../cat/virt-ls.pod:309 ../clone/virt-sysprep.pod:71 ../df/virt-df.pod:96 ../edit/virt-edit.pod:107 ../inspector/virt-inspector.pod:87 ../rescue/virt-rescue.pod:147
282 msgid "B<--domain> guest"
283 msgstr ""
284
285 #. type: textblock
286 #: ../align/virt-alignment-scan.pod:120 ../cat/virt-cat.pod:95 ../cat/virt-filesystems.pod:145 ../cat/virt-ls.pod:311 ../clone/virt-sysprep.pod:73 ../df/virt-df.pod:98 ../edit/virt-edit.pod:109 ../inspector/virt-inspector.pod:89 ../rescue/virt-rescue.pod:149
287 msgid ""
288 "Add all the disks from the named libvirt guest.  Domain UUIDs can be used "
289 "instead of names."
290 msgstr ""
291
292 #. type: =item
293 #: ../align/virt-alignment-scan.pod:123 ../cat/virt-cat.pod:105 ../cat/virt-filesystems.pod:170 ../cat/virt-ls.pod:328 ../clone/virt-sysprep.pod:95 ../df/virt-df.pod:101 ../fish/guestfish.pod:233 ../fuse/guestmount.pod:142 ../inspector/virt-inspector.pod:99 ../rescue/virt-rescue.pod:152
294 msgid "B<--format=raw|qcow2|..>"
295 msgstr ""
296
297 #. type: =item
298 #: ../align/virt-alignment-scan.pod:125 ../cat/virt-cat.pod:107 ../cat/virt-filesystems.pod:172 ../cat/virt-ls.pod:330 ../clone/virt-sysprep.pod:97 ../df/virt-df.pod:103 ../edit/virt-edit.pod:134 ../fish/guestfish.pod:235 ../fuse/guestmount.pod:144 ../inspector/virt-inspector.pod:101 ../rescue/virt-rescue.pod:154
299 msgid "B<--format>"
300 msgstr ""
301
302 #. type: textblock
303 #: ../align/virt-alignment-scan.pod:127 ../cat/virt-cat.pod:109 ../cat/virt-filesystems.pod:174 ../cat/virt-ls.pod:332 ../clone/virt-sysprep.pod:99 ../df/virt-df.pod:105 ../edit/virt-edit.pod:136 ../fish/guestfish.pod:237 ../fuse/guestmount.pod:146 ../rescue/virt-rescue.pod:156
304 msgid ""
305 "The default for the I<-a> option is to auto-detect the format of the disk "
306 "image.  Using this forces the disk format for I<-a> options which follow on "
307 "the command line.  Using I<--format> with no argument switches back to "
308 "auto-detection for subsequent I<-a> options."
309 msgstr ""
310
311 #. type: textblock
312 #: ../align/virt-alignment-scan.pod:132 ../cat/virt-cat.pod:114 ../cat/virt-filesystems.pod:179 ../cat/virt-ls.pod:337 ../clone/virt-sysprep.pod:104 ../df/virt-df.pod:110 ../edit/virt-edit.pod:141 ../fish/guestfish.pod:242 ../fish/guestfish.pod:673 ../inspector/virt-inspector.pod:351 ../rescue/virt-rescue.pod:161 ../src/guestfs.pod:2877
313 msgid "For example:"
314 msgstr ""
315
316 #. type: verbatim
317 #: ../align/virt-alignment-scan.pod:134
318 #, no-wrap
319 msgid ""
320 " virt-alignment-scan --format=raw -a disk.img\n"
321 "\n"
322 msgstr ""
323
324 #. type: textblock
325 #: ../align/virt-alignment-scan.pod:136 ../cat/virt-cat.pod:118 ../cat/virt-filesystems.pod:183 ../cat/virt-ls.pod:341 ../clone/virt-sysprep.pod:108 ../df/virt-df.pod:114 ../edit/virt-edit.pod:145 ../fish/guestfish.pod:246 ../rescue/virt-rescue.pod:165
326 msgid "forces raw format (no auto-detection) for C<disk.img>."
327 msgstr ""
328
329 #. type: verbatim
330 #: ../align/virt-alignment-scan.pod:138
331 #, no-wrap
332 msgid ""
333 " virt-alignment-scan --format=raw -a disk.img --format -a another.img\n"
334 "\n"
335 msgstr ""
336
337 #. type: textblock
338 #: ../align/virt-alignment-scan.pod:140 ../cat/virt-cat.pod:122 ../cat/virt-filesystems.pod:187 ../cat/virt-ls.pod:345 ../clone/virt-sysprep.pod:112 ../df/virt-df.pod:118 ../edit/virt-edit.pod:149 ../fish/guestfish.pod:250 ../rescue/virt-rescue.pod:169
339 msgid ""
340 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
341 "auto-detection for C<another.img>."
342 msgstr ""
343
344 #. type: textblock
345 #: ../align/virt-alignment-scan.pod:143 ../cat/virt-cat.pod:125 ../cat/virt-filesystems.pod:190 ../cat/virt-ls.pod:348 ../clone/virt-sysprep.pod:115 ../df/virt-df.pod:121 ../edit/virt-edit.pod:152 ../rescue/virt-rescue.pod:172
346 msgid ""
347 "If you have untrusted raw-format guest disk images, you should use this "
348 "option to specify the disk format.  This avoids a possible security problem "
349 "with malicious guests (CVE-2010-3851)."
350 msgstr ""
351
352 #. type: =item
353 #: ../align/virt-alignment-scan.pod:147 ../resize/virt-resize.pod:491 ../sparsify/virt-sparsify.pod:153
354 msgid "B<-q>"
355 msgstr ""
356
357 #. type: =item
358 #: ../align/virt-alignment-scan.pod:149 ../resize/virt-resize.pod:493 ../sparsify/virt-sparsify.pod:155
359 msgid "B<--quiet>"
360 msgstr ""
361
362 #. type: textblock
363 #: ../align/virt-alignment-scan.pod:151
364 msgid ""
365 "Don't produce any output.  Just set the exit code (see L</EXIT STATUS> "
366 "below)."
367 msgstr ""
368
369 #. type: =item
370 #: ../align/virt-alignment-scan.pod:154 ../cat/virt-cat.pod:134 ../cat/virt-filesystems.pod:261 ../cat/virt-ls.pod:425 ../clone/virt-sysprep.pod:138 ../df/virt-df.pod:173 ../edit/virt-edit.pod:161 ../fish/guestfish.pod:390 ../fuse/guestmount.pod:266 ../inspector/virt-inspector.pod:119 ../rescue/virt-rescue.pod:219 ../sparsify/virt-sparsify.pod:159
371 msgid "B<-v>"
372 msgstr ""
373
374 #. type: =item
375 #: ../align/virt-alignment-scan.pod:156 ../cat/virt-cat.pod:136 ../cat/virt-filesystems.pod:263 ../cat/virt-ls.pod:427 ../clone/virt-sysprep.pod:140 ../df/virt-df.pod:175 ../edit/virt-edit.pod:163 ../fish/guestfish.pod:392 ../fuse/guestmount.pod:268 ../inspector/virt-inspector.pod:121 ../rescue/virt-rescue.pod:221 ../sparsify/virt-sparsify.pod:161
376 msgid "B<--verbose>"
377 msgstr ""
378
379 #. type: textblock
380 #: ../align/virt-alignment-scan.pod:158 ../cat/virt-cat.pod:138 ../cat/virt-filesystems.pod:265 ../cat/virt-ls.pod:429 ../clone/virt-sysprep.pod:142 ../df/virt-df.pod:177 ../edit/virt-edit.pod:165 ../inspector/virt-inspector.pod:123 ../rescue/virt-rescue.pod:223 ../sparsify/virt-sparsify.pod:163
381 msgid "Enable verbose messages for debugging."
382 msgstr ""
383
384 #. type: =item
385 #: ../align/virt-alignment-scan.pod:160 ../cat/virt-cat.pod:140 ../cat/virt-filesystems.pod:267 ../cat/virt-ls.pod:431 ../clone/virt-sysprep.pod:144 ../df/virt-df.pod:179 ../edit/virt-edit.pod:167 ../fish/guestfish.pod:397 ../fuse/guestmount.pod:272 ../inspector/virt-inspector.pod:125 ../rescue/virt-rescue.pod:225 ../resize/virt-resize.pod:561 ../sparsify/virt-sparsify.pod:165
386 msgid "B<-V>"
387 msgstr ""
388
389 #. type: =item
390 #: ../align/virt-alignment-scan.pod:162 ../cat/virt-cat.pod:142 ../cat/virt-filesystems.pod:269 ../cat/virt-ls.pod:433 ../clone/virt-sysprep.pod:146 ../df/virt-df.pod:181 ../edit/virt-edit.pod:169 ../fish/guestfish.pod:399 ../fuse/guestmount.pod:274 ../inspector/virt-inspector.pod:127 ../rescue/virt-rescue.pod:227 ../resize/virt-resize.pod:563 ../sparsify/virt-sparsify.pod:167 ../tools/virt-list-filesystems.pl:69 ../tools/virt-list-partitions.pl:70 ../tools/virt-make-fs.pl:169 ../tools/virt-tar.pl:119 ../tools/virt-win-reg.pl:112
391 msgid "B<--version>"
392 msgstr ""
393
394 #. type: textblock
395 #: ../align/virt-alignment-scan.pod:164 ../cat/virt-cat.pod:144 ../cat/virt-filesystems.pod:271 ../cat/virt-ls.pod:435 ../clone/virt-sysprep.pod:148 ../df/virt-df.pod:183 ../edit/virt-edit.pod:171 ../inspector/virt-inspector.pod:129 ../rescue/virt-rescue.pod:229 ../resize/virt-resize.pod:565 ../sparsify/virt-sparsify.pod:169 ../tools/virt-list-filesystems.pl:71 ../tools/virt-list-partitions.pl:72 ../tools/virt-make-fs.pl:171 ../tools/virt-tar.pl:121 ../tools/virt-win-reg.pl:114
396 msgid "Display version number and exit."
397 msgstr ""
398
399 #. type: =item
400 #: ../align/virt-alignment-scan.pod:166 ../cat/virt-cat.pod:146 ../cat/virt-filesystems.pod:281 ../cat/virt-ls.pod:437 ../clone/virt-sysprep.pod:150 ../df/virt-df.pod:185 ../edit/virt-edit.pod:173 ../fish/guestfish.pod:412 ../fuse/guestmount.pod:287 ../inspector/virt-inspector.pod:131 ../rescue/virt-rescue.pod:240 ../sparsify/virt-sparsify.pod:171 ../tools/virt-tar.pl:158
401 msgid "B<-x>"
402 msgstr ""
403
404 #. type: textblock
405 #: ../align/virt-alignment-scan.pod:168 ../cat/virt-cat.pod:148 ../cat/virt-filesystems.pod:283 ../cat/virt-ls.pod:439 ../clone/virt-sysprep.pod:152 ../df/virt-df.pod:187 ../edit/virt-edit.pod:175 ../inspector/virt-inspector.pod:133 ../rescue/virt-rescue.pod:242 ../sparsify/virt-sparsify.pod:173
406 msgid "Enable tracing of libguestfs API calls."
407 msgstr ""
408
409 #. type: =head1
410 #: ../align/virt-alignment-scan.pod:172
411 msgid "RECOMMENDED ALIGNMENT"
412 msgstr ""
413
414 #. type: textblock
415 #: ../align/virt-alignment-scan.pod:174
416 msgid ""
417 "Operating systems older than Windows 2008 and Linux before ca.2010 place the "
418 "first sector of the first partition at sector 63, with a 512 byte sector "
419 "size.  This happens because of a historical accident.  Drives have to report "
420 "a cylinder / head / sector (CHS) geometry to the BIOS.  The geometry is "
421 "completely meaningless on modern drives, but it happens that the geometry "
422 "reported always has 63 sectors per track.  The operating system therefore "
423 "places the first partition at the start of the second \"track\", at sector "
424 "63."
425 msgstr ""
426
427 #. type: textblock
428 #: ../align/virt-alignment-scan.pod:183
429 msgid ""
430 "When the guest OS is virtualized, the host operating system and hypervisor "
431 "may prefer accesses aligned to one of:"
432 msgstr ""
433
434 #. type: =item
435 #: ../align/virt-alignment-scan.pod:188
436 msgid "* 512 bytes"
437 msgstr ""
438
439 #. type: textblock
440 #: ../align/virt-alignment-scan.pod:190
441 msgid ""
442 "if the host OS uses local storage directly on hard drive partitions, and the "
443 "hard drive has 512 byte physical sectors."
444 msgstr ""
445
446 #. type: =item
447 #: ../align/virt-alignment-scan.pod:193
448 msgid "* 4 Kbytes"
449 msgstr ""
450
451 #. type: textblock
452 #: ../align/virt-alignment-scan.pod:195
453 msgid ""
454 "for local storage on new hard drives with 4Kbyte physical sectors; for "
455 "file-backed storage on filesystems with 4Kbyte block size; or for some types "
456 "of network-attached storage."
457 msgstr ""
458
459 #. type: =item
460 #: ../align/virt-alignment-scan.pod:199
461 msgid "* 64 Kbytes"
462 msgstr ""
463
464 #. type: textblock
465 #: ../align/virt-alignment-scan.pod:201
466 msgid ""
467 "for high-end network-attached storage.  This is the optimal block size for "
468 "some NetApp hardware."
469 msgstr ""
470
471 #. type: =item
472 #: ../align/virt-alignment-scan.pod:204
473 msgid "* 1 Mbyte"
474 msgstr ""
475
476 #. type: textblock
477 #: ../align/virt-alignment-scan.pod:206
478 msgid "see L</1 MB PARTITION ALIGNMENT> below."
479 msgstr ""
480
481 #. type: textblock
482 #: ../align/virt-alignment-scan.pod:210
483 msgid ""
484 "Partitions which are not aligned correctly to the underlying storage cause "
485 "extra I/O.  For example:"
486 msgstr ""
487
488 #. type: verbatim
489 #: ../align/virt-alignment-scan.pod:213
490 #, no-wrap
491 msgid ""
492 "                       sect#63\n"
493 "                       +--------------------------+------\n"
494 "                       |         guest            |\n"
495 "                       |    filesystem block      |\n"
496 " ---+------------------+------+-------------------+-----+---\n"
497 "    |  host block             |  host block             |\n"
498 "    |                         |                         |\n"
499 " ---+-------------------------+-------------------------+---\n"
500 "\n"
501 msgstr ""
502
503 #. type: textblock
504 #: ../align/virt-alignment-scan.pod:222
505 msgid ""
506 "In this example, each time a 4K guest block is read, two blocks on the host "
507 "must be accessed (so twice as much I/O is done).  When a 4K guest block is "
508 "written, two host blocks must first be read, the old and new data combined, "
509 "and the two blocks written back (4x I/O)."
510 msgstr ""
511
512 #. type: =head2
513 #: ../align/virt-alignment-scan.pod:227
514 msgid "LINUX HOST BLOCK AND I/O SIZE"
515 msgstr ""
516
517 #. type: textblock
518 #: ../align/virt-alignment-scan.pod:229
519 msgid ""
520 "New versions of the Linux kernel expose the physical and logical block size, "
521 "and minimum and recommended I/O size."
522 msgstr ""
523
524 #. type: textblock
525 #: ../align/virt-alignment-scan.pod:232
526 msgid "For a typical consumer hard drive with 512 byte sectors:"
527 msgstr ""
528
529 #. type: verbatim
530 #: ../align/virt-alignment-scan.pod:234
531 #, no-wrap
532 msgid ""
533 " $ cat /sys/block/sda/queue/hw_sector_size\n"
534 " 512\n"
535 " $ cat /sys/block/sda/queue/physical_block_size\n"
536 " 512\n"
537 " $ cat /sys/block/sda/queue/logical_block_size\n"
538 " 512\n"
539 " $ cat /sys/block/sda/queue/minimum_io_size\n"
540 " 512\n"
541 " $ cat /sys/block/sda/queue/optimal_io_size\n"
542 " 0\n"
543 "\n"
544 msgstr ""
545
546 #. type: textblock
547 #: ../align/virt-alignment-scan.pod:245
548 msgid "For a new consumer hard drive with 4Kbyte sectors:"
549 msgstr ""
550
551 #. type: verbatim
552 #: ../align/virt-alignment-scan.pod:247
553 #, no-wrap
554 msgid ""
555 " $ cat /sys/block/sda/queue/hw_sector_size\n"
556 " 4096\n"
557 " $ cat /sys/block/sda/queue/physical_block_size\n"
558 " 4096\n"
559 " $ cat /sys/block/sda/queue/logical_block_size\n"
560 " 4096\n"
561 " $ cat /sys/block/sda/queue/minimum_io_size\n"
562 " 4096\n"
563 " $ cat /sys/block/sda/queue/optimal_io_size\n"
564 " 0\n"
565 "\n"
566 msgstr ""
567
568 #. type: textblock
569 #: ../align/virt-alignment-scan.pod:258
570 msgid "For a NetApp LUN:"
571 msgstr ""
572
573 #. type: verbatim
574 #: ../align/virt-alignment-scan.pod:260
575 #, no-wrap
576 msgid ""
577 " $ cat /sys/block/sdc/queue/logical_block_size\n"
578 " 512\n"
579 " $ cat /sys/block/sdc/queue/physical_block_size\n"
580 " 512\n"
581 " $ cat /sys/block/sdc/queue/minimum_io_size\n"
582 " 4096\n"
583 " $ cat /sys/block/sdc/queue/optimal_io_size\n"
584 " 65536\n"
585 "\n"
586 msgstr ""
587
588 #. type: textblock
589 #: ../align/virt-alignment-scan.pod:269
590 msgid ""
591 "The NetApp allows 512 byte accesses (but they will be very inefficient), "
592 "prefers a minimum 4K I/O size, but the optimal I/O size is 64K."
593 msgstr ""
594
595 #. type: textblock
596 #: ../align/virt-alignment-scan.pod:273
597 msgid ""
598 "For detailed information about what these numbers mean, see "
599 "L<http://docs.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/6/html/Storage_Administration_Guide/newstorage-iolimits.html>"
600 msgstr ""
601
602 #. type: textblock
603 #: ../align/virt-alignment-scan.pod:276
604 msgid ""
605 "[Thanks to Matt Booth for providing 4K drive data.  Thanks to Mike Snitzer "
606 "for providing NetApp data and additional information.]"
607 msgstr ""
608
609 #. type: =head2
610 #: ../align/virt-alignment-scan.pod:279
611 msgid "1 MB PARTITION ALIGNMENT"
612 msgstr ""
613
614 #. type: textblock
615 #: ../align/virt-alignment-scan.pod:281
616 msgid ""
617 "Microsoft picked 1 MB as the default alignment for all partitions starting "
618 "with Windows 2008 Server, and Linux has followed this."
619 msgstr ""
620
621 #. type: textblock
622 #: ../align/virt-alignment-scan.pod:284
623 msgid ""
624 "Assuming 512 byte sectors in the guest, you will now see the first partition "
625 "starting at sector 2048, and subsequent partitions (if any)  will start at a "
626 "multiple of 2048 sectors."
627 msgstr ""
628
629 #. type: textblock
630 #: ../align/virt-alignment-scan.pod:288
631 msgid ""
632 "1 MB alignment is compatible with all current alignment requirements (4K, "
633 "64K) and provides room for future growth in physical block sizes."
634 msgstr ""
635
636 #. type: =head2
637 #: ../align/virt-alignment-scan.pod:291
638 msgid "SETTING ALIGNMENT"
639 msgstr ""
640
641 #. type: textblock
642 #: ../align/virt-alignment-scan.pod:293
643 msgid ""
644 "L<virt-resize(1)> can change the alignment of the partitions of some "
645 "guests.  Currently it can fully align all the partitions of all Windows "
646 "guests, and it will fix the bootloader where necessary.  For Linux guests, "
647 "it can align the second and subsequent partitions, so the majority of OS "
648 "accesses except at boot will be aligned."
649 msgstr ""
650
651 #. type: textblock
652 #: ../align/virt-alignment-scan.pod:299
653 msgid ""
654 "Another way to correct partition alignment problems is to reinstall your "
655 "guest operating systems.  If you install operating systems from templates, "
656 "ensure these have correct partition alignment too."
657 msgstr ""
658
659 #. type: textblock
660 #: ../align/virt-alignment-scan.pod:303
661 msgid ""
662 "For older versions of Windows, the following NetApp document contains useful "
663 "information: L<http://media.netapp.com/documents/tr-3747.pdf>"
664 msgstr ""
665
666 #. type: textblock
667 #: ../align/virt-alignment-scan.pod:306
668 msgid ""
669 "For Red Hat Enterprise Linux E<le> 5, use a Kickstart script that contains "
670 "an explicit C<%pre> section that creates aligned partitions using "
671 "L<parted(8)>.  Do not use the Kickstart C<part> command.  The NetApp "
672 "document above contains an example."
673 msgstr ""
674
675 #. type: =head1
676 #: ../align/virt-alignment-scan.pod:311 ../cat/virt-cat.pod:231 ../cat/virt-filesystems.pod:373 ../cat/virt-ls.pod:483 ../clone/virt-sysprep.pod:475 ../df/virt-df.pod:215 ../edit/virt-edit.pod:342 ../inspector/virt-inspector.pod:367 ../rescue/virt-rescue.pod:303 ../resize/virt-resize.pod:676 ../tools/virt-list-filesystems.pl:188 ../tools/virt-list-partitions.pl:258 ../tools/virt-make-fs.pl:550 ../tools/virt-tar.pl:289 ../tools/virt-win-reg.pl:744
677 msgid "SHELL QUOTING"
678 msgstr ""
679
680 #. type: textblock
681 #: ../align/virt-alignment-scan.pod:313 ../cat/virt-cat.pod:233 ../cat/virt-filesystems.pod:375 ../cat/virt-ls.pod:485 ../clone/virt-sysprep.pod:477 ../df/virt-df.pod:217 ../edit/virt-edit.pod:344 ../inspector/virt-inspector.pod:369 ../rescue/virt-rescue.pod:305 ../resize/virt-resize.pod:678 ../tools/virt-list-filesystems.pl:190 ../tools/virt-list-partitions.pl:260 ../tools/virt-make-fs.pl:552 ../tools/virt-tar.pl:291 ../tools/virt-win-reg.pl:752
682 msgid ""
683 "Libvirt guest names can contain arbitrary characters, some of which have "
684 "meaning to the shell such as C<#> and space.  You may need to quote or "
685 "escape these characters on the command line.  See the shell manual page "
686 "L<sh(1)> for details."
687 msgstr ""
688
689 #. type: =head1
690 #: ../align/virt-alignment-scan.pod:318 ../cat/virt-cat.pod:238 ../cat/virt-filesystems.pod:380 ../cat/virt-ls.pod:490 ../clone/virt-sysprep.pod:482 ../df/virt-df.pod:222 ../edit/virt-edit.pod:349 ../fish/guestfish.pod:1114 ../fuse/guestmount.pod:312 ../inspector/virt-inspector.pod:390 ../resize/virt-resize.pod:683 ../sparsify/virt-sparsify.pod:227 ../test-tool/libguestfs-test-tool.pod:90
691 msgid "EXIT STATUS"
692 msgstr ""
693
694 #. type: textblock
695 #: ../align/virt-alignment-scan.pod:320
696 msgid "This program returns:"
697 msgstr ""
698
699 #. type: =item
700 #: ../align/virt-alignment-scan.pod:324 ../align/virt-alignment-scan.pod:330 ../align/virt-alignment-scan.pod:336 ../align/virt-alignment-scan.pod:343 ../cat/virt-cat.pod:177 ../cat/virt-cat.pod:182 ../cat/virt-cat.pod:187 ../cat/virt-cat.pod:198 ../cat/virt-cat.pod:202 ../clone/virt-sysprep.pod:283 ../clone/virt-sysprep.pod:287 ../clone/virt-sysprep.pod:291 ../clone/virt-sysprep.pod:295 ../clone/virt-sysprep.pod:310 ../clone/virt-sysprep.pod:314 ../clone/virt-sysprep.pod:318 ../clone/virt-sysprep.pod:322 ../clone/virt-sysprep.pod:326 ../clone/virt-sysprep.pod:362 ../clone/virt-sysprep.pod:384 ../clone/virt-sysprep.pod:388 ../df/virt-df.pod:148 ../df/virt-df.pod:154 ../edit/virt-edit.pod:266 ../edit/virt-edit.pod:271 ../edit/virt-edit.pod:276 ../edit/virt-edit.pod:287 ../edit/virt-edit.pod:291 ../examples/guestfs-recipes.pod:98 ../examples/guestfs-recipes.pod:102 ../examples/guestfs-recipes.pod:106 ../examples/guestfs-recipes.pod:132 ../examples/guestfs-recipes.pod:137 ../examples/guestfs-recipes.pod:227 ../examples/guestfs-recipes.pod:231 ../examples/guestfs-recipes.pod:235 ../examples/guestfs-recipes.pod:239 ../examples/guestfs-recipes.pod:243 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:441 ../fish/guestfish-actions.pod:449 ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:463 ../fish/guestfish-actions.pod:1262 ../fish/guestfish-actions.pod:1266 ../fish/guestfish-actions.pod:1270 ../fish/guestfish-actions.pod:1274 ../fish/guestfish-actions.pod:1282 ../fish/guestfish-actions.pod:1286 ../fish/guestfish-actions.pod:1290 ../fish/guestfish-actions.pod:1300 ../fish/guestfish-actions.pod:1304 ../fish/guestfish-actions.pod:1308 ../fish/guestfish-actions.pod:1398 ../fish/guestfish-actions.pod:1402 ../fish/guestfish-actions.pod:1407 ../fish/guestfish-actions.pod:1412 ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:1458 ../fish/guestfish-actions.pod:1463 ../fish/guestfish-actions.pod:1719 ../fish/guestfish-actions.pod:1726 ../fish/guestfish-actions.pod:1733 ../fish/guestfish-actions.pod:2136 ../fish/guestfish-actions.pod:2142 ../fish/guestfish-actions.pod:2150 ../fish/guestfish-actions.pod:2157 ../fish/guestfish-actions.pod:2164 ../fish/guestfish.pod:445 ../fish/guestfish.pod:449 ../fish/guestfish.pod:453 ../fish/guestfish.pod:457 ../inspector/virt-inspector.pod:408 ../inspector/virt-inspector.pod:412 ../resize/virt-resize.pod:359 ../resize/virt-resize.pod:363 ../resize/virt-resize.pod:372 ../resize/virt-resize.pod:378 ../sparsify/virt-sparsify.pod:32 ../sparsify/virt-sparsify.pod:39 ../sparsify/virt-sparsify.pod:43 ../sparsify/virt-sparsify.pod:49 ../sparsify/virt-sparsify.pod:54 ../sparsify/virt-sparsify.pod:58 ../sparsify/virt-sparsify.pod:64 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:29 ../src/guestfs-actions.pod:641 ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:656 ../src/guestfs-actions.pod:663 ../src/guestfs-actions.pod:2079 ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:2087 ../src/guestfs-actions.pod:2091 ../src/guestfs-actions.pod:2099 ../src/guestfs-actions.pod:2103 ../src/guestfs-actions.pod:2107 ../src/guestfs-actions.pod:2117 ../src/guestfs-actions.pod:2121 ../src/guestfs-actions.pod:2125 ../src/guestfs-actions.pod:2263 ../src/guestfs-actions.pod:2267 ../src/guestfs-actions.pod:2272 ../src/guestfs-actions.pod:2277 ../src/guestfs-actions.pod:2338 ../src/guestfs-actions.pod:2342 ../src/guestfs-actions.pod:2347 ../src/guestfs-actions.pod:2762 ../src/guestfs-actions.pod:2769 ../src/guestfs-actions.pod:2776 ../src/guestfs-actions.pod:3321 ../src/guestfs-actions.pod:3327 ../src/guestfs-actions.pod:3335 ../src/guestfs-actions.pod:3342 ../src/guestfs-actions.pod:3349 ../src/guestfs.pod:403 ../src/guestfs.pod:408 ../src/guestfs.pod:413 ../src/guestfs.pod:417 ../src/guestfs.pod:422 ../src/guestfs.pod:426 ../src/guestfs.pod:431 ../src/guestfs.pod:436 ../src/guestfs.pod:1109 ../src/guestfs.pod:1113 ../src/guestfs.pod:1117 ../src/guestfs.pod:1122 ../src/guestfs.pod:1130 ../src/guestfs.pod:1149 ../src/guestfs.pod:1157 ../src/guestfs.pod:1179 ../src/guestfs.pod:1183 ../src/guestfs.pod:1187 ../src/guestfs.pod:1191 ../src/guestfs.pod:1195 ../src/guestfs.pod:1199 ../src/guestfs.pod:1689 ../src/guestfs.pod:1694 ../src/guestfs.pod:1698 ../src/guestfs.pod:1800 ../src/guestfs.pod:1805 ../src/guestfs.pod:1809 ../src/guestfs.pod:1819 ../src/guestfs.pod:2108 ../src/guestfs.pod:2113 ../src/guestfs.pod:2119 ../src/guestfs.pod:2127 ../src/guestfs.pod:2645 ../src/guestfs.pod:2651 ../src/guestfs.pod:2656 ../src/guestfs.pod:2662 ../src/guestfs.pod:3062 ../src/guestfs.pod:3067 ../src/guestfs.pod:3071 ../src/guestfs.pod:3075 ../src/guestfs.pod:3079 ../src/guestfs.pod:3093 ../src/guestfs.pod:3098 ../src/guestfs.pod:3329 ../src/guestfs.pod:3333 ../src/guestfs.pod:3337 ../src/guestfs.pod:3341 ../tools/virt-win-reg.pl:197 ../tools/virt-win-reg.pl:202 ../tools/virt-win-reg.pl:208 ../tools/virt-win-reg.pl:721 ../tools/virt-win-reg.pl:727 ../tools/virt-win-reg.pl:733
701 msgid "*"
702 msgstr ""
703
704 #. type: textblock
705 #: ../align/virt-alignment-scan.pod:326
706 msgid "0"
707 msgstr ""
708
709 #. type: textblock
710 #: ../align/virt-alignment-scan.pod:328
711 msgid "successful exit, all partitions are aligned E<ge> 64K for best performance"
712 msgstr ""
713
714 #. type: textblock
715 #: ../align/virt-alignment-scan.pod:332
716 msgid "1"
717 msgstr ""
718
719 #. type: textblock
720 #: ../align/virt-alignment-scan.pod:334
721 msgid "an error scanning the disk image or guest"
722 msgstr ""
723
724 #. type: textblock
725 #: ../align/virt-alignment-scan.pod:338
726 msgid "2"
727 msgstr ""
728
729 #. type: textblock
730 #: ../align/virt-alignment-scan.pod:340
731 msgid ""
732 "successful exit, some partitions have alignment E<lt> 64K which can result "
733 "in poor performance on high end network storage"
734 msgstr ""
735
736 #. type: textblock
737 #: ../align/virt-alignment-scan.pod:345
738 msgid "3"
739 msgstr ""
740
741 #. type: textblock
742 #: ../align/virt-alignment-scan.pod:347
743 msgid ""
744 "successful exit, some partitions have alignment E<lt> 4K which can result in "
745 "poor performance on most hypervisors"
746 msgstr ""
747
748 #. type: =head1
749 #: ../align/virt-alignment-scan.pod:352 ../cat/virt-cat.pod:243 ../cat/virt-filesystems.pod:385 ../cat/virt-ls.pod:495 ../clone/virt-sysprep.pod:486 ../df/virt-df.pod:227 ../edit/virt-edit.pod:354 ../erlang/examples/guestfs-erlang.pod:97 ../examples/guestfs-examples.pod:33 ../examples/guestfs-recipes.pod:384 ../fish/guestfish.pod:1268 ../fish/virt-copy-in.pod:50 ../fish/virt-copy-out.pod:39 ../fish/virt-tar-in.pod:47 ../fish/virt-tar-out.pod:41 ../fuse/guestmount.pod:317 ../inspector/virt-inspector.pod:395 ../java/examples/guestfs-java.pod:45 ../ocaml/examples/guestfs-ocaml.pod:78 ../perl/examples/guestfs-perl.pod:39 ../python/examples/guestfs-python.pod:42 ../rescue/virt-rescue.pod:325 ../resize/virt-resize.pod:688 ../ruby/examples/guestfs-ruby.pod:36 ../sparsify/virt-sparsify.pod:251 ../src/guestfs.pod:3270 ../test-tool/libguestfs-test-tool.pod:100 ../tools/virt-list-filesystems.pl:195 ../tools/virt-list-partitions.pl:265 ../tools/virt-make-fs.pl:557 ../tools/virt-tar.pl:296 ../tools/virt-win-reg.pl:757
750 msgid "SEE ALSO"
751 msgstr ""
752
753 #. type: textblock
754 #: ../align/virt-alignment-scan.pod:354
755 msgid ""
756 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-rescue(1)>, "
757 "L<virt-resize(1)>, L<http://libguestfs.org/>."
758 msgstr ""
759
760 #. type: =head1
761 #: ../align/virt-alignment-scan.pod:361 ../cat/virt-cat.pod:252 ../cat/virt-filesystems.pod:396 ../cat/virt-ls.pod:507 ../clone/virt-sysprep.pod:501 ../df/virt-df.pod:235 ../edit/virt-edit.pod:368 ../rescue/virt-rescue.pod:334 ../resize/virt-resize.pod:711 ../sparsify/virt-sparsify.pod:264 ../tools/virt-list-filesystems.pl:208 ../tools/virt-list-partitions.pl:277 ../tools/virt-make-fs.pl:582 ../tools/virt-tar.pl:311 ../tools/virt-win-reg.pl:783
762 msgid "AUTHOR"
763 msgstr ""
764
765 #. type: textblock
766 #: ../align/virt-alignment-scan.pod:363 ../cat/virt-cat.pod:254 ../cat/virt-filesystems.pod:398 ../cat/virt-ls.pod:509 ../clone/virt-sysprep.pod:503 ../df/virt-df.pod:237 ../edit/virt-edit.pod:370 ../inspector/virt-inspector.pod:410 ../rescue/virt-rescue.pod:336 ../resize/virt-resize.pod:713 ../sparsify/virt-sparsify.pod:266 ../tools/virt-list-filesystems.pl:210 ../tools/virt-list-partitions.pl:279 ../tools/virt-make-fs.pl:584 ../tools/virt-tar.pl:313 ../tools/virt-win-reg.pl:785
767 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
768 msgstr ""
769
770 #. type: =head1
771 #: ../align/virt-alignment-scan.pod:365 ../cat/virt-cat.pod:256 ../cat/virt-filesystems.pod:400 ../cat/virt-ls.pod:511 ../clone/virt-sysprep.pod:505 ../df/virt-df.pod:239 ../edit/virt-edit.pod:372 ../erlang/examples/guestfs-erlang.pod:114 ../examples/guestfs-examples.pod:49 ../examples/guestfs-recipes.pod:401 ../fish/guestfish.pod:1300 ../fish/virt-copy-in.pod:64 ../fish/virt-copy-out.pod:53 ../fish/virt-tar-in.pod:62 ../fish/virt-tar-out.pod:55 ../fuse/guestmount.pod:332 ../inspector/virt-inspector.pod:418 ../java/examples/guestfs-java.pod:62 ../ocaml/examples/guestfs-ocaml.pod:95 ../perl/examples/guestfs-perl.pod:56 ../python/examples/guestfs-python.pod:58 ../rescue/virt-rescue.pod:338 ../resize/virt-resize.pod:715 ../ruby/examples/guestfs-ruby.pod:52 ../sparsify/virt-sparsify.pod:268 ../src/guestfs.pod:3352 ../test-tool/libguestfs-test-tool.pod:110 ../tools/virt-list-filesystems.pl:212 ../tools/virt-list-partitions.pl:281 ../tools/virt-make-fs.pl:586 ../tools/virt-tar.pl:315 ../tools/virt-win-reg.pl:787
772 msgid "COPYRIGHT"
773 msgstr ""
774
775 #. type: textblock
776 #: ../align/virt-alignment-scan.pod:367 ../clone/virt-sysprep.pod:507 ../sparsify/virt-sparsify.pod:270
777 msgid "Copyright (C) 2011 Red Hat Inc."
778 msgstr ""
779
780 #. type: textblock
781 #: ../align/virt-alignment-scan.pod:369 ../cat/virt-cat.pod:260 ../cat/virt-filesystems.pod:404 ../cat/virt-ls.pod:515 ../clone/virt-sysprep.pod:509 ../df/virt-df.pod:243 ../edit/virt-edit.pod:376 ../fish/guestfish.pod:1305 ../fish/virt-copy-in.pod:69 ../fish/virt-copy-out.pod:58 ../fish/virt-tar-in.pod:67 ../fish/virt-tar-out.pod:60 ../fuse/guestmount.pod:337 ../inspector/virt-inspector.pod:422 ../rescue/virt-rescue.pod:342 ../resize/virt-resize.pod:719 ../sparsify/virt-sparsify.pod:272 ../test-tool/libguestfs-test-tool.pod:115 ../tools/virt-list-filesystems.pl:216 ../tools/virt-list-partitions.pl:285 ../tools/virt-make-fs.pl:590 ../tools/virt-tar.pl:319 ../tools/virt-win-reg.pl:791
782 msgid ""
783 "This program is free software; you can redistribute it and/or modify it "
784 "under the terms of the GNU General Public License as published by the Free "
785 "Software Foundation; either version 2 of the License, or (at your option) "
786 "any later version."
787 msgstr ""
788
789 #. type: textblock
790 #: ../align/virt-alignment-scan.pod:374 ../cat/virt-cat.pod:265 ../cat/virt-filesystems.pod:409 ../cat/virt-ls.pod:520 ../clone/virt-sysprep.pod:514 ../df/virt-df.pod:248 ../edit/virt-edit.pod:381 ../fish/guestfish.pod:1310 ../fish/virt-copy-in.pod:74 ../fish/virt-copy-out.pod:63 ../fish/virt-tar-in.pod:72 ../fish/virt-tar-out.pod:65 ../fuse/guestmount.pod:342 ../inspector/virt-inspector.pod:427 ../rescue/virt-rescue.pod:347 ../resize/virt-resize.pod:724 ../sparsify/virt-sparsify.pod:277 ../test-tool/libguestfs-test-tool.pod:120 ../tools/virt-list-filesystems.pl:221 ../tools/virt-list-partitions.pl:290 ../tools/virt-make-fs.pl:595 ../tools/virt-tar.pl:324 ../tools/virt-win-reg.pl:796
791 msgid ""
792 "This program is distributed in the hope that it will be useful, but WITHOUT "
793 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
794 "FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for "
795 "more details."
796 msgstr ""
797
798 #. type: textblock
799 #: ../align/virt-alignment-scan.pod:379 ../cat/virt-cat.pod:270 ../cat/virt-filesystems.pod:414 ../cat/virt-ls.pod:525 ../clone/virt-sysprep.pod:519 ../df/virt-df.pod:253 ../edit/virt-edit.pod:386 ../fish/guestfish.pod:1315 ../fish/virt-copy-in.pod:79 ../fish/virt-copy-out.pod:68 ../fish/virt-tar-in.pod:77 ../fish/virt-tar-out.pod:70 ../fuse/guestmount.pod:347 ../inspector/virt-inspector.pod:432 ../rescue/virt-rescue.pod:352 ../resize/virt-resize.pod:729 ../sparsify/virt-sparsify.pod:282 ../test-tool/libguestfs-test-tool.pod:125 ../tools/virt-list-filesystems.pl:226 ../tools/virt-list-partitions.pl:295 ../tools/virt-make-fs.pl:600 ../tools/virt-tar.pl:329 ../tools/virt-win-reg.pl:801
800 msgid ""
801 "You should have received a copy of the GNU General Public License along with "
802 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
803 "Ave, Cambridge, MA 02139, USA."
804 msgstr ""
805
806 #. type: textblock
807 #: ../cat/virt-cat.pod:5
808 msgid "virt-cat - Display files in a virtual machine"
809 msgstr ""
810
811 #. type: verbatim
812 #: ../cat/virt-cat.pod:9
813 #, no-wrap
814 msgid ""
815 " virt-cat [--options] -d domname file [file ...]\n"
816 "\n"
817 msgstr ""
818
819 #. type: verbatim
820 #: ../cat/virt-cat.pod:11
821 #, no-wrap
822 msgid ""
823 " virt-cat [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
824 "\n"
825 msgstr ""
826
827 #. type: textblock
828 #: ../cat/virt-cat.pod:13 ../edit/virt-edit.pod:15 ../inspector/virt-inspector.pod:13
829 msgid "Old-style:"
830 msgstr ""
831
832 #. type: verbatim
833 #: ../cat/virt-cat.pod:15
834 #, no-wrap
835 msgid ""
836 " virt-cat domname file\n"
837 "\n"
838 msgstr ""
839
840 #. type: verbatim
841 #: ../cat/virt-cat.pod:17
842 #, no-wrap
843 msgid ""
844 " virt-cat disk.img file\n"
845 "\n"
846 msgstr ""
847
848 #. type: textblock
849 #: ../cat/virt-cat.pod:21
850 msgid ""
851 "C<virt-cat> is a command line tool to display the contents of C<file> where "
852 "C<file> exists in the named virtual machine (or disk image)."
853 msgstr ""
854
855 #. type: textblock
856 #: ../cat/virt-cat.pod:24
857 msgid ""
858 "Multiple filenames can be given, in which case they are concatenated "
859 "together.  Each filename must be a full path, starting at the root directory "
860 "(starting with '/')."
861 msgstr ""
862
863 #. type: textblock
864 #: ../cat/virt-cat.pod:28
865 msgid ""
866 "C<virt-cat> can be used to quickly view a file.  To edit a file, use "
867 "C<virt-edit>.  For more complex cases you should look at the L<guestfish(1)> "
868 "tool (see L</USING GUESTFISH> below)."
869 msgstr ""
870
871 #. type: =head1
872 #: ../cat/virt-cat.pod:32 ../cat/virt-ls.pod:35 ../df/virt-df.pod:43 ../edit/virt-edit.pod:44 ../fish/guestfish.pod:41 ../fish/guestfish.pod:1051 ../fish/virt-copy-in.pod:29 ../fish/virt-copy-out.pod:21 ../fish/virt-tar-in.pod:30 ../fish/virt-tar-out.pod:24 ../fuse/guestmount.pod:39 ../resize/virt-resize.pod:27 ../sparsify/virt-sparsify.pod:75 ../tools/virt-tar.pl:50
873 msgid "EXAMPLES"
874 msgstr ""
875
876 #. type: textblock
877 #: ../cat/virt-cat.pod:34
878 msgid "Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
879 msgstr ""
880
881 #. type: verbatim
882 #: ../cat/virt-cat.pod:37
883 #, no-wrap
884 msgid ""
885 " virt-cat -d mydomain /etc/fstab\n"
886 "\n"
887 msgstr ""
888
889 #. type: textblock
890 #: ../cat/virt-cat.pod:39
891 msgid "List syslog messages from a VM disk image file:"
892 msgstr ""
893
894 #. type: verbatim
895 #: ../cat/virt-cat.pod:41
896 #, no-wrap
897 msgid ""
898 " virt-cat -a disk.img /var/log/messages | tail\n"
899 "\n"
900 msgstr ""
901
902 #. type: textblock
903 #: ../cat/virt-cat.pod:43
904 msgid "Find out what DHCP IP address a VM acquired:"
905 msgstr ""
906
907 #. type: verbatim
908 #: ../cat/virt-cat.pod:45
909 #, no-wrap
910 msgid ""
911 " virt-cat -d mydomain /var/log/messages | \\\n"
912 "   grep 'dhclient: bound to' | tail\n"
913 "\n"
914 msgstr ""
915
916 #. type: textblock
917 #: ../cat/virt-cat.pod:48
918 msgid "Find out what packages were recently installed:"
919 msgstr ""
920
921 #. type: verbatim
922 #: ../cat/virt-cat.pod:50
923 #, no-wrap
924 msgid ""
925 " virt-cat -d mydomain /var/log/yum.log | tail\n"
926 "\n"
927 msgstr ""
928
929 #. type: textblock
930 #: ../cat/virt-cat.pod:52
931 msgid "Find out who is logged on inside a virtual machine:"
932 msgstr ""
933
934 #. type: verbatim
935 #: ../cat/virt-cat.pod:54
936 #, no-wrap
937 msgid ""
938 " virt-cat -d mydomain /var/run/utmp > /tmp/utmp\n"
939 " who /tmp/utmp\n"
940 "\n"
941 msgstr ""
942
943 #. type: textblock
944 #: ../cat/virt-cat.pod:57
945 msgid "or who was logged on:"
946 msgstr ""
947
948 #. type: verbatim
949 #: ../cat/virt-cat.pod:59
950 #, no-wrap
951 msgid ""
952 " virt-cat -d mydomain /var/log/wtmp > /tmp/wtmp\n"
953 " last -f /tmp/wtmp\n"
954 "\n"
955 msgstr ""
956
957 #. type: textblock
958 #: ../cat/virt-cat.pod:74 ../cat/virt-filesystems.pod:103 ../cat/virt-ls.pod:273 ../df/virt-df.pod:71 ../edit/virt-edit.pod:74 ../inspector/virt-inspector.pod:67 ../rescue/virt-rescue.pod:124
959 msgid ""
960 "Add I<file> which should be a disk image from a virtual machine.  If the "
961 "virtual machine has multiple block devices, you must supply all of them with "
962 "separate I<-a> options."
963 msgstr ""
964
965 #. type: =item
966 #: ../cat/virt-cat.pod:98 ../cat/virt-filesystems.pod:148 ../cat/virt-ls.pod:314 ../edit/virt-edit.pod:112 ../fish/guestfish.pod:217 ../fuse/guestmount.pod:135 ../inspector/virt-inspector.pod:92
967 msgid "B<--echo-keys>"
968 msgstr ""
969
970 #. type: textblock
971 #: ../cat/virt-cat.pod:100
972 msgid ""
973 "When prompting for keys and passphrases, virt-cat normally turns echoing off "
974 "so you cannot see what you are typing.  If you are not worried about Tempest "
975 "attacks and there is no one else in the room you can specify this flag to "
976 "see what you are typing."
977 msgstr ""
978
979 #. type: verbatim
980 #: ../cat/virt-cat.pod:116
981 #, no-wrap
982 msgid ""
983 " virt-cat --format=raw -a disk.img file\n"
984 "\n"
985 msgstr ""
986
987 #. type: verbatim
988 #: ../cat/virt-cat.pod:120
989 #, no-wrap
990 msgid ""
991 " virt-cat --format=raw -a disk.img --format -a another.img file\n"
992 "\n"
993 msgstr ""
994
995 #. type: =item
996 #: ../cat/virt-cat.pod:129 ../cat/virt-filesystems.pod:200 ../cat/virt-ls.pod:361 ../edit/virt-edit.pod:156 ../fish/guestfish.pod:289 ../fuse/guestmount.pod:172 ../inspector/virt-inspector.pod:114
997 msgid "B<--keys-from-stdin>"
998 msgstr ""
999
1000 #. type: textblock
1001 #: ../cat/virt-cat.pod:131 ../cat/virt-filesystems.pod:202 ../cat/virt-ls.pod:363 ../edit/virt-edit.pod:158 ../fish/guestfish.pod:291 ../fuse/guestmount.pod:174 ../inspector/virt-inspector.pod:116
1002 msgid ""
1003 "Read key or passphrase parameters from stdin.  The default is to try to read "
1004 "passphrases from the user by opening C</dev/tty>."
1005 msgstr ""
1006
1007 #. type: =head1
1008 #: ../cat/virt-cat.pod:152 ../cat/virt-ls.pod:443 ../edit/virt-edit.pod:179 ../inspector/virt-inspector.pod:144 ../rescue/virt-rescue.pod:246
1009 msgid "OLD-STYLE COMMAND LINE ARGUMENTS"
1010 msgstr ""
1011
1012 #. type: textblock
1013 #: ../cat/virt-cat.pod:154
1014 msgid "Previous versions of virt-cat allowed you to write either:"
1015 msgstr ""
1016
1017 #. type: verbatim
1018 #: ../cat/virt-cat.pod:156
1019 #, no-wrap
1020 msgid ""
1021 " virt-cat disk.img [disk.img ...] file\n"
1022 "\n"
1023 msgstr ""
1024
1025 #. type: textblock
1026 #: ../cat/virt-cat.pod:158 ../cat/virt-ls.pod:449 ../edit/virt-edit.pod:185 ../inspector/virt-inspector.pod:150 ../rescue/virt-rescue.pod:252
1027 msgid "or"
1028 msgstr ""
1029
1030 #. type: verbatim
1031 #: ../cat/virt-cat.pod:160
1032 #, no-wrap
1033 msgid ""
1034 " virt-cat guestname file\n"
1035 "\n"
1036 msgstr ""
1037
1038 #. type: textblock
1039 #: ../cat/virt-cat.pod:162 ../cat/virt-ls.pod:453 ../edit/virt-edit.pod:189 ../inspector/virt-inspector.pod:154 ../rescue/virt-rescue.pod:256
1040 msgid ""
1041 "whereas in this version you should use I<-a> or I<-d> respectively to avoid "
1042 "the confusing case where a disk image might have the same name as a guest."
1043 msgstr ""
1044
1045 #. type: textblock
1046 #: ../cat/virt-cat.pod:166 ../cat/virt-ls.pod:457 ../edit/virt-edit.pod:193 ../inspector/virt-inspector.pod:158 ../rescue/virt-rescue.pod:260
1047 msgid "For compatibility the old style is still supported."
1048 msgstr ""
1049
1050 #. type: =head1
1051 #: ../cat/virt-cat.pod:168 ../edit/virt-edit.pod:257 ../fish/guestfish.pod:858
1052 msgid "WINDOWS PATHS"
1053 msgstr ""
1054
1055 #. type: textblock
1056 #: ../cat/virt-cat.pod:170
1057 msgid ""
1058 "C<virt-cat> has a limited ability to understand Windows drive letters and "
1059 "paths (eg. C<E:\\foo\\bar.txt>)."
1060 msgstr ""
1061
1062 #. type: textblock
1063 #: ../cat/virt-cat.pod:173 ../edit/virt-edit.pod:262
1064 msgid "If and only if the guest is running Windows then:"
1065 msgstr ""
1066
1067 #. type: textblock
1068 #: ../cat/virt-cat.pod:179 ../edit/virt-edit.pod:268
1069 msgid ""
1070 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
1071 "to the correct filesystem."
1072 msgstr ""
1073
1074 #. type: textblock
1075 #: ../cat/virt-cat.pod:184 ../edit/virt-edit.pod:273
1076 msgid ""
1077 "Any backslash (C<\\>) characters in the path are replaced with forward "
1078 "slashes so that libguestfs can process it."
1079 msgstr ""
1080
1081 #. type: textblock
1082 #: ../cat/virt-cat.pod:189
1083 msgid ""
1084 "The path is resolved case insensitively to locate the file that should be "
1085 "displayed."
1086 msgstr ""
1087
1088 #. type: textblock
1089 #: ../cat/virt-cat.pod:194 ../edit/virt-edit.pod:283
1090 msgid "There are some known shortcomings:"
1091 msgstr ""
1092
1093 #. type: textblock
1094 #: ../cat/virt-cat.pod:200 ../edit/virt-edit.pod:289
1095 msgid "Some NTFS symbolic links may not be followed correctly."
1096 msgstr ""
1097
1098 #. type: textblock
1099 #: ../cat/virt-cat.pod:204 ../edit/virt-edit.pod:293
1100 msgid "NTFS junction points that cross filesystems are not followed."
1101 msgstr ""
1102
1103 #. type: =head1
1104 #: ../cat/virt-cat.pod:208 ../edit/virt-edit.pod:297
1105 msgid "USING GUESTFISH"
1106 msgstr ""
1107
1108 #. type: textblock
1109 #: ../cat/virt-cat.pod:210
1110 msgid ""
1111 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
1112 "C<virt-cat> doesn't work."
1113 msgstr ""
1114
1115 #. type: textblock
1116 #: ../cat/virt-cat.pod:213
1117 msgid "Using C<virt-cat> is approximately equivalent to doing:"
1118 msgstr ""
1119
1120 #. type: verbatim
1121 #: ../cat/virt-cat.pod:215
1122 #, no-wrap
1123 msgid ""
1124 " guestfish --ro -i -d domname download file -\n"
1125 "\n"
1126 msgstr ""
1127
1128 #. type: textblock
1129 #: ../cat/virt-cat.pod:217
1130 msgid ""
1131 "where C<domname> is the name of the libvirt guest, and C<file> is the full "
1132 "path to the file.  Note the final C<-> (meaning \"output to stdout\")."
1133 msgstr ""
1134
1135 #. type: textblock
1136 #: ../cat/virt-cat.pod:221
1137 msgid ""
1138 "The command above uses libguestfs's guest inspection feature and so does not "
1139 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
1140 "disk images that don't contain guests.  To display a file from a disk image "
1141 "directly, use:"
1142 msgstr ""
1143
1144 #. type: verbatim
1145 #: ../cat/virt-cat.pod:226
1146 #, no-wrap
1147 msgid ""
1148 " guestfish --ro -a disk.img -m /dev/sda1 download file -\n"
1149 "\n"
1150 msgstr ""
1151
1152 #. type: textblock
1153 #: ../cat/virt-cat.pod:228
1154 msgid ""
1155 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
1156 "the disk image, and C<file> is the full path to the file."
1157 msgstr ""
1158
1159 #. type: textblock
1160 #: ../cat/virt-cat.pod:240 ../cat/virt-filesystems.pod:382 ../cat/virt-ls.pod:492 ../df/virt-df.pod:224 ../edit/virt-edit.pod:351 ../fuse/guestmount.pod:314 ../inspector/virt-inspector.pod:392 ../resize/virt-resize.pod:685 ../sparsify/virt-sparsify.pod:229
1161 msgid "This program returns 0 if successful, or non-zero if there was an error."
1162 msgstr ""
1163
1164 #. type: textblock
1165 #: ../cat/virt-cat.pod:245
1166 msgid ""
1167 "L<guestfs(3)>, L<guestfish(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
1168 "L<virt-tar-out(1)>, L<http://libguestfs.org/>."
1169 msgstr ""
1170
1171 #. type: textblock
1172 #: ../cat/virt-cat.pod:258 ../inspector/virt-inspector.pod:420 ../resize/virt-resize.pod:717 ../tools/virt-make-fs.pl:588
1173 msgid "Copyright (C) 2010-2011 Red Hat Inc."
1174 msgstr ""
1175
1176 #. type: textblock
1177 #: ../cat/virt-filesystems.pod:5
1178 msgid ""
1179 "virt-filesystems - List filesystems, partitions, block devices, LVM in a "
1180 "virtual machine or disk image"
1181 msgstr ""
1182
1183 #. type: verbatim
1184 #: ../cat/virt-filesystems.pod:9
1185 #, no-wrap
1186 msgid ""
1187 " virt-filesystems [--options] -d domname\n"
1188 "\n"
1189 msgstr ""
1190
1191 #. type: verbatim
1192 #: ../cat/virt-filesystems.pod:11
1193 #, no-wrap
1194 msgid ""
1195 " virt-filesystems [--options] -a disk.img [-a disk.img ...]\n"
1196 "\n"
1197 msgstr ""
1198
1199 #. type: textblock
1200 #: ../cat/virt-filesystems.pod:15
1201 msgid ""
1202 "This tool allows you to discover filesystems, partitions, logical volumes, "
1203 "and their sizes in a disk image or virtual machine.  It is a replacement for "
1204 "L<virt-list-filesystems(1)> and L<virt-list-partitions(1)>."
1205 msgstr ""
1206
1207 #. type: textblock
1208 #: ../cat/virt-filesystems.pod:20
1209 msgid ""
1210 "One use for this tool is from shell scripts to iterate over all filesystems "
1211 "from a disk image:"
1212 msgstr ""
1213
1214 #. type: verbatim
1215 #: ../cat/virt-filesystems.pod:23
1216 #, no-wrap
1217 msgid ""
1218 " for fs in $(virt-filesystems -a disk.img); do\n"
1219 "   # ...\n"
1220 " done\n"
1221 "\n"
1222 msgstr ""
1223
1224 #. type: textblock
1225 #: ../cat/virt-filesystems.pod:27
1226 msgid ""
1227 "Another use is to list partitions before using another tool to modify those "
1228 "partitions (such as L<virt-resize(1)>).  If you are curious about what an "
1229 "unknown disk image contains, use this tool along with L<virt-inspector(1)>."
1230 msgstr ""
1231
1232 #. type: textblock
1233 #: ../cat/virt-filesystems.pod:32
1234 msgid ""
1235 "Various command line options control what this program displays.  You need "
1236 "to give either I<-a> or I<-d> options to specify the disk image or libvirt "
1237 "guest respectively.  If you just specify that then the program shows "
1238 "filesystems found, one per line, like this:"
1239 msgstr ""
1240
1241 #. type: verbatim
1242 #: ../cat/virt-filesystems.pod:37
1243 #, no-wrap
1244 msgid ""
1245 " $ virt-filesystems -a disk.img\n"
1246 " /dev/sda1\n"
1247 " /dev/vg_guest/lv_root\n"
1248 "\n"
1249 msgstr ""
1250
1251 #. type: textblock
1252 #: ../cat/virt-filesystems.pod:41
1253 msgid "If you add I<-l> or I<--long> then the output includes extra information:"
1254 msgstr ""
1255
1256 #. type: verbatim
1257 #: ../cat/virt-filesystems.pod:44
1258 #, no-wrap
1259 msgid ""
1260 " $ virt-filesystems -a disk.img -l\n"
1261 " Name                   Type         VFS   Label  Size\n"
1262 " /dev/sda1              filesystem   ext4  boot   524288000\n"
1263 " /dev/vg_guest/lv_root  filesystem   ext4  root   10212081664\n"
1264 "\n"
1265 msgstr ""
1266
1267 #. type: textblock
1268 #: ../cat/virt-filesystems.pod:49
1269 msgid ""
1270 "If you add I<--extra> then non-mountable (swap, unknown) filesystems are "
1271 "shown as well:"
1272 msgstr ""
1273
1274 #. type: verbatim
1275 #: ../cat/virt-filesystems.pod:52
1276 #, no-wrap
1277 msgid ""
1278 " $ virt-filesystems -a disk.img --extra\n"
1279 " /dev/sda1\n"
1280 " /dev/vg_guest/lv_root\n"
1281 " /dev/vg_guest/lv_swap\n"
1282 " /dev/vg_guest/lv_data\n"
1283 "\n"
1284 msgstr ""
1285
1286 #. type: textblock
1287 #: ../cat/virt-filesystems.pod:58
1288 msgid "If you add I<--partitions> then partitions are shown instead of filesystems:"
1289 msgstr ""
1290
1291 #. type: verbatim
1292 #: ../cat/virt-filesystems.pod:60
1293 #, no-wrap
1294 msgid ""
1295 " $ virt-filesystems -a disk.img --partitions\n"
1296 " /dev/sda1\n"
1297 " /dev/sda2\n"
1298 "\n"
1299 msgstr ""
1300
1301 #. type: textblock
1302 #: ../cat/virt-filesystems.pod:64
1303 msgid ""
1304 "Similarly you can use I<--logical-volumes>, I<--volume-groups>, "
1305 "I<--physical-volumes>, I<--block-devices> to list those items."
1306 msgstr ""
1307
1308 #. type: textblock
1309 #: ../cat/virt-filesystems.pod:67
1310 msgid ""
1311 "You can use these options in combination as well (if you want a combination "
1312 "including filesystems, you have to add I<--filesystems>).  Notice that some "
1313 "items fall into several categories (eg. C</dev/sda1> might be both a "
1314 "partition and a filesystem).  These items are listed several times.  To get "
1315 "a list which includes absolutely everything that virt-filesystems knows "
1316 "about, use the I<--all> option."
1317 msgstr ""
1318
1319 #. type: textblock
1320 #: ../cat/virt-filesystems.pod:74
1321 msgid ""
1322 "UUIDs (because they are quite long) are not shown by default.  Add the "
1323 "I<--uuid> option to display device and filesystem UUIDs in the long output."
1324 msgstr ""
1325
1326 #. type: textblock
1327 #: ../cat/virt-filesystems.pod:78
1328 msgid ""
1329 "I<--all --long --uuid> is a useful combination to display all possible "
1330 "information about everything."
1331 msgstr ""
1332
1333 #. type: verbatim
1334 #: ../cat/virt-filesystems.pod:81
1335 #, no-wrap
1336 msgid ""
1337 " $ virt-filesystems -a win.img --all --long --uuid -h\n"
1338 " Name      Type       VFS  Label           Size Parent   UUID\n"
1339 " /dev/sda1 filesystem ntfs System Reserved 100M -        F81C92571C92112C\n"
1340 " /dev/sda2 filesystem ntfs -               20G  -        F2E8996AE8992E3B\n"
1341 " /dev/sda1 partition  -    -               100M /dev/sda -\n"
1342 " /dev/sda2 partition  -    -               20G  /dev/sda -\n"
1343 " /dev/sda  device     -    -               20G  -        -\n"
1344 "\n"
1345 msgstr ""
1346
1347 #. type: textblock
1348 #: ../cat/virt-filesystems.pod:89
1349 msgid "For machine-readable output, use I<--csv> to get Comma-Separated Values."
1350 msgstr ""
1351
1352 #. type: =item
1353 #: ../cat/virt-filesystems.pod:110 ../tools/virt-list-filesystems.pl:121
1354 msgid "B<--all>"
1355 msgstr ""
1356
1357 #. type: textblock
1358 #: ../cat/virt-filesystems.pod:112
1359 msgid ""
1360 "Display everything.  This is currently the same as specifying these options: "
1361 "I<--filesystems>, I<--extra>, I<--partitions>, I<--block-devices>, "
1362 "I<--logical-volumes>, I<--volume-groups>, I<--physical-volumes>.  (More may "
1363 "be added to this list in future)."
1364 msgstr ""
1365
1366 #. type: textblock
1367 #: ../cat/virt-filesystems.pod:117
1368 msgid "See also I<--long>."
1369 msgstr ""
1370
1371 #. type: =item
1372 #: ../cat/virt-filesystems.pod:119
1373 msgid "B<--blkdevs>"
1374 msgstr ""
1375
1376 #. type: =item
1377 #: ../cat/virt-filesystems.pod:121
1378 msgid "B<--block-devices>"
1379 msgstr ""
1380
1381 #. type: textblock
1382 #: ../cat/virt-filesystems.pod:123
1383 msgid "Display block devices."
1384 msgstr ""
1385
1386 #. type: =item
1387 #: ../cat/virt-filesystems.pod:135 ../cat/virt-ls.pod:301 ../df/virt-df.pod:88
1388 msgid "B<--csv>"
1389 msgstr ""
1390
1391 #. type: textblock
1392 #: ../cat/virt-filesystems.pod:137 ../cat/virt-ls.pod:303 ../df/virt-df.pod:90
1393 msgid ""
1394 "Write out the results in CSV format (comma-separated values).  This format "
1395 "can be imported easily into databases and spreadsheets, but read L</NOTE "
1396 "ABOUT CSV FORMAT> below."
1397 msgstr ""
1398
1399 #. type: textblock
1400 #: ../cat/virt-filesystems.pod:150
1401 msgid ""
1402 "When prompting for keys and passphrases, virt-filesystems normally turns "
1403 "echoing off so you cannot see what you are typing.  If you are not worried "
1404 "about Tempest attacks and there is no one else in the room you can specify "
1405 "this flag to see what you are typing."
1406 msgstr ""
1407
1408 #. type: =item
1409 #: ../cat/virt-filesystems.pod:155
1410 msgid "B<--extra>"
1411 msgstr ""
1412
1413 #. type: textblock
1414 #: ../cat/virt-filesystems.pod:157
1415 msgid ""
1416 "This causes filesystems that are not ordinary, mountable filesystems to be "
1417 "displayed.  This category includes swapspace, and filesystems that are empty "
1418 "or contain unknown data."
1419 msgstr ""
1420
1421 #. type: textblock
1422 #: ../cat/virt-filesystems.pod:161
1423 msgid "This option implies I<--filesystems>."
1424 msgstr ""
1425
1426 #. type: =item
1427 #: ../cat/virt-filesystems.pod:163
1428 msgid "B<--filesystems>"
1429 msgstr ""
1430
1431 #. type: textblock
1432 #: ../cat/virt-filesystems.pod:165
1433 msgid ""
1434 "Display mountable filesystems.  If no display option was selected then this "
1435 "option is implied."
1436 msgstr ""
1437
1438 #. type: textblock
1439 #: ../cat/virt-filesystems.pod:168
1440 msgid "With I<--extra>, non-mountable filesystems are shown too."
1441 msgstr ""
1442
1443 #. type: verbatim
1444 #: ../cat/virt-filesystems.pod:181
1445 #, no-wrap
1446 msgid ""
1447 " virt-filesystems --format=raw -a disk.img\n"
1448 "\n"
1449 msgstr ""
1450
1451 #. type: verbatim
1452 #: ../cat/virt-filesystems.pod:185
1453 #, no-wrap
1454 msgid ""
1455 " virt-filesystems --format=raw -a disk.img --format -a another.img\n"
1456 "\n"
1457 msgstr ""
1458
1459 #. type: =item
1460 #: ../cat/virt-filesystems.pod:194 ../cat/virt-ls.pod:352 ../df/virt-df.pod:125 ../fish/guestfish.pod:156 ../tools/virt-list-partitions.pl:109
1461 msgid "B<-h>"
1462 msgstr ""
1463
1464 #. type: =item
1465 #: ../cat/virt-filesystems.pod:196 ../cat/virt-ls.pod:354 ../df/virt-df.pod:127 ../tools/virt-list-partitions.pl:111
1466 msgid "B<--human-readable>"
1467 msgstr ""
1468
1469 #. type: textblock
1470 #: ../cat/virt-filesystems.pod:198
1471 msgid "In I<--long> mode, display sizes in human-readable format."
1472 msgstr ""
1473
1474 #. type: =item
1475 #: ../cat/virt-filesystems.pod:205 ../cat/virt-ls.pod:366 ../tools/virt-list-filesystems.pl:108 ../tools/virt-list-partitions.pl:119
1476 msgid "B<-l>"
1477 msgstr ""
1478
1479 #. type: =item
1480 #: ../cat/virt-filesystems.pod:207 ../cat/virt-ls.pod:368 ../tools/virt-list-filesystems.pl:110 ../tools/virt-list-partitions.pl:121
1481 msgid "B<--long>"
1482 msgstr ""
1483
1484 #. type: textblock
1485 #: ../cat/virt-filesystems.pod:209
1486 msgid "Display extra columns of data (\"long format\")."
1487 msgstr ""
1488
1489 #. type: textblock
1490 #: ../cat/virt-filesystems.pod:211
1491 msgid "A title row is added unless you also specify I<--no-title>."
1492 msgstr ""
1493
1494 #. type: textblock
1495 #: ../cat/virt-filesystems.pod:213
1496 msgid ""
1497 "The extra columns displayed depend on what output you select, and the "
1498 "ordering of columns may change in future versions.  Use the title row, "
1499 "I<--csv> output and/or L<csvtool(1)> to match columns to data in external "
1500 "programs."
1501 msgstr ""
1502
1503 #. type: textblock
1504 #: ../cat/virt-filesystems.pod:218
1505 msgid ""
1506 "Use I<-h> if you want sizes to be displayed in human-readable format.  The "
1507 "default is to show raw numbers of I<bytes>."
1508 msgstr ""
1509
1510 #. type: textblock
1511 #: ../cat/virt-filesystems.pod:221
1512 msgid "Use I<--uuid> to display UUIDs too."
1513 msgstr ""
1514
1515 #. type: =item
1516 #: ../cat/virt-filesystems.pod:223
1517 msgid "B<--lvs>"
1518 msgstr ""
1519
1520 #. type: =item
1521 #: ../cat/virt-filesystems.pod:225
1522 msgid "B<--logvols>"
1523 msgstr ""
1524
1525 #. type: =item
1526 #: ../cat/virt-filesystems.pod:227
1527 msgid "B<--logical-volumes>"
1528 msgstr ""
1529
1530 #. type: textblock
1531 #: ../cat/virt-filesystems.pod:229
1532 msgid ""
1533 "Display LVM logical volumes.  In this mode, these are displayed irrespective "
1534 "of whether the LVs contain filesystems."
1535 msgstr ""
1536
1537 #. type: =item
1538 #: ../cat/virt-filesystems.pod:232
1539 msgid "B<--no-title>"
1540 msgstr ""
1541
1542 #. type: textblock
1543 #: ../cat/virt-filesystems.pod:234
1544 msgid "In I<--long> mode, don't add a title row."
1545 msgstr ""
1546
1547 #. type: textblock
1548 #: ../cat/virt-filesystems.pod:236
1549 msgid ""
1550 "Note that the order of the columns is not fixed, and may change in future "
1551 "versions of virt-filesystems, so using this option may give you unexpected "
1552 "surprises."
1553 msgstr ""
1554
1555 #. type: =item
1556 #: ../cat/virt-filesystems.pod:240
1557 msgid "B<--parts>"
1558 msgstr ""
1559
1560 #. type: =item
1561 #: ../cat/virt-filesystems.pod:242
1562 msgid "B<--partitions>"
1563 msgstr ""
1564
1565 #. type: textblock
1566 #: ../cat/virt-filesystems.pod:244
1567 msgid ""
1568 "Display partitions.  In this mode, these are displayed irrespective of "
1569 "whether the partitions contain filesystems."
1570 msgstr ""
1571
1572 #. type: =item
1573 #: ../cat/virt-filesystems.pod:247
1574 msgid "B<--pvs>"
1575 msgstr ""
1576
1577 #. type: =item
1578 #: ../cat/virt-filesystems.pod:249
1579 msgid "B<--physvols>"
1580 msgstr ""
1581
1582 #. type: =item
1583 #: ../cat/virt-filesystems.pod:251
1584 msgid "B<--physical-volumes>"
1585 msgstr ""
1586
1587 #. type: textblock
1588 #: ../cat/virt-filesystems.pod:253
1589 msgid "Display LVM physical volumes."
1590 msgstr ""
1591
1592 #. type: =item
1593 #: ../cat/virt-filesystems.pod:255 ../df/virt-df.pod:163
1594 msgid "B<--uuid>"
1595 msgstr ""
1596
1597 #. type: =item
1598 #: ../cat/virt-filesystems.pod:257
1599 msgid "B<--uuids>"
1600 msgstr ""
1601
1602 #. type: textblock
1603 #: ../cat/virt-filesystems.pod:259
1604 msgid "In I<--long> mode, display UUIDs as well."
1605 msgstr ""
1606
1607 #. type: =item
1608 #: ../cat/virt-filesystems.pod:273
1609 msgid "B<--vgs>"
1610 msgstr ""
1611
1612 #. type: =item
1613 #: ../cat/virt-filesystems.pod:275
1614 msgid "B<--volgroups>"
1615 msgstr ""
1616
1617 #. type: =item
1618 #: ../cat/virt-filesystems.pod:277
1619 msgid "B<--volume-groups>"
1620 msgstr ""
1621
1622 #. type: textblock
1623 #: ../cat/virt-filesystems.pod:279
1624 msgid "Display LVM volume groups."
1625 msgstr ""
1626
1627 #. type: =head1
1628 #: ../cat/virt-filesystems.pod:287
1629 msgid "COLUMNS"
1630 msgstr ""
1631
1632 #. type: textblock
1633 #: ../cat/virt-filesystems.pod:289
1634 msgid ""
1635 "Note that columns in the output are subject to reordering and change in "
1636 "future versions of this tool."
1637 msgstr ""
1638
1639 #. type: =item
1640 #: ../cat/virt-filesystems.pod:294
1641 msgid "B<Name>"
1642 msgstr ""
1643
1644 #. type: textblock
1645 #: ../cat/virt-filesystems.pod:296
1646 msgid "The filesystem, partition, block device or LVM name."
1647 msgstr ""
1648
1649 #. type: textblock
1650 #: ../cat/virt-filesystems.pod:298
1651 msgid ""
1652 "For device and partition names these are displayed as canonical libguestfs "
1653 "names, so that for example C</dev/sda2> is the second partition on the first "
1654 "device."
1655 msgstr ""
1656
1657 #. type: textblock
1658 #: ../cat/virt-filesystems.pod:302
1659 msgid ""
1660 "If the I<--long> option is B<not> specified, then only the name column is "
1661 "shown in the output."
1662 msgstr ""
1663
1664 #. type: =item
1665 #: ../cat/virt-filesystems.pod:305
1666 msgid "B<Type>"
1667 msgstr ""
1668
1669 #. type: textblock
1670 #: ../cat/virt-filesystems.pod:307
1671 msgid "The object type, for example C<filesystem>, C<lv>, C<device> etc."
1672 msgstr ""
1673
1674 #. type: =item
1675 #: ../cat/virt-filesystems.pod:309
1676 msgid "B<VFS>"
1677 msgstr ""
1678
1679 #. type: textblock
1680 #: ../cat/virt-filesystems.pod:311
1681 msgid ""
1682 "If there is a filesystem, then this column displays the filesystem type if "
1683 "one could be detected, eg. C<ext4>."
1684 msgstr ""
1685
1686 #. type: =item
1687 #: ../cat/virt-filesystems.pod:314
1688 msgid "B<Label>"
1689 msgstr ""
1690
1691 #. type: textblock
1692 #: ../cat/virt-filesystems.pod:316
1693 msgid ""
1694 "If the object has a label (used for identifying and mounting filesystems) "
1695 "then this column contains the label."
1696 msgstr ""
1697
1698 #. type: =item
1699 #: ../cat/virt-filesystems.pod:319
1700 msgid "B<MBR>"
1701 msgstr ""
1702
1703 #. type: textblock
1704 #: ../cat/virt-filesystems.pod:321
1705 msgid ""
1706 "The partition type byte, displayed as a two digit hexadecimal number.  A "
1707 "comprehensive list of partition types can be found here: "
1708 "L<http://www.win.tue.nl/~aeb/partitions/partition_types-1.html>"
1709 msgstr ""
1710
1711 #. type: textblock
1712 #: ../cat/virt-filesystems.pod:325
1713 msgid "This is only applicable for DOS (MBR) partitions."
1714 msgstr ""
1715
1716 #. type: =item
1717 #: ../cat/virt-filesystems.pod:327
1718 msgid "B<Size>"
1719 msgstr ""
1720
1721 #. type: textblock
1722 #: ../cat/virt-filesystems.pod:329
1723 msgid ""
1724 "The size of the object in bytes.  If the I<--human> option is used then the "
1725 "size is displayed in a human-readable form."
1726 msgstr ""
1727
1728 #. type: =item
1729 #: ../cat/virt-filesystems.pod:332
1730 msgid "B<Parent>"
1731 msgstr ""
1732
1733 #. type: textblock
1734 #: ../cat/virt-filesystems.pod:334
1735 msgid ""
1736 "The parent column records the parent relationship between objects.  For "
1737 "example, if the object is a partition, then this column contains the name of "
1738 "the containing device.  If the object is a logical volume, then this column "
1739 "is the name of the volume group."
1740 msgstr ""
1741
1742 #. type: =item
1743 #: ../cat/virt-filesystems.pod:339
1744 msgid "B<UUID>"
1745 msgstr ""
1746
1747 #. type: textblock
1748 #: ../cat/virt-filesystems.pod:341
1749 msgid ""
1750 "If the object has a UUID (used for identifying and mounting filesystems and "
1751 "block devices) then this column contains the UUID as a string."
1752 msgstr ""
1753
1754 #. type: textblock
1755 #: ../cat/virt-filesystems.pod:345
1756 msgid "The UUID is only displayed if the I<--uuid> option is given."
1757 msgstr ""
1758
1759 #. type: =head1
1760 #: ../cat/virt-filesystems.pod:349 ../cat/virt-ls.pod:459 ../df/virt-df.pod:191
1761 msgid "NOTE ABOUT CSV FORMAT"
1762 msgstr ""
1763
1764 #. type: textblock
1765 #: ../cat/virt-filesystems.pod:351 ../cat/virt-ls.pod:461 ../df/virt-df.pod:193
1766 msgid ""
1767 "Comma-separated values (CSV) is a deceptive format.  It I<seems> like it "
1768 "should be easy to parse, but it is definitely not easy to parse."
1769 msgstr ""
1770
1771 #. type: textblock
1772 #: ../cat/virt-filesystems.pod:354 ../cat/virt-ls.pod:464 ../df/virt-df.pod:196
1773 msgid ""
1774 "Myth: Just split fields at commas.  Reality: This does I<not> work "
1775 "reliably.  This example has two columns:"
1776 msgstr ""
1777
1778 #. type: verbatim
1779 #: ../cat/virt-filesystems.pod:357 ../cat/virt-ls.pod:467 ../df/virt-df.pod:199
1780 #, no-wrap
1781 msgid ""
1782 " \"foo,bar\",baz\n"
1783 "\n"
1784 msgstr ""
1785
1786 #. type: textblock
1787 #: ../cat/virt-filesystems.pod:359 ../cat/virt-ls.pod:469 ../df/virt-df.pod:201
1788 msgid ""
1789 "Myth: Read the file one line at a time.  Reality: This does I<not> work "
1790 "reliably.  This example has one row:"
1791 msgstr ""
1792
1793 #. type: verbatim
1794 #: ../cat/virt-filesystems.pod:362 ../cat/virt-ls.pod:472 ../df/virt-df.pod:204
1795 #, no-wrap
1796 msgid ""
1797 " \"foo\n"
1798 " bar\",baz\n"
1799 "\n"
1800 msgstr ""
1801
1802 #. type: textblock
1803 #: ../cat/virt-filesystems.pod:365 ../cat/virt-ls.pod:475 ../df/virt-df.pod:207
1804 msgid ""
1805 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
1806 "packaged in major Linux distributions)."
1807 msgstr ""
1808
1809 #. type: textblock
1810 #: ../cat/virt-filesystems.pod:368 ../cat/virt-ls.pod:478 ../df/virt-df.pod:210
1811 msgid ""
1812 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
1813 "or Python's built-in csv library)."
1814 msgstr ""
1815
1816 #. type: textblock
1817 #: ../cat/virt-filesystems.pod:371 ../cat/virt-ls.pod:481 ../df/virt-df.pod:213
1818 msgid "Most spreadsheets and databases can import CSV directly."
1819 msgstr ""
1820
1821 #. type: textblock
1822 #: ../cat/virt-filesystems.pod:387
1823 msgid ""
1824 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
1825 "L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<csvtool(1)>, "
1826 "L<http://libguestfs.org/>."
1827 msgstr ""
1828
1829 #. type: textblock
1830 #: ../cat/virt-filesystems.pod:402 ../tools/virt-win-reg.pl:789
1831 msgid "Copyright (C) 2010 Red Hat Inc."
1832 msgstr ""
1833
1834 #. type: textblock
1835 #: ../cat/virt-ls.pod:5
1836 msgid "virt-ls - List files in a virtual machine"
1837 msgstr ""
1838
1839 #. type: verbatim
1840 #: ../cat/virt-ls.pod:9
1841 #, no-wrap
1842 msgid ""
1843 " virt-ls [--options] -d domname directory [directory ...]\n"
1844 "\n"
1845 msgstr ""
1846
1847 #. type: verbatim
1848 #: ../cat/virt-ls.pod:11
1849 #, no-wrap
1850 msgid ""
1851 " virt-ls [--options] -a disk.img [-a disk.img ...] directory [directory "
1852 "...]\n"
1853 "\n"
1854 msgstr ""
1855
1856 #. type: textblock
1857 #: ../cat/virt-ls.pod:13 ../df/virt-df.pod:15 ../rescue/virt-rescue.pod:15
1858 msgid "Old style:"
1859 msgstr ""
1860
1861 #. type: verbatim
1862 #: ../cat/virt-ls.pod:15
1863 #, no-wrap
1864 msgid ""
1865 " virt-ls [--options] domname directory\n"
1866 "\n"
1867 msgstr ""
1868
1869 #. type: verbatim
1870 #: ../cat/virt-ls.pod:17
1871 #, no-wrap
1872 msgid ""
1873 " virt-ls [--options] disk.img [disk.img ...] directory\n"
1874 "\n"
1875 msgstr ""
1876
1877 #. type: textblock
1878 #: ../cat/virt-ls.pod:21
1879 msgid ""
1880 "C<virt-ls> lists filenames, file sizes, checksums, extended attributes and "
1881 "more from a virtual machine or disk image."
1882 msgstr ""
1883
1884 #. type: textblock
1885 #: ../cat/virt-ls.pod:24
1886 msgid ""
1887 "Multiple directory names can be given, in which case the output from each is "
1888 "concatenated."
1889 msgstr ""
1890
1891 #. type: textblock
1892 #: ../cat/virt-ls.pod:27
1893 msgid ""
1894 "To list directories from a libvirt guest use the I<-d> option to specify the "
1895 "name of the guest.  For a disk image, use the I<-a> option."
1896 msgstr ""
1897
1898 #. type: textblock
1899 #: ../cat/virt-ls.pod:31
1900 msgid ""
1901 "C<virt-ls> can do many simple file listings.  For more complicated cases you "
1902 "may need to use L<guestfish(1)>, or write a program directly to the "
1903 "L<guestfs(3)> API."
1904 msgstr ""
1905
1906 #. type: textblock
1907 #: ../cat/virt-ls.pod:37
1908 msgid "Get a list of all files and directories in a virtual machine:"
1909 msgstr ""
1910
1911 #. type: verbatim
1912 #: ../cat/virt-ls.pod:39
1913 #, no-wrap
1914 msgid ""
1915 " virt-ls -R -d guest /\n"
1916 "\n"
1917 msgstr ""
1918
1919 #. type: textblock
1920 #: ../cat/virt-ls.pod:41
1921 msgid "List all setuid or setgid programs in a Linux virtual machine:"
1922 msgstr ""
1923
1924 #. type: verbatim
1925 #: ../cat/virt-ls.pod:43
1926 #, no-wrap
1927 msgid ""
1928 " virt-ls -lR -d guest / | grep '^- [42]'\n"
1929 "\n"
1930 msgstr ""
1931
1932 #. type: textblock
1933 #: ../cat/virt-ls.pod:45
1934 msgid "List all public-writable directories in a Linux virtual machine:"
1935 msgstr ""
1936
1937 #. type: verbatim
1938 #: ../cat/virt-ls.pod:47
1939 #, no-wrap
1940 msgid ""
1941 " virt-ls -lR -d guest / | grep '^d ...7'\n"
1942 "\n"
1943 msgstr ""
1944
1945 #. type: textblock
1946 #: ../cat/virt-ls.pod:49
1947 msgid "List all Unix domain sockets in a Linux virtual machine:"
1948 msgstr ""
1949
1950 #. type: verbatim
1951 #: ../cat/virt-ls.pod:51
1952 #, no-wrap
1953 msgid ""
1954 " virt-ls -lR -d guest / | grep '^s'\n"
1955 "\n"
1956 msgstr ""
1957
1958 #. type: textblock
1959 #: ../cat/virt-ls.pod:53
1960 msgid "List all regular files with filenames ending in '.png':"
1961 msgstr ""
1962
1963 #. type: verbatim
1964 #: ../cat/virt-ls.pod:55
1965 #, no-wrap
1966 msgid ""
1967 " virt-ls -lR -d guest / | grep -i '^-.*\\.png$'\n"
1968 "\n"
1969 msgstr ""
1970
1971 #. type: textblock
1972 #: ../cat/virt-ls.pod:57
1973 msgid "To display files larger than 10MB in home directories:"
1974 msgstr ""
1975
1976 #. type: verbatim
1977 #: ../cat/virt-ls.pod:59
1978 #, no-wrap
1979 msgid ""
1980 " virt-ls -lR -d guest /home | awk '$3 > 10*1024*1024'\n"
1981 "\n"
1982 msgstr ""
1983
1984 #. type: textblock
1985 #: ../cat/virt-ls.pod:61
1986 msgid "Find everything modified in the last 7 days:"
1987 msgstr ""
1988
1989 #. type: verbatim
1990 #: ../cat/virt-ls.pod:63
1991 #, no-wrap
1992 msgid ""
1993 " virt-ls -lR -d guest --time-days / | awk '$6 <= 7'\n"
1994 "\n"
1995 msgstr ""
1996
1997 #. type: textblock
1998 #: ../cat/virt-ls.pod:65
1999 msgid "Find regular files modified in the last 24 hours:"
2000 msgstr ""
2001
2002 #. type: verbatim
2003 #: ../cat/virt-ls.pod:67
2004 #, no-wrap
2005 msgid ""
2006 " virt-ls -lR -d guest --time-days / | grep '^-' | awk '$6 < 1'\n"
2007 "\n"
2008 msgstr ""
2009
2010 #. type: =head2
2011 #: ../cat/virt-ls.pod:69
2012 msgid "DIFFERENCES IN SNAPSHOTS AND BACKING FILES"
2013 msgstr ""
2014
2015 #. type: textblock
2016 #: ../cat/virt-ls.pod:71
2017 msgid ""
2018 "Find the differences between files in a guest and an earlier snapshot of the "
2019 "same guest."
2020 msgstr ""
2021
2022 #. type: verbatim
2023 #: ../cat/virt-ls.pod:74
2024 #, no-wrap
2025 msgid ""
2026 " virt-ls -lR -a snapshot.img / --uids --time-t > old\n"
2027 " virt-ls -lR -a current.img / --uids --time-t > new\n"
2028 " diff -u old new | less\n"
2029 "\n"
2030 msgstr ""
2031
2032 #. type: textblock
2033 #: ../cat/virt-ls.pod:78
2034 msgid ""
2035 "The commands above won't find files where the content has changed but the "
2036 "metadata (eg. file size and modification date) is the same.  To do that, you "
2037 "need to add the I<--checksum> parameter to both C<virt-ls> commands.  "
2038 "I<--checksum> can be quite slow since it has to read and compute a checksum "
2039 "of every regular file in the virtual machine."
2040 msgstr ""
2041
2042 #. type: =head1
2043 #: ../cat/virt-ls.pod:84
2044 msgid "OUTPUT MODES"
2045 msgstr ""
2046
2047 #. type: textblock
2048 #: ../cat/virt-ls.pod:86
2049 msgid ""
2050 "C<virt-ls> has four output modes, controlled by different combinations of "
2051 "the I<-l> and I<-R> options."
2052 msgstr ""
2053
2054 #. type: =head2
2055 #: ../cat/virt-ls.pod:89
2056 msgid "SIMPLE LISTING"
2057 msgstr ""
2058
2059 #. type: textblock
2060 #: ../cat/virt-ls.pod:91
2061 msgid "A simple listing is like the ordinary L<ls(1)> command:"
2062 msgstr ""
2063
2064 #. type: verbatim
2065 #: ../cat/virt-ls.pod:93
2066 #, no-wrap
2067 msgid ""
2068 " $ virt-ls -d guest /\n"
2069 " bin\n"
2070 " boot\n"
2071 " [etc.]\n"
2072 "\n"
2073 msgstr ""
2074
2075 #. type: =head2
2076 #: ../cat/virt-ls.pod:98
2077 msgid "LONG LISTING"
2078 msgstr ""
2079
2080 #. type: textblock
2081 #: ../cat/virt-ls.pod:100
2082 msgid ""
2083 "With the I<-l> (I<--long>) option, the output is like the C<ls -l> command "
2084 "(more specifically, like the C<guestfs_ll> function)."
2085 msgstr ""
2086
2087 #. type: verbatim
2088 #: ../cat/virt-ls.pod:103
2089 #, no-wrap
2090 msgid ""
2091 " $ virt-ls -l -d guest /\n"
2092 " total 204\n"
2093 " dr-xr-xr-x.   2 root root   4096 2009-08-25 19:06 bin\n"
2094 " dr-xr-xr-x.   5 root root   3072 2009-08-25 19:06 boot\n"
2095 " [etc.]\n"
2096 "\n"
2097 msgstr ""
2098
2099 #. type: textblock
2100 #: ../cat/virt-ls.pod:109
2101 msgid ""
2102 "Note that while this is useful for displaying a directory, do not try "
2103 "parsing this output in another program.  Use L</RECURSIVE LONG LISTING> "
2104 "instead."
2105 msgstr ""
2106
2107 #. type: =head2
2108 #: ../cat/virt-ls.pod:113
2109 msgid "RECURSIVE LISTING"
2110 msgstr ""
2111
2112 #. type: textblock
2113 #: ../cat/virt-ls.pod:115
2114 msgid ""
2115 "With the I<-R> (I<--recursive>) option, C<virt-ls> lists the names of files "
2116 "and directories recursively:"
2117 msgstr ""
2118
2119 #. type: verbatim
2120 #: ../cat/virt-ls.pod:118
2121 #, no-wrap
2122 msgid ""
2123 " $ virt-ls -R -d guest /tmp\n"
2124 " foo\n"
2125 " foo/bar\n"
2126 " [etc.]\n"
2127 "\n"
2128 msgstr ""
2129
2130 #. type: textblock
2131 #: ../cat/virt-ls.pod:123
2132 msgid ""
2133 "To generate this output, C<virt-ls> runs the C<guestfs_find0> function and "
2134 "converts C<\\0> characters to C<\\n>."
2135 msgstr ""
2136
2137 #. type: =head2
2138 #: ../cat/virt-ls.pod:126
2139 msgid "RECURSIVE LONG LISTING"
2140 msgstr ""
2141
2142 #. type: textblock
2143 #: ../cat/virt-ls.pod:128
2144 msgid ""
2145 "Using I<-lR> options together changes the output to display directories "
2146 "recursively, with file stats, and optionally other features such as "
2147 "checksums and extended attributes."
2148 msgstr ""
2149
2150 #. type: textblock
2151 #: ../cat/virt-ls.pod:132
2152 msgid ""
2153 "Most of the interesting features of C<virt-ls> are only available when using "
2154 "I<-lR> mode."
2155 msgstr ""
2156
2157 #. type: textblock
2158 #: ../cat/virt-ls.pod:135
2159 msgid ""
2160 "The fields are normally space-separated.  Filenames are B<not> quoted, so "
2161 "you cannot use the output in another program (because filenames can contain "
2162 "spaces and other unsafe characters).  If the guest was untrusted and someone "
2163 "knew you were using C<virt-ls> to analyze the guest, they could play tricks "
2164 "on you by creating filenames with embedded newline characters.  To B<safely> "
2165 "parse the output in another program, use the I<--csv> (Comma-Separated "
2166 "Values) option."
2167 msgstr ""
2168
2169 #. type: textblock
2170 #: ../cat/virt-ls.pod:143
2171 msgid ""
2172 "Note that this output format is completely unrelated to the C<ls -lR> "
2173 "command."
2174 msgstr ""
2175
2176 #. type: verbatim
2177 #: ../cat/virt-ls.pod:146
2178 #, no-wrap
2179 msgid ""
2180 " $ virt-ls -lR -d guest /bin\n"
2181 " d 0555       4096 /bin\n"
2182 " - 0755        123 /bin/alsaunmute\n"
2183 " - 0755      28328 /bin/arch\n"
2184 " l 0777          4 /bin/awk -> gawk\n"
2185 " - 0755      27216 /bin/basename\n"
2186 " - 0755     943360 /bin/bash\n"
2187 " [etc.]\n"
2188 "\n"
2189 msgstr ""
2190
2191 #. type: textblock
2192 #: ../cat/virt-ls.pod:155
2193 msgid "These basic fields are always shown:"
2194 msgstr ""
2195
2196 #. type: =item
2197 #: ../cat/virt-ls.pod:159
2198 msgid "type"
2199 msgstr ""
2200
2201 #. type: textblock
2202 #: ../cat/virt-ls.pod:161
2203 msgid ""
2204 "The file type, one of: C<-> (regular file), C<d> (directory), C<c> "
2205 "(character device), C<b> (block device), C<p> (named pipe), C<l> (symbolic "
2206 "link), C<s> (socket) or C<u> (unknown)."
2207 msgstr ""
2208
2209 #. type: =item
2210 #: ../cat/virt-ls.pod:171
2211 msgid "permissions"
2212 msgstr ""
2213
2214 #. type: textblock
2215 #: ../cat/virt-ls.pod:173
2216 msgid "The Unix permissions, displayed as a 4 digit octal number."
2217 msgstr ""
2218
2219 #. type: =item
2220 #: ../cat/virt-ls.pod:175
2221 msgid "size"
2222 msgstr ""
2223
2224 #. type: textblock
2225 #: ../cat/virt-ls.pod:177
2226 msgid ""
2227 "The size of the file.  This is shown in bytes unless I<-h> or "
2228 "I<--human-readable> option is given, in which case this is shown as a "
2229 "human-readable number."
2230 msgstr ""
2231
2232 #. type: =head2
2233 #: ../cat/virt-ls.pod:181 ../fish/guestfish-actions.pod:4380
2234 msgid "path"
2235 msgstr ""
2236
2237 #. type: textblock
2238 #: ../cat/virt-ls.pod:183
2239 msgid "The full path of the file or directory."
2240 msgstr ""
2241
2242 #. type: =item
2243 #: ../cat/virt-ls.pod:185
2244 msgid "link"
2245 msgstr ""
2246
2247 #. type: textblock
2248 #: ../cat/virt-ls.pod:187
2249 msgid "For symbolic links only, the link target."
2250 msgstr ""
2251
2252 #. type: textblock
2253 #: ../cat/virt-ls.pod:191
2254 msgid ""
2255 "In I<-lR> mode, additional command line options enable the display of more "
2256 "fields."
2257 msgstr ""
2258
2259 #. type: textblock
2260 #: ../cat/virt-ls.pod:194
2261 msgid ""
2262 "With the I<--uids> flag, these additional fields are displayed before the "
2263 "path:"
2264 msgstr ""
2265
2266 #. type: =item
2267 #: ../cat/virt-ls.pod:199
2268 msgid "uid"
2269 msgstr ""
2270
2271 #. type: =item
2272 #: ../cat/virt-ls.pod:201
2273 msgid "gid"
2274 msgstr ""
2275
2276 #. type: textblock
2277 #: ../cat/virt-ls.pod:203
2278 msgid ""
2279 "The UID and GID of the owner of the file (displayed numerically).  Note "
2280 "these only make sense in the context of a Unix-like guest."
2281 msgstr ""
2282
2283 #. type: textblock
2284 #: ../cat/virt-ls.pod:208
2285 msgid "With the I<--times> flag, these additional fields are displayed:"
2286 msgstr ""
2287
2288 #. type: =item
2289 #: ../cat/virt-ls.pod:212
2290 msgid "atime"
2291 msgstr ""
2292
2293 #. type: textblock
2294 #: ../cat/virt-ls.pod:214
2295 msgid "The time of last access."
2296 msgstr ""
2297
2298 #. type: =item
2299 #: ../cat/virt-ls.pod:216
2300 msgid "mtime"
2301 msgstr ""
2302
2303 #. type: textblock
2304 #: ../cat/virt-ls.pod:218
2305 msgid "The time of last modification."
2306 msgstr ""
2307
2308 #. type: =item
2309 #: ../cat/virt-ls.pod:220
2310 msgid "ctime"
2311 msgstr ""
2312
2313 #. type: textblock
2314 #: ../cat/virt-ls.pod:222
2315 msgid "The time of last status change."
2316 msgstr ""
2317
2318 #. type: textblock
2319 #: ../cat/virt-ls.pod:226
2320 msgid ""
2321 "The time fields are displayed as string dates and times, unless one of the "
2322 "I<--time-t>, I<--time-relative> or I<--time-days> flags is given."
2323 msgstr ""
2324
2325 #. type: textblock
2326 #: ../cat/virt-ls.pod:229
2327 msgid "With the I<--extra-stats> flag, these additional fields are displayed:"
2328 msgstr ""
2329
2330 #. type: =item
2331 #: ../cat/virt-ls.pod:233
2332 msgid "device"
2333 msgstr ""
2334
2335 #. type: textblock
2336 #: ../cat/virt-ls.pod:235
2337 msgid ""
2338 "The device containing the file (displayed as major:minor).  This may not "
2339 "match devices as known to the guest."
2340 msgstr ""
2341
2342 #. type: =item
2343 #: ../cat/virt-ls.pod:238
2344 msgid "inode"
2345 msgstr ""
2346
2347 #. type: textblock
2348 #: ../cat/virt-ls.pod:240
2349 msgid "The inode number."
2350 msgstr ""
2351
2352 #. type: =item
2353 #: ../cat/virt-ls.pod:242
2354 msgid "nlink"
2355 msgstr ""
2356
2357 #. type: textblock
2358 #: ../cat/virt-ls.pod:244
2359 msgid "The number of hard links."
2360 msgstr ""
2361
2362 #. type: =item
2363 #: ../cat/virt-ls.pod:246
2364 msgid "rdev"
2365 msgstr ""
2366
2367 #. type: textblock
2368 #: ../cat/virt-ls.pod:248
2369 msgid "For block and char special files, the device (displayed as major:minor)."
2370 msgstr ""
2371
2372 #. type: =item
2373 #: ../cat/virt-ls.pod:251
2374 msgid "blocks"
2375 msgstr ""
2376
2377 #. type: textblock
2378 #: ../cat/virt-ls.pod:253
2379 msgid "The number of 512 byte blocks allocated to the file."
2380 msgstr ""
2381
2382 #. type: textblock
2383 #: ../cat/virt-ls.pod:257
2384 msgid ""
2385 "With the I<--checksum> flag, the checksum of the file contents is shown "
2386 "(only for regular files).  Computing file checksums can take a considerable "
2387 "amount of time."
2388 msgstr ""
2389
2390 #. type: =item
2391 #: ../cat/virt-ls.pod:280
2392 msgid "B<--checksum>"
2393 msgstr ""
2394
2395 #. type: =item
2396 #: ../cat/virt-ls.pod:282
2397 msgid "B<--checksum=crc|md5|sha1|sha224|sha256|sha384|sha512>"
2398 msgstr ""
2399
2400 #. type: textblock
2401 #: ../cat/virt-ls.pod:284
2402 msgid ""
2403 "Display checksum over file contents for regular files.  With no argument, "
2404 "this defaults to using I<md5>.  Using an argument, you can select the "
2405 "checksum type to use."
2406 msgstr ""
2407
2408 #. type: textblock
2409 #: ../cat/virt-ls.pod:288 ../cat/virt-ls.pod:325 ../cat/virt-ls.pod:358 ../cat/virt-ls.pod:391 ../cat/virt-ls.pod:401 ../cat/virt-ls.pod:408 ../cat/virt-ls.pod:415 ../cat/virt-ls.pod:422
2410 msgid ""
2411 "This option only has effect in I<-lR> output mode.  See L</RECURSIVE LONG "
2412 "LISTING> above."
2413 msgstr ""
2414
2415 #. type: textblock
2416 #: ../cat/virt-ls.pod:316
2417 msgid ""
2418 "When prompting for keys and passphrases, virt-ls normally turns echoing off "
2419 "so you cannot see what you are typing.  If you are not worried about Tempest "
2420 "attacks and there is no one else in the room you can specify this flag to "
2421 "see what you are typing."
2422 msgstr ""
2423
2424 #. type: =item
2425 #: ../cat/virt-ls.pod:321
2426 msgid "B<--extra-stats>"
2427 msgstr ""
2428
2429 #. type: textblock
2430 #: ../cat/virt-ls.pod:323
2431 msgid "Display extra stats."
2432 msgstr ""
2433
2434 #. type: verbatim
2435 #: ../cat/virt-ls.pod:339
2436 #, no-wrap
2437 msgid ""
2438 " virt-ls --format=raw -a disk.img /dir\n"
2439 "\n"
2440 msgstr ""
2441
2442 #. type: verbatim
2443 #: ../cat/virt-ls.pod:343
2444 #, no-wrap
2445 msgid ""
2446 " virt-ls --format=raw -a disk.img --format -a another.img /dir\n"
2447 "\n"
2448 msgstr ""
2449
2450 #. type: textblock
2451 #: ../cat/virt-ls.pod:356
2452 msgid "Display file sizes in human-readable format."
2453 msgstr ""
2454
2455 #. type: =item
2456 #: ../cat/virt-ls.pod:370
2457 msgid "B<-R>"
2458 msgstr ""
2459
2460 #. type: =item
2461 #: ../cat/virt-ls.pod:372
2462 msgid "B<--recursive>"
2463 msgstr ""
2464
2465 #. type: textblock
2466 #: ../cat/virt-ls.pod:374
2467 msgid ""
2468 "Select the mode.  With neither of these options, C<virt-ls> produces a "
2469 "simple, flat list of the files in the named directory.  See L</SIMPLE "
2470 "LISTING>."
2471 msgstr ""
2472
2473 #. type: textblock
2474 #: ../cat/virt-ls.pod:378
2475 msgid ""
2476 "C<virt-ls -l> produces a \"long listing\", which shows more detail.  See "
2477 "L</LONG LISTING>."
2478 msgstr ""
2479
2480 #. type: textblock
2481 #: ../cat/virt-ls.pod:381
2482 msgid ""
2483 "C<virt-ls -R> produces a recursive list of files starting at the named "
2484 "directory.  See L</RECURSIVE LISTING>."
2485 msgstr ""
2486
2487 #. type: textblock
2488 #: ../cat/virt-ls.pod:384
2489 msgid ""
2490 "C<virt-ls -lR> produces a recursive long listing which can be more easily "
2491 "parsed.  See L</RECURSIVE LONG LISTING>."
2492 msgstr ""
2493
2494 #. type: =item
2495 #: ../cat/virt-ls.pod:387
2496 msgid "B<--times>"
2497 msgstr ""
2498
2499 #. type: textblock
2500 #: ../cat/virt-ls.pod:389
2501 msgid "Display time fields."
2502 msgstr ""
2503
2504 #. type: =item
2505 #: ../cat/virt-ls.pod:394
2506 msgid "B<--time-days>"
2507 msgstr ""
2508
2509 #. type: textblock
2510 #: ../cat/virt-ls.pod:396
2511 msgid "Display time fields as days before now (negative if in the future)."
2512 msgstr ""
2513
2514 #. type: textblock
2515 #: ../cat/virt-ls.pod:398
2516 msgid ""
2517 "Note that C<0> in output means \"up to 1 day before now\", or that the age "
2518 "of the file is between 0 and 86399 seconds."
2519 msgstr ""
2520
2521 #. type: =item
2522 #: ../cat/virt-ls.pod:404
2523 msgid "B<--time-relative>"
2524 msgstr ""
2525
2526 #. type: textblock
2527 #: ../cat/virt-ls.pod:406
2528 msgid "Display time fields as seconds before now (negative if in the future)."
2529 msgstr ""
2530
2531 #. type: =item
2532 #: ../cat/virt-ls.pod:411
2533 msgid "B<--time-t>"
2534 msgstr ""
2535
2536 #. type: textblock
2537 #: ../cat/virt-ls.pod:413
2538 msgid "Display time fields as seconds since the Unix epoch."
2539 msgstr ""
2540
2541 #. type: =item
2542 #: ../cat/virt-ls.pod:418
2543 msgid "B<--uids>"
2544 msgstr ""
2545
2546 #. type: textblock
2547 #: ../cat/virt-ls.pod:420
2548 msgid "Display UID and GID fields."
2549 msgstr ""
2550
2551 #. type: textblock
2552 #: ../cat/virt-ls.pod:445
2553 msgid "Previous versions of virt-ls allowed you to write either:"
2554 msgstr ""
2555
2556 #. type: verbatim
2557 #: ../cat/virt-ls.pod:447
2558 #, no-wrap
2559 msgid ""
2560 " virt-ls disk.img [disk.img ...] /dir\n"
2561 "\n"
2562 msgstr ""
2563
2564 #. type: verbatim
2565 #: ../cat/virt-ls.pod:451
2566 #, no-wrap
2567 msgid ""
2568 " virt-ls guestname /dir\n"
2569 "\n"
2570 msgstr ""
2571
2572 #. type: textblock
2573 #: ../cat/virt-ls.pod:497
2574 msgid ""
2575 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, "
2576 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
2577 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
2578 msgstr ""
2579
2580 #. type: textblock
2581 #: ../cat/virt-ls.pod:513 ../df/virt-df.pod:241 ../edit/virt-edit.pod:374 ../rescue/virt-rescue.pod:340
2582 msgid "Copyright (C) 2009-2011 Red Hat Inc."
2583 msgstr ""
2584
2585 #. type: textblock
2586 #: ../clone/virt-sysprep.pod:5
2587 msgid "virt-sysprep - Reset or unconfigure a virtual machine so clones can be made"
2588 msgstr ""
2589
2590 #. type: verbatim
2591 #: ../clone/virt-sysprep.pod:9
2592 #, no-wrap
2593 msgid ""
2594 " virt-sysprep [--options] -d domname\n"
2595 "\n"
2596 msgstr ""
2597
2598 #. type: verbatim
2599 #: ../clone/virt-sysprep.pod:11
2600 #, no-wrap
2601 msgid ""
2602 " virt-sysprep [--options] -a disk.img [-a disk.img ...]\n"
2603 "\n"
2604 msgstr ""
2605
2606 #. type: textblock
2607 #: ../clone/virt-sysprep.pod:15
2608 msgid ""
2609 "Virt-sysprep \"resets\" or \"unconfigures\" a virtual machine so that clones "
2610 "can be made from it.  Steps in this process include removing SSH host keys, "
2611 "removing persistent network MAC configuration, and removing user accounts.  "
2612 "Each step can be enabled or disabled as required."
2613 msgstr ""
2614
2615 #. type: textblock
2616 #: ../clone/virt-sysprep.pod:21
2617 msgid ""
2618 "Virt-sysprep is a simple shell script, allowing easy inspection or "
2619 "customization by the system administrator."
2620 msgstr ""
2621
2622 #. type: textblock
2623 #: ../clone/virt-sysprep.pod:24
2624 msgid ""
2625 "Virt-sysprep modifies the guest or disk image I<in place>.  The guest must "
2626 "be shut down.  If you want to preserve the existing contents of the guest, "
2627 "you I<must copy or clone the disk first>.  See L</COPYING AND CLONING> "
2628 "below."
2629 msgstr ""
2630
2631 #. type: textblock
2632 #: ../clone/virt-sysprep.pod:29
2633 msgid ""
2634 "You do I<not> need to run virt-sysprep as root.  In fact we'd generally "
2635 "recommend that you don't.  The time you might want to run it as root is when "
2636 "you need root in order to access the disk image, but even in this case it "
2637 "would be better to change the permissions on the disk image to be writable "
2638 "as the non-root user running virt-sysprep."
2639 msgstr ""
2640
2641 #. type: textblock
2642 #: ../clone/virt-sysprep.pod:35
2643 msgid ""
2644 "\"Sysprep\" stands for \"system preparation\" tool.  The name comes from the "
2645 "Microsoft program C<sysprep.exe> which is used to unconfigure Windows "
2646 "machines in preparation for cloning them.  Having said that, virt-sysprep "
2647 "does I<not> currently work on Microsoft Windows guests.  We plan to support "
2648 "Windows sysprepping in a future version, and we already have code to do it."
2649 msgstr ""
2650
2651 #. type: =item
2652 #: ../clone/virt-sysprep.pod:76
2653 msgid "B<--enable=...>"
2654 msgstr ""
2655
2656 #. type: textblock
2657 #: ../clone/virt-sysprep.pod:78
2658 msgid ""
2659 "Choose which sysprep operations to perform.  Give a comma-separated list of "
2660 "operations, for example:"
2661 msgstr ""
2662
2663 #. type: verbatim
2664 #: ../clone/virt-sysprep.pod:81
2665 #, no-wrap
2666 msgid ""
2667 " --enable=ssh-hostkeys,udev-persistent-net\n"
2668 "\n"
2669 msgstr ""
2670
2671 #. type: textblock
2672 #: ../clone/virt-sysprep.pod:83
2673 msgid "would enable ONLY C<ssh-hostkeys> and C<udev-persistent-net> operations."
2674 msgstr ""
2675
2676 #. type: textblock
2677 #: ../clone/virt-sysprep.pod:85
2678 msgid ""
2679 "If the I<--enable> option is not given, then we default to trying all "
2680 "possible sysprep operations.  But some sysprep operations are skipped for "
2681 "some guest types."
2682 msgstr ""
2683
2684 #. type: textblock
2685 #: ../clone/virt-sysprep.pod:89
2686 msgid ""
2687 "Use I<--list-operations> to list operations supported by a particular "
2688 "version of virt-sysprep."
2689 msgstr ""
2690
2691 #. type: textblock
2692 #: ../clone/virt-sysprep.pod:92
2693 msgid "See L</OPERATIONS> below for a list and an explanation of each operation."
2694 msgstr ""
2695
2696 #. type: verbatim
2697 #: ../clone/virt-sysprep.pod:106
2698 #, no-wrap
2699 msgid ""
2700 " virt-sysprep --format=raw -a disk.img\n"
2701 "\n"
2702 msgstr ""
2703
2704 #. type: verbatim
2705 #: ../clone/virt-sysprep.pod:110
2706 #, no-wrap
2707 msgid ""
2708 " virt-sysprep --format=raw -a disk.img --format -a another.img\n"
2709 "\n"
2710 msgstr ""
2711
2712 #. type: =item
2713 #: ../clone/virt-sysprep.pod:119
2714 msgid "B<--hostname> newhostname"
2715 msgstr ""
2716
2717 #. type: textblock
2718 #: ../clone/virt-sysprep.pod:121
2719 msgid ""
2720 "Change the hostname.  See the L</hostname> operation below.  If not given, "
2721 "defaults to C<localhost.localdomain>."
2722 msgstr ""
2723
2724 #. type: =item
2725 #: ../clone/virt-sysprep.pod:124
2726 msgid "B<--list-operations>"
2727 msgstr ""
2728
2729 #. type: textblock
2730 #: ../clone/virt-sysprep.pod:126
2731 msgid "List the operations supported by the virt-sysprep program."
2732 msgstr ""
2733
2734 #. type: =item
2735 #: ../clone/virt-sysprep.pod:128
2736 msgid "B<--selinux-relabel>"
2737 msgstr ""
2738
2739 #. type: =item
2740 #: ../clone/virt-sysprep.pod:130
2741 msgid "B<--no-selinux-relabel>"
2742 msgstr ""
2743
2744 #. type: textblock
2745 #: ../clone/virt-sysprep.pod:132
2746 msgid ""
2747 "I<--selinux-relabel> forces SELinux relabelling next time the guest boots.  "
2748 "I<--no-selinux-relabel> disables relabelling."
2749 msgstr ""
2750
2751 #. type: textblock
2752 #: ../clone/virt-sysprep.pod:135
2753 msgid ""
2754 "The default is to try to detect if SELinux relabelling is required.  See "
2755 "L</SELINUX RELABELLING> below for more details."
2756 msgstr ""
2757
2758 #. type: =head1
2759 #: ../clone/virt-sysprep.pod:156
2760 msgid "OPERATIONS"
2761 msgstr ""
2762
2763 #. type: textblock
2764 #: ../clone/virt-sysprep.pod:158
2765 msgid ""
2766 "If the I<--enable> option is I<not> given, then I<all sysprep operations are "
2767 "enabled>, although some are skipped depending on the type of guest."
2768 msgstr ""
2769
2770 #. type: textblock
2771 #: ../clone/virt-sysprep.pod:162
2772 msgid ""
2773 "Operations can be individually enabled using the I<--enable> option.  Use a "
2774 "comma-separated list, for example:"
2775 msgstr ""
2776
2777 #. type: verbatim
2778 #: ../clone/virt-sysprep.pod:165
2779 #, no-wrap
2780 msgid ""
2781 " virt-sysprep --enable=ssh-hostkeys,udev-persistent-net [etc..]\n"
2782 "\n"
2783 msgstr ""
2784
2785 #. type: textblock
2786 #: ../clone/virt-sysprep.pod:167
2787 msgid ""
2788 "To list the operations supported by the current version of virt-sysprep, use "
2789 "I<--list-operations>."
2790 msgstr ""
2791
2792 #. type: textblock
2793 #: ../clone/virt-sysprep.pod:170
2794 msgid ""
2795 "Future versions of virt-sysprep may add more operations.  If you are using "
2796 "virt-sysprep and want predictable behaviour, specify only the operations "
2797 "that you want to have enabled."
2798 msgstr ""
2799
2800 #. type: =head2
2801 #: ../clone/virt-sysprep.pod:174
2802 msgid "cron-spool"
2803 msgstr ""
2804
2805 #. type: textblock
2806 #: ../clone/virt-sysprep.pod:176
2807 msgid "Remove user at-jobs and cron-jobs."
2808 msgstr ""
2809
2810 #. type: =head2
2811 #: ../clone/virt-sysprep.pod:178
2812 msgid "dhcp-client-state"
2813 msgstr ""
2814
2815 #. type: textblock
2816 #: ../clone/virt-sysprep.pod:180
2817 msgid "Remove DHCP client leases."
2818 msgstr ""
2819
2820 #. type: =head2
2821 #: ../clone/virt-sysprep.pod:182
2822 msgid "dhcp-server-state"
2823 msgstr ""
2824
2825 #. type: textblock
2826 #: ../clone/virt-sysprep.pod:184
2827 msgid "Remove DHCP server leases."
2828 msgstr ""
2829
2830 #. type: =head2
2831 #: ../clone/virt-sysprep.pod:186
2832 msgid "hostname"
2833 msgstr ""
2834
2835 #. type: textblock
2836 #: ../clone/virt-sysprep.pod:188
2837 msgid ""
2838 "Changes the hostname of the guest to the value given in the I<--hostname> "
2839 "parameter."
2840 msgstr ""
2841
2842 #. type: textblock
2843 #: ../clone/virt-sysprep.pod:191
2844 msgid ""
2845 "If the I<--hostname> parameter is not given, then the hostname is changed to "
2846 "C<localhost.localdomain>."
2847 msgstr ""
2848
2849 #. type: =head2
2850 #: ../clone/virt-sysprep.pod:194
2851 msgid "logfiles"
2852 msgstr ""
2853
2854 #. type: textblock
2855 #: ../clone/virt-sysprep.pod:196
2856 msgid "Remove many log files."
2857 msgstr ""
2858
2859 #. type: =head2
2860 #: ../clone/virt-sysprep.pod:198
2861 msgid "mail-spool"
2862 msgstr ""
2863
2864 #. type: textblock
2865 #: ../clone/virt-sysprep.pod:200
2866 msgid "Remove email from the local mail spool directory."
2867 msgstr ""
2868
2869 #. type: =head2
2870 #: ../clone/virt-sysprep.pod:202
2871 msgid "net-hwaddr"
2872 msgstr ""
2873
2874 #. type: textblock
2875 #: ../clone/virt-sysprep.pod:204
2876 msgid ""
2877 "Remove HWADDR (hard-coded MAC address) configuration.  For Fedora and Red "
2878 "Hat Enterprise Linux, this is removed from C<ifcfg-*> files."
2879 msgstr ""
2880
2881 #. type: =head2
2882 #: ../clone/virt-sysprep.pod:207
2883 msgid "random-seed"
2884 msgstr ""
2885
2886 #. type: textblock
2887 #: ../clone/virt-sysprep.pod:209
2888 msgid ""
2889 "Write some random bytes from the host into the random seed file of the "
2890 "guest."
2891 msgstr ""
2892
2893 #. type: textblock
2894 #: ../clone/virt-sysprep.pod:212
2895 msgid "See L</RANDOM SEED> below."
2896 msgstr ""
2897
2898 #. type: =head2
2899 #: ../clone/virt-sysprep.pod:214
2900 msgid "rhn-systemid"
2901 msgstr ""
2902
2903 #. type: textblock
2904 #: ../clone/virt-sysprep.pod:216
2905 msgid "Remove the RHN system ID."
2906 msgstr ""
2907
2908 #. type: =head2
2909 #: ../clone/virt-sysprep.pod:218
2910 msgid "smolt-uuid"
2911 msgstr ""
2912
2913 #. type: textblock
2914 #: ../clone/virt-sysprep.pod:220
2915 msgid "Remove the Smolt hardware UUID."
2916 msgstr ""
2917
2918 #. type: =head2
2919 #: ../clone/virt-sysprep.pod:222
2920 msgid "ssh-hostkeys"
2921 msgstr ""
2922
2923 #. type: textblock
2924 #: ../clone/virt-sysprep.pod:224
2925 msgid "Remove the SSH host keys in the guest."
2926 msgstr ""
2927
2928 #. type: textblock
2929 #: ../clone/virt-sysprep.pod:226
2930 msgid ""
2931 "The SSH host keys are regenerated (differently) next time the guest is "
2932 "booted."
2933 msgstr ""
2934
2935 #. type: textblock
2936 #: ../clone/virt-sysprep.pod:229
2937 msgid ""
2938 "If, after cloning, the guest gets the same IP address, ssh will give you a "
2939 "stark warning about the host key changing:"
2940 msgstr ""
2941
2942 #. type: verbatim
2943 #: ../clone/virt-sysprep.pod:232
2944 #, no-wrap
2945 msgid ""
2946 " @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@\n"
2947 " @    WARNING: REMOTE HOST IDENTIFICATION HAS CHANGED!     @\n"
2948 " @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@\n"
2949 " IT IS POSSIBLE THAT SOMEONE IS DOING SOMETHING NASTY!\n"
2950 "\n"
2951 msgstr ""
2952
2953 #. type: =head2
2954 #: ../clone/virt-sysprep.pod:237
2955 msgid "udev-persistent-net"
2956 msgstr ""
2957
2958 #. type: textblock
2959 #: ../clone/virt-sysprep.pod:239
2960 msgid ""
2961 "Remove udev persistent net rules which map the guest's existing MAC address "
2962 "to a fixed ethernet device (eg. eth0)."
2963 msgstr ""
2964
2965 #. type: textblock
2966 #: ../clone/virt-sysprep.pod:242
2967 msgid ""
2968 "After a guest is cloned, the MAC address usually changes.  Since the old MAC "
2969 "address occupies the old name (eg. eth0), this means the fresh MAC address "
2970 "is assigned to a new name (eg. eth1) and this is usually undesirable.  "
2971 "Erasing the udev persistent net rules avoids this."
2972 msgstr ""
2973
2974 #. type: =head2
2975 #: ../clone/virt-sysprep.pod:247
2976 msgid "utmp"
2977 msgstr ""
2978
2979 #. type: textblock
2980 #: ../clone/virt-sysprep.pod:249
2981 msgid "Remove the utmp file."
2982 msgstr ""
2983
2984 #. type: textblock
2985 #: ../clone/virt-sysprep.pod:251
2986 msgid ""
2987 "This records who is currently logged in on a machine.  In modern Linux "
2988 "distros it is stored in a ramdisk and hence not part of the virtual "
2989 "machine's disk, but it was stored on disk in older distros."
2990 msgstr ""
2991
2992 #. type: =head2
2993 #: ../clone/virt-sysprep.pod:255
2994 msgid "yum-uuid"
2995 msgstr ""
2996
2997 #. type: textblock
2998 #: ../clone/virt-sysprep.pod:257
2999 msgid "Remove the yum UUID."
3000 msgstr ""
3001
3002 #. type: textblock
3003 #: ../clone/virt-sysprep.pod:259
3004 msgid ""
3005 "Yum creates a fresh UUID the next time it runs when it notices that the "
3006 "original UUID has been erased."
3007 msgstr ""
3008
3009 #. type: =head1
3010 #: ../clone/virt-sysprep.pod:262
3011 msgid "COPYING AND CLONING"
3012 msgstr ""
3013
3014 #. type: textblock
3015 #: ../clone/virt-sysprep.pod:264
3016 msgid ""
3017 "Virt-sysprep can be used as part of a process of cloning guests, or to "
3018 "prepare a template from which guests can be cloned.  There are many "
3019 "different ways to achieve this using the virt tools, and this section is "
3020 "just an introduction."
3021 msgstr ""
3022
3023 #. type: textblock
3024 #: ../clone/virt-sysprep.pod:269
3025 msgid "A virtual machine (when switched off) consists of two parts:"
3026 msgstr ""
3027
3028 #. type: =item
3029 #: ../clone/virt-sysprep.pod:273
3030 msgid "I<configuration>"
3031 msgstr ""
3032
3033 #. type: textblock
3034 #: ../clone/virt-sysprep.pod:275
3035 msgid ""
3036 "The configuration or description of the guest.  eg. The libvirt XML (see "
3037 "C<virsh dumpxml>), the running configuration of the guest, or another "
3038 "external format like OVF."
3039 msgstr ""
3040
3041 #. type: textblock
3042 #: ../clone/virt-sysprep.pod:279
3043 msgid "Some configuration items that might need to be changed:"
3044 msgstr ""
3045
3046 #. type: textblock
3047 #: ../clone/virt-sysprep.pod:285
3048 msgid "name"
3049 msgstr ""
3050
3051 #. type: textblock
3052 #: ../clone/virt-sysprep.pod:289 ../clone/virt-sysprep.pod:316
3053 msgid "UUID"
3054 msgstr ""
3055
3056 #. type: textblock
3057 #: ../clone/virt-sysprep.pod:293
3058 msgid "path to block device(s)"
3059 msgstr ""
3060
3061 #. type: textblock
3062 #: ../clone/virt-sysprep.pod:297
3063 msgid "network card MAC address"
3064 msgstr ""
3065
3066 #. type: =item
3067 #: ../clone/virt-sysprep.pod:301
3068 msgid "I<block device(s)>"
3069 msgstr ""
3070
3071 #. type: textblock
3072 #: ../clone/virt-sysprep.pod:303
3073 msgid ""
3074 "One or more hard disk images, themselves containing files, directories, "
3075 "applications, kernels, configuration, etc."
3076 msgstr ""
3077
3078 #. type: textblock
3079 #: ../clone/virt-sysprep.pod:306
3080 msgid "Some things inside the block devices that might need to be changed:"
3081 msgstr ""
3082
3083 #. type: textblock
3084 #: ../clone/virt-sysprep.pod:312
3085 msgid "hostname and other net configuration"
3086 msgstr ""
3087
3088 #. type: textblock
3089 #: ../clone/virt-sysprep.pod:320
3090 msgid "SSH host keys"
3091 msgstr ""
3092
3093 #. type: textblock
3094 #: ../clone/virt-sysprep.pod:324
3095 msgid "Windows unique security ID (SID)"
3096 msgstr ""
3097
3098 #. type: textblock
3099 #: ../clone/virt-sysprep.pod:328
3100 msgid "Puppet registration"
3101 msgstr ""
3102
3103 #. type: =head2
3104 #: ../clone/virt-sysprep.pod:334
3105 msgid "COPYING THE BLOCK DEVICE"
3106 msgstr ""
3107
3108 #. type: textblock
3109 #: ../clone/virt-sysprep.pod:336
3110 msgid ""
3111 "Starting with an original guest, you probably wish to copy the guest block "
3112 "device and its configuration to make a template.  Then once you are happy "
3113 "with the template, you will want to make many clones from it."
3114 msgstr ""
3115
3116 #. type: verbatim
3117 #: ../clone/virt-sysprep.pod:341
3118 #, no-wrap
3119 msgid ""
3120 "                        virt-sysprep\n"
3121 "                             |\n"
3122 "                             v\n"
3123 " original guest --------> template ---------->\n"
3124 "                                      \\------> cloned\n"
3125 "                                       \\-----> guests\n"
3126 "                                        \\---->\n"
3127 "\n"
3128 msgstr ""
3129
3130 #. type: textblock
3131 #: ../clone/virt-sysprep.pod:349
3132 msgid ""
3133 "You can, of course, just copy the block device on the host using L<cp(1)> or "
3134 "L<dd(1)>."
3135 msgstr ""
3136
3137 #. type: verbatim
3138 #: ../clone/virt-sysprep.pod:352
3139 #, no-wrap
3140 msgid ""
3141 "                   dd                 dd\n"
3142 " original guest --------> template ---------->\n"
3143 "                                      \\------> cloned\n"
3144 "                                       \\-----> guests\n"
3145 "                                        \\---->\n"
3146 "\n"
3147 msgstr ""
3148
3149 #. type: textblock
3150 #: ../clone/virt-sysprep.pod:358
3151 msgid "There are some smarter (and faster) ways too:"
3152 msgstr ""
3153
3154 #. type: verbatim
3155 #: ../clone/virt-sysprep.pod:364
3156 #, no-wrap
3157 msgid ""
3158 "                          snapshot\n"
3159 "                template ---------->\n"
3160 "                            \\------> cloned\n"
3161 "                             \\-----> guests\n"
3162 "                              \\---->\n"
3163 "\n"
3164 msgstr ""
3165
3166 #. type: textblock
3167 #: ../clone/virt-sysprep.pod:370
3168 msgid ""
3169 "Use the block device as a backing file and create a snapshot on top for each "
3170 "guest.  The advantage is that you don't need to copy the block device (very "
3171 "fast) and only changes are stored (less storage required)."
3172 msgstr ""
3173
3174 #. type: textblock
3175 #: ../clone/virt-sysprep.pod:375
3176 msgid ""
3177 "Note that writing to the backing file once you have created guests on top of "
3178 "it is not possible: you will corrupt the guests."
3179 msgstr ""
3180
3181 #. type: textblock
3182 #: ../clone/virt-sysprep.pod:378
3183 msgid ""
3184 "Tools that can do this include: L<qemu-img(1)> (with the I<create -f qcow2 "
3185 "-o backing_file> option), L<lvcreate(8)> (I<--snapshot> option).  Some "
3186 "filesystems (such as btrfs) and most Network Attached Storage devices can "
3187 "also create cheap snapshots from files or LUNs."
3188 msgstr ""
3189
3190 #. type: textblock
3191 #: ../clone/virt-sysprep.pod:386
3192 msgid "Get your NAS to snapshot and/or duplicate the LUN."
3193 msgstr ""
3194
3195 #. type: textblock
3196 #: ../clone/virt-sysprep.pod:390
3197 msgid "Prepare your template using L<virt-sparsify(1)>.  See below."
3198 msgstr ""
3199
3200 #. type: =head2
3201 #: ../clone/virt-sysprep.pod:394
3202 msgid "VIRT-CLONE"
3203 msgstr ""
3204
3205 #. type: textblock
3206 #: ../clone/virt-sysprep.pod:396
3207 msgid ""
3208 "A separate tool, L<virt-clone(1)>, can be used to duplicate the block device "
3209 "and/or modify the external libvirt configuration of a guest.  It will reset "
3210 "the name, UUID and MAC address of the guest in the libvirt XML."
3211 msgstr ""
3212
3213 #. type: textblock
3214 #: ../clone/virt-sysprep.pod:401
3215 msgid ""
3216 "L<virt-clone(1)> does not use libguestfs and cannot look inside the disk "
3217 "image.  This was the original motivation to write virt-sysprep."
3218 msgstr ""
3219
3220 #. type: =head2
3221 #: ../clone/virt-sysprep.pod:404
3222 msgid "SPARSIFY"
3223 msgstr ""
3224
3225 #. type: verbatim
3226 #: ../clone/virt-sysprep.pod:406
3227 #, no-wrap
3228 msgid ""
3229 "              virt-sparsify\n"
3230 " original guest --------> template\n"
3231 "\n"
3232 msgstr ""
3233
3234 #. type: textblock
3235 #: ../clone/virt-sysprep.pod:409
3236 msgid ""
3237 "L<virt-sparsify(1)> can be used to make the cloning template smaller, making "
3238 "it easier to compress and/or faster to copy."
3239 msgstr ""
3240
3241 #. type: textblock
3242 #: ../clone/virt-sysprep.pod:412
3243 msgid ""
3244 "Notice that since virt-sparsify also copies the image, you can use it to "
3245 "make the initial copy (instead of C<dd>)."
3246 msgstr ""
3247
3248 #. type: =head2
3249 #: ../clone/virt-sysprep.pod:415
3250 msgid "RESIZE"
3251 msgstr ""
3252
3253 #. type: verbatim
3254 #: ../clone/virt-sysprep.pod:417
3255 #, no-wrap
3256 msgid ""
3257 "                         virt-resize\n"
3258 "                template ---------->\n"
3259 "                            \\------> cloned\n"
3260 "                             \\-----> guests\n"
3261 "                              \\---->\n"
3262 "\n"
3263 msgstr ""
3264
3265 #. type: textblock
3266 #: ../clone/virt-sysprep.pod:423
3267 msgid ""
3268 "If you want to give people cloned guests, but let them pick the size of the "
3269 "guest themselves (eg. depending on how much they are prepared to pay for "
3270 "disk space), then instead of copying the template, you can run "
3271 "L<virt-resize(1)>.  Virt-resize performs a copy and resize, and thus is "
3272 "ideal for cloning guests from a template."
3273 msgstr ""
3274
3275 #. type: =head1
3276 #: ../clone/virt-sysprep.pod:429 ../src/guestfs.pod:1164
3277 msgid "SECURITY"
3278 msgstr ""
3279
3280 #. type: textblock
3281 #: ../clone/virt-sysprep.pod:431
3282 msgid ""
3283 "Although virt-sysprep removes some sensitive information from the guest, it "
3284 "does not pretend to remove all of it.  You should examine the L</OPERATIONS> "
3285 "above, and the implementation of the operations in the shell script.  You "
3286 "should also examine the guest afterwards."
3287 msgstr ""
3288
3289 #. type: textblock
3290 #: ../clone/virt-sysprep.pod:436
3291 msgid ""
3292 "Sensitive files are simply removed.  The data they contained may still exist "
3293 "on the disk, easily recovered with a hex editor or undelete tool.  Use "
3294 "L<virt-sparsify(1)> as one way to remove this content.  See also the "
3295 "L<scrub(1)> command to get rid of deleted content in directory entries and "
3296 "inodes."
3297 msgstr ""
3298
3299 #. type: =head2
3300 #: ../clone/virt-sysprep.pod:442
3301 msgid "RANDOM SEED"
3302 msgstr ""
3303
3304 #. type: textblock
3305 #: ../clone/virt-sysprep.pod:444
3306 msgid "I<(This section applies to Linux guests only)>"
3307 msgstr ""
3308
3309 #. type: textblock
3310 #: ../clone/virt-sysprep.pod:446
3311 msgid ""
3312 "The virt-sysprep C<random-seed> operation writes a few bytes of randomness "
3313 "from the host into the guest's random seed file."
3314 msgstr ""
3315
3316 #. type: textblock
3317 #: ../clone/virt-sysprep.pod:449
3318 msgid ""
3319 "If this is just done once and the guest is cloned from the same template, "
3320 "then each guest will start with the same entropy, and things like SSH host "
3321 "keys and TCP sequence numbers may be predictable."
3322 msgstr ""
3323
3324 #. type: textblock
3325 #: ../clone/virt-sysprep.pod:453
3326 msgid ""
3327 "Therefore you should arrange to add more randomness I<after> cloning from a "
3328 "template too, which can be done by just enabling the C<random-seed> "
3329 "operation:"
3330 msgstr ""
3331
3332 #. type: verbatim
3333 #: ../clone/virt-sysprep.pod:457
3334 #, no-wrap
3335 msgid ""
3336 " cp template.img newguest.img\n"
3337 " virt-sysprep --enable=random-seed -a newguest.img\n"
3338 "\n"
3339 msgstr ""
3340
3341 #. type: =head2
3342 #: ../clone/virt-sysprep.pod:460
3343 msgid "SELINUX RELABELLING"
3344 msgstr ""
3345
3346 #. type: textblock
3347 #: ../clone/virt-sysprep.pod:462
3348 msgid "I<(This section applies to Linux guests using SELinux only)>"
3349 msgstr ""
3350
3351 #. type: textblock
3352 #: ../clone/virt-sysprep.pod:464
3353 msgid ""
3354 "If any new files are created by virt-sysprep, then virt-sysprep touches "
3355 "C</.autorelabel> so that these will be correctly labelled by SELinux the "
3356 "next time the guest is booted.  This process interrupts boot and can take "
3357 "some time."
3358 msgstr ""
3359
3360 #. type: textblock
3361 #: ../clone/virt-sysprep.pod:469
3362 msgid ""
3363 "You can force relabelling for all guests by supplying the "
3364 "I<--selinux-relabel> option."
3365 msgstr ""
3366
3367 #. type: textblock
3368 #: ../clone/virt-sysprep.pod:472
3369 msgid ""
3370 "You can disable relabelling entirely by supplying the "
3371 "I<--no-selinux-relabel> option."
3372 msgstr ""
3373
3374 #. type: textblock
3375 #: ../clone/virt-sysprep.pod:484
3376 msgid "This program returns 0 on success, or 1 if there was an error."
3377 msgstr ""
3378
3379 #. type: textblock
3380 #: ../clone/virt-sysprep.pod:488
3381 msgid ""
3382 "L<guestfs(3)>, L<guestfish(1)>, L<virt-clone(1)>, L<virt-rescue(1)>, "
3383 "L<virt-resize(1)>, L<virt-sparsify(1)>, L<virsh(1)>, L<lvcreate(8)>, "
3384 "L<qemu-img(1)>, L<scrub(1)>, L<http://libguestfs.org/>, "
3385 "L<http://libvirt.org/>."
3386 msgstr ""
3387
3388 #. type: textblock
3389 #: ../df/virt-df.pod:5
3390 msgid "virt-df - Display free space on virtual filesystems"
3391 msgstr ""
3392
3393 #. type: verbatim
3394 #: ../df/virt-df.pod:9
3395 #, no-wrap
3396 msgid ""
3397 " virt-df [--options]\n"
3398 "\n"
3399 msgstr ""
3400
3401 #. type: verbatim
3402 #: ../df/virt-df.pod:11
3403 #, no-wrap
3404 msgid ""
3405 " virt-df [--options] -d domname\n"
3406 "\n"
3407 msgstr ""
3408
3409 #. type: verbatim
3410 #: ../df/virt-df.pod:13
3411 #, no-wrap
3412 msgid ""
3413 " virt-df [--options] -a disk.img [-a disk.img ...]\n"
3414 "\n"
3415 msgstr ""
3416
3417 #. type: verbatim
3418 #: ../df/virt-df.pod:17
3419 #, no-wrap
3420 msgid ""
3421 " virt-df [--options] domname\n"
3422 "\n"
3423 msgstr ""
3424
3425 #. type: verbatim
3426 #: ../df/virt-df.pod:19
3427 #, no-wrap
3428 msgid ""
3429 " virt-df [--options] disk.img [disk.img ...]\n"
3430 "\n"
3431 msgstr ""
3432
3433 #. type: textblock
3434 #: ../df/virt-df.pod:23
3435 msgid ""
3436 "C<virt-df> is a command line tool to display free space on virtual machine "
3437 "filesystems.  Unlike other tools, it doesn't just display the size of disk "
3438 "allocated to a virtual machine, but can look inside disk images to see how "
3439 "much space is really being used."
3440 msgstr ""
3441
3442 #. type: textblock
3443 #: ../df/virt-df.pod:28
3444 msgid ""
3445 "If used without any I<-a> or I<-d> arguments, C<virt-df> checks with libvirt "
3446 "to get a list of all active and inactive guests, and performs a C<df>-type "
3447 "operation on each one in turn, printing out the results."
3448 msgstr ""
3449
3450 #. type: textblock
3451 #: ../df/virt-df.pod:32
3452 msgid ""
3453 "If any I<-a> or I<-d> arguments are specified, C<virt-df> performs a "
3454 "C<df>-type operation on either the single named libvirt domain, or on the "
3455 "disk image(s) listed on the command line (which must all belong to a single "
3456 "VM).  In this mode (with arguments), C<virt-df> will I<only work for a "
3457 "single guest>.  If you want to run on multiple guests, then you have to "
3458 "invoke C<virt-df> multiple times."
3459 msgstr ""
3460
3461 #. type: textblock
3462 #: ../df/virt-df.pod:39
3463 msgid ""
3464 "Use the I<--csv> option to get a format which can be easily parsed by other "
3465 "programs.  Other options are similar to the standard L<df(1)> command."
3466 msgstr ""
3467
3468 #. type: textblock
3469 #: ../df/virt-df.pod:45
3470 msgid ""
3471 "Show disk usage for a single libvirt guest called C<F14x64>.  Make the "
3472 "output human-readable:"
3473 msgstr ""
3474
3475 #. type: verbatim
3476 #: ../df/virt-df.pod:48
3477 #, no-wrap
3478 msgid ""
3479 " # virt-df -d F14x64 -h\n"
3480 " Filesystem                       Size     Used  Available  Use%\n"
3481 " F14x64:/dev/sda1                 484M      66M       393M   14%\n"
3482 " F14x64:/dev/vg_f13x64/lv_root    7.4G     3.4G       4.0G   46%\n"
3483 "\n"
3484 msgstr ""
3485
3486 #. type: textblock
3487 #: ../df/virt-df.pod:53
3488 msgid "Show disk usage for a disk image file called C<test.img>:"
3489 msgstr ""
3490
3491 #. type: verbatim
3492 #: ../df/virt-df.pod:55
3493 #, no-wrap
3494 msgid ""
3495 " $ virt-df -a test1.img\n"
3496 " Filesystem                  1K-blocks     Used  Available  Use%\n"
3497 " test1.img:/dev/sda1             99099     1551      92432    2%\n"
3498 "\n"
3499 msgstr ""
3500
3501 #. type: verbatim
3502 #: ../df/virt-df.pod:112
3503 #, no-wrap
3504 msgid ""
3505 " virt-df --format=raw -a disk.img\n"
3506 "\n"
3507 msgstr ""
3508
3509 #. type: verbatim
3510 #: ../df/virt-df.pod:116
3511 #, no-wrap
3512 msgid ""
3513 " virt-df --format=raw -a disk.img --format -a another.img\n"
3514 "\n"
3515 msgstr ""
3516
3517 #. type: textblock
3518 #: ../df/virt-df.pod:129
3519 msgid "Print sizes in human-readable format."
3520 msgstr ""
3521
3522 #. type: textblock
3523 #: ../df/virt-df.pod:131
3524 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
3525 msgstr ""
3526
3527 #. type: =item
3528 #: ../df/virt-df.pod:133 ../fish/guestfish.pod:258 ../fuse/guestmount.pod:164
3529 msgid "B<-i>"
3530 msgstr ""
3531
3532 #. type: =item
3533 #: ../df/virt-df.pod:135
3534 msgid "B<--inodes>"
3535 msgstr ""
3536
3537 #. type: textblock
3538 #: ../df/virt-df.pod:137
3539 msgid "Print inodes instead of blocks."
3540 msgstr ""
3541
3542 #. type: =item
3543 #: ../df/virt-df.pod:139
3544 msgid "B<--one-per-guest>"
3545 msgstr ""
3546
3547 #. type: textblock
3548 #: ../df/virt-df.pod:141
3549 msgid ""
3550 "Run one libguestfs appliance per guest.  Normally C<virt-df> will add the "
3551 "disks from several guests to a single libguestfs appliance."
3552 msgstr ""
3553
3554 #. type: textblock
3555 #: ../df/virt-df.pod:144
3556 msgid "You might use this option in the following circumstances:"
3557 msgstr ""
3558
3559 #. type: textblock
3560 #: ../df/virt-df.pod:150
3561 msgid ""
3562 "If you think an untrusted guest might actively try to exploit the libguestfs "
3563 "appliance kernel, then this prevents one guest from interfering with the "
3564 "stats printed for another guest."
3565 msgstr ""
3566
3567 #. type: textblock
3568 #: ../df/virt-df.pod:156
3569 msgid ""
3570 "If the kernel has a bug which stops it from accessing a filesystem in one "
3571 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
3572 "and report stats for further guests."
3573 msgstr ""
3574
3575 #. type: textblock
3576 #: ../df/virt-df.pod:165
3577 msgid ""
3578 "Print UUIDs instead of names.  This is useful for following a guest even "
3579 "when the guest is migrated or renamed, or when two guests happen to have the "
3580 "same name."
3581 msgstr ""
3582
3583 #. type: textblock
3584 #: ../df/virt-df.pod:169
3585 msgid ""
3586 "Note that only domains that we fetch from libvirt come with UUIDs.  For disk "
3587 "images, we still print the disk image name even when this option is "
3588 "specified."
3589 msgstr ""
3590
3591 #. type: textblock
3592 #: ../df/virt-df.pod:229
3593 msgid ""
3594 "L<df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
3595 "L<http://libguestfs.org/>."
3596 msgstr ""
3597
3598 #. type: textblock
3599 #: ../edit/virt-edit.pod:5
3600 msgid "virt-edit - Edit a file in a virtual machine"
3601 msgstr ""
3602
3603 #. type: verbatim
3604 #: ../edit/virt-edit.pod:9
3605 #, no-wrap
3606 msgid ""
3607 " virt-edit [--options] -d domname file [file ...]\n"
3608 "\n"
3609 msgstr ""
3610
3611 #. type: verbatim
3612 #: ../edit/virt-edit.pod:11
3613 #, no-wrap
3614 msgid ""
3615 " virt-edit [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
3616 "\n"
3617 msgstr ""
3618
3619 #. type: verbatim
3620 #: ../edit/virt-edit.pod:13
3621 #, no-wrap
3622 msgid ""
3623 " virt-edit [-d domname|-a disk.img] file -e 'expr'\n"
3624 "\n"
3625 msgstr ""
3626
3627 #. type: verbatim
3628 #: ../edit/virt-edit.pod:17
3629 #, no-wrap
3630 msgid ""
3631 " virt-edit domname file\n"
3632 "\n"
3633 msgstr ""
3634
3635 #. type: verbatim
3636 #: ../edit/virt-edit.pod:19 ../edit/virt-edit.pod:183
3637 #, no-wrap
3638 msgid ""
3639 " virt-edit disk.img [disk.img ...] file\n"
3640 "\n"
3641 msgstr ""
3642
3643 #. type: =head1
3644 #: ../edit/virt-edit.pod:21 ../fish/guestfish.pod:23 ../fish/virt-copy-in.pod:13 ../fish/virt-tar-in.pod:15 ../fuse/guestmount.pod:15 ../rescue/virt-rescue.pod:21 ../tools/virt-tar.pl:64 ../tools/virt-win-reg.pl:51
3645 msgid "WARNING"
3646 msgstr ""
3647
3648 #. type: textblock
3649 #: ../edit/virt-edit.pod:23
3650 msgid ""
3651 "You must I<not> use C<virt-edit> on live virtual machines.  If you do this, "
3652 "you risk disk corruption in the VM.  C<virt-edit> tries to stop you from "
3653 "doing this, but doesn't catch all cases."
3654 msgstr ""
3655
3656 #. type: textblock
3657 #: ../edit/virt-edit.pod:29
3658 msgid ""
3659 "C<virt-edit> is a command line tool to edit C<file> where each C<file> "
3660 "exists in the named virtual machine (or disk image)."
3661 msgstr ""
3662
3663 #. type: textblock
3664 #: ../edit/virt-edit.pod:32
3665 msgid ""
3666 "Multiple filenames can be given, in which case they are each edited in "
3667 "turn.  Each filename must be a full path, starting at the root directory "
3668 "(starting with '/')."
3669 msgstr ""
3670
3671 #. type: textblock
3672 #: ../edit/virt-edit.pod:36
3673 msgid "If you want to just view a file, use L<virt-cat(1)>."
3674 msgstr ""
3675
3676 #. type: textblock
3677 #: ../edit/virt-edit.pod:38
3678 msgid ""
3679 "For more complex cases you should look at the L<guestfish(1)> tool (see "
3680 "L</USING GUESTFISH> below)."
3681 msgstr ""
3682
3683 #. type: textblock
3684 #: ../edit/virt-edit.pod:41
3685 msgid ""
3686 "C<virt-edit> cannot be used to create a new file.  L<guestfish(1)> can do "
3687 "that and much more."
3688 msgstr ""
3689
3690 #. type: textblock
3691 #: ../edit/virt-edit.pod:46
3692 msgid "Edit the named files interactively:"
3693 msgstr ""
3694
3695 #. type: verbatim
3696 #: ../edit/virt-edit.pod:48
3697 #, no-wrap
3698 msgid ""
3699 " virt-edit -d mydomain /boot/grub/grub.conf\n"
3700 "\n"
3701 msgstr ""
3702
3703 #. type: verbatim
3704 #: ../edit/virt-edit.pod:50
3705 #, no-wrap
3706 msgid ""
3707 " virt-edit -d mydomain /etc/passwd\n"
3708 "\n"
3709 msgstr ""
3710
3711 #. type: textblock
3712 #: ../edit/virt-edit.pod:52
3713 msgid "For Windows guests, some Windows paths are understood:"
3714 msgstr ""
3715
3716 #. type: verbatim
3717 #: ../edit/virt-edit.pod:54
3718 #, no-wrap
3719 msgid ""
3720 " virt-edit -d mywindomain 'c:\\autoexec.bat'\n"
3721 "\n"
3722 msgstr ""
3723
3724 #. type: textblock
3725 #: ../edit/virt-edit.pod:56
3726 msgid ""
3727 "If Perl is installed, you can also edit files non-interactively (see "
3728 "L</NON-INTERACTIVE EDITING> below).  To change the init default level to 5:"
3729 msgstr ""
3730
3731 #. type: verbatim
3732 #: ../edit/virt-edit.pod:60
3733 #, no-wrap
3734 msgid ""
3735 " virt-edit -d mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
3736 "\n"
3737 msgstr ""
3738
3739 #. type: =item
3740 #: ../edit/virt-edit.pod:81
3741 msgid "B<-b> extension"
3742 msgstr ""
3743
3744 #. type: =item
3745 #: ../edit/virt-edit.pod:83
3746 msgid "B<--backup> extension"
3747 msgstr ""
3748
3749 #. type: textblock
3750 #: ../edit/virt-edit.pod:85
3751 msgid ""
3752 "Create a backup of the original file I<in the guest disk image>.  The backup "
3753 "has the original filename with C<extension> added."
3754 msgstr ""
3755
3756 #. type: textblock
3757 #: ../edit/virt-edit.pod:88
3758 msgid ""
3759 "Usually the first character of C<extension> would be a dot C<.> so you would "
3760 "write:"
3761 msgstr ""
3762
3763 #. type: verbatim
3764 #: ../edit/virt-edit.pod:91
3765 #, no-wrap
3766 msgid ""
3767 " virt-edit -b .orig [etc]\n"
3768 "\n"
3769 msgstr ""
3770
3771 #. type: textblock
3772 #: ../edit/virt-edit.pod:93
3773 msgid "By default, no backup file is made."
3774 msgstr ""
3775
3776 #. type: =item
3777 #: ../edit/virt-edit.pod:95 ../fish/guestfish.pod:181 ../fuse/guestmount.pod:105 ../inspector/virt-inspector.pod:74 ../tools/virt-list-filesystems.pl:77 ../tools/virt-list-partitions.pl:78 ../tools/virt-tar.pl:127 ../tools/virt-win-reg.pl:128
3778 msgid "B<-c URI>"
3779 msgstr ""
3780
3781 #. type: =item
3782 #: ../edit/virt-edit.pod:97 ../fish/guestfish.pod:183 ../fuse/guestmount.pod:107 ../inspector/virt-inspector.pod:76 ../tools/virt-list-filesystems.pl:79 ../tools/virt-list-partitions.pl:80 ../tools/virt-tar.pl:129 ../tools/virt-win-reg.pl:130
3783 msgid "B<--connect URI>"
3784 msgstr ""
3785
3786 #. type: textblock
3787 #: ../edit/virt-edit.pod:102 ../tools/virt-list-filesystems.pl:84 ../tools/virt-list-partitions.pl:85 ../tools/virt-tar.pl:134 ../tools/virt-win-reg.pl:135
3788 msgid ""
3789 "If you specify guest block devices directly, then libvirt is not used at "
3790 "all."
3791 msgstr ""
3792
3793 #. type: textblock
3794 #: ../edit/virt-edit.pod:114
3795 msgid ""
3796 "When prompting for keys and passphrases, virt-edit normally turns echoing "
3797 "off so you cannot see what you are typing.  If you are not worried about "
3798 "Tempest attacks and there is no one else in the room you can specify this "
3799 "flag to see what you are typing."
3800 msgstr ""
3801
3802 #. type: =item
3803 #: ../edit/virt-edit.pod:119
3804 msgid "B<-e> EXPR"
3805 msgstr ""
3806
3807 #. type: =item
3808 #: ../edit/virt-edit.pod:121
3809 msgid "B<--expr> EXPR"
3810 msgstr ""
3811
3812 #. type: textblock
3813 #: ../edit/virt-edit.pod:123
3814 msgid ""
3815 "Instead of launching the external editor, non-interactively apply the Perl "
3816 "expression C<EXPR> to each line in the file.  See L</NON-INTERACTIVE "
3817 "EDITING> below."
3818 msgstr ""
3819
3820 #. type: textblock
3821 #: ../edit/virt-edit.pod:127
3822 msgid ""
3823 "Be careful to properly quote the expression to prevent it from being altered "
3824 "by the shell."
3825 msgstr ""
3826
3827 #. type: textblock
3828 #: ../edit/virt-edit.pod:130
3829 msgid "Note that this option is only available when Perl 5 is installed."
3830 msgstr ""
3831
3832 #. type: =item
3833 #: ../edit/virt-edit.pod:132
3834 msgid "B<--format> raw|qcow2|..."
3835 msgstr ""
3836
3837 #. type: verbatim
3838 #: ../edit/virt-edit.pod:143
3839 #, no-wrap
3840 msgid ""
3841 " virt-edit --format=raw -a disk.img file\n"
3842 "\n"
3843 msgstr ""
3844
3845 #. type: verbatim
3846 #: ../edit/virt-edit.pod:147
3847 #, no-wrap
3848 msgid ""
3849 " virt-edit --format=raw -a disk.img --format -a another.img file\n"
3850 "\n"
3851 msgstr ""
3852
3853 #. type: textblock
3854 #: ../edit/virt-edit.pod:181
3855 msgid "Previous versions of virt-edit allowed you to write either:"
3856 msgstr ""
3857
3858 #. type: verbatim
3859 #: ../edit/virt-edit.pod:187
3860 #, no-wrap
3861 msgid ""
3862 " virt-edit guestname file\n"
3863 "\n"
3864 msgstr ""
3865
3866 #. type: =head1
3867 #: ../edit/virt-edit.pod:195
3868 msgid "NON-INTERACTIVE EDITING"
3869 msgstr ""
3870
3871 #. type: textblock
3872 #: ../edit/virt-edit.pod:197
3873 msgid ""
3874 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
3875 "administrator can interactively edit the file."
3876 msgstr ""
3877
3878 #. type: textblock
3879 #: ../edit/virt-edit.pod:200
3880 msgid ""
3881 "There are two ways also to use C<virt-edit> from scripts in order to make "
3882 "automated edits to files.  (Note that although you I<can> use C<virt-edit> "
3883 "like this, it's less error-prone to write scripts directly using the "
3884 "libguestfs API and Augeas for configuration file editing.)"
3885 msgstr ""
3886
3887 #. type: textblock
3888 #: ../edit/virt-edit.pod:206
3889 msgid ""
3890 "The first method is to temporarily set C<$EDITOR> to any script or program "
3891 "you want to run.  The script is invoked as C<$EDITOR tmpfile> and it should "
3892 "update C<tmpfile> in place however it likes."
3893 msgstr ""
3894
3895 #. type: textblock
3896 #: ../edit/virt-edit.pod:210
3897 msgid ""
3898 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
3899 "short Perl snippet in the style of L<sed(1)>.  For example to replace all "
3900 "instances of C<foo> with C<bar> in a file:"
3901 msgstr ""
3902
3903 #. type: verbatim
3904 #: ../edit/virt-edit.pod:214
3905 #, no-wrap
3906 msgid ""
3907 " virt-edit -d domname filename -e 's/foo/bar/'\n"
3908 "\n"
3909 msgstr ""
3910
3911 #. type: textblock
3912 #: ../edit/virt-edit.pod:216
3913 msgid ""
3914 "The full power of Perl regular expressions can be used (see L<perlre(1)>).  "
3915 "For example to delete root's password you could do:"
3916 msgstr ""
3917
3918 #. type: verbatim
3919 #: ../edit/virt-edit.pod:219
3920 #, no-wrap
3921 msgid ""
3922 " virt-edit -d domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
3923 "\n"
3924 msgstr ""
3925
3926 #. type: textblock
3927 #: ../edit/virt-edit.pod:221
3928 msgid ""
3929 "What really happens is that the snippet is evaluated as a Perl expression "
3930 "for each line of the file.  The line, including the final C<\\n>, is passed "
3931 "in C<$_> and the expression should update C<$_> or leave it unchanged."
3932 msgstr ""
3933
3934 #. type: textblock
3935 #: ../edit/virt-edit.pod:226
3936 msgid ""
3937 "To delete a line, set C<$_> to the empty string.  For example, to delete the "
3938 "C<apache> user account from the password file you can do:"
3939 msgstr ""
3940
3941 #. type: verbatim
3942 #: ../edit/virt-edit.pod:229
3943 #, no-wrap
3944 msgid ""
3945 " virt-edit -d mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
3946 "\n"
3947 msgstr ""
3948
3949 #. type: textblock
3950 #: ../edit/virt-edit.pod:231
3951 msgid ""
3952 "To insert a line, prepend or append it to C<$_>.  However appending lines to "
3953 "the end of the file is rather difficult this way since there is no concept "
3954 "of \"last line of the file\" - your expression just doesn't get called "
3955 "again.  You might want to use the first method (setting C<$EDITOR>) if you "
3956 "want to do this."
3957 msgstr ""
3958
3959 #. type: textblock
3960 #: ../edit/virt-edit.pod:237
3961 msgid ""
3962 "The variable C<$lineno> contains the current line number.  As is "
3963 "traditional, the first line in the file is number C<1>."
3964 msgstr ""
3965
3966 #. type: textblock
3967 #: ../edit/virt-edit.pod:240
3968 msgid ""
3969 "The return value from the expression is ignored, but the expression may call "
3970 "C<die> in order to abort the whole program, leaving the original file "
3971 "untouched."
3972 msgstr ""
3973
3974 #. type: textblock
3975 #: ../edit/virt-edit.pod:244
3976 msgid ""
3977 "Remember when matching the end of a line that C<$_> may contain the final "
3978 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
3979 "newline then neither of these.  Thus to match or substitute some text at the "
3980 "end of a line, use this regular expression:"
3981 msgstr ""
3982
3983 #. type: verbatim
3984 #: ../edit/virt-edit.pod:249
3985 #, no-wrap
3986 msgid ""
3987 " /some text(\\r?\\n)?$/\n"
3988 "\n"
3989 msgstr ""
3990
3991 #. type: textblock
3992 #: ../edit/virt-edit.pod:251
3993 msgid ""
3994 "Alternately, use the perl C<chomp> function, being careful not to chomp "
3995 "C<$_> itself (since that would remove all newlines from the file):"
3996 msgstr ""
3997
3998 #. type: verbatim
3999 #: ../edit/virt-edit.pod:255
4000 #, no-wrap
4001 msgid ""
4002 " my $m = $_; chomp $m; $m =~ /some text$/\n"
4003 "\n"
4004 msgstr ""
4005
4006 #. type: textblock
4007 #: ../edit/virt-edit.pod:259
4008 msgid ""
4009 "C<virt-edit> has a limited ability to understand Windows drive letters and "
4010 "paths (eg. C<E:\\foo\\bar.txt>)."
4011 msgstr ""
4012
4013 #. type: textblock
4014 #: ../edit/virt-edit.pod:278
4015 msgid ""
4016 "The path is resolved case insensitively to locate the file that should be "
4017 "edited."
4018 msgstr ""
4019
4020 #. type: textblock
4021 #: ../edit/virt-edit.pod:299
4022 msgid ""
4023 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
4024 "C<virt-edit> doesn't work."
4025 msgstr ""
4026
4027 #. type: textblock
4028 #: ../edit/virt-edit.pod:302
4029 msgid "Using C<virt-edit> is approximately equivalent to doing:"
4030 msgstr ""
4031
4032 #. type: verbatim
4033 #: ../edit/virt-edit.pod:304
4034 #, no-wrap
4035 msgid ""
4036 " guestfish --rw -i -d domname edit /file\n"
4037 "\n"
4038 msgstr ""
4039
4040 #. type: textblock
4041 #: ../edit/virt-edit.pod:306
4042 msgid ""
4043 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
4044 "path to the file."
4045 msgstr ""
4046
4047 #. type: textblock
4048 #: ../edit/virt-edit.pod:309
4049 msgid ""
4050 "The command above uses libguestfs's guest inspection feature and so does not "
4051 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
4052 "disk images that don't contain guests.  To edit a file on a disk image "
4053 "directly, use:"
4054 msgstr ""
4055
4056 #. type: verbatim
4057 #: ../edit/virt-edit.pod:314
4058 #, no-wrap
4059 msgid ""
4060 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
4061 "\n"
4062 msgstr ""
4063
4064 #. type: textblock
4065 #: ../edit/virt-edit.pod:316
4066 msgid ""
4067 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
4068 "the disk image to edit, and C</file> is the full path to the file."
4069 msgstr ""
4070
4071 #. type: textblock
4072 #: ../edit/virt-edit.pod:320
4073 msgid ""
4074 "C<virt-edit> cannot create new files.  Use the guestfish commands C<touch>, "
4075 "C<write> or C<upload> instead:"
4076 msgstr ""
4077
4078 #. type: verbatim
4079 #: ../edit/virt-edit.pod:323
4080 #, no-wrap
4081 msgid ""
4082 " guestfish --rw -i -d domname touch /newfile\n"
4083 "\n"
4084 msgstr ""
4085
4086 #. type: verbatim
4087 #: ../edit/virt-edit.pod:325
4088 #, no-wrap
4089 msgid ""
4090 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
4091 "\n"
4092 msgstr ""
4093
4094 #. type: verbatim
4095 #: ../edit/virt-edit.pod:327
4096 #, no-wrap
4097 msgid ""
4098 " guestfish --rw -i -d domname upload localfile /newfile\n"
4099 "\n"
4100 msgstr ""
4101
4102 #. type: =head1
4103 #: ../edit/virt-edit.pod:329 ../fish/guestfish.pod:1119 ../rescue/virt-rescue.pod:298 ../sparsify/virt-sparsify.pod:232 ../src/guestfs.pod:3209 ../test-tool/libguestfs-test-tool.pod:95
4104 msgid "ENVIRONMENT VARIABLES"
4105 msgstr ""
4106
4107 #. type: =item
4108 #: ../edit/virt-edit.pod:333
4109 msgid "C<EDITOR>"
4110 msgstr ""
4111
4112 #. type: textblock
4113 #: ../edit/virt-edit.pod:335
4114 msgid ""
4115 "If set, this string is used as the editor.  It may contain arguments, "
4116 "eg. C<\"emacs -nw\">"
4117 msgstr ""
4118
4119 #. type: textblock
4120 #: ../edit/virt-edit.pod:338
4121 msgid "If not set, C<vi> is used."
4122 msgstr ""
4123
4124 #. type: textblock
4125 #: ../edit/virt-edit.pod:356
4126 msgid ""
4127 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
4128 "L<virt-tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
4129 "L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
4130 msgstr ""
4131
4132 #. type: textblock
4133 #: ../erlang/examples/guestfs-erlang.pod:5
4134 msgid "guestfs-erlang - How to use libguestfs from Erlang"
4135 msgstr ""
4136
4137 #. type: verbatim
4138 #: ../erlang/examples/guestfs-erlang.pod:9
4139 #, no-wrap
4140 msgid ""
4141 " {ok, G} = guestfs:create(),\n"
4142 " ok = guestfs:add_drive_opts(G, Disk,\n"
4143 "                             [{format, \"raw\"}, {readonly, true}]),\n"
4144 " ok = guestfs:launch(G),\n"
4145 " [Device] = guestfs:list_devices(G),\n"
4146 " ok = guestfs:close(G).\n"
4147 "\n"
4148 msgstr ""
4149
4150 #. type: textblock
4151 #: ../erlang/examples/guestfs-erlang.pod:18
4152 msgid ""
4153 "This manual page documents how to call libguestfs from the Erlang "
4154 "programming language.  This page just documents the differences from the C "
4155 "API and gives some examples.  If you are not familiar with using libguestfs, "
4156 "you also need to read L<guestfs(3)>."
4157 msgstr ""
4158
4159 #. type: =head2
4160 #: ../erlang/examples/guestfs-erlang.pod:23
4161 msgid "OPENING AND CLOSING THE HANDLE"
4162 msgstr ""
4163
4164 #. type: textblock
4165 #: ../erlang/examples/guestfs-erlang.pod:25
4166 msgid ""
4167 "The Erlang bindings are implemented using an external program called "
4168 "C<erl-guestfs>.  This program must be on the current PATH, or else you "
4169 "should specify the full path to the program:"
4170 msgstr ""
4171
4172 #. type: verbatim
4173 #: ../erlang/examples/guestfs-erlang.pod:29
4174 #, no-wrap
4175 msgid ""
4176 " {ok, G} = guestfs:create().\n"
4177 "\n"
4178 msgstr ""
4179
4180 #. type: verbatim
4181 #: ../erlang/examples/guestfs-erlang.pod:31
4182 #, no-wrap
4183 msgid ""
4184 " {ok, G} = guestfs:create(\"/path/to/erl-guestfs\").\n"
4185 "\n"
4186 msgstr ""
4187
4188 #. type: textblock
4189 #: ../erlang/examples/guestfs-erlang.pod:33
4190 msgid "C<G> is the libguestfs handle which you should pass to other functions."
4191 msgstr ""
4192
4193 #. type: textblock
4194 #: ../erlang/examples/guestfs-erlang.pod:36
4195 msgid "To close the handle:"
4196 msgstr ""
4197
4198 #. type: verbatim
4199 #: ../erlang/examples/guestfs-erlang.pod:38
4200 #, no-wrap
4201 msgid ""
4202 " ok = guestfs:close(G).\n"
4203 "\n"
4204 msgstr ""
4205
4206 #. type: =head2
4207 #: ../erlang/examples/guestfs-erlang.pod:40
4208 msgid "FUNCTIONS WITH OPTIONAL ARGUMENTS"
4209 msgstr ""
4210
4211 #. type: textblock
4212 #: ../erlang/examples/guestfs-erlang.pod:42
4213 msgid ""
4214 "For functions that take optional arguments, the first arguments are the "
4215 "non-optional ones.  The last argument is a list of tuples supplying the "
4216 "remaining optional arguments."
4217 msgstr ""
4218
4219 #. type: verbatim
4220 #: ../erlang/examples/guestfs-erlang.pod:46
4221 #, no-wrap
4222 msgid ""
4223 " ok = guestfs:add_drive_opts(G, Disk,\n"
4224 "                             [{format, \"raw\"}, {readonly, true}]).\n"
4225 "\n"
4226 msgstr ""
4227
4228 #. type: textblock
4229 #: ../erlang/examples/guestfs-erlang.pod:49
4230 msgid "If the last argument would be an empty list, you can also omit it:"
4231 msgstr ""
4232
4233 #. type: verbatim
4234 #: ../erlang/examples/guestfs-erlang.pod:51
4235 #, no-wrap
4236 msgid ""
4237 " ok = guestfs:add_drive_opts(G, Disk).\n"
4238 "\n"
4239 msgstr ""
4240
4241 #. type: =head2
4242 #: ../erlang/examples/guestfs-erlang.pod:53
4243 msgid "RETURN VALUES AND ERRORS"
4244 msgstr ""
4245
4246 #. type: textblock
4247 #: ../erlang/examples/guestfs-erlang.pod:55
4248 msgid ""
4249 "On success, most functions return a C<Result> term (which could be a list, "
4250 "string, tuple etc.).  If there is nothing for the function to return, then "
4251 "the atom C<ok> is returned."
4252 msgstr ""
4253
4254 #. type: textblock
4255 #: ../erlang/examples/guestfs-erlang.pod:59
4256 msgid "On error, you would see one of the following tuples:"
4257 msgstr ""
4258
4259 #. type: =item
4260 #: ../erlang/examples/guestfs-erlang.pod:63
4261 msgid "C<{error, Msg, Errno}>"
4262 msgstr ""
4263
4264 #. type: textblock
4265 #: ../erlang/examples/guestfs-erlang.pod:65
4266 msgid "This indicates an ordinary error from the function."
4267 msgstr ""
4268
4269 #. type: textblock
4270 #: ../erlang/examples/guestfs-erlang.pod:67
4271 msgid ""
4272 "C<Msg> is the error message (string) and C<Errno> is the Unix error "
4273 "(integer)."
4274 msgstr ""
4275
4276 #. type: textblock
4277 #: ../erlang/examples/guestfs-erlang.pod:70
4278 msgid "C<Errno> can be zero.  See L<guestfs(3)/guestfs_last_errno>."
4279 msgstr ""
4280
4281 #. type: =item
4282 #: ../erlang/examples/guestfs-erlang.pod:72
4283 msgid "C<{unknown, Function}>"
4284 msgstr ""
4285
4286 #. type: textblock
4287 #: ../erlang/examples/guestfs-erlang.pod:74
4288 msgid ""
4289 "This indicates that the function you called is not known.  Generally this "
4290 "means you are mixing C<erl-guestfs> from another version of libguestfs, "
4291 "which you should not do."
4292 msgstr ""
4293
4294 #. type: textblock
4295 #: ../erlang/examples/guestfs-erlang.pod:78
4296 msgid "C<Function> is the name of the unknown function."
4297 msgstr ""
4298
4299 #. type: =item
4300 #: ../erlang/examples/guestfs-erlang.pod:80
4301 msgid "C<{unknownarg, Arg}>"
4302 msgstr ""
4303
4304 #. type: textblock
4305 #: ../erlang/examples/guestfs-erlang.pod:82
4306 msgid ""
4307 "This indicates that you called a function with optional arguments, with an "
4308 "unknown argument name."
4309 msgstr ""
4310
4311 #. type: textblock
4312 #: ../erlang/examples/guestfs-erlang.pod:85
4313 msgid "C<Arg> is the name of the unknown argument."
4314 msgstr ""
4315
4316 #. type: =head1
4317 #: ../erlang/examples/guestfs-erlang.pod:89 ../examples/guestfs-examples.pod:25 ../java/examples/guestfs-java.pod:37 ../ocaml/examples/guestfs-ocaml.pod:70 ../perl/examples/guestfs-perl.pod:31 ../python/examples/guestfs-python.pod:34 ../ruby/examples/guestfs-ruby.pod:28
4318 msgid "EXAMPLE 1: CREATE A DISK IMAGE"
4319 msgstr ""
4320
4321 #. type: textblock
4322 #: ../erlang/examples/guestfs-erlang.pod:91 ../examples/guestfs-examples.pod:27 ../java/examples/guestfs-java.pod:39 ../ocaml/examples/guestfs-ocaml.pod:72 ../perl/examples/guestfs-perl.pod:33 ../python/examples/guestfs-python.pod:36 ../ruby/examples/guestfs-ruby.pod:30
4323 msgid "@EXAMPLE1@"
4324 msgstr ""
4325
4326 #. type: =head1
4327 #: ../erlang/examples/guestfs-erlang.pod:93 ../examples/guestfs-examples.pod:29 ../java/examples/guestfs-java.pod:41 ../ocaml/examples/guestfs-ocaml.pod:74 ../perl/examples/guestfs-perl.pod:35 ../python/examples/guestfs-python.pod:38 ../ruby/examples/guestfs-ruby.pod:32
4328 msgid "EXAMPLE 2: INSPECT A VIRTUAL MACHINE DISK IMAGE"
4329 msgstr ""
4330
4331 #. type: textblock
4332 #: ../erlang/examples/guestfs-erlang.pod:95 ../examples/guestfs-examples.pod:31 ../java/examples/guestfs-java.pod:43 ../ocaml/examples/guestfs-ocaml.pod:76 ../perl/examples/guestfs-perl.pod:37 ../python/examples/guestfs-python.pod:40 ../ruby/examples/guestfs-ruby.pod:34
4333 msgid "@EXAMPLE2@"
4334 msgstr ""
4335
4336 #. type: textblock
4337 #: ../erlang/examples/guestfs-erlang.pod:99
4338 msgid ""
4339 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
4340 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
4341 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://www.erlang.org/>.  "
4342 "L<http://libguestfs.org/>."
4343 msgstr ""
4344
4345 #. type: =head1
4346 #: ../erlang/examples/guestfs-erlang.pod:110 ../examples/guestfs-examples.pod:45 ../examples/guestfs-recipes.pod:397 ../fish/guestfish.pod:1296 ../fish/virt-copy-in.pod:60 ../fish/virt-copy-out.pod:49 ../fish/virt-tar-in.pod:58 ../fish/virt-tar-out.pod:51 ../fuse/guestmount.pod:328 ../inspector/virt-inspector.pod:404 ../java/examples/guestfs-java.pod:58 ../ocaml/examples/guestfs-ocaml.pod:91 ../perl/examples/guestfs-perl.pod:52 ../python/examples/guestfs-python.pod:54 ../ruby/examples/guestfs-ruby.pod:48 ../src/guestfs.pod:3348 ../test-tool/libguestfs-test-tool.pod:106
4347 msgid "AUTHORS"
4348 msgstr ""
4349
4350 #. type: textblock
4351 #: ../erlang/examples/guestfs-erlang.pod:112 ../examples/guestfs-examples.pod:47 ../examples/guestfs-recipes.pod:399 ../fish/guestfish.pod:1298 ../fish/virt-copy-in.pod:62 ../fish/virt-copy-out.pod:51 ../fish/virt-tar-in.pod:60 ../fish/virt-tar-out.pod:53 ../fuse/guestmount.pod:330 ../java/examples/guestfs-java.pod:60 ../ocaml/examples/guestfs-ocaml.pod:93 ../perl/examples/guestfs-perl.pod:54 ../python/examples/guestfs-python.pod:56 ../ruby/examples/guestfs-ruby.pod:50 ../src/guestfs.pod:3350 ../test-tool/libguestfs-test-tool.pod:108
4352 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
4353 msgstr ""
4354
4355 #. type: textblock
4356 #: ../erlang/examples/guestfs-erlang.pod:116 ../java/examples/guestfs-java.pod:64 ../perl/examples/guestfs-perl.pod:58
4357 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
4358 msgstr ""
4359
4360 #. type: textblock
4361 #: ../erlang/examples/guestfs-erlang.pod:118 ../examples/guestfs-examples.pod:53 ../examples/guestfs-recipes.pod:405 ../java/examples/guestfs-java.pod:66 ../ocaml/examples/guestfs-ocaml.pod:99 ../perl/examples/guestfs-perl.pod:60 ../python/examples/guestfs-python.pod:62 ../ruby/examples/guestfs-ruby.pod:56
4362 msgid ""
4363 "The examples in this manual page may be freely copied, modified and "
4364 "distributed without any restrictions."
4365 msgstr ""
4366
4367 #. type: textblock
4368 #: ../erlang/examples/guestfs-erlang.pod:121 ../examples/guestfs-examples.pod:56 ../examples/guestfs-recipes.pod:408 ../java/examples/guestfs-java.pod:69 ../ocaml/examples/guestfs-ocaml.pod:102 ../perl/examples/guestfs-perl.pod:63 ../python/examples/guestfs-python.pod:65 ../ruby/examples/guestfs-ruby.pod:59 ../src/guestfs.pod:3357
4369 msgid ""
4370 "This library is free software; you can redistribute it and/or modify it "
4371 "under the terms of the GNU Lesser General Public License as published by the "
4372 "Free Software Foundation; either version 2 of the License, or (at your "
4373 "option) any later version."
4374 msgstr ""
4375
4376 #. type: textblock
4377 #: ../erlang/examples/guestfs-erlang.pod:126 ../examples/guestfs-examples.pod:61 ../examples/guestfs-recipes.pod:413 ../java/examples/guestfs-java.pod:74 ../ocaml/examples/guestfs-ocaml.pod:107 ../perl/examples/guestfs-perl.pod:68 ../python/examples/guestfs-python.pod:70 ../ruby/examples/guestfs-ruby.pod:64 ../src/guestfs.pod:3362
4378 msgid ""
4379 "This library is distributed in the hope that it will be useful, but WITHOUT "
4380 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
4381 "FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License "
4382 "for more details."
4383 msgstr ""
4384
4385 #. type: textblock
4386 #: ../erlang/examples/guestfs-erlang.pod:131 ../examples/guestfs-examples.pod:66 ../examples/guestfs-recipes.pod:418 ../java/examples/guestfs-java.pod:79 ../ocaml/examples/guestfs-ocaml.pod:112 ../perl/examples/guestfs-perl.pod:73 ../python/examples/guestfs-python.pod:75 ../ruby/examples/guestfs-ruby.pod:69 ../src/guestfs.pod:3367
4387 msgid ""
4388 "You should have received a copy of the GNU Lesser General Public License "
4389 "along with this library; if not, write to the Free Software Foundation, "
4390 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
4391 msgstr ""
4392
4393 #. type: textblock
4394 #: ../examples/guestfs-examples.pod:5
4395 msgid "guestfs-examples - Examples of using libguestfs from C"
4396 msgstr ""
4397
4398 #. type: verbatim
4399 #: ../examples/guestfs-examples.pod:9 ../src/guestfs.pod:9
4400 #, no-wrap
4401 msgid ""
4402 " #include <guestfs.h>\n"
4403 " \n"
4404 msgstr ""
4405
4406 #. type: verbatim
4407 #: ../examples/guestfs-examples.pod:11
4408 #, no-wrap
4409 msgid ""
4410 " guestfs_h *g = guestfs_create ();\n"
4411 " guestfs_add_drive_ro (g, \"disk.img\");\n"
4412 " guestfs_launch (g);\n"
4413 "\n"
4414 msgstr ""
4415
4416 #. type: verbatim
4417 #: ../examples/guestfs-examples.pod:15 ../src/guestfs.pod:19
4418 #, no-wrap
4419 msgid ""
4420 " cc prog.c -o prog -lguestfs\n"
4421 "or:\n"
4422 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
4423 "\n"
4424 msgstr ""
4425
4426 #. type: textblock
4427 #: ../examples/guestfs-examples.pod:21
4428 msgid ""
4429 "This manual page contains examples of calling libguestfs from the C "
4430 "programming language.  If you are not familiar with using libguestfs, you "
4431 "also need to read L<guestfs(3)>."
4432 msgstr ""
4433
4434 #. type: textblock
4435 #: ../examples/guestfs-examples.pod:35
4436 msgid ""
4437 "L<guestfs(3)>, L<guestfs-erlang(3)>, L<guestfs-java(3)>, "
4438 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
4439 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
4440 msgstr ""
4441
4442 #. type: textblock
4443 #: ../examples/guestfs-examples.pod:51 ../ocaml/examples/guestfs-ocaml.pod:97 ../python/examples/guestfs-python.pod:60 ../ruby/examples/guestfs-ruby.pod:54
4444 msgid "Copyright (C) 2010 Red Hat Inc. L<http://libguestfs.org/>"
4445 msgstr ""
4446
4447 #. type: =end
4448 #: ../examples/guestfs-recipes.pod:3 ../examples/guestfs-recipes.pod:12
4449 msgid "comment"
4450 msgstr ""
4451
4452 #. type: textblock
4453 #: ../examples/guestfs-recipes.pod:5
4454 msgid ""
4455 "pod2man and pod2html have differing bugs which makes it hard to write URLs "
4456 "here.  The only way which works for both sorts of output is to just write "
4457 "the URL directly.  Do NOT use L<...> for URLs."
4458 msgstr ""
4459
4460 #. type: textblock
4461 #: ../examples/guestfs-recipes.pod:9
4462 msgid ""
4463 "We break with tradition here and don't use ALL CAPS for the section "
4464 "headings, as this makes them much easier to read."
4465 msgstr ""
4466
4467 #. type: textblock
4468 #: ../examples/guestfs-recipes.pod:16
4469 msgid "guestfs-recipes - libguestfs, guestfish and virt tools recipes"
4470 msgstr ""
4471
4472 #. type: textblock
4473 #: ../examples/guestfs-recipes.pod:20
4474 msgid ""
4475 "This page contains recipes for and links to things you can do using "
4476 "libguestfs, L<guestfish(1)> and the virt tools."
4477 msgstr ""
4478
4479 #. type: =head1
4480 #: ../examples/guestfs-recipes.pod:23
4481 msgid "Audit a virtual machine for setuid files"
4482 msgstr ""
4483
4484 #. type: textblock
4485 #: ../examples/guestfs-recipes.pod:25
4486 msgid ""
4487 "The link below contains a small program which can be used to audit a Linux "
4488 "virtual machine to see what setuid and setgid files it contains."
4489 msgstr ""
4490
4491 #. type: textblock
4492 #: ../examples/guestfs-recipes.pod:28
4493 msgid "https://rwmj.wordpress.com/2010/12/15/tip-audit-virtual-machine-for-setuid-files/#content"
4494 msgstr ""
4495
4496 #. type: =head1
4497 #: ../examples/guestfs-recipes.pod:30
4498 msgid "Change the background image in a Windows XP VM"
4499 msgstr ""
4500
4501 #. type: textblock
4502 #: ../examples/guestfs-recipes.pod:32
4503 msgid ""
4504 "The links below explain how to use L<guestfish(1)> to change the background "
4505 "image for a user of a Windows XP VM.  Unfortunately the technique appears to "
4506 "be substantially different for each version of Windows."
4507 msgstr ""
4508
4509 #. type: textblock
4510 #: ../examples/guestfs-recipes.pod:37
4511 msgid ""
4512 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002655.html "
4513 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002658.html"
4514 msgstr ""
4515
4516 #. type: =head1
4517 #: ../examples/guestfs-recipes.pod:40
4518 msgid "Cloning a virtual machine (Linux)"
4519 msgstr ""
4520
4521 #. type: textblock
4522 #: ../examples/guestfs-recipes.pod:42
4523 msgid ""
4524 "The guestfish technique described in the link below works well for most "
4525 "Linux VMs.  Depending on the Linux distro you may need to change the paths "
4526 "slightly."
4527 msgstr ""
4528
4529 #. type: textblock
4530 #: ../examples/guestfs-recipes.pod:46
4531 msgid "https://rwmj.wordpress.com/2010/09/24/tip-my-procedure-for-cloning-a-fedora-vm/#content"
4532 msgstr ""
4533
4534 #. type: textblock
4535 #: ../examples/guestfs-recipes.pod:48
4536 msgid ""
4537 "Avoid L<virt-clone(1)>.  Currently what to do about virt-clone is under "
4538 "discussion."
4539 msgstr ""
4540
4541 #. type: textblock
4542 #: ../examples/guestfs-recipes.pod:51
4543 msgid "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
4544 msgstr ""
4545
4546 #. type: =head1
4547 #: ../examples/guestfs-recipes.pod:53
4548 msgid "Cloning a virtual machine (Windows)"
4549 msgstr ""
4550
4551 #. type: textblock
4552 #: ../examples/guestfs-recipes.pod:55
4553 msgid ""
4554 "It is possible to do a \"sysprep\" using libguestfs alone, although not "
4555 "straightforward.  Currently there is code in the Aeolus Oz project which "
4556 "does this (using libguestfs).  As part of our review of the virt-clone tool, "
4557 "we may add sysprepping ability."
4558 msgstr ""
4559
4560 #. type: textblock
4561 #: ../examples/guestfs-recipes.pod:60
4562 msgid ""
4563 "https://github.com/clalancette/oz "
4564 "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
4565 msgstr ""
4566
4567 #. type: =head1
4568 #: ../examples/guestfs-recipes.pod:63
4569 msgid "Convert a CD-ROM / DVD / ISO to a tarball"
4570 msgstr ""
4571
4572 #. type: textblock
4573 #: ../examples/guestfs-recipes.pod:65
4574 msgid "This converts input C<cd.iso> to output C<cd.tar.gz>:"
4575 msgstr ""
4576
4577 #. type: verbatim
4578 #: ../examples/guestfs-recipes.pod:67
4579 #, no-wrap
4580 msgid ""
4581 " guestfish --ro -a cd.iso -m /dev/sda tgz-out / cd.tar.gz\n"
4582 "\n"
4583 msgstr ""
4584
4585 #. type: textblock
4586 #: ../examples/guestfs-recipes.pod:69
4587 msgid "To export just a subdirectory, eg. C</files>, do:"
4588 msgstr ""
4589
4590 #. type: verbatim
4591 #: ../examples/guestfs-recipes.pod:71
4592 #, no-wrap
4593 msgid ""
4594 " guestfish --ro -a cd.iso -m /dev/sda tgz-out /files cd.tar.gz\n"
4595 "\n"
4596 msgstr ""
4597
4598 #. type: =head1
4599 #: ../examples/guestfs-recipes.pod:73
4600 msgid "Create empty disk images"
4601 msgstr ""
4602
4603 #. type: textblock
4604 #: ../examples/guestfs-recipes.pod:75
4605 msgid ""
4606 "You can use the L<guestfish(1)> I<-N> option to create empty disk images.  "
4607 "The useful guide below explains the options available."
4608 msgstr ""
4609
4610 #. type: textblock
4611 #: ../examples/guestfs-recipes.pod:78
4612 msgid "https://rwmj.wordpress.com/2010/09/08/new-guestfish-n-options-in-1-5-9/#content"
4613 msgstr ""
4614
4615 #. type: =head1
4616 #: ../examples/guestfs-recipes.pod:80
4617 msgid "Dump raw filesystem content from inside a disk image or VM"
4618 msgstr ""
4619
4620 #. type: textblock
4621 #: ../examples/guestfs-recipes.pod:82
4622 msgid ""
4623 "You can use the L<guestfish(1)> C<download> command to extract the raw "
4624 "filesystem content from any filesystem in a disk image or a VM (even one "
4625 "which is encrypted or buried inside an LV):"
4626 msgstr ""
4627
4628 #. type: verbatim
4629 #: ../examples/guestfs-recipes.pod:86
4630 #, no-wrap
4631 msgid ""
4632 " guestfish --ro -a disk.img run : download /dev/sda1 sda1.img\n"
4633 "\n"
4634 msgstr ""
4635
4636 #. type: verbatim
4637 #: ../examples/guestfs-recipes.pod:88
4638 #, no-wrap
4639 msgid ""
4640 " guestfish --ro -d Guest run : download /dev/vg_guest/lv_root lv.img\n"
4641 "\n"
4642 msgstr ""
4643
4644 #. type: textblock
4645 #: ../examples/guestfs-recipes.pod:90
4646 msgid "To list the filesystems in a disk image, use L<virt-filesystems(1)>."
4647 msgstr ""
4648
4649 #. type: =head1
4650 #: ../examples/guestfs-recipes.pod:92
4651 msgid "Edit grub configuration in a VM"
4652 msgstr ""
4653
4654 #. type: textblock
4655 #: ../examples/guestfs-recipes.pod:94
4656 msgid "You can use this to:"
4657 msgstr ""
4658
4659 #. type: textblock
4660 #: ../examples/guestfs-recipes.pod:100
4661 msgid "Fix a virtual machine that does not boot."
4662 msgstr ""
4663
4664 #. type: textblock
4665 #: ../examples/guestfs-recipes.pod:104
4666 msgid "Change which kernel is used to boot the VM."
4667 msgstr ""
4668
4669 #. type: textblock
4670 #: ../examples/guestfs-recipes.pod:108
4671 msgid "Change kernel command line options."
4672 msgstr ""
4673
4674 #. type: textblock
4675 #: ../examples/guestfs-recipes.pod:112
4676 msgid "Use L<virt-edit(1)> to edit the grub configuration:"
4677 msgstr ""
4678
4679 #. type: verbatim
4680 #: ../examples/guestfs-recipes.pod:114
4681 #, no-wrap
4682 msgid ""
4683 " virt-edit -d BrokenGuest /boot/grub/grub.conf\n"
4684 "\n"
4685 msgstr ""
4686
4687 #. type: textblock
4688 #: ../examples/guestfs-recipes.pod:116
4689 msgid ""
4690 "or for general tinkering inside an unbootable VM use L<virt-rescue(1)> like "
4691 "this:"
4692 msgstr ""
4693
4694 #. type: verbatim
4695 #: ../examples/guestfs-recipes.pod:119
4696 #, no-wrap
4697 msgid ""
4698 " virt-rescue -d BrokenGuest\n"
4699 "\n"
4700 msgstr ""
4701
4702 #. type: =head1
4703 #: ../examples/guestfs-recipes.pod:121
4704 msgid "Export any directory from a VM"
4705 msgstr ""
4706
4707 #. type: textblock
4708 #: ../examples/guestfs-recipes.pod:123
4709 msgid "To export C</home> from a VM into a local directory use L<virt-copy-out(1)>:"
4710 msgstr ""
4711
4712 #. type: verbatim
4713 #: ../examples/guestfs-recipes.pod:126
4714 #, no-wrap
4715 msgid ""
4716 " virt-copy-out -d Guest /home .\n"
4717 "\n"
4718 msgstr ""
4719
4720 #. type: textblock
4721 #: ../examples/guestfs-recipes.pod:128 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1450 ../fish/guestfish-actions.pod:1715 ../fish/guestfish-actions.pod:2132 ../src/guestfs-actions.pod:18 ../src/guestfs-actions.pod:2334 ../src/guestfs-actions.pod:2758 ../src/guestfs-actions.pod:3317 ../src/guestfs.pod:1685 ../tools/virt-win-reg.pl:717
4722 msgid "Notes:"
4723 msgstr ""
4724
4725 #. type: textblock
4726 #: ../examples/guestfs-recipes.pod:134
4727 msgid ""
4728 "The final dot of the command is not a printing error.  It means we want to "
4729 "copy out to the current directory."
4730 msgstr ""
4731
4732 #. type: textblock
4733 #: ../examples/guestfs-recipes.pod:139
4734 msgid "This creates a directory called C<home> under the current directory."
4735 msgstr ""
4736
4737 #. type: textblock
4738 #: ../examples/guestfs-recipes.pod:143
4739 msgid ""
4740 "If the guest is a Windows guest then you can use drive letters and "
4741 "backslashes, but you must prefix the path with C<win:> and quote it to "
4742 "protect it from the shell, like this:"
4743 msgstr ""
4744
4745 #. type: verbatim
4746 #: ../examples/guestfs-recipes.pod:147
4747 #, no-wrap
4748 msgid ""
4749 " virt-copy-out -d WinGuest 'win:c:\\windows\\system32\\config' .\n"
4750 "\n"
4751 msgstr ""
4752
4753 #. type: textblock
4754 #: ../examples/guestfs-recipes.pod:149
4755 msgid "To get the output as a compressed tarball, do:"
4756 msgstr ""
4757
4758 #. type: verbatim
4759 #: ../examples/guestfs-recipes.pod:151
4760 #, no-wrap
4761 msgid ""
4762 " virt-tar-out -d Guest /home - | gzip --best > home.tar.gz\n"
4763 "\n"
4764 msgstr ""
4765
4766 #. type: textblock
4767 #: ../examples/guestfs-recipes.pod:153
4768 msgid ""
4769 "Although it sounds tempting, this is usually not a reliable way to get a "
4770 "backup from a running guest.  See the entry in the FAQ: "
4771 "http://libguestfs.org/FAQ.html#backup"
4772 msgstr ""
4773
4774 #. type: =head1
4775 #: ../examples/guestfs-recipes.pod:157
4776 msgid "Find out which user is using the most space"
4777 msgstr ""
4778
4779 #. type: textblock
4780 #: ../examples/guestfs-recipes.pod:159
4781 msgid ""
4782 "This simple script examines a Linux guest to find out which user is using "
4783 "the most space in their home directory:"
4784 msgstr ""
4785
4786 #. type: verbatim
4787 #: ../examples/guestfs-recipes.pod:162
4788 #, no-wrap
4789 msgid ""
4790 " #!/bin/sh -\n"
4791 " \n"
4792 msgstr ""
4793
4794 #. type: verbatim
4795 #: ../examples/guestfs-recipes.pod:164 ../fish/guestfish.pod:984
4796 #, no-wrap
4797 msgid ""
4798 " set -e\n"
4799 " \n"
4800 msgstr ""
4801
4802 #. type: verbatim
4803 #: ../examples/guestfs-recipes.pod:166
4804 #, no-wrap
4805 msgid ""
4806 " vm=\"$1\"\n"
4807 " dir=/home\n"
4808 " \n"
4809 msgstr ""
4810
4811 #. type: verbatim
4812 #: ../examples/guestfs-recipes.pod:169
4813 #, no-wrap
4814 msgid ""
4815 " eval $(guestfish --ro -d \"$vm\" -i --listen)\n"
4816 " \n"
4817 msgstr ""
4818
4819 #. type: verbatim
4820 #: ../examples/guestfs-recipes.pod:171
4821 #, no-wrap
4822 msgid ""
4823 " for d in $(guestfish --remote ls \"$dir\"); do\n"
4824 "     echo -n \"$dir/$d\"\n"
4825 "     echo -ne '\\t'\n"
4826 "     guestfish --remote du \"$dir/$d\";\n"
4827 " done | sort -nr -k 2\n"
4828 " \n"
4829 msgstr ""
4830
4831 #. type: verbatim
4832 #: ../examples/guestfs-recipes.pod:177 ../fish/guestfish.pod:941
4833 #, no-wrap
4834 msgid ""
4835 " guestfish --remote exit\n"
4836 "\n"
4837 msgstr ""
4838
4839 #. type: =head1
4840 #: ../examples/guestfs-recipes.pod:179
4841 msgid "Get DHCP address from a VM"
4842 msgstr ""
4843
4844 #. type: textblock
4845 #: ../examples/guestfs-recipes.pod:181
4846 msgid ""
4847 "The link below explains the many different possible techniques for getting "
4848 "the last assigned DHCP address of a virtual machine."
4849 msgstr ""
4850
4851 #. type: textblock
4852 #: ../examples/guestfs-recipes.pod:184
4853 msgid "https://rwmj.wordpress.com/2011/03/31/tip-code-for-getting-dhcp-address-from-a-virtual-machine-disk-image/#content"
4854 msgstr ""
4855
4856 #. type: textblock
4857 #: ../examples/guestfs-recipes.pod:186
4858 msgid ""
4859 "In the libguestfs source examples directory you will find the latest version "
4860 "of the C<virt-dhcp-address.c> program."
4861 msgstr ""
4862
4863 #. type: =head1
4864 #: ../examples/guestfs-recipes.pod:189
4865 msgid "Get the operating system product name string"
4866 msgstr ""
4867
4868 #. type: textblock
4869 #: ../examples/guestfs-recipes.pod:191
4870 msgid "Save the following script into a file called C<product-name.sh>:"
4871 msgstr ""
4872
4873 #. type: verbatim
4874 #: ../examples/guestfs-recipes.pod:193
4875 #, no-wrap
4876 msgid ""
4877 " #!/bin/sh -\n"
4878 " set -e\n"
4879 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
4880 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
4881 " guestfish --remote inspect-get-product-name \"$root\"\n"
4882 " guestfish --remote exit\n"
4883 "\n"
4884 msgstr ""
4885
4886 #. type: textblock
4887 #: ../examples/guestfs-recipes.pod:200
4888 msgid "Make the script executable and run it on a named guest:"
4889 msgstr ""
4890
4891 #. type: verbatim
4892 #: ../examples/guestfs-recipes.pod:202
4893 #, no-wrap
4894 msgid ""
4895 " # product-name.sh RHEL60x64\n"
4896 " Red Hat Enterprise Linux Server release 6.0 (Santiago)\n"
4897 "\n"
4898 msgstr ""
4899
4900 #. type: textblock
4901 #: ../examples/guestfs-recipes.pod:205
4902 msgid ""
4903 "You can also use an XPath query on the L<virt-inspector(1)> XML using the "
4904 "C<xpath> command line tool or from your favourite programming language:"
4905 msgstr ""
4906
4907 #. type: verbatim
4908 #: ../examples/guestfs-recipes.pod:209
4909 #, no-wrap
4910 msgid ""
4911 " # virt-inspector RHEL60x64 > xml\n"
4912 " # xpath '//product_name' < xml\n"
4913 " Found 1 nodes:\n"
4914 " -- NODE --\n"
4915 " <product_name>Red Hat Enterprise Linux Server release 6.0 "
4916 "(Santiago)</product_name>\n"
4917 "\n"
4918 msgstr ""
4919
4920 #. type: =head1
4921 #: ../examples/guestfs-recipes.pod:215
4922 msgid "Get the default boot kernel for a Linux VM"
4923 msgstr ""
4924
4925 #. type: textblock
4926 #: ../examples/guestfs-recipes.pod:217
4927 msgid ""
4928 "The link below contains a program to print the default boot kernel for a "
4929 "Linux VM."
4930 msgstr ""
4931
4932 #. type: textblock
4933 #: ../examples/guestfs-recipes.pod:220
4934 msgid "https://rwmj.wordpress.com/2010/10/30/tip-use-augeas-to-get-the-default-boot-kernel-for-a-vm/#content"
4935 msgstr ""
4936
4937 #. type: textblock
4938 #: ../examples/guestfs-recipes.pod:222
4939 msgid ""
4940 "It uses Augeas, and the technique is generally applicable for many different "
4941 "tasks, such as:"
4942 msgstr ""
4943
4944 #. type: textblock
4945 #: ../examples/guestfs-recipes.pod:229
4946 msgid "listing the user accounts in the guest"
4947 msgstr ""
4948
4949 #. type: textblock
4950 #: ../examples/guestfs-recipes.pod:233
4951 msgid "what repositories is it configured to use"
4952 msgstr ""
4953
4954 #. type: textblock
4955 #: ../examples/guestfs-recipes.pod:237
4956 msgid "what NTP servers does it connect to"
4957 msgstr ""
4958
4959 #. type: textblock
4960 #: ../examples/guestfs-recipes.pod:241
4961 msgid "what were the boot messages last time it booted"
4962 msgstr ""
4963
4964 #. type: textblock
4965 #: ../examples/guestfs-recipes.pod:245
4966 msgid "listing who was logged in recently"
4967 msgstr ""
4968
4969 #. type: textblock
4970 #: ../examples/guestfs-recipes.pod:249
4971 msgid "http://augeas.net/"
4972 msgstr ""
4973
4974 #. type: =head1
4975 #: ../examples/guestfs-recipes.pod:251
4976 msgid "Install RPMs in a guest"
4977 msgstr ""
4978
4979 #. type: textblock
4980 #: ../examples/guestfs-recipes.pod:253
4981 msgid ""
4982 "The link below contains a method to install RPMs in a guest.  In fact the "
4983 "RPMs are just uploaded to the guest along with a \"firstboot\" script that "
4984 "installs them next time the guest is booted.  You could use this technique "
4985 "to install vital security updates in an offline guest."
4986 msgstr ""
4987
4988 #. type: textblock
4989 #: ../examples/guestfs-recipes.pod:259
4990 msgid "https://rwmj.wordpress.com/2010/12/01/tip-install-rpms-in-a-guest/#content"
4991 msgstr ""
4992
4993 #. type: =head1
4994 #: ../examples/guestfs-recipes.pod:261
4995 msgid "List applications installed in a VM"
4996 msgstr ""
4997
4998 #. type: textblock
4999 #: ../examples/guestfs-recipes.pod:263
5000 msgid "Save the following to a file C<list-apps.sh>:"
5001 msgstr ""
5002
5003 #. type: verbatim
5004 #: ../examples/guestfs-recipes.pod:265
5005 #, no-wrap
5006 msgid ""
5007 " #!/bin/sh -\n"
5008 " set -e\n"
5009 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
5010 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
5011 " guestfish --remote inspect-list-applications \"$root\"\n"
5012 " guestfish --remote exit\n"
5013 "\n"
5014 msgstr ""
5015
5016 #. type: textblock
5017 #: ../examples/guestfs-recipes.pod:272
5018 msgid ""
5019 "Make the file executable and then you can run it on any named virtual "
5020 "machine:"
5021 msgstr ""
5022
5023 #. type: verbatim
5024 #: ../examples/guestfs-recipes.pod:275
5025 #, no-wrap
5026 msgid ""
5027 " # list-apps.sh WinGuest\n"
5028 " [0] = {\n"
5029 "   app_name: Mozilla Firefox (3.6.12)\n"
5030 "   app_display_name: Mozilla Firefox (3.6.12)\n"
5031 "   app_epoch: 0\n"
5032 "   app_version: 3.6.12 (en-GB)\n"
5033 "   app_release:\n"
5034 "   app_install_path: C:\\Program Files\\Mozilla Firefox\n"
5035 "   app_trans_path:\n"
5036 "   app_publisher: Mozilla\n"
5037 "   app_url: http://www.mozilla.com/en-GB/\n"
5038 "   app_source_package:\n"
5039 "   app_summary:\n"
5040 "   app_description: Mozilla Firefox\n"
5041 " }\n"
5042 " [1] = {\n"
5043 "   app_name: VLC media player\n"
5044 "   app_display_name: VLC media player 1.1.5\n"
5045 "   app_epoch: 0\n"
5046 "   app_version: 1.1.5\n"
5047 "   app_release:\n"
5048 "   app_install_path: C:\\Program Files\\VideoLAN\\VLC\n"
5049 "   app_trans_path:\n"
5050 "   app_publisher: VideoLAN\n"
5051 "   app_url: http://www.videolan.org/\n"
5052 "   app_source_package:\n"
5053 "   app_summary:\n"
5054 "   app_description:\n"
5055 " }\n"
5056 "\n"
5057 msgstr ""
5058
5059 #. type: textblock
5060 #: ../examples/guestfs-recipes.pod:305
5061 msgid ""
5062 "If you want to run the script on disk images (instead of libvirt virtual "
5063 "machines), change C<-d \"$1\"> to C<-a \"$1\">.  See also "
5064 "L<virt-inspector(1)>."
5065 msgstr ""
5066
5067 #. type: =head1
5068 #: ../examples/guestfs-recipes.pod:309
5069 msgid "List files and directories in a VM"
5070 msgstr ""
5071
5072 #. type: textblock
5073 #: ../examples/guestfs-recipes.pod:311
5074 msgid "This involves using the L<guestfish(1)> C<find0> command like this:"
5075 msgstr ""
5076
5077 #. type: verbatim
5078 #: ../examples/guestfs-recipes.pod:313
5079 #, no-wrap
5080 msgid ""
5081 " guestfish --ro -d Guest -i find0 / - | tr '\\0' '\\n' | sort\n"
5082 "\n"
5083 msgstr ""
5084
5085 #. type: =head1
5086 #: ../examples/guestfs-recipes.pod:315
5087 msgid "List services in a Windows VM"
5088 msgstr ""
5089
5090 #. type: textblock
5091 #: ../examples/guestfs-recipes.pod:317
5092 msgid ""
5093 "The link below contains a script that can be used to list out the services "
5094 "from a Windows VM, and whether those services run at boot time or are loaded "
5095 "on demand."
5096 msgstr ""
5097
5098 #. type: textblock
5099 #: ../examples/guestfs-recipes.pod:321
5100 msgid "https://rwmj.wordpress.com/2010/12/10/tip-list-services-in-a-windows-guest/#content"
5101 msgstr ""
5102
5103 #. type: =head1
5104 #: ../examples/guestfs-recipes.pod:323
5105 msgid "Make a disk image sparse"
5106 msgstr ""
5107
5108 #. type: textblock
5109 #: ../examples/guestfs-recipes.pod:325
5110 msgid ""
5111 "The link below contains some guides for making a disk image sparse (or "
5112 "reintroducing sparseness)."
5113 msgstr ""
5114
5115 #. type: textblock
5116 #: ../examples/guestfs-recipes.pod:328
5117 msgid "https://rwmj.wordpress.com/2010/10/19/tip-making-a-disk-image-sparse/#content"
5118 msgstr ""
5119
5120 #. type: =head1
5121 #: ../examples/guestfs-recipes.pod:330
5122 msgid "Monitor disk usage over time"
5123 msgstr ""
5124
5125 #. type: textblock
5126 #: ../examples/guestfs-recipes.pod:332
5127 msgid ""
5128 "You can use L<virt-df(1)> to monitor disk usage of your guests over time.  "
5129 "The link below contains a guide."
5130 msgstr ""
5131
5132 #. type: textblock
5133 #: ../examples/guestfs-recipes.pod:335
5134 msgid "http://virt-tools.org/learning/advanced-virt-df/"
5135 msgstr ""
5136
5137 #. type: =head1
5138 #: ../examples/guestfs-recipes.pod:337
5139 msgid "Reading the Windows Event Log from Windows Vista (or later)"
5140 msgstr ""
5141
5142 #. type: textblock
5143 #: ../examples/guestfs-recipes.pod:339
5144 msgid ""
5145 "L<guestfish(1)> plus the tools described in the link below can be used to "
5146 "read out the Windows Event Log from any virtual machine running Windows "
5147 "Vista or a later version."
5148 msgstr ""
5149
5150 #. type: textblock
5151 #: ../examples/guestfs-recipes.pod:343
5152 msgid "https://rwmj.wordpress.com/2011/04/17/decoding-the-windows-event-log-using-guestfish/#content"
5153 msgstr ""
5154
5155 #. type: =head1
5156 #: ../examples/guestfs-recipes.pod:345
5157 msgid "Remove root password (Linux)"
5158 msgstr ""
5159
5160 #. type: textblock
5161 #: ../examples/guestfs-recipes.pod:347
5162 msgid ""
5163 "Using the L<virt-edit(1)> I<-e> option you can do simple replacements on "
5164 "files.  One use is to remove the root password from a Linux guest:"
5165 msgstr ""
5166
5167 #. type: verbatim
5168 #: ../examples/guestfs-recipes.pod:350
5169 #, no-wrap
5170 msgid ""
5171 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
5172 "\n"
5173 msgstr ""
5174
5175 #. type: =head1
5176 #: ../examples/guestfs-recipes.pod:352
5177 msgid "Remove Administrator password (Windows)"
5178 msgstr ""
5179
5180 #. type: textblock
5181 #: ../examples/guestfs-recipes.pod:354
5182 msgid ""
5183 "The link below contains one technique for removing the Administrator "
5184 "password from a Windows VM, or to be more precise, it gives you a command "
5185 "prompt the next time you log in which you can use to bypass any security:"
5186 msgstr ""
5187
5188 #. type: textblock
5189 #: ../examples/guestfs-recipes.pod:359
5190 msgid "https://mdbooth.wordpress.com/2010/10/18/resetting-a-windows-guests-administrator-password-with-guestfish/"
5191 msgstr ""
5192
5193 #. type: =head1
5194 #: ../examples/guestfs-recipes.pod:361
5195 msgid "Unpack a live CD"
5196 msgstr ""
5197
5198 #. type: textblock
5199 #: ../examples/guestfs-recipes.pod:363
5200 msgid ""
5201 "Linux live CDs often contain multiple layers of disk images wrapped like a "
5202 "Russian doll.  You can use L<guestfish(1)> to look inside these multiple "
5203 "layers, as outlined in the guide below."
5204 msgstr ""
5205
5206 #. type: textblock
5207 #: ../examples/guestfs-recipes.pod:367
5208 msgid "https://rwmj.wordpress.com/2009/07/15/unpack-the-russian-doll-of-a-f11-live-cd/#content"
5209 msgstr ""
5210
5211 #. type: =head1
5212 #: ../examples/guestfs-recipes.pod:369
5213 msgid "Uploading and downloading files"
5214 msgstr ""
5215
5216 #. type: textblock
5217 #: ../examples/guestfs-recipes.pod:371
5218 msgid ""
5219 "The link below contains general tips on uploading (copying in)  and "
5220 "downloading (copying out) files from VMs."
5221 msgstr ""
5222
5223 #. type: textblock
5224 #: ../examples/guestfs-recipes.pod:374
5225 msgid "https://rwmj.wordpress.com/2010/12/02/tip-uploading-and-downloading/#content"
5226 msgstr ""
5227
5228 #. type: =head1
5229 #: ../examples/guestfs-recipes.pod:376
5230 msgid "Use libguestfs tools on VMware ESX guests"
5231 msgstr ""
5232
5233 #. type: textblock
5234 #: ../examples/guestfs-recipes.pod:378
5235 msgid ""
5236 "The link below explains how to use libguestfs, L<guestfish(1)> and the virt "
5237 "tools on any VMware ESX guests, by first sharing the VMware VMFS over sshfs."
5238 msgstr ""
5239
5240 #. type: textblock
5241 #: ../examples/guestfs-recipes.pod:382
5242 msgid "https://rwmj.wordpress.com/2011/05/10/tip-use-libguestfs-on-vmware-esx-guests/#content"
5243 msgstr ""
5244
5245 #. type: textblock
5246 #: ../examples/guestfs-recipes.pod:386
5247 msgid ""
5248 "L<guestfs(3)>, L<guestfish(1)>, L<guestfs-examples(3)>, "
5249 "L<guestfs-erlang(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, "
5250 "L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby(3)>, "
5251 "L<http://libguestfs.org/>."
5252 msgstr ""
5253
5254 #. type: textblock
5255 #: ../examples/guestfs-recipes.pod:403
5256 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5257 msgstr ""
5258
5259 #. type: =head2
5260 #: ../fish/guestfish-actions.pod:1
5261 msgid "add-cdrom"
5262 msgstr ""
5263
5264 #. type: verbatim
5265 #: ../fish/guestfish-actions.pod:3
5266 #, no-wrap
5267 msgid ""
5268 " add-cdrom filename\n"
5269 "\n"
5270 msgstr ""
5271
5272 #. type: textblock
5273 #: ../fish/guestfish-actions.pod:5 ../src/guestfs-actions.pod:14
5274 msgid "This function adds a virtual CD-ROM disk image to the guest."
5275 msgstr ""
5276
5277 #. type: textblock
5278 #: ../fish/guestfish-actions.pod:7 ../src/guestfs-actions.pod:16
5279 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
5280 msgstr ""
5281
5282 #. type: textblock
5283 #: ../fish/guestfish-actions.pod:15
5284 msgid ""
5285 "This call checks for the existence of C<filename>.  This stops you from "
5286 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5287 "and C<http:> URLs.  To specify those, use the general L</config> call "
5288 "instead."
5289 msgstr ""
5290
5291 #. type: textblock
5292 #: ../fish/guestfish-actions.pod:22
5293 msgid ""
5294 "If you just want to add an ISO file (often you use this as an efficient way "
5295 "to transfer large files into the guest), then you should probably use "
5296 "L</add-drive-ro> instead."
5297 msgstr ""
5298
5299 #. type: textblock
5300 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:214 ../fish/guestfish-actions.pod:228
5301 msgid ""
5302 "I<This function is deprecated.> In new code, use the L</add_drive_opts> call "
5303 "instead."
5304 msgstr ""
5305
5306 #. type: textblock
5307 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:217 ../fish/guestfish-actions.pod:231 ../fish/guestfish-actions.pod:941 ../fish/guestfish-actions.pod:976 ../fish/guestfish-actions.pod:1149 ../fish/guestfish-actions.pod:1509 ../fish/guestfish-actions.pod:1523 ../fish/guestfish-actions.pod:3284 ../fish/guestfish-actions.pod:3595 ../fish/guestfish-actions.pod:3643 ../fish/guestfish-actions.pod:4561 ../fish/guestfish-actions.pod:4581 ../fish/guestfish-actions.pod:4600 ../fish/guestfish-actions.pod:4638 ../fish/guestfish-actions.pod:5287 ../fish/guestfish-actions.pod:5390 ../src/guestfs-actions.pod:10 ../src/guestfs-actions.pod:305 ../src/guestfs-actions.pod:326 ../src/guestfs-actions.pod:1580 ../src/guestfs-actions.pod:1637 ../src/guestfs-actions.pod:1920 ../src/guestfs-actions.pod:2419 ../src/guestfs-actions.pod:2440 ../src/guestfs-actions.pod:5076 ../src/guestfs-actions.pod:5598 ../src/guestfs-actions.pod:5698 ../src/guestfs-actions.pod:6994 ../src/guestfs-actions.pod:7035 ../src/guestfs-actions.pod:7066 ../src/guestfs-actions.pod:7126 ../src/guestfs-actions.pod:8058 ../src/guestfs-actions.pod:8167 ../src/guestfs-actions.pod:8347
5308 msgid ""
5309 "Deprecated functions will not be removed from the API, but the fact that "
5310 "they are deprecated indicates that there are problems with correct use of "
5311 "these functions."
5312 msgstr ""
5313
5314 #. type: =head2
5315 #: ../fish/guestfish-actions.pod:35
5316 msgid "add-domain"
5317 msgstr ""
5318
5319 #. type: =head2
5320 #: ../fish/guestfish-actions.pod:37
5321 msgid "domain"
5322 msgstr ""
5323
5324 #. type: verbatim
5325 #: ../fish/guestfish-actions.pod:39
5326 #, no-wrap
5327 msgid ""
5328 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] "
5329 "[allowuuid:..] [readonlydisk:..]\n"
5330 "\n"
5331 msgstr ""
5332
5333 #. type: textblock
5334 #: ../fish/guestfish-actions.pod:41
5335 msgid ""
5336 "This function adds the disk(s) attached to the named libvirt domain C<dom>.  "
5337 "It works by connecting to libvirt, requesting the domain and domain XML from "
5338 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
5339 msgstr ""
5340
5341 #. type: textblock
5342 #: ../fish/guestfish-actions.pod:46 ../src/guestfs-actions.pod:65
5343 msgid ""
5344 "The number of disks added is returned.  This operation is atomic: if an "
5345 "error is returned, then no disks are added."
5346 msgstr ""
5347
5348 #. type: textblock
5349 #: ../fish/guestfish-actions.pod:49 ../src/guestfs-actions.pod:68
5350 msgid ""
5351 "This function does some minimal checks to make sure the libvirt domain is "
5352 "not running (unless C<readonly> is true).  In a future version we will try "
5353 "to acquire the libvirt lock on each disk."
5354 msgstr ""
5355
5356 #. type: textblock
5357 #: ../fish/guestfish-actions.pod:53 ../src/guestfs-actions.pod:72
5358 msgid ""
5359 "Disks must be accessible locally.  This often means that adding disks from a "
5360 "remote libvirt connection (see L<http://libvirt.org/remote.html>)  will fail "
5361 "unless those disks are accessible via the same device path locally too."
5362 msgstr ""
5363
5364 #. type: textblock
5365 #: ../fish/guestfish-actions.pod:58 ../src/guestfs-actions.pod:77
5366 msgid ""
5367 "The optional C<libvirturi> parameter sets the libvirt URI (see "
5368 "L<http://libvirt.org/uri.html>).  If this is not set then we connect to the "
5369 "default libvirt URI (or one set through an environment variable, see the "
5370 "libvirt documentation for full details)."
5371 msgstr ""
5372
5373 #. type: textblock
5374 #: ../fish/guestfish-actions.pod:64 ../src/guestfs-actions.pod:83
5375 msgid ""
5376 "The optional C<live> flag controls whether this call will try to connect to "
5377 "a running virtual machine C<guestfsd> process if it sees a suitable "
5378 "E<lt>channelE<gt> element in the libvirt XML definition.  The default (if "
5379 "the flag is omitted) is never to try.  See L<guestfs(3)/ATTACHING TO RUNNING "
5380 "DAEMONS> for more information."
5381 msgstr ""
5382
5383 #. type: textblock
5384 #: ../fish/guestfish-actions.pod:71 ../src/guestfs-actions.pod:90
5385 msgid ""
5386 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
5387 "passed instead of the domain name.  The C<dom> string is treated as a UUID "
5388 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
5389 "as usual."
5390 msgstr ""
5391
5392 #. type: textblock
5393 #: ../fish/guestfish-actions.pod:76 ../src/guestfs-actions.pod:95
5394 msgid ""
5395 "The optional C<readonlydisk> parameter controls what we do for disks which "
5396 "are marked E<lt>readonly/E<gt> in the libvirt XML.  Possible values are:"
5397 msgstr ""
5398
5399 #. type: =item
5400 #: ../fish/guestfish-actions.pod:82 ../src/guestfs-actions.pod:101
5401 msgid "readonlydisk = \"error\""
5402 msgstr ""
5403
5404 #. type: textblock
5405 #: ../fish/guestfish-actions.pod:84 ../fish/guestfish-actions.pod:95 ../fish/guestfish-actions.pod:106 ../src/guestfs-actions.pod:103 ../src/guestfs-actions.pod:114 ../src/guestfs-actions.pod:125
5406 msgid "If C<readonly> is false:"
5407 msgstr ""
5408
5409 #. type: textblock
5410 #: ../fish/guestfish-actions.pod:86 ../src/guestfs-actions.pod:105
5411 msgid ""
5412 "The whole call is aborted with an error if any disk with the "
5413 "E<lt>readonly/E<gt> flag is found."
5414 msgstr ""
5415
5416 #. type: textblock
5417 #: ../fish/guestfish-actions.pod:89 ../fish/guestfish-actions.pod:100 ../fish/guestfish-actions.pod:110 ../src/guestfs-actions.pod:108 ../src/guestfs-actions.pod:119 ../src/guestfs-actions.pod:129
5418 msgid "If C<readonly> is true:"
5419 msgstr ""
5420
5421 #. type: textblock
5422 #: ../fish/guestfish-actions.pod:91 ../fish/guestfish-actions.pod:102 ../fish/guestfish-actions.pod:112 ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121 ../src/guestfs-actions.pod:131
5423 msgid "Disks with the E<lt>readonly/E<gt> flag are added read-only."
5424 msgstr ""
5425
5426 #. type: =item
5427 #: ../fish/guestfish-actions.pod:93 ../src/guestfs-actions.pod:112
5428 msgid "readonlydisk = \"read\""
5429 msgstr ""
5430
5431 #. type: textblock
5432 #: ../fish/guestfish-actions.pod:97 ../src/guestfs-actions.pod:116
5433 msgid ""
5434 "Disks with the E<lt>readonly/E<gt> flag are added read-only.  Other disks "
5435 "are added read/write."
5436 msgstr ""
5437
5438 #. type: =item
5439 #: ../fish/guestfish-actions.pod:104 ../src/guestfs-actions.pod:123
5440 msgid "readonlydisk = \"write\" (default)"
5441 msgstr ""
5442
5443 #. type: textblock
5444 #: ../fish/guestfish-actions.pod:108 ../src/guestfs-actions.pod:127
5445 msgid "Disks with the E<lt>readonly/E<gt> flag are added read/write."
5446 msgstr ""
5447
5448 #. type: =item
5449 #: ../fish/guestfish-actions.pod:114 ../src/guestfs-actions.pod:133
5450 msgid "readonlydisk = \"ignore\""
5451 msgstr ""
5452
5453 #. type: textblock
5454 #: ../fish/guestfish-actions.pod:116 ../src/guestfs-actions.pod:135
5455 msgid "If C<readonly> is true or false:"
5456 msgstr ""
5457
5458 #. type: textblock
5459 #: ../fish/guestfish-actions.pod:118 ../src/guestfs-actions.pod:137
5460 msgid "Disks with the E<lt>readonly/E<gt> flag are skipped."
5461 msgstr ""
5462
5463 #. type: textblock
5464 #: ../fish/guestfish-actions.pod:122
5465 msgid ""
5466 "The other optional parameters are passed directly through to "
5467 "L</add-drive-opts>."
5468 msgstr ""
5469
5470 #. type: textblock
5471 #: ../fish/guestfish-actions.pod:125 ../fish/guestfish-actions.pod:194 ../fish/guestfish-actions.pod:624 ../fish/guestfish-actions.pod:835 ../fish/guestfish-actions.pod:856 ../fish/guestfish-actions.pod:894 ../fish/guestfish-actions.pod:903 ../fish/guestfish-actions.pod:912 ../fish/guestfish-actions.pod:926 ../fish/guestfish-actions.pod:2171 ../fish/guestfish-actions.pod:3333 ../fish/guestfish-actions.pod:3496 ../fish/guestfish-actions.pod:3631
5472 msgid ""
5473 "This command has one or more optional arguments.  See L</OPTIONAL "
5474 "ARGUMENTS>."
5475 msgstr ""
5476
5477 #. type: =head2
5478 #: ../fish/guestfish-actions.pod:127
5479 msgid "add-drive"
5480 msgstr ""
5481
5482 #. type: verbatim
5483 #: ../fish/guestfish-actions.pod:129
5484 #, no-wrap
5485 msgid ""
5486 " add-drive filename\n"
5487 "\n"
5488 msgstr ""
5489
5490 #. type: textblock
5491 #: ../fish/guestfish-actions.pod:131
5492 msgid ""
5493 "This function is the equivalent of calling L</add-drive-opts> with no "
5494 "optional parameters, so the disk is added writable, with the format being "
5495 "detected automatically."
5496 msgstr ""
5497
5498 #. type: textblock
5499 #: ../fish/guestfish-actions.pod:135
5500 msgid ""
5501 "Automatic detection of the format opens you up to a potential security hole "
5502 "when dealing with untrusted raw-format images.  See CVE-2010-3851 and "
5503 "RHBZ#642934.  Specifying the format closes this security hole.  Therefore "
5504 "you should think about replacing calls to this function with calls to "
5505 "L</add-drive-opts>, and specifying the format."
5506 msgstr ""
5507
5508 #. type: =head2
5509 #: ../fish/guestfish-actions.pod:142
5510 msgid "add-drive-opts"
5511 msgstr ""
5512
5513 #. type: =head2
5514 #: ../fish/guestfish-actions.pod:144
5515 msgid "add"
5516 msgstr ""
5517
5518 #. type: verbatim
5519 #: ../fish/guestfish-actions.pod:146
5520 #, no-wrap
5521 msgid ""
5522 " add-drive-opts filename [readonly:..] [format:..] [iface:..] [name:..]\n"
5523 "\n"
5524 msgstr ""
5525
5526 #. type: textblock
5527 #: ../fish/guestfish-actions.pod:148 ../src/guestfs-actions.pod:208
5528 msgid ""
5529 "This function adds a virtual machine disk image C<filename> to libguestfs.  "
5530 "The first time you call this function, the disk appears as C</dev/sda>, the "
5531 "second time as C</dev/sdb>, and so on."
5532 msgstr ""
5533
5534 #. type: textblock
5535 #: ../fish/guestfish-actions.pod:153 ../src/guestfs-actions.pod:213
5536 msgid ""
5537 "You don't necessarily need to be root when using libguestfs.  However you "
5538 "obviously do need sufficient permissions to access the filename for whatever "
5539 "operations you want to perform (ie. read access if you just want to read the "
5540 "image or write access if you want to modify the image)."
5541 msgstr ""
5542
5543 #. type: textblock
5544 #: ../fish/guestfish-actions.pod:159 ../src/guestfs-actions.pod:219
5545 msgid "This call checks that C<filename> exists."
5546 msgstr ""
5547
5548 #. type: textblock
5549 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:3295 ../src/guestfs-actions.pod:221 ../src/guestfs-actions.pod:5113
5550 msgid "The optional arguments are:"
5551 msgstr ""
5552
5553 #. type: =item
5554 #: ../fish/guestfish-actions.pod:165 ../src/guestfs-actions.pod:225
5555 msgid "C<readonly>"
5556 msgstr ""
5557
5558 #. type: textblock
5559 #: ../fish/guestfish-actions.pod:167 ../src/guestfs-actions.pod:227
5560 msgid ""
5561 "If true then the image is treated as read-only.  Writes are still allowed, "
5562 "but they are stored in a temporary snapshot overlay which is discarded at "
5563 "the end.  The disk that you add is not modified."
5564 msgstr ""
5565
5566 #. type: =item
5567 #: ../fish/guestfish-actions.pod:171 ../src/guestfs-actions.pod:231
5568 msgid "C<format>"
5569 msgstr ""
5570
5571 #. type: textblock
5572 #: ../fish/guestfish-actions.pod:173
5573 msgid ""
5574 "This forces the image format.  If you omit this (or use L</add-drive> or "
5575 "L</add-drive-ro>) then the format is automatically detected.  Possible "
5576 "formats include C<raw> and C<qcow2>."
5577 msgstr ""
5578
5579 #. type: textblock
5580 #: ../fish/guestfish-actions.pod:177 ../src/guestfs-actions.pod:237
5581 msgid ""
5582 "Automatic detection of the format opens you up to a potential security hole "
5583 "when dealing with untrusted raw-format images.  See CVE-2010-3851 and "
5584 "RHBZ#642934.  Specifying the format closes this security hole."
5585 msgstr ""
5586
5587 #. type: =item
5588 #: ../fish/guestfish-actions.pod:182 ../src/guestfs-actions.pod:242
5589 msgid "C<iface>"
5590 msgstr ""
5591
5592 #. type: textblock
5593 #: ../fish/guestfish-actions.pod:184
5594 msgid ""
5595 "This rarely-used option lets you emulate the behaviour of the deprecated "
5596 "L</add-drive-with-if> call (q.v.)"
5597 msgstr ""
5598
5599 #. type: =item
5600 #: ../fish/guestfish-actions.pod:187 ../src/guestfs-actions.pod:247
5601 msgid "C<name>"
5602 msgstr ""
5603
5604 #. type: textblock
5605 #: ../fish/guestfish-actions.pod:189 ../src/guestfs-actions.pod:249
5606 msgid ""
5607 "The name the drive had in the original guest, e.g. /dev/sdb. This is used as "
5608 "a hint to the guest inspection process if it is available."
5609 msgstr ""
5610
5611 #. type: =head2
5612 #: ../fish/guestfish-actions.pod:196
5613 msgid "add-drive-ro"
5614 msgstr ""
5615
5616 #. type: =head2
5617 #: ../fish/guestfish-actions.pod:198
5618 msgid "add-ro"
5619 msgstr ""
5620
5621 #. type: verbatim
5622 #: ../fish/guestfish-actions.pod:200
5623 #, no-wrap
5624 msgid ""
5625 " add-drive-ro filename\n"
5626 "\n"
5627 msgstr ""
5628
5629 #. type: textblock
5630 #: ../fish/guestfish-actions.pod:202
5631 msgid ""
5632 "This function is the equivalent of calling L</add-drive-opts> with the "
5633 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
5634 "is added read-only, with the format being detected automatically."
5635 msgstr ""
5636
5637 #. type: =head2
5638 #: ../fish/guestfish-actions.pod:207
5639 msgid "add-drive-ro-with-if"
5640 msgstr ""
5641
5642 #. type: verbatim
5643 #: ../fish/guestfish-actions.pod:209
5644 #, no-wrap
5645 msgid ""
5646 " add-drive-ro-with-if filename iface\n"
5647 "\n"
5648 msgstr ""
5649
5650 #. type: textblock
5651 #: ../fish/guestfish-actions.pod:211
5652 msgid ""
5653 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
5654 "interface emulation to use at run time."
5655 msgstr ""
5656
5657 #. type: =head2
5658 #: ../fish/guestfish-actions.pod:221
5659 msgid "add-drive-with-if"
5660 msgstr ""
5661
5662 #. type: verbatim
5663 #: ../fish/guestfish-actions.pod:223
5664 #, no-wrap
5665 msgid ""
5666 " add-drive-with-if filename iface\n"
5667 "\n"
5668 msgstr ""
5669
5670 #. type: textblock
5671 #: ../fish/guestfish-actions.pod:225
5672 msgid ""
5673 "This is the same as L</add-drive> but it allows you to specify the QEMU "
5674 "interface emulation to use at run time."
5675 msgstr ""
5676
5677 #. type: =head2
5678 #: ../fish/guestfish-actions.pod:235
5679 msgid "aug-clear"
5680 msgstr ""
5681
5682 #. type: verbatim
5683 #: ../fish/guestfish-actions.pod:237
5684 #, no-wrap
5685 msgid ""
5686 " aug-clear augpath\n"
5687 "\n"
5688 msgstr ""
5689
5690 #. type: textblock
5691 #: ../fish/guestfish-actions.pod:239 ../src/guestfs-actions.pod:343
5692 msgid ""
5693 "Set the value associated with C<path> to C<NULL>.  This is the same as the "
5694 "L<augtool(1)> C<clear> command."
5695 msgstr ""
5696
5697 #. type: =head2
5698 #: ../fish/guestfish-actions.pod:242
5699 msgid "aug-close"
5700 msgstr ""
5701
5702 #. type: verbatim
5703 #: ../fish/guestfish-actions.pod:244
5704 #, no-wrap
5705 msgid ""
5706 " aug-close\n"
5707 "\n"
5708 msgstr ""
5709
5710 #. type: textblock
5711 #: ../fish/guestfish-actions.pod:246
5712 msgid ""
5713 "Close the current Augeas handle and free up any resources used by it.  After "
5714 "calling this, you have to call L</aug-init> again before you can use any "
5715 "other Augeas functions."
5716 msgstr ""
5717
5718 #. type: =head2
5719 #: ../fish/guestfish-actions.pod:251
5720 msgid "aug-defnode"
5721 msgstr ""
5722
5723 #. type: verbatim
5724 #: ../fish/guestfish-actions.pod:253
5725 #, no-wrap
5726 msgid ""
5727 " aug-defnode name expr val\n"
5728 "\n"
5729 msgstr ""
5730
5731 #. type: textblock
5732 #: ../fish/guestfish-actions.pod:255 ../src/guestfs-actions.pod:372
5733 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
5734 msgstr ""
5735
5736 #. type: textblock
5737 #: ../fish/guestfish-actions.pod:258
5738 msgid ""
5739 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
5740 "calling L</aug-set> C<expr>, C<value>.  C<name> will be the nodeset "
5741 "containing that single node."
5742 msgstr ""
5743
5744 #. type: textblock
5745 #: ../fish/guestfish-actions.pod:262 ../src/guestfs-actions.pod:379
5746 msgid ""
5747 "On success this returns a pair containing the number of nodes in the "
5748 "nodeset, and a boolean flag if a node was created."
5749 msgstr ""
5750
5751 #. type: =head2
5752 #: ../fish/guestfish-actions.pod:266
5753 msgid "aug-defvar"
5754 msgstr ""
5755
5756 #. type: verbatim
5757 #: ../fish/guestfish-actions.pod:268
5758 #, no-wrap
5759 msgid ""
5760 " aug-defvar name expr\n"
5761 "\n"
5762 msgstr ""
5763
5764 #. type: textblock
5765 #: ../fish/guestfish-actions.pod:270 ../src/guestfs-actions.pod:396
5766 msgid ""
5767 "Defines an Augeas variable C<name> whose value is the result of evaluating "
5768 "C<expr>.  If C<expr> is NULL, then C<name> is undefined."
5769 msgstr ""
5770
5771 #. type: textblock
5772 #: ../fish/guestfish-actions.pod:274 ../src/guestfs-actions.pod:400
5773 msgid ""
5774 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
5775 "evaluates to something which is not a nodeset."
5776 msgstr ""
5777
5778 #. type: =head2
5779 #: ../fish/guestfish-actions.pod:277
5780 msgid "aug-get"
5781 msgstr ""
5782
5783 #. type: verbatim
5784 #: ../fish/guestfish-actions.pod:279
5785 #, no-wrap
5786 msgid ""
5787 " aug-get augpath\n"
5788 "\n"
5789 msgstr ""
5790
5791 #. type: textblock
5792 #: ../fish/guestfish-actions.pod:281 ../src/guestfs-actions.pod:413
5793 msgid ""
5794 "Look up the value associated with C<path>.  If C<path> matches exactly one "
5795 "node, the C<value> is returned."
5796 msgstr ""
5797
5798 #. type: =head2
5799 #: ../fish/guestfish-actions.pod:284
5800 msgid "aug-init"
5801 msgstr ""
5802
5803 #. type: verbatim
5804 #: ../fish/guestfish-actions.pod:286
5805 #, no-wrap
5806 msgid ""
5807 " aug-init root flags\n"
5808 "\n"
5809 msgstr ""
5810
5811 #. type: textblock
5812 #: ../fish/guestfish-actions.pod:288 ../src/guestfs-actions.pod:428
5813 msgid ""
5814 "Create a new Augeas handle for editing configuration files.  If there was "
5815 "any previous Augeas handle associated with this guestfs session, then it is "
5816 "closed."
5817 msgstr ""
5818
5819 #. type: textblock
5820 #: ../fish/guestfish-actions.pod:292
5821 msgid "You must call this before using any other L</aug-*> commands."
5822 msgstr ""
5823
5824 #. type: textblock
5825 #: ../fish/guestfish-actions.pod:295 ../src/guestfs-actions.pod:435
5826 msgid "C<root> is the filesystem root.  C<root> must not be NULL, use C</> instead."
5827 msgstr ""
5828
5829 #. type: textblock
5830 #: ../fish/guestfish-actions.pod:298 ../src/guestfs-actions.pod:438
5831 msgid ""
5832 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
5833 "logical I<or> of the following integers:"
5834 msgstr ""
5835
5836 #. type: =item
5837 #: ../fish/guestfish-actions.pod:304 ../src/guestfs-actions.pod:444
5838 msgid "C<AUG_SAVE_BACKUP> = 1"
5839 msgstr ""
5840
5841 #. type: textblock
5842 #: ../fish/guestfish-actions.pod:306 ../src/guestfs-actions.pod:446
5843 msgid "Keep the original file with a C<.augsave> extension."
5844 msgstr ""
5845
5846 #. type: =item
5847 #: ../fish/guestfish-actions.pod:308 ../src/guestfs-actions.pod:448
5848 msgid "C<AUG_SAVE_NEWFILE> = 2"
5849 msgstr ""
5850
5851 #. type: textblock
5852 #: ../fish/guestfish-actions.pod:310 ../src/guestfs-actions.pod:450
5853 msgid ""
5854 "Save changes into a file with extension C<.augnew>, and do not overwrite "
5855 "original.  Overrides C<AUG_SAVE_BACKUP>."
5856 msgstr ""
5857
5858 #. type: =item
5859 #: ../fish/guestfish-actions.pod:313 ../src/guestfs-actions.pod:453
5860 msgid "C<AUG_TYPE_CHECK> = 4"
5861 msgstr ""
5862
5863 #. type: textblock
5864 #: ../fish/guestfish-actions.pod:315 ../src/guestfs-actions.pod:455
5865 msgid "Typecheck lenses."
5866 msgstr ""
5867
5868 #. type: textblock
5869 #: ../fish/guestfish-actions.pod:317
5870 msgid ""
5871 "This option is only useful when debugging Augeas lenses.  Use of this option "
5872 "may require additional memory for the libguestfs appliance.  You may need to "
5873 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call L</set-memsize>."
5874 msgstr ""
5875
5876 #. type: =item
5877 #: ../fish/guestfish-actions.pod:322 ../src/guestfs-actions.pod:462
5878 msgid "C<AUG_NO_STDINC> = 8"
5879 msgstr ""
5880
5881 #. type: textblock
5882 #: ../fish/guestfish-actions.pod:324 ../src/guestfs-actions.pod:464
5883 msgid "Do not use standard load path for modules."
5884 msgstr ""
5885
5886 #. type: =item
5887 #: ../fish/guestfish-actions.pod:326 ../src/guestfs-actions.pod:466
5888 msgid "C<AUG_SAVE_NOOP> = 16"
5889 msgstr ""
5890
5891 #. type: textblock
5892 #: ../fish/guestfish-actions.pod:328 ../src/guestfs-actions.pod:468
5893 msgid "Make save a no-op, just record what would have been changed."
5894 msgstr ""
5895
5896 #. type: =item
5897 #: ../fish/guestfish-actions.pod:330 ../src/guestfs-actions.pod:470
5898 msgid "C<AUG_NO_LOAD> = 32"
5899 msgstr ""
5900
5901 #. type: textblock
5902 #: ../fish/guestfish-actions.pod:332
5903 msgid "Do not load the tree in L</aug-init>."
5904 msgstr ""
5905
5906 #. type: textblock
5907 #: ../fish/guestfish-actions.pod:336
5908 msgid "To close the handle, you can call L</aug-close>."
5909 msgstr ""
5910
5911 #. type: textblock
5912 #: ../fish/guestfish-actions.pod:338 ../src/guestfs-actions.pod:478
5913 msgid "To find out more about Augeas, see L<http://augeas.net/>."
5914 msgstr ""
5915
5916 #. type: =head2
5917 #: ../fish/guestfish-actions.pod:340
5918 msgid "aug-insert"
5919 msgstr ""
5920
5921 #. type: verbatim
5922 #: ../fish/guestfish-actions.pod:342
5923 #, no-wrap
5924 msgid ""
5925 " aug-insert augpath label true|false\n"
5926 "\n"
5927 msgstr ""
5928
5929 #. type: textblock
5930 #: ../fish/guestfish-actions.pod:344 ../src/guestfs-actions.pod:492
5931 msgid ""
5932 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
5933 "or after C<path> (depending on the boolean flag C<before>)."
5934 msgstr ""
5935
5936 #. type: textblock
5937 #: ../fish/guestfish-actions.pod:348 ../src/guestfs-actions.pod:496
5938 msgid ""
5939 "C<path> must match exactly one existing node in the tree, and C<label> must "
5940 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
5941 msgstr ""
5942
5943 #. type: =head2
5944 #: ../fish/guestfish-actions.pod:352
5945 msgid "aug-load"
5946 msgstr ""
5947
5948 #. type: verbatim
5949 #: ../fish/guestfish-actions.pod:354
5950 #, no-wrap
5951 msgid ""
5952 " aug-load\n"
5953 "\n"
5954 msgstr ""
5955
5956 #. type: textblock
5957 #: ../fish/guestfish-actions.pod:356 ../src/guestfs-actions.pod:509
5958 msgid "Load files into the tree."
5959 msgstr ""
5960
5961 #. type: textblock
5962 #: ../fish/guestfish-actions.pod:358 ../src/guestfs-actions.pod:511
5963 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
5964 msgstr ""
5965
5966 #. type: =head2
5967 #: ../fish/guestfish-actions.pod:361
5968 msgid "aug-ls"
5969 msgstr ""
5970
5971 #. type: verbatim
5972 #: ../fish/guestfish-actions.pod:363
5973 #, no-wrap
5974 msgid ""
5975 " aug-ls augpath\n"
5976 "\n"
5977 msgstr ""
5978
5979 #. type: textblock
5980 #: ../fish/guestfish-actions.pod:365
5981 msgid ""
5982 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
5983 "resulting nodes into alphabetical order."
5984 msgstr ""
5985
5986 #. type: =head2
5987 #: ../fish/guestfish-actions.pod:368
5988 msgid "aug-match"
5989 msgstr ""
5990
5991 #. type: verbatim
5992 #: ../fish/guestfish-actions.pod:370
5993 #, no-wrap
5994 msgid ""
5995 " aug-match augpath\n"
5996 "\n"
5997 msgstr ""
5998
5999 #. type: textblock
6000 #: ../fish/guestfish-actions.pod:372 ../src/guestfs-actions.pod:539
6001 msgid ""
6002 "Returns a list of paths which match the path expression C<path>.  The "
6003 "returned paths are sufficiently qualified so that they match exactly one "
6004 "node in the current tree."
6005 msgstr ""
6006
6007 #. type: =head2
6008 #: ../fish/guestfish-actions.pod:376
6009 msgid "aug-mv"
6010 msgstr ""
6011
6012 #. type: verbatim
6013 #: ../fish/guestfish-actions.pod:378
6014 #, no-wrap
6015 msgid ""
6016 " aug-mv src dest\n"
6017 "\n"
6018 msgstr ""
6019
6020 #. type: textblock
6021 #: ../fish/guestfish-actions.pod:380 ../src/guestfs-actions.pod:556
6022 msgid ""
6023 "Move the node C<src> to C<dest>.  C<src> must match exactly one node.  "
6024 "C<dest> is overwritten if it exists."
6025 msgstr ""
6026
6027 #. type: =head2
6028 #: ../fish/guestfish-actions.pod:383
6029 msgid "aug-rm"
6030 msgstr ""
6031
6032 #. type: verbatim
6033 #: ../fish/guestfish-actions.pod:385
6034 #, no-wrap
6035 msgid ""
6036 " aug-rm augpath\n"
6037 "\n"
6038 msgstr ""
6039
6040 #. type: textblock
6041 #: ../fish/guestfish-actions.pod:387 ../src/guestfs-actions.pod:569
6042 msgid "Remove C<path> and all of its children."
6043 msgstr ""
6044
6045 #. type: textblock
6046 #: ../fish/guestfish-actions.pod:389 ../src/guestfs-actions.pod:571
6047 msgid "On success this returns the number of entries which were removed."
6048 msgstr ""
6049
6050 #. type: =head2
6051 #: ../fish/guestfish-actions.pod:391
6052 msgid "aug-save"
6053 msgstr ""
6054
6055 #. type: verbatim
6056 #: ../fish/guestfish-actions.pod:393
6057 #, no-wrap
6058 msgid ""
6059 " aug-save\n"
6060 "\n"
6061 msgstr ""
6062
6063 #. type: textblock
6064 #: ../fish/guestfish-actions.pod:395 ../src/guestfs-actions.pod:582
6065 msgid "This writes all pending changes to disk."
6066 msgstr ""
6067
6068 #. type: textblock
6069 #: ../fish/guestfish-actions.pod:397
6070 msgid ""
6071 "The flags which were passed to L</aug-init> affect exactly how files are "
6072 "saved."
6073 msgstr ""
6074
6075 #. type: =head2
6076 #: ../fish/guestfish-actions.pod:400
6077 msgid "aug-set"
6078 msgstr ""
6079
6080 #. type: verbatim
6081 #: ../fish/guestfish-actions.pod:402
6082 #, no-wrap
6083 msgid ""
6084 " aug-set augpath val\n"
6085 "\n"
6086 msgstr ""
6087
6088 #. type: textblock
6089 #: ../fish/guestfish-actions.pod:404 ../src/guestfs-actions.pod:598
6090 msgid "Set the value associated with C<path> to C<val>."
6091 msgstr ""
6092
6093 #. type: textblock
6094 #: ../fish/guestfish-actions.pod:406
6095 msgid ""
6096 "In the Augeas API, it is possible to clear a node by setting the value to "
6097 "NULL.  Due to an oversight in the libguestfs API you cannot do that with "
6098 "this call.  Instead you must use the L</aug-clear> call."
6099 msgstr ""
6100
6101 #. type: =head2
6102 #: ../fish/guestfish-actions.pod:411
6103 msgid "available"
6104 msgstr ""
6105
6106 #. type: verbatim
6107 #: ../fish/guestfish-actions.pod:413
6108 #, no-wrap
6109 msgid ""
6110 " available 'groups ...'\n"
6111 "\n"
6112 msgstr ""
6113
6114 #. type: textblock
6115 #: ../fish/guestfish-actions.pod:415 ../src/guestfs-actions.pod:615
6116 msgid ""
6117 "This command is used to check the availability of some groups of "
6118 "functionality in the appliance, which not all builds of the libguestfs "
6119 "appliance will be able to provide."
6120 msgstr ""
6121
6122 #. type: textblock
6123 #: ../fish/guestfish-actions.pod:419
6124 msgid ""
6125 "The libguestfs groups, and the functions that those groups correspond to, "
6126 "are listed in L<guestfs(3)/AVAILABILITY>.  You can also fetch this list at "
6127 "runtime by calling L</available-all-groups>."
6128 msgstr ""
6129
6130 #. type: textblock
6131 #: ../fish/guestfish-actions.pod:424 ../src/guestfs-actions.pod:624
6132 msgid ""
6133 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
6134 "\"augeas\"]> would check for the availability of the Linux inotify functions "
6135 "and Augeas (configuration file editing) functions."
6136 msgstr ""
6137
6138 #. type: textblock
6139 #: ../fish/guestfish-actions.pod:429 ../src/guestfs-actions.pod:629
6140 msgid "The command returns no error if I<all> requested groups are available."
6141 msgstr ""
6142
6143 #. type: textblock
6144 #: ../fish/guestfish-actions.pod:431 ../src/guestfs-actions.pod:631
6145 msgid ""
6146 "It fails with an error if one or more of the requested groups is unavailable "
6147 "in the appliance."
6148 msgstr ""
6149
6150 #. type: textblock
6151 #: ../fish/guestfish-actions.pod:434 ../src/guestfs-actions.pod:634
6152 msgid ""
6153 "If an unknown group name is included in the list of groups then an error is "
6154 "always returned."
6155 msgstr ""
6156
6157 #. type: textblock
6158 #: ../fish/guestfish-actions.pod:437 ../src/guestfs-actions.pod:637
6159 msgid "I<Notes:>"
6160 msgstr ""
6161
6162 #. type: textblock
6163 #: ../fish/guestfish-actions.pod:443
6164 msgid "You must call L</launch> before calling this function."
6165 msgstr ""
6166
6167 #. type: textblock
6168 #: ../fish/guestfish-actions.pod:445 ../src/guestfs-actions.pod:645
6169 msgid ""
6170 "The reason is because we don't know what groups are supported by the "
6171 "appliance/daemon until it is running and can be queried."
6172 msgstr ""
6173
6174 #. type: textblock
6175 #: ../fish/guestfish-actions.pod:451 ../src/guestfs-actions.pod:651
6176 msgid ""
6177 "If a group of functions is available, this does not necessarily mean that "
6178 "they will work.  You still have to check for errors when calling individual "
6179 "API functions even if they are available."
6180 msgstr ""
6181
6182 #. type: textblock
6183 #: ../fish/guestfish-actions.pod:458 ../src/guestfs-actions.pod:658
6184 msgid ""
6185 "It is usually the job of distro packagers to build complete functionality "
6186 "into the libguestfs appliance.  Upstream libguestfs, if built from source "
6187 "with all requirements satisfied, will support everything."
6188 msgstr ""
6189
6190 #. type: textblock
6191 #: ../fish/guestfish-actions.pod:465
6192 msgid ""
6193 "This call was added in version C<1.0.80>.  In previous versions of "
6194 "libguestfs all you could do would be to speculatively execute a command to "
6195 "find out if the daemon implemented it.  See also L</version>."
6196 msgstr ""
6197
6198 #. type: =head2
6199 #: ../fish/guestfish-actions.pod:472
6200 msgid "available-all-groups"
6201 msgstr ""
6202
6203 #. type: verbatim
6204 #: ../fish/guestfish-actions.pod:474
6205 #, no-wrap
6206 msgid ""
6207 " available-all-groups\n"
6208 "\n"
6209 msgstr ""
6210
6211 #. type: textblock
6212 #: ../fish/guestfish-actions.pod:476
6213 msgid ""
6214 "This command returns a list of all optional groups that this daemon knows "
6215 "about.  Note this returns both supported and unsupported groups.  To find "
6216 "out which ones the daemon can actually support you have to call "
6217 "L</available> on each member of the returned list."
6218 msgstr ""
6219
6220 #. type: textblock
6221 #: ../fish/guestfish-actions.pod:482
6222 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
6223 msgstr ""
6224
6225 #. type: =head2
6226 #: ../fish/guestfish-actions.pod:484
6227 msgid "base64-in"
6228 msgstr ""
6229
6230 #. type: verbatim
6231 #: ../fish/guestfish-actions.pod:486
6232 #, no-wrap
6233 msgid ""
6234 " base64-in (base64file|-) filename\n"
6235 "\n"
6236 msgstr ""
6237
6238 #. type: textblock
6239 #: ../fish/guestfish-actions.pod:488 ../src/guestfs-actions.pod:702
6240 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
6241 msgstr ""
6242
6243 #. type: textblock
6244 #: ../fish/guestfish-actions.pod:491 ../fish/guestfish-actions.pod:500 ../fish/guestfish-actions.pod:749 ../fish/guestfish-actions.pod:833 ../fish/guestfish-actions.pod:854 ../fish/guestfish-actions.pod:1025 ../fish/guestfish-actions.pod:1044 ../fish/guestfish-actions.pod:1418 ../fish/guestfish-actions.pod:4858 ../fish/guestfish-actions.pod:4870 ../fish/guestfish-actions.pod:4881 ../fish/guestfish-actions.pod:4892 ../fish/guestfish-actions.pod:4944 ../fish/guestfish-actions.pod:4953 ../fish/guestfish-actions.pod:5007 ../fish/guestfish-actions.pod:5030
6245 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
6246 msgstr ""
6247
6248 #. type: =head2
6249 #: ../fish/guestfish-actions.pod:493
6250 msgid "base64-out"
6251 msgstr ""
6252
6253 #. type: verbatim
6254 #: ../fish/guestfish-actions.pod:495
6255 #, no-wrap
6256 msgid ""
6257 " base64-out filename (base64file|-)\n"
6258 "\n"
6259 msgstr ""
6260
6261 #. type: textblock
6262 #: ../fish/guestfish-actions.pod:497 ../src/guestfs-actions.pod:716
6263 msgid ""
6264 "This command downloads the contents of C<filename>, writing it out to local "
6265 "file C<base64file> encoded as base64."
6266 msgstr ""
6267
6268 #. type: =head2
6269 #: ../fish/guestfish-actions.pod:502
6270 msgid "blockdev-flushbufs"
6271 msgstr ""
6272
6273 #. type: verbatim
6274 #: ../fish/guestfish-actions.pod:504
6275 #, no-wrap
6276 msgid ""
6277 " blockdev-flushbufs device\n"
6278 "\n"
6279 msgstr ""
6280
6281 #. type: textblock
6282 #: ../fish/guestfish-actions.pod:506 ../src/guestfs-actions.pod:729
6283 msgid "This tells the kernel to flush internal buffers associated with C<device>."
6284 msgstr ""
6285
6286 #. type: textblock
6287 #: ../fish/guestfish-actions.pod:509 ../fish/guestfish-actions.pod:520 ../fish/guestfish-actions.pod:529 ../fish/guestfish-actions.pod:539 ../fish/guestfish-actions.pod:551 ../fish/guestfish-actions.pod:564 ../fish/guestfish-actions.pod:572 ../fish/guestfish-actions.pod:583 ../fish/guestfish-actions.pod:591 ../fish/guestfish-actions.pod:599 ../src/guestfs-actions.pod:732 ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:764 ../src/guestfs-actions.pod:780 ../src/guestfs-actions.pod:798 ../src/guestfs-actions.pod:817 ../src/guestfs-actions.pod:831 ../src/guestfs-actions.pod:849 ../src/guestfs-actions.pod:863 ../src/guestfs-actions.pod:877
6288 msgid "This uses the L<blockdev(8)> command."
6289 msgstr ""
6290
6291 #. type: =head2
6292 #: ../fish/guestfish-actions.pod:511
6293 msgid "blockdev-getbsz"
6294 msgstr ""
6295
6296 #. type: verbatim
6297 #: ../fish/guestfish-actions.pod:513
6298 #, no-wrap
6299 msgid ""
6300 " blockdev-getbsz device\n"
6301 "\n"
6302 msgstr ""
6303
6304 #. type: textblock
6305 #: ../fish/guestfish-actions.pod:515 ../src/guestfs-actions.pod:744
6306 msgid "This returns the block size of a device."
6307 msgstr ""
6308
6309 #. type: textblock
6310 #: ../fish/guestfish-actions.pod:517 ../fish/guestfish-actions.pod:580 ../src/guestfs-actions.pod:746 ../src/guestfs-actions.pod:846
6311 msgid ""
6312 "(Note this is different from both I<size in blocks> and I<filesystem block "
6313 "size>)."
6314 msgstr ""
6315
6316 #. type: =head2
6317 #: ../fish/guestfish-actions.pod:522
6318 msgid "blockdev-getro"
6319 msgstr ""
6320
6321 #. type: verbatim
6322 #: ../fish/guestfish-actions.pod:524
6323 #, no-wrap
6324 msgid ""
6325 " blockdev-getro device\n"
6326 "\n"
6327 msgstr ""
6328
6329 #. type: textblock
6330 #: ../fish/guestfish-actions.pod:526 ../src/guestfs-actions.pod:761
6331 msgid ""
6332 "Returns a boolean indicating if the block device is read-only (true if "
6333 "read-only, false if not)."
6334 msgstr ""
6335
6336 #. type: =head2
6337 #: ../fish/guestfish-actions.pod:531
6338 msgid "blockdev-getsize64"
6339 msgstr ""
6340
6341 #. type: verbatim
6342 #: ../fish/guestfish-actions.pod:533
6343 #, no-wrap
6344 msgid ""
6345 " blockdev-getsize64 device\n"
6346 "\n"
6347 msgstr ""
6348
6349 #. type: textblock
6350 #: ../fish/guestfish-actions.pod:535 ../src/guestfs-actions.pod:776
6351 msgid "This returns the size of the device in bytes."
6352 msgstr ""
6353
6354 #. type: textblock
6355 #: ../fish/guestfish-actions.pod:537
6356 msgid "See also L</blockdev-getsz>."
6357 msgstr ""
6358
6359 #. type: =head2
6360 #: ../fish/guestfish-actions.pod:541
6361 msgid "blockdev-getss"
6362 msgstr ""
6363
6364 #. type: verbatim
6365 #: ../fish/guestfish-actions.pod:543
6366 #, no-wrap
6367 msgid ""
6368 " blockdev-getss device\n"
6369 "\n"
6370 msgstr ""
6371
6372 #. type: textblock
6373 #: ../fish/guestfish-actions.pod:545 ../src/guestfs-actions.pod:792
6374 msgid ""
6375 "This returns the size of sectors on a block device.  Usually 512, but can be "
6376 "larger for modern devices."
6377 msgstr ""
6378
6379 #. type: textblock
6380 #: ../fish/guestfish-actions.pod:548
6381 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
6382 msgstr ""
6383
6384 #. type: =head2
6385 #: ../fish/guestfish-actions.pod:553
6386 msgid "blockdev-getsz"
6387 msgstr ""
6388
6389 #. type: verbatim
6390 #: ../fish/guestfish-actions.pod:555
6391 #, no-wrap
6392 msgid ""
6393 " blockdev-getsz device\n"
6394 "\n"
6395 msgstr ""
6396
6397 #. type: textblock
6398 #: ../fish/guestfish-actions.pod:557 ../src/guestfs-actions.pod:810
6399 msgid ""
6400 "This returns the size of the device in units of 512-byte sectors (even if "
6401 "the sectorsize isn't 512 bytes ... weird)."
6402 msgstr ""
6403
6404 #. type: textblock
6405 #: ../fish/guestfish-actions.pod:560
6406 msgid ""
6407 "See also L</blockdev-getss> for the real sector size of the device, and "
6408 "L</blockdev-getsize64> for the more useful I<size in bytes>."
6409 msgstr ""
6410
6411 #. type: =head2
6412 #: ../fish/guestfish-actions.pod:566
6413 msgid "blockdev-rereadpt"
6414 msgstr ""
6415
6416 #. type: verbatim
6417 #: ../fish/guestfish-actions.pod:568
6418 #, no-wrap
6419 msgid ""
6420 " blockdev-rereadpt device\n"
6421 "\n"
6422 msgstr ""
6423
6424 #. type: textblock
6425 #: ../fish/guestfish-actions.pod:570 ../src/guestfs-actions.pod:829
6426 msgid "Reread the partition table on C<device>."
6427 msgstr ""
6428
6429 #. type: =head2
6430 #: ../fish/guestfish-actions.pod:574
6431 msgid "blockdev-setbsz"
6432 msgstr ""
6433
6434 #. type: verbatim
6435 #: ../fish/guestfish-actions.pod:576
6436 #, no-wrap
6437 msgid ""
6438 " blockdev-setbsz device blocksize\n"
6439 "\n"
6440 msgstr ""
6441
6442 #. type: textblock
6443 #: ../fish/guestfish-actions.pod:578 ../src/guestfs-actions.pod:844
6444 msgid "This sets the block size of a device."
6445 msgstr ""
6446
6447 #. type: =head2
6448 #: ../fish/guestfish-actions.pod:585
6449 msgid "blockdev-setro"
6450 msgstr ""
6451
6452 #. type: verbatim
6453 #: ../fish/guestfish-actions.pod:587
6454 #, no-wrap
6455 msgid ""
6456 " blockdev-setro device\n"
6457 "\n"
6458 msgstr ""
6459
6460 #. type: textblock
6461 #: ../fish/guestfish-actions.pod:589 ../src/guestfs-actions.pod:861
6462 msgid "Sets the block device named C<device> to read-only."
6463 msgstr ""
6464
6465 #. type: =head2
6466 #: ../fish/guestfish-actions.pod:593
6467 msgid "blockdev-setrw"
6468 msgstr ""
6469
6470 #. type: verbatim
6471 #: ../fish/guestfish-actions.pod:595
6472 #, no-wrap
6473 msgid ""
6474 " blockdev-setrw device\n"
6475 "\n"
6476 msgstr ""
6477
6478 #. type: textblock
6479 #: ../fish/guestfish-actions.pod:597 ../src/guestfs-actions.pod:875
6480 msgid "Sets the block device named C<device> to read-write."
6481 msgstr ""
6482
6483 #. type: =head2
6484 #: ../fish/guestfish-actions.pod:601
6485 msgid "btrfs-filesystem-resize"
6486 msgstr ""
6487
6488 #. type: verbatim
6489 #: ../fish/guestfish-actions.pod:603
6490 #, no-wrap
6491 msgid ""
6492 " btrfs-filesystem-resize mountpoint [size:..]\n"
6493 "\n"
6494 msgstr ""
6495
6496 #. type: textblock
6497 #: ../fish/guestfish-actions.pod:605 ../src/guestfs-actions.pod:897
6498 msgid "This command resizes a btrfs filesystem."
6499 msgstr ""
6500
6501 #. type: textblock
6502 #: ../fish/guestfish-actions.pod:607 ../src/guestfs-actions.pod:899
6503 msgid ""
6504 "Note that unlike other resize calls, the filesystem has to be mounted and "
6505 "the parameter is the mountpoint not the device (this is a requirement of "
6506 "btrfs itself)."
6507 msgstr ""
6508
6509 #. type: textblock
6510 #: ../fish/guestfish-actions.pod:611 ../fish/guestfish-actions.pod:3606 ../src/guestfs-actions.pod:903 ../src/guestfs-actions.pod:5637
6511 msgid "The optional parameters are:"
6512 msgstr ""
6513
6514 #. type: =item
6515 #: ../fish/guestfish-actions.pod:615 ../fish/guestfish-actions.pod:3610 ../src/guestfs-actions.pod:907 ../src/guestfs-actions.pod:5641
6516 msgid "C<size>"
6517 msgstr ""
6518
6519 #. type: textblock
6520 #: ../fish/guestfish-actions.pod:617 ../src/guestfs-actions.pod:909
6521 msgid ""
6522 "The new size (in bytes) of the filesystem.  If omitted, the filesystem is "
6523 "resized to the maximum size."
6524 msgstr ""
6525
6526 #. type: textblock
6527 #: ../fish/guestfish-actions.pod:622 ../src/guestfs-actions.pod:914
6528 msgid "See also L<btrfs(8)>."
6529 msgstr ""
6530
6531 #. type: =head2
6532 #: ../fish/guestfish-actions.pod:626
6533 msgid "case-sensitive-path"
6534 msgstr ""
6535
6536 #. type: verbatim
6537 #: ../fish/guestfish-actions.pod:628
6538 #, no-wrap
6539 msgid ""
6540 " case-sensitive-path path\n"
6541 "\n"
6542 msgstr ""
6543
6544 #. type: textblock
6545 #: ../fish/guestfish-actions.pod:630 ../src/guestfs-actions.pod:948
6546 msgid ""
6547 "This can be used to resolve case insensitive paths on a filesystem which is "
6548 "case sensitive.  The use case is to resolve paths which you have read from "
6549 "Windows configuration files or the Windows Registry, to the true path."
6550 msgstr ""
6551
6552 #. type: textblock
6553 #: ../fish/guestfish-actions.pod:635 ../src/guestfs-actions.pod:953
6554 msgid ""
6555 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
6556 "(and probably others), which is that although the underlying filesystem is "
6557 "case-insensitive, the driver exports the filesystem to Linux as "
6558 "case-sensitive."
6559 msgstr ""
6560
6561 #. type: textblock
6562 #: ../fish/guestfish-actions.pod:640 ../src/guestfs-actions.pod:958
6563 msgid ""
6564 "One consequence of this is that special directories such as C<c:\\windows> "
6565 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
6566 "precise details of how they were created.  In Windows itself this would not "
6567 "be a problem."
6568 msgstr ""
6569
6570 #. type: textblock
6571 #: ../fish/guestfish-actions.pod:646 ../src/guestfs-actions.pod:964
6572 msgid ""
6573 "Bug or feature? You decide: "
6574 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
6575 msgstr ""
6576
6577 #. type: textblock
6578 #: ../fish/guestfish-actions.pod:649 ../src/guestfs-actions.pod:967
6579 msgid ""
6580 "This function resolves the true case of each element in the path and returns "
6581 "the case-sensitive path."
6582 msgstr ""
6583
6584 #. type: textblock
6585 #: ../fish/guestfish-actions.pod:652
6586 msgid ""
6587 "Thus L</case-sensitive-path> (\"/Windows/System32\")  might return "
6588 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
6589 "how the directories were originally created under Windows)."
6590 msgstr ""
6591
6592 #. type: textblock
6593 #: ../fish/guestfish-actions.pod:657 ../src/guestfs-actions.pod:975
6594 msgid "I<Note>: This function does not handle drive names, backslashes etc."
6595 msgstr ""
6596
6597 #. type: textblock
6598 #: ../fish/guestfish-actions.pod:660
6599 msgid "See also L</realpath>."
6600 msgstr ""
6601
6602 #. type: =head2
6603 #: ../fish/guestfish-actions.pod:662
6604 msgid "cat"
6605 msgstr ""
6606
6607 #. type: verbatim
6608 #: ../fish/guestfish-actions.pod:664
6609 #, no-wrap
6610 msgid ""
6611 " cat path\n"
6612 "\n"
6613 msgstr ""
6614
6615 #. type: textblock
6616 #: ../fish/guestfish-actions.pod:666 ../fish/guestfish-actions.pod:4037 ../src/guestfs-actions.pod:991 ../src/guestfs-actions.pod:6297
6617 msgid "Return the contents of the file named C<path>."
6618 msgstr ""
6619
6620 #. type: textblock
6621 #: ../fish/guestfish-actions.pod:668
6622 msgid ""
6623 "Note that this function cannot correctly handle binary files (specifically, "
6624 "files containing C<\\0> character which is treated as end of string).  For "
6625 "those you need to use the L</read-file> or L</download> functions which have "
6626 "a more complex interface."
6627 msgstr ""
6628
6629 #. type: textblock
6630 #: ../fish/guestfish-actions.pod:673 ../fish/guestfish-actions.pod:808 ../fish/guestfish-actions.pod:820 ../fish/guestfish-actions.pod:1103 ../fish/guestfish-actions.pod:1113 ../fish/guestfish-actions.pod:1180 ../fish/guestfish-actions.pod:1190 ../fish/guestfish-actions.pod:1382 ../fish/guestfish-actions.pod:1695 ../fish/guestfish-actions.pod:1705 ../fish/guestfish-actions.pod:1755 ../fish/guestfish-actions.pod:1770 ../fish/guestfish-actions.pod:1780 ../fish/guestfish-actions.pod:1799 ../fish/guestfish-actions.pod:3907 ../fish/guestfish-actions.pod:3922 ../fish/guestfish-actions.pod:3998 ../fish/guestfish-actions.pod:4015 ../fish/guestfish-actions.pod:4030 ../fish/guestfish-actions.pod:4699 ../fish/guestfish-actions.pod:4745 ../fish/guestfish-actions.pod:4830 ../fish/guestfish-actions.pod:4845 ../fish/guestfish-actions.pod:5251 ../fish/guestfish-actions.pod:5263 ../fish/guestfish-actions.pod:5281 ../fish/guestfish-actions.pod:5298 ../fish/guestfish-actions.pod:5308 ../fish/guestfish-actions.pod:5362 ../fish/guestfish-actions.pod:5372 ../fish/guestfish-actions.pod:5401 ../fish/guestfish-actions.pod:5411 ../src/guestfs-actions.pod:1001 ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1200 ../src/guestfs-actions.pod:1855 ../src/guestfs-actions.pod:1874 ../src/guestfs-actions.pod:1977 ../src/guestfs-actions.pod:1996 ../src/guestfs-actions.pod:2242 ../src/guestfs-actions.pod:2724 ../src/guestfs-actions.pod:2743 ../src/guestfs-actions.pod:2808 ../src/guestfs-actions.pod:2832 ../src/guestfs-actions.pod:2849 ../src/guestfs-actions.pod:2878 ../src/guestfs-actions.pod:6079 ../src/guestfs-actions.pod:6105 ../src/guestfs-actions.pod:6236 ../src/guestfs-actions.pod:6262 ../src/guestfs-actions.pod:6286 ../src/guestfs-actions.pod:7241 ../src/guestfs-actions.pod:7296 ../src/guestfs-actions.pod:7442 ../src/guestfs-actions.pod:7466 ../src/guestfs-actions.pod:8131 ../src/guestfs-actions.pod:8151 ../src/guestfs-actions.pod:8184 ../src/guestfs-actions.pod:8203 ../src/guestfs-actions.pod:8222 ../src/guestfs-actions.pod:8313 ../src/guestfs-actions.pod:8332 ../src/guestfs-actions.pod:8378 ../src/guestfs-actions.pod:8397
6631 msgid ""
6632 "Because of the message protocol, there is a transfer limit of somewhere "
6633 "between 2MB and 4MB.  See L<guestfs(3)/PROTOCOL LIMITS>."
6634 msgstr ""
6635
6636 #. type: =head2
6637 #: ../fish/guestfish-actions.pod:676
6638 msgid "checksum"
6639 msgstr ""
6640
6641 #. type: verbatim
6642 #: ../fish/guestfish-actions.pod:678
6643 #, no-wrap
6644 msgid ""
6645 " checksum csumtype path\n"
6646 "\n"
6647 msgstr ""
6648
6649 #. type: textblock
6650 #: ../fish/guestfish-actions.pod:680 ../src/guestfs-actions.pod:1013
6651 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
6652 msgstr ""
6653
6654 #. type: textblock
6655 #: ../fish/guestfish-actions.pod:683 ../src/guestfs-actions.pod:1016
6656 msgid ""
6657 "The type of checksum to compute is given by the C<csumtype> parameter which "
6658 "must have one of the following values:"
6659 msgstr ""
6660
6661 #. type: =item
6662 #: ../fish/guestfish-actions.pod:688 ../src/guestfs-actions.pod:1021
6663 msgid "C<crc>"
6664 msgstr ""
6665
6666 #. type: textblock
6667 #: ../fish/guestfish-actions.pod:690 ../src/guestfs-actions.pod:1023
6668 msgid ""
6669 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
6670 "C<cksum> command."
6671 msgstr ""
6672
6673 #. type: =item
6674 #: ../fish/guestfish-actions.pod:693 ../src/guestfs-actions.pod:1026
6675 msgid "C<md5>"
6676 msgstr ""
6677
6678 #. type: textblock
6679 #: ../fish/guestfish-actions.pod:695 ../src/guestfs-actions.pod:1028
6680 msgid "Compute the MD5 hash (using the C<md5sum> program)."
6681 msgstr ""
6682
6683 #. type: =item
6684 #: ../fish/guestfish-actions.pod:697 ../src/guestfs-actions.pod:1030
6685 msgid "C<sha1>"
6686 msgstr ""
6687
6688 #. type: textblock
6689 #: ../fish/guestfish-actions.pod:699 ../src/guestfs-actions.pod:1032
6690 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
6691 msgstr ""
6692
6693 #. type: =item
6694 #: ../fish/guestfish-actions.pod:701 ../src/guestfs-actions.pod:1034
6695 msgid "C<sha224>"
6696 msgstr ""
6697
6698 #. type: textblock
6699 #: ../fish/guestfish-actions.pod:703 ../src/guestfs-actions.pod:1036
6700 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
6701 msgstr ""
6702
6703 #. type: =item
6704 #: ../fish/guestfish-actions.pod:705 ../src/guestfs-actions.pod:1038
6705 msgid "C<sha256>"
6706 msgstr ""
6707
6708 #. type: textblock
6709 #: ../fish/guestfish-actions.pod:707 ../src/guestfs-actions.pod:1040
6710 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
6711 msgstr ""
6712
6713 #. type: =item
6714 #: ../fish/guestfish-actions.pod:709 ../src/guestfs-actions.pod:1042
6715 msgid "C<sha384>"
6716 msgstr ""
6717
6718 #. type: textblock
6719 #: ../fish/guestfish-actions.pod:711 ../src/guestfs-actions.pod:1044
6720 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
6721 msgstr ""
6722
6723 #. type: =item
6724 #: ../fish/guestfish-actions.pod:713 ../src/guestfs-actions.pod:1046
6725 msgid "C<sha512>"
6726 msgstr ""
6727
6728 #. type: textblock
6729 #: ../fish/guestfish-actions.pod:715 ../src/guestfs-actions.pod:1048
6730 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
6731 msgstr ""
6732
6733 #. type: textblock
6734 #: ../fish/guestfish-actions.pod:719 ../src/guestfs-actions.pod:1052
6735 msgid "The checksum is returned as a printable string."
6736 msgstr ""
6737
6738 #. type: textblock
6739 #: ../fish/guestfish-actions.pod:721
6740 msgid "To get the checksum for a device, use L</checksum-device>."
6741 msgstr ""
6742
6743 #. type: textblock
6744 #: ../fish/guestfish-actions.pod:723
6745 msgid "To get the checksums for many files, use L</checksums-out>."
6746 msgstr ""
6747
6748 #. type: =head2
6749 #: ../fish/guestfish-actions.pod:725
6750 msgid "checksum-device"
6751 msgstr ""
6752
6753 #. type: verbatim
6754 #: ../fish/guestfish-actions.pod:727
6755 #, no-wrap
6756 msgid ""
6757 " checksum-device csumtype device\n"
6758 "\n"
6759 msgstr ""
6760
6761 #. type: textblock
6762 #: ../fish/guestfish-actions.pod:729
6763 msgid ""
6764 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
6765 "device named C<device>.  For the types of checksums supported see the "
6766 "L</checksum> command."
6767 msgstr ""
6768
6769 #. type: =head2
6770 #: ../fish/guestfish-actions.pod:733
6771 msgid "checksums-out"
6772 msgstr ""
6773
6774 #. type: verbatim
6775 #: ../fish/guestfish-actions.pod:735
6776 #, no-wrap
6777 msgid ""
6778 " checksums-out csumtype directory (sumsfile|-)\n"
6779 "\n"
6780 msgstr ""
6781
6782 #. type: textblock
6783 #: ../fish/guestfish-actions.pod:737 ../src/guestfs-actions.pod:1087
6784 msgid ""
6785 "This command computes the checksums of all regular files in C<directory> and "
6786 "then emits a list of those checksums to the local output file C<sumsfile>."
6787 msgstr ""
6788
6789 #. type: textblock
6790 #: ../fish/guestfish-actions.pod:741 ../src/guestfs-actions.pod:1091
6791 msgid ""
6792 "This can be used for verifying the integrity of a virtual machine.  However "
6793 "to be properly secure you should pay attention to the output of the checksum "
6794 "command (it uses the ones from GNU coreutils).  In particular when the "
6795 "filename is not printable, coreutils uses a special backslash syntax.  For "
6796 "more information, see the GNU coreutils info file."
6797 msgstr ""
6798
6799 #. type: =head2
6800 #: ../fish/guestfish-actions.pod:751
6801 msgid "chmod"
6802 msgstr ""
6803
6804 #. type: verbatim
6805 #: ../fish/guestfish-actions.pod:753
6806 #, no-wrap
6807 msgid ""
6808 " chmod mode path\n"
6809 "\n"
6810 msgstr ""
6811
6812 #. type: textblock
6813 #: ../fish/guestfish-actions.pod:755 ../src/guestfs-actions.pod:1110
6814 msgid ""
6815 "Change the mode (permissions) of C<path> to C<mode>.  Only numeric modes are "
6816 "supported."
6817 msgstr ""
6818
6819 #. type: textblock
6820 #: ../fish/guestfish-actions.pod:758 ../src/guestfs-actions.pod:1113
6821 msgid ""
6822 "I<Note>: When using this command from guestfish, C<mode> by default would be "
6823 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
6824 "C<700>."
6825 msgstr ""
6826
6827 #. type: textblock
6828 #: ../fish/guestfish-actions.pod:762 ../fish/guestfish-actions.pod:3259 ../fish/guestfish-actions.pod:3398 ../fish/guestfish-actions.pod:3408 ../fish/guestfish-actions.pod:3418 ../src/guestfs-actions.pod:1117 ../src/guestfs-actions.pod:5044 ../src/guestfs-actions.pod:5253 ../src/guestfs-actions.pod:5272 ../src/guestfs-actions.pod:5291
6829 msgid "The mode actually set is affected by the umask."
6830 msgstr ""
6831
6832 #. type: =head2
6833 #: ../fish/guestfish-actions.pod:764
6834 msgid "chown"
6835 msgstr ""
6836
6837 #. type: verbatim
6838 #: ../fish/guestfish-actions.pod:766
6839 #, no-wrap
6840 msgid ""
6841 " chown owner group path\n"
6842 "\n"
6843 msgstr ""
6844
6845 #. type: textblock
6846 #: ../fish/guestfish-actions.pod:768 ../src/guestfs-actions.pod:1131
6847 msgid "Change the file owner to C<owner> and group to C<group>."
6848 msgstr ""
6849
6850 #. type: textblock
6851 #: ../fish/guestfish-actions.pod:770 ../fish/guestfish-actions.pod:2703 ../src/guestfs-actions.pod:1133 ../src/guestfs-actions.pod:4124
6852 msgid ""
6853 "Only numeric uid and gid are supported.  If you want to use names, you will "
6854 "need to locate and parse the password file yourself (Augeas support makes "
6855 "this relatively easy)."
6856 msgstr ""
6857
6858 #. type: =head2
6859 #: ../fish/guestfish-actions.pod:774
6860 msgid "command"
6861 msgstr ""
6862
6863 #. type: verbatim
6864 #: ../fish/guestfish-actions.pod:776
6865 #, no-wrap
6866 msgid ""
6867 " command 'arguments ...'\n"
6868 "\n"
6869 msgstr ""
6870
6871 #. type: textblock
6872 #: ../fish/guestfish-actions.pod:778 ../src/guestfs-actions.pod:1147
6873 msgid ""
6874 "This call runs a command from the guest filesystem.  The filesystem must be "
6875 "mounted, and must contain a compatible operating system (ie. something "
6876 "Linux, with the same or compatible processor architecture)."
6877 msgstr ""
6878
6879 #. type: textblock
6880 #: ../fish/guestfish-actions.pod:783
6881 msgid ""
6882 "The single parameter is an argv-style list of arguments.  The first element "
6883 "is the name of the program to run.  Subsequent elements are parameters.  The "
6884 "list must be non-empty (ie. must contain a program name).  Note that the "
6885 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
6886 msgstr ""
6887
6888 #. type: textblock
6889 #: ../fish/guestfish-actions.pod:790 ../src/guestfs-actions.pod:1159
6890 msgid "The return value is anything printed to I<stdout> by the command."
6891 msgstr ""
6892
6893 #. type: textblock
6894 #: ../fish/guestfish-actions.pod:793 ../src/guestfs-actions.pod:1162
6895 msgid ""
6896 "If the command returns a non-zero exit status, then this function returns an "
6897 "error message.  The error message string is the content of I<stderr> from "
6898 "the command."
6899 msgstr ""
6900
6901 #. type: textblock
6902 #: ../fish/guestfish-actions.pod:797 ../src/guestfs-actions.pod:1166
6903 msgid ""
6904 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
6905 "C</bin>.  If you require a program from another location, you should provide "
6906 "the full path in the first parameter."
6907 msgstr ""
6908
6909 #. type: textblock
6910 #: ../fish/guestfish-actions.pod:802 ../src/guestfs-actions.pod:1171
6911 msgid ""
6912 "Shared libraries and data files required by the program must be available on "
6913 "filesystems which are mounted in the correct places.  It is the caller's "
6914 "responsibility to ensure all filesystems that are needed are mounted at the "
6915 "right locations."
6916 msgstr ""
6917
6918 #. type: =head2
6919 #: ../fish/guestfish-actions.pod:811
6920 msgid "command-lines"
6921 msgstr ""
6922
6923 #. type: verbatim
6924 #: ../fish/guestfish-actions.pod:813
6925 #, no-wrap
6926 msgid ""
6927 " command-lines 'arguments ...'\n"
6928 "\n"
6929 msgstr ""
6930
6931 #. type: textblock
6932 #: ../fish/guestfish-actions.pod:815
6933 msgid "This is the same as L</command>, but splits the result into a list of lines."
6934 msgstr ""
6935
6936 #. type: textblock
6937 #: ../fish/guestfish-actions.pod:818
6938 msgid "See also: L</sh-lines>"
6939 msgstr ""
6940
6941 #. type: =head2
6942 #: ../fish/guestfish-actions.pod:823
6943 msgid "compress-device-out"
6944 msgstr ""
6945
6946 #. type: verbatim
6947 #: ../fish/guestfish-actions.pod:825
6948 #, no-wrap
6949 msgid ""
6950 " compress-device-out ctype device (zdevice|-) [level:..]\n"
6951 "\n"
6952 msgstr ""
6953
6954 #. type: textblock
6955 #: ../fish/guestfish-actions.pod:827 ../src/guestfs-actions.pod:1221
6956 msgid ""
6957 "This command compresses C<device> and writes it out to the local file "
6958 "C<zdevice>."
6959 msgstr ""
6960
6961 #. type: textblock
6962 #: ../fish/guestfish-actions.pod:830
6963 msgid ""
6964 "The C<ctype> and optional C<level> parameters have the same meaning as in "
6965 "L</compress-out>."
6966 msgstr ""
6967
6968 #. type: =head2
6969 #: ../fish/guestfish-actions.pod:837
6970 msgid "compress-out"
6971 msgstr ""
6972
6973 #. type: verbatim
6974 #: ../fish/guestfish-actions.pod:839
6975 #, no-wrap
6976 msgid ""
6977 " compress-out ctype file (zfile|-) [level:..]\n"
6978 "\n"
6979 msgstr ""
6980
6981 #. type: textblock
6982 #: ../fish/guestfish-actions.pod:841 ../src/guestfs-actions.pod:1273
6983 msgid ""
6984 "This command compresses C<file> and writes it out to the local file "
6985 "C<zfile>."
6986 msgstr ""
6987
6988 #. type: textblock
6989 #: ../fish/guestfish-actions.pod:844 ../src/guestfs-actions.pod:1276
6990 msgid ""
6991 "The compression program used is controlled by the C<ctype> parameter.  "
6992 "Currently this includes: C<compress>, C<gzip>, C<bzip2>, C<xz> or C<lzop>.  "
6993 "Some compression types may not be supported by particular builds of "
6994 "libguestfs, in which case you will get an error containing the substring "
6995 "\"not supported\"."
6996 msgstr ""
6997
6998 #. type: textblock
6999 #: ../fish/guestfish-actions.pod:850 ../src/guestfs-actions.pod:1282
7000 msgid ""
7001 "The optional C<level> parameter controls compression level.  The meaning and "
7002 "default for this parameter depends on the compression program being used."
7003 msgstr ""
7004
7005 #. type: =head2
7006 #: ../fish/guestfish-actions.pod:858
7007 msgid "config"
7008 msgstr ""
7009
7010 #. type: verbatim
7011 #: ../fish/guestfish-actions.pod:860
7012 #, no-wrap
7013 msgid ""
7014 " config qemuparam qemuvalue\n"
7015 "\n"
7016 msgstr ""
7017
7018 #. type: textblock
7019 #: ../fish/guestfish-actions.pod:862 ../src/guestfs-actions.pod:1323
7020 msgid ""
7021 "This can be used to add arbitrary qemu command line parameters of the form "
7022 "I<-param value>.  Actually it's not quite arbitrary - we prevent you from "
7023 "setting some parameters which would interfere with parameters that we use."
7024 msgstr ""
7025
7026 #. type: textblock
7027 #: ../fish/guestfish-actions.pod:867 ../src/guestfs-actions.pod:1328
7028 msgid "The first character of C<param> string must be a C<-> (dash)."
7029 msgstr ""
7030
7031 #. type: textblock
7032 #: ../fish/guestfish-actions.pod:869 ../src/guestfs-actions.pod:1330
7033 msgid "C<value> can be NULL."
7034 msgstr ""
7035
7036 #. type: =head2
7037 #: ../fish/guestfish-actions.pod:871
7038 msgid "copy-device-to-device"
7039 msgstr ""
7040
7041 #. type: verbatim
7042 #: ../fish/guestfish-actions.pod:873
7043 #, no-wrap
7044 msgid ""
7045 " copy-device-to-device src dest [srcoffset:..] [destoffset:..] [size:..]\n"
7046 "\n"
7047 msgstr ""
7048
7049 #. type: textblock
7050 #: ../fish/guestfish-actions.pod:875
7051 msgid ""
7052 "The four calls L</copy-device-to-device>, L</copy-device-to-file>, "
7053 "L</copy-file-to-device>, and L</copy-file-to-file> let you copy from a "
7054 "source (device|file) to a destination (device|file)."
7055 msgstr ""
7056
7057 #. type: textblock
7058 #: ../fish/guestfish-actions.pod:882 ../src/guestfs-actions.pod:1360
7059 msgid ""
7060 "Partial copies can be made since you can specify optionally the source "
7061 "offset, destination offset and size to copy.  These values are all specified "
7062 "in bytes.  If not given, the offsets both default to zero, and the size "
7063 "defaults to copying as much as possible until we hit the end of the source."
7064 msgstr ""
7065
7066 #. type: textblock
7067 #: ../fish/guestfish-actions.pod:888 ../src/guestfs-actions.pod:1366
7068 msgid ""
7069 "The source and destination may be the same object.  However overlapping "
7070 "regions may not be copied correctly."
7071 msgstr ""
7072
7073 #. type: textblock
7074 #: ../fish/guestfish-actions.pod:891 ../src/guestfs-actions.pod:1369
7075 msgid ""
7076 "If the destination is a file, it is created if required.  If the destination "
7077 "file is not large enough, it is extended."
7078 msgstr ""
7079
7080 #. type: =head2
7081 #: ../fish/guestfish-actions.pod:896
7082 msgid "copy-device-to-file"
7083 msgstr ""
7084
7085 #. type: verbatim
7086 #: ../fish/guestfish-actions.pod:898
7087 #, no-wrap
7088 msgid ""
7089 " copy-device-to-file src dest [srcoffset:..] [destoffset:..] [size:..]\n"
7090 "\n"
7091 msgstr ""
7092
7093 #. type: textblock
7094 #: ../fish/guestfish-actions.pod:900 ../fish/guestfish-actions.pod:909 ../fish/guestfish-actions.pod:918
7095 msgid "See L</copy-device-to-device> for a general overview of this call."
7096 msgstr ""
7097
7098 #. type: =head2
7099 #: ../fish/guestfish-actions.pod:905
7100 msgid "copy-file-to-device"
7101 msgstr ""
7102
7103 #. type: verbatim
7104 #: ../fish/guestfish-actions.pod:907
7105 #, no-wrap
7106 msgid ""
7107 " copy-file-to-device src dest [srcoffset:..] [destoffset:..] [size:..]\n"
7108 "\n"
7109 msgstr ""
7110
7111 #. type: =head2
7112 #: ../fish/guestfish-actions.pod:914
7113 msgid "copy-file-to-file"
7114 msgstr ""
7115
7116 #. type: verbatim
7117 #: ../fish/guestfish-actions.pod:916
7118 #, no-wrap
7119 msgid ""
7120 " copy-file-to-file src dest [srcoffset:..] [destoffset:..] [size:..]\n"
7121 "\n"
7122 msgstr ""
7123
7124 #. type: textblock
7125 #: ../fish/guestfish-actions.pod:921
7126 msgid ""
7127 "This is B<not> the function you want for copying files.  This is for copying "
7128 "blocks within existing files.  See L</cp>, L</cp-a> and L</mv> for general "
7129 "file copying and moving functions."
7130 msgstr ""
7131
7132 #. type: =head2
7133 #: ../fish/guestfish-actions.pod:928
7134 msgid "copy-size"
7135 msgstr ""
7136
7137 #. type: verbatim
7138 #: ../fish/guestfish-actions.pod:930
7139 #, no-wrap
7140 msgid ""
7141 " copy-size src dest size\n"
7142 "\n"
7143 msgstr ""
7144
7145 #. type: textblock
7146 #: ../fish/guestfish-actions.pod:932 ../src/guestfs-actions.pod:1584
7147 msgid ""
7148 "This command copies exactly C<size> bytes from one source device or file "
7149 "C<src> to another destination device or file C<dest>."
7150 msgstr ""
7151
7152 #. type: textblock
7153 #: ../fish/guestfish-actions.pod:935 ../src/guestfs-actions.pod:1587
7154 msgid ""
7155 "Note this will fail if the source is too short or if the destination is not "
7156 "large enough."
7157 msgstr ""
7158
7159 #. type: textblock
7160 #: ../fish/guestfish-actions.pod:938 ../fish/guestfish-actions.pod:973
7161 msgid ""
7162 "I<This function is deprecated.> In new code, use the "
7163 "L</copy_device_to_device> call instead."
7164 msgstr ""
7165
7166 #. type: =head2
7167 #: ../fish/guestfish-actions.pod:945
7168 msgid "cp"
7169 msgstr ""
7170
7171 #. type: verbatim
7172 #: ../fish/guestfish-actions.pod:947
7173 #, no-wrap
7174 msgid ""
7175 " cp src dest\n"
7176 "\n"
7177 msgstr ""
7178
7179 #. type: textblock
7180 #: ../fish/guestfish-actions.pod:949 ../src/guestfs-actions.pod:1606
7181 msgid ""
7182 "This copies a file from C<src> to C<dest> where C<dest> is either a "
7183 "destination filename or destination directory."
7184 msgstr ""
7185
7186 #. type: =head2
7187 #: ../fish/guestfish-actions.pod:952
7188 msgid "cp-a"
7189 msgstr ""
7190
7191 #. type: verbatim
7192 #: ../fish/guestfish-actions.pod:954
7193 #, no-wrap
7194 msgid ""
7195 " cp-a src dest\n"
7196 "\n"
7197 msgstr ""
7198
7199 #. type: textblock
7200 #: ../fish/guestfish-actions.pod:956 ../src/guestfs-actions.pod:1620
7201 msgid ""
7202 "This copies a file or directory from C<src> to C<dest> recursively using the "
7203 "C<cp -a> command."
7204 msgstr ""
7205
7206 #. type: =head2
7207 #: ../fish/guestfish-actions.pod:959
7208 msgid "dd"
7209 msgstr ""
7210
7211 #. type: verbatim
7212 #: ../fish/guestfish-actions.pod:961
7213 #, no-wrap
7214 msgid ""
7215 " dd src dest\n"
7216 "\n"
7217 msgstr ""
7218
7219 #. type: textblock
7220 #: ../fish/guestfish-actions.pod:963 ../src/guestfs-actions.pod:1641
7221 msgid ""
7222 "This command copies from one source device or file C<src> to another "
7223 "destination device or file C<dest>.  Normally you would use this to copy to "
7224 "or from a device or partition, for example to duplicate a filesystem."
7225 msgstr ""
7226
7227 #. type: textblock
7228 #: ../fish/guestfish-actions.pod:968
7229 msgid ""
7230 "If the destination is a device, it must be as large or larger than the "
7231 "source file or device, otherwise the copy will fail.  This command cannot do "
7232 "partial copies (see L</copy-device-to-device>)."
7233 msgstr ""
7234
7235 #. type: =head2
7236 #: ../fish/guestfish-actions.pod:980
7237 msgid "df"
7238 msgstr ""
7239
7240 #. type: verbatim
7241 #: ../fish/guestfish-actions.pod:982
7242 #, no-wrap
7243 msgid ""
7244 " df\n"
7245 "\n"
7246 msgstr ""
7247
7248 #. type: textblock
7249 #: ../fish/guestfish-actions.pod:984 ../src/guestfs-actions.pod:1660
7250 msgid "This command runs the C<df> command to report disk space used."
7251 msgstr ""
7252
7253 #. type: textblock
7254 #: ../fish/guestfish-actions.pod:986 ../fish/guestfish-actions.pod:997
7255 msgid ""
7256 "This command is mostly useful for interactive sessions.  It is I<not> "
7257 "intended that you try to parse the output string.  Use L</statvfs> from "
7258 "programs."
7259 msgstr ""
7260
7261 #. type: =head2
7262 #: ../fish/guestfish-actions.pod:990
7263 msgid "df-h"
7264 msgstr ""
7265
7266 #. type: verbatim
7267 #: ../fish/guestfish-actions.pod:992
7268 #, no-wrap
7269 msgid ""
7270 " df-h\n"
7271 "\n"
7272 msgstr ""
7273
7274 #. type: textblock
7275 #: ../fish/guestfish-actions.pod:994 ../src/guestfs-actions.pod:1676
7276 msgid ""
7277 "This command runs the C<df -h> command to report disk space used in "
7278 "human-readable format."
7279 msgstr ""
7280
7281 #. type: =head2
7282 #: ../fish/guestfish-actions.pod:1001
7283 msgid "dmesg"
7284 msgstr ""
7285
7286 #. type: verbatim
7287 #: ../fish/guestfish-actions.pod:1003
7288 #, no-wrap
7289 msgid ""
7290 " dmesg\n"
7291 "\n"
7292 msgstr ""
7293
7294 #. type: textblock
7295 #: ../fish/guestfish-actions.pod:1005 ../src/guestfs-actions.pod:1693
7296 msgid ""
7297 "This returns the kernel messages (C<dmesg> output) from the guest kernel.  "
7298 "This is sometimes useful for extended debugging of problems."
7299 msgstr ""
7300
7301 #. type: textblock
7302 #: ../fish/guestfish-actions.pod:1009
7303 msgid ""
7304 "Another way to get the same information is to enable verbose messages with "
7305 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
7306 "before running the program."
7307 msgstr ""
7308
7309 #. type: =head2
7310 #: ../fish/guestfish-actions.pod:1014
7311 msgid "download"
7312 msgstr ""
7313
7314 #. type: verbatim
7315 #: ../fish/guestfish-actions.pod:1016
7316 #, no-wrap
7317 msgid ""
7318 " download remotefilename (filename|-)\n"
7319 "\n"
7320 msgstr ""
7321
7322 #. type: textblock
7323 #: ../fish/guestfish-actions.pod:1018 ../fish/guestfish-actions.pod:1031 ../src/guestfs-actions.pod:1714 ../src/guestfs-actions.pod:1739
7324 msgid ""
7325 "Download file C<remotefilename> and save it as C<filename> on the local "
7326 "machine."
7327 msgstr ""
7328
7329 #. type: textblock
7330 #: ../fish/guestfish-actions.pod:1021 ../fish/guestfish-actions.pod:5003 ../src/guestfs-actions.pod:1717 ../src/guestfs-actions.pod:7701
7331 msgid "C<filename> can also be a named pipe."
7332 msgstr ""
7333
7334 #. type: textblock
7335 #: ../fish/guestfish-actions.pod:1023
7336 msgid "See also L</upload>, L</cat>."
7337 msgstr ""
7338
7339 #. type: =head2
7340 #: ../fish/guestfish-actions.pod:1027
7341 msgid "download-offset"
7342 msgstr ""
7343
7344 #. type: verbatim
7345 #: ../fish/guestfish-actions.pod:1029
7346 #, no-wrap
7347 msgid ""
7348 " download-offset remotefilename (filename|-) offset size\n"
7349 "\n"
7350 msgstr ""
7351
7352 #. type: textblock
7353 #: ../fish/guestfish-actions.pod:1034 ../src/guestfs-actions.pod:1742
7354 msgid ""
7355 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
7356 "region must be within the file or device)."
7357 msgstr ""
7358
7359 #. type: textblock
7360 #: ../fish/guestfish-actions.pod:1037
7361 msgid ""
7362 "Note that there is no limit on the amount of data that can be downloaded "
7363 "with this call, unlike with L</pread>, and this call always reads the full "
7364 "amount unless an error occurs."
7365 msgstr ""
7366
7367 #. type: textblock
7368 #: ../fish/guestfish-actions.pod:1042
7369 msgid "See also L</download>, L</pread>."
7370 msgstr ""
7371
7372 #. type: =head2
7373 #: ../fish/guestfish-actions.pod:1046
7374 msgid "drop-caches"
7375 msgstr ""
7376
7377 #. type: verbatim
7378 #: ../fish/guestfish-actions.pod:1048
7379 #, no-wrap
7380 msgid ""
7381 " drop-caches whattodrop\n"
7382 "\n"
7383 msgstr ""
7384
7385 #. type: textblock
7386 #: ../fish/guestfish-actions.pod:1050 ../src/guestfs-actions.pod:1767
7387 msgid ""
7388 "This instructs the guest kernel to drop its page cache, and/or dentries and "
7389 "inode caches.  The parameter C<whattodrop> tells the kernel what precisely "
7390 "to drop, see L<http://linux-mm.org/Drop_Caches>"
7391 msgstr ""
7392
7393 #. type: textblock
7394 #: ../fish/guestfish-actions.pod:1055 ../src/guestfs-actions.pod:1772
7395 msgid "Setting C<whattodrop> to 3 should drop everything."
7396 msgstr ""
7397
7398 #. type: textblock
7399 #: ../fish/guestfish-actions.pod:1057 ../src/guestfs-actions.pod:1774
7400 msgid ""
7401 "This automatically calls L<sync(2)> before the operation, so that the "
7402 "maximum guest memory is freed."
7403 msgstr ""
7404
7405 #. type: =head2
7406 #: ../fish/guestfish-actions.pod:1060
7407 msgid "du"
7408 msgstr ""
7409
7410 #. type: verbatim
7411 #: ../fish/guestfish-actions.pod:1062
7412 #, no-wrap
7413 msgid ""
7414 " du path\n"
7415 "\n"
7416 msgstr ""
7417
7418 #. type: textblock
7419 #: ../fish/guestfish-actions.pod:1064 ../src/guestfs-actions.pod:1787
7420 msgid ""
7421 "This command runs the C<du -s> command to estimate file space usage for "
7422 "C<path>."
7423 msgstr ""
7424
7425 #. type: textblock
7426 #: ../fish/guestfish-actions.pod:1067 ../src/guestfs-actions.pod:1790
7427 msgid ""
7428 "C<path> can be a file or a directory.  If C<path> is a directory then the "
7429 "estimate includes the contents of the directory and all subdirectories "
7430 "(recursively)."
7431 msgstr ""
7432
7433 #. type: textblock
7434 #: ../fish/guestfish-actions.pod:1071 ../src/guestfs-actions.pod:1794
7435 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
7436 msgstr ""
7437
7438 #. type: =head2
7439 #: ../fish/guestfish-actions.pod:1074
7440 msgid "e2fsck-f"
7441 msgstr ""
7442
7443 #. type: verbatim
7444 #: ../fish/guestfish-actions.pod:1076
7445 #, no-wrap
7446 msgid ""
7447 " e2fsck-f device\n"
7448 "\n"
7449 msgstr ""
7450
7451 #. type: textblock
7452 #: ../fish/guestfish-actions.pod:1078 ../src/guestfs-actions.pod:1812
7453 msgid ""
7454 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
7455 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
7456 "clean (I<-f>)."
7457 msgstr ""
7458
7459 #. type: textblock
7460 #: ../fish/guestfish-actions.pod:1082
7461 msgid ""
7462 "This command is only needed because of L</resize2fs> (q.v.).  Normally you "
7463 "should use L</fsck>."
7464 msgstr ""
7465
7466 #. type: =head2
7467 #: ../fish/guestfish-actions.pod:1085
7468 msgid "echo-daemon"
7469 msgstr ""
7470
7471 #. type: verbatim
7472 #: ../fish/guestfish-actions.pod:1087
7473 #, no-wrap
7474 msgid ""
7475 " echo-daemon 'words ...'\n"
7476 "\n"
7477 msgstr ""
7478
7479 #. type: textblock
7480 #: ../fish/guestfish-actions.pod:1089 ../src/guestfs-actions.pod:1829
7481 msgid ""
7482 "This command concatenates the list of C<words> passed with single spaces "
7483 "between them and returns the resulting string."
7484 msgstr ""
7485
7486 #. type: textblock
7487 #: ../fish/guestfish-actions.pod:1092 ../src/guestfs-actions.pod:1832
7488 msgid "You can use this command to test the connection through to the daemon."
7489 msgstr ""
7490
7491 #. type: textblock
7492 #: ../fish/guestfish-actions.pod:1094
7493 msgid "See also L</ping-daemon>."
7494 msgstr ""
7495
7496 #. type: =head2
7497 #: ../fish/guestfish-actions.pod:1096
7498 msgid "egrep"
7499 msgstr ""
7500
7501 #. type: verbatim
7502 #: ../fish/guestfish-actions.pod:1098
7503 #, no-wrap
7504 msgid ""
7505 " egrep regex path\n"
7506 "\n"
7507 msgstr ""
7508
7509 #. type: textblock
7510 #: ../fish/guestfish-actions.pod:1100 ../src/guestfs-actions.pod:1848
7511 msgid "This calls the external C<egrep> program and returns the matching lines."
7512 msgstr ""
7513
7514 #. type: =head2
7515 #: ../fish/guestfish-actions.pod:1106
7516 msgid "egrepi"
7517 msgstr ""
7518
7519 #. type: verbatim
7520 #: ../fish/guestfish-actions.pod:1108
7521 #, no-wrap
7522 msgid ""
7523 " egrepi regex path\n"
7524 "\n"
7525 msgstr ""
7526
7527 #. type: textblock
7528 #: ../fish/guestfish-actions.pod:1110 ../src/guestfs-actions.pod:1867
7529 msgid "This calls the external C<egrep -i> program and returns the matching lines."
7530 msgstr ""
7531
7532 #. type: =head2
7533 #: ../fish/guestfish-actions.pod:1116
7534 msgid "equal"
7535 msgstr ""
7536
7537 #. type: verbatim
7538 #: ../fish/guestfish-actions.pod:1118
7539 #, no-wrap
7540 msgid ""
7541 " equal file1 file2\n"
7542 "\n"
7543 msgstr ""
7544
7545 #. type: textblock
7546 #: ../fish/guestfish-actions.pod:1120 ../src/guestfs-actions.pod:1886
7547 msgid ""
7548 "This compares the two files C<file1> and C<file2> and returns true if their "
7549 "content is exactly equal, or false otherwise."
7550 msgstr ""
7551
7552 #. type: textblock
7553 #: ../fish/guestfish-actions.pod:1123 ../src/guestfs-actions.pod:1889
7554 msgid "The external L<cmp(1)> program is used for the comparison."
7555 msgstr ""
7556
7557 #. type: =head2
7558 #: ../fish/guestfish-actions.pod:1125
7559 msgid "exists"
7560 msgstr ""
7561
7562 #. type: verbatim
7563 #: ../fish/guestfish-actions.pod:1127
7564 #, no-wrap
7565 msgid ""
7566 " exists path\n"
7567 "\n"
7568 msgstr ""
7569
7570 #. type: textblock
7571 #: ../fish/guestfish-actions.pod:1129 ../src/guestfs-actions.pod:1901
7572 msgid ""
7573 "This returns C<true> if and only if there is a file, directory (or anything) "
7574 "with the given C<path> name."
7575 msgstr ""
7576
7577 #. type: textblock
7578 #: ../fish/guestfish-actions.pod:1132
7579 msgid "See also L</is-file>, L</is-dir>, L</stat>."
7580 msgstr ""
7581
7582 #. type: =head2
7583 #: ../fish/guestfish-actions.pod:1134
7584 msgid "fallocate"
7585 msgstr ""
7586
7587 #. type: verbatim
7588 #: ../fish/guestfish-actions.pod:1136
7589 #, no-wrap
7590 msgid ""
7591 " fallocate path len\n"
7592 "\n"
7593 msgstr ""
7594
7595 #. type: textblock
7596 #: ../fish/guestfish-actions.pod:1138 ../fish/guestfish-actions.pod:1157 ../src/guestfs-actions.pod:1924 ../src/guestfs-actions.pod:1943
7597 msgid ""
7598 "This command preallocates a file (containing zero bytes) named C<path> of "
7599 "size C<len> bytes.  If the file exists already, it is overwritten."
7600 msgstr ""
7601
7602 #. type: textblock
7603 #: ../fish/guestfish-actions.pod:1142 ../src/guestfs-actions.pod:1928
7604 msgid ""
7605 "Do not confuse this with the guestfish-specific C<alloc> command which "
7606 "allocates a file in the host and attaches it as a device."
7607 msgstr ""
7608
7609 #. type: textblock
7610 #: ../fish/guestfish-actions.pod:1146
7611 msgid ""
7612 "I<This function is deprecated.> In new code, use the L</fallocate64> call "
7613 "instead."
7614 msgstr ""
7615
7616 #. type: =head2
7617 #: ../fish/guestfish-actions.pod:1153
7618 msgid "fallocate64"
7619 msgstr ""
7620
7621 #. type: verbatim
7622 #: ../fish/guestfish-actions.pod:1155
7623 #, no-wrap
7624 msgid ""
7625 " fallocate64 path len\n"
7626 "\n"
7627 msgstr ""
7628
7629 #. type: textblock
7630 #: ../fish/guestfish-actions.pod:1161
7631 msgid ""
7632 "Note that this call allocates disk blocks for the file.  To create a sparse "
7633 "file use L</truncate-size> instead."
7634 msgstr ""
7635
7636 #. type: textblock
7637 #: ../fish/guestfish-actions.pod:1164
7638 msgid ""
7639 "The deprecated call L</fallocate> does the same, but owing to an oversight "
7640 "it only allowed 30 bit lengths to be specified, effectively limiting the "
7641 "maximum size of files created through that call to 1GB."
7642 msgstr ""
7643
7644 #. type: textblock
7645 #: ../fish/guestfish-actions.pod:1169 ../src/guestfs-actions.pod:1955
7646 msgid ""
7647 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
7648 "commands which create a file in the host and attach it as a device."
7649 msgstr ""
7650
7651 #. type: =head2
7652 #: ../fish/guestfish-actions.pod:1173
7653 msgid "fgrep"
7654 msgstr ""
7655
7656 #. type: verbatim
7657 #: ../fish/guestfish-actions.pod:1175
7658 #, no-wrap
7659 msgid ""
7660 " fgrep pattern path\n"
7661 "\n"
7662 msgstr ""
7663
7664 #. type: textblock
7665 #: ../fish/guestfish-actions.pod:1177 ../src/guestfs-actions.pod:1970
7666 msgid "This calls the external C<fgrep> program and returns the matching lines."
7667 msgstr ""
7668
7669 #. type: =head2
7670 #: ../fish/guestfish-actions.pod:1183
7671 msgid "fgrepi"
7672 msgstr ""
7673
7674 #. type: verbatim
7675 #: ../fish/guestfish-actions.pod:1185
7676 #, no-wrap
7677 msgid ""
7678 " fgrepi pattern path\n"
7679 "\n"
7680 msgstr ""
7681
7682 #. type: textblock
7683 #: ../fish/guestfish-actions.pod:1187 ../src/guestfs-actions.pod:1989
7684 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
7685 msgstr ""
7686
7687 #. type: =head2
7688 #: ../fish/guestfish-actions.pod:1193
7689 msgid "file"
7690 msgstr ""
7691
7692 #. type: verbatim
7693 #: ../fish/guestfish-actions.pod:1195
7694 #, no-wrap
7695 msgid ""
7696 " file path\n"
7697 "\n"
7698 msgstr ""
7699
7700 #. type: textblock
7701 #: ../fish/guestfish-actions.pod:1197 ../src/guestfs-actions.pod:2007
7702 msgid ""
7703 "This call uses the standard L<file(1)> command to determine the type or "
7704 "contents of the file."
7705 msgstr ""
7706
7707 #. type: textblock
7708 #: ../fish/guestfish-actions.pod:1200 ../src/guestfs-actions.pod:2010
7709 msgid ""
7710 "This call will also transparently look inside various types of compressed "
7711 "file."
7712 msgstr ""
7713
7714 #. type: textblock
7715 #: ../fish/guestfish-actions.pod:1203 ../src/guestfs-actions.pod:2013
7716 msgid ""
7717 "The exact command which runs is C<file -zb path>.  Note in particular that "
7718 "the filename is not prepended to the output (the I<-b> option)."
7719 msgstr ""
7720
7721 #. type: textblock
7722 #: ../fish/guestfish-actions.pod:1207 ../src/guestfs-actions.pod:2017
7723 msgid ""
7724 "The output depends on the output of the underlying L<file(1)> command and it "
7725 "can change in future in ways beyond our control.  In other words, the output "
7726 "is not guaranteed by the ABI."
7727 msgstr ""
7728
7729 #. type: textblock
7730 #: ../fish/guestfish-actions.pod:1211
7731 msgid ""
7732 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
7733 "(etc), L</is-zero>."
7734 msgstr ""
7735
7736 #. type: =head2
7737 #: ../fish/guestfish-actions.pod:1214
7738 msgid "file-architecture"
7739 msgstr ""
7740
7741 #. type: verbatim
7742 #: ../fish/guestfish-actions.pod:1216
7743 #, no-wrap
7744 msgid ""
7745 " file-architecture filename\n"
7746 "\n"
7747 msgstr ""
7748
7749 #. type: textblock
7750 #: ../fish/guestfish-actions.pod:1218 ../src/guestfs-actions.pod:2035
7751 msgid ""
7752 "This detects the architecture of the binary C<filename>, and returns it if "
7753 "known."
7754 msgstr ""
7755
7756 #. type: textblock
7757 #: ../fish/guestfish-actions.pod:1221 ../src/guestfs-actions.pod:2038
7758 msgid "Currently defined architectures are:"
7759 msgstr ""
7760
7761 #. type: =item
7762 #: ../fish/guestfish-actions.pod:1225 ../src/guestfs-actions.pod:2042
7763 msgid "\"i386\""
7764 msgstr ""
7765
7766 #. type: textblock
7767 #: ../fish/guestfish-actions.pod:1227 ../src/guestfs-actions.pod:2044
7768 msgid ""
7769 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
7770 "irrespective of the precise processor requirements of the binary."
7771 msgstr ""
7772
7773 #. type: =item
7774 #: ../fish/guestfish-actions.pod:1230 ../src/guestfs-actions.pod:2047
7775 msgid "\"x86_64\""
7776 msgstr ""
7777
7778 #. type: textblock
7779 #: ../fish/guestfish-actions.pod:1232 ../src/guestfs-actions.pod:2049
7780 msgid "64 bit x86-64."
7781 msgstr ""
7782
7783 #. type: =item
7784 #: ../fish/guestfish-actions.pod:1234 ../src/guestfs-actions.pod:2051
7785 msgid "\"sparc\""
7786 msgstr ""
7787
7788 #. type: textblock
7789 #: ../fish/guestfish-actions.pod:1236 ../src/guestfs-actions.pod:2053
7790 msgid "32 bit SPARC."
7791 msgstr ""
7792
7793 #. type: =item
7794 #: ../fish/guestfish-actions.pod:1238 ../src/guestfs-actions.pod:2055
7795 msgid "\"sparc64\""
7796 msgstr ""
7797
7798 #. type: textblock
7799 #: ../fish/guestfish-actions.pod:1240 ../src/guestfs-actions.pod:2057
7800 msgid "64 bit SPARC V9 and above."
7801 msgstr ""
7802
7803 #. type: =item
7804 #: ../fish/guestfish-actions.pod:1242 ../src/guestfs-actions.pod:2059
7805 msgid "\"ia64\""
7806 msgstr ""
7807
7808 #. type: textblock
7809 #: ../fish/guestfish-actions.pod:1244 ../src/guestfs-actions.pod:2061
7810 msgid "Intel Itanium."
7811 msgstr ""
7812
7813 #. type: =item
7814 #: ../fish/guestfish-actions.pod:1246 ../src/guestfs-actions.pod:2063
7815 msgid "\"ppc\""
7816 msgstr ""
7817
7818 #. type: textblock
7819 #: ../fish/guestfish-actions.pod:1248 ../src/guestfs-actions.pod:2065
7820 msgid "32 bit Power PC."
7821 msgstr ""
7822
7823 #. type: =item
7824 #: ../fish/guestfish-actions.pod:1250 ../src/guestfs-actions.pod:2067
7825 msgid "\"ppc64\""
7826 msgstr ""
7827
7828 #. type: textblock
7829 #: ../fish/guestfish-actions.pod:1252 ../src/guestfs-actions.pod:2069
7830 msgid "64 bit Power PC."
7831 msgstr ""
7832
7833 #. type: textblock
7834 #: ../fish/guestfish-actions.pod:1256 ../src/guestfs-actions.pod:2073
7835 msgid "Libguestfs may return other architecture strings in future."
7836 msgstr ""
7837
7838 #. type: textblock
7839 #: ../fish/guestfish-actions.pod:1258 ../src/guestfs-actions.pod:2075
7840 msgid "The function works on at least the following types of files:"
7841 msgstr ""
7842
7843 #. type: textblock
7844 #: ../fish/guestfish-actions.pod:1264 ../src/guestfs-actions.pod:2081
7845 msgid "many types of Un*x and Linux binary"
7846 msgstr ""
7847
7848 #. type: textblock
7849 #: ../fish/guestfish-actions.pod:1268 ../src/guestfs-actions.pod:2085
7850 msgid "many types of Un*x and Linux shared library"
7851 msgstr ""
7852
7853 #. type: textblock
7854 #: ../fish/guestfish-actions.pod:1272 ../src/guestfs-actions.pod:2089
7855 msgid "Windows Win32 and Win64 binaries"
7856 msgstr ""
7857
7858 #. type: textblock
7859 #: ../fish/guestfish-actions.pod:1276 ../src/guestfs-actions.pod:2093
7860 msgid "Windows Win32 and Win64 DLLs"
7861 msgstr ""
7862
7863 #. type: textblock
7864 #: ../fish/guestfish-actions.pod:1278 ../src/guestfs-actions.pod:2095
7865 msgid "Win32 binaries and DLLs return C<i386>."
7866 msgstr ""
7867
7868 #. type: textblock
7869 #: ../fish/guestfish-actions.pod:1280 ../src/guestfs-actions.pod:2097
7870 msgid "Win64 binaries and DLLs return C<x86_64>."
7871 msgstr ""
7872
7873 #. type: textblock
7874 #: ../fish/guestfish-actions.pod:1284 ../src/guestfs-actions.pod:2101
7875 msgid "Linux kernel modules"
7876 msgstr ""
7877
7878 #. type: textblock
7879 #: ../fish/guestfish-actions.pod:1288 ../src/guestfs-actions.pod:2105
7880 msgid "Linux new-style initrd images"
7881 msgstr ""
7882
7883 #. type: textblock
7884 #: ../fish/guestfish-actions.pod:1292 ../src/guestfs-actions.pod:2109
7885 msgid "some non-x86 Linux vmlinuz kernels"
7886 msgstr ""
7887
7888 #. type: textblock
7889 #: ../fish/guestfish-actions.pod:1296 ../src/guestfs-actions.pod:2113
7890 msgid "What it can't do currently:"
7891 msgstr ""
7892
7893 #. type: textblock
7894 #: ../fish/guestfish-actions.pod:1302 ../src/guestfs-actions.pod:2119
7895 msgid "static libraries (libfoo.a)"
7896 msgstr ""
7897
7898 #. type: textblock
7899 #: ../fish/guestfish-actions.pod:1306 ../src/guestfs-actions.pod:2123
7900 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
7901 msgstr ""
7902
7903 #. type: textblock
7904 #: ../fish/guestfish-actions.pod:1310 ../src/guestfs-actions.pod:2127
7905 msgid "x86 Linux vmlinuz kernels"
7906 msgstr ""
7907
7908 #. type: textblock
7909 #: ../fish/guestfish-actions.pod:1312 ../src/guestfs-actions.pod:2129
7910 msgid ""
7911 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
7912 "compressed code, and are horribly hard to unpack.  If you want to find the "
7913 "architecture of a kernel, use the architecture of the associated initrd or "
7914 "kernel module(s) instead."
7915 msgstr ""
7916
7917 #. type: =head2
7918 #: ../fish/guestfish-actions.pod:1319
7919 msgid "filesize"
7920 msgstr ""
7921
7922 #. type: verbatim
7923 #: ../fish/guestfish-actions.pod:1321
7924 #, no-wrap
7925 msgid ""
7926 " filesize file\n"
7927 "\n"
7928 msgstr ""
7929
7930 #. type: textblock
7931 #: ../fish/guestfish-actions.pod:1323 ../src/guestfs-actions.pod:2147
7932 msgid "This command returns the size of C<file> in bytes."
7933 msgstr ""
7934
7935 #. type: textblock
7936 #: ../fish/guestfish-actions.pod:1325
7937 msgid ""
7938 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
7939 "L</is-file> etc.  To get the size of block devices, use "
7940 "L</blockdev-getsize64>."
7941 msgstr ""
7942
7943 #. type: =head2
7944 #: ../fish/guestfish-actions.pod:1329
7945 msgid "fill"
7946 msgstr ""
7947
7948 #. type: verbatim
7949 #: ../fish/guestfish-actions.pod:1331
7950 #, no-wrap
7951 msgid ""
7952 " fill c len path\n"
7953 "\n"
7954 msgstr ""
7955
7956 #. type: textblock
7957 #: ../fish/guestfish-actions.pod:1333 ../src/guestfs-actions.pod:2165
7958 msgid ""
7959 "This command creates a new file called C<path>.  The initial content of the "
7960 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
7961 "C<[0..255]>."
7962 msgstr ""
7963
7964 #. type: textblock
7965 #: ../fish/guestfish-actions.pod:1337
7966 msgid ""
7967 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
7968 "L</truncate-size>.  To create a file with a pattern of repeating bytes use "
7969 "L</fill-pattern>."
7970 msgstr ""
7971
7972 #. type: =head2
7973 #: ../fish/guestfish-actions.pod:1342
7974 msgid "fill-pattern"
7975 msgstr ""
7976
7977 #. type: verbatim
7978 #: ../fish/guestfish-actions.pod:1344
7979 #, no-wrap
7980 msgid ""
7981 " fill-pattern pattern len path\n"
7982 "\n"
7983 msgstr ""
7984
7985 #. type: textblock
7986 #: ../fish/guestfish-actions.pod:1346
7987 msgid ""
7988 "This function is like L</fill> except that it creates a new file of length "
7989 "C<len> containing the repeating pattern of bytes in C<pattern>.  The pattern "
7990 "is truncated if necessary to ensure the length of the file is exactly C<len> "
7991 "bytes."
7992 msgstr ""
7993
7994 #. type: =head2
7995 #: ../fish/guestfish-actions.pod:1351
7996 msgid "find"
7997 msgstr ""
7998
7999 #. type: verbatim
8000 #: ../fish/guestfish-actions.pod:1353
8001 #, no-wrap
8002 msgid ""
8003 " find directory\n"
8004 "\n"
8005 msgstr ""
8006
8007 #. type: textblock
8008 #: ../fish/guestfish-actions.pod:1355 ../src/guestfs-actions.pod:2211
8009 msgid ""
8010 "This command lists out all files and directories, recursively, starting at "
8011 "C<directory>.  It is essentially equivalent to running the shell command "
8012 "C<find directory -print> but some post-processing happens on the output, "
8013 "described below."
8014 msgstr ""
8015
8016 #. type: textblock
8017 #: ../fish/guestfish-actions.pod:1360 ../src/guestfs-actions.pod:2216
8018 msgid ""
8019 "This returns a list of strings I<without any prefix>.  Thus if the directory "
8020 "structure was:"
8021 msgstr ""
8022
8023 #. type: verbatim
8024 #: ../fish/guestfish-actions.pod:1363 ../src/guestfs-actions.pod:2219
8025 #, no-wrap
8026 msgid ""
8027 " /tmp/a\n"
8028 " /tmp/b\n"
8029 " /tmp/c/d\n"
8030 "\n"
8031 msgstr ""
8032
8033 #. type: textblock
8034 #: ../fish/guestfish-actions.pod:1367
8035 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
8036 msgstr ""
8037
8038 #. type: verbatim
8039 #: ../fish/guestfish-actions.pod:1370 ../src/guestfs-actions.pod:2226
8040 #, no-wrap
8041 msgid ""
8042 " a\n"
8043 " b\n"
8044 " c\n"
8045 " c/d\n"
8046 "\n"
8047 msgstr ""
8048
8049 #. type: textblock
8050 #: ../fish/guestfish-actions.pod:1375 ../src/guestfs-actions.pod:2231
8051 msgid "If C<directory> is not a directory, then this command returns an error."
8052 msgstr ""
8053
8054 #. type: textblock
8055 #: ../fish/guestfish-actions.pod:1378 ../src/guestfs-actions.pod:2234
8056 msgid "The returned list is sorted."
8057 msgstr ""
8058
8059 #. type: textblock
8060 #: ../fish/guestfish-actions.pod:1380
8061 msgid "See also L</find0>."
8062 msgstr ""
8063
8064 #. type: =head2
8065 #: ../fish/guestfish-actions.pod:1385
8066 msgid "find0"
8067 msgstr ""
8068
8069 #. type: verbatim
8070 #: ../fish/guestfish-actions.pod:1387
8071 #, no-wrap
8072 msgid ""
8073 " find0 directory (files|-)\n"
8074 "\n"
8075 msgstr ""
8076
8077 #. type: textblock
8078 #: ../fish/guestfish-actions.pod:1389 ../src/guestfs-actions.pod:2254
8079 msgid ""
8080 "This command lists out all files and directories, recursively, starting at "
8081 "C<directory>, placing the resulting list in the external file called "
8082 "C<files>."
8083 msgstr ""
8084
8085 #. type: textblock
8086 #: ../fish/guestfish-actions.pod:1393
8087 msgid "This command works the same way as L</find> with the following exceptions:"
8088 msgstr ""
8089
8090 #. type: textblock
8091 #: ../fish/guestfish-actions.pod:1400 ../src/guestfs-actions.pod:2265
8092 msgid "The resulting list is written to an external file."
8093 msgstr ""
8094
8095 #. type: textblock
8096 #: ../fish/guestfish-actions.pod:1404 ../src/guestfs-actions.pod:2269
8097 msgid ""
8098 "Items (filenames) in the result are separated by C<\\0> characters.  See "
8099 "L<find(1)> option I<-print0>."
8100 msgstr ""
8101
8102 #. type: textblock
8103 #: ../fish/guestfish-actions.pod:1409 ../src/guestfs-actions.pod:2274
8104 msgid "This command is not limited in the number of names that it can return."
8105 msgstr ""
8106
8107 #. type: textblock
8108 #: ../fish/guestfish-actions.pod:1414 ../src/guestfs-actions.pod:2279
8109 msgid "The result list is not sorted."
8110 msgstr ""
8111
8112 #. type: =head2
8113 #: ../fish/guestfish-actions.pod:1420
8114 msgid "findfs-label"
8115 msgstr ""
8116
8117 #. type: verbatim
8118 #: ../fish/guestfish-actions.pod:1422
8119 #, no-wrap
8120 msgid ""
8121 " findfs-label label\n"
8122 "\n"
8123 msgstr ""
8124
8125 #. type: textblock
8126 #: ../fish/guestfish-actions.pod:1424 ../src/guestfs-actions.pod:2293
8127 msgid ""
8128 "This command searches the filesystems and returns the one which has the "
8129 "given label.  An error is returned if no such filesystem can be found."
8130 msgstr ""
8131
8132 #. type: textblock
8133 #: ../fish/guestfish-actions.pod:1428
8134 msgid "To find the label of a filesystem, use L</vfs-label>."
8135 msgstr ""
8136
8137 #. type: =head2
8138 #: ../fish/guestfish-actions.pod:1430
8139 msgid "findfs-uuid"
8140 msgstr ""
8141
8142 #. type: verbatim
8143 #: ../fish/guestfish-actions.pod:1432
8144 #, no-wrap
8145 msgid ""
8146 " findfs-uuid uuid\n"
8147 "\n"
8148 msgstr ""
8149
8150 #. type: textblock
8151 #: ../fish/guestfish-actions.pod:1434 ../src/guestfs-actions.pod:2310
8152 msgid ""
8153 "This command searches the filesystems and returns the one which has the "
8154 "given UUID.  An error is returned if no such filesystem can be found."
8155 msgstr ""
8156
8157 #. type: textblock
8158 #: ../fish/guestfish-actions.pod:1438
8159 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
8160 msgstr ""
8161
8162 #. type: =head2
8163 #: ../fish/guestfish-actions.pod:1440
8164 msgid "fsck"
8165 msgstr ""
8166
8167 #. type: verbatim
8168 #: ../fish/guestfish-actions.pod:1442
8169 #, no-wrap
8170 msgid ""
8171 " fsck fstype device\n"
8172 "\n"
8173 msgstr ""
8174
8175 #. type: textblock
8176 #: ../fish/guestfish-actions.pod:1444 ../src/guestfs-actions.pod:2328
8177 msgid ""
8178 "This runs the filesystem checker (fsck) on C<device> which should have "
8179 "filesystem type C<fstype>."
8180 msgstr ""
8181
8182 #. type: textblock
8183 #: ../fish/guestfish-actions.pod:1447 ../src/guestfs-actions.pod:2331
8184 msgid ""
8185 "The returned integer is the status.  See L<fsck(8)> for the list of status "
8186 "codes from C<fsck>."
8187 msgstr ""
8188
8189 #. type: textblock
8190 #: ../fish/guestfish-actions.pod:1456 ../src/guestfs-actions.pod:2340
8191 msgid "Multiple status codes can be summed together."
8192 msgstr ""
8193
8194 #. type: textblock
8195 #: ../fish/guestfish-actions.pod:1460 ../src/guestfs-actions.pod:2344
8196 msgid ""
8197 "A non-zero return code can mean \"success\", for example if errors have been "
8198 "corrected on the filesystem."
8199 msgstr ""
8200
8201 #. type: textblock
8202 #: ../fish/guestfish-actions.pod:1465 ../src/guestfs-actions.pod:2349
8203 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
8204 msgstr ""
8205
8206 #. type: textblock
8207 #: ../fish/guestfish-actions.pod:1470 ../src/guestfs-actions.pod:2354
8208 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
8209 msgstr ""
8210
8211 #. type: =head2
8212 #: ../fish/guestfish-actions.pod:1472
8213 msgid "get-append"
8214 msgstr ""
8215
8216 #. type: verbatim
8217 #: ../fish/guestfish-actions.pod:1474
8218 #, no-wrap
8219 msgid ""
8220 " get-append\n"
8221 "\n"
8222 msgstr ""
8223
8224 #. type: textblock
8225 #: ../fish/guestfish-actions.pod:1476 ../src/guestfs-actions.pod:2365
8226 msgid ""
8227 "Return the additional kernel options which are added to the guest kernel "
8228 "command line."
8229 msgstr ""
8230
8231 #. type: textblock
8232 #: ../fish/guestfish-actions.pod:1479 ../src/guestfs-actions.pod:2368
8233 msgid "If C<NULL> then no options are added."
8234 msgstr ""
8235
8236 #. type: =head2
8237 #: ../fish/guestfish-actions.pod:1481
8238 msgid "get-attach-method"
8239 msgstr ""
8240
8241 #. type: verbatim
8242 #: ../fish/guestfish-actions.pod:1483
8243 #, no-wrap
8244 msgid ""
8245 " get-attach-method\n"
8246 "\n"
8247 msgstr ""
8248
8249 #. type: textblock
8250 #: ../fish/guestfish-actions.pod:1485
8251 msgid "Return the current attach method.  See L</set-attach-method>."
8252 msgstr ""
8253
8254 #. type: =head2
8255 #: ../fish/guestfish-actions.pod:1487
8256 msgid "get-autosync"
8257 msgstr ""
8258
8259 #. type: verbatim
8260 #: ../fish/guestfish-actions.pod:1489
8261 #, no-wrap
8262 msgid ""
8263 " get-autosync\n"
8264 "\n"
8265 msgstr ""
8266
8267 #. type: textblock
8268 #: ../fish/guestfish-actions.pod:1491 ../src/guestfs-actions.pod:2393
8269 msgid "Get the autosync flag."
8270 msgstr ""
8271
8272 #. type: =head2
8273 #: ../fish/guestfish-actions.pod:1493
8274 msgid "get-direct"
8275 msgstr ""
8276
8277 #. type: verbatim
8278 #: ../fish/guestfish-actions.pod:1495
8279 #, no-wrap
8280 msgid ""
8281 " get-direct\n"
8282 "\n"
8283 msgstr ""
8284
8285 #. type: textblock
8286 #: ../fish/guestfish-actions.pod:1497 ../src/guestfs-actions.pod:2404
8287 msgid "Return the direct appliance mode flag."
8288 msgstr ""
8289
8290 #. type: =head2
8291 #: ../fish/guestfish-actions.pod:1499
8292 msgid "get-e2label"
8293 msgstr ""
8294
8295 #. type: verbatim
8296 #: ../fish/guestfish-actions.pod:1501
8297 #, no-wrap
8298 msgid ""
8299 " get-e2label device\n"
8300 "\n"
8301 msgstr ""
8302
8303 #. type: textblock
8304 #: ../fish/guestfish-actions.pod:1503 ../src/guestfs-actions.pod:2423
8305 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
8306 msgstr ""
8307
8308 #. type: textblock
8309 #: ../fish/guestfish-actions.pod:1506
8310 msgid ""
8311 "I<This function is deprecated.> In new code, use the L</vfs_label> call "
8312 "instead."
8313 msgstr ""
8314
8315 #. type: =head2
8316 #: ../fish/guestfish-actions.pod:1513
8317 msgid "get-e2uuid"
8318 msgstr ""
8319
8320 #. type: verbatim
8321 #: ../fish/guestfish-actions.pod:1515
8322 #, no-wrap
8323 msgid ""
8324 " get-e2uuid device\n"
8325 "\n"
8326 msgstr ""
8327
8328 #. type: textblock
8329 #: ../fish/guestfish-actions.pod:1517 ../src/guestfs-actions.pod:2444
8330 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
8331 msgstr ""
8332
8333 #. type: textblock
8334 #: ../fish/guestfish-actions.pod:1520
8335 msgid ""
8336 "I<This function is deprecated.> In new code, use the L</vfs_uuid> call "
8337 "instead."
8338 msgstr ""
8339
8340 #. type: =head2
8341 #: ../fish/guestfish-actions.pod:1527
8342 msgid "get-memsize"
8343 msgstr ""
8344
8345 #. type: verbatim
8346 #: ../fish/guestfish-actions.pod:1529
8347 #, no-wrap
8348 msgid ""
8349 " get-memsize\n"
8350 "\n"
8351 msgstr ""
8352
8353 #. type: textblock
8354 #: ../fish/guestfish-actions.pod:1531 ../src/guestfs-actions.pod:2457
8355 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
8356 msgstr ""
8357
8358 #. type: textblock
8359 #: ../fish/guestfish-actions.pod:1534
8360 msgid ""
8361 "If L</set-memsize> was not called on this handle, and if "
8362 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
8363 "value for memsize."
8364 msgstr ""
8365
8366 #. type: textblock
8367 #: ../fish/guestfish-actions.pod:1538 ../fish/guestfish-actions.pod:1595 ../fish/guestfish-actions.pod:4360 ../fish/guestfish-actions.pod:4462 ../src/guestfs-actions.pod:2464 ../src/guestfs-actions.pod:2556 ../src/guestfs-actions.pod:6755 ../src/guestfs-actions.pod:6881
8368 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
8369 msgstr ""
8370
8371 #. type: =head2
8372 #: ../fish/guestfish-actions.pod:1541
8373 msgid "get-network"
8374 msgstr ""
8375
8376 #. type: verbatim
8377 #: ../fish/guestfish-actions.pod:1543
8378 #, no-wrap
8379 msgid ""
8380 " get-network\n"
8381 "\n"
8382 msgstr ""
8383
8384 #. type: textblock
8385 #: ../fish/guestfish-actions.pod:1545 ../src/guestfs-actions.pod:2476
8386 msgid "This returns the enable network flag."
8387 msgstr ""
8388
8389 #. type: =head2
8390 #: ../fish/guestfish-actions.pod:1547
8391 msgid "get-path"
8392 msgstr ""
8393
8394 #. type: verbatim
8395 #: ../fish/guestfish-actions.pod:1549
8396 #, no-wrap
8397 msgid ""
8398 " get-path\n"
8399 "\n"
8400 msgstr ""
8401
8402 #. type: textblock
8403 #: ../fish/guestfish-actions.pod:1551 ../src/guestfs-actions.pod:2487
8404 msgid "Return the current search path."
8405 msgstr ""
8406
8407 #. type: textblock
8408 #: ../fish/guestfish-actions.pod:1553 ../src/guestfs-actions.pod:2489
8409 msgid ""
8410 "This is always non-NULL.  If it wasn't set already, then this will return "
8411 "the default path."
8412 msgstr ""
8413
8414 #. type: =head2
8415 #: ../fish/guestfish-actions.pod:1556
8416 msgid "get-pgroup"
8417 msgstr ""
8418
8419 #. type: verbatim
8420 #: ../fish/guestfish-actions.pod:1558
8421 #, no-wrap
8422 msgid ""
8423 " get-pgroup\n"
8424 "\n"
8425 msgstr ""
8426
8427 #. type: textblock
8428 #: ../fish/guestfish-actions.pod:1560 ../src/guestfs-actions.pod:2502
8429 msgid "This returns the process group flag."
8430 msgstr ""
8431
8432 #. type: =head2
8433 #: ../fish/guestfish-actions.pod:1562
8434 msgid "get-pid"
8435 msgstr ""
8436
8437 #. type: =head2
8438 #: ../fish/guestfish-actions.pod:1564
8439 msgid "pid"
8440 msgstr ""
8441
8442 #. type: verbatim
8443 #: ../fish/guestfish-actions.pod:1566
8444 #, no-wrap
8445 msgid ""
8446 " get-pid\n"
8447 "\n"
8448 msgstr ""
8449
8450 #. type: textblock
8451 #: ../fish/guestfish-actions.pod:1568 ../src/guestfs-actions.pod:2513
8452 msgid ""
8453 "Return the process ID of the qemu subprocess.  If there is no qemu "
8454 "subprocess, then this will return an error."
8455 msgstr ""
8456
8457 #. type: textblock
8458 #: ../fish/guestfish-actions.pod:1571 ../src/guestfs-actions.pod:2516
8459 msgid "This is an internal call used for debugging and testing."
8460 msgstr ""
8461
8462 #. type: =head2
8463 #: ../fish/guestfish-actions.pod:1573
8464 msgid "get-qemu"
8465 msgstr ""
8466
8467 #. type: verbatim
8468 #: ../fish/guestfish-actions.pod:1575
8469 #, no-wrap
8470 msgid ""
8471 " get-qemu\n"
8472 "\n"
8473 msgstr ""
8474
8475 #. type: textblock
8476 #: ../fish/guestfish-actions.pod:1577 ../src/guestfs-actions.pod:2527
8477 msgid "Return the current qemu binary."
8478 msgstr ""
8479
8480 #. type: textblock
8481 #: ../fish/guestfish-actions.pod:1579 ../src/guestfs-actions.pod:2529
8482 msgid ""
8483 "This is always non-NULL.  If it wasn't set already, then this will return "
8484 "the default qemu binary name."
8485 msgstr ""
8486
8487 #. type: =head2
8488 #: ../fish/guestfish-actions.pod:1582
8489 msgid "get-recovery-proc"
8490 msgstr ""
8491
8492 #. type: verbatim
8493 #: ../fish/guestfish-actions.pod:1584
8494 #, no-wrap
8495 msgid ""
8496 " get-recovery-proc\n"
8497 "\n"
8498 msgstr ""
8499
8500 #. type: textblock
8501 #: ../fish/guestfish-actions.pod:1586 ../src/guestfs-actions.pod:2542
8502 msgid "Return the recovery process enabled flag."
8503 msgstr ""
8504
8505 #. type: =head2
8506 #: ../fish/guestfish-actions.pod:1588
8507 msgid "get-selinux"
8508 msgstr ""
8509
8510 #. type: verbatim
8511 #: ../fish/guestfish-actions.pod:1590
8512 #, no-wrap
8513 msgid ""
8514 " get-selinux\n"
8515 "\n"
8516 msgstr ""
8517
8518 #. type: textblock
8519 #: ../fish/guestfish-actions.pod:1592
8520 msgid ""
8521 "This returns the current setting of the selinux flag which is passed to the "
8522 "appliance at boot time.  See L</set-selinux>."
8523 msgstr ""
8524
8525 #. type: =head2
8526 #: ../fish/guestfish-actions.pod:1598
8527 msgid "get-smp"
8528 msgstr ""
8529
8530 #. type: verbatim
8531 #: ../fish/guestfish-actions.pod:1600
8532 #, no-wrap
8533 msgid ""
8534 " get-smp\n"
8535 "\n"
8536 msgstr ""
8537
8538 #. type: textblock
8539 #: ../fish/guestfish-actions.pod:1602 ../src/guestfs-actions.pod:2568
8540 msgid "This returns the number of virtual CPUs assigned to the appliance."
8541 msgstr ""
8542
8543 #. type: =head2
8544 #: ../fish/guestfish-actions.pod:1604
8545 msgid "get-state"
8546 msgstr ""
8547
8548 #. type: verbatim
8549 #: ../fish/guestfish-actions.pod:1606
8550 #, no-wrap
8551 msgid ""
8552 " get-state\n"
8553 "\n"
8554 msgstr ""
8555
8556 #. type: textblock
8557 #: ../fish/guestfish-actions.pod:1608 ../src/guestfs-actions.pod:2579
8558 msgid ""
8559 "This returns the current state as an opaque integer.  This is only useful "
8560 "for printing debug and internal error messages."
8561 msgstr ""
8562
8563 #. type: textblock
8564 #: ../fish/guestfish-actions.pod:1611 ../fish/guestfish-actions.pod:2570 ../fish/guestfish-actions.pod:2588 ../fish/guestfish-actions.pod:2626 ../fish/guestfish-actions.pod:2642 ../src/guestfs-actions.pod:2582 ../src/guestfs-actions.pod:3901 ../src/guestfs-actions.pod:3930 ../src/guestfs-actions.pod:3991 ../src/guestfs-actions.pod:4018
8565 msgid "For more information on states, see L<guestfs(3)>."
8566 msgstr ""
8567
8568 #. type: =head2
8569 #: ../fish/guestfish-actions.pod:1613
8570 msgid "get-trace"
8571 msgstr ""
8572
8573 #. type: verbatim
8574 #: ../fish/guestfish-actions.pod:1615
8575 #, no-wrap
8576 msgid ""
8577 " get-trace\n"
8578 "\n"
8579 msgstr ""
8580
8581 #. type: textblock
8582 #: ../fish/guestfish-actions.pod:1617 ../src/guestfs-actions.pod:2593
8583 msgid "Return the command trace flag."
8584 msgstr ""
8585
8586 #. type: =head2
8587 #: ../fish/guestfish-actions.pod:1619
8588 msgid "get-umask"
8589 msgstr ""
8590
8591 #. type: verbatim
8592 #: ../fish/guestfish-actions.pod:1621
8593 #, no-wrap
8594 msgid ""
8595 " get-umask\n"
8596 "\n"
8597 msgstr ""
8598
8599 #. type: textblock
8600 #: ../fish/guestfish-actions.pod:1623
8601 msgid ""
8602 "Return the current umask.  By default the umask is C<022> unless it has been "
8603 "set by calling L</umask>."
8604 msgstr ""
8605
8606 #. type: =head2
8607 #: ../fish/guestfish-actions.pod:1626
8608 msgid "get-verbose"
8609 msgstr ""
8610
8611 #. type: verbatim
8612 #: ../fish/guestfish-actions.pod:1628
8613 #, no-wrap
8614 msgid ""
8615 " get-verbose\n"
8616 "\n"
8617 msgstr ""
8618
8619 #. type: textblock
8620 #: ../fish/guestfish-actions.pod:1630 ../src/guestfs-actions.pod:2616
8621 msgid "This returns the verbose messages flag."
8622 msgstr ""
8623
8624 #. type: =head2
8625 #: ../fish/guestfish-actions.pod:1632
8626 msgid "getcon"
8627 msgstr ""
8628
8629 #. type: verbatim
8630 #: ../fish/guestfish-actions.pod:1634
8631 #, no-wrap
8632 msgid ""
8633 " getcon\n"
8634 "\n"
8635 msgstr ""
8636
8637 #. type: textblock
8638 #: ../fish/guestfish-actions.pod:1636 ../src/guestfs-actions.pod:2627
8639 msgid "This gets the SELinux security context of the daemon."
8640 msgstr ""
8641
8642 #. type: textblock
8643 #: ../fish/guestfish-actions.pod:1638
8644 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
8645 msgstr ""
8646
8647 #. type: =head2
8648 #: ../fish/guestfish-actions.pod:1641
8649 msgid "getxattr"
8650 msgstr ""
8651
8652 #. type: verbatim
8653 #: ../fish/guestfish-actions.pod:1643
8654 #, no-wrap
8655 msgid ""
8656 " getxattr path name\n"
8657 "\n"
8658 msgstr ""
8659
8660 #. type: textblock
8661 #: ../fish/guestfish-actions.pod:1645
8662 msgid ""
8663 "Get a single extended attribute from file C<path> named C<name>.  This call "
8664 "follows symlinks.  If you want to lookup an extended attribute for the "
8665 "symlink itself, use L</lgetxattr>."
8666 msgstr ""
8667
8668 #. type: textblock
8669 #: ../fish/guestfish-actions.pod:1649 ../fish/guestfish-actions.pod:2715
8670 msgid ""
8671 "Normally it is better to get all extended attributes from a file in one go "
8672 "by calling L</getxattrs>.  However some Linux filesystem implementations are "
8673 "buggy and do not provide a way to list out attributes.  For these "
8674 "filesystems (notably ntfs-3g)  you have to know the names of the extended "
8675 "attributes you want in advance and call this function."
8676 msgstr ""
8677
8678 #. type: textblock
8679 #: ../fish/guestfish-actions.pod:1656 ../fish/guestfish-actions.pod:2722 ../src/guestfs-actions.pod:2656 ../src/guestfs-actions.pod:4151
8680 msgid ""
8681 "Extended attribute values are blobs of binary data.  If there is no extended "
8682 "attribute named C<name>, this returns an error."
8683 msgstr ""
8684
8685 #. type: textblock
8686 #: ../fish/guestfish-actions.pod:1659
8687 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
8688 msgstr ""
8689
8690 #. type: =head2
8691 #: ../fish/guestfish-actions.pod:1661
8692 msgid "getxattrs"
8693 msgstr ""
8694
8695 #. type: verbatim
8696 #: ../fish/guestfish-actions.pod:1663
8697 #, no-wrap
8698 msgid ""
8699 " getxattrs path\n"
8700 "\n"
8701 msgstr ""
8702
8703 #. type: textblock
8704 #: ../fish/guestfish-actions.pod:1665 ../src/guestfs-actions.pod:2673
8705 msgid "This call lists the extended attributes of the file or directory C<path>."
8706 msgstr ""
8707
8708 #. type: textblock
8709 #: ../fish/guestfish-actions.pod:1668 ../src/guestfs-actions.pod:2676
8710 msgid ""
8711 "At the system call level, this is a combination of the L<listxattr(2)> and "
8712 "L<getxattr(2)> calls."
8713 msgstr ""
8714
8715 #. type: textblock
8716 #: ../fish/guestfish-actions.pod:1671
8717 msgid "See also: L</lgetxattrs>, L<attr(5)>."
8718 msgstr ""
8719
8720 #. type: =head2
8721 #: ../fish/guestfish-actions.pod:1673
8722 msgid "glob-expand"
8723 msgstr ""
8724
8725 #. type: verbatim
8726 #: ../fish/guestfish-actions.pod:1675
8727 #, no-wrap
8728 msgid ""
8729 " glob-expand pattern\n"
8730 "\n"
8731 msgstr ""
8732
8733 #. type: textblock
8734 #: ../fish/guestfish-actions.pod:1677 ../src/guestfs-actions.pod:2693
8735 msgid ""
8736 "This command searches for all the pathnames matching C<pattern> according to "
8737 "the wildcard expansion rules used by the shell."
8738 msgstr ""
8739
8740 #. type: textblock
8741 #: ../fish/guestfish-actions.pod:1681 ../src/guestfs-actions.pod:2697
8742 msgid "If no paths match, then this returns an empty list (note: not an error)."
8743 msgstr ""
8744
8745 #. type: textblock
8746 #: ../fish/guestfish-actions.pod:1684 ../src/guestfs-actions.pod:2700
8747 msgid ""
8748 "It is just a wrapper around the C L<glob(3)> function with flags "
8749 "C<GLOB_MARK|GLOB_BRACE>.  See that manual page for more details."
8750 msgstr ""
8751
8752 #. type: =head2
8753 #: ../fish/guestfish-actions.pod:1688
8754 msgid "grep"
8755 msgstr ""
8756
8757 #. type: verbatim
8758 #: ../fish/guestfish-actions.pod:1690
8759 #, no-wrap
8760 msgid ""
8761 " grep regex path\n"
8762 "\n"
8763 msgstr ""
8764
8765 #. type: textblock
8766 #: ../fish/guestfish-actions.pod:1692 ../src/guestfs-actions.pod:2717
8767 msgid "This calls the external C<grep> program and returns the matching lines."
8768 msgstr ""
8769
8770 #. type: =head2
8771 #: ../fish/guestfish-actions.pod:1698
8772 msgid "grepi"
8773 msgstr ""
8774
8775 #. type: verbatim
8776 #: ../fish/guestfish-actions.pod:1700
8777 #, no-wrap
8778 msgid ""
8779 " grepi regex path\n"
8780 "\n"
8781 msgstr ""
8782
8783 #. type: textblock
8784 #: ../fish/guestfish-actions.pod:1702 ../src/guestfs-actions.pod:2736
8785 msgid "This calls the external C<grep -i> program and returns the matching lines."
8786 msgstr ""
8787
8788 #. type: =head2
8789 #: ../fish/guestfish-actions.pod:1708
8790 msgid "grub-install"
8791 msgstr ""
8792
8793 #. type: verbatim
8794 #: ../fish/guestfish-actions.pod:1710
8795 #, no-wrap
8796 msgid ""
8797 " grub-install root device\n"
8798 "\n"
8799 msgstr ""
8800
8801 #. type: textblock
8802 #: ../fish/guestfish-actions.pod:1712 ../src/guestfs-actions.pod:2755
8803 msgid ""
8804 "This command installs GRUB 1 (the Grand Unified Bootloader) on C<device>, "
8805 "with the root directory being C<root>."
8806 msgstr ""
8807
8808 #. type: textblock
8809 #: ../fish/guestfish-actions.pod:1721 ../src/guestfs-actions.pod:2764
8810 msgid ""
8811 "There is currently no way in the API to install grub2, which is used by most "
8812 "modern Linux guests.  It is possible to run the grub2 command from the "
8813 "guest, although see the caveats in L<guestfs(3)/RUNNING COMMANDS>."
8814 msgstr ""
8815
8816 #. type: textblock
8817 #: ../fish/guestfish-actions.pod:1728 ../src/guestfs-actions.pod:2771
8818 msgid ""
8819 "This uses C<grub-install> from the host.  Unfortunately grub is not always "
8820 "compatible with itself, so this only works in rather narrow circumstances.  "
8821 "Careful testing with each guest version is advisable."
8822 msgstr ""
8823
8824 #. type: textblock
8825 #: ../fish/guestfish-actions.pod:1735 ../src/guestfs-actions.pod:2778
8826 msgid ""
8827 "If grub-install reports the error \"No suitable drive was found in the "
8828 "generated device map.\" it may be that you need to create a "
8829 "C</boot/grub/device.map> file first that contains the mapping between grub "
8830 "device names and Linux device names.  It is usually sufficient to create a "
8831 "file containing:"
8832 msgstr ""
8833
8834 #. type: verbatim
8835 #: ../fish/guestfish-actions.pod:1742 ../src/guestfs-actions.pod:2785
8836 #, no-wrap
8837 msgid ""
8838 " (hd0) /dev/vda\n"
8839 "\n"
8840 msgstr ""
8841
8842 #. type: textblock
8843 #: ../fish/guestfish-actions.pod:1744 ../src/guestfs-actions.pod:2787
8844 msgid "replacing C</dev/vda> with the name of the installation device."
8845 msgstr ""
8846
8847 #. type: =head2
8848 #: ../fish/guestfish-actions.pod:1748
8849 msgid "head"
8850 msgstr ""
8851
8852 #. type: verbatim
8853 #: ../fish/guestfish-actions.pod:1750
8854 #, no-wrap
8855 msgid ""
8856 " head path\n"
8857 "\n"
8858 msgstr ""
8859
8860 #. type: textblock
8861 #: ../fish/guestfish-actions.pod:1752 ../src/guestfs-actions.pod:2801
8862 msgid ""
8863 "This command returns up to the first 10 lines of a file as a list of "
8864 "strings."
8865 msgstr ""
8866
8867 #. type: =head2
8868 #: ../fish/guestfish-actions.pod:1758
8869 msgid "head-n"
8870 msgstr ""
8871
8872 #. type: verbatim
8873 #: ../fish/guestfish-actions.pod:1760
8874 #, no-wrap
8875 msgid ""
8876 " head-n nrlines path\n"
8877 "\n"
8878 msgstr ""
8879
8880 #. type: textblock
8881 #: ../fish/guestfish-actions.pod:1762 ../src/guestfs-actions.pod:2820
8882 msgid ""
8883 "If the parameter C<nrlines> is a positive number, this returns the first "
8884 "C<nrlines> lines of the file C<path>."
8885 msgstr ""
8886
8887 #. type: textblock
8888 #: ../fish/guestfish-actions.pod:1765 ../src/guestfs-actions.pod:2823
8889 msgid ""
8890 "If the parameter C<nrlines> is a negative number, this returns lines from "
8891 "the file C<path>, excluding the last C<nrlines> lines."
8892 msgstr ""
8893
8894 #. type: textblock
8895 #: ../fish/guestfish-actions.pod:1768 ../fish/guestfish-actions.pod:4843 ../src/guestfs-actions.pod:2826 ../src/guestfs-actions.pod:7460
8896 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
8897 msgstr ""
8898
8899 #. type: =head2
8900 #: ../fish/guestfish-actions.pod:1773
8901 msgid "hexdump"
8902 msgstr ""
8903
8904 #. type: verbatim
8905 #: ../fish/guestfish-actions.pod:1775
8906 #, no-wrap
8907 msgid ""
8908 " hexdump path\n"
8909 "\n"
8910 msgstr ""
8911
8912 #. type: textblock
8913 #: ../fish/guestfish-actions.pod:1777 ../src/guestfs-actions.pod:2843
8914 msgid ""
8915 "This runs C<hexdump -C> on the given C<path>.  The result is the "
8916 "human-readable, canonical hex dump of the file."
8917 msgstr ""
8918
8919 #. type: =head2
8920 #: ../fish/guestfish-actions.pod:1783
8921 msgid "initrd-cat"
8922 msgstr ""
8923
8924 #. type: verbatim
8925 #: ../fish/guestfish-actions.pod:1785
8926 #, no-wrap
8927 msgid ""
8928 " initrd-cat initrdpath filename\n"
8929 "\n"
8930 msgstr ""
8931
8932 #. type: textblock
8933 #: ../fish/guestfish-actions.pod:1787 ../src/guestfs-actions.pod:2862
8934 msgid ""
8935 "This command unpacks the file C<filename> from the initrd file called "
8936 "C<initrdpath>.  The filename must be given I<without> the initial C</> "
8937 "character."
8938 msgstr ""
8939
8940 #. type: textblock
8941 #: ../fish/guestfish-actions.pod:1791 ../src/guestfs-actions.pod:2866
8942 msgid ""
8943 "For example, in guestfish you could use the following command to examine the "
8944 "boot script (usually called C</init>)  contained in a Linux initrd or "
8945 "initramfs image:"
8946 msgstr ""
8947
8948 #. type: verbatim
8949 #: ../fish/guestfish-actions.pod:1795 ../src/guestfs-actions.pod:2870
8950 #, no-wrap
8951 msgid ""
8952 " initrd-cat /boot/initrd-<version>.img init\n"
8953 "\n"
8954 msgstr ""
8955
8956 #. type: textblock
8957 #: ../fish/guestfish-actions.pod:1797
8958 msgid "See also L</initrd-list>."
8959 msgstr ""
8960
8961 #. type: =head2
8962 #: ../fish/guestfish-actions.pod:1802
8963 msgid "initrd-list"
8964 msgstr ""
8965
8966 #. type: verbatim
8967 #: ../fish/guestfish-actions.pod:1804
8968 #, no-wrap
8969 msgid ""
8970 " initrd-list path\n"
8971 "\n"
8972 msgstr ""
8973
8974 #. type: textblock
8975 #: ../fish/guestfish-actions.pod:1806 ../src/guestfs-actions.pod:2889
8976 msgid "This command lists out files contained in an initrd."
8977 msgstr ""
8978
8979 #. type: textblock
8980 #: ../fish/guestfish-actions.pod:1808 ../src/guestfs-actions.pod:2891
8981 msgid ""
8982 "The files are listed without any initial C</> character.  The files are "
8983 "listed in the order they appear (not necessarily alphabetical).  Directory "
8984 "names are listed as separate items."
8985 msgstr ""
8986
8987 #. type: textblock
8988 #: ../fish/guestfish-actions.pod:1812 ../src/guestfs-actions.pod:2895
8989 msgid ""
8990 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8991 "initrd.  We I<only> support the newer initramfs format (compressed cpio "
8992 "files)."
8993 msgstr ""
8994
8995 #. type: =head2
8996 #: ../fish/guestfish-actions.pod:1816
8997 msgid "inotify-add-watch"
8998 msgstr ""
8999
9000 #. type: verbatim
9001 #: ../fish/guestfish-actions.pod:1818
9002 #, no-wrap
9003 msgid ""
9004 " inotify-add-watch path mask\n"
9005 "\n"
9006 msgstr ""
9007
9008 #. type: textblock
9009 #: ../fish/guestfish-actions.pod:1820 ../src/guestfs-actions.pod:2912
9010 msgid "Watch C<path> for the events listed in C<mask>."
9011 msgstr ""
9012
9013 #. type: textblock
9014 #: ../fish/guestfish-actions.pod:1822 ../src/guestfs-actions.pod:2914
9015 msgid ""
9016 "Note that if C<path> is a directory then events within that directory are "
9017 "watched, but this does I<not> happen recursively (in subdirectories)."
9018 msgstr ""
9019
9020 #. type: textblock
9021 #: ../fish/guestfish-actions.pod:1826 ../src/guestfs-actions.pod:2918
9022 msgid ""
9023 "Note for non-C or non-Linux callers: the inotify events are defined by the "
9024 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
9025 msgstr ""
9026
9027 #. type: =head2
9028 #: ../fish/guestfish-actions.pod:1830
9029 msgid "inotify-close"
9030 msgstr ""
9031
9032 #. type: verbatim
9033 #: ../fish/guestfish-actions.pod:1832
9034 #, no-wrap
9035 msgid ""
9036 " inotify-close\n"
9037 "\n"
9038 msgstr ""
9039
9040 #. type: textblock
9041 #: ../fish/guestfish-actions.pod:1834 ../src/guestfs-actions.pod:2931
9042 msgid ""
9043 "This closes the inotify handle which was previously opened by inotify_init.  "
9044 "It removes all watches, throws away any pending events, and deallocates all "
9045 "resources."
9046 msgstr ""
9047
9048 #. type: =head2
9049 #: ../fish/guestfish-actions.pod:1838
9050 msgid "inotify-files"
9051 msgstr ""
9052
9053 #. type: verbatim
9054 #: ../fish/guestfish-actions.pod:1840
9055 #, no-wrap
9056 msgid ""
9057 " inotify-files\n"
9058 "\n"
9059 msgstr ""
9060
9061 #. type: textblock
9062 #: ../fish/guestfish-actions.pod:1842
9063 msgid ""
9064 "This function is a helpful wrapper around L</inotify-read> which just "
9065 "returns a list of pathnames of objects that were touched.  The returned "
9066 "pathnames are sorted and deduplicated."
9067 msgstr ""
9068
9069 #. type: =head2
9070 #: ../fish/guestfish-actions.pod:1846
9071 msgid "inotify-init"
9072 msgstr ""
9073
9074 #. type: verbatim
9075 #: ../fish/guestfish-actions.pod:1848
9076 #, no-wrap
9077 msgid ""
9078 " inotify-init maxevents\n"
9079 "\n"
9080 msgstr ""
9081
9082 #. type: textblock
9083 #: ../fish/guestfish-actions.pod:1850 ../src/guestfs-actions.pod:2960
9084 msgid ""
9085 "This command creates a new inotify handle.  The inotify subsystem can be "
9086 "used to notify events which happen to objects in the guest filesystem."
9087 msgstr ""
9088
9089 #. type: textblock
9090 #: ../fish/guestfish-actions.pod:1854
9091 msgid ""
9092 "C<maxevents> is the maximum number of events which will be queued up between "
9093 "calls to L</inotify-read> or L</inotify-files>.  If this is passed as C<0>, "
9094 "then the kernel (or previously set)  default is used.  For Linux 2.6.29 the "
9095 "default was 16384 events.  Beyond this limit, the kernel throws away events, "
9096 "but records the fact that it threw them away by setting a flag "
9097 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
9098 msgstr ""
9099
9100 #. type: textblock
9101 #: ../fish/guestfish-actions.pod:1864
9102 msgid ""
9103 "Before any events are generated, you have to add some watches to the "
9104 "internal watch list.  See: L</inotify-add-watch>, L</inotify-rm-watch> and "
9105 "L</inotify-watch-all>."
9106 msgstr ""
9107
9108 #. type: textblock
9109 #: ../fish/guestfish-actions.pod:1870
9110 msgid ""
9111 "Queued up events should be read periodically by calling L</inotify-read> (or "
9112 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>).  "
9113 "If you don't read the events out often enough then you risk the internal "
9114 "queue overflowing."
9115 msgstr ""
9116
9117 #. type: textblock
9118 #: ../fish/guestfish-actions.pod:1877
9119 msgid ""
9120 "The handle should be closed after use by calling L</inotify-close>.  This "
9121 "also removes any watches automatically."
9122 msgstr ""
9123
9124 #. type: textblock
9125 #: ../fish/guestfish-actions.pod:1881 ../src/guestfs-actions.pod:2991
9126 msgid ""
9127 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
9128 "by the Linux kernel, which is roughly what we expose via libguestfs.  Note "
9129 "that there is one global inotify handle per libguestfs instance."
9130 msgstr ""
9131
9132 #. type: =head2
9133 #: ../fish/guestfish-actions.pod:1886
9134 msgid "inotify-read"
9135 msgstr ""
9136
9137 #. type: verbatim
9138 #: ../fish/guestfish-actions.pod:1888
9139 #, no-wrap
9140 msgid ""
9141 " inotify-read\n"
9142 "\n"
9143 msgstr ""
9144
9145 #. type: textblock
9146 #: ../fish/guestfish-actions.pod:1890 ../src/guestfs-actions.pod:3005
9147 msgid ""
9148 "Return the complete queue of events that have happened since the previous "
9149 "read call."
9150 msgstr ""
9151
9152 #. type: textblock
9153 #: ../fish/guestfish-actions.pod:1893 ../src/guestfs-actions.pod:3008
9154 msgid "If no events have happened, this returns an empty list."
9155 msgstr ""
9156
9157 #. type: textblock
9158 #: ../fish/guestfish-actions.pod:1895 ../src/guestfs-actions.pod:3010
9159 msgid ""
9160 "I<Note>: In order to make sure that all events have been read, you must call "
9161 "this function repeatedly until it returns an empty list.  The reason is that "
9162 "the call will read events up to the maximum appliance-to-host message size "
9163 "and leave remaining events in the queue."
9164 msgstr ""
9165
9166 #. type: =head2
9167 #: ../fish/guestfish-actions.pod:1901
9168 msgid "inotify-rm-watch"
9169 msgstr ""
9170
9171 #. type: verbatim
9172 #: ../fish/guestfish-actions.pod:1903
9173 #, no-wrap
9174 msgid ""
9175 " inotify-rm-watch wd\n"
9176 "\n"
9177 msgstr ""
9178
9179 #. type: textblock
9180 #: ../fish/guestfish-actions.pod:1905
9181 msgid "Remove a previously defined inotify watch.  See L</inotify-add-watch>."
9182 msgstr ""
9183
9184 #. type: =head2
9185 #: ../fish/guestfish-actions.pod:1908
9186 msgid "inspect-get-arch"
9187 msgstr ""
9188
9189 #. type: verbatim
9190 #: ../fish/guestfish-actions.pod:1910
9191 #, no-wrap
9192 msgid ""
9193 " inspect-get-arch root\n"
9194 "\n"
9195 msgstr ""
9196
9197 #. type: textblock
9198 #: ../fish/guestfish-actions.pod:1912
9199 msgid ""
9200 "This returns the architecture of the inspected operating system.  The "
9201 "possible return values are listed under L</file-architecture>."
9202 msgstr ""
9203
9204 #. type: textblock
9205 #: ../fish/guestfish-actions.pod:1916 ../src/guestfs-actions.pod:3045
9206 msgid ""
9207 "If the architecture could not be determined, then the string C<unknown> is "
9208 "returned."
9209 msgstr ""
9210
9211 #. type: textblock
9212 #: ../fish/guestfish-actions.pod:1919 ../fish/guestfish-actions.pod:2014 ../fish/guestfish-actions.pod:2093 ../fish/guestfish-actions.pod:2105 ../fish/guestfish-actions.pod:2189 ../fish/guestfish-actions.pod:2251 ../fish/guestfish-actions.pod:2272 ../fish/guestfish-actions.pod:2286 ../fish/guestfish-actions.pod:2326 ../fish/guestfish-actions.pod:2362 ../fish/guestfish-actions.pod:2375 ../fish/guestfish-actions.pod:2388 ../fish/guestfish-actions.pod:2398 ../fish/guestfish-actions.pod:2408 ../fish/guestfish-actions.pod:2420 ../fish/guestfish-actions.pod:2516 ../fish/guestfish-actions.pod:2550 ../src/guestfs-actions.pod:3048 ../src/guestfs-actions.pod:3150 ../src/guestfs-actions.pod:3254 ../src/guestfs-actions.pod:3273 ../src/guestfs-actions.pod:3404 ../src/guestfs-actions.pod:3488 ../src/guestfs-actions.pod:3516 ../src/guestfs-actions.pod:3537 ../src/guestfs-actions.pod:3590 ../src/guestfs-actions.pod:3634 ../src/guestfs-actions.pod:3654 ../src/guestfs-actions.pod:3674 ../src/guestfs-actions.pod:3691 ../src/guestfs-actions.pod:3707 ../src/guestfs-actions.pod:3725 ../src/guestfs-actions.pod:3827 ../src/guestfs-actions.pod:3868
9213 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
9214 msgstr ""
9215
9216 #. type: =head2
9217 #: ../fish/guestfish-actions.pod:1921
9218 msgid "inspect-get-distro"
9219 msgstr ""
9220
9221 #. type: verbatim
9222 #: ../fish/guestfish-actions.pod:1923
9223 #, no-wrap
9224 msgid ""
9225 " inspect-get-distro root\n"
9226 "\n"
9227 msgstr ""
9228
9229 #. type: textblock
9230 #: ../fish/guestfish-actions.pod:1925 ../src/guestfs-actions.pod:3061
9231 msgid "This returns the distro (distribution) of the inspected operating system."
9232 msgstr ""
9233
9234 #. type: textblock
9235 #: ../fish/guestfish-actions.pod:1928 ../src/guestfs-actions.pod:3064
9236 msgid "Currently defined distros are:"
9237 msgstr ""
9238
9239 #. type: =item
9240 #: ../fish/guestfish-actions.pod:1932 ../src/guestfs-actions.pod:3068
9241 msgid "\"archlinux\""
9242 msgstr ""
9243
9244 #. type: textblock
9245 #: ../fish/guestfish-actions.pod:1934 ../src/guestfs-actions.pod:3070
9246 msgid "Arch Linux."
9247 msgstr ""
9248
9249 #. type: =item
9250 #: ../fish/guestfish-actions.pod:1936 ../src/guestfs-actions.pod:3072
9251 msgid "\"centos\""
9252 msgstr ""
9253
9254 #. type: textblock
9255 #: ../fish/guestfish-actions.pod:1938 ../src/guestfs-actions.pod:3074
9256 msgid "CentOS."
9257 msgstr ""
9258
9259 #. type: =item
9260 #: ../fish/guestfish-actions.pod:1940 ../src/guestfs-actions.pod:3076
9261 msgid "\"debian\""
9262 msgstr ""
9263
9264 #. type: textblock
9265 #: ../fish/guestfish-actions.pod:1942 ../src/guestfs-actions.pod:3078
9266 msgid "Debian."
9267 msgstr ""
9268
9269 #. type: =item
9270 #: ../fish/guestfish-actions.pod:1944 ../src/guestfs-actions.pod:3080
9271 msgid "\"fedora\""
9272 msgstr ""
9273
9274 #. type: textblock
9275 #: ../fish/guestfish-actions.pod:1946 ../src/guestfs-actions.pod:3082
9276 msgid "Fedora."
9277 msgstr ""
9278
9279 #. type: =item
9280 #: ../fish/guestfish-actions.pod:1948 ../src/guestfs-actions.pod:3084
9281 msgid "\"gentoo\""
9282 msgstr ""
9283
9284 #. type: textblock
9285 #: ../fish/guestfish-actions.pod:1950 ../src/guestfs-actions.pod:3086
9286 msgid "Gentoo."
9287 msgstr ""
9288
9289 #. type: =item
9290 #: ../fish/guestfish-actions.pod:1952 ../src/guestfs-actions.pod:3088
9291 msgid "\"linuxmint\""
9292 msgstr ""
9293
9294 #. type: textblock
9295 #: ../fish/guestfish-actions.pod:1954 ../src/guestfs-actions.pod:3090
9296 msgid "Linux Mint."
9297 msgstr ""
9298
9299 #. type: =item
9300 #: ../fish/guestfish-actions.pod:1956 ../src/guestfs-actions.pod:3092
9301 msgid "\"mageia\""
9302 msgstr ""
9303
9304 #. type: textblock
9305 #: ../fish/guestfish-actions.pod:1958 ../src/guestfs-actions.pod:3094
9306 msgid "Mageia."
9307 msgstr ""
9308
9309 #. type: =item
9310 #: ../fish/guestfish-actions.pod:1960 ../src/guestfs-actions.pod:3096
9311 msgid "\"mandriva\""
9312 msgstr ""
9313
9314 #. type: textblock
9315 #: ../fish/guestfish-actions.pod:1962 ../src/guestfs-actions.pod:3098
9316 msgid "Mandriva."
9317 msgstr ""
9318
9319 #. type: =item
9320 #: ../fish/guestfish-actions.pod:1964 ../src/guestfs-actions.pod:3100
9321 msgid "\"meego\""
9322 msgstr ""
9323
9324 #. type: textblock
9325 #: ../fish/guestfish-actions.pod:1966 ../src/guestfs-actions.pod:3102
9326 msgid "MeeGo."
9327 msgstr ""
9328
9329 #. type: =item
9330 #: ../fish/guestfish-actions.pod:1968 ../src/guestfs-actions.pod:3104
9331 msgid "\"opensuse\""
9332 msgstr ""
9333
9334 #. type: textblock
9335 #: ../fish/guestfish-actions.pod:1970 ../src/guestfs-actions.pod:3106
9336 msgid "OpenSUSE."
9337 msgstr ""
9338
9339 #. type: =item
9340 #: ../fish/guestfish-actions.pod:1972 ../src/guestfs-actions.pod:3108
9341 msgid "\"pardus\""
9342 msgstr ""
9343
9344 #. type: textblock
9345 #: ../fish/guestfish-actions.pod:1974 ../src/guestfs-actions.pod:3110
9346 msgid "Pardus."
9347 msgstr ""
9348
9349 #. type: =item
9350 #: ../fish/guestfish-actions.pod:1976 ../src/guestfs-actions.pod:3112
9351 msgid "\"redhat-based\""
9352 msgstr ""
9353
9354 #. type: textblock
9355 #: ../fish/guestfish-actions.pod:1978 ../src/guestfs-actions.pod:3114
9356 msgid "Some Red Hat-derived distro."
9357 msgstr ""
9358
9359 #. type: =item
9360 #: ../fish/guestfish-actions.pod:1980 ../src/guestfs-actions.pod:3116
9361 msgid "\"rhel\""
9362 msgstr ""
9363
9364 #. type: textblock
9365 #: ../fish/guestfish-actions.pod:1982 ../src/guestfs-actions.pod:3118
9366 msgid "Red Hat Enterprise Linux."
9367 msgstr ""
9368
9369 #. type: =item
9370 #: ../fish/guestfish-actions.pod:1984 ../src/guestfs-actions.pod:3120
9371 msgid "\"scientificlinux\""
9372 msgstr ""
9373
9374 #. type: textblock
9375 #: ../fish/guestfish-actions.pod:1986 ../src/guestfs-actions.pod:3122
9376 msgid "Scientific Linux."
9377 msgstr ""
9378
9379 #. type: =item
9380 #: ../fish/guestfish-actions.pod:1988 ../src/guestfs-actions.pod:3124
9381 msgid "\"slackware\""
9382 msgstr ""
9383
9384 #. type: textblock
9385 #: ../fish/guestfish-actions.pod:1990 ../src/guestfs-actions.pod:3126
9386 msgid "Slackware."
9387 msgstr ""
9388
9389 #. type: =item
9390 #: ../fish/guestfish-actions.pod:1992 ../src/guestfs-actions.pod:3128
9391 msgid "\"ttylinux\""
9392 msgstr ""
9393
9394 #. type: textblock
9395 #: ../fish/guestfish-actions.pod:1994 ../src/guestfs-actions.pod:3130
9396 msgid "ttylinux."
9397 msgstr ""
9398
9399 #. type: =item
9400 #: ../fish/guestfish-actions.pod:1996 ../src/guestfs-actions.pod:3132
9401 msgid "\"ubuntu\""
9402 msgstr ""
9403
9404 #. type: textblock
9405 #: ../fish/guestfish-actions.pod:1998 ../src/guestfs-actions.pod:3134
9406 msgid "Ubuntu."
9407 msgstr ""
9408
9409 #. type: =item
9410 #: ../fish/guestfish-actions.pod:2000 ../fish/guestfish-actions.pod:2084 ../fish/guestfish-actions.pod:2353 ../src/guestfs-actions.pod:3136 ../src/guestfs-actions.pod:3245 ../src/guestfs-actions.pod:3625
9411 msgid "\"unknown\""
9412 msgstr ""
9413
9414 #. type: textblock
9415 #: ../fish/guestfish-actions.pod:2002 ../src/guestfs-actions.pod:3138
9416 msgid "The distro could not be determined."
9417 msgstr ""
9418
9419 #. type: =item
9420 #: ../fish/guestfish-actions.pod:2004 ../fish/guestfish-actions.pod:2341 ../src/guestfs-actions.pod:3140 ../src/guestfs-actions.pod:3613
9421 msgid "\"windows\""
9422 msgstr ""
9423
9424 #. type: textblock
9425 #: ../fish/guestfish-actions.pod:2006 ../src/guestfs-actions.pod:3142
9426 msgid ""
9427 "Windows does not have distributions.  This string is returned if the OS type "
9428 "is Windows."
9429 msgstr ""
9430
9431 #. type: textblock
9432 #: ../fish/guestfish-actions.pod:2011 ../fish/guestfish-actions.pod:2090 ../fish/guestfish-actions.pod:2359 ../src/guestfs-actions.pod:3147 ../src/guestfs-actions.pod:3251 ../src/guestfs-actions.pod:3631
9433 msgid ""
9434 "Future versions of libguestfs may return other strings here.  The caller "
9435 "should be prepared to handle any string."
9436 msgstr ""
9437
9438 #. type: =head2
9439 #: ../fish/guestfish-actions.pod:2016
9440 msgid "inspect-get-drive-mappings"
9441 msgstr ""
9442
9443 #. type: verbatim
9444 #: ../fish/guestfish-actions.pod:2018
9445 #, no-wrap
9446 msgid ""
9447 " inspect-get-drive-mappings root\n"
9448 "\n"
9449 msgstr ""
9450
9451 #. type: textblock
9452 #: ../fish/guestfish-actions.pod:2020 ../src/guestfs-actions.pod:3163
9453 msgid ""
9454 "This call is useful for Windows which uses a primitive system of assigning "
9455 "drive letters (like \"C:\") to partitions.  This inspection API examines the "
9456 "Windows Registry to find out how disks/partitions are mapped to drive "
9457 "letters, and returns a hash table as in the example below:"
9458 msgstr ""
9459
9460 #. type: verbatim
9461 #: ../fish/guestfish-actions.pod:2026 ../src/guestfs-actions.pod:3169
9462 #, no-wrap
9463 msgid ""
9464 " C      =>     /dev/vda2\n"
9465 " E      =>     /dev/vdb1\n"
9466 " F      =>     /dev/vdc1\n"
9467 "\n"
9468 msgstr ""
9469
9470 #. type: textblock
9471 #: ../fish/guestfish-actions.pod:2030 ../src/guestfs-actions.pod:3173
9472 msgid ""
9473 "Note that keys are drive letters.  For Windows, the key is case insensitive "
9474 "and just contains the drive letter, without the customary colon separator "
9475 "character."
9476 msgstr ""
9477
9478 #. type: textblock
9479 #: ../fish/guestfish-actions.pod:2034 ../src/guestfs-actions.pod:3177
9480 msgid ""
9481 "In future we may support other operating systems that also used drive "
9482 "letters, but the keys for those might not be case insensitive and might be "
9483 "longer than 1 character.  For example in OS-9, hard drives were named C<h0>, "
9484 "C<h1> etc."
9485 msgstr ""
9486
9487 #. type: textblock
9488 #: ../fish/guestfish-actions.pod:2039 ../src/guestfs-actions.pod:3182
9489 msgid ""
9490 "For Windows guests, currently only hard drive mappings are returned.  "
9491 "Removable disks (eg. DVD-ROMs) are ignored."
9492 msgstr ""
9493
9494 #. type: textblock
9495 #: ../fish/guestfish-actions.pod:2042 ../src/guestfs-actions.pod:3185
9496 msgid ""
9497 "For guests that do not use drive mappings, or if the drive mappings could "
9498 "not be determined, this returns an empty hash table."
9499 msgstr ""
9500
9501 #. type: textblock
9502 #: ../fish/guestfish-actions.pod:2045
9503 msgid ""
9504 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
9505 "L</inspect-get-mountpoints>, L</inspect-get-filesystems>."
9506 msgstr ""
9507
9508 #. type: =head2
9509 #: ../fish/guestfish-actions.pod:2049
9510 msgid "inspect-get-filesystems"
9511 msgstr ""
9512
9513 #. type: verbatim
9514 #: ../fish/guestfish-actions.pod:2051
9515 #, no-wrap
9516 msgid ""
9517 " inspect-get-filesystems root\n"
9518 "\n"
9519 msgstr ""
9520
9521 #. type: textblock
9522 #: ../fish/guestfish-actions.pod:2053 ../src/guestfs-actions.pod:3206
9523 msgid ""
9524 "This returns a list of all the filesystems that we think are associated with "
9525 "this operating system.  This includes the root filesystem, other ordinary "
9526 "filesystems, and non-mounted devices like swap partitions."
9527 msgstr ""
9528
9529 #. type: textblock
9530 #: ../fish/guestfish-actions.pod:2058 ../src/guestfs-actions.pod:3211
9531 msgid ""
9532 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
9533 "to be shared between operating systems."
9534 msgstr ""
9535
9536 #. type: textblock
9537 #: ../fish/guestfish-actions.pod:2061
9538 msgid ""
9539 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
9540 "L</inspect-get-mountpoints>."
9541 msgstr ""
9542
9543 #. type: =head2
9544 #: ../fish/guestfish-actions.pod:2064
9545 msgid "inspect-get-format"
9546 msgstr ""
9547
9548 #. type: verbatim
9549 #: ../fish/guestfish-actions.pod:2066
9550 #, no-wrap
9551 msgid ""
9552 " inspect-get-format root\n"
9553 "\n"
9554 msgstr ""
9555
9556 #. type: textblock
9557 #: ../fish/guestfish-actions.pod:2068 ../src/guestfs-actions.pod:3229
9558 msgid ""
9559 "This returns the format of the inspected operating system.  You can use it "
9560 "to detect install images, live CDs and similar."
9561 msgstr ""
9562
9563 #. type: textblock
9564 #: ../fish/guestfish-actions.pod:2071 ../src/guestfs-actions.pod:3232
9565 msgid "Currently defined formats are:"
9566 msgstr ""
9567
9568 #. type: =item
9569 #: ../fish/guestfish-actions.pod:2075 ../src/guestfs-actions.pod:3236
9570 msgid "\"installed\""
9571 msgstr ""
9572
9573 #. type: textblock
9574 #: ../fish/guestfish-actions.pod:2077 ../src/guestfs-actions.pod:3238
9575 msgid "This is an installed operating system."
9576 msgstr ""
9577
9578 #. type: =item
9579 #: ../fish/guestfish-actions.pod:2079 ../src/guestfs-actions.pod:3240
9580 msgid "\"installer\""
9581 msgstr ""
9582
9583 #. type: textblock
9584 #: ../fish/guestfish-actions.pod:2081 ../src/guestfs-actions.pod:3242
9585 msgid ""
9586 "The disk image being inspected is not an installed operating system, but a "
9587 "I<bootable> install disk, live CD, or similar."
9588 msgstr ""
9589
9590 #. type: textblock
9591 #: ../fish/guestfish-actions.pod:2086 ../src/guestfs-actions.pod:3247
9592 msgid "The format of this disk image is not known."
9593 msgstr ""
9594
9595 #. type: =head2
9596 #: ../fish/guestfish-actions.pod:2095
9597 msgid "inspect-get-hostname"
9598 msgstr ""
9599
9600 #. type: verbatim
9601 #: ../fish/guestfish-actions.pod:2097
9602 #, no-wrap
9603 msgid ""
9604 " inspect-get-hostname root\n"
9605 "\n"
9606 msgstr ""
9607
9608 #. type: textblock
9609 #: ../fish/guestfish-actions.pod:2099 ../src/guestfs-actions.pod:3267
9610 msgid ""
9611 "This function returns the hostname of the operating system as found by "
9612 "inspection of the guest's configuration files."
9613 msgstr ""
9614
9615 #. type: textblock
9616 #: ../fish/guestfish-actions.pod:2102 ../src/guestfs-actions.pod:3270
9617 msgid ""
9618 "If the hostname could not be determined, then the string C<unknown> is "
9619 "returned."
9620 msgstr ""
9621
9622 #. type: =head2
9623 #: ../fish/guestfish-actions.pod:2107
9624 msgid "inspect-get-icon"
9625 msgstr ""
9626
9627 #. type: verbatim
9628 #: ../fish/guestfish-actions.pod:2109
9629 #, no-wrap
9630 msgid ""
9631 " inspect-get-icon root [favicon:..] [highquality:..]\n"
9632 "\n"
9633 msgstr ""
9634
9635 #. type: textblock
9636 #: ../fish/guestfish-actions.pod:2111 ../src/guestfs-actions.pod:3296
9637 msgid ""
9638 "This function returns an icon corresponding to the inspected operating "
9639 "system.  The icon is returned as a buffer containing a PNG image (re-encoded "
9640 "to PNG if necessary)."
9641 msgstr ""
9642
9643 #. type: textblock
9644 #: ../fish/guestfish-actions.pod:2115 ../src/guestfs-actions.pod:3300
9645 msgid ""
9646 "If it was not possible to get an icon this function returns a zero-length "
9647 "(non-NULL) buffer.  I<Callers must check for this case>."
9648 msgstr ""
9649
9650 #. type: textblock
9651 #: ../fish/guestfish-actions.pod:2118 ../src/guestfs-actions.pod:3303
9652 msgid ""
9653 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
9654 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
9655 "this file will be returned.  You can disable favicons by passing the "
9656 "optional C<favicon> boolean as false (default is true)."
9657 msgstr ""
9658
9659 #. type: textblock
9660 #: ../fish/guestfish-actions.pod:2124 ../src/guestfs-actions.pod:3309
9661 msgid ""
9662 "If finding the favicon fails, then we look in other places in the guest for "
9663 "a suitable icon."
9664 msgstr ""
9665
9666 #. type: textblock
9667 #: ../fish/guestfish-actions.pod:2127 ../src/guestfs-actions.pod:3312
9668 msgid ""
9669 "If the optional C<highquality> boolean is true then only high quality icons "
9670 "are returned, which means only icons of high resolution with an alpha "
9671 "channel.  The default (false) is to return any icon we can, even if it is of "
9672 "substandard quality."
9673 msgstr ""
9674
9675 #. type: textblock
9676 #: ../fish/guestfish-actions.pod:2138 ../src/guestfs-actions.pod:3323
9677 msgid ""
9678 "Unlike most other inspection API calls, the guest's disks must be mounted up "
9679 "before you call this, since it needs to read information from the guest "
9680 "filesystem during the call."
9681 msgstr ""
9682
9683 #. type: textblock
9684 #: ../fish/guestfish-actions.pod:2144 ../src/guestfs-actions.pod:3329
9685 msgid ""
9686 "B<Security:> The icon data comes from the untrusted guest, and should be "
9687 "treated with caution.  PNG files have been known to contain exploits.  "
9688 "Ensure that libpng (or other relevant libraries) are fully up to date before "
9689 "trying to process or display the icon."
9690 msgstr ""
9691
9692 #. type: textblock
9693 #: ../fish/guestfish-actions.pod:2152 ../src/guestfs-actions.pod:3337
9694 msgid ""
9695 "The PNG image returned can be any size.  It might not be square.  Libguestfs "
9696 "tries to return the largest, highest quality icon available.  The "
9697 "application must scale the icon to the required size."
9698 msgstr ""
9699
9700 #. type: textblock
9701 #: ../fish/guestfish-actions.pod:2159 ../src/guestfs-actions.pod:3344
9702 msgid ""
9703 "Extracting icons from Windows guests requires the external C<wrestool> "
9704 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
9705 "C<pnmtopng>, C<pamcut>)  from the C<netpbm> package.  These must be "
9706 "installed separately."
9707 msgstr ""
9708
9709 #. type: textblock
9710 #: ../fish/guestfish-actions.pod:2166 ../src/guestfs-actions.pod:3351
9711 msgid ""
9712 "Operating system icons are usually trademarks.  Seek legal advice before "
9713 "using trademarks in applications."
9714 msgstr ""
9715
9716 #. type: =head2
9717 #: ../fish/guestfish-actions.pod:2173
9718 msgid "inspect-get-major-version"
9719 msgstr ""
9720
9721 #. type: verbatim
9722 #: ../fish/guestfish-actions.pod:2175
9723 #, no-wrap
9724 msgid ""
9725 " inspect-get-major-version root\n"
9726 "\n"
9727 msgstr ""
9728
9729 #. type: textblock
9730 #: ../fish/guestfish-actions.pod:2177 ../src/guestfs-actions.pod:3392
9731 msgid "This returns the major version number of the inspected operating system."
9732 msgstr ""
9733
9734 #. type: textblock
9735 #: ../fish/guestfish-actions.pod:2180 ../src/guestfs-actions.pod:3395
9736 msgid ""
9737 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
9738 "popular public names used by the operating system.  Notably the operating "
9739 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
9740 "1).  You can find out the real versions corresponding to releases of Windows "
9741 "by consulting Wikipedia or MSDN."
9742 msgstr ""
9743
9744 #. type: textblock
9745 #: ../fish/guestfish-actions.pod:2187 ../fish/guestfish-actions.pod:2198 ../src/guestfs-actions.pod:3402 ../src/guestfs-actions.pod:3419
9746 msgid "If the version could not be determined, then C<0> is returned."
9747 msgstr ""
9748
9749 #. type: =head2
9750 #: ../fish/guestfish-actions.pod:2191
9751 msgid "inspect-get-minor-version"
9752 msgstr ""
9753
9754 #. type: verbatim
9755 #: ../fish/guestfish-actions.pod:2193
9756 #, no-wrap
9757 msgid ""
9758 " inspect-get-minor-version root\n"
9759 "\n"
9760 msgstr ""
9761
9762 #. type: textblock
9763 #: ../fish/guestfish-actions.pod:2195 ../src/guestfs-actions.pod:3416
9764 msgid "This returns the minor version number of the inspected operating system."
9765 msgstr ""
9766
9767 #. type: textblock
9768 #: ../fish/guestfish-actions.pod:2200
9769 msgid ""
9770 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
9771 "L</inspect-get-major-version>."
9772 msgstr ""
9773
9774 #. type: =head2
9775 #: ../fish/guestfish-actions.pod:2203
9776 msgid "inspect-get-mountpoints"
9777 msgstr ""
9778
9779 #. type: verbatim
9780 #: ../fish/guestfish-actions.pod:2205
9781 #, no-wrap
9782 msgid ""
9783 " inspect-get-mountpoints root\n"
9784 "\n"
9785 msgstr ""
9786
9787 #. type: textblock
9788 #: ../fish/guestfish-actions.pod:2207 ../src/guestfs-actions.pod:3434
9789 msgid ""
9790 "This returns a hash of where we think the filesystems associated with this "
9791 "operating system should be mounted.  Callers should note that this is at "
9792 "best an educated guess made by reading configuration files such as "
9793 "C</etc/fstab>.  I<In particular note> that this may return filesystems which "
9794 "are non-existent or not mountable and callers should be prepared to handle "
9795 "or ignore failures if they try to mount them."
9796 msgstr ""
9797
9798 #. type: textblock
9799 #: ../fish/guestfish-actions.pod:2216 ../src/guestfs-actions.pod:3443
9800 msgid ""
9801 "Each element in the returned hashtable has a key which is the path of the "
9802 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
9803 "mounted there (eg. C</dev/sda1>)."
9804 msgstr ""
9805
9806 #. type: textblock
9807 #: ../fish/guestfish-actions.pod:2221 ../src/guestfs-actions.pod:3448
9808 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
9809 msgstr ""
9810
9811 #. type: textblock
9812 #: ../fish/guestfish-actions.pod:2224
9813 msgid ""
9814 "For operating systems like Windows which still use drive letters, this call "
9815 "will only return an entry for the first drive \"mounted on\" C</>.  For "
9816 "information about the mapping of drive letters to partitions, see "
9817 "L</inspect-get-drive-mappings>."
9818 msgstr ""
9819
9820 #. type: textblock
9821 #: ../fish/guestfish-actions.pod:2230
9822 msgid ""
9823 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
9824 "L</inspect-get-filesystems>."
9825 msgstr ""
9826
9827 #. type: =head2
9828 #: ../fish/guestfish-actions.pod:2233
9829 msgid "inspect-get-package-format"
9830 msgstr ""
9831
9832 #. type: verbatim
9833 #: ../fish/guestfish-actions.pod:2235
9834 #, no-wrap
9835 msgid ""
9836 " inspect-get-package-format root\n"
9837 "\n"
9838 msgstr ""
9839
9840 #. type: textblock
9841 #: ../fish/guestfish-actions.pod:2237
9842 msgid ""
9843 "This function and L</inspect-get-package-management> return the package "
9844 "format and package management tool used by the inspected operating system.  "
9845 "For example for Fedora these functions would return C<rpm> (package format) "
9846 "and C<yum> (package management)."
9847 msgstr ""
9848
9849 #. type: textblock
9850 #: ../fish/guestfish-actions.pod:2243 ../src/guestfs-actions.pod:3480
9851 msgid ""
9852 "This returns the string C<unknown> if we could not determine the package "
9853 "format I<or> if the operating system does not have a real packaging system "
9854 "(eg. Windows)."
9855 msgstr ""
9856
9857 #. type: textblock
9858 #: ../fish/guestfish-actions.pod:2247 ../src/guestfs-actions.pod:3484
9859 msgid ""
9860 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>, "
9861 "C<pkgsrc>.  Future versions of libguestfs may return other strings."
9862 msgstr ""
9863
9864 #. type: =head2
9865 #: ../fish/guestfish-actions.pod:2253
9866 msgid "inspect-get-package-management"
9867 msgstr ""
9868
9869 #. type: verbatim
9870 #: ../fish/guestfish-actions.pod:2255
9871 #, no-wrap
9872 msgid ""
9873 " inspect-get-package-management root\n"
9874 "\n"
9875 msgstr ""
9876
9877 #. type: textblock
9878 #: ../fish/guestfish-actions.pod:2257
9879 msgid ""
9880 "L</inspect-get-package-format> and this function return the package format "
9881 "and package management tool used by the inspected operating system.  For "
9882 "example for Fedora these functions would return C<rpm> (package format) and "
9883 "C<yum> (package management)."
9884 msgstr ""
9885
9886 #. type: textblock
9887 #: ../fish/guestfish-actions.pod:2263 ../src/guestfs-actions.pod:3507
9888 msgid ""
9889 "This returns the string C<unknown> if we could not determine the package "
9890 "management tool I<or> if the operating system does not have a real packaging "
9891 "system (eg. Windows)."
9892 msgstr ""
9893
9894 #. type: textblock
9895 #: ../fish/guestfish-actions.pod:2267 ../src/guestfs-actions.pod:3511
9896 msgid ""
9897 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
9898 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>, C<zypper>.  Future "
9899 "versions of libguestfs may return other strings."
9900 msgstr ""
9901
9902 #. type: =head2
9903 #: ../fish/guestfish-actions.pod:2274
9904 msgid "inspect-get-product-name"
9905 msgstr ""
9906
9907 #. type: verbatim
9908 #: ../fish/guestfish-actions.pod:2276
9909 #, no-wrap
9910 msgid ""
9911 " inspect-get-product-name root\n"
9912 "\n"
9913 msgstr ""
9914
9915 #. type: textblock
9916 #: ../fish/guestfish-actions.pod:2278 ../src/guestfs-actions.pod:3529
9917 msgid ""
9918 "This returns the product name of the inspected operating system.  The "
9919 "product name is generally some freeform string which can be displayed to the "
9920 "user, but should not be parsed by programs."
9921 msgstr ""
9922
9923 #. type: textblock
9924 #: ../fish/guestfish-actions.pod:2283 ../src/guestfs-actions.pod:3534
9925 msgid ""
9926 "If the product name could not be determined, then the string C<unknown> is "
9927 "returned."
9928 msgstr ""
9929
9930 #. type: =head2
9931 #: ../fish/guestfish-actions.pod:2288
9932 msgid "inspect-get-product-variant"
9933 msgstr ""
9934
9935 #. type: verbatim
9936 #: ../fish/guestfish-actions.pod:2290
9937 #, no-wrap
9938 msgid ""
9939 " inspect-get-product-variant root\n"
9940 "\n"
9941 msgstr ""
9942
9943 #. type: textblock
9944 #: ../fish/guestfish-actions.pod:2292 ../src/guestfs-actions.pod:3550
9945 msgid "This returns the product variant of the inspected operating system."
9946 msgstr ""
9947
9948 #. type: textblock
9949 #: ../fish/guestfish-actions.pod:2295 ../src/guestfs-actions.pod:3553
9950 msgid ""
9951 "For Windows guests, this returns the contents of the Registry key "
9952 "C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> "
9953 "which is usually a string such as C<Client> or C<Server> (other values are "
9954 "possible).  This can be used to distinguish consumer and enterprise versions "
9955 "of Windows that have the same version number (for example, Windows 7 and "
9956 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
9957 "the latter is C<Server>)."
9958 msgstr ""
9959
9960 #. type: textblock
9961 #: ../fish/guestfish-actions.pod:2304 ../src/guestfs-actions.pod:3562
9962 msgid ""
9963 "For enterprise Linux guests, in future we intend this to return the product "
9964 "variant such as C<Desktop>, C<Server> and so on.  But this is not "
9965 "implemented at present."
9966 msgstr ""
9967
9968 #. type: textblock
9969 #: ../fish/guestfish-actions.pod:2308 ../src/guestfs-actions.pod:3566
9970 msgid ""
9971 "If the product variant could not be determined, then the string C<unknown> "
9972 "is returned."
9973 msgstr ""
9974
9975 #. type: textblock
9976 #: ../fish/guestfish-actions.pod:2311
9977 msgid ""
9978 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
9979 "L</inspect-get-product-name>, L</inspect-get-major-version>."
9980 msgstr ""
9981
9982 #. type: =head2
9983 #: ../fish/guestfish-actions.pod:2315
9984 msgid "inspect-get-roots"
9985 msgstr ""
9986
9987 #. type: verbatim
9988 #: ../fish/guestfish-actions.pod:2317
9989 #, no-wrap
9990 msgid ""
9991 " inspect-get-roots\n"
9992 "\n"
9993 msgstr ""
9994
9995 #. type: textblock
9996 #: ../fish/guestfish-actions.pod:2319
9997 msgid ""
9998 "This function is a convenient way to get the list of root devices, as "
9999 "returned from a previous call to L</inspect-os>, but without redoing the "
10000 "whole inspection process."
10001 msgstr ""
10002
10003 #. type: textblock
10004 #: ../fish/guestfish-actions.pod:2323
10005 msgid ""
10006 "This returns an empty list if either no root devices were found or the "
10007 "caller has not called L</inspect-os>."
10008 msgstr ""
10009
10010 #. type: =head2
10011 #: ../fish/guestfish-actions.pod:2328
10012 msgid "inspect-get-type"
10013 msgstr ""
10014
10015 #. type: verbatim
10016 #: ../fish/guestfish-actions.pod:2330
10017 #, no-wrap
10018 msgid ""
10019 " inspect-get-type root\n"
10020 "\n"
10021 msgstr ""
10022
10023 #. type: textblock
10024 #: ../fish/guestfish-actions.pod:2332 ../src/guestfs-actions.pod:3604
10025 msgid ""
10026 "This returns the type of the inspected operating system.  Currently defined "
10027 "types are:"
10028 msgstr ""
10029
10030 #. type: =item
10031 #: ../fish/guestfish-actions.pod:2337 ../src/guestfs-actions.pod:3609
10032 msgid "\"linux\""
10033 msgstr ""
10034
10035 #. type: textblock
10036 #: ../fish/guestfish-actions.pod:2339 ../src/guestfs-actions.pod:3611
10037 msgid "Any Linux-based operating system."
10038 msgstr ""
10039
10040 #. type: textblock
10041 #: ../fish/guestfish-actions.pod:2343 ../src/guestfs-actions.pod:3615
10042 msgid "Any Microsoft Windows operating system."
10043 msgstr ""
10044
10045 #. type: =item
10046 #: ../fish/guestfish-actions.pod:2345 ../src/guestfs-actions.pod:3617
10047 msgid "\"freebsd\""
10048 msgstr ""
10049
10050 #. type: textblock
10051 #: ../fish/guestfish-actions.pod:2347 ../src/guestfs-actions.pod:3619
10052 msgid "FreeBSD."
10053 msgstr ""
10054
10055 #. type: =item
10056 #: ../fish/guestfish-actions.pod:2349 ../src/guestfs-actions.pod:3621
10057 msgid "\"netbsd\""
10058 msgstr ""
10059
10060 #. type: textblock
10061 #: ../fish/guestfish-actions.pod:2351 ../src/guestfs-actions.pod:3623
10062 msgid "NetBSD."
10063 msgstr ""
10064
10065 #. type: textblock
10066 #: ../fish/guestfish-actions.pod:2355 ../src/guestfs-actions.pod:3627
10067 msgid "The operating system type could not be determined."
10068 msgstr ""
10069
10070 #. type: =head2
10071 #: ../fish/guestfish-actions.pod:2364
10072 msgid "inspect-get-windows-current-control-set"
10073 msgstr ""
10074
10075 #. type: verbatim
10076 #: ../fish/guestfish-actions.pod:2366
10077 #, no-wrap
10078 msgid ""
10079 " inspect-get-windows-current-control-set root\n"
10080 "\n"
10081 msgstr ""
10082
10083 #. type: textblock
10084 #: ../fish/guestfish-actions.pod:2368 ../src/guestfs-actions.pod:3647
10085 msgid ""
10086 "This returns the Windows CurrentControlSet of the inspected guest.  The "
10087 "CurrentControlSet is a registry key name such as C<ControlSet001>."
10088 msgstr ""
10089
10090 #. type: textblock
10091 #: ../fish/guestfish-actions.pod:2371 ../src/guestfs-actions.pod:3650
10092 msgid ""
10093 "This call assumes that the guest is Windows and that the Registry could be "
10094 "examined by inspection.  If this is not the case then an error is returned."
10095 msgstr ""
10096
10097 #. type: =head2
10098 #: ../fish/guestfish-actions.pod:2377
10099 msgid "inspect-get-windows-systemroot"
10100 msgstr ""
10101
10102 #. type: verbatim
10103 #: ../fish/guestfish-actions.pod:2379
10104 #, no-wrap
10105 msgid ""
10106 " inspect-get-windows-systemroot root\n"
10107 "\n"
10108 msgstr ""
10109
10110 #. type: textblock
10111 #: ../fish/guestfish-actions.pod:2381 ../src/guestfs-actions.pod:3667
10112 msgid ""
10113 "This returns the Windows systemroot of the inspected guest.  The systemroot "
10114 "is a directory path such as C</WINDOWS>."
10115 msgstr ""
10116
10117 #. type: textblock
10118 #: ../fish/guestfish-actions.pod:2384 ../src/guestfs-actions.pod:3670
10119 msgid ""
10120 "This call assumes that the guest is Windows and that the systemroot could be "
10121 "determined by inspection.  If this is not the case then an error is "
10122 "returned."
10123 msgstr ""
10124
10125 #. type: =head2
10126 #: ../fish/guestfish-actions.pod:2390
10127 msgid "inspect-is-live"
10128 msgstr ""
10129
10130 #. type: verbatim
10131 #: ../fish/guestfish-actions.pod:2392
10132 #, no-wrap
10133 msgid ""
10134 " inspect-is-live root\n"
10135 "\n"
10136 msgstr ""
10137
10138 #. type: textblock
10139 #: ../fish/guestfish-actions.pod:2394
10140 msgid ""
10141 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
10142 "then this returns true if a live image was detected on the disk."
10143 msgstr ""
10144
10145 #. type: =head2
10146 #: ../fish/guestfish-actions.pod:2400
10147 msgid "inspect-is-multipart"
10148 msgstr ""
10149
10150 #. type: verbatim
10151 #: ../fish/guestfish-actions.pod:2402
10152 #, no-wrap
10153 msgid ""
10154 " inspect-is-multipart root\n"
10155 "\n"
10156 msgstr ""
10157
10158 #. type: textblock
10159 #: ../fish/guestfish-actions.pod:2404
10160 msgid ""
10161 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
10162 "then this returns true if the disk is part of a set."
10163 msgstr ""
10164
10165 #. type: =head2
10166 #: ../fish/guestfish-actions.pod:2410
10167 msgid "inspect-is-netinst"
10168 msgstr ""
10169
10170 #. type: verbatim
10171 #: ../fish/guestfish-actions.pod:2412
10172 #, no-wrap
10173 msgid ""
10174 " inspect-is-netinst root\n"
10175 "\n"
10176 msgstr ""
10177
10178 #. type: textblock
10179 #: ../fish/guestfish-actions.pod:2414
10180 msgid ""
10181 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
10182 "then this returns true if the disk is a network installer, ie. not a "
10183 "self-contained install CD but one which is likely to require network access "
10184 "to complete the install."
10185 msgstr ""
10186
10187 #. type: =head2
10188 #: ../fish/guestfish-actions.pod:2422
10189 msgid "inspect-list-applications"
10190 msgstr ""
10191
10192 #. type: verbatim
10193 #: ../fish/guestfish-actions.pod:2424
10194 #, no-wrap
10195 msgid ""
10196 " inspect-list-applications root\n"
10197 "\n"
10198 msgstr ""
10199
10200 #. type: textblock
10201 #: ../fish/guestfish-actions.pod:2426 ../src/guestfs-actions.pod:3737
10202 msgid "Return the list of applications installed in the operating system."
10203 msgstr ""
10204
10205 #. type: textblock
10206 #: ../fish/guestfish-actions.pod:2428
10207 msgid ""
10208 "I<Note:> This call works differently from other parts of the inspection "
10209 "API.  You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
10210 "then mount up the disks, before calling this.  Listing applications is a "
10211 "significantly more difficult operation which requires access to the full "
10212 "filesystem.  Also note that unlike the other L</inspect-get-*> calls which "
10213 "are just returning data cached in the libguestfs handle, this call actually "
10214 "reads parts of the mounted filesystems during the call."
10215 msgstr ""
10216
10217 #. type: textblock
10218 #: ../fish/guestfish-actions.pod:2438 ../src/guestfs-actions.pod:3749
10219 msgid ""
10220 "This returns an empty list if the inspection code was not able to determine "
10221 "the list of applications."
10222 msgstr ""
10223
10224 #. type: textblock
10225 #: ../fish/guestfish-actions.pod:2441 ../src/guestfs-actions.pod:3752
10226 msgid "The application structure contains the following fields:"
10227 msgstr ""
10228
10229 #. type: =item
10230 #: ../fish/guestfish-actions.pod:2445 ../src/guestfs-actions.pod:3756
10231 msgid "C<app_name>"
10232 msgstr ""
10233
10234 #. type: textblock
10235 #: ../fish/guestfish-actions.pod:2447 ../src/guestfs-actions.pod:3758
10236 msgid ""
10237 "The name of the application.  For Red Hat-derived and Debian-derived Linux "
10238 "guests, this is the package name."
10239 msgstr ""
10240
10241 #. type: =item
10242 #: ../fish/guestfish-actions.pod:2450 ../src/guestfs-actions.pod:3761
10243 msgid "C<app_display_name>"
10244 msgstr ""
10245
10246 #. type: textblock
10247 #: ../fish/guestfish-actions.pod:2452 ../src/guestfs-actions.pod:3763
10248 msgid ""
10249 "The display name of the application, sometimes localized to the install "
10250 "language of the guest operating system."
10251 msgstr ""
10252
10253 #. type: textblock
10254 #: ../fish/guestfish-actions.pod:2455 ../src/guestfs-actions.pod:3766
10255 msgid ""
10256 "If unavailable this is returned as an empty string C<\"\">.  Callers needing "
10257 "to display something can use C<app_name> instead."
10258 msgstr ""
10259
10260 #. type: =item
10261 #: ../fish/guestfish-actions.pod:2458 ../src/guestfs-actions.pod:3769
10262 msgid "C<app_epoch>"
10263 msgstr ""
10264
10265 #. type: textblock
10266 #: ../fish/guestfish-actions.pod:2460 ../src/guestfs-actions.pod:3771
10267 msgid ""
10268 "For package managers which use epochs, this contains the epoch of the "
10269 "package (an integer).  If unavailable, this is returned as C<0>."
10270 msgstr ""
10271
10272 #. type: =item
10273 #: ../fish/guestfish-actions.pod:2463 ../src/guestfs-actions.pod:3774
10274 msgid "C<app_version>"
10275 msgstr ""
10276
10277 #. type: textblock
10278 #: ../fish/guestfish-actions.pod:2465 ../src/guestfs-actions.pod:3776
10279 msgid ""
10280 "The version string of the application or package.  If unavailable this is "
10281 "returned as an empty string C<\"\">."
10282 msgstr ""
10283
10284 #. type: =item
10285 #: ../fish/guestfish-actions.pod:2468 ../src/guestfs-actions.pod:3779
10286 msgid "C<app_release>"
10287 msgstr ""
10288
10289 #. type: textblock
10290 #: ../fish/guestfish-actions.pod:2470 ../src/guestfs-actions.pod:3781
10291 msgid ""
10292 "The release string of the application or package, for package managers that "
10293 "use this.  If unavailable this is returned as an empty string C<\"\">."
10294 msgstr ""
10295
10296 #. type: =item
10297 #: ../fish/guestfish-actions.pod:2474 ../src/guestfs-actions.pod:3785
10298 msgid "C<app_install_path>"
10299 msgstr ""
10300
10301 #. type: textblock
10302 #: ../fish/guestfish-actions.pod:2476 ../src/guestfs-actions.pod:3787
10303 msgid ""
10304 "The installation path of the application (on operating systems such as "
10305 "Windows which use installation paths).  This path is in the format used by "
10306 "the guest operating system, it is not a libguestfs path."
10307 msgstr ""
10308
10309 #. type: textblock
10310 #: ../fish/guestfish-actions.pod:2481 ../src/guestfs-actions.pod:3792
10311 msgid "If unavailable this is returned as an empty string C<\"\">."
10312 msgstr ""
10313
10314 #. type: =item
10315 #: ../fish/guestfish-actions.pod:2483 ../src/guestfs-actions.pod:3794
10316 msgid "C<app_trans_path>"
10317 msgstr ""
10318
10319 #. type: textblock
10320 #: ../fish/guestfish-actions.pod:2485 ../src/guestfs-actions.pod:3796
10321 msgid ""
10322 "The install path translated into a libguestfs path.  If unavailable this is "
10323 "returned as an empty string C<\"\">."
10324 msgstr ""
10325
10326 #. type: =item
10327 #: ../fish/guestfish-actions.pod:2488 ../src/guestfs-actions.pod:3799
10328 msgid "C<app_publisher>"
10329 msgstr ""
10330
10331 #. type: textblock
10332 #: ../fish/guestfish-actions.pod:2490 ../src/guestfs-actions.pod:3801
10333 msgid ""
10334 "The name of the publisher of the application, for package managers that use "
10335 "this.  If unavailable this is returned as an empty string C<\"\">."
10336 msgstr ""
10337
10338 #. type: =item
10339 #: ../fish/guestfish-actions.pod:2494 ../src/guestfs-actions.pod:3805
10340 msgid "C<app_url>"
10341 msgstr ""
10342
10343 #. type: textblock
10344 #: ../fish/guestfish-actions.pod:2496 ../src/guestfs-actions.pod:3807
10345 msgid ""
10346 "The URL (eg. upstream URL) of the application.  If unavailable this is "
10347 "returned as an empty string C<\"\">."
10348 msgstr ""
10349
10350 #. type: =item
10351 #: ../fish/guestfish-actions.pod:2499 ../src/guestfs-actions.pod:3810
10352 msgid "C<app_source_package>"
10353 msgstr ""
10354
10355 #. type: textblock
10356 #: ../fish/guestfish-actions.pod:2501 ../src/guestfs-actions.pod:3812
10357 msgid ""
10358 "For packaging systems which support this, the name of the source package.  "
10359 "If unavailable this is returned as an empty string C<\"\">."
10360 msgstr ""
10361
10362 #. type: =item
10363 #: ../fish/guestfish-actions.pod:2504 ../src/guestfs-actions.pod:3815
10364 msgid "C<app_summary>"
10365 msgstr ""
10366
10367 #. type: textblock
10368 #: ../fish/guestfish-actions.pod:2506 ../src/guestfs-actions.pod:3817
10369 msgid ""
10370 "A short (usually one line) description of the application or package.  If "
10371 "unavailable this is returned as an empty string C<\"\">."
10372 msgstr ""
10373
10374 #. type: =item
10375 #: ../fish/guestfish-actions.pod:2509 ../src/guestfs-actions.pod:3820
10376 msgid "C<app_description>"
10377 msgstr ""
10378
10379 #. type: textblock
10380 #: ../fish/guestfish-actions.pod:2511 ../src/guestfs-actions.pod:3822
10381 msgid ""
10382 "A longer description of the application or package.  If unavailable this is "
10383 "returned as an empty string C<\"\">."
10384 msgstr ""
10385
10386 #. type: =head2
10387 #: ../fish/guestfish-actions.pod:2518
10388 msgid "inspect-os"
10389 msgstr ""
10390
10391 #. type: verbatim
10392 #: ../fish/guestfish-actions.pod:2520
10393 #, no-wrap
10394 msgid ""
10395 " inspect-os\n"
10396 "\n"
10397 msgstr ""
10398
10399 #. type: textblock
10400 #: ../fish/guestfish-actions.pod:2522 ../src/guestfs-actions.pod:3840
10401 msgid ""
10402 "This function uses other libguestfs functions and certain heuristics to "
10403 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
10404 "for operating systems."
10405 msgstr ""
10406
10407 #. type: textblock
10408 #: ../fish/guestfish-actions.pod:2526 ../src/guestfs-actions.pod:3844
10409 msgid "The list returned is empty if no operating systems were found."
10410 msgstr ""
10411
10412 #. type: textblock
10413 #: ../fish/guestfish-actions.pod:2528 ../src/guestfs-actions.pod:3846
10414 msgid ""
10415 "If one operating system was found, then this returns a list with a single "
10416 "element, which is the name of the root filesystem of this operating system.  "
10417 "It is also possible for this function to return a list containing more than "
10418 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
10419 "element being the root filesystem of one of the operating systems."
10420 msgstr ""
10421
10422 #. type: textblock
10423 #: ../fish/guestfish-actions.pod:2535
10424 msgid ""
10425 "You can pass the root string(s) returned to other L</inspect-get-*> "
10426 "functions in order to query further information about each operating system, "
10427 "such as the name and version."
10428 msgstr ""
10429
10430 #. type: textblock
10431 #: ../fish/guestfish-actions.pod:2540
10432 msgid ""
10433 "This function uses other libguestfs features such as L</mount-ro> and "
10434 "L</umount-all> in order to mount and unmount filesystems and look at the "
10435 "contents.  This should be called with no disks currently mounted.  The "
10436 "function may also use Augeas, so any existing Augeas handle will be closed."
10437 msgstr ""
10438
10439 #. type: textblock
10440 #: ../fish/guestfish-actions.pod:2546 ../src/guestfs-actions.pod:3864
10441 msgid ""
10442 "This function cannot decrypt encrypted disks.  The caller must do that first "
10443 "(supplying the necessary keys) if the disk is encrypted."
10444 msgstr ""
10445
10446 #. type: textblock
10447 #: ../fish/guestfish-actions.pod:2552 ../fish/guestfish-actions.pod:2750 ../fish/guestfish-actions.pod:2809
10448 msgid "See also L</list-filesystems>."
10449 msgstr ""
10450
10451 #. type: =head2
10452 #: ../fish/guestfish-actions.pod:2554
10453 msgid "is-blockdev"
10454 msgstr ""
10455
10456 #. type: verbatim
10457 #: ../fish/guestfish-actions.pod:2556
10458 #, no-wrap
10459 msgid ""
10460 " is-blockdev path\n"
10461 "\n"
10462 msgstr ""
10463
10464 #. type: textblock
10465 #: ../fish/guestfish-actions.pod:2558 ../src/guestfs-actions.pod:3884
10466 msgid ""
10467 "This returns C<true> if and only if there is a block device with the given "
10468 "C<path> name."
10469 msgstr ""
10470
10471 #. type: textblock
10472 #: ../fish/guestfish-actions.pod:2561 ../fish/guestfish-actions.pod:2579 ../fish/guestfish-actions.pod:2598 ../fish/guestfish-actions.pod:2607 ../fish/guestfish-actions.pod:2617 ../fish/guestfish-actions.pod:2651 ../fish/guestfish-actions.pod:2660
10473 msgid "See also L</stat>."
10474 msgstr ""
10475
10476 #. type: =head2
10477 #: ../fish/guestfish-actions.pod:2563
10478 msgid "is-busy"
10479 msgstr ""
10480
10481 #. type: verbatim
10482 #: ../fish/guestfish-actions.pod:2565
10483 #, no-wrap
10484 msgid ""
10485 " is-busy\n"
10486 "\n"
10487 msgstr ""
10488
10489 #. type: textblock
10490 #: ../fish/guestfish-actions.pod:2567 ../src/guestfs-actions.pod:3898
10491 msgid ""
10492 "This returns true iff this handle is busy processing a command (in the "
10493 "C<BUSY> state)."
10494 msgstr ""
10495
10496 #. type: =head2
10497 #: ../fish/guestfish-actions.pod:2572
10498 msgid "is-chardev"
10499 msgstr ""
10500
10501 #. type: verbatim
10502 #: ../fish/guestfish-actions.pod:2574
10503 #, no-wrap
10504 msgid ""
10505 " is-chardev path\n"
10506 "\n"
10507 msgstr ""
10508
10509 #. type: textblock
10510 #: ../fish/guestfish-actions.pod:2576 ../src/guestfs-actions.pod:3913
10511 msgid ""
10512 "This returns C<true> if and only if there is a character device with the "
10513 "given C<path> name."
10514 msgstr ""
10515
10516 #. type: =head2
10517 #: ../fish/guestfish-actions.pod:2581
10518 msgid "is-config"
10519 msgstr ""
10520
10521 #. type: verbatim
10522 #: ../fish/guestfish-actions.pod:2583
10523 #, no-wrap
10524 msgid ""
10525 " is-config\n"
10526 "\n"
10527 msgstr ""
10528
10529 #. type: textblock
10530 #: ../fish/guestfish-actions.pod:2585 ../src/guestfs-actions.pod:3927
10531 msgid ""
10532 "This returns true iff this handle is being configured (in the C<CONFIG> "
10533 "state)."
10534 msgstr ""
10535
10536 #. type: =head2
10537 #: ../fish/guestfish-actions.pod:2590
10538 msgid "is-dir"
10539 msgstr ""
10540
10541 #. type: verbatim
10542 #: ../fish/guestfish-actions.pod:2592
10543 #, no-wrap
10544 msgid ""
10545 " is-dir path\n"
10546 "\n"
10547 msgstr ""
10548
10549 #. type: textblock
10550 #: ../fish/guestfish-actions.pod:2594 ../src/guestfs-actions.pod:3942
10551 msgid ""
10552 "This returns C<true> if and only if there is a directory with the given "
10553 "C<path> name.  Note that it returns false for other objects like files."
10554 msgstr ""
10555
10556 #. type: =head2
10557 #: ../fish/guestfish-actions.pod:2600
10558 msgid "is-fifo"
10559 msgstr ""
10560
10561 #. type: verbatim
10562 #: ../fish/guestfish-actions.pod:2602
10563 #, no-wrap
10564 msgid ""
10565 " is-fifo path\n"
10566 "\n"
10567 msgstr ""
10568
10569 #. type: textblock
10570 #: ../fish/guestfish-actions.pod:2604 ../src/guestfs-actions.pod:3958
10571 msgid ""
10572 "This returns C<true> if and only if there is a FIFO (named pipe)  with the "
10573 "given C<path> name."
10574 msgstr ""
10575
10576 #. type: =head2
10577 #: ../fish/guestfish-actions.pod:2609
10578 msgid "is-file"
10579 msgstr ""
10580
10581 #. type: verbatim
10582 #: ../fish/guestfish-actions.pod:2611
10583 #, no-wrap
10584 msgid ""
10585 " is-file path\n"
10586 "\n"
10587 msgstr ""
10588
10589 #. type: textblock
10590 #: ../fish/guestfish-actions.pod:2613 ../src/guestfs-actions.pod:3973
10591 msgid ""
10592 "This returns C<true> if and only if there is a regular file with the given "
10593 "C<path> name.  Note that it returns false for other objects like "
10594 "directories."
10595 msgstr ""
10596
10597 #. type: =head2
10598 #: ../fish/guestfish-actions.pod:2619
10599 msgid "is-launching"
10600 msgstr ""
10601
10602 #. type: verbatim
10603 #: ../fish/guestfish-actions.pod:2621
10604 #, no-wrap
10605 msgid ""
10606 " is-launching\n"
10607 "\n"
10608 msgstr ""
10609
10610 #. type: textblock
10611 #: ../fish/guestfish-actions.pod:2623 ../src/guestfs-actions.pod:3988
10612 msgid ""
10613 "This returns true iff this handle is launching the subprocess (in the "
10614 "C<LAUNCHING> state)."
10615 msgstr ""
10616
10617 #. type: =head2
10618 #: ../fish/guestfish-actions.pod:2628
10619 msgid "is-lv"
10620 msgstr ""
10621
10622 #. type: verbatim
10623 #: ../fish/guestfish-actions.pod:2630
10624 #, no-wrap
10625 msgid ""
10626 " is-lv device\n"
10627 "\n"
10628 msgstr ""
10629
10630 #. type: textblock
10631 #: ../fish/guestfish-actions.pod:2632 ../src/guestfs-actions.pod:4003
10632 msgid ""
10633 "This command tests whether C<device> is a logical volume, and returns true "
10634 "iff this is the case."
10635 msgstr ""
10636
10637 #. type: =head2
10638 #: ../fish/guestfish-actions.pod:2635
10639 msgid "is-ready"
10640 msgstr ""
10641
10642 #. type: verbatim
10643 #: ../fish/guestfish-actions.pod:2637
10644 #, no-wrap
10645 msgid ""
10646 " is-ready\n"
10647 "\n"
10648 msgstr ""
10649
10650 #. type: textblock
10651 #: ../fish/guestfish-actions.pod:2639 ../src/guestfs-actions.pod:4015
10652 msgid ""
10653 "This returns true iff this handle is ready to accept commands (in the "
10654 "C<READY> state)."
10655 msgstr ""
10656
10657 #. type: =head2
10658 #: ../fish/guestfish-actions.pod:2644
10659 msgid "is-socket"
10660 msgstr ""
10661
10662 #. type: verbatim
10663 #: ../fish/guestfish-actions.pod:2646
10664 #, no-wrap
10665 msgid ""
10666 " is-socket path\n"
10667 "\n"
10668 msgstr ""
10669
10670 #. type: textblock
10671 #: ../fish/guestfish-actions.pod:2648 ../src/guestfs-actions.pod:4030
10672 msgid ""
10673 "This returns C<true> if and only if there is a Unix domain socket with the "
10674 "given C<path> name."
10675 msgstr ""
10676
10677 #. type: =head2
10678 #: ../fish/guestfish-actions.pod:2653
10679 msgid "is-symlink"
10680 msgstr ""
10681
10682 #. type: verbatim
10683 #: ../fish/guestfish-actions.pod:2655
10684 #, no-wrap
10685 msgid ""
10686 " is-symlink path\n"
10687 "\n"
10688 msgstr ""
10689
10690 #. type: textblock
10691 #: ../fish/guestfish-actions.pod:2657 ../src/guestfs-actions.pod:4045
10692 msgid ""
10693 "This returns C<true> if and only if there is a symbolic link with the given "
10694 "C<path> name."
10695 msgstr ""
10696
10697 #. type: =head2
10698 #: ../fish/guestfish-actions.pod:2662
10699 msgid "is-zero"
10700 msgstr ""
10701
10702 #. type: verbatim
10703 #: ../fish/guestfish-actions.pod:2664
10704 #, no-wrap
10705 msgid ""
10706 " is-zero path\n"
10707 "\n"
10708 msgstr ""
10709
10710 #. type: textblock
10711 #: ../fish/guestfish-actions.pod:2666 ../src/guestfs-actions.pod:4060
10712 msgid ""
10713 "This returns true iff the file exists and the file is empty or it contains "
10714 "all zero bytes."
10715 msgstr ""
10716
10717 #. type: =head2
10718 #: ../fish/guestfish-actions.pod:2669
10719 msgid "is-zero-device"
10720 msgstr ""
10721
10722 #. type: verbatim
10723 #: ../fish/guestfish-actions.pod:2671
10724 #, no-wrap
10725 msgid ""
10726 " is-zero-device device\n"
10727 "\n"
10728 msgstr ""
10729
10730 #. type: textblock
10731 #: ../fish/guestfish-actions.pod:2673 ../src/guestfs-actions.pod:4073
10732 msgid "This returns true iff the device exists and contains all zero bytes."
10733 msgstr ""
10734
10735 #. type: textblock
10736 #: ../fish/guestfish-actions.pod:2675 ../src/guestfs-actions.pod:4075
10737 msgid "Note that for large devices this can take a long time to run."
10738 msgstr ""
10739
10740 #. type: =head2
10741 #: ../fish/guestfish-actions.pod:2677
10742 msgid "kill-subprocess"
10743 msgstr ""
10744
10745 #. type: verbatim
10746 #: ../fish/guestfish-actions.pod:2679
10747 #, no-wrap
10748 msgid ""
10749 " kill-subprocess\n"
10750 "\n"
10751 msgstr ""
10752
10753 #. type: textblock
10754 #: ../fish/guestfish-actions.pod:2681 ../src/guestfs-actions.pod:4086
10755 msgid "This kills the qemu subprocess.  You should never need to call this."
10756 msgstr ""
10757
10758 #. type: =head2
10759 #: ../fish/guestfish-actions.pod:2683
10760 msgid "launch"
10761 msgstr ""
10762
10763 #. type: =head2
10764 #: ../fish/guestfish-actions.pod:2685
10765 msgid "run"
10766 msgstr ""
10767
10768 #. type: verbatim
10769 #: ../fish/guestfish-actions.pod:2687
10770 #, no-wrap
10771 msgid ""
10772 " launch\n"
10773 "\n"
10774 msgstr ""
10775
10776 #. type: textblock
10777 #: ../fish/guestfish-actions.pod:2689 ../src/guestfs-actions.pod:4097
10778 msgid ""
10779 "Internally libguestfs is implemented by running a virtual machine using "
10780 "L<qemu(1)>."
10781 msgstr ""
10782
10783 #. type: textblock
10784 #: ../fish/guestfish-actions.pod:2692 ../src/guestfs-actions.pod:4100
10785 msgid ""
10786 "You should call this after configuring the handle (eg. adding drives) but "
10787 "before performing any actions."
10788 msgstr ""
10789
10790 #. type: =head2
10791 #: ../fish/guestfish-actions.pod:2695
10792 msgid "lchown"
10793 msgstr ""
10794
10795 #. type: verbatim
10796 #: ../fish/guestfish-actions.pod:2697
10797 #, no-wrap
10798 msgid ""
10799 " lchown owner group path\n"
10800 "\n"
10801 msgstr ""
10802
10803 #. type: textblock
10804 #: ../fish/guestfish-actions.pod:2699
10805 msgid ""
10806 "Change the file owner to C<owner> and group to C<group>.  This is like "
10807 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
10808 "the target."
10809 msgstr ""
10810
10811 #. type: =head2
10812 #: ../fish/guestfish-actions.pod:2707
10813 msgid "lgetxattr"
10814 msgstr ""
10815
10816 #. type: verbatim
10817 #: ../fish/guestfish-actions.pod:2709
10818 #, no-wrap
10819 msgid ""
10820 " lgetxattr path name\n"
10821 "\n"
10822 msgstr ""
10823
10824 #. type: textblock
10825 #: ../fish/guestfish-actions.pod:2711 ../src/guestfs-actions.pod:4140
10826 msgid ""
10827 "Get a single extended attribute from file C<path> named C<name>.  If C<path> "
10828 "is a symlink, then this call returns an extended attribute from the symlink."
10829 msgstr ""
10830
10831 #. type: textblock
10832 #: ../fish/guestfish-actions.pod:2725
10833 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
10834 msgstr ""
10835
10836 #. type: =head2
10837 #: ../fish/guestfish-actions.pod:2727
10838 msgid "lgetxattrs"
10839 msgstr ""
10840
10841 #. type: verbatim
10842 #: ../fish/guestfish-actions.pod:2729
10843 #, no-wrap
10844 msgid ""
10845 " lgetxattrs path\n"
10846 "\n"
10847 msgstr ""
10848
10849 #. type: textblock
10850 #: ../fish/guestfish-actions.pod:2731
10851 msgid ""
10852 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
10853 "it returns the extended attributes of the link itself."
10854 msgstr ""
10855
10856 #. type: =head2
10857 #: ../fish/guestfish-actions.pod:2735
10858 msgid "list-9p"
10859 msgstr ""
10860
10861 #. type: verbatim
10862 #: ../fish/guestfish-actions.pod:2737
10863 #, no-wrap
10864 msgid ""
10865 " list-9p\n"
10866 "\n"
10867 msgstr ""
10868
10869 #. type: textblock
10870 #: ../fish/guestfish-actions.pod:2739 ../src/guestfs-actions.pod:4183
10871 msgid ""
10872 "List all 9p filesystems attached to the guest.  A list of mount tags is "
10873 "returned."
10874 msgstr ""
10875
10876 #. type: =head2
10877 #: ../fish/guestfish-actions.pod:2742
10878 msgid "list-devices"
10879 msgstr ""
10880
10881 #. type: verbatim
10882 #: ../fish/guestfish-actions.pod:2744
10883 #, no-wrap
10884 msgid ""
10885 " list-devices\n"
10886 "\n"
10887 msgstr ""
10888
10889 #. type: textblock
10890 #: ../fish/guestfish-actions.pod:2746 ../src/guestfs-actions.pod:4197
10891 msgid "List all the block devices."
10892 msgstr ""
10893
10894 #. type: textblock
10895 #: ../fish/guestfish-actions.pod:2748 ../src/guestfs-actions.pod:4199
10896 msgid "The full block device names are returned, eg. C</dev/sda>."
10897 msgstr ""
10898
10899 #. type: =head2
10900 #: ../fish/guestfish-actions.pod:2752
10901 msgid "list-dm-devices"
10902 msgstr ""
10903
10904 #. type: verbatim
10905 #: ../fish/guestfish-actions.pod:2754
10906 #, no-wrap
10907 msgid ""
10908 " list-dm-devices\n"
10909 "\n"
10910 msgstr ""
10911
10912 #. type: textblock
10913 #: ../fish/guestfish-actions.pod:2756 ../src/guestfs-actions.pod:4214
10914 msgid "List all device mapper devices."
10915 msgstr ""
10916
10917 #. type: textblock
10918 #: ../fish/guestfish-actions.pod:2758
10919 msgid ""
10920 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
10921 "previous call to L</luks-open>."
10922 msgstr ""
10923
10924 #. type: textblock
10925 #: ../fish/guestfish-actions.pod:2761
10926 msgid ""
10927 "Device mapper devices which correspond to logical volumes are I<not> "
10928 "returned in this list.  Call L</lvs> if you want to list logical volumes."
10929 msgstr ""
10930
10931 #. type: =head2
10932 #: ../fish/guestfish-actions.pod:2765
10933 msgid "list-filesystems"
10934 msgstr ""
10935
10936 #. type: verbatim
10937 #: ../fish/guestfish-actions.pod:2767
10938 #, no-wrap
10939 msgid ""
10940 " list-filesystems\n"
10941 "\n"
10942 msgstr ""
10943
10944 #. type: textblock
10945 #: ../fish/guestfish-actions.pod:2769 ../src/guestfs-actions.pod:4234
10946 msgid ""
10947 "This inspection command looks for filesystems on partitions, block devices "
10948 "and logical volumes, returning a list of devices containing filesystems and "
10949 "their type."
10950 msgstr ""
10951
10952 #. type: textblock
10953 #: ../fish/guestfish-actions.pod:2773 ../src/guestfs-actions.pod:4238
10954 msgid ""
10955 "The return value is a hash, where the keys are the devices containing "
10956 "filesystems, and the values are the filesystem types.  For example:"
10957 msgstr ""
10958
10959 #. type: verbatim
10960 #: ../fish/guestfish-actions.pod:2777 ../src/guestfs-actions.pod:4242
10961 #, no-wrap
10962 msgid ""
10963 " \"/dev/sda1\" => \"ntfs\"\n"
10964 " \"/dev/sda2\" => \"ext2\"\n"
10965 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
10966 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
10967 "\n"
10968 msgstr ""
10969
10970 #. type: textblock
10971 #: ../fish/guestfish-actions.pod:2782 ../src/guestfs-actions.pod:4247
10972 msgid ""
10973 "The value can have the special value \"unknown\", meaning the content of the "
10974 "device is undetermined or empty.  \"swap\" means a Linux swap partition."
10975 msgstr ""
10976
10977 #. type: textblock
10978 #: ../fish/guestfish-actions.pod:2786
10979 msgid ""
10980 "This command runs other libguestfs commands, which might include L</mount> "
10981 "and L</umount>, and therefore you should use this soon after launch and only "
10982 "when nothing is mounted."
10983 msgstr ""
10984
10985 #. type: textblock
10986 #: ../fish/guestfish-actions.pod:2790
10987 msgid ""
10988 "Not all of the filesystems returned will be mountable.  In particular, swap "
10989 "partitions are returned in the list.  Also this command does not check that "
10990 "each filesystem found is valid and mountable, and some filesystems might be "
10991 "mountable but require special options.  Filesystems may not all belong to a "
10992 "single logical operating system (use L</inspect-os> to look for OSes)."
10993 msgstr ""
10994
10995 #. type: =head2
10996 #: ../fish/guestfish-actions.pod:2798
10997 msgid "list-partitions"
10998 msgstr ""
10999
11000 #. type: verbatim
11001 #: ../fish/guestfish-actions.pod:2800
11002 #, no-wrap
11003 msgid ""
11004 " list-partitions\n"
11005 "\n"
11006 msgstr ""
11007
11008 #. type: textblock
11009 #: ../fish/guestfish-actions.pod:2802 ../src/guestfs-actions.pod:4276
11010 msgid "List all the partitions detected on all block devices."
11011 msgstr ""
11012
11013 #. type: textblock
11014 #: ../fish/guestfish-actions.pod:2804 ../src/guestfs-actions.pod:4278
11015 msgid "The full partition device names are returned, eg. C</dev/sda1>"
11016 msgstr ""
11017
11018 #. type: textblock
11019 #: ../fish/guestfish-actions.pod:2806
11020 msgid ""
11021 "This does not return logical volumes.  For that you will need to call "
11022 "L</lvs>."
11023 msgstr ""
11024
11025 #. type: =head2
11026 #: ../fish/guestfish-actions.pod:2811
11027 msgid "ll"
11028 msgstr ""
11029
11030 #. type: verbatim
11031 #: ../fish/guestfish-actions.pod:2813
11032 #, no-wrap
11033 msgid ""
11034 " ll directory\n"
11035 "\n"
11036 msgstr ""
11037
11038 #. type: textblock
11039 #: ../fish/guestfish-actions.pod:2815 ../src/guestfs-actions.pod:4297
11040 msgid ""
11041 "List the files in C<directory> (relative to the root directory, there is no "
11042 "cwd) in the format of 'ls -la'."
11043 msgstr ""
11044
11045 #. type: textblock
11046 #: ../fish/guestfish-actions.pod:2818 ../src/guestfs-actions.pod:4300
11047 msgid ""
11048 "This command is mostly useful for interactive sessions.  It is I<not> "
11049 "intended that you try to parse the output string."
11050 msgstr ""
11051
11052 #. type: =head2
11053 #: ../fish/guestfish-actions.pod:2821
11054 msgid "ln"
11055 msgstr ""
11056
11057 #. type: verbatim
11058 #: ../fish/guestfish-actions.pod:2823
11059 #, no-wrap
11060 msgid ""
11061 " ln target linkname\n"
11062 "\n"
11063 msgstr ""
11064
11065 #. type: textblock
11066 #: ../fish/guestfish-actions.pod:2825 ../src/guestfs-actions.pod:4315
11067 msgid "This command creates a hard link using the C<ln> command."
11068 msgstr ""
11069
11070 #. type: =head2
11071 #: ../fish/guestfish-actions.pod:2827
11072 msgid "ln-f"
11073 msgstr ""
11074
11075 #. type: verbatim
11076 #: ../fish/guestfish-actions.pod:2829
11077 #, no-wrap
11078 msgid ""
11079 " ln-f target linkname\n"
11080 "\n"
11081 msgstr ""
11082
11083 #. type: textblock
11084 #: ../fish/guestfish-actions.pod:2831 ../src/guestfs-actions.pod:4328
11085 msgid ""
11086 "This command creates a hard link using the C<ln -f> command.  The I<-f> "
11087 "option removes the link (C<linkname>) if it exists already."
11088 msgstr ""
11089
11090 #. type: =head2
11091 #: ../fish/guestfish-actions.pod:2834
11092 msgid "ln-s"
11093 msgstr ""
11094
11095 #. type: verbatim
11096 #: ../fish/guestfish-actions.pod:2836
11097 #, no-wrap
11098 msgid ""
11099 " ln-s target linkname\n"
11100 "\n"
11101 msgstr ""
11102
11103 #. type: textblock
11104 #: ../fish/guestfish-actions.pod:2838 ../src/guestfs-actions.pod:4342
11105 msgid "This command creates a symbolic link using the C<ln -s> command."
11106 msgstr ""
11107
11108 #. type: =head2
11109 #: ../fish/guestfish-actions.pod:2840
11110 msgid "ln-sf"
11111 msgstr ""
11112
11113 #. type: verbatim
11114 #: ../fish/guestfish-actions.pod:2842
11115 #, no-wrap
11116 msgid ""
11117 " ln-sf target linkname\n"
11118 "\n"
11119 msgstr ""
11120
11121 #. type: textblock
11122 #: ../fish/guestfish-actions.pod:2844 ../src/guestfs-actions.pod:4355
11123 msgid ""
11124 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
11125 "option removes the link (C<linkname>) if it exists already."
11126 msgstr ""
11127
11128 #. type: =head2
11129 #: ../fish/guestfish-actions.pod:2847
11130 msgid "lremovexattr"
11131 msgstr ""
11132
11133 #. type: verbatim
11134 #: ../fish/guestfish-actions.pod:2849
11135 #, no-wrap
11136 msgid ""
11137 " lremovexattr xattr path\n"
11138 "\n"
11139 msgstr ""
11140
11141 #. type: textblock
11142 #: ../fish/guestfish-actions.pod:2851
11143 msgid ""
11144 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
11145 "it removes an extended attribute of the link itself."
11146 msgstr ""
11147
11148 #. type: =head2
11149 #: ../fish/guestfish-actions.pod:2855
11150 msgid "ls"
11151 msgstr ""
11152
11153 #. type: verbatim
11154 #: ../fish/guestfish-actions.pod:2857
11155 #, no-wrap
11156 msgid ""
11157 " ls directory\n"
11158 "\n"
11159 msgstr ""
11160
11161 #. type: textblock
11162 #: ../fish/guestfish-actions.pod:2859 ../src/guestfs-actions.pod:4383
11163 msgid ""
11164 "List the files in C<directory> (relative to the root directory, there is no "
11165 "cwd).  The '.' and '..' entries are not returned, but hidden files are "
11166 "shown."
11167 msgstr ""
11168
11169 #. type: textblock
11170 #: ../fish/guestfish-actions.pod:2863
11171 msgid ""
11172 "This command is mostly useful for interactive sessions.  Programs should "
11173 "probably use L</readdir> instead."
11174 msgstr ""
11175
11176 #. type: =head2
11177 #: ../fish/guestfish-actions.pod:2866
11178 msgid "lsetxattr"
11179 msgstr ""
11180
11181 #. type: verbatim
11182 #: ../fish/guestfish-actions.pod:2868
11183 #, no-wrap
11184 msgid ""
11185 " lsetxattr xattr val vallen path\n"
11186 "\n"
11187 msgstr ""
11188
11189 #. type: textblock
11190 #: ../fish/guestfish-actions.pod:2870
11191 msgid ""
11192 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
11193 "sets an extended attribute of the link itself."
11194 msgstr ""
11195
11196 #. type: =head2
11197 #: ../fish/guestfish-actions.pod:2874
11198 msgid "lstat"
11199 msgstr ""
11200
11201 #. type: verbatim
11202 #: ../fish/guestfish-actions.pod:2876
11203 #, no-wrap
11204 msgid ""
11205 " lstat path\n"
11206 "\n"
11207 msgstr ""
11208
11209 #. type: textblock
11210 #: ../fish/guestfish-actions.pod:2878 ../fish/guestfish-actions.pod:4678 ../src/guestfs-actions.pod:4419 ../src/guestfs-actions.pod:7200
11211 msgid "Returns file information for the given C<path>."
11212 msgstr ""
11213
11214 #. type: textblock
11215 #: ../fish/guestfish-actions.pod:2880
11216 msgid ""
11217 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
11218 "the link is stat-ed, not the file it refers to."
11219 msgstr ""
11220
11221 #. type: textblock
11222 #: ../fish/guestfish-actions.pod:2884 ../src/guestfs-actions.pod:4425
11223 msgid "This is the same as the C<lstat(2)> system call."
11224 msgstr ""
11225
11226 #. type: =head2
11227 #: ../fish/guestfish-actions.pod:2886
11228 msgid "lstatlist"
11229 msgstr ""
11230
11231 #. type: verbatim
11232 #: ../fish/guestfish-actions.pod:2888
11233 #, no-wrap
11234 msgid ""
11235 " lstatlist path 'names ...'\n"
11236 "\n"
11237 msgstr ""
11238
11239 #. type: textblock
11240 #: ../fish/guestfish-actions.pod:2890
11241 msgid ""
11242 "This call allows you to perform the L</lstat> operation on multiple files, "
11243 "where all files are in the directory C<path>.  C<names> is the list of files "
11244 "from this directory."
11245 msgstr ""
11246
11247 #. type: textblock
11248 #: ../fish/guestfish-actions.pod:2894 ../src/guestfs-actions.pod:4444
11249 msgid ""
11250 "On return you get a list of stat structs, with a one-to-one correspondence "
11251 "to the C<names> list.  If any name did not exist or could not be lstat'd, "
11252 "then the C<ino> field of that structure is set to C<-1>."
11253 msgstr ""
11254
11255 #. type: textblock
11256 #: ../fish/guestfish-actions.pod:2899
11257 msgid ""
11258 "This call is intended for programs that want to efficiently list a directory "
11259 "contents without making many round-trips.  See also L</lxattrlist> for a "
11260 "similarly efficient call for getting extended attributes.  Very long "
11261 "directory listings might cause the protocol message size to be exceeded, "
11262 "causing this call to fail.  The caller must split up such requests into "
11263 "smaller groups of names."
11264 msgstr ""
11265
11266 #. type: =head2
11267 #: ../fish/guestfish-actions.pod:2907
11268 msgid "luks-add-key"
11269 msgstr ""
11270
11271 #. type: verbatim
11272 #: ../fish/guestfish-actions.pod:2909
11273 #, no-wrap
11274 msgid ""
11275 " luks-add-key device keyslot\n"
11276 "\n"
11277 msgstr ""
11278
11279 #. type: textblock
11280 #: ../fish/guestfish-actions.pod:2911 ../src/guestfs-actions.pod:4472
11281 msgid ""
11282 "This command adds a new key on LUKS device C<device>.  C<key> is any "
11283 "existing key, and is used to access the device.  C<newkey> is the new key to "
11284 "add.  C<keyslot> is the key slot that will be replaced."
11285 msgstr ""
11286
11287 #. type: textblock
11288 #: ../fish/guestfish-actions.pod:2916
11289 msgid ""
11290 "Note that if C<keyslot> already contains a key, then this command will "
11291 "fail.  You have to use L</luks-kill-slot> first to remove that key."
11292 msgstr ""
11293
11294 #. type: textblock
11295 #: ../fish/guestfish-actions.pod:2920 ../fish/guestfish-actions.pod:2942 ../fish/guestfish-actions.pod:2952 ../fish/guestfish-actions.pod:2963 ../fish/guestfish-actions.pod:2989 ../fish/guestfish-actions.pod:2999
11296 msgid ""
11297 "This command has one or more key or passphrase parameters.  Guestfish will "
11298 "prompt for these separately."
11299 msgstr ""
11300
11301 #. type: =head2
11302 #: ../fish/guestfish-actions.pod:2923
11303 msgid "luks-close"
11304 msgstr ""
11305
11306 #. type: verbatim
11307 #: ../fish/guestfish-actions.pod:2925
11308 #, no-wrap
11309 msgid ""
11310 " luks-close device\n"
11311 "\n"
11312 msgstr ""
11313
11314 #. type: textblock
11315 #: ../fish/guestfish-actions.pod:2927
11316 msgid ""
11317 "This closes a LUKS device that was created earlier by L</luks-open> or "
11318 "L</luks-open-ro>.  The C<device> parameter must be the name of the LUKS "
11319 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
11320 "underlying block device."
11321 msgstr ""
11322
11323 #. type: =head2
11324 #: ../fish/guestfish-actions.pod:2933
11325 msgid "luks-format"
11326 msgstr ""
11327
11328 #. type: verbatim
11329 #: ../fish/guestfish-actions.pod:2935
11330 #, no-wrap
11331 msgid ""
11332 " luks-format device keyslot\n"
11333 "\n"
11334 msgstr ""
11335
11336 #. type: textblock
11337 #: ../fish/guestfish-actions.pod:2937 ../src/guestfs-actions.pod:4513
11338 msgid ""
11339 "This command erases existing data on C<device> and formats the device as a "
11340 "LUKS encrypted device.  C<key> is the initial key, which is added to key "
11341 "slot C<slot>.  (LUKS supports 8 key slots, numbered 0-7)."
11342 msgstr ""
11343
11344 #. type: =head2
11345 #: ../fish/guestfish-actions.pod:2945
11346 msgid "luks-format-cipher"
11347 msgstr ""
11348
11349 #. type: verbatim
11350 #: ../fish/guestfish-actions.pod:2947
11351 #, no-wrap
11352 msgid ""
11353 " luks-format-cipher device keyslot cipher\n"
11354 "\n"
11355 msgstr ""
11356
11357 #. type: textblock
11358 #: ../fish/guestfish-actions.pod:2949
11359 msgid ""
11360 "This command is the same as L</luks-format> but it also allows you to set "
11361 "the C<cipher> used."
11362 msgstr ""
11363
11364 #. type: =head2
11365 #: ../fish/guestfish-actions.pod:2955
11366 msgid "luks-kill-slot"
11367 msgstr ""
11368
11369 #. type: verbatim
11370 #: ../fish/guestfish-actions.pod:2957
11371 #, no-wrap
11372 msgid ""
11373 " luks-kill-slot device keyslot\n"
11374 "\n"
11375 msgstr ""
11376
11377 #. type: textblock
11378 #: ../fish/guestfish-actions.pod:2959 ../src/guestfs-actions.pod:4554
11379 msgid ""
11380 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
11381 "device C<device>.  C<key> must be one of the I<other> keys."
11382 msgstr ""
11383
11384 #. type: =head2
11385 #: ../fish/guestfish-actions.pod:2966
11386 msgid "luks-open"
11387 msgstr ""
11388
11389 #. type: verbatim
11390 #: ../fish/guestfish-actions.pod:2968
11391 #, no-wrap
11392 msgid ""
11393 " luks-open device mapname\n"
11394 "\n"
11395 msgstr ""
11396
11397 #. type: textblock
11398 #: ../fish/guestfish-actions.pod:2970 ../src/guestfs-actions.pod:4574
11399 msgid ""
11400 "This command opens a block device which has been encrypted according to the "
11401 "Linux Unified Key Setup (LUKS) standard."
11402 msgstr ""
11403
11404 #. type: textblock
11405 #: ../fish/guestfish-actions.pod:2973 ../src/guestfs-actions.pod:4577
11406 msgid "C<device> is the encrypted block device or partition."
11407 msgstr ""
11408
11409 #. type: textblock
11410 #: ../fish/guestfish-actions.pod:2975 ../src/guestfs-actions.pod:4579
11411 msgid ""
11412 "The caller must supply one of the keys associated with the LUKS block "
11413 "device, in the C<key> parameter."
11414 msgstr ""
11415
11416 #. type: textblock
11417 #: ../fish/guestfish-actions.pod:2978 ../src/guestfs-actions.pod:4582
11418 msgid ""
11419 "This creates a new block device called C</dev/mapper/mapname>.  Reads and "
11420 "writes to this block device are decrypted from and encrypted to the "
11421 "underlying C<device> respectively."
11422 msgstr ""
11423
11424 #. type: textblock
11425 #: ../fish/guestfish-actions.pod:2982
11426 msgid ""
11427 "If this block device contains LVM volume groups, then calling L</vgscan> "
11428 "followed by L</vg-activate-all> will make them visible."
11429 msgstr ""
11430
11431 #. type: textblock
11432 #: ../fish/guestfish-actions.pod:2986
11433 msgid "Use L</list-dm-devices> to list all device mapper devices."
11434 msgstr ""
11435
11436 #. type: =head2
11437 #: ../fish/guestfish-actions.pod:2992
11438 msgid "luks-open-ro"
11439 msgstr ""
11440
11441 #. type: verbatim
11442 #: ../fish/guestfish-actions.pod:2994
11443 #, no-wrap
11444 msgid ""
11445 " luks-open-ro device mapname\n"
11446 "\n"
11447 msgstr ""
11448
11449 #. type: textblock
11450 #: ../fish/guestfish-actions.pod:2996
11451 msgid ""
11452 "This is the same as L</luks-open> except that a read-only mapping is "
11453 "created."
11454 msgstr ""
11455
11456 #. type: =head2
11457 #: ../fish/guestfish-actions.pod:3002
11458 msgid "lvcreate"
11459 msgstr ""
11460
11461 #. type: verbatim
11462 #: ../fish/guestfish-actions.pod:3004
11463 #, no-wrap
11464 msgid ""
11465 " lvcreate logvol volgroup mbytes\n"
11466 "\n"
11467 msgstr ""
11468
11469 #. type: textblock
11470 #: ../fish/guestfish-actions.pod:3006 ../src/guestfs-actions.pod:4628
11471 msgid ""
11472 "This creates an LVM logical volume called C<logvol> on the volume group "
11473 "C<volgroup>, with C<size> megabytes."
11474 msgstr ""
11475
11476 #. type: =head2
11477 #: ../fish/guestfish-actions.pod:3009
11478 msgid "lvm-canonical-lv-name"
11479 msgstr ""
11480
11481 #. type: verbatim
11482 #: ../fish/guestfish-actions.pod:3011
11483 #, no-wrap
11484 msgid ""
11485 " lvm-canonical-lv-name lvname\n"
11486 "\n"
11487 msgstr ""
11488
11489 #. type: textblock
11490 #: ../fish/guestfish-actions.pod:3013 ../src/guestfs-actions.pod:4641
11491 msgid ""
11492 "This converts alternative naming schemes for LVs that you might find to the "
11493 "canonical name.  For example, C</dev/mapper/VG-LV> is converted to "
11494 "C</dev/VG/LV>."
11495 msgstr ""
11496
11497 #. type: textblock
11498 #: ../fish/guestfish-actions.pod:3017 ../src/guestfs-actions.pod:4645
11499 msgid ""
11500 "This command returns an error if the C<lvname> parameter does not refer to a "
11501 "logical volume."
11502 msgstr ""
11503
11504 #. type: textblock
11505 #: ../fish/guestfish-actions.pod:3020
11506 msgid "See also L</is-lv>."
11507 msgstr ""
11508
11509 #. type: =head2
11510 #: ../fish/guestfish-actions.pod:3022
11511 msgid "lvm-clear-filter"
11512 msgstr ""
11513
11514 #. type: verbatim
11515 #: ../fish/guestfish-actions.pod:3024
11516 #, no-wrap
11517 msgid ""
11518 " lvm-clear-filter\n"
11519 "\n"
11520 msgstr ""
11521
11522 #. type: textblock
11523 #: ../fish/guestfish-actions.pod:3026
11524 msgid ""
11525 "This undoes the effect of L</lvm-set-filter>.  LVM will be able to see every "
11526 "block device."
11527 msgstr ""
11528
11529 #. type: textblock
11530 #: ../fish/guestfish-actions.pod:3029 ../fish/guestfish-actions.pod:3057 ../src/guestfs-actions.pod:4663 ../src/guestfs-actions.pod:4702
11531 msgid "This command also clears the LVM cache and performs a volume group scan."
11532 msgstr ""
11533
11534 #. type: =head2
11535 #: ../fish/guestfish-actions.pod:3032
11536 msgid "lvm-remove-all"
11537 msgstr ""
11538
11539 #. type: verbatim
11540 #: ../fish/guestfish-actions.pod:3034
11541 #, no-wrap
11542 msgid ""
11543 " lvm-remove-all\n"
11544 "\n"
11545 msgstr ""
11546
11547 #. type: textblock
11548 #: ../fish/guestfish-actions.pod:3036 ../src/guestfs-actions.pod:4675
11549 msgid ""
11550 "This command removes all LVM logical volumes, volume groups and physical "
11551 "volumes."
11552 msgstr ""
11553
11554 #. type: =head2
11555 #: ../fish/guestfish-actions.pod:3039
11556 msgid "lvm-set-filter"
11557 msgstr ""
11558
11559 #. type: verbatim
11560 #: ../fish/guestfish-actions.pod:3041
11561 #, no-wrap
11562 msgid ""
11563 " lvm-set-filter 'devices ...'\n"
11564 "\n"
11565 msgstr ""
11566
11567 #. type: textblock
11568 #: ../fish/guestfish-actions.pod:3043 ../src/guestfs-actions.pod:4688
11569 msgid ""
11570 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
11571 "block devices in the list C<devices>, and will ignore all other attached "
11572 "block devices."
11573 msgstr ""
11574
11575 #. type: textblock
11576 #: ../fish/guestfish-actions.pod:3047 ../src/guestfs-actions.pod:4692
11577 msgid ""
11578 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
11579 "get LVM to ignore the duplicates, otherwise LVM can get confused.  Note also "
11580 "there are two types of duplication possible: either cloned PVs/VGs which "
11581 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
11582 "same name.  In normal operation you cannot create this situation, but you "
11583 "can do it outside LVM, eg.  by cloning disk images or by bit twiddling "
11584 "inside the LVM metadata."
11585 msgstr ""
11586
11587 #. type: textblock
11588 #: ../fish/guestfish-actions.pod:3060 ../src/guestfs-actions.pod:4705
11589 msgid "You can filter whole block devices or individual partitions."
11590 msgstr ""
11591
11592 #. type: textblock
11593 #: ../fish/guestfish-actions.pod:3062 ../src/guestfs-actions.pod:4707
11594 msgid ""
11595 "You cannot use this if any VG is currently in use (eg.  contains a mounted "
11596 "filesystem), even if you are not filtering out that VG."
11597 msgstr ""
11598
11599 #. type: =head2
11600 #: ../fish/guestfish-actions.pod:3066
11601 msgid "lvremove"
11602 msgstr ""
11603
11604 #. type: verbatim
11605 #: ../fish/guestfish-actions.pod:3068
11606 #, no-wrap
11607 msgid ""
11608 " lvremove device\n"
11609 "\n"
11610 msgstr ""
11611
11612 #. type: textblock
11613 #: ../fish/guestfish-actions.pod:3070 ../src/guestfs-actions.pod:4721
11614 msgid ""
11615 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
11616 "LV, such as C</dev/VG/LV>."
11617 msgstr ""
11618
11619 #. type: textblock
11620 #: ../fish/guestfish-actions.pod:3073 ../src/guestfs-actions.pod:4724
11621 msgid ""
11622 "You can also remove all LVs in a volume group by specifying the VG name, "
11623 "C</dev/VG>."
11624 msgstr ""
11625
11626 #. type: =head2
11627 #: ../fish/guestfish-actions.pod:3076
11628 msgid "lvrename"
11629 msgstr ""
11630
11631 #. type: verbatim
11632 #: ../fish/guestfish-actions.pod:3078
11633 #, no-wrap
11634 msgid ""
11635 " lvrename logvol newlogvol\n"
11636 "\n"
11637 msgstr ""
11638
11639 #. type: textblock
11640 #: ../fish/guestfish-actions.pod:3080 ../src/guestfs-actions.pod:4738
11641 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
11642 msgstr ""
11643
11644 #. type: =head2
11645 #: ../fish/guestfish-actions.pod:3082
11646 msgid "lvresize"
11647 msgstr ""
11648
11649 #. type: verbatim
11650 #: ../fish/guestfish-actions.pod:3084
11651 #, no-wrap
11652 msgid ""
11653 " lvresize device mbytes\n"
11654 "\n"
11655 msgstr ""
11656
11657 #. type: textblock
11658 #: ../fish/guestfish-actions.pod:3086 ../src/guestfs-actions.pod:4751
11659 msgid ""
11660 "This resizes (expands or shrinks) an existing LVM logical volume to "
11661 "C<mbytes>.  When reducing, data in the reduced part is lost."
11662 msgstr ""
11663
11664 #. type: =head2
11665 #: ../fish/guestfish-actions.pod:3090
11666 msgid "lvresize-free"
11667 msgstr ""
11668
11669 #. type: verbatim
11670 #: ../fish/guestfish-actions.pod:3092
11671 #, no-wrap
11672 msgid ""
11673 " lvresize-free lv percent\n"
11674 "\n"
11675 msgstr ""
11676
11677 #. type: textblock
11678 #: ../fish/guestfish-actions.pod:3094 ../src/guestfs-actions.pod:4766
11679 msgid ""
11680 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
11681 "remaining free space in the volume group.  Commonly you would call this with "
11682 "pc = 100 which expands the logical volume as much as possible, using all "
11683 "remaining free space in the volume group."
11684 msgstr ""
11685
11686 #. type: =head2
11687 #: ../fish/guestfish-actions.pod:3100
11688 msgid "lvs"
11689 msgstr ""
11690
11691 #. type: verbatim
11692 #: ../fish/guestfish-actions.pod:3102
11693 #, no-wrap
11694 msgid ""
11695 " lvs\n"
11696 "\n"
11697 msgstr ""
11698
11699 #. type: textblock
11700 #: ../fish/guestfish-actions.pod:3104 ../src/guestfs-actions.pod:4781
11701 msgid ""
11702 "List all the logical volumes detected.  This is the equivalent of the "
11703 "L<lvs(8)> command."
11704 msgstr ""
11705
11706 #. type: textblock
11707 #: ../fish/guestfish-actions.pod:3107 ../src/guestfs-actions.pod:4784
11708 msgid ""
11709 "This returns a list of the logical volume device names "
11710 "(eg. C</dev/VolGroup00/LogVol00>)."
11711 msgstr ""
11712
11713 #. type: textblock
11714 #: ../fish/guestfish-actions.pod:3110
11715 msgid "See also L</lvs-full>, L</list-filesystems>."
11716 msgstr ""
11717
11718 #. type: =head2
11719 #: ../fish/guestfish-actions.pod:3112
11720 msgid "lvs-full"
11721 msgstr ""
11722
11723 #. type: verbatim
11724 #: ../fish/guestfish-actions.pod:3114
11725 #, no-wrap
11726 msgid ""
11727 " lvs-full\n"
11728 "\n"
11729 msgstr ""
11730
11731 #. type: textblock
11732 #: ../fish/guestfish-actions.pod:3116 ../src/guestfs-actions.pod:4800
11733 msgid ""
11734 "List all the logical volumes detected.  This is the equivalent of the "
11735 "L<lvs(8)> command.  The \"full\" version includes all fields."
11736 msgstr ""
11737
11738 #. type: =head2
11739 #: ../fish/guestfish-actions.pod:3119
11740 msgid "lvuuid"
11741 msgstr ""
11742
11743 #. type: verbatim
11744 #: ../fish/guestfish-actions.pod:3121
11745 #, no-wrap
11746 msgid ""
11747 " lvuuid device\n"
11748 "\n"
11749 msgstr ""
11750
11751 #. type: textblock
11752 #: ../fish/guestfish-actions.pod:3123 ../src/guestfs-actions.pod:4815
11753 msgid "This command returns the UUID of the LVM LV C<device>."
11754 msgstr ""
11755
11756 #. type: =head2
11757 #: ../fish/guestfish-actions.pod:3125
11758 msgid "lxattrlist"
11759 msgstr ""
11760
11761 #. type: verbatim
11762 #: ../fish/guestfish-actions.pod:3127
11763 #, no-wrap
11764 msgid ""
11765 " lxattrlist path 'names ...'\n"
11766 "\n"
11767 msgstr ""
11768
11769 #. type: textblock
11770 #: ../fish/guestfish-actions.pod:3129 ../src/guestfs-actions.pod:4829
11771 msgid ""
11772 "This call allows you to get the extended attributes of multiple files, where "
11773 "all files are in the directory C<path>.  C<names> is the list of files from "
11774 "this directory."
11775 msgstr ""
11776
11777 #. type: textblock
11778 #: ../fish/guestfish-actions.pod:3133 ../src/guestfs-actions.pod:4833
11779 msgid ""
11780 "On return you get a flat list of xattr structs which must be interpreted "
11781 "sequentially.  The first xattr struct always has a zero-length C<attrname>.  "
11782 "C<attrval> in this struct is zero-length to indicate there was an error "
11783 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
11784 "number (the number of following attributes for this file, which could be "
11785 "C<\"0\">).  Then after the first xattr struct are the zero or more "
11786 "attributes for the first named file.  This repeats for the second and "
11787 "subsequent files."
11788 msgstr ""
11789
11790 #. type: textblock
11791 #: ../fish/guestfish-actions.pod:3143
11792 msgid ""
11793 "This call is intended for programs that want to efficiently list a directory "
11794 "contents without making many round-trips.  See also L</lstatlist> for a "
11795 "similarly efficient call for getting standard stats.  Very long directory "
11796 "listings might cause the protocol message size to be exceeded, causing this "
11797 "call to fail.  The caller must split up such requests into smaller groups of "
11798 "names."
11799 msgstr ""
11800
11801 #. type: =head2
11802 #: ../fish/guestfish-actions.pod:3151
11803 msgid "mkdir"
11804 msgstr ""
11805
11806 #. type: verbatim
11807 #: ../fish/guestfish-actions.pod:3153
11808 #, no-wrap
11809 msgid ""
11810 " mkdir path\n"
11811 "\n"
11812 msgstr ""
11813
11814 #. type: textblock
11815 #: ../fish/guestfish-actions.pod:3155 ../src/guestfs-actions.pod:4863
11816 msgid "Create a directory named C<path>."
11817 msgstr ""
11818
11819 #. type: =head2
11820 #: ../fish/guestfish-actions.pod:3157
11821 msgid "mkdir-mode"
11822 msgstr ""
11823
11824 #. type: verbatim
11825 #: ../fish/guestfish-actions.pod:3159
11826 #, no-wrap
11827 msgid ""
11828 " mkdir-mode path mode\n"
11829 "\n"
11830 msgstr ""
11831
11832 #. type: textblock
11833 #: ../fish/guestfish-actions.pod:3161 ../src/guestfs-actions.pod:4876
11834 msgid ""
11835 "This command creates a directory, setting the initial permissions of the "
11836 "directory to C<mode>."
11837 msgstr ""
11838
11839 #. type: textblock
11840 #: ../fish/guestfish-actions.pod:3164 ../src/guestfs-actions.pod:4879
11841 msgid ""
11842 "For common Linux filesystems, the actual mode which is set will be C<mode & "
11843 "~umask & 01777>.  Non-native-Linux filesystems may interpret the mode in "
11844 "other ways."
11845 msgstr ""
11846
11847 #. type: textblock
11848 #: ../fish/guestfish-actions.pod:3168
11849 msgid "See also L</mkdir>, L</umask>"
11850 msgstr ""
11851
11852 #. type: =head2
11853 #: ../fish/guestfish-actions.pod:3170
11854 msgid "mkdir-p"
11855 msgstr ""
11856
11857 #. type: verbatim
11858 #: ../fish/guestfish-actions.pod:3172
11859 #, no-wrap
11860 msgid ""
11861 " mkdir-p path\n"
11862 "\n"
11863 msgstr ""
11864
11865 #. type: textblock
11866 #: ../fish/guestfish-actions.pod:3174 ../src/guestfs-actions.pod:4895
11867 msgid ""
11868 "Create a directory named C<path>, creating any parent directories as "
11869 "necessary.  This is like the C<mkdir -p> shell command."
11870 msgstr ""
11871
11872 #. type: =head2
11873 #: ../fish/guestfish-actions.pod:3177
11874 msgid "mkdtemp"
11875 msgstr ""
11876
11877 #. type: verbatim
11878 #: ../fish/guestfish-actions.pod:3179
11879 #, no-wrap
11880 msgid ""
11881 " mkdtemp template\n"
11882 "\n"
11883 msgstr ""
11884
11885 #. type: textblock
11886 #: ../fish/guestfish-actions.pod:3181 ../src/guestfs-actions.pod:4908
11887 msgid ""
11888 "This command creates a temporary directory.  The C<template> parameter "
11889 "should be a full pathname for the temporary directory name with the final "
11890 "six characters being \"XXXXXX\"."
11891 msgstr ""
11892
11893 #. type: textblock
11894 #: ../fish/guestfish-actions.pod:3186 ../src/guestfs-actions.pod:4913
11895 msgid ""
11896 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
11897 "being suitable for Windows filesystems."
11898 msgstr ""
11899
11900 #. type: textblock
11901 #: ../fish/guestfish-actions.pod:3189 ../src/guestfs-actions.pod:4916
11902 msgid "The name of the temporary directory that was created is returned."
11903 msgstr ""
11904
11905 #. type: textblock
11906 #: ../fish/guestfish-actions.pod:3192 ../src/guestfs-actions.pod:4919
11907 msgid "The temporary directory is created with mode 0700 and is owned by root."
11908 msgstr ""
11909
11910 #. type: textblock
11911 #: ../fish/guestfish-actions.pod:3195 ../src/guestfs-actions.pod:4922
11912 msgid ""
11913 "The caller is responsible for deleting the temporary directory and its "
11914 "contents after use."
11915 msgstr ""
11916
11917 #. type: textblock
11918 #: ../fish/guestfish-actions.pod:3198 ../src/guestfs-actions.pod:4925
11919 msgid "See also: L<mkdtemp(3)>"
11920 msgstr ""
11921
11922 #. type: =head2
11923 #: ../fish/guestfish-actions.pod:3200
11924 msgid "mke2fs-J"
11925 msgstr ""
11926
11927 #. type: verbatim
11928 #: ../fish/guestfish-actions.pod:3202
11929 #, no-wrap
11930 msgid ""
11931 " mke2fs-J fstype blocksize device journal\n"
11932 "\n"
11933 msgstr ""
11934
11935 #. type: textblock
11936 #: ../fish/guestfish-actions.pod:3204 ../src/guestfs-actions.pod:4941
11937 msgid ""
11938 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11939 "C<journal>.  It is equivalent to the command:"
11940 msgstr ""
11941
11942 #. type: verbatim
11943 #: ../fish/guestfish-actions.pod:3208 ../src/guestfs-actions.pod:4945
11944 #, no-wrap
11945 msgid ""
11946 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
11947 "\n"
11948 msgstr ""
11949
11950 #. type: textblock
11951 #: ../fish/guestfish-actions.pod:3210
11952 msgid "See also L</mke2journal>."
11953 msgstr ""
11954
11955 #. type: =head2
11956 #: ../fish/guestfish-actions.pod:3212
11957 msgid "mke2fs-JL"
11958 msgstr ""
11959
11960 #. type: verbatim
11961 #: ../fish/guestfish-actions.pod:3214
11962 #, no-wrap
11963 msgid ""
11964 " mke2fs-JL fstype blocksize device label\n"
11965 "\n"
11966 msgstr ""
11967
11968 #. type: textblock
11969 #: ../fish/guestfish-actions.pod:3216 ../src/guestfs-actions.pod:4962
11970 msgid ""
11971 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11972 "the journal labeled C<label>."
11973 msgstr ""
11974
11975 #. type: textblock
11976 #: ../fish/guestfish-actions.pod:3219
11977 msgid "See also L</mke2journal-L>."
11978 msgstr ""
11979
11980 #. type: =head2
11981 #: ../fish/guestfish-actions.pod:3221
11982 msgid "mke2fs-JU"
11983 msgstr ""
11984
11985 #. type: verbatim
11986 #: ../fish/guestfish-actions.pod:3223
11987 #, no-wrap
11988 msgid ""
11989 " mke2fs-JU fstype blocksize device uuid\n"
11990 "\n"
11991 msgstr ""
11992
11993 #. type: textblock
11994 #: ../fish/guestfish-actions.pod:3225 ../src/guestfs-actions.pod:4980
11995 msgid ""
11996 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11997 "the journal with UUID C<uuid>."
11998 msgstr ""
11999
12000 #. type: textblock
12001 #: ../fish/guestfish-actions.pod:3228
12002 msgid "See also L</mke2journal-U>."
12003 msgstr ""
12004
12005 #. type: =head2
12006 #: ../fish/guestfish-actions.pod:3230
12007 msgid "mke2journal"
12008 msgstr ""
12009
12010 #. type: verbatim
12011 #: ../fish/guestfish-actions.pod:3232
12012 #, no-wrap
12013 msgid ""
12014 " mke2journal blocksize device\n"
12015 "\n"
12016 msgstr ""
12017
12018 #. type: textblock
12019 #: ../fish/guestfish-actions.pod:3234 ../src/guestfs-actions.pod:4996
12020 msgid ""
12021 "This creates an ext2 external journal on C<device>.  It is equivalent to the "
12022 "command:"
12023 msgstr ""
12024
12025 #. type: verbatim
12026 #: ../fish/guestfish-actions.pod:3237 ../src/guestfs-actions.pod:4999
12027 #, no-wrap
12028 msgid ""
12029 " mke2fs -O journal_dev -b blocksize device\n"
12030 "\n"
12031 msgstr ""
12032
12033 #. type: =head2
12034 #: ../fish/guestfish-actions.pod:3239
12035 msgid "mke2journal-L"
12036 msgstr ""
12037
12038 #. type: verbatim
12039 #: ../fish/guestfish-actions.pod:3241
12040 #, no-wrap
12041 msgid ""
12042 " mke2journal-L blocksize label device\n"
12043 "\n"
12044 msgstr ""
12045
12046 #. type: textblock
12047 #: ../fish/guestfish-actions.pod:3243 ../src/guestfs-actions.pod:5013
12048 msgid "This creates an ext2 external journal on C<device> with label C<label>."
12049 msgstr ""
12050
12051 #. type: =head2
12052 #: ../fish/guestfish-actions.pod:3245
12053 msgid "mke2journal-U"
12054 msgstr ""
12055
12056 #. type: verbatim
12057 #: ../fish/guestfish-actions.pod:3247
12058 #, no-wrap
12059 msgid ""
12060 " mke2journal-U blocksize uuid device\n"
12061 "\n"
12062 msgstr ""
12063
12064 #. type: textblock
12065 #: ../fish/guestfish-actions.pod:3249 ../src/guestfs-actions.pod:5027
12066 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
12067 msgstr ""
12068
12069 #. type: =head2
12070 #: ../fish/guestfish-actions.pod:3251
12071 msgid "mkfifo"
12072 msgstr ""
12073
12074 #. type: verbatim
12075 #: ../fish/guestfish-actions.pod:3253
12076 #, no-wrap
12077 msgid ""
12078 " mkfifo mode path\n"
12079 "\n"
12080 msgstr ""
12081
12082 #. type: textblock
12083 #: ../fish/guestfish-actions.pod:3255
12084 msgid ""
12085 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>.  It "
12086 "is just a convenient wrapper around L</mknod>."
12087 msgstr ""
12088
12089 #. type: =head2
12090 #: ../fish/guestfish-actions.pod:3261
12091 msgid "mkfs"
12092 msgstr ""
12093
12094 #. type: verbatim
12095 #: ../fish/guestfish-actions.pod:3263
12096 #, no-wrap
12097 msgid ""
12098 " mkfs fstype device\n"
12099 "\n"
12100 msgstr ""
12101
12102 #. type: textblock
12103 #: ../fish/guestfish-actions.pod:3265 ../src/guestfs-actions.pod:5057
12104 msgid ""
12105 "This creates a filesystem on C<device> (usually a partition or LVM logical "
12106 "volume).  The filesystem type is C<fstype>, for example C<ext3>."
12107 msgstr ""
12108
12109 #. type: =head2
12110 #: ../fish/guestfish-actions.pod:3269
12111 msgid "mkfs-b"
12112 msgstr ""
12113
12114 #. type: verbatim
12115 #: ../fish/guestfish-actions.pod:3271
12116 #, no-wrap
12117 msgid ""
12118 " mkfs-b fstype blocksize device\n"
12119 "\n"
12120 msgstr ""
12121
12122 #. type: textblock
12123 #: ../fish/guestfish-actions.pod:3273
12124 msgid ""
12125 "This call is similar to L</mkfs>, but it allows you to control the block "
12126 "size of the resulting filesystem.  Supported block sizes depend on the "
12127 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
12128 msgstr ""
12129
12130 #. type: textblock
12131 #: ../fish/guestfish-actions.pod:3278 ../fish/guestfish-actions.pod:3305 ../src/guestfs-actions.pod:5085 ../src/guestfs-actions.pod:5123
12132 msgid ""
12133 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
12134 "cluster size."
12135 msgstr ""
12136
12137 #. type: textblock
12138 #: ../fish/guestfish-actions.pod:3281
12139 msgid ""
12140 "I<This function is deprecated.> In new code, use the L</mkfs_opts> call "
12141 "instead."
12142 msgstr ""
12143
12144 #. type: =head2
12145 #: ../fish/guestfish-actions.pod:3288
12146 msgid "mkfs-opts"
12147 msgstr ""
12148
12149 #. type: verbatim
12150 #: ../fish/guestfish-actions.pod:3290
12151 #, no-wrap
12152 msgid ""
12153 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] "
12154 "[sectorsize:..]\n"
12155 "\n"
12156 msgstr ""
12157
12158 #. type: textblock
12159 #: ../fish/guestfish-actions.pod:3292 ../src/guestfs-actions.pod:5110
12160 msgid ""
12161 "This function creates a filesystem on C<device>.  The filesystem type is "
12162 "C<fstype>, for example C<ext3>."
12163 msgstr ""
12164
12165 #. type: =item
12166 #: ../fish/guestfish-actions.pod:3299 ../src/guestfs-actions.pod:5117
12167 msgid "C<blocksize>"
12168 msgstr ""
12169
12170 #. type: textblock
12171 #: ../fish/guestfish-actions.pod:3301 ../src/guestfs-actions.pod:5119
12172 msgid ""
12173 "The filesystem block size.  Supported block sizes depend on the filesystem "
12174 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
12175 "filesystems."
12176 msgstr ""
12177
12178 #. type: textblock
12179 #: ../fish/guestfish-actions.pod:3308 ../src/guestfs-actions.pod:5126
12180 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
12181 msgstr ""
12182
12183 #. type: =item
12184 #: ../fish/guestfish-actions.pod:3310 ../src/guestfs-actions.pod:5128
12185 msgid "C<features>"
12186 msgstr ""
12187
12188 #. type: textblock
12189 #: ../fish/guestfish-actions.pod:3312 ../src/guestfs-actions.pod:5130
12190 msgid "This passes the I<-O> parameter to the external mkfs program."
12191 msgstr ""
12192
12193 #. type: textblock
12194 #: ../fish/guestfish-actions.pod:3314 ../src/guestfs-actions.pod:5132
12195 msgid ""
12196 "For certain filesystem types, this allows extra filesystem features to be "
12197 "selected.  See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
12198 msgstr ""
12199
12200 #. type: textblock
12201 #: ../fish/guestfish-actions.pod:3318 ../src/guestfs-actions.pod:5136
12202 msgid ""
12203 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
12204 "type."
12205 msgstr ""
12206
12207 #. type: =item
12208 #: ../fish/guestfish-actions.pod:3321 ../src/guestfs-actions.pod:5139
12209 msgid "C<inode>"
12210 msgstr ""
12211
12212 #. type: textblock
12213 #: ../fish/guestfish-actions.pod:3323 ../src/guestfs-actions.pod:5141
12214 msgid ""
12215 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
12216 "sets the inode size (only for ext2/3/4 filesystems at present)."
12217 msgstr ""
12218
12219 #. type: =item
12220 #: ../fish/guestfish-actions.pod:3326 ../src/guestfs-actions.pod:5144
12221 msgid "C<sectorsize>"
12222 msgstr ""
12223
12224 #. type: textblock
12225 #: ../fish/guestfish-actions.pod:3328 ../src/guestfs-actions.pod:5146
12226 msgid ""
12227 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
12228 "sets sector size for ufs filesystem."
12229 msgstr ""
12230
12231 #. type: =head2
12232 #: ../fish/guestfish-actions.pod:3335
12233 msgid "mkmountpoint"
12234 msgstr ""
12235
12236 #. type: verbatim
12237 #: ../fish/guestfish-actions.pod:3337
12238 #, no-wrap
12239 msgid ""
12240 " mkmountpoint exemptpath\n"
12241 "\n"
12242 msgstr ""
12243
12244 #. type: textblock
12245 #: ../fish/guestfish-actions.pod:3339
12246 msgid ""
12247 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
12248 "to create extra mountpoints before mounting the first filesystem."
12249 msgstr ""
12250
12251 #. type: textblock
12252 #: ../fish/guestfish-actions.pod:3343 ../src/guestfs-actions.pod:5189
12253 msgid ""
12254 "These calls are I<only> necessary in some very limited circumstances, mainly "
12255 "the case where you want to mount a mix of unrelated and/or read-only "
12256 "filesystems together."
12257 msgstr ""
12258
12259 #. type: textblock
12260 #: ../fish/guestfish-actions.pod:3347 ../src/guestfs-actions.pod:5193
12261 msgid ""
12262 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
12263 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
12264 "inside that.  You can unpack this as follows in guestfish:"
12265 msgstr ""
12266
12267 #. type: verbatim
12268 #: ../fish/guestfish-actions.pod:3352 ../src/guestfs-actions.pod:5198
12269 #, no-wrap
12270 msgid ""
12271 " add-ro Fedora-11-i686-Live.iso\n"
12272 " run\n"
12273 " mkmountpoint /cd\n"
12274 " mkmountpoint /sqsh\n"
12275 " mkmountpoint /ext3fs\n"
12276 " mount /dev/sda /cd\n"
12277 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
12278 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
12279 "\n"
12280 msgstr ""
12281
12282 #. type: textblock
12283 #: ../fish/guestfish-actions.pod:3361 ../src/guestfs-actions.pod:5207
12284 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
12285 msgstr ""
12286
12287 #. type: textblock
12288 #: ../fish/guestfish-actions.pod:3363
12289 msgid ""
12290 "L</mkmountpoint> is not compatible with L</umount-all>.  You may get "
12291 "unexpected errors if you try to mix these calls.  It is safest to manually "
12292 "unmount filesystems and remove mountpoints after use."
12293 msgstr ""
12294
12295 #. type: textblock
12296 #: ../fish/guestfish-actions.pod:3367
12297 msgid ""
12298 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
12299 "for this to work for manual mountpoints, you must ensure that the innermost "
12300 "mountpoints have the longest pathnames, as in the example code above."
12301 msgstr ""
12302
12303 #. type: textblock
12304 #: ../fish/guestfish-actions.pod:3372 ../src/guestfs-actions.pod:5218
12305 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
12306 msgstr ""
12307
12308 #. type: textblock
12309 #: ../fish/guestfish-actions.pod:3374
12310 msgid ""
12311 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
12312 "L</umount-all> to be called when the handle is closed which can also trigger "
12313 "these issues."
12314 msgstr ""
12315
12316 #. type: =head2
12317 #: ../fish/guestfish-actions.pod:3378
12318 msgid "mknod"
12319 msgstr ""
12320
12321 #. type: verbatim
12322 #: ../fish/guestfish-actions.pod:3380
12323 #, no-wrap
12324 msgid ""
12325 " mknod mode devmajor devminor path\n"
12326 "\n"
12327 msgstr ""
12328
12329 #. type: textblock
12330 #: ../fish/guestfish-actions.pod:3382 ../src/guestfs-actions.pod:5237
12331 msgid ""
12332 "This call creates block or character special devices, or named pipes "
12333 "(FIFOs)."
12334 msgstr ""
12335
12336 #. type: textblock
12337 #: ../fish/guestfish-actions.pod:3385 ../src/guestfs-actions.pod:5240
12338 msgid ""
12339 "The C<mode> parameter should be the mode, using the standard constants.  "
12340 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
12341 "used when creating block and character special devices."
12342 msgstr ""
12343
12344 #. type: textblock
12345 #: ../fish/guestfish-actions.pod:3390
12346 msgid ""
12347 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
12348 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
12349 "regular file).  These constants are available in the standard Linux header "
12350 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
12351 "wrappers around this command which bitwise OR in the appropriate constant "
12352 "for you."
12353 msgstr ""
12354
12355 #. type: =head2
12356 #: ../fish/guestfish-actions.pod:3400
12357 msgid "mknod-b"
12358 msgstr ""
12359
12360 #. type: verbatim
12361 #: ../fish/guestfish-actions.pod:3402
12362 #, no-wrap
12363 msgid ""
12364 " mknod-b mode devmajor devminor path\n"
12365 "\n"
12366 msgstr ""
12367
12368 #. type: textblock
12369 #: ../fish/guestfish-actions.pod:3404
12370 msgid ""
12371 "This call creates a block device node called C<path> with mode C<mode> and "
12372 "device major/minor C<devmajor> and C<devminor>.  It is just a convenient "
12373 "wrapper around L</mknod>."
12374 msgstr ""
12375
12376 #. type: =head2
12377 #: ../fish/guestfish-actions.pod:3410
12378 msgid "mknod-c"
12379 msgstr ""
12380
12381 #. type: verbatim
12382 #: ../fish/guestfish-actions.pod:3412
12383 #, no-wrap
12384 msgid ""
12385 " mknod-c mode devmajor devminor path\n"
12386 "\n"
12387 msgstr ""
12388
12389 #. type: textblock
12390 #: ../fish/guestfish-actions.pod:3414
12391 msgid ""
12392 "This call creates a char device node called C<path> with mode C<mode> and "
12393 "device major/minor C<devmajor> and C<devminor>.  It is just a convenient "
12394 "wrapper around L</mknod>."
12395 msgstr ""
12396
12397 #. type: =head2
12398 #: ../fish/guestfish-actions.pod:3420
12399 msgid "mkswap"
12400 msgstr ""
12401
12402 #. type: verbatim
12403 #: ../fish/guestfish-actions.pod:3422
12404 #, no-wrap
12405 msgid ""
12406 " mkswap device\n"
12407 "\n"
12408 msgstr ""
12409
12410 #. type: textblock
12411 #: ../fish/guestfish-actions.pod:3424 ../src/guestfs-actions.pod:5303
12412 msgid "Create a swap partition on C<device>."
12413 msgstr ""
12414
12415 #. type: =head2
12416 #: ../fish/guestfish-actions.pod:3426
12417 msgid "mkswap-L"
12418 msgstr ""
12419
12420 #. type: verbatim
12421 #: ../fish/guestfish-actions.pod:3428
12422 #, no-wrap
12423 msgid ""
12424 " mkswap-L label device\n"
12425 "\n"
12426 msgstr ""
12427
12428 #. type: textblock
12429 #: ../fish/guestfish-actions.pod:3430 ../src/guestfs-actions.pod:5316
12430 msgid "Create a swap partition on C<device> with label C<label>."
12431 msgstr ""
12432
12433 #. type: textblock
12434 #: ../fish/guestfish-actions.pod:3432 ../src/guestfs-actions.pod:5318
12435 msgid ""
12436 "Note that you cannot attach a swap label to a block device "
12437 "(eg. C</dev/sda>), just to a partition.  This appears to be a limitation of "
12438 "the kernel or swap tools."
12439 msgstr ""
12440
12441 #. type: =head2
12442 #: ../fish/guestfish-actions.pod:3436
12443 msgid "mkswap-U"
12444 msgstr ""
12445
12446 #. type: verbatim
12447 #: ../fish/guestfish-actions.pod:3438
12448 #, no-wrap
12449 msgid ""
12450 " mkswap-U uuid device\n"
12451 "\n"
12452 msgstr ""
12453
12454 #. type: textblock
12455 #: ../fish/guestfish-actions.pod:3440 ../src/guestfs-actions.pod:5333
12456 msgid "Create a swap partition on C<device> with UUID C<uuid>."
12457 msgstr ""
12458
12459 #. type: =head2
12460 #: ../fish/guestfish-actions.pod:3442
12461 msgid "mkswap-file"
12462 msgstr ""
12463
12464 #. type: verbatim
12465 #: ../fish/guestfish-actions.pod:3444
12466 #, no-wrap
12467 msgid ""
12468 " mkswap-file path\n"
12469 "\n"
12470 msgstr ""
12471
12472 #. type: textblock
12473 #: ../fish/guestfish-actions.pod:3446 ../src/guestfs-actions.pod:5345
12474 msgid "Create a swap file."
12475 msgstr ""
12476
12477 #. type: textblock
12478 #: ../fish/guestfish-actions.pod:3448
12479 msgid ""
12480 "This command just writes a swap file signature to an existing file.  To "
12481 "create the file itself, use something like L</fallocate>."
12482 msgstr ""
12483
12484 #. type: =head2
12485 #: ../fish/guestfish-actions.pod:3451
12486 msgid "modprobe"
12487 msgstr ""
12488
12489 #. type: verbatim
12490 #: ../fish/guestfish-actions.pod:3453
12491 #, no-wrap
12492 msgid ""
12493 " modprobe modulename\n"
12494 "\n"
12495 msgstr ""
12496
12497 #. type: textblock
12498 #: ../fish/guestfish-actions.pod:3455 ../src/guestfs-actions.pod:5360
12499 msgid "This loads a kernel module in the appliance."
12500 msgstr ""
12501
12502 #. type: textblock
12503 #: ../fish/guestfish-actions.pod:3457 ../src/guestfs-actions.pod:5362
12504 msgid ""
12505 "The kernel module must have been whitelisted when libguestfs was built (see "
12506 "C<appliance/kmod.whitelist.in> in the source)."
12507 msgstr ""
12508
12509 #. type: =head2
12510 #: ../fish/guestfish-actions.pod:3460
12511 msgid "mount"
12512 msgstr ""
12513
12514 #. type: verbatim
12515 #: ../fish/guestfish-actions.pod:3462
12516 #, no-wrap
12517 msgid ""
12518 " mount device mountpoint\n"
12519 "\n"
12520 msgstr ""
12521
12522 #. type: textblock
12523 #: ../fish/guestfish-actions.pod:3464 ../src/guestfs-actions.pod:5376
12524 msgid ""
12525 "Mount a guest disk at a position in the filesystem.  Block devices are named "
12526 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest.  If "
12527 "those block devices contain partitions, they will have the usual names "
12528 "(eg. C</dev/sda1>).  Also LVM C</dev/VG/LV>-style names can be used."
12529 msgstr ""
12530
12531 #. type: textblock
12532 #: ../fish/guestfish-actions.pod:3470 ../src/guestfs-actions.pod:5382
12533 msgid ""
12534 "The rules are the same as for L<mount(2)>: A filesystem must first be "
12535 "mounted on C</> before others can be mounted.  Other filesystems can only be "
12536 "mounted on directories which already exist."
12537 msgstr ""
12538
12539 #. type: textblock
12540 #: ../fish/guestfish-actions.pod:3475 ../src/guestfs-actions.pod:5387
12541 msgid ""
12542 "The mounted filesystem is writable, if we have sufficient permissions on the "
12543 "underlying device."
12544 msgstr ""
12545
12546 #. type: textblock
12547 #: ../fish/guestfish-actions.pod:3478
12548 msgid ""
12549 "Before libguestfs 1.13.16, this call implicitly added the options C<sync> "
12550 "and C<noatime>.  The C<sync> option greatly slowed writes and caused many "
12551 "problems for users.  If your program might need to work with older versions "
12552 "of libguestfs, use L</mount-options> instead (using an empty string for the "
12553 "first parameter if you don't want any options)."
12554 msgstr ""
12555
12556 #. type: =head2
12557 #: ../fish/guestfish-actions.pod:3485
12558 msgid "mount-9p"
12559 msgstr ""
12560
12561 #. type: verbatim
12562 #: ../fish/guestfish-actions.pod:3487
12563 #, no-wrap
12564 msgid ""
12565 " mount-9p mounttag mountpoint [options:..]\n"
12566 "\n"
12567 msgstr ""
12568
12569 #. type: textblock
12570 #: ../fish/guestfish-actions.pod:3489 ../src/guestfs-actions.pod:5416
12571 msgid ""
12572 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
12573 "C<mountpoint>."
12574 msgstr ""
12575
12576 #. type: textblock
12577 #: ../fish/guestfish-actions.pod:3492 ../src/guestfs-actions.pod:5419
12578 msgid ""
12579 "If required, C<trans=virtio> will be automatically added to the options.  "
12580 "Any other options required can be passed in the optional C<options> "
12581 "parameter."
12582 msgstr ""
12583
12584 #. type: =head2
12585 #: ../fish/guestfish-actions.pod:3498
12586 msgid "mount-loop"
12587 msgstr ""
12588
12589 #. type: verbatim
12590 #: ../fish/guestfish-actions.pod:3500
12591 #, no-wrap
12592 msgid ""
12593 " mount-loop file mountpoint\n"
12594 "\n"
12595 msgstr ""
12596
12597 #. type: textblock
12598 #: ../fish/guestfish-actions.pod:3502 ../src/guestfs-actions.pod:5458
12599 msgid ""
12600 "This command lets you mount C<file> (a filesystem image in a file) on a "
12601 "mount point.  It is entirely equivalent to the command C<mount -o loop file "
12602 "mountpoint>."
12603 msgstr ""
12604
12605 #. type: =head2
12606 #: ../fish/guestfish-actions.pod:3506
12607 msgid "mount-options"
12608 msgstr ""
12609
12610 #. type: verbatim
12611 #: ../fish/guestfish-actions.pod:3508
12612 #, no-wrap
12613 msgid ""
12614 " mount-options options device mountpoint\n"
12615 "\n"
12616 msgstr ""
12617
12618 #. type: textblock
12619 #: ../fish/guestfish-actions.pod:3510
12620 msgid ""
12621 "This is the same as the L</mount> command, but it allows you to set the "
12622 "mount options as for the L<mount(8)> I<-o> flag."
12623 msgstr ""
12624
12625 #. type: textblock
12626 #: ../fish/guestfish-actions.pod:3514 ../src/guestfs-actions.pod:5478
12627 msgid ""
12628 "If the C<options> parameter is an empty string, then no options are passed "
12629 "(all options default to whatever the filesystem uses)."
12630 msgstr ""
12631
12632 #. type: =head2
12633 #: ../fish/guestfish-actions.pod:3518
12634 msgid "mount-ro"
12635 msgstr ""
12636
12637 #. type: verbatim
12638 #: ../fish/guestfish-actions.pod:3520
12639 #, no-wrap
12640 msgid ""
12641 " mount-ro device mountpoint\n"
12642 "\n"
12643 msgstr ""
12644
12645 #. type: textblock
12646 #: ../fish/guestfish-actions.pod:3522
12647 msgid ""
12648 "This is the same as the L</mount> command, but it mounts the filesystem with "
12649 "the read-only (I<-o ro>) flag."
12650 msgstr ""
12651
12652 #. type: =head2
12653 #: ../fish/guestfish-actions.pod:3525
12654 msgid "mount-vfs"
12655 msgstr ""
12656
12657 #. type: verbatim
12658 #: ../fish/guestfish-actions.pod:3527
12659 #, no-wrap
12660 msgid ""
12661 " mount-vfs options vfstype device mountpoint\n"
12662 "\n"
12663 msgstr ""
12664
12665 #. type: textblock
12666 #: ../fish/guestfish-actions.pod:3529
12667 msgid ""
12668 "This is the same as the L</mount> command, but it allows you to set both the "
12669 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
12670 msgstr ""
12671
12672 #. type: =head2
12673 #: ../fish/guestfish-actions.pod:3533
12674 msgid "mountpoints"
12675 msgstr ""
12676
12677 #. type: verbatim
12678 #: ../fish/guestfish-actions.pod:3535
12679 #, no-wrap
12680 msgid ""
12681 " mountpoints\n"
12682 "\n"
12683 msgstr ""
12684
12685 #. type: textblock
12686 #: ../fish/guestfish-actions.pod:3537
12687 msgid ""
12688 "This call is similar to L</mounts>.  That call returns a list of devices.  "
12689 "This one returns a hash table (map) of device name to directory where the "
12690 "device is mounted."
12691 msgstr ""
12692
12693 #. type: =head2
12694 #: ../fish/guestfish-actions.pod:3541
12695 msgid "mounts"
12696 msgstr ""
12697
12698 #. type: verbatim
12699 #: ../fish/guestfish-actions.pod:3543
12700 #, no-wrap
12701 msgid ""
12702 " mounts\n"
12703 "\n"
12704 msgstr ""
12705
12706 #. type: textblock
12707 #: ../fish/guestfish-actions.pod:3545 ../src/guestfs-actions.pod:5539
12708 msgid ""
12709 "This returns the list of currently mounted filesystems.  It returns the list "
12710 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
12711 msgstr ""
12712
12713 #. type: textblock
12714 #: ../fish/guestfish-actions.pod:3548 ../src/guestfs-actions.pod:5542
12715 msgid "Some internal mounts are not shown."
12716 msgstr ""
12717
12718 #. type: textblock
12719 #: ../fish/guestfish-actions.pod:3550
12720 msgid "See also: L</mountpoints>"
12721 msgstr ""
12722
12723 #. type: =head2
12724 #: ../fish/guestfish-actions.pod:3552
12725 msgid "mv"
12726 msgstr ""
12727
12728 #. type: verbatim
12729 #: ../fish/guestfish-actions.pod:3554
12730 #, no-wrap
12731 msgid ""
12732 " mv src dest\n"
12733 "\n"
12734 msgstr ""
12735
12736 #. type: textblock
12737 #: ../fish/guestfish-actions.pod:3556 ../src/guestfs-actions.pod:5559
12738 msgid ""
12739 "This moves a file from C<src> to C<dest> where C<dest> is either a "
12740 "destination filename or destination directory."
12741 msgstr ""
12742
12743 #. type: =head2
12744 #: ../fish/guestfish-actions.pod:3559
12745 msgid "ntfs-3g-probe"
12746 msgstr ""
12747
12748 #. type: verbatim
12749 #: ../fish/guestfish-actions.pod:3561
12750 #, no-wrap
12751 msgid ""
12752 " ntfs-3g-probe true|false device\n"
12753 "\n"
12754 msgstr ""
12755
12756 #. type: textblock
12757 #: ../fish/guestfish-actions.pod:3563 ../src/guestfs-actions.pod:5573
12758 msgid ""
12759 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
12760 "C<device> for mountability.  (Not all NTFS volumes can be mounted "
12761 "read-write, and some cannot be mounted at all)."
12762 msgstr ""
12763
12764 #. type: textblock
12765 #: ../fish/guestfish-actions.pod:3567 ../src/guestfs-actions.pod:5577
12766 msgid ""
12767 "C<rw> is a boolean flag.  Set it to true if you want to test if the volume "
12768 "can be mounted read-write.  Set it to false if you want to test if the "
12769 "volume can be mounted read-only."
12770 msgstr ""
12771
12772 #. type: textblock
12773 #: ../fish/guestfish-actions.pod:3571 ../src/guestfs-actions.pod:5581
12774 msgid ""
12775 "The return value is an integer which C<0> if the operation would succeed, or "
12776 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
12777 msgstr ""
12778
12779 #. type: =head2
12780 #: ../fish/guestfish-actions.pod:3575
12781 msgid "ntfsresize"
12782 msgstr ""
12783
12784 #. type: verbatim
12785 #: ../fish/guestfish-actions.pod:3577
12786 #, no-wrap
12787 msgid ""
12788 " ntfsresize device\n"
12789 "\n"
12790 msgstr ""
12791
12792 #. type: textblock
12793 #: ../fish/guestfish-actions.pod:3579 ../fish/guestfish-actions.pod:3603 ../src/guestfs-actions.pod:5602 ../src/guestfs-actions.pod:5634
12794 msgid ""
12795 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
12796 "size of the underlying device."
12797 msgstr ""
12798
12799 #. type: textblock
12800 #: ../fish/guestfish-actions.pod:3582 ../src/guestfs-actions.pod:5605
12801 msgid ""
12802 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
12803 "consistency check (for safety).  You have to boot into Windows to perform "
12804 "this check and clear this condition.  Furthermore, ntfsresize refuses to "
12805 "resize filesystems which have been marked in this way.  So in effect it is "
12806 "not possible to call ntfsresize multiple times on a single filesystem "
12807 "without booting into Windows between each resize."
12808 msgstr ""
12809
12810 #. type: textblock
12811 #: ../fish/guestfish-actions.pod:3590 ../fish/guestfish-actions.pod:3629 ../src/guestfs-actions.pod:5613 ../src/guestfs-actions.pod:5660
12812 msgid "See also L<ntfsresize(8)>."
12813 msgstr ""
12814
12815 #. type: textblock
12816 #: ../fish/guestfish-actions.pod:3592 ../fish/guestfish-actions.pod:3640
12817 msgid ""
12818 "I<This function is deprecated.> In new code, use the L</ntfsresize_opts> "
12819 "call instead."
12820 msgstr ""
12821
12822 #. type: =head2
12823 #: ../fish/guestfish-actions.pod:3599
12824 msgid "ntfsresize-opts"
12825 msgstr ""
12826
12827 #. type: verbatim
12828 #: ../fish/guestfish-actions.pod:3601
12829 #, no-wrap
12830 msgid ""
12831 " ntfsresize-opts device [size:..] [force:..]\n"
12832 "\n"
12833 msgstr ""
12834
12835 #. type: textblock
12836 #: ../fish/guestfish-actions.pod:3612 ../src/guestfs-actions.pod:5643
12837 msgid ""
12838 "The new size (in bytes) of the filesystem.  If omitted, the filesystem is "
12839 "resized to fit the container (eg. partition)."
12840 msgstr ""
12841
12842 #. type: =item
12843 #: ../fish/guestfish-actions.pod:3615 ../src/guestfs-actions.pod:5646
12844 msgid "C<force>"
12845 msgstr ""
12846
12847 #. type: textblock
12848 #: ../fish/guestfish-actions.pod:3617 ../src/guestfs-actions.pod:5648
12849 msgid ""
12850 "If this option is true, then force the resize of the filesystem even if the "
12851 "filesystem is marked as requiring a consistency check."
12852 msgstr ""
12853
12854 #. type: textblock
12855 #: ../fish/guestfish-actions.pod:3620
12856 msgid ""
12857 "After the resize operation, the filesystem is always marked as requiring a "
12858 "consistency check (for safety).  You have to boot into Windows to perform "
12859 "this check and clear this condition.  If you I<don't> set the C<force> "
12860 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
12861 "a single filesystem without booting into Windows between each resize."
12862 msgstr ""
12863
12864 #. type: =head2
12865 #: ../fish/guestfish-actions.pod:3633
12866 msgid "ntfsresize-size"
12867 msgstr ""
12868
12869 #. type: verbatim
12870 #: ../fish/guestfish-actions.pod:3635
12871 #, no-wrap
12872 msgid ""
12873 " ntfsresize-size device size\n"
12874 "\n"
12875 msgstr ""
12876
12877 #. type: textblock
12878 #: ../fish/guestfish-actions.pod:3637
12879 msgid ""
12880 "This command is the same as L</ntfsresize> except that it allows you to "
12881 "specify the new size (in bytes) explicitly."
12882 msgstr ""
12883
12884 #. type: =head2
12885 #: ../fish/guestfish-actions.pod:3647
12886 msgid "part-add"
12887 msgstr ""
12888
12889 #. type: verbatim
12890 #: ../fish/guestfish-actions.pod:3649
12891 #, no-wrap
12892 msgid ""
12893 " part-add device prlogex startsect endsect\n"
12894 "\n"
12895 msgstr ""
12896
12897 #. type: textblock
12898 #: ../fish/guestfish-actions.pod:3651
12899 msgid ""
12900 "This command adds a partition to C<device>.  If there is no partition table "
12901 "on the device, call L</part-init> first."
12902 msgstr ""
12903
12904 #. type: textblock
12905 #: ../fish/guestfish-actions.pod:3654 ../src/guestfs-actions.pod:5721
12906 msgid ""
12907 "The C<prlogex> parameter is the type of partition.  Normally you should pass "
12908 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
12909 "C<logical>) and C<e> (or C<extended>) partition types."
12910 msgstr ""
12911
12912 #. type: textblock
12913 #: ../fish/guestfish-actions.pod:3659 ../src/guestfs-actions.pod:5726
12914 msgid ""
12915 "C<startsect> and C<endsect> are the start and end of the partition in "
12916 "I<sectors>.  C<endsect> may be negative, which means it counts backwards "
12917 "from the end of the disk (C<-1> is the last sector)."
12918 msgstr ""
12919
12920 #. type: textblock
12921 #: ../fish/guestfish-actions.pod:3663
12922 msgid ""
12923 "Creating a partition which covers the whole disk is not so easy.  Use "
12924 "L</part-disk> to do that."
12925 msgstr ""
12926
12927 #. type: =head2
12928 #: ../fish/guestfish-actions.pod:3666
12929 msgid "part-del"
12930 msgstr ""
12931
12932 #. type: verbatim
12933 #: ../fish/guestfish-actions.pod:3668
12934 #, no-wrap
12935 msgid ""
12936 " part-del device partnum\n"
12937 "\n"
12938 msgstr ""
12939
12940 #. type: textblock
12941 #: ../fish/guestfish-actions.pod:3670 ../src/guestfs-actions.pod:5744
12942 msgid "This command deletes the partition numbered C<partnum> on C<device>."
12943 msgstr ""
12944
12945 #. type: textblock
12946 #: ../fish/guestfish-actions.pod:3672 ../src/guestfs-actions.pod:5746
12947 msgid ""
12948 "Note that in the case of MBR partitioning, deleting an extended partition "
12949 "also deletes any logical partitions it contains."
12950 msgstr ""
12951
12952 #. type: =head2
12953 #: ../fish/guestfish-actions.pod:3676
12954 msgid "part-disk"
12955 msgstr ""
12956
12957 #. type: verbatim
12958 #: ../fish/guestfish-actions.pod:3678
12959 #, no-wrap
12960 msgid ""
12961 " part-disk device parttype\n"
12962 "\n"
12963 msgstr ""
12964
12965 #. type: textblock
12966 #: ../fish/guestfish-actions.pod:3680
12967 msgid ""
12968 "This command is simply a combination of L</part-init> followed by "
12969 "L</part-add> to create a single primary partition covering the whole disk."
12970 msgstr ""
12971
12972 #. type: textblock
12973 #: ../fish/guestfish-actions.pod:3684
12974 msgid ""
12975 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
12976 "possible values are described in L</part-init>."
12977 msgstr ""
12978
12979 #. type: =head2
12980 #: ../fish/guestfish-actions.pod:3687
12981 msgid "part-get-bootable"
12982 msgstr ""
12983
12984 #. type: verbatim
12985 #: ../fish/guestfish-actions.pod:3689
12986 #, no-wrap
12987 msgid ""
12988 " part-get-bootable device partnum\n"
12989 "\n"
12990 msgstr ""
12991
12992 #. type: textblock
12993 #: ../fish/guestfish-actions.pod:3691 ../src/guestfs-actions.pod:5779
12994 msgid ""
12995 "This command returns true if the partition C<partnum> on C<device> has the "
12996 "bootable flag set."
12997 msgstr ""
12998
12999 #. type: textblock
13000 #: ../fish/guestfish-actions.pod:3694
13001 msgid "See also L</part-set-bootable>."
13002 msgstr ""
13003
13004 #. type: =head2
13005 #: ../fish/guestfish-actions.pod:3696
13006 msgid "part-get-mbr-id"
13007 msgstr ""
13008
13009 #. type: verbatim
13010 #: ../fish/guestfish-actions.pod:3698
13011 #, no-wrap
13012 msgid ""
13013 " part-get-mbr-id device partnum\n"
13014 "\n"
13015 msgstr ""
13016
13017 #. type: textblock
13018 #: ../fish/guestfish-actions.pod:3700 ../src/guestfs-actions.pod:5795
13019 msgid ""
13020 "Returns the MBR type byte (also known as the ID byte) from the numbered "
13021 "partition C<partnum>."
13022 msgstr ""
13023
13024 #. type: textblock
13025 #: ../fish/guestfish-actions.pod:3703 ../fish/guestfish-actions.pod:3847
13026 msgid ""
13027 "Note that only MBR (old DOS-style) partitions have type bytes.  You will get "
13028 "undefined results for other partition table types (see "
13029 "L</part-get-parttype>)."
13030 msgstr ""
13031
13032 #. type: =head2
13033 #: ../fish/guestfish-actions.pod:3707
13034 msgid "part-get-parttype"
13035 msgstr ""
13036
13037 #. type: verbatim
13038 #: ../fish/guestfish-actions.pod:3709
13039 #, no-wrap
13040 msgid ""
13041 " part-get-parttype device\n"
13042 "\n"
13043 msgstr ""
13044
13045 #. type: textblock
13046 #: ../fish/guestfish-actions.pod:3711 ../src/guestfs-actions.pod:5812
13047 msgid ""
13048 "This command examines the partition table on C<device> and returns the "
13049 "partition table type (format) being used."
13050 msgstr ""
13051
13052 #. type: textblock
13053 #: ../fish/guestfish-actions.pod:3714
13054 msgid ""
13055 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
13056 "table), C<gpt> (a GPT/EFI-style partition table).  Other values are "
13057 "possible, although unusual.  See L</part-init> for a full list."
13058 msgstr ""
13059
13060 #. type: =head2
13061 #: ../fish/guestfish-actions.pod:3719
13062 msgid "part-init"
13063 msgstr ""
13064
13065 #. type: verbatim
13066 #: ../fish/guestfish-actions.pod:3721
13067 #, no-wrap
13068 msgid ""
13069 " part-init device parttype\n"
13070 "\n"
13071 msgstr ""
13072
13073 #. type: textblock
13074 #: ../fish/guestfish-actions.pod:3723 ../src/guestfs-actions.pod:5832
13075 msgid ""
13076 "This creates an empty partition table on C<device> of one of the partition "
13077 "types listed below.  Usually C<parttype> should be either C<msdos> or C<gpt> "
13078 "(for large disks)."
13079 msgstr ""
13080
13081 #. type: textblock
13082 #: ../fish/guestfish-actions.pod:3727
13083 msgid ""
13084 "Initially there are no partitions.  Following this, you should call "
13085 "L</part-add> for each partition required."
13086 msgstr ""
13087
13088 #. type: textblock
13089 #: ../fish/guestfish-actions.pod:3730 ../src/guestfs-actions.pod:5839
13090 msgid "Possible values for C<parttype> are:"
13091 msgstr ""
13092
13093 #. type: =item
13094 #: ../fish/guestfish-actions.pod:3734 ../src/guestfs-actions.pod:5843
13095 msgid "B<efi>"
13096 msgstr ""
13097
13098 #. type: =item
13099 #: ../fish/guestfish-actions.pod:3736 ../src/guestfs-actions.pod:5845
13100 msgid "B<gpt>"
13101 msgstr ""
13102
13103 #. type: textblock
13104 #: ../fish/guestfish-actions.pod:3738 ../src/guestfs-actions.pod:5847
13105 msgid "Intel EFI / GPT partition table."
13106 msgstr ""
13107
13108 #. type: textblock
13109 #: ../fish/guestfish-actions.pod:3740 ../src/guestfs-actions.pod:5849
13110 msgid ""
13111 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
13112 "and Intel-based Mac OS X.  It also has limited backwards compatibility with "
13113 "the C<mbr> format."
13114 msgstr ""
13115
13116 #. type: =item
13117 #: ../fish/guestfish-actions.pod:3744 ../src/guestfs-actions.pod:5853
13118 msgid "B<mbr>"
13119 msgstr ""
13120
13121 #. type: =item
13122 #: ../fish/guestfish-actions.pod:3746 ../src/guestfs-actions.pod:5855
13123 msgid "B<msdos>"
13124 msgstr ""
13125
13126 #. type: textblock
13127 #: ../fish/guestfish-actions.pod:3748 ../src/guestfs-actions.pod:5857
13128 msgid ""
13129 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
13130 "Windows.  This partition type will B<only> work for device sizes up to 2 "
13131 "TB.  For large disks we recommend using C<gpt>."
13132 msgstr ""
13133
13134 #. type: textblock
13135 #: ../fish/guestfish-actions.pod:3755 ../src/guestfs-actions.pod:5864
13136 msgid "Other partition table types that may work but are not supported include:"
13137 msgstr ""
13138
13139 #. type: =item
13140 #: ../fish/guestfish-actions.pod:3760 ../src/guestfs-actions.pod:5869
13141 msgid "B<aix>"
13142 msgstr ""
13143
13144 #. type: textblock
13145 #: ../fish/guestfish-actions.pod:3762 ../src/guestfs-actions.pod:5871
13146 msgid "AIX disk labels."
13147 msgstr ""
13148
13149 #. type: =item
13150 #: ../fish/guestfish-actions.pod:3764 ../src/guestfs-actions.pod:5873
13151 msgid "B<amiga>"
13152 msgstr ""
13153
13154 #. type: =item
13155 #: ../fish/guestfish-actions.pod:3766 ../src/guestfs-actions.pod:5875
13156 msgid "B<rdb>"
13157 msgstr ""
13158
13159 #. type: textblock
13160 #: ../fish/guestfish-actions.pod:3768 ../src/guestfs-actions.pod:5877
13161 msgid "Amiga \"Rigid Disk Block\" format."
13162 msgstr ""
13163
13164 #. type: =item
13165 #: ../fish/guestfish-actions.pod:3770 ../src/guestfs-actions.pod:5879
13166 msgid "B<bsd>"
13167 msgstr ""
13168
13169 #. type: textblock
13170 #: ../fish/guestfish-actions.pod:3772 ../src/guestfs-actions.pod:5881
13171 msgid "BSD disk labels."
13172 msgstr ""
13173
13174 #. type: =item
13175 #: ../fish/guestfish-actions.pod:3774 ../src/guestfs-actions.pod:5883
13176 msgid "B<dasd>"
13177 msgstr ""
13178
13179 #. type: textblock
13180 #: ../fish/guestfish-actions.pod:3776 ../src/guestfs-actions.pod:5885
13181 msgid "DASD, used on IBM mainframes."
13182 msgstr ""
13183
13184 #. type: =item
13185 #: ../fish/guestfish-actions.pod:3778 ../src/guestfs-actions.pod:5887
13186 msgid "B<dvh>"
13187 msgstr ""
13188
13189 #. type: textblock
13190 #: ../fish/guestfish-actions.pod:3780 ../src/guestfs-actions.pod:5889
13191 msgid "MIPS/SGI volumes."
13192 msgstr ""
13193
13194 #. type: =item
13195 #: ../fish/guestfish-actions.pod:3782 ../src/guestfs-actions.pod:5891
13196 msgid "B<mac>"
13197 msgstr ""
13198
13199 #. type: textblock
13200 #: ../fish/guestfish-actions.pod:3784 ../src/guestfs-actions.pod:5893
13201 msgid "Old Mac partition format.  Modern Macs use C<gpt>."
13202 msgstr ""
13203
13204 #. type: =item
13205 #: ../fish/guestfish-actions.pod:3786 ../src/guestfs-actions.pod:5895
13206 msgid "B<pc98>"
13207 msgstr ""
13208
13209 #. type: textblock
13210 #: ../fish/guestfish-actions.pod:3788 ../src/guestfs-actions.pod:5897
13211 msgid "NEC PC-98 format, common in Japan apparently."
13212 msgstr ""
13213
13214 #. type: =item
13215 #: ../fish/guestfish-actions.pod:3790 ../src/guestfs-actions.pod:5899
13216 msgid "B<sun>"
13217 msgstr ""
13218
13219 #. type: textblock
13220 #: ../fish/guestfish-actions.pod:3792 ../src/guestfs-actions.pod:5901
13221 msgid "Sun disk labels."
13222 msgstr ""
13223
13224 #. type: =head2
13225 #: ../fish/guestfish-actions.pod:3796
13226 msgid "part-list"
13227 msgstr ""
13228
13229 #. type: verbatim
13230 #: ../fish/guestfish-actions.pod:3798
13231 #, no-wrap
13232 msgid ""
13233 " part-list device\n"
13234 "\n"
13235 msgstr ""
13236
13237 #. type: textblock
13238 #: ../fish/guestfish-actions.pod:3800 ../src/guestfs-actions.pod:5915
13239 msgid ""
13240 "This command parses the partition table on C<device> and returns the list of "
13241 "partitions found."
13242 msgstr ""
13243
13244 #. type: textblock
13245 #: ../fish/guestfish-actions.pod:3803 ../src/guestfs-actions.pod:5918
13246 msgid "The fields in the returned structure are:"
13247 msgstr ""
13248
13249 #. type: =item
13250 #: ../fish/guestfish-actions.pod:3807 ../src/guestfs-actions.pod:5922
13251 msgid "B<part_num>"
13252 msgstr ""
13253
13254 #. type: textblock
13255 #: ../fish/guestfish-actions.pod:3809 ../src/guestfs-actions.pod:5924
13256 msgid "Partition number, counting from 1."
13257 msgstr ""
13258
13259 #. type: =item
13260 #: ../fish/guestfish-actions.pod:3811 ../src/guestfs-actions.pod:5926
13261 msgid "B<part_start>"
13262 msgstr ""
13263
13264 #. type: textblock
13265 #: ../fish/guestfish-actions.pod:3813
13266 msgid ""
13267 "Start of the partition I<in bytes>.  To get sectors you have to divide by "
13268 "the device's sector size, see L</blockdev-getss>."
13269 msgstr ""
13270
13271 #. type: =item
13272 #: ../fish/guestfish-actions.pod:3816 ../src/guestfs-actions.pod:5931
13273 msgid "B<part_end>"
13274 msgstr ""
13275
13276 #. type: textblock
13277 #: ../fish/guestfish-actions.pod:3818 ../src/guestfs-actions.pod:5933
13278 msgid "End of the partition in bytes."
13279 msgstr ""
13280
13281 #. type: =item
13282 #: ../fish/guestfish-actions.pod:3820 ../src/guestfs-actions.pod:5935
13283 msgid "B<part_size>"
13284 msgstr ""
13285
13286 #. type: textblock
13287 #: ../fish/guestfish-actions.pod:3822 ../src/guestfs-actions.pod:5937
13288 msgid "Size of the partition in bytes."
13289 msgstr ""
13290
13291 #. type: =head2
13292 #: ../fish/guestfish-actions.pod:3826
13293 msgid "part-set-bootable"
13294 msgstr ""
13295
13296 #. type: verbatim
13297 #: ../fish/guestfish-actions.pod:3828
13298 #, no-wrap
13299 msgid ""
13300 " part-set-bootable device partnum true|false\n"
13301 "\n"
13302 msgstr ""
13303
13304 #. type: textblock
13305 #: ../fish/guestfish-actions.pod:3830 ../src/guestfs-actions.pod:5955
13306 msgid ""
13307 "This sets the bootable flag on partition numbered C<partnum> on device "
13308 "C<device>.  Note that partitions are numbered from 1."
13309 msgstr ""
13310
13311 #. type: textblock
13312 #: ../fish/guestfish-actions.pod:3833 ../src/guestfs-actions.pod:5958
13313 msgid ""
13314 "The bootable flag is used by some operating systems (notably Windows) to "
13315 "determine which partition to boot from.  It is by no means universally "
13316 "recognized."
13317 msgstr ""
13318
13319 #. type: =head2
13320 #: ../fish/guestfish-actions.pod:3837
13321 msgid "part-set-mbr-id"
13322 msgstr ""
13323
13324 #. type: verbatim
13325 #: ../fish/guestfish-actions.pod:3839
13326 #, no-wrap
13327 msgid ""
13328 " part-set-mbr-id device partnum idbyte\n"
13329 "\n"
13330 msgstr ""
13331
13332 #. type: textblock
13333 #: ../fish/guestfish-actions.pod:3841 ../src/guestfs-actions.pod:5974
13334 msgid ""
13335 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
13336 "C<partnum> to C<idbyte>.  Note that the type bytes quoted in most "
13337 "documentation are in fact hexadecimal numbers, but usually documented "
13338 "without any leading \"0x\" which might be confusing."
13339 msgstr ""
13340
13341 #. type: =head2
13342 #: ../fish/guestfish-actions.pod:3851
13343 msgid "part-set-name"
13344 msgstr ""
13345
13346 #. type: verbatim
13347 #: ../fish/guestfish-actions.pod:3853
13348 #, no-wrap
13349 msgid ""
13350 " part-set-name device partnum name\n"
13351 "\n"
13352 msgstr ""
13353
13354 #. type: textblock
13355 #: ../fish/guestfish-actions.pod:3855 ../src/guestfs-actions.pod:5996
13356 msgid ""
13357 "This sets the partition name on partition numbered C<partnum> on device "
13358 "C<device>.  Note that partitions are numbered from 1."
13359 msgstr ""
13360
13361 #. type: textblock
13362 #: ../fish/guestfish-actions.pod:3858 ../src/guestfs-actions.pod:5999
13363 msgid ""
13364 "The partition name can only be set on certain types of partition table.  "
13365 "This works on C<gpt> but not on C<mbr> partitions."
13366 msgstr ""
13367
13368 #. type: =head2
13369 #: ../fish/guestfish-actions.pod:3861
13370 msgid "part-to-dev"
13371 msgstr ""
13372
13373 #. type: verbatim
13374 #: ../fish/guestfish-actions.pod:3863
13375 #, no-wrap
13376 msgid ""
13377 " part-to-dev partition\n"
13378 "\n"
13379 msgstr ""
13380
13381 #. type: textblock
13382 #: ../fish/guestfish-actions.pod:3865 ../src/guestfs-actions.pod:6012
13383 msgid ""
13384 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
13385 "partition number, returning the device name (eg. \"/dev/sdb\")."
13386 msgstr ""
13387
13388 #. type: textblock
13389 #: ../fish/guestfish-actions.pod:3869 ../fish/guestfish-actions.pod:3881
13390 msgid ""
13391 "The named partition must exist, for example as a string returned from "
13392 "L</list-partitions>."
13393 msgstr ""
13394
13395 #. type: textblock
13396 #: ../fish/guestfish-actions.pod:3872
13397 msgid "See also L</part-to-partnum>."
13398 msgstr ""
13399
13400 #. type: =head2
13401 #: ../fish/guestfish-actions.pod:3874
13402 msgid "part-to-partnum"
13403 msgstr ""
13404
13405 #. type: verbatim
13406 #: ../fish/guestfish-actions.pod:3876
13407 #, no-wrap
13408 msgid ""
13409 " part-to-partnum partition\n"
13410 "\n"
13411 msgstr ""
13412
13413 #. type: textblock
13414 #: ../fish/guestfish-actions.pod:3878 ../src/guestfs-actions.pod:6032
13415 msgid ""
13416 "This function takes a partition name (eg. \"/dev/sdb1\") and returns the "
13417 "partition number (eg. C<1>)."
13418 msgstr ""
13419
13420 #. type: textblock
13421 #: ../fish/guestfish-actions.pod:3884
13422 msgid "See also L</part-to-dev>."
13423 msgstr ""
13424
13425 #. type: =head2
13426 #: ../fish/guestfish-actions.pod:3886
13427 msgid "ping-daemon"
13428 msgstr ""
13429
13430 #. type: verbatim
13431 #: ../fish/guestfish-actions.pod:3888
13432 #, no-wrap
13433 msgid ""
13434 " ping-daemon\n"
13435 "\n"
13436 msgstr ""
13437
13438 #. type: textblock
13439 #: ../fish/guestfish-actions.pod:3890 ../src/guestfs-actions.pod:6049
13440 msgid ""
13441 "This is a test probe into the guestfs daemon running inside the qemu "
13442 "subprocess.  Calling this function checks that the daemon responds to the "
13443 "ping message, without affecting the daemon or attached block device(s) in "
13444 "any other way."
13445 msgstr ""
13446
13447 #. type: =head2
13448 #: ../fish/guestfish-actions.pod:3895
13449 msgid "pread"
13450 msgstr ""
13451
13452 #. type: verbatim
13453 #: ../fish/guestfish-actions.pod:3897
13454 #, no-wrap
13455 msgid ""
13456 " pread path count offset\n"
13457 "\n"
13458 msgstr ""
13459
13460 #. type: textblock
13461 #: ../fish/guestfish-actions.pod:3899 ../src/guestfs-actions.pod:6067
13462 msgid ""
13463 "This command lets you read part of a file.  It reads C<count> bytes of the "
13464 "file, starting at C<offset>, from file C<path>."
13465 msgstr ""
13466
13467 #. type: textblock
13468 #: ../fish/guestfish-actions.pod:3902 ../fish/guestfish-actions.pod:3917 ../src/guestfs-actions.pod:6070 ../src/guestfs-actions.pod:6096
13469 msgid ""
13470 "This may read fewer bytes than requested.  For further details see the "
13471 "L<pread(2)> system call."
13472 msgstr ""
13473
13474 #. type: textblock
13475 #: ../fish/guestfish-actions.pod:3905
13476 msgid "See also L</pwrite>, L</pread-device>."
13477 msgstr ""
13478
13479 #. type: =head2
13480 #: ../fish/guestfish-actions.pod:3910
13481 msgid "pread-device"
13482 msgstr ""
13483
13484 #. type: verbatim
13485 #: ../fish/guestfish-actions.pod:3912
13486 #, no-wrap
13487 msgid ""
13488 " pread-device device count offset\n"
13489 "\n"
13490 msgstr ""
13491
13492 #. type: textblock
13493 #: ../fish/guestfish-actions.pod:3914 ../src/guestfs-actions.pod:6093
13494 msgid ""
13495 "This command lets you read part of a file.  It reads C<count> bytes of "
13496 "C<device>, starting at C<offset>."
13497 msgstr ""
13498
13499 #. type: textblock
13500 #: ../fish/guestfish-actions.pod:3920
13501 msgid "See also L</pread>."
13502 msgstr ""
13503
13504 #. type: =head2
13505 #: ../fish/guestfish-actions.pod:3925
13506 msgid "pvcreate"
13507 msgstr ""
13508
13509 #. type: verbatim
13510 #: ../fish/guestfish-actions.pod:3927
13511 #, no-wrap
13512 msgid ""
13513 " pvcreate device\n"
13514 "\n"
13515 msgstr ""
13516
13517 #. type: textblock
13518 #: ../fish/guestfish-actions.pod:3929 ../src/guestfs-actions.pod:6116
13519 msgid ""
13520 "This creates an LVM physical volume on the named C<device>, where C<device> "
13521 "should usually be a partition name such as C</dev/sda1>."
13522 msgstr ""
13523
13524 #. type: =head2
13525 #: ../fish/guestfish-actions.pod:3933
13526 msgid "pvremove"
13527 msgstr ""
13528
13529 #. type: verbatim
13530 #: ../fish/guestfish-actions.pod:3935
13531 #, no-wrap
13532 msgid ""
13533 " pvremove device\n"
13534 "\n"
13535 msgstr ""
13536
13537 #. type: textblock
13538 #: ../fish/guestfish-actions.pod:3937 ../src/guestfs-actions.pod:6130
13539 msgid ""
13540 "This wipes a physical volume C<device> so that LVM will no longer recognise "
13541 "it."
13542 msgstr ""
13543
13544 #. type: textblock
13545 #: ../fish/guestfish-actions.pod:3940 ../src/guestfs-actions.pod:6133
13546 msgid ""
13547 "The implementation uses the C<pvremove> command which refuses to wipe "
13548 "physical volumes that contain any volume groups, so you have to remove those "
13549 "first."
13550 msgstr ""
13551
13552 #. type: =head2
13553 #: ../fish/guestfish-actions.pod:3944
13554 msgid "pvresize"
13555 msgstr ""
13556
13557 #. type: verbatim
13558 #: ../fish/guestfish-actions.pod:3946
13559 #, no-wrap
13560 msgid ""
13561 " pvresize device\n"
13562 "\n"
13563 msgstr ""
13564
13565 #. type: textblock
13566 #: ../fish/guestfish-actions.pod:3948 ../src/guestfs-actions.pod:6147
13567 msgid ""
13568 "This resizes (expands or shrinks) an existing LVM physical volume to match "
13569 "the new size of the underlying device."
13570 msgstr ""
13571
13572 #. type: =head2
13573 #: ../fish/guestfish-actions.pod:3951
13574 msgid "pvresize-size"
13575 msgstr ""
13576
13577 #. type: verbatim
13578 #: ../fish/guestfish-actions.pod:3953
13579 #, no-wrap
13580 msgid ""
13581 " pvresize-size device size\n"
13582 "\n"
13583 msgstr ""
13584
13585 #. type: textblock
13586 #: ../fish/guestfish-actions.pod:3955
13587 msgid ""
13588 "This command is the same as L</pvresize> except that it allows you to "
13589 "specify the new size (in bytes) explicitly."
13590 msgstr ""
13591
13592 #. type: =head2
13593 #: ../fish/guestfish-actions.pod:3958
13594 msgid "pvs"
13595 msgstr ""
13596
13597 #. type: verbatim
13598 #: ../fish/guestfish-actions.pod:3960
13599 #, no-wrap
13600 msgid ""
13601 " pvs\n"
13602 "\n"
13603 msgstr ""
13604
13605 #. type: textblock
13606 #: ../fish/guestfish-actions.pod:3962 ../src/guestfs-actions.pod:6173
13607 msgid ""
13608 "List all the physical volumes detected.  This is the equivalent of the "
13609 "L<pvs(8)> command."
13610 msgstr ""
13611
13612 #. type: textblock
13613 #: ../fish/guestfish-actions.pod:3965 ../src/guestfs-actions.pod:6176
13614 msgid ""
13615 "This returns a list of just the device names that contain PVs "
13616 "(eg. C</dev/sda2>)."
13617 msgstr ""
13618
13619 #. type: textblock
13620 #: ../fish/guestfish-actions.pod:3968
13621 msgid "See also L</pvs-full>."
13622 msgstr ""
13623
13624 #. type: =head2
13625 #: ../fish/guestfish-actions.pod:3970
13626 msgid "pvs-full"
13627 msgstr ""
13628
13629 #. type: verbatim
13630 #: ../fish/guestfish-actions.pod:3972
13631 #, no-wrap
13632 msgid ""
13633 " pvs-full\n"
13634 "\n"
13635 msgstr ""
13636
13637 #. type: textblock
13638 #: ../fish/guestfish-actions.pod:3974 ../src/guestfs-actions.pod:6192
13639 msgid ""
13640 "List all the physical volumes detected.  This is the equivalent of the "
13641 "L<pvs(8)> command.  The \"full\" version includes all fields."
13642 msgstr ""
13643
13644 #. type: =head2
13645 #: ../fish/guestfish-actions.pod:3977
13646 msgid "pvuuid"
13647 msgstr ""
13648
13649 #. type: verbatim
13650 #: ../fish/guestfish-actions.pod:3979
13651 #, no-wrap
13652 msgid ""
13653 " pvuuid device\n"
13654 "\n"
13655 msgstr ""
13656
13657 #. type: textblock
13658 #: ../fish/guestfish-actions.pod:3981 ../src/guestfs-actions.pod:6207
13659 msgid "This command returns the UUID of the LVM PV C<device>."
13660 msgstr ""
13661
13662 #. type: =head2
13663 #: ../fish/guestfish-actions.pod:3983
13664 msgid "pwrite"
13665 msgstr ""
13666
13667 #. type: verbatim
13668 #: ../fish/guestfish-actions.pod:3985
13669 #, no-wrap
13670 msgid ""
13671 " pwrite path content offset\n"
13672 "\n"
13673 msgstr ""
13674
13675 #. type: textblock
13676 #: ../fish/guestfish-actions.pod:3987 ../src/guestfs-actions.pod:6223
13677 msgid ""
13678 "This command writes to part of a file.  It writes the data buffer C<content> "
13679 "to the file C<path> starting at offset C<offset>."
13680 msgstr ""
13681
13682 #. type: textblock
13683 #: ../fish/guestfish-actions.pod:3990 ../src/guestfs-actions.pod:6226
13684 msgid ""
13685 "This command implements the L<pwrite(2)> system call, and like that system "
13686 "call it may not write the full data requested.  The return value is the "
13687 "number of bytes that were actually written to the file.  This could even be "
13688 "0, although short writes are unlikely for regular files in ordinary "
13689 "circumstances."
13690 msgstr ""
13691
13692 #. type: textblock
13693 #: ../fish/guestfish-actions.pod:3996
13694 msgid "See also L</pread>, L</pwrite-device>."
13695 msgstr ""
13696
13697 #. type: =head2
13698 #: ../fish/guestfish-actions.pod:4001
13699 msgid "pwrite-device"
13700 msgstr ""
13701
13702 #. type: verbatim
13703 #: ../fish/guestfish-actions.pod:4003
13704 #, no-wrap
13705 msgid ""
13706 " pwrite-device device content offset\n"
13707 "\n"
13708 msgstr ""
13709
13710 #. type: textblock
13711 #: ../fish/guestfish-actions.pod:4005 ../src/guestfs-actions.pod:6250
13712 msgid ""
13713 "This command writes to part of a device.  It writes the data buffer "
13714 "C<content> to C<device> starting at offset C<offset>."
13715 msgstr ""
13716
13717 #. type: textblock
13718 #: ../fish/guestfish-actions.pod:4008 ../src/guestfs-actions.pod:6253
13719 msgid ""
13720 "This command implements the L<pwrite(2)> system call, and like that system "
13721 "call it may not write the full data requested (although short writes to disk "
13722 "devices and partitions are probably impossible with standard Linux kernels)."
13723 msgstr ""
13724
13725 #. type: textblock
13726 #: ../fish/guestfish-actions.pod:4013
13727 msgid "See also L</pwrite>."
13728 msgstr ""
13729
13730 #. type: =head2
13731 #: ../fish/guestfish-actions.pod:4018
13732 msgid "read-file"
13733 msgstr ""
13734
13735 #. type: verbatim
13736 #: ../fish/guestfish-actions.pod:4020
13737 #, no-wrap
13738 msgid ""
13739 " read-file path\n"
13740 "\n"
13741 msgstr ""
13742
13743 #. type: textblock
13744 #: ../fish/guestfish-actions.pod:4022 ../src/guestfs-actions.pod:6274
13745 msgid "This calls returns the contents of the file C<path> as a buffer."
13746 msgstr ""
13747
13748 #. type: textblock
13749 #: ../fish/guestfish-actions.pod:4025
13750 msgid ""
13751 "Unlike L</cat>, this function can correctly handle files that contain "
13752 "embedded ASCII NUL characters.  However unlike L</download>, this function "
13753 "is limited in the total size of file that can be handled."
13754 msgstr ""
13755
13756 #. type: =head2
13757 #: ../fish/guestfish-actions.pod:4033
13758 msgid "read-lines"
13759 msgstr ""
13760
13761 #. type: verbatim
13762 #: ../fish/guestfish-actions.pod:4035
13763 #, no-wrap
13764 msgid ""
13765 " read-lines path\n"
13766 "\n"
13767 msgstr ""
13768
13769 #. type: textblock
13770 #: ../fish/guestfish-actions.pod:4039 ../src/guestfs-actions.pod:6299
13771 msgid ""
13772 "The file contents are returned as a list of lines.  Trailing C<LF> and "
13773 "C<CRLF> character sequences are I<not> returned."
13774 msgstr ""
13775
13776 #. type: textblock
13777 #: ../fish/guestfish-actions.pod:4042
13778 msgid ""
13779 "Note that this function cannot correctly handle binary files (specifically, "
13780 "files containing C<\\0> character which is treated as end of line).  For "
13781 "those you need to use the L</read-file> function which has a more complex "
13782 "interface."
13783 msgstr ""
13784
13785 #. type: =head2
13786 #: ../fish/guestfish-actions.pod:4047
13787 msgid "readdir"
13788 msgstr ""
13789
13790 #. type: verbatim
13791 #: ../fish/guestfish-actions.pod:4049
13792 #, no-wrap
13793 msgid ""
13794 " readdir dir\n"
13795 "\n"
13796 msgstr ""
13797
13798 #. type: textblock
13799 #: ../fish/guestfish-actions.pod:4051 ../src/guestfs-actions.pod:6319
13800 msgid "This returns the list of directory entries in directory C<dir>."
13801 msgstr ""
13802
13803 #. type: textblock
13804 #: ../fish/guestfish-actions.pod:4053 ../src/guestfs-actions.pod:6321
13805 msgid ""
13806 "All entries in the directory are returned, including C<.> and C<..>.  The "
13807 "entries are I<not> sorted, but returned in the same order as the underlying "
13808 "filesystem."
13809 msgstr ""
13810
13811 #. type: textblock
13812 #: ../fish/guestfish-actions.pod:4057 ../src/guestfs-actions.pod:6325
13813 msgid ""
13814 "Also this call returns basic file type information about each file.  The "
13815 "C<ftyp> field will contain one of the following characters:"
13816 msgstr ""
13817
13818 #. type: =item
13819 #: ../fish/guestfish-actions.pod:4062 ../src/guestfs-actions.pod:6330
13820 msgid "'b'"
13821 msgstr ""
13822
13823 #. type: textblock
13824 #: ../fish/guestfish-actions.pod:4064 ../src/guestfs-actions.pod:6332
13825 msgid "Block special"
13826 msgstr ""
13827
13828 #. type: =item
13829 #: ../fish/guestfish-actions.pod:4066 ../src/guestfs-actions.pod:6334
13830 msgid "'c'"
13831 msgstr ""
13832
13833 #. type: textblock
13834 #: ../fish/guestfish-actions.pod:4068 ../src/guestfs-actions.pod:6336
13835 msgid "Char special"
13836 msgstr ""
13837
13838 #. type: =item
13839 #: ../fish/guestfish-actions.pod:4070 ../src/guestfs-actions.pod:6338
13840 msgid "'d'"
13841 msgstr ""
13842
13843 #. type: textblock
13844 #: ../fish/guestfish-actions.pod:4072 ../src/guestfs-actions.pod:6340
13845 msgid "Directory"
13846 msgstr ""
13847
13848 #. type: =item
13849 #: ../fish/guestfish-actions.pod:4074 ../src/guestfs-actions.pod:6342
13850 msgid "'f'"
13851 msgstr ""
13852
13853 #. type: textblock
13854 #: ../fish/guestfish-actions.pod:4076 ../src/guestfs-actions.pod:6344
13855 msgid "FIFO (named pipe)"
13856 msgstr ""
13857
13858 #. type: =item
13859 #: ../fish/guestfish-actions.pod:4078 ../src/guestfs-actions.pod:6346
13860 msgid "'l'"
13861 msgstr ""
13862
13863 #. type: textblock
13864 #: ../fish/guestfish-actions.pod:4080 ../src/guestfs-actions.pod:6348
13865 msgid "Symbolic link"
13866 msgstr ""
13867
13868 #. type: =item
13869 #: ../fish/guestfish-actions.pod:4082 ../src/guestfs-actions.pod:6350
13870 msgid "'r'"
13871 msgstr ""
13872
13873 #. type: textblock
13874 #: ../fish/guestfish-actions.pod:4084 ../src/guestfs-actions.pod:6352
13875 msgid "Regular file"
13876 msgstr ""
13877
13878 #. type: =item
13879 #: ../fish/guestfish-actions.pod:4086 ../src/guestfs-actions.pod:6354
13880 msgid "'s'"
13881 msgstr ""
13882
13883 #. type: textblock
13884 #: ../fish/guestfish-actions.pod:4088 ../src/guestfs-actions.pod:6356
13885 msgid "Socket"
13886 msgstr ""
13887
13888 #. type: =item
13889 #: ../fish/guestfish-actions.pod:4090 ../src/guestfs-actions.pod:6358
13890 msgid "'u'"
13891 msgstr ""
13892
13893 #. type: textblock
13894 #: ../fish/guestfish-actions.pod:4092 ../src/guestfs-actions.pod:6360
13895 msgid "Unknown file type"
13896 msgstr ""
13897
13898 #. type: =item
13899 #: ../fish/guestfish-actions.pod:4094 ../src/guestfs-actions.pod:6362
13900 msgid "'?'"
13901 msgstr ""
13902
13903 #. type: textblock
13904 #: ../fish/guestfish-actions.pod:4096 ../src/guestfs-actions.pod:6364
13905 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
13906 msgstr ""
13907
13908 #. type: textblock
13909 #: ../fish/guestfish-actions.pod:4101
13910 msgid ""
13911 "This function is primarily intended for use by programs.  To get a simple "
13912 "list of names, use L</ls>.  To get a printable directory for human "
13913 "consumption, use L</ll>."
13914 msgstr ""
13915
13916 #. type: =head2
13917 #: ../fish/guestfish-actions.pod:4105
13918 msgid "readlink"
13919 msgstr ""
13920
13921 #. type: verbatim
13922 #: ../fish/guestfish-actions.pod:4107
13923 #, no-wrap
13924 msgid ""
13925 " readlink path\n"
13926 "\n"
13927 msgstr ""
13928
13929 #. type: textblock
13930 #: ../fish/guestfish-actions.pod:4109 ../src/guestfs-actions.pod:6385
13931 msgid "This command reads the target of a symbolic link."
13932 msgstr ""
13933
13934 #. type: =head2
13935 #: ../fish/guestfish-actions.pod:4111
13936 msgid "readlinklist"
13937 msgstr ""
13938
13939 #. type: verbatim
13940 #: ../fish/guestfish-actions.pod:4113
13941 #, no-wrap
13942 msgid ""
13943 " readlinklist path 'names ...'\n"
13944 "\n"
13945 msgstr ""
13946
13947 #. type: textblock
13948 #: ../fish/guestfish-actions.pod:4115 ../src/guestfs-actions.pod:6399
13949 msgid ""
13950 "This call allows you to do a C<readlink> operation on multiple files, where "
13951 "all files are in the directory C<path>.  C<names> is the list of files from "
13952 "this directory."
13953 msgstr ""
13954
13955 #. type: textblock
13956 #: ../fish/guestfish-actions.pod:4119 ../src/guestfs-actions.pod:6403
13957 msgid ""
13958 "On return you get a list of strings, with a one-to-one correspondence to the "
13959 "C<names> list.  Each string is the value of the symbolic link."
13960 msgstr ""
13961
13962 #. type: textblock
13963 #: ../fish/guestfish-actions.pod:4123 ../src/guestfs-actions.pod:6407
13964 msgid ""
13965 "If the C<readlink(2)> operation fails on any name, then the corresponding "
13966 "result string is the empty string C<\"\">.  However the whole operation is "
13967 "completed even if there were C<readlink(2)> errors, and so you can call this "
13968 "function with names where you don't know if they are symbolic links already "
13969 "(albeit slightly less efficient)."
13970 msgstr ""
13971
13972 #. type: textblock
13973 #: ../fish/guestfish-actions.pod:4130 ../src/guestfs-actions.pod:6414
13974 msgid ""
13975 "This call is intended for programs that want to efficiently list a directory "
13976 "contents without making many round-trips.  Very long directory listings "
13977 "might cause the protocol message size to be exceeded, causing this call to "
13978 "fail.  The caller must split up such requests into smaller groups of names."
13979 msgstr ""
13980
13981 #. type: =head2
13982 #: ../fish/guestfish-actions.pod:4137
13983 msgid "realpath"
13984 msgstr ""
13985
13986 #. type: verbatim
13987 #: ../fish/guestfish-actions.pod:4139
13988 #, no-wrap
13989 msgid ""
13990 " realpath path\n"
13991 "\n"
13992 msgstr ""
13993
13994 #. type: textblock
13995 #: ../fish/guestfish-actions.pod:4141 ../src/guestfs-actions.pod:6433
13996 msgid ""
13997 "Return the canonicalized absolute pathname of C<path>.  The returned path "
13998 "has no C<.>, C<..> or symbolic link path elements."
13999 msgstr ""
14000
14001 #. type: =head2
14002 #: ../fish/guestfish-actions.pod:4144
14003 msgid "removexattr"
14004 msgstr ""
14005
14006 #. type: verbatim
14007 #: ../fish/guestfish-actions.pod:4146
14008 #, no-wrap
14009 msgid ""
14010 " removexattr xattr path\n"
14011 "\n"
14012 msgstr ""
14013
14014 #. type: textblock
14015 #: ../fish/guestfish-actions.pod:4148 ../src/guestfs-actions.pod:6448
14016 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
14017 msgstr ""
14018
14019 #. type: textblock
14020 #: ../fish/guestfish-actions.pod:4151
14021 msgid "See also: L</lremovexattr>, L<attr(5)>."
14022 msgstr ""
14023
14024 #. type: =head2
14025 #: ../fish/guestfish-actions.pod:4153
14026 msgid "resize2fs"
14027 msgstr ""
14028
14029 #. type: verbatim
14030 #: ../fish/guestfish-actions.pod:4155
14031 #, no-wrap
14032 msgid ""
14033 " resize2fs device\n"
14034 "\n"
14035 msgstr ""
14036
14037 #. type: textblock
14038 #: ../fish/guestfish-actions.pod:4157 ../src/guestfs-actions.pod:6463
14039 msgid ""
14040 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
14041 "underlying device."
14042 msgstr ""
14043
14044 #. type: textblock
14045 #: ../fish/guestfish-actions.pod:4160
14046 msgid ""
14047 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
14048 "before calling this command.  For unknown reasons C<resize2fs> sometimes "
14049 "gives an error about this and sometimes not.  In any case, it is always safe "
14050 "to call L</e2fsck-f> before calling this function."
14051 msgstr ""
14052
14053 #. type: =head2
14054 #: ../fish/guestfish-actions.pod:4166
14055 msgid "resize2fs-M"
14056 msgstr ""
14057
14058 #. type: verbatim
14059 #: ../fish/guestfish-actions.pod:4168
14060 #, no-wrap
14061 msgid ""
14062 " resize2fs-M device\n"
14063 "\n"
14064 msgstr ""
14065
14066 #. type: textblock
14067 #: ../fish/guestfish-actions.pod:4170
14068 msgid ""
14069 "This command is the same as L</resize2fs>, but the filesystem is resized to "
14070 "its minimum size.  This works like the I<-M> option to the C<resize2fs> "
14071 "command."
14072 msgstr ""
14073
14074 #. type: textblock
14075 #: ../fish/guestfish-actions.pod:4174
14076 msgid ""
14077 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
14078 "and read the C<Block size> and C<Block count> values.  These two numbers, "
14079 "multiplied together, give the resulting size of the minimal filesystem in "
14080 "bytes."
14081 msgstr ""
14082
14083 #. type: =head2
14084 #: ../fish/guestfish-actions.pod:4179
14085 msgid "resize2fs-size"
14086 msgstr ""
14087
14088 #. type: verbatim
14089 #: ../fish/guestfish-actions.pod:4181
14090 #, no-wrap
14091 msgid ""
14092 " resize2fs-size device size\n"
14093 "\n"
14094 msgstr ""
14095
14096 #. type: textblock
14097 #: ../fish/guestfish-actions.pod:4183
14098 msgid ""
14099 "This command is the same as L</resize2fs> except that it allows you to "
14100 "specify the new size (in bytes) explicitly."
14101 msgstr ""
14102
14103 #. type: =head2
14104 #: ../fish/guestfish-actions.pod:4186
14105 msgid "rm"
14106 msgstr ""
14107
14108 #. type: verbatim
14109 #: ../fish/guestfish-actions.pod:4188
14110 #, no-wrap
14111 msgid ""
14112 " rm path\n"
14113 "\n"
14114 msgstr ""
14115
14116 #. type: textblock
14117 #: ../fish/guestfish-actions.pod:4190 ../src/guestfs-actions.pod:6515
14118 msgid "Remove the single file C<path>."
14119 msgstr ""
14120
14121 #. type: =head2
14122 #: ../fish/guestfish-actions.pod:4192
14123 msgid "rm-rf"
14124 msgstr ""
14125
14126 #. type: verbatim
14127 #: ../fish/guestfish-actions.pod:4194
14128 #, no-wrap
14129 msgid ""
14130 " rm-rf path\n"
14131 "\n"
14132 msgstr ""
14133
14134 #. type: textblock
14135 #: ../fish/guestfish-actions.pod:4196 ../src/guestfs-actions.pod:6527
14136 msgid ""
14137 "Remove the file or directory C<path>, recursively removing the contents if "
14138 "its a directory.  This is like the C<rm -rf> shell command."
14139 msgstr ""
14140
14141 #. type: =head2
14142 #: ../fish/guestfish-actions.pod:4200
14143 msgid "rmdir"
14144 msgstr ""
14145
14146 #. type: verbatim
14147 #: ../fish/guestfish-actions.pod:4202
14148 #, no-wrap
14149 msgid ""
14150 " rmdir path\n"
14151 "\n"
14152 msgstr ""
14153
14154 #. type: textblock
14155 #: ../fish/guestfish-actions.pod:4204 ../src/guestfs-actions.pod:6541
14156 msgid "Remove the single directory C<path>."
14157 msgstr ""
14158
14159 #. type: =head2
14160 #: ../fish/guestfish-actions.pod:4206
14161 msgid "rmmountpoint"
14162 msgstr ""
14163
14164 #. type: verbatim
14165 #: ../fish/guestfish-actions.pod:4208
14166 #, no-wrap
14167 msgid ""
14168 " rmmountpoint exemptpath\n"
14169 "\n"
14170 msgstr ""
14171
14172 #. type: textblock
14173 #: ../fish/guestfish-actions.pod:4210
14174 msgid ""
14175 "This calls removes a mountpoint that was previously created with "
14176 "L</mkmountpoint>.  See L</mkmountpoint> for full details."
14177 msgstr ""
14178
14179 #. type: =head2
14180 #: ../fish/guestfish-actions.pod:4214
14181 msgid "scrub-device"
14182 msgstr ""
14183
14184 #. type: verbatim
14185 #: ../fish/guestfish-actions.pod:4216
14186 #, no-wrap
14187 msgid ""
14188 " scrub-device device\n"
14189 "\n"
14190 msgstr ""
14191
14192 #. type: textblock
14193 #: ../fish/guestfish-actions.pod:4218 ../src/guestfs-actions.pod:6567
14194 msgid ""
14195 "This command writes patterns over C<device> to make data retrieval more "
14196 "difficult."
14197 msgstr ""
14198
14199 #. type: textblock
14200 #: ../fish/guestfish-actions.pod:4221 ../fish/guestfish-actions.pod:4233 ../fish/guestfish-actions.pod:4246 ../src/guestfs-actions.pod:6570 ../src/guestfs-actions.pod:6588 ../src/guestfs-actions.pod:6607
14201 msgid ""
14202 "It is an interface to the L<scrub(1)> program.  See that manual page for "
14203 "more details."
14204 msgstr ""
14205
14206 #. type: =head2
14207 #: ../fish/guestfish-actions.pod:4224
14208 msgid "scrub-file"
14209 msgstr ""
14210
14211 #. type: verbatim
14212 #: ../fish/guestfish-actions.pod:4226
14213 #, no-wrap
14214 msgid ""
14215 " scrub-file file\n"
14216 "\n"
14217 msgstr ""
14218
14219 #. type: textblock
14220 #: ../fish/guestfish-actions.pod:4228 ../src/guestfs-actions.pod:6583
14221 msgid ""
14222 "This command writes patterns over a file to make data retrieval more "
14223 "difficult."
14224 msgstr ""
14225
14226 #. type: textblock
14227 #: ../fish/guestfish-actions.pod:4231 ../src/guestfs-actions.pod:6586
14228 msgid "The file is I<removed> after scrubbing."
14229 msgstr ""
14230
14231 #. type: =head2
14232 #: ../fish/guestfish-actions.pod:4236
14233 msgid "scrub-freespace"
14234 msgstr ""
14235
14236 #. type: verbatim
14237 #: ../fish/guestfish-actions.pod:4238
14238 #, no-wrap
14239 msgid ""
14240 " scrub-freespace dir\n"
14241 "\n"
14242 msgstr ""
14243
14244 #. type: textblock
14245 #: ../fish/guestfish-actions.pod:4240
14246 msgid ""
14247 "This command creates the directory C<dir> and then fills it with files until "
14248 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
14249 "deletes them.  The intention is to scrub any free space on the partition "
14250 "containing C<dir>."
14251 msgstr ""
14252
14253 #. type: =head2
14254 #: ../fish/guestfish-actions.pod:4249
14255 msgid "set-append"
14256 msgstr ""
14257
14258 #. type: =head2
14259 #: ../fish/guestfish-actions.pod:4251
14260 msgid "append"
14261 msgstr ""
14262
14263 #. type: verbatim
14264 #: ../fish/guestfish-actions.pod:4253
14265 #, no-wrap
14266 msgid ""
14267 " set-append append\n"
14268 "\n"
14269 msgstr ""
14270
14271 #. type: textblock
14272 #: ../fish/guestfish-actions.pod:4255 ../src/guestfs-actions.pod:6620
14273 msgid ""
14274 "This function is used to add additional options to the guest kernel command "
14275 "line."
14276 msgstr ""
14277
14278 #. type: textblock
14279 #: ../fish/guestfish-actions.pod:4258 ../src/guestfs-actions.pod:6623
14280 msgid ""
14281 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
14282 "environment variable."
14283 msgstr ""
14284
14285 #. type: textblock
14286 #: ../fish/guestfish-actions.pod:4261 ../src/guestfs-actions.pod:6626
14287 msgid ""
14288 "Setting C<append> to C<NULL> means I<no> additional options are passed "
14289 "(libguestfs always adds a few of its own)."
14290 msgstr ""
14291
14292 #. type: =head2
14293 #: ../fish/guestfish-actions.pod:4264
14294 msgid "set-attach-method"
14295 msgstr ""
14296
14297 #. type: =head2
14298 #: ../fish/guestfish-actions.pod:4266
14299 msgid "attach-method"
14300 msgstr ""
14301
14302 #. type: verbatim
14303 #: ../fish/guestfish-actions.pod:4268
14304 #, no-wrap
14305 msgid ""
14306 " set-attach-method attachmethod\n"
14307 "\n"
14308 msgstr ""
14309
14310 #. type: textblock
14311 #: ../fish/guestfish-actions.pod:4270 ../src/guestfs-actions.pod:6639
14312 msgid ""
14313 "Set the method that libguestfs uses to connect to the back end guestfsd "
14314 "daemon.  Possible methods are:"
14315 msgstr ""
14316
14317 #. type: =item
14318 #: ../fish/guestfish-actions.pod:4275 ../src/guestfs-actions.pod:6644 ../src/guestfs.pod:2916
14319 msgid "C<appliance>"
14320 msgstr ""
14321
14322 #. type: textblock
14323 #: ../fish/guestfish-actions.pod:4277 ../src/guestfs-actions.pod:6646
14324 msgid ""
14325 "Launch an appliance and connect to it.  This is the ordinary method and the "
14326 "default."
14327 msgstr ""
14328
14329 #. type: =item
14330 #: ../fish/guestfish-actions.pod:4280 ../src/guestfs-actions.pod:6649
14331 msgid "C<unix:I<path>>"
14332 msgstr ""
14333
14334 #. type: textblock
14335 #: ../fish/guestfish-actions.pod:4282 ../src/guestfs-actions.pod:6651
14336 msgid "Connect to the Unix domain socket I<path>."
14337 msgstr ""
14338
14339 #. type: textblock
14340 #: ../fish/guestfish-actions.pod:4284 ../src/guestfs-actions.pod:6653
14341 msgid ""
14342 "This method lets you connect to an existing daemon or (using virtio-serial) "
14343 "to a live guest.  For more information, see L<guestfs(3)/ATTACHING TO "
14344 "RUNNING DAEMONS>."
14345 msgstr ""
14346
14347 #. type: =head2
14348 #: ../fish/guestfish-actions.pod:4290
14349 msgid "set-autosync"
14350 msgstr ""
14351
14352 #. type: =head2
14353 #: ../fish/guestfish-actions.pod:4292
14354 msgid "autosync"
14355 msgstr ""
14356
14357 #. type: verbatim
14358 #: ../fish/guestfish-actions.pod:4294
14359 #, no-wrap
14360 msgid ""
14361 " set-autosync true|false\n"
14362 "\n"
14363 msgstr ""
14364
14365 #. type: textblock
14366 #: ../fish/guestfish-actions.pod:4296 ../src/guestfs-actions.pod:6669
14367 msgid ""
14368 "If C<autosync> is true, this enables autosync.  Libguestfs will make a best "
14369 "effort attempt to make filesystems consistent and synchronized when the "
14370 "handle is closed (also if the program exits without closing handles)."
14371 msgstr ""
14372
14373 #. type: textblock
14374 #: ../fish/guestfish-actions.pod:4301 ../src/guestfs-actions.pod:6674
14375 msgid ""
14376 "This is enabled by default (since libguestfs 1.5.24, previously it was "
14377 "disabled by default)."
14378 msgstr ""
14379
14380 #. type: =head2
14381 #: ../fish/guestfish-actions.pod:4304
14382 msgid "set-direct"
14383 msgstr ""
14384
14385 #. type: =head2
14386 #: ../fish/guestfish-actions.pod:4306
14387 msgid "direct"
14388 msgstr ""
14389
14390 #. type: verbatim
14391 #: ../fish/guestfish-actions.pod:4308
14392 #, no-wrap
14393 msgid ""
14394 " set-direct true|false\n"
14395 "\n"
14396 msgstr ""
14397
14398 #. type: textblock
14399 #: ../fish/guestfish-actions.pod:4310 ../src/guestfs-actions.pod:6687
14400 msgid ""
14401 "If the direct appliance mode flag is enabled, then stdin and stdout are "
14402 "passed directly through to the appliance once it is launched."
14403 msgstr ""
14404
14405 #. type: textblock
14406 #: ../fish/guestfish-actions.pod:4314
14407 msgid ""
14408 "One consequence of this is that log messages aren't caught by the library "
14409 "and handled by L</set-log-message-callback>, but go straight to stdout."
14410 msgstr ""
14411
14412 #. type: textblock
14413 #: ../fish/guestfish-actions.pod:4318 ../src/guestfs-actions.pod:6695
14414 msgid "You probably don't want to use this unless you know what you are doing."
14415 msgstr ""
14416
14417 #. type: textblock
14418 #: ../fish/guestfish-actions.pod:4321 ../src/guestfs-actions.pod:6698
14419 msgid "The default is disabled."
14420 msgstr ""
14421
14422 #. type: =head2
14423 #: ../fish/guestfish-actions.pod:4323
14424 msgid "set-e2label"
14425 msgstr ""
14426
14427 #. type: verbatim
14428 #: ../fish/guestfish-actions.pod:4325
14429 #, no-wrap
14430 msgid ""
14431 " set-e2label device label\n"
14432 "\n"
14433 msgstr ""
14434
14435 #. type: textblock
14436 #: ../fish/guestfish-actions.pod:4327 ../src/guestfs-actions.pod:6711
14437 msgid ""
14438 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
14439 "C<label>.  Filesystem labels are limited to 16 characters."
14440 msgstr ""
14441
14442 #. type: textblock
14443 #: ../fish/guestfish-actions.pod:4331
14444 msgid ""
14445 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
14446 "label on a filesystem."
14447 msgstr ""
14448
14449 #. type: =head2
14450 #: ../fish/guestfish-actions.pod:4334
14451 msgid "set-e2uuid"
14452 msgstr ""
14453
14454 #. type: verbatim
14455 #: ../fish/guestfish-actions.pod:4336
14456 #, no-wrap
14457 msgid ""
14458 " set-e2uuid device uuid\n"
14459 "\n"
14460 msgstr ""
14461
14462 #. type: textblock
14463 #: ../fish/guestfish-actions.pod:4338 ../src/guestfs-actions.pod:6729
14464 msgid ""
14465 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
14466 "C<uuid>.  The format of the UUID and alternatives such as C<clear>, "
14467 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
14468 msgstr ""
14469
14470 #. type: textblock
14471 #: ../fish/guestfish-actions.pod:4343
14472 msgid ""
14473 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
14474 "UUID of a filesystem."
14475 msgstr ""
14476
14477 #. type: =head2
14478 #: ../fish/guestfish-actions.pod:4346
14479 msgid "set-memsize"
14480 msgstr ""
14481
14482 #. type: =head2
14483 #: ../fish/guestfish-actions.pod:4348
14484 msgid "memsize"
14485 msgstr ""
14486
14487 #. type: verbatim
14488 #: ../fish/guestfish-actions.pod:4350
14489 #, no-wrap
14490 msgid ""
14491 " set-memsize memsize\n"
14492 "\n"
14493 msgstr ""
14494
14495 #. type: textblock
14496 #: ../fish/guestfish-actions.pod:4352
14497 msgid ""
14498 "This sets the memory size in megabytes allocated to the qemu subprocess.  "
14499 "This only has any effect if called before L</launch>."
14500 msgstr ""
14501
14502 #. type: textblock
14503 #: ../fish/guestfish-actions.pod:4356 ../src/guestfs-actions.pod:6751
14504 msgid ""
14505 "You can also change this by setting the environment variable "
14506 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
14507 msgstr ""
14508
14509 #. type: =head2
14510 #: ../fish/guestfish-actions.pod:4363
14511 msgid "set-network"
14512 msgstr ""
14513
14514 #. type: =head2
14515 #: ../fish/guestfish-actions.pod:4365
14516 msgid "network"
14517 msgstr ""
14518
14519 #. type: verbatim
14520 #: ../fish/guestfish-actions.pod:4367
14521 #, no-wrap
14522 msgid ""
14523 " set-network true|false\n"
14524 "\n"
14525 msgstr ""
14526
14527 #. type: textblock
14528 #: ../fish/guestfish-actions.pod:4369 ../src/guestfs-actions.pod:6768
14529 msgid ""
14530 "If C<network> is true, then the network is enabled in the libguestfs "
14531 "appliance.  The default is false."
14532 msgstr ""
14533
14534 #. type: textblock
14535 #: ../fish/guestfish-actions.pod:4372 ../src/guestfs-actions.pod:6771
14536 msgid ""
14537 "This affects whether commands are able to access the network (see "
14538 "L<guestfs(3)/RUNNING COMMANDS>)."
14539 msgstr ""
14540
14541 #. type: textblock
14542 #: ../fish/guestfish-actions.pod:4375
14543 msgid "You must call this before calling L</launch>, otherwise it has no effect."
14544 msgstr ""
14545
14546 #. type: =head2
14547 #: ../fish/guestfish-actions.pod:4378
14548 msgid "set-path"
14549 msgstr ""
14550
14551 #. type: verbatim
14552 #: ../fish/guestfish-actions.pod:4382
14553 #, no-wrap
14554 msgid ""
14555 " set-path searchpath\n"
14556 "\n"
14557 msgstr ""
14558
14559 #. type: textblock
14560 #: ../fish/guestfish-actions.pod:4384 ../src/guestfs-actions.pod:6787
14561 msgid "Set the path that libguestfs searches for kernel and initrd.img."
14562 msgstr ""
14563
14564 #. type: textblock
14565 #: ../fish/guestfish-actions.pod:4386 ../src/guestfs-actions.pod:6789
14566 msgid ""
14567 "The default is C<$libdir/guestfs> unless overridden by setting "
14568 "C<LIBGUESTFS_PATH> environment variable."
14569 msgstr ""
14570
14571 #. type: textblock
14572 #: ../fish/guestfish-actions.pod:4389 ../src/guestfs-actions.pod:6792
14573 msgid "Setting C<path> to C<NULL> restores the default path."
14574 msgstr ""
14575
14576 #. type: =head2
14577 #: ../fish/guestfish-actions.pod:4391
14578 msgid "set-pgroup"
14579 msgstr ""
14580
14581 #. type: =head2
14582 #: ../fish/guestfish-actions.pod:4393
14583 msgid "pgroup"
14584 msgstr ""
14585
14586 #. type: verbatim
14587 #: ../fish/guestfish-actions.pod:4395
14588 #, no-wrap
14589 msgid ""
14590 " set-pgroup true|false\n"
14591 "\n"
14592 msgstr ""
14593
14594 #. type: textblock
14595 #: ../fish/guestfish-actions.pod:4397 ../src/guestfs-actions.pod:6804
14596 msgid ""
14597 "If C<pgroup> is true, child processes are placed into their own process "
14598 "group."
14599 msgstr ""
14600
14601 #. type: textblock
14602 #: ../fish/guestfish-actions.pod:4400 ../src/guestfs-actions.pod:6807
14603 msgid ""
14604 "The practical upshot of this is that signals like C<SIGINT> (from users "
14605 "pressing C<^C>) won't be received by the child process."
14606 msgstr ""
14607
14608 #. type: textblock
14609 #: ../fish/guestfish-actions.pod:4403 ../src/guestfs-actions.pod:6810
14610 msgid ""
14611 "The default for this flag is false, because usually you want C<^C> to kill "
14612 "the subprocess."
14613 msgstr ""
14614
14615 #. type: =head2
14616 #: ../fish/guestfish-actions.pod:4406
14617 msgid "set-qemu"
14618 msgstr ""
14619
14620 #. type: =head2
14621 #: ../fish/guestfish-actions.pod:4408
14622 msgid "qemu"
14623 msgstr ""
14624
14625 #. type: verbatim
14626 #: ../fish/guestfish-actions.pod:4410
14627 #, no-wrap
14628 msgid ""
14629 " set-qemu qemu\n"
14630 "\n"
14631 msgstr ""
14632
14633 #. type: textblock
14634 #: ../fish/guestfish-actions.pod:4412 ../src/guestfs-actions.pod:6823
14635 msgid "Set the qemu binary that we will use."
14636 msgstr ""
14637
14638 #. type: textblock
14639 #: ../fish/guestfish-actions.pod:4414 ../src/guestfs-actions.pod:6825
14640 msgid "The default is chosen when the library was compiled by the configure script."
14641 msgstr ""
14642
14643 #. type: textblock
14644 #: ../fish/guestfish-actions.pod:4417 ../src/guestfs-actions.pod:6828
14645 msgid ""
14646 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
14647 "variable."
14648 msgstr ""
14649
14650 #. type: textblock
14651 #: ../fish/guestfish-actions.pod:4420 ../src/guestfs-actions.pod:6831
14652 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
14653 msgstr ""
14654
14655 #. type: textblock
14656 #: ../fish/guestfish-actions.pod:4422 ../src/guestfs-actions.pod:6833
14657 msgid ""
14658 "Note that you should call this function as early as possible after creating "
14659 "the handle.  This is because some pre-launch operations depend on testing "
14660 "qemu features (by running C<qemu -help>).  If the qemu binary changes, we "
14661 "don't retest features, and so you might see inconsistent results.  Using the "
14662 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
14663 "the qemu binary at the same time as the handle is created."
14664 msgstr ""
14665
14666 #. type: =head2
14667 #: ../fish/guestfish-actions.pod:4430
14668 msgid "set-recovery-proc"
14669 msgstr ""
14670
14671 #. type: =head2
14672 #: ../fish/guestfish-actions.pod:4432
14673 msgid "recovery-proc"
14674 msgstr ""
14675
14676 #. type: verbatim
14677 #: ../fish/guestfish-actions.pod:4434
14678 #, no-wrap
14679 msgid ""
14680 " set-recovery-proc true|false\n"
14681 "\n"
14682 msgstr ""
14683
14684 #. type: textblock
14685 #: ../fish/guestfish-actions.pod:4436
14686 msgid ""
14687 "If this is called with the parameter C<false> then L</launch> does not "
14688 "create a recovery process.  The purpose of the recovery process is to stop "
14689 "runaway qemu processes in the case where the main program aborts abruptly."
14690 msgstr ""
14691
14692 #. type: textblock
14693 #: ../fish/guestfish-actions.pod:4441
14694 msgid ""
14695 "This only has any effect if called before L</launch>, and the default is "
14696 "true."
14697 msgstr ""
14698
14699 #. type: textblock
14700 #: ../fish/guestfish-actions.pod:4444 ../src/guestfs-actions.pod:6859
14701 msgid ""
14702 "About the only time when you would want to disable this is if the main "
14703 "process will fork itself into the background (\"daemonize\" itself).  In "
14704 "this case the recovery process thinks that the main program has disappeared "
14705 "and so kills qemu, which is not very helpful."
14706 msgstr ""
14707
14708 #. type: =head2
14709 #: ../fish/guestfish-actions.pod:4450
14710 msgid "set-selinux"
14711 msgstr ""
14712
14713 #. type: =head2
14714 #: ../fish/guestfish-actions.pod:4452
14715 msgid "selinux"
14716 msgstr ""
14717
14718 #. type: verbatim
14719 #: ../fish/guestfish-actions.pod:4454
14720 #, no-wrap
14721 msgid ""
14722 " set-selinux true|false\n"
14723 "\n"
14724 msgstr ""
14725
14726 #. type: textblock
14727 #: ../fish/guestfish-actions.pod:4456 ../src/guestfs-actions.pod:6875
14728 msgid ""
14729 "This sets the selinux flag that is passed to the appliance at boot time.  "
14730 "The default is C<selinux=0> (disabled)."
14731 msgstr ""
14732
14733 #. type: textblock
14734 #: ../fish/guestfish-actions.pod:4459 ../src/guestfs-actions.pod:6878
14735 msgid ""
14736 "Note that if SELinux is enabled, it is always in Permissive mode "
14737 "(C<enforcing=0>)."
14738 msgstr ""
14739
14740 #. type: =head2
14741 #: ../fish/guestfish-actions.pod:4465
14742 msgid "set-smp"
14743 msgstr ""
14744
14745 #. type: =head2
14746 #: ../fish/guestfish-actions.pod:4467
14747 msgid "smp"
14748 msgstr ""
14749
14750 #. type: verbatim
14751 #: ../fish/guestfish-actions.pod:4469
14752 #, no-wrap
14753 msgid ""
14754 " set-smp smp\n"
14755 "\n"
14756 msgstr ""
14757
14758 #. type: textblock
14759 #: ../fish/guestfish-actions.pod:4471 ../src/guestfs-actions.pod:6894
14760 msgid ""
14761 "Change the number of virtual CPUs assigned to the appliance.  The default is "
14762 "C<1>.  Increasing this may improve performance, though often it has no "
14763 "effect."
14764 msgstr ""
14765
14766 #. type: textblock
14767 #: ../fish/guestfish-actions.pod:4475
14768 msgid "This function must be called before L</launch>."
14769 msgstr ""
14770
14771 #. type: =head2
14772 #: ../fish/guestfish-actions.pod:4477
14773 msgid "set-trace"
14774 msgstr ""
14775
14776 #. type: =head2
14777 #: ../fish/guestfish-actions.pod:4479
14778 msgid "trace"
14779 msgstr ""
14780
14781 #. type: verbatim
14782 #: ../fish/guestfish-actions.pod:4481
14783 #, no-wrap
14784 msgid ""
14785 " set-trace true|false\n"
14786 "\n"
14787 msgstr ""
14788
14789 #. type: textblock
14790 #: ../fish/guestfish-actions.pod:4483 ../src/guestfs-actions.pod:6910
14791 msgid ""
14792 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
14793 "return values are traced."
14794 msgstr ""
14795
14796 #. type: textblock
14797 #: ../fish/guestfish-actions.pod:4486 ../src/guestfs-actions.pod:6913
14798 msgid ""
14799 "If you want to trace C API calls into libguestfs (and other libraries) then "
14800 "possibly a better way is to use the external ltrace(1) command."
14801 msgstr ""
14802
14803 #. type: textblock
14804 #: ../fish/guestfish-actions.pod:4490 ../src/guestfs-actions.pod:6917
14805 msgid ""
14806 "Command traces are disabled unless the environment variable "
14807 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
14808 msgstr ""
14809
14810 #. type: textblock
14811 #: ../fish/guestfish-actions.pod:4493
14812 msgid ""
14813 "Trace messages are normally sent to C<stderr>, unless you register a "
14814 "callback to send them somewhere else (see L</set-event-callback>)."
14815 msgstr ""
14816
14817 #. type: =head2
14818 #: ../fish/guestfish-actions.pod:4497
14819 msgid "set-verbose"
14820 msgstr ""
14821
14822 #. type: =head2
14823 #: ../fish/guestfish-actions.pod:4499
14824 msgid "verbose"
14825 msgstr ""
14826
14827 #. type: verbatim
14828 #: ../fish/guestfish-actions.pod:4501
14829 #, no-wrap
14830 msgid ""
14831 " set-verbose true|false\n"
14832 "\n"
14833 msgstr ""
14834
14835 #. type: textblock
14836 #: ../fish/guestfish-actions.pod:4503 ../src/guestfs-actions.pod:6934
14837 msgid "If C<verbose> is true, this turns on verbose messages."
14838 msgstr ""
14839
14840 #. type: textblock
14841 #: ../fish/guestfish-actions.pod:4505 ../src/guestfs-actions.pod:6936
14842 msgid ""
14843 "Verbose messages are disabled unless the environment variable "
14844 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
14845 msgstr ""
14846
14847 #. type: textblock
14848 #: ../fish/guestfish-actions.pod:4508
14849 msgid ""
14850 "Verbose messages are normally sent to C<stderr>, unless you register a "
14851 "callback to send them somewhere else (see L</set-event-callback>)."
14852 msgstr ""
14853
14854 #. type: =head2
14855 #: ../fish/guestfish-actions.pod:4512
14856 msgid "setcon"
14857 msgstr ""
14858
14859 #. type: verbatim
14860 #: ../fish/guestfish-actions.pod:4514
14861 #, no-wrap
14862 msgid ""
14863 " setcon context\n"
14864 "\n"
14865 msgstr ""
14866
14867 #. type: textblock
14868 #: ../fish/guestfish-actions.pod:4516 ../src/guestfs-actions.pod:6953
14869 msgid ""
14870 "This sets the SELinux security context of the daemon to the string "
14871 "C<context>."
14872 msgstr ""
14873
14874 #. type: textblock
14875 #: ../fish/guestfish-actions.pod:4519 ../src/guestfs-actions.pod:6956
14876 msgid "See the documentation about SELINUX in L<guestfs(3)>."
14877 msgstr ""
14878
14879 #. type: =head2
14880 #: ../fish/guestfish-actions.pod:4521
14881 msgid "setxattr"
14882 msgstr ""
14883
14884 #. type: verbatim
14885 #: ../fish/guestfish-actions.pod:4523
14886 #, no-wrap
14887 msgid ""
14888 " setxattr xattr val vallen path\n"
14889 "\n"
14890 msgstr ""
14891
14892 #. type: textblock
14893 #: ../fish/guestfish-actions.pod:4525 ../src/guestfs-actions.pod:6971
14894 msgid ""
14895 "This call sets the extended attribute named C<xattr> of the file C<path> to "
14896 "the value C<val> (of length C<vallen>).  The value is arbitrary 8 bit data."
14897 msgstr ""
14898
14899 #. type: textblock
14900 #: ../fish/guestfish-actions.pod:4529
14901 msgid "See also: L</lsetxattr>, L<attr(5)>."
14902 msgstr ""
14903
14904 #. type: =head2
14905 #: ../fish/guestfish-actions.pod:4531
14906 msgid "sfdisk"
14907 msgstr ""
14908
14909 #. type: verbatim
14910 #: ../fish/guestfish-actions.pod:4533
14911 #, no-wrap
14912 msgid ""
14913 " sfdisk device cyls heads sectors 'lines ...'\n"
14914 "\n"
14915 msgstr ""
14916
14917 #. type: textblock
14918 #: ../fish/guestfish-actions.pod:4535 ../src/guestfs-actions.pod:6998
14919 msgid ""
14920 "This is a direct interface to the L<sfdisk(8)> program for creating "
14921 "partitions on block devices."
14922 msgstr ""
14923
14924 #. type: textblock
14925 #: ../fish/guestfish-actions.pod:4538 ../src/guestfs-actions.pod:7001
14926 msgid "C<device> should be a block device, for example C</dev/sda>."
14927 msgstr ""
14928
14929 #. type: textblock
14930 #: ../fish/guestfish-actions.pod:4540 ../src/guestfs-actions.pod:7003
14931 msgid ""
14932 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
14933 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
14934 "I<-H> and I<-S> parameters.  If you pass C<0> for any of these, then the "
14935 "corresponding parameter is omitted.  Usually for 'large' disks, you can just "
14936 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
14937 "the kernel) cannot work out the right geometry and you will need to tell it."
14938 msgstr ""
14939
14940 #. type: textblock
14941 #: ../fish/guestfish-actions.pod:4548 ../src/guestfs-actions.pod:7011
14942 msgid ""
14943 "C<lines> is a list of lines that we feed to C<sfdisk>.  For more information "
14944 "refer to the L<sfdisk(8)> manpage."
14945 msgstr ""
14946
14947 #. type: textblock
14948 #: ../fish/guestfish-actions.pod:4551 ../src/guestfs-actions.pod:7014
14949 msgid ""
14950 "To create a single partition occupying the whole disk, you would pass "
14951 "C<lines> as a single element list, when the single element being the string "
14952 "C<,> (comma)."
14953 msgstr ""
14954
14955 #. type: textblock
14956 #: ../fish/guestfish-actions.pod:4555
14957 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
14958 msgstr ""
14959
14960 #. type: textblock
14961 #: ../fish/guestfish-actions.pod:4558 ../fish/guestfish-actions.pod:4578 ../fish/guestfish-actions.pod:4597
14962 msgid ""
14963 "I<This function is deprecated.> In new code, use the L</part_add> call "
14964 "instead."
14965 msgstr ""
14966
14967 #. type: =head2
14968 #: ../fish/guestfish-actions.pod:4565
14969 msgid "sfdiskM"
14970 msgstr ""
14971
14972 #. type: verbatim
14973 #: ../fish/guestfish-actions.pod:4567
14974 #, no-wrap
14975 msgid ""
14976 " sfdiskM device 'lines ...'\n"
14977 "\n"
14978 msgstr ""
14979
14980 #. type: textblock
14981 #: ../fish/guestfish-actions.pod:4569
14982 msgid ""
14983 "This is a simplified interface to the L</sfdisk> command, where partition "
14984 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
14985 "you don't need to specify the cyls, heads and sectors parameters which were "
14986 "rarely if ever used anyway."
14987 msgstr ""
14988
14989 #. type: textblock
14990 #: ../fish/guestfish-actions.pod:4575
14991 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
14992 msgstr ""
14993
14994 #. type: =head2
14995 #: ../fish/guestfish-actions.pod:4585
14996 msgid "sfdisk-N"
14997 msgstr ""
14998
14999 #. type: verbatim
15000 #: ../fish/guestfish-actions.pod:4587
15001 #, no-wrap
15002 msgid ""
15003 " sfdisk-N device partnum cyls heads sectors line\n"
15004 "\n"
15005 msgstr ""
15006
15007 #. type: textblock
15008 #: ../fish/guestfish-actions.pod:4589 ../src/guestfs-actions.pod:7070
15009 msgid ""
15010 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
15011 "(note: C<n> counts from 1)."
15012 msgstr ""
15013
15014 #. type: textblock
15015 #: ../fish/guestfish-actions.pod:4592
15016 msgid ""
15017 "For other parameters, see L</sfdisk>.  You should usually pass C<0> for the "
15018 "cyls/heads/sectors parameters."
15019 msgstr ""
15020
15021 #. type: textblock
15022 #: ../fish/guestfish-actions.pod:4595
15023 msgid "See also: L</part-add>"
15024 msgstr ""
15025
15026 #. type: =head2
15027 #: ../fish/guestfish-actions.pod:4604
15028 msgid "sfdisk-disk-geometry"
15029 msgstr ""
15030
15031 #. type: verbatim
15032 #: ../fish/guestfish-actions.pod:4606
15033 #, no-wrap
15034 msgid ""
15035 " sfdisk-disk-geometry device\n"
15036 "\n"
15037 msgstr ""
15038
15039 #. type: textblock
15040 #: ../fish/guestfish-actions.pod:4608
15041 msgid ""
15042 "This displays the disk geometry of C<device> read from the partition table.  "
15043 "Especially in the case where the underlying block device has been resized, "
15044 "this can be different from the kernel's idea of the geometry (see "
15045 "L</sfdisk-kernel-geometry>)."
15046 msgstr ""
15047
15048 #. type: textblock
15049 #: ../fish/guestfish-actions.pod:4613 ../fish/guestfish-actions.pod:4622 ../src/guestfs-actions.pod:7093 ../src/guestfs-actions.pod:7109
15050 msgid "The result is in human-readable format, and not designed to be parsed."
15051 msgstr ""
15052
15053 #. type: =head2
15054 #: ../fish/guestfish-actions.pod:4616
15055 msgid "sfdisk-kernel-geometry"
15056 msgstr ""
15057
15058 #. type: verbatim
15059 #: ../fish/guestfish-actions.pod:4618
15060 #, no-wrap
15061 msgid ""
15062 " sfdisk-kernel-geometry device\n"
15063 "\n"
15064 msgstr ""
15065
15066 #. type: textblock
15067 #: ../fish/guestfish-actions.pod:4620 ../src/guestfs-actions.pod:7107
15068 msgid "This displays the kernel's idea of the geometry of C<device>."
15069 msgstr ""
15070
15071 #. type: =head2
15072 #: ../fish/guestfish-actions.pod:4625
15073 msgid "sfdisk-l"
15074 msgstr ""
15075
15076 #. type: verbatim
15077 #: ../fish/guestfish-actions.pod:4627
15078 #, no-wrap
15079 msgid ""
15080 " sfdisk-l device\n"
15081 "\n"
15082 msgstr ""
15083
15084 #. type: textblock
15085 #: ../fish/guestfish-actions.pod:4629 ../src/guestfs-actions.pod:7130
15086 msgid ""
15087 "This displays the partition table on C<device>, in the human-readable output "
15088 "of the L<sfdisk(8)> command.  It is not intended to be parsed."
15089 msgstr ""
15090
15091 #. type: textblock
15092 #: ../fish/guestfish-actions.pod:4633
15093 msgid "See also: L</part-list>"
15094 msgstr ""
15095
15096 #. type: textblock
15097 #: ../fish/guestfish-actions.pod:4635
15098 msgid ""
15099 "I<This function is deprecated.> In new code, use the L</part_list> call "
15100 "instead."
15101 msgstr ""
15102
15103 #. type: =head2
15104 #: ../fish/guestfish-actions.pod:4642
15105 msgid "sh"
15106 msgstr ""
15107
15108 #. type: verbatim
15109 #: ../fish/guestfish-actions.pod:4644
15110 #, no-wrap
15111 msgid ""
15112 " sh command\n"
15113 "\n"
15114 msgstr ""
15115
15116 #. type: textblock
15117 #: ../fish/guestfish-actions.pod:4646 ../src/guestfs-actions.pod:7147
15118 msgid ""
15119 "This call runs a command from the guest filesystem via the guest's "
15120 "C</bin/sh>."
15121 msgstr ""
15122
15123 #. type: textblock
15124 #: ../fish/guestfish-actions.pod:4649
15125 msgid "This is like L</command>, but passes the command to:"
15126 msgstr ""
15127
15128 #. type: verbatim
15129 #: ../fish/guestfish-actions.pod:4651 ../src/guestfs-actions.pod:7152
15130 #, no-wrap
15131 msgid ""
15132 " /bin/sh -c \"command\"\n"
15133 "\n"
15134 msgstr ""
15135
15136 #. type: textblock
15137 #: ../fish/guestfish-actions.pod:4653 ../src/guestfs-actions.pod:7154
15138 msgid ""
15139 "Depending on the guest's shell, this usually results in wildcards being "
15140 "expanded, shell expressions being interpolated and so on."
15141 msgstr ""
15142
15143 #. type: textblock
15144 #: ../fish/guestfish-actions.pod:4657
15145 msgid "All the provisos about L</command> apply to this call."
15146 msgstr ""
15147
15148 #. type: =head2
15149 #: ../fish/guestfish-actions.pod:4659
15150 msgid "sh-lines"
15151 msgstr ""
15152
15153 #. type: verbatim
15154 #: ../fish/guestfish-actions.pod:4661
15155 #, no-wrap
15156 msgid ""
15157 " sh-lines command\n"
15158 "\n"
15159 msgstr ""
15160
15161 #. type: textblock
15162 #: ../fish/guestfish-actions.pod:4663
15163 msgid "This is the same as L</sh>, but splits the result into a list of lines."
15164 msgstr ""
15165
15166 #. type: textblock
15167 #: ../fish/guestfish-actions.pod:4666
15168 msgid "See also: L</command-lines>"
15169 msgstr ""
15170
15171 #. type: =head2
15172 #: ../fish/guestfish-actions.pod:4668
15173 msgid "sleep"
15174 msgstr ""
15175
15176 #. type: verbatim
15177 #: ../fish/guestfish-actions.pod:4670
15178 #, no-wrap
15179 msgid ""
15180 " sleep secs\n"
15181 "\n"
15182 msgstr ""
15183
15184 #. type: textblock
15185 #: ../fish/guestfish-actions.pod:4672 ../src/guestfs-actions.pod:7188
15186 msgid "Sleep for C<secs> seconds."
15187 msgstr ""
15188
15189 #. type: =head2
15190 #: ../fish/guestfish-actions.pod:4674
15191 msgid "stat"
15192 msgstr ""
15193
15194 #. type: verbatim
15195 #: ../fish/guestfish-actions.pod:4676
15196 #, no-wrap
15197 msgid ""
15198 " stat path\n"
15199 "\n"
15200 msgstr ""
15201
15202 #. type: textblock
15203 #: ../fish/guestfish-actions.pod:4680 ../src/guestfs-actions.pod:7202
15204 msgid "This is the same as the C<stat(2)> system call."
15205 msgstr ""
15206
15207 #. type: =head2
15208 #: ../fish/guestfish-actions.pod:4682
15209 msgid "statvfs"
15210 msgstr ""
15211
15212 #. type: verbatim
15213 #: ../fish/guestfish-actions.pod:4684
15214 #, no-wrap
15215 msgid ""
15216 " statvfs path\n"
15217 "\n"
15218 msgstr ""
15219
15220 #. type: textblock
15221 #: ../fish/guestfish-actions.pod:4686 ../src/guestfs-actions.pod:7216
15222 msgid ""
15223 "Returns file system statistics for any mounted file system.  C<path> should "
15224 "be a file or directory in the mounted file system (typically it is the mount "
15225 "point itself, but it doesn't need to be)."
15226 msgstr ""
15227
15228 #. type: textblock
15229 #: ../fish/guestfish-actions.pod:4690 ../src/guestfs-actions.pod:7220
15230 msgid "This is the same as the C<statvfs(2)> system call."
15231 msgstr ""
15232
15233 #. type: =head2
15234 #: ../fish/guestfish-actions.pod:4692
15235 msgid "strings"
15236 msgstr ""
15237
15238 #. type: verbatim
15239 #: ../fish/guestfish-actions.pod:4694
15240 #, no-wrap
15241 msgid ""
15242 " strings path\n"
15243 "\n"
15244 msgstr ""
15245
15246 #. type: textblock
15247 #: ../fish/guestfish-actions.pod:4696 ../src/guestfs-actions.pod:7234
15248 msgid ""
15249 "This runs the L<strings(1)> command on a file and returns the list of "
15250 "printable strings found."
15251 msgstr ""
15252
15253 #. type: =head2
15254 #: ../fish/guestfish-actions.pod:4702
15255 msgid "strings-e"
15256 msgstr ""
15257
15258 #. type: verbatim
15259 #: ../fish/guestfish-actions.pod:4704
15260 #, no-wrap
15261 msgid ""
15262 " strings-e encoding path\n"
15263 "\n"
15264 msgstr ""
15265
15266 #. type: textblock
15267 #: ../fish/guestfish-actions.pod:4706
15268 msgid ""
15269 "This is like the L</strings> command, but allows you to specify the encoding "
15270 "of strings that are looked for in the source file C<path>."
15271 msgstr ""
15272
15273 #. type: textblock
15274 #: ../fish/guestfish-actions.pod:4710 ../src/guestfs-actions.pod:7257
15275 msgid "Allowed encodings are:"
15276 msgstr ""
15277
15278 #. type: =item
15279 #: ../fish/guestfish-actions.pod:4714 ../src/guestfs-actions.pod:7261
15280 msgid "s"
15281 msgstr ""
15282
15283 #. type: textblock
15284 #: ../fish/guestfish-actions.pod:4716
15285 msgid ""
15286 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
15287 "ISO-8859-X (this is what L</strings> uses)."
15288 msgstr ""
15289
15290 #. type: =item
15291 #: ../fish/guestfish-actions.pod:4719 ../src/guestfs-actions.pod:7266
15292 msgid "S"
15293 msgstr ""
15294
15295 #. type: textblock
15296 #: ../fish/guestfish-actions.pod:4721 ../src/guestfs-actions.pod:7268
15297 msgid "Single 8-bit-byte characters."
15298 msgstr ""
15299
15300 #. type: =item
15301 #: ../fish/guestfish-actions.pod:4723 ../src/guestfs-actions.pod:7270
15302 msgid "b"
15303 msgstr ""
15304
15305 #. type: textblock
15306 #: ../fish/guestfish-actions.pod:4725 ../src/guestfs-actions.pod:7272
15307 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
15308 msgstr ""
15309
15310 #. type: =item
15311 #: ../fish/guestfish-actions.pod:4728 ../src/guestfs-actions.pod:7275
15312 msgid "l (lower case letter L)"
15313 msgstr ""
15314
15315 #. type: textblock
15316 #: ../fish/guestfish-actions.pod:4730 ../src/guestfs-actions.pod:7277
15317 msgid ""
15318 "16-bit little endian such as UTF-16LE and UCS-2LE.  This is useful for "
15319 "examining binaries in Windows guests."
15320 msgstr ""
15321
15322 #. type: =item
15323 #: ../fish/guestfish-actions.pod:4733 ../src/guestfs-actions.pod:7280
15324 msgid "B"
15325 msgstr ""
15326
15327 #. type: textblock
15328 #: ../fish/guestfish-actions.pod:4735 ../src/guestfs-actions.pod:7282
15329 msgid "32-bit big endian such as UCS-4BE."
15330 msgstr ""
15331
15332 #. type: =item
15333 #: ../fish/guestfish-actions.pod:4737 ../src/guestfs-actions.pod:7284
15334 msgid "L"
15335 msgstr ""
15336
15337 #. type: textblock
15338 #: ../fish/guestfish-actions.pod:4739 ../src/guestfs-actions.pod:7286
15339 msgid "32-bit little endian such as UCS-4LE."
15340 msgstr ""
15341
15342 #. type: textblock
15343 #: ../fish/guestfish-actions.pod:4743 ../src/guestfs-actions.pod:7290
15344 msgid "The returned strings are transcoded to UTF-8."
15345 msgstr ""
15346
15347 #. type: =head2
15348 #: ../fish/guestfish-actions.pod:4748
15349 msgid "swapoff-device"
15350 msgstr ""
15351
15352 #. type: verbatim
15353 #: ../fish/guestfish-actions.pod:4750
15354 #, no-wrap
15355 msgid ""
15356 " swapoff-device device\n"
15357 "\n"
15358 msgstr ""
15359
15360 #. type: textblock
15361 #: ../fish/guestfish-actions.pod:4752
15362 msgid ""
15363 "This command disables the libguestfs appliance swap device or partition "
15364 "named C<device>.  See L</swapon-device>."
15365 msgstr ""
15366
15367 #. type: =head2
15368 #: ../fish/guestfish-actions.pod:4756
15369 msgid "swapoff-file"
15370 msgstr ""
15371
15372 #. type: verbatim
15373 #: ../fish/guestfish-actions.pod:4758
15374 #, no-wrap
15375 msgid ""
15376 " swapoff-file file\n"
15377 "\n"
15378 msgstr ""
15379
15380 #. type: textblock
15381 #: ../fish/guestfish-actions.pod:4760 ../src/guestfs-actions.pod:7321
15382 msgid "This command disables the libguestfs appliance swap on file."
15383 msgstr ""
15384
15385 #. type: =head2
15386 #: ../fish/guestfish-actions.pod:4762
15387 msgid "swapoff-label"
15388 msgstr ""
15389
15390 #. type: verbatim
15391 #: ../fish/guestfish-actions.pod:4764
15392 #, no-wrap
15393 msgid ""
15394 " swapoff-label label\n"
15395 "\n"
15396 msgstr ""
15397
15398 #. type: textblock
15399 #: ../fish/guestfish-actions.pod:4766 ../src/guestfs-actions.pod:7333
15400 msgid ""
15401 "This command disables the libguestfs appliance swap on labeled swap "
15402 "partition."
15403 msgstr ""
15404
15405 #. type: =head2
15406 #: ../fish/guestfish-actions.pod:4769
15407 msgid "swapoff-uuid"
15408 msgstr ""
15409
15410 #. type: verbatim
15411 #: ../fish/guestfish-actions.pod:4771
15412 #, no-wrap
15413 msgid ""
15414 " swapoff-uuid uuid\n"
15415 "\n"
15416 msgstr ""
15417
15418 #. type: textblock
15419 #: ../fish/guestfish-actions.pod:4773 ../src/guestfs-actions.pod:7346
15420 msgid ""
15421 "This command disables the libguestfs appliance swap partition with the given "
15422 "UUID."
15423 msgstr ""
15424
15425 #. type: =head2
15426 #: ../fish/guestfish-actions.pod:4776
15427 msgid "swapon-device"
15428 msgstr ""
15429
15430 #. type: verbatim
15431 #: ../fish/guestfish-actions.pod:4778
15432 #, no-wrap
15433 msgid ""
15434 " swapon-device device\n"
15435 "\n"
15436 msgstr ""
15437
15438 #. type: textblock
15439 #: ../fish/guestfish-actions.pod:4780
15440 msgid ""
15441 "This command enables the libguestfs appliance to use the swap device or "
15442 "partition named C<device>.  The increased memory is made available for all "
15443 "commands, for example those run using L</command> or L</sh>."
15444 msgstr ""
15445
15446 #. type: textblock
15447 #: ../fish/guestfish-actions.pod:4785 ../src/guestfs-actions.pod:7364
15448 msgid ""
15449 "Note that you should not swap to existing guest swap partitions unless you "
15450 "know what you are doing.  They may contain hibernation information, or other "
15451 "information that the guest doesn't want you to trash.  You also risk leaking "
15452 "information about the host to the guest this way.  Instead, attach a new "
15453 "host device to the guest and swap on that."
15454 msgstr ""
15455
15456 #. type: =head2
15457 #: ../fish/guestfish-actions.pod:4792
15458 msgid "swapon-file"
15459 msgstr ""
15460
15461 #. type: verbatim
15462 #: ../fish/guestfish-actions.pod:4794
15463 #, no-wrap
15464 msgid ""
15465 " swapon-file file\n"
15466 "\n"
15467 msgstr ""
15468
15469 #. type: textblock
15470 #: ../fish/guestfish-actions.pod:4796
15471 msgid "This command enables swap to a file.  See L</swapon-device> for other notes."
15472 msgstr ""
15473
15474 #. type: =head2
15475 #: ../fish/guestfish-actions.pod:4799
15476 msgid "swapon-label"
15477 msgstr ""
15478
15479 #. type: verbatim
15480 #: ../fish/guestfish-actions.pod:4801
15481 #, no-wrap
15482 msgid ""
15483 " swapon-label label\n"
15484 "\n"
15485 msgstr ""
15486
15487 #. type: textblock
15488 #: ../fish/guestfish-actions.pod:4803
15489 msgid ""
15490 "This command enables swap to a labeled swap partition.  See "
15491 "L</swapon-device> for other notes."
15492 msgstr ""
15493
15494 #. type: =head2
15495 #: ../fish/guestfish-actions.pod:4806
15496 msgid "swapon-uuid"
15497 msgstr ""
15498
15499 #. type: verbatim
15500 #: ../fish/guestfish-actions.pod:4808
15501 #, no-wrap
15502 msgid ""
15503 " swapon-uuid uuid\n"
15504 "\n"
15505 msgstr ""
15506
15507 #. type: textblock
15508 #: ../fish/guestfish-actions.pod:4810
15509 msgid ""
15510 "This command enables swap to a swap partition with the given UUID.  See "
15511 "L</swapon-device> for other notes."
15512 msgstr ""
15513
15514 #. type: =head2
15515 #: ../fish/guestfish-actions.pod:4813
15516 msgid "sync"
15517 msgstr ""
15518
15519 #. type: verbatim
15520 #: ../fish/guestfish-actions.pod:4815
15521 #, no-wrap
15522 msgid ""
15523 " sync\n"
15524 "\n"
15525 msgstr ""
15526
15527 #. type: textblock
15528 #: ../fish/guestfish-actions.pod:4817 ../src/guestfs-actions.pod:7419
15529 msgid ""
15530 "This syncs the disk, so that any writes are flushed through to the "
15531 "underlying disk image."
15532 msgstr ""
15533
15534 #. type: textblock
15535 #: ../fish/guestfish-actions.pod:4820 ../src/guestfs-actions.pod:7422
15536 msgid ""
15537 "You should always call this if you have modified a disk image, before "
15538 "closing the handle."
15539 msgstr ""
15540
15541 #. type: =head2
15542 #: ../fish/guestfish-actions.pod:4823
15543 msgid "tail"
15544 msgstr ""
15545
15546 #. type: verbatim
15547 #: ../fish/guestfish-actions.pod:4825
15548 #, no-wrap
15549 msgid ""
15550 " tail path\n"
15551 "\n"
15552 msgstr ""
15553
15554 #. type: textblock
15555 #: ../fish/guestfish-actions.pod:4827 ../src/guestfs-actions.pod:7435
15556 msgid "This command returns up to the last 10 lines of a file as a list of strings."
15557 msgstr ""
15558
15559 #. type: =head2
15560 #: ../fish/guestfish-actions.pod:4833
15561 msgid "tail-n"
15562 msgstr ""
15563
15564 #. type: verbatim
15565 #: ../fish/guestfish-actions.pod:4835
15566 #, no-wrap
15567 msgid ""
15568 " tail-n nrlines path\n"
15569 "\n"
15570 msgstr ""
15571
15572 #. type: textblock
15573 #: ../fish/guestfish-actions.pod:4837 ../src/guestfs-actions.pod:7454
15574 msgid ""
15575 "If the parameter C<nrlines> is a positive number, this returns the last "
15576 "C<nrlines> lines of the file C<path>."
15577 msgstr ""
15578
15579 #. type: textblock
15580 #: ../fish/guestfish-actions.pod:4840 ../src/guestfs-actions.pod:7457
15581 msgid ""
15582 "If the parameter C<nrlines> is a negative number, this returns lines from "
15583 "the file C<path>, starting with the C<-nrlines>th line."
15584 msgstr ""
15585
15586 #. type: =head2
15587 #: ../fish/guestfish-actions.pod:4848
15588 msgid "tar-in"
15589 msgstr ""
15590
15591 #. type: verbatim
15592 #: ../fish/guestfish-actions.pod:4850
15593 #, no-wrap
15594 msgid ""
15595 " tar-in (tarfile|-) directory\n"
15596 "\n"
15597 msgstr ""
15598
15599 #. type: textblock
15600 #: ../fish/guestfish-actions.pod:4852 ../src/guestfs-actions.pod:7478
15601 msgid ""
15602 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
15603 "tar file) into C<directory>."
15604 msgstr ""
15605
15606 #. type: textblock
15607 #: ../fish/guestfish-actions.pod:4855
15608 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
15609 msgstr ""
15610
15611 #. type: =head2
15612 #: ../fish/guestfish-actions.pod:4860
15613 msgid "tar-out"
15614 msgstr ""
15615
15616 #. type: verbatim
15617 #: ../fish/guestfish-actions.pod:4862
15618 #, no-wrap
15619 msgid ""
15620 " tar-out directory (tarfile|-)\n"
15621 "\n"
15622 msgstr ""
15623
15624 #. type: textblock
15625 #: ../fish/guestfish-actions.pod:4864 ../src/guestfs-actions.pod:7495
15626 msgid ""
15627 "This command packs the contents of C<directory> and downloads it to local "
15628 "file C<tarfile>."
15629 msgstr ""
15630
15631 #. type: textblock
15632 #: ../fish/guestfish-actions.pod:4867
15633 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
15634 msgstr ""
15635
15636 #. type: =head2
15637 #: ../fish/guestfish-actions.pod:4872
15638 msgid "tgz-in"
15639 msgstr ""
15640
15641 #. type: verbatim
15642 #: ../fish/guestfish-actions.pod:4874
15643 #, no-wrap
15644 msgid ""
15645 " tgz-in (tarball|-) directory\n"
15646 "\n"
15647 msgstr ""
15648
15649 #. type: textblock
15650 #: ../fish/guestfish-actions.pod:4876 ../src/guestfs-actions.pod:7512
15651 msgid ""
15652 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
15653 "tar file) into C<directory>."
15654 msgstr ""
15655
15656 #. type: textblock
15657 #: ../fish/guestfish-actions.pod:4879
15658 msgid "To upload an uncompressed tarball, use L</tar-in>."
15659 msgstr ""
15660
15661 #. type: =head2
15662 #: ../fish/guestfish-actions.pod:4883
15663 msgid "tgz-out"
15664 msgstr ""
15665
15666 #. type: verbatim
15667 #: ../fish/guestfish-actions.pod:4885
15668 #, no-wrap
15669 msgid ""
15670 " tgz-out directory (tarball|-)\n"
15671 "\n"
15672 msgstr ""
15673
15674 #. type: textblock
15675 #: ../fish/guestfish-actions.pod:4887 ../src/guestfs-actions.pod:7528
15676 msgid ""
15677 "This command packs the contents of C<directory> and downloads it to local "
15678 "file C<tarball>."
15679 msgstr ""
15680
15681 #. type: textblock
15682 #: ../fish/guestfish-actions.pod:4890
15683 msgid "To download an uncompressed tarball, use L</tar-out>."
15684 msgstr ""
15685
15686 #. type: =head2
15687 #: ../fish/guestfish-actions.pod:4894
15688 msgid "touch"
15689 msgstr ""
15690
15691 #. type: verbatim
15692 #: ../fish/guestfish-actions.pod:4896
15693 #, no-wrap
15694 msgid ""
15695 " touch path\n"
15696 "\n"
15697 msgstr ""
15698
15699 #. type: textblock
15700 #: ../fish/guestfish-actions.pod:4898 ../src/guestfs-actions.pod:7543
15701 msgid ""
15702 "Touch acts like the L<touch(1)> command.  It can be used to update the "
15703 "timestamps on a file, or, if the file does not exist, to create a new "
15704 "zero-length file."
15705 msgstr ""
15706
15707 #. type: textblock
15708 #: ../fish/guestfish-actions.pod:4902 ../src/guestfs-actions.pod:7547
15709 msgid ""
15710 "This command only works on regular files, and will fail on other file types "
15711 "such as directories, symbolic links, block special etc."
15712 msgstr ""
15713
15714 #. type: =head2
15715 #: ../fish/guestfish-actions.pod:4905
15716 msgid "truncate"
15717 msgstr ""
15718
15719 #. type: verbatim
15720 #: ../fish/guestfish-actions.pod:4907
15721 #, no-wrap
15722 msgid ""
15723 " truncate path\n"
15724 "\n"
15725 msgstr ""
15726
15727 #. type: textblock
15728 #: ../fish/guestfish-actions.pod:4909 ../src/guestfs-actions.pod:7560
15729 msgid ""
15730 "This command truncates C<path> to a zero-length file.  The file must exist "
15731 "already."
15732 msgstr ""
15733
15734 #. type: =head2
15735 #: ../fish/guestfish-actions.pod:4912
15736 msgid "truncate-size"
15737 msgstr ""
15738
15739 #. type: verbatim
15740 #: ../fish/guestfish-actions.pod:4914
15741 #, no-wrap
15742 msgid ""
15743 " truncate-size path size\n"
15744 "\n"
15745 msgstr ""
15746
15747 #. type: textblock
15748 #: ../fish/guestfish-actions.pod:4916 ../src/guestfs-actions.pod:7574
15749 msgid ""
15750 "This command truncates C<path> to size C<size> bytes.  The file must exist "
15751 "already."
15752 msgstr ""
15753
15754 #. type: textblock
15755 #: ../fish/guestfish-actions.pod:4919
15756 msgid ""
15757 "If the current file size is less than C<size> then the file is extended to "
15758 "the required size with zero bytes.  This creates a sparse file (ie. disk "
15759 "blocks are not allocated for the file until you write to it).  To create a "
15760 "non-sparse file of zeroes, use L</fallocate64> instead."
15761 msgstr ""
15762
15763 #. type: =head2
15764 #: ../fish/guestfish-actions.pod:4925
15765 msgid "tune2fs-l"
15766 msgstr ""
15767
15768 #. type: verbatim
15769 #: ../fish/guestfish-actions.pod:4927
15770 #, no-wrap
15771 msgid ""
15772 " tune2fs-l device\n"
15773 "\n"
15774 msgstr ""
15775
15776 #. type: textblock
15777 #: ../fish/guestfish-actions.pod:4929 ../src/guestfs-actions.pod:7593
15778 msgid ""
15779 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
15780 "C<device>."
15781 msgstr ""
15782
15783 #. type: textblock
15784 #: ../fish/guestfish-actions.pod:4932 ../src/guestfs-actions.pod:7596
15785 msgid ""
15786 "It is the same as running C<tune2fs -l device>.  See L<tune2fs(8)> manpage "
15787 "for more details.  The list of fields returned isn't clearly defined, and "
15788 "depends on both the version of C<tune2fs> that libguestfs was built against, "
15789 "and the filesystem itself."
15790 msgstr ""
15791
15792 #. type: =head2
15793 #: ../fish/guestfish-actions.pod:4937
15794 msgid "txz-in"
15795 msgstr ""
15796
15797 #. type: verbatim
15798 #: ../fish/guestfish-actions.pod:4939
15799 #, no-wrap
15800 msgid ""
15801 " txz-in (tarball|-) directory\n"
15802 "\n"
15803 msgstr ""
15804
15805 #. type: textblock
15806 #: ../fish/guestfish-actions.pod:4941 ../src/guestfs-actions.pod:7616
15807 msgid ""
15808 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
15809 "tar file) into C<directory>."
15810 msgstr ""
15811
15812 #. type: =head2
15813 #: ../fish/guestfish-actions.pod:4946
15814 msgid "txz-out"
15815 msgstr ""
15816
15817 #. type: verbatim
15818 #: ../fish/guestfish-actions.pod:4948
15819 #, no-wrap
15820 msgid ""
15821 " txz-out directory (tarball|-)\n"
15822 "\n"
15823 msgstr ""
15824
15825 #. type: textblock
15826 #: ../fish/guestfish-actions.pod:4950 ../src/guestfs-actions.pod:7630
15827 msgid ""
15828 "This command packs the contents of C<directory> and downloads it to local "
15829 "file C<tarball> (as an xz compressed tar archive)."
15830 msgstr ""
15831
15832 #. type: =head2
15833 #: ../fish/guestfish-actions.pod:4955
15834 msgid "umask"
15835 msgstr ""
15836
15837 #. type: verbatim
15838 #: ../fish/guestfish-actions.pod:4957
15839 #, no-wrap
15840 msgid ""
15841 " umask mask\n"
15842 "\n"
15843 msgstr ""
15844
15845 #. type: textblock
15846 #: ../fish/guestfish-actions.pod:4959 ../src/guestfs-actions.pod:7643
15847 msgid ""
15848 "This function sets the mask used for creating new files and device nodes to "
15849 "C<mask & 0777>."
15850 msgstr ""
15851
15852 #. type: textblock
15853 #: ../fish/guestfish-actions.pod:4962 ../src/guestfs-actions.pod:7646
15854 msgid ""
15855 "Typical umask values would be C<022> which creates new files with "
15856 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
15857 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
15858 msgstr ""
15859
15860 #. type: textblock
15861 #: ../fish/guestfish-actions.pod:4967 ../src/guestfs-actions.pod:7651
15862 msgid ""
15863 "The default umask is C<022>.  This is important because it means that "
15864 "directories and device nodes will be created with C<0644> or C<0755> mode "
15865 "even if you specify C<0777>."
15866 msgstr ""
15867
15868 #. type: textblock
15869 #: ../fish/guestfish-actions.pod:4971
15870 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
15871 msgstr ""
15872
15873 #. type: textblock
15874 #: ../fish/guestfish-actions.pod:4974 ../src/guestfs-actions.pod:7658
15875 msgid "This call returns the previous umask."
15876 msgstr ""
15877
15878 #. type: =head2
15879 #: ../fish/guestfish-actions.pod:4976
15880 msgid "umount"
15881 msgstr ""
15882
15883 #. type: =head2
15884 #: ../fish/guestfish-actions.pod:4978
15885 msgid "unmount"
15886 msgstr ""
15887
15888 #. type: verbatim
15889 #: ../fish/guestfish-actions.pod:4980
15890 #, no-wrap
15891 msgid ""
15892 " umount pathordevice\n"
15893 "\n"
15894 msgstr ""
15895
15896 #. type: textblock
15897 #: ../fish/guestfish-actions.pod:4982 ../src/guestfs-actions.pod:7670
15898 msgid ""
15899 "This unmounts the given filesystem.  The filesystem may be specified either "
15900 "by its mountpoint (path) or the device which contains the filesystem."
15901 msgstr ""
15902
15903 #. type: =head2
15904 #: ../fish/guestfish-actions.pod:4986
15905 msgid "umount-all"
15906 msgstr ""
15907
15908 #. type: =head2
15909 #: ../fish/guestfish-actions.pod:4988
15910 msgid "unmount-all"
15911 msgstr ""
15912
15913 #. type: verbatim
15914 #: ../fish/guestfish-actions.pod:4990
15915 #, no-wrap
15916 msgid ""
15917 " umount-all\n"
15918 "\n"
15919 msgstr ""
15920
15921 #. type: textblock
15922 #: ../fish/guestfish-actions.pod:4992 ../src/guestfs-actions.pod:7683
15923 msgid "This unmounts all mounted filesystems."
15924 msgstr ""
15925
15926 #. type: textblock
15927 #: ../fish/guestfish-actions.pod:4994 ../src/guestfs-actions.pod:7685
15928 msgid "Some internal mounts are not unmounted by this call."
15929 msgstr ""
15930
15931 #. type: =head2
15932 #: ../fish/guestfish-actions.pod:4996
15933 msgid "upload"
15934 msgstr ""
15935
15936 #. type: verbatim
15937 #: ../fish/guestfish-actions.pod:4998
15938 #, no-wrap
15939 msgid ""
15940 " upload (filename|-) remotefilename\n"
15941 "\n"
15942 msgstr ""
15943
15944 #. type: textblock
15945 #: ../fish/guestfish-actions.pod:5000 ../fish/guestfish-actions.pod:5013 ../src/guestfs-actions.pod:7698 ../src/guestfs-actions.pod:7722
15946 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
15947 msgstr ""
15948
15949 #. type: textblock
15950 #: ../fish/guestfish-actions.pod:5005
15951 msgid "See also L</download>."
15952 msgstr ""
15953
15954 #. type: =head2
15955 #: ../fish/guestfish-actions.pod:5009
15956 msgid "upload-offset"
15957 msgstr ""
15958
15959 #. type: verbatim
15960 #: ../fish/guestfish-actions.pod:5011
15961 #, no-wrap
15962 msgid ""
15963 " upload-offset (filename|-) remotefilename offset\n"
15964 "\n"
15965 msgstr ""
15966
15967 #. type: textblock
15968 #: ../fish/guestfish-actions.pod:5016 ../src/guestfs-actions.pod:7725
15969 msgid ""
15970 "C<remotefilename> is overwritten starting at the byte C<offset> specified.  "
15971 "The intention is to overwrite parts of existing files or devices, although "
15972 "if a non-existant file is specified then it is created with a \"hole\" "
15973 "before C<offset>.  The size of the data written is implicit in the size of "
15974 "the source C<filename>."
15975 msgstr ""
15976
15977 #. type: textblock
15978 #: ../fish/guestfish-actions.pod:5023
15979 msgid ""
15980 "Note that there is no limit on the amount of data that can be uploaded with "
15981 "this call, unlike with L</pwrite>, and this call always writes the full "
15982 "amount unless an error occurs."
15983 msgstr ""
15984
15985 #. type: textblock
15986 #: ../fish/guestfish-actions.pod:5028
15987 msgid "See also L</upload>, L</pwrite>."
15988 msgstr ""
15989
15990 #. type: =head2
15991 #: ../fish/guestfish-actions.pod:5032
15992 msgid "utimens"
15993 msgstr ""
15994
15995 #. type: verbatim
15996 #: ../fish/guestfish-actions.pod:5034
15997 #, no-wrap
15998 msgid ""
15999 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
16000 "\n"
16001 msgstr ""
16002
16003 #. type: textblock
16004 #: ../fish/guestfish-actions.pod:5036 ../src/guestfs-actions.pod:7758
16005 msgid "This command sets the timestamps of a file with nanosecond precision."
16006 msgstr ""
16007
16008 #. type: textblock
16009 #: ../fish/guestfish-actions.pod:5039 ../src/guestfs-actions.pod:7761
16010 msgid ""
16011 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
16012 "from the epoch."
16013 msgstr ""
16014
16015 #. type: textblock
16016 #: ../fish/guestfish-actions.pod:5042 ../src/guestfs-actions.pod:7764
16017 msgid ""
16018 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
16019 "nanoseconds from the epoch."
16020 msgstr ""
16021
16022 #. type: textblock
16023 #: ../fish/guestfish-actions.pod:5045 ../src/guestfs-actions.pod:7767
16024 msgid ""
16025 "If the C<*nsecs> field contains the special value C<-1> then the "
16026 "corresponding timestamp is set to the current time.  (The C<*secs> field is "
16027 "ignored in this case)."
16028 msgstr ""
16029
16030 #. type: textblock
16031 #: ../fish/guestfish-actions.pod:5049 ../src/guestfs-actions.pod:7771
16032 msgid ""
16033 "If the C<*nsecs> field contains the special value C<-2> then the "
16034 "corresponding timestamp is left unchanged.  (The C<*secs> field is ignored "
16035 "in this case)."
16036 msgstr ""
16037
16038 #. type: =head2
16039 #: ../fish/guestfish-actions.pod:5053
16040 msgid "version"
16041 msgstr ""
16042
16043 #. type: verbatim
16044 #: ../fish/guestfish-actions.pod:5055
16045 #, no-wrap
16046 msgid ""
16047 " version\n"
16048 "\n"
16049 msgstr ""
16050
16051 #. type: textblock
16052 #: ../fish/guestfish-actions.pod:5057 ../src/guestfs-actions.pod:7784
16053 msgid "Return the libguestfs version number that the program is linked against."
16054 msgstr ""
16055
16056 #. type: textblock
16057 #: ../fish/guestfish-actions.pod:5060 ../src/guestfs-actions.pod:7787
16058 msgid ""
16059 "Note that because of dynamic linking this is not necessarily the version of "
16060 "libguestfs that you compiled against.  You can compile the program, and then "
16061 "at runtime dynamically link against a completely different C<libguestfs.so> "
16062 "library."
16063 msgstr ""
16064
16065 #. type: textblock
16066 #: ../fish/guestfish-actions.pod:5065 ../src/guestfs-actions.pod:7792
16067 msgid ""
16068 "This call was added in version C<1.0.58>.  In previous versions of "
16069 "libguestfs there was no way to get the version number.  From C code you can "
16070 "use dynamic linker functions to find out if this symbol exists (if it "
16071 "doesn't, then it's an earlier version)."
16072 msgstr ""
16073
16074 #. type: textblock
16075 #: ../fish/guestfish-actions.pod:5071 ../src/guestfs-actions.pod:7798
16076 msgid ""
16077 "The call returns a structure with four elements.  The first three (C<major>, "
16078 "C<minor> and C<release>) are numbers and correspond to the usual version "
16079 "triplet.  The fourth element (C<extra>) is a string and is normally empty, "
16080 "but may be used for distro-specific information."
16081 msgstr ""
16082
16083 #. type: textblock
16084 #: ../fish/guestfish-actions.pod:5077 ../src/guestfs-actions.pod:7804
16085 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
16086 msgstr ""
16087
16088 #. type: textblock
16089 #: ../fish/guestfish-actions.pod:5080 ../src/guestfs-actions.pod:7807
16090 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
16091 msgstr ""
16092
16093 #. type: textblock
16094 #: ../fish/guestfish-actions.pod:5082
16095 msgid ""
16096 "I<Note:> Don't use this call to test for availability of features.  In "
16097 "enterprise distributions we backport features from later versions into "
16098 "earlier versions, making this an unreliable way to test for features.  Use "
16099 "L</available> instead."
16100 msgstr ""
16101
16102 #. type: =head2
16103 #: ../fish/guestfish-actions.pod:5088
16104 msgid "vfs-label"
16105 msgstr ""
16106
16107 #. type: verbatim
16108 #: ../fish/guestfish-actions.pod:5090
16109 #, no-wrap
16110 msgid ""
16111 " vfs-label device\n"
16112 "\n"
16113 msgstr ""
16114
16115 #. type: textblock
16116 #: ../fish/guestfish-actions.pod:5092 ../src/guestfs-actions.pod:7827
16117 msgid "This returns the filesystem label of the filesystem on C<device>."
16118 msgstr ""
16119
16120 #. type: textblock
16121 #: ../fish/guestfish-actions.pod:5095 ../src/guestfs-actions.pod:7830
16122 msgid "If the filesystem is unlabeled, this returns the empty string."
16123 msgstr ""
16124
16125 #. type: textblock
16126 #: ../fish/guestfish-actions.pod:5097
16127 msgid "To find a filesystem from the label, use L</findfs-label>."
16128 msgstr ""
16129
16130 #. type: =head2
16131 #: ../fish/guestfish-actions.pod:5099
16132 msgid "vfs-type"
16133 msgstr ""
16134
16135 #. type: verbatim
16136 #: ../fish/guestfish-actions.pod:5101
16137 #, no-wrap
16138 msgid ""
16139 " vfs-type device\n"
16140 "\n"
16141 msgstr ""
16142
16143 #. type: textblock
16144 #: ../fish/guestfish-actions.pod:5103 ../src/guestfs-actions.pod:7845
16145 msgid ""
16146 "This command gets the filesystem type corresponding to the filesystem on "
16147 "C<device>."
16148 msgstr ""
16149
16150 #. type: textblock
16151 #: ../fish/guestfish-actions.pod:5106 ../src/guestfs-actions.pod:7848
16152 msgid ""
16153 "For most filesystems, the result is the name of the Linux VFS module which "
16154 "would be used to mount this filesystem if you mounted it without specifying "
16155 "the filesystem type.  For example a string such as C<ext3> or C<ntfs>."
16156 msgstr ""
16157
16158 #. type: =head2
16159 #: ../fish/guestfish-actions.pod:5111
16160 msgid "vfs-uuid"
16161 msgstr ""
16162
16163 #. type: verbatim
16164 #: ../fish/guestfish-actions.pod:5113
16165 #, no-wrap
16166 msgid ""
16167 " vfs-uuid device\n"
16168 "\n"
16169 msgstr ""
16170
16171 #. type: textblock
16172 #: ../fish/guestfish-actions.pod:5115 ../src/guestfs-actions.pod:7864
16173 msgid "This returns the filesystem UUID of the filesystem on C<device>."
16174 msgstr ""
16175
16176 #. type: textblock
16177 #: ../fish/guestfish-actions.pod:5118 ../src/guestfs-actions.pod:7867
16178 msgid "If the filesystem does not have a UUID, this returns the empty string."
16179 msgstr ""
16180
16181 #. type: textblock
16182 #: ../fish/guestfish-actions.pod:5120
16183 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
16184 msgstr ""
16185
16186 #. type: =head2
16187 #: ../fish/guestfish-actions.pod:5122
16188 msgid "vg-activate"
16189 msgstr ""
16190
16191 #. type: verbatim
16192 #: ../fish/guestfish-actions.pod:5124
16193 #, no-wrap
16194 msgid ""
16195 " vg-activate true|false 'volgroups ...'\n"
16196 "\n"
16197 msgstr ""
16198
16199 #. type: textblock
16200 #: ../fish/guestfish-actions.pod:5126 ../src/guestfs-actions.pod:7883
16201 msgid ""
16202 "This command activates or (if C<activate> is false) deactivates all logical "
16203 "volumes in the listed volume groups C<volgroups>."
16204 msgstr ""
16205
16206 #. type: textblock
16207 #: ../fish/guestfish-actions.pod:5129 ../src/guestfs-actions.pod:7886
16208 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
16209 msgstr ""
16210
16211 #. type: textblock
16212 #: ../fish/guestfish-actions.pod:5131 ../src/guestfs-actions.pod:7888
16213 msgid ""
16214 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
16215 "activated or deactivated."
16216 msgstr ""
16217
16218 #. type: =head2
16219 #: ../fish/guestfish-actions.pod:5134
16220 msgid "vg-activate-all"
16221 msgstr ""
16222
16223 #. type: verbatim
16224 #: ../fish/guestfish-actions.pod:5136
16225 #, no-wrap
16226 msgid ""
16227 " vg-activate-all true|false\n"
16228 "\n"
16229 msgstr ""
16230
16231 #. type: textblock
16232 #: ../fish/guestfish-actions.pod:5138 ../src/guestfs-actions.pod:7901
16233 msgid ""
16234 "This command activates or (if C<activate> is false) deactivates all logical "
16235 "volumes in all volume groups."
16236 msgstr ""
16237
16238 #. type: textblock
16239 #: ../fish/guestfish-actions.pod:5141 ../src/guestfs-actions.pod:7904
16240 msgid "This command is the same as running C<vgchange -a y|n>"
16241 msgstr ""
16242
16243 #. type: =head2
16244 #: ../fish/guestfish-actions.pod:5143
16245 msgid "vgcreate"
16246 msgstr ""
16247
16248 #. type: verbatim
16249 #: ../fish/guestfish-actions.pod:5145
16250 #, no-wrap
16251 msgid ""
16252 " vgcreate volgroup 'physvols ...'\n"
16253 "\n"
16254 msgstr ""
16255
16256 #. type: textblock
16257 #: ../fish/guestfish-actions.pod:5147 ../src/guestfs-actions.pod:7917
16258 msgid ""
16259 "This creates an LVM volume group called C<volgroup> from the non-empty list "
16260 "of physical volumes C<physvols>."
16261 msgstr ""
16262
16263 #. type: =head2
16264 #: ../fish/guestfish-actions.pod:5150
16265 msgid "vglvuuids"
16266 msgstr ""
16267
16268 #. type: verbatim
16269 #: ../fish/guestfish-actions.pod:5152
16270 #, no-wrap
16271 msgid ""
16272 " vglvuuids vgname\n"
16273 "\n"
16274 msgstr ""
16275
16276 #. type: textblock
16277 #: ../fish/guestfish-actions.pod:5154 ../src/guestfs-actions.pod:7930
16278 msgid ""
16279 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
16280 "volumes created in this volume group."
16281 msgstr ""
16282
16283 #. type: textblock
16284 #: ../fish/guestfish-actions.pod:5157
16285 msgid ""
16286 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
16287 "logical volumes and volume groups."
16288 msgstr ""
16289
16290 #. type: textblock
16291 #: ../fish/guestfish-actions.pod:5160
16292 msgid "See also L</vgpvuuids>."
16293 msgstr ""
16294
16295 #. type: =head2
16296 #: ../fish/guestfish-actions.pod:5162
16297 msgid "vgpvuuids"
16298 msgstr ""
16299
16300 #. type: verbatim
16301 #: ../fish/guestfish-actions.pod:5164
16302 #, no-wrap
16303 msgid ""
16304 " vgpvuuids vgname\n"
16305 "\n"
16306 msgstr ""
16307
16308 #. type: textblock
16309 #: ../fish/guestfish-actions.pod:5166 ../src/guestfs-actions.pod:7950
16310 msgid ""
16311 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
16312 "volumes that this volume group resides on."
16313 msgstr ""
16314
16315 #. type: textblock
16316 #: ../fish/guestfish-actions.pod:5169
16317 msgid ""
16318 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
16319 "physical volumes and volume groups."
16320 msgstr ""
16321
16322 #. type: textblock
16323 #: ../fish/guestfish-actions.pod:5172
16324 msgid "See also L</vglvuuids>."
16325 msgstr ""
16326
16327 #. type: =head2
16328 #: ../fish/guestfish-actions.pod:5174
16329 msgid "vgremove"
16330 msgstr ""
16331
16332 #. type: verbatim
16333 #: ../fish/guestfish-actions.pod:5176
16334 #, no-wrap
16335 msgid ""
16336 " vgremove vgname\n"
16337 "\n"
16338 msgstr ""
16339
16340 #. type: textblock
16341 #: ../fish/guestfish-actions.pod:5178 ../src/guestfs-actions.pod:7970
16342 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
16343 msgstr ""
16344
16345 #. type: textblock
16346 #: ../fish/guestfish-actions.pod:5180 ../src/guestfs-actions.pod:7972
16347 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
16348 msgstr ""
16349
16350 #. type: =head2
16351 #: ../fish/guestfish-actions.pod:5183
16352 msgid "vgrename"
16353 msgstr ""
16354
16355 #. type: verbatim
16356 #: ../fish/guestfish-actions.pod:5185
16357 #, no-wrap
16358 msgid ""
16359 " vgrename volgroup newvolgroup\n"
16360 "\n"
16361 msgstr ""
16362
16363 #. type: textblock
16364 #: ../fish/guestfish-actions.pod:5187 ../src/guestfs-actions.pod:7986
16365 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
16366 msgstr ""
16367
16368 #. type: =head2
16369 #: ../fish/guestfish-actions.pod:5189
16370 msgid "vgs"
16371 msgstr ""
16372
16373 #. type: verbatim
16374 #: ../fish/guestfish-actions.pod:5191
16375 #, no-wrap
16376 msgid ""
16377 " vgs\n"
16378 "\n"
16379 msgstr ""
16380
16381 #. type: textblock
16382 #: ../fish/guestfish-actions.pod:5193 ../src/guestfs-actions.pod:7997
16383 msgid ""
16384 "List all the volumes groups detected.  This is the equivalent of the "
16385 "L<vgs(8)> command."
16386 msgstr ""
16387
16388 #. type: textblock
16389 #: ../fish/guestfish-actions.pod:5196 ../src/guestfs-actions.pod:8000
16390 msgid ""
16391 "This returns a list of just the volume group names that were detected "
16392 "(eg. C<VolGroup00>)."
16393 msgstr ""
16394
16395 #. type: textblock
16396 #: ../fish/guestfish-actions.pod:5199
16397 msgid "See also L</vgs-full>."
16398 msgstr ""
16399
16400 #. type: =head2
16401 #: ../fish/guestfish-actions.pod:5201
16402 msgid "vgs-full"
16403 msgstr ""
16404
16405 #. type: verbatim
16406 #: ../fish/guestfish-actions.pod:5203
16407 #, no-wrap
16408 msgid ""
16409 " vgs-full\n"
16410 "\n"
16411 msgstr ""
16412
16413 #. type: textblock
16414 #: ../fish/guestfish-actions.pod:5205 ../src/guestfs-actions.pod:8016
16415 msgid ""
16416 "List all the volumes groups detected.  This is the equivalent of the "
16417 "L<vgs(8)> command.  The \"full\" version includes all fields."
16418 msgstr ""
16419
16420 #. type: =head2
16421 #: ../fish/guestfish-actions.pod:5208
16422 msgid "vgscan"
16423 msgstr ""
16424
16425 #. type: verbatim
16426 #: ../fish/guestfish-actions.pod:5210
16427 #, no-wrap
16428 msgid ""
16429 " vgscan\n"
16430 "\n"
16431 msgstr ""
16432
16433 #. type: textblock
16434 #: ../fish/guestfish-actions.pod:5212 ../src/guestfs-actions.pod:8030
16435 msgid ""
16436 "This rescans all block devices and rebuilds the list of LVM physical "
16437 "volumes, volume groups and logical volumes."
16438 msgstr ""
16439
16440 #. type: =head2
16441 #: ../fish/guestfish-actions.pod:5215
16442 msgid "vguuid"
16443 msgstr ""
16444
16445 #. type: verbatim
16446 #: ../fish/guestfish-actions.pod:5217
16447 #, no-wrap
16448 msgid ""
16449 " vguuid vgname\n"
16450 "\n"
16451 msgstr ""
16452
16453 #. type: textblock
16454 #: ../fish/guestfish-actions.pod:5219 ../src/guestfs-actions.pod:8043
16455 msgid "This command returns the UUID of the LVM VG named C<vgname>."
16456 msgstr ""
16457
16458 #. type: =head2
16459 #: ../fish/guestfish-actions.pod:5221
16460 msgid "wc-c"
16461 msgstr ""
16462
16463 #. type: verbatim
16464 #: ../fish/guestfish-actions.pod:5223
16465 #, no-wrap
16466 msgid ""
16467 " wc-c path\n"
16468 "\n"
16469 msgstr ""
16470
16471 #. type: textblock
16472 #: ../fish/guestfish-actions.pod:5225 ../src/guestfs-actions.pod:8083
16473 msgid ""
16474 "This command counts the characters in a file, using the C<wc -c> external "
16475 "command."
16476 msgstr ""
16477
16478 #. type: =head2
16479 #: ../fish/guestfish-actions.pod:5228
16480 msgid "wc-l"
16481 msgstr ""
16482
16483 #. type: verbatim
16484 #: ../fish/guestfish-actions.pod:5230
16485 #, no-wrap
16486 msgid ""
16487 " wc-l path\n"
16488 "\n"
16489 msgstr ""
16490
16491 #. type: textblock
16492 #: ../fish/guestfish-actions.pod:5232 ../src/guestfs-actions.pod:8096
16493 msgid ""
16494 "This command counts the lines in a file, using the C<wc -l> external "
16495 "command."
16496 msgstr ""
16497
16498 #. type: =head2
16499 #: ../fish/guestfish-actions.pod:5235
16500 msgid "wc-w"
16501 msgstr ""
16502
16503 #. type: verbatim
16504 #: ../fish/guestfish-actions.pod:5237
16505 #, no-wrap
16506 msgid ""
16507 " wc-w path\n"
16508 "\n"
16509 msgstr ""
16510
16511 #. type: textblock
16512 #: ../fish/guestfish-actions.pod:5239 ../src/guestfs-actions.pod:8109
16513 msgid ""
16514 "This command counts the words in a file, using the C<wc -w> external "
16515 "command."
16516 msgstr ""
16517
16518 #. type: =head2
16519 #: ../fish/guestfish-actions.pod:5242
16520 msgid "write"
16521 msgstr ""
16522
16523 #. type: verbatim
16524 #: ../fish/guestfish-actions.pod:5244
16525 #, no-wrap
16526 msgid ""
16527 " write path content\n"
16528 "\n"
16529 msgstr ""
16530
16531 #. type: textblock
16532 #: ../fish/guestfish-actions.pod:5246 ../src/guestfs-actions.pod:8124
16533 msgid ""
16534 "This call creates a file called C<path>.  The content of the file is the "
16535 "string C<content> (which can contain any 8 bit data)."
16536 msgstr ""
16537
16538 #. type: textblock
16539 #: ../fish/guestfish-actions.pod:5249
16540 msgid "See also L</write-append>."
16541 msgstr ""
16542
16543 #. type: =head2
16544 #: ../fish/guestfish-actions.pod:5254
16545 msgid "write-append"
16546 msgstr ""
16547
16548 #. type: verbatim
16549 #: ../fish/guestfish-actions.pod:5256
16550 #, no-wrap
16551 msgid ""
16552 " write-append path content\n"
16553 "\n"
16554 msgstr ""
16555
16556 #. type: textblock
16557 #: ../fish/guestfish-actions.pod:5258 ../src/guestfs-actions.pod:8144
16558 msgid ""
16559 "This call appends C<content> to the end of file C<path>.  If C<path> does "
16560 "not exist, then a new file is created."
16561 msgstr ""
16562
16563 #. type: textblock
16564 #: ../fish/guestfish-actions.pod:5261
16565 msgid "See also L</write>."
16566 msgstr ""
16567
16568 #. type: =head2
16569 #: ../fish/guestfish-actions.pod:5266
16570 msgid "write-file"
16571 msgstr ""
16572
16573 #. type: verbatim
16574 #: ../fish/guestfish-actions.pod:5268
16575 #, no-wrap
16576 msgid ""
16577 " write-file path content size\n"
16578 "\n"
16579 msgstr ""
16580
16581 #. type: textblock
16582 #: ../fish/guestfish-actions.pod:5270 ../src/guestfs-actions.pod:8171
16583 msgid ""
16584 "This call creates a file called C<path>.  The contents of the file is the "
16585 "string C<content> (which can contain any 8 bit data), with length C<size>."
16586 msgstr ""
16587
16588 #. type: textblock
16589 #: ../fish/guestfish-actions.pod:5274 ../src/guestfs-actions.pod:8175
16590 msgid ""
16591 "As a special case, if C<size> is C<0> then the length is calculated using "
16592 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
16593 msgstr ""
16594
16595 #. type: textblock
16596 #: ../fish/guestfish-actions.pod:5278 ../src/guestfs-actions.pod:8179
16597 msgid ""
16598 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
16599 "I<not> work, even if the length is specified."
16600 msgstr ""
16601
16602 #. type: textblock
16603 #: ../fish/guestfish-actions.pod:5284
16604 msgid "I<This function is deprecated.> In new code, use the L</write> call instead."
16605 msgstr ""
16606
16607 #. type: =head2
16608 #: ../fish/guestfish-actions.pod:5291
16609 msgid "zegrep"
16610 msgstr ""
16611
16612 #. type: verbatim
16613 #: ../fish/guestfish-actions.pod:5293
16614 #, no-wrap
16615 msgid ""
16616 " zegrep regex path\n"
16617 "\n"
16618 msgstr ""
16619
16620 #. type: textblock
16621 #: ../fish/guestfish-actions.pod:5295 ../src/guestfs-actions.pod:8196
16622 msgid "This calls the external C<zegrep> program and returns the matching lines."
16623 msgstr ""
16624
16625 #. type: =head2
16626 #: ../fish/guestfish-actions.pod:5301
16627 msgid "zegrepi"
16628 msgstr ""
16629
16630 #. type: verbatim
16631 #: ../fish/guestfish-actions.pod:5303
16632 #, no-wrap
16633 msgid ""
16634 " zegrepi regex path\n"
16635 "\n"
16636 msgstr ""
16637
16638 #. type: textblock
16639 #: ../fish/guestfish-actions.pod:5305 ../src/guestfs-actions.pod:8215
16640 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
16641 msgstr ""
16642
16643 #. type: =head2
16644 #: ../fish/guestfish-actions.pod:5311
16645 msgid "zero"
16646 msgstr ""
16647
16648 #. type: verbatim
16649 #: ../fish/guestfish-actions.pod:5313
16650 #, no-wrap
16651 msgid ""
16652 " zero device\n"
16653 "\n"
16654 msgstr ""
16655
16656 #. type: textblock
16657 #: ../fish/guestfish-actions.pod:5315 ../src/guestfs-actions.pod:8233
16658 msgid "This command writes zeroes over the first few blocks of C<device>."
16659 msgstr ""
16660
16661 #. type: textblock
16662 #: ../fish/guestfish-actions.pod:5317 ../src/guestfs-actions.pod:8235
16663 msgid ""
16664 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
16665 "securely wipe the device).  It should be sufficient to remove any partition "
16666 "tables, filesystem superblocks and so on."
16667 msgstr ""
16668
16669 #. type: textblock
16670 #: ../fish/guestfish-actions.pod:5321 ../fish/guestfish-actions.pod:5336 ../src/guestfs-actions.pod:8239 ../src/guestfs-actions.pod:8265
16671 msgid ""
16672 "If blocks are already zero, then this command avoids writing zeroes.  This "
16673 "prevents the underlying device from becoming non-sparse or growing "
16674 "unnecessarily."
16675 msgstr ""
16676
16677 #. type: textblock
16678 #: ../fish/guestfish-actions.pod:5325
16679 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
16680 msgstr ""
16681
16682 #. type: =head2
16683 #: ../fish/guestfish-actions.pod:5328
16684 msgid "zero-device"
16685 msgstr ""
16686
16687 #. type: verbatim
16688 #: ../fish/guestfish-actions.pod:5330
16689 #, no-wrap
16690 msgid ""
16691 " zero-device device\n"
16692 "\n"
16693 msgstr ""
16694
16695 #. type: textblock
16696 #: ../fish/guestfish-actions.pod:5332
16697 msgid ""
16698 "This command writes zeroes over the entire C<device>.  Compare with L</zero> "
16699 "which just zeroes the first few blocks of a device."
16700 msgstr ""
16701
16702 #. type: =head2
16703 #: ../fish/guestfish-actions.pod:5340
16704 msgid "zerofree"
16705 msgstr ""
16706
16707 #. type: verbatim
16708 #: ../fish/guestfish-actions.pod:5342
16709 #, no-wrap
16710 msgid ""
16711 " zerofree device\n"
16712 "\n"
16713 msgstr ""
16714
16715 #. type: textblock
16716 #: ../fish/guestfish-actions.pod:5344 ../src/guestfs-actions.pod:8284
16717 msgid ""
16718 "This runs the I<zerofree> program on C<device>.  This program claims to zero "
16719 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
16720 "possible to compress the filesystem more effectively."
16721 msgstr ""
16722
16723 #. type: textblock
16724 #: ../fish/guestfish-actions.pod:5349 ../src/guestfs-actions.pod:8289
16725 msgid "You should B<not> run this program if the filesystem is mounted."
16726 msgstr ""
16727
16728 #. type: textblock
16729 #: ../fish/guestfish-actions.pod:5352 ../src/guestfs-actions.pod:8292
16730 msgid ""
16731 "It is possible that using this program can damage the filesystem or data on "
16732 "the filesystem."
16733 msgstr ""
16734
16735 #. type: =head2
16736 #: ../fish/guestfish-actions.pod:5355
16737 msgid "zfgrep"
16738 msgstr ""
16739
16740 #. type: verbatim
16741 #: ../fish/guestfish-actions.pod:5357
16742 #, no-wrap
16743 msgid ""
16744 " zfgrep pattern path\n"
16745 "\n"
16746 msgstr ""
16747
16748 #. type: textblock
16749 #: ../fish/guestfish-actions.pod:5359 ../src/guestfs-actions.pod:8306
16750 msgid "This calls the external C<zfgrep> program and returns the matching lines."
16751 msgstr ""
16752
16753 #. type: =head2
16754 #: ../fish/guestfish-actions.pod:5365
16755 msgid "zfgrepi"
16756 msgstr ""
16757
16758 #. type: verbatim
16759 #: ../fish/guestfish-actions.pod:5367
16760 #, no-wrap
16761 msgid ""
16762 " zfgrepi pattern path\n"
16763 "\n"
16764 msgstr ""
16765
16766 #. type: textblock
16767 #: ../fish/guestfish-actions.pod:5369 ../src/guestfs-actions.pod:8325
16768 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
16769 msgstr ""
16770
16771 #. type: =head2
16772 #: ../fish/guestfish-actions.pod:5375
16773 msgid "zfile"
16774 msgstr ""
16775
16776 #. type: verbatim
16777 #: ../fish/guestfish-actions.pod:5377
16778 #, no-wrap
16779 msgid ""
16780 " zfile meth path\n"
16781 "\n"
16782 msgstr ""
16783
16784 #. type: textblock
16785 #: ../fish/guestfish-actions.pod:5379 ../src/guestfs-actions.pod:8351
16786 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
16787 msgstr ""
16788
16789 #. type: textblock
16790 #: ../fish/guestfish-actions.pod:5382 ../src/guestfs-actions.pod:8354
16791 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
16792 msgstr ""
16793
16794 #. type: textblock
16795 #: ../fish/guestfish-actions.pod:5384
16796 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
16797 msgstr ""
16798
16799 #. type: textblock
16800 #: ../fish/guestfish-actions.pod:5387
16801 msgid "I<This function is deprecated.> In new code, use the L</file> call instead."
16802 msgstr ""
16803
16804 #. type: =head2
16805 #: ../fish/guestfish-actions.pod:5394
16806 msgid "zgrep"
16807 msgstr ""
16808
16809 #. type: verbatim
16810 #: ../fish/guestfish-actions.pod:5396
16811 #, no-wrap
16812 msgid ""
16813 " zgrep regex path\n"
16814 "\n"
16815 msgstr ""
16816
16817 #. type: textblock
16818 #: ../fish/guestfish-actions.pod:5398 ../src/guestfs-actions.pod:8371
16819 msgid "This calls the external C<zgrep> program and returns the matching lines."
16820 msgstr ""
16821
16822 #. type: =head2
16823 #: ../fish/guestfish-actions.pod:5404
16824 msgid "zgrepi"
16825 msgstr ""
16826
16827 #. type: verbatim
16828 #: ../fish/guestfish-actions.pod:5406
16829 #, no-wrap
16830 msgid ""
16831 " zgrepi regex path\n"
16832 "\n"
16833 msgstr ""
16834
16835 #. type: textblock
16836 #: ../fish/guestfish-actions.pod:5408 ../src/guestfs-actions.pod:8390
16837 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
16838 msgstr ""
16839
16840 #. type: =head2
16841 #: ../fish/guestfish-commands.pod:1
16842 msgid "alloc"
16843 msgstr ""
16844
16845 #. type: =head2
16846 #: ../fish/guestfish-commands.pod:3
16847 msgid "allocate"
16848 msgstr ""
16849
16850 #. type: verbatim
16851 #: ../fish/guestfish-commands.pod:5
16852 #, no-wrap
16853 msgid ""
16854 " alloc filename size\n"
16855 "\n"
16856 msgstr ""
16857
16858 #. type: textblock
16859 #: ../fish/guestfish-commands.pod:7
16860 msgid ""
16861 "This creates an empty (zeroed) file of the given size, and then adds so it "
16862 "can be further examined."
16863 msgstr ""
16864
16865 #. type: textblock
16866 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:193
16867 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
16868 msgstr ""
16869
16870 #. type: textblock
16871 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:195
16872 msgid "Size can be specified using standard suffixes, eg. C<1M>."
16873 msgstr ""
16874
16875 #. type: textblock
16876 #: ../fish/guestfish-commands.pod:14
16877 msgid ""
16878 "To create a sparse file, use L</sparse> instead.  To create a prepared disk "
16879 "image, see L</PREPARED DISK IMAGES>."
16880 msgstr ""
16881
16882 #. type: =head2
16883 #: ../fish/guestfish-commands.pod:17
16884 msgid "copy-in"
16885 msgstr ""
16886
16887 #. type: verbatim
16888 #: ../fish/guestfish-commands.pod:19
16889 #, no-wrap
16890 msgid ""
16891 " copy-in local [local ...] /remotedir\n"
16892 "\n"
16893 msgstr ""
16894
16895 #. type: textblock
16896 #: ../fish/guestfish-commands.pod:21
16897 msgid ""
16898 "C<copy-in> copies local files or directories recursively into the disk "
16899 "image, placing them in the directory called C</remotedir> (which must "
16900 "exist).  This guestfish meta-command turns into a sequence of L</tar-in> and "
16901 "other commands as necessary."
16902 msgstr ""
16903
16904 #. type: textblock
16905 #: ../fish/guestfish-commands.pod:26
16906 msgid ""
16907 "Multiple local files and directories can be specified, but the last "
16908 "parameter must always be a remote directory.  Wildcards cannot be used."
16909 msgstr ""
16910
16911 #. type: =head2
16912 #: ../fish/guestfish-commands.pod:30
16913 msgid "copy-out"
16914 msgstr ""
16915
16916 #. type: verbatim
16917 #: ../fish/guestfish-commands.pod:32
16918 #, no-wrap
16919 msgid ""
16920 " copy-out remote [remote ...] localdir\n"
16921 "\n"
16922 msgstr ""
16923
16924 #. type: textblock
16925 #: ../fish/guestfish-commands.pod:34
16926 msgid ""
16927 "C<copy-out> copies remote files or directories recursively out of the disk "
16928 "image, placing them on the host disk in a local directory called C<localdir> "
16929 "(which must exist).  This guestfish meta-command turns into a sequence of "
16930 "L</download>, L</tar-out> and other commands as necessary."
16931 msgstr ""
16932
16933 #. type: textblock
16934 #: ../fish/guestfish-commands.pod:40
16935 msgid ""
16936 "Multiple remote files and directories can be specified, but the last "
16937 "parameter must always be a local directory.  To download to the current "
16938 "directory, use C<.> as in:"
16939 msgstr ""
16940
16941 #. type: verbatim
16942 #: ../fish/guestfish-commands.pod:44
16943 #, no-wrap
16944 msgid ""
16945 " copy-out /home .\n"
16946 "\n"
16947 msgstr ""
16948
16949 #. type: textblock
16950 #: ../fish/guestfish-commands.pod:46
16951 msgid ""
16952 "Wildcards cannot be used in the ordinary command, but you can use them with "
16953 "the help of L</glob> like this:"
16954 msgstr ""
16955
16956 #. type: verbatim
16957 #: ../fish/guestfish-commands.pod:49
16958 #, no-wrap
16959 msgid ""
16960 " glob copy-out /home/* .\n"
16961 "\n"
16962 msgstr ""
16963
16964 #. type: =head2
16965 #: ../fish/guestfish-commands.pod:51
16966 msgid "display"
16967 msgstr ""
16968
16969 #. type: verbatim
16970 #: ../fish/guestfish-commands.pod:53
16971 #, no-wrap
16972 msgid ""
16973 " display filename\n"
16974 "\n"
16975 msgstr ""
16976
16977 #. type: textblock
16978 #: ../fish/guestfish-commands.pod:55
16979 msgid ""
16980 "Use C<display> (a graphical display program) to display an image file.  It "
16981 "downloads the file, and runs C<display> on it."
16982 msgstr ""
16983
16984 #. type: textblock
16985 #: ../fish/guestfish-commands.pod:58
16986 msgid ""
16987 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
16988 "environment variable.  For example to use the GNOME display program:"
16989 msgstr ""
16990
16991 #. type: verbatim
16992 #: ../fish/guestfish-commands.pod:61
16993 #, no-wrap
16994 msgid ""
16995 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
16996 "\n"
16997 msgstr ""
16998
16999 #. type: textblock
17000 #: ../fish/guestfish-commands.pod:63
17001 msgid "See also L<display(1)>."
17002 msgstr ""
17003
17004 #. type: =head2
17005 #: ../fish/guestfish-commands.pod:65
17006 msgid "echo"
17007 msgstr ""
17008
17009 #. type: verbatim
17010 #: ../fish/guestfish-commands.pod:67
17011 #, no-wrap
17012 msgid ""
17013 " echo [params ...]\n"
17014 "\n"
17015 msgstr ""
17016
17017 #. type: textblock
17018 #: ../fish/guestfish-commands.pod:69
17019 msgid "This echos the parameters to the terminal."
17020 msgstr ""
17021
17022 #. type: =head2
17023 #: ../fish/guestfish-commands.pod:71
17024 msgid "edit"
17025 msgstr ""
17026
17027 #. type: =head2
17028 #: ../fish/guestfish-commands.pod:73
17029 msgid "vi"
17030 msgstr ""
17031
17032 #. type: =head2
17033 #: ../fish/guestfish-commands.pod:75
17034 msgid "emacs"
17035 msgstr ""
17036
17037 #. type: verbatim
17038 #: ../fish/guestfish-commands.pod:77
17039 #, no-wrap
17040 msgid ""
17041 " edit filename\n"
17042 "\n"
17043 msgstr ""
17044
17045 #. type: textblock
17046 #: ../fish/guestfish-commands.pod:79
17047 msgid ""
17048 "This is used to edit a file.  It downloads the file, edits it locally using "
17049 "your editor, then uploads the result."
17050 msgstr ""
17051
17052 #. type: textblock
17053 #: ../fish/guestfish-commands.pod:82
17054 msgid ""
17055 "The editor is C<$EDITOR>.  However if you use the alternate commands C<vi> "
17056 "or C<emacs> you will get those corresponding editors."
17057 msgstr ""
17058
17059 #. type: =head2
17060 #: ../fish/guestfish-commands.pod:86
17061 msgid "glob"
17062 msgstr ""
17063
17064 #. type: verbatim
17065 #: ../fish/guestfish-commands.pod:88
17066 #, no-wrap
17067 msgid ""
17068 " glob command args...\n"
17069 "\n"
17070 msgstr ""
17071
17072 #. type: textblock
17073 #: ../fish/guestfish-commands.pod:90
17074 msgid ""
17075 "Expand wildcards in any paths in the args list, and run C<command> "
17076 "repeatedly on each matching path."
17077 msgstr ""
17078
17079 #. type: textblock
17080 #: ../fish/guestfish-commands.pod:93
17081 msgid "See L</WILDCARDS AND GLOBBING>."
17082 msgstr ""
17083
17084 #. type: =head2
17085 #: ../fish/guestfish-commands.pod:95
17086 msgid "hexedit"
17087 msgstr ""
17088
17089 #. type: verbatim
17090 #: ../fish/guestfish-commands.pod:97
17091 #, no-wrap
17092 msgid ""
17093 " hexedit <filename|device>\n"
17094 " hexedit <filename|device> <max>\n"
17095 " hexedit <filename|device> <start> <max>\n"
17096 "\n"
17097 msgstr ""
17098
17099 #. type: textblock
17100 #: ../fish/guestfish-commands.pod:101
17101 msgid ""
17102 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
17103 "device."
17104 msgstr ""
17105
17106 #. type: textblock
17107 #: ../fish/guestfish-commands.pod:104
17108 msgid ""
17109 "This command works by downloading potentially the whole file or device, "
17110 "editing it locally, then uploading it.  If the file or device is large, you "
17111 "have to specify which part you wish to edit by using C<max> and/or C<start> "
17112 "C<max> parameters.  C<start> and C<max> are specified in bytes, with the "
17113 "usual modifiers allowed such as C<1M> (1 megabyte)."
17114 msgstr ""
17115
17116 #. type: textblock
17117 #: ../fish/guestfish-commands.pod:111
17118 msgid "For example to edit the first few sectors of a disk you might do:"
17119 msgstr ""
17120
17121 #. type: verbatim
17122 #: ../fish/guestfish-commands.pod:114
17123 #, no-wrap
17124 msgid ""
17125 " hexedit /dev/sda 1M\n"
17126 "\n"
17127 msgstr ""
17128
17129 #. type: textblock
17130 #: ../fish/guestfish-commands.pod:116
17131 msgid ""
17132 "which would allow you to edit anywhere within the first megabyte of the "
17133 "disk."
17134 msgstr ""
17135
17136 #. type: textblock
17137 #: ../fish/guestfish-commands.pod:119
17138 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
17139 msgstr ""
17140
17141 #. type: verbatim
17142 #: ../fish/guestfish-commands.pod:121
17143 #, no-wrap
17144 msgid ""
17145 " hexedit /dev/sda1 0x400 0x400\n"
17146 "\n"
17147 msgstr ""
17148
17149 #. type: textblock
17150 #: ../fish/guestfish-commands.pod:123
17151 msgid "(assuming the superblock is in the standard location)."
17152 msgstr ""
17153
17154 #. type: textblock
17155 #: ../fish/guestfish-commands.pod:125
17156 msgid ""
17157 "This command requires the external L<hexedit(1)> program.  You can specify "
17158 "another program to use by setting the C<HEXEDITOR> environment variable."
17159 msgstr ""
17160
17161 #. type: textblock
17162 #: ../fish/guestfish-commands.pod:129
17163 msgid "See also L</hexdump>."
17164 msgstr ""
17165
17166 #. type: =head2
17167 #: ../fish/guestfish-commands.pod:131
17168 msgid "lcd"
17169 msgstr ""
17170
17171 #. type: verbatim
17172 #: ../fish/guestfish-commands.pod:133
17173 #, no-wrap
17174 msgid ""
17175 " lcd directory\n"
17176 "\n"
17177 msgstr ""
17178
17179 #. type: textblock
17180 #: ../fish/guestfish-commands.pod:135
17181 msgid "Change the local directory, ie. the current directory of guestfish itself."
17182 msgstr ""
17183
17184 #. type: textblock
17185 #: ../fish/guestfish-commands.pod:138
17186 msgid "Note that C<!cd> won't do what you might expect."
17187 msgstr ""
17188
17189 #. type: =head2
17190 #: ../fish/guestfish-commands.pod:140
17191 msgid "man"
17192 msgstr ""
17193
17194 #. type: =head2
17195 #: ../fish/guestfish-commands.pod:142
17196 msgid "manual"
17197 msgstr ""
17198
17199 #. type: verbatim
17200 #: ../fish/guestfish-commands.pod:144
17201 #, no-wrap
17202 msgid ""
17203 "  man\n"
17204 "\n"
17205 msgstr ""
17206
17207 #. type: textblock
17208 #: ../fish/guestfish-commands.pod:146
17209 msgid "Opens the manual page for guestfish."
17210 msgstr ""
17211
17212 #. type: =head2
17213 #: ../fish/guestfish-commands.pod:148
17214 msgid "more"
17215 msgstr ""
17216
17217 #. type: =head2
17218 #: ../fish/guestfish-commands.pod:150
17219 msgid "less"
17220 msgstr ""
17221
17222 #. type: verbatim
17223 #: ../fish/guestfish-commands.pod:152
17224 #, no-wrap
17225 msgid ""
17226 " more filename\n"
17227 "\n"
17228 msgstr ""
17229
17230 #. type: verbatim
17231 #: ../fish/guestfish-commands.pod:154
17232 #, no-wrap
17233 msgid ""
17234 " less filename\n"
17235 "\n"
17236 msgstr ""
17237
17238 #. type: textblock
17239 #: ../fish/guestfish-commands.pod:156
17240 msgid "This is used to view a file."
17241 msgstr ""
17242
17243 #. type: textblock
17244 #: ../fish/guestfish-commands.pod:158
17245 msgid ""
17246 "The default viewer is C<$PAGER>.  However if you use the alternate command "
17247 "C<less> you will get the C<less> command specifically."
17248 msgstr ""
17249
17250 #. type: =head2
17251 #: ../fish/guestfish-commands.pod:161
17252 msgid "reopen"
17253 msgstr ""
17254
17255 #. type: verbatim
17256 #: ../fish/guestfish-commands.pod:163
17257 #, no-wrap
17258 msgid ""
17259 "  reopen\n"
17260 "\n"
17261 msgstr ""
17262
17263 #. type: textblock
17264 #: ../fish/guestfish-commands.pod:165
17265 msgid ""
17266 "Close and reopen the libguestfs handle.  It is not necessary to use this "
17267 "normally, because the handle is closed properly when guestfish exits.  "
17268 "However this is occasionally useful for testing."
17269 msgstr ""
17270
17271 #. type: =head2
17272 #: ../fish/guestfish-commands.pod:169
17273 msgid "setenv"
17274 msgstr ""
17275
17276 #. type: verbatim
17277 #: ../fish/guestfish-commands.pod:171
17278 #, no-wrap
17279 msgid ""
17280 "  setenv VAR value\n"
17281 "\n"
17282 msgstr ""
17283
17284 #. type: textblock
17285 #: ../fish/guestfish-commands.pod:173
17286 msgid "Set the environment variable C<VAR> to the string C<value>."
17287 msgstr ""
17288
17289 #. type: textblock
17290 #: ../fish/guestfish-commands.pod:175
17291 msgid "To print the value of an environment variable use a shell command such as:"
17292 msgstr ""
17293
17294 #. type: verbatim
17295 #: ../fish/guestfish-commands.pod:178
17296 #, no-wrap
17297 msgid ""
17298 " !echo $VAR\n"
17299 "\n"
17300 msgstr ""
17301
17302 #. type: =head2
17303 #: ../fish/guestfish-commands.pod:180
17304 msgid "sparse"
17305 msgstr ""
17306
17307 #. type: verbatim
17308 #: ../fish/guestfish-commands.pod:182
17309 #, no-wrap
17310 msgid ""
17311 " sparse filename size\n"
17312 "\n"
17313 msgstr ""
17314
17315 #. type: textblock
17316 #: ../fish/guestfish-commands.pod:184
17317 msgid ""
17318 "This creates an empty sparse file of the given size, and then adds so it can "
17319 "be further examined."
17320 msgstr ""
17321
17322 #. type: textblock
17323 #: ../fish/guestfish-commands.pod:187
17324 msgid ""
17325 "In all respects it works the same as the L</alloc> command, except that the "
17326 "image file is allocated sparsely, which means that disk blocks are not "
17327 "assigned to the file until they are needed.  Sparse disk files only use "
17328 "space when written to, but they are slower and there is a danger you could "
17329 "run out of real disk space during a write operation."
17330 msgstr ""
17331
17332 #. type: =head2
17333 #: ../fish/guestfish-commands.pod:197
17334 msgid "supported"
17335 msgstr ""
17336
17337 #. type: verbatim
17338 #: ../fish/guestfish-commands.pod:199
17339 #, no-wrap
17340 msgid ""
17341 " supported\n"
17342 "\n"
17343 msgstr ""
17344
17345 #. type: textblock
17346 #: ../fish/guestfish-commands.pod:201
17347 msgid ""
17348 "This command returns a list of the optional groups known to the daemon, and "
17349 "indicates which ones are supported by this build of the libguestfs "
17350 "appliance."
17351 msgstr ""
17352
17353 #. type: textblock
17354 #: ../fish/guestfish-commands.pod:205
17355 msgid "See also L<guestfs(3)/AVAILABILITY>."
17356 msgstr ""
17357
17358 #. type: =head2
17359 #: ../fish/guestfish-commands.pod:207
17360 msgid "time"
17361 msgstr ""
17362
17363 #. type: verbatim
17364 #: ../fish/guestfish-commands.pod:209
17365 #, no-wrap
17366 msgid ""
17367 " time command args...\n"
17368 "\n"
17369 msgstr ""
17370
17371 #. type: textblock
17372 #: ../fish/guestfish-commands.pod:211
17373 msgid ""
17374 "Run the command as usual, but print the elapsed time afterwards.  This can "
17375 "be useful for benchmarking operations."
17376 msgstr ""
17377
17378 #. type: =head2
17379 #: ../fish/guestfish-commands.pod:214
17380 msgid "unsetenv"
17381 msgstr ""
17382
17383 #. type: verbatim
17384 #: ../fish/guestfish-commands.pod:216
17385 #, no-wrap
17386 msgid ""
17387 "  unsetenv VAR\n"
17388 "\n"
17389 msgstr ""
17390
17391 #. type: textblock
17392 #: ../fish/guestfish-commands.pod:218
17393 msgid "Remove C<VAR> from the environment."
17394 msgstr ""
17395
17396 #. type: textblock
17397 #: ../fish/guestfish.pod:5
17398 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
17399 msgstr ""
17400
17401 #. type: verbatim
17402 #: ../fish/guestfish.pod:9
17403 #, no-wrap
17404 msgid ""
17405 " guestfish [--options] [commands]\n"
17406 "\n"
17407 msgstr ""
17408
17409 #. type: verbatim
17410 #: ../fish/guestfish.pod:11
17411 #, no-wrap
17412 msgid ""
17413 " guestfish\n"
17414 "\n"
17415 msgstr ""
17416
17417 #. type: verbatim
17418 #: ../fish/guestfish.pod:13
17419 #, no-wrap
17420 msgid ""
17421 " guestfish [--ro|--rw] -a disk.img\n"
17422 "\n"
17423 msgstr ""
17424
17425 #. type: verbatim
17426 #: ../fish/guestfish.pod:15
17427 #, no-wrap
17428 msgid ""
17429 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
17430 "\n"
17431 msgstr ""
17432
17433 #. type: verbatim
17434 #: ../fish/guestfish.pod:17
17435 #, no-wrap
17436 msgid ""
17437 " guestfish -d libvirt-domain\n"
17438 "\n"
17439 msgstr ""
17440
17441 #. type: verbatim
17442 #: ../fish/guestfish.pod:19
17443 #, no-wrap
17444 msgid ""
17445 " guestfish [--ro|--rw] -a disk.img -i\n"
17446 "\n"
17447 msgstr ""
17448
17449 #. type: verbatim
17450 #: ../fish/guestfish.pod:21
17451 #, no-wrap
17452 msgid ""
17453 " guestfish -d libvirt-domain -i\n"
17454 "\n"
17455 msgstr ""
17456
17457 #. type: textblock
17458 #: ../fish/guestfish.pod:25
17459 msgid ""
17460 "Using guestfish in read/write mode on live virtual machines can be "
17461 "dangerous, potentially causing disk corruption.  Use the I<--ro> (read-only) "
17462 "option to use guestfish safely if the disk image or virtual machine might be "
17463 "live."
17464 msgstr ""
17465
17466 #. type: textblock
17467 #: ../fish/guestfish.pod:32
17468 msgid ""
17469 "Guestfish is a shell and command-line tool for examining and modifying "
17470 "virtual machine filesystems.  It uses libguestfs and exposes all of the "
17471 "functionality of the guestfs API, see L<guestfs(3)>."
17472 msgstr ""
17473
17474 #. type: textblock
17475 #: ../fish/guestfish.pod:36
17476 msgid ""
17477 "Guestfish gives you structured access to the libguestfs API, from shell "
17478 "scripts or the command line or interactively.  If you want to rescue a "
17479 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
17480 "command."
17481 msgstr ""
17482
17483 #. type: =head2
17484 #: ../fish/guestfish.pod:43
17485 msgid "As an interactive shell"
17486 msgstr ""
17487
17488 #. type: verbatim
17489 #: ../fish/guestfish.pod:45
17490 #, no-wrap
17491 msgid ""
17492 " $ guestfish\n"
17493 " \n"
17494 msgstr ""
17495
17496 #. type: verbatim
17497 #: ../fish/guestfish.pod:47
17498 #, no-wrap
17499 msgid ""
17500 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
17501 " editing virtual machine filesystems.\n"
17502 " \n"
17503 msgstr ""
17504
17505 #. type: verbatim
17506 #: ../fish/guestfish.pod:50
17507 #, no-wrap
17508 msgid ""
17509 " Type: 'help' for a list of commands\n"
17510 "       'man' to read the manual\n"
17511 "       'quit' to quit the shell\n"
17512 " \n"
17513 msgstr ""
17514
17515 #. type: verbatim
17516 #: ../fish/guestfish.pod:54
17517 #, no-wrap
17518 msgid ""
17519 " ><fs> add-ro disk.img\n"
17520 " ><fs> run\n"
17521 " ><fs> list-filesystems\n"
17522 " /dev/sda1: ext4\n"
17523 " /dev/vg_guest/lv_root: ext4\n"
17524 " /dev/vg_guest/lv_swap: swap\n"
17525 " ><fs> mount /dev/vg_guest/lv_root /\n"
17526 " ><fs> cat /etc/fstab\n"
17527 " # /etc/fstab\n"
17528 " # Created by anaconda\n"
17529 " [...]\n"
17530 " ><fs> exit\n"
17531 "\n"
17532 msgstr ""
17533
17534 #. type: =head2
17535 #: ../fish/guestfish.pod:67
17536 msgid "From shell scripts"
17537 msgstr ""
17538
17539 #. type: textblock
17540 #: ../fish/guestfish.pod:69
17541 msgid "Create a new C</etc/motd> file in a guest or disk image:"
17542 msgstr ""
17543
17544 #. type: verbatim
17545 #: ../fish/guestfish.pod:71
17546 #, no-wrap
17547 msgid ""
17548 " guestfish <<_EOF_\n"
17549 " add disk.img\n"
17550 " run\n"
17551 " mount /dev/vg_guest/lv_root /\n"
17552 " write /etc/motd \"Welcome, new users\"\n"
17553 " _EOF_\n"
17554 "\n"
17555 msgstr ""
17556
17557 #. type: textblock
17558 #: ../fish/guestfish.pod:78
17559 msgid "List the LVM logical volumes in a disk image:"
17560 msgstr ""
17561
17562 #. type: verbatim
17563 #: ../fish/guestfish.pod:80
17564 #, no-wrap
17565 msgid ""
17566 " guestfish -a disk.img --ro <<_EOF_\n"
17567 " run\n"
17568 " lvs\n"
17569 " _EOF_\n"
17570 "\n"
17571 msgstr ""
17572
17573 #. type: textblock
17574 #: ../fish/guestfish.pod:85
17575 msgid "List all the filesystems in a disk image:"
17576 msgstr ""
17577
17578 #. type: verbatim
17579 #: ../fish/guestfish.pod:87
17580 #, no-wrap
17581 msgid ""
17582 " guestfish -a disk.img --ro <<_EOF_\n"
17583 " run\n"
17584 " list-filesystems\n"
17585 " _EOF_\n"
17586 "\n"
17587 msgstr ""
17588
17589 #. type: =head2
17590 #: ../fish/guestfish.pod:92
17591 msgid "On one command line"
17592 msgstr ""
17593
17594 #. type: textblock
17595 #: ../fish/guestfish.pod:94 ../fish/virt-copy-in.pod:31
17596 msgid "Update C</etc/resolv.conf> in a guest:"
17597 msgstr ""
17598
17599 #. type: verbatim
17600 #: ../fish/guestfish.pod:96
17601 #, no-wrap
17602 msgid ""
17603 " guestfish \\\n"
17604 "   add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
17605 "   write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
17606 "\n"
17607 msgstr ""
17608
17609 #. type: textblock
17610 #: ../fish/guestfish.pod:100
17611 msgid "Edit C</boot/grub/grub.conf> interactively:"
17612 msgstr ""
17613
17614 #. type: verbatim
17615 #: ../fish/guestfish.pod:102
17616 #, no-wrap
17617 msgid ""
17618 " guestfish --rw --add disk.img \\\n"
17619 "   --mount /dev/vg_guest/lv_root \\\n"
17620 "   --mount /dev/sda1:/boot \\\n"
17621 "   edit /boot/grub/grub.conf\n"
17622 "\n"
17623 msgstr ""
17624
17625 #. type: =head2
17626 #: ../fish/guestfish.pod:107
17627 msgid "Mount disks automatically"
17628 msgstr ""
17629
17630 #. type: textblock
17631 #: ../fish/guestfish.pod:109
17632 msgid ""
17633 "Use the I<-i> option to automatically mount the disks from a virtual "
17634 "machine:"
17635 msgstr ""
17636
17637 #. type: verbatim
17638 #: ../fish/guestfish.pod:112
17639 #, no-wrap
17640 msgid ""
17641 " guestfish --ro -a disk.img -i cat /etc/group\n"
17642 "\n"
17643 msgstr ""
17644
17645 #. type: verbatim
17646 #: ../fish/guestfish.pod:114
17647 #, no-wrap
17648 msgid ""
17649 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
17650 "\n"
17651 msgstr ""
17652
17653 #. type: textblock
17654 #: ../fish/guestfish.pod:116
17655 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
17656 msgstr ""
17657
17658 #. type: verbatim
17659 #: ../fish/guestfish.pod:118
17660 #, no-wrap
17661 msgid ""
17662 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
17663 "\n"
17664 msgstr ""
17665
17666 #. type: =head2
17667 #: ../fish/guestfish.pod:120
17668 msgid "As a script interpreter"
17669 msgstr ""
17670
17671 #. type: textblock
17672 #: ../fish/guestfish.pod:122
17673 msgid "Create a 100MB disk containing an ext2-formatted partition:"
17674 msgstr ""
17675
17676 #. type: verbatim
17677 #: ../fish/guestfish.pod:124
17678 #, no-wrap
17679 msgid ""
17680 " #!/usr/bin/guestfish -f\n"
17681 " sparse test1.img 100M\n"
17682 " run\n"
17683 " part-disk /dev/sda mbr\n"
17684 " mkfs ext2 /dev/sda1\n"
17685 "\n"
17686 msgstr ""
17687
17688 #. type: =head2
17689 #: ../fish/guestfish.pod:130
17690 msgid "Start with a prepared disk"
17691 msgstr ""
17692
17693 #. type: textblock
17694 #: ../fish/guestfish.pod:132
17695 msgid ""
17696 "An alternate way to create a 100MB disk called C<test1.img> containing a "
17697 "single ext2-formatted partition:"
17698 msgstr ""
17699
17700 #. type: verbatim
17701 #: ../fish/guestfish.pod:135 ../src/guestfs.pod:2243
17702 #, no-wrap
17703 msgid ""
17704 " guestfish -N fs\n"
17705 "\n"
17706 msgstr ""
17707
17708 #. type: textblock
17709 #: ../fish/guestfish.pod:137
17710 msgid "To list what is available do:"
17711 msgstr ""
17712
17713 #. type: verbatim
17714 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:1042
17715 #, no-wrap
17716 msgid ""
17717 " guestfish -N help | less\n"
17718 "\n"
17719 msgstr ""
17720
17721 #. type: =head2
17722 #: ../fish/guestfish.pod:141
17723 msgid "Remote control"
17724 msgstr ""
17725
17726 #. type: verbatim
17727 #: ../fish/guestfish.pod:143
17728 #, no-wrap
17729 msgid ""
17730 " eval \"`guestfish --listen`\"\n"
17731 " guestfish --remote add-ro disk.img\n"
17732 " guestfish --remote run\n"
17733 " guestfish --remote lvs\n"
17734 "\n"
17735 msgstr ""
17736
17737 #. type: textblock
17738 #: ../fish/guestfish.pod:154
17739 msgid "Displays general help on options."
17740 msgstr ""
17741
17742 #. type: =item
17743 #: ../fish/guestfish.pod:158
17744 msgid "B<--cmd-help>"
17745 msgstr ""
17746
17747 #. type: textblock
17748 #: ../fish/guestfish.pod:160
17749 msgid "Lists all available guestfish commands."
17750 msgstr ""
17751
17752 #. type: =item
17753 #: ../fish/guestfish.pod:162
17754 msgid "B<-h cmd>"
17755 msgstr ""
17756
17757 #. type: =item
17758 #: ../fish/guestfish.pod:164
17759 msgid "B<--cmd-help cmd>"
17760 msgstr ""
17761
17762 #. type: textblock
17763 #: ../fish/guestfish.pod:166
17764 msgid "Displays detailed help on a single command C<cmd>."
17765 msgstr ""
17766
17767 #. type: =item
17768 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:96
17769 msgid "B<-a image>"
17770 msgstr ""
17771
17772 #. type: =item
17773 #: ../fish/guestfish.pod:170 ../fuse/guestmount.pod:98
17774 msgid "B<--add image>"
17775 msgstr ""
17776
17777 #. type: textblock
17778 #: ../fish/guestfish.pod:172
17779 msgid "Add a block device or virtual machine image to the shell."
17780 msgstr ""
17781
17782 #. type: textblock
17783 #: ../fish/guestfish.pod:177
17784 msgid ""
17785 "Using this flag is mostly equivalent to using the C<add> command, with "
17786 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
17787 "the I<--format=...> flag was given."
17788 msgstr ""
17789
17790 #. type: textblock
17791 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:109
17792 msgid ""
17793 "When used in conjunction with the I<-d> option, this specifies the libvirt "
17794 "URI to use.  The default is to use the default libvirt connection."
17795 msgstr ""
17796
17797 #. type: =item
17798 #: ../fish/guestfish.pod:189
17799 msgid "B<--csh>"
17800 msgstr ""
17801
17802 #. type: textblock
17803 #: ../fish/guestfish.pod:191
17804 msgid ""
17805 "If using the I<--listen> option and a csh-like shell, use this option.  See "
17806 "section L</REMOTE CONTROL AND CSH> below."
17807 msgstr ""
17808
17809 #. type: =item
17810 #: ../fish/guestfish.pod:194 ../fuse/guestmount.pod:113
17811 msgid "B<-d libvirt-domain>"
17812 msgstr ""
17813
17814 #. type: =item
17815 #: ../fish/guestfish.pod:196 ../fuse/guestmount.pod:115
17816 msgid "B<--domain libvirt-domain>"
17817 msgstr ""
17818
17819 #. type: textblock
17820 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:117
17821 msgid ""
17822 "Add disks from the named libvirt domain.  If the I<--ro> option is also "
17823 "used, then any libvirt domain can be used.  However in write mode, only "
17824 "libvirt domains which are shut down can be named here."
17825 msgstr ""
17826
17827 #. type: textblock
17828 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:121
17829 msgid "Domain UUIDs can be used instead of names."
17830 msgstr ""
17831
17832 #. type: textblock
17833 #: ../fish/guestfish.pod:204
17834 msgid ""
17835 "Using this flag is mostly equivalent to using the C<add-domain> command, "
17836 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
17837 "if the I<--format:...> flag was given."
17838 msgstr ""
17839
17840 #. type: =item
17841 #: ../fish/guestfish.pod:208
17842 msgid "B<-D>"
17843 msgstr ""
17844
17845 #. type: =item
17846 #: ../fish/guestfish.pod:210
17847 msgid "B<--no-dest-paths>"
17848 msgstr ""
17849
17850 #. type: textblock
17851 #: ../fish/guestfish.pod:212
17852 msgid ""
17853 "Don't tab-complete paths on the guest filesystem.  It is useful to be able "
17854 "to hit the tab key to complete paths on the guest filesystem, but this "
17855 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
17856 "allow this feature to be disabled."
17857 msgstr ""
17858
17859 #. type: textblock
17860 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:137
17861 msgid ""
17862 "When prompting for keys and passphrases, guestfish normally turns echoing "
17863 "off so you cannot see what you are typing.  If you are not worried about "
17864 "Tempest attacks and there is no one else in the room you can specify this "
17865 "flag to see what you are typing."
17866 msgstr ""
17867
17868 #. type: =item
17869 #: ../fish/guestfish.pod:224
17870 msgid "B<-f file>"
17871 msgstr ""
17872
17873 #. type: =item
17874 #: ../fish/guestfish.pod:226
17875 msgid "B<--file file>"
17876 msgstr ""
17877
17878 #. type: textblock
17879 #: ../fish/guestfish.pod:228
17880 msgid "Read commands from C<file>.  To write pure guestfish scripts, use:"
17881 msgstr ""
17882
17883 #. type: verbatim
17884 #: ../fish/guestfish.pod:231
17885 #, no-wrap
17886 msgid ""
17887 " #!/usr/bin/guestfish -f\n"
17888 "\n"
17889 msgstr ""
17890
17891 #. type: verbatim
17892 #: ../fish/guestfish.pod:244
17893 #, no-wrap
17894 msgid ""
17895 " guestfish --format=raw -a disk.img\n"
17896 "\n"
17897 msgstr ""
17898
17899 #. type: verbatim
17900 #: ../fish/guestfish.pod:248
17901 #, no-wrap
17902 msgid ""
17903 " guestfish --format=raw -a disk.img --format -a another.img\n"
17904 "\n"
17905 msgstr ""
17906
17907 #. type: textblock
17908 #: ../fish/guestfish.pod:253
17909 msgid ""
17910 "If you have untrusted raw-format guest disk images, you should use this "
17911 "option to specify the disk format.  This avoids a possible security problem "
17912 "with malicious guests (CVE-2010-3851).  See also L</add-drive-opts>."
17913 msgstr ""
17914
17915 #. type: =item
17916 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:166
17917 msgid "B<--inspector>"
17918 msgstr ""
17919
17920 #. type: textblock
17921 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:168
17922 msgid ""
17923 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
17924 "system and mount filesystems as they would be mounted on the real virtual "
17925 "machine."
17926 msgstr ""
17927
17928 #. type: textblock
17929 #: ../fish/guestfish.pod:266
17930 msgid "Typical usage is either:"
17931 msgstr ""
17932
17933 #. type: verbatim
17934 #: ../fish/guestfish.pod:268
17935 #, no-wrap
17936 msgid ""
17937 " guestfish -d myguest -i\n"
17938 "\n"
17939 msgstr ""
17940
17941 #. type: textblock
17942 #: ../fish/guestfish.pod:270
17943 msgid "(for an inactive libvirt domain called I<myguest>), or:"
17944 msgstr ""
17945
17946 #. type: verbatim
17947 #: ../fish/guestfish.pod:272
17948 #, no-wrap
17949 msgid ""
17950 " guestfish --ro -d myguest -i\n"
17951 "\n"
17952 msgstr ""
17953
17954 #. type: textblock
17955 #: ../fish/guestfish.pod:274
17956 msgid "(for active domains, readonly), or specify the block device directly:"
17957 msgstr ""
17958
17959 #. type: verbatim
17960 #: ../fish/guestfish.pod:276
17961 #, no-wrap
17962 msgid ""
17963 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
17964 "\n"
17965 msgstr ""
17966
17967 #. type: textblock
17968 #: ../fish/guestfish.pod:278
17969 msgid ""
17970 "Note that the command line syntax changed slightly over older versions of "
17971 "guestfish.  You can still use the old syntax:"
17972 msgstr ""
17973
17974 #. type: verbatim
17975 #: ../fish/guestfish.pod:281
17976 #, no-wrap
17977 msgid ""
17978 " guestfish [--ro] -i disk.img\n"
17979 "\n"
17980 msgstr ""
17981
17982 #. type: verbatim
17983 #: ../fish/guestfish.pod:283
17984 #, no-wrap
17985 msgid ""
17986 " guestfish [--ro] -i libvirt-domain\n"
17987 "\n"
17988 msgstr ""
17989
17990 #. type: textblock
17991 #: ../fish/guestfish.pod:285
17992 msgid ""
17993 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
17994 "then using other commands to mount the filesystems that were found."
17995 msgstr ""
17996
17997 #. type: =item
17998 #: ../fish/guestfish.pod:294
17999 msgid "B<--listen>"
18000 msgstr ""
18001
18002 #. type: textblock
18003 #: ../fish/guestfish.pod:296
18004 msgid ""
18005 "Fork into the background and listen for remote commands.  See section "
18006 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
18007 msgstr ""
18008
18009 #. type: =item
18010 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:177
18011 msgid "B<--live>"
18012 msgstr ""
18013
18014 #. type: textblock
18015 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:179
18016 msgid ""
18017 "Connect to a live virtual machine.  (Experimental, see "
18018 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
18019 msgstr ""
18020
18021 #. type: =item
18022 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:182
18023 msgid "B<-m dev[:mountpoint[:options]]>"
18024 msgstr ""
18025
18026 #. type: =item
18027 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:184
18028 msgid "B<--mount dev[:mountpoint[:options]]>"
18029 msgstr ""
18030
18031 #. type: textblock
18032 #: ../fish/guestfish.pod:308
18033 msgid "Mount the named partition or logical volume on the given mountpoint."
18034 msgstr ""
18035
18036 #. type: textblock
18037 #: ../fish/guestfish.pod:310
18038 msgid "If the mountpoint is omitted, it defaults to C</>."
18039 msgstr ""
18040
18041 #. type: textblock
18042 #: ../fish/guestfish.pod:312
18043 msgid "You have to mount something on C</> before most commands will work."
18044 msgstr ""
18045
18046 #. type: textblock
18047 #: ../fish/guestfish.pod:314
18048 msgid ""
18049 "If any I<-m> or I<--mount> options are given, the guest is automatically "
18050 "launched."
18051 msgstr ""
18052
18053 #. type: textblock
18054 #: ../fish/guestfish.pod:317
18055 msgid ""
18056 "If you don't know what filesystems a disk image contains, you can either run "
18057 "guestfish without this option, then list the partitions, filesystems and LVs "
18058 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
18059 "commands), or you can use the L<virt-filesystems(1)> program."
18060 msgstr ""
18061
18062 #. type: textblock
18063 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:192
18064 msgid ""
18065 "The third (and rarely used) part of the mount parameter is the list of mount "
18066 "options used to mount the underlying filesystem.  If this is not given, then "
18067 "the mount options are either the empty string or C<ro> (the latter if the "
18068 "I<--ro> flag is used).  By specifying the mount options, you override this "
18069 "default choice.  Probably the only time you would use this is to enable ACLs "
18070 "and/or extended attributes if the filesystem can support them:"
18071 msgstr ""
18072
18073 #. type: verbatim
18074 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:200
18075 #, no-wrap
18076 msgid ""
18077 " -m /dev/sda1:/:acl,user_xattr\n"
18078 "\n"
18079 msgstr ""
18080
18081 #. type: textblock
18082 #: ../fish/guestfish.pod:333
18083 msgid "Using this flag is equivalent to using the C<mount-options> command."
18084 msgstr ""
18085
18086 #. type: =item
18087 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:202 ../resize/virt-resize.pod:435
18088 msgid "B<-n>"
18089 msgstr ""
18090
18091 #. type: =item
18092 #: ../fish/guestfish.pod:337 ../fuse/guestmount.pod:204
18093 msgid "B<--no-sync>"
18094 msgstr ""
18095
18096 #. type: textblock
18097 #: ../fish/guestfish.pod:339
18098 msgid ""
18099 "Disable autosync.  This is enabled by default.  See the discussion of "
18100 "autosync in the L<guestfs(3)> manpage."
18101 msgstr ""
18102
18103 #. type: =item
18104 #: ../fish/guestfish.pod:342
18105 msgid "B<-N type>"
18106 msgstr ""
18107
18108 #. type: =item
18109 #: ../fish/guestfish.pod:344
18110 msgid "B<--new type>"
18111 msgstr ""
18112
18113 #. type: =item
18114 #: ../fish/guestfish.pod:346
18115 msgid "B<-N help>"
18116 msgstr ""
18117
18118 #. type: textblock
18119 #: ../fish/guestfish.pod:348
18120 msgid ""
18121 "Prepare a fresh disk image formatted as \"type\".  This is an alternative to "
18122 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
18123 "preformatted disk with a filesystem and adds it.  See L</PREPARED DISK "
18124 "IMAGES> below."
18125 msgstr ""
18126
18127 #. type: =item
18128 #: ../fish/guestfish.pod:353
18129 msgid "B<--progress-bars>"
18130 msgstr ""
18131
18132 #. type: textblock
18133 #: ../fish/guestfish.pod:355
18134 msgid "Enable progress bars, even when guestfish is used non-interactively."
18135 msgstr ""
18136
18137 #. type: textblock
18138 #: ../fish/guestfish.pod:357
18139 msgid ""
18140 "Progress bars are enabled by default when guestfish is used as an "
18141 "interactive shell."
18142 msgstr ""
18143
18144 #. type: =item
18145 #: ../fish/guestfish.pod:360
18146 msgid "B<--no-progress-bars>"
18147 msgstr ""
18148
18149 #. type: textblock
18150 #: ../fish/guestfish.pod:362
18151 msgid "Disable progress bars."
18152 msgstr ""
18153
18154 #. type: =item
18155 #: ../fish/guestfish.pod:364
18156 msgid "B<--remote[=pid]>"
18157 msgstr ""
18158
18159 #. type: textblock
18160 #: ../fish/guestfish.pod:366
18161 msgid ""
18162 "Send remote commands to C<$GUESTFISH_PID> or C<pid>.  See section L</REMOTE "
18163 "CONTROL GUESTFISH OVER A SOCKET> below."
18164 msgstr ""
18165
18166 #. type: =item
18167 #: ../fish/guestfish.pod:369 ../fuse/guestmount.pod:248 ../rescue/virt-rescue.pod:189
18168 msgid "B<-r>"
18169 msgstr ""
18170
18171 #. type: =item
18172 #: ../fish/guestfish.pod:371 ../fuse/guestmount.pod:250 ../rescue/virt-rescue.pod:191
18173 msgid "B<--ro>"
18174 msgstr ""
18175
18176 #. type: textblock
18177 #: ../fish/guestfish.pod:373
18178 msgid ""
18179 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
18180 "mounts are done read-only."
18181 msgstr ""
18182
18183 #. type: textblock
18184 #: ../fish/guestfish.pod:376 ../rescue/virt-rescue.pod:195
18185 msgid ""
18186 "The option must always be used if the disk image or virtual machine might be "
18187 "running, and is generally recommended in cases where you don't need write "
18188 "access to the disk."
18189 msgstr ""
18190
18191 #. type: textblock
18192 #: ../fish/guestfish.pod:380
18193 msgid ""
18194 "Note that prepared disk images created with I<-N> are not affected by this "
18195 "option.  Also commands like C<add> are not affected - you have to specify "
18196 "the C<readonly:true> option explicitly if you need it."
18197 msgstr ""
18198
18199 #. type: textblock
18200 #: ../fish/guestfish.pod:384
18201 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
18202 msgstr ""
18203
18204 #. type: =item
18205 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:262 ../rescue/virt-rescue.pod:201
18206 msgid "B<--selinux>"
18207 msgstr ""
18208
18209 #. type: textblock
18210 #: ../fish/guestfish.pod:388
18211 msgid "Enable SELinux support for the guest.  See L<guestfs(3)/SELINUX>."
18212 msgstr ""
18213
18214 #. type: textblock
18215 #: ../fish/guestfish.pod:394
18216 msgid ""
18217 "Enable very verbose messages.  This is particularly useful if you find a "
18218 "bug."
18219 msgstr ""
18220
18221 #. type: textblock
18222 #: ../fish/guestfish.pod:401
18223 msgid "Display the guestfish / libguestfs version number and exit."
18224 msgstr ""
18225
18226 #. type: =item
18227 #: ../fish/guestfish.pod:403 ../fuse/guestmount.pod:278 ../rescue/virt-rescue.pod:231
18228 msgid "B<-w>"
18229 msgstr ""
18230
18231 #. type: =item
18232 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:280 ../rescue/virt-rescue.pod:233
18233 msgid "B<--rw>"
18234 msgstr ""
18235
18236 #. type: textblock
18237 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:282
18238 msgid ""
18239 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
18240 "mounts are done read-write."
18241 msgstr ""
18242
18243 #. type: textblock
18244 #: ../fish/guestfish.pod:410
18245 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
18246 msgstr ""
18247
18248 #. type: textblock
18249 #: ../fish/guestfish.pod:414
18250 msgid "Echo each command before executing it."
18251 msgstr ""
18252
18253 #. type: =head1
18254 #: ../fish/guestfish.pod:418
18255 msgid "COMMANDS ON COMMAND LINE"
18256 msgstr ""
18257
18258 #. type: textblock
18259 #: ../fish/guestfish.pod:420
18260 msgid "Any additional (non-option) arguments are treated as commands to execute."
18261 msgstr ""
18262
18263 #. type: textblock
18264 #: ../fish/guestfish.pod:423
18265 msgid ""
18266 "Commands to execute should be separated by a colon (C<:>), where the colon "
18267 "is a separate parameter.  Thus:"
18268 msgstr ""
18269
18270 #. type: verbatim
18271 #: ../fish/guestfish.pod:426
18272 #, no-wrap
18273 msgid ""
18274 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
18275 "\n"
18276 msgstr ""
18277
18278 #. type: textblock
18279 #: ../fish/guestfish.pod:428
18280 msgid ""
18281 "If there are no additional arguments, then we enter a shell, either an "
18282 "interactive shell with a prompt (if the input is a terminal) or a "
18283 "non-interactive shell."
18284 msgstr ""
18285
18286 #. type: textblock
18287 #: ../fish/guestfish.pod:432
18288 msgid ""
18289 "In either command line mode or non-interactive shell, the first command that "
18290 "gives an error causes the whole shell to exit.  In interactive mode (with a "
18291 "prompt) if a command fails, you can continue to enter commands."
18292 msgstr ""
18293
18294 #. type: =head1
18295 #: ../fish/guestfish.pod:437
18296 msgid "USING launch (OR run)"
18297 msgstr ""
18298
18299 #. type: textblock
18300 #: ../fish/guestfish.pod:439
18301 msgid ""
18302 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
18303 "then launch it, then mount any disks you need, and finally issue "
18304 "actions/commands.  So the general order of the day is:"
18305 msgstr ""
18306
18307 #. type: textblock
18308 #: ../fish/guestfish.pod:447
18309 msgid "add or -a/--add"
18310 msgstr ""
18311
18312 #. type: textblock
18313 #: ../fish/guestfish.pod:451
18314 msgid "launch (aka run)"
18315 msgstr ""
18316
18317 #. type: textblock
18318 #: ../fish/guestfish.pod:455
18319 msgid "mount or -m/--mount"
18320 msgstr ""
18321
18322 #. type: textblock
18323 #: ../fish/guestfish.pod:459
18324 msgid "any other commands"
18325 msgstr ""
18326
18327 #. type: textblock
18328 #: ../fish/guestfish.pod:463
18329 msgid ""
18330 "C<run> is a synonym for C<launch>.  You must C<launch> (or C<run>)  your "
18331 "guest before mounting or performing any other commands."
18332 msgstr ""
18333
18334 #. type: textblock
18335 #: ../fish/guestfish.pod:466
18336 msgid ""
18337 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
18338 "I<--new> options were given then C<run> is done automatically, simply "
18339 "because guestfish can't perform the action you asked for without doing this."
18340 msgstr ""
18341
18342 #. type: =head1
18343 #: ../fish/guestfish.pod:471
18344 msgid "OPENING DISKS FOR READ AND WRITE"
18345 msgstr ""
18346
18347 #. type: textblock
18348 #: ../fish/guestfish.pod:473
18349 msgid ""
18350 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
18351 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
18352 "I<-i> and I<-m> open disk images read-only or for writing."
18353 msgstr ""
18354
18355 #. type: textblock
18356 #: ../fish/guestfish.pod:478
18357 msgid ""
18358 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
18359 "opening disk images supplied on the command line for write.  To open a disk "
18360 "image read-only you have to do I<-a image --ro>."
18361 msgstr ""
18362
18363 #. type: textblock
18364 #: ../fish/guestfish.pod:482
18365 msgid ""
18366 "This matters: If you accidentally open a live VM disk image writable then "
18367 "you will cause irreversible disk corruption."
18368 msgstr ""
18369
18370 #. type: textblock
18371 #: ../fish/guestfish.pod:485
18372 msgid ""
18373 "In a future libguestfs we intend to change the default the other way.  Disk "
18374 "images will be opened read-only.  You will have to either specify "
18375 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
18376 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
18377 "access for disk images specified by those other command line options."
18378 msgstr ""
18379
18380 #. type: textblock
18381 #: ../fish/guestfish.pod:492
18382 msgid ""
18383 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
18384 "which does nothing (it is already the default).  However it is highly "
18385 "recommended that you use this option to indicate that you need write access, "
18386 "and prepare your scripts for the day when this option will be required for "
18387 "write access."
18388 msgstr ""
18389
18390 #. type: textblock
18391 #: ../fish/guestfish.pod:498
18392 msgid ""
18393 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
18394 "other libguestfs program apart from guestfish and guestmount."
18395 msgstr ""
18396
18397 #. type: =head1
18398 #: ../fish/guestfish.pod:501
18399 msgid "QUOTING"
18400 msgstr ""
18401
18402 #. type: textblock
18403 #: ../fish/guestfish.pod:503
18404 msgid ""
18405 "You can quote ordinary parameters using either single or double quotes.  For "
18406 "example:"
18407 msgstr ""
18408
18409 #. type: verbatim
18410 #: ../fish/guestfish.pod:506
18411 #, no-wrap
18412 msgid ""
18413 " add \"file with a space.img\"\n"
18414 "\n"
18415 msgstr ""
18416
18417 #. type: verbatim
18418 #: ../fish/guestfish.pod:508
18419 #, no-wrap
18420 msgid ""
18421 " rm '/file name'\n"
18422 "\n"
18423 msgstr ""
18424
18425 #. type: verbatim
18426 #: ../fish/guestfish.pod:510
18427 #, no-wrap
18428 msgid ""
18429 " rm '/\"'\n"
18430 "\n"
18431 msgstr ""
18432
18433 #. type: textblock
18434 #: ../fish/guestfish.pod:512
18435 msgid ""
18436 "A few commands require a list of strings to be passed.  For these, use a "
18437 "whitespace-separated list, enclosed in quotes.  Strings containing "
18438 "whitespace to be passed through must be enclosed in single quotes.  A "
18439 "literal single quote must be escaped with a backslash."
18440 msgstr ""
18441
18442 #. type: verbatim
18443 #: ../fish/guestfish.pod:517
18444 #, no-wrap
18445 msgid ""
18446 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
18447 " command \"/bin/echo 'foo      bar'\"\n"
18448 " command \"/bin/echo \\'foo\\'\"\n"
18449 "\n"
18450 msgstr ""
18451
18452 #. type: =head2
18453 #: ../fish/guestfish.pod:521
18454 msgid "ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS"
18455 msgstr ""
18456
18457 #. type: textblock
18458 #: ../fish/guestfish.pod:523
18459 msgid ""
18460 "In double-quoted arguments (only) use backslash to insert special "
18461 "characters:"
18462 msgstr ""
18463
18464 #. type: =item
18465 #: ../fish/guestfish.pod:528
18466 msgid "C<\\a>"
18467 msgstr ""
18468
18469 #. type: textblock
18470 #: ../fish/guestfish.pod:530
18471 msgid "Alert (bell) character."
18472 msgstr ""
18473
18474 #. type: =item
18475 #: ../fish/guestfish.pod:532
18476 msgid "C<\\b>"
18477 msgstr ""
18478
18479 #. type: textblock
18480 #: ../fish/guestfish.pod:534
18481 msgid "Backspace character."
18482 msgstr ""
18483
18484 #. type: =item
18485 #: ../fish/guestfish.pod:536
18486 msgid "C<\\f>"
18487 msgstr ""
18488
18489 #. type: textblock
18490 #: ../fish/guestfish.pod:538
18491 msgid "Form feed character."
18492 msgstr ""
18493
18494 #. type: =item
18495 #: ../fish/guestfish.pod:540
18496 msgid "C<\\n>"
18497 msgstr ""
18498
18499 #. type: textblock
18500 #: ../fish/guestfish.pod:542
18501 msgid "Newline character."
18502 msgstr ""
18503
18504 #. type: =item
18505 #: ../fish/guestfish.pod:544
18506 msgid "C<\\r>"
18507 msgstr ""
18508
18509 #. type: textblock
18510 #: ../fish/guestfish.pod:546
18511 msgid "Carriage return character."
18512 msgstr ""
18513
18514 #. type: =item
18515 #: ../fish/guestfish.pod:548
18516 msgid "C<\\t>"
18517 msgstr ""
18518
18519 #. type: textblock
18520 #: ../fish/guestfish.pod:550
18521 msgid "Horizontal tab character."
18522 msgstr ""
18523
18524 #. type: =item
18525 #: ../fish/guestfish.pod:552
18526 msgid "C<\\v>"
18527 msgstr ""
18528
18529 #. type: textblock
18530 #: ../fish/guestfish.pod:554
18531 msgid "Vertical tab character."
18532 msgstr ""
18533
18534 #. type: =item
18535 #: ../fish/guestfish.pod:556
18536 msgid "C<\\\">"
18537 msgstr ""
18538
18539 #. type: textblock
18540 #: ../fish/guestfish.pod:558
18541 msgid "A literal double quote character."
18542 msgstr ""
18543
18544 #. type: =item
18545 #: ../fish/guestfish.pod:560
18546 msgid "C<\\ooo>"
18547 msgstr ""
18548
18549 #. type: textblock
18550 #: ../fish/guestfish.pod:562
18551 msgid ""
18552 "A character with octal value I<ooo>.  There must be precisely 3 octal digits "
18553 "(unlike C)."
18554 msgstr ""
18555
18556 #. type: =item
18557 #: ../fish/guestfish.pod:565
18558 msgid "C<\\xhh>"
18559 msgstr ""
18560
18561 #. type: textblock
18562 #: ../fish/guestfish.pod:567
18563 msgid "A character with hex value I<hh>.  There must be precisely 2 hex digits."
18564 msgstr ""
18565
18566 #. type: textblock
18567 #: ../fish/guestfish.pod:570
18568 msgid ""
18569 "In the current implementation C<\\000> and C<\\x00> cannot be used in "
18570 "strings."
18571 msgstr ""
18572
18573 #. type: =item
18574 #: ../fish/guestfish.pod:573
18575 msgid "C<\\\\>"
18576 msgstr ""
18577
18578 #. type: textblock
18579 #: ../fish/guestfish.pod:575
18580 msgid "A literal backslash character."
18581 msgstr ""
18582
18583 #. type: =head1
18584 #: ../fish/guestfish.pod:579
18585 msgid "OPTIONAL ARGUMENTS"
18586 msgstr ""
18587
18588 #. type: textblock
18589 #: ../fish/guestfish.pod:581
18590 msgid ""
18591 "Some commands take optional arguments.  These arguments appear in this "
18592 "documentation as C<[argname:..]>.  You can use them as in these examples:"
18593 msgstr ""
18594
18595 #. type: verbatim
18596 #: ../fish/guestfish.pod:585
18597 #, no-wrap
18598 msgid ""
18599 " add-drive-opts filename\n"
18600 "\n"
18601 msgstr ""
18602
18603 #. type: verbatim
18604 #: ../fish/guestfish.pod:587
18605 #, no-wrap
18606 msgid ""
18607 " add-drive-opts filename readonly:true\n"
18608 "\n"
18609 msgstr ""
18610
18611 #. type: verbatim
18612 #: ../fish/guestfish.pod:589
18613 #, no-wrap
18614 msgid ""
18615 " add-drive-opts filename format:qcow2 readonly:false\n"
18616 "\n"
18617 msgstr ""
18618
18619 #. type: textblock
18620 #: ../fish/guestfish.pod:591
18621 msgid ""
18622 "Each optional argument can appear at most once.  All optional arguments must "
18623 "appear after the required ones."
18624 msgstr ""
18625
18626 #. type: =head1
18627 #: ../fish/guestfish.pod:594
18628 msgid "NUMBERS"
18629 msgstr ""
18630
18631 #. type: textblock
18632 #: ../fish/guestfish.pod:596
18633 msgid "This section applies to all commands which can take integers as parameters."
18634 msgstr ""
18635
18636 #. type: =head2
18637 #: ../fish/guestfish.pod:599
18638 msgid "SIZE SUFFIX"
18639 msgstr ""
18640
18641 #. type: textblock
18642 #: ../fish/guestfish.pod:601
18643 msgid ""
18644 "When the command takes a parameter measured in bytes, you can use one of the "
18645 "following suffixes to specify kilobytes, megabytes and larger sizes:"
18646 msgstr ""
18647
18648 #. type: =item
18649 #: ../fish/guestfish.pod:607
18650 msgid "B<k> or B<K> or B<KiB>"
18651 msgstr ""
18652
18653 #. type: textblock
18654 #: ../fish/guestfish.pod:609
18655 msgid "The size in kilobytes (multiplied by 1024)."
18656 msgstr ""
18657
18658 #. type: =item
18659 #: ../fish/guestfish.pod:611
18660 msgid "B<KB>"
18661 msgstr ""
18662
18663 #. type: textblock
18664 #: ../fish/guestfish.pod:613
18665 msgid "The size in SI 1000 byte units."
18666 msgstr ""
18667
18668 #. type: =item
18669 #: ../fish/guestfish.pod:615
18670 msgid "B<M> or B<MiB>"
18671 msgstr ""
18672
18673 #. type: textblock
18674 #: ../fish/guestfish.pod:617
18675 msgid "The size in megabytes (multiplied by 1048576)."
18676 msgstr ""
18677
18678 #. type: =item
18679 #: ../fish/guestfish.pod:619
18680 msgid "B<MB>"
18681 msgstr ""
18682
18683 #. type: textblock
18684 #: ../fish/guestfish.pod:621
18685 msgid "The size in SI 1000000 byte units."
18686 msgstr ""
18687
18688 #. type: =item
18689 #: ../fish/guestfish.pod:623
18690 msgid "B<G> or B<GiB>"
18691 msgstr ""
18692
18693 #. type: textblock
18694 #: ../fish/guestfish.pod:625
18695 msgid "The size in gigabytes (multiplied by 2**30)."
18696 msgstr ""
18697
18698 #. type: =item
18699 #: ../fish/guestfish.pod:627
18700 msgid "B<GB>"
18701 msgstr ""
18702
18703 #. type: textblock
18704 #: ../fish/guestfish.pod:629
18705 msgid "The size in SI 10**9 byte units."
18706 msgstr ""
18707
18708 #. type: =item
18709 #: ../fish/guestfish.pod:631
18710 msgid "B<T> or B<TiB>"
18711 msgstr ""
18712
18713 #. type: textblock
18714 #: ../fish/guestfish.pod:633
18715 msgid "The size in terabytes (multiplied by 2**40)."
18716 msgstr ""
18717
18718 #. type: =item
18719 #: ../fish/guestfish.pod:635
18720 msgid "B<TB>"
18721 msgstr ""
18722
18723 #. type: textblock
18724 #: ../fish/guestfish.pod:637
18725 msgid "The size in SI 10**12 byte units."
18726 msgstr ""
18727
18728 #. type: =item
18729 #: ../fish/guestfish.pod:639
18730 msgid "B<P> or B<PiB>"
18731 msgstr ""
18732
18733 #. type: textblock
18734 #: ../fish/guestfish.pod:641
18735 msgid "The size in petabytes (multiplied by 2**50)."
18736 msgstr ""
18737
18738 #. type: =item
18739 #: ../fish/guestfish.pod:643
18740 msgid "B<PB>"
18741 msgstr ""
18742
18743 #. type: textblock
18744 #: ../fish/guestfish.pod:645
18745 msgid "The size in SI 10**15 byte units."
18746 msgstr ""
18747
18748 #. type: =item
18749 #: ../fish/guestfish.pod:647
18750 msgid "B<E> or B<EiB>"
18751 msgstr ""
18752
18753 #. type: textblock
18754 #: ../fish/guestfish.pod:649
18755 msgid "The size in exabytes (multiplied by 2**60)."
18756 msgstr ""
18757
18758 #. type: =item
18759 #: ../fish/guestfish.pod:651
18760 msgid "B<EB>"
18761 msgstr ""
18762
18763 #. type: textblock
18764 #: ../fish/guestfish.pod:653
18765 msgid "The size in SI 10**18 byte units."
18766 msgstr ""
18767
18768 #. type: =item
18769 #: ../fish/guestfish.pod:655
18770 msgid "B<Z> or B<ZiB>"
18771 msgstr ""
18772
18773 #. type: textblock
18774 #: ../fish/guestfish.pod:657
18775 msgid "The size in zettabytes (multiplied by 2**70)."
18776 msgstr ""
18777
18778 #. type: =item
18779 #: ../fish/guestfish.pod:659
18780 msgid "B<ZB>"
18781 msgstr ""
18782
18783 #. type: textblock
18784 #: ../fish/guestfish.pod:661
18785 msgid "The size in SI 10**21 byte units."
18786 msgstr ""
18787
18788 #. type: =item
18789 #: ../fish/guestfish.pod:663
18790 msgid "B<Y> or B<YiB>"
18791 msgstr ""
18792
18793 #. type: textblock
18794 #: ../fish/guestfish.pod:665
18795 msgid "The size in yottabytes (multiplied by 2**80)."
18796 msgstr ""
18797
18798 #. type: =item
18799 #: ../fish/guestfish.pod:667
18800 msgid "B<YB>"
18801 msgstr ""
18802
18803 #. type: textblock
18804 #: ../fish/guestfish.pod:669
18805 msgid "The size in SI 10**24 byte units."
18806 msgstr ""
18807
18808 #. type: verbatim
18809 #: ../fish/guestfish.pod:675
18810 #, no-wrap
18811 msgid ""
18812 " truncate-size /file 1G\n"
18813 "\n"
18814 msgstr ""
18815
18816 #. type: textblock
18817 #: ../fish/guestfish.pod:677
18818 msgid "would truncate the file to 1 gigabyte."
18819 msgstr ""
18820
18821 #. type: textblock
18822 #: ../fish/guestfish.pod:679
18823 msgid ""
18824 "Be careful because a few commands take sizes in kilobytes or megabytes "
18825 "(eg. the parameter to L</memsize> is specified in megabytes already).  "
18826 "Adding a suffix will probably not do what you expect."
18827 msgstr ""
18828
18829 #. type: =head2
18830 #: ../fish/guestfish.pod:683
18831 msgid "OCTAL AND HEXADECIMAL NUMBERS"
18832 msgstr ""
18833
18834 #. type: textblock
18835 #: ../fish/guestfish.pod:685
18836 msgid ""
18837 "For specifying the radix (base) use the C convention: C<0> to prefix an "
18838 "octal number or C<0x> to prefix a hexadecimal number.  For example:"
18839 msgstr ""
18840
18841 #. type: verbatim
18842 #: ../fish/guestfish.pod:688
18843 #, no-wrap
18844 msgid ""
18845 " 1234      decimal number 1234\n"
18846 " 02322     octal number, equivalent to decimal 1234\n"
18847 " 0x4d2     hexadecimal number, equivalent to decimal 1234\n"
18848 "\n"
18849 msgstr ""
18850
18851 #. type: textblock
18852 #: ../fish/guestfish.pod:692
18853 msgid ""
18854 "When using the C<chmod> command, you almost always want to specify an octal "
18855 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
18856 "L<chmod(1)> program):"
18857 msgstr ""
18858
18859 #. type: verbatim
18860 #: ../fish/guestfish.pod:696
18861 #, no-wrap
18862 msgid ""
18863 " chmod 0777 /public  # OK\n"
18864 " chmod 777 /public   # WRONG! This is mode 777 decimal = 01411 octal.\n"
18865 "\n"
18866 msgstr ""
18867
18868 #. type: textblock
18869 #: ../fish/guestfish.pod:699
18870 msgid ""
18871 "Commands that return numbers usually print them in decimal, but some "
18872 "commands print numbers in other radices (eg. C<umask> prints the mode in "
18873 "octal, preceeded by C<0>)."
18874 msgstr ""
18875
18876 #. type: =head1
18877 #: ../fish/guestfish.pod:703
18878 msgid "WILDCARDS AND GLOBBING"
18879 msgstr ""
18880
18881 #. type: textblock
18882 #: ../fish/guestfish.pod:705
18883 msgid ""
18884 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
18885 "(globbing) by default.  So for example the following will not do what you "
18886 "expect:"
18887 msgstr ""
18888
18889 #. type: verbatim
18890 #: ../fish/guestfish.pod:709
18891 #, no-wrap
18892 msgid ""
18893 " rm-rf /home/*\n"
18894 "\n"
18895 msgstr ""
18896
18897 #. type: textblock
18898 #: ../fish/guestfish.pod:711
18899 msgid ""
18900 "Assuming you don't have a directory called literally C</home/*> then the "
18901 "above command will return an error."
18902 msgstr ""
18903
18904 #. type: textblock
18905 #: ../fish/guestfish.pod:714
18906 msgid "To perform wildcard expansion, use the C<glob> command."
18907 msgstr ""
18908
18909 #. type: verbatim
18910 #: ../fish/guestfish.pod:716
18911 #, no-wrap
18912 msgid ""
18913 " glob rm-rf /home/*\n"
18914 "\n"
18915 msgstr ""
18916
18917 #. type: textblock
18918 #: ../fish/guestfish.pod:718
18919 msgid ""
18920 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
18921 "many times), equivalent to:"
18922 msgstr ""
18923
18924 #. type: verbatim
18925 #: ../fish/guestfish.pod:721
18926 #, no-wrap
18927 msgid ""
18928 " rm-rf /home/jim\n"
18929 " rm-rf /home/joe\n"
18930 " rm-rf /home/mary\n"
18931 "\n"
18932 msgstr ""
18933
18934 #. type: textblock
18935 #: ../fish/guestfish.pod:725
18936 msgid "C<glob> only works on simple guest paths and not on device names."
18937 msgstr ""
18938
18939 #. type: textblock
18940 #: ../fish/guestfish.pod:727
18941 msgid ""
18942 "If you have several parameters, each containing a wildcard, then glob will "
18943 "perform a Cartesian product."
18944 msgstr ""
18945
18946 #. type: =head1
18947 #: ../fish/guestfish.pod:730
18948 msgid "COMMENTS"
18949 msgstr ""
18950
18951 #. type: textblock
18952 #: ../fish/guestfish.pod:732
18953 msgid ""
18954 "Any line which starts with a I<#> character is treated as a comment and "
18955 "ignored.  The I<#> can optionally be preceeded by whitespace, but B<not> by "
18956 "a command.  For example:"
18957 msgstr ""
18958
18959 #. type: verbatim
18960 #: ../fish/guestfish.pod:736
18961 #, no-wrap
18962 msgid ""
18963 " # this is a comment\n"
18964 "         # this is a comment\n"
18965 " foo # NOT a comment\n"
18966 "\n"
18967 msgstr ""
18968
18969 #. type: textblock
18970 #: ../fish/guestfish.pod:740
18971 msgid "Blank lines are also ignored."
18972 msgstr ""
18973
18974 #. type: =head1
18975 #: ../fish/guestfish.pod:742
18976 msgid "RUNNING COMMANDS LOCALLY"
18977 msgstr ""
18978
18979 #. type: textblock
18980 #: ../fish/guestfish.pod:744
18981 msgid ""
18982 "Any line which starts with a I<!> character is treated as a command sent to "
18983 "the local shell (C</bin/sh> or whatever L<system(3)> uses).  For example:"
18984 msgstr ""
18985
18986 #. type: verbatim
18987 #: ../fish/guestfish.pod:748
18988 #, no-wrap
18989 msgid ""
18990 " !mkdir local\n"
18991 " tgz-out /remote local/remote-data.tar.gz\n"
18992 "\n"
18993 msgstr ""
18994
18995 #. type: textblock
18996 #: ../fish/guestfish.pod:751
18997 msgid ""
18998 "will create a directory C<local> on the host, and then export the contents "
18999 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>.  "
19000 "(See C<tgz-out>)."
19001 msgstr ""
19002
19003 #. type: textblock
19004 #: ../fish/guestfish.pod:755
19005 msgid ""
19006 "To change the local directory, use the C<lcd> command.  C<!cd> will have no "
19007 "effect, due to the way that subprocesses work in Unix."
19008 msgstr ""
19009
19010 #. type: =head2
19011 #: ../fish/guestfish.pod:758
19012 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
19013 msgstr ""
19014
19015 #. type: textblock
19016 #: ../fish/guestfish.pod:760
19017 msgid ""
19018 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
19019 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
19020 "and executed as guestfish commands."
19021 msgstr ""
19022
19023 #. type: textblock
19024 #: ../fish/guestfish.pod:764
19025 msgid ""
19026 "Thus you can use shell script to construct arbitrary guestfish commands "
19027 "which are then parsed by guestfish."
19028 msgstr ""
19029
19030 #. type: textblock
19031 #: ../fish/guestfish.pod:767
19032 msgid ""
19033 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
19034 "through C</foo.100>) using guestfish commands alone.  However this is simple "
19035 "if we use a shell script to create the guestfish commands for us:"
19036 msgstr ""
19037
19038 #. type: verbatim
19039 #: ../fish/guestfish.pod:772
19040 #, no-wrap
19041 msgid ""
19042 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
19043 "\n"
19044 msgstr ""
19045
19046 #. type: textblock
19047 #: ../fish/guestfish.pod:774
19048 msgid "or with names like C</foo.001>:"
19049 msgstr ""
19050
19051 #. type: verbatim
19052 #: ../fish/guestfish.pod:776
19053 #, no-wrap
19054 msgid ""
19055 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
19056 "\n"
19057 msgstr ""
19058
19059 #. type: textblock
19060 #: ../fish/guestfish.pod:778
19061 msgid ""
19062 "When using guestfish interactively it can be helpful to just run the shell "
19063 "script first (ie. remove the initial C<E<lt>> character so it is just an "
19064 "ordinary I<!> local command), see what guestfish commands it would run, and "
19065 "when you are happy with those prepend the C<E<lt>> character to run the "
19066 "guestfish commands for real."
19067 msgstr ""
19068
19069 #. type: =head1
19070 #: ../fish/guestfish.pod:784
19071 msgid "PIPES"
19072 msgstr ""
19073
19074 #. type: textblock
19075 #: ../fish/guestfish.pod:786
19076 msgid ""
19077 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
19078 "command (a guestfish command) to the second command (any host command).  For "
19079 "example:"
19080 msgstr ""
19081
19082 #. type: verbatim
19083 #: ../fish/guestfish.pod:790
19084 #, no-wrap
19085 msgid ""
19086 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
19087 "\n"
19088 msgstr ""
19089
19090 #. type: textblock
19091 #: ../fish/guestfish.pod:792
19092 msgid ""
19093 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
19094 "program).  The above command would list all accounts in the guest filesystem "
19095 "which have UID 0, ie. root accounts including backdoors.  Other examples:"
19096 msgstr ""
19097
19098 #. type: verbatim
19099 #: ../fish/guestfish.pod:797
19100 #, no-wrap
19101 msgid ""
19102 " hexdump /bin/ls | head\n"
19103 " list-devices | tail -1\n"
19104 " tgz-out / - | tar ztf -\n"
19105 "\n"
19106 msgstr ""
19107
19108 #. type: textblock
19109 #: ../fish/guestfish.pod:801
19110 msgid ""
19111 "The space before the pipe symbol is required, any space after the pipe "
19112 "symbol is optional.  Everything after the pipe symbol is just passed "
19113 "straight to the host shell, so it can contain redirections, globs and "
19114 "anything else that makes sense on the host side."
19115 msgstr ""
19116
19117 #. type: textblock
19118 #: ../fish/guestfish.pod:806
19119 msgid ""
19120 "To use a literal argument which begins with a pipe symbol, you have to quote "
19121 "it, eg:"
19122 msgstr ""
19123
19124 #. type: verbatim
19125 #: ../fish/guestfish.pod:809
19126 #, no-wrap
19127 msgid ""
19128 " echo \"|\"\n"
19129 "\n"
19130 msgstr ""
19131
19132 #. type: =head1
19133 #: ../fish/guestfish.pod:811
19134 msgid "HOME DIRECTORIES"
19135 msgstr ""
19136
19137 #. type: textblock
19138 #: ../fish/guestfish.pod:813
19139 msgid ""
19140 "If a parameter starts with the character C<~> then the tilde may be expanded "
19141 "as a home directory path (either C<~> for the current user's home directory, "
19142 "or C<~user> for another user)."
19143 msgstr ""
19144
19145 #. type: textblock
19146 #: ../fish/guestfish.pod:817
19147 msgid ""
19148 "Note that home directory expansion happens for users known I<on the host>, "
19149 "not in the guest filesystem."
19150 msgstr ""
19151
19152 #. type: textblock
19153 #: ../fish/guestfish.pod:820
19154 msgid ""
19155 "To use a literal argument which begins with a tilde, you have to quote it, "
19156 "eg:"
19157 msgstr ""
19158
19159 #. type: verbatim
19160 #: ../fish/guestfish.pod:823
19161 #, no-wrap
19162 msgid ""
19163 " echo \"~\"\n"
19164 "\n"
19165 msgstr ""
19166
19167 #. type: =head2
19168 #: ../fish/guestfish.pod:825 ../src/guestfs.pod:534
19169 msgid "ENCRYPTED DISKS"
19170 msgstr ""
19171
19172 #. type: textblock
19173 #: ../fish/guestfish.pod:827
19174 msgid ""
19175 "Libguestfs has some support for Linux guests encrypted according to the "
19176 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
19177 "disk encryption systems used by modern Linux guests.  Currently only "
19178 "LVM-on-LUKS is supported."
19179 msgstr ""
19180
19181 #. type: textblock
19182 #: ../fish/guestfish.pod:832
19183 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
19184 msgstr ""
19185
19186 #. type: verbatim
19187 #: ../fish/guestfish.pod:834
19188 #, no-wrap
19189 msgid ""
19190 " ><fs> vfs-type /dev/sda2\n"
19191 " crypto_LUKS\n"
19192 "\n"
19193 msgstr ""
19194
19195 #. type: textblock
19196 #: ../fish/guestfish.pod:837
19197 msgid ""
19198 "Then open those devices using L</luks-open>.  This creates a device-mapper "
19199 "device called C</dev/mapper/luksdev>."
19200 msgstr ""
19201
19202 #. type: verbatim
19203 #: ../fish/guestfish.pod:840
19204 #, no-wrap
19205 msgid ""
19206 " ><fs> luks-open /dev/sda2 luksdev\n"
19207 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
19208 "\n"
19209 msgstr ""
19210
19211 #. type: textblock
19212 #: ../fish/guestfish.pod:843
19213 msgid ""
19214 "Finally you have to tell LVM to scan for volume groups on the newly created "
19215 "mapper device:"
19216 msgstr ""
19217
19218 #. type: verbatim
19219 #: ../fish/guestfish.pod:846
19220 #, no-wrap
19221 msgid ""
19222 " vgscan\n"
19223 " vg-activate-all true\n"
19224 "\n"
19225 msgstr ""
19226
19227 #. type: textblock
19228 #: ../fish/guestfish.pod:849
19229 msgid "The logical volume(s) can now be mounted in the usual way."
19230 msgstr ""
19231
19232 #. type: textblock
19233 #: ../fish/guestfish.pod:851
19234 msgid ""
19235 "Before closing a LUKS device you must unmount any logical volumes on it and "
19236 "deactivate the volume groups by calling C<vg-activate false VG> on each "
19237 "one.  Then you can close the mapper device:"
19238 msgstr ""
19239
19240 #. type: verbatim
19241 #: ../fish/guestfish.pod:855
19242 #, no-wrap
19243 msgid ""
19244 " vg-activate false /dev/VG\n"
19245 " luks-close /dev/mapper/luksdev\n"
19246 "\n"
19247 msgstr ""
19248
19249 #. type: textblock
19250 #: ../fish/guestfish.pod:860
19251 msgid ""
19252 "If a path is prefixed with C<win:> then you can use Windows-style drive "
19253 "letters and paths (with some limitations).  The following commands are "
19254 "equivalent:"
19255 msgstr ""
19256
19257 #. type: verbatim
19258 #: ../fish/guestfish.pod:864
19259 #, no-wrap
19260 msgid ""
19261 " file /WINDOWS/system32/config/system.LOG\n"
19262 "\n"
19263 msgstr ""
19264
19265 #. type: verbatim
19266 #: ../fish/guestfish.pod:866
19267 #, no-wrap
19268 msgid ""
19269 " file win:\\windows\\system32\\config\\system.log\n"
19270 "\n"
19271 msgstr ""
19272
19273 #. type: verbatim
19274 #: ../fish/guestfish.pod:868
19275 #, no-wrap
19276 msgid ""
19277 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
19278 "\n"
19279 msgstr ""
19280
19281 #. type: textblock
19282 #: ../fish/guestfish.pod:870
19283 msgid ""
19284 "The parameter is rewritten \"behind the scenes\" by looking up the position "
19285 "where the drive is mounted, prepending that to the path, changing all "
19286 "backslash characters to forward slash, then resolving the result using "
19287 "L</case-sensitive-path>.  For example if the E: drive was mounted on C</e> "
19288 "then the parameter might be rewritten like this:"
19289 msgstr ""
19290
19291 #. type: verbatim
19292 #: ../fish/guestfish.pod:876
19293 #, no-wrap
19294 msgid ""
19295 " win:e:\\foo\\bar => /e/FOO/bar\n"
19296 "\n"
19297 msgstr ""
19298
19299 #. type: textblock
19300 #: ../fish/guestfish.pod:878
19301 msgid "This only works in argument positions that expect a path."
19302 msgstr ""
19303
19304 #. type: =head1
19305 #: ../fish/guestfish.pod:880
19306 msgid "UPLOADING AND DOWNLOADING FILES"
19307 msgstr ""
19308
19309 #. type: textblock
19310 #: ../fish/guestfish.pod:882
19311 msgid ""
19312 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
19313 "others which upload from or download to a local file, you can use the "
19314 "special filename C<-> to mean \"from stdin\" or \"to stdout\".  For example:"
19315 msgstr ""
19316
19317 #. type: verbatim
19318 #: ../fish/guestfish.pod:886
19319 #, no-wrap
19320 msgid ""
19321 " upload - /foo\n"
19322 "\n"
19323 msgstr ""
19324
19325 #. type: textblock
19326 #: ../fish/guestfish.pod:888
19327 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
19328 msgstr ""
19329
19330 #. type: verbatim
19331 #: ../fish/guestfish.pod:891
19332 #, no-wrap
19333 msgid ""
19334 " tar-out /etc - | tar tf -\n"
19335 "\n"
19336 msgstr ""
19337
19338 #. type: textblock
19339 #: ../fish/guestfish.pod:893
19340 msgid ""
19341 "writes the tarball to stdout and then pipes that into the external \"tar\" "
19342 "command (see L</PIPES>)."
19343 msgstr ""
19344
19345 #. type: textblock
19346 #: ../fish/guestfish.pod:896
19347 msgid ""
19348 "When using C<-> to read from stdin, the input is read up to the end of "
19349 "stdin.  You can also use a special \"heredoc\"-like syntax to read up to "
19350 "some arbitrary end marker:"
19351 msgstr ""
19352
19353 #. type: verbatim
19354 #: ../fish/guestfish.pod:900
19355 #, no-wrap
19356 msgid ""
19357 " upload -<<END /foo\n"
19358 " input line 1\n"
19359 " input line 2\n"
19360 " input line 3\n"
19361 " END\n"
19362 "\n"
19363 msgstr ""
19364
19365 #. type: textblock
19366 #: ../fish/guestfish.pod:906
19367 msgid ""
19368 "Any string of characters can be used instead of C<END>.  The end marker must "
19369 "appear on a line of its own, without any preceeding or following characters "
19370 "(not even spaces)."
19371 msgstr ""
19372
19373 #. type: textblock
19374 #: ../fish/guestfish.pod:910
19375 msgid ""
19376 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
19377 "upload local files (so-called \"FileIn\" parameters in the generator)."
19378 msgstr ""
19379
19380 #. type: =head1
19381 #: ../fish/guestfish.pod:913
19382 msgid "EXIT ON ERROR BEHAVIOUR"
19383 msgstr ""
19384
19385 #. type: textblock
19386 #: ../fish/guestfish.pod:915
19387 msgid ""
19388 "By default, guestfish will ignore any errors when in interactive mode "
19389 "(ie. taking commands from a human over a tty), and will exit on the first "
19390 "error in non-interactive mode (scripts, commands given on the command line)."
19391 msgstr ""
19392
19393 #. type: textblock
19394 #: ../fish/guestfish.pod:920
19395 msgid ""
19396 "If you prefix a command with a I<-> character, then that command will not "
19397 "cause guestfish to exit, even if that (one) command returns an error."
19398 msgstr ""
19399
19400 #. type: =head1
19401 #: ../fish/guestfish.pod:924
19402 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
19403 msgstr ""
19404
19405 #. type: textblock
19406 #: ../fish/guestfish.pod:926
19407 msgid ""
19408 "Guestfish can be remote-controlled over a socket.  This is useful "
19409 "particularly in shell scripts where you want to make several different "
19410 "changes to a filesystem, but you don't want the overhead of starting up a "
19411 "guestfish process each time."
19412 msgstr ""
19413
19414 #. type: textblock
19415 #: ../fish/guestfish.pod:931
19416 msgid "Start a guestfish server process using:"
19417 msgstr ""
19418
19419 #. type: verbatim
19420 #: ../fish/guestfish.pod:933
19421 #, no-wrap
19422 msgid ""
19423 " eval \"`guestfish --listen`\"\n"
19424 "\n"
19425 msgstr ""
19426
19427 #. type: textblock
19428 #: ../fish/guestfish.pod:935
19429 msgid "and then send it commands by doing:"
19430 msgstr ""
19431
19432 #. type: verbatim
19433 #: ../fish/guestfish.pod:937
19434 #, no-wrap
19435 msgid ""
19436 " guestfish --remote cmd [...]\n"
19437 "\n"
19438 msgstr ""
19439
19440 #. type: textblock
19441 #: ../fish/guestfish.pod:939
19442 msgid "To cause the server to exit, send it the exit command:"
19443 msgstr ""
19444
19445 #. type: textblock
19446 #: ../fish/guestfish.pod:943
19447 msgid ""
19448 "Note that the server will normally exit if there is an error in a command.  "
19449 "You can change this in the usual way.  See section L</EXIT ON ERROR "
19450 "BEHAVIOUR>."
19451 msgstr ""
19452
19453 #. type: =head2
19454 #: ../fish/guestfish.pod:947
19455 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
19456 msgstr ""
19457
19458 #. type: textblock
19459 #: ../fish/guestfish.pod:949
19460 msgid ""
19461 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
19462 "is how the I<--remote> option knows where to send the commands.  You can "
19463 "have several guestfish listener processes running using:"
19464 msgstr ""
19465
19466 #. type: verbatim
19467 #: ../fish/guestfish.pod:953
19468 #, no-wrap
19469 msgid ""
19470 " eval \"`guestfish --listen`\"\n"
19471 " pid1=$GUESTFISH_PID\n"
19472 " eval \"`guestfish --listen`\"\n"
19473 " pid2=$GUESTFISH_PID\n"
19474 " ...\n"
19475 " guestfish --remote=$pid1 cmd\n"
19476 " guestfish --remote=$pid2 cmd\n"
19477 "\n"
19478 msgstr ""
19479
19480 #. type: =head2
19481 #: ../fish/guestfish.pod:961
19482 msgid "REMOTE CONTROL AND CSH"
19483 msgstr ""
19484
19485 #. type: textblock
19486 #: ../fish/guestfish.pod:963
19487 msgid ""
19488 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
19489 "option:"
19490 msgstr ""
19491
19492 #. type: verbatim
19493 #: ../fish/guestfish.pod:966
19494 #, no-wrap
19495 msgid ""
19496 " eval \"`guestfish --listen --csh`\"\n"
19497 "\n"
19498 msgstr ""
19499
19500 #. type: =head2
19501 #: ../fish/guestfish.pod:968
19502 msgid "REMOTE CONTROL DETAILS"
19503 msgstr ""
19504
19505 #. type: textblock
19506 #: ../fish/guestfish.pod:970
19507 msgid ""
19508 "Remote control happens over a Unix domain socket called "
19509 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
19510 "of the process, and C<$PID> is the process ID of the server."
19511 msgstr ""
19512
19513 #. type: textblock
19514 #: ../fish/guestfish.pod:974
19515 msgid "Guestfish client and server versions must match exactly."
19516 msgstr ""
19517
19518 #. type: =head2
19519 #: ../fish/guestfish.pod:976
19520 msgid "USING REMOTE CONTROL ROBUSTLY FROM SHELL SCRIPTS"
19521 msgstr ""
19522
19523 #. type: textblock
19524 #: ../fish/guestfish.pod:978
19525 msgid ""
19526 "From Bash, you can use the following code which creates a guestfish "
19527 "instance, correctly quotes the command line, handles failure to start, and "
19528 "cleans up guestfish when the script exits:"
19529 msgstr ""
19530
19531 #. type: verbatim
19532 #: ../fish/guestfish.pod:982 ../src/guestfs.pod:980
19533 #, no-wrap
19534 msgid ""
19535 " #!/bin/bash -\n"
19536 " \n"
19537 msgstr ""
19538
19539 #. type: verbatim
19540 #: ../fish/guestfish.pod:986
19541 #, no-wrap
19542 msgid ""
19543 " guestfish[0]=\"guestfish\"\n"
19544 " guestfish[1]=\"--listen\"\n"
19545 " guestfish[2]=\"--ro\"\n"
19546 " guestfish[3]=\"-a\"\n"
19547 " guestfish[4]=\"disk.img\"\n"
19548 " \n"
19549 msgstr ""
19550
19551 #. type: verbatim
19552 #: ../fish/guestfish.pod:992
19553 #, no-wrap
19554 msgid ""
19555 " GUESTFISH_PID=\n"
19556 " eval $(\"${guestfish[@]}\")\n"
19557 " if [ -z \"$GUESTFISH_PID\" ]; then\n"
19558 "     echo \"error: guestfish didn't start up, see error messages above\"\n"
19559 "     exit 1\n"
19560 " fi\n"
19561 " \n"
19562 msgstr ""
19563
19564 #. type: verbatim
19565 #: ../fish/guestfish.pod:999
19566 #, no-wrap
19567 msgid ""
19568 " cleanup_guestfish ()\n"
19569 " {\n"
19570 "     guestfish --remote -- exit >/dev/null 2>&1 ||:\n"
19571 " }\n"
19572 " trap cleanup_guestfish EXIT ERR\n"
19573 " \n"
19574 msgstr ""
19575
19576 #. type: verbatim
19577 #: ../fish/guestfish.pod:1005
19578 #, no-wrap
19579 msgid ""
19580 " guestfish --remote -- run\n"
19581 " \n"
19582 msgstr ""
19583
19584 #. type: verbatim
19585 #: ../fish/guestfish.pod:1007
19586 #, no-wrap
19587 msgid ""
19588 " # ...\n"
19589 "\n"
19590 msgstr ""
19591
19592 #. type: =head2
19593 #: ../fish/guestfish.pod:1009
19594 msgid "REMOTE CONTROL RUN COMMAND HANGING"
19595 msgstr ""
19596
19597 #. type: textblock
19598 #: ../fish/guestfish.pod:1011
19599 msgid ""
19600 "Using the C<run> (or C<launch>) command remotely in a command substitution "
19601 "context hangs, ie. don't do (note the backquotes):"
19602 msgstr ""
19603
19604 #. type: verbatim
19605 #: ../fish/guestfish.pod:1014
19606 #, no-wrap
19607 msgid ""
19608 " a=`guestfish --remote run`\n"
19609 "\n"
19610 msgstr ""
19611
19612 #. type: textblock
19613 #: ../fish/guestfish.pod:1016
19614 msgid ""
19615 "Since the C<run> command produces no output on stdout, this is not useful "
19616 "anyway.  For further information see "
19617 "L<https://bugzilla.redhat.com/show_bug.cgi?id=592910>."
19618 msgstr ""
19619
19620 #. type: =head1
19621 #: ../fish/guestfish.pod:1020
19622 msgid "PREPARED DISK IMAGES"
19623 msgstr ""
19624
19625 #. type: textblock
19626 #: ../fish/guestfish.pod:1022
19627 msgid ""
19628 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
19629 "preformatted disk images that guestfish can make for you to save typing.  "
19630 "This is particularly useful for testing purposes.  This option is used "
19631 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
19632 "can be mixed with I<-a>)."
19633 msgstr ""
19634
19635 #. type: textblock
19636 #: ../fish/guestfish.pod:1028
19637 msgid ""
19638 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
19639 "the second and so on.  Existing files in the current directory are "
19640 "I<overwritten>."
19641 msgstr ""
19642
19643 #. type: textblock
19644 #: ../fish/guestfish.pod:1032
19645 msgid ""
19646 "The type briefly describes how the disk should be sized, partitioned, how "
19647 "filesystem(s) should be created, and how content should be added.  "
19648 "Optionally the type can be followed by extra parameters, separated by C<:> "
19649 "(colon) characters.  For example, I<-N fs> creates a default 100MB, "
19650 "sparsely-allocated disk, containing a single partition, with the partition "
19651 "formatted as ext2.  I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
19652 "on a 1GB disk instead."
19653 msgstr ""
19654
19655 #. type: textblock
19656 #: ../fish/guestfish.pod:1040
19657 msgid "To list the available types and any extra parameters they take, run:"
19658 msgstr ""
19659
19660 #. type: textblock
19661 #: ../fish/guestfish.pod:1044
19662 msgid ""
19663 "Note that the prepared filesystem is not mounted.  You would usually have to "
19664 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
19665 msgstr ""
19666
19667 #. type: textblock
19668 #: ../fish/guestfish.pod:1048
19669 msgid ""
19670 "If any I<-N> or I<--new> options are given, the guest is automatically "
19671 "launched."
19672 msgstr ""
19673
19674 #. type: textblock
19675 #: ../fish/guestfish.pod:1053
19676 msgid "Create a 100MB disk with an ext4-formatted partition:"
19677 msgstr ""
19678
19679 #. type: verbatim
19680 #: ../fish/guestfish.pod:1055
19681 #, no-wrap
19682 msgid ""
19683 " guestfish -N fs:ext4\n"
19684 "\n"
19685 msgstr ""
19686
19687 #. type: textblock
19688 #: ../fish/guestfish.pod:1057
19689 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
19690 msgstr ""
19691
19692 #. type: verbatim
19693 #: ../fish/guestfish.pod:1059
19694 #, no-wrap
19695 msgid ""
19696 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
19697 "\n"
19698 msgstr ""
19699
19700 #. type: textblock
19701 #: ../fish/guestfish.pod:1061
19702 msgid "Create a blank 200MB disk:"
19703 msgstr ""
19704
19705 #. type: verbatim
19706 #: ../fish/guestfish.pod:1063
19707 #, no-wrap
19708 msgid ""
19709 " guestfish -N disk:200M\n"
19710 "\n"
19711 msgstr ""
19712
19713 #. type: =head1
19714 #: ../fish/guestfish.pod:1065
19715 msgid "PROGRESS BARS"
19716 msgstr ""
19717
19718 #. type: textblock
19719 #: ../fish/guestfish.pod:1067
19720 msgid ""
19721 "Some (not all) long-running commands send progress notification messages as "
19722 "they are running.  Guestfish turns these messages into progress bars."
19723 msgstr ""
19724
19725 #. type: textblock
19726 #: ../fish/guestfish.pod:1071
19727 msgid ""
19728 "When a command that supports progress bars takes longer than two seconds to "
19729 "run, and if progress bars are enabled, then you will see one appearing below "
19730 "the command:"
19731 msgstr ""
19732
19733 #. type: verbatim
19734 #: ../fish/guestfish.pod:1075
19735 #, no-wrap
19736 msgid ""
19737 " ><fs> copy-size /large-file /another-file 2048M\n"
19738 " / 10% [#####-----------------------------------------] 00:30\n"
19739 "\n"
19740 msgstr ""
19741
19742 #. type: textblock
19743 #: ../fish/guestfish.pod:1078
19744 msgid ""
19745 "The spinner on the left hand side moves round once for every progress "
19746 "notification received from the backend.  This is a (reasonably) golden "
19747 "assurance that the command is \"doing something\" even if the progress bar "
19748 "is not moving, because the command is able to send the progress "
19749 "notifications.  When the bar reaches 100% and the command finishes, the "
19750 "spinner disappears."
19751 msgstr ""
19752
19753 #. type: textblock
19754 #: ../fish/guestfish.pod:1085
19755 msgid ""
19756 "Progress bars are enabled by default when guestfish is used interactively.  "
19757 "You can enable them even for non-interactive modes using I<--progress-bars>, "
19758 "and you can disable them completely using I<--no-progress-bars>."
19759 msgstr ""
19760
19761 #. type: =head1
19762 #: ../fish/guestfish.pod:1090
19763 msgid "GUESTFISH COMMANDS"
19764 msgstr ""
19765
19766 #. type: textblock
19767 #: ../fish/guestfish.pod:1092
19768 msgid ""
19769 "The commands in this section are guestfish convenience commands, in other "
19770 "words, they are not part of the L<guestfs(3)> API."
19771 msgstr ""
19772
19773 #. type: =head2
19774 #: ../fish/guestfish.pod:1095
19775 msgid "help"
19776 msgstr ""
19777
19778 #. type: verbatim
19779 #: ../fish/guestfish.pod:1097
19780 #, no-wrap
19781 msgid ""
19782 " help\n"
19783 " help cmd\n"
19784 "\n"
19785 msgstr ""
19786
19787 #. type: textblock
19788 #: ../fish/guestfish.pod:1100
19789 msgid "Without any parameter, this provides general help."
19790 msgstr ""
19791
19792 #. type: textblock
19793 #: ../fish/guestfish.pod:1102
19794 msgid "With a C<cmd> parameter, this displays detailed help for that command."
19795 msgstr ""
19796
19797 #. type: =head2
19798 #: ../fish/guestfish.pod:1104
19799 msgid "quit | exit"
19800 msgstr ""
19801
19802 #. type: textblock
19803 #: ../fish/guestfish.pod:1106
19804 msgid "This exits guestfish.  You can also use C<^D> key."
19805 msgstr ""
19806
19807 #. type: textblock
19808 #: ../fish/guestfish.pod:1108
19809 msgid "@FISH_COMMANDS@"
19810 msgstr ""
19811
19812 #. type: =head1
19813 #: ../fish/guestfish.pod:1110
19814 msgid "COMMANDS"
19815 msgstr ""
19816
19817 #. type: textblock
19818 #: ../fish/guestfish.pod:1112 ../src/guestfs.pod:1520
19819 msgid "@ACTIONS@"
19820 msgstr ""
19821
19822 #. type: textblock
19823 #: ../fish/guestfish.pod:1116
19824 msgid ""
19825 "guestfish returns 0 if the commands completed without error, or 1 if there "
19826 "was an error."
19827 msgstr ""
19828
19829 #. type: =item
19830 #: ../fish/guestfish.pod:1123
19831 msgid "EDITOR"
19832 msgstr ""
19833
19834 #. type: textblock
19835 #: ../fish/guestfish.pod:1125
19836 msgid ""
19837 "The C<edit> command uses C<$EDITOR> as the editor.  If not set, it uses "
19838 "C<vi>."
19839 msgstr ""
19840
19841 #. type: =item
19842 #: ../fish/guestfish.pod:1128 ../src/guestfs.pod:3213
19843 msgid "FEBOOTSTRAP_KERNEL"
19844 msgstr ""
19845
19846 #. type: =item
19847 #: ../fish/guestfish.pod:1130 ../src/guestfs.pod:3215
19848 msgid "FEBOOTSTRAP_MODULES"
19849 msgstr ""
19850
19851 #. type: textblock
19852 #: ../fish/guestfish.pod:1132 ../src/guestfs.pod:3217
19853 msgid ""
19854 "These two environment variables allow the kernel that libguestfs uses in the "
19855 "appliance to be selected.  If C<$FEBOOTSTRAP_KERNEL> is not set, then the "
19856 "most recent host kernel is chosen.  For more information about kernel "
19857 "selection, see L<febootstrap-supermin-helper(8)>.  This feature is only "
19858 "available in febootstrap E<ge> 3.8."
19859 msgstr ""
19860
19861 #. type: =item
19862 #: ../fish/guestfish.pod:1138
19863 msgid "GUESTFISH_DISPLAY_IMAGE"
19864 msgstr ""
19865
19866 #. type: textblock
19867 #: ../fish/guestfish.pod:1140
19868 msgid ""
19869 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images.  "
19870 "If not set, it uses L<display(1)>."
19871 msgstr ""
19872
19873 #. type: =item
19874 #: ../fish/guestfish.pod:1143
19875 msgid "GUESTFISH_PID"
19876 msgstr ""
19877
19878 #. type: textblock
19879 #: ../fish/guestfish.pod:1145
19880 msgid ""
19881 "Used with the I<--remote> option to specify the remote guestfish process to "
19882 "control.  See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
19883 msgstr ""
19884
19885 #. type: =item
19886 #: ../fish/guestfish.pod:1149
19887 msgid "HEXEDITOR"
19888 msgstr ""
19889
19890 #. type: textblock
19891 #: ../fish/guestfish.pod:1151
19892 msgid ""
19893 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor.  If "
19894 "not specified, the external L<hexedit(1)> program is used."
19895 msgstr ""
19896
19897 #. type: =item
19898 #: ../fish/guestfish.pod:1155
19899 msgid "HOME"
19900 msgstr ""
19901
19902 #. type: textblock
19903 #: ../fish/guestfish.pod:1157
19904 msgid ""
19905 "If compiled with GNU readline support, various files in the home directory "
19906 "can be used.  See L</FILES>."
19907 msgstr ""
19908
19909 #. type: =item
19910 #: ../fish/guestfish.pod:1160 ../src/guestfs.pod:3223
19911 msgid "LIBGUESTFS_APPEND"
19912 msgstr ""
19913
19914 #. type: textblock
19915 #: ../fish/guestfish.pod:1162 ../src/guestfs.pod:3225
19916 msgid "Pass additional options to the guest kernel."
19917 msgstr ""
19918
19919 #. type: =item
19920 #: ../fish/guestfish.pod:1164 ../src/guestfs.pod:3227
19921 msgid "LIBGUESTFS_DEBUG"
19922 msgstr ""
19923
19924 #. type: textblock
19925 #: ../fish/guestfish.pod:1166
19926 msgid ""
19927 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages.  This has the same "
19928 "effect as using the B<-v> option."
19929 msgstr ""
19930
19931 #. type: =item
19932 #: ../fish/guestfish.pod:1169 ../src/guestfs.pod:3232
19933 msgid "LIBGUESTFS_MEMSIZE"
19934 msgstr ""
19935
19936 #. type: textblock
19937 #: ../fish/guestfish.pod:1171 ../src/guestfs.pod:3234
19938 msgid "Set the memory allocated to the qemu process, in megabytes.  For example:"
19939 msgstr ""
19940
19941 #. type: verbatim
19942 #: ../fish/guestfish.pod:1174 ../src/guestfs.pod:3237
19943 #, no-wrap
19944 msgid ""
19945 " LIBGUESTFS_MEMSIZE=700\n"
19946 "\n"
19947 msgstr ""
19948
19949 #. type: =item
19950 #: ../fish/guestfish.pod:1176 ../src/guestfs.pod:3239
19951 msgid "LIBGUESTFS_PATH"
19952 msgstr ""
19953
19954 #. type: textblock
19955 #: ../fish/guestfish.pod:1178
19956 msgid ""
19957 "Set the path that guestfish uses to search for kernel and initrd.img.  See "
19958 "the discussion of paths in L<guestfs(3)>."
19959 msgstr ""
19960
19961 #. type: =item
19962 #: ../fish/guestfish.pod:1181 ../src/guestfs.pod:3244
19963 msgid "LIBGUESTFS_QEMU"
19964 msgstr ""
19965
19966 #. type: textblock
19967 #: ../fish/guestfish.pod:1183 ../src/guestfs.pod:3246
19968 msgid ""
19969 "Set the default qemu binary that libguestfs uses.  If not set, then the qemu "
19970 "which was found at compile time by the configure script is used."
19971 msgstr ""
19972
19973 #. type: =item
19974 #: ../fish/guestfish.pod:1187 ../src/guestfs.pod:3252
19975 msgid "LIBGUESTFS_TRACE"
19976 msgstr ""
19977
19978 #. type: textblock
19979 #: ../fish/guestfish.pod:1189
19980 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
19981 msgstr ""
19982
19983 #. type: =item
19984 #: ../fish/guestfish.pod:1191
19985 msgid "PAGER"
19986 msgstr ""
19987
19988 #. type: textblock
19989 #: ../fish/guestfish.pod:1193
19990 msgid ""
19991 "The C<more> command uses C<$PAGER> as the pager.  If not set, it uses "
19992 "C<more>."
19993 msgstr ""
19994
19995 #. type: =item
19996 #: ../fish/guestfish.pod:1196 ../sparsify/virt-sparsify.pod:236 ../src/guestfs.pod:3257
19997 msgid "TMPDIR"
19998 msgstr ""
19999
20000 #. type: textblock
20001 #: ../fish/guestfish.pod:1198 ../src/guestfs.pod:3259
20002 msgid ""
20003 "Location of temporary directory, defaults to C</tmp> except for the cached "
20004 "supermin appliance which defaults to C</var/tmp>."
20005 msgstr ""
20006
20007 #. type: textblock
20008 #: ../fish/guestfish.pod:1201 ../src/guestfs.pod:3262
20009 msgid ""
20010 "If libguestfs was compiled to use the supermin appliance then the real "
20011 "appliance is cached in this directory, shared between all handles belonging "
20012 "to the same EUID.  You can use C<$TMPDIR> to configure another directory to "
20013 "use in case C</var/tmp> is not large enough."
20014 msgstr ""
20015
20016 #. type: =head1
20017 #: ../fish/guestfish.pod:1209 ../fuse/guestmount.pod:297 ../rescue/virt-rescue.pod:310
20018 msgid "FILES"
20019 msgstr ""
20020
20021 #. type: =item
20022 #: ../fish/guestfish.pod:1213 ../fuse/guestmount.pod:301 ../rescue/virt-rescue.pod:314
20023 msgid "$HOME/.libguestfs-tools.rc"
20024 msgstr ""
20025
20026 #. type: =item
20027 #: ../fish/guestfish.pod:1215 ../fuse/guestmount.pod:303 ../rescue/virt-rescue.pod:316
20028 msgid "/etc/libguestfs-tools.conf"
20029 msgstr ""
20030
20031 #. type: textblock
20032 #: ../fish/guestfish.pod:1217 ../fuse/guestmount.pod:305 ../rescue/virt-rescue.pod:318
20033 msgid ""
20034 "This configuration file controls the default read-only or read-write mode "
20035 "(I<--ro> or I<--rw>)."
20036 msgstr ""
20037
20038 #. type: textblock
20039 #: ../fish/guestfish.pod:1220
20040 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
20041 msgstr ""
20042
20043 #. type: =item
20044 #: ../fish/guestfish.pod:1222
20045 msgid "$HOME/.guestfish"
20046 msgstr ""
20047
20048 #. type: textblock
20049 #: ../fish/guestfish.pod:1224
20050 msgid ""
20051 "If compiled with GNU readline support, then the command history is saved in "
20052 "this file."
20053 msgstr ""
20054
20055 #. type: =item
20056 #: ../fish/guestfish.pod:1227
20057 msgid "$HOME/.inputrc"
20058 msgstr ""
20059
20060 #. type: =item
20061 #: ../fish/guestfish.pod:1229
20062 msgid "/etc/inputrc"
20063 msgstr ""
20064
20065 #. type: textblock
20066 #: ../fish/guestfish.pod:1231
20067 msgid ""
20068 "If compiled with GNU readline support, then these files can be used to "
20069 "configure readline.  For further information, please see "
20070 "L<readline(3)/INITIALIZATION FILE>."
20071 msgstr ""
20072
20073 #. type: textblock
20074 #: ../fish/guestfish.pod:1235
20075 msgid "To write rules which only apply to guestfish, use:"
20076 msgstr ""
20077
20078 #. type: verbatim
20079 #: ../fish/guestfish.pod:1237
20080 #, no-wrap
20081 msgid ""
20082 " $if guestfish\n"
20083 " ...\n"
20084 " $endif\n"
20085 "\n"
20086 msgstr ""
20087
20088 #. type: textblock
20089 #: ../fish/guestfish.pod:1241
20090 msgid ""
20091 "Variables that you can set in inputrc that change the behaviour of guestfish "
20092 "in useful ways include:"
20093 msgstr ""
20094
20095 #. type: =item
20096 #: ../fish/guestfish.pod:1246
20097 msgid "completion-ignore-case (default: on)"
20098 msgstr ""
20099
20100 #. type: textblock
20101 #: ../fish/guestfish.pod:1248
20102 msgid ""
20103 "By default, guestfish will ignore case when tab-completing paths on the "
20104 "disk.  Use:"
20105 msgstr ""
20106
20107 #. type: verbatim
20108 #: ../fish/guestfish.pod:1251
20109 #, no-wrap
20110 msgid ""
20111 " set completion-ignore-case off\n"
20112 "\n"
20113 msgstr ""
20114
20115 #. type: textblock
20116 #: ../fish/guestfish.pod:1253
20117 msgid "to make guestfish case sensitive."
20118 msgstr ""
20119
20120 #. type: =item
20121 #: ../fish/guestfish.pod:1257
20122 msgid "test1.img"
20123 msgstr ""
20124
20125 #. type: =item
20126 #: ../fish/guestfish.pod:1259
20127 msgid "test2.img (etc)"
20128 msgstr ""
20129
20130 #. type: textblock
20131 #: ../fish/guestfish.pod:1261
20132 msgid ""
20133 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
20134 "will be created in the file C<test1.img> in the current directory.  The "
20135 "second use of I<-N> will use C<test2.img> and so on.  Any existing file with "
20136 "the same name will be overwritten."
20137 msgstr ""
20138
20139 #. type: textblock
20140 #: ../fish/guestfish.pod:1270
20141 msgid ""
20142 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-alignment-scan(1)>, "
20143 "L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, "
20144 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, "
20145 "L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, "
20146 "L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, "
20147 "L<virt-sparsify(1)>, L<virt-sysprep(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
20148 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<display(1)>, L<hexedit(1)>, "
20149 "L<febootstrap-supermin-helper(8)>."
20150 msgstr ""
20151
20152 #. type: textblock
20153 #: ../fish/guestfish.pod:1302 ../src/guestfs.pod:3354 ../test-tool/libguestfs-test-tool.pod:112
20154 msgid "Copyright (C) 2009-2011 Red Hat Inc.  L<http://libguestfs.org/>"
20155 msgstr ""
20156
20157 #. type: textblock
20158 #: ../fish/virt-copy-in.pod:5
20159 msgid "virt-copy-in - Copy files and directories into a virtual machine disk image."
20160 msgstr ""
20161
20162 #. type: verbatim
20163 #: ../fish/virt-copy-in.pod:9
20164 #, no-wrap
20165 msgid ""
20166 " virt-copy-in -a disk.img file|dir [file|dir ...] /destination\n"
20167 "\n"
20168 msgstr ""
20169
20170 #. type: verbatim
20171 #: ../fish/virt-copy-in.pod:11
20172 #, no-wrap
20173 msgid ""
20174 " virt-copy-in -d domain file|dir [file|dir ...] /destination\n"
20175 "\n"
20176 msgstr ""
20177
20178 #. type: textblock
20179 #: ../fish/virt-copy-in.pod:15
20180 msgid ""
20181 "Using C<virt-copy-in> on live virtual machines can be dangerous, potentially "
20182 "causing disk corruption.  The virtual machine must be shut down before you "
20183 "use this command."
20184 msgstr ""
20185
20186 #. type: textblock
20187 #: ../fish/virt-copy-in.pod:21
20188 msgid ""
20189 "C<virt-copy-in> copies files and directories from the local disk into a "
20190 "virtual machine disk image or named libvirt domain."
20191 msgstr ""
20192
20193 #. type: textblock
20194 #: ../fish/virt-copy-in.pod:24
20195 msgid ""
20196 "You can give one of more filenames and directories on the command line.  "
20197 "Directories are copied in recursively.  The final parameter must be the "
20198 "destination directory in the disk image which must be an absolute path "
20199 "starting with a C</> character."
20200 msgstr ""
20201
20202 #. type: verbatim
20203 #: ../fish/virt-copy-in.pod:33
20204 #, no-wrap
20205 msgid ""
20206 " virt-copy-in -d MyGuest resolv.conf /etc\n"
20207 "\n"
20208 msgstr ""
20209
20210 #. type: textblock
20211 #: ../fish/virt-copy-in.pod:35 ../fish/virt-tar-in.pod:32
20212 msgid "Upload a home directory to a guest:"
20213 msgstr ""
20214
20215 #. type: verbatim
20216 #: ../fish/virt-copy-in.pod:37
20217 #, no-wrap
20218 msgid ""
20219 " virt-copy-in -d MyGuest skel /home\n"
20220 "\n"
20221 msgstr ""
20222
20223 #. type: =head1
20224 #: ../fish/virt-copy-in.pod:39 ../fish/virt-copy-out.pod:28 ../fish/virt-tar-in.pod:36 ../fish/virt-tar-out.pod:30
20225 msgid "JUST A SHELL SCRIPT WRAPPER AROUND GUESTFISH"
20226 msgstr ""
20227
20228 #. type: textblock
20229 #: ../fish/virt-copy-in.pod:41
20230 msgid ""
20231 "This command is just a simple shell script wrapper around the "
20232 "L<guestfish(1)> C<copy-in> command.  For anything more complex than a "
20233 "trivial copy, you are probably better off using guestfish directly."
20234 msgstr ""
20235
20236 #. type: textblock
20237 #: ../fish/virt-copy-in.pod:47 ../fish/virt-copy-out.pod:36 ../fish/virt-tar-in.pod:44 ../fish/virt-tar-out.pod:38
20238 msgid ""
20239 "Since the shell script just passes options straight to guestfish, read "
20240 "L<guestfish(1)> to see the full list of options."
20241 msgstr ""
20242
20243 #. type: textblock
20244 #: ../fish/virt-copy-in.pod:52
20245 msgid ""
20246 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
20247 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
20248 msgstr ""
20249
20250 #. type: textblock
20251 #: ../fish/virt-copy-in.pod:66 ../fish/virt-copy-out.pod:55 ../fish/virt-tar-in.pod:64 ../fish/virt-tar-out.pod:57
20252 msgid "Copyright (C) 2011 Red Hat Inc.  L<http://libguestfs.org/>"
20253 msgstr ""
20254
20255 #. type: textblock
20256 #: ../fish/virt-copy-out.pod:5
20257 msgid ""
20258 "virt-copy-out - Copy files and directories out of a virtual machine disk "
20259 "image."
20260 msgstr ""
20261
20262 #. type: verbatim
20263 #: ../fish/virt-copy-out.pod:9
20264 #, no-wrap
20265 msgid ""
20266 " virt-copy-out -a disk.img /file|dir [/file|dir ...] localdir\n"
20267 "\n"
20268 msgstr ""
20269
20270 #. type: verbatim
20271 #: ../fish/virt-copy-out.pod:11
20272 #, no-wrap
20273 msgid ""
20274 " virt-copy-out -d domain /file|dir [/file|dir ...] localdir\n"
20275 "\n"
20276 msgstr ""
20277
20278 #. type: textblock
20279 #: ../fish/virt-copy-out.pod:15
20280 msgid ""
20281 "C<virt-copy-out> copies files and directories out of a virtual machine disk "
20282 "image or named libvirt domain."
20283 msgstr ""
20284
20285 #. type: textblock
20286 #: ../fish/virt-copy-out.pod:18
20287 msgid ""
20288 "You can give one of more filenames and directories on the command line.  "
20289 "Directories are copied out recursively."
20290 msgstr ""
20291
20292 #. type: textblock
20293 #: ../fish/virt-copy-out.pod:23
20294 msgid "Download the home directories from a virtual machine:"
20295 msgstr ""
20296
20297 #. type: verbatim
20298 #: ../fish/virt-copy-out.pod:25
20299 #, no-wrap
20300 msgid ""
20301 " mkdir homes\n"
20302 " virt-copy-out -d MyGuest /home homes\n"
20303 "\n"
20304 msgstr ""
20305
20306 #. type: textblock
20307 #: ../fish/virt-copy-out.pod:30
20308 msgid ""
20309 "This command is just a simple shell script wrapper around the "
20310 "L<guestfish(1)> C<copy-out> command.  For anything more complex than a "
20311 "trivial copy, you are probably better off using guestfish directly."
20312 msgstr ""
20313
20314 #. type: textblock
20315 #: ../fish/virt-copy-out.pod:41
20316 msgid ""
20317 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-edit(1)>, "
20318 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
20319 msgstr ""
20320
20321 #. type: textblock
20322 #: ../fish/virt-tar-in.pod:5
20323 msgid "virt-tar-in - Unpack a tarball into a virtual machine disk image."
20324 msgstr ""
20325
20326 #. type: verbatim
20327 #: ../fish/virt-tar-in.pod:9
20328 #, no-wrap
20329 msgid ""
20330 " virt-tar-in -a disk.img data.tar /destination\n"
20331 "\n"
20332 msgstr ""
20333
20334 #. type: verbatim
20335 #: ../fish/virt-tar-in.pod:11
20336 #, no-wrap
20337 msgid ""
20338 " virt-tar-in -d domain data.tar /destination\n"
20339 "\n"
20340 msgstr ""
20341
20342 #. type: verbatim
20343 #: ../fish/virt-tar-in.pod:13
20344 #, no-wrap
20345 msgid ""
20346 " zcat data.tar.gz | virt-tar-in -d domain - /destination\n"
20347 "\n"
20348 msgstr ""
20349
20350 #. type: textblock
20351 #: ../fish/virt-tar-in.pod:17
20352 msgid ""
20353 "Using C<virt-tar-in> on live virtual machines can be dangerous, potentially "
20354 "causing disk corruption.  The virtual machine must be shut down before you "
20355 "use this command."
20356 msgstr ""
20357
20358 #. type: textblock
20359 #: ../fish/virt-tar-in.pod:23
20360 msgid ""
20361 "C<virt-tar-in> unpacks an uncompressed tarball into a virtual machine disk "
20362 "image or named libvirt domain."
20363 msgstr ""
20364
20365 #. type: textblock
20366 #: ../fish/virt-tar-in.pod:26
20367 msgid ""
20368 "The first parameter is the tar file.  Use C<-> to read the tar file from "
20369 "standard input.  The second parameter is the absolute target directory to "
20370 "unpack into."
20371 msgstr ""
20372
20373 #. type: verbatim
20374 #: ../fish/virt-tar-in.pod:34
20375 #, no-wrap
20376 msgid ""
20377 " virt-tar-in -d MyGuest homes.tar /home\n"
20378 "\n"
20379 msgstr ""
20380
20381 #. type: textblock
20382 #: ../fish/virt-tar-in.pod:38
20383 msgid ""
20384 "This command is just a simple shell script wrapper around the "
20385 "L<guestfish(1)> C<tar-in> command.  For anything more complex than a trivial "
20386 "copy, you are probably better off using guestfish directly."
20387 msgstr ""
20388
20389 #. type: textblock
20390 #: ../fish/virt-tar-in.pod:49
20391 msgid ""
20392 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
20393 "L<virt-edit(1)>, L<virt-make-fs(1)>, L<virt-tar-out(1)>, "
20394 "L<http://libguestfs.org/>."
20395 msgstr ""
20396
20397 #. type: textblock
20398 #: ../fish/virt-tar-out.pod:5
20399 msgid "virt-tar-out - Pack a virtual machine disk image directory into a tarball."
20400 msgstr ""
20401
20402 #. type: verbatim
20403 #: ../fish/virt-tar-out.pod:9
20404 #, no-wrap
20405 msgid ""
20406 " virt-tar-out -a disk.img /dir files.tar\n"
20407 "\n"
20408 msgstr ""
20409
20410 #. type: verbatim
20411 #: ../fish/virt-tar-out.pod:11
20412 #, no-wrap
20413 msgid ""
20414 " virt-tar-out -d domain /dir files.tar\n"
20415 "\n"
20416 msgstr ""
20417
20418 #. type: verbatim
20419 #: ../fish/virt-tar-out.pod:13
20420 #, no-wrap
20421 msgid ""
20422 " virt-tar-out -d domain /dir - | gzip --best > files.tar.gz\n"
20423 "\n"
20424 msgstr ""
20425
20426 #. type: textblock
20427 #: ../fish/virt-tar-out.pod:17
20428 msgid "C<virt-tar-out> packs a virtual machine disk image directory into a tarball."
20429 msgstr ""
20430
20431 #. type: textblock
20432 #: ../fish/virt-tar-out.pod:20
20433 msgid ""
20434 "The first parameter is the absolute path of the virtual machine directory.  "
20435 "The second parameter is the tar file to write.  Use C<-> to write to "
20436 "standard output."
20437 msgstr ""
20438
20439 #. type: textblock
20440 #: ../fish/virt-tar-out.pod:26
20441 msgid "Download the home directories from a guest:"
20442 msgstr ""
20443
20444 #. type: verbatim
20445 #: ../fish/virt-tar-out.pod:28
20446 #, no-wrap
20447 msgid ""
20448 " virt-tar-out -d MyGuest /home - | gzip --best > homes.tar.gz\n"
20449 "\n"
20450 msgstr ""
20451
20452 #. type: textblock
20453 #: ../fish/virt-tar-out.pod:32
20454 msgid ""
20455 "This command is just a simple shell script wrapper around the "
20456 "L<guestfish(1)> C<tar-out> command.  For anything more complex than a "
20457 "trivial copy, you are probably better off using guestfish directly."
20458 msgstr ""
20459
20460 #. type: textblock
20461 #: ../fish/virt-tar-out.pod:43
20462 msgid ""
20463 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
20464 "L<virt-edit(1)>, L<virt-tar-in(1)>, L<http://libguestfs.org/>."
20465 msgstr ""
20466
20467 #. type: textblock
20468 #: ../fuse/guestmount.pod:5
20469 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
20470 msgstr ""
20471
20472 #. type: verbatim
20473 #: ../fuse/guestmount.pod:9
20474 #, no-wrap
20475 msgid ""
20476 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
20477 "\n"
20478 msgstr ""
20479
20480 #. type: verbatim
20481 #: ../fuse/guestmount.pod:11
20482 #, no-wrap
20483 msgid ""
20484 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
20485 "\n"
20486 msgstr ""
20487
20488 #. type: verbatim
20489 #: ../fuse/guestmount.pod:13
20490 #, no-wrap
20491 msgid ""
20492 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
20493 "\n"
20494 msgstr ""
20495
20496 #. type: textblock
20497 #: ../fuse/guestmount.pod:17
20498 msgid ""
20499 "You must I<not> use C<guestmount> in read-write mode on live virtual "
20500 "machines.  If you do this, you risk disk corruption in the VM."
20501 msgstr ""
20502
20503 #. type: textblock
20504 #: ../fuse/guestmount.pod:22
20505 msgid ""
20506 "The guestmount program can be used to mount virtual machine filesystems and "
20507 "other disk images on the host.  It uses libguestfs for access to the guest "
20508 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
20509 "a mountable device."
20510 msgstr ""
20511
20512 #. type: textblock
20513 #: ../fuse/guestmount.pod:27
20514 msgid ""
20515 "Along with other options, you have to give at least one device (I<-a> "
20516 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
20517 "option) or use the I<-i> inspection option or the I<--live> option.  How "
20518 "this works is better explained in the L<guestfish(1)> manual page, or by "
20519 "looking at the examples below."
20520 msgstr ""
20521
20522 #. type: textblock
20523 #: ../fuse/guestmount.pod:33
20524 msgid ""
20525 "FUSE lets you mount filesystems as non-root.  The mountpoint must be owned "
20526 "by you, and the filesystem will not be visible to any other users unless you "
20527 "make certain global configuration changes to C</etc/fuse.conf>.  To unmount "
20528 "the filesystem, use the C<fusermount -u> command."
20529 msgstr ""
20530
20531 #. type: textblock
20532 #: ../fuse/guestmount.pod:41
20533 msgid ""
20534 "For a typical Windows guest which has its main filesystem on the first "
20535 "partition:"
20536 msgstr ""
20537
20538 #. type: verbatim
20539 #: ../fuse/guestmount.pod:44
20540 #, no-wrap
20541 msgid ""
20542 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
20543 "\n"
20544 msgstr ""
20545
20546 #. type: textblock
20547 #: ../fuse/guestmount.pod:46
20548 msgid ""
20549 "For a typical Linux guest which has a /boot filesystem on the first "
20550 "partition, and the root filesystem on a logical volume:"
20551 msgstr ""
20552
20553 #. type: verbatim
20554 #: ../fuse/guestmount.pod:49
20555 #, no-wrap
20556 msgid ""
20557 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
20558 "\n"
20559 msgstr ""
20560
20561 #. type: textblock
20562 #: ../fuse/guestmount.pod:51
20563 msgid "To get libguestfs to detect guest mountpoints for you:"
20564 msgstr ""
20565
20566 #. type: verbatim
20567 #: ../fuse/guestmount.pod:53
20568 #, no-wrap
20569 msgid ""
20570 " guestmount -a guest.img -i --ro /mnt\n"
20571 "\n"
20572 msgstr ""
20573
20574 #. type: textblock
20575 #: ../fuse/guestmount.pod:55
20576 msgid "For a libvirt guest called \"Guest\" you could do:"
20577 msgstr ""
20578
20579 #. type: verbatim
20580 #: ../fuse/guestmount.pod:57
20581 #, no-wrap
20582 msgid ""
20583 " guestmount -d Guest -i --ro /mnt\n"
20584 "\n"
20585 msgstr ""
20586
20587 #. type: textblock
20588 #: ../fuse/guestmount.pod:59
20589 msgid ""
20590 "If you don't know what filesystems are contained in a guest or disk image, "
20591 "use L<virt-filesystems(1)> first:"
20592 msgstr ""
20593
20594 #. type: verbatim
20595 #: ../fuse/guestmount.pod:62
20596 #, no-wrap
20597 msgid ""
20598 " virt-filesystems MyGuest\n"
20599 "\n"
20600 msgstr ""
20601
20602 #. type: textblock
20603 #: ../fuse/guestmount.pod:64
20604 msgid ""
20605 "If you want to trace the libguestfs calls but without excessive debugging "
20606 "information, we recommend:"
20607 msgstr ""
20608
20609 #. type: verbatim
20610 #: ../fuse/guestmount.pod:67
20611 #, no-wrap
20612 msgid ""
20613 " guestmount [...] --trace /mnt\n"
20614 "\n"
20615 msgstr ""
20616
20617 #. type: textblock
20618 #: ../fuse/guestmount.pod:69
20619 msgid "If you want to debug the program, we recommend:"
20620 msgstr ""
20621
20622 #. type: verbatim
20623 #: ../fuse/guestmount.pod:71
20624 #, no-wrap
20625 msgid ""
20626 " guestmount [...] --trace --verbose /mnt\n"
20627 "\n"
20628 msgstr ""
20629
20630 #. type: =head1
20631 #: ../fuse/guestmount.pod:73 ../rescue/virt-rescue.pod:96 ../resize/virt-resize.pod:621
20632 msgid "NOTES"
20633 msgstr ""
20634
20635 #. type: =head2
20636 #: ../fuse/guestmount.pod:75
20637 msgid "Other users cannot see the filesystem by default"
20638 msgstr ""
20639
20640 #. type: textblock
20641 #: ../fuse/guestmount.pod:77
20642 msgid ""
20643 "If you mount a filesystem as one user (eg. root), then other users will not "
20644 "be able to see it by default.  The fix is to add the FUSE C<allow_other> "
20645 "option when mounting:"
20646 msgstr ""
20647
20648 #. type: verbatim
20649 #: ../fuse/guestmount.pod:81
20650 #, no-wrap
20651 msgid ""
20652 " sudo guestmount [...] -o allow_other /mnt\n"
20653 "\n"
20654 msgstr ""
20655
20656 #. type: =head2
20657 #: ../fuse/guestmount.pod:83
20658 msgid "Enabling FUSE"
20659 msgstr ""
20660
20661 #. type: textblock
20662 #: ../fuse/guestmount.pod:85
20663 msgid ""
20664 "On some distros, you may need to add yourself to a special group "
20665 "(eg. C<fuse>) before you can use any FUSE filesystem.  This is necessary on "
20666 "Debian and derivatives."
20667 msgstr ""
20668
20669 #. type: textblock
20670 #: ../fuse/guestmount.pod:89
20671 msgid ""
20672 "On other distros, no special group is required.  It is not necessary on "
20673 "Fedora or Red Hat Enterprise Linux."
20674 msgstr ""
20675
20676 #. type: textblock
20677 #: ../fuse/guestmount.pod:100
20678 msgid "Add a block device or virtual machine image."
20679 msgstr ""
20680
20681 #. type: =item
20682 #: ../fuse/guestmount.pod:123
20683 msgid "B<--dir-cache-timeout N>"
20684 msgstr ""
20685
20686 #. type: textblock
20687 #: ../fuse/guestmount.pod:125
20688 msgid ""
20689 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
20690 "seconds.  The readdir cache [actually, there are several semi-independent "
20691 "caches] is populated after a readdir(2) call with the stat and extended "
20692 "attributes of the files in the directory, in anticipation that they will be "
20693 "requested soon after."
20694 msgstr ""
20695
20696 #. type: textblock
20697 #: ../fuse/guestmount.pod:131
20698 msgid ""
20699 "There is also a different attribute cache implemented by FUSE (see the FUSE "
20700 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
20701 "requests, only cache existing ones."
20702 msgstr ""
20703
20704 #. type: textblock
20705 #: ../fuse/guestmount.pod:151
20706 msgid ""
20707 "If you have untrusted raw-format guest disk images, you should use this "
20708 "option to specify the disk format.  This avoids a possible security problem "
20709 "with malicious guests (CVE-2010-3851).  See also "
20710 "L<guestfs(3)/guestfs_add_drive_opts>."
20711 msgstr ""
20712
20713 #. type: =item
20714 #: ../fuse/guestmount.pod:156
20715 msgid "B<--fuse-help>"
20716 msgstr ""
20717
20718 #. type: textblock
20719 #: ../fuse/guestmount.pod:158
20720 msgid "Display help on special FUSE options (see I<-o> below)."
20721 msgstr ""
20722
20723 #. type: textblock
20724 #: ../fuse/guestmount.pod:162
20725 msgid "Display brief help and exit."
20726 msgstr ""
20727
20728 #. type: textblock
20729 #: ../fuse/guestmount.pod:186
20730 msgid ""
20731 "Mount the named partition or logical volume on the given mountpoint B<in the "
20732 "guest> (this has nothing to do with mountpoints in the host)."
20733 msgstr ""
20734
20735 #. type: textblock
20736 #: ../fuse/guestmount.pod:189
20737 msgid ""
20738 "If the mountpoint is omitted, it defaults to C</>.  You have to mount "
20739 "something on C</>."
20740 msgstr ""
20741
20742 #. type: textblock
20743 #: ../fuse/guestmount.pod:206
20744 msgid ""
20745 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
20746 "unmounted.  If you specify this option, then we don't attempt to sync the "
20747 "disk.  See the discussion of autosync in the L<guestfs(3)> manpage."
20748 msgstr ""
20749
20750 #. type: =item
20751 #: ../fuse/guestmount.pod:211
20752 msgid "B<-o option>"
20753 msgstr ""
20754
20755 #. type: =item
20756 #: ../fuse/guestmount.pod:213
20757 msgid "B<--option option>"
20758 msgstr ""
20759
20760 #. type: textblock
20761 #: ../fuse/guestmount.pod:215
20762 msgid "Pass extra options to FUSE."
20763 msgstr ""
20764
20765 #. type: textblock
20766 #: ../fuse/guestmount.pod:217
20767 msgid ""
20768 "To get a list of all the extra options supported by FUSE, use the command "
20769 "below.  Note that only the FUSE I<-o> options can be passed, and only some "
20770 "of them are a good idea."
20771 msgstr ""
20772
20773 #. type: verbatim
20774 #: ../fuse/guestmount.pod:221
20775 #, no-wrap
20776 msgid ""
20777 " guestmount --fuse-help\n"
20778 "\n"
20779 msgstr ""
20780
20781 #. type: textblock
20782 #: ../fuse/guestmount.pod:223
20783 msgid "Some potentially useful FUSE options:"
20784 msgstr ""
20785
20786 #. type: =item
20787 #: ../fuse/guestmount.pod:227
20788 msgid "B<-o allow_other>"
20789 msgstr ""
20790
20791 #. type: textblock
20792 #: ../fuse/guestmount.pod:229
20793 msgid "Allow other users to see the filesystem."
20794 msgstr ""
20795
20796 #. type: =item
20797 #: ../fuse/guestmount.pod:231
20798 msgid "B<-o attr_timeout=N>"
20799 msgstr ""
20800
20801 #. type: textblock
20802 #: ../fuse/guestmount.pod:233
20803 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
20804 msgstr ""
20805
20806 #. type: =item
20807 #: ../fuse/guestmount.pod:235
20808 msgid "B<-o kernel_cache>"
20809 msgstr ""
20810
20811 #. type: textblock
20812 #: ../fuse/guestmount.pod:237
20813 msgid ""
20814 "Allow the kernel to cache files (reduces the number of reads that have to go "
20815 "through the L<guestfs(3)> API).  This is generally a good idea if you can "
20816 "afford the extra memory usage."
20817 msgstr ""
20818
20819 #. type: =item
20820 #: ../fuse/guestmount.pod:241
20821 msgid "B<-o uid=N> B<-o gid=N>"
20822 msgstr ""
20823
20824 #. type: textblock
20825 #: ../fuse/guestmount.pod:243
20826 msgid ""
20827 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
20828 "the chosen values."
20829 msgstr ""
20830
20831 #. type: textblock
20832 #: ../fuse/guestmount.pod:252
20833 msgid ""
20834 "Add devices and mount everything read-only.  Also disallow writes and make "
20835 "the disk appear read-only to FUSE."
20836 msgstr ""
20837
20838 #. type: textblock
20839 #: ../fuse/guestmount.pod:255
20840 msgid ""
20841 "This is highly recommended if you are not going to edit the guest disk.  If "
20842 "the guest is running and this option is I<not> supplied, then there is a "
20843 "strong risk of disk corruption in the guest.  We try to prevent this from "
20844 "happening, but it is not always possible."
20845 msgstr ""
20846
20847 #. type: textblock
20848 #: ../fuse/guestmount.pod:260 ../rescue/virt-rescue.pod:199
20849 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
20850 msgstr ""
20851
20852 #. type: textblock
20853 #: ../fuse/guestmount.pod:264
20854 msgid "Enable SELinux support for the guest."
20855 msgstr ""
20856
20857 #. type: textblock
20858 #: ../fuse/guestmount.pod:270
20859 msgid "Enable verbose messages from underlying libguestfs."
20860 msgstr ""
20861
20862 #. type: textblock
20863 #: ../fuse/guestmount.pod:276
20864 msgid "Display the program version and exit."
20865 msgstr ""
20866
20867 #. type: textblock
20868 #: ../fuse/guestmount.pod:285 ../fuse/guestmount.pod:308 ../rescue/virt-rescue.pod:238 ../rescue/virt-rescue.pod:321
20869 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
20870 msgstr ""
20871
20872 #. type: =item
20873 #: ../fuse/guestmount.pod:289
20874 msgid "B<--trace>"
20875 msgstr ""
20876
20877 #. type: textblock
20878 #: ../fuse/guestmount.pod:291
20879 msgid "Trace libguestfs calls and entry into each FUSE function."
20880 msgstr ""
20881
20882 #. type: textblock
20883 #: ../fuse/guestmount.pod:293
20884 msgid "This also stops the daemon from forking into the background."
20885 msgstr ""
20886
20887 #. type: textblock
20888 #: ../fuse/guestmount.pod:319
20889 msgid ""
20890 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
20891 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
20892 "L<http://fuse.sf.net/>."
20893 msgstr ""
20894
20895 #. type: textblock
20896 #: ../fuse/guestmount.pod:334
20897 msgid "Copyright (C) 2009-2010 Red Hat Inc.  L<http://libguestfs.org/>"
20898 msgstr ""
20899
20900 #. type: textblock
20901 #: ../inspector/virt-inspector.pod:5
20902 msgid ""
20903 "virt-inspector - Display operating system version and other information "
20904 "about a virtual machine"
20905 msgstr ""
20906
20907 #. type: verbatim
20908 #: ../inspector/virt-inspector.pod:9
20909 #, no-wrap
20910 msgid ""
20911 " virt-inspector [--options] -d domname\n"
20912 "\n"
20913 msgstr ""
20914
20915 #. type: verbatim
20916 #: ../inspector/virt-inspector.pod:11
20917 #, no-wrap
20918 msgid ""
20919 " virt-inspector [--options] -a disk.img [-a disk.img ...]\n"
20920 "\n"
20921 msgstr ""
20922
20923 #. type: verbatim
20924 #: ../inspector/virt-inspector.pod:15
20925 #, no-wrap
20926 msgid ""
20927 " virt-inspector domname\n"
20928 "\n"
20929 msgstr ""
20930
20931 #. type: verbatim
20932 #: ../inspector/virt-inspector.pod:17 ../inspector/virt-inspector.pod:148
20933 #, no-wrap
20934 msgid ""
20935 " virt-inspector disk.img [disk.img ...]\n"
20936 "\n"
20937 msgstr ""
20938
20939 #. type: textblock
20940 #: ../inspector/virt-inspector.pod:21
20941 msgid ""
20942 "B<virt-inspector> examines a virtual machine or disk image and tries to "
20943 "determine the version of the operating system and other information about "
20944 "the virtual machine."
20945 msgstr ""
20946
20947 #. type: textblock
20948 #: ../inspector/virt-inspector.pod:25
20949 msgid "Virt-inspector produces XML output for feeding into other programs."
20950 msgstr ""
20951
20952 #. type: textblock
20953 #: ../inspector/virt-inspector.pod:27
20954 msgid ""
20955 "In the normal usage, use C<virt-inspector -d domname> where C<domname> is "
20956 "the libvirt domain (see: C<virsh list --all>)."
20957 msgstr ""
20958
20959 #. type: textblock
20960 #: ../inspector/virt-inspector.pod:30
20961 msgid ""
20962 "You can also run virt-inspector directly on disk images from a single "
20963 "virtual machine.  Use C<virt-inspector -a disk.img>.  In rare cases a domain "
20964 "has several block devices, in which case you should list several I<-a> "
20965 "options one after another, with the first corresponding to the guest's "
20966 "C</dev/sda>, the second to the guest's C</dev/sdb> and so on."
20967 msgstr ""
20968
20969 #. type: textblock
20970 #: ../inspector/virt-inspector.pod:37
20971 msgid ""
20972 "You can also run virt-inspector on install disks, live CDs, bootable USB "
20973 "keys and similar."
20974 msgstr ""
20975
20976 #. type: textblock
20977 #: ../inspector/virt-inspector.pod:40
20978 msgid ""
20979 "Virt-inspector can only inspect and report upon I<one domain at a time>.  To "
20980 "inspect several virtual machines, you have to run virt-inspector several "
20981 "times (for example, from a shell script for-loop)."
20982 msgstr ""
20983
20984 #. type: textblock
20985 #: ../inspector/virt-inspector.pod:45
20986 msgid ""
20987 "Because virt-inspector needs direct access to guest images, it won't "
20988 "normally work over remote libvirt connections."
20989 msgstr ""
20990
20991 #. type: textblock
20992 #: ../inspector/virt-inspector.pod:48
20993 msgid ""
20994 "All of the information available from virt-inspector is also available "
20995 "through the core libguestfs inspection API (see L<guestfs(3)/INSPECTION>).  "
20996 "The same information can also be fetched using guestfish or via libguestfs "
20997 "bindings in many programming languages (see L<guestfs(3)/USING LIBGUESTFS "
20998 "WITH OTHER PROGRAMMING LANGUAGES>)."
20999 msgstr ""
21000
21001 #. type: textblock
21002 #: ../inspector/virt-inspector.pod:81
21003 msgid ""
21004 "Libvirt is only used if you specify a C<domname> on the command line.  If "
21005 "you specify guest block devices directly (I<-a>), then libvirt is not used "
21006 "at all."
21007 msgstr ""
21008
21009 #. type: textblock
21010 #: ../inspector/virt-inspector.pod:94
21011 msgid ""
21012 "When prompting for keys and passphrases, virt-inspector normally turns "
21013 "echoing off so you cannot see what you are typing.  If you are not worried "
21014 "about Tempest attacks and there is no one else in the room you can specify "
21015 "this flag to see what you are typing."
21016 msgstr ""
21017
21018 #. type: textblock
21019 #: ../inspector/virt-inspector.pod:103 ../tools/virt-list-filesystems.pl:93 ../tools/virt-list-partitions.pl:94 ../tools/virt-tar.pl:143 ../tools/virt-win-reg.pl:144
21020 msgid ""
21021 "Specify the format of disk images given on the command line.  If this is "
21022 "omitted then the format is autodetected from the content of the disk image."
21023 msgstr ""
21024
21025 #. type: textblock
21026 #: ../inspector/virt-inspector.pod:107 ../tools/virt-list-filesystems.pl:97 ../tools/virt-list-partitions.pl:98 ../tools/virt-tar.pl:147 ../tools/virt-win-reg.pl:148
21027 msgid ""
21028 "If disk images are requested from libvirt, then this program asks libvirt "
21029 "for this information.  In this case, the value of the format parameter is "
21030 "ignored."
21031 msgstr ""
21032
21033 #. type: textblock
21034 #: ../inspector/virt-inspector.pod:111 ../resize/virt-resize.pod:391 ../resize/virt-resize.pod:483 ../sparsify/virt-sparsify.pod:132 ../tools/virt-list-filesystems.pl:101 ../tools/virt-list-partitions.pl:102 ../tools/virt-tar.pl:151 ../tools/virt-win-reg.pl:152
21035 msgid ""
21036 "If working with untrusted raw-format guest disk images, you should ensure "
21037 "the format is always specified."
21038 msgstr ""
21039
21040 #. type: =item
21041 #: ../inspector/virt-inspector.pod:135
21042 msgid "B<--xpath> query"
21043 msgstr ""
21044
21045 #. type: textblock
21046 #: ../inspector/virt-inspector.pod:137
21047 msgid ""
21048 "Perform an XPath query on the XML on stdin, and print the result on stdout.  "
21049 "In this mode virt-inspector simply runs an XPath query; all other inspection "
21050 "functions are disabled.  See L</XPATH QUERIES> below for some examples."
21051 msgstr ""
21052
21053 #. type: textblock
21054 #: ../inspector/virt-inspector.pod:146
21055 msgid "Previous versions of virt-inspector allowed you to write either:"
21056 msgstr ""
21057
21058 #. type: verbatim
21059 #: ../inspector/virt-inspector.pod:152
21060 #, no-wrap
21061 msgid ""
21062 " virt-inspector guestname\n"
21063 "\n"
21064 msgstr ""
21065
21066 #. type: =head1
21067 #: ../inspector/virt-inspector.pod:160
21068 msgid "XML FORMAT"
21069 msgstr ""
21070
21071 #. type: textblock
21072 #: ../inspector/virt-inspector.pod:162
21073 msgid ""
21074 "The virt-inspector XML is described precisely in a RELAX NG schema file "
21075 "C<virt-inspector.rng> which is supplied with libguestfs.  This section is "
21076 "just an overview."
21077 msgstr ""
21078
21079 #. type: textblock
21080 #: ../inspector/virt-inspector.pod:166
21081 msgid ""
21082 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
21083 "more E<lt>operatingsystemE<gt> elements.  You would only see more than one "
21084 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
21085 "which is vanishingly rare in real world VMs."
21086 msgstr ""
21087
21088 #. type: =head2
21089 #: ../inspector/virt-inspector.pod:171
21090 msgid "E<lt>operatingsystemE<gt>"
21091 msgstr ""
21092
21093 #. type: textblock
21094 #: ../inspector/virt-inspector.pod:173
21095 msgid ""
21096 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
21097 "describe the operating system, its architecture, the descriptive \"product "
21098 "name\" string, the type of OS and so on, as in this example:"
21099 msgstr ""
21100
21101 #. type: verbatim
21102 #: ../inspector/virt-inspector.pod:177
21103 #, no-wrap
21104 msgid ""
21105 " <operatingsystems>\n"
21106 "   <operatingsystem>\n"
21107 "     <root>/dev/sda2</root>\n"
21108 "     <name>windows</name>\n"
21109 "     <arch>i386</arch>\n"
21110 "     <distro>windows</distro>\n"
21111 "     <product_name>Windows 7 Enterprise</product_name>\n"
21112 "     <product_variant>Client</product_variant>\n"
21113 "     <major_version>6</major_version>\n"
21114 "     <minor_version>1</minor_version>\n"
21115 "     <windows_systemroot>/Windows</windows_systemroot>\n"
21116 "     <format>installed</format>\n"
21117 "\n"
21118 msgstr ""
21119
21120 #. type: textblock
21121 #: ../inspector/virt-inspector.pod:190
21122 msgid ""
21123 "In brief, E<lt>nameE<gt> is the class of operating system (something like "
21124 "C<linux> or C<windows>), E<lt>distroE<gt> is the distribution (eg. C<fedora> "
21125 "but many other distros are recognized) and E<lt>archE<gt> is the guest "
21126 "architecture.  The other fields are fairly self-explanatory, but because "
21127 "these fields are taken directly from the libguestfs inspection API you can "
21128 "find precise information from L<guestfs(3)/INSPECTION>."
21129 msgstr ""
21130
21131 #. type: textblock
21132 #: ../inspector/virt-inspector.pod:198
21133 msgid ""
21134 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
21135 "of view of libguestfs (block devices may have completely different names "
21136 "inside the VM itself)."
21137 msgstr ""
21138
21139 #. type: =head2
21140 #: ../inspector/virt-inspector.pod:202
21141 msgid "E<lt>mountpointsE<gt>"
21142 msgstr ""
21143
21144 #. type: textblock
21145 #: ../inspector/virt-inspector.pod:204
21146 msgid ""
21147 "Un*x-like guests typically have multiple filesystems which are mounted at "
21148 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
21149 "element which looks like this:"
21150 msgstr ""
21151
21152 #. type: verbatim
21153 #: ../inspector/virt-inspector.pod:208
21154 #, no-wrap
21155 msgid ""
21156 " <operatingsystems>\n"
21157 "   <operatingsystem>\n"
21158 "     ...\n"
21159 "     <mountpoints>\n"
21160 "       <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
21161 "       <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
21162 "     </mountpoints>\n"
21163 "\n"
21164 msgstr ""
21165
21166 #. type: textblock
21167 #: ../inspector/virt-inspector.pod:216
21168 msgid ""
21169 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
21170 "and may have completely different names inside the guest.  Only mountable "
21171 "filesystems appear in this list, not things like swap devices."
21172 msgstr ""
21173
21174 #. type: =head2
21175 #: ../inspector/virt-inspector.pod:221
21176 msgid "E<lt>filesystemsE<gt>"
21177 msgstr ""
21178
21179 #. type: textblock
21180 #: ../inspector/virt-inspector.pod:223
21181 msgid ""
21182 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
21183 "filesystems belonging to the guest, including swap and empty partitions.  "
21184 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
21185 "this OS or shared with this OS and other OSes)."
21186 msgstr ""
21187
21188 #. type: textblock
21189 #: ../inspector/virt-inspector.pod:229
21190 msgid "You might see something like this:"
21191 msgstr ""
21192
21193 #. type: verbatim
21194 #: ../inspector/virt-inspector.pod:231
21195 #, no-wrap
21196 msgid ""
21197 " <operatingsystems>\n"
21198 "   <operatingsystem>\n"
21199 "     ...\n"
21200 "     <filesystems>\n"
21201 "       <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
21202 "         <type>ext4</type>\n"
21203 "         <label>Fedora-13-x86_64</label>\n"
21204 "         <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
21205 "       </filesystem>\n"
21206 "\n"
21207 msgstr ""
21208
21209 #. type: textblock
21210 #: ../inspector/virt-inspector.pod:241
21211 msgid ""
21212 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
21213 "the label, and the UUID."
21214 msgstr ""
21215
21216 #. type: =head2
21217 #: ../inspector/virt-inspector.pod:244
21218 msgid "E<lt>applicationsE<gt>"
21219 msgstr ""
21220
21221 #. type: textblock
21222 #: ../inspector/virt-inspector.pod:246
21223 msgid ""
21224 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
21225 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
21226 "machine."
21227 msgstr ""
21228
21229 #. type: textblock
21230 #: ../inspector/virt-inspector.pod:250
21231 msgid ""
21232 "E<lt>package_formatE<gt>, if present, describes the packaging system used.  "
21233 "Typical values would be C<rpm> and C<deb>."
21234 msgstr ""
21235
21236 #. type: textblock
21237 #: ../inspector/virt-inspector.pod:253
21238 msgid ""
21239 "E<lt>package_managementE<gt>, if present, describes the package manager.  "
21240 "Typical values include C<yum>, C<up2date> and C<apt>"
21241 msgstr ""
21242
21243 #. type: textblock
21244 #: ../inspector/virt-inspector.pod:256
21245 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
21246 msgstr ""
21247
21248 #. type: verbatim
21249 #: ../inspector/virt-inspector.pod:259
21250 #, no-wrap
21251 msgid ""
21252 " <operatingsystems>\n"
21253 "   <operatingsystem>\n"
21254 "     ...\n"
21255 "     <applications>\n"
21256 "       <application>\n"
21257 "         <name>coreutils</name>\n"
21258 "         <version>8.5</version>\n"
21259 "         <release>1</release>\n"
21260 "       </application>\n"
21261 "\n"
21262 msgstr ""
21263
21264 #. type: textblock
21265 #: ../inspector/virt-inspector.pod:269
21266 msgid ""
21267 "The version and release fields may not be available for some types guests.  "
21268 "Other fields are possible, see "
21269 "L<guestfs(3)/guestfs_inspect_list_applications>."
21270 msgstr ""
21271
21272 #. type: =head2
21273 #: ../inspector/virt-inspector.pod:273
21274 msgid "E<lt>drive_mappingsE<gt>"
21275 msgstr ""
21276
21277 #. type: textblock
21278 #: ../inspector/virt-inspector.pod:275
21279 msgid ""
21280 "For operating systems like Windows which use drive letters, virt-inspector "
21281 "is able to find out how drive letters map to filesystems."
21282 msgstr ""
21283
21284 #. type: verbatim
21285 #: ../inspector/virt-inspector.pod:279
21286 #, no-wrap
21287 msgid ""
21288 " <operatingsystems>\n"
21289 "   <operatingsystem>\n"
21290 "     ...\n"
21291 "     <drive_mappings>\n"
21292 "       <drive_mapping name=\"C\">/dev/sda2</drive_mapping>\n"
21293 "       <drive_mapping name=\"E\">/dev/sdb1</drive_mapping>\n"
21294 "     </drive_mappings>\n"
21295 "\n"
21296 msgstr ""
21297
21298 #. type: textblock
21299 #: ../inspector/virt-inspector.pod:287
21300 msgid ""
21301 "In the example above, drive C maps to the filesystem on the second partition "
21302 "on the first disk, and drive E maps to the filesystem on the first partition "
21303 "on the second disk."
21304 msgstr ""
21305
21306 #. type: textblock
21307 #: ../inspector/virt-inspector.pod:291
21308 msgid ""
21309 "Note that this only covers permanent local filesystem mappings, not things "
21310 "like network shares.  Furthermore NTFS volume mount points may not be listed "
21311 "here."
21312 msgstr ""
21313
21314 #. type: =head2
21315 #: ../inspector/virt-inspector.pod:295
21316 msgid "E<lt>iconE<gt>"
21317 msgstr ""
21318
21319 #. type: textblock
21320 #: ../inspector/virt-inspector.pod:297
21321 msgid ""
21322 "Virt-inspector is sometimes able to extract an icon or logo for the guest.  "
21323 "The icon is returned as base64-encoded PNG data.  Note that the icon can be "
21324 "very large and high quality."
21325 msgstr ""
21326
21327 #. type: verbatim
21328 #: ../inspector/virt-inspector.pod:301
21329 #, no-wrap
21330 msgid ""
21331 " <operatingsystems>\n"
21332 "   <operatingsystem>\n"
21333 "     ...\n"
21334 "     <icon>\n"
21335 "       iVBORw0KGgoAAAANSUhEUgAAAGAAAABg[.......]\n"
21336 "       [... many lines of base64 data ...]\n"
21337 "     </icon>\n"
21338 "\n"
21339 msgstr ""
21340
21341 #. type: textblock
21342 #: ../inspector/virt-inspector.pod:309
21343 msgid ""
21344 "To display the icon, you have to extract it and convert the base64 data back "
21345 "to a binary file.  Use an XPath query or simply an editor to extract the "
21346 "data, then use the coreutils L<base64(1)> program to do the conversion back "
21347 "to a PNG file:"
21348 msgstr ""
21349
21350 #. type: verbatim
21351 #: ../inspector/virt-inspector.pod:314
21352 #, no-wrap
21353 msgid ""
21354 " base64 -i -d < icon.data > icon.png\n"
21355 "\n"
21356 msgstr ""
21357
21358 #. type: =head2
21359 #: ../inspector/virt-inspector.pod:316
21360 msgid "INSPECTING INSTALL DISKS, LIVE CDs"
21361 msgstr ""
21362
21363 #. type: textblock
21364 #: ../inspector/virt-inspector.pod:318
21365 msgid ""
21366 "Virt-inspector can detect some operating system installers on install disks, "
21367 "live CDs, bootable USB keys and more."
21368 msgstr ""
21369
21370 #. type: textblock
21371 #: ../inspector/virt-inspector.pod:321
21372 msgid ""
21373 "In this case the E<lt>formatE<gt> tag will contain C<installer> and other "
21374 "fields may be present to indicate a live CD, network installer, or one part "
21375 "of a multipart CD.  For example:"
21376 msgstr ""
21377
21378 #. type: verbatim
21379 #: ../inspector/virt-inspector.pod:325
21380 #, no-wrap
21381 msgid ""
21382 " <operatingsystems>\n"
21383 "   <operatingsystem>\n"
21384 "     <root>/dev/sda</root>\n"
21385 "     <name>linux</name>\n"
21386 "     <arch>i386</arch>\n"
21387 "     <distro>ubuntu</distro>\n"
21388 "     <product_name>Ubuntu 10.10 &quot;Maverick "
21389 "Meerkat&quot;</product_name>\n"
21390 "     <major_version>10</major_version>\n"
21391 "     <minor_version>10</minor_version>\n"
21392 "     <format>installer</format>\n"
21393 "     <live/>\n"
21394 "\n"
21395 msgstr ""
21396
21397 #. type: =head1
21398 #: ../inspector/virt-inspector.pod:337
21399 msgid "XPATH QUERIES"
21400 msgstr ""
21401
21402 #. type: textblock
21403 #: ../inspector/virt-inspector.pod:339
21404 msgid ""
21405 "Virt-inspector includes built in support for running XPath queries.  The "
21406 "reason for including XPath support directly in virt-inspector is simply that "
21407 "there are no good and widely available command line programs that can do "
21408 "XPath queries.  The only good one is L<xmlstarlet(1)> and that is not "
21409 "available on Red Hat Enterprise Linux."
21410 msgstr ""
21411
21412 #. type: textblock
21413 #: ../inspector/virt-inspector.pod:346
21414 msgid ""
21415 "To perform an XPath query, use the I<--xpath> option.  Note that in this "
21416 "mode, virt-inspector simply reads XML from stdin and outputs the query "
21417 "result on stdout.  All other inspection features are disabled in this mode."
21418 msgstr ""
21419
21420 #. type: verbatim
21421 #: ../inspector/virt-inspector.pod:353
21422 #, no-wrap
21423 msgid ""
21424 " $ virt-inspector -d Guest | virt-inspector --xpath '//filesystems'\n"
21425 " <filesystems>\n"
21426 "      <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
21427 "        <type>ext4</type>\n"
21428 " [...]\n"
21429 "\n"
21430 msgstr ""
21431
21432 #. type: verbatim
21433 #: ../inspector/virt-inspector.pod:359
21434 #, no-wrap
21435 msgid ""
21436 " $ virt-inspector -d Guest | \\\n"
21437 "     virt-inspector --xpath "
21438 "\"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
21439 " ext4\n"
21440 "\n"
21441 msgstr ""
21442
21443 #. type: verbatim
21444 #: ../inspector/virt-inspector.pod:363
21445 #, no-wrap
21446 msgid ""
21447 " $ virt-inspector -d Guest | \\\n"
21448 "     virt-inspector --xpath 'string(//icon)' | base64 -i -d | display -\n"
21449 " [displays the guest icon, if there is one]\n"
21450 "\n"
21451 msgstr ""
21452
21453 #. type: =head1
21454 #: ../inspector/virt-inspector.pod:374
21455 msgid "OLD VERSIONS OF VIRT-INSPECTOR"
21456 msgstr ""
21457
21458 #. type: textblock
21459 #: ../inspector/virt-inspector.pod:376
21460 msgid ""
21461 "Early versions of libguestfs shipped with a different virt-inspector program "
21462 "written in Perl (the current version is written in C).  The XML output of "
21463 "the Perl virt-inspector was different and it could also output in other "
21464 "formats like text."
21465 msgstr ""
21466
21467 #. type: textblock
21468 #: ../inspector/virt-inspector.pod:381
21469 msgid "The old virt-inspector is no longer supported or shipped with libguestfs."
21470 msgstr ""
21471
21472 #. type: textblock
21473 #: ../inspector/virt-inspector.pod:384
21474 msgid ""
21475 "To confuse matters further, in Red Hat Enterprise Linux 6 we ship two "
21476 "versions of virt-inspector with different names:"
21477 msgstr ""
21478
21479 #. type: verbatim
21480 #: ../inspector/virt-inspector.pod:387
21481 #, no-wrap
21482 msgid ""
21483 " virt-inspector     Old Perl version.\n"
21484 " virt-inspector2    New C version.\n"
21485 "\n"
21486 msgstr ""
21487
21488 #. type: textblock
21489 #: ../inspector/virt-inspector.pod:397
21490 msgid ""
21491 "L<guestfs(3)>, L<guestfish(1)>, L<http://www.w3.org/TR/xpath/>, "
21492 "L<base64(1)>, L<xmlstarlet(1)>, L<http://libguestfs.org/>."
21493 msgstr ""
21494
21495 #. type: textblock
21496 #: ../inspector/virt-inspector.pod:414
21497 msgid "Matthew Booth L<mbooth@redhat.com>"
21498 msgstr ""
21499
21500 #. type: textblock
21501 #: ../java/examples/guestfs-java.pod:5
21502 msgid "guestfs-java - How to use libguestfs from Java"
21503 msgstr ""
21504
21505 #. type: verbatim
21506 #: ../java/examples/guestfs-java.pod:9
21507 #, no-wrap
21508 msgid ""
21509 " import com.redhat.et.libguestfs.*;\n"
21510 " \n"
21511 msgstr ""
21512
21513 #. type: verbatim
21514 #: ../java/examples/guestfs-java.pod:11
21515 #, no-wrap
21516 msgid ""
21517 " GuestFS g = new GuestFS ();\n"
21518 " g.add_drive_opts (\"disk.img\", null);\n"
21519 " g.launch ();\n"
21520 "\n"
21521 msgstr ""
21522
21523 #. type: textblock
21524 #: ../java/examples/guestfs-java.pod:17
21525 msgid ""
21526 "This manual page documents how to call libguestfs from the Java programming "
21527 "language.  This page just documents the differences from the C API and gives "
21528 "some examples.  If you are not familiar with using libguestfs, you also need "
21529 "to read L<guestfs(3)>."
21530 msgstr ""
21531
21532 #. type: =head2
21533 #: ../java/examples/guestfs-java.pod:22 ../ocaml/examples/guestfs-ocaml.pod:53
21534 msgid "CLOSING THE HANDLE"
21535 msgstr ""
21536
21537 #. type: textblock
21538 #: ../java/examples/guestfs-java.pod:24
21539 msgid ""
21540 "The handle is closed when it is reaped by the garbage collector.  Because "
21541 "libguestfs handles include a lot of state, it is also possible to close (and "
21542 "hence free) them explicitly by calling the C<close> method."
21543 msgstr ""
21544
21545 #. type: =head2
21546 #: ../java/examples/guestfs-java.pod:29 ../ocaml/examples/guestfs-ocaml.pod:60 ../python/examples/guestfs-python.pod:21 ../ruby/examples/guestfs-ruby.pod:22
21547 msgid "EXCEPTIONS"
21548 msgstr ""
21549
21550 #. type: textblock
21551 #: ../java/examples/guestfs-java.pod:31
21552 msgid ""
21553 "Errors from libguestfs functions are mapped into the C<LibGuestFSException> "
21554 "exception.  This has a single parameter which is the error message (a "
21555 "C<String>)."
21556 msgstr ""
21557
21558 #. type: textblock
21559 #: ../java/examples/guestfs-java.pod:35
21560 msgid "Calling any method on a closed handle raises the same exception."
21561 msgstr ""
21562
21563 #. type: textblock
21564 #: ../java/examples/guestfs-java.pod:47
21565 msgid ""
21566 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, "
21567 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
21568 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>, "
21569 "L<http://caml.inria.fr/>."
21570 msgstr ""
21571
21572 #. type: textblock
21573 #: ../ocaml/examples/guestfs-ocaml.pod:5
21574 msgid "guestfs-ocaml - How to use libguestfs from OCaml"
21575 msgstr ""
21576
21577 #. type: textblock
21578 #: ../ocaml/examples/guestfs-ocaml.pod:9
21579 msgid "Module style:"
21580 msgstr ""
21581
21582 #. type: verbatim
21583 #: ../ocaml/examples/guestfs-ocaml.pod:11
21584 #, no-wrap
21585 msgid ""
21586 " let g = Guestfs.create () in\n"
21587 " Guestfs.add_drive_opts g ~format:\"raw\" ~readonly:true \"disk.img\";\n"
21588 " Guestfs.launch g;\n"
21589 "\n"
21590 msgstr ""
21591
21592 #. type: textblock
21593 #: ../ocaml/examples/guestfs-ocaml.pod:15
21594 msgid "Object-oriented style:"
21595 msgstr ""
21596
21597 #. type: verbatim
21598 #: ../ocaml/examples/guestfs-ocaml.pod:17
21599 #, no-wrap
21600 msgid ""
21601 " let g = new Guestfs.guestfs () in\n"
21602 " g#add_drive_opts ~format:\"raw\" ~readonly:true \"disk.img\";\n"
21603 " g#launch ();\n"
21604 "\n"
21605 msgstr ""
21606
21607 #. type: verbatim
21608 #: ../ocaml/examples/guestfs-ocaml.pod:21
21609 #, no-wrap
21610 msgid ""
21611 " ocamlfind opt prog.ml -package guestfs -linkpkg -o prog\n"
21612 "or:\n"
21613 " ocamlopt -I +guestfs mlguestfs.cmxa prog.ml -o prog\n"
21614 "\n"
21615 msgstr ""
21616
21617 #. type: textblock
21618 #: ../ocaml/examples/guestfs-ocaml.pod:27
21619 msgid ""
21620 "This manual page documents how to call libguestfs from the OCaml programming "
21621 "language.  This page just documents the differences from the C API and gives "
21622 "some examples.  If you are not familiar with using libguestfs, you also need "
21623 "to read L<guestfs(3)>."
21624 msgstr ""
21625
21626 #. type: =head2
21627 #: ../ocaml/examples/guestfs-ocaml.pod:32
21628 msgid "PROGRAMMING STYLES"
21629 msgstr ""
21630
21631 #. type: textblock
21632 #: ../ocaml/examples/guestfs-ocaml.pod:34
21633 msgid ""
21634 "There are two different programming styles supported by the OCaml bindings.  "
21635 "You can use a module style, with each C function mapped to an OCaml "
21636 "function:"
21637 msgstr ""
21638
21639 #. type: verbatim
21640 #: ../ocaml/examples/guestfs-ocaml.pod:38
21641 #, no-wrap
21642 msgid ""
21643 " int guestfs_set_verbose (guestfs_h *g, int flag);\n"
21644 "\n"
21645 msgstr ""
21646
21647 #. type: textblock
21648 #: ../ocaml/examples/guestfs-ocaml.pod:40
21649 msgid "becomes:"
21650 msgstr ""
21651
21652 #. type: verbatim
21653 #: ../ocaml/examples/guestfs-ocaml.pod:42
21654 #, no-wrap
21655 msgid ""
21656 " val Guestfs.set_verbose : Guestfs.t -> bool -> unit\n"
21657 "\n"
21658 msgstr ""
21659
21660 #. type: textblock
21661 #: ../ocaml/examples/guestfs-ocaml.pod:44
21662 msgid ""
21663 "Alternately you can use an object-oriented style, calling methods on the "
21664 "class C<Guestfs.guestfs>:"
21665 msgstr ""
21666
21667 #. type: verbatim
21668 #: ../ocaml/examples/guestfs-ocaml.pod:47
21669 #, no-wrap
21670 msgid ""
21671 " method set_verbose : bool -> unit\n"
21672 "\n"
21673 msgstr ""
21674
21675 #. type: textblock
21676 #: ../ocaml/examples/guestfs-ocaml.pod:49
21677 msgid ""
21678 "The object-oriented style is usually briefer, and the minor performance "
21679 "penalty isn't noticable in the general overhead of performing libguestfs "
21680 "functions."
21681 msgstr ""
21682
21683 #. type: textblock
21684 #: ../ocaml/examples/guestfs-ocaml.pod:55
21685 msgid ""
21686 "The handle is closed when it is reaped by the garbage collector.  Because "
21687 "libguestfs handles include a lot of state, it is also possible to close (and "
21688 "hence free) them explicitly by calling C<Guestfs.close> or the C<#close> "
21689 "method."
21690 msgstr ""
21691
21692 #. type: textblock
21693 #: ../ocaml/examples/guestfs-ocaml.pod:62
21694 msgid ""
21695 "Errors from libguestfs functions are mapped into the C<Guestfs.Error> "
21696 "exception.  This has a single parameter which is the error message (a "
21697 "string)."
21698 msgstr ""
21699
21700 #. type: textblock
21701 #: ../ocaml/examples/guestfs-ocaml.pod:66
21702 msgid ""
21703 "Calling any function/method on a closed handle raises "
21704 "C<Guestfs.Handle_closed>.  The single parameter is the name of the function "
21705 "that you called."
21706 msgstr ""
21707
21708 #. type: textblock
21709 #: ../ocaml/examples/guestfs-ocaml.pod:80
21710 msgid ""
21711 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, "
21712 "L<guestfs-java(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
21713 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>, "
21714 "L<http://caml.inria.fr/>."
21715 msgstr ""
21716
21717 #. type: textblock
21718 #: ../perl/examples/guestfs-perl.pod:5
21719 msgid "guestfs-perl - How to use libguestfs from Perl"
21720 msgstr ""
21721
21722 #. type: verbatim
21723 #: ../perl/examples/guestfs-perl.pod:9
21724 #, no-wrap
21725 msgid ""
21726 " use Sys::Guestfs;\n"
21727 " \n"
21728 msgstr ""
21729
21730 #. type: verbatim
21731 #: ../perl/examples/guestfs-perl.pod:11
21732 #, no-wrap
21733 msgid ""
21734 " my $h = Sys::Guestfs->new ();\n"
21735 " $h->add_drive_opts ('guest.img', format => 'raw');\n"
21736 " $h->launch ();\n"
21737 " $h->mount_options ('', '/dev/sda1', '/');\n"
21738 " $h->touch ('/hello');\n"
21739 " $h->sync ();\n"
21740 "\n"
21741 msgstr ""
21742
21743 #. type: textblock
21744 #: ../perl/examples/guestfs-perl.pod:20
21745 msgid ""
21746 "This manual page documents how to call libguestfs from the Perl programming "
21747 "language.  This page just documents the differences from the C API and gives "
21748 "some examples.  If you are not familiar with using libguestfs, you also need "
21749 "to read L<guestfs(3)>.  To read the full Perl API, see L<Sys::Guestfs(3)>."
21750 msgstr ""
21751
21752 #. type: =head2
21753 #: ../perl/examples/guestfs-perl.pod:26
21754 msgid "ERRORS"
21755 msgstr ""
21756
21757 #. type: textblock
21758 #: ../perl/examples/guestfs-perl.pod:28
21759 msgid ""
21760 "Errors from libguestfs functions turn into calls to C<croak> (see "
21761 "L<Carp(3)>)."
21762 msgstr ""
21763
21764 #. type: textblock
21765 #: ../perl/examples/guestfs-perl.pod:41
21766 msgid ""
21767 "L<Sys::Guestfs(3)>, L<guestfs(3)>, L<guestfs-examples(3)>, "
21768 "L<guestfs-erlang(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, "
21769 "L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, "
21770 "L<http://libguestfs.org/>."
21771 msgstr ""
21772
21773 #. type: textblock
21774 #: ../python/examples/guestfs-python.pod:5
21775 msgid "guestfs-python - How to use libguestfs from Python"
21776 msgstr ""
21777
21778 #. type: verbatim
21779 #: ../python/examples/guestfs-python.pod:9
21780 #, no-wrap
21781 msgid ""
21782 " import guestfs\n"
21783 " g = guestfs.GuestFS ()\n"
21784 " g.add_drive_opts (\"disk.img\", format=\"raw\", readonly=1)\n"
21785 " g.launch\n"
21786 "\n"
21787 msgstr ""
21788
21789 #. type: textblock
21790 #: ../python/examples/guestfs-python.pod:16
21791 msgid ""
21792 "This manual page documents how to call libguestfs from the Python "
21793 "programming language.  This page just documents the differences from the C "
21794 "API and gives some examples.  If you are not familiar with using libguestfs, "
21795 "you also need to read L<guestfs(3)>."
21796 msgstr ""
21797
21798 #. type: textblock
21799 #: ../python/examples/guestfs-python.pod:23
21800 msgid ""
21801 "Errors from libguestfs functions are mapped into C<RuntimeException> with a "
21802 "single string argument which is the error message."
21803 msgstr ""
21804
21805 #. type: =head2
21806 #: ../python/examples/guestfs-python.pod:26
21807 msgid "MORE DOCUMENTATION"
21808 msgstr ""
21809
21810 #. type: textblock
21811 #: ../python/examples/guestfs-python.pod:28
21812 msgid "Type:"
21813 msgstr ""
21814
21815 #. type: verbatim
21816 #: ../python/examples/guestfs-python.pod:30
21817 #, no-wrap
21818 msgid ""
21819 " $ python\n"
21820 " >>> import guestfs\n"
21821 " >>> help (guestfs)\n"
21822 "\n"
21823 msgstr ""
21824
21825 #. type: textblock
21826 #: ../python/examples/guestfs-python.pod:44
21827 msgid ""
21828 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, "
21829 "L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, "
21830 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
21831 msgstr ""
21832
21833 #. type: textblock
21834 #: ../rescue/virt-rescue.pod:5
21835 msgid "virt-rescue - Run a rescue shell on a virtual machine"
21836 msgstr ""
21837
21838 #. type: verbatim
21839 #: ../rescue/virt-rescue.pod:9
21840 #, no-wrap
21841 msgid ""
21842 " virt-rescue [--options] -d domname\n"
21843 "\n"
21844 msgstr ""
21845
21846 #. type: verbatim
21847 #: ../rescue/virt-rescue.pod:11
21848 #, no-wrap
21849 msgid ""
21850 " virt-rescue [--options] -a disk.img [-a disk.img ...]\n"
21851 "\n"
21852 msgstr ""
21853
21854 #. type: verbatim
21855 #: ../rescue/virt-rescue.pod:13
21856 #, no-wrap
21857 msgid ""
21858 " virt-rescue --suggest (-d domname | -a disk.img ...)\n"
21859 "\n"
21860 msgstr ""
21861
21862 #. type: verbatim
21863 #: ../rescue/virt-rescue.pod:17
21864 #, no-wrap
21865 msgid ""
21866 " virt-rescue [--options] domname\n"
21867 "\n"
21868 msgstr ""
21869
21870 #. type: verbatim
21871 #: ../rescue/virt-rescue.pod:19
21872 #, no-wrap
21873 msgid ""
21874 " virt-rescue [--options] disk.img [disk.img ...]\n"
21875 "\n"
21876 msgstr ""
21877
21878 #. type: textblock
21879 #: ../rescue/virt-rescue.pod:23
21880 msgid ""
21881 "You must I<not> use C<virt-rescue> on live virtual machines.  Doing so will "
21882 "probably result in disk corruption in the VM.  C<virt-rescue> tries to stop "
21883 "you from doing this, but doesn't catch all cases."
21884 msgstr ""
21885
21886 #. type: textblock
21887 #: ../rescue/virt-rescue.pod:27
21888 msgid ""
21889 "However if you use the I<--ro> (read only) option, then you can attach a "
21890 "shell to a live virtual machine.  The results might be strange or "
21891 "inconsistent at times but you won't get disk corruption."
21892 msgstr ""
21893
21894 #. type: textblock
21895 #: ../rescue/virt-rescue.pod:33
21896 msgid ""
21897 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
21898 "need for a CD.  virt-rescue gives you a rescue shell and some simple "
21899 "recovery tools which you can use to examine or rescue a virtual machine or "
21900 "disk image."
21901 msgstr ""
21902
21903 #. type: textblock
21904 #: ../rescue/virt-rescue.pod:38
21905 msgid ""
21906 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
21907 "on disk image(s):"
21908 msgstr ""
21909
21910 #. type: verbatim
21911 #: ../rescue/virt-rescue.pod:41
21912 #, no-wrap
21913 msgid ""
21914 " virt-rescue -d GuestName\n"
21915 "\n"
21916 msgstr ""
21917
21918 #. type: verbatim
21919 #: ../rescue/virt-rescue.pod:43
21920 #, no-wrap
21921 msgid ""
21922 " virt-rescue --ro -a /path/to/disk.img\n"
21923 "\n"
21924 msgstr ""
21925
21926 #. type: verbatim
21927 #: ../rescue/virt-rescue.pod:45
21928 #, no-wrap
21929 msgid ""
21930 " virt-rescue -a /dev/sdc\n"
21931 "\n"
21932 msgstr ""
21933
21934 #. type: textblock
21935 #: ../rescue/virt-rescue.pod:47
21936 msgid "For live VMs you I<must> use the --ro option."
21937 msgstr ""
21938
21939 #. type: textblock
21940 #: ../rescue/virt-rescue.pod:49
21941 msgid ""
21942 "When you run virt-rescue on a virtual machine or disk image, you are placed "
21943 "in an interactive bash shell where you can use many ordinary Linux "
21944 "commands.  What you see in C</> (C</bin>, C</lib> etc) is the rescue "
21945 "appliance.  You must mount the virtual machine's filesystems by hand.  There "
21946 "is an empty directory called C</sysroot> where you can mount filesystems."
21947 msgstr ""
21948
21949 #. type: textblock
21950 #: ../rescue/virt-rescue.pod:56
21951 msgid ""
21952 "You can get virt-rescue to suggest mount commands for you by using the "
21953 "I<--suggest> option (in another terminal):"
21954 msgstr ""
21955
21956 #. type: verbatim
21957 #: ../rescue/virt-rescue.pod:59
21958 #, no-wrap
21959 msgid ""
21960 " $ virt-rescue --suggest -d Fedora15\n"
21961 " Inspecting the virtual machine or disk image ...\n"
21962 " \n"
21963 msgstr ""
21964
21965 #. type: verbatim
21966 #: ../rescue/virt-rescue.pod:62
21967 #, no-wrap
21968 msgid ""
21969 " This disk contains one or more operating systems.  You can use these\n"
21970 " mount commands in virt-rescue (at the ><rescue> prompt) to mount the\n"
21971 " filesystems.\n"
21972 " \n"
21973 msgstr ""
21974
21975 #. type: verbatim
21976 #: ../rescue/virt-rescue.pod:66
21977 #, no-wrap
21978 msgid ""
21979 " # /dev/vg_f15x32/lv_root is the root of a linux operating system\n"
21980 " # type: linux, distro: fedora, version: 15.0\n"
21981 " # Fedora release 15 (Lovelock)\n"
21982 " \n"
21983 msgstr ""
21984
21985 #. type: verbatim
21986 #: ../rescue/virt-rescue.pod:70
21987 #, no-wrap
21988 msgid ""
21989 " mount /dev/vg_f15x32/lv_root /sysroot/\n"
21990 " mount /dev/vda1 /sysroot/boot\n"
21991 " mount --bind /dev /sysroot/dev\n"
21992 " mount --bind /dev/pts /sysroot/dev/pts\n"
21993 " mount --bind /proc /sysroot/proc\n"
21994 " mount --bind /sys /sysroot/sys\n"
21995 "\n"
21996 msgstr ""
21997
21998 #. type: textblock
21999 #: ../rescue/virt-rescue.pod:77
22000 msgid ""
22001 "Another way is to list the logical volumes (with L<lvs(8)>) and partitions "
22002 "(with L<parted(8)>) and mount them by hand:"
22003 msgstr ""
22004
22005 #. type: verbatim
22006 #: ../rescue/virt-rescue.pod:80
22007 #, no-wrap
22008 msgid ""
22009 " ><rescue> lvs\n"
22010 " LV      VG        Attr   LSize   Origin Snap%  Move Log Copy%  Convert\n"
22011 " lv_root vg_f15x32 -wi-a-   8.83G\n"
22012 " lv_swap vg_f15x32 -wi-a- 992.00M\n"
22013 " ><rescue> mount /dev/vg_f15x32/lv_root /sysroot\n"
22014 " ><rescue> mount /dev/vda1 /sysroot/boot\n"
22015 " ><rescue> ls /sysroot\n"
22016 "\n"
22017 msgstr ""
22018
22019 #. type: textblock
22020 #: ../rescue/virt-rescue.pod:88
22021 msgid "Another command to list available filesystems is L<virt-filesystems(1)>."
22022 msgstr ""
22023
22024 #. type: textblock
22025 #: ../rescue/virt-rescue.pod:91
22026 msgid ""
22027 "To run commands in a Linux guest (for example, grub), you should chroot into "
22028 "the /sysroot directory first:"
22029 msgstr ""
22030
22031 #. type: verbatim
22032 #: ../rescue/virt-rescue.pod:94
22033 #, no-wrap
22034 msgid ""
22035 " ><rescue> chroot /sysroot\n"
22036 "\n"
22037 msgstr ""
22038
22039 #. type: textblock
22040 #: ../rescue/virt-rescue.pod:98
22041 msgid ""
22042 "Virt-rescue can be used on I<any> disk image file or device, not just a "
22043 "virtual machine.  For example you can use it on a blank file if you want to "
22044 "partition that file (although we would recommend using L<guestfish(1)> "
22045 "instead as it is more suitable for this purpose).  You can even use "
22046 "virt-rescue on things like SD cards."
22047 msgstr ""
22048
22049 #. type: textblock
22050 #: ../rescue/virt-rescue.pod:104
22051 msgid ""
22052 "Virt-rescue does not require root.  You only need to run it as root if you "
22053 "need root to open the disk image."
22054 msgstr ""
22055
22056 #. type: textblock
22057 #: ../rescue/virt-rescue.pod:107
22058 msgid ""
22059 "This tool is just designed for quick interactive hacking on a virtual "
22060 "machine.  For more structured access to a virtual machine disk image, you "
22061 "should use L<guestfs(3)>.  To get a structured shell that you can use to "
22062 "make scripted changes to guests, use L<guestfish(1)>."
22063 msgstr ""
22064
22065 #. type: =item
22066 #: ../rescue/virt-rescue.pod:131
22067 msgid "B<--append kernelopts>"
22068 msgstr ""
22069
22070 #. type: textblock
22071 #: ../rescue/virt-rescue.pod:133
22072 msgid "Pass additional options to the rescue kernel."
22073 msgstr ""
22074
22075 #. type: verbatim
22076 #: ../rescue/virt-rescue.pod:163
22077 #, no-wrap
22078 msgid ""
22079 " virt-rescue --format=raw -a disk.img\n"
22080 "\n"
22081 msgstr ""
22082
22083 #. type: verbatim
22084 #: ../rescue/virt-rescue.pod:167
22085 #, no-wrap
22086 msgid ""
22087 " virt-rescue --format=raw -a disk.img --format -a another.img\n"
22088 "\n"
22089 msgstr ""
22090
22091 #. type: =item
22092 #: ../rescue/virt-rescue.pod:176
22093 msgid "B<-m MB>"
22094 msgstr ""
22095
22096 #. type: =item
22097 #: ../rescue/virt-rescue.pod:178
22098 msgid "B<--memsize MB>"
22099 msgstr ""
22100
22101 #. type: textblock
22102 #: ../rescue/virt-rescue.pod:180
22103 msgid ""
22104 "Change the amount of memory allocated to the rescue system.  The default is "
22105 "set by libguestfs and is small but adequate for running system tools.  The "
22106 "occasional program might need more memory.  The parameter is specified in "
22107 "megabytes."
22108 msgstr ""
22109
22110 #. type: =item
22111 #: ../rescue/virt-rescue.pod:185
22112 msgid "B<--network>"
22113 msgstr ""
22114
22115 #. type: textblock
22116 #: ../rescue/virt-rescue.pod:187
22117 msgid "Enable QEMU user networking in the guest.  See L</NETWORK>."
22118 msgstr ""
22119
22120 #. type: textblock
22121 #: ../rescue/virt-rescue.pod:193
22122 msgid "Open the image read-only."
22123 msgstr ""
22124
22125 #. type: textblock
22126 #: ../rescue/virt-rescue.pod:203
22127 msgid ""
22128 "Enable SELinux in the rescue appliance.  You should read "
22129 "L<guestfs(3)/SELINUX> before using this option."
22130 msgstr ""
22131
22132 #. type: =item
22133 #: ../rescue/virt-rescue.pod:206
22134 msgid "B<--smp> N"
22135 msgstr ""
22136
22137 #. type: textblock
22138 #: ../rescue/virt-rescue.pod:208
22139 msgid "Enable N E<ge> 2 virtual CPUs in the rescue appliance."
22140 msgstr ""
22141
22142 #. type: =item
22143 #: ../rescue/virt-rescue.pod:210
22144 msgid "B<--suggest>"
22145 msgstr ""
22146
22147 #. type: textblock
22148 #: ../rescue/virt-rescue.pod:212
22149 msgid ""
22150 "Inspect the disk image and suggest what mount commands should be used to "
22151 "mount the disks.  You should use the I<--suggest> option in a second "
22152 "terminal, then paste the commands into another virt-rescue."
22153 msgstr ""
22154
22155 #. type: textblock
22156 #: ../rescue/virt-rescue.pod:216
22157 msgid ""
22158 "This option implies I<--ro> and is safe to use even if the guest is up or if "
22159 "another virt-rescue is running."
22160 msgstr ""
22161
22162 #. type: textblock
22163 #: ../rescue/virt-rescue.pod:235
22164 msgid ""
22165 "This changes the I<-a> and I<-d> options so that disks are added and mounts "
22166 "are done read-write."
22167 msgstr ""
22168
22169 #. type: textblock
22170 #: ../rescue/virt-rescue.pod:248
22171 msgid "Previous versions of virt-rescue allowed you to write either:"
22172 msgstr ""
22173
22174 #. type: verbatim
22175 #: ../rescue/virt-rescue.pod:250
22176 #, no-wrap
22177 msgid ""
22178 " virt-rescue disk.img [disk.img ...]\n"
22179 "\n"
22180 msgstr ""
22181
22182 #. type: verbatim
22183 #: ../rescue/virt-rescue.pod:254
22184 #, no-wrap
22185 msgid ""
22186 " virt-rescue guestname\n"
22187 "\n"
22188 msgstr ""
22189
22190 #. type: =head1
22191 #: ../rescue/virt-rescue.pod:262
22192 msgid "NETWORK"
22193 msgstr ""
22194
22195 #. type: textblock
22196 #: ../rescue/virt-rescue.pod:264
22197 msgid ""
22198 "Adding the I<--network> option enables QEMU user networking in the rescue "
22199 "appliance.  There are some differences between user networking and ordinary "
22200 "networking:"
22201 msgstr ""
22202
22203 #. type: =item
22204 #: ../rescue/virt-rescue.pod:270
22205 msgid "ping does not work"
22206 msgstr ""
22207
22208 #. type: textblock
22209 #: ../rescue/virt-rescue.pod:272
22210 msgid ""
22211 "Because the ICMP ECHO_REQUEST protocol generally requires root in order to "
22212 "send the ping packets, and because virt-rescue must be able to run as "
22213 "non-root, QEMU user networking is not able to emulate the L<ping(8)> "
22214 "command.  The ping command will appear to resolve addresses but will not be "
22215 "able to send or receive any packets.  This does not mean that the network is "
22216 "not working."
22217 msgstr ""
22218
22219 #. type: =item
22220 #: ../rescue/virt-rescue.pod:279
22221 msgid "cannot receive connections"
22222 msgstr ""
22223
22224 #. type: textblock
22225 #: ../rescue/virt-rescue.pod:281
22226 msgid "QEMU user networking cannot receive incoming connections."
22227 msgstr ""
22228
22229 #. type: =item
22230 #: ../rescue/virt-rescue.pod:283
22231 msgid "making TCP connections"
22232 msgstr ""
22233
22234 #. type: textblock
22235 #: ../rescue/virt-rescue.pod:285
22236 msgid ""
22237 "The virt-rescue appliance needs to be small and so does not include many "
22238 "network tools.  In particular there is no L<telnet(1)> command.  You can "
22239 "make TCP connections from the shell using the magical "
22240 "C</dev/tcp/E<lt>hostnameE<gt>/E<lt>portE<gt>> syntax:"
22241 msgstr ""
22242
22243 #. type: verbatim
22244 #: ../rescue/virt-rescue.pod:290
22245 #, no-wrap
22246 msgid ""
22247 " exec 3<>/dev/tcp/redhat.com/80\n"
22248 " echo \"GET /\" >&3\n"
22249 " cat <&3\n"
22250 "\n"
22251 msgstr ""
22252
22253 #. type: textblock
22254 #: ../rescue/virt-rescue.pod:294
22255 msgid "See L<bash(1)> for more details."
22256 msgstr ""
22257
22258 #. type: textblock
22259 #: ../rescue/virt-rescue.pod:300
22260 msgid ""
22261 "Several environment variables affect virt-rescue.  See "
22262 "L<guestfs(3)/ENVIRONMENT VARIABLES> for the complete list."
22263 msgstr ""
22264
22265 #. type: textblock
22266 #: ../rescue/virt-rescue.pod:327
22267 msgid ""
22268 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
22269 "L<virt-filesystems(1)>, L<http://libguestfs.org/>."
22270 msgstr ""
22271
22272 #. type: textblock
22273 #: ../resize/virt-resize.pod:5
22274 msgid "virt-resize - Resize a virtual machine disk"
22275 msgstr ""
22276
22277 #. type: verbatim
22278 #: ../resize/virt-resize.pod:9
22279 #, no-wrap
22280 msgid ""
22281 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
22282 "   [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
22283 "   [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
22284 "\n"
22285 msgstr ""
22286
22287 #. type: textblock
22288 #: ../resize/virt-resize.pod:15
22289 msgid ""
22290 "Virt-resize is a tool which can resize a virtual machine disk, making it "
22291 "larger or smaller overall, and resizing or deleting any partitions contained "
22292 "within."
22293 msgstr ""
22294
22295 #. type: textblock
22296 #: ../resize/virt-resize.pod:19
22297 msgid ""
22298 "Virt-resize B<cannot> resize disk images in-place.  Virt-resize B<should "
22299 "not> be used on live virtual machines - for consistent results, shut the "
22300 "virtual machine down before resizing it."
22301 msgstr ""
22302
22303 #. type: textblock
22304 #: ../resize/virt-resize.pod:23
22305 msgid ""
22306 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
22307 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
22308 msgstr ""
22309
22310 #. type: =item
22311 #: ../resize/virt-resize.pod:31 ../resize/virt-resize.pod:597 ../sparsify/virt-sparsify.pod:203 ../src/guestfs.pod:484 ../src/guestfs.pod:1302 ../src/guestfs.pod:1441 ../src/guestfs.pod:2690
22312 msgid "1."
22313 msgstr ""
22314
22315 #. type: textblock
22316 #: ../resize/virt-resize.pod:33
22317 msgid ""
22318 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
22319 "fill the extra 5GB of space."
22320 msgstr ""
22321
22322 #. type: verbatim
22323 #: ../resize/virt-resize.pod:36
22324 #, no-wrap
22325 msgid ""
22326 " virt-filesystems --long -h --all -a olddisk\n"
22327 " \n"
22328 msgstr ""
22329
22330 #. type: verbatim
22331 #: ../resize/virt-resize.pod:38
22332 #, no-wrap
22333 msgid ""
22334 " truncate -r olddisk newdisk\n"
22335 " truncate -s +5G newdisk\n"
22336 " \n"
22337 msgstr ""
22338
22339 #. type: verbatim
22340 #: ../resize/virt-resize.pod:41
22341 #, no-wrap
22342 msgid ""
22343 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
22344 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
22345 "\n"
22346 msgstr ""
22347
22348 #. type: =item
22349 #: ../resize/virt-resize.pod:44 ../resize/virt-resize.pod:604 ../sparsify/virt-sparsify.pod:210 ../src/guestfs.pod:490 ../src/guestfs.pod:1306 ../src/guestfs.pod:1445 ../src/guestfs.pod:2715
22350 msgid "2."
22351 msgstr ""
22352
22353 #. type: textblock
22354 #: ../resize/virt-resize.pod:46
22355 msgid ""
22356 "As above, but make the /boot partition 200MB bigger, while giving the "
22357 "remaining space to /dev/sda2:"
22358 msgstr ""
22359
22360 #. type: verbatim
22361 #: ../resize/virt-resize.pod:49
22362 #, no-wrap
22363 msgid ""
22364 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
22365 "   olddisk newdisk\n"
22366 "\n"
22367 msgstr ""
22368
22369 #. type: =item
22370 #: ../resize/virt-resize.pod:52 ../resize/virt-resize.pod:610 ../sparsify/virt-sparsify.pod:216 ../src/guestfs.pod:501 ../src/guestfs.pod:1451
22371 msgid "3."
22372 msgstr ""
22373
22374 #. type: textblock
22375 #: ../resize/virt-resize.pod:54
22376 msgid ""
22377 "As in the first example, but expand a logical volume as the final step.  "
22378 "This is what you would typically use for Linux guests that use LVM:"
22379 msgstr ""
22380
22381 #. type: verbatim
22382 #: ../resize/virt-resize.pod:58
22383 #, no-wrap
22384 msgid ""
22385 " virt-resize --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root \\\n"
22386 "   olddisk newdisk\n"
22387 "\n"
22388 msgstr ""
22389
22390 #. type: =item
22391 #: ../resize/virt-resize.pod:61
22392 msgid "4."
22393 msgstr ""
22394
22395 #. type: textblock
22396 #: ../resize/virt-resize.pod:63
22397 msgid ""
22398 "As in the first example, but the output format will be qcow2 instead of a "
22399 "raw disk:"
22400 msgstr ""
22401
22402 #. type: verbatim
22403 #: ../resize/virt-resize.pod:66
22404 #, no-wrap
22405 msgid ""
22406 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
22407 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
22408 "\n"
22409 msgstr ""
22410
22411 #. type: =head1
22412 #: ../resize/virt-resize.pod:71
22413 msgid "DETAILED USAGE"
22414 msgstr ""
22415
22416 #. type: =head2
22417 #: ../resize/virt-resize.pod:73
22418 msgid "EXPANDING A VIRTUAL MACHINE DISK"
22419 msgstr ""
22420
22421 #. type: =item
22422 #: ../resize/virt-resize.pod:77
22423 msgid "1. Shut down the virtual machine"
22424 msgstr ""
22425
22426 #. type: =item
22427 #: ../resize/virt-resize.pod:79
22428 msgid "2. Locate input disk image"
22429 msgstr ""
22430
22431 #. type: textblock
22432 #: ../resize/virt-resize.pod:81
22433 msgid ""
22434 "Locate the input disk image (ie. the file or device on the host containing "
22435 "the guest's disk).  If the guest is managed by libvirt, you can use C<virsh "
22436 "dumpxml> like this to find the disk image name:"
22437 msgstr ""
22438
22439 #. type: verbatim
22440 #: ../resize/virt-resize.pod:85
22441 #, no-wrap
22442 msgid ""
22443 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
22444 " Found 1 nodes:\n"
22445 " -- NODE --\n"
22446 " <source dev=\"/dev/vg/lv_guest\" />\n"
22447 "\n"
22448 msgstr ""
22449
22450 #. type: =item
22451 #: ../resize/virt-resize.pod:90
22452 msgid "3. Look at current sizing"
22453 msgstr ""
22454
22455 #. type: textblock
22456 #: ../resize/virt-resize.pod:92
22457 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
22458 msgstr ""
22459
22460 #. type: verbatim
22461 #: ../resize/virt-resize.pod:95
22462 #, no-wrap
22463 msgid ""
22464 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
22465 " Name       Type       Size  Parent\n"
22466 " /dev/sda1  partition  101M  /dev/sda\n"
22467 " /dev/sda2  partition  7.9G  /dev/sda\n"
22468 " /dev/sda   device     8.0G  -\n"
22469 "\n"
22470 msgstr ""
22471
22472 #. type: textblock
22473 #: ../resize/virt-resize.pod:101
22474 msgid ""
22475 "(This example is a virtual machine with an 8 GB disk which we would like to "
22476 "expand up to 10 GB)."
22477 msgstr ""
22478
22479 #. type: =item
22480 #: ../resize/virt-resize.pod:104
22481 msgid "4. Create output disk"
22482 msgstr ""
22483
22484 #. type: textblock
22485 #: ../resize/virt-resize.pod:106
22486 msgid ""
22487 "Virt-resize cannot do in-place disk modifications.  You have to have space "
22488 "to store the resized output disk."
22489 msgstr ""
22490
22491 #. type: textblock
22492 #: ../resize/virt-resize.pod:109
22493 msgid "To store the resized disk image in a file, create a file of a suitable size:"
22494 msgstr ""
22495
22496 #. type: verbatim
22497 #: ../resize/virt-resize.pod:112
22498 #, no-wrap
22499 msgid ""
22500 " # rm -f outdisk\n"
22501 " # truncate -s 10G outdisk\n"
22502 "\n"
22503 msgstr ""
22504
22505 #. type: textblock
22506 #: ../resize/virt-resize.pod:115
22507 msgid "Or use L<lvcreate(1)> to create a logical volume:"
22508 msgstr ""
22509
22510 #. type: verbatim
22511 #: ../resize/virt-resize.pod:117
22512 #, no-wrap
22513 msgid ""
22514 " # lvcreate -L 10G -n lv_name vg_name\n"
22515 "\n"
22516 msgstr ""
22517
22518 #. type: textblock
22519 #: ../resize/virt-resize.pod:119
22520 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
22521 msgstr ""
22522
22523 #. type: verbatim
22524 #: ../resize/virt-resize.pod:121
22525 #, no-wrap
22526 msgid ""
22527 " # virsh pool-list\n"
22528 " # virsh vol-create-as poolname newvol 10G\n"
22529 "\n"
22530 msgstr ""
22531
22532 #. type: =item
22533 #: ../resize/virt-resize.pod:124
22534 msgid "5. Resize"
22535 msgstr ""
22536
22537 #. type: textblock
22538 #: ../resize/virt-resize.pod:126
22539 msgid ""
22540 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
22541 "file) and the output disk.  The output disk is the one created in the "
22542 "previous step."
22543 msgstr ""
22544
22545 #. type: verbatim
22546 #: ../resize/virt-resize.pod:130
22547 #, no-wrap
22548 msgid ""
22549 " # virt-resize indisk outdisk\n"
22550 "\n"
22551 msgstr ""
22552
22553 #. type: textblock
22554 #: ../resize/virt-resize.pod:132
22555 msgid ""
22556 "This command just copies disk image C<indisk> to disk image C<outdisk> "
22557 "I<without> resizing or changing any existing partitions.  If C<outdisk> is "
22558 "larger, then an extra, empty partition is created at the end of the disk "
22559 "covering the extra space.  If C<outdisk> is smaller, then it will give an "
22560 "error."
22561 msgstr ""
22562
22563 #. type: textblock
22564 #: ../resize/virt-resize.pod:138
22565 msgid ""
22566 "More realistically you'd want to expand existing partitions in the disk "
22567 "image by passing extra options (for the full list see the L</OPTIONS> "
22568 "section below)."
22569 msgstr ""
22570
22571 #. type: textblock
22572 #: ../resize/virt-resize.pod:142
22573 msgid ""
22574 "L</--expand> is the most useful option.  It expands the named partition "
22575 "within the disk to fill any extra space:"
22576 msgstr ""
22577
22578 #. type: verbatim
22579 #: ../resize/virt-resize.pod:145
22580 #, no-wrap
22581 msgid ""
22582 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
22583 "\n"
22584 msgstr ""
22585
22586 #. type: textblock
22587 #: ../resize/virt-resize.pod:147
22588 msgid ""
22589 "(In this case, an extra partition is I<not> created at the end of the disk, "
22590 "because there will be no unused space)."
22591 msgstr ""
22592
22593 #. type: textblock
22594 #: ../resize/virt-resize.pod:150
22595 msgid ""
22596 "L</--resize> is the other commonly used option.  The following would "
22597 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
22598 "rest of the available space:"
22599 msgstr ""
22600
22601 #. type: verbatim
22602 #: ../resize/virt-resize.pod:154
22603 #, no-wrap
22604 msgid ""
22605 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
22606 "     indisk outdisk\n"
22607 "\n"
22608 msgstr ""
22609
22610 #. type: textblock
22611 #: ../resize/virt-resize.pod:157
22612 msgid ""
22613 "If the expanded partition in the image contains a filesystem or LVM PV, then "
22614 "if virt-resize knows how, it will resize the contents, the equivalent of "
22615 "calling a command such as L<pvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)> "
22616 "or L<btrfs(8)>.  However virt-resize does not know how to resize some "
22617 "filesystems, so you would have to online resize them after booting the "
22618 "guest."
22619 msgstr ""
22620
22621 #. type: textblock
22622 #: ../resize/virt-resize.pod:164
22623 msgid "Other options are covered below."
22624 msgstr ""
22625
22626 #. type: =item
22627 #: ../resize/virt-resize.pod:166
22628 msgid "6. Test"
22629 msgstr ""
22630
22631 #. type: textblock
22632 #: ../resize/virt-resize.pod:168
22633 msgid "Thoroughly test the new disk image I<before> discarding the old one."
22634 msgstr ""
22635
22636 #. type: textblock
22637 #: ../resize/virt-resize.pod:170
22638 msgid "If you are using libvirt, edit the XML to point at the new disk:"
22639 msgstr ""
22640
22641 #. type: verbatim
22642 #: ../resize/virt-resize.pod:172
22643 #, no-wrap
22644 msgid ""
22645 " # virsh edit guestname\n"
22646 "\n"
22647 msgstr ""
22648
22649 #. type: textblock
22650 #: ../resize/virt-resize.pod:174
22651 msgid ""
22652 "Change E<lt>source ...E<gt>, see "
22653 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
22654 msgstr ""
22655
22656 #. type: textblock
22657 #: ../resize/virt-resize.pod:177
22658 msgid "Then start up the domain with the new, resized disk:"
22659 msgstr ""
22660
22661 #. type: verbatim
22662 #: ../resize/virt-resize.pod:179
22663 #, no-wrap
22664 msgid ""
22665 " # virsh start guestname\n"
22666 "\n"
22667 msgstr ""
22668
22669 #. type: textblock
22670 #: ../resize/virt-resize.pod:181
22671 msgid ""
22672 "and check that it still works.  See also the L</NOTES> section below for "
22673 "additional information."
22674 msgstr ""
22675
22676 #. type: =item
22677 #: ../resize/virt-resize.pod:184
22678 msgid "7. Resize LVs etc inside the guest"
22679 msgstr ""
22680
22681 #. type: textblock
22682 #: ../resize/virt-resize.pod:186
22683 msgid "(This can also be done offline using L<guestfish(1)>)"
22684 msgstr ""
22685
22686 #. type: textblock
22687 #: ../resize/virt-resize.pod:188
22688 msgid ""
22689 "Once the guest has booted you should see the new space available, at least "
22690 "for filesystems that virt-resize knows how to resize, and for PVs.  The user "
22691 "may need to resize LVs inside PVs, and also resize filesystem types that "
22692 "virt-resize does not know how to expand."
22693 msgstr ""
22694
22695 #. type: =head2
22696 #: ../resize/virt-resize.pod:195
22697 msgid "SHRINKING A VIRTUAL MACHINE DISK"
22698 msgstr ""
22699
22700 #. type: textblock
22701 #: ../resize/virt-resize.pod:197
22702 msgid ""
22703 "Shrinking is somewhat more complex than expanding, and only an overview is "
22704 "given here."
22705 msgstr ""
22706
22707 #. type: textblock
22708 #: ../resize/virt-resize.pod:200
22709 msgid ""
22710 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
22711 "filesystems).  The user has to shrink content before passing the disk image "
22712 "to virt-resize, and virt-resize will check that the content has been shrunk "
22713 "properly."
22714 msgstr ""
22715
22716 #. type: textblock
22717 #: ../resize/virt-resize.pod:205
22718 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
22719 msgstr ""
22720
22721 #. type: textblock
22722 #: ../resize/virt-resize.pod:207
22723 msgid ""
22724 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
22725 "steps 3 and 4 above to allocate a new disk image."
22726 msgstr ""
22727
22728 #. type: textblock
22729 #: ../resize/virt-resize.pod:210
22730 msgid "Then run virt-resize with any of the I<--shrink> and/or I<--resize> options."
22731 msgstr ""
22732
22733 #. type: =head2
22734 #: ../resize/virt-resize.pod:213
22735 msgid "IGNORING OR DELETING PARTITIONS"
22736 msgstr ""
22737
22738 #. type: textblock
22739 #: ../resize/virt-resize.pod:215
22740 msgid ""
22741 "virt-resize also gives a convenient way to ignore or delete partitions when "
22742 "copying from the input disk to the output disk.  Ignoring a partition speeds "
22743 "up the copy where you don't care about the existing contents of a "
22744 "partition.  Deleting a partition removes it completely, but note that it "
22745 "also renumbers any partitions after the one which is deleted, which can "
22746 "leave some guests unbootable."
22747 msgstr ""
22748
22749 #. type: =head2
22750 #: ../resize/virt-resize.pod:222
22751 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
22752 msgstr ""
22753
22754 #. type: textblock
22755 #: ../resize/virt-resize.pod:224
22756 msgid ""
22757 "If the input disk is in qcow2 format, then you may prefer that the output is "
22758 "in qcow2 format as well.  Alternately, virt-resize can convert the format on "
22759 "the fly.  The output format is simply determined by the format of the empty "
22760 "output container that you provide.  Thus to create qcow2 output, use:"
22761 msgstr ""
22762
22763 #. type: verbatim
22764 #: ../resize/virt-resize.pod:230
22765 #, no-wrap
22766 msgid ""
22767 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
22768 "\n"
22769 msgstr ""
22770
22771 #. type: textblock
22772 #: ../resize/virt-resize.pod:232
22773 msgid "instead of the truncate command (use I<-c> for a compressed disk)."
22774 msgstr ""
22775
22776 #. type: textblock
22777 #: ../resize/virt-resize.pod:234
22778 msgid "Similarly, to get non-sparse raw output use:"
22779 msgstr ""
22780
22781 #. type: verbatim
22782 #: ../resize/virt-resize.pod:236
22783 #, no-wrap
22784 msgid ""
22785 " fallocate -l size outdisk\n"
22786 "\n"
22787 msgstr ""
22788
22789 #. type: textblock
22790 #: ../resize/virt-resize.pod:238
22791 msgid ""
22792 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
22793 "if=/dev/zero of=outdisk bs=1M count=..>)"
22794 msgstr ""
22795
22796 #. type: =head2
22797 #: ../resize/virt-resize.pod:241
22798 msgid "LOGICAL PARTITIONS"
22799 msgstr ""
22800
22801 #. type: textblock
22802 #: ../resize/virt-resize.pod:243
22803 msgid ""
22804 "Logical partitions (a.k.a. C</dev/sda5+> on disks using DOS partition "
22805 "tables) cannot be resized."
22806 msgstr ""
22807
22808 #. type: textblock
22809 #: ../resize/virt-resize.pod:246
22810 msgid ""
22811 "To understand what is going on, firstly one of the four partitions "
22812 "C</dev/sda1-4> will have MBR partition type C<05> or C<0f>.  This is called "
22813 "the B<extended partition>.  Use L<virt-filesystems(1)> to see the MBR "
22814 "partition type."
22815 msgstr ""
22816
22817 #. type: textblock
22818 #: ../resize/virt-resize.pod:251
22819 msgid "Logical partitions live inside the extended partition."
22820 msgstr ""
22821
22822 #. type: textblock
22823 #: ../resize/virt-resize.pod:253
22824 msgid ""
22825 "The extended partition can be expanded, but not shrunk (unless you force it, "
22826 "which is not advisable).  When the extended partition is copied across, all "
22827 "the logical partitions contained inside are copied over implicitly.  "
22828 "Virt-resize does not look inside the extended partition, so it copies the "
22829 "logical partitions blindly."
22830 msgstr ""
22831
22832 #. type: textblock
22833 #: ../resize/virt-resize.pod:259
22834 msgid ""
22835 "You cannot specify a logical partition (C</dev/sda5+>) at all on the command "
22836 "line.  Doing so will give an error."
22837 msgstr ""
22838
22839 #. type: textblock
22840 #: ../resize/virt-resize.pod:268 ../sparsify/virt-sparsify.pod:105
22841 msgid "Display help."
22842 msgstr ""
22843
22844 #. type: =item
22845 #: ../resize/virt-resize.pod:270
22846 msgid "B<--align-first auto>"
22847 msgstr ""
22848
22849 #. type: =item
22850 #: ../resize/virt-resize.pod:272
22851 msgid "B<--align-first never>"
22852 msgstr ""
22853
22854 #. type: =item
22855 #: ../resize/virt-resize.pod:274
22856 msgid "B<--align-first always>"
22857 msgstr ""
22858
22859 #. type: textblock
22860 #: ../resize/virt-resize.pod:276
22861 msgid ""
22862 "Align the first partition for improved performance (see also the "
22863 "I<--alignment> option)."
22864 msgstr ""
22865
22866 #. type: textblock
22867 #: ../resize/virt-resize.pod:279
22868 msgid ""
22869 "The default is I<--align-first auto> which only aligns the first partition "
22870 "if it is safe to do so.  That is, only when we know how to fix the "
22871 "bootloader automatically, and at the moment that can only be done for "
22872 "Windows guests."
22873 msgstr ""
22874
22875 #. type: textblock
22876 #: ../resize/virt-resize.pod:284
22877 msgid ""
22878 "I<--align-first never> means we never move the first partition.  This is the "
22879 "safest option.  Try this if the guest does not boot after resizing."
22880 msgstr ""
22881
22882 #. type: textblock
22883 #: ../resize/virt-resize.pod:288
22884 msgid ""
22885 "I<--align-first always> means we always align the first partition (if it "
22886 "needs to be aligned).  For some guests this will break the bootloader, "
22887 "making the guest unbootable."
22888 msgstr ""
22889
22890 #. type: =item
22891 #: ../resize/virt-resize.pod:292
22892 msgid "B<--alignment N>"
22893 msgstr ""
22894
22895 #. type: textblock
22896 #: ../resize/virt-resize.pod:294
22897 msgid ""
22898 "Set the alignment of partitions to C<N> sectors.  The default in virt-resize "
22899 "E<lt> 1.13.19 was 64 sectors, and after that is 128 sectors."
22900 msgstr ""
22901
22902 #. type: textblock
22903 #: ../resize/virt-resize.pod:298
22904 msgid ""
22905 "Assuming 512 byte sector size inside the guest, here are some suitable "
22906 "values for this:"
22907 msgstr ""
22908
22909 #. type: =item
22910 #: ../resize/virt-resize.pod:303
22911 msgid "I<--alignment 1> (512 bytes)"
22912 msgstr ""
22913
22914 #. type: textblock
22915 #: ../resize/virt-resize.pod:305
22916 msgid ""
22917 "The partitions would be packed together as closely as possible, but would be "
22918 "completely unaligned.  In some cases this can cause very poor performance.  "
22919 "See L<virt-alignment-scan(1)> for further details."
22920 msgstr ""
22921
22922 #. type: =item
22923 #: ../resize/virt-resize.pod:309
22924 msgid "I<--alignment 8> (4K)"
22925 msgstr ""
22926
22927 #. type: textblock
22928 #: ../resize/virt-resize.pod:311
22929 msgid ""
22930 "This would be the minimum acceptable alignment for reasonable performance on "
22931 "modern hosts."
22932 msgstr ""
22933
22934 #. type: =item
22935 #: ../resize/virt-resize.pod:314
22936 msgid "I<--alignment 128> (64K)"
22937 msgstr ""
22938
22939 #. type: textblock
22940 #: ../resize/virt-resize.pod:316
22941 msgid ""
22942 "This alignment provides good performance when the host is using high end "
22943 "network storage."
22944 msgstr ""
22945
22946 #. type: =item
22947 #: ../resize/virt-resize.pod:319
22948 msgid "I<--alignment 2048> (1M)"
22949 msgstr ""
22950
22951 #. type: textblock
22952 #: ../resize/virt-resize.pod:321
22953 msgid ""
22954 "This is the standard alignment used by all newly installed guests since "
22955 "around 2008."
22956 msgstr ""
22957
22958 #. type: =item
22959 #: ../resize/virt-resize.pod:326
22960 msgid "B<-d>"
22961 msgstr ""
22962
22963 #. type: =item
22964 #: ../resize/virt-resize.pod:328 ../tools/virt-make-fs.pl:177 ../tools/virt-win-reg.pl:120
22965 msgid "B<--debug>"
22966 msgstr ""
22967
22968 #. type: textblock
22969 #: ../resize/virt-resize.pod:330 ../tools/virt-win-reg.pl:122
22970 msgid "Enable debugging messages."
22971 msgstr ""
22972
22973 #. type: =item
22974 #: ../resize/virt-resize.pod:332
22975 msgid "B<--delete part>"
22976 msgstr ""
22977
22978 #. type: textblock
22979 #: ../resize/virt-resize.pod:334
22980 msgid ""
22981 "Delete the named partition.  It would be more accurate to describe this as "
22982 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
22983 "the original disk image is left intact."
22984 msgstr ""
22985
22986 #. type: textblock
22987 #: ../resize/virt-resize.pod:338
22988 msgid ""
22989 "Note that when you delete a partition, then anything contained in the "
22990 "partition is also deleted.  Furthermore, this causes any partitions that "
22991 "come after to be I<renumbered>, which can easily make your guest unbootable."
22992 msgstr ""
22993
22994 #. type: textblock
22995 #: ../resize/virt-resize.pod:343 ../resize/virt-resize.pod:404 ../resize/virt-resize.pod:531 ../sparsify/virt-sparsify.pod:145
22996 msgid "You can give this option multiple times."
22997 msgstr ""
22998
22999 #. type: =item
23000 #: ../resize/virt-resize.pod:345
23001 msgid "B<--expand part>"
23002 msgstr ""
23003
23004 #. type: textblock
23005 #: ../resize/virt-resize.pod:347
23006 msgid ""
23007 "Expand the named partition so it uses up all extra space (space left over "
23008 "after any other resize changes that you request have been done)."
23009 msgstr ""
23010
23011 #. type: textblock
23012 #: ../resize/virt-resize.pod:350
23013 msgid ""
23014 "If virt-resize knows how, it will expand the direct content of the "
23015 "partition.  For example, if the partition is an LVM PV, it will expand the "
23016 "PV to fit (like calling L<pvresize(8)>).  Virt-resize leaves any other "
23017 "content it doesn't know about alone."
23018 msgstr ""
23019
23020 #. type: textblock
23021 #: ../resize/virt-resize.pod:355
23022 msgid "Currently virt-resize can resize:"
23023 msgstr ""
23024
23025 #. type: textblock
23026 #: ../resize/virt-resize.pod:361
23027 msgid "ext2, ext3 and ext4 filesystems."
23028 msgstr ""
23029
23030 #. type: textblock
23031 #: ../resize/virt-resize.pod:365
23032 msgid "NTFS filesystems, if libguestfs was compiled with support for NTFS."
23033 msgstr ""
23034
23035 #. type: textblock
23036 #: ../resize/virt-resize.pod:367
23037 msgid ""
23038 "The filesystem must have been shut down consistently last time it was used.  "
23039 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
23040 "consistency check, so at the first boot after resizing Windows will check "
23041 "the disk."
23042 msgstr ""
23043
23044 #. type: textblock
23045 #: ../resize/virt-resize.pod:374
23046 msgid ""
23047 "LVM PVs (physical volumes).  virt-resize does not usually resize anything "
23048 "inside the PV, but see the I<--LV-expand> option.  The user could also "
23049 "resize LVs as desired after boot."
23050 msgstr ""
23051
23052 #. type: textblock
23053 #: ../resize/virt-resize.pod:380
23054 msgid "Btrfs filesystems, if libguestfs was compiled with support for btrfs."
23055 msgstr ""
23056
23057 #. type: textblock
23058 #: ../resize/virt-resize.pod:384 ../resize/virt-resize.pod:559
23059 msgid "Note that you cannot use I<--expand> and I<--shrink> together."
23060 msgstr ""
23061
23062 #. type: =item
23063 #: ../resize/virt-resize.pod:386 ../sparsify/virt-sparsify.pod:125 ../tools/virt-list-filesystems.pl:91 ../tools/virt-list-partitions.pl:92 ../tools/virt-tar.pl:141 ../tools/virt-win-reg.pl:142
23064 msgid "B<--format> raw"
23065 msgstr ""
23066
23067 #. type: textblock
23068 #: ../resize/virt-resize.pod:388 ../sparsify/virt-sparsify.pod:129
23069 msgid ""
23070 "Specify the format of the input disk image.  If this flag is not given then "
23071 "it is auto-detected from the image itself."
23072 msgstr ""
23073
23074 #. type: textblock
23075 #: ../resize/virt-resize.pod:394
23076 msgid ""
23077 "Note that this option I<does not> affect the output format.  See L</QCOW2 "
23078 "AND NON-SPARSE RAW FORMATS>."
23079 msgstr ""
23080
23081 #. type: =item
23082 #: ../resize/virt-resize.pod:397
23083 msgid "B<--ignore part>"
23084 msgstr ""
23085
23086 #. type: textblock
23087 #: ../resize/virt-resize.pod:399
23088 msgid ""
23089 "Ignore the named partition.  Effectively this means the partition is "
23090 "allocated on the destination disk, but the content is not copied across from "
23091 "the source disk.  The content of the partition will be blank (all zero "
23092 "bytes)."
23093 msgstr ""
23094
23095 #. type: =item
23096 #: ../resize/virt-resize.pod:406
23097 msgid "B<--LV-expand logvol>"
23098 msgstr ""
23099
23100 #. type: textblock
23101 #: ../resize/virt-resize.pod:408
23102 msgid ""
23103 "This takes the logical volume and, as a final step, expands it to fill all "
23104 "the space available in its volume group.  A typical usage, assuming a Linux "
23105 "guest with a single PV C</dev/sda2> and a root device called "
23106 "C</dev/vg_guest/lv_root> would be:"
23107 msgstr ""
23108
23109 #. type: verbatim
23110 #: ../resize/virt-resize.pod:413
23111 #, no-wrap
23112 msgid ""
23113 " virt-resize indisk outdisk \\\n"
23114 "   --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
23115 "\n"
23116 msgstr ""
23117
23118 #. type: textblock
23119 #: ../resize/virt-resize.pod:416
23120 msgid ""
23121 "This would first expand the partition (and PV), and then expand the root "
23122 "device to fill the extra space in the PV."
23123 msgstr ""
23124
23125 #. type: textblock
23126 #: ../resize/virt-resize.pod:419
23127 msgid ""
23128 "The contents of the LV are also resized if virt-resize knows how to do "
23129 "that.  You can stop virt-resize from trying to expand the content by using "
23130 "the option I<--no-expand-content>."
23131 msgstr ""
23132
23133 #. type: textblock
23134 #: ../resize/virt-resize.pod:423
23135 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
23136 msgstr ""
23137
23138 #. type: textblock
23139 #: ../resize/virt-resize.pod:425
23140 msgid ""
23141 "You can give this option multiple times, I<but> it doesn't make sense to do "
23142 "this unless the logical volumes you specify are all in different volume "
23143 "groups."
23144 msgstr ""
23145
23146 #. type: =item
23147 #: ../resize/virt-resize.pod:429 ../sparsify/virt-sparsify.pod:147
23148 msgid "B<--machine-readable>"
23149 msgstr ""
23150
23151 #. type: textblock
23152 #: ../resize/virt-resize.pod:431 ../sparsify/virt-sparsify.pod:149
23153 msgid ""
23154 "This option is used to make the output more machine friendly when being "
23155 "parsed by other programs.  See L</MACHINE READABLE OUTPUT> below."
23156 msgstr ""
23157
23158 #. type: =item
23159 #: ../resize/virt-resize.pod:437
23160 msgid "B<--dryrun>"
23161 msgstr ""
23162
23163 #. type: textblock
23164 #: ../resize/virt-resize.pod:439
23165 msgid "Print a summary of what would be done, but don't do anything."
23166 msgstr ""
23167
23168 #. type: =item
23169 #: ../resize/virt-resize.pod:441
23170 msgid "B<--no-copy-boot-loader>"
23171 msgstr ""
23172
23173 #. type: textblock
23174 #: ../resize/virt-resize.pod:443
23175 msgid ""
23176 "By default, virt-resize copies over some sectors at the start of the disk "
23177 "(up to the beginning of the first partition).  Commonly these sectors "
23178 "contain the Master Boot Record (MBR) and the boot loader, and are required "
23179 "in order for the guest to boot correctly."
23180 msgstr ""
23181
23182 #. type: textblock
23183 #: ../resize/virt-resize.pod:448
23184 msgid ""
23185 "If you specify this flag, then this initial copy is not done.  You may need "
23186 "to reinstall the boot loader in this case."
23187 msgstr ""
23188
23189 #. type: =item
23190 #: ../resize/virt-resize.pod:451
23191 msgid "B<--no-extra-partition>"
23192 msgstr ""
23193
23194 #. type: textblock
23195 #: ../resize/virt-resize.pod:453
23196 msgid ""
23197 "By default, virt-resize creates an extra partition if there is any extra, "
23198 "unused space after all resizing has happened.  Use this option to prevent "
23199 "the extra partition from being created.  If you do this then the extra space "
23200 "will be inaccessible until you run fdisk, parted, or some other partitioning "
23201 "tool in the guest."
23202 msgstr ""
23203
23204 #. type: textblock
23205 #: ../resize/virt-resize.pod:459
23206 msgid ""
23207 "Note that if the surplus space is smaller than 10 MB, no extra partition "
23208 "will be created."
23209 msgstr ""
23210
23211 #. type: =item
23212 #: ../resize/virt-resize.pod:462
23213 msgid "B<--no-expand-content>"
23214 msgstr ""
23215
23216 #. type: textblock
23217 #: ../resize/virt-resize.pod:464
23218 msgid ""
23219 "By default, virt-resize will try to expand the direct contents of "
23220 "partitions, if it knows how (see I<--expand> option above)."
23221 msgstr ""
23222
23223 #. type: textblock
23224 #: ../resize/virt-resize.pod:467
23225 msgid ""
23226 "If you give the I<--no-expand-content> option then virt-resize will not "
23227 "attempt this."
23228 msgstr ""
23229
23230 #. type: =item
23231 #: ../resize/virt-resize.pod:470
23232 msgid "B<--ntfsresize-force>"
23233 msgstr ""
23234
23235 #. type: textblock
23236 #: ../resize/virt-resize.pod:472
23237 msgid ""
23238 "Pass the I<--force> option to L<ntfsresize(8)>, allowing resizing even if "
23239 "the NTFS disk is marked as needing a consistency check.  You have to use "
23240 "this option if you want to resize a Windows guest multiple times without "
23241 "booting into Windows between each resize."
23242 msgstr ""
23243
23244 #. type: =item
23245 #: ../resize/virt-resize.pod:478
23246 msgid "B<--output-format> raw"
23247 msgstr ""
23248
23249 #. type: textblock
23250 #: ../resize/virt-resize.pod:480
23251 msgid ""
23252 "Specify the format of the output disk image.  If this flag is not given then "
23253 "it is auto-detected from the image itself."
23254 msgstr ""
23255
23256 #. type: textblock
23257 #: ../resize/virt-resize.pod:486
23258 msgid ""
23259 "Note that this option I<does not create> the output format.  This option "
23260 "just tells libguestfs what it is so it doesn't try to guess it.  You still "
23261 "need to create the output disk with the right format.  See L</QCOW2 AND "
23262 "NON-SPARSE RAW FORMATS>."
23263 msgstr ""
23264
23265 #. type: textblock
23266 #: ../resize/virt-resize.pod:495
23267 msgid "Don't print the summary."
23268 msgstr ""
23269
23270 #. type: =item
23271 #: ../resize/virt-resize.pod:497
23272 msgid "B<--resize part=size>"
23273 msgstr ""
23274
23275 #. type: textblock
23276 #: ../resize/virt-resize.pod:499
23277 msgid ""
23278 "Resize the named partition (expanding or shrinking it) so that it has the "
23279 "given size."
23280 msgstr ""
23281
23282 #. type: textblock
23283 #: ../resize/virt-resize.pod:502
23284 msgid ""
23285 "C<size> can be expressed as an absolute number followed by b/K/M/G to mean "
23286 "bytes, Kilobytes, Megabytes, or Gigabytes; or as a percentage of the current "
23287 "size; or as a relative number or percentage.  For example:"
23288 msgstr ""
23289
23290 #. type: verbatim
23291 #: ../resize/virt-resize.pod:508
23292 #, no-wrap
23293 msgid ""
23294 " --resize /dev/sda2=10G\n"
23295 "\n"
23296 msgstr ""
23297
23298 #. type: verbatim
23299 #: ../resize/virt-resize.pod:510
23300 #, no-wrap
23301 msgid ""
23302 " --resize /dev/sda4=90%\n"
23303 "\n"
23304 msgstr ""
23305
23306 #. type: verbatim
23307 #: ../resize/virt-resize.pod:512
23308 #, no-wrap
23309 msgid ""
23310 " --resize /dev/sda2=+1G\n"
23311 "\n"
23312 msgstr ""
23313
23314 #. type: verbatim
23315 #: ../resize/virt-resize.pod:514
23316 #, no-wrap
23317 msgid ""
23318 " --resize /dev/sda2=-200M\n"
23319 "\n"
23320 msgstr ""
23321
23322 #. type: verbatim
23323 #: ../resize/virt-resize.pod:516
23324 #, no-wrap
23325 msgid ""
23326 " --resize /dev/sda1=+128K\n"
23327 "\n"
23328 msgstr ""
23329
23330 #. type: verbatim
23331 #: ../resize/virt-resize.pod:518
23332 #, no-wrap
23333 msgid ""
23334 " --resize /dev/sda1=+10%\n"
23335 "\n"
23336 msgstr ""
23337
23338 #. type: verbatim
23339 #: ../resize/virt-resize.pod:520
23340 #, no-wrap
23341 msgid ""
23342 " --resize /dev/sda1=-10%\n"
23343 "\n"
23344 msgstr ""
23345
23346 #. type: textblock
23347 #: ../resize/virt-resize.pod:522
23348 msgid ""
23349 "You can increase the size of any partition.  Virt-resize will expand the "
23350 "direct content of the partition if it knows how (see I<--expand> below)."
23351 msgstr ""
23352
23353 #. type: textblock
23354 #: ../resize/virt-resize.pod:526
23355 msgid ""
23356 "You can only I<decrease> the size of partitions that contain filesystems or "
23357 "PVs which have already been shrunk.  Virt-resize will check this has been "
23358 "done before proceeding, or else will print an error (see also "
23359 "I<--resize-force>)."
23360 msgstr ""
23361
23362 #. type: =item
23363 #: ../resize/virt-resize.pod:533
23364 msgid "B<--resize-force part=size>"
23365 msgstr ""
23366
23367 #. type: textblock
23368 #: ../resize/virt-resize.pod:535
23369 msgid ""
23370 "This is the same as I<--resize> except that it will let you decrease the "
23371 "size of any partition.  Generally this means you will lose any data which "
23372 "was at the end of the partition you shrink, but you may not care about that "
23373 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
23374 "as a swap partition)."
23375 msgstr ""
23376
23377 #. type: textblock
23378 #: ../resize/virt-resize.pod:541
23379 msgid "See also the I<--ignore> option."
23380 msgstr ""
23381
23382 #. type: =item
23383 #: ../resize/virt-resize.pod:543
23384 msgid "B<--shrink part>"
23385 msgstr ""
23386
23387 #. type: textblock
23388 #: ../resize/virt-resize.pod:545
23389 msgid ""
23390 "Shrink the named partition until the overall disk image fits in the "
23391 "destination.  The named partition B<must> contain a filesystem or PV which "
23392 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
23393 "online tools).  Virt-resize will check this and give an error if it has not "
23394 "been done."
23395 msgstr ""
23396
23397 #. type: textblock
23398 #: ../resize/virt-resize.pod:551
23399 msgid ""
23400 "The amount by which the overall disk must be shrunk (after carrying out all "
23401 "other operations requested by the user) is called the \"deficit\".  For "
23402 "example, a straight copy (assume no other operations)  from a 5GB disk image "
23403 "to a 4GB disk image results in a 1GB deficit.  In this case, virt-resize "
23404 "would give an error unless the user specified a partition to shrink and that "
23405 "partition had more than a gigabyte of free space."
23406 msgstr ""
23407
23408 #. type: =head1
23409 #: ../resize/virt-resize.pod:569 ../sparsify/virt-sparsify.pod:177
23410 msgid "MACHINE READABLE OUTPUT"
23411 msgstr ""
23412
23413 #. type: textblock
23414 #: ../resize/virt-resize.pod:571
23415 msgid ""
23416 "The I<--machine-readable> option can be used to make the output more machine "
23417 "friendly, which is useful when calling virt-resize from other programs, GUIs "
23418 "etc."
23419 msgstr ""
23420
23421 #. type: textblock
23422 #: ../resize/virt-resize.pod:575 ../sparsify/virt-sparsify.pod:183
23423 msgid "There are two ways to use this option."
23424 msgstr ""
23425
23426 #. type: textblock
23427 #: ../resize/virt-resize.pod:577
23428 msgid ""
23429 "Firstly use the option on its own to query the capabilities of the "
23430 "virt-resize binary.  Typical output looks like this:"
23431 msgstr ""
23432
23433 #. type: verbatim
23434 #: ../resize/virt-resize.pod:580
23435 #, no-wrap
23436 msgid ""
23437 " $ virt-resize --machine-readable\n"
23438 " virt-resize\n"
23439 " ntfsresize-force\n"
23440 " 32bitok\n"
23441 " ntfs\n"
23442 " btrfs\n"
23443 "\n"
23444 msgstr ""
23445
23446 #. type: textblock
23447 #: ../resize/virt-resize.pod:587 ../sparsify/virt-sparsify.pod:193
23448 msgid ""
23449 "A list of features is printed, one per line, and the program exits with "
23450 "status 0."
23451 msgstr ""
23452
23453 #. type: textblock
23454 #: ../resize/virt-resize.pod:590 ../sparsify/virt-sparsify.pod:196
23455 msgid ""
23456 "Secondly use the option in conjunction with other options to make the "
23457 "regular program output more machine friendly."
23458 msgstr ""
23459
23460 #. type: textblock
23461 #: ../resize/virt-resize.pod:593 ../sparsify/virt-sparsify.pod:199
23462 msgid "At the moment this means:"
23463 msgstr ""
23464
23465 #. type: textblock
23466 #: ../resize/virt-resize.pod:599 ../sparsify/virt-sparsify.pod:205
23467 msgid ""
23468 "Progress bar messages can be parsed from stdout by looking for this regular "
23469 "expression:"
23470 msgstr ""
23471
23472 #. type: verbatim
23473 #: ../resize/virt-resize.pod:602 ../sparsify/virt-sparsify.pod:208
23474 #, no-wrap
23475 msgid ""
23476 " ^[0-9]+/[0-9]+$\n"
23477 "\n"
23478 msgstr ""
23479
23480 #. type: textblock
23481 #: ../resize/virt-resize.pod:606 ../sparsify/virt-sparsify.pod:212
23482 msgid ""
23483 "The calling program should treat messages sent to stdout (except for "
23484 "progress bar messages) as status messages.  They can be logged and/or "
23485 "displayed to the user."
23486 msgstr ""
23487
23488 #. type: textblock
23489 #: ../resize/virt-resize.pod:612
23490 msgid ""
23491 "The calling program should treat messages sent to stderr as error messages.  "
23492 "In addition, virt-resize exits with a non-zero status code if there was a "
23493 "fatal error."
23494 msgstr ""
23495
23496 #. type: textblock
23497 #: ../resize/virt-resize.pod:618
23498 msgid ""
23499 "Versions of the program prior to 1.13.9 did not support the "
23500 "I<--machine-readable> option and will return an error."
23501 msgstr ""
23502
23503 #. type: =head2
23504 #: ../resize/virt-resize.pod:623
23505 msgid "\"Partition 1 does not end on cylinder boundary.\""
23506 msgstr ""
23507
23508 #. type: textblock
23509 #: ../resize/virt-resize.pod:625
23510 msgid ""
23511 "Virt-resize aligns partitions to multiples of 128 sectors (see the "
23512 "I<--alignment> parameter).  Usually this means the partitions will not be "
23513 "aligned to the ancient CHS geometry.  However CHS geometry is meaningless "
23514 "for disks manufactured since the early 1990s, and doubly so for virtual hard "
23515 "drives.  Alignment of partitions to cylinders is not required by any modern "
23516 "operating system."
23517 msgstr ""
23518
23519 #. type: =head2
23520 #: ../resize/virt-resize.pod:632
23521 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
23522 msgstr ""
23523
23524 #. type: textblock
23525 #: ../resize/virt-resize.pod:634
23526 msgid ""
23527 "In Windows Vista and later versions, Microsoft switched to using a separate "
23528 "boot partition.  In these VMs, typically C</dev/sda1> is the boot partition "
23529 "and C</dev/sda2> is the main (C:) drive.  Resizing the first (boot) "
23530 "partition causes the bootloader to fail with C<0xC0000225> error.  Resizing "
23531 "the second partition (ie. C: drive)  should work."
23532 msgstr ""
23533
23534 #. type: textblock
23535 #: ../resize/virt-resize.pod:641
23536 msgid ""
23537 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
23538 "NTFS partitions have been expanded.  This is just a safety check and (unless "
23539 "it find errors) is nothing to worry about."
23540 msgstr ""
23541
23542 #. type: =head2
23543 #: ../resize/virt-resize.pod:645
23544 msgid "GUEST BOOT STUCK AT \"GRUB\""
23545 msgstr ""
23546
23547 #. type: textblock
23548 #: ../resize/virt-resize.pod:647
23549 msgid ""
23550 "If a Linux guest does not boot after resizing, and the boot is stuck after "
23551 "printing C<GRUB> on the console, try reinstalling grub."
23552 msgstr ""
23553
23554 #. type: verbatim
23555 #: ../resize/virt-resize.pod:650
23556 #, no-wrap
23557 msgid ""
23558 " guestfish -i -a newdisk\n"
23559 " ><fs> cat /boot/grub/device.map\n"
23560 " # check the contents of this file are sensible or\n"
23561 " # edit the file if necessary\n"
23562 " ><fs> grub-install / /dev/vda\n"
23563 " ><fs> exit\n"
23564 "\n"
23565 msgstr ""
23566
23567 #. type: textblock
23568 #: ../resize/virt-resize.pod:657
23569 msgid ""
23570 "For more flexible guest reconfiguration, including if you need to specify "
23571 "other parameters to grub-install, use L<virt-rescue(1)>."
23572 msgstr ""
23573
23574 #. type: =head1
23575 #: ../resize/virt-resize.pod:660
23576 msgid "ALTERNATIVE TOOLS"
23577 msgstr ""
23578
23579 #. type: textblock
23580 #: ../resize/virt-resize.pod:662
23581 msgid ""
23582 "There are several proprietary tools for resizing partitions.  We won't "
23583 "mention any here."
23584 msgstr ""
23585
23586 #. type: textblock
23587 #: ../resize/virt-resize.pod:665
23588 msgid ""
23589 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
23590 "operations on disk images.  They can resize and move partitions, but I don't "
23591 "think they can do anything with the contents, and they certainly don't "
23592 "understand LVM."
23593 msgstr ""
23594
23595 #. type: textblock
23596 #: ../resize/virt-resize.pod:670
23597 msgid ""
23598 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
23599 "but at a much lower level.  You will probably end up hand-calculating sector "
23600 "offsets, which is something that virt-resize was designed to avoid.  If you "
23601 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
23602 "I<--debug> flag."
23603 msgstr ""
23604
23605 #. type: textblock
23606 #: ../resize/virt-resize.pod:690
23607 msgid ""
23608 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
23609 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
23610 "L<ntfsresize(8)>, L<btrfs(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
23611 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
23612 "L<virt-sparsify(1)>, L<virt-alignment-scan(1)>, L<http://libguestfs.org/>."
23613 msgstr ""
23614
23615 #. type: textblock
23616 #: ../ruby/examples/guestfs-ruby.pod:5
23617 msgid "guestfs-ruby - How to use libguestfs from Ruby"
23618 msgstr ""
23619
23620 #. type: verbatim
23621 #: ../ruby/examples/guestfs-ruby.pod:9
23622 #, no-wrap
23623 msgid ""
23624 " require 'guestfs'\n"
23625 " g = Guestfs::Guestfs.new()\n"
23626 " g.add_drive_opts(\"disk.img\",\n"
23627 "                  :readonly => 1, :format => \"raw\")\n"
23628 " g.launch()\n"
23629 "\n"
23630 msgstr ""
23631
23632 #. type: textblock
23633 #: ../ruby/examples/guestfs-ruby.pod:17
23634 msgid ""
23635 "This manual page documents how to call libguestfs from the Ruby programming "
23636 "language.  This page just documents the differences from the C API and gives "
23637 "some examples.  If you are not familiar with using libguestfs, you also need "
23638 "to read L<guestfs(3)>."
23639 msgstr ""
23640
23641 #. type: textblock
23642 #: ../ruby/examples/guestfs-ruby.pod:24
23643 msgid ""
23644 "Errors from libguestfs functions are mapped into the C<Error> exception.  "
23645 "This has a single parameter which is the error message (a string)."
23646 msgstr ""
23647
23648 #. type: textblock
23649 #: ../ruby/examples/guestfs-ruby.pod:38
23650 msgid ""
23651 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, "
23652 "L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, "
23653 "L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<http://libguestfs.org/>."
23654 msgstr ""
23655
23656 #. type: textblock
23657 #: ../sparsify/virt-sparsify.pod:5
23658 msgid "virt-sparsify - Make a virtual machine disk sparse"
23659 msgstr ""
23660
23661 #. type: verbatim
23662 #: ../sparsify/virt-sparsify.pod:9
23663 #, no-wrap
23664 msgid ""
23665 " virt-sparsify [--options] indisk outdisk\n"
23666 "\n"
23667 msgstr ""
23668
23669 #. type: textblock
23670 #: ../sparsify/virt-sparsify.pod:13
23671 msgid ""
23672 "Virt-sparsify is a tool which can make a virtual machine disk (or any disk "
23673 "image) sparse a.k.a. thin-provisioned.  This means that free space within "
23674 "the disk image can be converted back to free space on the host."
23675 msgstr ""
23676
23677 #. type: textblock
23678 #: ../sparsify/virt-sparsify.pod:18
23679 msgid ""
23680 "Virt-sparsify can locate and sparsify free space in most filesystems "
23681 "(eg. ext2/3/4, btrfs, NTFS, etc.), and also in LVM physical volumes."
23682 msgstr ""
23683
23684 #. type: textblock
23685 #: ../sparsify/virt-sparsify.pod:21
23686 msgid ""
23687 "Virt-sparsify can also convert between some disk formats, for example "
23688 "converting a raw disk image to a thin-provisioned qcow2 image."
23689 msgstr ""
23690
23691 #. type: textblock
23692 #: ../sparsify/virt-sparsify.pod:24
23693 msgid ""
23694 "Virt-sparsify can operate on any disk image, not just ones from virtual "
23695 "machines.  If a virtual machine has more than one attached disk, you must "
23696 "sparsify each one separately."
23697 msgstr ""
23698
23699 #. type: =head2
23700 #: ../sparsify/virt-sparsify.pod:28
23701 msgid "IMPORTANT LIMITATIONS"
23702 msgstr ""
23703
23704 #. type: textblock
23705 #: ../sparsify/virt-sparsify.pod:34
23706 msgid ""
23707 "Virt-sparsify does not do in-place modifications.  It copies from a source "
23708 "image to a destination image, leaving the source unchanged.  I<Check that "
23709 "the sparsification was successful before deleting the source image>."
23710 msgstr ""
23711
23712 #. type: textblock
23713 #: ../sparsify/virt-sparsify.pod:41
23714 msgid "The virtual machine I<must be shut down> before using this tool."
23715 msgstr ""
23716
23717 #. type: textblock
23718 #: ../sparsify/virt-sparsify.pod:45
23719 msgid ""
23720 "Virt-sparsify may require up to 2x the virtual size of the source disk image "
23721 "(1 temporary copy + 1 destination image).  This is in the worst case and "
23722 "usually much less space is required."
23723 msgstr ""
23724
23725 #. type: textblock
23726 #: ../sparsify/virt-sparsify.pod:51
23727 msgid "Virt-sparsify cannot resize disk images.  To do that, use L<virt-resize(1)>."
23728 msgstr ""
23729
23730 #. type: textblock
23731 #: ../sparsify/virt-sparsify.pod:56
23732 msgid "Virt-sparsify cannot handle encrypted disks."
23733 msgstr ""
23734
23735 #. type: textblock
23736 #: ../sparsify/virt-sparsify.pod:60
23737 msgid ""
23738 "Virt-sparsify cannot yet sparsify the space between partitions.  Note that "
23739 "this space is often used for critical items like bootloaders so it's not "
23740 "really unused."
23741 msgstr ""
23742
23743 #. type: textblock
23744 #: ../sparsify/virt-sparsify.pod:66
23745 msgid ""
23746 "Virt-sparsify does not yet know how to sparsify swapspace.  It is not safe "
23747 "to do this unless we can be sure there is no hibernation data, so at the "
23748 "moment swap partitions are ignored."
23749 msgstr ""
23750
23751 #. type: textblock
23752 #: ../sparsify/virt-sparsify.pod:72
23753 msgid ""
23754 "You may also want to read the manual pages for the associated tools "
23755 "L<virt-filesystems(1)> and L<virt-df(1)> before starting."
23756 msgstr ""
23757
23758 #. type: textblock
23759 #: ../sparsify/virt-sparsify.pod:77
23760 msgid "Typical usage is:"
23761 msgstr ""
23762
23763 #. type: verbatim
23764 #: ../sparsify/virt-sparsify.pod:79
23765 #, no-wrap
23766 msgid ""
23767 " virt-sparsify indisk outdisk\n"
23768 "\n"
23769 msgstr ""
23770
23771 #. type: textblock
23772 #: ../sparsify/virt-sparsify.pod:81
23773 msgid ""
23774 "which copies C<indisk> to C<outdisk>, making the output sparse.  C<outdisk> "
23775 "is created, or overwritten if it already exists.  The format of the input "
23776 "disk is detected (eg. qcow2) and the same format is used for the output "
23777 "disk."
23778 msgstr ""
23779
23780 #. type: textblock
23781 #: ../sparsify/virt-sparsify.pod:86
23782 msgid "To convert between formats, use the I<--convert> option:"
23783 msgstr ""
23784
23785 #. type: verbatim
23786 #: ../sparsify/virt-sparsify.pod:88
23787 #, no-wrap
23788 msgid ""
23789 " virt-sparsify disk.raw --convert qcow2 disk.qcow2\n"
23790 "\n"
23791 msgstr ""
23792
23793 #. type: textblock
23794 #: ../sparsify/virt-sparsify.pod:90
23795 msgid ""
23796 "Virt-sparsify tries to zero and sparsify free space on every filesystem it "
23797 "can find within the source disk image.  You can get it to ignore (don't zero "
23798 "free space on) certain filesystems by doing:"
23799 msgstr ""
23800
23801 #. type: verbatim
23802 #: ../sparsify/virt-sparsify.pod:94
23803 #, no-wrap
23804 msgid ""
23805 " virt-sparsify --ignore /dev/sda1 indisk outdisk\n"
23806 "\n"
23807 msgstr ""
23808
23809 #. type: textblock
23810 #: ../sparsify/virt-sparsify.pod:96
23811 msgid "See L<virt-filesystems(1)> to get a list of filesystems within a disk image."
23812 msgstr ""
23813
23814 #. type: =item
23815 #: ../sparsify/virt-sparsify.pod:107
23816 msgid "B<--convert> raw"
23817 msgstr ""
23818
23819 #. type: =item
23820 #: ../sparsify/virt-sparsify.pod:109
23821 msgid "B<--convert> qcow2"
23822 msgstr ""
23823
23824 #. type: =item
23825 #: ../sparsify/virt-sparsify.pod:111
23826 msgid "B<--convert> [other formats]"
23827 msgstr ""
23828
23829 #. type: textblock
23830 #: ../sparsify/virt-sparsify.pod:113
23831 msgid ""
23832 "Use C<output-format> as the format for the destination image.  If this is "
23833 "not specified, then the input format is used."
23834 msgstr ""
23835
23836 #. type: textblock
23837 #: ../sparsify/virt-sparsify.pod:116
23838 msgid "Supported and known-working output formats are: C<raw>, C<qcow2>."
23839 msgstr ""
23840
23841 #. type: textblock
23842 #: ../sparsify/virt-sparsify.pod:118
23843 msgid ""
23844 "You can also use any format supported by the L<qemu-img(1)> program, "
23845 "eg. C<vdi> or C<vmdk>, but support for other formats is reliant on qemu."
23846 msgstr ""
23847
23848 #. type: textblock
23849 #: ../sparsify/virt-sparsify.pod:122
23850 msgid ""
23851 "Specifying the I<--convert> option is usually a good idea, because then "
23852 "virt-sparsify doesn't need to try to guess the input format."
23853 msgstr ""
23854
23855 #. type: =item
23856 #: ../sparsify/virt-sparsify.pod:127
23857 msgid "B<--format> qcow2"
23858 msgstr ""
23859
23860 #. type: =item
23861 #: ../sparsify/virt-sparsify.pod:135
23862 msgid "B<--ignore> filesystem"
23863 msgstr ""
23864
23865 #. type: =item
23866 #: ../sparsify/virt-sparsify.pod:137
23867 msgid "B<--ignore> volgroup"
23868 msgstr ""
23869
23870 #. type: textblock
23871 #: ../sparsify/virt-sparsify.pod:139
23872 msgid ""
23873 "Ignore the named filesystem.  Free space on the filesystem will not be "
23874 "zeroed, but existing blocks of zeroes will still be sparsified."
23875 msgstr ""
23876
23877 #. type: textblock
23878 #: ../sparsify/virt-sparsify.pod:142
23879 msgid ""
23880 "In the second form, this ignores the named volume group.  Use the volume "
23881 "group name without the C</dev/> prefix, eg. I<--ignore vg_foo>"
23882 msgstr ""
23883
23884 #. type: textblock
23885 #: ../sparsify/virt-sparsify.pod:157
23886 msgid "This disables progress bars and other unnecessary output."
23887 msgstr ""
23888
23889 #. type: textblock
23890 #: ../sparsify/virt-sparsify.pod:179
23891 msgid ""
23892 "The I<--machine-readable> option can be used to make the output more machine "
23893 "friendly, which is useful when calling virt-sparsify from other programs, "
23894 "GUIs etc."
23895 msgstr ""
23896
23897 #. type: textblock
23898 #: ../sparsify/virt-sparsify.pod:185
23899 msgid ""
23900 "Firstly use the option on its own to query the capabilities of the "
23901 "virt-sparsify binary.  Typical output looks like this:"
23902 msgstr ""
23903
23904 #. type: verbatim
23905 #: ../sparsify/virt-sparsify.pod:188
23906 #, no-wrap
23907 msgid ""
23908 " $ virt-sparsify --machine-readable\n"
23909 " virt-sparsify\n"
23910 " ntfs\n"
23911 " btrfs\n"
23912 "\n"
23913 msgstr ""
23914
23915 #. type: textblock
23916 #: ../sparsify/virt-sparsify.pod:218
23917 msgid ""
23918 "The calling program should treat messages sent to stderr as error messages.  "
23919 "In addition, virt-sparsify exits with a non-zero status code if there was a "
23920 "fatal error."
23921 msgstr ""
23922
23923 #. type: textblock
23924 #: ../sparsify/virt-sparsify.pod:224
23925 msgid ""
23926 "All versions of virt-sparsify have supported the I<--machine-readable> "
23927 "option."
23928 msgstr ""
23929
23930 #. type: textblock
23931 #: ../sparsify/virt-sparsify.pod:238
23932 msgid ""
23933 "Location of the temporary directory used for the potentially large temporary "
23934 "overlay file."
23935 msgstr ""
23936
23937 #. type: textblock
23938 #: ../sparsify/virt-sparsify.pod:241
23939 msgid ""
23940 "You should ensure there is enough free space in the worst case for a full "
23941 "copy of the source disk (I<virtual> size), or else set C<$TMPDIR> to point "
23942 "to another directory that has enough space."
23943 msgstr ""
23944
23945 #. type: textblock
23946 #: ../sparsify/virt-sparsify.pod:245
23947 msgid "This defaults to C</tmp>."
23948 msgstr ""
23949
23950 #. type: textblock
23951 #: ../sparsify/virt-sparsify.pod:249
23952 msgid "For other environment variables, see L<guestfs(3)/ENVIRONMENT VARIABLES>."
23953 msgstr ""
23954
23955 #. type: textblock
23956 #: ../sparsify/virt-sparsify.pod:253
23957 msgid ""
23958 "L<virt-filesystems(1)>, L<virt-df(1)>, L<virt-resize(1)>, L<virt-rescue(1)>, "
23959 "L<guestfs(3)>, L<guestfish(1)>, L<truncate(1)>, L<fallocate(1)>, "
23960 "L<qemu-img(1)>, L<http://libguestfs.org/>."
23961 msgstr ""
23962
23963 #. type: =head2
23964 #: ../src/guestfs-actions.pod:1
23965 msgid "guestfs_add_cdrom"
23966 msgstr ""
23967
23968 #. type: verbatim
23969 #: ../src/guestfs-actions.pod:3
23970 #, no-wrap
23971 msgid ""
23972 " int\n"
23973 " guestfs_add_cdrom (guestfs_h *g,\n"
23974 "                    const char *filename);\n"
23975 "\n"
23976 msgstr ""
23977
23978 #. type: textblock
23979 #: ../src/guestfs-actions.pod:7 ../src/guestfs-actions.pod:302 ../src/guestfs-actions.pod:323
23980 msgid ""
23981 "I<This function is deprecated.> In new code, use the "
23982 "L</guestfs_add_drive_opts> call instead."
23983 msgstr ""
23984
23985 #. type: textblock
23986 #: ../src/guestfs-actions.pod:24
23987 msgid ""
23988 "This call checks for the existence of C<filename>.  This stops you from "
23989 "specifying other types of drive which are supported by qemu such as C<nbd:> "
23990 "and C<http:> URLs.  To specify those, use the general C<guestfs_config> call "
23991 "instead."
23992 msgstr ""
23993
23994 #. type: textblock
23995 #: ../src/guestfs-actions.pod:31
23996 msgid ""
23997 "If you just want to add an ISO file (often you use this as an efficient way "
23998 "to transfer large files into the guest), then you should probably use "
23999 "C<guestfs_add_drive_ro> instead."
24000 msgstr ""
24001
24002 #. type: textblock
24003 #: ../src/guestfs-actions.pod:37 ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:254 ../src/guestfs-actions.pod:291 ../src/guestfs-actions.pod:312 ../src/guestfs-actions.pod:333 ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360 ../src/guestfs-actions.pod:480 ../src/guestfs-actions.pod:500 ../src/guestfs-actions.pod:514 ../src/guestfs-actions.pod:559 ../src/guestfs-actions.pod:587 ../src/guestfs-actions.pod:605 ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:705 ../src/guestfs-actions.pod:719 ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:833 ../src/guestfs-actions.pod:851 ../src/guestfs-actions.pod:865 ../src/guestfs-actions.pod:879 ../src/guestfs-actions.pod:916 ../src/guestfs-actions.pod:1099 ../src/guestfs-actions.pod:1119 ../src/guestfs-actions.pod:1137 ../src/guestfs-actions.pod:1227 ../src/guestfs-actions.pod:1286 ../src/guestfs-actions.pod:1332 ../src/guestfs-actions.pod:1372 ../src/guestfs-actions.pod:1425 ../src/guestfs-actions.pod:1478 ../src/guestfs-actions.pod:1536 ../src/guestfs-actions.pod:1590 ../src/guestfs-actions.pod:1609 ../src/guestfs-actions.pod:1623 ../src/guestfs-actions.pod:1651 ../src/guestfs-actions.pod:1721 ../src/guestfs-actions.pod:1752 ../src/guestfs-actions.pod:1777 ../src/guestfs-actions.pod:1819 ../src/guestfs-actions.pod:1932 ../src/guestfs-actions.pod:1959 ../src/guestfs-actions.pod:2174 ../src/guestfs-actions.pod:2196 ../src/guestfs-actions.pod:2283 ../src/guestfs-actions.pod:2791 ../src/guestfs-actions.pod:2935 ../src/guestfs-actions.pod:2996 ../src/guestfs-actions.pod:3031 ../src/guestfs-actions.pod:4088 ../src/guestfs-actions.pod:4103 ../src/guestfs-actions.pod:4128 ../src/guestfs-actions.pod:4317 ../src/guestfs-actions.pod:4331 ../src/guestfs-actions.pod:4344 ../src/guestfs-actions.pod:4358 ../src/guestfs-actions.pod:4373 ../src/guestfs-actions.pod:4409 ../src/guestfs-actions.pod:4481 ../src/guestfs-actions.pod:4501 ../src/guestfs-actions.pod:4518 ../src/guestfs-actions.pod:4538 ../src/guestfs-actions.pod:4558 ../src/guestfs-actions.pod:4593 ../src/guestfs-actions.pod:4612 ../src/guestfs-actions.pod:4631 ../src/guestfs-actions.pod:4666 ../src/guestfs-actions.pod:4678 ../src/guestfs-actions.pod:4711 ../src/guestfs-actions.pod:4727 ../src/guestfs-actions.pod:4740 ../src/guestfs-actions.pod:4755 ../src/guestfs-actions.pod:4772 ../src/guestfs-actions.pod:4865 ../src/guestfs-actions.pod:4885 ../src/guestfs-actions.pod:4898 ../src/guestfs-actions.pod:4949 ../src/guestfs-actions.pod:4967 ../src/guestfs-actions.pod:4985 ../src/guestfs-actions.pod:5001 ../src/guestfs-actions.pod:5015 ../src/guestfs-actions.pod:5029 ../src/guestfs-actions.pod:5046 ../src/guestfs-actions.pod:5061 ../src/guestfs-actions.pod:5088 ../src/guestfs-actions.pod:5151 ../src/guestfs-actions.pod:5224 ../src/guestfs-actions.pod:5255 ../src/guestfs-actions.pod:5274 ../src/guestfs-actions.pod:5293 ../src/guestfs-actions.pod:5305 ../src/guestfs-actions.pod:5322 ../src/guestfs-actions.pod:5335 ../src/guestfs-actions.pod:5350 ../src/guestfs-actions.pod:5365 ../src/guestfs-actions.pod:5397 ../src/guestfs-actions.pod:5423 ../src/guestfs-actions.pod:5462 ../src/guestfs-actions.pod:5482 ../src/guestfs-actions.pod:5496 ../src/guestfs-actions.pod:5513 ../src/guestfs-actions.pod:5562 ../src/guestfs-actions.pod:5615 ../src/guestfs-actions.pod:5662 ../src/guestfs-actions.pod:5705 ../src/guestfs-actions.pod:5733 ../src/guestfs-actions.pod:5750 ../src/guestfs-actions.pod:5768 ../src/guestfs-actions.pod:5905 ../src/guestfs-actions.pod:5962 ../src/guestfs-actions.pod:5984 ../src/guestfs-actions.pod:6002 ../src/guestfs-actions.pod:6054 ../src/guestfs-actions.pod:6120 ../src/guestfs-actions.pod:6137 ../src/guestfs-actions.pod:6150 ../src/guestfs-actions.pod:6164 ../src/guestfs-actions.pod:6453 ../src/guestfs-actions.pod:6472 ../src/guestfs-actions.pod:6491 ../src/guestfs-actions.pod:6505 ../src/guestfs-actions.pod:6517 ../src/guestfs-actions.pod:6531 ../src/guestfs-actions.pod:6543 ../src/guestfs-actions.pod:6557 ../src/guestfs-actions.pod:6573 ../src/guestfs-actions.pod:6591 ../src/guestfs-actions.pod:6610 ../src/guestfs-actions.pod:6629 ../src/guestfs-actions.pod:6659 ../src/guestfs-actions.pod:6677 ../src/guestfs-actions.pod:6700 ../src/guestfs-actions.pod:6718 ../src/guestfs-actions.pod:6737 ../src/guestfs-actions.pod:6758 ../src/guestfs-actions.pod:6777 ../src/guestfs-actions.pod:6794 ../src/guestfs-actions.pod:6813 ../src/guestfs-actions.pod:6841 ../src/guestfs-actions.pod:6865 ../src/guestfs-actions.pod:6884 ../src/guestfs-actions.pod:6900 ../src/guestfs-actions.pod:6924 ../src/guestfs-actions.pod:6943 ../src/guestfs-actions.pod:6958 ../src/guestfs-actions.pod:6977 ../src/guestfs-actions.pod:7021 ../src/guestfs-actions.pod:7048 ../src/guestfs-actions.pod:7078 ../src/guestfs-actions.pod:7190 ../src/guestfs-actions.pod:7311 ../src/guestfs-actions.pod:7323 ../src/guestfs-actions.pod:7336 ../src/guestfs-actions.pod:7349 ../src/guestfs-actions.pod:7371 ../src/guestfs-actions.pod:7384 ../src/guestfs-actions.pod:7397 ../src/guestfs-actions.pod:7410 ../src/guestfs-actions.pod:7425 ../src/guestfs-actions.pod:7484 ../src/guestfs-actions.pod:7501 ../src/guestfs-actions.pod:7517 ../src/guestfs-actions.pod:7533 ../src/guestfs-actions.pod:7550 ../src/guestfs-actions.pod:7563 ../src/guestfs-actions.pod:7583 ../src/guestfs-actions.pod:7619 ../src/guestfs-actions.pod:7633 ../src/guestfs-actions.pod:7674 ../src/guestfs-actions.pod:7687 ../src/guestfs-actions.pod:7705 ../src/guestfs-actions.pod:7739 ../src/guestfs-actions.pod:7775 ../src/guestfs-actions.pod:7891 ../src/guestfs-actions.pod:7906 ../src/guestfs-actions.pod:7920 ../src/guestfs-actions.pod:7975 ../src/guestfs-actions.pod:7988 ../src/guestfs-actions.pod:8033 ../src/guestfs-actions.pod:8073 ../src/guestfs-actions.pod:8129 ../src/guestfs-actions.pod:8149 ../src/guestfs-actions.pod:8182 ../src/guestfs-actions.pod:8246 ../src/guestfs-actions.pod:8269 ../src/guestfs-actions.pod:8295
24004 msgid "This function returns 0 on success or -1 on error."
24005 msgstr ""
24006
24007 #. type: textblock
24008 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:189 ../src/guestfs-actions.pod:1334 ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2495 ../src/guestfs-actions.pod:2620 ../src/guestfs-actions.pod:4090 ../src/guestfs-actions.pod:4110 ../src/guestfs-actions.pod:5399 ../src/guestfs-actions.pod:6679 ../src/guestfs-actions.pod:6796 ../src/guestfs-actions.pod:6945 ../src/guestfs-actions.pod:7427 ../src/guestfs-actions.pod:7552 ../src/guestfs-actions.pod:8075
24009 msgid "(Added in 0.3)"
24010 msgstr ""
24011
24012 #. type: =head2
24013 #: ../src/guestfs-actions.pod:41
24014 msgid "guestfs_add_domain"
24015 msgstr ""
24016
24017 #. type: verbatim
24018 #: ../src/guestfs-actions.pod:43
24019 #, no-wrap
24020 msgid ""
24021 " int\n"
24022 " guestfs_add_domain (guestfs_h *g,\n"
24023 "                     const char *dom,\n"
24024 "                     ...);\n"
24025 "\n"
24026 msgstr ""
24027
24028 #. type: textblock
24029 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:198 ../src/guestfs-actions.pod:890 ../src/guestfs-actions.pod:1214 ../src/guestfs-actions.pod:1266 ../src/guestfs-actions.pod:1344 ../src/guestfs-actions.pod:1413 ../src/guestfs-actions.pod:1466 ../src/guestfs-actions.pod:1519 ../src/guestfs-actions.pod:3288 ../src/guestfs-actions.pod:5100 ../src/guestfs-actions.pod:5409 ../src/guestfs-actions.pod:5626
24030 msgid ""
24031 "You may supply a list of optional arguments to this call.  Use zero or more "
24032 "of the following pairs of parameters, and terminate the list with C<-1> on "
24033 "its own.  See L</CALLS WITH OPTIONAL ARGUMENTS>."
24034 msgstr ""
24035
24036 #. type: verbatim
24037 #: ../src/guestfs-actions.pod:53
24038 #, no-wrap
24039 msgid ""
24040 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
24041 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
24042 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
24043 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
24044 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
24045 " GUESTFS_ADD_DOMAIN_READONLYDISK, const char *readonlydisk,\n"
24046 "\n"
24047 msgstr ""
24048
24049 #. type: textblock
24050 #: ../src/guestfs-actions.pod:60
24051 msgid ""
24052 "This function adds the disk(s) attached to the named libvirt domain C<dom>.  "
24053 "It works by connecting to libvirt, requesting the domain and domain XML from "
24054 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
24055 "one."
24056 msgstr ""
24057
24058 #. type: textblock
24059 #: ../src/guestfs-actions.pod:141
24060 msgid ""
24061 "The other optional parameters are passed directly through to "
24062 "C<guestfs_add_drive_opts>."
24063 msgstr ""
24064
24065 #. type: textblock
24066 #: ../src/guestfs-actions.pod:144 ../src/guestfs-actions.pod:403 ../src/guestfs-actions.pod:573 ../src/guestfs-actions.pod:751 ../src/guestfs-actions.pod:782 ../src/guestfs-actions.pod:800 ../src/guestfs-actions.pod:819 ../src/guestfs-actions.pod:1797 ../src/guestfs-actions.pod:2153 ../src/guestfs-actions.pod:2356 ../src/guestfs-actions.pod:2467 ../src/guestfs-actions.pod:2518 ../src/guestfs-actions.pod:2570 ../src/guestfs-actions.pod:2584 ../src/guestfs-actions.pod:2607 ../src/guestfs-actions.pod:2922 ../src/guestfs-actions.pod:3406 ../src/guestfs-actions.pod:3424 ../src/guestfs-actions.pod:5585 ../src/guestfs-actions.pod:5802 ../src/guestfs-actions.pod:6040 ../src/guestfs-actions.pod:6234 ../src/guestfs-actions.pod:6260 ../src/guestfs-actions.pod:7660 ../src/guestfs-actions.pod:8086 ../src/guestfs-actions.pod:8099 ../src/guestfs-actions.pod:8112
24067 msgid "On error this function returns -1."
24068 msgstr ""
24069
24070 #. type: textblock
24071 #: ../src/guestfs-actions.pod:146
24072 msgid "(Added in 1.7.4)"
24073 msgstr ""
24074
24075 #. type: =head2
24076 #: ../src/guestfs-actions.pod:148
24077 msgid "guestfs_add_domain_va"
24078 msgstr ""
24079
24080 #. type: verbatim
24081 #: ../src/guestfs-actions.pod:150
24082 #, no-wrap
24083 msgid ""
24084 " int\n"
24085 " guestfs_add_domain_va (guestfs_h *g,\n"
24086 "                        const char *dom,\n"
24087 "                        va_list args);\n"
24088 "\n"
24089 msgstr ""
24090
24091 #. type: textblock
24092 #: ../src/guestfs-actions.pod:155
24093 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
24094 msgstr ""
24095
24096 #. type: textblock
24097 #: ../src/guestfs-actions.pod:157 ../src/guestfs-actions.pod:168 ../src/guestfs-actions.pod:267 ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:929 ../src/guestfs-actions.pod:940 ../src/guestfs-actions.pod:1242 ../src/guestfs-actions.pod:1255 ../src/guestfs-actions.pod:1301 ../src/guestfs-actions.pod:1314 ../src/guestfs-actions.pod:1391 ../src/guestfs-actions.pod:1403 ../src/guestfs-actions.pod:1444 ../src/guestfs-actions.pod:1456 ../src/guestfs-actions.pod:1497 ../src/guestfs-actions.pod:1509 ../src/guestfs-actions.pod:1555 ../src/guestfs-actions.pod:1567 ../src/guestfs-actions.pod:3372 ../src/guestfs-actions.pod:3384 ../src/guestfs-actions.pod:5165 ../src/guestfs-actions.pod:5177 ../src/guestfs-actions.pod:5437 ../src/guestfs-actions.pod:5449 ../src/guestfs-actions.pod:5675 ../src/guestfs-actions.pod:5686
24098 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
24099 msgstr ""
24100
24101 #. type: =head2
24102 #: ../src/guestfs-actions.pod:159
24103 msgid "guestfs_add_domain_argv"
24104 msgstr ""
24105
24106 #. type: verbatim
24107 #: ../src/guestfs-actions.pod:161
24108 #, no-wrap
24109 msgid ""
24110 " int\n"
24111 " guestfs_add_domain_argv (guestfs_h *g,\n"
24112 "                          const char *dom,\n"
24113 "                          const struct guestfs_add_domain_argv *optargs);\n"
24114 "\n"
24115 msgstr ""
24116
24117 #. type: textblock
24118 #: ../src/guestfs-actions.pod:166
24119 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
24120 msgstr ""
24121
24122 #. type: =head2
24123 #: ../src/guestfs-actions.pod:170
24124 msgid "guestfs_add_drive"
24125 msgstr ""
24126
24127 #. type: verbatim
24128 #: ../src/guestfs-actions.pod:172
24129 #, no-wrap
24130 msgid ""
24131 " int\n"
24132 " guestfs_add_drive (guestfs_h *g,\n"
24133 "                    const char *filename);\n"
24134 "\n"
24135 msgstr ""
24136
24137 #. type: textblock
24138 #: ../src/guestfs-actions.pod:176
24139 msgid ""
24140 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
24141 "optional parameters, so the disk is added writable, with the format being "
24142 "detected automatically."
24143 msgstr ""
24144
24145 #. type: textblock
24146 #: ../src/guestfs-actions.pod:180
24147 msgid ""
24148 "Automatic detection of the format opens you up to a potential security hole "
24149 "when dealing with untrusted raw-format images.  See CVE-2010-3851 and "
24150 "RHBZ#642934.  Specifying the format closes this security hole.  Therefore "
24151 "you should think about replacing calls to this function with calls to "
24152 "C<guestfs_add_drive_opts>, and specifying the format."
24153 msgstr ""
24154
24155 #. type: =head2
24156 #: ../src/guestfs-actions.pod:191
24157 msgid "guestfs_add_drive_opts"
24158 msgstr ""
24159
24160 #. type: verbatim
24161 #: ../src/guestfs-actions.pod:193
24162 #, no-wrap
24163 msgid ""
24164 " int\n"
24165 " guestfs_add_drive_opts (guestfs_h *g,\n"
24166 "                         const char *filename,\n"
24167 "                         ...);\n"
24168 "\n"
24169 msgstr ""
24170
24171 #. type: verbatim
24172 #: ../src/guestfs-actions.pod:203
24173 #, no-wrap
24174 msgid ""
24175 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
24176 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
24177 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
24178 " GUESTFS_ADD_DRIVE_OPTS_NAME, const char *name,\n"
24179 "\n"
24180 msgstr ""
24181
24182 #. type: textblock
24183 #: ../src/guestfs-actions.pod:233
24184 msgid ""
24185 "This forces the image format.  If you omit this (or use C<guestfs_add_drive> "
24186 "or C<guestfs_add_drive_ro>) then the format is automatically detected.  "
24187 "Possible formats include C<raw> and C<qcow2>."
24188 msgstr ""
24189
24190 #. type: textblock
24191 #: ../src/guestfs-actions.pod:244
24192 msgid ""
24193 "This rarely-used option lets you emulate the behaviour of the deprecated "
24194 "C<guestfs_add_drive_with_if> call (q.v.)"
24195 msgstr ""
24196
24197 #. type: textblock
24198 #: ../src/guestfs-actions.pod:256
24199 msgid "(Added in 1.5.23)"
24200 msgstr ""
24201
24202 #. type: =head2
24203 #: ../src/guestfs-actions.pod:258
24204 msgid "guestfs_add_drive_opts_va"
24205 msgstr ""
24206
24207 #. type: verbatim
24208 #: ../src/guestfs-actions.pod:260
24209 #, no-wrap
24210 msgid ""
24211 " int\n"
24212 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
24213 "                            const char *filename,\n"
24214 "                            va_list args);\n"
24215 "\n"
24216 msgstr ""
24217
24218 #. type: textblock
24219 #: ../src/guestfs-actions.pod:265
24220 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
24221 msgstr ""
24222
24223 #. type: =head2
24224 #: ../src/guestfs-actions.pod:269
24225 msgid "guestfs_add_drive_opts_argv"
24226 msgstr ""
24227
24228 #. type: verbatim
24229 #: ../src/guestfs-actions.pod:271
24230 #, no-wrap
24231 msgid ""
24232 " int\n"
24233 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
24234 "                              const char *filename,\n"
24235 "                              const struct guestfs_add_drive_opts_argv "
24236 "*optargs);\n"
24237 "\n"
24238 msgstr ""
24239
24240 #. type: textblock
24241 #: ../src/guestfs-actions.pod:276
24242 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
24243 msgstr ""
24244
24245 #. type: =head2
24246 #: ../src/guestfs-actions.pod:280
24247 msgid "guestfs_add_drive_ro"
24248 msgstr ""
24249
24250 #. type: verbatim
24251 #: ../src/guestfs-actions.pod:282
24252 #, no-wrap
24253 msgid ""
24254 " int\n"
24255 " guestfs_add_drive_ro (guestfs_h *g,\n"
24256 "                       const char *filename);\n"
24257 "\n"
24258 msgstr ""
24259
24260 #. type: textblock
24261 #: ../src/guestfs-actions.pod:286
24262 msgid ""
24263 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
24264 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
24265 "disk is added read-only, with the format being detected automatically."
24266 msgstr ""
24267
24268 #. type: textblock
24269 #: ../src/guestfs-actions.pod:293
24270 msgid "(Added in 1.0.38)"
24271 msgstr ""
24272
24273 #. type: =head2
24274 #: ../src/guestfs-actions.pod:295
24275 msgid "guestfs_add_drive_ro_with_if"
24276 msgstr ""
24277
24278 #. type: verbatim
24279 #: ../src/guestfs-actions.pod:297
24280 #, no-wrap
24281 msgid ""
24282 " int\n"
24283 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
24284 "                               const char *filename,\n"
24285 "                               const char *iface);\n"
24286 "\n"
24287 msgstr ""
24288
24289 #. type: textblock
24290 #: ../src/guestfs-actions.pod:309
24291 msgid ""
24292 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
24293 "QEMU interface emulation to use at run time."
24294 msgstr ""
24295
24296 #. type: textblock
24297 #: ../src/guestfs-actions.pod:314 ../src/guestfs-actions.pod:335 ../src/guestfs-actions.pod:2881
24298 msgid "(Added in 1.0.84)"
24299 msgstr ""
24300
24301 #. type: =head2
24302 #: ../src/guestfs-actions.pod:316
24303 msgid "guestfs_add_drive_with_if"
24304 msgstr ""
24305
24306 #. type: verbatim
24307 #: ../src/guestfs-actions.pod:318
24308 #, no-wrap
24309 msgid ""
24310 " int\n"
24311 " guestfs_add_drive_with_if (guestfs_h *g,\n"
24312 "                            const char *filename,\n"
24313 "                            const char *iface);\n"
24314 "\n"
24315 msgstr ""
24316
24317 #. type: textblock
24318 #: ../src/guestfs-actions.pod:330
24319 msgid ""
24320 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
24321 "QEMU interface emulation to use at run time."
24322 msgstr ""
24323
24324 #. type: =head2
24325 #: ../src/guestfs-actions.pod:337
24326 msgid "guestfs_aug_clear"
24327 msgstr ""
24328
24329 #. type: verbatim
24330 #: ../src/guestfs-actions.pod:339
24331 #, no-wrap
24332 msgid ""
24333 " int\n"
24334 " guestfs_aug_clear (guestfs_h *g,\n"
24335 "                    const char *augpath);\n"
24336 "\n"
24337 msgstr ""
24338
24339 #. type: textblock
24340 #: ../src/guestfs-actions.pod:348 ../src/guestfs-actions.pod:2609
24341 msgid "(Added in 1.3.4)"
24342 msgstr ""
24343
24344 #. type: =head2
24345 #: ../src/guestfs-actions.pod:350
24346 msgid "guestfs_aug_close"
24347 msgstr ""
24348
24349 #. type: verbatim
24350 #: ../src/guestfs-actions.pod:352
24351 #, no-wrap
24352 msgid ""
24353 " int\n"
24354 " guestfs_aug_close (guestfs_h *g);\n"
24355 "\n"
24356 msgstr ""
24357
24358 #. type: textblock
24359 #: ../src/guestfs-actions.pod:355
24360 msgid ""
24361 "Close the current Augeas handle and free up any resources used by it.  After "
24362 "calling this, you have to call C<guestfs_aug_init> again before you can use "
24363 "any other Augeas functions."
24364 msgstr ""
24365
24366 #. type: textblock
24367 #: ../src/guestfs-actions.pod:362 ../src/guestfs-actions.pod:387 ../src/guestfs-actions.pod:405 ../src/guestfs-actions.pod:419 ../src/guestfs-actions.pod:482 ../src/guestfs-actions.pod:502 ../src/guestfs-actions.pod:516 ../src/guestfs-actions.pod:547 ../src/guestfs-actions.pod:561 ../src/guestfs-actions.pod:575 ../src/guestfs-actions.pod:589 ../src/guestfs-actions.pod:607 ../src/guestfs-actions.pod:6311
24368 msgid "(Added in 0.7)"
24369 msgstr ""
24370
24371 #. type: =head2
24372 #: ../src/guestfs-actions.pod:364
24373 msgid "guestfs_aug_defnode"
24374 msgstr ""
24375
24376 #. type: verbatim
24377 #: ../src/guestfs-actions.pod:366
24378 #, no-wrap
24379 msgid ""
24380 " struct guestfs_int_bool *\n"
24381 " guestfs_aug_defnode (guestfs_h *g,\n"
24382 "                      const char *name,\n"
24383 "                      const char *expr,\n"
24384 "                      const char *val);\n"
24385 "\n"
24386 msgstr ""
24387
24388 #. type: textblock
24389 #: ../src/guestfs-actions.pod:375
24390 msgid ""
24391 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
24392 "calling C<guestfs_aug_set> C<expr>, C<value>.  C<name> will be the nodeset "
24393 "containing that single node."
24394 msgstr ""
24395
24396 #. type: textblock
24397 #: ../src/guestfs-actions.pod:383
24398 msgid ""
24399 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
24400 "an error.  I<The caller must call C<guestfs_free_int_bool> after use>."
24401 msgstr ""
24402
24403 #. type: =head2
24404 #: ../src/guestfs-actions.pod:389
24405 msgid "guestfs_aug_defvar"
24406 msgstr ""
24407
24408 #. type: verbatim
24409 #: ../src/guestfs-actions.pod:391
24410 #, no-wrap
24411 msgid ""
24412 " int\n"
24413 " guestfs_aug_defvar (guestfs_h *g,\n"
24414 "                     const char *name,\n"
24415 "                     const char *expr);\n"
24416 "\n"
24417 msgstr ""
24418
24419 #. type: =head2
24420 #: ../src/guestfs-actions.pod:407
24421 msgid "guestfs_aug_get"
24422 msgstr ""
24423
24424 #. type: verbatim
24425 #: ../src/guestfs-actions.pod:409
24426 #, no-wrap
24427 msgid ""
24428 " char *\n"
24429 " guestfs_aug_get (guestfs_h *g,\n"
24430 "                  const char *augpath);\n"
24431 "\n"
24432 msgstr ""
24433
24434 #. type: textblock
24435 #: ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:980 ../src/guestfs-actions.pod:998 ../src/guestfs-actions.pod:1058 ../src/guestfs-actions.pod:1074 ../src/guestfs-actions.pod:1177 ../src/guestfs-actions.pod:1666 ../src/guestfs-actions.pod:1683 ../src/guestfs-actions.pod:1702 ../src/guestfs-actions.pod:1836 ../src/guestfs-actions.pod:2024 ../src/guestfs-actions.pod:2136 ../src/guestfs-actions.pod:2299 ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2383 ../src/guestfs-actions.pod:2426 ../src/guestfs-actions.pod:2447 ../src/guestfs-actions.pod:2632 ../src/guestfs-actions.pod:2846 ../src/guestfs-actions.pod:3050 ../src/guestfs-actions.pod:3152 ../src/guestfs-actions.pod:3256 ../src/guestfs-actions.pod:3275 ../src/guestfs-actions.pod:3490 ../src/guestfs-actions.pod:3518 ../src/guestfs-actions.pod:3539 ../src/guestfs-actions.pod:3573 ../src/guestfs-actions.pod:3636 ../src/guestfs-actions.pod:3656 ../src/guestfs-actions.pod:3676 ../src/guestfs-actions.pod:4303 ../src/guestfs-actions.pod:4650 ../src/guestfs-actions.pod:4817 ../src/guestfs-actions.pod:4927 ../src/guestfs-actions.pod:5820 ../src/guestfs-actions.pod:6021 ../src/guestfs-actions.pod:6209 ../src/guestfs-actions.pod:6387 ../src/guestfs-actions.pod:6436 ../src/guestfs-actions.pod:7096 ../src/guestfs-actions.pod:7112 ../src/guestfs-actions.pod:7136 ../src/guestfs-actions.pod:7160 ../src/guestfs-actions.pod:7834 ../src/guestfs-actions.pod:7853 ../src/guestfs-actions.pod:7871 ../src/guestfs-actions.pod:8045 ../src/guestfs-actions.pod:8359
24436 msgid ""
24437 "This function returns a string, or NULL on error.  I<The caller must free "
24438 "the returned string after use>."
24439 msgstr ""
24440
24441 #. type: =head2
24442 #: ../src/guestfs-actions.pod:421
24443 msgid "guestfs_aug_init"
24444 msgstr ""
24445
24446 #. type: verbatim
24447 #: ../src/guestfs-actions.pod:423
24448 #, no-wrap
24449 msgid ""
24450 " int\n"
24451 " guestfs_aug_init (guestfs_h *g,\n"
24452 "                   const char *root,\n"
24453 "                   int flags);\n"
24454 "\n"
24455 msgstr ""
24456
24457 #. type: textblock
24458 #: ../src/guestfs-actions.pod:432
24459 msgid "You must call this before using any other C<guestfs_aug_*> commands."
24460 msgstr ""
24461
24462 #. type: textblock
24463 #: ../src/guestfs-actions.pod:457
24464 msgid ""
24465 "This option is only useful when debugging Augeas lenses.  Use of this option "
24466 "may require additional memory for the libguestfs appliance.  You may need to "
24467 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call "
24468 "C<guestfs_set_memsize>."
24469 msgstr ""
24470
24471 #. type: textblock
24472 #: ../src/guestfs-actions.pod:472
24473 msgid "Do not load the tree in C<guestfs_aug_init>."
24474 msgstr ""
24475
24476 #. type: textblock
24477 #: ../src/guestfs-actions.pod:476
24478 msgid "To close the handle, you can call C<guestfs_aug_close>."
24479 msgstr ""
24480
24481 #. type: =head2
24482 #: ../src/guestfs-actions.pod:484
24483 msgid "guestfs_aug_insert"
24484 msgstr ""
24485
24486 #. type: verbatim
24487 #: ../src/guestfs-actions.pod:486
24488 #, no-wrap
24489 msgid ""
24490 " int\n"
24491 " guestfs_aug_insert (guestfs_h *g,\n"
24492 "                     const char *augpath,\n"
24493 "                     const char *label,\n"
24494 "                     int before);\n"
24495 "\n"
24496 msgstr ""
24497
24498 #. type: =head2
24499 #: ../src/guestfs-actions.pod:504
24500 msgid "guestfs_aug_load"
24501 msgstr ""
24502
24503 #. type: verbatim
24504 #: ../src/guestfs-actions.pod:506
24505 #, no-wrap
24506 msgid ""
24507 " int\n"
24508 " guestfs_aug_load (guestfs_h *g);\n"
24509 "\n"
24510 msgstr ""
24511
24512 #. type: =head2
24513 #: ../src/guestfs-actions.pod:518
24514 msgid "guestfs_aug_ls"
24515 msgstr ""
24516
24517 #. type: verbatim
24518 #: ../src/guestfs-actions.pod:520
24519 #, no-wrap
24520 msgid ""
24521 " char **\n"
24522 " guestfs_aug_ls (guestfs_h *g,\n"
24523 "                 const char *augpath);\n"
24524 "\n"
24525 msgstr ""
24526
24527 #. type: textblock
24528 #: ../src/guestfs-actions.pod:524
24529 msgid ""
24530 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
24531 "sorting the resulting nodes into alphabetical order."
24532 msgstr ""
24533
24534 #. type: textblock
24535 #: ../src/guestfs-actions.pod:527 ../src/guestfs-actions.pod:543 ../src/guestfs-actions.pod:689 ../src/guestfs-actions.pod:1196 ../src/guestfs-actions.pod:1851 ../src/guestfs-actions.pod:1870 ../src/guestfs-actions.pod:1973 ../src/guestfs-actions.pod:1992 ../src/guestfs-actions.pod:2238 ../src/guestfs-actions.pod:2704 ../src/guestfs-actions.pod:2720 ../src/guestfs-actions.pod:2739 ../src/guestfs-actions.pod:2804 ../src/guestfs-actions.pod:2828 ../src/guestfs-actions.pod:2899 ../src/guestfs-actions.pod:2948 ../src/guestfs-actions.pod:3217 ../src/guestfs-actions.pod:3592 ../src/guestfs-actions.pod:3872 ../src/guestfs-actions.pod:4186 ../src/guestfs-actions.pod:4203 ../src/guestfs-actions.pod:4223 ../src/guestfs-actions.pod:4285 ../src/guestfs-actions.pod:4390 ../src/guestfs-actions.pod:4789 ../src/guestfs-actions.pod:5546 ../src/guestfs-actions.pod:6181 ../src/guestfs-actions.pod:6307 ../src/guestfs-actions.pod:6421 ../src/guestfs-actions.pod:7176 ../src/guestfs-actions.pod:7237 ../src/guestfs-actions.pod:7292 ../src/guestfs-actions.pod:7438 ../src/guestfs-actions.pod:7462 ../src/guestfs-actions.pod:7938 ../src/guestfs-actions.pod:7958 ../src/guestfs-actions.pod:8005 ../src/guestfs-actions.pod:8199 ../src/guestfs-actions.pod:8218 ../src/guestfs-actions.pod:8309 ../src/guestfs-actions.pod:8328 ../src/guestfs-actions.pod:8374 ../src/guestfs-actions.pod:8393
24536 msgid ""
24537 "This function returns a NULL-terminated array of strings (like "
24538 "L<environ(3)>), or NULL if there was an error.  I<The caller must free the "
24539 "strings and the array after use>."
24540 msgstr ""
24541
24542 #. type: textblock
24543 #: ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:1121 ../src/guestfs-actions.pod:1139 ../src/guestfs-actions.pod:1908 ../src/guestfs-actions.pod:3950 ../src/guestfs-actions.pod:3981 ../src/guestfs-actions.pod:4633 ../src/guestfs-actions.pod:4680 ../src/guestfs-actions.pod:4867 ../src/guestfs-actions.pod:4900 ../src/guestfs-actions.pod:5063 ../src/guestfs-actions.pod:5550 ../src/guestfs-actions.pod:6122 ../src/guestfs-actions.pod:6519 ../src/guestfs-actions.pod:6533 ../src/guestfs-actions.pod:6545 ../src/guestfs-actions.pod:7023 ../src/guestfs-actions.pod:7676 ../src/guestfs-actions.pod:7689 ../src/guestfs-actions.pod:7922 ../src/guestfs-actions.pod:8187
24544 msgid "(Added in 0.8)"
24545 msgstr ""
24546
24547 #. type: =head2
24548 #: ../src/guestfs-actions.pod:533
24549 msgid "guestfs_aug_match"
24550 msgstr ""
24551
24552 #. type: verbatim
24553 #: ../src/guestfs-actions.pod:535
24554 #, no-wrap
24555 msgid ""
24556 " char **\n"
24557 " guestfs_aug_match (guestfs_h *g,\n"
24558 "                    const char *augpath);\n"
24559 "\n"
24560 msgstr ""
24561
24562 #. type: =head2
24563 #: ../src/guestfs-actions.pod:549
24564 msgid "guestfs_aug_mv"
24565 msgstr ""
24566
24567 #. type: verbatim
24568 #: ../src/guestfs-actions.pod:551
24569 #, no-wrap
24570 msgid ""
24571 " int\n"
24572 " guestfs_aug_mv (guestfs_h *g,\n"
24573 "                 const char *src,\n"
24574 "                 const char *dest);\n"
24575 "\n"
24576 msgstr ""
24577
24578 #. type: =head2
24579 #: ../src/guestfs-actions.pod:563
24580 msgid "guestfs_aug_rm"
24581 msgstr ""
24582
24583 #. type: verbatim
24584 #: ../src/guestfs-actions.pod:565
24585 #, no-wrap
24586 msgid ""
24587 " int\n"
24588 " guestfs_aug_rm (guestfs_h *g,\n"
24589 "                 const char *augpath);\n"
24590 "\n"
24591 msgstr ""
24592
24593 #. type: =head2
24594 #: ../src/guestfs-actions.pod:577
24595 msgid "guestfs_aug_save"
24596 msgstr ""
24597
24598 #. type: verbatim
24599 #: ../src/guestfs-actions.pod:579
24600 #, no-wrap
24601 msgid ""
24602 " int\n"
24603 " guestfs_aug_save (guestfs_h *g);\n"
24604 "\n"
24605 msgstr ""
24606
24607 #. type: textblock
24608 #: ../src/guestfs-actions.pod:584
24609 msgid ""
24610 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
24611 "are saved."
24612 msgstr ""
24613
24614 #. type: =head2
24615 #: ../src/guestfs-actions.pod:591
24616 msgid "guestfs_aug_set"
24617 msgstr ""
24618
24619 #. type: verbatim
24620 #: ../src/guestfs-actions.pod:593
24621 #, no-wrap
24622 msgid ""
24623 " int\n"
24624 " guestfs_aug_set (guestfs_h *g,\n"
24625 "                  const char *augpath,\n"
24626 "                  const char *val);\n"
24627 "\n"
24628 msgstr ""
24629
24630 #. type: textblock
24631 #: ../src/guestfs-actions.pod:600
24632 msgid ""
24633 "In the Augeas API, it is possible to clear a node by setting the value to "
24634 "NULL.  Due to an oversight in the libguestfs API you cannot do that with "
24635 "this call.  Instead you must use the C<guestfs_aug_clear> call."
24636 msgstr ""
24637
24638 #. type: =head2
24639 #: ../src/guestfs-actions.pod:609
24640 msgid "guestfs_available"
24641 msgstr ""
24642
24643 #. type: verbatim
24644 #: ../src/guestfs-actions.pod:611
24645 #, no-wrap
24646 msgid ""
24647 " int\n"
24648 " guestfs_available (guestfs_h *g,\n"
24649 "                    char *const *groups);\n"
24650 "\n"
24651 msgstr ""
24652
24653 #. type: textblock
24654 #: ../src/guestfs-actions.pod:619
24655 msgid ""
24656 "The libguestfs groups, and the functions that those groups correspond to, "
24657 "are listed in L<guestfs(3)/AVAILABILITY>.  You can also fetch this list at "
24658 "runtime by calling C<guestfs_available_all_groups>."
24659 msgstr ""
24660
24661 #. type: textblock
24662 #: ../src/guestfs-actions.pod:643
24663 msgid "You must call C<guestfs_launch> before calling this function."
24664 msgstr ""
24665
24666 #. type: textblock
24667 #: ../src/guestfs-actions.pod:665
24668 msgid ""
24669 "This call was added in version C<1.0.80>.  In previous versions of "
24670 "libguestfs all you could do would be to speculatively execute a command to "
24671 "find out if the daemon implemented it.  See also C<guestfs_version>."
24672 msgstr ""
24673
24674 #. type: textblock
24675 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:1653
24676 msgid "(Added in 1.0.80)"
24677 msgstr ""
24678
24679 #. type: =head2
24680 #: ../src/guestfs-actions.pod:676
24681 msgid "guestfs_available_all_groups"
24682 msgstr ""
24683
24684 #. type: verbatim
24685 #: ../src/guestfs-actions.pod:678
24686 #, no-wrap
24687 msgid ""
24688 " char **\n"
24689 " guestfs_available_all_groups (guestfs_h *g);\n"
24690 "\n"
24691 msgstr ""
24692
24693 #. type: textblock
24694 #: ../src/guestfs-actions.pod:681
24695 msgid ""
24696 "This command returns a list of all optional groups that this daemon knows "
24697 "about.  Note this returns both supported and unsupported groups.  To find "
24698 "out which ones the daemon can actually support you have to call "
24699 "C<guestfs_available> on each member of the returned list."
24700 msgstr ""
24701
24702 #. type: textblock
24703 #: ../src/guestfs-actions.pod:687
24704 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
24705 msgstr ""
24706
24707 #. type: textblock
24708 #: ../src/guestfs-actions.pod:693
24709 msgid "(Added in 1.3.15)"
24710 msgstr ""
24711
24712 #. type: =head2
24713 #: ../src/guestfs-actions.pod:695
24714 msgid "guestfs_base64_in"
24715 msgstr ""
24716
24717 #. type: verbatim
24718 #: ../src/guestfs-actions.pod:697
24719 #, no-wrap
24720 msgid ""
24721 " int\n"
24722 " guestfs_base64_in (guestfs_h *g,\n"
24723 "                    const char *base64file,\n"
24724 "                    const char *filename);\n"
24725 "\n"
24726 msgstr ""
24727
24728 #. type: textblock
24729 #: ../src/guestfs-actions.pod:707 ../src/guestfs-actions.pod:721
24730 msgid "(Added in 1.3.5)"
24731 msgstr ""
24732
24733 #. type: =head2
24734 #: ../src/guestfs-actions.pod:709
24735 msgid "guestfs_base64_out"
24736 msgstr ""
24737
24738 #. type: verbatim
24739 #: ../src/guestfs-actions.pod:711
24740 #, no-wrap
24741 msgid ""
24742 " int\n"
24743 " guestfs_base64_out (guestfs_h *g,\n"
24744 "                     const char *filename,\n"
24745 "                     const char *base64file);\n"
24746 "\n"
24747 msgstr ""
24748
24749 #. type: =head2
24750 #: ../src/guestfs-actions.pod:723
24751 msgid "guestfs_blockdev_flushbufs"
24752 msgstr ""
24753
24754 #. type: verbatim
24755 #: ../src/guestfs-actions.pod:725
24756 #, no-wrap
24757 msgid ""
24758 " int\n"
24759 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
24760 "                             const char *device);\n"
24761 "\n"
24762 msgstr ""
24763
24764 #. type: textblock
24765 #: ../src/guestfs-actions.pod:736 ../src/guestfs-actions.pod:753 ../src/guestfs-actions.pod:768 ../src/guestfs-actions.pod:784 ../src/guestfs-actions.pod:802 ../src/guestfs-actions.pod:821 ../src/guestfs-actions.pod:835 ../src/guestfs-actions.pod:853 ../src/guestfs-actions.pod:867 ../src/guestfs-actions.pod:881
24766 msgid "(Added in 0.9.3)"
24767 msgstr ""
24768
24769 #. type: =head2
24770 #: ../src/guestfs-actions.pod:738
24771 msgid "guestfs_blockdev_getbsz"
24772 msgstr ""
24773
24774 #. type: verbatim
24775 #: ../src/guestfs-actions.pod:740
24776 #, no-wrap
24777 msgid ""
24778 " int\n"
24779 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
24780 "                          const char *device);\n"
24781 "\n"
24782 msgstr ""
24783
24784 #. type: =head2
24785 #: ../src/guestfs-actions.pod:755
24786 msgid "guestfs_blockdev_getro"
24787 msgstr ""
24788
24789 #. type: verbatim
24790 #: ../src/guestfs-actions.pod:757
24791 #, no-wrap
24792 msgid ""
24793 " int\n"
24794 " guestfs_blockdev_getro (guestfs_h *g,\n"
24795 "                         const char *device);\n"
24796 "\n"
24797 msgstr ""
24798
24799 #. type: textblock
24800 #: ../src/guestfs-actions.pod:766 ../src/guestfs-actions.pod:1891 ../src/guestfs-actions.pod:1906 ../src/guestfs-actions.pod:2395 ../src/guestfs-actions.pod:2406 ../src/guestfs-actions.pod:2478 ../src/guestfs-actions.pod:2504 ../src/guestfs-actions.pod:2544 ../src/guestfs-actions.pod:2559 ../src/guestfs-actions.pod:2595 ../src/guestfs-actions.pod:2618 ../src/guestfs-actions.pod:3693 ../src/guestfs-actions.pod:3709 ../src/guestfs-actions.pod:3727 ../src/guestfs-actions.pod:3889 ../src/guestfs-actions.pod:3903 ../src/guestfs-actions.pod:3918 ../src/guestfs-actions.pod:3932 ../src/guestfs-actions.pod:3948 ../src/guestfs-actions.pod:3963 ../src/guestfs-actions.pod:3979 ../src/guestfs-actions.pod:3993 ../src/guestfs-actions.pod:4006 ../src/guestfs-actions.pod:4020 ../src/guestfs-actions.pod:4035 ../src/guestfs-actions.pod:4050 ../src/guestfs-actions.pod:4063 ../src/guestfs-actions.pod:4077 ../src/guestfs-actions.pod:5784
24801 msgid "This function returns a C truth value on success or -1 on error."
24802 msgstr ""
24803
24804 #. type: =head2
24805 #: ../src/guestfs-actions.pod:770
24806 msgid "guestfs_blockdev_getsize64"
24807 msgstr ""
24808
24809 #. type: verbatim
24810 #: ../src/guestfs-actions.pod:772
24811 #, no-wrap
24812 msgid ""
24813 " int64_t\n"
24814 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
24815 "                             const char *device);\n"
24816 "\n"
24817 msgstr ""
24818
24819 #. type: textblock
24820 #: ../src/guestfs-actions.pod:778
24821 msgid "See also C<guestfs_blockdev_getsz>."
24822 msgstr ""
24823
24824 #. type: =head2
24825 #: ../src/guestfs-actions.pod:786
24826 msgid "guestfs_blockdev_getss"
24827 msgstr ""
24828
24829 #. type: verbatim
24830 #: ../src/guestfs-actions.pod:788
24831 #, no-wrap
24832 msgid ""
24833 " int\n"
24834 " guestfs_blockdev_getss (guestfs_h *g,\n"
24835 "                         const char *device);\n"
24836 "\n"
24837 msgstr ""
24838
24839 #. type: textblock
24840 #: ../src/guestfs-actions.pod:795
24841 msgid ""
24842 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
24843 "that)."
24844 msgstr ""
24845
24846 #. type: =head2
24847 #: ../src/guestfs-actions.pod:804
24848 msgid "guestfs_blockdev_getsz"
24849 msgstr ""
24850
24851 #. type: verbatim
24852 #: ../src/guestfs-actions.pod:806
24853 #, no-wrap
24854 msgid ""
24855 " int64_t\n"
24856 " guestfs_blockdev_getsz (guestfs_h *g,\n"
24857 "                         const char *device);\n"
24858 "\n"
24859 msgstr ""
24860
24861 #. type: textblock
24862 #: ../src/guestfs-actions.pod:813
24863 msgid ""
24864 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
24865 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
24866 msgstr ""
24867
24868 #. type: =head2
24869 #: ../src/guestfs-actions.pod:823
24870 msgid "guestfs_blockdev_rereadpt"
24871 msgstr ""
24872
24873 #. type: verbatim
24874 #: ../src/guestfs-actions.pod:825
24875 #, no-wrap
24876 msgid ""
24877 " int\n"
24878 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
24879 "                            const char *device);\n"
24880 "\n"
24881 msgstr ""
24882
24883 #. type: =head2
24884 #: ../src/guestfs-actions.pod:837
24885 msgid "guestfs_blockdev_setbsz"
24886 msgstr ""
24887
24888 #. type: verbatim
24889 #: ../src/guestfs-actions.pod:839
24890 #, no-wrap
24891 msgid ""
24892 " int\n"
24893 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
24894 "                          const char *device,\n"
24895 "                          int blocksize);\n"
24896 "\n"
24897 msgstr ""
24898
24899 #. type: =head2
24900 #: ../src/guestfs-actions.pod:855
24901 msgid "guestfs_blockdev_setro"
24902 msgstr ""
24903
24904 #. type: verbatim
24905 #: ../src/guestfs-actions.pod:857
24906 #, no-wrap
24907 msgid ""
24908 " int\n"
24909 " guestfs_blockdev_setro (guestfs_h *g,\n"
24910 "                         const char *device);\n"
24911 "\n"
24912 msgstr ""
24913
24914 #. type: =head2
24915 #: ../src/guestfs-actions.pod:869
24916 msgid "guestfs_blockdev_setrw"
24917 msgstr ""
24918
24919 #. type: verbatim
24920 #: ../src/guestfs-actions.pod:871
24921 #, no-wrap
24922 msgid ""
24923 " int\n"
24924 " guestfs_blockdev_setrw (guestfs_h *g,\n"
24925 "                         const char *device);\n"
24926 "\n"
24927 msgstr ""
24928
24929 #. type: =head2
24930 #: ../src/guestfs-actions.pod:883
24931 msgid "guestfs_btrfs_filesystem_resize"
24932 msgstr ""
24933
24934 #. type: verbatim
24935 #: ../src/guestfs-actions.pod:885
24936 #, no-wrap
24937 msgid ""
24938 " int\n"
24939 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
24940 "                                  const char *mountpoint,\n"
24941 "                                  ...);\n"
24942 "\n"
24943 msgstr ""
24944
24945 #. type: verbatim
24946 #: ../src/guestfs-actions.pod:895
24947 #, no-wrap
24948 msgid ""
24949 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
24950 "\n"
24951 msgstr ""
24952
24953 #. type: textblock
24954 #: ../src/guestfs-actions.pod:918
24955 msgid "(Added in 1.11.17)"
24956 msgstr ""
24957
24958 #. type: =head2
24959 #: ../src/guestfs-actions.pod:920
24960 msgid "guestfs_btrfs_filesystem_resize_va"
24961 msgstr ""
24962
24963 #. type: verbatim
24964 #: ../src/guestfs-actions.pod:922
24965 #, no-wrap
24966 msgid ""
24967 " int\n"
24968 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
24969 "                                     const char *mountpoint,\n"
24970 "                                     va_list args);\n"
24971 "\n"
24972 msgstr ""
24973
24974 #. type: textblock
24975 #: ../src/guestfs-actions.pod:927
24976 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
24977 msgstr ""
24978
24979 #. type: =head2
24980 #: ../src/guestfs-actions.pod:931
24981 msgid "guestfs_btrfs_filesystem_resize_argv"
24982 msgstr ""
24983
24984 #. type: verbatim
24985 #: ../src/guestfs-actions.pod:933
24986 #, no-wrap
24987 msgid ""
24988 " int\n"
24989 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
24990 "                                       const char *mountpoint,\n"
24991 "                                       const struct "
24992 "guestfs_btrfs_filesystem_resize_argv *optargs);\n"
24993 "\n"
24994 msgstr ""
24995
24996 #. type: textblock
24997 #: ../src/guestfs-actions.pod:938
24998 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
24999 msgstr ""
25000
25001 #. type: =head2
25002 #: ../src/guestfs-actions.pod:942
25003 msgid "guestfs_case_sensitive_path"
25004 msgstr ""
25005
25006 #. type: verbatim
25007 #: ../src/guestfs-actions.pod:944
25008 #, no-wrap
25009 msgid ""
25010 " char *\n"
25011 " guestfs_case_sensitive_path (guestfs_h *g,\n"
25012 "                              const char *path);\n"
25013 "\n"
25014 msgstr ""
25015
25016 #. type: textblock
25017 #: ../src/guestfs-actions.pod:970
25018 msgid ""
25019 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")  might return "
25020 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
25021 "how the directories were originally created under Windows)."
25022 msgstr ""
25023
25024 #. type: textblock
25025 #: ../src/guestfs-actions.pod:978
25026 msgid "See also C<guestfs_realpath>."
25027 msgstr ""
25028
25029 #. type: textblock
25030 #: ../src/guestfs-actions.pod:983 ../src/guestfs-actions.pod:7856
25031 msgid "(Added in 1.0.75)"
25032 msgstr ""
25033
25034 #. type: =head2
25035 #: ../src/guestfs-actions.pod:985
25036 msgid "guestfs_cat"
25037 msgstr ""
25038
25039 #. type: verbatim
25040 #: ../src/guestfs-actions.pod:987
25041 #, no-wrap
25042 msgid ""
25043 " char *\n"
25044 " guestfs_cat (guestfs_h *g,\n"
25045 "              const char *path);\n"
25046 "\n"
25047 msgstr ""
25048
25049 #. type: textblock
25050 #: ../src/guestfs-actions.pod:993
25051 msgid ""
25052 "Note that this function cannot correctly handle binary files (specifically, "
25053 "files containing C<\\0> character which is treated as end of string).  For "
25054 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
25055 "functions which have a more complex interface."
25056 msgstr ""
25057
25058 #. type: textblock
25059 #: ../src/guestfs-actions.pod:1004 ../src/guestfs-actions.pod:4207 ../src/guestfs-actions.pod:4289 ../src/guestfs-actions.pod:4306 ../src/guestfs-actions.pod:4394 ../src/guestfs-actions.pod:4793 ../src/guestfs-actions.pod:4807 ../src/guestfs-actions.pod:6185 ../src/guestfs-actions.pod:6199 ../src/guestfs-actions.pod:8009 ../src/guestfs-actions.pod:8023
25060 msgid "(Added in 0.4)"
25061 msgstr ""
25062
25063 #. type: =head2
25064 #: ../src/guestfs-actions.pod:1006
25065 msgid "guestfs_checksum"
25066 msgstr ""
25067
25068 #. type: verbatim
25069 #: ../src/guestfs-actions.pod:1008
25070 #, no-wrap
25071 msgid ""
25072 " char *\n"
25073 " guestfs_checksum (guestfs_h *g,\n"
25074 "                   const char *csumtype,\n"
25075 "                   const char *path);\n"
25076 "\n"
25077 msgstr ""
25078
25079 #. type: textblock
25080 #: ../src/guestfs-actions.pod:1054
25081 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
25082 msgstr ""
25083
25084 #. type: textblock
25085 #: ../src/guestfs-actions.pod:1056
25086 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
25087 msgstr ""
25088
25089 #. type: textblock
25090 #: ../src/guestfs-actions.pod:1061 ../src/guestfs-actions.pod:1728 ../src/guestfs-actions.pod:2586 ../src/guestfs-actions.pod:3905 ../src/guestfs-actions.pod:3934 ../src/guestfs-actions.pod:3995 ../src/guestfs-actions.pod:4022 ../src/guestfs-actions.pod:7712
25091 msgid "(Added in 1.0.2)"
25092 msgstr ""
25093
25094 #. type: =head2
25095 #: ../src/guestfs-actions.pod:1063
25096 msgid "guestfs_checksum_device"
25097 msgstr ""
25098
25099 #. type: verbatim
25100 #: ../src/guestfs-actions.pod:1065
25101 #, no-wrap
25102 msgid ""
25103 " char *\n"
25104 " guestfs_checksum_device (guestfs_h *g,\n"
25105 "                          const char *csumtype,\n"
25106 "                          const char *device);\n"
25107 "\n"
25108 msgstr ""
25109
25110 #. type: textblock
25111 #: ../src/guestfs-actions.pod:1070
25112 msgid ""
25113 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
25114 "device named C<device>.  For the types of checksums supported see the "
25115 "C<guestfs_checksum> command."
25116 msgstr ""
25117
25118 #. type: textblock
25119 #: ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:5617 ../src/guestfs-actions.pod:5752 ../src/guestfs-actions.pod:5786 ../src/guestfs-actions.pod:5804 ../src/guestfs-actions.pod:5986 ../src/guestfs-actions.pod:7621 ../src/guestfs-actions.pod:7635 ../src/guestfs-actions.pod:8035
25120 msgid "(Added in 1.3.2)"
25121 msgstr ""
25122
25123 #. type: =head2
25124 #: ../src/guestfs-actions.pod:1079
25125 msgid "guestfs_checksums_out"
25126 msgstr ""
25127
25128 #. type: verbatim
25129 #: ../src/guestfs-actions.pod:1081
25130 #, no-wrap
25131 msgid ""
25132 " int\n"
25133 " guestfs_checksums_out (guestfs_h *g,\n"
25134 "                        const char *csumtype,\n"
25135 "                        const char *directory,\n"
25136 "                        const char *sumsfile);\n"
25137 "\n"
25138 msgstr ""
25139
25140 #. type: textblock
25141 #: ../src/guestfs-actions.pod:1101
25142 msgid "(Added in 1.3.7)"
25143 msgstr ""
25144
25145 #. type: =head2
25146 #: ../src/guestfs-actions.pod:1103
25147 msgid "guestfs_chmod"
25148 msgstr ""
25149
25150 #. type: verbatim
25151 #: ../src/guestfs-actions.pod:1105
25152 #, no-wrap
25153 msgid ""
25154 " int\n"
25155 " guestfs_chmod (guestfs_h *g,\n"
25156 "                int mode,\n"
25157 "                const char *path);\n"
25158 "\n"
25159 msgstr ""
25160
25161 #. type: =head2
25162 #: ../src/guestfs-actions.pod:1123
25163 msgid "guestfs_chown"
25164 msgstr ""
25165
25166 #. type: verbatim
25167 #: ../src/guestfs-actions.pod:1125
25168 #, no-wrap
25169 msgid ""
25170 " int\n"
25171 " guestfs_chown (guestfs_h *g,\n"
25172 "                int owner,\n"
25173 "                int group,\n"
25174 "                const char *path);\n"
25175 "\n"
25176 msgstr ""
25177
25178 #. type: =head2
25179 #: ../src/guestfs-actions.pod:1141
25180 msgid "guestfs_command"
25181 msgstr ""
25182
25183 #. type: verbatim
25184 #: ../src/guestfs-actions.pod:1143
25185 #, no-wrap
25186 msgid ""
25187 " char *\n"
25188 " guestfs_command (guestfs_h *g,\n"
25189 "                  char *const *arguments);\n"
25190 "\n"
25191 msgstr ""
25192
25193 #. type: textblock
25194 #: ../src/guestfs-actions.pod:1152
25195 msgid ""
25196 "The single parameter is an argv-style list of arguments.  The first element "
25197 "is the name of the program to run.  Subsequent elements are parameters.  The "
25198 "list must be non-empty (ie. must contain a program name).  Note that the "
25199 "command runs directly, and is I<not> invoked via the shell (see "
25200 "C<guestfs_sh>)."
25201 msgstr ""
25202
25203 #. type: textblock
25204 #: ../src/guestfs-actions.pod:1183 ../src/guestfs-actions.pod:1203 ../src/guestfs-actions.pod:2027
25205 msgid "(Added in 0.9.1)"
25206 msgstr ""
25207
25208 #. type: =head2
25209 #: ../src/guestfs-actions.pod:1185
25210 msgid "guestfs_command_lines"
25211 msgstr ""
25212
25213 #. type: verbatim
25214 #: ../src/guestfs-actions.pod:1187
25215 #, no-wrap
25216 msgid ""
25217 " char **\n"
25218 " guestfs_command_lines (guestfs_h *g,\n"
25219 "                        char *const *arguments);\n"
25220 "\n"
25221 msgstr ""
25222
25223 #. type: textblock
25224 #: ../src/guestfs-actions.pod:1191
25225 msgid ""
25226 "This is the same as C<guestfs_command>, but splits the result into a list of "
25227 "lines."
25228 msgstr ""
25229
25230 #. type: textblock
25231 #: ../src/guestfs-actions.pod:1194
25232 msgid "See also: C<guestfs_sh_lines>"
25233 msgstr ""
25234
25235 #. type: =head2
25236 #: ../src/guestfs-actions.pod:1205
25237 msgid "guestfs_compress_device_out"
25238 msgstr ""
25239
25240 #. type: verbatim
25241 #: ../src/guestfs-actions.pod:1207
25242 #, no-wrap
25243 msgid ""
25244 " int\n"
25245 " guestfs_compress_device_out (guestfs_h *g,\n"
25246 "                              const char *ctype,\n"
25247 "                              const char *device,\n"
25248 "                              const char *zdevice,\n"
25249 "                              ...);\n"
25250 "\n"
25251 msgstr ""
25252
25253 #. type: verbatim
25254 #: ../src/guestfs-actions.pod:1219
25255 #, no-wrap
25256 msgid ""
25257 " GUESTFS_COMPRESS_DEVICE_OUT_LEVEL, int level,\n"
25258 "\n"
25259 msgstr ""
25260
25261 #. type: textblock
25262 #: ../src/guestfs-actions.pod:1224
25263 msgid ""
25264 "The C<ctype> and optional C<level> parameters have the same meaning as in "
25265 "C<guestfs_compress_out>."
25266 msgstr ""
25267
25268 #. type: textblock
25269 #: ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:1288 ../src/guestfs-actions.pod:2572 ../src/guestfs-actions.pod:6902
25270 msgid "(Added in 1.13.15)"
25271 msgstr ""
25272
25273 #. type: =head2
25274 #: ../src/guestfs-actions.pod:1231
25275 msgid "guestfs_compress_device_out_va"
25276 msgstr ""
25277
25278 #. type: verbatim
25279 #: ../src/guestfs-actions.pod:1233
25280 #, no-wrap
25281 msgid ""
25282 " int\n"
25283 " guestfs_compress_device_out_va (guestfs_h *g,\n"
25284 "                                 const char *ctype,\n"
25285 "                                 const char *device,\n"
25286 "                                 const char *zdevice,\n"
25287 "                                 va_list args);\n"
25288 "\n"
25289 msgstr ""
25290
25291 #. type: textblock
25292 #: ../src/guestfs-actions.pod:1240
25293 msgid "This is the \"va_list variant\" of L</guestfs_compress_device_out>."
25294 msgstr ""
25295
25296 #. type: =head2
25297 #: ../src/guestfs-actions.pod:1244
25298 msgid "guestfs_compress_device_out_argv"
25299 msgstr ""
25300
25301 #. type: verbatim
25302 #: ../src/guestfs-actions.pod:1246
25303 #, no-wrap
25304 msgid ""
25305 " int\n"
25306 " guestfs_compress_device_out_argv (guestfs_h *g,\n"
25307 "                                   const char *ctype,\n"
25308 "                                   const char *device,\n"
25309 "                                   const char *zdevice,\n"
25310 "                                   const struct "
25311 "guestfs_compress_device_out_argv *optargs);\n"
25312 "\n"
25313 msgstr ""
25314
25315 #. type: textblock
25316 #: ../src/guestfs-actions.pod:1253
25317 msgid "This is the \"argv variant\" of L</guestfs_compress_device_out>."
25318 msgstr ""
25319
25320 #. type: =head2
25321 #: ../src/guestfs-actions.pod:1257
25322 msgid "guestfs_compress_out"
25323 msgstr ""
25324
25325 #. type: verbatim
25326 #: ../src/guestfs-actions.pod:1259
25327 #, no-wrap
25328 msgid ""
25329 " int\n"
25330 " guestfs_compress_out (guestfs_h *g,\n"
25331 "                       const char *ctype,\n"
25332 "                       const char *file,\n"
25333 "                       const char *zfile,\n"
25334 "                       ...);\n"
25335 "\n"
25336 msgstr ""
25337
25338 #. type: verbatim
25339 #: ../src/guestfs-actions.pod:1271
25340 #, no-wrap
25341 msgid ""
25342 " GUESTFS_COMPRESS_OUT_LEVEL, int level,\n"
25343 "\n"
25344 msgstr ""
25345
25346 #. type: =head2
25347 #: ../src/guestfs-actions.pod:1290
25348 msgid "guestfs_compress_out_va"
25349 msgstr ""
25350
25351 #. type: verbatim
25352 #: ../src/guestfs-actions.pod:1292
25353 #, no-wrap
25354 msgid ""
25355 " int\n"
25356 " guestfs_compress_out_va (guestfs_h *g,\n"
25357 "                          const char *ctype,\n"
25358 "                          const char *file,\n"
25359 "                          const char *zfile,\n"
25360 "                          va_list args);\n"
25361 "\n"
25362 msgstr ""
25363
25364 #. type: textblock
25365 #: ../src/guestfs-actions.pod:1299
25366 msgid "This is the \"va_list variant\" of L</guestfs_compress_out>."
25367 msgstr ""
25368
25369 #. type: =head2
25370 #: ../src/guestfs-actions.pod:1303
25371 msgid "guestfs_compress_out_argv"
25372 msgstr ""
25373
25374 #. type: verbatim
25375 #: ../src/guestfs-actions.pod:1305
25376 #, no-wrap
25377 msgid ""
25378 " int\n"
25379 " guestfs_compress_out_argv (guestfs_h *g,\n"
25380 "                            const char *ctype,\n"
25381 "                            const char *file,\n"
25382 "                            const char *zfile,\n"
25383 "                            const struct guestfs_compress_out_argv "
25384 "*optargs);\n"
25385 "\n"
25386 msgstr ""
25387
25388 #. type: textblock
25389 #: ../src/guestfs-actions.pod:1312
25390 msgid "This is the \"argv variant\" of L</guestfs_compress_out>."
25391 msgstr ""
25392
25393 #. type: =head2
25394 #: ../src/guestfs-actions.pod:1316
25395 msgid "guestfs_config"
25396 msgstr ""
25397
25398 #. type: verbatim
25399 #: ../src/guestfs-actions.pod:1318
25400 #, no-wrap
25401 msgid ""
25402 " int\n"
25403 " guestfs_config (guestfs_h *g,\n"
25404 "                 const char *qemuparam,\n"
25405 "                 const char *qemuvalue);\n"
25406 "\n"
25407 msgstr ""
25408
25409 #. type: =head2
25410 #: ../src/guestfs-actions.pod:1336
25411 msgid "guestfs_copy_device_to_device"
25412 msgstr ""
25413
25414 #. type: verbatim
25415 #: ../src/guestfs-actions.pod:1338
25416 #, no-wrap
25417 msgid ""
25418 " int\n"
25419 " guestfs_copy_device_to_device (guestfs_h *g,\n"
25420 "                                const char *src,\n"
25421 "                                const char *dest,\n"
25422 "                                ...);\n"
25423 "\n"
25424 msgstr ""
25425
25426 #. type: verbatim
25427 #: ../src/guestfs-actions.pod:1349
25428 #, no-wrap
25429 msgid ""
25430 " GUESTFS_COPY_DEVICE_TO_DEVICE_SRCOFFSET, int64_t srcoffset,\n"
25431 " GUESTFS_COPY_DEVICE_TO_DEVICE_DESTOFFSET, int64_t destoffset,\n"
25432 " GUESTFS_COPY_DEVICE_TO_DEVICE_SIZE, int64_t size,\n"
25433 "\n"
25434 msgstr ""
25435
25436 #. type: textblock
25437 #: ../src/guestfs-actions.pod:1353
25438 msgid ""
25439 "The four calls C<guestfs_copy_device_to_device>, "
25440 "C<guestfs_copy_device_to_file>, C<guestfs_copy_file_to_device>, and "
25441 "C<guestfs_copy_file_to_file> let you copy from a source (device|file) to a "
25442 "destination (device|file)."
25443 msgstr ""
25444
25445 #. type: textblock
25446 #: ../src/guestfs-actions.pod:1374 ../src/guestfs-actions.pod:1427 ../src/guestfs-actions.pod:1480 ../src/guestfs-actions.pod:1538 ../src/guestfs-actions.pod:1592 ../src/guestfs-actions.pod:1723 ../src/guestfs-actions.pod:1754 ../src/guestfs-actions.pod:1799 ../src/guestfs-actions.pod:2176 ../src/guestfs-actions.pod:2198 ../src/guestfs-actions.pod:4105 ../src/guestfs-actions.pod:7707 ../src/guestfs-actions.pod:7741 ../src/guestfs-actions.pod:8248 ../src/guestfs-actions.pod:8271
25447 msgid ""
25448 "This long-running command can generate progress notification messages so "
25449 "that the caller can display a progress bar or indicator.  To receive these "
25450 "messages, the caller must register a progress event callback.  See "
25451 "L<guestfs(3)/GUESTFS_EVENT_PROGRESS>."
25452 msgstr ""
25453
25454 #. type: textblock
25455 #: ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1432 ../src/guestfs-actions.pod:1485 ../src/guestfs-actions.pod:1543 ../src/guestfs-actions.pod:6042
25456 msgid "(Added in 1.13.25)"
25457 msgstr ""
25458
25459 #. type: =head2
25460 #: ../src/guestfs-actions.pod:1381
25461 msgid "guestfs_copy_device_to_device_va"
25462 msgstr ""
25463
25464 #. type: verbatim
25465 #: ../src/guestfs-actions.pod:1383
25466 #, no-wrap
25467 msgid ""
25468 " int\n"
25469 " guestfs_copy_device_to_device_va (guestfs_h *g,\n"
25470 "                                   const char *src,\n"
25471 "                                   const char *dest,\n"
25472 "                                   va_list args);\n"
25473 "\n"
25474 msgstr ""
25475
25476 #. type: textblock
25477 #: ../src/guestfs-actions.pod:1389
25478 msgid "This is the \"va_list variant\" of L</guestfs_copy_device_to_device>."
25479 msgstr ""
25480
25481 #. type: =head2
25482 #: ../src/guestfs-actions.pod:1393
25483 msgid "guestfs_copy_device_to_device_argv"
25484 msgstr ""
25485
25486 #. type: verbatim
25487 #: ../src/guestfs-actions.pod:1395
25488 #, no-wrap
25489 msgid ""
25490 " int\n"
25491 " guestfs_copy_device_to_device_argv (guestfs_h *g,\n"
25492 "                                     const char *src,\n"
25493 "                                     const char *dest,\n"
25494 "                                     const struct "
25495 "guestfs_copy_device_to_device_argv *optargs);\n"
25496 "\n"
25497 msgstr ""
25498
25499 #. type: textblock
25500 #: ../src/guestfs-actions.pod:1401
25501 msgid "This is the \"argv variant\" of L</guestfs_copy_device_to_device>."
25502 msgstr ""
25503
25504 #. type: =head2
25505 #: ../src/guestfs-actions.pod:1405
25506 msgid "guestfs_copy_device_to_file"
25507 msgstr ""
25508
25509 #. type: verbatim
25510 #: ../src/guestfs-actions.pod:1407
25511 #, no-wrap
25512 msgid ""
25513 " int\n"
25514 " guestfs_copy_device_to_file (guestfs_h *g,\n"
25515 "                              const char *src,\n"
25516 "                              const char *dest,\n"
25517 "                              ...);\n"
25518 "\n"
25519 msgstr ""
25520
25521 #. type: verbatim
25522 #: ../src/guestfs-actions.pod:1418
25523 #, no-wrap
25524 msgid ""
25525 " GUESTFS_COPY_DEVICE_TO_FILE_SRCOFFSET, int64_t srcoffset,\n"
25526 " GUESTFS_COPY_DEVICE_TO_FILE_DESTOFFSET, int64_t destoffset,\n"
25527 " GUESTFS_COPY_DEVICE_TO_FILE_SIZE, int64_t size,\n"
25528 "\n"
25529 msgstr ""
25530
25531 #. type: textblock
25532 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1475 ../src/guestfs-actions.pod:1528
25533 msgid "See C<guestfs_copy_device_to_device> for a general overview of this call."
25534 msgstr ""
25535
25536 #. type: =head2
25537 #: ../src/guestfs-actions.pod:1434
25538 msgid "guestfs_copy_device_to_file_va"
25539 msgstr ""
25540
25541 #. type: verbatim
25542 #: ../src/guestfs-actions.pod:1436
25543 #, no-wrap
25544 msgid ""
25545 " int\n"
25546 " guestfs_copy_device_to_file_va (guestfs_h *g,\n"
25547 "                                 const char *src,\n"
25548 "                                 const char *dest,\n"
25549 "                                 va_list args);\n"
25550 "\n"
25551 msgstr ""
25552
25553 #. type: textblock
25554 #: ../src/guestfs-actions.pod:1442
25555 msgid "This is the \"va_list variant\" of L</guestfs_copy_device_to_file>."
25556 msgstr ""
25557
25558 #. type: =head2
25559 #: ../src/guestfs-actions.pod:1446
25560 msgid "guestfs_copy_device_to_file_argv"
25561 msgstr ""
25562
25563 #. type: verbatim
25564 #: ../src/guestfs-actions.pod:1448
25565 #, no-wrap
25566 msgid ""
25567 " int\n"
25568 " guestfs_copy_device_to_file_argv (guestfs_h *g,\n"
25569 "                                   const char *src,\n"
25570 "                                   const char *dest,\n"
25571 "                                   const struct "
25572 "guestfs_copy_device_to_file_argv *optargs);\n"
25573 "\n"
25574 msgstr ""
25575
25576 #. type: textblock
25577 #: ../src/guestfs-actions.pod:1454
25578 msgid "This is the \"argv variant\" of L</guestfs_copy_device_to_file>."
25579 msgstr ""
25580
25581 #. type: =head2
25582 #: ../src/guestfs-actions.pod:1458
25583 msgid "guestfs_copy_file_to_device"
25584 msgstr ""
25585
25586 #. type: verbatim
25587 #: ../src/guestfs-actions.pod:1460
25588 #, no-wrap
25589 msgid ""
25590 " int\n"
25591 " guestfs_copy_file_to_device (guestfs_h *g,\n"
25592 "                              const char *src,\n"
25593 "                              const char *dest,\n"
25594 "                              ...);\n"
25595 "\n"
25596 msgstr ""
25597
25598 #. type: verbatim
25599 #: ../src/guestfs-actions.pod:1471
25600 #, no-wrap
25601 msgid ""
25602 " GUESTFS_COPY_FILE_TO_DEVICE_SRCOFFSET, int64_t srcoffset,\n"
25603 " GUESTFS_COPY_FILE_TO_DEVICE_DESTOFFSET, int64_t destoffset,\n"
25604 " GUESTFS_COPY_FILE_TO_DEVICE_SIZE, int64_t size,\n"
25605 "\n"
25606 msgstr ""
25607
25608 #. type: =head2
25609 #: ../src/guestfs-actions.pod:1487
25610 msgid "guestfs_copy_file_to_device_va"
25611 msgstr ""
25612
25613 #. type: verbatim
25614 #: ../src/guestfs-actions.pod:1489
25615 #, no-wrap
25616 msgid ""
25617 " int\n"
25618 " guestfs_copy_file_to_device_va (guestfs_h *g,\n"
25619 "                                 const char *src,\n"
25620 "                                 const char *dest,\n"
25621 "                                 va_list args);\n"
25622 "\n"
25623 msgstr ""
25624
25625 #. type: textblock
25626 #: ../src/guestfs-actions.pod:1495
25627 msgid "This is the \"va_list variant\" of L</guestfs_copy_file_to_device>."
25628 msgstr ""
25629
25630 #. type: =head2
25631 #: ../src/guestfs-actions.pod:1499
25632 msgid "guestfs_copy_file_to_device_argv"
25633 msgstr ""
25634
25635 #. type: verbatim
25636 #: ../src/guestfs-actions.pod:1501
25637 #, no-wrap
25638 msgid ""
25639 " int\n"
25640 " guestfs_copy_file_to_device_argv (guestfs_h *g,\n"
25641 "                                   const char *src,\n"
25642 "                                   const char *dest,\n"
25643 "                                   const struct "
25644 "guestfs_copy_file_to_device_argv *optargs);\n"
25645 "\n"
25646 msgstr ""
25647
25648 #. type: textblock
25649 #: ../src/guestfs-actions.pod:1507
25650 msgid "This is the \"argv variant\" of L</guestfs_copy_file_to_device>."
25651 msgstr ""
25652
25653 #. type: =head2
25654 #: ../src/guestfs-actions.pod:1511
25655 msgid "guestfs_copy_file_to_file"
25656 msgstr ""
25657
25658 #. type: verbatim
25659 #: ../src/guestfs-actions.pod:1513
25660 #, no-wrap
25661 msgid ""
25662 " int\n"
25663 " guestfs_copy_file_to_file (guestfs_h *g,\n"
25664 "                            const char *src,\n"
25665 "                            const char *dest,\n"
25666 "                            ...);\n"
25667 "\n"
25668 msgstr ""
25669
25670 #. type: verbatim
25671 #: ../src/guestfs-actions.pod:1524
25672 #, no-wrap
25673 msgid ""
25674 " GUESTFS_COPY_FILE_TO_FILE_SRCOFFSET, int64_t srcoffset,\n"
25675 " GUESTFS_COPY_FILE_TO_FILE_DESTOFFSET, int64_t destoffset,\n"
25676 " GUESTFS_COPY_FILE_TO_FILE_SIZE, int64_t size,\n"
25677 "\n"
25678 msgstr ""
25679
25680 #. type: textblock
25681 #: ../src/guestfs-actions.pod:1531
25682 msgid ""
25683 "This is B<not> the function you want for copying files.  This is for copying "
25684 "blocks within existing files.  See C<guestfs_cp>, C<guestfs_cp_a> and "
25685 "C<guestfs_mv> for general file copying and moving functions."
25686 msgstr ""
25687
25688 #. type: =head2
25689 #: ../src/guestfs-actions.pod:1545
25690 msgid "guestfs_copy_file_to_file_va"
25691 msgstr ""
25692
25693 #. type: verbatim
25694 #: ../src/guestfs-actions.pod:1547
25695 #, no-wrap
25696 msgid ""
25697 " int\n"
25698 " guestfs_copy_file_to_file_va (guestfs_h *g,\n"
25699 "                               const char *src,\n"
25700 "                               const char *dest,\n"
25701 "                               va_list args);\n"
25702 "\n"
25703 msgstr ""
25704
25705 #. type: textblock
25706 #: ../src/guestfs-actions.pod:1553
25707 msgid "This is the \"va_list variant\" of L</guestfs_copy_file_to_file>."
25708 msgstr ""
25709
25710 #. type: =head2
25711 #: ../src/guestfs-actions.pod:1557
25712 msgid "guestfs_copy_file_to_file_argv"
25713 msgstr ""
25714
25715 #. type: verbatim
25716 #: ../src/guestfs-actions.pod:1559
25717 #, no-wrap
25718 msgid ""
25719 " int\n"
25720 " guestfs_copy_file_to_file_argv (guestfs_h *g,\n"
25721 "                                 const char *src,\n"
25722 "                                 const char *dest,\n"
25723 "                                 const struct guestfs_copy_file_to_file_argv "
25724 "*optargs);\n"
25725 "\n"
25726 msgstr ""
25727
25728 #. type: textblock
25729 #: ../src/guestfs-actions.pod:1565
25730 msgid "This is the \"argv variant\" of L</guestfs_copy_file_to_file>."
25731 msgstr ""
25732
25733 #. type: =head2
25734 #: ../src/guestfs-actions.pod:1569
25735 msgid "guestfs_copy_size"
25736 msgstr ""
25737
25738 #. type: verbatim
25739 #: ../src/guestfs-actions.pod:1571
25740 #, no-wrap
25741 msgid ""
25742 " int\n"
25743 " guestfs_copy_size (guestfs_h *g,\n"
25744 "                    const char *src,\n"
25745 "                    const char *dest,\n"
25746 "                    int64_t size);\n"
25747 "\n"
25748 msgstr ""
25749
25750 #. type: textblock
25751 #: ../src/guestfs-actions.pod:1577 ../src/guestfs-actions.pod:1634
25752 msgid ""
25753 "I<This function is deprecated.> In new code, use the "
25754 "L</guestfs_copy_device_to_device> call instead."
25755 msgstr ""
25756
25757 #. type: textblock
25758 #: ../src/guestfs-actions.pod:1597 ../src/guestfs-actions.pod:4820 ../src/guestfs-actions.pod:6212 ../src/guestfs-actions.pod:7942 ../src/guestfs-actions.pod:7962 ../src/guestfs-actions.pod:8048
25759 msgid "(Added in 1.0.87)"
25760 msgstr ""
25761
25762 #. type: =head2
25763 #: ../src/guestfs-actions.pod:1599
25764 msgid "guestfs_cp"
25765 msgstr ""
25766
25767 #. type: verbatim
25768 #: ../src/guestfs-actions.pod:1601
25769 #, no-wrap
25770 msgid ""
25771 " int\n"
25772 " guestfs_cp (guestfs_h *g,\n"
25773 "             const char *src,\n"
25774 "             const char *dest);\n"
25775 "\n"
25776 msgstr ""
25777
25778 #. type: textblock
25779 #: ../src/guestfs-actions.pod:1611 ../src/guestfs-actions.pod:1625 ../src/guestfs-actions.pod:1705 ../src/guestfs-actions.pod:1779 ../src/guestfs-actions.pod:1893 ../src/guestfs-actions.pod:5564 ../src/guestfs-actions.pod:6056
25780 msgid "(Added in 1.0.18)"
25781 msgstr ""
25782
25783 #. type: =head2
25784 #: ../src/guestfs-actions.pod:1613
25785 msgid "guestfs_cp_a"
25786 msgstr ""
25787
25788 #. type: verbatim
25789 #: ../src/guestfs-actions.pod:1615
25790 #, no-wrap
25791 msgid ""
25792 " int\n"
25793 " guestfs_cp_a (guestfs_h *g,\n"
25794 "               const char *src,\n"
25795 "               const char *dest);\n"
25796 "\n"
25797 msgstr ""
25798
25799 #. type: =head2
25800 #: ../src/guestfs-actions.pod:1627
25801 msgid "guestfs_dd"
25802 msgstr ""
25803
25804 #. type: verbatim
25805 #: ../src/guestfs-actions.pod:1629
25806 #, no-wrap
25807 msgid ""
25808 " int\n"
25809 " guestfs_dd (guestfs_h *g,\n"
25810 "             const char *src,\n"
25811 "             const char *dest);\n"
25812 "\n"
25813 msgstr ""
25814
25815 #. type: textblock
25816 #: ../src/guestfs-actions.pod:1646
25817 msgid ""
25818 "If the destination is a device, it must be as large or larger than the "
25819 "source file or device, otherwise the copy will fail.  This command cannot do "
25820 "partial copies (see C<guestfs_copy_device_to_device>)."
25821 msgstr ""
25822
25823 #. type: =head2
25824 #: ../src/guestfs-actions.pod:1655
25825 msgid "guestfs_df"
25826 msgstr ""
25827
25828 #. type: verbatim
25829 #: ../src/guestfs-actions.pod:1657
25830 #, no-wrap
25831 msgid ""
25832 " char *\n"
25833 " guestfs_df (guestfs_h *g);\n"
25834 "\n"
25835 msgstr ""
25836
25837 #. type: textblock
25838 #: ../src/guestfs-actions.pod:1662 ../src/guestfs-actions.pod:1679
25839 msgid ""
25840 "This command is mostly useful for interactive sessions.  It is I<not> "
25841 "intended that you try to parse the output string.  Use C<guestfs_statvfs> "
25842 "from programs."
25843 msgstr ""
25844
25845 #. type: textblock
25846 #: ../src/guestfs-actions.pod:1669 ../src/guestfs-actions.pod:1686 ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:2811 ../src/guestfs-actions.pod:2835 ../src/guestfs-actions.pod:2903 ../src/guestfs-actions.pod:4930 ../src/guestfs-actions.pod:5464 ../src/guestfs-actions.pod:7445 ../src/guestfs-actions.pod:7469 ../src/guestfs-actions.pod:8088 ../src/guestfs-actions.pod:8101 ../src/guestfs-actions.pod:8114
25847 msgid "(Added in 1.0.54)"
25848 msgstr ""
25849
25850 #. type: =head2
25851 #: ../src/guestfs-actions.pod:1671
25852 msgid "guestfs_df_h"
25853 msgstr ""
25854
25855 #. type: verbatim
25856 #: ../src/guestfs-actions.pod:1673
25857 #, no-wrap
25858 msgid ""
25859 " char *\n"
25860 " guestfs_df_h (guestfs_h *g);\n"
25861 "\n"
25862 msgstr ""
25863
25864 #. type: =head2
25865 #: ../src/guestfs-actions.pod:1688
25866 msgid "guestfs_dmesg"
25867 msgstr ""
25868
25869 #. type: verbatim
25870 #: ../src/guestfs-actions.pod:1690
25871 #, no-wrap
25872 msgid ""
25873 " char *\n"
25874 " guestfs_dmesg (guestfs_h *g);\n"
25875 "\n"
25876 msgstr ""
25877
25878 #. type: textblock
25879 #: ../src/guestfs-actions.pod:1697
25880 msgid ""
25881 "Another way to get the same information is to enable verbose messages with "
25882 "C<guestfs_set_verbose> or by setting the environment variable "
25883 "C<LIBGUESTFS_DEBUG=1> before running the program."
25884 msgstr ""
25885
25886 #. type: =head2
25887 #: ../src/guestfs-actions.pod:1707
25888 msgid "guestfs_download"
25889 msgstr ""
25890
25891 #. type: verbatim
25892 #: ../src/guestfs-actions.pod:1709
25893 #, no-wrap
25894 msgid ""
25895 " int\n"
25896 " guestfs_download (guestfs_h *g,\n"
25897 "                   const char *remotefilename,\n"
25898 "                   const char *filename);\n"
25899 "\n"
25900 msgstr ""
25901
25902 #. type: textblock
25903 #: ../src/guestfs-actions.pod:1719
25904 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
25905 msgstr ""
25906
25907 #. type: =head2
25908 #: ../src/guestfs-actions.pod:1730
25909 msgid "guestfs_download_offset"
25910 msgstr ""
25911
25912 #. type: verbatim
25913 #: ../src/guestfs-actions.pod:1732
25914 #, no-wrap
25915 msgid ""
25916 " int\n"
25917 " guestfs_download_offset (guestfs_h *g,\n"
25918 "                          const char *remotefilename,\n"
25919 "                          const char *filename,\n"
25920 "                          int64_t offset,\n"
25921 "                          int64_t size);\n"
25922 "\n"
25923 msgstr ""
25924
25925 #. type: textblock
25926 #: ../src/guestfs-actions.pod:1745
25927 msgid ""
25928 "Note that there is no limit on the amount of data that can be downloaded "
25929 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
25930 "full amount unless an error occurs."
25931 msgstr ""
25932
25933 #. type: textblock
25934 #: ../src/guestfs-actions.pod:1750
25935 msgid "See also C<guestfs_download>, C<guestfs_pread>."
25936 msgstr ""
25937
25938 #. type: textblock
25939 #: ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:7746
25940 msgid "(Added in 1.5.17)"
25941 msgstr ""
25942
25943 #. type: =head2
25944 #: ../src/guestfs-actions.pod:1761
25945 msgid "guestfs_drop_caches"
25946 msgstr ""
25947
25948 #. type: verbatim
25949 #: ../src/guestfs-actions.pod:1763
25950 #, no-wrap
25951 msgid ""
25952 " int\n"
25953 " guestfs_drop_caches (guestfs_h *g,\n"
25954 "                      int whattodrop);\n"
25955 "\n"
25956 msgstr ""
25957
25958 #. type: =head2
25959 #: ../src/guestfs-actions.pod:1781
25960 msgid "guestfs_du"
25961 msgstr ""
25962
25963 #. type: verbatim
25964 #: ../src/guestfs-actions.pod:1783
25965 #, no-wrap
25966 msgid ""
25967 " int64_t\n"
25968 " guestfs_du (guestfs_h *g,\n"
25969 "             const char *path);\n"
25970 "\n"
25971 msgstr ""
25972
25973 #. type: =head2
25974 #: ../src/guestfs-actions.pod:1806
25975 msgid "guestfs_e2fsck_f"
25976 msgstr ""
25977
25978 #. type: verbatim
25979 #: ../src/guestfs-actions.pod:1808
25980 #, no-wrap
25981 msgid ""
25982 " int\n"
25983 " guestfs_e2fsck_f (guestfs_h *g,\n"
25984 "                   const char *device);\n"
25985 "\n"
25986 msgstr ""
25987
25988 #. type: textblock
25989 #: ../src/guestfs-actions.pod:1816
25990 msgid ""
25991 "This command is only needed because of C<guestfs_resize2fs> (q.v.).  "
25992 "Normally you should use C<guestfs_fsck>."
25993 msgstr ""
25994
25995 #. type: textblock
25996 #: ../src/guestfs-actions.pod:1821
25997 msgid "(Added in 1.0.29)"
25998 msgstr ""
25999
26000 #. type: =head2
26001 #: ../src/guestfs-actions.pod:1823
26002 msgid "guestfs_echo_daemon"
26003 msgstr ""
26004
26005 #. type: verbatim
26006 #: ../src/guestfs-actions.pod:1825
26007 #, no-wrap
26008 msgid ""
26009 " char *\n"
26010 " guestfs_echo_daemon (guestfs_h *g,\n"
26011 "                      char *const *words);\n"
26012 "\n"
26013 msgstr ""
26014
26015 #. type: textblock
26016 #: ../src/guestfs-actions.pod:1834
26017 msgid "See also C<guestfs_ping_daemon>."
26018 msgstr ""
26019
26020 #. type: textblock
26021 #: ../src/guestfs-actions.pod:1839 ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:6926
26022 msgid "(Added in 1.0.69)"
26023 msgstr ""
26024
26025 #. type: =head2
26026 #: ../src/guestfs-actions.pod:1841
26027 msgid "guestfs_egrep"
26028 msgstr ""
26029
26030 #. type: verbatim
26031 #: ../src/guestfs-actions.pod:1843
26032 #, no-wrap
26033 msgid ""
26034 " char **\n"
26035 " guestfs_egrep (guestfs_h *g,\n"
26036 "                const char *regex,\n"
26037 "                const char *path);\n"
26038 "\n"
26039 msgstr ""
26040
26041 #. type: textblock
26042 #: ../src/guestfs-actions.pod:1858 ../src/guestfs-actions.pod:1877 ../src/guestfs-actions.pod:1934 ../src/guestfs-actions.pod:1980 ../src/guestfs-actions.pod:1999 ../src/guestfs-actions.pod:2727 ../src/guestfs-actions.pod:2746 ../src/guestfs-actions.pod:2924 ../src/guestfs-actions.pod:2937 ../src/guestfs-actions.pod:2952 ../src/guestfs-actions.pod:2998 ../src/guestfs-actions.pod:3020 ../src/guestfs-actions.pod:3033 ../src/guestfs-actions.pod:4319 ../src/guestfs-actions.pod:4333 ../src/guestfs-actions.pod:4346 ../src/guestfs-actions.pod:4360 ../src/guestfs-actions.pod:5352 ../src/guestfs-actions.pod:6390 ../src/guestfs-actions.pod:6439 ../src/guestfs-actions.pod:7313 ../src/guestfs-actions.pod:7325 ../src/guestfs-actions.pod:7338 ../src/guestfs-actions.pod:7351 ../src/guestfs-actions.pod:7373 ../src/guestfs-actions.pod:7386 ../src/guestfs-actions.pod:7399 ../src/guestfs-actions.pod:7412 ../src/guestfs-actions.pod:8206 ../src/guestfs-actions.pod:8225 ../src/guestfs-actions.pod:8316 ../src/guestfs-actions.pod:8335 ../src/guestfs-actions.pod:8381 ../src/guestfs-actions.pod:8400
26043 msgid "(Added in 1.0.66)"
26044 msgstr ""
26045
26046 #. type: =head2
26047 #: ../src/guestfs-actions.pod:1860
26048 msgid "guestfs_egrepi"
26049 msgstr ""
26050
26051 #. type: verbatim
26052 #: ../src/guestfs-actions.pod:1862
26053 #, no-wrap
26054 msgid ""
26055 " char **\n"
26056 " guestfs_egrepi (guestfs_h *g,\n"
26057 "                 const char *regex,\n"
26058 "                 const char *path);\n"
26059 "\n"
26060 msgstr ""
26061
26062 #. type: =head2
26063 #: ../src/guestfs-actions.pod:1879
26064 msgid "guestfs_equal"
26065 msgstr ""
26066
26067 #. type: verbatim
26068 #: ../src/guestfs-actions.pod:1881
26069 #, no-wrap
26070 msgid ""
26071 " int\n"
26072 " guestfs_equal (guestfs_h *g,\n"
26073 "                const char *file1,\n"
26074 "                const char *file2);\n"
26075 "\n"
26076 msgstr ""
26077
26078 #. type: =head2
26079 #: ../src/guestfs-actions.pod:1895
26080 msgid "guestfs_exists"
26081 msgstr ""
26082
26083 #. type: verbatim
26084 #: ../src/guestfs-actions.pod:1897
26085 #, no-wrap
26086 msgid ""
26087 " int\n"
26088 " guestfs_exists (guestfs_h *g,\n"
26089 "                 const char *path);\n"
26090 "\n"
26091 msgstr ""
26092
26093 #. type: textblock
26094 #: ../src/guestfs-actions.pod:1904
26095 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
26096 msgstr ""
26097
26098 #. type: =head2
26099 #: ../src/guestfs-actions.pod:1910
26100 msgid "guestfs_fallocate"
26101 msgstr ""
26102
26103 #. type: verbatim
26104 #: ../src/guestfs-actions.pod:1912
26105 #, no-wrap
26106 msgid ""
26107 " int\n"
26108 " guestfs_fallocate (guestfs_h *g,\n"
26109 "                    const char *path,\n"
26110 "                    int len);\n"
26111 "\n"
26112 msgstr ""
26113
26114 #. type: textblock
26115 #: ../src/guestfs-actions.pod:1917
26116 msgid ""
26117 "I<This function is deprecated.> In new code, use the L</guestfs_fallocate64> "
26118 "call instead."
26119 msgstr ""
26120
26121 #. type: =head2
26122 #: ../src/guestfs-actions.pod:1936
26123 msgid "guestfs_fallocate64"
26124 msgstr ""
26125
26126 #. type: verbatim
26127 #: ../src/guestfs-actions.pod:1938
26128 #, no-wrap
26129 msgid ""
26130 " int\n"
26131 " guestfs_fallocate64 (guestfs_h *g,\n"
26132 "                      const char *path,\n"
26133 "                      int64_t len);\n"
26134 "\n"
26135 msgstr ""
26136
26137 #. type: textblock
26138 #: ../src/guestfs-actions.pod:1947
26139 msgid ""
26140 "Note that this call allocates disk blocks for the file.  To create a sparse "
26141 "file use C<guestfs_truncate_size> instead."
26142 msgstr ""
26143
26144 #. type: textblock
26145 #: ../src/guestfs-actions.pod:1950
26146 msgid ""
26147 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
26148 "oversight it only allowed 30 bit lengths to be specified, effectively "
26149 "limiting the maximum size of files created through that call to 1GB."
26150 msgstr ""
26151
26152 #. type: textblock
26153 #: ../src/guestfs-actions.pod:1961
26154 msgid "(Added in 1.3.17)"
26155 msgstr ""
26156
26157 #. type: =head2
26158 #: ../src/guestfs-actions.pod:1963
26159 msgid "guestfs_fgrep"
26160 msgstr ""
26161
26162 #. type: verbatim
26163 #: ../src/guestfs-actions.pod:1965
26164 #, no-wrap
26165 msgid ""
26166 " char **\n"
26167 " guestfs_fgrep (guestfs_h *g,\n"
26168 "                const char *pattern,\n"
26169 "                const char *path);\n"
26170 "\n"
26171 msgstr ""
26172
26173 #. type: =head2
26174 #: ../src/guestfs-actions.pod:1982
26175 msgid "guestfs_fgrepi"
26176 msgstr ""
26177
26178 #. type: verbatim
26179 #: ../src/guestfs-actions.pod:1984
26180 #, no-wrap
26181 msgid ""
26182 " char **\n"
26183 " guestfs_fgrepi (guestfs_h *g,\n"
26184 "                 const char *pattern,\n"
26185 "                 const char *path);\n"
26186 "\n"
26187 msgstr ""
26188
26189 #. type: =head2
26190 #: ../src/guestfs-actions.pod:2001
26191 msgid "guestfs_file"
26192 msgstr ""
26193
26194 #. type: verbatim
26195 #: ../src/guestfs-actions.pod:2003
26196 #, no-wrap
26197 msgid ""
26198 " char *\n"
26199 " guestfs_file (guestfs_h *g,\n"
26200 "               const char *path);\n"
26201 "\n"
26202 msgstr ""
26203
26204 #. type: textblock
26205 #: ../src/guestfs-actions.pod:2021
26206 msgid ""
26207 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
26208 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
26209 msgstr ""
26210
26211 #. type: =head2
26212 #: ../src/guestfs-actions.pod:2029
26213 msgid "guestfs_file_architecture"
26214 msgstr ""
26215
26216 #. type: verbatim
26217 #: ../src/guestfs-actions.pod:2031
26218 #, no-wrap
26219 msgid ""
26220 " char *\n"
26221 " guestfs_file_architecture (guestfs_h *g,\n"
26222 "                            const char *filename);\n"
26223 "\n"
26224 msgstr ""
26225
26226 #. type: textblock
26227 #: ../src/guestfs-actions.pod:2139 ../src/guestfs-actions.pod:2302 ../src/guestfs-actions.pod:2319 ../src/guestfs-actions.pod:3053 ../src/guestfs-actions.pod:3155 ../src/guestfs-actions.pod:3221 ../src/guestfs-actions.pod:3408 ../src/guestfs-actions.pod:3426 ../src/guestfs-actions.pod:3466 ../src/guestfs-actions.pod:3542 ../src/guestfs-actions.pod:3639 ../src/guestfs-actions.pod:3876 ../src/guestfs-actions.pod:4008
26228 msgid "(Added in 1.5.3)"
26229 msgstr ""
26230
26231 #. type: =head2
26232 #: ../src/guestfs-actions.pod:2141
26233 msgid "guestfs_filesize"
26234 msgstr ""
26235
26236 #. type: verbatim
26237 #: ../src/guestfs-actions.pod:2143
26238 #, no-wrap
26239 msgid ""
26240 " int64_t\n"
26241 " guestfs_filesize (guestfs_h *g,\n"
26242 "                   const char *file);\n"
26243 "\n"
26244 msgstr ""
26245
26246 #. type: textblock
26247 #: ../src/guestfs-actions.pod:2149
26248 msgid ""
26249 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
26250 "C<guestfs_is_dir>, C<guestfs_is_file> etc.  To get the size of block "
26251 "devices, use C<guestfs_blockdev_getsize64>."
26252 msgstr ""
26253
26254 #. type: textblock
26255 #: ../src/guestfs-actions.pod:2155
26256 msgid "(Added in 1.0.82)"
26257 msgstr ""
26258
26259 #. type: =head2
26260 #: ../src/guestfs-actions.pod:2157
26261 msgid "guestfs_fill"
26262 msgstr ""
26263
26264 #. type: verbatim
26265 #: ../src/guestfs-actions.pod:2159
26266 #, no-wrap
26267 msgid ""
26268 " int\n"
26269 " guestfs_fill (guestfs_h *g,\n"
26270 "               int c,\n"
26271 "               int len,\n"
26272 "               const char *path);\n"
26273 "\n"
26274 msgstr ""
26275
26276 #. type: textblock
26277 #: ../src/guestfs-actions.pod:2169
26278 msgid ""
26279 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
26280 "C<guestfs_truncate_size>.  To create a file with a pattern of repeating "
26281 "bytes use C<guestfs_fill_pattern>."
26282 msgstr ""
26283
26284 #. type: textblock
26285 #: ../src/guestfs-actions.pod:2181
26286 msgid "(Added in 1.0.79)"
26287 msgstr ""
26288
26289 #. type: =head2
26290 #: ../src/guestfs-actions.pod:2183
26291 msgid "guestfs_fill_pattern"
26292 msgstr ""
26293
26294 #. type: verbatim
26295 #: ../src/guestfs-actions.pod:2185
26296 #, no-wrap
26297 msgid ""
26298 " int\n"
26299 " guestfs_fill_pattern (guestfs_h *g,\n"
26300 "                       const char *pattern,\n"
26301 "                       int len,\n"
26302 "                       const char *path);\n"
26303 "\n"
26304 msgstr ""
26305
26306 #. type: textblock
26307 #: ../src/guestfs-actions.pod:2191
26308 msgid ""
26309 "This function is like C<guestfs_fill> except that it creates a new file of "
26310 "length C<len> containing the repeating pattern of bytes in C<pattern>.  The "
26311 "pattern is truncated if necessary to ensure the length of the file is "
26312 "exactly C<len> bytes."
26313 msgstr ""
26314
26315 #. type: textblock
26316 #: ../src/guestfs-actions.pod:2203
26317 msgid "(Added in 1.3.12)"
26318 msgstr ""
26319
26320 #. type: =head2
26321 #: ../src/guestfs-actions.pod:2205
26322 msgid "guestfs_find"
26323 msgstr ""
26324
26325 #. type: verbatim
26326 #: ../src/guestfs-actions.pod:2207
26327 #, no-wrap
26328 msgid ""
26329 " char **\n"
26330 " guestfs_find (guestfs_h *g,\n"
26331 "               const char *directory);\n"
26332 "\n"
26333 msgstr ""
26334
26335 #. type: textblock
26336 #: ../src/guestfs-actions.pod:2223
26337 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
26338 msgstr ""
26339
26340 #. type: textblock
26341 #: ../src/guestfs-actions.pod:2236
26342 msgid "See also C<guestfs_find0>."
26343 msgstr ""
26344
26345 #. type: textblock
26346 #: ../src/guestfs-actions.pod:2245 ../src/guestfs-actions.pod:4757 ../src/guestfs-actions.pod:6474
26347 msgid "(Added in 1.0.27)"
26348 msgstr ""
26349
26350 #. type: =head2
26351 #: ../src/guestfs-actions.pod:2247
26352 msgid "guestfs_find0"
26353 msgstr ""
26354
26355 #. type: verbatim
26356 #: ../src/guestfs-actions.pod:2249
26357 #, no-wrap
26358 msgid ""
26359 " int\n"
26360 " guestfs_find0 (guestfs_h *g,\n"
26361 "                const char *directory,\n"
26362 "                const char *files);\n"
26363 "\n"
26364 msgstr ""
26365
26366 #. type: textblock
26367 #: ../src/guestfs-actions.pod:2258
26368 msgid ""
26369 "This command works the same way as C<guestfs_find> with the following "
26370 "exceptions:"
26371 msgstr ""
26372
26373 #. type: textblock
26374 #: ../src/guestfs-actions.pod:2285
26375 msgid "(Added in 1.0.74)"
26376 msgstr ""
26377
26378 #. type: =head2
26379 #: ../src/guestfs-actions.pod:2287
26380 msgid "guestfs_findfs_label"
26381 msgstr ""
26382
26383 #. type: verbatim
26384 #: ../src/guestfs-actions.pod:2289
26385 #, no-wrap
26386 msgid ""
26387 " char *\n"
26388 " guestfs_findfs_label (guestfs_h *g,\n"
26389 "                       const char *label);\n"
26390 "\n"
26391 msgstr ""
26392
26393 #. type: textblock
26394 #: ../src/guestfs-actions.pod:2297
26395 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
26396 msgstr ""
26397
26398 #. type: =head2
26399 #: ../src/guestfs-actions.pod:2304
26400 msgid "guestfs_findfs_uuid"
26401 msgstr ""
26402
26403 #. type: verbatim
26404 #: ../src/guestfs-actions.pod:2306
26405 #, no-wrap
26406 msgid ""
26407 " char *\n"
26408 " guestfs_findfs_uuid (guestfs_h *g,\n"
26409 "                      const char *uuid);\n"
26410 "\n"
26411 msgstr ""
26412
26413 #. type: textblock
26414 #: ../src/guestfs-actions.pod:2314
26415 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
26416 msgstr ""
26417
26418 #. type: =head2
26419 #: ../src/guestfs-actions.pod:2321
26420 msgid "guestfs_fsck"
26421 msgstr ""
26422
26423 #. type: verbatim
26424 #: ../src/guestfs-actions.pod:2323
26425 #, no-wrap
26426 msgid ""
26427 " int\n"
26428 " guestfs_fsck (guestfs_h *g,\n"
26429 "               const char *fstype,\n"
26430 "               const char *device);\n"
26431 "\n"
26432 msgstr ""
26433
26434 #. type: textblock
26435 #: ../src/guestfs-actions.pod:2358 ../src/guestfs-actions.pod:8253
26436 msgid "(Added in 1.0.16)"
26437 msgstr ""
26438
26439 #. type: =head2
26440 #: ../src/guestfs-actions.pod:2360
26441 msgid "guestfs_get_append"
26442 msgstr ""
26443
26444 #. type: verbatim
26445 #: ../src/guestfs-actions.pod:2362
26446 #, no-wrap
26447 msgid ""
26448 " const char *\n"
26449 " guestfs_get_append (guestfs_h *g);\n"
26450 "\n"
26451 msgstr ""
26452
26453 #. type: textblock
26454 #: ../src/guestfs-actions.pod:2370
26455 msgid ""
26456 "This function returns a string which may be NULL.  There is no way to return "
26457 "an error from this function.  The string is owned by the guest handle and "
26458 "must I<not> be freed."
26459 msgstr ""
26460
26461 #. type: textblock
26462 #: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:6152 ../src/guestfs-actions.pod:6631 ../src/guestfs-actions.pod:7080 ../src/guestfs-actions.pod:7099 ../src/guestfs-actions.pod:7115 ../src/guestfs-actions.pod:7139 ../src/guestfs-actions.pod:7893 ../src/guestfs-actions.pod:7908 ../src/guestfs-actions.pod:8297
26463 msgid "(Added in 1.0.26)"
26464 msgstr ""
26465
26466 #. type: =head2
26467 #: ../src/guestfs-actions.pod:2376
26468 msgid "guestfs_get_attach_method"
26469 msgstr ""
26470
26471 #. type: verbatim
26472 #: ../src/guestfs-actions.pod:2378
26473 #, no-wrap
26474 msgid ""
26475 " char *\n"
26476 " guestfs_get_attach_method (guestfs_h *g);\n"
26477 "\n"
26478 msgstr ""
26479
26480 #. type: textblock
26481 #: ../src/guestfs-actions.pod:2381
26482 msgid "Return the current attach method.  See C<guestfs_set_attach_method>."
26483 msgstr ""
26484
26485 #. type: textblock
26486 #: ../src/guestfs-actions.pod:2386 ../src/guestfs-actions.pod:6661
26487 msgid "(Added in 1.9.8)"
26488 msgstr ""
26489
26490 #. type: =head2
26491 #: ../src/guestfs-actions.pod:2388
26492 msgid "guestfs_get_autosync"
26493 msgstr ""
26494
26495 #. type: verbatim
26496 #: ../src/guestfs-actions.pod:2390
26497 #, no-wrap
26498 msgid ""
26499 " int\n"
26500 " guestfs_get_autosync (guestfs_h *g);\n"
26501 "\n"
26502 msgstr ""
26503
26504 #. type: =head2
26505 #: ../src/guestfs-actions.pod:2399
26506 msgid "guestfs_get_direct"
26507 msgstr ""
26508
26509 #. type: verbatim
26510 #: ../src/guestfs-actions.pod:2401
26511 #, no-wrap
26512 msgid ""
26513 " int\n"
26514 " guestfs_get_direct (guestfs_h *g);\n"
26515 "\n"
26516 msgstr ""
26517
26518 #. type: textblock
26519 #: ../src/guestfs-actions.pod:2408 ../src/guestfs-actions.pod:6702
26520 msgid "(Added in 1.0.72)"
26521 msgstr ""
26522
26523 #. type: =head2
26524 #: ../src/guestfs-actions.pod:2410
26525 msgid "guestfs_get_e2label"
26526 msgstr ""
26527
26528 #. type: verbatim
26529 #: ../src/guestfs-actions.pod:2412
26530 #, no-wrap
26531 msgid ""
26532 " char *\n"
26533 " guestfs_get_e2label (guestfs_h *g,\n"
26534 "                      const char *device);\n"
26535 "\n"
26536 msgstr ""
26537
26538 #. type: textblock
26539 #: ../src/guestfs-actions.pod:2416
26540 msgid ""
26541 "I<This function is deprecated.> In new code, use the L</guestfs_vfs_label> "
26542 "call instead."
26543 msgstr ""
26544
26545 #. type: textblock
26546 #: ../src/guestfs-actions.pod:2429 ../src/guestfs-actions.pod:2450 ../src/guestfs-actions.pod:6720 ../src/guestfs-actions.pod:6739
26547 msgid "(Added in 1.0.15)"
26548 msgstr ""
26549
26550 #. type: =head2
26551 #: ../src/guestfs-actions.pod:2431
26552 msgid "guestfs_get_e2uuid"
26553 msgstr ""
26554
26555 #. type: verbatim
26556 #: ../src/guestfs-actions.pod:2433
26557 #, no-wrap
26558 msgid ""
26559 " char *\n"
26560 " guestfs_get_e2uuid (guestfs_h *g,\n"
26561 "                     const char *device);\n"
26562 "\n"
26563 msgstr ""
26564
26565 #. type: textblock
26566 #: ../src/guestfs-actions.pod:2437
26567 msgid ""
26568 "I<This function is deprecated.> In new code, use the L</guestfs_vfs_uuid> "
26569 "call instead."
26570 msgstr ""
26571
26572 #. type: =head2
26573 #: ../src/guestfs-actions.pod:2452
26574 msgid "guestfs_get_memsize"
26575 msgstr ""
26576
26577 #. type: verbatim
26578 #: ../src/guestfs-actions.pod:2454
26579 #, no-wrap
26580 msgid ""
26581 " int\n"
26582 " guestfs_get_memsize (guestfs_h *g);\n"
26583 "\n"
26584 msgstr ""
26585
26586 #. type: textblock
26587 #: ../src/guestfs-actions.pod:2460
26588 msgid ""
26589 "If C<guestfs_set_memsize> was not called on this handle, and if "
26590 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
26591 "value for memsize."
26592 msgstr ""
26593
26594 #. type: textblock
26595 #: ../src/guestfs-actions.pod:2469 ../src/guestfs-actions.pod:5048 ../src/guestfs-actions.pod:5257 ../src/guestfs-actions.pod:5276 ../src/guestfs-actions.pod:5295 ../src/guestfs-actions.pod:5307 ../src/guestfs-actions.pod:5324 ../src/guestfs-actions.pod:5337 ../src/guestfs-actions.pod:6377 ../src/guestfs-actions.pod:6760 ../src/guestfs-actions.pod:7050 ../src/guestfs-actions.pod:7662
26596 msgid "(Added in 1.0.55)"
26597 msgstr ""
26598
26599 #. type: =head2
26600 #: ../src/guestfs-actions.pod:2471
26601 msgid "guestfs_get_network"
26602 msgstr ""
26603
26604 #. type: verbatim
26605 #: ../src/guestfs-actions.pod:2473
26606 #, no-wrap
26607 msgid ""
26608 " int\n"
26609 " guestfs_get_network (guestfs_h *g);\n"
26610 "\n"
26611 msgstr ""
26612
26613 #. type: textblock
26614 #: ../src/guestfs-actions.pod:2480 ../src/guestfs-actions.pod:6779
26615 msgid "(Added in 1.5.4)"
26616 msgstr ""
26617
26618 #. type: =head2
26619 #: ../src/guestfs-actions.pod:2482
26620 msgid "guestfs_get_path"
26621 msgstr ""
26622
26623 #. type: verbatim
26624 #: ../src/guestfs-actions.pod:2484
26625 #, no-wrap
26626 msgid ""
26627 " const char *\n"
26628 " guestfs_get_path (guestfs_h *g);\n"
26629 "\n"
26630 msgstr ""
26631
26632 #. type: textblock
26633 #: ../src/guestfs-actions.pod:2492 ../src/guestfs-actions.pod:2532
26634 msgid ""
26635 "This function returns a string, or NULL on error.  The string is owned by "
26636 "the guest handle and must I<not> be freed."
26637 msgstr ""
26638
26639 #. type: =head2
26640 #: ../src/guestfs-actions.pod:2497
26641 msgid "guestfs_get_pgroup"
26642 msgstr ""
26643
26644 #. type: verbatim
26645 #: ../src/guestfs-actions.pod:2499
26646 #, no-wrap
26647 msgid ""
26648 " int\n"
26649 " guestfs_get_pgroup (guestfs_h *g);\n"
26650 "\n"
26651 msgstr ""
26652
26653 #. type: textblock
26654 #: ../src/guestfs-actions.pod:2506 ../src/guestfs-actions.pod:6815 ../src/guestfs-actions.pod:8154
26655 msgid "(Added in 1.11.18)"
26656 msgstr ""
26657
26658 #. type: =head2
26659 #: ../src/guestfs-actions.pod:2508
26660 msgid "guestfs_get_pid"
26661 msgstr ""
26662
26663 #. type: verbatim
26664 #: ../src/guestfs-actions.pod:2510
26665 #, no-wrap
26666 msgid ""
26667 " int\n"
26668 " guestfs_get_pid (guestfs_h *g);\n"
26669 "\n"
26670 msgstr ""
26671
26672 #. type: textblock
26673 #: ../src/guestfs-actions.pod:2520
26674 msgid "(Added in 1.0.56)"
26675 msgstr ""
26676
26677 #. type: =head2
26678 #: ../src/guestfs-actions.pod:2522
26679 msgid "guestfs_get_qemu"
26680 msgstr ""
26681
26682 #. type: verbatim
26683 #: ../src/guestfs-actions.pod:2524
26684 #, no-wrap
26685 msgid ""
26686 " const char *\n"
26687 " guestfs_get_qemu (guestfs_h *g);\n"
26688 "\n"
26689 msgstr ""
26690
26691 #. type: textblock
26692 #: ../src/guestfs-actions.pod:2535 ../src/guestfs-actions.pod:6843
26693 msgid "(Added in 1.0.6)"
26694 msgstr ""
26695
26696 #. type: =head2
26697 #: ../src/guestfs-actions.pod:2537
26698 msgid "guestfs_get_recovery_proc"
26699 msgstr ""
26700
26701 #. type: verbatim
26702 #: ../src/guestfs-actions.pod:2539
26703 #, no-wrap
26704 msgid ""
26705 " int\n"
26706 " guestfs_get_recovery_proc (guestfs_h *g);\n"
26707 "\n"
26708 msgstr ""
26709
26710 #. type: textblock
26711 #: ../src/guestfs-actions.pod:2546 ../src/guestfs-actions.pod:4130 ../src/guestfs-actions.pod:4461 ../src/guestfs-actions.pod:4855 ../src/guestfs-actions.pod:4887 ../src/guestfs-actions.pod:6082 ../src/guestfs-actions.pod:6425 ../src/guestfs-actions.pod:6867 ../src/guestfs-actions.pod:7565 ../src/guestfs-actions.pod:7585 ../src/guestfs-actions.pod:7777
26712 msgid "(Added in 1.0.77)"
26713 msgstr ""
26714
26715 #. type: =head2
26716 #: ../src/guestfs-actions.pod:2548
26717 msgid "guestfs_get_selinux"
26718 msgstr ""
26719
26720 #. type: verbatim
26721 #: ../src/guestfs-actions.pod:2550
26722 #, no-wrap
26723 msgid ""
26724 " int\n"
26725 " guestfs_get_selinux (guestfs_h *g);\n"
26726 "\n"
26727 msgstr ""
26728
26729 #. type: textblock
26730 #: ../src/guestfs-actions.pod:2553
26731 msgid ""
26732 "This returns the current setting of the selinux flag which is passed to the "
26733 "appliance at boot time.  See C<guestfs_set_selinux>."
26734 msgstr ""
26735
26736 #. type: textblock
26737 #: ../src/guestfs-actions.pod:2561 ../src/guestfs-actions.pod:2635 ../src/guestfs-actions.pod:6886 ../src/guestfs-actions.pod:6960
26738 msgid "(Added in 1.0.67)"
26739 msgstr ""
26740
26741 #. type: =head2
26742 #: ../src/guestfs-actions.pod:2563
26743 msgid "guestfs_get_smp"
26744 msgstr ""
26745
26746 #. type: verbatim
26747 #: ../src/guestfs-actions.pod:2565
26748 #, no-wrap
26749 msgid ""
26750 " int\n"
26751 " guestfs_get_smp (guestfs_h *g);\n"
26752 "\n"
26753 msgstr ""
26754
26755 #. type: =head2
26756 #: ../src/guestfs-actions.pod:2574
26757 msgid "guestfs_get_state"
26758 msgstr ""
26759
26760 #. type: verbatim
26761 #: ../src/guestfs-actions.pod:2576
26762 #, no-wrap
26763 msgid ""
26764 " int\n"
26765 " guestfs_get_state (guestfs_h *g);\n"
26766 "\n"
26767 msgstr ""
26768
26769 #. type: =head2
26770 #: ../src/guestfs-actions.pod:2588
26771 msgid "guestfs_get_trace"
26772 msgstr ""
26773
26774 #. type: verbatim
26775 #: ../src/guestfs-actions.pod:2590
26776 #, no-wrap
26777 msgid ""
26778 " int\n"
26779 " guestfs_get_trace (guestfs_h *g);\n"
26780 "\n"
26781 msgstr ""
26782
26783 #. type: =head2
26784 #: ../src/guestfs-actions.pod:2599
26785 msgid "guestfs_get_umask"
26786 msgstr ""
26787
26788 #. type: verbatim
26789 #: ../src/guestfs-actions.pod:2601
26790 #, no-wrap
26791 msgid ""
26792 " int\n"
26793 " guestfs_get_umask (guestfs_h *g);\n"
26794 "\n"
26795 msgstr ""
26796
26797 #. type: textblock
26798 #: ../src/guestfs-actions.pod:2604
26799 msgid ""
26800 "Return the current umask.  By default the umask is C<022> unless it has been "
26801 "set by calling C<guestfs_umask>."
26802 msgstr ""
26803
26804 #. type: =head2
26805 #: ../src/guestfs-actions.pod:2611
26806 msgid "guestfs_get_verbose"
26807 msgstr ""
26808
26809 #. type: verbatim
26810 #: ../src/guestfs-actions.pod:2613
26811 #, no-wrap
26812 msgid ""
26813 " int\n"
26814 " guestfs_get_verbose (guestfs_h *g);\n"
26815 "\n"
26816 msgstr ""
26817
26818 #. type: =head2
26819 #: ../src/guestfs-actions.pod:2622
26820 msgid "guestfs_getcon"
26821 msgstr ""
26822
26823 #. type: verbatim
26824 #: ../src/guestfs-actions.pod:2624
26825 #, no-wrap
26826 msgid ""
26827 " char *\n"
26828 " guestfs_getcon (guestfs_h *g);\n"
26829 "\n"
26830 msgstr ""
26831
26832 #. type: textblock
26833 #: ../src/guestfs-actions.pod:2629
26834 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
26835 msgstr ""
26836
26837 #. type: =head2
26838 #: ../src/guestfs-actions.pod:2637
26839 msgid "guestfs_getxattr"
26840 msgstr ""
26841
26842 #. type: verbatim
26843 #: ../src/guestfs-actions.pod:2639
26844 #, no-wrap
26845 msgid ""
26846 " char *\n"
26847 " guestfs_getxattr (guestfs_h *g,\n"
26848 "                   const char *path,\n"
26849 "                   const char *name,\n"
26850 "                   size_t *size_r);\n"
26851 "\n"
26852 msgstr ""
26853
26854 #. type: textblock
26855 #: ../src/guestfs-actions.pod:2645
26856 msgid ""
26857 "Get a single extended attribute from file C<path> named C<name>.  This call "
26858 "follows symlinks.  If you want to lookup an extended attribute for the "
26859 "symlink itself, use C<guestfs_lgetxattr>."
26860 msgstr ""
26861
26862 #. type: textblock
26863 #: ../src/guestfs-actions.pod:2649 ../src/guestfs-actions.pod:4144
26864 msgid ""
26865 "Normally it is better to get all extended attributes from a file in one go "
26866 "by calling C<guestfs_getxattrs>.  However some Linux filesystem "
26867 "implementations are buggy and do not provide a way to list out attributes.  "
26868 "For these filesystems (notably ntfs-3g)  you have to know the names of the "
26869 "extended attributes you want in advance and call this function."
26870 msgstr ""
26871
26872 #. type: textblock
26873 #: ../src/guestfs-actions.pod:2659
26874 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
26875 msgstr ""
26876
26877 #. type: textblock
26878 #: ../src/guestfs-actions.pod:2661 ../src/guestfs-actions.pod:2874 ../src/guestfs-actions.pod:3356 ../src/guestfs-actions.pod:4156 ../src/guestfs-actions.pod:6075 ../src/guestfs-actions.pod:6101 ../src/guestfs-actions.pod:6282
26879 msgid ""
26880 "This function returns a buffer, or NULL on error.  The size of the returned "
26881 "buffer is written to C<*size_r>.  I<The caller must free the returned buffer "
26882 "after use>."
26883 msgstr ""
26884
26885 #. type: textblock
26886 #: ../src/guestfs-actions.pod:2665 ../src/guestfs-actions.pod:4160
26887 msgid "(Added in 1.7.24)"
26888 msgstr ""
26889
26890 #. type: =head2
26891 #: ../src/guestfs-actions.pod:2667
26892 msgid "guestfs_getxattrs"
26893 msgstr ""
26894
26895 #. type: verbatim
26896 #: ../src/guestfs-actions.pod:2669
26897 #, no-wrap
26898 msgid ""
26899 " struct guestfs_xattr_list *\n"
26900 " guestfs_getxattrs (guestfs_h *g,\n"
26901 "                    const char *path);\n"
26902 "\n"
26903 msgstr ""
26904
26905 #. type: textblock
26906 #: ../src/guestfs-actions.pod:2679
26907 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
26908 msgstr ""
26909
26910 #. type: textblock
26911 #: ../src/guestfs-actions.pod:2681 ../src/guestfs-actions.pod:4172 ../src/guestfs-actions.pod:4851
26912 msgid ""
26913 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
26914 "an error.  I<The caller must call C<guestfs_free_xattr_list> after use>."
26915 msgstr ""
26916
26917 #. type: textblock
26918 #: ../src/guestfs-actions.pod:2685 ../src/guestfs-actions.pod:4176 ../src/guestfs-actions.pod:4375 ../src/guestfs-actions.pod:4411 ../src/guestfs-actions.pod:6455 ../src/guestfs-actions.pod:6979 ../src/guestfs-actions.pod:8362
26919 msgid "(Added in 1.0.59)"
26920 msgstr ""
26921
26922 #. type: =head2
26923 #: ../src/guestfs-actions.pod:2687
26924 msgid "guestfs_glob_expand"
26925 msgstr ""
26926
26927 #. type: verbatim
26928 #: ../src/guestfs-actions.pod:2689
26929 #, no-wrap
26930 msgid ""
26931 " char **\n"
26932 " guestfs_glob_expand (guestfs_h *g,\n"
26933 "                      const char *pattern);\n"
26934 "\n"
26935 msgstr ""
26936
26937 #. type: textblock
26938 #: ../src/guestfs-actions.pod:2708 ../src/guestfs-actions.pod:7163 ../src/guestfs-actions.pod:7180
26939 msgid "(Added in 1.0.50)"
26940 msgstr ""
26941
26942 #. type: =head2
26943 #: ../src/guestfs-actions.pod:2710
26944 msgid "guestfs_grep"
26945 msgstr ""
26946
26947 #. type: verbatim
26948 #: ../src/guestfs-actions.pod:2712
26949 #, no-wrap
26950 msgid ""
26951 " char **\n"
26952 " guestfs_grep (guestfs_h *g,\n"
26953 "               const char *regex,\n"
26954 "               const char *path);\n"
26955 "\n"
26956 msgstr ""
26957
26958 #. type: =head2
26959 #: ../src/guestfs-actions.pod:2729
26960 msgid "guestfs_grepi"
26961 msgstr ""
26962
26963 #. type: verbatim
26964 #: ../src/guestfs-actions.pod:2731
26965 #, no-wrap
26966 msgid ""
26967 " char **\n"
26968 " guestfs_grepi (guestfs_h *g,\n"
26969 "                const char *regex,\n"
26970 "                const char *path);\n"
26971 "\n"
26972 msgstr ""
26973
26974 #. type: =head2
26975 #: ../src/guestfs-actions.pod:2748
26976 msgid "guestfs_grub_install"
26977 msgstr ""
26978
26979 #. type: verbatim
26980 #: ../src/guestfs-actions.pod:2750
26981 #, no-wrap
26982 msgid ""
26983 " int\n"
26984 " guestfs_grub_install (guestfs_h *g,\n"
26985 "                       const char *root,\n"
26986 "                       const char *device);\n"
26987 "\n"
26988 msgstr ""
26989
26990 #. type: textblock
26991 #: ../src/guestfs-actions.pod:2793
26992 msgid "(Added in 1.0.17)"
26993 msgstr ""
26994
26995 #. type: =head2
26996 #: ../src/guestfs-actions.pod:2795
26997 msgid "guestfs_head"
26998 msgstr ""
26999
27000 #. type: verbatim
27001 #: ../src/guestfs-actions.pod:2797
27002 #, no-wrap
27003 msgid ""
27004 " char **\n"
27005 " guestfs_head (guestfs_h *g,\n"
27006 "               const char *path);\n"
27007 "\n"
27008 msgstr ""
27009
27010 #. type: =head2
27011 #: ../src/guestfs-actions.pod:2813
27012 msgid "guestfs_head_n"
27013 msgstr ""
27014
27015 #. type: verbatim
27016 #: ../src/guestfs-actions.pod:2815
27017 #, no-wrap
27018 msgid ""
27019 " char **\n"
27020 " guestfs_head_n (guestfs_h *g,\n"
27021 "                 int nrlines,\n"
27022 "                 const char *path);\n"
27023 "\n"
27024 msgstr ""
27025
27026 #. type: =head2
27027 #: ../src/guestfs-actions.pod:2837
27028 msgid "guestfs_hexdump"
27029 msgstr ""
27030
27031 #. type: verbatim
27032 #: ../src/guestfs-actions.pod:2839
27033 #, no-wrap
27034 msgid ""
27035 " char *\n"
27036 " guestfs_hexdump (guestfs_h *g,\n"
27037 "                  const char *path);\n"
27038 "\n"
27039 msgstr ""
27040
27041 #. type: textblock
27042 #: ../src/guestfs-actions.pod:2852 ../src/guestfs-actions.pod:7244 ../src/guestfs-actions.pod:7299
27043 msgid "(Added in 1.0.22)"
27044 msgstr ""
27045
27046 #. type: =head2
27047 #: ../src/guestfs-actions.pod:2854
27048 msgid "guestfs_initrd_cat"
27049 msgstr ""
27050
27051 #. type: verbatim
27052 #: ../src/guestfs-actions.pod:2856
27053 #, no-wrap
27054 msgid ""
27055 " char *\n"
27056 " guestfs_initrd_cat (guestfs_h *g,\n"
27057 "                     const char *initrdpath,\n"
27058 "                     const char *filename,\n"
27059 "                     size_t *size_r);\n"
27060 "\n"
27061 msgstr ""
27062
27063 #. type: textblock
27064 #: ../src/guestfs-actions.pod:2872
27065 msgid "See also C<guestfs_initrd_list>."
27066 msgstr ""
27067
27068 #. type: =head2
27069 #: ../src/guestfs-actions.pod:2883
27070 msgid "guestfs_initrd_list"
27071 msgstr ""
27072
27073 #. type: verbatim
27074 #: ../src/guestfs-actions.pod:2885
27075 #, no-wrap
27076 msgid ""
27077 " char **\n"
27078 " guestfs_initrd_list (guestfs_h *g,\n"
27079 "                      const char *path);\n"
27080 "\n"
27081 msgstr ""
27082
27083 #. type: =head2
27084 #: ../src/guestfs-actions.pod:2905
27085 msgid "guestfs_inotify_add_watch"
27086 msgstr ""
27087
27088 #. type: verbatim
27089 #: ../src/guestfs-actions.pod:2907
27090 #, no-wrap
27091 msgid ""
27092 " int64_t\n"
27093 " guestfs_inotify_add_watch (guestfs_h *g,\n"
27094 "                            const char *path,\n"
27095 "                            int mask);\n"
27096 "\n"
27097 msgstr ""
27098
27099 #. type: =head2
27100 #: ../src/guestfs-actions.pod:2926
27101 msgid "guestfs_inotify_close"
27102 msgstr ""
27103
27104 #. type: verbatim
27105 #: ../src/guestfs-actions.pod:2928
27106 #, no-wrap
27107 msgid ""
27108 " int\n"
27109 " guestfs_inotify_close (guestfs_h *g);\n"
27110 "\n"
27111 msgstr ""
27112
27113 #. type: =head2
27114 #: ../src/guestfs-actions.pod:2939
27115 msgid "guestfs_inotify_files"
27116 msgstr ""
27117
27118 #. type: verbatim
27119 #: ../src/guestfs-actions.pod:2941
27120 #, no-wrap
27121 msgid ""
27122 " char **\n"
27123 " guestfs_inotify_files (guestfs_h *g);\n"
27124 "\n"
27125 msgstr ""
27126
27127 #. type: textblock
27128 #: ../src/guestfs-actions.pod:2944
27129 msgid ""
27130 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
27131 "returns a list of pathnames of objects that were touched.  The returned "
27132 "pathnames are sorted and deduplicated."
27133 msgstr ""
27134
27135 #. type: =head2
27136 #: ../src/guestfs-actions.pod:2954
27137 msgid "guestfs_inotify_init"
27138 msgstr ""
27139
27140 #. type: verbatim
27141 #: ../src/guestfs-actions.pod:2956
27142 #, no-wrap
27143 msgid ""
27144 " int\n"
27145 " guestfs_inotify_init (guestfs_h *g,\n"
27146 "                       int maxevents);\n"
27147 "\n"
27148 msgstr ""
27149
27150 #. type: textblock
27151 #: ../src/guestfs-actions.pod:2964
27152 msgid ""
27153 "C<maxevents> is the maximum number of events which will be queued up between "
27154 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>.  If this is "
27155 "passed as C<0>, then the kernel (or previously set)  default is used.  For "
27156 "Linux 2.6.29 the default was 16384 events.  Beyond this limit, the kernel "
27157 "throws away events, but records the fact that it threw them away by setting "
27158 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
27159 "C<guestfs_inotify_read>)."
27160 msgstr ""
27161
27162 #. type: textblock
27163 #: ../src/guestfs-actions.pod:2974
27164 msgid ""
27165 "Before any events are generated, you have to add some watches to the "
27166 "internal watch list.  See: C<guestfs_inotify_add_watch>, "
27167 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
27168 msgstr ""
27169
27170 #. type: textblock
27171 #: ../src/guestfs-actions.pod:2980
27172 msgid ""
27173 "Queued up events should be read periodically by calling "
27174 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
27175 "wrapper around C<guestfs_inotify_read>).  If you don't read the events out "
27176 "often enough then you risk the internal queue overflowing."
27177 msgstr ""
27178
27179 #. type: textblock
27180 #: ../src/guestfs-actions.pod:2987
27181 msgid ""
27182 "The handle should be closed after use by calling C<guestfs_inotify_close>.  "
27183 "This also removes any watches automatically."
27184 msgstr ""
27185
27186 #. type: =head2
27187 #: ../src/guestfs-actions.pod:3000
27188 msgid "guestfs_inotify_read"
27189 msgstr ""
27190
27191 #. type: verbatim
27192 #: ../src/guestfs-actions.pod:3002
27193 #, no-wrap
27194 msgid ""
27195 " struct guestfs_inotify_event_list *\n"
27196 " guestfs_inotify_read (guestfs_h *g);\n"
27197 "\n"
27198 msgstr ""
27199
27200 #. type: textblock
27201 #: ../src/guestfs-actions.pod:3016
27202 msgid ""
27203 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
27204 "there was an error.  I<The caller must call "
27205 "C<guestfs_free_inotify_event_list> after use>."
27206 msgstr ""
27207
27208 #. type: =head2
27209 #: ../src/guestfs-actions.pod:3022
27210 msgid "guestfs_inotify_rm_watch"
27211 msgstr ""
27212
27213 #. type: verbatim
27214 #: ../src/guestfs-actions.pod:3024
27215 #, no-wrap
27216 msgid ""
27217 " int\n"
27218 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
27219 "                           int wd);\n"
27220 "\n"
27221 msgstr ""
27222
27223 #. type: textblock
27224 #: ../src/guestfs-actions.pod:3028
27225 msgid ""
27226 "Remove a previously defined inotify watch.  See "
27227 "C<guestfs_inotify_add_watch>."
27228 msgstr ""
27229
27230 #. type: =head2
27231 #: ../src/guestfs-actions.pod:3035
27232 msgid "guestfs_inspect_get_arch"
27233 msgstr ""
27234
27235 #. type: verbatim
27236 #: ../src/guestfs-actions.pod:3037
27237 #, no-wrap
27238 msgid ""
27239 " char *\n"
27240 " guestfs_inspect_get_arch (guestfs_h *g,\n"
27241 "                           const char *root);\n"
27242 "\n"
27243 msgstr ""
27244
27245 #. type: textblock
27246 #: ../src/guestfs-actions.pod:3041
27247 msgid ""
27248 "This returns the architecture of the inspected operating system.  The "
27249 "possible return values are listed under C<guestfs_file_architecture>."
27250 msgstr ""
27251
27252 #. type: =head2
27253 #: ../src/guestfs-actions.pod:3055
27254 msgid "guestfs_inspect_get_distro"
27255 msgstr ""
27256
27257 #. type: verbatim
27258 #: ../src/guestfs-actions.pod:3057
27259 #, no-wrap
27260 msgid ""
27261 " char *\n"
27262 " guestfs_inspect_get_distro (guestfs_h *g,\n"
27263 "                             const char *root);\n"
27264 "\n"
27265 msgstr ""
27266
27267 #. type: =head2
27268 #: ../src/guestfs-actions.pod:3157
27269 msgid "guestfs_inspect_get_drive_mappings"
27270 msgstr ""
27271
27272 #. type: verbatim
27273 #: ../src/guestfs-actions.pod:3159
27274 #, no-wrap
27275 msgid ""
27276 " char **\n"
27277 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
27278 "                                     const char *root);\n"
27279 "\n"
27280 msgstr ""
27281
27282 #. type: textblock
27283 #: ../src/guestfs-actions.pod:3188
27284 msgid ""
27285 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
27286 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
27287 msgstr ""
27288
27289 #. type: textblock
27290 #: ../src/guestfs-actions.pod:3192 ../src/guestfs-actions.pod:3460 ../src/guestfs-actions.pod:4263 ../src/guestfs-actions.pod:5526 ../src/guestfs-actions.pod:7601
27291 msgid ""
27292 "This function returns a NULL-terminated array of strings, or NULL if there "
27293 "was an error.  The array of strings will always have length C<2n+1>, where "
27294 "C<n> keys and values alternate, followed by the trailing NULL entry.  I<The "
27295 "caller must free the strings and the array after use>."
27296 msgstr ""
27297
27298 #. type: textblock
27299 #: ../src/guestfs-actions.pod:3198 ../src/guestfs-actions.pod:3659
27300 msgid "(Added in 1.9.17)"
27301 msgstr ""
27302
27303 #. type: =head2
27304 #: ../src/guestfs-actions.pod:3200
27305 msgid "guestfs_inspect_get_filesystems"
27306 msgstr ""
27307
27308 #. type: verbatim
27309 #: ../src/guestfs-actions.pod:3202
27310 #, no-wrap
27311 msgid ""
27312 " char **\n"
27313 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
27314 "                                  const char *root);\n"
27315 "\n"
27316 msgstr ""
27317
27318 #. type: textblock
27319 #: ../src/guestfs-actions.pod:3214
27320 msgid ""
27321 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
27322 "C<guestfs_inspect_get_mountpoints>."
27323 msgstr ""
27324
27325 #. type: =head2
27326 #: ../src/guestfs-actions.pod:3223
27327 msgid "guestfs_inspect_get_format"
27328 msgstr ""
27329
27330 #. type: verbatim
27331 #: ../src/guestfs-actions.pod:3225
27332 #, no-wrap
27333 msgid ""
27334 " char *\n"
27335 " guestfs_inspect_get_format (guestfs_h *g,\n"
27336 "                             const char *root);\n"
27337 "\n"
27338 msgstr ""
27339
27340 #. type: textblock
27341 #: ../src/guestfs-actions.pod:3259 ../src/guestfs-actions.pod:3695 ../src/guestfs-actions.pod:3711 ../src/guestfs-actions.pod:3729 ../src/guestfs-actions.pod:6493
27342 msgid "(Added in 1.9.4)"
27343 msgstr ""
27344
27345 #. type: =head2
27346 #: ../src/guestfs-actions.pod:3261
27347 msgid "guestfs_inspect_get_hostname"
27348 msgstr ""
27349
27350 #. type: verbatim
27351 #: ../src/guestfs-actions.pod:3263
27352 #, no-wrap
27353 msgid ""
27354 " char *\n"
27355 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
27356 "                               const char *root);\n"
27357 "\n"
27358 msgstr ""
27359
27360 #. type: textblock
27361 #: ../src/guestfs-actions.pod:3278
27362 msgid "(Added in 1.7.9)"
27363 msgstr ""
27364
27365 #. type: =head2
27366 #: ../src/guestfs-actions.pod:3280
27367 msgid "guestfs_inspect_get_icon"
27368 msgstr ""
27369
27370 #. type: verbatim
27371 #: ../src/guestfs-actions.pod:3282
27372 #, no-wrap
27373 msgid ""
27374 " char *\n"
27375 " guestfs_inspect_get_icon (guestfs_h *g,\n"
27376 "                           const char *root,\n"
27377 "                           size_t *size_r,\n"
27378 "                           ...);\n"
27379 "\n"
27380 msgstr ""
27381
27382 #. type: verbatim
27383 #: ../src/guestfs-actions.pod:3293
27384 #, no-wrap
27385 msgid ""
27386 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
27387 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
27388 "\n"
27389 msgstr ""
27390
27391 #. type: textblock
27392 #: ../src/guestfs-actions.pod:3360 ../src/guestfs-actions.pod:4190 ../src/guestfs-actions.pod:5425
27393 msgid "(Added in 1.11.12)"
27394 msgstr ""
27395
27396 #. type: =head2
27397 #: ../src/guestfs-actions.pod:3362
27398 msgid "guestfs_inspect_get_icon_va"
27399 msgstr ""
27400
27401 #. type: verbatim
27402 #: ../src/guestfs-actions.pod:3364
27403 #, no-wrap
27404 msgid ""
27405 " char *\n"
27406 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
27407 "                              const char *root,\n"
27408 "                              size_t *size_r,\n"
27409 "                              va_list args);\n"
27410 "\n"
27411 msgstr ""
27412
27413 #. type: textblock
27414 #: ../src/guestfs-actions.pod:3370
27415 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
27416 msgstr ""
27417
27418 #. type: =head2
27419 #: ../src/guestfs-actions.pod:3374
27420 msgid "guestfs_inspect_get_icon_argv"
27421 msgstr ""
27422
27423 #. type: verbatim
27424 #: ../src/guestfs-actions.pod:3376
27425 #, no-wrap
27426 msgid ""
27427 " char *\n"
27428 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
27429 "                                const char *root,\n"
27430 "                                size_t *size_r,\n"
27431 "                                const struct guestfs_inspect_get_icon_argv "
27432 "*optargs);\n"
27433 "\n"
27434 msgstr ""
27435
27436 #. type: textblock
27437 #: ../src/guestfs-actions.pod:3382
27438 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
27439 msgstr ""
27440
27441 #. type: =head2
27442 #: ../src/guestfs-actions.pod:3386
27443 msgid "guestfs_inspect_get_major_version"
27444 msgstr ""
27445
27446 #. type: verbatim
27447 #: ../src/guestfs-actions.pod:3388
27448 #, no-wrap
27449 msgid ""
27450 " int\n"
27451 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
27452 "                                    const char *root);\n"
27453 "\n"
27454 msgstr ""
27455
27456 #. type: =head2
27457 #: ../src/guestfs-actions.pod:3410
27458 msgid "guestfs_inspect_get_minor_version"
27459 msgstr ""
27460
27461 #. type: verbatim
27462 #: ../src/guestfs-actions.pod:3412
27463 #, no-wrap
27464 msgid ""
27465 " int\n"
27466 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
27467 "                                    const char *root);\n"
27468 "\n"
27469 msgstr ""
27470
27471 #. type: textblock
27472 #: ../src/guestfs-actions.pod:3421
27473 msgid ""
27474 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
27475 "C<guestfs_inspect_get_major_version>."
27476 msgstr ""
27477
27478 #. type: =head2
27479 #: ../src/guestfs-actions.pod:3428
27480 msgid "guestfs_inspect_get_mountpoints"
27481 msgstr ""
27482
27483 #. type: verbatim
27484 #: ../src/guestfs-actions.pod:3430
27485 #, no-wrap
27486 msgid ""
27487 " char **\n"
27488 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
27489 "                                  const char *root);\n"
27490 "\n"
27491 msgstr ""
27492
27493 #. type: textblock
27494 #: ../src/guestfs-actions.pod:3451
27495 msgid ""
27496 "For operating systems like Windows which still use drive letters, this call "
27497 "will only return an entry for the first drive \"mounted on\" C</>.  For "
27498 "information about the mapping of drive letters to partitions, see "
27499 "C<guestfs_inspect_get_drive_mappings>."
27500 msgstr ""
27501
27502 #. type: textblock
27503 #: ../src/guestfs-actions.pod:3457
27504 msgid ""
27505 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
27506 "C<guestfs_inspect_get_filesystems>."
27507 msgstr ""
27508
27509 #. type: =head2
27510 #: ../src/guestfs-actions.pod:3468
27511 msgid "guestfs_inspect_get_package_format"
27512 msgstr ""
27513
27514 #. type: verbatim
27515 #: ../src/guestfs-actions.pod:3470
27516 #, no-wrap
27517 msgid ""
27518 " char *\n"
27519 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
27520 "                                     const char *root);\n"
27521 "\n"
27522 msgstr ""
27523
27524 #. type: textblock
27525 #: ../src/guestfs-actions.pod:3474
27526 msgid ""
27527 "This function and C<guestfs_inspect_get_package_management> return the "
27528 "package format and package management tool used by the inspected operating "
27529 "system.  For example for Fedora these functions would return C<rpm> (package "
27530 "format) and C<yum> (package management)."
27531 msgstr ""
27532
27533 #. type: textblock
27534 #: ../src/guestfs-actions.pod:3493 ../src/guestfs-actions.pod:3521
27535 msgid "(Added in 1.7.5)"
27536 msgstr ""
27537
27538 #. type: =head2
27539 #: ../src/guestfs-actions.pod:3495
27540 msgid "guestfs_inspect_get_package_management"
27541 msgstr ""
27542
27543 #. type: verbatim
27544 #: ../src/guestfs-actions.pod:3497
27545 #, no-wrap
27546 msgid ""
27547 " char *\n"
27548 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
27549 "                                         const char *root);\n"
27550 "\n"
27551 msgstr ""
27552
27553 #. type: textblock
27554 #: ../src/guestfs-actions.pod:3501
27555 msgid ""
27556 "C<guestfs_inspect_get_package_format> and this function return the package "
27557 "format and package management tool used by the inspected operating system.  "
27558 "For example for Fedora these functions would return C<rpm> (package format) "
27559 "and C<yum> (package management)."
27560 msgstr ""
27561
27562 #. type: =head2
27563 #: ../src/guestfs-actions.pod:3523
27564 msgid "guestfs_inspect_get_product_name"
27565 msgstr ""
27566
27567 #. type: verbatim
27568 #: ../src/guestfs-actions.pod:3525
27569 #, no-wrap
27570 msgid ""
27571 " char *\n"
27572 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
27573 "                                   const char *root);\n"
27574 "\n"
27575 msgstr ""
27576
27577 #. type: =head2
27578 #: ../src/guestfs-actions.pod:3544
27579 msgid "guestfs_inspect_get_product_variant"
27580 msgstr ""
27581
27582 #. type: verbatim
27583 #: ../src/guestfs-actions.pod:3546
27584 #, no-wrap
27585 msgid ""
27586 " char *\n"
27587 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
27588 "                                      const char *root);\n"
27589 "\n"
27590 msgstr ""
27591
27592 #. type: textblock
27593 #: ../src/guestfs-actions.pod:3569
27594 msgid ""
27595 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
27596 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
27597 msgstr ""
27598
27599 #. type: textblock
27600 #: ../src/guestfs-actions.pod:3576
27601 msgid "(Added in 1.9.13)"
27602 msgstr ""
27603
27604 #. type: =head2
27605 #: ../src/guestfs-actions.pod:3578
27606 msgid "guestfs_inspect_get_roots"
27607 msgstr ""
27608
27609 #. type: verbatim
27610 #: ../src/guestfs-actions.pod:3580
27611 #, no-wrap
27612 msgid ""
27613 " char **\n"
27614 " guestfs_inspect_get_roots (guestfs_h *g);\n"
27615 "\n"
27616 msgstr ""
27617
27618 #. type: textblock
27619 #: ../src/guestfs-actions.pod:3583
27620 msgid ""
27621 "This function is a convenient way to get the list of root devices, as "
27622 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
27623 "the whole inspection process."
27624 msgstr ""
27625
27626 #. type: textblock
27627 #: ../src/guestfs-actions.pod:3587
27628 msgid ""
27629 "This returns an empty list if either no root devices were found or the "
27630 "caller has not called C<guestfs_inspect_os>."
27631 msgstr ""
27632
27633 #. type: textblock
27634 #: ../src/guestfs-actions.pod:3596
27635 msgid "(Added in 1.7.3)"
27636 msgstr ""
27637
27638 #. type: =head2
27639 #: ../src/guestfs-actions.pod:3598
27640 msgid "guestfs_inspect_get_type"
27641 msgstr ""
27642
27643 #. type: verbatim
27644 #: ../src/guestfs-actions.pod:3600
27645 #, no-wrap
27646 msgid ""
27647 " char *\n"
27648 " guestfs_inspect_get_type (guestfs_h *g,\n"
27649 "                           const char *root);\n"
27650 "\n"
27651 msgstr ""
27652
27653 #. type: =head2
27654 #: ../src/guestfs-actions.pod:3641
27655 msgid "guestfs_inspect_get_windows_current_control_set"
27656 msgstr ""
27657
27658 #. type: verbatim
27659 #: ../src/guestfs-actions.pod:3643
27660 #, no-wrap
27661 msgid ""
27662 " char *\n"
27663 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
27664 "                                                  const char *root);\n"
27665 "\n"
27666 msgstr ""
27667
27668 #. type: =head2
27669 #: ../src/guestfs-actions.pod:3661
27670 msgid "guestfs_inspect_get_windows_systemroot"
27671 msgstr ""
27672
27673 #. type: verbatim
27674 #: ../src/guestfs-actions.pod:3663
27675 #, no-wrap
27676 msgid ""
27677 " char *\n"
27678 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
27679 "                                         const char *root);\n"
27680 "\n"
27681 msgstr ""
27682
27683 #. type: textblock
27684 #: ../src/guestfs-actions.pod:3679
27685 msgid "(Added in 1.5.25)"
27686 msgstr ""
27687
27688 #. type: =head2
27689 #: ../src/guestfs-actions.pod:3681
27690 msgid "guestfs_inspect_is_live"
27691 msgstr ""
27692
27693 #. type: verbatim
27694 #: ../src/guestfs-actions.pod:3683
27695 #, no-wrap
27696 msgid ""
27697 " int\n"
27698 " guestfs_inspect_is_live (guestfs_h *g,\n"
27699 "                          const char *root);\n"
27700 "\n"
27701 msgstr ""
27702
27703 #. type: textblock
27704 #: ../src/guestfs-actions.pod:3687
27705 msgid ""
27706 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
27707 "disk), then this returns true if a live image was detected on the disk."
27708 msgstr ""
27709
27710 #. type: =head2
27711 #: ../src/guestfs-actions.pod:3697
27712 msgid "guestfs_inspect_is_multipart"
27713 msgstr ""
27714
27715 #. type: verbatim
27716 #: ../src/guestfs-actions.pod:3699
27717 #, no-wrap
27718 msgid ""
27719 " int\n"
27720 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
27721 "                               const char *root);\n"
27722 "\n"
27723 msgstr ""
27724
27725 #. type: textblock
27726 #: ../src/guestfs-actions.pod:3703
27727 msgid ""
27728 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
27729 "disk), then this returns true if the disk is part of a set."
27730 msgstr ""
27731
27732 #. type: =head2
27733 #: ../src/guestfs-actions.pod:3713
27734 msgid "guestfs_inspect_is_netinst"
27735 msgstr ""
27736
27737 #. type: verbatim
27738 #: ../src/guestfs-actions.pod:3715
27739 #, no-wrap
27740 msgid ""
27741 " int\n"
27742 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
27743 "                             const char *root);\n"
27744 "\n"
27745 msgstr ""
27746
27747 #. type: textblock
27748 #: ../src/guestfs-actions.pod:3719
27749 msgid ""
27750 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
27751 "disk), then this returns true if the disk is a network installer, ie. not a "
27752 "self-contained install CD but one which is likely to require network access "
27753 "to complete the install."
27754 msgstr ""
27755
27756 #. type: =head2
27757 #: ../src/guestfs-actions.pod:3731
27758 msgid "guestfs_inspect_list_applications"
27759 msgstr ""
27760
27761 #. type: verbatim
27762 #: ../src/guestfs-actions.pod:3733
27763 #, no-wrap
27764 msgid ""
27765 " struct guestfs_application_list *\n"
27766 " guestfs_inspect_list_applications (guestfs_h *g,\n"
27767 "                                    const char *root);\n"
27768 "\n"
27769 msgstr ""
27770
27771 #. type: textblock
27772 #: ../src/guestfs-actions.pod:3739
27773 msgid ""
27774 "I<Note:> This call works differently from other parts of the inspection "
27775 "API.  You have to call C<guestfs_inspect_os>, then "
27776 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
27777 "this.  Listing applications is a significantly more difficult operation "
27778 "which requires access to the full filesystem.  Also note that unlike the "
27779 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
27780 "the libguestfs handle, this call actually reads parts of the mounted "
27781 "filesystems during the call."
27782 msgstr ""
27783
27784 #. type: textblock
27785 #: ../src/guestfs-actions.pod:3829
27786 msgid ""
27787 "This function returns a C<struct guestfs_application_list *>, or NULL if "
27788 "there was an error.  I<The caller must call C<guestfs_free_application_list> "
27789 "after use>."
27790 msgstr ""
27791
27792 #. type: textblock
27793 #: ../src/guestfs-actions.pod:3833
27794 msgid "(Added in 1.7.8)"
27795 msgstr ""
27796
27797 #. type: =head2
27798 #: ../src/guestfs-actions.pod:3835
27799 msgid "guestfs_inspect_os"
27800 msgstr ""
27801
27802 #. type: verbatim
27803 #: ../src/guestfs-actions.pod:3837
27804 #, no-wrap
27805 msgid ""
27806 " char **\n"
27807 " guestfs_inspect_os (guestfs_h *g);\n"
27808 "\n"
27809 msgstr ""
27810
27811 #. type: textblock
27812 #: ../src/guestfs-actions.pod:3853
27813 msgid ""
27814 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
27815 "functions in order to query further information about each operating system, "
27816 "such as the name and version."
27817 msgstr ""
27818
27819 #. type: textblock
27820 #: ../src/guestfs-actions.pod:3858
27821 msgid ""
27822 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
27823 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
27824 "the contents.  This should be called with no disks currently mounted.  The "
27825 "function may also use Augeas, so any existing Augeas handle will be closed."
27826 msgstr ""
27827
27828 #. type: textblock
27829 #: ../src/guestfs-actions.pod:3870 ../src/guestfs-actions.pod:4201 ../src/guestfs-actions.pod:4283
27830 msgid "See also C<guestfs_list_filesystems>."
27831 msgstr ""
27832
27833 #. type: =head2
27834 #: ../src/guestfs-actions.pod:3878
27835 msgid "guestfs_is_blockdev"
27836 msgstr ""
27837
27838 #. type: verbatim
27839 #: ../src/guestfs-actions.pod:3880
27840 #, no-wrap
27841 msgid ""
27842 " int\n"
27843 " guestfs_is_blockdev (guestfs_h *g,\n"
27844 "                      const char *path);\n"
27845 "\n"
27846 msgstr ""
27847
27848 #. type: textblock
27849 #: ../src/guestfs-actions.pod:3887 ../src/guestfs-actions.pod:3916 ../src/guestfs-actions.pod:3946 ../src/guestfs-actions.pod:3961 ../src/guestfs-actions.pod:3977 ../src/guestfs-actions.pod:4033 ../src/guestfs-actions.pod:4048
27850 msgid "See also C<guestfs_stat>."
27851 msgstr ""
27852
27853 #. type: textblock
27854 #: ../src/guestfs-actions.pod:3891 ../src/guestfs-actions.pod:3920 ../src/guestfs-actions.pod:3965 ../src/guestfs-actions.pod:4037 ../src/guestfs-actions.pod:4052
27855 msgid "(Added in 1.5.10)"
27856 msgstr ""
27857
27858 #. type: =head2
27859 #: ../src/guestfs-actions.pod:3893
27860 msgid "guestfs_is_busy"
27861 msgstr ""
27862
27863 #. type: verbatim
27864 #: ../src/guestfs-actions.pod:3895
27865 #, no-wrap
27866 msgid ""
27867 " int\n"
27868 " guestfs_is_busy (guestfs_h *g);\n"
27869 "\n"
27870 msgstr ""
27871
27872 #. type: =head2
27873 #: ../src/guestfs-actions.pod:3907
27874 msgid "guestfs_is_chardev"
27875 msgstr ""
27876
27877 #. type: verbatim
27878 #: ../src/guestfs-actions.pod:3909
27879 #, no-wrap
27880 msgid ""
27881 " int\n"
27882 " guestfs_is_chardev (guestfs_h *g,\n"
27883 "                     const char *path);\n"
27884 "\n"
27885 msgstr ""
27886
27887 #. type: =head2
27888 #: ../src/guestfs-actions.pod:3922
27889 msgid "guestfs_is_config"
27890 msgstr ""
27891
27892 #. type: verbatim
27893 #: ../src/guestfs-actions.pod:3924
27894 #, no-wrap
27895 msgid ""
27896 " int\n"
27897 " guestfs_is_config (guestfs_h *g);\n"
27898 "\n"
27899 msgstr ""
27900
27901 #. type: =head2
27902 #: ../src/guestfs-actions.pod:3936
27903 msgid "guestfs_is_dir"
27904 msgstr ""
27905
27906 #. type: verbatim
27907 #: ../src/guestfs-actions.pod:3938
27908 #, no-wrap
27909 msgid ""
27910 " int\n"
27911 " guestfs_is_dir (guestfs_h *g,\n"
27912 "                 const char *path);\n"
27913 "\n"
27914 msgstr ""
27915
27916 #. type: =head2
27917 #: ../src/guestfs-actions.pod:3952
27918 msgid "guestfs_is_fifo"
27919 msgstr ""
27920
27921 #. type: verbatim
27922 #: ../src/guestfs-actions.pod:3954
27923 #, no-wrap
27924 msgid ""
27925 " int\n"
27926 " guestfs_is_fifo (guestfs_h *g,\n"
27927 "                  const char *path);\n"
27928 "\n"
27929 msgstr ""
27930
27931 #. type: =head2
27932 #: ../src/guestfs-actions.pod:3967
27933 msgid "guestfs_is_file"
27934 msgstr ""
27935
27936 #. type: verbatim
27937 #: ../src/guestfs-actions.pod:3969
27938 #, no-wrap
27939 msgid ""
27940 " int\n"
27941 " guestfs_is_file (guestfs_h *g,\n"
27942 "                  const char *path);\n"
27943 "\n"
27944 msgstr ""
27945
27946 #. type: =head2
27947 #: ../src/guestfs-actions.pod:3983
27948 msgid "guestfs_is_launching"
27949 msgstr ""
27950
27951 #. type: verbatim
27952 #: ../src/guestfs-actions.pod:3985
27953 #, no-wrap
27954 msgid ""
27955 " int\n"
27956 " guestfs_is_launching (guestfs_h *g);\n"
27957 "\n"
27958 msgstr ""
27959
27960 #. type: =head2
27961 #: ../src/guestfs-actions.pod:3997
27962 msgid "guestfs_is_lv"
27963 msgstr ""
27964
27965 #. type: verbatim
27966 #: ../src/guestfs-actions.pod:3999
27967 #, no-wrap
27968 msgid ""
27969 " int\n"
27970 " guestfs_is_lv (guestfs_h *g,\n"
27971 "                const char *device);\n"
27972 "\n"
27973 msgstr ""
27974
27975 #. type: =head2
27976 #: ../src/guestfs-actions.pod:4010
27977 msgid "guestfs_is_ready"
27978 msgstr ""
27979
27980 #. type: verbatim
27981 #: ../src/guestfs-actions.pod:4012
27982 #, no-wrap
27983 msgid ""
27984 " int\n"
27985 " guestfs_is_ready (guestfs_h *g);\n"
27986 "\n"
27987 msgstr ""
27988
27989 #. type: =head2
27990 #: ../src/guestfs-actions.pod:4024
27991 msgid "guestfs_is_socket"
27992 msgstr ""
27993
27994 #. type: verbatim
27995 #: ../src/guestfs-actions.pod:4026
27996 #, no-wrap
27997 msgid ""
27998 " int\n"
27999 " guestfs_is_socket (guestfs_h *g,\n"
28000 "                    const char *path);\n"
28001 "\n"
28002 msgstr ""
28003
28004 #. type: =head2
28005 #: ../src/guestfs-actions.pod:4039
28006 msgid "guestfs_is_symlink"
28007 msgstr ""
28008
28009 #. type: verbatim
28010 #: ../src/guestfs-actions.pod:4041
28011 #, no-wrap
28012 msgid ""
28013 " int\n"
28014 " guestfs_is_symlink (guestfs_h *g,\n"
28015 "                     const char *path);\n"
28016 "\n"
28017 msgstr ""
28018
28019 #. type: =head2
28020 #: ../src/guestfs-actions.pod:4054
28021 msgid "guestfs_is_zero"
28022 msgstr ""
28023
28024 #. type: verbatim
28025 #: ../src/guestfs-actions.pod:4056
28026 #, no-wrap
28027 msgid ""
28028 " int\n"
28029 " guestfs_is_zero (guestfs_h *g,\n"
28030 "                  const char *path);\n"
28031 "\n"
28032 msgstr ""
28033
28034 #. type: textblock
28035 #: ../src/guestfs-actions.pod:4065 ../src/guestfs-actions.pod:4079
28036 msgid "(Added in 1.11.8)"
28037 msgstr ""
28038
28039 #. type: =head2
28040 #: ../src/guestfs-actions.pod:4067
28041 msgid "guestfs_is_zero_device"
28042 msgstr ""
28043
28044 #. type: verbatim
28045 #: ../src/guestfs-actions.pod:4069
28046 #, no-wrap
28047 msgid ""
28048 " int\n"
28049 " guestfs_is_zero_device (guestfs_h *g,\n"
28050 "                         const char *device);\n"
28051 "\n"
28052 msgstr ""
28053
28054 #. type: =head2
28055 #: ../src/guestfs-actions.pod:4081
28056 msgid "guestfs_kill_subprocess"
28057 msgstr ""
28058
28059 #. type: verbatim
28060 #: ../src/guestfs-actions.pod:4083
28061 #, no-wrap
28062 msgid ""
28063 " int\n"
28064 " guestfs_kill_subprocess (guestfs_h *g);\n"
28065 "\n"
28066 msgstr ""
28067
28068 #. type: =head2
28069 #: ../src/guestfs-actions.pod:4092
28070 msgid "guestfs_launch"
28071 msgstr ""
28072
28073 #. type: verbatim
28074 #: ../src/guestfs-actions.pod:4094
28075 #, no-wrap
28076 msgid ""
28077 " int\n"
28078 " guestfs_launch (guestfs_h *g);\n"
28079 "\n"
28080 msgstr ""
28081
28082 #. type: =head2
28083 #: ../src/guestfs-actions.pod:4112
28084 msgid "guestfs_lchown"
28085 msgstr ""
28086
28087 #. type: verbatim
28088 #: ../src/guestfs-actions.pod:4114
28089 #, no-wrap
28090 msgid ""
28091 " int\n"
28092 " guestfs_lchown (guestfs_h *g,\n"
28093 "                 int owner,\n"
28094 "                 int group,\n"
28095 "                 const char *path);\n"
28096 "\n"
28097 msgstr ""
28098
28099 #. type: textblock
28100 #: ../src/guestfs-actions.pod:4120
28101 msgid ""
28102 "Change the file owner to C<owner> and group to C<group>.  This is like "
28103 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
28104 "changed, not the target."
28105 msgstr ""
28106
28107 #. type: =head2
28108 #: ../src/guestfs-actions.pod:4132
28109 msgid "guestfs_lgetxattr"
28110 msgstr ""
28111
28112 #. type: verbatim
28113 #: ../src/guestfs-actions.pod:4134
28114 #, no-wrap
28115 msgid ""
28116 " char *\n"
28117 " guestfs_lgetxattr (guestfs_h *g,\n"
28118 "                    const char *path,\n"
28119 "                    const char *name,\n"
28120 "                    size_t *size_r);\n"
28121 "\n"
28122 msgstr ""
28123
28124 #. type: textblock
28125 #: ../src/guestfs-actions.pod:4154
28126 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
28127 msgstr ""
28128
28129 #. type: =head2
28130 #: ../src/guestfs-actions.pod:4162
28131 msgid "guestfs_lgetxattrs"
28132 msgstr ""
28133
28134 #. type: verbatim
28135 #: ../src/guestfs-actions.pod:4164
28136 #, no-wrap
28137 msgid ""
28138 " struct guestfs_xattr_list *\n"
28139 " guestfs_lgetxattrs (guestfs_h *g,\n"
28140 "                     const char *path);\n"
28141 "\n"
28142 msgstr ""
28143
28144 #. type: textblock
28145 #: ../src/guestfs-actions.pod:4168
28146 msgid ""
28147 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
28148 "then it returns the extended attributes of the link itself."
28149 msgstr ""
28150
28151 #. type: =head2
28152 #: ../src/guestfs-actions.pod:4178
28153 msgid "guestfs_list_9p"
28154 msgstr ""
28155
28156 #. type: verbatim
28157 #: ../src/guestfs-actions.pod:4180
28158 #, no-wrap
28159 msgid ""
28160 " char **\n"
28161 " guestfs_list_9p (guestfs_h *g);\n"
28162 "\n"
28163 msgstr ""
28164
28165 #. type: =head2
28166 #: ../src/guestfs-actions.pod:4192
28167 msgid "guestfs_list_devices"
28168 msgstr ""
28169
28170 #. type: verbatim
28171 #: ../src/guestfs-actions.pod:4194
28172 #, no-wrap
28173 msgid ""
28174 " char **\n"
28175 " guestfs_list_devices (guestfs_h *g);\n"
28176 "\n"
28177 msgstr ""
28178
28179 #. type: =head2
28180 #: ../src/guestfs-actions.pod:4209
28181 msgid "guestfs_list_dm_devices"
28182 msgstr ""
28183
28184 #. type: verbatim
28185 #: ../src/guestfs-actions.pod:4211
28186 #, no-wrap
28187 msgid ""
28188 " char **\n"
28189 " guestfs_list_dm_devices (guestfs_h *g);\n"
28190 "\n"
28191 msgstr ""
28192
28193 #. type: textblock
28194 #: ../src/guestfs-actions.pod:4216
28195 msgid ""
28196 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
28197 "previous call to C<guestfs_luks_open>."
28198 msgstr ""
28199
28200 #. type: textblock
28201 #: ../src/guestfs-actions.pod:4219
28202 msgid ""
28203 "Device mapper devices which correspond to logical volumes are I<not> "
28204 "returned in this list.  Call C<guestfs_lvs> if you want to list logical "
28205 "volumes."
28206 msgstr ""
28207
28208 #. type: textblock
28209 #: ../src/guestfs-actions.pod:4227 ../src/guestfs-actions.pod:5664
28210 msgid "(Added in 1.11.15)"
28211 msgstr ""
28212
28213 #. type: =head2
28214 #: ../src/guestfs-actions.pod:4229
28215 msgid "guestfs_list_filesystems"
28216 msgstr ""
28217
28218 #. type: verbatim
28219 #: ../src/guestfs-actions.pod:4231
28220 #, no-wrap
28221 msgid ""
28222 " char **\n"
28223 " guestfs_list_filesystems (guestfs_h *g);\n"
28224 "\n"
28225 msgstr ""
28226
28227 #. type: textblock
28228 #: ../src/guestfs-actions.pod:4251
28229 msgid ""
28230 "This command runs other libguestfs commands, which might include "
28231 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
28232 "soon after launch and only when nothing is mounted."
28233 msgstr ""
28234
28235 #. type: textblock
28236 #: ../src/guestfs-actions.pod:4255
28237 msgid ""
28238 "Not all of the filesystems returned will be mountable.  In particular, swap "
28239 "partitions are returned in the list.  Also this command does not check that "
28240 "each filesystem found is valid and mountable, and some filesystems might be "
28241 "mountable but require special options.  Filesystems may not all belong to a "
28242 "single logical operating system (use C<guestfs_inspect_os> to look for "
28243 "OSes)."
28244 msgstr ""
28245
28246 #. type: textblock
28247 #: ../src/guestfs-actions.pod:4269 ../src/guestfs-actions.pod:6024
28248 msgid "(Added in 1.5.15)"
28249 msgstr ""
28250
28251 #. type: =head2
28252 #: ../src/guestfs-actions.pod:4271
28253 msgid "guestfs_list_partitions"
28254 msgstr ""
28255
28256 #. type: verbatim
28257 #: ../src/guestfs-actions.pod:4273
28258 #, no-wrap
28259 msgid ""
28260 " char **\n"
28261 " guestfs_list_partitions (guestfs_h *g);\n"
28262 "\n"
28263 msgstr ""
28264
28265 #. type: textblock
28266 #: ../src/guestfs-actions.pod:4280
28267 msgid ""
28268 "This does not return logical volumes.  For that you will need to call "
28269 "C<guestfs_lvs>."
28270 msgstr ""
28271
28272 #. type: =head2
28273 #: ../src/guestfs-actions.pod:4291
28274 msgid "guestfs_ll"
28275 msgstr ""
28276
28277 #. type: verbatim
28278 #: ../src/guestfs-actions.pod:4293
28279 #, no-wrap
28280 msgid ""
28281 " char *\n"
28282 " guestfs_ll (guestfs_h *g,\n"
28283 "             const char *directory);\n"
28284 "\n"
28285 msgstr ""
28286
28287 #. type: =head2
28288 #: ../src/guestfs-actions.pod:4308
28289 msgid "guestfs_ln"
28290 msgstr ""
28291
28292 #. type: verbatim
28293 #: ../src/guestfs-actions.pod:4310
28294 #, no-wrap
28295 msgid ""
28296 " int\n"
28297 " guestfs_ln (guestfs_h *g,\n"
28298 "             const char *target,\n"
28299 "             const char *linkname);\n"
28300 "\n"
28301 msgstr ""
28302
28303 #. type: =head2
28304 #: ../src/guestfs-actions.pod:4321
28305 msgid "guestfs_ln_f"
28306 msgstr ""
28307
28308 #. type: verbatim
28309 #: ../src/guestfs-actions.pod:4323
28310 #, no-wrap
28311 msgid ""
28312 " int\n"
28313 " guestfs_ln_f (guestfs_h *g,\n"
28314 "               const char *target,\n"
28315 "               const char *linkname);\n"
28316 "\n"
28317 msgstr ""
28318
28319 #. type: =head2
28320 #: ../src/guestfs-actions.pod:4335
28321 msgid "guestfs_ln_s"
28322 msgstr ""
28323
28324 #. type: verbatim
28325 #: ../src/guestfs-actions.pod:4337
28326 #, no-wrap
28327 msgid ""
28328 " int\n"
28329 " guestfs_ln_s (guestfs_h *g,\n"
28330 "               const char *target,\n"
28331 "               const char *linkname);\n"
28332 "\n"
28333 msgstr ""
28334
28335 #. type: =head2
28336 #: ../src/guestfs-actions.pod:4348
28337 msgid "guestfs_ln_sf"
28338 msgstr ""
28339
28340 #. type: verbatim
28341 #: ../src/guestfs-actions.pod:4350
28342 #, no-wrap
28343 msgid ""
28344 " int\n"
28345 " guestfs_ln_sf (guestfs_h *g,\n"
28346 "                const char *target,\n"
28347 "                const char *linkname);\n"
28348 "\n"
28349 msgstr ""
28350
28351 #. type: =head2
28352 #: ../src/guestfs-actions.pod:4362
28353 msgid "guestfs_lremovexattr"
28354 msgstr ""
28355
28356 #. type: verbatim
28357 #: ../src/guestfs-actions.pod:4364
28358 #, no-wrap
28359 msgid ""
28360 " int\n"
28361 " guestfs_lremovexattr (guestfs_h *g,\n"
28362 "                       const char *xattr,\n"
28363 "                       const char *path);\n"
28364 "\n"
28365 msgstr ""
28366
28367 #. type: textblock
28368 #: ../src/guestfs-actions.pod:4369
28369 msgid ""
28370 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
28371 "link, then it removes an extended attribute of the link itself."
28372 msgstr ""
28373
28374 #. type: =head2
28375 #: ../src/guestfs-actions.pod:4377
28376 msgid "guestfs_ls"
28377 msgstr ""
28378
28379 #. type: verbatim
28380 #: ../src/guestfs-actions.pod:4379
28381 #, no-wrap
28382 msgid ""
28383 " char **\n"
28384 " guestfs_ls (guestfs_h *g,\n"
28385 "             const char *directory);\n"
28386 "\n"
28387 msgstr ""
28388
28389 #. type: textblock
28390 #: ../src/guestfs-actions.pod:4387
28391 msgid ""
28392 "This command is mostly useful for interactive sessions.  Programs should "
28393 "probably use C<guestfs_readdir> instead."
28394 msgstr ""
28395
28396 #. type: =head2
28397 #: ../src/guestfs-actions.pod:4396
28398 msgid "guestfs_lsetxattr"
28399 msgstr ""
28400
28401 #. type: verbatim
28402 #: ../src/guestfs-actions.pod:4398
28403 #, no-wrap
28404 msgid ""
28405 " int\n"
28406 " guestfs_lsetxattr (guestfs_h *g,\n"
28407 "                    const char *xattr,\n"
28408 "                    const char *val,\n"
28409 "                    int vallen,\n"
28410 "                    const char *path);\n"
28411 "\n"
28412 msgstr ""
28413
28414 #. type: textblock
28415 #: ../src/guestfs-actions.pod:4405
28416 msgid ""
28417 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
28418 "then it sets an extended attribute of the link itself."
28419 msgstr ""
28420
28421 #. type: =head2
28422 #: ../src/guestfs-actions.pod:4413
28423 msgid "guestfs_lstat"
28424 msgstr ""
28425
28426 #. type: verbatim
28427 #: ../src/guestfs-actions.pod:4415
28428 #, no-wrap
28429 msgid ""
28430 " struct guestfs_stat *\n"
28431 " guestfs_lstat (guestfs_h *g,\n"
28432 "                const char *path);\n"
28433 "\n"
28434 msgstr ""
28435
28436 #. type: textblock
28437 #: ../src/guestfs-actions.pod:4421
28438 msgid ""
28439 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
28440 "link, then the link is stat-ed, not the file it refers to."
28441 msgstr ""
28442
28443 #. type: textblock
28444 #: ../src/guestfs-actions.pod:4427 ../src/guestfs-actions.pod:7204
28445 msgid ""
28446 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
28447 "error.  I<The caller must call C<guestfs_free_stat> after use>."
28448 msgstr ""
28449
28450 #. type: textblock
28451 #: ../src/guestfs-actions.pod:4431 ../src/guestfs-actions.pod:7208 ../src/guestfs-actions.pod:7226 ../src/guestfs-actions.pod:7607
28452 msgid "(Added in 0.9.2)"
28453 msgstr ""
28454
28455 #. type: =head2
28456 #: ../src/guestfs-actions.pod:4433
28457 msgid "guestfs_lstatlist"
28458 msgstr ""
28459
28460 #. type: verbatim
28461 #: ../src/guestfs-actions.pod:4435
28462 #, no-wrap
28463 msgid ""
28464 " struct guestfs_stat_list *\n"
28465 " guestfs_lstatlist (guestfs_h *g,\n"
28466 "                    const char *path,\n"
28467 "                    char *const *names);\n"
28468 "\n"
28469 msgstr ""
28470
28471 #. type: textblock
28472 #: ../src/guestfs-actions.pod:4440
28473 msgid ""
28474 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
28475 "files, where all files are in the directory C<path>.  C<names> is the list "
28476 "of files from this directory."
28477 msgstr ""
28478
28479 #. type: textblock
28480 #: ../src/guestfs-actions.pod:4449
28481 msgid ""
28482 "This call is intended for programs that want to efficiently list a directory "
28483 "contents without making many round-trips.  See also C<guestfs_lxattrlist> "
28484 "for a similarly efficient call for getting extended attributes.  Very long "
28485 "directory listings might cause the protocol message size to be exceeded, "
28486 "causing this call to fail.  The caller must split up such requests into "
28487 "smaller groups of names."
28488 msgstr ""
28489
28490 #. type: textblock
28491 #: ../src/guestfs-actions.pod:4457
28492 msgid ""
28493 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
28494 "an error.  I<The caller must call C<guestfs_free_stat_list> after use>."
28495 msgstr ""
28496
28497 #. type: =head2
28498 #: ../src/guestfs-actions.pod:4463
28499 msgid "guestfs_luks_add_key"
28500 msgstr ""
28501
28502 #. type: verbatim
28503 #: ../src/guestfs-actions.pod:4465
28504 #, no-wrap
28505 msgid ""
28506 " int\n"
28507 " guestfs_luks_add_key (guestfs_h *g,\n"
28508 "                       const char *device,\n"
28509 "                       const char *key,\n"
28510 "                       const char *newkey,\n"
28511 "                       int keyslot);\n"
28512 "\n"
28513 msgstr ""
28514
28515 #. type: textblock
28516 #: ../src/guestfs-actions.pod:4477
28517 msgid ""
28518 "Note that if C<keyslot> already contains a key, then this command will "
28519 "fail.  You have to use C<guestfs_luks_kill_slot> first to remove that key."
28520 msgstr ""
28521
28522 #. type: textblock
28523 #: ../src/guestfs-actions.pod:4483 ../src/guestfs-actions.pod:4520 ../src/guestfs-actions.pod:4540 ../src/guestfs-actions.pod:4560 ../src/guestfs-actions.pod:4595 ../src/guestfs-actions.pod:4614
28524 msgid ""
28525 "This function takes a key or passphrase parameter which could contain "
28526 "sensitive material.  Read the section L</KEYS AND PASSPHRASES> for more "
28527 "information."
28528 msgstr ""
28529
28530 #. type: textblock
28531 #: ../src/guestfs-actions.pod:4487 ../src/guestfs-actions.pod:4524 ../src/guestfs-actions.pod:4544 ../src/guestfs-actions.pod:4564
28532 msgid "(Added in 1.5.2)"
28533 msgstr ""
28534
28535 #. type: =head2
28536 #: ../src/guestfs-actions.pod:4489
28537 msgid "guestfs_luks_close"
28538 msgstr ""
28539
28540 #. type: verbatim
28541 #: ../src/guestfs-actions.pod:4491
28542 #, no-wrap
28543 msgid ""
28544 " int\n"
28545 " guestfs_luks_close (guestfs_h *g,\n"
28546 "                     const char *device);\n"
28547 "\n"
28548 msgstr ""
28549
28550 #. type: textblock
28551 #: ../src/guestfs-actions.pod:4495
28552 msgid ""
28553 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
28554 "or C<guestfs_luks_open_ro>.  The C<device> parameter must be the name of the "
28555 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
28556 "underlying block device."
28557 msgstr ""
28558
28559 #. type: textblock
28560 #: ../src/guestfs-actions.pod:4503 ../src/guestfs-actions.pod:4599 ../src/guestfs-actions.pod:4618 ../src/guestfs-actions.pod:4668 ../src/guestfs-actions.pod:4713
28561 msgid "(Added in 1.5.1)"
28562 msgstr ""
28563
28564 #. type: =head2
28565 #: ../src/guestfs-actions.pod:4505
28566 msgid "guestfs_luks_format"
28567 msgstr ""
28568
28569 #. type: verbatim
28570 #: ../src/guestfs-actions.pod:4507
28571 #, no-wrap
28572 msgid ""
28573 " int\n"
28574 " guestfs_luks_format (guestfs_h *g,\n"
28575 "                      const char *device,\n"
28576 "                      const char *key,\n"
28577 "                      int keyslot);\n"
28578 "\n"
28579 msgstr ""
28580
28581 #. type: =head2
28582 #: ../src/guestfs-actions.pod:4526
28583 msgid "guestfs_luks_format_cipher"
28584 msgstr ""
28585
28586 #. type: verbatim
28587 #: ../src/guestfs-actions.pod:4528
28588 #, no-wrap
28589 msgid ""
28590 " int\n"
28591 " guestfs_luks_format_cipher (guestfs_h *g,\n"
28592 "                             const char *device,\n"
28593 "                             const char *key,\n"
28594 "                             int keyslot,\n"
28595 "                             const char *cipher);\n"
28596 "\n"
28597 msgstr ""
28598
28599 #. type: textblock
28600 #: ../src/guestfs-actions.pod:4535
28601 msgid ""
28602 "This command is the same as C<guestfs_luks_format> but it also allows you to "
28603 "set the C<cipher> used."
28604 msgstr ""
28605
28606 #. type: =head2
28607 #: ../src/guestfs-actions.pod:4546
28608 msgid "guestfs_luks_kill_slot"
28609 msgstr ""
28610
28611 #. type: verbatim
28612 #: ../src/guestfs-actions.pod:4548
28613 #, no-wrap
28614 msgid ""
28615 " int\n"
28616 " guestfs_luks_kill_slot (guestfs_h *g,\n"
28617 "                         const char *device,\n"
28618 "                         const char *key,\n"
28619 "                         int keyslot);\n"
28620 "\n"
28621 msgstr ""
28622
28623 #. type: =head2
28624 #: ../src/guestfs-actions.pod:4566
28625 msgid "guestfs_luks_open"
28626 msgstr ""
28627
28628 #. type: verbatim
28629 #: ../src/guestfs-actions.pod:4568
28630 #, no-wrap
28631 msgid ""
28632 " int\n"
28633 " guestfs_luks_open (guestfs_h *g,\n"
28634 "                    const char *device,\n"
28635 "                    const char *key,\n"
28636 "                    const char *mapname);\n"
28637 "\n"
28638 msgstr ""
28639
28640 #. type: textblock
28641 #: ../src/guestfs-actions.pod:4586
28642 msgid ""
28643 "If this block device contains LVM volume groups, then calling "
28644 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
28645 "visible."
28646 msgstr ""
28647
28648 #. type: textblock
28649 #: ../src/guestfs-actions.pod:4590
28650 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
28651 msgstr ""
28652
28653 #. type: =head2
28654 #: ../src/guestfs-actions.pod:4601
28655 msgid "guestfs_luks_open_ro"
28656 msgstr ""
28657
28658 #. type: verbatim
28659 #: ../src/guestfs-actions.pod:4603
28660 #, no-wrap
28661 msgid ""
28662 " int\n"
28663 " guestfs_luks_open_ro (guestfs_h *g,\n"
28664 "                       const char *device,\n"
28665 "                       const char *key,\n"
28666 "                       const char *mapname);\n"
28667 "\n"
28668 msgstr ""
28669
28670 #. type: textblock
28671 #: ../src/guestfs-actions.pod:4609
28672 msgid ""
28673 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
28674 "created."
28675 msgstr ""
28676
28677 #. type: =head2
28678 #: ../src/guestfs-actions.pod:4620
28679 msgid "guestfs_lvcreate"
28680 msgstr ""
28681
28682 #. type: verbatim
28683 #: ../src/guestfs-actions.pod:4622
28684 #, no-wrap
28685 msgid ""
28686 " int\n"
28687 " guestfs_lvcreate (guestfs_h *g,\n"
28688 "                   const char *logvol,\n"
28689 "                   const char *volgroup,\n"
28690 "                   int mbytes);\n"
28691 "\n"
28692 msgstr ""
28693
28694 #. type: =head2
28695 #: ../src/guestfs-actions.pod:4635
28696 msgid "guestfs_lvm_canonical_lv_name"
28697 msgstr ""
28698
28699 #. type: verbatim
28700 #: ../src/guestfs-actions.pod:4637
28701 #, no-wrap
28702 msgid ""
28703 " char *\n"
28704 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
28705 "                                const char *lvname);\n"
28706 "\n"
28707 msgstr ""
28708
28709 #. type: textblock
28710 #: ../src/guestfs-actions.pod:4648
28711 msgid "See also C<guestfs_is_lv>."
28712 msgstr ""
28713
28714 #. type: textblock
28715 #: ../src/guestfs-actions.pod:4653
28716 msgid "(Added in 1.5.24)"
28717 msgstr ""
28718
28719 #. type: =head2
28720 #: ../src/guestfs-actions.pod:4655
28721 msgid "guestfs_lvm_clear_filter"
28722 msgstr ""
28723
28724 #. type: verbatim
28725 #: ../src/guestfs-actions.pod:4657
28726 #, no-wrap
28727 msgid ""
28728 " int\n"
28729 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
28730 "\n"
28731 msgstr ""
28732
28733 #. type: textblock
28734 #: ../src/guestfs-actions.pod:4660
28735 msgid ""
28736 "This undoes the effect of C<guestfs_lvm_set_filter>.  LVM will be able to "
28737 "see every block device."
28738 msgstr ""
28739
28740 #. type: =head2
28741 #: ../src/guestfs-actions.pod:4670
28742 msgid "guestfs_lvm_remove_all"
28743 msgstr ""
28744
28745 #. type: verbatim
28746 #: ../src/guestfs-actions.pod:4672
28747 #, no-wrap
28748 msgid ""
28749 " int\n"
28750 " guestfs_lvm_remove_all (guestfs_h *g);\n"
28751 "\n"
28752 msgstr ""
28753
28754 #. type: =head2
28755 #: ../src/guestfs-actions.pod:4682
28756 msgid "guestfs_lvm_set_filter"
28757 msgstr ""
28758
28759 #. type: verbatim
28760 #: ../src/guestfs-actions.pod:4684
28761 #, no-wrap
28762 msgid ""
28763 " int\n"
28764 " guestfs_lvm_set_filter (guestfs_h *g,\n"
28765 "                         char *const *devices);\n"
28766 "\n"
28767 msgstr ""
28768
28769 #. type: =head2
28770 #: ../src/guestfs-actions.pod:4715
28771 msgid "guestfs_lvremove"
28772 msgstr ""
28773
28774 #. type: verbatim
28775 #: ../src/guestfs-actions.pod:4717
28776 #, no-wrap
28777 msgid ""
28778 " int\n"
28779 " guestfs_lvremove (guestfs_h *g,\n"
28780 "                   const char *device);\n"
28781 "\n"
28782 msgstr ""
28783
28784 #. type: textblock
28785 #: ../src/guestfs-actions.pod:4729 ../src/guestfs-actions.pod:6139 ../src/guestfs-actions.pod:7977
28786 msgid "(Added in 1.0.13)"
28787 msgstr ""
28788
28789 #. type: =head2
28790 #: ../src/guestfs-actions.pod:4731
28791 msgid "guestfs_lvrename"
28792 msgstr ""
28793
28794 #. type: verbatim
28795 #: ../src/guestfs-actions.pod:4733
28796 #, no-wrap
28797 msgid ""
28798 " int\n"
28799 " guestfs_lvrename (guestfs_h *g,\n"
28800 "                   const char *logvol,\n"
28801 "                   const char *newlogvol);\n"
28802 "\n"
28803 msgstr ""
28804
28805 #. type: textblock
28806 #: ../src/guestfs-actions.pod:4742 ../src/guestfs-actions.pod:7990
28807 msgid "(Added in 1.0.83)"
28808 msgstr ""
28809
28810 #. type: =head2
28811 #: ../src/guestfs-actions.pod:4744
28812 msgid "guestfs_lvresize"
28813 msgstr ""
28814
28815 #. type: verbatim
28816 #: ../src/guestfs-actions.pod:4746
28817 #, no-wrap
28818 msgid ""
28819 " int\n"
28820 " guestfs_lvresize (guestfs_h *g,\n"
28821 "                   const char *device,\n"
28822 "                   int mbytes);\n"
28823 "\n"
28824 msgstr ""
28825
28826 #. type: =head2
28827 #: ../src/guestfs-actions.pod:4759
28828 msgid "guestfs_lvresize_free"
28829 msgstr ""
28830
28831 #. type: verbatim
28832 #: ../src/guestfs-actions.pod:4761
28833 #, no-wrap
28834 msgid ""
28835 " int\n"
28836 " guestfs_lvresize_free (guestfs_h *g,\n"
28837 "                        const char *lv,\n"
28838 "                        int percent);\n"
28839 "\n"
28840 msgstr ""
28841
28842 #. type: textblock
28843 #: ../src/guestfs-actions.pod:4774
28844 msgid "(Added in 1.3.3)"
28845 msgstr ""
28846
28847 #. type: =head2
28848 #: ../src/guestfs-actions.pod:4776
28849 msgid "guestfs_lvs"
28850 msgstr ""
28851
28852 #. type: verbatim
28853 #: ../src/guestfs-actions.pod:4778
28854 #, no-wrap
28855 msgid ""
28856 " char **\n"
28857 " guestfs_lvs (guestfs_h *g);\n"
28858 "\n"
28859 msgstr ""
28860
28861 #. type: textblock
28862 #: ../src/guestfs-actions.pod:4787
28863 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
28864 msgstr ""
28865
28866 #. type: =head2
28867 #: ../src/guestfs-actions.pod:4795
28868 msgid "guestfs_lvs_full"
28869 msgstr ""
28870
28871 #. type: verbatim
28872 #: ../src/guestfs-actions.pod:4797
28873 #, no-wrap
28874 msgid ""
28875 " struct guestfs_lvm_lv_list *\n"
28876 " guestfs_lvs_full (guestfs_h *g);\n"
28877 "\n"
28878 msgstr ""
28879
28880 #. type: textblock
28881 #: ../src/guestfs-actions.pod:4803
28882 msgid ""
28883 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
28884 "was an error.  I<The caller must call C<guestfs_free_lvm_lv_list> after "
28885 "use>."
28886 msgstr ""
28887
28888 #. type: =head2
28889 #: ../src/guestfs-actions.pod:4809
28890 msgid "guestfs_lvuuid"
28891 msgstr ""
28892
28893 #. type: verbatim
28894 #: ../src/guestfs-actions.pod:4811
28895 #, no-wrap
28896 msgid ""
28897 " char *\n"
28898 " guestfs_lvuuid (guestfs_h *g,\n"
28899 "                 const char *device);\n"
28900 "\n"
28901 msgstr ""
28902
28903 #. type: =head2
28904 #: ../src/guestfs-actions.pod:4822
28905 msgid "guestfs_lxattrlist"
28906 msgstr ""
28907
28908 #. type: verbatim
28909 #: ../src/guestfs-actions.pod:4824
28910 #, no-wrap
28911 msgid ""
28912 " struct guestfs_xattr_list *\n"
28913 " guestfs_lxattrlist (guestfs_h *g,\n"
28914 "                     const char *path,\n"
28915 "                     char *const *names);\n"
28916 "\n"
28917 msgstr ""
28918
28919 #. type: textblock
28920 #: ../src/guestfs-actions.pod:4843
28921 msgid ""
28922 "This call is intended for programs that want to efficiently list a directory "
28923 "contents without making many round-trips.  See also C<guestfs_lstatlist> for "
28924 "a similarly efficient call for getting standard stats.  Very long directory "
28925 "listings might cause the protocol message size to be exceeded, causing this "
28926 "call to fail.  The caller must split up such requests into smaller groups of "
28927 "names."
28928 msgstr ""
28929
28930 #. type: =head2
28931 #: ../src/guestfs-actions.pod:4857
28932 msgid "guestfs_mkdir"
28933 msgstr ""
28934
28935 #. type: verbatim
28936 #: ../src/guestfs-actions.pod:4859
28937 #, no-wrap
28938 msgid ""
28939 " int\n"
28940 " guestfs_mkdir (guestfs_h *g,\n"
28941 "                const char *path);\n"
28942 "\n"
28943 msgstr ""
28944
28945 #. type: =head2
28946 #: ../src/guestfs-actions.pod:4869
28947 msgid "guestfs_mkdir_mode"
28948 msgstr ""
28949
28950 #. type: verbatim
28951 #: ../src/guestfs-actions.pod:4871
28952 #, no-wrap
28953 msgid ""
28954 " int\n"
28955 " guestfs_mkdir_mode (guestfs_h *g,\n"
28956 "                     const char *path,\n"
28957 "                     int mode);\n"
28958 "\n"
28959 msgstr ""
28960
28961 #. type: textblock
28962 #: ../src/guestfs-actions.pod:4883
28963 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
28964 msgstr ""
28965
28966 #. type: =head2
28967 #: ../src/guestfs-actions.pod:4889
28968 msgid "guestfs_mkdir_p"
28969 msgstr ""
28970
28971 #. type: verbatim
28972 #: ../src/guestfs-actions.pod:4891
28973 #, no-wrap
28974 msgid ""
28975 " int\n"
28976 " guestfs_mkdir_p (guestfs_h *g,\n"
28977 "                  const char *path);\n"
28978 "\n"
28979 msgstr ""
28980
28981 #. type: =head2
28982 #: ../src/guestfs-actions.pod:4902
28983 msgid "guestfs_mkdtemp"
28984 msgstr ""
28985
28986 #. type: verbatim
28987 #: ../src/guestfs-actions.pod:4904
28988 #, no-wrap
28989 msgid ""
28990 " char *\n"
28991 " guestfs_mkdtemp (guestfs_h *g,\n"
28992 "                  const char *template);\n"
28993 "\n"
28994 msgstr ""
28995
28996 #. type: =head2
28997 #: ../src/guestfs-actions.pod:4932
28998 msgid "guestfs_mke2fs_J"
28999 msgstr ""
29000
29001 #. type: verbatim
29002 #: ../src/guestfs-actions.pod:4934
29003 #, no-wrap
29004 msgid ""
29005 " int\n"
29006 " guestfs_mke2fs_J (guestfs_h *g,\n"
29007 "                   const char *fstype,\n"
29008 "                   int blocksize,\n"
29009 "                   const char *device,\n"
29010 "                   const char *journal);\n"
29011 "\n"
29012 msgstr ""
29013
29014 #. type: textblock
29015 #: ../src/guestfs-actions.pod:4947
29016 msgid "See also C<guestfs_mke2journal>."
29017 msgstr ""
29018
29019 #. type: textblock
29020 #: ../src/guestfs-actions.pod:4951 ../src/guestfs-actions.pod:4969 ../src/guestfs-actions.pod:4987 ../src/guestfs-actions.pod:5003 ../src/guestfs-actions.pod:5017 ../src/guestfs-actions.pod:5031 ../src/guestfs-actions.pod:5090 ../src/guestfs-actions.pod:5367
29021 msgid "(Added in 1.0.68)"
29022 msgstr ""
29023
29024 #. type: =head2
29025 #: ../src/guestfs-actions.pod:4953
29026 msgid "guestfs_mke2fs_JL"
29027 msgstr ""
29028
29029 #. type: verbatim
29030 #: ../src/guestfs-actions.pod:4955
29031 #, no-wrap
29032 msgid ""
29033 " int\n"
29034 " guestfs_mke2fs_JL (guestfs_h *g,\n"
29035 "                    const char *fstype,\n"
29036 "                    int blocksize,\n"
29037 "                    const char *device,\n"
29038 "                    const char *label);\n"
29039 "\n"
29040 msgstr ""
29041
29042 #. type: textblock
29043 #: ../src/guestfs-actions.pod:4965
29044 msgid "See also C<guestfs_mke2journal_L>."
29045 msgstr ""
29046
29047 #. type: =head2
29048 #: ../src/guestfs-actions.pod:4971
29049 msgid "guestfs_mke2fs_JU"
29050 msgstr ""
29051
29052 #. type: verbatim
29053 #: ../src/guestfs-actions.pod:4973
29054 #, no-wrap
29055 msgid ""
29056 " int\n"
29057 " guestfs_mke2fs_JU (guestfs_h *g,\n"
29058 "                    const char *fstype,\n"
29059 "                    int blocksize,\n"
29060 "                    const char *device,\n"
29061 "                    const char *uuid);\n"
29062 "\n"
29063 msgstr ""
29064
29065 #. type: textblock
29066 #: ../src/guestfs-actions.pod:4983
29067 msgid "See also C<guestfs_mke2journal_U>."
29068 msgstr ""
29069
29070 #. type: =head2
29071 #: ../src/guestfs-actions.pod:4989
29072 msgid "guestfs_mke2journal"
29073 msgstr ""
29074
29075 #. type: verbatim
29076 #: ../src/guestfs-actions.pod:4991
29077 #, no-wrap
29078 msgid ""
29079 " int\n"
29080 " guestfs_mke2journal (guestfs_h *g,\n"
29081 "                      int blocksize,\n"
29082 "                      const char *device);\n"
29083 "\n"
29084 msgstr ""
29085
29086 #. type: =head2
29087 #: ../src/guestfs-actions.pod:5005
29088 msgid "guestfs_mke2journal_L"
29089 msgstr ""
29090
29091 #. type: verbatim
29092 #: ../src/guestfs-actions.pod:5007
29093 #, no-wrap
29094 msgid ""
29095 " int\n"
29096 " guestfs_mke2journal_L (guestfs_h *g,\n"
29097 "                        int blocksize,\n"
29098 "                        const char *label,\n"
29099 "                        const char *device);\n"
29100 "\n"
29101 msgstr ""
29102
29103 #. type: =head2
29104 #: ../src/guestfs-actions.pod:5019
29105 msgid "guestfs_mke2journal_U"
29106 msgstr ""
29107
29108 #. type: verbatim
29109 #: ../src/guestfs-actions.pod:5021
29110 #, no-wrap
29111 msgid ""
29112 " int\n"
29113 " guestfs_mke2journal_U (guestfs_h *g,\n"
29114 "                        int blocksize,\n"
29115 "                        const char *uuid,\n"
29116 "                        const char *device);\n"
29117 "\n"
29118 msgstr ""
29119
29120 #. type: =head2
29121 #: ../src/guestfs-actions.pod:5033
29122 msgid "guestfs_mkfifo"
29123 msgstr ""
29124
29125 #. type: verbatim
29126 #: ../src/guestfs-actions.pod:5035
29127 #, no-wrap
29128 msgid ""
29129 " int\n"
29130 " guestfs_mkfifo (guestfs_h *g,\n"
29131 "                 int mode,\n"
29132 "                 const char *path);\n"
29133 "\n"
29134 msgstr ""
29135
29136 #. type: textblock
29137 #: ../src/guestfs-actions.pod:5040
29138 msgid ""
29139 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>.  It "
29140 "is just a convenient wrapper around C<guestfs_mknod>."
29141 msgstr ""
29142
29143 #. type: =head2
29144 #: ../src/guestfs-actions.pod:5050
29145 msgid "guestfs_mkfs"
29146 msgstr ""
29147
29148 #. type: verbatim
29149 #: ../src/guestfs-actions.pod:5052
29150 #, no-wrap
29151 msgid ""
29152 " int\n"
29153 " guestfs_mkfs (guestfs_h *g,\n"
29154 "               const char *fstype,\n"
29155 "               const char *device);\n"
29156 "\n"
29157 msgstr ""
29158
29159 #. type: =head2
29160 #: ../src/guestfs-actions.pod:5065
29161 msgid "guestfs_mkfs_b"
29162 msgstr ""
29163
29164 #. type: verbatim
29165 #: ../src/guestfs-actions.pod:5067
29166 #, no-wrap
29167 msgid ""
29168 " int\n"
29169 " guestfs_mkfs_b (guestfs_h *g,\n"
29170 "                 const char *fstype,\n"
29171 "                 int blocksize,\n"
29172 "                 const char *device);\n"
29173 "\n"
29174 msgstr ""
29175
29176 #. type: textblock
29177 #: ../src/guestfs-actions.pod:5073
29178 msgid ""
29179 "I<This function is deprecated.> In new code, use the L</guestfs_mkfs_opts> "
29180 "call instead."
29181 msgstr ""
29182
29183 #. type: textblock
29184 #: ../src/guestfs-actions.pod:5080
29185 msgid ""
29186 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
29187 "block size of the resulting filesystem.  Supported block sizes depend on the "
29188 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
29189 msgstr ""
29190
29191 #. type: =head2
29192 #: ../src/guestfs-actions.pod:5092
29193 msgid "guestfs_mkfs_opts"
29194 msgstr ""
29195
29196 #. type: verbatim
29197 #: ../src/guestfs-actions.pod:5094
29198 #, no-wrap
29199 msgid ""
29200 " int\n"
29201 " guestfs_mkfs_opts (guestfs_h *g,\n"
29202 "                    const char *fstype,\n"
29203 "                    const char *device,\n"
29204 "                    ...);\n"
29205 "\n"
29206 msgstr ""
29207
29208 #. type: verbatim
29209 #: ../src/guestfs-actions.pod:5105
29210 #, no-wrap
29211 msgid ""
29212 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
29213 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
29214 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
29215 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
29216 "\n"
29217 msgstr ""
29218
29219 #. type: textblock
29220 #: ../src/guestfs-actions.pod:5153
29221 msgid "(Added in 1.7.19)"
29222 msgstr ""
29223
29224 #. type: =head2
29225 #: ../src/guestfs-actions.pod:5155
29226 msgid "guestfs_mkfs_opts_va"
29227 msgstr ""
29228
29229 #. type: verbatim
29230 #: ../src/guestfs-actions.pod:5157
29231 #, no-wrap
29232 msgid ""
29233 " int\n"
29234 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
29235 "                       const char *fstype,\n"
29236 "                       const char *device,\n"
29237 "                       va_list args);\n"
29238 "\n"
29239 msgstr ""
29240
29241 #. type: textblock
29242 #: ../src/guestfs-actions.pod:5163
29243 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
29244 msgstr ""
29245
29246 #. type: =head2
29247 #: ../src/guestfs-actions.pod:5167
29248 msgid "guestfs_mkfs_opts_argv"
29249 msgstr ""
29250
29251 #. type: verbatim
29252 #: ../src/guestfs-actions.pod:5169
29253 #, no-wrap
29254 msgid ""
29255 " int\n"
29256 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
29257 "                         const char *fstype,\n"
29258 "                         const char *device,\n"
29259 "                         const struct guestfs_mkfs_opts_argv *optargs);\n"
29260 "\n"
29261 msgstr ""
29262
29263 #. type: textblock
29264 #: ../src/guestfs-actions.pod:5175
29265 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
29266 msgstr ""
29267
29268 #. type: =head2
29269 #: ../src/guestfs-actions.pod:5179
29270 msgid "guestfs_mkmountpoint"
29271 msgstr ""
29272
29273 #. type: verbatim
29274 #: ../src/guestfs-actions.pod:5181
29275 #, no-wrap
29276 msgid ""
29277 " int\n"
29278 " guestfs_mkmountpoint (guestfs_h *g,\n"
29279 "                       const char *exemptpath);\n"
29280 "\n"
29281 msgstr ""
29282
29283 #. type: textblock
29284 #: ../src/guestfs-actions.pod:5185
29285 msgid ""
29286 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
29287 "that can be used to create extra mountpoints before mounting the first "
29288 "filesystem."
29289 msgstr ""
29290
29291 #. type: textblock
29292 #: ../src/guestfs-actions.pod:5209
29293 msgid ""
29294 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.  You "
29295 "may get unexpected errors if you try to mix these calls.  It is safest to "
29296 "manually unmount filesystems and remove mountpoints after use."
29297 msgstr ""
29298
29299 #. type: textblock
29300 #: ../src/guestfs-actions.pod:5213
29301 msgid ""
29302 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
29303 "first, so for this to work for manual mountpoints, you must ensure that the "
29304 "innermost mountpoints have the longest pathnames, as in the example code "
29305 "above."
29306 msgstr ""
29307
29308 #. type: textblock
29309 #: ../src/guestfs-actions.pod:5220
29310 msgid ""
29311 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
29312 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
29313 "can also trigger these issues."
29314 msgstr ""
29315
29316 #. type: textblock
29317 #: ../src/guestfs-actions.pod:5226 ../src/guestfs-actions.pod:5532 ../src/guestfs-actions.pod:6559
29318 msgid "(Added in 1.0.62)"
29319 msgstr ""
29320
29321 #. type: =head2
29322 #: ../src/guestfs-actions.pod:5228
29323 msgid "guestfs_mknod"
29324 msgstr ""
29325
29326 #. type: verbatim
29327 #: ../src/guestfs-actions.pod:5230
29328 #, no-wrap
29329 msgid ""
29330 " int\n"
29331 " guestfs_mknod (guestfs_h *g,\n"
29332 "                int mode,\n"
29333 "                int devmajor,\n"
29334 "                int devminor,\n"
29335 "                const char *path);\n"
29336 "\n"
29337 msgstr ""
29338
29339 #. type: textblock
29340 #: ../src/guestfs-actions.pod:5245
29341 msgid ""
29342 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
29343 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
29344 "regular file).  These constants are available in the standard Linux header "
29345 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
29346 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
29347 "the appropriate constant for you."
29348 msgstr ""
29349
29350 #. type: =head2
29351 #: ../src/guestfs-actions.pod:5259
29352 msgid "guestfs_mknod_b"
29353 msgstr ""
29354
29355 #. type: verbatim
29356 #: ../src/guestfs-actions.pod:5261
29357 #, no-wrap
29358 msgid ""
29359 " int\n"
29360 " guestfs_mknod_b (guestfs_h *g,\n"
29361 "                  int mode,\n"
29362 "                  int devmajor,\n"
29363 "                  int devminor,\n"
29364 "                  const char *path);\n"
29365 "\n"
29366 msgstr ""
29367
29368 #. type: textblock
29369 #: ../src/guestfs-actions.pod:5268
29370 msgid ""
29371 "This call creates a block device node called C<path> with mode C<mode> and "
29372 "device major/minor C<devmajor> and C<devminor>.  It is just a convenient "
29373 "wrapper around C<guestfs_mknod>."
29374 msgstr ""
29375
29376 #. type: =head2
29377 #: ../src/guestfs-actions.pod:5278
29378 msgid "guestfs_mknod_c"
29379 msgstr ""
29380
29381 #. type: verbatim
29382 #: ../src/guestfs-actions.pod:5280
29383 #, no-wrap
29384 msgid ""
29385 " int\n"
29386 " guestfs_mknod_c (guestfs_h *g,\n"
29387 "                  int mode,\n"
29388 "                  int devmajor,\n"
29389 "                  int devminor,\n"
29390 "                  const char *path);\n"
29391 "\n"
29392 msgstr ""
29393
29394 #. type: textblock
29395 #: ../src/guestfs-actions.pod:5287
29396 msgid ""
29397 "This call creates a char device node called C<path> with mode C<mode> and "
29398 "device major/minor C<devmajor> and C<devminor>.  It is just a convenient "
29399 "wrapper around C<guestfs_mknod>."
29400 msgstr ""
29401
29402 #. type: =head2
29403 #: ../src/guestfs-actions.pod:5297
29404 msgid "guestfs_mkswap"
29405 msgstr ""
29406
29407 #. type: verbatim
29408 #: ../src/guestfs-actions.pod:5299
29409 #, no-wrap
29410 msgid ""
29411 " int\n"
29412 " guestfs_mkswap (guestfs_h *g,\n"
29413 "                 const char *device);\n"
29414 "\n"
29415 msgstr ""
29416
29417 #. type: =head2
29418 #: ../src/guestfs-actions.pod:5309
29419 msgid "guestfs_mkswap_L"
29420 msgstr ""
29421
29422 #. type: verbatim
29423 #: ../src/guestfs-actions.pod:5311
29424 #, no-wrap
29425 msgid ""
29426 " int\n"
29427 " guestfs_mkswap_L (guestfs_h *g,\n"
29428 "                   const char *label,\n"
29429 "                   const char *device);\n"
29430 "\n"
29431 msgstr ""
29432
29433 #. type: =head2
29434 #: ../src/guestfs-actions.pod:5326
29435 msgid "guestfs_mkswap_U"
29436 msgstr ""
29437
29438 #. type: verbatim
29439 #: ../src/guestfs-actions.pod:5328
29440 #, no-wrap
29441 msgid ""
29442 " int\n"
29443 " guestfs_mkswap_U (guestfs_h *g,\n"
29444 "                   const char *uuid,\n"
29445 "                   const char *device);\n"
29446 "\n"
29447 msgstr ""
29448
29449 #. type: =head2
29450 #: ../src/guestfs-actions.pod:5339
29451 msgid "guestfs_mkswap_file"
29452 msgstr ""
29453
29454 #. type: verbatim
29455 #: ../src/guestfs-actions.pod:5341
29456 #, no-wrap
29457 msgid ""
29458 " int\n"
29459 " guestfs_mkswap_file (guestfs_h *g,\n"
29460 "                      const char *path);\n"
29461 "\n"
29462 msgstr ""
29463
29464 #. type: textblock
29465 #: ../src/guestfs-actions.pod:5347
29466 msgid ""
29467 "This command just writes a swap file signature to an existing file.  To "
29468 "create the file itself, use something like C<guestfs_fallocate>."
29469 msgstr ""
29470
29471 #. type: =head2
29472 #: ../src/guestfs-actions.pod:5354
29473 msgid "guestfs_modprobe"
29474 msgstr ""
29475
29476 #. type: verbatim
29477 #: ../src/guestfs-actions.pod:5356
29478 #, no-wrap
29479 msgid ""
29480 " int\n"
29481 " guestfs_modprobe (guestfs_h *g,\n"
29482 "                   const char *modulename);\n"
29483 "\n"
29484 msgstr ""
29485
29486 #. type: =head2
29487 #: ../src/guestfs-actions.pod:5369
29488 msgid "guestfs_mount"
29489 msgstr ""
29490
29491 #. type: verbatim
29492 #: ../src/guestfs-actions.pod:5371
29493 #, no-wrap
29494 msgid ""
29495 " int\n"
29496 " guestfs_mount (guestfs_h *g,\n"
29497 "                const char *device,\n"
29498 "                const char *mountpoint);\n"
29499 "\n"
29500 msgstr ""
29501
29502 #. type: textblock
29503 #: ../src/guestfs-actions.pod:5390
29504 msgid ""
29505 "Before libguestfs 1.13.16, this call implicitly added the options C<sync> "
29506 "and C<noatime>.  The C<sync> option greatly slowed writes and caused many "
29507 "problems for users.  If your program might need to work with older versions "
29508 "of libguestfs, use C<guestfs_mount_options> instead (using an empty string "
29509 "for the first parameter if you don't want any options)."
29510 msgstr ""
29511
29512 #. type: =head2
29513 #: ../src/guestfs-actions.pod:5401
29514 msgid "guestfs_mount_9p"
29515 msgstr ""
29516
29517 #. type: verbatim
29518 #: ../src/guestfs-actions.pod:5403
29519 #, no-wrap
29520 msgid ""
29521 " int\n"
29522 " guestfs_mount_9p (guestfs_h *g,\n"
29523 "                   const char *mounttag,\n"
29524 "                   const char *mountpoint,\n"
29525 "                   ...);\n"
29526 "\n"
29527 msgstr ""
29528
29529 #. type: verbatim
29530 #: ../src/guestfs-actions.pod:5414
29531 #, no-wrap
29532 msgid ""
29533 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
29534 "\n"
29535 msgstr ""
29536
29537 #. type: =head2
29538 #: ../src/guestfs-actions.pod:5427
29539 msgid "guestfs_mount_9p_va"
29540 msgstr ""
29541
29542 #. type: verbatim
29543 #: ../src/guestfs-actions.pod:5429
29544 #, no-wrap
29545 msgid ""
29546 " int\n"
29547 " guestfs_mount_9p_va (guestfs_h *g,\n"
29548 "                      const char *mounttag,\n"
29549 "                      const char *mountpoint,\n"
29550 "                      va_list args);\n"
29551 "\n"
29552 msgstr ""
29553
29554 #. type: textblock
29555 #: ../src/guestfs-actions.pod:5435
29556 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
29557 msgstr ""
29558
29559 #. type: =head2
29560 #: ../src/guestfs-actions.pod:5439
29561 msgid "guestfs_mount_9p_argv"
29562 msgstr ""
29563
29564 #. type: verbatim
29565 #: ../src/guestfs-actions.pod:5441
29566 #, no-wrap
29567 msgid ""
29568 " int\n"
29569 " guestfs_mount_9p_argv (guestfs_h *g,\n"
29570 "                        const char *mounttag,\n"
29571 "                        const char *mountpoint,\n"
29572 "                        const struct guestfs_mount_9p_argv *optargs);\n"
29573 "\n"
29574 msgstr ""
29575
29576 #. type: textblock
29577 #: ../src/guestfs-actions.pod:5447
29578 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
29579 msgstr ""
29580
29581 #. type: =head2
29582 #: ../src/guestfs-actions.pod:5451
29583 msgid "guestfs_mount_loop"
29584 msgstr ""
29585
29586 #. type: verbatim
29587 #: ../src/guestfs-actions.pod:5453
29588 #, no-wrap
29589 msgid ""
29590 " int\n"
29591 " guestfs_mount_loop (guestfs_h *g,\n"
29592 "                     const char *file,\n"
29593 "                     const char *mountpoint);\n"
29594 "\n"
29595 msgstr ""
29596
29597 #. type: =head2
29598 #: ../src/guestfs-actions.pod:5466
29599 msgid "guestfs_mount_options"
29600 msgstr ""
29601
29602 #. type: verbatim
29603 #: ../src/guestfs-actions.pod:5468
29604 #, no-wrap
29605 msgid ""
29606 " int\n"
29607 " guestfs_mount_options (guestfs_h *g,\n"
29608 "                        const char *options,\n"
29609 "                        const char *device,\n"
29610 "                        const char *mountpoint);\n"
29611 "\n"
29612 msgstr ""
29613
29614 #. type: textblock
29615 #: ../src/guestfs-actions.pod:5474
29616 msgid ""
29617 "This is the same as the C<guestfs_mount> command, but it allows you to set "
29618 "the mount options as for the L<mount(8)> I<-o> flag."
29619 msgstr ""
29620
29621 #. type: textblock
29622 #: ../src/guestfs-actions.pod:5484 ../src/guestfs-actions.pod:5498 ../src/guestfs-actions.pod:5515
29623 msgid "(Added in 1.0.10)"
29624 msgstr ""
29625
29626 #. type: =head2
29627 #: ../src/guestfs-actions.pod:5486
29628 msgid "guestfs_mount_ro"
29629 msgstr ""
29630
29631 #. type: verbatim
29632 #: ../src/guestfs-actions.pod:5488
29633 #, no-wrap
29634 msgid ""
29635 " int\n"
29636 " guestfs_mount_ro (guestfs_h *g,\n"
29637 "                   const char *device,\n"
29638 "                   const char *mountpoint);\n"
29639 "\n"
29640 msgstr ""
29641
29642 #. type: textblock
29643 #: ../src/guestfs-actions.pod:5493
29644 msgid ""
29645 "This is the same as the C<guestfs_mount> command, but it mounts the "
29646 "filesystem with the read-only (I<-o ro>) flag."
29647 msgstr ""
29648
29649 #. type: =head2
29650 #: ../src/guestfs-actions.pod:5500
29651 msgid "guestfs_mount_vfs"
29652 msgstr ""
29653
29654 #. type: verbatim
29655 #: ../src/guestfs-actions.pod:5502
29656 #, no-wrap
29657 msgid ""
29658 " int\n"
29659 " guestfs_mount_vfs (guestfs_h *g,\n"
29660 "                    const char *options,\n"
29661 "                    const char *vfstype,\n"
29662 "                    const char *device,\n"
29663 "                    const char *mountpoint);\n"
29664 "\n"
29665 msgstr ""
29666
29667 #. type: textblock
29668 #: ../src/guestfs-actions.pod:5509
29669 msgid ""
29670 "This is the same as the C<guestfs_mount> command, but it allows you to set "
29671 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
29672 "I<-t> flags."
29673 msgstr ""
29674
29675 #. type: =head2
29676 #: ../src/guestfs-actions.pod:5517
29677 msgid "guestfs_mountpoints"
29678 msgstr ""
29679
29680 #. type: verbatim
29681 #: ../src/guestfs-actions.pod:5519
29682 #, no-wrap
29683 msgid ""
29684 " char **\n"
29685 " guestfs_mountpoints (guestfs_h *g);\n"
29686 "\n"
29687 msgstr ""
29688
29689 #. type: textblock
29690 #: ../src/guestfs-actions.pod:5522
29691 msgid ""
29692 "This call is similar to C<guestfs_mounts>.  That call returns a list of "
29693 "devices.  This one returns a hash table (map) of device name to directory "
29694 "where the device is mounted."
29695 msgstr ""
29696
29697 #. type: =head2
29698 #: ../src/guestfs-actions.pod:5534
29699 msgid "guestfs_mounts"
29700 msgstr ""
29701
29702 #. type: verbatim
29703 #: ../src/guestfs-actions.pod:5536
29704 #, no-wrap
29705 msgid ""
29706 " char **\n"
29707 " guestfs_mounts (guestfs_h *g);\n"
29708 "\n"
29709 msgstr ""
29710
29711 #. type: textblock
29712 #: ../src/guestfs-actions.pod:5544
29713 msgid "See also: C<guestfs_mountpoints>"
29714 msgstr ""
29715
29716 #. type: =head2
29717 #: ../src/guestfs-actions.pod:5552
29718 msgid "guestfs_mv"
29719 msgstr ""
29720
29721 #. type: verbatim
29722 #: ../src/guestfs-actions.pod:5554
29723 #, no-wrap
29724 msgid ""
29725 " int\n"
29726 " guestfs_mv (guestfs_h *g,\n"
29727 "             const char *src,\n"
29728 "             const char *dest);\n"
29729 "\n"
29730 msgstr ""
29731
29732 #. type: =head2
29733 #: ../src/guestfs-actions.pod:5566
29734 msgid "guestfs_ntfs_3g_probe"
29735 msgstr ""
29736
29737 #. type: verbatim
29738 #: ../src/guestfs-actions.pod:5568
29739 #, no-wrap
29740 msgid ""
29741 " int\n"
29742 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
29743 "                        int rw,\n"
29744 "                        const char *device);\n"
29745 "\n"
29746 msgstr ""
29747
29748 #. type: textblock
29749 #: ../src/guestfs-actions.pod:5587
29750 msgid "(Added in 1.0.43)"
29751 msgstr ""
29752
29753 #. type: =head2
29754 #: ../src/guestfs-actions.pod:5589
29755 msgid "guestfs_ntfsresize"
29756 msgstr ""
29757
29758 #. type: verbatim
29759 #: ../src/guestfs-actions.pod:5591
29760 #, no-wrap
29761 msgid ""
29762 " int\n"
29763 " guestfs_ntfsresize (guestfs_h *g,\n"
29764 "                     const char *device);\n"
29765 "\n"
29766 msgstr ""
29767
29768 #. type: textblock
29769 #: ../src/guestfs-actions.pod:5595 ../src/guestfs-actions.pod:5695
29770 msgid ""
29771 "I<This function is deprecated.> In new code, use the "
29772 "L</guestfs_ntfsresize_opts> call instead."
29773 msgstr ""
29774
29775 #. type: =head2
29776 #: ../src/guestfs-actions.pod:5619
29777 msgid "guestfs_ntfsresize_opts"
29778 msgstr ""
29779
29780 #. type: verbatim
29781 #: ../src/guestfs-actions.pod:5621
29782 #, no-wrap
29783 msgid ""
29784 " int\n"
29785 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
29786 "                          const char *device,\n"
29787 "                          ...);\n"
29788 "\n"
29789 msgstr ""
29790
29791 #. type: verbatim
29792 #: ../src/guestfs-actions.pod:5631
29793 #, no-wrap
29794 msgid ""
29795 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
29796 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
29797 "\n"
29798 msgstr ""
29799
29800 #. type: textblock
29801 #: ../src/guestfs-actions.pod:5651
29802 msgid ""
29803 "After the resize operation, the filesystem is always marked as requiring a "
29804 "consistency check (for safety).  You have to boot into Windows to perform "
29805 "this check and clear this condition.  If you I<don't> set the C<force> "
29806 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
29807 "times on a single filesystem without booting into Windows between each "
29808 "resize."
29809 msgstr ""
29810
29811 #. type: =head2
29812 #: ../src/guestfs-actions.pod:5666
29813 msgid "guestfs_ntfsresize_opts_va"
29814 msgstr ""
29815
29816 #. type: verbatim
29817 #: ../src/guestfs-actions.pod:5668
29818 #, no-wrap
29819 msgid ""
29820 " int\n"
29821 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
29822 "                             const char *device,\n"
29823 "                             va_list args);\n"
29824 "\n"
29825 msgstr ""
29826
29827 #. type: textblock
29828 #: ../src/guestfs-actions.pod:5673
29829 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
29830 msgstr ""
29831
29832 #. type: =head2
29833 #: ../src/guestfs-actions.pod:5677
29834 msgid "guestfs_ntfsresize_opts_argv"
29835 msgstr ""
29836
29837 #. type: verbatim
29838 #: ../src/guestfs-actions.pod:5679
29839 #, no-wrap
29840 msgid ""
29841 " int\n"
29842 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
29843 "                               const char *device,\n"
29844 "                               const struct guestfs_ntfsresize_opts_argv "
29845 "*optargs);\n"
29846 "\n"
29847 msgstr ""
29848
29849 #. type: textblock
29850 #: ../src/guestfs-actions.pod:5684
29851 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
29852 msgstr ""
29853
29854 #. type: =head2
29855 #: ../src/guestfs-actions.pod:5688
29856 msgid "guestfs_ntfsresize_size"
29857 msgstr ""
29858
29859 #. type: verbatim
29860 #: ../src/guestfs-actions.pod:5690
29861 #, no-wrap
29862 msgid ""
29863 " int\n"
29864 " guestfs_ntfsresize_size (guestfs_h *g,\n"
29865 "                          const char *device,\n"
29866 "                          int64_t size);\n"
29867 "\n"
29868 msgstr ""
29869
29870 #. type: textblock
29871 #: ../src/guestfs-actions.pod:5702
29872 msgid ""
29873 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
29874 "to specify the new size (in bytes) explicitly."
29875 msgstr ""
29876
29877 #. type: textblock
29878 #: ../src/guestfs-actions.pod:5707 ../src/guestfs-actions.pod:6166 ../src/guestfs-actions.pod:6239 ../src/guestfs-actions.pod:6507 ../src/guestfs-actions.pod:8134
29879 msgid "(Added in 1.3.14)"
29880 msgstr ""
29881
29882 #. type: =head2
29883 #: ../src/guestfs-actions.pod:5709
29884 msgid "guestfs_part_add"
29885 msgstr ""
29886
29887 #. type: verbatim
29888 #: ../src/guestfs-actions.pod:5711
29889 #, no-wrap
29890 msgid ""
29891 " int\n"
29892 " guestfs_part_add (guestfs_h *g,\n"
29893 "                   const char *device,\n"
29894 "                   const char *prlogex,\n"
29895 "                   int64_t startsect,\n"
29896 "                   int64_t endsect);\n"
29897 "\n"
29898 msgstr ""
29899
29900 #. type: textblock
29901 #: ../src/guestfs-actions.pod:5718
29902 msgid ""
29903 "This command adds a partition to C<device>.  If there is no partition table "
29904 "on the device, call C<guestfs_part_init> first."
29905 msgstr ""
29906
29907 #. type: textblock
29908 #: ../src/guestfs-actions.pod:5730
29909 msgid ""
29910 "Creating a partition which covers the whole disk is not so easy.  Use "
29911 "C<guestfs_part_disk> to do that."
29912 msgstr ""
29913
29914 #. type: textblock
29915 #: ../src/guestfs-actions.pod:5735 ../src/guestfs-actions.pod:5770 ../src/guestfs-actions.pod:5823 ../src/guestfs-actions.pod:5907 ../src/guestfs-actions.pod:5945 ../src/guestfs-actions.pod:5964 ../src/guestfs-actions.pod:6004
29916 msgid "(Added in 1.0.78)"
29917 msgstr ""
29918
29919 #. type: =head2
29920 #: ../src/guestfs-actions.pod:5737
29921 msgid "guestfs_part_del"
29922 msgstr ""
29923
29924 #. type: verbatim
29925 #: ../src/guestfs-actions.pod:5739
29926 #, no-wrap
29927 msgid ""
29928 " int\n"
29929 " guestfs_part_del (guestfs_h *g,\n"
29930 "                   const char *device,\n"
29931 "                   int partnum);\n"
29932 "\n"
29933 msgstr ""
29934
29935 #. type: =head2
29936 #: ../src/guestfs-actions.pod:5754
29937 msgid "guestfs_part_disk"
29938 msgstr ""
29939
29940 #. type: verbatim
29941 #: ../src/guestfs-actions.pod:5756
29942 #, no-wrap
29943 msgid ""
29944 " int\n"
29945 " guestfs_part_disk (guestfs_h *g,\n"
29946 "                    const char *device,\n"
29947 "                    const char *parttype);\n"
29948 "\n"
29949 msgstr ""
29950
29951 #. type: textblock
29952 #: ../src/guestfs-actions.pod:5761
29953 msgid ""
29954 "This command is simply a combination of C<guestfs_part_init> followed by "
29955 "C<guestfs_part_add> to create a single primary partition covering the whole "
29956 "disk."
29957 msgstr ""
29958
29959 #. type: textblock
29960 #: ../src/guestfs-actions.pod:5765
29961 msgid ""
29962 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
29963 "possible values are described in C<guestfs_part_init>."
29964 msgstr ""
29965
29966 #. type: =head2
29967 #: ../src/guestfs-actions.pod:5772
29968 msgid "guestfs_part_get_bootable"
29969 msgstr ""
29970
29971 #. type: verbatim
29972 #: ../src/guestfs-actions.pod:5774
29973 #, no-wrap
29974 msgid ""
29975 " int\n"
29976 " guestfs_part_get_bootable (guestfs_h *g,\n"
29977 "                            const char *device,\n"
29978 "                            int partnum);\n"
29979 "\n"
29980 msgstr ""
29981
29982 #. type: textblock
29983 #: ../src/guestfs-actions.pod:5782
29984 msgid "See also C<guestfs_part_set_bootable>."
29985 msgstr ""
29986
29987 #. type: =head2
29988 #: ../src/guestfs-actions.pod:5788
29989 msgid "guestfs_part_get_mbr_id"
29990 msgstr ""
29991
29992 #. type: verbatim
29993 #: ../src/guestfs-actions.pod:5790
29994 #, no-wrap
29995 msgid ""
29996 " int\n"
29997 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
29998 "                          const char *device,\n"
29999 "                          int partnum);\n"
30000 "\n"
30001 msgstr ""
30002
30003 #. type: textblock
30004 #: ../src/guestfs-actions.pod:5798 ../src/guestfs-actions.pod:5980
30005 msgid ""
30006 "Note that only MBR (old DOS-style) partitions have type bytes.  You will get "
30007 "undefined results for other partition table types (see "
30008 "C<guestfs_part_get_parttype>)."
30009 msgstr ""
30010
30011 #. type: =head2
30012 #: ../src/guestfs-actions.pod:5806
30013 msgid "guestfs_part_get_parttype"
30014 msgstr ""
30015
30016 #. type: verbatim
30017 #: ../src/guestfs-actions.pod:5808
30018 #, no-wrap
30019 msgid ""
30020 " char *\n"
30021 " guestfs_part_get_parttype (guestfs_h *g,\n"
30022 "                            const char *device);\n"
30023 "\n"
30024 msgstr ""
30025
30026 #. type: textblock
30027 #: ../src/guestfs-actions.pod:5815
30028 msgid ""
30029 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
30030 "table), C<gpt> (a GPT/EFI-style partition table).  Other values are "
30031 "possible, although unusual.  See C<guestfs_part_init> for a full list."
30032 msgstr ""
30033
30034 #. type: =head2
30035 #: ../src/guestfs-actions.pod:5825
30036 msgid "guestfs_part_init"
30037 msgstr ""
30038
30039 #. type: verbatim
30040 #: ../src/guestfs-actions.pod:5827
30041 #, no-wrap
30042 msgid ""
30043 " int\n"
30044 " guestfs_part_init (guestfs_h *g,\n"
30045 "                    const char *device,\n"
30046 "                    const char *parttype);\n"
30047 "\n"
30048 msgstr ""
30049
30050 #. type: textblock
30051 #: ../src/guestfs-actions.pod:5836
30052 msgid ""
30053 "Initially there are no partitions.  Following this, you should call "
30054 "C<guestfs_part_add> for each partition required."
30055 msgstr ""
30056
30057 #. type: =head2
30058 #: ../src/guestfs-actions.pod:5909
30059 msgid "guestfs_part_list"
30060 msgstr ""
30061
30062 #. type: verbatim
30063 #: ../src/guestfs-actions.pod:5911
30064 #, no-wrap
30065 msgid ""
30066 " struct guestfs_partition_list *\n"
30067 " guestfs_part_list (guestfs_h *g,\n"
30068 "                    const char *device);\n"
30069 "\n"
30070 msgstr ""
30071
30072 #. type: textblock
30073 #: ../src/guestfs-actions.pod:5928
30074 msgid ""
30075 "Start of the partition I<in bytes>.  To get sectors you have to divide by "
30076 "the device's sector size, see C<guestfs_blockdev_getss>."
30077 msgstr ""
30078
30079 #. type: textblock
30080 #: ../src/guestfs-actions.pod:5941
30081 msgid ""
30082 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
30083 "was an error.  I<The caller must call C<guestfs_free_partition_list> after "
30084 "use>."
30085 msgstr ""
30086
30087 #. type: =head2
30088 #: ../src/guestfs-actions.pod:5947
30089 msgid "guestfs_part_set_bootable"
30090 msgstr ""
30091
30092 #. type: verbatim
30093 #: ../src/guestfs-actions.pod:5949
30094 #, no-wrap
30095 msgid ""
30096 " int\n"
30097 " guestfs_part_set_bootable (guestfs_h *g,\n"
30098 "                            const char *device,\n"
30099 "                            int partnum,\n"
30100 "                            int bootable);\n"
30101 "\n"
30102 msgstr ""
30103
30104 #. type: =head2
30105 #: ../src/guestfs-actions.pod:5966
30106 msgid "guestfs_part_set_mbr_id"
30107 msgstr ""
30108
30109 #. type: verbatim
30110 #: ../src/guestfs-actions.pod:5968
30111 #, no-wrap
30112 msgid ""
30113 " int\n"
30114 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
30115 "                          const char *device,\n"
30116 "                          int partnum,\n"
30117 "                          int idbyte);\n"
30118 "\n"
30119 msgstr ""
30120
30121 #. type: =head2
30122 #: ../src/guestfs-actions.pod:5988
30123 msgid "guestfs_part_set_name"
30124 msgstr ""
30125
30126 #. type: verbatim
30127 #: ../src/guestfs-actions.pod:5990
30128 #, no-wrap
30129 msgid ""
30130 " int\n"
30131 " guestfs_part_set_name (guestfs_h *g,\n"
30132 "                        const char *device,\n"
30133 "                        int partnum,\n"
30134 "                        const char *name);\n"
30135 "\n"
30136 msgstr ""
30137
30138 #. type: =head2
30139 #: ../src/guestfs-actions.pod:6006
30140 msgid "guestfs_part_to_dev"
30141 msgstr ""
30142
30143 #. type: verbatim
30144 #: ../src/guestfs-actions.pod:6008
30145 #, no-wrap
30146 msgid ""
30147 " char *\n"
30148 " guestfs_part_to_dev (guestfs_h *g,\n"
30149 "                      const char *partition);\n"
30150 "\n"
30151 msgstr ""
30152
30153 #. type: textblock
30154 #: ../src/guestfs-actions.pod:6016 ../src/guestfs-actions.pod:6035
30155 msgid ""
30156 "The named partition must exist, for example as a string returned from "
30157 "C<guestfs_list_partitions>."
30158 msgstr ""
30159
30160 #. type: textblock
30161 #: ../src/guestfs-actions.pod:6019
30162 msgid "See also C<guestfs_part_to_partnum>."
30163 msgstr ""
30164
30165 #. type: =head2
30166 #: ../src/guestfs-actions.pod:6026
30167 msgid "guestfs_part_to_partnum"
30168 msgstr ""
30169
30170 #. type: verbatim
30171 #: ../src/guestfs-actions.pod:6028
30172 #, no-wrap
30173 msgid ""
30174 " int\n"
30175 " guestfs_part_to_partnum (guestfs_h *g,\n"
30176 "                          const char *partition);\n"
30177 "\n"
30178 msgstr ""
30179
30180 #. type: textblock
30181 #: ../src/guestfs-actions.pod:6038
30182 msgid "See also C<guestfs_part_to_dev>."
30183 msgstr ""
30184
30185 #. type: =head2
30186 #: ../src/guestfs-actions.pod:6044
30187 msgid "guestfs_ping_daemon"
30188 msgstr ""
30189
30190 #. type: verbatim
30191 #: ../src/guestfs-actions.pod:6046
30192 #, no-wrap
30193 msgid ""
30194 " int\n"
30195 " guestfs_ping_daemon (guestfs_h *g);\n"
30196 "\n"
30197 msgstr ""
30198
30199 #. type: =head2
30200 #: ../src/guestfs-actions.pod:6058
30201 msgid "guestfs_pread"
30202 msgstr ""
30203
30204 #. type: verbatim
30205 #: ../src/guestfs-actions.pod:6060
30206 #, no-wrap
30207 msgid ""
30208 " char *\n"
30209 " guestfs_pread (guestfs_h *g,\n"
30210 "                const char *path,\n"
30211 "                int count,\n"
30212 "                int64_t offset,\n"
30213 "                size_t *size_r);\n"
30214 "\n"
30215 msgstr ""
30216
30217 #. type: textblock
30218 #: ../src/guestfs-actions.pod:6073
30219 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
30220 msgstr ""
30221
30222 #. type: =head2
30223 #: ../src/guestfs-actions.pod:6084
30224 msgid "guestfs_pread_device"
30225 msgstr ""
30226
30227 #. type: verbatim
30228 #: ../src/guestfs-actions.pod:6086
30229 #, no-wrap
30230 msgid ""
30231 " char *\n"
30232 " guestfs_pread_device (guestfs_h *g,\n"
30233 "                       const char *device,\n"
30234 "                       int count,\n"
30235 "                       int64_t offset,\n"
30236 "                       size_t *size_r);\n"
30237 "\n"
30238 msgstr ""
30239
30240 #. type: textblock
30241 #: ../src/guestfs-actions.pod:6099
30242 msgid "See also C<guestfs_pread>."
30243 msgstr ""
30244
30245 #. type: textblock
30246 #: ../src/guestfs-actions.pod:6108
30247 msgid "(Added in 1.5.21)"
30248 msgstr ""
30249
30250 #. type: =head2
30251 #: ../src/guestfs-actions.pod:6110
30252 msgid "guestfs_pvcreate"
30253 msgstr ""
30254
30255 #. type: verbatim
30256 #: ../src/guestfs-actions.pod:6112
30257 #, no-wrap
30258 msgid ""
30259 " int\n"
30260 " guestfs_pvcreate (guestfs_h *g,\n"
30261 "                   const char *device);\n"
30262 "\n"
30263 msgstr ""
30264
30265 #. type: =head2
30266 #: ../src/guestfs-actions.pod:6124
30267 msgid "guestfs_pvremove"
30268 msgstr ""
30269
30270 #. type: verbatim
30271 #: ../src/guestfs-actions.pod:6126
30272 #, no-wrap
30273 msgid ""
30274 " int\n"
30275 " guestfs_pvremove (guestfs_h *g,\n"
30276 "                   const char *device);\n"
30277 "\n"
30278 msgstr ""
30279
30280 #. type: =head2
30281 #: ../src/guestfs-actions.pod:6141
30282 msgid "guestfs_pvresize"
30283 msgstr ""
30284
30285 #. type: verbatim
30286 #: ../src/guestfs-actions.pod:6143
30287 #, no-wrap
30288 msgid ""
30289 " int\n"
30290 " guestfs_pvresize (guestfs_h *g,\n"
30291 "                   const char *device);\n"
30292 "\n"
30293 msgstr ""
30294
30295 #. type: =head2
30296 #: ../src/guestfs-actions.pod:6154
30297 msgid "guestfs_pvresize_size"
30298 msgstr ""
30299
30300 #. type: verbatim
30301 #: ../src/guestfs-actions.pod:6156
30302 #, no-wrap
30303 msgid ""
30304 " int\n"
30305 " guestfs_pvresize_size (guestfs_h *g,\n"
30306 "                        const char *device,\n"
30307 "                        int64_t size);\n"
30308 "\n"
30309 msgstr ""
30310
30311 #. type: textblock
30312 #: ../src/guestfs-actions.pod:6161
30313 msgid ""
30314 "This command is the same as C<guestfs_pvresize> except that it allows you to "
30315 "specify the new size (in bytes) explicitly."
30316 msgstr ""
30317
30318 #. type: =head2
30319 #: ../src/guestfs-actions.pod:6168
30320 msgid "guestfs_pvs"
30321 msgstr ""
30322
30323 #. type: verbatim
30324 #: ../src/guestfs-actions.pod:6170
30325 #, no-wrap
30326 msgid ""
30327 " char **\n"
30328 " guestfs_pvs (guestfs_h *g);\n"
30329 "\n"
30330 msgstr ""
30331
30332 #. type: textblock
30333 #: ../src/guestfs-actions.pod:6179
30334 msgid "See also C<guestfs_pvs_full>."
30335 msgstr ""
30336
30337 #. type: =head2
30338 #: ../src/guestfs-actions.pod:6187
30339 msgid "guestfs_pvs_full"
30340 msgstr ""
30341
30342 #. type: verbatim
30343 #: ../src/guestfs-actions.pod:6189
30344 #, no-wrap
30345 msgid ""
30346 " struct guestfs_lvm_pv_list *\n"
30347 " guestfs_pvs_full (guestfs_h *g);\n"
30348 "\n"
30349 msgstr ""
30350
30351 #. type: textblock
30352 #: ../src/guestfs-actions.pod:6195
30353 msgid ""
30354 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
30355 "was an error.  I<The caller must call C<guestfs_free_lvm_pv_list> after "
30356 "use>."
30357 msgstr ""
30358
30359 #. type: =head2
30360 #: ../src/guestfs-actions.pod:6201
30361 msgid "guestfs_pvuuid"
30362 msgstr ""
30363
30364 #. type: verbatim
30365 #: ../src/guestfs-actions.pod:6203
30366 #, no-wrap
30367 msgid ""
30368 " char *\n"
30369 " guestfs_pvuuid (guestfs_h *g,\n"
30370 "                 const char *device);\n"
30371 "\n"
30372 msgstr ""
30373
30374 #. type: =head2
30375 #: ../src/guestfs-actions.pod:6214
30376 msgid "guestfs_pwrite"
30377 msgstr ""
30378
30379 #. type: verbatim
30380 #: ../src/guestfs-actions.pod:6216
30381 #, no-wrap
30382 msgid ""
30383 " int\n"
30384 " guestfs_pwrite (guestfs_h *g,\n"
30385 "                 const char *path,\n"
30386 "                 const char *content,\n"
30387 "                 size_t content_size,\n"
30388 "                 int64_t offset);\n"
30389 "\n"
30390 msgstr ""
30391
30392 #. type: textblock
30393 #: ../src/guestfs-actions.pod:6232
30394 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
30395 msgstr ""
30396
30397 #. type: =head2
30398 #: ../src/guestfs-actions.pod:6241
30399 msgid "guestfs_pwrite_device"
30400 msgstr ""
30401
30402 #. type: verbatim
30403 #: ../src/guestfs-actions.pod:6243
30404 #, no-wrap
30405 msgid ""
30406 " int\n"
30407 " guestfs_pwrite_device (guestfs_h *g,\n"
30408 "                        const char *device,\n"
30409 "                        const char *content,\n"
30410 "                        size_t content_size,\n"
30411 "                        int64_t offset);\n"
30412 "\n"
30413 msgstr ""
30414
30415 #. type: textblock
30416 #: ../src/guestfs-actions.pod:6258
30417 msgid "See also C<guestfs_pwrite>."
30418 msgstr ""
30419
30420 #. type: textblock
30421 #: ../src/guestfs-actions.pod:6265
30422 msgid "(Added in 1.5.20)"
30423 msgstr ""
30424
30425 #. type: =head2
30426 #: ../src/guestfs-actions.pod:6267
30427 msgid "guestfs_read_file"
30428 msgstr ""
30429
30430 #. type: verbatim
30431 #: ../src/guestfs-actions.pod:6269
30432 #, no-wrap
30433 msgid ""
30434 " char *\n"
30435 " guestfs_read_file (guestfs_h *g,\n"
30436 "                    const char *path,\n"
30437 "                    size_t *size_r);\n"
30438 "\n"
30439 msgstr ""
30440
30441 #. type: textblock
30442 #: ../src/guestfs-actions.pod:6277
30443 msgid ""
30444 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
30445 "embedded ASCII NUL characters.  However unlike C<guestfs_download>, this "
30446 "function is limited in the total size of file that can be handled."
30447 msgstr ""
30448
30449 #. type: textblock
30450 #: ../src/guestfs-actions.pod:6289
30451 msgid "(Added in 1.0.63)"
30452 msgstr ""
30453
30454 #. type: =head2
30455 #: ../src/guestfs-actions.pod:6291
30456 msgid "guestfs_read_lines"
30457 msgstr ""
30458
30459 #. type: verbatim
30460 #: ../src/guestfs-actions.pod:6293
30461 #, no-wrap
30462 msgid ""
30463 " char **\n"
30464 " guestfs_read_lines (guestfs_h *g,\n"
30465 "                     const char *path);\n"
30466 "\n"
30467 msgstr ""
30468
30469 #. type: textblock
30470 #: ../src/guestfs-actions.pod:6302
30471 msgid ""
30472 "Note that this function cannot correctly handle binary files (specifically, "
30473 "files containing C<\\0> character which is treated as end of line).  For "
30474 "those you need to use the C<guestfs_read_file> function which has a more "
30475 "complex interface."
30476 msgstr ""
30477
30478 #. type: =head2
30479 #: ../src/guestfs-actions.pod:6313
30480 msgid "guestfs_readdir"
30481 msgstr ""
30482
30483 #. type: verbatim
30484 #: ../src/guestfs-actions.pod:6315
30485 #, no-wrap
30486 msgid ""
30487 " struct guestfs_dirent_list *\n"
30488 " guestfs_readdir (guestfs_h *g,\n"
30489 "                  const char *dir);\n"
30490 "\n"
30491 msgstr ""
30492
30493 #. type: textblock
30494 #: ../src/guestfs-actions.pod:6369
30495 msgid ""
30496 "This function is primarily intended for use by programs.  To get a simple "
30497 "list of names, use C<guestfs_ls>.  To get a printable directory for human "
30498 "consumption, use C<guestfs_ll>."
30499 msgstr ""
30500
30501 #. type: textblock
30502 #: ../src/guestfs-actions.pod:6373
30503 msgid ""
30504 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
30505 "was an error.  I<The caller must call C<guestfs_free_dirent_list> after "
30506 "use>."
30507 msgstr ""
30508
30509 #. type: =head2
30510 #: ../src/guestfs-actions.pod:6379
30511 msgid "guestfs_readlink"
30512 msgstr ""
30513
30514 #. type: verbatim
30515 #: ../src/guestfs-actions.pod:6381
30516 #, no-wrap
30517 msgid ""
30518 " char *\n"
30519 " guestfs_readlink (guestfs_h *g,\n"
30520 "                   const char *path);\n"
30521 "\n"
30522 msgstr ""
30523
30524 #. type: =head2
30525 #: ../src/guestfs-actions.pod:6392
30526 msgid "guestfs_readlinklist"
30527 msgstr ""
30528
30529 #. type: verbatim
30530 #: ../src/guestfs-actions.pod:6394
30531 #, no-wrap
30532 msgid ""
30533 " char **\n"
30534 " guestfs_readlinklist (guestfs_h *g,\n"
30535 "                       const char *path,\n"
30536 "                       char *const *names);\n"
30537 "\n"
30538 msgstr ""
30539
30540 #. type: =head2
30541 #: ../src/guestfs-actions.pod:6427
30542 msgid "guestfs_realpath"
30543 msgstr ""
30544
30545 #. type: verbatim
30546 #: ../src/guestfs-actions.pod:6429
30547 #, no-wrap
30548 msgid ""
30549 " char *\n"
30550 " guestfs_realpath (guestfs_h *g,\n"
30551 "                   const char *path);\n"
30552 "\n"
30553 msgstr ""
30554
30555 #. type: =head2
30556 #: ../src/guestfs-actions.pod:6441
30557 msgid "guestfs_removexattr"
30558 msgstr ""
30559
30560 #. type: verbatim
30561 #: ../src/guestfs-actions.pod:6443
30562 #, no-wrap
30563 msgid ""
30564 " int\n"
30565 " guestfs_removexattr (guestfs_h *g,\n"
30566 "                      const char *xattr,\n"
30567 "                      const char *path);\n"
30568 "\n"
30569 msgstr ""
30570
30571 #. type: textblock
30572 #: ../src/guestfs-actions.pod:6451
30573 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
30574 msgstr ""
30575
30576 #. type: =head2
30577 #: ../src/guestfs-actions.pod:6457
30578 msgid "guestfs_resize2fs"
30579 msgstr ""
30580
30581 #. type: verbatim
30582 #: ../src/guestfs-actions.pod:6459
30583 #, no-wrap
30584 msgid ""
30585 " int\n"
30586 " guestfs_resize2fs (guestfs_h *g,\n"
30587 "                    const char *device);\n"
30588 "\n"
30589 msgstr ""
30590
30591 #. type: textblock
30592 #: ../src/guestfs-actions.pod:6466
30593 msgid ""
30594 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
30595 "C<device> before calling this command.  For unknown reasons C<resize2fs> "
30596 "sometimes gives an error about this and sometimes not.  In any case, it is "
30597 "always safe to call C<guestfs_e2fsck_f> before calling this function."
30598 msgstr ""
30599
30600 #. type: =head2
30601 #: ../src/guestfs-actions.pod:6476
30602 msgid "guestfs_resize2fs_M"
30603 msgstr ""
30604
30605 #. type: verbatim
30606 #: ../src/guestfs-actions.pod:6478
30607 #, no-wrap
30608 msgid ""
30609 " int\n"
30610 " guestfs_resize2fs_M (guestfs_h *g,\n"
30611 "                      const char *device);\n"
30612 "\n"
30613 msgstr ""
30614
30615 #. type: textblock
30616 #: ../src/guestfs-actions.pod:6482
30617 msgid ""
30618 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
30619 "resized to its minimum size.  This works like the I<-M> option to the "
30620 "C<resize2fs> command."
30621 msgstr ""
30622
30623 #. type: textblock
30624 #: ../src/guestfs-actions.pod:6486
30625 msgid ""
30626 "To get the resulting size of the filesystem you should call "
30627 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values.  "
30628 "These two numbers, multiplied together, give the resulting size of the "
30629 "minimal filesystem in bytes."
30630 msgstr ""
30631
30632 #. type: =head2
30633 #: ../src/guestfs-actions.pod:6495
30634 msgid "guestfs_resize2fs_size"
30635 msgstr ""
30636
30637 #. type: verbatim
30638 #: ../src/guestfs-actions.pod:6497
30639 #, no-wrap
30640 msgid ""
30641 " int\n"
30642 " guestfs_resize2fs_size (guestfs_h *g,\n"
30643 "                         const char *device,\n"
30644 "                         int64_t size);\n"
30645 "\n"
30646 msgstr ""
30647
30648 #. type: textblock
30649 #: ../src/guestfs-actions.pod:6502
30650 msgid ""
30651 "This command is the same as C<guestfs_resize2fs> except that it allows you "
30652 "to specify the new size (in bytes) explicitly."
30653 msgstr ""
30654
30655 #. type: =head2
30656 #: ../src/guestfs-actions.pod:6509
30657 msgid "guestfs_rm"
30658 msgstr ""
30659
30660 #. type: verbatim
30661 #: ../src/guestfs-actions.pod:6511
30662 #, no-wrap
30663 msgid ""
30664 " int\n"
30665 " guestfs_rm (guestfs_h *g,\n"
30666 "             const char *path);\n"
30667 "\n"
30668 msgstr ""
30669
30670 #. type: =head2
30671 #: ../src/guestfs-actions.pod:6521
30672 msgid "guestfs_rm_rf"
30673 msgstr ""
30674
30675 #. type: verbatim
30676 #: ../src/guestfs-actions.pod:6523
30677 #, no-wrap
30678 msgid ""
30679 " int\n"
30680 " guestfs_rm_rf (guestfs_h *g,\n"
30681 "                const char *path);\n"
30682 "\n"
30683 msgstr ""
30684
30685 #. type: =head2
30686 #: ../src/guestfs-actions.pod:6535
30687 msgid "guestfs_rmdir"
30688 msgstr ""
30689
30690 #. type: verbatim
30691 #: ../src/guestfs-actions.pod:6537
30692 #, no-wrap
30693 msgid ""
30694 " int\n"
30695 " guestfs_rmdir (guestfs_h *g,\n"
30696 "                const char *path);\n"
30697 "\n"
30698 msgstr ""
30699
30700 #. type: =head2
30701 #: ../src/guestfs-actions.pod:6547
30702 msgid "guestfs_rmmountpoint"
30703 msgstr ""
30704
30705 #. type: verbatim
30706 #: ../src/guestfs-actions.pod:6549
30707 #, no-wrap
30708 msgid ""
30709 " int\n"
30710 " guestfs_rmmountpoint (guestfs_h *g,\n"
30711 "                       const char *exemptpath);\n"
30712 "\n"
30713 msgstr ""
30714
30715 #. type: textblock
30716 #: ../src/guestfs-actions.pod:6553
30717 msgid ""
30718 "This calls removes a mountpoint that was previously created with "
30719 "C<guestfs_mkmountpoint>.  See C<guestfs_mkmountpoint> for full details."
30720 msgstr ""
30721
30722 #. type: =head2
30723 #: ../src/guestfs-actions.pod:6561
30724 msgid "guestfs_scrub_device"
30725 msgstr ""
30726
30727 #. type: verbatim
30728 #: ../src/guestfs-actions.pod:6563
30729 #, no-wrap
30730 msgid ""
30731 " int\n"
30732 " guestfs_scrub_device (guestfs_h *g,\n"
30733 "                       const char *device);\n"
30734 "\n"
30735 msgstr ""
30736
30737 #. type: textblock
30738 #: ../src/guestfs-actions.pod:6575 ../src/guestfs-actions.pod:6593 ../src/guestfs-actions.pod:6612
30739 msgid "(Added in 1.0.52)"
30740 msgstr ""
30741
30742 #. type: =head2
30743 #: ../src/guestfs-actions.pod:6577
30744 msgid "guestfs_scrub_file"
30745 msgstr ""
30746
30747 #. type: verbatim
30748 #: ../src/guestfs-actions.pod:6579
30749 #, no-wrap
30750 msgid ""
30751 " int\n"
30752 " guestfs_scrub_file (guestfs_h *g,\n"
30753 "                     const char *file);\n"
30754 "\n"
30755 msgstr ""
30756
30757 #. type: =head2
30758 #: ../src/guestfs-actions.pod:6595
30759 msgid "guestfs_scrub_freespace"
30760 msgstr ""
30761
30762 #. type: verbatim
30763 #: ../src/guestfs-actions.pod:6597
30764 #, no-wrap
30765 msgid ""
30766 " int\n"
30767 " guestfs_scrub_freespace (guestfs_h *g,\n"
30768 "                          const char *dir);\n"
30769 "\n"
30770 msgstr ""
30771
30772 #. type: textblock
30773 #: ../src/guestfs-actions.pod:6601
30774 msgid ""
30775 "This command creates the directory C<dir> and then fills it with files until "
30776 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
30777 "and deletes them.  The intention is to scrub any free space on the partition "
30778 "containing C<dir>."
30779 msgstr ""
30780
30781 #. type: =head2
30782 #: ../src/guestfs-actions.pod:6614
30783 msgid "guestfs_set_append"
30784 msgstr ""
30785
30786 #. type: verbatim
30787 #: ../src/guestfs-actions.pod:6616
30788 #, no-wrap
30789 msgid ""
30790 " int\n"
30791 " guestfs_set_append (guestfs_h *g,\n"
30792 "                     const char *append);\n"
30793 "\n"
30794 msgstr ""
30795
30796 #. type: =head2
30797 #: ../src/guestfs-actions.pod:6633
30798 msgid "guestfs_set_attach_method"
30799 msgstr ""
30800
30801 #. type: verbatim
30802 #: ../src/guestfs-actions.pod:6635
30803 #, no-wrap
30804 msgid ""
30805 " int\n"
30806 " guestfs_set_attach_method (guestfs_h *g,\n"
30807 "                            const char *attachmethod);\n"
30808 "\n"
30809 msgstr ""
30810
30811 #. type: =head2
30812 #: ../src/guestfs-actions.pod:6663
30813 msgid "guestfs_set_autosync"
30814 msgstr ""
30815
30816 #. type: verbatim
30817 #: ../src/guestfs-actions.pod:6665
30818 #, no-wrap
30819 msgid ""
30820 " int\n"
30821 " guestfs_set_autosync (guestfs_h *g,\n"
30822 "                       int autosync);\n"
30823 "\n"
30824 msgstr ""
30825
30826 #. type: =head2
30827 #: ../src/guestfs-actions.pod:6681
30828 msgid "guestfs_set_direct"
30829 msgstr ""
30830
30831 #. type: verbatim
30832 #: ../src/guestfs-actions.pod:6683
30833 #, no-wrap
30834 msgid ""
30835 " int\n"
30836 " guestfs_set_direct (guestfs_h *g,\n"
30837 "                     int direct);\n"
30838 "\n"
30839 msgstr ""
30840
30841 #. type: textblock
30842 #: ../src/guestfs-actions.pod:6691
30843 msgid ""
30844 "One consequence of this is that log messages aren't caught by the library "
30845 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
30846 "stdout."
30847 msgstr ""
30848
30849 #. type: =head2
30850 #: ../src/guestfs-actions.pod:6704
30851 msgid "guestfs_set_e2label"
30852 msgstr ""
30853
30854 #. type: verbatim
30855 #: ../src/guestfs-actions.pod:6706
30856 #, no-wrap
30857 msgid ""
30858 " int\n"
30859 " guestfs_set_e2label (guestfs_h *g,\n"
30860 "                      const char *device,\n"
30861 "                      const char *label);\n"
30862 "\n"
30863 msgstr ""
30864
30865 #. type: textblock
30866 #: ../src/guestfs-actions.pod:6715
30867 msgid ""
30868 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
30869 "the existing label on a filesystem."
30870 msgstr ""
30871
30872 #. type: =head2
30873 #: ../src/guestfs-actions.pod:6722
30874 msgid "guestfs_set_e2uuid"
30875 msgstr ""
30876
30877 #. type: verbatim
30878 #: ../src/guestfs-actions.pod:6724
30879 #, no-wrap
30880 msgid ""
30881 " int\n"
30882 " guestfs_set_e2uuid (guestfs_h *g,\n"
30883 "                     const char *device,\n"
30884 "                     const char *uuid);\n"
30885 "\n"
30886 msgstr ""
30887
30888 #. type: textblock
30889 #: ../src/guestfs-actions.pod:6734
30890 msgid ""
30891 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
30892 "the existing UUID of a filesystem."
30893 msgstr ""
30894
30895 #. type: =head2
30896 #: ../src/guestfs-actions.pod:6741
30897 msgid "guestfs_set_memsize"
30898 msgstr ""
30899
30900 #. type: verbatim
30901 #: ../src/guestfs-actions.pod:6743
30902 #, no-wrap
30903 msgid ""
30904 " int\n"
30905 " guestfs_set_memsize (guestfs_h *g,\n"
30906 "                      int memsize);\n"
30907 "\n"
30908 msgstr ""
30909
30910 #. type: textblock
30911 #: ../src/guestfs-actions.pod:6747
30912 msgid ""
30913 "This sets the memory size in megabytes allocated to the qemu subprocess.  "
30914 "This only has any effect if called before C<guestfs_launch>."
30915 msgstr ""
30916
30917 #. type: =head2
30918 #: ../src/guestfs-actions.pod:6762
30919 msgid "guestfs_set_network"
30920 msgstr ""
30921
30922 #. type: verbatim
30923 #: ../src/guestfs-actions.pod:6764
30924 #, no-wrap
30925 msgid ""
30926 " int\n"
30927 " guestfs_set_network (guestfs_h *g,\n"
30928 "                      int network);\n"
30929 "\n"
30930 msgstr ""
30931
30932 #. type: textblock
30933 #: ../src/guestfs-actions.pod:6774
30934 msgid ""
30935 "You must call this before calling C<guestfs_launch>, otherwise it has no "
30936 "effect."
30937 msgstr ""
30938
30939 #. type: =head2
30940 #: ../src/guestfs-actions.pod:6781
30941 msgid "guestfs_set_path"
30942 msgstr ""
30943
30944 #. type: verbatim
30945 #: ../src/guestfs-actions.pod:6783
30946 #, no-wrap
30947 msgid ""
30948 " int\n"
30949 " guestfs_set_path (guestfs_h *g,\n"
30950 "                   const char *searchpath);\n"
30951 "\n"
30952 msgstr ""
30953
30954 #. type: =head2
30955 #: ../src/guestfs-actions.pod:6798
30956 msgid "guestfs_set_pgroup"
30957 msgstr ""
30958
30959 #. type: verbatim
30960 #: ../src/guestfs-actions.pod:6800
30961 #, no-wrap
30962 msgid ""
30963 " int\n"
30964 " guestfs_set_pgroup (guestfs_h *g,\n"
30965 "                     int pgroup);\n"
30966 "\n"
30967 msgstr ""
30968
30969 #. type: =head2
30970 #: ../src/guestfs-actions.pod:6817
30971 msgid "guestfs_set_qemu"
30972 msgstr ""
30973
30974 #. type: verbatim
30975 #: ../src/guestfs-actions.pod:6819
30976 #, no-wrap
30977 msgid ""
30978 " int\n"
30979 " guestfs_set_qemu (guestfs_h *g,\n"
30980 "                   const char *qemu);\n"
30981 "\n"
30982 msgstr ""
30983
30984 #. type: =head2
30985 #: ../src/guestfs-actions.pod:6845
30986 msgid "guestfs_set_recovery_proc"
30987 msgstr ""
30988
30989 #. type: verbatim
30990 #: ../src/guestfs-actions.pod:6847
30991 #, no-wrap
30992 msgid ""
30993 " int\n"
30994 " guestfs_set_recovery_proc (guestfs_h *g,\n"
30995 "                            int recoveryproc);\n"
30996 "\n"
30997 msgstr ""
30998
30999 #. type: textblock
31000 #: ../src/guestfs-actions.pod:6851
31001 msgid ""
31002 "If this is called with the parameter C<false> then C<guestfs_launch> does "
31003 "not create a recovery process.  The purpose of the recovery process is to "
31004 "stop runaway qemu processes in the case where the main program aborts "
31005 "abruptly."
31006 msgstr ""
31007
31008 #. type: textblock
31009 #: ../src/guestfs-actions.pod:6856
31010 msgid ""
31011 "This only has any effect if called before C<guestfs_launch>, and the default "
31012 "is true."
31013 msgstr ""
31014
31015 #. type: =head2
31016 #: ../src/guestfs-actions.pod:6869
31017 msgid "guestfs_set_selinux"
31018 msgstr ""
31019
31020 #. type: verbatim
31021 #: ../src/guestfs-actions.pod:6871
31022 #, no-wrap
31023 msgid ""
31024 " int\n"
31025 " guestfs_set_selinux (guestfs_h *g,\n"
31026 "                      int selinux);\n"
31027 "\n"
31028 msgstr ""
31029
31030 #. type: =head2
31031 #: ../src/guestfs-actions.pod:6888
31032 msgid "guestfs_set_smp"
31033 msgstr ""
31034
31035 #. type: verbatim
31036 #: ../src/guestfs-actions.pod:6890
31037 #, no-wrap
31038 msgid ""
31039 " int\n"
31040 " guestfs_set_smp (guestfs_h *g,\n"
31041 "                  int smp);\n"
31042 "\n"
31043 msgstr ""
31044
31045 #. type: textblock
31046 #: ../src/guestfs-actions.pod:6898
31047 msgid "This function must be called before C<guestfs_launch>."
31048 msgstr ""
31049
31050 #. type: =head2
31051 #: ../src/guestfs-actions.pod:6904
31052 msgid "guestfs_set_trace"
31053 msgstr ""
31054
31055 #. type: verbatim
31056 #: ../src/guestfs-actions.pod:6906
31057 #, no-wrap
31058 msgid ""
31059 " int\n"
31060 " guestfs_set_trace (guestfs_h *g,\n"
31061 "                    int trace);\n"
31062 "\n"
31063 msgstr ""
31064
31065 #. type: textblock
31066 #: ../src/guestfs-actions.pod:6920
31067 msgid ""
31068 "Trace messages are normally sent to C<stderr>, unless you register a "
31069 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
31070 msgstr ""
31071
31072 #. type: =head2
31073 #: ../src/guestfs-actions.pod:6928
31074 msgid "guestfs_set_verbose"
31075 msgstr ""
31076
31077 #. type: verbatim
31078 #: ../src/guestfs-actions.pod:6930
31079 #, no-wrap
31080 msgid ""
31081 " int\n"
31082 " guestfs_set_verbose (guestfs_h *g,\n"
31083 "                      int verbose);\n"
31084 "\n"
31085 msgstr ""
31086
31087 #. type: textblock
31088 #: ../src/guestfs-actions.pod:6939
31089 msgid ""
31090 "Verbose messages are normally sent to C<stderr>, unless you register a "
31091 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
31092 msgstr ""
31093
31094 #. type: =head2
31095 #: ../src/guestfs-actions.pod:6947
31096 msgid "guestfs_setcon"
31097 msgstr ""
31098
31099 #. type: verbatim
31100 #: ../src/guestfs-actions.pod:6949
31101 #, no-wrap
31102 msgid ""
31103 " int\n"
31104 " guestfs_setcon (guestfs_h *g,\n"
31105 "                 const char *context);\n"
31106 "\n"
31107 msgstr ""
31108
31109 #. type: =head2
31110 #: ../src/guestfs-actions.pod:6962
31111 msgid "guestfs_setxattr"
31112 msgstr ""
31113
31114 #. type: verbatim
31115 #: ../src/guestfs-actions.pod:6964
31116 #, no-wrap
31117 msgid ""
31118 " int\n"
31119 " guestfs_setxattr (guestfs_h *g,\n"
31120 "                   const char *xattr,\n"
31121 "                   const char *val,\n"
31122 "                   int vallen,\n"
31123 "                   const char *path);\n"
31124 "\n"
31125 msgstr ""
31126
31127 #. type: textblock
31128 #: ../src/guestfs-actions.pod:6975
31129 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
31130 msgstr ""
31131
31132 #. type: =head2
31133 #: ../src/guestfs-actions.pod:6981
31134 msgid "guestfs_sfdisk"
31135 msgstr ""
31136
31137 #. type: verbatim
31138 #: ../src/guestfs-actions.pod:6983
31139 #, no-wrap
31140 msgid ""
31141 " int\n"
31142 " guestfs_sfdisk (guestfs_h *g,\n"
31143 "                 const char *device,\n"
31144 "                 int cyls,\n"
31145 "                 int heads,\n"
31146 "                 int sectors,\n"
31147 "                 char *const *lines);\n"
31148 "\n"
31149 msgstr ""
31150
31151 #. type: textblock
31152 #: ../src/guestfs-actions.pod:6991 ../src/guestfs-actions.pod:7032 ../src/guestfs-actions.pod:7063
31153 msgid ""
31154 "I<This function is deprecated.> In new code, use the L</guestfs_part_add> "
31155 "call instead."
31156 msgstr ""
31157
31158 #. type: textblock
31159 #: ../src/guestfs-actions.pod:7018
31160 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
31161 msgstr ""
31162
31163 #. type: =head2
31164 #: ../src/guestfs-actions.pod:7025
31165 msgid "guestfs_sfdiskM"
31166 msgstr ""
31167
31168 #. type: verbatim
31169 #: ../src/guestfs-actions.pod:7027
31170 #, no-wrap
31171 msgid ""
31172 " int\n"
31173 " guestfs_sfdiskM (guestfs_h *g,\n"
31174 "                  const char *device,\n"
31175 "                  char *const *lines);\n"
31176 "\n"
31177 msgstr ""
31178
31179 #. type: textblock
31180 #: ../src/guestfs-actions.pod:7039
31181 msgid ""
31182 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
31183 "partition sizes are specified in megabytes only (rounded to the nearest "
31184 "cylinder) and you don't need to specify the cyls, heads and sectors "
31185 "parameters which were rarely if ever used anyway."
31186 msgstr ""
31187
31188 #. type: textblock
31189 #: ../src/guestfs-actions.pod:7045
31190 msgid ""
31191 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
31192 "C<guestfs_part_disk>"
31193 msgstr ""
31194
31195 #. type: =head2
31196 #: ../src/guestfs-actions.pod:7052
31197 msgid "guestfs_sfdisk_N"
31198 msgstr ""
31199
31200 #. type: verbatim
31201 #: ../src/guestfs-actions.pod:7054
31202 #, no-wrap
31203 msgid ""
31204 " int\n"
31205 " guestfs_sfdisk_N (guestfs_h *g,\n"
31206 "                   const char *device,\n"
31207 "                   int partnum,\n"
31208 "                   int cyls,\n"
31209 "                   int heads,\n"
31210 "                   int sectors,\n"
31211 "                   const char *line);\n"
31212 "\n"
31213 msgstr ""
31214
31215 #. type: textblock
31216 #: ../src/guestfs-actions.pod:7073
31217 msgid ""
31218 "For other parameters, see C<guestfs_sfdisk>.  You should usually pass C<0> "
31219 "for the cyls/heads/sectors parameters."
31220 msgstr ""
31221
31222 #. type: textblock
31223 #: ../src/guestfs-actions.pod:7076
31224 msgid "See also: C<guestfs_part_add>"
31225 msgstr ""
31226
31227 #. type: =head2
31228 #: ../src/guestfs-actions.pod:7082
31229 msgid "guestfs_sfdisk_disk_geometry"
31230 msgstr ""
31231
31232 #. type: verbatim
31233 #: ../src/guestfs-actions.pod:7084
31234 #, no-wrap
31235 msgid ""
31236 " char *\n"
31237 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
31238 "                               const char *device);\n"
31239 "\n"
31240 msgstr ""
31241
31242 #. type: textblock
31243 #: ../src/guestfs-actions.pod:7088
31244 msgid ""
31245 "This displays the disk geometry of C<device> read from the partition table.  "
31246 "Especially in the case where the underlying block device has been resized, "
31247 "this can be different from the kernel's idea of the geometry (see "
31248 "C<guestfs_sfdisk_kernel_geometry>)."
31249 msgstr ""
31250
31251 #. type: =head2
31252 #: ../src/guestfs-actions.pod:7101
31253 msgid "guestfs_sfdisk_kernel_geometry"
31254 msgstr ""
31255
31256 #. type: verbatim
31257 #: ../src/guestfs-actions.pod:7103
31258 #, no-wrap
31259 msgid ""
31260 " char *\n"
31261 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
31262 "                                 const char *device);\n"
31263 "\n"
31264 msgstr ""
31265
31266 #. type: =head2
31267 #: ../src/guestfs-actions.pod:7117
31268 msgid "guestfs_sfdisk_l"
31269 msgstr ""
31270
31271 #. type: verbatim
31272 #: ../src/guestfs-actions.pod:7119
31273 #, no-wrap
31274 msgid ""
31275 " char *\n"
31276 " guestfs_sfdisk_l (guestfs_h *g,\n"
31277 "                   const char *device);\n"
31278 "\n"
31279 msgstr ""
31280
31281 #. type: textblock
31282 #: ../src/guestfs-actions.pod:7123
31283 msgid ""
31284 "I<This function is deprecated.> In new code, use the L</guestfs_part_list> "
31285 "call instead."
31286 msgstr ""
31287
31288 #. type: textblock
31289 #: ../src/guestfs-actions.pod:7134
31290 msgid "See also: C<guestfs_part_list>"
31291 msgstr ""
31292
31293 #. type: =head2
31294 #: ../src/guestfs-actions.pod:7141
31295 msgid "guestfs_sh"
31296 msgstr ""
31297
31298 #. type: verbatim
31299 #: ../src/guestfs-actions.pod:7143
31300 #, no-wrap
31301 msgid ""
31302 " char *\n"
31303 " guestfs_sh (guestfs_h *g,\n"
31304 "             const char *command);\n"
31305 "\n"
31306 msgstr ""
31307
31308 #. type: textblock
31309 #: ../src/guestfs-actions.pod:7150
31310 msgid "This is like C<guestfs_command>, but passes the command to:"
31311 msgstr ""
31312
31313 #. type: textblock
31314 #: ../src/guestfs-actions.pod:7158
31315 msgid "All the provisos about C<guestfs_command> apply to this call."
31316 msgstr ""
31317
31318 #. type: =head2
31319 #: ../src/guestfs-actions.pod:7165
31320 msgid "guestfs_sh_lines"
31321 msgstr ""
31322
31323 #. type: verbatim
31324 #: ../src/guestfs-actions.pod:7167
31325 #, no-wrap
31326 msgid ""
31327 " char **\n"
31328 " guestfs_sh_lines (guestfs_h *g,\n"
31329 "                   const char *command);\n"
31330 "\n"
31331 msgstr ""
31332
31333 #. type: textblock
31334 #: ../src/guestfs-actions.pod:7171
31335 msgid ""
31336 "This is the same as C<guestfs_sh>, but splits the result into a list of "
31337 "lines."
31338 msgstr ""
31339
31340 #. type: textblock
31341 #: ../src/guestfs-actions.pod:7174
31342 msgid "See also: C<guestfs_command_lines>"
31343 msgstr ""
31344
31345 #. type: =head2
31346 #: ../src/guestfs-actions.pod:7182
31347 msgid "guestfs_sleep"
31348 msgstr ""
31349
31350 #. type: verbatim
31351 #: ../src/guestfs-actions.pod:7184
31352 #, no-wrap
31353 msgid ""
31354 " int\n"
31355 " guestfs_sleep (guestfs_h *g,\n"
31356 "                int secs);\n"
31357 "\n"
31358 msgstr ""
31359
31360 #. type: textblock
31361 #: ../src/guestfs-actions.pod:7192
31362 msgid "(Added in 1.0.41)"
31363 msgstr ""
31364
31365 #. type: =head2
31366 #: ../src/guestfs-actions.pod:7194 ../src/guestfs-structs.pod:109
31367 msgid "guestfs_stat"
31368 msgstr ""
31369
31370 #. type: verbatim
31371 #: ../src/guestfs-actions.pod:7196
31372 #, no-wrap
31373 msgid ""
31374 " struct guestfs_stat *\n"
31375 " guestfs_stat (guestfs_h *g,\n"
31376 "               const char *path);\n"
31377 "\n"
31378 msgstr ""
31379
31380 #. type: =head2
31381 #: ../src/guestfs-actions.pod:7210 ../src/guestfs-structs.pod:135
31382 msgid "guestfs_statvfs"
31383 msgstr ""
31384
31385 #. type: verbatim
31386 #: ../src/guestfs-actions.pod:7212
31387 #, no-wrap
31388 msgid ""
31389 " struct guestfs_statvfs *\n"
31390 " guestfs_statvfs (guestfs_h *g,\n"
31391 "                  const char *path);\n"
31392 "\n"
31393 msgstr ""
31394
31395 #. type: textblock
31396 #: ../src/guestfs-actions.pod:7222
31397 msgid ""
31398 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
31399 "error.  I<The caller must call C<guestfs_free_statvfs> after use>."
31400 msgstr ""
31401
31402 #. type: =head2
31403 #: ../src/guestfs-actions.pod:7228
31404 msgid "guestfs_strings"
31405 msgstr ""
31406
31407 #. type: verbatim
31408 #: ../src/guestfs-actions.pod:7230
31409 #, no-wrap
31410 msgid ""
31411 " char **\n"
31412 " guestfs_strings (guestfs_h *g,\n"
31413 "                  const char *path);\n"
31414 "\n"
31415 msgstr ""
31416
31417 #. type: =head2
31418 #: ../src/guestfs-actions.pod:7246
31419 msgid "guestfs_strings_e"
31420 msgstr ""
31421
31422 #. type: verbatim
31423 #: ../src/guestfs-actions.pod:7248
31424 #, no-wrap
31425 msgid ""
31426 " char **\n"
31427 " guestfs_strings_e (guestfs_h *g,\n"
31428 "                    const char *encoding,\n"
31429 "                    const char *path);\n"
31430 "\n"
31431 msgstr ""
31432
31433 #. type: textblock
31434 #: ../src/guestfs-actions.pod:7253
31435 msgid ""
31436 "This is like the C<guestfs_strings> command, but allows you to specify the "
31437 "encoding of strings that are looked for in the source file C<path>."
31438 msgstr ""
31439
31440 #. type: textblock
31441 #: ../src/guestfs-actions.pod:7263
31442 msgid ""
31443 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
31444 "ISO-8859-X (this is what C<guestfs_strings> uses)."
31445 msgstr ""
31446
31447 #. type: =head2
31448 #: ../src/guestfs-actions.pod:7301
31449 msgid "guestfs_swapoff_device"
31450 msgstr ""
31451
31452 #. type: verbatim
31453 #: ../src/guestfs-actions.pod:7303
31454 #, no-wrap
31455 msgid ""
31456 " int\n"
31457 " guestfs_swapoff_device (guestfs_h *g,\n"
31458 "                         const char *device);\n"
31459 "\n"
31460 msgstr ""
31461
31462 #. type: textblock
31463 #: ../src/guestfs-actions.pod:7307
31464 msgid ""
31465 "This command disables the libguestfs appliance swap device or partition "
31466 "named C<device>.  See C<guestfs_swapon_device>."
31467 msgstr ""
31468
31469 #. type: =head2
31470 #: ../src/guestfs-actions.pod:7315
31471 msgid "guestfs_swapoff_file"
31472 msgstr ""
31473
31474 #. type: verbatim
31475 #: ../src/guestfs-actions.pod:7317
31476 #, no-wrap
31477 msgid ""
31478 " int\n"
31479 " guestfs_swapoff_file (guestfs_h *g,\n"
31480 "                       const char *file);\n"
31481 "\n"
31482 msgstr ""
31483
31484 #. type: =head2
31485 #: ../src/guestfs-actions.pod:7327
31486 msgid "guestfs_swapoff_label"
31487 msgstr ""
31488
31489 #. type: verbatim
31490 #: ../src/guestfs-actions.pod:7329
31491 #, no-wrap
31492 msgid ""
31493 " int\n"
31494 " guestfs_swapoff_label (guestfs_h *g,\n"
31495 "                        const char *label);\n"
31496 "\n"
31497 msgstr ""
31498
31499 #. type: =head2
31500 #: ../src/guestfs-actions.pod:7340
31501 msgid "guestfs_swapoff_uuid"
31502 msgstr ""
31503
31504 #. type: verbatim
31505 #: ../src/guestfs-actions.pod:7342
31506 #, no-wrap
31507 msgid ""
31508 " int\n"
31509 " guestfs_swapoff_uuid (guestfs_h *g,\n"
31510 "                       const char *uuid);\n"
31511 "\n"
31512 msgstr ""
31513
31514 #. type: =head2
31515 #: ../src/guestfs-actions.pod:7353
31516 msgid "guestfs_swapon_device"
31517 msgstr ""
31518
31519 #. type: verbatim
31520 #: ../src/guestfs-actions.pod:7355
31521 #, no-wrap
31522 msgid ""
31523 " int\n"
31524 " guestfs_swapon_device (guestfs_h *g,\n"
31525 "                        const char *device);\n"
31526 "\n"
31527 msgstr ""
31528
31529 #. type: textblock
31530 #: ../src/guestfs-actions.pod:7359
31531 msgid ""
31532 "This command enables the libguestfs appliance to use the swap device or "
31533 "partition named C<device>.  The increased memory is made available for all "
31534 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
31535 msgstr ""
31536
31537 #. type: =head2
31538 #: ../src/guestfs-actions.pod:7375
31539 msgid "guestfs_swapon_file"
31540 msgstr ""
31541
31542 #. type: verbatim
31543 #: ../src/guestfs-actions.pod:7377
31544 #, no-wrap
31545 msgid ""
31546 " int\n"
31547 " guestfs_swapon_file (guestfs_h *g,\n"
31548 "                      const char *file);\n"
31549 "\n"
31550 msgstr ""
31551
31552 #. type: textblock
31553 #: ../src/guestfs-actions.pod:7381
31554 msgid ""
31555 "This command enables swap to a file.  See C<guestfs_swapon_device> for other "
31556 "notes."
31557 msgstr ""
31558
31559 #. type: =head2
31560 #: ../src/guestfs-actions.pod:7388
31561 msgid "guestfs_swapon_label"
31562 msgstr ""
31563
31564 #. type: verbatim
31565 #: ../src/guestfs-actions.pod:7390
31566 #, no-wrap
31567 msgid ""
31568 " int\n"
31569 " guestfs_swapon_label (guestfs_h *g,\n"
31570 "                       const char *label);\n"
31571 "\n"
31572 msgstr ""
31573
31574 #. type: textblock
31575 #: ../src/guestfs-actions.pod:7394
31576 msgid ""
31577 "This command enables swap to a labeled swap partition.  See "
31578 "C<guestfs_swapon_device> for other notes."
31579 msgstr ""
31580
31581 #. type: =head2
31582 #: ../src/guestfs-actions.pod:7401
31583 msgid "guestfs_swapon_uuid"
31584 msgstr ""
31585
31586 #. type: verbatim
31587 #: ../src/guestfs-actions.pod:7403
31588 #, no-wrap
31589 msgid ""
31590 " int\n"
31591 " guestfs_swapon_uuid (guestfs_h *g,\n"
31592 "                      const char *uuid);\n"
31593 "\n"
31594 msgstr ""
31595
31596 #. type: textblock
31597 #: ../src/guestfs-actions.pod:7407
31598 msgid ""
31599 "This command enables swap to a swap partition with the given UUID.  See "
31600 "C<guestfs_swapon_device> for other notes."
31601 msgstr ""
31602
31603 #. type: =head2
31604 #: ../src/guestfs-actions.pod:7414
31605 msgid "guestfs_sync"
31606 msgstr ""
31607
31608 #. type: verbatim
31609 #: ../src/guestfs-actions.pod:7416
31610 #, no-wrap
31611 msgid ""
31612 " int\n"
31613 " guestfs_sync (guestfs_h *g);\n"
31614 "\n"
31615 msgstr ""
31616
31617 #. type: =head2
31618 #: ../src/guestfs-actions.pod:7429
31619 msgid "guestfs_tail"
31620 msgstr ""
31621
31622 #. type: verbatim
31623 #: ../src/guestfs-actions.pod:7431
31624 #, no-wrap
31625 msgid ""
31626 " char **\n"
31627 " guestfs_tail (guestfs_h *g,\n"
31628 "               const char *path);\n"
31629 "\n"
31630 msgstr ""
31631
31632 #. type: =head2
31633 #: ../src/guestfs-actions.pod:7447
31634 msgid "guestfs_tail_n"
31635 msgstr ""
31636
31637 #. type: verbatim
31638 #: ../src/guestfs-actions.pod:7449
31639 #, no-wrap
31640 msgid ""
31641 " char **\n"
31642 " guestfs_tail_n (guestfs_h *g,\n"
31643 "                 int nrlines,\n"
31644 "                 const char *path);\n"
31645 "\n"
31646 msgstr ""
31647
31648 #. type: =head2
31649 #: ../src/guestfs-actions.pod:7471
31650 msgid "guestfs_tar_in"
31651 msgstr ""
31652
31653 #. type: verbatim
31654 #: ../src/guestfs-actions.pod:7473
31655 #, no-wrap
31656 msgid ""
31657 " int\n"
31658 " guestfs_tar_in (guestfs_h *g,\n"
31659 "                 const char *tarfile,\n"
31660 "                 const char *directory);\n"
31661 "\n"
31662 msgstr ""
31663
31664 #. type: textblock
31665 #: ../src/guestfs-actions.pod:7481
31666 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
31667 msgstr ""
31668
31669 #. type: textblock
31670 #: ../src/guestfs-actions.pod:7486 ../src/guestfs-actions.pod:7503 ../src/guestfs-actions.pod:7519 ../src/guestfs-actions.pod:7535
31671 msgid "(Added in 1.0.3)"
31672 msgstr ""
31673
31674 #. type: =head2
31675 #: ../src/guestfs-actions.pod:7488
31676 msgid "guestfs_tar_out"
31677 msgstr ""
31678
31679 #. type: verbatim
31680 #: ../src/guestfs-actions.pod:7490
31681 #, no-wrap
31682 msgid ""
31683 " int\n"
31684 " guestfs_tar_out (guestfs_h *g,\n"
31685 "                  const char *directory,\n"
31686 "                  const char *tarfile);\n"
31687 "\n"
31688 msgstr ""
31689
31690 #. type: textblock
31691 #: ../src/guestfs-actions.pod:7498
31692 msgid ""
31693 "To download a compressed tarball, use C<guestfs_tgz_out> or "
31694 "C<guestfs_txz_out>."
31695 msgstr ""
31696
31697 #. type: =head2
31698 #: ../src/guestfs-actions.pod:7505
31699 msgid "guestfs_tgz_in"
31700 msgstr ""
31701
31702 #. type: verbatim
31703 #: ../src/guestfs-actions.pod:7507
31704 #, no-wrap
31705 msgid ""
31706 " int\n"
31707 " guestfs_tgz_in (guestfs_h *g,\n"
31708 "                 const char *tarball,\n"
31709 "                 const char *directory);\n"
31710 "\n"
31711 msgstr ""
31712
31713 #. type: textblock
31714 #: ../src/guestfs-actions.pod:7515
31715 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
31716 msgstr ""
31717
31718 #. type: =head2
31719 #: ../src/guestfs-actions.pod:7521
31720 msgid "guestfs_tgz_out"
31721 msgstr ""
31722
31723 #. type: verbatim
31724 #: ../src/guestfs-actions.pod:7523
31725 #, no-wrap
31726 msgid ""
31727 " int\n"
31728 " guestfs_tgz_out (guestfs_h *g,\n"
31729 "                  const char *directory,\n"
31730 "                  const char *tarball);\n"
31731 "\n"
31732 msgstr ""
31733
31734 #. type: textblock
31735 #: ../src/guestfs-actions.pod:7531
31736 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
31737 msgstr ""
31738
31739 #. type: =head2
31740 #: ../src/guestfs-actions.pod:7537
31741 msgid "guestfs_touch"
31742 msgstr ""
31743
31744 #. type: verbatim
31745 #: ../src/guestfs-actions.pod:7539
31746 #, no-wrap
31747 msgid ""
31748 " int\n"
31749 " guestfs_touch (guestfs_h *g,\n"
31750 "                const char *path);\n"
31751 "\n"
31752 msgstr ""
31753
31754 #. type: =head2
31755 #: ../src/guestfs-actions.pod:7554
31756 msgid "guestfs_truncate"
31757 msgstr ""
31758
31759 #. type: verbatim
31760 #: ../src/guestfs-actions.pod:7556
31761 #, no-wrap
31762 msgid ""
31763 " int\n"
31764 " guestfs_truncate (guestfs_h *g,\n"
31765 "                   const char *path);\n"
31766 "\n"
31767 msgstr ""
31768
31769 #. type: =head2
31770 #: ../src/guestfs-actions.pod:7567
31771 msgid "guestfs_truncate_size"
31772 msgstr ""
31773
31774 #. type: verbatim
31775 #: ../src/guestfs-actions.pod:7569
31776 #, no-wrap
31777 msgid ""
31778 " int\n"
31779 " guestfs_truncate_size (guestfs_h *g,\n"
31780 "                        const char *path,\n"
31781 "                        int64_t size);\n"
31782 "\n"
31783 msgstr ""
31784
31785 #. type: textblock
31786 #: ../src/guestfs-actions.pod:7577
31787 msgid ""
31788 "If the current file size is less than C<size> then the file is extended to "
31789 "the required size with zero bytes.  This creates a sparse file (ie. disk "
31790 "blocks are not allocated for the file until you write to it).  To create a "
31791 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
31792 msgstr ""
31793
31794 #. type: =head2
31795 #: ../src/guestfs-actions.pod:7587
31796 msgid "guestfs_tune2fs_l"
31797 msgstr ""
31798
31799 #. type: verbatim
31800 #: ../src/guestfs-actions.pod:7589
31801 #, no-wrap
31802 msgid ""
31803 " char **\n"
31804 " guestfs_tune2fs_l (guestfs_h *g,\n"
31805 "                    const char *device);\n"
31806 "\n"
31807 msgstr ""
31808
31809 #. type: =head2
31810 #: ../src/guestfs-actions.pod:7609
31811 msgid "guestfs_txz_in"
31812 msgstr ""
31813
31814 #. type: verbatim
31815 #: ../src/guestfs-actions.pod:7611
31816 #, no-wrap
31817 msgid ""
31818 " int\n"
31819 " guestfs_txz_in (guestfs_h *g,\n"
31820 "                 const char *tarball,\n"
31821 "                 const char *directory);\n"
31822 "\n"
31823 msgstr ""
31824
31825 #. type: =head2
31826 #: ../src/guestfs-actions.pod:7623
31827 msgid "guestfs_txz_out"
31828 msgstr ""
31829
31830 #. type: verbatim
31831 #: ../src/guestfs-actions.pod:7625
31832 #, no-wrap
31833 msgid ""
31834 " int\n"
31835 " guestfs_txz_out (guestfs_h *g,\n"
31836 "                  const char *directory,\n"
31837 "                  const char *tarball);\n"
31838 "\n"
31839 msgstr ""
31840
31841 #. type: =head2
31842 #: ../src/guestfs-actions.pod:7637
31843 msgid "guestfs_umask"
31844 msgstr ""
31845
31846 #. type: verbatim
31847 #: ../src/guestfs-actions.pod:7639
31848 #, no-wrap
31849 msgid ""
31850 " int\n"
31851 " guestfs_umask (guestfs_h *g,\n"
31852 "                int mask);\n"
31853 "\n"
31854 msgstr ""
31855
31856 #. type: textblock
31857 #: ../src/guestfs-actions.pod:7655
31858 msgid ""
31859 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
31860 "C<guestfs_mkdir>."
31861 msgstr ""
31862
31863 #. type: =head2
31864 #: ../src/guestfs-actions.pod:7664
31865 msgid "guestfs_umount"
31866 msgstr ""
31867
31868 #. type: verbatim
31869 #: ../src/guestfs-actions.pod:7666
31870 #, no-wrap
31871 msgid ""
31872 " int\n"
31873 " guestfs_umount (guestfs_h *g,\n"
31874 "                 const char *pathordevice);\n"
31875 "\n"
31876 msgstr ""
31877
31878 #. type: =head2
31879 #: ../src/guestfs-actions.pod:7678
31880 msgid "guestfs_umount_all"
31881 msgstr ""
31882
31883 #. type: verbatim
31884 #: ../src/guestfs-actions.pod:7680
31885 #, no-wrap
31886 msgid ""
31887 " int\n"
31888 " guestfs_umount_all (guestfs_h *g);\n"
31889 "\n"
31890 msgstr ""
31891
31892 #. type: =head2
31893 #: ../src/guestfs-actions.pod:7691
31894 msgid "guestfs_upload"
31895 msgstr ""
31896
31897 #. type: verbatim
31898 #: ../src/guestfs-actions.pod:7693
31899 #, no-wrap
31900 msgid ""
31901 " int\n"
31902 " guestfs_upload (guestfs_h *g,\n"
31903 "                 const char *filename,\n"
31904 "                 const char *remotefilename);\n"
31905 "\n"
31906 msgstr ""
31907
31908 #. type: textblock
31909 #: ../src/guestfs-actions.pod:7703
31910 msgid "See also C<guestfs_download>."
31911 msgstr ""
31912
31913 #. type: =head2
31914 #: ../src/guestfs-actions.pod:7714
31915 msgid "guestfs_upload_offset"
31916 msgstr ""
31917
31918 #. type: verbatim
31919 #: ../src/guestfs-actions.pod:7716
31920 #, no-wrap
31921 msgid ""
31922 " int\n"
31923 " guestfs_upload_offset (guestfs_h *g,\n"
31924 "                        const char *filename,\n"
31925 "                        const char *remotefilename,\n"
31926 "                        int64_t offset);\n"
31927 "\n"
31928 msgstr ""
31929
31930 #. type: textblock
31931 #: ../src/guestfs-actions.pod:7732
31932 msgid ""
31933 "Note that there is no limit on the amount of data that can be uploaded with "
31934 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
31935 "full amount unless an error occurs."
31936 msgstr ""
31937
31938 #. type: textblock
31939 #: ../src/guestfs-actions.pod:7737
31940 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
31941 msgstr ""
31942
31943 #. type: =head2
31944 #: ../src/guestfs-actions.pod:7748
31945 msgid "guestfs_utimens"
31946 msgstr ""
31947
31948 #. type: verbatim
31949 #: ../src/guestfs-actions.pod:7750
31950 #, no-wrap
31951 msgid ""
31952 " int\n"
31953 " guestfs_utimens (guestfs_h *g,\n"
31954 "                  const char *path,\n"
31955 "                  int64_t atsecs,\n"
31956 "                  int64_t atnsecs,\n"
31957 "                  int64_t mtsecs,\n"
31958 "                  int64_t mtnsecs);\n"
31959 "\n"
31960 msgstr ""
31961
31962 #. type: =head2
31963 #: ../src/guestfs-actions.pod:7779 ../src/guestfs-structs.pod:175
31964 msgid "guestfs_version"
31965 msgstr ""
31966
31967 #. type: verbatim
31968 #: ../src/guestfs-actions.pod:7781
31969 #, no-wrap
31970 msgid ""
31971 " struct guestfs_version *\n"
31972 " guestfs_version (guestfs_h *g);\n"
31973 "\n"
31974 msgstr ""
31975
31976 #. type: textblock
31977 #: ../src/guestfs-actions.pod:7809
31978 msgid ""
31979 "I<Note:> Don't use this call to test for availability of features.  In "
31980 "enterprise distributions we backport features from later versions into "
31981 "earlier versions, making this an unreliable way to test for features.  Use "
31982 "C<guestfs_available> instead."
31983 msgstr ""
31984
31985 #. type: textblock
31986 #: ../src/guestfs-actions.pod:7815
31987 msgid ""
31988 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
31989 "error.  I<The caller must call C<guestfs_free_version> after use>."
31990 msgstr ""
31991
31992 #. type: textblock
31993 #: ../src/guestfs-actions.pod:7819
31994 msgid "(Added in 1.0.58)"
31995 msgstr ""
31996
31997 #. type: =head2
31998 #: ../src/guestfs-actions.pod:7821
31999 msgid "guestfs_vfs_label"
32000 msgstr ""
32001
32002 #. type: verbatim
32003 #: ../src/guestfs-actions.pod:7823
32004 #, no-wrap
32005 msgid ""
32006 " char *\n"
32007 " guestfs_vfs_label (guestfs_h *g,\n"
32008 "                    const char *device);\n"
32009 "\n"
32010 msgstr ""
32011
32012 #. type: textblock
32013 #: ../src/guestfs-actions.pod:7832
32014 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
32015 msgstr ""
32016
32017 #. type: textblock
32018 #: ../src/guestfs-actions.pod:7837 ../src/guestfs-actions.pod:7874
32019 msgid "(Added in 1.3.18)"
32020 msgstr ""
32021
32022 #. type: =head2
32023 #: ../src/guestfs-actions.pod:7839
32024 msgid "guestfs_vfs_type"
32025 msgstr ""
32026
32027 #. type: verbatim
32028 #: ../src/guestfs-actions.pod:7841
32029 #, no-wrap
32030 msgid ""
32031 " char *\n"
32032 " guestfs_vfs_type (guestfs_h *g,\n"
32033 "                   const char *device);\n"
32034 "\n"
32035 msgstr ""
32036
32037 #. type: =head2
32038 #: ../src/guestfs-actions.pod:7858
32039 msgid "guestfs_vfs_uuid"
32040 msgstr ""
32041
32042 #. type: verbatim
32043 #: ../src/guestfs-actions.pod:7860
32044 #, no-wrap
32045 msgid ""
32046 " char *\n"
32047 " guestfs_vfs_uuid (guestfs_h *g,\n"
32048 "                   const char *device);\n"
32049 "\n"
32050 msgstr ""
32051
32052 #. type: textblock
32053 #: ../src/guestfs-actions.pod:7869
32054 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
32055 msgstr ""
32056
32057 #. type: =head2
32058 #: ../src/guestfs-actions.pod:7876
32059 msgid "guestfs_vg_activate"
32060 msgstr ""
32061
32062 #. type: verbatim
32063 #: ../src/guestfs-actions.pod:7878
32064 #, no-wrap
32065 msgid ""
32066 " int\n"
32067 " guestfs_vg_activate (guestfs_h *g,\n"
32068 "                      int activate,\n"
32069 "                      char *const *volgroups);\n"
32070 "\n"
32071 msgstr ""
32072
32073 #. type: =head2
32074 #: ../src/guestfs-actions.pod:7895
32075 msgid "guestfs_vg_activate_all"
32076 msgstr ""
32077
32078 #. type: verbatim
32079 #: ../src/guestfs-actions.pod:7897
32080 #, no-wrap
32081 msgid ""
32082 " int\n"
32083 " guestfs_vg_activate_all (guestfs_h *g,\n"
32084 "                          int activate);\n"
32085 "\n"
32086 msgstr ""
32087
32088 #. type: =head2
32089 #: ../src/guestfs-actions.pod:7910
32090 msgid "guestfs_vgcreate"
32091 msgstr ""
32092
32093 #. type: verbatim
32094 #: ../src/guestfs-actions.pod:7912
32095 #, no-wrap
32096 msgid ""
32097 " int\n"
32098 " guestfs_vgcreate (guestfs_h *g,\n"
32099 "                   const char *volgroup,\n"
32100 "                   char *const *physvols);\n"
32101 "\n"
32102 msgstr ""
32103
32104 #. type: =head2
32105 #: ../src/guestfs-actions.pod:7924
32106 msgid "guestfs_vglvuuids"
32107 msgstr ""
32108
32109 #. type: verbatim
32110 #: ../src/guestfs-actions.pod:7926
32111 #, no-wrap
32112 msgid ""
32113 " char **\n"
32114 " guestfs_vglvuuids (guestfs_h *g,\n"
32115 "                    const char *vgname);\n"
32116 "\n"
32117 msgstr ""
32118
32119 #. type: textblock
32120 #: ../src/guestfs-actions.pod:7933
32121 msgid ""
32122 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
32123 "associate logical volumes and volume groups."
32124 msgstr ""
32125
32126 #. type: textblock
32127 #: ../src/guestfs-actions.pod:7936
32128 msgid "See also C<guestfs_vgpvuuids>."
32129 msgstr ""
32130
32131 #. type: =head2
32132 #: ../src/guestfs-actions.pod:7944
32133 msgid "guestfs_vgpvuuids"
32134 msgstr ""
32135
32136 #. type: verbatim
32137 #: ../src/guestfs-actions.pod:7946
32138 #, no-wrap
32139 msgid ""
32140 " char **\n"
32141 " guestfs_vgpvuuids (guestfs_h *g,\n"
32142 "                    const char *vgname);\n"
32143 "\n"
32144 msgstr ""
32145
32146 #. type: textblock
32147 #: ../src/guestfs-actions.pod:7953
32148 msgid ""
32149 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
32150 "associate physical volumes and volume groups."
32151 msgstr ""
32152
32153 #. type: textblock
32154 #: ../src/guestfs-actions.pod:7956
32155 msgid "See also C<guestfs_vglvuuids>."
32156 msgstr ""
32157
32158 #. type: =head2
32159 #: ../src/guestfs-actions.pod:7964
32160 msgid "guestfs_vgremove"
32161 msgstr ""
32162
32163 #. type: verbatim
32164 #: ../src/guestfs-actions.pod:7966
32165 #, no-wrap
32166 msgid ""
32167 " int\n"
32168 " guestfs_vgremove (guestfs_h *g,\n"
32169 "                   const char *vgname);\n"
32170 "\n"
32171 msgstr ""
32172
32173 #. type: =head2
32174 #: ../src/guestfs-actions.pod:7979
32175 msgid "guestfs_vgrename"
32176 msgstr ""
32177
32178 #. type: verbatim
32179 #: ../src/guestfs-actions.pod:7981
32180 #, no-wrap
32181 msgid ""
32182 " int\n"
32183 " guestfs_vgrename (guestfs_h *g,\n"
32184 "                   const char *volgroup,\n"
32185 "                   const char *newvolgroup);\n"
32186 "\n"
32187 msgstr ""
32188
32189 #. type: =head2
32190 #: ../src/guestfs-actions.pod:7992
32191 msgid "guestfs_vgs"
32192 msgstr ""
32193
32194 #. type: verbatim
32195 #: ../src/guestfs-actions.pod:7994
32196 #, no-wrap
32197 msgid ""
32198 " char **\n"
32199 " guestfs_vgs (guestfs_h *g);\n"
32200 "\n"
32201 msgstr ""
32202
32203 #. type: textblock
32204 #: ../src/guestfs-actions.pod:8003
32205 msgid "See also C<guestfs_vgs_full>."
32206 msgstr ""
32207
32208 #. type: =head2
32209 #: ../src/guestfs-actions.pod:8011
32210 msgid "guestfs_vgs_full"
32211 msgstr ""
32212
32213 #. type: verbatim
32214 #: ../src/guestfs-actions.pod:8013
32215 #, no-wrap
32216 msgid ""
32217 " struct guestfs_lvm_vg_list *\n"
32218 " guestfs_vgs_full (guestfs_h *g);\n"
32219 "\n"
32220 msgstr ""
32221
32222 #. type: textblock
32223 #: ../src/guestfs-actions.pod:8019
32224 msgid ""
32225 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
32226 "was an error.  I<The caller must call C<guestfs_free_lvm_vg_list> after "
32227 "use>."
32228 msgstr ""
32229
32230 #. type: =head2
32231 #: ../src/guestfs-actions.pod:8025
32232 msgid "guestfs_vgscan"
32233 msgstr ""
32234
32235 #. type: verbatim
32236 #: ../src/guestfs-actions.pod:8027
32237 #, no-wrap
32238 msgid ""
32239 " int\n"
32240 " guestfs_vgscan (guestfs_h *g);\n"
32241 "\n"
32242 msgstr ""
32243
32244 #. type: =head2
32245 #: ../src/guestfs-actions.pod:8037
32246 msgid "guestfs_vguuid"
32247 msgstr ""
32248
32249 #. type: verbatim
32250 #: ../src/guestfs-actions.pod:8039
32251 #, no-wrap
32252 msgid ""
32253 " char *\n"
32254 " guestfs_vguuid (guestfs_h *g,\n"
32255 "                 const char *vgname);\n"
32256 "\n"
32257 msgstr ""
32258
32259 #. type: =head2
32260 #: ../src/guestfs-actions.pod:8050
32261 msgid "guestfs_wait_ready"
32262 msgstr ""
32263
32264 #. type: verbatim
32265 #: ../src/guestfs-actions.pod:8052
32266 #, no-wrap
32267 msgid ""
32268 " int\n"
32269 " guestfs_wait_ready (guestfs_h *g);\n"
32270 "\n"
32271 msgstr ""
32272
32273 #. type: textblock
32274 #: ../src/guestfs-actions.pod:8055
32275 msgid ""
32276 "I<This function is deprecated.> In new code, use the L</guestfs_launch> call "
32277 "instead."
32278 msgstr ""
32279
32280 #. type: textblock
32281 #: ../src/guestfs-actions.pod:8062
32282 msgid "This function is a no op."
32283 msgstr ""
32284
32285 #. type: textblock
32286 #: ../src/guestfs-actions.pod:8064
32287 msgid ""
32288 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
32289 "calling C<guestfs_launch> to wait for the launch to complete.  However this "
32290 "is no longer necessary because C<guestfs_launch> now does the waiting."
32291 msgstr ""
32292
32293 #. type: textblock
32294 #: ../src/guestfs-actions.pod:8069
32295 msgid ""
32296 "If you see any calls to this function in code then you can just remove them, "
32297 "unless you want to retain compatibility with older versions of the API."
32298 msgstr ""
32299
32300 #. type: =head2
32301 #: ../src/guestfs-actions.pod:8077
32302 msgid "guestfs_wc_c"
32303 msgstr ""
32304
32305 #. type: verbatim
32306 #: ../src/guestfs-actions.pod:8079
32307 #, no-wrap
32308 msgid ""
32309 " int\n"
32310 " guestfs_wc_c (guestfs_h *g,\n"
32311 "               const char *path);\n"
32312 "\n"
32313 msgstr ""
32314
32315 #. type: =head2
32316 #: ../src/guestfs-actions.pod:8090
32317 msgid "guestfs_wc_l"
32318 msgstr ""
32319
32320 #. type: verbatim
32321 #: ../src/guestfs-actions.pod:8092
32322 #, no-wrap
32323 msgid ""
32324 " int\n"
32325 " guestfs_wc_l (guestfs_h *g,\n"
32326 "               const char *path);\n"
32327 "\n"
32328 msgstr ""
32329
32330 #. type: =head2
32331 #: ../src/guestfs-actions.pod:8103
32332 msgid "guestfs_wc_w"
32333 msgstr ""
32334
32335 #. type: verbatim
32336 #: ../src/guestfs-actions.pod:8105
32337 #, no-wrap
32338 msgid ""
32339 " int\n"
32340 " guestfs_wc_w (guestfs_h *g,\n"
32341 "               const char *path);\n"
32342 "\n"
32343 msgstr ""
32344
32345 #. type: =head2
32346 #: ../src/guestfs-actions.pod:8116
32347 msgid "guestfs_write"
32348 msgstr ""
32349
32350 #. type: verbatim
32351 #: ../src/guestfs-actions.pod:8118
32352 #, no-wrap
32353 msgid ""
32354 " int\n"
32355 " guestfs_write (guestfs_h *g,\n"
32356 "                const char *path,\n"
32357 "                const char *content,\n"
32358 "                size_t content_size);\n"
32359 "\n"
32360 msgstr ""
32361
32362 #. type: textblock
32363 #: ../src/guestfs-actions.pod:8127
32364 msgid "See also C<guestfs_write_append>."
32365 msgstr ""
32366
32367 #. type: =head2
32368 #: ../src/guestfs-actions.pod:8136
32369 msgid "guestfs_write_append"
32370 msgstr ""
32371
32372 #. type: verbatim
32373 #: ../src/guestfs-actions.pod:8138
32374 #, no-wrap
32375 msgid ""
32376 " int\n"
32377 " guestfs_write_append (guestfs_h *g,\n"
32378 "                       const char *path,\n"
32379 "                       const char *content,\n"
32380 "                       size_t content_size);\n"
32381 "\n"
32382 msgstr ""
32383
32384 #. type: textblock
32385 #: ../src/guestfs-actions.pod:8147
32386 msgid "See also C<guestfs_write>."
32387 msgstr ""
32388
32389 #. type: =head2
32390 #: ../src/guestfs-actions.pod:8156
32391 msgid "guestfs_write_file"
32392 msgstr ""
32393
32394 #. type: verbatim
32395 #: ../src/guestfs-actions.pod:8158
32396 #, no-wrap
32397 msgid ""
32398 " int\n"
32399 " guestfs_write_file (guestfs_h *g,\n"
32400 "                     const char *path,\n"
32401 "                     const char *content,\n"
32402 "                     int size);\n"
32403 "\n"
32404 msgstr ""
32405
32406 #. type: textblock
32407 #: ../src/guestfs-actions.pod:8164
32408 msgid ""
32409 "I<This function is deprecated.> In new code, use the L</guestfs_write> call "
32410 "instead."
32411 msgstr ""
32412
32413 #. type: =head2
32414 #: ../src/guestfs-actions.pod:8189
32415 msgid "guestfs_zegrep"
32416 msgstr ""
32417
32418 #. type: verbatim
32419 #: ../src/guestfs-actions.pod:8191
32420 #, no-wrap
32421 msgid ""
32422 " char **\n"
32423 " guestfs_zegrep (guestfs_h *g,\n"
32424 "                 const char *regex,\n"
32425 "                 const char *path);\n"
32426 "\n"
32427 msgstr ""
32428
32429 #. type: =head2
32430 #: ../src/guestfs-actions.pod:8208
32431 msgid "guestfs_zegrepi"
32432 msgstr ""
32433
32434 #. type: verbatim
32435 #: ../src/guestfs-actions.pod:8210
32436 #, no-wrap
32437 msgid ""
32438 " char **\n"
32439 " guestfs_zegrepi (guestfs_h *g,\n"
32440 "                  const char *regex,\n"
32441 "                  const char *path);\n"
32442 "\n"
32443 msgstr ""
32444
32445 #. type: =head2
32446 #: ../src/guestfs-actions.pod:8227
32447 msgid "guestfs_zero"
32448 msgstr ""
32449
32450 #. type: verbatim
32451 #: ../src/guestfs-actions.pod:8229
32452 #, no-wrap
32453 msgid ""
32454 " int\n"
32455 " guestfs_zero (guestfs_h *g,\n"
32456 "               const char *device);\n"
32457 "\n"
32458 msgstr ""
32459
32460 #. type: textblock
32461 #: ../src/guestfs-actions.pod:8243
32462 msgid ""
32463 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
32464 "C<guestfs_is_zero_device>"
32465 msgstr ""
32466
32467 #. type: =head2
32468 #: ../src/guestfs-actions.pod:8255
32469 msgid "guestfs_zero_device"
32470 msgstr ""
32471
32472 #. type: verbatim
32473 #: ../src/guestfs-actions.pod:8257
32474 #, no-wrap
32475 msgid ""
32476 " int\n"
32477 " guestfs_zero_device (guestfs_h *g,\n"
32478 "                      const char *device);\n"
32479 "\n"
32480 msgstr ""
32481
32482 #. type: textblock
32483 #: ../src/guestfs-actions.pod:8261
32484 msgid ""
32485 "This command writes zeroes over the entire C<device>.  Compare with "
32486 "C<guestfs_zero> which just zeroes the first few blocks of a device."
32487 msgstr ""
32488
32489 #. type: textblock
32490 #: ../src/guestfs-actions.pod:8276
32491 msgid "(Added in 1.3.1)"
32492 msgstr ""
32493
32494 #. type: =head2
32495 #: ../src/guestfs-actions.pod:8278
32496 msgid "guestfs_zerofree"
32497 msgstr ""
32498
32499 #. type: verbatim
32500 #: ../src/guestfs-actions.pod:8280
32501 #, no-wrap
32502 msgid ""
32503 " int\n"
32504 " guestfs_zerofree (guestfs_h *g,\n"
32505 "                   const char *device);\n"
32506 "\n"
32507 msgstr ""
32508
32509 #. type: =head2
32510 #: ../src/guestfs-actions.pod:8299
32511 msgid "guestfs_zfgrep"
32512 msgstr ""
32513
32514 #. type: verbatim
32515 #: ../src/guestfs-actions.pod:8301
32516 #, no-wrap
32517 msgid ""
32518 " char **\n"
32519 " guestfs_zfgrep (guestfs_h *g,\n"
32520 "                 const char *pattern,\n"
32521 "                 const char *path);\n"
32522 "\n"
32523 msgstr ""
32524
32525 #. type: =head2
32526 #: ../src/guestfs-actions.pod:8318
32527 msgid "guestfs_zfgrepi"
32528 msgstr ""
32529
32530 #. type: verbatim
32531 #: ../src/guestfs-actions.pod:8320
32532 #, no-wrap
32533 msgid ""
32534 " char **\n"
32535 " guestfs_zfgrepi (guestfs_h *g,\n"
32536 "                  const char *pattern,\n"
32537 "                  const char *path);\n"
32538 "\n"
32539 msgstr ""
32540
32541 #. type: =head2
32542 #: ../src/guestfs-actions.pod:8337
32543 msgid "guestfs_zfile"
32544 msgstr ""
32545
32546 #. type: verbatim
32547 #: ../src/guestfs-actions.pod:8339
32548 #, no-wrap
32549 msgid ""
32550 " char *\n"
32551 " guestfs_zfile (guestfs_h *g,\n"
32552 "                const char *meth,\n"
32553 "                const char *path);\n"
32554 "\n"
32555 msgstr ""
32556
32557 #. type: textblock
32558 #: ../src/guestfs-actions.pod:8344
32559 msgid ""
32560 "I<This function is deprecated.> In new code, use the L</guestfs_file> call "
32561 "instead."
32562 msgstr ""
32563
32564 #. type: textblock
32565 #: ../src/guestfs-actions.pod:8356
32566 msgid ""
32567 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
32568 "files."
32569 msgstr ""
32570
32571 #. type: =head2
32572 #: ../src/guestfs-actions.pod:8364
32573 msgid "guestfs_zgrep"
32574 msgstr ""
32575
32576 #. type: verbatim
32577 #: ../src/guestfs-actions.pod:8366
32578 #, no-wrap
32579 msgid ""
32580 " char **\n"
32581 " guestfs_zgrep (guestfs_h *g,\n"
32582 "                const char *regex,\n"
32583 "                const char *path);\n"
32584 "\n"
32585 msgstr ""
32586
32587 #. type: =head2
32588 #: ../src/guestfs-actions.pod:8383
32589 msgid "guestfs_zgrepi"
32590 msgstr ""
32591
32592 #. type: verbatim
32593 #: ../src/guestfs-actions.pod:8385
32594 #, no-wrap
32595 msgid ""
32596 " char **\n"
32597 " guestfs_zgrepi (guestfs_h *g,\n"
32598 "                 const char *regex,\n"
32599 "                 const char *path);\n"
32600 "\n"
32601 msgstr ""
32602
32603 #. type: =item
32604 #: ../src/guestfs-availability.pod:3
32605 msgid "B<augeas>"
32606 msgstr ""
32607
32608 #. type: textblock
32609 #: ../src/guestfs-availability.pod:5
32610 msgid ""
32611 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
32612 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
32613 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
32614 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
32615 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
32616 msgstr ""
32617
32618 #. type: =item
32619 #: ../src/guestfs-availability.pod:21
32620 msgid "B<btrfs>"
32621 msgstr ""
32622
32623 #. type: textblock
32624 #: ../src/guestfs-availability.pod:23
32625 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
32626 msgstr ""
32627
32628 #. type: =item
32629 #: ../src/guestfs-availability.pod:26
32630 msgid "B<grub>"
32631 msgstr ""
32632
32633 #. type: textblock
32634 #: ../src/guestfs-availability.pod:28
32635 msgid "The following functions: L</guestfs_grub_install>"
32636 msgstr ""
32637
32638 #. type: =item
32639 #: ../src/guestfs-availability.pod:31
32640 msgid "B<inotify>"
32641 msgstr ""
32642
32643 #. type: textblock
32644 #: ../src/guestfs-availability.pod:33
32645 msgid ""
32646 "The following functions: L</guestfs_inotify_add_watch> "
32647 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
32648 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
32649 msgstr ""
32650
32651 #. type: =item
32652 #: ../src/guestfs-availability.pod:41
32653 msgid "B<linuxfsuuid>"
32654 msgstr ""
32655
32656 #. type: textblock
32657 #: ../src/guestfs-availability.pod:43
32658 msgid ""
32659 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
32660 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
32661 msgstr ""
32662
32663 #. type: =item
32664 #: ../src/guestfs-availability.pod:50
32665 msgid "B<linuxmodules>"
32666 msgstr ""
32667
32668 #. type: textblock
32669 #: ../src/guestfs-availability.pod:52
32670 msgid "The following functions: L</guestfs_modprobe>"
32671 msgstr ""
32672
32673 #. type: =item
32674 #: ../src/guestfs-availability.pod:55
32675 msgid "B<linuxxattrs>"
32676 msgstr ""
32677
32678 #. type: textblock
32679 #: ../src/guestfs-availability.pod:57
32680 msgid ""
32681 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
32682 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
32683 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
32684 "L</guestfs_setxattr>"
32685 msgstr ""
32686
32687 #. type: =item
32688 #: ../src/guestfs-availability.pod:68
32689 msgid "B<luks>"
32690 msgstr ""
32691
32692 #. type: textblock
32693 #: ../src/guestfs-availability.pod:70
32694 msgid ""
32695 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
32696 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
32697 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
32698 msgstr ""
32699
32700 #. type: =item
32701 #: ../src/guestfs-availability.pod:79
32702 msgid "B<lvm2>"
32703 msgstr ""
32704
32705 #. type: textblock
32706 #: ../src/guestfs-availability.pod:81
32707 msgid ""
32708 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
32709 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
32710 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
32711 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
32712 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
32713 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
32714 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
32715 "L</guestfs_vgs_full>"
32716 msgstr ""
32717
32718 #. type: =item
32719 #: ../src/guestfs-availability.pod:104
32720 msgid "B<mknod>"
32721 msgstr ""
32722
32723 #. type: textblock
32724 #: ../src/guestfs-availability.pod:106
32725 msgid ""
32726 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
32727 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
32728 msgstr ""
32729
32730 #. type: =item
32731 #: ../src/guestfs-availability.pod:112
32732 msgid "B<ntfs3g>"
32733 msgstr ""
32734
32735 #. type: textblock
32736 #: ../src/guestfs-availability.pod:114
32737 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
32738 msgstr ""
32739
32740 #. type: =item
32741 #: ../src/guestfs-availability.pod:117
32742 msgid "B<ntfsprogs>"
32743 msgstr ""
32744
32745 #. type: textblock
32746 #: ../src/guestfs-availability.pod:119
32747 msgid ""
32748 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
32749 "L</guestfs_ntfsresize_size>"
32750 msgstr ""
32751
32752 #. type: =item
32753 #: ../src/guestfs-availability.pod:124
32754 msgid "B<realpath>"
32755 msgstr ""
32756
32757 #. type: textblock
32758 #: ../src/guestfs-availability.pod:126
32759 msgid "The following functions: L</guestfs_realpath>"
32760 msgstr ""
32761
32762 #. type: =item
32763 #: ../src/guestfs-availability.pod:129
32764 msgid "B<scrub>"
32765 msgstr ""
32766
32767 #. type: textblock
32768 #: ../src/guestfs-availability.pod:131
32769 msgid ""
32770 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
32771 "L</guestfs_scrub_freespace>"
32772 msgstr ""
32773
32774 #. type: =item
32775 #: ../src/guestfs-availability.pod:136
32776 msgid "B<selinux>"
32777 msgstr ""
32778
32779 #. type: textblock
32780 #: ../src/guestfs-availability.pod:138
32781 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
32782 msgstr ""
32783
32784 #. type: =item
32785 #: ../src/guestfs-availability.pod:142
32786 msgid "B<xz>"
32787 msgstr ""
32788
32789 #. type: textblock
32790 #: ../src/guestfs-availability.pod:144
32791 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
32792 msgstr ""
32793
32794 #. type: =item
32795 #: ../src/guestfs-availability.pod:148
32796 msgid "B<zerofree>"
32797 msgstr ""
32798
32799 #. type: textblock
32800 #: ../src/guestfs-availability.pod:150
32801 msgid "The following functions: L</guestfs_zerofree>"
32802 msgstr ""
32803
32804 #. type: =head2
32805 #: ../src/guestfs-structs.pod:1
32806 msgid "guestfs_int_bool"
32807 msgstr ""
32808
32809 #. type: verbatim
32810 #: ../src/guestfs-structs.pod:3
32811 #, no-wrap
32812 msgid ""
32813 " struct guestfs_int_bool {\n"
32814 "   int32_t i;\n"
32815 "   int32_t b;\n"
32816 " };\n"
32817 " \n"
32818 msgstr ""
32819
32820 #. type: verbatim
32821 #: ../src/guestfs-structs.pod:8
32822 #, no-wrap
32823 msgid ""
32824 " struct guestfs_int_bool_list {\n"
32825 "   uint32_t len; /* Number of elements in list. */\n"
32826 "   struct guestfs_int_bool *val; /* Elements. */\n"
32827 " };\n"
32828 " \n"
32829 msgstr ""
32830
32831 #. type: verbatim
32832 #: ../src/guestfs-structs.pod:13
32833 #, no-wrap
32834 msgid ""
32835 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
32836 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
32837 "\n"
32838 msgstr ""
32839
32840 #. type: =head2
32841 #: ../src/guestfs-structs.pod:16
32842 msgid "guestfs_lvm_pv"
32843 msgstr ""
32844
32845 #. type: verbatim
32846 #: ../src/guestfs-structs.pod:18
32847 #, no-wrap
32848 msgid ""
32849 " struct guestfs_lvm_pv {\n"
32850 "   char *pv_name;\n"
32851 "   /* The next field is NOT nul-terminated, be careful when printing it: "
32852 "*/\n"
32853 "   char pv_uuid[32];\n"
32854 "   char *pv_fmt;\n"
32855 "   uint64_t pv_size;\n"
32856 "   uint64_t dev_size;\n"
32857 "   uint64_t pv_free;\n"
32858 "   uint64_t pv_used;\n"
32859 "   char *pv_attr;\n"
32860 "   int64_t pv_pe_count;\n"
32861 "   int64_t pv_pe_alloc_count;\n"
32862 "   char *pv_tags;\n"
32863 "   uint64_t pe_start;\n"
32864 "   int64_t pv_mda_count;\n"
32865 "   uint64_t pv_mda_free;\n"
32866 " };\n"
32867 " \n"
32868 msgstr ""
32869
32870 #. type: verbatim
32871 #: ../src/guestfs-structs.pod:36
32872 #, no-wrap
32873 msgid ""
32874 " struct guestfs_lvm_pv_list {\n"
32875 "   uint32_t len; /* Number of elements in list. */\n"
32876 "   struct guestfs_lvm_pv *val; /* Elements. */\n"
32877 " };\n"
32878 " \n"
32879 msgstr ""
32880
32881 #. type: verbatim
32882 #: ../src/guestfs-structs.pod:41
32883 #, no-wrap
32884 msgid ""
32885 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
32886 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
32887 "\n"
32888 msgstr ""
32889
32890 #. type: =head2
32891 #: ../src/guestfs-structs.pod:44
32892 msgid "guestfs_lvm_vg"
32893 msgstr ""
32894
32895 #. type: verbatim
32896 #: ../src/guestfs-structs.pod:46
32897 #, no-wrap
32898 msgid ""
32899 " struct guestfs_lvm_vg {\n"
32900 "   char *vg_name;\n"
32901 "   /* The next field is NOT nul-terminated, be careful when printing it: "
32902 "*/\n"
32903 "   char vg_uuid[32];\n"
32904 "   char *vg_fmt;\n"
32905 "   char *vg_attr;\n"
32906 "   uint64_t vg_size;\n"
32907 "   uint64_t vg_free;\n"
32908 "   char *vg_sysid;\n"
32909 "   uint64_t vg_extent_size;\n"
32910 "   int64_t vg_extent_count;\n"
32911 "   int64_t vg_free_count;\n"
32912 "   int64_t max_lv;\n"
32913 "   int64_t max_pv;\n"
32914 "   int64_t pv_count;\n"
32915 "   int64_t lv_count;\n"
32916 "   int64_t snap_count;\n"
32917 "   int64_t vg_seqno;\n"
32918 "   char *vg_tags;\n"
32919 "   int64_t vg_mda_count;\n"
32920 "   uint64_t vg_mda_free;\n"
32921 " };\n"
32922 " \n"
32923 msgstr ""
32924
32925 #. type: verbatim
32926 #: ../src/guestfs-structs.pod:69
32927 #, no-wrap
32928 msgid ""
32929 " struct guestfs_lvm_vg_list {\n"
32930 "   uint32_t len; /* Number of elements in list. */\n"
32931 "   struct guestfs_lvm_vg *val; /* Elements. */\n"
32932 " };\n"
32933 " \n"
32934 msgstr ""
32935
32936 #. type: verbatim
32937 #: ../src/guestfs-structs.pod:74
32938 #, no-wrap
32939 msgid ""
32940 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
32941 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
32942 "\n"
32943 msgstr ""
32944
32945 #. type: =head2
32946 #: ../src/guestfs-structs.pod:77
32947 msgid "guestfs_lvm_lv"
32948 msgstr ""
32949
32950 #. type: verbatim
32951 #: ../src/guestfs-structs.pod:79
32952 #, no-wrap
32953 msgid ""
32954 " struct guestfs_lvm_lv {\n"
32955 "   char *lv_name;\n"
32956 "   /* The next field is NOT nul-terminated, be careful when printing it: "
32957 "*/\n"
32958 "   char lv_uuid[32];\n"
32959 "   char *lv_attr;\n"
32960 "   int64_t lv_major;\n"
32961 "   int64_t lv_minor;\n"
32962 "   int64_t lv_kernel_major;\n"
32963 "   int64_t lv_kernel_minor;\n"
32964 "   uint64_t lv_size;\n"
32965 "   int64_t seg_count;\n"
32966 "   char *origin;\n"
32967 "   /* The next field is [0..100] or -1 meaning 'not present': */\n"
32968 "   float snap_percent;\n"
32969 "   /* The next field is [0..100] or -1 meaning 'not present': */\n"
32970 "   float copy_percent;\n"
32971 "   char *move_pv;\n"
32972 "   char *lv_tags;\n"
32973 "   char *mirror_log;\n"
32974 "   char *modules;\n"
32975 " };\n"
32976 " \n"
32977 msgstr ""
32978
32979 #. type: verbatim
32980 #: ../src/guestfs-structs.pod:101
32981 #, no-wrap
32982 msgid ""
32983 " struct guestfs_lvm_lv_list {\n"
32984 "   uint32_t len; /* Number of elements in list. */\n"
32985 "   struct guestfs_lvm_lv *val; /* Elements. */\n"
32986 " };\n"
32987 " \n"
32988 msgstr ""
32989
32990 #. type: verbatim
32991 #: ../src/guestfs-structs.pod:106
32992 #, no-wrap
32993 msgid ""
32994 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
32995 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
32996 "\n"
32997 msgstr ""
32998
32999 #. type: verbatim
33000 #: ../src/guestfs-structs.pod:111
33001 #, no-wrap
33002 msgid ""
33003 " struct guestfs_stat {\n"
33004 "   int64_t dev;\n"
33005 "   int64_t ino;\n"
33006 "   int64_t mode;\n"
33007 "   int64_t nlink;\n"
33008 "   int64_t uid;\n"
33009 "   int64_t gid;\n"
33010 "   int64_t rdev;\n"
33011 "   int64_t size;\n"
33012 "   int64_t blksize;\n"
33013 "   int64_t blocks;\n"
33014 "   int64_t atime;\n"
33015 "   int64_t mtime;\n"
33016 "   int64_t ctime;\n"
33017 " };\n"
33018 " \n"
33019 msgstr ""
33020
33021 #. type: verbatim
33022 #: ../src/guestfs-structs.pod:127
33023 #, no-wrap
33024 msgid ""
33025 " struct guestfs_stat_list {\n"
33026 "   uint32_t len; /* Number of elements in list. */\n"
33027 "   struct guestfs_stat *val; /* Elements. */\n"
33028 " };\n"
33029 " \n"
33030 msgstr ""
33031
33032 #. type: verbatim
33033 #: ../src/guestfs-structs.pod:132
33034 #, no-wrap
33035 msgid ""
33036 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
33037 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
33038 "\n"
33039 msgstr ""
33040
33041 #. type: verbatim
33042 #: ../src/guestfs-structs.pod:137
33043 #, no-wrap
33044 msgid ""
33045 " struct guestfs_statvfs {\n"
33046 "   int64_t bsize;\n"
33047 "   int64_t frsize;\n"
33048 "   int64_t blocks;\n"
33049 "   int64_t bfree;\n"
33050 "   int64_t bavail;\n"
33051 "   int64_t files;\n"
33052 "   int64_t ffree;\n"
33053 "   int64_t favail;\n"
33054 "   int64_t fsid;\n"
33055 "   int64_t flag;\n"
33056 "   int64_t namemax;\n"
33057 " };\n"
33058 " \n"
33059 msgstr ""
33060
33061 #. type: verbatim
33062 #: ../src/guestfs-structs.pod:151
33063 #, no-wrap
33064 msgid ""
33065 " struct guestfs_statvfs_list {\n"
33066 "   uint32_t len; /* Number of elements in list. */\n"
33067 "   struct guestfs_statvfs *val; /* Elements. */\n"
33068 " };\n"
33069 " \n"
33070 msgstr ""
33071
33072 #. type: verbatim
33073 #: ../src/guestfs-structs.pod:156
33074 #, no-wrap
33075 msgid ""
33076 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
33077 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
33078 "\n"
33079 msgstr ""
33080
33081 #. type: =head2
33082 #: ../src/guestfs-structs.pod:159
33083 msgid "guestfs_dirent"
33084 msgstr ""
33085
33086 #. type: verbatim
33087 #: ../src/guestfs-structs.pod:161
33088 #, no-wrap
33089 msgid ""
33090 " struct guestfs_dirent {\n"
33091 "   int64_t ino;\n"
33092 "   char ftyp;\n"
33093 "   char *name;\n"
33094 " };\n"
33095 " \n"
33096 msgstr ""
33097
33098 #. type: verbatim
33099 #: ../src/guestfs-structs.pod:167
33100 #, no-wrap
33101 msgid ""
33102 " struct guestfs_dirent_list {\n"
33103 "   uint32_t len; /* Number of elements in list. */\n"
33104 "   struct guestfs_dirent *val; /* Elements. */\n"
33105 " };\n"
33106 " \n"
33107 msgstr ""
33108
33109 #. type: verbatim
33110 #: ../src/guestfs-structs.pod:172
33111 #, no-wrap
33112 msgid ""
33113 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
33114 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
33115 "\n"
33116 msgstr ""
33117
33118 #. type: verbatim
33119 #: ../src/guestfs-structs.pod:177
33120 #, no-wrap
33121 msgid ""
33122 " struct guestfs_version {\n"
33123 "   int64_t major;\n"
33124 "   int64_t minor;\n"
33125 "   int64_t release;\n"
33126 "   char *extra;\n"
33127 " };\n"
33128 " \n"
33129 msgstr ""
33130
33131 #. type: verbatim
33132 #: ../src/guestfs-structs.pod:184
33133 #, no-wrap
33134 msgid ""
33135 " struct guestfs_version_list {\n"
33136 "   uint32_t len; /* Number of elements in list. */\n"
33137 "   struct guestfs_version *val; /* Elements. */\n"
33138 " };\n"
33139 " \n"
33140 msgstr ""
33141
33142 #. type: verbatim
33143 #: ../src/guestfs-structs.pod:189
33144 #, no-wrap
33145 msgid ""
33146 " void guestfs_free_version (struct guestfs_free_version *);\n"
33147 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
33148 "\n"
33149 msgstr ""
33150
33151 #. type: =head2
33152 #: ../src/guestfs-structs.pod:192
33153 msgid "guestfs_xattr"
33154 msgstr ""
33155
33156 #. type: verbatim
33157 #: ../src/guestfs-structs.pod:194
33158 #, no-wrap
33159 msgid ""
33160 " struct guestfs_xattr {\n"
33161 "   char *attrname;\n"
33162 "   /* The next two fields describe a byte array. */\n"
33163 "   uint32_t attrval_len;\n"
33164 "   char *attrval;\n"
33165 " };\n"
33166 " \n"
33167 msgstr ""
33168
33169 #. type: verbatim
33170 #: ../src/guestfs-structs.pod:201
33171 #, no-wrap
33172 msgid ""
33173 " struct guestfs_xattr_list {\n"
33174 "   uint32_t len; /* Number of elements in list. */\n"
33175 "   struct guestfs_xattr *val; /* Elements. */\n"
33176 " };\n"
33177 " \n"
33178 msgstr ""
33179
33180 #. type: verbatim
33181 #: ../src/guestfs-structs.pod:206
33182 #, no-wrap
33183 msgid ""
33184 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
33185 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
33186 "\n"
33187 msgstr ""
33188
33189 #. type: =head2
33190 #: ../src/guestfs-structs.pod:209
33191 msgid "guestfs_inotify_event"
33192 msgstr ""
33193
33194 #. type: verbatim
33195 #: ../src/guestfs-structs.pod:211
33196 #, no-wrap
33197 msgid ""
33198 " struct guestfs_inotify_event {\n"
33199 "   int64_t in_wd;\n"
33200 "   uint32_t in_mask;\n"
33201 "   uint32_t in_cookie;\n"
33202 "   char *in_name;\n"
33203 " };\n"
33204 " \n"
33205 msgstr ""
33206
33207 #. type: verbatim
33208 #: ../src/guestfs-structs.pod:218
33209 #, no-wrap
33210 msgid ""
33211 " struct guestfs_inotify_event_list {\n"
33212 "   uint32_t len; /* Number of elements in list. */\n"
33213 "   struct guestfs_inotify_event *val; /* Elements. */\n"
33214 " };\n"
33215 " \n"
33216 msgstr ""
33217
33218 #. type: verbatim
33219 #: ../src/guestfs-structs.pod:223
33220 #, no-wrap
33221 msgid ""
33222 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
33223 " void guestfs_free_inotify_event_list (struct "
33224 "guestfs_free_inotify_event_list *);\n"
33225 "\n"
33226 msgstr ""
33227
33228 #. type: =head2
33229 #: ../src/guestfs-structs.pod:226
33230 msgid "guestfs_partition"
33231 msgstr ""
33232
33233 #. type: verbatim
33234 #: ../src/guestfs-structs.pod:228
33235 #, no-wrap
33236 msgid ""
33237 " struct guestfs_partition {\n"
33238 "   int32_t part_num;\n"
33239 "   uint64_t part_start;\n"
33240 "   uint64_t part_end;\n"
33241 "   uint64_t part_size;\n"
33242 " };\n"
33243 " \n"
33244 msgstr ""
33245
33246 #. type: verbatim
33247 #: ../src/guestfs-structs.pod:235
33248 #, no-wrap
33249 msgid ""
33250 " struct guestfs_partition_list {\n"
33251 "   uint32_t len; /* Number of elements in list. */\n"
33252 "   struct guestfs_partition *val; /* Elements. */\n"
33253 " };\n"
33254 " \n"
33255 msgstr ""
33256
33257 #. type: verbatim
33258 #: ../src/guestfs-structs.pod:240
33259 #, no-wrap
33260 msgid ""
33261 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
33262 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
33263 "\n"
33264 msgstr ""
33265
33266 #. type: =head2
33267 #: ../src/guestfs-structs.pod:243
33268 msgid "guestfs_application"
33269 msgstr ""
33270
33271 #. type: verbatim
33272 #: ../src/guestfs-structs.pod:245
33273 #, no-wrap
33274 msgid ""
33275 " struct guestfs_application {\n"
33276 "   char *app_name;\n"
33277 "   char *app_display_name;\n"
33278 "   int32_t app_epoch;\n"
33279 "   char *app_version;\n"
33280 "   char *app_release;\n"
33281 "   char *app_install_path;\n"
33282 "   char *app_trans_path;\n"
33283 "   char *app_publisher;\n"
33284 "   char *app_url;\n"
33285 "   char *app_source_package;\n"
33286 "   char *app_summary;\n"
33287 "   char *app_description;\n"
33288 " };\n"
33289 " \n"
33290 msgstr ""
33291
33292 #. type: verbatim
33293 #: ../src/guestfs-structs.pod:260
33294 #, no-wrap
33295 msgid ""
33296 " struct guestfs_application_list {\n"
33297 "   uint32_t len; /* Number of elements in list. */\n"
33298 "   struct guestfs_application *val; /* Elements. */\n"
33299 " };\n"
33300 " \n"
33301 msgstr ""
33302
33303 #. type: verbatim
33304 #: ../src/guestfs-structs.pod:265
33305 #, no-wrap
33306 msgid ""
33307 " void guestfs_free_application (struct guestfs_free_application *);\n"
33308 " void guestfs_free_application_list (struct guestfs_free_application_list "
33309 "*);\n"
33310 "\n"
33311 msgstr ""
33312
33313 #. type: textblock
33314 #: ../src/guestfs.pod:5
33315 msgid "guestfs - Library for accessing and modifying virtual machine images"
33316 msgstr ""
33317
33318 #. type: verbatim
33319 #: ../src/guestfs.pod:11
33320 #, no-wrap
33321 msgid ""
33322 " guestfs_h *g = guestfs_create ();\n"
33323 " guestfs_add_drive (g, \"guest.img\");\n"
33324 " guestfs_launch (g);\n"
33325 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
33326 " guestfs_touch (g, \"/hello\");\n"
33327 " guestfs_umount (g, \"/\");\n"
33328 " guestfs_close (g);\n"
33329 "\n"
33330 msgstr ""
33331
33332 #. type: textblock
33333 #: ../src/guestfs.pod:25
33334 msgid ""
33335 "Libguestfs is a library for accessing and modifying guest disk images.  "
33336 "Amongst the things this is good for: making batch configuration changes to "
33337 "guests, getting disk used/free statistics (see also: virt-df), migrating "
33338 "between virtualization systems (see also: virt-p2v), performing partial "
33339 "backups, performing partial guest clones, cloning guests and changing "
33340 "registry/UUID/hostname info, and much else besides."
33341 msgstr ""
33342
33343 #. type: textblock
33344 #: ../src/guestfs.pod:33
33345 msgid ""
33346 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
33347 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
33348 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
33349 "qcow2, vmdk."
33350 msgstr ""
33351
33352 #. type: textblock
33353 #: ../src/guestfs.pod:38
33354 msgid ""
33355 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
33356 "what filesystem is in each LV, etc.).  It can also run commands in the "
33357 "context of the guest.  Also you can access filesystems over FUSE."
33358 msgstr ""
33359
33360 #. type: textblock
33361 #: ../src/guestfs.pod:43
33362 msgid ""
33363 "Libguestfs is a library that can be linked with C and C++ management "
33364 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
33365 "PHP, Erlang, Haskell or C#).  You can also use it from shell scripts or the "
33366 "command line."
33367 msgstr ""
33368
33369 #. type: textblock
33370 #: ../src/guestfs.pod:48
33371 msgid ""
33372 "You don't need to be root to use libguestfs, although obviously you do need "
33373 "enough permissions to access the disk images."
33374 msgstr ""
33375
33376 #. type: textblock
33377 #: ../src/guestfs.pod:51
33378 msgid ""
33379 "Libguestfs is a large API because it can do many things.  For a gentle "
33380 "introduction, please read the L</API OVERVIEW> section next."
33381 msgstr ""
33382
33383 #. type: textblock
33384 #: ../src/guestfs.pod:54
33385 msgid ""
33386 "There are also some example programs in the L<guestfs-examples(3)> manual "
33387 "page."
33388 msgstr ""
33389
33390 #. type: =head1
33391 #: ../src/guestfs.pod:57
33392 msgid "API OVERVIEW"
33393 msgstr ""
33394
33395 #. type: textblock
33396 #: ../src/guestfs.pod:59
33397 msgid ""
33398 "This section provides a gentler overview of the libguestfs API.  We also try "
33399 "to group API calls together, where that may not be obvious from reading "
33400 "about the individual calls in the main section of this manual."
33401 msgstr ""
33402
33403 #. type: =head2
33404 #: ../src/guestfs.pod:64
33405 msgid "HANDLES"
33406 msgstr ""
33407
33408 #. type: textblock
33409 #: ../src/guestfs.pod:66
33410 msgid ""
33411 "Before you can use libguestfs calls, you have to create a handle.  Then you "
33412 "must add at least one disk image to the handle, followed by launching the "
33413 "handle, then performing whatever operations you want, and finally closing "
33414 "the handle.  By convention we use the single letter C<g> for the name of the "
33415 "handle variable, although of course you can use any name you want."
33416 msgstr ""
33417
33418 #. type: textblock
33419 #: ../src/guestfs.pod:73
33420 msgid "The general structure of all libguestfs-using programs looks like this:"
33421 msgstr ""
33422
33423 #. type: verbatim
33424 #: ../src/guestfs.pod:76
33425 #, no-wrap
33426 msgid ""
33427 " guestfs_h *g = guestfs_create ();\n"
33428 " \n"
33429 msgstr ""
33430
33431 #. type: verbatim
33432 #: ../src/guestfs.pod:78
33433 #, no-wrap
33434 msgid ""
33435 " /* Call guestfs_add_drive additional times if there are\n"
33436 "  * multiple disk images.\n"
33437 "  */\n"
33438 " guestfs_add_drive (g, \"guest.img\");\n"
33439 " \n"
33440 msgstr ""
33441
33442 #. type: verbatim
33443 #: ../src/guestfs.pod:83
33444 #, no-wrap
33445 msgid ""
33446 " /* Most manipulation calls won't work until you've launched\n"
33447 "  * the handle 'g'.  You have to do this _after_ adding drives\n"
33448 "  * and _before_ other commands.\n"
33449 "  */\n"
33450 " guestfs_launch (g);\n"
33451 " \n"
33452 msgstr ""
33453
33454 #. type: verbatim
33455 #: ../src/guestfs.pod:89
33456 #, no-wrap
33457 msgid ""
33458 " /* Now you can examine what partitions, LVs etc are available.\n"
33459 "  */\n"
33460 " char **partitions = guestfs_list_partitions (g);\n"
33461 " char **logvols = guestfs_lvs (g);\n"
33462 " \n"
33463 msgstr ""
33464
33465 #. type: verbatim
33466 #: ../src/guestfs.pod:94
33467 #, no-wrap
33468 msgid ""
33469 " /* To access a filesystem in the image, you must mount it.\n"
33470 "  */\n"
33471 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
33472 " \n"
33473 msgstr ""
33474
33475 #. type: verbatim
33476 #: ../src/guestfs.pod:98
33477 #, no-wrap
33478 msgid ""
33479 " /* Now you can perform filesystem actions on the guest\n"
33480 "  * disk image.\n"
33481 "  */\n"
33482 " guestfs_touch (g, \"/hello\");\n"
33483 " \n"
33484 msgstr ""
33485
33486 #. type: verbatim
33487 #: ../src/guestfs.pod:103
33488 #, no-wrap
33489 msgid ""
33490 " /* This is only needed for libguestfs < 1.5.24.  Since then\n"
33491 "  * it is done automatically when you close the handle.  See\n"
33492 "  * discussion of autosync in this page.\n"
33493 "  */\n"
33494 " guestfs_sync (g);\n"
33495 " \n"
33496 msgstr ""
33497
33498 #. type: verbatim
33499 #: ../src/guestfs.pod:109
33500 #, no-wrap
33501 msgid ""
33502 " /* Close the handle 'g'. */\n"
33503 " guestfs_close (g);\n"
33504 "\n"
33505 msgstr ""
33506
33507 #. type: textblock
33508 #: ../src/guestfs.pod:112
33509 msgid ""
33510 "The code above doesn't include any error checking.  In real code you should "
33511 "check return values carefully for errors.  In general all functions that "
33512 "return integers return C<-1> on error, and all functions that return "
33513 "pointers return C<NULL> on error.  See section L</ERROR HANDLING> below for "
33514 "how to handle errors, and consult the documentation for each function call "
33515 "below to see precisely how they return error indications.  See "
33516 "L<guestfs-examples(3)> for fully worked examples."
33517 msgstr ""
33518
33519 #. type: =head2
33520 #: ../src/guestfs.pod:121
33521 msgid "DISK IMAGES"
33522 msgstr ""
33523
33524 #. type: textblock
33525 #: ../src/guestfs.pod:123
33526 msgid ""
33527 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
33528 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
33529 "actual block device, or simply an empty file of zeroes that you have created "
33530 "through L<posix_fallocate(3)>.  Libguestfs lets you do useful things to all "
33531 "of these."
33532 msgstr ""
33533
33534 #. type: textblock
33535 #: ../src/guestfs.pod:129
33536 msgid ""
33537 "The call you should use in modern code for adding drives is "
33538 "L</guestfs_add_drive_opts>.  To add a disk image, allowing writes, and "
33539 "specifying that the format is raw, do:"
33540 msgstr ""
33541
33542 #. type: verbatim
33543 #: ../src/guestfs.pod:133
33544 #, no-wrap
33545 msgid ""
33546 " guestfs_add_drive_opts (g, filename,\n"
33547 "                         GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
33548 "                         -1);\n"
33549 "\n"
33550 msgstr ""
33551
33552 #. type: textblock
33553 #: ../src/guestfs.pod:137
33554 msgid "You can add a disk read-only using:"
33555 msgstr ""
33556
33557 #. type: verbatim
33558 #: ../src/guestfs.pod:139
33559 #, no-wrap
33560 msgid ""
33561 " guestfs_add_drive_opts (g, filename,\n"
33562 "                         GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
33563 "                         GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
33564 "                         -1);\n"
33565 "\n"
33566 msgstr ""
33567
33568 #. type: textblock
33569 #: ../src/guestfs.pod:144
33570 msgid ""
33571 "or by calling the older function L</guestfs_add_drive_ro>.  In either case "
33572 "libguestfs won't modify the file."
33573 msgstr ""
33574
33575 #. type: textblock
33576 #: ../src/guestfs.pod:147
33577 msgid ""
33578 "Be extremely cautious if the disk image is in use, eg. if it is being used "
33579 "by a virtual machine.  Adding it read-write will almost certainly cause disk "
33580 "corruption, but adding it read-only is safe."
33581 msgstr ""
33582
33583 #. type: textblock
33584 #: ../src/guestfs.pod:151
33585 msgid ""
33586 "You must add at least one disk image, and you may add multiple disk images.  "
33587 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
33588 "first one you added), C</dev/sdb> (for the second one you added), etc."
33589 msgstr ""
33590
33591 #. type: textblock
33592 #: ../src/guestfs.pod:156
33593 msgid ""
33594 "Once L</guestfs_launch> has been called you cannot add any more images.  You "
33595 "can call L</guestfs_list_devices> to get a list of the device names, in the "
33596 "order that you added them.  See also L</BLOCK DEVICE NAMING> below."
33597 msgstr ""
33598
33599 #. type: =head2
33600 #: ../src/guestfs.pod:161
33601 msgid "MOUNTING"
33602 msgstr ""
33603
33604 #. type: textblock
33605 #: ../src/guestfs.pod:163
33606 msgid ""
33607 "Before you can read or write files, create directories and so on in a disk "
33608 "image that contains filesystems, you have to mount those filesystems using "
33609 "L</guestfs_mount_options> or L</guestfs_mount_ro>.  If you already know that "
33610 "a disk image contains (for example) one partition with a filesystem on that "
33611 "partition, then you can mount it directly:"
33612 msgstr ""
33613
33614 #. type: verbatim
33615 #: ../src/guestfs.pod:170
33616 #, no-wrap
33617 msgid ""
33618 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
33619 "\n"
33620 msgstr ""
33621
33622 #. type: textblock
33623 #: ../src/guestfs.pod:172
33624 msgid ""
33625 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
33626 "disk image that we added (C</dev/sda>).  If the disk contains Linux LVM2 "
33627 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>).  Note "
33628 "that these are libguestfs virtual devices, and are nothing to do with host "
33629 "devices."
33630 msgstr ""
33631
33632 #. type: textblock
33633 #: ../src/guestfs.pod:178
33634 msgid ""
33635 "If you are given a disk image and you don't know what it contains then you "
33636 "have to find out.  Libguestfs can do that too: use "
33637 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
33638 "and LVs, and either try mounting each to see what is mountable, or else "
33639 "examine them with L</guestfs_vfs_type> or L</guestfs_file>.  To list just "
33640 "filesystems, use L</guestfs_list_filesystems>."
33641 msgstr ""
33642
33643 #. type: textblock
33644 #: ../src/guestfs.pod:186
33645 msgid ""
33646 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
33647 "L</INSPECTION> below).  But you might find it easier to look at higher level "
33648 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
33649 msgstr ""
33650
33651 #. type: textblock
33652 #: ../src/guestfs.pod:191
33653 msgid ""
33654 "To mount a filesystem read-only, use L</guestfs_mount_ro>.  There are "
33655 "several other variations of the C<guestfs_mount_*> call."
33656 msgstr ""
33657
33658 #. type: =head2
33659 #: ../src/guestfs.pod:194
33660 msgid "FILESYSTEM ACCESS AND MODIFICATION"
33661 msgstr ""
33662
33663 #. type: textblock
33664 #: ../src/guestfs.pod:196
33665 msgid ""
33666 "The majority of the libguestfs API consists of fairly low-level calls for "
33667 "accessing and modifying the files, directories, symlinks etc on mounted "
33668 "filesystems.  There are over a hundred such calls which you can find listed "
33669 "in detail below in this man page, and we don't even pretend to cover them "
33670 "all in this overview."
33671 msgstr ""
33672
33673 #. type: textblock
33674 #: ../src/guestfs.pod:202
33675 msgid ""
33676 "Specify filenames as full paths, starting with C<\"/\"> and including the "
33677 "mount point."
33678 msgstr ""
33679
33680 #. type: textblock
33681 #: ../src/guestfs.pod:205
33682 msgid ""
33683 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
33684 "the file called C<\"etc/passwd\"> then you could do:"
33685 msgstr ""
33686
33687 #. type: verbatim
33688 #: ../src/guestfs.pod:208
33689 #, no-wrap
33690 msgid ""
33691 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
33692 "\n"
33693 msgstr ""
33694
33695 #. type: textblock
33696 #: ../src/guestfs.pod:210
33697 msgid ""
33698 "This would return C<data> as a newly allocated buffer containing the full "
33699 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
33700 "or C<NULL> if there was an error."
33701 msgstr ""
33702
33703 #. type: textblock
33704 #: ../src/guestfs.pod:214
33705 msgid ""
33706 "As another example, to create a top-level directory on that filesystem "
33707 "called C<\"var\"> you would do:"
33708 msgstr ""
33709
33710 #. type: verbatim
33711 #: ../src/guestfs.pod:217
33712 #, no-wrap
33713 msgid ""
33714 " guestfs_mkdir (g, \"/var\");\n"
33715 "\n"
33716 msgstr ""
33717
33718 #. type: textblock
33719 #: ../src/guestfs.pod:219
33720 msgid "To create a symlink you could do:"
33721 msgstr ""
33722
33723 #. type: verbatim
33724 #: ../src/guestfs.pod:221
33725 #, no-wrap
33726 msgid ""
33727 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
33728 "               \"/etc/rc3.d/S30portmap\");\n"
33729 "\n"
33730 msgstr ""
33731
33732 #. type: textblock
33733 #: ../src/guestfs.pod:224
33734 msgid ""
33735 "Libguestfs will reject attempts to use relative paths and there is no "
33736 "concept of a current working directory."
33737 msgstr ""
33738
33739 #. type: textblock
33740 #: ../src/guestfs.pod:227
33741 msgid ""
33742 "Libguestfs can return errors in many situations: for example if the "
33743 "filesystem isn't writable, or if a file or directory that you requested "
33744 "doesn't exist.  If you are using the C API (documented here)  you have to "
33745 "check for those error conditions after each call.  (Other language bindings "
33746 "turn these errors into exceptions)."
33747 msgstr ""
33748
33749 #. type: textblock
33750 #: ../src/guestfs.pod:233
33751 msgid ""
33752 "File writes are affected by the per-handle umask, set by calling "
33753 "L</guestfs_umask> and defaulting to 022.  See L</UMASK>."
33754 msgstr ""
33755
33756 #. type: =head2
33757 #: ../src/guestfs.pod:236
33758 msgid "PARTITIONING"
33759 msgstr ""
33760
33761 #. type: textblock
33762 #: ../src/guestfs.pod:238
33763 msgid ""
33764 "Libguestfs contains API calls to read, create and modify partition tables on "
33765 "disk images."
33766 msgstr ""
33767
33768 #. type: textblock
33769 #: ../src/guestfs.pod:241
33770 msgid ""
33771 "In the common case where you want to create a single partition covering the "
33772 "whole disk, you should use the L</guestfs_part_disk> call:"
33773 msgstr ""
33774
33775 #. type: verbatim
33776 #: ../src/guestfs.pod:245
33777 #, no-wrap
33778 msgid ""
33779 " const char *parttype = \"mbr\";\n"
33780 " if (disk_is_larger_than_2TB)\n"
33781 "   parttype = \"gpt\";\n"
33782 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
33783 "\n"
33784 msgstr ""
33785
33786 #. type: textblock
33787 #: ../src/guestfs.pod:250
33788 msgid ""
33789 "Obviously this effectively wipes anything that was on that disk image "
33790 "before."
33791 msgstr ""
33792
33793 #. type: =head2
33794 #: ../src/guestfs.pod:253
33795 msgid "LVM2"
33796 msgstr ""
33797
33798 #. type: textblock
33799 #: ../src/guestfs.pod:255
33800 msgid ""
33801 "Libguestfs provides access to a large part of the LVM2 API, such as "
33802 "L</guestfs_lvcreate> and L</guestfs_vgremove>.  It won't make much sense "
33803 "unless you familiarize yourself with the concepts of physical volumes, "
33804 "volume groups and logical volumes."
33805 msgstr ""
33806
33807 #. type: textblock
33808 #: ../src/guestfs.pod:260
33809 msgid ""
33810 "This author strongly recommends reading the LVM HOWTO, online at "
33811 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
33812 msgstr ""
33813
33814 #. type: =head2
33815 #: ../src/guestfs.pod:263
33816 msgid "DOWNLOADING"
33817 msgstr ""
33818
33819 #. type: textblock
33820 #: ../src/guestfs.pod:265
33821 msgid ""
33822 "Use L</guestfs_cat> to download small, text only files.  This call is "
33823 "limited to files which are less than 2 MB and which cannot contain any ASCII "
33824 "NUL (C<\\0>) characters.  However the API is very simple to use."
33825 msgstr ""
33826
33827 #. type: textblock
33828 #: ../src/guestfs.pod:269
33829 msgid ""
33830 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
33831 "bit data, since it returns a (pointer, size) pair.  However it is still "
33832 "limited to \"small\" files, less than 2 MB."
33833 msgstr ""
33834
33835 #. type: textblock
33836 #: ../src/guestfs.pod:273
33837 msgid ""
33838 "L</guestfs_download> can be used to download any file, with no limits on "
33839 "content or size (even files larger than 4 GB)."
33840 msgstr ""
33841
33842 #. type: textblock
33843 #: ../src/guestfs.pod:276
33844 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
33845 msgstr ""
33846
33847 #. type: =head2
33848 #: ../src/guestfs.pod:279
33849 msgid "UPLOADING"
33850 msgstr ""
33851
33852 #. type: textblock
33853 #: ../src/guestfs.pod:281
33854 msgid ""
33855 "It's often the case that you want to write a file or files to the disk "
33856 "image."
33857 msgstr ""
33858
33859 #. type: textblock
33860 #: ../src/guestfs.pod:284
33861 msgid ""
33862 "To write a small file with fixed content, use L</guestfs_write>.  To create "
33863 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
33864 "L</guestfs_fallocate64> (with all disk blocks allocated).  There are a "
33865 "variety of other functions for creating test files, for example "
33866 "L</guestfs_fill> and L</guestfs_fill_pattern>."
33867 msgstr ""
33868
33869 #. type: textblock
33870 #: ../src/guestfs.pod:290
33871 msgid ""
33872 "To upload a single file, use L</guestfs_upload>.  This call has no limits on "
33873 "file content or size (even files larger than 4 GB)."
33874 msgstr ""
33875
33876 #. type: textblock
33877 #: ../src/guestfs.pod:293
33878 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
33879 msgstr ""
33880
33881 #. type: textblock
33882 #: ../src/guestfs.pod:295
33883 msgid ""
33884 "However the fastest way to upload I<large numbers of arbitrary files> is to "
33885 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
33886 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>.  If you add "
33887 "the drive in a predictable way (eg. adding it last after all other drives) "
33888 "then you can get the device name from L</guestfs_list_devices> and mount it "
33889 "directly using L</guestfs_mount_ro>.  Note that squashfs images are "
33890 "sometimes non-portable between kernel versions, and they don't support "
33891 "labels or UUIDs.  If you want to pre-build an image or you need to mount it "
33892 "using a label or UUID, use an ISO image instead."
33893 msgstr ""
33894
33895 #. type: =head2
33896 #: ../src/guestfs.pod:306
33897 msgid "COPYING"
33898 msgstr ""
33899
33900 #. type: textblock
33901 #: ../src/guestfs.pod:308
33902 msgid ""
33903 "There are various different commands for copying between files and devices "
33904 "and in and out of the guest filesystem.  These are summarised in the table "
33905 "below."
33906 msgstr ""
33907
33908 #. type: =item
33909 #: ../src/guestfs.pod:314
33910 msgid "B<file> to B<file>"
33911 msgstr ""
33912
33913 #. type: textblock
33914 #: ../src/guestfs.pod:316
33915 msgid ""
33916 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
33917 "directories recursively."
33918 msgstr ""
33919
33920 #. type: textblock
33921 #: ../src/guestfs.pod:319
33922 msgid "To copy part of a file (offset and size) use L</guestfs_copy_file_to_file>."
33923 msgstr ""
33924
33925 #. type: =item
33926 #: ../src/guestfs.pod:322
33927 msgid "B<file> to B<device>"
33928 msgstr ""
33929
33930 #. type: =item
33931 #: ../src/guestfs.pod:324
33932 msgid "B<device> to B<file>"
33933 msgstr ""
33934
33935 #. type: =item
33936 #: ../src/guestfs.pod:326
33937 msgid "B<device> to B<device>"
33938 msgstr ""
33939
33940 #. type: textblock
33941 #: ../src/guestfs.pod:328
33942 msgid ""
33943 "Use L</guestfs_copy_file_to_device>, L</guestfs_copy_device_to_file>, or "
33944 "L</guestfs_copy_device_to_device>."
33945 msgstr ""
33946
33947 #. type: textblock
33948 #: ../src/guestfs.pod:331
33949 msgid "Example: duplicate the contents of an LV:"
33950 msgstr ""
33951
33952 #. type: verbatim
33953 #: ../src/guestfs.pod:333
33954 #, no-wrap
33955 msgid ""
33956 " guestfs_copy_device_to_device (g,\n"
33957 "         \"/dev/VG/Original\", \"/dev/VG/Copy\",\n"
33958 "         /* -1 marks the end of the list of optional parameters */\n"
33959 "         -1);\n"
33960 "\n"
33961 msgstr ""
33962
33963 #. type: textblock
33964 #: ../src/guestfs.pod:338
33965 msgid ""
33966 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
33967 "(C</dev/VG/Original>).  To copy less than the whole source device, use the "
33968 "optional C<size> parameter:"
33969 msgstr ""
33970
33971 #. type: verbatim
33972 #: ../src/guestfs.pod:342
33973 #, no-wrap
33974 msgid ""
33975 " guestfs_copy_device_to_device (g,\n"
33976 "         \"/dev/VG/Original\", \"/dev/VG/Copy\",\n"
33977 "         GUESTFS_COPY_DEVICE_TO_DEVICE_SIZE, 10000,\n"
33978 "         -1);\n"
33979 "\n"
33980 msgstr ""
33981
33982 #. type: =item
33983 #: ../src/guestfs.pod:347
33984 msgid "B<file on the host> to B<file or device>"
33985 msgstr ""
33986
33987 #. type: textblock
33988 #: ../src/guestfs.pod:349
33989 msgid "Use L</guestfs_upload>.  See L</UPLOADING> above."
33990 msgstr ""
33991
33992 #. type: =item
33993 #: ../src/guestfs.pod:351
33994 msgid "B<file or device> to B<file on the host>"
33995 msgstr ""
33996
33997 #. type: textblock
33998 #: ../src/guestfs.pod:353
33999 msgid "Use L</guestfs_download>.  See L</DOWNLOADING> above."
34000 msgstr ""
34001
34002 #. type: =head2
34003 #: ../src/guestfs.pod:357
34004 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
34005 msgstr ""
34006
34007 #. type: textblock
34008 #: ../src/guestfs.pod:359
34009 msgid ""
34010 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, "
34011 "L</guestfs_tar_out> etc appear to only take filenames as arguments, so it "
34012 "appears you can only upload and download to files.  However many Un*x-like "
34013 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, "
34014 "C</dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, "
34015 "stderr, and arbitrary file descriptor N."
34016 msgstr ""
34017
34018 #. type: textblock
34019 #: ../src/guestfs.pod:367
34020 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
34021 msgstr ""
34022
34023 #. type: verbatim
34024 #: ../src/guestfs.pod:370
34025 #, no-wrap
34026 msgid ""
34027 " guestfs_download (g, filename, \"/dev/stdout\");\n"
34028 "\n"
34029 msgstr ""
34030
34031 #. type: textblock
34032 #: ../src/guestfs.pod:372
34033 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
34034 msgstr ""
34035
34036 #. type: verbatim
34037 #: ../src/guestfs.pod:374
34038 #, no-wrap
34039 msgid ""
34040 " char devfd[64];\n"
34041 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
34042 " guestfs_tar_out (g, \"/\", devfd);\n"
34043 "\n"
34044 msgstr ""
34045
34046 #. type: =head2
34047 #: ../src/guestfs.pod:378
34048 msgid "LISTING FILES"
34049 msgstr ""
34050
34051 #. type: textblock
34052 #: ../src/guestfs.pod:380
34053 msgid ""
34054 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
34055 "L<guestfish(1)>-equivalent command C<ll>)."
34056 msgstr ""
34057
34058 #. type: textblock
34059 #: ../src/guestfs.pod:383
34060 msgid ""
34061 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
34062 "programs, as a flat list of strings."
34063 msgstr ""
34064
34065 #. type: textblock
34066 #: ../src/guestfs.pod:386
34067 msgid ""
34068 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
34069 "directory, plus additional information about each one.  It is more "
34070 "equivalent to using the L<readdir(3)> call on a local filesystem."
34071 msgstr ""
34072
34073 #. type: textblock
34074 #: ../src/guestfs.pod:390
34075 msgid ""
34076 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
34077 "files."
34078 msgstr ""
34079
34080 #. type: =head2
34081 #: ../src/guestfs.pod:393
34082 msgid "RUNNING COMMANDS"
34083 msgstr ""
34084
34085 #. type: textblock
34086 #: ../src/guestfs.pod:395
34087 msgid ""
34088 "Although libguestfs is primarily an API for manipulating files inside guest "
34089 "images, we also provide some limited facilities for running commands inside "
34090 "guests."
34091 msgstr ""
34092
34093 #. type: textblock
34094 #: ../src/guestfs.pod:399
34095 msgid "There are many limitations to this:"
34096 msgstr ""
34097
34098 #. type: textblock
34099 #: ../src/guestfs.pod:405
34100 msgid ""
34101 "The kernel version that the command runs under will be different from what "
34102 "it expects."
34103 msgstr ""
34104
34105 #. type: textblock
34106 #: ../src/guestfs.pod:410
34107 msgid ""
34108 "If the command needs to communicate with daemons, then most likely they "
34109 "won't be running."
34110 msgstr ""
34111
34112 #. type: textblock
34113 #: ../src/guestfs.pod:415
34114 msgid "The command will be running in limited memory."
34115 msgstr ""
34116
34117 #. type: textblock
34118 #: ../src/guestfs.pod:419
34119 msgid ""
34120 "The network may not be available unless you enable it (see "
34121 "L</guestfs_set_network>)."
34122 msgstr ""
34123
34124 #. type: textblock
34125 #: ../src/guestfs.pod:424
34126 msgid "Only supports Linux guests (not Windows, BSD, etc)."
34127 msgstr ""
34128
34129 #. type: textblock
34130 #: ../src/guestfs.pod:428
34131 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
34132 msgstr ""
34133
34134 #. type: textblock
34135 #: ../src/guestfs.pod:433
34136 msgid ""
34137 "For SELinux guests, you may need to enable SELinux and load policy first.  "
34138 "See L</SELINUX> in this manpage."
34139 msgstr ""
34140
34141 #. type: textblock
34142 #: ../src/guestfs.pod:438
34143 msgid ""
34144 "I<Security:> It is not safe to run commands from untrusted, possibly "
34145 "malicious guests.  These commands may attempt to exploit your program by "
34146 "sending unexpected output.  They could also try to exploit the Linux kernel "
34147 "or qemu provided by the libguestfs appliance.  They could use the network "
34148 "provided by the libguestfs appliance to bypass ordinary network partitions "
34149 "and firewalls.  They could use the elevated privileges or different SELinux "
34150 "context of your program to their advantage."
34151 msgstr ""
34152
34153 #. type: textblock
34154 #: ../src/guestfs.pod:447
34155 msgid ""
34156 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
34157 "(a script which runs when the guest next boots normally), and to have this "
34158 "script run the commands you want in the normal context of the running guest, "
34159 "network security and so on.  For information about other security issues, "
34160 "see L</SECURITY>."
34161 msgstr ""
34162
34163 #. type: textblock
34164 #: ../src/guestfs.pod:455
34165 msgid ""
34166 "The two main API calls to run commands are L</guestfs_command> and "
34167 "L</guestfs_sh> (there are also variations)."
34168 msgstr ""
34169
34170 #. type: textblock
34171 #: ../src/guestfs.pod:458
34172 msgid ""
34173 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
34174 "shell globs, redirections, etc will work."
34175 msgstr ""
34176
34177 #. type: =head2
34178 #: ../src/guestfs.pod:461
34179 msgid "CONFIGURATION FILES"
34180 msgstr ""
34181
34182 #. type: textblock
34183 #: ../src/guestfs.pod:463
34184 msgid ""
34185 "To read and write configuration files in Linux guest filesystems, we "
34186 "strongly recommend using Augeas.  For example, Augeas understands how to "
34187 "read and write, say, a Linux shadow password file or X.org configuration "
34188 "file, and so avoids you having to write that code."
34189 msgstr ""
34190
34191 #. type: textblock
34192 #: ../src/guestfs.pod:468
34193 msgid ""
34194 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs.  We don't "
34195 "document Augeas itself here because there is excellent documentation on the "
34196 "L<http://augeas.net/> website."
34197 msgstr ""
34198
34199 #. type: textblock
34200 #: ../src/guestfs.pod:472
34201 msgid ""
34202 "If you don't want to use Augeas (you fool!) then try calling "
34203 "L</guestfs_read_lines> to get the file as a list of lines which you can "
34204 "iterate over."
34205 msgstr ""
34206
34207 #. type: =head2
34208 #: ../src/guestfs.pod:476
34209 msgid "SELINUX"
34210 msgstr ""
34211
34212 #. type: textblock
34213 #: ../src/guestfs.pod:478
34214 msgid ""
34215 "We support SELinux guests.  To ensure that labeling happens correctly in "
34216 "SELinux guests, you need to enable SELinux and load the guest's policy:"
34217 msgstr ""
34218
34219 #. type: textblock
34220 #: ../src/guestfs.pod:486
34221 msgid "Before launching, do:"
34222 msgstr ""
34223
34224 #. type: verbatim
34225 #: ../src/guestfs.pod:488
34226 #, no-wrap
34227 msgid ""
34228 " guestfs_set_selinux (g, 1);\n"
34229 "\n"
34230 msgstr ""
34231
34232 #. type: textblock
34233 #: ../src/guestfs.pod:492
34234 msgid ""
34235 "After mounting the guest's filesystem(s), load the policy.  This is best "
34236 "done by running the L<load_policy(8)> command in the guest itself:"
34237 msgstr ""
34238
34239 #. type: verbatim
34240 #: ../src/guestfs.pod:496
34241 #, no-wrap
34242 msgid ""
34243 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
34244 "\n"
34245 msgstr ""
34246
34247 #. type: textblock
34248 #: ../src/guestfs.pod:498
34249 msgid ""
34250 "(Older versions of C<load_policy> require you to specify the name of the "
34251 "policy file)."
34252 msgstr ""
34253
34254 #. type: textblock
34255 #: ../src/guestfs.pod:503
34256 msgid ""
34257 "Optionally, set the security context for the API.  The correct security "
34258 "context to use can only be known by inspecting the guest.  As an example:"
34259 msgstr ""
34260
34261 #. type: verbatim
34262 #: ../src/guestfs.pod:507
34263 #, no-wrap
34264 msgid ""
34265 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
34266 "\n"
34267 msgstr ""
34268
34269 #. type: textblock
34270 #: ../src/guestfs.pod:511
34271 msgid "This will work for running commands and editing existing files."
34272 msgstr ""
34273
34274 #. type: textblock
34275 #: ../src/guestfs.pod:513
34276 msgid ""
34277 "When new files are created, you may need to label them explicitly, for "
34278 "example by running the external command C<restorecon pathname>."
34279 msgstr ""
34280
34281 #. type: =head2
34282 #: ../src/guestfs.pod:517
34283 msgid "UMASK"
34284 msgstr ""
34285
34286 #. type: textblock
34287 #: ../src/guestfs.pod:519
34288 msgid ""
34289 "Certain calls are affected by the current file mode creation mask (the "
34290 "\"umask\").  In particular ones which create files or directories, such as "
34291 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>.  This affects "
34292 "either the default mode that the file is created with or modifies the mode "
34293 "that you supply."
34294 msgstr ""
34295
34296 #. type: textblock
34297 #: ../src/guestfs.pod:525
34298 msgid ""
34299 "The default umask is C<022>, so files are created with modes such as C<0644> "
34300 "and directories with C<0755>."
34301 msgstr ""
34302
34303 #. type: textblock
34304 #: ../src/guestfs.pod:528
34305 msgid ""
34306 "There are two ways to avoid being affected by umask.  Either set umask to 0 "
34307 "(call C<guestfs_umask (g, 0)> early after launching).  Or call "
34308 "L</guestfs_chmod> after creating each file or directory."
34309 msgstr ""
34310
34311 #. type: textblock
34312 #: ../src/guestfs.pod:532
34313 msgid "For more information about umask, see L<umask(2)>."
34314 msgstr ""
34315
34316 #. type: textblock
34317 #: ../src/guestfs.pod:536
34318 msgid ""
34319 "Libguestfs allows you to access Linux guests which have been encrypted using "
34320 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
34321 "standard.  This includes nearly all whole disk encryption systems used by "
34322 "modern Linux guests."
34323 msgstr ""
34324
34325 #. type: textblock
34326 #: ../src/guestfs.pod:542
34327 msgid ""
34328 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
34329 "returns the string C<crypto_LUKS>)."
34330 msgstr ""
34331
34332 #. type: textblock
34333 #: ../src/guestfs.pod:545
34334 msgid ""
34335 "Then open these devices by calling L</guestfs_luks_open>.  Obviously you "
34336 "will require the passphrase!"
34337 msgstr ""
34338
34339 #. type: textblock
34340 #: ../src/guestfs.pod:548
34341 msgid ""
34342 "Opening a LUKS device creates a new device mapper device called "
34343 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
34344 "L</guestfs_luks_open>).  Reads and writes to this mapper device are "
34345 "decrypted from and encrypted to the underlying block device respectively."
34346 msgstr ""
34347
34348 #. type: textblock
34349 #: ../src/guestfs.pod:554
34350 msgid ""
34351 "LVM volume groups on the device can be made visible by calling "
34352 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>.  The logical "
34353 "volume(s) can now be mounted in the usual way."
34354 msgstr ""
34355
34356 #. type: textblock
34357 #: ../src/guestfs.pod:558
34358 msgid ""
34359 "Use the reverse process to close a LUKS device.  Unmount any logical volumes "
34360 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
34361 "[\"/dev/VG\"])>.  Then close the mapper device by calling "
34362 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
34363 "underlying encrypted block device)."
34364 msgstr ""
34365
34366 #. type: =head2
34367 #: ../src/guestfs.pod:565
34368 msgid "INSPECTION"
34369 msgstr ""
34370
34371 #. type: textblock
34372 #: ../src/guestfs.pod:567
34373 msgid ""
34374 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
34375 "contains operating systems, an install CD or a live CD.  (These APIs used to "
34376 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
34377 "version 1.5.3 the most frequently used part of this library has been "
34378 "rewritten in C and moved into the core code)."
34379 msgstr ""
34380
34381 #. type: textblock
34382 #: ../src/guestfs.pod:574
34383 msgid ""
34384 "Add all disks belonging to the unknown virtual machine and call "
34385 "L</guestfs_launch> in the usual way."
34386 msgstr ""
34387
34388 #. type: textblock
34389 #: ../src/guestfs.pod:577
34390 msgid ""
34391 "Then call L</guestfs_inspect_os>.  This function uses other libguestfs calls "
34392 "and certain heuristics, and returns a list of operating systems that were "
34393 "found.  An empty list means none were found.  A single element is the root "
34394 "filesystem of the operating system.  For dual- or multi-boot guests, "
34395 "multiple roots can be returned, each one corresponding to a separate "
34396 "operating system.  (Multi-boot virtual machines are extremely rare in the "
34397 "world of virtualization, but since this scenario can happen, we have built "
34398 "libguestfs to deal with it.)"
34399 msgstr ""
34400
34401 #. type: textblock
34402 #: ../src/guestfs.pod:586
34403 msgid ""
34404 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
34405 "to get additional details about that operating system.  For example, call "
34406 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
34407 "Windows and Linux-based operating systems respectively."
34408 msgstr ""
34409
34410 #. type: textblock
34411 #: ../src/guestfs.pod:592
34412 msgid ""
34413 "Un*x-like and Linux-based operating systems usually consist of several "
34414 "filesystems which are mounted at boot time (for example, a separate boot "
34415 "partition mounted on C</boot>).  The inspection rules are able to detect how "
34416 "filesystems correspond to mount points.  Call "
34417 "C<guestfs_inspect_get_mountpoints> to get this mapping.  It might return a "
34418 "hash table like this example:"
34419 msgstr ""
34420
34421 #. type: verbatim
34422 #: ../src/guestfs.pod:599
34423 #, no-wrap
34424 msgid ""
34425 " /boot => /dev/sda1\n"
34426 " /     => /dev/vg_guest/lv_root\n"
34427 " /usr  => /dev/vg_guest/lv_usr\n"
34428 "\n"
34429 msgstr ""
34430
34431 #. type: textblock
34432 #: ../src/guestfs.pod:603
34433 msgid ""
34434 "The caller can then make calls to L</guestfs_mount_options> to mount the "
34435 "filesystems as suggested."
34436 msgstr ""
34437
34438 #. type: textblock
34439 #: ../src/guestfs.pod:606
34440 msgid ""
34441 "Be careful to mount filesystems in the right order (eg. C</> before "
34442 "C</usr>).  Sorting the keys of the hash by length, shortest first, should "
34443 "work."
34444 msgstr ""
34445
34446 #. type: textblock
34447 #: ../src/guestfs.pod:610
34448 msgid ""
34449 "Inspection currently only works for some common operating systems.  "
34450 "Contributors are welcome to send patches for other operating systems that we "
34451 "currently cannot detect."
34452 msgstr ""
34453
34454 #. type: textblock
34455 #: ../src/guestfs.pod:614
34456 msgid ""
34457 "Encrypted disks must be opened before inspection.  See L</ENCRYPTED DISKS> "
34458 "for more details.  The L</guestfs_inspect_os> function just ignores any "
34459 "encrypted devices."
34460 msgstr ""
34461
34462 #. type: textblock
34463 #: ../src/guestfs.pod:618
34464 msgid ""
34465 "A note on the implementation: The call L</guestfs_inspect_os> performs "
34466 "inspection and caches the results in the guest handle.  Subsequent calls to "
34467 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
34468 "re-read the disks.  If you change the content of the guest disks, you can "
34469 "redo inspection by calling L</guestfs_inspect_os> again.  "
34470 "(L</guestfs_inspect_list_applications> works a little differently from the "
34471 "other calls and does read the disks.  See documentation for that function "
34472 "for details)."
34473 msgstr ""
34474
34475 #. type: =head3
34476 #: ../src/guestfs.pod:627
34477 msgid "INSPECTING INSTALL DISKS"
34478 msgstr ""
34479
34480 #. type: textblock
34481 #: ../src/guestfs.pod:629
34482 msgid ""
34483 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
34484 "CDs and more."
34485 msgstr ""
34486
34487 #. type: textblock
34488 #: ../src/guestfs.pod:632
34489 msgid ""
34490 "Call L</guestfs_inspect_get_format> to return the format of the operating "
34491 "system, which currently can be C<installed> (a regular operating system) or "
34492 "C<installer> (some sort of install disk)."
34493 msgstr ""
34494
34495 #. type: textblock
34496 #: ../src/guestfs.pod:636
34497 msgid ""
34498 "Further information is available about the operating system that can be "
34499 "installed using the regular inspection APIs like "
34500 "L</guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> "
34501 "etc."
34502 msgstr ""
34503
34504 #. type: textblock
34505 #: ../src/guestfs.pod:641
34506 msgid ""
34507 "Some additional information specific to installer disks is also available "
34508 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and "
34509 "L</guestfs_inspect_is_multipart> calls."
34510 msgstr ""
34511
34512 #. type: =head2
34513 #: ../src/guestfs.pod:646
34514 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
34515 msgstr ""
34516
34517 #. type: textblock
34518 #: ../src/guestfs.pod:648
34519 msgid ""
34520 "Libguestfs can mount NTFS partitions.  It does this using the "
34521 "L<http://www.ntfs-3g.org/> driver."
34522 msgstr ""
34523
34524 #. type: =head3
34525 #: ../src/guestfs.pod:651
34526 msgid "DRIVE LETTERS AND PATHS"
34527 msgstr ""
34528
34529 #. type: textblock
34530 #: ../src/guestfs.pod:653
34531 msgid ""
34532 "DOS and Windows still use drive letters, and the filesystems are always "
34533 "treated as case insensitive by Windows itself, and therefore you might find "
34534 "a Windows configuration file referring to a path like "
34535 "C<c:\\windows\\system32>.  When the filesystem is mounted in libguestfs, "
34536 "that directory might be referred to as C</WINDOWS/System32>."
34537 msgstr ""
34538
34539 #. type: textblock
34540 #: ../src/guestfs.pod:659
34541 msgid ""
34542 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
34543 "L</guestfs_inspect_get_drive_mappings>)"
34544 msgstr ""
34545
34546 #. type: textblock
34547 #: ../src/guestfs.pod:662
34548 msgid ""
34549 "Dealing with separator characters (backslash vs forward slash) is outside "
34550 "the scope of libguestfs, but usually a simple character replacement will "
34551 "work."
34552 msgstr ""
34553
34554 #. type: textblock
34555 #: ../src/guestfs.pod:666
34556 msgid ""
34557 "To resolve the case insensitivity of paths, call "
34558 "L</guestfs_case_sensitive_path>."
34559 msgstr ""
34560
34561 #. type: =head3
34562 #: ../src/guestfs.pod:669
34563 msgid "ACCESSING THE WINDOWS REGISTRY"
34564 msgstr ""
34565
34566 #. type: textblock
34567 #: ../src/guestfs.pod:671
34568 msgid ""
34569 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
34570 "files, through the library C<hivex> which is part of the libguestfs project "
34571 "although ships as a separate tarball.  You have to locate and download the "
34572 "hive file(s) yourself, and then pass them to C<hivex> functions.  See also "
34573 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
34574 "L<virt-win-reg(1)> for more help on this issue."
34575 msgstr ""
34576
34577 #. type: =head3
34578 #: ../src/guestfs.pod:679
34579 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
34580 msgstr ""
34581
34582 #. type: textblock
34583 #: ../src/guestfs.pod:681
34584 msgid ""
34585 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
34586 "provide something which looks like a Linux symlink.  The way it tries to do "
34587 "the rewriting is described here:"
34588 msgstr ""
34589
34590 #. type: textblock
34591 #: ../src/guestfs.pod:685
34592 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/>"
34593 msgstr ""
34594
34595 #. type: textblock
34596 #: ../src/guestfs.pod:687
34597 msgid ""
34598 "The essential problem is that ntfs-3g simply does not have enough "
34599 "information to do a correct job.  NTFS links can contain drive letters and "
34600 "references to external device GUIDs that ntfs-3g has no way of resolving.  "
34601 "It is almost certainly the case that libguestfs callers should ignore what "
34602 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
34603 msgstr ""
34604
34605 #. type: textblock
34606 #: ../src/guestfs.pod:694
34607 msgid ""
34608 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
34609 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
34610 "attribute, and read the raw reparse data from that (you can find the format "
34611 "documented in various places around the web)."
34612 msgstr ""
34613
34614 #. type: =head3
34615 #: ../src/guestfs.pod:699
34616 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
34617 msgstr ""
34618
34619 #. type: textblock
34620 #: ../src/guestfs.pod:701
34621 msgid ""
34622 "There are other useful extended attributes that can be read from ntfs-3g "
34623 "filesystems (using L</guestfs_getxattr>).  See:"
34624 msgstr ""
34625
34626 #. type: textblock
34627 #: ../src/guestfs.pod:704
34628 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
34629 msgstr ""
34630
34631 #. type: =head2
34632 #: ../src/guestfs.pod:706
34633 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
34634 msgstr ""
34635
34636 #. type: textblock
34637 #: ../src/guestfs.pod:708
34638 msgid ""
34639 "Although we don't want to discourage you from using the C API, we will "
34640 "mention here that the same API is also available in other languages."
34641 msgstr ""
34642
34643 #. type: textblock
34644 #: ../src/guestfs.pod:711
34645 msgid ""
34646 "The API is broadly identical in all supported languages.  This means that "
34647 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
34648 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
34649 "OCaml.  In other words, a straightforward, predictable isomorphism between "
34650 "each language."
34651 msgstr ""
34652
34653 #. type: textblock
34654 #: ../src/guestfs.pod:717
34655 msgid ""
34656 "Error messages are automatically transformed into exceptions if the language "
34657 "supports it."
34658 msgstr ""
34659
34660 #. type: textblock
34661 #: ../src/guestfs.pod:720
34662 msgid ""
34663 "We don't try to \"object orientify\" parts of the API in OO languages, "
34664 "although contributors are welcome to write higher level APIs above what we "
34665 "provide in their favourite languages if they wish."
34666 msgstr ""
34667
34668 #. type: =item
34669 #: ../src/guestfs.pod:726
34670 msgid "B<C++>"
34671 msgstr ""
34672
34673 #. type: textblock
34674 #: ../src/guestfs.pod:728
34675 msgid ""
34676 "You can use the I<guestfs.h> header file from C++ programs.  The C++ API is "
34677 "identical to the C API.  C++ classes and exceptions are not used."
34678 msgstr ""
34679
34680 #. type: =item
34681 #: ../src/guestfs.pod:732
34682 msgid "B<C#>"
34683 msgstr ""
34684
34685 #. type: textblock
34686 #: ../src/guestfs.pod:734
34687 msgid ""
34688 "The C# bindings are highly experimental.  Please read the warnings at the "
34689 "top of C<csharp/Libguestfs.cs>."
34690 msgstr ""
34691
34692 #. type: =item
34693 #: ../src/guestfs.pod:737
34694 msgid "B<Erlang>"
34695 msgstr ""
34696
34697 #. type: textblock
34698 #: ../src/guestfs.pod:739
34699 msgid "See L<guestfs-erlang(3)>."
34700 msgstr ""
34701
34702 #. type: =item
34703 #: ../src/guestfs.pod:741
34704 msgid "B<Haskell>"
34705 msgstr ""
34706
34707 #. type: textblock
34708 #: ../src/guestfs.pod:743
34709 msgid ""
34710 "This is the only language binding that is working but incomplete.  Only "
34711 "calls which return simple integers have been bound in Haskell, and we are "
34712 "looking for help to complete this binding."
34713 msgstr ""
34714
34715 #. type: =item
34716 #: ../src/guestfs.pod:747
34717 msgid "B<Java>"
34718 msgstr ""
34719
34720 #. type: textblock
34721 #: ../src/guestfs.pod:749
34722 msgid ""
34723 "Full documentation is contained in the Javadoc which is distributed with "
34724 "libguestfs.  For examples, see L<guestfs-java(3)>."
34725 msgstr ""
34726
34727 #. type: =item
34728 #: ../src/guestfs.pod:752
34729 msgid "B<OCaml>"
34730 msgstr ""
34731
34732 #. type: textblock
34733 #: ../src/guestfs.pod:754
34734 msgid "See L<guestfs-ocaml(3)>."
34735 msgstr ""
34736
34737 #. type: =item
34738 #: ../src/guestfs.pod:756
34739 msgid "B<Perl>"
34740 msgstr ""
34741
34742 #. type: textblock
34743 #: ../src/guestfs.pod:758
34744 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
34745 msgstr ""
34746
34747 #. type: =item
34748 #: ../src/guestfs.pod:760
34749 msgid "B<PHP>"
34750 msgstr ""
34751
34752 #. type: textblock
34753 #: ../src/guestfs.pod:762
34754 msgid ""
34755 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
34756 "the php-libguestfs package for your distribution."
34757 msgstr ""
34758
34759 #. type: textblock
34760 #: ../src/guestfs.pod:765
34761 msgid "The PHP binding only works correctly on 64 bit machines."
34762 msgstr ""
34763
34764 #. type: =item
34765 #: ../src/guestfs.pod:767
34766 msgid "B<Python>"
34767 msgstr ""
34768
34769 #. type: textblock
34770 #: ../src/guestfs.pod:769
34771 msgid "See L<guestfs-python(3)>."
34772 msgstr ""
34773
34774 #. type: =item
34775 #: ../src/guestfs.pod:771
34776 msgid "B<Ruby>"
34777 msgstr ""
34778
34779 #. type: textblock
34780 #: ../src/guestfs.pod:773
34781 msgid "See L<guestfs-ruby(3)>."
34782 msgstr ""
34783
34784 #. type: =item
34785 #: ../src/guestfs.pod:775
34786 msgid "B<shell scripts>"
34787 msgstr ""
34788
34789 #. type: textblock
34790 #: ../src/guestfs.pod:777
34791 msgid "See L<guestfish(1)>."
34792 msgstr ""
34793
34794 #. type: =head2
34795 #: ../src/guestfs.pod:781
34796 msgid "LIBGUESTFS GOTCHAS"
34797 msgstr ""
34798
34799 #. type: textblock
34800 #: ../src/guestfs.pod:783
34801 msgid ""
34802 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
34803 "system [...] that works in the way it is documented but is counterintuitive "
34804 "and almost invites mistakes.\""
34805 msgstr ""
34806
34807 #. type: textblock
34808 #: ../src/guestfs.pod:787
34809 msgid ""
34810 "Since we developed libguestfs and the associated tools, there are several "
34811 "things we would have designed differently, but are now stuck with for "
34812 "backwards compatibility or other reasons.  If there is ever a libguestfs 2.0 "
34813 "release, you can expect these to change.  Beware of them."
34814 msgstr ""
34815
34816 #. type: =item
34817 #: ../src/guestfs.pod:795
34818 msgid "Autosync / forgetting to sync."
34819 msgstr ""
34820
34821 #. type: textblock
34822 #: ../src/guestfs.pod:797
34823 msgid ""
34824 "I<Update:> Autosync is enabled by default for all API users starting from "
34825 "libguestfs 1.5.24.  This section only applies to older versions."
34826 msgstr ""
34827
34828 #. type: textblock
34829 #: ../src/guestfs.pod:800
34830 msgid ""
34831 "When modifying a filesystem from C or another language, you B<must> unmount "
34832 "all filesystems and call L</guestfs_sync> explicitly before you close the "
34833 "libguestfs handle.  You can also call:"
34834 msgstr ""
34835
34836 #. type: verbatim
34837 #: ../src/guestfs.pod:804
34838 #, no-wrap
34839 msgid ""
34840 " guestfs_set_autosync (g, 1);\n"
34841 "\n"
34842 msgstr ""
34843
34844 #. type: textblock
34845 #: ../src/guestfs.pod:806
34846 msgid ""
34847 "to have the unmount/sync done automatically for you when the handle 'g' is "
34848 "closed.  (This feature is called \"autosync\", L</guestfs_set_autosync> "
34849 "q.v.)"
34850 msgstr ""
34851
34852 #. type: textblock
34853 #: ../src/guestfs.pod:810
34854 msgid ""
34855 "If you forget to do this, then it is entirely possible that your changes "
34856 "won't be written out, or will be partially written, or (very rarely) that "
34857 "you'll get disk corruption."
34858 msgstr ""
34859
34860 #. type: textblock
34861 #: ../src/guestfs.pod:814
34862 msgid ""
34863 "Note that in L<guestfish(3)> autosync is the default.  So quick and dirty "
34864 "guestfish scripts that forget to sync will work just fine, which can make "
34865 "this very puzzling if you are trying to debug a problem."
34866 msgstr ""
34867
34868 #. type: =item
34869 #: ../src/guestfs.pod:818
34870 msgid "Mount option C<-o sync> should not be the default."
34871 msgstr ""
34872
34873 #. type: textblock
34874 #: ../src/guestfs.pod:820
34875 msgid ""
34876 "I<Update:> L</guestfs_mount> no longer adds any options starting from "
34877 "libguestfs 1.13.16.  This section only applies to older versions."
34878 msgstr ""
34879
34880 #. type: textblock
34881 #: ../src/guestfs.pod:823
34882 msgid ""
34883 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly.  "
34884 "However C<-o sync> does not add any reliability benefit, but does have a "
34885 "very large performance impact."
34886 msgstr ""
34887
34888 #. type: textblock
34889 #: ../src/guestfs.pod:827
34890 msgid ""
34891 "The work around is to use L</guestfs_mount_options> and set the mount "
34892 "options that you actually want to use."
34893 msgstr ""
34894
34895 #. type: =item
34896 #: ../src/guestfs.pod:830
34897 msgid "Read-only should be the default."
34898 msgstr ""
34899
34900 #. type: textblock
34901 #: ../src/guestfs.pod:832
34902 msgid ""
34903 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
34904 "specify I<--rw> if you want to make changes to the image."
34905 msgstr ""
34906
34907 #. type: textblock
34908 #: ../src/guestfs.pod:835
34909 msgid "This would reduce the potential to corrupt live VM images."
34910 msgstr ""
34911
34912 #. type: textblock
34913 #: ../src/guestfs.pod:837
34914 msgid ""
34915 "Note that many filesystems change the disk when you just mount and unmount, "
34916 "even if you didn't perform any writes.  You need to use "
34917 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
34918 msgstr ""
34919
34920 #. type: =item
34921 #: ../src/guestfs.pod:841
34922 msgid "guestfish command line is hard to use."
34923 msgstr ""
34924
34925 #. type: textblock
34926 #: ../src/guestfs.pod:843
34927 msgid ""
34928 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
34929 "examination).  It tries to run a guestfish command C<disk.img> which doesn't "
34930 "exist, so it fails.  In earlier versions of guestfish the error message was "
34931 "also unintuitive, but we have corrected this since.  Like the Bourne shell, "
34932 "we should have used C<guestfish -c command> to run commands."
34933 msgstr ""
34934
34935 #. type: =item
34936 #: ../src/guestfs.pod:850
34937 msgid "guestfish megabyte modifiers don't work right on all commands"
34938 msgstr ""
34939
34940 #. type: textblock
34941 #: ../src/guestfs.pod:852
34942 msgid ""
34943 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
34944 "other modifiers).  What guestfish actually does is to multiply the number "
34945 "part by the modifier part and pass the result to the C API.  However this "
34946 "doesn't work for a few APIs which aren't expecting bytes, but are already "
34947 "expecting some other unit (eg. megabytes)."
34948 msgstr ""
34949
34950 #. type: textblock
34951 #: ../src/guestfs.pod:859
34952 msgid "The most common is L</guestfs_lvcreate>.  The guestfish command:"
34953 msgstr ""
34954
34955 #. type: verbatim
34956 #: ../src/guestfs.pod:861
34957 #, no-wrap
34958 msgid ""
34959 " lvcreate LV VG 100M\n"
34960 "\n"
34961 msgstr ""
34962
34963 #. type: textblock
34964 #: ../src/guestfs.pod:863
34965 msgid ""
34966 "does not do what you might expect.  Instead because L</guestfs_lvcreate> is "
34967 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
34968 "megabytes * megabytes) logical volume.  The error message you get from this "
34969 "is also a little obscure."
34970 msgstr ""
34971
34972 #. type: textblock
34973 #: ../src/guestfs.pod:868
34974 msgid ""
34975 "This could be fixed in the generator by specially marking parameters and "
34976 "return values which take bytes or other units."
34977 msgstr ""
34978
34979 #. type: =item
34980 #: ../src/guestfs.pod:871
34981 msgid "Ambiguity between devices and paths"
34982 msgstr ""
34983
34984 #. type: textblock
34985 #: ../src/guestfs.pod:873
34986 msgid ""
34987 "There is a subtle ambiguity in the API between a device name "
34988 "(eg. C</dev/sdb2>) and a similar pathname.  A file might just happen to be "
34989 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
34990 msgstr ""
34991
34992 #. type: textblock
34993 #: ../src/guestfs.pod:878
34994 msgid ""
34995 "In the current API we usually resolve this ambiguity by having two separate "
34996 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>.  "
34997 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
34998 "detecting if the path supplied begins with C</dev/>."
34999 msgstr ""
35000
35001 #. type: textblock
35002 #: ../src/guestfs.pod:884
35003 msgid ""
35004 "To avoid both the ambiguity and the need to duplicate some calls, we could "
35005 "make paths/devices into structured names.  One way to do this would be to "
35006 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
35007 "aspect of grub.  Another way would be to use a structured type, equivalent "
35008 "to this OCaml type:"
35009 msgstr ""
35010
35011 #. type: verbatim
35012 #: ../src/guestfs.pod:890
35013 #, no-wrap
35014 msgid ""
35015 " type path = Path of string | Device of int | Partition of int * int\n"
35016 "\n"
35017 msgstr ""
35018
35019 #. type: textblock
35020 #: ../src/guestfs.pod:892
35021 msgid "which would allow you to pass arguments like:"
35022 msgstr ""
35023
35024 #. type: verbatim
35025 #: ../src/guestfs.pod:894
35026 #, no-wrap
35027 msgid ""
35028 " Path \"/foo/bar\"\n"
35029 " Device 1            (* /dev/sdb, or perhaps /dev/sda *)\n"
35030 " Partition (1, 2)    (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
35031 " Path \"/dev/sdb2\"    (* not a device *)\n"
35032 "\n"
35033 msgstr ""
35034
35035 #. type: textblock
35036 #: ../src/guestfs.pod:899
35037 msgid ""
35038 "As you can see there are still problems to resolve even with this "
35039 "representation.  Also consider how it might work in guestfish."
35040 msgstr ""
35041
35042 #. type: =head2
35043 #: ../src/guestfs.pod:904
35044 msgid "KEYS AND PASSPHRASES"
35045 msgstr ""
35046
35047 #. type: textblock
35048 #: ../src/guestfs.pod:906
35049 msgid ""
35050 "Certain libguestfs calls take a parameter that contains sensitive key "
35051 "material, passed in as a C string."
35052 msgstr ""
35053
35054 #. type: textblock
35055 #: ../src/guestfs.pod:909
35056 msgid ""
35057 "In the future we would hope to change the libguestfs implementation so that "
35058 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
35059 "swap.  However this is I<not> done at the moment, because of the complexity "
35060 "of such an implementation."
35061 msgstr ""
35062
35063 #. type: textblock
35064 #: ../src/guestfs.pod:914
35065 msgid ""
35066 "Therefore you should be aware that any key parameter you pass to libguestfs "
35067 "might end up being written out to the swap partition.  If this is a concern, "
35068 "scrub the swap partition or don't use libguestfs on encrypted devices."
35069 msgstr ""
35070
35071 #. type: =head2
35072 #: ../src/guestfs.pod:919
35073 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
35074 msgstr ""
35075
35076 #. type: textblock
35077 #: ../src/guestfs.pod:921
35078 msgid ""
35079 "All high-level libguestfs actions are synchronous.  If you want to use "
35080 "libguestfs asynchronously then you must create a thread."
35081 msgstr ""
35082
35083 #. type: textblock
35084 #: ../src/guestfs.pod:924
35085 msgid ""
35086 "Only use the handle from a single thread.  Either use the handle exclusively "
35087 "from one thread, or provide your own mutex so that two threads cannot issue "
35088 "calls on the same handle at the same time."
35089 msgstr ""
35090
35091 #. type: textblock
35092 #: ../src/guestfs.pod:928
35093 msgid ""
35094 "See the graphical program guestfs-browser for one possible architecture for "
35095 "multithreaded programs using libvirt and libguestfs."
35096 msgstr ""
35097
35098 #. type: =head2
35099 #: ../src/guestfs.pod:931
35100 msgid "PATH"
35101 msgstr ""
35102
35103 #. type: textblock
35104 #: ../src/guestfs.pod:933
35105 msgid ""
35106 "Libguestfs needs a supermin appliance, which it finds by looking along an "
35107 "internal path."
35108 msgstr ""
35109
35110 #. type: textblock
35111 #: ../src/guestfs.pod:936
35112 msgid ""
35113 "By default it looks for these in the directory C<$libdir/guestfs> "
35114 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
35115 msgstr ""
35116
35117 #. type: textblock
35118 #: ../src/guestfs.pod:939
35119 msgid ""
35120 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
35121 "to change the directories that libguestfs will search in.  The value is a "
35122 "colon-separated list of paths.  The current directory is I<not> searched "
35123 "unless the path contains an empty element or C<.>.  For example "
35124 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
35125 "then C</usr/lib/guestfs>."
35126 msgstr ""
35127
35128 #. type: =head2
35129 #: ../src/guestfs.pod:946
35130 msgid "QEMU WRAPPERS"
35131 msgstr ""
35132
35133 #. type: textblock
35134 #: ../src/guestfs.pod:948
35135 msgid ""
35136 "If you want to compile your own qemu, run qemu from a non-standard location, "
35137 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
35138 "around qemu."
35139 msgstr ""
35140
35141 #. type: textblock
35142 #: ../src/guestfs.pod:952
35143 msgid ""
35144 "There is one important rule to remember: you I<must C<exec qemu>> as the "
35145 "last command in the shell script (so that qemu replaces the shell and "
35146 "becomes the direct child of the libguestfs-using program).  If you don't do "
35147 "this, then the qemu process won't be cleaned up correctly."
35148 msgstr ""
35149
35150 #. type: textblock
35151 #: ../src/guestfs.pod:957
35152 msgid ""
35153 "Here is an example of a wrapper, where I have built my own copy of qemu from "
35154 "source:"
35155 msgstr ""
35156
35157 #. type: verbatim
35158 #: ../src/guestfs.pod:960
35159 #, no-wrap
35160 msgid ""
35161 " #!/bin/sh -\n"
35162 " qemudir=/home/rjones/d/qemu\n"
35163 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
35164 "\"$@\"\n"
35165 "\n"
35166 msgstr ""
35167
35168 #. type: textblock
35169 #: ../src/guestfs.pod:964
35170 msgid ""
35171 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
35172 "then use it by setting the LIBGUESTFS_QEMU environment variable.  For "
35173 "example:"
35174 msgstr ""
35175
35176 #. type: verbatim
35177 #: ../src/guestfs.pod:968
35178 #, no-wrap
35179 msgid ""
35180 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
35181 "\n"
35182 msgstr ""
35183
35184 #. type: textblock
35185 #: ../src/guestfs.pod:970
35186 msgid ""
35187 "Note that libguestfs also calls qemu with the -help and -version options in "
35188 "order to determine features."
35189 msgstr ""
35190
35191 #. type: textblock
35192 #: ../src/guestfs.pod:973
35193 msgid ""
35194 "Wrappers can also be used to edit the options passed to qemu.  In the "
35195 "following example, the C<-machine ...> option (C<-machine> and the following "
35196 "argument) are removed from the command line and replaced with C<-machine "
35197 "pc,accel=tcg>.  The while loop iterates over the options until it finds the "
35198 "right one to remove, putting the remaining options into the C<args> array."
35199 msgstr ""
35200
35201 #. type: verbatim
35202 #: ../src/guestfs.pod:982
35203 #, no-wrap
35204 msgid ""
35205 " i=0\n"
35206 " while [ $# -gt 0 ]; do\n"
35207 "     case \"$1\" in\n"
35208 "     -machine)\n"
35209 "         shift 2;;\n"
35210 "     *)\n"
35211 "         args[i]=\"$1\"\n"
35212 "         (( i++ ))\n"
35213 "         shift ;;\n"
35214 "     esac\n"
35215 " done\n"
35216 " \n"
35217 msgstr ""
35218
35219 #. type: verbatim
35220 #: ../src/guestfs.pod:994
35221 #, no-wrap
35222 msgid ""
35223 " exec qemu-kvm -machine pc,accel=tcg \"${args[@]}\"\n"
35224 "\n"
35225 msgstr ""
35226
35227 #. type: =head2
35228 #: ../src/guestfs.pod:996
35229 msgid "ATTACHING TO RUNNING DAEMONS"
35230 msgstr ""
35231
35232 #. type: textblock
35233 #: ../src/guestfs.pod:998
35234 msgid ""
35235 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
35236 "babies.  Use with caution."
35237 msgstr ""
35238
35239 #. type: textblock
35240 #: ../src/guestfs.pod:1001
35241 msgid ""
35242 "I<Note (2):> This section explains how to attach to a running daemon from a "
35243 "low level perspective.  For most users, simply using virt tools such as "
35244 "L<guestfish(1)> with the I<--live> option will \"just work\"."
35245 msgstr ""
35246
35247 #. type: =head3
35248 #: ../src/guestfs.pod:1005
35249 msgid "Using guestfs_set_attach_method"
35250 msgstr ""
35251
35252 #. type: textblock
35253 #: ../src/guestfs.pod:1007
35254 msgid ""
35255 "By calling L</guestfs_set_attach_method> you can change how the library "
35256 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read "
35257 "L</ARCHITECTURE> for some background)."
35258 msgstr ""
35259
35260 #. type: textblock
35261 #: ../src/guestfs.pod:1011
35262 msgid ""
35263 "The normal attach method is C<appliance>, where a small appliance is created "
35264 "containing the daemon, and then the library connects to this."
35265 msgstr ""
35266
35267 #. type: textblock
35268 #: ../src/guestfs.pod:1014
35269 msgid ""
35270 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
35271 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
35272 "daemon over the Unix domain socket."
35273 msgstr ""
35274
35275 #. type: textblock
35276 #: ../src/guestfs.pod:1018
35277 msgid ""
35278 "The normal use for this is to connect to a running virtual machine that "
35279 "contains a C<guestfsd> daemon, and send commands so you can read and write "
35280 "files inside the live virtual machine."
35281 msgstr ""
35282
35283 #. type: =head3
35284 #: ../src/guestfs.pod:1022
35285 msgid "Using guestfs_add_domain with live flag"
35286 msgstr ""
35287
35288 #. type: textblock
35289 #: ../src/guestfs.pod:1024
35290 msgid ""
35291 "L</guestfs_add_domain> provides some help for getting the correct attach "
35292 "method.  If you pass the C<live> option to this function, then (if the "
35293 "virtual machine is running) it will examine the libvirt XML looking for a "
35294 "virtio-serial channel to connect to:"
35295 msgstr ""
35296
35297 #. type: verbatim
35298 #: ../src/guestfs.pod:1030
35299 #, no-wrap
35300 msgid ""
35301 " <domain>\n"
35302 "   ...\n"
35303 "   <devices>\n"
35304 "     ...\n"
35305 "     <channel type='unix'>\n"
35306 "       <source mode='bind' path='/path/to/socket'/>\n"
35307 "       <target type='virtio' name='org.libguestfs.channel.0'/>\n"
35308 "     </channel>\n"
35309 "     ...\n"
35310 "   </devices>\n"
35311 " </domain>\n"
35312 "\n"
35313 msgstr ""
35314
35315 #. type: textblock
35316 #: ../src/guestfs.pod:1042
35317 msgid ""
35318 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
35319 "method to C<unix:/path/to/socket>."
35320 msgstr ""
35321
35322 #. type: textblock
35323 #: ../src/guestfs.pod:1045
35324 msgid ""
35325 "Some of the libguestfs tools (including guestfish) support a I<--live> "
35326 "option which is passed through to L</guestfs_add_domain> thus allowing you "
35327 "to attach to and modify live virtual machines."
35328 msgstr ""
35329
35330 #. type: textblock
35331 #: ../src/guestfs.pod:1049
35332 msgid ""
35333 "The virtual machine needs to have been set up beforehand so that it has the "
35334 "virtio-serial channel and so that guestfsd is running inside it."
35335 msgstr ""
35336
35337 #. type: =head2
35338 #: ../src/guestfs.pod:1053
35339 msgid "ABI GUARANTEE"
35340 msgstr ""
35341
35342 #. type: textblock
35343 #: ../src/guestfs.pod:1055
35344 msgid ""
35345 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
35346 "actions as outlined in this section.  Although we will deprecate some "
35347 "actions, for example if they get replaced by newer calls, we will keep the "
35348 "old actions forever.  This allows you the developer to program in confidence "
35349 "against the libguestfs API."
35350 msgstr ""
35351
35352 #. type: =head2
35353 #: ../src/guestfs.pod:1061
35354 msgid "BLOCK DEVICE NAMING"
35355 msgstr ""
35356
35357 #. type: textblock
35358 #: ../src/guestfs.pod:1063
35359 msgid ""
35360 "In the kernel there is now quite a profusion of schemata for naming block "
35361 "devices (in this context, by I<block device> I mean a physical or virtual "
35362 "hard drive).  The original Linux IDE driver used names starting with "
35363 "C</dev/hd*>.  SCSI devices have historically used a different naming scheme, "
35364 "C</dev/sd*>.  When the Linux kernel I<libata> driver became a popular "
35365 "replacement for the old IDE driver (particularly for SATA devices) those "
35366 "devices also used the C</dev/sd*> scheme.  Additionally we now have virtual "
35367 "machines with paravirtualized drivers.  This has created several different "
35368 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
35369 "Xen PV disks."
35370 msgstr ""
35371
35372 #. type: textblock
35373 #: ../src/guestfs.pod:1075
35374 msgid ""
35375 "As discussed above, libguestfs uses a qemu appliance running an embedded "
35376 "Linux kernel to access block devices.  We can run a variety of appliances "
35377 "based on a variety of Linux kernels."
35378 msgstr ""
35379
35380 #. type: textblock
35381 #: ../src/guestfs.pod:1079
35382 msgid ""
35383 "This causes a problem for libguestfs because many API calls use device or "
35384 "partition names.  Working scripts and the recipe (example) scripts that we "
35385 "make available over the internet could fail if the naming scheme changes."
35386 msgstr ""
35387
35388 #. type: textblock
35389 #: ../src/guestfs.pod:1084
35390 msgid ""
35391 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>.  "
35392 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
35393 "required.  For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
35394 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
35395 msgstr ""
35396
35397 #. type: textblock
35398 #: ../src/guestfs.pod:1090
35399 msgid ""
35400 "Note that this I<only> applies to parameters.  The L</guestfs_list_devices>, "
35401 "L</guestfs_list_partitions> and similar calls return the true names of the "
35402 "devices and partitions as known to the appliance."
35403 msgstr ""
35404
35405 #. type: =head3
35406 #: ../src/guestfs.pod:1095
35407 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
35408 msgstr ""
35409
35410 #. type: textblock
35411 #: ../src/guestfs.pod:1097
35412 msgid ""
35413 "Usually this translation is transparent.  However in some (very rare)  cases "
35414 "you may need to know the exact algorithm.  Such cases include where you use "
35415 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
35416 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
35417 "devices."
35418 msgstr ""
35419
35420 #. type: textblock
35421 #: ../src/guestfs.pod:1103
35422 msgid ""
35423 "The algorithm is applied only to I<parameters> which are known to be either "
35424 "device or partition names.  Return values from functions such as "
35425 "L</guestfs_list_devices> are never changed."
35426 msgstr ""
35427
35428 #. type: textblock
35429 #: ../src/guestfs.pod:1111
35430 msgid "Is the string a parameter which is a device or partition name?"
35431 msgstr ""
35432
35433 #. type: textblock
35434 #: ../src/guestfs.pod:1115
35435 msgid "Does the string begin with C</dev/sd>?"
35436 msgstr ""
35437
35438 #. type: textblock
35439 #: ../src/guestfs.pod:1119
35440 msgid ""
35441 "Does the named device exist? If so, we use that device.  However if I<not> "
35442 "then we continue with this algorithm."
35443 msgstr ""
35444
35445 #. type: textblock
35446 #: ../src/guestfs.pod:1124
35447 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
35448 msgstr ""
35449
35450 #. type: textblock
35451 #: ../src/guestfs.pod:1126
35452 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
35453 msgstr ""
35454
35455 #. type: textblock
35456 #: ../src/guestfs.pod:1128
35457 msgid "If that named device exists, use it.  If not, continue."
35458 msgstr ""
35459
35460 #. type: textblock
35461 #: ../src/guestfs.pod:1132
35462 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
35463 msgstr ""
35464
35465 #. type: textblock
35466 #: ../src/guestfs.pod:1134
35467 msgid "If that named device exists, use it.  If not, return an error."
35468 msgstr ""
35469
35470 #. type: =head3
35471 #: ../src/guestfs.pod:1138
35472 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
35473 msgstr ""
35474
35475 #. type: textblock
35476 #: ../src/guestfs.pod:1140
35477 msgid ""
35478 "Although the standard naming scheme and automatic translation is useful for "
35479 "simple programs and guestfish scripts, for larger programs it is best not to "
35480 "rely on this mechanism."
35481 msgstr ""
35482
35483 #. type: textblock
35484 #: ../src/guestfs.pod:1144
35485 msgid ""
35486 "Where possible for maximum future portability programs using libguestfs "
35487 "should use these future-proof techniques:"
35488 msgstr ""
35489
35490 #. type: textblock
35491 #: ../src/guestfs.pod:1151
35492 msgid ""
35493 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
35494 "device names, and then use those names directly."
35495 msgstr ""
35496
35497 #. type: textblock
35498 #: ../src/guestfs.pod:1154
35499 msgid "Since those device names exist by definition, they will never be translated."
35500 msgstr ""
35501
35502 #. type: textblock
35503 #: ../src/guestfs.pod:1159
35504 msgid ""
35505 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
35506 "filesystem labels."
35507 msgstr ""
35508
35509 #. type: textblock
35510 #: ../src/guestfs.pod:1166
35511 msgid ""
35512 "This section discusses security implications of using libguestfs, "
35513 "particularly with untrusted or malicious guests or disk images."
35514 msgstr ""
35515
35516 #. type: =head2
35517 #: ../src/guestfs.pod:1169
35518 msgid "GENERAL SECURITY CONSIDERATIONS"
35519 msgstr ""
35520
35521 #. type: textblock
35522 #: ../src/guestfs.pod:1171
35523 msgid ""
35524 "Be careful with any files or data that you download from a guest (by "
35525 "\"download\" we mean not just the L</guestfs_download> command but any "
35526 "command that reads files, filenames, directories or anything else from a "
35527 "disk image).  An attacker could manipulate the data to fool your program "
35528 "into doing the wrong thing.  Consider cases such as:"
35529 msgstr ""
35530
35531 #. type: textblock
35532 #: ../src/guestfs.pod:1181
35533 msgid "the data (file etc) not being present"
35534 msgstr ""
35535
35536 #. type: textblock
35537 #: ../src/guestfs.pod:1185
35538 msgid "being present but empty"
35539 msgstr ""
35540
35541 #. type: textblock
35542 #: ../src/guestfs.pod:1189
35543 msgid "being much larger than normal"
35544 msgstr ""
35545
35546 #. type: textblock
35547 #: ../src/guestfs.pod:1193
35548 msgid "containing arbitrary 8 bit data"
35549 msgstr ""
35550
35551 #. type: textblock
35552 #: ../src/guestfs.pod:1197
35553 msgid "being in an unexpected character encoding"
35554 msgstr ""
35555
35556 #. type: textblock
35557 #: ../src/guestfs.pod:1201
35558 msgid "containing homoglyphs."
35559 msgstr ""
35560
35561 #. type: =head2
35562 #: ../src/guestfs.pod:1205
35563 msgid "SECURITY OF MOUNTING FILESYSTEMS"
35564 msgstr ""
35565
35566 #. type: textblock
35567 #: ../src/guestfs.pod:1207
35568 msgid ""
35569 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
35570 "(VFS) module can sometimes be escalated into exploits by deliberately "
35571 "creating a malicious, malformed filesystem.  These exploits are very severe "
35572 "for two reasons.  Firstly there are very many filesystem drivers in the "
35573 "kernel, and many of them are infrequently used and not much developer "
35574 "attention has been paid to the code.  Linux userspace helps potential "
35575 "crackers by detecting the filesystem type and automatically choosing the "
35576 "right VFS driver, even if that filesystem type is obscure or unexpected for "
35577 "the administrator.  Secondly, a kernel-level exploit is like a local root "
35578 "exploit (worse in some ways), giving immediate and total access to the "
35579 "system right down to the hardware level."
35580 msgstr ""
35581
35582 #. type: textblock
35583 #: ../src/guestfs.pod:1220
35584 msgid ""
35585 "That explains why you should never mount a filesystem from an untrusted "
35586 "guest on your host kernel.  How about libguestfs? We run a Linux kernel "
35587 "inside a qemu virtual machine, usually running as a non-root user.  The "
35588 "attacker would need to write a filesystem which first exploited the kernel, "
35589 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
35590 "the libguestfs protocol, and finally to be as serious as the host kernel "
35591 "exploit it would need to escalate its privileges to root.  This multi-step "
35592 "escalation, performed by a static piece of data, is thought to be extremely "
35593 "hard to do, although we never say 'never' about security issues."
35594 msgstr ""
35595
35596 #. type: textblock
35597 #: ../src/guestfs.pod:1231
35598 msgid ""
35599 "In any case callers can reduce the attack surface by forcing the filesystem "
35600 "type when mounting (use L</guestfs_mount_vfs>)."
35601 msgstr ""
35602
35603 #. type: =head2
35604 #: ../src/guestfs.pod:1234
35605 msgid "PROTOCOL SECURITY"
35606 msgstr ""
35607
35608 #. type: textblock
35609 #: ../src/guestfs.pod:1236
35610 msgid ""
35611 "The protocol is designed to be secure, being based on RFC 4506 (XDR)  with a "
35612 "defined upper message size.  However a program that uses libguestfs must "
35613 "also take care - for example you can write a program that downloads a binary "
35614 "from a disk image and executes it locally, and no amount of protocol "
35615 "security will save you from the consequences."
35616 msgstr ""
35617
35618 #. type: =head2
35619 #: ../src/guestfs.pod:1242
35620 msgid "INSPECTION SECURITY"
35621 msgstr ""
35622
35623 #. type: textblock
35624 #: ../src/guestfs.pod:1244
35625 msgid ""
35626 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
35627 "directly from the guest, and these could contain any 8 bit data.  Callers "
35628 "should be careful to escape these before printing them to a structured file "
35629 "(for example, use HTML escaping if creating a web page)."
35630 msgstr ""
35631
35632 #. type: textblock
35633 #: ../src/guestfs.pod:1250
35634 msgid ""
35635 "Guest configuration may be altered in unusual ways by the administrator of "
35636 "the virtual machine, and may not reflect reality (particularly for untrusted "
35637 "or actively malicious guests).  For example we parse the hostname from "
35638 "configuration files like C</etc/sysconfig/network> that we find in the "
35639 "guest, but the guest administrator can easily manipulate these files to "
35640 "provide the wrong hostname."
35641 msgstr ""
35642
35643 #. type: textblock
35644 #: ../src/guestfs.pod:1258
35645 msgid ""
35646 "The inspection API parses guest configuration using two external libraries: "
35647 "Augeas (Linux configuration) and hivex (Windows Registry).  Both are "
35648 "designed to be robust in the face of malicious data, although denial of "
35649 "service attacks are still possible, for example with oversized configuration "
35650 "files."
35651 msgstr ""
35652
35653 #. type: =head2
35654 #: ../src/guestfs.pod:1264
35655 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
35656 msgstr ""
35657
35658 #. type: textblock
35659 #: ../src/guestfs.pod:1266
35660 msgid ""
35661 "Be very cautious about running commands from the guest.  By running a "
35662 "command in the guest, you are giving CPU time to a binary that you do not "
35663 "control, under the same user account as the library, albeit wrapped in qemu "
35664 "virtualization.  More information and alternatives can be found in the "
35665 "section L</RUNNING COMMANDS>."
35666 msgstr ""
35667
35668 #. type: =head2
35669 #: ../src/guestfs.pod:1272
35670 msgid "CVE-2010-3851"
35671 msgstr ""
35672
35673 #. type: textblock
35674 #: ../src/guestfs.pod:1274
35675 msgid "https://bugzilla.redhat.com/642934"
35676 msgstr ""
35677
35678 #. type: textblock
35679 #: ../src/guestfs.pod:1276
35680 msgid ""
35681 "This security bug concerns the automatic disk format detection that qemu "
35682 "does on disk images."
35683 msgstr ""
35684
35685 #. type: textblock
35686 #: ../src/guestfs.pod:1279
35687 msgid ""
35688 "A raw disk image is just the raw bytes, there is no header.  Other disk "
35689 "images like qcow2 contain a special header.  Qemu deals with this by looking "
35690 "for one of the known headers, and if none is found then assuming the disk "
35691 "image must be raw."
35692 msgstr ""
35693
35694 #. type: textblock
35695 #: ../src/guestfs.pod:1284
35696 msgid ""
35697 "This allows a guest which has been given a raw disk image to write some "
35698 "other header.  At next boot (or when the disk image is accessed by "
35699 "libguestfs) qemu would do autodetection and think the disk image format was, "
35700 "say, qcow2 based on the header written by the guest."
35701 msgstr ""
35702
35703 #. type: textblock
35704 #: ../src/guestfs.pod:1289
35705 msgid ""
35706 "This in itself would not be a problem, but qcow2 offers many features, one "
35707 "of which is to allow a disk image to refer to another image (called the "
35708 "\"backing disk\").  It does this by placing the path to the backing disk "
35709 "into the qcow2 header.  This path is not validated and could point to any "
35710 "host file (eg. \"/etc/passwd\").  The backing disk is then exposed through "
35711 "\"holes\" in the qcow2 disk image, which of course is completely under the "
35712 "control of the attacker."
35713 msgstr ""
35714
35715 #. type: textblock
35716 #: ../src/guestfs.pod:1297
35717 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
35718 msgstr ""
35719
35720 #. type: textblock
35721 #: ../src/guestfs.pod:1304
35722 msgid "You have enabled the network or have opened the disk in write mode."
35723 msgstr ""
35724
35725 #. type: textblock
35726 #: ../src/guestfs.pod:1308
35727 msgid ""
35728 "You are also running untrusted code from the guest (see L</RUNNING "
35729 "COMMANDS>)."
35730 msgstr ""
35731
35732 #. type: textblock
35733 #: ../src/guestfs.pod:1313
35734 msgid ""
35735 "The way to avoid this is to specify the expected disk format when adding "
35736 "disks (the optional C<format> option to L</guestfs_add_drive_opts>).  You "
35737 "should always do this if the disk is raw format, and it's a good idea for "
35738 "other cases too."
35739 msgstr ""
35740
35741 #. type: textblock
35742 #: ../src/guestfs.pod:1318
35743 msgid ""
35744 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
35745 "format is fetched from libvirt and passed through."
35746 msgstr ""
35747
35748 #. type: textblock
35749 #: ../src/guestfs.pod:1321
35750 msgid ""
35751 "For libguestfs tools, use the I<--format> command line parameter as "
35752 "appropriate."
35753 msgstr ""
35754
35755 #. type: =head1
35756 #: ../src/guestfs.pod:1324
35757 msgid "CONNECTION MANAGEMENT"
35758 msgstr ""
35759
35760 #. type: =head2
35761 #: ../src/guestfs.pod:1326
35762 msgid "guestfs_h *"
35763 msgstr ""
35764
35765 #. type: textblock
35766 #: ../src/guestfs.pod:1328
35767 msgid ""
35768 "C<guestfs_h> is the opaque type representing a connection handle.  Create a "
35769 "handle by calling L</guestfs_create>.  Call L</guestfs_close> to free the "
35770 "handle and release all resources used."
35771 msgstr ""
35772
35773 #. type: textblock
35774 #: ../src/guestfs.pod:1332
35775 msgid ""
35776 "For information on using multiple handles and threads, see the section "
35777 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> above."
35778 msgstr ""
35779
35780 #. type: =head2
35781 #: ../src/guestfs.pod:1335
35782 msgid "guestfs_create"
35783 msgstr ""
35784
35785 #. type: verbatim
35786 #: ../src/guestfs.pod:1337
35787 #, no-wrap
35788 msgid ""
35789 " guestfs_h *guestfs_create (void);\n"
35790 "\n"
35791 msgstr ""
35792
35793 #. type: textblock
35794 #: ../src/guestfs.pod:1339
35795 msgid "Create a connection handle."
35796 msgstr ""
35797
35798 #. type: textblock
35799 #: ../src/guestfs.pod:1341
35800 msgid ""
35801 "On success this returns a non-NULL pointer to a handle.  On error it returns "
35802 "NULL."
35803 msgstr ""
35804
35805 #. type: textblock
35806 #: ../src/guestfs.pod:1344
35807 msgid ""
35808 "You have to \"configure\" the handle after creating it.  This includes "
35809 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
35810 "handle at least once."
35811 msgstr ""
35812
35813 #. type: textblock
35814 #: ../src/guestfs.pod:1348
35815 msgid "After configuring the handle, you have to call L</guestfs_launch>."
35816 msgstr ""
35817
35818 #. type: textblock
35819 #: ../src/guestfs.pod:1350
35820 msgid ""
35821 "You may also want to configure error handling for the handle.  See the "
35822 "L</ERROR HANDLING> section below."
35823 msgstr ""
35824
35825 #. type: =head2
35826 #: ../src/guestfs.pod:1353
35827 msgid "guestfs_close"
35828 msgstr ""
35829
35830 #. type: verbatim
35831 #: ../src/guestfs.pod:1355
35832 #, no-wrap
35833 msgid ""
35834 " void guestfs_close (guestfs_h *g);\n"
35835 "\n"
35836 msgstr ""
35837
35838 #. type: textblock
35839 #: ../src/guestfs.pod:1357
35840 msgid "This closes the connection handle and frees up all resources used."
35841 msgstr ""
35842
35843 #. type: textblock
35844 #: ../src/guestfs.pod:1359
35845 msgid ""
35846 "If autosync was set on the handle and the handle was launched, then this "
35847 "implicitly calls various functions to unmount filesystems and sync the "
35848 "disk.  See L</guestfs_set_autosync> for more details."
35849 msgstr ""
35850
35851 #. type: textblock
35852 #: ../src/guestfs.pod:1363
35853 msgid "If a close callback was set on the handle, then it is called."
35854 msgstr ""
35855
35856 #. type: =head1
35857 #: ../src/guestfs.pod:1365
35858 msgid "ERROR HANDLING"
35859 msgstr ""
35860
35861 #. type: textblock
35862 #: ../src/guestfs.pod:1367
35863 msgid ""
35864 "API functions can return errors.  For example, almost all functions that "
35865 "return C<int> will return C<-1> to indicate an error."
35866 msgstr ""
35867
35868 #. type: textblock
35869 #: ../src/guestfs.pod:1370
35870 msgid ""
35871 "Additional information is available for errors: an error message string and "
35872 "optionally an error number (errno) if the thing that failed was a system "
35873 "call."
35874 msgstr ""
35875
35876 #. type: textblock
35877 #: ../src/guestfs.pod:1374
35878 msgid ""
35879 "You can get at the additional information about the last error on the handle "
35880 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
35881 "up an error handler with L</guestfs_set_error_handler>."
35882 msgstr ""
35883
35884 #. type: textblock
35885 #: ../src/guestfs.pod:1379
35886 msgid ""
35887 "When the handle is created, a default error handler is installed which "
35888 "prints the error message string to C<stderr>.  For small short-running "
35889 "command line programs it is sufficient to do:"
35890 msgstr ""
35891
35892 #. type: verbatim
35893 #: ../src/guestfs.pod:1383
35894 #, no-wrap
35895 msgid ""
35896 " if (guestfs_launch (g) == -1)\n"
35897 "   exit (EXIT_FAILURE);\n"
35898 "\n"
35899 msgstr ""
35900
35901 #. type: textblock
35902 #: ../src/guestfs.pod:1386
35903 msgid ""
35904 "since the default error handler will ensure that an error message has been "
35905 "printed to C<stderr> before the program exits."
35906 msgstr ""
35907
35908 #. type: textblock
35909 #: ../src/guestfs.pod:1389
35910 msgid ""
35911 "For other programs the caller will almost certainly want to install an "
35912 "alternate error handler or do error handling in-line like this:"
35913 msgstr ""
35914
35915 #. type: verbatim
35916 #: ../src/guestfs.pod:1392
35917 #, no-wrap
35918 msgid ""
35919 " /* This disables the default behaviour of printing errors\n"
35920 "    on stderr. */\n"
35921 " guestfs_set_error_handler (g, NULL, NULL);\n"
35922 " \n"
35923 msgstr ""
35924
35925 #. type: verbatim
35926 #: ../src/guestfs.pod:1396
35927 #, no-wrap
35928 msgid ""
35929 " if (guestfs_launch (g) == -1) {\n"
35930 "   /* Examine the error message and print it etc. */\n"
35931 "   char *msg = guestfs_last_error (g);\n"
35932 "   int errnum = guestfs_last_errno (g);\n"
35933 "   fprintf (stderr, \"%s\", msg);\n"
35934 "   if (errnum != 0)\n"
35935 "     fprintf (stderr, \": %s\", strerror (errnum));\n"
35936 "   fprintf (stderr, \"\\n\");\n"
35937 "   /* ... */\n"
35938 " }\n"
35939 "\n"
35940 msgstr ""
35941
35942 #. type: textblock
35943 #: ../src/guestfs.pod:1407
35944 msgid ""
35945 "Out of memory errors are handled differently.  The default action is to call "
35946 "L<abort(3)>.  If this is undesirable, then you can set a handler using "
35947 "L</guestfs_set_out_of_memory_handler>."
35948 msgstr ""
35949
35950 #. type: textblock
35951 #: ../src/guestfs.pod:1411
35952 msgid ""
35953 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
35954 "because there is no handle if this happens there is no way to get additional "
35955 "error information.  However L</guestfs_create> is supposed to be a "
35956 "lightweight operation which can only fail because of insufficient memory (it "
35957 "returns NULL in this case)."
35958 msgstr ""
35959
35960 #. type: =head2
35961 #: ../src/guestfs.pod:1417
35962 msgid "guestfs_last_error"
35963 msgstr ""
35964
35965 #. type: verbatim
35966 #: ../src/guestfs.pod:1419
35967 #, no-wrap
35968 msgid ""
35969 " const char *guestfs_last_error (guestfs_h *g);\n"
35970 "\n"
35971 msgstr ""
35972
35973 #. type: textblock
35974 #: ../src/guestfs.pod:1421
35975 msgid ""
35976 "This returns the last error message that happened on C<g>.  If there has not "
35977 "been an error since the handle was created, then this returns C<NULL>."
35978 msgstr ""
35979
35980 #. type: textblock
35981 #: ../src/guestfs.pod:1425
35982 msgid ""
35983 "The lifetime of the returned string is until the next error occurs, or "
35984 "L</guestfs_close> is called."
35985 msgstr ""
35986
35987 #. type: =head2
35988 #: ../src/guestfs.pod:1428
35989 msgid "guestfs_last_errno"
35990 msgstr ""
35991
35992 #. type: verbatim
35993 #: ../src/guestfs.pod:1430
35994 #, no-wrap
35995 msgid ""
35996 " int guestfs_last_errno (guestfs_h *g);\n"
35997 "\n"
35998 msgstr ""
35999
36000 #. type: textblock
36001 #: ../src/guestfs.pod:1432
36002 msgid "This returns the last error number (errno) that happened on C<g>."
36003 msgstr ""
36004
36005 #. type: textblock
36006 #: ../src/guestfs.pod:1434
36007 msgid "If successful, an errno integer not equal to zero is returned."
36008 msgstr ""
36009
36010 #. type: textblock
36011 #: ../src/guestfs.pod:1436
36012 msgid "If no error, this returns 0.  This call can return 0 in three situations:"
36013 msgstr ""
36014
36015 #. type: textblock
36016 #: ../src/guestfs.pod:1443
36017 msgid "There has not been any error on the handle."
36018 msgstr ""
36019
36020 #. type: textblock
36021 #: ../src/guestfs.pod:1447
36022 msgid ""
36023 "There has been an error but the errno was meaningless.  This corresponds to "
36024 "the case where the error did not come from a failed system call, but for "
36025 "some other reason."
36026 msgstr ""
36027
36028 #. type: textblock
36029 #: ../src/guestfs.pod:1453
36030 msgid ""
36031 "There was an error from a failed system call, but for some reason the errno "
36032 "was not captured and returned.  This usually indicates a bug in libguestfs."
36033 msgstr ""
36034
36035 #. type: textblock
36036 #: ../src/guestfs.pod:1459
36037 msgid ""
36038 "Libguestfs tries to convert the errno from inside the applicance into a "
36039 "corresponding errno for the caller (not entirely trivial: the appliance "
36040 "might be running a completely different operating system from the library "
36041 "and error numbers are not standardized across Un*xen).  If this could not be "
36042 "done, then the error is translated to C<EINVAL>.  In practice this should "
36043 "only happen in very rare circumstances."
36044 msgstr ""
36045
36046 #. type: =head2
36047 #: ../src/guestfs.pod:1467
36048 msgid "guestfs_set_error_handler"
36049 msgstr ""
36050
36051 #. type: verbatim
36052 #: ../src/guestfs.pod:1469
36053 #, no-wrap
36054 msgid ""
36055 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
36056 "                                           void *opaque,\n"
36057 "                                           const char *msg);\n"
36058 " void guestfs_set_error_handler (guestfs_h *g,\n"
36059 "                                 guestfs_error_handler_cb cb,\n"
36060 "                                 void *opaque);\n"
36061 "\n"
36062 msgstr ""
36063
36064 #. type: textblock
36065 #: ../src/guestfs.pod:1476
36066 msgid ""
36067 "The callback C<cb> will be called if there is an error.  The parameters "
36068 "passed to the callback are an opaque data pointer and the error message "
36069 "string."
36070 msgstr ""
36071
36072 #. type: textblock
36073 #: ../src/guestfs.pod:1480
36074 msgid ""
36075 "C<errno> is not passed to the callback.  To get that the callback must call "
36076 "L</guestfs_last_errno>."
36077 msgstr ""
36078
36079 #. type: textblock
36080 #: ../src/guestfs.pod:1483
36081 msgid ""
36082 "Note that the message string C<msg> is freed as soon as the callback "
36083 "function returns, so if you want to stash it somewhere you must make your "
36084 "own copy."
36085 msgstr ""
36086
36087 #. type: textblock
36088 #: ../src/guestfs.pod:1487
36089 msgid "The default handler prints messages on C<stderr>."
36090 msgstr ""
36091
36092 #. type: textblock
36093 #: ../src/guestfs.pod:1489
36094 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
36095 msgstr ""
36096
36097 #. type: =head2
36098 #: ../src/guestfs.pod:1491
36099 msgid "guestfs_get_error_handler"
36100 msgstr ""
36101
36102 #. type: verbatim
36103 #: ../src/guestfs.pod:1493
36104 #, no-wrap
36105 msgid ""
36106 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
36107 "                                                     void **opaque_rtn);\n"
36108 "\n"
36109 msgstr ""
36110
36111 #. type: textblock
36112 #: ../src/guestfs.pod:1496
36113 msgid "Returns the current error handler callback."
36114 msgstr ""
36115
36116 #. type: =head2
36117 #: ../src/guestfs.pod:1498
36118 msgid "guestfs_set_out_of_memory_handler"
36119 msgstr ""
36120
36121 #. type: verbatim
36122 #: ../src/guestfs.pod:1500
36123 #, no-wrap
36124 msgid ""
36125 " typedef void (*guestfs_abort_cb) (void);\n"
36126 " void guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
36127 "                                         guestfs_abort_cb);\n"
36128 "\n"
36129 msgstr ""
36130
36131 #. type: textblock
36132 #: ../src/guestfs.pod:1504
36133 msgid ""
36134 "The callback C<cb> will be called if there is an out of memory situation.  "
36135 "I<Note this callback must not return>."
36136 msgstr ""
36137
36138 #. type: textblock
36139 #: ../src/guestfs.pod:1507
36140 msgid "The default is to call L<abort(3)>."
36141 msgstr ""
36142
36143 #. type: textblock
36144 #: ../src/guestfs.pod:1509
36145 msgid "You cannot set C<cb> to C<NULL>.  You can't ignore out of memory situations."
36146 msgstr ""
36147
36148 #. type: =head2
36149 #: ../src/guestfs.pod:1512
36150 msgid "guestfs_get_out_of_memory_handler"
36151 msgstr ""
36152
36153 #. type: verbatim
36154 #: ../src/guestfs.pod:1514
36155 #, no-wrap
36156 msgid ""
36157 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
36158 "\n"
36159 msgstr ""
36160
36161 #. type: textblock
36162 #: ../src/guestfs.pod:1516
36163 msgid "This returns the current out of memory handler."
36164 msgstr ""
36165
36166 #. type: =head1
36167 #: ../src/guestfs.pod:1518
36168 msgid "API CALLS"
36169 msgstr ""
36170
36171 #. type: =head1
36172 #: ../src/guestfs.pod:1522
36173 msgid "STRUCTURES"
36174 msgstr ""
36175
36176 #. type: textblock
36177 #: ../src/guestfs.pod:1524
36178 msgid "@STRUCTS@"
36179 msgstr ""
36180
36181 #. type: =head1
36182 #: ../src/guestfs.pod:1526
36183 msgid "AVAILABILITY"
36184 msgstr ""
36185
36186 #. type: =head2
36187 #: ../src/guestfs.pod:1528
36188 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
36189 msgstr ""
36190
36191 #. type: textblock
36192 #: ../src/guestfs.pod:1530
36193 msgid ""
36194 "Using L</guestfs_available> you can test availability of the following "
36195 "groups of functions.  This test queries the appliance to see if the "
36196 "appliance you are currently using supports the functionality."
36197 msgstr ""
36198
36199 #. type: textblock
36200 #: ../src/guestfs.pod:1535
36201 msgid "@AVAILABILITY@"
36202 msgstr ""
36203
36204 #. type: =head2
36205 #: ../src/guestfs.pod:1537
36206 msgid "GUESTFISH supported COMMAND"
36207 msgstr ""
36208
36209 #. type: textblock
36210 #: ../src/guestfs.pod:1539
36211 msgid ""
36212 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
36213 "prints out the available groups and whether they are supported by this build "
36214 "of libguestfs.  Note however that you have to do C<run> first."
36215 msgstr ""
36216
36217 #. type: =head2
36218 #: ../src/guestfs.pod:1544
36219 msgid "SINGLE CALLS AT COMPILE TIME"
36220 msgstr ""
36221
36222 #. type: textblock
36223 #: ../src/guestfs.pod:1546
36224 msgid ""
36225 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
36226 "function, such as:"
36227 msgstr ""
36228
36229 #. type: verbatim
36230 #: ../src/guestfs.pod:1549
36231 #, no-wrap
36232 msgid ""
36233 " #define LIBGUESTFS_HAVE_DD 1\n"
36234 "\n"
36235 msgstr ""
36236
36237 #. type: textblock
36238 #: ../src/guestfs.pod:1551
36239 msgid "if L</guestfs_dd> is available."
36240 msgstr ""
36241
36242 #. type: textblock
36243 #: ../src/guestfs.pod:1553
36244 msgid ""
36245 "Before version 1.5.8, if you needed to test whether a single libguestfs "
36246 "function is available at compile time, we recommended using build tools such "
36247 "as autoconf or cmake.  For example in autotools you could use:"
36248 msgstr ""
36249
36250 #. type: verbatim
36251 #: ../src/guestfs.pod:1558
36252 #, no-wrap
36253 msgid ""
36254 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
36255 " AC_CHECK_FUNCS([guestfs_dd])\n"
36256 "\n"
36257 msgstr ""
36258
36259 #. type: textblock
36260 #: ../src/guestfs.pod:1561
36261 msgid ""
36262 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
36263 "in your program."
36264 msgstr ""
36265
36266 #. type: =head2
36267 #: ../src/guestfs.pod:1564
36268 msgid "SINGLE CALLS AT RUN TIME"
36269 msgstr ""
36270
36271 #. type: textblock
36272 #: ../src/guestfs.pod:1566
36273 msgid ""
36274 "Testing at compile time doesn't guarantee that a function really exists in "
36275 "the library.  The reason is that you might be dynamically linked against a "
36276 "previous I<libguestfs.so> (dynamic library)  which doesn't have the call.  "
36277 "This situation unfortunately results in a segmentation fault, which is a "
36278 "shortcoming of the C dynamic linking system itself."
36279 msgstr ""
36280
36281 #. type: textblock
36282 #: ../src/guestfs.pod:1573
36283 msgid ""
36284 "You can use L<dlopen(3)> to test if a function is available at run time, as "
36285 "in this example program (note that you still need the compile time check as "
36286 "well):"
36287 msgstr ""
36288
36289 #. type: verbatim
36290 #: ../src/guestfs.pod:1577
36291 #, no-wrap
36292 msgid ""
36293 " #include <stdio.h>\n"
36294 " #include <stdlib.h>\n"
36295 " #include <unistd.h>\n"
36296 " #include <dlfcn.h>\n"
36297 " #include <guestfs.h>\n"
36298 " \n"
36299 msgstr ""
36300
36301 #. type: verbatim
36302 #: ../src/guestfs.pod:1583
36303 #, no-wrap
36304 msgid ""
36305 " main ()\n"
36306 " {\n"
36307 " #ifdef LIBGUESTFS_HAVE_DD\n"
36308 "   void *dl;\n"
36309 "   int has_function;\n"
36310 " \n"
36311 msgstr ""
36312
36313 #. type: verbatim
36314 #: ../src/guestfs.pod:1589
36315 #, no-wrap
36316 msgid ""
36317 "   /* Test if the function guestfs_dd is really available. */\n"
36318 "   dl = dlopen (NULL, RTLD_LAZY);\n"
36319 "   if (!dl) {\n"
36320 "     fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
36321 "     exit (EXIT_FAILURE);\n"
36322 "   }\n"
36323 "   has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
36324 "   dlclose (dl);\n"
36325 " \n"
36326 msgstr ""
36327
36328 #. type: verbatim
36329 #: ../src/guestfs.pod:1598
36330 #, no-wrap
36331 msgid ""
36332 "   if (!has_function)\n"
36333 "     printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
36334 "   else {\n"
36335 "     printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
36336 "     /* Now it's safe to call\n"
36337 "     guestfs_dd (g, \"foo\", \"bar\");\n"
36338 "     */\n"
36339 "   }\n"
36340 " #else\n"
36341 "   printf (\"guestfs_dd function was not found at compile time\\n\");\n"
36342 " #endif\n"
36343 "  }\n"
36344 "\n"
36345 msgstr ""
36346
36347 #. type: textblock
36348 #: ../src/guestfs.pod:1611
36349 msgid ""
36350 "You may think the above is an awful lot of hassle, and it is.  There are "
36351 "other ways outside of the C linking system to ensure that this kind of "
36352 "incompatibility never arises, such as using package versioning:"
36353 msgstr ""
36354
36355 #. type: verbatim
36356 #: ../src/guestfs.pod:1616
36357 #, no-wrap
36358 msgid ""
36359 " Requires: libguestfs >= 1.0.80\n"
36360 "\n"
36361 msgstr ""
36362
36363 #. type: =head1
36364 #: ../src/guestfs.pod:1618
36365 msgid "CALLS WITH OPTIONAL ARGUMENTS"
36366 msgstr ""
36367
36368 #. type: textblock
36369 #: ../src/guestfs.pod:1620
36370 msgid ""
36371 "A recent feature of the API is the introduction of calls which take optional "
36372 "arguments.  In C these are declared 3 ways.  The main way is as a call which "
36373 "takes variable arguments (ie. C<...>), as in this example:"
36374 msgstr ""
36375
36376 #. type: verbatim
36377 #: ../src/guestfs.pod:1625
36378 #, no-wrap
36379 msgid ""
36380 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
36381 "\n"
36382 msgstr ""
36383
36384 #. type: textblock
36385 #: ../src/guestfs.pod:1627
36386 msgid ""
36387 "Call this with a list of optional arguments, terminated by C<-1>.  So to "
36388 "call with no optional arguments specified:"
36389 msgstr ""
36390
36391 #. type: verbatim
36392 #: ../src/guestfs.pod:1630
36393 #, no-wrap
36394 msgid ""
36395 " guestfs_add_drive_opts (g, filename, -1);\n"
36396 "\n"
36397 msgstr ""
36398
36399 #. type: textblock
36400 #: ../src/guestfs.pod:1632
36401 msgid "With a single optional argument:"
36402 msgstr ""
36403
36404 #. type: verbatim
36405 #: ../src/guestfs.pod:1634
36406 #, no-wrap
36407 msgid ""
36408 " guestfs_add_drive_opts (g, filename,\n"
36409 "                         GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
36410 "                         -1);\n"
36411 "\n"
36412 msgstr ""
36413
36414 #. type: textblock
36415 #: ../src/guestfs.pod:1638
36416 msgid "With two:"
36417 msgstr ""
36418
36419 #. type: verbatim
36420 #: ../src/guestfs.pod:1640
36421 #, no-wrap
36422 msgid ""
36423 " guestfs_add_drive_opts (g, filename,\n"
36424 "                         GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
36425 "                         GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
36426 "                         -1);\n"
36427 "\n"
36428 msgstr ""
36429
36430 #. type: textblock
36431 #: ../src/guestfs.pod:1645
36432 msgid ""
36433 "and so forth.  Don't forget the terminating C<-1> otherwise Bad Things will "
36434 "happen!"
36435 msgstr ""
36436
36437 #. type: =head2
36438 #: ../src/guestfs.pod:1648
36439 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
36440 msgstr ""
36441
36442 #. type: textblock
36443 #: ../src/guestfs.pod:1650
36444 msgid ""
36445 "The second variant has the same name with the suffix C<_va>, which works the "
36446 "same way but takes a C<va_list>.  See the C manual for details.  For the "
36447 "example function, this is declared:"
36448 msgstr ""
36449
36450 #. type: verbatim
36451 #: ../src/guestfs.pod:1654
36452 #, no-wrap
36453 msgid ""
36454 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
36455 "                                va_list args);\n"
36456 "\n"
36457 msgstr ""
36458
36459 #. type: =head2
36460 #: ../src/guestfs.pod:1657
36461 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
36462 msgstr ""
36463
36464 #. type: textblock
36465 #: ../src/guestfs.pod:1659
36466 msgid ""
36467 "The third variant is useful where you need to construct these calls.  You "
36468 "pass in a structure where you fill in the optional fields.  The structure "
36469 "has a bitmask as the first element which you must set to indicate which "
36470 "fields you have filled in.  For our example function the structure and call "
36471 "are declared:"
36472 msgstr ""
36473
36474 #. type: verbatim
36475 #: ../src/guestfs.pod:1665
36476 #, no-wrap
36477 msgid ""
36478 " struct guestfs_add_drive_opts_argv {\n"
36479 "   uint64_t bitmask;\n"
36480 "   int readonly;\n"
36481 "   const char *format;\n"
36482 "   /* ... */\n"
36483 " };\n"
36484 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
36485 "              const struct guestfs_add_drive_opts_argv *optargs);\n"
36486 "\n"
36487 msgstr ""
36488
36489 #. type: textblock
36490 #: ../src/guestfs.pod:1674
36491 msgid "You could call it like this:"
36492 msgstr ""
36493
36494 #. type: verbatim
36495 #: ../src/guestfs.pod:1676
36496 #, no-wrap
36497 msgid ""
36498 " struct guestfs_add_drive_opts_argv optargs = {\n"
36499 "   .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
36500 "              GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
36501 "   .readonly = 1,\n"
36502 "   .format = \"qcow2\"\n"
36503 " };\n"
36504 " \n"
36505 msgstr ""
36506
36507 #. type: verbatim
36508 #: ../src/guestfs.pod:1683
36509 #, no-wrap
36510 msgid ""
36511 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
36512 "\n"
36513 msgstr ""
36514
36515 #. type: textblock
36516 #: ../src/guestfs.pod:1691
36517 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
36518 msgstr ""
36519
36520 #. type: textblock
36521 #: ../src/guestfs.pod:1696
36522 msgid "You do not need to fill in all fields of the structure."
36523 msgstr ""
36524
36525 #. type: textblock
36526 #: ../src/guestfs.pod:1700
36527 msgid ""
36528 "There must be a one-to-one correspondence between fields of the structure "
36529 "that are filled in, and bits set in the bitmask."
36530 msgstr ""
36531
36532 #. type: =head2
36533 #: ../src/guestfs.pod:1705
36534 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
36535 msgstr ""
36536
36537 #. type: textblock
36538 #: ../src/guestfs.pod:1707
36539 msgid ""
36540 "In other languages, optional arguments are expressed in the way that is "
36541 "natural for that language.  We refer you to the language-specific "
36542 "documentation for more details on that."
36543 msgstr ""
36544
36545 #. type: textblock
36546 #: ../src/guestfs.pod:1711
36547 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
36548 msgstr ""
36549
36550 #. type: =head2
36551 #: ../src/guestfs.pod:1713
36552 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
36553 msgstr ""
36554
36555 #. type: textblock
36556 #: ../src/guestfs.pod:1715
36557 msgid ""
36558 "B<Note:> This section documents the generic event mechanism introduced in "
36559 "libguestfs 1.10, which you should use in new code if possible.  The old "
36560 "functions C<guestfs_set_log_message_callback>, "
36561 "C<guestfs_set_subprocess_quit_callback>, "
36562 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
36563 "C<guestfs_set_progress_callback> are no longer documented in this manual "
36564 "page.  Because of the ABI guarantee, the old functions continue to work."
36565 msgstr ""
36566
36567 #. type: textblock
36568 #: ../src/guestfs.pod:1724
36569 msgid ""
36570 "Handles generate events when certain things happen, such as log messages "
36571 "being generated, progress messages during long-running operations, or the "
36572 "handle being closed.  The API calls described below let you register a "
36573 "callback to be called when events happen.  You can register multiple "
36574 "callbacks (for the same, different or overlapping sets of events), and "
36575 "individually remove callbacks.  If callbacks are not removed, then they "
36576 "remain in force until the handle is closed."
36577 msgstr ""
36578
36579 #. type: textblock
36580 #: ../src/guestfs.pod:1732
36581 msgid ""
36582 "In the current implementation, events are only generated synchronously: that "
36583 "means that events (and hence callbacks) can only happen while you are in the "
36584 "middle of making another libguestfs call.  The callback is called in the "
36585 "same thread."
36586 msgstr ""
36587
36588 #. type: textblock
36589 #: ../src/guestfs.pod:1737
36590 msgid ""
36591 "Events may contain a payload, usually nothing (void), an array of 64 bit "
36592 "unsigned integers, or a message buffer.  Payloads are discussed later on."
36593 msgstr ""
36594
36595 #. type: =head3
36596 #: ../src/guestfs.pod:1741
36597 msgid "CLASSES OF EVENTS"
36598 msgstr ""
36599
36600 #. type: =item
36601 #: ../src/guestfs.pod:1745
36602 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
36603 msgstr ""
36604
36605 #. type: textblock
36606 #: ../src/guestfs.pod:1748
36607 msgid ""
36608 "The callback function will be called while the handle is being closed "
36609 "(synchronously from L</guestfs_close>)."
36610 msgstr ""
36611
36612 #. type: textblock
36613 #: ../src/guestfs.pod:1751
36614 msgid ""
36615 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
36616 "handles that are open when the program exits.  This means that this callback "
36617 "might be called indirectly from L<exit(3)>, which can cause unexpected "
36618 "problems in higher-level languages (eg. if your HLL interpreter has already "
36619 "been cleaned up by the time this is called, and if your callback then jumps "
36620 "into some HLL function)."
36621 msgstr ""
36622
36623 #. type: textblock
36624 #: ../src/guestfs.pod:1758
36625 msgid ""
36626 "If no callback is registered: the handle is closed without any callback "
36627 "being invoked."
36628 msgstr ""
36629
36630 #. type: =item
36631 #: ../src/guestfs.pod:1761
36632 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
36633 msgstr ""
36634
36635 #. type: textblock
36636 #: ../src/guestfs.pod:1764
36637 msgid ""
36638 "The callback function will be called when the child process quits, either "
36639 "asynchronously or if killed by L</guestfs_kill_subprocess>.  (This "
36640 "corresponds to a transition from any state to the CONFIG state)."
36641 msgstr ""
36642
36643 #. type: textblock
36644 #: ../src/guestfs.pod:1768 ../src/guestfs.pod:1777 ../src/guestfs.pod:1894
36645 msgid "If no callback is registered: the event is ignored."
36646 msgstr ""
36647
36648 #. type: =item
36649 #: ../src/guestfs.pod:1770
36650 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
36651 msgstr ""
36652
36653 #. type: textblock
36654 #: ../src/guestfs.pod:1773
36655 msgid ""
36656 "The callback function will be called when the child process becomes ready "
36657 "first time after it has been launched.  (This corresponds to a transition "
36658 "from LAUNCHING to the READY state)."
36659 msgstr ""
36660
36661 #. type: =item
36662 #: ../src/guestfs.pod:1779
36663 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
36664 msgstr ""
36665
36666 #. type: textblock
36667 #: ../src/guestfs.pod:1782
36668 msgid ""
36669 "Some long-running operations can generate progress messages.  If this "
36670 "callback is registered, then it will be called each time a progress message "
36671 "is generated (usually two seconds after the operation started, and three "
36672 "times per second thereafter until it completes, although the frequency may "
36673 "change in future versions)."
36674 msgstr ""
36675
36676 #. type: textblock
36677 #: ../src/guestfs.pod:1788
36678 msgid ""
36679 "The callback receives in the payload four unsigned 64 bit numbers which are "
36680 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
36681 msgstr ""
36682
36683 #. type: textblock
36684 #: ../src/guestfs.pod:1791
36685 msgid ""
36686 "The units of C<total> are not defined, although for some operations C<total> "
36687 "may relate in some way to the amount of data to be transferred (eg. in bytes "
36688 "or megabytes), and C<position> may be the portion which has been "
36689 "transferred."
36690 msgstr ""
36691
36692 #. type: textblock
36693 #: ../src/guestfs.pod:1796
36694 msgid "The only defined and stable parts of the API are:"
36695 msgstr ""
36696
36697 #. type: textblock
36698 #: ../src/guestfs.pod:1802
36699 msgid ""
36700 "The callback can display to the user some type of progress bar or indicator "
36701 "which shows the ratio of C<position>:C<total>."
36702 msgstr ""
36703
36704 #. type: textblock
36705 #: ../src/guestfs.pod:1807
36706 msgid "0 E<lt>= C<position> E<lt>= C<total>"
36707 msgstr ""
36708
36709 #. type: textblock
36710 #: ../src/guestfs.pod:1811
36711 msgid ""
36712 "If any progress notification is sent during a call, then a final progress "
36713 "notification is always sent when C<position> = C<total> (I<unless> the call "
36714 "fails with an error)."
36715 msgstr ""
36716
36717 #. type: textblock
36718 #: ../src/guestfs.pod:1815
36719 msgid ""
36720 "This is to simplify caller code, so callers can easily set the progress "
36721 "indicator to \"100%\" at the end of the operation, without requiring special "
36722 "code to detect this case."
36723 msgstr ""
36724
36725 #. type: textblock
36726 #: ../src/guestfs.pod:1821
36727 msgid ""
36728 "For some calls we are unable to estimate the progress of the call, but we "
36729 "can still generate progress messages to indicate activity.  This is known as "
36730 "\"pulse mode\", and is directly supported by certain progress bar "
36731 "implementations (eg. GtkProgressBar)."
36732 msgstr ""
36733
36734 #. type: textblock
36735 #: ../src/guestfs.pod:1826
36736 msgid ""
36737 "For these calls, zero or more progress messages are generated with "
36738 "C<position = 0> and C<total = 1>, followed by a final message with "
36739 "C<position = total = 1>."
36740 msgstr ""
36741
36742 #. type: textblock
36743 #: ../src/guestfs.pod:1830
36744 msgid ""
36745 "As noted above, if the call fails with an error then the final message may "
36746 "not be generated."
36747 msgstr ""
36748
36749 #. type: textblock
36750 #: ../src/guestfs.pod:1835
36751 msgid ""
36752 "The callback also receives the procedure number (C<proc_nr>) and serial "
36753 "number (C<serial>) of the call.  These are only useful for debugging "
36754 "protocol issues, and the callback can normally ignore them.  The callback "
36755 "may want to print these numbers in error messages or debugging messages."
36756 msgstr ""
36757
36758 #. type: textblock
36759 #: ../src/guestfs.pod:1841
36760 msgid "If no callback is registered: progress messages are discarded."
36761 msgstr ""
36762
36763 #. type: =item
36764 #: ../src/guestfs.pod:1843
36765 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
36766 msgstr ""
36767
36768 #. type: textblock
36769 #: ../src/guestfs.pod:1846
36770 msgid ""
36771 "The callback function is called whenever a log message is generated by qemu, "
36772 "the appliance kernel, guestfsd (daemon), or utility programs."
36773 msgstr ""
36774
36775 #. type: textblock
36776 #: ../src/guestfs.pod:1849
36777 msgid ""
36778 "If the verbose flag (L</guestfs_set_verbose>) is set before launch "
36779 "(L</guestfs_launch>) then additional debug messages are generated."
36780 msgstr ""
36781
36782 #. type: textblock
36783 #: ../src/guestfs.pod:1852 ../src/guestfs.pod:1866
36784 msgid ""
36785 "If no callback is registered: the messages are discarded unless the verbose "
36786 "flag is set in which case they are sent to stderr.  You can override the "
36787 "printing of verbose messages to stderr by setting up a callback."
36788 msgstr ""
36789
36790 #. type: =item
36791 #: ../src/guestfs.pod:1857
36792 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
36793 msgstr ""
36794
36795 #. type: textblock
36796 #: ../src/guestfs.pod:1860
36797 msgid ""
36798 "The callback function is called whenever a log message is generated by the "
36799 "library part of libguestfs."
36800 msgstr ""
36801
36802 #. type: textblock
36803 #: ../src/guestfs.pod:1863
36804 msgid ""
36805 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
36806 "messages are generated."
36807 msgstr ""
36808
36809 #. type: =item
36810 #: ../src/guestfs.pod:1871
36811 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
36812 msgstr ""
36813
36814 #. type: textblock
36815 #: ../src/guestfs.pod:1874
36816 msgid ""
36817 "The callback function is called whenever a trace message is generated.  This "
36818 "only applies if the trace flag (L</guestfs_set_trace>) is set."
36819 msgstr ""
36820
36821 #. type: textblock
36822 #: ../src/guestfs.pod:1877
36823 msgid ""
36824 "If no callback is registered: the messages are sent to stderr.  You can "
36825 "override the printing of trace messages to stderr by setting up a callback."
36826 msgstr ""
36827
36828 #. type: =item
36829 #: ../src/guestfs.pod:1881
36830 msgid "GUESTFS_EVENT_ENTER (payload type: function name)"
36831 msgstr ""
36832
36833 #. type: textblock
36834 #: ../src/guestfs.pod:1884
36835 msgid "The callback function is called whenever a libguestfs function is entered."
36836 msgstr ""
36837
36838 #. type: textblock
36839 #: ../src/guestfs.pod:1887
36840 msgid ""
36841 "The payload is a string which contains the name of the function that we are "
36842 "entering (not including C<guestfs_> prefix)."
36843 msgstr ""
36844
36845 #. type: textblock
36846 #: ../src/guestfs.pod:1890
36847 msgid ""
36848 "Note that libguestfs functions can call themselves, so you may see many "
36849 "events from a single call.  A few libguestfs functions do not generate this "
36850 "event."
36851 msgstr ""
36852
36853 #. type: =head3
36854 #: ../src/guestfs.pod:1898
36855 msgid "guestfs_set_event_callback"
36856 msgstr ""
36857
36858 #. type: verbatim
36859 #: ../src/guestfs.pod:1900
36860 #, no-wrap
36861 msgid ""
36862 " int guestfs_set_event_callback (guestfs_h *g,\n"
36863 "                                 guestfs_event_callback cb,\n"
36864 "                                 uint64_t event_bitmask,\n"
36865 "                                 int flags,\n"
36866 "                                 void *opaque);\n"
36867 "\n"
36868 msgstr ""
36869
36870 #. type: textblock
36871 #: ../src/guestfs.pod:1906
36872 msgid ""
36873 "This function registers a callback (C<cb>) for all event classes in the "
36874 "C<event_bitmask>."
36875 msgstr ""
36876
36877 #. type: textblock
36878 #: ../src/guestfs.pod:1909
36879 msgid ""
36880 "For example, to register for all log message events, you could call this "
36881 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>.  "
36882 "To register a single callback for all possible classes of events, use "
36883 "C<GUESTFS_EVENT_ALL>."
36884 msgstr ""
36885
36886 #. type: textblock
36887 #: ../src/guestfs.pod:1915
36888 msgid "C<flags> should always be passed as 0."
36889 msgstr ""
36890
36891 #. type: textblock
36892 #: ../src/guestfs.pod:1917
36893 msgid ""
36894 "C<opaque> is an opaque pointer which is passed to the callback.  You can use "
36895 "it for any purpose."
36896 msgstr ""
36897
36898 #. type: textblock
36899 #: ../src/guestfs.pod:1920
36900 msgid ""
36901 "The return value is the event handle (an integer) which you can use to "
36902 "delete the callback (see below)."
36903 msgstr ""
36904
36905 #. type: textblock
36906 #: ../src/guestfs.pod:1923
36907 msgid ""
36908 "If there is an error, this function returns C<-1>, and sets the error in the "
36909 "handle in the usual way (see L</guestfs_last_error> etc.)"
36910 msgstr ""
36911
36912 #. type: textblock
36913 #: ../src/guestfs.pod:1926
36914 msgid ""
36915 "Callbacks remain in effect until they are deleted, or until the handle is "
36916 "closed."
36917 msgstr ""
36918
36919 #. type: textblock
36920 #: ../src/guestfs.pod:1929
36921 msgid ""
36922 "In the case where multiple callbacks are registered for a particular event "
36923 "class, all of the callbacks are called.  The order in which multiple "
36924 "callbacks are called is not defined."
36925 msgstr ""
36926
36927 #. type: =head3
36928 #: ../src/guestfs.pod:1933
36929 msgid "guestfs_delete_event_callback"
36930 msgstr ""
36931
36932 #. type: verbatim
36933 #: ../src/guestfs.pod:1935
36934 #, no-wrap
36935 msgid ""
36936 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
36937 "\n"
36938 msgstr ""
36939
36940 #. type: textblock
36941 #: ../src/guestfs.pod:1937
36942 msgid ""
36943 "Delete a callback that was previously registered.  C<event_handle> should be "
36944 "the integer that was returned by a previous call to "
36945 "C<guestfs_set_event_callback> on the same handle."
36946 msgstr ""
36947
36948 #. type: =head3
36949 #: ../src/guestfs.pod:1941
36950 msgid "guestfs_event_callback"
36951 msgstr ""
36952
36953 #. type: verbatim
36954 #: ../src/guestfs.pod:1943
36955 #, no-wrap
36956 msgid ""
36957 " typedef void (*guestfs_event_callback) (\n"
36958 "                  guestfs_h *g,\n"
36959 "                  void *opaque,\n"
36960 "                  uint64_t event,\n"
36961 "                  int event_handle,\n"
36962 "                  int flags,\n"
36963 "                  const char *buf, size_t buf_len,\n"
36964 "                  const uint64_t *array, size_t array_len);\n"
36965 "\n"
36966 msgstr ""
36967
36968 #. type: textblock
36969 #: ../src/guestfs.pod:1952
36970 msgid "This is the type of the event callback function that you have to provide."
36971 msgstr ""
36972
36973 #. type: textblock
36974 #: ../src/guestfs.pod:1955
36975 msgid ""
36976 "The basic parameters are: the handle (C<g>), the opaque user pointer "
36977 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
36978 "handle, and C<flags> which in the current API you should ignore."
36979 msgstr ""
36980
36981 #. type: textblock
36982 #: ../src/guestfs.pod:1959
36983 msgid ""
36984 "The remaining parameters contain the event payload (if any).  Each event may "
36985 "contain a payload, which usually relates to the event class, but for future "
36986 "proofing your code should be written to handle any payload for any event "
36987 "class."
36988 msgstr ""
36989
36990 #. type: textblock
36991 #: ../src/guestfs.pod:1964
36992 msgid ""
36993 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
36994 "there is no message buffer).  Note that this message buffer can contain "
36995 "arbitrary 8 bit data, including NUL bytes."
36996 msgstr ""
36997
36998 #. type: textblock
36999 #: ../src/guestfs.pod:1968
37000 msgid ""
37001 "C<array> and C<array_len> is an array of 64 bit unsigned integers.  At the "
37002 "moment this is only used for progress messages."
37003 msgstr ""
37004
37005 #. type: =head3
37006 #: ../src/guestfs.pod:1971
37007 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
37008 msgstr ""
37009
37010 #. type: textblock
37011 #: ../src/guestfs.pod:1973
37012 msgid ""
37013 "One motivation for the generic event API was to allow GUI programs to "
37014 "capture debug and other messages.  In libguestfs E<le> 1.8 these were sent "
37015 "unconditionally to C<stderr>."
37016 msgstr ""
37017
37018 #. type: textblock
37019 #: ../src/guestfs.pod:1977
37020 msgid ""
37021 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
37022 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>.  (Note that error "
37023 "messages are not events; you must capture error messages separately)."
37024 msgstr ""
37025
37026 #. type: textblock
37027 #: ../src/guestfs.pod:1982
37028 msgid ""
37029 "Programs have to set up a callback to capture the classes of events of "
37030 "interest:"
37031 msgstr ""
37032
37033 #. type: verbatim
37034 #: ../src/guestfs.pod:1985
37035 #, no-wrap
37036 msgid ""
37037 " int eh =\n"
37038 "   guestfs_set_event_callback\n"
37039 "     (g, message_callback,\n"
37040 "      GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
37041 "      GUESTFS_EVENT_TRACE,\n"
37042 "      0, NULL) == -1)\n"
37043 " if (eh == -1) {\n"
37044 "   // handle error in the usual way\n"
37045 " }\n"
37046 "\n"
37047 msgstr ""
37048
37049 #. type: textblock
37050 #: ../src/guestfs.pod:1995
37051 msgid ""
37052 "The callback can then direct messages to the appropriate place.  In this "
37053 "example, messages are directed to syslog:"
37054 msgstr ""
37055
37056 #. type: verbatim
37057 #: ../src/guestfs.pod:1998
37058 #, no-wrap
37059 msgid ""
37060 " static void\n"
37061 " message_callback (\n"
37062 "         guestfs_h *g,\n"
37063 "         void *opaque,\n"
37064 "         uint64_t event,\n"
37065 "         int event_handle,\n"
37066 "         int flags,\n"
37067 "         const char *buf, size_t buf_len,\n"
37068 "         const uint64_t *array, size_t array_len)\n"
37069 " {\n"
37070 "   const int priority = LOG_USER|LOG_INFO;\n"
37071 "   if (buf_len > 0)\n"
37072 "     syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
37073 " }\n"
37074 "\n"
37075 msgstr ""
37076
37077 #. type: =head1
37078 #: ../src/guestfs.pod:2013
37079 msgid "CANCELLING LONG TRANSFERS"
37080 msgstr ""
37081
37082 #. type: textblock
37083 #: ../src/guestfs.pod:2015
37084 msgid ""
37085 "Some operations can be cancelled by the caller while they are in progress.  "
37086 "Currently only operations that involve uploading or downloading data can be "
37087 "cancelled (technically: operations that have C<FileIn> or C<FileOut> "
37088 "parameters in the generator)."
37089 msgstr ""
37090
37091 #. type: =head2
37092 #: ../src/guestfs.pod:2020
37093 msgid "guestfs_user_cancel"
37094 msgstr ""
37095
37096 #. type: verbatim
37097 #: ../src/guestfs.pod:2022
37098 #, no-wrap
37099 msgid ""
37100 " void guestfs_user_cancel (guestfs_h *g);\n"
37101 "\n"
37102 msgstr ""
37103
37104 #. type: textblock
37105 #: ../src/guestfs.pod:2024
37106 msgid "C<guestfs_user_cancel> cancels the current upload or download operation."
37107 msgstr ""
37108
37109 #. type: textblock
37110 #: ../src/guestfs.pod:2027
37111 msgid ""
37112 "Unlike most other libguestfs calls, this function is signal safe and thread "
37113 "safe.  You can call it from a signal handler or from another thread, without "
37114 "needing to do any locking."
37115 msgstr ""
37116
37117 #. type: textblock
37118 #: ../src/guestfs.pod:2031
37119 msgid ""
37120 "The transfer that was in progress (if there is one) will stop shortly "
37121 "afterwards, and will return an error.  The errno (see "
37122 "L</guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find "
37123 "out if the operation was cancelled or failed because of another error."
37124 msgstr ""
37125
37126 #. type: textblock
37127 #: ../src/guestfs.pod:2037
37128 msgid ""
37129 "No cleanup is performed: for example, if a file was being uploaded then "
37130 "after cancellation there may be a partially uploaded file.  It is the "
37131 "caller's responsibility to clean up if necessary."
37132 msgstr ""
37133
37134 #. type: textblock
37135 #: ../src/guestfs.pod:2041
37136 msgid "There are two common places that you might call C<guestfs_user_cancel>."
37137 msgstr ""
37138
37139 #. type: textblock
37140 #: ../src/guestfs.pod:2043
37141 msgid ""
37142 "In an interactive text-based program, you might call it from a C<SIGINT> "
37143 "signal handler so that pressing C<^C> cancels the current operation.  (You "
37144 "also need to call L</guestfs_set_pgroup> so that child processes don't "
37145 "receive the C<^C> signal)."
37146 msgstr ""
37147
37148 #. type: textblock
37149 #: ../src/guestfs.pod:2048
37150 msgid ""
37151 "In a graphical program, when the main thread is displaying a progress bar "
37152 "with a cancel button, wire up the cancel button to call this function."
37153 msgstr ""
37154
37155 #. type: =head1
37156 #: ../src/guestfs.pod:2052
37157 msgid "PRIVATE DATA AREA"
37158 msgstr ""
37159
37160 #. type: textblock
37161 #: ../src/guestfs.pod:2054
37162 msgid ""
37163 "You can attach named pieces of private data to the libguestfs handle, fetch "
37164 "them by name, and walk over them, for the lifetime of the handle.  This is "
37165 "called the private data area and is only available from the C API."
37166 msgstr ""
37167
37168 #. type: textblock
37169 #: ../src/guestfs.pod:2059
37170 msgid "To attach a named piece of data, use the following call:"
37171 msgstr ""
37172
37173 #. type: verbatim
37174 #: ../src/guestfs.pod:2061
37175 #, no-wrap
37176 msgid ""
37177 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
37178 "\n"
37179 msgstr ""
37180
37181 #. type: textblock
37182 #: ../src/guestfs.pod:2063
37183 msgid ""
37184 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
37185 "pointer (which can be C<NULL>).  Any previous item with the same key is "
37186 "overwritten."
37187 msgstr ""
37188
37189 #. type: textblock
37190 #: ../src/guestfs.pod:2067
37191 msgid ""
37192 "You can use any C<key> you want, but your key should I<not> start with an "
37193 "underscore character.  Keys beginning with an underscore character are "
37194 "reserved for internal libguestfs purposes (eg. for implementing language "
37195 "bindings).  It is recommended that you prefix the key with some unique "
37196 "string to avoid collisions with other users."
37197 msgstr ""
37198
37199 #. type: textblock
37200 #: ../src/guestfs.pod:2073
37201 msgid "To retrieve the pointer, use:"
37202 msgstr ""
37203
37204 #. type: verbatim
37205 #: ../src/guestfs.pod:2075
37206 #, no-wrap
37207 msgid ""
37208 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
37209 "\n"
37210 msgstr ""
37211
37212 #. type: textblock
37213 #: ../src/guestfs.pod:2077
37214 msgid ""
37215 "This function returns C<NULL> if either no data is found associated with "
37216 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
37217 "C<NULL>."
37218 msgstr ""
37219
37220 #. type: textblock
37221 #: ../src/guestfs.pod:2081
37222 msgid ""
37223 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
37224 "way.  As far as libguestfs is concerned, it need not be a valid pointer at "
37225 "all.  In particular, libguestfs does I<not> try to free the data when the "
37226 "handle is closed.  If the data must be freed, then the caller must either "
37227 "free it before calling L</guestfs_close> or must set up a close callback to "
37228 "do it (see L</GUESTFS_EVENT_CLOSE>)."
37229 msgstr ""
37230
37231 #. type: textblock
37232 #: ../src/guestfs.pod:2088
37233 msgid "To walk over all entries, use these two functions:"
37234 msgstr ""
37235
37236 #. type: verbatim
37237 #: ../src/guestfs.pod:2090
37238 #, no-wrap
37239 msgid ""
37240 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
37241 "\n"
37242 msgstr ""
37243
37244 #. type: verbatim
37245 #: ../src/guestfs.pod:2092
37246 #, no-wrap
37247 msgid ""
37248 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
37249 "\n"
37250 msgstr ""
37251
37252 #. type: textblock
37253 #: ../src/guestfs.pod:2094
37254 msgid ""
37255 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
37256 "not have any particular meaning -- keys are not returned in any defined "
37257 "order).  A pointer to the key is returned in C<*key_rtn> and the "
37258 "corresponding data pointer is returned from the function.  C<NULL> is "
37259 "returned if there are no keys stored in the handle."
37260 msgstr ""
37261
37262 #. type: textblock
37263 #: ../src/guestfs.pod:2100
37264 msgid ""
37265 "C<guestfs_next_private> returns the next key, pointer pair.  The return "
37266 "value of this function is also C<NULL> is there are no further entries to "
37267 "return."
37268 msgstr ""
37269
37270 #. type: textblock
37271 #: ../src/guestfs.pod:2104
37272 msgid "Notes about walking over entries:"
37273 msgstr ""
37274
37275 #. type: textblock
37276 #: ../src/guestfs.pod:2110
37277 msgid "You must not call C<guestfs_set_private> while walking over the entries."
37278 msgstr ""
37279
37280 #. type: textblock
37281 #: ../src/guestfs.pod:2115
37282 msgid ""
37283 "The handle maintains an internal iterator which is reset when you call "
37284 "C<guestfs_first_private>.  This internal iterator is invalidated when you "
37285 "call C<guestfs_set_private>."
37286 msgstr ""
37287
37288 #. type: textblock
37289 #: ../src/guestfs.pod:2121
37290 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
37291 msgstr ""
37292
37293 #. type: verbatim
37294 #: ../src/guestfs.pod:2123
37295 #, no-wrap
37296 msgid ""
37297 " guestfs_set_private (g, key, NULL);\n"
37298 "\n"
37299 msgstr ""
37300
37301 #. type: textblock
37302 #: ../src/guestfs.pod:2125
37303 msgid "then that C<key> is not returned when walking."
37304 msgstr ""
37305
37306 #. type: textblock
37307 #: ../src/guestfs.pod:2129
37308 msgid ""
37309 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
37310 "C<guestfs_next_private> or C<guestfs_set_private>."
37311 msgstr ""
37312
37313 #. type: textblock
37314 #: ../src/guestfs.pod:2135
37315 msgid ""
37316 "The following example code shows how to print all keys and data pointers "
37317 "that are associated with the handle C<g>:"
37318 msgstr ""
37319
37320 #. type: verbatim
37321 #: ../src/guestfs.pod:2138
37322 #, no-wrap
37323 msgid ""
37324 " const char *key;\n"
37325 " void *data = guestfs_first_private (g, &key);\n"
37326 " while (data != NULL)\n"
37327 "   {\n"
37328 "     printf (\"key = %s, data = %p\\n\", key, data);\n"
37329 "     data = guestfs_next_private (g, &key);\n"
37330 "   }\n"
37331 "\n"
37332 msgstr ""
37333
37334 #. type: textblock
37335 #: ../src/guestfs.pod:2146
37336 msgid ""
37337 "More commonly you are only interested in keys that begin with an "
37338 "application-specific prefix C<foo_>.  Modify the loop like so:"
37339 msgstr ""
37340
37341 #. type: verbatim
37342 #: ../src/guestfs.pod:2149
37343 #, no-wrap
37344 msgid ""
37345 " const char *key;\n"
37346 " void *data = guestfs_first_private (g, &key);\n"
37347 " while (data != NULL)\n"
37348 "   {\n"
37349 "     if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
37350 "       printf (\"key = %s, data = %p\\n\", key, data);\n"
37351 "     data = guestfs_next_private (g, &key);\n"
37352 "   }\n"
37353 "\n"
37354 msgstr ""
37355
37356 #. type: textblock
37357 #: ../src/guestfs.pod:2158
37358 msgid ""
37359 "If you need to modify keys while walking, then you have to jump back to the "
37360 "beginning of the loop.  For example, to delete all keys prefixed with "
37361 "C<foo_>:"
37362 msgstr ""
37363
37364 #. type: verbatim
37365 #: ../src/guestfs.pod:2162
37366 #, no-wrap
37367 msgid ""
37368 "  const char *key;\n"
37369 "  void *data;\n"
37370 " again:\n"
37371 "  data = guestfs_first_private (g, &key);\n"
37372 "  while (data != NULL)\n"
37373 "    {\n"
37374 "      if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
37375 "        {\n"
37376 "          guestfs_set_private (g, key, NULL);\n"
37377 "          /* note that 'key' pointer is now invalid, and so is\n"
37378 "             the internal iterator */\n"
37379 "          goto again;\n"
37380 "        }\n"
37381 "      data = guestfs_next_private (g, &key);\n"
37382 "    }\n"
37383 "\n"
37384 msgstr ""
37385
37386 #. type: textblock
37387 #: ../src/guestfs.pod:2178
37388 msgid ""
37389 "Note that the above loop is guaranteed to terminate because the keys are "
37390 "being deleted, but other manipulations of keys within the loop might not "
37391 "terminate unless you also maintain an indication of which keys have been "
37392 "visited."
37393 msgstr ""
37394
37395 #. type: =head1
37396 #: ../src/guestfs.pod:2183
37397 msgid "SYSTEMTAP"
37398 msgstr ""
37399
37400 #. type: textblock
37401 #: ../src/guestfs.pod:2185
37402 msgid ""
37403 "The libguestfs C library can be probed using systemtap or DTrace.  This is "
37404 "true of any library, not just libguestfs.  However libguestfs also contains "
37405 "static markers to help in probing internal operations."
37406 msgstr ""
37407
37408 #. type: textblock
37409 #: ../src/guestfs.pod:2189
37410 msgid "You can list all the static markers by doing:"
37411 msgstr ""
37412
37413 #. type: verbatim
37414 #: ../src/guestfs.pod:2191
37415 #, no-wrap
37416 msgid ""
37417 " stap -l 'process(\"/usr/lib*/libguestfs.so.0\")\n"
37418 "              .provider(\"guestfs\").mark(\"*\")'\n"
37419 "\n"
37420 msgstr ""
37421
37422 #. type: textblock
37423 #: ../src/guestfs.pod:2194
37424 msgid ""
37425 "B<Note:> These static markers are I<not> part of the stable API and may "
37426 "change in future versions."
37427 msgstr ""
37428
37429 #. type: =head2
37430 #: ../src/guestfs.pod:2197
37431 msgid "SYSTEMTAP SCRIPT EXAMPLE"
37432 msgstr ""
37433
37434 #. type: textblock
37435 #: ../src/guestfs.pod:2199
37436 msgid ""
37437 "This script contains examples of displaying both the static markers and some "
37438 "ordinary C entry points:"
37439 msgstr ""
37440
37441 #. type: verbatim
37442 #: ../src/guestfs.pod:2202
37443 #, no-wrap
37444 msgid ""
37445 " global last;\n"
37446 " \n"
37447 msgstr ""
37448
37449 #. type: verbatim
37450 #: ../src/guestfs.pod:2204
37451 #, no-wrap
37452 msgid ""
37453 " function display_time () {\n"
37454 "       now = gettimeofday_us ();\n"
37455 "       delta = 0;\n"
37456 "       if (last > 0)\n"
37457 "             delta = now - last;\n"
37458 "       last = now;\n"
37459 " \n"
37460 msgstr ""
37461
37462 #. type: verbatim
37463 #: ../src/guestfs.pod:2211
37464 #, no-wrap
37465 msgid ""
37466 "       printf (\"%d (+%d):\", now, delta);\n"
37467 " }\n"
37468 " \n"
37469 msgstr ""
37470
37471 #. type: verbatim
37472 #: ../src/guestfs.pod:2214
37473 #, no-wrap
37474 msgid ""
37475 " probe begin {\n"
37476 "       last = 0;\n"
37477 "       printf (\"ready\\n\");\n"
37478 " }\n"
37479 " \n"
37480 msgstr ""
37481
37482 #. type: verbatim
37483 #: ../src/guestfs.pod:2219
37484 #, no-wrap
37485 msgid ""
37486 " /* Display all calls to static markers. */\n"
37487 " probe process(\"/usr/lib*/libguestfs.so.0\")\n"
37488 "           .provider(\"guestfs\").mark(\"*\") ? {\n"
37489 "       display_time();\n"
37490 "       printf (\"\\t%s %s\\n\", $$name, $$parms);\n"
37491 " }\n"
37492 " \n"
37493 msgstr ""
37494
37495 #. type: verbatim
37496 #: ../src/guestfs.pod:2226
37497 #, no-wrap
37498 msgid ""
37499 " /* Display all calls to guestfs_mkfs* functions. */\n"
37500 " probe process(\"/usr/lib*/libguestfs.so.0\")\n"
37501 "           .function(\"guestfs_mkfs*\") ? {\n"
37502 "       display_time();\n"
37503 "       printf (\"\\t%s %s\\n\", probefunc(), $$parms);\n"
37504 " }\n"
37505 "\n"
37506 msgstr ""
37507
37508 #. type: textblock
37509 #: ../src/guestfs.pod:2233
37510 msgid ""
37511 "The script above can be saved to C<test.stap> and run using the L<stap(1)> "
37512 "program.  Note that you either have to be root, or you have to add yourself "
37513 "to several special stap groups.  Consult the systemtap documentation for "
37514 "more information."
37515 msgstr ""
37516
37517 #. type: verbatim
37518 #: ../src/guestfs.pod:2238
37519 #, no-wrap
37520 msgid ""
37521 " # stap /tmp/test.stap\n"
37522 " ready\n"
37523 "\n"
37524 msgstr ""
37525
37526 #. type: textblock
37527 #: ../src/guestfs.pod:2241
37528 msgid "In another terminal, run a guestfish command such as this:"
37529 msgstr ""
37530
37531 #. type: textblock
37532 #: ../src/guestfs.pod:2245
37533 msgid "In the first terminal, stap trace output similar to this is shown:"
37534 msgstr ""
37535
37536 #. type: verbatim
37537 #: ../src/guestfs.pod:2247
37538 #, no-wrap
37539 msgid ""
37540 " 1318248056692655 (+0):\tlaunch_start\n"
37541 " 1318248056692850 (+195):       launch_build_appliance_start\n"
37542 " 1318248056818285 (+125435):    launch_build_appliance_end\n"
37543 " 1318248056838059 (+19774):     launch_run_qemu\n"
37544 " 1318248061071167 (+4233108):   launch_end\n"
37545 " 1318248061280324 (+209157):    guestfs_mkfs g=0x1024ab0 fstype=0x46116f "
37546 "device=0x1024e60\n"
37547 "\n"
37548 msgstr ""
37549
37550 #. type: =end
37551 #: ../src/guestfs.pod:2254 ../src/guestfs.pod:2259
37552 msgid "html"
37553 msgstr ""
37554
37555 #. type: textblock
37556 #: ../src/guestfs.pod:2256
37557 msgid ""
37558 "<!-- old anchor for the next section --> <a "
37559 "name=\"state_machine_and_low_level_event_api\"/>"
37560 msgstr ""
37561
37562 #. type: =head1
37563 #: ../src/guestfs.pod:2261
37564 msgid "ARCHITECTURE"
37565 msgstr ""
37566
37567 #. type: textblock
37568 #: ../src/guestfs.pod:2263
37569 msgid ""
37570 "Internally, libguestfs is implemented by running an appliance (a special "
37571 "type of small virtual machine) using L<qemu(1)>.  Qemu runs as a child "
37572 "process of the main program."
37573 msgstr ""
37574
37575 #. type: verbatim
37576 #: ../src/guestfs.pod:2267
37577 #, no-wrap
37578 msgid ""
37579 "  ___________________\n"
37580 " /                   \\\n"
37581 " | main program      |\n"
37582 " |                   |\n"
37583 " |                   |           child process / appliance\n"
37584 " |                   |           __________________________\n"
37585 " |                   |          / qemu                     \\\n"
37586 " +-------------------+   RPC    |      +-----------------+ |\n"
37587 " | libguestfs     <--------------------> guestfsd        | |\n"
37588 " |                   |          |      +-----------------+ |\n"
37589 " \\___________________/          |      | Linux kernel    | |\n"
37590 "                                |      +--^--------------+ |\n"
37591 "                                \\_________|________________/\n"
37592 "                                          |\n"
37593 "                                   _______v______\n"
37594 "                                  /              \\\n"
37595 "                                  | Device or    |\n"
37596 "                                  | disk image   |\n"
37597 "                                  \\______________/\n"
37598 "\n"
37599 msgstr ""
37600
37601 #. type: textblock
37602 #: ../src/guestfs.pod:2287
37603 msgid ""
37604 "The library, linked to the main program, creates the child process and hence "
37605 "the appliance in the L</guestfs_launch> function."
37606 msgstr ""
37607
37608 #. type: textblock
37609 #: ../src/guestfs.pod:2290
37610 msgid ""
37611 "Inside the appliance is a Linux kernel and a complete stack of userspace "
37612 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
37613 "L</guestfsd>.  The library talks to L</guestfsd> using remote procedure "
37614 "calls (RPC).  There is a mostly one-to-one correspondence between libguestfs "
37615 "API calls and RPC calls to the daemon.  Lastly the disk image(s) are "
37616 "attached to the qemu process which translates device access by the "
37617 "appliance's Linux kernel into accesses to the image."
37618 msgstr ""
37619
37620 #. type: textblock
37621 #: ../src/guestfs.pod:2299
37622 msgid ""
37623 "A common misunderstanding is that the appliance \"is\" the virtual machine.  "
37624 "Although the disk image you are attached to might also be used by some "
37625 "virtual machine, libguestfs doesn't know or care about this.  (But you will "
37626 "care if both libguestfs's qemu process and your virtual machine are trying "
37627 "to update the disk image at the same time, since these usually results in "
37628 "massive disk corruption)."
37629 msgstr ""
37630
37631 #. type: =head1
37632 #: ../src/guestfs.pod:2306
37633 msgid "STATE MACHINE"
37634 msgstr ""
37635
37636 #. type: textblock
37637 #: ../src/guestfs.pod:2308
37638 msgid "libguestfs uses a state machine to model the child process:"
37639 msgstr ""
37640
37641 #. type: verbatim
37642 #: ../src/guestfs.pod:2310
37643 #, no-wrap
37644 msgid ""
37645 "                         |\n"
37646 "                    guestfs_create\n"
37647 "                         |\n"
37648 "                         |\n"
37649 "                     ____V_____\n"
37650 "                    /          \\\n"
37651 "                    |  CONFIG  |\n"
37652 "                    \\__________/\n"
37653 "                     ^ ^   ^  \\\n"
37654 "                    /  |    \\  \\ guestfs_launch\n"
37655 "                   /   |    _\\__V______\n"
37656 "                  /    |   /           \\\n"
37657 "                 /     |   | LAUNCHING |\n"
37658 "                /      |   \\___________/\n"
37659 "               /       |       /\n"
37660 "              /        |  guestfs_launch\n"
37661 "             /         |     /\n"
37662 "    ______  /        __|____V\n"
37663 "   /      \\ ------> /        \\\n"
37664 "   | BUSY |         | READY  |\n"
37665 "   \\______/ <------ \\________/\n"
37666 "\n"
37667 msgstr ""
37668
37669 #. type: textblock
37670 #: ../src/guestfs.pod:2332
37671 msgid ""
37672 "The normal transitions are (1) CONFIG (when the handle is created, but there "
37673 "is no child process), (2) LAUNCHING (when the child process is booting up), "
37674 "(3) alternating between READY and BUSY as commands are issued to, and "
37675 "carried out by, the child process."
37676 msgstr ""
37677
37678 #. type: textblock
37679 #: ../src/guestfs.pod:2337
37680 msgid ""
37681 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
37682 "asynchronously at any time (eg. due to some internal error), and that causes "
37683 "the state to transition back to CONFIG."
37684 msgstr ""
37685
37686 #. type: textblock
37687 #: ../src/guestfs.pod:2341
37688 msgid ""
37689 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
37690 "issued when in the CONFIG state."
37691 msgstr ""
37692
37693 #. type: textblock
37694 #: ../src/guestfs.pod:2344
37695 msgid ""
37696 "The API offers one call that goes from CONFIG through LAUNCHING to READY.  "
37697 "L</guestfs_launch> blocks until the child process is READY to accept "
37698 "commands (or until some failure or timeout).  L</guestfs_launch> internally "
37699 "moves the state from CONFIG to LAUNCHING while it is running."
37700 msgstr ""
37701
37702 #. type: textblock
37703 #: ../src/guestfs.pod:2350
37704 msgid ""
37705 "API actions such as L</guestfs_mount> can only be issued when in the READY "
37706 "state.  These API calls block waiting for the command to be carried out "
37707 "(ie. the state to transition to BUSY and then back to READY).  There are no "
37708 "non-blocking versions, and no way to issue more than one command per handle "
37709 "at the same time."
37710 msgstr ""
37711
37712 #. type: textblock
37713 #: ../src/guestfs.pod:2356
37714 msgid ""
37715 "Finally, the child process sends asynchronous messages back to the main "
37716 "program, such as kernel log messages.  You can register a callback to "
37717 "receive these messages."
37718 msgstr ""
37719
37720 #. type: =head1
37721 #: ../src/guestfs.pod:2360
37722 msgid "INTERNALS"
37723 msgstr ""
37724
37725 #. type: =head2
37726 #: ../src/guestfs.pod:2362
37727 msgid "APPLIANCE BOOT PROCESS"
37728 msgstr ""
37729
37730 #. type: textblock
37731 #: ../src/guestfs.pod:2364
37732 msgid ""
37733 "This process has evolved and continues to evolve.  The description here "
37734 "corresponds only to the current version of libguestfs and is provided for "
37735 "information only."
37736 msgstr ""
37737
37738 #. type: textblock
37739 #: ../src/guestfs.pod:2368
37740 msgid ""
37741 "In order to follow the stages involved below, enable libguestfs debugging "
37742 "(set the environment variable C<LIBGUESTFS_DEBUG=1>)."
37743 msgstr ""
37744
37745 #. type: =item
37746 #: ../src/guestfs.pod:2373
37747 msgid "Create the appliance"
37748 msgstr ""
37749
37750 #. type: textblock
37751 #: ../src/guestfs.pod:2375
37752 msgid ""
37753 "C<febootstrap-supermin-helper> is invoked to create the kernel, a small "
37754 "initrd and the appliance."
37755 msgstr ""
37756
37757 #. type: textblock
37758 #: ../src/guestfs.pod:2378
37759 msgid ""
37760 "The appliance is cached in C</var/tmp/.guestfs-E<lt>UIDE<gt>> (or in another "
37761 "directory if C<TMPDIR> is set)."
37762 msgstr ""
37763
37764 #. type: textblock
37765 #: ../src/guestfs.pod:2381
37766 msgid ""
37767 "For a complete description of how the appliance is created and cached, read "
37768 "the L<febootstrap(8)> and L<febootstrap-supermin-helper(8)> man pages."
37769 msgstr ""
37770
37771 #. type: =item
37772 #: ../src/guestfs.pod:2385
37773 msgid "Start qemu and boot the kernel"
37774 msgstr ""
37775
37776 #. type: textblock
37777 #: ../src/guestfs.pod:2387
37778 msgid "qemu is invoked to boot the kernel."
37779 msgstr ""
37780
37781 #. type: =item
37782 #: ../src/guestfs.pod:2389
37783 msgid "Run the initrd"
37784 msgstr ""
37785
37786 #. type: textblock
37787 #: ../src/guestfs.pod:2391
37788 msgid ""
37789 "C<febootstrap-supermin-helper> builds a small initrd.  The initrd is not the "
37790 "appliance.  The purpose of the initrd is to load enough kernel modules in "
37791 "order that the appliance itself can be mounted and started."
37792 msgstr ""
37793
37794 #. type: textblock
37795 #: ../src/guestfs.pod:2395
37796 msgid ""
37797 "The initrd is a cpio archive called "
37798 "C</var/tmp/.guestfs-E<lt>UIDE<gt>/initrd>."
37799 msgstr ""
37800
37801 #. type: textblock
37802 #: ../src/guestfs.pod:2398
37803 msgid ""
37804 "When the initrd has started you will see messages showing that kernel "
37805 "modules are being loaded, similar to this:"
37806 msgstr ""
37807
37808 #. type: verbatim
37809 #: ../src/guestfs.pod:2401
37810 #, no-wrap
37811 msgid ""
37812 " febootstrap: ext2 mini initrd starting up\n"
37813 " febootstrap: mounting /sys\n"
37814 " febootstrap: internal insmod libcrc32c.ko\n"
37815 " febootstrap: internal insmod crc32c-intel.ko\n"
37816 "\n"
37817 msgstr ""
37818
37819 #. type: =item
37820 #: ../src/guestfs.pod:2406
37821 msgid "Find and mount the appliance device"
37822 msgstr ""
37823
37824 #. type: textblock
37825 #: ../src/guestfs.pod:2408
37826 msgid ""
37827 "The appliance is a sparse file containing an ext2 filesystem which contains "
37828 "a familiar (although reduced in size) Linux operating system.  It would "
37829 "normally be called C</var/tmp/.guestfs-E<lt>UIDE<gt>/root>."
37830 msgstr ""
37831
37832 #. type: textblock
37833 #: ../src/guestfs.pod:2412
37834 msgid ""
37835 "The regular disks being inspected by libguestfs are the first devices "
37836 "exposed by qemu (eg. as C</dev/vda>)."
37837 msgstr ""
37838
37839 #. type: textblock
37840 #: ../src/guestfs.pod:2415
37841 msgid ""
37842 "The last disk added to qemu is the appliance itself (eg. C</dev/vdb> if "
37843 "there was only one regular disk)."
37844 msgstr ""
37845
37846 #. type: textblock
37847 #: ../src/guestfs.pod:2418
37848 msgid ""
37849 "Thus the final job of the initrd is to locate the appliance disk, mount it, "
37850 "and switch root into the appliance, and run C</init> from the appliance."
37851 msgstr ""
37852
37853 #. type: textblock
37854 #: ../src/guestfs.pod:2422
37855 msgid "If this works successfully you will see messages such as:"
37856 msgstr ""
37857
37858 #. type: verbatim
37859 #: ../src/guestfs.pod:2424
37860 #, no-wrap
37861 msgid ""
37862 " febootstrap: picked /sys/block/vdb/dev as root device\n"
37863 " febootstrap: creating /dev/root as block special 252:16\n"
37864 " febootstrap: mounting new root on /root\n"
37865 " febootstrap: chroot\n"
37866 " Starting /init script ...\n"
37867 "\n"
37868 msgstr ""
37869
37870 #. type: textblock
37871 #: ../src/guestfs.pod:2430
37872 msgid ""
37873 "Note that C<Starting /init script ...> indicates that the appliance's init "
37874 "script is now running."
37875 msgstr ""
37876
37877 #. type: =item
37878 #: ../src/guestfs.pod:2433
37879 msgid "Initialize the appliance"
37880 msgstr ""
37881
37882 #. type: textblock
37883 #: ../src/guestfs.pod:2435
37884 msgid ""
37885 "The appliance itself now initializes itself.  This involves starting certain "
37886 "processes like C<udev>, possibly printing some debug information, and "
37887 "finally running the daemon (C<guestfsd>)."
37888 msgstr ""
37889
37890 #. type: =item
37891 #: ../src/guestfs.pod:2439
37892 msgid "The daemon"
37893 msgstr ""
37894
37895 #. type: textblock
37896 #: ../src/guestfs.pod:2441
37897 msgid ""
37898 "Finally the daemon (C<guestfsd>) runs inside the appliance.  If it runs you "
37899 "should see:"
37900 msgstr ""
37901
37902 #. type: verbatim
37903 #: ../src/guestfs.pod:2444
37904 #, no-wrap
37905 msgid ""
37906 " verbose daemon enabled\n"
37907 "\n"
37908 msgstr ""
37909
37910 #. type: textblock
37911 #: ../src/guestfs.pod:2446
37912 msgid ""
37913 "The daemon expects to see a named virtio-serial port exposed by qemu and "
37914 "connected on the other end to the library."
37915 msgstr ""
37916
37917 #. type: textblock
37918 #: ../src/guestfs.pod:2449
37919 msgid ""
37920 "The daemon connects to this port (and hence to the library) and sends a four "
37921 "byte message C<GUESTFS_LAUNCH_FLAG>, which initiates the communication "
37922 "protocol (see below)."
37923 msgstr ""
37924
37925 #. type: =head2
37926 #: ../src/guestfs.pod:2455
37927 msgid "COMMUNICATION PROTOCOL"
37928 msgstr ""
37929
37930 #. type: textblock
37931 #: ../src/guestfs.pod:2457
37932 msgid ""
37933 "Don't rely on using this protocol directly.  This section documents how it "
37934 "currently works, but it may change at any time."
37935 msgstr ""
37936
37937 #. type: textblock
37938 #: ../src/guestfs.pod:2460
37939 msgid ""
37940 "The protocol used to talk between the library and the daemon running inside "
37941 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
37942 "1014, RFC 1832, RFC 4506)."
37943 msgstr ""
37944
37945 #. type: textblock
37946 #: ../src/guestfs.pod:2464
37947 msgid ""
37948 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
37949 "this file is automatically generated)."
37950 msgstr ""
37951
37952 #. type: textblock
37953 #: ../src/guestfs.pod:2467
37954 msgid ""
37955 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
37956 "and C<FileOut> parameters, which are handled with very simple request/reply "
37957 "messages.  Then there are functions that have any C<FileIn> or C<FileOut> "
37958 "parameters, which use the same request and reply messages, but they may also "
37959 "be followed by files sent using a chunked encoding."
37960 msgstr ""
37961
37962 #. type: =head3
37963 #: ../src/guestfs.pod:2474
37964 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
37965 msgstr ""
37966
37967 #. type: textblock
37968 #: ../src/guestfs.pod:2476
37969 msgid "For ordinary functions, the request message is:"
37970 msgstr ""
37971
37972 #. type: verbatim
37973 #: ../src/guestfs.pod:2478
37974 #, no-wrap
37975 msgid ""
37976 " total length (header + arguments,\n"
37977 "      but not including the length word itself)\n"
37978 " struct guestfs_message_header (encoded as XDR)\n"
37979 " struct guestfs_<foo>_args (encoded as XDR)\n"
37980 "\n"
37981 msgstr ""
37982
37983 #. type: textblock
37984 #: ../src/guestfs.pod:2483
37985 msgid ""
37986 "The total length field allows the daemon to allocate a fixed size buffer "
37987 "into which it slurps the rest of the message.  As a result, the total length "
37988 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
37989 "effective size of any request is limited to somewhere under this size."
37990 msgstr ""
37991
37992 #. type: textblock
37993 #: ../src/guestfs.pod:2489
37994 msgid ""
37995 "Note also that many functions don't take any arguments, in which case the "
37996 "C<guestfs_I<foo>_args> is completely omitted."
37997 msgstr ""
37998
37999 #. type: textblock
38000 #: ../src/guestfs.pod:2492
38001 msgid ""
38002 "The header contains the procedure number (C<guestfs_proc>) which is how the "
38003 "receiver knows what type of args structure to expect, or none at all."
38004 msgstr ""
38005
38006 #. type: textblock
38007 #: ../src/guestfs.pod:2496
38008 msgid ""
38009 "For functions that take optional arguments, the optional arguments are "
38010 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
38011 "arguments.  A bitmask in the header indicates which optional arguments are "
38012 "meaningful.  The bitmask is also checked to see if it contains bits set "
38013 "which the daemon does not know about (eg. if more optional arguments were "
38014 "added in a later version of the library), and this causes the call to be "
38015 "rejected."
38016 msgstr ""
38017
38018 #. type: textblock
38019 #: ../src/guestfs.pod:2504
38020 msgid "The reply message for ordinary functions is:"
38021 msgstr ""
38022
38023 #. type: verbatim
38024 #: ../src/guestfs.pod:2506
38025 #, no-wrap
38026 msgid ""
38027 " total length (header + ret,\n"
38028 "      but not including the length word itself)\n"
38029 " struct guestfs_message_header (encoded as XDR)\n"
38030 " struct guestfs_<foo>_ret (encoded as XDR)\n"
38031 "\n"
38032 msgstr ""
38033
38034 #. type: textblock
38035 #: ../src/guestfs.pod:2511
38036 msgid ""
38037 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
38038 "functions that return no formal return values."
38039 msgstr ""
38040
38041 #. type: textblock
38042 #: ../src/guestfs.pod:2514
38043 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
38044 msgstr ""
38045
38046 #. type: textblock
38047 #: ../src/guestfs.pod:2517
38048 msgid ""
38049 "In the case of an error, a flag is set in the header, and the reply message "
38050 "is slightly changed:"
38051 msgstr ""
38052
38053 #. type: verbatim
38054 #: ../src/guestfs.pod:2520
38055 #, no-wrap
38056 msgid ""
38057 " total length (header + error,\n"
38058 "      but not including the length word itself)\n"
38059 " struct guestfs_message_header (encoded as XDR)\n"
38060 " struct guestfs_message_error (encoded as XDR)\n"
38061 "\n"
38062 msgstr ""
38063
38064 #. type: textblock
38065 #: ../src/guestfs.pod:2525
38066 msgid ""
38067 "The C<guestfs_message_error> structure contains the error message as a "
38068 "string."
38069 msgstr ""
38070
38071 #. type: =head3
38072 #: ../src/guestfs.pod:2528
38073 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
38074 msgstr ""
38075
38076 #. type: textblock
38077 #: ../src/guestfs.pod:2530
38078 msgid ""
38079 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest.  "
38080 "The normal request message is sent (see above).  However this is followed by "
38081 "a sequence of file chunks."
38082 msgstr ""
38083
38084 #. type: verbatim
38085 #: ../src/guestfs.pod:2534
38086 #, no-wrap
38087 msgid ""
38088 " total length (header + arguments,\n"
38089 "      but not including the length word itself,\n"
38090 "      and not including the chunks)\n"
38091 " struct guestfs_message_header (encoded as XDR)\n"
38092 " struct guestfs_<foo>_args (encoded as XDR)\n"
38093 " sequence of chunks for FileIn param #0\n"
38094 " sequence of chunks for FileIn param #1 etc.\n"
38095 "\n"
38096 msgstr ""
38097
38098 #. type: textblock
38099 #: ../src/guestfs.pod:2542
38100 msgid "The \"sequence of chunks\" is:"
38101 msgstr ""
38102
38103 #. type: verbatim
38104 #: ../src/guestfs.pod:2544
38105 #, no-wrap
38106 msgid ""
38107 " length of chunk (not including length word itself)\n"
38108 " struct guestfs_chunk (encoded as XDR)\n"
38109 " length of chunk\n"
38110 " struct guestfs_chunk (encoded as XDR)\n"
38111 "   ...\n"
38112 " length of chunk\n"
38113 " struct guestfs_chunk (with data.data_len == 0)\n"
38114 "\n"
38115 msgstr ""
38116
38117 #. type: textblock
38118 #: ../src/guestfs.pod:2552
38119 msgid ""
38120 "The final chunk has the C<data_len> field set to zero.  Additionally a flag "
38121 "is set in the final chunk to indicate either successful completion or early "
38122 "cancellation."
38123 msgstr ""
38124
38125 #. type: textblock
38126 #: ../src/guestfs.pod:2556
38127 msgid ""
38128 "At time of writing there are no functions that have more than one FileIn "
38129 "parameter.  However this is (theoretically) supported, by sending the "
38130 "sequence of chunks for each FileIn parameter one after another (from left to "
38131 "right)."
38132 msgstr ""
38133
38134 #. type: textblock
38135 #: ../src/guestfs.pod:2561
38136 msgid ""
38137 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
38138 "transfer.  The library does this by sending a chunk with a special flag set "
38139 "to indicate cancellation.  When the daemon sees this, it cancels the whole "
38140 "RPC, does I<not> send any reply, and goes back to reading the next request."
38141 msgstr ""
38142
38143 #. type: textblock
38144 #: ../src/guestfs.pod:2567
38145 msgid ""
38146 "The daemon may also cancel.  It does this by writing a special word "
38147 "C<GUESTFS_CANCEL_FLAG> to the socket.  The library listens for this during "
38148 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
38149 "cancel chunk).  The special word is chosen so that even if cancellation "
38150 "happens right at the end of the transfer (after the library has finished "
38151 "writing and has started listening for the reply), the \"spurious\" cancel "
38152 "flag will not be confused with the reply message."
38153 msgstr ""
38154
38155 #. type: textblock
38156 #: ../src/guestfs.pod:2576
38157 msgid ""
38158 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
38159 "limit), and also files where the size is not known in advance (eg. from "
38160 "pipes or sockets).  However the chunks are rather small "
38161 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
38162 "to keep much in memory."
38163 msgstr ""
38164
38165 #. type: =head3
38166 #: ../src/guestfs.pod:2582
38167 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
38168 msgstr ""
38169
38170 #. type: textblock
38171 #: ../src/guestfs.pod:2584
38172 msgid ""
38173 "The protocol for FileOut parameters is exactly the same as for FileIn "
38174 "parameters, but with the roles of daemon and library reversed."
38175 msgstr ""
38176
38177 #. type: verbatim
38178 #: ../src/guestfs.pod:2587
38179 #, no-wrap
38180 msgid ""
38181 " total length (header + ret,\n"
38182 "      but not including the length word itself,\n"
38183 "      and not including the chunks)\n"
38184 " struct guestfs_message_header (encoded as XDR)\n"
38185 " struct guestfs_<foo>_ret (encoded as XDR)\n"
38186 " sequence of chunks for FileOut param #0\n"
38187 " sequence of chunks for FileOut param #1 etc.\n"
38188 "\n"
38189 msgstr ""
38190
38191 #. type: =head3
38192 #: ../src/guestfs.pod:2595
38193 msgid "INITIAL MESSAGE"
38194 msgstr ""
38195
38196 #. type: textblock
38197 #: ../src/guestfs.pod:2597
38198 msgid ""
38199 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
38200 "which indicates that the guest and daemon is alive.  This is what "
38201 "L</guestfs_launch> waits for."
38202 msgstr ""
38203
38204 #. type: =head3
38205 #: ../src/guestfs.pod:2601
38206 msgid "PROGRESS NOTIFICATION MESSAGES"
38207 msgstr ""
38208
38209 #. type: textblock
38210 #: ../src/guestfs.pod:2603
38211 msgid ""
38212 "The daemon may send progress notification messages at any time.  These are "
38213 "distinguished by the normal length word being replaced by "
38214 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
38215 msgstr ""
38216
38217 #. type: textblock
38218 #: ../src/guestfs.pod:2607
38219 msgid ""
38220 "The library turns them into progress callbacks (see "
38221 "L</GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards "
38222 "them if not."
38223 msgstr ""
38224
38225 #. type: textblock
38226 #: ../src/guestfs.pod:2611
38227 msgid ""
38228 "The daemon self-limits the frequency of progress messages it sends (see "
38229 "C<daemon/proto.c:notify_progress>).  Not all calls generate progress "
38230 "messages."
38231 msgstr ""
38232
38233 #. type: =head1
38234 #: ../src/guestfs.pod:2615
38235 msgid "LIBGUESTFS VERSION NUMBERS"
38236 msgstr ""
38237
38238 #. type: textblock
38239 #: ../src/guestfs.pod:2617
38240 msgid ""
38241 "Since April 2010, libguestfs has started to make separate development and "
38242 "stable releases, along with corresponding branches in our git repository.  "
38243 "These separate releases can be identified by version number:"
38244 msgstr ""
38245
38246 #. type: verbatim
38247 #: ../src/guestfs.pod:2622
38248 #, no-wrap
38249 msgid ""
38250 "                 even numbers for stable: 1.2.x, 1.4.x, ...\n"
38251 "       .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
38252 "       |\n"
38253 "       v\n"
38254 " 1  .  3  .  5\n"
38255 " ^           ^\n"
38256 " |           |\n"
38257 " |           `-------- sub-version\n"
38258 " |\n"
38259 " `------ always '1' because we don't change the ABI\n"
38260 "\n"
38261 msgstr ""
38262
38263 #. type: textblock
38264 #: ../src/guestfs.pod:2633
38265 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
38266 msgstr ""
38267
38268 #. type: textblock
38269 #: ../src/guestfs.pod:2635
38270 msgid ""
38271 "As time passes we cherry pick fixes from the development branch and backport "
38272 "those into the stable branch, the effect being that the stable branch should "
38273 "get more stable and less buggy over time.  So the stable releases are ideal "
38274 "for people who don't need new features but would just like the software to "
38275 "work."
38276 msgstr ""
38277
38278 #. type: textblock
38279 #: ../src/guestfs.pod:2641
38280 msgid "Our criteria for backporting changes are:"
38281 msgstr ""
38282
38283 #. type: textblock
38284 #: ../src/guestfs.pod:2647
38285 msgid ""
38286 "Documentation changes which don't affect any code are backported unless the "
38287 "documentation refers to a future feature which is not in stable."
38288 msgstr ""
38289
38290 #. type: textblock
38291 #: ../src/guestfs.pod:2653
38292 msgid ""
38293 "Bug fixes which are not controversial, fix obvious problems, and have been "
38294 "well tested are backported."
38295 msgstr ""
38296
38297 #. type: textblock
38298 #: ../src/guestfs.pod:2658
38299 msgid ""
38300 "Simple rearrangements of code which shouldn't affect how it works get "
38301 "backported.  This is so that the code in the two branches doesn't get too "
38302 "far out of step, allowing us to backport future fixes more easily."
38303 msgstr ""
38304
38305 #. type: textblock
38306 #: ../src/guestfs.pod:2664
38307 msgid ""
38308 "We I<don't> backport new features, new APIs, new tools etc, except in one "
38309 "exceptional case: the new feature is required in order to implement an "
38310 "important bug fix."
38311 msgstr ""
38312
38313 #. type: textblock
38314 #: ../src/guestfs.pod:2670
38315 msgid ""
38316 "A new stable branch starts when we think the new features in development are "
38317 "substantial and compelling enough over the current stable branch to warrant "
38318 "it.  When that happens we create new stable and development versions 1.N.0 "
38319 "and 1.(N+1).0 [N is even].  The new dot-oh release won't necessarily be so "
38320 "stable at this point, but by backporting fixes from development, that branch "
38321 "will stabilize over time."
38322 msgstr ""
38323
38324 #. type: =head1
38325 #: ../src/guestfs.pod:2678
38326 msgid "EXTENDING LIBGUESTFS"
38327 msgstr ""
38328
38329 #. type: =head2
38330 #: ../src/guestfs.pod:2680
38331 msgid "ADDING A NEW API ACTION"
38332 msgstr ""
38333
38334 #. type: textblock
38335 #: ../src/guestfs.pod:2682
38336 msgid ""
38337 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
38338 "documentation) are generated, and this makes it easy to extend the "
38339 "libguestfs API."
38340 msgstr ""
38341
38342 #. type: textblock
38343 #: ../src/guestfs.pod:2686
38344 msgid "To add a new API action there are two changes:"
38345 msgstr ""
38346
38347 #. type: textblock
38348 #: ../src/guestfs.pod:2692
38349 msgid ""
38350 "You need to add a description of the call (name, parameters, return type, "
38351 "tests, documentation) to C<generator/generator_actions.ml>."
38352 msgstr ""
38353
38354 #. type: textblock
38355 #: ../src/guestfs.pod:2695
38356 msgid ""
38357 "There are two sorts of API action, depending on whether the call goes "
38358 "through to the daemon in the appliance, or is serviced entirely by the "
38359 "library (see L</ARCHITECTURE> above).  L</guestfs_sync> is an example of the "
38360 "former, since the sync is done in the appliance.  L</guestfs_set_trace> is "
38361 "an example of the latter, since a trace flag is maintained in the handle and "
38362 "all tracing is done on the library side."
38363 msgstr ""
38364
38365 #. type: textblock
38366 #: ../src/guestfs.pod:2703
38367 msgid ""
38368 "Most new actions are of the first type, and get added to the "
38369 "C<daemon_functions> list.  Each function has a unique procedure number used "
38370 "in the RPC protocol which is assigned to that action when we publish "
38371 "libguestfs and cannot be reused.  Take the latest procedure number and "
38372 "increment it."
38373 msgstr ""
38374
38375 #. type: textblock
38376 #: ../src/guestfs.pod:2709
38377 msgid ""
38378 "For library-only actions of the second type, add to the "
38379 "C<non_daemon_functions> list.  Since these functions are serviced by the "
38380 "library and do not travel over the RPC mechanism to the daemon, these "
38381 "functions do not need a procedure number, and so the procedure number is set "
38382 "to C<-1>."
38383 msgstr ""
38384
38385 #. type: textblock
38386 #: ../src/guestfs.pod:2717
38387 msgid "Implement the action (in C):"
38388 msgstr ""
38389
38390 #. type: textblock
38391 #: ../src/guestfs.pod:2719
38392 msgid ""
38393 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
38394 "C<daemon/> directory."
38395 msgstr ""
38396
38397 #. type: textblock
38398 #: ../src/guestfs.pod:2722
38399 msgid ""
38400 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
38401 "(note: double underscore) in the C<src/> directory."
38402 msgstr ""
38403
38404 #. type: textblock
38405 #: ../src/guestfs.pod:2725
38406 msgid "In either case, use another function as an example of what to do."
38407 msgstr ""
38408
38409 #. type: textblock
38410 #: ../src/guestfs.pod:2729
38411 msgid "After making these changes, use C<make> to compile."
38412 msgstr ""
38413
38414 #. type: textblock
38415 #: ../src/guestfs.pod:2731
38416 msgid ""
38417 "Note that you don't need to implement the RPC, language bindings, manual "
38418 "pages or anything else.  It's all automatically generated from the OCaml "
38419 "description."
38420 msgstr ""
38421
38422 #. type: =head2
38423 #: ../src/guestfs.pod:2735
38424 msgid "ADDING TESTS FOR AN API ACTION"
38425 msgstr ""
38426
38427 #. type: textblock
38428 #: ../src/guestfs.pod:2737
38429 msgid ""
38430 "You can supply zero or as many tests as you want per API call.  The tests "
38431 "can either be added as part of the API description "
38432 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
38433 "drop a script into C<regressions/>.  Note that adding a script to "
38434 "C<regressions/> is slower, so if possible use the first method."
38435 msgstr ""
38436
38437 #. type: textblock
38438 #: ../src/guestfs.pod:2743
38439 msgid ""
38440 "The following describes the test environment used when you add an API test "
38441 "in C<generator_actions.ml>."
38442 msgstr ""
38443
38444 #. type: textblock
38445 #: ../src/guestfs.pod:2746
38446 msgid "The test environment has 4 block devices:"
38447 msgstr ""
38448
38449 #. type: =item
38450 #: ../src/guestfs.pod:2750
38451 msgid "C</dev/sda> 500MB"
38452 msgstr ""
38453
38454 #. type: textblock
38455 #: ../src/guestfs.pod:2752
38456 msgid "General block device for testing."
38457 msgstr ""
38458
38459 #. type: =item
38460 #: ../src/guestfs.pod:2754
38461 msgid "C</dev/sdb> 50MB"
38462 msgstr ""
38463
38464 #. type: textblock
38465 #: ../src/guestfs.pod:2756
38466 msgid ""
38467 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
38468 "operations."
38469 msgstr ""
38470
38471 #. type: =item
38472 #: ../src/guestfs.pod:2759
38473 msgid "C</dev/sdc> 10MB"
38474 msgstr ""
38475
38476 #. type: textblock
38477 #: ../src/guestfs.pod:2761
38478 msgid "Used in a few tests where two block devices are needed."
38479 msgstr ""
38480
38481 #. type: =item
38482 #: ../src/guestfs.pod:2763
38483 msgid "C</dev/sdd>"
38484 msgstr ""
38485
38486 #. type: textblock
38487 #: ../src/guestfs.pod:2765
38488 msgid "ISO with fixed content (see C<images/test.iso>)."
38489 msgstr ""
38490
38491 #. type: textblock
38492 #: ../src/guestfs.pod:2769
38493 msgid ""
38494 "To be able to run the tests in a reasonable amount of time, the libguestfs "
38495 "appliance and block devices are reused between tests.  So don't try testing "
38496 "L</guestfs_kill_subprocess> :-x"
38497 msgstr ""
38498
38499 #. type: textblock
38500 #: ../src/guestfs.pod:2773
38501 msgid ""
38502 "Each test starts with an initial scenario, selected using one of the "
38503 "C<Init*> expressions, described in C<generator/generator_types.ml>.  These "
38504 "initialize the disks mentioned above in a particular way as documented in "
38505 "C<generator_types.ml>.  You should not assume anything about the previous "
38506 "contents of other disks that are not initialized."
38507 msgstr ""
38508
38509 #. type: textblock
38510 #: ../src/guestfs.pod:2779
38511 msgid ""
38512 "You can add a prerequisite clause to any individual test.  This is a "
38513 "run-time check, which, if it fails, causes the test to be skipped.  Useful "
38514 "if testing a command which might not work on all variations of libguestfs "
38515 "builds.  A test that has prerequisite of C<Always> means to run "
38516 "unconditionally."
38517 msgstr ""
38518
38519 #. type: textblock
38520 #: ../src/guestfs.pod:2785
38521 msgid ""
38522 "In addition, packagers can skip individual tests by setting environment "
38523 "variables before running C<make check>."
38524 msgstr ""
38525
38526 #. type: verbatim
38527 #: ../src/guestfs.pod:2788
38528 #, no-wrap
38529 msgid ""
38530 " SKIP_TEST_<CMD>_<NUM>=1\n"
38531 "\n"
38532 msgstr ""
38533
38534 #. type: textblock
38535 #: ../src/guestfs.pod:2790
38536 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
38537 msgstr ""
38538
38539 #. type: textblock
38540 #: ../src/guestfs.pod:2792
38541 msgid "or:"
38542 msgstr ""
38543
38544 #. type: verbatim
38545 #: ../src/guestfs.pod:2794
38546 #, no-wrap
38547 msgid ""
38548 " SKIP_TEST_<CMD>=1\n"
38549 "\n"
38550 msgstr ""
38551
38552 #. type: textblock
38553 #: ../src/guestfs.pod:2796
38554 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
38555 msgstr ""
38556
38557 #. type: textblock
38558 #: ../src/guestfs.pod:2798
38559 msgid "Packagers can run only certain tests by setting for example:"
38560 msgstr ""
38561
38562 #. type: verbatim
38563 #: ../src/guestfs.pod:2800
38564 #, no-wrap
38565 msgid ""
38566 " TEST_ONLY=\"vfs_type zerofree\"\n"
38567 "\n"
38568 msgstr ""
38569
38570 #. type: textblock
38571 #: ../src/guestfs.pod:2802
38572 msgid ""
38573 "See C<capitests/tests.c> for more details of how these environment variables "
38574 "work."
38575 msgstr ""
38576
38577 #. type: =head2
38578 #: ../src/guestfs.pod:2805
38579 msgid "DEBUGGING NEW API ACTIONS"
38580 msgstr ""
38581
38582 #. type: textblock
38583 #: ../src/guestfs.pod:2807
38584 msgid "Test new actions work before submitting them."
38585 msgstr ""
38586
38587 #. type: textblock
38588 #: ../src/guestfs.pod:2809
38589 msgid "You can use guestfish to try out new commands."
38590 msgstr ""
38591
38592 #. type: textblock
38593 #: ../src/guestfs.pod:2811
38594 msgid ""
38595 "Debugging the daemon is a problem because it runs inside a minimal "
38596 "environment.  However you can fprintf messages in the daemon to stderr, and "
38597 "they will show up if you use C<guestfish -v>."
38598 msgstr ""
38599
38600 #. type: =head2
38601 #: ../src/guestfs.pod:2815
38602 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
38603 msgstr ""
38604
38605 #. type: textblock
38606 #: ../src/guestfs.pod:2817
38607 msgid ""
38608 "Our C source code generally adheres to some basic code-formatting "
38609 "conventions.  The existing code base is not totally consistent on this "
38610 "front, but we do prefer that contributed code be formatted similarly.  In "
38611 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
38612 "indentation level, and other than that, follow the K&R style."
38613 msgstr ""
38614
38615 #. type: textblock
38616 #: ../src/guestfs.pod:2823
38617 msgid ""
38618 "If you use Emacs, add the following to one of one of your start-up files "
38619 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
38620 msgstr ""
38621
38622 #. type: verbatim
38623 #: ../src/guestfs.pod:2826
38624 #, no-wrap
38625 msgid ""
38626 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
38627 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
38628 " (add-hook 'find-file-hook\n"
38629 "     '(lambda () (if (and buffer-file-name\n"
38630 "                          (string-match \"/libguestfs\\\\>\"\n"
38631 "                              (buffer-file-name))\n"
38632 "                          (not (string-equal mode-name \"Change Log\"))\n"
38633 "                          (not (string-equal mode-name \"Makefile\")))\n"
38634 "                     (setq indent-tabs-mode nil))))\n"
38635 " \n"
38636 msgstr ""
38637
38638 #. type: verbatim
38639 #: ../src/guestfs.pod:2836
38640 #, no-wrap
38641 msgid ""
38642 " ;;; When editing C sources in libguestfs, use this style.\n"
38643 " (defun libguestfs-c-mode ()\n"
38644 "   \"C mode with adjusted defaults for use with libguestfs.\"\n"
38645 "   (interactive)\n"
38646 "   (c-set-style \"K&R\")\n"
38647 "   (setq c-indent-level 2)\n"
38648 "   (setq c-basic-offset 2))\n"
38649 " (add-hook 'c-mode-hook\n"
38650 "           '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
38651 "                               (buffer-file-name))\n"
38652 "                           (libguestfs-c-mode))))\n"
38653 "\n"
38654 msgstr ""
38655
38656 #. type: textblock
38657 #: ../src/guestfs.pod:2848
38658 msgid "Enable warnings when compiling (and fix any problems this finds):"
38659 msgstr ""
38660
38661 #. type: verbatim
38662 #: ../src/guestfs.pod:2851
38663 #, no-wrap
38664 msgid ""
38665 " ./configure --enable-gcc-warnings\n"
38666 "\n"
38667 msgstr ""
38668
38669 #. type: textblock
38670 #: ../src/guestfs.pod:2853
38671 msgid "Useful targets are:"
38672 msgstr ""
38673
38674 #. type: verbatim
38675 #: ../src/guestfs.pod:2855
38676 #, no-wrap
38677 msgid ""
38678 " make syntax-check  # checks the syntax of the C code\n"
38679 " make check         # runs the test suite\n"
38680 "\n"
38681 msgstr ""
38682
38683 #. type: =head2
38684 #: ../src/guestfs.pod:2858
38685 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
38686 msgstr ""
38687
38688 #. type: textblock
38689 #: ../src/guestfs.pod:2860
38690 msgid ""
38691 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
38692 "which are used to do shell quoting."
38693 msgstr ""
38694
38695 #. type: =item
38696 #: ../src/guestfs.pod:2865
38697 msgid "%Q"
38698 msgstr ""
38699
38700 #. type: textblock
38701 #: ../src/guestfs.pod:2867
38702 msgid ""
38703 "Simple shell quoted string.  Any spaces or other shell characters are "
38704 "escaped for you."
38705 msgstr ""
38706
38707 #. type: =item
38708 #: ../src/guestfs.pod:2870
38709 msgid "%R"
38710 msgstr ""
38711
38712 #. type: textblock
38713 #: ../src/guestfs.pod:2872
38714 msgid ""
38715 "Same as C<%Q> except the string is treated as a path which is prefixed by "
38716 "the sysroot."
38717 msgstr ""
38718
38719 #. type: verbatim
38720 #: ../src/guestfs.pod:2879
38721 #, no-wrap
38722 msgid ""
38723 " asprintf (&cmd, \"cat %R\", path);\n"
38724 "\n"
38725 msgstr ""
38726
38727 #. type: textblock
38728 #: ../src/guestfs.pod:2881
38729 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
38730 msgstr ""
38731
38732 #. type: textblock
38733 #: ../src/guestfs.pod:2883
38734 msgid ""
38735 "I<Note:> Do I<not> use these when you are passing parameters to the "
38736 "C<command{,r,v,rv}()> functions.  These parameters do NOT need to be quoted "
38737 "because they are not passed via the shell (instead, straight to exec).  You "
38738 "probably want to use the C<sysroot_path()> function however."
38739 msgstr ""
38740
38741 #. type: =head2
38742 #: ../src/guestfs.pod:2889
38743 msgid "SUBMITTING YOUR NEW API ACTIONS"
38744 msgstr ""
38745
38746 #. type: textblock
38747 #: ../src/guestfs.pod:2891
38748 msgid ""
38749 "Submit patches to the mailing list: "
38750 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
38751 "L<rjones@redhat.com>."
38752 msgstr ""
38753
38754 #. type: =head2
38755 #: ../src/guestfs.pod:2895
38756 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
38757 msgstr ""
38758
38759 #. type: textblock
38760 #: ../src/guestfs.pod:2897
38761 msgid "We support i18n (gettext anyhow) in the library."
38762 msgstr ""
38763
38764 #. type: textblock
38765 #: ../src/guestfs.pod:2899
38766 msgid ""
38767 "However many messages come from the daemon, and we don't translate those at "
38768 "the moment.  One reason is that the appliance generally has all locale files "
38769 "removed from it, because they take up a lot of space.  So we'd have to readd "
38770 "some of those, as well as copying our PO files into the appliance."
38771 msgstr ""
38772
38773 #. type: textblock
38774 #: ../src/guestfs.pod:2905
38775 msgid ""
38776 "Debugging messages are never translated, since they are intended for the "
38777 "programmers."
38778 msgstr ""
38779
38780 #. type: =head2
38781 #: ../src/guestfs.pod:2908
38782 msgid "SOURCE CODE SUBDIRECTORIES"
38783 msgstr ""
38784
38785 #. type: =item
38786 #: ../src/guestfs.pod:2912
38787 msgid "C<align>"
38788 msgstr ""
38789
38790 #. type: textblock
38791 #: ../src/guestfs.pod:2914
38792 msgid "L<virt-alignment-scan(1)> command and documentation."
38793 msgstr ""
38794
38795 #. type: textblock
38796 #: ../src/guestfs.pod:2918
38797 msgid "The libguestfs appliance, build scripts and so on."
38798 msgstr ""
38799
38800 #. type: =item
38801 #: ../src/guestfs.pod:2920
38802 msgid "C<capitests>"
38803 msgstr ""
38804
38805 #. type: textblock
38806 #: ../src/guestfs.pod:2922
38807 msgid "Automated tests of the C API."
38808 msgstr ""
38809
38810 #. type: =item
38811 #: ../src/guestfs.pod:2924
38812 msgid "C<cat>"
38813 msgstr ""
38814
38815 #. type: textblock
38816 #: ../src/guestfs.pod:2926
38817 msgid ""
38818 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
38819 "documentation."
38820 msgstr ""
38821
38822 #. type: =item
38823 #: ../src/guestfs.pod:2929
38824 msgid "C<caution>"
38825 msgstr ""
38826
38827 #. type: textblock
38828 #: ../src/guestfs.pod:2931
38829 msgid ""
38830 "Safety and liveness tests of components that libguestfs depends upon (not of "
38831 "libguestfs itself).  Mainly this is for qemu and the kernel."
38832 msgstr ""
38833
38834 #. type: =item
38835 #: ../src/guestfs.pod:2934
38836 msgid "C<clone>"
38837 msgstr ""
38838
38839 #. type: textblock
38840 #: ../src/guestfs.pod:2936
38841 msgid ""
38842 "Tools for cloning virtual machines.  Currently contains L<virt-sysprep(1)> "
38843 "command and documentation."
38844 msgstr ""
38845
38846 #. type: =item
38847 #: ../src/guestfs.pod:2939
38848 msgid "C<contrib>"
38849 msgstr ""
38850
38851 #. type: textblock
38852 #: ../src/guestfs.pod:2941
38853 msgid "Outside contributions, experimental parts."
38854 msgstr ""
38855
38856 #. type: =item
38857 #: ../src/guestfs.pod:2943
38858 msgid "C<daemon>"
38859 msgstr ""
38860
38861 #. type: textblock
38862 #: ../src/guestfs.pod:2945
38863 msgid ""
38864 "The daemon that runs inside the libguestfs appliance and carries out "
38865 "actions."
38866 msgstr ""
38867
38868 #. type: =item
38869 #: ../src/guestfs.pod:2948
38870 msgid "C<df>"
38871 msgstr ""
38872
38873 #. type: textblock
38874 #: ../src/guestfs.pod:2950
38875 msgid "L<virt-df(1)> command and documentation."
38876 msgstr ""
38877
38878 #. type: =item
38879 #: ../src/guestfs.pod:2952
38880 msgid "C<edit>"
38881 msgstr ""
38882
38883 #. type: textblock
38884 #: ../src/guestfs.pod:2954
38885 msgid "L<virt-edit(1)> command and documentation."
38886 msgstr ""
38887
38888 #. type: =item
38889 #: ../src/guestfs.pod:2956
38890 msgid "C<examples>"
38891 msgstr ""
38892
38893 #. type: textblock
38894 #: ../src/guestfs.pod:2958
38895 msgid "C API example code."
38896 msgstr ""
38897
38898 #. type: =item
38899 #: ../src/guestfs.pod:2960
38900 msgid "C<fish>"
38901 msgstr ""
38902
38903 #. type: textblock
38904 #: ../src/guestfs.pod:2962
38905 msgid ""
38906 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
38907 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
38908 "L<virt-tar-out(1)>."
38909 msgstr ""
38910
38911 #. type: =item
38912 #: ../src/guestfs.pod:2966
38913 msgid "C<fuse>"
38914 msgstr ""
38915
38916 #. type: textblock
38917 #: ../src/guestfs.pod:2968
38918 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
38919 msgstr ""
38920
38921 #. type: =item
38922 #: ../src/guestfs.pod:2970
38923 msgid "C<generator>"
38924 msgstr ""
38925
38926 #. type: textblock
38927 #: ../src/guestfs.pod:2972
38928 msgid ""
38929 "The crucially important generator, used to automatically generate large "
38930 "amounts of boilerplate C code for things like RPC and bindings."
38931 msgstr ""
38932
38933 #. type: =item
38934 #: ../src/guestfs.pod:2975
38935 msgid "C<images>"
38936 msgstr ""
38937
38938 #. type: textblock
38939 #: ../src/guestfs.pod:2977
38940 msgid "Files used by the test suite."
38941 msgstr ""
38942
38943 #. type: textblock
38944 #: ../src/guestfs.pod:2979
38945 msgid "Some \"phony\" guest images which we test against."
38946 msgstr ""
38947
38948 #. type: =item
38949 #: ../src/guestfs.pod:2981
38950 msgid "C<inspector>"
38951 msgstr ""
38952
38953 #. type: textblock
38954 #: ../src/guestfs.pod:2983
38955 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
38956 msgstr ""
38957
38958 #. type: =item
38959 #: ../src/guestfs.pod:2985
38960 msgid "C<logo>"
38961 msgstr ""
38962
38963 #. type: textblock
38964 #: ../src/guestfs.pod:2987
38965 msgid "Logo used on the website.  The fish is called Arthur by the way."
38966 msgstr ""
38967
38968 #. type: =item
38969 #: ../src/guestfs.pod:2989
38970 msgid "C<m4>"
38971 msgstr ""
38972
38973 #. type: textblock
38974 #: ../src/guestfs.pod:2991
38975 msgid "M4 macros used by autoconf."
38976 msgstr ""
38977
38978 #. type: =item
38979 #: ../src/guestfs.pod:2993
38980 msgid "C<po>"
38981 msgstr ""
38982
38983 #. type: textblock
38984 #: ../src/guestfs.pod:2995
38985 msgid "Translations of simple gettext strings."
38986 msgstr ""
38987
38988 #. type: =item
38989 #: ../src/guestfs.pod:2997
38990 msgid "C<po-docs>"
38991 msgstr ""
38992
38993 #. type: textblock
38994 #: ../src/guestfs.pod:2999
38995 msgid ""
38996 "The build infrastructure and PO files for translations of manpages and POD "
38997 "files.  Eventually this will be combined with the C<po> directory, but that "
38998 "is rather complicated."
38999 msgstr ""
39000
39001 #. type: =item
39002 #: ../src/guestfs.pod:3003
39003 msgid "C<regressions>"
39004 msgstr ""
39005
39006 #. type: textblock
39007 #: ../src/guestfs.pod:3005
39008 msgid "Regression tests."
39009 msgstr ""
39010
39011 #. type: =item
39012 #: ../src/guestfs.pod:3007
39013 msgid "C<rescue>"
39014 msgstr ""
39015
39016 #. type: textblock
39017 #: ../src/guestfs.pod:3009
39018 msgid "L<virt-rescue(1)> command and documentation."
39019 msgstr ""
39020
39021 #. type: =item
39022 #: ../src/guestfs.pod:3011
39023 msgid "C<resize>"
39024 msgstr ""
39025
39026 #. type: textblock
39027 #: ../src/guestfs.pod:3013
39028 msgid "L<virt-resize(1)> command and documentation."
39029 msgstr ""
39030
39031 #. type: =item
39032 #: ../src/guestfs.pod:3015
39033 msgid "C<sparsify>"
39034 msgstr ""
39035
39036 #. type: textblock
39037 #: ../src/guestfs.pod:3017
39038 msgid "L<virt-sparsify(1)> command and documentation."
39039 msgstr ""
39040
39041 #. type: =item
39042 #: ../src/guestfs.pod:3019
39043 msgid "C<src>"
39044 msgstr ""
39045
39046 #. type: textblock
39047 #: ../src/guestfs.pod:3021
39048 msgid "Source code to the C library."
39049 msgstr ""
39050
39051 #. type: =item
39052 #: ../src/guestfs.pod:3023
39053 msgid "C<tools>"
39054 msgstr ""
39055
39056 #. type: textblock
39057 #: ../src/guestfs.pod:3025
39058 msgid "Command line tools written in Perl (L<virt-win-reg(1)> and many others)."
39059 msgstr ""
39060
39061 #. type: =item
39062 #: ../src/guestfs.pod:3027
39063 msgid "C<test-tool>"
39064 msgstr ""
39065
39066 #. type: textblock
39067 #: ../src/guestfs.pod:3029
39068 msgid ""
39069 "Test tool for end users to test if their qemu/kernel combination will work "
39070 "with libguestfs."
39071 msgstr ""
39072
39073 #. type: =item
39074 #: ../src/guestfs.pod:3032
39075 msgid "C<csharp>"
39076 msgstr ""
39077
39078 #. type: =item
39079 #: ../src/guestfs.pod:3034
39080 msgid "C<erlang>"
39081 msgstr ""
39082
39083 #. type: =item
39084 #: ../src/guestfs.pod:3036
39085 msgid "C<haskell>"
39086 msgstr ""
39087
39088 #. type: =item
39089 #: ../src/guestfs.pod:3038
39090 msgid "C<java>"
39091 msgstr ""
39092
39093 #. type: =item
39094 #: ../src/guestfs.pod:3040
39095 msgid "C<ocaml>"
39096 msgstr ""
39097
39098 #. type: =item
39099 #: ../src/guestfs.pod:3042
39100 msgid "C<php>"
39101 msgstr ""
39102
39103 #. type: =item
39104 #: ../src/guestfs.pod:3044
39105 msgid "C<perl>"
39106 msgstr ""
39107
39108 #. type: =item
39109 #: ../src/guestfs.pod:3046
39110 msgid "C<python>"
39111 msgstr ""
39112
39113 #. type: =item
39114 #: ../src/guestfs.pod:3048
39115 msgid "C<ruby>"
39116 msgstr ""
39117
39118 #. type: textblock
39119 #: ../src/guestfs.pod:3050
39120 msgid "Language bindings."
39121 msgstr ""
39122
39123 #. type: =head2
39124 #: ../src/guestfs.pod:3054
39125 msgid "MAKING A STABLE RELEASE"
39126 msgstr ""
39127
39128 #. type: textblock
39129 #: ../src/guestfs.pod:3056
39130 msgid ""
39131 "When we make a stable release, there are several steps documented here.  See "
39132 "L</LIBGUESTFS VERSION NUMBERS> for general information about the stable "
39133 "branch policy."
39134 msgstr ""
39135
39136 #. type: textblock
39137 #: ../src/guestfs.pod:3064
39138 msgid "Check C<make && make check> works on at least Fedora, Debian and Ubuntu."
39139 msgstr ""
39140
39141 #. type: textblock
39142 #: ../src/guestfs.pod:3069
39143 msgid "Finalize RELEASE-NOTES."
39144 msgstr ""
39145
39146 #. type: textblock
39147 #: ../src/guestfs.pod:3073
39148 msgid "Update ROADMAP."
39149 msgstr ""
39150
39151 #. type: textblock
39152 #: ../src/guestfs.pod:3077
39153 msgid "Run C<src/api-support/update-from-tarballs.sh>."
39154 msgstr ""
39155
39156 #. type: textblock
39157 #: ../src/guestfs.pod:3081
39158 msgid "Push and pull from Transifex."
39159 msgstr ""
39160
39161 #. type: textblock
39162 #: ../src/guestfs.pod:3083
39163 msgid "Run:"
39164 msgstr ""
39165
39166 #. type: verbatim
39167 #: ../src/guestfs.pod:3085
39168 #, no-wrap
39169 msgid ""
39170 " tx push -s\n"
39171 "\n"
39172 msgstr ""
39173
39174 #. type: textblock
39175 #: ../src/guestfs.pod:3087
39176 msgid "to push the latest POT files to Transifex.  Then run:"
39177 msgstr ""
39178
39179 #. type: verbatim
39180 #: ../src/guestfs.pod:3089
39181 #, no-wrap
39182 msgid ""
39183 " ./tx-pull.sh\n"
39184 "\n"
39185 msgstr ""
39186
39187 #. type: textblock
39188 #: ../src/guestfs.pod:3091
39189 msgid "which is a wrapper to pull the latest translated C<*.po> files."
39190 msgstr ""
39191
39192 #. type: textblock
39193 #: ../src/guestfs.pod:3095
39194 msgid ""
39195 "Create new stable and development directories under "
39196 "L<http://libguestfs.org/download>."
39197 msgstr ""
39198
39199 #. type: textblock
39200 #: ../src/guestfs.pod:3100
39201 msgid "Create the branch in git:"
39202 msgstr ""
39203
39204 #. type: verbatim
39205 #: ../src/guestfs.pod:3102
39206 #, no-wrap
39207 msgid ""
39208 " git tag -a 1.XX.0 -m \"Version 1.XX.0 (stable)\"\n"
39209 " git tag -a 1.YY.0 -m \"Version 1.YY.0 (development)\"\n"
39210 " git branch stable-1.XX\n"
39211 " git push origin tag 1.XX.0 1.YY.0 stable-1.XX\n"
39212 "\n"
39213 msgstr ""
39214
39215 #. type: =head1
39216 #: ../src/guestfs.pod:3109
39217 msgid "LIMITS"
39218 msgstr ""
39219
39220 #. type: =head2
39221 #: ../src/guestfs.pod:3111
39222 msgid "PROTOCOL LIMITS"
39223 msgstr ""
39224
39225 #. type: textblock
39226 #: ../src/guestfs.pod:3113
39227 msgid ""
39228 "Internally libguestfs uses a message-based protocol to pass API calls and "
39229 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
39230 "plenty more detail about this).  The maximum message size used by the "
39231 "protocol is slightly less than 4 MB.  For some API calls you may need to be "
39232 "aware of this limit.  The API calls which may be affected are individually "
39233 "documented, with a link back to this section of the documentation."
39234 msgstr ""
39235
39236 #. type: textblock
39237 #: ../src/guestfs.pod:3121
39238 msgid ""
39239 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
39240 "a simple string.  Because this string is at some point internally encoded as "
39241 "a message, the maximum size that it can return is slightly under 4 MB.  If "
39242 "the requested file is larger than this then you will get an error."
39243 msgstr ""
39244
39245 #. type: textblock
39246 #: ../src/guestfs.pod:3127
39247 msgid ""
39248 "In order to transfer large files into and out of the guest filesystem, you "
39249 "need to use particular calls that support this.  The sections L</UPLOADING> "
39250 "and L</DOWNLOADING> document how to do this."
39251 msgstr ""
39252
39253 #. type: textblock
39254 #: ../src/guestfs.pod:3131
39255 msgid ""
39256 "You might also consider mounting the disk image using our FUSE filesystem "
39257 "support (L<guestmount(1)>)."
39258 msgstr ""
39259
39260 #. type: =head2
39261 #: ../src/guestfs.pod:3134
39262 msgid "MAXIMUM NUMBER OF DISKS"
39263 msgstr ""
39264
39265 #. type: textblock
39266 #: ../src/guestfs.pod:3136
39267 msgid "When using virtio disks (the default) the current limit is B<25> disks."
39268 msgstr ""
39269
39270 #. type: textblock
39271 #: ../src/guestfs.pod:3139
39272 msgid ""
39273 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
39274 "slots.  However febootstrap only understands disks with names C</dev/vda> "
39275 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
39276 "purposes."
39277 msgstr ""
39278
39279 #. type: textblock
39280 #: ../src/guestfs.pod:3144
39281 msgid ""
39282 "We are working to substantially raise this limit in future versions but it "
39283 "requires complex changes to qemu."
39284 msgstr ""
39285
39286 #. type: textblock
39287 #: ../src/guestfs.pod:3147
39288 msgid ""
39289 "In future versions of libguestfs it should also be possible to \"hot plug\" "
39290 "disks (add and remove disks after calling L</guestfs_launch>).  This also "
39291 "requires changes to qemu."
39292 msgstr ""
39293
39294 #. type: =head2
39295 #: ../src/guestfs.pod:3151
39296 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
39297 msgstr ""
39298
39299 #. type: textblock
39300 #: ../src/guestfs.pod:3153
39301 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
39302 msgstr ""
39303
39304 #. type: textblock
39305 #: ../src/guestfs.pod:3155
39306 msgid ""
39307 "This is because it reserves 4 bits for the minor device number (thus "
39308 "C</dev/vda>, and C</dev/vda1> through C</dev/vda15>)."
39309 msgstr ""
39310
39311 #. type: textblock
39312 #: ../src/guestfs.pod:3158
39313 msgid ""
39314 "If you attach a disk with more than 15 partitions, the extra partitions are "
39315 "ignored by libguestfs."
39316 msgstr ""
39317
39318 #. type: =head2
39319 #: ../src/guestfs.pod:3161
39320 msgid "MAXIMUM SIZE OF A DISK"
39321 msgstr ""
39322
39323 #. type: textblock
39324 #: ../src/guestfs.pod:3163
39325 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
39326 msgstr ""
39327
39328 #. type: textblock
39329 #: ../src/guestfs.pod:3165
39330 msgid ""
39331 "We have tested block devices up to 1 exabyte (2**60 or "
39332 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
39333 "filesystem."
39334 msgstr ""
39335
39336 #. type: textblock
39337 #: ../src/guestfs.pod:3169
39338 msgid ""
39339 "Although libguestfs probably does not impose any limit, the underlying host "
39340 "storage will.  If you store disk images on a host ext4 filesystem, then the "
39341 "maximum size will be limited by the maximum ext4 file size (currently 16 "
39342 "TB).  If you store disk images as host logical volumes then you are limited "
39343 "by the maximum size of an LV."
39344 msgstr ""
39345
39346 #. type: textblock
39347 #: ../src/guestfs.pod:3175
39348 msgid ""
39349 "For the hugest disk image files, we recommend using XFS on the host for "
39350 "storage."
39351 msgstr ""
39352
39353 #. type: =head2
39354 #: ../src/guestfs.pod:3178
39355 msgid "MAXIMUM SIZE OF A PARTITION"
39356 msgstr ""
39357
39358 #. type: textblock
39359 #: ../src/guestfs.pod:3180
39360 msgid ""
39361 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
39362 "numbers.  Assuming a 512 byte sector size, this means that MBR cannot "
39363 "address a partition located beyond 2 TB on the disk."
39364 msgstr ""
39365
39366 #. type: textblock
39367 #: ../src/guestfs.pod:3184
39368 msgid ""
39369 "It is recommended that you use GPT partitions on disks which are larger than "
39370 "this size.  GPT uses 64 bit sector numbers and so can address partitions "
39371 "which are theoretically larger than the largest disk we could support."
39372 msgstr ""
39373
39374 #. type: =head2
39375 #: ../src/guestfs.pod:3189
39376 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
39377 msgstr ""
39378
39379 #. type: textblock
39380 #: ../src/guestfs.pod:3191
39381 msgid ""
39382 "This depends on the filesystem type.  libguestfs itself does not impose any "
39383 "known limit.  Consult Wikipedia or the filesystem documentation to find out "
39384 "what these limits are."
39385 msgstr ""
39386
39387 #. type: =head2
39388 #: ../src/guestfs.pod:3195
39389 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
39390 msgstr ""
39391
39392 #. type: textblock
39393 #: ../src/guestfs.pod:3197
39394 msgid ""
39395 "The API functions L</guestfs_upload>, L</guestfs_download>, "
39396 "L</guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
39397 "uploads and downloads."
39398 msgstr ""
39399
39400 #. type: =head2
39401 #: ../src/guestfs.pod:3201
39402 msgid "INSPECTION LIMITS"
39403 msgstr ""
39404
39405 #. type: textblock
39406 #: ../src/guestfs.pod:3203
39407 msgid ""
39408 "The inspection code has several arbitrary limits on things like the size of "
39409 "Windows Registry hive it will read, and the length of product name.  These "
39410 "are intended to stop a malicious guest from consuming arbitrary amounts of "
39411 "memory and disk space on the host, and should not be reached in practice.  "
39412 "See the source code for more information."
39413 msgstr ""
39414
39415 #. type: textblock
39416 #: ../src/guestfs.pod:3229
39417 msgid ""
39418 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages.  This has the same "
39419 "effect as calling C<guestfs_set_verbose (g, 1)>."
39420 msgstr ""
39421
39422 #. type: textblock
39423 #: ../src/guestfs.pod:3241
39424 msgid ""
39425 "Set the path that libguestfs uses to search for a supermin appliance.  See "
39426 "the discussion of paths in section L</PATH> above."
39427 msgstr ""
39428
39429 #. type: textblock
39430 #: ../src/guestfs.pod:3250
39431 msgid "See also L</QEMU WRAPPERS> above."
39432 msgstr ""
39433
39434 #. type: textblock
39435 #: ../src/guestfs.pod:3254
39436 msgid ""
39437 "Set C<LIBGUESTFS_TRACE=1> to enable command traces.  This has the same "
39438 "effect as calling C<guestfs_set_trace (g, 1)>."
39439 msgstr ""
39440
39441 #. type: textblock
39442 #: ../src/guestfs.pod:3272
39443 msgid ""
39444 "L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-java(3)>, "
39445 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
39446 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, "
39447 "L<virt-alignment-scan(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
39448 "L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)>, "
39449 "L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
39450 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
39451 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-sparsify(1)>, "
39452 "L<virt-sysprep(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, "
39453 "L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, "
39454 "L<febootstrap-supermin-helper(8)>, L<hivex(3)>, L<stap(1)>, "
39455 "L<http://libguestfs.org/>."
39456 msgstr ""
39457
39458 #. type: textblock
39459 #: ../src/guestfs.pod:3308
39460 msgid ""
39461 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
39462 "L<lvm(8)>, L<disktype(1)>."
39463 msgstr ""
39464
39465 #. type: =head1
39466 #: ../src/guestfs.pod:3315 ../tools/virt-make-fs.pl:571 ../tools/virt-win-reg.pl:772
39467 msgid "BUGS"
39468 msgstr ""
39469
39470 #. type: textblock
39471 #: ../src/guestfs.pod:3317
39472 msgid "To get a list of bugs against libguestfs use this link:"
39473 msgstr ""
39474
39475 #. type: textblock
39476 #: ../src/guestfs.pod:3319
39477 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
39478 msgstr ""
39479
39480 #. type: textblock
39481 #: ../src/guestfs.pod:3321
39482 msgid "To report a new bug against libguestfs use this link:"
39483 msgstr ""
39484
39485 #. type: textblock
39486 #: ../src/guestfs.pod:3323
39487 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
39488 msgstr ""
39489
39490 #. type: textblock
39491 #: ../src/guestfs.pod:3325
39492 msgid "When reporting a bug, please check:"
39493 msgstr ""
39494
39495 #. type: textblock
39496 #: ../src/guestfs.pod:3331
39497 msgid "That the bug hasn't been reported already."
39498 msgstr ""
39499
39500 #. type: textblock
39501 #: ../src/guestfs.pod:3335
39502 msgid "That you are testing a recent version."
39503 msgstr ""
39504
39505 #. type: textblock
39506 #: ../src/guestfs.pod:3339
39507 msgid "Describe the bug accurately, and give a way to reproduce it."
39508 msgstr ""
39509
39510 #. type: textblock
39511 #: ../src/guestfs.pod:3343
39512 msgid ""
39513 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
39514 "bug report."
39515 msgstr ""
39516
39517 #. type: textblock
39518 #: ../test-tool/libguestfs-test-tool.pod:5
39519 msgid "libguestfs-test-tool - Diagnostics for libguestfs"
39520 msgstr ""
39521
39522 #. type: verbatim
39523 #: ../test-tool/libguestfs-test-tool.pod:9
39524 #, no-wrap
39525 msgid ""
39526 " libguestfs-test-tool [--options]\n"
39527 "\n"
39528 msgstr ""
39529
39530 #. type: textblock
39531 #: ../test-tool/libguestfs-test-tool.pod:13
39532 msgid ""
39533 "libguestfs-test-tool is a test program shipped with libguestfs to allow you "
39534 "to check basic libguestfs functionality is working.  This is needed because "
39535 "libguestfs occasionally breaks for reasons beyond our control: usually "
39536 "because of changes in the underlying qemu or kernel packages, or the host "
39537 "environment."
39538 msgstr ""
39539
39540 #. type: textblock
39541 #: ../test-tool/libguestfs-test-tool.pod:19
39542 msgid "If you suspect a problem in libguestfs, then just run:"
39543 msgstr ""
39544
39545 #. type: verbatim
39546 #: ../test-tool/libguestfs-test-tool.pod:21
39547 #, no-wrap
39548 msgid ""
39549 " libguestfs-test-tool\n"
39550 "\n"
39551 msgstr ""
39552
39553 #. type: textblock
39554 #: ../test-tool/libguestfs-test-tool.pod:23
39555 msgid "It will print lots of diagnostic messages."
39556 msgstr ""
39557
39558 #. type: textblock
39559 #: ../test-tool/libguestfs-test-tool.pod:25
39560 msgid "If it runs to completion successfully, you will see this near the end:"
39561 msgstr ""
39562
39563 #. type: verbatim
39564 #: ../test-tool/libguestfs-test-tool.pod:27
39565 #, no-wrap
39566 msgid ""
39567 " ===== TEST FINISHED OK =====\n"
39568 "\n"
39569 msgstr ""
39570
39571 #. type: textblock
39572 #: ../test-tool/libguestfs-test-tool.pod:29
39573 msgid "and the test tool will exit with code 0."
39574 msgstr ""
39575
39576 #. type: textblock
39577 #: ../test-tool/libguestfs-test-tool.pod:31
39578 msgid ""
39579 "If it fails (and/or exits with non-zero error code), please paste the "
39580 "I<complete, unedited> output of the test tool into a bug report.  More "
39581 "information about reporting bugs can be found on the "
39582 "L<http://libguestfs.org/> website."
39583 msgstr ""
39584
39585 #. type: textblock
39586 #: ../test-tool/libguestfs-test-tool.pod:42
39587 msgid "Display short usage information and exit."
39588 msgstr ""
39589
39590 #. type: =item
39591 #: ../test-tool/libguestfs-test-tool.pod:44
39592 msgid "B<--qemu qemu_binary>"
39593 msgstr ""
39594
39595 #. type: textblock
39596 #: ../test-tool/libguestfs-test-tool.pod:46
39597 msgid ""
39598 "If you have downloaded another qemu binary, point this option at the full "
39599 "path of the binary to try it."
39600 msgstr ""
39601
39602 #. type: =item
39603 #: ../test-tool/libguestfs-test-tool.pod:49
39604 msgid "B<--qemudir qemu_source_dir>"
39605 msgstr ""
39606
39607 #. type: textblock
39608 #: ../test-tool/libguestfs-test-tool.pod:51
39609 msgid ""
39610 "If you have compiled qemu from source, point this option at the source "
39611 "directory to try it."
39612 msgstr ""
39613
39614 #. type: =item
39615 #: ../test-tool/libguestfs-test-tool.pod:54
39616 msgid "B<-t N>"
39617 msgstr ""
39618
39619 #. type: =item
39620 #: ../test-tool/libguestfs-test-tool.pod:56
39621 msgid "B<--timeout N>"
39622 msgstr ""
39623
39624 #. type: textblock
39625 #: ../test-tool/libguestfs-test-tool.pod:58
39626 msgid ""
39627 "Set the launch timeout to C<N> seconds.  The default is 600 seconds (10 "
39628 "minutes) which does not usually need to be adjusted."
39629 msgstr ""
39630
39631 #. type: =head1
39632 #: ../test-tool/libguestfs-test-tool.pod:63
39633 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
39634 msgstr ""
39635
39636 #. type: textblock
39637 #: ../test-tool/libguestfs-test-tool.pod:65
39638 msgid ""
39639 "If you have compiled another version of qemu from source and would like to "
39640 "try that, then you can use the I<--qemudir> option to point to the qemu "
39641 "source directory."
39642 msgstr ""
39643
39644 #. type: textblock
39645 #: ../test-tool/libguestfs-test-tool.pod:69
39646 msgid ""
39647 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
39648 "option to point to the binary."
39649 msgstr ""
39650
39651 #. type: textblock
39652 #: ../test-tool/libguestfs-test-tool.pod:72
39653 msgid ""
39654 "Note when using these options, you can ignore the business of qemu wrapper "
39655 "scripts (L<guestfs(3)/QEMU WRAPPERS>), since libguestfs-test-tool writes a "
39656 "wrapper script for you if one is needed."
39657 msgstr ""
39658
39659 #. type: =head1
39660 #: ../test-tool/libguestfs-test-tool.pod:76
39661 msgid "TRYING OUT A DIFFERENT KERNEL"
39662 msgstr ""
39663
39664 #. type: textblock
39665 #: ../test-tool/libguestfs-test-tool.pod:78
39666 msgid ""
39667 "If you are using febootstrap E<ge> 3.8 then you can select which kernel "
39668 "libguestfs tries.  You do this by setting the environment variables "
39669 "C<FEBOOTSTRAP_KERNEL> and/or C<FEBOOTSTRAP_MODULES>."
39670 msgstr ""
39671
39672 #. type: textblock
39673 #: ../test-tool/libguestfs-test-tool.pod:82
39674 msgid ""
39675 "Refer to L<febootstrap-supermin-helper(8)/ENVIRONMENT VARIABLES> for further "
39676 "information."
39677 msgstr ""
39678
39679 #. type: =head1
39680 #: ../test-tool/libguestfs-test-tool.pod:85
39681 msgid "SELF-DIAGNOSIS"
39682 msgstr ""
39683
39684 #. type: textblock
39685 #: ../test-tool/libguestfs-test-tool.pod:87
39686 msgid ""
39687 "Refer to L<guestfs(3)/APPLIANCE BOOT PROCESS> to understand the messages "
39688 "produced by libguestfs-test-tool and/or possible errors."
39689 msgstr ""
39690
39691 #. type: textblock
39692 #: ../test-tool/libguestfs-test-tool.pod:92
39693 msgid ""
39694 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
39695 "I<1> if there was an error."
39696 msgstr ""
39697
39698 #. type: textblock
39699 #: ../test-tool/libguestfs-test-tool.pod:97
39700 msgid ""
39701 "For the full list of environment variables which may affect libguestfs, "
39702 "please see the L<guestfs(3)> manual page."
39703 msgstr ""
39704
39705 #. type: textblock
39706 #: ../test-tool/libguestfs-test-tool.pod:102
39707 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
39708 msgstr ""
39709
39710 #. type: textblock
39711 #: ../tools/virt-list-filesystems.pl:32
39712 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
39713 msgstr ""
39714
39715 #. type: verbatim
39716 #: ../tools/virt-list-filesystems.pl:36
39717 #, no-wrap
39718 msgid ""
39719 " virt-list-filesystems [--options] domname\n"
39720 "\n"
39721 msgstr ""
39722
39723 #. type: verbatim
39724 #: ../tools/virt-list-filesystems.pl:38
39725 #, no-wrap
39726 msgid ""
39727 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
39728 "\n"
39729 msgstr ""
39730
39731 #. type: textblock
39732 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
39733 msgid ""
39734 "This tool is obsolete.  Use L<virt-filesystems(1)> as a more flexible "
39735 "replacement."
39736 msgstr ""
39737
39738 #. type: textblock
39739 #: ../tools/virt-list-filesystems.pl:45
39740 msgid ""
39741 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
39742 "are contained in a virtual machine or disk image."
39743 msgstr ""
39744
39745 #. type: textblock
39746 #: ../tools/virt-list-filesystems.pl:49
39747 msgid ""
39748 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
39749 "functionality.  For more complex cases you should look at the "
39750 "L<guestfish(1)> tool."
39751 msgstr ""
39752
39753 #. type: textblock
39754 #: ../tools/virt-list-filesystems.pl:112
39755 msgid ""
39756 "With this option, C<virt-list-filesystems> displays the type of each "
39757 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
39758 msgstr ""
39759
39760 #. type: =item
39761 #: ../tools/virt-list-filesystems.pl:119
39762 msgid "B<-a>"
39763 msgstr ""
39764
39765 #. type: textblock
39766 #: ../tools/virt-list-filesystems.pl:123
39767 msgid ""
39768 "Normally we only show mountable filesystems.  If this option is given then "
39769 "swap devices are shown too."
39770 msgstr ""
39771
39772 #. type: textblock
39773 #: ../tools/virt-list-filesystems.pl:197
39774 msgid ""
39775 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
39776 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
39777 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
39778 msgstr ""
39779
39780 #. type: textblock
39781 #: ../tools/virt-list-filesystems.pl:214 ../tools/virt-tar.pl:317
39782 msgid "Copyright (C) 2009 Red Hat Inc."
39783 msgstr ""
39784
39785 #. type: textblock
39786 #: ../tools/virt-list-partitions.pl:32
39787 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
39788 msgstr ""
39789
39790 #. type: verbatim
39791 #: ../tools/virt-list-partitions.pl:36
39792 #, no-wrap
39793 msgid ""
39794 " virt-list-partitions [--options] domname\n"
39795 "\n"
39796 msgstr ""
39797
39798 #. type: verbatim
39799 #: ../tools/virt-list-partitions.pl:38
39800 #, no-wrap
39801 msgid ""
39802 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
39803 "\n"
39804 msgstr ""
39805
39806 #. type: textblock
39807 #: ../tools/virt-list-partitions.pl:45
39808 msgid ""
39809 "C<virt-list-partitions> is a command line tool to list the partitions that "
39810 "are contained in a virtual machine or disk image.  It is mainly useful as a "
39811 "first step to using L<virt-resize(1)>."
39812 msgstr ""
39813
39814 #. type: textblock
39815 #: ../tools/virt-list-partitions.pl:50
39816 msgid ""
39817 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
39818 "functionality.  For more complex cases you should look at the "
39819 "L<guestfish(1)> tool."
39820 msgstr ""
39821
39822 #. type: textblock
39823 #: ../tools/virt-list-partitions.pl:113
39824 msgid "Show sizes in human-readable form (eg. \"1G\")."
39825 msgstr ""
39826
39827 #. type: textblock
39828 #: ../tools/virt-list-partitions.pl:123
39829 msgid ""
39830 "With this option, C<virt-list-partitions> displays the type and size of each "
39831 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
39832 msgstr ""
39833
39834 #. type: =item
39835 #: ../tools/virt-list-partitions.pl:130
39836 msgid "B<-t>"
39837 msgstr ""
39838
39839 #. type: =item
39840 #: ../tools/virt-list-partitions.pl:132
39841 msgid "B<--total>"
39842 msgstr ""
39843
39844 #. type: textblock
39845 #: ../tools/virt-list-partitions.pl:134
39846 msgid "Display the total size of each block device (as a separate row or rows)."
39847 msgstr ""
39848
39849 #. type: textblock
39850 #: ../tools/virt-list-partitions.pl:267
39851 msgid ""
39852 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
39853 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
39854 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
39855 msgstr ""
39856
39857 #. type: textblock
39858 #: ../tools/virt-list-partitions.pl:283
39859 msgid "Copyright (C) 2009-2010 Red Hat Inc."
39860 msgstr ""
39861
39862 #. type: textblock
39863 #: ../tools/virt-make-fs.pl:37
39864 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
39865 msgstr ""
39866
39867 #. type: verbatim
39868 #: ../tools/virt-make-fs.pl:41
39869 #, no-wrap
39870 msgid ""
39871 " virt-make-fs [--options] input.tar output.img\n"
39872 "\n"
39873 msgstr ""
39874
39875 #. type: verbatim
39876 #: ../tools/virt-make-fs.pl:43
39877 #, no-wrap
39878 msgid ""
39879 " virt-make-fs [--options] input.tar.gz output.img\n"
39880 "\n"
39881 msgstr ""
39882
39883 #. type: verbatim
39884 #: ../tools/virt-make-fs.pl:45
39885 #, no-wrap
39886 msgid ""
39887 " virt-make-fs [--options] directory output.img\n"
39888 "\n"
39889 msgstr ""
39890
39891 #. type: textblock
39892 #: ../tools/virt-make-fs.pl:49
39893 msgid ""
39894 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
39895 "archive or some files in a directory.  It is similar to tools like "
39896 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>.  Unlike those tools, "
39897 "it can create common filesystem types like ext2/3 or NTFS, which can be "
39898 "useful if you want to attach these filesystems to existing virtual machines "
39899 "(eg. to import large amounts of read-only data to a VM)."
39900 msgstr ""
39901
39902 #. type: textblock
39903 #: ../tools/virt-make-fs.pl:57
39904 msgid "Basic usage is:"
39905 msgstr ""
39906
39907 #. type: verbatim
39908 #: ../tools/virt-make-fs.pl:59
39909 #, no-wrap
39910 msgid ""
39911 " virt-make-fs input output.img\n"
39912 "\n"
39913 msgstr ""
39914
39915 #. type: textblock
39916 #: ../tools/virt-make-fs.pl:61
39917 msgid ""
39918 "where C<input> is either a directory containing files that you want to add, "
39919 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
39920 "C<output.img> is a disk image.  The input type is detected automatically.  "
39921 "The output disk image defaults to a raw ext2 sparse image unless you specify "
39922 "extra flags (see L</OPTIONS> below)."
39923 msgstr ""
39924
39925 #. type: =head2
39926 #: ../tools/virt-make-fs.pl:67
39927 msgid "FILESYSTEM TYPE"
39928 msgstr ""
39929
39930 #. type: textblock
39931 #: ../tools/virt-make-fs.pl:69
39932 msgid ""
39933 "The default filesystem type is C<ext2>.  Just about any filesystem type that "
39934 "libguestfs supports can be used (but I<not> read-only formats like "
39935 "ISO9660).  Here are some of the more common choices:"
39936 msgstr ""
39937
39938 #. type: =item
39939 #: ../tools/virt-make-fs.pl:75
39940 msgid "I<ext3>"
39941 msgstr ""
39942
39943 #. type: textblock
39944 #: ../tools/virt-make-fs.pl:77
39945 msgid ""
39946 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size.  If "
39947 "you are not going to use the filesystem in a way that requires the journal, "
39948 "then this is just wasted overhead."
39949 msgstr ""
39950
39951 #. type: =item
39952 #: ../tools/virt-make-fs.pl:81
39953 msgid "I<ntfs> or I<vfat>"
39954 msgstr ""
39955
39956 #. type: textblock
39957 #: ../tools/virt-make-fs.pl:83
39958 msgid "Useful if exporting data to a Windows guest."
39959 msgstr ""
39960
39961 #. type: textblock
39962 #: ../tools/virt-make-fs.pl:85
39963 msgid ""
39964 "I<Note for vfat>: The tar archive or local directory must only contain files "
39965 "which are owned by root (ie. UID:GID = 0:0).  The reason is that the tar "
39966 "program running within libguestfs is unable to change the ownership of "
39967 "non-root files, since vfat itself does not support this."
39968 msgstr ""
39969
39970 #. type: =item
39971 #: ../tools/virt-make-fs.pl:90
39972 msgid "I<minix>"
39973 msgstr ""
39974
39975 #. type: textblock
39976 #: ../tools/virt-make-fs.pl:92
39977 msgid ""
39978 "Lower overhead than C<ext2>, but certain limitations on filename length and "
39979 "total filesystem size."
39980 msgstr ""
39981
39982 #. type: =head3
39983 #: ../tools/virt-make-fs.pl:97 ../tools/virt-make-fs.pl:116 ../tools/virt-make-fs.pl:149
39984 msgid "EXAMPLE"
39985 msgstr ""
39986
39987 #. type: verbatim
39988 #: ../tools/virt-make-fs.pl:99
39989 #, no-wrap
39990 msgid ""
39991 " virt-make-fs --type=minix input minixfs.img\n"
39992 "\n"
39993 msgstr ""
39994
39995 #. type: =head2
39996 #: ../tools/virt-make-fs.pl:101
39997 msgid "TO PARTITION OR NOT TO PARTITION"
39998 msgstr ""
39999
40000 #. type: textblock
40001 #: ../tools/virt-make-fs.pl:103
40002 msgid "Optionally virt-make-fs can add a partition table to the output disk."
40003 msgstr ""
40004
40005 #. type: textblock
40006 #: ../tools/virt-make-fs.pl:105
40007 msgid ""
40008 "Adding a partition can make the disk image more compatible with certain "
40009 "virtualized operating systems which don't expect to see a filesystem "
40010 "directly located on a block device (Linux doesn't care and will happily "
40011 "handle both types)."
40012 msgstr ""
40013
40014 #. type: textblock
40015 #: ../tools/virt-make-fs.pl:110
40016 msgid ""
40017 "On the other hand, if you have a partition table then the output image is no "
40018 "longer a straight filesystem.  For example you cannot run L<fsck(8)> "
40019 "directly on a partitioned disk image.  (However libguestfs tools such as "
40020 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
40021 msgstr ""
40022
40023 #. type: textblock
40024 #: ../tools/virt-make-fs.pl:118
40025 msgid "Add an MBR partition:"
40026 msgstr ""
40027
40028 #. type: verbatim
40029 #: ../tools/virt-make-fs.pl:120
40030 #, no-wrap
40031 msgid ""
40032 " virt-make-fs --partition -- input disk.img\n"
40033 "\n"
40034 msgstr ""
40035
40036 #. type: textblock
40037 #: ../tools/virt-make-fs.pl:122
40038 msgid ""
40039 "If the output disk image could be terabyte-sized or larger, it's better to "
40040 "use an EFI/GPT-compatible partition table:"
40041 msgstr ""
40042
40043 #. type: verbatim
40044 #: ../tools/virt-make-fs.pl:125
40045 #, no-wrap
40046 msgid ""
40047 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
40048 "\n"
40049 msgstr ""
40050
40051 #. type: =head2
40052 #: ../tools/virt-make-fs.pl:127
40053 msgid "EXTRA SPACE"
40054 msgstr ""
40055
40056 #. type: textblock
40057 #: ../tools/virt-make-fs.pl:129
40058 msgid ""
40059 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
40060 "the files that it contains, but might have extra space.  Depending on how "
40061 "you are going to use the output, you might think this extra space is wasted "
40062 "and want to minimize it, or you might want to leave space so that more files "
40063 "can be added later.  Virt-make-fs defaults to minimizing the extra space, "
40064 "but you can use the I<--size> flag to leave space in the filesystem if you "
40065 "want it."
40066 msgstr ""
40067
40068 #. type: textblock
40069 #: ../tools/virt-make-fs.pl:137
40070 msgid ""
40071 "An alternative way to leave extra space but not make the output image any "
40072 "bigger is to use an alternative disk image format (instead of the default "
40073 "\"raw\" format).  Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
40074 "image format (check your hypervisor supports this before using it).  This "
40075 "allows you to choose a large I<--size> but the extra space won't actually be "
40076 "allocated in the image until you try to store something in it."
40077 msgstr ""
40078
40079 #. type: textblock
40080 #: ../tools/virt-make-fs.pl:145
40081 msgid ""
40082 "Don't forget that you can also use local commands including L<resize2fs(8)> "
40083 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
40084 "to build another image from scratch."
40085 msgstr ""
40086
40087 #. type: verbatim
40088 #: ../tools/virt-make-fs.pl:151
40089 #, no-wrap
40090 msgid ""
40091 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
40092 "\n"
40093 msgstr ""
40094
40095 #. type: textblock
40096 #: ../tools/virt-make-fs.pl:179
40097 msgid "Enable debugging information."
40098 msgstr ""
40099
40100 #. type: =item
40101 #: ../tools/virt-make-fs.pl:185
40102 msgid "B<--size=E<lt>NE<gt>>"
40103 msgstr ""
40104
40105 #. type: =item
40106 #: ../tools/virt-make-fs.pl:187
40107 msgid "B<--size=+E<lt>NE<gt>>"
40108 msgstr ""
40109
40110 #. type: =item
40111 #: ../tools/virt-make-fs.pl:189
40112 msgid "B<-s E<lt>NE<gt>>"
40113 msgstr ""
40114
40115 #. type: =item
40116 #: ../tools/virt-make-fs.pl:191
40117 msgid "B<-s +E<lt>NE<gt>>"
40118 msgstr ""
40119
40120 #. type: textblock
40121 #: ../tools/virt-make-fs.pl:193
40122 msgid "Use the I<--size> (or I<-s>) option to choose the size of the output image."
40123 msgstr ""
40124
40125 #. type: textblock
40126 #: ../tools/virt-make-fs.pl:196
40127 msgid ""
40128 "If this option is I<not> given, then the output image will be just large "
40129 "enough to contain all the files, with not much wasted space."
40130 msgstr ""
40131
40132 #. type: textblock
40133 #: ../tools/virt-make-fs.pl:199
40134 msgid ""
40135 "To choose a fixed size output disk, specify an absolute number followed by "
40136 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
40137 "Petabytes or Exabytes.  This must be large enough to contain all the input "
40138 "files, else you will get an error."
40139 msgstr ""
40140
40141 #. type: textblock
40142 #: ../tools/virt-make-fs.pl:204
40143 msgid ""
40144 "To leave extra space, specify C<+> (plus sign) and a number followed by "
40145 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
40146 "Petabytes or Exabytes.  For example: I<--size=+200M> means enough space for "
40147 "the input files, and (approximately) an extra 200 MB free space."
40148 msgstr ""
40149
40150 #. type: textblock
40151 #: ../tools/virt-make-fs.pl:210
40152 msgid ""
40153 "Note that virt-make-fs estimates free space, and therefore will not produce "
40154 "filesystems containing precisely the free space requested.  (It is much more "
40155 "expensive and time-consuming to produce a filesystem which has precisely the "
40156 "desired free space)."
40157 msgstr ""
40158
40159 #. type: =item
40160 #: ../tools/virt-make-fs.pl:219
40161 msgid "B<--format=E<lt>fmtE<gt>>"
40162 msgstr ""
40163
40164 #. type: =item
40165 #: ../tools/virt-make-fs.pl:221
40166 msgid "B<-F E<lt>fmtE<gt>>"
40167 msgstr ""
40168
40169 #. type: textblock
40170 #: ../tools/virt-make-fs.pl:223
40171 msgid "Choose the output disk image format."
40172 msgstr ""
40173
40174 #. type: textblock
40175 #: ../tools/virt-make-fs.pl:225
40176 msgid "The default is C<raw> (raw sparse disk image)."
40177 msgstr ""
40178
40179 #. type: textblock
40180 #: ../tools/virt-make-fs.pl:227
40181 msgid ""
40182 "For other choices, see the L<qemu-img(1)> manpage.  The only other choice "
40183 "that would really make sense here is C<qcow2>."
40184 msgstr ""
40185
40186 #. type: =item
40187 #: ../tools/virt-make-fs.pl:234
40188 msgid "B<--type=E<lt>fsE<gt>>"
40189 msgstr ""
40190
40191 #. type: =item
40192 #: ../tools/virt-make-fs.pl:236
40193 msgid "B<-t E<lt>fsE<gt>>"
40194 msgstr ""
40195
40196 #. type: textblock
40197 #: ../tools/virt-make-fs.pl:238
40198 msgid "Choose the output filesystem type."
40199 msgstr ""
40200
40201 #. type: textblock
40202 #: ../tools/virt-make-fs.pl:240
40203 msgid "The default is C<ext2>."
40204 msgstr ""
40205
40206 #. type: textblock
40207 #: ../tools/virt-make-fs.pl:242
40208 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
40209 msgstr ""
40210
40211 #. type: =item
40212 #: ../tools/virt-make-fs.pl:249
40213 msgid "B<--partition>"
40214 msgstr ""
40215
40216 #. type: =item
40217 #: ../tools/virt-make-fs.pl:251
40218 msgid "B<--partition=E<lt>parttypeE<gt>>"
40219 msgstr ""
40220
40221 #. type: textblock
40222 #: ../tools/virt-make-fs.pl:253
40223 msgid ""
40224 "If specified, this flag adds an MBR partition table to the output disk "
40225 "image."
40226 msgstr ""
40227
40228 #. type: textblock
40229 #: ../tools/virt-make-fs.pl:256
40230 msgid ""
40231 "You can change the partition table type, eg. I<--partition=gpt> for large "
40232 "disks."
40233 msgstr ""
40234
40235 #. type: textblock
40236 #: ../tools/virt-make-fs.pl:259
40237 msgid ""
40238 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
40239 "might consider the next parameter to be the partition type.  For example:"
40240 msgstr ""
40241
40242 #. type: verbatim
40243 #: ../tools/virt-make-fs.pl:263
40244 #, no-wrap
40245 msgid ""
40246 " virt-make-fs --partition input.tar output.img\n"
40247 "\n"
40248 msgstr ""
40249
40250 #. type: textblock
40251 #: ../tools/virt-make-fs.pl:265
40252 msgid ""
40253 "would cause virt-make-fs to think you wanted to use a partition type of "
40254 "C<input.tar> which is completely wrong.  To avoid this, use I<--> (a double "
40255 "dash) between options and the input and output arguments:"
40256 msgstr ""
40257
40258 #. type: verbatim
40259 #: ../tools/virt-make-fs.pl:269
40260 #, no-wrap
40261 msgid ""
40262 " virt-make-fs --partition -- input.tar output.img\n"
40263 "\n"
40264 msgstr ""
40265
40266 #. type: textblock
40267 #: ../tools/virt-make-fs.pl:271
40268 msgid "For MBR, virt-make-fs sets the partition type byte automatically."
40269 msgstr ""
40270
40271 #. type: textblock
40272 #: ../tools/virt-make-fs.pl:559
40273 msgid ""
40274 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
40275 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
40276 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
40277 msgstr ""
40278
40279 #. type: textblock
40280 #: ../tools/virt-make-fs.pl:573 ../tools/virt-win-reg.pl:774
40281 msgid ""
40282 "When reporting bugs, please enable debugging and capture the I<complete> "
40283 "output:"
40284 msgstr ""
40285
40286 #. type: verbatim
40287 #: ../tools/virt-make-fs.pl:576
40288 #, no-wrap
40289 msgid ""
40290 " export LIBGUESTFS_DEBUG=1\n"
40291 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
40292 "\n"
40293 msgstr ""
40294
40295 #. type: textblock
40296 #: ../tools/virt-make-fs.pl:579
40297 msgid ""
40298 "Attach /tmp/virt-make-fs.log to a new bug report at "
40299 "L<https://bugzilla.redhat.com/>"
40300 msgstr ""
40301
40302 #. type: textblock
40303 #: ../tools/virt-tar.pl:33
40304 msgid "virt-tar - Extract or upload files to a virtual machine"
40305 msgstr ""
40306
40307 #. type: verbatim
40308 #: ../tools/virt-tar.pl:37
40309 #, no-wrap
40310 msgid ""
40311 " virt-tar [--options] -x domname directory tarball\n"
40312 "\n"
40313 msgstr ""
40314
40315 #. type: verbatim
40316 #: ../tools/virt-tar.pl:39
40317 #, no-wrap
40318 msgid ""
40319 " virt-tar [--options] -u domname tarball directory\n"
40320 "\n"
40321 msgstr ""
40322
40323 #. type: verbatim
40324 #: ../tools/virt-tar.pl:41
40325 #, no-wrap
40326 msgid ""
40327 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
40328 "\n"
40329 msgstr ""
40330
40331 #. type: verbatim
40332 #: ../tools/virt-tar.pl:43
40333 #, no-wrap
40334 msgid ""
40335 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
40336 "\n"
40337 msgstr ""
40338
40339 #. type: =head2
40340 #: ../tools/virt-tar.pl:45 ../tools/virt-win-reg.pl:88
40341 msgid "NOTE"
40342 msgstr ""
40343
40344 #. type: textblock
40345 #: ../tools/virt-tar.pl:47
40346 msgid ""
40347 "This tool is obsolete.  Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
40348 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
40349 msgstr ""
40350
40351 #. type: textblock
40352 #: ../tools/virt-tar.pl:52
40353 msgid "Download C</home> from the VM into a local tarball:"
40354 msgstr ""
40355
40356 #. type: verbatim
40357 #: ../tools/virt-tar.pl:54
40358 #, no-wrap
40359 msgid ""
40360 " virt-tar -x domname /home home.tar\n"
40361 "\n"
40362 msgstr ""
40363
40364 #. type: verbatim
40365 #: ../tools/virt-tar.pl:56
40366 #, no-wrap
40367 msgid ""
40368 " virt-tar -zx domname /home home.tar.gz\n"
40369 "\n"
40370 msgstr ""
40371
40372 #. type: textblock
40373 #: ../tools/virt-tar.pl:58
40374 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
40375 msgstr ""
40376
40377 #. type: verbatim
40378 #: ../tools/virt-tar.pl:60
40379 #, no-wrap
40380 msgid ""
40381 " virt-tar -u domname uploadstuff.tar /tmp\n"
40382 "\n"
40383 msgstr ""
40384
40385 #. type: verbatim
40386 #: ../tools/virt-tar.pl:62
40387 #, no-wrap
40388 msgid ""
40389 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
40390 "\n"
40391 msgstr ""
40392
40393 #. type: textblock
40394 #: ../tools/virt-tar.pl:66
40395 msgid ""
40396 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
40397 "virtual machines.  If you do this, you risk disk corruption in the VM.  "
40398 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
40399 msgstr ""
40400
40401 #. type: textblock
40402 #: ../tools/virt-tar.pl:71
40403 msgid ""
40404 "You can use I<-x> (extract) on live virtual machines, but you might get "
40405 "inconsistent results or errors if there is filesystem activity inside the "
40406 "VM.  If the live VM is synched and quiescent, then C<virt-tar> will usually "
40407 "work, but the only way to guarantee consistent results is if the virtual "
40408 "machine is shut down."
40409 msgstr ""
40410
40411 #. type: textblock
40412 #: ../tools/virt-tar.pl:79
40413 msgid ""
40414 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
40415 "parts of a guest filesystem.  There are many possibilities: making backups, "
40416 "uploading data files, snooping on guest activity, fixing or customizing "
40417 "guests, etc."
40418 msgstr ""
40419
40420 #. type: textblock
40421 #: ../tools/virt-tar.pl:84
40422 msgid ""
40423 "If you want to just view a single file, use L<virt-cat(1)>.  If you just "
40424 "want to edit a single file, use L<virt-edit(1)>.  For more complex cases you "
40425 "should look at the L<guestfish(1)> tool."
40426 msgstr ""
40427
40428 #. type: textblock
40429 #: ../tools/virt-tar.pl:88
40430 msgid ""
40431 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
40432 "its contents (recursively) from the virtual machine into a local tarball.  "
40433 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
40434 "virtual machine.  You cannot use these two options together."
40435 msgstr ""
40436
40437 #. type: textblock
40438 #: ../tools/virt-tar.pl:94
40439 msgid ""
40440 "In addition, you may need to use the I<-z> (gZip) option to enable "
40441 "compression.  When uploading, you have to specify I<-z> if the upload file "
40442 "is compressed because virt-tar won't detect this on its own."
40443 msgstr ""
40444
40445 #. type: textblock
40446 #: ../tools/virt-tar.pl:98
40447 msgid ""
40448 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs.  For "
40449 "example it cannot do PKZip files or bzip2 compression.  If you want that "
40450 "then you'll have to rebuild the tarballs yourself.  (This is a limitation of "
40451 "the L<libguestfs(3)> API)."
40452 msgstr ""
40453
40454 #. type: =item
40455 #: ../tools/virt-tar.pl:160
40456 msgid "B<--extract>"
40457 msgstr ""
40458
40459 #. type: =item
40460 #: ../tools/virt-tar.pl:162
40461 msgid "B<--download>"
40462 msgstr ""
40463
40464 #. type: =item
40465 #: ../tools/virt-tar.pl:164
40466 msgid "B<-u>"
40467 msgstr ""
40468
40469 #. type: =item
40470 #: ../tools/virt-tar.pl:166
40471 msgid "B<--upload>"
40472 msgstr ""
40473
40474 #. type: textblock
40475 #: ../tools/virt-tar.pl:168
40476 msgid ""
40477 "Use I<-x> to extract (download) a directory from a virtual machine to a "
40478 "local tarball."
40479 msgstr ""
40480
40481 #. type: textblock
40482 #: ../tools/virt-tar.pl:171
40483 msgid ""
40484 "Use I<-u> to upload and unpack from a local tarball into a virtual machine.  "
40485 "Please read the L</WARNING> section above before using this option."
40486 msgstr ""
40487
40488 #. type: textblock
40489 #: ../tools/virt-tar.pl:175
40490 msgid "You must specify exactly one of these options."
40491 msgstr ""
40492
40493 #. type: =item
40494 #: ../tools/virt-tar.pl:181
40495 msgid "B<-z>"
40496 msgstr ""
40497
40498 #. type: =item
40499 #: ../tools/virt-tar.pl:183
40500 msgid "B<--gzip>"
40501 msgstr ""
40502
40503 #. type: textblock
40504 #: ../tools/virt-tar.pl:185
40505 msgid "Specify that the input or output tarball is gzip-compressed."
40506 msgstr ""
40507
40508 #. type: textblock
40509 #: ../tools/virt-tar.pl:298
40510 msgid ""
40511 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
40512 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
40513 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
40514 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
40515 msgstr ""
40516
40517 #. type: textblock
40518 #: ../tools/virt-win-reg.pl:37
40519 msgid ""
40520 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
40521 "guest"
40522 msgstr ""
40523
40524 #. type: verbatim
40525 #: ../tools/virt-win-reg.pl:41
40526 #, no-wrap
40527 msgid ""
40528 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
40529 "\n"
40530 msgstr ""
40531
40532 #. type: verbatim
40533 #: ../tools/virt-win-reg.pl:43
40534 #, no-wrap
40535 msgid ""
40536 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
40537 "\n"
40538 msgstr ""
40539
40540 #. type: verbatim
40541 #: ../tools/virt-win-reg.pl:45
40542 #, no-wrap
40543 msgid ""
40544 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
40545 "\n"
40546 msgstr ""
40547
40548 #. type: verbatim
40549 #: ../tools/virt-win-reg.pl:47
40550 #, no-wrap
40551 msgid ""
40552 " virt-win-reg --merge domname [input.reg ...]\n"
40553 "\n"
40554 msgstr ""
40555
40556 #. type: verbatim
40557 #: ../tools/virt-win-reg.pl:49
40558 #, no-wrap
40559 msgid ""
40560 " virt-win-reg [--options] disk.img ... # instead of domname\n"
40561 "\n"
40562 msgstr ""
40563
40564 #. type: textblock
40565 #: ../tools/virt-win-reg.pl:53
40566 msgid ""
40567 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
40568 "virtual machines.  If you do this, you I<will> get irreversible disk "
40569 "corruption in the VM.  C<virt-win-reg> tries to stop you from doing this, "
40570 "but doesn't catch all cases."
40571 msgstr ""
40572
40573 #. type: textblock
40574 #: ../tools/virt-win-reg.pl:58
40575 msgid ""
40576 "Modifying the Windows Registry is an inherently risky operation.  The format "
40577 "is deliberately obscure and undocumented, and Registry changes can leave the "
40578 "system unbootable.  Therefore when using the I<--merge> option, make sure "
40579 "you have a reliable backup first."
40580 msgstr ""
40581
40582 #. type: textblock
40583 #: ../tools/virt-win-reg.pl:65
40584 msgid ""
40585 "This program can export and merge Windows Registry entries from a Windows "
40586 "guest."
40587 msgstr ""
40588
40589 #. type: textblock
40590 #: ../tools/virt-win-reg.pl:68
40591 msgid ""
40592 "The first parameter is the libvirt guest name or the raw disk image of a "
40593 "Windows guest."
40594 msgstr ""
40595
40596 #. type: textblock
40597 #: ../tools/virt-win-reg.pl:71
40598 msgid ""
40599 "If I<--merge> is I<not> specified, then the chosen registry key is "
40600 "displayed/exported (recursively).  For example:"
40601 msgstr ""
40602
40603 #. type: verbatim
40604 #: ../tools/virt-win-reg.pl:74
40605 #, no-wrap
40606 msgid ""
40607 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
40608 "\n"
40609 msgstr ""
40610
40611 #. type: textblock
40612 #: ../tools/virt-win-reg.pl:76
40613 msgid "You can also display single values from within registry keys, for example:"
40614 msgstr ""
40615
40616 #. type: verbatim
40617 #: ../tools/virt-win-reg.pl:79
40618 #, no-wrap
40619 msgid ""
40620 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
40621 " $ virt-win-reg Windows7 $cvkey ProductName\n"
40622 " Windows 7 Enterprise\n"
40623 "\n"
40624 msgstr ""
40625
40626 #. type: textblock
40627 #: ../tools/virt-win-reg.pl:83
40628 msgid ""
40629 "With I<--merge>, you can merge a textual regedit file into the Windows "
40630 "Registry:"
40631 msgstr ""
40632
40633 #. type: verbatim
40634 #: ../tools/virt-win-reg.pl:86
40635 #, no-wrap
40636 msgid ""
40637 " $ virt-win-reg --merge Windows7 changes.reg\n"
40638 "\n"
40639 msgstr ""
40640
40641 #. type: textblock
40642 #: ../tools/virt-win-reg.pl:90
40643 msgid ""
40644 "This program is only meant for simple access to the registry.  If you want "
40645 "to do complicated things with the registry, we suggest you download the "
40646 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
40647 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
40648 "L<hivexregedit(1)>."
40649 msgstr ""
40650
40651 #. type: =item
40652 #: ../tools/virt-win-reg.pl:159
40653 msgid "B<--merge>"
40654 msgstr ""
40655
40656 #. type: textblock
40657 #: ../tools/virt-win-reg.pl:161
40658 msgid ""
40659 "In merge mode, this merges a textual regedit file into the Windows Registry "
40660 "of the virtual machine.  If this flag is I<not> given then virt-win-reg "
40661 "displays or exports Registry entries instead."
40662 msgstr ""
40663
40664 #. type: textblock
40665 #: ../tools/virt-win-reg.pl:165
40666 msgid ""
40667 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
40668 "result in disk corruption.  However exporting (without this flag)  is always "
40669 "safe."
40670 msgstr ""
40671
40672 #. type: =item
40673 #: ../tools/virt-win-reg.pl:173
40674 msgid "B<--encoding> UTF-16LE|ASCII"
40675 msgstr ""
40676
40677 #. type: textblock
40678 #: ../tools/virt-win-reg.pl:175
40679 msgid ""
40680 "When merging (only), you may need to specify the encoding for strings to be "
40681 "used in the hive file.  This is explained in detail in "
40682 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
40683 msgstr ""
40684
40685 #. type: textblock
40686 #: ../tools/virt-win-reg.pl:179
40687 msgid ""
40688 "The default is to use UTF-16LE, which should work with recent versions of "
40689 "Windows."
40690 msgstr ""
40691
40692 #. type: =item
40693 #: ../tools/virt-win-reg.pl:186
40694 msgid "B<--unsafe-printable-strings>"
40695 msgstr ""
40696
40697 #. type: textblock
40698 #: ../tools/virt-win-reg.pl:188
40699 msgid ""
40700 "When exporting (only), assume strings are UTF-16LE and print them as strings "
40701 "instead of hex sequences.  Remove the final zero codepoint from strings if "
40702 "present."
40703 msgstr ""
40704
40705 #. type: textblock
40706 #: ../tools/virt-win-reg.pl:192
40707 msgid ""
40708 "This is unsafe and does not preserve the fidelity of strings in the original "
40709 "Registry for various reasons:"
40710 msgstr ""
40711
40712 #. type: textblock
40713 #: ../tools/virt-win-reg.pl:199
40714 msgid ""
40715 "Assumes the original encoding is UTF-16LE.  ASCII strings and strings in "
40716 "other encodings will be corrupted by this transformation."
40717 msgstr ""
40718
40719 #. type: textblock
40720 #: ../tools/virt-win-reg.pl:204
40721 msgid ""
40722 "Assumes that everything which has type 1 or 2 is really a string and that "
40723 "everything else is not a string, but the type field in real Registries is "
40724 "not reliable."
40725 msgstr ""
40726
40727 #. type: textblock
40728 #: ../tools/virt-win-reg.pl:210
40729 msgid ""
40730 "Loses information about whether a zero codepoint followed the string in the "
40731 "Registry or not."
40732 msgstr ""
40733
40734 #. type: textblock
40735 #: ../tools/virt-win-reg.pl:215
40736 msgid ""
40737 "This all happens because the Registry itself contains no information about "
40738 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
40739 msgstr ""
40740
40741 #. type: textblock
40742 #: ../tools/virt-win-reg.pl:219
40743 msgid ""
40744 "You should only use this option for quick hacking and debugging of the "
40745 "Registry contents, and I<never> use it if the output is going to be passed "
40746 "into another program or stored in another Registry."
40747 msgstr ""
40748
40749 #. type: =head1
40750 #: ../tools/virt-win-reg.pl:556
40751 msgid "SUPPORTED SYSTEMS"
40752 msgstr ""
40753
40754 #. type: textblock
40755 #: ../tools/virt-win-reg.pl:558
40756 msgid ""
40757 "The program currently supports Windows NT-derived guests starting with "
40758 "Windows XP through to at least Windows 7."
40759 msgstr ""
40760
40761 #. type: textblock
40762 #: ../tools/virt-win-reg.pl:561
40763 msgid "The following Registry keys are supported:"
40764 msgstr ""
40765
40766 #. type: =item
40767 #: ../tools/virt-win-reg.pl:565
40768 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
40769 msgstr ""
40770
40771 #. type: =item
40772 #: ../tools/virt-win-reg.pl:567
40773 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
40774 msgstr ""
40775
40776 #. type: =item
40777 #: ../tools/virt-win-reg.pl:569
40778 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
40779 msgstr ""
40780
40781 #. type: =item
40782 #: ../tools/virt-win-reg.pl:571
40783 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
40784 msgstr ""
40785
40786 #. type: =item
40787 #: ../tools/virt-win-reg.pl:573
40788 msgid "C<HKEY_USERS\\.DEFAULT>"
40789 msgstr ""
40790
40791 #. type: =item
40792 #: ../tools/virt-win-reg.pl:575
40793 msgid "C<HKEY_USERS\\I<SID>>"
40794 msgstr ""
40795
40796 #. type: textblock
40797 #: ../tools/virt-win-reg.pl:577
40798 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
40799 msgstr ""
40800
40801 #. type: =item
40802 #: ../tools/virt-win-reg.pl:579
40803 msgid "C<HKEY_USERS\\I<username>>"
40804 msgstr ""
40805
40806 #. type: textblock
40807 #: ../tools/virt-win-reg.pl:581
40808 msgid "where I<username> is a local user name (this is a libguestfs extension)."
40809 msgstr ""
40810
40811 #. type: textblock
40812 #: ../tools/virt-win-reg.pl:585
40813 msgid ""
40814 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
40815 "C<HKEY_USERS>."
40816 msgstr ""
40817
40818 #. type: textblock
40819 #: ../tools/virt-win-reg.pl:588
40820 msgid ""
40821 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
40822 "supported (there is no \"current user\")."
40823 msgstr ""
40824
40825 #. type: =head1
40826 #: ../tools/virt-win-reg.pl:591
40827 msgid "ENCODING"
40828 msgstr ""
40829
40830 #. type: textblock
40831 #: ../tools/virt-win-reg.pl:593
40832 msgid ""
40833 "C<virt-win-reg> expects that regedit files have already been reencoded in "
40834 "the local encoding.  Usually on Linux hosts, this means UTF-8 with "
40835 "Unix-style line endings.  Since Windows regedit files are often in UTF-16LE "
40836 "with Windows-style line endings, you may need to reencode the whole file "
40837 "before or after processing."
40838 msgstr ""
40839
40840 #. type: textblock
40841 #: ../tools/virt-win-reg.pl:599
40842 msgid ""
40843 "To reencode a file from Windows format to Linux (before processing it with "
40844 "the I<--merge> option), you would do something like this:"
40845 msgstr ""
40846
40847 #. type: verbatim
40848 #: ../tools/virt-win-reg.pl:602
40849 #, no-wrap
40850 msgid ""
40851 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
40852 "\n"
40853 msgstr ""
40854
40855 #. type: textblock
40856 #: ../tools/virt-win-reg.pl:604
40857 msgid ""
40858 "To go in the opposite direction, after exporting and before sending the file "
40859 "to a Windows user, do something like this:"
40860 msgstr ""
40861
40862 #. type: verbatim
40863 #: ../tools/virt-win-reg.pl:607
40864 #, no-wrap
40865 msgid ""
40866 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
40867 "\n"
40868 msgstr ""
40869
40870 #. type: textblock
40871 #: ../tools/virt-win-reg.pl:609
40872 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
40873 msgstr ""
40874
40875 #. type: textblock
40876 #: ../tools/virt-win-reg.pl:611
40877 msgid ""
40878 "If you are unsure about the current encoding, use the L<file(1)> command.  "
40879 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
40880 "Windows-style (CRLF) line endings, like this:"
40881 msgstr ""
40882
40883 #. type: verbatim
40884 #: ../tools/virt-win-reg.pl:615
40885 #, no-wrap
40886 msgid ""
40887 " $ file software.reg\n"
40888 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
40889 " with CRLF line terminators\n"
40890 "\n"
40891 msgstr ""
40892
40893 #. type: textblock
40894 #: ../tools/virt-win-reg.pl:619
40895 msgid "This file would need conversion before you could I<--merge> it."
40896 msgstr ""
40897
40898 #. type: =head1
40899 #: ../tools/virt-win-reg.pl:621
40900 msgid "CurrentControlSet etc."
40901 msgstr ""
40902
40903 #. type: textblock
40904 #: ../tools/virt-win-reg.pl:623
40905 msgid ""
40906 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
40907 "Registry at the level of the hive file, and therefore you cannot modify "
40908 "these."
40909 msgstr ""
40910
40911 #. type: textblock
40912 #: ../tools/virt-win-reg.pl:627
40913 msgid ""
40914 "C<CurrentControlSet> is usually an alias for C<ControlSet001>.  In some "
40915 "circumstances it might refer to another control set.  The way to find out is "
40916 "to look at the C<HKLM\\SYSTEM\\Select> key:"
40917 msgstr ""
40918
40919 #. type: verbatim
40920 #: ../tools/virt-win-reg.pl:631
40921 #, no-wrap
40922 msgid ""
40923 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
40924 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
40925 " \"Current\"=dword:00000001\n"
40926 " \"Default\"=dword:00000001\n"
40927 " \"Failed\"=dword:00000000\n"
40928 " \"LastKnownGood\"=dword:00000002\n"
40929 "\n"
40930 msgstr ""
40931
40932 #. type: textblock
40933 #: ../tools/virt-win-reg.pl:638
40934 msgid "\"Current\" is the one which Windows will choose when it boots."
40935 msgstr ""
40936
40937 #. type: textblock
40938 #: ../tools/virt-win-reg.pl:640
40939 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
40940 msgstr ""
40941
40942 #. type: =head1
40943 #: ../tools/virt-win-reg.pl:643
40944 msgid "DELETING REGISTRY KEYS AND VALUES"
40945 msgstr ""
40946
40947 #. type: textblock
40948 #: ../tools/virt-win-reg.pl:645
40949 msgid "To delete a whole registry key, use the syntax:"
40950 msgstr ""
40951
40952 #. type: verbatim
40953 #: ../tools/virt-win-reg.pl:647
40954 #, no-wrap
40955 msgid ""
40956 " [-HKEY_LOCAL_MACHINE\\Foo]\n"
40957 "\n"
40958 msgstr ""
40959
40960 #. type: textblock
40961 #: ../tools/virt-win-reg.pl:649
40962 msgid "To delete a single value within a key, use the syntax:"
40963 msgstr ""
40964
40965 #. type: verbatim
40966 #: ../tools/virt-win-reg.pl:651
40967 #, no-wrap
40968 msgid ""
40969 " [HKEY_LOCAL_MACHINE\\Foo]\n"
40970 " \"Value\"=-\n"
40971 "\n"
40972 msgstr ""
40973
40974 #. type: =head1
40975 #: ../tools/virt-win-reg.pl:654
40976 msgid "WINDOWS TIPS"
40977 msgstr ""
40978
40979 #. type: textblock
40980 #: ../tools/virt-win-reg.pl:656
40981 msgid ""
40982 "Note that some of these tips modify the guest disk image.  The guest I<must> "
40983 "be shut off, else you will get disk corruption."
40984 msgstr ""
40985
40986 #. type: =head2
40987 #: ../tools/virt-win-reg.pl:659
40988 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
40989 msgstr ""
40990
40991 #. type: textblock
40992 #: ../tools/virt-win-reg.pl:661
40993 msgid ""
40994 "Prepare a DOS batch script, VBScript or executable.  Upload this using "
40995 "L<guestfish(1)>.  For this example the script is called C<test.bat> and it "
40996 "is uploaded into C<C:\\>:"
40997 msgstr ""
40998
40999 #. type: verbatim
41000 #: ../tools/virt-win-reg.pl:665
41001 #, no-wrap
41002 msgid ""
41003 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
41004 "\n"
41005 msgstr ""
41006
41007 #. type: textblock
41008 #: ../tools/virt-win-reg.pl:667
41009 msgid "Prepare a regedit file containing the registry change:"
41010 msgstr ""
41011
41012 #. type: verbatim
41013 #: ../tools/virt-win-reg.pl:669
41014 #, no-wrap
41015 msgid ""
41016 " cat > test.reg <<'EOF'\n"
41017 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
41018 " \"Test\"=\"c:\\\\test.bat\"\n"
41019 " EOF\n"
41020 "\n"
41021 msgstr ""
41022
41023 #. type: textblock
41024 #: ../tools/virt-win-reg.pl:674
41025 msgid ""
41026 "In this example we use the key C<RunOnce> which means that the script will "
41027 "run precisely once when the first user logs in.  If you want it to run every "
41028 "time a user logs in, replace C<RunOnce> with C<Run>."
41029 msgstr ""
41030
41031 #. type: textblock
41032 #: ../tools/virt-win-reg.pl:678
41033 msgid "Now update the registry:"
41034 msgstr ""
41035
41036 #. type: verbatim
41037 #: ../tools/virt-win-reg.pl:680
41038 #, no-wrap
41039 msgid ""
41040 " virt-win-reg --merge WindowsGuest test.reg\n"
41041 "\n"
41042 msgstr ""
41043
41044 #. type: =head2
41045 #: ../tools/virt-win-reg.pl:682
41046 msgid "INSTALLING A SERVICE"
41047 msgstr ""
41048
41049 #. type: textblock
41050 #: ../tools/virt-win-reg.pl:684
41051 msgid ""
41052 "This section assumes you are familiar with Windows services, and you either "
41053 "have a program which handles the Windows Service Control Protocol directly "
41054 "or you want to run any program using a service wrapper like SrvAny or the "
41055 "free RHSrvAny."
41056 msgstr ""
41057
41058 #. type: textblock
41059 #: ../tools/virt-win-reg.pl:689
41060 msgid ""
41061 "First upload the program and optionally the service wrapper.  In this case "
41062 "the test program is called C<test.exe> and we are using the RHSrvAny "
41063 "wrapper:"
41064 msgstr ""
41065
41066 #. type: verbatim
41067 #: ../tools/virt-win-reg.pl:693
41068 #, no-wrap
41069 msgid ""
41070 " guestfish -i -d WindowsGuest <<EOF\n"
41071 "   upload rhsrvany.exe /rhsrvany.exe\n"
41072 "   upload test.exe /test.exe\n"
41073 " EOF\n"
41074 "\n"
41075 msgstr ""
41076
41077 #. type: textblock
41078 #: ../tools/virt-win-reg.pl:698
41079 msgid ""
41080 "Prepare a regedit file containing the registry changes.  In this example, "
41081 "the first registry change is needed for the service itself or the service "
41082 "wrapper (if used).  The second registry change is only needed because I am "
41083 "using the RHSrvAny service wrapper."
41084 msgstr ""
41085
41086 #. type: verbatim
41087 #: ../tools/virt-win-reg.pl:703
41088 #, no-wrap
41089 msgid ""
41090 " cat > service.reg <<'EOF'\n"
41091 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
41092 " \"Type\"=dword:00000010\n"
41093 " \"Start\"=dword:00000002\n"
41094 " \"ErrorControl\"=dword:00000001\n"
41095 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
41096 " \"DisplayName\"=\"RHSrvAny\"\n"
41097 " \"ObjectName\"=\"NetworkService\"\n"
41098 " \n"
41099 msgstr ""
41100
41101 #. type: verbatim
41102 #: ../tools/virt-win-reg.pl:712
41103 #, no-wrap
41104 msgid ""
41105 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
41106 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
41107 " \"PWD\"=\"c:\\\\Temp\"\n"
41108 " EOF\n"
41109 "\n"
41110 msgstr ""
41111
41112 #. type: textblock
41113 #: ../tools/virt-win-reg.pl:723
41114 msgid ""
41115 "For use of C<ControlSet001> see the section above in this manual page.  You "
41116 "may need to adjust this according to the control set that is in use by the "
41117 "guest."
41118 msgstr ""
41119
41120 #. type: textblock
41121 #: ../tools/virt-win-reg.pl:729
41122 msgid ""
41123 "C<\"ObjectName\"> controls the privileges that the service will have.  An "
41124 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
41125 "privileged account."
41126 msgstr ""
41127
41128 #. type: textblock
41129 #: ../tools/virt-win-reg.pl:735
41130 msgid ""
41131 "For the meaning of the magic numbers, see this Microsoft KB article: "
41132 "L<http://support.microsoft.com/kb/103000>."
41133 msgstr ""
41134
41135 #. type: textblock
41136 #: ../tools/virt-win-reg.pl:740
41137 msgid "Update the registry:"
41138 msgstr ""
41139
41140 #. type: verbatim
41141 #: ../tools/virt-win-reg.pl:742
41142 #, no-wrap
41143 msgid ""
41144 " virt-win-reg --merge WindowsGuest service.reg\n"
41145 "\n"
41146 msgstr ""
41147
41148 #. type: textblock
41149 #: ../tools/virt-win-reg.pl:746
41150 msgid ""
41151 "Be careful when passing parameters containing C<\\> (backslash) in the "
41152 "shell.  Usually you will have to use 'single quotes' or double backslashes "
41153 "(but not both) to protect them from the shell."
41154 msgstr ""
41155
41156 #. type: textblock
41157 #: ../tools/virt-win-reg.pl:750
41158 msgid "Paths and value names are case-insensitive."
41159 msgstr ""
41160
41161 #. type: textblock
41162 #: ../tools/virt-win-reg.pl:759
41163 msgid ""
41164 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
41165 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
41166 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
41167 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
41168 msgstr ""
41169
41170 #. type: verbatim
41171 #: ../tools/virt-win-reg.pl:777
41172 #, no-wrap
41173 msgid ""
41174 " export LIBGUESTFS_DEBUG=1\n"
41175 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
41176 "\n"
41177 msgstr ""
41178
41179 #. type: textblock
41180 #: ../tools/virt-win-reg.pl:780
41181 msgid ""
41182 "Attach /tmp/virt-win-reg.log to a new bug report at "
41183 "L<https://bugzilla.redhat.com/>"
41184 msgstr ""