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