podman/docs/source/markdown/podman-machine-set.1.md at 3d09d47a25e935076a011820fd8b8cd008a08ce0

mirror of https://github.com/containers/podman.git synced 2025-12-09 15:19:35 +08:00

Files

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

1.6 KiB

Raw Blame History

% podman-machine-set(1)

NAME

podman-machine-set - Sets a virtual machine setting

SYNOPSIS

podman machine set [options] [name]

DESCRIPTION

Change a machine setting.

Rootless only.

OPTIONS

--cpus=number

Number of CPUs. Only supported for QEMU machines.

--disk-size=number

Size of the disk for the guest VM in GB. Can only be increased. Only supported for QEMU machines.

--help

Print usage statement.

--memory, -m=number

Memory (in MB). Only supported for QEMU machines.

--rootful

Whether this machine should prefer rootful (true) or rootless (false) container execution. This option will also update the current podman remote connection default if it is currently pointing at the specified machine name (or podman-machine-default if no name is specified).

Unlike podman system connection default this option will also make the API socket, if available, forward to the rootful/rootless socket in the VM.

EXAMPLES

To switch the default VM podman-machine-default from rootless to rootful:

$ podman machine set --rootful

or more explicitly:

$ podman machine set --rootful=true

To switch the default VM podman-machine-default from rootful to rootless:

$ podman machine set --rootful=false

To switch the VM myvm from rootless to rootful:

$ podman machine set --rootful myvm

HISTORY

February 2022, Originally compiled by Jason Greene jason.greene@redhat.com

1.6 KiB Raw Blame History