Files
podman/docs/source/markdown/podman-machine-info.1.md
Ed Santiago ad7c54e13a man page checker: enforce stricter options format
Followup to #14906, in which a nonexistent option was found
in a man page. The xref script was designed to catch that,
but I was too lax in my parsing: the option was documented
using wrong syntax, and the script didn't catch it.

Solution: do not allow *any* unrecognized cruft in the
option description lines. And fix all improperly-written
entries to conform to the rule:

    **--option**=*value(s)*

Two asterisks around option, which must have two dashes. One
asterisk around value(s).

This is going to cause headaches for some people adding new
options, but I don't think I can fix that: there are many
factors that make an unparseable line. Adding 'hint' code
would make the script even more complex than it is. I have
to assume that our contributors are smart enough to look
at surrounding context and figure out the right way to
specify options.

Signed-off-by: Ed Santiago <santiago@redhat.com>
2022-07-14 06:35:51 -06:00

37 lines
708 B
Markdown

% podman-machine-info(1)
## NAME
podman\-machine\-info - Display machine host info
## SYNOPSIS
**podman machine info**
## DESCRIPTION
Display information pertaining to the machine host.
Rootless only, as all `podman machine` commands can be only be used with rootless Podman.
## OPTIONS
#### **--format**, **-f**=*format*
Change output format to "json" or a Go template.
#### **--help**
Print usage statement.
## EXAMPLES
```
$ podman machine info
$ podman machine info --format json
$ podman machine info --format {{.Host.Arch}}
```
## SEE ALSO
**[podman(1)](podman.1.md)**, **[podman-machine(1)](podman-machine.1.md)**
## HISTORY
June 2022, Originally compiled by Ashley Cui <acui@redhat.com>