Merge branch 'jc/for-each-ref' into jc/ref-locking
[git/git.git] / Documentation / git-init-db.txt
1 git-init-db(1)
2 ==============
3
4 NAME
5 ----
6 git-init-db - Creates an empty git repository
7
8
9 SYNOPSIS
10 --------
11 'git-init-db' [--template=<template_directory>] [--shared[=<permissions>]]
12
13
14 OPTIONS
15 -------
16
17 --
18
19 --template=<template_directory>::
20
21 Provide the directory from which templates will be used. The default template
22 directory is `/usr/share/git-core/templates`.
23
24 When specified, `<template_directory>` is used as the source of the template
25 files rather than the default. The template files include some directory
26 structure, some suggested "exclude patterns", and copies of non-executing
27 "hook" files. The suggested patterns and hook files are all modifiable and
28 extensible.
29
30 --shared[={false|true|umask|group|all|world|everybody}]::
31
32 Specify that the git repository is to be shared amongst several users. This
33 allows users belonging to the same group to push into that
34 repository. When specified, the config variable "core.sharedRepository" is
35 set so that files and directories under `$GIT_DIR` are created with the
36 requested permissions. When not specified, git will use permissions reported
37 by umask(2).
38
39 The option can have the following values, defaulting to 'group' if no value
40 is 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
54 DESCRIPTION
55 -----------
56 This command creates an empty git repository - basically a `.git` directory
57 with subdirectories for `objects`, `refs/heads`, `refs/tags`, and
58 template files.
59 An initial `HEAD` file that references the HEAD of the master branch
60 is also created.
61
62 If the `$GIT_DIR` environment variable is set then it specifies a path
63 to use instead of `./.git` for the base of the repository.
64
65 If the object storage directory is specified via the `$GIT_OBJECT_DIRECTORY`
66 environment variable then the sha1 directories are created underneath -
67 otherwise the default `$GIT_DIR/objects` directory is used.
68
69 Running `git-init-db` in an existing repository is safe. It will not overwrite
70 things that are already there. The primary reason for rerunning `git-init-db`
71 is to pick up newly added templates.
72
73
74
75 EXAMPLES
76 --------
77
78 Start 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
90 Author
91 ------
92 Written by Linus Torvalds <torvalds@osdl.org>
93
94 Documentation
95 --------------
96 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
97
98 GIT
99 ---
100 Part of the gitlink:git[7] suite
101