Mirrored_Repos/LookingGlass
1
0
Fork 0
mirror of https://github.com/gnif/LookingGlass.git synced 2024-12-25 23:13:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[doc] usage: Move Command Line Options to the top

Browse Source 
Also reformats common parameters, and lists them at the top man page
style
This commit is contained in:
Jonathan Rubenstein 2022-04-16 17:48:27 +03:00 committed by Geoffrey McRae
parent 836e7ab998
commit 5797fbb4e5
1 changed files with 34 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
doc/usage.rst
View File

@ -3,12 +3,44 @@
Usage
-----
The client command is the binary file: **looking-glass-client**. This
command should run after the Windows Host Application has started.
**looking-glass-client** [\-\-help] [\-f] [\-F] [\-s] [\-S] [options...]
.. _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 are listed below:
================ ===========================================
Short option Description
================ ===========================================
``-f shmFile`` use ``shmFile`` for IVSHMEM shared memory
``-F`` automatically enter full screen
``-s`` disable spice
``-S`` disable host screensaver
================ ===========================================
Options may be provided in short form when available, or long form.
Boolean options may be specified without a parameter to toggle their
state.
Examples:
- ``looking-glass-client -F`` (short)
- ``looking-glass-client win:fullScreen`` (long)
- ``looking-glass-client -f /dev/shm/my-lg-shmem`` (short with parameter)
- ``looking-glass-client app:shmFile=/dev/shm/my-lg-shmem`` (long with parameter)
.. seealso::
:ref:`client_full_command_options`
.. _client_key_bindings:
@ -53,30 +85,6 @@ Command Description
You can also find this list at any time by holding down :kbd:`Scroll Lock`.
.. _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 long form.
Boolean options may be specified without a parameter to toggle their
state.
Examples:
- ``looking-glass-client -F`` (short)
- ``looking-glass-client win:fullScreen`` (long)
- ``looking-glass-client -f /dev/shm/my-lg-shmem`` (short with parameter)
- ``looking-glass-client app:shmFile=/dev/shm/my-lg-shmem`` (long with parameter)
.. _client_config_options_file:
Configuration Files