Skip to content

Commit 7df9388

Browse files
committed
Update usage in README
Signed-off-by: Nikodem Rabuliński <[email protected]>
1 parent ca010ae commit 7df9388

1 file changed

Lines changed: 20 additions & 11 deletions

File tree

README.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@
1111
## Using
1212

1313
``` sh
14-
Usage: muvm [-c=CPU_LIST]... [-e=ENV]... [--mem=MEM] [--vram=VRAM] [--passt-socket=PATH] [-p=
15-
SERVER_PORT] [-f=FEX_IMAGE]... COMMAND [COMMAND_ARGS]...
14+
Usage: muvm [-c=CPU_LIST]... [-e=ENV]... [--mem=MEM] [--vram=VRAM] [--passt-socket=PATH] [-f=
15+
FEX_IMAGE]... [-m] [-i] [-t] [--privileged] [-p=<[[IP:][HOST_PORT]:]GUEST_PORT[/PROTOCOL]>]... [
16+
--emu=EMU] COMMAND [COMMAND_ARGS]...
1617

1718
Available positional items:
1819
COMMAND the command you want to execute in the vm
@@ -34,19 +35,27 @@ Available options:
3435
Machine Monitor) will attempt to return as many pages as
3536
possible to the host.
3637
[default: 80% of total RAM]
37-
--vram=VRAM The amount of Video RAM, in MiB, that will be available to this
38-
microVM.
39-
The memory configured for the microVM will not be reserved
40-
immediately. Instead, it will be provided as the guest demands
41-
it, and will be returned to the host once the guest releases
42-
the underlying resources.
43-
[default: same as the total amount of RAM in the system]
38+
--vram=VRAM The amount of Video RAM, in MiB, that will reported by userspace in
39+
this microVM.
40+
The userspace drivers will report this amount as heap size
41+
to the clients running in the microVM.
42+
[default: 50% of total RAM]
4443
--passt-socket=PATH Instead of starting passt, connect to passt socket at PATH
45-
-p, --server-port=SERVER_PORT Set the port to be used in server mode
46-
[default: 3334]
4744
-f, --fex-image=FEX_IMAGE Adds an erofs file to be mounted as a FEX rootfs.
4845
May be specified multiple times.
4946
First the base image, then overlays in order.
47+
-m, --merged-rootfs Use merged rootfs for FEX (experimental)
48+
-i, --interactive Attach to the command's stdin/out after starting it
49+
-t, --tty Allocate a tty for the command
50+
--privileged Run the command as root inside the vm.
51+
This notably does not allow root access to the host fs.
52+
-p, --publish=<[[IP:][HOST_PORT]:]GUEST_PORT[/PROTOCOL]>
53+
Publish a guest’s port, or range of ports, to the host.
54+
The syntax is similar to podman/docker.
55+
--emu=EMU Which emulator to use for running x86_64 binaries.
56+
Valid options are "box" and "fex". If this argument is not
57+
present, muvm will try to use FEX, falling back to Box if it
58+
can't be found.
5059
-h, --help Prints help information
5160
```
5261

0 commit comments

Comments
 (0)