[systemd-merge] - Chapter 12 layout

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@17436 af4574ff-66df-0310-9fd7-8a98e5e911e0
This commit is contained in:
DJ Lucas 2016-06-04 05:00:39 +00:00
parent bb5351185c
commit 5b8f578d5e
7 changed files with 1028 additions and 2 deletions

View File

@ -0,0 +1,132 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../../general.ent">
%general-entities;
<!ENTITY cups-pk-helper-download-http
"http://www.freedesktop.org/software/cups-pk-helper/releases/cups-pk-helper-&cups-pk-helper-version;.tar.xz">
<!ENTITY cups-pk-helper-download-ftp " ">
<!ENTITY cups-pk-helper-md5sum "f14fb79da9c85f71e3e29101e179f2fc">
<!ENTITY cups-pk-helper-size "152 KB">
<!ENTITY cups-pk-helper-buildsize "3.5 MB">
<!ENTITY cups-pk-helper-time "0.1 SBU">
]>
<sect1 id="cups-pk-helper" xreflabel="cups-pk-helper-&cups-pk-helper-version;" revision="systemd">
<?dbhtml filename="cups-pk-helper.html"?>
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<title>cups-pk-helper-&cups-pk-helper-version;</title>
<indexterm zone="cups-pk-helper">
<primary sortas="a-cups-pk-helper">cups-pk-helper</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to cups-pk-helper</title>
<para>
The <application>cups-pk-helper</application> package contains a
<application>PolicyKit</application> helper used to configure
<application>Cups</application> with fine-grained privileges.
</para>
<!-- &lfs77_checked; -->
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&cups-pk-helper-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&cups-pk-helper-download-ftp;"/>
</para>
</listitem>
<listitem>
<para>
Download MD5 sum: &cups-pk-helper-md5sum;
</para>
</listitem>
<listitem>
<para>
Download size: &cups-pk-helper-size;
</para>
</listitem>
<listitem>
<para>
Estimated disk space required: &cups-pk-helper-buildsize;
</para>
</listitem>
<listitem>
<para>
Estimated build time: &cups-pk-helper-time;
</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">cups-pk-helper Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required">
<xref linkend="polkit"/>
</para>
<para condition="html" role="usernotes">
User Notes: <ulink url="&blfs-wiki;/cups-pk-helper"/>
</para>
</sect2>
<sect2 role="installation">
<title>Installation of cups-pk-helper</title>
<para>
Install <application>cups-pk-helper</application> by running the following
commands:
</para>
<screen><userinput>./configure --prefix=/usr --sysconfdir=/etc &amp;&amp;
make</userinput></screen>
<para>
This package does not come with a test suite.
</para>
<para>
Now, as the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>make install</userinput></screen>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>
cups-pk-helper-mechanism
</seg>
<seg>
None
</seg>
<seg>
None
</seg>
</seglistitem>
</segmentedlist>
</sect2>
</sect1>

View File

@ -11,7 +11,7 @@
<!ENTITY initd-tools-time "less than 0.1 SBU">
]>
<sect1 id="initd-tools" xreflabel="Initd-tools-&initd-tools-version;">
<sect1 id="initd-tools" xreflabel="Initd-tools-&initd-tools-version;" revision="sysv">
<?dbhtml filename="initd-tools.html"?>
<sect1info>

View File

