From 39c6b97582d200bc3204a7a658083fc77b6daf8b Mon Sep 17 00:00:00 2001 From: Jonathan Rubenstein Date: Wed, 5 May 2021 15:39:45 -0400 Subject: [PATCH] [doc] install: Correct command line examples --- doc/install.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/install.rst b/doc/install.rst index 6fd374a1..9bf0a573 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -362,12 +362,13 @@ 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 +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) +- ``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)