Fix <option> vs <parameter>, and sometimes a little more

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@22448 af4574ff-66df-0310-9fd7-8a98e5e911e0
This commit is contained in:
Pierre Labastie 2019-12-07 17:38:33 +00:00
parent a5403032d0
commit aa41434620
34 changed files with 95 additions and 82 deletions

View File

@ -245,7 +245,7 @@ cp -r ../docs/reference/{NEWS,gio,glib,gobject} /usr/share/doc/glib-&glib2-versi
</para>
<para>
<parameter>-Ddoc=true</parameter>: This switch causes the
<option>-Ddoc=true</option>: This switch causes the
build to create and install the API documentation.
</para>

View File

@ -127,12 +127,12 @@ ninja</userinput></screen>
<sect2 role="commands">
<title>Command Explanations</title>
<para><parameter>-Dgtk_doc=true</parameter>: Build and install
<para><option>-Dgtk_doc=true</option>: Build and install
the documentation.</para>
<para><parameter>-Dcairo=true</parameter>: Use cairo for tests.</para>
<para><option>-Dcairo=true</option>: Use cairo for tests.</para>
<para><parameter>-Ddoctool=true</parameter>: Install g-ir-doc-tool
<para><option>-Ddoctool=true</option>: Install g-ir-doc-tool
and run related tests.</para>
</sect2>

View File

