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