5 guestfish - the libguestfs Filesystem Interactive SHell
9 guestfish [--options] [commands]
13 guestfish [--ro|--rw] -a disk.img
15 guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]
17 guestfish -d libvirt-domain
19 guestfish [--ro|--rw] -a disk.img -i
21 guestfish -d libvirt-domain -i
25 Using guestfish in read/write mode on live virtual machines can be
26 dangerous, potentially causing disk corruption. Use the I<--ro>
27 (read-only) option to use guestfish safely if the disk image or
28 virtual machine might be live.
32 Guestfish is a shell and command-line tool for examining and modifying
33 virtual machine filesystems. It uses libguestfs and exposes all of
34 the functionality of the guestfs API, see L<guestfs(3)>.
36 Guestfish gives you structured access to the libguestfs API, from
37 shell scripts or the command line or interactively. If you want to
38 rescue a broken virtual machine image, you should look at the
39 L<virt-rescue(1)> command.
43 =head2 As an interactive shell
47 Welcome to guestfish, the libguestfs filesystem interactive shell for
48 editing virtual machine filesystems.
50 Type: 'help' for a list of commands
51 'man' to read the manual
52 'quit' to quit the shell
56 ><fs> list-filesystems
58 /dev/vg_guest/lv_root: ext4
59 /dev/vg_guest/lv_swap: swap
60 ><fs> mount /dev/vg_guest/lv_root /
67 =head2 From shell scripts
69 Create a new C</etc/motd> file in a guest or disk image:
74 mount /dev/vg_guest/lv_root /
75 write /etc/motd "Welcome, new users"
78 List the LVM logical volumes in a disk image:
80 guestfish -a disk.img --ro <<_EOF_
85 List all the filesystems in a disk image:
87 guestfish -a disk.img --ro <<_EOF_
92 =head2 On one command line
94 Update C</etc/resolv.conf> in a guest:
97 add disk.img : run : mount /dev/vg_guest/lv_root / : \
98 write /etc/resolv.conf "nameserver 1.2.3.4"
100 Edit C</boot/grub/grub.conf> interactively:
102 guestfish --rw --add disk.img \
103 --mount /dev/vg_guest/lv_root \
104 --mount /dev/sda1:/boot \
105 edit /boot/grub/grub.conf
107 =head2 Mount disks automatically
109 Use the I<-i> option to automatically mount the
110 disks from a virtual machine:
112 guestfish --ro -a disk.img -i cat /etc/group
114 guestfish --ro -d libvirt-domain -i cat /etc/group
116 Another way to edit C</boot/grub/grub.conf> interactively is:
118 guestfish --rw -a disk.img -i edit /boot/grub/grub.conf
120 =head2 As a script interpreter
122 Create a 100MB disk containing an ext2-formatted partition:
124 #!/usr/bin/guestfish -f
125 sparse test1.img 100M
127 part-disk /dev/sda mbr
130 =head2 Start with a prepared disk
132 An alternate way to create a 100MB disk called C<test1.img> containing
133 a single ext2-formatted partition:
137 To list what is available do:
139 guestfish -N help | less
141 =head2 Remote control
143 eval "`guestfish --listen`"
144 guestfish --remote add-ro disk.img
145 guestfish --remote run
146 guestfish --remote lvs
154 Displays general help on options.
160 Lists all available guestfish commands.
164 =item B<--cmd-help cmd>
166 Displays detailed help on a single command C<cmd>.
172 Add a block device or virtual machine image to the shell.
174 The format of the disk image is auto-detected. To override this and
175 force a particular format use the I<--format=..> option.
177 Using this flag is mostly equivalent to using the C<add> command,
178 with C<readonly:true> if the I<--ro> flag was given, and
179 with C<format:...> if the I<--format:...> flag was given.
183 =item B<--connect URI>
185 When used in conjunction with the I<-d> option, this specifies
186 the libvirt URI to use. The default is to use the default libvirt
191 If using the I<--listen> option and a csh-like shell, use this option.
192 See section L</REMOTE CONTROL AND CSH> below.
194 =item B<-d libvirt-domain>
196 =item B<--domain libvirt-domain>
198 Add disks from the named libvirt domain. If the I<--ro> option is
199 also used, then any libvirt domain can be used. However in write
200 mode, only libvirt domains which are shut down can be named here.
202 Using this flag is mostly equivalent to using the C<add-domain> command,
203 with C<readonly:true> if the I<--ro> flag was given, and
204 with C<format:...> if the I<--format:...> flag was given.
208 =item B<--no-dest-paths>
210 Don't tab-complete paths on the guest filesystem. It is useful to be
211 able to hit the tab key to complete paths on the guest filesystem, but
212 this causes extra "hidden" guestfs calls to be made, so this option is
213 here to allow this feature to be disabled.
217 When prompting for keys and passphrases, guestfish normally turns
218 echoing off so you cannot see what you are typing. If you are not
219 worried about Tempest attacks and there is no one else in the room
220 you can specify this flag to see what you are typing.
226 Read commands from C<file>. To write pure guestfish
229 #!/usr/bin/guestfish -f
231 =item B<--format=raw|qcow2|..>
235 The default for the I<-a> option is to auto-detect the format of the
236 disk image. Using this forces the disk format for I<-a> options which
237 follow on the command line. Using I<--format> with no argument
238 switches back to auto-detection for subsequent I<-a> options.
242 guestfish --format=raw -a disk.img
244 forces raw format (no auto-detection) for C<disk.img>.
246 guestfish --format=raw -a disk.img --format -a another.img
248 forces raw format (no auto-detection) for C<disk.img> and reverts to
249 auto-detection for C<another.img>.
251 If you have untrusted raw-format guest disk images, you should use
252 this option to specify the disk format. This avoids a possible
253 security problem with malicious guests (CVE-2010-3851). See also
260 Using L<virt-inspector(1)> code, inspect the disks looking for
261 an operating system and mount filesystems as they would be
262 mounted on the real virtual machine.
264 Typical usage is either:
266 guestfish -d myguest -i
268 (for an inactive libvirt domain called I<myguest>), or:
270 guestfish --ro -d myguest -i
272 (for active domains, readonly), or specify the block device directly:
274 guestfish --rw -a /dev/Guests/MyGuest -i
276 Note that the command line syntax changed slightly over older
277 versions of guestfish. You can still use the old syntax:
279 guestfish [--ro] -i disk.img
281 guestfish [--ro] -i libvirt-domain
283 Using this flag is mostly equivalent to using the C<inspect-os>
284 command and then using other commands to mount the filesystems that
287 =item B<--keys-from-stdin>
289 Read key or passphrase parameters from stdin. The default is
290 to try to read passphrases from the user by opening C</dev/tty>.
294 Fork into the background and listen for remote commands. See section
295 L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below.
297 =item B<-m dev[:mountpoint]>
299 =item B<--mount dev[:mountpoint]>
301 Mount the named partition or logical volume on the given mountpoint.
303 If the mountpoint is omitted, it defaults to C</>.
305 You have to mount something on C</> before most commands will work.
307 If any I<-m> or I<--mount> options are given, the guest is
308 automatically launched.
310 If you don't know what filesystems a disk image contains, you can
311 either run guestfish without this option, then list the partitions,
312 filesystems and LVs available (see L</list-partitions>,
313 L</list-filesystems> and L</lvs> commands), or you can use the
314 L<virt-filesystems(1)> program.
316 Using this flag is mostly equivalent to using the C<mount-options>
317 command or the C<mount-ro> command if the I<--ro> flag was given.
323 Disable autosync. This is enabled by default. See the discussion
324 of autosync in the L<guestfs(3)> manpage.
332 Prepare a fresh disk image formatted as "type". This is an
333 alternative to the I<-a> option: whereas I<-a> adds an existing disk,
334 I<-N> creates a preformatted disk with a filesystem and adds it.
335 See L</PREPARED DISK IMAGES> below.
337 =item B<--progress-bars>
339 Enable progress bars, even when guestfish is used non-interactively.
341 Progress bars are enabled by default when guestfish is used as an
344 =item B<--no-progress-bars>
346 Disable progress bars.
348 =item B<--remote[=pid]>
350 Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section
351 L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below.
357 This changes the I<-a> and I<-m> options so that disks are added and
358 mounts are done read-only (see L<guestfs(3)/guestfs_mount_ro>).
360 The option must always be used if the disk image or virtual machine
361 might be running, and is generally recommended in cases where you
362 don't need write access to the disk.
364 Note that prepared disk images created with I<-N> are not affected by
367 See also L</OPENING DISKS FOR READ AND WRITE> below.
371 Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>.
377 Enable very verbose messages. This is particularly useful if you find
384 Display the guestfish / libguestfs version number and exit.
390 This option does nothing at the moment.
391 See L</OPENING DISKS FOR READ AND WRITE> below.
395 Echo each command before executing it.
399 =head1 COMMANDS ON COMMAND LINE
401 Any additional (non-option) arguments are treated as commands to
404 Commands to execute should be separated by a colon (C<:>), where the
405 colon is a separate parameter. Thus:
407 guestfish cmd [args...] : cmd [args...] : cmd [args...] ...
409 If there are no additional arguments, then we enter a shell, either an
410 interactive shell with a prompt (if the input is a terminal) or a
411 non-interactive shell.
413 In either command line mode or non-interactive shell, the first
414 command that gives an error causes the whole shell to exit. In
415 interactive mode (with a prompt) if a command fails, you can continue
418 =head1 USING launch (OR run)
420 As with L<guestfs(3)>, you must first configure your guest by adding
421 disks, then launch it, then mount any disks you need, and finally
422 issue actions/commands. So the general order of the day is:
444 C<run> is a synonym for C<launch>. You must C<launch> (or C<run>)
445 your guest before mounting or performing any other commands.
447 The only exception is that if any of the I<-i>, I<-m>, I<--mount>,
448 I<-N> or I<--new> options were given then C<run> is done
449 automatically, simply because guestfish can't perform the action you
450 asked for without doing this.
452 =head1 OPENING DISKS FOR READ AND WRITE
454 The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw>
455 affect whether the other command line options I<-a>, I<-c>, I<-d>,
456 I<-i> and I<-m> open disk images read-only or for writing.
458 In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to
459 opening disk images supplied on the command line for write. To open a
460 disk image read-only you have to do I<-a image --ro>.
462 This matters: If you accidentally open a live VM disk image writable
463 then you will cause irreversible disk corruption.
465 By libguestfs 1.8 we intend to change the default the other way. Disk
466 images will be opened read-only. You will have to either specify
467 I<guestfish --rw> or change a configuration file in order to get write
468 access for disk images specified by those other command line options.
470 This version of guestfish has a I<--rw> option which does nothing (it
471 is already the default). However it is highly recommended that you
472 use this option to indicate that guestfish needs write access, and to
473 prepare your scripts for the day when this option will be required for
476 B<Note:> This does I<not> affect commands like L</add> and L</mount>,
477 or any other libguestfs program apart from guestfish and guestmount.
481 You can quote ordinary parameters using either single or double
484 add "file with a space.img"
490 A few commands require a list of strings to be passed. For these, use
491 a whitespace-separated list, enclosed in quotes. Strings containing whitespace
492 to be passed through must be enclosed in single quotes. A literal single quote
493 must be escaped with a backslash.
495 vgcreate VG "/dev/sda1 /dev/sdb1"
496 command "/bin/echo 'foo bar'"
497 command "/bin/echo \'foo\'"
499 =head1 OPTIONAL ARGUMENTS
501 Some commands take optional arguments. These arguments appear in this
502 documentation as C<[argname:..]>. You can use them as in these
505 add-drive-opts filename
507 add-drive-opts filename readonly:true
509 add-drive-opts filename format:qcow2 readonly:false
511 Each optional argument can appear at most once. All optional
512 arguments must appear after the required ones.
516 This section applies to all commands which can take integers
521 When the command takes a parameter measured in bytes, you can use one
522 of the following suffixes to specify kilobytes, megabytes and larger
527 =item B<k> or B<K> or B<KiB>
529 The size in kilobytes (multiplied by 1024).
533 The size in SI 1000 byte units.
537 The size in megabytes (multiplied by 1048576).
541 The size in SI 1000000 byte units.
545 The size in gigabytes (multiplied by 2**30).
549 The size in SI 10**9 byte units.
553 The size in terabytes (multiplied by 2**40).
557 The size in SI 10**12 byte units.
561 The size in petabytes (multiplied by 2**50).
565 The size in SI 10**15 byte units.
569 The size in exabytes (multiplied by 2**60).
573 The size in SI 10**18 byte units.
577 The size in zettabytes (multiplied by 2**70).
581 The size in SI 10**21 byte units.
585 The size in yottabytes (multiplied by 2**80).
589 The size in SI 10**24 byte units.
595 truncate-size /file 1G
597 would truncate the file to 1 gigabyte.
599 Be careful because a few commands take sizes in kilobytes or megabytes
600 (eg. the parameter to L</memsize> is specified in megabytes already).
601 Adding a suffix will probably not do what you expect.
603 =head2 OCTAL AND HEXADECIMAL NUMBERS
605 For specifying the radix (base) use the C convention: C<0> to prefix
606 an octal number or C<0x> to prefix a hexadecimal number. For example:
608 1234 decimal number 1234
609 02322 octal number, equivalent to decimal 1234
610 0x4d2 hexadecimal number, equivalent to decimal 1234
612 When using the C<chmod> command, you almost always want to specify an
613 octal number for the mode, and you must prefix it with C<0> (unlike
614 the Unix L<chmod(1)> program):
616 chmod 0777 /public # OK
617 chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.
619 Commands that return numbers usually print them in decimal, but
620 some commands print numbers in other radices (eg. C<umask> prints
621 the mode in octal, preceeded by C<0>).
623 =head1 WILDCARDS AND GLOBBING
625 Neither guestfish nor the underlying guestfs API performs
626 wildcard expansion (globbing) by default. So for example the
627 following will not do what you expect:
631 Assuming you don't have a directory called literally C</home/*>
632 then the above command will return an error.
634 To perform wildcard expansion, use the C<glob> command.
638 runs C<rm-rf> on each path that matches (ie. potentially running
639 the command many times), equivalent to:
645 C<glob> only works on simple guest paths and not on device names.
647 If you have several parameters, each containing a wildcard, then glob
648 will perform a Cartesian product.
652 Any line which starts with a I<#> character is treated as a comment
653 and ignored. The I<#> can optionally be preceeded by whitespace,
654 but B<not> by a command. For example:
660 Blank lines are also ignored.
662 =head1 RUNNING COMMANDS LOCALLY
664 Any line which starts with a I<!> character is treated as a command
665 sent to the local shell (C</bin/sh> or whatever L<system(3)> uses).
669 tgz-out /remote local/remote-data.tar.gz
671 will create a directory C<local> on the host, and then export
672 the contents of C</remote> on the mounted filesystem to
673 C<local/remote-data.tar.gz>. (See C<tgz-out>).
675 To change the local directory, use the C<lcd> command. C<!cd> will
676 have no effect, due to the way that subprocesses work in Unix.
680 Use C<command E<lt>spaceE<gt> | command> to pipe the output of the
681 first command (a guestfish command) to the second command (any host
682 command). For example:
684 cat /etc/passwd | awk -F: '$3 == 0 { print }'
686 (where C<cat> is the guestfish cat command, but C<awk> is the host awk
687 program). The above command would list all accounts in the guest
688 filesystem which have UID 0, ie. root accounts including backdoors.
691 hexdump /bin/ls | head
692 list-devices | tail -1
693 tgz-out / - | tar ztf -
695 The space before the pipe symbol is required, any space after the pipe
696 symbol is optional. Everything after the pipe symbol is just passed
697 straight to the host shell, so it can contain redirections, globs and
698 anything else that makes sense on the host side.
700 To use a literal argument which begins with a pipe symbol, you have
705 =head1 HOME DIRECTORIES
707 If a parameter starts with the character C<~> then the tilde may be
708 expanded as a home directory path (either C<~> for the current user's
709 home directory, or C<~user> for another user).
711 Note that home directory expansion happens for users known I<on the
712 host>, not in the guest filesystem.
714 To use a literal argument which begins with a tilde, you have to quote
719 =head1 ENCRYPTED DISKS
721 Libguestfs has some support for Linux guests encrypted according to
722 the Linux Unified Key Setup (LUKS) standard, which includes nearly all
723 whole disk encryption systems used by modern Linux guests. Currently
724 only LVM-on-LUKS is supported.
726 Identify encrypted block devices and partitions using L</vfs-type>:
728 ><fs> vfs-type /dev/sda2
731 Then open those devices using L</luks-open>. This creates a
732 device-mapper device called C</dev/mapper/luksdev>.
734 ><fs> luks-open /dev/sda2 luksdev
735 Enter key or passphrase ("key"): <enter the passphrase>
737 Finally you have to tell LVM to scan for volume groups on
738 the newly created mapper device:
743 The logical volume(s) can now be mounted in the usual way.
745 Before closing a LUKS device you must unmount any logical volumes on
746 it and deactivate the volume groups by calling C<vg-activate false VG>
747 on each one. Then you can close the mapper device:
749 vg-activate false /dev/VG
750 luks-close /dev/mapper/luksdev
754 If a path is prefixed with C<win:> then you can use Windows-style
755 paths (with some limitations). The following commands are equivalent:
757 file /WINDOWS/system32/config/system.LOG
759 file win:/windows/system32/config/system.log
761 file win:\windows\system32\config\system.log
763 file WIN:C:\Windows\SYSTEM32\conFIG\SYSTEM.LOG
765 This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also
766 handles case insensitivity like Windows would. This only works in
767 argument positions that expect a path.
769 =head1 UPLOADING AND DOWNLOADING FILES
771 For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and
772 others which upload from or download to a local file, you can use the
773 special filename C<-> to mean "from stdin" or "to stdout". For example:
777 reads stdin and creates from that a file C</foo> in the disk image,
780 tar-out /etc - | tar tf -
782 writes the tarball to stdout and then pipes that into the external
783 "tar" command (see L</PIPES>).
785 When using C<-> to read from stdin, the input is read up to the end of
786 stdin. You can also use a special "heredoc"-like syntax to read up to
787 some arbitrary end marker:
795 Any string of characters can be used instead of C<END>. The end
796 marker must appear on a line of its own, without any preceeding or
797 following characters (not even spaces).
799 Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to
800 upload local files (so-called "FileIn" parameters in the generator).
802 =head1 EXIT ON ERROR BEHAVIOUR
804 By default, guestfish will ignore any errors when in interactive mode
805 (ie. taking commands from a human over a tty), and will exit on the
806 first error in non-interactive mode (scripts, commands given on the
809 If you prefix a command with a I<-> character, then that command will
810 not cause guestfish to exit, even if that (one) command returns an
813 =head1 REMOTE CONTROL GUESTFISH OVER A SOCKET
815 Guestfish can be remote-controlled over a socket. This is useful
816 particularly in shell scripts where you want to make several different
817 changes to a filesystem, but you don't want the overhead of starting
818 up a guestfish process each time.
820 Start a guestfish server process using:
822 eval "`guestfish --listen`"
824 and then send it commands by doing:
826 guestfish --remote cmd [...]
828 To cause the server to exit, send it the exit command:
830 guestfish --remote exit
832 Note that the server will normally exit if there is an error in a
833 command. You can change this in the usual way. See section
834 L</EXIT ON ERROR BEHAVIOUR>.
836 =head2 CONTROLLING MULTIPLE GUESTFISH PROCESSES
838 The C<eval> statement sets the environment variable C<$GUESTFISH_PID>,
839 which is how the I<--remote> option knows where to send the commands.
840 You can have several guestfish listener processes running using:
842 eval "`guestfish --listen`"
844 eval "`guestfish --listen`"
847 guestfish --remote=$pid1 cmd
848 guestfish --remote=$pid2 cmd
850 =head2 REMOTE CONTROL AND CSH
852 When using csh-like shells (csh, tcsh etc) you have to add the
855 eval "`guestfish --listen --csh`"
857 =head2 REMOTE CONTROL DETAILS
859 Remote control happens over a Unix domain socket called
860 C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective
861 user ID of the process, and C<$PID> is the process ID of the server.
863 Guestfish client and server versions must match exactly.
865 =head1 PREPARED DISK IMAGES
867 Use the I<-N type> or I<--new type> parameter to select one of a set
868 of preformatted disk images that guestfish can make for you to save
869 typing. This is particularly useful for testing purposes. This
870 option is used instead of the I<-a> option, and like I<-a> can appear
871 multiple times (and can be mixed with I<-a>).
873 The new disk is called C<test1.img> for the first I<-N>, C<test2.img>
874 for the second and so on. Existing files in the current directory are
877 The type briefly describes how the disk should be sized, partitioned,
878 how filesystem(s) should be created, and how content should be added.
879 Optionally the type can be followed by extra parameters, separated by
880 C<:> (colon) characters. For example, I<-N fs> creates a default
881 100MB, sparsely-allocated disk, containing a single partition, with
882 the partition formatted as ext2. I<-N fs:ext4:1G> is the same, but
883 for an ext4 filesystem on a 1GB disk instead.
885 To list the available types and any extra parameters they take, run:
887 guestfish -N help | less
889 Note that the prepared filesystem is not mounted. You would usually
890 have to use the C<mount /dev/sda1 /> command or add the
891 I<-m /dev/sda1> option.
893 If any I<-N> or I<--new> options are given, the guest is automatically
898 Create a 100MB disk with an ext4-formatted partition:
902 Create a 32MB disk with a VFAT-formatted partition, and mount it:
904 guestfish -N fs:vfat:32M -m /dev/sda1
906 Create a blank 200MB disk:
908 guestfish -N disk:200M
912 Some (not all) long-running commands send progress notification
913 messages as they are running. Guestfish turns these messages into
916 When a command that supports progress bars takes longer than two
917 seconds to run, and if progress bars are enabled, then you will see
918 one appearing below the command:
920 ><fs> copy-size /large-file /another-file 2048M
921 / 10% [#####-----------------------------------------] 00:30
923 The spinner on the left hand side moves round once for every progress
924 notification received from the backend. This is a (reasonably) golden
925 assurance that the command is "doing something" even if the progress
926 bar is not moving, because the command is able to send the progress
927 notifications. When the bar reaches 100% and the command finishes,
928 the spinner disappears.
930 Progress bars are enabled by default when guestfish is used
931 interactively. You can enable them even for non-interactive modes
932 using I<--progress-bars>, and you can disable them completely using
933 I<--no-progress-bars>.
935 =head1 GUESTFISH COMMANDS
937 The commands in this section are guestfish convenience commands, in
938 other words, they are not part of the L<guestfs(3)> API.
945 Without any parameter, this provides general help.
947 With a C<cmd> parameter, this displays detailed help for that command.
951 This exits guestfish. You can also use C<^D> key.
961 guestfish returns 0 if the commands completed without error, or
962 1 if there was an error.
964 =head1 ENVIRONMENT VARIABLES
970 The C<edit> command uses C<$EDITOR> as the editor. If not
975 Used with the I<--remote> option to specify the remote guestfish
976 process to control. See section
977 L</REMOTE CONTROL GUESTFISH OVER A SOCKET>.
981 The L</hexedit> command uses C<$HEXEDITOR> as the external hex
982 editor. If not specified, the external L<hexedit(1)> program
987 If compiled with GNU readline support, various files in the
988 home directory can be used. See L</FILES>.
990 =item LIBGUESTFS_APPEND
992 Pass additional options to the guest kernel.
994 =item LIBGUESTFS_DEBUG
996 Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the
997 same effect as using the B<-v> option.
999 =item LIBGUESTFS_MEMSIZE
1001 Set the memory allocated to the qemu process, in megabytes. For
1004 LIBGUESTFS_MEMSIZE=700
1006 =item LIBGUESTFS_PATH
1008 Set the path that guestfish uses to search for kernel and initrd.img.
1009 See the discussion of paths in L<guestfs(3)>.
1011 =item LIBGUESTFS_QEMU
1013 Set the default qemu binary that libguestfs uses. If not set, then
1014 the qemu which was found at compile time by the configure script is
1017 =item LIBGUESTFS_TRACE
1019 Set C<LIBGUESTFS_TRACE=1> to enable command traces.
1023 The C<more> command uses C<$PAGER> as the pager. If not
1024 set, it uses C<more>.
1028 Location of temporary directory, defaults to C</tmp>.
1030 If libguestfs was compiled to use the supermin appliance then the
1031 real appliance is cached in this directory, shared between all
1032 handles belonging to the same EUID. You can use C<$TMPDIR> to
1033 configure another directory to use in case C</tmp> is not large
1042 =item $HOME/.guestfish
1044 If compiled with GNU readline support, then the command history
1045 is saved in this file.
1047 =item $HOME/.inputrc
1051 If compiled with GNU readline support, then these files can be used to
1052 configure readline. For further information, please see
1053 L<readline(3)/INITIALIZATION FILE>.
1055 To write rules which only apply to guestfish, use:
1061 Variables that you can set in inputrc that change the behaviour
1062 of guestfish in useful ways include:
1066 =item completion-ignore-case (default: on)
1068 By default, guestfish will ignore case when tab-completing
1069 paths on the disk. Use:
1071 set completion-ignore-case off
1073 to make guestfish case sensitive.
1079 =item test2.img (etc)
1081 When using the C<-N> or C<--new> option, the prepared disk or
1082 filesystem will be created in the file C<test1.img> in the current
1083 directory. The second use of C<-N> will use C<test2.img> and so on.
1084 Any existing file with the same name will be overwritten.
1091 L<http://libguestfs.org/>,
1095 L<virt-filesystems(1)>,
1096 L<virt-inspector(1)>,
1097 L<virt-list-filesystems(1)>,
1098 L<virt-list-partitions(1)>,
1109 Richard W.M. Jones (C<rjones at redhat dot com>)
1113 Copyright (C) 2009-2010 Red Hat Inc.
1114 L<http://libguestfs.org/>
1116 This program is free software; you can redistribute it and/or modify
1117 it under the terms of the GNU General Public License as published by
1118 the Free Software Foundation; either version 2 of the License, or
1119 (at your option) any later version.
1121 This program is distributed in the hope that it will be useful,
1122 but WITHOUT ANY WARRANTY; without even the implied warranty of
1123 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1124 GNU General Public License for more details.
1126 You should have received a copy of the GNU General Public License
1127 along with this program; if not, write to the Free Software
1128 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.