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