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