Files
podman/docs/source/markdown/podman-machine-set.1.md.in
Erik Sjölund de92db0c81 man pages and command help: clean up descriptions
Short description in man pages:
* Use imperative form

Command help (cobra.Command.Short):
* Capitalize first letter
* Use imperative form
* Remove ending full stop when the short description
  only contains one sentence without any commas

Command help (cobra.Command.Long):
* Capitalize first letter unless the sentence starts
  with a command "podman command ..."
* Use imperative form when the long description is
  identical or almost identical to the short description.
  This modification was only done in a few places.

Command tables:
* Use imperative form in the "Description" column

[NO NEW TESTS NEEDED]

Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2023-05-28 18:57:43 +02:00

81 lines
1.8 KiB
Markdown

% podman-machine-set 1
## NAME
podman\-machine\-set - Set a virtual machine setting
## SYNOPSIS
**podman machine set** [*options*] [*name*]
## DESCRIPTION
Change a machine setting.
The default machine name is `podman-machine-default`. If a machine name is not specified as an argument,
then the settings will be applied to `podman-machine-default`.
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 prefers rootful (`true`) or rootless (`false`)
container execution. This option updates 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).
@@option user-mode-networking
Unlike [**podman system connection default**](podman-system-connection-default.1.md)
this option makes 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
```
## SEE ALSO
**[podman(1)](podman.1.md)**, **[podman-machine(1)](podman-machine.1.md)**
## HISTORY
February 2022, Originally compiled by Jason Greene <jason.greene@redhat.com>