@ -78,13 +78,17 @@
<xref linkend="cmake"/>
</para>
<bridgehead renderas="sect4">Recommended</bridgehead>
<para role="recommended">
<xref linkend="gobject-introspection"/> and
<xref linkend="vala"/>(both required for Gnome)
</para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="db"/>,
<xref linkend="doxygen"/> (for the API documentation),
<xref linkend="icu"/>, and both
<xref linkend="gobject-introspection"/> and
<xref linkend="vala"/>(required for Gnome)
<xref linkend="icu"/>
</para>
<para condition="html" role="usernotes">User Notes:
@ -103,6 +107,9 @@
<screen><userinput>mkdir build &amp;&amp;
cd build &amp;&amp;
<!-- Needs confirmation, but I got a race condition at -j8,
-j1 allowed the build to pass. Pierre 2019-12-06 -->
cmake -DCMAKE_INSTALL_PREFIX=/usr \
-DCMAKE_BUILD_TYPE=Release \
-DSHARED_ONLY=yes \
@ -167,20 +174,20 @@ cp -vr apidocs/html/* /usr/share/doc/libical-&libical-version;/html</userinput><
</para>
<para>
<option>-DUSE_BUILTIN_TZDATA=yes</option>: This switch is used
in order to build using your own timezone data.
</para>
<para>
<option>-DGOBJECT_INTROSPECTION=true</option>: This switch is used
<parameter>-DGOBJECT_INTROSPECTION=true</parameter>: This switch is used
to generate GObject metadata bindings.
</para>
<para>
<option>-DICAL_GLIB_VAPI=true</option>: This switch is used
<parameter>-DICAL_GLIB_VAPI=true</parameter>: This switch is used
in order to build bindings for <xref linkend="vala"/>.
</para>
<para>
<option>-DUSE_BUILTIN_TZDATA=yes</option>: This switch is used
in order to build using your own timezone data.
</para>
<!-- No CMake equivalents
<para>
<parameter>- -enable-cxx</parameter>: This switch enables

View File

@ -156,8 +156,8 @@ make</userinput></screen>
href="../../xincludes/static-libraries.xml"/>
<para>
<option>--enable-jit</option>: this option enables Just-in-time compiling,
which can greatly speed up pattern matching.
<parameter>--enable-jit</parameter>: this option enables Just-in-time
compiling, which can greatly speed up pattern matching.
</para>
</sect2>

View File

@ -133,7 +133,7 @@ make</userinput></screen>
</para>
<para>
<option>--enable-pinentry-tty</option>: Default is 'maybe'.
<parameter>--enable-pinentry-tty</parameter>: Default is 'maybe'.
</para>
</sect2>

View File

@ -177,7 +177,7 @@ rm -v /usr/share/doc/freetype-&freetype2-version;/freetype-config.1</userinput><
</para>
<para>
<parameter>--without-harfbuzz</parameter>: If
<option>--without-harfbuzz</option>: If
<application>harfbuzz</application> is installed prior to
<application>freetype</application> without
<application>freetype</application> support, use this switch to avoid a

View File

@ -148,7 +148,7 @@ ninja</userinput></screen>
<title>Command Explanations</title>
<para>
<parameter>-Ddocs=true</parameter>: Build and
<option>-Ddocs=true</option>: Build and
install documentation.
</para>

View File

@ -107,9 +107,6 @@ cp -v -R doc/* /usr/share/doc/giflib-&giflib-version;</userinput></screen>
directory that would otherwise be installed by the commands that follow.
</para>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="../../xincludes/static-libraries.xml"/>
</sect2>
<sect2 role="content">

View File

@ -106,12 +106,16 @@ make</userinput></screen>
<sect2 role="commands">
<title>Command Explanations</title>
<para><option>-DCMAKE_SKIP_INSTALL_RPATH=YES</option>: This option removes
embedded library search paths.</para>
<para>
<parameter>-DCMAKE_SKIP_INSTALL_RPATH=YES</parameter>: This option
removes embedded library search paths.
</para>
<para><option>-DJAS_ENABLE_DOC=NO</option>: This option disables
rebuilding the pdf documentation if <xref linkend="texlive"/>
is installed.</para>
<para>
<parameter>-DJAS_ENABLE_DOC=NO</parameter>: This option disables
rebuilding the pdf documentation if <xref linkend="texlive"/>
is installed.
</para>
</sect2>

View File

@ -132,7 +132,7 @@ make</userinput></screen>
<title>Command Explanations</title>
<para>
<parameter>-DWITH_JPEG8=ON</parameter>: This switch enables compatibility
<option>-DWITH_JPEG8=ON</option>: This switch enables compatibility
with <application>libjpeg</application> version 8.
</para>
<!--

View File

@ -357,7 +357,7 @@ EOF</userinput></screen>
</para>
<para>
<parameter>--with-jobs=<replaceable>&lt;X&gt;</replaceable></parameter>:
<option>--with-jobs=<replaceable>&lt;X&gt;</replaceable></option>:
The <parameter>-j</parameter> passed to make does not work with make as
invoked here. By default, the build system will use the number of
CPUs - 1.

View File

@ -429,14 +429,15 @@ php ./go-pear.phar</userinput></screen>
enables multibyte string support.
</para>
<!--
<para>
<parameter>--disable-mbstring</parameter>: This parameter
<parameter>- -disable-mbstring</parameter>: This parameter
disables multibyte string regular expression support. It
requires the external
<ulink url="https://github.com/kkos/oniguruma">oniguruma</ulink>
library.
</para>
-->
<para>
<parameter>--with-readline</parameter>: This parameter
enables command line <application>Readline</application> support.

View File

@ -307,11 +307,11 @@ make check</userinput></screen>
</para>
<para revision="sysv">
<parameter>--with-systemd{user,system}unitdir=</parameter>: These
<parameter>--with-systemd{user,system}unitdir=no</parameter>: These
switches disable installation of systemd units on elogind based systems.
</para>
<para>
<parameter>--with-console-auth-dir=/run/console/</parameter>: This
<parameter>--with-console-auth-dir=/run/console</parameter>: This
parameter specifies the directory to check for console ownerhip.
</para>

View File

@ -164,6 +164,11 @@ ninja</userinput></screen>
switch forcibly disables Mobile Broadband Provider support because it
is not currently available in BLFS.
</para>
<para>
<parameter>-Dgtk_doc=false</parameter>: Remove this if you have
<xref linkend="gtk-doc"/> installed and want to rebuild the
documentation with it.
</para>
<para>
<option>-Dwwan=false</option>: This switch disables WWAN support.
@ -172,10 +177,6 @@ ninja</userinput></screen>
<para>
<option>-Dintrospection=false</option>: Use this if you do not have <xref linkend="gobject-introspection"/> installed.
</para>
<para>
<option>-Dgtk_doc=false</option>: Remove this if you have <xref linkend="gtk-doc"/> installed
and want to rebuild the documentation with it.
</para>
</sect2>

View File

@ -194,7 +194,7 @@ make</userinput></screen>
</para>
<para revision="sysv">
<parameter>-DWITHSYSTEMDUSERUNITDIR=no</parameter>: This switch
<parameter>-DWITH_SYSTEMDUSERUNITDIR=no</parameter>: This switch
disables installing the systemd units, which are not used for a Sysv
build.
</para>

View File

@ -128,7 +128,7 @@ ninja</userinput></screen>
<title>Command Explanations</title>
<para>
<option>-Denable-gtk-doc=false</option>: Allow this package to be
<parameter>-Denable-gtk-doc=false</parameter>: Allow this package to be
built without GTK-Doc. Remove this parameter if GTK-Doc is installed
and you wish to rebuild and install the API documentation.
</para>

View File

@ -119,9 +119,9 @@ ninja</userinput></screen>
<title>Command Explanations</title>
<para>
<option>-Denable-gtk-doc=false</option>: This option disables generating
documentation. If you have <xref linkend="gtk-doc"/> installed and wish
to generate documentation, remove this option.
<parameter>-Denable-gtk-doc=false</parameter>: This option disables
generating documentation. If you have <xref linkend="gtk-doc"/>
installed and wish to generate documentation, remove this option.
</para>
</sect2>

View File

@ -132,8 +132,9 @@ ninja</userinput></screen>
<sect2 role="commands">
<title>Command Explanations</title>
<para>
<option>-Dgtk_doc=false</option>: Remove this if you have <xref linkend="gtk-doc"/> installed
and want to rebuild the documentation with it.
<parameter>-Dgtk_doc=false</parameter>: Remove this if you have
<xref linkend="gtk-doc"/> installed and want to rebuild the
documentation with it.
</para>
</sect2>

View File

@ -159,7 +159,7 @@ ninja</userinput></screen>
<title>Command Explanations</title>
<para>
<option>-Dgtk_doc=false</option>: Remove this if you have <xref linkend="gtk-doc"/> installed
<parameter>-Dgtk_doc=false</parameter>: Remove this if you have <xref linkend="gtk-doc"/> installed
and want to rebuild the documentation with it.
</para>

View File

@ -123,7 +123,7 @@ ninja</userinput></screen>
<title>Command Explanations</title>
<para>
<parameter>-Dgtk_doc=true</parameter>: Use this option
<option>-Dgtk_doc=true</option>: Use this option
to build the API reference manual.
</para>

View File

@ -140,6 +140,11 @@ ninja </userinput></screen>
</para>
-->
<para>
<parameter>-Dfribidi=false</parameter>: Omit this switch if want to enable
bidirectional capabilities.
</para>
<para>
<option>-Dgnutls=false</option>: Add this switch if you do not
want to enable GNUTLS support.
@ -150,11 +155,6 @@ ninja </userinput></screen>
want to enable vala bindings.
</para>
<para>
<option>-Dfribidi=false</option>: Omit this switch if want to enable
bidirectional capabilities.
</para>
<para>
<option>-Ddocs=true</option>: Add this switch if wish to
build the documentation.

View File

@ -127,9 +127,10 @@ ln -sfv ../../lib/libnsl.so.2.0.0 /usr/lib/libnsl.so</userinput></screen>
<sect2 role="commands">
<title>Command Explanations</title>
<!-- there is no disable-static in the configure string
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="../../xincludes/static-libraries.xml"/>
-->
<para>
<command>mv -v /usr/lib/libnsl.so.2* ...</command>: Move shared
libraries into /lib so they are available before /usr is mounted.

View File

@ -149,9 +149,9 @@ ninja</userinput></screen>
</para>
<para>
<option>-Dgssapi=disabled</option>: libsoup defaults to building with GSSAPI support,
<parameter>-Dgssapi=disabled</parameter>: libsoup defaults to building with GSSAPI support,
which requires Kerberos (as does the test suite). If you are building GNOME or
have kerberos installed, remove this option.
have kerberos installed, remove this switch.
</para>
</sect2>

View File

@ -101,7 +101,7 @@ make -C bin/dig</userinput></screen>
<sect2 role="commands">
<title>Command Explanations</title>
<para><option>--without-python</option>: This option eliminates
<para><parameter>--without-python</parameter>: This option eliminates
the need for an unused python module.</para>
<para><command>make -C lib/...</command>: These commands build the

View File

@ -164,7 +164,7 @@ make</userinput></screen>
</para>
<para revision="sysv">
<parameter>--without-systemd</parameter>: This command prevents
<parameter>--disable-systemd</parameter>: This command prevents
installation of <application>systemd</application> services.
</para>

View File

@ -165,9 +165,10 @@ ln -sfv ../../lib/$(readlink /usr/lib/libnftables.so) /usr/lib/libnftables.so</u
<sect2 role="commands">
<title>Command Explanations</title>
<!-- there is no disable-static option in the configure string
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="../../xincludes/static-libraries.xml"/>
-->
<para>
<parameter>--with-json</parameter>: build with support for JSON rules.
Omit if <xref linkend="jansson"/> is not available.

View File

@ -194,7 +194,7 @@ install -v -m644 doc/misc/{dnssec,ipv6,migrat*,options,rfc-compliance,roadmap
building of dynamic libraries and links the installed binaries to these
libraries.</para>
<para><parameter>--with-libidn2</parameter>: This parameter enables
<para><option>--with-libidn2</option>: This parameter enables
the IDNA2008 (Internationalized Domain Names in Applications)
support.</para>

View File

@ -118,7 +118,7 @@ make</userinput></screen>
</para>
<para>
<parameter>sed -i -e '/glew.lib.static:/d' ...</parameter>: This suppresses
<command>sed -i -e '/glew.lib.static:/d' ...</command>: This suppresses
the static library.
</para>

View File

@ -137,7 +137,7 @@ ninja</userinput></screen>
<sect2 role="commands">
<title>Command Explanations</title>
<para><option>-Dgtk_doc=false</option>: Remove this parameter if
<para><parameter>-Dgtk_doc=false</parameter>: Remove this parameter if
<application>GTK-Doc</application> is installed and you wish to rebuild
and install the API documentation.</para>

View File

@ -200,6 +200,18 @@ install -vm644 ../Documentation/webkitdomgtk-4.0/html/* \
<application>Mini Browser</application> compilation and install.
</para>
<para>
<parameter>-DUSE_WPE_RENDERER=OFF</parameter>: Remove this switch if the optional
packages <ulink url="https://github.com/WebPlatformForEmbedded/libwpe">libwpe</ulink> and
<ulink url="https://github.com/Igalia/WPEBackend-fdo">WPEBackend-fdo</ulink> are installed.
</para>
<para>
<parameter>-DENABLE_BUBBLEWRAP_SANDBOX=OFF</parameter>: Remove this switch if the optional
package <ulink url="https://github.com/flatpak/xdg-dbus-proxy">xdg-dbus-proxy</ulink>
is installed.
</para>
<para>
<option>-DUSE_LIBNOTIFY=OFF</option>: Use this switch if you do not
have <application>libnotify</application> installed.
@ -226,18 +238,6 @@ install -vm644 ../Documentation/webkitdomgtk-4.0/html/* \
package <xref linkend="woff2"/> is installed.
</para>
<para>
<option>-DUSE_WPE_RENDERER=OFF</option>: Remove this switch if the optional
packages <ulink url="https://github.com/WebPlatformForEmbedded/libwpe">libwpe</ulink> and
<ulink url="https://github.com/Igalia/WPEBackend-fdo">WPEBackend-fdo</ulink> are installed.
</para>
<para>
<option>-DENABLE_BUBBLEWRAP_SANDBOX=OFF</option>: Remove this switch if the optional
package <ulink url="https://github.com/flatpak/xdg-dbus-proxy">xdg-dbus-proxy</ulink>
is installed.
</para>
</sect2>
<sect2 role="content">

View File

@ -130,8 +130,10 @@ make</userinput></screen>
<application>GNOME Doc Utils</application>.
</para>
<!-- this is an option, not a parameter, but is it still necessary for
wayland? -->
<para>
<parameter>--enable-xhost-root</parameter>: This switch provides an
<option>--enable-xhost-root</option>: This switch provides an
interim workaround to allow GParted to run under Wayland by using xhost
to grant and revoke root access to the X11 display.
</para>

View File

@ -110,13 +110,13 @@ ninja</userinput></screen>
<title>Command Explanations</title>
<para>
<option>-Dwith-libcanberra=false</option>: Use this switch if you have
libcanberra not installed.
<parameter>-Dwith-lua=lua</parameter>: By default, this package
will look for luajit. Use the normal lua instead.
</para>
<para>
<option>-Dwith-lua=lua</option>: By default, this package
will look for luajit. Use the normal lua instead.
<option>-Dwith-libcanberra=false</option>: Use this switch if you have
libcanberra not installed.
</para>
</sect2>

View File

@ -231,7 +231,7 @@ rm -v /usr/lib/inkscape/lib*_LIB.a</userinput></screen>
</para>
<para>
<parameter>rm -v /usr/lib/inkscape/lib*_LIB.a</parameter>: The conversion
<command>rm -v /usr/lib/inkscape/lib*_LIB.a</command>: The conversion
of the package to use <command>cmake</command> has led to these libraries
getting installed, but they are not usable (there are no header files to
let a program know what they contain). So remove them.

View File

@ -125,7 +125,6 @@
./autogen.sh --prefix=/usr \
--libexecdir=/usr/lib/xfce4 \
--disable-gtk3 \
--docdir=/usr/share/doc/xarchiver-&xarchiver-version; &amp;&amp;
make</userinput></screen>
@ -154,9 +153,8 @@ make</userinput></screen>
</para>
<para>
<parameter>--disable-gtk3</parameter>: This switch allows building
against GTK+2. Default is <parameter>--enable-gtk3</parameter>. Remove it
or replace it, if you wish to build against GTK+3.
<option>--disable-gtk3</option>: This switch allows building
against GTK+2.
</para>
</sect2>