mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

documentation for export

Browse source 
This commit was sponsored by Ole-Morten Duesund on Patreon.
This commit is contained in:
Joey Hess 2017-08-29 13:25:48 -04:00
parent e55e445a36
commit 8f35c6584d
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
4 changed files with 49 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
doc/git-annex-export.mdwn Normal file
View file

@ -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 <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.

2
doc/git-annex-import.mdwn
View file

@ -96,6 +96,8 @@ instead of to the annex.
[[git-annex-add]](1) [[git-annex-add]](1)
[[git-annex-export]](1)
# AUTHOR # AUTHOR
Joey Hess <id@joeyh.name> Joey Hess <id@joeyh.name>

6
doc/git-annex.mdwn
View file

@ -158,6 +158,12 @@ subdirectories).
See [[git-annex-importfeed]](1) for details. See [[git-annex-importfeed]](1) for details.
* `export treeish --to remote`
Export content to a remote.
See [[git-annex-export]](1) for details.
* `undo [filename|directory] ...` * `undo [filename|directory] ...`
Undo last change to a file or directory. Undo last change to a file or directory.

4
doc/special_remotes/directory.mdwn
View file

@ -31,6 +31,10 @@ remote:
Do not use for new remotes. It is not safe to change the chunksize Do not use for new remotes. It is not safe to change the chunksize
setting of an existing remote. setting of an existing remote.
* `exporttree` - Set to "true" to make this special remote usable
by [[git-annex-export]]. It will not be usable as a general-purpose
special remote.
Setup example: Setup example:
# git annex initremote usbdrive type=directory directory=/media/usbdrive/ encryption=none # git annex initremote usbdrive type=directory directory=/media/usbdrive/ encryption=none