aboutsummaryrefslogtreecommitdiff
path: root/doc/git-annex-init.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2015-03-23 18:20:42 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2015-03-23 18:20:42 -0400
commitd17d5a77893ac01fc7c29f92447a3e85e3501d9f (patch)
tree5be49dd57a28ee56001023893f806b15dcd4c008 /doc/git-annex-init.mdwn
parent277b7335378e41d1a0ecb5fdc93760435b05fc5d (diff)
separated man pages for all the setup commands while at the gate in ATL
Diffstat (limited to 'doc/git-annex-init.mdwn')
-rw-r--r--doc/git-annex-init.mdwn27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/git-annex-init.mdwn b/doc/git-annex-init.mdwn
new file mode 100644
index 000000000..1398923bf
--- /dev/null
+++ b/doc/git-annex-init.mdwn
@@ -0,0 +1,27 @@
+# NAME
+
+git-annex init - initialize git-annex
+
+# SYNOPSIS
+
+git annex init `[description]`
+
+# DESCRIPTION
+
+Until a repository (or one of its remotes) has been initialized,
+git-annex will refuse to operate on it, to avoid accidentally
+using it in a repository that was not intended to have an annex.
+
+It's useful, but not mandatory, to initialize each new clone
+of a repository with its own description. If you don't provide one,
+one will be generated using the username, hostname and the path.
+
+# SEE ALSO
+
+[[git-annex]](1)
+
+# AUTHOR
+
+Joey Hess <id@joeyh.name>
+
+Warning: Automatically converted into a man page by mdwn2man. Edit with care.