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