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