.\" 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-CLONE" "1" "07 February 2017" "" "git-buildpackage Manual"

.SH NAME
gbp-clone \- Clone a repository from remote
.SH SYNOPSIS

\fBgbp\~clone\fR [ \fB--version\fR ] [ \fB--help\fR ] [ \fB--verbose\fR ] [ \fB--color=\fI[auto|on|off]\fB\fR ] [ \fB--color-scheme=\fICOLOR_SCHEME\fB\fR ] [ \fB--all\fR ] [ \fB--[no-]pristine-tar\fR ] [ \fB--debian-branch=\fIbranch_name\fB\fR ] [ \fB--upstream-branch=\fIbranch_name\fB\fR ] [ \fB--depth=\fIdepth\fB\fR ] [ \fB--reference=\fIrepository\fB\fR ] [ \fB--postclone=\fICOMMAND\fB\fR ] [ \fB--[no-]hooks\fR ] [ \fB--repo-user=[GIT|DEBIAN]\fR ] [ \fB--repo-email=[GIT|DEBIAN]\fR ] \fB\fIrepository\fB\fR [ \fB\fIdirectory\fB\fR ]

.SH "DESCRIPTION"
.PP
\fBgbp\~clone\fR clones a remote repository and sets up tracking branches for
the \fBdebian\fR, \fBupstream\fR and
\fBpristine-tar\fR branches. This way you can easily update
later using \fBgbp\~pull\fR\&.
.SH "OPTIONS"
.TP
\fB--version\fR
Print version of the program, i.e. version of the git-buildpackage
suite
.TP
\fB-v\fR
.TP
\fB--verbose\fR
Verbose execution
.TP
\fB-h\fR
.TP
\fB--help\fR
Print help and exit
.TP
\fB--color=\fI[auto|on|off]\fB \fR
Whether to use colored output.
.TP
\fB--color-scheme=\fICOLOR_SCHEME\fB \fR
Colors to use in output (when color is enabled). The format for
COLOR_SCHEME is
\&'<debug>:<info>:<warning>:<error>\&'.
Numerical values and color names are accepted, empty fields imply
the default color. For example,
\fB--git-color-scheme=\fR\&'cyan:34::' would
show debug messages in cyan, info messages in blue and other messages
in default (i.e. warning and error messages in red).
.TP
\fB--all \fR
Track all branches, not only \fIdebian\fR
and \fIupstream\fR\&.
.TP
\fB--debian-branch=\fIbranch_name\fB \fR
The branch in the Git repository the Debian package is being
developed on, default is \fImaster\fR\&.
.TP
\fB--upstream-branch=\fIbranch_name\fB \fR
The branch in the Git repository the upstream sources are put
onto. Default is \fIupstream\fR\&.
.TP
\fB--depth=\fIdepth\fB \fR
Git history depth, for creating shallow git clones.
.TP
\fB--reference=\fIrepository\fB \fR
Local repository to use as alternate instead of re-copying data from remote repository.
.TP
\fB--pristine-tar \fR
Track pristine tar branch.
.TP
\fB--[no-]hooks\fR
Enable running hooks.
.TP
\fB--postclone=\fICOMMAND\fB\fR
Execute \fICOMMAND\fR after cloning the source
from the remote.

Exported environment variables are: \fBGBP_GIT_DIR\fR (the
repository the package is being built from).

Note that if you clone a repository that contains a
hook configuration in \fIdebian/gbp.conf\fR
this hook will not be run automatically to prevent execution
of untrusted code.
.TP
\fB--repo-email=[GIT|DEBIAN]\fR
When set to \fBDEBIAN\fR
use the \fBDEBEMAIL\fR environment variable to set the
user.email Git configuration otherwise use Git\&'s
defaults.
.TP
\fB--repo-user=[GIT|DEBIAN]\fR
When set to \fBDEBIAN\fR
use the \fBDEBUSER\fR environment variable to set the
user.name Git configuration otherwise use Git\&'s
defaults.
.TP
\fB\fIrepository\fB\fR
The (possibly remote) repository to clone from.
.TP
\fB\fIdirectory\fB\fR
The directory to clone to.
.SH "EXAMPLES"
.PP
Clone a repository and setup a tracking branch for pristine-tar
as well:

.nf
      \fBgbp\~clone\fR --pristine-tar git://honk.sigxcpu.org/git/git-buildpackage.git
    
.fi
.SH "CONFIGURATION FILES"
.PP
Several \fIgbp.conf\fR files are parsed 
to set defaults for the above command-line arguments. See the
\fBgbp.conf\fR(5)> manpage for details.
.SH "SEE ALSO"
.PP
\fBgbp-buildpackage\fR(1)>,
\fBgbp-pull\fR(1)>,
\fBgbp.conf\fR(5)>
.SH "AUTHOR"
.PP
Guido Guenther <agx@sigxcpu.org>