From 119f951d4b91fef9cad0d1ce76d3a430510bfdc1 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Tue, 29 Aug 2017 13:25:48 -0400 Subject: documentation for export This commit was sponsored by Ole-Morten Duesund on Patreon. --- doc/git-annex-export.mdwn | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 doc/git-annex-export.mdwn (limited to 'doc/git-annex-export.mdwn') diff --git a/doc/git-annex-export.mdwn b/doc/git-annex-export.mdwn new file mode 100644 index 000000000..96a09dc9b --- /dev/null +++ b/doc/git-annex-export.mdwn @@ -0,0 +1,37 @@ +# NAME + +git-annex export - export content to a remote + +# SYNOPSIS + +git annex export `treeish --to remote` + +# DESCRIPTION + +Use this command to export a tree of files from a git-annex repository. + +Normally files are stored on a git-annex special remote named by their +keys. That is great for data storage, but your filenames are obscured. +Exporting replicates the tree to the special remote as-is. + +Mixing key/value and exports in the same remote would be a mess and so is +not allowed. So, you have to configure a remote with `exporttree=true` +when initially setting it up with [[git-annex-initremote]](1). + +Repeated exports are done efficiently, by diffing the old and new tree, +and transferring only the changed files. + +Exports can be interrupted and resumed. However, partially uploaded files +will be re-started from the beginning. + +# SEE ALSO + +[[git-annex]](1) + +[[git-annex-export]](1) + +# AUTHOR + +Joey Hess + +Warning: Automatically converted into a man page by mdwn2man. Edit with care. -- cgit v1.2.3