From 5bef733647dab227203355e603097374607642a8 Mon Sep 17 00:00:00 2001 From: Jonathan Rubenstein Date: Sat, 25 Dec 2021 22:11:37 +0200 Subject: [PATCH] [doc] install: Update command line options --- doc/install.rst | 40 ++++++++++++++++++++++------------------ 1 file changed, 22 insertions(+), 18 deletions(-) diff --git a/doc/install.rst b/doc/install.rst index a50298f6..727f7546 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -410,23 +410,23 @@ Full Command Line Options The following is a complete list of options accepted by this application - +------------------------+-------+------------------------+------------------------------------------------------------------------------------------+ - | Long | Short | Value | Description | - +========================+=======+========================+==========================================================================================+ - | app:configFile | -C | NULL | A file to read additional configuration from | - +------------------------+-------+------------------------+------------------------------------------------------------------------------------------+ - | app:renderer | -g | auto | Specify the renderer to use | - +------------------------+-------+------------------------+------------------------------------------------------------------------------------------+ - | app:license | -l | no | Show the license for this application and then terminate | - +------------------------+-------+------------------------+------------------------------------------------------------------------------------------+ - | app:cursorPollInterval | | 1000 | How often to check for a cursor update in microseconds | - +------------------------+-------+------------------------+------------------------------------------------------------------------------------------+ - | app:framePollInterval | | 1000 | How often to check for a frame update in microseconds | - +------------------------+-------+------------------------+------------------------------------------------------------------------------------------+ - | app:allowDMA | | yes | Allow direct DMA transfers if supported (see `README.md` in the `module` dir) | - +------------------------+-------+------------------------+------------------------------------------------------------------------------------------+ - | app:shmFile | -f | /dev/shm/looking-glass | The path to the shared memory file, or the name of the kvmfr device to use, e.g.: kvmfr0 | - +------------------------+-------+------------------------+------------------------------------------------------------------------------------------+ + +------------------------+-------+------------------------+-----------------------------------------------------------------------------------------+ + | Long | Short | Value | Description | + +========================+=======+========================+=========================================================================================+ + | app:configFile | -C | NULL | A file to read additional configuration from | + +------------------------+-------+------------------------+-----------------------------------------------------------------------------------------+ + | app:renderer | -g | auto | Specify the renderer to use | + +------------------------+-------+------------------------+-----------------------------------------------------------------------------------------+ + | app:license | -l | no | Show the license for this application and then terminate | + +------------------------+-------+------------------------+-----------------------------------------------------------------------------------------+ + | app:cursorPollInterval | | 1000 | How often to check for a cursor update in microseconds | + +------------------------+-------+------------------------+-----------------------------------------------------------------------------------------+ + | app:framePollInterval | | 1000 | How often to check for a frame update in microseconds | + +------------------------+-------+------------------------+-----------------------------------------------------------------------------------------+ + | app:allowDMA | | yes | Allow direct DMA transfers if supported (see `README.md` in the `module` dir) | + +------------------------+-------+------------------------+-----------------------------------------------------------------------------------------+ + | app:shmFile | -f | /dev/shm/looking-glass | The path to the shared memory file, or the name of the kvmfr device to use, e.g. kvmfr0 | + +------------------------+-------+------------------------+-----------------------------------------------------------------------------------------+ +-------------------------+-------+------------------------+----------------------------------------------------------------------+ | Long | Short | Value | Description | @@ -459,7 +459,7 @@ The following is a complete list of options accepted by this application +-------------------------+-------+------------------------+----------------------------------------------------------------------+ | win:fpsMin | -K | -1 | Frame rate minimum (0 = disable - not recommended, -1 = auto detect) | +-------------------------+-------+------------------------+----------------------------------------------------------------------+ - | win:ignoreQuit | -Q | no | Ignore requests to quit (i.e.: Alt+F4) | + | win:ignoreQuit | -Q | no | Ignore requests to quit (i.e. Alt+F4) | +-------------------------+-------+------------------------+----------------------------------------------------------------------+ | win:noScreensaver | -S | no | Prevent the screensaver from starting | +-------------------------+-------+------------------------+----------------------------------------------------------------------+ @@ -555,6 +555,10 @@ The following is a complete list of options accepted by this application +------------------+-------+-------+---------------------------------------------------------------------------+ | egl:debug | | no | Enable debug output | +------------------+-------+-------+---------------------------------------------------------------------------+ + | egl:noBufferAge | | no | Disable partial rendering based on buffer age | + +------------------+-------+-------+---------------------------------------------------------------------------+ + | egl:noSwapDamage | | no | Disable swapping with damage | + +------------------+-------+-------+---------------------------------------------------------------------------+ +----------------------+-------+-------+---------------------------------------------+ | Long | Short | Value | Description |