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