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