linux-from-scratch/glfs
1
0
Fork 0
mirror of https://github.com/Zeckmathederg/glfs.git synced 2025-02-03 14:47:17 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Added the 'User Notes' wiki link to each package page; changed all instances of .[so,a] to .{so,a} (brackets changed to braces); changed all replaceable tags to use angle brackets instead of square brackets to encapsulate the text - commit #10

Browse Source 
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@5838 af4574ff-66df-0310-9fd7-8a98e5e911e0
This commit is contained in:
Randy McMurchy 2006-04-10 18:39:30 +00:00
parent 3cb0c57714
commit c5c26547cd
23 changed files with 101 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
x/installing/x-setup.xml
View File

@ -144,9 +144,9 @@ EndSection</literal></screen>
replacing the "iso8859-1" string with the proper encoding name. This is
accomplished by running the following command as the <systemitem
class="username">root</systemitem> user, substituting the proper value
for <replaceable>[X]</replaceable>:</para>
for <replaceable>&lt;X&gt;</replaceable>:</para>
<screen role="root"><userinput>sed -i 's,iso8859-1\( \|$\),iso8859-<replaceable>[X]</replaceable>\1,g' \
<screen role="root"><userinput>sed -i 's,iso8859-1\( \|$\),iso8859-<replaceable>&lt;X&gt;</replaceable>\1,g' \
/usr/lib/X11/fonts/{75dpi,100dpi,misc}/fonts.alias</userinput></screen>
<para>Users of Cyrillic fonts have properly defined aliases in

2
x/installing/xorg.xml
View File

@ -215,7 +215,7 @@ sed -i "s@*/@*/\n#include &lt;linux/types.h&gt;\n@" \
needs another correction to fix a hard coded path. Execute the
following command:</para>
<screen><userinput>sed -i 's@/usr/X11R6@<replaceable>[/usr]</replaceable>@' programs/luit/parser.h</userinput></screen>
<screen><userinput>sed -i 's@/usr/X11R6@<replaceable>&lt;/usr&gt;</replaceable>@' programs/luit/parser.h</userinput></screen>
</sect3>

6
x/installing/xorg7.xml
View File

@ -143,7 +143,7 @@ cd xc</userinput></screen>
<envar>XORG_PREFIX</envar> variable with the following
command:</para>
<screen><userinput>export XORG_PREFIX="<replaceable>[/usr]</replaceable>"</userinput></screen>
<screen><userinput>export XORG_PREFIX="<replaceable>&lt;/usr&gt;</replaceable>"</userinput></screen>
<para>Throughout these instructions, you will use the same three
<command>configure</command> switches for all of the packages. Create the
@ -153,7 +153,7 @@ cd xc</userinput></screen>
<note>
<para>If you've decided to use an alternate prefix, be sure to add
<filename class="directory"><replaceable>[/usr]</replaceable>/lib/pkgconfig</filename>
<filename class="directory"><replaceable>&lt;/usr&gt;</replaceable>/lib/pkgconfig</filename>
to your <envar>PKG_CONFIG_PATH</envar> variable.</para>
</note>
@ -535,7 +535,7 @@ ln -svn $XORG_PREFIX/lib/X11/fonts/TTF /usr/share/fonts/X11-TTF</userinput></scr
<para>Install the server by running the following commands:</para>
<screen><userinput>./configure $XORG_CONFIG \
--with-mesa-source='<replaceable>[/path/to]</replaceable>/Mesa-&mesalib-version;' \
--with-mesa-source='<replaceable>&lt;/path/to&gt;</replaceable>/Mesa-&mesalib-version;' \
--with-fontdir=$XORG_PREFIX/lib/X11/fonts \
--with-module-dir=$XORG_PREFIX/lib/X11/modules &amp;&amp;
make</userinput></screen>

3
x/lib/atk.xml
View File

@ -68,6 +68,9 @@
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional"><xref linkend="gtk-doc"/></para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/atk"/></para>
</sect2>
<sect2 role="installation">

9
x/lib/cairo.xml
View File

