diff --git a/doc/source/index.rst b/doc/source/index.rst index 33e699e..5095912 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -32,3 +32,4 @@ Man Page :maxdepth: 1 man/openstack + man/search diff --git a/doc/source/man/search.rst b/doc/source/man/search.rst new file mode 100644 index 0000000..cbe1adf --- /dev/null +++ b/doc/source/man/search.rst @@ -0,0 +1,78 @@ +====== +Search +====== + +search facet list +----------------- + +List Searchlight Facets. + +.. program:: search facet list +.. code:: bash + + openstack search facet list + [--type ] + [--limit-terms ] + [--all-projects] + +.. option:: --type + + Get facets for a particular resource type. + +.. option:: --limit-terms + + Restricts the number of options returned for fields that + support facet terms. + +.. option:: --all-projects + + Request facet terms for all projects (admin only). + +search resource type list +------------------------- + +List Searchlight Resource Type (Plugin). + +.. program:: search resource type list +.. code:: bash + + openstack search resource type list + +search query +------------ + +Search Searchlight resource. + +.. program:: search query +.. code:: bash + + openstack search query + --type [ [ ...]] + --all-projects + --source [[,...]] + --json + + +.. option:: --type [ [ ...]] + + One or more types to search. Uniquely identifies + resource types. Example: ``--type OS::Glance::Image + OS::Nova::Server`` + +.. option:: --all-projects + + By default searches are restricted to the current project + unless all_projects is set. + +.. option:: --source [[,...]] + + Whether to display the json source. If not specified, + it will not be displayed. If specified with no argument, + the full source will be displayed. Otherwise, specify + the fields combined with ',' to return the fields you want. + It is recommended that you use the ``--max-width`` argument + with this option. + +.. option:: --json + + Treat the query argument as a JSON formatted DSL query.