@ -0,0 +1,233 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../../general.ent">
%general-entities;
<!ENTITY ModemManager-download-http "http://www.freedesktop.org/software/ModemManager/ModemManager-&ModemManager-version;.tar.xz">
<!ENTITY ModemManager-download-ftp " ">
<!ENTITY ModemManager-md5sum "1e46a148e2af0e9f503660fcd2d8957d">
<!ENTITY ModemManager-size "1.3 MB">
<!ENTITY ModemManager-buildsize "91 MB">
<!ENTITY ModemManager-time "1.0 SBU (with tests)">
]>
<sect1 id="ModemManager" xreflabel="ModemManager-&ModemManager-version;" revision="systemd">
<?dbhtml filename="ModemManager.html"?>
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<title>ModemManager-&ModemManager-version;</title>
<indexterm zone="ModemManager">
<primary sortas="a-ModemManager">ModemManager</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to ModemManager</title>
<para>
<application>ModemManager</application> provides a unified high level
API for communicating with mobile broadband modems, regardless of the
protocol used to communicate with the actual device.
</para>
<!-- &lfs77_checked; -->
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&ModemManager-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&ModemManager-download-ftp;"/>
</para>
</listitem>
<listitem>
<para>
Download MD5 sum: &ModemManager-md5sum;
</para>
</listitem>
<listitem>
<para>
Download size: &ModemManager-size;
</para>
</listitem>
<listitem>
<para>
Estimated disk space required: &ModemManager-buildsize;
</para>
</listitem>
<listitem>
<para>
Estimated build time: &ModemManager-time;
</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">ModemManager Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required">
<xref linkend="libgudev"/>
</para>
<bridgehead renderas="sect4">Recommended</bridgehead>
<para role="recommended">
<xref linkend="gobject-introspection"/>,
<xref linkend="libmbim"/>,
<xref linkend="libqmi"/>,
<xref linkend="polkit"/>, and
<xref linkend="vala"/>
</para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="gtk-doc"/>
</para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/ModemManager"/>
</para>
</sect2>
<sect2 role="installation">
<title>Installation of ModemManager</title>
<para>
Install <application>ModemManager</application> by running the following
commands:
</para>
<screen><userinput>./configure --prefix=/usr \
--sysconfdir=/etc \
--localstatedir=/var \
--disable-static &amp;&amp;
make</userinput></screen>
<para>
To test the results, issue: <command>make check</command>.
</para>
<para>
Now, as the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>make install</userinput></screen>
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="../../xincludes/static-libraries.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="../../xincludes/gtk-doc-rebuild.xml"/>
</sect2>
<sect2 role="configuration">
<title>Configuring ModemManager</title>
<sect3 id="ModemManager-init">
<title>Systemd Units</title>
<para>
To start the <command>ModemManager</command> daemon at boot, enable
the previously installed systemd unit by running the following command
as the <systemitem class="username">root</systemitem> user:
</para>
<indexterm zone="ModemManager ModemManager-init">
<primary sortas="f-ModemManager">ModemManager</primary>
</indexterm>
<screen role="root"><userinput>systemctl enable ModemManager</userinput></screen>
</sect3>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>
mmcli and ModemManager
</seg>
<seg>
libmm-glib.so
</seg>
<seg>
/usr/include/libmm-glib,
/usr/include/ModemManager,
/usr/lib/ModemManager,
/usr/share/gtk-doc/html/libmm-glib, and
/usr/share/gtk-doc/html/ModemManager
</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="mmcli">
<term><command>mmcli</command></term>
<listitem>
<para>
is an utility used to control and monitor the
<application>ModemManager</application>.
</para>
<indexterm zone="ModemManager mmcli">
<primary sortas="b-mmcli">mmcli</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="ModemManager-prog">
<term><command>ModemManager</command></term>
<listitem>
<para>
is a <application>D-Bus</application> service used
to communicate with modems.
</para>
<indexterm zone="ModemManager ModemManager-prog">
<primary sortas="b-ModemManager">ModemManager</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libmm-glib">
<term><filename class="libraryfile">libmm-glib.so</filename></term>
<listitem>
<para>
contains API functions for communicating with mobile broadband
modems, regardless of the protocol used to communicate with
the actual device.
</para>
<indexterm zone="ModemManager libmm-glib">
<primary sortas="c-libmm-glib">libmm-glib.so</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>

249
general/sysutils/strigi.xml Normal file
View File

