From 211146b1a9bf4ef573c6738e7c9a0e19b708e719 Mon Sep 17 00:00:00 2001 From: Jonathan Rubenstein Date: Wed, 5 May 2021 15:21:37 -0400 Subject: [PATCH] [doc] install: Add Command Line Options section May in the future include up to date client options from the client --- doc/install.rst | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/doc/install.rst b/doc/install.rst index 2f852bd9..6fd374a1 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -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)