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