diff --git a/doc/usage.rst b/doc/usage.rst index 9cbd608e..d09ab92e 100644 --- a/doc/usage.rst +++ b/doc/usage.rst @@ -237,69 +237,69 @@ All command line options | app:shmFile | -f | /dev/kvmfr0 | The path to the shared memory file, or the name of the kvmfr device to use, e.g. kvmfr0 | +------------------------+-------+-------------+-----------------------------------------------------------------------------------------+ - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | Long | Short | Value | Description | - +===========================+=======+========================+================================================================================================================+ - | win:title | | Looking Glass (client) | The window title | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:appId | | looking-glass-client | The application Id | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:position | | center | Initial window position at startup | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:size | | 1024x768 | Initial window size at startup | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:autoResize | -a | no | Auto resize the window to the guest | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:allowResize | -n | yes | Allow the window to be manually resized | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:keepAspect | -r | yes | Maintain the correct aspect ratio | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:forceAspect | | yes | Force the window to maintain the aspect ratio | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:dontUpscale | | no | Never try to upscale the window | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:intUpscale | | no | Allow only integer upscaling | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:shrinkOnUpscale | | no | Limit the window dimensions when dontUpscale is enabled | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:borderless | -d | no | Borderless mode | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:fullScreen | -F | no | Launch in fullscreen borderless mode | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:maximize | -T | no | Launch window maximized | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:minimizeOnFocusLoss | | no | Minimize window on focus loss | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:setGuestRes | | yes | On window size change, request the guest to match resoution (if supported by the guest, currently LG IDD only) | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | 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:noScreensaver | -S | no | Prevent the screensaver from starting | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:autoScreensaver | | no | Prevent the screensaver from starting when guest requests it | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:alerts | -q | yes | Show on screen alert messages | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:quickSplash | | no | Skip fading out the splash screen when a connection is established | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:overlayDimsDesktop | | yes | Dim the desktop when in interactive overlay mode | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:rotate | | 0 | Rotate the displayed image (0, 90, 180, 270) | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:uiFont | | DejaVu Sans Mono | The font to use when rendering on-screen UI | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:uiSize | | 14 | The font size to use when rendering on-screen UI | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:jitRender | | no | Enable just-in-time rendering | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:requestActivation | | yes | Request activation when attention is needed | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:disableWaitingMessage | | no | Disables the confirmation message for a cleaner UI | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ - | win:showFPS | -k | no | Enable the FPS & UPS display | - +---------------------------+-------+------------------------+----------------------------------------------------------------------------------------------------------------+ + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | Long | Short | Value | Description | + +===========================+=======+========================+=================================================================================================================+ + | win:title | | Looking Glass (client) | The window title | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:appId | | looking-glass-client | The application Id | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:position | | center | Initial window position at startup | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:size | | 1024x768 | Initial window size at startup | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:autoResize | -a | no | Auto resize the window to the guest | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:allowResize | -n | yes | Allow the window to be manually resized | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:keepAspect | -r | yes | Maintain the correct aspect ratio | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:forceAspect | | yes | Force the window to maintain the aspect ratio | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:dontUpscale | | no | Never try to upscale the window | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:intUpscale | | no | Allow only integer upscaling | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:shrinkOnUpscale | | no | Limit the window dimensions when dontUpscale is enabled | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:borderless | -d | no | Borderless mode | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:fullScreen | -F | no | Launch in fullscreen borderless mode | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:maximize | -T | no | Launch window maximized | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:minimizeOnFocusLoss | | no | Minimize window on focus loss | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:setGuestRes | | yes | On window size change, request the guest to match resolution (if supported by the guest, currently LG IDD only) | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | 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:noScreensaver | -S | no | Prevent the screensaver from starting | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:autoScreensaver | | no | Prevent the screensaver from starting when guest requests it | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:alerts | -q | yes | Show on screen alert messages | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:quickSplash | | no | Skip fading out the splash screen when a connection is established | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:overlayDimsDesktop | | yes | Dim the desktop when in interactive overlay mode | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:rotate | | 0 | Rotate the displayed image (0, 90, 180, 270) | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:uiFont | | DejaVu Sans Mono | The font to use when rendering on-screen UI | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:uiSize | | 14 | The font size to use when rendering on-screen UI | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:jitRender | | no | Enable just-in-time rendering | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:requestActivation | | yes | Request activation when attention is needed | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:disableWaitingMessage | | no | Disables the confirmation message for a cleaner UI | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ + | win:showFPS | -k | no | Enable the FPS & UPS display | + +---------------------------+-------+------------------------+-----------------------------------------------------------------------------------------------------------------+ +------------------------------+-------+---------------------+----------------------------------------------------------------------------------------------------------+ | Long | Short | Value | Description |