Documentation / git-init-db.txton commit gitweb: Refactor printing shortened title in git_shortlog_body and git_tags_body (17d0744)
   1git-init-db(1)
   2==============
   3
   4NAME
   5----
   6git-init-db - Creates an empty git repository
   7
   8
   9SYNOPSIS
  10--------
  11'git-init-db' [--template=<template_directory>] [--shared[=<permissions>]]
  12
  13
  14OPTIONS
  15-------
  16
  17--
  18
  19--template=<template_directory>::
  20
  21Provide the directory from which templates will be used.  The default template
  22directory is `/usr/share/git-core/templates`.
  23
  24When specified, `<template_directory>` is used as the source of the template
  25files rather than the default.  The template files include some directory
  26structure, some suggested "exclude patterns", and copies of non-executing
  27"hook" files.  The suggested patterns and hook files are all modifiable and
  28extensible.
  29
  30--shared[={false|true|umask|group|all|world|everybody}]::
  31
  32Specify that the git repository is to be shared amongst several users.  This
  33allows users belonging to the same group to push into that
  34repository.  When specified, the config variable "core.sharedRepository" is
  35set so that files and directories under `$GIT_DIR` are created with the
  36requested permissions.  When not specified, git will use permissions reported
  37by umask(2).
  38
  39The option can have the following values, defaulting to 'group' if no value
  40is given:
  41
  42 - 'umask' (or 'false'): Use permissions reported by umask(2). The default,
  43   when `--shared` is not specified.
  44
  45 - 'group' (or 'true'): Make the repository group-writable, (and g+sx, since
  46   the git group may be not the primary group of all users).
  47
  48 - 'all' (or 'world' or 'everybody'): Same as 'group', but make the repository
  49   readable by all users.
  50
  51--
  52
  53
  54DESCRIPTION
  55-----------
  56This command creates an empty git repository - basically a `.git` directory
  57with subdirectories for `objects`, `refs/heads`, `refs/tags`, and
  58template files.
  59An initial `HEAD` file that references the HEAD of the master branch
  60is also created.
  61
  62If the `$GIT_DIR` environment variable is set then it specifies a path
  63to use instead of `./.git` for the base of the repository.
  64
  65If the object storage directory is specified via the `$GIT_OBJECT_DIRECTORY`
  66environment variable then the sha1 directories are created underneath -
  67otherwise the default `$GIT_DIR/objects` directory is used.
  68
  69Running `git-init-db` in an existing repository is safe. It will not overwrite
  70things that are already there. The primary reason for rerunning `git-init-db`
  71is to pick up newly added templates.
  72
  73
  74
  75EXAMPLES
  76--------
  77
  78Start a new git repository for an existing code base::
  79+
  80----------------
  81$ cd /path/to/my/codebase
  82$ git-init-db   <1>
  83$ git-add .     <2>
  84----------------
  85+
  86<1> prepare /path/to/my/codebase/.git directory
  87<2> add all existing file to the index
  88
  89
  90Author
  91------
  92Written by Linus Torvalds <torvalds@osdl.org>
  93
  94Documentation
  95--------------
  96Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
  97
  98GIT
  99---
 100Part of the gitlink:git[7] suite
 101