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