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