Version 1.8.16.
[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 \"freebsd\"
742
743 FreeBSD.
744
745 =item \"unknown\"
746
747 The operating system type could not be determined.
748
749 =back
750
751 Future versions of libguestfs may return other strings here.
752 The caller should be prepared to handle any string.
753
754 Please read L<guestfs(3)/INSPECTION> for more details.");
755
756   ("inspect_get_arch", (RString "arch", [Device "root"], []), -1, [],
757    [],
758    "get architecture of inspected operating system",
759    "\
760 This function should only be called with a root device string
761 as returned by C<guestfs_inspect_os>.
762
763 This returns the architecture of the inspected operating system.
764 The possible return values are listed under
765 C<guestfs_file_architecture>.
766
767 If the architecture could not be determined, then the
768 string C<unknown> is returned.
769
770 Please read L<guestfs(3)/INSPECTION> for more details.");
771
772   ("inspect_get_distro", (RString "distro", [Device "root"], []), -1, [],
773    [],
774    "get distro of inspected operating system",
775    "\
776 This function should only be called with a root device string
777 as returned by C<guestfs_inspect_os>.
778
779 This returns the distro (distribution) of the inspected operating
780 system.
781
782 Currently defined distros are:
783
784 =over 4
785
786 =item \"archlinux\"
787
788 Arch Linux.
789
790 =item \"debian\"
791
792 Debian.
793
794 =item \"fedora\"
795
796 Fedora.
797
798 =item \"gentoo\"
799
800 Gentoo.
801
802 =item \"linuxmint\"
803
804 Linux Mint.
805
806 =item \"mandriva\"
807
808 Mandriva.
809
810 =item \"meego\"
811
812 MeeGo.
813
814 =item \"pardus\"
815
816 Pardus.
817
818 =item \"redhat-based\"
819
820 Some Red Hat-derived distro.
821
822 =item \"rhel\"
823
824 Red Hat Enterprise Linux and some derivatives.
825
826 =item \"ubuntu\"
827
828 Ubuntu.
829
830 =item \"unknown\"
831
832 The distro could not be determined.
833
834 =item \"windows\"
835
836 Windows does not have distributions.  This string is
837 returned if the OS type is Windows.
838
839 =back
840
841 Future versions of libguestfs may return other strings here.
842 The caller should be prepared to handle any string.
843
844 Please read L<guestfs(3)/INSPECTION> for more details.");
845
846   ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
847    [],
848    "get major version of inspected operating system",
849    "\
850 This function should only be called with a root device string
851 as returned by C<guestfs_inspect_os>.
852
853 This returns the major version number of the inspected operating
854 system.
855
856 Windows uses a consistent versioning scheme which is I<not>
857 reflected in the popular public names used by the operating system.
858 Notably the operating system known as \"Windows 7\" is really
859 version 6.1 (ie. major = 6, minor = 1).  You can find out the
860 real versions corresponding to releases of Windows by consulting
861 Wikipedia or MSDN.
862
863 If the version could not be determined, then C<0> is returned.
864
865 Please read L<guestfs(3)/INSPECTION> for more details.");
866
867   ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
868    [],
869    "get minor version of inspected operating system",
870    "\
871 This function should only be called with a root device string
872 as returned by C<guestfs_inspect_os>.
873
874 This returns the minor version number of the inspected operating
875 system.
876
877 If the version could not be determined, then C<0> is returned.
878
879 Please read L<guestfs(3)/INSPECTION> for more details.
880 See also C<guestfs_inspect_get_major_version>.");
881
882   ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
883    [],
884    "get product name of inspected operating system",
885    "\
886 This function should only be called with a root device string
887 as returned by C<guestfs_inspect_os>.
888
889 This returns the product name of the inspected operating
890 system.  The product name is generally some freeform string
891 which can be displayed to the user, but should not be
892 parsed by programs.
893
894 If the product name could not be determined, then the
895 string C<unknown> is returned.
896
897 Please read L<guestfs(3)/INSPECTION> for more details.");
898
899   ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
900    [],
901    "get mountpoints of inspected operating system",
902    "\
903 This function should only be called with a root device string
904 as returned by C<guestfs_inspect_os>.
905
906 This returns a hash of where we think the filesystems
907 associated with this operating system should be mounted.
908 Callers should note that this is at best an educated guess
909 made by reading configuration files such as C</etc/fstab>.
910 I<In particular note> that this may return filesystems
911 which are non-existent or not mountable and callers should
912 be prepared to handle or ignore failures if they try to
913 mount them.
914
915 Each element in the returned hashtable has a key which
916 is the path of the mountpoint (eg. C</boot>) and a value
917 which is the filesystem that would be mounted there
918 (eg. C</dev/sda1>).
919
920 Non-mounted devices such as swap devices are I<not>
921 returned in this list.
922
923 Please read L<guestfs(3)/INSPECTION> for more details.
924 See also C<guestfs_inspect_get_filesystems>.");
925
926   ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
927    [],
928    "get filesystems associated with inspected operating system",
929    "\
930 This function should only be called with a root device string
931 as returned by C<guestfs_inspect_os>.
932
933 This returns a list of all the filesystems that we think
934 are associated with this operating system.  This includes
935 the root filesystem, other ordinary filesystems, and
936 non-mounted devices like swap partitions.
937
938 In the case of a multi-boot virtual machine, it is possible
939 for a filesystem to be shared between operating systems.
940
941 Please read L<guestfs(3)/INSPECTION> for more details.
942 See also C<guestfs_inspect_get_mountpoints>.");
943
944   ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
945    [],
946    "set enable network flag",
947    "\
948 If C<network> is true, then the network is enabled in the
949 libguestfs appliance.  The default is false.
950
951 This affects whether commands are able to access the network
952 (see L<guestfs(3)/RUNNING COMMANDS>).
953
954 You must call this before calling C<guestfs_launch>, otherwise
955 it has no effect.");
956
957   ("get_network", (RBool "network", [], []), -1, [],
958    [],
959    "get enable network flag",
960    "\
961 This returns the enable network flag.");
962
963   ("list_filesystems", (RHashtable "fses", [], []), -1, [],
964    [],
965    "list filesystems",
966    "\
967 This inspection command looks for filesystems on partitions,
968 block devices and logical volumes, returning a list of devices
969 containing filesystems and their type.
970
971 The return value is a hash, where the keys are the devices
972 containing filesystems, and the values are the filesystem types.
973 For example:
974
975  \"/dev/sda1\" => \"ntfs\"
976  \"/dev/sda2\" => \"ext2\"
977  \"/dev/vg_guest/lv_root\" => \"ext4\"
978  \"/dev/vg_guest/lv_swap\" => \"swap\"
979
980 The value can have the special value \"unknown\", meaning the
981 content of the device is undetermined or empty.
982 \"swap\" means a Linux swap partition.
983
984 This command runs other libguestfs commands, which might include
985 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
986 use this soon after launch and only when nothing is mounted.
987
988 Not all of the filesystems returned will be mountable.  In
989 particular, swap partitions are returned in the list.  Also
990 this command does not check that each filesystem
991 found is valid and mountable, and some filesystems might
992 be mountable but require special options.  Filesystems may
993 not all belong to a single logical operating system
994 (use C<guestfs_inspect_os> to look for OSes).");
995
996   ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
997    [],
998    "add an image to examine or modify",
999    "\
1000 This function adds a virtual machine disk image C<filename> to
1001 libguestfs.  The first time you call this function, the disk
1002 appears as C</dev/sda>, the second time as C</dev/sdb>, and
1003 so on.
1004
1005 You don't necessarily need to be root when using libguestfs.  However
1006 you obviously do need sufficient permissions to access the filename
1007 for whatever operations you want to perform (ie. read access if you
1008 just want to read the image or write access if you want to modify the
1009 image).
1010
1011 This call checks that C<filename> exists.
1012
1013 The optional arguments are:
1014
1015 =over 4
1016
1017 =item C<readonly>
1018
1019 If true then the image is treated as read-only.  Writes are still
1020 allowed, but they are stored in a temporary snapshot overlay which
1021 is discarded at the end.  The disk that you add is not modified.
1022
1023 =item C<format>
1024
1025 This forces the image format.  If you omit this (or use C<guestfs_add_drive>
1026 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1027 Possible formats include C<raw> and C<qcow2>.
1028
1029 Automatic detection of the format opens you up to a potential
1030 security hole when dealing with untrusted raw-format images.
1031 See CVE-2010-3851 and RHBZ#642934.  Specifying the format closes
1032 this security hole.
1033
1034 =item C<iface>
1035
1036 This rarely-used option lets you emulate the behaviour of the
1037 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1038
1039 =back");
1040
1041   ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1042    [],
1043    "get Windows systemroot of inspected operating system",
1044    "\
1045 This function should only be called with a root device string
1046 as returned by C<guestfs_inspect_os>.
1047
1048 This returns the Windows systemroot of the inspected guest.
1049 The systemroot is a directory path such as C</WINDOWS>.
1050
1051 This call assumes that the guest is Windows and that the
1052 systemroot could be determined by inspection.  If this is not
1053 the case then an error is returned.
1054
1055 Please read L<guestfs(3)/INSPECTION> for more details.");
1056
1057   ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1058    [],
1059    "return list of operating systems found by last inspection",
1060    "\
1061 This function is a convenient way to get the list of root
1062 devices, as returned from a previous call to C<guestfs_inspect_os>,
1063 but without redoing the whole inspection process.
1064
1065 This returns an empty list if either no root devices were
1066 found or the caller has not called C<guestfs_inspect_os>.
1067
1068 Please read L<guestfs(3)/INSPECTION> for more details.");
1069
1070   ("debug_cmdline", (RStringList "cmdline", [], []), -1, [NotInDocs],
1071    [],
1072    "debug the QEMU command line (internal use only)",
1073    "\
1074 This returns the internal QEMU command line.  'debug' commands are
1075 not part of the formal API and can be removed or changed at any time.");
1076
1077   ("add_domain", (RInt "nrdisks", [String "dom"], [String "libvirturi"; Bool "readonly"; String "iface"]), -1, [FishAlias "domain"],
1078    [],
1079    "add the disk(s) from a named libvirt domain",
1080    "\
1081 This function adds the disk(s) attached to the named libvirt
1082 domain C<dom>.  It works by connecting to libvirt, requesting
1083 the domain and domain XML from libvirt, parsing it for disks,
1084 and calling C<guestfs_add_drive_opts> on each one.
1085
1086 The number of disks added is returned.  This operation is atomic:
1087 if an error is returned, then no disks are added.
1088
1089 This function does some minimal checks to make sure the libvirt
1090 domain is not running (unless C<readonly> is true).  In a future
1091 version we will try to acquire the libvirt lock on each disk.
1092
1093 Disks must be accessible locally.  This often means that adding disks
1094 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1095 will fail unless those disks are accessible via the same device path
1096 locally too.
1097
1098 The optional C<libvirturi> parameter sets the libvirt URI
1099 (see L<http://libvirt.org/uri.html>).  If this is not set then
1100 we connect to the default libvirt URI (or one set through an
1101 environment variable, see the libvirt documentation for full
1102 details).
1103
1104 The other optional parameters are passed directly through to
1105 C<guestfs_add_drive_opts>.");
1106
1107 (*
1108 This interface is not quite baked yet. -- RWMJ 2010-11-11
1109   ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"]), -1, [NotInFish],
1110    [],
1111    "add the disk(s) from a libvirt domain",
1112    "\
1113 This function adds the disk(s) attached to the libvirt domain C<dom>.
1114 It works by requesting the domain XML from libvirt, parsing it for
1115 disks, and calling C<guestfs_add_drive_opts> on each one.
1116
1117 In the C API we declare C<void *dom>, but really it has type
1118 C<virDomainPtr dom>.  This is so we don't need E<lt>libvirt.hE<gt>.
1119
1120 The number of disks added is returned.  This operation is atomic:
1121 if an error is returned, then no disks are added.
1122
1123 This function does some minimal checks to make sure the libvirt
1124 domain is not running (unless C<readonly> is true).  In a future
1125 version we will try to acquire the libvirt lock on each disk.
1126
1127 Disks must be accessible locally.  This often means that adding disks
1128 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1129 will fail unless those disks are accessible via the same device path
1130 locally too.
1131
1132 The optional parameters are passed directly through to
1133 C<guestfs_add_drive_opts>.");
1134 *)
1135
1136   ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1137    [],
1138    "get package format used by the operating system",
1139    "\
1140 This function should only be called with a root device string
1141 as returned by C<guestfs_inspect_os>.
1142
1143 This function and C<guestfs_inspect_get_package_management> return
1144 the package format and package management tool used by the
1145 inspected operating system.  For example for Fedora these
1146 functions would return C<rpm> (package format) and
1147 C<yum> (package management).
1148
1149 This returns the string C<unknown> if we could not determine the
1150 package format I<or> if the operating system does not have
1151 a real packaging system (eg. Windows).
1152
1153 Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>.
1154 Future versions of libguestfs may return other strings.
1155
1156 Please read L<guestfs(3)/INSPECTION> for more details.");
1157
1158   ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1159    [],
1160    "get package management tool used by the operating system",
1161    "\
1162 This function should only be called with a root device string
1163 as returned by C<guestfs_inspect_os>.
1164
1165 C<guestfs_inspect_get_package_format> and this function return
1166 the package format and package management tool used by the
1167 inspected operating system.  For example for Fedora these
1168 functions would return C<rpm> (package format) and
1169 C<yum> (package management).
1170
1171 This returns the string C<unknown> if we could not determine the
1172 package management tool I<or> if the operating system does not have
1173 a real packaging system (eg. Windows).
1174
1175 Possible strings include: C<yum>, C<up2date>,
1176 C<apt> (for all Debian derivatives),
1177 C<portage>, C<pisi>, C<pacman>, C<urpmi>.
1178 Future versions of libguestfs may return other strings.
1179
1180 Please read L<guestfs(3)/INSPECTION> for more details.");
1181
1182   ("inspect_list_applications", (RStructList ("applications", "application"), [Device "root"], []), -1, [],
1183    [],
1184    "get list of applications installed in the operating system",
1185    "\
1186 This function should only be called with a root device string
1187 as returned by C<guestfs_inspect_os>.
1188
1189 Return the list of applications installed in the operating system.
1190
1191 I<Note:> This call works differently from other parts of the
1192 inspection API.  You have to call C<guestfs_inspect_os>, then
1193 C<guestfs_inspect_get_mountpoints>, then mount up the disks,
1194 before calling this.  Listing applications is a significantly
1195 more difficult operation which requires access to the full
1196 filesystem.  Also note that unlike the other
1197 C<guestfs_inspect_get_*> calls which are just returning
1198 data cached in the libguestfs handle, this call actually reads
1199 parts of the mounted filesystems during the call.
1200
1201 This returns an empty list if the inspection code was not able
1202 to determine the list of applications.
1203
1204 The application structure contains the following fields:
1205
1206 =over 4
1207
1208 =item C<app_name>
1209
1210 The name of the application.  For Red Hat-derived and Debian-derived
1211 Linux guests, this is the package name.
1212
1213 =item C<app_display_name>
1214
1215 The display name of the application, sometimes localized to the
1216 install language of the guest operating system.
1217
1218 If unavailable this is returned as an empty string C<\"\">.
1219 Callers needing to display something can use C<app_name> instead.
1220
1221 =item C<app_epoch>
1222
1223 For package managers which use epochs, this contains the epoch of
1224 the package (an integer).  If unavailable, this is returned as C<0>.
1225
1226 =item C<app_version>
1227
1228 The version string of the application or package.  If unavailable
1229 this is returned as an empty string C<\"\">.
1230
1231 =item C<app_release>
1232
1233 The release string of the application or package, for package
1234 managers that use this.  If unavailable this is returned as an
1235 empty string C<\"\">.
1236
1237 =item C<app_install_path>
1238
1239 The installation path of the application (on operating systems
1240 such as Windows which use installation paths).  This path is
1241 in the format used by the guest operating system, it is not
1242 a libguestfs path.
1243
1244 If unavailable this is returned as an empty string C<\"\">.
1245
1246 =item C<app_trans_path>
1247
1248 The install path translated into a libguestfs path.
1249 If unavailable this is returned as an empty string C<\"\">.
1250
1251 =item C<app_publisher>
1252
1253 The name of the publisher of the application, for package
1254 managers that use this.  If unavailable this is returned
1255 as an empty string C<\"\">.
1256
1257 =item C<app_url>
1258
1259 The URL (eg. upstream URL) of the application.
1260 If unavailable this is returned as an empty string C<\"\">.
1261
1262 =item C<app_source_package>
1263
1264 For packaging systems which support this, the name of the source
1265 package.  If unavailable this is returned as an empty string C<\"\">.
1266
1267 =item C<app_summary>
1268
1269 A short (usually one line) description of the application or package.
1270 If unavailable this is returned as an empty string C<\"\">.
1271
1272 =item C<app_description>
1273
1274 A longer description of the application or package.
1275 If unavailable this is returned as an empty string C<\"\">.
1276
1277 =back
1278
1279 Please read L<guestfs(3)/INSPECTION> for more details.");
1280
1281   ("inspect_get_hostname", (RString "hostname", [Device "root"], []), -1, [],
1282    [],
1283    "get hostname of the operating system",
1284    "\
1285 This function should only be called with a root device string
1286 as returned by C<guestfs_inspect_os>.
1287
1288 This function returns the hostname of the operating system
1289 as found by inspection of the guest's configuration files.
1290
1291 If the hostname could not be determined, then the
1292 string C<unknown> is returned.
1293
1294 Please read L<guestfs(3)/INSPECTION> for more details.");
1295
1296 ]
1297
1298 (* daemon_functions are any functions which cause some action
1299  * to take place in the daemon.
1300  *)
1301
1302 let daemon_functions = [
1303   ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1304    [InitEmpty, Always, TestOutput (
1305       [["part_disk"; "/dev/sda"; "mbr"];
1306        ["mkfs"; "ext2"; "/dev/sda1"];
1307        ["mount"; "/dev/sda1"; "/"];
1308        ["write"; "/new"; "new file contents"];
1309        ["cat"; "/new"]], "new file contents")],
1310    "mount a guest disk at a position in the filesystem",
1311    "\
1312 Mount a guest disk at a position in the filesystem.  Block devices
1313 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1314 the guest.  If those block devices contain partitions, they will have
1315 the usual names (eg. C</dev/sda1>).  Also LVM C</dev/VG/LV>-style
1316 names can be used.
1317
1318 The rules are the same as for L<mount(2)>:  A filesystem must
1319 first be mounted on C</> before others can be mounted.  Other
1320 filesystems can only be mounted on directories which already
1321 exist.
1322
1323 The mounted filesystem is writable, if we have sufficient permissions
1324 on the underlying device.
1325
1326 B<Important note:>
1327 When you use this call, the filesystem options C<sync> and C<noatime>
1328 are set implicitly.  This was originally done because we thought it
1329 would improve reliability, but it turns out that I<-o sync> has a
1330 very large negative performance impact and negligible effect on
1331 reliability.  Therefore we recommend that you avoid using
1332 C<guestfs_mount> in any code that needs performance, and instead
1333 use C<guestfs_mount_options> (use an empty string for the first
1334 parameter if you don't want any options).");
1335
1336   ("sync", (RErr, [], []), 2, [],
1337    [ InitEmpty, Always, TestRun [["sync"]]],
1338    "sync disks, writes are flushed through to the disk image",
1339    "\
1340 This syncs the disk, so that any writes are flushed through to the
1341 underlying disk image.
1342
1343 You should always call this if you have modified a disk image, before
1344 closing the handle.");
1345
1346   ("touch", (RErr, [Pathname "path"], []), 3, [],
1347    [InitScratchFS, Always, TestOutputTrue (
1348       [["touch"; "/touch"];
1349        ["exists"; "/touch"]])],
1350    "update file timestamps or create a new file",
1351    "\
1352 Touch acts like the L<touch(1)> command.  It can be used to
1353 update the timestamps on a file, or, if the file does not exist,
1354 to create a new zero-length file.
1355
1356 This command only works on regular files, and will fail on other
1357 file types such as directories, symbolic links, block special etc.");
1358
1359   ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1360    [InitISOFS, Always, TestOutput (
1361       [["cat"; "/known-2"]], "abcdef\n")],
1362    "list the contents of a file",
1363    "\
1364 Return the contents of the file named C<path>.
1365
1366 Note that this function cannot correctly handle binary files
1367 (specifically, files containing C<\\0> character which is treated
1368 as end of string).  For those you need to use the C<guestfs_read_file>
1369 or C<guestfs_download> functions which have a more complex interface.");
1370
1371   ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1372    [], (* XXX Tricky to test because it depends on the exact format
1373         * of the 'ls -l' command, which changes between F10 and F11.
1374         *)
1375    "list the files in a directory (long format)",
1376    "\
1377 List the files in C<directory> (relative to the root directory,
1378 there is no cwd) in the format of 'ls -la'.
1379
1380 This command is mostly useful for interactive sessions.  It
1381 is I<not> intended that you try to parse the output string.");
1382
1383   ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1384    [InitScratchFS, Always, TestOutputList (
1385       [["mkdir"; "/ls"];
1386        ["touch"; "/ls/new"];
1387        ["touch"; "/ls/newer"];
1388        ["touch"; "/ls/newest"];
1389        ["ls"; "/ls"]], ["new"; "newer"; "newest"])],
1390    "list the files in a directory",
1391    "\
1392 List the files in C<directory> (relative to the root directory,
1393 there is no cwd).  The '.' and '..' entries are not returned, but
1394 hidden files are shown.
1395
1396 This command is mostly useful for interactive sessions.  Programs
1397 should probably use C<guestfs_readdir> instead.");
1398
1399   ("list_devices", (RStringList "devices", [], []), 7, [],
1400    [InitEmpty, Always, TestOutputListOfDevices (
1401       [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1402    "list the block devices",
1403    "\
1404 List all the block devices.
1405
1406 The full block device names are returned, eg. C</dev/sda>.
1407
1408 See also C<guestfs_list_filesystems>.");
1409
1410   ("list_partitions", (RStringList "partitions", [], []), 8, [],
1411    [InitBasicFS, Always, TestOutputListOfDevices (
1412       [["list_partitions"]], ["/dev/sda1"; "/dev/sdb1"]);
1413     InitEmpty, Always, TestOutputListOfDevices (
1414       [["part_init"; "/dev/sda"; "mbr"];
1415        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1416        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1417        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1418        ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"; "/dev/sdb1"])],
1419    "list the partitions",
1420    "\
1421 List all the partitions detected on all block devices.
1422
1423 The full partition device names are returned, eg. C</dev/sda1>
1424
1425 This does not return logical volumes.  For that you will need to
1426 call C<guestfs_lvs>.
1427
1428 See also C<guestfs_list_filesystems>.");
1429
1430   ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1431    [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1432       [["pvs"]], ["/dev/sda1"]);
1433     InitEmpty, Always, TestOutputListOfDevices (
1434       [["part_init"; "/dev/sda"; "mbr"];
1435        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1436        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1437        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1438        ["pvcreate"; "/dev/sda1"];
1439        ["pvcreate"; "/dev/sda2"];
1440        ["pvcreate"; "/dev/sda3"];
1441        ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1442    "list the LVM physical volumes (PVs)",
1443    "\
1444 List all the physical volumes detected.  This is the equivalent
1445 of the L<pvs(8)> command.
1446
1447 This returns a list of just the device names that contain
1448 PVs (eg. C</dev/sda2>).
1449
1450 See also C<guestfs_pvs_full>.");
1451
1452   ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1453    [InitBasicFSonLVM, Always, TestOutputList (
1454       [["vgs"]], ["VG"]);
1455     InitEmpty, Always, TestOutputList (
1456       [["part_init"; "/dev/sda"; "mbr"];
1457        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1458        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1459        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1460        ["pvcreate"; "/dev/sda1"];
1461        ["pvcreate"; "/dev/sda2"];
1462        ["pvcreate"; "/dev/sda3"];
1463        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1464        ["vgcreate"; "VG2"; "/dev/sda3"];
1465        ["vgs"]], ["VG1"; "VG2"])],
1466    "list the LVM volume groups (VGs)",
1467    "\
1468 List all the volumes groups detected.  This is the equivalent
1469 of the L<vgs(8)> command.
1470
1471 This returns a list of just the volume group names that were
1472 detected (eg. C<VolGroup00>).
1473
1474 See also C<guestfs_vgs_full>.");
1475
1476   ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1477    [InitBasicFSonLVM, Always, TestOutputList (
1478       [["lvs"]], ["/dev/VG/LV"]);
1479     InitEmpty, Always, TestOutputList (
1480       [["part_init"; "/dev/sda"; "mbr"];
1481        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1482        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1483        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1484        ["pvcreate"; "/dev/sda1"];
1485        ["pvcreate"; "/dev/sda2"];
1486        ["pvcreate"; "/dev/sda3"];
1487        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1488        ["vgcreate"; "VG2"; "/dev/sda3"];
1489        ["lvcreate"; "LV1"; "VG1"; "50"];
1490        ["lvcreate"; "LV2"; "VG1"; "50"];
1491        ["lvcreate"; "LV3"; "VG2"; "50"];
1492        ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1493    "list the LVM logical volumes (LVs)",
1494    "\
1495 List all the logical volumes detected.  This is the equivalent
1496 of the L<lvs(8)> command.
1497
1498 This returns a list of the logical volume device names
1499 (eg. C</dev/VolGroup00/LogVol00>).
1500
1501 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1502
1503   ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1504    [], (* XXX how to test? *)
1505    "list the LVM physical volumes (PVs)",
1506    "\
1507 List all the physical volumes detected.  This is the equivalent
1508 of the L<pvs(8)> command.  The \"full\" version includes all fields.");
1509
1510   ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1511    [], (* XXX how to test? *)
1512    "list the LVM volume groups (VGs)",
1513    "\
1514 List all the volumes groups detected.  This is the equivalent
1515 of the L<vgs(8)> command.  The \"full\" version includes all fields.");
1516
1517   ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1518    [], (* XXX how to test? *)
1519    "list the LVM logical volumes (LVs)",
1520    "\
1521 List all the logical volumes detected.  This is the equivalent
1522 of the L<lvs(8)> command.  The \"full\" version includes all fields.");
1523
1524   ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1525    [InitISOFS, Always, TestOutputList (
1526       [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1527     InitISOFS, Always, TestOutputList (
1528       [["read_lines"; "/empty"]], [])],
1529    "read file as lines",
1530    "\
1531 Return the contents of the file named C<path>.
1532
1533 The file contents are returned as a list of lines.  Trailing
1534 C<LF> and C<CRLF> character sequences are I<not> returned.
1535
1536 Note that this function cannot correctly handle binary files
1537 (specifically, files containing C<\\0> character which is treated
1538 as end of line).  For those you need to use the C<guestfs_read_file>
1539 function which has a more complex interface.");
1540
1541   ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1542    [], (* XXX Augeas code needs tests. *)
1543    "create a new Augeas handle",
1544    "\
1545 Create a new Augeas handle for editing configuration files.
1546 If there was any previous Augeas handle associated with this
1547 guestfs session, then it is closed.
1548
1549 You must call this before using any other C<guestfs_aug_*>
1550 commands.
1551
1552 C<root> is the filesystem root.  C<root> must not be NULL,
1553 use C</> instead.
1554
1555 The flags are the same as the flags defined in
1556 E<lt>augeas.hE<gt>, the logical I<or> of the following
1557 integers:
1558
1559 =over 4
1560
1561 =item C<AUG_SAVE_BACKUP> = 1
1562
1563 Keep the original file with a C<.augsave> extension.
1564
1565 =item C<AUG_SAVE_NEWFILE> = 2
1566
1567 Save changes into a file with extension C<.augnew>, and
1568 do not overwrite original.  Overrides C<AUG_SAVE_BACKUP>.
1569
1570 =item C<AUG_TYPE_CHECK> = 4
1571
1572 Typecheck lenses.
1573
1574 This option is only useful when debugging Augeas lenses.  Use
1575 of this option may require additional memory for the libguestfs
1576 appliance.  You may need to set the C<LIBGUESTFS_MEMSIZE>
1577 environment variable or call C<guestfs_set_memsize>.
1578
1579 =item C<AUG_NO_STDINC> = 8
1580
1581 Do not use standard load path for modules.
1582
1583 =item C<AUG_SAVE_NOOP> = 16
1584
1585 Make save a no-op, just record what would have been changed.
1586
1587 =item C<AUG_NO_LOAD> = 32
1588
1589 Do not load the tree in C<guestfs_aug_init>.
1590
1591 =back
1592
1593 To close the handle, you can call C<guestfs_aug_close>.
1594
1595 To find out more about Augeas, see L<http://augeas.net/>.");
1596
1597   ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1598    [], (* XXX Augeas code needs tests. *)
1599    "close the current Augeas handle",
1600    "\
1601 Close the current Augeas handle and free up any resources
1602 used by it.  After calling this, you have to call
1603 C<guestfs_aug_init> again before you can use any other
1604 Augeas functions.");
1605
1606   ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1607    [], (* XXX Augeas code needs tests. *)
1608    "define an Augeas variable",
1609    "\
1610 Defines an Augeas variable C<name> whose value is the result
1611 of evaluating C<expr>.  If C<expr> is NULL, then C<name> is
1612 undefined.
1613
1614 On success this returns the number of nodes in C<expr>, or
1615 C<0> if C<expr> evaluates to something which is not a nodeset.");
1616
1617   ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1618    [], (* XXX Augeas code needs tests. *)
1619    "define an Augeas node",
1620    "\
1621 Defines a variable C<name> whose value is the result of
1622 evaluating C<expr>.
1623
1624 If C<expr> evaluates to an empty nodeset, a node is created,
1625 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1626 C<name> will be the nodeset containing that single node.
1627
1628 On success this returns a pair containing the
1629 number of nodes in the nodeset, and a boolean flag
1630 if a node was created.");
1631
1632   ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1633    [], (* XXX Augeas code needs tests. *)
1634    "look up the value of an Augeas path",
1635    "\
1636 Look up the value associated with C<path>.  If C<path>
1637 matches exactly one node, the C<value> is returned.");
1638
1639   ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1640    [], (* XXX Augeas code needs tests. *)
1641    "set Augeas path to value",
1642    "\
1643 Set the value associated with C<path> to C<val>.
1644
1645 In the Augeas API, it is possible to clear a node by setting
1646 the value to NULL.  Due to an oversight in the libguestfs API
1647 you cannot do that with this call.  Instead you must use the
1648 C<guestfs_aug_clear> call.");
1649
1650   ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1651    [], (* XXX Augeas code needs tests. *)
1652    "insert a sibling Augeas node",
1653    "\
1654 Create a new sibling C<label> for C<path>, inserting it into
1655 the tree before or after C<path> (depending on the boolean
1656 flag C<before>).
1657
1658 C<path> must match exactly one existing node in the tree, and
1659 C<label> must be a label, ie. not contain C</>, C<*> or end
1660 with a bracketed index C<[N]>.");
1661
1662   ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1663    [], (* XXX Augeas code needs tests. *)
1664    "remove an Augeas path",
1665    "\
1666 Remove C<path> and all of its children.
1667
1668 On success this returns the number of entries which were removed.");
1669
1670   ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1671    [], (* XXX Augeas code needs tests. *)
1672    "move Augeas node",
1673    "\
1674 Move the node C<src> to C<dest>.  C<src> must match exactly
1675 one node.  C<dest> is overwritten if it exists.");
1676
1677   ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1678    [], (* XXX Augeas code needs tests. *)
1679    "return Augeas nodes which match augpath",
1680    "\
1681 Returns a list of paths which match the path expression C<path>.
1682 The returned paths are sufficiently qualified so that they match
1683 exactly one node in the current tree.");
1684
1685   ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1686    [], (* XXX Augeas code needs tests. *)
1687    "write all pending Augeas changes to disk",
1688    "\
1689 This writes all pending changes to disk.
1690
1691 The flags which were passed to C<guestfs_aug_init> affect exactly
1692 how files are saved.");
1693
1694   ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1695    [], (* XXX Augeas code needs tests. *)
1696    "load files into the tree",
1697    "\
1698 Load files into the tree.
1699
1700 See C<aug_load> in the Augeas documentation for the full gory
1701 details.");
1702
1703   ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1704    [], (* XXX Augeas code needs tests. *)
1705    "list Augeas nodes under augpath",
1706    "\
1707 This is just a shortcut for listing C<guestfs_aug_match>
1708 C<path/*> and sorting the resulting nodes into alphabetical order.");
1709
1710   ("rm", (RErr, [Pathname "path"], []), 29, [],
1711    [InitScratchFS, Always, TestRun
1712       [["mkdir"; "/rm"];
1713        ["touch"; "/rm/new"];
1714        ["rm"; "/rm/new"]];
1715     InitScratchFS, Always, TestLastFail
1716       [["rm"; "/nosuchfile"]];
1717     InitScratchFS, Always, TestLastFail
1718       [["mkdir"; "/rm2"];
1719        ["rm"; "/rm2"]]],
1720    "remove a file",
1721    "\
1722 Remove the single file C<path>.");
1723
1724   ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1725    [InitScratchFS, Always, TestRun
1726       [["mkdir"; "/rmdir"];
1727        ["rmdir"; "/rmdir"]];
1728     InitScratchFS, Always, TestLastFail
1729       [["rmdir"; "/rmdir2"]];
1730     InitScratchFS, Always, TestLastFail
1731       [["mkdir"; "/rmdir3"];
1732        ["touch"; "/rmdir3/new"];
1733        ["rmdir"; "/rmdir3/new"]]],
1734    "remove a directory",
1735    "\
1736 Remove the single directory C<path>.");
1737
1738   ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1739    [InitScratchFS, Always, TestOutputFalse
1740       [["mkdir"; "/rm_rf"];
1741        ["mkdir"; "/rm_rf/foo"];
1742        ["touch"; "/rm_rf/foo/bar"];
1743        ["rm_rf"; "/rm_rf"];
1744        ["exists"; "/rm_rf"]]],
1745    "remove a file or directory recursively",
1746    "\
1747 Remove the file or directory C<path>, recursively removing the
1748 contents if its a directory.  This is like the C<rm -rf> shell
1749 command.");
1750
1751   ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1752    [InitScratchFS, Always, TestOutputTrue
1753       [["mkdir"; "/mkdir"];
1754        ["is_dir"; "/mkdir"]];
1755     InitScratchFS, Always, TestLastFail
1756       [["mkdir"; "/mkdir2/foo/bar"]]],
1757    "create a directory",
1758    "\
1759 Create a directory named C<path>.");
1760
1761   ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1762    [InitScratchFS, Always, TestOutputTrue
1763       [["mkdir_p"; "/mkdir_p/foo/bar"];
1764        ["is_dir"; "/mkdir_p/foo/bar"]];
1765     InitScratchFS, Always, TestOutputTrue
1766       [["mkdir_p"; "/mkdir_p2/foo/bar"];
1767        ["is_dir"; "/mkdir_p2/foo"]];
1768     InitScratchFS, Always, TestOutputTrue
1769       [["mkdir_p"; "/mkdir_p3/foo/bar"];
1770        ["is_dir"; "/mkdir_p3"]];
1771     (* Regression tests for RHBZ#503133: *)
1772     InitScratchFS, Always, TestRun
1773       [["mkdir"; "/mkdir_p4"];
1774        ["mkdir_p"; "/mkdir_p4"]];
1775     InitScratchFS, Always, TestLastFail
1776       [["touch"; "/mkdir_p5"];
1777        ["mkdir_p"; "/mkdir_p5"]]],
1778    "create a directory and parents",
1779    "\
1780 Create a directory named C<path>, creating any parent directories
1781 as necessary.  This is like the C<mkdir -p> shell command.");
1782
1783   ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
1784    [], (* XXX Need stat command to test *)
1785    "change file mode",
1786    "\
1787 Change the mode (permissions) of C<path> to C<mode>.  Only
1788 numeric modes are supported.
1789
1790 I<Note>: When using this command from guestfish, C<mode>
1791 by default would be decimal, unless you prefix it with
1792 C<0> to get octal, ie. use C<0700> not C<700>.
1793
1794 The mode actually set is affected by the umask.");
1795
1796   ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
1797    [], (* XXX Need stat command to test *)
1798    "change file owner and group",
1799    "\
1800 Change the file owner to C<owner> and group to C<group>.
1801
1802 Only numeric uid and gid are supported.  If you want to use
1803 names, you will need to locate and parse the password file
1804 yourself (Augeas support makes this relatively easy).");
1805
1806   ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
1807    [InitISOFS, Always, TestOutputTrue (
1808       [["exists"; "/empty"]]);
1809     InitISOFS, Always, TestOutputTrue (
1810       [["exists"; "/directory"]])],
1811    "test if file or directory exists",
1812    "\
1813 This returns C<true> if and only if there is a file, directory
1814 (or anything) with the given C<path> name.
1815
1816 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1817
1818   ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
1819    [InitISOFS, Always, TestOutputTrue (
1820       [["is_file"; "/known-1"]]);
1821     InitISOFS, Always, TestOutputFalse (
1822       [["is_file"; "/directory"]])],
1823    "test if a regular file",
1824    "\
1825 This returns C<true> if and only if there is a regular file
1826 with the given C<path> name.  Note that it returns false for
1827 other objects like directories.
1828
1829 See also C<guestfs_stat>.");
1830
1831   ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
1832    [InitISOFS, Always, TestOutputFalse (
1833       [["is_dir"; "/known-3"]]);
1834     InitISOFS, Always, TestOutputTrue (
1835       [["is_dir"; "/directory"]])],
1836    "test if a directory",
1837    "\
1838 This returns C<true> if and only if there is a directory
1839 with the given C<path> name.  Note that it returns false for
1840 other objects like files.
1841
1842 See also C<guestfs_stat>.");
1843
1844   ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
1845    [InitEmpty, Always, TestOutputListOfDevices (
1846       [["part_init"; "/dev/sda"; "mbr"];
1847        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1848        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1849        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1850        ["pvcreate"; "/dev/sda1"];
1851        ["pvcreate"; "/dev/sda2"];
1852        ["pvcreate"; "/dev/sda3"];
1853        ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1854    "create an LVM physical volume",
1855    "\
1856 This creates an LVM physical volume on the named C<device>,
1857 where C<device> should usually be a partition name such
1858 as C</dev/sda1>.");
1859
1860   ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
1861    [InitEmpty, Always, TestOutputList (
1862       [["part_init"; "/dev/sda"; "mbr"];
1863        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1864        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1865        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1866        ["pvcreate"; "/dev/sda1"];
1867        ["pvcreate"; "/dev/sda2"];
1868        ["pvcreate"; "/dev/sda3"];
1869        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1870        ["vgcreate"; "VG2"; "/dev/sda3"];
1871        ["vgs"]], ["VG1"; "VG2"])],
1872    "create an LVM volume group",
1873    "\
1874 This creates an LVM volume group called C<volgroup>
1875 from the non-empty list of physical volumes C<physvols>.");
1876
1877   ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
1878    [InitEmpty, Always, TestOutputList (
1879       [["part_init"; "/dev/sda"; "mbr"];
1880        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1881        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1882        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1883        ["pvcreate"; "/dev/sda1"];
1884        ["pvcreate"; "/dev/sda2"];
1885        ["pvcreate"; "/dev/sda3"];
1886        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1887        ["vgcreate"; "VG2"; "/dev/sda3"];
1888        ["lvcreate"; "LV1"; "VG1"; "50"];
1889        ["lvcreate"; "LV2"; "VG1"; "50"];
1890        ["lvcreate"; "LV3"; "VG2"; "50"];
1891        ["lvcreate"; "LV4"; "VG2"; "50"];
1892        ["lvcreate"; "LV5"; "VG2"; "50"];
1893        ["lvs"]],
1894       ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1895        "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1896    "create an LVM logical volume",
1897    "\
1898 This creates an LVM logical volume called C<logvol>
1899 on the volume group C<volgroup>, with C<size> megabytes.");
1900
1901   ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
1902    [InitEmpty, Always, TestOutput (
1903       [["part_disk"; "/dev/sda"; "mbr"];
1904        ["mkfs"; "ext2"; "/dev/sda1"];
1905        ["mount_options"; ""; "/dev/sda1"; "/"];
1906        ["write"; "/new"; "new file contents"];
1907        ["cat"; "/new"]], "new file contents")],
1908    "make a filesystem",
1909    "\
1910 This creates a filesystem on C<device> (usually a partition
1911 or LVM logical volume).  The filesystem type is C<fstype>, for
1912 example C<ext3>.");
1913
1914   ("sfdisk", (RErr, [Device "device";
1915                      Int "cyls"; Int "heads"; Int "sectors";
1916                      StringList "lines"], []), 43, [DangerWillRobinson],
1917    [],
1918    "create partitions on a block device",
1919    "\
1920 This is a direct interface to the L<sfdisk(8)> program for creating
1921 partitions on block devices.
1922
1923 C<device> should be a block device, for example C</dev/sda>.
1924
1925 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1926 and sectors on the device, which are passed directly to sfdisk as
1927 the I<-C>, I<-H> and I<-S> parameters.  If you pass C<0> for any
1928 of these, then the corresponding parameter is omitted.  Usually for
1929 'large' disks, you can just pass C<0> for these, but for small
1930 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1931 out the right geometry and you will need to tell it.
1932
1933 C<lines> is a list of lines that we feed to C<sfdisk>.  For more
1934 information refer to the L<sfdisk(8)> manpage.
1935
1936 To create a single partition occupying the whole disk, you would
1937 pass C<lines> as a single element list, when the single element being
1938 the string C<,> (comma).
1939
1940 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1941 C<guestfs_part_init>");
1942
1943   ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
1944    (* Regression test for RHBZ#597135. *)
1945    [InitScratchFS, Always, TestLastFail
1946       [["write_file"; "/write_file"; "abc"; "10000"]]],
1947    "create a file",
1948    "\
1949 This call creates a file called C<path>.  The contents of the
1950 file is the string C<content> (which can contain any 8 bit data),
1951 with length C<size>.
1952
1953 As a special case, if C<size> is C<0>
1954 then the length is calculated using C<strlen> (so in this case
1955 the content cannot contain embedded ASCII NULs).
1956
1957 I<NB.> Owing to a bug, writing content containing ASCII NUL
1958 characters does I<not> work, even if the length is specified.");
1959
1960   ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
1961    [InitEmpty, Always, TestOutputListOfDevices (
1962       [["part_disk"; "/dev/sda"; "mbr"];
1963        ["mkfs"; "ext2"; "/dev/sda1"];
1964        ["mount_options"; ""; "/dev/sda1"; "/"];
1965        ["mounts"]], ["/dev/sda1"]);
1966     InitEmpty, Always, TestOutputList (
1967       [["part_disk"; "/dev/sda"; "mbr"];
1968        ["mkfs"; "ext2"; "/dev/sda1"];
1969        ["mount_options"; ""; "/dev/sda1"; "/"];
1970        ["umount"; "/"];
1971        ["mounts"]], [])],
1972    "unmount a filesystem",
1973    "\
1974 This unmounts the given filesystem.  The filesystem may be
1975 specified either by its mountpoint (path) or the device which
1976 contains the filesystem.");
1977
1978   ("mounts", (RStringList "devices", [], []), 46, [],
1979    [InitScratchFS, Always, TestOutputListOfDevices (
1980       [["mounts"]], ["/dev/sdb1"])],
1981    "show mounted filesystems",
1982    "\
1983 This returns the list of currently mounted filesystems.  It returns
1984 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1985
1986 Some internal mounts are not shown.
1987
1988 See also: C<guestfs_mountpoints>");
1989
1990   ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
1991    [InitScratchFS, Always, TestOutputList (
1992       [["umount_all"];
1993        ["mounts"]], []);
1994     (* check that umount_all can unmount nested mounts correctly: *)
1995     InitEmpty, Always, TestOutputList (
1996       [["part_init"; "/dev/sda"; "mbr"];
1997        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1998        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1999        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2000        ["mkfs"; "ext2"; "/dev/sda1"];
2001        ["mkfs"; "ext2"; "/dev/sda2"];
2002        ["mkfs"; "ext2"; "/dev/sda3"];
2003        ["mount_options"; ""; "/dev/sda1"; "/"];
2004        ["mkdir"; "/mp1"];
2005        ["mount_options"; ""; "/dev/sda2"; "/mp1"];
2006        ["mkdir"; "/mp1/mp2"];
2007        ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
2008        ["mkdir"; "/mp1/mp2/mp3"];
2009        ["umount_all"];
2010        ["mounts"]], [])],
2011    "unmount all filesystems",
2012    "\
2013 This unmounts all mounted filesystems.
2014
2015 Some internal mounts are not unmounted by this call.");
2016
2017   ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
2018    [],
2019    "remove all LVM LVs, VGs and PVs",
2020    "\
2021 This command removes all LVM logical volumes, volume groups
2022 and physical volumes.");
2023
2024   ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2025    [InitISOFS, Always, TestOutput (
2026       [["file"; "/empty"]], "empty");
2027     InitISOFS, Always, TestOutput (
2028       [["file"; "/known-1"]], "ASCII text");
2029     InitISOFS, Always, TestLastFail (
2030       [["file"; "/notexists"]]);
2031     InitISOFS, Always, TestOutput (
2032       [["file"; "/abssymlink"]], "symbolic link");
2033     InitISOFS, Always, TestOutput (
2034       [["file"; "/directory"]], "directory")],
2035    "determine file type",
2036    "\
2037 This call uses the standard L<file(1)> command to determine
2038 the type or contents of the file.
2039
2040 This call will also transparently look inside various types
2041 of compressed file.
2042
2043 The exact command which runs is C<file -zb path>.  Note in
2044 particular that the filename is not prepended to the output
2045 (the C<-b> option).
2046
2047 The output depends on the output of the underlying L<file(1)>
2048 command and it can change in future in ways beyond our control.
2049 In other words, the output is not guaranteed by the ABI.
2050
2051 See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>,
2052 C<guestfs_is_file>, C<guestfs_is_blockdev> (etc).");
2053
2054   ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2055    [InitScratchFS, Always, TestOutput (
2056       [["mkdir"; "/command"];
2057        ["upload"; "test-command"; "/command/test-command"];
2058        ["chmod"; "0o755"; "/command/test-command"];
2059        ["command"; "/command/test-command 1"]], "Result1");
2060     InitScratchFS, Always, TestOutput (
2061       [["mkdir"; "/command2"];
2062        ["upload"; "test-command"; "/command2/test-command"];
2063        ["chmod"; "0o755"; "/command2/test-command"];
2064        ["command"; "/command2/test-command 2"]], "Result2\n");
2065     InitScratchFS, Always, TestOutput (
2066       [["mkdir"; "/command3"];
2067        ["upload"; "test-command"; "/command3/test-command"];
2068        ["chmod"; "0o755"; "/command3/test-command"];
2069        ["command"; "/command3/test-command 3"]], "\nResult3");
2070     InitScratchFS, Always, TestOutput (
2071       [["mkdir"; "/command4"];
2072        ["upload"; "test-command"; "/command4/test-command"];
2073        ["chmod"; "0o755"; "/command4/test-command"];
2074        ["command"; "/command4/test-command 4"]], "\nResult4\n");
2075     InitScratchFS, Always, TestOutput (
2076       [["mkdir"; "/command5"];
2077        ["upload"; "test-command"; "/command5/test-command"];
2078        ["chmod"; "0o755"; "/command5/test-command"];
2079        ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2080     InitScratchFS, Always, TestOutput (
2081       [["mkdir"; "/command6"];
2082        ["upload"; "test-command"; "/command6/test-command"];
2083        ["chmod"; "0o755"; "/command6/test-command"];
2084        ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2085     InitScratchFS, Always, TestOutput (
2086       [["mkdir"; "/command7"];
2087        ["upload"; "test-command"; "/command7/test-command"];
2088        ["chmod"; "0o755"; "/command7/test-command"];
2089        ["command"; "/command7/test-command 7"]], "");
2090     InitScratchFS, Always, TestOutput (
2091       [["mkdir"; "/command8"];
2092        ["upload"; "test-command"; "/command8/test-command"];
2093        ["chmod"; "0o755"; "/command8/test-command"];
2094        ["command"; "/command8/test-command 8"]], "\n");
2095     InitScratchFS, Always, TestOutput (
2096       [["mkdir"; "/command9"];
2097        ["upload"; "test-command"; "/command9/test-command"];
2098        ["chmod"; "0o755"; "/command9/test-command"];
2099        ["command"; "/command9/test-command 9"]], "\n\n");
2100     InitScratchFS, Always, TestOutput (
2101       [["mkdir"; "/command10"];
2102        ["upload"; "test-command"; "/command10/test-command"];
2103        ["chmod"; "0o755"; "/command10/test-command"];
2104        ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2105     InitScratchFS, Always, TestOutput (
2106       [["mkdir"; "/command11"];
2107        ["upload"; "test-command"; "/command11/test-command"];
2108        ["chmod"; "0o755"; "/command11/test-command"];
2109        ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2110     InitScratchFS, Always, TestLastFail (
2111       [["mkdir"; "/command12"];
2112        ["upload"; "test-command"; "/command12/test-command"];
2113        ["chmod"; "0o755"; "/command12/test-command"];
2114        ["command"; "/command12/test-command"]])],
2115    "run a command from the guest filesystem",
2116    "\
2117 This call runs a command from the guest filesystem.  The
2118 filesystem must be mounted, and must contain a compatible
2119 operating system (ie. something Linux, with the same
2120 or compatible processor architecture).
2121
2122 The single parameter is an argv-style list of arguments.
2123 The first element is the name of the program to run.
2124 Subsequent elements are parameters.  The list must be
2125 non-empty (ie. must contain a program name).  Note that
2126 the command runs directly, and is I<not> invoked via
2127 the shell (see C<guestfs_sh>).
2128
2129 The return value is anything printed to I<stdout> by
2130 the command.
2131
2132 If the command returns a non-zero exit status, then
2133 this function returns an error message.  The error message
2134 string is the content of I<stderr> from the command.
2135
2136 The C<$PATH> environment variable will contain at least
2137 C</usr/bin> and C</bin>.  If you require a program from
2138 another location, you should provide the full path in the
2139 first parameter.
2140
2141 Shared libraries and data files required by the program
2142 must be available on filesystems which are mounted in the
2143 correct places.  It is the caller's responsibility to ensure
2144 all filesystems that are needed are mounted at the right
2145 locations.");
2146
2147   ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2148    [InitScratchFS, Always, TestOutputList (
2149       [["mkdir"; "/command_lines"];
2150        ["upload"; "test-command"; "/command_lines/test-command"];
2151        ["chmod"; "0o755"; "/command_lines/test-command"];
2152        ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2153     InitScratchFS, Always, TestOutputList (
2154       [["mkdir"; "/command_lines2"];
2155        ["upload"; "test-command"; "/command_lines2/test-command"];
2156        ["chmod"; "0o755"; "/command_lines2/test-command"];
2157        ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2158     InitScratchFS, Always, TestOutputList (
2159       [["mkdir"; "/command_lines3"];
2160        ["upload"; "test-command"; "/command_lines3/test-command"];
2161        ["chmod"; "0o755"; "/command_lines3/test-command"];
2162        ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2163     InitScratchFS, Always, TestOutputList (
2164       [["mkdir"; "/command_lines4"];
2165        ["upload"; "test-command"; "/command_lines4/test-command"];
2166        ["chmod"; "0o755"; "/command_lines4/test-command"];
2167        ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2168     InitScratchFS, Always, TestOutputList (
2169       [["mkdir"; "/command_lines5"];
2170        ["upload"; "test-command"; "/command_lines5/test-command"];
2171        ["chmod"; "0o755"; "/command_lines5/test-command"];
2172        ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2173     InitScratchFS, Always, TestOutputList (
2174       [["mkdir"; "/command_lines6"];
2175        ["upload"; "test-command"; "/command_lines6/test-command"];
2176        ["chmod"; "0o755"; "/command_lines6/test-command"];
2177        ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2178     InitScratchFS, Always, TestOutputList (
2179       [["mkdir"; "/command_lines7"];
2180        ["upload"; "test-command"; "/command_lines7/test-command"];
2181        ["chmod"; "0o755"; "/command_lines7/test-command"];
2182        ["command_lines"; "/command_lines7/test-command 7"]], []);
2183     InitScratchFS, Always, TestOutputList (
2184       [["mkdir"; "/command_lines8"];
2185        ["upload"; "test-command"; "/command_lines8/test-command"];
2186        ["chmod"; "0o755"; "/command_lines8/test-command"];
2187        ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2188     InitScratchFS, Always, TestOutputList (
2189       [["mkdir"; "/command_lines9"];
2190        ["upload"; "test-command"; "/command_lines9/test-command"];
2191        ["chmod"; "0o755"; "/command_lines9/test-command"];
2192        ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2193     InitScratchFS, Always, TestOutputList (
2194       [["mkdir"; "/command_lines10"];
2195        ["upload"; "test-command"; "/command_lines10/test-command"];
2196        ["chmod"; "0o755"; "/command_lines10/test-command"];
2197        ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2198     InitScratchFS, Always, TestOutputList (
2199       [["mkdir"; "/command_lines11"];
2200        ["upload"; "test-command"; "/command_lines11/test-command"];
2201        ["chmod"; "0o755"; "/command_lines11/test-command"];
2202        ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2203    "run a command, returning lines",
2204    "\
2205 This is the same as C<guestfs_command>, but splits the
2206 result into a list of lines.
2207
2208 See also: C<guestfs_sh_lines>");
2209
2210   ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2211    [InitISOFS, Always, TestOutputStruct (
2212       [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2213    "get file information",
2214    "\
2215 Returns file information for the given C<path>.
2216
2217 This is the same as the C<stat(2)> system call.");
2218
2219   ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2220    [InitISOFS, Always, TestOutputStruct (
2221       [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2222    "get file information for a symbolic link",
2223    "\
2224 Returns file information for the given C<path>.
2225
2226 This is the same as C<guestfs_stat> except that if C<path>
2227 is a symbolic link, then the link is stat-ed, not the file it
2228 refers to.
2229
2230 This is the same as the C<lstat(2)> system call.");
2231
2232   ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2233    [InitISOFS, Always, TestOutputStruct (
2234       [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2235    "get file system statistics",
2236    "\
2237 Returns file system statistics for any mounted file system.
2238 C<path> should be a file or directory in the mounted file system
2239 (typically it is the mount point itself, but it doesn't need to be).
2240
2241 This is the same as the C<statvfs(2)> system call.");
2242
2243   ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2244    [], (* XXX test *)
2245    "get ext2/ext3/ext4 superblock details",
2246    "\
2247 This returns the contents of the ext2, ext3 or ext4 filesystem
2248 superblock on C<device>.
2249
2250 It is the same as running C<tune2fs -l device>.  See L<tune2fs(8)>
2251 manpage for more details.  The list of fields returned isn't
2252 clearly defined, and depends on both the version of C<tune2fs>
2253 that libguestfs was built against, and the filesystem itself.");
2254
2255   ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2256    [InitEmpty, Always, TestOutputTrue (
2257       [["blockdev_setro"; "/dev/sda"];
2258        ["blockdev_getro"; "/dev/sda"]])],
2259    "set block device to read-only",
2260    "\
2261 Sets the block device named C<device> to read-only.
2262
2263 This uses the L<blockdev(8)> command.");
2264
2265   ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2266    [InitEmpty, Always, TestOutputFalse (
2267       [["blockdev_setrw"; "/dev/sda"];
2268        ["blockdev_getro"; "/dev/sda"]])],
2269    "set block device to read-write",
2270    "\
2271 Sets the block device named C<device> to read-write.
2272
2273 This uses the L<blockdev(8)> command.");
2274
2275   ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2276    [InitEmpty, Always, TestOutputTrue (
2277       [["blockdev_setro"; "/dev/sda"];
2278        ["blockdev_getro"; "/dev/sda"]])],
2279    "is block device set to read-only",
2280    "\
2281 Returns a boolean indicating if the block device is read-only
2282 (true if read-only, false if not).
2283
2284 This uses the L<blockdev(8)> command.");
2285
2286   ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2287    [InitEmpty, Always, TestOutputInt (
2288       [["blockdev_getss"; "/dev/sda"]], 512)],
2289    "get sectorsize of block device",
2290    "\
2291 This returns the size of sectors on a block device.
2292 Usually 512, but can be larger for modern devices.
2293
2294 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2295 for that).
2296
2297 This uses the L<blockdev(8)> command.");
2298
2299   ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2300    [InitEmpty, Always, TestOutputInt (
2301       [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2302    "get blocksize of block device",
2303    "\
2304 This returns the block size of a device.
2305
2306 (Note this is different from both I<size in blocks> and
2307 I<filesystem block size>).
2308
2309 This uses the L<blockdev(8)> command.");
2310
2311   ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2312    [], (* XXX test *)
2313    "set blocksize of block device",
2314    "\
2315 This sets the block size of a device.
2316
2317 (Note this is different from both I<size in blocks> and
2318 I<filesystem block size>).
2319
2320 This uses the L<blockdev(8)> command.");
2321
2322   ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2323    [InitEmpty, Always, TestOutputInt (
2324       [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2325    "get total size of device in 512-byte sectors",
2326    "\
2327 This returns the size of the device in units of 512-byte sectors
2328 (even if the sectorsize isn't 512 bytes ... weird).
2329
2330 See also C<guestfs_blockdev_getss> for the real sector size of
2331 the device, and C<guestfs_blockdev_getsize64> for the more
2332 useful I<size in bytes>.
2333
2334 This uses the L<blockdev(8)> command.");
2335
2336   ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2337    [InitEmpty, Always, TestOutputInt (
2338       [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2339    "get total size of device in bytes",
2340    "\
2341 This returns the size of the device in bytes.
2342
2343 See also C<guestfs_blockdev_getsz>.
2344
2345 This uses the L<blockdev(8)> command.");
2346
2347   ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2348    [InitEmpty, Always, TestRun
2349       [["blockdev_flushbufs"; "/dev/sda"]]],
2350    "flush device buffers",
2351    "\
2352 This tells the kernel to flush internal buffers associated
2353 with C<device>.
2354
2355 This uses the L<blockdev(8)> command.");
2356
2357   ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2358    [InitEmpty, Always, TestRun
2359       [["blockdev_rereadpt"; "/dev/sda"]]],
2360    "reread partition table",
2361    "\
2362 Reread the partition table on C<device>.
2363
2364 This uses the L<blockdev(8)> command.");
2365
2366   ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2367    [InitScratchFS, Always, TestOutput (
2368       (* Pick a file from cwd which isn't likely to change. *)
2369       [["mkdir"; "/upload"];
2370        ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2371        ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2372       Digest.to_hex (Digest.file "COPYING.LIB"))],
2373    "upload a file from the local machine",
2374    "\
2375 Upload local file C<filename> to C<remotefilename> on the
2376 filesystem.
2377
2378 C<filename> can also be a named pipe.
2379
2380 See also C<guestfs_download>.");
2381
2382   ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2383    [InitScratchFS, Always, TestOutput (
2384       (* Pick a file from cwd which isn't likely to change. *)
2385       [["mkdir"; "/download"];
2386        ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2387        ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2388        ["upload"; "testdownload.tmp"; "/download/upload"];
2389        ["checksum"; "md5"; "/download/upload"]],
2390       Digest.to_hex (Digest.file "COPYING.LIB"))],
2391    "download a file to the local machine",
2392    "\
2393 Download file C<remotefilename> and save it as C<filename>
2394 on the local machine.
2395
2396 C<filename> can also be a named pipe.
2397
2398 See also C<guestfs_upload>, C<guestfs_cat>.");
2399
2400   ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2401    [InitISOFS, Always, TestOutput (
2402       [["checksum"; "crc"; "/known-3"]], "2891671662");
2403     InitISOFS, Always, TestLastFail (
2404       [["checksum"; "crc"; "/notexists"]]);
2405     InitISOFS, Always, TestOutput (
2406       [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2407     InitISOFS, Always, TestOutput (
2408       [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2409     InitISOFS, Always, TestOutput (
2410       [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2411     InitISOFS, Always, TestOutput (
2412       [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2413     InitISOFS, Always, TestOutput (
2414       [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2415     InitISOFS, Always, TestOutput (
2416       [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2417     (* Test for RHBZ#579608, absolute symbolic links. *)
2418     InitISOFS, Always, TestOutput (
2419       [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2420    "compute MD5, SHAx or CRC checksum of file",
2421    "\
2422 This call computes the MD5, SHAx or CRC checksum of the
2423 file named C<path>.
2424
2425 The type of checksum to compute is given by the C<csumtype>
2426 parameter which must have one of the following values:
2427
2428 =over 4
2429
2430 =item C<crc>
2431
2432 Compute the cyclic redundancy check (CRC) specified by POSIX
2433 for the C<cksum> command.
2434
2435 =item C<md5>
2436
2437 Compute the MD5 hash (using the C<md5sum> program).
2438
2439 =item C<sha1>
2440
2441 Compute the SHA1 hash (using the C<sha1sum> program).
2442
2443 =item C<sha224>
2444
2445 Compute the SHA224 hash (using the C<sha224sum> program).
2446
2447 =item C<sha256>
2448
2449 Compute the SHA256 hash (using the C<sha256sum> program).
2450
2451 =item C<sha384>
2452
2453 Compute the SHA384 hash (using the C<sha384sum> program).
2454
2455 =item C<sha512>
2456
2457 Compute the SHA512 hash (using the C<sha512sum> program).
2458
2459 =back
2460
2461 The checksum is returned as a printable string.
2462
2463 To get the checksum for a device, use C<guestfs_checksum_device>.
2464
2465 To get the checksums for many files, use C<guestfs_checksums_out>.");
2466
2467   ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2468    [InitScratchFS, Always, TestOutput (
2469       [["mkdir"; "/tar_in"];
2470        ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2471        ["cat"; "/tar_in/hello"]], "hello\n")],
2472    "unpack tarfile to directory",
2473    "\
2474 This command uploads and unpacks local file C<tarfile> (an
2475 I<uncompressed> tar file) into C<directory>.
2476
2477 To upload a compressed tarball, use C<guestfs_tgz_in>
2478 or C<guestfs_txz_in>.");
2479
2480   ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2481    [],
2482    "pack directory into tarfile",
2483    "\
2484 This command packs the contents of C<directory> and downloads
2485 it to local file C<tarfile>.
2486
2487 To download a compressed tarball, use C<guestfs_tgz_out>
2488 or C<guestfs_txz_out>.");
2489
2490   ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2491    [InitScratchFS, Always, TestOutput (
2492       [["mkdir"; "/tgz_in"];
2493        ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2494        ["cat"; "/tgz_in/hello"]], "hello\n")],
2495    "unpack compressed tarball to directory",
2496    "\
2497 This command uploads and unpacks local file C<tarball> (a
2498 I<gzip compressed> tar file) into C<directory>.
2499
2500 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2501
2502   ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2503    [],
2504    "pack directory into compressed tarball",
2505    "\
2506 This command packs the contents of C<directory> and downloads
2507 it to local file C<tarball>.
2508
2509 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2510
2511   ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2512    [InitBasicFS, Always, TestLastFail (
2513       [["umount"; "/"];
2514        ["mount_ro"; "/dev/sda1"; "/"];
2515        ["touch"; "/new"]]);
2516     InitBasicFS, Always, TestOutput (
2517       [["write"; "/new"; "data"];
2518        ["umount"; "/"];
2519        ["mount_ro"; "/dev/sda1"; "/"];
2520        ["cat"; "/new"]], "data")],
2521    "mount a guest disk, read-only",
2522    "\
2523 This is the same as the C<guestfs_mount> command, but it
2524 mounts the filesystem with the read-only (I<-o ro>) flag.");
2525
2526   ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2527    [],
2528    "mount a guest disk with mount options",
2529    "\
2530 This is the same as the C<guestfs_mount> command, but it
2531 allows you to set the mount options as for the
2532 L<mount(8)> I<-o> flag.
2533
2534 If the C<options> parameter is an empty string, then
2535 no options are passed (all options default to whatever
2536 the filesystem uses).");
2537
2538   ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2539    [],
2540    "mount a guest disk with mount options and vfstype",
2541    "\
2542 This is the same as the C<guestfs_mount> command, but it
2543 allows you to set both the mount options and the vfstype
2544 as for the L<mount(8)> I<-o> and I<-t> flags.");
2545
2546   ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2547    [],
2548    "debugging and internals",
2549    "\
2550 The C<guestfs_debug> command exposes some internals of
2551 C<guestfsd> (the guestfs daemon) that runs inside the
2552 qemu subprocess.
2553
2554 There is no comprehensive help for this command.  You have
2555 to look at the file C<daemon/debug.c> in the libguestfs source
2556 to find out what you can do.");
2557
2558   ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2559    [InitEmpty, Always, TestOutputList (
2560       [["part_disk"; "/dev/sda"; "mbr"];
2561        ["pvcreate"; "/dev/sda1"];
2562        ["vgcreate"; "VG"; "/dev/sda1"];
2563        ["lvcreate"; "LV1"; "VG"; "50"];
2564        ["lvcreate"; "LV2"; "VG"; "50"];
2565        ["lvremove"; "/dev/VG/LV1"];
2566        ["lvs"]], ["/dev/VG/LV2"]);
2567     InitEmpty, Always, TestOutputList (
2568       [["part_disk"; "/dev/sda"; "mbr"];
2569        ["pvcreate"; "/dev/sda1"];
2570        ["vgcreate"; "VG"; "/dev/sda1"];
2571        ["lvcreate"; "LV1"; "VG"; "50"];
2572        ["lvcreate"; "LV2"; "VG"; "50"];
2573        ["lvremove"; "/dev/VG"];
2574        ["lvs"]], []);
2575     InitEmpty, Always, TestOutputList (
2576       [["part_disk"; "/dev/sda"; "mbr"];
2577        ["pvcreate"; "/dev/sda1"];
2578        ["vgcreate"; "VG"; "/dev/sda1"];
2579        ["lvcreate"; "LV1"; "VG"; "50"];
2580        ["lvcreate"; "LV2"; "VG"; "50"];
2581        ["lvremove"; "/dev/VG"];
2582        ["vgs"]], ["VG"])],
2583    "remove an LVM logical volume",
2584    "\
2585 Remove an LVM logical volume C<device>, where C<device> is
2586 the path to the LV, such as C</dev/VG/LV>.
2587
2588 You can also remove all LVs in a volume group by specifying
2589 the VG name, C</dev/VG>.");
2590
2591   ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2592    [InitEmpty, Always, TestOutputList (
2593       [["part_disk"; "/dev/sda"; "mbr"];
2594        ["pvcreate"; "/dev/sda1"];
2595        ["vgcreate"; "VG"; "/dev/sda1"];
2596        ["lvcreate"; "LV1"; "VG"; "50"];
2597        ["lvcreate"; "LV2"; "VG"; "50"];
2598        ["vgremove"; "VG"];
2599        ["lvs"]], []);
2600     InitEmpty, Always, TestOutputList (
2601       [["part_disk"; "/dev/sda"; "mbr"];
2602        ["pvcreate"; "/dev/sda1"];
2603        ["vgcreate"; "VG"; "/dev/sda1"];
2604        ["lvcreate"; "LV1"; "VG"; "50"];
2605        ["lvcreate"; "LV2"; "VG"; "50"];
2606        ["vgremove"; "VG"];
2607        ["vgs"]], [])],
2608    "remove an LVM volume group",
2609    "\
2610 Remove an LVM volume group C<vgname>, (for example C<VG>).
2611
2612 This also forcibly removes all logical volumes in the volume
2613 group (if any).");
2614
2615   ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2616    [InitEmpty, Always, TestOutputListOfDevices (
2617       [["part_disk"; "/dev/sda"; "mbr"];
2618        ["pvcreate"; "/dev/sda1"];
2619        ["vgcreate"; "VG"; "/dev/sda1"];
2620        ["lvcreate"; "LV1"; "VG"; "50"];
2621        ["lvcreate"; "LV2"; "VG"; "50"];
2622        ["vgremove"; "VG"];
2623        ["pvremove"; "/dev/sda1"];
2624        ["lvs"]], []);
2625     InitEmpty, Always, TestOutputListOfDevices (
2626       [["part_disk"; "/dev/sda"; "mbr"];
2627        ["pvcreate"; "/dev/sda1"];
2628        ["vgcreate"; "VG"; "/dev/sda1"];
2629        ["lvcreate"; "LV1"; "VG"; "50"];
2630        ["lvcreate"; "LV2"; "VG"; "50"];
2631        ["vgremove"; "VG"];
2632        ["pvremove"; "/dev/sda1"];
2633        ["vgs"]], []);
2634     InitEmpty, Always, TestOutputListOfDevices (
2635       [["part_disk"; "/dev/sda"; "mbr"];
2636        ["pvcreate"; "/dev/sda1"];
2637        ["vgcreate"; "VG"; "/dev/sda1"];
2638        ["lvcreate"; "LV1"; "VG"; "50"];
2639        ["lvcreate"; "LV2"; "VG"; "50"];
2640        ["vgremove"; "VG"];
2641        ["pvremove"; "/dev/sda1"];
2642        ["pvs"]], [])],
2643    "remove an LVM physical volume",
2644    "\
2645 This wipes a physical volume C<device> so that LVM will no longer
2646 recognise it.
2647
2648 The implementation uses the C<pvremove> command which refuses to
2649 wipe physical volumes that contain any volume groups, so you have
2650 to remove those first.");
2651
2652   ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2653    [InitBasicFS, Always, TestOutput (
2654       [["set_e2label"; "/dev/sda1"; "testlabel"];
2655        ["get_e2label"; "/dev/sda1"]], "testlabel")],
2656    "set the ext2/3/4 filesystem label",
2657    "\
2658 This sets the ext2/3/4 filesystem label of the filesystem on
2659 C<device> to C<label>.  Filesystem labels are limited to
2660 16 characters.
2661
2662 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2663 to return the existing label on a filesystem.");
2664
2665   ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2666    [],
2667    "get the ext2/3/4 filesystem label",
2668    "\
2669 This returns the ext2/3/4 filesystem label of the filesystem on
2670 C<device>.");
2671
2672   ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2673    (let uuid = uuidgen () in
2674     [InitBasicFS, Always, TestOutput (
2675        [["set_e2uuid"; "/dev/sda1"; uuid];
2676         ["get_e2uuid"; "/dev/sda1"]], uuid);
2677      InitBasicFS, Always, TestOutput (
2678        [["set_e2uuid"; "/dev/sda1"; "clear"];
2679         ["get_e2uuid"; "/dev/sda1"]], "");
2680      (* We can't predict what UUIDs will be, so just check the commands run. *)
2681      InitBasicFS, Always, TestRun (
2682        [["set_e2uuid"; "/dev/sda1"; "random"]]);
2683      InitBasicFS, Always, TestRun (
2684        [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2685    "set the ext2/3/4 filesystem UUID",
2686    "\
2687 This sets the ext2/3/4 filesystem UUID of the filesystem on
2688 C<device> to C<uuid>.  The format of the UUID and alternatives
2689 such as C<clear>, C<random> and C<time> are described in the
2690 L<tune2fs(8)> manpage.
2691
2692 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2693 to return the existing UUID of a filesystem.");
2694
2695   ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2696    (* Regression test for RHBZ#597112. *)
2697    (let uuid = uuidgen () in
2698     [InitNone, Always, TestOutput (
2699        [["mke2journal"; "1024"; "/dev/sdc"];
2700         ["set_e2uuid"; "/dev/sdc"; uuid];
2701         ["get_e2uuid"; "/dev/sdc"]], uuid)]),
2702    "get the ext2/3/4 filesystem UUID",
2703    "\
2704 This returns the ext2/3/4 filesystem UUID of the filesystem on
2705 C<device>.");
2706
2707   ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2708    [InitBasicFS, Always, TestOutputInt (
2709       [["umount"; "/dev/sda1"];
2710        ["fsck"; "ext2"; "/dev/sda1"]], 0);
2711     InitBasicFS, Always, TestOutputInt (
2712       [["umount"; "/dev/sda1"];
2713        ["zero"; "/dev/sda1"];
2714        ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2715    "run the filesystem checker",
2716    "\
2717 This runs the filesystem checker (fsck) on C<device> which
2718 should have filesystem type C<fstype>.
2719
2720 The returned integer is the status.  See L<fsck(8)> for the
2721 list of status codes from C<fsck>.
2722
2723 Notes:
2724
2725 =over 4
2726
2727 =item *
2728
2729 Multiple status codes can be summed together.
2730
2731 =item *
2732
2733 A non-zero return code can mean \"success\", for example if
2734 errors have been corrected on the filesystem.
2735
2736 =item *
2737
2738 Checking or repairing NTFS volumes is not supported
2739 (by linux-ntfs).
2740
2741 =back
2742
2743 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2744
2745   ("zero", (RErr, [Device "device"], []), 85, [Progress],
2746    [InitBasicFS, Always, TestRun (
2747       [["umount"; "/dev/sda1"];
2748        ["zero"; "/dev/sda1"]])],
2749    "write zeroes to the device",
2750    "\
2751 This command writes zeroes over the first few blocks of C<device>.
2752
2753 How many blocks are zeroed isn't specified (but it's I<not> enough
2754 to securely wipe the device).  It should be sufficient to remove
2755 any partition tables, filesystem superblocks and so on.
2756
2757 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2758
2759   ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [Optional "grub"],
2760    (* See:
2761     * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2762     * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2763     *)
2764    [InitBasicFS, Always, TestOutputTrue (
2765       [["mkdir_p"; "/boot/grub"];
2766        ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2767        ["grub_install"; "/"; "/dev/vda"];
2768        ["is_dir"; "/boot"]])],
2769    "install GRUB 1",
2770    "\
2771 This command installs GRUB 1 (the Grand Unified Bootloader) on
2772 C<device>, with the root directory being C<root>.
2773
2774 Notes:
2775
2776 =over 4
2777
2778 =item *
2779
2780 There is currently no way in the API to install grub2, which
2781 is used by most modern Linux guests.  It is possible to run
2782 the grub2 command from the guest, although see the
2783 caveats in L<guestfs(3)/RUNNING COMMANDS>.
2784
2785 =item *
2786
2787 This uses C<grub-install> from the host.  Unfortunately grub is
2788 not always compatible with itself, so this only works in rather
2789 narrow circumstances.  Careful testing with each guest version
2790 is advisable.
2791
2792 =item *
2793
2794 If grub-install reports the error
2795 \"No suitable drive was found in the generated device map.\"
2796 it may be that you need to create a C</boot/grub/device.map>
2797 file first that contains the mapping between grub device names
2798 and Linux device names.  It is usually sufficient to create
2799 a file containing:
2800
2801  (hd0) /dev/vda
2802
2803 replacing C</dev/vda> with the name of the installation device.
2804
2805 =back");
2806
2807   ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
2808    [InitScratchFS, Always, TestOutput (
2809       [["mkdir"; "/cp"];
2810        ["write"; "/cp/old"; "file content"];
2811        ["cp"; "/cp/old"; "/cp/new"];
2812        ["cat"; "/cp/new"]], "file content");
2813     InitScratchFS, Always, TestOutputTrue (
2814       [["mkdir"; "/cp2"];
2815        ["write"; "/cp2/old"; "file content"];
2816        ["cp"; "/cp2/old"; "/cp2/new"];
2817        ["is_file"; "/cp2/old"]]);
2818     InitScratchFS, Always, TestOutput (
2819       [["mkdir"; "/cp3"];
2820        ["write"; "/cp3/old"; "file content"];
2821        ["mkdir"; "/cp3/dir"];
2822        ["cp"; "/cp3/old"; "/cp3/dir/new"];
2823        ["cat"; "/cp3/dir/new"]], "file content")],
2824    "copy a file",
2825    "\
2826 This copies a file from C<src> to C<dest> where C<dest> is
2827 either a destination filename or destination directory.");
2828
2829   ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
2830    [InitScratchFS, Always, TestOutput (
2831       [["mkdir"; "/cp_a1"];
2832        ["mkdir"; "/cp_a2"];
2833        ["write"; "/cp_a1/file"; "file content"];
2834        ["cp_a"; "/cp_a1"; "/cp_a2"];
2835        ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
2836    "copy a file or directory recursively",
2837    "\
2838 This copies a file or directory from C<src> to C<dest>
2839 recursively using the C<cp -a> command.");
2840
2841   ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
2842    [InitScratchFS, Always, TestOutput (
2843       [["mkdir"; "/mv"];
2844        ["write"; "/mv/old"; "file content"];
2845        ["mv"; "/mv/old"; "/mv/new"];
2846        ["cat"; "/mv/new"]], "file content");
2847     InitScratchFS, Always, TestOutputFalse (
2848       [["mkdir"; "/mv2"];
2849        ["write"; "/mv2/old"; "file content"];
2850        ["mv"; "/mv2/old"; "/mv2/new"];
2851        ["is_file"; "/mv2/old"]])],
2852    "move a file",
2853    "\
2854 This moves a file from C<src> to C<dest> where C<dest> is
2855 either a destination filename or destination directory.");
2856
2857   ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
2858    [InitEmpty, Always, TestRun (
2859       [["drop_caches"; "3"]])],
2860    "drop kernel page cache, dentries and inodes",
2861    "\
2862 This instructs the guest kernel to drop its page cache,
2863 and/or dentries and inode caches.  The parameter C<whattodrop>
2864 tells the kernel what precisely to drop, see
2865 L<http://linux-mm.org/Drop_Caches>
2866
2867 Setting C<whattodrop> to 3 should drop everything.
2868
2869 This automatically calls L<sync(2)> before the operation,
2870 so that the maximum guest memory is freed.");
2871
2872   ("dmesg", (RString "kmsgs", [], []), 91, [],
2873    [InitEmpty, Always, TestRun (
2874       [["dmesg"]])],
2875    "return kernel messages",
2876    "\
2877 This returns the kernel messages (C<dmesg> output) from
2878 the guest kernel.  This is sometimes useful for extended
2879 debugging of problems.
2880
2881 Another way to get the same information is to enable
2882 verbose messages with C<guestfs_set_verbose> or by setting
2883 the environment variable C<LIBGUESTFS_DEBUG=1> before
2884 running the program.");
2885
2886   ("ping_daemon", (RErr, [], []), 92, [],
2887    [InitEmpty, Always, TestRun (
2888       [["ping_daemon"]])],
2889    "ping the guest daemon",
2890    "\
2891 This is a test probe into the guestfs daemon running inside
2892 the qemu subprocess.  Calling this function checks that the
2893 daemon responds to the ping message, without affecting the daemon
2894 or attached block device(s) in any other way.");
2895
2896   ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
2897    [InitScratchFS, Always, TestOutputTrue (
2898       [["mkdir"; "/equal"];
2899        ["write"; "/equal/file1"; "contents of a file"];
2900        ["cp"; "/equal/file1"; "/equal/file2"];
2901        ["equal"; "/equal/file1"; "/equal/file2"]]);
2902     InitScratchFS, Always, TestOutputFalse (
2903       [["mkdir"; "/equal2"];
2904        ["write"; "/equal2/file1"; "contents of a file"];
2905        ["write"; "/equal2/file2"; "contents of another file"];
2906        ["equal"; "/equal2/file1"; "/equal2/file2"]]);
2907     InitScratchFS, Always, TestLastFail (
2908       [["mkdir"; "/equal3"];
2909        ["equal"; "/equal3/file1"; "/equal3/file2"]])],
2910    "test if two files have equal contents",
2911    "\
2912 This compares the two files C<file1> and C<file2> and returns
2913 true if their content is exactly equal, or false otherwise.
2914
2915 The external L<cmp(1)> program is used for the comparison.");
2916
2917   ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
2918    [InitISOFS, Always, TestOutputList (
2919       [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2920     InitISOFS, Always, TestOutputList (
2921       [["strings"; "/empty"]], []);
2922     (* Test for RHBZ#579608, absolute symbolic links. *)
2923     InitISOFS, Always, TestRun (
2924       [["strings"; "/abssymlink"]])],
2925    "print the printable strings in a file",
2926    "\
2927 This runs the L<strings(1)> command on a file and returns
2928 the list of printable strings found.");
2929
2930   ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
2931    [InitISOFS, Always, TestOutputList (
2932       [["strings_e"; "b"; "/known-5"]], []);
2933     InitScratchFS, Always, TestOutputList (
2934       [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2935        ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
2936    "print the printable strings in a file",
2937    "\
2938 This is like the C<guestfs_strings> command, but allows you to
2939 specify the encoding of strings that are looked for in
2940 the source file C<path>.
2941
2942 Allowed encodings are:
2943
2944 =over 4
2945
2946 =item s
2947
2948 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2949 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2950
2951 =item S
2952
2953 Single 8-bit-byte characters.
2954
2955 =item b
2956
2957 16-bit big endian strings such as those encoded in
2958 UTF-16BE or UCS-2BE.
2959
2960 =item l (lower case letter L)
2961
2962 16-bit little endian such as UTF-16LE and UCS-2LE.
2963 This is useful for examining binaries in Windows guests.
2964
2965 =item B
2966
2967 32-bit big endian such as UCS-4BE.
2968
2969 =item L
2970
2971 32-bit little endian such as UCS-4LE.
2972
2973 =back
2974
2975 The returned strings are transcoded to UTF-8.");
2976
2977   ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
2978    [InitISOFS, Always, TestOutput (
2979       [["hexdump"; "/known-4"]], "00000000  61 62 63 0a 64 65 66 0a  67 68 69                 |abc.def.ghi|\n0000000b\n");
2980     (* Test for RHBZ#501888c2 regression which caused large hexdump
2981      * commands to segfault.
2982      *)
2983     InitISOFS, Always, TestRun (
2984       [["hexdump"; "/100krandom"]]);
2985     (* Test for RHBZ#579608, absolute symbolic links. *)
2986     InitISOFS, Always, TestRun (
2987       [["hexdump"; "/abssymlink"]])],
2988    "dump a file in hexadecimal",
2989    "\
2990 This runs C<hexdump -C> on the given C<path>.  The result is
2991 the human-readable, canonical hex dump of the file.");
2992
2993   ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
2994    [InitNone, Always, TestOutput (
2995       [["part_disk"; "/dev/sda"; "mbr"];
2996        ["mkfs"; "ext3"; "/dev/sda1"];
2997        ["mount_options"; ""; "/dev/sda1"; "/"];
2998        ["write"; "/new"; "test file"];
2999        ["umount"; "/dev/sda1"];
3000        ["zerofree"; "/dev/sda1"];
3001        ["mount_options"; ""; "/dev/sda1"; "/"];
3002        ["cat"; "/new"]], "test file")],
3003    "zero unused inodes and disk blocks on ext2/3 filesystem",
3004    "\
3005 This runs the I<zerofree> program on C<device>.  This program
3006 claims to zero unused inodes and disk blocks on an ext2/3
3007 filesystem, thus making it possible to compress the filesystem
3008 more effectively.
3009
3010 You should B<not> run this program if the filesystem is
3011 mounted.
3012
3013 It is possible that using this program can damage the filesystem
3014 or data on the filesystem.");
3015
3016   ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
3017    [],
3018    "resize an LVM physical volume",
3019    "\
3020 This resizes (expands or shrinks) an existing LVM physical
3021 volume to match the new size of the underlying device.");
3022
3023   ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
3024                        Int "cyls"; Int "heads"; Int "sectors";
3025                        String "line"], []), 99, [DangerWillRobinson],
3026    [],
3027    "modify a single partition on a block device",
3028    "\
3029 This runs L<sfdisk(8)> option to modify just the single
3030 partition C<n> (note: C<n> counts from 1).
3031
3032 For other parameters, see C<guestfs_sfdisk>.  You should usually
3033 pass C<0> for the cyls/heads/sectors parameters.
3034
3035 See also: C<guestfs_part_add>");
3036
3037   ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [],
3038    [],
3039    "display the partition table",
3040    "\
3041 This displays the partition table on C<device>, in the
3042 human-readable output of the L<sfdisk(8)> command.  It is
3043 not intended to be parsed.
3044
3045 See also: C<guestfs_part_list>");
3046
3047   ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3048    [],
3049    "display the kernel geometry",
3050    "\
3051 This displays the kernel's idea of the geometry of C<device>.
3052
3053 The result is in human-readable format, and not designed to
3054 be parsed.");
3055
3056   ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3057    [],
3058    "display the disk geometry from the partition table",
3059    "\
3060 This displays the disk geometry of C<device> read from the
3061 partition table.  Especially in the case where the underlying
3062 block device has been resized, this can be different from the
3063 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3064
3065 The result is in human-readable format, and not designed to
3066 be parsed.");
3067
3068   ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3069    [],
3070    "activate or deactivate all volume groups",
3071    "\
3072 This command activates or (if C<activate> is false) deactivates
3073 all logical volumes in all volume groups.
3074 If activated, then they are made known to the
3075 kernel, ie. they appear as C</dev/mapper> devices.  If deactivated,
3076 then those devices disappear.
3077
3078 This command is the same as running C<vgchange -a y|n>");
3079
3080   ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3081    [],
3082    "activate or deactivate some volume groups",
3083    "\
3084 This command activates or (if C<activate> is false) deactivates
3085 all logical volumes in the listed volume groups C<volgroups>.
3086 If activated, then they are made known to the
3087 kernel, ie. they appear as C</dev/mapper> devices.  If deactivated,
3088 then those devices disappear.
3089
3090 This command is the same as running C<vgchange -a y|n volgroups...>
3091
3092 Note that if C<volgroups> is an empty list then B<all> volume groups
3093 are activated or deactivated.");
3094
3095   ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3096    [InitNone, Always, TestOutput (
3097       [["part_disk"; "/dev/sda"; "mbr"];
3098        ["pvcreate"; "/dev/sda1"];
3099        ["vgcreate"; "VG"; "/dev/sda1"];
3100        ["lvcreate"; "LV"; "VG"; "10"];
3101        ["mkfs"; "ext2"; "/dev/VG/LV"];
3102        ["mount_options"; ""; "/dev/VG/LV"; "/"];
3103        ["write"; "/new"; "test content"];
3104        ["umount"; "/"];
3105        ["lvresize"; "/dev/VG/LV"; "20"];
3106        ["e2fsck_f"; "/dev/VG/LV"];
3107        ["resize2fs"; "/dev/VG/LV"];
3108        ["mount_options"; ""; "/dev/VG/LV"; "/"];
3109        ["cat"; "/new"]], "test content");
3110     InitNone, Always, TestRun (
3111       (* Make an LV smaller to test RHBZ#587484. *)
3112       [["part_disk"; "/dev/sda"; "mbr"];
3113        ["pvcreate"; "/dev/sda1"];
3114        ["vgcreate"; "VG"; "/dev/sda1"];
3115        ["lvcreate"; "LV"; "VG"; "20"];
3116        ["lvresize"; "/dev/VG/LV"; "10"]])],
3117    "resize an LVM logical volume",
3118    "\
3119 This resizes (expands or shrinks) an existing LVM logical
3120 volume to C<mbytes>.  When reducing, data in the reduced part
3121 is lost.");
3122
3123   ("resize2fs", (RErr, [Device "device"], []), 106, [],
3124    [], (* lvresize tests this *)
3125    "resize an ext2, ext3 or ext4 filesystem",
3126    "\
3127 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3128 the underlying device.
3129
3130 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3131 on the C<device> before calling this command.  For unknown reasons
3132 C<resize2fs> sometimes gives an error about this and sometimes not.
3133 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3134 calling this function.");
3135
3136   ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3137    [InitBasicFS, Always, TestOutputList (
3138       [["find"; "/"]], ["lost+found"]);
3139     InitBasicFS, Always, TestOutputList (
3140       [["touch"; "/a"];
3141        ["mkdir"; "/b"];
3142        ["touch"; "/b/c"];
3143        ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3144     InitScratchFS, Always, TestOutputList (
3145       [["mkdir_p"; "/find/b/c"];
3146        ["touch"; "/find/b/c/d"];
3147        ["find"; "/find/b/"]], ["c"; "c/d"])],
3148    "find all files and directories",
3149    "\
3150 This command lists out all files and directories, recursively,
3151 starting at C<directory>.  It is essentially equivalent to
3152 running the shell command C<find directory -print> but some
3153 post-processing happens on the output, described below.
3154
3155 This returns a list of strings I<without any prefix>.  Thus
3156 if the directory structure was:
3157
3158  /tmp/a
3159  /tmp/b
3160  /tmp/c/d
3161
3162 then the returned list from C<guestfs_find> C</tmp> would be
3163 4 elements:
3164
3165  a
3166  b
3167  c
3168  c/d
3169
3170 If C<directory> is not a directory, then this command returns
3171 an error.
3172
3173 The returned list is sorted.
3174
3175 See also C<guestfs_find0>.");
3176
3177   ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3178    [], (* lvresize tests this *)
3179    "check an ext2/ext3 filesystem",
3180    "\
3181 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3182 filesystem checker on C<device>, noninteractively (C<-p>),
3183 even if the filesystem appears to be clean (C<-f>).
3184
3185 This command is only needed because of C<guestfs_resize2fs>
3186 (q.v.).  Normally you should use C<guestfs_fsck>.");
3187
3188   ("sleep", (RErr, [Int "secs"], []), 109, [],
3189    [InitNone, Always, TestRun (
3190       [["sleep"; "1"]])],
3191    "sleep for some seconds",
3192    "\
3193 Sleep for C<secs> seconds.");
3194
3195   ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3196    [InitNone, Always, TestOutputInt (
3197       [["part_disk"; "/dev/sda"; "mbr"];
3198        ["mkfs"; "ntfs"; "/dev/sda1"];
3199        ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3200     InitNone, Always, TestOutputInt (
3201       [["part_disk"; "/dev/sda"; "mbr"];
3202        ["mkfs"; "ext2"; "/dev/sda1"];
3203        ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3204    "probe NTFS volume",
3205    "\
3206 This command runs the L<ntfs-3g.probe(8)> command which probes
3207 an NTFS C<device> for mountability.  (Not all NTFS volumes can
3208 be mounted read-write, and some cannot be mounted at all).
3209
3210 C<rw> is a boolean flag.  Set it to true if you want to test
3211 if the volume can be mounted read-write.  Set it to false if
3212 you want to test if the volume can be mounted read-only.
3213
3214 The return value is an integer which C<0> if the operation
3215 would succeed, or some non-zero value documented in the
3216 L<ntfs-3g.probe(8)> manual page.");
3217
3218   ("sh", (RString "output", [String "command"], []), 111, [],
3219    [], (* XXX needs tests *)
3220    "run a command via the shell",
3221    "\
3222 This call runs a command from the guest filesystem via the
3223 guest's C</bin/sh>.
3224
3225 This is like C<guestfs_command>, but passes the command to:
3226
3227  /bin/sh -c \"command\"
3228
3229 Depending on the guest's shell, this usually results in
3230 wildcards being expanded, shell expressions being interpolated
3231 and so on.
3232
3233 All the provisos about C<guestfs_command> apply to this call.");
3234
3235   ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3236    [], (* XXX needs tests *)
3237    "run a command via the shell returning lines",
3238    "\
3239 This is the same as C<guestfs_sh>, but splits the result
3240 into a list of lines.
3241
3242 See also: C<guestfs_command_lines>");
3243
3244   ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3245    (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3246     * code in stubs.c, since all valid glob patterns must start with "/".
3247     * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3248     *)
3249    [InitScratchFS, Always, TestOutputList (
3250       [["mkdir_p"; "/glob_expand/b/c"];
3251        ["touch"; "/glob_expand/b/c/d"];
3252        ["touch"; "/glob_expand/b/c/e"];
3253        ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3254     InitScratchFS, Always, TestOutputList (
3255       [["mkdir_p"; "/glob_expand2/b/c"];
3256        ["touch"; "/glob_expand2/b/c/d"];
3257        ["touch"; "/glob_expand2/b/c/e"];
3258        ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3259     InitScratchFS, Always, TestOutputList (
3260       [["mkdir_p"; "/glob_expand3/b/c"];
3261        ["touch"; "/glob_expand3/b/c/d"];
3262        ["touch"; "/glob_expand3/b/c/e"];
3263        ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3264    "expand a wildcard path",
3265    "\
3266 This command searches for all the pathnames matching
3267 C<pattern> according to the wildcard expansion rules
3268 used by the shell.
3269
3270 If no paths match, then this returns an empty list
3271 (note: not an error).
3272
3273 It is just a wrapper around the C L<glob(3)> function
3274 with flags C<GLOB_MARK|GLOB_BRACE>.
3275 See that manual page for more details.");
3276
3277   ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3278    [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3279       [["scrub_device"; "/dev/sdc"]])],
3280    "scrub (securely wipe) a device",
3281    "\
3282 This command writes patterns over C<device> to make data retrieval
3283 more difficult.
3284
3285 It is an interface to the L<scrub(1)> program.  See that
3286 manual page for more details.");
3287
3288   ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3289    [InitScratchFS, Always, TestRun (
3290       [["write"; "/scrub_file"; "content"];
3291        ["scrub_file"; "/scrub_file"]])],
3292    "scrub (securely wipe) a file",
3293    "\
3294 This command writes patterns over a file to make data retrieval
3295 more difficult.
3296
3297 The file is I<removed> after scrubbing.
3298
3299 It is an interface to the L<scrub(1)> program.  See that
3300 manual page for more details.");
3301
3302   ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3303    [], (* XXX needs testing *)
3304    "scrub (securely wipe) free space",
3305    "\
3306 This command creates the directory C<dir> and then fills it
3307 with files until the filesystem is full, and scrubs the files
3308 as for C<guestfs_scrub_file>, and deletes them.
3309 The intention is to scrub any free space on the partition
3310 containing C<dir>.
3311
3312 It is an interface to the L<scrub(1)> program.  See that
3313 manual page for more details.");
3314
3315   ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3316    [InitScratchFS, Always, TestRun (
3317       [["mkdir"; "/mkdtemp"];
3318        ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3319    "create a temporary directory",
3320    "\
3321 This command creates a temporary directory.  The
3322 C<template> parameter should be a full pathname for the
3323 temporary directory name with the final six characters being
3324 \"XXXXXX\".
3325
3326 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3327 the second one being suitable for Windows filesystems.
3328
3329 The name of the temporary directory that was created
3330 is returned.
3331
3332 The temporary directory is created with mode 0700
3333 and is owned by root.
3334
3335 The caller is responsible for deleting the temporary
3336 directory and its contents after use.
3337
3338 See also: L<mkdtemp(3)>");
3339
3340   ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3341    [InitISOFS, Always, TestOutputInt (
3342       [["wc_l"; "/10klines"]], 10000);
3343     (* Test for RHBZ#579608, absolute symbolic links. *)
3344     InitISOFS, Always, TestOutputInt (
3345       [["wc_l"; "/abssymlink"]], 10000)],
3346    "count lines in a file",
3347    "\
3348 This command counts the lines in a file, using the
3349 C<wc -l> external command.");
3350
3351   ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3352    [InitISOFS, Always, TestOutputInt (
3353       [["wc_w"; "/10klines"]], 10000)],
3354    "count words in a file",
3355    "\
3356 This command counts the words in a file, using the
3357 C<wc -w> external command.");
3358
3359   ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3360    [InitISOFS, Always, TestOutputInt (
3361       [["wc_c"; "/100kallspaces"]], 102400)],
3362    "count characters in a file",
3363    "\
3364 This command counts the characters in a file, using the
3365 C<wc -c> external command.");
3366
3367   ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3368    [InitISOFS, Always, TestOutputList (
3369       [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3370     (* Test for RHBZ#579608, absolute symbolic links. *)
3371     InitISOFS, Always, TestOutputList (
3372       [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3373    "return first 10 lines of a file",
3374    "\
3375 This command returns up to the first 10 lines of a file as
3376 a list of strings.");
3377
3378   ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3379    [InitISOFS, Always, TestOutputList (
3380       [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3381     InitISOFS, Always, TestOutputList (
3382       [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3383     InitISOFS, Always, TestOutputList (
3384       [["head_n"; "0"; "/10klines"]], [])],
3385    "return first N lines of a file",
3386    "\
3387 If the parameter C<nrlines> is a positive number, this returns the first
3388 C<nrlines> lines of the file C<path>.
3389
3390 If the parameter C<nrlines> is a negative number, this returns lines
3391 from the file C<path>, excluding the last C<nrlines> lines.
3392
3393 If the parameter C<nrlines> is zero, this returns an empty list.");
3394
3395   ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3396    [InitISOFS, Always, TestOutputList (
3397       [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3398    "return last 10 lines of a file",
3399    "\
3400 This command returns up to the last 10 lines of a file as
3401 a list of strings.");
3402
3403   ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3404    [InitISOFS, Always, TestOutputList (
3405       [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3406     InitISOFS, Always, TestOutputList (
3407       [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3408     InitISOFS, Always, TestOutputList (
3409       [["tail_n"; "0"; "/10klines"]], [])],
3410    "return last N lines of a file",
3411    "\
3412 If the parameter C<nrlines> is a positive number, this returns the last
3413 C<nrlines> lines of the file C<path>.
3414
3415 If the parameter C<nrlines> is a negative number, this returns lines
3416 from the file C<path>, starting with the C<-nrlines>th line.
3417
3418 If the parameter C<nrlines> is zero, this returns an empty list.");
3419
3420   ("df", (RString "output", [], []), 125, [],
3421    [], (* XXX Tricky to test because it depends on the exact format
3422         * of the 'df' command and other imponderables.
3423         *)
3424    "report file system disk space usage",
3425    "\
3426 This command runs the C<df> command to report disk space used.
3427
3428 This command is mostly useful for interactive sessions.  It
3429 is I<not> intended that you try to parse the output string.
3430 Use C<guestfs_statvfs> from programs.");
3431
3432   ("df_h", (RString "output", [], []), 126, [],
3433    [], (* XXX Tricky to test because it depends on the exact format
3434         * of the 'df' command and other imponderables.
3435         *)
3436    "report file system disk space usage (human readable)",
3437    "\
3438 This command runs the C<df -h> command to report disk space used
3439 in human-readable format.
3440
3441 This command is mostly useful for interactive sessions.  It
3442 is I<not> intended that you try to parse the output string.
3443 Use C<guestfs_statvfs> from programs.");
3444
3445   ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [],
3446    [InitISOFS, Always, TestOutputInt (
3447       [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3448    "estimate file space usage",
3449    "\
3450 This command runs the C<du -s> command to estimate file space
3451 usage for C<path>.
3452
3453 C<path> can be a file or a directory.  If C<path> is a directory
3454 then the estimate includes the contents of the directory and all
3455 subdirectories (recursively).
3456
3457 The result is the estimated size in I<kilobytes>
3458 (ie. units of 1024 bytes).");
3459
3460   ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3461    [InitISOFS, Always, TestOutputList (
3462       [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3463    "list files in an initrd",
3464    "\
3465 This command lists out files contained in an initrd.
3466
3467 The files are listed without any initial C</> character.  The
3468 files are listed in the order they appear (not necessarily
3469 alphabetical).  Directory names are listed as separate items.
3470
3471 Old Linux kernels (2.4 and earlier) used a compressed ext2
3472 filesystem as initrd.  We I<only> support the newer initramfs
3473 format (compressed cpio files).");
3474
3475   ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3476    [],
3477    "mount a file using the loop device",
3478    "\
3479 This command lets you mount C<file> (a filesystem image
3480 in a file) on a mount point.  It is entirely equivalent to
3481 the command C<mount -o loop file mountpoint>.");
3482
3483   ("mkswap", (RErr, [Device "device"], []), 130, [],
3484    [InitEmpty, Always, TestRun (
3485       [["part_disk"; "/dev/sda"; "mbr"];
3486        ["mkswap"; "/dev/sda1"]])],
3487    "create a swap partition",
3488    "\
3489 Create a swap partition on C<device>.");
3490
3491   ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3492    [InitEmpty, Always, TestRun (
3493       [["part_disk"; "/dev/sda"; "mbr"];
3494        ["mkswap_L"; "hello"; "/dev/sda1"]])],
3495    "create a swap partition with a label",
3496    "\
3497 Create a swap partition on C<device> with label C<label>.
3498
3499 Note that you cannot attach a swap label to a block device
3500 (eg. C</dev/sda>), just to a partition.  This appears to be
3501 a limitation of the kernel or swap tools.");
3502
3503   ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3504    (let uuid = uuidgen () in
3505     [InitEmpty, Always, TestRun (
3506        [["part_disk"; "/dev/sda"; "mbr"];
3507         ["mkswap_U"; uuid; "/dev/sda1"]])]),
3508    "create a swap partition with an explicit UUID",
3509    "\
3510 Create a swap partition on C<device> with UUID C<uuid>.");
3511
3512   ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3513    [InitScratchFS, Always, TestOutputStruct (
3514       [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3515        (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3516        ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3517     InitScratchFS, Always, TestOutputStruct (
3518       [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3519        ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3520    "make block, character or FIFO devices",
3521    "\
3522 This call creates block or character special devices, or
3523 named pipes (FIFOs).
3524
3525 The C<mode> parameter should be the mode, using the standard
3526 constants.  C<devmajor> and C<devminor> are the
3527 device major and minor numbers, only used when creating block
3528 and character special devices.
3529
3530 Note that, just like L<mknod(2)>, the mode must be bitwise
3531 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3532 just creates a regular file).  These constants are
3533 available in the standard Linux header files, or you can use
3534 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3535 which are wrappers around this command which bitwise OR
3536 in the appropriate constant for you.
3537
3538 The mode actually set is affected by the umask.");
3539
3540   ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3541    [InitScratchFS, Always, TestOutputStruct (
3542       [["mkfifo"; "0o777"; "/mkfifo"];
3543        ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3544    "make FIFO (named pipe)",
3545    "\
3546 This call creates a FIFO (named pipe) called C<path> with
3547 mode C<mode>.  It is just a convenient wrapper around
3548 C<guestfs_mknod>.
3549
3550 The mode actually set is affected by the umask.");
3551
3552   ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3553    [InitScratchFS, Always, TestOutputStruct (
3554       [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3555        ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3556    "make block device node",
3557    "\
3558 This call creates a block device node called C<path> with
3559 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3560 It is just a convenient wrapper around C<guestfs_mknod>.
3561
3562 The mode actually set is affected by the umask.");
3563
3564   ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3565    [InitScratchFS, Always, TestOutputStruct (
3566       [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3567        ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3568    "make char device node",
3569    "\
3570 This call creates a char device node called C<path> with
3571 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3572 It is just a convenient wrapper around C<guestfs_mknod>.
3573
3574 The mode actually set is affected by the umask.");
3575
3576   ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3577    [InitEmpty, Always, TestOutputInt (
3578       [["umask"; "0o22"]], 0o22)],
3579    "set file mode creation mask (umask)",
3580    "\
3581 This function sets the mask used for creating new files and
3582 device nodes to C<mask & 0777>.
3583
3584 Typical umask values would be C<022> which creates new files
3585 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3586 C<002> which creates new files with permissions like
3587 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3588
3589 The default umask is C<022>.  This is important because it
3590 means that directories and device nodes will be created with
3591 C<0644> or C<0755> mode even if you specify C<0777>.
3592
3593 See also C<guestfs_get_umask>,
3594 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3595
3596 This call returns the previous umask.");
3597
3598   ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3599    [],
3600    "read directories entries",
3601    "\
3602 This returns the list of directory entries in directory C<dir>.
3603
3604 All entries in the directory are returned, including C<.> and
3605 C<..>.  The entries are I<not> sorted, but returned in the same
3606 order as the underlying filesystem.
3607
3608 Also this call returns basic file type information about each
3609 file.  The C<ftyp> field will contain one of the following characters:
3610
3611 =over 4
3612
3613 =item 'b'
3614
3615 Block special
3616
3617 =item 'c'
3618
3619 Char special
3620
3621 =item 'd'
3622
3623 Directory
3624
3625 =item 'f'
3626
3627 FIFO (named pipe)
3628
3629 =item 'l'
3630
3631 Symbolic link
3632
3633 =item 'r'
3634
3635 Regular file
3636
3637 =item 's'
3638
3639 Socket
3640
3641 =item 'u'
3642
3643 Unknown file type
3644
3645 =item '?'
3646
3647 The L<readdir(3)> call returned a C<d_type> field with an
3648 unexpected value
3649
3650 =back
3651
3652 This function is primarily intended for use by programs.  To
3653 get a simple list of names, use C<guestfs_ls>.  To get a printable
3654 directory for human consumption, use C<guestfs_ll>.");
3655
3656   ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson],
3657    [],
3658    "create partitions on a block device",
3659    "\
3660 This is a simplified interface to the C<guestfs_sfdisk>
3661 command, where partition sizes are specified in megabytes
3662 only (rounded to the nearest cylinder) and you don't need
3663 to specify the cyls, heads and sectors parameters which
3664 were rarely if ever used anyway.
3665
3666 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3667 and C<guestfs_part_disk>");
3668
3669   ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3670    [],
3671    "determine file type inside a compressed file",
3672    "\
3673 This command runs C<file> after first decompressing C<path>
3674 using C<method>.
3675
3676 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3677
3678 Since 1.0.63, use C<guestfs_file> instead which can now
3679 process compressed files.");
3680
3681   ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3682    [],
3683    "list extended attributes of a file or directory",
3684    "\
3685 This call lists the extended attributes of the file or directory
3686 C<path>.
3687
3688 At the system call level, this is a combination of the
3689 L<listxattr(2)> and L<getxattr(2)> calls.
3690
3691 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3692
3693   ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3694    [],
3695    "list extended attributes of a file or directory",
3696    "\
3697 This is the same as C<guestfs_getxattrs>, but if C<path>
3698 is a symbolic link, then it returns the extended attributes
3699 of the link itself.");
3700
3701   ("setxattr", (RErr, [String "xattr";
3702                        String "val"; Int "vallen"; (* will be BufferIn *)
3703                        Pathname "path"], []), 143, [Optional "linuxxattrs"],
3704    [],
3705    "set extended attribute of a file or directory",
3706    "\
3707 This call sets the extended attribute named C<xattr>
3708 of the file C<path> to the value C<val> (of length C<vallen>).
3709 The value is arbitrary 8 bit data.
3710
3711 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3712
3713   ("lsetxattr", (RErr, [String "xattr";
3714                         String "val"; Int "vallen"; (* will be BufferIn *)
3715                         Pathname "path"], []), 144, [Optional "linuxxattrs"],
3716    [],
3717    "set extended attribute of a file or directory",
3718    "\
3719 This is the same as C<guestfs_setxattr>, but if C<path>
3720 is a symbolic link, then it sets an extended attribute
3721 of the link itself.");
3722
3723   ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3724    [],
3725    "remove extended attribute of a file or directory",
3726    "\
3727 This call removes the extended attribute named C<xattr>
3728 of the file C<path>.
3729
3730 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3731
3732   ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3733    [],
3734    "remove extended attribute of a file or directory",
3735    "\
3736 This is the same as C<guestfs_removexattr>, but if C<path>
3737 is a symbolic link, then it removes an extended attribute
3738 of the link itself.");
3739
3740   ("mountpoints", (RHashtable "mps", [], []), 147, [],
3741    [],
3742    "show mountpoints",
3743    "\
3744 This call is similar to C<guestfs_mounts>.  That call returns
3745 a list of devices.  This one returns a hash table (map) of
3746 device name to directory where the device is mounted.");
3747
3748   ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3749    (* This is a special case: while you would expect a parameter
3750     * of type "Pathname", that doesn't work, because it implies
3751     * NEED_ROOT in the generated calling code in stubs.c, and
3752     * this function cannot use NEED_ROOT.
3753     *)
3754    [],
3755    "create a mountpoint",
3756    "\
3757 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3758 specialized calls that can be used to create extra mountpoints
3759 before mounting the first filesystem.
3760
3761 These calls are I<only> necessary in some very limited circumstances,
3762 mainly the case where you want to mount a mix of unrelated and/or
3763 read-only filesystems together.
3764
3765 For example, live CDs often contain a \"Russian doll\" nest of
3766 filesystems, an ISO outer layer, with a squashfs image inside, with
3767 an ext2/3 image inside that.  You can unpack this as follows
3768 in guestfish:
3769
3770  add-ro Fedora-11-i686-Live.iso
3771  run
3772  mkmountpoint /cd
3773  mkmountpoint /sqsh
3774  mkmountpoint /ext3fs
3775  mount /dev/sda /cd
3776  mount-loop /cd/LiveOS/squashfs.img /sqsh
3777  mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3778
3779 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3780
3781 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3782 You may get unexpected errors if you try to mix these calls.  It is
3783 safest to manually unmount filesystems and remove mountpoints after use.
3784
3785 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3786 longest first, so for this to work for manual mountpoints, you
3787 must ensure that the innermost mountpoints have the longest
3788 pathnames, as in the example code above.
3789
3790 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3791
3792 Autosync [see C<guestfs_set_autosync>, this is set by default on
3793 handles] means that C<guestfs_umount_all> is called when the handle
3794 is closed which can also trigger these issues.");
3795
3796   ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
3797    [],
3798    "remove a mountpoint",
3799    "\
3800 This calls removes a mountpoint that was previously created
3801 with C<guestfs_mkmountpoint>.  See C<guestfs_mkmountpoint>
3802 for full details.");
3803
3804   ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
3805    [InitISOFS, Always, TestOutputBuffer (
3806       [["read_file"; "/known-4"]], "abc\ndef\nghi");
3807     (* Test various near large, large and too large files (RHBZ#589039). *)
3808     InitScratchFS, Always, TestLastFail (
3809       [["touch"; "/read_file"];
3810        ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3811        ["read_file"; "/read_file"]]);
3812     InitScratchFS, Always, TestLastFail (
3813       [["touch"; "/read_file2"];
3814        ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3815        ["read_file"; "/read_file2"]]);
3816     InitScratchFS, Always, TestLastFail (
3817       [["touch"; "/read_file3"];
3818        ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3819        ["read_file"; "/read_file3"]])],
3820    "read a file",
3821    "\
3822 This calls returns the contents of the file C<path> as a
3823 buffer.
3824
3825 Unlike C<guestfs_cat>, this function can correctly
3826 handle files that contain embedded ASCII NUL characters.
3827 However unlike C<guestfs_download>, this function is limited
3828 in the total size of file that can be handled.");
3829
3830   ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
3831    [InitISOFS, Always, TestOutputList (
3832       [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3833     InitISOFS, Always, TestOutputList (
3834       [["grep"; "nomatch"; "/test-grep.txt"]], []);
3835     (* Test for RHBZ#579608, absolute symbolic links. *)
3836     InitISOFS, Always, TestOutputList (
3837       [["grep"; "nomatch"; "/abssymlink"]], [])],
3838    "return lines matching a pattern",
3839    "\
3840 This calls the external C<grep> program and returns the
3841 matching lines.");
3842
3843   ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
3844    [InitISOFS, Always, TestOutputList (
3845       [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3846    "return lines matching a pattern",
3847    "\
3848 This calls the external C<egrep> program and returns the
3849 matching lines.");
3850
3851   ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
3852    [InitISOFS, Always, TestOutputList (
3853       [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3854    "return lines matching a pattern",
3855    "\
3856 This calls the external C<fgrep> program and returns the
3857 matching lines.");
3858
3859   ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
3860    [InitISOFS, Always, TestOutputList (
3861       [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3862    "return lines matching a pattern",
3863    "\
3864 This calls the external C<grep -i> program and returns the
3865 matching lines.");
3866
3867   ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
3868    [InitISOFS, Always, TestOutputList (
3869       [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3870    "return lines matching a pattern",
3871    "\
3872 This calls the external C<egrep -i> program and returns the
3873 matching lines.");
3874
3875   ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
3876    [InitISOFS, Always, TestOutputList (
3877       [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3878    "return lines matching a pattern",
3879    "\
3880 This calls the external C<fgrep -i> program and returns the
3881 matching lines.");
3882
3883   ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
3884    [InitISOFS, Always, TestOutputList (
3885       [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3886    "return lines matching a pattern",
3887    "\
3888 This calls the external C<zgrep> program and returns the
3889 matching lines.");
3890
3891   ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
3892    [InitISOFS, Always, TestOutputList (
3893       [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3894    "return lines matching a pattern",
3895    "\
3896 This calls the external C<zegrep> program and returns the
3897 matching lines.");
3898
3899   ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
3900    [InitISOFS, Always, TestOutputList (
3901       [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3902    "return lines matching a pattern",
3903    "\
3904 This calls the external C<zfgrep> program and returns the
3905 matching lines.");
3906
3907   ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
3908    [InitISOFS, Always, TestOutputList (
3909       [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3910    "return lines matching a pattern",
3911    "\
3912 This calls the external C<zgrep -i> program and returns the
3913 matching lines.");
3914
3915   ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
3916    [InitISOFS, Always, TestOutputList (
3917       [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3918    "return lines matching a pattern",
3919    "\
3920 This calls the external C<zegrep -i> program and returns the
3921 matching lines.");
3922
3923   ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
3924    [InitISOFS, Always, TestOutputList (
3925       [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3926    "return lines matching a pattern",
3927    "\
3928 This calls the external C<zfgrep -i> program and returns the
3929 matching lines.");
3930
3931   ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
3932    [InitISOFS, Always, TestOutput (
3933       [["realpath"; "/../directory"]], "/directory")],
3934    "canonicalized absolute pathname",
3935    "\
3936 Return the canonicalized absolute pathname of C<path>.  The
3937 returned path has no C<.>, C<..> or symbolic link path elements.");
3938
3939   ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
3940    [InitScratchFS, Always, TestOutputStruct (
3941       [["mkdir"; "/ln"];
3942        ["touch"; "/ln/a"];
3943        ["ln"; "/ln/a"; "/ln/b"];
3944        ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
3945    "create a hard link",
3946    "\
3947 This command creates a hard link using the C<ln> command.");
3948
3949   ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
3950    [InitScratchFS, Always, TestOutputStruct (
3951       [["mkdir"; "/ln_f"];
3952        ["touch"; "/ln_f/a"];
3953        ["touch"; "/ln_f/b"];
3954        ["ln_f"; "/ln_f/a"; "/ln_f/b"];
3955        ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
3956    "create a hard link",
3957    "\
3958 This command creates a hard link using the C<ln -f> command.
3959 The C<-f> option removes the link (C<linkname>) if it exists already.");
3960
3961   ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
3962    [InitScratchFS, Always, TestOutputStruct (
3963       [["mkdir"; "/ln_s"];
3964        ["touch"; "/ln_s/a"];
3965        ["ln_s"; "a"; "/ln_s/b"];
3966        ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
3967    "create a symbolic link",
3968    "\
3969 This command creates a symbolic link using the C<ln -s> command.");
3970
3971   ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
3972    [InitScratchFS, Always, TestOutput (
3973       [["mkdir_p"; "/ln_sf/b"];
3974        ["touch"; "/ln_sf/b/c"];
3975        ["ln_sf"; "../d"; "/ln_sf/b/c"];
3976        ["readlink"; "/ln_sf/b/c"]], "../d")],
3977    "create a symbolic link",
3978    "\
3979 This command creates a symbolic link using the C<ln -sf> command,
3980 The C<-f> option removes the link (C<linkname>) if it exists already.");
3981
3982   ("readlink", (RString "link", [Pathname "path"], []), 168, [],
3983    [] (* XXX tested above *),
3984    "read the target of a symbolic link",
3985    "\
3986 This command reads the target of a symbolic link.");
3987
3988   ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
3989    [InitScratchFS, Always, TestOutputStruct (
3990       [["fallocate"; "/fallocate"; "1000000"];
3991        ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
3992    "preallocate a file in the guest filesystem",
3993    "\
3994 This command preallocates a file (containing zero bytes) named
3995 C<path> of size C<len> bytes.  If the file exists already, it
3996 is overwritten.
3997
3998 Do not confuse this with the guestfish-specific
3999 C<alloc> command which allocates a file in the host and
4000 attaches it as a device.");
4001
4002   ("swapon_device", (RErr, [Device "device"], []), 170, [],
4003    [InitPartition, Always, TestRun (
4004       [["mkswap"; "/dev/sda1"];
4005        ["swapon_device"; "/dev/sda1"];
4006        ["swapoff_device"; "/dev/sda1"]])],
4007    "enable swap on device",
4008    "\
4009 This command enables the libguestfs appliance to use the
4010 swap device or partition named C<device>.  The increased
4011 memory is made available for all commands, for example
4012 those run using C<guestfs_command> or C<guestfs_sh>.
4013
4014 Note that you should not swap to existing guest swap
4015 partitions unless you know what you are doing.  They may
4016 contain hibernation information, or other information that
4017 the guest doesn't want you to trash.  You also risk leaking
4018 information about the host to the guest this way.  Instead,
4019 attach a new host device to the guest and swap on that.");
4020
4021   ("swapoff_device", (RErr, [Device "device"], []), 171, [],
4022    [], (* XXX tested by swapon_device *)
4023    "disable swap on device",
4024    "\
4025 This command disables the libguestfs appliance swap
4026 device or partition named C<device>.
4027 See C<guestfs_swapon_device>.");
4028
4029   ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4030    [InitScratchFS, Always, TestRun (
4031       [["fallocate"; "/swapon_file"; "8388608"];
4032        ["mkswap_file"; "/swapon_file"];
4033        ["swapon_file"; "/swapon_file"];
4034        ["swapoff_file"; "/swapon_file"];
4035        ["rm"; "/swapon_file"]])],
4036    "enable swap on file",
4037    "\
4038 This command enables swap to a file.
4039 See C<guestfs_swapon_device> for other notes.");
4040
4041   ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4042    [], (* XXX tested by swapon_file *)
4043    "disable swap on file",
4044    "\
4045 This command disables the libguestfs appliance swap on file.");
4046
4047   ("swapon_label", (RErr, [String "label"], []), 174, [],
4048    [InitEmpty, Always, TestRun (
4049       [["part_disk"; "/dev/sda"; "mbr"];
4050        ["mkswap_L"; "swapit"; "/dev/sda1"];
4051        ["swapon_label"; "swapit"];
4052        ["swapoff_label"; "swapit"];
4053        ["zero"; "/dev/sda"];
4054        ["blockdev_rereadpt"; "/dev/sda"]])],
4055    "enable swap on labeled swap partition",
4056    "\
4057 This command enables swap to a labeled swap partition.
4058 See C<guestfs_swapon_device> for other notes.");
4059
4060   ("swapoff_label", (RErr, [String "label"], []), 175, [],
4061    [], (* XXX tested by swapon_label *)
4062    "disable swap on labeled swap partition",
4063    "\
4064 This command disables the libguestfs appliance swap on
4065 labeled swap partition.");
4066
4067   ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4068    (let uuid = uuidgen () in
4069     [InitEmpty, Always, TestRun (
4070        [["mkswap_U"; uuid; "/dev/sdc"];
4071         ["swapon_uuid"; uuid];
4072         ["swapoff_uuid"; uuid]])]),
4073    "enable swap on swap partition by UUID",
4074    "\
4075 This command enables swap to a swap partition with the given UUID.
4076 See C<guestfs_swapon_device> for other notes.");
4077
4078   ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4079    [], (* XXX tested by swapon_uuid *)
4080    "disable swap on swap partition by UUID",
4081    "\
4082 This command disables the libguestfs appliance swap partition
4083 with the given UUID.");
4084
4085   ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4086    [InitScratchFS, Always, TestRun (
4087       [["fallocate"; "/mkswap_file"; "8388608"];
4088        ["mkswap_file"; "/mkswap_file"];
4089        ["rm"; "/mkswap_file"]])],
4090    "create a swap file",
4091    "\
4092 Create a swap file.
4093
4094 This command just writes a swap file signature to an existing
4095 file.  To create the file itself, use something like C<guestfs_fallocate>.");
4096
4097   ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4098    [InitISOFS, Always, TestRun (
4099       [["inotify_init"; "0"]])],
4100    "create an inotify handle",
4101    "\
4102 This command creates a new inotify handle.
4103 The inotify subsystem can be used to notify events which happen to
4104 objects in the guest filesystem.
4105
4106 C<maxevents> is the maximum number of events which will be
4107 queued up between calls to C<guestfs_inotify_read> or
4108 C<guestfs_inotify_files>.
4109 If this is passed as C<0>, then the kernel (or previously set)
4110 default is used.  For Linux 2.6.29 the default was 16384 events.
4111 Beyond this limit, the kernel throws away events, but records
4112 the fact that it threw them away by setting a flag
4113 C<IN_Q_OVERFLOW> in the returned structure list (see
4114 C<guestfs_inotify_read>).
4115
4116 Before any events are generated, you have to add some
4117 watches to the internal watch list.  See:
4118 C<guestfs_inotify_add_watch>,
4119 C<guestfs_inotify_rm_watch> and
4120 C<guestfs_inotify_watch_all>.
4121
4122 Queued up events should be read periodically by calling
4123 C<guestfs_inotify_read>
4124 (or C<guestfs_inotify_files> which is just a helpful
4125 wrapper around C<guestfs_inotify_read>).  If you don't
4126 read the events out often enough then you risk the internal
4127 queue overflowing.
4128
4129 The handle should be closed after use by calling
4130 C<guestfs_inotify_close>.  This also removes any
4131 watches automatically.
4132
4133 See also L<inotify(7)> for an overview of the inotify interface
4134 as exposed by the Linux kernel, which is roughly what we expose
4135 via libguestfs.  Note that there is one global inotify handle
4136 per libguestfs instance.");
4137
4138   ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4139    [InitScratchFS, Always, TestOutputList (
4140       [["mkdir"; "/inotify_add_watch"];
4141        ["inotify_init"; "0"];
4142        ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4143        ["touch"; "/inotify_add_watch/a"];
4144        ["touch"; "/inotify_add_watch/b"];
4145        ["inotify_files"]], ["a"; "b"])],
4146    "add an inotify watch",
4147    "\
4148 Watch C<path> for the events listed in C<mask>.
4149
4150 Note that if C<path> is a directory then events within that
4151 directory are watched, but this does I<not> happen recursively
4152 (in subdirectories).
4153
4154 Note for non-C or non-Linux callers: the inotify events are
4155 defined by the Linux kernel ABI and are listed in
4156 C</usr/include/sys/inotify.h>.");
4157
4158   ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4159    [],
4160    "remove an inotify watch",
4161    "\
4162 Remove a previously defined inotify watch.
4163 See C<guestfs_inotify_add_watch>.");
4164
4165   ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4166    [],
4167    "return list of inotify events",
4168    "\
4169 Return the complete queue of events that have happened
4170 since the previous read call.
4171
4172 If no events have happened, this returns an empty list.
4173
4174 I<Note>: In order to make sure that all events have been
4175 read, you must call this function repeatedly until it
4176 returns an empty list.  The reason is that the call will
4177 read events up to the maximum appliance-to-host message
4178 size and leave remaining events in the queue.");
4179
4180   ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4181    [],
4182    "return list of watched files that had events",
4183    "\
4184 This function is a helpful wrapper around C<guestfs_inotify_read>
4185 which just returns a list of pathnames of objects that were
4186 touched.  The returned pathnames are sorted and deduplicated.");
4187
4188   ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4189    [],
4190    "close the inotify handle",
4191    "\
4192 This closes the inotify handle which was previously
4193 opened by inotify_init.  It removes all watches, throws
4194 away any pending events, and deallocates all resources.");
4195
4196   ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4197    [],
4198    "set SELinux security context",
4199    "\
4200 This sets the SELinux security context of the daemon
4201 to the string C<context>.
4202
4203 See the documentation about SELINUX in L<guestfs(3)>.");
4204
4205   ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4206    [],
4207    "get SELinux security context",
4208    "\
4209 This gets the SELinux security context of the daemon.
4210
4211 See the documentation about SELINUX in L<guestfs(3)>,
4212 and C<guestfs_setcon>");
4213
4214   ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4215    [InitEmpty, Always, TestOutput (
4216       [["part_disk"; "/dev/sda"; "mbr"];
4217        ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4218        ["mount_options"; ""; "/dev/sda1"; "/"];
4219        ["write"; "/new"; "new file contents"];
4220        ["cat"; "/new"]], "new file contents");
4221     InitEmpty, Always, TestRun (
4222       [["part_disk"; "/dev/sda"; "mbr"];
4223        ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4224     InitEmpty, Always, TestLastFail (
4225       [["part_disk"; "/dev/sda"; "mbr"];
4226        ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4227     InitEmpty, Always, TestLastFail (
4228       [["part_disk"; "/dev/sda"; "mbr"];
4229        ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4230     InitEmpty, IfAvailable "ntfsprogs", TestRun (
4231       [["part_disk"; "/dev/sda"; "mbr"];
4232        ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4233    "make a filesystem with block size",
4234    "\
4235 This call is similar to C<guestfs_mkfs>, but it allows you to
4236 control the block size of the resulting filesystem.  Supported
4237 block sizes depend on the filesystem type, but typically they
4238 are C<1024>, C<2048> or C<4096> only.
4239
4240 For VFAT and NTFS the C<blocksize> parameter is treated as
4241 the requested cluster size.");
4242
4243   ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4244    [InitEmpty, Always, TestOutput (
4245       [["part_init"; "/dev/sda"; "mbr"];
4246        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4247        ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4248        ["mke2journal"; "4096"; "/dev/sda1"];
4249        ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4250        ["mount_options"; ""; "/dev/sda2"; "/"];
4251        ["write"; "/new"; "new file contents"];
4252        ["cat"; "/new"]], "new file contents")],
4253    "make ext2/3/4 external journal",
4254    "\
4255 This creates an ext2 external journal on C<device>.  It is equivalent
4256 to the command:
4257
4258  mke2fs -O journal_dev -b blocksize device");
4259
4260   ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4261    [InitEmpty, Always, TestOutput (
4262       [["part_init"; "/dev/sda"; "mbr"];
4263        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4264        ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4265        ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4266        ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4267        ["mount_options"; ""; "/dev/sda2"; "/"];
4268        ["write"; "/new"; "new file contents"];
4269        ["cat"; "/new"]], "new file contents")],
4270    "make ext2/3/4 external journal with label",
4271    "\
4272 This creates an ext2 external journal on C<device> with label C<label>.");
4273
4274   ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4275    (let uuid = uuidgen () in
4276     [InitEmpty, Always, TestOutput (
4277        [["part_init"; "/dev/sda"; "mbr"];
4278         ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4279         ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4280         ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4281         ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4282         ["mount_options"; ""; "/dev/sda2"; "/"];
4283         ["write"; "/new"; "new file contents"];
4284         ["cat"; "/new"]], "new file contents")]),
4285    "make ext2/3/4 external journal with UUID",
4286    "\
4287 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4288
4289   ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4290    [],
4291    "make ext2/3/4 filesystem with external journal",
4292    "\
4293 This creates an ext2/3/4 filesystem on C<device> with
4294 an external journal on C<journal>.  It is equivalent
4295 to the command:
4296
4297  mke2fs -t fstype -b blocksize -J device=<journal> <device>
4298
4299 See also C<guestfs_mke2journal>.");
4300
4301   ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4302    [],
4303    "make ext2/3/4 filesystem with external journal",
4304    "\
4305 This creates an ext2/3/4 filesystem on C<device> with
4306 an external journal on the journal labeled C<label>.
4307
4308 See also C<guestfs_mke2journal_L>.");
4309
4310   ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4311    [],
4312    "make ext2/3/4 filesystem with external journal",
4313    "\
4314 This creates an ext2/3/4 filesystem on C<device> with
4315 an external journal on the journal with UUID C<uuid>.
4316
4317 See also C<guestfs_mke2journal_U>.");
4318
4319   ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4320    [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4321    "load a kernel module",
4322    "\
4323 This loads a kernel module in the appliance.
4324
4325 The kernel module must have been whitelisted when libguestfs
4326 was built (see C<appliance/kmod.whitelist.in> in the source).");
4327
4328   ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4329    [InitNone, Always, TestOutput (
4330       [["echo_daemon"; "This is a test"]], "This is a test"
4331     )],
4332    "echo arguments back to the client",
4333    "\
4334 This command concatenates the list of C<words> passed with single spaces
4335 between them and returns the resulting string.
4336
4337 You can use this command to test the connection through to the daemon.
4338
4339 See also C<guestfs_ping_daemon>.");
4340
4341   ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4342    [], (* There is a regression test for this. *)
4343    "find all files and directories, returning NUL-separated list",
4344    "\
4345 This command lists out all files and directories, recursively,
4346 starting at C<directory>, placing the resulting list in the
4347 external file called C<files>.
4348
4349 This command works the same way as C<guestfs_find> with the
4350 following exceptions:
4351
4352 =over 4
4353
4354 =item *
4355
4356 The resulting list is written to an external file.
4357
4358 =item *
4359
4360 Items (filenames) in the result are separated
4361 by C<\\0> characters.  See L<find(1)> option I<-print0>.
4362
4363 =item *
4364
4365 This command is not limited in the number of names that it
4366 can return.
4367
4368 =item *
4369
4370 The result list is not sorted.
4371
4372 =back");
4373
4374   ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4375    [InitISOFS, Always, TestOutput (
4376       [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4377     InitISOFS, Always, TestOutput (
4378       [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4379     InitISOFS, Always, TestOutput (
4380       [["case_sensitive_path"; "/Known-1"]], "/known-1");
4381     InitISOFS, Always, TestLastFail (
4382       [["case_sensitive_path"; "/Known-1/"]]);
4383     InitScratchFS, Always, TestOutput (
4384       [["mkdir"; "/case_sensitive_path"];
4385        ["mkdir"; "/case_sensitive_path/bbb"];
4386        ["touch"; "/case_sensitive_path/bbb/c"];
4387        ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4388     InitScratchFS, Always, TestOutput (
4389       [["mkdir"; "/case_sensitive_path2"];
4390        ["mkdir"; "/case_sensitive_path2/bbb"];
4391        ["touch"; "/case_sensitive_path2/bbb/c"];
4392        ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4393     InitScratchFS, Always, TestLastFail (
4394       [["mkdir"; "/case_sensitive_path3"];
4395        ["mkdir"; "/case_sensitive_path3/bbb"];
4396        ["touch"; "/case_sensitive_path3/bbb/c"];
4397        ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4398    "return true path on case-insensitive filesystem",
4399    "\
4400 This can be used to resolve case insensitive paths on
4401 a filesystem which is case sensitive.  The use case is
4402 to resolve paths which you have read from Windows configuration
4403 files or the Windows Registry, to the true path.
4404
4405 The command handles a peculiarity of the Linux ntfs-3g
4406 filesystem driver (and probably others), which is that although
4407 the underlying filesystem is case-insensitive, the driver
4408 exports the filesystem to Linux as case-sensitive.
4409
4410 One consequence of this is that special directories such
4411 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4412 (or other things) depending on the precise details of how
4413 they were created.  In Windows itself this would not be
4414 a problem.
4415
4416 Bug or feature?  You decide:
4417 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4418
4419 This function resolves the true case of each element in the
4420 path and returns the case-sensitive path.
4421
4422 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4423 might return C<\"/WINDOWS/system32\"> (the exact return value
4424 would depend on details of how the directories were originally
4425 created under Windows).
4426
4427 I<Note>:
4428 This function does not handle drive names, backslashes etc.
4429
4430 See also C<guestfs_realpath>.");
4431
4432   ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4433    [InitScratchFS, Always, TestOutput (
4434       [["vfs_type"; "/dev/sdb1"]], "ext2")],
4435    "get the Linux VFS type corresponding to a mounted device",
4436    "\
4437 This command gets the filesystem type corresponding to
4438 the filesystem on C<device>.
4439
4440 For most filesystems, the result is the name of the Linux
4441 VFS module which would be used to mount this filesystem
4442 if you mounted it without specifying the filesystem type.
4443 For example a string such as C<ext3> or C<ntfs>.");
4444
4445   ("truncate", (RErr, [Pathname "path"], []), 199, [],
4446    [InitScratchFS, Always, TestOutputStruct (
4447       [["write"; "/truncate"; "some stuff so size is not zero"];
4448        ["truncate"; "/truncate"];
4449        ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4450    "truncate a file to zero size",
4451    "\
4452 This command truncates C<path> to a zero-length file.  The
4453 file must exist already.");
4454
4455   ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4456    [InitScratchFS, Always, TestOutputStruct (
4457       [["touch"; "/truncate_size"];
4458        ["truncate_size"; "/truncate_size"; "1000"];
4459        ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4460    "truncate a file to a particular size",
4461    "\
4462 This command truncates C<path> to size C<size> bytes.  The file
4463 must exist already.
4464
4465 If the current file size is less than C<size> then
4466 the file is extended to the required size with zero bytes.
4467 This creates a sparse file (ie. disk blocks are not allocated
4468 for the file until you write to it).  To create a non-sparse
4469 file of zeroes, use C<guestfs_fallocate64> instead.");
4470
4471   ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4472    [InitScratchFS, Always, TestOutputStruct (
4473       [["touch"; "/utimens"];
4474        ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4475        ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4476    "set timestamp of a file with nanosecond precision",
4477    "\
4478 This command sets the timestamps of a file with nanosecond
4479 precision.
4480
4481 C<atsecs, atnsecs> are the last access time (atime) in secs and
4482 nanoseconds from the epoch.
4483
4484 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4485 secs and nanoseconds from the epoch.
4486
4487 If the C<*nsecs> field contains the special value C<-1> then
4488 the corresponding timestamp is set to the current time.  (The
4489 C<*secs> field is ignored in this case).
4490
4491 If the C<*nsecs> field contains the special value C<-2> then
4492 the corresponding timestamp is left unchanged.  (The
4493 C<*secs> field is ignored in this case).");
4494
4495   ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4496    [InitScratchFS, Always, TestOutputStruct (
4497       [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4498        ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4499    "create a directory with a particular mode",
4500    "\
4501 This command creates a directory, setting the initial permissions
4502 of the directory to C<mode>.
4503
4504 For common Linux filesystems, the actual mode which is set will
4505 be C<mode & ~umask & 01777>.  Non-native-Linux filesystems may
4506 interpret the mode in other ways.
4507
4508 See also C<guestfs_mkdir>, C<guestfs_umask>");
4509
4510   ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4511    [], (* XXX *)
4512    "change file owner and group",
4513    "\
4514 Change the file owner to C<owner> and group to C<group>.
4515 This is like C<guestfs_chown> but if C<path> is a symlink then
4516 the link itself is changed, not the target.
4517
4518 Only numeric uid and gid are supported.  If you want to use
4519 names, you will need to locate and parse the password file
4520 yourself (Augeas support makes this relatively easy).");
4521
4522   ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4523    [], (* XXX *)
4524    "lstat on multiple files",
4525    "\
4526 This call allows you to perform the C<guestfs_lstat> operation
4527 on multiple files, where all files are in the directory C<path>.
4528 C<names> is the list of files from this directory.
4529
4530 On return you get a list of stat structs, with a one-to-one
4531 correspondence to the C<names> list.  If any name did not exist
4532 or could not be lstat'd, then the C<ino> field of that structure
4533 is set to C<-1>.
4534
4535 This call is intended for programs that want to efficiently
4536 list a directory contents without making many round-trips.
4537 See also C<guestfs_lxattrlist> for a similarly efficient call
4538 for getting extended attributes.  Very long directory listings
4539 might cause the protocol message size to be exceeded, causing
4540 this call to fail.  The caller must split up such requests
4541 into smaller groups of names.");
4542
4543   ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4544    [], (* XXX *)
4545    "lgetxattr on multiple files",
4546    "\
4547 This call allows you to get the extended attributes
4548 of multiple files, where all files are in the directory C<path>.
4549 C<names> is the list of files from this directory.
4550
4551 On return you get a flat list of xattr structs which must be
4552 interpreted sequentially.  The first xattr struct always has a zero-length
4553 C<attrname>.  C<attrval> in this struct is zero-length
4554 to indicate there was an error doing C<lgetxattr> for this
4555 file, I<or> is a C string which is a decimal number
4556 (the number of following attributes for this file, which could
4557 be C<\"0\">).  Then after the first xattr struct are the
4558 zero or more attributes for the first named file.
4559 This repeats for the second and subsequent files.
4560
4561 This call is intended for programs that want to efficiently
4562 list a directory contents without making many round-trips.
4563 See also C<guestfs_lstatlist> for a similarly efficient call
4564 for getting standard stats.  Very long directory listings
4565 might cause the protocol message size to be exceeded, causing
4566 this call to fail.  The caller must split up such requests
4567 into smaller groups of names.");
4568
4569   ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4570    [], (* XXX *)
4571    "readlink on multiple files",
4572    "\
4573 This call allows you to do a C<readlink> operation
4574 on multiple files, where all files are in the directory C<path>.
4575 C<names> is the list of files from this directory.
4576
4577 On return you get a list of strings, with a one-to-one
4578 correspondence to the C<names> list.  Each string is the
4579 value of the symbolic link.
4580
4581 If the C<readlink(2)> operation fails on any name, then
4582 the corresponding result string is the empty string C<\"\">.
4583 However the whole operation is completed even if there
4584 were C<readlink(2)> errors, and so you can call this
4585 function with names where you don't know if they are
4586 symbolic links already (albeit slightly less efficient).
4587
4588 This call is intended for programs that want to efficiently
4589 list a directory contents without making many round-trips.
4590 Very long directory listings might cause the protocol
4591 message size to be exceeded, causing
4592 this call to fail.  The caller must split up such requests
4593 into smaller groups of names.");
4594
4595   ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4596    [InitISOFS, Always, TestOutputBuffer (
4597       [["pread"; "/known-4"; "1"; "3"]], "\n");
4598     InitISOFS, Always, TestOutputBuffer (
4599       [["pread"; "/empty"; "0"; "100"]], "")],
4600    "read part of a file",
4601    "\
4602 This command lets you read part of a file.  It reads C<count>
4603 bytes of the file, starting at C<offset>, from file C<path>.
4604
4605 This may read fewer bytes than requested.  For further details
4606 see the L<pread(2)> system call.
4607
4608 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4609
4610   ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4611    [InitEmpty, Always, TestRun (
4612       [["part_init"; "/dev/sda"; "gpt"]])],
4613    "create an empty partition table",
4614    "\
4615 This creates an empty partition table on C<device> of one of the
4616 partition types listed below.  Usually C<parttype> should be
4617 either C<msdos> or C<gpt> (for large disks).
4618
4619 Initially there are no partitions.  Following this, you should
4620 call C<guestfs_part_add> for each partition required.
4621
4622 Possible values for C<parttype> are:
4623
4624 =over 4
4625
4626 =item B<efi> | B<gpt>
4627
4628 Intel EFI / GPT partition table.
4629
4630 This is recommended for >= 2 TB partitions that will be accessed
4631 from Linux and Intel-based Mac OS X.  It also has limited backwards
4632 compatibility with the C<mbr> format.
4633
4634 =item B<mbr> | B<msdos>
4635
4636 The standard PC \"Master Boot Record\" (MBR) format used
4637 by MS-DOS and Windows.  This partition type will B<only> work
4638 for device sizes up to 2 TB.  For large disks we recommend
4639 using C<gpt>.
4640
4641 =back
4642
4643 Other partition table types that may work but are not
4644 supported include:
4645
4646 =over 4
4647
4648 =item B<aix>
4649
4650 AIX disk labels.
4651
4652 =item B<amiga> | B<rdb>
4653
4654 Amiga \"Rigid Disk Block\" format.
4655
4656 =item B<bsd>
4657
4658 BSD disk labels.
4659
4660 =item B<dasd>
4661
4662 DASD, used on IBM mainframes.
4663
4664 =item B<dvh>
4665
4666 MIPS/SGI volumes.
4667
4668 =item B<mac>
4669
4670 Old Mac partition format.  Modern Macs use C<gpt>.
4671
4672 =item B<pc98>
4673
4674 NEC PC-98 format, common in Japan apparently.
4675
4676 =item B<sun>
4677
4678 Sun disk labels.
4679
4680 =back");
4681
4682   ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4683    [InitEmpty, Always, TestRun (
4684       [["part_init"; "/dev/sda"; "mbr"];
4685        ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4686     InitEmpty, Always, TestRun (
4687       [["part_init"; "/dev/sda"; "gpt"];
4688        ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4689        ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4690     InitEmpty, Always, TestRun (
4691       [["part_init"; "/dev/sda"; "mbr"];
4692        ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4693        ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4694        ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4695        ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4696    "add a partition to the device",
4697    "\
4698 This command adds a partition to C<device>.  If there is no partition
4699 table on the device, call C<guestfs_part_init> first.
4700
4701 The C<prlogex> parameter is the type of partition.  Normally you
4702 should pass C<p> or C<primary> here, but MBR partition tables also
4703 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4704 types.
4705
4706 C<startsect> and C<endsect> are the start and end of the partition
4707 in I<sectors>.  C<endsect> may be negative, which means it counts
4708 backwards from the end of the disk (C<-1> is the last sector).
4709
4710 Creating a partition which covers the whole disk is not so easy.
4711 Use C<guestfs_part_disk> to do that.");
4712
4713   ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4714    [InitEmpty, Always, TestRun (
4715       [["part_disk"; "/dev/sda"; "mbr"]]);
4716     InitEmpty, Always, TestRun (
4717       [["part_disk"; "/dev/sda"; "gpt"]])],
4718    "partition whole disk with a single primary partition",
4719    "\
4720 This command is simply a combination of C<guestfs_part_init>
4721 followed by C<guestfs_part_add> to create a single primary partition
4722 covering the whole disk.
4723
4724 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4725 but other possible values are described in C<guestfs_part_init>.");
4726
4727   ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4728    [InitEmpty, Always, TestRun (
4729       [["part_disk"; "/dev/sda"; "mbr"];
4730        ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4731    "make a partition bootable",
4732    "\
4733 This sets the bootable flag on partition numbered C<partnum> on
4734 device C<device>.  Note that partitions are numbered from 1.
4735
4736 The bootable flag is used by some operating systems (notably
4737 Windows) to determine which partition to boot from.  It is by
4738 no means universally recognized.");
4739
4740   ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4741    [InitEmpty, Always, TestRun (
4742       [["part_disk"; "/dev/sda"; "gpt"];
4743        ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4744    "set partition name",
4745    "\
4746 This sets the partition name on partition numbered C<partnum> on
4747 device C<device>.  Note that partitions are numbered from 1.
4748
4749 The partition name can only be set on certain types of partition
4750 table.  This works on C<gpt> but not on C<mbr> partitions.");
4751
4752   ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4753    [], (* XXX Add a regression test for this. *)
4754    "list partitions on a device",
4755    "\
4756 This command parses the partition table on C<device> and
4757 returns the list of partitions found.
4758
4759 The fields in the returned structure are:
4760
4761 =over 4
4762
4763 =item B<part_num>
4764
4765 Partition number, counting from 1.
4766
4767 =item B<part_start>
4768
4769 Start of the partition I<in bytes>.  To get sectors you have to
4770 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4771
4772 =item B<part_end>
4773
4774 End of the partition in bytes.
4775
4776 =item B<part_size>
4777
4778 Size of the partition in bytes.
4779
4780 =back");
4781
4782   ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
4783    [InitEmpty, Always, TestOutput (
4784       [["part_disk"; "/dev/sda"; "gpt"];
4785        ["part_get_parttype"; "/dev/sda"]], "gpt")],
4786    "get the partition table type",
4787    "\
4788 This command examines the partition table on C<device> and
4789 returns the partition table type (format) being used.
4790
4791 Common return values include: C<msdos> (a DOS/Windows style MBR
4792 partition table), C<gpt> (a GPT/EFI-style partition table).  Other
4793 values are possible, although unusual.  See C<guestfs_part_init>
4794 for a full list.");
4795
4796   ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
4797    [InitScratchFS, Always, TestOutputBuffer (
4798       [["fill"; "0x63"; "10"; "/fill"];
4799        ["read_file"; "/fill"]], "cccccccccc")],
4800    "fill a file with octets",
4801    "\
4802 This command creates a new file called C<path>.  The initial
4803 content of the file is C<len> octets of C<c>, where C<c>
4804 must be a number in the range C<[0..255]>.
4805
4806 To fill a file with zero bytes (sparsely), it is
4807 much more efficient to use C<guestfs_truncate_size>.
4808 To create a file with a pattern of repeating bytes
4809 use C<guestfs_fill_pattern>.");
4810
4811   ("available", (RErr, [StringList "groups"], []), 216, [],
4812    [InitNone, Always, TestRun [["available"; ""]]],
4813    "test availability of some parts of the API",
4814    "\
4815 This command is used to check the availability of some
4816 groups of functionality in the appliance, which not all builds of
4817 the libguestfs appliance will be able to provide.
4818
4819 The libguestfs groups, and the functions that those
4820 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4821 You can also fetch this list at runtime by calling
4822 C<guestfs_available_all_groups>.
4823
4824 The argument C<groups> is a list of group names, eg:
4825 C<[\"inotify\", \"augeas\"]> would check for the availability of
4826 the Linux inotify functions and Augeas (configuration file
4827 editing) functions.
4828
4829 The command returns no error if I<all> requested groups are available.
4830
4831 It fails with an error if one or more of the requested
4832 groups is unavailable in the appliance.
4833
4834 If an unknown group name is included in the
4835 list of groups then an error is always returned.
4836
4837 I<Notes:>
4838
4839 =over 4
4840
4841 =item *
4842
4843 You must call C<guestfs_launch> before calling this function.
4844
4845 The reason is because we don't know what groups are
4846 supported by the appliance/daemon until it is running and can
4847 be queried.
4848
4849 =item *
4850
4851 If a group of functions is available, this does not necessarily
4852 mean that they will work.  You still have to check for errors
4853 when calling individual API functions even if they are
4854 available.
4855
4856 =item *
4857
4858 It is usually the job of distro packagers to build
4859 complete functionality into the libguestfs appliance.
4860 Upstream libguestfs, if built from source with all
4861 requirements satisfied, will support everything.
4862
4863 =item *
4864
4865 This call was added in version C<1.0.80>.  In previous
4866 versions of libguestfs all you could do would be to speculatively
4867 execute a command to find out if the daemon implemented it.
4868 See also C<guestfs_version>.
4869
4870 =back");
4871
4872   ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
4873    [InitScratchFS, Always, TestOutputBuffer (
4874       [["mkdir"; "/dd"];
4875        ["write"; "/dd/src"; "hello, world"];
4876        ["dd"; "/dd/src"; "/dd/dest"];
4877        ["read_file"; "/dd/dest"]], "hello, world")],
4878    "copy from source to destination using dd",
4879    "\
4880 This command copies from one source device or file C<src>
4881 to another destination device or file C<dest>.  Normally you
4882 would use this to copy to or from a device or partition, for
4883 example to duplicate a filesystem.
4884
4885 If the destination is a device, it must be as large or larger
4886 than the source file or device, otherwise the copy will fail.
4887 This command cannot do partial copies (see C<guestfs_copy_size>).");
4888
4889   ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
4890    [InitScratchFS, Always, TestOutputInt (
4891       [["write"; "/filesize"; "hello, world"];
4892        ["filesize"; "/filesize"]], 12)],
4893    "return the size of the file in bytes",
4894    "\
4895 This command returns the size of C<file> in bytes.
4896
4897 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4898 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4899 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4900
4901   ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
4902    [InitBasicFSonLVM, Always, TestOutputList (
4903       [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4904        ["lvs"]], ["/dev/VG/LV2"])],
4905    "rename an LVM logical volume",
4906    "\
4907 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4908
4909   ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
4910    [InitBasicFSonLVM, Always, TestOutputList (
4911       [["umount"; "/"];
4912        ["vg_activate"; "false"; "VG"];
4913        ["vgrename"; "VG"; "VG2"];
4914        ["vg_activate"; "true"; "VG2"];
4915        ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4916        ["vgs"]], ["VG2"])],
4917    "rename an LVM volume group",
4918    "\
4919 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4920
4921   ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
4922    [InitISOFS, Always, TestOutputBuffer (
4923       [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4924    "list the contents of a single file in an initrd",
4925    "\
4926 This command unpacks the file C<filename> from the initrd file
4927 called C<initrdpath>.  The filename must be given I<without> the
4928 initial C</> character.
4929
4930 For example, in guestfish you could use the following command
4931 to examine the boot script (usually called C</init>)
4932 contained in a Linux initrd or initramfs image:
4933
4934  initrd-cat /boot/initrd-<version>.img init
4935
4936 See also C<guestfs_initrd_list>.");
4937
4938   ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
4939    [],
4940    "get the UUID of a physical volume",
4941    "\
4942 This command returns the UUID of the LVM PV C<device>.");
4943
4944   ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
4945    [],
4946    "get the UUID of a volume group",
4947    "\
4948 This command returns the UUID of the LVM VG named C<vgname>.");
4949
4950   ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
4951    [],
4952    "get the UUID of a logical volume",
4953    "\
4954 This command returns the UUID of the LVM LV C<device>.");
4955
4956   ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
4957    [],
4958    "get the PV UUIDs containing the volume group",
4959    "\
4960 Given a VG called C<vgname>, this returns the UUIDs of all
4961 the physical volumes that this volume group resides on.
4962
4963 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4964 calls to associate physical volumes and volume groups.
4965
4966 See also C<guestfs_vglvuuids>.");
4967
4968   ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
4969    [],
4970    "get the LV UUIDs of all LVs in the volume group",
4971    "\
4972 Given a VG called C<vgname>, this returns the UUIDs of all
4973 the logical volumes created in this volume group.
4974
4975 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4976 calls to associate logical volumes and volume groups.
4977
4978 See also C<guestfs_vgpvuuids>.");
4979
4980   ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
4981    [InitScratchFS, Always, TestOutputBuffer (
4982       [["mkdir"; "/copy_size"];
4983        ["write"; "/copy_size/src"; "hello, world"];
4984        ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
4985        ["read_file"; "/copy_size/dest"]], "hello")],
4986    "copy size bytes from source to destination using dd",
4987    "\
4988 This command copies exactly C<size> bytes from one source device
4989 or file C<src> to another destination device or file C<dest>.
4990
4991 Note this will fail if the source is too short or if the destination
4992 is not large enough.");
4993
4994   ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
4995    [InitBasicFSonLVM, Always, TestRun (
4996       [["zero_device"; "/dev/VG/LV"]])],
4997    "write zeroes to an entire device",
4998    "\
4999 This command writes zeroes over the entire C<device>.  Compare
5000 with C<guestfs_zero> which just zeroes the first few blocks of
5001 a device.");
5002
5003   ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
5004    [InitScratchFS, Always, TestOutput (
5005       [["mkdir"; "/txz_in"];
5006        ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
5007        ["cat"; "/txz_in/hello"]], "hello\n")],
5008    "unpack compressed tarball to directory",
5009    "\
5010 This command uploads and unpacks local file C<tarball> (an
5011 I<xz compressed> tar file) into C<directory>.");
5012
5013   ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
5014    [],
5015    "pack directory into compressed tarball",
5016    "\
5017 This command packs the contents of C<directory> and downloads
5018 it to local file C<tarball> (as an xz compressed tar archive).");
5019
5020   ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"],
5021    [],
5022    "resize an NTFS filesystem",
5023    "\
5024 This command resizes an NTFS filesystem, expanding or
5025 shrinking it to the size of the underlying device.
5026
5027 I<Note:> After the resize operation, the filesystem is marked
5028 as requiring a consistency check (for safety).  You have to boot
5029 into Windows to perform this check and clear this condition.
5030 Furthermore, ntfsresize refuses to resize filesystems
5031 which have been marked in this way.  So in effect it is
5032 not possible to call ntfsresize multiple times on a single
5033 filesystem without booting into Windows between each resize.
5034
5035 See also L<ntfsresize(8)>.");
5036
5037   ("vgscan", (RErr, [], []), 232, [],
5038    [InitEmpty, Always, TestRun (
5039       [["vgscan"]])],
5040    "rescan for LVM physical volumes, volume groups and logical volumes",
5041    "\
5042 This rescans all block devices and rebuilds the list of LVM
5043 physical volumes, volume groups and logical volumes.");
5044
5045   ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5046    [InitEmpty, Always, TestRun (
5047       [["part_init"; "/dev/sda"; "mbr"];
5048        ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5049        ["part_del"; "/dev/sda"; "1"]])],
5050    "delete a partition",
5051    "\
5052 This command deletes the partition numbered C<partnum> on C<device>.
5053
5054 Note that in the case of MBR partitioning, deleting an
5055 extended partition also deletes any logical partitions
5056 it contains.");
5057
5058   ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5059    [InitEmpty, Always, TestOutputTrue (
5060       [["part_init"; "/dev/sda"; "mbr"];
5061        ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5062        ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5063        ["part_get_bootable"; "/dev/sda"; "1"]])],
5064    "return true if a partition is bootable",
5065    "\
5066 This command returns true if the partition C<partnum> on
5067 C<device> has the bootable flag set.
5068
5069 See also C<guestfs_part_set_bootable>.");
5070
5071   ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5072    [InitEmpty, Always, TestOutputInt (
5073       [["part_init"; "/dev/sda"; "mbr"];
5074        ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5075        ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5076        ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5077    "get the MBR type byte (ID byte) from a partition",
5078    "\
5079 Returns the MBR type byte (also known as the ID byte) from
5080 the numbered partition C<partnum>.
5081
5082 Note that only MBR (old DOS-style) partitions have type bytes.
5083 You will get undefined results for other partition table
5084 types (see C<guestfs_part_get_parttype>).");
5085
5086   ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5087    [], (* tested by part_get_mbr_id *)
5088    "set the MBR type byte (ID byte) of a partition",
5089    "\
5090 Sets the MBR type byte (also known as the ID byte) of
5091 the numbered partition C<partnum> to C<idbyte>.  Note
5092 that the type bytes quoted in most documentation are
5093 in fact hexadecimal numbers, but usually documented
5094 without any leading \"0x\" which might be confusing.
5095
5096 Note that only MBR (old DOS-style) partitions have type bytes.
5097 You will get undefined results for other partition table
5098 types (see C<guestfs_part_get_parttype>).");
5099
5100   ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5101    [InitISOFS, Always, TestOutputFileMD5 (
5102       [["checksum_device"; "md5"; "/dev/sdd"]],
5103       "../images/test.iso")],
5104    "compute MD5, SHAx or CRC checksum of the contents of a device",
5105    "\
5106 This call computes the MD5, SHAx or CRC checksum of the
5107 contents of the device named C<device>.  For the types of
5108 checksums supported see the C<guestfs_checksum> command.");
5109
5110   ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5111    [InitNone, Always, TestRun (
5112       [["part_disk"; "/dev/sda"; "mbr"];
5113        ["pvcreate"; "/dev/sda1"];
5114        ["vgcreate"; "VG"; "/dev/sda1"];
5115        ["lvcreate"; "LV"; "VG"; "10"];
5116        ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5117    "expand an LV to fill free space",
5118    "\
5119 This expands an existing logical volume C<lv> so that it fills
5120 C<pc>% of the remaining free space in the volume group.  Commonly
5121 you would call this with pc = 100 which expands the logical volume
5122 as much as possible, using all remaining free space in the volume
5123 group.");
5124
5125   ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5126    [], (* XXX Augeas code needs tests. *)
5127    "clear Augeas path",
5128    "\
5129 Set the value associated with C<path> to C<NULL>.  This
5130 is the same as the L<augtool(1)> C<clear> command.");
5131
5132   ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5133    [InitEmpty, Always, TestOutputInt (
5134       [["get_umask"]], 0o22)],
5135    "get the current umask",
5136    "\
5137 Return the current umask.  By default the umask is C<022>
5138 unless it has been set by calling C<guestfs_umask>.");
5139
5140   ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5141    [],
5142    "upload a file to the appliance (internal use only)",
5143    "\
5144 The C<guestfs_debug_upload> command uploads a file to
5145 the libguestfs appliance.
5146
5147 There is no comprehensive help for this command.  You have
5148 to look at the file C<daemon/debug.c> in the libguestfs source
5149 to find out what it is for.");
5150
5151   ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5152    [InitScratchFS, Always, TestOutput (
5153       [["base64_in"; "../images/hello.b64"; "/base64_in"];
5154        ["cat"; "/base64_in"]], "hello\n")],
5155    "upload base64-encoded data to file",
5156    "\
5157 This command uploads base64-encoded data from C<base64file>
5158 to C<filename>.");
5159
5160   ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5161    [],
5162    "download file and encode as base64",
5163    "\
5164 This command downloads the contents of C<filename>, writing
5165 it out to local file C<base64file> encoded as base64.");
5166
5167   ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5168    [],
5169    "compute MD5, SHAx or CRC checksum of files in a directory",
5170    "\
5171 This command computes the checksums of all regular files in
5172 C<directory> and then emits a list of those checksums to
5173 the local output file C<sumsfile>.
5174
5175 This can be used for verifying the integrity of a virtual
5176 machine.  However to be properly secure you should pay
5177 attention to the output of the checksum command (it uses
5178 the ones from GNU coreutils).  In particular when the
5179 filename is not printable, coreutils uses a special
5180 backslash syntax.  For more information, see the GNU
5181 coreutils info file.");
5182
5183   ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5184    [InitScratchFS, Always, TestOutputBuffer (
5185       [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5186        ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5187    "fill a file with a repeating pattern of bytes",
5188    "\
5189 This function is like C<guestfs_fill> except that it creates
5190 a new file of length C<len> containing the repeating pattern
5191 of bytes in C<pattern>.  The pattern is truncated if necessary
5192 to ensure the length of the file is exactly C<len> bytes.");
5193
5194   ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5195    [InitScratchFS, Always, TestOutput (
5196       [["write"; "/write"; "new file contents"];
5197        ["cat"; "/write"]], "new file contents");
5198     InitScratchFS, Always, TestOutput (
5199       [["write"; "/write2"; "\nnew file contents\n"];
5200        ["cat"; "/write2"]], "\nnew file contents\n");
5201     InitScratchFS, Always, TestOutput (
5202       [["write"; "/write3"; "\n\n"];
5203        ["cat"; "/write3"]], "\n\n");
5204     InitScratchFS, Always, TestOutput (
5205       [["write"; "/write4"; ""];
5206        ["cat"; "/write4"]], "");
5207     InitScratchFS, Always, TestOutput (
5208       [["write"; "/write5"; "\n\n\n"];
5209        ["cat"; "/write5"]], "\n\n\n");
5210     InitScratchFS, Always, TestOutput (
5211       [["write"; "/write6"; "\n"];
5212        ["cat"; "/write6"]], "\n")],
5213    "create a new file",
5214    "\
5215 This call creates a file called C<path>.  The content of the
5216 file is the string C<content> (which can contain any 8 bit data).");
5217
5218   ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5219    [InitScratchFS, Always, TestOutput (
5220       [["write"; "/pwrite"; "new file contents"];
5221        ["pwrite"; "/pwrite"; "data"; "4"];
5222        ["cat"; "/pwrite"]], "new data contents");
5223     InitScratchFS, Always, TestOutput (
5224       [["write"; "/pwrite2"; "new file contents"];
5225        ["pwrite"; "/pwrite2"; "is extended"; "9"];
5226        ["cat"; "/pwrite2"]], "new file is extended");
5227     InitScratchFS, Always, TestOutput (
5228       [["write"; "/pwrite3"; "new file contents"];
5229        ["pwrite"; "/pwrite3"; ""; "4"];
5230        ["cat"; "/pwrite3"]], "new file contents")],
5231    "write to part of a file",
5232    "\
5233 This command writes to part of a file.  It writes the data
5234 buffer C<content> to the file C<path> starting at offset C<offset>.
5235
5236 This command implements the L<pwrite(2)> system call, and like
5237 that system call it may not write the full data requested.  The
5238 return value is the number of bytes that were actually written
5239 to the file.  This could even be 0, although short writes are
5240 unlikely for regular files in ordinary circumstances.
5241
5242 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5243
5244   ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5245    [],
5246    "resize an ext2, ext3 or ext4 filesystem (with size)",
5247    "\
5248 This command is the same as C<guestfs_resize2fs> except that it
5249 allows you to specify the new size (in bytes) explicitly.");
5250
5251   ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5252    [],
5253    "resize an LVM physical volume (with size)",
5254    "\
5255 This command is the same as C<guestfs_pvresize> except that it
5256 allows you to specify the new size (in bytes) explicitly.");
5257
5258   ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"],
5259    [],
5260    "resize an NTFS filesystem (with size)",
5261    "\
5262 This command is the same as C<guestfs_ntfsresize> except that it
5263 allows you to specify the new size (in bytes) explicitly.");
5264
5265   ("available_all_groups", (RStringList "groups", [], []), 251, [],
5266    [InitNone, Always, TestRun [["available_all_groups"]]],
5267    "return a list of all optional groups",
5268    "\
5269 This command returns a list of all optional groups that this
5270 daemon knows about.  Note this returns both supported and unsupported
5271 groups.  To find out which ones the daemon can actually support
5272 you have to call C<guestfs_available> on each member of the
5273 returned list.
5274
5275 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5276
5277   ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5278    [InitScratchFS, Always, TestOutputStruct (
5279       [["fallocate64"; "/fallocate64"; "1000000"];
5280        ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5281    "preallocate a file in the guest filesystem",
5282    "\
5283 This command preallocates a file (containing zero bytes) named
5284 C<path> of size C<len> bytes.  If the file exists already, it
5285 is overwritten.
5286
5287 Note that this call allocates disk blocks for the file.
5288 To create a sparse file use C<guestfs_truncate_size> instead.
5289
5290 The deprecated call C<guestfs_fallocate> does the same,
5291 but owing to an oversight it only allowed 30 bit lengths
5292 to be specified, effectively limiting the maximum size
5293 of files created through that call to 1GB.
5294
5295 Do not confuse this with the guestfish-specific
5296 C<alloc> and C<sparse> commands which create
5297 a file in the host and attach it as a device.");
5298
5299   ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5300    [InitBasicFS, Always, TestOutput (
5301        [["set_e2label"; "/dev/sda1"; "LTEST"];
5302         ["vfs_label"; "/dev/sda1"]], "LTEST")],
5303    "get the filesystem label",
5304    "\
5305 This returns the filesystem label of the filesystem on
5306 C<device>.
5307
5308 If the filesystem is unlabeled, this returns the empty string.
5309
5310 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5311
5312   ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5313    (let uuid = uuidgen () in
5314     [InitBasicFS, Always, TestOutput (
5315        [["set_e2uuid"; "/dev/sda1"; uuid];
5316         ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5317    "get the filesystem UUID",
5318    "\
5319 This returns the filesystem UUID of the filesystem on
5320 C<device>.
5321
5322 If the filesystem does not have a UUID, this returns the empty string.
5323
5324 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5325
5326   ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5327    (* Can't be tested with the current framework because
5328     * the VG is being used by the mounted filesystem, so
5329     * the vgchange -an command we do first will fail.
5330     *)
5331     [],
5332    "set LVM device filter",
5333    "\
5334 This sets the LVM device filter so that LVM will only be
5335 able to \"see\" the block devices in the list C<devices>,
5336 and will ignore all other attached block devices.
5337
5338 Where disk image(s) contain duplicate PVs or VGs, this
5339 command is useful to get LVM to ignore the duplicates, otherwise
5340 LVM can get confused.  Note also there are two types
5341 of duplication possible: either cloned PVs/VGs which have
5342 identical UUIDs; or VGs that are not cloned but just happen
5343 to have the same name.  In normal operation you cannot
5344 create this situation, but you can do it outside LVM, eg.
5345 by cloning disk images or by bit twiddling inside the LVM
5346 metadata.
5347
5348 This command also clears the LVM cache and performs a volume
5349 group scan.
5350
5351 You can filter whole block devices or individual partitions.
5352
5353 You cannot use this if any VG is currently in use (eg.
5354 contains a mounted filesystem), even if you are not
5355 filtering out that VG.");
5356
5357   ("lvm_clear_filter", (RErr, [], []), 256, [],
5358    [], (* see note on lvm_set_filter *)
5359    "clear LVM device filter",
5360    "\
5361 This undoes the effect of C<guestfs_lvm_set_filter>.  LVM
5362 will be able to see every block device.
5363
5364 This command also clears the LVM cache and performs a volume
5365 group scan.");
5366
5367   ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5368    [],
5369    "open a LUKS-encrypted block device",
5370    "\
5371 This command opens a block device which has been encrypted
5372 according to the Linux Unified Key Setup (LUKS) standard.
5373
5374 C<device> is the encrypted block device or partition.
5375
5376 The caller must supply one of the keys associated with the
5377 LUKS block device, in the C<key> parameter.
5378
5379 This creates a new block device called C</dev/mapper/mapname>.
5380 Reads and writes to this block device are decrypted from and
5381 encrypted to the underlying C<device> respectively.
5382
5383 If this block device contains LVM volume groups, then
5384 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5385 will make them visible.");
5386
5387   ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5388    [],
5389    "open a LUKS-encrypted block device read-only",
5390    "\
5391 This is the same as C<guestfs_luks_open> except that a read-only
5392 mapping is created.");
5393
5394   ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5395    [],
5396    "close a LUKS device",
5397    "\
5398 This closes a LUKS device that was created earlier by
5399 C<guestfs_luks_open> or C<guestfs_luks_open_ro>.  The
5400 C<device> parameter must be the name of the LUKS mapping
5401 device (ie. C</dev/mapper/mapname>) and I<not> the name
5402 of the underlying block device.");
5403
5404   ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5405    [],
5406    "format a block device as a LUKS encrypted device",
5407    "\
5408 This command erases existing data on C<device> and formats
5409 the device as a LUKS encrypted device.  C<key> is the
5410 initial key, which is added to key slot C<slot>.  (LUKS
5411 supports 8 key slots, numbered 0-7).");
5412
5413   ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5414    [],
5415    "format a block device as a LUKS encrypted device",
5416    "\
5417 This command is the same as C<guestfs_luks_format> but
5418 it also allows you to set the C<cipher> used.");
5419
5420   ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5421    [],
5422    "add a key on a LUKS encrypted device",
5423    "\
5424 This command adds a new key on LUKS device C<device>.
5425 C<key> is any existing key, and is used to access the device.
5426 C<newkey> is the new key to add.  C<keyslot> is the key slot
5427 that will be replaced.
5428
5429 Note that if C<keyslot> already contains a key, then this
5430 command will fail.  You have to use C<guestfs_luks_kill_slot>
5431 first to remove that key.");
5432
5433   ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5434    [],
5435    "remove a key from a LUKS encrypted device",
5436    "\
5437 This command deletes the key in key slot C<keyslot> from the
5438 encrypted LUKS device C<device>.  C<key> must be one of the
5439 I<other> keys.");
5440
5441   ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5442    [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5443       [["is_lv"; "/dev/VG/LV"]]);
5444     InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5445       [["is_lv"; "/dev/sda1"]])],
5446    "test if device is a logical volume",
5447    "\
5448 This command tests whether C<device> is a logical volume, and
5449 returns true iff this is the case.");
5450
5451   ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5452    [],
5453    "find a filesystem by UUID",
5454    "\
5455 This command searches the filesystems and returns the one
5456 which has the given UUID.  An error is returned if no such
5457 filesystem can be found.
5458
5459 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5460
5461   ("findfs_label", (RString "device", [String "label"], []), 266, [],
5462    [],
5463    "find a filesystem by label",
5464    "\
5465 This command searches the filesystems and returns the one
5466 which has the given label.  An error is returned if no such
5467 filesystem can be found.
5468
5469 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5470
5471   ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5472    [InitISOFS, Always, TestOutputFalse (
5473       [["is_chardev"; "/directory"]]);
5474     InitScratchFS, Always, TestOutputTrue (
5475       [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5476        ["is_chardev"; "/is_chardev"]])],
5477    "test if character device",
5478    "\
5479 This returns C<true> if and only if there is a character device
5480 with the given C<path> name.
5481
5482 See also C<guestfs_stat>.");
5483
5484   ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5485    [InitISOFS, Always, TestOutputFalse (
5486       [["is_blockdev"; "/directory"]]);
5487     InitScratchFS, Always, TestOutputTrue (
5488       [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5489        ["is_blockdev"; "/is_blockdev"]])],
5490    "test if block device",
5491    "\
5492 This returns C<true> if and only if there is a block device
5493 with the given C<path> name.
5494
5495 See also C<guestfs_stat>.");
5496
5497   ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5498    [InitISOFS, Always, TestOutputFalse (
5499       [["is_fifo"; "/directory"]]);
5500     InitScratchFS, Always, TestOutputTrue (
5501       [["mkfifo"; "0o777"; "/is_fifo"];
5502        ["is_fifo"; "/is_fifo"]])],
5503    "test if FIFO (named pipe)",
5504    "\
5505 This returns C<true> if and only if there is a FIFO (named pipe)
5506 with the given C<path> name.
5507
5508 See also C<guestfs_stat>.");
5509
5510   ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5511    [InitISOFS, Always, TestOutputFalse (
5512       [["is_symlink"; "/directory"]]);
5513     InitISOFS, Always, TestOutputTrue (
5514       [["is_symlink"; "/abssymlink"]])],
5515    "test if symbolic link",
5516    "\
5517 This returns C<true> if and only if there is a symbolic link
5518 with the given C<path> name.
5519
5520 See also C<guestfs_stat>.");
5521
5522   ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5523    (* XXX Need a positive test for sockets. *)
5524    [InitISOFS, Always, TestOutputFalse (
5525       [["is_socket"; "/directory"]])],
5526    "test if socket",
5527    "\
5528 This returns C<true> if and only if there is a Unix domain socket
5529 with the given C<path> name.
5530
5531 See also C<guestfs_stat>.");
5532
5533   ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5534    [InitPartition, Always, TestOutputDevice (
5535       [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5536     InitEmpty, Always, TestLastFail (
5537       [["part_to_dev"; "/dev/sda"]])],
5538    "convert partition name to device name",
5539    "\
5540 This function takes a partition name (eg. \"/dev/sdb1\") and
5541 removes the partition number, returning the device name
5542 (eg. \"/dev/sdb\").
5543
5544 The named partition must exist, for example as a string returned
5545 from C<guestfs_list_partitions>.");
5546
5547   ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5548    (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5549     [InitScratchFS, Always, TestOutput (
5550        [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5551         ["checksum"; "md5"; "/upload_offset"]], md5)]),
5552    "upload a file from the local machine with offset",
5553    "\
5554 Upload local file C<filename> to C<remotefilename> on the
5555 filesystem.
5556
5557 C<remotefilename> is overwritten starting at the byte C<offset>
5558 specified.  The intention is to overwrite parts of existing
5559 files or devices, although if a non-existant file is specified
5560 then it is created with a \"hole\" before C<offset>.  The
5561 size of the data written is implicit in the size of the
5562 source C<filename>.
5563
5564 Note that there is no limit on the amount of data that
5565 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5566 and this call always writes the full amount unless an
5567 error occurs.
5568
5569 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5570
5571   ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5572    (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5573     let offset = string_of_int 100 in
5574     let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5575     [InitScratchFS, Always, TestOutput (
5576        (* Pick a file from cwd which isn't likely to change. *)
5577        [["mkdir"; "/download_offset"];
5578         ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5579         ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5580         ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5581         ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5582    "download a file to the local machine with offset and size",
5583    "\
5584 Download file C<remotefilename> and save it as C<filename>
5585 on the local machine.
5586
5587 C<remotefilename> is read for C<size> bytes starting at C<offset>
5588 (this region must be within the file or device).
5589
5590 Note that there is no limit on the amount of data that
5591 can be downloaded with this call, unlike with C<guestfs_pread>,
5592 and this call always reads the full amount unless an
5593 error occurs.
5594
5595 See also C<guestfs_download>, C<guestfs_pread>.");
5596
5597   ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5598    [InitPartition, Always, TestOutputListOfDevices (
5599       [["pwrite_device"; "/dev/sda"; "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"; "446"];
5600        ["blockdev_rereadpt"; "/dev/sda"];
5601        ["list_partitions"]], ["/dev/sdb1"])],
5602    "write to part of a device",
5603    "\
5604 This command writes to part of a device.  It writes the data
5605 buffer C<content> to C<device> starting at offset C<offset>.
5606
5607 This command implements the L<pwrite(2)> system call, and like
5608 that system call it may not write the full data requested
5609 (although short writes to disk devices and partitions are
5610 probably impossible with standard Linux kernels).
5611
5612 See also C<guestfs_pwrite>.");
5613
5614   ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5615    [InitEmpty, Always, TestOutputBuffer (
5616       [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5617    "read part of a device",
5618    "\
5619 This command lets you read part of a file.  It reads C<count>
5620 bytes of C<device>, starting at C<offset>.
5621
5622 This may read fewer bytes than requested.  For further details
5623 see the L<pread(2)> system call.
5624
5625 See also C<guestfs_pread>.");
5626
5627   ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5628    [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5629     [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5630     InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5631     [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5632    "get canonical name of an LV",
5633    "\
5634 This converts alternative naming schemes for LVs that you
5635 might find to the canonical name.  For example, C</dev/mapper/VG-LV>
5636 is converted to C</dev/VG/LV>.
5637
5638 This command returns an error if the C<lvname> parameter does
5639 not refer to a logical volume.
5640
5641 See also C<guestfs_is_lv>.");
5642
5643   ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"]), 278, [],
5644    [InitEmpty, Always, TestOutput (
5645       [["part_disk"; "/dev/sda"; "mbr"];
5646        ["mkfs_opts"; "ext2"; "/dev/sda1"; "4096"];
5647        ["mount_options"; ""; "/dev/sda1"; "/"];
5648        ["write"; "/new"; "new file contents"];
5649        ["cat"; "/new"]], "new file contents")],
5650    "make a filesystem",
5651    "\
5652 This function creates a filesystem on C<device>.  The filesystem
5653 type is C<fstype>, for example C<ext3>.
5654
5655 The optional arguments are:
5656
5657 =over 4
5658
5659 =item C<blocksize>
5660
5661 The filesystem block size.  Supported block sizes depend on the
5662 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
5663 for Linux ext2/3 filesystems.
5664
5665 For VFAT and NTFS the C<blocksize> parameter is treated as
5666 the requested cluster size.
5667
5668 For UFS block sizes, please see L<mkfs.ufs(8)>.
5669
5670 =back");
5671
5672   ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
5673    [],
5674    "get a single extended attribute",
5675    "\
5676 Get a single extended attribute from file C<path> named C<name>.
5677 This call follows symlinks.  If you want to lookup an extended
5678 attribute for the symlink itself, use C<guestfs_lgetxattr>.
5679
5680 Normally it is better to get all extended attributes from a file
5681 in one go by calling C<guestfs_getxattrs>.  However some Linux
5682 filesystem implementations are buggy and do not provide a way to
5683 list out attributes.  For these filesystems (notably ntfs-3g)
5684 you have to know the names of the extended attributes you want
5685 in advance and call this function.
5686
5687 Extended attribute values are blobs of binary data.  If there
5688 is no extended attribute named C<name>, this returns an error.
5689
5690 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
5691
5692   ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
5693    [],
5694    "get a single extended attribute",
5695    "\
5696 Get a single extended attribute from file C<path> named C<name>.
5697 If C<path> is a symlink, then this call returns an extended
5698 attribute from the symlink.
5699
5700 Normally it is better to get all extended attributes from a file
5701 in one go by calling C<guestfs_getxattrs>.  However some Linux
5702 filesystem implementations are buggy and do not provide a way to
5703 list out attributes.  For these filesystems (notably ntfs-3g)
5704 you have to know the names of the extended attributes you want
5705 in advance and call this function.
5706
5707 Extended attribute values are blobs of binary data.  If there
5708 is no extended attribute named C<name>, this returns an error.
5709
5710 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
5711
5712 ]
5713
5714 let all_functions = non_daemon_functions @ daemon_functions
5715
5716 (* In some places we want the functions to be displayed sorted
5717  * alphabetically, so this is useful:
5718  *)
5719 let all_functions_sorted = List.sort action_compare all_functions
5720
5721 (* This is used to generate the src/MAX_PROC_NR file which
5722  * contains the maximum procedure number, a surrogate for the
5723  * ABI version number.  See src/Makefile.am for the details.
5724  *)
5725 let max_proc_nr =
5726   let proc_nrs = List.map (
5727     fun (_, _, proc_nr, _, _, _, _) -> proc_nr
5728   ) daemon_functions in
5729   List.fold_left max 0 proc_nrs
5730
5731 (* Non-API meta-commands available only in guestfish.
5732  *
5733  * Note (1): style, proc_nr and tests fields are all meaningless.
5734  * The only fields which are actually used are the shortname,
5735  * FishAlias flags, shortdesc and longdesc.
5736  *
5737  * Note (2): to refer to other commands, use L</shortname>.
5738  *
5739  * Note (3): keep this list sorted by shortname.
5740  *)
5741 let fish_commands = [
5742   ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
5743    "allocate and add a disk file",
5744    " alloc filename size
5745
5746 This creates an empty (zeroed) file of the given size, and then adds
5747 so it can be further examined.
5748
5749 For more advanced image creation, see L<qemu-img(1)> utility.
5750
5751 Size can be specified using standard suffixes, eg. C<1M>.
5752
5753 To create a sparse file, use L</sparse> instead.  To create a
5754 prepared disk image, see L</PREPARED DISK IMAGES>.");
5755
5756   ("copy_in", (RErr,[], []), -1, [], [],
5757    "copy local files or directories into an image",
5758    " copy-in local [local ...] /remotedir
5759
5760 C<copy-in> copies local files or directories recursively into the disk
5761 image, placing them in the directory called C</remotedir> (which must
5762 exist).  This guestfish meta-command turns into a sequence of
5763 L</tar-in> and other commands as necessary.
5764
5765 Multiple local files and directories can be specified, but the last
5766 parameter must always be a remote directory.  Wildcards cannot be
5767 used.");
5768
5769   ("copy_out", (RErr,[], []), -1, [], [],
5770    "copy remote files or directories out of an image",
5771    " copy-out remote [remote ...] localdir
5772
5773 C<copy-out> copies remote files or directories recursively out of the
5774 disk image, placing them on the host disk in a local directory called
5775 C<localdir> (which must exist).  This guestfish meta-command turns
5776 into a sequence of L</download>, L</tar-out> and other commands as
5777 necessary.
5778
5779 Multiple remote files and directories can be specified, but the last
5780 parameter must always be a local directory.  To download to the
5781 current directory, use C<.> as in:
5782
5783  copy-out /home .
5784
5785 Wildcards cannot be used in the ordinary command, but you can use
5786 them with the help of L</glob> like this:
5787
5788  glob copy-out /home/* .");
5789
5790   ("echo", (RErr,[], []), -1, [], [],
5791    "display a line of text",
5792    " echo [params ...]
5793
5794 This echos the parameters to the terminal.");
5795
5796   ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
5797    "edit a file",
5798    " edit filename
5799
5800 This is used to edit a file.  It downloads the file, edits it
5801 locally using your editor, then uploads the result.
5802
5803 The editor is C<$EDITOR>.  However if you use the alternate
5804 commands C<vi> or C<emacs> you will get those corresponding
5805 editors.");
5806
5807   ("glob", (RErr,[], []), -1, [], [],
5808    "expand wildcards in command",
5809    " glob command args...
5810
5811 Expand wildcards in any paths in the args list, and run C<command>
5812 repeatedly on each matching path.
5813
5814 See L</WILDCARDS AND GLOBBING>.");
5815
5816   ("hexedit", (RErr,[], []), -1, [], [],
5817    "edit with a hex editor",
5818    " hexedit <filename|device>
5819  hexedit <filename|device> <max>
5820  hexedit <filename|device> <start> <max>
5821
5822 Use hexedit (a hex editor) to edit all or part of a binary file
5823 or block device.
5824
5825 This command works by downloading potentially the whole file or
5826 device, editing it locally, then uploading it.  If the file or
5827 device is large, you have to specify which part you wish to edit
5828 by using C<max> and/or C<start> C<max> parameters.
5829 C<start> and C<max> are specified in bytes, with the usual
5830 modifiers allowed such as C<1M> (1 megabyte).
5831
5832 For example to edit the first few sectors of a disk you
5833 might do:
5834
5835  hexedit /dev/sda 1M
5836
5837 which would allow you to edit anywhere within the first megabyte
5838 of the disk.
5839
5840 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
5841
5842  hexedit /dev/sda1 0x400 0x400
5843
5844 (assuming the superblock is in the standard location).
5845
5846 This command requires the external L<hexedit(1)> program.  You
5847 can specify another program to use by setting the C<HEXEDITOR>
5848 environment variable.
5849
5850 See also L</hexdump>.");
5851
5852   ("lcd", (RErr,[], []), -1, [], [],
5853    "change working directory",
5854    " lcd directory
5855
5856 Change the local directory, ie. the current directory of guestfish
5857 itself.
5858
5859 Note that C<!cd> won't do what you might expect.");
5860
5861   ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
5862    "open the manual",
5863    "  man
5864
5865 Opens the manual page for guestfish.");
5866
5867   ("more", (RErr,[], []), -1, [FishAlias "less"], [],
5868    "view a file",
5869    " more filename
5870
5871  less filename
5872
5873 This is used to view a file.
5874
5875 The default viewer is C<$PAGER>.  However if you use the alternate
5876 command C<less> you will get the C<less> command specifically.");
5877
5878   ("reopen", (RErr,[], []), -1, [], [],
5879    "close and reopen libguestfs handle",
5880    "  reopen
5881
5882 Close and reopen the libguestfs handle.  It is not necessary to use
5883 this normally, because the handle is closed properly when guestfish
5884 exits.  However this is occasionally useful for testing.");
5885
5886   ("sparse", (RErr,[], []), -1, [], [],
5887    "create a sparse disk image and add",
5888    " sparse filename size
5889
5890 This creates an empty sparse file of the given size, and then adds
5891 so it can be further examined.
5892
5893 In all respects it works the same as the L</alloc> command, except that
5894 the image file is allocated sparsely, which means that disk blocks are
5895 not assigned to the file until they are needed.  Sparse disk files
5896 only use space when written to, but they are slower and there is a
5897 danger you could run out of real disk space during a write operation.
5898
5899 For more advanced image creation, see L<qemu-img(1)> utility.
5900
5901 Size can be specified using standard suffixes, eg. C<1M>.");
5902
5903   ("supported", (RErr,[], []), -1, [], [],
5904    "list supported groups of commands",
5905    " supported
5906
5907 This command returns a list of the optional groups
5908 known to the daemon, and indicates which ones are
5909 supported by this build of the libguestfs appliance.
5910
5911 See also L<guestfs(3)/AVAILABILITY>.");
5912
5913   ("time", (RErr,[], []), -1, [], [],
5914    "print elapsed time taken to run a command",
5915    " time command args...
5916
5917 Run the command as usual, but print the elapsed time afterwards.  This
5918 can be useful for benchmarking operations.");
5919
5920 ]