.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (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 "Git::Raw::Config 3pm"
.TH Git::Raw::Config 3pm 2024-01-10 "perl v5.38.2" "User Contributed Perl Documentation"
.\" 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
Git::Raw::Config \- Git config class
.SH VERSION
.IX Header "VERSION"
version 0.90
.SH DESCRIPTION
.IX Header "DESCRIPTION"
A Git::Raw::Config represents a Git configuration file.
.PP
\&\fBWARNING\fR: The API of this module is unstable and may change without warning
(any change will be appropriately documented in the changelog).
.SH METHODS
.IX Header "METHODS"
.SS "new( )"
.IX Subsection "new( )"
Create a new config object.
.SS "default( )"
.IX Subsection "default( )"
Retrieve the global, XDG and system configuration and open them into a single
prioritized config object that can be used when accessing default config data
outside a repository.
.ie n .SS "add_file( $path, $level )"
.el .SS "add_file( \f(CW$path\fP, \f(CW$level\fP )"
.IX Subsection "add_file( $path, $level )"
Add \f(CW$path\fR to the config object with priority level \f(CW$level\fR.
.ie n .SS "bool( $name [, $value ] )"
.el .SS "bool( \f(CW$name\fP [, \f(CW$value\fP ] )"
.IX Subsection "bool( $name [, $value ] )"
Retrieve the value of the \f(CW$name\fR configuration field of type boolean. If
\&\f(CW$value\fR is passed, the value of the configration will be updated and
returned. If \f(CW$name\fR configuration is not found, \f(CW\*(C`undef\*(C'\fR is returned.
.ie n .SS "int( $name [, $value ] )"
.el .SS "int( \f(CW$name\fP [, \f(CW$value\fP ] )"
.IX Subsection "int( $name [, $value ] )"
Retrieve the value of the \f(CW$name\fR configuration field of type integer. If
\&\f(CW$value\fR is passed, the value of the configration will be updated and
returned. If \f(CW$name\fR configuration is not found, \f(CW\*(C`undef\*(C'\fR is returned.
.ie n .SS "str( $name [, $value ] )"
.el .SS "str( \f(CW$name\fP [, \f(CW$value\fP ] )"
.IX Subsection "str( $name [, $value ] )"
Retrieve the value of the \f(CW$name\fR configuration field of type string. If
\&\f(CW$value\fR is passed, the value of the configration will be updated and
returned. If \f(CW$name\fR configuration is not found, \f(CW\*(C`undef\*(C'\fR is returned.
.ie n .SS "str_add( $name [, $value ] )"
.el .SS "str_add( \f(CW$name\fP [, \f(CW$value\fP ] )"
.IX Subsection "str_add( $name [, $value ] )"
Adds the value of the \f(CW$name\fR configuration field of type string. If
\&\f(CW$value\fR is passed, the value of the configration will be updated and
returned. If \f(CW$name\fR configuration is not found, \f(CW\*(C`undef\*(C'\fR is returned.
.ie n .SS "foreach( $callback )"
.el .SS "foreach( \f(CW$callback\fP )"
.IX Subsection "foreach( $callback )"
Run \f(CW$callback\fR for every config entry. The callback receives the name of the
config entry, its value and its priority level. A non-zero return value stops
the loop.
.ie n .SS "delete( $name )"
.el .SS "delete( \f(CW$name\fP )"
.IX Subsection "delete( $name )"
Delete the variable \f(CW$name\fR from the config object.
.SH AUTHOR
.IX Header "AUTHOR"
Alessandro Ghedini <alexbio@cpan.org>
.PP
Jacques Germishuys <jacquesg@cpan.org>
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright 2012 Alessandro Ghedini.
.PP
This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.
.PP
See http://dev.perl.org/licenses/ for more information.