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