Mirrored_Repos/LookingGlass
1
0
Fork 0
mirror of https://github.com/gnif/LookingGlass.git synced 2024-11-10 08:38:20 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
1a8dfe1cc0
LookingGlass/client/README.md

167 lines
11 KiB
Markdown
Raw Normal View History

[doc] fix formatting a bit
2019-05-23 10:19:37 +00:00
# Looking Glass Client
[doc] Updated project documentation in leu of Beta 1 release
2019-05-23 10:13:41 +00:00
This is the Looking Glass client application that is designed to work in tandem with the Looking Glass Host application
[doc] fix formatting a bit
2019-05-23 10:19:37 +00:00
---
## Building the Application
### Build Dependencies
[doc] Updated project documentation in leu of Beta 1 release
2019-05-23 10:13:41 +00:00
* binutils-dev
* cmake
* fonts-freefont-ttf
* libsdl2-dev
* libsdl2-ttf-dev
* libspice-protocol-dev
* libfontconfig1-dev
* libx11-dev
* nettle-dev
[doc] fix formatting a bit
2019-05-23 10:19:37 +00:00
#### Debian (and maybe Ubuntu)
[doc] Updated project documentation in leu of Beta 1 release
2019-05-23 10:13:41 +00:00
apt-get install binutils-dev cmake fonts-freefont-ttf libsdl2-dev libsdl2-ttf-dev libspice-protocol-dev libfontconfig1-dev libx11-dev nettle-dev
[doc] fix formatting a bit
2019-05-23 10:19:37 +00:00
### Building
[doc] Updated project documentation in leu of Beta 1 release
2019-05-23 10:13:41 +00:00
[doc] fix formatting a bit
2019-05-23 10:19:37 +00:00
mkdir build
cd build
[doc] Updated project documentation in leu of Beta 1 release
2019-05-23 10:13:41 +00:00
cmake ../
make
[doc] fixed another formatting snafu
2019-05-23 10:20:18 +00:00
Should this all go well you should be left with the file `looking-glass-client`
[doc] fix formatting a bit
2019-05-23 10:19:37 +00:00
---
## Usage Tips
### Key Bindings
[doc] Updated project documentation in leu of Beta 1 release
2019-05-23 10:13:41 +00:00
By default Looking Glass uses the `Scroll Lock` key as the escape key for commands as well as the input capture mode toggle, this can be changed using the `-m` switch if you desire a different key.
Below are a list of current key bindings:
| Command | Description |
|-|-|
[client] main: new feature to increase/decrease mouse sensitivity
2019-05-23 19:29:38 +00:00
| <kbd>ScrLk</kbd> | Toggle cursor screen capture |
| <kbd>ScrLk</kbd>+<kbd>F</kbd> | Full Screen toggle |
[client] add new keybind to toggle the video stream (ScrLck+V)
2020-10-14 08:32:21 +00:00
| <kbd>ScrLk</kbd>+<kbd>V</kbd> | Video stream toggle |
[client] main: new feature to increase/decrease mouse sensitivity
2019-05-23 19:29:38 +00:00
| <kbd>ScrLk</kbd>+<kbd>I</kbd> | Spice keyboard & mouse enable toggle |
| <kbd>ScrLk</kbd>+<kbd>N</kbd> | Toggle night vision mode (EGL renderer only!) |
[client] add quit keybind
2020-04-22 16:31:30 +00:00
| <kbd>ScrLk</kbd>+<kbd>Q</kbd> | Quit |
[client] fix typo
2019-05-23 19:31:16 +00:00
| <kbd>ScrLk</kbd>+<kbd>Insert</kbd> | Increase mouse sensitivity (in capture mode only) |
| <kbd>ScrLk</kbd>+<kbd>Del</kbd> | Decrease mouse sensitivity (in capture mode only) |
[client] README.md cosmetics
2019-05-31 06:45:55 +00:00
| <kbd>ScrLk</kbd>+<kbd>F1</kbd> | Send <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>F1</kbd> to the guest |
| <kbd>ScrLk</kbd>+<kbd>F2</kbd> | Send <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>F2</kbd> to the guest |
| <kbd>ScrLk</kbd>+<kbd>F3</kbd> | Send <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>F3</kbd> to the guest |
| <kbd>ScrLk</kbd>+<kbd>F4</kbd> | Send <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>F4</kbd> to the guest |
| <kbd>ScrLk</kbd>+<kbd>F5</kbd> | Send <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>F5</kbd> to the guest |
| <kbd>ScrLk</kbd>+<kbd>F6</kbd> | Send <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>F6</kbd> to the guest |
| <kbd>ScrLk</kbd>+<kbd>F7</kbd> | Send <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>F7</kbd> to the guest |
| <kbd>ScrLk</kbd>+<kbd>F8</kbd> | Send <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>F8</kbd> to the guest |
| <kbd>ScrLk</kbd>+<kbd>F9</kbd> | Send <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>F9</kbd> to the guest |
| <kbd>ScrLk</kbd>+<kbd>F10</kbd> | Send <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>F10</kbd> to the guest |
| <kbd>ScrLk</kbd>+<kbd>F11</kbd> | Send <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>F11</kbd> to the guest |
| <kbd>ScrLk</kbd>+<kbd>F12</kbd> | Send <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>F12</kbd> to the guest |
[client] updated documentation for new keybinds
2019-05-31 06:44:08 +00:00
[doc] Updated project documentation in leu of Beta 1 release
2019-05-23 10:13:41 +00:00
[doc] fix formatting a bit
2019-05-23 10:19:37 +00:00
### Setting options via command line arguments
[doc] Updated project documentation in leu of Beta 1 release
2019-05-23 10:13:41 +00:00
The syntax is simple: `module:name=value`, for example:
[client] Fix typo in example of README.md
2019-05-24 16:09:14 +00:00
./looking-glass-client win:fullScreen=yes egl:nvGain=1
[doc] Updated project documentation in leu of Beta 1 release
2019-05-23 10:13:41 +00:00
[doc] fix formatting a bit
2019-05-23 10:19:37 +00:00
### Setting options via configuration files
[doc] Updated project documentation in leu of Beta 1 release
2019-05-23 10:13:41 +00:00
By default the application will look for and load the config files in the following locations
* /etc/looking-glass-client.ini
* ~/.looking-glass-client.ini
The format of this file is the commonly known INI format, for example:
[win]
fullScreen=yes
[egl]
nvGain=1
Command line arguments will override any options loaded from the config files.
[doc] fix formatting a bit
2019-05-23 10:19:37 +00:00
### Supported options
[doc] Updated project documentation in leu of Beta 1 release
2019-05-23 10:13:41 +00:00
```
[doc] client: document defaults instead of my preconfigured values
2019-05-23 10:26:37 +00:00
|-------------------------------------------------------------------------------------------------------------------------|
| Long | Short | Value | Description |
|-------------------------------------------------------------------------------------------------------------------------|
| app:configFile | -C | NULL | A file to read additional configuration from |
| app:shmFile | -f | /dev/shm/looking-glass | The path to the shared memory file |
| app:shmSize | -L | 0 | Specify the size in MB of the shared memory file (0 = detect) |
| app:renderer | -g | auto | Specify the renderer to use |
| app:license | -l | no | Show the license for this application and then terminate |
| app:cursorPollInterval | | 1000 | How often to check for a cursor update in microseconds |
| app:framePollInterval | | 1000 | How often to check for a frame update in microseconds |
|-------------------------------------------------------------------------------------------------------------------------|
[doc] Updated project documentation in leu of Beta 1 release
2019-05-23 10:13:41 +00:00
Implement option to disable minimizing window on focus loss. Default behavior is not changed - not configuring these options unfocused window is minimized. * Added config entry win:minimizeOnFocusLoss (default true).
2019-07-01 07:53:12 +00:00
|-------------------------------------------------------------------------------------------------------------|
| Long | Short | Value | Description |
|-------------------------------------------------------------------------------------------------------------|
| win:title | | Looking Glass (client) | The window title |
| win:position | | center | Initial window position at startup |
| win:size | | 1024x768 | Initial window size at startup |
| win:autoResize | -a | no | Auto resize the window to the guest |
| win:allowResize | -n | yes | Aallow the window to be manually resized |
| win:keepAspect | -r | yes | Maintain the correct aspect ratio |
| win:borderless | -d | no | Borderless mode |
| win:fullScreen | -F | no | Launch in fullscreen borderless mode |
| win:maximize | -T | no | Launch window maximized |
| win:minimizeOnFocusLoss | | yes | Minimize window on focus loss |
| win:fpsLimit | -K | 200 | Frame rate limit (0 = disable - not recommended) |
| win:showFPS | -k | no | Enable the FPS & UPS display |
| win:ignoreQuit | -Q | no | Ignore requests to quit (ie: Alt+F4) |
| win:noScreensaver | -S | no | Prevent the screensaver from starting |
| win:alerts | -q | yes | Show on screen alert messages |
|-------------------------------------------------------------------------------------------------------------|
[doc] Updated project documentation in leu of Beta 1 release
2019-05-23 10:13:41 +00:00
|---------------------------------------------------------------------------------------------------------------------------------------|
| Long | Short | Value | Description |
|---------------------------------------------------------------------------------------------------------------------------------------|
| input:grabKeyboard | -G | yes | Grab the keyboard in capture mode |
| input:escapeKey | -m | 71 = ScrollLock | Specify the escape key, see https://wiki.libsdl.org/SDLScancodeLookup for valid values |
| input:hideCursor | -M | yes | Hide the local mouse cursor |
[client] fix typo
2019-05-23 19:31:16 +00:00
| input:mouseSens | | 0 | Initial mouse sensitivity when in capture mode (-9 to 9) |
[doc] Updated project documentation in leu of Beta 1 release
2019-05-23 10:13:41 +00:00
|---------------------------------------------------------------------------------------------------------------------------------------|
[doc] client: document defaults instead of my preconfigured values
2019-05-23 10:26:37 +00:00
|------------------------------------------------------------------------------------------------------------------|
| Long | Short | Value | Description |
|------------------------------------------------------------------------------------------------------------------|
| spice:enable | -s | yes | Enable the built in SPICE client for input and/or clipboard support |
| spice:host | -c | 127.0.0.1 | The SPICE server host or UNIX socket |
| spice:port | -p | 5900 | The SPICE server port (0 = unix socket) |
| spice:input | | yes | Use SPICE to send keyboard and mouse input events to the guest |
| spice:clipboard | | yes | Use SPICE to syncronize the clipboard contents with the guest |
| spice:clipboardToVM | | yes | Allow the clipboard to be syncronized TO the VM |
| spice:clipboardToLocal | | yes | Allow the clipboard to be syncronized FROM the VM |
| spice:scaleCursor | -j | yes | Scale cursor input position to screen size when up/down scaled |
update client/README.md: spice:captureOnStart from #278
2020-08-18 22:14:27 +00:00
| spice:captureOnStart | | no | Capture mouse and keyboard on start |
[client] add option to always show cursor
2020-11-15 13:41:22 +00:00
| spice:alwaysShowCursor | | no | Always show host cursor |
[doc] client: document defaults instead of my preconfigured values
2019-05-23 10:26:37 +00:00
|------------------------------------------------------------------------------------------------------------------|
[doc] Updated project documentation in leu of Beta 1 release
2019-05-23 10:13:41 +00:00
|--------------------------------------------------------------------------|
| Long | Short | Value | Description |
|--------------------------------------------------------------------------|
| egl:vsync | | no | Enable vsync |
| egl:nvGainMax | | 1 | The maximum night vision gain |
| egl:nvGain | | 0 | The initial night vision gain at startup |
|--------------------------------------------------------------------------|
|------------------------------------------------------------------------------------|
| Long | Short | Value | Description |
|------------------------------------------------------------------------------------|
| opengl:mipmap | | yes | Enable mipmapping |
[doc] client: document defaults instead of my preconfigured values
2019-05-23 10:26:37 +00:00
| opengl:vsync | | yes | Enable vsync |
[doc] Updated project documentation in leu of Beta 1 release
2019-05-23 10:13:41 +00:00
| opengl:preventBuffer | | yes | Prevent the driver from buffering frames |
| opengl:amdPinnedMem | | yes | Use GL_AMD_pinned_memory if it is available |
|------------------------------------------------------------------------------------|
```
Reference in New Issue Copy Permalink