tj.git-extras/man/git-alias.1
wyattscarpenter ffee88a246
Update git-alias.md: add brs to prevent incorrect line behavior (#1161)
* Update git-alias.md: add brs to prevent incorrect line behavior

currently these all appear on one line, in the rendered markdown viewer and also in the man page. That isn't what's wanted. What's wanted is for each to be on its own line, which this change implements, using the strategy I found in git-bulk.

* run make on git-alias
2024-09-19 11:19:48 +08:00

80 lines
1.7 KiB
Groff

.\" generated with Ronn-NG/v0.9.1
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
.TH "GIT\-ALIAS" "1" "September 2024" "" "Git Extras"
.SH "NAME"
\fBgit\-alias\fR \- Define, search and show aliases
.SH "SYNOPSIS"
\fBgit\-alias\fR
.br
\fBgit\-alias\fR <search\-pattern>
.br
\fBgit\-alias\fR <alias\-name> <command>
.br
\fBgit\-alias\fR [\-\-global]
.br
\fBgit\-alias\fR [\-\-local]
.br
\fBgit\-alias\fR [\-\-global] <search\-pattern>
.br
\fBgit\-alias\fR [\-\-local] <search\-pattern>
.br
\fBgit\-alias\fR [\-\-global] <alias\-name> <command>
.br
\fBgit\-alias\fR [\-\-local] <alias\-name> <command>
.br
.SH "DESCRIPTION"
List all aliases, show one alias, or set one (global or local) alias\.
.SH "OPTIONS"
\-\-global
.P
Show or create alias in the system config
.P
\-\-local
.P
Show or create alias in the repository config
.P
<search\-pattern>
.P
The pattern used to search aliases\.
.P
<alias\-name>
.P
The name of the alias to create\.
.P
<command>
.P
The command for which you are creating an alias\.
.SH "EXAMPLES"
Defining a new alias:
.IP "" 4
.nf
$ git alias last "cat\-file commit HEAD"
.fi
.IP "" 0
.P
Providing only one argument, \fBgit\-alias\fR searches for aliases matching the given value:
.IP "" 4
.nf
$ git alias ^la
last = cat\-file commit HEAD
.fi
.IP "" 0
.P
\fBgit\-alias\fR will show all aliases if no argument is given:
.IP "" 4
.nf
$ git alias
s = status
amend = commit \-\-amend
rank = shortlog \-sn \-\-no\-merges
whatis = show \-s \-\-pretty='tformat:%h (%s, %ad)' \-\-date=short
whois = !sh \-c 'git log \-i \-1 \-\-pretty="format:%an <%ae>
.fi
.IP "" 0
.SH "AUTHOR"
Written by Jonhnny Weslley <\fIjw@jonhnnyweslley\.net\fR>
.SH "REPORTING BUGS"
<\fIhttps://github\.com/tj/git\-extras/issues\fR>
.SH "SEE ALSO"
<\fIhttps://github\.com/tj/git\-extras\fR>