Add documentation for git-config-set

[git.git] / Documentation / git.txt

diff --git a/Documentation/git.txt b/Documentation/git.txt
index 054f091..694fee8 100644 (file)
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -8,13 +8,33 @@ git - the stupid content tracker
 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------

-'git-<command>' <args>
+'git' [--version] [--exec-path[=GIT_EXEC_PATH]] [--help] COMMAND [ARGS]

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------

-
-This is reference information for the core git commands.
-
+'git' is both a program and a directory content tracker system.
+The program 'git' is just a wrapper to reach the core git programs
+(or a potty if you like, as it's not exactly porcelain but still
+brings your stuff to the plumbing).
+
+OPTIONS
+-------
+--version::
+       prints the git suite version that the 'git' program came from.
+
+--help::
+       prints the synopsis and a list of available commands.
+       If a git command is named this option will bring up the
+       man-page for that command.
+
+--exec-path::
+       path to wherever your core git programs are installed.
+       This can also be controlled by setting the GIT_EXEC_PATH
+       environment variable. If no path is given 'git' will print
+       the current setting and then exit.
+
+CORE GIT COMMANDS
+-----------------

 Before reading this cover to cover, you may want to take a look
 at the link:tutorial.html[tutorial] document.
 
 Before reading this cover to cover, you may want to take a look
 at the link:tutorial.html[tutorial] document.
 


@@ -40,7 +60,7 @@ reflect recent changes.
 Commands Overview
 -----------------
 The git commands can helpfully be split into those that manipulate
 Commands Overview
 -----------------
 The git commands can helpfully be split into those that manipulate

-the repository, the cache and the working fileset, those that
+the repository, the index and the working fileset, those that

 interrogate and compare them, and those that moves objects and
 references between repositories.
 
 interrogate and compare them, and those that moves objects and
 references between repositories.
 


@@ -59,16 +79,18 @@ gitlink:git-apply[1]::
        applies it to the working tree.
 
 gitlink:git-checkout-index[1]::
        applies it to the working tree.
 
 gitlink:git-checkout-index[1]::

-       Copy files from the cache to the working directory
-       Previously this command was known as git-checkout-cache.
+       Copy files from the index to the working directory

 
 gitlink:git-commit-tree[1]::
        Creates a new commit object
 
 
 gitlink:git-commit-tree[1]::
        Creates a new commit object
 

+gitlink:git-config-set[1]::
+       Set options in .git/config.
+

 gitlink:git-hash-object[1]::
        Computes the object ID from a file.
 
 gitlink:git-hash-object[1]::
        Computes the object ID from a file.
 

-gitlink:git-index-pack.html[1]::
+gitlink:git-index-pack[1]::

        Build pack index file for an existing packed archive.
 
 gitlink:git-init-db[1]::
        Build pack index file for an existing packed archive.
 
 gitlink:git-init-db[1]::


@@ -76,7 +98,6 @@ gitlink:git-init-db[1]::
 
 gitlink:git-merge-index[1]::
        Runs a merge for files needing merging
 
 gitlink:git-merge-index[1]::
        Runs a merge for files needing merging

-       Previously this command was known as git-merge-cache.

 
 gitlink:git-mktag[1]::
        Creates a tag object
 
 gitlink:git-mktag[1]::
        Creates a tag object


@@ -88,17 +109,16 @@ gitlink:git-prune-packed[1]::
        Remove extra objects that are already in pack files.
 
 gitlink:git-read-tree[1]::
        Remove extra objects that are already in pack files.
 
 gitlink:git-read-tree[1]::

-       Reads tree information into the directory cache
+       Reads tree information into the directory index

 
 gitlink:git-unpack-objects[1]::
        Unpacks objects out of a packed archive.
 
 gitlink:git-update-index[1]::
        Modifies the index or directory cache
 
 gitlink:git-unpack-objects[1]::
        Unpacks objects out of a packed archive.
 
 gitlink:git-update-index[1]::
        Modifies the index or directory cache

