Merge branch 'master' of ssh://Culex@repo.or.cz/srv/git/gitman-de
[gitman-de.git] / git-de.txt
blob44ea35e949dbbc0e5785ba2831072059881058f8
1 git(1)
2 ======
4 NAME
5 ----
6 git - the stupid content tracker
9 SYNOPSIS
10 --------
11 [verse]
12 'git' [--version] [--exec-path[=GIT_EXEC_PATH]]
13     [-p|--paginate|--no-pager]
14     [--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE]
15     [--help] COMMAND [ARGS]
17 DESCRIPTION
18 -----------
19 Git is a fast, scalable, distributed revision control system with an
20 unusually rich command set that provides both high-level operations
21 and full access to internals.
23 See linkgit:gittutorial[7] to get started, then see
24 link:everyday.html[Everyday Git] for a useful minimum set of commands, and
25 "man git-commandname" for documentation of each command.  CVS users may
26 also want to read linkgit:gitcvs-migration[7].  See
27 the link:user-manual.html[Git User's Manual] for a more in-depth
28 introduction.
30 The COMMAND is either a name of a Git command (see below) or an alias
31 as defined in the configuration file (see linkgit:git-config[1]).
33 Formatted and hyperlinked version of the latest git
34 documentation can be viewed at
35 `http://www.kernel.org/pub/software/scm/git/docs/`.
37 ifdef::stalenotes[]
38 [NOTE]
39 ============
41 You are reading the documentation for the latest (possibly
42 unreleased) version of git, that is available from 'master'
43 branch of the `git.git` repository.
44 Documentation for older releases are available here:
46 * link:v1.5.6.4/git.html[documentation for release 1.5.6.4]
48 * release notes for
49   link:RelNotes-1.5.6.4.txt[1.5.6.4],
50   link:RelNotes-1.5.6.3.txt[1.5.6.3],
51   link:RelNotes-1.5.6.2.txt[1.5.6.2],
52   link:RelNotes-1.5.6.1.txt[1.5.6.1],
53   link:RelNotes-1.5.6.txt[1.5.6].
55 * link:v1.5.5.4/git.html[documentation for release 1.5.5.4]
57 * release notes for
58   link:RelNotes-1.5.5.4.txt[1.5.5.4],
59   link:RelNotes-1.5.5.3.txt[1.5.5.3],
60   link:RelNotes-1.5.5.2.txt[1.5.5.2],
61   link:RelNotes-1.5.5.1.txt[1.5.5.1],
62   link:RelNotes-1.5.5.txt[1.5.5].
64 * link:v1.5.4.5/git.html[documentation for release 1.5.4.5]
66 * release notes for
67   link:RelNotes-1.5.4.5.txt[1.5.4.5],
68   link:RelNotes-1.5.4.4.txt[1.5.4.4],
69   link:RelNotes-1.5.4.3.txt[1.5.4.3],
70   link:RelNotes-1.5.4.2.txt[1.5.4.2],
71   link:RelNotes-1.5.4.1.txt[1.5.4.1],
72   link:RelNotes-1.5.4.txt[1.5.4].
74 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
76 * release notes for
77   link:RelNotes-1.5.3.8.txt[1.5.3.8],
78   link:RelNotes-1.5.3.7.txt[1.5.3.7],
79   link:RelNotes-1.5.3.6.txt[1.5.3.6],
80   link:RelNotes-1.5.3.5.txt[1.5.3.5],
81   link:RelNotes-1.5.3.4.txt[1.5.3.4],
82   link:RelNotes-1.5.3.3.txt[1.5.3.3],
83   link:RelNotes-1.5.3.2.txt[1.5.3.2],
84   link:RelNotes-1.5.3.1.txt[1.5.3.1],
85   link:RelNotes-1.5.3.txt[1.5.3].
87 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
89 * release notes for
90   link:RelNotes-1.5.2.5.txt[1.5.2.5],
91   link:RelNotes-1.5.2.4.txt[1.5.2.4],
92   link:RelNotes-1.5.2.3.txt[1.5.2.3],
93   link:RelNotes-1.5.2.2.txt[1.5.2.2],
94   link:RelNotes-1.5.2.1.txt[1.5.2.1],
95   link:RelNotes-1.5.2.txt[1.5.2].
97 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
99 * release notes for
100   link:RelNotes-1.5.1.6.txt[1.5.1.6],
101   link:RelNotes-1.5.1.5.txt[1.5.1.5],
102   link:RelNotes-1.5.1.4.txt[1.5.1.4],
103   link:RelNotes-1.5.1.3.txt[1.5.1.3],
104   link:RelNotes-1.5.1.2.txt[1.5.1.2],
105   link:RelNotes-1.5.1.1.txt[1.5.1.1],
106   link:RelNotes-1.5.1.txt[1.5.1].
108 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
110 * release notes for
111   link:RelNotes-1.5.0.7.txt[1.5.0.7],
112   link:RelNotes-1.5.0.6.txt[1.5.0.6],
113   link:RelNotes-1.5.0.5.txt[1.5.0.5],
114   link:RelNotes-1.5.0.3.txt[1.5.0.3],
115   link:RelNotes-1.5.0.2.txt[1.5.0.2],
116   link:RelNotes-1.5.0.1.txt[1.5.0.1],
117   link:RelNotes-1.5.0.txt[1.5.0].
119 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
120   link:v1.3.3/git.html[1.3.3],
121   link:v1.2.6/git.html[1.2.6],
122   link:v1.0.13/git.html[1.0.13].
124 ============
126 endif::stalenotes[]
128 OPTIONS
129 -------
130 --version::
131         Prints the git suite version that the 'git' program came from.
133 --help::
134         Prints the synopsis and a list of the most commonly used
135         commands. If the option '--all' or '-a' is given then all
136         available commands are printed. If a git command is named this
137         option will bring up the manual page for that command.
139 Other options are available to control how the manual page is
140 displayed. See linkgit:git-help[1] for more information,
141 because `git --help ...` is converted internally into `git
142 help ...`.
144 --exec-path::
145         Path to wherever your core git programs are installed.
146         This can also be controlled by setting the GIT_EXEC_PATH
147         environment variable. If no path is given, 'git' will print
148         the current setting and then exit.
150 -p::
151 --paginate::
152         Pipe all output into 'less' (or if set, $PAGER).
154 --no-pager::
155         Do not pipe git output into a pager.
157 --git-dir=<path>::
158         Set the path to the repository. This can also be controlled by
159         setting the GIT_DIR environment variable. It can be an absolute
160         path or relative path to current working directory.
162 --work-tree=<path>::
163         Set the path to the working tree.  The value will not be
164         used in combination with repositories found automatically in
165         a .git directory (i.e. $GIT_DIR is not set).
166         This can also be controlled by setting the GIT_WORK_TREE
167         environment variable and the core.worktree configuration
168         variable. It can be an absolute path or relative path to
169         the directory specified by --git-dir or GIT_DIR.
170         Note: If --git-dir or GIT_DIR are specified but none of
171         --work-tree, GIT_WORK_TREE and core.worktree is specified,
172         the current working directory is regarded as the top directory
173         of your working tree.
175 --bare::
176         Treat the repository as a bare repository.  If GIT_DIR
177         environment is not set, it is set to the current working
178         directory.
181 FURTHER DOCUMENTATION
182 ---------------------
184 See the references above to get started using git.  The following is
185 probably more detail than necessary for a first-time user.
187 The link:user-manual.html#git-concepts[git concepts chapter of the
188 user-manual] and linkgit:gitcore-tutorial[7] both provide
189 introductions to the underlying git architecture.
191 See also the link:howto-index.html[howto] documents for some useful
192 examples.
194 The internals are documented in the
195 link:technical/api-index.html[GIT API documentation].
197 GIT COMMANDS
198 ------------
200 We divide git into high level ("porcelain") commands and low level
201 ("plumbing") commands.
203 High-level commands (porcelain)
204 -------------------------------
206 We separate the porcelain commands into the main commands and some
207 ancillary user utilities.
209 Main porcelain commands
210 ~~~~~~~~~~~~~~~~~~~~~~~
212 include::cmds-mainporcelain.txt[]
214 Ancillary Commands
215 ~~~~~~~~~~~~~~~~~~
216 Manipulators:
218 include::cmds-ancillarymanipulators.txt[]
220 Interrogators:
222 include::cmds-ancillaryinterrogators.txt[]
225 Interacting with Others
226 ~~~~~~~~~~~~~~~~~~~~~~~
228 These commands are to interact with foreign SCM and with other
229 people via patch over e-mail.
231 include::cmds-foreignscminterface.txt[]
234 Low-level commands (plumbing)
235 -----------------------------
237 Although git includes its
238 own porcelain layer, its low-level commands are sufficient to support
239 development of alternative porcelains.  Developers of such porcelains
240 might start by reading about linkgit:git-update-index[1] and
241 linkgit:git-read-tree[1].
243 The interface (input, output, set of options and the semantics)
244 to these low-level commands are meant to be a lot more stable
245 than Porcelain level commands, because these commands are
246 primarily for scripted use.  The interface to Porcelain commands
247 on the other hand are subject to change in order to improve the
248 end user experience.
250 The following description divides
251 the low-level commands into commands that manipulate objects (in
252 the repository, index, and working tree), commands that interrogate and
253 compare objects, and commands that move objects and references between
254 repositories.
257 Manipulation commands
258 ~~~~~~~~~~~~~~~~~~~~~
260 include::cmds-plumbingmanipulators.txt[]
263 Interrogation commands
264 ~~~~~~~~~~~~~~~~~~~~~~
266 include::cmds-plumbinginterrogators.txt[]
268 In general, the interrogate commands do not touch the files in
269 the working tree.
272 Synching repositories
273 ~~~~~~~~~~~~~~~~~~~~~
275 include::cmds-synchingrepositories.txt[]
277 The following are helper programs used by the above; end users
278 typically do not use them directly.
280 include::cmds-synchelpers.txt[]
283 Internal helper commands
284 ~~~~~~~~~~~~~~~~~~~~~~~~
286 These are internal helper commands used by other commands; end
287 users typically do not use them directly.
289 include::cmds-purehelpers.txt[]
292 Configuration Mechanism
293 -----------------------
295 Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
296 is used to hold per-repository configuration options.  It is a
297 simple text file modeled after `.ini` format familiar to some
298 people.  Here is an example:
300 ------------
302 # A '#' or ';' character indicates a comment.
305 ; core variables
306 [core]
307         ; Don't trust file modes
308         filemode = false
310 ; user identity
311 [user]
312         name = "Junio C Hamano"
313         email = "junkio@twinsun.com"
315 ------------
317 Various commands read from the configuration file and adjust
318 their operation accordingly.
321 Identifier Terminology
322 ----------------------
323 <object>::
324         Indicates the object name for any type of object.
326 <blob>::
327         Indicates a blob object name.
329 <tree>::
330         Indicates a tree object name.
332 <commit>::
333         Indicates a commit object name.
335 <tree-ish>::
336         Indicates a tree, commit or tag object name.  A
337         command that takes a <tree-ish> argument ultimately wants to
338         operate on a <tree> object but automatically dereferences
339         <commit> and <tag> objects that point at a <tree>.
341 <commit-ish>::
342         Indicates a commit or tag object name.  A
343         command that takes a <commit-ish> argument ultimately wants to
344         operate on a <commit> object but automatically dereferences
345         <tag> objects that point at a <commit>.
347 <type>::
348         Indicates that an object type is required.
349         Currently one of: `blob`, `tree`, `commit`, or `tag`.
351 <file>::
352         Indicates a filename - almost always relative to the
353         root of the tree structure `GIT_INDEX_FILE` describes.
355 Symbolic Identifiers
356 --------------------
357 Any git command accepting any <object> can also use the following
358 symbolic notation:
360 HEAD::
361         indicates the head of the current branch (i.e. the
362         contents of `$GIT_DIR/HEAD`).
364 <tag>::
365         a valid tag 'name'
366         (i.e. the contents of `$GIT_DIR/refs/tags/<tag>`).
368 <head>::
369         a valid head 'name'
370         (i.e. the contents of `$GIT_DIR/refs/heads/<head>`).
372 For a more complete list of ways to spell object names, see
373 "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
376 File/Directory Structure
377 ------------------------
379 Please see the linkgit:gitrepository-layout[5] document.
381 Read linkgit:githooks[5] for more details about each hook.
383 Higher level SCMs may provide and manage additional information in the
384 `$GIT_DIR`.
387 Terminology
388 -----------
389 Please see linkgit:gitglossary[7].
392 Environment Variables
393 ---------------------
394 Various git commands use the following environment variables:
396 The git Repository
397 ~~~~~~~~~~~~~~~~~~
398 These environment variables apply to 'all' core git commands. Nb: it
399 is worth noting that they may be used/overridden by SCMS sitting above
400 git so take care if using Cogito etc.
402 'GIT_INDEX_FILE'::
403         This environment allows the specification of an alternate
404         index file. If not specified, the default of `$GIT_DIR/index`
405         is used.
407 'GIT_OBJECT_DIRECTORY'::
408         If the object storage directory is specified via this
409         environment variable then the sha1 directories are created
410         underneath - otherwise the default `$GIT_DIR/objects`
411         directory is used.
413 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
414         Due to the immutable nature of git objects, old objects can be
415         archived into shared, read-only directories. This variable
416         specifies a ":" separated (on Windows ";" separated) list
417         of git object directories which can be used to search for git
418         objects. New objects will not be written to these directories.
420 'GIT_DIR'::
421         If the 'GIT_DIR' environment variable is set then it
422         specifies a path to use instead of the default `.git`
423         for the base of the repository.
425 'GIT_WORK_TREE'::
426         Set the path to the working tree.  The value will not be
427         used in combination with repositories found automatically in
428         a .git directory (i.e. $GIT_DIR is not set).
429         This can also be controlled by the '--work-tree' command line
430         option and the core.worktree configuration variable.
432 'GIT_CEILING_DIRECTORIES'::
433         This should be a colon-separated list of absolute paths.
434         If set, it is a list of directories that git should not chdir
435         up into while looking for a repository directory.
436         It will not exclude the current working directory or
437         a GIT_DIR set on the command line or in the environment.
438         (Useful for excluding slow-loading network directories.)
440 git Commits
441 ~~~~~~~~~~~
442 'GIT_AUTHOR_NAME'::
443 'GIT_AUTHOR_EMAIL'::
444 'GIT_AUTHOR_DATE'::
445 'GIT_COMMITTER_NAME'::
446 'GIT_COMMITTER_EMAIL'::
447 'GIT_COMMITTER_DATE'::
448 'EMAIL'::
449         see linkgit:git-commit-tree[1]
451 git Diffs
452 ~~~~~~~~~
453 'GIT_DIFF_OPTS'::
454         Only valid setting is "--unified=??" or "-u??" to set the
455         number of context lines shown when a unified diff is created.
456         This takes precedence over any "-U" or "--unified" option
457         value passed on the git diff command line.
459 'GIT_EXTERNAL_DIFF'::
460         When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
461         program named by it is called, instead of the diff invocation
462         described above.  For a path that is added, removed, or modified,
463         'GIT_EXTERNAL_DIFF' is called with 7 parameters:
465         path old-file old-hex old-mode new-file new-hex new-mode
467 where:
469         <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
470                          contents of <old|new>,
471         <old|new>-hex:: are the 40-hexdigit SHA1 hashes,
472         <old|new>-mode:: are the octal representation of the file modes.
475 The file parameters can point at the user's working file
476 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
477 when a new file is added), or a temporary file (e.g. `old-file` in the
478 index).  'GIT_EXTERNAL_DIFF' should not worry about unlinking the
479 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
481 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
482 parameter, <path>.
484 other
485 ~~~~~
486 'GIT_MERGE_VERBOSITY'::
487         A number controlling the amount of output shown by
488         the recursive merge strategy.  Overrides merge.verbosity.
489         See linkgit:git-merge[1]
491 'GIT_PAGER'::
492         This environment variable overrides `$PAGER`. If it is set
493         to an empty string or to the value "cat", git will not launch
494         a pager.
496 'GIT_SSH'::
497         If this environment variable is set then 'git-fetch'
498         and 'git-push' will use this command instead
499         of 'ssh' when they need to connect to a remote system.
500         The '$GIT_SSH' command will be given exactly two arguments:
501         the 'username@host' (or just 'host') from the URL and the
502         shell command to execute on that remote system.
504 To pass options to the program that you want to list in GIT_SSH
505 you will need to wrap the program and options into a shell script,
506 then set GIT_SSH to refer to the shell script.
508 Usually it is easier to configure any desired options through your
509 personal `.ssh/config` file.  Please consult your ssh documentation
510 for further details.
512 'GIT_FLUSH'::
513         If this environment variable is set to "1", then commands such
514         as 'git-blame' (in incremental mode), 'git-rev-list', 'git-log',
515         and 'git-whatchanged' will force a flush of the output stream
516         after each commit-oriented record have been flushed.   If this
517         variable is set to "0", the output of these commands will be done
518         using completely buffered I/O.   If this environment variable is
519         not set, git will choose buffered or record-oriented flushing
520         based on whether stdout appears to be redirected to a file or not.
522 'GIT_TRACE'::
523         If this variable is set to "1", "2" or "true" (comparison
524         is case insensitive), git will print `trace:` messages on
525         stderr telling about alias expansion, built-in command
526         execution and external command execution.
527         If this variable is set to an integer value greater than 1
528         and lower than 10 (strictly) then git will interpret this
529         value as an open file descriptor and will try to write the
530         trace messages into this file descriptor.
531         Alternatively, if this variable is set to an absolute path
532         (starting with a '/' character), git will interpret this
533         as a file path and will try to write the trace messages
534         into it.
536 Discussion[[Discussion]]
537 ------------------------
539 More detail on the following is available from the
540 link:user-manual.html#git-concepts[git concepts chapter of the
541 user-manual] and linkgit:gitcore-tutorial[7].
543 A git project normally consists of a working directory with a ".git"
544 subdirectory at the top level.  The .git directory contains, among other
545 things, a compressed object database representing the complete history
546 of the project, an "index" file which links that history to the current
547 contents of the working tree, and named pointers into that history such
548 as tags and branch heads.
550 The object database contains objects of three main types: blobs, which
551 hold file data; trees, which point to blobs and other trees to build up
552 directory hierarchies; and commits, which each reference a single tree
553 and some number of parent commits.
555 The commit, equivalent to what other systems call a "changeset" or
556 "version", represents a step in the project's history, and each parent
557 represents an immediately preceding step.  Commits with more than one
558 parent represent merges of independent lines of development.
560 All objects are named by the SHA1 hash of their contents, normally
561 written as a string of 40 hex digits.  Such names are globally unique.
562 The entire history leading up to a commit can be vouched for by signing
563 just that commit.  A fourth object type, the tag, is provided for this
564 purpose.
566 When first created, objects are stored in individual files, but for
567 efficiency may later be compressed together into "pack files".
569 Named pointers called refs mark interesting points in history.  A ref
570 may contain the SHA1 name of an object or the name of another ref.  Refs
571 with names beginning `ref/head/` contain the SHA1 name of the most
572 recent commit (or "head") of a branch under development.  SHA1 names of
573 tags of interest are stored under `ref/tags/`.  A special ref named
574 `HEAD` contains the name of the currently checked-out branch.
576 The index file is initialized with a list of all paths and, for each
577 path, a blob object and a set of attributes.  The blob object represents
578 the contents of the file as of the head of the current branch.  The
579 attributes (last modified time, size, etc.) are taken from the
580 corresponding file in the working tree.  Subsequent changes to the
581 working tree can be found by comparing these attributes.  The index may
582 be updated with new content, and new commits may be created from the
583 content stored in the index.
585 The index is also capable of storing multiple entries (called "stages")
586 for a given pathname.  These stages are used to hold the various
587 unmerged version of a file when a merge is in progress.
589 Authors
590 -------
591 * git's founding father is Linus Torvalds <torvalds@osdl.org>.
592 * The current git nurse is Junio C Hamano <gitster@pobox.com>.
593 * The git potty was written by Andreas Ericsson <ae@op5.se>.
594 * General upbringing is handled by the git-list <git@vger.kernel.org>.
596 Documentation
597 --------------
598 The documentation for git suite was started by David Greaves
599 <david@dgreaves.com>, and later enhanced greatly by the
600 contributors on the git-list <git@vger.kernel.org>.
602 SEE ALSO
603 --------
604 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
605 linkgit:everyday[7], linkgit:gitcvs-migration[7],
606 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
607 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual]
611 Part of the linkgit:git[1] suite