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