-       Previously this command was known as git-update-cache.

 
 gitlink:git-write-tree[1]::
 
 gitlink:git-write-tree[1]::

-       Creates a tree from the current cache
+       Creates a tree from the current index

 
 
 Interrogation commands
 
 
 Interrogation commands


@@ -108,11 +128,10 @@ gitlink:git-cat-file[1]::
        Provide content or type information for repository objects
 
 gitlink:git-diff-index[1]::
        Provide content or type information for repository objects
 
 gitlink:git-diff-index[1]::

-       Compares content and mode of blobs between the cache and repository
-       Previously this command was known as git-diff-cache.
+       Compares content and mode of blobs between the index and repository

 
 gitlink:git-diff-files[1]::
 
 gitlink:git-diff-files[1]::

-       Compares files in the working tree and the cache
+       Compares files in the working tree and the index

 
 gitlink:git-diff-stages[1]::
        Compares two "merge stages" in the index file.
 
 gitlink:git-diff-stages[1]::
        Compares two "merge stages" in the index file.


@@ -122,10 +141,9 @@ gitlink:git-diff-tree[1]::
 
 gitlink:git-fsck-objects[1]::
        Verifies the connectivity and validity of the objects in the database
 
 gitlink:git-fsck-objects[1]::
        Verifies the connectivity and validity of the objects in the database

-       Previously this command was known as git-fsck-cache.

 
 gitlink:git-ls-files[1]::
 
 gitlink:git-ls-files[1]::

-       Information about files in the cache/working directory
+       Information about files in the index/working directory

 
 gitlink:git-ls-tree[1]::
        Displays a tree object in human readable form
 
 gitlink:git-ls-tree[1]::
        Displays a tree object in human readable form


@@ -133,6 +151,9 @@ gitlink:git-ls-tree[1]::
 gitlink:git-merge-base[1]::
        Finds as good a common ancestor as possible for a merge
 
 gitlink:git-merge-base[1]::
        Finds as good a common ancestor as possible for a merge
 

+gitlink:git-name-rev[1]::
+       Find symbolic names for given revs
+

 gitlink:git-rev-list[1]::
        Lists commit objects in reverse chronological order
 
 gitlink:git-rev-list[1]::
        Lists commit objects in reverse chronological order
 


@@ -167,11 +188,9 @@ gitlink:git-fetch-pack[1]::
 
 gitlink:git-http-fetch[1]::
        Downloads a remote git repository via HTTP
 
 gitlink:git-http-fetch[1]::
        Downloads a remote git repository via HTTP

-       Previously this command was known as git-http-pull.

 
 gitlink:git-local-fetch[1]::
        Duplicates another git repository on a local system
 
 gitlink:git-local-fetch[1]::
        Duplicates another git repository on a local system

-       Previously this command was known as git-local-pull.

 
 gitlink:git-peek-remote[1]::
        Lists references on a remote repository using upload-pack protocol.
 
 gitlink:git-peek-remote[1]::
        Lists references on a remote repository using upload-pack protocol.


@@ -187,11 +206,9 @@ gitlink:git-shell[1]::
 
 gitlink:git-ssh-fetch[1]::
        Pulls from a remote repository over ssh connection
 
 gitlink:git-ssh-fetch[1]::
        Pulls from a remote repository over ssh connection

-       Previously this command was known as git-ssh-pull.

 
 gitlink:git-ssh-upload[1]::
        Helper "server-side" program used by git-ssh-fetch
 
 gitlink:git-ssh-upload[1]::
        Helper "server-side" program used by git-ssh-fetch

-       Previously this command was known as git-ssh-push.

 
 gitlink:git-update-server-info[1]::
        Updates auxiliary information on a dumb server to help
 
 gitlink:git-update-server-info[1]::
        Updates auxiliary information on a dumb server to help


@@ -207,7 +224,6 @@ Porcelain-ish Commands
 
 gitlink:git-add[1]::
        Add paths to the index file.
 
 gitlink:git-add[1]::
        Add paths to the index file.

