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