New APIs: inspect-get-package-format, inspect-get-package-management.
[libguestfs.git] / generator / generator_actions.ml
1 (* libguestfs
2  * Copyright (C) 2009-2010 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"],
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],
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 C<-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 C<-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 run C<guestfs_umount_all> followed by
286 C<guestfs_sync> 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 (to C<stderr>).
304
305 Verbose messages are disabled unless the environment variable
306 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
307
308   ("get_verbose", (RBool "verbose", [], []), -1, [],
309    [],
310    "get verbose mode",
311    "\
312 This returns the verbose messages flag.");
313
314   ("is_ready", (RBool "ready", [], []), -1, [],
315    [InitNone, Always, TestOutputTrue (
316       [["is_ready"]])],
317    "is ready to accept commands",
318    "\
319 This returns true iff this handle is ready to accept commands
320 (in the C<READY> state).
321
322 For more information on states, see L<guestfs(3)>.");
323
324   ("is_config", (RBool "config", [], []), -1, [],
325    [InitNone, Always, TestOutputFalse (
326       [["is_config"]])],
327    "is in configuration state",
328    "\
329 This returns true iff this handle is being configured
330 (in the C<CONFIG> state).
331
332 For more information on states, see L<guestfs(3)>.");
333
334   ("is_launching", (RBool "launching", [], []), -1, [],
335    [InitNone, Always, TestOutputFalse (
336       [["is_launching"]])],
337    "is launching subprocess",
338    "\
339 This returns true iff this handle is launching the subprocess
340 (in the C<LAUNCHING> state).
341
342 For more information on states, see L<guestfs(3)>.");
343
344   ("is_busy", (RBool "busy", [], []), -1, [],
345    [InitNone, Always, TestOutputFalse (
346       [["is_busy"]])],
347    "is busy processing a command",
348    "\
349 This returns true iff this handle is busy processing a command
350 (in the C<BUSY> state).
351
352 For more information on states, see L<guestfs(3)>.");
353
354   ("get_state", (RInt "state", [], []), -1, [],
355    [],
356    "get the current state",
357    "\
358 This returns the current state as an opaque integer.  This is
359 only useful for printing debug and internal error messages.
360
361 For more information on states, see L<guestfs(3)>.");
362
363   ("set_memsize", (RErr, [Int "memsize"], []), -1, [FishAlias "memsize"],
364    [InitNone, Always, TestOutputInt (
365       [["set_memsize"; "500"];
366        ["get_memsize"]], 500)],
367    "set memory allocated to the qemu subprocess",
368    "\
369 This sets the memory size in megabytes allocated to the
370 qemu subprocess.  This only has any effect if called before
371 C<guestfs_launch>.
372
373 You can also change this by setting the environment
374 variable C<LIBGUESTFS_MEMSIZE> before the handle is
375 created.
376
377 For more information on the architecture of libguestfs,
378 see L<guestfs(3)>.");
379
380   ("get_memsize", (RInt "memsize", [], []), -1, [],
381    [InitNone, Always, TestOutputIntOp (
382       [["get_memsize"]], ">=", 256)],
383    "get memory allocated to the qemu subprocess",
384    "\
385 This gets the memory size in megabytes allocated to the
386 qemu subprocess.
387
388 If C<guestfs_set_memsize> was not called
389 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
390 then this returns the compiled-in default value for memsize.
391
392 For more information on the architecture of libguestfs,
393 see L<guestfs(3)>.");
394
395   ("get_pid", (RInt "pid", [], []), -1, [FishAlias "pid"],
396    [InitNone, Always, TestOutputIntOp (
397       [["get_pid"]], ">=", 1)],
398    "get PID of qemu subprocess",
399    "\
400 Return the process ID of the qemu subprocess.  If there is no
401 qemu subprocess, then this will return an error.
402
403 This is an internal call used for debugging and testing.");
404
405   ("version", (RStruct ("version", "version"), [], []), -1, [],
406    [InitNone, Always, TestOutputStruct (
407       [["version"]], [CompareWithInt ("major", 1)])],
408    "get the library version number",
409    "\
410 Return the libguestfs version number that the program is linked
411 against.
412
413 Note that because of dynamic linking this is not necessarily
414 the version of libguestfs that you compiled against.  You can
415 compile the program, and then at runtime dynamically link
416 against a completely different C<libguestfs.so> library.
417
418 This call was added in version C<1.0.58>.  In previous
419 versions of libguestfs there was no way to get the version
420 number.  From C code you can use dynamic linker functions
421 to find out if this symbol exists (if it doesn't, then
422 it's an earlier version).
423
424 The call returns a structure with four elements.  The first
425 three (C<major>, C<minor> and C<release>) are numbers and
426 correspond to the usual version triplet.  The fourth element
427 (C<extra>) is a string and is normally empty, but may be
428 used for distro-specific information.
429
430 To construct the original version string:
431 C<$major.$minor.$release$extra>
432
433 See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>.
434
435 I<Note:> Don't use this call to test for availability
436 of features.  In enterprise distributions we backport
437 features from later versions into earlier versions,
438 making this an unreliable way to test for features.
439 Use C<guestfs_available> instead.");
440
441   ("set_selinux", (RErr, [Bool "selinux"], []), -1, [FishAlias "selinux"],
442    [InitNone, Always, TestOutputTrue (
443       [["set_selinux"; "true"];
444        ["get_selinux"]])],
445    "set SELinux enabled or disabled at appliance boot",
446    "\
447 This sets the selinux flag that is passed to the appliance
448 at boot time.  The default is C<selinux=0> (disabled).
449
450 Note that if SELinux is enabled, it is always in
451 Permissive mode (C<enforcing=0>).
452
453 For more information on the architecture of libguestfs,
454 see L<guestfs(3)>.");
455
456   ("get_selinux", (RBool "selinux", [], []), -1, [],
457    [],
458    "get SELinux enabled flag",
459    "\
460 This returns the current setting of the selinux flag which
461 is passed to the appliance at boot time.  See C<guestfs_set_selinux>.
462
463 For more information on the architecture of libguestfs,
464 see L<guestfs(3)>.");
465
466   ("set_trace", (RErr, [Bool "trace"], []), -1, [FishAlias "trace"],
467    [InitNone, Always, TestOutputFalse (
468       [["set_trace"; "false"];
469        ["get_trace"]])],
470    "enable or disable command traces",
471    "\
472 If the command trace flag is set to 1, then commands are
473 printed on stderr before they are executed in a format
474 which is very similar to the one used by guestfish.  In
475 other words, you can run a program with this enabled, and
476 you will get out a script which you can feed to guestfish
477 to perform the same set of actions.
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   ("get_trace", (RBool "trace", [], []), -1, [],
487    [],
488    "get command trace enabled flag",
489    "\
490 Return the command trace flag.");
491
492   ("set_direct", (RErr, [Bool "direct"], []), -1, [FishAlias "direct"],
493    [InitNone, Always, TestOutputFalse (
494       [["set_direct"; "false"];
495        ["get_direct"]])],
496    "enable or disable direct appliance mode",
497    "\
498 If the direct appliance mode flag is enabled, then stdin and
499 stdout are passed directly through to the appliance once it
500 is launched.
501
502 One consequence of this is that log messages aren't caught
503 by the library and handled by C<guestfs_set_log_message_callback>,
504 but go straight to stdout.
505
506 You probably don't want to use this unless you know what you
507 are doing.
508
509 The default is disabled.");
510
511   ("get_direct", (RBool "direct", [], []), -1, [],
512    [],
513    "get direct appliance mode flag",
514    "\
515 Return the direct appliance mode flag.");
516
517   ("set_recovery_proc", (RErr, [Bool "recoveryproc"], []), -1, [FishAlias "recovery-proc"],
518    [InitNone, Always, TestOutputTrue (
519       [["set_recovery_proc"; "true"];
520        ["get_recovery_proc"]])],
521    "enable or disable the recovery process",
522    "\
523 If this is called with the parameter C<false> then
524 C<guestfs_launch> does not create a recovery process.  The
525 purpose of the recovery process is to stop runaway qemu
526 processes in the case where the main program aborts abruptly.
527
528 This only has any effect if called before C<guestfs_launch>,
529 and the default is true.
530
531 About the only time when you would want to disable this is
532 if the main process will fork itself into the background
533 (\"daemonize\" itself).  In this case the recovery process
534 thinks that the main program has disappeared and so kills
535 qemu, which is not very helpful.");
536
537   ("get_recovery_proc", (RBool "recoveryproc", [], []), -1, [],
538    [],
539    "get recovery process enabled flag",
540    "\
541 Return the recovery process enabled flag.");
542
543   ("add_drive_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
544    [],
545    "add a drive specifying the QEMU block emulation to use",
546    "\
547 This is the same as C<guestfs_add_drive> but it allows you
548 to specify the QEMU interface emulation to use at run time.");
549
550   ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
551    [],
552    "add a drive read-only specifying the QEMU block emulation to use",
553    "\
554 This is the same as C<guestfs_add_drive_ro> but it allows you
555 to specify the QEMU interface emulation to use at run time.");
556
557   ("file_architecture", (RString "arch", [Pathname "filename"], []), -1, [],
558    [InitISOFS, Always, TestOutput (
559       [["file_architecture"; "/bin-i586-dynamic"]], "i386");
560     InitISOFS, Always, TestOutput (
561       [["file_architecture"; "/bin-sparc-dynamic"]], "sparc");
562     InitISOFS, Always, TestOutput (
563       [["file_architecture"; "/bin-win32.exe"]], "i386");
564     InitISOFS, Always, TestOutput (
565       [["file_architecture"; "/bin-win64.exe"]], "x86_64");
566     InitISOFS, Always, TestOutput (
567       [["file_architecture"; "/bin-x86_64-dynamic"]], "x86_64");
568     InitISOFS, Always, TestOutput (
569       [["file_architecture"; "/lib-i586.so"]], "i386");
570     InitISOFS, Always, TestOutput (
571       [["file_architecture"; "/lib-sparc.so"]], "sparc");
572     InitISOFS, Always, TestOutput (
573       [["file_architecture"; "/lib-win32.dll"]], "i386");
574     InitISOFS, Always, TestOutput (
575       [["file_architecture"; "/lib-win64.dll"]], "x86_64");
576     InitISOFS, Always, TestOutput (
577       [["file_architecture"; "/lib-x86_64.so"]], "x86_64");
578     InitISOFS, Always, TestOutput (
579       [["file_architecture"; "/initrd-x86_64.img"]], "x86_64");
580     InitISOFS, Always, TestOutput (
581       [["file_architecture"; "/initrd-x86_64.img.gz"]], "x86_64");],
582    "detect the architecture of a binary file",
583    "\
584 This detects the architecture of the binary C<filename>,
585 and returns it if known.
586
587 Currently defined architectures are:
588
589 =over 4
590
591 =item \"i386\"
592
593 This string is returned for all 32 bit i386, i486, i586, i686 binaries
594 irrespective of the precise processor requirements of the binary.
595
596 =item \"x86_64\"
597
598 64 bit x86-64.
599
600 =item \"sparc\"
601
602 32 bit SPARC.
603
604 =item \"sparc64\"
605
606 64 bit SPARC V9 and above.
607
608 =item \"ia64\"
609
610 Intel Itanium.
611
612 =item \"ppc\"
613
614 32 bit Power PC.
615
616 =item \"ppc64\"
617
618 64 bit Power PC.
619
620 =back
621
622 Libguestfs may return other architecture strings in future.
623
624 The function works on at least the following types of files:
625
626 =over 4
627
628 =item *
629
630 many types of Un*x and Linux binary
631
632 =item *
633
634 many types of Un*x and Linux shared library
635
636 =item *
637
638 Windows Win32 and Win64 binaries
639
640 =item *
641
642 Windows Win32 and Win64 DLLs
643
644 Win32 binaries and DLLs return C<i386>.
645
646 Win64 binaries and DLLs return C<x86_64>.
647
648 =item *
649
650 Linux kernel modules
651
652 =item *
653
654 Linux new-style initrd images
655
656 =item *
657
658 some non-x86 Linux vmlinuz kernels
659
660 =back
661
662 What it can't do currently:
663
664 =over 4
665
666 =item *
667
668 static libraries (libfoo.a)
669
670 =item *
671
672 Linux old-style initrd as compressed ext2 filesystem (RHEL 3)
673
674 =item *
675
676 x86 Linux vmlinuz kernels
677
678 x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and
679 compressed code, and are horribly hard to unpack.  If you want to find
680 the architecture of a kernel, use the architecture of the associated
681 initrd or kernel module(s) instead.
682
683 =back");
684
685   ("inspect_os", (RStringList "roots", [], []), -1, [],
686    [],
687    "inspect disk and return list of operating systems found",
688    "\
689 This function uses other libguestfs functions and certain
690 heuristics to inspect the disk(s) (usually disks belonging to
691 a virtual machine), looking for operating systems.
692
693 The list returned is empty if no operating systems were found.
694
695 If one operating system was found, then this returns a list with
696 a single element, which is the name of the root filesystem of
697 this operating system.  It is also possible for this function
698 to return a list containing more than one element, indicating
699 a dual-boot or multi-boot virtual machine, with each element being
700 the root filesystem of one of the operating systems.
701
702 You can pass the root string(s) returned to other
703 C<guestfs_inspect_get_*> functions in order to query further
704 information about each operating system, such as the name
705 and version.
706
707 This function uses other libguestfs features such as
708 C<guestfs_mount_ro> and C<guestfs_umount_all> in order to mount
709 and unmount filesystems and look at the contents.  This should
710 be called with no disks currently mounted.  The function may also
711 use Augeas, so any existing Augeas handle will be closed.
712
713 This function cannot decrypt encrypted disks.  The caller
714 must do that first (supplying the necessary keys) if the
715 disk is encrypted.
716
717 Please read L<guestfs(3)/INSPECTION> for more details.
718
719 See also C<guestfs_list_filesystems>.");
720
721   ("inspect_get_type", (RString "name", [Device "root"], []), -1, [],
722    [],
723    "get type of inspected operating system",
724    "\
725 This function should only be called with a root device string
726 as returned by C<guestfs_inspect_os>.
727
728 This returns the type of the inspected operating system.
729 Currently defined types are:
730
731 =over 4
732
733 =item \"linux\"
734
735 Any Linux-based operating system.
736
737 =item \"windows\"
738
739 Any Microsoft Windows operating system.
740
741 =item \"unknown\"
742
743 The operating system type could not be determined.
744
745 =back
746
747 Future versions of libguestfs may return other strings here.
748 The caller should be prepared to handle any string.
749
750 Please read L<guestfs(3)/INSPECTION> for more details.");
751
752   ("inspect_get_arch", (RString "arch", [Device "root"], []), -1, [],
753    [],
754    "get architecture of inspected operating system",
755    "\
756 This function should only be called with a root device string
757 as returned by C<guestfs_inspect_os>.
758
759 This returns the architecture of the inspected operating system.
760 The possible return values are listed under
761 C<guestfs_file_architecture>.
762
763 If the architecture could not be determined, then the
764 string C<unknown> is returned.
765
766 Please read L<guestfs(3)/INSPECTION> for more details.");
767
768   ("inspect_get_distro", (RString "distro", [Device "root"], []), -1, [],
769    [],
770    "get distro of inspected operating system",
771    "\
772 This function should only be called with a root device string
773 as returned by C<guestfs_inspect_os>.
774
775 This returns the distro (distribution) of the inspected operating
776 system.
777
778 Currently defined distros are:
779
780 =over 4
781
782 =item \"archlinux\"
783
784 Arch Linux.
785
786 =item \"debian\"
787
788 Debian or a Debian-derived distro such as Ubuntu.
789
790 =item \"fedora\"
791
792 Fedora.
793
794 =item \"gentoo\"
795
796 Gentoo.
797
798 =item \"meego\"
799
800 MeeGo.
801
802 =item \"pardus\"
803
804 Pardus.
805
806 =item \"redhat-based\"
807
808 Some Red Hat-derived distro.
809
810 =item \"rhel\"
811
812 Red Hat Enterprise Linux and some derivatives.
813
814 =item \"windows\"
815
816 Windows does not have distributions.  This string is
817 returned if the OS type is Windows.
818
819 =item \"ubuntu\"
820
821 Ubuntu.
822
823 =item \"unknown\"
824
825 The distro could not be determined.
826
827 =back
828
829 Future versions of libguestfs may return other strings here.
830 The caller should be prepared to handle any string.
831
832 Please read L<guestfs(3)/INSPECTION> for more details.");
833
834   ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
835    [],
836    "get major version of inspected operating system",
837    "\
838 This function should only be called with a root device string
839 as returned by C<guestfs_inspect_os>.
840
841 This returns the major version number of the inspected operating
842 system.
843
844 Windows uses a consistent versioning scheme which is I<not>
845 reflected in the popular public names used by the operating system.
846 Notably the operating system known as \"Windows 7\" is really
847 version 6.1 (ie. major = 6, minor = 1).  You can find out the
848 real versions corresponding to releases of Windows by consulting
849 Wikipedia or MSDN.
850
851 If the version could not be determined, then C<0> is returned.
852
853 Please read L<guestfs(3)/INSPECTION> for more details.");
854
855   ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
856    [],
857    "get minor version of inspected operating system",
858    "\
859 This function should only be called with a root device string
860 as returned by C<guestfs_inspect_os>.
861
862 This returns the minor version number of the inspected operating
863 system.
864
865 If the version could not be determined, then C<0> is returned.
866
867 Please read L<guestfs(3)/INSPECTION> for more details.
868 See also C<guestfs_inspect_get_major_version>.");
869
870   ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
871    [],
872    "get product name of inspected operating system",
873    "\
874 This function should only be called with a root device string
875 as returned by C<guestfs_inspect_os>.
876
877 This returns the product name of the inspected operating
878 system.  The product name is generally some freeform string
879 which can be displayed to the user, but should not be
880 parsed by programs.
881
882 If the product name could not be determined, then the
883 string C<unknown> is returned.
884
885 Please read L<guestfs(3)/INSPECTION> for more details.");
886
887   ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
888    [],
889    "get mountpoints of inspected operating system",
890    "\
891 This function should only be called with a root device string
892 as returned by C<guestfs_inspect_os>.
893
894 This returns a hash of where we think the filesystems
895 associated with this operating system should be mounted.
896 Callers should note that this is at best an educated guess
897 made by reading configuration files such as C</etc/fstab>.
898
899 Each element in the returned hashtable has a key which
900 is the path of the mountpoint (eg. C</boot>) and a value
901 which is the filesystem that would be mounted there
902 (eg. C</dev/sda1>).
903
904 Non-mounted devices such as swap devices are I<not>
905 returned in this list.
906
907 Please read L<guestfs(3)/INSPECTION> for more details.
908 See also C<guestfs_inspect_get_filesystems>.");
909
910   ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
911    [],
912    "get filesystems associated with inspected operating system",
913    "\
914 This function should only be called with a root device string
915 as returned by C<guestfs_inspect_os>.
916
917 This returns a list of all the filesystems that we think
918 are associated with this operating system.  This includes
919 the root filesystem, other ordinary filesystems, and
920 non-mounted devices like swap partitions.
921
922 In the case of a multi-boot virtual machine, it is possible
923 for a filesystem to be shared between operating systems.
924
925 Please read L<guestfs(3)/INSPECTION> for more details.
926 See also C<guestfs_inspect_get_mountpoints>.");
927
928   ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
929    [],
930    "set enable network flag",
931    "\
932 If C<network> is true, then the network is enabled in the
933 libguestfs appliance.  The default is false.
934
935 This affects whether commands are able to access the network
936 (see L<guestfs(3)/RUNNING COMMANDS>).
937
938 You must call this before calling C<guestfs_launch>, otherwise
939 it has no effect.");
940
941   ("get_network", (RBool "network", [], []), -1, [],
942    [],
943    "get enable network flag",
944    "\
945 This returns the enable network flag.");
946
947   ("list_filesystems", (RHashtable "fses", [], []), -1, [],
948    [],
949    "list filesystems",
950    "\
951 This inspection command looks for filesystems on partitions,
952 block devices and logical volumes, returning a list of devices
953 containing filesystems and their type.
954
955 The return value is a hash, where the keys are the devices
956 containing filesystems, and the values are the filesystem types.
957 For example:
958
959  \"/dev/sda1\" => \"ntfs\"
960  \"/dev/sda2\" => \"ext2\"
961  \"/dev/vg_guest/lv_root\" => \"ext4\"
962  \"/dev/vg_guest/lv_swap\" => \"swap\"
963
964 The value can have the special value \"unknown\", meaning the
965 content of the device is undetermined or empty.
966 \"swap\" means a Linux swap partition.
967
968 This command runs other libguestfs commands, which might include
969 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
970 use this soon after launch and only when nothing is mounted.
971
972 Not all of the filesystems returned will be mountable.  In
973 particular, swap partitions are returned in the list.  Also
974 this command does not check that each filesystem
975 found is valid and mountable, and some filesystems might
976 be mountable but require special options.  Filesystems may
977 not all belong to a single logical operating system
978 (use C<guestfs_inspect_os> to look for OSes).");
979
980   ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
981    [],
982    "add an image to examine or modify",
983    "\
984 This function adds a virtual machine disk image C<filename> to
985 libguestfs.  The first time you call this function, the disk
986 appears as C</dev/sda>, the second time as C</dev/sdb>, and
987 so on.
988
989 You don't necessarily need to be root when using libguestfs.  However
990 you obviously do need sufficient permissions to access the filename
991 for whatever operations you want to perform (ie. read access if you
992 just want to read the image or write access if you want to modify the
993 image).
994
995 This call checks that C<filename> exists.
996
997 The optional arguments are:
998
999 =over 4
1000
1001 =item C<readonly>
1002
1003 If true then the image is treated as read-only.  Writes are still
1004 allowed, but they are stored in a temporary snapshot overlay which
1005 is discarded at the end.  The disk that you add is not modified.
1006
1007 =item C<format>
1008
1009 This forces the image format.  If you omit this (or use C<guestfs_add_drive>
1010 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1011 Possible formats include C<raw> and C<qcow2>.
1012
1013 Automatic detection of the format opens you up to a potential
1014 security hole when dealing with untrusted raw-format images.
1015 See CVE-2010-3851 and RHBZ#642934.  Specifying the format closes
1016 this security hole.
1017
1018 =item C<iface>
1019
1020 This rarely-used option lets you emulate the behaviour of the
1021 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1022
1023 =back");
1024
1025   ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1026    [],
1027    "get Windows systemroot of inspected operating system",
1028    "\
1029 This function should only be called with a root device string
1030 as returned by C<guestfs_inspect_os>.
1031
1032 This returns the Windows systemroot of the inspected guest.
1033 The systemroot is a directory path such as C</WINDOWS>.
1034
1035 This call assumes that the guest is Windows and that the
1036 systemroot could be determined by inspection.  If this is not
1037 the case then an error is returned.
1038
1039 Please read L<guestfs(3)/INSPECTION> for more details.");
1040
1041   ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1042    [],
1043    "return list of operating systems found by last inspection",
1044    "\
1045 This function is a convenient way to get the list of root
1046 devices, as returned from a previous call to C<guestfs_inspect_os>,
1047 but without redoing the whole inspection process.
1048
1049 This returns an empty list if either no root devices were
1050 found or the caller has not called C<guestfs_inspect_os>.
1051
1052 Please read L<guestfs(3)/INSPECTION> for more details.");
1053
1054   ("debug_cmdline", (RStringList "cmdline", [], []), -1, [NotInDocs],
1055    [],
1056    "debug the QEMU command line (internal use only)",
1057    "\
1058 This returns the internal QEMU command line.  'debug' commands are
1059 not part of the formal API and can be removed or changed at any time.");
1060
1061   ("add_domain", (RInt "nrdisks", [String "dom"], [String "libvirturi"; Bool "readonly"; String "iface"]), -1, [FishAlias "domain"],
1062    [],
1063    "add the disk(s) from a named libvirt domain",
1064    "\
1065 This function adds the disk(s) attached to the named libvirt
1066 domain C<dom>.  It works by connecting to libvirt, requesting
1067 the domain and domain XML from libvirt, parsing it for disks,
1068 and calling C<guestfs_add_drive_opts> on each one.
1069
1070 The number of disks added is returned.  This operation is atomic:
1071 if an error is returned, then no disks are added.
1072
1073 This function does some minimal checks to make sure the libvirt
1074 domain is not running (unless C<readonly> is true).  In a future
1075 version we will try to acquire the libvirt lock on each disk.
1076
1077 Disks must be accessible locally.  This often means that adding disks
1078 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1079 will fail unless those disks are accessible via the same device path
1080 locally too.
1081
1082 The optional C<libvirturi> parameter sets the libvirt URI
1083 (see L<http://libvirt.org/uri.html>).  If this is not set then
1084 we connect to the default libvirt URI (or one set through an
1085 environment variable, see the libvirt documentation for full
1086 details).  If you are using the C API directly then it is more
1087 flexible to create the libvirt connection object yourself, get
1088 the domain object, and call C<guestfs_add_libvirt_dom>.
1089
1090 The other optional parameters are passed directly through to
1091 C<guestfs_add_drive_opts>.");
1092
1093 (*
1094 This interface is not quite baked yet. -- RWMJ 2010-11-11
1095   ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"]), -1, [NotInFish],
1096    [],
1097    "add the disk(s) from a libvirt domain",
1098    "\
1099 This function adds the disk(s) attached to the libvirt domain C<dom>.
1100 It works by requesting the domain XML from libvirt, parsing it for
1101 disks, and calling C<guestfs_add_drive_opts> on each one.
1102
1103 In the C API we declare C<void *dom>, but really it has type
1104 C<virDomainPtr dom>.  This is so we don't need E<lt>libvirt.hE<gt>.
1105
1106 The number of disks added is returned.  This operation is atomic:
1107 if an error is returned, then no disks are added.
1108
1109 This function does some minimal checks to make sure the libvirt
1110 domain is not running (unless C<readonly> is true).  In a future
1111 version we will try to acquire the libvirt lock on each disk.
1112
1113 Disks must be accessible locally.  This often means that adding disks
1114 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1115 will fail unless those disks are accessible via the same device path
1116 locally too.
1117
1118 The optional parameters are passed directly through to
1119 C<guestfs_add_drive_opts>.");
1120 *)
1121
1122   ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1123    [],
1124    "get package format used by the operating system",
1125    "\
1126 This function should only be called with a root device string
1127 as returned by C<guestfs_inspect_os>.
1128
1129 This function and C<guestfs_inspect_get_package_management> return
1130 the package format and package management tool used by the
1131 inspected operating system.  For example for Fedora these
1132 functions would return C<rpm> (package format) and
1133 C<yum> (package management).
1134
1135 This returns the string C<unknown> if we could not determine the
1136 package format I<or> if the operating system does not have
1137 a real packaging system (eg. Windows).
1138
1139 Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>.
1140 Future versions of libguestfs may return other strings.
1141
1142 Please read L<guestfs(3)/INSPECTION> for more details.");
1143
1144   ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1145    [],
1146    "get package management tool used by the operating system",
1147    "\
1148 This function should only be called with a root device string
1149 as returned by C<guestfs_inspect_os>.
1150
1151 C<guestfs_inspect_get_package_format> and this function return
1152 the package format and package management tool used by the
1153 inspected operating system.  For example for Fedora these
1154 functions would return C<rpm> (package format) and
1155 C<yum> (package management).
1156
1157 This returns the string C<unknown> if we could not determine the
1158 package management tool I<or> if the operating system does not have
1159 a real packaging system (eg. Windows).
1160
1161 Possible strings include: C<yum>, C<up2date>,
1162 C<apt> (for all Debian derivatives),
1163 C<portage>, C<pisi>, C<pacman>.
1164 Future versions of libguestfs may return other strings.
1165
1166 Please read L<guestfs(3)/INSPECTION> for more details.");
1167
1168 ]
1169
1170 (* daemon_functions are any functions which cause some action
1171  * to take place in the daemon.
1172  *)
1173
1174 let daemon_functions = [
1175   ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1176    [InitEmpty, Always, TestOutput (
1177       [["part_disk"; "/dev/sda"; "mbr"];
1178        ["mkfs"; "ext2"; "/dev/sda1"];
1179        ["mount"; "/dev/sda1"; "/"];
1180        ["write"; "/new"; "new file contents"];
1181        ["cat"; "/new"]], "new file contents")],
1182    "mount a guest disk at a position in the filesystem",
1183    "\
1184 Mount a guest disk at a position in the filesystem.  Block devices
1185 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1186 the guest.  If those block devices contain partitions, they will have
1187 the usual names (eg. C</dev/sda1>).  Also LVM C</dev/VG/LV>-style
1188 names can be used.
1189
1190 The rules are the same as for L<mount(2)>:  A filesystem must
1191 first be mounted on C</> before others can be mounted.  Other
1192 filesystems can only be mounted on directories which already
1193 exist.
1194
1195 The mounted filesystem is writable, if we have sufficient permissions
1196 on the underlying device.
1197
1198 B<Important note:>
1199 When you use this call, the filesystem options C<sync> and C<noatime>
1200 are set implicitly.  This was originally done because we thought it
1201 would improve reliability, but it turns out that I<-o sync> has a
1202 very large negative performance impact and negligible effect on
1203 reliability.  Therefore we recommend that you avoid using
1204 C<guestfs_mount> in any code that needs performance, and instead
1205 use C<guestfs_mount_options> (use an empty string for the first
1206 parameter if you don't want any options).");
1207
1208   ("sync", (RErr, [], []), 2, [],
1209    [ InitEmpty, Always, TestRun [["sync"]]],
1210    "sync disks, writes are flushed through to the disk image",
1211    "\
1212 This syncs the disk, so that any writes are flushed through to the
1213 underlying disk image.
1214
1215 You should always call this if you have modified a disk image, before
1216 closing the handle.");
1217
1218   ("touch", (RErr, [Pathname "path"], []), 3, [],
1219    [InitBasicFS, Always, TestOutputTrue (
1220       [["touch"; "/new"];
1221        ["exists"; "/new"]])],
1222    "update file timestamps or create a new file",
1223    "\
1224 Touch acts like the L<touch(1)> command.  It can be used to
1225 update the timestamps on a file, or, if the file does not exist,
1226 to create a new zero-length file.
1227
1228 This command only works on regular files, and will fail on other
1229 file types such as directories, symbolic links, block special etc.");
1230
1231   ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1232    [InitISOFS, Always, TestOutput (
1233       [["cat"; "/known-2"]], "abcdef\n")],
1234    "list the contents of a file",
1235    "\
1236 Return the contents of the file named C<path>.
1237
1238 Note that this function cannot correctly handle binary files
1239 (specifically, files containing C<\\0> character which is treated
1240 as end of string).  For those you need to use the C<guestfs_read_file>
1241 or C<guestfs_download> functions which have a more complex interface.");
1242
1243   ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1244    [], (* XXX Tricky to test because it depends on the exact format
1245         * of the 'ls -l' command, which changes between F10 and F11.
1246         *)
1247    "list the files in a directory (long format)",
1248    "\
1249 List the files in C<directory> (relative to the root directory,
1250 there is no cwd) in the format of 'ls -la'.
1251
1252 This command is mostly useful for interactive sessions.  It
1253 is I<not> intended that you try to parse the output string.");
1254
1255   ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1256    [InitBasicFS, Always, TestOutputList (
1257       [["touch"; "/new"];
1258        ["touch"; "/newer"];
1259        ["touch"; "/newest"];
1260        ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1261    "list the files in a directory",
1262    "\
1263 List the files in C<directory> (relative to the root directory,
1264 there is no cwd).  The '.' and '..' entries are not returned, but
1265 hidden files are shown.
1266
1267 This command is mostly useful for interactive sessions.  Programs
1268 should probably use C<guestfs_readdir> instead.");
1269
1270   ("list_devices", (RStringList "devices", [], []), 7, [],
1271    [InitEmpty, Always, TestOutputListOfDevices (
1272       [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1273    "list the block devices",
1274    "\
1275 List all the block devices.
1276
1277 The full block device names are returned, eg. C</dev/sda>.
1278
1279 See also C<guestfs_list_filesystems>.");
1280
1281   ("list_partitions", (RStringList "partitions", [], []), 8, [],
1282    [InitBasicFS, Always, TestOutputListOfDevices (
1283       [["list_partitions"]], ["/dev/sda1"]);
1284     InitEmpty, Always, TestOutputListOfDevices (
1285       [["part_init"; "/dev/sda"; "mbr"];
1286        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1287        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1288        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1289        ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1290    "list the partitions",
1291    "\
1292 List all the partitions detected on all block devices.
1293
1294 The full partition device names are returned, eg. C</dev/sda1>
1295
1296 This does not return logical volumes.  For that you will need to
1297 call C<guestfs_lvs>.
1298
1299 See also C<guestfs_list_filesystems>.");
1300
1301   ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1302    [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1303       [["pvs"]], ["/dev/sda1"]);
1304     InitEmpty, Always, TestOutputListOfDevices (
1305       [["part_init"; "/dev/sda"; "mbr"];
1306        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1307        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1308        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1309        ["pvcreate"; "/dev/sda1"];
1310        ["pvcreate"; "/dev/sda2"];
1311        ["pvcreate"; "/dev/sda3"];
1312        ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1313    "list the LVM physical volumes (PVs)",
1314    "\
1315 List all the physical volumes detected.  This is the equivalent
1316 of the L<pvs(8)> command.
1317
1318 This returns a list of just the device names that contain
1319 PVs (eg. C</dev/sda2>).
1320
1321 See also C<guestfs_pvs_full>.");
1322
1323   ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1324    [InitBasicFSonLVM, Always, TestOutputList (
1325       [["vgs"]], ["VG"]);
1326     InitEmpty, Always, TestOutputList (
1327       [["part_init"; "/dev/sda"; "mbr"];
1328        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1329        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1330        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1331        ["pvcreate"; "/dev/sda1"];
1332        ["pvcreate"; "/dev/sda2"];
1333        ["pvcreate"; "/dev/sda3"];
1334        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1335        ["vgcreate"; "VG2"; "/dev/sda3"];
1336        ["vgs"]], ["VG1"; "VG2"])],
1337    "list the LVM volume groups (VGs)",
1338    "\
1339 List all the volumes groups detected.  This is the equivalent
1340 of the L<vgs(8)> command.
1341
1342 This returns a list of just the volume group names that were
1343 detected (eg. C<VolGroup00>).
1344
1345 See also C<guestfs_vgs_full>.");
1346
1347   ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1348    [InitBasicFSonLVM, Always, TestOutputList (
1349       [["lvs"]], ["/dev/VG/LV"]);
1350     InitEmpty, Always, TestOutputList (
1351       [["part_init"; "/dev/sda"; "mbr"];
1352        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1353        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1354        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1355        ["pvcreate"; "/dev/sda1"];
1356        ["pvcreate"; "/dev/sda2"];
1357        ["pvcreate"; "/dev/sda3"];
1358        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1359        ["vgcreate"; "VG2"; "/dev/sda3"];
1360        ["lvcreate"; "LV1"; "VG1"; "50"];
1361        ["lvcreate"; "LV2"; "VG1"; "50"];
1362        ["lvcreate"; "LV3"; "VG2"; "50"];
1363        ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1364    "list the LVM logical volumes (LVs)",
1365    "\
1366 List all the logical volumes detected.  This is the equivalent
1367 of the L<lvs(8)> command.
1368
1369 This returns a list of the logical volume device names
1370 (eg. C</dev/VolGroup00/LogVol00>).
1371
1372 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1373
1374   ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1375    [], (* XXX how to test? *)
1376    "list the LVM physical volumes (PVs)",
1377    "\
1378 List all the physical volumes detected.  This is the equivalent
1379 of the L<pvs(8)> command.  The \"full\" version includes all fields.");
1380
1381   ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1382    [], (* XXX how to test? *)
1383    "list the LVM volume groups (VGs)",
1384    "\
1385 List all the volumes groups detected.  This is the equivalent
1386 of the L<vgs(8)> command.  The \"full\" version includes all fields.");
1387
1388   ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1389    [], (* XXX how to test? *)
1390    "list the LVM logical volumes (LVs)",
1391    "\
1392 List all the logical volumes detected.  This is the equivalent
1393 of the L<lvs(8)> command.  The \"full\" version includes all fields.");
1394
1395   ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1396    [InitISOFS, Always, TestOutputList (
1397       [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1398     InitISOFS, Always, TestOutputList (
1399       [["read_lines"; "/empty"]], [])],
1400    "read file as lines",
1401    "\
1402 Return the contents of the file named C<path>.
1403
1404 The file contents are returned as a list of lines.  Trailing
1405 C<LF> and C<CRLF> character sequences are I<not> returned.
1406
1407 Note that this function cannot correctly handle binary files
1408 (specifically, files containing C<\\0> character which is treated
1409 as end of line).  For those you need to use the C<guestfs_read_file>
1410 function which has a more complex interface.");
1411
1412   ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1413    [], (* XXX Augeas code needs tests. *)
1414    "create a new Augeas handle",
1415    "\
1416 Create a new Augeas handle for editing configuration files.
1417 If there was any previous Augeas handle associated with this
1418 guestfs session, then it is closed.
1419
1420 You must call this before using any other C<guestfs_aug_*>
1421 commands.
1422
1423 C<root> is the filesystem root.  C<root> must not be NULL,
1424 use C</> instead.
1425
1426 The flags are the same as the flags defined in
1427 E<lt>augeas.hE<gt>, the logical I<or> of the following
1428 integers:
1429
1430 =over 4
1431
1432 =item C<AUG_SAVE_BACKUP> = 1
1433
1434 Keep the original file with a C<.augsave> extension.
1435
1436 =item C<AUG_SAVE_NEWFILE> = 2
1437
1438 Save changes into a file with extension C<.augnew>, and
1439 do not overwrite original.  Overrides C<AUG_SAVE_BACKUP>.
1440
1441 =item C<AUG_TYPE_CHECK> = 4
1442
1443 Typecheck lenses (can be expensive).
1444
1445 =item C<AUG_NO_STDINC> = 8
1446
1447 Do not use standard load path for modules.
1448
1449 =item C<AUG_SAVE_NOOP> = 16
1450
1451 Make save a no-op, just record what would have been changed.
1452
1453 =item C<AUG_NO_LOAD> = 32
1454
1455 Do not load the tree in C<guestfs_aug_init>.
1456
1457 =back
1458
1459 To close the handle, you can call C<guestfs_aug_close>.
1460
1461 To find out more about Augeas, see L<http://augeas.net/>.");
1462
1463   ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1464    [], (* XXX Augeas code needs tests. *)
1465    "close the current Augeas handle",
1466    "\
1467 Close the current Augeas handle and free up any resources
1468 used by it.  After calling this, you have to call
1469 C<guestfs_aug_init> again before you can use any other
1470 Augeas functions.");
1471
1472   ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1473    [], (* XXX Augeas code needs tests. *)
1474    "define an Augeas variable",
1475    "\
1476 Defines an Augeas variable C<name> whose value is the result
1477 of evaluating C<expr>.  If C<expr> is NULL, then C<name> is
1478 undefined.
1479
1480 On success this returns the number of nodes in C<expr>, or
1481 C<0> if C<expr> evaluates to something which is not a nodeset.");
1482
1483   ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1484    [], (* XXX Augeas code needs tests. *)
1485    "define an Augeas node",
1486    "\
1487 Defines a variable C<name> whose value is the result of
1488 evaluating C<expr>.
1489
1490 If C<expr> evaluates to an empty nodeset, a node is created,
1491 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1492 C<name> will be the nodeset containing that single node.
1493
1494 On success this returns a pair containing the
1495 number of nodes in the nodeset, and a boolean flag
1496 if a node was created.");
1497
1498   ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1499    [], (* XXX Augeas code needs tests. *)
1500    "look up the value of an Augeas path",
1501    "\
1502 Look up the value associated with C<path>.  If C<path>
1503 matches exactly one node, the C<value> is returned.");
1504
1505   ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1506    [], (* XXX Augeas code needs tests. *)
1507    "set Augeas path to value",
1508    "\
1509 Set the value associated with C<path> to C<val>.
1510
1511 In the Augeas API, it is possible to clear a node by setting
1512 the value to NULL.  Due to an oversight in the libguestfs API
1513 you cannot do that with this call.  Instead you must use the
1514 C<guestfs_aug_clear> call.");
1515
1516   ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1517    [], (* XXX Augeas code needs tests. *)
1518    "insert a sibling Augeas node",
1519    "\
1520 Create a new sibling C<label> for C<path>, inserting it into
1521 the tree before or after C<path> (depending on the boolean
1522 flag C<before>).
1523
1524 C<path> must match exactly one existing node in the tree, and
1525 C<label> must be a label, ie. not contain C</>, C<*> or end
1526 with a bracketed index C<[N]>.");
1527
1528   ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1529    [], (* XXX Augeas code needs tests. *)
1530    "remove an Augeas path",
1531    "\
1532 Remove C<path> and all of its children.
1533
1534 On success this returns the number of entries which were removed.");
1535
1536   ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1537    [], (* XXX Augeas code needs tests. *)
1538    "move Augeas node",
1539    "\
1540 Move the node C<src> to C<dest>.  C<src> must match exactly
1541 one node.  C<dest> is overwritten if it exists.");
1542
1543   ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1544    [], (* XXX Augeas code needs tests. *)
1545    "return Augeas nodes which match augpath",
1546    "\
1547 Returns a list of paths which match the path expression C<path>.
1548 The returned paths are sufficiently qualified so that they match
1549 exactly one node in the current tree.");
1550
1551   ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1552    [], (* XXX Augeas code needs tests. *)
1553    "write all pending Augeas changes to disk",
1554    "\
1555 This writes all pending changes to disk.
1556
1557 The flags which were passed to C<guestfs_aug_init> affect exactly
1558 how files are saved.");
1559
1560   ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1561    [], (* XXX Augeas code needs tests. *)
1562    "load files into the tree",
1563    "\
1564 Load files into the tree.
1565
1566 See C<aug_load> in the Augeas documentation for the full gory
1567 details.");
1568
1569   ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1570    [], (* XXX Augeas code needs tests. *)
1571    "list Augeas nodes under augpath",
1572    "\
1573 This is just a shortcut for listing C<guestfs_aug_match>
1574 C<path/*> and sorting the resulting nodes into alphabetical order.");
1575
1576   ("rm", (RErr, [Pathname "path"], []), 29, [],
1577    [InitBasicFS, Always, TestRun
1578       [["touch"; "/new"];
1579        ["rm"; "/new"]];
1580     InitBasicFS, Always, TestLastFail
1581       [["rm"; "/new"]];
1582     InitBasicFS, Always, TestLastFail
1583       [["mkdir"; "/new"];
1584        ["rm"; "/new"]]],
1585    "remove a file",
1586    "\
1587 Remove the single file C<path>.");
1588
1589   ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1590    [InitBasicFS, Always, TestRun
1591       [["mkdir"; "/new"];
1592        ["rmdir"; "/new"]];
1593     InitBasicFS, Always, TestLastFail
1594       [["rmdir"; "/new"]];
1595     InitBasicFS, Always, TestLastFail
1596       [["touch"; "/new"];
1597        ["rmdir"; "/new"]]],
1598    "remove a directory",
1599    "\
1600 Remove the single directory C<path>.");
1601
1602   ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1603    [InitBasicFS, Always, TestOutputFalse
1604       [["mkdir"; "/new"];
1605        ["mkdir"; "/new/foo"];
1606        ["touch"; "/new/foo/bar"];
1607        ["rm_rf"; "/new"];
1608        ["exists"; "/new"]]],
1609    "remove a file or directory recursively",
1610    "\
1611 Remove the file or directory C<path>, recursively removing the
1612 contents if its a directory.  This is like the C<rm -rf> shell
1613 command.");
1614
1615   ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1616    [InitBasicFS, Always, TestOutputTrue
1617       [["mkdir"; "/new"];
1618        ["is_dir"; "/new"]];
1619     InitBasicFS, Always, TestLastFail
1620       [["mkdir"; "/new/foo/bar"]]],
1621    "create a directory",
1622    "\
1623 Create a directory named C<path>.");
1624
1625   ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1626    [InitBasicFS, Always, TestOutputTrue
1627       [["mkdir_p"; "/new/foo/bar"];
1628        ["is_dir"; "/new/foo/bar"]];
1629     InitBasicFS, Always, TestOutputTrue
1630       [["mkdir_p"; "/new/foo/bar"];
1631        ["is_dir"; "/new/foo"]];
1632     InitBasicFS, Always, TestOutputTrue
1633       [["mkdir_p"; "/new/foo/bar"];
1634        ["is_dir"; "/new"]];
1635     (* Regression tests for RHBZ#503133: *)
1636     InitBasicFS, Always, TestRun
1637       [["mkdir"; "/new"];
1638        ["mkdir_p"; "/new"]];
1639     InitBasicFS, Always, TestLastFail
1640       [["touch"; "/new"];
1641        ["mkdir_p"; "/new"]]],
1642    "create a directory and parents",
1643    "\
1644 Create a directory named C<path>, creating any parent directories
1645 as necessary.  This is like the C<mkdir -p> shell command.");
1646
1647   ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
1648    [], (* XXX Need stat command to test *)
1649    "change file mode",
1650    "\
1651 Change the mode (permissions) of C<path> to C<mode>.  Only
1652 numeric modes are supported.
1653
1654 I<Note>: When using this command from guestfish, C<mode>
1655 by default would be decimal, unless you prefix it with
1656 C<0> to get octal, ie. use C<0700> not C<700>.
1657
1658 The mode actually set is affected by the umask.");
1659
1660   ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
1661    [], (* XXX Need stat command to test *)
1662    "change file owner and group",
1663    "\
1664 Change the file owner to C<owner> and group to C<group>.
1665
1666 Only numeric uid and gid are supported.  If you want to use
1667 names, you will need to locate and parse the password file
1668 yourself (Augeas support makes this relatively easy).");
1669
1670   ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
1671    [InitISOFS, Always, TestOutputTrue (
1672       [["exists"; "/empty"]]);
1673     InitISOFS, Always, TestOutputTrue (
1674       [["exists"; "/directory"]])],
1675    "test if file or directory exists",
1676    "\
1677 This returns C<true> if and only if there is a file, directory
1678 (or anything) with the given C<path> name.
1679
1680 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1681
1682   ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
1683    [InitISOFS, Always, TestOutputTrue (
1684       [["is_file"; "/known-1"]]);
1685     InitISOFS, Always, TestOutputFalse (
1686       [["is_file"; "/directory"]])],
1687    "test if a regular file",
1688    "\
1689 This returns C<true> if and only if there is a regular file
1690 with the given C<path> name.  Note that it returns false for
1691 other objects like directories.
1692
1693 See also C<guestfs_stat>.");
1694
1695   ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
1696    [InitISOFS, Always, TestOutputFalse (
1697       [["is_dir"; "/known-3"]]);
1698     InitISOFS, Always, TestOutputTrue (
1699       [["is_dir"; "/directory"]])],
1700    "test if a directory",
1701    "\
1702 This returns C<true> if and only if there is a directory
1703 with the given C<path> name.  Note that it returns false for
1704 other objects like files.
1705
1706 See also C<guestfs_stat>.");
1707
1708   ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
1709    [InitEmpty, Always, TestOutputListOfDevices (
1710       [["part_init"; "/dev/sda"; "mbr"];
1711        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1712        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1713        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1714        ["pvcreate"; "/dev/sda1"];
1715        ["pvcreate"; "/dev/sda2"];
1716        ["pvcreate"; "/dev/sda3"];
1717        ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1718    "create an LVM physical volume",
1719    "\
1720 This creates an LVM physical volume on the named C<device>,
1721 where C<device> should usually be a partition name such
1722 as C</dev/sda1>.");
1723
1724   ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
1725    [InitEmpty, Always, TestOutputList (
1726       [["part_init"; "/dev/sda"; "mbr"];
1727        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1728        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1729        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1730        ["pvcreate"; "/dev/sda1"];
1731        ["pvcreate"; "/dev/sda2"];
1732        ["pvcreate"; "/dev/sda3"];
1733        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1734        ["vgcreate"; "VG2"; "/dev/sda3"];
1735        ["vgs"]], ["VG1"; "VG2"])],
1736    "create an LVM volume group",
1737    "\
1738 This creates an LVM volume group called C<volgroup>
1739 from the non-empty list of physical volumes C<physvols>.");
1740
1741   ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
1742    [InitEmpty, Always, TestOutputList (
1743       [["part_init"; "/dev/sda"; "mbr"];
1744        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1745        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1746        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1747        ["pvcreate"; "/dev/sda1"];
1748        ["pvcreate"; "/dev/sda2"];
1749        ["pvcreate"; "/dev/sda3"];
1750        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1751        ["vgcreate"; "VG2"; "/dev/sda3"];
1752        ["lvcreate"; "LV1"; "VG1"; "50"];
1753        ["lvcreate"; "LV2"; "VG1"; "50"];
1754        ["lvcreate"; "LV3"; "VG2"; "50"];
1755        ["lvcreate"; "LV4"; "VG2"; "50"];
1756        ["lvcreate"; "LV5"; "VG2"; "50"];
1757        ["lvs"]],
1758       ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1759        "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1760    "create an LVM logical volume",
1761    "\
1762 This creates an LVM logical volume called C<logvol>
1763 on the volume group C<volgroup>, with C<size> megabytes.");
1764
1765   ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
1766    [InitEmpty, Always, TestOutput (
1767       [["part_disk"; "/dev/sda"; "mbr"];
1768        ["mkfs"; "ext2"; "/dev/sda1"];
1769        ["mount_options"; ""; "/dev/sda1"; "/"];
1770        ["write"; "/new"; "new file contents"];
1771        ["cat"; "/new"]], "new file contents")],
1772    "make a filesystem",
1773    "\
1774 This creates a filesystem on C<device> (usually a partition
1775 or LVM logical volume).  The filesystem type is C<fstype>, for
1776 example C<ext3>.");
1777
1778   ("sfdisk", (RErr, [Device "device";
1779                      Int "cyls"; Int "heads"; Int "sectors";
1780                      StringList "lines"], []), 43, [DangerWillRobinson],
1781    [],
1782    "create partitions on a block device",
1783    "\
1784 This is a direct interface to the L<sfdisk(8)> program for creating
1785 partitions on block devices.
1786
1787 C<device> should be a block device, for example C</dev/sda>.
1788
1789 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1790 and sectors on the device, which are passed directly to sfdisk as
1791 the I<-C>, I<-H> and I<-S> parameters.  If you pass C<0> for any
1792 of these, then the corresponding parameter is omitted.  Usually for
1793 'large' disks, you can just pass C<0> for these, but for small
1794 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1795 out the right geometry and you will need to tell it.
1796
1797 C<lines> is a list of lines that we feed to C<sfdisk>.  For more
1798 information refer to the L<sfdisk(8)> manpage.
1799
1800 To create a single partition occupying the whole disk, you would
1801 pass C<lines> as a single element list, when the single element being
1802 the string C<,> (comma).
1803
1804 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1805 C<guestfs_part_init>");
1806
1807   ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
1808    (* Regression test for RHBZ#597135. *)
1809    [InitBasicFS, Always, TestLastFail
1810       [["write_file"; "/new"; "abc"; "10000"]]],
1811    "create a file",
1812    "\
1813 This call creates a file called C<path>.  The contents of the
1814 file is the string C<content> (which can contain any 8 bit data),
1815 with length C<size>.
1816
1817 As a special case, if C<size> is C<0>
1818 then the length is calculated using C<strlen> (so in this case
1819 the content cannot contain embedded ASCII NULs).
1820
1821 I<NB.> Owing to a bug, writing content containing ASCII NUL
1822 characters does I<not> work, even if the length is specified.");
1823
1824   ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
1825    [InitEmpty, Always, TestOutputListOfDevices (
1826       [["part_disk"; "/dev/sda"; "mbr"];
1827        ["mkfs"; "ext2"; "/dev/sda1"];
1828        ["mount_options"; ""; "/dev/sda1"; "/"];
1829        ["mounts"]], ["/dev/sda1"]);
1830     InitEmpty, Always, TestOutputList (
1831       [["part_disk"; "/dev/sda"; "mbr"];
1832        ["mkfs"; "ext2"; "/dev/sda1"];
1833        ["mount_options"; ""; "/dev/sda1"; "/"];
1834        ["umount"; "/"];
1835        ["mounts"]], [])],
1836    "unmount a filesystem",
1837    "\
1838 This unmounts the given filesystem.  The filesystem may be
1839 specified either by its mountpoint (path) or the device which
1840 contains the filesystem.");
1841
1842   ("mounts", (RStringList "devices", [], []), 46, [],
1843    [InitBasicFS, Always, TestOutputListOfDevices (
1844       [["mounts"]], ["/dev/sda1"])],
1845    "show mounted filesystems",
1846    "\
1847 This returns the list of currently mounted filesystems.  It returns
1848 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1849
1850 Some internal mounts are not shown.
1851
1852 See also: C<guestfs_mountpoints>");
1853
1854   ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
1855    [InitBasicFS, Always, TestOutputList (
1856       [["umount_all"];
1857        ["mounts"]], []);
1858     (* check that umount_all can unmount nested mounts correctly: *)
1859     InitEmpty, Always, TestOutputList (
1860       [["part_init"; "/dev/sda"; "mbr"];
1861        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1862        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1863        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1864        ["mkfs"; "ext2"; "/dev/sda1"];
1865        ["mkfs"; "ext2"; "/dev/sda2"];
1866        ["mkfs"; "ext2"; "/dev/sda3"];
1867        ["mount_options"; ""; "/dev/sda1"; "/"];
1868        ["mkdir"; "/mp1"];
1869        ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1870        ["mkdir"; "/mp1/mp2"];
1871        ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1872        ["mkdir"; "/mp1/mp2/mp3"];
1873        ["umount_all"];
1874        ["mounts"]], [])],
1875    "unmount all filesystems",
1876    "\
1877 This unmounts all mounted filesystems.
1878
1879 Some internal mounts are not unmounted by this call.");
1880
1881   ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
1882    [],
1883    "remove all LVM LVs, VGs and PVs",
1884    "\
1885 This command removes all LVM logical volumes, volume groups
1886 and physical volumes.");
1887
1888   ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
1889    [InitISOFS, Always, TestOutput (
1890       [["file"; "/empty"]], "empty");
1891     InitISOFS, Always, TestOutput (
1892       [["file"; "/known-1"]], "ASCII text");
1893     InitISOFS, Always, TestLastFail (
1894       [["file"; "/notexists"]]);
1895     InitISOFS, Always, TestOutput (
1896       [["file"; "/abssymlink"]], "symbolic link");
1897     InitISOFS, Always, TestOutput (
1898       [["file"; "/directory"]], "directory")],
1899    "determine file type",
1900    "\
1901 This call uses the standard L<file(1)> command to determine
1902 the type or contents of the file.
1903
1904 This call will also transparently look inside various types
1905 of compressed file.
1906
1907 The exact command which runs is C<file -zb path>.  Note in
1908 particular that the filename is not prepended to the output
1909 (the C<-b> option).
1910
1911 This command can also be used on C</dev/> devices
1912 (and partitions, LV names).  You can for example use this
1913 to determine if a device contains a filesystem, although
1914 it's usually better to use C<guestfs_vfs_type>.
1915
1916 If the C<path> does not begin with C</dev/> then
1917 this command only works for the content of regular files.
1918 For other file types (directory, symbolic link etc) it
1919 will just return the string C<directory> etc.");
1920
1921   ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
1922    [InitBasicFS, Always, TestOutput (
1923       [["upload"; "test-command"; "/test-command"];
1924        ["chmod"; "0o755"; "/test-command"];
1925        ["command"; "/test-command 1"]], "Result1");
1926     InitBasicFS, Always, TestOutput (
1927       [["upload"; "test-command"; "/test-command"];
1928        ["chmod"; "0o755"; "/test-command"];
1929        ["command"; "/test-command 2"]], "Result2\n");
1930     InitBasicFS, Always, TestOutput (
1931       [["upload"; "test-command"; "/test-command"];
1932        ["chmod"; "0o755"; "/test-command"];
1933        ["command"; "/test-command 3"]], "\nResult3");
1934     InitBasicFS, Always, TestOutput (
1935       [["upload"; "test-command"; "/test-command"];
1936        ["chmod"; "0o755"; "/test-command"];
1937        ["command"; "/test-command 4"]], "\nResult4\n");
1938     InitBasicFS, Always, TestOutput (
1939       [["upload"; "test-command"; "/test-command"];
1940        ["chmod"; "0o755"; "/test-command"];
1941        ["command"; "/test-command 5"]], "\nResult5\n\n");
1942     InitBasicFS, Always, TestOutput (
1943       [["upload"; "test-command"; "/test-command"];
1944        ["chmod"; "0o755"; "/test-command"];
1945        ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1946     InitBasicFS, Always, TestOutput (
1947       [["upload"; "test-command"; "/test-command"];
1948        ["chmod"; "0o755"; "/test-command"];
1949        ["command"; "/test-command 7"]], "");
1950     InitBasicFS, Always, TestOutput (
1951       [["upload"; "test-command"; "/test-command"];
1952        ["chmod"; "0o755"; "/test-command"];
1953        ["command"; "/test-command 8"]], "\n");
1954     InitBasicFS, Always, TestOutput (
1955       [["upload"; "test-command"; "/test-command"];
1956        ["chmod"; "0o755"; "/test-command"];
1957        ["command"; "/test-command 9"]], "\n\n");
1958     InitBasicFS, Always, TestOutput (
1959       [["upload"; "test-command"; "/test-command"];
1960        ["chmod"; "0o755"; "/test-command"];
1961        ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1962     InitBasicFS, Always, TestOutput (
1963       [["upload"; "test-command"; "/test-command"];
1964        ["chmod"; "0o755"; "/test-command"];
1965        ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1966     InitBasicFS, Always, TestLastFail (
1967       [["upload"; "test-command"; "/test-command"];
1968        ["chmod"; "0o755"; "/test-command"];
1969        ["command"; "/test-command"]])],
1970    "run a command from the guest filesystem",
1971    "\
1972 This call runs a command from the guest filesystem.  The
1973 filesystem must be mounted, and must contain a compatible
1974 operating system (ie. something Linux, with the same
1975 or compatible processor architecture).
1976
1977 The single parameter is an argv-style list of arguments.
1978 The first element is the name of the program to run.
1979 Subsequent elements are parameters.  The list must be
1980 non-empty (ie. must contain a program name).  Note that
1981 the command runs directly, and is I<not> invoked via
1982 the shell (see C<guestfs_sh>).
1983
1984 The return value is anything printed to I<stdout> by
1985 the command.
1986
1987 If the command returns a non-zero exit status, then
1988 this function returns an error message.  The error message
1989 string is the content of I<stderr> from the command.
1990
1991 The C<$PATH> environment variable will contain at least
1992 C</usr/bin> and C</bin>.  If you require a program from
1993 another location, you should provide the full path in the
1994 first parameter.
1995
1996 Shared libraries and data files required by the program
1997 must be available on filesystems which are mounted in the
1998 correct places.  It is the caller's responsibility to ensure
1999 all filesystems that are needed are mounted at the right
2000 locations.");
2001
2002   ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2003    [InitBasicFS, Always, TestOutputList (
2004       [["upload"; "test-command"; "/test-command"];
2005        ["chmod"; "0o755"; "/test-command"];
2006        ["command_lines"; "/test-command 1"]], ["Result1"]);
2007     InitBasicFS, Always, TestOutputList (
2008       [["upload"; "test-command"; "/test-command"];
2009        ["chmod"; "0o755"; "/test-command"];
2010        ["command_lines"; "/test-command 2"]], ["Result2"]);
2011     InitBasicFS, Always, TestOutputList (
2012       [["upload"; "test-command"; "/test-command"];
2013        ["chmod"; "0o755"; "/test-command"];
2014        ["command_lines"; "/test-command 3"]], ["";"Result3"]);
2015     InitBasicFS, Always, TestOutputList (
2016       [["upload"; "test-command"; "/test-command"];
2017        ["chmod"; "0o755"; "/test-command"];
2018        ["command_lines"; "/test-command 4"]], ["";"Result4"]);
2019     InitBasicFS, Always, TestOutputList (
2020       [["upload"; "test-command"; "/test-command"];
2021        ["chmod"; "0o755"; "/test-command"];
2022        ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
2023     InitBasicFS, Always, TestOutputList (
2024       [["upload"; "test-command"; "/test-command"];
2025        ["chmod"; "0o755"; "/test-command"];
2026        ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
2027     InitBasicFS, Always, TestOutputList (
2028       [["upload"; "test-command"; "/test-command"];
2029        ["chmod"; "0o755"; "/test-command"];
2030        ["command_lines"; "/test-command 7"]], []);
2031     InitBasicFS, Always, TestOutputList (
2032       [["upload"; "test-command"; "/test-command"];
2033        ["chmod"; "0o755"; "/test-command"];
2034        ["command_lines"; "/test-command 8"]], [""]);
2035     InitBasicFS, Always, TestOutputList (
2036       [["upload"; "test-command"; "/test-command"];
2037        ["chmod"; "0o755"; "/test-command"];
2038        ["command_lines"; "/test-command 9"]], ["";""]);
2039     InitBasicFS, Always, TestOutputList (
2040       [["upload"; "test-command"; "/test-command"];
2041        ["chmod"; "0o755"; "/test-command"];
2042        ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
2043     InitBasicFS, Always, TestOutputList (
2044       [["upload"; "test-command"; "/test-command"];
2045        ["chmod"; "0o755"; "/test-command"];
2046        ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
2047    "run a command, returning lines",
2048    "\
2049 This is the same as C<guestfs_command>, but splits the
2050 result into a list of lines.
2051
2052 See also: C<guestfs_sh_lines>");
2053
2054   ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2055    [InitISOFS, Always, TestOutputStruct (
2056       [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2057    "get file information",
2058    "\
2059 Returns file information for the given C<path>.
2060
2061 This is the same as the C<stat(2)> system call.");
2062
2063   ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2064    [InitISOFS, Always, TestOutputStruct (
2065       [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2066    "get file information for a symbolic link",
2067    "\
2068 Returns file information for the given C<path>.
2069
2070 This is the same as C<guestfs_stat> except that if C<path>
2071 is a symbolic link, then the link is stat-ed, not the file it
2072 refers to.
2073
2074 This is the same as the C<lstat(2)> system call.");
2075
2076   ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2077    [InitISOFS, Always, TestOutputStruct (
2078       [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2079    "get file system statistics",
2080    "\
2081 Returns file system statistics for any mounted file system.
2082 C<path> should be a file or directory in the mounted file system
2083 (typically it is the mount point itself, but it doesn't need to be).
2084
2085 This is the same as the C<statvfs(2)> system call.");
2086
2087   ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2088    [], (* XXX test *)
2089    "get ext2/ext3/ext4 superblock details",
2090    "\
2091 This returns the contents of the ext2, ext3 or ext4 filesystem
2092 superblock on C<device>.
2093
2094 It is the same as running C<tune2fs -l device>.  See L<tune2fs(8)>
2095 manpage for more details.  The list of fields returned isn't
2096 clearly defined, and depends on both the version of C<tune2fs>
2097 that libguestfs was built against, and the filesystem itself.");
2098
2099   ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2100    [InitEmpty, Always, TestOutputTrue (
2101       [["blockdev_setro"; "/dev/sda"];
2102        ["blockdev_getro"; "/dev/sda"]])],
2103    "set block device to read-only",
2104    "\
2105 Sets the block device named C<device> to read-only.
2106
2107 This uses the L<blockdev(8)> command.");
2108
2109   ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2110    [InitEmpty, Always, TestOutputFalse (
2111       [["blockdev_setrw"; "/dev/sda"];
2112        ["blockdev_getro"; "/dev/sda"]])],
2113    "set block device to read-write",
2114    "\
2115 Sets the block device named C<device> to read-write.
2116
2117 This uses the L<blockdev(8)> command.");
2118
2119   ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2120    [InitEmpty, Always, TestOutputTrue (
2121       [["blockdev_setro"; "/dev/sda"];
2122        ["blockdev_getro"; "/dev/sda"]])],
2123    "is block device set to read-only",
2124    "\
2125 Returns a boolean indicating if the block device is read-only
2126 (true if read-only, false if not).
2127
2128 This uses the L<blockdev(8)> command.");
2129
2130   ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2131    [InitEmpty, Always, TestOutputInt (
2132       [["blockdev_getss"; "/dev/sda"]], 512)],
2133    "get sectorsize of block device",
2134    "\
2135 This returns the size of sectors on a block device.
2136 Usually 512, but can be larger for modern devices.
2137
2138 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2139 for that).
2140
2141 This uses the L<blockdev(8)> command.");
2142
2143   ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2144    [InitEmpty, Always, TestOutputInt (
2145       [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2146    "get blocksize of block device",
2147    "\
2148 This returns the block size of a device.
2149
2150 (Note this is different from both I<size in blocks> and
2151 I<filesystem block size>).
2152
2153 This uses the L<blockdev(8)> command.");
2154
2155   ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2156    [], (* XXX test *)
2157    "set blocksize of block device",
2158    "\
2159 This sets the block size of a device.
2160
2161 (Note this is different from both I<size in blocks> and
2162 I<filesystem block size>).
2163
2164 This uses the L<blockdev(8)> command.");
2165
2166   ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2167    [InitEmpty, Always, TestOutputInt (
2168       [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2169    "get total size of device in 512-byte sectors",
2170    "\
2171 This returns the size of the device in units of 512-byte sectors
2172 (even if the sectorsize isn't 512 bytes ... weird).
2173
2174 See also C<guestfs_blockdev_getss> for the real sector size of
2175 the device, and C<guestfs_blockdev_getsize64> for the more
2176 useful I<size in bytes>.
2177
2178 This uses the L<blockdev(8)> command.");
2179
2180   ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2181    [InitEmpty, Always, TestOutputInt (
2182       [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2183    "get total size of device in bytes",
2184    "\
2185 This returns the size of the device in bytes.
2186
2187 See also C<guestfs_blockdev_getsz>.
2188
2189 This uses the L<blockdev(8)> command.");
2190
2191   ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2192    [InitEmpty, Always, TestRun
2193       [["blockdev_flushbufs"; "/dev/sda"]]],
2194    "flush device buffers",
2195    "\
2196 This tells the kernel to flush internal buffers associated
2197 with C<device>.
2198
2199 This uses the L<blockdev(8)> command.");
2200
2201   ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2202    [InitEmpty, Always, TestRun
2203       [["blockdev_rereadpt"; "/dev/sda"]]],
2204    "reread partition table",
2205    "\
2206 Reread the partition table on C<device>.
2207
2208 This uses the L<blockdev(8)> command.");
2209
2210   ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [],
2211    [InitBasicFS, Always, TestOutput (
2212       (* Pick a file from cwd which isn't likely to change. *)
2213       [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
2214        ["checksum"; "md5"; "/COPYING.LIB"]],
2215       Digest.to_hex (Digest.file "COPYING.LIB"))],
2216    "upload a file from the local machine",
2217    "\
2218 Upload local file C<filename> to C<remotefilename> on the
2219 filesystem.
2220
2221 C<filename> can also be a named pipe.
2222
2223 See also C<guestfs_download>.");
2224
2225   ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2226    [InitBasicFS, Always, TestOutput (
2227       (* Pick a file from cwd which isn't likely to change. *)
2228       [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
2229        ["download"; "/COPYING.LIB"; "testdownload.tmp"];
2230        ["upload"; "testdownload.tmp"; "/upload"];
2231        ["checksum"; "md5"; "/upload"]],
2232       Digest.to_hex (Digest.file "COPYING.LIB"))],
2233    "download a file to the local machine",
2234    "\
2235 Download file C<remotefilename> and save it as C<filename>
2236 on the local machine.
2237
2238 C<filename> can also be a named pipe.
2239
2240 See also C<guestfs_upload>, C<guestfs_cat>.");
2241
2242   ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2243    [InitISOFS, Always, TestOutput (
2244       [["checksum"; "crc"; "/known-3"]], "2891671662");
2245     InitISOFS, Always, TestLastFail (
2246       [["checksum"; "crc"; "/notexists"]]);
2247     InitISOFS, Always, TestOutput (
2248       [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2249     InitISOFS, Always, TestOutput (
2250       [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2251     InitISOFS, Always, TestOutput (
2252       [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2253     InitISOFS, Always, TestOutput (
2254       [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2255     InitISOFS, Always, TestOutput (
2256       [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2257     InitISOFS, Always, TestOutput (
2258       [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2259     (* Test for RHBZ#579608, absolute symbolic links. *)
2260     InitISOFS, Always, TestOutput (
2261       [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2262    "compute MD5, SHAx or CRC checksum of file",
2263    "\
2264 This call computes the MD5, SHAx or CRC checksum of the
2265 file named C<path>.
2266
2267 The type of checksum to compute is given by the C<csumtype>
2268 parameter which must have one of the following values:
2269
2270 =over 4
2271
2272 =item C<crc>
2273
2274 Compute the cyclic redundancy check (CRC) specified by POSIX
2275 for the C<cksum> command.
2276
2277 =item C<md5>
2278
2279 Compute the MD5 hash (using the C<md5sum> program).
2280
2281 =item C<sha1>
2282
2283 Compute the SHA1 hash (using the C<sha1sum> program).
2284
2285 =item C<sha224>
2286
2287 Compute the SHA224 hash (using the C<sha224sum> program).
2288
2289 =item C<sha256>
2290
2291 Compute the SHA256 hash (using the C<sha256sum> program).
2292
2293 =item C<sha384>
2294
2295 Compute the SHA384 hash (using the C<sha384sum> program).
2296
2297 =item C<sha512>
2298
2299 Compute the SHA512 hash (using the C<sha512sum> program).
2300
2301 =back
2302
2303 The checksum is returned as a printable string.
2304
2305 To get the checksum for a device, use C<guestfs_checksum_device>.
2306
2307 To get the checksums for many files, use C<guestfs_checksums_out>.");
2308
2309   ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2310    [InitBasicFS, Always, TestOutput (
2311       [["tar_in"; "../images/helloworld.tar"; "/"];
2312        ["cat"; "/hello"]], "hello\n")],
2313    "unpack tarfile to directory",
2314    "\
2315 This command uploads and unpacks local file C<tarfile> (an
2316 I<uncompressed> tar file) into C<directory>.
2317
2318 To upload a compressed tarball, use C<guestfs_tgz_in>
2319 or C<guestfs_txz_in>.");
2320
2321   ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2322    [],
2323    "pack directory into tarfile",
2324    "\
2325 This command packs the contents of C<directory> and downloads
2326 it to local file C<tarfile>.
2327
2328 To download a compressed tarball, use C<guestfs_tgz_out>
2329 or C<guestfs_txz_out>.");
2330
2331   ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2332    [InitBasicFS, Always, TestOutput (
2333       [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2334        ["cat"; "/hello"]], "hello\n")],
2335    "unpack compressed tarball to directory",
2336    "\
2337 This command uploads and unpacks local file C<tarball> (a
2338 I<gzip compressed> tar file) into C<directory>.
2339
2340 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2341
2342   ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2343    [],
2344    "pack directory into compressed tarball",
2345    "\
2346 This command packs the contents of C<directory> and downloads
2347 it to local file C<tarball>.
2348
2349 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2350
2351   ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2352    [InitBasicFS, Always, TestLastFail (
2353       [["umount"; "/"];
2354        ["mount_ro"; "/dev/sda1"; "/"];
2355        ["touch"; "/new"]]);
2356     InitBasicFS, Always, TestOutput (
2357       [["write"; "/new"; "data"];
2358        ["umount"; "/"];
2359        ["mount_ro"; "/dev/sda1"; "/"];
2360        ["cat"; "/new"]], "data")],
2361    "mount a guest disk, read-only",
2362    "\
2363 This is the same as the C<guestfs_mount> command, but it
2364 mounts the filesystem with the read-only (I<-o ro>) flag.");
2365
2366   ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2367    [],
2368    "mount a guest disk with mount options",
2369    "\
2370 This is the same as the C<guestfs_mount> command, but it
2371 allows you to set the mount options as for the
2372 L<mount(8)> I<-o> flag.
2373
2374 If the C<options> parameter is an empty string, then
2375 no options are passed (all options default to whatever
2376 the filesystem uses).");
2377
2378   ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2379    [],
2380    "mount a guest disk with mount options and vfstype",
2381    "\
2382 This is the same as the C<guestfs_mount> command, but it
2383 allows you to set both the mount options and the vfstype
2384 as for the L<mount(8)> I<-o> and I<-t> flags.");
2385
2386   ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2387    [],
2388    "debugging and internals",
2389    "\
2390 The C<guestfs_debug> command exposes some internals of
2391 C<guestfsd> (the guestfs daemon) that runs inside the
2392 qemu subprocess.
2393
2394 There is no comprehensive help for this command.  You have
2395 to look at the file C<daemon/debug.c> in the libguestfs source
2396 to find out what you can do.");
2397
2398   ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2399    [InitEmpty, Always, TestOutputList (
2400       [["part_disk"; "/dev/sda"; "mbr"];
2401        ["pvcreate"; "/dev/sda1"];
2402        ["vgcreate"; "VG"; "/dev/sda1"];
2403        ["lvcreate"; "LV1"; "VG"; "50"];
2404        ["lvcreate"; "LV2"; "VG"; "50"];
2405        ["lvremove"; "/dev/VG/LV1"];
2406        ["lvs"]], ["/dev/VG/LV2"]);
2407     InitEmpty, Always, TestOutputList (
2408       [["part_disk"; "/dev/sda"; "mbr"];
2409        ["pvcreate"; "/dev/sda1"];
2410        ["vgcreate"; "VG"; "/dev/sda1"];
2411        ["lvcreate"; "LV1"; "VG"; "50"];
2412        ["lvcreate"; "LV2"; "VG"; "50"];
2413        ["lvremove"; "/dev/VG"];
2414        ["lvs"]], []);
2415     InitEmpty, Always, TestOutputList (
2416       [["part_disk"; "/dev/sda"; "mbr"];
2417        ["pvcreate"; "/dev/sda1"];
2418        ["vgcreate"; "VG"; "/dev/sda1"];
2419        ["lvcreate"; "LV1"; "VG"; "50"];
2420        ["lvcreate"; "LV2"; "VG"; "50"];
2421        ["lvremove"; "/dev/VG"];
2422        ["vgs"]], ["VG"])],
2423    "remove an LVM logical volume",
2424    "\
2425 Remove an LVM logical volume C<device>, where C<device> is
2426 the path to the LV, such as C</dev/VG/LV>.
2427
2428 You can also remove all LVs in a volume group by specifying
2429 the VG name, C</dev/VG>.");
2430
2431   ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2432    [InitEmpty, Always, TestOutputList (
2433       [["part_disk"; "/dev/sda"; "mbr"];
2434        ["pvcreate"; "/dev/sda1"];
2435        ["vgcreate"; "VG"; "/dev/sda1"];
2436        ["lvcreate"; "LV1"; "VG"; "50"];
2437        ["lvcreate"; "LV2"; "VG"; "50"];
2438        ["vgremove"; "VG"];
2439        ["lvs"]], []);
2440     InitEmpty, Always, TestOutputList (
2441       [["part_disk"; "/dev/sda"; "mbr"];
2442        ["pvcreate"; "/dev/sda1"];
2443        ["vgcreate"; "VG"; "/dev/sda1"];
2444        ["lvcreate"; "LV1"; "VG"; "50"];
2445        ["lvcreate"; "LV2"; "VG"; "50"];
2446        ["vgremove"; "VG"];
2447        ["vgs"]], [])],
2448    "remove an LVM volume group",
2449    "\
2450 Remove an LVM volume group C<vgname>, (for example C<VG>).
2451
2452 This also forcibly removes all logical volumes in the volume
2453 group (if any).");
2454
2455   ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2456    [InitEmpty, Always, TestOutputListOfDevices (
2457       [["part_disk"; "/dev/sda"; "mbr"];
2458        ["pvcreate"; "/dev/sda1"];
2459        ["vgcreate"; "VG"; "/dev/sda1"];
2460        ["lvcreate"; "LV1"; "VG"; "50"];
2461        ["lvcreate"; "LV2"; "VG"; "50"];
2462        ["vgremove"; "VG"];
2463        ["pvremove"; "/dev/sda1"];
2464        ["lvs"]], []);
2465     InitEmpty, Always, TestOutputListOfDevices (
2466       [["part_disk"; "/dev/sda"; "mbr"];
2467        ["pvcreate"; "/dev/sda1"];
2468        ["vgcreate"; "VG"; "/dev/sda1"];
2469        ["lvcreate"; "LV1"; "VG"; "50"];
2470        ["lvcreate"; "LV2"; "VG"; "50"];
2471        ["vgremove"; "VG"];
2472        ["pvremove"; "/dev/sda1"];
2473        ["vgs"]], []);
2474     InitEmpty, Always, TestOutputListOfDevices (
2475       [["part_disk"; "/dev/sda"; "mbr"];
2476        ["pvcreate"; "/dev/sda1"];
2477        ["vgcreate"; "VG"; "/dev/sda1"];
2478        ["lvcreate"; "LV1"; "VG"; "50"];
2479        ["lvcreate"; "LV2"; "VG"; "50"];
2480        ["vgremove"; "VG"];
2481        ["pvremove"; "/dev/sda1"];
2482        ["pvs"]], [])],
2483    "remove an LVM physical volume",
2484    "\
2485 This wipes a physical volume C<device> so that LVM will no longer
2486 recognise it.
2487
2488 The implementation uses the C<pvremove> command which refuses to
2489 wipe physical volumes that contain any volume groups, so you have
2490 to remove those first.");
2491
2492   ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2493    [InitBasicFS, Always, TestOutput (
2494       [["set_e2label"; "/dev/sda1"; "testlabel"];
2495        ["get_e2label"; "/dev/sda1"]], "testlabel")],
2496    "set the ext2/3/4 filesystem label",
2497    "\
2498 This sets the ext2/3/4 filesystem label of the filesystem on
2499 C<device> to C<label>.  Filesystem labels are limited to
2500 16 characters.
2501
2502 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2503 to return the existing label on a filesystem.");
2504
2505   ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2506    [],
2507    "get the ext2/3/4 filesystem label",
2508    "\
2509 This returns the ext2/3/4 filesystem label of the filesystem on
2510 C<device>.");
2511
2512   ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2513    (let uuid = uuidgen () in
2514     [InitBasicFS, Always, TestOutput (
2515        [["set_e2uuid"; "/dev/sda1"; uuid];
2516         ["get_e2uuid"; "/dev/sda1"]], uuid);
2517      InitBasicFS, Always, TestOutput (
2518        [["set_e2uuid"; "/dev/sda1"; "clear"];
2519         ["get_e2uuid"; "/dev/sda1"]], "");
2520      (* We can't predict what UUIDs will be, so just check the commands run. *)
2521      InitBasicFS, Always, TestRun (
2522        [["set_e2uuid"; "/dev/sda1"; "random"]]);
2523      InitBasicFS, Always, TestRun (
2524        [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2525    "set the ext2/3/4 filesystem UUID",
2526    "\
2527 This sets the ext2/3/4 filesystem UUID of the filesystem on
2528 C<device> to C<uuid>.  The format of the UUID and alternatives
2529 such as C<clear>, C<random> and C<time> are described in the
2530 L<tune2fs(8)> manpage.
2531
2532 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2533 to return the existing UUID of a filesystem.");
2534
2535   ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2536    (* Regression test for RHBZ#597112. *)
2537    (let uuid = uuidgen () in
2538     [InitBasicFS, Always, TestOutput (
2539        [["mke2journal"; "1024"; "/dev/sdb"];
2540         ["set_e2uuid"; "/dev/sdb"; uuid];
2541         ["get_e2uuid"; "/dev/sdb"]], uuid)]),
2542    "get the ext2/3/4 filesystem UUID",
2543    "\
2544 This returns the ext2/3/4 filesystem UUID of the filesystem on
2545 C<device>.");
2546
2547   ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2548    [InitBasicFS, Always, TestOutputInt (
2549       [["umount"; "/dev/sda1"];
2550        ["fsck"; "ext2"; "/dev/sda1"]], 0);
2551     InitBasicFS, Always, TestOutputInt (
2552       [["umount"; "/dev/sda1"];
2553        ["zero"; "/dev/sda1"];
2554        ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2555    "run the filesystem checker",
2556    "\
2557 This runs the filesystem checker (fsck) on C<device> which
2558 should have filesystem type C<fstype>.
2559
2560 The returned integer is the status.  See L<fsck(8)> for the
2561 list of status codes from C<fsck>.
2562
2563 Notes:
2564
2565 =over 4
2566
2567 =item *
2568
2569 Multiple status codes can be summed together.
2570
2571 =item *
2572
2573 A non-zero return code can mean \"success\", for example if
2574 errors have been corrected on the filesystem.
2575
2576 =item *
2577
2578 Checking or repairing NTFS volumes is not supported
2579 (by linux-ntfs).
2580
2581 =back
2582
2583 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2584
2585   ("zero", (RErr, [Device "device"], []), 85, [Progress],
2586    [InitBasicFS, Always, TestOutput (
2587       [["umount"; "/dev/sda1"];
2588        ["zero"; "/dev/sda1"];
2589        ["file"; "/dev/sda1"]], "data")],
2590    "write zeroes to the device",
2591    "\
2592 This command writes zeroes over the first few blocks of C<device>.
2593
2594 How many blocks are zeroed isn't specified (but it's I<not> enough
2595 to securely wipe the device).  It should be sufficient to remove
2596 any partition tables, filesystem superblocks and so on.
2597
2598 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2599
2600   ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2601    (* See:
2602     * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2603     * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2604     *)
2605    [InitBasicFS, Always, TestOutputTrue (
2606       [["mkdir_p"; "/boot/grub"];
2607        ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2608        ["grub_install"; "/"; "/dev/vda"];
2609        ["is_dir"; "/boot"]])],
2610    "install GRUB",
2611    "\
2612 This command installs GRUB (the Grand Unified Bootloader) on
2613 C<device>, with the root directory being C<root>.
2614
2615 Note: If grub-install reports the error
2616 \"No suitable drive was found in the generated device map.\"
2617 it may be that you need to create a C</boot/grub/device.map>
2618 file first that contains the mapping between grub device names
2619 and Linux device names.  It is usually sufficient to create
2620 a file containing:
2621
2622  (hd0) /dev/vda
2623
2624 replacing C</dev/vda> with the name of the installation device.");
2625
2626   ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
2627    [InitBasicFS, Always, TestOutput (
2628       [["write"; "/old"; "file content"];
2629        ["cp"; "/old"; "/new"];
2630        ["cat"; "/new"]], "file content");
2631     InitBasicFS, Always, TestOutputTrue (
2632       [["write"; "/old"; "file content"];
2633        ["cp"; "/old"; "/new"];
2634        ["is_file"; "/old"]]);
2635     InitBasicFS, Always, TestOutput (
2636       [["write"; "/old"; "file content"];
2637        ["mkdir"; "/dir"];
2638        ["cp"; "/old"; "/dir/new"];
2639        ["cat"; "/dir/new"]], "file content")],
2640    "copy a file",
2641    "\
2642 This copies a file from C<src> to C<dest> where C<dest> is
2643 either a destination filename or destination directory.");
2644
2645   ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
2646    [InitBasicFS, Always, TestOutput (
2647       [["mkdir"; "/olddir"];
2648        ["mkdir"; "/newdir"];
2649        ["write"; "/olddir/file"; "file content"];
2650        ["cp_a"; "/olddir"; "/newdir"];
2651        ["cat"; "/newdir/olddir/file"]], "file content")],
2652    "copy a file or directory recursively",
2653    "\
2654 This copies a file or directory from C<src> to C<dest>
2655 recursively using the C<cp -a> command.");
2656
2657   ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
2658    [InitBasicFS, Always, TestOutput (
2659       [["write"; "/old"; "file content"];
2660        ["mv"; "/old"; "/new"];
2661        ["cat"; "/new"]], "file content");
2662     InitBasicFS, Always, TestOutputFalse (
2663       [["write"; "/old"; "file content"];
2664        ["mv"; "/old"; "/new"];
2665        ["is_file"; "/old"]])],
2666    "move a file",
2667    "\
2668 This moves a file from C<src> to C<dest> where C<dest> is
2669 either a destination filename or destination directory.");
2670
2671   ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
2672    [InitEmpty, Always, TestRun (
2673       [["drop_caches"; "3"]])],
2674    "drop kernel page cache, dentries and inodes",
2675    "\
2676 This instructs the guest kernel to drop its page cache,
2677 and/or dentries and inode caches.  The parameter C<whattodrop>
2678 tells the kernel what precisely to drop, see
2679 L<http://linux-mm.org/Drop_Caches>
2680
2681 Setting C<whattodrop> to 3 should drop everything.
2682
2683 This automatically calls L<sync(2)> before the operation,
2684 so that the maximum guest memory is freed.");
2685
2686   ("dmesg", (RString "kmsgs", [], []), 91, [],
2687    [InitEmpty, Always, TestRun (
2688       [["dmesg"]])],
2689    "return kernel messages",
2690    "\
2691 This returns the kernel messages (C<dmesg> output) from
2692 the guest kernel.  This is sometimes useful for extended
2693 debugging of problems.
2694
2695 Another way to get the same information is to enable
2696 verbose messages with C<guestfs_set_verbose> or by setting
2697 the environment variable C<LIBGUESTFS_DEBUG=1> before
2698 running the program.");
2699
2700   ("ping_daemon", (RErr, [], []), 92, [],
2701    [InitEmpty, Always, TestRun (
2702       [["ping_daemon"]])],
2703    "ping the guest daemon",
2704    "\
2705 This is a test probe into the guestfs daemon running inside
2706 the qemu subprocess.  Calling this function checks that the
2707 daemon responds to the ping message, without affecting the daemon
2708 or attached block device(s) in any other way.");
2709
2710   ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
2711    [InitBasicFS, Always, TestOutputTrue (
2712       [["write"; "/file1"; "contents of a file"];
2713        ["cp"; "/file1"; "/file2"];
2714        ["equal"; "/file1"; "/file2"]]);
2715     InitBasicFS, Always, TestOutputFalse (
2716       [["write"; "/file1"; "contents of a file"];
2717        ["write"; "/file2"; "contents of another file"];
2718        ["equal"; "/file1"; "/file2"]]);
2719     InitBasicFS, Always, TestLastFail (
2720       [["equal"; "/file1"; "/file2"]])],
2721    "test if two files have equal contents",
2722    "\
2723 This compares the two files C<file1> and C<file2> and returns
2724 true if their content is exactly equal, or false otherwise.
2725
2726 The external L<cmp(1)> program is used for the comparison.");
2727
2728   ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
2729    [InitISOFS, Always, TestOutputList (
2730       [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2731     InitISOFS, Always, TestOutputList (
2732       [["strings"; "/empty"]], []);
2733     (* Test for RHBZ#579608, absolute symbolic links. *)
2734     InitISOFS, Always, TestRun (
2735       [["strings"; "/abssymlink"]])],
2736    "print the printable strings in a file",
2737    "\
2738 This runs the L<strings(1)> command on a file and returns
2739 the list of printable strings found.");
2740
2741   ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
2742    [InitISOFS, Always, TestOutputList (
2743       [["strings_e"; "b"; "/known-5"]], []);
2744     InitBasicFS, Always, TestOutputList (
2745       [["write"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2746        ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2747    "print the printable strings in a file",
2748    "\
2749 This is like the C<guestfs_strings> command, but allows you to
2750 specify the encoding of strings that are looked for in
2751 the source file C<path>.
2752
2753 Allowed encodings are:
2754
2755 =over 4
2756
2757 =item s
2758
2759 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2760 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2761
2762 =item S
2763
2764 Single 8-bit-byte characters.
2765
2766 =item b
2767
2768 16-bit big endian strings such as those encoded in
2769 UTF-16BE or UCS-2BE.
2770
2771 =item l (lower case letter L)
2772
2773 16-bit little endian such as UTF-16LE and UCS-2LE.
2774 This is useful for examining binaries in Windows guests.
2775
2776 =item B
2777
2778 32-bit big endian such as UCS-4BE.
2779
2780 =item L
2781
2782 32-bit little endian such as UCS-4LE.
2783
2784 =back
2785
2786 The returned strings are transcoded to UTF-8.");
2787
2788   ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
2789    [InitISOFS, Always, TestOutput (
2790       [["hexdump"; "/known-4"]], "00000000  61 62 63 0a 64 65 66 0a  67 68 69                 |abc.def.ghi|\n0000000b\n");
2791     (* Test for RHBZ#501888c2 regression which caused large hexdump
2792      * commands to segfault.
2793      *)
2794     InitISOFS, Always, TestRun (
2795       [["hexdump"; "/100krandom"]]);
2796     (* Test for RHBZ#579608, absolute symbolic links. *)
2797     InitISOFS, Always, TestRun (
2798       [["hexdump"; "/abssymlink"]])],
2799    "dump a file in hexadecimal",
2800    "\
2801 This runs C<hexdump -C> on the given C<path>.  The result is
2802 the human-readable, canonical hex dump of the file.");
2803
2804   ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
2805    [InitNone, Always, TestOutput (
2806       [["part_disk"; "/dev/sda"; "mbr"];
2807        ["mkfs"; "ext3"; "/dev/sda1"];
2808        ["mount_options"; ""; "/dev/sda1"; "/"];
2809        ["write"; "/new"; "test file"];
2810        ["umount"; "/dev/sda1"];
2811        ["zerofree"; "/dev/sda1"];
2812        ["mount_options"; ""; "/dev/sda1"; "/"];
2813        ["cat"; "/new"]], "test file")],
2814    "zero unused inodes and disk blocks on ext2/3 filesystem",
2815    "\
2816 This runs the I<zerofree> program on C<device>.  This program
2817 claims to zero unused inodes and disk blocks on an ext2/3
2818 filesystem, thus making it possible to compress the filesystem
2819 more effectively.
2820
2821 You should B<not> run this program if the filesystem is
2822 mounted.
2823
2824 It is possible that using this program can damage the filesystem
2825 or data on the filesystem.");
2826
2827   ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
2828    [],
2829    "resize an LVM physical volume",
2830    "\
2831 This resizes (expands or shrinks) an existing LVM physical
2832 volume to match the new size of the underlying device.");
2833
2834   ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2835                        Int "cyls"; Int "heads"; Int "sectors";
2836                        String "line"], []), 99, [DangerWillRobinson],
2837    [],
2838    "modify a single partition on a block device",
2839    "\
2840 This runs L<sfdisk(8)> option to modify just the single
2841 partition C<n> (note: C<n> counts from 1).
2842
2843 For other parameters, see C<guestfs_sfdisk>.  You should usually
2844 pass C<0> for the cyls/heads/sectors parameters.
2845
2846 See also: C<guestfs_part_add>");
2847
2848   ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [],
2849    [],
2850    "display the partition table",
2851    "\
2852 This displays the partition table on C<device>, in the
2853 human-readable output of the L<sfdisk(8)> command.  It is
2854 not intended to be parsed.
2855
2856 See also: C<guestfs_part_list>");
2857
2858   ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
2859    [],
2860    "display the kernel geometry",
2861    "\
2862 This displays the kernel's idea of the geometry of C<device>.
2863
2864 The result is in human-readable format, and not designed to
2865 be parsed.");
2866
2867   ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
2868    [],
2869    "display the disk geometry from the partition table",
2870    "\
2871 This displays the disk geometry of C<device> read from the
2872 partition table.  Especially in the case where the underlying
2873 block device has been resized, this can be different from the
2874 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2875
2876 The result is in human-readable format, and not designed to
2877 be parsed.");
2878
2879   ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
2880    [],
2881    "activate or deactivate all volume groups",
2882    "\
2883 This command activates or (if C<activate> is false) deactivates
2884 all logical volumes in all volume groups.
2885 If activated, then they are made known to the
2886 kernel, ie. they appear as C</dev/mapper> devices.  If deactivated,
2887 then those devices disappear.
2888
2889 This command is the same as running C<vgchange -a y|n>");
2890
2891   ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
2892    [],
2893    "activate or deactivate some volume groups",
2894    "\
2895 This command activates or (if C<activate> is false) deactivates
2896 all logical volumes in the listed volume groups C<volgroups>.
2897 If activated, then they are made known to the
2898 kernel, ie. they appear as C</dev/mapper> devices.  If deactivated,
2899 then those devices disappear.
2900
2901 This command is the same as running C<vgchange -a y|n volgroups...>
2902
2903 Note that if C<volgroups> is an empty list then B<all> volume groups
2904 are activated or deactivated.");
2905
2906   ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
2907    [InitNone, Always, TestOutput (
2908       [["part_disk"; "/dev/sda"; "mbr"];
2909        ["pvcreate"; "/dev/sda1"];
2910        ["vgcreate"; "VG"; "/dev/sda1"];
2911        ["lvcreate"; "LV"; "VG"; "10"];
2912        ["mkfs"; "ext2"; "/dev/VG/LV"];
2913        ["mount_options"; ""; "/dev/VG/LV"; "/"];
2914        ["write"; "/new"; "test content"];
2915        ["umount"; "/"];
2916        ["lvresize"; "/dev/VG/LV"; "20"];
2917        ["e2fsck_f"; "/dev/VG/LV"];
2918        ["resize2fs"; "/dev/VG/LV"];
2919        ["mount_options"; ""; "/dev/VG/LV"; "/"];
2920        ["cat"; "/new"]], "test content");
2921     InitNone, Always, TestRun (
2922       (* Make an LV smaller to test RHBZ#587484. *)
2923       [["part_disk"; "/dev/sda"; "mbr"];
2924        ["pvcreate"; "/dev/sda1"];
2925        ["vgcreate"; "VG"; "/dev/sda1"];
2926        ["lvcreate"; "LV"; "VG"; "20"];
2927        ["lvresize"; "/dev/VG/LV"; "10"]])],
2928    "resize an LVM logical volume",
2929    "\
2930 This resizes (expands or shrinks) an existing LVM logical
2931 volume to C<mbytes>.  When reducing, data in the reduced part
2932 is lost.");
2933
2934   ("resize2fs", (RErr, [Device "device"], []), 106, [],
2935    [], (* lvresize tests this *)
2936    "resize an ext2, ext3 or ext4 filesystem",
2937    "\
2938 This resizes an ext2, ext3 or ext4 filesystem to match the size of
2939 the underlying device.
2940
2941 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2942 on the C<device> before calling this command.  For unknown reasons
2943 C<resize2fs> sometimes gives an error about this and sometimes not.
2944 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2945 calling this function.");
2946
2947   ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
2948    [InitBasicFS, Always, TestOutputList (
2949       [["find"; "/"]], ["lost+found"]);
2950     InitBasicFS, Always, TestOutputList (
2951       [["touch"; "/a"];
2952        ["mkdir"; "/b"];
2953        ["touch"; "/b/c"];
2954        ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2955     InitBasicFS, Always, TestOutputList (
2956       [["mkdir_p"; "/a/b/c"];
2957        ["touch"; "/a/b/c/d"];
2958        ["find"; "/a/b/"]], ["c"; "c/d"])],
2959    "find all files and directories",
2960    "\
2961 This command lists out all files and directories, recursively,
2962 starting at C<directory>.  It is essentially equivalent to
2963 running the shell command C<find directory -print> but some
2964 post-processing happens on the output, described below.
2965
2966 This returns a list of strings I<without any prefix>.  Thus
2967 if the directory structure was:
2968
2969  /tmp/a
2970  /tmp/b
2971  /tmp/c/d
2972
2973 then the returned list from C<guestfs_find> C</tmp> would be
2974 4 elements:
2975
2976  a
2977  b
2978  c
2979  c/d
2980
2981 If C<directory> is not a directory, then this command returns
2982 an error.
2983
2984 The returned list is sorted.
2985
2986 See also C<guestfs_find0>.");
2987
2988   ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
2989    [], (* lvresize tests this *)
2990    "check an ext2/ext3 filesystem",
2991    "\
2992 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2993 filesystem checker on C<device>, noninteractively (C<-p>),
2994 even if the filesystem appears to be clean (C<-f>).
2995
2996 This command is only needed because of C<guestfs_resize2fs>
2997 (q.v.).  Normally you should use C<guestfs_fsck>.");
2998
2999   ("sleep", (RErr, [Int "secs"], []), 109, [],
3000    [InitNone, Always, TestRun (
3001       [["sleep"; "1"]])],
3002    "sleep for some seconds",
3003    "\
3004 Sleep for C<secs> seconds.");
3005
3006   ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3007    [InitNone, Always, TestOutputInt (
3008       [["part_disk"; "/dev/sda"; "mbr"];
3009        ["mkfs"; "ntfs"; "/dev/sda1"];
3010        ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3011     InitNone, Always, TestOutputInt (
3012       [["part_disk"; "/dev/sda"; "mbr"];
3013        ["mkfs"; "ext2"; "/dev/sda1"];
3014        ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3015    "probe NTFS volume",
3016    "\
3017 This command runs the L<ntfs-3g.probe(8)> command which probes
3018 an NTFS C<device> for mountability.  (Not all NTFS volumes can
3019 be mounted read-write, and some cannot be mounted at all).
3020
3021 C<rw> is a boolean flag.  Set it to true if you want to test
3022 if the volume can be mounted read-write.  Set it to false if
3023 you want to test if the volume can be mounted read-only.
3024
3025 The return value is an integer which C<0> if the operation
3026 would succeed, or some non-zero value documented in the
3027 L<ntfs-3g.probe(8)> manual page.");
3028
3029   ("sh", (RString "output", [String "command"], []), 111, [],
3030    [], (* XXX needs tests *)
3031    "run a command via the shell",
3032    "\
3033 This call runs a command from the guest filesystem via the
3034 guest's C</bin/sh>.
3035
3036 This is like C<guestfs_command>, but passes the command to:
3037
3038  /bin/sh -c \"command\"
3039
3040 Depending on the guest's shell, this usually results in
3041 wildcards being expanded, shell expressions being interpolated
3042 and so on.
3043
3044 All the provisos about C<guestfs_command> apply to this call.");
3045
3046   ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3047    [], (* XXX needs tests *)
3048    "run a command via the shell returning lines",
3049    "\
3050 This is the same as C<guestfs_sh>, but splits the result
3051 into a list of lines.
3052
3053 See also: C<guestfs_command_lines>");
3054
3055   ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3056    (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3057     * code in stubs.c, since all valid glob patterns must start with "/".
3058     * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3059     *)
3060    [InitBasicFS, Always, TestOutputList (
3061       [["mkdir_p"; "/a/b/c"];
3062        ["touch"; "/a/b/c/d"];
3063        ["touch"; "/a/b/c/e"];
3064        ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
3065     InitBasicFS, Always, TestOutputList (
3066       [["mkdir_p"; "/a/b/c"];
3067        ["touch"; "/a/b/c/d"];
3068        ["touch"; "/a/b/c/e"];
3069        ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
3070     InitBasicFS, Always, TestOutputList (
3071       [["mkdir_p"; "/a/b/c"];
3072        ["touch"; "/a/b/c/d"];
3073        ["touch"; "/a/b/c/e"];
3074        ["glob_expand"; "/a/*/x/*"]], [])],
3075    "expand a wildcard path",
3076    "\
3077 This command searches for all the pathnames matching
3078 C<pattern> according to the wildcard expansion rules
3079 used by the shell.
3080
3081 If no paths match, then this returns an empty list
3082 (note: not an error).
3083
3084 It is just a wrapper around the C L<glob(3)> function
3085 with flags C<GLOB_MARK|GLOB_BRACE>.
3086 See that manual page for more details.");
3087
3088   ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3089    [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3090       [["scrub_device"; "/dev/sdc"]])],
3091    "scrub (securely wipe) a device",
3092    "\
3093 This command writes patterns over C<device> to make data retrieval
3094 more difficult.
3095
3096 It is an interface to the L<scrub(1)> program.  See that
3097 manual page for more details.");
3098
3099   ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3100    [InitBasicFS, Always, TestRun (
3101       [["write"; "/file"; "content"];
3102        ["scrub_file"; "/file"]])],
3103    "scrub (securely wipe) a file",
3104    "\
3105 This command writes patterns over a file to make data retrieval
3106 more difficult.
3107
3108 The file is I<removed> after scrubbing.
3109
3110 It is an interface to the L<scrub(1)> program.  See that
3111 manual page for more details.");
3112
3113   ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3114    [], (* XXX needs testing *)
3115    "scrub (securely wipe) free space",
3116    "\
3117 This command creates the directory C<dir> and then fills it
3118 with files until the filesystem is full, and scrubs the files
3119 as for C<guestfs_scrub_file>, and deletes them.
3120 The intention is to scrub any free space on the partition
3121 containing C<dir>.
3122
3123 It is an interface to the L<scrub(1)> program.  See that
3124 manual page for more details.");
3125
3126   ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3127    [InitBasicFS, Always, TestRun (
3128       [["mkdir"; "/tmp"];
3129        ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
3130    "create a temporary directory",
3131    "\
3132 This command creates a temporary directory.  The
3133 C<template> parameter should be a full pathname for the
3134 temporary directory name with the final six characters being
3135 \"XXXXXX\".
3136
3137 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3138 the second one being suitable for Windows filesystems.
3139
3140 The name of the temporary directory that was created
3141 is returned.
3142
3143 The temporary directory is created with mode 0700
3144 and is owned by root.
3145
3146 The caller is responsible for deleting the temporary
3147 directory and its contents after use.
3148
3149 See also: L<mkdtemp(3)>");
3150
3151   ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3152    [InitISOFS, Always, TestOutputInt (
3153       [["wc_l"; "/10klines"]], 10000);
3154     (* Test for RHBZ#579608, absolute symbolic links. *)
3155     InitISOFS, Always, TestOutputInt (
3156       [["wc_l"; "/abssymlink"]], 10000)],
3157    "count lines in a file",
3158    "\
3159 This command counts the lines in a file, using the
3160 C<wc -l> external command.");
3161
3162   ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3163    [InitISOFS, Always, TestOutputInt (
3164       [["wc_w"; "/10klines"]], 10000)],
3165    "count words in a file",
3166    "\
3167 This command counts the words in a file, using the
3168 C<wc -w> external command.");
3169
3170   ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3171    [InitISOFS, Always, TestOutputInt (
3172       [["wc_c"; "/100kallspaces"]], 102400)],
3173    "count characters in a file",
3174    "\
3175 This command counts the characters in a file, using the
3176 C<wc -c> external command.");
3177
3178   ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3179    [InitISOFS, Always, TestOutputList (
3180       [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3181     (* Test for RHBZ#579608, absolute symbolic links. *)
3182     InitISOFS, Always, TestOutputList (
3183       [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3184    "return first 10 lines of a file",
3185    "\
3186 This command returns up to the first 10 lines of a file as
3187 a list of strings.");
3188
3189   ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3190    [InitISOFS, Always, TestOutputList (
3191       [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3192     InitISOFS, Always, TestOutputList (
3193       [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3194     InitISOFS, Always, TestOutputList (
3195       [["head_n"; "0"; "/10klines"]], [])],
3196    "return first N lines of a file",
3197    "\
3198 If the parameter C<nrlines> is a positive number, this returns the first
3199 C<nrlines> lines of the file C<path>.
3200
3201 If the parameter C<nrlines> is a negative number, this returns lines
3202 from the file C<path>, excluding the last C<nrlines> lines.
3203
3204 If the parameter C<nrlines> is zero, this returns an empty list.");
3205
3206   ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3207    [InitISOFS, Always, TestOutputList (
3208       [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3209    "return last 10 lines of a file",
3210    "\
3211 This command returns up to the last 10 lines of a file as
3212 a list of strings.");
3213
3214   ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3215    [InitISOFS, Always, TestOutputList (
3216       [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3217     InitISOFS, Always, TestOutputList (
3218       [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3219     InitISOFS, Always, TestOutputList (
3220       [["tail_n"; "0"; "/10klines"]], [])],
3221    "return last N lines of a file",
3222    "\
3223 If the parameter C<nrlines> is a positive number, this returns the last
3224 C<nrlines> lines of the file C<path>.
3225
3226 If the parameter C<nrlines> is a negative number, this returns lines
3227 from the file C<path>, starting with the C<-nrlines>th line.
3228
3229 If the parameter C<nrlines> is zero, this returns an empty list.");
3230
3231   ("df", (RString "output", [], []), 125, [],
3232    [], (* XXX Tricky to test because it depends on the exact format
3233         * of the 'df' command and other imponderables.
3234         *)
3235    "report file system disk space usage",
3236    "\
3237 This command runs the C<df> command to report disk space used.
3238
3239 This command is mostly useful for interactive sessions.  It
3240 is I<not> intended that you try to parse the output string.
3241 Use C<statvfs> from programs.");
3242
3243   ("df_h", (RString "output", [], []), 126, [],
3244    [], (* XXX Tricky to test because it depends on the exact format
3245         * of the 'df' command and other imponderables.
3246         *)
3247    "report file system disk space usage (human readable)",
3248    "\
3249 This command runs the C<df -h> command to report disk space used
3250 in human-readable format.
3251
3252 This command is mostly useful for interactive sessions.  It
3253 is I<not> intended that you try to parse the output string.
3254 Use C<statvfs> from programs.");
3255
3256   ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [],
3257    [InitISOFS, Always, TestOutputInt (
3258       [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3259    "estimate file space usage",
3260    "\
3261 This command runs the C<du -s> command to estimate file space
3262 usage for C<path>.
3263
3264 C<path> can be a file or a directory.  If C<path> is a directory
3265 then the estimate includes the contents of the directory and all
3266 subdirectories (recursively).
3267
3268 The result is the estimated size in I<kilobytes>
3269 (ie. units of 1024 bytes).");
3270
3271   ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3272    [InitISOFS, Always, TestOutputList (
3273       [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3274    "list files in an initrd",
3275    "\
3276 This command lists out files contained in an initrd.
3277
3278 The files are listed without any initial C</> character.  The
3279 files are listed in the order they appear (not necessarily
3280 alphabetical).  Directory names are listed as separate items.
3281
3282 Old Linux kernels (2.4 and earlier) used a compressed ext2
3283 filesystem as initrd.  We I<only> support the newer initramfs
3284 format (compressed cpio files).");
3285
3286   ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3287    [],
3288    "mount a file using the loop device",
3289    "\
3290 This command lets you mount C<file> (a filesystem image
3291 in a file) on a mount point.  It is entirely equivalent to
3292 the command C<mount -o loop file mountpoint>.");
3293
3294   ("mkswap", (RErr, [Device "device"], []), 130, [],
3295    [InitEmpty, Always, TestRun (
3296       [["part_disk"; "/dev/sda"; "mbr"];
3297        ["mkswap"; "/dev/sda1"]])],
3298    "create a swap partition",
3299    "\
3300 Create a swap partition on C<device>.");
3301
3302   ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3303    [InitEmpty, Always, TestRun (
3304       [["part_disk"; "/dev/sda"; "mbr"];
3305        ["mkswap_L"; "hello"; "/dev/sda1"]])],
3306    "create a swap partition with a label",
3307    "\
3308 Create a swap partition on C<device> with label C<label>.
3309
3310 Note that you cannot attach a swap label to a block device
3311 (eg. C</dev/sda>), just to a partition.  This appears to be
3312 a limitation of the kernel or swap tools.");
3313
3314   ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3315    (let uuid = uuidgen () in
3316     [InitEmpty, Always, TestRun (
3317        [["part_disk"; "/dev/sda"; "mbr"];
3318         ["mkswap_U"; uuid; "/dev/sda1"]])]),
3319    "create a swap partition with an explicit UUID",
3320    "\
3321 Create a swap partition on C<device> with UUID C<uuid>.");
3322
3323   ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3324    [InitBasicFS, Always, TestOutputStruct (
3325       [["mknod"; "0o10777"; "0"; "0"; "/node"];
3326        (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3327        ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
3328     InitBasicFS, Always, TestOutputStruct (
3329       [["mknod"; "0o60777"; "66"; "99"; "/node"];
3330        ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3331    "make block, character or FIFO devices",
3332    "\
3333 This call creates block or character special devices, or
3334 named pipes (FIFOs).
3335
3336 The C<mode> parameter should be the mode, using the standard
3337 constants.  C<devmajor> and C<devminor> are the
3338 device major and minor numbers, only used when creating block
3339 and character special devices.
3340
3341 Note that, just like L<mknod(2)>, the mode must be bitwise
3342 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3343 just creates a regular file).  These constants are
3344 available in the standard Linux header files, or you can use
3345 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3346 which are wrappers around this command which bitwise OR
3347 in the appropriate constant for you.
3348
3349 The mode actually set is affected by the umask.");
3350
3351   ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3352    [InitBasicFS, Always, TestOutputStruct (
3353       [["mkfifo"; "0o777"; "/node"];
3354        ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
3355    "make FIFO (named pipe)",
3356    "\
3357 This call creates a FIFO (named pipe) called C<path> with
3358 mode C<mode>.  It is just a convenient wrapper around
3359 C<guestfs_mknod>.
3360
3361 The mode actually set is affected by the umask.");
3362
3363   ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3364    [InitBasicFS, Always, TestOutputStruct (
3365       [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3366        ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3367    "make block device node",
3368    "\
3369 This call creates a block device node called C<path> with
3370 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3371 It is just a convenient wrapper around C<guestfs_mknod>.
3372
3373 The mode actually set is affected by the umask.");
3374
3375   ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3376    [InitBasicFS, Always, TestOutputStruct (
3377       [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3378        ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3379    "make char device node",
3380    "\
3381 This call creates a char device node called C<path> with
3382 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3383 It is just a convenient wrapper around C<guestfs_mknod>.
3384
3385 The mode actually set is affected by the umask.");
3386
3387   ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3388    [InitEmpty, Always, TestOutputInt (
3389       [["umask"; "0o22"]], 0o22)],
3390    "set file mode creation mask (umask)",
3391    "\
3392 This function sets the mask used for creating new files and
3393 device nodes to C<mask & 0777>.
3394
3395 Typical umask values would be C<022> which creates new files
3396 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3397 C<002> which creates new files with permissions like
3398 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3399
3400 The default umask is C<022>.  This is important because it
3401 means that directories and device nodes will be created with
3402 C<0644> or C<0755> mode even if you specify C<0777>.
3403
3404 See also C<guestfs_get_umask>,
3405 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3406
3407 This call returns the previous umask.");
3408
3409   ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3410    [],
3411    "read directories entries",
3412    "\
3413 This returns the list of directory entries in directory C<dir>.
3414
3415 All entries in the directory are returned, including C<.> and
3416 C<..>.  The entries are I<not> sorted, but returned in the same
3417 order as the underlying filesystem.
3418
3419 Also this call returns basic file type information about each
3420 file.  The C<ftyp> field will contain one of the following characters:
3421
3422 =over 4
3423
3424 =item 'b'
3425
3426 Block special
3427
3428 =item 'c'
3429
3430 Char special
3431
3432 =item 'd'
3433
3434 Directory
3435
3436 =item 'f'
3437
3438 FIFO (named pipe)
3439
3440 =item 'l'
3441
3442 Symbolic link
3443
3444 =item 'r'
3445
3446 Regular file
3447
3448 =item 's'
3449
3450 Socket
3451
3452 =item 'u'
3453
3454 Unknown file type
3455
3456 =item '?'
3457
3458 The L<readdir(3)> call returned a C<d_type> field with an
3459 unexpected value
3460
3461 =back
3462
3463 This function is primarily intended for use by programs.  To
3464 get a simple list of names, use C<guestfs_ls>.  To get a printable
3465 directory for human consumption, use C<guestfs_ll>.");
3466
3467   ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson],
3468    [],
3469    "create partitions on a block device",
3470    "\
3471 This is a simplified interface to the C<guestfs_sfdisk>
3472 command, where partition sizes are specified in megabytes
3473 only (rounded to the nearest cylinder) and you don't need
3474 to specify the cyls, heads and sectors parameters which
3475 were rarely if ever used anyway.
3476
3477 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3478 and C<guestfs_part_disk>");
3479
3480   ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3481    [],
3482    "determine file type inside a compressed file",
3483    "\
3484 This command runs C<file> after first decompressing C<path>
3485 using C<method>.
3486
3487 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3488
3489 Since 1.0.63, use C<guestfs_file> instead which can now
3490 process compressed files.");
3491
3492   ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3493    [],
3494    "list extended attributes of a file or directory",
3495    "\
3496 This call lists the extended attributes of the file or directory
3497 C<path>.
3498
3499 At the system call level, this is a combination of the
3500 L<listxattr(2)> and L<getxattr(2)> calls.
3501
3502 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3503
3504   ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3505    [],
3506    "list extended attributes of a file or directory",
3507    "\
3508 This is the same as C<guestfs_getxattrs>, but if C<path>
3509 is a symbolic link, then it returns the extended attributes
3510 of the link itself.");
3511
3512   ("setxattr", (RErr, [String "xattr";
3513                        String "val"; Int "vallen"; (* will be BufferIn *)
3514                        Pathname "path"], []), 143, [Optional "linuxxattrs"],
3515    [],
3516    "set extended attribute of a file or directory",
3517    "\
3518 This call sets the extended attribute named C<xattr>
3519 of the file C<path> to the value C<val> (of length C<vallen>).
3520 The value is arbitrary 8 bit data.
3521
3522 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3523
3524   ("lsetxattr", (RErr, [String "xattr";
3525                         String "val"; Int "vallen"; (* will be BufferIn *)
3526                         Pathname "path"], []), 144, [Optional "linuxxattrs"],
3527    [],
3528    "set extended attribute of a file or directory",
3529    "\
3530 This is the same as C<guestfs_setxattr>, but if C<path>
3531 is a symbolic link, then it sets an extended attribute
3532 of the link itself.");
3533
3534   ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3535    [],
3536    "remove extended attribute of a file or directory",
3537    "\
3538 This call removes the extended attribute named C<xattr>
3539 of the file C<path>.
3540
3541 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3542
3543   ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3544    [],
3545    "remove extended attribute of a file or directory",
3546    "\
3547 This is the same as C<guestfs_removexattr>, but if C<path>
3548 is a symbolic link, then it removes an extended attribute
3549 of the link itself.");
3550
3551   ("mountpoints", (RHashtable "mps", [], []), 147, [],
3552    [],
3553    "show mountpoints",
3554    "\
3555 This call is similar to C<guestfs_mounts>.  That call returns
3556 a list of devices.  This one returns a hash table (map) of
3557 device name to directory where the device is mounted.");
3558
3559   ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3560    (* This is a special case: while you would expect a parameter
3561     * of type "Pathname", that doesn't work, because it implies
3562     * NEED_ROOT in the generated calling code in stubs.c, and
3563     * this function cannot use NEED_ROOT.
3564     *)
3565    [],
3566    "create a mountpoint",
3567    "\
3568 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3569 specialized calls that can be used to create extra mountpoints
3570 before mounting the first filesystem.
3571
3572 These calls are I<only> necessary in some very limited circumstances,
3573 mainly the case where you want to mount a mix of unrelated and/or
3574 read-only filesystems together.
3575
3576 For example, live CDs often contain a \"Russian doll\" nest of
3577 filesystems, an ISO outer layer, with a squashfs image inside, with
3578 an ext2/3 image inside that.  You can unpack this as follows
3579 in guestfish:
3580
3581  add-ro Fedora-11-i686-Live.iso
3582  run
3583  mkmountpoint /cd
3584  mkmountpoint /sqsh
3585  mkmountpoint /ext3fs
3586  mount /dev/sda /cd
3587  mount-loop /cd/LiveOS/squashfs.img /sqsh
3588  mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3589
3590 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3591
3592 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3593 You may get unexpected errors if you try to mix these calls.  It is
3594 safest to manually unmount filesystems and remove mountpoints after use.
3595
3596 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3597 longest first, so for this to work for manual mountpoints, you
3598 must ensure that the innermost mountpoints have the longest
3599 pathnames, as in the example code above.
3600
3601 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3602
3603 Autosync [see C<guestfs_set_autosync>, this is set by default on
3604 handles] means that C<guestfs_umount_all> is called when the handle
3605 is closed which can also trigger these issues.");
3606
3607   ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
3608    [],
3609    "remove a mountpoint",
3610    "\
3611 This calls removes a mountpoint that was previously created
3612 with C<guestfs_mkmountpoint>.  See C<guestfs_mkmountpoint>
3613 for full details.");
3614
3615   ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
3616    [InitISOFS, Always, TestOutputBuffer (
3617       [["read_file"; "/known-4"]], "abc\ndef\nghi");
3618     (* Test various near large, large and too large files (RHBZ#589039). *)
3619     InitBasicFS, Always, TestLastFail (
3620       [["touch"; "/a"];
3621        ["truncate_size"; "/a"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3622        ["read_file"; "/a"]]);
3623     InitBasicFS, Always, TestLastFail (
3624       [["touch"; "/a"];
3625        ["truncate_size"; "/a"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3626        ["read_file"; "/a"]]);
3627     InitBasicFS, Always, TestLastFail (
3628       [["touch"; "/a"];
3629        ["truncate_size"; "/a"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3630        ["read_file"; "/a"]])],
3631    "read a file",
3632    "\
3633 This calls returns the contents of the file C<path> as a
3634 buffer.
3635
3636 Unlike C<guestfs_cat>, this function can correctly
3637 handle files that contain embedded ASCII NUL characters.
3638 However unlike C<guestfs_download>, this function is limited
3639 in the total size of file that can be handled.");
3640
3641   ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
3642    [InitISOFS, Always, TestOutputList (
3643       [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3644     InitISOFS, Always, TestOutputList (
3645       [["grep"; "nomatch"; "/test-grep.txt"]], []);
3646     (* Test for RHBZ#579608, absolute symbolic links. *)
3647     InitISOFS, Always, TestOutputList (
3648       [["grep"; "nomatch"; "/abssymlink"]], [])],
3649    "return lines matching a pattern",
3650    "\
3651 This calls the external C<grep> program and returns the
3652 matching lines.");
3653
3654   ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
3655    [InitISOFS, Always, TestOutputList (
3656       [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3657    "return lines matching a pattern",
3658    "\
3659 This calls the external C<egrep> program and returns the
3660 matching lines.");
3661
3662   ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
3663    [InitISOFS, Always, TestOutputList (
3664       [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3665    "return lines matching a pattern",
3666    "\
3667 This calls the external C<fgrep> program and returns the
3668 matching lines.");
3669
3670   ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
3671    [InitISOFS, Always, TestOutputList (
3672       [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3673    "return lines matching a pattern",
3674    "\
3675 This calls the external C<grep -i> program and returns the
3676 matching lines.");
3677
3678   ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
3679    [InitISOFS, Always, TestOutputList (
3680       [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3681    "return lines matching a pattern",
3682    "\
3683 This calls the external C<egrep -i> program and returns the
3684 matching lines.");
3685
3686   ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
3687    [InitISOFS, Always, TestOutputList (
3688       [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3689    "return lines matching a pattern",
3690    "\
3691 This calls the external C<fgrep -i> program and returns the
3692 matching lines.");
3693
3694   ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
3695    [InitISOFS, Always, TestOutputList (
3696       [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3697    "return lines matching a pattern",
3698    "\
3699 This calls the external C<zgrep> program and returns the
3700 matching lines.");
3701
3702   ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
3703    [InitISOFS, Always, TestOutputList (
3704       [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3705    "return lines matching a pattern",
3706    "\
3707 This calls the external C<zegrep> program and returns the
3708 matching lines.");
3709
3710   ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
3711    [InitISOFS, Always, TestOutputList (
3712       [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3713    "return lines matching a pattern",
3714    "\
3715 This calls the external C<zfgrep> program and returns the
3716 matching lines.");
3717
3718   ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
3719    [InitISOFS, Always, TestOutputList (
3720       [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3721    "return lines matching a pattern",
3722    "\
3723 This calls the external C<zgrep -i> program and returns the
3724 matching lines.");
3725
3726   ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
3727    [InitISOFS, Always, TestOutputList (
3728       [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3729    "return lines matching a pattern",
3730    "\
3731 This calls the external C<zegrep -i> program and returns the
3732 matching lines.");
3733
3734   ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
3735    [InitISOFS, Always, TestOutputList (
3736       [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3737    "return lines matching a pattern",
3738    "\
3739 This calls the external C<zfgrep -i> program and returns the
3740 matching lines.");
3741
3742   ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
3743    [InitISOFS, Always, TestOutput (
3744       [["realpath"; "/../directory"]], "/directory")],
3745    "canonicalized absolute pathname",
3746    "\
3747 Return the canonicalized absolute pathname of C<path>.  The
3748 returned path has no C<.>, C<..> or symbolic link path elements.");
3749
3750   ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
3751    [InitBasicFS, Always, TestOutputStruct (
3752       [["touch"; "/a"];
3753        ["ln"; "/a"; "/b"];
3754        ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3755    "create a hard link",
3756    "\
3757 This command creates a hard link using the C<ln> command.");
3758
3759   ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
3760    [InitBasicFS, Always, TestOutputStruct (
3761       [["touch"; "/a"];
3762        ["touch"; "/b"];
3763        ["ln_f"; "/a"; "/b"];
3764        ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3765    "create a hard link",
3766    "\
3767 This command creates a hard link using the C<ln -f> command.
3768 The C<-f> option removes the link (C<linkname>) if it exists already.");
3769
3770   ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
3771    [InitBasicFS, Always, TestOutputStruct (
3772       [["touch"; "/a"];
3773        ["ln_s"; "a"; "/b"];
3774        ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3775    "create a symbolic link",
3776    "\
3777 This command creates a symbolic link using the C<ln -s> command.");
3778
3779   ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
3780    [InitBasicFS, Always, TestOutput (
3781       [["mkdir_p"; "/a/b"];
3782        ["touch"; "/a/b/c"];
3783        ["ln_sf"; "../d"; "/a/b/c"];
3784        ["readlink"; "/a/b/c"]], "../d")],
3785    "create a symbolic link",
3786    "\
3787 This command creates a symbolic link using the C<ln -sf> command,
3788 The C<-f> option removes the link (C<linkname>) if it exists already.");
3789
3790   ("readlink", (RString "link", [Pathname "path"], []), 168, [],
3791    [] (* XXX tested above *),
3792    "read the target of a symbolic link",
3793    "\
3794 This command reads the target of a symbolic link.");
3795
3796   ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
3797    [InitBasicFS, Always, TestOutputStruct (
3798       [["fallocate"; "/a"; "1000000"];
3799        ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3800    "preallocate a file in the guest filesystem",
3801    "\
3802 This command preallocates a file (containing zero bytes) named
3803 C<path> of size C<len> bytes.  If the file exists already, it
3804 is overwritten.
3805
3806 Do not confuse this with the guestfish-specific
3807 C<alloc> command which allocates a file in the host and
3808 attaches it as a device.");
3809
3810   ("swapon_device", (RErr, [Device "device"], []), 170, [],
3811    [InitPartition, Always, TestRun (
3812       [["mkswap"; "/dev/sda1"];
3813        ["swapon_device"; "/dev/sda1"];
3814        ["swapoff_device"; "/dev/sda1"]])],
3815    "enable swap on device",
3816    "\
3817 This command enables the libguestfs appliance to use the
3818 swap device or partition named C<device>.  The increased
3819 memory is made available for all commands, for example
3820 those run using C<guestfs_command> or C<guestfs_sh>.
3821
3822 Note that you should not swap to existing guest swap
3823 partitions unless you know what you are doing.  They may
3824 contain hibernation information, or other information that
3825 the guest doesn't want you to trash.  You also risk leaking
3826 information about the host to the guest this way.  Instead,
3827 attach a new host device to the guest and swap on that.");
3828
3829   ("swapoff_device", (RErr, [Device "device"], []), 171, [],
3830    [], (* XXX tested by swapon_device *)
3831    "disable swap on device",
3832    "\
3833 This command disables the libguestfs appliance swap
3834 device or partition named C<device>.
3835 See C<guestfs_swapon_device>.");
3836
3837   ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
3838    [InitBasicFS, Always, TestRun (
3839       [["fallocate"; "/swap"; "8388608"];
3840        ["mkswap_file"; "/swap"];
3841        ["swapon_file"; "/swap"];
3842        ["swapoff_file"; "/swap"]])],
3843    "enable swap on file",
3844    "\
3845 This command enables swap to a file.
3846 See C<guestfs_swapon_device> for other notes.");
3847
3848   ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
3849    [], (* XXX tested by swapon_file *)
3850    "disable swap on file",
3851    "\
3852 This command disables the libguestfs appliance swap on file.");
3853
3854   ("swapon_label", (RErr, [String "label"], []), 174, [],
3855    [InitEmpty, Always, TestRun (
3856       [["part_disk"; "/dev/sdb"; "mbr"];
3857        ["mkswap_L"; "swapit"; "/dev/sdb1"];
3858        ["swapon_label"; "swapit"];
3859        ["swapoff_label"; "swapit"];
3860        ["zero"; "/dev/sdb"];
3861        ["blockdev_rereadpt"; "/dev/sdb"]])],
3862    "enable swap on labeled swap partition",
3863    "\
3864 This command enables swap to a labeled swap partition.
3865 See C<guestfs_swapon_device> for other notes.");
3866
3867   ("swapoff_label", (RErr, [String "label"], []), 175, [],
3868    [], (* XXX tested by swapon_label *)
3869    "disable swap on labeled swap partition",
3870    "\
3871 This command disables the libguestfs appliance swap on
3872 labeled swap partition.");
3873
3874   ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
3875    (let uuid = uuidgen () in
3876     [InitEmpty, Always, TestRun (
3877        [["mkswap_U"; uuid; "/dev/sdb"];
3878         ["swapon_uuid"; uuid];
3879         ["swapoff_uuid"; uuid]])]),
3880    "enable swap on swap partition by UUID",
3881    "\
3882 This command enables swap to a swap partition with the given UUID.
3883 See C<guestfs_swapon_device> for other notes.");
3884
3885   ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
3886    [], (* XXX tested by swapon_uuid *)
3887    "disable swap on swap partition by UUID",
3888    "\
3889 This command disables the libguestfs appliance swap partition
3890 with the given UUID.");
3891
3892   ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
3893    [InitBasicFS, Always, TestRun (
3894       [["fallocate"; "/swap"; "8388608"];
3895        ["mkswap_file"; "/swap"]])],
3896    "create a swap file",
3897    "\
3898 Create a swap file.
3899
3900 This command just writes a swap file signature to an existing
3901 file.  To create the file itself, use something like C<guestfs_fallocate>.");
3902
3903   ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
3904    [InitISOFS, Always, TestRun (
3905       [["inotify_init"; "0"]])],
3906    "create an inotify handle",
3907    "\
3908 This command creates a new inotify handle.
3909 The inotify subsystem can be used to notify events which happen to
3910 objects in the guest filesystem.
3911
3912 C<maxevents> is the maximum number of events which will be
3913 queued up between calls to C<guestfs_inotify_read> or
3914 C<guestfs_inotify_files>.
3915 If this is passed as C<0>, then the kernel (or previously set)
3916 default is used.  For Linux 2.6.29 the default was 16384 events.
3917 Beyond this limit, the kernel throws away events, but records
3918 the fact that it threw them away by setting a flag
3919 C<IN_Q_OVERFLOW> in the returned structure list (see
3920 C<guestfs_inotify_read>).
3921
3922 Before any events are generated, you have to add some
3923 watches to the internal watch list.  See:
3924 C<guestfs_inotify_add_watch>,
3925 C<guestfs_inotify_rm_watch> and
3926 C<guestfs_inotify_watch_all>.
3927
3928 Queued up events should be read periodically by calling
3929 C<guestfs_inotify_read>
3930 (or C<guestfs_inotify_files> which is just a helpful
3931 wrapper around C<guestfs_inotify_read>).  If you don't
3932 read the events out often enough then you risk the internal
3933 queue overflowing.
3934
3935 The handle should be closed after use by calling
3936 C<guestfs_inotify_close>.  This also removes any
3937 watches automatically.
3938
3939 See also L<inotify(7)> for an overview of the inotify interface
3940 as exposed by the Linux kernel, which is roughly what we expose
3941 via libguestfs.  Note that there is one global inotify handle
3942 per libguestfs instance.");
3943
3944   ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
3945    [InitBasicFS, Always, TestOutputList (
3946       [["inotify_init"; "0"];
3947        ["inotify_add_watch"; "/"; "1073741823"];
3948        ["touch"; "/a"];
3949        ["touch"; "/b"];
3950        ["inotify_files"]], ["a"; "b"])],
3951    "add an inotify watch",
3952    "\
3953 Watch C<path> for the events listed in C<mask>.
3954
3955 Note that if C<path> is a directory then events within that
3956 directory are watched, but this does I<not> happen recursively
3957 (in subdirectories).
3958
3959 Note for non-C or non-Linux callers: the inotify events are
3960 defined by the Linux kernel ABI and are listed in
3961 C</usr/include/sys/inotify.h>.");
3962
3963   ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
3964    [],
3965    "remove an inotify watch",
3966    "\
3967 Remove a previously defined inotify watch.
3968 See C<guestfs_inotify_add_watch>.");
3969
3970   ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
3971    [],
3972    "return list of inotify events",
3973    "\
3974 Return the complete queue of events that have happened
3975 since the previous read call.
3976
3977 If no events have happened, this returns an empty list.
3978
3979 I<Note>: In order to make sure that all events have been
3980 read, you must call this function repeatedly until it
3981 returns an empty list.  The reason is that the call will
3982 read events up to the maximum appliance-to-host message
3983 size and leave remaining events in the queue.");
3984
3985   ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
3986    [],
3987    "return list of watched files that had events",
3988    "\
3989 This function is a helpful wrapper around C<guestfs_inotify_read>
3990 which just returns a list of pathnames of objects that were
3991 touched.  The returned pathnames are sorted and deduplicated.");
3992
3993   ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
3994    [],
3995    "close the inotify handle",
3996    "\
3997 This closes the inotify handle which was previously
3998 opened by inotify_init.  It removes all watches, throws
3999 away any pending events, and deallocates all resources.");
4000
4001   ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4002    [],
4003    "set SELinux security context",
4004    "\
4005 This sets the SELinux security context of the daemon
4006 to the string C<context>.
4007
4008 See the documentation about SELINUX in L<guestfs(3)>.");
4009
4010   ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4011    [],
4012    "get SELinux security context",
4013    "\
4014 This gets the SELinux security context of the daemon.
4015
4016 See the documentation about SELINUX in L<guestfs(3)>,
4017 and C<guestfs_setcon>");
4018
4019   ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [],
4020    [InitEmpty, Always, TestOutput (
4021       [["part_disk"; "/dev/sda"; "mbr"];
4022        ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4023        ["mount_options"; ""; "/dev/sda1"; "/"];
4024        ["write"; "/new"; "new file contents"];
4025        ["cat"; "/new"]], "new file contents");
4026     InitEmpty, Always, TestRun (
4027       [["part_disk"; "/dev/sda"; "mbr"];
4028        ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4029     InitEmpty, Always, TestLastFail (
4030       [["part_disk"; "/dev/sda"; "mbr"];
4031        ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4032     InitEmpty, Always, TestLastFail (
4033       [["part_disk"; "/dev/sda"; "mbr"];
4034        ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4035     InitEmpty, IfAvailable "ntfsprogs", TestRun (
4036       [["part_disk"; "/dev/sda"; "mbr"];
4037        ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4038    "make a filesystem with block size",
4039    "\
4040 This call is similar to C<guestfs_mkfs>, but it allows you to
4041 control the block size of the resulting filesystem.  Supported
4042 block sizes depend on the filesystem type, but typically they
4043 are C<1024>, C<2048> or C<4096> only.
4044
4045 For VFAT and NTFS the C<blocksize> parameter is treated as
4046 the requested cluster size.");
4047
4048   ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4049    [InitEmpty, Always, TestOutput (
4050       [["part_init"; "/dev/sda"; "mbr"];
4051        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4052        ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4053        ["mke2journal"; "4096"; "/dev/sda1"];
4054        ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4055        ["mount_options"; ""; "/dev/sda2"; "/"];
4056        ["write"; "/new"; "new file contents"];
4057        ["cat"; "/new"]], "new file contents")],
4058    "make ext2/3/4 external journal",
4059    "\
4060 This creates an ext2 external journal on C<device>.  It is equivalent
4061 to the command:
4062
4063  mke2fs -O journal_dev -b blocksize device");
4064
4065   ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4066    [InitEmpty, Always, TestOutput (
4067       [["part_init"; "/dev/sda"; "mbr"];
4068        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4069        ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4070        ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4071        ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4072        ["mount_options"; ""; "/dev/sda2"; "/"];
4073        ["write"; "/new"; "new file contents"];
4074        ["cat"; "/new"]], "new file contents")],
4075    "make ext2/3/4 external journal with label",
4076    "\
4077 This creates an ext2 external journal on C<device> with label C<label>.");
4078
4079   ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4080    (let uuid = uuidgen () in
4081     [InitEmpty, Always, TestOutput (
4082        [["part_init"; "/dev/sda"; "mbr"];
4083         ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4084         ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4085         ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4086         ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4087         ["mount_options"; ""; "/dev/sda2"; "/"];
4088         ["write"; "/new"; "new file contents"];
4089         ["cat"; "/new"]], "new file contents")]),
4090    "make ext2/3/4 external journal with UUID",
4091    "\
4092 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4093
4094   ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4095    [],
4096    "make ext2/3/4 filesystem with external journal",
4097    "\
4098 This creates an ext2/3/4 filesystem on C<device> with
4099 an external journal on C<journal>.  It is equivalent
4100 to the command:
4101
4102  mke2fs -t fstype -b blocksize -J device=<journal> <device>
4103
4104 See also C<guestfs_mke2journal>.");
4105
4106   ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4107    [],
4108    "make ext2/3/4 filesystem with external journal",
4109    "\
4110 This creates an ext2/3/4 filesystem on C<device> with
4111 an external journal on the journal labeled C<label>.
4112
4113 See also C<guestfs_mke2journal_L>.");
4114
4115   ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4116    [],
4117    "make ext2/3/4 filesystem with external journal",
4118    "\
4119 This creates an ext2/3/4 filesystem on C<device> with
4120 an external journal on the journal with UUID C<uuid>.
4121
4122 See also C<guestfs_mke2journal_U>.");
4123
4124   ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4125    [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4126    "load a kernel module",
4127    "\
4128 This loads a kernel module in the appliance.
4129
4130 The kernel module must have been whitelisted when libguestfs
4131 was built (see C<appliance/kmod.whitelist.in> in the source).");
4132
4133   ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4134    [InitNone, Always, TestOutput (
4135       [["echo_daemon"; "This is a test"]], "This is a test"
4136     )],
4137    "echo arguments back to the client",
4138    "\
4139 This command concatenates the list of C<words> passed with single spaces
4140 between them and returns the resulting string.
4141
4142 You can use this command to test the connection through to the daemon.
4143
4144 See also C<guestfs_ping_daemon>.");
4145
4146   ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4147    [], (* There is a regression test for this. *)
4148    "find all files and directories, returning NUL-separated list",
4149    "\
4150 This command lists out all files and directories, recursively,
4151 starting at C<directory>, placing the resulting list in the
4152 external file called C<files>.
4153
4154 This command works the same way as C<guestfs_find> with the
4155 following exceptions:
4156
4157 =over 4
4158
4159 =item *
4160
4161 The resulting list is written to an external file.
4162
4163 =item *
4164
4165 Items (filenames) in the result are separated
4166 by C<\\0> characters.  See L<find(1)> option I<-print0>.
4167
4168 =item *
4169
4170 This command is not limited in the number of names that it
4171 can return.
4172
4173 =item *
4174
4175 The result list is not sorted.
4176
4177 =back");
4178
4179   ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4180    [InitISOFS, Always, TestOutput (
4181       [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4182     InitISOFS, Always, TestOutput (
4183       [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4184     InitISOFS, Always, TestOutput (
4185       [["case_sensitive_path"; "/Known-1"]], "/known-1");
4186     InitISOFS, Always, TestLastFail (
4187       [["case_sensitive_path"; "/Known-1/"]]);
4188     InitBasicFS, Always, TestOutput (