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