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