mirror of
				https://github.com/gnif/LookingGlass.git
				synced 2025-11-03 22:22:08 +00:00 
			
		
		
		
	[doc] client: add documentation for disableWaitingMessage option
This commit is contained in:
		
				
					committed by
					
						
						Geoffrey McRae
					
				
			
			
				
	
			
			
			
						parent
						
							add45347b5
						
					
				
				
					commit
					c349f704d6
				
			
							
								
								
									
										288
									
								
								doc/usage.rst
									
									
									
									
									
								
							
							
						
						
									
										288
									
								
								doc/usage.rst
									
									
									
									
									
								
							@@ -224,7 +224,7 @@ All command line options
 | 
			
		||||
  +========================+=======+=============+=========================================================================================+
 | 
			
		||||
  | app:configFile         | -C    | NULL        | A file to read additional configuration from                                            |
 | 
			
		||||
  +------------------------+-------+-------------+-----------------------------------------------------------------------------------------+
 | 
			
		||||
  | app:renderer           | -g    | EGL         | Specify the renderer to use                                                             |
 | 
			
		||||
  | app:renderer           | -g    | auto        | Specify the renderer to use                                                             |
 | 
			
		||||
  +------------------------+-------+-------------+-----------------------------------------------------------------------------------------+
 | 
			
		||||
  | app:license            | -l    | no          | Show the license for this application and then terminate                                |
 | 
			
		||||
  +------------------------+-------+-------------+-----------------------------------------------------------------------------------------+
 | 
			
		||||
