mirror of
https://github.com/gnif/LookingGlass.git
synced 2024-11-21 21:17:19 +00:00
311 lines
7.2 KiB
ReStructuredText
311 lines
7.2 KiB
ReStructuredText
.. _building:
|
|
|
|
Building
|
|
########
|
|
|
|
The following instructions will help you build Looking Glass from source code.
|
|
Before attempting this, you should have a basic understanding of
|
|
how to use the shell.
|
|
|
|
.. _download_source:
|
|
|
|
Downloading
|
|
-----------
|
|
|
|
Visit the Looking Glass `Download Page <https://looking-glass.io/downloads>`__,
|
|
and download the stable version (**recommended**).
|
|
You can also download a *bleeding-edge version*, or the latest RC version
|
|
during a Release Candidate cycle.
|
|
|
|
Developers can clone the source code repo with ``git``.
|
|
|
|
.. code:: bash
|
|
|
|
git clone --recursive https://github.com/gnif/LookingGlass.git
|
|
|
|
.. warning::
|
|
|
|
Please only clone from Git if you're a developer, and know what you're
|
|
doing. Looking Glass requires git submodules that must be setup and updated
|
|
when building. Source code downloads from the website come bundled with the
|
|
necessary submodules.
|
|
|
|
.. note::
|
|
|
|
When using the latest bleeding-edge client version,
|
|
you *MUST* download and install the corresponding host application.
|
|
|
|
.. _build_client_section:
|
|
|
|
Client
|
|
------
|
|
|
|
.. _installing_build_dependencies:
|
|
|
|
Installing build dependencies
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
These required libraries and tools should be installed first.
|
|
|
|
.. note::
|
|
|
|
The below list of dependencies is for Debian. A community maintained list of
|
|
dependencies for other distributions for the current **stable** version of
|
|
Looking Glass is maintained on the wiki at:
|
|
https://looking-glass.io/wiki/Installation_on_other_distributions
|
|
|
|
.. _client_dependencies:
|
|
|
|
Required dependencies
|
|
^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
..
|
|
Editor note: Listed dependencies are Debian packages containing the
|
|
required resources. All dependencies must be explicitly defined.
|
|
Omitting required dependencies that happen to be pulled in via
|
|
Depends: or Recommends: from another listed package is not allowed.
|
|
All required packages must be listed.
|
|
|
|
- ``cmake``
|
|
- ``gcc``, ``g++`` \| ``clang``
|
|
- ``libegl-dev``
|
|
- ``libgl-dev``
|
|
- ``libgles-dev``
|
|
- ``libfontconfig-dev``
|
|
- ``libgmp-dev``
|
|
- ``libspice-protocol-dev``
|
|
- ``make``
|
|
- ``nettle-dev``
|
|
- ``pkg-config``
|
|
|
|
.. _client_deps_may_be_disabled:
|
|
|
|
May be disabled
|
|
<<<<<<<<<<<<<<<
|
|
|
|
These dependencies are required by default, but may be omitted if their
|
|
feature is disabled when running :ref:`cmake <client_building>`.
|
|
|
|
- Disable with ``cmake -DENABLE_BACKTRACE=no ..``
|
|
|
|
- ``binutils-dev``
|
|
|
|
- Disable with ``cmake -DENABLE_X11=no ..``
|
|
|
|
- ``libx11-dev``
|
|
- ``libxfixes-dev``
|
|
- ``libxi-dev``
|
|
- ``libxinerama-dev``
|
|
- ``libxss-dev``
|
|
- ``libxcursor-dev``
|
|
- ``libxpresent-dev``
|
|
|
|
- Disable with ``cmake -DENABLE_WAYLAND=no ..``
|
|
|
|
- ``libxkbcommon-dev``
|
|
- ``libwayland-bin``
|
|
- ``libwayland-dev``
|
|
- ``wayland-protocols``
|
|
|
|
- Disable with ``cmake -DENABLE_PIPEWIRE=no ..``
|
|
|
|
- ``libpipewire-0.3-dev``
|
|
- ``libsamplerate0-dev``
|
|
|
|
- Disable with ``cmake -DENABLE_PULSEAUDIO=no ..``
|
|
|
|
- ``libpulse-dev``
|
|
- ``libsamplerate0-dev``
|
|
|
|
.. _client_deps_recommended:
|
|
|
|
Recommended
|
|
<<<<<<<<<<<
|
|
|
|
- ``fonts-dejavu-core`` (This is the default UI font, but a random font will
|
|
be chosen if not available).
|
|
|
|
.. _client_fetching_with_apt:
|
|
|
|
Fetching with APT
|
|
^^^^^^^^^^^^^^^^^
|
|
|
|
You can fetch these dependencies with the following command:
|
|
|
|
.. code:: bash
|
|
|
|
apt-get install binutils-dev cmake fonts-dejavu-core libfontconfig-dev \
|
|
gcc g++ pkg-config libegl-dev libgl-dev libgles-dev libspice-protocol-dev \
|
|
nettle-dev libx11-dev libxcursor-dev libxi-dev libxinerama-dev \
|
|
libxpresent-dev libxss-dev libxkbcommon-dev libwayland-dev wayland-protocols \
|
|
libpipewire-0.3-dev libpulse-dev libsamplerate0-dev
|
|
|
|
You may omit some dependencies if you disable the feature which requires them
|
|
when running :ref:`cmake <client_building>`.
|
|
(See :ref:`client_deps_may_be_disabled`)
|
|
|
|
.. _client_building:
|
|
|
|
Building
|
|
~~~~~~~~
|
|
|
|
If you've downloaded the source code as a zip file, simply unzip and ``cd``
|
|
into the new directory. If you've cloned the repo with ``git``, then ``cd``
|
|
into the *LookingGlass* directory.
|
|
|
|
.. code:: bash
|
|
|
|
mkdir client/build
|
|
cd client/build
|
|
cmake ../
|
|
make
|
|
|
|
This will build the ``looking-glass-client`` binary, which is used to display
|
|
frames from the guest.
|
|
|
|
You can then :ref:`continue installing Looking Glass <client_install>`, or run
|
|
it directly from the build directory:
|
|
|
|
.. code:: bash
|
|
|
|
./looking-glass-client
|
|
|
|
.. seealso::
|
|
|
|
- :ref:`Client installation <client_install>`
|
|
- :ref:`Client usage <client_usage>`
|
|
|
|
.. note::
|
|
|
|
For users running GNOME on Wayland, you may want to enable ``libdecor`` when
|
|
building.
|
|
|
|
.. code:: bash
|
|
|
|
cmake -DENABLE_LIBDECOR=ON ../
|
|
|
|
For details, see :ref:`the FAQ <gnome_wayland_decorations>`.
|
|
|
|
.. note::
|
|
|
|
The most common compile error is related to backtrace support. Try disabling
|
|
this when building:
|
|
|
|
.. code:: bash
|
|
|
|
cmake -DENABLE_BACKTRACE=0 ../
|
|
|
|
If you disable this and need support for a crash, use ``gdb`` to obtain a
|
|
backtrace manually.
|
|
|
|
.. _host_building:
|
|
|
|
Host
|
|
----
|
|
|
|
These instructions help you build the host yourself from the
|
|
:ref:`downloaded source code <download_source>`.
|
|
|
|
.. warning::
|
|
:name: dont-build-the-host
|
|
|
|
Building the host from source code is not recommended for most purposes,
|
|
and should only be attempted by users who are prepared to handle issues
|
|
on their own. Please download the pre-built binary installers from
|
|
https://looking-glass.io/downloads for stability, and increased support.
|
|
|
|
.. note::
|
|
|
|
The pre-built binaries also include NvFBC support built in, which is
|
|
only available to current Nvidia SDK license holders, and cannot
|
|
be enabled when building the host without also having a license.
|
|
|
|
(`link <#dont-build-the-host>`_)
|
|
|
|
.. _host_win_on_win:
|
|
|
|
For Windows on Windows
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
1. Download and install msys2 x86_64 from
|
|
`http://www.msys2.org/ <http://www.msys2.org/>`__ following the setup
|
|
instructions provided
|
|
|
|
2. Run the MSYS2 shell
|
|
|
|
3. Download build dependencies with pacman
|
|
|
|
.. code:: bash
|
|
|
|
pacman -Fy
|
|
pacman -Sy git make mingw-w64-x86_64-gcc mingw-w64-x86_64-cmake
|
|
|
|
4. Change directory to the source tree with ``cd``
|
|
|
|
5. Configure the project and build it
|
|
|
|
.. code:: bash
|
|
|
|
mkdir host/build
|
|
cd host/build
|
|
cmake -G "MSYS Makefiles" ..
|
|
make
|
|
|
|
.. _host_linux_on_linux:
|
|
|
|
For Linux on Linux
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
Make a ``host/build`` directory, then run ``cmake``
|
|
|
|
.. code:: bash
|
|
|
|
mkdir host/build
|
|
cd host/build
|
|
cmake ..
|
|
make
|
|
|
|
.. _host_win_cross_on_linux:
|
|
|
|
For Windows cross compiling on Linux
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Like :ref:`host_linux_on_linux`, but using the mingw64 toolchain to
|
|
cross-compile a Windows ``.exe`` file.
|
|
|
|
.. code:: bash
|
|
|
|
mkdir host/build
|
|
cd host/build
|
|
cmake -DCMAKE_TOOLCHAIN_FILE=../toolchain-mingw64.cmake ..
|
|
make
|
|
|
|
.. _host_build_installer:
|
|
|
|
Building the Windows installer
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
1. :ref:`Build <host_win_cross_on_linux>` the host on Linux.
|
|
|
|
2. Install ``nsis``
|
|
|
|
.. code:: bash
|
|
|
|
apt-get install nsis
|
|
|
|
3. Use ``makensis`` to build the installer.
|
|
|
|
.. code:: bash
|
|
|
|
cd host/build/platform/Windows
|
|
makensis installer.nsi
|
|
|
|
.. _host_questions:
|
|
|
|
This will build ``looking-glass-host-setup.exe`` under
|
|
``host/build/platform/Windows/looking-glass-host-setup.exe``
|
|
|
|
.. seealso::
|
|
|
|
:ref:`Installing the Host <host_install>`
|