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