Files
podman/docs/source/markdown/podman-secret-ls.1.md
Ed Santiago 9b0c8d23bd man pages: sort flags, and keep them that way
Command flags (OPTIONS) in man pages have to date been in
haphazard order. Sometimes that order is sensible, e.g.,
most-important options first, but more often they're
just in arbitrary places. This makes life hard for users.

Here, I update the man-page-check Makefile script so it
checks and enforces alphabetical order in OPTIONS sections.
Then -- the hard part -- update all existing man pages to
conform to this requirement.

Signed-off-by: Ed Santiago <santiago@redhat.com>
2022-03-23 13:49:42 -06:00

48 lines
1.2 KiB
Markdown

% podman-secret-ls(1)
## NAME
podman\-secret\-ls - List all available secrets
## SYNOPSIS
**podman secret ls** [*options*]
## DESCRIPTION
Lists all the secrets that exist. The output can be formatted to a Go template using the **--format** option.
## OPTIONS
#### **--filter**, **-f**=*filter=value*
Filter output based on conditions given.
Multiple filters can be given with multiple uses of the --filter option.
Valid filters are listed below:
| **Filter** | **Description** |
| ---------- | ----------------------------------------------------------------- |
| name | [Name] Secret name (accepts regex) |
| id | [ID] Full or partial secret ID |
#### **--format**=*format*
Format secret output using Go template.
#### **--noheading**
Omit the table headings from the listing of secrets. .
## EXAMPLES
```
$ podman secret ls
$ podman secret ls --format "{{.Name}}"
$ podman secret ls --filter name=confidential
```
## SEE ALSO
**[podman(1)](podman.1.md)**, **[podman-secret(1)](podman-secret.1.md)**
## HISTORY
January 2021, Originally compiled by Ashley Cui <acui@redhat.com>