.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 "Dist::Zilla::Plugin::Git::Init 3pm" .TH Dist::Zilla::Plugin::Git::Init 3pm "2021-09-30" "perl v5.32.1" "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" Dist::Zilla::Plugin::Git::Init \- Initialize git repository on dzil new .SH "VERSION" .IX Header "VERSION" version 2.048 .SH "SYNOPSIS" .IX Header "SYNOPSIS" In your \fIprofile.ini\fR: .PP .Vb 7 \& [Git::Init] \& commit_message = initial commit ; this is the default \& commit = 1 ; this is the default \& branch = ; this is the default (means master) \& remote = origin https://github.com/USERNAME/%N.git ; no default \& push_url = origin git@github.com:USERNAME/%{lc}N.git ; no default \& config = user.email USERID@cpan.org ; there is no default .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This plugin initializes a git repository when a new distribution is created with \f(CW\*(C`dzil new\*(C'\fR. .SS "Plugin options" .IX Subsection "Plugin options" The plugin accepts the following options: .IP "\(bu" 4 commit_message \- the commit message to use when checking in the newly-minted dist. Defaults to \f(CW\*(C`initial commit\*(C'\fR. .IP "\(bu" 4 commit \- if true (the default), commit the newly-minted dist. If set to a false value, add the files to the Git index but don't actually make a commit. .IP "\(bu" 4 branch \- the branch name under which the newly-minted dist is checked in (if \f(CW\*(C`commit\*(C'\fR is true). Defaults to an empty string, which means that the Git default branch is used (master). .IP "\(bu" 4 config \- a config setting to make in the repository. No config entries are made by default. A setting is specified as \&\f(CW\*(C`OPTION VALUE\*(C'\fR. This may be specified multiple times to add multiple entries. .IP "\(bu" 4 remote \- a remote to add to the repository. No remotes are added by default. A remote is specified as \f(CW\*(C`NAME URL\*(C'\fR. This may be specified multiple times to add multiple remotes. .IP "\(bu" 4 push_url \- the \s-1URL\s0 to use to push to a particular remote to add to the repository. No URLs are added by default. A remote is specified as \f(CW\*(C`NAME URL\*(C'\fR. This may be specified multiple times to specify push URLs for multiple remotes, and is not required if the \s-1URL\s0 is the same as the one already set for that remote. .Sp Per the documentation for \fBgit\-remote\fR\|(1): Note that the push_url and the corresponding \s-1URL\s0 specified with \f(CW\*(C`remote\*(C'\fR, even though they can be set differently, must still refer to the same place. What you pushed to the push \s-1URL\s0 should be what you would see if you immediately fetched from the fetch \s-1URL\s0 (the \s-1URL\s0 specified with \f(CW\*(C`remote\*(C'\fR.) If you are trying to fetch from one place (e.g. your upstream) and push to another (e.g. your publishing repository), use two separate remotes. .Sp This, therefore, is best used in cases where pushing requires authentication, but pulling does not, or if pulling is via git or ssh, but pushing is via https, on the same repository. .SS "Formatting options" .IX Subsection "Formatting options" You can use the following codes in \f(CW\*(C`commit_message\*(C'\fR, \f(CW\*(C`config\*(C'\fR, \f(CW\*(C`remote\*(C'\fR, or \f(CW\*(C`push_url\*(C'\fR: .ie n .IP "%n" 4 .el .IP "\f(CW%n\fR" 4 .IX Item "%n" A newline. .ie n .IP "%N" 4 .el .IP "\f(CW%N\fR" 4 .IX Item "%N" The distribution name. You can also use \f(CW\*(C`%{lc}N\*(C'\fR or \f(CW\*(C`%{uc}N\*(C'\fR to get the name in lower case or upper case, respectively. .SH "SUPPORT" .IX Header "SUPPORT" Bugs may be submitted through the \s-1RT\s0 bug tracker (or bug\-Dist\-Zilla\-Plugin\-Git@rt.cpan.org ). .PP There is also a mailing list available for users of this distribution, at . .PP There is also an irc channel available for users of this distribution, at \&\f(CW\*(C`#distzilla\*(C'\fR on \f(CW\*(C`irc.perl.org\*(C'\fR . .SH "AUTHOR" .IX Header "AUTHOR" Jerome Quelin .SH "COPYRIGHT AND LICENCE" .IX Header "COPYRIGHT AND LICENCE" This software is copyright (c) 2009 by Jerome Quelin. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.