blkid: Use -c /dev/null because RHEL 5 blkid doesn't have -p option.
[libguestfs.git] / generator / generator_actions.ml
1 (* libguestfs
2  * Copyright (C) 2009-2011 Red Hat Inc.
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  *)
18
19 (* Please read generator/README first. *)
20
21 (* Note about long descriptions: When referring to another
22  * action, use the format C<guestfs_other> (ie. the full name of
23  * the C function).  This will be replaced as appropriate in other
24  * language bindings.
25  *
26  * Apart from that, long descriptions are just perldoc paragraphs.
27  *)
28
29 open Generator_types
30 open Generator_utils
31
32 (* These test functions are used in the language binding tests. *)
33
34 let test_all_args = [
35   String "str";
36   OptString "optstr";
37   StringList "strlist";
38   Bool "b";
39   Int "integer";
40   Int64 "integer64";
41   FileIn "filein";
42   FileOut "fileout";
43   BufferIn "bufferin";
44 ]
45
46 let test_all_rets = [
47   (* except for RErr, which is tested thoroughly elsewhere *)
48   "test0rint",         RInt "valout";
49   "test0rint64",       RInt64 "valout";
50   "test0rbool",        RBool "valout";
51   "test0rconststring", RConstString "valout";
52   "test0rconstoptstring", RConstOptString "valout";
53   "test0rstring",      RString "valout";
54   "test0rstringlist",  RStringList "valout";
55   "test0rstruct",      RStruct ("valout", "lvm_pv");
56   "test0rstructlist",  RStructList ("valout", "lvm_pv");
57   "test0rhashtable",   RHashtable "valout";
58 ]
59
60 let test_functions = [
61   ("test0", (RErr, test_all_args, []), -1, [NotInFish; NotInDocs],
62    [],
63    "internal test function - do not use",
64    "\
65 This is an internal test function which is used to test whether
66 the automatically generated bindings can handle every possible
67 parameter type correctly.
68
69 It echos the contents of each parameter to stdout.
70
71 You probably don't want to call this function.");
72 ] @ List.flatten (
73   List.map (
74     fun (name, ret) ->
75       [(name, (ret, [String "val"], []), -1, [NotInFish; NotInDocs],
76         [],
77         "internal test function - do not use",
78         "\
79 This is an internal test function which is used to test whether
80 the automatically generated bindings can handle every possible
81 return type correctly.
82
83 It converts string C<val> to the return type.
84
85 You probably don't want to call this function.");
86        (name ^ "err", (ret, [], []), -1, [NotInFish; NotInDocs],
87         [],
88         "internal test function - do not use",
89         "\
90 This is an internal test function which is used to test whether
91 the automatically generated bindings can handle every possible
92 return type correctly.
93
94 This function always returns an error.
95
96 You probably don't want to call this function.")]
97   ) test_all_rets
98 )
99
100 (* non_daemon_functions are any functions which don't get processed
101  * in the daemon, eg. functions for setting and getting local
102  * configuration values.
103  *)
104
105 let non_daemon_functions = test_functions @ [
106   ("launch", (RErr, [], []), -1, [FishAlias "run"; Progress],
107    [],
108    "launch the qemu subprocess",
109    "\
110 Internally libguestfs is implemented by running a virtual machine
111 using L<qemu(1)>.
112
113 You should call this after configuring the handle
114 (eg. adding drives) but before performing any actions.");
115
116   ("wait_ready", (RErr, [], []), -1, [NotInFish; DeprecatedBy "launch"],
117    [],
118    "wait until the qemu subprocess launches (no op)",
119    "\
120 This function is a no op.
121
122 In versions of the API E<lt> 1.0.71 you had to call this function
123 just after calling C<guestfs_launch> to wait for the launch
124 to complete.  However this is no longer necessary because
125 C<guestfs_launch> now does the waiting.
126
127 If you see any calls to this function in code then you can just
128 remove them, unless you want to retain compatibility with older
129 versions of the API.");
130
131   ("kill_subprocess", (RErr, [], []), -1, [],
132    [],
133    "kill the qemu subprocess",
134    "\
135 This kills the qemu subprocess.  You should never need to call this.");
136
137   ("add_drive", (RErr, [String "filename"], []), -1, [],
138    [],
139    "add an image to examine or modify",
140    "\
141 This function is the equivalent of calling C<guestfs_add_drive_opts>
142 with no optional parameters, so the disk is added writable, with
143 the format being detected automatically.
144
145 Automatic detection of the format opens you up to a potential
146 security hole when dealing with untrusted raw-format images.
147 See CVE-2010-3851 and RHBZ#642934.  Specifying the format closes
148 this security hole.  Therefore you should think about replacing
149 calls to this function with calls to C<guestfs_add_drive_opts>,
150 and specifying the format.");
151
152   ("add_cdrom", (RErr, [String "filename"], []), -1, [DeprecatedBy "add_drive_opts"],
153    [],
154    "add a CD-ROM disk image to examine",
155    "\
156 This function adds a virtual CD-ROM disk image to the guest.
157
158 This is equivalent to the qemu parameter I<-cdrom filename>.
159
160 Notes:
161
162 =over 4
163
164 =item *
165
166 This call checks for the existence of C<filename>.  This
167 stops you from specifying other types of drive which are supported
168 by qemu such as C<nbd:> and C<http:> URLs.  To specify those, use
169 the general C<guestfs_config> call instead.
170
171 =item *
172
173 If you just want to add an ISO file (often you use this as an
174 efficient way to transfer large files into the guest), then you
175 should probably use C<guestfs_add_drive_ro> instead.
176
177 =back");
178
179   ("add_drive_ro", (RErr, [String "filename"], []), -1, [FishAlias "add-ro"],
180    [],
181    "add a drive in snapshot mode (read-only)",
182    "\
183 This function is the equivalent of calling C<guestfs_add_drive_opts>
184 with the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1,
185 so the disk is added read-only, with the format being detected
186 automatically.");
187
188   ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"], []), -1, [],
189    [],
190    "add qemu parameters",
191    "\
192 This can be used to add arbitrary qemu command line parameters
193 of the form I<-param value>.  Actually it's not quite arbitrary - we
194 prevent you from setting some parameters which would interfere with
195 parameters that we use.
196
197 The first character of C<param> string must be a C<-> (dash).
198
199 C<value> can be NULL.");
200
201   ("set_qemu", (RErr, [OptString "qemu"], []), -1, [FishAlias "qemu"],
202    [],
203    "set the qemu binary",
204    "\
205 Set the qemu binary that we will use.
206
207 The default is chosen when the library was compiled by the
208 configure script.
209
210 You can also override this by setting the C<LIBGUESTFS_QEMU>
211 environment variable.
212
213 Setting C<qemu> to C<NULL> restores the default qemu binary.
214
215 Note that you should call this function as early as possible
216 after creating the handle.  This is because some pre-launch
217 operations depend on testing qemu features (by running C<qemu -help>).
218 If the qemu binary changes, we don't retest features, and
219 so you might see inconsistent results.  Using the environment
220 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
221 the qemu binary at the same time as the handle is created.");
222
223   ("get_qemu", (RConstString "qemu", [], []), -1, [],
224    [InitNone, Always, TestRun (
225       [["get_qemu"]])],
226    "get the qemu binary",
227    "\
228 Return the current qemu binary.
229
230 This is always non-NULL.  If it wasn't set already, then this will
231 return the default qemu binary name.");
232
233   ("set_path", (RErr, [OptString "searchpath"], []), -1, [FishAlias "path"],
234    [],
235    "set the search path",
236    "\
237 Set the path that libguestfs searches for kernel and initrd.img.
238
239 The default is C<$libdir/guestfs> unless overridden by setting
240 C<LIBGUESTFS_PATH> environment variable.
241
242 Setting C<path> to C<NULL> restores the default path.");
243
244   ("get_path", (RConstString "path", [], []), -1, [],
245    [InitNone, Always, TestRun (
246       [["get_path"]])],
247    "get the search path",
248    "\
249 Return the current search path.
250
251 This is always non-NULL.  If it wasn't set already, then this will
252 return the default path.");
253
254   ("set_append", (RErr, [OptString "append"], []), -1, [FishAlias "append"],
255    [],
256    "add options to kernel command line",
257    "\
258 This function is used to add additional options to the
259 guest kernel command line.
260
261 The default is C<NULL> unless overridden by setting
262 C<LIBGUESTFS_APPEND> environment variable.
263
264 Setting C<append> to C<NULL> means I<no> additional options
265 are passed (libguestfs always adds a few of its own).");
266
267   ("get_append", (RConstOptString "append", [], []), -1, [],
268    (* This cannot be tested with the current framework.  The
269     * function can return NULL in normal operations, which the
270     * test framework interprets as an error.
271     *)
272    [],
273    "get the additional kernel options",
274    "\
275 Return the additional kernel options which are added to the
276 guest kernel command line.
277
278 If C<NULL> then no options are added.");
279
280   ("set_autosync", (RErr, [Bool "autosync"], []), -1, [FishAlias "autosync"],
281    [],
282    "set autosync mode",
283    "\
284 If C<autosync> is true, this enables autosync.  Libguestfs will make a
285 best effort attempt to make filesystems consistent and synchronized
286 when the handle is closed
287 (also if the program exits without closing handles).
288
289 This is enabled by default (since libguestfs 1.5.24, previously it was
290 disabled by default).");
291
292   ("get_autosync", (RBool "autosync", [], []), -1, [],
293    [InitNone, Always, TestOutputTrue (
294       [["get_autosync"]])],
295    "get autosync mode",
296    "\
297 Get the autosync flag.");
298
299   ("set_verbose", (RErr, [Bool "verbose"], []), -1, [FishAlias "verbose"],
300    [],
301    "set verbose mode",
302    "\
303 If C<verbose> is true, this turns on verbose messages.
304
305 Verbose messages are disabled unless the environment variable
306 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
307
308 Verbose messages are normally sent to C<stderr>, unless you
309 register a callback to send them somewhere else (see
310 C<guestfs_set_event_callback>).");
311
312   ("get_verbose", (RBool "verbose", [], []), -1, [],
313    [],
314    "get verbose mode",
315    "\
316 This returns the verbose messages flag.");
317
318   ("is_ready", (RBool "ready", [], []), -1, [],
319    [InitNone, Always, TestOutputTrue (
320       [["is_ready"]])],
321    "is ready to accept commands",
322    "\
323 This returns true iff this handle is ready to accept commands
324 (in the C<READY> state).
325
326 For more information on states, see L<guestfs(3)>.");
327
328   ("is_config", (RBool "config", [], []), -1, [],
329    [InitNone, Always, TestOutputFalse (
330       [["is_config"]])],
331    "is in configuration state",
332    "\
333 This returns true iff this handle is being configured
334 (in the C<CONFIG> state).
335
336 For more information on states, see L<guestfs(3)>.");
337
338   ("is_launching", (RBool "launching", [], []), -1, [],
339    [InitNone, Always, TestOutputFalse (
340       [["is_launching"]])],
341    "is launching subprocess",
342    "\
343 This returns true iff this handle is launching the subprocess
344 (in the C<LAUNCHING> state).
345
346 For more information on states, see L<guestfs(3)>.");
347
348   ("is_busy", (RBool "busy", [], []), -1, [],
349    [InitNone, Always, TestOutputFalse (
350       [["is_busy"]])],
351    "is busy processing a command",
352    "\
353 This returns true iff this handle is busy processing a command
354 (in the C<BUSY> state).
355
356 For more information on states, see L<guestfs(3)>.");
357
358   ("get_state", (RInt "state", [], []), -1, [],
359    [],
360    "get the current state",
361    "\
362 This returns the current state as an opaque integer.  This is
363 only useful for printing debug and internal error messages.
364
365 For more information on states, see L<guestfs(3)>.");
366
367   ("set_memsize", (RErr, [Int "memsize"], []), -1, [FishAlias "memsize"],
368    [InitNone, Always, TestOutputInt (
369       [["set_memsize"; "500"];
370        ["get_memsize"]], 500)],
371    "set memory allocated to the qemu subprocess",
372    "\
373 This sets the memory size in megabytes allocated to the
374 qemu subprocess.  This only has any effect if called before
375 C<guestfs_launch>.
376
377 You can also change this by setting the environment
378 variable C<LIBGUESTFS_MEMSIZE> before the handle is
379 created.
380
381 For more information on the architecture of libguestfs,
382 see L<guestfs(3)>.");
383
384   ("get_memsize", (RInt "memsize", [], []), -1, [],
385    [InitNone, Always, TestOutputIntOp (
386       [["get_memsize"]], ">=", 256)],
387    "get memory allocated to the qemu subprocess",
388    "\
389 This gets the memory size in megabytes allocated to the
390 qemu subprocess.
391
392 If C<guestfs_set_memsize> was not called
393 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
394 then this returns the compiled-in default value for memsize.
395
396 For more information on the architecture of libguestfs,
397 see L<guestfs(3)>.");
398
399   ("get_pid", (RInt "pid", [], []), -1, [FishAlias "pid"],
400    [InitNone, Always, TestOutputIntOp (
401       [["get_pid"]], ">=", 1)],
402    "get PID of qemu subprocess",
403    "\
404 Return the process ID of the qemu subprocess.  If there is no
405 qemu subprocess, then this will return an error.
406
407 This is an internal call used for debugging and testing.");
408
409   ("version", (RStruct ("version", "version"), [], []), -1, [],
410    [InitNone, Always, TestOutputStruct (
411       [["version"]], [CompareWithInt ("major", 1)])],
412    "get the library version number",
413    "\
414 Return the libguestfs version number that the program is linked
415 against.
416
417 Note that because of dynamic linking this is not necessarily
418 the version of libguestfs that you compiled against.  You can
419 compile the program, and then at runtime dynamically link
420 against a completely different C<libguestfs.so> library.
421
422 This call was added in version C<1.0.58>.  In previous
423 versions of libguestfs there was no way to get the version
424 number.  From C code you can use dynamic linker functions
425 to find out if this symbol exists (if it doesn't, then
426 it's an earlier version).
427
428 The call returns a structure with four elements.  The first
429 three (C<major>, C<minor> and C<release>) are numbers and
430 correspond to the usual version triplet.  The fourth element
431 (C<extra>) is a string and is normally empty, but may be
432 used for distro-specific information.
433
434 To construct the original version string:
435 C<$major.$minor.$release$extra>
436
437 See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>.
438
439 I<Note:> Don't use this call to test for availability
440 of features.  In enterprise distributions we backport
441 features from later versions into earlier versions,
442 making this an unreliable way to test for features.
443 Use C<guestfs_available> instead.");
444
445   ("set_selinux", (RErr, [Bool "selinux"], []), -1, [FishAlias "selinux"],
446    [InitNone, Always, TestOutputTrue (
447       [["set_selinux"; "true"];
448        ["get_selinux"]])],
449    "set SELinux enabled or disabled at appliance boot",
450    "\
451 This sets the selinux flag that is passed to the appliance
452 at boot time.  The default is C<selinux=0> (disabled).
453
454 Note that if SELinux is enabled, it is always in
455 Permissive mode (C<enforcing=0>).
456
457 For more information on the architecture of libguestfs,
458 see L<guestfs(3)>.");
459
460   ("get_selinux", (RBool "selinux", [], []), -1, [],
461    [],
462    "get SELinux enabled flag",
463    "\
464 This returns the current setting of the selinux flag which
465 is passed to the appliance at boot time.  See C<guestfs_set_selinux>.
466
467 For more information on the architecture of libguestfs,
468 see L<guestfs(3)>.");
469
470   ("set_trace", (RErr, [Bool "trace"], []), -1, [FishAlias "trace"],
471    [InitNone, Always, TestOutputFalse (
472       [["set_trace"; "false"];
473        ["get_trace"]])],
474    "enable or disable command traces",
475    "\
476 If the command trace flag is set to 1, then libguestfs
477 calls, parameters and return values are traced.
478
479 If you want to trace C API calls into libguestfs (and
480 other libraries) then possibly a better way is to use
481 the external ltrace(1) command.
482
483 Command traces are disabled unless the environment variable
484 C<LIBGUESTFS_TRACE> is defined and set to C<1>.
485
486 Trace messages are normally sent to C<stderr>, unless you
487 register a callback to send them somewhere else (see
488 C<guestfs_set_event_callback>).");
489
490   ("get_trace", (RBool "trace", [], []), -1, [],
491    [],
492    "get command trace enabled flag",
493    "\
494 Return the command trace flag.");
495
496   ("set_direct", (RErr, [Bool "direct"], []), -1, [FishAlias "direct"],
497    [InitNone, Always, TestOutputFalse (
498       [["set_direct"; "false"];
499        ["get_direct"]])],
500    "enable or disable direct appliance mode",
501    "\
502 If the direct appliance mode flag is enabled, then stdin and
503 stdout are passed directly through to the appliance once it
504 is launched.
505
506 One consequence of this is that log messages aren't caught
507 by the library and handled by C<guestfs_set_log_message_callback>,
508 but go straight to stdout.
509
510 You probably don't want to use this unless you know what you
511 are doing.
512
513 The default is disabled.");
514
515   ("get_direct", (RBool "direct", [], []), -1, [],
516    [],
517    "get direct appliance mode flag",
518    "\
519 Return the direct appliance mode flag.");
520
521   ("set_recovery_proc", (RErr, [Bool "recoveryproc"], []), -1, [FishAlias "recovery-proc"],
522    [InitNone, Always, TestOutputTrue (
523       [["set_recovery_proc"; "true"];
524        ["get_recovery_proc"]])],
525    "enable or disable the recovery process",
526    "\
527 If this is called with the parameter C<false> then
528 C<guestfs_launch> does not create a recovery process.  The
529 purpose of the recovery process is to stop runaway qemu
530 processes in the case where the main program aborts abruptly.
531
532 This only has any effect if called before C<guestfs_launch>,
533 and the default is true.
534
535 About the only time when you would want to disable this is
536 if the main process will fork itself into the background
537 (\"daemonize\" itself).  In this case the recovery process
538 thinks that the main program has disappeared and so kills
539 qemu, which is not very helpful.");
540
541   ("get_recovery_proc", (RBool "recoveryproc", [], []), -1, [],
542    [],
543    "get recovery process enabled flag",
544    "\
545 Return the recovery process enabled flag.");
546
547   ("add_drive_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
548    [],
549    "add a drive specifying the QEMU block emulation to use",
550    "\
551 This is the same as C<guestfs_add_drive> but it allows you
552 to specify the QEMU interface emulation to use at run time.");
553
554   ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
555    [],
556    "add a drive read-only specifying the QEMU block emulation to use",
557    "\
558 This is the same as C<guestfs_add_drive_ro> but it allows you
559 to specify the QEMU interface emulation to use at run time.");
560
561   ("file_architecture", (RString "arch", [Pathname "filename"], []), -1, [],
562    [InitISOFS, Always, TestOutput (
563       [["file_architecture"; "/bin-i586-dynamic"]], "i386");
564     InitISOFS, Always, TestOutput (
565       [["file_architecture"; "/bin-sparc-dynamic"]], "sparc");
566     InitISOFS, Always, TestOutput (
567       [["file_architecture"; "/bin-win32.exe"]], "i386");
568     InitISOFS, Always, TestOutput (
569       [["file_architecture"; "/bin-win64.exe"]], "x86_64");
570     InitISOFS, Always, TestOutput (
571       [["file_architecture"; "/bin-x86_64-dynamic"]], "x86_64");
572     InitISOFS, Always, TestOutput (
573       [["file_architecture"; "/lib-i586.so"]], "i386");
574     InitISOFS, Always, TestOutput (
575       [["file_architecture"; "/lib-sparc.so"]], "sparc");
576     InitISOFS, Always, TestOutput (
577       [["file_architecture"; "/lib-win32.dll"]], "i386");
578     InitISOFS, Always, TestOutput (
579       [["file_architecture"; "/lib-win64.dll"]], "x86_64");
580     InitISOFS, Always, TestOutput (
581       [["file_architecture"; "/lib-x86_64.so"]], "x86_64");
582     InitISOFS, Always, TestOutput (
583       [["file_architecture"; "/initrd-x86_64.img"]], "x86_64");
584     InitISOFS, Always, TestOutput (
585       [["file_architecture"; "/initrd-x86_64.img.gz"]], "x86_64");],
586    "detect the architecture of a binary file",
587    "\
588 This detects the architecture of the binary C<filename>,
589 and returns it if known.
590
591 Currently defined architectures are:
592
593 =over 4
594
595 =item \"i386\"
596
597 This string is returned for all 32 bit i386, i486, i586, i686 binaries
598 irrespective of the precise processor requirements of the binary.
599
600 =item \"x86_64\"
601
602 64 bit x86-64.
603
604 =item \"sparc\"
605
606 32 bit SPARC.
607
608 =item \"sparc64\"
609
610 64 bit SPARC V9 and above.
611
612 =item \"ia64\"
613
614 Intel Itanium.
615
616 =item \"ppc\"
617
618 32 bit Power PC.
619
620 =item \"ppc64\"
621
622 64 bit Power PC.
623
624 =back
625
626 Libguestfs may return other architecture strings in future.
627
628 The function works on at least the following types of files:
629
630 =over 4
631
632 =item *
633
634 many types of Un*x and Linux binary
635
636 =item *
637
638 many types of Un*x and Linux shared library
639
640 =item *
641
642 Windows Win32 and Win64 binaries
643
644 =item *
645
646 Windows Win32 and Win64 DLLs
647
648 Win32 binaries and DLLs return C<i386>.
649
650 Win64 binaries and DLLs return C<x86_64>.
651
652 =item *
653
654 Linux kernel modules
655
656 =item *
657
658 Linux new-style initrd images
659
660 =item *
661
662 some non-x86 Linux vmlinuz kernels
663
664 =back
665
666 What it can't do currently:
667
668 =over 4
669
670 =item *
671
672 static libraries (libfoo.a)
673
674 =item *
675
676 Linux old-style initrd as compressed ext2 filesystem (RHEL 3)
677
678 =item *
679
680 x86 Linux vmlinuz kernels
681
682 x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and
683 compressed code, and are horribly hard to unpack.  If you want to find
684 the architecture of a kernel, use the architecture of the associated
685 initrd or kernel module(s) instead.
686
687 =back");
688
689   ("inspect_os", (RStringList "roots", [], []), -1, [],
690    [],
691    "inspect disk and return list of operating systems found",
692    "\
693 This function uses other libguestfs functions and certain
694 heuristics to inspect the disk(s) (usually disks belonging to
695 a virtual machine), looking for operating systems.
696
697 The list returned is empty if no operating systems were found.
698
699 If one operating system was found, then this returns a list with
700 a single element, which is the name of the root filesystem of
701 this operating system.  It is also possible for this function
702 to return a list containing more than one element, indicating
703 a dual-boot or multi-boot virtual machine, with each element being
704 the root filesystem of one of the operating systems.
705
706 You can pass the root string(s) returned to other
707 C<guestfs_inspect_get_*> functions in order to query further
708 information about each operating system, such as the name
709 and version.
710
711 This function uses other libguestfs features such as
712 C<guestfs_mount_ro> and C<guestfs_umount_all> in order to mount
713 and unmount filesystems and look at the contents.  This should
714 be called with no disks currently mounted.  The function may also
715 use Augeas, so any existing Augeas handle will be closed.
716
717 This function cannot decrypt encrypted disks.  The caller
718 must do that first (supplying the necessary keys) if the
719 disk is encrypted.
720
721 Please read L<guestfs(3)/INSPECTION> for more details.
722
723 See also C<guestfs_list_filesystems>.");
724
725   ("inspect_get_type", (RString "name", [Device "root"], []), -1, [],
726    [],
727    "get type of inspected operating system",
728    "\
729 This returns the type of the inspected operating system.
730 Currently defined types are:
731
732 =over 4
733
734 =item \"linux\"
735
736 Any Linux-based operating system.
737
738 =item \"windows\"
739
740 Any Microsoft Windows operating system.
741
742 =item \"freebsd\"
743
744 FreeBSD.
745
746 =item \"netbsd\"
747
748 NetBSD.
749
750 =item \"hurd\"
751
752 GNU/Hurd.
753
754 =item \"unknown\"
755
756 The operating system type could not be determined.
757
758 =back
759
760 Future versions of libguestfs may return other strings here.
761 The caller should be prepared to handle any string.
762
763 Please read L<guestfs(3)/INSPECTION> for more details.");
764
765   ("inspect_get_arch", (RString "arch", [Device "root"], []), -1, [],
766    [],
767    "get architecture of inspected operating system",
768    "\
769 This returns the architecture of the inspected operating system.
770 The possible return values are listed under
771 C<guestfs_file_architecture>.
772
773 If the architecture could not be determined, then the
774 string C<unknown> is returned.
775
776 Please read L<guestfs(3)/INSPECTION> for more details.");
777
778   ("inspect_get_distro", (RString "distro", [Device "root"], []), -1, [],
779    [],
780    "get distro of inspected operating system",
781    "\
782 This returns the distro (distribution) of the inspected operating
783 system.
784
785 Currently defined distros are:
786
787 =over 4
788
789 =item \"archlinux\"
790
791 Arch Linux.
792
793 =item \"centos\"
794
795 CentOS.
796
797 =item \"debian\"
798
799 Debian.
800
801 =item \"fedora\"
802
803 Fedora.
804
805 =item \"gentoo\"
806
807 Gentoo.
808
809 =item \"linuxmint\"
810
811 Linux Mint.
812
813 =item \"mageia\"
814
815 Mageia.
816
817 =item \"mandriva\"
818
819 Mandriva.
820
821 =item \"meego\"
822
823 MeeGo.
824
825 =item \"opensuse\"
826
827 OpenSUSE.
828
829 =item \"pardus\"
830
831 Pardus.
832
833 =item \"redhat-based\"
834
835 Some Red Hat-derived distro.
836
837 =item \"rhel\"
838
839 Red Hat Enterprise Linux.
840
841 =item \"scientificlinux\"
842
843 Scientific Linux.
844
845 =item \"slackware\"
846
847 Slackware.
848
849 =item \"ttylinux\"
850
851 ttylinux.
852
853 =item \"ubuntu\"
854
855 Ubuntu.
856
857 =item \"unknown\"
858
859 The distro could not be determined.
860
861 =item \"windows\"
862
863 Windows does not have distributions.  This string is
864 returned if the OS type is Windows.
865
866 =back
867
868 Future versions of libguestfs may return other strings here.
869 The caller should be prepared to handle any string.
870
871 Please read L<guestfs(3)/INSPECTION> for more details.");
872
873   ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
874    [],
875    "get major version of inspected operating system",
876    "\
877 This returns the major version number of the inspected operating
878 system.
879
880 Windows uses a consistent versioning scheme which is I<not>
881 reflected in the popular public names used by the operating system.
882 Notably the operating system known as \"Windows 7\" is really
883 version 6.1 (ie. major = 6, minor = 1).  You can find out the
884 real versions corresponding to releases of Windows by consulting
885 Wikipedia or MSDN.
886
887 If the version could not be determined, then C<0> is returned.
888
889 Please read L<guestfs(3)/INSPECTION> for more details.");
890
891   ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
892    [],
893    "get minor version of inspected operating system",
894    "\
895 This returns the minor version number of the inspected operating
896 system.
897
898 If the version could not be determined, then C<0> is returned.
899
900 Please read L<guestfs(3)/INSPECTION> for more details.
901 See also C<guestfs_inspect_get_major_version>.");
902
903   ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
904    [],
905    "get product name of inspected operating system",
906    "\
907 This returns the product name of the inspected operating
908 system.  The product name is generally some freeform string
909 which can be displayed to the user, but should not be
910 parsed by programs.
911
912 If the product name could not be determined, then the
913 string C<unknown> is returned.
914
915 Please read L<guestfs(3)/INSPECTION> for more details.");
916
917   ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
918    [],
919    "get mountpoints of inspected operating system",
920    "\
921 This returns a hash of where we think the filesystems
922 associated with this operating system should be mounted.
923 Callers should note that this is at best an educated guess
924 made by reading configuration files such as C</etc/fstab>.
925 I<In particular note> that this may return filesystems
926 which are non-existent or not mountable and callers should
927 be prepared to handle or ignore failures if they try to
928 mount them.
929
930 Each element in the returned hashtable has a key which
931 is the path of the mountpoint (eg. C</boot>) and a value
932 which is the filesystem that would be mounted there
933 (eg. C</dev/sda1>).
934
935 Non-mounted devices such as swap devices are I<not>
936 returned in this list.
937
938 For operating systems like Windows which still use drive
939 letters, this call will only return an entry for the first
940 drive \"mounted on\" C</>.  For information about the
941 mapping of drive letters to partitions, see
942 C<guestfs_inspect_get_drive_mappings>.
943
944 Please read L<guestfs(3)/INSPECTION> for more details.
945 See also C<guestfs_inspect_get_filesystems>.");
946
947   ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
948    [],
949    "get filesystems associated with inspected operating system",
950    "\
951 This returns a list of all the filesystems that we think
952 are associated with this operating system.  This includes
953 the root filesystem, other ordinary filesystems, and
954 non-mounted devices like swap partitions.
955
956 In the case of a multi-boot virtual machine, it is possible
957 for a filesystem to be shared between operating systems.
958
959 Please read L<guestfs(3)/INSPECTION> for more details.
960 See also C<guestfs_inspect_get_mountpoints>.");
961
962   ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
963    [],
964    "set enable network flag",
965    "\
966 If C<network> is true, then the network is enabled in the
967 libguestfs appliance.  The default is false.
968
969 This affects whether commands are able to access the network
970 (see L<guestfs(3)/RUNNING COMMANDS>).
971
972 You must call this before calling C<guestfs_launch>, otherwise
973 it has no effect.");
974
975   ("get_network", (RBool "network", [], []), -1, [],
976    [],
977    "get enable network flag",
978    "\
979 This returns the enable network flag.");
980
981   ("list_filesystems", (RHashtable "fses", [], []), -1, [],
982    [],
983    "list filesystems",
984    "\
985 This inspection command looks for filesystems on partitions,
986 block devices and logical volumes, returning a list of devices
987 containing filesystems and their type.
988
989 The return value is a hash, where the keys are the devices
990 containing filesystems, and the values are the filesystem types.
991 For example:
992
993  \"/dev/sda1\" => \"ntfs\"
994  \"/dev/sda2\" => \"ext2\"
995  \"/dev/vg_guest/lv_root\" => \"ext4\"
996  \"/dev/vg_guest/lv_swap\" => \"swap\"
997
998 The value can have the special value \"unknown\", meaning the
999 content of the device is undetermined or empty.
1000 \"swap\" means a Linux swap partition.
1001
1002 This command runs other libguestfs commands, which might include
1003 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
1004 use this soon after launch and only when nothing is mounted.
1005
1006 Not all of the filesystems returned will be mountable.  In
1007 particular, swap partitions are returned in the list.  Also
1008 this command does not check that each filesystem
1009 found is valid and mountable, and some filesystems might
1010 be mountable but require special options.  Filesystems may
1011 not all belong to a single logical operating system
1012 (use C<guestfs_inspect_os> to look for OSes).");
1013
1014   ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"; String "name"]), -1, [FishAlias "add"],
1015    [],
1016    "add an image to examine or modify",
1017    "\
1018 This function adds a virtual machine disk image C<filename> to
1019 libguestfs.  The first time you call this function, the disk
1020 appears as C</dev/sda>, the second time as C</dev/sdb>, and
1021 so on.
1022
1023 You don't necessarily need to be root when using libguestfs.  However
1024 you obviously do need sufficient permissions to access the filename
1025 for whatever operations you want to perform (ie. read access if you
1026 just want to read the image or write access if you want to modify the
1027 image).
1028
1029 This call checks that C<filename> exists.
1030
1031 The optional arguments are:
1032
1033 =over 4
1034
1035 =item C<readonly>
1036
1037 If true then the image is treated as read-only.  Writes are still
1038 allowed, but they are stored in a temporary snapshot overlay which
1039 is discarded at the end.  The disk that you add is not modified.
1040
1041 =item C<format>
1042
1043 This forces the image format.  If you omit this (or use C<guestfs_add_drive>
1044 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1045 Possible formats include C<raw> and C<qcow2>.
1046
1047 Automatic detection of the format opens you up to a potential
1048 security hole when dealing with untrusted raw-format images.
1049 See CVE-2010-3851 and RHBZ#642934.  Specifying the format closes
1050 this security hole.
1051
1052 =item C<iface>
1053
1054 This rarely-used option lets you emulate the behaviour of the
1055 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1056
1057 =item C<name>
1058
1059 The name the drive had in the original guest, e.g. /dev/sdb. This is used as a
1060 hint to the guest inspection process if it is available.
1061
1062 =back");
1063
1064   ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1065    [],
1066    "get Windows systemroot of inspected operating system",
1067    "\
1068 This returns the Windows systemroot of the inspected guest.
1069 The systemroot is a directory path such as C</WINDOWS>.
1070
1071 This call assumes that the guest is Windows and that the
1072 systemroot could be determined by inspection.  If this is not
1073 the case then an error is returned.
1074
1075 Please read L<guestfs(3)/INSPECTION> for more details.");
1076
1077   ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1078    [],
1079    "return list of operating systems found by last inspection",
1080    "\
1081 This function is a convenient way to get the list of root
1082 devices, as returned from a previous call to C<guestfs_inspect_os>,
1083 but without redoing the whole inspection process.
1084
1085 This returns an empty list if either no root devices were
1086 found or the caller has not called C<guestfs_inspect_os>.
1087
1088 Please read L<guestfs(3)/INSPECTION> for more details.");
1089
1090   ("debug_cmdline", (RStringList "cmdline", [], []), -1, [NotInDocs],
1091    [],
1092    "debug the QEMU command line (internal use only)",
1093    "\
1094 This returns the internal QEMU command line.  'debug' commands are
1095 not part of the formal API and can be removed or changed at any time.");
1096
1097   ("debug_drives", (RStringList "cmdline", [], []), -1, [NotInDocs],
1098    [],
1099    "debug the drives (internal use only)",
1100    "\
1101 This returns the internal list of drives.  'debug' commands are
1102 not part of the formal API and can be removed or changed at any time.");
1103
1104   ("add_domain", (RInt "nrdisks", [String "dom"], [String "libvirturi"; Bool "readonly"; String "iface"; Bool "live"; Bool "allowuuid"; String "readonlydisk"]), -1, [FishAlias "domain"],
1105    [],
1106    "add the disk(s) from a named libvirt domain",
1107    "\
1108 This function adds the disk(s) attached to the named libvirt
1109 domain C<dom>.  It works by connecting to libvirt, requesting
1110 the domain and domain XML from libvirt, parsing it for disks,
1111 and calling C<guestfs_add_drive_opts> on each one.
1112
1113 The number of disks added is returned.  This operation is atomic:
1114 if an error is returned, then no disks are added.
1115
1116 This function does some minimal checks to make sure the libvirt
1117 domain is not running (unless C<readonly> is true).  In a future
1118 version we will try to acquire the libvirt lock on each disk.
1119
1120 Disks must be accessible locally.  This often means that adding disks
1121 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1122 will fail unless those disks are accessible via the same device path
1123 locally too.
1124
1125 The optional C<libvirturi> parameter sets the libvirt URI
1126 (see L<http://libvirt.org/uri.html>).  If this is not set then
1127 we connect to the default libvirt URI (or one set through an
1128 environment variable, see the libvirt documentation for full
1129 details).
1130
1131 The optional C<live> flag controls whether this call will try
1132 to connect to a running virtual machine C<guestfsd> process if
1133 it sees a suitable E<lt>channelE<gt> element in the libvirt
1134 XML definition.  The default (if the flag is omitted) is never
1135 to try.  See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1136 information.
1137
1138 If the C<allowuuid> flag is true (default is false) then a UUID
1139 I<may> be passed instead of the domain name.  The C<dom> string is
1140 treated as a UUID first and looked up, and if that lookup fails
1141 then we treat C<dom> as a name as usual.
1142
1143 The optional C<readonlydisk> parameter controls what we do for
1144 disks which are marked E<lt>readonly/E<gt> in the libvirt XML.
1145 Possible values are:
1146
1147 =over 4
1148
1149 =item readonlydisk = \"error\"
1150
1151 If C<readonly> is false:
1152
1153 The whole call is aborted with an error if any disk with
1154 the E<lt>readonly/E<gt> flag is found.
1155
1156 If C<readonly> is true:
1157
1158 Disks with the E<lt>readonly/E<gt> flag are added read-only.
1159
1160 =item readonlydisk = \"read\"
1161
1162 If C<readonly> is false:
1163
1164 Disks with the E<lt>readonly/E<gt> flag are added read-only.
1165 Other disks are added read/write.
1166
1167 If C<readonly> is true:
1168
1169 Disks with the E<lt>readonly/E<gt> flag are added read-only.
1170
1171 =item readonlydisk = \"write\" (default)
1172
1173 If C<readonly> is false:
1174
1175 Disks with the E<lt>readonly/E<gt> flag are added read/write.
1176
1177 If C<readonly> is true:
1178
1179 Disks with the E<lt>readonly/E<gt> flag are added read-only.
1180
1181 =item readonlydisk = \"ignore\"
1182
1183 If C<readonly> is true or false:
1184
1185 Disks with the E<lt>readonly/E<gt> flag are skipped.
1186
1187 =back
1188
1189 The other optional parameters are passed directly through to
1190 C<guestfs_add_drive_opts>.");
1191
1192 (*
1193 This interface is not quite baked yet. -- RWMJ 2010-11-11
1194   ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"; Bool "live"; String "readonlydisk"]), -1, [NotInFish],
1195    [],
1196    "add the disk(s) from a libvirt domain",
1197    "\
1198 This function adds the disk(s) attached to the libvirt domain C<dom>.
1199 It works by requesting the domain XML from libvirt, parsing it for
1200 disks, and calling C<guestfs_add_drive_opts> on each one.
1201
1202 In the C API we declare C<void *dom>, but really it has type
1203 C<virDomainPtr dom>.  This is so we don't need E<lt>libvirt.hE<gt>.
1204
1205 The number of disks added is returned.  This operation is atomic:
1206 if an error is returned, then no disks are added.
1207
1208 This function does some minimal checks to make sure the libvirt
1209 domain is not running (unless C<readonly> is true).  In a future
1210 version we will try to acquire the libvirt lock on each disk.
1211
1212 Disks must be accessible locally.  This often means that adding disks
1213 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1214 will fail unless those disks are accessible via the same device path
1215 locally too.
1216
1217 The optional C<live> flag controls whether this call will try
1218 to connect to a running virtual machine C<guestfsd> process if
1219 it sees a suitable E<lt>channelE<gt> element in the libvirt
1220 XML definition.  The default (if the flag is omitted) is never
1221 to try.  See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1222 information.
1223
1224 The optional C<readonlydisk> parameter controls what we do for
1225 disks which are marked E<lt>readonly/E<gt> in the libvirt XML.
1226 See C<guestfs_add_domain> for possible values.
1227
1228 The other optional parameters are passed directly through to
1229 C<guestfs_add_drive_opts>.");
1230 *)
1231
1232   ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1233    [],
1234    "get package format used by the operating system",
1235    "\
1236 This function and C<guestfs_inspect_get_package_management> return
1237 the package format and package management tool used by the
1238 inspected operating system.  For example for Fedora these
1239 functions would return C<rpm> (package format) and
1240 C<yum> (package management).
1241
1242 This returns the string C<unknown> if we could not determine the
1243 package format I<or> if the operating system does not have
1244 a real packaging system (eg. Windows).
1245
1246 Possible strings include:
1247 C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>, C<pkgsrc>.
1248 Future versions of libguestfs may return other strings.
1249
1250 Please read L<guestfs(3)/INSPECTION> for more details.");
1251
1252   ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1253    [],
1254    "get package management tool used by the operating system",
1255    "\
1256 C<guestfs_inspect_get_package_format> and this function return
1257 the package format and package management tool used by the
1258 inspected operating system.  For example for Fedora these
1259 functions would return C<rpm> (package format) and
1260 C<yum> (package management).
1261
1262 This returns the string C<unknown> if we could not determine the
1263 package management tool I<or> if the operating system does not have
1264 a real packaging system (eg. Windows).
1265
1266 Possible strings include: C<yum>, C<up2date>,
1267 C<apt> (for all Debian derivatives),
1268 C<portage>, C<pisi>, C<pacman>, C<urpmi>, C<zypper>.
1269 Future versions of libguestfs may return other strings.
1270
1271 Please read L<guestfs(3)/INSPECTION> for more details.");
1272
1273   ("inspect_list_applications", (RStructList ("applications", "application"), [Device "root"], []), -1, [],
1274    [],
1275    "get list of applications installed in the operating system",
1276    "\
1277 Return the list of applications installed in the operating system.
1278
1279 I<Note:> This call works differently from other parts of the
1280 inspection API.  You have to call C<guestfs_inspect_os>, then
1281 C<guestfs_inspect_get_mountpoints>, then mount up the disks,
1282 before calling this.  Listing applications is a significantly
1283 more difficult operation which requires access to the full
1284 filesystem.  Also note that unlike the other
1285 C<guestfs_inspect_get_*> calls which are just returning
1286 data cached in the libguestfs handle, this call actually reads
1287 parts of the mounted filesystems during the call.
1288
1289 This returns an empty list if the inspection code was not able
1290 to determine the list of applications.
1291
1292 The application structure contains the following fields:
1293
1294 =over 4
1295
1296 =item C<app_name>
1297
1298 The name of the application.  For Red Hat-derived and Debian-derived
1299 Linux guests, this is the package name.
1300
1301 =item C<app_display_name>
1302
1303 The display name of the application, sometimes localized to the
1304 install language of the guest operating system.
1305
1306 If unavailable this is returned as an empty string C<\"\">.
1307 Callers needing to display something can use C<app_name> instead.
1308
1309 =item C<app_epoch>
1310
1311 For package managers which use epochs, this contains the epoch of
1312 the package (an integer).  If unavailable, this is returned as C<0>.
1313
1314 =item C<app_version>
1315
1316 The version string of the application or package.  If unavailable
1317 this is returned as an empty string C<\"\">.
1318
1319 =item C<app_release>
1320
1321 The release string of the application or package, for package
1322 managers that use this.  If unavailable this is returned as an
1323 empty string C<\"\">.
1324
1325 =item C<app_install_path>
1326
1327 The installation path of the application (on operating systems
1328 such as Windows which use installation paths).  This path is
1329 in the format used by the guest operating system, it is not
1330 a libguestfs path.
1331
1332 If unavailable this is returned as an empty string C<\"\">.
1333
1334 =item C<app_trans_path>
1335
1336 The install path translated into a libguestfs path.
1337 If unavailable this is returned as an empty string C<\"\">.
1338
1339 =item C<app_publisher>
1340
1341 The name of the publisher of the application, for package
1342 managers that use this.  If unavailable this is returned
1343 as an empty string C<\"\">.
1344
1345 =item C<app_url>
1346
1347 The URL (eg. upstream URL) of the application.
1348 If unavailable this is returned as an empty string C<\"\">.
1349
1350 =item C<app_source_package>
1351
1352 For packaging systems which support this, the name of the source
1353 package.  If unavailable this is returned as an empty string C<\"\">.
1354
1355 =item C<app_summary>
1356
1357 A short (usually one line) description of the application or package.
1358 If unavailable this is returned as an empty string C<\"\">.
1359
1360 =item C<app_description>
1361
1362 A longer description of the application or package.
1363 If unavailable this is returned as an empty string C<\"\">.
1364
1365 =back
1366
1367 Please read L<guestfs(3)/INSPECTION> for more details.");
1368
1369   ("inspect_get_hostname", (RString "hostname", [Device "root"], []), -1, [],
1370    [],
1371    "get hostname of the operating system",
1372    "\
1373 This function returns the hostname of the operating system
1374 as found by inspection of the guest's configuration files.
1375
1376 If the hostname could not be determined, then the
1377 string C<unknown> is returned.
1378
1379 Please read L<guestfs(3)/INSPECTION> for more details.");
1380
1381   ("inspect_get_format", (RString "format", [Device "root"], []), -1, [],
1382    [],
1383    "get format of inspected operating system",
1384    "\
1385 This returns the format of the inspected operating system.  You
1386 can use it to detect install images, live CDs and similar.
1387
1388 Currently defined formats are:
1389
1390 =over 4
1391
1392 =item \"installed\"
1393
1394 This is an installed operating system.
1395
1396 =item \"installer\"
1397
1398 The disk image being inspected is not an installed operating system,
1399 but a I<bootable> install disk, live CD, or similar.
1400
1401 =item \"unknown\"
1402
1403 The format of this disk image is not known.
1404
1405 =back
1406
1407 Future versions of libguestfs may return other strings here.
1408 The caller should be prepared to handle any string.
1409
1410 Please read L<guestfs(3)/INSPECTION> for more details.");
1411
1412   ("inspect_is_live", (RBool "live", [Device "root"], []), -1, [],
1413    [],
1414    "get live flag for install disk",
1415    "\
1416 If C<guestfs_inspect_get_format> returns C<installer> (this
1417 is an install disk), then this returns true if a live image
1418 was detected on the disk.
1419
1420 Please read L<guestfs(3)/INSPECTION> for more details.");
1421
1422   ("inspect_is_netinst", (RBool "netinst", [Device "root"], []), -1, [],
1423    [],
1424    "get netinst (network installer) flag for install disk",
1425    "\
1426 If C<guestfs_inspect_get_format> returns C<installer> (this
1427 is an install disk), then this returns true if the disk is
1428 a network installer, ie. not a self-contained install CD but
1429 one which is likely to require network access to complete
1430 the install.
1431
1432 Please read L<guestfs(3)/INSPECTION> for more details.");
1433
1434   ("inspect_is_multipart", (RBool "multipart", [Device "root"], []), -1, [],
1435    [],
1436    "get multipart flag for install disk",
1437    "\
1438 If C<guestfs_inspect_get_format> returns C<installer> (this
1439 is an install disk), then this returns true if the disk is
1440 part of a set.
1441
1442 Please read L<guestfs(3)/INSPECTION> for more details.");
1443
1444   ("set_attach_method", (RErr, [String "attachmethod"], []), -1, [FishAlias "attach-method"],
1445    [],
1446    "set the attach method",
1447    "\
1448 Set the method that libguestfs uses to connect to the back end
1449 guestfsd daemon.  Possible methods are:
1450
1451 =over 4
1452
1453 =item C<appliance>
1454
1455 Launch an appliance and connect to it.  This is the ordinary method
1456 and the default.
1457
1458 =item C<unix:I<path>>
1459
1460 Connect to the Unix domain socket I<path>.
1461
1462 This method lets you connect to an existing daemon or (using
1463 virtio-serial) to a live guest.  For more information, see
1464 L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>.
1465
1466 =back");
1467
1468   ("get_attach_method", (RString "attachmethod", [], []), -1, [],
1469    [InitNone, Always, TestOutput (
1470       [["get_attach_method"]], "appliance")],
1471    "get the attach method",
1472    "\
1473 Return the current attach method.  See C<guestfs_set_attach_method>.");
1474
1475   ("inspect_get_product_variant", (RString "variant", [Device "root"], []), -1, [],
1476    [],
1477    "get product variant of inspected operating system",
1478    "\
1479 This returns the product variant of the inspected operating
1480 system.
1481
1482 For Windows guests, this returns the contents of the Registry key
1483 C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion>
1484 C<InstallationType> which is usually a string such as
1485 C<Client> or C<Server> (other values are possible).  This
1486 can be used to distinguish consumer and enterprise versions
1487 of Windows that have the same version number (for example,
1488 Windows 7 and Windows 2008 Server are both version 6.1,
1489 but the former is C<Client> and the latter is C<Server>).
1490
1491 For enterprise Linux guests, in future we intend this to return
1492 the product variant such as C<Desktop>, C<Server> and so on.  But
1493 this is not implemented at present.
1494
1495 If the product variant could not be determined, then the
1496 string C<unknown> is returned.
1497
1498 Please read L<guestfs(3)/INSPECTION> for more details.
1499 See also C<guestfs_inspect_get_product_name>,
1500 C<guestfs_inspect_get_major_version>.");
1501
1502   ("inspect_get_windows_current_control_set", (RString "controlset", [Device "root"], []), -1, [],
1503    [],
1504    "get Windows CurrentControlSet of inspected operating system",
1505    "\
1506 This returns the Windows CurrentControlSet of the inspected guest.
1507 The CurrentControlSet is a registry key name such as C<ControlSet001>.
1508
1509 This call assumes that the guest is Windows and that the
1510 Registry could be examined by inspection.  If this is not
1511 the case then an error is returned.
1512
1513 Please read L<guestfs(3)/INSPECTION> for more details.");
1514
1515   ("inspect_get_drive_mappings", (RHashtable "drives", [Device "root"], []), -1, [],
1516    [],
1517    "get drive letter mappings",
1518    "\
1519 This call is useful for Windows which uses a primitive system
1520 of assigning drive letters (like \"C:\") to partitions.
1521 This inspection API examines the Windows Registry to find out
1522 how disks/partitions are mapped to drive letters, and returns
1523 a hash table as in the example below:
1524
1525  C      =>     /dev/vda2
1526  E      =>     /dev/vdb1
1527  F      =>     /dev/vdc1
1528
1529 Note that keys are drive letters.  For Windows, the key is
1530 case insensitive and just contains the drive letter, without
1531 the customary colon separator character.
1532
1533 In future we may support other operating systems that also used drive
1534 letters, but the keys for those might not be case insensitive
1535 and might be longer than 1 character.  For example in OS-9,
1536 hard drives were named C<h0>, C<h1> etc.
1537
1538 For Windows guests, currently only hard drive mappings are
1539 returned.  Removable disks (eg. DVD-ROMs) are ignored.
1540
1541 For guests that do not use drive mappings, or if the drive mappings
1542 could not be determined, this returns an empty hash table.
1543
1544 Please read L<guestfs(3)/INSPECTION> for more details.
1545 See also C<guestfs_inspect_get_mountpoints>,
1546 C<guestfs_inspect_get_filesystems>.");
1547
1548   ("inspect_get_icon", (RBufferOut "icon", [Device "root"],  [Bool "favicon"; Bool "highquality"]), -1, [],
1549    [],
1550    "get the icon corresponding to this operating system",
1551    "\
1552 This function returns an icon corresponding to the inspected
1553 operating system.  The icon is returned as a buffer containing a
1554 PNG image (re-encoded to PNG if necessary).
1555
1556 If it was not possible to get an icon this function returns a
1557 zero-length (non-NULL) buffer.  I<Callers must check for this case>.
1558
1559 Libguestfs will start by looking for a file called
1560 C</etc/favicon.png> or C<C:\\etc\\favicon.png>
1561 and if it has the correct format, the contents of this file will
1562 be returned.  You can disable favicons by passing the
1563 optional C<favicon> boolean as false (default is true).
1564
1565 If finding the favicon fails, then we look in other places in the
1566 guest for a suitable icon.
1567
1568 If the optional C<highquality> boolean is true then
1569 only high quality icons are returned, which means only icons of
1570 high resolution with an alpha channel.  The default (false) is
1571 to return any icon we can, even if it is of substandard quality.
1572
1573 Notes:
1574
1575 =over 4
1576
1577 =item *
1578
1579 Unlike most other inspection API calls, the guest's disks must be
1580 mounted up before you call this, since it needs to read information
1581 from the guest filesystem during the call.
1582
1583 =item *
1584
1585 B<Security:> The icon data comes from the untrusted guest,
1586 and should be treated with caution.  PNG files have been
1587 known to contain exploits.  Ensure that libpng (or other relevant
1588 libraries) are fully up to date before trying to process or
1589 display the icon.
1590
1591 =item *
1592
1593 The PNG image returned can be any size.  It might not be square.
1594 Libguestfs tries to return the largest, highest quality
1595 icon available.  The application must scale the icon to the
1596 required size.
1597
1598 =item *
1599
1600 Extracting icons from Windows guests requires the external
1601 C<wrestool> program from the C<icoutils> package, and
1602 several programs (C<bmptopnm>, C<pnmtopng>, C<pamcut>)
1603 from the C<netpbm> package.  These must be installed separately.
1604
1605 =item *
1606
1607 Operating system icons are usually trademarks.  Seek legal
1608 advice before using trademarks in applications.
1609
1610 =back");
1611
1612   ("set_pgroup", (RErr, [Bool "pgroup"], []), -1, [FishAlias "pgroup"],
1613    [],
1614    "set process group flag",
1615    "\
1616 If C<pgroup> is true, child processes are placed into
1617 their own process group.
1618
1619 The practical upshot of this is that signals like C<SIGINT> (from
1620 users pressing C<^C>) won't be received by the child process.
1621
1622 The default for this flag is false, because usually you want
1623 C<^C> to kill the subprocess.");
1624
1625   ("get_pgroup", (RBool "pgroup", [], []), -1, [],
1626    [],
1627    "get process group flag",
1628    "\
1629 This returns the process group flag.");
1630
1631   ("set_smp", (RErr, [Int "smp"], []), -1, [FishAlias "smp"],
1632    [],
1633    "set number of virtual CPUs in appliance",
1634    "\
1635 Change the number of virtual CPUs assigned to the appliance.  The
1636 default is C<1>.  Increasing this may improve performance, though
1637 often it has no effect.
1638
1639 This function must be called before C<guestfs_launch>.");
1640
1641   ("get_smp", (RInt "smp", [], []), -1, [],
1642    [],
1643    "get number of virtual CPUs in appliance",
1644    "\
1645 This returns the number of virtual CPUs assigned to the appliance.");
1646
1647 ]
1648
1649 (* daemon_functions are any functions which cause some action
1650  * to take place in the daemon.
1651  *)
1652
1653 let daemon_functions = [
1654   ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1655    [InitEmpty, Always, TestOutput (
1656       [["part_disk"; "/dev/sda"; "mbr"];
1657        ["mkfs"; "ext2"; "/dev/sda1"];
1658        ["mount"; "/dev/sda1"; "/"];
1659        ["write"; "/new"; "new file contents"];
1660        ["cat"; "/new"]], "new file contents")],
1661    "mount a guest disk at a position in the filesystem",
1662    "\
1663 Mount a guest disk at a position in the filesystem.  Block devices
1664 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1665 the guest.  If those block devices contain partitions, they will have
1666 the usual names (eg. C</dev/sda1>).  Also LVM C</dev/VG/LV>-style
1667 names can be used.
1668
1669 The rules are the same as for L<mount(2)>:  A filesystem must
1670 first be mounted on C</> before others can be mounted.  Other
1671 filesystems can only be mounted on directories which already
1672 exist.
1673
1674 The mounted filesystem is writable, if we have sufficient permissions
1675 on the underlying device.
1676
1677 Before libguestfs 1.13.16, this call implicitly added the options
1678 C<sync> and C<noatime>.  The C<sync> option greatly slowed
1679 writes and caused many problems for users.  If your program
1680 might need to work with older versions of libguestfs, use
1681 C<guestfs_mount_options> instead (using an empty string for the
1682 first parameter if you don't want any options).");
1683
1684   ("sync", (RErr, [], []), 2, [],
1685    [ InitEmpty, Always, TestRun [["sync"]]],
1686    "sync disks, writes are flushed through to the disk image",
1687    "\
1688 This syncs the disk, so that any writes are flushed through to the
1689 underlying disk image.
1690
1691 You should always call this if you have modified a disk image, before
1692 closing the handle.");
1693
1694   ("touch", (RErr, [Pathname "path"], []), 3, [],
1695    [InitScratchFS, Always, TestOutputTrue (
1696       [["touch"; "/touch"];
1697        ["exists"; "/touch"]])],
1698    "update file timestamps or create a new file",
1699    "\
1700 Touch acts like the L<touch(1)> command.  It can be used to
1701 update the timestamps on a file, or, if the file does not exist,
1702 to create a new zero-length file.
1703
1704 This command only works on regular files, and will fail on other
1705 file types such as directories, symbolic links, block special etc.");
1706
1707   ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1708    [InitISOFS, Always, TestOutput (
1709       [["cat"; "/known-2"]], "abcdef\n")],
1710    "list the contents of a file",
1711    "\
1712 Return the contents of the file named C<path>.
1713
1714 Note that this function cannot correctly handle binary files
1715 (specifically, files containing C<\\0> character which is treated
1716 as end of string).  For those you need to use the C<guestfs_read_file>
1717 or C<guestfs_download> functions which have a more complex interface.");
1718
1719   ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1720    [], (* XXX Tricky to test because it depends on the exact format
1721         * of the 'ls -l' command, which changes between F10 and F11.
1722         *)
1723    "list the files in a directory (long format)",
1724    "\
1725 List the files in C<directory> (relative to the root directory,
1726 there is no cwd) in the format of 'ls -la'.
1727
1728 This command is mostly useful for interactive sessions.  It
1729 is I<not> intended that you try to parse the output string.");
1730
1731   ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1732    [InitScratchFS, Always, TestOutputList (
1733       [["mkdir"; "/ls"];
1734        ["touch"; "/ls/new"];
1735        ["touch"; "/ls/newer"];
1736        ["touch"; "/ls/newest"];
1737        ["ls"; "/ls"]], ["new"; "newer"; "newest"])],
1738    "list the files in a directory",
1739    "\
1740 List the files in C<directory> (relative to the root directory,
1741 there is no cwd).  The '.' and '..' entries are not returned, but
1742 hidden files are shown.
1743
1744 This command is mostly useful for interactive sessions.  Programs
1745 should probably use C<guestfs_readdir> instead.");
1746
1747   ("list_devices", (RStringList "devices", [], []), 7, [],
1748    [InitEmpty, Always, TestOutputListOfDevices (
1749       [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1750    "list the block devices",
1751    "\
1752 List all the block devices.
1753
1754 The full block device names are returned, eg. C</dev/sda>.
1755
1756 See also C<guestfs_list_filesystems>.");
1757
1758   ("list_partitions", (RStringList "partitions", [], []), 8, [],
1759    [InitBasicFS, Always, TestOutputListOfDevices (
1760       [["list_partitions"]], ["/dev/sda1"; "/dev/sdb1"]);
1761     InitEmpty, Always, TestOutputListOfDevices (
1762       [["part_init"; "/dev/sda"; "mbr"];
1763        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1764        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1765        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1766        ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"; "/dev/sdb1"])],
1767    "list the partitions",
1768    "\
1769 List all the partitions detected on all block devices.
1770
1771 The full partition device names are returned, eg. C</dev/sda1>
1772
1773 This does not return logical volumes.  For that you will need to
1774 call C<guestfs_lvs>.
1775
1776 See also C<guestfs_list_filesystems>.");
1777
1778   ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1779    [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1780       [["pvs"]], ["/dev/sda1"]);
1781     InitEmpty, Always, TestOutputListOfDevices (
1782       [["part_init"; "/dev/sda"; "mbr"];
1783        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1784        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1785        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1786        ["pvcreate"; "/dev/sda1"];
1787        ["pvcreate"; "/dev/sda2"];
1788        ["pvcreate"; "/dev/sda3"];
1789        ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1790    "list the LVM physical volumes (PVs)",
1791    "\
1792 List all the physical volumes detected.  This is the equivalent
1793 of the L<pvs(8)> command.
1794
1795 This returns a list of just the device names that contain
1796 PVs (eg. C</dev/sda2>).
1797
1798 See also C<guestfs_pvs_full>.");
1799
1800   ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1801    [InitBasicFSonLVM, Always, TestOutputList (
1802       [["vgs"]], ["VG"]);
1803     InitEmpty, Always, TestOutputList (
1804       [["part_init"; "/dev/sda"; "mbr"];
1805        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1806        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1807        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1808        ["pvcreate"; "/dev/sda1"];
1809        ["pvcreate"; "/dev/sda2"];
1810        ["pvcreate"; "/dev/sda3"];
1811        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1812        ["vgcreate"; "VG2"; "/dev/sda3"];
1813        ["vgs"]], ["VG1"; "VG2"])],
1814    "list the LVM volume groups (VGs)",
1815    "\
1816 List all the volumes groups detected.  This is the equivalent
1817 of the L<vgs(8)> command.
1818
1819 This returns a list of just the volume group names that were
1820 detected (eg. C<VolGroup00>).
1821
1822 See also C<guestfs_vgs_full>.");
1823
1824   ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1825    [InitBasicFSonLVM, Always, TestOutputList (
1826       [["lvs"]], ["/dev/VG/LV"]);
1827     InitEmpty, Always, TestOutputList (
1828       [["part_init"; "/dev/sda"; "mbr"];
1829        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1830        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1831        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1832        ["pvcreate"; "/dev/sda1"];
1833        ["pvcreate"; "/dev/sda2"];
1834        ["pvcreate"; "/dev/sda3"];
1835        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1836        ["vgcreate"; "VG2"; "/dev/sda3"];
1837        ["lvcreate"; "LV1"; "VG1"; "50"];
1838        ["lvcreate"; "LV2"; "VG1"; "50"];
1839        ["lvcreate"; "LV3"; "VG2"; "50"];
1840        ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1841    "list the LVM logical volumes (LVs)",
1842    "\
1843 List all the logical volumes detected.  This is the equivalent
1844 of the L<lvs(8)> command.
1845
1846 This returns a list of the logical volume device names
1847 (eg. C</dev/VolGroup00/LogVol00>).
1848
1849 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1850
1851   ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1852    [], (* XXX how to test? *)
1853    "list the LVM physical volumes (PVs)",
1854    "\
1855 List all the physical volumes detected.  This is the equivalent
1856 of the L<pvs(8)> command.  The \"full\" version includes all fields.");
1857
1858   ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1859    [], (* XXX how to test? *)
1860    "list the LVM volume groups (VGs)",
1861    "\
1862 List all the volumes groups detected.  This is the equivalent
1863 of the L<vgs(8)> command.  The \"full\" version includes all fields.");
1864
1865   ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1866    [], (* XXX how to test? *)
1867    "list the LVM logical volumes (LVs)",
1868    "\
1869 List all the logical volumes detected.  This is the equivalent
1870 of the L<lvs(8)> command.  The \"full\" version includes all fields.");
1871
1872   ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1873    [InitISOFS, Always, TestOutputList (
1874       [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1875     InitISOFS, Always, TestOutputList (
1876       [["read_lines"; "/empty"]], [])],
1877    "read file as lines",
1878    "\
1879 Return the contents of the file named C<path>.
1880
1881 The file contents are returned as a list of lines.  Trailing
1882 C<LF> and C<CRLF> character sequences are I<not> returned.
1883
1884 Note that this function cannot correctly handle binary files
1885 (specifically, files containing C<\\0> character which is treated
1886 as end of line).  For those you need to use the C<guestfs_read_file>
1887 function which has a more complex interface.");
1888
1889   ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1890    [], (* XXX Augeas code needs tests. *)
1891    "create a new Augeas handle",
1892    "\
1893 Create a new Augeas handle for editing configuration files.
1894 If there was any previous Augeas handle associated with this
1895 guestfs session, then it is closed.
1896
1897 You must call this before using any other C<guestfs_aug_*>
1898 commands.
1899
1900 C<root> is the filesystem root.  C<root> must not be NULL,
1901 use C</> instead.
1902
1903 The flags are the same as the flags defined in
1904 E<lt>augeas.hE<gt>, the logical I<or> of the following
1905 integers:
1906
1907 =over 4
1908
1909 =item C<AUG_SAVE_BACKUP> = 1
1910
1911 Keep the original file with a C<.augsave> extension.
1912
1913 =item C<AUG_SAVE_NEWFILE> = 2
1914
1915 Save changes into a file with extension C<.augnew>, and
1916 do not overwrite original.  Overrides C<AUG_SAVE_BACKUP>.
1917
1918 =item C<AUG_TYPE_CHECK> = 4
1919
1920 Typecheck lenses.
1921
1922 This option is only useful when debugging Augeas lenses.  Use
1923 of this option may require additional memory for the libguestfs
1924 appliance.  You may need to set the C<LIBGUESTFS_MEMSIZE>
1925 environment variable or call C<guestfs_set_memsize>.
1926
1927 =item C<AUG_NO_STDINC> = 8
1928
1929 Do not use standard load path for modules.
1930
1931 =item C<AUG_SAVE_NOOP> = 16
1932
1933 Make save a no-op, just record what would have been changed.
1934
1935 =item C<AUG_NO_LOAD> = 32
1936
1937 Do not load the tree in C<guestfs_aug_init>.
1938
1939 =back
1940
1941 To close the handle, you can call C<guestfs_aug_close>.
1942
1943 To find out more about Augeas, see L<http://augeas.net/>.");
1944
1945   ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1946    [], (* XXX Augeas code needs tests. *)
1947    "close the current Augeas handle",
1948    "\
1949 Close the current Augeas handle and free up any resources
1950 used by it.  After calling this, you have to call
1951 C<guestfs_aug_init> again before you can use any other
1952 Augeas functions.");
1953
1954   ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1955    [], (* XXX Augeas code needs tests. *)
1956    "define an Augeas variable",
1957    "\
1958 Defines an Augeas variable C<name> whose value is the result
1959 of evaluating C<expr>.  If C<expr> is NULL, then C<name> is
1960 undefined.
1961
1962 On success this returns the number of nodes in C<expr>, or
1963 C<0> if C<expr> evaluates to something which is not a nodeset.");
1964
1965   ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1966    [], (* XXX Augeas code needs tests. *)
1967    "define an Augeas node",
1968    "\
1969 Defines a variable C<name> whose value is the result of
1970 evaluating C<expr>.
1971
1972 If C<expr> evaluates to an empty nodeset, a node is created,
1973 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1974 C<name> will be the nodeset containing that single node.
1975
1976 On success this returns a pair containing the
1977 number of nodes in the nodeset, and a boolean flag
1978 if a node was created.");
1979
1980   ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1981    [], (* XXX Augeas code needs tests. *)
1982    "look up the value of an Augeas path",
1983    "\
1984 Look up the value associated with C<path>.  If C<path>
1985 matches exactly one node, the C<value> is returned.");
1986
1987   ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1988    [], (* XXX Augeas code needs tests. *)
1989    "set Augeas path to value",
1990    "\
1991 Set the value associated with C<path> to C<val>.
1992
1993 In the Augeas API, it is possible to clear a node by setting
1994 the value to NULL.  Due to an oversight in the libguestfs API
1995 you cannot do that with this call.  Instead you must use the
1996 C<guestfs_aug_clear> call.");
1997
1998   ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1999    [], (* XXX Augeas code needs tests. *)
2000    "insert a sibling Augeas node",
2001    "\
2002 Create a new sibling C<label> for C<path>, inserting it into
2003 the tree before or after C<path> (depending on the boolean
2004 flag C<before>).
2005
2006 C<path> must match exactly one existing node in the tree, and
2007 C<label> must be a label, ie. not contain C</>, C<*> or end
2008 with a bracketed index C<[N]>.");
2009
2010   ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
2011    [], (* XXX Augeas code needs tests. *)
2012    "remove an Augeas path",
2013    "\
2014 Remove C<path> and all of its children.
2015
2016 On success this returns the number of entries which were removed.");
2017
2018   ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
2019    [], (* XXX Augeas code needs tests. *)
2020    "move Augeas node",
2021    "\
2022 Move the node C<src> to C<dest>.  C<src> must match exactly
2023 one node.  C<dest> is overwritten if it exists.");
2024
2025   ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
2026    [], (* XXX Augeas code needs tests. *)
2027    "return Augeas nodes which match augpath",
2028    "\
2029 Returns a list of paths which match the path expression C<path>.
2030 The returned paths are sufficiently qualified so that they match
2031 exactly one node in the current tree.");
2032
2033   ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
2034    [], (* XXX Augeas code needs tests. *)
2035    "write all pending Augeas changes to disk",
2036    "\
2037 This writes all pending changes to disk.
2038
2039 The flags which were passed to C<guestfs_aug_init> affect exactly
2040 how files are saved.");
2041
2042   ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
2043    [], (* XXX Augeas code needs tests. *)
2044    "load files into the tree",
2045    "\
2046 Load files into the tree.
2047
2048 See C<aug_load> in the Augeas documentation for the full gory
2049 details.");
2050
2051   ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
2052    [], (* XXX Augeas code needs tests. *)
2053    "list Augeas nodes under augpath",
2054    "\
2055 This is just a shortcut for listing C<guestfs_aug_match>
2056 C<path/*> and sorting the resulting nodes into alphabetical order.");
2057
2058   ("rm", (RErr, [Pathname "path"], []), 29, [],
2059    [InitScratchFS, Always, TestRun
2060       [["mkdir"; "/rm"];
2061        ["touch"; "/rm/new"];
2062        ["rm"; "/rm/new"]];
2063     InitScratchFS, Always, TestLastFail
2064       [["rm"; "/nosuchfile"]];
2065     InitScratchFS, Always, TestLastFail
2066       [["mkdir"; "/rm2"];
2067        ["rm"; "/rm2"]]],
2068    "remove a file",
2069    "\
2070 Remove the single file C<path>.");
2071
2072   ("rmdir", (RErr, [Pathname "path"], []), 30, [],
2073    [InitScratchFS, Always, TestRun
2074       [["mkdir"; "/rmdir"];
2075        ["rmdir"; "/rmdir"]];
2076     InitScratchFS, Always, TestLastFail
2077       [["rmdir"; "/rmdir2"]];
2078     InitScratchFS, Always, TestLastFail
2079       [["mkdir"; "/rmdir3"];
2080        ["touch"; "/rmdir3/new"];
2081        ["rmdir"; "/rmdir3/new"]]],
2082    "remove a directory",
2083    "\
2084 Remove the single directory C<path>.");
2085
2086   ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
2087    [InitScratchFS, Always, TestOutputFalse
2088       [["mkdir"; "/rm_rf"];
2089        ["mkdir"; "/rm_rf/foo"];
2090        ["touch"; "/rm_rf/foo/bar"];
2091        ["rm_rf"; "/rm_rf"];
2092        ["exists"; "/rm_rf"]]],
2093    "remove a file or directory recursively",
2094    "\
2095 Remove the file or directory C<path>, recursively removing the
2096 contents if its a directory.  This is like the C<rm -rf> shell
2097 command.");
2098
2099   ("mkdir", (RErr, [Pathname "path"], []), 32, [],
2100    [InitScratchFS, Always, TestOutputTrue
2101       [["mkdir"; "/mkdir"];
2102        ["is_dir"; "/mkdir"]];
2103     InitScratchFS, Always, TestLastFail
2104       [["mkdir"; "/mkdir2/foo/bar"]]],
2105    "create a directory",
2106    "\
2107 Create a directory named C<path>.");
2108
2109   ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
2110    [InitScratchFS, Always, TestOutputTrue
2111       [["mkdir_p"; "/mkdir_p/foo/bar"];
2112        ["is_dir"; "/mkdir_p/foo/bar"]];
2113     InitScratchFS, Always, TestOutputTrue
2114       [["mkdir_p"; "/mkdir_p2/foo/bar"];
2115        ["is_dir"; "/mkdir_p2/foo"]];
2116     InitScratchFS, Always, TestOutputTrue
2117       [["mkdir_p"; "/mkdir_p3/foo/bar"];
2118        ["is_dir"; "/mkdir_p3"]];
2119     (* Regression tests for RHBZ#503133: *)
2120     InitScratchFS, Always, TestRun
2121       [["mkdir"; "/mkdir_p4"];
2122        ["mkdir_p"; "/mkdir_p4"]];
2123     InitScratchFS, Always, TestLastFail
2124       [["touch"; "/mkdir_p5"];
2125        ["mkdir_p"; "/mkdir_p5"]]],
2126    "create a directory and parents",
2127    "\
2128 Create a directory named C<path>, creating any parent directories
2129 as necessary.  This is like the C<mkdir -p> shell command.");
2130
2131   ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
2132    [], (* XXX Need stat command to test *)
2133    "change file mode",
2134    "\
2135 Change the mode (permissions) of C<path> to C<mode>.  Only
2136 numeric modes are supported.
2137
2138 I<Note>: When using this command from guestfish, C<mode>
2139 by default would be decimal, unless you prefix it with
2140 C<0> to get octal, ie. use C<0700> not C<700>.
2141
2142 The mode actually set is affected by the umask.");
2143
2144   ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
2145    [], (* XXX Need stat command to test *)
2146    "change file owner and group",
2147    "\
2148 Change the file owner to C<owner> and group to C<group>.
2149
2150 Only numeric uid and gid are supported.  If you want to use
2151 names, you will need to locate and parse the password file
2152 yourself (Augeas support makes this relatively easy).");
2153
2154   ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
2155    [InitISOFS, Always, TestOutputTrue (
2156       [["exists"; "/empty"]]);
2157     InitISOFS, Always, TestOutputTrue (
2158       [["exists"; "/directory"]])],
2159    "test if file or directory exists",
2160    "\
2161 This returns C<true> if and only if there is a file, directory
2162 (or anything) with the given C<path> name.
2163
2164 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
2165
2166   ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
2167    [InitISOFS, Always, TestOutputTrue (
2168       [["is_file"; "/known-1"]]);
2169     InitISOFS, Always, TestOutputFalse (
2170       [["is_file"; "/directory"]])],
2171    "test if a regular file",
2172    "\
2173 This returns C<true> if and only if there is a regular file
2174 with the given C<path> name.  Note that it returns false for
2175 other objects like directories.
2176
2177 See also C<guestfs_stat>.");
2178
2179   ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
2180    [InitISOFS, Always, TestOutputFalse (
2181       [["is_dir"; "/known-3"]]);
2182     InitISOFS, Always, TestOutputTrue (
2183       [["is_dir"; "/directory"]])],
2184    "test if a directory",
2185    "\
2186 This returns C<true> if and only if there is a directory
2187 with the given C<path> name.  Note that it returns false for
2188 other objects like files.
2189
2190 See also C<guestfs_stat>.");
2191
2192   ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
2193    [InitEmpty, Always, TestOutputListOfDevices (
2194       [["part_init"; "/dev/sda"; "mbr"];
2195        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2196        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2197        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2198        ["pvcreate"; "/dev/sda1"];
2199        ["pvcreate"; "/dev/sda2"];
2200        ["pvcreate"; "/dev/sda3"];
2201        ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
2202    "create an LVM physical volume",
2203    "\
2204 This creates an LVM physical volume on the named C<device>,
2205 where C<device> should usually be a partition name such
2206 as C</dev/sda1>.");
2207
2208   ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
2209    [InitEmpty, Always, TestOutputList (
2210       [["part_init"; "/dev/sda"; "mbr"];
2211        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2212        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2213        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2214        ["pvcreate"; "/dev/sda1"];
2215        ["pvcreate"; "/dev/sda2"];
2216        ["pvcreate"; "/dev/sda3"];
2217        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2218        ["vgcreate"; "VG2"; "/dev/sda3"];
2219        ["vgs"]], ["VG1"; "VG2"])],
2220    "create an LVM volume group",
2221    "\
2222 This creates an LVM volume group called C<volgroup>
2223 from the non-empty list of physical volumes C<physvols>.");
2224
2225   ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
2226    [InitEmpty, Always, TestOutputList (
2227       [["part_init"; "/dev/sda"; "mbr"];
2228        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2229        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2230        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2231        ["pvcreate"; "/dev/sda1"];
2232        ["pvcreate"; "/dev/sda2"];
2233        ["pvcreate"; "/dev/sda3"];
2234        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2235        ["vgcreate"; "VG2"; "/dev/sda3"];
2236        ["lvcreate"; "LV1"; "VG1"; "50"];
2237        ["lvcreate"; "LV2"; "VG1"; "50"];
2238        ["lvcreate"; "LV3"; "VG2"; "50"];
2239        ["lvcreate"; "LV4"; "VG2"; "50"];
2240        ["lvcreate"; "LV5"; "VG2"; "50"];
2241        ["lvs"]],
2242       ["/dev/VG1/LV1"; "/dev/VG1/LV2";
2243        "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
2244    "create an LVM logical volume",
2245    "\
2246 This creates an LVM logical volume called C<logvol>
2247 on the volume group C<volgroup>, with C<size> megabytes.");
2248
2249   ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
2250    [InitEmpty, Always, TestOutput (
2251       [["part_disk"; "/dev/sda"; "mbr"];
2252        ["mkfs"; "ext2"; "/dev/sda1"];
2253        ["mount_options"; ""; "/dev/sda1"; "/"];
2254        ["write"; "/new"; "new file contents"];
2255        ["cat"; "/new"]], "new file contents")],
2256    "make a filesystem",
2257    "\
2258 This creates a filesystem on C<device> (usually a partition
2259 or LVM logical volume).  The filesystem type is C<fstype>, for
2260 example C<ext3>.");
2261
2262   ("sfdisk", (RErr, [Device "device";
2263                      Int "cyls"; Int "heads"; Int "sectors";
2264                      StringList "lines"], []), 43, [DeprecatedBy "part_add"],
2265    [],
2266    "create partitions on a block device",
2267    "\
2268 This is a direct interface to the L<sfdisk(8)> program for creating
2269 partitions on block devices.
2270
2271 C<device> should be a block device, for example C</dev/sda>.
2272
2273 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
2274 and sectors on the device, which are passed directly to sfdisk as
2275 the I<-C>, I<-H> and I<-S> parameters.  If you pass C<0> for any
2276 of these, then the corresponding parameter is omitted.  Usually for
2277 'large' disks, you can just pass C<0> for these, but for small
2278 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
2279 out the right geometry and you will need to tell it.
2280
2281 C<lines> is a list of lines that we feed to C<sfdisk>.  For more
2282 information refer to the L<sfdisk(8)> manpage.
2283
2284 To create a single partition occupying the whole disk, you would
2285 pass C<lines> as a single element list, when the single element being
2286 the string C<,> (comma).
2287
2288 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
2289 C<guestfs_part_init>");
2290
2291   ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
2292    (* Regression test for RHBZ#597135. *)
2293    [InitScratchFS, Always, TestLastFail
2294       [["write_file"; "/write_file"; "abc"; "10000"]]],
2295    "create a file",
2296    "\
2297 This call creates a file called C<path>.  The contents of the
2298 file is the string C<content> (which can contain any 8 bit data),
2299 with length C<size>.
2300
2301 As a special case, if C<size> is C<0>
2302 then the length is calculated using C<strlen> (so in this case
2303 the content cannot contain embedded ASCII NULs).
2304
2305 I<NB.> Owing to a bug, writing content containing ASCII NUL
2306 characters does I<not> work, even if the length is specified.");
2307
2308   ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
2309    [InitEmpty, Always, TestOutputListOfDevices (
2310       [["part_disk"; "/dev/sda"; "mbr"];
2311        ["mkfs"; "ext2"; "/dev/sda1"];
2312        ["mount_options"; ""; "/dev/sda1"; "/"];
2313        ["mounts"]], ["/dev/sda1"]);
2314     InitEmpty, Always, TestOutputList (
2315       [["part_disk"; "/dev/sda"; "mbr"];
2316        ["mkfs"; "ext2"; "/dev/sda1"];
2317        ["mount_options"; ""; "/dev/sda1"; "/"];
2318        ["umount"; "/"];
2319        ["mounts"]], [])],
2320    "unmount a filesystem",
2321    "\
2322 This unmounts the given filesystem.  The filesystem may be
2323 specified either by its mountpoint (path) or the device which
2324 contains the filesystem.");
2325
2326   ("mounts", (RStringList "devices", [], []), 46, [],
2327    [InitScratchFS, Always, TestOutputListOfDevices (
2328       [["mounts"]], ["/dev/sdb1"])],
2329    "show mounted filesystems",
2330    "\
2331 This returns the list of currently mounted filesystems.  It returns
2332 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
2333
2334 Some internal mounts are not shown.
2335
2336 See also: C<guestfs_mountpoints>");
2337
2338   ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
2339    [InitScratchFS, Always, TestOutputList (
2340       [["umount_all"];
2341        ["mounts"]], []);
2342     (* check that umount_all can unmount nested mounts correctly: *)
2343     InitEmpty, Always, TestOutputList (
2344       [["part_init"; "/dev/sda"; "mbr"];
2345        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2346        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2347        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2348        ["mkfs"; "ext2"; "/dev/sda1"];
2349        ["mkfs"; "ext2"; "/dev/sda2"];
2350        ["mkfs"; "ext2"; "/dev/sda3"];
2351        ["mount_options"; ""; "/dev/sda1"; "/"];
2352        ["mkdir"; "/mp1"];
2353        ["mount_options"; ""; "/dev/sda2"; "/mp1"];
2354        ["mkdir"; "/mp1/mp2"];
2355        ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
2356        ["mkdir"; "/mp1/mp2/mp3"];
2357        ["umount_all"];
2358        ["mounts"]], [])],
2359    "unmount all filesystems",
2360    "\
2361 This unmounts all mounted filesystems.
2362
2363 Some internal mounts are not unmounted by this call.");
2364
2365   ("lvm_remove_all", (RErr, [], []), 48, [Optional "lvm2"],
2366    [],
2367    "remove all LVM LVs, VGs and PVs",
2368    "\
2369 This command removes all LVM logical volumes, volume groups
2370 and physical volumes.");
2371
2372   ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2373    [InitISOFS, Always, TestOutput (
2374       [["file"; "/empty"]], "empty");
2375     InitISOFS, Always, TestOutput (
2376       [["file"; "/known-1"]], "ASCII text");
2377     InitISOFS, Always, TestLastFail (
2378       [["file"; "/notexists"]]);
2379     InitISOFS, Always, TestOutput (
2380       [["file"; "/abssymlink"]], "symbolic link");
2381     InitISOFS, Always, TestOutput (
2382       [["file"; "/directory"]], "directory")],
2383    "determine file type",
2384    "\
2385 This call uses the standard L<file(1)> command to determine
2386 the type or contents of the file.
2387
2388 This call will also transparently look inside various types
2389 of compressed file.
2390
2391 The exact command which runs is C<file -zb path>.  Note in
2392 particular that the filename is not prepended to the output
2393 (the I<-b> option).
2394
2395 The output depends on the output of the underlying L<file(1)>
2396 command and it can change in future in ways beyond our control.
2397 In other words, the output is not guaranteed by the ABI.
2398
2399 See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>,
2400 C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>.");
2401
2402   ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2403    [InitScratchFS, Always, TestOutput (
2404       [["mkdir"; "/command"];
2405        ["upload"; "test-command"; "/command/test-command"];
2406        ["chmod"; "0o755"; "/command/test-command"];
2407        ["command"; "/command/test-command 1"]], "Result1");
2408     InitScratchFS, Always, TestOutput (
2409       [["mkdir"; "/command2"];
2410        ["upload"; "test-command"; "/command2/test-command"];
2411        ["chmod"; "0o755"; "/command2/test-command"];
2412        ["command"; "/command2/test-command 2"]], "Result2\n");
2413     InitScratchFS, Always, TestOutput (
2414       [["mkdir"; "/command3"];
2415        ["upload"; "test-command"; "/command3/test-command"];
2416        ["chmod"; "0o755"; "/command3/test-command"];
2417        ["command"; "/command3/test-command 3"]], "\nResult3");
2418     InitScratchFS, Always, TestOutput (
2419       [["mkdir"; "/command4"];
2420        ["upload"; "test-command"; "/command4/test-command"];
2421        ["chmod"; "0o755"; "/command4/test-command"];
2422        ["command"; "/command4/test-command 4"]], "\nResult4\n");
2423     InitScratchFS, Always, TestOutput (
2424       [["mkdir"; "/command5"];
2425        ["upload"; "test-command"; "/command5/test-command"];
2426        ["chmod"; "0o755"; "/command5/test-command"];
2427        ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2428     InitScratchFS, Always, TestOutput (
2429       [["mkdir"; "/command6"];
2430        ["upload"; "test-command"; "/command6/test-command"];
2431        ["chmod"; "0o755"; "/command6/test-command"];
2432        ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2433     InitScratchFS, Always, TestOutput (
2434       [["mkdir"; "/command7"];
2435        ["upload"; "test-command"; "/command7/test-command"];
2436        ["chmod"; "0o755"; "/command7/test-command"];
2437        ["command"; "/command7/test-command 7"]], "");
2438     InitScratchFS, Always, TestOutput (
2439       [["mkdir"; "/command8"];
2440        ["upload"; "test-command"; "/command8/test-command"];
2441        ["chmod"; "0o755"; "/command8/test-command"];
2442        ["command"; "/command8/test-command 8"]], "\n");
2443     InitScratchFS, Always, TestOutput (
2444       [["mkdir"; "/command9"];
2445        ["upload"; "test-command"; "/command9/test-command"];
2446        ["chmod"; "0o755"; "/command9/test-command"];
2447        ["command"; "/command9/test-command 9"]], "\n\n");
2448     InitScratchFS, Always, TestOutput (
2449       [["mkdir"; "/command10"];
2450        ["upload"; "test-command"; "/command10/test-command"];
2451        ["chmod"; "0o755"; "/command10/test-command"];
2452        ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2453     InitScratchFS, Always, TestOutput (
2454       [["mkdir"; "/command11"];
2455        ["upload"; "test-command"; "/command11/test-command"];
2456        ["chmod"; "0o755"; "/command11/test-command"];
2457        ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2458     InitScratchFS, Always, TestLastFail (
2459       [["mkdir"; "/command12"];
2460        ["upload"; "test-command"; "/command12/test-command"];
2461        ["chmod"; "0o755"; "/command12/test-command"];
2462        ["command"; "/command12/test-command"]])],
2463    "run a command from the guest filesystem",
2464    "\
2465 This call runs a command from the guest filesystem.  The
2466 filesystem must be mounted, and must contain a compatible
2467 operating system (ie. something Linux, with the same
2468 or compatible processor architecture).
2469
2470 The single parameter is an argv-style list of arguments.
2471 The first element is the name of the program to run.
2472 Subsequent elements are parameters.  The list must be
2473 non-empty (ie. must contain a program name).  Note that
2474 the command runs directly, and is I<not> invoked via
2475 the shell (see C<guestfs_sh>).
2476
2477 The return value is anything printed to I<stdout> by
2478 the command.
2479
2480 If the command returns a non-zero exit status, then
2481 this function returns an error message.  The error message
2482 string is the content of I<stderr> from the command.
2483
2484 The C<$PATH> environment variable will contain at least
2485 C</usr/bin> and C</bin>.  If you require a program from
2486 another location, you should provide the full path in the
2487 first parameter.
2488
2489 Shared libraries and data files required by the program
2490 must be available on filesystems which are mounted in the
2491 correct places.  It is the caller's responsibility to ensure
2492 all filesystems that are needed are mounted at the right
2493 locations.");
2494
2495   ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2496    [InitScratchFS, Always, TestOutputList (
2497       [["mkdir"; "/command_lines"];
2498        ["upload"; "test-command"; "/command_lines/test-command"];
2499        ["chmod"; "0o755"; "/command_lines/test-command"];
2500        ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2501     InitScratchFS, Always, TestOutputList (
2502       [["mkdir"; "/command_lines2"];
2503        ["upload"; "test-command"; "/command_lines2/test-command"];
2504        ["chmod"; "0o755"; "/command_lines2/test-command"];
2505        ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2506     InitScratchFS, Always, TestOutputList (
2507       [["mkdir"; "/command_lines3"];
2508        ["upload"; "test-command"; "/command_lines3/test-command"];
2509        ["chmod"; "0o755"; "/command_lines3/test-command"];
2510        ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2511     InitScratchFS, Always, TestOutputList (
2512       [["mkdir"; "/command_lines4"];
2513        ["upload"; "test-command"; "/command_lines4/test-command"];
2514        ["chmod"; "0o755"; "/command_lines4/test-command"];
2515        ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2516     InitScratchFS, Always, TestOutputList (
2517       [["mkdir"; "/command_lines5"];
2518        ["upload"; "test-command"; "/command_lines5/test-command"];
2519        ["chmod"; "0o755"; "/command_lines5/test-command"];
2520        ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2521     InitScratchFS, Always, TestOutputList (
2522       [["mkdir"; "/command_lines6"];
2523        ["upload"; "test-command"; "/command_lines6/test-command"];
2524        ["chmod"; "0o755"; "/command_lines6/test-command"];
2525        ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2526     InitScratchFS, Always, TestOutputList (
2527       [["mkdir"; "/command_lines7"];
2528        ["upload"; "test-command"; "/command_lines7/test-command"];
2529        ["chmod"; "0o755"; "/command_lines7/test-command"];
2530        ["command_lines"; "/command_lines7/test-command 7"]], []);
2531     InitScratchFS, Always, TestOutputList (
2532       [["mkdir"; "/command_lines8"];
2533        ["upload"; "test-command"; "/command_lines8/test-command"];
2534        ["chmod"; "0o755"; "/command_lines8/test-command"];
2535        ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2536     InitScratchFS, Always, TestOutputList (
2537       [["mkdir"; "/command_lines9"];
2538        ["upload"; "test-command"; "/command_lines9/test-command"];
2539        ["chmod"; "0o755"; "/command_lines9/test-command"];
2540        ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2541     InitScratchFS, Always, TestOutputList (
2542       [["mkdir"; "/command_lines10"];
2543        ["upload"; "test-command"; "/command_lines10/test-command"];
2544        ["chmod"; "0o755"; "/command_lines10/test-command"];
2545        ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2546     InitScratchFS, Always, TestOutputList (
2547       [["mkdir"; "/command_lines11"];
2548        ["upload"; "test-command"; "/command_lines11/test-command"];
2549        ["chmod"; "0o755"; "/command_lines11/test-command"];
2550        ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2551    "run a command, returning lines",
2552    "\
2553 This is the same as C<guestfs_command>, but splits the
2554 result into a list of lines.
2555
2556 See also: C<guestfs_sh_lines>");
2557
2558   ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2559    [InitISOFS, Always, TestOutputStruct (
2560       [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2561    "get file information",
2562    "\
2563 Returns file information for the given C<path>.
2564
2565 This is the same as the C<stat(2)> system call.");
2566
2567   ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2568    [InitISOFS, Always, TestOutputStruct (
2569       [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2570    "get file information for a symbolic link",
2571    "\
2572 Returns file information for the given C<path>.
2573
2574 This is the same as C<guestfs_stat> except that if C<path>
2575 is a symbolic link, then the link is stat-ed, not the file it
2576 refers to.
2577
2578 This is the same as the C<lstat(2)> system call.");
2579
2580   ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2581    [InitISOFS, Always, TestOutputStruct (
2582       [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2583    "get file system statistics",
2584    "\
2585 Returns file system statistics for any mounted file system.
2586 C<path> should be a file or directory in the mounted file system
2587 (typically it is the mount point itself, but it doesn't need to be).
2588
2589 This is the same as the C<statvfs(2)> system call.");
2590
2591   ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2592    [InitScratchFS, Always, TestOutputHashtable (
2593       [["tune2fs_l"; "/dev/sdb1"]],
2594       ["Filesystem magic number", "0xEF53";
2595        "Filesystem OS type", "Linux"])],
2596    "get ext2/ext3/ext4 superblock details",
2597    "\
2598 This returns the contents of the ext2, ext3 or ext4 filesystem
2599 superblock on C<device>.
2600
2601 It is the same as running C<tune2fs -l device>.  See L<tune2fs(8)>
2602 manpage for more details.  The list of fields returned isn't
2603 clearly defined, and depends on both the version of C<tune2fs>
2604 that libguestfs was built against, and the filesystem itself.");
2605
2606   ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2607    [InitEmpty, Always, TestOutputTrue (
2608       [["blockdev_setro"; "/dev/sda"];
2609        ["blockdev_getro"; "/dev/sda"]])],
2610    "set block device to read-only",
2611    "\
2612 Sets the block device named C<device> to read-only.
2613
2614 This uses the L<blockdev(8)> command.");
2615
2616   ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2617    [InitEmpty, Always, TestOutputFalse (
2618       [["blockdev_setrw"; "/dev/sda"];
2619        ["blockdev_getro"; "/dev/sda"]])],
2620    "set block device to read-write",
2621    "\
2622 Sets the block device named C<device> to read-write.
2623
2624 This uses the L<blockdev(8)> command.");
2625
2626   ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2627    [InitEmpty, Always, TestOutputTrue (
2628       [["blockdev_setro"; "/dev/sda"];
2629        ["blockdev_getro"; "/dev/sda"]])],
2630    "is block device set to read-only",
2631    "\
2632 Returns a boolean indicating if the block device is read-only
2633 (true if read-only, false if not).
2634
2635 This uses the L<blockdev(8)> command.");
2636
2637   ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2638    [InitEmpty, Always, TestOutputInt (
2639       [["blockdev_getss"; "/dev/sda"]], 512)],
2640    "get sectorsize of block device",
2641    "\
2642 This returns the size of sectors on a block device.
2643 Usually 512, but can be larger for modern devices.
2644
2645 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2646 for that).
2647
2648 This uses the L<blockdev(8)> command.");
2649
2650   ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2651    [InitEmpty, Always, TestOutputInt (
2652       [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2653    "get blocksize of block device",
2654    "\
2655 This returns the block size of a device.
2656
2657 (Note this is different from both I<size in blocks> and
2658 I<filesystem block size>).
2659
2660 This uses the L<blockdev(8)> command.");
2661
2662   ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2663    [], (* XXX test *)
2664    "set blocksize of block device",
2665    "\
2666 This sets the block size of a device.
2667
2668 (Note this is different from both I<size in blocks> and
2669 I<filesystem block size>).
2670
2671 This uses the L<blockdev(8)> command.");
2672
2673   ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2674    [InitEmpty, Always, TestOutputInt (
2675       [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2676    "get total size of device in 512-byte sectors",
2677    "\
2678 This returns the size of the device in units of 512-byte sectors
2679 (even if the sectorsize isn't 512 bytes ... weird).
2680
2681 See also C<guestfs_blockdev_getss> for the real sector size of
2682 the device, and C<guestfs_blockdev_getsize64> for the more
2683 useful I<size in bytes>.
2684
2685 This uses the L<blockdev(8)> command.");
2686
2687   ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2688    [InitEmpty, Always, TestOutputInt (
2689       [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2690    "get total size of device in bytes",
2691    "\
2692 This returns the size of the device in bytes.
2693
2694 See also C<guestfs_blockdev_getsz>.
2695
2696 This uses the L<blockdev(8)> command.");
2697
2698   ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2699    [InitEmpty, Always, TestRun
2700       [["blockdev_flushbufs"; "/dev/sda"]]],
2701    "flush device buffers",
2702    "\
2703 This tells the kernel to flush internal buffers associated
2704 with C<device>.
2705
2706 This uses the L<blockdev(8)> command.");
2707
2708   ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2709    [InitEmpty, Always, TestRun
2710       [["blockdev_rereadpt"; "/dev/sda"]]],
2711    "reread partition table",
2712    "\
2713 Reread the partition table on C<device>.
2714
2715 This uses the L<blockdev(8)> command.");
2716
2717   ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2718    [InitScratchFS, Always, TestOutput (
2719       (* Pick a file from cwd which isn't likely to change. *)
2720       [["mkdir"; "/upload"];
2721        ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2722        ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2723       Digest.to_hex (Digest.file "COPYING.LIB"))],
2724    "upload a file from the local machine",
2725    "\
2726 Upload local file C<filename> to C<remotefilename> on the
2727 filesystem.
2728
2729 C<filename> can also be a named pipe.
2730
2731 See also C<guestfs_download>.");
2732
2733   ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2734    [InitScratchFS, Always, TestOutput (
2735       (* Pick a file from cwd which isn't likely to change. *)
2736       [["mkdir"; "/download"];
2737        ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2738        ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2739        ["upload"; "testdownload.tmp"; "/download/upload"];
2740        ["checksum"; "md5"; "/download/upload"]],
2741       Digest.to_hex (Digest.file "COPYING.LIB"))],
2742    "download a file to the local machine",
2743    "\
2744 Download file C<remotefilename> and save it as C<filename>
2745 on the local machine.
2746
2747 C<filename> can also be a named pipe.
2748
2749 See also C<guestfs_upload>, C<guestfs_cat>.");
2750
2751   ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2752    [InitISOFS, Always, TestOutput (
2753       [["checksum"; "crc"; "/known-3"]], "2891671662");
2754     InitISOFS, Always, TestLastFail (
2755       [["checksum"; "crc"; "/notexists"]]);
2756     InitISOFS, Always, TestOutput (
2757       [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2758     InitISOFS, Always, TestOutput (
2759       [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2760     InitISOFS, Always, TestOutput (
2761       [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2762     InitISOFS, Always, TestOutput (
2763       [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2764     InitISOFS, Always, TestOutput (
2765       [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2766     InitISOFS, Always, TestOutput (
2767       [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2768     (* Test for RHBZ#579608, absolute symbolic links. *)
2769     InitISOFS, Always, TestOutput (
2770       [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2771    "compute MD5, SHAx or CRC checksum of file",
2772    "\
2773 This call computes the MD5, SHAx or CRC checksum of the
2774 file named C<path>.
2775
2776 The type of checksum to compute is given by the C<csumtype>
2777 parameter which must have one of the following values:
2778
2779 =over 4
2780
2781 =item C<crc>
2782
2783 Compute the cyclic redundancy check (CRC) specified by POSIX
2784 for the C<cksum> command.
2785
2786 =item C<md5>
2787
2788 Compute the MD5 hash (using the C<md5sum> program).
2789
2790 =item C<sha1>
2791
2792 Compute the SHA1 hash (using the C<sha1sum> program).
2793
2794 =item C<sha224>
2795
2796 Compute the SHA224 hash (using the C<sha224sum> program).
2797
2798 =item C<sha256>
2799
2800 Compute the SHA256 hash (using the C<sha256sum> program).
2801
2802 =item C<sha384>
2803
2804 Compute the SHA384 hash (using the C<sha384sum> program).
2805
2806 =item C<sha512>
2807
2808 Compute the SHA512 hash (using the C<sha512sum> program).
2809
2810 =back
2811
2812 The checksum is returned as a printable string.
2813
2814 To get the checksum for a device, use C<guestfs_checksum_device>.
2815
2816 To get the checksums for many files, use C<guestfs_checksums_out>.");
2817
2818   ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2819    [InitScratchFS, Always, TestOutput (
2820       [["mkdir"; "/tar_in"];
2821        ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2822        ["cat"; "/tar_in/hello"]], "hello\n")],
2823    "unpack tarfile to directory",
2824    "\
2825 This command uploads and unpacks local file C<tarfile> (an
2826 I<uncompressed> tar file) into C<directory>.
2827
2828 To upload a compressed tarball, use C<guestfs_tgz_in>
2829 or C<guestfs_txz_in>.");
2830
2831   ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2832    [],
2833    "pack directory into tarfile",
2834    "\
2835 This command packs the contents of C<directory> and downloads
2836 it to local file C<tarfile>.
2837
2838 To download a compressed tarball, use C<guestfs_tgz_out>
2839 or C<guestfs_txz_out>.");
2840
2841   ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2842    [InitScratchFS, Always, TestOutput (
2843       [["mkdir"; "/tgz_in"];
2844        ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2845        ["cat"; "/tgz_in/hello"]], "hello\n")],
2846    "unpack compressed tarball to directory",
2847    "\
2848 This command uploads and unpacks local file C<tarball> (a
2849 I<gzip compressed> tar file) into C<directory>.
2850
2851 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2852
2853   ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2854    [],
2855    "pack directory into compressed tarball",
2856    "\
2857 This command packs the contents of C<directory> and downloads
2858 it to local file C<tarball>.
2859
2860 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2861
2862   ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2863    [InitBasicFS, Always, TestLastFail (
2864       [["umount"; "/"];
2865        ["mount_ro"; "/dev/sda1"; "/"];
2866        ["touch"; "/new"]]);
2867     InitBasicFS, Always, TestOutput (
2868       [["write"; "/new"; "data"];
2869        ["umount"; "/"];
2870        ["mount_ro"; "/dev/sda1"; "/"];
2871        ["cat"; "/new"]], "data")],
2872    "mount a guest disk, read-only",
2873    "\
2874 This is the same as the C<guestfs_mount> command, but it
2875 mounts the filesystem with the read-only (I<-o ro>) flag.");
2876
2877   ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2878    [],
2879    "mount a guest disk with mount options",
2880    "\
2881 This is the same as the C<guestfs_mount> command, but it
2882 allows you to set the mount options as for the
2883 L<mount(8)> I<-o> flag.
2884
2885 If the C<options> parameter is an empty string, then
2886 no options are passed (all options default to whatever
2887 the filesystem uses).");
2888
2889   ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2890    [],
2891    "mount a guest disk with mount options and vfstype",
2892    "\
2893 This is the same as the C<guestfs_mount> command, but it
2894 allows you to set both the mount options and the vfstype
2895 as for the L<mount(8)> I<-o> and I<-t> flags.");
2896
2897   ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2898    [],
2899    "debugging and internals",
2900    "\
2901 The C<guestfs_debug> command exposes some internals of
2902 C<guestfsd> (the guestfs daemon) that runs inside the
2903 qemu subprocess.
2904
2905 There is no comprehensive help for this command.  You have
2906 to look at the file C<daemon/debug.c> in the libguestfs source
2907 to find out what you can do.");
2908
2909   ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2910    [InitEmpty, Always, TestOutputList (
2911       [["part_disk"; "/dev/sda"; "mbr"];
2912        ["pvcreate"; "/dev/sda1"];
2913        ["vgcreate"; "VG"; "/dev/sda1"];
2914        ["lvcreate"; "LV1"; "VG"; "50"];
2915        ["lvcreate"; "LV2"; "VG"; "50"];
2916        ["lvremove"; "/dev/VG/LV1"];
2917        ["lvs"]], ["/dev/VG/LV2"]);
2918     InitEmpty, Always, TestOutputList (
2919       [["part_disk"; "/dev/sda"; "mbr"];
2920        ["pvcreate"; "/dev/sda1"];
2921        ["vgcreate"; "VG"; "/dev/sda1"];
2922        ["lvcreate"; "LV1"; "VG"; "50"];
2923        ["lvcreate"; "LV2"; "VG"; "50"];
2924        ["lvremove"; "/dev/VG"];
2925        ["lvs"]], []);
2926     InitEmpty, Always, TestOutputList (
2927       [["part_disk"; "/dev/sda"; "mbr"];
2928        ["pvcreate"; "/dev/sda1"];
2929        ["vgcreate"; "VG"; "/dev/sda1"];
2930        ["lvcreate"; "LV1"; "VG"; "50"];
2931        ["lvcreate"; "LV2"; "VG"; "50"];
2932        ["lvremove"; "/dev/VG"];
2933        ["vgs"]], ["VG"])],
2934    "remove an LVM logical volume",
2935    "\
2936 Remove an LVM logical volume C<device>, where C<device> is
2937 the path to the LV, such as C</dev/VG/LV>.
2938
2939 You can also remove all LVs in a volume group by specifying
2940 the VG name, C</dev/VG>.");
2941
2942   ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2943    [InitEmpty, Always, TestOutputList (
2944       [["part_disk"; "/dev/sda"; "mbr"];
2945        ["pvcreate"; "/dev/sda1"];
2946        ["vgcreate"; "VG"; "/dev/sda1"];
2947        ["lvcreate"; "LV1"; "VG"; "50"];
2948        ["lvcreate"; "LV2"; "VG"; "50"];
2949        ["vgremove"; "VG"];
2950        ["lvs"]], []);
2951     InitEmpty, Always, TestOutputList (
2952       [["part_disk"; "/dev/sda"; "mbr"];
2953        ["pvcreate"; "/dev/sda1"];
2954        ["vgcreate"; "VG"; "/dev/sda1"];
2955        ["lvcreate"; "LV1"; "VG"; "50"];
2956        ["lvcreate"; "LV2"; "VG"; "50"];
2957        ["vgremove"; "VG"];
2958        ["vgs"]], [])],
2959    "remove an LVM volume group",
2960    "\
2961 Remove an LVM volume group C<vgname>, (for example C<VG>).
2962
2963 This also forcibly removes all logical volumes in the volume
2964 group (if any).");
2965
2966   ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2967    [InitEmpty, Always, TestOutputListOfDevices (
2968       [["part_disk"; "/dev/sda"; "mbr"];
2969        ["pvcreate"; "/dev/sda1"];
2970        ["vgcreate"; "VG"; "/dev/sda1"];
2971        ["lvcreate"; "LV1"; "VG"; "50"];
2972        ["lvcreate"; "LV2"; "VG"; "50"];
2973        ["vgremove"; "VG"];
2974        ["pvremove"; "/dev/sda1"];
2975        ["lvs"]], []);
2976     InitEmpty, Always, TestOutputListOfDevices (
2977       [["part_disk"; "/dev/sda"; "mbr"];
2978        ["pvcreate"; "/dev/sda1"];
2979        ["vgcreate"; "VG"; "/dev/sda1"];
2980        ["lvcreate"; "LV1"; "VG"; "50"];
2981        ["lvcreate"; "LV2"; "VG"; "50"];
2982        ["vgremove"; "VG"];
2983        ["pvremove"; "/dev/sda1"];
2984        ["vgs"]], []);
2985     InitEmpty, Always, TestOutputListOfDevices (
2986       [["part_disk"; "/dev/sda"; "mbr"];
2987        ["pvcreate"; "/dev/sda1"];
2988        ["vgcreate"; "VG"; "/dev/sda1"];
2989        ["lvcreate"; "LV1"; "VG"; "50"];
2990        ["lvcreate"; "LV2"; "VG"; "50"];
2991        ["vgremove"; "VG"];
2992        ["pvremove"; "/dev/sda1"];
2993        ["pvs"]], [])],
2994    "remove an LVM physical volume",
2995    "\
2996 This wipes a physical volume C<device> so that LVM will no longer
2997 recognise it.
2998
2999 The implementation uses the C<pvremove> command which refuses to
3000 wipe physical volumes that contain any volume groups, so you have
3001 to remove those first.");
3002
3003   ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
3004    [InitBasicFS, Always, TestOutput (
3005       [["set_e2label"; "/dev/sda1"; "testlabel"];
3006        ["get_e2label"; "/dev/sda1"]], "testlabel")],
3007    "set the ext2/3/4 filesystem label",
3008    "\
3009 This sets the ext2/3/4 filesystem label of the filesystem on
3010 C<device> to C<label>.  Filesystem labels are limited to
3011 16 characters.
3012
3013 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
3014 to return the existing label on a filesystem.");
3015
3016   ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
3017    [],
3018    "get the ext2/3/4 filesystem label",
3019    "\
3020 This returns the ext2/3/4 filesystem label of the filesystem on
3021 C<device>.");
3022
3023   ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
3024    (let uuid = uuidgen () in
3025     [InitBasicFS, Always, TestOutput (
3026        [["set_e2uuid"; "/dev/sda1"; uuid];
3027         ["get_e2uuid"; "/dev/sda1"]], uuid);
3028      InitBasicFS, Always, TestOutput (
3029        [["set_e2uuid"; "/dev/sda1"; "clear"];
3030         ["get_e2uuid"; "/dev/sda1"]], "");
3031      (* We can't predict what UUIDs will be, so just check the commands run. *)
3032      InitBasicFS, Always, TestRun (
3033        [["set_e2uuid"; "/dev/sda1"; "random"]]);
3034      InitBasicFS, Always, TestRun (
3035        [["set_e2uuid"; "/dev/sda1"; "time"]])]),
3036    "set the ext2/3/4 filesystem UUID",
3037    "\
3038 This sets the ext2/3/4 filesystem UUID of the filesystem on
3039 C<device> to C<uuid>.  The format of the UUID and alternatives
3040 such as C<clear>, C<random> and C<time> are described in the
3041 L<tune2fs(8)> manpage.
3042
3043 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
3044 to return the existing UUID of a filesystem.");
3045
3046   ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
3047    (* Regression test for RHBZ#597112. *)
3048    (let uuid = uuidgen () in
3049     [InitNone, Always, TestOutput (
3050        [["mke2journal"; "1024"; "/dev/sdc"];
3051         ["set_e2uuid"; "/dev/sdc"; uuid];
3052         ["get_e2uuid"; "/dev/sdc"]], uuid)]),
3053    "get the ext2/3/4 filesystem UUID",
3054    "\
3055 This returns the ext2/3/4 filesystem UUID of the filesystem on
3056 C<device>.");
3057
3058   ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
3059    [InitBasicFS, Always, TestOutputInt (
3060       [["umount"; "/dev/sda1"];
3061        ["fsck"; "ext2"; "/dev/sda1"]], 0);
3062     InitBasicFS, Always, TestOutputInt (
3063       [["umount"; "/dev/sda1"];
3064        ["zero"; "/dev/sda1"];
3065        ["fsck"; "ext2"; "/dev/sda1"]], 8)],
3066    "run the filesystem checker",
3067    "\
3068 This runs the filesystem checker (fsck) on C<device> which
3069 should have filesystem type C<fstype>.
3070
3071 The returned integer is the status.  See L<fsck(8)> for the
3072 list of status codes from C<fsck>.
3073
3074 Notes:
3075
3076 =over 4
3077
3078 =item *
3079
3080 Multiple status codes can be summed together.
3081
3082 =item *
3083
3084 A non-zero return code can mean \"success\", for example if
3085 errors have been corrected on the filesystem.
3086
3087 =item *
3088
3089 Checking or repairing NTFS volumes is not supported
3090 (by linux-ntfs).
3091
3092 =back
3093
3094 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
3095
3096   ("zero", (RErr, [Device "device"], []), 85, [Progress],
3097    [InitBasicFS, Always, TestRun (
3098       [["umount"; "/dev/sda1"];
3099        ["zero"; "/dev/sda1"]])],
3100    "write zeroes to the device",
3101    "\
3102 This command writes zeroes over the first few blocks of C<device>.
3103
3104 How many blocks are zeroed isn't specified (but it's I<not> enough
3105 to securely wipe the device).  It should be sufficient to remove
3106 any partition tables, filesystem superblocks and so on.
3107
3108 If blocks are already zero, then this command avoids writing
3109 zeroes.  This prevents the underlying device from becoming non-sparse
3110 or growing unnecessarily.
3111
3112 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>,
3113 C<guestfs_is_zero_device>");
3114
3115   ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [Optional "grub"],
3116    (* See:
3117     * https://bugzilla.redhat.com/show_bug.cgi?id=484986
3118     * https://bugzilla.redhat.com/show_bug.cgi?id=479760
3119     *)
3120    [InitBasicFS, Always, TestOutputTrue (
3121       [["mkdir_p"; "/boot/grub"];
3122        ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
3123        ["grub_install"; "/"; "/dev/vda"];
3124        ["is_dir"; "/boot"]])],
3125    "install GRUB 1",
3126    "\
3127 This command installs GRUB 1 (the Grand Unified Bootloader) on
3128 C<device>, with the root directory being C<root>.
3129
3130 Notes:
3131
3132 =over 4
3133
3134 =item *
3135
3136 There is currently no way in the API to install grub2, which
3137 is used by most modern Linux guests.  It is possible to run
3138 the grub2 command from the guest, although see the
3139 caveats in L<guestfs(3)/RUNNING COMMANDS>.
3140
3141 =item *
3142
3143 This uses C<grub-install> from the host.  Unfortunately grub is
3144 not always compatible with itself, so this only works in rather
3145 narrow circumstances.  Careful testing with each guest version
3146 is advisable.
3147
3148 =item *
3149
3150 If grub-install reports the error
3151 \"No suitable drive was found in the generated device map.\"
3152 it may be that you need to create a C</boot/grub/device.map>
3153 file first that contains the mapping between grub device names
3154 and Linux device names.  It is usually sufficient to create
3155 a file containing:
3156
3157  (hd0) /dev/vda
3158
3159 replacing C</dev/vda> with the name of the installation device.
3160
3161 =back");
3162
3163   ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
3164    [InitScratchFS, Always, TestOutput (
3165       [["mkdir"; "/cp"];
3166        ["write"; "/cp/old"; "file content"];
3167        ["cp"; "/cp/old"; "/cp/new"];
3168        ["cat"; "/cp/new"]], "file content");
3169     InitScratchFS, Always, TestOutputTrue (
3170       [["mkdir"; "/cp2"];
3171        ["write"; "/cp2/old"; "file content"];
3172        ["cp"; "/cp2/old"; "/cp2/new"];
3173        ["is_file"; "/cp2/old"]]);
3174     InitScratchFS, Always, TestOutput (
3175       [["mkdir"; "/cp3"];
3176        ["write"; "/cp3/old"; "file content"];
3177        ["mkdir"; "/cp3/dir"];
3178        ["cp"; "/cp3/old"; "/cp3/dir/new"];
3179        ["cat"; "/cp3/dir/new"]], "file content")],
3180    "copy a file",
3181    "\
3182 This copies a file from C<src> to C<dest> where C<dest> is
3183 either a destination filename or destination directory.");
3184
3185   ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
3186    [InitScratchFS, Always, TestOutput (
3187       [["mkdir"; "/cp_a1"];
3188        ["mkdir"; "/cp_a2"];
3189        ["write"; "/cp_a1/file"; "file content"];
3190        ["cp_a"; "/cp_a1"; "/cp_a2"];
3191        ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
3192    "copy a file or directory recursively",
3193    "\
3194 This copies a file or directory from C<src> to C<dest>
3195 recursively using the C<cp -a> command.");
3196
3197   ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
3198    [InitScratchFS, Always, TestOutput (
3199       [["mkdir"; "/mv"];
3200        ["write"; "/mv/old"; "file content"];
3201        ["mv"; "/mv/old"; "/mv/new"];
3202        ["cat"; "/mv/new"]], "file content");
3203     InitScratchFS, Always, TestOutputFalse (
3204       [["mkdir"; "/mv2"];
3205        ["write"; "/mv2/old"; "file content"];
3206        ["mv"; "/mv2/old"; "/mv2/new"];
3207        ["is_file"; "/mv2/old"]])],
3208    "move a file",
3209    "\
3210 This moves a file from C<src> to C<dest> where C<dest> is
3211 either a destination filename or destination directory.");
3212
3213   ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
3214    [InitEmpty, Always, TestRun (
3215       [["drop_caches"; "3"]])],
3216    "drop kernel page cache, dentries and inodes",
3217    "\
3218 This instructs the guest kernel to drop its page cache,
3219 and/or dentries and inode caches.  The parameter C<whattodrop>
3220 tells the kernel what precisely to drop, see
3221 L<http://linux-mm.org/Drop_Caches>
3222
3223 Setting C<whattodrop> to 3 should drop everything.
3224
3225 This automatically calls L<sync(2)> before the operation,
3226 so that the maximum guest memory is freed.");
3227
3228   ("dmesg", (RString "kmsgs", [], []), 91, [],
3229    [InitEmpty, Always, TestRun (
3230       [["dmesg"]])],
3231    "return kernel messages",
3232    "\
3233 This returns the kernel messages (C<dmesg> output) from
3234 the guest kernel.  This is sometimes useful for extended
3235 debugging of problems.
3236
3237 Another way to get the same information is to enable
3238 verbose messages with C<guestfs_set_verbose> or by setting
3239 the environment variable C<LIBGUESTFS_DEBUG=1> before
3240 running the program.");
3241
3242   ("ping_daemon", (RErr, [], []), 92, [],
3243    [InitEmpty, Always, TestRun (
3244       [["ping_daemon"]])],
3245    "ping the guest daemon",
3246    "\
3247 This is a test probe into the guestfs daemon running inside
3248 the qemu subprocess.  Calling this function checks that the
3249 daemon responds to the ping message, without affecting the daemon
3250 or attached block device(s) in any other way.");
3251
3252   ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
3253    [InitScratchFS, Always, TestOutputTrue (
3254       [["mkdir"; "/equal"];
3255        ["write"; "/equal/file1"; "contents of a file"];
3256        ["cp"; "/equal/file1"; "/equal/file2"];
3257        ["equal"; "/equal/file1"; "/equal/file2"]]);
3258     InitScratchFS, Always, TestOutputFalse (
3259       [["mkdir"; "/equal2"];
3260        ["write"; "/equal2/file1"; "contents of a file"];
3261        ["write"; "/equal2/file2"; "contents of another file"];
3262        ["equal"; "/equal2/file1"; "/equal2/file2"]]);
3263     InitScratchFS, Always, TestLastFail (
3264       [["mkdir"; "/equal3"];
3265        ["equal"; "/equal3/file1"; "/equal3/file2"]])],
3266    "test if two files have equal contents",
3267    "\
3268 This compares the two files C<file1> and C<file2> and returns
3269 true if their content is exactly equal, or false otherwise.
3270
3271 The external L<cmp(1)> program is used for the comparison.");
3272
3273   ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
3274    [InitISOFS, Always, TestOutputList (
3275       [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
3276     InitISOFS, Always, TestOutputList (
3277       [["strings"; "/empty"]], []);
3278     (* Test for RHBZ#579608, absolute symbolic links. *)
3279     InitISOFS, Always, TestRun (
3280       [["strings"; "/abssymlink"]])],
3281    "print the printable strings in a file",
3282    "\
3283 This runs the L<strings(1)> command on a file and returns
3284 the list of printable strings found.");
3285
3286   ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
3287    [InitISOFS, Always, TestOutputList (
3288       [["strings_e"; "b"; "/known-5"]], []);
3289     InitScratchFS, Always, TestOutputList (
3290       [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
3291        ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
3292    "print the printable strings in a file",
3293    "\
3294 This is like the C<guestfs_strings> command, but allows you to
3295 specify the encoding of strings that are looked for in
3296 the source file C<path>.
3297
3298 Allowed encodings are:
3299
3300 =over 4
3301
3302 =item s
3303
3304 Single 7-bit-byte characters like ASCII and the ASCII-compatible
3305 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
3306
3307 =item S
3308
3309 Single 8-bit-byte characters.
3310
3311 =item b
3312
3313 16-bit big endian strings such as those encoded in
3314 UTF-16BE or UCS-2BE.
3315
3316 =item l (lower case letter L)
3317
3318 16-bit little endian such as UTF-16LE and UCS-2LE.
3319 This is useful for examining binaries in Windows guests.
3320
3321 =item B
3322
3323 32-bit big endian such as UCS-4BE.
3324
3325 =item L
3326
3327 32-bit little endian such as UCS-4LE.
3328
3329 =back
3330
3331 The returned strings are transcoded to UTF-8.");
3332
3333   ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
3334    [InitISOFS, Always, TestOutput (
3335       [["hexdump"; "/known-4"]], "00000000  61 62 63 0a 64 65 66 0a  67 68 69                 |abc.def.ghi|\n0000000b\n");
3336     (* Test for RHBZ#501888c2 regression which caused large hexdump
3337      * commands to segfault.
3338      *)
3339     InitISOFS, Always, TestRun (
3340       [["hexdump"; "/100krandom"]]);
3341     (* Test for RHBZ#579608, absolute symbolic links. *)
3342     InitISOFS, Always, TestRun (
3343       [["hexdump"; "/abssymlink"]])],
3344    "dump a file in hexadecimal",
3345    "\
3346 This runs C<hexdump -C> on the given C<path>.  The result is
3347 the human-readable, canonical hex dump of the file.");
3348
3349   ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
3350    [InitNone, Always, TestOutput (
3351       [["part_disk"; "/dev/sda"; "mbr"];
3352        ["mkfs"; "ext3"; "/dev/sda1"];
3353        ["mount_options"; ""; "/dev/sda1"; "/"];
3354        ["write"; "/new"; "test file"];
3355        ["umount"; "/dev/sda1"];
3356        ["zerofree"; "/dev/sda1"];
3357        ["mount_options"; ""; "/dev/sda1"; "/"];
3358        ["cat"; "/new"]], "test file")],
3359    "zero unused inodes and disk blocks on ext2/3 filesystem",
3360    "\
3361 This runs the I<zerofree> program on C<device>.  This program
3362 claims to zero unused inodes and disk blocks on an ext2/3
3363 filesystem, thus making it possible to compress the filesystem
3364 more effectively.
3365
3366 You should B<not> run this program if the filesystem is
3367 mounted.
3368
3369 It is possible that using this program can damage the filesystem
3370 or data on the filesystem.");
3371
3372   ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
3373    [],
3374    "resize an LVM physical volume",
3375    "\
3376 This resizes (expands or shrinks) an existing LVM physical
3377 volume to match the new size of the underlying device.");
3378
3379   ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
3380                        Int "cyls"; Int "heads"; Int "sectors";
3381                        String "line"], []), 99, [DeprecatedBy "part_add"],
3382    [],
3383    "modify a single partition on a block device",
3384    "\
3385 This runs L<sfdisk(8)> option to modify just the single
3386 partition C<n> (note: C<n> counts from 1).
3387
3388 For other parameters, see C<guestfs_sfdisk>.  You should usually
3389 pass C<0> for the cyls/heads/sectors parameters.
3390
3391 See also: C<guestfs_part_add>");
3392
3393   ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [DeprecatedBy "part_list"],
3394    [],
3395    "display the partition table",
3396    "\
3397 This displays the partition table on C<device>, in the
3398 human-readable output of the L<sfdisk(8)> command.  It is
3399 not intended to be parsed.
3400
3401 See also: C<guestfs_part_list>");
3402
3403   ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3404    [],
3405    "display the kernel geometry",
3406    "\
3407 This displays the kernel's idea of the geometry of C<device>.
3408
3409 The result is in human-readable format, and not designed to
3410 be parsed.");
3411
3412   ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3413    [],
3414    "display the disk geometry from the partition table",
3415    "\
3416 This displays the disk geometry of C<device> read from the
3417 partition table.  Especially in the case where the underlying
3418 block device has been resized, this can be different from the
3419 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3420
3421 The result is in human-readable format, and not designed to
3422 be parsed.");
3423
3424   ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3425    [],
3426    "activate or deactivate all volume groups",
3427    "\
3428 This command activates or (if C<activate> is false) deactivates
3429 all logical volumes in all volume groups.
3430
3431 This command is the same as running C<vgchange -a y|n>");
3432
3433   ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3434    [],
3435    "activate or deactivate some volume groups",
3436    "\
3437 This command activates or (if C<activate> is false) deactivates
3438 all logical volumes in the listed volume groups C<volgroups>.
3439
3440 This command is the same as running C<vgchange -a y|n volgroups...>
3441
3442 Note that if C<volgroups> is an empty list then B<all> volume groups
3443 are activated or deactivated.");
3444
3445   ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3446    [InitNone, Always, TestOutput (
3447       [["part_disk"; "/dev/sda"; "mbr"];
3448        ["pvcreate"; "/dev/sda1"];
3449        ["vgcreate"; "VG"; "/dev/sda1"];
3450        ["lvcreate"; "LV"; "VG"; "10"];
3451        ["mkfs"; "ext2"; "/dev/VG/LV"];
3452        ["mount_options"; ""; "/dev/VG/LV"; "/"];
3453        ["write"; "/new"; "test content"];
3454        ["umount"; "/"];
3455        ["lvresize"; "/dev/VG/LV"; "20"];
3456        ["e2fsck_f"; "/dev/VG/LV"];
3457        ["resize2fs"; "/dev/VG/LV"];
3458        ["mount_options"; ""; "/dev/VG/LV"; "/"];
3459        ["cat"; "/new"]], "test content");
3460     InitNone, Always, TestRun (
3461       (* Make an LV smaller to test RHBZ#587484. *)
3462       [["part_disk"; "/dev/sda"; "mbr"];
3463        ["pvcreate"; "/dev/sda1"];
3464        ["vgcreate"; "VG"; "/dev/sda1"];
3465        ["lvcreate"; "LV"; "VG"; "20"];
3466        ["lvresize"; "/dev/VG/LV"; "10"]])],
3467    "resize an LVM logical volume",
3468    "\
3469 This resizes (expands or shrinks) an existing LVM logical
3470 volume to C<mbytes>.  When reducing, data in the reduced part
3471 is lost.");
3472
3473   ("resize2fs", (RErr, [Device "device"], []), 106, [],
3474    [], (* lvresize tests this *)
3475    "resize an ext2, ext3 or ext4 filesystem",
3476    "\
3477 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3478 the underlying device.
3479
3480 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3481 on the C<device> before calling this command.  For unknown reasons
3482 C<resize2fs> sometimes gives an error about this and sometimes not.
3483 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3484 calling this function.");
3485
3486   ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3487    [InitBasicFS, Always, TestOutputList (
3488       [["find"; "/"]], ["lost+found"]);
3489     InitBasicFS, Always, TestOutputList (
3490       [["touch"; "/a"];
3491        ["mkdir"; "/b"];
3492        ["touch"; "/b/c"];
3493        ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3494     InitScratchFS, Always, TestOutputList (
3495       [["mkdir_p"; "/find/b/c"];
3496        ["touch"; "/find/b/c/d"];
3497        ["find"; "/find/b/"]], ["c"; "c/d"])],
3498    "find all files and directories",
3499    "\
3500 This command lists out all files and directories, recursively,
3501 starting at C<directory>.  It is essentially equivalent to
3502 running the shell command C<find directory -print> but some
3503 post-processing happens on the output, described below.
3504
3505 This returns a list of strings I<without any prefix>.  Thus
3506 if the directory structure was:
3507
3508  /tmp/a
3509  /tmp/b
3510  /tmp/c/d
3511
3512 then the returned list from C<guestfs_find> C</tmp> would be
3513 4 elements:
3514
3515  a
3516  b
3517  c
3518  c/d
3519
3520 If C<directory> is not a directory, then this command returns
3521 an error.
3522
3523 The returned list is sorted.
3524
3525 See also C<guestfs_find0>.");
3526
3527   ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3528    [], (* lvresize tests this *)
3529    "check an ext2/ext3 filesystem",
3530    "\
3531 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3532 filesystem checker on C<device>, noninteractively (I<-p>),
3533 even if the filesystem appears to be clean (I<-f>).
3534
3535 This command is only needed because of C<guestfs_resize2fs>
3536 (q.v.).  Normally you should use C<guestfs_fsck>.");
3537
3538   ("sleep", (RErr, [Int "secs"], []), 109, [],
3539    [InitNone, Always, TestRun (
3540       [["sleep"; "1"]])],
3541    "sleep for some seconds",
3542    "\
3543 Sleep for C<secs> seconds.");
3544
3545   ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3546    [InitNone, Always, TestOutputInt (
3547       [["part_disk"; "/dev/sda"; "mbr"];
3548        ["mkfs"; "ntfs"; "/dev/sda1"];
3549        ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3550     InitNone, Always, TestOutputInt (
3551       [["part_disk"; "/dev/sda"; "mbr"];
3552        ["mkfs"; "ext2"; "/dev/sda1"];
3553        ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3554    "probe NTFS volume",
3555    "\
3556 This command runs the L<ntfs-3g.probe(8)> command which probes
3557 an NTFS C<device> for mountability.  (Not all NTFS volumes can
3558 be mounted read-write, and some cannot be mounted at all).
3559
3560 C<rw> is a boolean flag.  Set it to true if you want to test
3561 if the volume can be mounted read-write.  Set it to false if
3562 you want to test if the volume can be mounted read-only.
3563
3564 The return value is an integer which C<0> if the operation
3565 would succeed, or some non-zero value documented in the
3566 L<ntfs-3g.probe(8)> manual page.");
3567
3568   ("sh", (RString "output", [String "command"], []), 111, [],
3569    [], (* XXX needs tests *)
3570    "run a command via the shell",
3571    "\
3572 This call runs a command from the guest filesystem via the
3573 guest's C</bin/sh>.
3574
3575 This is like C<guestfs_command>, but passes the command to:
3576
3577  /bin/sh -c \"command\"
3578
3579 Depending on the guest's shell, this usually results in
3580 wildcards being expanded, shell expressions being interpolated
3581 and so on.
3582
3583 All the provisos about C<guestfs_command> apply to this call.");
3584
3585   ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3586    [], (* XXX needs tests *)
3587    "run a command via the shell returning lines",
3588    "\
3589 This is the same as C<guestfs_sh>, but splits the result
3590 into a list of lines.
3591
3592 See also: C<guestfs_command_lines>");
3593
3594   ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3595    (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3596     * code in stubs.c, since all valid glob patterns must start with "/".
3597     * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3598     *)
3599    [InitScratchFS, Always, TestOutputList (
3600       [["mkdir_p"; "/glob_expand/b/c"];
3601        ["touch"; "/glob_expand/b/c/d"];
3602        ["touch"; "/glob_expand/b/c/e"];
3603        ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3604     InitScratchFS, Always, TestOutputList (
3605       [["mkdir_p"; "/glob_expand2/b/c"];
3606        ["touch"; "/glob_expand2/b/c/d"];
3607        ["touch"; "/glob_expand2/b/c/e"];
3608        ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3609     InitScratchFS, Always, TestOutputList (
3610       [["mkdir_p"; "/glob_expand3/b/c"];
3611        ["touch"; "/glob_expand3/b/c/d"];
3612        ["touch"; "/glob_expand3/b/c/e"];
3613        ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3614    "expand a wildcard path",
3615    "\
3616 This command searches for all the pathnames matching
3617 C<pattern> according to the wildcard expansion rules
3618 used by the shell.
3619
3620 If no paths match, then this returns an empty list
3621 (note: not an error).
3622
3623 It is just a wrapper around the C L<glob(3)> function
3624 with flags C<GLOB_MARK|GLOB_BRACE>.
3625 See that manual page for more details.");
3626
3627   ("scrub_device", (RErr, [Device "device"], []), 114, [Optional "scrub"],
3628    [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3629       [["scrub_device"; "/dev/sdc"]])],
3630    "scrub (securely wipe) a device",
3631    "\
3632 This command writes patterns over C<device> to make data retrieval
3633 more difficult.
3634
3635 It is an interface to the L<scrub(1)> program.  See that
3636 manual page for more details.");
3637
3638   ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3639    [InitScratchFS, Always, TestRun (
3640       [["write"; "/scrub_file"; "content"];
3641        ["scrub_file"; "/scrub_file"]])],
3642    "scrub (securely wipe) a file",
3643    "\
3644 This command writes patterns over a file to make data retrieval
3645 more difficult.
3646
3647 The file is I<removed> after scrubbing.
3648
3649 It is an interface to the L<scrub(1)> program.  See that
3650 manual page for more details.");
3651
3652   ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3653    [], (* XXX needs testing *)
3654    "scrub (securely wipe) free space",
3655    "\
3656 This command creates the directory C<dir> and then fills it
3657 with files until the filesystem is full, and scrubs the files
3658 as for C<guestfs_scrub_file>, and deletes them.
3659 The intention is to scrub any free space on the partition
3660 containing C<dir>.
3661
3662 It is an interface to the L<scrub(1)> program.  See that
3663 manual page for more details.");
3664
3665   ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3666    [InitScratchFS, Always, TestRun (
3667       [["mkdir"; "/mkdtemp"];
3668        ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3669    "create a temporary directory",
3670    "\
3671 This command creates a temporary directory.  The
3672 C<template> parameter should be a full pathname for the
3673 temporary directory name with the final six characters being
3674 \"XXXXXX\".
3675
3676 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3677 the second one being suitable for Windows filesystems.
3678
3679 The name of the temporary directory that was created
3680 is returned.
3681
3682 The temporary directory is created with mode 0700
3683 and is owned by root.
3684
3685 The caller is responsible for deleting the temporary
3686 directory and its contents after use.
3687
3688 See also: L<mkdtemp(3)>");
3689
3690   ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3691    [InitISOFS, Always, TestOutputInt (
3692       [["wc_l"; "/10klines"]], 10000);
3693     (* Test for RHBZ#579608, absolute symbolic links. *)
3694     InitISOFS, Always, TestOutputInt (
3695       [["wc_l"; "/abssymlink"]], 10000)],
3696    "count lines in a file",
3697    "\
3698 This command counts the lines in a file, using the
3699 C<wc -l> external command.");
3700
3701   ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3702    [InitISOFS, Always, TestOutputInt (
3703       [["wc_w"; "/10klines"]], 10000)],
3704    "count words in a file",
3705    "\
3706 This command counts the words in a file, using the
3707 C<wc -w> external command.");
3708
3709   ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3710    [InitISOFS, Always, TestOutputInt (
3711       [["wc_c"; "/100kallspaces"]], 102400)],
3712    "count characters in a file",
3713    "\
3714 This command counts the characters in a file, using the
3715 C<wc -c> external command.");
3716
3717   ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3718    [InitISOFS, Always, TestOutputList (
3719       [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3720     (* Test for RHBZ#579608, absolute symbolic links. *)
3721     InitISOFS, Always, TestOutputList (
3722       [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3723    "return first 10 lines of a file",
3724    "\
3725 This command returns up to the first 10 lines of a file as
3726 a list of strings.");
3727
3728   ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3729    [InitISOFS, Always, TestOutputList (
3730       [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3731     InitISOFS, Always, TestOutputList (
3732       [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3733     InitISOFS, Always, TestOutputList (
3734       [["head_n"; "0"; "/10klines"]], [])],
3735    "return first N lines of a file",
3736    "\
3737 If the parameter C<nrlines> is a positive number, this returns the first
3738 C<nrlines> lines of the file C<path>.
3739
3740 If the parameter C<nrlines> is a negative number, this returns lines
3741 from the file C<path>, excluding the last C<nrlines> lines.
3742
3743 If the parameter C<nrlines> is zero, this returns an empty list.");
3744
3745   ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3746    [InitISOFS, Always, TestOutputList (
3747       [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3748    "return last 10 lines of a file",
3749    "\
3750 This command returns up to the last 10 lines of a file as
3751 a list of strings.");
3752
3753   ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3754    [InitISOFS, Always, TestOutputList (
3755       [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3756     InitISOFS, Always, TestOutputList (
3757       [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3758     InitISOFS, Always, TestOutputList (
3759       [["tail_n"; "0"; "/10klines"]], [])],
3760    "return last N lines of a file",
3761    "\
3762 If the parameter C<nrlines> is a positive number, this returns the last
3763 C<nrlines> lines of the file C<path>.
3764
3765 If the parameter C<nrlines> is a negative number, this returns lines
3766 from the file C<path>, starting with the C<-nrlines>th line.
3767
3768 If the parameter C<nrlines> is zero, this returns an empty list.");
3769
3770   ("df", (RString "output", [], []), 125, [],
3771    [], (* XXX Tricky to test because it depends on the exact format
3772         * of the 'df' command and other imponderables.
3773         *)
3774    "report file system disk space usage",
3775    "\
3776 This command runs the C<df> command to report disk space used.
3777
3778 This command is mostly useful for interactive sessions.  It
3779 is I<not> intended that you try to parse the output string.
3780 Use C<guestfs_statvfs> from programs.");
3781
3782   ("df_h", (RString "output", [], []), 126, [],
3783    [], (* XXX Tricky to test because it depends on the exact format
3784         * of the 'df' command and other imponderables.
3785         *)
3786    "report file system disk space usage (human readable)",
3787    "\
3788 This command runs the C<df -h> command to report disk space used
3789 in human-readable format.
3790
3791 This command is mostly useful for interactive sessions.  It
3792 is I<not> intended that you try to parse the output string.
3793 Use C<guestfs_statvfs> from programs.");
3794
3795   ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [Progress],
3796    [InitISOFS, Always, TestOutputInt (
3797       [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3798    "estimate file space usage",
3799    "\
3800 This command runs the C<du -s> command to estimate file space
3801 usage for C<path>.
3802
3803 C<path> can be a file or a directory.  If C<path> is a directory
3804 then the estimate includes the contents of the directory and all
3805 subdirectories (recursively).
3806
3807 The result is the estimated size in I<kilobytes>
3808 (ie. units of 1024 bytes).");
3809
3810   ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3811    [InitISOFS, Always, TestOutputList (
3812       [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3813    "list files in an initrd",
3814    "\
3815 This command lists out files contained in an initrd.
3816
3817 The files are listed without any initial C</> character.  The
3818 files are listed in the order they appear (not necessarily
3819 alphabetical).  Directory names are listed as separate items.
3820
3821 Old Linux kernels (2.4 and earlier) used a compressed ext2
3822 filesystem as initrd.  We I<only> support the newer initramfs
3823 format (compressed cpio files).");
3824
3825   ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3826    [],
3827    "mount a file using the loop device",
3828    "\
3829 This command lets you mount C<file> (a filesystem image
3830 in a file) on a mount point.  It is entirely equivalent to
3831 the command C<mount -o loop file mountpoint>.");
3832
3833   ("mkswap", (RErr, [Device "device"], []), 130, [],
3834    [InitEmpty, Always, TestRun (
3835       [["part_disk"; "/dev/sda"; "mbr"];
3836        ["mkswap"; "/dev/sda1"]])],
3837    "create a swap partition",
3838    "\
3839 Create a swap partition on C<device>.");
3840
3841   ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3842    [InitEmpty, Always, TestRun (
3843       [["part_disk"; "/dev/sda"; "mbr"];
3844        ["mkswap_L"; "hello"; "/dev/sda1"]])],
3845    "create a swap partition with a label",
3846    "\
3847 Create a swap partition on C<device> with label C<label>.
3848
3849 Note that you cannot attach a swap label to a block device
3850 (eg. C</dev/sda>), just to a partition.  This appears to be
3851 a limitation of the kernel or swap tools.");
3852
3853   ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3854    (let uuid = uuidgen () in
3855     [InitEmpty, Always, TestRun (
3856        [["part_disk"; "/dev/sda"; "mbr"];
3857         ["mkswap_U"; uuid; "/dev/sda1"]])]),
3858    "create a swap partition with an explicit UUID",
3859    "\
3860 Create a swap partition on C<device> with UUID C<uuid>.");
3861
3862   ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3863    [InitScratchFS, Always, TestOutputStruct (
3864       [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3865        (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3866        ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3867     InitScratchFS, Always, TestOutputStruct (
3868       [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3869        ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3870    "make block, character or FIFO devices",
3871    "\
3872 This call creates block or character special devices, or
3873 named pipes (FIFOs).
3874
3875 The C<mode> parameter should be the mode, using the standard
3876 constants.  C<devmajor> and C<devminor> are the
3877 device major and minor numbers, only used when creating block
3878 and character special devices.
3879
3880 Note that, just like L<mknod(2)>, the mode must be bitwise
3881 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3882 just creates a regular file).  These constants are
3883 available in the standard Linux header files, or you can use
3884 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3885 which are wrappers around this command which bitwise OR
3886 in the appropriate constant for you.
3887
3888 The mode actually set is affected by the umask.");
3889
3890   ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3891    [InitScratchFS, Always, TestOutputStruct (
3892       [["mkfifo"; "0o777"; "/mkfifo"];
3893        ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3894    "make FIFO (named pipe)",
3895    "\
3896 This call creates a FIFO (named pipe) called C<path> with
3897 mode C<mode>.  It is just a convenient wrapper around
3898 C<guestfs_mknod>.
3899
3900 The mode actually set is affected by the umask.");
3901
3902   ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3903    [InitScratchFS, Always, TestOutputStruct (
3904       [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3905        ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3906    "make block device node",
3907    "\
3908 This call creates a block device node called C<path> with
3909 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3910 It is just a convenient wrapper around C<guestfs_mknod>.
3911
3912 The mode actually set is affected by the umask.");
3913
3914   ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3915    [InitScratchFS, Always, TestOutputStruct (
3916       [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3917        ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3918    "make char device node",
3919    "\
3920 This call creates a char device node called C<path> with
3921 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3922 It is just a convenient wrapper around C<guestfs_mknod>.
3923
3924 The mode actually set is affected by the umask.");
3925
3926   ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3927    [InitEmpty, Always, TestOutputInt (
3928       [["umask"; "0o22"]], 0o22)],
3929    "set file mode creation mask (umask)",
3930    "\
3931 This function sets the mask used for creating new files and
3932 device nodes to C<mask & 0777>.
3933
3934 Typical umask values would be C<022> which creates new files
3935 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3936 C<002> which creates new files with permissions like
3937 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3938
3939 The default umask is C<022>.  This is important because it
3940 means that directories and device nodes will be created with
3941 C<0644> or C<0755> mode even if you specify C<0777>.
3942
3943 See also C<guestfs_get_umask>,
3944 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3945
3946 This call returns the previous umask.");
3947
3948   ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3949    [],
3950    "read directories entries",
3951    "\
3952 This returns the list of directory entries in directory C<dir>.
3953
3954 All entries in the directory are returned, including C<.> and
3955 C<..>.  The entries are I<not> sorted, but returned in the same
3956 order as the underlying filesystem.
3957
3958 Also this call returns basic file type information about each
3959 file.  The C<ftyp> field will contain one of the following characters:
3960
3961 =over 4
3962
3963 =item 'b'
3964
3965 Block special
3966
3967 =item 'c'
3968
3969 Char special
3970
3971 =item 'd'
3972
3973 Directory
3974
3975 =item 'f'
3976
3977 FIFO (named pipe)
3978
3979 =item 'l'
3980
3981 Symbolic link
3982
3983 =item 'r'
3984
3985 Regular file
3986
3987 =item 's'
3988
3989 Socket
3990
3991 =item 'u'
3992
3993 Unknown file type
3994
3995 =item '?'
3996
3997 The L<readdir(3)> call returned a C<d_type> field with an
3998 unexpected value
3999
4000 =back
4001
4002 This function is primarily intended for use by programs.  To
4003 get a simple list of names, use C<guestfs_ls>.  To get a printable
4004 directory for human consumption, use C<guestfs_ll>.");
4005
4006   ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DeprecatedBy "part_add"],
4007    [],
4008    "create partitions on a block device",
4009    "\
4010 This is a simplified interface to the C<guestfs_sfdisk>
4011 command, where partition sizes are specified in megabytes
4012 only (rounded to the nearest cylinder) and you don't need
4013 to specify the cyls, heads and sectors parameters which
4014 were rarely if ever used anyway.
4015
4016 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
4017 and C<guestfs_part_disk>");
4018
4019   ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
4020    [],
4021    "determine file type inside a compressed file",
4022    "\
4023 This command runs C<file> after first decompressing C<path>
4024 using C<method>.
4025
4026 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
4027
4028 Since 1.0.63, use C<guestfs_file> instead which can now
4029 process compressed files.");
4030
4031   ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
4032    [],
4033    "list extended attributes of a file or directory",
4034    "\
4035 This call lists the extended attributes of the file or directory
4036 C<path>.
4037
4038 At the system call level, this is a combination of the
4039 L<listxattr(2)> and L<getxattr(2)> calls.
4040
4041 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
4042
4043   ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
4044    [],
4045    "list extended attributes of a file or directory",
4046    "\
4047 This is the same as C<guestfs_getxattrs>, but if C<path>
4048 is a symbolic link, then it returns the extended attributes
4049 of the link itself.");
4050
4051   ("setxattr", (RErr, [String "xattr";
4052                        String "val"; Int "vallen"; (* will be BufferIn *)
4053                        Pathname "path"], []), 143, [Optional "linuxxattrs"],
4054    [],
4055    "set extended attribute of a file or directory",
4056    "\
4057 This call sets the extended attribute named C<xattr>
4058 of the file C<path> to the value C<val> (of length C<vallen>).
4059 The value is arbitrary 8 bit data.
4060
4061 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
4062
4063   ("lsetxattr", (RErr, [String "xattr";
4064                         String "val"; Int "vallen"; (* will be BufferIn *)
4065                         Pathname "path"], []), 144, [Optional "linuxxattrs"],
4066    [],
4067    "set extended attribute of a file or directory",
4068    "\
4069 This is the same as C<guestfs_setxattr>, but if C<path>
4070 is a symbolic link, then it sets an extended attribute
4071 of the link itself.");
4072
4073   ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
4074    [],
4075    "remove extended attribute of a file or directory",
4076    "\
4077 This call removes the extended attribute named C<xattr>
4078 of the file C<path>.
4079
4080 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
4081
4082   ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
4083    [],
4084    "remove extended attribute of a file or directory",
4085    "\
4086 This is the same as C<guestfs_removexattr>, but if C<path>
4087 is a symbolic link, then it removes an extended attribute
4088 of the link itself.");
4089
4090   ("mountpoints", (RHashtable "mps", [], []), 147, [],
4091    [],
4092    "show mountpoints",
4093    "\
4094 This call is similar to C<guestfs_mounts>.  That call returns
4095 a list of devices.  This one returns a hash table (map) of
4096 device name to directory where the device is mounted.");
4097
4098   ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
4099    (* This is a special case: while you would expect a parameter
4100     * of type "Pathname", that doesn't work, because it implies
4101     * NEED_ROOT in the generated calling code in stubs.c, and
4102     * this function cannot use NEED_ROOT.
4103     *)
4104    [],
4105    "create a mountpoint",
4106    "\
4107 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
4108 specialized calls that can be used to create extra mountpoints
4109 before mounting the first filesystem.
4110
4111 These calls are I<only> necessary in some very limited circumstances,
4112 mainly the case where you want to mount a mix of unrelated and/or
4113 read-only filesystems together.
4114
4115 For example, live CDs often contain a \"Russian doll\" nest of
4116 filesystems, an ISO outer layer, with a squashfs image inside, with
4117 an ext2/3 image inside that.  You can unpack this as follows
4118 in guestfish:
4119
4120  add-ro Fedora-11-i686-Live.iso
4121  run
4122  mkmountpoint /cd
4123  mkmountpoint /sqsh
4124  mkmountpoint /ext3fs
4125  mount /dev/sda /cd
4126  mount-loop /cd/LiveOS/squashfs.img /sqsh
4127  mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
4128
4129 The inner filesystem is now unpacked under the /ext3fs mountpoint.
4130
4131 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
4132 You may get unexpected errors if you try to mix these calls.  It is
4133 safest to manually unmount filesystems and remove mountpoints after use.
4134
4135 C<guestfs_umount_all> unmounts filesystems by sorting the paths
4136 longest first, so for this to work for manual mountpoints, you
4137 must ensure that the innermost mountpoints have the longest
4138 pathnames, as in the example code above.
4139
4140 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
4141
4142 Autosync [see C<guestfs_set_autosync>, this is set by default on
4143 handles] can cause C<guestfs_umount_all> to be called when the handle
4144 is closed which can also trigger these issues.");
4145
4146   ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
4147    [],
4148    "remove a mountpoint",
4149    "\
4150 This calls removes a mountpoint that was previously created
4151 with C<guestfs_mkmountpoint>.  See C<guestfs_mkmountpoint>
4152 for full details.");
4153
4154   ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
4155    [InitISOFS, Always, TestOutputBuffer (
4156       [["read_file"; "/known-4"]], "abc\ndef\nghi");
4157     (* Test various near large, large and too large files (RHBZ#589039). *)
4158     InitScratchFS, Always, TestLastFail (
4159       [["touch"; "/read_file"];
4160        ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
4161        ["read_file"; "/read_file"]]);
4162     InitScratchFS, Always, TestLastFail (
4163       [["touch"; "/read_file2"];
4164        ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
4165        ["read_file"; "/read_file2"]]);
4166     InitScratchFS, Always, TestLastFail (
4167       [["touch"; "/read_file3"];
4168        ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
4169        ["read_file"; "/read_file3"]])],
4170    "read a file",
4171    "\
4172 This calls returns the contents of the file C<path> as a
4173 buffer.
4174
4175 Unlike C<guestfs_cat>, this function can correctly
4176 handle files that contain embedded ASCII NUL characters.
4177 However unlike C<guestfs_download>, this function is limited
4178 in the total size of file that can be handled.");
4179
4180   ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
4181    [InitISOFS, Always, TestOutputList (
4182       [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
4183     InitISOFS, Always, TestOutputList (
4184       [["grep"; "nomatch"; "/test-grep.txt"]], []);
4185     (* Test for RHBZ#579608, absolute symbolic links. *)
4186     InitISOFS, Always, TestOutputList (
4187       [["grep"; "nomatch"; "/abssymlink"]], [])],
4188    "return lines matching a pattern",
4189    "\
4190 This calls the external C<grep> program and returns the
4191 matching lines.");
4192
4193   ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
4194    [InitISOFS, Always, TestOutputList (
4195       [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4196    "return lines matching a pattern",
4197    "\
4198 This calls the external C<egrep> program and returns the
4199 matching lines.");
4200
4201   ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
4202    [InitISOFS, Always, TestOutputList (
4203       [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4204    "return lines matching a pattern",
4205    "\
4206 This calls the external C<fgrep> program and returns the
4207 matching lines.");
4208
4209   ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
4210    [InitISOFS, Always, TestOutputList (
4211       [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4212    "return lines matching a pattern",
4213    "\
4214 This calls the external C<grep -i> program and returns the
4215 matching lines.");
4216
4217   ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
4218    [InitISOFS, Always, TestOutputList (
4219       [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4220    "return lines matching a pattern",
4221    "\
4222 This calls the external C<egrep -i> program and returns the
4223 matching lines.");
4224
4225   ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
4226    [InitISOFS, Always, TestOutputList (
4227       [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4228    "return lines matching a pattern",
4229    "\
4230 This calls the external C<fgrep -i> program and returns the
4231 matching lines.");
4232
4233   ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
4234    [InitISOFS, Always, TestOutputList (
4235       [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4236    "return lines matching a pattern",
4237    "\
4238 This calls the external C<zgrep> program and returns the
4239 matching lines.");
4240
4241   ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
4242    [InitISOFS, Always, TestOutputList (
4243       [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4244    "return lines matching a pattern",
4245    "\
4246 This calls the external C<zegrep> program and returns the
4247 matching lines.");
4248
4249   ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
4250    [InitISOFS, Always, TestOutputList (
4251       [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4252    "return lines matching a pattern",
4253    "\
4254 This calls the external C<zfgrep> program and returns the
4255 matching lines.");
4256
4257   ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
4258    [InitISOFS, Always, TestOutputList (
4259       [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4260    "return lines matching a pattern",
4261    "\
4262 This calls the external C<zgrep -i> program and returns the
4263 matching lines.");
4264
4265   ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
4266    [InitISOFS, Always, TestOutputList (
4267       [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4268    "return lines matching a pattern",
4269    "\
4270 This calls the external C<zegrep -i> program and returns the
4271 matching lines.");
4272
4273   ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
4274    [InitISOFS, Always, TestOutputList (
4275       [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4276    "return lines matching a pattern",
4277    "\
4278 This calls the external C<zfgrep -i> program and returns the
4279 matching lines.");
4280
4281   ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
4282    [InitISOFS, Always, TestOutput (
4283       [["realpath"; "/../directory"]], "/directory")],
4284    "canonicalized absolute pathname",
4285    "\
4286 Return the canonicalized absolute pathname of C<path>.  The
4287 returned path has no C<.>, C<..> or symbolic link path elements.");
4288
4289   ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
4290    [InitScratchFS, Always, TestOutputStruct (
4291       [["mkdir"; "/ln"];
4292        ["touch"; "/ln/a"];
4293        ["ln"; "/ln/a"; "/ln/b"];
4294        ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
4295    "create a hard link",
4296    "\
4297 This command creates a hard link using the C<ln> command.");
4298
4299   ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
4300    [InitScratchFS, Always, TestOutputStruct (
4301       [["mkdir"; "/ln_f"];
4302        ["touch"; "/ln_f/a"];
4303        ["touch"; "/ln_f/b"];
4304        ["ln_f"; "/ln_f/a"; "/ln_f/b"];
4305        ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
4306    "create a hard link",
4307    "\
4308 This command creates a hard link using the C<ln -f> command.
4309 The I<-f> option removes the link (C<linkname>) if it exists already.");
4310
4311   ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
4312    [InitScratchFS, Always, TestOutputStruct (
4313       [["mkdir"; "/ln_s"];
4314        ["touch"; "/ln_s/a"];
4315        ["ln_s"; "a"; "/ln_s/b"];
4316        ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
4317    "create a symbolic link",
4318    "\
4319 This command creates a symbolic link using the C<ln -s> command.");
4320
4321   ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
4322    [InitScratchFS, Always, TestOutput (
4323       [["mkdir_p"; "/ln_sf/b"];
4324        ["touch"; "/ln_sf/b/c"];
4325        ["ln_sf"; "../d"; "/ln_sf/b/c"];
4326        ["readlink"; "/ln_sf/b/c"]], "../d")],
4327    "create a symbolic link",
4328    "\
4329 This command creates a symbolic link using the C<ln -sf> command,
4330 The I<-f> option removes the link (C<linkname>) if it exists already.");
4331
4332   ("readlink", (RString "link", [Pathname "path"], []), 168, [],
4333    [] (* XXX tested above *),
4334    "read the target of a symbolic link",
4335    "\
4336 This command reads the target of a symbolic link.");
4337
4338   ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
4339    [InitScratchFS, Always, TestOutputStruct (
4340       [["fallocate"; "/fallocate"; "1000000"];
4341        ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
4342    "preallocate a file in the guest filesystem",
4343    "\
4344 This command preallocates a file (containing zero bytes) named
4345 C<path> of size C<len> bytes.  If the file exists already, it
4346 is overwritten.
4347
4348 Do not confuse this with the guestfish-specific
4349 C<alloc> command which allocates a file in the host and
4350 attaches it as a device.");
4351
4352   ("swapon_device", (RErr, [Device "device"], []), 170, [],
4353    [InitPartition, Always, TestRun (
4354       [["mkswap"; "/dev/sda1"];
4355        ["swapon_device"; "/dev/sda1"];
4356        ["swapoff_device"; "/dev/sda1"]])],
4357    "enable swap on device",
4358    "\
4359 This command enables the libguestfs appliance to use the
4360 swap device or partition named C<device>.  The increased
4361 memory is made available for all commands, for example
4362 those run using C<guestfs_command> or C<guestfs_sh>.
4363
4364 Note that you should not swap to existing guest swap
4365 partitions unless you know what you are doing.  They may
4366 contain hibernation information, or other information that
4367 the guest doesn't want you to trash.  You also risk leaking
4368 information about the host to the guest this way.  Instead,
4369 attach a new host device to the guest and swap on that.");
4370
4371   ("swapoff_device", (RErr, [Device "device"], []), 171, [],
4372    [], (* XXX tested by swapon_device *)
4373    "disable swap on device",
4374    "\
4375 This command disables the libguestfs appliance swap
4376 device or partition named C<device>.
4377 See C<guestfs_swapon_device>.");
4378
4379   ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4380    [InitScratchFS, Always, TestRun (
4381       [["fallocate"; "/swapon_file"; "8388608"];
4382        ["mkswap_file"; "/swapon_file"];
4383        ["swapon_file"; "/swapon_file"];
4384        ["swapoff_file"; "/swapon_file"];
4385        ["rm"; "/swapon_file"]])],
4386    "enable swap on file",
4387    "\
4388 This command enables swap to a file.
4389 See C<guestfs_swapon_device> for other notes.");
4390
4391   ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4392    [], (* XXX tested by swapon_file *)
4393    "disable swap on file",
4394    "\
4395 This command disables the libguestfs appliance swap on file.");
4396
4397   ("swapon_label", (RErr, [String "label"], []), 174, [],
4398    [InitEmpty, Always, TestRun (
4399       [["part_disk"; "/dev/sda"; "mbr"];
4400        ["mkswap_L"; "swapit"; "/dev/sda1"];
4401        ["swapon_label"; "swapit"];
4402        ["swapoff_label"; "swapit"];
4403        ["zero"; "/dev/sda"];
4404        ["blockdev_rereadpt"; "/dev/sda"]])],
4405    "enable swap on labeled swap partition",
4406    "\
4407 This command enables swap to a labeled swap partition.
4408 See C<guestfs_swapon_device> for other notes.");
4409
4410   ("swapoff_label", (RErr, [String "label"], []), 175, [],
4411    [], (* XXX tested by swapon_label *)
4412    "disable swap on labeled swap partition",
4413    "\
4414 This command disables the libguestfs appliance swap on
4415 labeled swap partition.");
4416
4417   ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4418    (let uuid = uuidgen () in
4419     [InitEmpty, Always, TestRun (
4420        [["mkswap_U"; uuid; "/dev/sdc"];
4421         ["swapon_uuid"; uuid];
4422         ["swapoff_uuid"; uuid]])]),
4423    "enable swap on swap partition by UUID",
4424    "\
4425 This command enables swap to a swap partition with the given UUID.
4426 See C<guestfs_swapon_device> for other notes.");
4427
4428   ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4429    [], (* XXX tested by swapon_uuid *)
4430    "disable swap on swap partition by UUID",
4431    "\
4432 This command disables the libguestfs appliance swap partition
4433 with the given UUID.");
4434
4435   ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4436    [InitScratchFS, Always, TestRun (
4437       [["fallocate"; "/mkswap_file"; "8388608"];
4438        ["mkswap_file"; "/mkswap_file"];
4439        ["rm"; "/mkswap_file"]])],
4440    "create a swap file",
4441    "\
4442 Create a swap file.
4443
4444 This command just writes a swap file signature to an existing
4445 file.  To create the file itself, use something like C<guestfs_fallocate>.");
4446
4447   ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4448    [InitISOFS, Always, TestRun (
4449       [["inotify_init"; "0"]])],
4450    "create an inotify handle",
4451    "\
4452 This command creates a new inotify handle.
4453 The inotify subsystem can be used to notify events which happen to
4454 objects in the guest filesystem.
4455
4456 C<maxevents> is the maximum number of events which will be
4457 queued up between calls to C<guestfs_inotify_read> or
4458 C<guestfs_inotify_files>.
4459 If this is passed as C<0>, then the kernel (or previously set)
4460 default is used.  For Linux 2.6.29 the default was 16384 events.
4461 Beyond this limit, the kernel throws away events, but records
4462 the fact that it threw them away by setting a flag
4463 C<IN_Q_OVERFLOW> in the returned structure list (see
4464 C<guestfs_inotify_read>).
4465
4466 Before any events are generated, you have to add some
4467 watches to the internal watch list.  See:
4468 C<guestfs_inotify_add_watch>,
4469 C<guestfs_inotify_rm_watch> and
4470 C<guestfs_inotify_watch_all>.
4471
4472 Queued up events should be read periodically by calling
4473 C<guestfs_inotify_read>
4474 (or C<guestfs_inotify_files> which is just a helpful
4475 wrapper around C<guestfs_inotify_read>).  If you don't
4476 read the events out often enough then you risk the internal
4477 queue overflowing.
4478
4479 The handle should be closed after use by calling
4480 C<guestfs_inotify_close>.  This also removes any
4481 watches automatically.
4482
4483 See also L<inotify(7)> for an overview of the inotify interface
4484 as exposed by the Linux kernel, which is roughly what we expose
4485 via libguestfs.  Note that there is one global inotify handle
4486 per libguestfs instance.");
4487
4488   ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4489    [InitScratchFS, Always, TestOutputList (
4490       [["mkdir"; "/inotify_add_watch"];
4491        ["inotify_init"; "0"];
4492        ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4493        ["touch"; "/inotify_add_watch/a"];
4494        ["touch"; "/inotify_add_watch/b"];
4495        ["inotify_files"]], ["a"; "b"])],
4496    "add an inotify watch",
4497    "\
4498 Watch C<path> for the events listed in C<mask>.
4499
4500 Note that if C<path> is a directory then events within that
4501 directory are watched, but this does I<not> happen recursively
4502 (in subdirectories).
4503
4504 Note for non-C or non-Linux callers: the inotify events are
4505 defined by the Linux kernel ABI and are listed in
4506 C</usr/include/sys/inotify.h>.");
4507
4508   ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4509    [],
4510    "remove an inotify watch",
4511    "\
4512 Remove a previously defined inotify watch.
4513 See C<guestfs_inotify_add_watch>.");
4514
4515   ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4516    [],
4517    "return list of inotify events",
4518    "\
4519 Return the complete queue of events that have happened
4520 since the previous read call.
4521
4522 If no events have happened, this returns an empty list.
4523
4524 I<Note>: In order to make sure that all events have been
4525 read, you must call this function repeatedly until it
4526 returns an empty list.  The reason is that the call will
4527 read events up to the maximum appliance-to-host message
4528 size and leave remaining events in the queue.");
4529
4530   ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4531    [],
4532    "return list of watched files that had events",
4533    "\
4534 This function is a helpful wrapper around C<guestfs_inotify_read>
4535 which just returns a list of pathnames of objects that were
4536 touched.  The returned pathnames are sorted and deduplicated.");
4537
4538   ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4539    [],
4540    "close the inotify handle",
4541    "\
4542 This closes the inotify handle which was previously
4543 opened by inotify_init.  It removes all watches, throws
4544 away any pending events, and deallocates all resources.");
4545
4546   ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4547    [],
4548    "set SELinux security context",
4549    "\
4550 This sets the SELinux security context of the daemon
4551 to the string C<context>.
4552
4553 See the documentation about SELINUX in L<guestfs(3)>.");
4554
4555   ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4556    [],
4557    "get SELinux security context",
4558    "\
4559 This gets the SELinux security context of the daemon.
4560
4561 See the documentation about SELINUX in L<guestfs(3)>,
4562 and C<guestfs_setcon>");
4563
4564   ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4565    [InitEmpty, Always, TestOutput (
4566       [["part_disk"; "/dev/sda"; "mbr"];
4567        ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4568        ["mount_options"; ""; "/dev/sda1"; "/"];
4569        ["write"; "/new"; "new file contents"];
4570        ["cat"; "/new"]], "new file contents");
4571     InitEmpty, Always, TestRun (
4572       [["part_disk"; "/dev/sda"; "mbr"];
4573        ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4574     InitEmpty, Always, TestLastFail (
4575       [["part_disk"; "/dev/sda"; "mbr"];
4576        ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4577     InitEmpty, Always, TestLastFail (
4578       [["part_disk"; "/dev/sda"; "mbr"];
4579        ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4580     InitEmpty, IfAvailable "ntfsprogs", TestRun (
4581       [["part_disk"; "/dev/sda"; "mbr"];
4582        ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4583    "make a filesystem with block size",
4584    "\
4585 This call is similar to C<guestfs_mkfs>, but it allows you to
4586 control the block size of the resulting filesystem.  Supported
4587 block sizes depend on the filesystem type, but typically they
4588 are C<1024>, C<2048> or C<4096> only.
4589
4590 For VFAT and NTFS the C<blocksize> parameter is treated as
4591 the requested cluster size.");
4592
4593   ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4594    [InitEmpty, Always, TestOutput (
4595       [["part_init"; "/dev/sda"; "mbr"];
4596        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4597        ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4598        ["mke2journal"; "4096"; "/dev/sda1"];
4599        ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4600        ["mount_options"; ""; "/dev/sda2"; "/"];
4601        ["write"; "/new"; "new file contents"];
4602        ["cat"; "/new"]], "new file contents")],
4603    "make ext2/3/4 external journal",
4604    "\
4605 This creates an ext2 external journal on C<device>.  It is equivalent
4606 to the command:
4607
4608  mke2fs -O journal_dev -b blocksize device");
4609
4610   ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4611    [InitEmpty, Always, TestOutput (
4612       [["part_init"; "/dev/sda"; "mbr"];
4613        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4614        ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4615        ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4616        ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4617        ["mount_options"; ""; "/dev/sda2"; "/"];
4618        ["write"; "/new"; "new file contents"];
4619        ["cat"; "/new"]], "new file contents")],
4620    "make ext2/3/4 external journal with label",
4621    "\
4622 This creates an ext2 external journal on C<device> with label C<label>.");
4623
4624   ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4625    (let uuid = uuidgen () in
4626     [InitEmpty, Always, TestOutput (
4627        [["part_init"; "/dev/sda"; "mbr"];
4628         ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4629         ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4630         ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4631         ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4632         ["mount_options"; ""; "/dev/sda2"; "/"];
4633         ["write"; "/new"; "new file contents"];
4634         ["cat"; "/new"]], "new file contents")]),
4635    "make ext2/3/4 external journal with UUID",
4636    "\
4637 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4638
4639   ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4640    [],
4641    "make ext2/3/4 filesystem with external journal",
4642    "\
4643 This creates an ext2/3/4 filesystem on C<device> with
4644 an external journal on C<journal>.  It is equivalent
4645 to the command:
4646
4647  mke2fs -t fstype -b blocksize -J device=<journal> <device>
4648
4649 See also C<guestfs_mke2journal>.");
4650
4651   ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4652    [],
4653    "make ext2/3/4 filesystem with external journal",
4654    "\
4655 This creates an ext2/3/4 filesystem on C<device> with
4656 an external journal on the journal labeled C<label>.
4657
4658 See also C<guestfs_mke2journal_L>.");
4659
4660   ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4661    [],
4662    "make ext2/3/4 filesystem with external journal",
4663    "\
4664 This creates an ext2/3/4 filesystem on C<device> with
4665 an external journal on the journal with UUID C<uuid>.
4666
4667 See also C<guestfs_mke2journal_U>.");
4668
4669   ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4670    [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4671    "load a kernel module",
4672    "\
4673 This loads a kernel module in the appliance.
4674
4675 The kernel module must have been whitelisted when libguestfs
4676 was built (see C<appliance/kmod.whitelist.in> in the source).");
4677
4678   ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4679    [InitNone, Always, TestOutput (
4680       [["echo_daemon"; "This is a test"]], "This is a test"
4681     )],
4682    "echo arguments back to the client",
4683    "\
4684 This command concatenates the list of C<words> passed with single spaces
4685 between them and returns the resulting string.
4686
4687 You can use this command to test the connection through to the daemon.
4688
4689 See also C<guestfs_ping_daemon>.");
4690
4691   ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4692    [], (* There is a regression test for this. *)
4693    "find all files and directories, returning NUL-separated list",
4694    "\
4695 This command lists out all files and directories, recursively,
4696 starting at C<directory>, placing the resulting list in the
4697 external file called C<files>.
4698
4699 This command works the same way as C<guestfs_find> with the
4700 following exceptions:
4701
4702 =over 4
4703
4704 =item *
4705
4706 The resulting list is written to an external file.
4707
4708 =item *
4709
4710 Items (filenames) in the result are separated
4711 by C<\\0> characters.  See L<find(1)> option I<-print0>.
4712
4713 =item *
4714
4715 This command is not limited in the number of names that it
4716 can return.
4717
4718 =item *
4719
4720 The result list is not sorted.
4721
4722 =back");
4723
4724   ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4725    [InitISOFS, Always, TestOutput (
4726       [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4727     InitISOFS, Always, TestOutput (
4728       [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4729     InitISOFS, Always, TestOutput (
4730       [["case_sensitive_path"; "/Known-1"]], "/known-1");
4731     InitISOFS, Always, TestLastFail (
4732       [["case_sensitive_path"; "/Known-1/"]]);
4733     InitScratchFS, Always, TestOutput (
4734       [["mkdir"; "/case_sensitive_path"];
4735        ["mkdir"; "/case_sensitive_path/bbb"];
4736        ["touch"; "/case_sensitive_path/bbb/c"];
4737        ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4738     InitScratchFS, Always, TestOutput (
4739       [["mkdir"; "/case_sensitive_path2"];
4740        ["mkdir"; "/case_sensitive_path2/bbb"];
4741        ["touch"; "/case_sensitive_path2/bbb/c"];
4742        ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4743     InitScratchFS, Always, TestLastFail (
4744       [["mkdir"; "/case_sensitive_path3"];
4745        ["mkdir"; "/case_sensitive_path3/bbb"];
4746        ["touch"; "/case_sensitive_path3/bbb/c"];
4747        ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4748    "return true path on case-insensitive filesystem",
4749    "\
4750 This can be used to resolve case insensitive paths on
4751 a filesystem which is case sensitive.  The use case is
4752 to resolve paths which you have read from Windows configuration
4753 files or the Windows Registry, to the true path.
4754
4755 The command handles a peculiarity of the Linux ntfs-3g
4756 filesystem driver (and probably others), which is that although
4757 the underlying filesystem is case-insensitive, the driver
4758 exports the filesystem to Linux as case-sensitive.
4759
4760 One consequence of this is that special directories such
4761 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4762 (or other things) depending on the precise details of how
4763 they were created.  In Windows itself this would not be
4764 a problem.
4765
4766 Bug or feature?  You decide:
4767 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4768
4769 This function resolves the true case of each element in the
4770 path and returns the case-sensitive path.
4771
4772 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4773 might return C<\"/WINDOWS/system32\"> (the exact return value
4774 would depend on details of how the directories were originally
4775 created under Windows).
4776
4777 I<Note>:
4778 This function does not handle drive names, backslashes etc.
4779
4780 See also C<guestfs_realpath>.");
4781
4782   ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4783    [InitScratchFS, Always, TestOutput (
4784       [["vfs_type"; "/dev/sdb1"]], "ext2")],
4785    "get the Linux VFS type corresponding to a mounted device",
4786    "\
4787 This command gets the filesystem type corresponding to
4788 the filesystem on C<device>.
4789
4790 For most filesystems, the result is the name of the Linux
4791 VFS module which would be used to mount this filesystem
4792 if you mounted it without specifying the filesystem type.
4793 For example a string such as C<ext3> or C<ntfs>.");
4794
4795   ("truncate", (RErr, [Pathname "path"], []), 199, [],
4796    [InitScratchFS, Always, TestOutputStruct (
4797       [["write"; "/truncate"; "some stuff so size is not zero"];
4798        ["truncate"; "/truncate"];
4799        ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4800    "truncate a file to zero size",
4801    "\
4802 This command truncates C<path> to a zero-length file.  The
4803 file must exist already.");
4804
4805   ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4806    [InitScratchFS, Always, TestOutputStruct (
4807       [["touch"; "/truncate_size"];
4808        ["truncate_size"; "/truncate_size"; "1000"];
4809        ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4810    "truncate a file to a particular size",
4811    "\
4812 This command truncates C<path> to size C<size> bytes.  The file
4813 must exist already.
4814
4815 If the current file size is less than C<size> then
4816 the file is extended to the required size with zero bytes.
4817 This creates a sparse file (ie. disk blocks are not allocated
4818 for the file until you write to it).  To create a non-sparse
4819 file of zeroes, use C<guestfs_fallocate64> instead.");
4820
4821   ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4822    [InitScratchFS, Always, TestOutputStruct (
4823       [["touch"; "/utimens"];
4824        ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4825        ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4826    "set timestamp of a file with nanosecond precision",
4827    "\
4828 This command sets the timestamps of a file with nanosecond
4829 precision.
4830
4831 C<atsecs, atnsecs> are the last access time (atime) in secs and
4832 nanoseconds from the epoch.
4833
4834 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4835 secs and nanoseconds from the epoch.
4836
4837 If the C<*nsecs> field contains the special value C<-1> then
4838 the corresponding timestamp is set to the current time.  (The
4839 C<*secs> field is ignored in this case).
4840
4841 If the C<*nsecs> field contains the special value C<-2> then
4842 the corresponding timestamp is left unchanged.  (The
4843 C<*secs> field is ignored in this case).");
4844
4845   ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4846    [InitScratchFS, Always, TestOutputStruct (
4847       [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4848        ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4849    "create a directory with a particular mode",
4850    "\
4851 This command creates a directory, setting the initial permissions
4852 of the directory to C<mode>.
4853
4854 For common Linux filesystems, the actual mode which is set will
4855 be C<mode & ~umask & 01777>.  Non-native-Linux filesystems may
4856 interpret the mode in other ways.
4857
4858 See also C<guestfs_mkdir>, C<guestfs_umask>");
4859
4860   ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4861    [], (* XXX *)
4862    "change file owner and group",
4863    "\
4864 Change the file owner to C<owner> and group to C<group>.
4865 This is like C<guestfs_chown> but if C<path> is a symlink then
4866 the link itself is changed, not the target.
4867
4868 Only numeric uid and gid are supported.  If you want to use
4869 names, you will need to locate and parse the password file
4870 yourself (Augeas support makes this relatively easy).");
4871
4872   ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4873    [], (* XXX *)
4874    "lstat on multiple files",
4875    "\
4876 This call allows you to perform the C<guestfs_lstat> operation
4877 on multiple files, where all files are in the directory C<path>.
4878 C<names> is the list of files from this directory.
4879
4880 On return you get a list of stat structs, with a one-to-one
4881 correspondence to the C<names> list.  If any name did not exist
4882 or could not be lstat'd, then the C<ino> field of that structure
4883 is set to C<-1>.
4884
4885 This call is intended for programs that want to efficiently
4886 list a directory contents without making many round-trips.
4887 See also C<guestfs_lxattrlist> for a similarly efficient call
4888 for getting extended attributes.  Very long directory listings
4889 might cause the protocol message size to be exceeded, causing
4890 this call to fail.  The caller must split up such requests
4891 into smaller groups of names.");
4892
4893   ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4894    [], (* XXX *)
4895    "lgetxattr on multiple files",
4896    "\
4897 This call allows you to get the extended attributes
4898 of multiple files, where all files are in the directory C<path>.
4899 C<names> is the list of files from this directory.
4900
4901 On return you get a flat list of xattr structs which must be
4902 interpreted sequentially.  The first xattr struct always has a zero-length
4903 C<attrname>.  C<attrval> in this struct is zero-length
4904 to indicate there was an error doing C<lgetxattr> for this
4905 file, I<or> is a C string which is a decimal number
4906 (the number of following attributes for this file, which could
4907 be C<\"0\">).  Then after the first xattr struct are the
4908 zero or more attributes for the first named file.
4909 This repeats for the second and subsequent files.
4910
4911 This call is intended for programs that want to efficiently
4912 list a directory contents without making many round-trips.
4913 See also C<guestfs_lstatlist> for a similarly efficient call
4914 for getting standard stats.  Very long directory listings
4915 might cause the protocol message size to be exceeded, causing
4916 this call to fail.  The caller must split up such requests
4917 into smaller groups of names.");
4918
4919   ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4920    [], (* XXX *)
4921    "readlink on multiple files",
4922    "\
4923 This call allows you to do a C<readlink> operation
4924 on multiple files, where all files are in the directory C<path>.
4925 C<names> is the list of files from this directory.
4926
4927 On return you get a list of strings, with a one-to-one
4928 correspondence to the C<names> list.  Each string is the
4929 value of the symbolic link.
4930
4931 If the C<readlink(2)> operation fails on any name, then
4932 the corresponding result string is the empty string C<\"\">.
4933 However the whole operation is completed even if there
4934 were C<readlink(2)> errors, and so you can call this
4935 function with names where you don't know if they are
4936 symbolic links already (albeit slightly less efficient).
4937
4938 This call is intended for programs that want to efficiently
4939 list a directory contents without making many round-trips.
4940 Very long directory listings might cause the protocol
4941 message size to be exceeded, causing
4942 this call to fail.  The caller must split up such requests
4943 into smaller groups of names.");
4944
4945   ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4946    [InitISOFS, Always, TestOutputBuffer (
4947       [["pread"; "/known-4"; "1"; "3"]], "\n");
4948     InitISOFS, Always, TestOutputBuffer (
4949       [["pread"; "/empty"; "0"; "100"]], "")],
4950    "read part of a file",
4951    "\
4952 This command lets you read part of a file.  It reads C<count>
4953 bytes of the file, starting at C<offset>, from file C<path>.
4954
4955 This may read fewer bytes than requested.  For further details
4956 see the L<pread(2)> system call.
4957
4958 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4959
4960   ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4961    [InitEmpty, Always, TestRun (
4962       [["part_init"; "/dev/sda"; "gpt"]])],
4963    "create an empty partition table",
4964    "\
4965 This creates an empty partition table on C<device> of one of the
4966 partition types listed below.  Usually C<parttype> should be
4967 either C<msdos> or C<gpt> (for large disks).
4968
4969 Initially there are no partitions.  Following this, you should
4970 call C<guestfs_part_add> for each partition required.
4971
4972 Possible values for C<parttype> are:
4973
4974 =over 4
4975
4976 =item B<efi>
4977
4978 =item B<gpt>
4979
4980 Intel EFI / GPT partition table.
4981
4982 This is recommended for >= 2 TB partitions that will be accessed
4983 from Linux and Intel-based Mac OS X.  It also has limited backwards
4984 compatibility with the C<mbr> format.
4985
4986 =item B<mbr>
4987
4988 =item B<msdos>
4989
4990 The standard PC \"Master Boot Record\" (MBR) format used
4991 by MS-DOS and Windows.  This partition type will B<only> work
4992 for device sizes up to 2 TB.  For large disks we recommend
4993 using C<gpt>.
4994
4995 =back
4996
4997 Other partition table types that may work but are not
4998 supported include:
4999
5000 =over 4
5001
5002 =item B<aix>
5003
5004 AIX disk labels.
5005
5006 =item B<amiga>
5007
5008 =item B<rdb>
5009
5010 Amiga \"Rigid Disk Block\" format.
5011
5012 =item B<bsd>
5013
5014 BSD disk labels.
5015
5016 =item B<dasd>
5017
5018 DASD, used on IBM mainframes.
5019
5020 =item B<dvh>
5021
5022 MIPS/SGI volumes.
5023
5024 =item B<mac>
5025
5026 Old Mac partition format.  Modern Macs use C<gpt>.
5027
5028 =item B<pc98>
5029
5030 NEC PC-98 format, common in Japan apparently.
5031
5032 =item B<sun>
5033
5034 Sun disk labels.
5035
5036 =back");
5037
5038   ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
5039    [InitEmpty, Always, TestRun (
5040       [["part_init"; "/dev/sda"; "mbr"];
5041        ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
5042     InitEmpty, Always, TestRun (
5043       [["part_init"; "/dev/sda"; "gpt"];
5044        ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
5045        ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
5046     InitEmpty, Always, TestRun (
5047       [["part_init"; "/dev/sda"; "mbr"];
5048        ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
5049        ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
5050        ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
5051        ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
5052    "add a partition to the device",
5053    "\
5054 This command adds a partition to C<device>.  If there is no partition
5055 table on the device, call C<guestfs_part_init> first.
5056
5057 The C<prlogex> parameter is the type of partition.  Normally you
5058 should pass C<p> or C<primary> here, but MBR partition tables also
5059 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
5060 types.
5061
5062 C<startsect> and C<endsect> are the start and end of the partition
5063 in I<sectors>.  C<endsect> may be negative, which means it counts
5064 backwards from the end of the disk (C<-1> is the last sector).
5065
5066 Creating a partition which covers the whole disk is not so easy.
5067 Use C<guestfs_part_disk> to do that.");
5068
5069   ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [],
5070    [InitEmpty, Always, TestRun (
5071       [["part_disk"; "/dev/sda"; "mbr"]]);
5072     InitEmpty, Always, TestRun (
5073       [["part_disk"; "/dev/sda"; "gpt"]])],
5074    "partition whole disk with a single primary partition",
5075    "\
5076 This command is simply a combination of C<guestfs_part_init>
5077 followed by C<guestfs_part_add> to create a single primary partition
5078 covering the whole disk.
5079
5080 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
5081 but other possible values are described in C<guestfs_part_init>.");
5082
5083   ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
5084    [InitEmpty, Always, TestRun (
5085       [["part_disk"; "/dev/sda"; "mbr"];
5086        ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
5087    "make a partition bootable",
5088    "\
5089 This sets the bootable flag on partition numbered C<partnum> on
5090 device C<device>.  Note that partitions are numbered from 1.
5091
5092 The bootable flag is used by some operating systems (notably
5093 Windows) to determine which partition to boot from.  It is by
5094 no means universally recognized.");
5095
5096   ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
5097    [InitEmpty, Always, TestRun (
5098       [["part_disk"; "/dev/sda"; "gpt"];
5099        ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
5100    "set partition name",
5101    "\
5102 This sets the partition name on partition numbered C<partnum> on
5103 device C<device>.  Note that partitions are numbered from 1.
5104
5105 The partition name can only be set on certain types of partition
5106 table.  This works on C<gpt> but not on C<mbr> partitions.");
5107
5108   ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
5109    [], (* XXX Add a regression test for this. *)
5110    "list partitions on a device",
5111    "\
5112 This command parses the partition table on C<device> and
5113 returns the list of partitions found.
5114
5115 The fields in the returned structure are:
5116
5117 =over 4
5118
5119 =item B<part_num>
5120
5121 Partition number, counting from 1.
5122
5123 =item B<part_start>
5124
5125 Start of the partition I<in bytes>.  To get sectors you have to
5126 divide by the device's sector size, see C<guestfs_blockdev_getss>.
5127
5128 =item B<part_end>
5129
5130 End of the partition in bytes.
5131
5132 =item B<part_size>
5133
5134 Size of the partition in bytes.
5135
5136 =back");
5137
5138   ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
5139    [InitEmpty, Always, TestOutput (
5140       [["part_disk"; "/dev/sda"; "gpt"];
5141        ["part_get_parttype"; "/dev/sda"]], "gpt")],
5142    "get the partition table type",
5143    "\
5144 This command examines the partition table on C<device> and
5145 returns the partition table type (format) being used.
5146
5147 Common return values include: C<msdos> (a DOS/Windows style MBR
5148 partition table), C<gpt> (a GPT/EFI-style partition table).  Other
5149 values are possible, although unusual.  See C<guestfs_part_init>
5150 for a full list.");
5151
5152   ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
5153    [InitScratchFS, Always, TestOutputBuffer (
5154       [["fill"; "0x63"; "10"; "/fill"];
5155        ["read_file"; "/fill"]], "cccccccccc")],
5156    "fill a file with octets",
5157    "\
5158 This command creates a new file called C<path>.  The initial
5159 content of the file is C<len> octets of C<c>, where C<c>
5160 must be a number in the range C<[0..255]>.
5161
5162 To fill a file with zero bytes (sparsely), it is
5163 much more efficient to use C<guestfs_truncate_size>.
5164 To create a file with a pattern of repeating bytes
5165 use C<guestfs_fill_pattern>.");
5166
5167   ("available", (RErr, [StringList "groups"], []), 216, [],
5168    [InitNone, Always, TestRun [["available"; ""]]],
5169    "test availability of some parts of the API",
5170    "\
5171 This command is used to check the availability of some
5172 groups of functionality in the appliance, which not all builds of
5173 the libguestfs appliance will be able to provide.
5174
5175 The libguestfs groups, and the functions that those
5176 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
5177 You can also fetch this list at runtime by calling
5178 C<guestfs_available_all_groups>.
5179
5180 The argument C<groups> is a list of group names, eg:
5181 C<[\"inotify\", \"augeas\"]> would check for the availability of
5182 the Linux inotify functions and Augeas (configuration file
5183 editing) functions.
5184
5185 The command returns no error if I<all> requested groups are available.
5186
5187 It fails with an error if one or more of the requested
5188 groups is unavailable in the appliance.
5189
5190 If an unknown group name is included in the
5191 list of groups then an error is always returned.
5192
5193 I<Notes:>
5194
5195 =over 4
5196
5197 =item *
5198
5199 You must call C<guestfs_launch> before calling this function.
5200
5201 The reason is because we don't know what groups are
5202 supported by the appliance/daemon until it is running and can
5203 be queried.
5204
5205 =item *
5206
5207 If a group of functions is available, this does not necessarily
5208 mean that they will work.  You still have to check for errors
5209 when calling individual API functions even if they are
5210 available.
5211
5212 =item *
5213
5214 It is usually the job of distro packagers to build
5215 complete functionality into the libguestfs appliance.
5216 Upstream libguestfs, if built from source with all
5217 requirements satisfied, will support everything.
5218
5219 =item *
5220
5221 This call was added in version C<1.0.80>.  In previous
5222 versions of libguestfs all you could do would be to speculatively
5223 execute a command to find out if the daemon implemented it.
5224 See also C<guestfs_version>.
5225
5226 =back");
5227
5228   ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [DeprecatedBy "copy_device_to_device"],
5229    [InitScratchFS, Always, TestOutputBuffer (
5230       [["mkdir"; "/dd"];
5231        ["write"; "/dd/src"; "hello, world"];
5232        ["dd"; "/dd/src"; "/dd/dest"];
5233        ["read_file"; "/dd/dest"]], "hello, world")],
5234    "copy from source to destination using dd",
5235    "\
5236 This command copies from one source device or file C<src>
5237 to another destination device or file C<dest>.  Normally you
5238 would use this to copy to or from a device or partition, for
5239 example to duplicate a filesystem.
5240
5241 If the destination is a device, it must be as large or larger
5242 than the source file or device, otherwise the copy will fail.
5243 This command cannot do partial copies
5244 (see C<guestfs_copy_device_to_device>).");
5245
5246   ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
5247    [InitScratchFS, Always, TestOutputInt (
5248       [["write"; "/filesize"; "hello, world"];
5249        ["filesize"; "/filesize"]], 12)],
5250    "return the size of the file in bytes",
5251    "\
5252 This command returns the size of C<file> in bytes.
5253
5254 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
5255 C<guestfs_is_dir>, C<guestfs_is_file> etc.
5256 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
5257
5258   ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
5259    [InitBasicFSonLVM, Always, TestOutputList (
5260       [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
5261        ["lvs"]], ["/dev/VG/LV2"])],
5262    "rename an LVM logical volume",
5263    "\
5264 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
5265
5266   ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
5267    [InitBasicFSonLVM, Always, TestOutputList (
5268       [["umount"; "/"];
5269        ["vg_activate"; "false"; "VG"];
5270        ["vgrename"; "VG"; "VG2"];
5271        ["vg_activate"; "true"; "VG2"];
5272        ["mount_options"; ""; "/dev/VG2/LV"; "/"];
5273        ["vgs"]], ["VG2"])],
5274    "rename an LVM volume group",
5275    "\
5276 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
5277
5278   ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
5279    [InitISOFS, Always, TestOutputBuffer (
5280       [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
5281    "list the contents of a single file in an initrd",
5282    "\
5283 This command unpacks the file C<filename> from the initrd file
5284 called C<initrdpath>.  The filename must be given I<without> the
5285 initial C</> character.
5286
5287 For example, in guestfish you could use the following command
5288 to examine the boot script (usually called C</init>)
5289 contained in a Linux initrd or initramfs image:
5290
5291  initrd-cat /boot/initrd-<version>.img init
5292
5293 See also C<guestfs_initrd_list>.");
5294
5295   ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
5296    [],
5297    "get the UUID of a physical volume",
5298    "\
5299 This command returns the UUID of the LVM PV C<device>.");
5300
5301   ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
5302    [],
5303    "get the UUID of a volume group",
5304    "\
5305 This command returns the UUID of the LVM VG named C<vgname>.");
5306
5307   ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
5308    [],
5309    "get the UUID of a logical volume",
5310    "\
5311 This command returns the UUID of the LVM LV C<device>.");
5312
5313   ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
5314    [],
5315    "get the PV UUIDs containing the volume group",
5316    "\
5317 Given a VG called C<vgname>, this returns the UUIDs of all
5318 the physical volumes that this volume group resides on.
5319
5320 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
5321 calls to associate physical volumes and volume groups.
5322
5323 See also C<guestfs_vglvuuids>.");
5324
5325   ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
5326    [],
5327    "get the LV UUIDs of all LVs in the volume group",
5328    "\
5329 Given a VG called C<vgname>, this returns the UUIDs of all
5330 the logical volumes created in this volume group.
5331
5332 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
5333 calls to associate logical volumes and volume groups.
5334
5335 See also C<guestfs_vgpvuuids>.");
5336
5337   ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress; DeprecatedBy "copy_device_to_device"],
5338    [InitScratchFS, Always, TestOutputBuffer (
5339       [["mkdir"; "/copy_size"];
5340        ["write"; "/copy_size/src"; "hello, world"];
5341        ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
5342        ["read_file"; "/copy_size/dest"]], "hello")],
5343    "copy size bytes from source to destination using dd",
5344    "\
5345 This command copies exactly C<size> bytes from one source device
5346 or file C<src> to another destination device or file C<dest>.
5347
5348 Note this will fail if the source is too short or if the destination
5349 is not large enough.");
5350
5351   ("zero_device", (RErr, [Device "device"], []), 228, [Progress],
5352    [InitBasicFSonLVM, Always, TestRun (
5353       [["zero_device"; "/dev/VG/LV"]])],
5354    "write zeroes to an entire device",
5355    "\
5356 This command writes zeroes over the entire C<device>.  Compare
5357 with C<guestfs_zero> which just zeroes the first few blocks of
5358 a device.
5359
5360 If blocks are already zero, then this command avoids writing
5361 zeroes.  This prevents the underlying device from becoming non-sparse
5362 or growing unnecessarily.");
5363
5364   ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
5365    [InitScratchFS, Always, TestOutput (
5366       [["mkdir"; "/txz_in"];
5367        ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
5368        ["cat"; "/txz_in/hello"]], "hello\n")],
5369    "unpack compressed tarball to directory",
5370    "\
5371 This command uploads and unpacks local file C<tarball> (an
5372 I<xz compressed> tar file) into C<directory>.");
5373
5374   ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
5375    [],
5376    "pack directory into compressed tarball",
5377    "\
5378 This command packs the contents of C<directory> and downloads
5379 it to local file C<tarball> (as an xz compressed tar archive).");
5380
5381   ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"; DeprecatedBy "ntfsresize_opts"],
5382    [],
5383    "resize an NTFS filesystem",
5384    "\
5385 This command resizes an NTFS filesystem, expanding or
5386 shrinking it to the size of the underlying device.
5387
5388 I<Note:> After the resize operation, the filesystem is marked
5389 as requiring a consistency check (for safety).  You have to boot
5390 into Windows to perform this check and clear this condition.
5391 Furthermore, ntfsresize refuses to resize filesystems
5392 which have been marked in this way.  So in effect it is
5393 not possible to call ntfsresize multiple times on a single
5394 filesystem without booting into Windows between each resize.
5395
5396 See also L<ntfsresize(8)>.");
5397
5398   ("vgscan", (RErr, [], []), 232, [],
5399    [InitEmpty, Always, TestRun (
5400       [["vgscan"]])],
5401    "rescan for LVM physical volumes, volume groups and logical volumes",
5402    "\
5403 This rescans all block devices and rebuilds the list of LVM
5404 physical volumes, volume groups and logical volumes.");
5405
5406   ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5407    [InitEmpty, Always, TestRun (
5408       [["part_init"; "/dev/sda"; "mbr"];
5409        ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5410        ["part_del"; "/dev/sda"; "1"]])],
5411    "delete a partition",
5412    "\
5413 This command deletes the partition numbered C<partnum> on C<device>.
5414
5415 Note that in the case of MBR partitioning, deleting an
5416 extended partition also deletes any logical partitions
5417 it contains.");
5418
5419   ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5420    [InitEmpty, Always, TestOutputTrue (
5421       [["part_init"; "/dev/sda"; "mbr"];
5422        ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5423        ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5424        ["part_get_bootable"; "/dev/sda"; "1"]])],
5425    "return true if a partition is bootable",
5426    "\
5427 This command returns true if the partition C<partnum> on
5428 C<device> has the bootable flag set.
5429
5430 See also C<guestfs_part_set_bootable>.");
5431
5432   ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5433    [InitEmpty, Always, TestOutputInt (
5434       [["part_init"; "/dev/sda"; "mbr"];
5435        ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5436        ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5437        ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5438    "get the MBR type byte (ID byte) from a partition",
5439    "\
5440 Returns the MBR type byte (also known as the ID byte) from
5441 the numbered partition C<partnum>.
5442
5443 Note that only MBR (old DOS-style) partitions have type bytes.
5444 You will get undefined results for other partition table
5445 types (see C<guestfs_part_get_parttype>).");
5446
5447   ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5448    [], (* tested by part_get_mbr_id *)
5449    "set the MBR type byte (ID byte) of a partition",
5450    "\
5451 Sets the MBR type byte (also known as the ID byte) of
5452 the numbered partition C<partnum> to C<idbyte>.  Note
5453 that the type bytes quoted in most documentation are
5454 in fact hexadecimal numbers, but usually documented
5455 without any leading \"0x\" which might be confusing.
5456
5457 Note that only MBR (old DOS-style) partitions have type bytes.
5458 You will get undefined results for other partition table
5459 types (see C<guestfs_part_get_parttype>).");
5460
5461   ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5462    [InitISOFS, Always, TestOutputFileMD5 (
5463       [["checksum_device"; "md5"; "/dev/sdd"]],
5464       "../images/test.iso")],
5465    "compute MD5, SHAx or CRC checksum of the contents of a device",
5466    "\
5467 This call computes the MD5, SHAx or CRC checksum of the
5468 contents of the device named C<device>.  For the types of
5469 checksums supported see the C<guestfs_checksum> command.");
5470
5471   ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5472    [InitNone, Always, TestRun (
5473       [["part_disk"; "/dev/sda"; "mbr"];
5474        ["pvcreate"; "/dev/sda1"];
5475        ["vgcreate"; "VG"; "/dev/sda1"];
5476        ["lvcreate"; "LV"; "VG"; "10"];
5477        ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5478    "expand an LV to fill free space",
5479    "\
5480 This expands an existing logical volume C<lv> so that it fills
5481 C<pc>% of the remaining free space in the volume group.  Commonly
5482 you would call this with pc = 100 which expands the logical volume
5483 as much as possible, using all remaining free space in the volume
5484 group.");
5485
5486   ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5487    [], (* XXX Augeas code needs tests. *)
5488    "clear Augeas path",
5489    "\
5490 Set the value associated with C<path> to C<NULL>.  This
5491 is the same as the L<augtool(1)> C<clear> command.");
5492
5493   ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5494    [InitEmpty, Always, TestOutputInt (
5495       [["get_umask"]], 0o22)],
5496    "get the current umask",
5497    "\
5498 Return the current umask.  By default the umask is C<022>
5499 unless it has been set by calling C<guestfs_umask>.");
5500
5501   ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5502    [],
5503    "upload a file to the appliance (internal use only)",
5504    "\
5505 The C<guestfs_debug_upload> command uploads a file to
5506 the libguestfs appliance.
5507
5508 There is no comprehensive help for this command.  You have
5509 to look at the file C<daemon/debug.c> in the libguestfs source
5510 to find out what it is for.");
5511
5512   ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5513    [InitScratchFS, Always, TestOutput (
5514       [["base64_in"; "../images/hello.b64"; "/base64_in"];
5515        ["cat"; "/base64_in"]], "hello\n")],
5516    "upload base64-encoded data to file",
5517    "\
5518 This command uploads base64-encoded data from C<base64file>
5519 to C<filename>.");
5520
5521   ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5522    [],
5523    "download file and encode as base64",
5524    "\
5525 This command downloads the contents of C<filename>, writing
5526 it out to local file C<base64file> encoded as base64.");
5527
5528   ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5529    [],
5530    "compute MD5, SHAx or CRC checksum of files in a directory",
5531    "\
5532 This command computes the checksums of all regular files in
5533 C<directory> and then emits a list of those checksums to
5534 the local output file C<sumsfile>.
5535
5536 This can be used for verifying the integrity of a virtual
5537 machine.  However to be properly secure you should pay
5538 attention to the output of the checksum command (it uses
5539 the ones from GNU coreutils).  In particular when the
5540 filename is not printable, coreutils uses a special
5541 backslash syntax.  For more information, see the GNU
5542 coreutils info file.");
5543
5544   ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5545    [InitScratchFS, Always, TestOutputBuffer (
5546       [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5547        ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5548    "fill a file with a repeating pattern of bytes",
5549    "\
5550 This function is like C<guestfs_fill> except that it creates
5551 a new file of length C<len> containing the repeating pattern
5552 of bytes in C<pattern>.  The pattern is truncated if necessary
5553 to ensure the length of the file is exactly C<len> bytes.");
5554
5555   ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5556    [InitScratchFS, Always, TestOutput (
5557       [["write"; "/write"; "new file contents"];
5558        ["cat"; "/write"]], "new file contents");
5559     InitScratchFS, Always, TestOutput (
5560       [["write"; "/write2"; "\nnew file contents\n"];
5561        ["cat"; "/write2"]], "\nnew file contents\n");
5562     InitScratchFS, Always, TestOutput (
5563       [["write"; "/write3"; "\n\n"];
5564        ["cat"; "/write3"]], "\n\n");
5565     InitScratchFS, Always, TestOutput (
5566       [["write"; "/write4"; ""];
5567        ["cat"; "/write4"]], "");
5568     InitScratchFS, Always, TestOutput (
5569       [["write"; "/write5"; "\n\n\n"];
5570        ["cat"; "/write5"]], "\n\n\n");
5571     InitScratchFS, Always, TestOutput (
5572       [["write"; "/write6"; "\n"];
5573        ["cat"; "/write6"]], "\n")],
5574    "create a new file",
5575    "\
5576 This call creates a file called C<path>.  The content of the
5577 file is the string C<content> (which can contain any 8 bit data).
5578
5579 See also C<guestfs_write_append>.");
5580
5581   ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5582    [InitScratchFS, Always, TestOutput (
5583       [["write"; "/pwrite"; "new file contents"];
5584        ["pwrite"; "/pwrite"; "data"; "4"];
5585        ["cat"; "/pwrite"]], "new data contents");
5586     InitScratchFS, Always, TestOutput (
5587       [["write"; "/pwrite2"; "new file contents"];
5588        ["pwrite"; "/pwrite2"; "is extended"; "9"];
5589        ["cat"; "/pwrite2"]], "new file is extended");
5590     InitScratchFS, Always, TestOutput (
5591       [["write"; "/pwrite3"; "new file contents"];
5592        ["pwrite"; "/pwrite3"; ""; "4"];
5593        ["cat"; "/pwrite3"]], "new file contents")],
5594    "write to part of a file",
5595    "\
5596 This command writes to part of a file.  It writes the data
5597 buffer C<content> to the file C<path> starting at offset C<offset>.
5598
5599 This command implements the L<pwrite(2)> system call, and like
5600 that system call it may not write the full data requested.  The
5601 return value is the number of bytes that were actually written
5602 to the file.  This could even be 0, although short writes are
5603 unlikely for regular files in ordinary circumstances.
5604
5605 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5606
5607   ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5608    [],
5609    "resize an ext2, ext3 or ext4 filesystem (with size)",
5610    "\
5611 This command is the same as C<guestfs_resize2fs> except that it
5612 allows you to specify the new size (in bytes) explicitly.");
5613
5614   ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5615    [],
5616    "resize an LVM physical volume (with size)",
5617    "\
5618 This command is the same as C<guestfs_pvresize> except that it
5619 allows you to specify the new size (in bytes) explicitly.");
5620
5621   ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"; DeprecatedBy "ntfsresize_opts"],
5622    [],
5623    "resize an NTFS filesystem (with size)",
5624    "\
5625 This command is the same as C<guestfs_ntfsresize> except that it
5626 allows you to specify the new size (in bytes) explicitly.");
5627
5628   ("available_all_groups", (RStringList "groups", [], []), 251, [],
5629    [InitNone, Always, TestRun [["available_all_groups"]]],
5630    "return a list of all optional groups",
5631    "\
5632 This command returns a list of all optional groups that this
5633 daemon knows about.  Note this returns both supported and unsupported
5634 groups.  To find out which ones the daemon can actually support
5635 you have to call C<guestfs_available> on each member of the
5636 returned list.
5637
5638 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5639
5640   ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5641    [InitScratchFS, Always, TestOutputStruct (
5642       [["fallocate64"; "/fallocate64"; "1000000"];
5643        ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5644    "preallocate a file in the guest filesystem",
5645    "\
5646 This command preallocates a file (containing zero bytes) named
5647 C<path> of size C<len> bytes.  If the file exists already, it
5648 is overwritten.
5649
5650 Note that this call allocates disk blocks for the file.
5651 To create a sparse file use C<guestfs_truncate_size> instead.
5652
5653 The deprecated call C<guestfs_fallocate> does the same,
5654 but owing to an oversight it only allowed 30 bit lengths
5655 to be specified, effectively limiting the maximum size
5656 of files created through that call to 1GB.
5657
5658 Do not confuse this with the guestfish-specific
5659 C<alloc> and C<sparse> commands which create
5660 a file in the host and attach it as a device.");
5661
5662   ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5663    [InitBasicFS, Always, TestOutput (
5664        [["set_e2label"; "/dev/sda1"; "LTEST"];
5665         ["vfs_label"; "/dev/sda1"]], "LTEST")],
5666    "get the filesystem label",
5667    "\
5668 This returns the filesystem label of the filesystem on
5669 C<device>.
5670
5671 If the filesystem is unlabeled, this returns the empty string.
5672
5673 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5674
5675   ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5676    (let uuid = uuidgen () in
5677     [InitBasicFS, Always, TestOutput (
5678        [["set_e2uuid"; "/dev/sda1"; uuid];
5679         ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5680    "get the filesystem UUID",
5681    "\
5682 This returns the filesystem UUID of the filesystem on
5683 C<device>.
5684
5685 If the filesystem does not have a UUID, this returns the empty string.
5686
5687 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5688
5689   ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5690    (* Can't be tested with the current framework because
5691     * the VG is being used by the mounted filesystem, so
5692     * the vgchange -an command we do first will fail.
5693     *)
5694     [],
5695    "set LVM device filter",
5696    "\
5697 This sets the LVM device filter so that LVM will only be
5698 able to \"see\" the block devices in the list C<devices>,
5699 and will ignore all other attached block devices.
5700
5701 Where disk image(s) contain duplicate PVs or VGs, this
5702 command is useful to get LVM to ignore the duplicates, otherwise
5703 LVM can get confused.  Note also there are two types
5704 of duplication possible: either cloned PVs/VGs which have
5705 identical UUIDs; or VGs that are not cloned but just happen
5706 to have the same name.  In normal operation you cannot
5707 create this situation, but you can do it outside LVM, eg.
5708 by cloning disk images or by bit twiddling inside the LVM
5709 metadata.
5710
5711 This command also clears the LVM cache and performs a volume
5712 group scan.
5713
5714 You can filter whole block devices or individual partitions.
5715
5716 You cannot use this if any VG is currently in use (eg.
5717 contains a mounted filesystem), even if you are not
5718 filtering out that VG.");
5719
5720   ("lvm_clear_filter", (RErr, [], []), 256, [],
5721    [], (* see note on lvm_set_filter *)
5722    "clear LVM device filter",
5723    "\
5724 This undoes the effect of C<guestfs_lvm_set_filter>.  LVM
5725 will be able to see every block device.
5726
5727 This command also clears the LVM cache and performs a volume
5728 group scan.");
5729
5730   ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5731    [],
5732    "open a LUKS-encrypted block device",
5733    "\
5734 This command opens a block device which has been encrypted
5735 according to the Linux Unified Key Setup (LUKS) standard.
5736
5737 C<device> is the encrypted block device or partition.
5738
5739 The caller must supply one of the keys associated with the
5740 LUKS block device, in the C<key> parameter.
5741
5742 This creates a new block device called C</dev/mapper/mapname>.
5743 Reads and writes to this block device are decrypted from and
5744 encrypted to the underlying C<device> respectively.
5745
5746 If this block device contains LVM volume groups, then
5747 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5748 will make them visible.
5749
5750 Use C<guestfs_list_dm_devices> to list all device mapper
5751 devices.");
5752
5753   ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5754    [],
5755    "open a LUKS-encrypted block device read-only",
5756    "\
5757 This is the same as C<guestfs_luks_open> except that a read-only
5758 mapping is created.");
5759
5760   ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5761    [],
5762    "close a LUKS device",
5763    "\
5764 This closes a LUKS device that was created earlier by
5765 C<guestfs_luks_open> or C<guestfs_luks_open_ro>.  The
5766 C<device> parameter must be the name of the LUKS mapping
5767 device (ie. C</dev/mapper/mapname>) and I<not> the name
5768 of the underlying block device.");
5769
5770   ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"],
5771    [],
5772    "format a block device as a LUKS encrypted device",
5773    "\
5774 This command erases existing data on C<device> and formats
5775 the device as a LUKS encrypted device.  C<key> is the
5776 initial key, which is added to key slot C<slot>.  (LUKS
5777 supports 8 key slots, numbered 0-7).");
5778
5779   ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"],
5780    [],
5781    "format a block device as a LUKS encrypted device",
5782    "\
5783 This command is the same as C<guestfs_luks_format> but
5784 it also allows you to set the C<cipher> used.");
5785
5786   ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5787    [],
5788    "add a key on a LUKS encrypted device",
5789    "\
5790 This command adds a new key on LUKS device C<device>.
5791 C<key> is any existing key, and is used to access the device.
5792 C<newkey> is the new key to add.  C<keyslot> is the key slot
5793 that will be replaced.
5794
5795 Note that if C<keyslot> already contains a key, then this
5796 command will fail.  You have to use C<guestfs_luks_kill_slot>
5797 first to remove that key.");
5798
5799   ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5800    [],
5801    "remove a key from a LUKS encrypted device",
5802    "\
5803 This command deletes the key in key slot C<keyslot> from the
5804 encrypted LUKS device C<device>.  C<key> must be one of the
5805 I<other> keys.");
5806
5807   ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5808    [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5809       [["is_lv"; "/dev/VG/LV"]]);
5810     InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5811       [["is_lv"; "/dev/sda1"]])],
5812    "test if device is a logical volume",
5813    "\
5814 This command tests whether C<device> is a logical volume, and
5815 returns true iff this is the case.");
5816
5817   ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5818    [],
5819    "find a filesystem by UUID",
5820    "\
5821 This command searches the filesystems and returns the one
5822 which has the given UUID.  An error is returned if no such
5823 filesystem can be found.
5824
5825 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5826
5827   ("findfs_label", (RString "device", [String "label"], []), 266, [],
5828    [],
5829    "find a filesystem by label",
5830    "\
5831 This command searches the filesystems and returns the one
5832 which has the given label.  An error is returned if no such
5833 filesystem can be found.
5834
5835 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5836
5837   ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5838    [InitISOFS, Always, TestOutputFalse (
5839       [["is_chardev"; "/directory"]]);
5840     InitScratchFS, Always, TestOutputTrue (
5841       [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5842        ["is_chardev"; "/is_chardev"]])],
5843    "test if character device",
5844    "\
5845 This returns C<true> if and only if there is a character device
5846 with the given C<path> name.
5847
5848 See also C<guestfs_stat>.");
5849
5850   ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5851    [InitISOFS, Always, TestOutputFalse (
5852       [["is_blockdev"; "/directory"]]);
5853     InitScratchFS, Always, TestOutputTrue (
5854       [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5855        ["is_blockdev"; "/is_blockdev"]])],
5856    "test if block device",
5857    "\
5858 This returns C<true> if and only if there is a block device
5859 with the given C<path> name.
5860
5861 See also C<guestfs_stat>.");
5862
5863   ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5864    [InitISOFS, Always, TestOutputFalse (
5865       [["is_fifo"; "/directory"]]);
5866     InitScratchFS, Always, TestOutputTrue (
5867       [["mkfifo"; "0o777"; "/is_fifo"];
5868        ["is_fifo"; "/is_fifo"]])],
5869    "test if FIFO (named pipe)",
5870    "\
5871 This returns C<true> if and only if there is a FIFO (named pipe)
5872 with the given C<path> name.
5873
5874 See also C<guestfs_stat>.");
5875
5876   ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5877    [InitISOFS, Always, TestOutputFalse (
5878       [["is_symlink"; "/directory"]]);
5879     InitISOFS, Always, TestOutputTrue (
5880       [["is_symlink"; "/abssymlink"]])],
5881    "test if symbolic link",
5882    "\
5883 This returns C<true> if and only if there is a symbolic link
5884 with the given C<path> name.
5885
5886 See also C<guestfs_stat>.");
5887
5888   ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5889    (* XXX Need a positive test for sockets. *)
5890    [InitISOFS, Always, TestOutputFalse (
5891       [["is_socket"; "/directory"]])],
5892    "test if socket",
5893    "\
5894 This returns C<true> if and only if there is a Unix domain socket
5895 with the given C<path> name.
5896
5897 See also C<guestfs_stat>.");
5898
5899   ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5900    [InitPartition, Always, TestOutputDevice (
5901       [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5902     InitEmpty, Always, TestLastFail (
5903       [["part_to_dev"; "/dev/sda"]])],
5904    "convert partition name to device name",
5905    "\
5906 This function takes a partition name (eg. \"/dev/sdb1\") and
5907 removes the partition number, returning the device name
5908 (eg. \"/dev/sdb\").
5909
5910 The named partition must exist, for example as a string returned
5911 from C<guestfs_list_partitions>.
5912
5913 See also C<guestfs_part_to_partnum>.");
5914
5915   ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5916    (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5917     [InitScratchFS, Always, TestOutput (
5918        [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5919         ["checksum"; "md5"; "/upload_offset"]], md5)]),
5920    "upload a file from the local machine with offset",
5921    "\
5922 Upload local file C<filename> to C<remotefilename> on the
5923 filesystem.
5924
5925 C<remotefilename> is overwritten starting at the byte C<offset>
5926 specified.  The intention is to overwrite parts of existing
5927 files or devices, although if a non-existant file is specified
5928 then it is created with a \"hole\" before C<offset>.  The
5929 size of the data written is implicit in the size of the
5930 source C<filename>.
5931
5932 Note that there is no limit on the amount of data that
5933 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5934 and this call always writes the full amount unless an
5935 error occurs.
5936
5937 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5938
5939   ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5940    (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5941     let offset = string_of_int 100 in
5942     let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5943     [InitScratchFS, Always, TestOutput (
5944        (* Pick a file from cwd which isn't likely to change. *)
5945        [["mkdir"; "/download_offset"];
5946         ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5947         ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5948         ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5949         ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5950    "download a file to the local machine with offset and size",
5951    "\
5952 Download file C<remotefilename> and save it as C<filename>
5953 on the local machine.
5954
5955 C<remotefilename> is read for C<size> bytes starting at C<offset>
5956 (this region must be within the file or device).
5957
5958 Note that there is no limit on the amount of data that
5959 can be downloaded with this call, unlike with C<guestfs_pread>,
5960 and this call always reads the full amount unless an
5961 error occurs.
5962
5963 See also C<guestfs_download>, C<guestfs_pread>.");
5964
5965   ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5966    [InitPartition, Always, TestOutputListOfDevices (
5967       [["pwrite_device"; "/dev/sda"; "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"; "446"];
5968        ["blockdev_rereadpt"; "/dev/sda"];
5969        ["list_partitions"]], ["/dev/sdb1"])],
5970    "write to part of a device",
5971    "\
5972 This command writes to part of a device.  It writes the data
5973 buffer C<content> to C<device> starting at offset C<offset>.
5974
5975 This command implements the L<pwrite(2)> system call, and like
5976 that system call it may not write the full data requested
5977 (although short writes to disk devices and partitions are
5978 probably impossible with standard Linux kernels).
5979
5980 See also C<guestfs_pwrite>.");
5981
5982   ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5983    [InitEmpty, Always, TestOutputBuffer (
5984       [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5985    "read part of a device",
5986    "\
5987 This command lets you read part of a file.  It reads C<count>
5988 bytes of C<device>, starting at C<offset>.
5989
5990 This may read fewer bytes than requested.  For further details
5991 see the L<pread(2)> system call.
5992
5993 See also C<guestfs_pread>.");
5994
5995   ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5996    [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5997     [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5998     InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5999     [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
6000    "get canonical name of an LV",
6001    "\
6002 This converts alternative naming schemes for LVs that you
6003 might find to the canonical name.  For example, C</dev/mapper/VG-LV>
6004 is converted to C</dev/VG/LV>.
6005
6006 This command returns an error if the C<lvname> parameter does
6007 not refer to a logical volume.
6008
6009 See also C<guestfs_is_lv>.");
6010
6011   ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"; String "features"; Int "inode"; Int "sectorsize"]), 278, [],
6012    [InitEmpty, Always, TestOutput (
6013       [["part_disk"; "/dev/sda"; "mbr"];
6014        ["mkfs_opts"; "ext2"; "/dev/sda1"; ""; "NOARG"; ""; ""];
6015        ["mount_options"; ""; "/dev/sda1"; "/"];
6016        ["write"; "/new"; "new file contents"];
6017        ["cat"; "/new"]], "new file contents")],
6018    "make a filesystem",
6019    "\
6020 This function creates a filesystem on C<device>.  The filesystem
6021 type is C<fstype>, for example C<ext3>.
6022
6023 The optional arguments are:
6024
6025 =over 4
6026
6027 =item C<blocksize>
6028
6029 The filesystem block size.  Supported block sizes depend on the
6030 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
6031 for Linux ext2/3 filesystems.
6032
6033 For VFAT and NTFS the C<blocksize> parameter is treated as
6034 the requested cluster size.
6035
6036 For UFS block sizes, please see L<mkfs.ufs(8)>.
6037
6038 =item C<features>
6039
6040 This passes the I<-O> parameter to the external mkfs program.
6041
6042 For certain filesystem types, this allows extra filesystem
6043 features to be selected.  See L<mke2fs(8)> and L<mkfs.ufs(8)>
6044 for more details.
6045
6046 You cannot use this optional parameter with the C<gfs> or
6047 C<gfs2> filesystem type.
6048
6049 =item C<inode>
6050
6051 This passes the I<-I> parameter to the external L<mke2fs(8)> program
6052 which sets the inode size (only for ext2/3/4 filesystems at present).
6053
6054 =item C<sectorsize>
6055
6056 This passes the I<-S> parameter to external L<mkfs.ufs(8)> program,
6057 which sets sector size for ufs filesystem.
6058
6059 =back");
6060
6061   ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
6062    [],
6063    "get a single extended attribute",
6064    "\
6065 Get a single extended attribute from file C<path> named C<name>.
6066 This call follows symlinks.  If you want to lookup an extended
6067 attribute for the symlink itself, use C<guestfs_lgetxattr>.
6068
6069 Normally it is better to get all extended attributes from a file
6070 in one go by calling C<guestfs_getxattrs>.  However some Linux
6071 filesystem implementations are buggy and do not provide a way to
6072 list out attributes.  For these filesystems (notably ntfs-3g)
6073 you have to know the names of the extended attributes you want
6074 in advance and call this function.
6075
6076 Extended attribute values are blobs of binary data.  If there
6077 is no extended attribute named C<name>, this returns an error.
6078
6079 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
6080
6081   ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
6082    [],
6083    "get a single extended attribute",
6084    "\
6085 Get a single extended attribute from file C<path> named C<name>.
6086 If C<path> is a symlink, then this call returns an extended
6087 attribute from the symlink.
6088
6089 Normally it is better to get all extended attributes from a file
6090 in one go by calling C<guestfs_getxattrs>.  However some Linux
6091 filesystem implementations are buggy and do not provide a way to
6092 list out attributes.  For these filesystems (notably ntfs-3g)
6093 you have to know the names of the extended attributes you want
6094 in advance and call this function.
6095
6096 Extended attribute values are blobs of binary data.  If there
6097 is no extended attribute named C<name>, this returns an error.
6098
6099 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
6100
6101   ("resize2fs_M", (RErr, [Device "device"], []), 281, [],
6102    [],
6103    "resize an ext2, ext3 or ext4 filesystem to the minimum size",
6104    "\
6105 This command is the same as C<guestfs_resize2fs>, but the filesystem
6106 is resized to its minimum size.  This works like the I<-M> option
6107 to the C<resize2fs> command.
6108
6109 To get the resulting size of the filesystem you should call
6110 C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count>
6111 values.  These two numbers, multiplied together, give the
6112 resulting size of the minimal filesystem in bytes.");
6113
6114   ("internal_autosync", (RErr, [], []), 282, [NotInFish; NotInDocs],
6115    [],
6116    "internal autosync operation",
6117    "\
6118 This command performs the autosync operation just before the
6119 handle is closed.  You should not call this command directly.
6120 Instead, use the autosync flag (C<guestfs_set_autosync>) to
6121 control whether or not this operation is performed when the
6122 handle is closed.");
6123
6124   ("is_zero", (RBool "zeroflag", [Pathname "path"], []), 283, [],
6125    [InitISOFS, Always, TestOutputTrue (
6126       [["is_zero"; "/100kallzeroes"]]);
6127     InitISOFS, Always, TestOutputFalse (
6128       [["is_zero"; "/100kallspaces"]])],
6129    "test if a file contains all zero bytes",
6130    "\
6131 This returns true iff the file exists and the file is empty or
6132 it contains all zero bytes.");
6133
6134   ("is_zero_device", (RBool "zeroflag", [Device "device"], []), 284, [],
6135    [InitBasicFS, Always, TestOutputTrue (
6136       [["umount"; "/dev/sda1"];
6137        ["zero_device"; "/dev/sda1"];
6138        ["is_zero_device"; "/dev/sda1"]]);
6139     InitBasicFS, Always, TestOutputFalse (
6140       [["is_zero_device"; "/dev/sda1"]])],
6141    "test if a device contains all zero bytes",
6142    "\
6143 This returns true iff the device exists and contains all zero bytes.
6144
6145 Note that for large devices this can take a long time to run.");
6146
6147   ("list_9p", (RStringList "mounttags", [], []), 285, [],
6148    [],
6149    "list 9p filesystems",
6150    "\
6151 List all 9p filesystems attached to the guest.  A list of
6152 mount tags is returned.");
6153
6154   ("mount_9p", (RErr, [String "mounttag"; String "mountpoint"], [String "options"]), 286, [],
6155    [],
6156    "mount 9p filesystem",
6157    "\
6158 Mount the virtio-9p filesystem with the tag C<mounttag> on the
6159 directory C<mountpoint>.
6160
6161 If required, C<trans=virtio> will be automatically added to the options.
6162 Any other options required can be passed in the optional C<options>
6163 parameter.");
6164
6165   ("list_dm_devices", (RStringList "devices", [], []), 287, [],
6166    [],
6167    "list device mapper devices",
6168    "\
6169 List all device mapper devices.
6170
6171 The returned list contains C</dev/mapper/*> devices, eg. ones created
6172 by a previous call to C<guestfs_luks_open>.
6173
6174 Device mapper devices which correspond to logical volumes are I<not>
6175 returned in this list.  Call C<guestfs_lvs> if you want to list logical
6176 volumes.");
6177
6178   ("ntfsresize_opts", (RErr, [Device "device"], [Int64 "size"; Bool "force"]), 288, [Optional "ntfsprogs"],
6179    [],
6180    "resize an NTFS filesystem",
6181    "\
6182 This command resizes an NTFS filesystem, expanding or
6183 shrinking it to the size of the underlying device.
6184
6185 The optional parameters are:
6186
6187 =over 4
6188
6189 =item C<size>
6190
6191 The new size (in bytes) of the filesystem.  If omitted, the filesystem
6192 is resized to fit the container (eg. partition).
6193
6194 =item C<force>
6195
6196 If this option is true, then force the resize of the filesystem
6197 even if the filesystem is marked as requiring a consistency check.
6198
6199 After the resize operation, the filesystem is always marked
6200 as requiring a consistency check (for safety).  You have to boot
6201 into Windows to perform this check and clear this condition.
6202 If you I<don't> set the C<force> option then it is not
6203 possible to call C<guestfs_ntfsresize_opts> multiple times on a
6204 single filesystem without booting into Windows between each resize.
6205
6206 =back
6207
6208 See also L<ntfsresize(8)>.");
6209
6210   ("btrfs_filesystem_resize", (RErr, [Pathname "mountpoint"], [Int64 "size"]), 289, [Optional "btrfs"],
6211    [],
6212    "resize a btrfs filesystem",
6213    "\
6214 This command resizes a btrfs filesystem.
6215
6216 Note that unlike other resize calls, the filesystem has to be
6217 mounted and the parameter is the mountpoint not the device
6218 (this is a requirement of btrfs itself).
6219
6220 The optional parameters are:
6221
6222 =over 4
6223
6224 =item C<size>
6225
6226 The new size (in bytes) of the filesystem.  If omitted, the filesystem
6227 is resized to the maximum size.
6228
6229 =back
6230
6231 See also L<btrfs(8)>.");
6232
6233   ("write_append", (RErr, [Pathname "path"; BufferIn "content"], []), 290, [ProtocolLimitWarning],
6234    [InitScratchFS, Always, TestOutput (
6235       [["write"; "/write_append"; "line1\n"];
6236        ["write_append"; "/write_append"; "line2\n"];
6237        ["write_append"; "/write_append"; "line3a"];
6238        ["write_append"; "/write_append"; "line3b\n"];
6239        ["cat"; "/write_append"]], "line1\nline2\nline3aline3b\n")],
6240    "append content to end of file",
6241    "\
6242 This call appends C<content> to the end of file C<path>.  If
6243 C<path> does not exist, then a new file is created.
6244
6245 See also C<guestfs_write>.");
6246
6247   ("compress_out", (RErr, [String "ctype"; Pathname "file"; FileOut "zfile"], [Int "level"]), 291, [],
6248    [],
6249    "output compressed file",
6250    "\
6251 This command compresses C<file> and writes it out to the local
6252 file C<zfile>.
6253
6254 The compression program used is controlled by the C<ctype> parameter.
6255 Currently this includes: C<compress>, C<gzip>, C<bzip2>, C<xz> or C<lzop>.
6256 Some compression types may not be supported by particular builds of
6257 libguestfs, in which case you will get an error containing the
6258 substring \"not supported\".
6259
6260 The optional C<level> parameter controls compression level.  The
6261 meaning and default for this parameter depends on the compression
6262 program being used.");
6263
6264   ("compress_device_out", (RErr, [String "ctype"; Device "device"; FileOut "zdevice"], [Int "level"]), 292, [],
6265    [],
6266    "output compressed device",
6267    "\
6268 This command compresses C<device> and writes it out to the local
6269 file C<zdevice>.
6270
6271 The C<ctype> and optional C<level> parameters have the same meaning
6272 as in C<guestfs_compress_out>.");
6273
6274   ("part_to_partnum", (RInt "partnum", [Device "partition"], []), 293, [],
6275    [InitPartition, Always, TestOutputInt (
6276       [["part_to_partnum"; "/dev/sda1"]], 1);
6277     InitEmpty, Always, TestLastFail (
6278       [["part_to_partnum"; "/dev/sda"]])],
6279    "convert partition name to partition number",
6280    "\
6281 This function takes a partition name (eg. \"/dev/sdb1\") and
6282 returns the partition number (eg. C<1>).
6283
6284 The named partition must exist, for example as a string returned
6285 from C<guestfs_list_partitions>.
6286
6287 See also C<guestfs_part_to_dev>.");
6288
6289   ("copy_device_to_device", (RErr, [Device "src"; Device "dest"], [Int64 "srcoffset"; Int64 "destoffset"; Int64 "size"]), 294, [Progress],
6290    [],
6291    "copy from source device to destination device",
6292    "\
6293 The four calls C<guestfs_copy_device_to_device>,
6294 C<guestfs_copy_device_to_file>,
6295 C<guestfs_copy_file_to_device>, and
6296 C<guestfs_copy_file_to_file>
6297 let you copy from a source (device|file) to a destination
6298 (device|file).
6299
6300 Partial copies can be made since you can specify optionally
6301 the source offset, destination offset and size to copy.  These
6302 values are all specified in bytes.  If not given, the offsets
6303 both default to zero, and the size defaults to copying as much
6304 as possible until we hit the end of the source.
6305
6306 The source and destination may be the same object.  However
6307 overlapping regions may not be copied correctly.
6308
6309 If the destination is a file, it is created if required.  If
6310 the destination file is not large enough, it is extended.");
6311
6312   ("copy_device_to_file", (RErr, [Device "src"; Pathname "dest"], [Int64 "srcoffset"; Int64 "destoffset"; Int64 "size"]), 295, [Progress],
6313    [],
6314    "copy from source device to destination file",
6315    "\
6316 See C<guestfs_copy_device_to_device> for a general overview
6317 of this call.");
6318
6319   ("copy_file_to_device", (RErr, [Pathname "src"; Device "dest"], [Int64 "srcoffset"; Int64 "destoffset"; Int64 "size"]), 296, [Progress],
6320    [],
6321    "copy from source file to destination device",
6322    "\
6323 See C<guestfs_copy_device_to_device> for a general overview
6324 of this call.");
6325
6326   ("copy_file_to_file", (RErr, [Pathname "src"; Pathname "dest"], [Int64 "srcoffset"; Int64 "destoffset"; Int64 "size"]), 297, [Progress],
6327    [InitScratchFS, Always, TestOutputBuffer (
6328       [["mkdir"; "/copyff"];
6329        ["write"; "/copyff/src"; "hello, world"];
6330        ["copy_file_to_file"; "/copyff/src"; "/copyff/dest"; ""; ""; ""];
6331        ["read_file"; "/copyff/dest"]], "hello, world")],
6332    "copy from source file to destination file",
6333    "\
6334 See C<guestfs_copy_device_to_device> for a general overview
6335 of this call.
6336
6337 This is B<not> the function you want for copying files.  This
6338 is for copying blocks within existing files.  See C<guestfs_cp>,
6339 C<guestfs_cp_a> and C<guestfs_mv> for general file copying and
6340 moving functions.");
6341
6342   ("tune2fs", (RErr, [Device "device"], [Bool "force"; Int "maxmountcount"; Int "mountcount"; String "errorbehavior"; Int64 "group"; Int "intervalbetweenchecks"; Int "reservedblockspercentage"; String "lastmounteddirectory"; Int64 "reservedblockscount"; Int64 "user"]), 298, [],
6343    [InitScratchFS, Always, TestOutputHashtable (
6344      [["tune2fs"; "/dev/sdb1"; "false"; "0"; ""; "NOARG"; ""; "0"; ""; "NOARG"; ""; ""];
6345       ["tune2fs_l"; "/dev/sdb1"]],
6346      ["Check interval", "0 (<none>)";
6347       "Maximum mount count", "-1"]);
6348     InitScratchFS, Always, TestOutputHashtable (
6349       [["tune2fs"; "/dev/sdb1"; "false"; "0"; ""; "NOARG"; ""; "86400"; ""; "NOARG"; ""; ""];
6350        ["tune2fs_l"; "/dev/sdb1"]],
6351       ["Check interval", "86400 (1 day)";
6352        "Maximum mount count", "-1"]);
6353     InitScratchFS, Always, TestOutputHashtable (
6354       [["tune2fs"; "/dev/sdb1"; "false"; ""; ""; "NOARG"; "1"; ""; ""; "NOARG"; ""; "1"];
6355        ["tune2fs_l"; "/dev/sdb1"]],
6356       ["Reserved blocks uid", "1 (user bin)";
6357        "Reserved blocks gid", "1 (group bin)"]);
6358     InitScratchFS, Always, TestOutputHashtable (
6359       [["tune2fs"; "/dev/sdb1"; "false"; ""; ""; "NOARG"; "0"; ""; ""; "NOARG"; ""; "0"];
6360        ["tune2fs_l"; "/dev/sdb1"]],
6361       ["Reserved blocks uid", "0 (user root)";
6362        "Reserved blocks gid", "0 (group root)"])
6363    ],
6364    "adjust ext2/ext3/ext4 filesystem parameters",
6365    "\
6366 This call allows you to adjust various filesystem parameters of
6367 an ext2/ext3/ext4 filesystem called C<device>.
6368
6369 The optional parameters are:
6370
6371 =over 4
6372
6373 =item C<force>
6374
6375 Force tune2fs to complete the operation even in the face of errors.
6376 This is the same as the tune2fs C<-f> option.
6377
6378 =item C<maxmountcount>
6379
6380 Set the number of mounts after which the filesystem is checked
6381 by L<e2fsck(8)>.  If this is C<0> then the number of mounts is
6382 disregarded.  This is the same as the tune2fs C<-c> option.
6383
6384 =item C<mountcount>
6385
6386 Set the number of times the filesystem has been mounted.
6387 This is the same as the tune2fs C<-C> option.
6388
6389 =item C<errorbehavior>
6390
6391 Change the behavior of the kernel code when errors are detected.
6392 Possible values currently are: C<continue>, C<remount-ro>, C<panic>.
6393 In practice these options don't really make any difference,
6394 particularly for write errors.
6395
6396 This is the same as the tune2fs C<-e> option.
6397
6398 =item C<group>
6399
6400 Set the group which can use reserved filesystem blocks.
6401 This is the same as the tune2fs C<-g> option except that it
6402 can only be specified as a number.
6403
6404 =item C<intervalbetweenchecks>
6405
6406 Adjust the maximal time between two filesystem checks
6407 (in seconds).  If the option is passed as C<0> then
6408 time-dependent checking is disabled.
6409
6410 This is the same as the tune2fs C<-i> option.
6411
6412 =item C<reservedblockspercentage>
6413
6414 Set the percentage of the filesystem which may only be allocated
6415 by privileged processes.
6416 This is the same as the tune2fs C<-m> option.
6417
6418 =item C<lastmounteddirectory>
6419
6420 Set the last mounted directory.
6421 This is the same as the tune2fs C<-M> option.
6422
6423 =item C<reservedblockscount>
6424 Set the number of reserved filesystem blocks.
6425 This is the same as the tune2fs C<-r> option.
6426
6427 =item C<user>
6428
6429 Set the user who can use the reserved filesystem blocks.
6430 This is the same as the tune2fs C<-u> option except that it
6431 can only be specified as a number.
6432
6433 =back
6434
6435 To get the current values of filesystem parameters, see
6436 C<guestfs_tune2fs_l>.  For precise details of how tune2fs
6437 works, see the L<tune2fs(8)> man page.");
6438
6439   ("md_create", (RErr, [String "name"; DeviceList "devices"], [Int64 "missingbitmap"; Int "nrdevices"; Int "spare"; Int64 "chunk"; String "level"]), 299, [Optional "mdadm"],
6440    [],
6441    "create a Linux md (RAID) device",
6442    "\
6443 Create a Linux md (RAID) device named C<name> on the devices
6444 in the list C<devices>.
6445
6446 The optional parameters are:
6447
6448 =over 4
6449
6450 =item C<missingbitmap>
6451
6452 A bitmap of missing devices.  If a bit is set it means that a
6453 missing device is added to the array.  The least significant bit
6454 corresponds to the first device in the array.
6455
6456 As examples:
6457
6458 If C<devices = [\"/dev/sda\"]> and C<missingbitmap = 0x1> then
6459 the resulting array would be C<[E<lt>missingE<gt>, \"/dev/sda\"]>.
6460
6461 If C<devices = [\"/dev/sda\"]> and C<missingbitmap = 0x2> then
6462 the resulting array would be C<[\"/dev/sda\", E<lt>missingE<gt>]>.
6463
6464 This defaults to C<0> (no missing devices).
6465
6466 The length of C<devices> + the number of bits set in
6467 C<missingbitmap> must equal C<nrdevices> + C<spare>.
6468
6469 =item C<nrdevices>
6470
6471 The number of active RAID devices.
6472
6473 If not set, this defaults to the length of C<devices> plus
6474 the number of bits set in C<missingbitmap>.
6475
6476 =item C<spare>
6477
6478 The number of spare devices.
6479
6480 If not set, this defaults to C<0>.
6481
6482 =item C<chunk>
6483
6484 The chunk size in bytes.
6485
6486 =item C<level>
6487
6488 The RAID level, which can be one of:
6489 I<linear>, I<raid0>, I<0>, I<stripe>, I<raid1>, I<1>, I<mirror>,
6490 I<raid4>, I<4>, I<raid5>, I<5>, I<raid6>, I<6>, I<raid10>, I<10>.
6491 Some of these are synonymous, and more levels may be added in future.
6492
6493 If not set, this defaults to C<raid1>.
6494
6495 =back");
6496
6497   ("list_md_devices", (RStringList "devices", [], []), 300, [],
6498    [],
6499    "list Linux md (RAID) devices",
6500    "\
6501 List all Linux md devices.");
6502
6503   ("md_detail", (RHashtable "info", [Device "md"], []), 301,  [Optional "mdadm"],
6504    [],
6505    "obtain metadata for an MD device",
6506    "\
6507 This command exposes the output of 'mdadm -DY <md>'. The following fields are
6508 usually present in the returned hash. Other fields may also be present.
6509
6510 =over
6511
6512 =item C<level>
6513
6514 The raid level of the MD device.
6515
6516 =item C<devices>
6517
6518 The number of underlying devices in the MD device.
6519
6520 =item C<metadata>
6521
6522 The metadata version used.
6523
6524 =item C<uuid>
6525
6526 The UUID of the MD device.
6527
6528 =item C<name>
6529
6530 The name of the MD device.
6531
6532 =back");
6533
6534   ("md_stop", (RErr, [Device "md"], []), 302, [Optional "mdadm"],
6535    [],
6536    "stop a Linux md (RAID) device",
6537    "\
6538 This command deactivates the MD array named C<md>.  The
6539 device is stopped, but it is not destroyed or zeroed.");
6540
6541   ("blkid", (RHashtable "info", [Device "device"], []), 303, [],
6542    [InitScratchFS, Always, TestOutputHashtable (
6543       [["blkid"; "/dev/sdb1"]],
6544       ["TYPE", "ext2";
6545        "USAGE", "filesystem";
6546        "PART_ENTRY_NUMBER", "1";
6547        "PART_ENTRY_TYPE", "0x83";
6548        "PART_ENTRY_OFFSET", "128";
6549        "PART_ENTRY_SIZE", "102145"])],
6550    "print block device attributes",
6551    "\
6552 This command returns block device attributes for C<device>. The following fields are
6553 usually present in the returned hash. Other fields may also be present.
6554
6555 =over
6556
6557 =item C<UUID>
6558
6559 The uuid of this device.
6560
6561 =item C<LABEL>
6562
6563 The label of this device.
6564
6565 =item C<VERSION>
6566
6567 The version of blkid command.
6568
6569 =item C<TYPE>
6570
6571 The filesystem type or RAID of this device.
6572
6573 =item C<USAGE>
6574
6575 The usage of this device, for example C<filesystem> or C<raid>.
6576
6577 =back");
6578
6579 ]
6580
6581 let all_functions = non_daemon_functions @ daemon_functions
6582
6583 (* In some places we want the functions to be displayed sorted
6584  * alphabetically, so this is useful:
6585  *)
6586 let all_functions_sorted = List.sort action_compare all_functions
6587
6588 (* This is used to generate the src/MAX_PROC_NR file which
6589  * contains the maximum procedure number, a surrogate for the
6590  * ABI version number.  See src/Makefile.am for the details.
6591  *)
6592 let max_proc_nr =
6593   let proc_nrs = List.map (
6594     fun (_, _, proc_nr, _, _, _, _) -> proc_nr
6595   ) daemon_functions in
6596   List.fold_left max 0 proc_nrs
6597
6598 (* Non-API meta-commands available only in guestfish.
6599  *
6600  * Note (1): style, proc_nr and tests fields are all meaningless.
6601  * The only fields which are actually used are the shortname,
6602  * FishAlias flags, shortdesc and longdesc.
6603  *
6604  * Note (2): to refer to other commands, use L</shortname>.
6605  *
6606  * Note (3): keep this list sorted by shortname.
6607  *)
6608 let fish_commands = [
6609   ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
6610    "allocate and add a disk file",
6611    " alloc filename size
6612
6613 This creates an empty (zeroed) file of the given size, and then adds
6614 so it can be further examined.
6615
6616 For more advanced image creation, see L<qemu-img(1)> utility.
6617
6618 Size can be specified using standard suffixes, eg. C<1M>.
6619
6620 To create a sparse file, use L</sparse> instead.  To create a
6621 prepared disk image, see L</PREPARED DISK IMAGES>.");
6622
6623   ("copy_in", (RErr,[], []), -1, [], [],
6624    "copy local files or directories into an image",
6625    " copy-in local [local ...] /remotedir
6626
6627 C<copy-in> copies local files or directories recursively into the disk
6628 image, placing them in the directory called C</remotedir> (which must
6629 exist).  This guestfish meta-command turns into a sequence of
6630 L</tar-in> and other commands as necessary.
6631
6632 Multiple local files and directories can be specified, but the last
6633 parameter must always be a remote directory.  Wildcards cannot be
6634 used.");
6635
6636   ("copy_out", (RErr,[], []), -1, [], [],
6637    "copy remote files or directories out of an image",
6638    " copy-out remote [remote ...] localdir
6639
6640 C<copy-out> copies remote files or directories recursively out of the
6641 disk image, placing them on the host disk in a local directory called
6642 C<localdir> (which must exist).  This guestfish meta-command turns
6643 into a sequence of L</download>, L</tar-out> and other commands as
6644 necessary.
6645
6646 Multiple remote files and directories can be specified, but the last
6647 parameter must always be a local directory.  To download to the
6648 current directory, use C<.> as in:
6649
6650  copy-out /home .
6651
6652 Wildcards cannot be used in the ordinary command, but you can use
6653 them with the help of L</glob> like this:
6654
6655  glob copy-out /home/* .");
6656
6657   ("display", (RErr,[], []), -1, [], [],
6658    "display an image",
6659    " display filename
6660
6661 Use C<display> (a graphical display program) to display an image
6662 file.  It downloads the file, and runs C<display> on it.
6663
6664 To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE>
6665 environment variable.  For example to use the GNOME display program:
6666
6667  export GUESTFISH_DISPLAY_IMAGE=eog
6668
6669 See also L<display(1)>.");
6670
6671   ("echo", (RErr,[], []), -1, [], [],
6672    "display a line of text",
6673    " echo [params ...]
6674
6675 This echos the parameters to the terminal.");
6676
6677   ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
6678    "edit a file",
6679    " edit filename
6680
6681 This is used to edit a file.  It downloads the file, edits it
6682 locally using your editor, then uploads the result.
6683
6684 The editor is C<$EDITOR>.  However if you use the alternate
6685 commands C<vi> or C<emacs> you will get those corresponding
6686 editors.");
6687
6688   ("glob", (RErr,[], []), -1, [], [],
6689    "expand wildcards in command",
6690    " glob command args...
6691
6692 Expand wildcards in any paths in the args list, and run C<command>
6693 repeatedly on each matching path.
6694
6695 See L</WILDCARDS AND GLOBBING>.");
6696
6697   ("hexedit", (RErr,[], []), -1, [], [],
6698    "edit with a hex editor",
6699    " hexedit <filename|device>
6700  hexedit <filename|device> <max>
6701  hexedit <filename|device> <start> <max>
6702
6703 Use hexedit (a hex editor) to edit all or part of a binary file
6704 or block device.
6705
6706 This command works by downloading potentially the whole file or
6707 device, editing it locally, then uploading it.  If the file or
6708 device is large, you have to specify which part you wish to edit
6709 by using C<max> and/or C<start> C<max> parameters.
6710 C<start> and C<max> are specified in bytes, with the usual
6711 modifiers allowed such as C<1M> (1 megabyte).
6712
6713 For example to edit the first few sectors of a disk you
6714 might do:
6715
6716  hexedit /dev/sda 1M
6717
6718 which would allow you to edit anywhere within the first megabyte
6719 of the disk.
6720
6721 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
6722
6723  hexedit /dev/sda1 0x400 0x400
6724
6725 (assuming the superblock is in the standard location).
6726
6727 This command requires the external L<hexedit(1)> program.  You
6728 can specify another program to use by setting the C<HEXEDITOR>
6729 environment variable.
6730
6731 See also L</hexdump>.");
6732
6733   ("lcd", (RErr,[], []), -1, [], [],
6734    "change working directory",
6735    " lcd directory
6736
6737 Change the local directory, ie. the current directory of guestfish
6738 itself.
6739
6740 Note that C<!cd> won't do what you might expect.");
6741
6742   ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
6743    "open the manual",
6744    "  man
6745
6746 Opens the manual page for guestfish.");
6747
6748   ("more", (RErr,[], []), -1, [FishAlias "less"], [],
6749    "view a file",
6750    " more filename
6751
6752  less filename
6753
6754 This is used to view a file.
6755
6756 The default viewer is C<$PAGER>.  However if you use the alternate
6757 command C<less> you will get the C<less> command specifically.");
6758
6759   ("reopen", (RErr,[], []), -1, [], [],
6760    "close and reopen libguestfs handle",
6761    "  reopen
6762
6763 Close and reopen the libguestfs handle.  It is not necessary to use
6764 this normally, because the handle is closed properly when guestfish
6765 exits.  However this is occasionally useful for testing.");
6766
6767   ("setenv", (RErr,[], []), -1, [], [],
6768    "set an environment variable",
6769    "  setenv VAR value
6770
6771 Set the environment variable C<VAR> to the string C<value>.
6772
6773 To print the value of an environment variable use a shell command
6774 such as:
6775
6776  !echo $VAR");
6777
6778   ("sparse", (RErr,[], []), -1, [], [],
6779    "create a sparse disk image and add",
6780    " sparse filename size
6781
6782 This creates an empty sparse file of the given size, and then adds
6783 so it can be further examined.
6784
6785 In all respects it works the same as the L</alloc> command, except that
6786 the image file is allocated sparsely, which means that disk blocks are
6787 not assigned to the file until they are needed.  Sparse disk files
6788 only use space when written to, but they are slower and there is a
6789 danger you could run out of real disk space during a write operation.
6790
6791 For more advanced image creation, see L<qemu-img(1)> utility.
6792
6793 Size can be specified using standard suffixes, eg. C<1M>.");
6794
6795   ("supported", (RErr,[], []), -1, [], [],
6796    "list supported groups of commands",
6797    " supported
6798
6799 This command returns a list of the optional groups
6800 known to the daemon, and indicates which ones are
6801 supported by this build of the libguestfs appliance.
6802
6803 See also L<guestfs(3)/AVAILABILITY>.");
6804
6805   ("time", (RErr,[], []), -1, [], [],
6806    "print elapsed time taken to run a command",
6807    " time command args...
6808
6809 Run the command as usual, but print the elapsed time afterwards.  This
6810 can be useful for benchmarking operations.");
6811
6812   ("unsetenv", (RErr,[], []), -1, [], [],
6813    "unset an environment variable",
6814    "  unsetenv VAR
6815
6816 Remove C<VAR> from the environment.");
6817
6818 ]