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

[doc] install: Correct command line examples

Browse Source
This commit is contained in:
Jonathan Rubenstein 2021-05-05 15:39:45 -04:00 committed by Geoffrey McRae
parent 211146b1a9
commit 39c6b97582
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/install.rst
View File

@ -362,12 +362,13 @@ Example: ``looking-glass-client --help``
Common options include ``-s`` for disabling spice, ``-S`` for disabling the Common options include ``-s`` for disabling spice, ``-S`` for disabling the
screen saver, and ``-F`` to automatically enter full screen. screen saver, and ``-F`` to automatically enter full screen.
Options may be provided with a Short form, if available, or directly by 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 long form. Boolean options may be specified without a paramater to toggle their
state. state.
Examples: Examples:
- ``looking-glass-client -F yes`` (Short) - ``looking-glass-client -F`` (short)
- ``looking-glass-client win:fullScreen yes`` (Long) - ``looking-glass-client win:fullScreen`` (long)
- ``looking-glass-client win:fullScreen`` (boolean toggle) - ``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)