-       Previously this command was known as git-add-script.

 
 gitlink:git-am[1]::
        Apply patches from a mailbox, but cooler.
 
 gitlink:git-am[1]::
        Apply patches from a mailbox, but cooler.


@@ -217,50 +233,39 @@ gitlink:git-applymbox[1]::
 
 gitlink:git-bisect[1]::
        Find the change that introduced a bug.
 
 gitlink:git-bisect[1]::
        Find the change that introduced a bug.

-       Previously this command was known as git-bisect-script.

 
 gitlink:git-branch[1]::
        Create and Show branches.
 
 gitlink:git-branch[1]::
        Create and Show branches.

-       Previously this command was known as git-branch-script.

 
 gitlink:git-checkout[1]::
        Checkout and switch to a branch.
 
 gitlink:git-checkout[1]::
        Checkout and switch to a branch.

-       Previously this command was known as git-checkout-script.

 
 gitlink:git-cherry-pick[1]::
        Cherry-pick the effect of an existing commit.
 
 gitlink:git-cherry-pick[1]::
        Cherry-pick the effect of an existing commit.

-       Previously this command was known as git-cherry-pick-script.

 
 gitlink:git-clone[1]::
        Clones a repository into a new directory.
 
 gitlink:git-clone[1]::
        Clones a repository into a new directory.

-       Previously this command was known as git-clone-script.

 
 gitlink:git-commit[1]::
        Record changes to the repository.
 
 gitlink:git-commit[1]::
        Record changes to the repository.

-       Previously this command was known as git-commit-script.

 
 gitlink:git-diff[1]::
        Show changes between commits, commit and working tree, etc.
 
 gitlink:git-diff[1]::
        Show changes between commits, commit and working tree, etc.

-       Previously this command was known as git-diff-script.

 
 gitlink:git-fetch[1]::
        Download from a remote repository via various protocols.
 
 gitlink:git-fetch[1]::
        Download from a remote repository via various protocols.

-       Previously this command was known as git-fetch-script.

 
 gitlink:git-format-patch[1]::
        Prepare patches for e-mail submission.
 
 gitlink:git-format-patch[1]::
        Prepare patches for e-mail submission.

-       Previously this command was known as git-format-patch-script.

 
 gitlink:git-grep[1]::
        Print lines matching a pattern
 
 gitlink:git-log[1]::
        Shows commit logs.
 
 gitlink:git-grep[1]::
        Print lines matching a pattern
 
 gitlink:git-log[1]::
        Shows commit logs.

-       Previously this command was known as git-log-script.

 
 gitlink:git-ls-remote[1]::
        Shows references in a remote or local repository.
 
 gitlink:git-ls-remote[1]::
        Shows references in a remote or local repository.

-       Previously this command was known as git-ls-remote-script.

 
 gitlink:git-merge[1]::
        Grand unified merge driver.
 
 gitlink:git-merge[1]::
        Grand unified merge driver.


@@ -270,39 +275,27 @@ gitlink:git-mv[1]::
 
 gitlink:git-octopus[1]::
        Merge more than two commits.
 
 gitlink:git-octopus[1]::
        Merge more than two commits.

-       Previously this command was known as git-octopus-script.

 
 gitlink:git-pull[1]::
        Fetch from and merge with a remote repository.
 
 gitlink:git-pull[1]::
        Fetch from and merge with a remote repository.

-       Previously this command was known as git-pull-script.

 
 gitlink:git-push[1]::
        Update remote refs along with associated objects.
 
 gitlink:git-push[1]::
        Update remote refs along with associated objects.

-       Previously this command was known as git-push-script.

 
 gitlink:git-rebase[1]::
        Rebase local commits to new upstream head.
 
 gitlink:git-rebase[1]::
        Rebase local commits to new upstream head.

