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