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]: use arrow characters

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

20
doc/module.rst
View File

@ -4,9 +4,9 @@ Kernel module
############# #############
This kernel module implements a basic interface to the IVSHMEM device This kernel module implements a basic interface to the IVSHMEM device
for Looking Glass in VM->VM mode. for Looking Glass in VM → VM mode.
Additionally in VM->host mode, it can be used to generate a shared Additionally in VM → host mode, it can be used to generate a shared
memory device on the host machine that supports dmabuf. memory device on the host machine that supports dmabuf.
Prerequisites Prerequisites
@ -53,11 +53,11 @@ To install the module into DKMS, run
Loading Loading
~~~~~~~ ~~~~~~~
For VM->VM, simply modprobe the module:: For VM → VM, simply modprobe the module::
modprobe kvmfr modprobe kvmfr
For VM->host with dmabuf, modprobe with the parameter For VM → host with dmabuf, modprobe with the parameter
``static_size_mb``: ``static_size_mb``:
.. code:: bash .. code:: bash
@ -80,13 +80,13 @@ To compile the module manually, run ``make`` in the module directory.
Loading Loading
~~~~~~~ ~~~~~~~
For VM->VM mode, run: For VM → VM mode, run:
.. code:: bash .. code:: bash
insmod kvmfr.ko insmod kvmfr.ko
For VM->host mode with dmabuf, instead of creating a shared memory file, For VM → host mode with dmabuf, instead of creating a shared memory file,
load this module with the parameter ``static_size_mb``. For example, a load this module with the parameter ``static_size_mb``. For example, a
32 MB shared memory device can be created with: 32 MB shared memory device can be created with:
@ -145,10 +145,10 @@ You may also use a config file: ``~/.looking-glass-client.ini``, or
.. _module_vm_to_host: .. _module_vm_to_host:
VM->Host VM → Host
~~~~~~~~ ~~~~~~~~~~~~
In VM->host mode, use this device in place of the shared memory file. In VM → host mode, use this device in place of the shared memory file.
QEMU QEMU
^^^^ ^^^^
@ -243,7 +243,7 @@ contents::
This will now run the next time you start your machine. This will now run the next time you start your machine.
If you are running in VM->host mode, you must additionally create another file If you are running in VM → host mode, you must additionally create another file
``/etc/modprobe.d/kvmfr.conf`` to properly set the size. It should have the ``/etc/modprobe.d/kvmfr.conf`` to properly set the size. It should have the
following contents:: following contents::

2
doc/usage.rst
View File

@ -87,7 +87,7 @@ Command Description
:kbd:`ScrLk` + :kbd:`RWin` Send :kbd:`RWin` to the guest :kbd:`ScrLk` + :kbd:`RWin` Send :kbd:`RWin` to the guest
============================ ======================================================= ============================ =======================================================
You can also find this list at any time by holding down :kbd:`Scroll Lock`. You can also find this list at any time by holding down :kbd:`ScrLk`.
.. _client_config_options_file: .. _client_config_options_file: