diff options
author | Manuel Canales Esparcia <manuel@linuxfromscratch.org> | 2006-02-01 20:41:29 +0000 |
---|---|---|
committer | Manuel Canales Esparcia <manuel@linuxfromscratch.org> | 2006-02-01 20:41:29 +0000 |
commit | 92474b451445f3a1822c5ce6353ff91ff9d65e2d (patch) | |
tree | 2d46d778c492f2764e92ac17841fa76996d4637f /chapter06 | |
parent | 50e693d738db6a9f7765a293c77cc85e4218739f (diff) |
Indenting chapter 6, part 2.
git-svn-id: http://svn.linuxfromscratch.org/LFS/trunk/BOOK@7324 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689
Diffstat (limited to 'chapter06')
-rw-r--r-- | chapter06/bash.xml | 208 | ||||
-rw-r--r-- | chapter06/binutils.xml | 533 | ||||
-rw-r--r-- | chapter06/bison.xml | 181 |
3 files changed, 520 insertions, 402 deletions
diff --git a/chapter06/bash.xml b/chapter06/bash.xml index 3010805b7..82608f068 100644 --- a/chapter06/bash.xml +++ b/chapter06/bash.xml @@ -1,122 +1,154 @@ <?xml version="1.0" encoding="ISO-8859-1"?> -<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ <!ENTITY % general-entities SYSTEM "../general.ent"> %general-entities; ]> + <sect1 id="ch-system-bash" role="wrap"> -<title>Bash-&bash-version;</title> -<?dbhtml filename="bash.html"?> + <?dbhtml filename="bash.html"?> + + <title>Bash-&bash-version;</title> + + <indexterm zone="ch-system-bash"> + <primary sortas="a-Bash">Bash</primary> + </indexterm> + + <sect2 role="package"> + <title/> -<indexterm zone="ch-system-bash"><primary sortas="a-Bash">Bash</primary></indexterm> + <para>The Bash package contains the Bourne-Again SHell.</para> -<sect2 role="package"><title/> -<para>The Bash package contains the Bourne-Again SHell.</para> + <segmentedlist> + <segtitle>&buildtime;</segtitle> + <segtitle>&diskspace;</segtitle> -<segmentedlist> -<segtitle>&buildtime;</segtitle> -<segtitle>&diskspace;</segtitle> -<seglistitem><seg>1.2 SBU</seg><seg>24.6 MB</seg></seglistitem> -</segmentedlist> + <seglistitem> + <seg>1.2 SBU</seg> + <seg>24.6 MB</seg> + </seglistitem> + </segmentedlist> -<segmentedlist> -<segtitle>&dependencies;</segtitle> -<seglistitem><seg>Binutils, Coreutils, Diffutils, Gawk, -GCC, Glibc, Grep, Make, Ncurses, and Sed.</seg></seglistitem> -</segmentedlist> -</sect2> + <segmentedlist> + <segtitle>&dependencies;</segtitle> -<sect2 role="installation"> -<title>Installation of Bash</title> + <seglistitem> + <seg>Binutils, Coreutils, Diffutils, Gawk, GCC, Glibc, Grep, Make, + Ncurses, and Sed.</seg> + </seglistitem> + </segmentedlist> -<para>If you downloaded the Bash documentation tarball and wish to install HTML -documentation, issue the following commands:</para> + </sect2> + + <sect2 role="installation"> + <title>Installation of Bash</title> + + <para>If you downloaded the Bash documentation tarball and wish to install + HTML documentation, issue the following commands:</para> <screen><userinput>tar -xvf ../bash-doc-&bash-doc-version;.tar.gz && sed -i "s|htmldir = @htmldir@|htmldir = /usr/share/doc/bash-&bash-version;|" \ Makefile.in</userinput></screen> -<para>Prepare Bash for compilation:</para> + <para>Prepare Bash for compilation:</para> <screen><userinput>./configure --prefix=/usr --bindir=/bin \ --without-bash-malloc --with-installed-readline</userinput></screen> -<para>The meaning of the configure options:</para> + <variablelist> + <title>The meaning of the configure options:</title> -<variablelist> -<varlistentry> -<term><parameter>--with-installed-readline</parameter></term> -<listitem><para>This option tells Bash to use the -<filename class="libraryfile">readline</filename> library that is already installed -on the system rather than using its own readline version.</para></listitem> -</varlistentry> -</variablelist> + <varlistentry> + <term><parameter>--with-installed-readline</parameter></term> + <listitem> + <para>This option tells Bash to use the <filename + class="libraryfile">readline</filename> library that is already + installed on the system rather than using its own readline + version.</para> + </listitem> + </varlistentry> -<para>Compile the package:</para> + </variablelist> + + <para>Compile the package:</para> <screen><userinput>make</userinput></screen> -<para>To test the results, issue: -<userinput>make tests</userinput>.</para> + <para>To test the results, issue: + <userinput>make tests</userinput>.</para> -<para>Install the package:</para> + <para>Install the package:</para> <screen><userinput>make install</userinput></screen> -<para>Run the newly compiled <command>bash</command> program (replacing the one that is -currently being executed):</para> + <para>Run the newly compiled <command>bash</command> program (replacing the one that is + currently being executed):</para> <screen role="nodump"><userinput>exec /bin/bash --login +h</userinput></screen> -<note><para>The parameters used make the <command>bash</command> -process an interactive login shell and continue to disable hashing so -that new programs are found as they become available.</para></note> - -</sect2> - - -<sect2 id="contents-bash" role="content"><title>Contents of Bash</title> - -<segmentedlist> -<segtitle>Installed programs</segtitle> -<seglistitem><seg>bash, bashbug, and sh (link to bash)</seg></seglistitem> -</segmentedlist> - -<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> -<?dbfo list-presentation="list"?> -<?dbhtml list-presentation="table"?> - -<varlistentry id="bash"> -<term><command>bash</command></term> -<listitem> -<para>A widely-used command interpreter; it performs many types of -expansions and substitutions on a given command line before executing -it, thus making this interpreter a powerful tool</para> -<indexterm zone="ch-system-bash bash"><primary sortas="b-bash">bash</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="bashbug"> -<term><command>bashbug</command></term> -<listitem> -<para>A shell script to help the user compose and mail standard formatted bug -reports concerning <command>bash</command></para> -<indexterm zone="ch-system-bash bashbug"><primary sortas="b-bashbug">bashbug</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="sh"> -<term><command>sh</command></term> -<listitem> -<para>A symlink to the <command>bash</command> program; when invoked -as <command>sh</command>, <command>bash</command> tries to mimic the -startup behavior of historical versions of <command>sh</command> as -closely as possible, while conforming to the POSIX standard as well</para> -<indexterm zone="ch-system-bash sh"><primary sortas="b-sh">sh</primary></indexterm> -</listitem> -</varlistentry> -</variablelist> - -</sect2> + <note> + <para>The parameters used make the <command>bash</command> + process an interactive login shell and continue to disable hashing so + that new programs are found as they become available.</para> + </note> + + </sect2> + + <sect2 id="contents-bash" role="content"> + <title>Contents of Bash</title> + + <segmentedlist> + <segtitle>Installed programs</segtitle> + + <seglistitem> + <seg>bash, bashbug, and sh (link to bash)</seg> + </seglistitem> + </segmentedlist> + + <variablelist> + <bridgehead renderas="sect3">Short Descriptions</bridgehead> + <?dbfo list-presentation="list"?> + <?dbhtml list-presentation="table"?> + + <varlistentry id="bash"> + <term><command>bash</command></term> + <listitem> + <para>A widely-used command interpreter; it performs many types of + expansions and substitutions on a given command line before executing + it, thus making this interpreter a powerful tool</para> + <indexterm zone="ch-system-bash bash"> + <primary sortas="b-bash">bash</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="bashbug"> + <term><command>bashbug</command></term> + <listitem> + <para>A shell script to help the user compose and mail standard + formatted bug reports concerning <command>bash</command></para> + <indexterm zone="ch-system-bash bashbug"> + <primary sortas="b-bashbug">bashbug</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="sh"> + <term><command>sh</command></term> + <listitem> + <para>A symlink to the <command>bash</command> program; when invoked + as <command>sh</command>, <command>bash</command> tries to mimic the + startup behavior of historical versions of <command>sh</command> as + closely as possible, while conforming to the POSIX standard as + well</para> + <indexterm zone="ch-system-bash sh"> + <primary sortas="b-sh">sh</primary> + </indexterm> + </listitem> + </varlistentry> + + </variablelist> + + </sect2> </sect1> - diff --git a/chapter06/binutils.xml b/chapter06/binutils.xml index c5f7926b7..59a0f0ca4 100644 --- a/chapter06/binutils.xml +++ b/chapter06/binutils.xml @@ -1,277 +1,336 @@ <?xml version="1.0" encoding="ISO-8859-1"?> -<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ <!ENTITY % general-entities SYSTEM "../general.ent"> %general-entities; ]> + <sect1 id="ch-system-binutils" role="wrap"> -<title>Binutils-&binutils-version;</title> -<?dbhtml filename="binutils.html"?> + <?dbhtml filename="binutils.html"?> + + <title>Binutils-&binutils-version;</title> + + <indexterm zone="ch-system-binutils"> + <primary sortas="a-Binutils">Binutils</primary> + </indexterm> + + <sect2 role="package"> + <title/> -<indexterm zone="ch-system-binutils"><primary sortas="a-Binutils">Binutils</primary></indexterm> + <para>The Binutils package contains a linker, an assembler, and other + tools for handling object files.</para> -<sect2 role="package"><title/> -<para>The Binutils package contains a linker, an assembler, and other tools for -handling object files.</para> + <segmentedlist> + <segtitle>&buildtime;</segtitle> + <segtitle>&diskspace;</segtitle> -<segmentedlist> -<segtitle>&buildtime;</segtitle> -<segtitle>&diskspace;</segtitle> -<seglistitem><seg>1.3 SBU</seg><seg>158 MB</seg></seglistitem> -</segmentedlist> + <seglistitem> + <seg>1.3 SBU</seg> + <seg>158 MB</seg> + </seglistitem> + </segmentedlist> -<segmentedlist> -<segtitle>&dependencies;</segtitle> -<seglistitem><seg>Bash, Coreutils, Diffutils, GCC, Gettext, -Glibc, Grep, M4, Make, Perl, Sed, and Texinfo</seg></seglistitem> -</segmentedlist> -</sect2> + <segmentedlist> + <segtitle>&dependencies;</segtitle> -<sect2 role="installation"> -<title>Installation of Binutils</title> + <seglistitem> + <seg>Bash, Coreutils, Diffutils, GCC, Gettext, Glibc, Grep, M4, + Make, Perl, Sed, and Texinfo</seg> + </seglistitem> + </segmentedlist> -<para>Verify that the PTYs are working properly inside the chroot -environment. Check that everything is set up correctly by performing a -simple test:</para> + </sect2> + + <sect2 role="installation"> + <title>Installation of Binutils</title> + + <para>Verify that the PTYs are working properly inside the chroot + environment. Check that everything is set up correctly by performing a + simple test:</para> <screen><userinput>expect -c "spawn ls"</userinput></screen> -<para>If the following message shows up, the chroot environment is not -set up for proper PTY operation:</para> + <para>If the following message shows up, the chroot environment is not + set up for proper PTY operation:</para> -<screen><computeroutput>The system has no more ptys. +<screen><computeroutput>The system has no more ptys. Ask your system administrator to create more.</computeroutput></screen> -<para>This issue needs to be resolved before running the test suites -for Binutils and GCC.</para> + <para>This issue needs to be resolved before running the test suites + for Binutils and GCC.</para> -<para>The Binutils documentation recommends building Binutils outside of the -source directory in a dedicated build directory:</para> + <para>The Binutils documentation recommends building Binutils outside of the + source directory in a dedicated build directory:</para> <screen><userinput>mkdir -v ../binutils-build cd ../binutils-build</userinput></screen> -<para>Prepare Binutils for compilation:</para> + <para>Prepare Binutils for compilation:</para> <screen><userinput>../binutils-&binutils-version;/configure --prefix=/usr \ --enable-shared</userinput></screen> -<para>Compile the package:</para> + <para>Compile the package:</para> <screen><userinput>make tooldir=/usr</userinput></screen> - <variablelist> - <title>The meaning of the make parameter:</title> - <varlistentry> - <term><parameter>tooldir=/usr</parameter></term> - <listitem> - <para>Normally, the tooldir (the directory where the executables will - ultimately be located) is set to <filename - class="directory">$(exec_prefix)/$(target_alias)</filename>. For - example, i686 machines would expand that to <filename - class="directory">/usr/i686-pc-linux-gnu</filename>. Because this is - a custom system, this target-specific directory in <filename - class="directory">/usr</filename> is not required. <filename - class="directory">$(exec_prefix)/$(target_alias)</filename> would be - used if the system was used to cross-compile (for example, compiling a - package on an Intel machine that generates code that can be executed - on PowerPC machines).</para> - </listitem> - </varlistentry> - </variablelist> - -<important><para>The test suite for Binutils in this section is -considered critical. Do not skip it under any -circumstances.</para></important> - -<para>Test the results:</para> + <variablelist> + <title>The meaning of the make parameter:</title> + + <varlistentry> + <term><parameter>tooldir=/usr</parameter></term> + <listitem> + <para>Normally, the tooldir (the directory where the executables will + ultimately be located) is set to <filename + class="directory">$(exec_prefix)/$(target_alias)</filename>. For + example, i686 machines would expand that to <filename + class="directory">/usr/i686-pc-linux-gnu</filename>. Because this is + a custom system, this target-specific directory in <filename + class="directory">/usr</filename> is not required. <filename + class="directory">$(exec_prefix)/$(target_alias)</filename> would be + used if the system was used to cross-compile (for example, compiling a + package on an Intel machine that generates code that can be executed + on PowerPC machines).</para> + </listitem> + </varlistentry> + + </variablelist> + + <important> + <para>The test suite for Binutils in this section is considered critical. + Do not skip it under any circumstances.</para> + </important> + + <para>Test the results:</para> <screen><userinput>make check</userinput></screen> -<para>Install the package:</para> + <para>Install the package:</para> <screen><userinput>make tooldir=/usr install</userinput></screen> -<para>Install the <filename class="headerfile">libiberty</filename> header file that is needed by -some packages:</para> + <para>Install the <filename class="headerfile">libiberty</filename> header + file that is needed by some packages:</para> <screen><userinput>cp -v ../binutils-&binutils-version;/include/libiberty.h /usr/include</userinput></screen> -</sect2> - - -<sect2 id="contents-binutils" role="content"><title>Contents of Binutils</title> - -<segmentedlist> -<segtitle>Installed programs</segtitle> -<segtitle>Installed libraries</segtitle> -<seglistitem><seg>addr2line, ar, as, c++filt, gprof, ld, nm, objcopy, objdump, -ranlib, readelf, size, strings, and strip</seg> -<seg>libiberty.a, libbfd.[a,so], and libopcodes.[a,so]</seg></seglistitem> -</segmentedlist> - -<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> -<?dbfo list-presentation="list"?> -<?dbhtml list-presentation="table"?> - -<varlistentry id="addr2line"> -<term><command>addr2line</command></term> -<listitem> -<para>Translates program addresses to file names and line numbers; -given an address and the name of an executable, it uses the debugging -information in the executable to determine which source file and line -number are associated with the address</para> -<indexterm zone="ch-system-binutils addr2line"><primary sortas="b-addr2line">addr2line</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="ar"> -<term><command>ar</command></term> -<listitem> -<para>Creates, modifies, and extracts from archives</para> -<indexterm zone="ch-system-binutils ar"><primary sortas="b-ar">ar</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="as"> -<term><command>as</command></term> -<listitem> -<para>An assembler that assembles the output of <command>gcc</command> -into object files</para> -<indexterm zone="ch-system-binutils as"><primary sortas="b-as">as</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="c-filt"> -<term><command>c++filt</command></term> -<listitem> -<para>Used by the linker to de-mangle C++ and Java symbols and to keep -overloaded functions from clashing</para> -<indexterm zone="ch-system-binutils c-filt"><primary sortas="b-c++filt">c++filt</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="gprof"> -<term><command>gprof</command></term> -<listitem> -<para>Displays call graph profile data</para> -<indexterm zone="ch-system-binutils gprof"><primary sortas="b-gprof">gprof</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="ld"> -<term><command>ld</command></term> -<listitem> -<para>A linker that combines a number of object and archive files into a single file, -relocating their data and tying up symbol references</para> -<indexterm zone="ch-system-binutils ld"><primary sortas="b-ld">ld</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="nm"> -<term><command>nm</command></term> -<listitem> -<para>Lists the symbols occurring in a given object file</para> -<indexterm zone="ch-system-binutils nm"><primary sortas="b-nm">nm</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="objcopy"> -<term><command>objcopy</command></term> -<listitem> -<para>Translates one type of object file into another</para> -<indexterm zone="ch-system-binutils objcopy"><primary sortas="b-objcopy">objcopy</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="objdump"> -<term><command>objdump</command></term> -<listitem> -<para>Displays information about the given object file, with options -controlling the particular information to display; the information -shown is useful to programmers who are working on the compilation -tools</para> -<indexterm zone="ch-system-binutils objdump"><primary sortas="b-objdump">objdump</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="ranlib"> -<term><command>ranlib</command></term> -<listitem> -<para>Generates an index of the contents of an archive and stores it -in the archive; the index lists all of the symbols defined by archive -members that are relocatable object files</para> -<indexterm zone="ch-system-binutils ranlib"><primary sortas="b-ranlib">ranlib</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="readelf"> -<term><command>readelf</command></term> -<listitem> -<para>Displays information about ELF type binaries</para> -<indexterm zone="ch-system-binutils readelf"><primary sortas="b-readelf">readelf</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="size"> -<term><command>size</command></term> -<listitem> -<para>Lists the section sizes and the total size for the given object files</para> -<indexterm zone="ch-system-binutils size"><primary sortas="b-size">size</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="strings"> -<term><command>strings</command></term> -<listitem> -<para>Outputs, for each given file, the sequences of printable -characters that are of at least the specified length (defaulting to -four); for object files, it prints, by default, only the strings from -the initializing and loading sections while for other types of files, it -scans the entire file</para> -<indexterm zone="ch-system-binutils strings"><primary sortas="b-strings">strings</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="strip"> -<term><command>strip</command></term> -<listitem> -<para>Discards symbols from object files</para> -<indexterm zone="ch-system-binutils strip"><primary sortas="b-strip">strip</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="libiberty"> -<term><filename class="libraryfile">libiberty</filename></term> -<listitem> -<para>Contains routines used by various GNU programs, including -<command>getopt</command>, <command>obstack</command>, -<command>strerror</command>, <command>strtol</command>, and -<command>strtoul</command></para> -<indexterm zone="ch-system-binutils libiberty"><primary sortas="c-libiberty">libiberty</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="libbfd"> -<term><filename class="libraryfile">libbfd</filename></term> -<listitem> -<para>The Binary File Descriptor library</para> -<indexterm zone="ch-system-binutils libbfd"><primary sortas="c-libbfd">libbfd</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="libopcodes"> -<term><filename class="libraryfile">libopcodes</filename></term> -<listitem> -<para>A library for dealing with opcodes—the <quote>readable -text</quote> versions of instructions for the processor; -it is used for building utilities like -<command>objdump</command>.</para> -<indexterm zone="ch-system-binutils libopcodes"><primary sortas="c-libopcodes">libopcodes</primary></indexterm> -</listitem> -</varlistentry> -</variablelist> - -</sect2> + </sect2> + + + <sect2 id="contents-binutils" role="content"> + <title>Contents of Binutils</title> + + <segmentedlist> + <segtitle>Installed programs</segtitle> + <segtitle>Installed libraries</segtitle> + + <seglistitem> + <seg>addr2line, ar, as, c++filt, gprof, ld, nm, objcopy, objdump, + ranlib, readelf, size, strings, and strip</seg> + <seg>libiberty.a, libbfd.[a,so], and libopcodes.[a,so]</seg> + </seglistitem> + </segmentedlist> + + <variablelist> + <bridgehead renderas="sect3">Short Descriptions</bridgehead> + <?dbfo list-presentation="list"?> + <?dbhtml list-presentation="table"?> + + <varlistentry id="addr2line"> + <term><command>addr2line</command></term> + <listitem> + <para>Translates program addresses to file names and line numbers; + given an address and the name of an executable, it uses the debugging + information in the executable to determine which source file and line + number are associated with the address</para> + <indexterm zone="ch-system-binutils addr2line"> + <primary sortas="b-addr2line">addr2line</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="ar"> + <term><command>ar</command></term> + <listitem> + <para>Creates, modifies, and extracts from archives</para> + <indexterm zone="ch-system-binutils ar"> + <primary sortas="b-ar">ar</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="as"> + <term><command>as</command></term> + <listitem> + <para>An assembler that assembles the output of <command>gcc</command> + into object files</para> + <indexterm zone="ch-system-binutils as"> + <primary sortas="b-as">as</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="c-filt"> + <term><command>c++filt</command></term> + <listitem> + <para>Used by the linker to de-mangle C++ and Java symbols and to keep + overloaded functions from clashing</para> + <indexterm zone="ch-system-binutils c-filt"> + <primary sortas="b-c++filt">c++filt</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="gprof"> + <term><command>gprof</command></term> + <listitem> + <para>Displays call graph profile data</para> + <indexterm zone="ch-system-binutils gprof"> + <primary sortas="b-gprof">gprof</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="ld"> + <term><command>ld</command></term> + <listitem> + <para>A linker that combines a number of object and archive files + into a single file, relocating their data and tying up symbol + references</para> + <indexterm zone="ch-system-binutils ld"> + <primary sortas="b-ld">ld</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="nm"> + <term><command>nm</command></term> + <listitem> + <para>Lists the symbols occurring in a given object file</para> + <indexterm zone="ch-system-binutils nm"> + <primary sortas="b-nm">nm</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="objcopy"> + <term><command>objcopy</command></term> + <listitem> + <para>Translates one type of object file into another</para> + <indexterm zone="ch-system-binutils objcopy"> + <primary sortas="b-objcopy">objcopy</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="objdump"> + <term><command>objdump</command></term> + <listitem> + <para>Displays information about the given object file, with options + controlling the particular information to display; the information + shown is useful to programmers who are working on the compilation + tools</para> + <indexterm zone="ch-system-binutils objdump"> + <primary sortas="b-objdump">objdump</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="ranlib"> + <term><command>ranlib</command></term> + <listitem> + <para>Generates an index of the contents of an archive and stores it + in the archive; the index lists all of the symbols defined by archive + members that are relocatable object files</para> + <indexterm zone="ch-system-binutils ranlib"> + <primary sortas="b-ranlib">ranlib</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="readelf"> + <term><command>readelf</command></term> + <listitem> + <para>Displays information about ELF type binaries</para> + <indexterm zone="ch-system-binutils readelf"> + <primary sortas="b-readelf">readelf</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="size"> + <term><command>size</command></term> + <listitem> + <para>Lists the section sizes and the total size for the given + object files</para> + <indexterm zone="ch-system-binutils size"> + <primary sortas="b-size">size</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="strings"> + <term><command>strings</command></term> + <listitem> + <para>Outputs, for each given file, the sequences of printable + characters that are of at least the specified length (defaulting to + four); for object files, it prints, by default, only the strings from + the initializing and loading sections while for other types of files, it + scans the entire file</para> + <indexterm zone="ch-system-binutils strings"> + <primary sortas="b-strings">strings</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="strip"> + <term><command>strip</command></term> + <listitem> + <para>Discards symbols from object files</para> + <indexterm zone="ch-system-binutils strip"> + <primary sortas="b-strip">strip</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="libiberty"> + <term><filename class="libraryfile">libiberty</filename></term> + <listitem> + <para>Contains routines used by various GNU programs, including + <command>getopt</command>, <command>obstack</command>, + <command>strerror</command>, <command>strtol</command>, and + <command>strtoul</command></para> + <indexterm zone="ch-system-binutils libiberty"> + <primary sortas="c-libiberty">libiberty</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="libbfd"> + <term><filename class="libraryfile">libbfd</filename></term> + <listitem> + <para>The Binary File Descriptor library</para> + <indexterm zone="ch-system-binutils libbfd"> + <primary sortas="c-libbfd">libbfd</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="libopcodes"> + <term><filename class="libraryfile">libopcodes</filename></term> + <listitem> + <para>A library for dealing with opcodes—the <quote>readable + text</quote> versions of instructions for the processor; + it is used for building utilities like + <command>objdump</command>.</para> + <indexterm zone="ch-system-binutils libopcodes"> + <primary sortas="c-libopcodes">libopcodes</primary> + </indexterm> + </listitem> + </varlistentry> + + </variablelist> + + </sect2> </sect1> - diff --git a/chapter06/bison.xml b/chapter06/bison.xml index d5fb0ae82..3e208fe02 100644 --- a/chapter06/bison.xml +++ b/chapter06/bison.xml @@ -1,102 +1,129 @@ <?xml version="1.0" encoding="ISO-8859-1"?> -<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ <!ENTITY % general-entities SYSTEM "../general.ent"> %general-entities; ]> + <sect1 id="ch-system-bison" role="wrap"> -<title>Bison-&bison-version;</title> -<?dbhtml filename="bison.html"?> + <?dbhtml filename="bison.html"?> + + <title>Bison-&bison-version;</title> + + <indexterm zone="ch-system-bison"> + <primary sortas="a-Bison">Bison</primary> + </indexterm> + + <sect2 role="package"> + <title/> -<indexterm zone="ch-system-bison"><primary sortas="a-Bison">Bison</primary></indexterm> + <para>The Bison package contains a parser generator.</para> -<sect2 role="package"><title/> -<para>The Bison package contains a parser generator.</para> + <segmentedlist> + <segtitle>&buildtime;</segtitle> + <segtitle>&diskspace;</segtitle> -<segmentedlist> -<segtitle>&buildtime;</segtitle> -<segtitle>&diskspace;</segtitle> -<seglistitem><seg>0.6 SBU</seg><seg>9.9 MB</seg></seglistitem> -</segmentedlist> + <seglistitem> + <seg>0.6 SBU</seg> + <seg>9.9 MB</seg> + </seglistitem> + </segmentedlist> -<segmentedlist> -<segtitle>&dependencies;</segtitle> -<seglistitem><seg>Bash, Binutils, Coreutils, Diffutils, -GCC, Gettext, Glibc, Grep, M4, Make, and Sed</seg></seglistitem> -</segmentedlist> -</sect2> + <segmentedlist> + <segtitle>&dependencies;</segtitle> -<sect2 role="installation"> -<title>Installation of Bison</title> + <seglistitem> + <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Gettext, Glibc, + Grep, M4, Make, and Sed</seg> + </seglistitem> + </segmentedlist> -<para>Prepare Bison for compilation:</para> + </sect2> + + <sect2 role="installation"> + <title>Installation of Bison</title> + + <para>Prepare Bison for compilation:</para> <screen><userinput>./configure --prefix=/usr</userinput></screen> -<para>The configure system causes bison to be built without support for -internationalization of error messages if a <command>bison</command> -program is not already in $PATH. The following addition will correct -this.</para> + <para>The configure system causes bison to be built without support for + internationalization of error messages if a <command>bison</command> + program is not already in $PATH. The following addition will correct + this.</para> -<screen>echo '#define YYENABLE_NLS 1' >> config.h</screen> +<screen>echo '#define YYENABLE_NLS 1' >> config.h</screen> -<para>Compile the package:</para> + <para>Compile the package:</para> <screen><userinput>make</userinput></screen> -<para>To test the results, issue: -<userinput>make check</userinput>.</para> + <para>To test the results, issue: + <userinput>make check</userinput>.</para> -<para>Install the package:</para> + <para>Install the package:</para> <screen><userinput>make install</userinput></screen> -</sect2> - -<sect2 id="contents-bison" role="content"><title>Contents of Bison</title> - -<segmentedlist> -<segtitle>Installed programs</segtitle> -<segtitle>Installed library</segtitle> -<seglistitem><seg>bison and yacc</seg><seg>liby.a</seg></seglistitem> -</segmentedlist> - -<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> -<?dbfo list-presentation="list"?> -<?dbhtml list-presentation="table"?> - -<varlistentry id="bison"> -<term><command>bison</command></term> -<listitem> -<para>Generates, from a series of rules, a program for analyzing the structure -of text files; Bison is a replacement for Yacc (Yet Another Compiler -Compiler)</para> -<indexterm zone="ch-system-bison bison"><primary sortas="b-bison">bison</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="yacc"> -<term><command>yacc</command></term> -<listitem> -<para>A wrapper for <command>bison</command>, meant for programs -that still call <command>yacc</command> instead of <command>bison</command>; -it calls <command>bison</command> with the <parameter>-y</parameter> option</para> -<indexterm zone="ch-system-bison yacc"><primary sortas="b-yacc">yacc</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="liby.a"> -<term><filename class="libraryfile">liby.a</filename></term> -<listitem> -<para>The Yacc library containing implementations of Yacc-compatible -<emphasis>yyerror</emphasis> and <emphasis>main</emphasis> functions; -this library is normally not very useful, but POSIX requires -it</para> -<indexterm zone="ch-system-bison liby.a"><primary sortas="c-liby.a">liby.a</primary></indexterm> -</listitem> -</varlistentry> -</variablelist> - -</sect2> + </sect2> + + <sect2 id="contents-bison" role="content"> + <title>Contents of Bison</title> + + <segmentedlist> + <segtitle>Installed programs</segtitle> + <segtitle>Installed library</segtitle> + + <seglistitem> + <seg>bison and yacc</seg> + <seg>liby.a</seg> + </seglistitem> + </segmentedlist> + + <variablelist> + <bridgehead renderas="sect3">Short Descriptions</bridgehead> + <?dbfo list-presentation="list"?> + <?dbhtml list-presentation="table"?> + + <varlistentry id="bison"> + <term><command>bison</command></term> + <listitem> + <para>Generates, from a series of rules, a program for analyzing the + structure of text files; Bison is a replacement for Yacc (Yet Another + Compiler Compiler)</para> + <indexterm zone="ch-system-bison bison"> + <primary sortas="b-bison">bison</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="yacc"> + <term><command>yacc</command></term> + <listitem> + <para>A wrapper for <command>bison</command>, meant for programs that + still call <command>yacc</command> instead of <command>bison</command>; + it calls <command>bison</command> with the <parameter>-y</parameter> + option</para> + <indexterm zone="ch-system-bison yacc"> + <primary sortas="b-yacc">yacc</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="liby.a"> + <term><filename class="libraryfile">liby.a</filename></term> + <listitem> + <para>The Yacc library containing implementations of Yacc-compatible + <function>yyerror</function> and <function>main</function> functions; + this library is normally not very useful, but POSIX requires it</para> + <indexterm zone="ch-system-bison liby.a"> + <primary sortas="c-liby.a">liby.a</primary> + </indexterm> + </listitem> + </varlistentry> + + </variablelist> + + </sect2> </sect1> - |