7121: Add comment about why buffers must be returned.
[arvados.git] / doc / sdk / cli / subcommands.html.textile.liquid
index c7655ba78e9a22b7068d02fba1ea9565df5f9d13..018213c1a1815061f3265a85040937dcb53652a7 100644 (file)
@@ -45,11 +45,11 @@ h3(#arv-copy). arv copy
 <notextile>
 <pre>
 $ <code class="userinput">arv copy --help</code>
-usage: arv-copy [-h] [-v] [--progress] [--no-progress] [-f] --src
-                SOURCE_ARVADOS --dst DESTINATION_ARVADOS [--recursive]
-                [--no-recursive] [--dst-git-repo DST_GIT_REPO]
-                [--project-uuid PROJECT_UUID] [--retries RETRIES]
-                object_uuid
+usage: arv_copy.py [-h] [-v] [--progress] [--no-progress] [-f] --src
+                   SOURCE_ARVADOS --dst DESTINATION_ARVADOS [--recursive]
+                   [--no-recursive] [--dst-git-repo DST_GIT_REPO]
+                   [--project-uuid PROJECT_UUID] [--retries RETRIES]
+                   object_uuid
 
 Copy a pipeline instance, template or collection from one Arvados instance to
 another.
@@ -64,15 +64,15 @@ optional arguments:
   --no-progress         Do not report progress on copying collections.
   -f, --force           Perform copy even if the object appears to exist at
                         the remote destination.
-  --src SOURCE_ARVADOS  The name of the source Arvados instance (required).
-                        May be either a pathname to a config file, or the
-                        basename of a file in
-                        $HOME/.config/arvados/instance_name.conf.
+  --src SOURCE_ARVADOS  The name of the source Arvados instance (required) -
+                        points at an Arvados config file. May be either a
+                        pathname to a config file, or (for example) "foo" as
+                        shorthand for $HOME/.config/arvados/foo.conf.
   --dst DESTINATION_ARVADOS
                         The name of the destination Arvados instance
-                        (required). May be either a pathname to a config file,
-                        or the basename of a file in
-                        $HOME/.config/arvados/instance_name.conf.
+                        (required) - points at an Arvados config file. May be
+                        either a pathname to a config file, or (for example)
+                        "foo" as shorthand for $HOME/.config/arvados/foo.conf.
   --recursive           Recursively copy any dependencies for this object.
                         (default)
   --no-recursive        Do not copy any dependencies. NOTE: if this option is
@@ -387,7 +387,7 @@ optional arguments:
                         exit
   --local               Run locally using arv-run-pipeline-instance
   --docker-image DOCKER_IMAGE
-                        Docker image to use, default arvados/jobs
+                        Docker image to use, otherwise use instance default.
   --ignore-rcode        Commands that return non-zero return codes should not
                         be considered failed.
   --no-reuse            Do not reuse past jobs.