@ -0,0 +1,249 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../../general.ent">
%general-entities;
<!ENTITY strigi-download-http "http://www.vandenoever.info/software/strigi/strigi-&strigi-version;.tar.bz2">
<!ENTITY strigi-download-ftp " ">
<!ENTITY strigi-md5sum "d69443234f4286d71997db9de543331a">
<!ENTITY strigi-size "811 KB">
<!ENTITY strigi-buildsize "52 MB">
<!ENTITY strigi-time "1.2 SBU">
]>
<sect1 id="strigi" xreflabel="strigi-&strigi-version;" revision="systemd">
<?dbhtml filename="strigi.html"?>
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<title>Strigi-&strigi-version;</title>
<indexterm zone="strigi">
<primary sortas="a-strigi">strigi</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to Strigi</title>
<para><application>Strigi</application> is a program for fast indexing and
searching of personal data. It can gather and index information from
files in the filesystem even if they are hidden in emails or
archives.</para>
<!-- &lfs78_checked; -->
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>Download (HTTP): <ulink url="&strigi-download-http;"/></para>
</listitem>
<listitem>
<para>Download (FTP): <ulink url="&strigi-download-ftp;"/></para>
</listitem>
<listitem>
<para>Download MD5 sum: &strigi-md5sum;</para>
</listitem>
<listitem>
<para>Download size: &strigi-size;</para>
</listitem>
<listitem>
<para>Estimated disk space required: &strigi-buildsize;</para>
</listitem>
<listitem>
<para>Estimated build time: &strigi-time;</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">Strigi Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required">
<xref linkend="cmake"/>
</para>
<bridgehead renderas="sect4">Recommended</bridgehead>
<para role="recommended">
<xref linkend="dbus"/> and
<xref linkend="qt4"/>
</para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="ffmpeg"/>,
<xref linkend="exiv2"/>,
<xref linkend="libxml2"/>,
<ulink url="http://sourceforge.net/projects/clucene/files/clucene-core-stable/">
CLucene version 0.9x</ulink> , and
<ulink url="http://logging.apache.org/log4cxx/">log4cxx</ulink>
</para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/strigi"/></para>
</sect2>
<sect2 role="installation">
<title>Installation of Strigi</title>
<para>Install <application>strigi</application> by running the following
commands:</para>
<screen><userinput>sed -i "s/BufferedStream :/STREAMS_EXPORT &amp;/" libstreams/include/strigi/bufferedstream.h &amp;&amp;
mkdir build &amp;&amp;
cd build &amp;&amp;
cmake -DCMAKE_INSTALL_PREFIX=/usr \
-DCMAKE_INSTALL_LIBDIR=lib \
-DCMAKE_BUILD_TYPE=Release \
-DENABLE_CLUCENE=OFF \
-DENABLE_CLUCENE_NG=OFF \
.. &amp;&amp;
make</userinput></screen>
<para>To test the results, issue <command>make test</command>.</para>
<para>Now, as the <systemitem class="username">root</systemitem> user:</para>
<screen role="root"><userinput>make install</userinput></screen>
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<para>
<command>sed -i "..."</command>: This command fixes the build with recent
<application>GCC</application> versions.
</para>
<para>
<parameter>-DCMAKE_INSTALL_LIBDIR=lib</parameter>: This switch is used so
the package doesn't write over the lib64 symlink on 64 bit systems.
</para>
<para>
<parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is used to
apply higher level of the compiler optimizations.
</para>
<para>
<option>-DENABLE_QT4=OFF</option>: Use this <command>cmake</command>
variable if you don't have <application>Qt4</application> installed or if
you compiled <application>Qt4</application> without
<application>D-Bus</application> support.
</para>
<para>
<option>-DENABLE_CLUCENE*=OFF</option>: These statements disable the
package from trying to use <xref linkend="clucene"/> (current stable
version).
</para>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>deepfind, deepgrep, rdfindexer, strigiclient, strigicmd,
strigidaemon, and xmlindexer</seg>
<seg>libsearchclient.so, libstreamanalyzer.so, libstreams.so,
libstrigihtmlgui.so, libstrigiqtdbusclient.so, and several in
/usr/lib/strigi</seg>
<seg>/usr/include/strigi, /usr/lib/strigi, and /usr/share/strigi</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="deepfind">
<term><command>deepfind</command></term>
<listitem>
<para>is a utility for searching for filenames in compressed
archives like tar, cpio, and zip</para>
<indexterm zone="strigi deepfind">
<primary sortas="b-deepfind">deepfind</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="deepgrep">
<term><command>deepgrep</command></term>
<listitem>
<para>is a utility for searching compressed archives like
tar, cpio, and zip</para>
<indexterm zone="strigi deepgrep">
<primary sortas="b-deepgrep">deepgrep</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="rdfindexer">
<term><command>rdfindexer</command></term>
<listitem>
<para>manages and performs indexing of the RDF data for entities
present on your site</para>
<indexterm zone="strigi rdfindexer">
<primary sortas="b-rdfindexer">rdfindexer</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="strigiclient">
<term><command>strigiclient</command></term>
<listitem>
<para>is a Qt4 client (GUI) for the Strigi Desktop Search software</para>
<indexterm zone="strigi strigiclient">
<primary sortas="b-strigiclient">strigiclient</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="strigicmd">
<term><command>strigicmd</command></term>
<listitem>
<para>is a program for creating and querying indices</para>
<indexterm zone="strigi strigicmd">
<primary sortas="b-strigicmd">strigicmd</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="strigidaemon">
<term><command>strigidaemon</command></term>
<listitem>
<para>is a daemon program for maintaining indices</para>
<indexterm zone="strigi strigidaemon">
<primary sortas="b-strigidaemon">strigidaemon</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="xmlindexer">
<term><command>xmlindexer</command></term>
<listitem>
<para>indexes XML documents</para>
<indexterm zone="strigi xmlindexer">
<primary sortas="b-xmlindexer">xmlindexer</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>

