|
6 | 6 |
|
7 | 7 | - `muvm-guest`: acts as an entrypoint inside the microVM to set up the environment for running your program. |
8 | 8 |
|
| 9 | +- `muvm-server`: a server listening for requests to run additional programs. This allows you to run multiple graphical applications inside the same microVM. |
| 10 | + |
9 | 11 | ## Using |
10 | 12 |
|
11 | 13 | ``` sh |
12 | | - |
13 | | -Usage: muvm [OPTIONS] COMMAND [COMMAND_ARGS...] |
14 | | -OPTIONS: |
15 | | - -h --help Show help |
16 | | - --net=NET_MODE Set network mode |
17 | | - --passt-socket=PATH Instead of starting passt, connect to passt socket at PATHNET_MODE can be either TSI (default) or PASST |
18 | | - |
19 | | -COMMAND: the command you want to execute in the vm |
20 | | -COMMAND_ARGS: arguments of COMMAND |
21 | | - |
| 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]... |
| 16 | + |
| 17 | +Available positional items: |
| 18 | + COMMAND the command you want to execute in the vm |
| 19 | + COMMAND_ARGS arguments of COMMAND |
| 20 | + |
| 21 | +Available options: |
| 22 | + -c, --cpu-list=CPU_LIST The numerical list of processors that this microVM will be bound to. |
| 23 | + Numbers are separated by commas and may include ranges. For |
| 24 | + example: 0,5,8-11. |
| 25 | + [default: all logical CPUs on the host, limited to performance cores |
| 26 | + (if applicable)] |
| 27 | + -e, --env=ENV Set environment variable to be passed to the microVM |
| 28 | + ENV should be in KEY=VALUE format, or KEY on its own to inherit |
| 29 | + the current value from the local environment |
| 30 | + --mem=MEM The amount of RAM, in MiB, that will be available to this microVM. |
| 31 | + The memory configured for the microVM will not be reserved |
| 32 | + immediately. Instead, it will be provided as the guest demands |
| 33 | + it, and both the guest and libkrun (acting as the Virtual |
| 34 | + Machine Monitor) will attempt to return as many pages as |
| 35 | + possible to the host. |
| 36 | + [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] |
| 44 | + --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] |
| 47 | + -f, --fex-image=FEX_IMAGE Adds an erofs file to be mounted as a FEX rootfs. |
| 48 | + May be specified multiple times. |
| 49 | + First the base image, then overlays in order. |
| 50 | + -h, --help Prints help information |
22 | 51 | ``` |
23 | 52 |
|
24 | 53 | ## Running graphical applications |
|
0 commit comments