.\" -*- 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 "libguestfs-tools.conf 5"
.TH libguestfs-tools.conf 5 2024-01-05 libguestfs-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
libguestfs\-tools.conf \- configuration file for guestfish, guestmount, virt\-rescue
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& /etc/libguestfs\-tools.conf
\&
\& $XDG_CONFIG_DIRS/libguestfs/libguestfs\-tools.conf
\&
\& $HOME/.libguestfs\-tools.rc
\&
\& $XDG_CONFIG_HOME/libguestfs/libguestfs\-tools.conf
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fIlibguestfs\-tools.conf\fR (or \fR\f(CI$HOME\fR\fI/.libguestfs\-tools.rc\fR) changes the
defaults for the following programs only:
.IP \(bu 4
\&\fBguestfish\fR\|(1)
.IP \(bu 4
\&\fBguestmount\fR\|(1)
.IP \(bu 4
\&\fBvirt\-rescue\fR\|(1)
.PP
There is currently only one setting which is controlled by this
file.  Adding (or uncommenting):
.PP
.Vb 1
\& read_only = true;
.Ve
.PP
changes these programs so they act as if the \fI\-\-ro\fR flag was given on
the command line.  You can use this to make the programs safe against
accidental modification of a live guest (users would have to
explicitly add the \fI\-\-rw\fR flag to modify guests).  This is not the
default because it is not backwards compatible.
See also "OPENING DISKS FOR READ AND WRITE" in \fBguestfish\fR\|(1).
.PP
Note that \fBthe semicolon is required\fR.
.PP
This file is parsed by the libconfig library.  For more information
about the format, see:
http://www.hyperrealm.com/libconfig/libconfig_manual.html
.SH "FILE LOCATION"
.IX Header "FILE LOCATION"
The order of the configuration files being read is, by importance:
.IP \(bu 4
\&\f(CW$XDG_CONFIG_HOME\fR/libguestfs/libguestfs\-tools.conf (\f(CW$XDG_CONFIG_HOME\fR is
\&\fR\f(CI$HOME\fR\fI/.config\fR if not set).
.IP \(bu 4
\&\f(CW$HOME\fR/.libguestfs\-tools.rc
.IP \(bu 4
\&\f(CW$XDG_CONFIG_DIRS\fR/libguestfs/libguestfs\-tools.conf (where \f(CW$XDG_CONFIG_DIRS\fR
means any of the directories in that environment variable, or just \fI/etc/xdg\fR
if not set)
.IP \(bu 4
/etc/libguestfs\-tools.conf
.PP
This means local users can override the system configuration by copying
the configuration file (or creating it anew) into
\&\fR\f(CI$XDG_CONFIG_HOME\fR\fI/libguestfs/libguestfs\-tools.conf\fR.
.PP
\&\fI/etc/libguestfs\-tools.conf\fR and \fR\f(CI$HOME\fR\fI/.libguestfs\-tools.rc\fR are the old
non-XDG paths which are read for compatibility.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
"OPENING DISKS FOR READ AND WRITE" in \fBguestfish\fR\|(1),
\&\fBguestmount\fR\|(1),
\&\fBvirt\-rescue\fR\|(1),
http://libguestfs.org/,
http://standards.freedesktop.org/basedir\-spec/latest/.
.SH AUTHORS
.IX Header "AUTHORS"
Richard W.M. Jones (\f(CW\*(C`rjones at redhat dot com\*(C'\fR)
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2011\-2023 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.