source: x/installing/xorg-server.xml@ e26871f

12.0 12.1 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since e26871f was 14891a90, checked in by Xi Ruoyao <xry111@…>, 12 months ago

treewide: More "User Notes" clean up

Remove links to pages w/o real contents.
  • Property mode set to 100644
File size: 9.5 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY xorg-server-download-http "&xorg-download-http;/xserver/xorg-server-&xorg-server-version;.tar.xz">
8 <!ENTITY xorg-server-download-ftp "&xorg-download-ftp;/xserver/xorg-server-&xorg-server-version;.tar.xz">
9 <!ENTITY xorg-server-md5sum "79a6eb04b1b17ad6c7aab46da73944e8">
10 <!ENTITY xorg-server-size "4.8 MB">
11 <!ENTITY xorg-server-buildsize "188 MB (with tests)">
12 <!ENTITY xorg-server-time "0.6 SBU (using parallelism=4; with tests)">
13]>
14
15<sect1 id="xorg-server" xreflabel="Xorg-Server-&xorg-server-version;">
16 <?dbhtml filename="xorg-server.html"?>
17
18
19 <title>Xorg-Server-&xorg-server-version;</title>
20
21 <indexterm zone="xorg-server">
22 <primary sortas="a-xorg-server">xorg-server</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to Xorg Server</title>
27
28 <para>
29 The <application>Xorg</application> Server is the core
30 of the X Window system.
31 </para>
32
33 &lfs113_checked;
34
35 <bridgehead renderas="sect3">Package Information</bridgehead>
36 <itemizedlist spacing="compact">
37 <listitem>
38 <para>
39 Download (HTTP): <ulink url="&xorg-server-download-http;"/>
40 </para>
41 </listitem>
42 <listitem>
43 <para>
44 Download (FTP): <ulink url="&xorg-server-download-ftp;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download MD5 sum: &xorg-server-md5sum;
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download size: &xorg-server-size;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Estimated disk space required: &xorg-server-buildsize;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated build time: &xorg-server-time;
65 </para>
66 </listitem>
67 </itemizedlist>
68
69 <bridgehead renderas="sect3">Xorg Server Dependencies</bridgehead>
70
71 <bridgehead renderas="sect4">Required</bridgehead>
72 <para role="required">
73 <xref linkend="libxcvt"/>,
74 <xref linkend="pixman"/>,
75 <xref linkend="xorg7-font"/> (only font-util), and at runtime:
76 <xref role="runtime" linkend="xkeyboard-config"/>
77 </para>
78
79 <bridgehead renderas="sect4">Recommended</bridgehead>
80 <para role="recommended">
81 <phrase revision="sysv"><xref role="runtime"
82 linkend="elogind"/> (runtime),</phrase>
83 <xref linkend="libepoxy"/> (needed for glamor),
84 <xref linkend="libtirpc"/>,
85 <phrase revision="systemd"><xref role="runtime"
86 linkend="systemd"/> (runtime),</phrase>
87 and <xref role='runtime' linkend='xorg-libinput-driver'/> (runtime)
88 </para>
89
90 <bridgehead renderas="sect4">Optional</bridgehead>
91 <para role="optional">
92 <xref role="runtime" linkend="acpid"/> (runtime),
93 <xref linkend="doxygen"/> (to build API documentation),
94 <xref linkend="fop"/> (to build documentation),
95 <xref linkend="libunwind"/>,
96 <xref linkend="nettle"/>,
97 <xref linkend="libgcrypt"/>,
98 <xref linkend="xcb-util-keysyms"/>,
99 <xref linkend="xcb-util-image"/>,
100 <xref linkend="xcb-util-renderutil"/>,
101 <xref linkend="xcb-util-wm"/> (all four to build Xephyr),
102 <xref linkend="xmlto"/> (to build documentation),
103 <xref linkend="xkeyboard-config"/> (for tests),
104 <ulink url="https://gitlab.freedesktop.org/xorg/test/rendercheck">rendercheck</ulink> (for tests), and
105 <ulink url="https://www.x.org/archive/individual/doc/">xorg-sgml-doctools</ulink> (to build documentation)
106 </para>
107
108 </sect2>
109
110 <sect2 role="installation">
111 <title>Installation of Xorg Server</title>
112
113 <para>
114 Install the server by running the following commands:
115 </para>
116
117<screen><userinput>mkdir build &amp;&amp;
118cd build &amp;&amp;
119
120meson setup .. \
121 --prefix=$XORG_PREFIX \
122 --localstatedir=/var \
123 -Dsuid_wrapper=true \
124 -Dxkb_output_dir=/var/lib/xkb &amp;&amp;
125ninja</userinput></screen>
126
127 <para>
128 To test the results, issue: <command>ninja test</command>. You
129 will need to run <command>ldconfig</command> as the <systemitem
130 class="username">root</systemitem> user first or some tests may fail.
131 </para>
132
133 <para>
134 Now as the <systemitem class="username">root</systemitem>
135 user:
136 </para>
137
138<screen role="root" revision="sysv"><userinput>ninja install &amp;&amp;
139mkdir -pv /etc/X11/xorg.conf.d &amp;&amp;
140cat &gt;&gt; /etc/sysconfig/createfiles &lt;&lt; "EOF"
141<literal>/tmp/.ICE-unix dir 1777 root root
142/tmp/.X11-unix dir 1777 root root</literal>
143EOF</userinput></screen>
144
145<screen role="root" revision="systemd"><userinput>ninja install &amp;&amp;
146mkdir -pv /etc/X11/xorg.conf.d</userinput></screen>
147
148 </sect2>
149
150 <sect2 role="commands">
151 <title>Command Explanations</title>
152
153 <para>
154 <parameter>-Dsuid_wrapper=true</parameter>: Builds the suid-root
155 wrapper for legacy driver support on rootless xserver systems.
156 </para>
157
158 <para>
159 <option>-Dsystemd_logind=false</option>:
160 This switch disables <phrase revision="systemd">systemd-logind</phrase>
161 <phrase revision="sysv">elogind</phrase> integration, allowing Xorg Server
162 to work without having the <phrase revision="systemd">systemd</phrase>
163 <phrase revision="elogind">elogind</phrase> PAM module configured.
164 </para>
165
166 <para revision="sysv">
167 <command>cat &gt;&gt; /etc/sysconfig/createfiles...</command>: This
168 command creates the <filename class="directory">/tmp/.ICE-unix</filename>
169 and <filename class="directory">/tmp/.X11-unix</filename> directories at
170 startup, and ensures that the permissions and ownership are correct as
171 required by the server.
172 </para>
173
174 <para>
175 <option>-Dxephyr=true</option>: This option allows building Xephyr if its
176 dependencies are met.
177 </para>
178
179 </sect2>
180
181 <sect2 role="content">
182 <title>Contents</title>
183
184 <segmentedlist>
185 <segtitle>Installed Programs</segtitle>
186 <segtitle>Installed Libraries</segtitle>
187 <segtitle>Installed Directories</segtitle>
188
189 <seglistitem>
190 <seg>
191 gtf, X, Xnest, Xorg, Xvfb, and optionally Xephyr
192 </seg>
193 <seg>
194 several under $XORG_PREFIX/lib/xorg/modules/ including the
195 <filename class="libraryfile">modesetting_drv.so</filename>
196 driver
197 </seg>
198 <seg>
199 /etc/X11/xorg.conf.d,
200 $XORG_PREFIX/include/xorg,
201 $XORG_PREFIX/lib/xorg, and
202 $XORG_PREFIX/share/X11/xorg.conf.d
203 </seg>
204
205 </seglistitem>
206 </segmentedlist>
207
208 <variablelist>
209 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
210 <?dbfo list-presentation="list"?>
211 <?dbhtml list-presentation="table"?>
212
213 <varlistentry id="gtf-x7">
214 <term><command>gtf</command></term>
215 <listitem>
216 <para>
217 calculates VESA GTF mode lines
218 </para>
219 <indexterm zone="xorg-server gtf-x7">
220 <primary sortas="b-gtf">gtf</primary>
221 </indexterm>
222 </listitem>
223 </varlistentry>
224
225 <varlistentry id="X-x7">
226 <term><command>X</command></term>
227 <listitem>
228 <para>
229 is a symbolic link to Xorg
230 </para>
231 <indexterm zone="xorg-server X-x7">
232 <primary sortas="b-X">X</primary>
233 </indexterm>
234 </listitem>
235 </varlistentry>
236
237 <varlistentry id="Xephyr-x7">
238 <term><command>Xephyr</command></term>
239 <listitem>
240 <para>
241 is a nested X server which supports modern X extensions
242 </para>
243 <indexterm zone="xorg-server Xephyr-x7">
244 <primary sortas="b-Xephyr">Xephyr</primary>
245 </indexterm>
246 </listitem>
247 </varlistentry>
248
249 <varlistentry id="Xnest-x7">
250 <term><command>Xnest</command></term>
251 <listitem>
252 <para>
253 is a nested X server
254 </para>
255 <indexterm zone="xorg-server Xnest-x7">
256 <primary sortas="b-Xnest">Xnest</primary>
257 </indexterm>
258 </listitem>
259 </varlistentry>
260
261 <varlistentry id="Xorg-x7">
262 <term><command>Xorg</command></term>
263 <listitem>
264 <para>
265 is the X11R7 X Server
266 </para>
267 <indexterm zone="xorg-server Xorg-x7">
268 <primary sortas="b-Xorg">Xorg</primary>
269 </indexterm>
270 </listitem>
271 </varlistentry>
272
273 <varlistentry id="Xvfb-x7">
274 <term><command>Xvfb</command></term>
275 <listitem>
276 <para>
277 is the virtual framebuffer X server for X Version 11
278 </para>
279 <indexterm zone="xorg-server Xvfb-x7">
280 <primary sortas="b-Xvfb">Xvfb</primary>
281 </indexterm>
282 </listitem>
283 </varlistentry>
284
285 <varlistentry id="modesetting_drv-x7">
286 <term><filename class="libraryfile">modesetting_drv.so</filename></term>
287 <listitem>
288 <para>
289 provides a video driver for machines using Kernel Mode Setting (KMS).
290 This will use glamor if that has been enabled and the hardware offers
291 acceleration
292 </para>
293 <indexterm zone="xorg-server modesetting_drv-x7">
294 <primary sortas="c-modesetting_drv">modesetting_drv.so</primary>
295 </indexterm>
296 </listitem>
297 </varlistentry>
298
299 </variablelist>
300
301 </sect2>
302
303</sect1>
Note: See TracBrowser for help on using the repository browser.