X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/43dcf83e8b5332004bddd01be22476e68b1cef0f..e3987b71873a1173cfcf202da45b5b39440030d5:/doc/sdk/cli/reference.html.textile.liquid diff --git a/doc/sdk/cli/reference.html.textile.liquid b/doc/sdk/cli/reference.html.textile.liquid index a76ef2f287..cd70dfd4ae 100644 --- a/doc/sdk/cli/reference.html.textile.liquid +++ b/doc/sdk/cli/reference.html.textile.liquid @@ -4,6 +4,11 @@ navsection: sdk navmenu: CLI title: "arv reference" ... +{% 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_ @@ -54,13 +59,13 @@ h4. @list@ Arguments accepted by the @list@ subcommand include:
-    --limit, -l :     Maximum number of resources to return.
-   --offset, -o :     Number of users to skip before first returned record.
-  --filters, -f :     Conditions for filtering users.
-    --order, -r :     Order in which to return matching users.
-   --select, -s :     Select which fields to return
-     --distinct, -d:     Return each distinct object.
-     --no-count, -n:     Don't count items_available.
+  -l, --limit=        Maximum number of items to return. (Default: 100)
+  -o, --offset=       Number of items to skip before first returned record. (Default: 0)
+  -f, --filters=      Conditions for filtering items.
+  -r, --order=        Order in which to return matching items.
+  -s, --select=       Select which fields to return.
+  -d, --distinct         Return each distinct object.
+  -c, --count=        Type of count to return in items_available ('none' or 'exact'). (Default: exact)
 
The @--filters@ option takes a string describing a JSON list of filters on which the returned resources should be returned. Each filter is a three-element list of _[field, operator, value]_, where the _operator_ may be one of @=@, @<@, @<=@, @>@, @>=@, @!=@, @like@, or @ilike@.