View File

@ -25,14 +25,25 @@ $Date$
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="bluez.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="colord.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="cpio.xml"/>
<!-- systemd only -->
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="cups-pk-helper.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="dbus.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="fcron.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="gpm.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="hdparm.xml"/>
<!-- sysv only -->
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="initdtools.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="lm_sensors.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="logrotate.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="mc.xml"/>
<!-- systemd only -->
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modemmanager.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="obex-data-server.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="p7zip.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="pax.xml"/>
@ -42,7 +53,10 @@ $Date$
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="rasqal.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="redland.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="sg3_utils.xml"/>
<!-- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="strigi.xml"/> -->
<!-- systemd only -->
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="strigi.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="sysstat.xml"/>
<!-- systemd only -->
@ -54,6 +68,10 @@ $Date$
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="unzip.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="upower.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="usbutils.xml"/>
<!-- systemd only -->
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="weston.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="which.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="zip.xml"/>

391
general/sysutils/weston.xml Normal file
View File

@ -0,0 +1,391 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../../general.ent">
%general-entities;
<!ENTITY weston-download-http "http://wayland.freedesktop.org/releases/weston-&weston-version;.tar.xz">
<!ENTITY weston-download-ftp " ">
<!ENTITY weston-md5sum "24cb8a7ed0535b4fc3642643988dab36">
<!ENTITY weston-size "1.3 MB">
<!ENTITY weston-buildsize "50 MB">
<!ENTITY weston-time "0.3 SBU">
]>
<sect1 id="weston" xreflabel="Weston-&weston-version;" revision="systemd">
<?dbhtml filename="weston.html"?>
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<title>Weston-&weston-version;</title>
<indexterm zone="weston">
<primary sortas="a-Weston">Weston</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to Weston</title>
<para>
<application>Weston</application> is the reference implementation of
a <application>Wayland</application> compositor, and a useful
compositor in its own right. It has various backends that lets it
run on Linux kernel modesetting and evdev input as well as under X11.
<application>Weston</application> also ships with a few example clients,
from simple clients that demonstrate certain aspects of the protocol
to more complete clients and a simplistic toolkit.
</para>
<!-- &lfs77_checked; -->
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&weston-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&weston-download-ftp;"/>
</para>
</listitem>
<listitem>
<para>
Download MD5 sum: &weston-md5sum;
</para>
</listitem>
<listitem>
<para>
Download size: &weston-size;
</para>
</listitem>
<listitem>
<para>
Estimated disk space required: &weston-buildsize;
</para>
</listitem>
<listitem>
<para>
Estimated build time: &weston-time;
</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">Weston Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required">
<xref linkend="cairo"/>,
<xref linkend="libinput"/>,
<xref linkend="libjpeg"/>,
<xref linkend="libxkbcommon"/>,
<xref linkend="mesa"/> (built with
<application>Wayland</application> support),
<xref linkend="mtdev"/> and
<xref linkend="wayland"/>
</para>
<bridgehead renderas="sect4">Recommended</bridgehead>
<para role="recommended">
<xref linkend="glu"/> (to build the screensaver client),
<xref linkend="linux-pam"/> (to build the
<command>weston-launch</command> utility),
<xref linkend="pango"/> (to build some demo clients),
<xref linkend="systemd"/>,
<xref linkend="xorg7-lib"/> (to build the X11
backend and X11 compatibility layer) and
<xref linkend="xorg-server"/> (with Xwayland, runtime
- for X11 backwards compatibility)
</para>
<note>
<para>
The <command>weston-launch</command> utility is required if
you want to run <application>Weston</application> as a
non privileged user.
</para>
</note>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="colord"/>,
<xref linkend="lcms2"/>,
<xref linkend="libva"/> (for H.264 VAAPI video encoding),
<xref linkend="libwebp"/>,
<ulink url="http://www.freerdp.com/">FreeRDP</ulink> and
<ulink url="http://www.nongnu.org/libunwind/">libunwind</ulink>
</para>
<para condition="html" role="usernotes">
User Notes: <ulink url="&blfs-wiki;/weston"/>
</para>
</sect2>
<sect2 role="installation">
<title>Installation of Weston</title>
<para>
Install <application>Weston</application> by running the following
commands:
</para>
<screen><userinput>./configure --prefix=/usr --enable-demo-clients-install &amp;&amp;
make</userinput></screen>
<para>
To test the results, issue: <command>make check</command>.
</para>
<para>
Now, as the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>make install</userinput></screen>
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<para>
<parameter>--enable-demo-clients-install</parameter>: This switch
enables installing of the the demo clients shipped with
<application>Weston</application>.
</para>
<note>
<para>
Consult <command>./configure --help</command> output for switches needed
to prevent <command>configure</command> from looking for some of the
recommended dependencies.
</para>
</note>
</sect2>
<sect2 role="using">
<title>Using Weston</title>
<para>
To start <application>Weston</application> as an X11 client,
from an X terminal, run the following command:
</para>
<screen><userinput>weston</userinput></screen>
<para>
To run it as a DRM compositor, from a TTY, while logged
in as a normal user, run the following command:
</para>
<screen><userinput>weston-launch</userinput></screen>
<para>
Note that <command>weston-launch</command> is a wrapper for
<command>weston</command>. If you need to pass a parameter
to <command>weston</command> while using
<command>weston-launch</command>, use the following syntax:
</para>
<screen><userinput>weston-launch -- --backend=fbdev-backend.so</userinput></screen>
<para>
Note the -- between the <command>weston-launch</command> and
the <command>weston</command> parameter
<parameter>--backend=fbdev-backend.so</parameter>. For list
of parameters that you can pass to <command>weston</command>,
consult the <command>weston(1)</command> manual page.
</para>
<para>
To terminate <application>Weston</application> when running
as a DRM compositor, use the CTRL+ALT+Backspace
combination on your keyboard.
</para>
<para>
Note that the default backend, DRM, will only run if a
KMS driver is present on the system. It will not run in
a virtual machine such as VBox or Qemu and on NVidia or
AMD hardware with proprietary drivers. On these setups
it would be possible to use the FBDEV backend by running
the command described above.
</para>
<para>
Also note that X11 backend requires working EGL stack.
If you are running hardware that has no 3D support or
no EGL stack, you can't run accelerated applications
inside <application>Weston</application>. Latest
proprietary NVidia driver has the necessary EGL
stack needed to run <application>Weston</application>
as an X11 client, but it is not officially supported.
</para>
</sect2>
<sect2 role="configuration">
<title>Configuring Weston</title>
<sect3 id="weston-config">
<title>Config Files</title>
<para>
<filename>~/.config/weston.ini</filename>
</para>
<indexterm zone="weston weston-config">
<primary sortas="e-AA.config-weston.ini">~/.config/weston.ini</primary>
</indexterm>
</sect3>
<sect3>
<title>Configuration Information</title>
<para>
<application>Weston</application> configuration file can be
used to configure which modules will be loaded, keyboard
layout, display resolution, touchpad behaviour, desktop shell
appearance, etc.
</para>
<para>
To change the keyboard layout inside <application>Weston</application>,
add the following to your config file:
</para>
<screen><literal>[keyboard]
keymap_model=pc105
keymap_layout=de
keymap_variant=euro
keymap_options=grp:alt_shift_toggle</literal></screen>
<para>
For explanation about each of the mentioned options,
consult the <command>xkeyboard-config(7)</command>
manual page.
</para>
<para>
To change the resolution of the compositor,
add the following to your config file:
</para>
<screen><literal>[output]
name=LVDS1
mode=1366x768</literal></screen>
<para>
The name can be one of the following:
</para>
<itemizedlist spacing="compact">
<listitem>
<para>
DRM backend: LVDS1 (Laptop internal panel no.1)
</para>
</listitem>
<listitem>
<para>
DRM backend: VGA1 (VGA connector no.1)
</para>
</listitem>
<listitem>
<para>
X11 backend: X1 (X window no.1)
</para>
</listitem>
<listitem>
<para>
Wayland backend: WL1 (Wayland window no.1)
</para>
</listitem>
</itemizedlist>
<para>
For more information consult the
<command>weston-drm(7)</command> manual page.
</para>
<para>
To load a <application>Weston</application> module or a shell
backend, add the following to your config file:
</para>
<screen><literal>[core]
modules=xwayland.so
shell=desktop-shell.so</literal></screen>
<para>
Note that you need to load the <filename>xwayland.so</filename>
if you want to use X11 clients inside
<application>Weston</application>.
</para>
<para>
For a detailed list of configuration directives, consult the
<command>weston.ini(5)</command> manual page or examine the
<filename>weston.ini</filename> file inside the
<application>Weston</application> source directory.
</para>
</sect3>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>
wcap-decode, weston, weston-calibrator, weston-clickdot,
weston-cliptest, weston-dnd, weston-editor, weston-eventdemo,
weston-flower, weston-fullscreen, weston-image,
weston-info, weston-launch, weston-multi-resource,
weston-presentation-shm, weston-resizor, weston-scaler,
weston-simple-damage, weston-simple-egl, weston-simple-shm,
weston-simple-touch, weston-smoke, weston-stacking,
weston-subsurfaces, weston-terminal and weston-transformed
</seg>
<seg>
None
</seg>
<seg>
/usr/include/weston,
/usr/lib/weston,
/usr/share/wayland-sessions and
/usr/share/weston
</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="weston-prog">
<term><command>weston</command></term>
<listitem>
<para>
is the reference implementation of a Wayland server.
</para>
<indexterm zone="weston weston-prog">
<primary sortas="b-weston">weston</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>

View File

@ -233,6 +233,7 @@
<!ENTITY bluez-version "5.40">
<!ENTITY colord-version "1.2.12"> <!-- Even minors only -->
<!ENTITY cpio-version "2.12">
<!ENTITY cups-pk-helper-version "0.2.5">
<!ENTITY dbus-version "1.10.8"> <!-- Even minors only -->
<!ENTITY eudev-version "1.7">
<!ENTITY fcron-version "3.2.0">
@ -242,6 +243,7 @@
<!ENTITY lm_sensors-version "3.4.0">
<!ENTITY logrotate-version "3.9.1">
<!ENTITY mc-version "4.8.17">
<!ENTITY ModemManager-version "1.4.10">
<!ENTITY obex-data-server-version "0.4.6">
<!ENTITY p7zip-version "15.14.1">
<!ENTITY pax-version "070715">
@ -260,6 +262,7 @@
<!ENTITY unzip-version "6.0">
<!ENTITY upower-version "0.99.4">
<!ENTITY usbutils-version "008">
<!ENTITY weston-version "1.8.0">
<!ENTITY which-version "2.21">
<!ENTITY zip-version "3.0">