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