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  guestfish -i libvirt-domain
  12
  13  guestfish -i disk-image(s)
  14
  15 =head1 EXAMPLES
  16
  17 =head2 From shell scripts
  18
  19 Create a new C</etc/motd> file in a guest:
  20
  21  guestfish <<_EOF_
  22  add disk.img
  23  run
  24  mount /dev/VolGroup00/LogVol00 /
  25  write_file /etc/motd "Hello users" 0
  26  _EOF_
  27
  28 List the LVs in a guest:
  29
  30  guestfish <<_EOF_
  31  add disk.img
  32  run
  33  lvs
  34  _EOF_
  35
  36 =head2 On the command line
  37
  38 List the LVM PVs in a guest image:
  39
  40  guestfish add disk.img : run : pvs
  41
  42 Remove C</boot/grub/menu.lst> (in reality not such a great idea):
  43
  44  guestfish --add disk.img \
  45    --mount /dev/VolGroup00/LogVol00 \
  46    --mount /dev/sda1:/boot \
  47    rm /boot/grub/menu.lst
  48
  49 =head2 As an interactive shell
  50
  51  $ guestfish
  52
  53  Welcome to guestfish, the libguestfs filesystem interactive shell for
  54  editing virtual machine filesystems.
  55
  56  Type: 'help' for help with commands
  57        'quit' to quit the shell
  58
  59  ><fs> help
  60
  61 =head2 As a script interpreter
  62
  63  #!/usr/bin/guestfish -f
  64  alloc /tmp/output.img 10M
  65  run
  66  sfdisk /dev/sda 0 0 0 ,
  67  mkfs ext2 /dev/sda1
  68
  69 =head2 Remote control
  70
  71  eval `guestfish --listen`
  72  guestfish --remote cmd
  73
  74 =head1 DESCRIPTION
  75
  76 Guestfish is a shell and command-line tool for examining and modifying
  77 virtual machine filesystems.  It uses libguestfs and exposes all of
  78 the functionality of the guestfs API, see L<guestfs(3)>.
  79
  80 =head1 OPTIONS
  81
  82 =over 4
  83
  84 =item B<--help>
  85
  86 Displays general help on options.
  87
  88 =item B<-h> | B<--cmd-help>
  89
  90 Lists all available guestfish commands.
  91
  92 =item B<-h cmd> | B<--cmd-help cmd>
  93
  94 Displays detailed help on a single command C<cmd>.
  95
  96 =item B<-a image> | B<--add image>
  97
  98 Add a block device or virtual machine image to the shell.
  99
 100 =item B<-D> | B<--no-dest-paths>
 101
 102 Don't tab-complete paths on the guest filesystem.  It is useful to be
 103 able to hit the tab key to complete paths on the guest filesystem, but
 104 this causes extra "hidden" guestfs calls to be made, so this option is
 105 here to allow this feature to be disabled.
 106
 107 =item B<-f file> | B<--file file>
 108
 109 Read commands from C<file>.  To write pure guestfish
 110 scripts, use:
 111
 112  #!/usr/bin/guestfish -f
 113
 114 =item B<-i> | B<--inspector>
 115
 116 Run virt-inspector on the named libvirt domain or list of disk
 117 images.  If virt-inspector is available and if it can identify
 118 the domain or disk images, then partitions will be mounted
 119 correctly at start-up.
 120
 121 Typical usage is either:
 122
 123  guestfish -i myguest
 124
 125 (for an inactive libvirt domain called I<myguest>), or:
 126
 127  guestfish --ro -i myguest
 128
 129 (for active domains, readonly), or specify the block device directly:
 130
 131  guestfish -i /dev/Guests/MyGuest
 132
 133 You cannot use I<-a>, I<-m>, I<--listen> or I<--remote> in conjunction
 134 with this option, and options other than I<--ro> might not behave
 135 correctly.
 136
 137 See also: L<virt-inspector(1)>.
 138
 139 =item B<--listen>
 140
 141 Fork into the background and listen for remote commands.  See section
 142 I<REMOTE CONTROL GUESTFISH OVER A SOCKET> below.
 143
 144 =item B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>
 145
 146 Mount the named partition or logical volume on the given mountpoint.
 147
 148 If the mountpoint is omitted, it defaults to C</>.
 149
 150 You have to mount something on C</> before most commands will work.
 151
 152 If any C<-m> or C<--mount> options are given, the guest is
 153 automatically launched.
 154
 155 =item B<-n> | B<--no-sync>
 156
 157 Disable autosync.  This is enabled by default.  See the discussion
 158 of autosync in the L<guestfs(3)> manpage.
 159
 160 =item B<--remote[=pid]>
 161
 162 Send remote commands to C<$GUESTFISH_PID> or C<pid>.  See section
 163 I<REMOTE CONTROL GUESTFISH OVER A SOCKET> below.
 164
 165 =item B<-r> | B<--ro>
 166
 167 This changes the C<-m> option so that mounts are done read-only
 168 (see C<guestfs_mount_ro> in the L<guestfs(3)> manpage).
 169
 170 =item B<-v> | B<--verbose>
 171
 172 Enable very verbose messages.  This is particularly useful if you find
 173 a bug.
 174
 175 =item B<-V> | B<--version>
 176
 177 Display the guestfish / libguestfs version number and exit.
 178
 179 =item B<-x>
 180
 181 Echo each command before executing it.
 182
 183 =back
 184
 185 =head1 COMMANDS ON COMMAND LINE
 186
 187 Any additional (non-option) arguments are treated as commands to
 188 execute.
 189
 190 Commands to execute should be separated by a colon (C<:>), where the
 191 colon is a separate parameter.  Thus:
 192
 193  guestfish cmd [args...] : cmd [args...] : cmd [args...] ...
 194
 195 If there are no additional arguments, then we enter a shell, either an
 196 interactive shell with a prompt (if the input is a terminal) or a
 197 non-interactive shell.
 198
 199 In either command line mode or non-interactive shell, the first
 200 command that gives an error causes the whole shell to exit.  In
 201 interactive mode (with a prompt) if a command fails, you can continue
 202 to enter commands.
 203
 204 =head1 USING launch (OR run)
 205
 206 As with L<guestfs(3)>, you must first configure your guest by adding
 207 disks, then launch it, then mount any disks you need, and finally
 208 issue actions/commands.  So the general order of the day is:
 209
 210 =over 4
 211
 212 =item *
 213
 214 add or -a/--add
 215
 216 =item *
 217
 218 launch (aka run)
 219
 220 =item *
 221
 222 mount or -m/--mount
 223
 224 =item *
 225
 226 any other commands
 227
 228 =back
 229
 230 C<run> is a synonym for C<launch>.  You must C<launch> (or C<run>)
 231 your guest before mounting or performing any other commands.
 232
 233 The only exception is that if the C<-m> or C<--mount> option was
 234 given, the guest is automatically run for you (simply because
 235 guestfish can't mount the disks you asked for without doing this).
 236
 237 =head1 QUOTING
 238
 239 You can quote ordinary parameters using either single or double
 240 quotes.  For example:
 241
 242  add "file with a space.img"
 243
 244  rm '/file name'
 245
 246  rm '/"'
 247
 248 A few commands require a list of strings to be passed.  For these, use
 249 a space-separated list, enclosed in quotes.  For example:
 250
 251  vgcreate VG "/dev/sda1 /dev/sdb1"
 252
 253 =head1 WILDCARDS AND GLOBBING
 254
 255 Neither guestfish nor the underlying guestfs API performs
 256 wildcard expansion (globbing) by default.  So for example the
 257 following will not do what you expect:
 258
 259  rm-rf /home/*
 260
 261 Assuming you don't have a directory literally called C</home/*>
 262 then the above command will return an error.
 263
 264 To perform wildcard expansion, use the C<glob> command.
 265
 266  glob rm-rf /home/*
 267
 268 runs C<rm-rf> on each path that matches (ie. potentially running
 269 the command many times), equivalent to:
 270
 271  rm-rf /home/jim
 272  rm-rf /home/joe
 273  rm-rf /home/mary
 274
 275 C<glob> only works on simple guest paths and not on device names.
 276
 277 If you have several parameters, each containing a wildcard, then glob
 278 will perform a cartesian product.
 279
 280 =head1 COMMENTS
 281
 282 Any line which starts with a I<#> character is treated as a comment
 283 and ignored.  The I<#> can optionally be preceeded by whitespace,
 284 but B<not> by a command.  For example:
 285
 286  # this is a comment
 287          # this is a comment
 288  foo # NOT a comment
 289
 290 Blank lines are also ignored.
 291
 292 =head1 RUNNING COMMANDS LOCALLY
 293
 294 Any line which starts with a I<!> character is treated as a command
 295 sent to the local shell (C</bin/sh> or whatever L<system(3)> uses).
 296 For example:
 297
 298  !mkdir local
 299  tgz-out /remote local/remote-data.tar.gz
 300
 301 will create a directory C<local> on the host, and then export
 302 the contents of C</remote> on the mounted filesystem to
 303 C<local/remote-data.tar.gz>.  (See C<tgz-out>).
 304
 305 =head1 PIPES
 306
 307 Use C<command E<lt>spaceE<gt> | command> to pipe the output of the
 308 first command (a guestfish command) to the second command (any host
 309 command).  For example:
 310
 311  cat /etc/passwd | awk -F: '$3 == 0 { print }'
 312
 313 (where C<cat> is the guestfish cat command, but C<awk> is the host awk
 314 program).  The above command would list all accounts in the guest
 315 filesystem which have UID 0, ie. root accounts including backdoors.
 316 Other examples:
 317
 318  hexdump /bin/ls | head
 319  list-devices | tail -1
 320
 321 The space before the pipe symbol is required, any space after the pipe
 322 symbol is optional.  Everything after the pipe symbol is just passed
 323 straight to the host shell, so it can contain redirections, globs and
 324 anything else that makes sense on the host side.
 325
 326 To use a literal argument which begins with a pipe symbol, you have
 327 to quote it, eg:
 328
 329  echo "|"
 330
 331 =head1 EXIT ON ERROR BEHAVIOUR
 332
 333 By default, guestfish will ignore any errors when in interactive mode
 334 (ie. taking commands from a human over a tty), and will exit on the
 335 first error in non-interactive mode (scripts, commands given on the
 336 command line).
 337
 338 If you prefix a command with a I<-> character, then that command will
 339 not cause guestfish to exit, even if that (one) command returns an
 340 error.
 341
 342 =head1 REMOTE CONTROL GUESTFISH OVER A SOCKET
 343
 344 Guestfish can be remote-controlled over a socket.  This is useful
 345 particularly in shell scripts where you want to make several different
 346 changes to a filesystem, but you don't want the overhead of starting
 347 up a guestfish process each time.
 348
 349 Start a guestfish server process using:
 350
 351  eval `guestfish --listen`
 352
 353 and then send it commands by doing:
 354
 355  guestfish --remote cmd [...]
 356
 357 To cause the server to exit, send it the exit command:
 358
 359  guestfish --remote exit
 360
 361 Note that the server will normally exit if there is an error in a
 362 command.  You can change this in the usual way.  See section I<EXIT ON
 363 ERROR BEHAVIOUR>.
 364
 365 =head2 CONTROLLING MULTIPLE GUESTFISH PROCESSES
 366
 367 The C<eval> statement sets the environment variable C<$GUESTFISH_PID>,
 368 which is how the C<--remote> option knows where to send the commands.
 369 You can have several guestfish listener processes running using:
 370
 371  eval `guestfish --listen`
 372  pid1=$GUESTFISH_PID
 373  eval `guestfish --listen`
 374  pid2=$GUESTFISH_PID
 375  ...
 376  guestfish --remote=$pid1 cmd
 377  guestfish --remote=$pid2 cmd
 378
 379 =head2 STANDARD OUTPUT DURING REMOTE CONTROL
 380
 381 Because of limitations in the C<eval> statement, stdout from the
 382 listener is currently redirected to C</dev/null>.
 383
 384 Stderr is unchanged.
 385
 386 =head2 REMOTE CONTROL DETAILS
 387
 388 Remote control happens over a Unix domain socket called
 389 C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective
 390 user ID of the process, and C<$PID> is the process ID of the server.
 391
 392 Guestfish client and server versions must match exactly.
 393
 394 =head1 GUESTFISH COMMANDS
 395
 396 The commands in this section are guestfish convenience commands, in
 397 other words, they are not part of the L<guestfs(3)> API.
 398
 399 =head2 alloc | allocate
 400
 401  alloc filename size
 402
 403 This creates an empty (zeroed) file of the given size, and then adds
 404 so it can be further examined.
 405
 406 For more advanced image creation, see L<qemu-img(1)> utility.
 407
 408 Size can be specified (where C<nn> means a number):
 409
 410 =over 4
 411
 412 =item C<nn> or C<nn>K or C<nn>KB
 413
 414 number of kilobytes, eg: C<1440> = standard 3.5in floppy
 415
 416 =item C<nn>M or C<nn>MB
 417
 418 number of megabytes
 419
 420 =item C<nn>G or C<nn>GB
 421
 422 number of gigabytes
 423
 424 =item C<nn>sects
 425
 426 number of 512 byte sectors
 427
 428 =back
 429
 430 =head2 echo
 431
 432  echo [params ...]
 433
 434 This echos the parameters to the terminal.
 435
 436 =head2 edit | vi | emacs
 437
 438  edit filename
 439
 440 This is used to edit a file.  It downloads the file, edits it
 441 locally using your editor, then uploads the result.
 442
 443 The editor is C<$EDITOR>.  However if you use the alternate
 444 commands C<vi> or C<emacs> you will get those corresponding
 445 editors.
 446
 447 NOTE: This will not work reliably for large files
 448 (> 2 MB) or binary files containing \0 bytes.
 449
 450 =head2 glob
 451
 452  glob command args...
 453
 454 Expand wildcards in any paths in the args list, and run C<command>
 455 repeatedly on each matching path.
 456
 457 See section WILDCARDS AND GLOBBING.
 458
 459 =head2 help
 460
 461  help
 462  help cmd
 463
 464 Without any parameter, this lists all commands.  With a C<cmd>
 465 parameter, this displays detailed help for a command.
 466
 467 =head2 lcd
 468
 469  lcd directory
 470
 471 Change the local directory, ie. the current directory of guestfish
 472 itself.
 473
 474 Note that C<!cd> won't do what you might expect.
 475
 476 =head2 more | less
 477
 478  more filename
 479
 480  less filename
 481
 482 This is used to view a file.
 483
 484 The default viewer is C<$PAGER>.  However if you use the alternate
 485 command C<less> you will get the C<less> command specifically.
 486
 487 NOTE: This will not work reliably for large files
 488 (> 2 MB) or binary files containing \0 bytes.
 489
 490 =head2 quit | exit
 491
 492 This exits guestfish.  You can also use C<^D> key.
 493
 494 =head2 reopen
 495
 496  reopen
 497
 498 Close and reopen the libguestfs handle.  It is not necessary to use
 499 this normally, because the handle is closed properly when guestfish
 500 exits.  However this is occasionally useful for testing.
 501
 502 =head2 time
 503
 504  time command args...
 505
 506 Run the command as usual, but print the elapsed time afterwards.  This
 507 can be useful for benchmarking operations.
 508
 509 =head1 COMMANDS
 510
 511 @ACTIONS@
 512
 513 =head1 ENVIRONMENT VARIABLES
 514
 515 =over 4
 516
 517 =item EDITOR
 518
 519 The C<edit> command uses C<$EDITOR> as the editor.  If not
 520 set, it uses C<vi>.
 521
 522 =item GUESTFISH_PID
 523
 524 Used with the I<--remote> option to specify the remote guestfish
 525 process to control.  See section I<REMOTE CONTROL GUESTFISH OVER A
 526 SOCKET>.
 527
 528 =item HOME
 529
 530 If compiled with GNU readline support, then the command history
 531 is saved in C<$HOME/.guestfish>
 532
 533 =item LIBGUESTFS_APPEND
 534
 535 Pass additional options to the guest kernel.
 536
 537 =item LIBGUESTFS_DEBUG
 538
 539 Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages.  This has the
 540 same effect as using the B<-v> option.
 541
 542 =item LIBGUESTFS_MEMSIZE
 543
 544 Set the memory allocated to the qemu process, in megabytes.  For
 545 example:
 546
 547  LIBGUESTFS_MEMSIZE=700
 548
 549 =item LIBGUESTFS_PATH
 550
 551 Set the path that guestfish uses to search for kernel and initrd.img.
 552 See the discussion of paths in L<guestfs(3)>.
 553
 554 =item LIBGUESTFS_QEMU
 555
 556 Set the default qemu binary that libguestfs uses.  If not set, then
 557 the qemu which was found at compile time by the configure script is
 558 used.
 559
 560 =item PAGER
 561
 562 The C<more> command uses C<$PAGER> as the pager.  If not
 563 set, it uses C<more>.
 564
 565 =back
 566
 567 =head1 EXIT CODE
 568
 569 guestfish returns I<0> if the commands completed without error, or
 570 I<1> if there was an error.
 571
 572 =head1 SEE ALSO
 573
 574 L<guestfs(3)>,
 575 L<http://libguestfs.org/>.
 576
 577 =head1 AUTHORS
 578
 579 Richard W.M. Jones (C<rjones at redhat dot com>)
 580
 581 =head1 COPYRIGHT
 582
 583 Copyright (C) 2009 Red Hat Inc.
 584 L<http://libguestfs.org/>
 585
 586 This program is free software; you can redistribute it and/or modify
 587 it under the terms of the GNU General Public License as published by
 588 the Free Software Foundation; either version 2 of the License, or
 589 (at your option) any later version.
 590
 591 This program is distributed in the hope that it will be useful,
 592 but WITHOUT ANY WARRANTY; without even the implied warranty of
 593 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 594 GNU General Public License for more details.
 595
 596 You should have received a copy of the GNU General Public License
 597 along with this program; if not, write to the Free Software
 598 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.