1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Red Hat Inc.
3 # This file is distributed under the same license as the libguestfs package.
5 # rjones <rjones@redhat.com>, 2011.
8 "Project-Id-Version: libguestfs\n"
9 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
10 "POT-Creation-Date: 2011-07-20 17:31+0200\n"
11 "PO-Revision-Date: 2011-07-17 20:50+0000\n"
12 "Last-Translator: rjones <rjones@redhat.com>\n"
13 "Language-Team: Japanese (http://www.transifex.net/projects/p/fedora/team/"
17 "Content-Type: text/plain; charset=UTF-8\n"
18 "Content-Transfer-Encoding: 8bit\n"
19 "Plural-Forms: nplurals=1; plural=0\n"
22 #: ../cat/virt-cat.pod:3 ../cat/virt-filesystems.pod:3 ../cat/virt-ls.pod:3
23 #: ../df/virt-df.pod:3 ../edit/virt-edit.pod:3
24 #: ../examples/guestfs-examples.pod:3 ../examples/guestfs-recipes.pod:14
25 #: ../fish/guestfish.pod:3 ../fish/virt-copy-in.pod:3
26 #: ../fish/virt-copy-out.pod:3 ../fish/virt-tar-in.pod:3
27 #: ../fish/virt-tar-out.pod:3 ../fuse/guestmount.pod:3
28 #: ../inspector/virt-inspector.pod:3 ../java/examples/guestfs-java.pod:3
29 #: ../ocaml/examples/guestfs-ocaml.pod:3 ../perl/examples/guestfs-perl.pod:3
30 #: ../python/examples/guestfs-python.pod:3 ../rescue/virt-rescue.pod:3
31 #: ../resize/virt-resize.pod:3 ../ruby/examples/guestfs-ruby.pod:3
32 #: ../src/guestfs.pod:3 ../test-tool/libguestfs-test-tool.pod:3
33 #: ../tools/virt-list-filesystems.pl:30 ../tools/virt-list-partitions.pl:30
34 #: ../tools/virt-make-fs.pl:35 ../tools/virt-tar.pl:31
35 #: ../tools/virt-win-reg.pl:35
40 #: ../cat/virt-cat.pod:5
41 msgid "virt-cat - Display files in a virtual machine"
45 #: ../cat/virt-cat.pod:7 ../cat/virt-filesystems.pod:7 ../cat/virt-ls.pod:7
46 #: ../df/virt-df.pod:7 ../edit/virt-edit.pod:7
47 #: ../examples/guestfs-examples.pod:7 ../fish/guestfish.pod:7
48 #: ../fish/virt-copy-in.pod:7 ../fish/virt-copy-out.pod:7
49 #: ../fish/virt-tar-in.pod:7 ../fish/virt-tar-out.pod:7
50 #: ../fuse/guestmount.pod:7 ../inspector/virt-inspector.pod:7
51 #: ../java/examples/guestfs-java.pod:7 ../ocaml/examples/guestfs-ocaml.pod:7
52 #: ../perl/examples/guestfs-perl.pod:7 ../python/examples/guestfs-python.pod:7
53 #: ../rescue/virt-rescue.pod:7 ../resize/virt-resize.pod:7
54 #: ../ruby/examples/guestfs-ruby.pod:7 ../src/guestfs.pod:7
55 #: ../test-tool/libguestfs-test-tool.pod:7
56 #: ../tools/virt-list-filesystems.pl:34 ../tools/virt-list-partitions.pl:34
57 #: ../tools/virt-make-fs.pl:39 ../tools/virt-tar.pl:35
58 #: ../tools/virt-win-reg.pl:39
63 #: ../cat/virt-cat.pod:9
66 " virt-cat [--options] -d domname file [file ...]\n"
71 #: ../cat/virt-cat.pod:11
74 " virt-cat [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
79 #: ../cat/virt-cat.pod:13 ../edit/virt-edit.pod:15
80 #: ../inspector/virt-inspector.pod:13
85 #: ../cat/virt-cat.pod:15
88 " virt-cat domname file\n"
93 #: ../cat/virt-cat.pod:17
96 " virt-cat disk.img file\n"
101 #: ../cat/virt-cat.pod:19 ../cat/virt-filesystems.pod:13 ../cat/virt-ls.pod:19
102 #: ../df/virt-df.pod:21 ../edit/virt-edit.pod:27
103 #: ../examples/guestfs-examples.pod:19 ../examples/guestfs-recipes.pod:18
104 #: ../fish/guestfish.pod:30 ../fish/virt-copy-in.pod:19
105 #: ../fish/virt-copy-out.pod:13 ../fish/virt-tar-in.pod:21
106 #: ../fish/virt-tar-out.pod:15 ../fuse/guestmount.pod:20
107 #: ../inspector/virt-inspector.pod:19 ../java/examples/guestfs-java.pod:15
108 #: ../ocaml/examples/guestfs-ocaml.pod:25 ../perl/examples/guestfs-perl.pod:18
109 #: ../python/examples/guestfs-python.pod:14 ../rescue/virt-rescue.pod:29
110 #: ../resize/virt-resize.pod:13 ../ruby/examples/guestfs-ruby.pod:15
111 #: ../src/guestfs.pod:23 ../test-tool/libguestfs-test-tool.pod:11
112 #: ../tools/virt-list-filesystems.pl:40 ../tools/virt-list-partitions.pl:40
113 #: ../tools/virt-make-fs.pl:47 ../tools/virt-tar.pl:77
114 #: ../tools/virt-win-reg.pl:63
119 #: ../cat/virt-cat.pod:21
121 "C<virt-cat> is a command line tool to display the contents of C<file> where "
122 "C<file> exists in the named virtual machine (or disk image)."
126 #: ../cat/virt-cat.pod:24
128 "Multiple filenames can be given, in which case they are concatenated "
129 "together. Each filename must be a full path, starting at the root directory "
130 "(starting with '/')."
134 #: ../cat/virt-cat.pod:28
136 "C<virt-cat> can be used to quickly view a file. To edit a file, use C<virt-"
137 "edit>. For more complex cases you should look at the L<guestfish(1)> tool "
138 "(see L</USING GUESTFISH> below)."
142 #: ../cat/virt-cat.pod:32 ../cat/virt-ls.pod:35 ../df/virt-df.pod:43
143 #: ../edit/virt-edit.pod:44 ../fish/guestfish.pod:41
144 #: ../fish/guestfish.pod:1007 ../fish/virt-copy-in.pod:29
145 #: ../fish/virt-copy-out.pod:21 ../fish/virt-tar-in.pod:30
146 #: ../fish/virt-tar-out.pod:24 ../fuse/guestmount.pod:39
147 #: ../resize/virt-resize.pod:27 ../tools/virt-tar.pl:50
152 #: ../cat/virt-cat.pod:34
154 "Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
158 #: ../cat/virt-cat.pod:37
161 " virt-cat -d mydomain /etc/fstab\n"
166 #: ../cat/virt-cat.pod:39
167 msgid "List syslog messages from a VM disk image file:"
171 #: ../cat/virt-cat.pod:41
174 " virt-cat -a disk.img /var/log/messages | tail\n"
179 #: ../cat/virt-cat.pod:43
180 msgid "Find out what DHCP IP address a VM acquired:"
184 #: ../cat/virt-cat.pod:45
187 " virt-cat -d mydomain /var/log/messages | \\\n"
188 " grep 'dhclient: bound to' | tail\n"
193 #: ../cat/virt-cat.pod:48
194 msgid "Find out what packages were recently installed:"
198 #: ../cat/virt-cat.pod:50
201 " virt-cat -d mydomain /var/log/yum.log | tail\n"
206 #: ../cat/virt-cat.pod:52
207 msgid "Find out who is logged on inside a virtual machine:"
211 #: ../cat/virt-cat.pod:54
214 " virt-cat -d mydomain /var/run/utmp > /tmp/utmp\n"
220 #: ../cat/virt-cat.pod:57
221 msgid "or who was logged on:"
225 #: ../cat/virt-cat.pod:59
228 " virt-cat -d mydomain /var/log/wtmp > /tmp/wtmp\n"
229 " last -f /tmp/wtmp\n"
234 #: ../cat/virt-cat.pod:62 ../cat/virt-filesystems.pod:91
235 #: ../cat/virt-ls.pod:261 ../df/virt-df.pod:59 ../edit/virt-edit.pod:62
236 #: ../fish/guestfish.pod:148 ../fish/virt-copy-in.pod:45
237 #: ../fish/virt-copy-out.pod:34 ../fish/virt-tar-in.pod:42
238 #: ../fish/virt-tar-out.pod:36 ../fuse/guestmount.pod:83
239 #: ../inspector/virt-inspector.pod:55 ../rescue/virt-rescue.pod:84
240 #: ../resize/virt-resize.pod:241 ../test-tool/libguestfs-test-tool.pod:37
241 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-list-partitions.pl:54
242 #: ../tools/virt-make-fs.pl:153 ../tools/virt-tar.pl:103
243 #: ../tools/virt-win-reg.pl:96
248 #: ../cat/virt-cat.pod:66 ../cat/virt-filesystems.pod:95
249 #: ../cat/virt-ls.pod:265 ../df/virt-df.pod:63 ../edit/virt-edit.pod:66
250 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:151
251 #: ../inspector/virt-inspector.pod:59 ../rescue/virt-rescue.pod:88
252 #: ../resize/virt-resize.pod:245 ../tools/virt-list-filesystems.pl:61
253 #: ../tools/virt-list-partitions.pl:62 ../tools/virt-make-fs.pl:161
254 #: ../tools/virt-tar.pl:111 ../tools/virt-win-reg.pl:104
259 #: ../cat/virt-cat.pod:68 ../cat/virt-filesystems.pod:97
260 #: ../cat/virt-ls.pod:267 ../df/virt-df.pod:65 ../edit/virt-edit.pod:68
261 #: ../inspector/virt-inspector.pod:61 ../rescue/virt-rescue.pod:90
262 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-list-partitions.pl:64
263 #: ../tools/virt-make-fs.pl:163 ../tools/virt-tar.pl:113
264 #: ../tools/virt-win-reg.pl:106
265 msgid "Display brief help."
269 #: ../cat/virt-cat.pod:70 ../cat/virt-filesystems.pod:99
270 #: ../cat/virt-ls.pod:269 ../df/virt-df.pod:67 ../edit/virt-edit.pod:70
271 #: ../inspector/virt-inspector.pod:63 ../rescue/virt-rescue.pod:92
276 #: ../cat/virt-cat.pod:72 ../cat/virt-filesystems.pod:101
277 #: ../cat/virt-ls.pod:271 ../df/virt-df.pod:69 ../edit/virt-edit.pod:72
278 #: ../inspector/virt-inspector.pod:65 ../rescue/virt-rescue.pod:94
279 msgid "B<--add> file"
283 #: ../cat/virt-cat.pod:74 ../cat/virt-filesystems.pod:103
284 #: ../cat/virt-ls.pod:273 ../df/virt-df.pod:71 ../edit/virt-edit.pod:74
285 #: ../inspector/virt-inspector.pod:67 ../rescue/virt-rescue.pod:96
287 "Add I<file> which should be a disk image from a virtual machine. If the "
288 "virtual machine has multiple block devices, you must supply all of them with "
289 "separate I<-a> options."
293 #: ../cat/virt-cat.pod:78 ../cat/virt-filesystems.pod:107
294 #: ../cat/virt-ls.pod:277 ../df/virt-df.pod:75 ../edit/virt-edit.pod:78
295 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:93
296 #: ../inspector/virt-inspector.pod:71 ../rescue/virt-rescue.pod:100
298 "The format of the disk image is auto-detected. To override this and force a "
299 "particular format use the I<--format=..> option."
303 #: ../cat/virt-cat.pod:81 ../cat/virt-filesystems.pod:125
304 #: ../cat/virt-ls.pod:291 ../df/virt-df.pod:78 ../rescue/virt-rescue.pod:107
309 #: ../cat/virt-cat.pod:83 ../cat/virt-filesystems.pod:127
310 #: ../cat/virt-ls.pod:293 ../df/virt-df.pod:80 ../rescue/virt-rescue.pod:109
311 msgid "B<--connect> URI"
315 #: ../cat/virt-cat.pod:85 ../cat/virt-filesystems.pod:129
316 #: ../cat/virt-ls.pod:295 ../df/virt-df.pod:82 ../edit/virt-edit.pod:99
317 #: ../inspector/virt-inspector.pod:78 ../rescue/virt-rescue.pod:111
318 #: ../tools/virt-list-filesystems.pl:81 ../tools/virt-list-partitions.pl:82
319 #: ../tools/virt-tar.pl:131 ../tools/virt-win-reg.pl:132
321 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
322 "to the default libvirt hypervisor."
326 #: ../cat/virt-cat.pod:88 ../cat/virt-filesystems.pod:132
327 #: ../cat/virt-ls.pod:298 ../df/virt-df.pod:85 ../rescue/virt-rescue.pod:114
329 "If you specify guest block devices directly (I<-a>), then libvirt is not "
334 #: ../cat/virt-cat.pod:91 ../cat/virt-filesystems.pod:141
335 #: ../cat/virt-ls.pod:307 ../df/virt-df.pod:88 ../edit/virt-edit.pod:105
336 #: ../inspector/virt-inspector.pod:85 ../rescue/virt-rescue.pod:117
341 #: ../cat/virt-cat.pod:93 ../cat/virt-filesystems.pod:143
342 #: ../cat/virt-ls.pod:309 ../df/virt-df.pod:90 ../edit/virt-edit.pod:107
343 #: ../inspector/virt-inspector.pod:87 ../rescue/virt-rescue.pod:119
344 msgid "B<--domain> guest"
348 #: ../cat/virt-cat.pod:95 ../cat/virt-filesystems.pod:145
349 #: ../cat/virt-ls.pod:311 ../df/virt-df.pod:92 ../edit/virt-edit.pod:109
350 #: ../inspector/virt-inspector.pod:89 ../rescue/virt-rescue.pod:121
352 "Add all the disks from the named libvirt guest. Domain UUIDs can be used "
357 #: ../cat/virt-cat.pod:98 ../cat/virt-filesystems.pod:148
358 #: ../cat/virt-ls.pod:314 ../edit/virt-edit.pod:112 ../fish/guestfish.pod:217
359 #: ../fuse/guestmount.pod:126 ../inspector/virt-inspector.pod:92
360 msgid "B<--echo-keys>"
364 #: ../cat/virt-cat.pod:100
366 "When prompting for keys and passphrases, virt-cat normally turns echoing off "
367 "so you cannot see what you are typing. If you are not worried about Tempest "
368 "attacks and there is no one else in the room you can specify this flag to "
369 "see what you are typing."
373 #: ../cat/virt-cat.pod:105 ../cat/virt-filesystems.pod:170
374 #: ../cat/virt-ls.pod:328 ../df/virt-df.pod:95 ../fish/guestfish.pod:233
375 #: ../fuse/guestmount.pod:133 ../inspector/virt-inspector.pod:99
376 #: ../rescue/virt-rescue.pod:124
377 msgid "B<--format=raw|qcow2|..>"
381 #: ../cat/virt-cat.pod:107 ../cat/virt-filesystems.pod:172
382 #: ../cat/virt-ls.pod:330 ../df/virt-df.pod:97 ../edit/virt-edit.pod:134
383 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:135
384 #: ../inspector/virt-inspector.pod:101 ../rescue/virt-rescue.pod:126
389 #: ../cat/virt-cat.pod:109 ../cat/virt-filesystems.pod:174
390 #: ../cat/virt-ls.pod:332 ../df/virt-df.pod:99 ../edit/virt-edit.pod:136
391 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:137
392 #: ../rescue/virt-rescue.pod:128
394 "The default for the I<-a> option is to auto-detect the format of the disk "
395 "image. Using this forces the disk format for I<-a> options which follow on "
396 "the command line. Using I<--format> with no argument switches back to auto-"
397 "detection for subsequent I<-a> options."
401 #: ../cat/virt-cat.pod:114 ../cat/virt-filesystems.pod:179
402 #: ../cat/virt-ls.pod:337 ../df/virt-df.pod:104 ../edit/virt-edit.pod:141
403 #: ../fish/guestfish.pod:242 ../fish/guestfish.pod:673
404 #: ../inspector/virt-inspector.pod:335 ../rescue/virt-rescue.pod:133
405 #: ../src/guestfs.pod:2652
410 #: ../cat/virt-cat.pod:116
413 " virt-cat --format=raw -a disk.img file\n"
418 #: ../cat/virt-cat.pod:118 ../cat/virt-filesystems.pod:183
419 #: ../cat/virt-ls.pod:341 ../df/virt-df.pod:108 ../edit/virt-edit.pod:145
420 #: ../fish/guestfish.pod:246 ../rescue/virt-rescue.pod:137
421 msgid "forces raw format (no auto-detection) for C<disk.img>."
425 #: ../cat/virt-cat.pod:120
428 " virt-cat --format=raw -a disk.img --format -a another.img file\n"
433 #: ../cat/virt-cat.pod:122 ../cat/virt-filesystems.pod:187
434 #: ../cat/virt-ls.pod:345 ../df/virt-df.pod:112 ../edit/virt-edit.pod:149
435 #: ../fish/guestfish.pod:250 ../rescue/virt-rescue.pod:141
437 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
438 "detection for C<another.img>."
442 #: ../cat/virt-cat.pod:125 ../cat/virt-filesystems.pod:190
443 #: ../cat/virt-ls.pod:348 ../df/virt-df.pod:115 ../edit/virt-edit.pod:152
444 #: ../rescue/virt-rescue.pod:144
446 "If you have untrusted raw-format guest disk images, you should use this "
447 "option to specify the disk format. This avoids a possible security problem "
448 "with malicious guests (CVE-2010-3851)."
452 #: ../cat/virt-cat.pod:129 ../cat/virt-filesystems.pod:200
453 #: ../cat/virt-ls.pod:361 ../edit/virt-edit.pod:156 ../fish/guestfish.pod:289
454 #: ../fuse/guestmount.pod:163 ../inspector/virt-inspector.pod:114
455 msgid "B<--keys-from-stdin>"
459 #: ../cat/virt-cat.pod:131 ../cat/virt-filesystems.pod:202
460 #: ../cat/virt-ls.pod:363 ../edit/virt-edit.pod:158 ../fish/guestfish.pod:291
461 #: ../fuse/guestmount.pod:165 ../inspector/virt-inspector.pod:116
463 "Read key or passphrase parameters from stdin. The default is to try to read "
464 "passphrases from the user by opening C</dev/tty>."
468 #: ../cat/virt-cat.pod:134 ../cat/virt-filesystems.pod:261
469 #: ../cat/virt-ls.pod:425 ../df/virt-df.pod:167 ../edit/virt-edit.pod:161
470 #: ../fish/guestfish.pod:390 ../fuse/guestmount.pod:257
471 #: ../inspector/virt-inspector.pod:119 ../rescue/virt-rescue.pod:178
476 #: ../cat/virt-cat.pod:136 ../cat/virt-filesystems.pod:263
477 #: ../cat/virt-ls.pod:427 ../df/virt-df.pod:169 ../edit/virt-edit.pod:163
478 #: ../fish/guestfish.pod:392 ../fuse/guestmount.pod:259
479 #: ../inspector/virt-inspector.pod:121 ../rescue/virt-rescue.pod:180
484 #: ../cat/virt-cat.pod:138 ../cat/virt-filesystems.pod:265
485 #: ../cat/virt-ls.pod:429 ../df/virt-df.pod:171 ../edit/virt-edit.pod:165
486 #: ../inspector/virt-inspector.pod:123 ../rescue/virt-rescue.pod:182
487 msgid "Enable verbose messages for debugging."
491 #: ../cat/virt-cat.pod:140 ../cat/virt-filesystems.pod:267
492 #: ../cat/virt-ls.pod:431 ../df/virt-df.pod:173 ../edit/virt-edit.pod:167
493 #: ../fish/guestfish.pod:397 ../fuse/guestmount.pod:263
494 #: ../inspector/virt-inspector.pod:125 ../rescue/virt-rescue.pod:184
495 #: ../resize/virt-resize.pod:478
500 #: ../cat/virt-cat.pod:142 ../cat/virt-filesystems.pod:269
501 #: ../cat/virt-ls.pod:433 ../df/virt-df.pod:175 ../edit/virt-edit.pod:169
502 #: ../fish/guestfish.pod:399 ../fuse/guestmount.pod:265
503 #: ../inspector/virt-inspector.pod:127 ../rescue/virt-rescue.pod:186
504 #: ../resize/virt-resize.pod:480 ../tools/virt-list-filesystems.pl:69
505 #: ../tools/virt-list-partitions.pl:70 ../tools/virt-make-fs.pl:169
506 #: ../tools/virt-tar.pl:119 ../tools/virt-win-reg.pl:112
511 #: ../cat/virt-cat.pod:144 ../cat/virt-filesystems.pod:271
512 #: ../cat/virt-ls.pod:435 ../df/virt-df.pod:177 ../edit/virt-edit.pod:171
513 #: ../inspector/virt-inspector.pod:129 ../rescue/virt-rescue.pod:188
514 #: ../resize/virt-resize.pod:482 ../tools/virt-list-filesystems.pl:71
515 #: ../tools/virt-list-partitions.pl:72 ../tools/virt-make-fs.pl:171
516 #: ../tools/virt-tar.pl:121 ../tools/virt-win-reg.pl:114
517 msgid "Display version number and exit."
521 #: ../cat/virt-cat.pod:146 ../cat/virt-filesystems.pod:281
522 #: ../cat/virt-ls.pod:437 ../df/virt-df.pod:179 ../edit/virt-edit.pod:173
523 #: ../fish/guestfish.pod:412 ../fuse/guestmount.pod:278
524 #: ../inspector/virt-inspector.pod:131 ../rescue/virt-rescue.pod:199
525 #: ../tools/virt-tar.pl:158
530 #: ../cat/virt-cat.pod:148 ../cat/virt-filesystems.pod:283
531 #: ../cat/virt-ls.pod:439 ../df/virt-df.pod:181 ../edit/virt-edit.pod:175
532 #: ../inspector/virt-inspector.pod:133 ../rescue/virt-rescue.pod:201
533 msgid "Enable tracing of libguestfs API calls."
537 #: ../cat/virt-cat.pod:152 ../cat/virt-ls.pod:443 ../edit/virt-edit.pod:179
538 #: ../inspector/virt-inspector.pod:137 ../rescue/virt-rescue.pod:205
539 msgid "OLD-STYLE COMMAND LINE ARGUMENTS"
543 #: ../cat/virt-cat.pod:154
544 msgid "Previous versions of virt-cat allowed you to write either:"
548 #: ../cat/virt-cat.pod:156
551 " virt-cat disk.img [disk.img ...] file\n"
556 #: ../cat/virt-cat.pod:158 ../cat/virt-ls.pod:449 ../edit/virt-edit.pod:185
557 #: ../inspector/virt-inspector.pod:143 ../rescue/virt-rescue.pod:211
562 #: ../cat/virt-cat.pod:160
565 " virt-cat guestname file\n"
570 #: ../cat/virt-cat.pod:162 ../cat/virt-ls.pod:453 ../edit/virt-edit.pod:189
571 #: ../inspector/virt-inspector.pod:147 ../rescue/virt-rescue.pod:215
573 "whereas in this version you should use I<-a> or I<-d> respectively to avoid "
574 "the confusing case where a disk image might have the same name as a guest."
578 #: ../cat/virt-cat.pod:166 ../cat/virt-ls.pod:457 ../edit/virt-edit.pod:193
579 #: ../inspector/virt-inspector.pod:151 ../rescue/virt-rescue.pod:219
580 msgid "For compatibility the old style is still supported."
584 #: ../cat/virt-cat.pod:168 ../edit/virt-edit.pod:297
585 msgid "USING GUESTFISH"
589 #: ../cat/virt-cat.pod:170
591 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
592 "C<virt-cat> doesn't work."
596 #: ../cat/virt-cat.pod:173
597 msgid "Using C<virt-cat> is approximately equivalent to doing:"
601 #: ../cat/virt-cat.pod:175
604 " guestfish --ro -i -d domname download file -\n"
609 #: ../cat/virt-cat.pod:177
611 "where C<domname> is the name of the libvirt guest, and C<file> is the full "
612 "path to the file. Note the final C<-> (meaning \"output to stdout\")."
616 #: ../cat/virt-cat.pod:181
618 "The command above uses libguestfs's guest inspection feature and so does not "
619 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
620 "disk images that don't contain guests. To display a file from a disk image "
625 #: ../cat/virt-cat.pod:186
628 " guestfish --ro -a disk.img -m /dev/sda1 download file -\n"
633 #: ../cat/virt-cat.pod:188
635 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
636 "the disk image to edit, and C<file> is the full path to the file."
640 #: ../cat/virt-cat.pod:192 ../cat/virt-filesystems.pod:365
641 #: ../cat/virt-ls.pod:483 ../df/virt-df.pod:209 ../edit/virt-edit.pod:342
642 #: ../inspector/virt-inspector.pod:349 ../rescue/virt-rescue.pod:262
643 #: ../resize/virt-resize.pod:543 ../tools/virt-list-filesystems.pl:188
644 #: ../tools/virt-list-partitions.pl:258 ../tools/virt-make-fs.pl:532
645 #: ../tools/virt-tar.pl:289 ../tools/virt-win-reg.pl:733
646 msgid "SHELL QUOTING"
650 #: ../cat/virt-cat.pod:194 ../cat/virt-filesystems.pod:367
651 #: ../cat/virt-ls.pod:485 ../df/virt-df.pod:211 ../edit/virt-edit.pod:344
652 #: ../inspector/virt-inspector.pod:351 ../rescue/virt-rescue.pod:264
653 #: ../resize/virt-resize.pod:545 ../tools/virt-list-filesystems.pl:190
654 #: ../tools/virt-list-partitions.pl:260 ../tools/virt-make-fs.pl:534
655 #: ../tools/virt-tar.pl:291 ../tools/virt-win-reg.pl:741
657 "Libvirt guest names can contain arbitrary characters, some of which have "
658 "meaning to the shell such as C<#> and space. You may need to quote or "
659 "escape these characters on the command line. See the shell manual page L<sh"
664 #: ../cat/virt-cat.pod:199 ../cat/virt-filesystems.pod:372
665 #: ../cat/virt-ls.pod:490 ../df/virt-df.pod:216 ../edit/virt-edit.pod:349
666 #: ../examples/guestfs-examples.pod:33 ../examples/guestfs-recipes.pod:384
667 #: ../fish/guestfish.pod:1214 ../fish/virt-copy-in.pod:50
668 #: ../fish/virt-copy-out.pod:39 ../fish/virt-tar-in.pod:47
669 #: ../fish/virt-tar-out.pod:41 ../fuse/guestmount.pod:303
670 #: ../inspector/virt-inspector.pod:372 ../java/examples/guestfs-java.pod:45
671 #: ../ocaml/examples/guestfs-ocaml.pod:78 ../perl/examples/guestfs-perl.pod:39
672 #: ../python/examples/guestfs-python.pod:42 ../rescue/virt-rescue.pod:284
673 #: ../resize/virt-resize.pod:550 ../ruby/examples/guestfs-ruby.pod:36
674 #: ../src/guestfs.pod:3016 ../test-tool/libguestfs-test-tool.pod:87
675 #: ../tools/virt-list-filesystems.pl:195 ../tools/virt-list-partitions.pl:265
676 #: ../tools/virt-make-fs.pl:539 ../tools/virt-tar.pl:296
677 #: ../tools/virt-win-reg.pl:746
682 #: ../cat/virt-cat.pod:201
684 "L<guestfs(3)>, L<guestfish(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, L<virt-"
685 "tar-out(1)>, L<http://libguestfs.org/>."
689 #: ../cat/virt-cat.pod:208 ../cat/virt-filesystems.pod:383
690 #: ../cat/virt-ls.pod:502 ../df/virt-df.pod:224 ../edit/virt-edit.pod:363
691 #: ../rescue/virt-rescue.pod:292 ../resize/virt-resize.pod:571
692 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-list-partitions.pl:277
693 #: ../tools/virt-make-fs.pl:564 ../tools/virt-tar.pl:311
694 #: ../tools/virt-win-reg.pl:772
699 #: ../cat/virt-cat.pod:210 ../cat/virt-filesystems.pod:385
700 #: ../cat/virt-ls.pod:504 ../df/virt-df.pod:226 ../edit/virt-edit.pod:365
701 #: ../inspector/virt-inspector.pod:386 ../rescue/virt-rescue.pod:294
702 #: ../resize/virt-resize.pod:573 ../tools/virt-list-filesystems.pl:210
703 #: ../tools/virt-list-partitions.pl:279 ../tools/virt-make-fs.pl:566
704 #: ../tools/virt-tar.pl:313 ../tools/virt-win-reg.pl:774
705 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
709 #: ../cat/virt-cat.pod:212 ../cat/virt-filesystems.pod:387
710 #: ../cat/virt-ls.pod:506 ../df/virt-df.pod:228 ../edit/virt-edit.pod:367
711 #: ../examples/guestfs-examples.pod:48 ../examples/guestfs-recipes.pod:400
712 #: ../fish/guestfish.pod:1242 ../fish/virt-copy-in.pod:64
713 #: ../fish/virt-copy-out.pod:53 ../fish/virt-tar-in.pod:62
714 #: ../fish/virt-tar-out.pod:55 ../fuse/guestmount.pod:318
715 #: ../inspector/virt-inspector.pod:394 ../java/examples/guestfs-java.pod:61
716 #: ../ocaml/examples/guestfs-ocaml.pod:94 ../perl/examples/guestfs-perl.pod:55
717 #: ../python/examples/guestfs-python.pod:57 ../rescue/virt-rescue.pod:296
718 #: ../resize/virt-resize.pod:575 ../ruby/examples/guestfs-ruby.pod:51
719 #: ../src/guestfs.pod:3091 ../test-tool/libguestfs-test-tool.pod:97
720 #: ../tools/virt-list-filesystems.pl:212 ../tools/virt-list-partitions.pl:281
721 #: ../tools/virt-make-fs.pl:568 ../tools/virt-tar.pl:315
722 #: ../tools/virt-win-reg.pl:776
727 #: ../cat/virt-cat.pod:214 ../inspector/virt-inspector.pod:396
728 #: ../resize/virt-resize.pod:577
729 msgid "Copyright (C) 2010-2011 Red Hat Inc."
733 #: ../cat/virt-cat.pod:216 ../cat/virt-filesystems.pod:391
734 #: ../cat/virt-ls.pod:510 ../df/virt-df.pod:232 ../edit/virt-edit.pod:371
735 #: ../fish/guestfish.pod:1247 ../fish/virt-copy-in.pod:69
736 #: ../fish/virt-copy-out.pod:58 ../fish/virt-tar-in.pod:67
737 #: ../fish/virt-tar-out.pod:60 ../fuse/guestmount.pod:323
738 #: ../inspector/virt-inspector.pod:398 ../rescue/virt-rescue.pod:300
739 #: ../resize/virt-resize.pod:579 ../test-tool/libguestfs-test-tool.pod:102
740 #: ../tools/virt-list-filesystems.pl:216 ../tools/virt-list-partitions.pl:285
741 #: ../tools/virt-make-fs.pl:572 ../tools/virt-tar.pl:319
742 #: ../tools/virt-win-reg.pl:780
744 "This program is free software; you can redistribute it and/or modify it "
745 "under the terms of the GNU General Public License as published by the Free "
746 "Software Foundation; either version 2 of the License, or (at your option) "
751 #: ../cat/virt-cat.pod:221 ../cat/virt-filesystems.pod:396
752 #: ../cat/virt-ls.pod:515 ../df/virt-df.pod:237 ../edit/virt-edit.pod:376
753 #: ../fish/guestfish.pod:1252 ../fish/virt-copy-in.pod:74
754 #: ../fish/virt-copy-out.pod:63 ../fish/virt-tar-in.pod:72
755 #: ../fish/virt-tar-out.pod:65 ../fuse/guestmount.pod:328
756 #: ../inspector/virt-inspector.pod:403 ../rescue/virt-rescue.pod:305
757 #: ../resize/virt-resize.pod:584 ../test-tool/libguestfs-test-tool.pod:107
758 #: ../tools/virt-list-filesystems.pl:221 ../tools/virt-list-partitions.pl:290
759 #: ../tools/virt-make-fs.pl:577 ../tools/virt-tar.pl:324
760 #: ../tools/virt-win-reg.pl:785
762 "This program is distributed in the hope that it will be useful, but WITHOUT "
763 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
764 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
769 #: ../cat/virt-cat.pod:226 ../cat/virt-filesystems.pod:401
770 #: ../cat/virt-ls.pod:520 ../df/virt-df.pod:242 ../edit/virt-edit.pod:381
771 #: ../fish/guestfish.pod:1257 ../fish/virt-copy-in.pod:79
772 #: ../fish/virt-copy-out.pod:68 ../fish/virt-tar-in.pod:77
773 #: ../fish/virt-tar-out.pod:70 ../fuse/guestmount.pod:333
774 #: ../inspector/virt-inspector.pod:408 ../rescue/virt-rescue.pod:310
775 #: ../resize/virt-resize.pod:589 ../test-tool/libguestfs-test-tool.pod:112
776 #: ../tools/virt-list-filesystems.pl:226 ../tools/virt-list-partitions.pl:295
777 #: ../tools/virt-make-fs.pl:582 ../tools/virt-tar.pl:329
778 #: ../tools/virt-win-reg.pl:790
780 "You should have received a copy of the GNU General Public License along with "
781 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
782 "Ave, Cambridge, MA 02139, USA."
786 #: ../cat/virt-filesystems.pod:5
788 "virt-filesystems - List filesystems, partitions, block devices, LVM in a "
789 "virtual machine or disk image"
793 #: ../cat/virt-filesystems.pod:9
796 " virt-filesystems [--options] -d domname\n"
801 #: ../cat/virt-filesystems.pod:11
804 " virt-filesystems [--options] -a disk.img [-a disk.img ...]\n"
809 #: ../cat/virt-filesystems.pod:15
811 "This tool allows you to discover filesystems, partitions, logical volumes, "
812 "and their sizes in a disk image or virtual machine. It is a replacement for "
813 "L<virt-list-filesystems(1)> and L<virt-list-partitions(1)>."
817 #: ../cat/virt-filesystems.pod:20
819 "One use for this tool is from shell scripts to iterate over all filesystems "
824 #: ../cat/virt-filesystems.pod:23
827 " for fs in $(virt-filesystems -a disk.img); do\n"
834 #: ../cat/virt-filesystems.pod:27
836 "Another use is to list partitions before using another tool to modify those "
837 "partitions (such as L<virt-resize(1)>). If you are curious about what an "
838 "unknown disk image contains, use this tool along with L<virt-inspector(1)>."
842 #: ../cat/virt-filesystems.pod:32
844 "Various command line options control what this program displays. You need "
845 "to give either I<-a> or I<-d> options to specify the disk image or libvirt "
846 "guest respectively. If you just specify that then the program shows "
847 "filesystems found, one per line, like this:"
851 #: ../cat/virt-filesystems.pod:37
854 " $ virt-filesystems -a disk.img\n"
856 " /dev/vg_guest/lv_root\n"
861 #: ../cat/virt-filesystems.pod:41
863 "If you add I<-l> or I<--long> then the output includes extra information:"
867 #: ../cat/virt-filesystems.pod:44
870 " $ virt-filesystems -a disk.img -l\n"
871 " Name Type VFS Label Size\n"
872 " /dev/sda1 filesystem ext4 boot 524288000\n"
873 " /dev/vg_guest/lv_root filesystem ext4 root 10212081664\n"
878 #: ../cat/virt-filesystems.pod:49
880 "If you add I<--extra> then non-mountable (swap, unknown) filesystems are "
885 #: ../cat/virt-filesystems.pod:52
888 " $ virt-filesystems -a disk.img --extra\n"
890 " /dev/vg_guest/lv_root\n"
891 " /dev/vg_guest/lv_swap\n"
892 " /dev/vg_guest/lv_data\n"
897 #: ../cat/virt-filesystems.pod:58
899 "If you add I<--partitions> then partitions are shown instead of filesystems:"
903 #: ../cat/virt-filesystems.pod:60
906 " $ virt-filesystems -a disk.img --partitions\n"
913 #: ../cat/virt-filesystems.pod:64
915 "Similarly you can use I<--logical-volumes>, I<--volume-groups>, I<--physical-"
916 "volumes>, I<--block-devices> to list those items."
920 #: ../cat/virt-filesystems.pod:67
922 "You can use these options in combination as well (if you want a combination "
923 "including filesystems, you have to add I<--filesystems>). Notice that some "
924 "items fall into several categories (eg. C</dev/sda1> might be both a "
925 "partition and a filesystem). These items are listed several times. To get "
926 "a list which includes absolutely everything that virt-filesystems knows "
927 "about, use the I<--all> option."
931 #: ../cat/virt-filesystems.pod:74
933 "UUIDs (because they are quite long) are not shown by default. Add the I<--"
934 "uuid> option to display device and filesystem UUIDs in the long output."
938 #: ../cat/virt-filesystems.pod:78
940 "I<--all --long --uuid> is a useful combination to display all possible "
941 "information about everything."
945 #: ../cat/virt-filesystems.pod:81
948 " $ virt-filesystems -a win.img --all --long --uuid -h\n"
949 " Name Type VFS Label Size Parent UUID\n"
950 " /dev/sda1 filesystem ntfs System Reserved 100M - F81C92571C92112C\n"
951 " /dev/sda2 filesystem ntfs - 20G - F2E8996AE8992E3B\n"
952 " /dev/sda1 partition - - 100M /dev/sda -\n"
953 " /dev/sda2 partition - - 20G /dev/sda -\n"
954 " /dev/sda device - - 20G - -\n"
959 #: ../cat/virt-filesystems.pod:89
961 "For machine-readable output, use I<--csv> to get Comma-Separated Values."
965 #: ../cat/virt-filesystems.pod:110 ../tools/virt-list-filesystems.pl:121
970 #: ../cat/virt-filesystems.pod:112
972 "Display everything. This is currently the same as specifying these options: "
973 "I<--filesystems>, I<--extra>, I<--partitions>, I<--block-devices>, I<--"
974 "logical-volumes>, I<--volume-groups>, I<--physical-volumes>. (More may be "
975 "added to this list in future)."
979 #: ../cat/virt-filesystems.pod:117
980 msgid "See also I<--long>."
984 #: ../cat/virt-filesystems.pod:119
989 #: ../cat/virt-filesystems.pod:121
990 msgid "B<--block-devices>"
994 #: ../cat/virt-filesystems.pod:123
995 msgid "Display block devices."
999 #: ../cat/virt-filesystems.pod:135 ../cat/virt-ls.pod:301
1004 #: ../cat/virt-filesystems.pod:137 ../cat/virt-ls.pod:303
1006 "Write out the results in CSV format (comma-separated values). This format "
1007 "can be imported easily into databases and spreadsheets, but read L</NOTE "
1008 "ABOUT CSV FORMAT> below."
1012 #: ../cat/virt-filesystems.pod:150
1014 "When prompting for keys and passphrases, virt-filesystems normally turns "
1015 "echoing off so you cannot see what you are typing. If you are not worried "
1016 "about Tempest attacks and there is no one else in the room you can specify "
1017 "this flag to see what you are typing."
1021 #: ../cat/virt-filesystems.pod:155
1026 #: ../cat/virt-filesystems.pod:157
1028 "This causes filesystems that are not ordinary, mountable filesystems to be "
1029 "displayed. This category includes swapspace, and filesystems that are empty "
1030 "or contain unknown data."
1034 #: ../cat/virt-filesystems.pod:161
1035 msgid "This option implies I<--filesystems>."
1039 #: ../cat/virt-filesystems.pod:163
1040 msgid "B<--filesystems>"
1044 #: ../cat/virt-filesystems.pod:165
1046 "Display mountable filesystems. If no display option was selected then this "
1047 "option is implied."
1051 #: ../cat/virt-filesystems.pod:168
1052 msgid "With I<--extra>, non-mountable filesystems are shown too."
1056 #: ../cat/virt-filesystems.pod:181
1059 " virt-filesystems --format=raw -a disk.img\n"
1064 #: ../cat/virt-filesystems.pod:185
1067 " virt-filesystems --format=raw -a disk.img --format -a another.img\n"
1072 #: ../cat/virt-filesystems.pod:194 ../cat/virt-ls.pod:352
1073 #: ../df/virt-df.pod:119 ../fish/guestfish.pod:156
1074 #: ../tools/virt-list-partitions.pl:109
1079 #: ../cat/virt-filesystems.pod:196 ../cat/virt-ls.pod:354
1080 #: ../df/virt-df.pod:121 ../tools/virt-list-partitions.pl:111
1081 msgid "B<--human-readable>"
1085 #: ../cat/virt-filesystems.pod:198
1086 msgid "In I<--long> mode, display sizes in human-readable format."
1090 #: ../cat/virt-filesystems.pod:205 ../cat/virt-ls.pod:366
1091 #: ../tools/virt-list-filesystems.pl:108 ../tools/virt-list-partitions.pl:119
1096 #: ../cat/virt-filesystems.pod:207 ../cat/virt-ls.pod:368
1097 #: ../tools/virt-list-filesystems.pl:110 ../tools/virt-list-partitions.pl:121
1102 #: ../cat/virt-filesystems.pod:209
1103 msgid "Display extra columns of data (\"long format\")."
1107 #: ../cat/virt-filesystems.pod:211
1108 msgid "A title row is added unless you also specify I<--no-title>."
1112 #: ../cat/virt-filesystems.pod:213
1114 "The extra columns displayed depend on what output you select, and the "
1115 "ordering of columns may change in future versions. Use the title row, I<--"
1116 "csv> output and/or L<csvtool(1)> to match columns to data in external "
1121 #: ../cat/virt-filesystems.pod:218
1123 "Use I<-h> if you want sizes to be displayed in human-readable format. The "
1124 "default is to show raw numbers of I<bytes>."
1128 #: ../cat/virt-filesystems.pod:221
1129 msgid "Use I<--uuid> to display UUIDs too."
1133 #: ../cat/virt-filesystems.pod:223
1138 #: ../cat/virt-filesystems.pod:225
1139 msgid "B<--logvols>"
1143 #: ../cat/virt-filesystems.pod:227
1144 msgid "B<--logical-volumes>"
1148 #: ../cat/virt-filesystems.pod:229
1150 "Display LVM logical volumes. In this mode, these are displayed irrespective "
1151 "of whether the LVs contain filesystems."
1155 #: ../cat/virt-filesystems.pod:232
1156 msgid "B<--no-title>"
1160 #: ../cat/virt-filesystems.pod:234
1161 msgid "In I<--long> mode, don't add a title row."
1165 #: ../cat/virt-filesystems.pod:236
1167 "Note that the order of the columns is not fixed, and may change in future "
1168 "versions of virt-filesystems, so using this option may give you unexpected "
1173 #: ../cat/virt-filesystems.pod:240
1178 #: ../cat/virt-filesystems.pod:242
1179 msgid "B<--partitions>"
1183 #: ../cat/virt-filesystems.pod:244
1185 "Display partitions. In this mode, these are displayed irrespective of "
1186 "whether the partitions contain filesystems."
1190 #: ../cat/virt-filesystems.pod:247
1195 #: ../cat/virt-filesystems.pod:249
1196 msgid "B<--physvols>"
1200 #: ../cat/virt-filesystems.pod:251
1201 msgid "B<--physical-volumes>"
1205 #: ../cat/virt-filesystems.pod:253
1206 msgid "Display LVM physical volumes."
1210 #: ../cat/virt-filesystems.pod:255 ../df/virt-df.pod:157
1215 #: ../cat/virt-filesystems.pod:257
1220 #: ../cat/virt-filesystems.pod:259
1221 msgid "In I<--long> mode, display UUIDs as well."
1225 #: ../cat/virt-filesystems.pod:273
1230 #: ../cat/virt-filesystems.pod:275
1231 msgid "B<--volgroups>"
1235 #: ../cat/virt-filesystems.pod:277
1236 msgid "B<--volume-groups>"
1240 #: ../cat/virt-filesystems.pod:279
1241 msgid "Display LVM volume groups."
1245 #: ../cat/virt-filesystems.pod:287
1250 #: ../cat/virt-filesystems.pod:289
1252 "Note that columns in the output are subject to reordering and change in "
1253 "future versions of this tool."
1257 #: ../cat/virt-filesystems.pod:294
1262 #: ../cat/virt-filesystems.pod:296
1263 msgid "The filesystem, partition, block device or LVM name."
1267 #: ../cat/virt-filesystems.pod:298
1269 "For device and partition names these are displayed as canonical libguestfs "
1270 "names, so that for example C</dev/sda2> is the second partition on the first "
1275 #: ../cat/virt-filesystems.pod:302
1277 "If the I<--long> option is B<not> specified, then only the name column is "
1278 "shown in the output."
1282 #: ../cat/virt-filesystems.pod:305
1287 #: ../cat/virt-filesystems.pod:307
1288 msgid "The object type, for example C<filesystem>, C<lv>, C<device> etc."
1292 #: ../cat/virt-filesystems.pod:309
1297 #: ../cat/virt-filesystems.pod:311
1299 "If there is a filesystem, then this column displays the filesystem type if "
1300 "one could be detected, eg. C<ext4>."
1304 #: ../cat/virt-filesystems.pod:314
1309 #: ../cat/virt-filesystems.pod:316
1311 "If the object has a label (used for identifying and mounting filesystems) "
1312 "then this column contains the label."
1316 #: ../cat/virt-filesystems.pod:319
1321 #: ../cat/virt-filesystems.pod:321
1323 "The size of the object in bytes. If the I<--human> option is used then the "
1324 "size is displayed in a human-readable form."
1328 #: ../cat/virt-filesystems.pod:324
1333 #: ../cat/virt-filesystems.pod:326
1335 "The parent column records the parent relationship between objects. For "
1336 "example, if the object is a partition, then this column contains the name of "
1337 "the containing device. If the object is a logical volume, then this column "
1338 "is the name of the volume group."
1342 #: ../cat/virt-filesystems.pod:331
1347 #: ../cat/virt-filesystems.pod:333
1349 "If the object has a UUID (used for identifying and mounting filesystems and "
1350 "block devices) then this column contains the UUID as a string."
1354 #: ../cat/virt-filesystems.pod:337
1355 msgid "The UUID is only displayed if the I<--uuid> option is given."
1359 #: ../cat/virt-filesystems.pod:341 ../cat/virt-ls.pod:459
1360 #: ../df/virt-df.pod:185
1361 msgid "NOTE ABOUT CSV FORMAT"
1365 #: ../cat/virt-filesystems.pod:343 ../cat/virt-ls.pod:461
1366 #: ../df/virt-df.pod:187
1368 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
1369 "should be easy to parse, but it is definitely not easy to parse."
1373 #: ../cat/virt-filesystems.pod:346 ../cat/virt-ls.pod:464
1374 #: ../df/virt-df.pod:190
1376 "Myth: Just split fields at commas. Reality: This does I<not> work "
1377 "reliably. This example has two columns:"
1381 #: ../cat/virt-filesystems.pod:349 ../cat/virt-ls.pod:467
1382 #: ../df/virt-df.pod:193
1385 " \"foo,bar\",baz\n"
1390 #: ../cat/virt-filesystems.pod:351 ../cat/virt-ls.pod:469
1391 #: ../df/virt-df.pod:195
1393 "Myth: Read the file one line at a time. Reality: This does I<not> work "
1394 "reliably. This example has one row:"
1398 #: ../cat/virt-filesystems.pod:354 ../cat/virt-ls.pod:472
1399 #: ../df/virt-df.pod:198
1408 #: ../cat/virt-filesystems.pod:357 ../cat/virt-ls.pod:475
1409 #: ../df/virt-df.pod:201
1411 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
1412 "packaged in major Linux distributions)."
1416 #: ../cat/virt-filesystems.pod:360 ../cat/virt-ls.pod:478
1417 #: ../df/virt-df.pod:204
1419 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
1420 "or Python's built-in csv library)."
1424 #: ../cat/virt-filesystems.pod:363 ../cat/virt-ls.pod:481
1425 #: ../df/virt-df.pod:207
1426 msgid "Most spreadsheets and databases can import CSV directly."
1430 #: ../cat/virt-filesystems.pod:374
1432 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-df(1)>, L<virt-list-"
1433 "filesystems(1)>, L<virt-list-partitions(1)>, L<csvtool(1)>, L<http://"
1438 #: ../cat/virt-filesystems.pod:389 ../tools/virt-make-fs.pl:570
1439 #: ../tools/virt-win-reg.pl:778
1440 msgid "Copyright (C) 2010 Red Hat Inc."
1444 #: ../cat/virt-ls.pod:5
1445 msgid "virt-ls - List files in a virtual machine"
1449 #: ../cat/virt-ls.pod:9
1452 " virt-ls [--options] -d domname directory [directory ...]\n"
1457 #: ../cat/virt-ls.pod:11
1460 " virt-ls [--options] -a disk.img [-a disk.img ...] directory [directory ...]\n"
1465 #: ../cat/virt-ls.pod:13 ../df/virt-df.pod:15 ../rescue/virt-rescue.pod:13
1470 #: ../cat/virt-ls.pod:15
1473 " virt-ls [--options] domname directory\n"
1478 #: ../cat/virt-ls.pod:17
1481 " virt-ls [--options] disk.img [disk.img ...] directory\n"
1486 #: ../cat/virt-ls.pod:21
1488 "C<virt-ls> lists filenames, file sizes, checksums, extended attributes and "
1489 "more from a virtual machine or disk image."
1493 #: ../cat/virt-ls.pod:24
1495 "Multiple directory names can be given, in which case the output from each is "
1500 #: ../cat/virt-ls.pod:27
1502 "To list directories from a libvirt guest use the I<-d> option to specify the "
1503 "name of the guest. For a disk image, use the I<-a> option."
1507 #: ../cat/virt-ls.pod:31
1509 "C<virt-ls> can do many simple file listings. For more complicated cases you "
1510 "may need to use L<guestfish(1)>, or write a program directly to the L<guestfs"
1515 #: ../cat/virt-ls.pod:37
1516 msgid "Get a list of all files and directories in a virtual machine:"
1520 #: ../cat/virt-ls.pod:39
1523 " virt-ls -R -d guest /\n"
1528 #: ../cat/virt-ls.pod:41
1529 msgid "List all setuid or setgid programs in a Linux virtual machine:"
1533 #: ../cat/virt-ls.pod:43
1536 " virt-ls -lR -d guest / | grep '^- [42]'\n"
1541 #: ../cat/virt-ls.pod:45
1542 msgid "List all public-writable directories in a Linux virtual machine:"
1546 #: ../cat/virt-ls.pod:47
1549 " virt-ls -lR -d guest / | grep '^d ...7'\n"
1554 #: ../cat/virt-ls.pod:49
1555 msgid "List all Unix domain sockets in a Linux virtual machine:"
1559 #: ../cat/virt-ls.pod:51
1562 " virt-ls -lR -d guest / | grep '^s'\n"
1567 #: ../cat/virt-ls.pod:53
1568 msgid "List all regular files with filenames ending in '.png':"
1572 #: ../cat/virt-ls.pod:55
1575 " virt-ls -lR -d guest / | grep -i '^-.*\\.png$'\n"
1580 #: ../cat/virt-ls.pod:57
1581 msgid "To display files larger than 10MB in home directories:"
1585 #: ../cat/virt-ls.pod:59
1588 " virt-ls -lR -d guest /home | awk '$3 > 10*1024*1024'\n"
1593 #: ../cat/virt-ls.pod:61
1594 msgid "Find everything modified in the last 7 days:"
1598 #: ../cat/virt-ls.pod:63
1601 " virt-ls -lR -d guest --time-days / | awk '$6 <= 7'\n"
1606 #: ../cat/virt-ls.pod:65
1607 msgid "Find regular files modified in the last 24 hours:"
1611 #: ../cat/virt-ls.pod:67
1614 " virt-ls -lR -d guest --time-days / | grep '^-' | awk '$6 < 1'\n"
1619 #: ../cat/virt-ls.pod:69
1620 msgid "DIFFERENCES IN SNAPSHOTS AND BACKING FILES"
1624 #: ../cat/virt-ls.pod:71
1626 "Find the differences between files in a guest and an earlier snapshot of the "
1631 #: ../cat/virt-ls.pod:74
1634 " virt-ls -lR -a snapshot.img / --uids --time-t > old\n"
1635 " virt-ls -lR -a current.img / --uids --time-t > new\n"
1636 " diff -u old new | less\n"
1641 #: ../cat/virt-ls.pod:78
1643 "The commands above won't find files where the content has changed but the "
1644 "metadata (eg. file size and modification date) is the same. To do that, you "
1645 "need to add the I<--checksum> parameter to both C<virt-ls> commands. I<--"
1646 "checksum> can be quite slow since it has to read and compute a checksum of "
1647 "every regular file in the virtual machine."
1651 #: ../cat/virt-ls.pod:84
1652 msgid "OUTPUT MODES"
1656 #: ../cat/virt-ls.pod:86
1658 "C<virt-ls> has four output modes, controlled by different combinations of "
1659 "the I<-l> and I<-R> options."
1663 #: ../cat/virt-ls.pod:89
1664 msgid "SIMPLE LISTING"
1668 #: ../cat/virt-ls.pod:91
1669 msgid "A simple listing is like the ordinary L<ls(1)> command:"
1673 #: ../cat/virt-ls.pod:93
1676 " $ virt-ls -d guest /\n"
1684 #: ../cat/virt-ls.pod:98
1685 msgid "LONG LISTING"
1689 #: ../cat/virt-ls.pod:100
1691 "With the I<-l> (I<--long>) option, the output is like the C<ls -l> command "
1692 "(more specifically, like the C<guestfs_ll> function)."
1696 #: ../cat/virt-ls.pod:103
1699 " $ virt-ls -l -d guest /\n"
1701 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
1702 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
1708 #: ../cat/virt-ls.pod:109
1710 "Note that while this is useful for displaying a directory, do not try "
1711 "parsing this output in another program. Use L</RECURSIVE LONG LISTING> "
1716 #: ../cat/virt-ls.pod:113
1717 msgid "RECURSIVE LISTING"
1721 #: ../cat/virt-ls.pod:115
1723 "With the I<-R> (I<--recursive>) option, C<virt-ls> lists the names of files "
1724 "and directories recursively:"
1728 #: ../cat/virt-ls.pod:118
1731 " $ virt-ls -R -d guest /tmp\n"
1739 #: ../cat/virt-ls.pod:123
1741 "To generate this output, C<virt-ls> runs the C<guestfs_find0> function and "
1742 "converts C<\\0> characters to C<\\n>."
1746 #: ../cat/virt-ls.pod:126
1747 msgid "RECURSIVE LONG LISTING"
1751 #: ../cat/virt-ls.pod:128
1753 "Using I<-lR> options together changes the output to display directories "
1754 "recursively, with file stats, and optionally other features such as "
1755 "checksums and extended attributes."
1759 #: ../cat/virt-ls.pod:132
1761 "Most of the interesting features of C<virt-ls> are only available when using "
1766 #: ../cat/virt-ls.pod:135
1768 "The fields are normally space-separated. Filenames are B<not> quoted, so "
1769 "you cannot use the output in another program (because filenames can contain "
1770 "spaces and other unsafe characters). If the guest was untrusted and someone "
1771 "knew you were using C<virt-ls> to analyze the guest, they could play tricks "
1772 "on you by creating filenames with embedded newline characters. To B<safely> "
1773 "parse the output in another program, use the I<--csv> (Comma-Separated "
1778 #: ../cat/virt-ls.pod:143
1780 "Note that this output format is completely unrelated to the C<ls -lR> "
1785 #: ../cat/virt-ls.pod:146
1788 " $ virt-ls -lR -d guest /bin\n"
1789 " d 0555 4096 /bin\n"
1790 " - 0755 123 /bin/alsaunmute\n"
1791 " - 0755 28328 /bin/arch\n"
1792 " l 0777 4 /bin/awk -> gawk\n"
1793 " - 0755 27216 /bin/basename\n"
1794 " - 0755 943360 /bin/bash\n"
1800 #: ../cat/virt-ls.pod:155
1801 msgid "These basic fields are always shown:"
1805 #: ../cat/virt-ls.pod:159
1810 #: ../cat/virt-ls.pod:161
1812 "The file type, one of: C<-> (regular file), C<d> (directory), C<c> "
1813 "(character device), C<b> (block device), C<p> (named pipe), C<l> (symbolic "
1814 "link), C<s> (socket) or C<u> (unknown)."
1818 #: ../cat/virt-ls.pod:171
1823 #: ../cat/virt-ls.pod:173
1824 msgid "The Unix permissions, displayed as a 4 digit octal number."
1828 #: ../cat/virt-ls.pod:175
1833 #: ../cat/virt-ls.pod:177
1835 "The size of the file. This is shown in bytes unless I<-h> or I<--human-"
1836 "readable> option is given, in which case this is shown as a human-readable "
1841 #: ../cat/virt-ls.pod:181 ../fish/guestfish-actions.pod:4183
1846 #: ../cat/virt-ls.pod:183
1847 msgid "The full path of the file or directory."
1851 #: ../cat/virt-ls.pod:185
1856 #: ../cat/virt-ls.pod:187
1857 msgid "For symbolic links only, the link target."
1861 #: ../cat/virt-ls.pod:191
1863 "In I<-lR> mode, additional command line options enable the display of more "
1868 #: ../cat/virt-ls.pod:194
1870 "With the I<--uids> flag, these additional fields are displayed before the "
1875 #: ../cat/virt-ls.pod:199
1880 #: ../cat/virt-ls.pod:201
1885 #: ../cat/virt-ls.pod:203
1887 "The UID and GID of the owner of the file (displayed numerically). Note "
1888 "these only make sense in the context of a Unix-like guest."
1892 #: ../cat/virt-ls.pod:208
1893 msgid "With the I<--times> flag, these additional fields are displayed:"
1897 #: ../cat/virt-ls.pod:212
1902 #: ../cat/virt-ls.pod:214
1903 msgid "The time of last access."
1907 #: ../cat/virt-ls.pod:216
1912 #: ../cat/virt-ls.pod:218
1913 msgid "The time of last modification."
1917 #: ../cat/virt-ls.pod:220
1922 #: ../cat/virt-ls.pod:222
1923 msgid "The time of last status change."
1927 #: ../cat/virt-ls.pod:226
1929 "The time fields are displayed as string dates and times, unless one of the "
1930 "I<--time-t>, I<--time-relative> or I<--time-days> flags is given."
1934 #: ../cat/virt-ls.pod:229
1935 msgid "With the I<--extra-stats> flag, these additional fields are displayed:"
1939 #: ../cat/virt-ls.pod:233
1944 #: ../cat/virt-ls.pod:235
1946 "The device containing the file (displayed as major:minor). This may not "
1947 "match devices as known to the guest."
1951 #: ../cat/virt-ls.pod:238
1956 #: ../cat/virt-ls.pod:240
1957 msgid "The inode number."
1961 #: ../cat/virt-ls.pod:242
1966 #: ../cat/virt-ls.pod:244
1967 msgid "The number of hard links."
1971 #: ../cat/virt-ls.pod:246
1976 #: ../cat/virt-ls.pod:248
1978 "For block and char special files, the device (displayed as major:minor)."
1982 #: ../cat/virt-ls.pod:251
1987 #: ../cat/virt-ls.pod:253
1988 msgid "The number of 512 byte blocks allocated to the file."
1992 #: ../cat/virt-ls.pod:257
1994 "With the I<--checksum> flag, the checksum of the file contents is shown "
1995 "(only for regular files). Computing file checksums can take a considerable "
2000 #: ../cat/virt-ls.pod:280
2001 msgid "B<--checksum>"
2005 #: ../cat/virt-ls.pod:282
2006 msgid "B<--checksum=crc|md5|sha1|sha224|sha256|sha384|sha512>"
2010 #: ../cat/virt-ls.pod:284
2012 "Display checksum over file contents for regular files. With no argument, "
2013 "this defaults to using I<md5>. Using an argument, you can select the "
2014 "checksum type to use."
2018 #: ../cat/virt-ls.pod:288 ../cat/virt-ls.pod:325 ../cat/virt-ls.pod:358
2019 #: ../cat/virt-ls.pod:391 ../cat/virt-ls.pod:401 ../cat/virt-ls.pod:408
2020 #: ../cat/virt-ls.pod:415 ../cat/virt-ls.pod:422
2022 "This option only has effect in I<-lR> output mode. See L</RECURSIVE LONG "
2027 #: ../cat/virt-ls.pod:316
2029 "When prompting for keys and passphrases, virt-ls normally turns echoing off "
2030 "so you cannot see what you are typing. If you are not worried about Tempest "
2031 "attacks and there is no one else in the room you can specify this flag to "
2032 "see what you are typing."
2036 #: ../cat/virt-ls.pod:321
2037 msgid "B<--extra-stats>"
2041 #: ../cat/virt-ls.pod:323
2042 msgid "Display extra stats."
2046 #: ../cat/virt-ls.pod:339
2049 " virt-ls --format=raw -a disk.img /dir\n"
2054 #: ../cat/virt-ls.pod:343
2057 " virt-ls --format=raw -a disk.img --format -a another.img /dir\n"
2062 #: ../cat/virt-ls.pod:356
2063 msgid "Display file sizes in human-readable format."
2067 #: ../cat/virt-ls.pod:370
2072 #: ../cat/virt-ls.pod:372
2073 msgid "B<--recursive>"
2077 #: ../cat/virt-ls.pod:374
2079 "Select the mode. With neither of these options, C<virt-ls> produces a "
2080 "simple, flat list of the files in the named directory. See L</SIMPLE "
2085 #: ../cat/virt-ls.pod:378
2087 "C<virt-ls -l> produces a \"long listing\", which shows more detail. See L</"
2092 #: ../cat/virt-ls.pod:381
2094 "C<virt-ls -R> produces a recursive list of files starting at the named "
2095 "directory. See L</RECURSIVE LISTING>."
2099 #: ../cat/virt-ls.pod:384
2101 "C<virt-ls -lR> produces a recursive long listing which can be more easily "
2102 "parsed. See L</RECURSIVE LONG LISTING>."
2106 #: ../cat/virt-ls.pod:387
2111 #: ../cat/virt-ls.pod:389
2112 msgid "Display time fields."
2116 #: ../cat/virt-ls.pod:394
2117 msgid "B<--time-days>"
2121 #: ../cat/virt-ls.pod:396
2122 msgid "Display time fields as days before now (negative if in the future)."
2126 #: ../cat/virt-ls.pod:398
2128 "Note that C<0> in output means \"up to 1 day before now\", or that the age "
2129 "of the file is between 0 and 86399 seconds."
2133 #: ../cat/virt-ls.pod:404
2134 msgid "B<--time-relative>"
2138 #: ../cat/virt-ls.pod:406
2139 msgid "Display time fields as seconds before now (negative if in the future)."
2143 #: ../cat/virt-ls.pod:411
2148 #: ../cat/virt-ls.pod:413
2149 msgid "Display time fields as seconds since the Unix epoch."
2153 #: ../cat/virt-ls.pod:418
2158 #: ../cat/virt-ls.pod:420
2159 msgid "Display UID and GID fields."
2163 #: ../cat/virt-ls.pod:445
2164 msgid "Previous versions of virt-ls allowed you to write either:"
2168 #: ../cat/virt-ls.pod:447
2171 " virt-ls disk.img [disk.img ...] /dir\n"
2176 #: ../cat/virt-ls.pod:451
2179 " virt-ls guestname /dir\n"
2184 #: ../cat/virt-ls.pod:492
2186 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-"
2187 "tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
2188 "L<http://libguestfs.org/>."
2192 #: ../cat/virt-ls.pod:508 ../df/virt-df.pod:230 ../edit/virt-edit.pod:369
2193 #: ../rescue/virt-rescue.pod:298
2194 msgid "Copyright (C) 2009-2011 Red Hat Inc."
2198 #: ../df/virt-df.pod:5
2199 msgid "virt-df - Display free space on virtual filesystems"
2203 #: ../df/virt-df.pod:9
2206 " virt-df [--options]\n"
2211 #: ../df/virt-df.pod:11
2214 " virt-df [--options] -d domname\n"
2219 #: ../df/virt-df.pod:13
2222 " virt-df [--options] -a disk.img [-a disk.img ...]\n"
2227 #: ../df/virt-df.pod:17
2230 " virt-df [--options] domname\n"
2235 #: ../df/virt-df.pod:19
2238 " virt-df [--options] disk.img [disk.img ...]\n"
2243 #: ../df/virt-df.pod:23
2245 "C<virt-df> is a command line tool to display free space on virtual machine "
2246 "filesystems. Unlike other tools, it doesn't just display the size of disk "
2247 "allocated to a virtual machine, but can look inside disk images to see how "
2248 "much space is really being used."
2252 #: ../df/virt-df.pod:28
2254 "If used without any I<-a> or I<-d> arguments, C<virt-df> checks with libvirt "
2255 "to get a list of all active and inactive guests, and performs a C<df>-type "
2256 "operation on each one in turn, printing out the results."
2260 #: ../df/virt-df.pod:32
2262 "If any I<-a> or I<-d> arguments are specified, C<virt-df> performs a C<df>-"
2263 "type operation on either the single named libvirt domain, or on the disk "
2264 "image(s) listed on the command line (which must all belong to a single VM). "
2265 "In this mode (with arguments), C<virt-df> will I<only work for a single "
2266 "guest>. If you want to run on multiple guests, then you have to invoke "
2267 "C<virt-df> multiple times."
2271 #: ../df/virt-df.pod:39
2273 "Use the I<--csv> option to get a format which can be easily parsed by other "
2274 "programs. Other options are similar to the standard L<df(1)> command."
2278 #: ../df/virt-df.pod:45
2280 "Show disk usage for a single libvirt guest called C<F14x64>. Make the "
2281 "output human-readable:"
2285 #: ../df/virt-df.pod:48
2288 " # virt-df -d F14x64 -h\n"
2289 " Filesystem Size Used Available Use%\n"
2290 " F14x64:/dev/sda1 484M 66M 393M 14%\n"
2291 " F14x64:/dev/vg_f13x64/lv_root 7.4G 3.4G 4.0G 46%\n"
2296 #: ../df/virt-df.pod:53
2297 msgid "Show disk usage for a disk image file called C<test.img>:"
2301 #: ../df/virt-df.pod:55
2304 " $ virt-df -a test1.img\n"
2305 " Filesystem 1K-blocks Used Available Use%\n"
2306 " test1.img:/dev/sda1 99099 1551 92432 2%\n"
2311 #: ../df/virt-df.pod:106
2314 " virt-df --format=raw -a disk.img\n"
2319 #: ../df/virt-df.pod:110
2322 " virt-df --format=raw -a disk.img --format -a another.img\n"
2327 #: ../df/virt-df.pod:123
2328 msgid "Print sizes in human-readable format."
2332 #: ../df/virt-df.pod:125
2333 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
2337 #: ../df/virt-df.pod:127 ../fish/guestfish.pod:258 ../fuse/guestmount.pod:155
2342 #: ../df/virt-df.pod:129
2347 #: ../df/virt-df.pod:131
2348 msgid "Print inodes instead of blocks."
2352 #: ../df/virt-df.pod:133
2353 msgid "B<--one-per-guest>"
2357 #: ../df/virt-df.pod:135
2359 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
2360 "disks from several guests to a single libguestfs appliance."
2364 #: ../df/virt-df.pod:138
2365 msgid "You might use this option in the following circumstances:"
2369 #: ../df/virt-df.pod:142 ../df/virt-df.pod:148 ../edit/virt-edit.pod:266
2370 #: ../edit/virt-edit.pod:271 ../edit/virt-edit.pod:276
2371 #: ../edit/virt-edit.pod:287 ../edit/virt-edit.pod:291
2372 #: ../examples/guestfs-recipes.pod:98 ../examples/guestfs-recipes.pod:102
2373 #: ../examples/guestfs-recipes.pod:106 ../examples/guestfs-recipes.pod:132
2374 #: ../examples/guestfs-recipes.pod:137 ../examples/guestfs-recipes.pod:227
2375 #: ../examples/guestfs-recipes.pod:231 ../examples/guestfs-recipes.pod:235
2376 #: ../examples/guestfs-recipes.pod:239 ../examples/guestfs-recipes.pod:243
2377 #: ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20
2378 #: ../fish/guestfish-actions.pod:385 ../fish/guestfish-actions.pod:393
2379 #: ../fish/guestfish-actions.pod:400 ../fish/guestfish-actions.pod:407
2380 #: ../fish/guestfish-actions.pod:1099 ../fish/guestfish-actions.pod:1103
2381 #: ../fish/guestfish-actions.pod:1107 ../fish/guestfish-actions.pod:1111
2382 #: ../fish/guestfish-actions.pod:1119 ../fish/guestfish-actions.pod:1123
2383 #: ../fish/guestfish-actions.pod:1127 ../fish/guestfish-actions.pod:1137
2384 #: ../fish/guestfish-actions.pod:1141 ../fish/guestfish-actions.pod:1145
2385 #: ../fish/guestfish-actions.pod:1235 ../fish/guestfish-actions.pod:1239
2386 #: ../fish/guestfish-actions.pod:1244 ../fish/guestfish-actions.pod:1249
2387 #: ../fish/guestfish-actions.pod:1291 ../fish/guestfish-actions.pod:1295
2388 #: ../fish/guestfish-actions.pod:1300 ../fish/guestfish-actions.pod:1933
2389 #: ../fish/guestfish-actions.pod:1939 ../fish/guestfish-actions.pod:1947
2390 #: ../fish/guestfish-actions.pod:1954 ../fish/guestfish-actions.pod:1961
2391 #: ../fish/guestfish.pod:445 ../fish/guestfish.pod:449
2392 #: ../fish/guestfish.pod:453 ../fish/guestfish.pod:457
2393 #: ../inspector/virt-inspector.pod:384 ../inspector/virt-inspector.pod:388
2394 #: ../resize/virt-resize.pod:282 ../resize/virt-resize.pod:286
2395 #: ../resize/virt-resize.pod:295 ../resize/virt-resize.pod:301
2396 #: ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22
2397 #: ../src/guestfs-actions.pod:583 ../src/guestfs-actions.pod:591
2398 #: ../src/guestfs-actions.pod:598 ../src/guestfs-actions.pod:605
2399 #: ../src/guestfs-actions.pod:1662 ../src/guestfs-actions.pod:1666
2400 #: ../src/guestfs-actions.pod:1670 ../src/guestfs-actions.pod:1674
2401 #: ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1686
2402 #: ../src/guestfs-actions.pod:1690 ../src/guestfs-actions.pod:1700
2403 #: ../src/guestfs-actions.pod:1704 ../src/guestfs-actions.pod:1708
2404 #: ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850
2405 #: ../src/guestfs-actions.pod:1855 ../src/guestfs-actions.pod:1860
2406 #: ../src/guestfs-actions.pod:1921 ../src/guestfs-actions.pod:1925
2407 #: ../src/guestfs-actions.pod:1930 ../src/guestfs-actions.pod:2859
2408 #: ../src/guestfs-actions.pod:2865 ../src/guestfs-actions.pod:2873
2409 #: ../src/guestfs-actions.pod:2880 ../src/guestfs-actions.pod:2887
2410 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398
2411 #: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411
2412 #: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1064
2413 #: ../src/guestfs.pod:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1077
2414 #: ../src/guestfs.pod:1085 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112
2415 #: ../src/guestfs.pod:1134 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142
2416 #: ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154
2417 #: ../src/guestfs.pod:1643 ../src/guestfs.pod:1648 ../src/guestfs.pod:1652
2418 #: ../src/guestfs.pod:1754 ../src/guestfs.pod:1759 ../src/guestfs.pod:1763
2419 #: ../src/guestfs.pod:1773 ../src/guestfs.pod:2047 ../src/guestfs.pod:2052
2420 #: ../src/guestfs.pod:2058 ../src/guestfs.pod:2066 ../src/guestfs.pod:2420
2421 #: ../src/guestfs.pod:2426 ../src/guestfs.pod:2431 ../src/guestfs.pod:2437
2422 #: ../src/guestfs.pod:2818 ../src/guestfs.pod:2823 ../src/guestfs.pod:2827
2423 #: ../src/guestfs.pod:2831 ../src/guestfs.pod:2835 ../src/guestfs.pod:2849
2424 #: ../src/guestfs.pod:2854 ../src/guestfs.pod:3068 ../src/guestfs.pod:3072
2425 #: ../src/guestfs.pod:3076 ../src/guestfs.pod:3080
2426 #: ../tools/virt-win-reg.pl:197 ../tools/virt-win-reg.pl:202
2427 #: ../tools/virt-win-reg.pl:208 ../tools/virt-win-reg.pl:710
2428 #: ../tools/virt-win-reg.pl:716 ../tools/virt-win-reg.pl:722
2433 #: ../df/virt-df.pod:144
2435 "If you think an untrusted guest might actively try to exploit the libguestfs "
2436 "appliance kernel, then this prevents one guest from interfering with the "
2437 "stats printed for another guest."
2441 #: ../df/virt-df.pod:150
2443 "If the kernel has a bug which stops it from accessing a filesystem in one "
2444 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
2445 "and report stats for further guests."
2449 #: ../df/virt-df.pod:159
2451 "Print UUIDs instead of names. This is useful for following a guest even "
2452 "when the guest is migrated or renamed, or when two guests happen to have the "
2457 #: ../df/virt-df.pod:163
2459 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
2460 "images, we still print the disk image name even when this option is "
2465 #: ../df/virt-df.pod:218
2467 "L<df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<http://"
2472 #: ../edit/virt-edit.pod:5
2473 msgid "virt-edit - Edit a file in a virtual machine"
2477 #: ../edit/virt-edit.pod:9
2480 " virt-edit [--options] -d domname file [file ...]\n"
2485 #: ../edit/virt-edit.pod:11
2488 " virt-edit [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
2493 #: ../edit/virt-edit.pod:13
2496 " virt-edit [-d domname|-a disk.img] file -e 'expr'\n"
2501 #: ../edit/virt-edit.pod:17
2504 " virt-edit domname file\n"
2509 #: ../edit/virt-edit.pod:19 ../edit/virt-edit.pod:183
2512 " virt-edit disk.img [disk.img ...] file\n"
2517 #: ../edit/virt-edit.pod:21 ../fish/guestfish.pod:23
2518 #: ../fish/virt-copy-in.pod:13 ../fish/virt-tar-in.pod:15
2519 #: ../fuse/guestmount.pod:15 ../rescue/virt-rescue.pod:19
2520 #: ../tools/virt-tar.pl:64 ../tools/virt-win-reg.pl:51
2525 #: ../edit/virt-edit.pod:23
2527 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
2528 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
2529 "doing this, but doesn't catch all cases."
2533 #: ../edit/virt-edit.pod:29
2535 "C<virt-edit> is a command line tool to edit C<file> where each C<file> "
2536 "exists in the named virtual machine (or disk image)."
2540 #: ../edit/virt-edit.pod:32
2542 "Multiple filenames can be given, in which case they are each edited in "
2543 "turn. Each filename must be a full path, starting at the root directory "
2544 "(starting with '/')."
2548 #: ../edit/virt-edit.pod:36
2549 msgid "If you want to just view a file, use L<virt-cat(1)>."
2553 #: ../edit/virt-edit.pod:38
2555 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
2556 "USING GUESTFISH> below)."
2560 #: ../edit/virt-edit.pod:41
2562 "C<virt-edit> cannot be used to create a new file. L<guestfish(1)> can do "
2563 "that and much more."
2567 #: ../edit/virt-edit.pod:46
2568 msgid "Edit the named files interactively:"
2572 #: ../edit/virt-edit.pod:48
2575 " virt-edit -d mydomain /boot/grub/grub.conf\n"
2580 #: ../edit/virt-edit.pod:50
2583 " virt-edit -d mydomain /etc/passwd\n"
2588 #: ../edit/virt-edit.pod:52
2589 msgid "For Windows guests, some Windows paths are understood:"
2593 #: ../edit/virt-edit.pod:54
2596 " virt-edit -d mywindomain 'c:\\autoexec.bat'\n"
2601 #: ../edit/virt-edit.pod:56
2603 "If Perl is installed, you can also edit files non-interactively (see L</NON-"
2604 "INTERACTIVE EDITING> below). To change the init default level to 5:"
2608 #: ../edit/virt-edit.pod:60
2611 " virt-edit -d mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
2616 #: ../edit/virt-edit.pod:81
2617 msgid "B<-b> extension"
2621 #: ../edit/virt-edit.pod:83
2622 msgid "B<--backup> extension"
2626 #: ../edit/virt-edit.pod:85
2628 "Create a backup of the original file I<in the guest disk image>. The backup "
2629 "has the original filename with C<extension> added."
2633 #: ../edit/virt-edit.pod:88
2635 "Usually the first character of C<extension> would be a dot C<.> so you would "
2640 #: ../edit/virt-edit.pod:91
2643 " virt-edit -b .orig [etc]\n"
2648 #: ../edit/virt-edit.pod:93
2649 msgid "By default, no backup file is made."
2653 #: ../edit/virt-edit.pod:95 ../fish/guestfish.pod:181
2654 #: ../fuse/guestmount.pod:96 ../inspector/virt-inspector.pod:74
2655 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-list-partitions.pl:78
2656 #: ../tools/virt-tar.pl:127 ../tools/virt-win-reg.pl:128
2661 #: ../edit/virt-edit.pod:97 ../fish/guestfish.pod:183
2662 #: ../fuse/guestmount.pod:98 ../inspector/virt-inspector.pod:76
2663 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-list-partitions.pl:80
2664 #: ../tools/virt-tar.pl:129 ../tools/virt-win-reg.pl:130
2665 msgid "B<--connect URI>"
2669 #: ../edit/virt-edit.pod:102 ../tools/virt-list-filesystems.pl:84
2670 #: ../tools/virt-list-partitions.pl:85 ../tools/virt-tar.pl:134
2671 #: ../tools/virt-win-reg.pl:135
2673 "If you specify guest block devices directly, then libvirt is not used at all."
2677 #: ../edit/virt-edit.pod:114
2679 "When prompting for keys and passphrases, virt-edit normally turns echoing "
2680 "off so you cannot see what you are typing. If you are not worried about "
2681 "Tempest attacks and there is no one else in the room you can specify this "
2682 "flag to see what you are typing."
2686 #: ../edit/virt-edit.pod:119
2691 #: ../edit/virt-edit.pod:121
2692 msgid "B<--expr> EXPR"
2696 #: ../edit/virt-edit.pod:123
2698 "Instead of launching the external editor, non-interactively apply the Perl "
2699 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
2704 #: ../edit/virt-edit.pod:127
2706 "Be careful to properly quote the expression to prevent it from being altered "
2711 #: ../edit/virt-edit.pod:130
2712 msgid "Note that this option is only available when Perl 5 is installed."
2716 #: ../edit/virt-edit.pod:132
2717 msgid "B<--format> raw|qcow2|..."
2721 #: ../edit/virt-edit.pod:143
2724 " virt-edit --format=raw -a disk.img file\n"
2729 #: ../edit/virt-edit.pod:147
2732 " virt-edit --format=raw -a disk.img --format -a another.img file\n"
2737 #: ../edit/virt-edit.pod:181
2738 msgid "Previous versions of virt-edit allowed you to write either:"
2742 #: ../edit/virt-edit.pod:187
2745 " virt-edit guestname file\n"
2750 #: ../edit/virt-edit.pod:195
2751 msgid "NON-INTERACTIVE EDITING"
2755 #: ../edit/virt-edit.pod:197
2757 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
2758 "administrator can interactively edit the file."
2762 #: ../edit/virt-edit.pod:200
2764 "There are two ways also to use C<virt-edit> from scripts in order to make "
2765 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
2766 "like this, it's less error-prone to write scripts directly using the "
2767 "libguestfs API and Augeas for configuration file editing.)"
2771 #: ../edit/virt-edit.pod:206
2773 "The first method is to temporarily set C<$EDITOR> to any script or program "
2774 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
2775 "update C<tmpfile> in place however it likes."
2779 #: ../edit/virt-edit.pod:210
2781 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
2782 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
2783 "instances of C<foo> with C<bar> in a file:"
2787 #: ../edit/virt-edit.pod:214
2790 " virt-edit -d domname filename -e 's/foo/bar/'\n"
2795 #: ../edit/virt-edit.pod:216
2797 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
2798 "For example to delete root's password you could do:"
2802 #: ../edit/virt-edit.pod:219
2805 " virt-edit -d domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
2810 #: ../edit/virt-edit.pod:221
2812 "What really happens is that the snippet is evaluated as a Perl expression "
2813 "for each line of the file. The line, including the final C<\\n>, is passed "
2814 "in C<$_> and the expression should update C<$_> or leave it unchanged."
2818 #: ../edit/virt-edit.pod:226
2820 "To delete a line, set C<$_> to the empty string. For example, to delete the "
2821 "C<apache> user account from the password file you can do:"
2825 #: ../edit/virt-edit.pod:229
2828 " virt-edit -d mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
2833 #: ../edit/virt-edit.pod:231
2835 "To insert a line, prepend or append it to C<$_>. However appending lines to "
2836 "the end of the file is rather difficult this way since there is no concept "
2837 "of \"last line of the file\" - your expression just doesn't get called "
2838 "again. You might want to use the first method (setting C<$EDITOR>) if you "
2843 #: ../edit/virt-edit.pod:237
2845 "The variable C<$lineno> contains the current line number. As is "
2846 "traditional, the first line in the file is number C<1>."
2850 #: ../edit/virt-edit.pod:240
2852 "The return value from the expression is ignored, but the expression may call "
2853 "C<die> in order to abort the whole program, leaving the original file "
2858 #: ../edit/virt-edit.pod:244
2860 "Remember when matching the end of a line that C<$_> may contain the final C<"
2861 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
2862 "newline then neither of these. Thus to match or substitute some text at the "
2863 "end of a line, use this regular expression:"
2867 #: ../edit/virt-edit.pod:249
2870 " /some text(\\r?\\n)?$/\n"
2875 #: ../edit/virt-edit.pod:251
2877 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
2878 "$_> itself (since that would remove all newlines from the file):"
2882 #: ../edit/virt-edit.pod:255
2885 " my $m = $_; chomp $m; $m =~ /some text$/\n"
2890 #: ../edit/virt-edit.pod:257 ../fish/guestfish.pod:858
2891 msgid "WINDOWS PATHS"
2895 #: ../edit/virt-edit.pod:259
2897 "C<virt-edit> has a limited ability to understand Windows drive letters and "
2898 "paths (eg. C<E:\\foo\\bar.txt>)."
2902 #: ../edit/virt-edit.pod:262
2903 msgid "If and only if the guest is running Windows then:"
2907 #: ../edit/virt-edit.pod:268
2909 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
2910 "to the correct filesystem."
2914 #: ../edit/virt-edit.pod:273
2916 "Any backslash (C<\\>) characters in the path are replaced with forward "
2917 "slashes so that libguestfs can process it."
2921 #: ../edit/virt-edit.pod:278
2923 "The path is resolved case insensitively to locate the file that should be "
2928 #: ../edit/virt-edit.pod:283
2929 msgid "There are some known shortcomings:"
2933 #: ../edit/virt-edit.pod:289
2934 msgid "Some NTFS symbolic links may not be followed correctly."
2938 #: ../edit/virt-edit.pod:293
2939 msgid "NTFS junction points that cross filesystems are not followed."
2943 #: ../edit/virt-edit.pod:299
2945 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
2946 "C<virt-edit> doesn't work."
2950 #: ../edit/virt-edit.pod:302
2951 msgid "Using C<virt-edit> is approximately equivalent to doing:"
2955 #: ../edit/virt-edit.pod:304
2958 " guestfish --rw -i -d domname edit /file\n"
2963 #: ../edit/virt-edit.pod:306
2965 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
2970 #: ../edit/virt-edit.pod:309
2972 "The command above uses libguestfs's guest inspection feature and so does not "
2973 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
2974 "disk images that don't contain guests. To edit a file on a disk image "
2979 #: ../edit/virt-edit.pod:314
2982 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
2987 #: ../edit/virt-edit.pod:316
2989 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
2990 "the disk image to edit, and C</file> is the full path to the file."
2994 #: ../edit/virt-edit.pod:320
2996 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
2997 "C<write> or C<upload> instead:"
3001 #: ../edit/virt-edit.pod:323
3004 " guestfish --rw -i -d domname touch /newfile\n"
3009 #: ../edit/virt-edit.pod:325
3012 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
3017 #: ../edit/virt-edit.pod:327
3020 " guestfish --rw -i -d domname upload localfile /newfile\n"
3025 #: ../edit/virt-edit.pod:329 ../fish/guestfish.pod:1075
3026 #: ../rescue/virt-rescue.pod:257 ../src/guestfs.pod:2965
3027 #: ../test-tool/libguestfs-test-tool.pod:82
3028 msgid "ENVIRONMENT VARIABLES"
3032 #: ../edit/virt-edit.pod:333
3037 #: ../edit/virt-edit.pod:335
3039 "If set, this string is used as the editor. It may contain arguments, eg. C<"
3044 #: ../edit/virt-edit.pod:338
3045 msgid "If not set, C<vi> is used."
3049 #: ../edit/virt-edit.pod:351
3051 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
3052 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
3053 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
3057 #: ../examples/guestfs-examples.pod:5
3058 msgid "guestfs-examples - Examples of using libguestfs from C"
3062 #: ../examples/guestfs-examples.pod:9 ../src/guestfs.pod:9
3065 " #include <guestfs.h>\n"
3070 #: ../examples/guestfs-examples.pod:11
3073 " guestfs_h *g = guestfs_create ();\n"
3074 " guestfs_add_drive_ro (g, \"disk.img\");\n"
3075 " guestfs_launch (g);\n"
3080 #: ../examples/guestfs-examples.pod:15 ../src/guestfs.pod:19
3083 " cc prog.c -o prog -lguestfs\n"
3085 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
3090 #: ../examples/guestfs-examples.pod:21
3092 "This manual page contains examples of calling libguestfs from the C "
3093 "programming language. If you are not familiar with using libguestfs, you "
3094 "also need to read L<guestfs(3)>."
3098 #: ../examples/guestfs-examples.pod:25 ../java/examples/guestfs-java.pod:37
3099 #: ../ocaml/examples/guestfs-ocaml.pod:70 ../perl/examples/guestfs-perl.pod:31
3100 #: ../python/examples/guestfs-python.pod:34
3101 #: ../ruby/examples/guestfs-ruby.pod:28
3102 msgid "EXAMPLE 1: CREATE A DISK IMAGE"
3106 #: ../examples/guestfs-examples.pod:27 ../java/examples/guestfs-java.pod:39
3107 #: ../ocaml/examples/guestfs-ocaml.pod:72 ../perl/examples/guestfs-perl.pod:33
3108 #: ../python/examples/guestfs-python.pod:36
3109 #: ../ruby/examples/guestfs-ruby.pod:30
3114 #: ../examples/guestfs-examples.pod:29 ../java/examples/guestfs-java.pod:41
3115 #: ../ocaml/examples/guestfs-ocaml.pod:74 ../perl/examples/guestfs-perl.pod:35
3116 #: ../python/examples/guestfs-python.pod:38
3117 #: ../ruby/examples/guestfs-ruby.pod:32
3118 msgid "EXAMPLE 2: INSPECT A VIRTUAL MACHINE DISK IMAGE"
3122 #: ../examples/guestfs-examples.pod:31 ../java/examples/guestfs-java.pod:43
3123 #: ../ocaml/examples/guestfs-ocaml.pod:76 ../perl/examples/guestfs-perl.pod:37
3124 #: ../python/examples/guestfs-python.pod:40
3125 #: ../ruby/examples/guestfs-ruby.pod:34
3130 #: ../examples/guestfs-examples.pod:35
3132 "L<guestfs(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, "
3133 "L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://"
3138 #: ../examples/guestfs-examples.pod:44 ../examples/guestfs-recipes.pod:396
3139 #: ../fish/guestfish.pod:1238 ../fish/virt-copy-in.pod:60
3140 #: ../fish/virt-copy-out.pod:49 ../fish/virt-tar-in.pod:58
3141 #: ../fish/virt-tar-out.pod:51 ../fuse/guestmount.pod:314
3142 #: ../inspector/virt-inspector.pod:380 ../java/examples/guestfs-java.pod:57
3143 #: ../ocaml/examples/guestfs-ocaml.pod:90 ../perl/examples/guestfs-perl.pod:51
3144 #: ../python/examples/guestfs-python.pod:53
3145 #: ../ruby/examples/guestfs-ruby.pod:47 ../src/guestfs.pod:3087
3146 #: ../test-tool/libguestfs-test-tool.pod:93
3151 #: ../examples/guestfs-examples.pod:46 ../examples/guestfs-recipes.pod:398
3152 #: ../fish/guestfish.pod:1240 ../fish/virt-copy-in.pod:62
3153 #: ../fish/virt-copy-out.pod:51 ../fish/virt-tar-in.pod:60
3154 #: ../fish/virt-tar-out.pod:53 ../fuse/guestmount.pod:316
3155 #: ../java/examples/guestfs-java.pod:59 ../ocaml/examples/guestfs-ocaml.pod:92
3156 #: ../perl/examples/guestfs-perl.pod:53
3157 #: ../python/examples/guestfs-python.pod:55
3158 #: ../ruby/examples/guestfs-ruby.pod:49 ../src/guestfs.pod:3089
3159 #: ../test-tool/libguestfs-test-tool.pod:95
3160 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
3164 #: ../examples/guestfs-examples.pod:50 ../ocaml/examples/guestfs-ocaml.pod:96
3165 #: ../python/examples/guestfs-python.pod:59
3166 #: ../ruby/examples/guestfs-ruby.pod:53
3167 msgid "Copyright (C) 2010 Red Hat Inc. L<http://libguestfs.org/>"
3171 #: ../examples/guestfs-examples.pod:52 ../examples/guestfs-recipes.pod:404
3172 #: ../java/examples/guestfs-java.pod:65 ../ocaml/examples/guestfs-ocaml.pod:98
3173 #: ../perl/examples/guestfs-perl.pod:59
3174 #: ../python/examples/guestfs-python.pod:61
3175 #: ../ruby/examples/guestfs-ruby.pod:55
3177 "The examples in this manual page may be freely copied, modified and "
3178 "distributed without any restrictions."
3182 #: ../examples/guestfs-examples.pod:55 ../examples/guestfs-recipes.pod:407
3183 #: ../java/examples/guestfs-java.pod:68
3184 #: ../ocaml/examples/guestfs-ocaml.pod:101
3185 #: ../perl/examples/guestfs-perl.pod:62
3186 #: ../python/examples/guestfs-python.pod:64
3187 #: ../ruby/examples/guestfs-ruby.pod:58 ../src/guestfs.pod:3096
3189 "This library is free software; you can redistribute it and/or modify it "
3190 "under the terms of the GNU Lesser General Public License as published by the "
3191 "Free Software Foundation; either version 2 of the License, or (at your "
3192 "option) any later version."
3196 #: ../examples/guestfs-examples.pod:60 ../examples/guestfs-recipes.pod:412
3197 #: ../java/examples/guestfs-java.pod:73
3198 #: ../ocaml/examples/guestfs-ocaml.pod:106
3199 #: ../perl/examples/guestfs-perl.pod:67
3200 #: ../python/examples/guestfs-python.pod:69
3201 #: ../ruby/examples/guestfs-ruby.pod:63 ../src/guestfs.pod:3101
3203 "This library is distributed in the hope that it will be useful, but WITHOUT "
3204 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
3205 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
3210 #: ../examples/guestfs-examples.pod:65 ../examples/guestfs-recipes.pod:417
3211 #: ../java/examples/guestfs-java.pod:78
3212 #: ../ocaml/examples/guestfs-ocaml.pod:111
3213 #: ../perl/examples/guestfs-perl.pod:72
3214 #: ../python/examples/guestfs-python.pod:74
3215 #: ../ruby/examples/guestfs-ruby.pod:68 ../src/guestfs.pod:3106
3217 "You should have received a copy of the GNU Lesser General Public License "
3218 "along with this library; if not, write to the Free Software Foundation, "
3219 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
3223 #: ../examples/guestfs-recipes.pod:3 ../examples/guestfs-recipes.pod:12
3228 #: ../examples/guestfs-recipes.pod:5
3230 "pod2man and pod2html have differing bugs which makes it hard to write URLs "
3231 "here. The only way which works for both sorts of output is to just write "
3232 "the URL directly. Do NOT use L<...> for URLs."
3236 #: ../examples/guestfs-recipes.pod:9
3238 "We break with tradition here and don't use ALL CAPS for the section "
3239 "headings, as this makes them much easier to read."
3243 #: ../examples/guestfs-recipes.pod:16
3244 msgid "guestfs-recipes - libguestfs, guestfish and virt tools recipes"
3248 #: ../examples/guestfs-recipes.pod:20
3250 "This page contains recipes for and links to things you can do using "
3251 "libguestfs, L<guestfish(1)> and the virt tools."
3255 #: ../examples/guestfs-recipes.pod:23
3256 msgid "Audit a virtual machine for setuid files"
3260 #: ../examples/guestfs-recipes.pod:25
3262 "The link below contains a small program which can be used to audit a Linux "
3263 "virtual machine to see what setuid and setgid files it contains."
3267 #: ../examples/guestfs-recipes.pod:28
3269 "https://rwmj.wordpress.com/2010/12/15/tip-audit-virtual-machine-for-setuid-"
3274 #: ../examples/guestfs-recipes.pod:30
3275 msgid "Change the background image in a Windows XP VM"
3279 #: ../examples/guestfs-recipes.pod:32
3281 "The links below explain how to use L<guestfish(1)> to change the background "
3282 "image for a user of a Windows XP VM. Unfortunately the technique appears to "
3283 "be substantially different for each version of Windows."
3287 #: ../examples/guestfs-recipes.pod:37
3289 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002655.html https://"
3290 "lists.fedoraproject.org/pipermail/virt/2011-May/002658.html"
3294 #: ../examples/guestfs-recipes.pod:40
3295 msgid "Cloning a virtual machine (Linux)"
3299 #: ../examples/guestfs-recipes.pod:42
3301 "The guestfish technique described in the link below works well for most "
3302 "Linux VMs. Depending on the Linux distro you may need to change the paths "
3307 #: ../examples/guestfs-recipes.pod:46
3309 "https://rwmj.wordpress.com/2010/09/24/tip-my-procedure-for-cloning-a-fedora-"
3314 #: ../examples/guestfs-recipes.pod:48
3316 "Avoid L<virt-clone(1)>. Currently what to do about virt-clone is under "
3321 #: ../examples/guestfs-recipes.pod:51
3322 msgid "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
3326 #: ../examples/guestfs-recipes.pod:53
3327 msgid "Cloning a virtual machine (Windows)"
3331 #: ../examples/guestfs-recipes.pod:55
3333 "It is possible to do a \"sysprep\" using libguestfs alone, although not "
3334 "straightforward. Currently there is code in the Aeolus Oz project which "
3335 "does this (using libguestfs). As part of our review of the virt-clone tool, "
3336 "we may add sysprepping ability."
3340 #: ../examples/guestfs-recipes.pod:60
3342 "https://github.com/clalancette/oz https://www.redhat.com/archives/virt-tools-"
3343 "list/2011-May/msg00019.html"
3347 #: ../examples/guestfs-recipes.pod:63
3348 msgid "Convert a CD-ROM / DVD / ISO to a tarball"
3352 #: ../examples/guestfs-recipes.pod:65
3353 msgid "This converts input C<cd.iso> to output C<cd.tar.gz>:"
3357 #: ../examples/guestfs-recipes.pod:67
3360 " guestfish --ro -a cd.iso -m /dev/sda tgz-out / cd.tar.gz\n"
3365 #: ../examples/guestfs-recipes.pod:69
3366 msgid "To export just a subdirectory, eg. C</files>, do:"
3370 #: ../examples/guestfs-recipes.pod:71
3373 " guestfish --ro -a cd.iso -m /dev/sda tgz-out /files cd.tar.gz\n"
3378 #: ../examples/guestfs-recipes.pod:73
3379 msgid "Create empty disk images"
3383 #: ../examples/guestfs-recipes.pod:75
3385 "You can use the L<guestfish(1)> I<-N> option to create empty disk images. "
3386 "The useful guide below explains the options available."
3390 #: ../examples/guestfs-recipes.pod:78
3392 "https://rwmj.wordpress.com/2010/09/08/new-guestfish-n-options-in-1-5-9/"
3397 #: ../examples/guestfs-recipes.pod:80
3398 msgid "Dump raw filesystem content from inside a disk image or VM"
3402 #: ../examples/guestfs-recipes.pod:82
3404 "You can use the L<guestfish(1)> C<download> command to extract the raw "
3405 "filesystem content from any filesystem in a disk image or a VM (even one "
3406 "which is encrypted or buried inside an LV):"
3410 #: ../examples/guestfs-recipes.pod:86
3413 " guestfish --ro -a disk.img run : download /dev/sda1 sda1.img\n"
3418 #: ../examples/guestfs-recipes.pod:88
3421 " guestfish --ro -d Guest run : download /dev/vg_guest/lv_root lv.img\n"
3426 #: ../examples/guestfs-recipes.pod:90
3427 msgid "To list the filesystems in a disk image, use L<virt-filesystems(1)>."
3431 #: ../examples/guestfs-recipes.pod:92
3432 msgid "Edit grub configuration in a VM"
3436 #: ../examples/guestfs-recipes.pod:94
3437 msgid "You can use this to:"
3441 #: ../examples/guestfs-recipes.pod:100
3442 msgid "Fix a virtual machine that does not boot."
3446 #: ../examples/guestfs-recipes.pod:104
3447 msgid "Change which kernel is used to boot the VM."
3451 #: ../examples/guestfs-recipes.pod:108
3452 msgid "Change kernel command line options."
3456 #: ../examples/guestfs-recipes.pod:112
3457 msgid "Use L<virt-edit(1)> to edit the grub configuration:"
3461 #: ../examples/guestfs-recipes.pod:114
3464 " virt-edit -d BrokenGuest /boot/grub/grub.conf\n"
3469 #: ../examples/guestfs-recipes.pod:116
3471 "or for general tinkering inside an unbootable VM use L<virt-rescue(1)> like "
3476 #: ../examples/guestfs-recipes.pod:119
3479 " virt-rescue -d BrokenGuest\n"
3484 #: ../examples/guestfs-recipes.pod:121
3485 msgid "Export any directory from a VM"
3489 #: ../examples/guestfs-recipes.pod:123
3491 "To export C</home> from a VM into a local directory use L<virt-copy-out(1)>:"
3495 #: ../examples/guestfs-recipes.pod:126
3498 " virt-copy-out -d Guest /home .\n"
3503 #: ../examples/guestfs-recipes.pod:128 ../fish/guestfish-actions.pod:9
3504 #: ../fish/guestfish-actions.pod:1287 ../fish/guestfish-actions.pod:1929
3505 #: ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1917
3506 #: ../src/guestfs-actions.pod:2855 ../src/guestfs.pod:1639
3507 #: ../tools/virt-win-reg.pl:706
3512 #: ../examples/guestfs-recipes.pod:134
3514 "The final dot of the command is not a printing error. It means we want to "
3515 "copy out to the current directory."
3519 #: ../examples/guestfs-recipes.pod:139
3520 msgid "This creates a directory called C<home> under the current directory."
3524 #: ../examples/guestfs-recipes.pod:143
3526 "If the guest is a Windows guest then you can use drive letters and "
3527 "backslashes, but you must prefix the path with C<win:> and quote it to "
3528 "protect it from the shell, like this:"
3532 #: ../examples/guestfs-recipes.pod:147
3535 " virt-copy-out -d WinGuest 'win:c:\\windows\\system32\\config' .\n"
3540 #: ../examples/guestfs-recipes.pod:149
3541 msgid "To get the output as a compressed tarball, do:"
3545 #: ../examples/guestfs-recipes.pod:151
3548 " virt-tar-out -d Guest /home - | gzip --best > home.tar.gz\n"
3553 #: ../examples/guestfs-recipes.pod:153
3555 "Although it sounds tempting, this is usually not a reliable way to get a "
3556 "backup from a running guest. See the entry in the FAQ: http://libguestfs."
3557 "org/FAQ.html#backup"
3561 #: ../examples/guestfs-recipes.pod:157
3562 msgid "Find out which user is using the most space"
3566 #: ../examples/guestfs-recipes.pod:159
3568 "This simple script examines a Linux guest to find out which user is using "
3569 "the most space in their home directory:"
3573 #: ../examples/guestfs-recipes.pod:162
3581 #: ../examples/guestfs-recipes.pod:164
3589 #: ../examples/guestfs-recipes.pod:166
3598 #: ../examples/guestfs-recipes.pod:169
3601 " eval $(guestfish --ro -d \"$vm\" -i --listen)\n"
3606 #: ../examples/guestfs-recipes.pod:171
3609 " for d in $(guestfish --remote ls \"$dir\"); do\n"
3610 " echo -n \"$dir/$d\"\n"
3612 " guestfish --remote du \"$dir/$d\";\n"
3613 " done | sort -nr -k 2\n"
3618 #: ../examples/guestfs-recipes.pod:177 ../fish/guestfish.pod:941
3621 " guestfish --remote exit\n"
3626 #: ../examples/guestfs-recipes.pod:179
3627 msgid "Get DHCP address from a VM"
3631 #: ../examples/guestfs-recipes.pod:181
3633 "The link below explains the many different possible techniques for getting "
3634 "the last assigned DHCP address of a virtual machine."
3638 #: ../examples/guestfs-recipes.pod:184
3640 "https://rwmj.wordpress.com/2011/03/31/tip-code-for-getting-dhcp-address-from-"
3641 "a-virtual-machine-disk-image/#content"
3645 #: ../examples/guestfs-recipes.pod:186
3647 "In the libguestfs source examples directory you will find the latest version "
3648 "of the C<virt-dhcp-address.c> program."
3652 #: ../examples/guestfs-recipes.pod:189
3653 msgid "Get the operating system product name string"
3657 #: ../examples/guestfs-recipes.pod:191
3658 msgid "Save the following script into a file called C<product-name.sh>:"
3662 #: ../examples/guestfs-recipes.pod:193
3667 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
3668 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
3669 " guestfish --remote inspect-get-product-name \"$root\"\n"
3670 " guestfish --remote exit\n"
3675 #: ../examples/guestfs-recipes.pod:200
3676 msgid "Make the script executable and run it on a named guest:"
3680 #: ../examples/guestfs-recipes.pod:202
3683 " # product-name.sh RHEL60x64\n"
3684 " Red Hat Enterprise Linux Server release 6.0 (Santiago)\n"
3689 #: ../examples/guestfs-recipes.pod:205
3691 "You can also use an XPath query on the L<virt-inspector(1)> XML using the "
3692 "C<xpath> command line tool or from your favourite programming language:"
3696 #: ../examples/guestfs-recipes.pod:209
3699 " # virt-inspector RHEL60x64 > xml\n"
3700 " # xpath '//product_name' < xml\n"
3703 " <product_name>Red Hat Enterprise Linux Server release 6.0 (Santiago)</product_name>\n"
3708 #: ../examples/guestfs-recipes.pod:215
3709 msgid "Get the default boot kernel for a Linux VM"
3713 #: ../examples/guestfs-recipes.pod:217
3715 "The link below contains a program to print the default boot kernel for a "
3720 #: ../examples/guestfs-recipes.pod:220
3722 "https://rwmj.wordpress.com/2010/10/30/tip-use-augeas-to-get-the-default-boot-"
3723 "kernel-for-a-vm/#content"
3727 #: ../examples/guestfs-recipes.pod:222
3729 "It uses Augeas, and the technique is generally applicable for many different "
3734 #: ../examples/guestfs-recipes.pod:229
3735 msgid "listing the user accounts in the guest"
3739 #: ../examples/guestfs-recipes.pod:233
3740 msgid "what repositories is it configured to use"
3744 #: ../examples/guestfs-recipes.pod:237
3745 msgid "what NTP servers does it connect to"
3749 #: ../examples/guestfs-recipes.pod:241
3750 msgid "what were the boot messages last time it booted"
3754 #: ../examples/guestfs-recipes.pod:245
3755 msgid "listing who was logged in recently"
3759 #: ../examples/guestfs-recipes.pod:249
3760 msgid "http://augeas.net/"
3764 #: ../examples/guestfs-recipes.pod:251
3765 msgid "Install RPMs in a guest"
3769 #: ../examples/guestfs-recipes.pod:253
3771 "The link below contains a method to install RPMs in a guest. In fact the "
3772 "RPMs are just uploaded to the guest along with a \"firstboot\" script that "
3773 "installs them next time the guest is booted. You could use this technique "
3774 "to install vital security updates in an offline guest."
3778 #: ../examples/guestfs-recipes.pod:259
3780 "https://rwmj.wordpress.com/2010/12/01/tip-install-rpms-in-a-guest/#content"
3784 #: ../examples/guestfs-recipes.pod:261
3785 msgid "List applications installed in a VM"
3789 #: ../examples/guestfs-recipes.pod:263
3790 msgid "Save the following to a file C<list-apps.sh>:"
3794 #: ../examples/guestfs-recipes.pod:265
3799 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
3800 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
3801 " guestfish --remote inspect-list-applications \"$root\"\n"
3802 " guestfish --remote exit\n"
3807 #: ../examples/guestfs-recipes.pod:272
3809 "Make the file executable and then you can run it on any named virtual "
3814 #: ../examples/guestfs-recipes.pod:275
3817 " # list-apps.sh WinGuest\n"
3819 " app_name: Mozilla Firefox (3.6.12)\n"
3820 " app_display_name: Mozilla Firefox (3.6.12)\n"
3822 " app_version: 3.6.12 (en-GB)\n"
3824 " app_install_path: C:\\Program Files\\Mozilla Firefox\n"
3825 " app_trans_path:\n"
3826 " app_publisher: Mozilla\n"
3827 " app_url: http://www.mozilla.com/en-GB/\n"
3828 " app_source_package:\n"
3830 " app_description: Mozilla Firefox\n"
3833 " app_name: VLC media player\n"
3834 " app_display_name: VLC media player 1.1.5\n"
3836 " app_version: 1.1.5\n"
3838 " app_install_path: C:\\Program Files\\VideoLAN\\VLC\n"
3839 " app_trans_path:\n"
3840 " app_publisher: VideoLAN\n"
3841 " app_url: http://www.videolan.org/\n"
3842 " app_source_package:\n"
3844 " app_description:\n"
3850 #: ../examples/guestfs-recipes.pod:305
3852 "If you want to run the script on disk images (instead of libvirt virtual "
3853 "machines), change C<-d \"$1\"> to C<-a \"$1\">. See also L<virt-inspector(1)"
3858 #: ../examples/guestfs-recipes.pod:309
3859 msgid "List files and directories in a VM"
3863 #: ../examples/guestfs-recipes.pod:311
3864 msgid "This involves using the L<guestfish(1)> C<find0> command like this:"
3868 #: ../examples/guestfs-recipes.pod:313
3871 " guestfish --ro -d Guest -i find0 / - | tr '\\0' '\\n' | sort\n"
3876 #: ../examples/guestfs-recipes.pod:315
3877 msgid "List services in a Windows VM"
3881 #: ../examples/guestfs-recipes.pod:317
3883 "The link below contains a script that can be used to list out the services "
3884 "from a Windows VM, and whether those services run at boot time or are loaded "
3889 #: ../examples/guestfs-recipes.pod:321
3891 "https://rwmj.wordpress.com/2010/12/10/tip-list-services-in-a-windows-guest/"
3896 #: ../examples/guestfs-recipes.pod:323
3897 msgid "Make a disk image sparse"
3901 #: ../examples/guestfs-recipes.pod:325
3903 "The link below contains some guides for making a disk image sparse (or "
3904 "reintroducing sparseness)."
3908 #: ../examples/guestfs-recipes.pod:328
3910 "https://rwmj.wordpress.com/2010/10/19/tip-making-a-disk-image-sparse/#content"
3914 #: ../examples/guestfs-recipes.pod:330
3915 msgid "Monitor disk usage over time"
3919 #: ../examples/guestfs-recipes.pod:332
3921 "You can use L<virt-df(1)> to monitor disk usage of your guests over time. "
3922 "The link below contains a guide."
3926 #: ../examples/guestfs-recipes.pod:335
3927 msgid "http://virt-tools.org/learning/advanced-virt-df/"
3931 #: ../examples/guestfs-recipes.pod:337
3932 msgid "Reading the Windows Event Log from Windows Vista (or later)"
3936 #: ../examples/guestfs-recipes.pod:339
3938 "L<guestfish(1)> plus the tools described in the link below can be used to "
3939 "read out the Windows Event Log from any virtual machine running Windows "
3940 "Vista or a later version."
3944 #: ../examples/guestfs-recipes.pod:343
3946 "https://rwmj.wordpress.com/2011/04/17/decoding-the-windows-event-log-using-"
3947 "guestfish/#content"
3951 #: ../examples/guestfs-recipes.pod:345
3952 msgid "Remove root password (Linux)"
3956 #: ../examples/guestfs-recipes.pod:347
3958 "Using the L<virt-edit(1)> I<-e> option you can do simple replacements on "
3959 "files. One use is to remove the root password from a Linux guest:"
3963 #: ../examples/guestfs-recipes.pod:350
3966 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
3971 #: ../examples/guestfs-recipes.pod:352
3972 msgid "Remove Administrator password (Windows)"
3976 #: ../examples/guestfs-recipes.pod:354
3978 "The link below contains one technique for removing the Administrator "
3979 "password from a Windows VM, or to be more precise, it gives you a command "
3980 "prompt the next time you log in which you can use to bypass any security:"
3984 #: ../examples/guestfs-recipes.pod:359
3986 "https://mdbooth.wordpress.com/2010/10/18/resetting-a-windows-guests-"
3987 "administrator-password-with-guestfish/"
3991 #: ../examples/guestfs-recipes.pod:361
3992 msgid "Unpack a live CD"
3996 #: ../examples/guestfs-recipes.pod:363
3998 "Linux live CDs often contain multiple layers of disk images wrapped like a "
3999 "Russian doll. You can use L<guestfish(1)> to look inside these multiple "
4000 "layers, as outlined in the guide below."
4004 #: ../examples/guestfs-recipes.pod:367
4006 "https://rwmj.wordpress.com/2009/07/15/unpack-the-russian-doll-of-a-f11-live-"
4011 #: ../examples/guestfs-recipes.pod:369
4012 msgid "Uploading and downloading files"
4016 #: ../examples/guestfs-recipes.pod:371
4018 "The link below contains general tips on uploading (copying in) and "
4019 "downloading (copying out) files from VMs."
4023 #: ../examples/guestfs-recipes.pod:374
4025 "https://rwmj.wordpress.com/2010/12/02/tip-uploading-and-downloading/#content"
4029 #: ../examples/guestfs-recipes.pod:376
4030 msgid "Use libguestfs tools on VMware ESX guests"
4034 #: ../examples/guestfs-recipes.pod:378
4036 "The link below explains how to use libguestfs, L<guestfish(1)> and the virt "
4037 "tools on any VMware ESX guests, by first sharing the VMware VMFS over sshfs."
4041 #: ../examples/guestfs-recipes.pod:382
4043 "https://rwmj.wordpress.com/2011/05/10/tip-use-libguestfs-on-vmware-esx-"
4048 #: ../examples/guestfs-recipes.pod:386
4050 "L<guestfs(3)>, L<guestfish(1)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
4051 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby"
4052 "(3)>, L<http://libguestfs.org/>."
4056 #: ../examples/guestfs-recipes.pod:402
4057 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
4061 #: ../fish/guestfish-actions.pod:1
4066 #: ../fish/guestfish-actions.pod:3
4069 " add-cdrom filename\n"
4074 #: ../fish/guestfish-actions.pod:5 ../src/guestfs-actions.pod:7
4075 msgid "This function adds a virtual CD-ROM disk image to the guest."
4079 #: ../fish/guestfish-actions.pod:7 ../src/guestfs-actions.pod:9
4080 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
4084 #: ../fish/guestfish-actions.pod:15
4086 "This call checks for the existence of C<filename>. This stops you from "
4087 "specifying other types of drive which are supported by qemu such as C<nbd:> "
4088 "and C<http:> URLs. To specify those, use the general L</config> call "
4093 #: ../fish/guestfish-actions.pod:22
4095 "If you just want to add an ISO file (often you use this as an efficient way "
4096 "to transfer large files into the guest), then you should probably use L</add-"
4097 "drive-ro> instead."
4101 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:163
4102 #: ../fish/guestfish-actions.pod:177 ../src/guestfs-actions.pod:32
4103 #: ../src/guestfs-actions.pod:254 ../src/guestfs-actions.pod:275
4105 "This function is deprecated. In new code, use the C<add_drive_opts> call "
4110 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:166
4111 #: ../fish/guestfish-actions.pod:180 ../fish/guestfish-actions.pod:986
4112 #: ../fish/guestfish-actions.pod:1346 ../fish/guestfish-actions.pod:1360
4113 #: ../fish/guestfish-actions.pod:3085 ../fish/guestfish-actions.pod:3292
4114 #: ../fish/guestfish-actions.pod:3406 ../fish/guestfish-actions.pod:3454
4115 #: ../fish/guestfish-actions.pod:4355 ../fish/guestfish-actions.pod:4378
4116 #: ../fish/guestfish-actions.pod:4400 ../fish/guestfish-actions.pod:4438
4117 #: ../fish/guestfish-actions.pod:5087 ../fish/guestfish-actions.pod:5185
4118 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257
4119 #: ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1513
4120 #: ../src/guestfs-actions.pod:2008 ../src/guestfs-actions.pod:2029
4121 #: ../src/guestfs-actions.pod:4628 ../src/guestfs-actions.pod:4947
4122 #: ../src/guestfs-actions.pod:5165 ../src/guestfs-actions.pod:5255
4123 #: ../src/guestfs-actions.pod:6544 ../src/guestfs-actions.pod:6574
4124 #: ../src/guestfs-actions.pod:6607 ../src/guestfs-actions.pod:6666
4125 #: ../src/guestfs-actions.pod:7602 ../src/guestfs-actions.pod:7714
4126 #: ../src/guestfs-actions.pod:7884
4128 "Deprecated functions will not be removed from the API, but the fact that "
4129 "they are deprecated indicates that there are problems with correct use of "
4134 #: ../fish/guestfish-actions.pod:35
4139 #: ../fish/guestfish-actions.pod:37
4144 #: ../fish/guestfish-actions.pod:39
4147 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..]\n"
4152 #: ../fish/guestfish-actions.pod:41
4154 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
4155 "It works by connecting to libvirt, requesting the domain and domain XML from "
4156 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
4160 #: ../fish/guestfish-actions.pod:46 ../src/guestfs-actions.pod:64
4162 "The number of disks added is returned. This operation is atomic: if an "
4163 "error is returned, then no disks are added."
4167 #: ../fish/guestfish-actions.pod:49 ../src/guestfs-actions.pod:67
4169 "This function does some minimal checks to make sure the libvirt domain is "
4170 "not running (unless C<readonly> is true). In a future version we will try "
4171 "to acquire the libvirt lock on each disk."
4175 #: ../fish/guestfish-actions.pod:53 ../src/guestfs-actions.pod:71
4177 "Disks must be accessible locally. This often means that adding disks from a "
4178 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
4179 "unless those disks are accessible via the same device path locally too."
4183 #: ../fish/guestfish-actions.pod:58 ../src/guestfs-actions.pod:76
4185 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
4186 "libvirt.org/uri.html>). If this is not set then we connect to the default "
4187 "libvirt URI (or one set through an environment variable, see the libvirt "
4188 "documentation for full details)."
4192 #: ../fish/guestfish-actions.pod:64 ../src/guestfs-actions.pod:82
4194 "The optional C<live> flag controls whether this call will try to connect to "
4195 "a running virtual machine C<guestfsd> process if it sees a suitable "
4196 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
4197 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
4198 "DAEMONS> for more information."
4202 #: ../fish/guestfish-actions.pod:71 ../src/guestfs-actions.pod:89
4204 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
4205 "passed instead of the domain name. The C<dom> string is treated as a UUID "
4206 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
4211 #: ../fish/guestfish-actions.pod:76
4213 "The other optional parameters are passed directly through to L</add-drive-"
4218 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143
4219 #: ../fish/guestfish-actions.pod:568 ../fish/guestfish-actions.pod:1968
4220 #: ../fish/guestfish-actions.pod:3134 ../fish/guestfish-actions.pod:3307
4221 #: ../fish/guestfish-actions.pod:3442
4223 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
4227 #: ../fish/guestfish-actions.pod:81
4232 #: ../fish/guestfish-actions.pod:83
4235 " add-drive filename\n"
4240 #: ../fish/guestfish-actions.pod:85
4242 "This function is the equivalent of calling L</add-drive-opts> with no "
4243 "optional parameters, so the disk is added writable, with the format being "
4244 "detected automatically."
4248 #: ../fish/guestfish-actions.pod:89
4250 "Automatic detection of the format opens you up to a potential security hole "
4251 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4252 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4253 "you should think about replacing calls to this function with calls to L</add-"
4254 "drive-opts>, and specifying the format."
4258 #: ../fish/guestfish-actions.pod:96
4259 msgid "add-drive-opts"
4263 #: ../fish/guestfish-actions.pod:98
4268 #: ../fish/guestfish-actions.pod:100
4271 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
4276 #: ../fish/guestfish-actions.pod:102 ../src/guestfs-actions.pod:160
4278 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4279 "The first time you call this function, the disk appears as C</dev/sda>, the "
4280 "second time as C</dev/sdb>, and so on."
4284 #: ../fish/guestfish-actions.pod:107 ../src/guestfs-actions.pod:165
4286 "You don't necessarily need to be root when using libguestfs. However you "
4287 "obviously do need sufficient permissions to access the filename for whatever "
4288 "operations you want to perform (ie. read access if you just want to read the "
4289 "image or write access if you want to modify the image)."
4293 #: ../fish/guestfish-actions.pod:113 ../src/guestfs-actions.pod:171
4294 msgid "This call checks that C<filename> exists."
4298 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3096
4299 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4655
4300 msgid "The optional arguments are:"
4304 #: ../fish/guestfish-actions.pod:119 ../src/guestfs-actions.pod:177
4309 #: ../fish/guestfish-actions.pod:121 ../src/guestfs-actions.pod:179
4311 "If true then the image is treated as read-only. Writes are still allowed, "
4312 "but they are stored in a temporary snapshot overlay which is discarded at "
4313 "the end. The disk that you add is not modified."
4317 #: ../fish/guestfish-actions.pod:125 ../src/guestfs-actions.pod:183
4322 #: ../fish/guestfish-actions.pod:127
4324 "This forces the image format. If you omit this (or use L</add-drive> or L</"
4325 "add-drive-ro>) then the format is automatically detected. Possible formats "
4326 "include C<raw> and C<qcow2>."
4330 #: ../fish/guestfish-actions.pod:131 ../src/guestfs-actions.pod:189
4332 "Automatic detection of the format opens you up to a potential security hole "
4333 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4334 "RHBZ#642934. Specifying the format closes this security hole."
4338 #: ../fish/guestfish-actions.pod:136 ../src/guestfs-actions.pod:194
4343 #: ../fish/guestfish-actions.pod:138
4345 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
4346 "add-drive-with-if> call (q.v.)"
4350 #: ../fish/guestfish-actions.pod:145
4351 msgid "add-drive-ro"
4355 #: ../fish/guestfish-actions.pod:147
4360 #: ../fish/guestfish-actions.pod:149
4363 " add-drive-ro filename\n"
4368 #: ../fish/guestfish-actions.pod:151
4370 "This function is the equivalent of calling L</add-drive-opts> with the "
4371 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
4372 "is added read-only, with the format being detected automatically."
4376 #: ../fish/guestfish-actions.pod:156
4377 msgid "add-drive-ro-with-if"
4381 #: ../fish/guestfish-actions.pod:158
4384 " add-drive-ro-with-if filename iface\n"
4389 #: ../fish/guestfish-actions.pod:160
4391 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
4392 "interface emulation to use at run time."
4396 #: ../fish/guestfish-actions.pod:170
4397 msgid "add-drive-with-if"
4401 #: ../fish/guestfish-actions.pod:172
4404 " add-drive-with-if filename iface\n"
4409 #: ../fish/guestfish-actions.pod:174
4411 "This is the same as L</add-drive> but it allows you to specify the QEMU "
4412 "interface emulation to use at run time."
4416 #: ../fish/guestfish-actions.pod:184
4421 #: ../fish/guestfish-actions.pod:186
4424 " aug-clear augpath\n"
4429 #: ../fish/guestfish-actions.pod:188 ../src/guestfs-actions.pod:290
4431 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4432 "L<augtool(1)> C<clear> command."
4436 #: ../fish/guestfish-actions.pod:191
4441 #: ../fish/guestfish-actions.pod:193
4449 #: ../fish/guestfish-actions.pod:195
4451 "Close the current Augeas handle and free up any resources used by it. After "
4452 "calling this, you have to call L</aug-init> again before you can use any "
4453 "other Augeas functions."
4457 #: ../fish/guestfish-actions.pod:200
4462 #: ../fish/guestfish-actions.pod:202
4465 " aug-defnode name expr val\n"
4470 #: ../fish/guestfish-actions.pod:204 ../src/guestfs-actions.pod:319
4472 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4476 #: ../fish/guestfish-actions.pod:207
4478 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4479 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
4480 "containing that single node."
4484 #: ../fish/guestfish-actions.pod:211 ../src/guestfs-actions.pod:326
4486 "On success this returns a pair containing the number of nodes in the "
4487 "nodeset, and a boolean flag if a node was created."
4491 #: ../fish/guestfish-actions.pod:215
4496 #: ../fish/guestfish-actions.pod:217
4499 " aug-defvar name expr\n"
4504 #: ../fish/guestfish-actions.pod:219 ../src/guestfs-actions.pod:343
4506 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4507 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4511 #: ../fish/guestfish-actions.pod:223 ../src/guestfs-actions.pod:347
4513 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4514 "evaluates to something which is not a nodeset."
4518 #: ../fish/guestfish-actions.pod:226
4523 #: ../fish/guestfish-actions.pod:228
4526 " aug-get augpath\n"
4531 #: ../fish/guestfish-actions.pod:230 ../src/guestfs-actions.pod:360
4533 "Look up the value associated with C<path>. If C<path> matches exactly one "
4534 "node, the C<value> is returned."
4538 #: ../fish/guestfish-actions.pod:233
4543 #: ../fish/guestfish-actions.pod:235
4546 " aug-init root flags\n"
4551 #: ../fish/guestfish-actions.pod:237 ../src/guestfs-actions.pod:375
4553 "Create a new Augeas handle for editing configuration files. If there was "
4554 "any previous Augeas handle associated with this guestfs session, then it is "
4559 #: ../fish/guestfish-actions.pod:241
4560 msgid "You must call this before using any other L</aug-*> commands."
4564 #: ../fish/guestfish-actions.pod:244 ../src/guestfs-actions.pod:382
4566 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4570 #: ../fish/guestfish-actions.pod:247 ../src/guestfs-actions.pod:385
4572 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4573 "logical I<or> of the following integers:"
4577 #: ../fish/guestfish-actions.pod:253 ../src/guestfs-actions.pod:391
4578 msgid "C<AUG_SAVE_BACKUP> = 1"
4582 #: ../fish/guestfish-actions.pod:255 ../src/guestfs-actions.pod:393
4583 msgid "Keep the original file with a C<.augsave> extension."
4587 #: ../fish/guestfish-actions.pod:257 ../src/guestfs-actions.pod:395
4588 msgid "C<AUG_SAVE_NEWFILE> = 2"
4592 #: ../fish/guestfish-actions.pod:259 ../src/guestfs-actions.pod:397
4594 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4595 "original. Overrides C<AUG_SAVE_BACKUP>."
4599 #: ../fish/guestfish-actions.pod:262 ../src/guestfs-actions.pod:400
4600 msgid "C<AUG_TYPE_CHECK> = 4"
4604 #: ../fish/guestfish-actions.pod:264 ../src/guestfs-actions.pod:402
4605 msgid "Typecheck lenses (can be expensive)."
4609 #: ../fish/guestfish-actions.pod:266 ../src/guestfs-actions.pod:404
4610 msgid "C<AUG_NO_STDINC> = 8"
4614 #: ../fish/guestfish-actions.pod:268 ../src/guestfs-actions.pod:406
4615 msgid "Do not use standard load path for modules."
4619 #: ../fish/guestfish-actions.pod:270 ../src/guestfs-actions.pod:408
4620 msgid "C<AUG_SAVE_NOOP> = 16"
4624 #: ../fish/guestfish-actions.pod:272 ../src/guestfs-actions.pod:410
4625 msgid "Make save a no-op, just record what would have been changed."
4629 #: ../fish/guestfish-actions.pod:274 ../src/guestfs-actions.pod:412
4630 msgid "C<AUG_NO_LOAD> = 32"
4634 #: ../fish/guestfish-actions.pod:276
4635 msgid "Do not load the tree in L</aug-init>."
4639 #: ../fish/guestfish-actions.pod:280
4640 msgid "To close the handle, you can call L</aug-close>."
4644 #: ../fish/guestfish-actions.pod:282 ../src/guestfs-actions.pod:420
4645 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4649 #: ../fish/guestfish-actions.pod:284
4654 #: ../fish/guestfish-actions.pod:286
4657 " aug-insert augpath label true|false\n"
4662 #: ../fish/guestfish-actions.pod:288 ../src/guestfs-actions.pod:434
4664 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4665 "or after C<path> (depending on the boolean flag C<before>)."
4669 #: ../fish/guestfish-actions.pod:292 ../src/guestfs-actions.pod:438
4671 "C<path> must match exactly one existing node in the tree, and C<label> must "
4672 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4676 #: ../fish/guestfish-actions.pod:296
4681 #: ../fish/guestfish-actions.pod:298
4689 #: ../fish/guestfish-actions.pod:300 ../src/guestfs-actions.pod:451
4690 msgid "Load files into the tree."
4694 #: ../fish/guestfish-actions.pod:302 ../src/guestfs-actions.pod:453
4695 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4699 #: ../fish/guestfish-actions.pod:305
4704 #: ../fish/guestfish-actions.pod:307
4712 #: ../fish/guestfish-actions.pod:309
4714 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
4715 "resulting nodes into alphabetical order."
4719 #: ../fish/guestfish-actions.pod:312
4724 #: ../fish/guestfish-actions.pod:314
4727 " aug-match augpath\n"
4732 #: ../fish/guestfish-actions.pod:316 ../src/guestfs-actions.pod:481
4734 "Returns a list of paths which match the path expression C<path>. The "
4735 "returned paths are sufficiently qualified so that they match exactly one "
4736 "node in the current tree."
4740 #: ../fish/guestfish-actions.pod:320
4745 #: ../fish/guestfish-actions.pod:322
4748 " aug-mv src dest\n"
4753 #: ../fish/guestfish-actions.pod:324 ../src/guestfs-actions.pod:498
4755 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4756 "C<dest> is overwritten if it exists."
4760 #: ../fish/guestfish-actions.pod:327
4765 #: ../fish/guestfish-actions.pod:329
4773 #: ../fish/guestfish-actions.pod:331 ../src/guestfs-actions.pod:511
4774 msgid "Remove C<path> and all of its children."
4778 #: ../fish/guestfish-actions.pod:333 ../src/guestfs-actions.pod:513
4779 msgid "On success this returns the number of entries which were removed."
4783 #: ../fish/guestfish-actions.pod:335
4788 #: ../fish/guestfish-actions.pod:337
4796 #: ../fish/guestfish-actions.pod:339 ../src/guestfs-actions.pod:524
4797 msgid "This writes all pending changes to disk."
4801 #: ../fish/guestfish-actions.pod:341
4803 "The flags which were passed to L</aug-init> affect exactly how files are "
4808 #: ../fish/guestfish-actions.pod:344
4813 #: ../fish/guestfish-actions.pod:346
4816 " aug-set augpath val\n"
4821 #: ../fish/guestfish-actions.pod:348 ../src/guestfs-actions.pod:540
4822 msgid "Set the value associated with C<path> to C<val>."
4826 #: ../fish/guestfish-actions.pod:350
4828 "In the Augeas API, it is possible to clear a node by setting the value to "
4829 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
4830 "this call. Instead you must use the L</aug-clear> call."
4834 #: ../fish/guestfish-actions.pod:355
4839 #: ../fish/guestfish-actions.pod:357
4842 " available 'groups ...'\n"
4847 #: ../fish/guestfish-actions.pod:359 ../src/guestfs-actions.pod:557
4849 "This command is used to check the availability of some groups of "
4850 "functionality in the appliance, which not all builds of the libguestfs "
4851 "appliance will be able to provide."
4855 #: ../fish/guestfish-actions.pod:363
4857 "The libguestfs groups, and the functions that those groups correspond to, "
4858 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
4859 "runtime by calling L</available-all-groups>."
4863 #: ../fish/guestfish-actions.pod:368 ../src/guestfs-actions.pod:566
4865 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
4866 "\"]> would check for the availability of the Linux inotify functions and "
4867 "Augeas (configuration file editing) functions."
4871 #: ../fish/guestfish-actions.pod:373 ../src/guestfs-actions.pod:571
4872 msgid "The command returns no error if I<all> requested groups are available."
4876 #: ../fish/guestfish-actions.pod:375 ../src/guestfs-actions.pod:573
4878 "It fails with an error if one or more of the requested groups is unavailable "
4883 #: ../fish/guestfish-actions.pod:378 ../src/guestfs-actions.pod:576
4885 "If an unknown group name is included in the list of groups then an error is "
4890 #: ../fish/guestfish-actions.pod:381 ../src/guestfs-actions.pod:579
4895 #: ../fish/guestfish-actions.pod:387
4896 msgid "You must call L</launch> before calling this function."
4900 #: ../fish/guestfish-actions.pod:389 ../src/guestfs-actions.pod:587
4902 "The reason is because we don't know what groups are supported by the "
4903 "appliance/daemon until it is running and can be queried."
4907 #: ../fish/guestfish-actions.pod:395 ../src/guestfs-actions.pod:593
4909 "If a group of functions is available, this does not necessarily mean that "
4910 "they will work. You still have to check for errors when calling individual "
4911 "API functions even if they are available."
4915 #: ../fish/guestfish-actions.pod:402 ../src/guestfs-actions.pod:600
4917 "It is usually the job of distro packagers to build complete functionality "
4918 "into the libguestfs appliance. Upstream libguestfs, if built from source "
4919 "with all requirements satisfied, will support everything."
4923 #: ../fish/guestfish-actions.pod:409
4925 "This call was added in version C<1.0.80>. In previous versions of "
4926 "libguestfs all you could do would be to speculatively execute a command to "
4927 "find out if the daemon implemented it. See also L</version>."
4931 #: ../fish/guestfish-actions.pod:416
4932 msgid "available-all-groups"
4936 #: ../fish/guestfish-actions.pod:418
4939 " available-all-groups\n"
4944 #: ../fish/guestfish-actions.pod:420
4946 "This command returns a list of all optional groups that this daemon knows "
4947 "about. Note this returns both supported and unsupported groups. To find "
4948 "out which ones the daemon can actually support you have to call L</"
4949 "available> on each member of the returned list."
4953 #: ../fish/guestfish-actions.pod:426
4954 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
4958 #: ../fish/guestfish-actions.pod:428
4963 #: ../fish/guestfish-actions.pod:430
4966 " base64-in (base64file|-) filename\n"
4971 #: ../fish/guestfish-actions.pod:432 ../src/guestfs-actions.pod:644
4973 "This command uploads base64-encoded data from C<base64file> to C<filename>."
4977 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444
4978 #: ../fish/guestfish-actions.pod:693 ../fish/guestfish-actions.pod:862
4979 #: ../fish/guestfish-actions.pod:881 ../fish/guestfish-actions.pod:1255
4980 #: ../fish/guestfish-actions.pod:4658 ../fish/guestfish-actions.pod:4670
4981 #: ../fish/guestfish-actions.pod:4681 ../fish/guestfish-actions.pod:4692
4982 #: ../fish/guestfish-actions.pod:4744 ../fish/guestfish-actions.pod:4753
4983 #: ../fish/guestfish-actions.pod:4807 ../fish/guestfish-actions.pod:4830
4984 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
4988 #: ../fish/guestfish-actions.pod:437
4993 #: ../fish/guestfish-actions.pod:439
4996 " base64-out filename (base64file|-)\n"
5001 #: ../fish/guestfish-actions.pod:441 ../src/guestfs-actions.pod:658
5003 "This command downloads the contents of C<filename>, writing it out to local "
5004 "file C<base64file> encoded as base64."
5008 #: ../fish/guestfish-actions.pod:446
5009 msgid "blockdev-flushbufs"
5013 #: ../fish/guestfish-actions.pod:448
5016 " blockdev-flushbufs device\n"
5021 #: ../fish/guestfish-actions.pod:450 ../src/guestfs-actions.pod:671
5023 "This tells the kernel to flush internal buffers associated with C<device>."
5027 #: ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464
5028 #: ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483
5029 #: ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508
5030 #: ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527
5031 #: ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
5032 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:691
5033 #: ../src/guestfs-actions.pod:706 ../src/guestfs-actions.pod:722
5034 #: ../src/guestfs-actions.pod:740 ../src/guestfs-actions.pod:759
5035 #: ../src/guestfs-actions.pod:773 ../src/guestfs-actions.pod:791
5036 #: ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:819
5037 msgid "This uses the L<blockdev(8)> command."
5041 #: ../fish/guestfish-actions.pod:455
5042 msgid "blockdev-getbsz"
5046 #: ../fish/guestfish-actions.pod:457
5049 " blockdev-getbsz device\n"
5054 #: ../fish/guestfish-actions.pod:459 ../src/guestfs-actions.pod:686
5055 msgid "This returns the block size of a device."
5059 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
5060 #: ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788
5062 "(Note this is different from both I<size in blocks> and I<filesystem block "
5067 #: ../fish/guestfish-actions.pod:466
5068 msgid "blockdev-getro"
5072 #: ../fish/guestfish-actions.pod:468
5075 " blockdev-getro device\n"
5080 #: ../fish/guestfish-actions.pod:470 ../src/guestfs-actions.pod:703
5082 "Returns a boolean indicating if the block device is read-only (true if read-"
5083 "only, false if not)."
5087 #: ../fish/guestfish-actions.pod:475
5088 msgid "blockdev-getsize64"
5092 #: ../fish/guestfish-actions.pod:477
5095 " blockdev-getsize64 device\n"
5100 #: ../fish/guestfish-actions.pod:479 ../src/guestfs-actions.pod:718
5101 msgid "This returns the size of the device in bytes."
5105 #: ../fish/guestfish-actions.pod:481
5106 msgid "See also L</blockdev-getsz>."
5110 #: ../fish/guestfish-actions.pod:485
5111 msgid "blockdev-getss"
5115 #: ../fish/guestfish-actions.pod:487
5118 " blockdev-getss device\