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