summaryrefslogtreecommitdiff
path: root/doc/git-annex-map.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2015-03-24 15:23:59 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2015-03-24 15:23:59 -0400
commit5c8727dea29d5266de481475495eb979038bfa5a (patch)
tree2362c6ba5cd464d1e44f6a08ef4d7d034b594c75 /doc/git-annex-map.mdwn
parentd17d5a77893ac01fc7c29f92447a3e85e3501d9f (diff)
separated man pages for all the maintenance commands
Diffstat (limited to 'doc/git-annex-map.mdwn')
-rw-r--r--doc/git-annex-map.mdwn40
1 files changed, 40 insertions, 0 deletions
diff --git a/doc/git-annex-map.mdwn b/doc/git-annex-map.mdwn
new file mode 100644
index 000000000..6e5ced2b4
--- /dev/null
+++ b/doc/git-annex-map.mdwn
@@ -0,0 +1,40 @@
+# NAME
+
+git-annex map - generate map of repositories
+
+# SYNOPSIS
+
+git annex map
+
+# DESCRIPTION
+
+Helps you keep track of your repositories, and the connections between them,
+by going out and looking at all the ones it can get to, and generating a
+Graphviz file displaying it all. If the `dot` command is available, it is
+used to display the file to your screen (using x11 backend).
+
+This command only connects to hosts that the host it's run on can
+directly connect to. It does not try to tunnel through intermediate hosts.
+So it might not show all connections between the repositories in the network
+
+Also, if connecting to a host requires a password, you might have to enter
+it several times as the map is being built.
+
+Note that this subcommand can be used to graph any git repository; it
+is not limited to git-annex repositories.
+
+# OPTIONS
+
+* `--fast`
+
+ Disable using `dot` to display the generated Graphviz file.
+
+# SEE ALSO
+
+[[git-annex]](1)
+
+# AUTHOR
+
+Joey Hess <id@joeyh.name>
+
+Warning: Automatically converted into a man page by mdwn2man. Edit with care.