Mirrored_Repos/LookingGlass
1
0
Fork 0
mirror of https://github.com/gnif/LookingGlass.git synced 2024-11-22 05:27:20 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[doc] install: Add Command Line Options section

Browse Source 
May in the future include up to date client options from the client
This commit is contained in:
Jonathan Rubenstein 2021-05-05 15:21:37 -04:00 committed by Geoffrey McRae
parent d44b55440f
commit 211146b1a9
1 changed files with 19 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/install.rst
View File

@ -349,8 +349,25 @@ Running the Client
The client command is the binary file: **looking-glass-client**. This
command should run after the Windows Host Application has started.
For an updated list of arguments visit:
https://github.com/gnif/LookingGlass/blob/master/client/README.md
.. _client_cli_options:
Command Line Options
~~~~~~~~~~~~~~~~~~~~
A full list of command line options is available with the ``--help`` or ``-h``
options.
Example: ``looking-glass-client --help``
Common options include ``-s`` for disabling spice, ``-S`` for disabling the
screen saver, and ``-F`` to automatically enter full screen.
Options may be provided with a Short form, if available, or directly by
Long form. Boolean options may be specified without a paramater to toggle their
state.
Examples:
- ``looking-glass-client -F yes`` (Short)
- ``looking-glass-client win:fullScreen yes`` (Long)
- ``looking-glass-client win:fullScreen`` (boolean toggle)