aboutsummaryrefslogtreecommitdiff
path: root/doc/git-annex-testremote.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2015-03-25 12:09:49 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2015-03-25 12:09:49 -0400
commitf77d5bcc56a4692f321896dedab75c6ec32f967a (patch)
treeb57bf5d62fe1651502917f13d093ce9b4d79a6c3 /doc/git-annex-testremote.mdwn
parent00c09b2038611de97c26f4141a748f08cc8fe570 (diff)
finished splitting out man pages for all commands
Diffstat (limited to 'doc/git-annex-testremote.mdwn')
-rw-r--r--doc/git-annex-testremote.mdwn39
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/git-annex-testremote.mdwn b/doc/git-annex-testremote.mdwn
new file mode 100644
index 000000000..fff08fdcc
--- /dev/null
+++ b/doc/git-annex-testremote.mdwn
@@ -0,0 +1,39 @@
+# NAME
+
+git-annex testremote - test transfers to/from a remote
+
+# SYNOPSIS
+
+git annex testremote `remote`
+
+# DESCRIPTION
+
+This tests a remote by generating some random objects and sending them to
+the remote, then redownloading them, removing them from the remote, etc.
+
+It's safe to run in an existing repository (the repository contents are
+not altered), although it may perform expensive data transfers.
+
+Testing a single remote will use the remote's configuration,
+automatically varying the chunk sizes, and with simple shared encryption
+enabled and disabled.
+
+# OPTIONS
+
+* `--fast`
+
+ Perform a smaller set of tests.
+
+* `--size=NUnits`
+
+ Tune the base size of the generated objects. The default is 1MiB.
+
+# SEE ALSO
+
+[[git-annex]](1)
+
+# AUTHOR
+
+Joey Hess <id@joeyh.name>
+
+Warning: Automatically converted into a man page by mdwn2man. Edit with care.