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

[doc]: make title casing consistent

Browse Source
This commit is contained in:
Tudor Brindus 2022-09-18 19:57:49 -04:00 committed by Geoffrey McRae
parent 33bcf19164
commit 2780f6c22f
6 changed files with 41 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/build.rst
View File

@ -42,7 +42,7 @@ Client
.. _installing_build_dependencies: .. _installing_build_dependencies:
Installing Build Dependencies Installing build dependencies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
These required libraries and tools should be installed first. These required libraries and tools should be installed first.
@ -56,7 +56,7 @@ These required libraries and tools should be installed first.
.. _client_dependencies: .. _client_dependencies:
Required Dependencies Required dependencies
^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
.. ..

16
doc/install.rst
View File

@ -5,7 +5,7 @@ Installation
.. _libvirt: .. _libvirt:
libvirt/QEMU Configuration: libvirt/QEMU configuration:
--------------------------- ---------------------------
This article assumes you already have a fully functional libvirt domain with This article assumes you already have a fully functional libvirt domain with
@ -64,7 +64,7 @@ section.
.. _libvirt_determining_memory: .. _libvirt_determining_memory:
Determining Memory Determining memory
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
You will need to adjust the memory size to be suitable for your desired maximum You will need to adjust the memory size to be suitable for your desired maximum
@ -195,7 +195,7 @@ If you also want clipboard synchronization please see
.. _libvirt_clipboard_synchronization: .. _libvirt_clipboard_synchronization:
Clipboard Synchronization Clipboard synchronization
^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^
Looking Glass can synchronize the clipboard between the host and guest using 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: .. _host_install:
Additional Tuning Additional tuning
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^
Looking Glass is latency sensitive and as such it may suffer microstutters if Looking Glass is latency sensitive and as such it may suffer microstutters if
@ -301,7 +301,7 @@ required to obtain optimal performance.
How to perform these changes is left as an exercise to the reader. 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 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 Installing the IVSHMEM driver
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Since B6 the host installer available on the official Looking Glass website Since B6 the host installer available on the official Looking Glass website
@ -355,7 +355,7 @@ version.
.. _host_install_service: .. _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 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_install:
Client Application Client application
------------------ ------------------
The Looking Glass Client receives frames from the :ref:`Host <host_install>` to The Looking Glass Client receives frames from the :ref:`Host <host_install>` to

6
doc/module.rst
View File

@ -1,6 +1,6 @@
.. _kernel_module: .. _kernel_module:
Kernel Module Kernel module
############# #############
This kernel module implements a basic interface to the IVSHMEM device This kernel module implements a basic interface to the IVSHMEM device
@ -27,7 +27,7 @@ Then switch to the ``module/`` directory
.. _module_dkms: .. _module_dkms:
Using DKMS (Recommended) Using DKMS (recommended)
------------------------ ------------------------
You can use the kernel's DKMS feature to keep the module across upgrades. You can use the kernel's DKMS feature to keep the module across upgrades.
@ -70,7 +70,7 @@ with commas.
.. _module_manual: .. _module_manual:
Compiling & Loading (Manual) Compiling & loading (manual)
---------------------------- ----------------------------
To compile the module manually, run ``make`` in the module directory. To compile the module manually, run ``make`` in the module directory.

2
doc/obs.rst
View File

@ -9,7 +9,7 @@ with a Screen or Window Capture source.
This may help improve your viewers' watching experience, and This may help improve your viewers' watching experience, and
allows you to use your host privately. 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 The OBS plugin is included in the main source tree of Looking Glass. The

4
doc/troubleshooting.rst
View File

@ -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_doesnt_appear:
When Launching Looking Glass the Desktop Doesn't Appear When launching Looking Glass the desktop doesn't appear
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- **Using an AMD GPU?** - **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 The clipboard is not working
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- **Is clipboard synchronization enabled?** - **Is clipboard synchronization enabled?**

22
doc/usage.rst
View File

@ -1,6 +1,6 @@
.. _client_usage: .. _client_usage:
Client Usage Client usage
------------ ------------
**looking-glass-client** [\-\-help] [\-f] [\-F] [\-s] [\-S] [options...] **looking-glass-client** [\-\-help] [\-f] [\-F] [\-s] [\-S] [options...]
@ -8,7 +8,7 @@ Client Usage
.. _client_cli_options: .. _client_cli_options:
Command Line Options Command line options
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
A full list of command line options is available with the ``--help`` or ``-h`` A full list of command line options is available with the ``--help`` or ``-h``
@ -44,7 +44,7 @@ Examples:
.. _client_key_bindings: .. _client_key_bindings:
Default Key Bindings Default key bindings
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
By default, Looking Glass uses the :kbd:`ScrLk` key as the escape key 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: .. _client_config_options_file:
Configuration Files Configuration files
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
By default, Looking Glass will load config files from By default, Looking Glass will load config files from
@ -123,7 +123,7 @@ files.
.. _client_overlay_mode: .. _client_overlay_mode:
Overlay Mode Overlay mode
~~~~~~~~~~~~ ~~~~~~~~~~~~
The Overlay Mode lets you configure various runtime options for Looking Glass. 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: .. _client_config_widget:
Configuration Widget Configuration widget
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
The Configuration Widget is accessible through the Overlay Mode. The The Configuration Widget is accessible through the Overlay Mode. The
@ -166,7 +166,7 @@ Settings tab
Changes in the Settings tab are not persistent, and will change back to Changes in the Settings tab are not persistent, and will change back to
their default values when the client is restarted. 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 The EGL Filters tab contains options for toggling, configuring, and ordering
@ -210,8 +210,8 @@ the "Preset name" pull down. Presets are persistent and are stored on disk at
.. _client_full_command_options: .. _client_full_command_options:
Full Command Line Options All command line options
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
The following is a complete list of options accepted by this application 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 Host usage
---------- ----------
By default the host application will simply work however there are some 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: .. _host_capture:
Capture Interface Capture interface
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
.. note:: .. note::