@ -81,6 +81,9 @@
<ulink url="http://xcb.freedesktop.org/wiki/">XCB</ulink>, and
<xref linkend="gtk-doc"/></para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/cairo"/></para>
</sect2>
<sect2 role="installation">
@ -133,7 +136,7 @@ make</userinput></screen>
<seglistitem>
<seg>None</seg>
<seg>libcairo.[so,a]</seg>
<seg>libcairo.{so,a}</seg>
<seg>/usr/include/cairo and /usr/share/gtk-doc/html/cairo</seg>
</seglistitem>
</segmentedlist>
@ -144,12 +147,12 @@ make</userinput></screen>
<?dbhtml list-presentation="table"?>
<varlistentry id="libcairo">
<term><filename class='libraryfile'>libcairo.[so,a]</filename></term>
<term><filename class='libraryfile'>libcairo.{so,a}</filename></term>
<listitem>
<para>contains the 2D graphics functions required for rendering to
the various output targets.</para>
<indexterm zone="cairo libcairo">
<primary sortas="c-libcairo">libcairo.[so,a]</primary>
<primary sortas="c-libcairo">libcairo.{so,a}</primary>
</indexterm>
</listitem>
</varlistentry>

7
x/lib/freeglut.xml
View File

@ -66,6 +66,9 @@
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required"><xref linkend="x-window-system"/></para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/freeglut"/></para>
</sect2>
<sect2 role="installation">
@ -109,12 +112,12 @@ install -v -m644 doc/freeglut_user_interface.html \
<?dbhtml list-presentation="table"?>
<varlistentry id="libglut">
<term><filename class='libraryfile'>libglut.[so,a]</filename></term>
<term><filename class='libraryfile'>libglut.{so,a}</filename></term>
<listitem>
<para>contains functions that implement the OpenGL Utility
Toolkit.</para>
<indexterm zone="freeglut libglut">
<primary sortas="c-libglut">libglut.[so,a]</primary>
<primary sortas="c-libglut">libglut.{so,a}</primary>
</indexterm>
</listitem>
</varlistentry>

5
x/lib/goffice.xml
View File

@ -89,6 +89,9 @@
to support GNOME by creating the
<filename class='libraryfile'>libgsf-gnome-1</filename> library)</para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/goffice"/></para>
</sect2>
<sect2 role="installation">
@ -121,7 +124,7 @@ make</userinput></screen>
<seg>libgoffice-1.so and numerous support plugins</seg>
<seg>/usr/include/libgoffice-1,
/usr/lib/goffice,
/usr/share/[,pixmaps/]goffice</seg>
/usr/share/{,pixmaps/}goffice</seg>
</seglistitem>
</segmentedlist>

13
x/lib/gtk+.xml
View File

