aboutsummaryrefslogtreecommitdiff
path: root/USE.md
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2024-05-20 09:47:58 +0200
committerJonas Smedegaard <dr@jones.dk>2024-05-20 09:47:58 +0200
commitcbd4703eb81b583d9a9e91227067368491b88aae (patch)
treef4ae6ad63cbd7fd27ed70fc07b383567701db1ad /USE.md
parentb03347f7e43c3c312e15b3dae1ff342f5a6140ad (diff)
move non-initial parts of SETUP section Clone to new USE section Sync
Diffstat (limited to 'USE.md')
-rw-r--r--USE.md26
1 files changed, 25 insertions, 1 deletions
diff --git a/USE.md b/USE.md
index 7b7cd45..675659b 100644
--- a/USE.md
+++ b/USE.md
@@ -38,7 +38,31 @@ git annex add baz
git commit -m "Update foo bar, and add baz."
```
-(final `git commit` is implied by [`git annex sync` or `git annex move`](#clone))
+(final `git commit` is implied by [`git annex sync` or `git annex move`](#sync))
+
+
+## Sync
+
+To align a git-annex repository with subscribed annex(es),
+request a syncronization:
+
+```shell
+git annex sync --content --all
+```
+
+Alternatively (e.g. on slow/expensive network),
+syncronize only metadata and only with nearest clones:
+
+```shell
+git annex sync
+```
+
+Alternatively (e.g. on small host),
+push the content to only be remote without keeping a local copy:
+
+```shell
+git annex move .
+```
## Access