@@ -237,139 +237,149 @@ 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: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: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    | yes                    | 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  |       | no                     | 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: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 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                                                                      |
 | 
			
		||||
  +==============================+=======+=====================+==================================================================================+
 | 
			
		||||
  | input:captureOnFocus         |       | no                  | Enable capture mode when the window becomes focused                              |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------+
 | 
			
		||||
  | input:grabKeyboard           | -G    | yes                 | Grab the keyboard in capture mode                                                |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------+
 | 
			
		||||
  | input:grabKeyboardOnFocus    |       | no                  | Grab the keyboard when focused                                                   |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------+
 | 
			
		||||
  | input:releaseKeysOnFocusLoss |       | yes                 | On focus loss, send key up events to guest for all held keys                     |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------+
 | 
			
		||||
  | input:escapeKey              | -m    | 70 = KEY_SCROLLLOCK | Specify the escape/menu key to use (use "help" to see valid values)              |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------+
 | 
			
		||||
  | input:ignoreWindowsKeys      |       | no                  | Do not pass events for the windows keys to the guest                             |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------+
 | 
			
		||||
  | input:hideCursor             | -M    | yes                 | Hide the local mouse cursor                                                      |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------+
 | 
			
		||||
  | input:mouseSens              |       | 0                   | Initial mouse sensitivity when in capture mode (-9 to 9)                         |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------+
 | 
			
		||||
  | input:mouseSmoothing         |       | yes                 | Apply simple mouse smoothing when rawMouse is not in use (helps reduce aliasing) |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------+
 | 
			
		||||
  | input:rawMouse               |       | yes                 | Use RAW mouse input when in capture mode (good for gaming)                       |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------+
 | 
			
		||||
  | input:mouseRedraw            |       | yes                 | Mouse movements trigger redraws (ignores FPS minimum)                            |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------+
 | 
			
		||||
  | input:autoCapture            |       | no                  | Try to keep the mouse captured when needed                                       |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------+
 | 
			
		||||
  | input:captureOnly            |       | no                  | Only enable input via SPICE if in capture mode                                   |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------+
 | 
			
		||||
  | input:helpMenuDelay          |       | 200                 | Show help menu after holding down the escape key for this many milliseconds      |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------+
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------------------------------+
 | 
			
		||||
  | Long                         | Short | Value               | Description                                                                                              |
 | 
			
		||||
  +==============================+=======+=====================+==========================================================================================================+
 | 
			
		||||
  | input:captureOnFocus         |       | no                  | Enable capture mode when the window becomes focused                                                      |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------------------------------+
 | 
			
		||||
  | input:grabKeyboard           | -G    | yes                 | Grab the keyboard in capture mode                                                                        |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------------------------------+
 | 
			
		||||
  | input:grabKeyboardOnFocus    |       | no                  | Grab the keyboard when focused                                                                           |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------------------------------+
 | 
			
		||||
  | input:releaseKeysOnFocusLoss |       | yes                 | On focus loss, send key up events to guest for all held keys                                             |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------------------------------+
 | 
			
		||||
  | input:escapeKey              | -m    | 70 = KEY_SCROLLLOCK | Specify the escape/menu key to use (use "help" to see valid values)                                      |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------------------------------+
 | 
			
		||||
  | input:ignoreWindowsKeys      |       | no                  | Do not pass events for the windows keys to the guest                                                     |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------------------------------+
 | 
			
		||||
  | input:hideCursor             | -M    | yes                 | Hide the local mouse cursor                                                                              |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------------------------------+
 | 
			
		||||
  | input:mouseSens              |       | 0                   | Initial mouse sensitivity when in capture mode (-9 to 9)                                                 |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------------------------------+
 | 
			
		||||
  | input:mouseSmoothing         |       | yes                 | Apply simple mouse smoothing when rawMouse is not in use (helps reduce aliasing)                         |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------------------------------+
 | 
			
		||||
  | input:rawMouse               |       | no                  | Use RAW mouse input when in capture mode (good for gaming)                                               |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------------------------------+
 | 
			
		||||
  | input:mouseRedraw            |       | yes                 | Mouse movements trigger redraws (ignores FPS minimum)                                                    |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------------------------------+
 | 
			
		||||
  | input:autoCapture            |       | no                  | Try to keep the mouse captured when needed                                                               |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------------------------------+
 | 
			
		||||
  | input:captureOnly            |       | no                  | Only enable input via SPICE if in capture mode                                                           |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------------------------------+
 | 
			
		||||
  | input:helpMenuDelay          |       | 200                 | Show help menu after holding down the escape key for this many milliseconds                              |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------------------------------+
 | 
			
		||||
  | input:evdev                  |       | NULL                | csv list of evdev input devices to use for capture mode (ie: /dev/input/by-id/usb-some_device-event-kbd) |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------------------------------+
 | 
			
		||||
  | input:evdevExclusive         |       | yes                 | Only use evdev devices for input when in capture mode                                                    |
 | 
			
		||||
  +------------------------------+-------+---------------------+----------------------------------------------------------------------------------------------------------+
 | 
			
		||||
 | 
			
		||||
  +------------------------+-------+-----------------------------------+---------------------------------------------------------------------+
 | 
			
		||||
  | Long                   | Short | Value                             | Description                                                         |
 | 
			
		||||
  +========================+=======+===================================+=====================================================================+
 | 
			
		||||
  | spice:enable           | -s    | yes                               | Enable the built in SPICE client for input and/or clipboard support |
 | 
			
		||||
  +------------------------+-------+-----------------------------------+---------------------------------------------------------------------+
 | 
			
		||||
  | spice:host             | -c    | /opt/PVM/vms/Windows/windows.sock | The SPICE server host or UNIX socket                                |
 | 
			
		||||
  +------------------------+-------+-----------------------------------+---------------------------------------------------------------------+
 | 
			
		||||
  | spice:port             | -p    | 0                                 | The SPICE server port (0 = unix socket)                             |
 | 
			
		||||
  +------------------------+-------+-----------------------------------+---------------------------------------------------------------------+
 | 
			
		||||
  | spice:input            |       | yes                               | Use SPICE to send keyboard and mouse input events to the guest      |
 | 
			
		||||
  +------------------------+-------+-----------------------------------+---------------------------------------------------------------------+
 | 
			
		||||
  | spice:clipboard        |       | yes                               | Use SPICE to synchronize the clipboard contents with the guest      |
 | 
			
		||||
  +------------------------+-------+-----------------------------------+---------------------------------------------------------------------+
 | 
			
		||||
  | spice:clipboardToVM    |       | yes                               | Allow the clipboard to be synchronized TO the VM                    |
 | 
			
		||||
  +------------------------+-------+-----------------------------------+---------------------------------------------------------------------+
 | 
			
		||||
  | spice:clipboardToLocal |       | yes                               | Allow the clipboard to be synchronized FROM the VM                  |
 | 
			
		||||
  +------------------------+-------+-----------------------------------+---------------------------------------------------------------------+
 | 
			
		||||
  | spice:audio            |       | yes                               | Enable SPICE audio support                                          |
 | 
			
		||||
  +------------------------+-------+-----------------------------------+---------------------------------------------------------------------+
 | 
			
		||||
  | spice:scaleCursor      | -j    | yes                               | Scale cursor input position to screen size when up/down scaled      |
 | 
			
		||||
  +------------------------+-------+-----------------------------------+---------------------------------------------------------------------+
 | 
			
		||||
  | spice:captureOnStart   |       | no                                | Capture mouse and keyboard on start                                 |
 | 
			
		||||
  +------------------------+-------+-----------------------------------+---------------------------------------------------------------------+
 | 
			
		||||
  | spice:alwaysShowCursor |       | no                                | Always show host cursor                                             |
 | 
			
		||||
  +------------------------+-------+-----------------------------------+---------------------------------------------------------------------+
 | 
			
		||||
  | spice:showCursorDot    |       | yes                               | Use a "dot" cursor when the window does not have focus              |
 | 
			
		||||
  +------------------------+-------+-----------------------------------+---------------------------------------------------------------------+
 | 
			
		||||
  | spice:largeCursorDot   |       | yes                               | Use a larger version of the "dot" cursor                            |
 | 
			
		||||
  +------------------------+-------+-----------------------------------+---------------------------------------------------------------------+
 | 
			
		||||
  +------------------------+-------+-----------+---------------------------------------------------------------------+
 | 
			
		||||
  | Long                   | Short | Value     | Description                                                         |
 | 
			
		||||
  +========================+=======+===========+=====================================================================+
 | 
			
		||||
  | spice:enable           | -s    | yes       | Enable the built in SPICE client for input and/or clipboard support |
 | 
			
		||||
  +------------------------+-------+-----------+---------------------------------------------------------------------+
 | 
			
		||||
  | spice:host             | -c    | 127.0.0.1 | The SPICE server host or UNIX socket                                |
 | 
			
		||||
  +------------------------+-------+-----------+---------------------------------------------------------------------+
 | 
			
		||||
  | spice:port             | -p    | 5900      | The SPICE server port (0 = unix socket)                             |
 | 
			
		||||
  +------------------------+-------+-----------+---------------------------------------------------------------------+
 | 
			
		||||
  | spice:input            |       | yes       | Use SPICE to send keyboard and mouse input events to the guest      |
 | 
			
		||||
  +------------------------+-------+-----------+---------------------------------------------------------------------+
 | 
			
		||||
  | spice:clipboard        |       | yes       | Use SPICE to synchronize the clipboard contents with the guest      |
 | 
			
		||||
  +------------------------+-------+-----------+---------------------------------------------------------------------+
 | 
			
		||||
  | spice:clipboardToVM    |       | yes       | Allow the clipboard to be synchronized TO the VM                    |
 | 
			
		||||
  +------------------------+-------+-----------+---------------------------------------------------------------------+
 | 
			
		||||
  | spice:clipboardToLocal |       | yes       | Allow the clipboard to be synchronized FROM the VM                  |
 | 
			
		||||
  +------------------------+-------+-----------+---------------------------------------------------------------------+
 | 
			
		||||
  | spice:audio            |       | yes       | Enable SPICE audio support                                          |
 | 
			
		||||
  +------------------------+-------+-----------+---------------------------------------------------------------------+
 | 
			
		||||
  | spice:scaleCursor      | -j    | yes       | Scale cursor input position to screen size when up/down scaled      |
 | 
			
		||||
  +------------------------+-------+-----------+---------------------------------------------------------------------+
 | 
			
		||||
  | spice:captureOnStart   |       | no        | Capture mouse and keyboard on start                                 |
 | 
			
		||||
  +------------------------+-------+-----------+---------------------------------------------------------------------+
 | 
			
		||||
  | spice:alwaysShowCursor |       | no        | Always show host cursor                                             |
 | 
			
		||||
  +------------------------+-------+-----------+---------------------------------------------------------------------+
 | 
			
		||||
  | spice:showCursorDot    |       | yes       | Use a "dot" cursor when the window does not have focus              |
 | 
			
		||||
  +------------------------+-------+-----------+---------------------------------------------------------------------+
 | 
			
		||||
  | spice:largeCursorDot   |       | no        | Use a larger version of the "dot" cursor                            |
 | 
			
		||||
  +------------------------+-------+-----------+---------------------------------------------------------------------+
 | 
			
		||||
 | 
			
		||||
  +------------------------+-------+-------+-------------------------------------------------------------------------------+
 | 
			
		||||
  | Long                   | Short | Value | Description                                                                   |
 | 
			
		||||
  +========================+=======+=======+===============================================================================+
 | 
			
		||||
  | audio:periodSize       |       | 256   | Requested audio device period size in samples                                 |
 | 
			
		||||
  +------------------------+-------+-------+-------------------------------------------------------------------------------+
 | 
			
		||||
  | audio:bufferLatency    |       | 12    | Additional buffer latency in milliseconds                                     |
 | 
			
		||||
  +------------------------+-------+-------+-------------------------------------------------------------------------------+
 | 
			
		||||
  | audio:micDefault       |       | allow | Default action when an application opens the microphone (prompt, allow, deny) |
 | 
			
		||||
  +------------------------+-------+-------+-------------------------------------------------------------------------------+
 | 
			
		||||
  | audio:micShowIndicator |       | yes   | Display microphone usage indicator                                            |
 | 
			
		||||
  +------------------------+-------+-------+-------------------------------------------------------------------------------+
 | 
			
		||||
  | audio:syncVolume       |       | yes   | Synchronize the volume level with the guest                                   |
 | 
			
		||||
  +------------------------+-------+-------+-------------------------------------------------------------------------------+
 | 
			
		||||
  +------------------------+-------+--------+-------------------------------------------------------------------------------+
 | 
			
		||||
  | Long                   | Short | Value  | Description                                                                   |
 | 
			
		||||
  +========================+=======+========+===============================================================================+
 | 
			
		||||
  | audio:periodSize       |       | 2048   | Requested audio device period size in samples                                 |
 | 
			
		||||
  +------------------------+-------+--------+-------------------------------------------------------------------------------+
 | 
			
		||||
  | audio:bufferLatency    |       | 13     | Additional buffer latency in milliseconds                                     |
 | 
			
		||||
  +------------------------+-------+--------+-------------------------------------------------------------------------------+
 | 
			
		||||
  | audio:micDefault       |       | prompt | Default action when an application opens the microphone (prompt, allow, deny) |
 | 
			
		||||
  +------------------------+-------+--------+-------------------------------------------------------------------------------+
 | 
			
		||||
  | audio:micShowIndicator |       | yes    | Display microphone usage indicator                                            |
 | 
			
		||||
  +------------------------+-------+--------+-------------------------------------------------------------------------------+
 | 
			
		||||
  | audio:syncVolume       |       | yes    | Synchronize the volume level with the guest                                   |
 | 
			
		||||
  +------------------------+-------+--------+-------------------------------------------------------------------------------+
 | 
			
		||||
 | 
			
		||||
  +-------------------+-------+-------+---------------------------------------------------------------------------+
 | 
			
		||||
  | Long              | Short | Value | Description                                                               |
 | 
			
		||||
