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