.\" 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 "GIT-CLEAN-FORGE-FORK 1p" .TH GIT-CLEAN-FORGE-FORK 1p "2022-01-02" "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" git\-clean\-forge\-fork \- create tidy forks for pull requests .SH "VERSION" .IX Header "VERSION" version 0.007 .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBgit clean-forge-fork\fR [\fB\-\-upstream=\fR\fI\s-1REMOTE\s0\fR] .SH "DESCRIPTION" .IX Header "DESCRIPTION" Creates a fork for proposing changes to a project hosted on a git forge, like GitHub or GitLab. Also configures the fork to make it obvious that it only exists for submitting changes, so that the fork clutters up your git forge profile a bit less. Also adds a 'fork' remote to which you can push your proposed changes. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-\-upstream=\fR\fI\s-1REMOTE\s0\fR" 4 .IX Item "--upstream=REMOTE" Specify the name of the upstream git remote, i.e., what you want to fork. Defaults to \*(L"origin\*(R". .SH "FILES" .IX Header "FILES" .ie n .IP "$XDG_CONFIG_HOME/.config/gitforge/access_tokens/\fI\s-1DOMAIN\s0\fR" 4 .el .IP "\f(CW$XDG_CONFIG_HOME\fR/.config/gitforge/access_tokens/\fI\s-1DOMAIN\s0\fR" 4 .IX Item "$XDG_CONFIG_HOME/.config/gitforge/access_tokens/DOMAIN" Where \fI\s-1DOMAIN\s0\fR is the domain name of the git forge (e.g. \*(L"github.com\*(R", \*(L"salsa.debian.org\*(R"), this file should contain an \&\s-1API\s0 access token to log in to your account at the git forge. If unset, \f(CW$XDG_CONFIG_HOME\fR defaults to ~/.config. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBgit\-nuke\-forge\-fork\fR\|(1), \fBgit\-clean\-forge\-repo\fR\|(1) .SH "AUTHOR" .IX Header "AUTHOR" Sean Whitton .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is Copyright (c) 2017, 2020 by Sean Whitton . .PP This is free software, licensed under: .PP .Vb 1 \& The GNU General Public License, Version 3, June 2007 .Ve