guestfish.pod

   1 =encoding utf8
   2
   3 =head1 NAME
   4
   5 guestfish - the libguestfs filesystem interactive shell
   6
   7 =head1 SYNOPSIS
   8
   9  guestfish [--options] [commands]
  10
  11 =head1 EXAMPLES
  12
  13 =head2 From shell scripts
  14
  15 Create a new C</etc/motd> file in a guest:
  16
  17  guestfish <<_EOF_
  18  add disk.img
  19  run
  20  mount /dev/VolGroup00/LogVol00 /
  21  write_file /etc/motd "Hello users" 0
  22  _EOF_
  23
  24 List the LVs in a guest:
  25
  26  guestfish <<_EOF_
  27  add disk.img
  28  run
  29  lvs
  30  _EOF_
  31
  32 =head2 On the command line
  33
  34 List the LVM PVs in a guest image:
  35
  36  guestfish add disk.img : run : pvs
  37
  38 Remove C</boot/grub/menu.lst> (in reality not such a great idea):
  39
  40  guestfish --add disk.img \
  41    --mount /dev/VolGroup00/LogVol00 \
  42    --mount /dev/sda1:/boot \
  43    rm /boot/grub/menu.lst : \
  44    sync : exit
  45
  46 =head2 As an interactive shell
  47
  48  $ guestfish
  49
  50  Welcome to guestfish, the libguestfs filesystem interactive shell for
  51  editing virtual machine filesystems.
  52
  53  Type: 'help' for help with commands
  54        'quit' to quit the shell
  55
  56  ><fs> help
  57
  58 =head1 DESCRIPTION
  59
  60 Guestfish is a shell and command-line tool for examining and modifying
  61 virtual machine filesystems.  It uses libguestfs and exposes all of
  62 the functionality of the guestfs API, see L<guestfs(3)>.
  63
  64 =head1 OPTIONS
  65
  66 =over 4
  67
  68 =item B<--help>
  69
  70 Displays general help on options.
  71
  72 =item B<-h> | B<--cmd-help>
  73
  74 Lists all available guestfish commands.
  75
  76 =item B<-h cmd> | B<--cmd-help cmd>
  77
  78 Displays detailed help on a single command C<cmd>.
  79
  80 =item B<-a image> | B<--add image>
  81
  82 Add a block device or virtual machine image to the shell.
  83
  84 =item B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>
  85
  86 Mount the named partition or logical volume on the given mountpoint.
  87
  88 If the mountpoint is omitted, it defaults to C</>.
  89
  90 You have to mount something on C</> before most commands will work.
  91
  92 If any C<-m> or C<--mount> options are given, the guest is
  93 automatically launched.
  94
  95 =item B<-n> | B<--no-sync>
  96
  97 Disable autosync.  This is enabled by default.  See the discussion
  98 of autosync in the L<guestfs(3)> manpage.
  99
 100 =item B<-r> | B<--ro>
 101
 102 This changes the C<-m> option so that mounts are done read-only
 103 (see C<guestfs_mount_ro> in the L<guestfs(3)> manpage).
 104
 105 =item B<-v> | B<--verbose>
 106
 107 Enable very verbose messages.  This is particularly useful if you find
 108 a bug.
 109
 110 =item B<-D> | B<--no-dest-paths>
 111
 112 Don't tab-complete paths on the guest filesystem.  It is useful to be
 113 able to hit the tab key to complete paths on the guest filesystem, but
 114 this causes extra "hidden" guestfs calls to be made, so this option is
 115 here to allow this feature to be disabled.
 116
 117 =back
 118
 119 =head1 COMMANDS ON COMMAND LINE
 120
 121 Any additional (non-option) arguments are treated as commands to
 122 execute.
 123
 124 Commands to execute should be separated by a colon (C<:>), where the
 125 colon is a separate parameter.  Thus:
 126
 127  guestfish cmd [args...] : cmd [args...] : cmd [args...] ...
 128
 129 If there are no additional arguments, then we enter a shell, either an
 130 interactive shell with a prompt (if the input is a terminal) or a
 131 non-interactive shell.
 132
 133 In either command line mode or non-interactive shell, the first
 134 command that gives an error causes the whole shell to exit.  In
 135 interactive mode (with a prompt) if a command fails, you can continue
 136 to enter commands.
 137
 138 =head1 USING launch (OR run)
 139
 140 As with L<guestfs(3)>, you must first configure your guest by adding
 141 disks, then launch it, then mount any disks you need, and finally
 142 issue actions/commands.  So the general order of the day is:
 143
 144 =over 4
 145
 146 =item *
 147
 148 add or -a/--add
 149
 150 =item *
 151
 152 launch (aka run)
 153
 154 =item *
 155
 156 mount or -m/--mount
 157
 158 =item *
 159
 160 any other commands
 161
 162 =back
 163
 164 C<run> is a synonym for C<launch>.  You must C<launch> (or C<run>)
 165 your guest before mounting or performing any other commands.
 166
 167 The only exception is that if the C<-m> or C<--mount> option was
 168 given, the guest is automatically run for you (simply because
 169 guestfish can't mount the disks you asked for without doing this).
 170
 171 =head1 QUOTING
 172
 173 You can quote ordinary parameters using either single or double
 174 quotes.  For example:
 175
 176  add "file with a space.img"
 177
 178  rm '/file name'
 179
 180  rm '/"'
 181
 182 A few commands require a list of strings to be passed.  For these, use
 183 a space-separated list, enclosed in quotes.  For example:
 184
 185  vgcreate VG "/dev/sda1 /dev/sdb1"
 186
 187 =head1 COMMENTS
 188
 189 Any line which starts with a I<#> character is treated as a comment
 190 and ignored.  The I<#> can optionally be preceeded by whitespace,
 191 but B<not> by a command.  For example:
 192
 193  # this is a comment
 194          # this is a comment
 195  foo # NOT a comment
 196
 197 Blank lines are also ignored.
 198
 199 =head1 RUNNING COMMANDS LOCALLY
 200
 201 Any line which starts with a I<!> character is treated as a command
 202 sent to the local shell (C</bin/sh> or whatever L<system(3)> uses).
 203 For example:
 204
 205  !mkdir local
 206  tgz-out /remote local/remote-data.tar.gz
 207
 208 will create a directory C<local> on the host, and then export
 209 the contents of C</remote> on the mounted filesystem to
 210 C<local/remote-data.tar.gz>.  (See C<tgz-out>).
 211
 212 =head1 EXIT ON ERROR BEHAVIOUR
 213
 214 By default, guestfish will ignore any errors when in interactive mode
 215 (ie. taking commands from a human over a tty), and will exit on the
 216 first error in non-interactive mode (scripts, commands given on the
 217 command line).
 218
 219 If you prefix a command with a I<-> character, then that command will
 220 not cause guestfish to exit, even if that (one) command returns an
 221 error.
 222
 223 =head1 COMMANDS
 224
 225 =head2 help
 226
 227  help
 228  help cmd
 229
 230 Without any parameter, this lists all commands.  With a C<cmd>
 231 parameter, this displays detailed help for a command.
 232
 233 =head2 quit | exit
 234
 235 This exits guestfish.  You can also use C<^D> key.
 236
 237 =head2 alloc | allocate
 238
 239  alloc filename size
 240
 241 This creates an empty (zeroed) file of the given size, and then adds
 242 so it can be further examined.
 243
 244 For more advanced image creation, see L<qemu-img(1)> utility.
 245
 246 Size can be specified (where C<nn> means a number):
 247
 248 =over 4
 249
 250 =item C<nn> or C<nn>K or C<nn>KB
 251
 252 number of kilobytes, eg: C<1440> = standard 3.5in floppy
 253
 254 =item C<nn>M or C<nn>MB
 255
 256 number of megabytes
 257
 258 =item C<nn>G or C<nn>GB
 259
 260 number of gigabytes
 261
 262 =item C<nn>sects
 263
 264 number of 512 byte sectors
 265
 266 =back
 267
 268 =head2 echo
 269
 270  echo [params ...]
 271
 272 This echos the parameters to the terminal.
 273
 274 =head2 edit | vi | emacs
 275
 276  edit filename
 277
 278 This is used to edit a file.  It downloads the file, edits it
 279 locally using your editor, then uploads the result.
 280
 281 The editor is C<$EDITOR>.  However if you use the alternate
 282 commands C<vi> or C<emacs> you will get those corresponding
 283 editors.
 284
 285 NOTE: This will not work reliably for large files
 286 (> 2 MB) or binary files containing \0 bytes.
 287
 288 =head2 lcd
 289
 290  lcd directory
 291
 292 Change the local directory, ie. the current directory of guestfish
 293 itself.
 294
 295 Note that C<!cd> won't do what you might expect.
 296
 297 @ACTIONS@
 298
 299 =head1 ENVIRONMENT VARIABLES
 300
 301 =over 4
 302
 303 =item LIBGUESTFS_DEBUG
 304
 305 Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages.  This has the
 306 same effect as using the B<-v> option.
 307
 308 =item LIBGUESTFS_PATH
 309
 310 Set the path that guestfish uses to search for kernel and initrd.img.
 311 See the discussion of paths in L<guestfs(3)>.
 312
 313 =item LIBGUESTFS_QEMU
 314
 315 Set the default qemu binary that libguestfs uses.  If not set, then
 316 the qemu which was found at compile time by the configure script is
 317 used.
 318
 319 =item LIBGUESTFS_APPEND
 320
 321 Pass additional options to the guest kernel.
 322
 323 =item HOME
 324
 325 If compiled with GNU readline support, then the command history
 326 is saved in C<$HOME/.guestfish>
 327
 328 =item EDITOR
 329
 330 The C<edit> command uses C<$EDITOR> as the editor.  If not
 331 set, it uses C<vi>.
 332
 333 =back
 334
 335 =head1 EXIT CODE
 336
 337 guestfish returns I<0> if the commands completed without error, or
 338 I<1> if there was an error.
 339
 340 =head1 SEE ALSO
 341
 342 L<guestfs(3)>,
 343 L<http://libguestfs.org/>.
 344
 345 =head1 AUTHORS
 346
 347 Richard W.M. Jones (C<rjones at redhat dot com>)
 348
 349 =head1 COPYRIGHT
 350
 351 Copyright (C) 2009 Red Hat Inc.
 352 L<http://libguestfs.org/>
 353
 354 This program is free software; you can redistribute it and/or modify
 355 it under the terms of the GNU General Public License as published by
 356 the Free Software Foundation; either version 2 of the License, or
 357 (at your option) any later version.
 358
 359 This program is distributed in the hope that it will be useful,
 360 but WITHOUT ANY WARRANTY; without even the implied warranty of
 361 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 362 GNU General Public License for more details.
 363
 364 You should have received a copy of the GNU General Public License
 365 along with this program; if not, write to the Free Software
 366 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.