@ -66,6 +66,9 @@
<xref linkend="libjpeg"/>, and
<xref linkend="x-window-system"/></para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/gtk+"/></para>
</sect2>
<sect2 role="installation">
@ -110,7 +113,7 @@ install -v -m644 docs/text/* /usr/share/doc/gtk+-&GTK-version;/text</userinput><
<seglistitem>
<seg>gtk-config</seg>
<seg>libgdk.[so,a] and libgtk.[so,a]</seg>
<seg>libgdk.{so,a} and libgtk.{so,a}</seg>
<seg>/etc/gtk, /usr/include/gtk-1.2, and /usr/share/themes</seg>
</seglistitem>
</segmentedlist>
@ -134,25 +137,25 @@ install -v -m644 docs/text/* /usr/share/doc/gtk+-&GTK-version;/text</userinput><
</varlistentry>
<varlistentry id="libgtk">
<term><filename class='libraryfile'>libgtk.[so,a]</filename></term>
<term><filename class='libraryfile'>libgtk.{so,a}</filename></term>
<listitem>
<para>(GIMP Tool Kit) is a library for creating graphical user
interfaces similar to the Motif <quote>look and feel</quote>.</para>
<indexterm zone="GTK libgtk">
<primary sortas="c-libgtk">libgtk.[so,a]</primary>
<primary sortas="c-libgtk">libgtk.{so,a}</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libgdk">
<term><filename class='libraryfile'>libgdk.[so,a]</filename></term>
<term><filename class='libraryfile'>libgdk.{so,a}</filename></term>
<listitem>
<para>is designed as a wrapper library that lies on top of Xlib.
It performs many common and desired operations for a programmer
instead of the programmer having to explicitly ask for such
functionality from Xlib directly.</para>
<indexterm zone="GTK libgdk">
<primary sortas="c-libgdk">libgdk.[so,a]</primary>
<primary sortas="c-libgdk">libgdk.{so,a}</primary>
</indexterm>
</listitem>
</varlistentry>

5
x/lib/gtk+2.xml
View File

@ -80,6 +80,9 @@
<para role="optional"><xref linkend="gtk-doc"/> and
<xref linkend="docbook-utils"/></para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/gtk+2"/></para>
</sect2>
<sect2 role="installation">
@ -136,7 +139,7 @@ cp -v -R docs/tutorial/html/* /usr/share/doc/gtk+-&gtk2-version;/tutorial</useri
loader plugins</seg>
<seg>/etc/gtk-2.0, /usr/include/gtk-2.0, /usr/lib/gtk-2.0,
/usr/share/doc/gtk+-&gtk2-version;, /usr/share/gtk-2.0,
/usr/share/gtk-doc/html/[gdk,gdk-pixbuf,gtk],
/usr/share/gtk-doc/html/{gdk,gdk-pixbuf,gtk},
/usr/share/themes/Default/gtk*, /usr/share/themes/Emacs and
/usr/share/themes/Raleigh</seg>
</seglistitem>

3
x/lib/hicolor-icon-theme.xml
View File

@ -60,6 +60,9 @@ xreflabel="hicolor-icon-theme-&hicolor-icon-theme-version;">
</listitem>
</itemizedlist>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/hicolor-icon-theme"/></para>
</sect2>
<sect2 role="installation">

3
x/lib/lesstif.xml
View File

@ -76,6 +76,9 @@
(used to generate the <filename>INSTALL</filename> documentation file) and
<ulink url="http://dmalloc.com">Dmalloc</ulink></para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/lesstif"/></para>
</sect2>
<sect2 role="installation">

9
x/lib/libdrm.xml
View File

@ -59,6 +59,9 @@
</listitem>
</itemizedlist>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/libdrm"/></para>
</sect2>
<sect2 role="installation">
@ -91,7 +94,7 @@ make</userinput></screen>
<segtitle>Installed Libraries</segtitle>
<seglistitem>
<seg>libdrm.[so,a]</seg>
<seg>libdrm.{so,a}</seg>
</seglistitem>
</segmentedlist>
@ -101,11 +104,11 @@ make</userinput></screen>
<?dbhtml list-presentation="table"?>
<varlistentry id="libdrm-lib">
<term><filename class='libraryfile'>libdrm.[so,a]</filename></term>
<term><filename class='libraryfile'>libdrm.{so,a}</filename></term>
<listitem>
<para>contains the Direct Rendering Module library functions.</para>
<indexterm zone="libdrm libdrm-lib">
<primary sortas="c-libdrm">libdrm.[so,a]</primary>
<primary sortas="c-libdrm">libdrm.{so,a}</primary>
</indexterm>
</listitem>
</varlistentry>

9
x/lib/libwnck.xml
View File

@ -68,6 +68,9 @@
<para role="optional"><xref linkend="startup-notification"/> and
<xref linkend="gtk-doc"/></para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/libwnck"/></para>
</sect2>
<sect2 role="installation">
@ -97,7 +100,7 @@ make</userinput></screen>
<seglistitem>
<seg>None</seg>
<seg>libwnck-1.[so,a]</seg>
<seg>libwnck-1.{so,a}</seg>
<seg>/usr/include/libwnck-1.0 and
/usr/share/gtk-doc/html/libwnck</seg>
</seglistitem>
@ -109,11 +112,11 @@ make</userinput></screen>
<?dbhtml list-presentation="table"?>
<varlistentry id="libwnck-1">
<term><filename class='libraryfile'>libwnck-1.[so,a]</filename></term>
<term><filename class='libraryfile'>libwnck-1.{so,a}</filename></term>
<listitem>
<para>contains functions for writing pagers and task lists.</para>
<indexterm zone="libwnck libwnck-1">
<primary sortas="c-libwnck-1">libwnck-1.[so,a]</primary>
<primary sortas="c-libwnck-1">libwnck-1.{so,a}</primary>
</indexterm>
</listitem>
</varlistentry>

9
x/lib/libxklavier.xml
View File

@ -68,6 +68,9 @@
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional"><xref linkend="doxygen"/></para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/libxklavier"/></para>
</sect2>
<sect2 role="installation">
@ -95,7 +98,7 @@ make</userinput></screen>
<seglistitem>
<seg>None</seg>
<seg>libxklavier.[so,a]</seg>
<seg>libxklavier.{so,a}</seg>
<seg>/usr/include/libxklavier, and /usr/share/libxklavier</seg>
</seglistitem>
</segmentedlist>
@ -106,11 +109,11 @@ make</userinput></screen>
<?dbhtml list-presentation="table"?>
<varlistentry id="libxklavier-lib">
<term><filename class='libraryfile'>libxklavier.[so,a]</filename></term>
<term><filename class='libraryfile'>libxklavier.{so,a}</filename></term>
<listitem>
<para>contains XKB utility functions.</para>
<indexterm zone="libxklavier libxklavier-lib">
<primary sortas="c-libxklavier">libxklavier.[so,a]</primary>
<primary sortas="c-libxklavier">libxklavier.{so,a}</primary>
</indexterm>
</listitem>
</varlistentry>

7
x/lib/mesalib.xml
View File

@ -85,6 +85,9 @@
directory.</para>
</note>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/mesalib"/></para>
</sect2>
<sect2 role="installation">
@ -135,7 +138,7 @@ make PROGS='glxinfo glxgears'</userinput></screen>
Execute the following command as the
<systemitem class="username">root</systemitem> user:</para>
<screen><userinput role="root">ln -s -v <replaceable>[/usr/X11]</replaceable>/include/GL /usr/include</userinput></screen>
<screen><userinput role="root">ln -s -v <replaceable>&lt;/usr/X11&gt;</replaceable>/include/GL /usr/include</userinput></screen>
</sect2>
@ -178,7 +181,7 @@ make PROGS='glxinfo glxgears'</userinput></screen>
<seglistitem>
<seg>glxgears and glxinfo</seg>
<seg>libGL.[so,a], libGLU.[so,a], libGLw.[so,a], libglut.[so,a] and
<seg>libGL.{so,a}, libGLU.{so,a}, libGLw.{so,a}, libglut.{so,a} and
*_dri.so</seg>
<seg>$XORG_PREFIX/lib/modules/dri</seg>
</seglistitem>

3
x/lib/pango.xml
View File

@ -80,6 +80,9 @@
<bridgehead renderas="sect4">Optional (To Rebuild the API Documentation)</bridgehead>
<para role="optional"><xref linkend="gtk-doc"/></para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/pango"/></para>
</sect2>
<sect2 role="installation">

10
x/lib/qt.xml
View File

@ -75,8 +75,8 @@
<para>Note: if for whatever reason you do not have the recommended
libraries installed on your system, you must remove the corresponding
<parameter>-system-<replaceable>[library]</replaceable></parameter> and
<parameter>-plugin-imgfmt-<replaceable>[library]</replaceable></parameter>
<parameter>-system-<replaceable>&lt;library&gt;</replaceable></parameter> and
<parameter>-plugin-imgfmt-<replaceable>&lt;library&gt;</replaceable></parameter>
parameters from the <command>configure</command> commands shown in the
instructions below.</para>
@ -252,9 +252,9 @@ cp -v -r examples /opt/qt/doc</userinput></screen>
<note>
<para>If you pass the
<option>-plugin-sql-<replaceable>[driver]</replaceable></option>
<option>-plugin-sql-<replaceable>&lt;driver&gt;</replaceable></option>
switch to the <command>configure</command> command, you must also pass
<option>-I<replaceable>[/path/to/sql/headers]</replaceable></option>
<option>-I<replaceable>&lt;/path/to/sql/headers&gt;</replaceable></option>
so <command>make</command> can find the appropriate header files.</para>
</note>
@ -366,7 +366,7 @@ ldconfig &amp;&amp;
cat &gt;&gt; /etc/man_db.conf &lt;&lt; "EOF"
<literal># Begin qt addition to man_db.conf
MANPATH /opt/qt/doc/man
MANDATORY_MANPATH /opt/qt/doc/man
# End qt addition to man_db.conf</literal>
EOF</userinput></screen>

3
x/lib/shared-mime-info.xml
View File

@ -67,6 +67,9 @@ xreflabel="shared-mime-info-&shared-mime-info-version;">
<xref linkend="libxml2"/>, and
<xref linkend="perl-xml-parser"/></para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/shared-mime-info"/></para>
</sect2>
<sect2 role="installation">

9
x/lib/startup-notification.xml
View File

@ -66,6 +66,9 @@ xreflabel="startup-notification-&startup-notification-version;">
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required"><xref linkend="x-window-system"/></para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/startup-notification"/></para>
</sect2>
<sect2 role="installation">
@ -95,7 +98,7 @@ install -v -m644 -D doc/startup-notification.txt \
<seglistitem>
<seg>None</seg>
<seg>libstartup-notification-1.[so,a]</seg>
<seg>libstartup-notification-1.{so,a}</seg>
<seg>/usr/include/startup-notification-1.0 and
/usr/share/doc/startup-notification-&startup-notification-version;</seg>
</seglistitem>
@ -107,13 +110,13 @@ install -v -m644 -D doc/startup-notification.txt \
<?dbhtml list-presentation="table"?>
<varlistentry id="libstartup-notification">
<term><filename class='libraryfile'>libstartup-notification-1.[so,a]</filename></term>
<term><filename class='libraryfile'>libstartup-notification-1.{so,a}</filename></term>
<listitem>
<para>provides the functions to assist applications in communicating
with the cursor system to provide feedback to the user that the
application is loading.</para>
<indexterm zone="startup-notification libstartup-notification">
<primary sortas="c-libstartup-notification">libstartup-notification-1.[so,a]</primary>
<primary sortas="c-libstartup-notification">libstartup-notification-1.{so,a}</primary>
</indexterm>
</listitem>
</varlistentry>

5
x/wm/fluxbox.xml
View File

@ -66,6 +66,9 @@
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional"><xref linkend="imlib2"/> Image display library</para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/fluxbox"/></para>
</sect2>
<sect2 role="installation">
@ -171,7 +174,7 @@ fluxbox-generate_menu</userinput></screen>
<para>If you want to use an image as your desktop background, copy the
theme you like into <filename class='directory'>~/.fluxbox</filename>.
Then add a line to make it use the correct image. In the following command,
change <replaceable>[theme]</replaceable> for the name of the theme you
change <replaceable>&lt;theme&gt;</replaceable> for the name of the theme you
want and change <replaceable>/path/to/nice/image.xpm</replaceable> to
reflect the actual image you want to use.</para>

9
x/wm/metacity.xml
View File

@ -77,6 +77,9 @@
must enable explicitly to get it. And it doesn't work, so don't bother
unless you want to hack on it...</quote></para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/metacity"/></para>
</sect2>
<sect2 role="installation">
@ -159,14 +162,14 @@ EOF</userinput></screen>
<seglistitem>
<seg>metacity, metacity-message, metacity-theme-viewer
and metacity-window-demo</seg>
<seg>libmetacity-private.[so,a]</seg>
<seg>&gnome-etc-dir;/gconf/gconf.xml.defaults[,/schemas]/apps/metacity,
<seg>libmetacity-private.{so,a}</seg>
<seg>&gnome-etc-dir;/gconf/gconf.xml.defaults{,/schemas}/apps/metacity,
/usr/include/metacity-1,
/usr/lib/metacity,
/usr/share/doc/metacity-&metacity-version;,
/usr/share/gnome/wm-properties,
/usr/share/metacity and
/usr/share/themes/[AgingGorilla,Atlanta,Bright,Crux,Esco,Metabox,Simple]/metacity-1</seg>
/usr/share/themes/{AgingGorilla,Atlanta,Bright,Crux,Esco,Metabox,Simple}/metacity-1</seg>
</seglistitem>
</segmentedlist>

3
x/wm/sawfish.xml
View File

@ -66,6 +66,9 @@
<para role="required"><xref linkend="rep-gtk"/> and
<xref linkend="esound"/></para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/sawfish"/></para>
</sect2>
<sect2 role="installation">

9
x/wm/xfce.xml
View File

@ -71,6 +71,9 @@
<xref linkend="startup-notification"/> and <xref linkend="a2ps"/> (required to build
<application>xfprint</application>).</para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/xfce"/></para>
</sect2>
<sect2 role="installation">
@ -256,10 +259,10 @@ EOF</userinput></screen>
xflock4, xfmime-edit, xfmountdev4, xfrecent, xfrecent4,
xfprint-manager, xfprint4, xfrun4, xfsamba4, xftaskbar4,
xfterm4, xftrash4, xftree4, and xfwm4</seg>
<seg id='xfcelibs'>libxfce4util.[a,so], libdbh.[a,so], libxfcegui4.[a,so],
libxfce4mcs.[a,so], libxffm_actions.so, libxffm_basic.so, libxffm_calls.so,
<seg id='xfcelibs'>libxfce4util.{a,so}, libdbh.{a,so}, libxfcegui4.{a,so},
libxfce4mcs.{a,so}, libxffm_actions.so, libxffm_basic.so, libxffm_calls.so,
libxffm_cpy.so, libxffm_on_demand.so, libxffm_secondary.so, libxffm_tubo.so,
libxfsm-4.2.[a,so]</seg>
libxfsm-4.2.{a,so}</seg>
<seg>/usr/lib/xfce4, /usr/share/doc/xfce4, /usr/share/xfce4, /usr/share/xffm
and /usr/share/xfwm4</seg>
</seglistitem>