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