.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Podwrapper::Man 1.52.0 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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-index-validate 1"
.TH virt-index-validate 1 2024-03-15 guestfs-tools-1.52.0 "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\-index\-validate \- Validate virt\-builder index file
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& virt\-index\-validate index
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBvirt\-builder\fR\|(1) uses an index file to store metadata about templates
that it knows how to use.  This index file has a specific format which
virt-index-validate knows how to validate.
.PP
Note that virt-index-validate can validate either the signed or
unsigned index file (ie. either \fIindex\fR or \fIindex.asc\fR).  It can
only validate a local file, not a URL.
.SH OPTIONS
.IX Header "OPTIONS"
.IP \fB\-\-compat\-1.24.0\fR 4
.IX Item "--compat-1.24.0"
Check for compatibility with virt-builder 1.24.0.  (Using this option
implies \fI\-\-compat\-1.24.1\fR, so you don't need to use both.)
.Sp
In particular:
.RS 4
.IP \(bu 4
This version of virt-builder could not handle \f(CW\*(C`[...]\*(C'\fR
(square brackets) in field names (eg. \f(CW\*(C`checksum[sha512]=...\*(C'\fR).
.IP \(bu 4
It required detached signatures (\f(CW\*(C`sig=...\*(C'\fR).
.RE
.RS 4
.RE
.IP \fB\-\-compat\-1.24.1\fR 4
.IX Item "--compat-1.24.1"
Check for compatibility with virt-builder ≥ 1.24.1.
.Sp
In particular:
.RS 4
.IP \(bu 4
This version of virt-builder could not handle \f(CW\*(C`.\*(C'\fR (period) in field
names or \f(CW\*(C`,\*(C'\fR (comma) in subfield names.
.IP \(bu 4
It could not handle comments appearing in the file.
.RE
.RS 4
.RE
.IP \fB\-\-help\fR 4
.IX Item "--help"
Display help.
.IP \fB\-V\fR 4
.IX Item "-V"
.PD 0
.IP \fB\-\-version\fR 4
.IX Item "--version"
.PD
Display version number and exit.
.SH "EXIT STATUS"
.IX Header "EXIT STATUS"
This program returns 0 if the index file validates, or non-zero if
there was an error.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBvirt\-builder\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 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 GNU 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
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.
.PP
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301 USA.
.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.