Version 1.5.21.
[libguestfs.git] / po-docs / libguestfs-docs.pot
1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Red Hat Inc.
3 # This file is distributed under the same license as the libguestfs package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
5 #
6 #, fuzzy
7 msgid ""
8 msgstr ""
9 "Project-Id-Version: libguestfs 1.5.21\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2010-10-01 21:02+0200\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
15 "MIME-Version: 1.0\n"
16 "Content-Type: text/plain; charset=utf-8\n"
17 "Content-Transfer-Encoding: ENCODING"
18
19 # type: =encoding
20 #: ../src/guestfs.pod:1 ../fish/guestfish.pod:1 ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1 ../inspector/virt-inspector.pl:36 ../tools/virt-edit.pl:31 ../tools/virt-win-reg.pl:34 ../tools/virt-df.pl:32 ../tools/virt-ls.pl:31 ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28 ../tools/virt-cat.pl:30 ../tools/virt-tar.pl:30 ../tools/virt-rescue.pl:29 ../tools/virt-make-fs.pl:33 ../tools/virt-list-partitions.pl:28
21 msgid "utf8"
22 msgstr ""
23
24 # type: =head1
25 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../inspector/virt-inspector.pl:38 ../tools/virt-edit.pl:33 ../tools/virt-win-reg.pl:36 ../tools/virt-df.pl:34 ../tools/virt-ls.pl:33 ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 ../tools/virt-cat.pl:32 ../tools/virt-tar.pl:32 ../tools/virt-rescue.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
26 msgid "NAME"
27 msgstr ""
28
29 # type: textblock
30 #: ../src/guestfs.pod:5
31 msgid "guestfs - Library for accessing and modifying virtual machine images"
32 msgstr ""
33
34 # type: =head1
35 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../inspector/virt-inspector.pl:42 ../tools/virt-edit.pl:37 ../tools/virt-win-reg.pl:40 ../tools/virt-df.pl:38 ../tools/virt-ls.pl:37 ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 ../tools/virt-cat.pl:36 ../tools/virt-tar.pl:36 ../tools/virt-rescue.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
36 msgid "SYNOPSIS"
37 msgstr ""
38
39 # type: verbatim
40 #: ../src/guestfs.pod:9
41 #, no-wrap
42 msgid ""
43 " #include <guestfs.h>\n"
44 " \n"
45 msgstr ""
46
47 # type: verbatim
48 #: ../src/guestfs.pod:11
49 #, no-wrap
50 msgid ""
51 " guestfs_h *g = guestfs_create ();\n"
52 " guestfs_add_drive (g, \"guest.img\");\n"
53 " guestfs_launch (g);\n"
54 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
55 " guestfs_touch (g, \"/hello\");\n"
56 " guestfs_umount (g, \"/\");\n"
57 " guestfs_sync (g);\n"
58 " guestfs_close (g);\n"
59 "\n"
60 msgstr ""
61
62 # type: verbatim
63 #: ../src/guestfs.pod:20
64 #, no-wrap
65 msgid ""
66 " cc prog.c -o prog -lguestfs\n"
67 "or:\n"
68 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
69 "\n"
70 msgstr ""
71
72 # type: =head1
73 #: ../src/guestfs.pod:24 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:16 ../inspector/virt-inspector.pl:48 ../tools/virt-edit.pl:51 ../tools/virt-win-reg.pl:64 ../tools/virt-df.pl:46 ../tools/virt-ls.pl:43 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-cat.pl:42 ../tools/virt-tar.pl:73 ../tools/virt-rescue.pl:51 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
74 msgid "DESCRIPTION"
75 msgstr ""
76
77 # type: textblock
78 #: ../src/guestfs.pod:26
79 msgid ""
80 "Libguestfs is a library for accessing and modifying guest disk images.  "
81 "Amongst the things this is good for: making batch configuration changes to "
82 "guests, getting disk used/free statistics (see also: virt-df), migrating "
83 "between virtualization systems (see also: virt-p2v), performing partial "
84 "backups, performing partial guest clones, cloning guests and changing "
85 "registry/UUID/hostname info, and much else besides."
86 msgstr ""
87
88 # type: textblock
89 #: ../src/guestfs.pod:34
90 msgid ""
91 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
92 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
93 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
94 "qcow2, vmdk."
95 msgstr ""
96
97 # type: textblock
98 #: ../src/guestfs.pod:39
99 msgid ""
100 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
101 "what filesystem is in each LV, etc.).  It can also run commands in the "
102 "context of the guest.  Also you can access filesystems over FUSE."
103 msgstr ""
104
105 # type: textblock
106 #: ../src/guestfs.pod:44
107 msgid ""
108 "Libguestfs is a library that can be linked with C and C++ management "
109 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
110 "PHP, Haskell or C#).  You can also use it from shell scripts or the command "
111 "line."
112 msgstr ""
113
114 # type: textblock
115 #: ../src/guestfs.pod:49
116 msgid ""
117 "You don't need to be root to use libguestfs, although obviously you do need "
118 "enough permissions to access the disk images."
119 msgstr ""
120
121 # type: textblock
122 #: ../src/guestfs.pod:52
123 msgid ""
124 "Libguestfs is a large API because it can do many things.  For a gentle "
125 "introduction, please read the L</API OVERVIEW> section next."
126 msgstr ""
127
128 # type: =head1
129 #: ../src/guestfs.pod:55
130 msgid "API OVERVIEW"
131 msgstr ""
132
133 # type: textblock
134 #: ../src/guestfs.pod:57
135 msgid ""
136 "This section provides a gentler overview of the libguestfs API.  We also try "
137 "to group API calls together, where that may not be obvious from reading "
138 "about the individual calls in the main section of this manual."
139 msgstr ""
140
141 # type: =head2
142 #: ../src/guestfs.pod:62
143 msgid "HANDLES"
144 msgstr ""
145
146 # type: textblock
147 #: ../src/guestfs.pod:64
148 msgid ""
149 "Before you can use libguestfs calls, you have to create a handle.  Then you "
150 "must add at least one disk image to the handle, followed by launching the "
151 "handle, then performing whatever operations you want, and finally closing "
152 "the handle.  By convention we use the single letter C<g> for the name of the "
153 "handle variable, although of course you can use any name you want."
154 msgstr ""
155
156 # type: textblock
157 #: ../src/guestfs.pod:71
158 msgid "The general structure of all libguestfs-using programs looks like this:"
159 msgstr ""
160
161 # type: verbatim
162 #: ../src/guestfs.pod:74
163 #, no-wrap
164 msgid ""
165 " guestfs_h *g = guestfs_create ();\n"
166 " \n"
167 msgstr ""
168
169 # type: verbatim
170 #: ../src/guestfs.pod:76
171 #, no-wrap
172 msgid ""
173 " /* Call guestfs_add_drive additional times if there are\n"
174 "  * multiple disk images.\n"
175 "  */\n"
176 " guestfs_add_drive (g, \"guest.img\");\n"
177 " \n"
178 msgstr ""
179
180 # type: verbatim
181 #: ../src/guestfs.pod:81
182 #, no-wrap
183 msgid ""
184 " /* Most manipulation calls won't work until you've launched\n"
185 "  * the handle 'g'.  You have to do this _after_ adding drives\n"
186 "  * and _before_ other commands.\n"
187 "  */\n"
188 " guestfs_launch (g);\n"
189 " \n"
190 msgstr ""
191
192 # type: verbatim
193 #: ../src/guestfs.pod:87
194 #, no-wrap
195 msgid ""
196 " /* Now you can examine what partitions, LVs etc are available.\n"
197 "  */\n"
198 " char **partitions = guestfs_list_partitions (g);\n"
199 " char **logvols = guestfs_lvs (g);\n"
200 " \n"
201 msgstr ""
202
203 # type: verbatim
204 #: ../src/guestfs.pod:92
205 #, no-wrap
206 msgid ""
207 " /* To access a filesystem in the image, you must mount it.\n"
208 "  */\n"
209 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
210 " \n"
211 msgstr ""
212
213 # type: verbatim
214 #: ../src/guestfs.pod:96
215 #, no-wrap
216 msgid ""
217 " /* Now you can perform filesystem actions on the guest\n"
218 "  * disk image.\n"
219 "  */\n"
220 " guestfs_touch (g, \"/hello\");\n"
221 " \n"
222 msgstr ""
223
224 # type: verbatim
225 #: ../src/guestfs.pod:101
226 #, no-wrap
227 msgid ""
228 " /* You only need to call guestfs_sync if you have made\n"
229 "  * changes to the guest image.  (But if you've made changes\n"
230 "  * then you *must* sync).  See also: guestfs_umount and\n"
231 "  * guestfs_umount_all calls.\n"
232 "  */\n"
233 " guestfs_sync (g);\n"
234 " \n"
235 msgstr ""
236
237 # type: verbatim
238 #: ../src/guestfs.pod:108
239 #, no-wrap
240 msgid ""
241 " /* Close the handle 'g'. */\n"
242 " guestfs_close (g);\n"
243 "\n"
244 msgstr ""
245
246 # type: textblock
247 #: ../src/guestfs.pod:111
248 msgid ""
249 "The code above doesn't include any error checking.  In real code you should "
250 "check return values carefully for errors.  In general all functions that "
251 "return integers return C<-1> on error, and all functions that return "
252 "pointers return C<NULL> on error.  See section L</ERROR HANDLING> below for "
253 "how to handle errors, and consult the documentation for each function call "
254 "below to see precisely how they return error indications."
255 msgstr ""
256
257 # type: =head2
258 #: ../src/guestfs.pod:119
259 msgid "DISK IMAGES"
260 msgstr ""
261
262 # type: textblock
263 #: ../src/guestfs.pod:121
264 msgid ""
265 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
266 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
267 "actual block device, or simply an empty file of zeroes that you have created "
268 "through L<posix_fallocate(3)>.  Libguestfs lets you do useful things to all "
269 "of these."
270 msgstr ""
271
272 # type: textblock
273 #: ../src/guestfs.pod:127
274 msgid ""
275 "You can add a disk read-only using L</guestfs_add_drive_ro>, in which case "
276 "libguestfs won't modify the file."
277 msgstr ""
278
279 # type: textblock
280 #: ../src/guestfs.pod:130
281 msgid ""
282 "Be extremely cautious if the disk image is in use, eg. if it is being used "
283 "by a virtual machine.  Adding it read-write will almost certainly cause disk "
284 "corruption, but adding it read-only is safe."
285 msgstr ""
286
287 # type: textblock
288 #: ../src/guestfs.pod:134
289 msgid ""
290 "You must add at least one disk image, and you may add multiple disk images.  "
291 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
292 "first one you added), C</dev/sdb> (for the second one you added), etc."
293 msgstr ""
294
295 # type: textblock
296 #: ../src/guestfs.pod:139
297 msgid ""
298 "Once L</guestfs_launch> has been called you cannot add any more images.  You "
299 "can call L</guestfs_list_devices> to get a list of the device names, in the "
300 "order that you added them.  See also L</BLOCK DEVICE NAMING> below."
301 msgstr ""
302
303 # type: =head2
304 #: ../src/guestfs.pod:144
305 msgid "MOUNTING"
306 msgstr ""
307
308 # type: textblock
309 #: ../src/guestfs.pod:146
310 msgid ""
311 "Before you can read or write files, create directories and so on in a disk "
312 "image that contains filesystems, you have to mount those filesystems using "
313 "L</guestfs_mount>.  If you already know that a disk image contains (for "
314 "example) one partition with a filesystem on that partition, then you can "
315 "mount it directly:"
316 msgstr ""
317
318 # type: verbatim
319 #: ../src/guestfs.pod:152
320 #, no-wrap
321 msgid ""
322 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
323 "\n"
324 msgstr ""
325
326 # type: textblock
327 #: ../src/guestfs.pod:154
328 msgid ""
329 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
330 "disk image that we added (C</dev/sda>).  If the disk contains Linux LVM2 "
331 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>)."
332 msgstr ""
333
334 # type: textblock
335 #: ../src/guestfs.pod:158
336 msgid ""
337 "If you are given a disk image and you don't know what it contains then you "
338 "have to find out.  Libguestfs can do that too: use "
339 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
340 "and LVs, and either try mounting each to see what is mountable, or else "
341 "examine them with L</guestfs_vfs_type> or L</guestfs_file>.  Libguestfs also "
342 "has a set of APIs for inspection of disk images (see L</INSPECTION> below).  "
343 "But you might find it easier to look at higher level programs built on top "
344 "of libguestfs, in particular L<virt-inspector(1)>."
345 msgstr ""
346
347 # type: textblock
348 #: ../src/guestfs.pod:168
349 msgid ""
350 "To mount a disk image read-only, use L</guestfs_mount_ro>.  There are "
351 "several other variations of the C<guestfs_mount_*> call."
352 msgstr ""
353
354 # type: =head2
355 #: ../src/guestfs.pod:171
356 msgid "FILESYSTEM ACCESS AND MODIFICATION"
357 msgstr ""
358
359 # type: textblock
360 #: ../src/guestfs.pod:173
361 msgid ""
362 "The majority of the libguestfs API consists of fairly low-level calls for "
363 "accessing and modifying the files, directories, symlinks etc on mounted "
364 "filesystems.  There are over a hundred such calls which you can find listed "
365 "in detail below in this man page, and we don't even pretend to cover them "
366 "all in this overview."
367 msgstr ""
368
369 # type: textblock
370 #: ../src/guestfs.pod:179
371 msgid ""
372 "Specify filenames as full paths, starting with C<\"/\"> and including the "
373 "mount point."
374 msgstr ""
375
376 # type: textblock
377 #: ../src/guestfs.pod:182
378 msgid ""
379 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
380 "the file called C<\"etc/passwd\"> then you could do:"
381 msgstr ""
382
383 # type: verbatim
384 #: ../src/guestfs.pod:185
385 #, no-wrap
386 msgid ""
387 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
388 "\n"
389 msgstr ""
390
391 # type: textblock
392 #: ../src/guestfs.pod:187
393 msgid ""
394 "This would return C<data> as a newly allocated buffer containing the full "
395 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
396 "or C<NULL> if there was an error."
397 msgstr ""
398
399 # type: textblock
400 #: ../src/guestfs.pod:191
401 msgid ""
402 "As another example, to create a top-level directory on that filesystem "
403 "called C<\"var\"> you would do:"
404 msgstr ""
405
406 # type: verbatim
407 #: ../src/guestfs.pod:194
408 #, no-wrap
409 msgid ""
410 " guestfs_mkdir (g, \"/var\");\n"
411 "\n"
412 msgstr ""
413
414 # type: textblock
415 #: ../src/guestfs.pod:196
416 msgid "To create a symlink you could do:"
417 msgstr ""
418
419 # type: verbatim
420 #: ../src/guestfs.pod:198
421 #, no-wrap
422 msgid ""
423 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
424 "               \"/etc/rc3.d/S30portmap\");\n"
425 "\n"
426 msgstr ""
427
428 # type: textblock
429 #: ../src/guestfs.pod:201
430 msgid ""
431 "Libguestfs will reject attempts to use relative paths and there is no "
432 "concept of a current working directory."
433 msgstr ""
434
435 # type: textblock
436 #: ../src/guestfs.pod:204
437 msgid ""
438 "Libguestfs can return errors in many situations: for example if the "
439 "filesystem isn't writable, or if a file or directory that you requested "
440 "doesn't exist.  If you are using the C API (documented here)  you have to "
441 "check for those error conditions after each call.  (Other language bindings "
442 "turn these errors into exceptions)."
443 msgstr ""
444
445 # type: textblock
446 #: ../src/guestfs.pod:210
447 msgid ""
448 "File writes are affected by the per-handle umask, set by calling "
449 "L</guestfs_umask> and defaulting to 022.  See L</UMASK>."
450 msgstr ""
451
452 # type: =head2
453 #: ../src/guestfs.pod:213
454 msgid "PARTITIONING"
455 msgstr ""
456
457 # type: textblock
458 #: ../src/guestfs.pod:215
459 msgid ""
460 "Libguestfs contains API calls to read, create and modify partition tables on "
461 "disk images."
462 msgstr ""
463
464 # type: textblock
465 #: ../src/guestfs.pod:218
466 msgid ""
467 "In the common case where you want to create a single partition covering the "
468 "whole disk, you should use the L</guestfs_part_disk> call:"
469 msgstr ""
470
471 # type: verbatim
472 #: ../src/guestfs.pod:222
473 #, no-wrap
474 msgid ""
475 " const char *parttype = \"mbr\";\n"
476 " if (disk_is_larger_than_2TB)\n"
477 "   parttype = \"gpt\";\n"
478 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
479 "\n"
480 msgstr ""
481
482 # type: textblock
483 #: ../src/guestfs.pod:227
484 msgid ""
485 "Obviously this effectively wipes anything that was on that disk image "
486 "before."
487 msgstr ""
488
489 # type: =head2
490 #: ../src/guestfs.pod:230
491 msgid "LVM2"
492 msgstr ""
493
494 # type: textblock
495 #: ../src/guestfs.pod:232
496 msgid ""
497 "Libguestfs provides access to a large part of the LVM2 API, such as "
498 "L</guestfs_lvcreate> and L</guestfs_vgremove>.  It won't make much sense "
499 "unless you familiarize yourself with the concepts of physical volumes, "
500 "volume groups and logical volumes."
501 msgstr ""
502
503 # type: textblock
504 #: ../src/guestfs.pod:237
505 msgid ""
506 "This author strongly recommends reading the LVM HOWTO, online at "
507 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
508 msgstr ""
509
510 # type: =head2
511 #: ../src/guestfs.pod:240
512 msgid "DOWNLOADING"
513 msgstr ""
514
515 # type: textblock
516 #: ../src/guestfs.pod:242
517 msgid ""
518 "Use L</guestfs_cat> to download small, text only files.  This call is "
519 "limited to files which are less than 2 MB and which cannot contain any ASCII "
520 "NUL (C<\\0>) characters.  However it has a very simple to use API."
521 msgstr ""
522
523 # type: textblock
524 #: ../src/guestfs.pod:247
525 msgid ""
526 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
527 "bit data, since it returns a (pointer, size) pair.  However it is still "
528 "limited to \"small\" files, less than 2 MB."
529 msgstr ""
530
531 # type: textblock
532 #: ../src/guestfs.pod:251
533 msgid ""
534 "L</guestfs_download> can be used to download any file, with no limits on "
535 "content or size (even files larger than 4 GB)."
536 msgstr ""
537
538 # type: textblock
539 #: ../src/guestfs.pod:254
540 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
541 msgstr ""
542
543 # type: =head2
544 #: ../src/guestfs.pod:257
545 msgid "UPLOADING"
546 msgstr ""
547
548 # type: textblock
549 #: ../src/guestfs.pod:259
550 msgid ""
551 "It's often the case that you want to write a file or files to the disk "
552 "image."
553 msgstr ""
554
555 # type: textblock
556 #: ../src/guestfs.pod:262
557 msgid ""
558 "To write a small file with fixed content, use L</guestfs_write>.  To create "
559 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
560 "L</guestfs_fallocate64> (with all disk blocks allocated).  There are a "
561 "variety of other functions for creating test files, for example "
562 "L</guestfs_fill> and L</guestfs_fill_pattern>."
563 msgstr ""
564
565 # type: textblock
566 #: ../src/guestfs.pod:268
567 msgid ""
568 "To upload a single file, use L</guestfs_upload>.  This call has no limits on "
569 "file content or size (even files larger than 4 GB)."
570 msgstr ""
571
572 # type: textblock
573 #: ../src/guestfs.pod:271
574 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
575 msgstr ""
576
577 # type: textblock
578 #: ../src/guestfs.pod:273
579 msgid ""
580 "However the fastest way to upload I<large numbers of arbitrary files> is to "
581 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
582 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>.  If you add "
583 "the drive in a predictable way (eg. adding it last after all other drives) "
584 "then you can get the device name from L</guestfs_list_devices> and mount it "
585 "directly using L</guestfs_mount_ro>.  Note that squashfs images are "
586 "sometimes non-portable between kernel versions, and they don't support "
587 "labels or UUIDs.  If you want to pre-build an image or you need to mount it "
588 "using a label or UUID, use an ISO image instead."
589 msgstr ""
590
591 # type: =head2
592 #: ../src/guestfs.pod:284
593 msgid "COPYING"
594 msgstr ""
595
596 # type: textblock
597 #: ../src/guestfs.pod:286
598 msgid ""
599 "There are various different commands for copying between files and devices "
600 "and in and out of the guest filesystem.  These are summarised in the table "
601 "below."
602 msgstr ""
603
604 # type: =item
605 #: ../src/guestfs.pod:292
606 msgid "B<file> to B<file>"
607 msgstr ""
608
609 # type: textblock
610 #: ../src/guestfs.pod:294
611 msgid ""
612 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
613 "directories recursively."
614 msgstr ""
615
616 # type: =item
617 #: ../src/guestfs.pod:297
618 msgid "B<file or device> to B<file or device>"
619 msgstr ""
620
621 # type: textblock
622 #: ../src/guestfs.pod:299
623 msgid ""
624 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
625 "devices in the guest."
626 msgstr ""
627
628 # type: textblock
629 #: ../src/guestfs.pod:302
630 msgid "Example: duplicate the contents of an LV:"
631 msgstr ""
632
633 # type: verbatim
634 #: ../src/guestfs.pod:304
635 #, no-wrap
636 msgid ""
637 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
638 "\n"
639 msgstr ""
640
641 # type: textblock
642 #: ../src/guestfs.pod:306
643 msgid ""
644 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
645 "(C</dev/VG/Original>).  To copy less than the whole source device, use "
646 "L</guestfs_copy_size>."
647 msgstr ""
648
649 # type: =item
650 #: ../src/guestfs.pod:310
651 msgid "B<file on the host> to B<file or device>"
652 msgstr ""
653
654 # type: textblock
655 #: ../src/guestfs.pod:312
656 msgid "Use L</guestfs_upload>.  See L</UPLOADING> above."
657 msgstr ""
658
659 # type: =item
660 #: ../src/guestfs.pod:314
661 msgid "B<file or device> to B<file on the host>"
662 msgstr ""
663
664 # type: textblock
665 #: ../src/guestfs.pod:316
666 msgid "Use L</guestfs_download>.  See L</DOWNLOADING> above."
667 msgstr ""
668
669 # type: =head2
670 #: ../src/guestfs.pod:320
671 msgid "LISTING FILES"
672 msgstr ""
673
674 # type: textblock
675 #: ../src/guestfs.pod:322
676 msgid ""
677 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
678 "L<guestfish(1)>-equivalent command C<ll>)."
679 msgstr ""
680
681 # type: textblock
682 #: ../src/guestfs.pod:325
683 msgid ""
684 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
685 "programs, as a flat list of strings."
686 msgstr ""
687
688 # type: textblock
689 #: ../src/guestfs.pod:328
690 msgid ""
691 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
692 "directory, plus additional information about each one.  It is more "
693 "equivalent to using the L<readdir(3)> call on a local filesystem."
694 msgstr ""
695
696 # type: textblock
697 #: ../src/guestfs.pod:332
698 msgid ""
699 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
700 "files."
701 msgstr ""
702
703 # type: =head2
704 #: ../src/guestfs.pod:335
705 msgid "RUNNING COMMANDS"
706 msgstr ""
707
708 # type: textblock
709 #: ../src/guestfs.pod:337
710 msgid ""
711 "Although libguestfs is primarily an API for manipulating files inside guest "
712 "images, we also provide some limited facilities for running commands inside "
713 "guests."
714 msgstr ""
715
716 # type: textblock
717 #: ../src/guestfs.pod:341
718 msgid "There are many limitations to this:"
719 msgstr ""
720
721 # type: =item
722 #: ../src/guestfs.pod:345 ../src/guestfs.pod:350 ../src/guestfs.pod:355 ../src/guestfs.pod:359 ../src/guestfs.pod:364 ../src/guestfs.pod:368 ../src/guestfs.pod:373 ../src/guestfs.pod:1254 ../src/guestfs.pod:1259 ../src/guestfs.pod:1263 ../src/guestfs.pod:1365 ../src/guestfs.pod:1369 ../src/guestfs.pod:1373 ../src/guestfs.pod:1378 ../src/guestfs.pod:1386 ../src/guestfs.pod:1405 ../src/guestfs.pod:1413 ../src/guestfs.pod:1643 ../src/guestfs.pod:1649 ../src/guestfs.pod:1654 ../src/guestfs.pod:1660 ../src/guestfs.pod:1767 ../src/guestfs.pod:1771 ../src/guestfs.pod:1775 ../src/guestfs.pod:1779 ../src/guestfs-actions.pod:14 ../src/guestfs-actions.pod:21 ../src/guestfs-actions.pod:372 ../src/guestfs-actions.pod:380 ../src/guestfs-actions.pod:387 ../src/guestfs-actions.pod:394 ../src/guestfs-actions.pod:1285 ../src/guestfs-actions.pod:1289 ../src/guestfs-actions.pod:1293 ../src/guestfs-actions.pod:1297 ../src/guestfs-actions.pod:1305 ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:1313 ../src/guestfs-actions.pod:1323 ../src/guestfs-actions.pod:1327 ../src/guestfs-actions.pod:1331 ../src/guestfs-actions.pod:1454 ../src/guestfs-actions.pod:1458 ../src/guestfs-actions.pod:1463 ../src/guestfs-actions.pod:1468 ../src/guestfs-actions.pod:1520 ../src/guestfs-actions.pod:1524 ../src/guestfs-actions.pod:1529 ../fish/guestfish.pod:338 ../fish/guestfish.pod:342 ../fish/guestfish.pod:346 ../fish/guestfish.pod:350 ../fish/guestfish-actions.pod:15 ../fish/guestfish-actions.pod:22 ../fish/guestfish-actions.pod:306 ../fish/guestfish-actions.pod:314 ../fish/guestfish-actions.pod:321 ../fish/guestfish-actions.pod:328 ../fish/guestfish-actions.pod:1023 ../fish/guestfish-actions.pod:1027 ../fish/guestfish-actions.pod:1031 ../fish/guestfish-actions.pod:1035 ../fish/guestfish-actions.pod:1043 ../fish/guestfish-actions.pod:1047 ../fish/guestfish-actions.pod:1051 ../fish/guestfish-actions.pod:1061 ../fish/guestfish-actions.pod:1065 ../fish/guestfish-actions.pod:1069 ../fish/guestfish-actions.pod:1159 ../fish/guestfish-actions.pod:1163 ../fish/guestfish-actions.pod:1168 ../fish/guestfish-actions.pod:1173 ../fish/guestfish-actions.pod:1215 ../fish/guestfish-actions.pod:1219 ../fish/guestfish-actions.pod:1224 ../tools/virt-df.pl:144 ../tools/virt-df.pl:150 ../tools/virt-resize.pl:324 ../tools/virt-resize.pl:329 ../tools/virt-resize.pl:339
723 msgid "*"
724 msgstr ""
725
726 # type: textblock
727 #: ../src/guestfs.pod:347
728 msgid ""
729 "The kernel version that the command runs under will be different from what "
730 "it expects."
731 msgstr ""
732
733 # type: textblock
734 #: ../src/guestfs.pod:352
735 msgid ""
736 "If the command needs to communicate with daemons, then most likely they "
737 "won't be running."
738 msgstr ""
739
740 # type: textblock
741 #: ../src/guestfs.pod:357
742 msgid "The command will be running in limited memory."
743 msgstr ""
744
745 # type: textblock
746 #: ../src/guestfs.pod:361
747 msgid ""
748 "The network may not be available unless you enable it (see "
749 "L</guestfs_set_network>)."
750 msgstr ""
751
752 # type: textblock
753 #: ../src/guestfs.pod:366
754 msgid "Only supports Linux guests (not Windows, BSD, etc)."
755 msgstr ""
756
757 # type: textblock
758 #: ../src/guestfs.pod:370
759 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
760 msgstr ""
761
762 # type: textblock
763 #: ../src/guestfs.pod:375
764 msgid ""
765 "For SELinux guests, you may need to enable SELinux and load policy first.  "
766 "See L</SELINUX> in this manpage."
767 msgstr ""
768
769 # type: textblock
770 #: ../src/guestfs.pod:380
771 msgid ""
772 "The two main API calls to run commands are L</guestfs_command> and "
773 "L</guestfs_sh> (there are also variations)."
774 msgstr ""
775
776 # type: textblock
777 #: ../src/guestfs.pod:383
778 msgid ""
779 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
780 "shell globs, redirections, etc will work."
781 msgstr ""
782
783 # type: =head2
784 #: ../src/guestfs.pod:386
785 msgid "CONFIGURATION FILES"
786 msgstr ""
787
788 # type: textblock
789 #: ../src/guestfs.pod:388
790 msgid ""
791 "To read and write configuration files in Linux guest filesystems, we "
792 "strongly recommend using Augeas.  For example, Augeas understands how to "
793 "read and write, say, a Linux shadow password file or X.org configuration "
794 "file, and so avoids you having to write that code."
795 msgstr ""
796
797 # type: textblock
798 #: ../src/guestfs.pod:393
799 msgid ""
800 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs.  We don't "
801 "document Augeas itself here because there is excellent documentation on the "
802 "L<http://augeas.net/> website."
803 msgstr ""
804
805 # type: textblock
806 #: ../src/guestfs.pod:397
807 msgid ""
808 "If you don't want to use Augeas (you fool!) then try calling "
809 "L</guestfs_read_lines> to get the file as a list of lines which you can "
810 "iterate over."
811 msgstr ""
812
813 # type: =head2
814 #: ../src/guestfs.pod:401
815 msgid "SELINUX"
816 msgstr ""
817
818 # type: textblock
819 #: ../src/guestfs.pod:403
820 msgid ""
821 "We support SELinux guests.  To ensure that labeling happens correctly in "
822 "SELinux guests, you need to enable SELinux and load the guest's policy:"
823 msgstr ""
824
825 # type: =item
826 #: ../src/guestfs.pod:409
827 msgid "1."
828 msgstr ""
829
830 # type: textblock
831 #: ../src/guestfs.pod:411
832 msgid "Before launching, do:"
833 msgstr ""
834
835 # type: verbatim
836 #: ../src/guestfs.pod:413
837 #, no-wrap
838 msgid ""
839 " guestfs_set_selinux (g, 1);\n"
840 "\n"
841 msgstr ""
842
843 # type: =item
844 #: ../src/guestfs.pod:415
845 msgid "2."
846 msgstr ""
847
848 # type: textblock
849 #: ../src/guestfs.pod:417
850 msgid ""
851 "After mounting the guest's filesystem(s), load the policy.  This is best "
852 "done by running the L<load_policy(8)> command in the guest itself:"
853 msgstr ""
854
855 # type: verbatim
856 #: ../src/guestfs.pod:421
857 #, no-wrap
858 msgid ""
859 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
860 "\n"
861 msgstr ""
862
863 # type: textblock
864 #: ../src/guestfs.pod:423
865 msgid ""
866 "(Older versions of C<load_policy> require you to specify the name of the "
867 "policy file)."
868 msgstr ""
869
870 # type: =item
871 #: ../src/guestfs.pod:426
872 msgid "3."
873 msgstr ""
874
875 # type: textblock
876 #: ../src/guestfs.pod:428
877 msgid ""
878 "Optionally, set the security context for the API.  The correct security "
879 "context to use can only be known by inspecting the guest.  As an example:"
880 msgstr ""
881
882 # type: verbatim
883 #: ../src/guestfs.pod:432
884 #, no-wrap
885 msgid ""
886 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
887 "\n"
888 msgstr ""
889
890 # type: textblock
891 #: ../src/guestfs.pod:436
892 msgid "This will work for running commands and editing existing files."
893 msgstr ""
894
895 # type: textblock
896 #: ../src/guestfs.pod:438
897 msgid ""
898 "When new files are created, you may need to label them explicitly, for "
899 "example by running the external command C<restorecon pathname>."
900 msgstr ""
901
902 # type: =head2
903 #: ../src/guestfs.pod:442
904 msgid "UMASK"
905 msgstr ""
906
907 # type: textblock
908 #: ../src/guestfs.pod:444
909 msgid ""
910 "Certain calls are affected by the current file mode creation mask (the "
911 "\"umask\").  In particular ones which create files or directories, such as "
912 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>.  This affects "
913 "either the default mode that the file is created with or modifies the mode "
914 "that you supply."
915 msgstr ""
916
917 # type: textblock
918 #: ../src/guestfs.pod:450
919 msgid ""
920 "The default umask is C<022>, so files are created with modes such as C<0644> "
921 "and directories with C<0755>."
922 msgstr ""
923
924 # type: textblock
925 #: ../src/guestfs.pod:453
926 msgid ""
927 "There are two ways to avoid being affected by umask.  Either set umask to 0 "
928 "(call C<guestfs_umask (g, 0)> early after launching).  Or call "
929 "L</guestfs_chmod> after creating each file or directory."
930 msgstr ""
931
932 # type: textblock
933 #: ../src/guestfs.pod:457
934 msgid "For more information about umask, see L<umask(2)>."
935 msgstr ""
936
937 # type: =head1
938 #: ../src/guestfs.pod:459 ../fish/guestfish.pod:589
939 msgid "ENCRYPTED DISKS"
940 msgstr ""
941
942 # type: textblock
943 #: ../src/guestfs.pod:461
944 msgid ""
945 "Libguestfs allows you to access Linux guests which have been encrypted using "
946 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
947 "standard.  This includes nearly all whole disk encryption systems used by "
948 "modern Linux guests."
949 msgstr ""
950
951 # type: textblock
952 #: ../src/guestfs.pod:467
953 msgid ""
954 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
955 "returns the string C<crypto_LUKS>)."
956 msgstr ""
957
958 # type: textblock
959 #: ../src/guestfs.pod:470
960 msgid ""
961 "Then open these devices by calling L</guestfs_luks_open>.  Obviously you "
962 "will require the passphrase!"
963 msgstr ""
964
965 # type: textblock
966 #: ../src/guestfs.pod:473
967 msgid ""
968 "Opening a LUKS device creates a new device mapper device called "
969 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
970 "L</guestfs_luks_open>).  Reads and writes to this mapper device are "
971 "decrypted from and encrypted to the underlying block device respectively."
972 msgstr ""
973
974 # type: textblock
975 #: ../src/guestfs.pod:479
976 msgid ""
977 "LVM volume groups on the device can be made visible by calling "
978 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>.  The logical "
979 "volume(s) can now be mounted in the usual way."
980 msgstr ""
981
982 # type: textblock
983 #: ../src/guestfs.pod:483
984 msgid ""
985 "Use the reverse process to close a LUKS device.  Unmount any logical volumes "
986 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
987 "[\"/dev/VG\"])>.  Then close the mapper device by calling "
988 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
989 "underlying encrypted block device)."
990 msgstr ""
991
992 # type: =head2
993 #: ../src/guestfs.pod:490
994 msgid "INSPECTION"
995 msgstr ""
996
997 # type: textblock
998 #: ../src/guestfs.pod:492
999 msgid ""
1000 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1001 "contains operating systems.  (These APIs used to be in a separate Perl-only "
1002 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1003 "frequently used part of this library has been rewritten in C and moved into "
1004 "the core code)."
1005 msgstr ""
1006
1007 # type: textblock
1008 #: ../src/guestfs.pod:498
1009 msgid ""
1010 "Add all disks belonging to the unknown virtual machine and call "
1011 "L</guestfs_launch> in the usual way."
1012 msgstr ""
1013
1014 # type: textblock
1015 #: ../src/guestfs.pod:501
1016 msgid ""
1017 "Then call L</guestfs_inspect_os>.  This function uses other libguestfs calls "
1018 "and certain heuristics, and returns a list of operating systems that were "
1019 "found.  An empty list means none were found.  A single element is the root "
1020 "filesystem of the operating system.  For dual- or multi-boot guests, "
1021 "multiple roots can be returned, each one corresponding to a separate "
1022 "operating system.  (Multi-boot virtual machines are extremely rare in the "
1023 "world of virtualization, but since this scenario can happen, we have built "
1024 "libguestfs to deal with it.)"
1025 msgstr ""
1026
1027 # type: textblock
1028 #: ../src/guestfs.pod:510
1029 msgid ""
1030 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1031 "to get additional details about that operating system.  For example, call "
1032 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1033 "Windows and Linux-based operating systems respectively."
1034 msgstr ""
1035
1036 # type: textblock
1037 #: ../src/guestfs.pod:516
1038 msgid ""
1039 "Un*x-like and Linux-based operating systems usually consist of several "
1040 "filesystems which are mounted at boot time (for example, a separate boot "
1041 "partition mounted on C</boot>).  The inspection rules are able to detect how "
1042 "filesystems correspond to mount points.  Call "
1043 "C<guestfs_inspect_get_mountpoints> to get this mapping.  It might return a "
1044 "hash table like this example:"
1045 msgstr ""
1046
1047 # type: verbatim
1048 #: ../src/guestfs.pod:523
1049 #, no-wrap
1050 msgid ""
1051 " /boot => /dev/sda1\n"
1052 " /     => /dev/vg_guest/lv_root\n"
1053 " /usr  => /dev/vg_guest/lv_usr\n"
1054 "\n"
1055 msgstr ""
1056
1057 # type: textblock
1058 #: ../src/guestfs.pod:527
1059 msgid ""
1060 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1061 "filesystems as suggested."
1062 msgstr ""
1063
1064 # type: textblock
1065 #: ../src/guestfs.pod:530
1066 msgid ""
1067 "Be careful to mount filesystems in the right order (eg. C</> before "
1068 "C</usr>).  Sorting the keys of the hash by length, shortest first, should "
1069 "work."
1070 msgstr ""
1071
1072 # type: textblock
1073 #: ../src/guestfs.pod:534
1074 msgid ""
1075 "Inspection currently only works for some common operating systems.  "
1076 "Contributors are welcome to send patches for other operating systems that we "
1077 "currently cannot detect."
1078 msgstr ""
1079
1080 # type: textblock
1081 #: ../src/guestfs.pod:538
1082 msgid ""
1083 "Encrypted disks must be opened before inspection.  See L</ENCRYPTED DISKS> "
1084 "for more details.  The L</guestfs_inspect_os> function just ignores any "
1085 "encrypted devices."
1086 msgstr ""
1087
1088 # type: textblock
1089 #: ../src/guestfs.pod:542
1090 msgid ""
1091 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1092 "inspection and caches the results in the guest handle.  Subsequent calls to "
1093 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
1094 "re-read the disks.  If you change the content of the guest disks, you can "
1095 "redo inspection by calling L</guestfs_inspect_os> again."
1096 msgstr ""
1097
1098 # type: =head2
1099 #: ../src/guestfs.pod:549
1100 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1101 msgstr ""
1102
1103 # type: textblock
1104 #: ../src/guestfs.pod:551
1105 msgid ""
1106 "Libguestfs can mount NTFS partitions.  It does this using the "
1107 "L<http://www.ntfs-3g.org/> driver."
1108 msgstr ""
1109
1110 # type: textblock
1111 #: ../src/guestfs.pod:554
1112 msgid ""
1113 "DOS and Windows still use drive letters, and the filesystems are always "
1114 "treated as case insensitive by Windows itself, and therefore you might find "
1115 "a Windows configuration file referring to a path like "
1116 "C<c:\\windows\\system32>.  When the filesystem is mounted in libguestfs, "
1117 "that directory might be referred to as C</WINDOWS/System32>."
1118 msgstr ""
1119
1120 # type: textblock
1121 #: ../src/guestfs.pod:560
1122 msgid ""
1123 "Drive letter mappings are outside the scope of libguestfs.  You have to use "
1124 "libguestfs to read the appropriate Windows Registry and configuration files, "
1125 "to determine yourself how drives are mapped (see also L<hivex(3)> and "
1126 "L<virt-inspector(1)>)."
1127 msgstr ""
1128
1129 # type: textblock
1130 #: ../src/guestfs.pod:565
1131 msgid ""
1132 "Replacing backslash characters with forward slash characters is also outside "
1133 "the scope of libguestfs, but something that you can easily do."
1134 msgstr ""
1135
1136 # type: textblock
1137 #: ../src/guestfs.pod:568
1138 msgid ""
1139 "Where we can help is in resolving the case insensitivity of paths.  For "
1140 "this, call L</guestfs_case_sensitive_path>."
1141 msgstr ""
1142
1143 # type: textblock
1144 #: ../src/guestfs.pod:571
1145 msgid ""
1146 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1147 "files, through the library C<hivex> which is part of the libguestfs project "
1148 "although ships as a separate tarball.  You have to locate and download the "
1149 "hive file(s) yourself, and then pass them to C<hivex> functions.  See also "
1150 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
1151 "L<virt-win-reg(1)> for more help on this issue."
1152 msgstr ""
1153
1154 # type: =head2
1155 #: ../src/guestfs.pod:579
1156 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1157 msgstr ""
1158
1159 # type: textblock
1160 #: ../src/guestfs.pod:581
1161 msgid ""
1162 "Although we don't want to discourage you from using the C API, we will "
1163 "mention here that the same API is also available in other languages."
1164 msgstr ""
1165
1166 # type: textblock
1167 #: ../src/guestfs.pod:584
1168 msgid ""
1169 "The API is broadly identical in all supported languages.  This means that "
1170 "the C call C<guestfs_mount(g,path)> is C<$g-E<gt>mount($path)> in Perl, "
1171 "C<g.mount(path)> in Python, and C<Guestfs.mount g path> in OCaml.  In other "
1172 "words, a straightforward, predictable isomorphism between each language."
1173 msgstr ""
1174
1175 # type: textblock
1176 #: ../src/guestfs.pod:590
1177 msgid ""
1178 "Error messages are automatically transformed into exceptions if the language "
1179 "supports it."
1180 msgstr ""
1181
1182 # type: textblock
1183 #: ../src/guestfs.pod:593
1184 msgid ""
1185 "We don't try to \"object orientify\" parts of the API in OO languages, "
1186 "although contributors are welcome to write higher level APIs above what we "
1187 "provide in their favourite languages if they wish."
1188 msgstr ""
1189
1190 # type: =item
1191 #: ../src/guestfs.pod:599
1192 msgid "B<C++>"
1193 msgstr ""
1194
1195 # type: textblock
1196 #: ../src/guestfs.pod:601
1197 msgid ""
1198 "You can use the I<guestfs.h> header file from C++ programs.  The C++ API is "
1199 "identical to the C API.  C++ classes and exceptions are not used."
1200 msgstr ""
1201
1202 # type: =item
1203 #: ../src/guestfs.pod:605
1204 msgid "B<C#>"
1205 msgstr ""
1206
1207 # type: textblock
1208 #: ../src/guestfs.pod:607
1209 msgid ""
1210 "The C# bindings are highly experimental.  Please read the warnings at the "
1211 "top of C<csharp/Libguestfs.cs>."
1212 msgstr ""
1213
1214 # type: =item
1215 #: ../src/guestfs.pod:610
1216 msgid "B<Haskell>"
1217 msgstr ""
1218
1219 # type: textblock
1220 #: ../src/guestfs.pod:612
1221 msgid ""
1222 "This is the only language binding that is working but incomplete.  Only "
1223 "calls which return simple integers have been bound in Haskell, and we are "
1224 "looking for help to complete this binding."
1225 msgstr ""
1226
1227 # type: =item
1228 #: ../src/guestfs.pod:616
1229 msgid "B<Java>"
1230 msgstr ""
1231
1232 # type: textblock
1233 #: ../src/guestfs.pod:618
1234 msgid ""
1235 "Full documentation is contained in the Javadoc which is distributed with "
1236 "libguestfs."
1237 msgstr ""
1238
1239 # type: =item
1240 #: ../src/guestfs.pod:621
1241 msgid "B<OCaml>"
1242 msgstr ""
1243
1244 # type: textblock
1245 #: ../src/guestfs.pod:623
1246 msgid "For documentation see the file C<guestfs.mli>."
1247 msgstr ""
1248
1249 # type: =item
1250 #: ../src/guestfs.pod:625
1251 msgid "B<Perl>"
1252 msgstr ""
1253
1254 # type: textblock
1255 #: ../src/guestfs.pod:627
1256 msgid "For documentation see L<Sys::Guestfs(3)>."
1257 msgstr ""
1258
1259 # type: =item
1260 #: ../src/guestfs.pod:629
1261 msgid "B<PHP>"
1262 msgstr ""
1263
1264 # type: textblock
1265 #: ../src/guestfs.pod:631
1266 msgid ""
1267 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1268 "the php-libguestfs package for your distribution."
1269 msgstr ""
1270
1271 # type: textblock
1272 #: ../src/guestfs.pod:634
1273 msgid "The PHP binding only works correctly on 64 bit machines."
1274 msgstr ""
1275
1276 # type: =item
1277 #: ../src/guestfs.pod:636
1278 msgid "B<Python>"
1279 msgstr ""
1280
1281 # type: textblock
1282 #: ../src/guestfs.pod:638
1283 msgid "For documentation do:"
1284 msgstr ""
1285
1286 # type: verbatim
1287 #: ../src/guestfs.pod:640
1288 #, no-wrap
1289 msgid ""
1290 " $ python\n"
1291 " >>> import guestfs\n"
1292 " >>> help (guestfs)\n"
1293 "\n"
1294 msgstr ""
1295
1296 # type: =item
1297 #: ../src/guestfs.pod:644
1298 msgid "B<Ruby>"
1299 msgstr ""
1300
1301 # type: textblock
1302 #: ../src/guestfs.pod:646
1303 msgid ""
1304 "Use the Guestfs module.  There is no Ruby-specific documentation, but you "
1305 "can find examples written in Ruby in the libguestfs source."
1306 msgstr ""
1307
1308 # type: =item
1309 #: ../src/guestfs.pod:649
1310 msgid "B<shell scripts>"
1311 msgstr ""
1312
1313 # type: textblock
1314 #: ../src/guestfs.pod:651
1315 msgid "For documentation see L<guestfish(1)>."
1316 msgstr ""
1317
1318 # type: =head2
1319 #: ../src/guestfs.pod:655
1320 msgid "LIBGUESTFS GOTCHAS"
1321 msgstr ""
1322
1323 # type: textblock
1324 #: ../src/guestfs.pod:657
1325 msgid ""
1326 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1327 "system [...] that works in the way it is documented but is counterintuitive "
1328 "and almost invites mistakes.\""
1329 msgstr ""
1330
1331 # type: textblock
1332 #: ../src/guestfs.pod:661
1333 msgid ""
1334 "Since we developed libguestfs and the associated tools, there are several "
1335 "things we would have designed differently, but are now stuck with for "
1336 "backwards compatibility or other reasons.  If there is ever a libguestfs 2.0 "
1337 "release, you can expect these to change.  Beware of them."
1338 msgstr ""
1339
1340 # type: =item
1341 #: ../src/guestfs.pod:669
1342 msgid "Autosync / forgetting to sync."
1343 msgstr ""
1344
1345 # type: textblock
1346 #: ../src/guestfs.pod:671
1347 msgid ""
1348 "When modifying a filesystem from C or another language, you B<must> unmount "
1349 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1350 "libguestfs handle.  You can also call:"
1351 msgstr ""
1352
1353 # type: verbatim
1354 #: ../src/guestfs.pod:675
1355 #, no-wrap
1356 msgid ""
1357 " guestfs_set_autosync (g, 1);\n"
1358 "\n"
1359 msgstr ""
1360
1361 # type: textblock
1362 #: ../src/guestfs.pod:677
1363 msgid ""
1364 "to have the unmount/sync done automatically for you when the handle 'g' is "
1365 "closed.  (This feature is called \"autosync\", L</guestfs_set_autosync> "
1366 "q.v.)"
1367 msgstr ""
1368
1369 # type: textblock
1370 #: ../src/guestfs.pod:681
1371 msgid ""
1372 "If you forget to do this, then it is entirely possible that your changes "
1373 "won't be written out, or will be partially written, or (very rarely) that "
1374 "you'll get disk corruption."
1375 msgstr ""
1376
1377 # type: textblock
1378 #: ../src/guestfs.pod:685
1379 msgid ""
1380 "Note that in L<guestfish(3)> autosync is the default.  So quick and dirty "
1381 "guestfish scripts that forget to sync will work just fine, which can make "
1382 "this very puzzling if you are trying to debug a problem."
1383 msgstr ""
1384
1385 # type: =item
1386 #: ../src/guestfs.pod:689
1387 msgid "Mount option C<-o sync> should not be the default."
1388 msgstr ""
1389
1390 # type: textblock
1391 #: ../src/guestfs.pod:691
1392 msgid ""
1393 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly.  "
1394 "However C<-o sync> does not add any reliability benefit, but does have a "
1395 "very large performance impact."
1396 msgstr ""
1397
1398 # type: textblock
1399 #: ../src/guestfs.pod:695
1400 msgid ""
1401 "The work around is to use L</guestfs_mount_options> and set the mount "
1402 "options that you actually want to use."
1403 msgstr ""
1404
1405 # type: =item
1406 #: ../src/guestfs.pod:698
1407 msgid "Read-only should be the default."
1408 msgstr ""
1409
1410 # type: textblock
1411 #: ../src/guestfs.pod:700
1412 msgid ""
1413 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1414 "specify I<--rw> if you want to make changes to the image."
1415 msgstr ""
1416
1417 # type: textblock
1418 #: ../src/guestfs.pod:703
1419 msgid "This would reduce the potential to corrupt live VM images."
1420 msgstr ""
1421
1422 # type: textblock
1423 #: ../src/guestfs.pod:705
1424 msgid ""
1425 "Note that many filesystems change the disk when you just mount and unmount, "
1426 "even if you didn't perform any writes.  You need to use "
1427 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
1428 msgstr ""
1429
1430 # type: =item
1431 #: ../src/guestfs.pod:709
1432 msgid "guestfish command line is hard to use."
1433 msgstr ""
1434
1435 # type: textblock
1436 #: ../src/guestfs.pod:711
1437 msgid ""
1438 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1439 "examination).  It tries to run a guestfish command C<disk.img> which doesn't "
1440 "exist, so it fails.  In earlier versions of guestfish the error message was "
1441 "also unintuitive, but we have corrected this since.  Like the Bourne shell, "
1442 "we should have used C<guestfish -c command> to run commands."
1443 msgstr ""
1444
1445 # type: =item
1446 #: ../src/guestfs.pod:718
1447 msgid "guestfish megabyte modifiers don't work right on all commands"
1448 msgstr ""
1449
1450 # type: textblock
1451 #: ../src/guestfs.pod:720
1452 msgid ""
1453 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1454 "other modifiers).  What guestfish actually does is to multiply the number "
1455 "part by the modifier part and pass the result to the C API.  However this "
1456 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1457 "expecting some other unit (eg. megabytes)."
1458 msgstr ""
1459
1460 # type: textblock
1461 #: ../src/guestfs.pod:727
1462 msgid "The most common is L</guestfs_lvcreate>.  The guestfish command:"
1463 msgstr ""
1464
1465 # type: verbatim
1466 #: ../src/guestfs.pod:729
1467 #, no-wrap
1468 msgid ""
1469 " lvcreate LV VG 100M\n"
1470 "\n"
1471 msgstr ""
1472
1473 # type: textblock
1474 #: ../src/guestfs.pod:731
1475 msgid ""
1476 "does not do what you might expect.  Instead because L</guestfs_lvcreate> is "
1477 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1478 "megabytes * megabytes) logical volume.  The error message you get from this "
1479 "is also a little obscure."
1480 msgstr ""
1481
1482 # type: textblock
1483 #: ../src/guestfs.pod:736
1484 msgid ""
1485 "This could be fixed in the generator by specially marking parameters and "
1486 "return values which take bytes or other units."
1487 msgstr ""
1488
1489 # type: =item
1490 #: ../src/guestfs.pod:739
1491 msgid "Library should return errno with error messages."
1492 msgstr ""
1493
1494 # type: textblock
1495 #: ../src/guestfs.pod:741
1496 msgid ""
1497 "It would be a nice-to-have to be able to get the original value of 'errno' "
1498 "from inside the appliance along error paths (where set).  Currently "
1499 "L<guestmount(1)> goes through hoops to try to reverse the error message "
1500 "string into an errno, see the function error() in fuse/guestmount.c."
1501 msgstr ""
1502
1503 # type: textblock
1504 #: ../src/guestfs.pod:747
1505 msgid ""
1506 "In libguestfs 1.5.4, the protocol was changed so that the Linux errno is "
1507 "sent back from the daemon."
1508 msgstr ""
1509
1510 # type: =item
1511 #: ../src/guestfs.pod:750
1512 msgid "Ambiguity between devices and paths"
1513 msgstr ""
1514
1515 # type: textblock
1516 #: ../src/guestfs.pod:752
1517 msgid ""
1518 "There is a subtle ambiguity in the API between a device name "
1519 "(eg. C</dev/sdb2>) and a similar pathname.  A file might just happen to be "
1520 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1521 msgstr ""
1522
1523 # type: textblock
1524 #: ../src/guestfs.pod:757
1525 msgid ""
1526 "In the current API we usually resolve this ambiguity by having two separate "
1527 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>.  "
1528 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1529 "detecting if the path supplied begins with C</dev/>."
1530 msgstr ""
1531
1532 # type: textblock
1533 #: ../src/guestfs.pod:763
1534 msgid ""
1535 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1536 "make paths/devices into structured names.  One way to do this would be to "
1537 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1538 "aspect of grub.  Another way would be to use a structured type, equivalent "
1539 "to this OCaml type:"
1540 msgstr ""
1541
1542 # type: verbatim
1543 #: ../src/guestfs.pod:769
1544 #, no-wrap
1545 msgid ""
1546 " type path = Path of string | Device of int | Partition of int * int\n"
1547 "\n"
1548 msgstr ""
1549
1550 # type: textblock
1551 #: ../src/guestfs.pod:771
1552 msgid "which would allow you to pass arguments like:"
1553 msgstr ""
1554
1555 # type: verbatim
1556 #: ../src/guestfs.pod:773
1557 #, no-wrap
1558 msgid ""
1559 " Path \"/foo/bar\"\n"
1560 " Device 1            (* /dev/sdb, or perhaps /dev/sda *)\n"
1561 " Partition (1, 2)    (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1562 " Path \"/dev/sdb2\"    (* not a device *)\n"
1563 "\n"
1564 msgstr ""
1565
1566 # type: textblock
1567 #: ../src/guestfs.pod:778
1568 msgid ""
1569 "As you can see there are still problems to resolve even with this "
1570 "representation.  Also consider how it might work in guestfish."
1571 msgstr ""
1572
1573 # type: =head2
1574 #: ../src/guestfs.pod:783
1575 msgid "PROTOCOL LIMITS"
1576 msgstr ""
1577
1578 # type: textblock
1579 #: ../src/guestfs.pod:785
1580 msgid ""
1581 "Internally libguestfs uses a message-based protocol to pass API calls and "
1582 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1583 "plenty more detail about this).  The maximum message size used by the "
1584 "protocol is slightly less than 4 MB.  For some API calls you may need to be "
1585 "aware of this limit.  The API calls which may be affected are individually "
1586 "documented, with a link back to this section of the documentation."
1587 msgstr ""
1588
1589 # type: textblock
1590 #: ../src/guestfs.pod:793
1591 msgid ""
1592 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1593 "a simple string.  Because this string is at some point internally encoded as "
1594 "a message, the maximum size that it can return is slightly under 4 MB.  If "
1595 "the requested file is larger than this then you will get an error."
1596 msgstr ""
1597
1598 # type: textblock
1599 #: ../src/guestfs.pod:799
1600 msgid ""
1601 "In order to transfer large files into and out of the guest filesystem, you "
1602 "need to use particular calls that support this.  The sections L</UPLOADING> "
1603 "and L</DOWNLOADING> document how to do this."
1604 msgstr ""
1605
1606 # type: textblock
1607 #: ../src/guestfs.pod:803
1608 msgid ""
1609 "You might also consider mounting the disk image using our FUSE filesystem "
1610 "support (L<guestmount(1)>)."
1611 msgstr ""
1612
1613 # type: =head2
1614 #: ../src/guestfs.pod:806
1615 msgid "KEYS AND PASSPHRASES"
1616 msgstr ""
1617
1618 # type: textblock
1619 #: ../src/guestfs.pod:808
1620 msgid ""
1621 "Certain libguestfs calls take a parameter that contains sensitive key "
1622 "material, passed in as a C string."
1623 msgstr ""
1624
1625 # type: textblock
1626 #: ../src/guestfs.pod:811
1627 msgid ""
1628 "In the future we would hope to change the libguestfs implementation so that "
1629 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1630 "swap.  However this is I<not> done at the moment, because of the complexity "
1631 "of such an implementation."
1632 msgstr ""
1633
1634 # type: textblock
1635 #: ../src/guestfs.pod:816
1636 msgid ""
1637 "Therefore you should be aware that any key parameter you pass to libguestfs "
1638 "might end up being written out to the swap partition.  If this is a concern, "
1639 "scrub the swap partition or don't use libguestfs on encrypted devices."
1640 msgstr ""
1641
1642 # type: =head1
1643 #: ../src/guestfs.pod:821
1644 msgid "CONNECTION MANAGEMENT"
1645 msgstr ""
1646
1647 # type: =head2
1648 #: ../src/guestfs.pod:823
1649 msgid "guestfs_h *"
1650 msgstr ""
1651
1652 # type: textblock
1653 #: ../src/guestfs.pod:825
1654 msgid ""
1655 "C<guestfs_h> is the opaque type representing a connection handle.  Create a "
1656 "handle by calling L</guestfs_create>.  Call L</guestfs_close> to free the "
1657 "handle and release all resources used."
1658 msgstr ""
1659
1660 # type: textblock
1661 #: ../src/guestfs.pod:829
1662 msgid ""
1663 "For information on using multiple handles and threads, see the section "
1664 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> below."
1665 msgstr ""
1666
1667 # type: =head2
1668 #: ../src/guestfs.pod:832
1669 msgid "guestfs_create"
1670 msgstr ""
1671
1672 # type: verbatim
1673 #: ../src/guestfs.pod:834
1674 #, no-wrap
1675 msgid ""
1676 " guestfs_h *guestfs_create (void);\n"
1677 "\n"
1678 msgstr ""
1679
1680 # type: textblock
1681 #: ../src/guestfs.pod:836
1682 msgid "Create a connection handle."
1683 msgstr ""
1684
1685 # type: textblock
1686 #: ../src/guestfs.pod:838
1687 msgid "You have to call L</guestfs_add_drive> on the handle at least once."
1688 msgstr ""
1689
1690 # type: textblock
1691 #: ../src/guestfs.pod:840
1692 msgid ""
1693 "This function returns a non-NULL pointer to a handle on success or NULL on "
1694 "error."
1695 msgstr ""
1696
1697 # type: textblock
1698 #: ../src/guestfs.pod:843
1699 msgid "After configuring the handle, you have to call L</guestfs_launch>."
1700 msgstr ""
1701
1702 # type: textblock
1703 #: ../src/guestfs.pod:845
1704 msgid ""
1705 "You may also want to configure error handling for the handle.  See L</ERROR "
1706 "HANDLING> section below."
1707 msgstr ""
1708
1709 # type: =head2
1710 #: ../src/guestfs.pod:848
1711 msgid "guestfs_close"
1712 msgstr ""
1713
1714 # type: verbatim
1715 #: ../src/guestfs.pod:850
1716 #, no-wrap
1717 msgid ""
1718 " void guestfs_close (guestfs_h *g);\n"
1719 "\n"
1720 msgstr ""
1721
1722 # type: textblock
1723 #: ../src/guestfs.pod:852
1724 msgid "This closes the connection handle and frees up all resources used."
1725 msgstr ""
1726
1727 # type: =head1
1728 #: ../src/guestfs.pod:854
1729 msgid "ERROR HANDLING"
1730 msgstr ""
1731
1732 # type: textblock
1733 #: ../src/guestfs.pod:856
1734 msgid ""
1735 "The convention in all functions that return C<int> is that they return C<-1> "
1736 "to indicate an error.  You can get additional information on errors by "
1737 "calling L</guestfs_last_error> and/or by setting up an error handler with "
1738 "L</guestfs_set_error_handler>."
1739 msgstr ""
1740
1741 # type: textblock
1742 #: ../src/guestfs.pod:861
1743 msgid "The default error handler prints the information string to C<stderr>."
1744 msgstr ""
1745
1746 # type: textblock
1747 #: ../src/guestfs.pod:863
1748 msgid ""
1749 "Out of memory errors are handled differently.  The default action is to call "
1750 "L<abort(3)>.  If this is undesirable, then you can set a handler using "
1751 "L</guestfs_set_out_of_memory_handler>."
1752 msgstr ""
1753
1754 # type: =head2
1755 #: ../src/guestfs.pod:867
1756 msgid "guestfs_last_error"
1757 msgstr ""
1758
1759 # type: verbatim
1760 #: ../src/guestfs.pod:869
1761 #, no-wrap
1762 msgid ""
1763 " const char *guestfs_last_error (guestfs_h *g);\n"
1764 "\n"
1765 msgstr ""
1766
1767 # type: textblock
1768 #: ../src/guestfs.pod:871
1769 msgid ""
1770 "This returns the last error message that happened on C<g>.  If there has not "
1771 "been an error since the handle was created, then this returns C<NULL>."
1772 msgstr ""
1773
1774 # type: textblock
1775 #: ../src/guestfs.pod:875
1776 msgid ""
1777 "The lifetime of the returned string is until the next error occurs, or "
1778 "L</guestfs_close> is called."
1779 msgstr ""
1780
1781 # type: textblock
1782 #: ../src/guestfs.pod:878
1783 msgid ""
1784 "The error string is not localized (ie. is always in English), because this "
1785 "makes searching for error messages in search engines give the largest number "
1786 "of results."
1787 msgstr ""
1788
1789 # type: =head2
1790 #: ../src/guestfs.pod:882
1791 msgid "guestfs_set_error_handler"
1792 msgstr ""
1793
1794 # type: verbatim
1795 #: ../src/guestfs.pod:884
1796 #, no-wrap
1797 msgid ""
1798 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
1799 "                                           void *opaque,\n"
1800 "                                           const char *msg);\n"
1801 " void guestfs_set_error_handler (guestfs_h *g,\n"
1802 "                                 guestfs_error_handler_cb cb,\n"
1803 "                                 void *opaque);\n"
1804 "\n"
1805 msgstr ""
1806
1807 # type: textblock
1808 #: ../src/guestfs.pod:891
1809 msgid ""
1810 "The callback C<cb> will be called if there is an error.  The parameters "
1811 "passed to the callback are an opaque data pointer and the error message "
1812 "string."
1813 msgstr ""
1814
1815 # type: textblock
1816 #: ../src/guestfs.pod:895
1817 msgid ""
1818 "Note that the message string C<msg> is freed as soon as the callback "
1819 "function returns, so if you want to stash it somewhere you must make your "
1820 "own copy."
1821 msgstr ""
1822
1823 # type: textblock
1824 #: ../src/guestfs.pod:899
1825 msgid "The default handler prints messages on C<stderr>."
1826 msgstr ""
1827
1828 # type: textblock
1829 #: ../src/guestfs.pod:901
1830 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
1831 msgstr ""
1832
1833 # type: =head2
1834 #: ../src/guestfs.pod:903
1835 msgid "guestfs_get_error_handler"
1836 msgstr ""
1837
1838 # type: verbatim
1839 #: ../src/guestfs.pod:905
1840 #, no-wrap
1841 msgid ""
1842 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
1843 "                                                     void **opaque_rtn);\n"
1844 "\n"
1845 msgstr ""
1846
1847 # type: textblock
1848 #: ../src/guestfs.pod:908
1849 msgid "Returns the current error handler callback."
1850 msgstr ""
1851
1852 # type: =head2
1853 #: ../src/guestfs.pod:910
1854 msgid "guestfs_set_out_of_memory_handler"
1855 msgstr ""
1856
1857 # type: verbatim
1858 #: ../src/guestfs.pod:912
1859 #, no-wrap
1860 msgid ""
1861 " typedef void (*guestfs_abort_cb) (void);\n"
1862 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
1863 "                                        guestfs_abort_cb);\n"
1864 "\n"
1865 msgstr ""
1866
1867 # type: textblock
1868 #: ../src/guestfs.pod:916
1869 msgid ""
1870 "The callback C<cb> will be called if there is an out of memory situation.  "
1871 "I<Note this callback must not return>."
1872 msgstr ""
1873
1874 # type: textblock
1875 #: ../src/guestfs.pod:919
1876 msgid "The default is to call L<abort(3)>."
1877 msgstr ""
1878
1879 # type: textblock
1880 #: ../src/guestfs.pod:921
1881 msgid "You cannot set C<cb> to C<NULL>.  You can't ignore out of memory situations."
1882 msgstr ""
1883
1884 # type: =head2
1885 #: ../src/guestfs.pod:924
1886 msgid "guestfs_get_out_of_memory_handler"
1887 msgstr ""
1888
1889 # type: verbatim
1890 #: ../src/guestfs.pod:926
1891 #, no-wrap
1892 msgid ""
1893 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
1894 "\n"
1895 msgstr ""
1896
1897 # type: textblock
1898 #: ../src/guestfs.pod:928
1899 msgid "This returns the current out of memory handler."
1900 msgstr ""
1901
1902 # type: =head1
1903 #: ../src/guestfs.pod:930
1904 msgid "PATH"
1905 msgstr ""
1906
1907 # type: textblock
1908 #: ../src/guestfs.pod:932
1909 msgid ""
1910 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
1911 "internal path."
1912 msgstr ""
1913
1914 # type: textblock
1915 #: ../src/guestfs.pod:935
1916 msgid ""
1917 "By default it looks for these in the directory C<$libdir/guestfs> "
1918 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1919 msgstr ""
1920
1921 # type: textblock
1922 #: ../src/guestfs.pod:938
1923 msgid ""
1924 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1925 "to change the directories that libguestfs will search in.  The value is a "
1926 "colon-separated list of paths.  The current directory is I<not> searched "
1927 "unless the path contains an empty element or C<.>.  For example "
1928 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1929 "then C</usr/lib/guestfs>."
1930 msgstr ""
1931
1932 # type: =head1
1933 #: ../src/guestfs.pod:945
1934 msgid "HIGH-LEVEL API ACTIONS"
1935 msgstr ""
1936
1937 # type: =head2
1938 #: ../src/guestfs.pod:947
1939 msgid "ABI GUARANTEE"
1940 msgstr ""
1941
1942 # type: textblock
1943 #: ../src/guestfs.pod:949
1944 msgid ""
1945 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
1946 "actions as outlined in this section.  Although we will deprecate some "
1947 "actions, for example if they get replaced by newer calls, we will keep the "
1948 "old actions forever.  This allows you the developer to program in confidence "
1949 "against the libguestfs API."
1950 msgstr ""
1951
1952 # type: textblock
1953 #: ../src/guestfs.pod:955 ../fish/guestfish.pod:819
1954 msgid "@ACTIONS@"
1955 msgstr ""
1956
1957 # type: =head1
1958 #: ../src/guestfs.pod:957
1959 msgid "STRUCTURES"
1960 msgstr ""
1961
1962 # type: textblock
1963 #: ../src/guestfs.pod:959
1964 msgid "@STRUCTS@"
1965 msgstr ""
1966
1967 # type: =head1
1968 #: ../src/guestfs.pod:961
1969 msgid "AVAILABILITY"
1970 msgstr ""
1971
1972 # type: =head2
1973 #: ../src/guestfs.pod:963
1974 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
1975 msgstr ""
1976
1977 # type: textblock
1978 #: ../src/guestfs.pod:965
1979 msgid ""
1980 "Using L</guestfs_available> you can test availability of the following "
1981 "groups of functions.  This test queries the appliance to see if the "
1982 "appliance you are currently using supports the functionality."
1983 msgstr ""
1984
1985 # type: textblock
1986 #: ../src/guestfs.pod:970
1987 msgid "@AVAILABILITY@"
1988 msgstr ""
1989
1990 # type: =head2
1991 #: ../src/guestfs.pod:972
1992 msgid "GUESTFISH supported COMMAND"
1993 msgstr ""
1994
1995 # type: textblock
1996 #: ../src/guestfs.pod:974
1997 msgid ""
1998 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
1999 "prints out the available groups and whether they are supported by this build "
2000 "of libguestfs.  Note however that you have to do C<run> first."
2001 msgstr ""
2002
2003 # type: =head2
2004 #: ../src/guestfs.pod:979
2005 msgid "SINGLE CALLS AT COMPILE TIME"
2006 msgstr ""
2007
2008 # type: textblock
2009 #: ../src/guestfs.pod:981
2010 msgid ""
2011 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2012 "function, such as:"
2013 msgstr ""
2014
2015 # type: verbatim
2016 #: ../src/guestfs.pod:984
2017 #, no-wrap
2018 msgid ""
2019 " #define LIBGUESTFS_HAVE_DD 1\n"
2020 "\n"
2021 msgstr ""
2022
2023 # type: textblock
2024 #: ../src/guestfs.pod:986
2025 msgid "if L</guestfs_dd> is available."
2026 msgstr ""
2027
2028 # type: textblock
2029 #: ../src/guestfs.pod:988
2030 msgid ""
2031 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2032 "function is available at compile time, we recommended using build tools such "
2033 "as autoconf or cmake.  For example in autotools you could use:"
2034 msgstr ""
2035
2036 # type: verbatim
2037 #: ../src/guestfs.pod:993
2038 #, no-wrap
2039 msgid ""
2040 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2041 " AC_CHECK_FUNCS([guestfs_dd])\n"
2042 "\n"
2043 msgstr ""
2044
2045 # type: textblock
2046 #: ../src/guestfs.pod:996
2047 msgid ""
2048 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2049 "in your program."
2050 msgstr ""
2051
2052 # type: =head2
2053 #: ../src/guestfs.pod:999
2054 msgid "SINGLE CALLS AT RUN TIME"
2055 msgstr ""
2056
2057 # type: textblock
2058 #: ../src/guestfs.pod:1001
2059 msgid ""
2060 "Testing at compile time doesn't guarantee that a function really exists in "
2061 "the library.  The reason is that you might be dynamically linked against a "
2062 "previous I<libguestfs.so> (dynamic library)  which doesn't have the call.  "
2063 "This situation unfortunately results in a segmentation fault, which is a "
2064 "shortcoming of the C dynamic linking system itself."
2065 msgstr ""
2066
2067 # type: textblock
2068 #: ../src/guestfs.pod:1008
2069 msgid ""
2070 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2071 "in this example program (note that you still need the compile time check as "
2072 "well):"
2073 msgstr ""
2074
2075 # type: verbatim
2076 #: ../src/guestfs.pod:1012
2077 #, no-wrap
2078 msgid ""
2079 " #include <stdio.h>\n"
2080 " #include <stdlib.h>\n"
2081 " #include <unistd.h>\n"
2082 " #include <dlfcn.h>\n"
2083 " #include <guestfs.h>\n"
2084 " \n"
2085 msgstr ""
2086
2087 # type: verbatim
2088 #: ../src/guestfs.pod:1018
2089 #, no-wrap
2090 msgid ""
2091 " main ()\n"
2092 " {\n"
2093 " #ifdef LIBGUESTFS_HAVE_DD\n"
2094 "   void *dl;\n"
2095 "   int has_function;\n"
2096 " \n"
2097 msgstr ""
2098
2099 # type: verbatim
2100 #: ../src/guestfs.pod:1024
2101 #, no-wrap
2102 msgid ""
2103 "   /* Test if the function guestfs_dd is really available. */\n"
2104 "   dl = dlopen (NULL, RTLD_LAZY);\n"
2105 "   if (!dl) {\n"
2106 "     fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2107 "     exit (EXIT_FAILURE);\n"
2108 "   }\n"
2109 "   has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2110 "   dlclose (dl);\n"
2111 " \n"
2112 msgstr ""
2113
2114 # type: verbatim
2115 #: ../src/guestfs.pod:1033
2116 #, no-wrap
2117 msgid ""
2118 "   if (!has_function)\n"
2119 "     printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2120 "   else {\n"
2121 "     printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2122 "     /* Now it's safe to call\n"
2123 "     guestfs_dd (g, \"foo\", \"bar\");\n"
2124 "     */\n"
2125 "   }\n"
2126 " #else\n"
2127 "   printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2128 " #endif\n"
2129 "  }\n"
2130 "\n"
2131 msgstr ""
2132
2133 # type: textblock
2134 #: ../src/guestfs.pod:1046
2135 msgid ""
2136 "You may think the above is an awful lot of hassle, and it is.  There are "
2137 "other ways outside of the C linking system to ensure that this kind of "
2138 "incompatibility never arises, such as using package versioning:"
2139 msgstr ""
2140
2141 # type: verbatim
2142 #: ../src/guestfs.pod:1051
2143 #, no-wrap
2144 msgid ""
2145 " Requires: libguestfs >= 1.0.80\n"
2146 "\n"
2147 msgstr ""
2148
2149 # type: =end
2150 #: ../src/guestfs.pod:1053 ../src/guestfs.pod:1058
2151 msgid "html"
2152 msgstr ""
2153
2154 # type: textblock
2155 #: ../src/guestfs.pod:1055
2156 msgid ""
2157 "<!-- old anchor for the next section --> <a "
2158 "name=\"state_machine_and_low_level_event_api\"/>"
2159 msgstr ""
2160
2161 # type: =head1
2162 #: ../src/guestfs.pod:1060
2163 msgid "ARCHITECTURE"
2164 msgstr ""
2165
2166 # type: textblock
2167 #: ../src/guestfs.pod:1062
2168 msgid ""
2169 "Internally, libguestfs is implemented by running an appliance (a special "
2170 "type of small virtual machine) using L<qemu(1)>.  Qemu runs as a child "
2171 "process of the main program."
2172 msgstr ""
2173
2174 # type: verbatim
2175 #: ../src/guestfs.pod:1066
2176 #, no-wrap
2177 msgid ""
2178 "  ___________________\n"
2179 " /                   \\\n"
2180 " | main program      |\n"
2181 " |                   |\n"
2182 " |                   |           child process / appliance\n"
2183 " |                   |           __________________________\n"
2184 " |                   |          / qemu                     \\\n"
2185 " +-------------------+   RPC    |      +-----------------+ |\n"
2186 " | libguestfs     <--------------------> guestfsd        | |\n"
2187 " |                   |          |      +-----------------+ |\n"
2188 " \\___________________/          |      | Linux kernel    | |\n"
2189 "                                |      +--^--------------+ |\n"
2190 "                                \\_________|________________/\n"
2191 "                                          |\n"
2192 "                                   _______v______\n"
2193 "                                  /              \\\n"
2194 "                                  | Device or    |\n"
2195 "                                  | disk image   |\n"
2196 "                                  \\______________/\n"
2197 "\n"
2198 msgstr ""
2199
2200 # type: textblock
2201 #: ../src/guestfs.pod:1086
2202 msgid ""
2203 "The library, linked to the main program, creates the child process and hence "
2204 "the appliance in the L</guestfs_launch> function."
2205 msgstr ""
2206
2207 # type: textblock
2208 #: ../src/guestfs.pod:1089
2209 msgid ""
2210 "Inside the appliance is a Linux kernel and a complete stack of userspace "
2211 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
2212 "L</guestfsd>.  The library talks to L</guestfsd> using remote procedure "
2213 "calls (RPC).  There is a mostly one-to-one correspondence between libguestfs "
2214 "API calls and RPC calls to the daemon.  Lastly the disk image(s) are "
2215 "attached to the qemu process which translates device access by the "
2216 "appliance's Linux kernel into accesses to the image."
2217 msgstr ""
2218
2219 # type: textblock
2220 #: ../src/guestfs.pod:1098
2221 msgid ""
2222 "A common misunderstanding is that the appliance \"is\" the virtual machine.  "
2223 "Although the disk image you are attached to might also be used by some "
2224 "virtual machine, libguestfs doesn't know or care about this.  (But you will "
2225 "care if both libguestfs's qemu process and your virtual machine are trying "
2226 "to update the disk image at the same time, since these usually results in "
2227 "massive disk corruption)."
2228 msgstr ""
2229
2230 # type: =head1
2231 #: ../src/guestfs.pod:1105
2232 msgid "STATE MACHINE"
2233 msgstr ""
2234
2235 # type: textblock
2236 #: ../src/guestfs.pod:1107
2237 msgid "libguestfs uses a state machine to model the child process:"
2238 msgstr ""
2239
2240 # type: verbatim
2241 #: ../src/guestfs.pod:1109
2242 #, no-wrap
2243 msgid ""
2244 "                         |\n"
2245 "                    guestfs_create\n"
2246 "                         |\n"
2247 "                         |\n"
2248 "                     ____V_____\n"
2249 "                    /          \\\n"
2250 "                    |  CONFIG  |\n"
2251 "                    \\__________/\n"
2252 "                     ^ ^   ^  \\\n"
2253 "                    /  |    \\  \\ guestfs_launch\n"
2254 "                   /   |    _\\__V______\n"
2255 "                  /    |   /           \\\n"
2256 "                 /     |   | LAUNCHING |\n"
2257 "                /      |   \\___________/\n"
2258 "               /       |       /\n"
2259 "              /        |  guestfs_launch\n"
2260 "             /         |     /\n"
2261 "    ______  /        __|____V\n"
2262 "   /      \\ ------> /        \\\n"
2263 "   | BUSY |         | READY  |\n"
2264 "   \\______/ <------ \\________/\n"
2265 "\n"
2266 msgstr ""
2267
2268 # type: textblock
2269 #: ../src/guestfs.pod:1131
2270 msgid ""
2271 "The normal transitions are (1) CONFIG (when the handle is created, but there "
2272 "is no child process), (2) LAUNCHING (when the child process is booting up), "
2273 "(3) alternating between READY and BUSY as commands are issued to, and "
2274 "carried out by, the child process."
2275 msgstr ""
2276
2277 # type: textblock
2278 #: ../src/guestfs.pod:1136
2279 msgid ""
2280 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
2281 "asynchronously at any time (eg. due to some internal error), and that causes "
2282 "the state to transition back to CONFIG."
2283 msgstr ""
2284
2285 # type: textblock
2286 #: ../src/guestfs.pod:1140
2287 msgid ""
2288 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
2289 "issued when in the CONFIG state."
2290 msgstr ""
2291
2292 # type: textblock
2293 #: ../src/guestfs.pod:1143
2294 msgid ""
2295 "The API offers one call that goes from CONFIG through LAUNCHING to READY.  "
2296 "L</guestfs_launch> blocks until the child process is READY to accept "
2297 "commands (or until some failure or timeout).  L</guestfs_launch> internally "
2298 "moves the state from CONFIG to LAUNCHING while it is running."
2299 msgstr ""
2300
2301 # type: textblock
2302 #: ../src/guestfs.pod:1149
2303 msgid ""
2304 "API actions such as L</guestfs_mount> can only be issued when in the READY "
2305 "state.  These API calls block waiting for the command to be carried out "
2306 "(ie. the state to transition to BUSY and then back to READY).  There are no "
2307 "non-blocking versions, and no way to issue more than one command per handle "
2308 "at the same time."
2309 msgstr ""
2310
2311 # type: textblock
2312 #: ../src/guestfs.pod:1155
2313 msgid ""
2314 "Finally, the child process sends asynchronous messages back to the main "
2315 "program, such as kernel log messages.  You can register a callback to "
2316 "receive these messages."
2317 msgstr ""
2318
2319 # type: =head2
2320 #: ../src/guestfs.pod:1159
2321 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
2322 msgstr ""
2323
2324 # type: textblock
2325 #: ../src/guestfs.pod:1161
2326 msgid ""
2327 "The child process generates events in some situations.  Current events "
2328 "include: receiving a log message, the child process exits."
2329 msgstr ""
2330
2331 # type: textblock
2332 #: ../src/guestfs.pod:1164
2333 msgid ""
2334 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
2335 "types of events."
2336 msgstr ""
2337
2338 # type: textblock
2339 #: ../src/guestfs.pod:1167
2340 msgid ""
2341 "Only I<one callback of each type> can be registered for each handle.  "
2342 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
2343 "that type.  Cancel all callbacks of this type by calling this function with "
2344 "C<cb> set to C<NULL>."
2345 msgstr ""
2346
2347 # type: =head2
2348 #: ../src/guestfs.pod:1172
2349 msgid "guestfs_set_log_message_callback"
2350 msgstr ""
2351
2352 # type: verbatim
2353 #: ../src/guestfs.pod:1174
2354 #, no-wrap
2355 msgid ""
2356 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
2357 "                                         char *buf, int len);\n"
2358 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
2359 "                                        guestfs_log_message_cb cb,\n"
2360 "                                        void *opaque);\n"
2361 "\n"
2362 msgstr ""
2363
2364 # type: textblock
2365 #: ../src/guestfs.pod:1180
2366 msgid ""
2367 "The callback function C<cb> will be called whenever qemu or the guest writes "
2368 "anything to the console."
2369 msgstr ""
2370
2371 # type: textblock
2372 #: ../src/guestfs.pod:1183
2373 msgid "Use this function to capture kernel messages and similar."
2374 msgstr ""
2375
2376 # type: textblock
2377 #: ../src/guestfs.pod:1185
2378 msgid ""
2379 "Normally there is no log message handler, and log messages are just "
2380 "discarded."
2381 msgstr ""
2382
2383 # type: =head2
2384 #: ../src/guestfs.pod:1188
2385 msgid "guestfs_set_subprocess_quit_callback"
2386 msgstr ""
2387
2388 # type: verbatim
2389 #: ../src/guestfs.pod:1190
2390 #, no-wrap
2391 msgid ""
2392 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
2393 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
2394 "                                            guestfs_subprocess_quit_cb cb,\n"
2395 "                                            void *opaque);\n"
2396 "\n"
2397 msgstr ""
2398
2399 # type: textblock
2400 #: ../src/guestfs.pod:1195
2401 msgid ""
2402 "The callback function C<cb> will be called when the child process quits, "
2403 "either asynchronously or if killed by L</guestfs_kill_subprocess>.  (This "
2404 "corresponds to a transition from any state to the CONFIG state)."
2405 msgstr ""
2406
2407 # type: =head2
2408 #: ../src/guestfs.pod:1200
2409 msgid "guestfs_set_launch_done_callback"
2410 msgstr ""
2411
2412 # type: verbatim
2413 #: ../src/guestfs.pod:1202
2414 #, no-wrap
2415 msgid ""
2416 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
2417 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
2418 "                                        guestfs_launch_done_cb cb,\n"
2419 "                                        void *opaque);\n"
2420 "\n"
2421 msgstr ""
2422
2423 # type: textblock
2424 #: ../src/guestfs.pod:1207
2425 msgid ""
2426 "The callback function C<cb> will be called when the child process becomes "
2427 "ready first time after it has been launched.  (This corresponds to a "
2428 "transition from LAUNCHING to the READY state)."
2429 msgstr ""
2430
2431 # type: =head2
2432 #: ../src/guestfs.pod:1211
2433 msgid "guestfs_set_close_callback"
2434 msgstr ""
2435
2436 # type: verbatim
2437 #: ../src/guestfs.pod:1213
2438 #, no-wrap
2439 msgid ""
2440 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
2441 " void guestfs_set_close_callback (guestfs_h *g,\n"
2442 "                                  guestfs_close_cb cb,\n"
2443 "                                  void *opaque);\n"
2444 "\n"
2445 msgstr ""
2446
2447 # type: textblock
2448 #: ../src/guestfs.pod:1218
2449 msgid ""
2450 "The callback function C<cb> will be called while the handle is being closed "
2451 "(synchronously from L</guestfs_close>)."
2452 msgstr ""
2453
2454 # type: textblock
2455 #: ../src/guestfs.pod:1221
2456 msgid ""
2457 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
2458 "handles that are open when the program exits.  This means that this callback "
2459 "might be called indirectly from L<exit(3)>, which can cause unexpected "
2460 "problems in higher-level languages (eg. if your HLL interpreter has already "
2461 "been cleaned up by the time this is called, and if your callback then jumps "
2462 "into some HLL function)."
2463 msgstr ""
2464
2465 # type: =head2
2466 #: ../src/guestfs.pod:1229
2467 msgid "guestfs_set_progress_callback"
2468 msgstr ""
2469
2470 # type: verbatim
2471 #: ../src/guestfs.pod:1231
2472 #, no-wrap
2473 msgid ""
2474 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
2475 "                                      int proc_nr, int serial,\n"
2476 "                                      uint64_t position, uint64_t total);\n"
2477 " void guestfs_set_progress_callback (guestfs_h *g,\n"
2478 "                                     guestfs_progress_cb cb,\n"
2479 "                                     void *opaque);\n"
2480 "\n"
2481 msgstr ""
2482
2483 # type: textblock
2484 #: ../src/guestfs.pod:1238
2485 msgid ""
2486 "Some long-running operations can generate progress messages.  If this "
2487 "callback is registered, then it will be called each time a progress message "
2488 "is generated (usually two seconds after the operation started, and three "
2489 "times per second thereafter until it completes, although the frequency may "
2490 "change in future versions)."
2491 msgstr ""
2492
2493 # type: textblock
2494 #: ../src/guestfs.pod:1244
2495 msgid ""
2496 "The callback receives two numbers: C<position> and C<total>.  The units of "
2497 "C<total> are not defined, although for some operations C<total> may relate "
2498 "in some way to the amount of data to be transferred (eg. in bytes or "
2499 "megabytes), and C<position> may be the portion which has been transferred."
2500 msgstr ""
2501
2502 # type: textblock
2503 #: ../src/guestfs.pod:1250
2504 msgid "The only defined and stable parts of the API are:"
2505 msgstr ""
2506
2507 # type: textblock
2508 #: ../src/guestfs.pod:1256
2509 msgid ""
2510 "The callback can display to the user some type of progress bar or indicator "
2511 "which shows the ratio of C<position>:C<total>."
2512 msgstr ""
2513
2514 # type: textblock
2515 #: ../src/guestfs.pod:1261
2516 msgid "0 E<lt>= C<position> E<lt>= C<total>"
2517 msgstr ""
2518
2519 # type: textblock
2520 #: ../src/guestfs.pod:1265
2521 msgid ""
2522 "If any progress notification is sent during a call, then a final progress "
2523 "notification is always sent when C<position> = C<total>."
2524 msgstr ""
2525
2526 # type: textblock
2527 #: ../src/guestfs.pod:1268
2528 msgid ""
2529 "This is to simplify caller code, so callers can easily set the progress "
2530 "indicator to \"100%\" at the end of the operation, without requiring special "
2531 "code to detect this case."
2532 msgstr ""
2533
2534 # type: textblock
2535 #: ../src/guestfs.pod:1274
2536 msgid ""
2537 "The callback also receives the procedure number and serial number of the "
2538 "call.  These are only useful for debugging protocol issues, and the callback "
2539 "can normally ignore them.  The callback may want to print these numbers in "
2540 "error messages or debugging messages."
2541 msgstr ""
2542
2543 # type: =head1
2544 #: ../src/guestfs.pod:1279
2545 msgid "PRIVATE DATA AREA"
2546 msgstr ""
2547
2548 # type: textblock
2549 #: ../src/guestfs.pod:1281
2550 msgid ""
2551 "You can attach named pieces of private data to the libguestfs handle, and "
2552 "fetch them by name for the lifetime of the handle.  This is called the "
2553 "private data area and is only available from the C API."
2554 msgstr ""
2555
2556 # type: textblock
2557 #: ../src/guestfs.pod:1285
2558 msgid "To attach a named piece of data, use the following call:"
2559 msgstr ""
2560
2561 # type: verbatim
2562 #: ../src/guestfs.pod:1287
2563 #, no-wrap
2564 msgid ""
2565 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
2566 "\n"
2567 msgstr ""
2568
2569 # type: textblock
2570 #: ../src/guestfs.pod:1289
2571 msgid ""
2572 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
2573 "pointer (which can be C<NULL>).  Any previous item with the same name is "
2574 "overwritten."
2575 msgstr ""
2576
2577 # type: textblock
2578 #: ../src/guestfs.pod:1293
2579 msgid ""
2580 "You can use any C<key> you want, but names beginning with an underscore "
2581 "character are reserved for internal libguestfs purposes (for implementing "
2582 "language bindings).  It is recommended to prefix the name with some unique "
2583 "string to avoid collisions with other users."
2584 msgstr ""
2585
2586 # type: textblock
2587 #: ../src/guestfs.pod:1298
2588 msgid "To retrieve the pointer, use:"
2589 msgstr ""
2590
2591 # type: verbatim
2592 #: ../src/guestfs.pod:1300
2593 #, no-wrap
2594 msgid ""
2595 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
2596 "\n"
2597 msgstr ""
2598
2599 # type: textblock
2600 #: ../src/guestfs.pod:1302
2601 msgid ""
2602 "This function returns C<NULL> if either no data is found associated with "
2603 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
2604 "C<NULL>."
2605 msgstr ""
2606
2607 # type: textblock
2608 #: ../src/guestfs.pod:1306
2609 msgid ""
2610 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
2611 "way.  As far as libguestfs is concerned, it need not be a valid pointer at "
2612 "all.  In particular, libguestfs does I<not> try to free the data when the "
2613 "handle is closed.  If the data must be freed, then the caller must either "
2614 "free it before calling L</guestfs_close> or must set up a close callback to "
2615 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
2616 "can be registered for a handle)."
2617 msgstr ""
2618
2619 # type: textblock
2620 #: ../src/guestfs.pod:1314
2621 msgid ""
2622 "The private data area is implemented using a hash table, and should be "
2623 "reasonably efficient for moderate numbers of keys."
2624 msgstr ""
2625
2626 # type: =head1
2627 #: ../src/guestfs.pod:1317
2628 msgid "BLOCK DEVICE NAMING"
2629 msgstr ""
2630
2631 # type: textblock
2632 #: ../src/guestfs.pod:1319
2633 msgid ""
2634 "In the kernel there is now quite a profusion of schemata for naming block "
2635 "devices (in this context, by I<block device> I mean a physical or virtual "
2636 "hard drive).  The original Linux IDE driver used names starting with "
2637 "C</dev/hd*>.  SCSI devices have historically used a different naming scheme, "
2638 "C</dev/sd*>.  When the Linux kernel I<libata> driver became a popular "
2639 "replacement for the old IDE driver (particularly for SATA devices) those "
2640 "devices also used the C</dev/sd*> scheme.  Additionally we now have virtual "
2641 "machines with paravirtualized drivers.  This has created several different "
2642 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
2643 "Xen PV disks."
2644 msgstr ""
2645
2646 # type: textblock
2647 #: ../src/guestfs.pod:1331
2648 msgid ""
2649 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2650 "Linux kernel to access block devices.  We can run a variety of appliances "
2651 "based on a variety of Linux kernels."
2652 msgstr ""
2653
2654 # type: textblock
2655 #: ../src/guestfs.pod:1335
2656 msgid ""
2657 "This causes a problem for libguestfs because many API calls use device or "
2658 "partition names.  Working scripts and the recipe (example) scripts that we "
2659 "make available over the internet could fail if the naming scheme changes."
2660 msgstr ""
2661
2662 # type: textblock
2663 #: ../src/guestfs.pod:1340
2664 msgid ""
2665 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>.  "
2666 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2667 "required.  For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2668 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2669 msgstr ""
2670
2671 # type: textblock
2672 #: ../src/guestfs.pod:1346
2673 msgid ""
2674 "Note that this I<only> applies to parameters.  The L</guestfs_list_devices>, "
2675 "L</guestfs_list_partitions> and similar calls return the true names of the "
2676 "devices and partitions as known to the appliance."
2677 msgstr ""
2678
2679 # type: =head2
2680 #: ../src/guestfs.pod:1351
2681 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2682 msgstr ""
2683
2684 # type: textblock
2685 #: ../src/guestfs.pod:1353
2686 msgid ""
2687 "Usually this translation is transparent.  However in some (very rare)  cases "
2688 "you may need to know the exact algorithm.  Such cases include where you use "
2689 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
2690 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
2691 "devices."
2692 msgstr ""
2693
2694 # type: textblock
2695 #: ../src/guestfs.pod:1359
2696 msgid ""
2697 "The algorithm is applied only to I<parameters> which are known to be either "
2698 "device or partition names.  Return values from functions such as "
2699 "L</guestfs_list_devices> are never changed."
2700 msgstr ""
2701
2702 # type: textblock
2703 #: ../src/guestfs.pod:1367
2704 msgid "Is the string a parameter which is a device or partition name?"
2705 msgstr ""
2706
2707 # type: textblock
2708 #: ../src/guestfs.pod:1371
2709 msgid "Does the string begin with C</dev/sd>?"
2710 msgstr ""
2711
2712 # type: textblock
2713 #: ../src/guestfs.pod:1375
2714 msgid ""
2715 "Does the named device exist? If so, we use that device.  However if I<not> "
2716 "then we continue with this algorithm."
2717 msgstr ""
2718
2719 # type: textblock
2720 #: ../src/guestfs.pod:1380
2721 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2722 msgstr ""
2723
2724 # type: textblock
2725 #: ../src/guestfs.pod:1382
2726 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2727 msgstr ""
2728
2729 # type: textblock
2730 #: ../src/guestfs.pod:1384
2731 msgid "If that named device exists, use it.  If not, continue."
2732 msgstr ""
2733
2734 # type: textblock
2735 #: ../src/guestfs.pod:1388
2736 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2737 msgstr ""
2738
2739 # type: textblock
2740 #: ../src/guestfs.pod:1390
2741 msgid "If that named device exists, use it.  If not, return an error."
2742 msgstr ""
2743
2744 # type: =head2
2745 #: ../src/guestfs.pod:1394
2746 msgid "PORTABILITY CONCERNS"
2747 msgstr ""
2748
2749 # type: textblock
2750 #: ../src/guestfs.pod:1396
2751 msgid ""
2752 "Although the standard naming scheme and automatic translation is useful for "
2753 "simple programs and guestfish scripts, for larger programs it is best not to "
2754 "rely on this mechanism."
2755 msgstr ""
2756
2757 # type: textblock
2758 #: ../src/guestfs.pod:1400
2759 msgid ""
2760 "Where possible for maximum future portability programs using libguestfs "
2761 "should use these future-proof techniques:"
2762 msgstr ""
2763
2764 # type: textblock
2765 #: ../src/guestfs.pod:1407
2766 msgid ""
2767 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2768 "device names, and then use those names directly."
2769 msgstr ""
2770
2771 # type: textblock
2772 #: ../src/guestfs.pod:1410
2773 msgid "Since those device names exist by definition, they will never be translated."
2774 msgstr ""
2775
2776 # type: textblock
2777 #: ../src/guestfs.pod:1415
2778 msgid ""
2779 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2780 "filesystem labels."
2781 msgstr ""
2782
2783 # type: =head1
2784 #: ../src/guestfs.pod:1420
2785 msgid "INTERNALS"
2786 msgstr ""
2787
2788 # type: =head2
2789 #: ../src/guestfs.pod:1422
2790 msgid "COMMUNICATION PROTOCOL"
2791 msgstr ""
2792
2793 # type: textblock
2794 #: ../src/guestfs.pod:1424
2795 msgid ""
2796 "Don't rely on using this protocol directly.  This section documents how it "
2797 "currently works, but it may change at any time."
2798 msgstr ""
2799
2800 # type: textblock
2801 #: ../src/guestfs.pod:1427
2802 msgid ""
2803 "The protocol used to talk between the library and the daemon running inside "
2804 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
2805 "1014, RFC 1832, RFC 4506)."
2806 msgstr ""
2807
2808 # type: textblock
2809 #: ../src/guestfs.pod:1431
2810 msgid ""
2811 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
2812 "this file is automatically generated)."
2813 msgstr ""
2814
2815 # type: textblock
2816 #: ../src/guestfs.pod:1434
2817 msgid ""
2818 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
2819 "and C<FileOut> parameters, which are handled with very simple request/reply "
2820 "messages.  Then there are functions that have any C<FileIn> or C<FileOut> "
2821 "parameters, which use the same request and reply messages, but they may also "
2822 "be followed by files sent using a chunked encoding."
2823 msgstr ""
2824
2825 # type: =head3
2826 #: ../src/guestfs.pod:1441
2827 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
2828 msgstr ""
2829
2830 # type: textblock
2831 #: ../src/guestfs.pod:1443
2832 msgid "For ordinary functions, the request message is:"
2833 msgstr ""
2834
2835 # type: verbatim
2836 #: ../src/guestfs.pod:1445
2837 #, no-wrap
2838 msgid ""
2839 " total length (header + arguments,\n"
2840 "      but not including the length word itself)\n"
2841 " struct guestfs_message_header (encoded as XDR)\n"
2842 " struct guestfs_<foo>_args (encoded as XDR)\n"
2843 "\n"
2844 msgstr ""
2845
2846 # type: textblock
2847 #: ../src/guestfs.pod:1450
2848 msgid ""
2849 "The total length field allows the daemon to allocate a fixed size buffer "
2850 "into which it slurps the rest of the message.  As a result, the total length "
2851 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
2852 "effective size of any request is limited to somewhere under this size."
2853 msgstr ""
2854
2855 # type: textblock
2856 #: ../src/guestfs.pod:1456
2857 msgid ""
2858 "Note also that many functions don't take any arguments, in which case the "
2859 "C<guestfs_I<foo>_args> is completely omitted."
2860 msgstr ""
2861
2862 # type: textblock
2863 #: ../src/guestfs.pod:1459
2864 msgid ""
2865 "The header contains the procedure number (C<guestfs_proc>) which is how the "
2866 "receiver knows what type of args structure to expect, or none at all."
2867 msgstr ""
2868
2869 # type: textblock
2870 #: ../src/guestfs.pod:1463
2871 msgid "The reply message for ordinary functions is:"
2872 msgstr ""
2873
2874 # type: verbatim
2875 #: ../src/guestfs.pod:1465
2876 #, no-wrap
2877 msgid ""
2878 " total length (header + ret,\n"
2879 "      but not including the length word itself)\n"
2880 " struct guestfs_message_header (encoded as XDR)\n"
2881 " struct guestfs_<foo>_ret (encoded as XDR)\n"
2882 "\n"
2883 msgstr ""
2884
2885 # type: textblock
2886 #: ../src/guestfs.pod:1470
2887 msgid ""
2888 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
2889 "functions that return no formal return values."
2890 msgstr ""
2891
2892 # type: textblock
2893 #: ../src/guestfs.pod:1473
2894 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
2895 msgstr ""
2896
2897 # type: textblock
2898 #: ../src/guestfs.pod:1476
2899 msgid ""
2900 "In the case of an error, a flag is set in the header, and the reply message "
2901 "is slightly changed:"
2902 msgstr ""
2903
2904 # type: verbatim
2905 #: ../src/guestfs.pod:1479
2906 #, no-wrap
2907 msgid ""
2908 " total length (header + error,\n"
2909 "      but not including the length word itself)\n"
2910 " struct guestfs_message_header (encoded as XDR)\n"
2911 " struct guestfs_message_error (encoded as XDR)\n"
2912 "\n"
2913 msgstr ""
2914
2915 # type: textblock
2916 #: ../src/guestfs.pod:1484
2917 msgid ""
2918 "The C<guestfs_message_error> structure contains the error message as a "
2919 "string."
2920 msgstr ""
2921
2922 # type: =head3
2923 #: ../src/guestfs.pod:1487
2924 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
2925 msgstr ""
2926
2927 # type: textblock
2928 #: ../src/guestfs.pod:1489
2929 msgid ""
2930 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest.  "
2931 "The normal request message is sent (see above).  However this is followed by "
2932 "a sequence of file chunks."
2933 msgstr ""
2934
2935 # type: verbatim
2936 #: ../src/guestfs.pod:1493
2937 #, no-wrap
2938 msgid ""
2939 " total length (header + arguments,\n"
2940 "      but not including the length word itself,\n"
2941 "      and not including the chunks)\n"
2942 " struct guestfs_message_header (encoded as XDR)\n"
2943 " struct guestfs_<foo>_args (encoded as XDR)\n"
2944 " sequence of chunks for FileIn param #0\n"
2945 " sequence of chunks for FileIn param #1 etc.\n"
2946 "\n"
2947 msgstr ""
2948
2949 # type: textblock
2950 #: ../src/guestfs.pod:1501
2951 msgid "The \"sequence of chunks\" is:"
2952 msgstr ""
2953
2954 # type: verbatim
2955 #: ../src/guestfs.pod:1503
2956 #, no-wrap
2957 msgid ""
2958 " length of chunk (not including length word itself)\n"
2959 " struct guestfs_chunk (encoded as XDR)\n"
2960 " length of chunk\n"
2961 " struct guestfs_chunk (encoded as XDR)\n"
2962 "   ...\n"
2963 " length of chunk\n"
2964 " struct guestfs_chunk (with data.data_len == 0)\n"
2965 "\n"
2966 msgstr ""
2967
2968 # type: textblock
2969 #: ../src/guestfs.pod:1511
2970 msgid ""
2971 "The final chunk has the C<data_len> field set to zero.  Additionally a flag "
2972 "is set in the final chunk to indicate either successful completion or early "
2973 "cancellation."
2974 msgstr ""
2975
2976 # type: textblock
2977 #: ../src/guestfs.pod:1515
2978 msgid ""
2979 "At time of writing there are no functions that have more than one FileIn "
2980 "parameter.  However this is (theoretically) supported, by sending the "
2981 "sequence of chunks for each FileIn parameter one after another (from left to "
2982 "right)."
2983 msgstr ""
2984
2985 # type: textblock
2986 #: ../src/guestfs.pod:1520
2987 msgid ""
2988 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
2989 "transfer.  The library does this by sending a chunk with a special flag set "
2990 "to indicate cancellation.  When the daemon sees this, it cancels the whole "
2991 "RPC, does I<not> send any reply, and goes back to reading the next request."
2992 msgstr ""
2993
2994 # type: textblock
2995 #: ../src/guestfs.pod:1526
2996 msgid ""
2997 "The daemon may also cancel.  It does this by writing a special word "
2998 "C<GUESTFS_CANCEL_FLAG> to the socket.  The library listens for this during "
2999 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3000 "cancel chunk).  The special word is chosen so that even if cancellation "
3001 "happens right at the end of the transfer (after the library has finished "
3002 "writing and has started listening for the reply), the \"spurious\" cancel "
3003 "flag will not be confused with the reply message."
3004 msgstr ""
3005
3006 # type: textblock
3007 #: ../src/guestfs.pod:1535
3008 msgid ""
3009 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3010 "limit), and also files where the size is not known in advance (eg. from "
3011 "pipes or sockets).  However the chunks are rather small "
3012 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3013 "to keep much in memory."
3014 msgstr ""
3015
3016 # type: =head3
3017 #: ../src/guestfs.pod:1541
3018 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3019 msgstr ""
3020
3021 # type: textblock
3022 #: ../src/guestfs.pod:1543
3023 msgid ""
3024 "The protocol for FileOut parameters is exactly the same as for FileIn "
3025 "parameters, but with the roles of daemon and library reversed."
3026 msgstr ""
3027
3028 # type: verbatim
3029 #: ../src/guestfs.pod:1546
3030 #, no-wrap
3031 msgid ""
3032 " total length (header + ret,\n"
3033 "      but not including the length word itself,\n"
3034 "      and not including the chunks)\n"
3035 " struct guestfs_message_header (encoded as XDR)\n"
3036 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3037 " sequence of chunks for FileOut param #0\n"
3038 " sequence of chunks for FileOut param #1 etc.\n"
3039 "\n"
3040 msgstr ""
3041
3042 # type: =head3
3043 #: ../src/guestfs.pod:1554
3044 msgid "INITIAL MESSAGE"
3045 msgstr ""
3046
3047 # type: textblock
3048 #: ../src/guestfs.pod:1556
3049 msgid ""
3050 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3051 "which indicates that the guest and daemon is alive.  This is what "
3052 "L</guestfs_launch> waits for."
3053 msgstr ""
3054
3055 # type: =head3
3056 #: ../src/guestfs.pod:1560
3057 msgid "PROGRESS NOTIFICATION MESSAGES"
3058 msgstr ""
3059
3060 # type: textblock
3061 #: ../src/guestfs.pod:1562
3062 msgid ""
3063 "The daemon may send progress notification messages at any time.  These are "
3064 "distinguished by the normal length word being replaced by "
3065 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3066 msgstr ""
3067
3068 # type: textblock
3069 #: ../src/guestfs.pod:1566
3070 msgid ""
3071 "The library turns them into progress callbacks (see "
3072 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3073 "discards them if not."
3074 msgstr ""
3075
3076 # type: textblock
3077 #: ../src/guestfs.pod:1570
3078 msgid ""
3079 "The daemon self-limits the frequency of progress messages it sends (see "
3080 "C<daemon/proto.c:notify_progress>).  Not all calls generate progress "
3081 "messages."
3082 msgstr ""
3083
3084 # type: =head1
3085 #: ../src/guestfs.pod:1574
3086 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
3087 msgstr ""
3088
3089 # type: textblock
3090 #: ../src/guestfs.pod:1576
3091 msgid ""
3092 "All high-level libguestfs actions are synchronous.  If you want to use "
3093 "libguestfs asynchronously then you must create a thread."
3094 msgstr ""
3095
3096 # type: textblock
3097 #: ../src/guestfs.pod:1579
3098 msgid ""
3099 "Only use the handle from a single thread.  Either use the handle exclusively "
3100 "from one thread, or provide your own mutex so that two threads cannot issue "
3101 "calls on the same handle at the same time."
3102 msgstr ""
3103
3104 # type: textblock
3105 #: ../src/guestfs.pod:1583
3106 msgid ""
3107 "See the graphical program guestfs-browser for one possible architecture for "
3108 "multithreaded programs using libvirt and libguestfs."
3109 msgstr ""
3110
3111 # type: =head1
3112 #: ../src/guestfs.pod:1586
3113 msgid "QEMU WRAPPERS"
3114 msgstr ""
3115
3116 # type: textblock
3117 #: ../src/guestfs.pod:1588
3118 msgid ""
3119 "If you want to compile your own qemu, run qemu from a non-standard location, "
3120 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
3121 "around qemu."
3122 msgstr ""
3123
3124 # type: textblock
3125 #: ../src/guestfs.pod:1592
3126 msgid ""
3127 "There is one important rule to remember: you I<must C<exec qemu>> as the "
3128 "last command in the shell script (so that qemu replaces the shell and "
3129 "becomes the direct child of the libguestfs-using program).  If you don't do "
3130 "this, then the qemu process won't be cleaned up correctly."
3131 msgstr ""
3132
3133 # type: textblock
3134 #: ../src/guestfs.pod:1597
3135 msgid ""
3136 "Here is an example of a wrapper, where I have built my own copy of qemu from "
3137 "source:"
3138 msgstr ""
3139
3140 # type: verbatim
3141 #: ../src/guestfs.pod:1600
3142 #, no-wrap
3143 msgid ""
3144 " #!/bin/sh -\n"
3145 " qemudir=/home/rjones/d/qemu\n"
3146 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
3147 "\"$@\"\n"
3148 "\n"
3149 msgstr ""
3150
3151 # type: textblock
3152 #: ../src/guestfs.pod:1604
3153 msgid ""
3154 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
3155 "then use it by setting the LIBGUESTFS_QEMU environment variable.  For "
3156 "example:"
3157 msgstr ""
3158
3159 # type: verbatim
3160 #: ../src/guestfs.pod:1608
3161 #, no-wrap
3162 msgid ""
3163 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
3164 "\n"
3165 msgstr ""
3166
3167 # type: textblock
3168 #: ../src/guestfs.pod:1610
3169 msgid ""
3170 "Note that libguestfs also calls qemu with the -help and -version options in "
3171 "order to determine features."
3172 msgstr ""
3173
3174 # type: =head1
3175 #: ../src/guestfs.pod:1613
3176 msgid "LIBGUESTFS VERSION NUMBERS"
3177 msgstr ""
3178
3179 # type: textblock
3180 #: ../src/guestfs.pod:1615
3181 msgid ""
3182 "Since April 2010, libguestfs has started to make separate development and "
3183 "stable releases, along with corresponding branches in our git repository.  "
3184 "These separate releases can be identified by version number:"
3185 msgstr ""
3186
3187 # type: verbatim
3188 #: ../src/guestfs.pod:1620
3189 #, no-wrap
3190 msgid ""
3191 "                 even numbers for stable: 1.2.x, 1.4.x, ...\n"
3192 "       .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3193 "       |\n"
3194 "       v\n"
3195 " 1  .  3  .  5\n"
3196 " ^           ^\n"
3197 " |           |\n"
3198 " |           `-------- sub-version\n"
3199 " |\n"
3200 " `------ always '1' because we don't change the ABI\n"
3201 "\n"
3202 msgstr ""
3203
3204 # type: textblock
3205 #: ../src/guestfs.pod:1631
3206 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3207 msgstr ""
3208
3209 # type: textblock
3210 #: ../src/guestfs.pod:1633
3211 msgid ""
3212 "As time passes we cherry pick fixes from the development branch and backport "
3213 "those into the stable branch, the effect being that the stable branch should "
3214 "get more stable and less buggy over time.  So the stable releases are ideal "
3215 "for people who don't need new features but would just like the software to "
3216 "work."
3217 msgstr ""
3218
3219 # type: textblock
3220 #: ../src/guestfs.pod:1639
3221 msgid "Our criteria for backporting changes are:"
3222 msgstr ""
3223
3224 # type: textblock
3225 #: ../src/guestfs.pod:1645
3226 msgid ""
3227 "Documentation changes which don't affect any code are backported unless the "
3228 "documentation refers to a future feature which is not in stable."
3229 msgstr ""
3230
3231 # type: textblock
3232 #: ../src/guestfs.pod:1651
3233 msgid ""
3234 "Bug fixes which are not controversial, fix obvious problems, and have been "
3235 "well tested are backported."
3236 msgstr ""
3237
3238 # type: textblock
3239 #: ../src/guestfs.pod:1656
3240 msgid ""
3241 "Simple rearrangements of code which shouldn't affect how it works get "
3242 "backported.  This is so that the code in the two branches doesn't get too "
3243 "far out of step, allowing us to backport future fixes more easily."
3244 msgstr ""
3245
3246 # type: textblock
3247 #: ../src/guestfs.pod:1662
3248 msgid ""
3249 "We I<don't> backport new features, new APIs, new tools etc, except in one "
3250 "exceptional case: the new feature is required in order to implement an "
3251 "important bug fix."
3252 msgstr ""
3253
3254 # type: textblock
3255 #: ../src/guestfs.pod:1668
3256 msgid ""
3257 "A new stable branch starts when we think the new features in development are "
3258 "substantial and compelling enough over the current stable branch to warrant "
3259 "it.  When that happens we create new stable and development versions 1.N.0 "
3260 "and 1.(N+1).0 [N is even].  The new dot-oh release won't necessarily be so "
3261 "stable at this point, but by backporting fixes from development, that branch "
3262 "will stabilize over time."
3263 msgstr ""
3264
3265 # type: =head1
3266 #: ../src/guestfs.pod:1676 ../fish/guestfish.pod:826 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:312 ../tools/virt-rescue.pl:226
3267 msgid "ENVIRONMENT VARIABLES"
3268 msgstr ""
3269
3270 # type: =item
3271 #: ../src/guestfs.pod:1680 ../fish/guestfish.pod:852
3272 msgid "LIBGUESTFS_APPEND"
3273 msgstr ""
3274
3275 # type: textblock
3276 #: ../src/guestfs.pod:1682 ../fish/guestfish.pod:854
3277 msgid "Pass additional options to the guest kernel."
3278 msgstr ""
3279
3280 # type: =item
3281 #: ../src/guestfs.pod:1684 ../fish/guestfish.pod:856
3282 msgid "LIBGUESTFS_DEBUG"
3283 msgstr ""
3284
3285 # type: textblock
3286 #: ../src/guestfs.pod:1686
3287 msgid ""
3288 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages.  This has the same "
3289 "effect as calling C<guestfs_set_verbose (g, 1)>."
3290 msgstr ""
3291
3292 # type: =item
3293 #: ../src/guestfs.pod:1689 ../fish/guestfish.pod:861
3294 msgid "LIBGUESTFS_MEMSIZE"
3295 msgstr ""
3296
3297 # type: textblock
3298 #: ../src/guestfs.pod:1691 ../fish/guestfish.pod:863
3299 msgid "Set the memory allocated to the qemu process, in megabytes.  For example:"
3300 msgstr ""
3301
3302 # type: verbatim
3303 #: ../src/guestfs.pod:1694 ../fish/guestfish.pod:866
3304 #, no-wrap
3305 msgid ""
3306 " LIBGUESTFS_MEMSIZE=700\n"
3307 "\n"
3308 msgstr ""
3309
3310 # type: =item
3311 #: ../src/guestfs.pod:1696 ../fish/guestfish.pod:868
3312 msgid "LIBGUESTFS_PATH"
3313 msgstr ""
3314
3315 # type: textblock
3316 #: ../src/guestfs.pod:1698
3317 msgid ""
3318 "Set the path that libguestfs uses to search for kernel and initrd.img.  See "
3319 "the discussion of paths in section PATH above."
3320 msgstr ""
3321
3322 # type: =item
3323 #: ../src/guestfs.pod:1701 ../fish/guestfish.pod:873
3324 msgid "LIBGUESTFS_QEMU"
3325 msgstr ""
3326
3327 # type: textblock
3328 #: ../src/guestfs.pod:1703 ../fish/guestfish.pod:875
3329 msgid ""
3330 "Set the default qemu binary that libguestfs uses.  If not set, then the qemu "
3331 "which was found at compile time by the configure script is used."
3332 msgstr ""
3333
3334 # type: textblock
3335 #: ../src/guestfs.pod:1707
3336 msgid "See also L</QEMU WRAPPERS> above."
3337 msgstr ""
3338
3339 # type: =item
3340 #: ../src/guestfs.pod:1709 ../fish/guestfish.pod:879
3341 msgid "LIBGUESTFS_TRACE"
3342 msgstr ""
3343
3344 # type: textblock
3345 #: ../src/guestfs.pod:1711
3346 msgid ""
3347 "Set C<LIBGUESTFS_TRACE=1> to enable command traces.  This has the same "
3348 "effect as calling C<guestfs_set_trace (g, 1)>."
3349 msgstr ""
3350
3351 # type: =item
3352 #: ../src/guestfs.pod:1714 ../fish/guestfish.pod:888
3353 msgid "TMPDIR"
3354 msgstr ""
3355
3356 # type: textblock
3357 #: ../src/guestfs.pod:1716 ../fish/guestfish.pod:890
3358 msgid "Location of temporary directory, defaults to C</tmp>."
3359 msgstr ""
3360
3361 # type: textblock
3362 #: ../src/guestfs.pod:1718 ../fish/guestfish.pod:892
3363 msgid ""
3364 "If libguestfs was compiled to use the supermin appliance then the real "
3365 "appliance is cached in this directory, shared between all handles belonging "
3366 "to the same EUID.  You can use C<$TMPDIR> to configure another directory to "
3367 "use in case C</tmp> is not large enough."
3368 msgstr ""
3369
3370 # type: =head1
3371 #: ../src/guestfs.pod:1726 ../fish/guestfish.pod:950 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:178 ../inspector/virt-inspector.pl:846 ../tools/virt-edit.pl:325 ../tools/virt-win-reg.pl:461 ../tools/virt-df.pl:536 ../tools/virt-ls.pl:210 ../tools/virt-resize.pl:1399 ../tools/virt-list-filesystems.pl:191 ../tools/virt-cat.pl:163 ../tools/virt-tar.pl:257 ../tools/virt-rescue.pl:231 ../tools/virt-make-fs.pl:527 ../tools/virt-list-partitions.pl:229
3372 msgid "SEE ALSO"
3373 msgstr ""
3374
3375 # type: textblock
3376 #: ../src/guestfs.pod:1728
3377 msgid ""
3378 "L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
3379 "L<virt-edit(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
3380 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
3381 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
3382 "L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
3383 msgstr ""
3384
3385 # type: textblock
3386 #: ../src/guestfs.pod:1746
3387 msgid ""
3388 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
3389 "L<lvm(8)>, L<disktype(1)>."
3390 msgstr ""
3391
3392 # type: =head1
3393 #: ../src/guestfs.pod:1753 ../tools/virt-win-reg.pl:476 ../tools/virt-make-fs.pl:541
3394 msgid "BUGS"
3395 msgstr ""
3396
3397 # type: textblock
3398 #: ../src/guestfs.pod:1755
3399 msgid "To get a list of bugs against libguestfs use this link:"
3400 msgstr ""
3401
3402 # type: textblock
3403 #: ../src/guestfs.pod:1757
3404 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
3405 msgstr ""
3406
3407 # type: textblock
3408 #: ../src/guestfs.pod:1759
3409 msgid "To report a new bug against libguestfs use this link:"
3410 msgstr ""
3411
3412 # type: textblock
3413 #: ../src/guestfs.pod:1761
3414 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
3415 msgstr ""
3416
3417 # type: textblock
3418 #: ../src/guestfs.pod:1763
3419 msgid "When reporting a bug, please check:"
3420 msgstr ""
3421
3422 # type: textblock
3423 #: ../src/guestfs.pod:1769
3424 msgid "That the bug hasn't been reported already."
3425 msgstr ""
3426
3427 # type: textblock
3428 #: ../src/guestfs.pod:1773
3429 msgid "That you are testing a recent version."
3430 msgstr ""
3431
3432 # type: textblock
3433 #: ../src/guestfs.pod:1777
3434 msgid "Describe the bug accurately, and give a way to reproduce it."
3435 msgstr ""
3436
3437 # type: textblock
3438 #: ../src/guestfs.pod:1781
3439 msgid ""
3440 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
3441 "bug report."
3442 msgstr ""
3443
3444 # type: =head1
3445 #: ../src/guestfs.pod:1786 ../fish/guestfish.pod:967 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:189 ../inspector/virt-inspector.pl:855
3446 msgid "AUTHORS"
3447 msgstr ""
3448
3449 # type: textblock
3450 #: ../src/guestfs.pod:1788 ../fish/guestfish.pod:969 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:191
3451 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
3452 msgstr ""
3453
3454 # type: =head1
3455 #: ../src/guestfs.pod:1790 ../fish/guestfish.pod:971 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:193 ../inspector/virt-inspector.pl:861 ../tools/virt-edit.pl:341 ../tools/virt-win-reg.pl:491 ../tools/virt-df.pl:549 ../tools/virt-ls.pl:225 ../tools/virt-resize.pl:1420 ../tools/virt-list-filesystems.pl:207 ../tools/virt-cat.pl:177 ../tools/virt-tar.pl:272 ../tools/virt-rescue.pl:245 ../tools/virt-make-fs.pl:556 ../tools/virt-list-partitions.pl:244
3456 msgid "COPYRIGHT"
3457 msgstr ""
3458
3459 # type: textblock
3460 #: ../src/guestfs.pod:1792 ../fish/guestfish.pod:973
3461 msgid "Copyright (C) 2009-2010 Red Hat Inc.  L<http://libguestfs.org/>"
3462 msgstr ""
3463
3464 # type: textblock
3465 #: ../src/guestfs.pod:1795
3466 msgid ""
3467 "This library is free software; you can redistribute it and/or modify it "
3468 "under the terms of the GNU Lesser General Public License as published by the "
3469 "Free Software Foundation; either version 2 of the License, or (at your "
3470 "option) any later version."
3471 msgstr ""
3472
3473 # type: textblock
3474 #: ../src/guestfs.pod:1800
3475 msgid ""
3476 "This library is distributed in the hope that it will be useful, but WITHOUT "
3477 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
3478 "FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License "
3479 "for more details."
3480 msgstr ""
3481
3482 # type: textblock
3483 #: ../src/guestfs.pod:1805
3484 msgid ""
3485 "You should have received a copy of the GNU Lesser General Public License "
3486 "along with this library; if not, write to the Free Software Foundation, "
3487 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
3488 msgstr ""
3489
3490 # type: =head2
3491 #: ../src/guestfs-actions.pod:1
3492 msgid "guestfs_add_cdrom"
3493 msgstr ""
3494
3495 # type: verbatim
3496 #: ../src/guestfs-actions.pod:3
3497 #, no-wrap
3498 msgid ""
3499 " int guestfs_add_cdrom (guestfs_h *g,\n"
3500 "\t\tconst char *filename);\n"
3501 "\n"
3502 msgstr ""
3503
3504 # type: textblock
3505 #: ../src/guestfs-actions.pod:6 ../fish/guestfish-actions.pod:7
3506 msgid "This function adds a virtual CD-ROM disk image to the guest."
3507 msgstr ""
3508
3509 # type: textblock
3510 #: ../src/guestfs-actions.pod:8 ../fish/guestfish-actions.pod:9
3511 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
3512 msgstr ""
3513
3514 # type: textblock
3515 #: ../src/guestfs-actions.pod:10 ../src/guestfs-actions.pod:1516 ../fish/guestfish-actions.pod:11 ../fish/guestfish-actions.pod:1211
3516 msgid "Notes:"
3517 msgstr ""
3518
3519 # type: textblock
3520 #: ../src/guestfs-actions.pod:16
3521 msgid ""
3522 "This call checks for the existence of C<filename>.  This stops you from "
3523 "specifying other types of drive which are supported by qemu such as C<nbd:> "
3524 "and C<http:> URLs.  To specify those, use the general C<guestfs_config> call "
3525 "instead."
3526 msgstr ""
3527
3528 # type: textblock
3529 #: ../src/guestfs-actions.pod:23
3530 msgid ""
3531 "If you just want to add an ISO file (often you use this as an efficient way "
3532 "to transfer large files into the guest), then you should probably use "
3533 "C<guestfs_add_drive_ro> instead."
3534 msgstr ""
3535
3536 # type: textblock
3537 #: ../src/guestfs-actions.pod:29 ../src/guestfs-actions.pod:63 ../src/guestfs-actions.pod:92 ../src/guestfs-actions.pod:103 ../src/guestfs-actions.pod:114 ../src/guestfs-actions.pod:124 ../src/guestfs-actions.pod:135 ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:266 ../src/guestfs-actions.pod:302 ../src/guestfs-actions.pod:324 ../src/guestfs-actions.pod:339 ../src/guestfs-actions.pod:403 ../src/guestfs-actions.pod:430 ../src/guestfs-actions.pod:441 ../src/guestfs-actions.pod:453 ../src/guestfs-actions.pod:534 ../src/guestfs-actions.pod:549 ../src/guestfs-actions.pod:560 ../src/guestfs-actions.pod:571 ../src/guestfs-actions.pod:717 ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:824 ../src/guestfs-actions.pod:839 ../src/guestfs-actions.pod:855 ../src/guestfs-actions.pod:866 ../src/guestfs-actions.pod:883 ../src/guestfs-actions.pod:916 ../src/guestfs-actions.pod:974 ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:1024 ../src/guestfs-actions.pod:1055 ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1174 ../src/guestfs-actions.pod:1374 ../src/guestfs-actions.pod:1393 ../src/guestfs-actions.pod:1474 ../src/guestfs-actions.pod:1822 ../src/guestfs-actions.pod:1945 ../src/guestfs-actions.pod:2000 ../src/guestfs-actions.pod:2030 ../src/guestfs-actions.pod:2439 ../src/guestfs-actions.pod:2451 ../src/guestfs-actions.pod:2468 ../src/guestfs-actions.pod:2576 ../src/guestfs-actions.pod:2587 ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:2620 ../src/guestfs-actions.pod:2650 ../src/guestfs-actions.pod:2714 ../src/guestfs-actions.pod:2731 ../src/guestfs-actions.pod:2745 ../src/guestfs-actions.pod:2765 ../src/guestfs-actions.pod:2785 ../src/guestfs-actions.pod:2814 ../src/guestfs-actions.pod:2830 ../src/guestfs-actions.pod:2846 ../src/guestfs-actions.pod:2858 ../src/guestfs-actions.pod:2867 ../src/guestfs-actions.pod:2900 ../src/guestfs-actions.pod:2913 ../src/guestfs-actions.pod:2923 ../src/guestfs-actions.pod:2935 ../src/guestfs-actions.pod:2949 ../src/guestfs-actions.pod:3029 ../src/guestfs-actions.pod:3046 ../src/guestfs-actions.pod:3056 ../src/guestfs-actions.pod:3101 ../src/guestfs-actions.pod:3116 ../src/guestfs-actions.pod:3131 ../src/guestfs-actions.pod:3144 ../src/guestfs-actions.pod:3155 ../src/guestfs-actions.pod:3166 ../src/guestfs-actions.pod:3180 ../src/guestfs-actions.pod:3192 ../src/guestfs-actions.pod:3209 ../src/guestfs-actions.pod:3240 ../src/guestfs-actions.pod:3268 ../src/guestfs-actions.pod:3284 ../src/guestfs-actions.pod:3300 ../src/guestfs-actions.pod:3309 ../src/guestfs-actions.pod:3323 ../src/guestfs-actions.pod:3333 ../src/guestfs-actions.pod:3345 ../src/guestfs-actions.pod:3357 ../src/guestfs-actions.pod:3389 ../src/guestfs-actions.pod:3401 ../src/guestfs-actions.pod:3418 ../src/guestfs-actions.pod:3429 ../src/guestfs-actions.pod:3443 ../src/guestfs-actions.pod:3483 ../src/guestfs-actions.pod:3514 ../src/guestfs-actions.pod:3525 ../src/guestfs-actions.pod:3550 ../src/guestfs-actions.pod:3564 ../src/guestfs-actions.pod:3579 ../src/guestfs-actions.pod:3701 ../src/guestfs-actions.pod:3753 ../src/guestfs-actions.pod:3772 ../src/guestfs-actions.pod:3787 ../src/guestfs-actions.pod:3813 ../src/guestfs-actions.pod:3870 ../src/guestfs-actions.pod:3884 ../src/guestfs-actions.pod:3894 ../src/guestfs-actions.pod:3905 ../src/guestfs-actions.pod:4160 ../src/guestfs-actions.pod:4176 ../src/guestfs-actions.pod:4187 ../src/guestfs-actions.pod:4196 ../src/guestfs-actions.pod:4207 ../src/guestfs-actions.pod:4216 ../src/guestfs-actions.pod:4227 ../src/guestfs-actions.pod:4240 ../src/guestfs-actions.pod:4258 ../src/guestfs-actions.pod:4274 ../src/guestfs-actions.pod:4290 ../src/guestfs-actions.pod:4305 ../src/guestfs-actions.pod:4325 ../src/guestfs-actions.pod:4340 ../src/guestfs-actions.pod:4356 ../src/guestfs-actions.pod:4374 ../src/guestfs-actions.pod:4390 ../src/guestfs-actions.pod:4404 ../src/guestfs-actions.pod:4429 ../src/guestfs-actions.pod:4450 ../src/guestfs-actions.pod:4466 ../src/guestfs-actions.pod:4487 ../src/guestfs-actions.pod:4499 ../src/guestfs-actions.pod:4511 ../src/guestfs-actions.pod:4527 ../src/guestfs-actions.pod:4561 ../src/guestfs-actions.pod:4581 ../src/guestfs-actions.pod:4604 ../src/guestfs-actions.pod:4694 ../src/guestfs-actions.pod:4800 ../src/guestfs-actions.pod:4809 ../src/guestfs-actions.pod:4819 ../src/guestfs-actions.pod:4829 ../src/guestfs-actions.pod:4848 ../src/guestfs-actions.pod:4858 ../src/guestfs-actions.pod:4868 ../src/guestfs-actions.pod:4878 ../src/guestfs-actions.pod:4890 ../src/guestfs-actions.pod:4940 ../src/guestfs-actions.pod:4954 ../src/guestfs-actions.pod:4967 ../src/guestfs-actions.pod:4980 ../src/guestfs-actions.pod:4994 ../src/guestfs-actions.pod:5004 ../src/guestfs-actions.pod:5021 ../src/guestfs-actions.pod:5051 ../src/guestfs-actions.pod:5062 ../src/guestfs-actions.pod:5097 ../src/guestfs-actions.pod:5107 ../src/guestfs-actions.pod:5122 ../src/guestfs-actions.pod:5148 ../src/guestfs-actions.pod:5176 ../src/guestfs-actions.pod:5280 ../src/guestfs-actions.pod:5295 ../src/guestfs-actions.pod:5306 ../src/guestfs-actions.pod:5352 ../src/guestfs-actions.pod:5362 ../src/guestfs-actions.pod:5399 ../src/guestfs-actions.pod:5426 ../src/guestfs-actions.pod:5468 ../src/guestfs-actions.pod:5491 ../src/guestfs-actions.pod:5548 ../src/guestfs-actions.pod:5564 ../src/guestfs-actions.pod:5590
3538 msgid "This function returns 0 on success or -1 on error."
3539 msgstr ""
3540
3541 # type: =head2
3542 #: ../src/guestfs-actions.pod:31
3543 msgid "guestfs_add_drive"
3544 msgstr ""
3545
3546 # type: verbatim
3547 #: ../src/guestfs-actions.pod:33
3548 #, no-wrap
3549 msgid ""
3550 " int guestfs_add_drive (guestfs_h *g,\n"
3551 "\t\tconst char *filename);\n"
3552 "\n"
3553 msgstr ""
3554
3555 # type: textblock
3556 #: ../src/guestfs-actions.pod:36 ../fish/guestfish-actions.pod:36
3557 msgid ""
3558 "This function adds a virtual machine disk image C<filename> to the guest.  "
3559 "The first time you call this function, the disk appears as IDE disk 0 "
3560 "(C</dev/sda>) in the guest, the second time as C</dev/sdb>, and so on."
3561 msgstr ""
3562
3563 # type: textblock
3564 #: ../src/guestfs-actions.pod:41 ../fish/guestfish-actions.pod:41
3565 msgid ""
3566 "You don't necessarily need to be root when using libguestfs.  However you "
3567 "obviously do need sufficient permissions to access the filename for whatever "
3568 "operations you want to perform (ie. read access if you just want to read the "
3569 "image or write access if you want to modify the image)."
3570 msgstr ""
3571
3572 # type: textblock
3573 #: ../src/guestfs-actions.pod:47 ../fish/guestfish-actions.pod:47
3574 msgid ""
3575 "This is equivalent to the qemu parameter C<-drive "
3576 "file=filename,cache=off,if=...>."
3577 msgstr ""
3578
3579 # type: textblock
3580 #: ../src/guestfs-actions.pod:50 ../fish/guestfish-actions.pod:50
3581 msgid ""
3582 "C<cache=off> is omitted in cases where it is not supported by the underlying "
3583 "filesystem."
3584 msgstr ""
3585
3586 # type: textblock
3587 #: ../src/guestfs-actions.pod:53 ../src/guestfs-actions.pod:82
3588 msgid ""
3589 "C<if=...> is set at compile time by the configuration option C<./configure "
3590 "--with-drive-if=...>.  In the rare case where you might need to change this "
3591 "at run time, use C<guestfs_add_drive_with_if> or "
3592 "C<guestfs_add_drive_ro_with_if>."
3593 msgstr ""
3594
3595 # type: textblock
3596 #: ../src/guestfs-actions.pod:58 ../src/guestfs-actions.pod:87
3597 msgid ""
3598 "Note that this call checks for the existence of C<filename>.  This stops you "
3599 "from specifying other types of drive which are supported by qemu such as "
3600 "C<nbd:> and C<http:> URLs.  To specify those, use the general "
3601 "C<guestfs_config> call instead."
3602 msgstr ""
3603
3604 # type: =head2
3605 #: ../src/guestfs-actions.pod:65
3606 msgid "guestfs_add_drive_ro"
3607 msgstr ""
3608
3609 # type: verbatim
3610 #: ../src/guestfs-actions.pod:67
3611 #, no-wrap
3612 msgid ""
3613 " int guestfs_add_drive_ro (guestfs_h *g,\n"
3614 "\t\tconst char *filename);\n"
3615 "\n"
3616 msgstr ""
3617
3618 # type: textblock
3619 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:69
3620 msgid "This adds a drive in snapshot mode, making it effectively read-only."
3621 msgstr ""
3622
3623 # type: textblock
3624 #: ../src/guestfs-actions.pod:73 ../fish/guestfish-actions.pod:72
3625 msgid ""
3626 "Note that writes to the device are allowed, and will be seen for the "
3627 "duration of the guestfs handle, but they are written to a temporary file "
3628 "which is discarded as soon as the guestfs handle is closed.  We don't "
3629 "currently have any method to enable changes to be committed, although qemu "
3630 "can support this."
3631 msgstr ""
3632
3633 # type: textblock
3634 #: ../src/guestfs-actions.pod:79 ../fish/guestfish-actions.pod:78
3635 msgid ""
3636 "This is equivalent to the qemu parameter C<-drive "
3637 "file=filename,snapshot=on,if=...>."
3638 msgstr ""
3639
3640 # type: =head2
3641 #: ../src/guestfs-actions.pod:94
3642 msgid "guestfs_add_drive_ro_with_if"
3643 msgstr ""
3644
3645 # type: verbatim
3646 #: ../src/guestfs-actions.pod:96
3647 #, no-wrap
3648 msgid ""
3649 " int guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
3650 "\t\tconst char *filename,\n"
3651 "\t\tconst char *iface);\n"
3652 "\n"
3653 msgstr ""
3654
3655 # type: textblock
3656 #: ../src/guestfs-actions.pod:100
3657 msgid ""
3658 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
3659 "QEMU interface emulation to use at run time."
3660 msgstr ""
3661
3662 # type: =head2
3663 #: ../src/guestfs-actions.pod:105
3664 msgid "guestfs_add_drive_with_if"
3665 msgstr ""
3666
3667 # type: verbatim
3668 #: ../src/guestfs-actions.pod:107
3669 #, no-wrap
3670 msgid ""
3671 " int guestfs_add_drive_with_if (guestfs_h *g,\n"
3672 "\t\tconst char *filename,\n"
3673 "\t\tconst char *iface);\n"
3674 "\n"
3675 msgstr ""
3676
3677 # type: textblock
3678 #: ../src/guestfs-actions.pod:111
3679 msgid ""
3680 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
3681 "QEMU interface emulation to use at run time."
3682 msgstr ""
3683
3684 # type: =head2
3685 #: ../src/guestfs-actions.pod:116
3686 msgid "guestfs_aug_clear"
3687 msgstr ""
3688
3689 # type: verbatim
3690 #: ../src/guestfs-actions.pod:118
3691 #, no-wrap
3692 msgid ""
3693 " int guestfs_aug_clear (guestfs_h *g,\n"
3694 "\t\tconst char *augpath);\n"
3695 "\n"
3696 msgstr ""
3697
3698 # type: textblock
3699 #: ../src/guestfs-actions.pod:121 ../fish/guestfish-actions.pod:109
3700 msgid ""
3701 "Set the value associated with C<path> to C<NULL>.  This is the same as the "
3702 "L<augtool(1)> C<clear> command."
3703 msgstr ""
3704
3705 # type: =head2
3706 #: ../src/guestfs-actions.pod:126
3707 msgid "guestfs_aug_close"
3708 msgstr ""
3709
3710 # type: verbatim
3711 #: ../src/guestfs-actions.pod:128
3712 #, no-wrap
3713 msgid ""
3714 " int guestfs_aug_close (guestfs_h *g);\n"
3715 "\n"
3716 msgstr ""
3717
3718 # type: textblock
3719 #: ../src/guestfs-actions.pod:130
3720 msgid ""
3721 "Close the current Augeas handle and free up any resources used by it.  After "
3722 "calling this, you have to call C<guestfs_aug_init> again before you can use "
3723 "any other Augeas functions."
3724 msgstr ""
3725
3726 # type: =head2
3727 #: ../src/guestfs-actions.pod:137
3728 msgid "guestfs_aug_defnode"
3729 msgstr ""
3730
3731 # type: verbatim
3732 #: ../src/guestfs-actions.pod:139
3733 #, no-wrap
3734 msgid ""
3735 " struct guestfs_int_bool *guestfs_aug_defnode (guestfs_h *g,\n"
3736 "\t\tconst char *name,\n"
3737 "\t\tconst char *expr,\n"
3738 "\t\tconst char *val);\n"
3739 "\n"
3740 msgstr ""
3741
3742 # type: textblock
3743 #: ../src/guestfs-actions.pod:144 ../fish/guestfish-actions.pod:125
3744 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
3745 msgstr ""
3746
3747 # type: textblock
3748 #: ../src/guestfs-actions.pod:147
3749 msgid ""
3750 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
3751 "calling C<guestfs_aug_set> C<expr>, C<value>.  C<name> will be the nodeset "
3752 "containing that single node."
3753 msgstr ""
3754
3755 # type: textblock
3756 #: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:132
3757 msgid ""
3758 "On success this returns a pair containing the number of nodes in the "
3759 "nodeset, and a boolean flag if a node was created."
3760 msgstr ""
3761
3762 # type: textblock
3763 #: ../src/guestfs-actions.pod:155
3764 msgid ""
3765 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
3766 "an error.  I<The caller must call C<guestfs_free_int_bool> after use>."
3767 msgstr ""
3768
3769 # type: =head2
3770 #: ../src/guestfs-actions.pod:159
3771 msgid "guestfs_aug_defvar"
3772 msgstr ""
3773
3774 # type: verbatim
3775 #: ../src/guestfs-actions.pod:161
3776 #, no-wrap
3777 msgid ""
3778 " int guestfs_aug_defvar (guestfs_h *g,\n"
3779 "\t\tconst char *name,\n"
3780 "\t\tconst char *expr);\n"
3781 "\n"
3782 msgstr ""
3783
3784 # type: textblock
3785 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:140
3786 msgid ""
3787 "Defines an Augeas variable C<name> whose value is the result of evaluating "
3788 "C<expr>.  If C<expr> is NULL, then C<name> is undefined."
3789 msgstr ""
3790
3791 # type: textblock
3792 #: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:144
3793 msgid ""
3794 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
3795 "evaluates to something which is not a nodeset."
3796 msgstr ""
3797
3798 # type: textblock
3799 #: ../src/guestfs-actions.pod:172 ../src/guestfs-actions.pod:313 ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:492 ../src/guestfs-actions.pod:507 ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:1041 ../src/guestfs-actions.pod:1356 ../src/guestfs-actions.pod:1538 ../src/guestfs-actions.pod:1619 ../src/guestfs-actions.pod:1650 ../src/guestfs-actions.pod:1693 ../src/guestfs-actions.pod:1710 ../src/guestfs-actions.pod:1935 ../src/guestfs-actions.pod:2147 ../src/guestfs-actions.pod:2165 ../src/guestfs-actions.pod:3503 ../src/guestfs-actions.pod:3610 ../src/guestfs-actions.pod:3964 ../src/guestfs-actions.pod:3987 ../src/guestfs-actions.pod:5086 ../src/guestfs-actions.pod:5436 ../src/guestfs-actions.pod:5446 ../src/guestfs-actions.pod:5456
3800 msgid "On error this function returns -1."
3801 msgstr ""
3802
3803 # type: =head2
3804 #: ../src/guestfs-actions.pod:174
3805 msgid "guestfs_aug_get"
3806 msgstr ""
3807
3808 # type: verbatim
3809 #: ../src/guestfs-actions.pod:176
3810 #, no-wrap
3811 msgid ""
3812 " char *guestfs_aug_get (guestfs_h *g,\n"
3813 "\t\tconst char *augpath);\n"
3814 "\n"
3815 msgstr ""
3816
3817 # type: textblock
3818 #: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:151
3819 msgid ""
3820 "Look up the value associated with C<path>.  If C<path> matches exactly one "
3821 "node, the C<value> is returned."
3822 msgstr ""
3823
3824 # type: textblock
3825 #: ../src/guestfs-actions.pod:182 ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:695 ../src/guestfs-actions.pod:786 ../src/guestfs-actions.pod:899 ../src/guestfs-actions.pod:928 ../src/guestfs-actions.pod:942 ../src/guestfs-actions.pod:958 ../src/guestfs-actions.pod:1069 ../src/guestfs-actions.pod:1233 ../src/guestfs-actions.pod:1342 ../src/guestfs-actions.pod:1487 ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1577 ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1729 ../src/guestfs-actions.pod:1868 ../src/guestfs-actions.pod:2049 ../src/guestfs-actions.pod:2099 ../src/guestfs-actions.pod:2215 ../src/guestfs-actions.pod:2250 ../src/guestfs-actions.pod:2565 ../src/guestfs-actions.pod:2986 ../src/guestfs-actions.pod:3082 ../src/guestfs-actions.pod:3625 ../src/guestfs-actions.pod:3801 ../src/guestfs-actions.pod:3942 ../src/guestfs-actions.pod:4103 ../src/guestfs-actions.pod:4146 ../src/guestfs-actions.pod:4622 ../src/guestfs-actions.pod:4635 ../src/guestfs-actions.pod:4649&nb