aboutsummaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-search.1.md
diff options
context:
space:
mode:
authorPaul Holzinger <paul.holzinger@web.de>2020-11-10 14:59:34 +0100
committerPaul Holzinger <paul.holzinger@web.de>2020-11-10 15:27:08 +0100
commit52a869470530f3c6bf7820a2b63fa9e17f227a16 (patch)
tree84d2940f763b124c75dd124aecbf76ff3707f140 /docs/source/markdown/podman-search.1.md
parentda01191aa3526e3a77d9a055e23c318c26720785 (diff)
downloadpodman-52a869470530f3c6bf7820a2b63fa9e17f227a16.tar.gz
podman-52a869470530f3c6bf7820a2b63fa9e17f227a16.tar.bz2
podman-52a869470530f3c6bf7820a2b63fa9e17f227a16.zip
Add anchors for flag names on docs.podman.io
Change the docs markdown so that flag names will be h4 headers. Sphinx will automatically add anchors to headers. Add css to make sure the flag names are not to big compared to the text. The man pages also still renders fine but it looks a bit different. 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.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/source/markdown/podman-search.1.md b/docs/source/markdown/podman-search.1.md
index 15a38383a..ec610d3ba 100644
--- a/docs/source/markdown/podman-search.1.md
+++ b/docs/source/markdown/podman-search.1.md
@@ -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