Merge branch 'master' into 14965-arv-mount-py-three

[arvados.git] / doc / sdk / cli / subcommands.html.textile.liquid

diff --git a/doc/sdk/cli/subcommands.html.textile.liquid b/doc/sdk/cli/subcommands.html.textile.liquid
index 80ed56a22d5ac24514cb978b74491bf22341cc82..b23ec46fa75f35f1955aea204d3f01bd6407f365 100644 (file)
--- a/doc/sdk/cli/subcommands.html.textile.liquid
+++ b/doc/sdk/cli/subcommands.html.textile.liquid
@@ -5,6 +5,11 @@ navmenu: CLI
 title: "arv subcommands"
 
 ...
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
+
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
 
 _In order to use the @arv@ command, make sure that you have a "working environment.":{{site.baseurl}}/user/getting_started/check-environment.html_
 
@@ -27,19 +32,11 @@ h3(#arv-get). arv get
 
 <notextile>
 <pre>
-$ <code class="userinput">arv arv get --help</code>
-Usage: arv get [uuid] [fields...]
-Fetch the specified Arvados object, select the specified fields,
-and print a text representation (json or yaml, use --format).
-</pre>
-</notextile>
-*Note*: the 'format' flag is used by @arv@ (not @arv get@), as detailed on the "arv CLI overview page":{{site.baseurl}}/sdk/cli/index.html.
+$ <code class="userinput">arv get --help</code>
+Usage: arv [--format json|yaml] get [uuid] [fields...]
 
-This command can be used instead of the previously required:
-
-<notextile>
-<pre>
-$ <code class="userinput">EDITOR=cat arv edit [uuid]</code>
+Fetch the specified Arvados object, select the specified fields,
+and print a text representation.
 </pre>
 </notextile>
 
@@ -67,11 +64,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.
@@ -86,15 +83,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
@@ -143,6 +140,8 @@ arv tag remove --all
 
 h3(#arv-ws). arv ws
 
+This is a frontend to @arv-ws@.
+
 @arv ws@ provides access to the websockets event stream.
 
 <notextile>
@@ -171,7 +170,7 @@ optional arguments:
 
 h3(#arv-keep). arv keep
 
-@arv keep@ provides access to the Keep storage service.
+@arv keep@ commands for accessing the Keep storage service.
 
 <notextile>
 <pre>
@@ -179,12 +178,14 @@ $ <code class="userinput">arv keep --help</code>
 Usage: arv keep [method] [--parameters]
 Use 'arv keep [method] --help' to get more information about specific methods.
 
-Available methods: ls, get, put, less, check, docker
+Available methods: ls, get, put, docker
 </pre>
 </notextile>
 
 h3(#arv-keep-ls). arv keep ls
 
+This is a frontend to @arv-ls@.
+
 <notextile>
 <pre>
 $ <code class="userinput">arv keep ls --help</code>
@@ -206,6 +207,8 @@ optional arguments:
 
 h3(#arv-keep-get). arv keep get
 
+This is a frontend to @arv-get@.
+
 <notextile>
 <pre>
 $ <code class="userinput">arv keep get --help</code>
@@ -259,6 +262,8 @@ optional arguments:
 
 h3(#arv-keep-put). arv keep put
 
+This is a frontend to @arv-put@.
+
 <notextile>
 <pre>
 $ <code class="userinput">arv keep put --help</code>
@@ -338,6 +343,8 @@ optional arguments:
 
 h3(#arv-pipeline-run). arv pipeline run
 
+WARNING: this uses the obsolete "job" API.  Don't use this.  You should use @arvados-cwl-runner@ instead.
+
 @arv pipeline run@ can be used to start a pipeline run from the command line.
 
 The User Guide has a page with a bit more information on "using arv pipeline run":{{site.baseurl}}/user/topics/running-pipeline-command-line.html.
@@ -384,6 +391,8 @@ Options:
 
 h3(#arv-run). arv run
 
+WARNING: this uses the obsolete "job" API.  Don't use this.  You should use @arvados-cwl-runner@ instead.
+
 The @arv-run@ command creates Arvados pipelines at the command line that fan out to multiple concurrent tasks across Arvados compute nodes.
 
 The User Guide has a page on "using arv-run":{{site.baseurl}}/user/topics/arv-run.html.