aboutsummaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-search.1.md
diff options
context:
space:
mode:
authorPaul Holzinger <paul.holzinger@web.de>2021-03-29 13:52:59 +0200
committerPaul Holzinger <paul.holzinger@web.de>2021-03-29 14:38:25 +0200
commitbc48211924bd8f88263149f8b5d047a52f8d1733 (patch)
tree9e9d01ba112981055b9d5351af35c38b3b3bc20e /docs/source/markdown/podman-search.1.md
parent7e4b13b94699ee688c146afab727d2dec991376a (diff)
downloadpodman-bc48211924bd8f88263149f8b5d047a52f8d1733.tar.gz
podman-bc48211924bd8f88263149f8b5d047a52f8d1733.tar.bz2
podman-bc48211924bd8f88263149f8b5d047a52f8d1733.zip
Fix long option format on docs.podman.io
Escape the two dashes, otherwise they are combined into one long dash. I tested that this change is safe and still renders correctly on github and with the man pages. This commit also contains a small change to make it build locally. Assuming you have the dependencies installed you can do: ``` cd docs make html ``` Preview the html files in docs/build/html with `python -m http.server 8000 --directory build/html`. Fixes containers/podman.io#373 Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
Diffstat (limited to 'docs/source/markdown/podman-search.1.md')
-rw-r--r--docs/source/markdown/podman-search.1.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/docs/source/markdown/podman-search.1.md b/docs/source/markdown/podman-search.1.md
index ec610d3ba..23aa6acd1 100644
--- a/docs/source/markdown/podman-search.1.md
+++ b/docs/source/markdown/podman-search.1.md
@@ -11,9 +11,9 @@ podman\-search - Search a registry for an image
The user can specify which registry to search by prefixing the registry in the search term
(example **registry.fedoraproject.org/fedora**), default is the registries in the
**registries.search** table in the config file - **/etc/containers/registries.conf**.
-The default number of results is 25. The number of results can be limited using the **--limit** flag.
+The default number of results is 25. The number of results can be limited using the **\-\-limit** flag.
If more than one registry is being searched, the limit will be applied to each registry. The output can be filtered
-using the **--filter** flag. To get all available images in a registry without a specific
+using the **\-\-filter** flag. To get all available images in a registry without a specific
search term, the user can just enter the registry name with a trailing "/" (example **registry.fedoraproject.org/**).
Note, searching without a search term will only work for registries that implement the v2 API.
@@ -25,14 +25,14 @@ Note, searching without a search term will only work for registries that impleme
## OPTIONS
-#### **--authfile**=*path*
+#### **\-\-authfile**=*path*
Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json
Note: You can also override the default path of the authentication file by setting the REGISTRY\_AUTH\_FILE
environment variable. `export REGISTRY_AUTH_FILE=path`
-#### **--filter**, **-f**=*filter*
+#### **\-\-filter**, **-f**=*filter*
Filter output based on conditions provided (default [])
@@ -42,7 +42,7 @@ Supported filters are:
* is-automated (boolean - true | false) - is the image automated or not
* is-official (boolean - true | false) - is the image official or not
-#### **--format**=*format*
+#### **\-\-format**=*format*
Change the output format to a Go template
@@ -60,7 +60,7 @@ Valid placeholders for the Go template are listed below:
Note: use .Tag only if the --list-tags is set.
-#### **--limit**=*limit*
+#### **\-\-limit**=*limit*
Limit the number of results (default 25).
Note: The results from each registry will be limited to this value.
@@ -68,24 +68,24 @@ Example if limit is 10 and two registries are being searched, the total
number of results will be 20, 10 from each (if there are at least 10 matches in each).
The order of the search results is the order in which the API endpoint returns the results.
-#### **--list-tags**
+#### **\-\-list-tags**
List the available tags in the repository for the specified image.
**Note:** --list-tags requires the search term to be a fully specified image name.
The result contains the Image name and its tag, one line for every tag associated with the image.
-#### **--no-trunc**
+#### **\-\-no-trunc**
Do not truncate the output
-#### **--tls-verify**=*true|false*
+#### **\-\-tls-verify**=*true|false*
Require HTTPS and verify certificates when contacting registries (default: true). If explicitly set to true,
then TLS verification will be used. If set to false, then TLS verification will not be used if needed. If not specified,
default registries will be searched through (in /etc/containers/registries.conf), and TLS will be skipped if a default
registry is listed in the insecure registries.
-#### **--help**, **-h**
+#### **\-\-help**, **-h**
Print usage statement