diff options
author | Richard W.M. Jones <rjones@redhat.com> | 2010-09-18 09:38:05 +0100 |
---|---|---|
committer | Richard W.M. Jones <rjones@redhat.com> | 2010-09-18 09:38:05 +0100 |
commit | 0003ea2c3dbaa7e22f4f616539136821d80694b8 (patch) | |
tree | 1a5bcededb436fb9f1a0e8e046599fdd0d5ae7f1 /fish/guestfish.pod | |
parent | 585fceb3350c17a3d6ed7f2daffd5e2b3e5fc3e1 (diff) | |
download | libguestfs-0003ea2c3dbaa7e22f4f616539136821d80694b8.tar.gz libguestfs-0003ea2c3dbaa7e22f4f616539136821d80694b8.tar.xz libguestfs-0003ea2c3dbaa7e22f4f616539136821d80694b8.zip |
generator: Generate guestfish-only commands.
The guestfish-only commands such as 'alloc' and 'edit' are
now generated from one place in the generator instead of being
spread around ad-hoc in the C code.
Diffstat (limited to 'fish/guestfish.pod')
-rw-r--r-- | fish/guestfish.pod | 139 |
1 files changed, 1 insertions, 138 deletions
diff --git a/fish/guestfish.pod b/fish/guestfish.pod index f9269a16..ed2e7980 100644 --- a/fish/guestfish.pod +++ b/fish/guestfish.pod @@ -770,77 +770,6 @@ I<--no-progress-bars>. The commands in this section are guestfish convenience commands, in other words, they are not part of the L<guestfs(3)> API. -=head2 alloc | allocate - - alloc filename size - -This creates an empty (zeroed) file of the given size, and then adds -so it can be further examined. - -For more advanced image creation, see L<qemu-img(1)> utility. - -Size can be specified using standard suffixes, eg. C<1M>. - -=head2 copy-in - - copy-in local [local ...] /remotedir - -C<copy-in> copies local files or directories recursively into the disk -image, placing them in the directory called C</remotedir> (which must -exist). This guestfish meta-command turns into a sequence of -L</tar-in> and other commands as necessary. - -Multiple local files and directories can be specified, but the last -parameter must always be a remote directory. Wildcards cannot be -used. - -=head2 copy-out - - copy-out remote [remote ...] localdir - -C<copy-out> copies remote files or directories recursively out of the -disk image, placing them on the host disk in a local directory called -C<localdir> (which must exist). This guestfish meta-command turns -into a sequence of L</download>, L</tar-out> and other commands as -necessary. - -Multiple remote files and directories can be specified, but the last -parameter must always be a local directory. To download to the -current directory, use C<.> as in: - - copy-out /home . - -Wildcards cannot be used in the ordinary command, but you can use -them with the help of L</glob> like this: - - glob copy-out /home/* . - -=head2 echo - - echo [params ...] - -This echos the parameters to the terminal. - -=head2 edit | vi | emacs - - edit filename - -This is used to edit a file. It downloads the file, edits it -locally using your editor, then uploads the result. - -The editor is C<$EDITOR>. However if you use the alternate -commands C<vi> or C<emacs> you will get those corresponding -editors. - -=head2 glob - - glob command args... - -Expand wildcards in any paths in the args list, and run C<command> -repeatedly on each matching path. - -See section WILDCARDS AND GLOBBING. - =head2 help help @@ -849,77 +778,11 @@ See section WILDCARDS AND GLOBBING. Without any parameter, this lists all commands. With a C<cmd> parameter, this displays detailed help for a command. -=head2 lcd - - lcd directory - -Change the local directory, ie. the current directory of guestfish -itself. - -Note that C<!cd> won't do what you might expect. - -=head2 man | manual - - man - -Opens the manual page for guestfish. - -=head2 more | less - - more filename - - less filename - -This is used to view a file. - -The default viewer is C<$PAGER>. However if you use the alternate -command C<less> you will get the C<less> command specifically. - =head2 quit | exit This exits guestfish. You can also use C<^D> key. -=head2 reopen - - reopen - -Close and reopen the libguestfs handle. It is not necessary to use -this normally, because the handle is closed properly when guestfish -exits. However this is occasionally useful for testing. - -=head2 sparse - - sparse filename size - -This creates an empty sparse file of the given size, and then adds -so it can be further examined. - -In all respects it works the same as the C<alloc> command, except that -the image file is allocated sparsely, which means that disk blocks are -not assigned to the file until they are needed. Sparse disk files -only use space when written to, but they are slower and there is a -danger you could run out of real disk space during a write operation. - -For more advanced image creation, see L<qemu-img(1)> utility. - -Size can be specified using standard suffixes, eg. C<1M>. - -=head2 supported - - supported - -This command returns a list of the optional groups -known to the daemon, and indicates which ones are -supported by this build of the libguestfs appliance. - -See also L<guestfs(3)/AVAILABILITY>. - -=head2 time - - time command args... - -Run the command as usual, but print the elapsed time afterwards. This -can be useful for benchmarking operations. +@FISH_COMMANDS@ =head1 COMMANDS |