Documentation/git-init.txt

   1 git-init(1)
   2 ===========
   3
   4 NAME
   5 ----
   6 git-init - Create an empty git repository or reinitialize an existing one
   7
   8
   9 SYNOPSIS
  10 --------
  11 'git-init' [-q | --quiet] [--template=<template_directory>] [--shared[=<permissions>]]
  12
  13
  14 OPTIONS
  15 -------
  16
  17 --
  18
  19 -q, \--quiet::
  20
  21 Only print error and warning messages, all other output will be suppressed.
  22
  23 --template=<template_directory>::
  24
  25 Provide the directory from which templates will be used.  The default template
  26 directory is `/usr/share/git-core/templates`.
  27
  28 When specified, `<template_directory>` is used as the source of the template
  29 files rather than the default.  The template files include some directory
  30 structure, some suggested "exclude patterns", and copies of non-executing
  31 "hook" files.  The suggested patterns and hook files are all modifiable and
  32 extensible.
  33
  34 --shared[={false|true|umask|group|all|world|everybody|0xxx}]::
  35
  36 Specify that the git repository is to be shared amongst several users.  This
  37 allows users belonging to the same group to push into that
  38 repository.  When specified, the config variable "core.sharedRepository" is
  39 set so that files and directories under `$GIT_DIR` are created with the
  40 requested permissions.  When not specified, git will use permissions reported
  41 by umask(2).
  42
  43 The option can have the following values, defaulting to 'group' if no value
  44 is given:
  45
  46  - 'umask' (or 'false'): Use permissions reported by umask(2). The default,
  47    when `--shared` is not specified.
  48
  49  - 'group' (or 'true'): Make the repository group-writable, (and g+sx, since
  50    the git group may be not the primary group of all users).
  51
  52  - 'all' (or 'world' or 'everybody'): Same as 'group', but make the repository
  53    readable by all users.
  54
  55  - '0xxx': '0xxx' is an octal number and each file will have mode '0xxx'
  56    Any option except 'umask' can be set using this option. '0xxx' will
  57    override users umask(2) value, and thus, users with a safe umask (0077)
  58    can use this option. '0640' will create a repository which is group-readable
  59    but not writable. '0660' is equivalent to 'group'.
  60
  61 By default, the configuration flag receive.denyNonFastForwards is enabled
  62 in shared repositories, so that you cannot force a non fast-forwarding push
  63 into it.
  64
  65 --
  66
  67
  68 DESCRIPTION
  69 -----------
  70 This command creates an empty git repository - basically a `.git` directory
  71 with subdirectories for `objects`, `refs/heads`, `refs/tags`, and
  72 template files.
  73 An initial `HEAD` file that references the HEAD of the master branch
  74 is also created.
  75
  76 If the `$GIT_DIR` environment variable is set then it specifies a path
  77 to use instead of `./.git` for the base of the repository.
  78
  79 If the object storage directory is specified via the `$GIT_OBJECT_DIRECTORY`
  80 environment variable then the sha1 directories are created underneath -
  81 otherwise the default `$GIT_DIR/objects` directory is used.
  82
  83 Running `git-init` in an existing repository is safe. It will not overwrite
  84 things that are already there. The primary reason for rerunning `git-init`
  85 is to pick up newly added templates.
  86
  87 Note that `git-init` is the same as `git-init-db`.  The command
  88 was primarily meant to initialize the object database, but over
  89 time it has become responsible for setting up the other aspects
  90 of the repository, such as installing the default hooks and
  91 setting the configuration variables.  The old name is retained
  92 for backward compatibility reasons.
  93
  94
  95 EXAMPLES
  96 --------
  97
  98 Start a new git repository for an existing code base::
  99 +
 100 ----------------
 101 $ cd /path/to/my/codebase
 102 $ git-init      <1>
 103 $ git-add .     <2>
 104 ----------------
 105 +
 106 <1> prepare /path/to/my/codebase/.git directory
 107 <2> add all existing file to the index
 108
 109
 110 Author
 111 ------
 112 Written by Linus Torvalds <torvalds@osdl.org>
 113
 114 Documentation
 115 --------------
 116 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
 117
 118 GIT
 119 ---
 120 Part of the linkgit:git[7] suite