command-list.txt: documentation and guide line
[git/git.git] / command-list.txt
CommitLineData
fe902f2c
NTND
1# Command classification list
2# ---------------------------
3# All supported commands, builtin or external, must be described in
4# here. This info is used to list commands in various places. Each
5# command is on one line followed by one or more attributes.
6#
7# The first attribute group is mandatory and indicates the command
8# type. This group includes:
9#
10# mainporcelain
11# ancillarymanipulators
12# ancillaryinterrogators
13# foreignscminterface
14# plumbingmanipulators
15# plumbinginterrogators
16# synchingrepositories
17# synchelpers
18# purehelpers
19#
20# The type names are self explanatory. But if you want to see what
21# command belongs to what group to get a better picture, have a look
22# at "git" man page, "GIT COMMANDS" section.
23#
24# Commands of type mainporcelain can also optionally have one of these
25# attributes:
26#
27# init
28# worktree
29# info
30# history
31# remote
32#
33# These commands are considered "common" and will show up in "git
34# help" output in groups. Uncommon porcelain commands must not
35# specify any of these attributes.
36#
37# "complete" attribute is used to mark that the command should be
38# completable by git-completion.bash. Note that by default,
39# mainporcelain commands are completable so you don't need this
40# attribute.
41#
42# As part of the Git man page list, the man(5/7) guides are also
43# specified here, which can only have "guide" attribute and nothing
44# else.
45#
f318d739
NTND
46### command list (do not change this line, also do not change alignment)
47# command name category [category] [category]
2f5b4950 48git-add mainporcelain worktree
79d30668
JH
49git-am mainporcelain
50git-annotate ancillaryinterrogators
51git-apply plumbingmanipulators
52git-archimport foreignscminterface
53git-archive mainporcelain
2f5b4950 54git-bisect mainporcelain info
79d30668 55git-blame ancillaryinterrogators
2f5b4950 56git-branch mainporcelain history
79d30668
JH
57git-bundle mainporcelain
58git-cat-file plumbinginterrogators
59git-check-attr purehelpers
368aa529 60git-check-ignore purehelpers
226ad348 61git-check-mailmap purehelpers
2f5b4950 62git-checkout mainporcelain history
79d30668
JH
63git-checkout-index plumbingmanipulators
64git-check-ref-format purehelpers
65git-cherry ancillaryinterrogators
66git-cherry-pick mainporcelain
67git-citool mainporcelain
68git-clean mainporcelain
2f5b4950 69git-clone mainporcelain init
7e29b825 70git-column purehelpers
2f5b4950 71git-commit mainporcelain history
79d30668
JH
72git-commit-tree plumbingmanipulators
73git-config ancillarymanipulators
74git-count-objects ancillaryinterrogators
fa0aad4f 75git-credential purehelpers
c6632eba
JK
76git-credential-cache purehelpers
77git-credential-store purehelpers
79d30668
JH
78git-cvsexportcommit foreignscminterface
79git-cvsimport foreignscminterface
80git-cvsserver foreignscminterface
81git-daemon synchingrepositories
82git-describe mainporcelain
2f5b4950 83git-diff mainporcelain history
79d30668
JH
84git-diff-files plumbinginterrogators
85git-diff-index plumbinginterrogators
86git-diff-tree plumbinginterrogators
afcbc8e7 87git-difftool ancillaryinterrogators
bf990a29
SG
88git-fast-export ancillarymanipulators
89git-fast-import ancillarymanipulators
2f5b4950 90git-fetch mainporcelain remote
79d30668
JH
91git-fetch-pack synchingrepositories
92git-filter-branch ancillarymanipulators
93git-fmt-merge-msg purehelpers
94git-for-each-ref plumbinginterrogators
95git-format-patch mainporcelain
bf990a29 96git-fsck ancillaryinterrogators
79d30668
JH
97git-gc mainporcelain
98git-get-tar-commit-id ancillaryinterrogators
2f5b4950 99git-grep mainporcelain info
79d30668
JH
100git-gui mainporcelain
101git-hash-object plumbingmanipulators
bf990a29 102git-help ancillaryinterrogators
5717b47c 103git-http-backend synchingrepositories
79d30668
JH
104git-http-fetch synchelpers
105git-http-push synchelpers
106git-imap-send foreignscminterface
107git-index-pack plumbingmanipulators
2f5b4950 108git-init mainporcelain init
79d30668 109git-instaweb ancillaryinterrogators
dfd66ddf 110git-interpret-trailers purehelpers
79d30668 111gitk mainporcelain
2f5b4950 112git-log mainporcelain info
79d30668
JH
113git-ls-files plumbinginterrogators
114git-ls-remote plumbinginterrogators
115git-ls-tree plumbinginterrogators
116git-mailinfo purehelpers
117git-mailsplit purehelpers
2f5b4950 118git-merge mainporcelain history
79d30668
JH
119git-merge-base plumbinginterrogators
120git-merge-file plumbingmanipulators
121git-merge-index plumbingmanipulators
122git-merge-one-file purehelpers
123git-mergetool ancillarymanipulators
124git-merge-tree ancillaryinterrogators
125git-mktag plumbingmanipulators
126git-mktree plumbingmanipulators
2f5b4950 127git-mv mainporcelain worktree
79d30668 128git-name-rev plumbinginterrogators
65d9fb48 129git-notes mainporcelain
b6f93057 130git-p4 foreignscminterface
79d30668
JH
131git-pack-objects plumbingmanipulators
132git-pack-redundant plumbinginterrogators
133git-pack-refs ancillarymanipulators
134git-parse-remote synchelpers
135git-patch-id purehelpers
79d30668
JH
136git-prune ancillarymanipulators
137git-prune-packed plumbingmanipulators
2f5b4950
SG
138git-pull mainporcelain remote
139git-push mainporcelain remote
79d30668
JH
140git-quiltimport foreignscminterface
141git-read-tree plumbingmanipulators
2f5b4950 142git-rebase mainporcelain history
79d30668
JH
143git-receive-pack synchelpers
144git-reflog ancillarymanipulators
79d30668
JH
145git-remote ancillarymanipulators
146git-repack ancillarymanipulators
3240269d 147git-replace ancillarymanipulators
79d30668
JH
148git-request-pull foreignscminterface
149git-rerere ancillaryinterrogators
2f5b4950 150git-reset mainporcelain worktree
79d30668
JH
151git-revert mainporcelain
152git-rev-list plumbinginterrogators
153git-rev-parse ancillaryinterrogators
2f5b4950 154git-rm mainporcelain worktree
79d30668
JH
155git-send-email foreignscminterface
156git-send-pack synchingrepositories
157git-shell synchelpers
158git-shortlog mainporcelain
2f5b4950 159git-show mainporcelain info
79d30668
JH
160git-show-branch ancillaryinterrogators
161git-show-index plumbinginterrogators
162git-show-ref plumbinginterrogators
63b90396 163git-sh-i18n purehelpers
79d30668
JH
164git-sh-setup purehelpers
165git-stash mainporcelain
2f5b4950 166git-status mainporcelain info
79d30668
JH
167git-stripspace purehelpers
168git-submodule mainporcelain
169git-svn foreignscminterface
170git-symbolic-ref plumbingmanipulators
2f5b4950 171git-tag mainporcelain history
79d30668
JH
172git-unpack-file plumbinginterrogators
173git-unpack-objects plumbingmanipulators
174git-update-index plumbingmanipulators
175git-update-ref plumbingmanipulators
176git-update-server-info synchingrepositories
177git-upload-archive synchelpers
178git-upload-pack synchelpers
179git-var plumbinginterrogators
d07b00b7 180git-verify-commit ancillaryinterrogators
79d30668
JH
181git-verify-pack plumbinginterrogators
182git-verify-tag ancillaryinterrogators
86ce2d54 183gitweb ancillaryinterrogators
79d30668 184git-whatchanged ancillaryinterrogators
df0b6cfb 185git-worktree mainporcelain
79d30668 186git-write-tree plumbingmanipulators
1b81d8cb
NTND
187gitattributes guide
188gitcli guide
189gitcore-tutorial guide
190gitcvs-migration guide
191gitdiffcore guide
192giteveryday guide
193gitglossary guide
194githooks guide
195gitignore guide
196gitmodules guide
197gitnamespaces guide
198gitrepository-layout guide
199gitrevisions guide
200gittutorial-2 guide
201gittutorial guide
202gitworkflows guide