-       Previously this command was known as git-rebase-script.
-
-gitlink:git-rename[1]::
-       Rename files and directories.
-       Previously this command was known as git-rename-script.

 
 gitlink:git-repack[1]::
        Pack unpacked objects in a repository.
 
 gitlink:git-repack[1]::
        Pack unpacked objects in a repository.

-       Previously this command was known as git-repack-script.

 
 gitlink:git-reset[1]::
        Reset current HEAD to the specified state.
 
 gitlink:git-reset[1]::
        Reset current HEAD to the specified state.

-       Previously this command was known as git-reset-script.

 
 gitlink:git-resolve[1]::
        Merge two commits.
 
 gitlink:git-resolve[1]::
        Merge two commits.

-       Previously this command was known as git-resolve-script.

 
 gitlink:git-revert[1]::
        Revert an existing commit.
 
 gitlink:git-revert[1]::
        Revert an existing commit.

-       Previously this command was known as git-revert-script.

 
 gitlink:git-shortlog[1]::
        Summarizes 'git log' output.
 
 gitlink:git-shortlog[1]::
        Summarizes 'git log' output.


@@ -312,11 +305,9 @@ gitlink:git-show-branch[1]::
 
 gitlink:git-status[1]::
        Shows the working tree status.
 
 gitlink:git-status[1]::
        Shows the working tree status.

-       Previously this command was known as git-status-script.

 
 gitlink:git-verify-tag[1]::
        Check the GPG signature of tag.
 
 gitlink:git-verify-tag[1]::
        Check the GPG signature of tag.

-       Previously this command was known as git-verify-tag-script.

 
 gitlink:git-whatchanged[1]::
        Shows commit logs and differences they introduce.
 
 gitlink:git-whatchanged[1]::
        Shows commit logs and differences they introduce.


@@ -331,38 +322,36 @@ gitlink:git-applypatch[1]::
 
 gitlink:git-archimport[1]::
        Import an arch repository into git.
 
 gitlink:git-archimport[1]::
        Import an arch repository into git.

-       Previously this command was known as git-archimport-script.

 
 gitlink:git-convert-objects[1]::
        Converts old-style git repository
 
 gitlink:git-convert-objects[1]::
        Converts old-style git repository

-       Previously this command was known as git-convert-cache.

 
 gitlink:git-cvsimport[1]::
        Salvage your data out of another SCM people love to hate.
 
 gitlink:git-cvsimport[1]::
        Salvage your data out of another SCM people love to hate.

-       Previously this command was known as git-cvsimport-script.
+
+gitlink:git-lost-found[1]::
+       Recover lost refs that luckily have not yet been pruned.

 
 gitlink:git-merge-one-file[1]::
        The standard helper program to use with "git-merge-index"
 
 gitlink:git-merge-one-file[1]::
        The standard helper program to use with "git-merge-index"

-       Previously this command was known as git-merge-one-file-script.

 
 gitlink:git-prune[1]::
        Prunes all unreachable objects from the object database
 
 gitlink:git-prune[1]::
        Prunes all unreachable objects from the object database

-       Previously this command was known as git-prune-script.

 
 gitlink:git-relink[1]::
        Hardlink common objects in local repositories.
 
 gitlink:git-relink[1]::
        Hardlink common objects in local repositories.

-       Previously this command was known as git-relink-script.

 
 gitlink:git-svnimport[1]::
        Import a SVN repository into git.
 
 gitlink:git-sh-setup[1]::
        Common git shell script setup code.
 
 gitlink:git-svnimport[1]::
        Import a SVN repository into git.
 
 gitlink:git-sh-setup[1]::
        Common git shell script setup code.

-       Previously this command was known as git-sh-setup-script.
+
+gitlink:git-symbolic-ref[1]::
+       Read and modify symbolic refs

 
 gitlink:git-tag[1]::
        An example script to create a tag object signed with GPG
 
 gitlink:git-tag[1]::
        An example script to create a tag object signed with GPG

