mirror of
https://github.com/gnif/LookingGlass.git
synced 2024-11-21 21:17:19 +00:00
[doc]: make title casing consistent
This commit is contained in:
Tudor Brindus
Geoffrey McRae
parent
33bcf19164
commit
2780f6c22f
@ -42,7 +42,7 @@ Client
|
||||
|
||||
.. _installing_build_dependencies:
|
||||
|
||||
Installing Build Dependencies
|
||||
Installing build dependencies
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
These required libraries and tools should be installed first.
|
||||
@ -56,7 +56,7 @@ These required libraries and tools should be installed first.
|
||||
|
||||
.. _client_dependencies:
|
||||
|
||||
Required Dependencies
|
||||
Required dependencies
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
..
|
||||
|
||||
@ -5,7 +5,7 @@ Installation
|
||||
|
||||
.. _libvirt:
|
||||
|
||||
libvirt/QEMU Configuration:
|
||||
libvirt/QEMU configuration:
|
||||
---------------------------
|
||||
|
||||
This article assumes you already have a fully functional libvirt domain with
|
||||
@ -42,7 +42,7 @@ your virtual machine.
|
||||
.. note::
|
||||
If you are using QEMU directly without libvirt the following arguments are
|
||||
required instead.
|
||||
|
||||
|
||||
Add the following to the commands to your QEMU command line, adjusting
|
||||
the ``bus`` parameter to suit your particular configuration:
|
||||
|
||||
@ -64,7 +64,7 @@ section.
|
||||
|
||||
.. _libvirt_determining_memory:
|
||||
|
||||
Determining Memory
|
||||
Determining memory
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
You will need to adjust the memory size to be suitable for your desired maximum
|
||||
@ -158,7 +158,7 @@ input, sound input and output, and display fallback.
|
||||
.. note::
|
||||
The default configuration that libvirt uses is not optimal and must be
|
||||
adjusted. Failure to perform these changes will cause input issues along
|
||||
with failure to support 5 button mice.
|
||||
with failure to support 5 button mice.
|
||||
|
||||
If you would like to use Spice to give you keyboard and mouse input
|
||||
along with clipboard sync support, make sure you have a
|
||||
@ -184,7 +184,7 @@ To enable Audio support add a standard Intel HDA audio device to your
|
||||
configuration as per below:
|
||||
|
||||
.. code:: xml
|
||||
|
||||
|
||||
<sound model='ich9'>
|
||||
<audio id='1'/>
|
||||
</sound>
|
||||
@ -195,7 +195,7 @@ If you also want clipboard synchronization please see
|
||||
|
||||
.. _libvirt_clipboard_synchronization:
|
||||
|
||||
Clipboard Synchronization
|
||||
Clipboard synchronization
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Looking Glass can synchronize the clipboard between the host and guest using
|
||||
@ -262,7 +262,7 @@ Find the ``<memballoon>`` tag and set its type to ``none``:
|
||||
|
||||
.. _host_install:
|
||||
|
||||
Additional Tuning
|
||||
Additional tuning
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
Looking Glass is latency sensitive and as such it may suffer microstutters if
|
||||
@ -288,7 +288,7 @@ required to obtain optimal performance.
|
||||
5. Be sure to set your CPU model type to `host-passthrough` so that your guest
|
||||
operating system is aware of the acceleration features of your CPU and can
|
||||
make full use of them.
|
||||
|
||||
|
||||
6. AMD users be sure that you have the CPU feature flag `topoext` enabled or
|
||||
your guest operating system will not be aware of which CPU cores are
|
||||
hyper-thread pairs.
|
||||
@ -301,7 +301,7 @@ required to obtain optimal performance.
|
||||
|
||||
How to perform these changes is left as an exercise to the reader.
|
||||
|
||||
Host Application
|
||||
Host application
|
||||
----------------
|
||||
|
||||
The Looking Glass Host application captures frames from the guest OS using a
|
||||
@ -345,7 +345,7 @@ either the :ref:`libvirt` section.
|
||||
|
||||
.. _installing_the_ivshmem_driver:
|
||||
|
||||
Installing the IVSHMEM Driver
|
||||
Installing the IVSHMEM driver
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Since B6 the host installer available on the official Looking Glass website
|
||||
@ -355,7 +355,7 @@ version.
|
||||
|
||||
.. _host_install_service:
|
||||
|
||||
Installing the Looking Glass Service
|
||||
Installing the Looking Glass service
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
After installing your IVSHMEM driver, we can now install the Looking Glass Host
|
||||
@ -383,7 +383,7 @@ running ``looking-glass-host-setup.exe /?``.
|
||||
|
||||
.. _client_install:
|
||||
|
||||
Client Application
|
||||
Client application
|
||||
------------------
|
||||
|
||||
The Looking Glass Client receives frames from the :ref:`Host <host_install>` to
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
.. _kernel_module:
|
||||
|
||||
Kernel Module
|
||||
Kernel module
|
||||
#############
|
||||
|
||||
This kernel module implements a basic interface to the IVSHMEM device
|
||||
@ -27,7 +27,7 @@ Then switch to the ``module/`` directory
|
||||
|
||||
.. _module_dkms:
|
||||
|
||||
Using DKMS (Recommended)
|
||||
Using DKMS (recommended)
|
||||
------------------------
|
||||
|
||||
You can use the kernel's DKMS feature to keep the module across upgrades.
|
||||
@ -70,7 +70,7 @@ with commas.
|
||||
|
||||
.. _module_manual:
|
||||
|
||||
Compiling & Loading (Manual)
|
||||
Compiling & loading (manual)
|
||||
----------------------------
|
||||
|
||||
To compile the module manually, run ``make`` in the module directory.
|
||||
|
||||
@ -9,7 +9,7 @@ with a Screen or Window Capture source.
|
||||
This may help improve your viewers' watching experience, and
|
||||
allows you to use your host privately.
|
||||
|
||||
Build Instructions
|
||||
Build instructions
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The OBS plugin is included in the main source tree of Looking Glass. The
|
||||
|
||||
@ -6,7 +6,7 @@ Glass. Below is a list of known issues with potential solutions:
|
||||
|
||||
.. _when_launching_looking_glass_the_desktop_doesnt_appear:
|
||||
|
||||
When Launching Looking Glass the Desktop Doesn't Appear
|
||||
When launching Looking Glass the desktop doesn't appear
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
- **Using an AMD GPU?**
|
||||
@ -21,7 +21,7 @@ When Launching Looking Glass the Desktop Doesn't Appear
|
||||
|
||||
.. _the_clipboard_is_not_working:
|
||||
|
||||
The Clipboard is not Working
|
||||
The clipboard is not working
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
- **Is clipboard synchronization enabled?**
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
.. _client_usage:
|
||||
|
||||
Client Usage
|
||||
Client usage
|
||||
------------
|
||||
|
||||
**looking-glass-client** [\-\-help] [\-f] [\-F] [\-s] [\-S] [options...]
|
||||
@ -8,7 +8,7 @@ Client Usage
|
||||
|
||||
.. _client_cli_options:
|
||||
|
||||
Command Line Options
|
||||
Command line options
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
A full list of command line options is available with the ``--help`` or ``-h``
|
||||
@ -44,7 +44,7 @@ Examples:
|
||||
|
||||
.. _client_key_bindings:
|
||||
|
||||
Default Key Bindings
|
||||
Default key bindings
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
By default, Looking Glass uses the :kbd:`ScrLk` key as the escape key
|
||||
@ -91,7 +91,7 @@ You can also find this list at any time by holding down :kbd:`Scroll Lock`.
|
||||
|
||||
.. _client_config_options_file:
|
||||
|
||||
Configuration Files
|
||||
Configuration files
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
By default, Looking Glass will load config files from
|
||||
@ -123,7 +123,7 @@ files.
|
||||
|
||||
.. _client_overlay_mode:
|
||||
|
||||
Overlay Mode
|
||||
Overlay mode
|
||||
~~~~~~~~~~~~
|
||||
|
||||
The Overlay Mode lets you configure various runtime options for Looking Glass.
|
||||
@ -148,7 +148,7 @@ as your changes may be discarded.
|
||||
|
||||
.. _client_config_widget:
|
||||
|
||||
Configuration Widget
|
||||
Configuration widget
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The Configuration Widget is accessible through the Overlay Mode. The
|
||||
@ -166,19 +166,19 @@ Settings tab
|
||||
Changes in the Settings tab are not persistent, and will change back to
|
||||
their default values when the client is restarted.
|
||||
|
||||
EGL Filters tab
|
||||
EGL filters tab
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
The EGL Filters tab contains options for toggling, configuring, and ordering
|
||||
post-processing filters. Each filter can be expanded to open its settings.
|
||||
Filters can also be re-ordered by dragging them up or down. Filters are applied
|
||||
The EGL Filters tab contains options for toggling, configuring, and ordering
|
||||
post-processing filters. Each filter can be expanded to open its settings.
|
||||
Filters can also be re-ordered by dragging them up or down. Filters are applied
|
||||
from top to bottom, keep this in mind when ordering them, e.g applying CAS
|
||||
before FSR might have different results than the reverse. Users are encouraged
|
||||
to experiment with the order and parameters to achieve optimal results. The
|
||||
to experiment with the order and parameters to achieve optimal results. The
|
||||
currently available filters include:
|
||||
|
||||
- Downscaler: Filter for downscaling the host resolution. Can be used to undo
|
||||
poor upscaling on the VM to better utilize AMD FSR (see below). The filter
|
||||
- Downscaler: Filter for downscaling the host resolution. Can be used to undo
|
||||
poor upscaling on the VM to better utilize AMD FSR (see below). The filter
|
||||
has a pixel-size setting that is used to set the effective downscaling ratio,
|
||||
and a configurable interpolation algorithm.
|
||||
|
||||
@ -193,9 +193,9 @@ currently available filters include:
|
||||
application. Has adjustable sharpness setting.
|
||||
|
||||
The filter settings and order can be saved to presets so that it can be restored
|
||||
at a later time. As filter settings are usually application specific, multiple
|
||||
presets can be defined for each case scenario. To save a preset, click on "Save
|
||||
preset as..." and enter a preset name. Presets are loaded by selecting them in
|
||||
at a later time. As filter settings are usually application specific, multiple
|
||||
presets can be defined for each case scenario. To save a preset, click on "Save
|
||||
preset as..." and enter a preset name. Presets are loaded by selecting them in
|
||||
the "Preset name" pull down. Presets are persistent and are stored on disk at
|
||||
``$XDG_CONFIG_HOME/looking-glass/presets``.
|
||||
|
||||
@ -210,8 +210,8 @@ the "Preset name" pull down. Presets are persistent and are stored on disk at
|
||||
|
||||
.. _client_full_command_options:
|
||||
|
||||
Full Command Line Options
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
All command line options
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The following is a complete list of options accepted by this application
|
||||
|
||||
@ -337,7 +337,7 @@ The following is a complete list of options accepted by this application
|
||||
|
||||
.. _host_usage:
|
||||
|
||||
Host Usage
|
||||
Host usage
|
||||
----------
|
||||
|
||||
By default the host application will simply work however there are some
|
||||
@ -350,7 +350,7 @@ application was installed for it to be found and used by the application
|
||||
|
||||
.. _host_capture:
|
||||
|
||||
Capture Interface
|
||||
Capture interface
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. note::
|
||||
@ -397,7 +397,7 @@ to the `looking-glass-host.ini` configuration:
|
||||
|
||||
[app]
|
||||
capture=dxgi
|
||||
|
||||
|
||||
[dxgi]
|
||||
copyBackend=d3d12
|
||||
d3d12CopySleep=5
|
||||
|
||||
Loading…
Reference in New Issue
Block a user