Mirrored_Repos/LookingGlass
1
0
Fork 0
mirror of https://github.com/gnif/LookingGlass.git synced 2024-11-21 21:17:19 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[doc] fix formatting a bit

Browse Source
This commit is contained in:
Geoffrey McRae 2019-05-23 20:19:37 +10:00
parent 76d58deefa
commit 07be380f34
3 changed files with 23 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -1,4 +1,5 @@
# LookingGlass # Looking Glass
An extremely low latency KVMFR (KVM FrameRelay) implementation for guests with VGA PCI Passthrough. An extremely low latency KVMFR (KVM FrameRelay) implementation for guests with VGA PCI Passthrough.
* Project Website: https://looking-glass.hostfission.com * Project Website: https://looking-glass.hostfission.com

2
VERSION
View File

@ -1 +1 @@
a12-225-gdba9764c5e+1 a12-226-g76d58deefa+1

30
client/README.md
View File

@ -1,8 +1,12 @@
#Looking Glass Client # Looking Glass Client
This is the Looking Glass client application that is designed to work in tandem with the Looking Glass Host application This is the Looking Glass client application that is designed to work in tandem with the Looking Glass Host application
## Build Dependencies ---
## Building the Application
### Build Dependencies
* binutils-dev * binutils-dev
* cmake * cmake
@ -14,18 +18,24 @@ This is the Looking Glass client application that is designed to work in tandem
* libx11-dev * libx11-dev
* nettle-dev * nettle-dev
### Debian (and maybe Ubuntu) #### Debian (and maybe Ubuntu)
apt-get install binutils-dev cmake fonts-freefont-ttf libsdl2-dev libsdl2-ttf-dev libspice-protocol-dev libfontconfig1-dev libx11-dev nettle-dev apt-get install binutils-dev cmake fonts-freefont-ttf libsdl2-dev libsdl2-ttf-dev libspice-protocol-dev libfontconfig1-dev libx11-dev nettle-dev
## Building ### Building
mkdir client/build mkdir build
cd client/build cd build
cmake ../ cmake ../
make make
## Key Bindings Should this all go well you should be left with the file `looking-glass-client`
---
## Usage Tips
### Key Bindings
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. 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: Below are a list of current key bindings:
@ -37,13 +47,13 @@ Below are a list of current key bindings:
| <kbd>ScrLk</kbd>+<kbd>I</kbd> | Spice keyboard & mouse enable toggle | | <kbd>ScrLk</kbd>+<kbd>I</kbd> | Spice keyboard & mouse enable toggle |
| <kbd>ScrLk</kbd>+<kbd>N</kbd> | Toggle night vision mode (EGL renderer only!) | | <kbd>ScrLk</kbd>+<kbd>N</kbd> | Toggle night vision mode (EGL renderer only!) |
## Setting options via command line arguments ### Setting options via command line arguments
The syntax is simple: `module:name=value`, for example: The syntax is simple: `module:name=value`, for example:
./looking-glass-host win:fullScreen=yes egl:nvGain=1 ./looking-glass-host win:fullScreen=yes egl:nvGain=1
## Setting options via configuration files ### Setting options via configuration files
By default the application will look for and load the config files in the following locations By default the application will look for and load the config files in the following locations
@ -60,7 +70,7 @@ The format of this file is the commonly known INI format, for example:
Command line arguments will override any options loaded from the config files. Command line arguments will override any options loaded from the config files.
## Supported options ### Supported options
``` ```
|------------------------------------------------------------------------------------------------------------| |------------------------------------------------------------------------------------------------------------|