Documentation / git-credential-cache.txton commit git-rebase.sh: update help messages a bit (d4e8062)
   1git-credential-cache(1)
   2=======================
   3
   4NAME
   5----
   6git-credential-cache - Helper to temporarily store passwords in memory
   7
   8SYNOPSIS
   9--------
  10-----------------------------
  11git config credential.helper 'cache [<options>]'
  12-----------------------------
  13
  14DESCRIPTION
  15-----------
  16
  17This command caches credentials in memory for use by future Git
  18programs. The stored credentials never touch the disk, and are forgotten
  19after a configurable timeout.  The cache is accessible over a Unix
  20domain socket, restricted to the current user by filesystem permissions.
  21
  22You probably don't want to invoke this command directly; it is meant to
  23be used as a credential helper by other parts of Git. See
  24linkgit:gitcredentials[7] or `EXAMPLES` below.
  25
  26OPTIONS
  27-------
  28
  29--timeout <seconds>::
  30
  31        Number of seconds to cache credentials (default: 900).
  32
  33--socket <path>::
  34
  35        Use `<path>` to contact a running cache daemon (or start a new
  36        cache daemon if one is not started).
  37        Defaults to `$XDG_CACHE_HOME/git/credential/socket` unless
  38        `~/.git-credential-cache/` exists in which case
  39        `~/.git-credential-cache/socket` is used instead.
  40        If your home directory is on a network-mounted filesystem, you
  41        may need to change this to a local filesystem. You must specify
  42        an absolute path.
  43
  44CONTROLLING THE DAEMON
  45----------------------
  46
  47If you would like the daemon to exit early, forgetting all cached
  48credentials before their timeout, you can issue an `exit` action:
  49
  50--------------------------------------
  51git credential-cache exit
  52--------------------------------------
  53
  54EXAMPLES
  55--------
  56
  57The point of this helper is to reduce the number of times you must type
  58your username or password. For example:
  59
  60------------------------------------
  61$ git config credential.helper cache
  62$ git push http://example.com/repo.git
  63Username: <type your username>
  64Password: <type your password>
  65
  66[work for 5 more minutes]
  67$ git push http://example.com/repo.git
  68[your credentials are used automatically]
  69------------------------------------
  70
  71You can provide options via the credential.helper configuration
  72variable (this example drops the cache time to 5 minutes):
  73
  74-------------------------------------------------------
  75$ git config credential.helper 'cache --timeout=300'
  76-------------------------------------------------------
  77
  78GIT
  79---
  80Part of the linkgit:git[1] suite