mirrors/libguestfs
1
0
Fork 0
mirror of https://github.com/libguestfs/libguestfs.git synced 2026-03-22 07:03:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

cat, edit: Reference guestfish equivalent commands in the manual pages.

Browse Source 
(cherry picked from commit 4de124debf)
This commit is contained in:
Richard W.M. Jones
2011-04-05 17:44:41 +01:00
parent 7ef60bb65d
commit ee993d1a4d
2 changed files with 72 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
cat/virt-cat.pod
View File

@@ -27,7 +27,7 @@ directory (starting with '/').
C<virt-cat> can be used to quickly view a file. To edit a file, use
C<virt-edit>. For more complex cases you should look at the
L<guestfish(1)> tool.
L<guestfish(1)> tool (see L</USING GUESTFISH> below).
=head1 EXAMPLES
@@ -164,6 +164,30 @@ name as a guest.
For compatibility the old style is still supported.
=head1 USING GUESTFISH
L<guestfish(1)> is a more powerful, lower level tool which you can use
when C<virt-cat> doesn't work.
Using C<virt-cat> is approximately equivalent to doing:
guestfish --ro -i -d domname download file -
where C<domname> is the name of the libvirt guest, and C<file> is the
full path to the file. Note the final C<-> (meaning "output to
stdout").
The command above uses libguestfs's guest inspection feature and so
does not work on guests that libguestfs cannot inspect, or on things
like arbitrary disk images that don't contain guests. To display a
file from a disk image directly, use:
guestfish --ro -a disk.img -m /dev/sda1 download file -
where C<disk.img> is the disk image, C</dev/sda1> is the filesystem
within the disk image to edit, and C<file> is the full path to the
file.
=head1 SHELL QUOTING
Libvirt guest names can contain arbitrary characters, some of which
@@ -184,7 +208,7 @@ Richard W.M. Jones L<http://people.redhat.com/~rjones/>
=head1 COPYRIGHT
Copyright (C) 2010 Red Hat Inc.
Copyright (C) 2010-2011 Red Hat Inc.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by

50
tools/virt-edit
View File

@@ -1,6 +1,6 @@
#!/usr/bin/perl -w
# virt-edit
# Copyright (C) 2009-2010 Red Hat Inc.
# Copyright (C) 2009-2011 Red Hat Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
@@ -52,8 +52,13 @@ you from doing this, but doesn't catch all cases.
C<virt-edit> is a command line tool to edit C<file> where C<file>
exists in the named virtual machine (or disk image).
If you want to just view a file, use L<virt-cat(1)>. For more complex
cases you should look at the L<guestfish(1)> tool.
If you want to just view a file, use L<virt-cat(1)>.
For more complex cases you should look at the L<guestfish(1)> tool
(see L</USING GUESTFISH> below).
C<virt-edit> cannot be used to create a new file, nor to edit
multiple files. L<guestfish(1)> can do that and much more.
=head1 EXAMPLES
@@ -327,6 +332,43 @@ file):
my $m = $_; chomp $m; $m =~ /some text$/
=head1 USING GUESTFISH
L<guestfish(1)> is a more powerful, lower level tool which you can use
when C<virt-edit> doesn't work.
Using C<virt-edit> is approximately equivalent to doing:
guestfish --rw -i -d domname edit /file
where C<domname> is the name of the libvirt guest, and C</file> is the
full path to the file.
The command above uses libguestfs's guest inspection feature and so
does not work on guests that libguestfs cannot inspect, or on things
like arbitrary disk images that don't contain guests. To edit a file
on a disk image directly, use:
guestfish --rw -a disk.img -m /dev/sda1 edit /file
where C<disk.img> is the disk image, C</dev/sda1> is the filesystem
within the disk image to edit, and C</file> is the full path to the
file.
C<virt-edit> cannot create new files. Use the guestfish commands
C<touch>, C<write> or C<upload> instead:
guestfish --rw -i -d domname touch /newfile
guestfish --rw -i -d domname write /newfile "new content"
guestfish --rw -i -d domname upload localfile /newfile
C<virt-edit> cannot edit multiple files, but guestfish can
do it like this:
guestfish --rw -i -d domname edit /file1 : edit /file2
=head1 ENVIRONMENT VARIABLES
=over 4
@@ -365,7 +407,7 @@ Richard W.M. Jones L<http://people.redhat.com/~rjones/>
=head1 COPYRIGHT
Copyright (C) 2009-2010 Red Hat Inc.
Copyright (C) 2009-2011 Red Hat Inc.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by