.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "GBP.CONF" "5" "07 February 2017" "" "gbp.conf Manual"

.SH NAME
gbp.conf \- Gbp configuration file
.SH SYNOPSIS
.TP
\fB/etc/git-buildpackage/gbp.conf\fR
system wide
.TP
\fB~/.gbp.conf\fR
per user
.TP
\fB\&.gbp.conf\fR
per branch, can be published with the
repository (deprecated)
.TP
\fBdebian/gbp.conf\fR
per branch, can be published with the
repository
.TP
\fB\&.git/gbp.conf\fR
per repository
.SH "DESCRIPTION"
.PP
The \fIgbp.conf\fR configuration files provide
default global options and specific options for individual \fBgbp\fR
commands.  All files have the same format as described below and
are parsed in the above order from top to bottom with increasing
precedence.
.PP
Each file consists of either zero or one default section, and
zero or one sections for each \fBgbp\fR command. Additionally, there
can be an arbitrary number of
\fBremote-config\fR sections.  Comments start with a
hash sign (\fB#\fR). The overall layout is:

.nf
    [DEFAULT]
    # This section is for global settings. Affects all commands.
    # Options set here have the lowest priority.
    key = value

    [<command>]
    # Specific sections for each command, like \fBbuildpackage\fR
    # Options set here have lower priority than command line options
    key = value

    [remote-config <name>]
    # Specific sections for a remote configuration. This can be used several
    # times to set up remote configuration for \fBgbp create-remote-repo\fR
    key = value
.fi
.PP
The sections for each command are named like the command (without \fBgbp\fR) surrounded
by square brackets (e.g. \fB[buildpackage]\fR).
For backwards compatibility, command sections starting with \fIgit-\fR or
\fIgbp-\fR are also supported but will provoke a warning when parsed by
\fBgbp\fR\&.
.PP
The keys in the
\fBkey\fR=\fIvalue\fR pairs are named
like the command-line options of the corresponding command (with the
\&'--' stripped off) and can hold the same values, but see below for
details. In case of \fBgbp\~buildpackage\fR and \fBgbp\~buildpackage-rpm\fR
the key needs '--git-' instead of '--' stripped off.
.PP
For example,
the \fBgbp-buildpackage\fR(1)> manual page documents
the \fB--git-export-dir\fR=\fIdirectory\fR
option which can be turned into configuration file setting by
dropping the
\fB--git-\fR prefix:

.nf
    [buildpackage]
    export-dir = directory
.fi
.PP
Options that can be repeated on the command line take Python-like
lists in the config file. For example,
the \fBgbp-import-orig\fR(1)> command has the
\fB--filter\fR=\fIpattern\fR option
which can be turned into a configuration file option like this:

.nf
    [import-orig]
    filter = [ '.svn', '.hg' ]
.fi
.PP
Boolean options can be either \fBTrue\fR or \fBFalse\fR\&. For example,
\fBgbp-import-orig\fR(1)> has the \fB--pristine-tar\fR and
\fB--no-pristine-tar\fR options which translate to:

.nf
    [import-orig]
    pristine-tar = True
.fi
.PP
and

.nf
    [import-orig]
    pristine-tar = False
.fi
.PP
respectively.
.sp
.RS
.B "Note:"
To see the current set of values that would be applied after parsing the
configuration files, use \fBgbp-config\fR(1)>.
.RE
.sp
.RS
.B "Note:"
\fBgbp import-dscs\fR and \fBgit-pbuilder\fR
can't be configured via \fIgbp.conf\fR\&.
.RE
.PP
\fBgbp-create-remote-repo\fR(1)> can additionally parse remote site
configurations from \fIgbp.conf\fR\&. For example, a configuration like:

.nf
[remote-config pkg-libvirt]
# Location of the repository
remote-url-pattern = ssh://git.debian.org/git/pkg-libvirt/%(pkg)s
# Template dir to passed to git-init
template-dir = /srv/alioth.debian.org/chroot/home/groups/pkg-libvirt/git-template
.fi
.PP
can be used to create remote repositories for the pkg-libvirt project using:

.nf
gbp-create-remote-repo --remote-config=pkg-libvirt
.fi
.PP
This can be useful if you're often creating new remote repositories for
different projects.
.SH "EXAMPLES"
.PP
An example set up for packaging work:

.nf
 # $HOME/.gbp.conf

 [DEFAULT]
 pristine-tar = True
 cleaner = fakeroot debian/rules clean

 [buildpackage]
 export-dir  = ../build-area/

 [import-orig]
 dch = False
 filter = [
        \&'.svn',
        \&'.hg',
        \&'.bzr',
        \&'CVS',
        \&'debian/*',
        \&'*/debian/*'
        ]
 filter-pristine-tar = True

 [import-dsc]
 filter = [
        \&'CVS',
        \&'.cvsignore',
        \&'.hg',
        \&'.hgignore'
        \&'.bzr',
        \&'.bzrignore',
        \&'.gitignore'
        ]

 # End of file
.fi
.SH "ENVIRONMENT"
.TP
\fBGBP_CONF_FILES\fR
Colon separated list of files to parse. The default is
the above list of configuration files.
.TP
\fBGBP_DISABLE_SECTION_DEPRECTATION\fR
Don't print a deprecation warning when \fBgbp\fR
encounters a section starting
with \fBgit-\fR
or \fBgbp-\fR\&.
.SH "FILES"
.PP
See \fI/etc/git-buildpackage/gbp.conf\fR for an example.
.SH "SEE ALSO"
.PP
\fBgbp-clone\fR(1)>,
\fBgbp-create-remote-repo\fR(1)>,
\fBgbp-pq\fR(1)>,
\fBgbp-pull\fR(1)>,
\fBgbp-dch\fR(1)>,
\fBgbp-import-dsc\fR(1)>,
\fBgbp-import-orig\fR(1)>,
\fBgbp-buildpackage\fR(1)>,
\fIThe Git-Buildpackage Manual\fR <URL:file:///usr/share/doc/git-buildpackage/manual-html/index.html>
.SH "AUTHORS"
.PP
Guido Guenther <agx@sigxcpu.org>
.PP
This manual page is based on a POD version by Jari Aalto <jari.aalto@cante.net>\&.
Released under license GNU GPL version 2 or (at your option) any later.
version.