c7b9fa40cf203125b77846be399dff94db45e0b6
[libguestfs.git] / guestfish-actions.pod
1 =head2 add-cdrom | cdrom
2
3  add-cdrom filename
4
5 This function adds a virtual CD-ROM disk image to the guest.
6
7 This is equivalent to the qemu parameter C<-cdrom filename>.
8
9 =head2 add-drive | add
10
11  add-drive filename
12
13 This function adds a virtual machine disk image C<filename> to the
14 guest.  The first time you call this function, the disk appears as IDE
15 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
16 so on.
17
18 You don't necessarily need to be root when using libguestfs.  However
19 you obviously do need sufficient permissions to access the filename
20 for whatever operations you want to perform (ie. read access if you
21 just want to read the image or write access if you want to modify the
22 image).
23
24 This is equivalent to the qemu parameter C<-drive file=filename>.
25
26 =head2 aug-close
27
28  aug-close
29
30 Close the current Augeas handle and free up any resources
31 used by it.  After calling this, you have to call
32 C<aug-init> again before you can use any other
33 Augeas functions.
34
35 =head2 aug-defnode
36
37  aug-defnode name expr val
38
39 Defines a variable C<name> whose value is the result of
40 evaluating C<expr>.
41
42 If C<expr> evaluates to an empty nodeset, a node is created,
43 equivalent to calling C<aug-set> C<expr>, C<value>.
44 C<name> will be the nodeset containing that single node.
45
46 On success this returns a pair containing the
47 number of nodes in the nodeset, and a boolean flag
48 if a node was created.
49
50 =head2 aug-defvar
51
52  aug-defvar name expr
53
54 Defines an Augeas variable C<name> whose value is the result
55 of evaluating C<expr>.  If C<expr> is NULL, then C<name> is
56 undefined.
57
58 On success this returns the number of nodes in C<expr>, or
59 C<0> if C<expr> evaluates to something which is not a nodeset.
60
61 =head2 aug-get
62
63  aug-get path
64
65 Look up the value associated with C<path>.  If C<path>
66 matches exactly one node, the C<value> is returned.
67
68 =head2 aug-init
69
70  aug-init root flags
71
72 Create a new Augeas handle for editing configuration files.
73 If there was any previous Augeas handle associated with this
74 guestfs session, then it is closed.
75
76 You must call this before using any other C<aug-*>
77 commands.
78
79 C<root> is the filesystem root.  C<root> must not be NULL,
80 use C</> instead.
81
82 The flags are the same as the flags defined in
83 E<lt>augeas.hE<gt>, the logical I<or> of the following
84 integers:
85
86 =over 4
87
88 =item C<AUG_SAVE_BACKUP> = 1
89
90 Keep the original file with a C<.augsave> extension.
91
92 =item C<AUG_SAVE_NEWFILE> = 2
93
94 Save changes into a file with extension C<.augnew>, and
95 do not overwrite original.  Overrides C<AUG_SAVE_BACKUP>.
96
97 =item C<AUG_TYPE_CHECK> = 4
98
99 Typecheck lenses (can be expensive).
100
101 =item C<AUG_NO_STDINC> = 8
102
103 Do not use standard load path for modules.
104
105 =item C<AUG_SAVE_NOOP> = 16
106
107 Make save a no-op, just record what would have been changed.
108
109 =item C<AUG_NO_LOAD> = 32
110
111 Do not load the tree in C<aug-init>.
112
113 =back
114
115 To close the handle, you can call C<aug-close>.
116
117 To find out more about Augeas, see L<http://augeas.net/>.
118
119 =head2 aug-insert
120
121  aug-insert path label true|false
122
123 Create a new sibling C<label> for C<path>, inserting it into
124 the tree before or after C<path> (depending on the boolean
125 flag C<before>).
126
127 C<path> must match exactly one existing node in the tree, and
128 C<label> must be a label, ie. not contain C</>, C<*> or end
129 with a bracketed index C<[N]>.
130
131 =head2 aug-load
132
133  aug-load
134
135 Load files into the tree.
136
137 See C<aug_load> in the Augeas documentation for the full gory
138 details.
139
140 =head2 aug-ls
141
142  aug-ls path
143
144 This is just a shortcut for listing C<aug-match>
145 C<path/*> and sorting the resulting nodes into alphabetical order.
146
147 =head2 aug-match
148
149  aug-match path
150
151 Returns a list of paths which match the path expression C<path>.
152 The returned paths are sufficiently qualified so that they match
153 exactly one node in the current tree.
154
155 =head2 aug-mv
156
157  aug-mv src dest
158
159 Move the node C<src> to C<dest>.  C<src> must match exactly
160 one node.  C<dest> is overwritten if it exists.
161
162 =head2 aug-rm
163
164  aug-rm path
165
166 Remove C<path> and all of its children.
167
168 On success this returns the number of entries which were removed.
169
170 =head2 aug-save
171
172  aug-save
173
174 This writes all pending changes to disk.
175
176 The flags which were passed to C<aug-init> affect exactly
177 how files are saved.
178
179 =head2 aug-set
180
181  aug-set path val
182
183 Set the value associated with C<path> to C<value>.
184
185 =head2 blockdev-flushbufs
186
187  blockdev-flushbufs device
188
189 This tells the kernel to flush internal buffers associated
190 with C<device>.
191
192 This uses the L<blockdev(8)> command.
193
194 =head2 blockdev-getbsz
195
196  blockdev-getbsz device
197
198 This returns the block size of a device.
199
200 (Note this is different from both I<size in blocks> and
201 I<filesystem block size>).
202
203 This uses the L<blockdev(8)> command.
204
205 =head2 blockdev-getro
206
207  blockdev-getro device
208
209 Returns a boolean indicating if the block device is read-only
210 (true if read-only, false if not).
211
212 This uses the L<blockdev(8)> command.
213
214 =head2 blockdev-getsize64
215
216  blockdev-getsize64 device
217
218 This returns the size of the device in bytes.
219
220 See also C<blockdev-getsz>.
221
222 This uses the L<blockdev(8)> command.
223
224 =head2 blockdev-getss
225
226  blockdev-getss device
227
228 This returns the size of sectors on a block device.
229 Usually 512, but can be larger for modern devices.
230
231 (Note, this is not the size in sectors, use C<blockdev-getsz>
232 for that).
233
234 This uses the L<blockdev(8)> command.
235
236 =head2 blockdev-getsz
237
238  blockdev-getsz device
239
240 This returns the size of the device in units of 512-byte sectors
241 (even if the sectorsize isn't 512 bytes ... weird).
242
243 See also C<blockdev-getss> for the real sector size of
244 the device, and C<blockdev-getsize64> for the more
245 useful I<size in bytes>.
246
247 This uses the L<blockdev(8)> command.
248
249 =head2 blockdev-rereadpt
250
251  blockdev-rereadpt device
252
253 Reread the partition table on C<device>.
254
255 This uses the L<blockdev(8)> command.
256
257 =head2 blockdev-setbsz
258
259  blockdev-setbsz device blocksize
260
261 This sets the block size of a device.
262
263 (Note this is different from both I<size in blocks> and
264 I<filesystem block size>).
265
266 This uses the L<blockdev(8)> command.
267
268 =head2 blockdev-setro
269
270  blockdev-setro device
271
272 Sets the block device named C<device> to read-only.
273
274 This uses the L<blockdev(8)> command.
275
276 =head2 blockdev-setrw
277
278  blockdev-setrw device
279
280 Sets the block device named C<device> to read-write.
281
282 This uses the L<blockdev(8)> command.
283
284 =head2 cat
285
286  cat path
287
288 Return the contents of the file named C<path>.
289
290 Note that this function cannot correctly handle binary files
291 (specifically, files containing C<\0> character which is treated
292 as end of string).  For those you need to use the C<download>
293 function which has a more complex interface.
294
295 Because of the message protocol, there is a transfer limit 
296 of somewhere between 2MB and 4MB.  To transfer large files you should use
297 FTP.
298
299 =head2 checksum
300
301  checksum csumtype path
302
303 This call computes the MD5, SHAx or CRC checksum of the
304 file named C<path>.
305
306 The type of checksum to compute is given by the C<csumtype>
307 parameter which must have one of the following values:
308
309 =over 4
310
311 =item C<crc>
312
313 Compute the cyclic redundancy check (CRC) specified by POSIX
314 for the C<cksum> command.
315
316 =item C<md5>
317
318 Compute the MD5 hash (using the C<md5sum> program).
319
320 =item C<sha1>
321
322 Compute the SHA1 hash (using the C<sha1sum> program).
323
324 =item C<sha224>
325
326 Compute the SHA224 hash (using the C<sha224sum> program).
327
328 =item C<sha256>
329
330 Compute the SHA256 hash (using the C<sha256sum> program).
331
332 =item C<sha384>
333
334 Compute the SHA384 hash (using the C<sha384sum> program).
335
336 =item C<sha512>
337
338 Compute the SHA512 hash (using the C<sha512sum> program).
339
340 =back
341
342 The checksum is returned as a printable string.
343
344 =head2 chmod
345
346  chmod mode path
347
348 Change the mode (permissions) of C<path> to C<mode>.  Only
349 numeric modes are supported.
350
351 =head2 chown
352
353  chown owner group path
354
355 Change the file owner to C<owner> and group to C<group>.
356
357 Only numeric uid and gid are supported.  If you want to use
358 names, you will need to locate and parse the password file
359 yourself (Augeas support makes this relatively easy).
360
361 =head2 command
362
363  command 'arguments ...'
364
365 This call runs a command from the guest filesystem.  The
366 filesystem must be mounted, and must contain a compatible
367 operating system (ie. something Linux, with the same
368 or compatible processor architecture).
369
370 The single parameter is an argv-style list of arguments.
371 The first element is the name of the program to run.
372 Subsequent elements are parameters.  The list must be
373 non-empty (ie. must contain a program name).
374
375 The C<$PATH> environment variable will contain at least
376 C</usr/bin> and C</bin>.  If you require a program from
377 another location, you should provide the full path in the
378 first parameter.
379
380 Shared libraries and data files required by the program
381 must be available on filesystems which are mounted in the
382 correct places.  It is the caller's responsibility to ensure
383 all filesystems that are needed are mounted at the right
384 locations.
385
386 =head2 command-lines
387
388  command-lines 'arguments ...'
389
390 This is the same as C<command>, but splits the
391 result into a list of lines.
392
393 =head2 config
394
395  config qemuparam qemuvalue
396
397 This can be used to add arbitrary qemu command line parameters
398 of the form C<-param value>.  Actually it's not quite arbitrary - we
399 prevent you from setting some parameters which would interfere with
400 parameters that we use.
401
402 The first character of C<param> string must be a C<-> (dash).
403
404 C<value> can be NULL.
405
406 =head2 cp
407
408  cp src dest
409
410 This copies a file from C<src> to C<dest> where C<dest> is
411 either a destination filename or destination directory.
412
413 =head2 cp-a
414
415  cp-a src dest
416
417 This copies a file or directory from C<src> to C<dest>
418 recursively using the C<cp -a> command.
419
420 =head2 debug
421
422  debug subcmd 'extraargs ...'
423
424 The C<debug> command exposes some internals of
425 C<guestfsd> (the guestfs daemon) that runs inside the
426 qemu subprocess.
427
428 There is no comprehensive help for this command.  You have
429 to look at the file C<daemon/debug.c> in the libguestfs source
430 to find out what you can do.
431
432 =head2 download
433
434  download remotefilename (filename|-)
435
436 Download file C<remotefilename> and save it as C<filename>
437 on the local machine.
438
439 C<filename> can also be a named pipe.
440
441 See also C<upload>, C<cat>.
442
443 Use C<-> instead of a filename to read/write from stdin/stdout.
444
445 =head2 exists
446
447  exists path
448
449 This returns C<true> if and only if there is a file, directory
450 (or anything) with the given C<path> name.
451
452 See also C<is-file>, C<is-dir>, C<stat>.
453
454 =head2 file
455
456  file path
457
458 This call uses the standard L<file(1)> command to determine
459 the type or contents of the file.  This also works on devices,
460 for example to find out whether a partition contains a filesystem.
461
462 The exact command which runs is C<file -bsL path>.  Note in
463 particular that the filename is not prepended to the output
464 (the C<-b> option).
465
466 =head2 fsck
467
468  fsck fstype device
469
470 This runs the filesystem checker (fsck) on C<device> which
471 should have filesystem type C<fstype>.
472
473 The returned integer is the status.  See L<fsck(8)> for the
474 list of status codes from C<fsck>.
475
476 Notes:
477
478 =over 4
479
480 =item *
481
482 Multiple status codes can be summed together.
483
484 =item *
485
486 A non-zero return code can mean "success", for example if
487 errors have been corrected on the filesystem.
488
489 =item *
490
491 Checking or repairing NTFS volumes is not supported
492 (by linux-ntfs).
493
494 =back
495
496 This command is entirely equivalent to running C<fsck -a -t fstype device>.
497
498 =head2 get-autosync
499
500  get-autosync
501
502 Get the autosync flag.
503
504 =head2 get-e2label
505
506  get-e2label device
507
508 This returns the ext2/3/4 filesystem label of the filesystem on
509 C<device>.
510
511 =head2 get-e2uuid
512
513  get-e2uuid device
514
515 This returns the ext2/3/4 filesystem UUID of the filesystem on
516 C<device>.
517
518 =head2 get-path
519
520  get-path
521
522 Return the current search path.
523
524 This is always non-NULL.  If it wasn't set already, then this will
525 return the default path.
526
527 =head2 get-qemu
528
529  get-qemu
530
531 Return the current qemu binary.
532
533 This is always non-NULL.  If it wasn't set already, then this will
534 return the default qemu binary name.
535
536 =head2 get-state
537
538  get-state
539
540 This returns the current state as an opaque integer.  This is
541 only useful for printing debug and internal error messages.
542
543 For more information on states, see L<guestfs(3)>.
544
545 =head2 get-verbose
546
547  get-verbose
548
549 This returns the verbose messages flag.
550
551 =head2 grub-install
552
553  grub-install root device
554
555 This command installs GRUB (the Grand Unified Bootloader) on
556 C<device>, with the root directory being C<root>.
557
558 =head2 is-busy
559
560  is-busy
561
562 This returns true iff this handle is busy processing a command
563 (in the C<BUSY> state).
564
565 For more information on states, see L<guestfs(3)>.
566
567 =head2 is-config
568
569  is-config
570
571 This returns true iff this handle is being configured
572 (in the C<CONFIG> state).
573
574 For more information on states, see L<guestfs(3)>.
575
576 =head2 is-dir
577
578  is-dir path
579
580 This returns C<true> if and only if there is a directory
581 with the given C<path> name.  Note that it returns false for
582 other objects like files.
583
584 See also C<stat>.
585
586 =head2 is-file
587
588  is-file path
589
590 This returns C<true> if and only if there is a file
591 with the given C<path> name.  Note that it returns false for
592 other objects like directories.
593
594 See also C<stat>.
595
596 =head2 is-launching
597
598  is-launching
599
600 This returns true iff this handle is launching the subprocess
601 (in the C<LAUNCHING> state).
602
603 For more information on states, see L<guestfs(3)>.
604
605 =head2 is-ready
606
607  is-ready
608
609 This returns true iff this handle is ready to accept commands
610 (in the C<READY> state).
611
612 For more information on states, see L<guestfs(3)>.
613
614 =head2 kill-subprocess
615
616  kill-subprocess
617
618 This kills the qemu subprocess.  You should never need to call this.
619
620 =head2 launch | run
621
622  launch
623
624 Internally libguestfs is implemented by running a virtual machine
625 using L<qemu(1)>.
626
627 You should call this after configuring the handle
628 (eg. adding drives) but before performing any actions.
629
630 =head2 list-devices
631
632  list-devices
633
634 List all the block devices.
635
636 The full block device names are returned, eg. C</dev/sda>
637
638 =head2 list-partitions
639
640  list-partitions
641
642 List all the partitions detected on all block devices.
643
644 The full partition device names are returned, eg. C</dev/sda1>
645
646 This does not return logical volumes.  For that you will need to
647 call C<lvs>.
648
649 =head2 ll
650
651  ll directory
652
653 List the files in C<directory> (relative to the root directory,
654 there is no cwd) in the format of 'ls -la'.
655
656 This command is mostly useful for interactive sessions.  It
657 is I<not> intended that you try to parse the output string.
658
659 =head2 ls
660
661  ls directory
662
663 List the files in C<directory> (relative to the root directory,
664 there is no cwd).  The '.' and '..' entries are not returned, but
665 hidden files are shown.
666
667 This command is mostly useful for interactive sessions.  Programs
668 should probably use C<readdir> instead.
669
670 =head2 lstat
671
672  lstat path
673
674 Returns file information for the given C<path>.
675
676 This is the same as C<stat> except that if C<path>
677 is a symbolic link, then the link is stat-ed, not the file it
678 refers to.
679
680 This is the same as the C<lstat(2)> system call.
681
682 =head2 lvcreate
683
684  lvcreate logvol volgroup mbytes
685
686 This creates an LVM volume group called C<logvol>
687 on the volume group C<volgroup>, with C<size> megabytes.
688
689 =head2 lvm-remove-all
690
691  lvm-remove-all
692
693 This command removes all LVM logical volumes, volume groups
694 and physical volumes.
695
696 B<This command is dangerous.  Without careful use you
697 can easily destroy all your data>.
698
699 =head2 lvremove
700
701  lvremove device
702
703 Remove an LVM logical volume C<device>, where C<device> is
704 the path to the LV, such as C</dev/VG/LV>.
705
706 You can also remove all LVs in a volume group by specifying
707 the VG name, C</dev/VG>.
708
709 =head2 lvs
710
711  lvs
712
713 List all the logical volumes detected.  This is the equivalent
714 of the L<lvs(8)> command.
715
716 This returns a list of the logical volume device names
717 (eg. C</dev/VolGroup00/LogVol00>).
718
719 See also C<lvs-full>.
720
721 =head2 lvs-full
722
723  lvs-full
724
725 List all the logical volumes detected.  This is the equivalent
726 of the L<lvs(8)> command.  The "full" version includes all fields.
727
728 =head2 mkdir
729
730  mkdir path
731
732 Create a directory named C<path>.
733
734 =head2 mkdir-p
735
736  mkdir-p path
737
738 Create a directory named C<path>, creating any parent directories
739 as necessary.  This is like the C<mkdir -p> shell command.
740
741 =head2 mkfs
742
743  mkfs fstype device
744
745 This creates a filesystem on C<device> (usually a partition
746 of LVM logical volume).  The filesystem type is C<fstype>, for
747 example C<ext3>.
748
749 =head2 mount
750
751  mount device mountpoint
752
753 Mount a guest disk at a position in the filesystem.  Block devices
754 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
755 the guest.  If those block devices contain partitions, they will have
756 the usual names (eg. C</dev/sda1>).  Also LVM C</dev/VG/LV>-style
757 names can be used.
758
759 The rules are the same as for L<mount(2)>:  A filesystem must
760 first be mounted on C</> before others can be mounted.  Other
761 filesystems can only be mounted on directories which already
762 exist.
763
764 The mounted filesystem is writable, if we have sufficient permissions
765 on the underlying device.
766
767 The filesystem options C<sync> and C<noatime> are set with this
768 call, in order to improve reliability.
769
770 =head2 mount-options
771
772  mount-options options device mountpoint
773
774 This is the same as the C<mount> command, but it
775 allows you to set the mount options as for the
776 L<mount(8)> I<-o> flag.
777
778 =head2 mount-ro
779
780  mount-ro device mountpoint
781
782 This is the same as the C<mount> command, but it
783 mounts the filesystem with the read-only (I<-o ro>) flag.
784
785 =head2 mount-vfs
786
787  mount-vfs options vfstype device mountpoint
788
789 This is the same as the C<mount> command, but it
790 allows you to set both the mount options and the vfstype
791 as for the L<mount(8)> I<-o> and I<-t> flags.
792
793 =head2 mounts
794
795  mounts
796
797 This returns the list of currently mounted filesystems.  It returns
798 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
799
800 Some internal mounts are not shown.
801
802 =head2 mv
803
804  mv src dest
805
806 This moves a file from C<src> to C<dest> where C<dest> is
807 either a destination filename or destination directory.
808
809 =head2 pvcreate
810
811  pvcreate device
812
813 This creates an LVM physical volume on the named C<device>,
814 where C<device> should usually be a partition name such
815 as C</dev/sda1>.
816
817 =head2 pvremove
818
819  pvremove device
820
821 This wipes a physical volume C<device> so that LVM will no longer
822 recognise it.
823
824 The implementation uses the C<pvremove> command which refuses to
825 wipe physical volumes that contain any volume groups, so you have
826 to remove those first.
827
828 =head2 pvs
829
830  pvs
831
832 List all the physical volumes detected.  This is the equivalent
833 of the L<pvs(8)> command.
834
835 This returns a list of just the device names that contain
836 PVs (eg. C</dev/sda2>).
837
838 See also C<pvs-full>.
839
840 =head2 pvs-full
841
842  pvs-full
843
844 List all the physical volumes detected.  This is the equivalent
845 of the L<pvs(8)> command.  The "full" version includes all fields.
846
847 =head2 read-lines
848
849  read-lines path
850
851 Return the contents of the file named C<path>.
852
853 The file contents are returned as a list of lines.  Trailing
854 C<LF> and C<CRLF> character sequences are I<not> returned.
855
856 Note that this function cannot correctly handle binary files
857 (specifically, files containing C<\0> character which is treated
858 as end of line).  For those you need to use the C<read-file>
859 function which has a more complex interface.
860
861 =head2 rm
862
863  rm path
864
865 Remove the single file C<path>.
866
867 =head2 rm-rf
868
869  rm-rf path
870
871 Remove the file or directory C<path>, recursively removing the
872 contents if its a directory.  This is like the C<rm -rf> shell
873 command.
874
875 =head2 rmdir
876
877  rmdir path
878
879 Remove the single directory C<path>.
880
881 =head2 set-autosync | autosync
882
883  set-autosync true|false
884
885 If C<autosync> is true, this enables autosync.  Libguestfs will make a
886 best effort attempt to run C<umount-all> followed by
887 C<sync> when the handle is closed
888 (also if the program exits without closing handles).
889
890 This is disabled by default (except in guestfish where it is
891 enabled by default).
892
893 =head2 set-e2label
894
895  set-e2label device label
896
897 This sets the ext2/3/4 filesystem label of the filesystem on
898 C<device> to C<label>.  Filesystem labels are limited to
899 16 characters.
900
901 You can use either C<tune2fs-l> or C<get-e2label>
902 to return the existing label on a filesystem.
903
904 =head2 set-e2uuid
905
906  set-e2uuid device uuid
907
908 This sets the ext2/3/4 filesystem UUID of the filesystem on
909 C<device> to C<uuid>.  The format of the UUID and alternatives
910 such as C<clear>, C<random> and C<time> are described in the
911 L<tune2fs(8)> manpage.
912
913 You can use either C<tune2fs-l> or C<get-e2uuid>
914 to return the existing UUID of a filesystem.
915
916 =head2 set-path | path
917
918  set-path path
919
920 Set the path that libguestfs searches for kernel and initrd.img.
921
922 The default is C<$libdir/guestfs> unless overridden by setting
923 C<LIBGUESTFS_PATH> environment variable.
924
925 The string C<path> is stashed in the libguestfs handle, so the caller
926 must make sure it remains valid for the lifetime of the handle.
927
928 Setting C<path> to C<NULL> restores the default path.
929
930 =head2 set-qemu | qemu
931
932  set-qemu qemu
933
934 Set the qemu binary that we will use.
935
936 The default is chosen when the library was compiled by the
937 configure script.
938
939 You can also override this by setting the C<LIBGUESTFS_QEMU>
940 environment variable.
941
942 The string C<qemu> is stashed in the libguestfs handle, so the caller
943 must make sure it remains valid for the lifetime of the handle.
944
945 Setting C<qemu> to C<NULL> restores the default qemu binary.
946
947 =head2 set-verbose | verbose
948
949  set-verbose true|false
950
951 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
952
953 Verbose messages are disabled unless the environment variable
954 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
955
956 =head2 sfdisk
957
958  sfdisk device cyls heads sectors 'lines ...'
959
960 This is a direct interface to the L<sfdisk(8)> program for creating
961 partitions on block devices.
962
963 C<device> should be a block device, for example C</dev/sda>.
964
965 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
966 and sectors on the device, which are passed directly to sfdisk as
967 the I<-C>, I<-H> and I<-S> parameters.  If you pass C<0> for any
968 of these, then the corresponding parameter is omitted.  Usually for
969 'large' disks, you can just pass C<0> for these, but for small
970 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
971 out the right geometry and you will need to tell it.
972
973 C<lines> is a list of lines that we feed to C<sfdisk>.  For more
974 information refer to the L<sfdisk(8)> manpage.
975
976 To create a single partition occupying the whole disk, you would
977 pass C<lines> as a single element list, when the single element being
978 the string C<,> (comma).
979
980 B<This command is dangerous.  Without careful use you
981 can easily destroy all your data>.
982
983 =head2 stat
984
985  stat path
986
987 Returns file information for the given C<path>.
988
989 This is the same as the C<stat(2)> system call.
990
991 =head2 statvfs
992
993  statvfs path
994
995 Returns file system statistics for any mounted file system.
996 C<path> should be a file or directory in the mounted file system
997 (typically it is the mount point itself, but it doesn't need to be).
998
999 This is the same as the C<statvfs(2)> system call.
1000
1001 =head2 sync
1002
1003  sync
1004
1005 This syncs the disk, so that any writes are flushed through to the
1006 underlying disk image.
1007
1008 You should always call this if you have modified a disk image, before
1009 closing the handle.
1010
1011 =head2 tar-in
1012
1013  tar-in (tarfile|-) directory
1014
1015 This command uploads and unpacks local file C<tarfile> (an
1016 I<uncompressed> tar file) into C<directory>.
1017
1018 To upload a compressed tarball, use C<tgz-in>.
1019
1020 Use C<-> instead of a filename to read/write from stdin/stdout.
1021
1022 =head2 tar-out
1023
1024  tar-out directory (tarfile|-)
1025
1026 This command packs the contents of C<directory> and downloads
1027 it to local file C<tarfile>.
1028
1029 To download a compressed tarball, use C<tgz-out>.
1030
1031 Use C<-> instead of a filename to read/write from stdin/stdout.
1032
1033 =head2 tgz-in
1034
1035  tgz-in (tarball|-) directory
1036
1037 This command uploads and unpacks local file C<tarball> (a
1038 I<gzip compressed> tar file) into C<directory>.
1039
1040 To upload an uncompressed tarball, use C<tar-in>.
1041
1042 Use C<-> instead of a filename to read/write from stdin/stdout.
1043
1044 =head2 tgz-out
1045
1046  tgz-out directory (tarball|-)
1047
1048 This command packs the contents of C<directory> and downloads
1049 it to local file C<tarball>.
1050
1051 To download an uncompressed tarball, use C<tar-out>.
1052
1053 Use C<-> instead of a filename to read/write from stdin/stdout.
1054
1055 =head2 touch
1056
1057  touch path
1058
1059 Touch acts like the L<touch(1)> command.  It can be used to
1060 update the timestamps on a file, or, if the file does not exist,
1061 to create a new zero-length file.
1062
1063 =head2 tune2fs-l
1064
1065  tune2fs-l device
1066
1067 This returns the contents of the ext2, ext3 or ext4 filesystem
1068 superblock on C<device>.
1069
1070 It is the same as running C<tune2fs -l device>.  See L<tune2fs(8)>
1071 manpage for more details.  The list of fields returned isn't
1072 clearly defined, and depends on both the version of C<tune2fs>
1073 that libguestfs was built against, and the filesystem itself.
1074
1075 =head2 umount | unmount
1076
1077  umount pathordevice
1078
1079 This unmounts the given filesystem.  The filesystem may be
1080 specified either by its mountpoint (path) or the device which
1081 contains the filesystem.
1082
1083 =head2 umount-all | unmount-all
1084
1085  umount-all
1086
1087 This unmounts all mounted filesystems.
1088
1089 Some internal mounts are not unmounted by this call.
1090
1091 =head2 upload
1092
1093  upload (filename|-) remotefilename
1094
1095 Upload local file C<filename> to C<remotefilename> on the
1096 filesystem.
1097
1098 C<filename> can also be a named pipe.
1099
1100 See also C<download>.
1101
1102 Use C<-> instead of a filename to read/write from stdin/stdout.
1103
1104 =head2 vgcreate
1105
1106  vgcreate volgroup 'physvols ...'
1107
1108 This creates an LVM volume group called C<volgroup>
1109 from the non-empty list of physical volumes C<physvols>.
1110
1111 =head2 vgremove
1112
1113  vgremove vgname
1114
1115 Remove an LVM volume group C<vgname>, (for example C<VG>).
1116
1117 This also forcibly removes all logical volumes in the volume
1118 group (if any).
1119
1120 =head2 vgs
1121
1122  vgs
1123
1124 List all the volumes groups detected.  This is the equivalent
1125 of the L<vgs(8)> command.
1126
1127 This returns a list of just the volume group names that were
1128 detected (eg. C<VolGroup00>).
1129
1130 See also C<vgs-full>.
1131
1132 =head2 vgs-full
1133
1134  vgs-full
1135
1136 List all the volumes groups detected.  This is the equivalent
1137 of the L<vgs(8)> command.  The "full" version includes all fields.
1138
1139 =head2 write-file
1140
1141  write-file path content size
1142
1143 This call creates a file called C<path>.  The contents of the
1144 file is the string C<content> (which can contain any 8 bit data),
1145 with length C<size>.
1146
1147 As a special case, if C<size> is C<0>
1148 then the length is calculated using C<strlen> (so in this case
1149 the content cannot contain embedded ASCII NULs).
1150
1151 Because of the message protocol, there is a transfer limit 
1152 of somewhere between 2MB and 4MB.  To transfer large files you should use
1153 FTP.
1154
1155 =head2 zero
1156
1157  zero device
1158
1159 This command writes zeroes over the first few blocks of C<device>.
1160
1161 How many blocks are zeroed isn't specified (but it's I<not> enough
1162 to securely wipe the device).  It should be sufficient to remove
1163 any partition tables, filesystem superblocks and so on.
1164