-       Previously this command was known as git-tag-script.

 
 gitlink:git-update-ref[1]::
        Update the object name stored in a ref safely.
 
 gitlink:git-update-ref[1]::
        Update the object name stored in a ref safely.


@@ -378,7 +367,6 @@ gitlink:git-cherry[1]::
 
 gitlink:git-count-objects[1]::
        Count unpacked number of objects and their disk consumption.
 
 gitlink:git-count-objects[1]::
        Count unpacked number of objects and their disk consumption.

-       Previously this command was known as git-count-objects-script.

 
 gitlink:git-daemon[1]::
        A really simple server for git repositories.
 
 gitlink:git-daemon[1]::
        A really simple server for git repositories.


@@ -397,18 +385,15 @@ gitlink:git-patch-id[1]::
 
 gitlink:git-parse-remote[1]::
        Routines to help parsing $GIT_DIR/remotes/
 
 gitlink:git-parse-remote[1]::
        Routines to help parsing $GIT_DIR/remotes/

-       Previously this command was known as git-parse-remote-script.

 
 gitlink:git-request-pull[1]::
        git-request-pull.
 
 gitlink:git-request-pull[1]::
        git-request-pull.

-       Previously this command was known as git-request-pull-script.

 
 gitlink:git-rev-parse[1]::
        Pick out and massage parameters.
 
 gitlink:git-send-email[1]::
        Send patch e-mails out of "format-patch --mbox" output.
 
 gitlink:git-rev-parse[1]::
        Pick out and massage parameters.
 
 gitlink:git-send-email[1]::
        Send patch e-mails out of "format-patch --mbox" output.

-       Previously this command was known as git-send-email-script.

 
 gitlink:git-symbolic-refs[1]::
        Read and modify symbolic refs.
 
 gitlink:git-symbolic-refs[1]::
        Read and modify symbolic refs.


@@ -424,6 +409,37 @@ gitlink:gitk[1]::
        gitk.
 
 
        gitk.
 
 

+Configuration Mechanism
+-----------------------
+
+Starting from 0.99.9 (actually mid 0.99.8.GIT), .git/config file
+is used to hold per-repository configuration options.  It is a
+simple text file modelled after `.ini` format familiar to some
+people.  Here is an example:
+
+------------
+#
+# This is the config file, and
+# a '#' or ';' character indicates
+# a comment
+#
+
+; core variables
+[core]
+       ; Don't trust file modes
+       filemode = false
+
+; user identity
+[user]
+       name = "Junio C Hamano"
+       email = "junkio@twinsun.com"
+
+------------
+
+Various commands read from the configuration file and adjust
+their operation accordingly.
+
+

 Identifier Terminology
 ----------------------
 <object>::
 Identifier Terminology
 ----------------------
 <object>::


@@ -497,8 +513,8 @@ git so take care if using Cogito etc
 
 'GIT_INDEX_FILE'::
        This environment allows the specification of an alternate
 
 'GIT_INDEX_FILE'::
        This environment allows the specification of an alternate

-       cache/index file. If not specified, the default of
-       `$GIT_DIR/index` is used.
+       index file. If not specified, the default of `$GIT_DIR/index`
+       is used.

 
 'GIT_OBJECT_DIRECTORY'::
        If the object storage directory is specified via this
 
 'GIT_OBJECT_DIRECTORY'::
        If the object storage directory is specified via this


@@ -540,9 +556,12 @@ Discussion[[Discussion]]
 ------------------------
 include::../README[]
 
 ------------------------
 include::../README[]
 

-Author
-------
-Written by Linus Torvalds <torvalds@osdl.org> and the git-list <git@vger.kernel.org>.
+Authors
+-------
+       git's founding father is Linus Torvalds <torvalds@osdl.org>.
+       The current git nurse is Junio C. Hamano <junkio@cox.net>.
+       The git potty was written by Andres Ericsson <ae@op5.se>.
+       General upbringing is handled by the git-list <git@vger.kernel.org>.

 
 Documentation
 --------------
 
 Documentation
 --------------