.\" Automatically generated by Podwrapper::Man 1.44.2 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "virt-get-kernel 1"
.TH virt-get-kernel 1 "2021-09-07" "libguestfs-1.44.2" "Virtualization Support"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
virt\-get\-kernel \- Extract kernel and ramdisk from guests
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& virt\-get\-kernel [\-\-options] \-d domname
\&
\& virt\-get\-kernel [\-\-options] \-a disk.img
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This option extracts the kernel and initramfs from a guest.
.PP
The format of the disk image is automatically detected unless you
specify it by using the \fI\-\-format\fR option.
.PP
In the case where the guest contains multiple kernels, the one with
the highest version number is chosen.  To extract arbitrary kernels
from the disk image, see \fBguestfish\fR\|(1).  To extract the entire
\&\f(CW\*(C`/boot\*(C'\fR directory of a guest, see \fBvirt\-copy\-out\fR\|(1).
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-\-help\fR" 4
.IX Item "--help"
Display help.
.IP "\fB\-a\fR file" 4
.IX Item "-a file"
.PD 0
.IP "\fB\-\-add\fR file" 4
.IX Item "--add file"
.PD
Add \fIfile\fR which should be a disk image from a virtual machine.
.Sp
The format of the disk image is auto-detected.  To override this and
force a particular format use the \fI\-\-format\fR option.
.IP "\fB\-a\fR \s-1URI\s0" 4
.IX Item "-a URI"
.PD 0
.IP "\fB\-\-add\fR \s-1URI\s0" 4
.IX Item "--add URI"
.PD
Add a remote disk.  The \s-1URI\s0 format is compatible with guestfish.
See \*(L"\s-1ADDING REMOTE STORAGE\*(R"\s0 in \fBguestfish\fR\|(1).
.IP "\fB\-\-blocksize\fR \fB512\fR" 4
.IX Item "--blocksize 512"
.PD 0
.IP "\fB\-\-blocksize\fR \fB4096\fR" 4
.IX Item "--blocksize 4096"
.PD
This parameter sets the sector size of the disk image added with \fI\-a\fR
option and is ignored for libvirt guest added with \fI\-d\fR option.  See
also \*(L"guestfs_add_drive_opts\*(R" in \fBguestfs\fR\|(3).
.IP "\fB\-\-colors\fR" 4
.IX Item "--colors"
.PD 0
.IP "\fB\-\-colours\fR" 4
.IX Item "--colours"
.PD
Use \s-1ANSI\s0 colour sequences to colourize messages.  This is the default
when the output is a tty.  If the output of the program is redirected
to a file, \s-1ANSI\s0 colour sequences are disabled unless you use this
option.
.IP "\fB\-c\fR \s-1URI\s0" 4
.IX Item "-c URI"
.PD 0
.IP "\fB\-\-connect\fR \s-1URI\s0" 4
.IX Item "--connect URI"
.PD
If using libvirt, connect to the given \fI\s-1URI\s0\fR.  If omitted, then we
connect to the default libvirt hypervisor.
.Sp
If you specify guest block devices directly (\fI\-a\fR), then libvirt is
not used at all.
.IP "\fB\-d\fR guest" 4
.IX Item "-d guest"
.PD 0
.IP "\fB\-\-domain\fR guest" 4
.IX Item "--domain guest"
.PD
Add all the disks from the named libvirt guest.  Domain UUIDs can be
used instead of names.
.IP "\fB\-\-echo\-keys\fR" 4
.IX Item "--echo-keys"
When prompting for keys and passphrases, virt-get-kernel normally turns
echoing off so you cannot see what you are typing.  If you are not
worried about Tempest attacks and there is no one else in the room
you can specify this flag to see what you are typing.
.IP "\fB\-\-format\fR raw|qcow2|.." 4
.IX Item "--format raw|qcow2|.."
.PD 0
.IP "\fB\-\-format\fR auto" 4
.IX Item "--format auto"
.PD
The default for the \fI\-a\fR option is to auto-detect the format of the
disk image.  Using this forces the disk format for the \fI\-a\fR option
on the command line.
.Sp
If you have untrusted raw-format guest disk images, you should use
this option to specify the disk format.  This avoids a possible
security problem with malicious guests (\s-1CVE\-2010\-3851\s0).
.IP "\fB\-\-key\fR \s-1SELECTOR\s0" 4
.IX Item "--key SELECTOR"
Specify a key for \s-1LUKS,\s0 to automatically open a \s-1LUKS\s0 device when using
the inspection.  \f(CW\*(C`ID\*(C'\fR can be either the libguestfs device name, or
the \s-1UUID\s0 of the \s-1LUKS\s0 device.
.RS 4
.ie n .IP "\fB\-\-key\fR ""ID"":key:KEY_STRING" 4
.el .IP "\fB\-\-key\fR \f(CWID\fR:key:KEY_STRING" 4
.IX Item "--key ID:key:KEY_STRING"
Use the specified \f(CW\*(C`KEY_STRING\*(C'\fR as passphrase.
.ie n .IP "\fB\-\-key\fR ""ID"":file:FILENAME" 4
.el .IP "\fB\-\-key\fR \f(CWID\fR:file:FILENAME" 4
.IX Item "--key ID:file:FILENAME"
Read the passphrase from \fI\s-1FILENAME\s0\fR.
.RE
.RS 4
.RE
.IP "\fB\-\-keys\-from\-stdin\fR" 4
.IX Item "--keys-from-stdin"
Read key or passphrase parameters from stdin.  The default is
to try to read passphrases from the user by opening \fI/dev/tty\fR.
.Sp
If there are multiple encrypted devices then you may need to supply
multiple keys on stdin, one per line.
.IP "\fB\-\-machine\-readable\fR" 4
.IX Item "--machine-readable"
.PD 0
.IP "\fB\-\-machine\-readable\fR=format" 4
.IX Item "--machine-readable=format"
.PD
This option is used to make the output more machine friendly
when being parsed by other programs.  See
\&\*(L"\s-1MACHINE READABLE OUTPUT\*(R"\s0 below.
.IP "\fB\-o\fR directory" 4
.IX Item "-o directory"
.PD 0
.IP "\fB\-\-output\fR directory" 4
.IX Item "--output directory"
.PD
This option specifies the output directory where kernel and initramfs
from the guest are written.
.Sp
If not specified, the default output is the current directory.
.IP "\fB\-\-prefix\fR prefix" 4
.IX Item "--prefix prefix"
This option specifies a prefix for the extracted files.
.Sp
If a prefix is specified, then there will be a dash (\f(CW\*(C`\-\*(C'\fR) after the
prefix and before the rest of the file name; for example, a kernel
in the guest like \f(CW\*(C`vmlinuz\-3.19.0\-20\-generic\*(C'\fR is saved as
\&\f(CW\*(C`mydistro\-vmlinuz\-3.19.0\-20\-generic\*(C'\fR when the prefix is \f(CW\*(C`mydistro\*(C'\fR.
.Sp
See also \fI\-\-unversioned\-names\fR.
.IP "\fB\-q\fR" 4
.IX Item "-q"
.PD 0
.IP "\fB\-\-quiet\fR" 4
.IX Item "--quiet"
.PD
Don’t print ordinary progress messages.
.IP "\fB\-\-unversioned\-names\fR" 4
.IX Item "--unversioned-names"
This option affects the destination file name of extracted files.
.Sp
If enabled, files will be saved locally just with the base name;
for example, kernel and ramdisk in the guest like
\&\f(CW\*(C`vmlinuz\-3.19.0\-20\-generic\*(C'\fR and \f(CW\*(C`initrd.img\-3.19.0\-20\-generic\*(C'\fR
are saved respectively as \f(CW\*(C`vmlinuz\*(C'\fR and \f(CW\*(C`initrd.img\*(C'\fR.
.Sp
See also \fI\-\-prefix\fR.
.IP "\fB\-v\fR" 4
.IX Item "-v"
.PD 0
.IP "\fB\-\-verbose\fR" 4
.IX Item "--verbose"
.PD
Enable verbose messages for debugging.
.IP "\fB\-V\fR" 4
.IX Item "-V"
.PD 0
.IP "\fB\-\-version\fR" 4
.IX Item "--version"
.PD
Display version number and exit.
.IP "\fB\-x\fR" 4
.IX Item "-x"
Enable tracing of libguestfs \s-1API\s0 calls.
.SH "MACHINE READABLE OUTPUT"
.IX Header "MACHINE READABLE OUTPUT"
The \fI\-\-machine\-readable\fR option can be used to make the output more
machine friendly, which is useful when calling virt-get-kernel from
other programs, GUIs etc.
.PP
Use the option on its own to query the capabilities of the
virt-get-kernel binary.  Typical output looks like this:
.PP
.Vb 2
\& $ virt\-get\-kernel \-\-machine\-readable
\& virt\-get\-kernel
.Ve
.PP
A list of features is printed, one per line, and the program exits
with status 0.
.PP
It is possible to specify a format string for controlling the output;
see \*(L"\s-1ADVANCED MACHINE READABLE OUTPUT\*(R"\s0 in \fBguestfs\fR\|(3).
.SH "ENVIRONMENT VARIABLES"
.IX Header "ENVIRONMENT VARIABLES"
For other environment variables which affect all libguestfs programs,
see \*(L"\s-1ENVIRONMENT VARIABLES\*(R"\s0 in \fBguestfs\fR\|(3).
.SH "EXIT STATUS"
.IX Header "EXIT STATUS"
This program returns 0 if successful, or non-zero if there was an
error.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBguestfs\fR\|(3),
\&\fBguestfish\fR\|(1),
\&\fBguestmount\fR\|(1),
\&\fBvirt\-copy\-out\fR\|(1),
http://libguestfs.org/.
.SH "AUTHOR"
.IX Header "AUTHOR"
Richard W.M. Jones http://people.redhat.com/~rjones/
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2013\-2020 Red Hat Inc.
.SH "LICENSE"
.IX Header "LICENSE"
This program is free software; you can redistribute it and/or modify it
under the terms of the \s-1GNU\s0 General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
.PP
This program is distributed in the hope that it will be useful, but
\&\s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0  See the \s-1GNU\s0
General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, \s-1MA 02110\-1301 USA.\s0
.SH "BUGS"
.IX Header "BUGS"
To get a list of bugs against libguestfs, use this link:
https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools
.PP
To report a new bug against libguestfs, use this link:
https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools
.PP
When reporting a bug, please supply:
.IP "\(bu" 4
The version of libguestfs.
.IP "\(bu" 4
Where you got libguestfs (eg. which Linux distro, compiled from source, etc)
.IP "\(bu" 4
Describe the bug accurately and give a way to reproduce it.
.IP "\(bu" 4
Run \fBlibguestfs\-test\-tool\fR\|(1) and paste the \fBcomplete, unedited\fR
output into the bug report.