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