@@ -428,16 +438,16 @@ All command line options
 | 
			
		||||
  +---------------------+-------+-------+----------------------------------------------------------+
 | 
			
		||||
  | Long                | Short | Value | Description                                              |
 | 
			
		||||
  +=====================+=======+=======+==========================================================+
 | 
			
		||||
  | i3:globalFullScreen |       | yes   | Use i3's global full screen feature (spans all monitors) |
 | 
			
		||||
  | i3:globalFullScreen |       | no    | Use i3's global full screen feature (spans all monitors) |
 | 
			
		||||
  +---------------------+-------+-------+----------------------------------------------------------+
 | 
			
		||||
 | 
			
		||||
  +--------------------+-------+---------------+------------------------------------+
 | 
			
		||||
  | Long               | Short | Value         | Description                        |
 | 
			
		||||
  +====================+=======+===============+====================================+
 | 
			
		||||
  | pipewire:outDevice |       | Looking Glass | The default playback device to use |
 | 
			
		||||
  +--------------------+-------+---------------+------------------------------------+
 | 
			
		||||
  | pipewire:recDevice |       | PureNoise Mic | The default record device to use   |
 | 
			
		||||
  +--------------------+-------+---------------+------------------------------------+
 | 
			
		||||
  +--------------------+-------+-------+------------------------------------+
 | 
			
		||||
  | Long               | Short | Value | Description                        |
 | 
			
		||||
  +====================+=======+=======+====================================+
 | 
			
		||||
  | pipewire:outDevice |       | NULL  | The default playback device to use |
 | 
			
		||||
  +--------------------+-------+-------+------------------------------------+
 | 
			
		||||
  | pipewire:recDevice |       | NULL  | The default record device to use   |
 | 
			
		||||
  +--------------------+-------+-------+------------------------------------+
 | 
			
		||||
 | 
			
		||||
.. _host_usage:
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user