aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2017-08-15 12:39:10 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2017-08-15 12:39:10 -0400
commit802cecdf36f2575b62c42b105019ea70f3e8aef8 (patch)
tree6f251c57d645bbcbd758632f87858eec06611920 /doc
parentcb91d1539e4f7d935c5106dbf54a7d58b5f297d6 (diff)
move, copy: Support --batch.
Diffstat (limited to 'doc')
-rw-r--r--doc/git-annex-copy.mdwn13
-rw-r--r--doc/git-annex-move.mdwn13
-rw-r--r--doc/todo/--batch_for_copy.mdwn2
3 files changed, 28 insertions, 0 deletions
diff --git a/doc/git-annex-copy.mdwn b/doc/git-annex-copy.mdwn
index ecf78e905..c15a29f72 100644
--- a/doc/git-annex-copy.mdwn
+++ b/doc/git-annex-copy.mdwn
@@ -75,6 +75,19 @@ Copies the content of files from or to another remote.
The [[git-annex-matching-options]](1)
can be used to specify files to copy.
+* `--batch`
+
+ Enables batch mode, in which lines containing names of files to copy
+ are read from stdin.
+
+ As each specified file is processed, the usual progress output is
+ displayed. If a file's content does not need to be copied or it
+ is not an annexed file, a blank line is output in response instead.
+
+ Since the usual output while copying a file is verbose and not
+ machine-parseable, you may want to use --json in combination with
+ --batch.
+
* `--json`
Enable JSON output. This is intended to be parsed by programs that use
diff --git a/doc/git-annex-move.mdwn b/doc/git-annex-move.mdwn
index 0aa349dee..4e42e934f 100644
--- a/doc/git-annex-move.mdwn
+++ b/doc/git-annex-move.mdwn
@@ -70,6 +70,19 @@ Moves the content of files from or to another remote.
The [[git-annex-matching-options]](1)
can be used to specify files to move.
+* `--batch`
+
+ Enables batch mode, in which lines containing names of files to move
+ are read from stdin.
+
+ As each specified file is processed, the usual progress output is
+ displayed. If a file's content does not need to be moved or it
+ is not an annexed file, a blank line is output in response instead.
+
+ Since the usual output while moving a file is verbose and not
+ machine-parseable, you may want to use --json in combination with
+ --batch.
+
* `--json`
Enable JSON output. This is intended to be parsed by programs that use
diff --git a/doc/todo/--batch_for_copy.mdwn b/doc/todo/--batch_for_copy.mdwn
index 53cb77eec..0db965677 100644
--- a/doc/todo/--batch_for_copy.mdwn
+++ b/doc/todo/--batch_for_copy.mdwn
@@ -7,3 +7,5 @@ nothing
"""]]
[!meta author=yoh]
+
+> [[done]] for copy and move --[[Joey]]