Beyond Linux® From Scratch (systemd Edition)

Version 12.0

The BLFS Development Team

Copyright © 1999-2023, The BLFS Development Team

All rights reserved.

This book is licensed under a Creative Commons License.

Computer instructions may be extracted from the book under the MIT License.

Linux® is a registered trademark of Linus Torvalds.

Published 2023-09-01

Revision History
Revision 12.0 2023-09-01 Twenty-eighth Release
Revision 11.3 2023-03-01 Twenty-seventh Release
Revision 11.2 2022-09-01 Twenty-sixth Release
Revision 11.1 2022-03-01 Twenty-fifth Release
Revision 11.0 2021-09-01 Twenty-fourth Release
Revision 10.1 2021-03-01 Twenty-third Release
Revision 10.0 2020-09-01 Twenty-second Release
Revision 9.1 2020-03-01 Twenty-first Release
Revision 9.0 2019-09-01 Twentieth release
Revision 8.4 2019-03-01 Nineteenth release
Revision 8.3 2018-09-01 Eighteenth release
Revision 8.2 2018-03-02 Seventeenth release
Revision 8.1 2017-09-01 Sixteenth release
Revision 8.0 2017-02-25 Fifteenth release
Revision 7.10 2016-09-07 Fourteenth release
Revision 7.9 2016-03-08 Thirteenth release
Revision 7.8 2015-10-01 Twelfth release
Revision 7.7 2015-03-06 Eleventh release
Revision 7.6 2014-09-23 Tenth release
Revision 7.5 2014-03-05 Ninth release
Revision 7.4 2013-09-14 Eighth release
Revision 6.3 2008-08-24 Seventh release
Revision 6.2 2007-02-14 Sixth release
Revision 6.1 2005-08-14 Fifth release
Revision 6.0 2005-04-02 Fourth release
Revision 5.1 2004-06-05 Third release
Revision 5.0 2003-11-06 Second release
Revision 1.0 2003-04-25 First release

Abstract

This book follows on from the Linux From Scratch book. It introduces and guides the reader through additions to the system including networking, graphical interfaces, sound support, and printer and scanner support.


Dedication

This book is dedicated to the LFS community

Table of Contents

Preface

Having helped out with Linux From Scratch for a short time, I noticed that we were getting many queries as to how to do things beyond the base LFS system. At the time, the only assistance specifically offered relating to LFS were the LFS hints (https://www.linuxfromscratch.org/hints). Most of the LFS hints are extremely good and well written but I (and others) could still see a need for more comprehensive help to go Beyond LFS — hence BLFS.

BLFS aims to be more than the LFS-hints converted to XML although much of our work is based around the hints and indeed some authors write both hints and the relevant BLFS sections. We hope that we can provide you with enough information to not only manage to build your system up to what you want, whether it be a web server or a multimedia desktop system, but also that you will learn a lot about system configuration as you go.

Thanks as ever go to everyone in the LFS/BLFS community; especially those who have contributed instructions, written text, answered questions and generally shouted when things were wrong!

Finally, we encourage you to become involved in the community; ask questions on the mailing list or news gateway and join in the fun on #lfs and #lfs-support at Libera. You can find more details about all of these in the Introduction section of the book.

Enjoy using BLFS.

Mark Hymers
markh <at> linuxfromscratch.org
BLFS Editor (July 2001–March 2003)

I still remember how I found the BLFS project and started using the instructions that were completed at the time. I could not believe how wonderful it was to get an application up and running very quickly, with explanations as to why things were done a certain way. Unfortunately, for me, it wasn't long before I was opening applications that had nothing more than "To be done" on the page. I did what most would do, I waited for someone else to do it. It wasn't too long before I am looking through Bugzilla for something easy to do. As with any learning experience, the definition of what was easy kept changing.

We still encourage you to become involved as BLFS is never really finished. Contributing or just using, we hope you enjoy your BLFS experience.

Larry Lawrence
larry <at> linuxfromscratch.org
BLFS Editor (March 2003–June 2004)

The BLFS project is a natural progression of LFS. Together, these projects provide a unique resource for the Open Source Community. They take the mystery out of the process of building a complete, functional software system from the source code contributed by many talented individuals throughout the world. They truly allow users to implement the slogan Your distro, your rules.

Our goal is to continue to provide the best resource available that shows you how to integrate many significant Open Source applications. Since these applications are constantly updated and new applications are developed, this book will never be complete. Additionally, there is always room for improvement in explaining the nuances of how to install the different packages. To make these improvements, we need your feedback. I encourage you to participate on the different mailing lists, news groups, and IRC channels to help meet these goals.

Bruce Dubbs
bdubbs <at> linuxfromscratch.org
BLFS Editor (June 2004–December 2006 and February 2011–now)

My introduction to the [B]LFS project was actually by accident. I was trying to build a GNOME environment using some how-tos and other information I found on the web. A couple of times I ran into some build issues and Googling pulled up some old BLFS mailing list messages. Out for curiosity, I visited the Linux From Scratch web site and shortly thereafter was hooked. I've not used any other Linux distribution for personal use since.

I can't promise anyone will feel the sense of satisfaction I felt after building my first few systems using [B]LFS instructions, but I sincerely hope that your BLFS experience is as rewarding for you as it has been for me.

The BLFS project has grown significantly the last couple of years. There are more package instructions and related dependencies than ever before. The project requires your input for continued success. If you discover that you enjoy building BLFS, please consider helping out in any way you can. BLFS requires hundreds of hours of maintenance to keep it even semi-current. If you feel confident enough in your editing skills, please consider joining the BLFS team. Simply contributing to the mailing list discussions with sound advice and/or providing patches to the book's XML will probably result in you receiving an invitation to join the team.

Randy McMurchy
randy <at> linuxfromscratch.org
BLFS Editor (December 2006–January 2011)

Foreword

This version of the book is intended to be used when building on top of a system built using the LFS book. Every effort has been made to ensure accuracy and reliability of the instructions. Many people find that using the instructions in this book after building the current stable or development version of LFS provides a stable and very modern Linux system.

Enjoy!

Randy McMurchy
August 24th, 2008

Who Would Want to Read this Book

This book is mainly aimed at those who have built a system based on the LFS book. It will also be useful for those who are using other distributions, and for one reason or another want to manually build software and need some assistance. Note that the material in this book, in particular the dependency listings, assumes that you are using a basic LFS system with every package listed in the LFS book already installed and configured. BLFS can be used to create a range of diverse systems and so the target audience is probably as wide as that of the LFS book. If you found LFS useful, you should also like this!

Since Release 7.4, the BLFS book version has matched the LFS book version. This book may be incompatible with a previous or later release of the LFS book.

Organization

This book is divided into the following fourteen parts.

Part I - Introduction

This part contains essential information which is needed to understand the rest of the book.

Part II - Post LFS Configuration and Extra Software

Here we introduce basic configuration and security issues. We also discuss a range of text editors, file systems, and shells which aren't covered in the main LFS book.

Part III - General Libraries and Utilities

In this section we cover libraries which are often needed throughout the book, as well as system utilities. Information on programming (including recompiling GCC to support its full range of languages) concludes this part.

Part IV - Basic Networking

Here we explain how to connect to a network when you aren't using the simple static IP setup presented in the main LFS book. Networking libraries and command-line networking tools are also covered here.

Part V - Servers

Here we show you how to set up mail and other servers (such as FTP, Apache, etc.).

Part VI - X + Window Managers

This part explains how to set up a basic X Window System, along with some generic X libraries and Window managers.

Part VII - KDE

This part is for those who want to use the K Desktop Environment, or parts of it.

Part VIII - GNOME

GNOME is the main alternative to KDE in the Desktop Environment arena.

Part IX - Xfce

Xfce is a lightweight alternative to GNOME and KDE.

Part X - LXDE

LXDE is another lightweight alternative to GNOME and KDE.

Part XI - More X Software

Office programs and graphical web browsers are important to most people. They, and some generic X software, can be found in this part of the book.

Part XII - Multimedia

Here we cover multimedia libraries and drivers, along with some audio, video, and CD-writing programs.

Part XIII - Printing, Scanning and Typesetting (PST)

This part covers document handling, from applications like Ghostscript, CUPS, and DocBook, all the way to texlive.

Appendices

The Appendices present information which doesn't belong in the body of book; they are included as reference material. The glossary of acronyms is a handy feature.

Part I. Introduction

Chapter 1. Welcome to BLFS

The Beyond Linux From Scratch book is designed to carry on from where the LFS book leaves off. But unlike the LFS book, it isn't designed to be followed straight through. Reading the Which sections of the book? part of this chapter should help guide you through the book.

Please read most of this part of the book carefully as it explains quite a few of the conventions used throughout the book.

Which Sections of the Book Do I Want?

Unlike the Linux From Scratch book, BLFS isn't designed to be followed in a linear manner. LFS provides instructions on how to create a base system which can become anything from a web server to a multimedia desktop system. BLFS attempts to guide you in the process of going from the base system to your intended destination. Choice is very much involved.

Everyone who reads this book will want to read certain sections. The Introduction, which you are currently reading, contains generic information. Take special note of the information in Chapter 2, Important Information, as this contains comments about how to unpack software, issues related to the use of different locales, and various other considerations which apply throughout the book.

The part on Post LFS Configuration and Extra Software is where most people will want to turn next. This deals not only with configuration, but also with Security (Chapter 4, Security), File Systems (Chapter 5, File Systems and Disk Management -- including GRUB for UEFI), Text Editors (Chapter 6, Text Editors), and Shells (Chapter 7, Shells). Indeed, you may wish to reference some parts of this chapter (especially the sections on Text Editors and File Systems) while building your LFS system.

Following these basic items, most people will want to at least browse through the General Libraries and Utilities part of the book. This contains information on many items which are prerequisites for other sections of the book, as well as some items (such as Chapter 13, Programming) which are useful in their own right. You don't have to install all of the libraries and packages found in this part; each BLFS installation procedure tells you which other packages this one depends upon. You can choose the program you want to install, and see what it needs. (Don't forget to check for nested dependencies!)

Likewise, most people will probably want to look at the Networking section. It deals with connecting to the Internet or your LAN (Chapter 14, Connecting to a Network) using a variety of methods such as DHCP and PPP, and with items such as Networking Libraries (Chapter 17, Networking Libraries), plus various basic networking programs and utilities.

Once you have dealt with these basics, you may wish to configure more advanced network services. These are dealt with in the Servers part of the book. Those wanting to build servers should find a good starting point there. Note that this section also contains information on several database packages.

The next twelve chapters deal with desktop systems. This portion of the book starts with a part talking about Graphical Components. This part also deals with some generic X-based libraries (Chapter 25, Graphical Environment Libraries). After that, KDE, GNOME, Xfce, and LXDE are given their own parts, followed by one on X Software.

The book then moves on to deal with Multimedia packages. Note that many people may want to use the ALSA-1.2.7 instructions from this chapter when first starting their BLFS journey; the instructions are placed here because it is the most logical place for them.

The final part of the main BLFS book deals with Printing, Scanning and Typesetting. This is useful for most people with desktop systems, but even those who are creating dedicated server systems may find it useful.

We hope you enjoy using BLFS. May you realize your dream of building the perfectly personalized Linux system!

Conventions Used in this Book

Typographical Conventions

To make things easy to follow, a number of conventions are used throughout the book. Here are some examples:

./configure --prefix=/usr

This form of text should be typed exactly as shown unless otherwise noted in the surrounding text. It is also used to identify references to specific commands.

install-info: unknown option
`--dir-file=/mnt/lfs/usr/info/dir'

This form of text (fixed width font) shows screen output, probably the result of issuing a command. It is also used to show filenames such as /boot/grub/grub.conf

Emphasis

This form of text is used for several purposes, but mainly to emphasize important points, or to give examples of what to type.

https://www.linuxfromscratch.org/

This form of text is used for hypertext links external to the book, such as HowTos, download locations, websites, etc.

SeaMonkey-2.53.17

This form of text is used for links internal to the book, such as another section describing a different package.

cat > $LFS/etc/group << "EOF"
root:x:0:
bin:x:1:
......
EOF

This style is mainly used when creating configuration files. The first command (in bold) tells the system to create the file $LFS/etc/group from whatever is typed on the following lines, until the sequence EOF is encountered. Therefore, this whole section is usually typed exactly as shown. Remember, copy and paste is your friend!

<REPLACED TEXT>

This form of text is used to encapsulate text that should be modified, and is not to be typed as shown, or copied and pasted. The angle brackets are not part of the literal text; they are part of the substitution.

root

This form of text is used to show a specific system user or group reference in the instructions.

 

Conventions Used for Package Dependencies

When new packages are created, the software's authors depend on prior work. In order to build a package in BLFS, these dependencies must be built before the desired package can be compiled. For each package, prerequisites are listed in one or more separate sections: Required, Recommended, and Optional.

Required Dependencies

These dependencies are the bare minimum needed to build the package. Packages in LFS, and the required dependencies of these required packages, are omitted from this list. Always remember to check for nested dependencies. If a dependency is said to be runtime, then it is not needed for building the package, but only to use it after installation.

Recommended Dependencies

These are dependencies the BLFS editors have determined are important to give the package reasonable capabilities. If a recommended dependency is not said to be runtime, package installation instructions assume it is installed. If it is not installed, the instructions may require modification, to accommodate the missing package. A recommended runtime dependency does not need to be installed before building the package, but must be built afterwards for running the package with reasonable capabilities.

Optional Dependencies

These are dependencies the package may use. Integration of optional dependencies may be automatic by the package, or additional steps not presented by BLFS may be necessary. Optional dependencies are sometimes listed without explicit BLFS instructions. In this case you must determine how to perform the installation yourself.

 

Conventions Used for Kernel Configuration Options

Some packages require specific kernel configuration options. The general layout for these looks like this:

Master section --->
  Subsection --->
    [*]     Required parameter                                        [REQU_PAR]
    <*>     Required parameter (not as module)                   [REQU_PAR_NMOD]
    <*/M>   Required parameter (could be a module)                [REQU_PAR_MOD]
    <M>     Required parameter (as a module)                 [REQU_PAR_MOD_ONLY]
    < /*/M> Optional parameter                                         [OPT_PAR]
    < /M>   Optional parameter (as a module if enabled)       [OPT_PAR_MOD_ONLY]
    [ ]     Incompatible parameter                                  [INCOMP_PAR]
    < >     Incompatible parameter (even as module)             [INCOMP_PAR_MOD]

[...] on the right gives the symbolic name of the option, so you can easily check whether it is set in your .config file. Note that the .config file contains a CONFIG_ prefix before all symbolic names. The meaning of the various entries is:

Master section top level menu item
Subsection submenu item
Required parameter the option can either be built-in, or not selected: it must be selected
Required parameter (not as module) the option can be built-in, a module, or not selected (tri-state): it must be selected as built-in
Required parameter (could be a module) the option can be built-in, a module, or not selected: it must be selected, either as built-in or as a module
Required parameter (as a module) the option can be built-in, a module, or not selected: it must be selected as a module; selecting it as built-in may cause unwanted effects
Optional parameter the option can be built-in, a module, or not selected: it may be selected as a module or built-in if you need it for driving the hardware or optional kernel features
Optional parameter the option can be built-in, a module, or not selected: it may be selected as a module if you need it for driving the hardware or optional kernel features, but selecting it as built-in may cause unwanted effects
Incompatible parameter the option can either be built-in or not selected: it must not be selected
Incompatible parameter (even as module) the option can be built-in, a module, or not selected: it must not be selected

Note that, depending on other selections, the angle brackets (<>) in the configuration menu may appear as braces ({}) if the option cannot be unselected, or even as dashes (-*- or -M-), when the choice is imposed. The help text describing the option specifies the other selections on which this option relies, and how those other selections are set.

The letter in blue is the hotkey for this option. If you are running make menuconfig, you can press a key to quickly traverse all the options with this key as the hotkey on the screen.

 

SBU values in BLFS

As in LFS, each package in BLFS has a build time listed in Standard Build Units (SBUs). These times are relative to the time it took to build binutils in LFS, and are intended to provide some insight into how long it will take to build a package. Most times listed are for a single processor or core to build the package. In some cases, large, long running builds tested on multi-core systems have SBU times listed with comments such as '(parallelism=4)'. These values indicate testing was done using multiple cores. Note that while this speeds up the build on systems with the appropriate hardware, the speedup is not linear and to some extent depends on the individual package and the specific hardware used.

For packages which use ninja (i.e., anything using meson) or rust, by default all cores are used; similar comments will be seen on such packages even when the build time is minimal.

Where even a parallel build takes more than 15 SBU, on certain machines the time may be considerably greater even when the build does not use swap. In particular, different micro-architectures will build some files at different relative speeds, and this can introduce delays when certain make targets wait for another file to be created. Where a large build uses a lot of C++ files, processors with Simultaneous Multi Threading will share the Floating Point Unit and can take 45% longer than when using four 'prime' cores (measured on an intel i7 using taskset and keeping the other cores idle).

Some packages do not support parallel builds; for these, the make command must specify -j1. Packages that are known to impose such limits are so marked in the text.

Book Version

This is BLFS-BOOK version 12.0 dated September 1st, 2023. This is the 12.0-systemd branch of the BLFS book, currently targeting the LFS 12.0-systemd book. For development versions, if this version is older than a month, it's likely that your mirror hasn't been synchronized recently and a newer version is probably available for download or viewing. Check one of the mirror sites at https://www.linuxfromscratch.org/mirrors.html for an updated version.

Mirror Sites

The BLFS project has a number of mirrors set up world-wide to make it easier and more convenient for you to access the website. Please visit the https://www.linuxfromscratch.org/mirrors.html website for the list of current mirrors.

Getting the Source Packages

Within the BLFS instructions, each package has two references for finding the source files for the package—an HTTP link and an FTP link (some packages may only list one of these links). Every effort has been made to ensure that these links are accurate. However, the World Wide Web is in continuous flux. Packages are sometimes moved or updated and the exact URL specified is not always available.

To overcome this problem, the BLFS Team, with the assistance of Oregon State University Open Source Lab, has made an HTTP/FTP site available through world wide mirrors. See https://www.linuxfromscratch.org/blfs/download.html#sources for a list. These sites have all the sources of the exact versions of the packages used in BLFS. If you can't find the BLFS package you need at the listed addresses, get it from these sites.

We would like to ask a favor, however. Although this is a public resource for you to use, please do not abuse it. We have already had one unthinking individual download over 3 GB of data, including multiple copies of the same files that are placed at different locations (via symlinks) to make finding the right package easier. This person clearly did not know what files he needed and downloaded everything. The best place to download files is the site or sites set up by the source code developer. Please try there first.

Change Log

Current release: 12.0 – September 1st, 2023

Changelog Entries:

  • Septenber 1st, 2023

    • [bdubbs] - Release of BLFS-12.0.

  • August 31st, 2023

    • [renodr] - Update to Thunderbird-115.2.0 (Security Update). Fixes #18479.

  • August 30th, 2023

    • [renodr] - Archive LXDM because of problems with PAM and elogind.

    • [pierre] - Update to blocaled-0.5. Fixes #18480.

  • August 29th, 2023

    • [renodr] - Update to intel-media-driver-23.3.2. Fixes #18472.

    • [ken] - Update to firefox-115.2.0 (Security Update). Fixes #18468.

  • August 28th, 2023

    • [renodr] - Update to libreoffice-7.6.0.3. Fixes #18435.

  • August 24th, 2023

    • [bdubbs] - Update to kf5-apps-23.08.0, kate, kwave, falkon. Fixes #18152.

  • August 23rd, 2023

    • [renodr] - Update to Thunderbird-115.1.1 (Security Update). Fixes #18323.

    • [renodr] - Update to gnome-system-monitor-45.0. Fixes #18430.

    • [bdubbs] - Update to qemu-8.1.0. Fixes #18408.

    • [bdubbs] - Update to plasma5-5.27.7. Fixes #18189.

    • [bdubbs] - Update to kf5-109.0. Fixes #18164.

  • August 22nd, 2023

    • [renodr] - Update to gnome-bluetooth-42.6. Fixes #18414.

    • [renodr] - Update to samba-4.18.6. Fixes #18416.

    • [bdubbs] - Update to xfce4-terminal-1.1.0. Fixes #18443.

    • [bdubbs] - Update to xfce4-appfinder-4.18.1. Fixes #18444.

    • [bdubbs] - Update to fop-2.9. Fixes #18441.

    • [bdubbs] - Update to apache-ant-1.10.14. Fixes #18433.

    • [renodr] - Update to WebKitGTK+-2.41.91. Fixes #18432.

  • August 21st, 2023

    • [ken]- Update to mutt-2.2.11. Fixes #18431.

    • [bdubbs]- MPlayer-1.5 FTBFS with binutils-2.41. Fixes #18381.

  • August 20th, 2023

    • [bdubbs] - Update to imlib2-1.12.0. Fixes #18428.

    • [renodr] - Move Kea from the Networking chapter to the Major Servers chapter.

  • August 19th, 2023

    • [bdubbs] - Update to ImageMagick-7.1.1-15. Addresses #16962.

    • [bdubbs] - Update to php-8.2.9 (Security update). Fixes #18423.

  • August 17th, 2023

    • [bdubbs] - Update to xwayland-23.2.0. Fixes #18415.

    • [bdubbs] - Update to mesa-23.1.6. Fixes #18417.

    • [bdubbs] - Update to libxcb-1.16. Fixes #18419.

    • [bdubbs] - Update to xcb-proto-1.16.0. Fixes #18418.

    • [renodr] - Update to screen-4.9.1. Fixes #18425.

    • [renodr] - Update to krb5-1.21.2 (Security Update). Fixes #18420.

    • [renodr] - Update to bind-9.18.18. Fixes #18424.

    • [renodr] - Document a test that is known to hang on some systems in rustc.

    • [renodr] - Disable the creation of the /tmp/hsperfdata_[username] directory in Java. On a BLFS system, this directory is not typically needed.

  • August 16th, 2023

    • [renodr] - Archive the SUPER Perl Module. It was previously only used by Archive::TestMockModule, which was just archived.

    • [renodr] - Archive Test::MockModule. It was previously only used in Archive::Zip, but it is no longer used there anymore.

    • [renodr] - Update to blfs-systemd-units-20230816. This fixes warnings when using the sendmail service.

  • August 14th, 2023

    • [renodr] - Update to vala-0.56.11. Fixes #18412.

    • [renodr] - Update to VIM-9.0.1677 (sync to LFS).

    • [renodr] - Update to libsndfile-1.2.2. Fixes #18411.

    • [renodr] - Update to mc-4.8.30. Fixes #18410.

    • [renodr] - Update to libadwaita-1.3.4. Fixes #18409.

    • [timtas] - Update to openldap-2.6.6. Fixes #18361.

  • August 13th, 2023

    • [thomas] - Update to openssh-9.4p1 and ssh-askpass-9.4p1. Fixes #18397.

    • [renodr] - Update to gtkmm-3.24.8. Fixes #18402.

    • [renodr] - Update to libcloudproviders-0.3.2. Fixes #18399.

    • [renodr] - Update to cmake-3.27.2. Fixes #18400.

    • [renodr] - Update to JSON-C-0.17. Fixes #18407.

    • [renodr] - Update to libsecret-0.21.0. Fixes #18406.

    • [renodr] - Update to Text-CSV-2.03 (Perl Module). Fixes #18405.

    • [renodr] - Update to Text-CSV_XS-1.51 (Perl Module). Fixes #18405.

    • [renodr] - Update to boost-1.83.0. Fixes #18404.

  • August 12th, 2023

    • [ken] - Change the context note in texlive source to say the fix for 'mkiv' will be removed when texlive next requires an update. Addresses #18349.

    • [renodr] - Update to WebKitGTK+-2.41.90. Fixes #18403.

  • August 11th, 2023

    • [renodr] - Update to node.js-18.17.1 (Security Update). Fixes #18395.

    • [renodr] - Update to postgresql-15.4 (Security Update). Fixes #18401.

    • [renodr] - Update to NetworkManager-1.44.0. Fixes #18396.

    • [renodr] - Update to intel-gmmlib-22.3.10. Fixes #18398.

  • August 9th, 2023

    • [renodr] - Update to unixODBC-2.3.12. Fixes #18394.

    • [renodr] - Update to fuse-3.16.1. Fixes #18393.

  • August 8th, 2023

    • [renodr] - Enable the bubblewrap sandbox in WebKitGTK+. This should reduce the impact of future security vulnerabilities in this package. Fixes #18391.

    • [renodr] - Add xdg-user-proxy in support of allowing sandboxing in WebKitGTK+.

    • [ken] - Fix fontforge ftbfs with gettext-0.22. Fixes #18392.

    • [renodr] - Update to mercurial-6.5.1. Fixes #18389.

    • [bdubbs] - Update to gtk-4.12.0. Fixes #18386.

    • [renodr] - Update to intel-media-driver-23.3.1. Fixes #18390.

  • August 7th, 2023

    • [renodr] - Update to gvfs-1.50.6. Fixes #18387.

    • [renodr] - Update to vala-0.56.10. Fixes #18385.

    • [renodr] - Update to Pygments-2.16.1 (Python Module). Fixes #18384.

    • [renodr] - Update to gedit-46.1. Fixes #18383.

    • [renodr] - Update to rustc-1.71.1 (Security Update). Fixes #18382.

    • [ken] - Update to qtwebengine-5.15.15 (security fixes). Fixes #18331.

  • August 6th, 2023

    • [renodr] - Update to gnome-terminal-3.48.2. Fixes #18378.

    • [renodr] - Fix security vulnerabilities in WebKitGTK+ and runtime issues in VMs. Fixes #18375.

    • [bdubbs] - Add a patch from upstream that allows ffmpeg-6.0 to build with binutils-2.41. Fixes #18367.

  • August 5th, 2023

    • [bdubbs] - Update to pipewire-0.3.77. Fixes #18379.

    • [bdubbs] - Update to mesa-23.1.5. Fixes #18372.

  • August 4th, 2023

    • [bdubbs] - Update to gnutls-3.8.1. Fixes #18377.

    • [bdubbs] - Update to SDL2-2.28.2. Fixes #18373.

    • [bdubbs] - Update to unrar-6.2.10. Fixes #18371.

    • [bdubbs] - Update to sg3_utils-1.48. Fixes #18370.

    • [bdubbs] - Update to LVM2.2.03.22. Fixes #18369.

    • [renodr] - Update to seamonkey-2.53.17 (Security Update). Fixes #18362.

    • [renodr] - Update to mariadb-10.11.4 (Security Update). Fixes #18374.

  • August 3rd, 2023

    • [bdubbs] - Update to polkit-123. Fixes #18345.

    • [renodr] - Update to poppler-23.08.0. Fixes #18364.

    • [renodr] - Update to smartmontools-7.4. Fixes #18363.

    • [renodr] - Update to harfbuzz-8.1.1. Fixes #18359.

    • [renodr] - Update to emacs-29.1. Fixes #18356.

    • [renodr] - Update to sphinx-7.1.2. Fixes #18365.

  • August 2nd, 2023

    • [renodr] - Update to gedit-46.0. Fixes #18350.

    • [renodr] - Update to tepl-6.8.0. Fixes #18357.

    • [renodr] - Update to libgedit-amtk-5.8.0. Fixes #18366.

    • [renodr] - Update to libgedit-gtksourceview-299.0.4. Fixes #18353.

  • August 1st, 2023

    • [renodr] - Update to epiphany-44.6. Fixes #18352.

    • [renodr] - Update to libarchive-3.7.1. Fixes #18351.

    • [bdubbs] - Update to numpy-1.25.2 (Python module). Fixes #18360.

    • [bdubbs] - Update to pyparsing-3.1.1 (Python module). Fixes #18355.

    • [renodr] - Document some of GDM's behavior with NVIDIA GPUs, and a potential workaround if users wish to try it. Fixes #18266.

    • [ken] - Update to firefox-115.1.0esr (security update). Fixes #18310.

  • July 31st, 2023

    • [ken] - Update to Net-HTTP-6.23 (perl module). Fixes #18358.

  • July 30th, 2023

    • [ken] - Update to dvisvgm-3.1. Fixes #18265.

    • [bdubbs] - Update to pipewire-0.3.76. Fixes #18348.

    • [bdubbs] - Update to mlt-7.18.0. Fixes #18347.

    • [bdubbs] - Update to gspell-1.12.2. Fixes #18346.

    • [bdubbs] - Update to gcc-13.2.0. Fixes #18341.

  • July 28th, 2023

    • [xry111] - Update to systemd-254 (sync with LFS). Fixes #18344.

    • [bdubbs] - Update to btrfs-progs-v6.3.3. Fixes #18340.

    • [renodr] - Update to nss-3.92. Fixes #18339.

    • [renodr] - Update to sphinx-7.1.1 (Python Module). Fixes #18343.

    • [renodr] - Update to python-dbusmock-0.29.1 (Python Module). Fixes #18342.

  • July 27th, 2023

    • [bdubbs] - Update to umockdev-0.17.18. Fixes #18338.

  • July 26th, 2023

    • [renodr] - Update to gexiv2-0.14.2. Fixes #18337.

    • [renodr] - Update to cmake-3.27.1. Fixes #18336.

    • [renodr] - Update to curl-8.2.1 (Security Update). Fixes #18315.

  • July 25th, 2023

    • [bdubbs] - Update to qca-2.3.7. Fixes #18334.

    • [bdubbs] - Update to sudo-1.9.14p3. Fixes #18333.

    • [bdubbs] - Update to sphinx-7.1.0 (Python module). Fixes #18335.

  • July 24th, 2023

    • [bdubbs] - Update to inkscape-1.3. Fixes #18332.

  • July 23rd, 2023

    • [renodr] - Update to pipewire-0.3.75. Fixes #18330.

    • [renodr] - Update to icewm-3.4.1. Fixes #18329.

    • [renodr] - Update to glu-9.0.3. Fixes #18328.

    • [renodr] - Update to mesa-23.1.4. Fixes #18325.

    • [bdubbs] - Update to libreoffice-7.5.5.2. Fixes #18322.

    • [renodr] - Update the gstreamer and plugins to 1.22.5 (Security Update). Fixes #18318.

    • [renodr] - Update to librsvg-2.56.3 (Security Update). Fixes #18327.

    • [renodr] - Update to libblockdev-3.0.2. Fixes #18319.

    • [renodr] - Update to talloc-2.4.1. Fixes #18320.

    • [renodr] - Update to libshumate-1.0.5. Fixes #18321.

    • [renodr] - Update to unrar-6.2.9. Fixes #18324.

  • July 22nd, 2023

    • [renodr] - Update to OpenJDK-20.0.2 (Security Update). Fixes #18317.

  • July 21st, 2023

    • [renodr] - Update to WebKitGTK+-2.41.6 (Security Update). Fixes #18255.

    • [renodr] - Update to samba-4.18.5 (Security Update). Fixes #18257.

    • [renodr] - Update to dhcpcd-10.0.2. Fixes #18314.

    • [renodr] - Update to fuse3-3.15.1. Fixes #18306.

    • [rahul] - Add the TearFree patch to xorg-server. Fixes #18316.

  • July 20th, 2023

    • [bdubbs] - Update to bind-9.18.17. Fixes #18313.

    • [bdubbs] - Update to xfsprogs-6.4.0. Fixes #18312.

    • [bdubbs] - Update to openssh-9.3p2 (Security Update). Fixes #18311.

    • [bdubbs] - Update to cmake-3.27.0. Fixes #18309.

    • [bdubbs] - Update to node-18.17.0. Fixes #18308.

  • July 19th, 2023

    • [bdubbs] - Update to libarchive-3.7.0. Fixes #18307.

    • [bdubbs] - Update to PyYAML-6.0.1. Fixes #18304.

    • [bdubbs] - Update to highlight-4.7. Fixes #18302.

    • [bdubbs] - Update to sudo-1.9.14p2. Fixes #18300.

    • [bdubbs] - Update to stunnel-5.70. Fixes #18296.

    • [bdubbs] - Update to nghttp2-1.55.1 (Security Update). Fixes #18295.

    • [bdubbs] - Update to wireshark-4.0.7 (Security Update). Fixes #18294.

    • [bdubbs] - Update to libva-2.19.0. Fixes #18293.

  • July 18th, 2023

    • [bdubbs] - Update to LWP (libwww-perl-6.72). Fixes #18305.

    • [bdubbs] - Update to krb5-1.21.1 (Security Update). Fixes #18288.

    • [bdubbs] - Add LXQt Desktop and Applications chapters.

    • [bdubbs] - Add sddm (display manager) page.

    • [bdubbs] - Add sddm qt-alternate and qt-components pages.

    • [renodr] - Update to cheese-44.1. Fixes #18301.

    • [renodr] - Update to epiphany-44.5. Fixes #18263.

    • [renodr] - Update to intel-media-driver-23.3.0. Fixes #18299.

    • [renodr] - Update to intel-gmmlib-22.3.9. Fixes #18298.

  • July 17th, 2023

    • [bdubbs] - Update to liblinear-247. Fixes #18281.

    • [bdubbs] - Update to libbytesize-2.9. Fixes #18259.

    • [bdubbs] - Update to libblockdev-3.0.1. Fixes #18256.

    • [bdubbs] - Update to gnupg-2.4.3. Fixes #18250.

    • [xry111] - Archive xf86-video-*. Fixes #18267.

    • [bdubbs] - Update to LMDB_0.9.31. Fixes #18290.

    • [bdubbs] - Update to qpdf-11.5.0. Fixes #18282.

    • [bdubbs] - Update to harfbuzz-8.0.1. Fixes #18278.

    • [bdubbs] - Update to xapian-core-1.4.23. Fixes #18270.

    • [bdubbs] - Update to exempi-2.6.4. Fixes #18269.

  • July 15th, 2023

    • [xry111] - Update to rustc-1.71.0. Fixes #18297.

  • July 12th, 2023

    • [timtas] - Update to thunderbird-115.0. Fixes #18275.

    • [pierre] - Update to mercurial-6.5. Fixes #18261.

    • [pierre] - Update to glib-2.76.4. Fixes #18291.

    • [pierre] - Update to sudo-1.9.14p1. Fixes #18289.

    • [pierre] - Update to graphviz-8.1.0. Fixes #18271.

    • [pierre] - Update to gpgme-1.21.0. Fixes #18268.

    • [pierre] - Update to pipewire-0.3.74. Fixes #18264.

    • [pierre] - Update to inih-57. Fixes #18260.

    • [ken] - Update to firefox-115.0.2esr (Security fix). Fixes #18276.

  • July 11th, 2023

    • [renodr] - Update to libgudev-238. Fixes #18287.

    • [rahul] - Update to upower-1.90.2. Fixes #18251.

    • [pierre] - Update to qemu-8.0.3. Fixes #18277.

    • [rahul] - Update to libshumate-1.0.4. Fixes #18284.

    • [timtas] - Update to openldap-2.6.5. Fixes #18285.

    • [thomas] - Update to xterm-384. Fixes #18286.

    • [thomas] - Update to php-8.2.8. Fixes #18262.

  • July 10th, 2023

    • [renodr] - Update to LWP-Protocol-https-6.11 (Perl Module, Security Update). Fixes #18283.

    • [renodr] - Update to Test-Differences-0.70 (Perl Module). Fixes #18272.

    • [renodr] - Update to numpy-1.25.1 (Python Module). Fixes #18279.

    • [renodr] - Update to lxml-4.9.3 (Python Module). Fixes #18253.

    • [renodr] - Update to Cython-0.29.36 (Python Module). Fixes #18252.

  • July 9th, 2023

    • [pierre] - Update to mutter-44.3. Fixes #18274.

    • [pierre] - Update to gnome-shell-44.3. Fixes #18273.

  • July 8th, 2023

    • [thomas] - Add ISC-Kea DHCP Server 2.4.0 (and its dependency log4cplus) which is the successor of the ISC dhcpd. Fixes #18160.

  • July 6th, 2023

    • [renodr] - Update to gnome-maps-44.3. Fixes #18239.

    • [renodr] - Update to evince-44.3. Fixes #18238.

    • [renodr] - Update to eog-44.3. Fixes #18237.

    • [renodr] - Update to gnome-user-docs-44.3. Fixes #18236.

    • [renodr] - Update to gvfs-1.50.5. Fixes #18235.

    • [renodr] - Update to evolution and evolution-data-server 3.48.4. Fixes #18232.

    • [renodr] - Update to epiphany-44.4. Fixes #18228.

    • [renodr] - Update to gnome-control-center-44.3. Fixes #18227.

    • [renodr] - Update to tepl-6.6.0. Fixes #18226.

    • [renodr] - Update to opencv-4.8.0. Fixes #18213.

    • [renodr] - Update to gstreamer and plugins 1.22.4 (Security Update). Fixes #18190.

    • [renodr] - Update to jdk-20.0.1 (Security Update). Fixes #18192.

  • July 5th, 2023

    • [renodr] - Update to intel-media-driver-23.2.4. Fixes #18254.

    • [ken] - Update to ImageMagick-7.1.1-12 (Security fix). Fixes #18204.

  • July 4th, 2023

    • [ken] - Update to JS-102.13.0 (Security fix). Fixes #18248.

    • [ken] - Update to firefox-115.0esr (Security fix). Fixes #18220. Please read that ticket or the Editor Notes for information on minimum dependencies if updating older systems.

    • [timtas] - Update to xfce4-settings-4.18.3. Fixes #18249.

    • [renodr] - Fix building xfsprogs-6.3.0 with gettext-0.22.

    • [bdubbs] - Update to wayland-protocols-1.32. Fixes #18247.

    • [bdubbs] - Update to libqalculate-4.7.0. Fixes #18246.

    • [bdubbs] - Update to vala-0.56.9. Fixes #18245.

    • [bdubbs] - Update to poppler-23.07.0. Fixes #18244.

    • [bdubbs] - Update to libjpeg-turbo-3.0.0. Fixes #18243.

  • July 3rd, 2023

    • [bdubbs] - Update to taglib-1.13.1. Fixes #18234.

    • [bdubbs] - Update to SDL2-2.28.1. Fixes #18233.

    • [bdubbs] - Update to bluez-5.68. Fixes #18229.

    • [bdubbs] - Update to libuv-v1.46.0. Fixes #18225.

    • [bdubbs] - Update to libpaper-2.1.1. Fixes #18224.

    • [bdubbs] - Update to p11-kit-0.25.0. Fixes #18219.

    • [bdubbs] - Update to glib-networking-2.76.1. Fixes #18217.

    • [bdubbs] - Update to NetworkManager-1.42.8. Fixes #18215.

  • July 1st, 2023

    • [xry111] - Update to librsvg-2.56.2. Fixes #18231.

    • [timtas] - Update to nss-3.91. Fixes #18218.

  • June 30th, 2023

    • [bdubbs] - Update to udisks-2.10.0. Fixes #18214.

    • [bdubbs] - Update to libblockdev-3.0. Fixes #18216.

    • [bdubbs] - Add libnvme-1.5 in support of libblockdev.

  • June 29th, 2023

    • [bdubbs] - Update to libwebp-1.3.1. Fixes #18212.

    • [bdubbs] - Update to xterm-383. Fixes #18210.

    • [timtas] - Mention how to build samba without dbus.

    • [timtas] - Update to sudo-1.9.14. Fixes #18209.

  • June 27th, 2023

    • [renodr] - Fix building gexiv2 on i686 systems. Fixes #18208.

    • [renodr] - Update the systemd-units tarball to 20230627.

    • [bdubbs] - Update to pipewire-0.3.72. Fixes #18207.

  • June 26th, 2023

    • [bdubbs] - Update to gedit-45.0. Fixes #18202.

    • [bdubbs] - Update to tepl-6.5.1 in support of gedit.

    • [bdubbs] - Add libgedit-gtksourceview in support of tepl and gedit.

    • [bdubbs] - Update to flac-1.4.3. Fixes #18201.

    • [bdubbs] - Update to mercurial-6.4.5. Fixes #18196.

    • [renodr] - Update to ghostscript-10.01.2. Fixes #18194.

    • [renodr] - Update to libpng-1.6.40. Fixes #18195.

    • [renodr] - Update to freetype-2.13.1. Fixes #18203.

    • [renodr] - Update to pytest-7.4.0 (Python Module). Fixes #18200.

    • [rahul] - Update to gegl-0.4.46. Fixes #18206.

  • June 25th, 2023

    • [renodr] - Fix building ncftp with GCC-13/clang-16. Fixes #18205.

    • [timtas] - Update to mesa-23.1.3. Fixes #18197.

  • June 23rd, 2023

    • [renodr] - Update to BIND-9.18.16 (Security Update). Fixes #18193.

    • [renodr] - Update to node.js-18.16.1 (Security Update). Fixes #18187.

    • [renodr] - Update to cups-2.4.6 (Security Update). Fixes #18198.

    • [ken] - Remove obsolete optional exiv2 dependency from gegl-0.4.44. Fixes #18199.

    • [thomas] - Update to libburn-1.5.6, libisofs-1.5.6 and libisoburn-1.5.6. Fixes #18191.

  • June 22nd, 2023

    • [renodr] - Update to libksba-1.6.4. Fixes #18185.

    • [renodr] - Update to libassuan-2.5.6. Fixes #18184.

    • [renodr] - Update to libwww-perl-6.71 (Perl Module). Fixes #18188.

    • [renodr] - Update to pycairo-1.24.0 (Python Module). Fixes #18186.

    • [renodr] - Update to SDL2-2.28.0. Fixes #18172.

  • June 19th, 2023

    • [renodr] - Update to evince-44.2. Fixes #18183.

    • [renodr] - Update to pyparsing-3.1.0 (Python Module). Fixes #18182.

    • [renodr] - Update to NumPy-1.25.0 (Python Module). Fixes #18181.

    • [bdubbs] - Update to btrfs-progs-v6.3.2. Fixes #18176.

  • June 17th, 2023

    • [renodr] - Update to gnome-video-effects-0.6.0. Fixes #18171.

    • [renodr] - Update to tiff-4.5.1. Fixes #18170.

    • [renodr] - Fix CVE-2023-24805 in cups-filters. Fixes #18180.

    • [pierre] - Update to mupdf-1.22.2. Fixes #18178

    • [pierre] - Update to xorgproto-2023.2. Fixes #18177

    • [pierre] - Update to gjs-1.76.2. Fixes #18175

  • June 16th, 2023

    • [rahul] - Update libX11 to 1.8.6 (Security Update). Fixes #18174

  • June 15th, 2023

    • [renodr] - Update to Thunderbird-102.12.0 (Security Update). Fixes #18036.

    • [renodr] - Update to WebKitGTK+-2.41.5 to fix problems with screen flickering on Intel GPUs. Fixes #18051.

  • June 14th, 2023

    • [bdubbs] - Update to cups-2.4.5. Fixes #18169.

    • [bdubbs] - Update to icu4c-73_2. Fixes #18168.

  • June 13th, 2023

    • [ken] - Update to asymptote-2.86. Fixes #18148.

    • [pierre] - Update to qt5-5.15.10. Fixes #18144.

  • June 12th, 2023

    • [bdubbs] - Update to gjs-1.76.1. Fixes #18166.

    • [bdubbs] - Update to xkeyboard-config-2.39. Fixes #18165.

    • [bdubbs] - Update to pytest-7.3.2 (Python module). Fixes #18162.

    • [bdubbs] - Update to libreoffice-7.5.4.2. Fixes #18153.

  • June 11th, 2023

    • [renodr] - Update to fuse-3.15.0. Fixes #18159.

    • [renodr] - Update to libadwaita-1.3.3. Fixes #18163.

  • June 10th, 2023

    • [bdubbs] - Update to libgusb-0.4.6. Fixes #18155.

    • [bdubbs] - Update to mesa-23.1.2. Fixes #18154.

    • [bdubbs] - Update to cachecontrol-0.13.1. Fixes #18151.

    • [bdubbs] - Update to php-8.2.7. Fixes #18150.

    • [bdubbs] - Update to mercurial-6.4.4. Fixes #18149.

    • [bdubbs] - Update to nghttp2-1.54.0. Fixes #18147.

    • [thomas] - Add a sed to poppler to fix a build issue on 32-bit systems.

  • June 9th, 2023

    • [bdubbs] - Update to python3-3.11.4. Fixes #18145.

    • [bdubbs] - Update to dbus-1.14.8. Fixes #18141.

    • [renodr] - Update to intel-gmmlib-22.3.7. Fixes #18140.

    • [renodr] - Update to sendmail-8.17.2. Fixes #18131.

    • [renodr] - Update to gucharmap-15.0.4. Fixes #17815.

    • [renodr] - Update to gnome-weather-44.0. Fixes #17840.

    • [renodr] - Update to gnome-terminal-3.48.1. Fixes #17814.

    • [renodr] - Add a patch to Desktop File Utils to handle the SingleMainWindow key. Fixes #17925.

    • [renodr] - Update to gnome-system-monitor-44.0. Fixes #17813.

    • [renodr] - Update to gnome-maps-44.2. Fixes #17827.

    • [renodr] - Update to gnome-disk-utility-44.0. Fixes #17802.

    • [renodr] - Update to gnome-calculator-44.0. Fixes #17812.

    • [renodr] - Update to evolution-3.48.3. Fixes #17808.

    • [renodr] - Update to evolution-data-server-3.48.3. Fixes #17808.

    • [renodr] - Update to evince-44.1. Fixes #17826.

    • [renodr] - Update to eog-44.2. Fixes #17825.

    • [renodr] - Update to cheese-44.0.1. Fixes #17920.

    • [renodr] - Update to baobab-44.0. Fixes #17839.

    • [renodr] - Update to gdm-44.1. Fixes #18013.

    • [renodr] - Update to gnome-user-docs-44.1. Fixes #18158.

    • [renodr] - Update to gnome-session-44.0. Fixes #18157.

    • [renodr] - Update to gnome-shell-extensions-44.0. Fixes #17836.

    • [renodr] - Update to gnome-shell-44.2. Fixes #17836.

    • [renodr] - Update to mutter-44.2. Fixes #17835.

    • [renodr] - Update to gnome-control-center-44.2. Fixes #17811.

    • [renodr] - Update to gnome-settings-daemon-44.1. Fixes #17834.

  • June 8th, 2023

    • [bdubbs] - Update to sphinx_rtd_theme-1.2.2. Fixes #18146.

    • [bdubbs] - Update to gtk-4.10.4. Fixes #18143.

    • [bdubbs] - Update to xwayland-23.1.2. Fixes #18142.

    • [bdubbs] - Update to krb5-1.21. Fixes #18139.

    • [bdubbs] - Update to poppler-23.06.0. Fixes #18137.

    • [bdubbs] - Update to xorgproto-2023.1. Fixes #18136.

    • [bdubbs] - Update to nss-3.90. Fixes #18135.

    • [bdubbs] - Update to icewm-3.4.0. Fixes #18134.

    • [bdubbs] - Update to bluefish-2.2.14. Fixes #18129.

    • [bdubbs] - Update to cups-2.4.4. Fixes #18125.

    • [timtas] - Update to nettle-3.9.1. Fixes #18119.

    • [thomas] - Update to postfix-3.8.1. Fixes #18138.

  • June 7th, 2023

    • [bdubbs] - Update to librsvg-2.56.1. Fixes #18118.

    • [bdubbs] - Update to rustc-1.70.0. Fixes #18122.

    • [bdubbs] - Update to llvm-16.0.5. Fixes #18127.

    • [renodr] - Update to nautilus-44.2.1. Fixes #17810.

    • [renodr] - Update to gvfs-1.50.4. Fixes #17809.

    • [renodr] - Update to gnome-backgrounds-44.0. Fixes #17833.

  • June 6th, 2023

    • [bdubbs] - Update to vte-0.70.2. Fixes #18124.

    • [bdubbs] - Update to ntp-4.2.8p17. Fixes #18123.

    • [bdubbs] - Update to tree-2.1.1. Fixes #18117.

    • [bdubbs] - Update to cachecontrol-0.13.0.tar.gz (Python module). Fixes #18115.

    • [bdubbs] - Update to unrar-6.2.8. Fixes #18114.

    • [ken] - Update to firefox-102.12.0 (security update) and JS-102.12.0. Fixes #18110.

  • June 5th, 2023

    • [bdubbs] - Update to serf-1.3.10. Fixes #18113.

    • [bdubbs] - Update to gnupg-2.4.2. Fixes #18106.

    • [bdubbs] - Update to gc-8.2.4. Fixes #18103.

    • [bdubbs] - Update to xfce4-pulseaudio-plugin-0.4.7. Fixes #18111.

    • [bdubbs] - Update to xfce4-session-4.18.3. Fixes #18100.

    • [renodr] - Update to intel-media-driver-23.2.3. Fixes #18064.

  • June 4th, 2023

    • [bdubbs] - Update to xwd-1.0.9 (Xorg App). Fixes #18133.

    • [bdubbs] - Update to xrdb-1.2.2 (Xorg App). Fixes #18132.

    • [bdubbs] - Delete obsolete Xorg Library libdmx. Fixes #18128.

    • [bdubbs] - Update to xtrans-1.5.0 (Xorg Library). Fixes #18128.

    • [bdubbs] - Update to libX11-1.8.5 (Xorg Library). Fixes #18112.

    • [bdubbs] - Update to MarkupSafe-2.1.3 (Python Module). Fixes #18126.

    • [bdubbs] - Update to Net-DNS-1.39 (Perl Module). Fixes #18120.

    • [bdubbs] - Update to xterm-382. Fixes #18107.

    • [bdubbs] - Update to curl-8.1.2. Fixes #18104.

    • [bdubbs] - Update to btrfs-progs-v6.3.1. Fixes #18101.

  • June 2nd, 2023

    • [timtas] - Update to git-2.41.0. Fixes #18121.

  • June 1st, 2023

    • [timtas] - Update to qemu-8.0.2. Fixes #18102.

    • [renodr] - Update to tracker-miners-3.5.2. Fixes #17832.

    • [renodr] - Update to tracker-3.5.3. Fixes #17832.

    • [renodr] - Update to evolution-data-server-3.48.2. Partially fixes #17808.

    • [renodr] - Update to libpeas-1.36.0. Fixes #17807.

    • [xry111] - Update to libssh2-1.11.0. Fixes #18105.

  • May 31st, 2023

    • [timtas] - Update to xfce4-power-manager-4.18.2. Fixes #18108.

    • [timtas] - Update to samba-4.18.3. Fixes #18109.

    • [pierre] - Fix building gwenview and libkexiv2 against exiv2-0.28.

  • May 30th, 2023

    • [bdubbs] - Update to webkitgtk-2.40.2. Fixes #18099.

  • May 29th, 2023

    • [pierre] - Update to at-spi2-core-2.48.3. Fixes #18098.

    • [pierre] - Update to xterm-381. Fixes #18097.

    • [pierre] - Update to gdb-13.2. Fixes #18096.

    • [pierre] - Update to epiphany-44.3. Fixes #18095.

    • [pierre] - Update to vala-0.56.8. Fixes #18094.

    • [bdubbs] - Update to vim-9.0.1503. Addresses #12241.

  • May 28th, 2023

    • [bdubbs] - Update to glib-2.76.3. Fixes #18092.

    • [bdubbs] - Update to mesa-23.1.1. Fixes #18091.

  • May 27th, 2023

    • [pierre] - Update to gexiv2-0.14.1 (with a patch for exiv2-0.28). Fixes #18020.

  • May 26th, 2023

    • [bdubbs] - Update to sdl12-compat-release-1.2.64. Fixes #18090.

    • [bdubbs] - Update to exiv2-0.28.0. Fixes #18093.

    • [bdubbs] - Update to Cython-0.29.35 (Python module). Fixes #18089.

    • [ken] - Update how to list all configure options for firefox and thunderbird.

  • May 25th, 2023

    • [bdubbs] - Update to wireshark-4.0.6 (Security Fix). Fixes #18088.

  • May 24th, 2023

    • [renodr] - Update to grilo-0.3.16. Fixes #18035.

    • [renodr] - Update to gnome-online-accounts-3.48.0. Fixes #17806.

    • [renodr] - Update to gnome-desktop-44.0. Fixes #17831.

    • [renodr] - Update to gnome-autoar-0.4.4. Fixes #17805.

    • [bdubbs] - Update to sphinx_rtd_theme-1.2.1. Fixes #18087.

    • [bdubbs] - Update python sphinx dependencies to sphinxcontrib-jquery-4.1, sphinxcontrib-applehelp-1.0.4, and sphinxcontrib-htmlhelp-2.0.1.

    • [pierre] - Update to requests-2.31.0 (python module, security update). Fixes #18084.

    • [pierre] - Update to enchant-2.5.0. Fixes #18082.

    • [pierre] - Update to xfsprogs-6.3.0. Fixes #18081.

    • [pierre] - Update to nmap-7.94. Fixes #18076.

    • [pierre] - Update to qpdf-11.4.0. Fixes #18075.

    • [bdubbs] - Update to highlight-4.6. Fixes #18086.

  • May 23rd, 2023

    • [bdubbs] - Update to curl-8.1.1. Fixes #18085.

    • [bdubbs] - Update to gtk+3-3.24.38. Fixes #18083.

    • [timtas] - Update to xfce4-panel-4.18.4. Fixes #18079.

    • [timtas] - Update to libxfce4ui-4.18.4. Fixes #18078.

    • [bdubbs] - Update to gstreamer-1.22.3 and gst-plugins. Fixes #18073.

  • May 22nd, 2023

    • [bdubbs] - Update to libuv-1.45.0. Fixes #18074.

    • [bdubbs] - Update to pycryptodome-3.18.0 (Python module). Fixes #18072.

    • [bdubbs] - Update to double-conversion-3.3.0. Fixes #18071.

    • [ken] - Update to c-ares-1.19.1 (Security fix). Fixes #18077.

    • [bdubbs] - Update to icewm-3.3.5. Fixes #18068.

    • [bdubbs] - Update to doxygen-1.9.7. Fixes #18068.

    • [ken] - Perl modules - add Test::Deep, Test::Requires and URI as test dependencies for HTTP::CookieJar. Fixes #18080.

  • May 21st, 2023

    • [bdubbs] - Update to cmake-3.26.4. Fixes #18067.

    • [bdubbs] - Update to libwacom-2.7.0. Fixes #18066.

    • [bdubbs] - Update to pipewire-0.3.71. Fixes #18065.

    • [bdubbs] - Update to bind and bind utilities 9.18.15. Fixes #18063.

    • [bdubbs] - Update to llvm-16.0.4. Fixes #18061.

  • May 19th, 2023

    • [bdubbs] - Update to IO-Socket-SSL-2.083 (Perl Module). Fixes #18062.

    • [bdubbs] - Update to dos2unix-7.5.0. Fixes #18060.

    • [bdubbs] - Update to asciidoctor-2.0.20. Fixes #18059.

    • [bdubbs] - Update to docutils-0.20.1 (Python module). Fixes #18057.

    • [bdubbs] - Update to libcap-2.69. Fixes #18054.

    • [bdubbs] - Update to fribidi-1.0.13. Fixes #18055.

    • [bdubbs] - Update to unrar-6.2.7. Fixes #18049.

    • [bdubbs] - Update to lua-5.4.6. Fixes #18048.

    • [bdubbs] - Update to setxkbmap-1.3.4 (Xorg App). Fixes #18047.

  • May 17th, 2023

    • [bdubbs] - Update to nettle-3.9. Fixes #18046.

    • [bdubbs] - Update to at-spi2-core-2.48.2. Fixes #18041.

    • [bdubbs] - Update to php-8.2.6. Fixes #18039.

    • [timtas] - Update to curl-8.1.0. Fixes #18058.

    • [xry111] - Update to sqlite-autoconf-3420000 (3.42.0). Fixes #18056.

  • May 16th, 2023

    • [pierre] - Update to sphinx-7.0.1 (Python module). Fixes #18043.

    • [pierre] - Update to mupdf-1.22.1. Fixes #18038.

    • [pierre] - Update to docutils-0.20 (Python module). Fixes #18050.

  • May 15th, 2023

    • [bdubbs] - Update to mesa-23.1.0. Fixes #18034.

    • [timtas] - Update to ristretto-0.13.1. Fixes #18045.

  • May 14th, 2023

    • [bdubbs] - Update to plasma-5.27.5. Fixes #17685.

    • [bdubbs] - Update to kf5-gear-23.04.1 including kate, kwave, and falkon. Fixes #17741.

    • [bdubbs] - Update to kf5-5.106.0. Fixes #17778.

    • [xry111] - Update to llvm-16.0.3. Fixes #17861.

  • May 13th, 2023

    • [pierre] - Add HTTP::CookieJar-0.014 (perl module dependency) needed by libwww-perl-6.70.

    • [pierre] - Update to Business::ISBN::Data-20230426.001 (perl module dependency) because a newer version is needed by Business::ISBN-3.008. Fixes #18044.

  • May 12th, 2023

    • [ken] - Update to qtwebengine-5.15.14 (security fixes). Fixes #18024.

    • [timtas] - Update to postgresql-15.3. Fixes #18040.

    • [bdubbs] - Update to libaom-3.6.1. Fixes #18037.

    • [bdubbs] - Update to rpcsvc-proto-1.4.4. Fixes #18033.

    • [bdubbs] - Update to nghttp2-1.53.0. Fixes #18032.

    • [bdubbs] - Update to wget-1.21.4. Fixes #18031.

  • May 11th, 2023

    • [bdubbs] - Update to xterm-380. Fixes #18030.

    • [bdubbs] - Update to Net-DNS-1.38 (Perl module). Fixes #18029.

    • [bdubbs] - Update to harfbuzz-7.3.0. Fixes #18028.

  • May 9th, 2023

    • [timtas] - Update to Linux-PAM-1.5.3. Fixes #18025.

    • [ken] - Update to firefox-102.11.0 (with a sed for GCC-13) and JS-102.11.0 (both are Security fixes). Fixes #18022.

    • [ken] - Use a sed to fix libvdpau-va-gl-0.4.0 FTBFS with GCC-13. Fixes #18027.

    • [ken] - Patch texlive source for a security fix. #18006.

    • [bdubbs] - Update to libxslt-1.1.38. Fixes #18026.

  • May 8th, 2023

    • [ken] - Use a sed to fix pango-1.50.14 FTBFS with GCC-13. Fixes #18023.

    • [bdubbs] - Update to mlt-7.16.0. Fixes #18021.

  • May 7th, 2023

    • [pierre] - Use a sed to fix QT5-FTBFS with GCC-13. Fixes #18019.

    • [bdubbs] - Update to libwww-perl-6.70 (Perl module). Fixes #18018.

    • [bdubbs] - Update to nss-3.89.1. Fixes #18017.

    • [bdubbs] - Update to graphviz-8.0.5. Fixes #18015.

    • [bdubbs] - Update to babl-0.1.106. Fixes #18014.

    • [bdubbs] - Update to mercurial-6.4.3. Fixes #18007.

    • [bdubbs] - Update to libreoffice-7.5.3.2. Fixes #18011.

  • May 6th, 2023

    • [bdubbs] - Update to libevdev-1.13.1 (Xorg driver). Fixes #18010.

    • [bdubbs] - Update to libXi-1.8.1 (Xorg library). Fixes #18009.

    • [timtas] - Update to intel-media-23.2.1. Fixes #18016.

  • May 5th, 2023

    • [bdubbs] - Update to requests-2.30.0 (Python module). Fixes #18008.

    • [bdubbs] - Update to urllib3-2.0.2 (Python module). Required for requests-2.30.0.

    • [timtas] - Update to alsa-lib alsa-utils 1.2.9. Fixes #18012.

    • [timtas] - Update to xarchiver-0.5.4.21. Fixes #18005.

  • May 4th, 2023

    • [bdubbs] - Update to icewm-3.3.4. Fixes #18004.

  • May 3rd, 2023

    • [bdubbs] - Update to imlib2-1.11.1. Fixes #18003.

    • [bdubbs] - Update to poppler-23.05.0. Fixes #18002.

    • [bdubbs] - Update to qca-2.3.6. Fixes #18001.

    • [bdubbs] - Update to pciutils-3.10.0. Fixes #18000.

    • [bdubbs] - Update to cpio-2.14. Fixes #17999.

    • [bdubbs] - Update to libsoup3-3.4.2. Fixes #17998.

    • [bdubbs] - Update to gspell-1.12.1. Fixes #17997.

    • [bdubbs] - Update to audacious and audacious-plugins 4.3.1. Fixes #17995.

    • [bdubbs] - Update to sphinx-7.0.0 (Python module). Fixes #17994.

  • May 2nd, 2023

    • [bdubbs] - Update to iso-codes-4.15.0. Fixes #17992.

    • [bdubbs] - Update to valgrind-3.21.0. Fixes #17990.

    • [bdubbs] - Update to gnupg-2.4.1. Fixes #17989.

    • [bdubbs] - Update to btrfs-progs-v6.3. Fixes #17988.

  • May 1st, 2023

    • [bdubbs] - Update to gcc-13.1. Fixes #17983.

  • April 30th, 2023

    • [timtas] - Update to thunar-4.18.6. Fixes #17996.

  • April 29th, 2023

    • [timtas] - Update to thunar-4.18.5. Fixes #17991.

  • April 28th, 2023

    • [bdubbs] - Update to xinput-1.6.4 (xorg app). Fixes #17987.

    • [bdubbs] - Update to xdpyinfo-1.3.4 (xorg app). Fixes #17986.

    • [timtas] - Update to git-2.40.1. Fixes #17980.

  • April 27th, 2023

    • [ken] - in texlive (source) create config.cache. This saves significant time in a parallel build.

    • [renodr] - Update to xf86-video-ati-22.0.0 (Xorg Driver). Fixes #17981.

    • [bdubbs] - Update to harfbuzz-7.2.0. Fixes #17984.

    • [bdubbs] - Update to requests-2.29.0 (Python module). Fixes #17985.

    • [bdubbs] - Update to sphinx-6.2.1 (Python module). Fixes #17982.

  • April 24th, 2023

    • [timtas] - Update to thunderbird-102.10.1. Fixes #17979.

    • [bdubbs] - Update to glib-2.76.2. Fixes #17978.

  • April 23rd, 2023

    • [bdubbs] - Update to sphinx-6.2.0 (Python module). Fixes #17977.

    • [renodr] - Update to gsettings-desktop-schemas-44.0. Fixes #17830.

    • [renodr] - Update to vte-0.72.1. Fixes #17804.

    • [bdubbs] - Update to rustc-1.69.0. Fixes #17965.

    • [bdubbs] - Update to numpy-1.24.3 (Python module). Fixes #17974.

    • [renodr] - Update to libadwaita-1.3.2. Fixes #17976.

    • [renodr] - Update to gtk-4.10.3. Fixes #17975.

    • [renodr] - Update to NetworkManager-1.42.6. Fixes #17967.

    • [renodr] - Add webp-pixbuf-loader in support of EOG. Fixes #17923.

  • April 22nd, 2023

    • [bdubbs] - Update to LVM2.2.03.21. Fixes #17973.

    • [bdubbs] - Update to libsoup-3.4.1. Fixes #17972.

    • [bdubbs] - Update to Data-Compare-1.29 (Perl Module). Fixes #17971.

    • [bdubbs] - Update to gpgme-1.20.0. Fixes #17970.

  • April 21st, 2023

    • [renodr] - Update to epiphany-44.2. Fixes #17816.

    • [renodr] - Update to WebKitGTK+-2.40.1 (Security Update). Fixes #17801.

    • [bdubbs] - Update to pipewire-0.3.70. Fixes #17969.

    • [bdubbs] - Update to dhcpcd-10.0.1. Fixes #17966.

    • [timtas] - Update to mesa-23.0.3. Fixes #17968.

    • [bdubbs] - Update to python-dbusmock-0.29.0 (Python module). Fixes #17964.

    • [bdubbs] - Update to babl-0.1.104. Fixes #17963.

  • April 20th, 2023

    • [bdubbs] - Update to qemu-8.0.0. Fixes #17962.

    • [bdubbs] - Update to bind9 and bind 9.18.14. Fixes #17961.

    • [bdubbs] - Update to nfs-utils-2.6.3. Fixes #17960.

    • [bdubbs] - Update to vala-0.56.7. Fixes #17959.

    • [renodr] - Add libavif in support of WebKitGTK+. Fixes #17952.

    • [renodr] - Add libaom in support of libavif. Fixes #17953.

  • April 19th, 2023

    • [bdubbs] - Update to Pygments-2.15.1 (Python module). Fixes #17956.

    • [bdubbs] - Update to libqalculate-4.6.1. Fixes #17950.

    • [renodr] - Add unifdef into the book. Fixes #17924.

    • [renodr] - Update to gtksourceview5-5.8.0. Fixes #17817.

    • [renodr] - Update to libadwaita-1.3.1. Fixes #17818.

    • [renodr] - Update to sysprof-3.48.0. Fixes #17820.

    • [renodr] - Update to libsoup-3.4.0. Fixes #17821.

    • [renodr] - Update to gjs-1.76.0. Fixes #17824.

    • [renodr] - Update to pygobject-3.44.1 (Python Module). Fixes #17841.

    • [renodr] - Update to at-spi2-core-2.48.0. Fixes #17842.

    • [renodr] - Update to intel-media-driver-23.2.0. Fixes #17957.

    • [renodr] - Update the gstreamer stack to 1.22.2. Includes the base package and all of the plugins. Fixes #17921.

    • [timtas] - Update to transmission-4.0.3. Fixes #17937.

    • [renodr] - Update to network-manager-applet-1.32.0. Fixes #17951.

    • [renodr] - Update to samba-4.18.2. Fixes #17958.

  • April 18th, 2023

    • [pierre] - Patch qtwebengine for ICU-73. Fixes #17941.

    • [bdubbs] - Update to libXpm-3.5.16 (Xorg Library). Fixes #17949.

    • [bdubbs] - Update to libXft-2.3.8 (Xorg Library). Fixes #17948.

    • [bdubbs] - Update to umockdev-0.17.17. Fixes #17945.

    • [bdubbs] - Update to apr-1.7.4. Fixes #17944.

    • [bdubbs] - Update to postfix-3.8.0. Fixes #17943.

    • [bdubbs] - Update to graphviz-8.0.3. Fixes #17942.

    • [timtas] - Update to tumbler-4.18.1. Fixes #17947.

    • [timtas] - Update to xfconf-4.18.1. Fixes #17946.

  • April 17th, 2023

    • [bdubbs] - Update to php-8.2.5. Fixes #17935.

    • [bdubbs] - Update to mercurial-6.4.2. Fixes #17934.

  • April 15th, 2023

    • [bdubbs] - Update to dhcpcd-10.0.0. Fixes #17940.

    • [bdubbs] - Update to boost-1.82.0. Fixes #17939.

    • [bdubbs] - Update to mupdf-1.22.0. Fixes #17938.

    • [bdubbs] - Update to node-18.16.0. Fixes #17928.

    • [bdubbs] - Update to libpaper-2.1.0. Fixes #17927.

    • [bdubbs] - Update to icu4c-73.1. Fixes #17926.

    • [bdubbs] - Update to tcsh-6.24.10. Fixes #17933.

    • [bdubbs] - Update to pipewire-0.3.69. Fixes #17932.

    • [bdubbs] - Update to pytest-7.3.1 (Python module). Fixes #17936.

    • [bdubbs] - Update to packaging-23.1 (Python module). Fixes #17929.

  • April 14th, 2023

    • [bdubbs] - Update to Python-3.11.3. Fixes #17895.

  • April 13th, 2023

    • [renodr] - Update to Wireshark-4.0.5 (Security Update). Fixes #17930.

    • [renodr] - Update to libxml2-2.10.4 (Security Update). Fixes #17922.

    • [renodr] - Update to Thunderbird-102.10.0 (Security Update). Fixes #17931.

  • April 11th, 2023

    • [ken] - Remove unneeded mtxrun --generate from texlive. Fixes #17919.

    • [ken] - Update to firefox-102.10.0 and JS-102.10.0 (both are Security fixes). Fixes #17913.

    • [ken] - Patch libwebp-1.0.3 (Security fix). Fixes #17918.

  • April 10th, 2023

    • [bdubbs] - Update to Pygments-2.15.0 (Python Module). Fixes #17917.

    • [bdubbs] - Update to graphviz-8.0.2. Fixes #17916.

    • [bdubbs] - Update to tcsh-6.24.08. Fixes #17915.

    • [bdubbs] - Update to parted-3.6. Fixes #17914.

  • April 10th, 2023

    • [renodr] - Update to intel-media-driver-23.1.6. Fixes #17912.

    • [bdubbs] - Update to xwininfo-1.1.6 (Xorg app). Fixes #17911.

    • [bdubbs] - Update to libXfixes-6.0.1 (Xorg library). Fixes #17910.

    • [bdubbs] - Update to libXt-1.3.0 (Xorg library). Fixes #17909.

    • [bdubbs] - Update to icewm-3.3.3. Fixes #17908.

    • [pierre] - Update to Qt-5.15.9. Fixes #17900.

    • [renodr] - Update to xf86-input-wacom-1.2.0 (Xorg Driver). Fixes #17897.

    • [renodr] - Update to vala-0.56.6. Fixes #17896.

    • [renodr] - Update to graphviz-8.0.1. Fixes #17885.

    • [renodr] - Update to wayland-1.22.0. Fixes #17892.

    • [renodr] - Fix several bugs and incompatibilities with newer kernels in pm-utils.

  • April 9th, 2023

    • [bdubbs] - Update to libgcrypt-1.10.2. Fixes #17903.

    • [bdubbs] - Update to mesa-23.0.2. Fixes #17906.

    • [bdubbs] - Update to libpcap-1.10.4. Fixes #17905.

    • [bdubbs] - Update to pytest-7.3.0 (Python module). Fixes #17907.

  • April 8th, 2023

    • [renodr] - Update to libreoffice-7.5.2.2. Fixes #17883.

    • [renodr] - Update to libva-2.18.0. Fixes #17879.

  • April 7th, 2023

    • [bdubbs] - Update to pipewire-0.3.68. Fixes #17902.

    • [timtas] - Update to httpd-2.4.57. Fixes #17899.

    • [bdubbs] - Update to libgpg-error-1.47. Fixes #17904.

    • [bdubbs] - Update to feh-3.10. Fixes #17901.

    • [renodr] - Update to Seamonkey-2.53.16 (Security Update). Fixes #17884.

    • [bdubbs] - Change SDL-1.2 to sdl12-compat-release-1.2.60. Fixes #17898.

  • April 6th, 2023

    • [renodr] - Update to ruby-3.2.2 (Security Update). Fixes #17887.

    • [pierre] - Update to accountsservice-23.13.9. Fixes #17789.

    • [bdubbs] - Update to SDL2-2.26.5. Fixes #17894.

    • [bdubbs] - Update to xf86-input-libinput-1.3.0 (Xorg Driver). Fixes #17893.

    • [pierre] - Patch firefox for ffmpeg-6.0

  • April 4th, 2023

    • [bdubbs] - Update to poppler-23.04.0. Fixes #17890.

    • [bdubbs] - Update to cracklib-2.9.11. Fixes #17889.

    • [bdubbs] - Update to cmake-3.26.3. Fixes #17886.

  • April 3rd, 2023

    • [bdubbs] - Update to Cython-0.29.34 (Python module). Fixes #17891.

    • [bdubbs] - Update to libatomic_ops-7.8.0. Fixes #17876.

    • [bdubbs] - Update to libcap-2.68. Fixes #17865.

    • [bdubbs] - Update to libbytesize-2.8. Fixes #17854.

    • [renodr] - Update to intel-media-driver-23.1.5. Fixes #17878.

    • [bdubbs] - Update to sqlite-autoconf-3410200 (3.41.2). Fixes #17849.

    • [bdubbs] - Update to Business-ISBN-3.008 (Perl Module). Fixes #17855.

    • [bdubbs] - Update to SCons-4.5.2. Fixes #17848.

    • [bdubbs] - Update to links-2.29. Fixes #17847.

    • [renodr] - Fix building Thunderbird with rustc-1.68.x.

  • April 2nd, 2023

    • [bdubbs] - Update to wpebackend-fdo-1.14.2. Fixes #17846.

    • [bdubbs] - Update to adwaita-icon-theme-44.0. Fixes #17838.

    • [bdubbs] - Update to mpg123-1.31.3. Fixes #17828.

    • [pierre] - Update to xwayland-23.1.1 (security update). Fixes #17850.

    • [ken] - Update to mutt-2.2.10. Fixes #17863.

    • [ken] - Update to biber-2.19. Fixes #17757.

    • [ken] - Update to dvisvgm-3.0.4. Fixes #17775.

    • [ken] - Add a workaround to support (mkiv) context in texlive-2023. Addresses #17843.

    • [ken] - Update to texlive-2023 and 2023 install-tl-unx. Fixes #17823.

    • [ken] - Move creation of symlink for libkpathsea from pre-configure in dvisvgm to end of texlive (from source) so that an existing evince linked against the previous year's texlive has a chance to work.

  • April 1st, 2023

    • [pierre] - Remove flit_core from python dependencies; it is now in LFS.

    • [bdubbs] - Update to gpgme-1.19.0. Fixes #17803.

    • [bdubbs] - Update to glib-networking-2.76.0. Fixes #17800.

    • [bdubbs] - Update to php-8.2.4. Fixes #17798.

    • [bdubbs] - Update to gtk-4.10.1. Fixes #17792.

    • [timtas] - Update to apr-1.7.3. Fixes #17888.

  • March 31st, 2023

    • [pierre] - Update to glib-2.76.1. Fixes #17779.

  • March 30th, 2023

    • [renodr] - Update to rustc-1.68.2. Fixes #17877.

    • [renodr] - Update to Thunderbird-102.9.1 (Security Update). Fixes #17880.

    • [renodr] - Update to xorg-server-21.1.8 (Security Update). Fixes #17882.

    • [renodr] - Update to xfce4-pulseaudio-plugins-0.4.6. Fixes #17875.

    • [renodr] - Update to vala-0.56.5. Fixes #17868.

    • [renodr] - Update to gegl-0.4.44. Fixes #17867.

    • [renodr] - Update to fuse-3.14.1. Fixes #17866.

    • [renodr] - Update to gobject-introspection-1.76.1. Fixes #17853.

    • [renodr] - Update to Samba-4.18.1 (Security Update). Fixes #17881.

    • [renodr] - Update to gimp-2.10.34 and the associated new gimp-help that released alongside it. Fixes #17776.

    • [renodr] - Update to NetworkManager-1.42.4. Fixes #17771.

    • [timtas] - Really fix the transmission-4.0.2 webclient.

    • [timtas] - Update to transmission-4.0.2. Fixes #17795.

    • [pierre] - Update to libinput-1.23.0. Fixes #17869.

    • [pierre] - Update to btrfs-progs-6.2.2. Fixes #17862.

    • [pierre] - Update to xfsprogs-6.2.0. Fixes #17858.

    • [pierre] - Update to ghostscript-10.01.1 (Security Update). Fixes #17851.

    • [pierre] - Update to xwayland-23.1.0. Fixes #17850.

    • [pierre] - Update to lvm2-2.03.19. Fixes #17844.

    • [pierre] - Update to mesa-23.0.1. Fixes #17740.

  • March 28th, 2023

    • [ken] - The binary version of asy has been compiled against libGLX since 2020 - work around that in case anyone wishes to use it in future. Partly addresses #17823.

  • March 27th, 2023

    • [timtas] - Update to libxfce4ui-4.18.3. Fixes #17872.

    • [timtas] - Update to garcon-4.18.1. Fixes #17873.

    • [timtas] - Update to xfce4-panel-4.18.3. Fixes #17874.

    • [timtas] - Update to xfce4-session-4.18.2. Fixes #17871.

    • [renodr] - Update to curl-8.0.1 (Security Update). Fixes #17829.

  • March 26th, 2023

    • [renodr] - Update to mercurial-6.4. Fixes #17857.

    • [renodr] - Update to librsvg-2.56.0. Fixes #17819.

    • [renodr] - Update to rust-1.68.1. Fixes #17860.

    • [renodr] - Update to Thunderbird-102.9.0 (Security Update). Fixes #17794.

    • [renodr] - Fix crashes in gdb when debugging rust programs. Fixes #17864.

  • March 25th, 2023

    • [renodr] - Revert back to LLVM-15. Still leaves page modifications for LLVM-16 in place, just commented to make upgrading back to LLVM-16 easier. The revert is due to LLVM bugs leading to miscompilations in Thunderbird and Firefox. Fixes #17859.

  • Match 24th, 2023

    • [thomas] - Update to cmake-3.26.1. Fixes #17856.

  • Match 23rd, 2023

    • [renodr] - Fix building Seamonkey with LLVM-16. Fixes #17852.

    • [renodr] - Update to intel-media-driver-23.1.4. Fixes #17768.

    • [renodr] - Update to intel-gmmlib-22.3.5. Fixes #17845.

  • March 19th, 2023

    • [renodr] - Fix building Firefox with LLVM-16.

    • [thomas] - Update to bind-9.18.13, bind-utils-9.18.13. Fixes #17790.

    • [xry111] - Update to rustc-1.68.0. Fixes #17822.

    • [xry111] - Update to llvm-16.0.0. Fixes #17799.

  • March 17th, 2023

    • [bdubbs] - Update to openssh-9.3p1. Fixes #17796.

    • [bdubbs] - Update to Business-ISMN-1.203 (Perl module). Fixes #17797.

    • [bdubbs] - Update to kImageAnnotator-0.6.1. Fixes #17793.

    • [bdubbs] - Update to libXaw-1.0.15 (Xorg library). Fixes #17791.

    • [bdubbs] - Update to highlight-4.5. Fixes #17788.

    • [bdubbs] - Update to gobject-introspection-1.76.0. Fixes #17787.

    • [bdubbs] - Update to cracklib-2.9.10. Fixes #17748.

  • March 16th, 2023

    • [bdubbs] - Update to cmake-3.26.0. Fixes #17785.

    • [bdubbs] - Update to git-2.40.0. Fixes #17783.

    • [bdubbs] - Update to icewm-3.3.2. Fixes #17784.

    • [bdubbs] - Update to Data-Compare-1.28 (Perl module). Fixes #17786.

    • [bdubbs] - Update to Net-DNS-1.37 (Perl module). Fixes #17782.

    • [bdubbs] - Update to imlib2-1.11.0. Fixes #17777.

    • [bdubbs] - Update to pipewire-0.3.67. Fixes #17772.

  • March 14th, 2023

    • [ken] - Update to firefox-102.9.0esr and JS-102.9.0esr (both contain security fixes). Fixes #17781.

    • [thomas] - Update to sqlite-3.41.1. Fixes #17774.

  • March 13th, 2023

    • [timtas] - Update to samba-4.18.0. Fixes #17767.

  • March 12th, 2023

    • [ken] - Update to nss-3.89. Fixes #17773.

  • March 9th, 2023

    • [ken] - Update to qtwebengine-5.15.13 (Security Update). Fixes #17769.

    • [bdubbs] - Update to libpaper-2.0.10. Fixes #17770.

    • [bdubbs] - Update to cmake-3.25.3. Fixes #17766.

  • March 8th, 2023

    • [bdubbs] - Update to node-18.15.0. Fixes #17765.

    • [pierre] - Update to btrfs-progs-6.2.1. Fixes #17734.

    • [thomas] - Add a patch to fix gcc-go version string (part of gcc-12.2.0).

  • March 7th, 2023

    • [renodr] - Update to SCons-4.5.1. Fixes #17752.

    • [renodr] - Update to httpd-2.4.56 (Security Update). Fixes #17764.

    • [bdubbs] - Update to mlt-7.14.0. Fixes #17760.

    • [bdubbs] - Update to libqalculate-4.6.0. Fixes #17763.

    • [bdubbs] - Update to SDL2-2.26.4. Fixes #17761.

    • [bdubbs] - Update to gcr4-4.1.0. Fixes #17758.

    • [bdubbs] - Remove using the external ffmpeg from mplayer. Fixes #17751.

    • [thomas] - Update to sudo-1.9.13p3. Fixes #17762.

    • [thomas] - Update to tigervnc-1.13.1. Fixes #17759.

  • March 6th, 2023

    • [xry111] - Update to systemd-253. Fixes #17659.

    • [bdubbs] - Update to gstreamer-1.22.1 and plugins. Fixes #17747.

    • [renodr] - Update to libhandy-1.8.2. Fixes #17755.

    • [renodr] - Update to libadwaita-1.2.3. Fixes #17754.

    • [renodr] - Update to SCons-4.5.0. Fixes #17752.

    • [renodr] - Update to xfburn-0.7.0. Fixes #17446.

    • [bdubbs] - Update to audacious-4.3 and audacious-plugins-4.3. Fixes #17756.

    • [bdubbs] - Update to gtk-4.10.0. Fixes #17753.

    • [bdubbs] - Update to stunnel-5.69. Fixes #17749.

  • March 5th, 2023

    • [bdubbs] - Update to wpebackend-fdo-1.14.1. Fixes #17750.

    • [bdubbs] - Update to pango-1.50.14. Fixes #17745.

    • [bdubbs] - Update to gtk+-3.24.37. Fixes #17744.

    • [bdubbs] - Update to pytest-7.2.2 (Python module). Fixes #17743.

    • [bdubbs] - Update to mercurial-6.3.3. Fixes #17738.

    • [bdubbs] - Update to harfbuzz-7.1.0. Fixes #17737.

  • March 4th, 2023

    • [bdubbs] - Update to libreoffice-7.5.1.2. Fixes #17742.

  • March 3rd, 2023

    • [bdubbs] - Update to ffmpeg-6.0. Fixes #17729.

    • [bdubbs] - Update to raptor2-2.0.16. Fixes #17736.

    • [bdubbs] - Update to poppler-23.03.0. Fixes #17735.

    • [bdubbs] - Update to qpdf-11.3.0. Fixes #17710.

    • [bdubbs] - Update to node.js-18.14.2. Fixes #17694.

    • [bdubbs] - Update to LVM2.2.03.19. Fixes #17693.

    • [thomas] - Update to wireshark-4.0.4. Fixes #17739.

    • [timtas] - Update to v4l-utils-1.24.1. Fixes #17705.

  • March 2nd, 2023

    • [timtas] - Update to xfce4-notifyd-0.8.2. Fixes #17732.

    • [timtas] - Update to v4l-utils-1.24.0. Fixes #17705.

    • [timtas] - Update to libnotify-0.8.2. Fixes #17678.

    • [bdubbs] - Update to sudo-1.9.13p2. Fixes #17727.

    • [bdubbs] - Update to pango-1.50.13. Fixes #17688.

    • [bdubbs] - Update to ibus-1.5.28. Fixes #17686.

    • [bdubbs] - Update to gegl-0.4.42. Fixes #17682.

    • [bdubbs] - Update to babl-0.1.102. Fixes #17681.

    • [bdubbs] - Update to enchant-2.3.4. Fixes #17680.

    • [bdubbs] - Update to liblinear-246. Fixes #17676.

    • [renodr] - Update to glib-2.74.6. Fixes #17709.

    • [renodr] - Update to fetchmail-6.4.37. Fixes #17711.

    • [renodr] - Update to libass-0.17.1. Fixes #17712.

    • [renodr] - Update to bubblewrap-0.8.0. Fixes #17730.

    • [renodr] - Update to iso-codes-4.13.0. Fixes #17731.

    • [renodr] - Update to fuse-3.14.0. Fixes #17675.

    • [renodr] - Update to NetworkManager-1.42.2. Fixes #17703.

    • [renodr] - Update to gjs-1.74.2. Fixes #17704.

    • [renodr] - Update to bluefish-2.2.13. Fixes #17706.

    • [renodr] - Update to font-adobe-utopia-type1-1.0.5 (Xorg Font). Fixes #17715.

    • [renodr] - Update to font-alias-1.0.5 (Xorg Font). Fixes #17716.

    • [renodr] - Update to encodings-1.0.7 (Xorg Font). Fixes #17717.

    • [renodr] - Update to font-bh-ttf-1.0.4 (Xorg Font). Fixes #17718.

    • [renodr] - Update to font-bh-type1-1.0.4 (Xorg Font). Fixes #17719.

    • [renodr] - Update to font-ibm-type1-1.0.4 (Xorg Font). Fixes #17720.

    • [renodr] - Update to font-misc-ethiopic-1.0.5 (Xorg Font). Fixes #17725.

    • [renodr] - Update to font-xfree86-type1-1.0.5 (Xorg Font). Fixes #17726.

    • [renodr] - Update to bdftopcf-1.1.1 (Xorg Legacy). Fixes #17708.

    • [renodr] - Update to font-adobe-100dpi-1.0.4 (Xorg Legacy). Fixes #17713.

    • [renodr] - Update to font-adobe-75dpi-1.0.4 (Xorg Legacy). Fixes #17714.

    • [renodr] - Update to font-isas-misc-1.0.4 (Xorg Legacy). Fixes #17721.

    • [renodr] - Update to font-jis-misc-1.0.4 (Xorg Legacy). Fixes #17722.

    • [renodr] - Update to font-daewoo-misc-1.0.4 (Xorg Legacy). Fixes #17723.

    • [renodr] - Update to font-misc-misc-1.1.3 (Xorg Legacy). Fixes #17724.

    • [renodr] - Update to xbitmaps-1.1.3. Fixes #17702.

    • [renodr] - Update to xcursor-themes-1.0.7. Fixes #17701.

    • [renodr] - Update to harfbuzz-7.0.1. Fixes #17683.

    • [renodr] - Update to libwww-perl-6.68 (Perl Module). Fixes #17728.

    • [renodr] - Archive libdiscird. Fixes #17733.

    • [renodr] - Update to HTTP-Daemon-6.16 (Perl Module). Fixes #17707.

    • [timtas] - Update to mesa-22.3.6. Fixes #17697.

    • [thomas] - Upgrade sqlite-3.41.0. Fixes #17687.

  • March 1st, 2023

    • [xry111] - Separate intel-vaapi-driver from libva into its own section, and clarify it's used for "old" Intel GPUs.

    • [bdubbs] - Release of BLFS-11.3.

Mailing Lists

The linuxfromscratch.org server is hosting a number of mailing lists that are used for the development of the BLFS book. These lists include, among others, the main development and support lists.

For more information regarding which lists are available, how to subscribe to them, archive locations, etc., visit https://www.linuxfromscratch.org/mail.html.

Editor Notes

The BLFS Project has created a Wiki for editors to comment on pages and instructions at https://wiki.linuxfromscratch.org/blfs/wiki.

When editor notes are present, a link appears in the form https://wiki.linuxfromscratch.org/blfs/wiki/pkgname right below the dependency list. The idea behind the editor notes is to give additional information about the package and/or its build instructions, common pitfalls or maybe even more sophisticated configuration for special cases of use.

The vast majority of the packages do not have editor notes.

Note

The editor notes might be outdated. Even though the pages should be reviewed when a package is updated, it might happen that there are notes referring to an obsolete version and therefore, the notes might be out of date. Always check the date of the notes and more importantly, the version of the package the notes refer to.

Asking for Help and the FAQ

If you encounter a problem while using this book, and your problem is not listed in the FAQ (https://www.linuxfromscratch.org/faq), you will find that most of the people on Internet Relay Chat (IRC) and on the mailing lists are willing to help you. An overview of the LFS mailing lists can be found in Mailing lists. To assist us in diagnosing and solving your problem, include as much relevant information as possible in your request for help.

Things to Check Prior to Asking

Before asking for help, you should review the following items:

  • Is the hardware support compiled into the kernel or available as a module to the kernel? If it is a module, is it configured properly in modprobe.conf and has it been loaded? You should use lsmod as the root user to see if it's loaded. Check the sys.log file or run modprobe <driver> to review any error message. If it loads properly, you may need to add the modprobe command to your boot scripts.

  • Are your permissions properly set, especially for devices? LFS uses groups to make these settings easier, but it also adds the step of adding users to groups to allow access. A simple usermod -G audio <user> may be all that's necessary for that user to have access to the sound system. Any question that starts out with It works as root, but not as ... requires a thorough review of permissions prior to asking.

  • BLFS liberally uses /opt/<package>. The main objection to this centers around the need to expand your environment variables for each package placed there (e.g., PATH=$PATH:/opt/kde/bin). In most cases, the package instructions will walk you through the changes, but some will not. The section called Going Beyond BLFS is available to help you check.

Things to Mention

Apart from a brief explanation of the problem you're having, the essential things to include in your request are:

  • the version of the book you are using (being 12.0),

  • the package or section giving you problems,

  • the exact error message or symptom you are receiving,

  • whether you have deviated from the book or LFS at all,

  • if you are installing a BLFS package on a non-LFS system.

(Note that saying that you've deviated from the book doesn't mean that we won't help you. It'll just help us to see other possible causes of your problem.)

Expect guidance instead of specific instructions. If you are instructed to read something, please do so. It generally implies that the answer was way too obvious and that the question would not have been asked if a little research was done prior to asking. The volunteers in the mailing list prefer not to be used as an alternative to doing reasonable research on your end. In addition, the quality of your experience with BLFS is also greatly enhanced by this research, and the quality of volunteers is enhanced because they don't feel that their time has been abused, so they are far more likely to participate.

An excellent article on asking for help on the Internet in general has been written by Eric S. Raymond. It is available online at http://www.catb.org/~esr/faqs/smart-questions.html. Read and follow the hints in that document and you are much more likely to get a response to start with and also to get the help you actually need.

Credits

Many people have contributed both directly and indirectly to BLFS. This page lists all of those we can think of. We may well have left people out and if you feel this is the case, drop us a line. Many thanks to all of the LFS community for their assistance with this project.

Current Editors

  • Bruce Dubbs

  • Pierre Labastie

  • DJ Lucas

  • Ken Moffat

  • Douglas Reno

Contributors and Past Editors

The list of contributors is far too large to provide detailed information about the contributions for each contributor. Over the years, the following individuals have provided significant inputs to the book:

  • Timothy Bauscher

  • Daniel Bauman

  • Jeff Bauman

  • Andy Benton

  • Wayne Blaszczyk

  • Paul Campbell

  • Nathan Coulson

  • Jeroen Coumans

  • Guy Dalziel

  • Robert Daniels

  • Richard Downing

  • Manuel Canales Esparcia

  • Jim Gifford

  • Manfred Glombowski

  • Ag Hatzimanikas

  • Mark Hymers

  • James Iwanek

  • David Jensen

  • Jeremy Jones

  • Seth Klein

  • Alex Kloss

  • Eric Konopka

  • Larry Lawrence

  • Chris Lynn

  • Andrew McMurry

  • Randy McMurchy

  • Denis Mugnier

  • Billy O'Connor

  • Fernando de Oliveira

  • Alexander Patrakov

  • Olivier Peres

  • Andreas Pedersen

  • Henning Rohde

  • Matt Rogers

  • James Robertson

  • Henning Rohde

  • Chris Staub

  • Jesse Tie-Ten-Quee

  • Ragnar Thomsen

  • Thomas Trepl

  • Tushar Teredesai

  • Jeremy Utley

  • Zack Winkles

  • Christian Wurst

  • Igor Živković

General Acknowledgments

  • Fernando Arbeiza

  • Miguel Bazdresch

  • Gerard Beekmans

  • Oliver Brakmann

  • Jeremy Byron

  • Ian Chilton

  • David Ciecierski

  • Jim Harris

  • Lee Harris

  • Marc Heerdink

  • Steffen Knollmann

  • Eric Konopka

  • Scot McPherson

  • Ted Riley

Contact Information

Please direct your emails to one of the BLFS mailing lists. See Mailing lists for more information on the available mailing lists.

Chapter 2. Important Information

This chapter is used to explain some of the policies used throughout the book, to introduce important concepts and to explain some issues you may see with some of the included packages.

Notes on Building Software

Those people who have built an LFS system may be aware of the general principles of downloading and unpacking software. Some of that information is repeated here for those new to building their own software.

Each set of installation instructions contains a URL from which you can download the package. The patches; however, are stored on the LFS servers and are available via HTTP. These are referenced as needed in the installation instructions.

While you can keep the source files anywhere you like, we assume that you have unpacked the package and changed into the directory created by the unpacking process (the source directory). We also assume you have uncompressed any required patches and they are in the directory immediately above the source directory.

We can not emphasize strongly enough that you should start from a clean source tree each time. This means that if you have had an error during configuration or compilation, it's usually best to delete the source tree and re-unpack it before trying again. This obviously doesn't apply if you're an advanced user used to hacking Makefiles and C code, but if in doubt, start from a clean tree.

Building Software as an Unprivileged (non-root) User

The golden rule of Unix System Administration is to use your superpowers only when necessary. Hence, BLFS recommends that you build software as an unprivileged user and only become the root user when installing the software. This philosophy is followed in all the packages in this book. Unless otherwise specified, all instructions should be executed as an unprivileged user. The book will advise you on instructions that need root privileges.

Unpacking the Software

If a file is in .tar format and compressed, it is unpacked by running one of the following commands:

tar -xvf filename.tar.gz
tar -xvf filename.tgz
tar -xvf filename.tar.Z
tar -xvf filename.tar.bz2

Note

You may omit using the v parameter in the commands shown above and below if you wish to suppress the verbose listing of all the files in the archive as they are extracted. This can help speed up the extraction as well as make any errors produced during the extraction more obvious to you.

You can also use a slightly different method:

bzcat filename.tar.bz2 | tar -xv

Finally, sometimes we have a compressed patch file in .patch.gz or .patch.bz2 format. The best way to apply the patch is piping the output of the decompressor to the patch utility. For example:

gzip -cd ../patchname.patch.gz | patch -p1

Or for a patch compressed with bzip2:

bzcat ../patchname.patch.bz2 | patch -p1

Verifying File Integrity

Generally, to verify that the downloaded file is complete, many package maintainers also distribute md5sums of the files. To verify the md5sum of the downloaded files, download both the file and the corresponding md5sum file to the same directory (preferably from different on-line locations), and (assuming file.md5sum is the md5sum file downloaded) run the following command:

md5sum -c file.md5sum

If there are any errors, they will be reported. Note that the BLFS book includes md5sums for all the source files also. To use the BLFS supplied md5sums, you can create a file.md5sum (place the md5sum data and the exact name of the downloaded file on the same line of a file, separated by white space) and run the command shown above. Alternately, simply run the command shown below and compare the output to the md5sum data shown in the BLFS book.

md5sum <name_of_downloaded_file>

MD5 is not cryptographically secure, so the md5sums are only provided for detecting unmalicious changes to the file content. For example, an error or truncation introduced during network transfer, or a stealth update to the package from the upstream (updating the content of a released tarball instead of making a new release properly).

There is no 100% secure way to make sure the genuity of the source files. Assuming the upstream is managing their website correctly (the private key is not leaked and the domain is not hijacked), and the trust anchors have been set up correctly using make-ca-1.12 on the BLFS system, we can reasonably trust download URLs to the upstream official website with https protocol. Note that BLFS book itself is published on a website with https, so you should already have some confidence in https protocol or you wouldn't trust the book content.

If the package is downloaded from an unofficial location (for example a local mirror), checksums generated by cryptographically secure digest algorithms (for example SHA256) can be used to verify the genuity of the package. Download the checksum file from the upstream official website (or somewhere you can trust) and compare the checksum of the package from unofficial location with it. For example, SHA256 checksum can be checked with the command:

Note

If the checksum and the package are downloaded from the same untrusted location, you won't gain security enhancement by verifying the package with the checksum. The attacker can fake the checksum as well as compromising the package itself.

sha256sum -c file.sha256sum

If GnuPG-2.4.3 is installed, you can also verify the genuity of the package with a GPG signature. Import the upstream GPG public key with:

gpg --recv-key keyID

keyID should be replaced with the key ID from somewhere you can trust (for example, copy it from the upstream official website using https). Now you can verify the signature with:

gpg --recv-key file.sig file

The advantage of GnuPG signature is, once you imported a public key which can be trusted, you can download both the package and its signature from the same unofficial location and verify them with the public key. So you won't need to connect to the official upstream website to retrieve a checksum for each new release. You only need to update the public key if it's expired or revoked.

Creating Log Files During Installation

For larger packages, it is convenient to create log files instead of staring at the screen hoping to catch a particular error or warning. Log files are also useful for debugging and keeping records. The following command allows you to create an installation log. Replace <command> with the command you intend to execute.

( <command> 2>&1 | tee compile.log && exit $PIPESTATUS )

2>&1 redirects error messages to the same location as standard output. The tee command allows viewing of the output while logging the results to a file. The parentheses around the command run the entire command in a subshell and finally the exit $PIPESTATUS command ensures the result of the <command> is returned as the result and not the result of the tee command.

Using Multiple Processors

For many modern systems with multiple processors (or cores) the compilation time for a package can be reduced by performing a "parallel make" by either setting an environment variable or telling the make program how many processors are available. For instance, a Core2Duo can support two simultaneous processes with:

export MAKEFLAGS='-j2'

or just building with:

make -j2

If you have applied the optional sed when building ninja in LFS, you can use:

export NINJAJOBS=2

when a package uses ninja, or just:

ninja -j2

but for ninja, the default number of jobs is N + 2, if the number of logical processors N is greater than 2; or N + 1 if N is 1 or 2. The reason to use a number of jobs slightly greater than the number of logical processors is keeping all logical processors busy even if some jobs are performing I/O operations.

Generally the number of processes should not exceed the number of cores supported by the CPU too much. To list the processors on your system, issue: grep processor /proc/cpuinfo.

In some cases, using multiple processes may result in a race condition where the success of the build depends on the order of the commands run by the make program. For instance, if an executable needs File A and File B, attempting to link the program before one of the dependent components is available will result in a failure. This condition usually arises because the upstream developer has not properly designated all the prerequisites needed to accomplish a step in the Makefile.

If this occurs, the best way to proceed is to drop back to a single processor build. Adding -j1 to a make command will override the similar setting in the MAKEFLAGS environment variable.

Important

Another problem may occur with modern CPU's, which have a lot of cores. Each job started consumes memory, and if the sum of the needed memory for each job exceeds the available memory, you may encounter either an OOM (Out of Memory) kernel interrupt or intense swapping that will slow the build beyond reasonable limits.

Some compilations with g++ may consume up to 2.5 GB of memory, so to be safe, you should restrict the number of jobs to (Total Memory in GB)/2.5, at least for big packages such as LLVM, WebKitGtk, QtWebEngine, or libreoffice.

Automated Building Procedures

There are times when automating the building of a package can come in handy. Everyone has their own reasons for wanting to automate building, and everyone goes about it in their own way. Creating Makefiles, Bash scripts, Perl scripts or simply a list of commands used to cut and paste are just some of the methods you can use to automate building BLFS packages. Detailing how and providing examples of the many ways you can automate the building of packages is beyond the scope of this section. This section will expose you to using file redirection and the yes command to help provide ideas on how to automate your builds.

File Redirection to Automate Input

You will find times throughout your BLFS journey when you will come across a package that has a command prompting you for information. This information might be configuration details, a directory path, or a response to a license agreement. This can present a challenge to automate the building of that package. Occasionally, you will be prompted for different information in a series of questions. One method to automate this type of scenario requires putting the desired responses in a file and using redirection so that the program uses the data in the file as the answers to the questions.

This effectively makes the test suite use the responses in the file as the input to the questions. Occasionally you may end up doing a bit of trial and error determining the exact format of your input file for some things, but once figured out and documented you can use this to automate building the package.

Using yes to Automate Input

Sometimes you will only need to provide one response, or provide the same response to many prompts. For these instances, the yes command works really well. The yes command can be used to provide a response (the same one) to one or more instances of questions. It can be used to simulate pressing just the Enter key, entering the Y key or entering a string of text. Perhaps the easiest way to show its use is in an example.

First, create a short Bash script by entering the following commands:

cat > blfs-yes-test1 << "EOF"
#!/bin/bash

echo -n -e "\n\nPlease type something (or nothing) and press Enter ---> "

read A_STRING

if test "$A_STRING" = ""; then A_STRING="Just the Enter key was pressed"
else A_STRING="You entered '$A_STRING'"
fi

echo -e "\n\n$A_STRING\n\n"
EOF
chmod 755 blfs-yes-test1

Now run the script by issuing ./blfs-yes-test1 from the command line. It will wait for a response, which can be anything (or nothing) followed by the Enter key. After entering something, the result will be echoed to the screen. Now use the yes command to automate the entering of a response:

yes | ./blfs-yes-test1

Notice that piping yes by itself to the script results in y being passed to the script. Now try it with a string of text:

yes 'This is some text' | ./blfs-yes-test1

The exact string was used as the response to the script. Finally, try it using an empty (null) string:

yes '' | ./blfs-yes-test1

Notice this results in passing just the press of the Enter key to the script. This is useful for times when the default answer to the prompt is sufficient. This syntax is used in the Net-tools instructions to accept all the defaults to the many prompts during the configuration step. You may now remove the test script, if desired.

File Redirection to Automate Output

In order to automate the building of some packages, especially those that require you to read a license agreement one page at a time, requires using a method that avoids having to press a key to display each page. Redirecting the output to a file can be used in these instances to assist with the automation. The previous section on this page touched on creating log files of the build output. The redirection method shown there used the tee command to redirect output to a file while also displaying the output to the screen. Here, the output will only be sent to a file.

Again, the easiest way to demonstrate the technique is to show an example. First, issue the command:

ls -l /usr/bin | less

Of course, you'll be required to view the output one page at a time because the less filter was used. Now try the same command, but this time redirect the output to a file. The special file /dev/null can be used instead of the filename shown, but you will have no log file to examine:

ls -l /usr/bin | less > redirect_test.log 2>&1

Notice that this time the command immediately returned to the shell prompt without having to page through the output. You may now remove the log file.

The last example will use the yes command in combination with output redirection to bypass having to page through the output and then provide a y to a prompt. This technique could be used in instances when otherwise you would have to page through the output of a file (such as a license agreement) and then answer the question of do you accept the above?. For this example, another short Bash script is required:

cat > blfs-yes-test2 << "EOF"
#!/bin/bash

ls -l /usr/bin | less

echo -n -e "\n\nDid you enjoy reading this? (y,n) "

read A_STRING

if test "$A_STRING" = "y"; then A_STRING="You entered the 'y' key"
else A_STRING="You did NOT enter the 'y' key"
fi

echo -e "\n\n$A_STRING\n\n"
EOF
chmod 755 blfs-yes-test2

This script can be used to simulate a program that requires you to read a license agreement, then respond appropriately to accept the agreement before the program will install anything. First, run the script without any automation techniques by issuing ./blfs-yes-test2.

Now issue the following command which uses two automation techniques, making it suitable for use in an automated build script:

yes | ./blfs-yes-test2 > blfs-yes-test2.log 2>&1

If desired, issue tail blfs-yes-test2.log to see the end of the paged output, and confirmation that y was passed through to the script. Once satisfied that it works as it should, you may remove the script and log file.

Finally, keep in mind that there are many ways to automate and/or script the build commands. There is not a single correct way to do it. Your imagination is the only limit.

Dependencies

For each package described, BLFS lists the known dependencies. These are listed under several headings, whose meaning is as follows:

  • Required means that the target package cannot be correctly built without the dependency having first been installed, except if the dependency is said to be runtime, which means the target package can be built but cannot function without it.

    Note that a target package can start to function in many subtle ways: an installed configuration file can make the init system, cron daemon, or bus daemon to run a program automatically; another package using the target package as an dependency can run a program from the target package in the building system; and the configuration sections in the BLFS book may also run a program from a just installed package. So if you are installing the target package without a Required (runtime) dependency installed, You should install the dependency as soon as possible after the installation of the target package.

  • Recommended means that BLFS strongly suggests this package is installed first (except if said to be runtime, see below) for a clean and trouble-free build, that won't have issues either during the build process, or at run-time. The instructions in the book assume these packages are installed. Some changes or workarounds may be required if these packages are not installed. If a recommended dependency is said to be runtime, it means that BLFS strongly suggests that this dependency is installed before using the package, for getting full functionality.

  • Optional means that this package might be installed for added functionality. Often BLFS will describe the dependency to explain the added functionality that will result. An optional dependency may be automatically pick up by the target package if the dependency is installed, but another some optional dependency may also need additional configuration options to enable them when the target package is built. Such additional options are often documented in the BLFS book. If an optional dependency is said to be runtime, it means you may install the dependency after installing the target package to support some optional features of the target package if you need these features.

    An optional dependency may be out of BLFS. If you need such an external optional dependency for some features you need, read Going Beyond BLFS for the general hint about installing an out-of-BLFS package.

Using the Most Current Package Sources

On occasion you may run into a situation in the book when a package will not build or work properly. Though the Editors attempt to ensure that every package in the book builds and works properly, sometimes a package has been overlooked or was not tested with this particular version of BLFS.

If you discover that a package will not build or work properly, you should see if there is a more current version of the package. Typically this means you go to the maintainer's web site and download the most current tarball and attempt to build the package. If you cannot determine the maintainer's web site by looking at the download URLs, use Google and query the package's name. For example, in the Google search bar type: 'package_name download' (omit the quotes) or something similar. Sometimes typing: 'package_name home page' will result in you finding the maintainer's web site.

Stripping One More Time

In LFS, stripping of debugging symbols and unneeded symbol table entries was discussed a couple of times. When building BLFS packages, there are generally no special instructions that discuss stripping again. Stripping can be done while installing a package, or afterwards.

Stripping while Installing a Package

There are several ways to strip executables installed by a package. They depend on the build system used (see below the section about build systems), so only some generalities can be listed here:

Note

The following methods using the feature of a building system (autotools, meson, or cmake) will not strip static libraries if any is installed. Fortunately there are not too many static libraries in BLFS, and a static library can always be stripped safely by running strip --strip-unneeded on it manually.

  • The packages using autotools usually have an install-strip target in their generated Makefile files. So installing stripped executables is just a matter of using make install-strip instead of make install.

  • The packages using the meson build system can accept -Dstrip=true when running meson. If you've forgot to add this option running the meson, you can also run meson install --strip instead of ninja install.

  • cmake generates install/strip targets for both the Unix Makefiles and Ninja generators (the default is Unix Makefiles on linux). So just run make install/strip or ninja install/strip instead of the install counterparts.

  • Removing (or not generating) debug symbols can also be achieved by removing the -g<something> options in C/C++ calls. How to do that is very specific for each package. And, it does not remove unneeded symbol table entries. So it will not be explained in detail here. See also below the paragraphs about optimization.

Stripping Installed Executables

The strip utility changes files in place, which may break anything using it if it is loaded in memory. Note that if a file is in use but just removed from the disk (i.e. not overwritten nor modified), this is not a problem since the kernel can use deleted files. Look at /proc/*/maps and it is likely that you'll see some (deleted) entries. The mv just removes the destination file from the directory but does not touch its content, so that it satisfies the condition for the kernel to use the old (deleted) file. But this approach can detach hard links into duplicated copies, causing a bloat which is obviously unwanted as we are stripping to reduce system size. If two files in a same file system share the same inode number, they are hard links to each other and we should reconstruct the link. The script below is just an example. It should be run as the root user:

cat > /usr/sbin/strip-all.sh << "EOF"
#!/usr/bin/bash

if [ $EUID -ne 0 ]; then
  echo "Need to be root"
  exit 1
fi

last_fs_inode=
last_file=

{ find /usr/lib -type f -name '*.so*' ! -name '*dbg'
  find /usr/lib -type f -name '*.a'
  find /usr/{bin,sbin,libexec} -type f
} | xargs stat -c '%m %i %n' | sort | while read fs inode file; do
       if ! readelf -h $file >/dev/null 2>&1; then continue; fi
       if file $file | grep --quiet --invert-match 'not stripped'; then continue; fi

       if [ "$fs $inode" = "$last_fs_inode" ]; then
         ln -f $last_file $file;
         continue;
       fi

       cp --preserve $file    ${file}.tmp
       strip --strip-unneeded ${file}.tmp
       mv ${file}.tmp $file

       last_fs_inode="$fs $inode"
       last_file=$file
done
EOF
chmod 744 /usr/sbin/strip-all.sh

If you install programs in other directories such as /opt or /usr/local, you may want to strip the files there too. Just add other directories to scan in the compound list of find commands between the braces.

For more information on stripping, see https://www.technovelty.org/linux/stripping-shared-libraries.html.

Working with different build systems

There are now three different build systems in common use for converting C or C++ source code into compiled programs or libraries and their details (particularly, finding out about available options and their default values) differ. It may be easiest to understand the issues caused by some choices (typically slow execution or unexpected use of, or omission of, optimizations) by starting with the CFLAGS, CXXFLAGS, and LDFLAGS environment variables. There are also some programs which use Rust.

Most LFS and BLFS builders are probably aware of the basics of CFLAGS and CXXFLAGS for altering how a program is compiled. Typically, some form of optimization is used by upstream developers (-O2 or -O3), sometimes with the creation of debug symbols (-g), as defaults.

If there are contradictory flags (e.g. multiple different -O values), the last value will be used. Sometimes this means that flags specified in environment variables will be picked up before values hardcoded in the Makefile, and therefore ignored. For example, where a user specifies -O2 and that is followed by -O3 the build will use -O3.

There are various other things which can be passed in CFLAGS or CXXFLAGS, such as allowing using the instruction set extensions available with a specific microarchitecture (e.g. -march=amdfam10 or -march=native), tune the generated code for a specific microarchitecture (e. g. -mtune=tigerlake or -mtune=native, if -mtune= is not used, the microarchitecture from -march= setting will be used), or specifying a specific standard for C or C++ (-std=c++17 for example). But one thing which has now come to light is that programmers might include debug assertions in their code, expecting them to be disabled in releases by using -DNDEBUG. Specifically, if Mesa-23.1.6 is built with these assertions enabled, some activities such as loading levels of games can take extremely long times, even on high-class video cards.

Autotools with Make

This combination is often described as CMMI (configure, make, make install) and is used here to also cover the few packages which have a configure script that is not generated by autotools.

Sometimes running ./configure --help will produce useful options about switches which might be used. At other times, after looking at the output from configure you may need to look at the details of the script to find out what it was actually searching for.

Many configure scripts will pick up any CFLAGS or CXXFLAGS from the environment, but CMMI packages vary about how these will be mixed with any flags which would otherwise be used (variously: ignored, used to replace the programmer's suggestion, used before the programmer's suggestion, or used after the programmer's suggestion).

In most CMMI packages, running make will list each command and run it, interspersed with any warnings. But some packages try to be silent and only show which file they are compiling or linking instead of showing the command line. If you need to inspect the command, either because of an error, or just to see what options and flags are being used, adding V=1 to the make invocation may help.

CMake

CMake works in a very different way, and it has two backends which can be used on BLFS: make and ninja. The default backend is make, but ninja can be faster on large packages with multiple processors. To use ninja, specify -G Ninja in the cmake command. However, there are some packages which create fatal errors in their ninja files but build successfully using the default of Unix Makefiles.

The hardest part of using CMake is knowing what options you might wish to specify. The only way to get a list of what the package knows about is to run cmake -LAH and look at the output for that default configuration.

Perhaps the most-important thing about CMake is that it has a variety of CMAKE_BUILD_TYPE values, and these affect the flags. The default is that this is not set and no flags are generated. Any CFLAGS or CXXFLAGS in the environment will be used. If the programmer has coded any debug assertions, those will be enabled unless -DNDEBUG is used. The following CMAKE_BUILD_TYPE values will generate the flags shown, and these will come after any flags in the environment and therefore take precedence.

Value Flags
Debug -g
Release -O3 -DNDEBUG
RelWithDebInfo -O2 -g -DNDEBUG
MinSizeRel -Os -DNDEBUG

CMake tries to produce quiet builds. To see the details of the commands which are being run, use make VERBOSE=1 or ninja -v.

By default, CMake treats file installation differently from the other build systems: if a file already exists and is not newer than a file that would overwrite it, then the file is not installed. This may be a problem if a user wants to record which file belongs to a package, either using LD_PRELOAD, or by listing files newer than a timestamp. The default can be changed by setting the variable CMAKE_INSTALL_ALWAYS to 1 in the environment, for example by export'ing it.

Meson

Meson has some similarities to CMake, but many differences. To get details of the defines that you may wish to change you can look at meson_options.txt which is usually in the top-level directory.

If you have already configured the package by running meson and now wish to change one or more settings, you can either remove the build directory, recreate it, and use the altered options, or within the build directory run meson configure, e.g. to set an option:

meson configure -D<some_option>=true

If you do that, the file meson-private/cmd_line.txt will show the last commands which were used.

Meson provides the following buildtype values, and the flags they enable come after any flags supplied in the environment and therefore take precedence.

  • plain : no added flags. This is for distributors to supply their own CFLAGS, CXXFLAGS and LDFLAGS. There is no obvious reason to use this in BLFS.

  • debug : -g - this is the default if nothing is specified in either meson.build or the command line. However it results large and slow binaries, so we should override it in BLFS.

  • debugoptimized : -O2 -g - this is the default specified in meson.build of some packages.

  • release : -O3 (occasionally a package will force -O2 here) - this is the buildtype we use for most packages with Meson build system in BLFS.

The -DNDEBUG flag is implied by the release buildtype for some packages (for example Mesa-23.1.6). It can also be provided explicitly by passing -Db_ndebug=true.

To see the details of the commands which are being run in a package using meson, use ninja -v.

Rustc and Cargo

Most released rustc programs are provided as crates (source tarballs) which will query a server to check current versions of dependencies and then download them as necessary. These packages are built using cargo --release. In theory, you can manipulate the RUSTFLAGS to change the optimize-level (default for --release is 3, i. e. -Copt-level=3, like -O3) or to force it to build for the machine it is being compiled on, using -Ctarget-cpu=native but in practice this seems to make no significant difference.

If you are compiling a standalone Rust program (as an unpackaged .rs file) by running rustc directly, you should specify -O (the abbreviation of -Copt-level=2) or -Copt-level=3 otherwise it will do an unoptimized compile and run much slower. If are compiling the program for debugging it, replace the -O or -Copt-level= options with -g to produce an unoptimized program with debug info.

Like ninja, by default cargo uses all logical processors. This can often be worked around, either by exporting CARGO_BUILD_JOBS=<N> or passing --jobs <N> to cargo. For compiling rustc itself, specifying --jobs <N> for invocations of x.py (together with the CARGO_BUILD_JOBS environment variable, which looks like a belt and braces approach but seems to be necessary) mostly works. The exception is running the tests when building rustc, some of them will nevertheless use all online CPUs, at least as of rustc-1.42.0.

Optimizing the build

Many people will prefer to optimize compiles as they see fit, by providing CFLAGS or CXXFLAGS. For an introduction to the options available with gcc and g++ see https://gcc.gnu.org/onlinedocs/gcc-13.2.0/gcc/Optimize-Options.html. The same content can be also found in info gcc.

Some packages default to -O2 -g, others to -O3 -g, and if CFLAGS or CXXFLAGS are supplied they might be added to the package's defaults, replace the package's defaults, or even be ignored. There are details on some desktop packages which were mostly current in April 2019 at https://www.linuxfromscratch.org/~ken/tuning/ - in particular, README.txt, tuning-1-packages-and-notes.txt, and tuning-notes-2B.txt. The particular thing to remember is that if you want to try some of the more interesting flags you may need to force verbose builds to confirm what is being used.

Clearly, if you are optimizing your own program you can spend time to profile it and perhaps recode some of it if it is too slow. But for building a whole system that approach is impractical. In general, -O3 usually produces faster programs than -O2. Specifying -march=native is also beneficial, but means that you cannot move the binaries to an incompatible machine - this can also apply to newer machines, not just to older machines. For example programs compiled for amdfam10 run on old Phenoms, Kaveris, and Ryzens : but programs compiled for a Kaveri will not run on a Ryzen because certain op-codes are not present. Similarly, if you build for a Haswell not everything will run on a SandyBridge.

Note

Be careful that the name of a -march setting does not always match the baseline of the microarchitecture with the same name. For example, the Skylake-based Intel Celeron processors do not support AVX at all, but -march=skylake assumes AVX and even AVX2.

When a shared library is built by GCC, a feature named semantic interposition is enabled by default. When the shared library refers to a symbol name with external linkage and default visibility, if the symbol exists in both the shared library and the main executable, semantic interposition guarantees the symbol in the main executable is always used. This feature was invented in an attempt to make the behavior of linking a shared library and linking a static library as similar as possible. Today only a small number of packages still depend on semantic interposition, but the feature is still on by the default of GCC, causing many optimizations disabled for shared libraries because they conflict with semantic interposition. The -fno-semantic-interposition option can be passed to gcc or g++ to disable semantic interposition and enable more optimizations for shared libraries. This option is used as the default of some packages (for example Python-3.11.4), and it's also the default of Clang.

There are also various other options which some people claim are beneficial. At worst, you get to recompile and test, and then discover that in your usage the options do not provide a benefit.

If building Perl or Python modules, in general the CFLAGS and CXXFLAGS used are those which were used by those parent packages.

For LDFLAGS, there are three options can be used for optimization. They are quite safe to use and the building system of some packages use some of these options as the default.

With -Wl,-O1, the linker will optimize the hash table to speed up the dynamic linking. Note that -Wl,-O1 is completely unrelated to the compiler optimization flag -O1.

With -Wl,--as-needed, the linker will disregard unnecessary -lfoo options from the command line, i. e. the shared library libfoo will only be linked if a symbol in libfoo is really referred from the executable or shared library being linked. This can sometimes mitigate the excessive dependencies to shared libraries issues caused by libtool.

With -Wl,-z,pack-relative-relocs, the linker generates a more compacted form of the relative relocation entries for PIEs and shared libraries. It reduces the size of the linked PIE or shared library, and speeds up the loading of the PIE or shared library.

The -Wl, prefix is necessary because despite the variable is named LDFLAGS, its content is actually passed to gcc (or g++, clang, etc.) during the link stage, not directly passed to ld.

Options for hardening the build

Even on desktop systems, there are still a lot of exploitable vulnerabilities. For many of these, the attack comes via javascript in a browser. Often, a series of vulnerabilities are used to gain access to data (or sometimes to pwn, i.e. own, the machine and install rootkits). Most commercial distros will apply various hardening measures.

In the past, there was Hardened LFS where gcc (a much older version) was forced to use hardening (with options to turn some of it off on a per-package basis). The current LFS and BLFS books are carrying forward a part of its spirit by enabling PIE (-fPIE -pie) and SSP (-fstack-protector-strong) as the defaults for GCC and clang. What is being covered here is different - first you have to make sure that the package is indeed using your added flags and not over-riding them.

For hardening options which are reasonably cheap, there is some discussion in the 'tuning' link above (occasionally, one or more of these options might be inappropriate for a package). These options are -D_FORTIFY_SOURCE=2 and (for C++) -D_GLIBCXX_ASSERTIONS. On modern machines these should only have a little impact on how fast things run, and often they will not be noticeable.

The main distros use much more, such as RELRO (Relocation Read Only) and perhaps -fstack-clash-protection. You may also encounter the so-called userspace retpoline (-mindirect-branch=thunk etc.) which is the equivalent of the spectre mitigations applied to the linux kernel in late 2018. The kernel mitigations caused a lot of complaints about lost performance, if you have a production server you might wish to consider testing that, along with the other available options, to see if performance is still sufficient.

Whilst gcc has many hardening options, clang/LLVM's strengths lie elsewhere. Some options which gcc provides are said to be less effective in clang/LLVM.

The /usr Versus /usr/local Debate

Should I install XXX in /usr or /usr/local?

This is a question without an obvious answer for an LFS based system.

In traditional Unix systems, /usr usually contains files that come with the system distribution, and the /usr/local tree is free for the local administrator to manage. The only really hard and fast rule is that Unix distributions should not touch /usr/local, except perhaps to create the basic directories within it.

With Linux distributions like Red Hat, Debian, etc., a possible rule is that /usr is managed by the distribution's package system and /usr/local is not. This way the package manager's database knows about every file within /usr.

LFS users build their own system and so deciding where the system ends and local files begin is not straightforward. So the choice should be made in order to make things easier to administer. There are several reasons for dividing files between /usr and /usr/local.

  • On a network of several machines all running LFS, or mixed LFS and other Linux distributions, /usr/local could be used to hold packages that are common between all the computers in the network. It can be NFS mounted or mirrored from a single server. Here local indicates local to the site.

  • On a network of several computers all running an identical LFS system, /usr/local could hold packages that are different between the machines. In this case local refers to the individual computers.

  • Even on a single computer, /usr/local can be useful if you have several distributions installed simultaneously, and want a place to put packages that will be the same on all of them.

  • Or you might regularly rebuild your LFS, but want a place to put files that you don't want to rebuild each time. This way you can wipe the LFS file system and start from a clean partition every time without losing everything.

Some people ask why not use your own directory tree, e.g., /usr/site, rather than /usr/local?

There is nothing stopping you, many sites do make their own trees, however it makes installing new software more difficult. Automatic installers often look for dependencies in /usr and /usr/local, and if the file it is looking for is in /usr/site instead, the installer will probably fail unless you specifically tell it where to look.

What is the BLFS position on this?

All of the BLFS instructions install programs in /usr with optional instructions to install into /opt for some specific packages.

Optional Patches

As you follow the various sections in the book, you will observe that the book occasionally includes patches that are required for a successful and secure installation of the packages. The general policy of the book is to include patches that fall in one of the following criteria:

  • Fixes a compilation problem.

  • Fixes a security problem.

  • Fixes a broken functionality.

In short, the book only includes patches that are either required or recommended. There is a Patches subproject which hosts various patches (including the patches referenced in the books) to enable you to configure your LFS the way you like it.

BLFS Systemd Units

The BLFS Systemd Units package contains the systemd unit files that are used throughout the book.

The BLFS Systemd Units package will be used throughout the BLFS book for systemd unit files. Each systemd unit has a separate install target. It is recommended that you keep the package source directory around until completion of your BLFS system. When a systemd unit is requested from BLFS Systemd Units, simply change to the directory, and as the root user, execute the given make install-<systemd-unit> command. This command installs the systemd unit to its proper location (along with any auxiliary configuration scripts) and also enables it by default.

Note

It is advisable to peruse each systemd unit before installation to determine whether the installed files meet your needs.

About Libtool Archive (.la) files

Files with a .la extension

In LFS and BLFS, many packages use a internally shipped libtool copy to build on a variety of Unix platforms. This includes platforms such as AIX, Solaris, IRIX, HP-UX, and Cygwin as well as Linux. The origins of this tool are quite dated. It was intended to manage libraries on systems with less advanced capabilities than a modern Linux system.

On a Linux system, libtool specific files are generally unneeded. Normally libraries are specified in the build process during the link phase. Since a linux system uses the Executable and Linkable Format (ELF) for executables and dynamic libraries, information needed to complete the task is embedded in the files. Both the linker and the program loader can query the appropriate files and properly link or execute the program.

Static libraries are rarely used in LFS and BLFS. And, nowadays most packages store the information needed for linking against a static library into a .pc file, instead of relying on libtool. A pkg-config --static --libs command will output the sufficient flags for the linker to link against a static library without any libtool magic.

The problem is that libtool usually creates one or more text files for package libraries called libtool archives. These small files have a ".la" extension and contain information that is similar to that embedded in the libraries or pkg-config files. When building a package that uses libtool, the process automatically looks for these files. Sometimes a .la file can contains the name or path of a static library used during build but not installed, then the build process will break because the .la file refers to something nonexistent on the system. Similarly, if a package is updated and no longer uses the .la file, then the build process can break with the old .la files.

The solution is to remove the .la files. However there is a catch. Some packages, such as ImageMagick-7.1.1-15, use a libtool function, lt_dlopen, to load libraries as needed during execution and resolve their dependencies at run time. In this case, the .la files should remain.

The script below, removes all unneeded .la files and saves them in a directory, /var/local/la-files by default, not in the normal library path. It also searches all pkg-config files (.pc) for embedded references to .la files and fixes them to be conventional library references needed when an application or library is built. It can be run as needed to clean up the directories that may be causing problems.

cat > /usr/sbin/remove-la-files.sh << "EOF"
#!/bin/bash

# /usr/sbin/remove-la-files.sh
# Written for Beyond Linux From Scratch
# by Bruce Dubbs <[email protected]>

# Make sure we are running with root privs
if test "${EUID}" -ne 0; then
    echo "Error: $(basename ${0}) must be run as the root user! Exiting..."
    exit 1
fi

# Make sure PKG_CONFIG_PATH is set if discarded by sudo
source /etc/profile

OLD_LA_DIR=/var/local/la-files

mkdir -p $OLD_LA_DIR

# Only search directories in /opt, but not symlinks to directories
OPTDIRS=$(find /opt -mindepth 1 -maxdepth 1 -type d)

# Move any found .la files to a directory out of the way
find /usr/lib $OPTDIRS -name "*.la" ! -path "/usr/lib/ImageMagick*" \
  -exec mv -fv {} $OLD_LA_DIR \;
###############

# Fix any .pc files that may have .la references

STD_PC_PATH='/usr/lib/pkgconfig
             /usr/share/pkgconfig
             /usr/local/lib/pkgconfig
             /usr/local/share/pkgconfig'

# For each directory that can have .pc files
for d in $(echo $PKG_CONFIG_PATH | tr : ' ') $STD_PC_PATH; do

  # For each pc file
  for pc in $d/*.pc ; do
    if [ $pc == "$d/*.pc" ]; then continue; fi

    # Check each word in a line with a .la reference
    for word in $(grep '\.la' $pc); do
      if $(echo $word | grep -q '.la$' ); then
        mkdir -p $d/la-backup
        cp -fv  $pc $d/la-backup

        basename=$(basename $word )
        libref=$(echo $basename|sed -e 's/^lib/-l/' -e 's/\.la$//')

        # Fix the .pc file
        sed -i "s:$word:$libref:" $pc
      fi
    done
  done
done

EOF

chmod +x /usr/sbin/remove-la-files.sh

Libraries: Static or shared?

Libraries: Static or shared?

The original libraries were simply an archive of routines from which the required routines were extracted and linked into the executable program. These are described as static libraries, with names of the form libfoo.a on UNIX-like operating systems. On some old operating systems they are the only type available.

On almost all Linux platforms there are also shared (or equivalently dynamic) libraries (with names of the form libfoo.so) – one copy of the library is loaded into virtual memory, and shared by all the programs which call any of its functions. This is space efficient.

In the past, essential programs such as a shell were often linked statically so that some form of minimal recovery system would exist even if shared libraries, such as libc.so, became damaged (e.g. moved to lost+found after fsck following an unclean shutdown). Nowadays, most people use an alternative system install or a USB stick if they have to recover. Journaling filesystems also reduce the likelihood of this sort of problem.

Within the book, there are various places where configure switches such as --disable-static are employed, and other places where the possibility of using system versions of libraries instead of the versions included within another package is discussed. The main reason for this is to simplify updates of libraries.

If a package is linked to a dynamic library, updating to a newer library version is automatic once the newer library is installed and the program is (re)started (provided the library major version is unchanged, e.g. going from libfoo.so.2.0 to libfoo.so.2.1. Going to libfoo.so.3 will require recompilation – ldd can be used to find which programs use the old version). If a program is linked to a static library, the program always has to be recompiled. If you know which programs are linked to a particular static library, this is merely an annoyance. But usually you will not know which programs to recompile.

One way to identify when a static library is used, is to deal with it at the end of the installation of every package. Write a script to find all the static libraries in /usr/lib or wherever you are installing to, and either move them to another directory so that they are no longer found by the linker, or rename them so that libfoo.a becomes e.g. libfoo.a.hidden. The static library can then be temporarily restored if it is ever needed, and the package needing it can be identified. This shouldn't be done blindly since many libraries only exist in a static version. For example, some libraries from the glibc and gcc packages should always be present on the system (libc_nonshared.a, libg.a, libpthread_nonshared.a, libssp_nonshared.a, libsupc++.a as of glibc-2.36 and gcc-12.2).

If you use this approach, you may discover that more packages than you were expecting use a static library. That was the case with nettle-2.4 in its default static-only configuration: It was required by GnuTLS-3.0.19, but also linked into package(s) which used GnuTLS, such as glib-networking-2.32.3.

Many packages put some of their common functions into a static library which is only used by the programs within the package and, crucially, the library is not installed as a standalone library. These internal libraries are not a problem – if the package has to be rebuilt to fix a bug or vulnerability, nothing else is linked to them.

When BLFS mentions system libraries, it means shared versions of libraries. Some packages such as Firefox-115.2.0 and ghostscript-10.01.2 bundle many other libraries in their build tree. The version they ship is often older than the version used in the system, so it may contain bugs – sometimes developers go to the trouble of fixing bugs in their included libraries, other times they do not.

Sometimes, deciding to use system libraries is an easy decision. Other times it may require you to alter the system version (e.g. for libpng-1.6.40 if used for Firefox-115.2.0). Occasionally, a package ships an old library and can no longer link to the current version, but can link to an older version. In this case, BLFS will usually just use the shipped version. Sometimes the included library is no longer developed separately, or its upstream is now the same as the package's upstream and you have no other packages which will use it. In those cases, you'll be lead to use the included library even if you usually prefer to use system libraries.

Locale Related Issues

This page contains information about locale related problems and issues. In the following paragraphs you'll find a generic overview of things that can come up when configuring your system for various locales. Many (but not all) existing locale related problems can be classified and fall under one of the headings below. The severity ratings below use the following criteria:

  • Critical: The program doesn't perform its main function. The fix would be very intrusive, it's better to search for a replacement.

  • High: Part of the functionality that the program provides is not usable. If that functionality is required, it's better to search for a replacement.

  • Low: The program works in all typical use cases, but lacks some functionality normally provided by its equivalents.

If there is a known workaround for a specific package, it will appear on that package's page. For the most recent information about locale related issues for individual packages, check the Editor Notes in the BLFS Wiki.

The Needed Encoding is Not a Valid Option in the Program

Severity: Critical

Some programs require the user to specify the character encoding for their input or output data and present only a limited choice of encodings. This is the case for the -X option in Enscript-1.6.6, the -input-charset option in unpatched Cdrtools-3.02a09, and the character sets offered for display in the menu of Links-2.29. If the required encoding is not in the list, the program usually becomes completely unusable. For non-interactive programs, it may be possible to work around this by converting the document to a supported input character set before submitting to the program.

A solution to this type of problem is to implement the necessary support for the missing encoding as a patch to the original program or to find a replacement.

The Program Assumes the Locale-Based Encoding of External Documents

Severity: High for non-text documents, low for text documents

Some programs, nano-7.2 or JOE-4.6 for example, assume that documents are always in the encoding implied by the current locale. While this assumption may be valid for the user-created documents, it is not safe for external ones. When this assumption fails, non-ASCII characters are displayed incorrectly, and the document may become unreadable.

If the external document is entirely text based, it can be converted to the current locale encoding using the iconv program.

For documents that are not text-based, this is not possible. In fact, the assumption made in the program may be completely invalid for documents where the Microsoft Windows operating system has set de facto standards. An example of this problem is ID3v1 tags in MP3 files (see the BLFS Wiki ID3v1Coding page for more details). For these cases, the only solution is to find a replacement program that doesn't have the issue (e.g., one that will allow you to specify the assumed document encoding).

Among BLFS packages, this problem applies to nano-7.2, JOE-4.6, and all media players except Audacious-4.3.1.

Another problem in this category is when someone cannot read the documents you've sent them because their operating system is set up to handle character encodings differently. This can happen often when the other person is using Microsoft Windows, which only provides one character encoding for a given country. For example, this causes problems with UTF-8 encoded TeX documents created in Linux. On Windows, most applications will assume that these documents have been created using the default Windows 8-bit encoding.

In extreme cases, Windows encoding compatibility issues may be solved only by running Windows programs under Wine.

The Program Uses or Creates Filenames in the Wrong Encoding

Severity: Critical

The POSIX standard mandates that the filename encoding is the encoding implied by the current LC_CTYPE locale category. This information is well-hidden on the page which specifies the behavior of Tar and Cpio programs. Some programs get it wrong by default (or simply don't have enough information to get it right). The result is that they create filenames which are not subsequently shown correctly by ls, or they refuse to accept filenames that ls shows properly. For the GLib-2.76.4 library, the problem can be corrected by setting the G_FILENAME_ENCODING environment variable to the special "@locale" value. Glib2 based programs that don't respect that environment variable are buggy.

The Zip-3.0 and UnZip-6.0 have this problem because they hard-code the expected filename encoding. UnZip contains a hard-coded conversion table between the CP850 (DOS) and ISO-8859-1 (UNIX) encodings and uses this table when extracting archives created under DOS or Microsoft Windows. However, this assumption only works for those in the US and not for anyone using a UTF-8 locale. Non-ASCII characters will be mangled in the extracted filenames.

The general rule for avoiding this class of problems is to avoid installing broken programs. If this is impossible, the convmv command-line tool can be used to fix filenames created by these broken programs, or intentionally mangle the existing filenames to meet the broken expectations of such programs.

In other cases, a similar problem is caused by importing filenames from a system using a different locale with a tool that is not locale-aware (e.g., OpenSSH-9.4p1). In order to avoid mangling non-ASCII characters when transferring files to a system with a different locale, any of the following methods can be used:

  • Transfer anyway, fix the damage with convmv.

  • On the sending side, create a tar archive with the --format=posix switch passed to tar (this will be the default in a future version of tar).

  • Mail the files as attachments. Mail clients specify the encoding of attached filenames.

  • Write the files to a removable disk formatted with a FAT or FAT32 filesystem.

  • Transfer the files using Samba.

  • Transfer the files via FTP using RFC2640-aware server (this currently means only wu-ftpd, which has bad security history) and client (e.g., lftp).

The last four methods work because the filenames are automatically converted from the sender's locale to UNICODE and stored or sent in this form. They are then transparently converted from UNICODE to the recipient's locale encoding.

The Program Breaks Multibyte Characters or Doesn't Count Character Cells Correctly

Severity: High or critical

Many programs were written in an older era where multibyte locales were not common. Such programs assume that C "char" data type, which is one byte, can be used to store single characters. Further, they assume that any sequence of characters is a valid string and that every character occupies a single character cell. Such assumptions completely break in UTF-8 locales. The visible manifestation is that the program truncates strings prematurely (i.e., at 80 bytes instead of 80 characters). Terminal-based programs don't place the cursor correctly on the screen, don't react to the "Backspace" key by erasing one character, and leave junk characters around when updating the screen, usually turning the screen into a complete mess.

Fixing this kind of problems is a tedious task from a programmer's point of view, like all other cases of retrofitting new concepts into the old flawed design. In this case, one has to redesign all data structures in order to accommodate to the fact that a complete character may span a variable number of "char"s (or switch to wchar_t and convert as needed). Also, for every call to the "strlen" and similar functions, find out whether a number of bytes, a number of characters, or the width of the string was really meant. Sometimes it is faster to write a program with the same functionality from scratch.

Among BLFS packages, this problem applies to xine-ui-0.99.14 and all the shells.

The Package Installs Manual Pages in Incorrect or Non-Displayable Encoding

Severity: Low

LFS expects that manual pages are in the language-specific (usually 8-bit) encoding, as specified on the LFS Man DB page. However, some packages install translated manual pages in UTF-8 encoding (e.g., Shadow, already dealt with), or manual pages in languages not in the table. Not all BLFS packages have been audited for conformance with the requirements put in LFS (the large majority have been checked, and fixes placed in the book for packages known to install non-conforming manual pages). If you find a manual page installed by any of BLFS packages that is obviously in the wrong encoding, please remove or convert it as needed, and report this to BLFS team as a bug.

You can easily check your system for any non-conforming manual pages by copying the following short shell script to some accessible location,

#!/bin/sh
# Begin checkman.sh
# Usage: find /usr/share/man -type f | xargs checkman.sh
for a in "$@"
do
    # echo "Checking $a..."
    # Pure-ASCII manual page (possibly except comments) is OK
    grep -v '.\\"' "$a" | iconv -f US-ASCII -t US-ASCII >/dev/null 2>&1 \
        && continue
    # Non-UTF-8 manual page is OK
    iconv -f UTF-8 -t UTF-8 "$a" >/dev/null 2>&1 || continue
    # Found a UTF-8 manual page, bad.
    echo "UTF-8 manual page: $a" >&2
done
# End checkman.sh

and then issuing the following command (modify the command below if the checkman.sh script is not in your PATH environment variable):

find /usr/share/man -type f | xargs checkman.sh

Note that if you have manual pages installed in any location other than /usr/share/man (e.g., /usr/local/share/man), you must modify the above command to include this additional location.

Going Beyond BLFS

The packages that are installed in this book are only the tip of the iceberg. We hope that the experience you gained with the LFS book and the BLFS book will give you the background needed to compile, install and configure packages that are not included in this book.

When you want to install a package to a location other than /, or /usr, you are installing outside the default environment settings on most machines. The following examples should assist you in determining how to correct this situation. The examples cover the complete range of settings that may need updating, but they are not all needed in every situation.

  • Expand the PATH to include $PREFIX/bin.

  • Expand the PATH for root to include $PREFIX/sbin.

  • Add $PREFIX/lib to /etc/ld.so.conf or expand LD_LIBRARY_PATH to include it. Before using the latter option, check out http://xahlee.info/UnixResource_dir/_/ldpath.html. If you modify /etc/ld.so.conf, remember to update /etc/ld.so.cache by executing ldconfig as the root user.

  • Add $PREFIX/man to /etc/man_db.conf or expand MANPATH.

  • Add $PREFIX/info to INFOPATH.

  • Add $PREFIX/lib/pkgconfig to PKG_CONFIG_PATH. Some packages are now installing .pc files in $PREFIX/share/pkgconfig, so you may have to include this directory also.

  • Add $PREFIX/include to CPPFLAGS when compiling packages that depend on the package you installed.

  • Add $PREFIX/lib to LDFLAGS when compiling packages that depend on a library installed by the package.

If you are in search of a package that is not in the book, the following are different ways you can search for the desired package.

Some general hints on handling new packages:

  • Many of the newer packages follow the ./configure && make && make install process. Help on the options accepted by configure can be obtained via the command ./configure --help.

  • Most of the packages contain documentation on compiling and installing the package. Some of the documents are excellent, some not so excellent. Check out the homepage of the package for any additional and updated hints for compiling and configuring the package.

  • If you are having a problem compiling the package, try searching the LFS archives at https://www.linuxfromscratch.org/search.html for the error or if that fails, try searching Google. Often, a distribution will have already solved the problem (many of them use development versions of packages, so they see the changes sooner than those of us who normally use stable released versions). But be cautious - all builders tend to carry patches which are no longer necessary, and to have fixes which are only required because of their particular choices in how they build a package. You may have to search deeply to find a fix for the package version you are trying to use, or even to find the package (names are sometimes not what you might expect, e.g. ghostscript often has a prefix or a suffix in its name), but the following notes might help, particularly for those who, like the editors, are trying to build the latest versions and encountering problems:

    • Arch https://www.archlinux.org/packages/ - enter the package name in the 'Keywords' box, select the package name, select the 'Source Files' field, and then select the PKGBUILD entry to see how they build this package.

    • Debian https://ftp.debian.org/debian/pool (use your country's version if there is one) - the source will be in .tar.gz tarballs (either the original upstream .orig source, or else a dfsg containing those parts which comply with Debian's free software guidelines) accompanied by versioned .diff.gz or .tar.gz additions. These additions often show how the package is built, and may contain patches. In the .diff.gz versions, any patches create files in debian/patches.

    • Fedora package source gets reorganized from time to time. At the moment the package source for rpms is at https://src.fedoraproject.org/projects/rpms/%2A and from there you can try putting a package name in the search box. If the package is found you can look at the files (specfile to control the build, various patches) or the commits. If that fails, you can download an srpm (source rpm) and using rpm2cpio (see the Tip at the bottom of the page). For rpms go to https://dl.fedoraproject.org/pub/fedora/linux/ and then choose which repo you wish to look at - development/rawhide is the latest development, or choose releases for what was shipped in a release, updates for updates to a release, or updates/testing for the latest updates which might work or might have problems.

    • Gentoo - First use a search engine to find an ebuild which looks as if it will fix the problem, or search at https://packages.gentoo.org/ - use the search field. Note where the package lives in the portage hierarchy, e.g. app-something/. In general you can treat the ebuild as a sort of pseudo-code / shell combination with some functions you can hazard a guess at, such as dodoc. If the fix is just a sed, try it. However, in most cases the fix will use a patch. To find the patch, use a gentoo-portage mirror: Two links to mirrors in the U.S.A. which seem to usually be up to date are https://mirror.rackspace.com/gentoo-portage/ and https://mirror.steadfast.net/gentoo-portage/. Navigate down the tree to the package, then to the files/ directory to look for the patch. Sometimes a portage mirror has not yet been updated, particularly for a recent new patch. In a few cases, gentoo batch the patches into a tarball and the ebuild will have a link in the form https://dev.gentoo.org/~${PATCH_DEV}/distfiles/${P}-patches-${PATCH_VER}.tar.xz : here, look for PATCH_DEV and PATCH_VER in the build and format the full URL in your browser or for wget : remember the '~' before the developer's ID and note that trying to search the earlier levels of the URL in a browser may drop you at www.gentoo.org or return 403 (forbidden).

    • openSUSE provide a rolling release, some package versions are in https://download.opensuse.org/source/tumbleweed/repo/oss/src/ but others are in ../update/openSUSE-current/src - the source only seems to be available in source rpms.

    • Slackware - the official package browser is currently broken. The site at https://slackbuilds.org/ has current and previous versions in their unofficial repository with links to homepages, downloads, and some individual files, particularly the .SlackBuild files.

    • Ubuntu ftp://ftp.ubuntu.com/ubuntu/pool/ - see the Debian notes above.

    If everything else fails, try the blfs-support mailing-list.

Tip

If you have found a package that is only available in .deb or .rpm format, there are two small scripts, rpm2targz and deb2targz that are available at https://anduin.linuxfromscratch.org/BLFS/extras/deb2targz.tar.bz2 and https://anduin.linuxfromscratch.org/BLFS/extras/rpm2targz.tar.bz2 to convert the archives into a simple tar.gz format.

You may also find an rpm2cpio script useful. The Perl version in the linux kernel archives at https://lore.kernel.org/all/[email protected]/2-rpm2cpio works for most source rpms. The rpm2targz script will use an rpm2cpio script or binary if one is on your path. Note that rpm2cpio will unpack a source rpm in the current directory, giving a tarball, a spec file, and perhaps patches or other files.

Part II. Post LFS Configuration and Extra Software

Chapter 3. After LFS Configuration Issues

The intention of LFS is to provide a basic system which you can build upon. There are several things about tidying up the system which many people wonder about once they have done the base install. We hope to cover these issues in this chapter.

Most people coming from non-Unix like backgrounds to Linux find the concept of text-only configuration files slightly strange. In Linux, just about all configuration is done via the manipulation of text files. The majority of these files can be found in the /etc hierarchy. There are often graphical configuration programs available for different subsystems but most are simply pretty front ends to the process of editing a text file. The advantage of text-only configuration is that you can edit parameters using your favorite text editor, whether that be vim, emacs, or any other editor.

The first task is making a recovery boot device in Creating a Custom Boot Device because it's the most critical need. Hardware issues relevant to firmware and other devices is addressed next. The system is then configured to ease addition of new users, because this can affect the choices you make in the two subsequent topics—The Bash Shell Startup Files and The vimrc Files.

There is one remaining topic: Customizing your Logon with /etc/issue. It doesn't have much interaction with the other topics in this chapter.

Creating a Custom Boot Device

Decent Rescue Boot Device Needs

This section is really about creating a rescue device. As the name rescue implies, the host system has a problem, often lost partition information or corrupted file systems, that prevents it from booting and/or operating normally. For this reason, you must not depend on resources from the host being "rescued". To presume that any given partition or hard drive will be available is a risky presumption.

In a modern system, there are many devices that can be used as a rescue device: floppy, cdrom, usb drive, or even a network card. Which one you use depends on your hardware and your BIOS. In the past, a rescue device was thought to be a floppy disk. Today, many systems do not even have a floppy drive.

Building a complete rescue device is a challenging task. In many ways, it is equivalent to building an entire LFS system. In addition, it would be a repetition of information already available. For these reasons, the procedures for a rescue device image are not presented here.

Creating a Rescue Floppy

The software of today's systems has grown large. Linux 2.6 no longer supports booting directly from a floppy. In spite of this, there are solutions available using older versions of Linux. One of the best is Tom's Root/Boot Disk available at http://www.toms.net/rb/. This will provide a minimal Linux system on a single floppy disk and provides the ability to customize the contents of your disk if necessary.

Creating a Bootable CD-ROM

There are several sources that can be used for a rescue CD-ROM. Just about any commercial distribution's installation CD-ROMs or DVDs will work. These include RedHat, Ubuntu, and SuSE. One very popular option is Knoppix.

Also, the LFS Community has developed its own LiveCD available at https://www.linuxfromscratch.org/livecd/. This LiveCD, is no longer capable of building an entire LFS/BLFS system, but is still a good rescue CD-ROM. If you download the ISO image, use xorriso to copy the image to a CD-ROM.

The instructions for using GRUB2 to make a custom rescue CD-ROM are also available in LFS Chapter 10.

Creating a Bootable USB Drive

A USB Pen drive, sometimes called a Thumb drive, is recognized by Linux as a SCSI device. Using one of these devices as a rescue device has the advantage that it is usually large enough to hold more than a minimal boot image. You can save critical data to the drive as well as use it to diagnose and recover a damaged system. Booting such a drive requires BIOS support, but building the system consists of formatting the drive, adding GRUB as well as the Linux kernel and supporting files.

About Console Fonts

An LFS system can be used without a graphical desktop, and unless or until you install a graphical environment you will have to work in the console. Most, if not all, PCs boot with an 8x16 font - whatever the actual screen size. There are a few things you can do to alter the display on the console. Most of them involve changing the font, but the first alters the commandline used by grub.

Setting a smaller screen size in grub

Modern screens often have a lot more pixels then the screens used in the past. If your screen is 1600 pixels wide, an 8x16 font will give you 200 columns of text - unless your monitor is enormous, the text will be tiny. One of the ways to work around this is to tell grub to use a smaller size, such as 1024x768 or 800x600 or even 640x480. Even if your screen does not have a 4:3 aspect ratio, this should work.

To try this, you can reboot and edit grub's command-line to insert a 'video=' parameter between the 'root=/dev/sdXn' and 'ro', for example root=/dev/sda2 video=1024x768 ro based on the example in LFS section 10.4.4 : ../../../../lfs/view/12.0-systemd/chapter10/grub.html.

If you decide that you wish to do this, you can then (as the root user) edit /boot/grub/grub.cfg.

Using the standard psf fonts

In LFS the kbd package is used. The fonts it provides are PC Screen Fonts, usually called PSF, and they were installed into /usr/share/consolefonts. Where these include a unicode mapping table, the file suffix is often changed to .psfu although packages such as terminus-font (see below) do not add the 'u'. These fonts are usually compressed with gzip to save space, but that is not essential.

The initial PC text screens had 8 colours, or 16 colours if the bright versions of the original 8 colours were used. A PSF font can include up to 256 characters (technically, glyphs) while allowing 16 colours, or up to 512 characters (in which case, the bright colours will not be available). Clearly, these console fonts cannot be used to display CJK text - that would need thousands of available glyphs.

Some fonts in kbd can cover more than 512 codepoints ('characters'), with varying degrees of fidelity: unicode contains several whitespace codepoints which can all be mapped to a space, varieties of dashes can be mapped to a minus sign, smart quotes can map to the regular ASCII quotes rather than to whatever is used for "codepoint not present or invalid", and those cyrillic or greek letters which look like latin letters can be mapped onto them, so 'A' can also do duty for cyrillic A and greek Alpha, and 'P' can also do duty for cyrillic ER and greek RHO. Unfortunately, where a font has been created from a BDF file (the method in terminus and Debian's console-setup ) such mapping of additional codepoints onto an existing glyph is not always done, although the terminus ter-vXXn fonts do this well.

There are over 120 combinations of font and size in kbd: often a font is provided at several character sizes, and sometimes varieties cover different subsets of unicode. Most are 8 pixels wide, in heights from 8 to 16 pixels, but there are a few which are 9 pixels wide, some others which are 12x22, and even one (latarcyrheb-sun32.psfu) which has been scaled up to 16x32. Using a bigger font is another way of making text on a large screen easier to read.

Testing different fonts

You can test fonts as a normal user. If you have a font which has not been installed, you can load it with :

setfont /path/to/yourfont.ext

For the fonts already installed you only need the name, so using gr737a-9x16.psfu.gz as an example:

setfont gr737a-9x16

To see the glyphs in the font, use:

showconsolefont

If the font looks as if it might be useful, you can then go on to test it more thoroughly.

When you find a font which you wish to use, as the root user) edit /etc/vconsole.conf as described in LFS section 9.6 ../../../../lfs/view/12.0-systemd/chapter09/console.html..

For fonts not supplied with the kbd package you will need to optionally compress it / them with gzip and then install it / them as the root user.

Editing fonts using psf-tools

Although some console fonts are created from BDF files, which is a text format with hex values for the pixels in each row of the character, there are more-modern tools available for editing psf fonts. The psftools package allows you to dump a font to a text representation with a dash for a pixel which is off (black) and a hash for a pixel which is on (white). You can then edit the text file to add more characters, or reshape them, or map extra codepoints onto them, and then create a new psf font with your changes.

Using fonts from Terminus-font

The Terminus Font package provides fixed-width bitmap fonts designed for long (8 hours and more per day) work with computers. Under 'Character variants' on that page is a list of patches (in the alt/ directory). If you are using a graphical browser to look at that page, you can see what the patches do, e.g. 'll2' makes 'l' more visibly different from 'i' and '1'.

By default terminus-fonts will try to create several types of font, and it will fail if bdftopcf from Xorg Applications has not been installed. The configure script is only really useful if you go on to install all the fonts (console and X11 bitmap) to the correct directories, as in a distro. To build only the PSF fonts and their dependencies, run:

make psf

This will create more than 240 ter-*.psf fonts. The 'b' suffix indicates bright, 'n' indicates normal. You can then test them to see if any fit your requirements. Unless you are creating a distro, there seems little point in installing them all.

As an example, to install the last of these fonts, you can gzip it and then as the root user:

install -v -m644 ter-v32n.psf.gz /usr/share/consolefonts

About Firmware

On some recent PCs it can be necessary, or desirable, to load firmware to make them work at their best. There is a directory, /lib/firmware, where the kernel or kernel drivers look for firmware images.

Currently, most firmware can be found at a git repository: https://git.kernel.org/cgit/linux/kernel/git/firmware/linux-firmware.git/tree/. For convenience, the LFS Project has created a mirror, updated daily, where these firmware files can be accessed via wget or a web browser at https://anduin.linuxfromscratch.org/BLFS/linux-firmware/.

To get the firmware, either point a browser to one of the above repositories and then download the item(s) which you need, or install git-2.41.0 and clone that repository.

For some other firmware, particularly for Intel microcode and certain wifi devices, the needed firmware is not available in the above repository. Some of this will be addressed below, but a search of the Internet for needed firmware is sometimes necessary.

Firmware files are conventionally referred to as blobs because you cannot determine what they will do. Note that firmware is distributed under various different licenses which do not permit disassembly or reverse-engineering.

Firmware for PCs falls into four categories:

  • Updates to the CPU to work around errata, usually referred to as microcode.

  • Firmware for video controllers. On x86 machines this is required for ATI devices (Radeon and AMDGPU chips) and may be useful for Intel (Skylake and later) and Nvidia (Kepler and later) GPUs.

    ATI Radeon and AMDGPU devices all require firmware to be able to use KMS (kernel modesetting - the preferred option) as well as for Xorg. For old radeon chips (before the R600), the firmware is still in the kernel source.

    Intel integrated GPUs from Skylake onwards can use firmware for GuC (the Graphics microcontroller), and also for the HuC (HEVC/H265 microcontroller which offloads to the GPU) and the DMC (Display Microcontroller) to provide additional low-power states. The GuC and HuC have had a chequered history in the kernel and updated firmware may be disabled by default, depending on your kernel version. Further details may be found at 01.org and Arch linux.

    Nvidia GPUs from Kepler onwards require signed firmware, otherwise the nouveau driver is unable to provide hardware acceleration. Nvidia has now released firmware up to Ampere (GeForce30 series) to linux-firmware. Note that faster clocks than the default are not enabled by the released firmware.

  • Firmware updates for wired network ports. Most of them work even without the updates, but they will probably work better with the updated firmware. For some modern laptops, firmware for both wired ethernet (e.g. rtl_nic) and also for bluetooth devices (e.g. qca) is required before the wired network can be used.

  • Firmware for other devices, such as wireless NICs. These devices are not required for the PC to boot, but need the firmware before these devices can be used.

Note

Although not needed to load a firmware blob, the following tools may be useful for determining, obtaining, or preparing the needed firmware in order to load it into the system: cpio-2.14, git-2.41.0, pciutils-3.10.0, and Wget-1.21.4

Microcode updates for CPUs

In general, microcode can be loaded by the BIOS or UEFI, and it might be updated by upgrading to a newer version of those. On linux, you can also load the microcode from the kernel if you are using an AMD family 10h or later processor (first introduced late 2007), or an Intel processor from 1998 and later (Pentium4, Core, etc), if updated microcode has been released. These updates only last until the machine is powered off, so they need to be applied on every boot.

Intel provide updates of their microcode for Skylake and later processors as new vulnerabilities come to light, and have in the past provided updates for processors from SandyBridge onwards, although those are no-longer supported for new fixes. New versions of AMD firmware are rare and usually only apply to a few models, although motherboard manufacturers get AGESA (AMD Generic Encapsulated Software Architecture) updates to change BIOS values, e.g. to support more memory variants, new vulnerability fixes or newer CPUs.

There were two ways of loading the microcode, described as 'early' and 'late'. Early loading happens before userspace has been started, late loading happens after userspace has started. However, late loading is known to be problematic and not supported anymore (see the kernel commit x86/microcode: Taint and warn on late loading.) Indeed, early loading is needed to work around one particular erratum in early Intel Haswell processors which had TSX enabled. (See Intel Disables TSX Instructions: Erratum Found in Haswell, Haswell-E/EP, Broadwell-Y.) Without this update glibc can do the wrong thing in uncommon situations.

In previous versions of this book, late loading of microcode to see if it gets applied was recommended, followed by using an initrd to force early loading. But now that the contents of the Intel microcode tarball is documented, and AMD microcode can be read by a Python script to determine which machines it covers, there is no real reason to use late loading.

It might be still possible to manually force late loading of microcode. But it may cause kernel malfunction and you should take the risk yourself. You will need to reconfigure your kernel for either method. The instructions here will show you how to create an initrd for early loading. It is also possible to build the same microcode bin file into the kernel, which allows early loading but requires the kernel to be recompiled to update the microcode.

To confirm what processor(s) you have (if more than one, they will be identical) look in /proc/cpuinfo. Determine the decimal values of the cpu family, model and stepping by running the following command (it will also report the current microcode version):

head -n7 /proc/cpuinfo

Convert the cpu family, model and stepping to pairs of hexadecimal digits, and remember the value of the microcode field. You can now check if there is any microcode available.

If you are creating an initrd to update firmware for different machines, as a distro would do, go down to 'Early loading of microcode' and cat all the Intel blobs to GenuineIntel.bin or cat all the AMD blobs to AuthenticAMD.bin. This creates a larger initrd - for all Intel machines in the 20200609 update the size was 3.0 MB compared to typically 24 KB for one machine.

Intel Microcode for the CPU

The first step is to get the most recent version of the Intel microcode. This must be done by navigating to https://github.com/intel/Intel-Linux-Processor-Microcode-Data-Files/releases/ and downloading the latest file there. As of this writing the most secure version of the microcode is microcode-20230808. Extract this file in the normal way, the microcode is in the intel-ucode directory, containing various blobs with names in the form XX-YY-ZZ. There are also various other files, and a releasenote.

In the past, intel did not provide any details of which blobs had changed versions, but now the releasenote details this. You can compare the microcode version in /proc/cpuinfo with the version for your CPU model in the releasenote to know if there is an update.

The recent firmware for older processors is provided to deal with vulnerabilities which have now been made public, and for some of these such as Microarchitectural Data Sampling (MDS) you might wish to increase the protection by disabling hyperthreading, or alternatively to disable the kernel's default mitigation because of its impact on compile times. Please read the online documentation at https://www.kernel.org/doc/html/latest/admin-guide/hw-vuln/index.html.

For an Tigerlake mobile (described as Intel(R) Core(TM) i5-11300H CPU) the relevant values are cpu family 6, model 140, stepping 1 so in this case the required identification is 06-8c-01. The releasenote says the latest microcode for it is versioned 0xac. If the value of the microcode field in /proc/cpuinfo is 0xac or greater, it indicates the microcode update is already applied by the BIOS. Otherwise, configure the kernel to support loading Intel microcode, and then proceed to the section called “Early loading of microcode”:

General setup --->
  [*] Initial RAM filesystem and RAM disk (initramfs/initrd) support
                                                           ...  [BLK_DEV_INITRD]

Processor type and features --->
  [*] CPU microcode loading support                                  [MICROCODE]
  [*]   Intel microcode loading support                        [MICROCODE_INTEL]

AMD Microcode for the CPU

Begin by downloading a container of firmware for your CPU family from https://anduin.linuxfromscratch.org/BLFS/linux-firmware/amd-ucode/. The family is always specified in hex. Families 10h to 14h (16 to 20) are in microcode_amd.bin. Families 15h, 16h, 17h (Zen, Zen+, Zen2) and 19h (Zen3) have their own containers, but very few machines are likely to get updated microcode. Instead, AMD provide an updated AGESA to the motherboard makers, who may provide an updated BIOS using this. There is a Python3 script at https://github.com/AMDESE/amd_ucode_info/blob/master/amd_ucode_info.py. Download that script and run it against the bin file to check which processors have updates.

For the very old Athlon(tm) II X2 in these examples the values were cpu family 16, model 5, stepping 3 giving an identification of Family=0x10 Model=0x05 Stepping=0x03. One line of the amd_ucode_info.py script output describes the microcode version for it:

Family=0x10 Model=0x05 Stepping=0x03: Patch=0x010000c8 Length=960 bytes

If the value of the microcode field in /proc/cpuinfo is 0x10000c8 or greater, it indicates the BIOS has already applied the microcode update. Otherwise, configure the kernel to support loading AMD microcode, and then proceed to the section called “Early loading of microcode”:

General setup --->
  [*] Initial RAM filesystem and RAM disk (initramfs/initrd) support
                                                           ...  [BLK_DEV_INITRD]

Processor type and features --->
  [*] CPU microcode loading support                                  [MICROCODE]
  [*]   AMD microcode loading support                            [MICROCODE_AMD]

Early loading of microcode

If you have established that updated microcode is available for your system, it is time to prepare it for early loading. This requires an additional package, cpio-2.14 and the creation of an initrd which will need to be added to grub.cfg.

It does not matter where you prepare the initrd, and once it is working you can apply the same initrd to later LFS systems or newer kernels on this same machine, at least until any newer microcode is released. Use the following commands:

mkdir -p initrd/kernel/x86/microcode
cd initrd

For an AMD machine, use the following command (replace <MYCONTAINER> with the name of the container for your CPU's family):

cp -v ../<MYCONTAINER> kernel/x86/microcode/AuthenticAMD.bin

Or for an Intel machine copy the appropriate blob using this command:

cp -v ../intel-ucode/<XX-YY-ZZ> kernel/x86/microcode/GenuineIntel.bin

Now prepare the initrd:

find . | cpio -o -H newc > /boot/microcode.img

You now need to add a new entry to /boot/grub/grub.cfg and here you should add a new line after the linux line within the stanza. If /boot is a separate mountpoint:

initrd /microcode.img

or this if it is not:

initrd /boot/microcode.img

If you are already booting with an initrd (see the section called “About initramfs”), you should run mkinitramfs again after putting the appropriate blob or container into /lib/firmware. More precisely, put an intel blob in a /lib/firmware/intel-ucode directory or an AMD container in a /lib/firmware/amd-ucode directory before running mkinitramfs. Alternatively, you can have both initrd on the same line, such as initrd /microcode.img /other-initrd.img (adapt that as above if /boot is not a separate mountpoint).

You can now reboot with the added initrd, and then use the following command to check that the early load worked:

dmesg | grep -e 'microcode' -e 'Linux version' -e 'Command line'

If you updated to address vulnerabilities, you can look at the output of the lscpu command to see what is now reported.

The places and times where early loading happens are very different in AMD and Intel machines. First, an example of an Intel (Tigerlake mobile) with early loading:

[    0.000000] microcode: microcode updated early: 0x86 -> 0xac, date = 2023-02-27
[    0.000000] Linux version 6.4.7 (root@stargazer) (gcc (GCC) 13.2.0, GNU ld (GNU Binutils) 2.41) #1 SMP PREEMPT_DYNAMIC Wed Aug  2 19:08:46 CST 2023
[    0.000000] Command line: BOOT_IMAGE=/boot/vmlinuz-6.4.7 root=PARTUUID=<CLASSIFIED> ro
[    0.424002] microcode: Microcode Update Driver: v2.2.

A historic AMD example:

[    0.000000] Linux version 4.15.3 (ken@testserver) (gcc version 7.3.0 (GCC))
               #2 SMP Sun Feb 18 02:32:03 GMT 2018
[    0.000000] Command line: BOOT_IMAGE=/vmlinuz-4.15.3-sda5 root=/dev/sda5 ro
[    0.307619] microcode: microcode updated early to new patch_level=0x010000c8
[    0.307678] microcode: CPU0: patch_level=0x010000c8
[    0.307723] microcode: CPU1: patch_level=0x010000c8
[    0.307795] microcode: Microcode Update Driver: v2.2.

Firmware for Video Cards

Firmware for ATI video chips (R600 and later)

These instructions do NOT apply to old radeons before the R600 family. For those, the firmware is in the kernel's /lib/firmware/ directory. Nor do they apply if you intend to avoid a graphical setup such as Xorg and are content to use the default 80x25 display rather than a framebuffer.

Early radeon devices only needed a single 2K blob of firmware. Recent devices need several different blobs, and some of them are much bigger. The total size of the radeon firmware directory is over 500K — on a large modern system you can probably spare the space, but it is still redundant to install all the unused files each time you build a system.

A better approach is to install pciutils-3.10.0 and then use lspci to identify which VGA controller is installed.

With that information, check the RadeonFeature page of the Xorg wiki for Decoder ring for engineering vs marketing names to identify the family (you may need to know this for the Xorg driver in BLFS — Southern Islands and Sea Islands use the radeonsi driver) and the specific model.

Now that you know which controller you are using, consult the Radeon page of the Gentoo wiki which has a table listing the required firmware blobs for the various chipsets. Note that Southern Islands and Sea Islands chips use different firmware for kernel 3.17 and later compared to earlier kernels. Identify and download the required blobs then install them:

mkdir -pv /lib/firmware/radeon
cp -v <YOUR_BLOBS> /lib/firmware/radeon

Building the kernel amdgpu driver as a module is recommended because the firmware files need to be accessible at the time it is loaded. If you are building it as a part of the kernel image for any reason, you need to either include the firmware files in the initramfs (read the section called “About initramfs” for details), or include them in the kernel image itself (read the section called “Include Firmware Blobs in the Kernel Image” for details).

Firmware for AMD/ATI amdgpu video chips

All video controllers using the amdgpu kernel driver require firmware, whether you will be using the xorg amdgpu driver, the xserver's modesetting driver, or just kernel modesetting to get a console framebuffer larger than 80x25.

Install pciutils-3.10.0 and use that to check the model name (look for 'VGA compatible controller:'). If you have an APU (Accelerated Processing Unit, i.e. CPU and video on the same chip) that will probably tell you the name. If you have a separate amdgpu video card you will need to search to determine which name it uses (e.g. a card described as Advanced Micro Devices, Inc. [AMD/ATI] Baffin [Radeon RX 550 640SP / RX 560/560X] needs Polaris11 firmware. There is a table of "Family, Chipset name, Product name and Firmware" at the end of the Kernel sections in AMDGPU page of the Gentoo wiki.

Once you have identified the firmware name, install all the relevant files for it. For example, the Baffin card mentioned above has 21 different polaris11* files, APUs such as renoir and picasso have at least 12 files and might gain more in future updates (e.g. the raven APU now has a 13th file, raven_ta.bin).

mkdir -pv /lib/firmware/amdgpu
cp -v <YOUR_BLOBS> /lib/firmware/amdgpu

If disk space is not a problem, you could install all the current amdgpu firmware files and not worry about exactly which chipset is installed.

Building the kernel amdgpu driver as a module is recommended because the firmware files need to be accessible at the time it is loaded. If you are building it as a part of the kernel image for any reason, you need to either include the firmware files in the initramfs (read the section called “About initramfs” for details), or include them in the kernel image itself (read the section called “Include Firmware Blobs in the Kernel Image” for details).

Firmware for Nvidia video chips

Nvidia has released basic signed firmware for recent graphics chips, but significantly after the chips and its own binary drivers were first available. For other chips it has been necessary to extract the firmware from the binary driver.

For more exact information about which chips need extracted firmware, see https://nouveau.freedesktop.org/VideoAcceleration.html.

If the necessary firmware is available in the nvidia/ directory of linux-firmware, copy it to /lib/firmware/nouveau.

If the firmware has not been made available in linux-firmware, for the old chips mentioned in the nouveau wiki link above run the following commands:

wget https://anduin.linuxfromscratch.org/BLFS/nvidia-firmware/extract_firmware.py
wget https://us.download.nvidia.com/XFree86/Linux-x86/340.32/NVIDIA-Linux-x86-340.32.run
sh NVIDIA-Linux-x86-340.32.run --extract-only
python3 extract_firmware.py
mkdir -p /lib/firmware/nouveau
cp -d nv* vuc-* /lib/firmware/nouveau/

Firmware for Network Interfaces

The kernel likes to load firmware for some network drivers, particularly those from Realtek (the /lib/linux-firmware/rtl_nic/) directory, but they generally appear to work without it. Therefore, you can boot the kernel, check dmesg for messages about this missing firmware, and if necessary download the firmware and put it in the specified directory in /lib/firmware so that it will be found on subsequent boots. Note that with current kernels this works whether or not the driver is compiled in or built as a module, there is no need to build this firmware into the kernel. Here is an example where the R8169 driver has been compiled in but the firmware was not made available. Once the firmware had been provided, there was no mention of it on later boots.

dmesg | grep firmware | grep r8169
[    7.018028] r8169 0000:01:00.0: Direct firmware load for rtl_nic/rtl8168g-2.fw failed with error -2
[    7.018036] r8169 0000:01:00.0 eth0: unable to load firmware patch rtl_nic/rtl8168g-2.fw (-2)

Firmware for Regulatory Database of Wireless Devices

Different countries have different regulations on the radio spectrum usage of wireless devices. You can install a firmware to make the wireless devices obey local spectrum regulations, so you won't be inquired by local authority or find your wireless NIC jamming the frequencies of other devices (for example, remote controllers). The regulatory database firmware can be downloaded from https://kernel.org/pub/software/network/wireless-regdb/. To install it, simply extract regulatory.db and regulatory.db.p7s from the tarball into /lib/firmware. Note that either the cfg80211 driver needs to be selected as a module for the regulatory.* files to be loaded, or those files need to be included as firmware into the kernel, as explained above in the section called “Firmware for Video Cards”.

The access point (AP) would send a country code to your wireless NIC, and wpa_supplicant-2.10 would tell the kernel to load the regulation of this country from regulatory.db, and enforce it. Note that several AP don't send this country code, so you may be locked to a rather restricted usage (specially if you want to use your interface as an AP).

Sound Open Firmware

Some systems (especially budget laptops) utilizes a DSP shipped with the CPU for connection with the audio codec. The Sound Open Firmware must be loaded onto the DSP to make it functional. These firmware files can be downloaded from https://github.com/thesofproject/sof-bin/releases. Extract the tarball and changing into the extracted directory, then as the root user install the firmware:

install -vdm755 /usr/lib/firmware/intel       &&
cp -av -T --no-preserve=ownership sof-v*      \
   /usr/lib/firmware/intel/sof                &&
cp -av -T --no-preserve=ownership sof-tplg-v* \
   /usr/lib/firmware/intel/sof-tplg

alsa-lib-1.2.9 needs Use Case Manager configuration files for the systems using Sound Open Firmware as well. The ALSA UCM configuration files can be downloaded from https://github.com/alsa-project/alsa-ucm-conf/tags. Extract the tarball and changing into the extracted directory, then as the root user install the configuration files:

install -vdm755 /usr/share/alsa &&
cp -av -T --no-preserve=ownership ucm2 /usr/share/alsa/ucm2

Once the firmware is loaded (you may need a reboot so the kernel will load them) and the UCM configuration files are installed, following the section called “Configuring ALSA Utilities” to set up your sound card for ALSA properly.

Firmware for Other Devices

Identifying the correct firmware will typically require you to install pciutils-3.10.0, and then use lspci to identify the device. You should then search online to check which module it uses, which firmware, and where to obtain the firmware — not all of it is in linux-firmware.

If possible, you should begin by using a wired connection when you first boot your LFS system. To use a wireless connection you will need to use a network tools such as iw-5.19, Wireless Tools-29, or wpa_supplicant-2.10.

Firmware may also be needed for other devices such as some SCSI controllers, bluetooth adaptors, or TV recorders. The same principles apply.

Include Firmware Blobs in the Kernel Image

Some drivers, notably the drivers for ATI or AMD GPU, requires the firmware files accessible at the time it is loaded. The easiest method to handle these drivers is building them as a kernel module. An alternative method is creating an initramfs (read the section called “About initramfs” for details) including the firmware files. If you don't want to use either methods, you may include the firmware files in the kernel image itself. Install the needed firmware files into /lib/firmware first, then set the following kernel configuration and rebuild the kernel:

Device Drivers --->
  Generic Driver Options --->
    Firmware loader --->
      <*>                   Firmware loading facility                [FW_LOADER]
      (xx/aa.bin xx/bb.bin)   Build named firmware blobs into the kernel binary
                                                           ...  [EXTRA_FIRMWARE]
      (/lib/firmware)           Firmware blobs root directory
                                                       ...  [EXTRA_FIRMWARE_DIR]

Replace xx/aa.bin xx/bb.bin with a whitespace-separated list of paths to the needed firmware files, relative to /lib/firmware. A method easier than manually typing the list (it may be long) is running the following command:

echo CONFIG_EXTRA_FIRMWARE='"'$({ cd /lib/firmware; echo amdgpu/* })'"' >> .config
make oldconfig

Replace amdgpu/* with a shell pattern matching the needed firmware files.

Warning

Do not distribute a kernel image containing the firmware to others or you may violate the GPL.

About Devices

Although most devices needed by packages in BLFS and beyond are set up properly by udev using the default rules installed by LFS in /etc/udev/rules.d, there are cases where the rules must be modified or augmented.

Multiple Sound Cards

If there are multiple sound cards in a system, the "default" sound card becomes random. The method to establish sound card order depends on whether the drivers are modules or not. If the sound card drivers are compiled into the kernel, control is via kernel command line parameters in /boot/grub/grub.cfg. For example, if a system has both an FM801 card and a SoundBlaster PCI card, the following can be appended to the command line:

snd-fm801.index=0 snd-ens1371.index=1

If the sound card drivers are built as modules, the order can be established in the /etc/modprobe.conf file with:

options snd-fm801 index=0
options snd-ens1371 index=1

USB Device Issues

USB devices usually have two kinds of device nodes associated with them.

The first kind is created by device-specific drivers (e.g., usb_storage/sd_mod or usblp) in the kernel. For example, a USB mass storage device would be /dev/sdb, and a USB printer would be /dev/usb/lp0. These device nodes exist only when the device-specific driver is loaded.

The second kind of device nodes (/dev/bus/usb/BBB/DDD, where BBB is the bus number and DDD is the device number) are created even if the device doesn't have a kernel driver. By using these "raw" USB device nodes, an application can exchange arbitrary USB packets with the device, i.e., bypass the possibly-existing kernel driver.

Access to raw USB device nodes is needed when a userspace program is acting as a device driver. However, for the program to open the device successfully, the permissions have to be set correctly. By default, due to security concerns, all raw USB devices are owned by user root and group root, and have 0664 permissions (the read access is needed, e.g., for lsusb to work and for programs to access USB hubs). Packages (such as SANE and libgphoto2) containing userspace USB device drivers also ship udev rules that change the permissions of the controlled raw USB devices. That is, rules installed by SANE change permissions for known scanners, but not printers. If a package maintainer forgot to write a rule for your device, report a bug to both BLFS (if the package is there) and upstream, and you will need to write your own rule.

Before Linux-2.6.15, raw USB device access was performed not with /dev/bus/usb/BBB/DDD device nodes, but with /proc/bus/usb/BBB/DDD pseudofiles. Some applications still use only this deprecated technique and can't use the new device nodes. They cannot work with Linux kernel version 3.5 or newer. If you need to run such an application, contact the developer of it for a fix.

Udev Device Attributes

Fine-tuning of device attributes such as group name and permissions is possible by creating extra udev rules, matching on something like this. The vendor and product can be found by searching the /sys/devices directory entries or using udevadm info after the device has been attached. See the documentation in the current udev directory of /usr/share/doc for details.

SUBSYSTEM=="usb_device", SYSFS{idVendor}=="05d8", SYSFS{idProduct}=="4002", \
  GROUP:="scanner", MODE:="0660"

Note

The above line is used for descriptive purposes only. The scanner udev rules are put into place when installing SANE-1.0.32.

Devices for DVD Drives

If the initial boot process does not set up the /dev/dvd device properly, it can be installed using the following modification to the default udev rules. As the root user, run:

sed '1d;/SYMLINK.*cdrom/ a\
KERNEL=="sr0", ENV{ID_CDROM_DVD}=="1", SYMLINK+="dvd", OPTIONS+="link_priority=-100"' \
/lib/udev/rules.d/60-cdrom_id.rules > /etc/udev/rules.d/60-cdrom_id.rules

Configuring for Adding Users

Together, the /usr/sbin/useradd command and /etc/skel directory (both are easy to set up and use) provide a way to assure new users are added to your LFS system with the same beginning settings for things such as the PATH, keyboard processing and other environmental variables. Using these two facilities makes it easier to assure this initial state for each new user added to the system.

The /etc/skel directory holds copies of various initialization and other files that may be copied to the new user's home directory when the /usr/sbin/useradd program adds the new user.

Useradd

The useradd program uses a collection of default values kept in /etc/default/useradd. This file is created in a base LFS installation by the Shadow package. If it has been removed or renamed, the useradd program uses some internal defaults. You can see the default values by running /usr/sbin/useradd -D.

To change these values, simply modify the /etc/default/useradd file as the root user. An alternative to directly modifying the file is to run useradd as the root user while supplying the desired modifications on the command line. Information on how to do this can be found in the useradd man page.

/etc/skel

To get started, create an /etc/skel directory and make sure it is writable only by the system administrator, usually root. Creating the directory as root is the best way to go.

The mode of any files from this part of the book that you put in /etc/skel should be writable only by the owner. Also, since there is no telling what kind of sensitive information a user may eventually place in their copy of these files, you should make them unreadable by "group" and "other".

You can also put other files in /etc/skel and different permissions may be needed for them.

Decide which initialization files should be provided in every (or most) new user's home directory. The decisions you make will affect what you do in the next two sections, The Bash Shell Startup Files and The vimrc Files. Some or all of those files will be useful for root, any already-existing users, and new users.

The files from those sections that you might want to place in /etc/skel include .inputrc, .bash_profile, .bashrc, .bash_logout, .dircolors, and .vimrc. If you are unsure which of these should be placed there, just continue to the following sections, read each section and any references provided, and then make your decision.

You will run a slightly modified set of commands for files which are placed in /etc/skel. Each section will remind you of this. In brief, the book's commands have been written for files not added to /etc/skel and instead just sends the results to the user's home directory. If the file is going to be in /etc/skel, change the book's command(s) to send output there instead and then just copy the file from /etc/skel to the appropriate directories, like /etc, ~ or the home directory of any other user already in the system.

When Adding a User

When adding a new user with useradd, use the -m parameter, which tells useradd to create the user's home directory and copy files from /etc/skel (can be overridden) to the new user's home directory. For example (perform as the root user):

useradd -m <newuser>

If you are sharing a /home or /usr/src with another Linux distro (for example, the host distro used for building LFS), you can create a user with the same UID (and, same primary group GID) to keep the file ownership consistent across the systems. First, on the other distro, get the UID of the user and the GID of the user's primary group:

getent passwd <username> | cut -d ':' -f 3,4

The command should output the UID and GID, separated by a colon. Now on the BLFS system, create the primary group and the user:

groupadd -g <GID> <username> &&
useradd -u <UID> -g <username> <username>

About System Users and Groups

Throughout BLFS, many packages install programs that run as daemons or in some way should have a user or group name assigned. Generally these names are used to map a user ID (uid) or group ID (gid) for system use. Generally the specific uid or gid numbers used by these applications are not significant. The exception of course, is that root has a uid and gid of 0 (zero) that is indeed special. The uid values are stored in /etc/passwd and the gid values are found in /etc/group.

Customarily, Unix systems classify users and groups into two categories: system users and regular users. The system users and groups are given low numbers and regular users and groups have numeric values greater than all the system values. The cutoff for these numbers is found in two parameters in the /etc/login.defs configuration file. The default UID_MIN value is 1000 and the default GID_MIN value is 1000. If a specific uid or gid value is not specified when creating a user with useradd or a group with groupadd the values assigned will always be above these cutoff values.

Additionally, the Linux Standard Base recommends that system uid and gid values should be below 100.

Below is a table of suggested uid/gid values used in BLFS beyond those defined in a base LFS installation. These can be changed as desired, but provide a suggested set of consistent values.

Table 3.1. UID/GID Suggested Values

Name uid gid
bin 1
lp 9
adm 16
atd 17 17
messagebus 18 18
lpadmin   19
named 20 20
gdm 21 21
fcron 22 22
systemd-journal 23 23
apache 25 25
smmsp 26 26
polkitd 27 27
rpc 28 28
exim 31 31
postfix 32 32
postdrop 33
sendmail 34
mail 34
vmailman 35 35
news 36 36
kdm 37 37
fetchmail 38
mysql 40 40
postgres 41 41
dovecot 42 42
dovenull 43 43
ftp 45 45
proftpd 46 46
vsftpd 47 47
rsyncd 48 48
sshd 50 50
stunnel 51 51
dhcpcd 52 52
svn 56 56
svntest 57
git 58 58
games 60 60
kvm 61
wireshark 62
lightdm 63 63
sddm 64 64
lightdm 65 65
scanner 70
colord 71 71
systemd-journal-gateway 73 73
systemd-journal-remote 74 74
systemd-journal-upload 75 75
systemd-network 76 76
systemd-resolve 77 77
systemd-timesync 78 78
systemd-coredump 79 79
uuidd 80 80
systemd-oom 81 81
ldap 83 83
avahi 84 84
avahi-autoipd 85 85
netdev 86
ntp 87 87
unbound 88 88
plugdev 90
wheel 97
anonymous 98
nobody 65534
nogroup 65534

The Bash Shell Startup Files

The shell program /bin/bash (hereafter referred to as just "the shell") uses a collection of startup files to help create an environment. Each file has a specific use and may affect login and interactive environments differently. The files in the /etc directory generally provide global settings. If an equivalent file exists in your home directory it may override the global settings.

An interactive login shell is started after a successful login, using /bin/login, by reading the /etc/passwd file. This shell invocation normally reads /etc/profile and its private equivalent ~/.bash_profile (or ~/.profile if called as /bin/sh) upon startup.

An interactive non-login shell is normally started at the command-line using a shell program (e.g., [prompt]$/bin/bash) or by the /bin/su command. An interactive non-login shell is also started with a terminal program such as xterm or konsole from within a graphical environment. This type of shell invocation normally copies the parent environment and then reads the user's ~/.bashrc file for additional startup configuration instructions.

A non-interactive shell is usually present when a shell script is running. It is non-interactive because it is processing a script and not waiting for user input between commands. For these shell invocations, only the environment inherited from the parent shell is used.

The file ~/.bash_logout is not used for an invocation of the shell. It is read and executed when a user exits from an interactive login shell.

Many distributions use /etc/bashrc for system wide initialization of non-login shells. This file is usually called from the user's ~/.bashrc file and is not built directly into bash itself. This convention is followed in this section.

For more information see info bash -- Nodes: Bash Startup Files and Interactive Shells.

Note

Most of the instructions below are used to create files located in the /etc directory structure which requires you to execute the commands as the root user. If you elect to create the files in user's home directories instead, you should run the commands as an unprivileged user.

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/bash-shell-startup-files

/etc/profile

Here is a base /etc/profile. This file starts by setting up some helper functions and some basic parameters. It specifies some bash history parameters and, for security purposes, disables keeping a permanent history file for the root user. It also sets a default user prompt. It then calls small, single purpose scripts in the /etc/profile.d directory to provide most of the initialization.

For more information on the escape sequences you can use for your prompt (i.e., the PS1 environment variable) see info bash -- Node: Printing a Prompt.

cat > /etc/profile << "EOF"
# Begin /etc/profile
# Written for Beyond Linux From Scratch
# by James Robertson <[email protected]>
# modifications by Dagmar d'Surreal <[email protected]>

# System wide environment variables and startup programs.

# System wide aliases and functions should go in /etc/bashrc.  Personal
# environment variables and startup programs should go into
# ~/.bash_profile.  Personal aliases and functions should go into
# ~/.bashrc.

# Functions to help us manage paths.  Second argument is the name of the
# path variable to be modified (default: PATH)
pathremove () {
        local IFS=':'
        local NEWPATH
        local DIR
        local PATHVARIABLE=${2:-PATH}
        for DIR in ${!PATHVARIABLE} ; do
                if [ "$DIR" != "$1" ] ; then
                  NEWPATH=${NEWPATH:+$NEWPATH:}$DIR
                fi
        done
        export $PATHVARIABLE="$NEWPATH"
}

pathprepend () {
        pathremove $1 $2
        local PATHVARIABLE=${2:-PATH}
        export $PATHVARIABLE="$1${!PATHVARIABLE:+:${!PATHVARIABLE}}"
}

pathappend () {
        pathremove $1 $2
        local PATHVARIABLE=${2:-PATH}
        export $PATHVARIABLE="${!PATHVARIABLE:+${!PATHVARIABLE}:}$1"
}

export -f pathremove pathprepend pathappend

# Set the initial path
export PATH=/usr/bin

# Attempt to provide backward compatibility with LFS earlier than 11
if [ ! -L /bin ]; then
        pathappend /bin
fi

if [ $EUID -eq 0 ] ; then
        pathappend /usr/sbin
        if [ ! -L /sbin ]; then
                pathappend /sbin
        fi
        unset HISTFILE
fi

# Set up some environment variables.
export HISTSIZE=1000
export HISTIGNORE="&:[bf]g:exit"

# Set some defaults for graphical systems
export XDG_DATA_DIRS=${XDG_DATA_DIRS:-/usr/share/}
export XDG_CONFIG_DIRS=${XDG_CONFIG_DIRS:-/etc/xdg/}
export XDG_RUNTIME_DIR=${XDG_RUNTIME_DIR:-/tmp/xdg-$USER}

# Set up a red prompt for root and a green one for users.
NORMAL="\[\e[0m\]"
RED="\[\e[1;31m\]"
GREEN="\[\e[1;32m\]"
if [[ $EUID == 0 ]] ; then
  PS1="$RED\u [ $NORMAL\w$RED ]# $NORMAL"
else
  PS1="$GREEN\u [ $NORMAL\w$GREEN ]\$ $NORMAL"
fi

for script in /etc/profile.d/*.sh ; do
        if [ -r $script ] ; then
                . $script
        fi
done

unset script RED GREEN NORMAL

# End /etc/profile
EOF

The /etc/profile.d Directory

Now create the /etc/profile.d directory, where the individual initialization scripts are placed:

install --directory --mode=0755 --owner=root --group=root /etc/profile.d

/etc/profile.d/bash_completion.sh

Note

Using the bash completion script below is controversial. Not all users like it. It adds many (usually over 1000) lines to the bash environment and makes it difficult to use the 'set' command to examine simple environment variables. Omitting this script does not interfere with the ability of bash to use the tab key for file name completion.

This script imports bash completion scripts, installed by many other BLFS packages, to allow TAB command line completion.

cat > /etc/profile.d/bash_completion.sh << "EOF"
# Begin /etc/profile.d/bash_completion.sh
# Import bash completion scripts

# If the bash-completion package is installed, use its configuration instead
if [ -f /usr/share/bash-completion/bash_completion ]; then

  # Check for interactive bash and that we haven't already been sourced.
  if [ -n "${BASH_VERSION-}" -a -n "${PS1-}" -a -z "${BASH_COMPLETION_VERSINFO-}" ]; then

    # Check for recent enough version of bash.
    if [ ${BASH_VERSINFO[0]} -gt 4 ] || \
       [ ${BASH_VERSINFO[0]} -eq 4 -a ${BASH_VERSINFO[1]} -ge 1 ]; then
       [ -r "${XDG_CONFIG_HOME:-$HOME/.config}/bash_completion" ] && \
            . "${XDG_CONFIG_HOME:-$HOME/.config}/bash_completion"
       if shopt -q progcomp && [ -r /usr/share/bash-completion/bash_completion ]; then
          # Source completion code.
          . /usr/share/bash-completion/bash_completion
       fi
    fi
  fi

else

  # bash-completions are not installed, use only bash completion directory
  if shopt -q progcomp; then
    for script in /etc/bash_completion.d/* ; do
      if [ -r $script ] ; then
        . $script
      fi
    done
  fi
fi

# End /etc/profile.d/bash_completion.sh
EOF

Make sure that the directory exists:

install --directory --mode=0755 --owner=root --group=root /etc/bash_completion.d

For a more complete installation, see https://wiki.linuxfromscratch.org/blfs/wiki/bash-shell-startup-files#bash-completions.

/etc/profile.d/dircolors.sh

This script uses the ~/.dircolors and /etc/dircolors files to control the colors of file names in a directory listing. They control colorized output of things like ls --color. The explanation of how to initialize these files is at the end of this section.

cat > /etc/profile.d/dircolors.sh << "EOF"
# Setup for /bin/ls and /bin/grep to support color, the alias is in /etc/bashrc.
if [ -f "/etc/dircolors" ] ; then
        eval $(dircolors -b /etc/dircolors)
fi

if [ -f "$HOME/.dircolors" ] ; then
        eval $(dircolors -b $HOME/.dircolors)
fi

alias ls='ls --color=auto'
alias grep='grep --color=auto'
EOF

/etc/profile.d/extrapaths.sh

This script adds some useful paths to the PATH and can be used to customize other PATH related environment variables (e.g. LD_LIBRARY_PATH, etc) that may be needed for all users.

cat > /etc/profile.d/extrapaths.sh << "EOF"
if [ -d /usr/local/lib/pkgconfig ] ; then
        pathappend /usr/local/lib/pkgconfig PKG_CONFIG_PATH
fi
if [ -d /usr/local/bin ]; then
        pathprepend /usr/local/bin
fi
if [ -d /usr/local/sbin -a $EUID -eq 0 ]; then
        pathprepend /usr/local/sbin
fi

if [ -d /usr/local/share ]; then
        pathprepend /usr/local/share XDG_DATA_DIRS
fi

# Set some defaults before other applications add to these paths.
pathappend /usr/share/man  MANPATH
pathappend /usr/share/info INFOPATH
EOF

/etc/profile.d/readline.sh

This script sets up the default inputrc configuration file. If the user does not have individual settings, it uses the global file.

cat > /etc/profile.d/readline.sh << "EOF"
# Set up the INPUTRC environment variable.
if [ -z "$INPUTRC" -a ! -f "$HOME/.inputrc" ] ; then
        INPUTRC=/etc/inputrc
fi
export INPUTRC
EOF

/etc/profile.d/umask.sh

Setting the umask value is important for security. Here the default group write permissions are turned off for system users and when the user name and group name are not the same.

cat > /etc/profile.d/umask.sh << "EOF"
# By default, the umask should be set.
if [ "$(id -gn)" = "$(id -un)" -a $EUID -gt 99 ] ; then
  umask 002
else
  umask 022
fi
EOF

/etc/profile.d/i18n.sh

This script sets an environment variable necessary for native language support. A full discussion on determining this variable can be found on the LFS Bash Shell Startup Files page.

cat > /etc/profile.d/i18n.sh << "EOF"
# Set up i18n variables
. /etc/locale.conf
export LANG
EOF

Other Initialization Values

Other initialization can easily be added to the profile by adding additional scripts to the /etc/profile.d directory.

/etc/bashrc

Here is a base /etc/bashrc. Comments in the file should explain everything you need.

cat > /etc/bashrc << "EOF"
# Begin /etc/bashrc
# Written for Beyond Linux From Scratch
# by James Robertson <[email protected]>
# updated by Bruce Dubbs <[email protected]>

# System wide aliases and functions.

# System wide environment variables and startup programs should go into
# /etc/profile.  Personal environment variables and startup programs
# should go into ~/.bash_profile.  Personal aliases and functions should
# go into ~/.bashrc

# Provides colored /bin/ls and /bin/grep commands.  Used in conjunction
# with code in /etc/profile.

alias ls='ls --color=auto'
alias grep='grep --color=auto'

# Provides prompt for non-login shells, specifically shells started
# in the X environment. [Review the LFS archive thread titled
# PS1 Environment Variable for a great case study behind this script
# addendum.]

NORMAL="\[\e[0m\]"
RED="\[\e[1;31m\]"
GREEN="\[\e[1;32m\]"
if [[ $EUID == 0 ]] ; then
  PS1="$RED\u [ $NORMAL\w$RED ]# $NORMAL"
else
  PS1="$GREEN\u [ $NORMAL\w$GREEN ]\$ $NORMAL"
fi

unset RED GREEN NORMAL

# End /etc/bashrc
EOF

~/.bash_profile

Here is a base ~/.bash_profile. If you want each new user to have this file automatically, just change the output of the command to /etc/skel/.bash_profile and check the permissions after the command is run. You can then copy /etc/skel/.bash_profile to the home directories of already existing users, including root, and set the owner and group appropriately.

cat > ~/.bash_profile << "EOF"
# Begin ~/.bash_profile
# Written for Beyond Linux From Scratch
# by James Robertson <[email protected]>
# updated by Bruce Dubbs <[email protected]>

# Personal environment variables and startup programs.

# Personal aliases and functions should go in ~/.bashrc.  System wide
# environment variables and startup programs are in /etc/profile.
# System wide aliases and functions are in /etc/bashrc.

if [ -f "$HOME/.bashrc" ] ; then
  source $HOME/.bashrc
fi

if [ -d "$HOME/bin" ] ; then
  pathprepend $HOME/bin
fi

# Having . in the PATH is dangerous
#if [ $EUID -gt 99 ]; then
#  pathappend .
#fi

# End ~/.bash_profile
EOF

~/.profile

Here is a base ~/.profile. The comments and instructions for using /etc/skel for .bash_profile above also apply here. Only the target file names are different.

cat > ~/.profile << "EOF"
# Begin ~/.profile
# Personal environment variables and startup programs.

if [ -d "$HOME/bin" ] ; then
  pathprepend $HOME/bin
fi

# Set up user specific i18n variables
#export LANG=<ll>_<CC>.<charmap><@modifiers>

# End ~/.profile
EOF

~/.bashrc

Here is a base ~/.bashrc.

cat > ~/.bashrc << "EOF"
# Begin ~/.bashrc
# Written for Beyond Linux From Scratch
# by James Robertson <[email protected]>

# Personal aliases and functions.

# Personal environment variables and startup programs should go in
# ~/.bash_profile.  System wide environment variables and startup
# programs are in /etc/profile.  System wide aliases and functions are
# in /etc/bashrc.

if [ -f "/etc/bashrc" ] ; then
  source /etc/bashrc
fi

# Set up user specific i18n variables
#export LANG=<ll>_<CC>.<charmap><@modifiers>

# End ~/.bashrc
EOF

~/.bash_logout

This is an empty ~/.bash_logout that can be used as a template. You will notice that the base ~/.bash_logout does not include a clear command. This is because the clear is handled in the /etc/issue file.

cat > ~/.bash_logout << "EOF"
# Begin ~/.bash_logout
# Written for Beyond Linux From Scratch
# by James Robertson <[email protected]>

# Personal items to perform on logout.

# End ~/.bash_logout
EOF

/etc/dircolors

If you want to use the dircolors capability, then run the following command. The /etc/skel setup steps shown above also can be used here to provide a ~/.dircolors file when a new user is set up. As before, just change the output file name on the following command and assure the permissions, owner, and group are correct on the files created and/or copied.

dircolors -p > /etc/dircolors

If you wish to customize the colors used for different file types, you can edit the /etc/dircolors file. The instructions for setting the colors are embedded in the file.

Finally, Ian Macdonald has written an excellent collection of tips and tricks to enhance your shell environment. You can read it online at https://www.caliban.org/bash/index.shtml.

The /etc/vimrc and ~/.vimrc Files

The LFS book installs Vim as its text editor. At this point it should be noted that there are a lot of different editing applications out there including Emacs, nano, Joe and many more. Anyone who has been around the Internet (especially usenet) for a short time will certainly have observed at least one flame war, usually involving Vim and Emacs users!

The LFS book creates a basic vimrc file. In this section you'll find an attempt to enhance this file. At startup, vim reads the global configuration file (/etc/vimrc) as well as a user-specific file (~/.vimrc). Either or both can be tailored to suit the needs of your particular system.

Here is a slightly expanded .vimrc that you can put in ~/.vimrc to provide user specific effects. Of course, if you put it into /etc/skel/.vimrc instead, it will be made available to users you add to the system later. You can also copy the file from /etc/skel/.vimrc to the home directory of users already on the system, such as root. Be sure to set permissions, owner, and group if you do copy anything directly from /etc/skel.

" Begin .vimrc

set columns=80
set wrapmargin=8
set ruler

" End .vimrc

Note that the comment tags are " instead of the more usual # or //. This is correct, the syntax for vimrc is slightly unusual.

Below you'll find a quick explanation of what each of the options in this example file means here:

  • set columns=80: This simply sets the number of columns used on the screen.

  • set wrapmargin=8: This is the number of characters from the right window border where wrapping starts.

  • set ruler: This makes vim show the current row and column at the bottom right of the screen.

More information on the many vim options can be found by reading the help inside vim itself. Do this by typing :help in vim to get the general help, or by typing :help usr_toc.txt to view the User Manual Table of Contents.

Customizing your Logon with /etc/issue

When you first boot up your new LFS system, the logon screen will be nice and plain (as it should be in a bare-bones system). Many people however, will want their system to display some information in the logon message. This can be accomplished using the file /etc/issue.

The /etc/issue file is a plain text file which will also accept certain escape sequences (see below) in order to insert information about the system. There is also the file issue.net which can be used when logging on remotely. ssh however, will only use it if you set the option in the configuration file and will not interpret the escape sequences shown below.

One of the most common things which people want to do is clear the screen at each logon. The easiest way of doing that is to put a "clear" escape sequence into /etc/issue. A simple way of doing this is to issue the command clear > /etc/issue. This will insert the relevant escape code into the start of the /etc/issue file. Note that if you do this, when you edit the file, you should leave the characters (normally '^[[H^[[2J') on the first line alone.

Note

Terminal escape sequences are special codes recognized by the terminal. The ^[ represents an ASCII ESC character. The sequence ESC [ H puts the cursor in the upper left hand corner of the screen and ESC 2 J erases the screen. For more information on terminal escape sequences see http://rtfm.etla.org/xterm/ctlseq.html

The following sequences are recognized by agetty (the program which usually parses /etc/issue). This information is from man agetty where you can find extra information about the logon process.

The issue file can contain certain character sequences to display various information. All issue sequences consist of a backslash (\) immediately followed by one of the letters explained below (so \d in /etc/issue would insert the current date).

b   Insert the baudrate of the current line.
d   Insert the current date.
s   Insert the system name, the name of the operating system.
l   Insert the name of the current tty line.
m   Insert the architecture identifier of the machine, e.g., i686.
n   Insert the nodename of the machine, also known as the hostname.
o   Insert the domainname of the machine.
r   Insert the release number of the kernel, e.g., 2.6.11.12.
t   Insert the current time.
u   Insert the number of current users logged in.
U   Insert the string "1 user" or "<n> users" where <n> is the
    number of current users logged in.
v   Insert the version of the OS, e.g., the build-date etc.

Chapter 4. Security

Security takes many forms in a computing environment. After some initial discussion, this chapter gives examples of three different types of security: access, prevention and detection.

Access for users is usually handled by login or an application designed to handle the login function. In this chapter, we show how to enhance login by setting policies with PAM modules. Access via networks can also be secured by policies set by iptables, commonly referred to as a firewall. The Network Security Services (NSS) and Netscape Portable Runtime (NSPR) libraries can be installed and shared among the many applications requiring them. For applications that don't offer the best security, you can use the Stunnel package to wrap an application daemon inside an SSL tunnel.

Prevention of breaches, like a trojan, are assisted by applications like GnuPG, specifically the ability to confirm signed packages, which recognizes modifications of the tarball after the packager creates it.

Finally, we touch on detection with a package that stores "signatures" of critical files (defined by the administrator) and then regenerates those "signatures" and compares for files that have been changed.

Vulnerabilities

About vulnerabilities

All software has bugs. Sometimes, a bug can be exploited, for example to allow users to gain enhanced privileges (perhaps gaining a root shell, or simply accessing or deleting other user's files), or to allow a remote site to crash an application (denial of service), or for theft of data. These bugs are labelled as vulnerabilities.

The main place where vulnerabilities get logged is cve.mitre.org. Unfortunately, many vulnerability numbers (CVE-yyyy-nnnn) are initially only labelled as "reserved" when distributions start issuing fixes. Also, some vulnerabilities apply to particular combinations of configure options, or only apply to old versions of packages which have long since been updated in BLFS.

BLFS differs from distributions—there is no BLFS security team, and the editors only become aware of vulnerabilities after they are public knowledge. Sometimes, a package with a vulnerability will not be updated in the book for a long time. Issues can be logged in the Trac system, which might speed up resolution.

The normal way for BLFS to fix a vulnerability is, ideally, to update the book to a new fixed release of the package. Sometimes that happens even before the vulnerability is public knowledge, so there is no guarantee that it will be shown as a vulnerability fix in the Changelog. Alternatively, a sed command, or a patch taken from a distribution, may be appropriate.

The bottom line is that you are responsible for your own security, and for assessing the potential impact of any problems.

The editors now issue Security Advisories for packages in BLFS (and LFS), which can be found at BLFS Security Advisories, and grade the severity according to what upstream reports, or to what is shown at nvd.nist.gov if that has details.

To keep track of what is being discovered, you may wish to follow the security announcements of one or more distributions. For example, Debian has Debian security. Fedora's links on security are at the Fedora wiki. Details of Gentoo linux security announcements are discussed at Gentoo security. Finally, the Slackware archives of security announcements are at Slackware security.

The most general English source is perhaps the Full Disclosure Mailing List, but please read the comment on that page. If you use other languages you may prefer other sites such as heise.de (German) or cert.hr (Croatian). These are not linux-specific. There is also a daily update at lwn.net for subscribers (free access to the data after 2 weeks, but their vulnerabilities database at lwn.net/Alerts is unrestricted).

For some packages, subscribing to their 'announce' lists will provide prompt news of newer versions.

make-ca-1.12

Introduction to make-ca

Public Key Infrastructure (PKI) is a method to validate the authenticity of an otherwise unknown entity across untrusted networks. PKI works by establishing a chain of trust, rather than trusting each individual host or entity explicitly. In order for a certificate presented by a remote entity to be trusted, that certificate must present a complete chain of certificates that can be validated using the root certificate of a Certificate Authority (CA) that is trusted by the local machine.

Establishing trust with a CA involves validating things like company address, ownership, contact information, etc., and ensuring that the CA has followed best practices, such as undergoing periodic security audits by independent investigators and maintaining an always available certificate revocation list. This is well outside the scope of BLFS (as it is for most Linux distributions). The certificate store provided here is taken from the Mozilla Foundation, who have established very strict inclusion policies described here.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

make-ca Dependencies

Required

p11-kit-0.25.0 (runtime, built after libtasn1-4.19.0, required in the following instructions to generate certificate stores from trust anchors, and each time make-ca is run)

Optional (runtime)

nss-3.92 (to generate a shared NSSDB)

Installation of make-ca and Generation of the CA-certificates stores

The make-ca script will download and process the certificates included in the certdata.txt file for use as trust anchors for the p11-kit-0.25.0 trust module. Additionally, it will generate system certificate stores used by BLFS applications (if the recommended and optional applications are present on the system). Any local certificates stored in /etc/ssl/local will be imported to both the trust anchors and the generated certificate stores (overriding Mozilla's trust). Additionally, any modified trust values will be copied from the trust anchors to /etc/ssl/local prior to any updates, preserving custom trust values that differ from Mozilla when using the trust utility from p11-kit to operate on the trust store.

To install the various certificate stores, first install the make-ca script into the correct location. As the root user:

make install &&
install -vdm755 /etc/ssl/local

Note

Technically, this package is already installed at this point. But most packages listing make-ca as a dependency actually requires the system certificate store set up by this package, instead of requiring the make-ca program itself. So the instructions for using make-ca for setting up the system certificate store is included in this section. You should make sure the required runtime dependency for make-ca is satisfied now, and continue to follow the instructions.

As the root user, download the certificate source and prepare for system use with the following command:

Note

If running the script a second time with the same version of certdata.txt, for instance, to update the stores when make-ca is upgraded, or to add additional stores as the requisite software is installed, replace the -g switch with the -r switch in the command line. If packaging, run make-ca --help to see all available command line options.

/usr/sbin/make-ca -g

You should periodically update the store with the above command, either manually, or via a systemd timer. A timer is installed at /usr/lib/systemd/system/update-pki.timer that, if enabled, will check for updates weekly. Execute the following commands, as the root user, to enable the systemd timer:

systemctl enable update-pki.timer

Configuring make-ca

For most users, no additional configuration is necessary, however, the default certdata.txt file provided by make-ca is obtained from the mozilla-release branch, and is modified to provide a Mercurial revision. This will be the correct version for most systems. There are several other variants of the file available for use that might be preferred for one reason or another, including the files shipped with Mozilla products in this book. RedHat and OpenSUSE, for instance, use the version included in nss-3.92. Additional upstream downloads are available at the links included in /etc/make-ca/make-ca.conf.dist. Simply copy the file to /etc/make-ca.conf and edit as appropriate.

About Trust Arguments

There are three trust types that are recognized by the make-ca script, SSL/TLS, S/Mime, and code signing. For OpenSSL, these are serverAuth, emailProtection, and codeSigning respectively. If one of the three trust arguments is omitted, the certificate is neither trusted, nor rejected for that role. Clients that use OpenSSL or NSS encountering this certificate will present a warning to the user. Clients using GnuTLS without p11-kit support are not aware of trusted certificates. To include this CA into the ca-bundle.crt, email-ca-bundle.crt, or objsign-ca-bundle.crt files (the GnuTLS legacy bundles), it must have the appropriate trust arguments.

Adding Additional CA Certificates

The /etc/ssl/local directory is available to add additional CA certificates to the system trust store. This directory is also used to store certificates that were added to or modified in the system trust store by p11-kit-0.25.0 so that trust values are maintained across upgrades. Files in this directory must be in the OpenSSL trusted certificate format. Certificates imported using the trust utility from p11-kit-0.25.0 will utilize the x509 Extended Key Usage values to assign default trust values for the system anchors.

If you need to override trust values, or otherwise need to create an OpenSSL trusted certificate manually from a regular PEM encoded file, you need to add trust arguments to the openssl command, and create a new certificate. For example, using the CAcert roots, if you want to trust both for all three roles, the following commands will create appropriate OpenSSL trusted certificates (run as the root user after Wget-1.21.4 is installed):

wget http://www.cacert.org/certs/root.crt &&
wget http://www.cacert.org/certs/class3.crt &&
openssl x509 -in root.crt -text -fingerprint -setalias "CAcert Class 1 root" \
        -addtrust serverAuth -addtrust emailProtection -addtrust codeSigning \
        > /etc/ssl/local/CAcert_Class_1_root.pem &&
openssl x509 -in class3.crt -text -fingerprint -setalias "CAcert Class 3 root" \
        -addtrust serverAuth -addtrust emailProtection -addtrust codeSigning \
        > /etc/ssl/local/CAcert_Class_3_root.pem &&
/usr/sbin/make-ca -r

Overriding Mozilla Trust

Occasionally, there may be instances where you don't agree with Mozilla's inclusion of a particular certificate authority. If you'd like to override the default trust of a particular CA, simply create a copy of the existing certificate in /etc/ssl/local with different trust arguments. For example, if you'd like to distrust the "Makebelieve_CA_Root" file, run the following commands:

openssl x509 -in /etc/ssl/certs/Makebelieve_CA_Root.pem \
             -text \
             -fingerprint \
             -setalias "Disabled Makebelieve CA Root" \
             -addreject serverAuth \
             -addreject emailProtection \
             -addreject codeSigning \
       > /etc/ssl/local/Disabled_Makebelieve_CA_Root.pem &&
/usr/sbin/make-ca -r

Using make-ca with Python3

When Python3 was installed in LFS it included the pip3 module with vendored certificates from the Certifi module. That was necessary, but it means that whenever pip3 is used it can reference those certificates, primarily when creating a virtual environment or when installing a module with all its wheel dependencies in one go.

It is generally considered that the System Administrator should be in charge of which certificates are available. Now that make-ca-1.12 and p11-kit-0.25.0 have been installed and make-ca has been configured, it is possible to make pip3 use the system certificates.

The vendored certificates installed in LFS are a snapshot from when the pulled-in version of Certifi was created. If you regularly update the system certificates, the vendored version will become out of date.

To use the system certificates in Python3 you should set _PIP_STANDALONE_CERT to point to them, e.g for the bash shell:

export _PIP_STANDALONE_CERT=/etc/pki/tls/certs/ca-bundle.crt

Warning

If you have created virtual environments, for example when testing modules, and those include the Requests and Certifi modules in ~/.local/lib/python3.11/ then those local modules will be used instead of the system certificates unless you remove the local modules.

To use the system certificates in Python3 with the BLFS profiles add the following variable to your system or personal profiles:

mkdir -pv /etc/profile.d &&
cat > /etc/profile.d/pythoncerts.sh << "EOF"
# Begin /etc/profile.d/pythoncerts.sh

export _PIP_STANDALONE_CERT=/etc/pki/tls/certs/ca-bundle.crt

# End /etc/profile.d/pythoncerts.sh
EOF

Contents

Installed Programs: make-ca
Installed Directories: /etc/ssl/{certs,local} and /etc/pki/{nssdb,anchors,tls/{certs,java}}

Short Descriptions

make-ca

is a shell script that adapts a current version of certdata.txt, and prepares it for use as the system trust store

CrackLib-2.9.11

Introduction to CrackLib

The CrackLib package contains a library used to enforce strong passwords by comparing user selected passwords to words in chosen word lists.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Recommended word list for English-speaking countries:

There are additional word lists available for download, e.g., from https://wiki.skullsecurity.org/index.php/Passwords. CrackLib can utilize as many, or as few word lists you choose to install.

Important

Users tend to base their passwords on regular words of the spoken language, and crackers know that. CrackLib is intended to filter out such bad passwords at the source using a dictionary created from word lists. To accomplish this, the word list(s) for use with CrackLib must be an exhaustive list of words and word-based keystroke combinations likely to be chosen by users of the system as (guessable) passwords.

The default word list recommended above for downloading mostly satisfies this role in English-speaking countries. In other situations, it may be necessary to download (or even create) additional word lists.

Note that word lists suitable for spell-checking are not usable as CrackLib word lists in countries with non-Latin based alphabets, because of word-based keystroke combinations that make bad passwords.

Installation of CrackLib

Install CrackLib by running the following commands:

autoreconf -fiv &&

PYTHON=python3               \
./configure --prefix=/usr    \
            --disable-static \
            --with-default-dict=/usr/lib/cracklib/pw_dict &&
make

Now, as the root user:

make install

Issue the following commands as the root user to install the recommended word list and create the CrackLib dictionary. Other word lists (text based, one word per line) can also be used by simply installing them into /usr/share/dict and adding them to the create-cracklib-dict command.

install -v -m644 -D    ../cracklib-words-2.9.11.xz \
                         /usr/share/dict/cracklib-words.xz    &&

unxz -v                  /usr/share/dict/cracklib-words.xz    &&
ln -v -sf cracklib-words /usr/share/dict/words                &&
echo $(hostname) >>      /usr/share/dict/cracklib-extra-words &&
install -v -m755 -d      /usr/lib/cracklib                    &&

create-cracklib-dict     /usr/share/dict/cracklib-words \
                         /usr/share/dict/cracklib-extra-words

If desired, check the proper operation of the library as an unprivileged user by issuing the following command:

make test

Important

If you are installing CrackLib after your LFS system has been completed and you have the Shadow package installed, you must reinstall Shadow-4.13 if you wish to provide strong password support on your system. If you are now going to install the Linux-PAM-1.5.3 package, you may disregard this note as Shadow will be reinstalled after the Linux-PAM installation.

Command Explanations

autoreconf -fiv: The configure script shipped with the package is too old to get the right version string of Python 3.10 or later. This command regenerates it with a more recent version of autotools, which fixes the issue.

PYTHON=python3: This forces the installation of python bindings for Python 3, even if Python 2 is installed.

--with-default-dict=/lib/cracklib/pw_dict: This parameter forces the installation of the CrackLib dictionary to the /lib hierarchy.

--disable-static: This switch prevents installation of static versions of the libraries.

install -v -m644 -D ...: This command creates the /usr/share/dict directory (if it doesn't already exist) and installs the compressed word list there.

ln -v -s cracklib-words /usr/share/dict/words: The word list is linked to /usr/share/dict/words as historically, words is the primary word list in the /usr/share/dict directory. Omit this command if you already have a /usr/share/dict/words file installed on your system.

echo $(hostname) >>...: The value of hostname is echoed to a file called cracklib-extra-words. This extra file is intended to be a site specific list which includes easy to guess passwords such as company or department names, user names, product names, computer names, domain names, etc.

create-cracklib-dict ...: This command creates the CrackLib dictionary from the word lists. Modify the command to add any additional word lists you have installed.

Contents

Installed Programs: cracklib-check, cracklib-format, cracklib-packer, cracklib-unpacker, cracklib-update, and create-cracklib-dict
Installed Libraries: libcrack.so and the _cracklib.so (Python module)
Installed Directories: /usr/lib/cracklib, /usr/share/dict and /usr/share/cracklib

Short Descriptions

cracklib-check

is used to determine if a password is strong

cracklib-format

is used to format text files (lowercases all words, removes control characters and sorts the lists)

cracklib-packer

creates a database with words read from standard input

cracklib-unpacker

displays on standard output the database specified

create-cracklib-dict

is used to create the CrackLib dictionary from the given word list(s)

libcrack.so

provides a fast dictionary lookup method for strong password enforcement

cryptsetup-2.4.3

Introduction to cryptsetup

cryptsetup is used to set up transparent encryption of block devices using the kernel crypto API.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

cryptsetup Dependencies

Required

JSON-C-0.17, LVM2-2.03.22, and popt-1.19

Optional

libpwquality-1.4.5, argon2, libssh, and passwdqc

Kernel Configuration

Encrypted block devices require kernel support. To use it, the appropriate kernel configuration parameters need to be set:

Device Drivers --->
  [*] Multiple devices driver support (RAID and LVM) --->                   [MD]
    <*/M> Device mapper support                                     [BLK_DEV_DM]
    <*/M>   Crypt target support                                      [DM_CRYPT]

-*- Cryptographic API --->                                              [CRYPTO]
  Block ciphers --->
    <*/M> AES (Advanced Encryption Standard)                        [CRYPTO_AES]
    # For tests:
    <*/M> Twofish                                               [CRYPTO_TWOFISH]
  Length-preserving ciphers and modes --->
    <*/M> XTS (XOR Encrypt XOR with ciphertext stealing)            [CRYPTO_XTS]
  Hashes, digests, and MACs --->
    <*/M> SHA-224 and SHA-256                                    [CRYPTO_SHA256]
  Userspace interface --->
    <*/M> Symmetric key cipher algorithms             [CRYPTO_USER_API_SKCIPHER]

Installation of cryptsetup

Install cryptsetup by running the following commands:

./configure --prefix=/usr --disable-ssh-token &&
make

To test the result, issue as the root user: make check. Some tests will fail if appropriate kernel configuration options are not set. Some additional options that may be needed for tests are: CONFIG_SCSI_LOWLEVEL, CONFIG_SCSI_DEBUG, CONFIG_BLK_DEV_DM_BUILTIN, CONFIG_CRYPTO_USER, CONFIG_CRYPTO_CRYPTD, CONFIG_CRYPTO_LRW, CONFIG_CRYPTO_XTS, CONFIG_CRYPTO_ESSIV, CONFIG_CRYPTO_CRCT10DIF, CONFIG_CRYPTO_AES_TI, CONFIG_CRYPTO_AES_NI_INTEL, CONFIG_CRYPTO_BLOWFISH, CONFIG_CRYPTO_CAST5, CONFIG_CRYPTO_SERPENT, CONFIG_CRYPTO_SERPENT_SSE2_X86_64, CONFIG_CRYPTO_SERPENT_AVX_X86_64, CONFIG_CRYPTO_SERPENT_AVX2_X86_64, and CONFIG_CRYPTO_TWOFISH_X86_64.

Now, as the root user:

make install

Command Explanations

--disable-ssh-token: This option is required if the optional libssh dependency is not installed.

Configuring cryptsetup

Because of the number of possible configurations, setup of encrypted volumes is beyond the scope of the BLFS book. Please see the configuration guide in the cryptsetup FAQ.

Contents

Installed Programs: cryptsetup, cryptsetup-reencrypt, integritysetup, and veritysetup
Installed Libraries: libcryptsetup.so
Installed Directories: None

Short Descriptions

cryptsetup

is used to setup dm-crypt managed device-mapper mappings

cryptsetup-reencrypt

is a tool for offline LUKS device re-encryption

integritysetup

is a tool to manage dm-integrity (block level integrity) volumes

veritysetup

is used to configure dm-verity managed device-mapper mappings. Device-mapper verity target provides read-only transparent integrity checking of block devices using kernel crypto API

Cyrus SASL-2.1.28

Introduction to Cyrus SASL

The Cyrus SASL package contains a Simple Authentication and Security Layer implementation, a method for adding authentication support to connection-based protocols. To use SASL, a protocol includes a command for identifying and authenticating a user to a server and for optionally negotiating protection of subsequent protocol interactions. If its use is negotiated, a security layer is inserted between the protocol and the connection.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Cyrus SASL Dependencies

Recommended
Optional

Linux-PAM-1.5.3, MIT Kerberos V5-1.21.2, MariaDB-10.11.4 or MySQL, OpenLDAP-2.6.6, PostgreSQL-15.4, sphinx-7.1.2, SQLite-3.42.0, krb4, Dmalloc, and Pod::POM::View::Restructured

Installation of Cyrus SASL

Note

This package does not support parallel build.

Install Cyrus SASL by running the following commands:

./configure --prefix=/usr        \
            --sysconfdir=/etc    \
            --enable-auth-sasldb \
            --with-dbpath=/var/lib/sasl/sasldb2 \
            --with-sphinx-build=no              \
            --with-saslauthd=/var/run/saslauthd &&
make -j1

This package does not come with a test suite. If you are planning on using the GSSAPI authentication mechanism, test it after installing the package using the sample server and client programs which were built in the preceding step. Instructions for performing the tests can be found at https://www.linuxfromscratch.org/hints/downloads/files/cyrus-sasl.txt.

Now, as the root user:

make install &&
install -v -dm755                          /usr/share/doc/cyrus-sasl-2.1.28/html &&
install -v -m644  saslauthd/LDAP_SASLAUTHD /usr/share/doc/cyrus-sasl-2.1.28      &&
install -v -m644  doc/legacy/*.html        /usr/share/doc/cyrus-sasl-2.1.28/html &&
install -v -dm700 /var/lib/sasl

Command Explanations

--with-dbpath=/var/lib/sasl/sasldb2: This switch forces the sasldb database to be created in /var/lib/sasl instead of /etc.

--with-saslauthd=/var/run/saslauthd: This switch forces saslauthd to use the FHS compliant directory /var/run/saslauthd for variable run-time data.

--enable-auth-sasldb: This switch enables SASLDB authentication backend.

--with-dblib=gdbm: This switch forces GDBM to be used instead of Berkeley DB.

--with-ldap: This switch enables the OpenLDAP support.

--enable-ldapdb: This switch enables the LDAPDB authentication backend.

--enable-login: This option enables unsupported LOGIN authentication.

--enable-ntlm: This option enables unsupported NTLM authentication.

install -v -m644 ...: These commands install documentation which is not installed by the make install command.

install -v -m700 -d /var/lib/sasl: This directory must exist when starting saslauthd or using the sasldb plugin. If you're not going to be running the daemon or using the plugins, you may omit the creation of this directory.

Configuring Cyrus SASL

Config Files

/etc/saslauthd.conf (for saslauthd LDAP configuration) and /etc/sasl2/Appname.conf (where "Appname" is the application defined name of the application)

Configuration Information

See https://www.cyrusimap.org/sasl/sasl/sysadmin.html for information on what to include in the application configuration files.

See file:///usr/share/doc/cyrus-sasl-2.1.28/LDAP_SASLAUTHD for configuring saslauthd with OpenLDAP.

See https://www.cyrusimap.org/sasl/sasl/gssapi.html#gssapi for configuring saslauthd with Kerberos.

Systemd Unit

If you need to run the saslauthd daemon at system startup, install the saslauthd.service unit included in the blfs-systemd-units-20230816 package using the following command:

make install-saslauthd

Note

You'll need to modify /etc/default/saslauthd and modify the MECHANISM parameter with your desired authentication mechanism. The default authentication mechanism is "shadow".

Contents

Installed Programs: pluginviewer, saslauthd, sasldblistusers2, saslpasswd2 and testsaslauthd
Installed Library: libsasl2.so
Installed Directories: /usr/include/sasl, /usr/lib/sasl2, /usr/share/doc/cyrus-sasl-2.1.28 and /var/lib/sasl

Short Descriptions

pluginviewer

is used to list loadable SASL plugins and their properties

saslauthd

is the SASL authentication server

sasldblistusers2

is used to list the users in the SASL password database sasldb2

saslpasswd2

is used to set and delete a user's SASL password and mechanism specific secrets in the SASL password database sasldb2

testsaslauthd

is a test utility for the SASL authentication server

libsasl2.so

is a general purpose authentication library for server and client applications

GnuPG-2.4.3

Introduction to GnuPG

The GnuPG package is GNU's tool for secure communication and data storage. It can be used to encrypt data and to create digital signatures. It includes an advanced key management facility and is compliant with the proposed OpenPGP Internet standard as described in RFC2440 and the S/MIME standard as described by several RFCs. GnuPG 2 is the stable version of GnuPG integrating support for OpenPGP and S/MIME.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

GnuPG 2 Dependencies

Required

libassuan-2.5.6, libgcrypt-1.10.2, libksba-1.6.4, npth-1.6, and OpenLDAP-2.6.6

Recommended
Optional

cURL-8.2.1, Fuse-3.16.1, ImageMagick-7.1.1-15 (for the convert utility, used for generating the documentation), libusb-1.0.26, an MTA, SQLite-3.42.0, texlive-20230313 (or install-tl-unx), fig2dev (for generating documentation), and GNU adns

Installation of GnuPG

First, fix a compatibility issue with emacs:

patch -Np1 -i ../gnupg-2.4.3-emacs-1.patch

Install GnuPG by running the following commands:

mkdir build &&
cd    build &&

../configure --prefix=/usr           \
             --localstatedir=/var    \
             --sysconfdir=/etc       \
             --docdir=/usr/share/doc/gnupg-2.4.3 &&
make &&

makeinfo --html --no-split -I doc -o doc/gnupg_nochunks.html ../doc/gnupg.texi &&
makeinfo --plaintext       -I doc -o doc/gnupg.txt           ../doc/gnupg.texi &&
make -C doc html

If you have texlive-20230313 installed and you wish to create documentation in alternate formats, issue the following commands (fig2dev is needed for the ps format):

make -C doc pdf ps

To test the results, issue: make check.

Now, as the root user:

make install &&

install -v -m755 -d /usr/share/doc/gnupg-2.4.3/html            &&
install -v -m644    doc/gnupg_nochunks.html \
                    /usr/share/doc/gnupg-2.4.3/html/gnupg.html &&
install -v -m644    ../doc/*.texi doc/gnupg.txt \
                    /usr/share/doc/gnupg-2.4.3 &&
install -v -m644    doc/gnupg.html/* \
                    /usr/share/doc/gnupg-2.4.3/html

If you created alternate formats of the documentation, install them using the following command as the root user:

install -v -m644 doc/gnupg.{pdf,dvi,ps} \
                 /usr/share/doc/gnupg-2.4.3

Command Explanations

mkdir build && cd build: the Gnupg2 developers recommend to build the package in a dedicated directory.

--docdir=/usr/share/doc/gnupg-2.4.3: This switch changes the default docdir to /usr/share/doc/gnupg-2.4.3.

--enable-all-tests: This switch allows more tests to be run with make check.

--enable-g13: This switch enables building the g13 program.

Contents

Installed Programs: addgnupghome, applygnupgdefaults, dirmngr, dirmngr-client, g13 (optional), gpg-agent, gpg-card, gpg-connect-agent, gpg, gpgconf, gpgparsemail, gpgscm, gpgsm, gpgsplit, gpgtar, gpgv, gpg-wks-client, gpg-wks-server, kbxutil, and watchgnupg
Installed Libraries: None
Installed Directories: /usr/share/doc/gnupg-2.4.3 and /usr/share/gnupg

Short Descriptions

addgnupghome

is used to create and populate a user's ~/.gnupg directories

applygnupgdefaults

is a wrapper script used to run gpgconf with the --apply-defaults parameter on all user's GnuPG home directories

dirmngr

is a tool that takes care of accessing the OpenPGP keyservers

dirmngr-client

is a tool to contact a running dirmngr and test whether a certificate has been revoked

g13

is a tool to create, mount or unmount an encrypted file system container (optional)

gpg-agent

is a daemon used to manage secret (private) keys independently from any protocol. It is used as a backend for gpg and gpgsm as well as for a couple of other utilities

gpg-card

is a tool to manage smart cards and tokens

gpg-connect-agent

is a utility used to communicate with a running gpg-agent

gpg

is the OpenPGP part of the GNU Privacy Guard (GnuPG). It is a tool used to provide digital encryption and signing services using the OpenPGP standard

gpgconf

is a utility used to automatically and reasonably safely query and modify configuration files in the ~/.gnupg home directory. It is designed not to be invoked manually by the user, but automatically by graphical user interfaces

gpgparsemail

is a utility currently only useful for debugging. Run it with --help for usage information

gpgscm

executes the given scheme program or spawns an interactive shell

gpgsm

is a tool similar to gpg used to provide digital encryption and signing services on X.509 certificates and the CMS protocol. It is mainly used as a backend for S/MIME mail processing

gpgsplit

splits an OpenPGP message into packets

gpgtar

is a tool to encrypt or sign files into an archive

gpgv

is a verify only version of gpg

gpg-wks-client

is a client for the Web Key Service protocol

gpg-wks-server

provides a server for the Web Key Service protocol

kbxutil

is used to list, export and import Keybox data

watchgnupg

is used to listen to a Unix Domain socket created by any of the GnuPG tools

GnuTLS-3.8.1

Introduction to GnuTLS

The GnuTLS package contains libraries and userspace tools which provide a secure layer over a reliable transport layer. Currently the GnuTLS library implements the proposed standards by the IETF's TLS working group. Quoting from the TLS 1.3 protocol specification :

TLS allows client/server applications to communicate over the Internet in a way that is designed to prevent eavesdropping, tampering, and message forgery.

GnuTLS provides support for TLS 1.3, TLS 1.2, TLS 1.1, TLS 1.0, and (optionally) SSL 3.0 protocols. It also supports TLS extensions, including server name and max record size. Additionally, the library supports authentication using the SRP protocol, X.509 certificates, and OpenPGP keys, along with support for the TLS Pre-Shared-Keys (PSK) extension, the Inner Application (TLS/IA) extension, and X.509 and OpenPGP certificate handling.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GnuTLS Dependencies

Required

Nettle-3.9.1

Recommended
Optional

Brotli-1.0.9, Doxygen-1.9.7, GTK-Doc-1.33.2, libidn-1.41 or libidn2-2.3.4, libseccomp-2.5.4, Net-tools-2.10 (used during the test suite), texlive-20230313 or install-tl-unx, Unbound-1.17.1 (to build the DANE library), Valgrind-3.21.0 (used during the test suite), autogen, cmocka and datefudge (used during the test suite if the DANE library is built), and Trousers (Trusted Platform Module support)

Note

Note that if you do not install libtasn1-4.19.0, a version shipped in the GnuTLS tarball will be used instead.

Installation of GnuTLS

Install GnuTLS by running the following commands:

./configure --prefix=/usr \
            --docdir=/usr/share/doc/gnutls-3.8.1 \
            --with-default-trust-store-pkcs11="pkcs11:" &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--with-default-trust-store-pkcs11="pkcs11:": This switch tells gnutls to use the PKCS #11 trust store as the default trust. Omit this switch if p11-kit-0.25.0 is not installed.

--with-default-trust-store-file=/etc/pki/tls/certs/ca-bundle.crt: This switch tells configure where to find the legacy CA certificate bundle and to use it instead of PKCS #11 module by default. Use this if p11-kit-0.25.0 is not installed.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

--enable-openssl-compatibility: Use this switch if you wish to build the OpenSSL compatibility library.

--without-p11-kit: use this switch if you have not installed p11-kit.

--with-included-unistring: uses the bundled version of libunistring, instead of the system one. Use this switch if you have not installed libunistring-1.1.

Contents

Installed Programs: certtool, danetool, gnutls-cli, gnutls-cli-debug, gnutls-serv, ocsptool, p11tool, psktool, and srptool
Installed Libraries: libgnutls.so, libgnutls-dane.so, libgnutlsxx.so, libgnutls-openssl.so (optional), and /usr/lib/guile/3.0/extensions/guile-gnutls-v-2.so
Installed Directories: /usr/include/gnutls, /usr/lib/guile/3.0/site-ccache/gnutls, /usr/share/guile/site/3.0/gnutls, and /usr/share/doc/gnutls-3.8.1

Short Descriptions

certtool

is used to generate X.509 certificates, certificate requests, and private keys

danetool

is a tool used to generate and check DNS resource records for the DANE protocol

gnutls-cli

is a simple client program to set up a TLS connection to some other computer

gnutls-cli-debug

is a simple client program to set up a TLS connection to some other computer and produces very verbose progress results

gnutls-serv

is a simple server program that listens to incoming TLS connections

ocsptool

is a program that can parse and print information about OCSP requests/responses, generate requests and verify responses

p11tool

is a program that allows handling data from PKCS #11 smart cards and security modules

psktool

is a simple program that generates random keys for use with TLS-PSK

srptool

is a simple program that emulates the programs in the Stanford SRP (Secure Remote Password) libraries using GnuTLS

libgnutls.so

contains the core API functions and X.509 certificate API functions

GPGME-1.21.0

Introduction to GPGME

The GPGME package is a C library that allows cryptography support to be added to a program. It is designed to make access to public key crypto engines like GnuPG or GpgSM easier for applications. GPGME provides a high-level crypto API for encryption, decryption, signing, signature verification and key management.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GPGME Dependencies

Required

libassuan-2.5.6

Optional

Doxygen-1.9.7 and Graphviz-8.1.0 (for API documentation), GnuPG-2.4.3 (required if Qt or SWIG are installed; used during the test suite), Clisp-2.49, (Qt-5.15.10 or qt-alternate-5.15.10), and/or SWIG-4.1.1 (for language bindings)

Installation of GPGME

Install GPGME by running the following commands:

./configure --prefix=/usr --disable-gpg-test &&
make

To test the results, you should have GnuPG-2.4.3 installed and remove the --disable-gpg-test above. Issue: make -k check. One test, TestRemarks, is known to fail.

Now, as the root user:

make install

Command Explanations

--disable-gpg-test: if this parameter is not passed to configure, the test programs are built during make stage, which requires GnuPG-2.4.3. This parameter is not needed if GnuPG-2.4.3 is installed.

Contents

Installed Program: gpgme-json, and gpgme-tool
Installed Libraries: libgpgme, libgpgmepp.so, and libqgpgme.so
Installed Directory: /usr/include/{gpgme++,qgpgme,QGpgME}, /usr/lib/cmake/{Gpgmepp,QGpgme}. /usr/lib/python2.7/site-packages/gpg, /usr/lib/python3.11/site-packages/gpg-1.21.0-py3.11-linux-<arch>.egg, and /usr/share/common-lisp/source/gpgme

Short Descriptions

gpgme-json

outputs GPGME commands in JSON format

gpgme-tool

is an assuan server exposing GPGME operations, such as printing fingerprints and keyids with keyservers

libgpgme.so

contains the GPGME API functions

libgpgmepp.so

contains the C++ GPGME API functions

libqgpgme.so

contains API functions for handling GPG operations in Qt applications

iptables-1.8.9

Introduction to iptables

iptables is a userspace command line program used to configure the Linux 2.4 and later kernel packet filtering ruleset.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

iptables Dependencies

Optional

libpcap-1.10.4 (required for BPF compiler or nfsynproxy support), bpf-utils (required for Berkeley Packet Filter support), libnfnetlink (required for connlabel support), libnetfilter_conntrack (required for connlabel support), and nftables

Kernel Configuration

A firewall in Linux is accomplished through the netfilter interface. To use iptables to configure netfilter, the following kernel configuration parameters are required:

[*] Networking support --->                                                [NET]
  Networking options --->
    [*] Network packet filtering framework (Netfilter) --->          [NETFILTER]
      [*] Advanced netfilter configuration                  [NETFILTER_ADVANCED]
      Core Netfilter Configuration --->
        <*/M> Netfilter connection tracking support               [NF_CONNTRACK]
        <*/M> Netfilter Xtables support (required for ip_tables)
                                                        ...  [NETFILTER_XTABLES]
        <*/M>   LOG target support                     [NETFILTER_XT_TARGET_LOG]
      IP: Netfilter Configuration --->
        <*/M> IP tables support (required for filtering/masq/NAT)
                                                           ...  [IP_NF_IPTABLES]

Include any connection tracking protocols that will be used, as well as any protocols that you wish to use for match support under the "Core Netfilter Configuration" section. The above options are enough for running Creating a Personal Firewall With iptables below.

Installation of iptables

Note

The installation below does not include building some specialized extension libraries which require the raw headers in the Linux source code. If you wish to build the additional extensions (if you aren't sure, then you probably don't), you can look at the INSTALL file to see an example of how to change the KERNEL_DIR= parameter to point at the Linux source code. Note that if you upgrade the kernel version, you may also need to recompile iptables and that the BLFS team has not tested using the raw kernel headers.

Install iptables by running the following commands:

./configure --prefix=/usr      \
            --disable-nftables \
            --enable-libipq    &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-nftables: This switch disables building nftables compatibility.

--enable-libipq: This switch enables building of libipq.so which can be used by some packages outside of BLFS.

--enable-nfsynproxy: This switch enables installation of nfsynproxy SYNPROXY configuration tool.

Configuring iptables

Note

In the following example configurations, LAN1 is used for the internal LAN interface, and WAN1 is used for the external interface connected to the Internet. You will need to replace these values with appropriate interface names for your system.

Personal Firewall

A Personal Firewall is designed to let you access all the services offered on the Internet while keeping your computer secure and your data private.

Below is a slightly modified version of Rusty Russell's recommendation from the Linux 2.4 Packet Filtering HOWTO. It is still applicable to the Linux 5.x kernels.

install -v -dm755 /etc/systemd/scripts

cat > /etc/systemd/scripts/iptables << "EOF"
#!/bin/sh

# Begin /etc/systemd/scripts/iptables

# Insert connection-tracking modules
# (not needed if built into the kernel)
modprobe nf_conntrack
modprobe xt_LOG

# Enable broadcast echo Protection
echo 1 > /proc/sys/net/ipv4/icmp_echo_ignore_broadcasts

# Disable Source Routed Packets
echo 0 > /proc/sys/net/ipv4/conf/all/accept_source_route
echo 0 > /proc/sys/net/ipv4/conf/default/accept_source_route

# Enable TCP SYN Cookie Protection
echo 1 > /proc/sys/net/ipv4/tcp_syncookies

# Disable ICMP Redirect Acceptance
echo 0 > /proc/sys/net/ipv4/conf/default/accept_redirects

# Do not send Redirect Messages
echo 0 > /proc/sys/net/ipv4/conf/all/send_redirects
echo 0 > /proc/sys/net/ipv4/conf/default/send_redirects

# Drop Spoofed Packets coming in on an interface, where responses
# would result in the reply going out a different interface.
echo 1 > /proc/sys/net/ipv4/conf/all/rp_filter
echo 1 > /proc/sys/net/ipv4/conf/default/rp_filter

# Log packets with impossible addresses.
echo 1 > /proc/sys/net/ipv4/conf/all/log_martians
echo 1 > /proc/sys/net/ipv4/conf/default/log_martians

# be verbose on dynamic ip-addresses  (not needed in case of static IP)
echo 2 > /proc/sys/net/ipv4/ip_dynaddr

# disable Explicit Congestion Notification
# too many routers are still ignorant
echo 0 > /proc/sys/net/ipv4/tcp_ecn

# Set a known state
iptables -P INPUT   DROP
iptables -P FORWARD DROP
iptables -P OUTPUT  DROP

# These lines are here in case rules are already in place and the
# script is ever rerun on the fly. We want to remove all rules and
# pre-existing user defined chains before we implement new rules.
iptables -F
iptables -X
iptables -Z

iptables -t nat -F

# Allow local-only connections
iptables -A INPUT  -i lo -j ACCEPT

# Free output on any interface to any ip for any service
# (equal to -P ACCEPT)
iptables -A OUTPUT -j ACCEPT

# Permit answers on already established connections
# and permit new connections related to established ones
# (e.g. port mode ftp)
iptables -A INPUT -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT

# Log everything else.
iptables -A INPUT -j LOG --log-prefix "FIREWALL:INPUT "

# End /etc/systemd/scripts/iptables
EOF
chmod 700 /etc/systemd/scripts/iptables

This script is quite simple, it drops all traffic coming into your computer that wasn't initiated from your computer, but as long as you are simply surfing the Internet you are unlikely to exceed its limits.

If you frequently encounter certain delays at accessing FTP servers, take a look at BusyBox with iptables example number 4.

Even if you have daemons or services running on your system, these will be inaccessible everywhere but from your computer itself. If you want to allow access to services on your machine, such as ssh or ping, take a look at Creating a BusyBox With iptables.

Masquerading Router

A Network Firewall has two interfaces, one connected to an intranet, in this example LAN1, and one connected to the Internet, here WAN1. To provide the maximum security for the firewall itself, make sure that there are no unnecessary servers running on it such as X11. As a general principle, the firewall itself should not access any untrusted service (think of a remote server giving answers that makes a daemon on your system crash, or even worse, that implements a worm via a buffer-overflow).

install -v -dm755 /etc/systemd/scripts

cat > /etc/systemd/scripts/iptables << "EOF"
#!/bin/sh

# Begin /etc/systemd/scripts/iptables

echo
echo "You're using the example configuration for a setup of a firewall"
echo "from Beyond Linux From Scratch."
echo "This example is far from being complete, it is only meant"
echo "to be a reference."
echo "Firewall security is a complex issue, that exceeds the scope"
echo "of the configuration rules below."

echo "You can find additional information"
echo "about firewalls in Chapter 4 of the BLFS book."
echo "https://www.linuxfromscratch.org/blfs"
echo

# Insert iptables modules (not needed if built into the kernel).

modprobe nf_conntrack
modprobe nf_conntrack_ftp
modprobe xt_conntrack
modprobe xt_LOG
modprobe xt_state

# Enable broadcast echo Protection
echo 1 > /proc/sys/net/ipv4/icmp_echo_ignore_broadcasts

# Disable Source Routed Packets
echo 0 > /proc/sys/net/ipv4/conf/all/accept_source_route

# Enable TCP SYN Cookie Protection
echo 1 > /proc/sys/net/ipv4/tcp_syncookies

# Disable ICMP Redirect Acceptance
echo 0 > /proc/sys/net/ipv4/conf/all/accept_redirects

# Don't send Redirect Messages
echo 0 > /proc/sys/net/ipv4/conf/default/send_redirects

# Drop Spoofed Packets coming in on an interface where responses
# would result in the reply going out a different interface.
echo 1 > /proc/sys/net/ipv4/conf/default/rp_filter

# Log packets with impossible addresses.
echo 1 > /proc/sys/net/ipv4/conf/all/log_martians

# Be verbose on dynamic ip-addresses  (not needed in case of static IP)
echo 2 > /proc/sys/net/ipv4/ip_dynaddr

# Disable Explicit Congestion Notification
# Too many routers are still ignorant
echo 0 > /proc/sys/net/ipv4/tcp_ecn

# Set a known state
iptables -P INPUT   DROP
iptables -P FORWARD DROP
iptables -P OUTPUT  DROP

# These lines are here in case rules are already in place and the
# script is ever rerun on the fly. We want to remove all rules and
# pre-existing user defined chains before we implement new rules.
iptables -F
iptables -X
iptables -Z

iptables -t nat -F

# Allow local connections
iptables -A INPUT  -i lo -j ACCEPT
iptables -A OUTPUT -o lo -j ACCEPT

# Allow forwarding if the initiated on the intranet
iptables -A FORWARD -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT
iptables -A FORWARD ! -i WAN1 -m conntrack --ctstate NEW       -j ACCEPT

# Do masquerading
# (not needed if intranet is not using private ip-addresses)
iptables -t nat -A POSTROUTING -o WAN1 -j MASQUERADE

# Log everything for debugging
# (last of all rules, but before policy rules)
iptables -A INPUT   -j LOG --log-prefix "FIREWALL:INPUT "
iptables -A FORWARD -j LOG --log-prefix "FIREWALL:FORWARD "
iptables -A OUTPUT  -j LOG --log-prefix "FIREWALL:OUTPUT "

# Enable IP Forwarding
echo 1 > /proc/sys/net/ipv4/ip_forward

# The following sections allow inbound packets for specific examples
# Uncomment the example lines and adjust as necessary

# Allow ping on the external interface
#iptables -A INPUT  -p icmp -m icmp --icmp-type echo-request -j ACCEPT
#iptables -A OUTPUT -p icmp -m icmp --icmp-type echo-reply   -j ACCEPT

# Reject ident packets with TCP reset to avoid delays with FTP or IRC
#iptables -A INPUT  -p tcp --dport 113 -j REJECT --reject-with tcp-reset

# Allow HTTP and HTTPS to 192.168.0.2
#iptables -A PREROUTING -t nat -i WAN1 -p tcp --dport 80 -j DNAT --to 192.168.0.2
#iptables -A PREROUTING -t nat -i WAN1 -p tcp --dport 443 -j DNAT --to 192.168.0.2
#iptables -A FORWARD -p tcp -d 192.168.0.2 --dport 80 -j ACCEPT
#iptables -A FORWARD -p tcp -d 192.168.0.2 --dport 443 -j ACCEPT

# End /etc/systemd/scripts/iptables
EOF
chmod 700 /etc/systemd/scripts/iptables

With this script your intranet should be reasonably secure against external attacks. No one should be able to setup a new connection to any internal service and, if it's masqueraded, makes your intranet invisible to the Internet. Furthermore, your firewall should be relatively safe because there are no services running that a cracker could attack.

BusyBox

This scenario isn't too different from the Creating a Masquerading Router With iptables, but additionally offers some services to your intranet. Examples of this can be when you want to administer your firewall from another host on your intranet or use it as a proxy or a name server.

Note

Outlining specifically how to protect a server that offers services on the Internet goes far beyond the scope of this document. See the references in the section called “Extra Information” for more information.

Be cautious. Every service you have enabled makes your setup more complex and your firewall less secure. You are exposed to the risks of misconfigured services or running a service with an exploitable bug. A firewall should generally not run any extra services. See the introduction to the Creating a Masquerading Router With iptables for some more details.

If you want to add services such as internal Samba or name servers that do not need to access the Internet themselves, the additional statements are quite simple and should still be acceptable from a security standpoint. Just add the following lines into the script before the logging rules.

iptables -A INPUT  -i ! WAN1  -j ACCEPT
iptables -A OUTPUT -o ! WAN1  -j ACCEPT

If daemons, such as squid, have to access the Internet themselves, you could open OUTPUT generally and restrict INPUT.

iptables -A INPUT -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT
iptables -A OUTPUT -j ACCEPT

However, it is generally not advisable to leave OUTPUT unrestricted. You lose any control over trojans who would like to "call home", and a bit of redundancy in case you've (mis-)configured a service so that it broadcasts its existence to the world.

To accomplish this, you should restrict INPUT and OUTPUT on all ports except those that it's absolutely necessary to have open. Which ports you have to open depends on your needs: mostly you will find them by looking for failed accesses in your log files.

Have a Look at the Following Examples:

  • Squid is caching the web:

    iptables -A OUTPUT -p tcp --dport 80 -j ACCEPT
    iptables -A INPUT  -p tcp --sport 80 -m conntrack --ctstate ESTABLISHED \
      -j ACCEPT
  • Your caching name server (e.g., named) does its lookups via UDP:

    iptables -A OUTPUT -p udp --dport 53 -j ACCEPT
  • You want to be able to ping your computer to ensure it's still alive:

    iptables -A INPUT  -p icmp -m icmp --icmp-type echo-request -j ACCEPT
    iptables -A OUTPUT -p icmp -m icmp --icmp-type echo-reply   -j ACCEPT
  • If you are frequently accessing FTP servers or enjoy chatting, you might notice delays because some implementations of these daemons query an identd daemon on your system to obtain usernames. Although there's really little harm in this, having an identd running is not recommended because many security experts feel the service gives out too much additional information.

    To avoid these delays you could reject the requests with a 'tcp-reset' response:

    iptables -A INPUT  -p tcp --dport 113 -j REJECT --reject-with tcp-reset
  • To log and drop invalid packets (packets that came in after netfilter's timeout or some types of network scans) insert these rules at the top of the chain:

    iptables -I INPUT 0 -p tcp -m conntrack --ctstate INVALID \
      -j LOG --log-prefix "FIREWALL:INVALID "
    iptables -I INPUT 1 -p tcp -m conntrack --ctstate INVALID -j DROP
  • Anything coming from the outside should not have a private address, this is a common attack called IP-spoofing:

    iptables -A INPUT -i WAN1 -s 10.0.0.0/8     -j DROP
    iptables -A INPUT -i WAN1 -s 172.16.0.0/12  -j DROP
    iptables -A INPUT -i WAN1 -s 192.168.0.0/16 -j DROP

    There are other addresses that you may also want to drop: 0.0.0.0/8, 127.0.0.0/8, 224.0.0.0/3 (multicast and experimental), 169.254.0.0/16 (Link Local Networks), and 192.0.2.0/24 (IANA defined test network).

  • If your firewall is a DHCP client, you need to allow those packets:

    iptables -A INPUT  -i WAN1 -p udp -s 0.0.0.0 --sport 67 \
       -d 255.255.255.255 --dport 68 -j ACCEPT
  • To simplify debugging and be fair to anyone who'd like to access a service you have disabled, purposely or by mistake, you could REJECT those packets that are dropped.

    Obviously this must be done directly after logging as the very last lines before the packets are dropped by policy:

    iptables -A INPUT -j REJECT

These are only examples to show you some of the capabilities of the firewall code in Linux. Have a look at the man page of iptables. There you will find much more information. The port numbers needed for this can be found in /etc/services, in case you didn't find them by trial and error in your log file.

Systemd Unit

To set up the iptables firewall at boot, install the iptables.service unit included in the blfs-systemd-units-20230816 package.

make install-iptables

Contents

Installed Programs: ip6tables, ip6tables-apply, ip6tables-legacy, ip6tables-legacy-restore, ip6tables-legacy-save, ip6tables-restore, ip6tables-save, iptables, iptables-apply, iptables-legacy, iptables-legacy-restore, iptables-legacy-apply, iptables-restore, iptables-save, iptables-xml, nfsynproxy (optional), and xtables-multi
Installed Libraries: libip4tc.so, libip6tc.so, libipq.so, libiptc.so, and libxtables.so
Installed Directories: /lib/xtables and /usr/include/libiptc

Short Descriptions

iptables

is used to set up, maintain, and inspect the tables of IP packet filter rules in the Linux kernel

iptables-apply

is a safer way to update iptables remotely

iptables-legacy

is used to interact with iptables using the legacy command set

iptables-legacy-restore

is used to restore a set of legacy iptables rules

iptables-legacy-save

is used to save a set of legacy iptables rules

iptables-restore

is used to restore IP Tables from data specified on STDIN. Use I/O redirection provided by your shell to read from a file

iptables-save

is used to dump the contents of an IP Table in easily parseable format to STDOUT. Use I/O-redirection provided by your shell to write to a file

iptables-xml

is used to convert the output of iptables-save to an XML format. Using the iptables.xslt stylesheet converts the XML back to the format of iptables-restore

ip6tables*

are a set of commands for IPV6 that parallel the iptables commands above

nfsynproxy

(optional) configuration tool. SYNPROXY target makes handling of large SYN floods possible without the large performance penalties imposed by the connection tracking in such cases

xtables-multi

is a binary that behaves according to the name it is called by

Setting Up a Network Firewall

Introduction to Firewall Creation

The purpose of a firewall is to protect a computer or a network against malicious access. In a perfect world every daemon or service, on every machine, is perfectly configured and immune to security flaws, and all users are trusted implicitly to use the equipment as intended. However, this is rarely, if ever, the case. Daemons may be misconfigured, or updates may not have been applied for known exploits against essential services. Additionally, you may wish to choose which services are accessible by certain machines or users, or you may wish to limit which machines or applications are allowed external access. Alternatively, you simply may not trust some of your applications or users. For these reasons, a carefully designed firewall should be an essential part of system security.

While a firewall can greatly limit the scope of the above issues, do not assume that having a firewall makes careful configuration redundant, or that any negligent misconfiguration is harmless. A firewall does not prevent the exploitation of any service you offer outside of it. Despite having a firewall, you need to keep applications and daemons properly configured and up to date.

Meaning of the Word "Firewall"

The word firewall can have several different meanings.

Personal Firewall

This is a hardware device or software program, intended to secure a home or desktop computer connected to the Internet. This type of firewall is highly relevant for users who do not know how their computers might be accessed via the Internet or how to disable that access, especially if they are always online and connected via broadband links.

An example configuration for a personal firewall is provided at Creating a Personal Firewall With iptables.

Masquerading Router

This is a system placed between the Internet and an intranet. To minimize the risk of compromising the firewall itself, it should generally have only one role—that of protecting the intranet. Although not completely risk-free, the tasks of doing the routing and IP masquerading (rewriting IP headers of the packets it routes from clients with private IP addresses onto the Internet so that they seem to come from the firewall itself) are commonly considered relatively secure.

An example configuration for a masquerading firewall is provided at Creating a Masquerading Router With iptables.

BusyBox

This is often an old computer you may have retired and nearly forgotten, performing masquerading or routing functions, but offering non-firewall services such as a web-cache or mail. This may be used for home networks, but is not to be considered as secure as a firewall only machine because the combination of server and router/firewall on one machine raises the complexity of the setup.

An example configuration for a BusyBox is provided at Creating a BusyBox With iptables.

Firewall with a Demilitarized Zone

This type of firewall performs masquerading or routing, but grants public access to some branch of your network that is physically separated from your regular intranet and is essentially a separate network with direct Internet access. The servers on this network are those which must be easily accessible from both the Internet and intranet. The firewall protects both networks. This type of firewall has a minimum of three network interfaces.

Packetfilter

This type of firewall does routing or masquerading but does not maintain a state table of ongoing communication streams. It is fast but quite limited in its ability to block undesired packets without blocking desired packets.

Conclusion

Caution

The example configurations provided for iptables-1.8.9 are not intended to be a complete guide to securing systems. Firewalling is a complex issue that requires careful configuration. The configurations provided by BLFS are intended only to give examples of how a firewall works. They are not intended to fit any particular configuration and may not provide complete protection from an attack.

BLFS provides an utility to manage the kernel Netfilter interface, iptables-1.8.9. It has been around since early 2.4 kernels, and has been the standard since. This is likely the set of tools that will be most familiar to existing admins. Other tools have been developed more recently, see the list of further readings below for more details. Here you will find a list of URLs that contain comprehensive information about building firewalls and further securing your system.

libcap-2.69 with PAM

Introduction to libcap with PAM

The libcap package was installed in LFS, but if Linux-PAM support is desired, the PAM module must be built (after installation of Linux-PAM).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libcap Dependencies

Required

Linux-PAM-1.5.3

Installation of libcap

Note

If you are upgrading libcap from a previous version, use the instructions in LFS libcap page to upgrade libcap. If Linux-PAM-1.5.3 has been built, the PAM module will automatically be built too.

Install libcap by running the following commands:

make -C pam_cap

This package does not come with a test suite.

Now, as the root user:

install -v -m755 pam_cap/pam_cap.so /usr/lib/security &&
install -v -m644 pam_cap/capability.conf /etc/security

Configuring Libcap

In order to allow Linux-PAM to grant privileges based on POSIX capabilities, you need to add the libcap module to the beginning of the /etc/pam.d/system-auth file. Make the required edits with the following commands:

mv -v /etc/pam.d/system-auth{,.bak} &&
cat > /etc/pam.d/system-auth << "EOF" &&
# Begin /etc/pam.d/system-auth

auth      optional    pam_cap.so
EOF
tail -n +3 /etc/pam.d/system-auth.bak >> /etc/pam.d/system-auth

Additionally, you'll need to modify the /etc/security/capability.conf file to grant necessary privileges to users, and utilize the setcap utility to set capabilities on specific utilities as needed. See man 8 setcap and man 3 cap_from_text for additional information.

Contents

Installed Programs: None
Installed Library: pam_cap.so
Installed Directories: None

Linux-PAM-1.5.3

Introduction to Linux PAM

The Linux PAM package contains Pluggable Authentication Modules used by the local system administrator to control how application programs authenticate users.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Optional Documentation

Linux PAM Dependencies

Optional

Berkeley DB-5.3.28, libnsl-2.0.0, libtirpc-1.3.3, libaudit, and Prelude

Note

Shadow-4.13 and Systemd-254 must be reinstalled and reconfigured after installing and configuring Linux PAM.

Installation of Linux PAM

If you downloaded the documentation, unpack the tarball by issuing the following command.

tar -xf ../Linux-PAM-1.5.3-docs.tar.xz --strip-components=1

Compile and link Linux PAM by running the following commands:

./configure --prefix=/usr                        \
            --sbindir=/usr/sbin                  \
            --sysconfdir=/etc                    \
            --libdir=/usr/lib                    \
            --enable-securedir=/usr/lib/security \
            --docdir=/usr/share/doc/Linux-PAM-1.5.3 &&
make

To test the results, a suitable /etc/pam.d/other configuration file must exist.

Reinstallation or Upgrade of Linux PAM

If you have a system with Linux PAM installed and working, be careful when modifying the files in /etc/pam.d, since your system may become totally unusable. If you want to run the tests, you do not need to create another /etc/pam.d/other file. The existing file can be used for the tests.

You should also be aware that make install overwrites the configuration files in /etc/security as well as /etc/environment. If you have modified those files, be sure to back them up.

For a first-time installation, create a configuration file by issuing the following commands as the root user:

install -v -m755 -d /etc/pam.d &&

cat > /etc/pam.d/other << "EOF"
auth     required       pam_deny.so
account  required       pam_deny.so
password required       pam_deny.so
session  required       pam_deny.so
EOF

Now run the tests by issuing make check. Be sure the tests produced no errors before continuing the installation. Note that the tests are very long. Redirect the output to a log file, so you can inspect it thoroughly.

For a first-time installation, remove the configuration file created earlier by issuing the following command as the root user:

rm -fv /etc/pam.d/other

Now, as the root user:

make install &&
chmod -v 4755 /usr/sbin/unix_chkpwd

Command Explanations

--enable-securedir=/usr/lib/security: This switch sets the installation location for the PAM modules.

chmod -v 4755 /usr/sbin/unix_chkpwd: The setuid bit for the unix_chkpwd helper program must be turned on, so that non-root processes can access the shadow file.

Configuring Linux-PAM

Configuration Files

/etc/security/* and /etc/pam.d/*

Configuration Information

Configuration information is placed in /etc/pam.d/. Here is a sample file:

# Begin /etc/pam.d/other

auth            required        pam_unix.so     nullok
account         required        pam_unix.so
session         required        pam_unix.so
password        required        pam_unix.so     nullok

# End /etc/pam.d/other

Now create some generic configuration files. As the root user:

install -vdm755 /etc/pam.d &&
cat > /etc/pam.d/system-account << "EOF" &&
# Begin /etc/pam.d/system-account

account   required    pam_unix.so

# End /etc/pam.d/system-account
EOF

cat > /etc/pam.d/system-auth << "EOF" &&
# Begin /etc/pam.d/system-auth

auth      required    pam_unix.so

# End /etc/pam.d/system-auth
EOF

cat > /etc/pam.d/system-session << "EOF" &&
# Begin /etc/pam.d/system-session

session   required    pam_unix.so

# End /etc/pam.d/system-session
EOF

cat > /etc/pam.d/system-password << "EOF"
# Begin /etc/pam.d/system-password

# use yescrypt hash for encryption, use shadow, and try to use any
# previously defined authentication token (chosen password) set by any
# prior module.
password  required    pam_unix.so       yescrypt shadow try_first_pass

# End /etc/pam.d/system-password
EOF

If you wish to enable strong password support, install libpwquality-1.4.5, and follow the instructions on that page to configure the pam_pwquality PAM module with strong password support.

Next, add a restrictive /etc/pam.d/other configuration file. With this file, programs that are PAM aware will not run unless a configuration file specifically for that application exists.

cat > /etc/pam.d/other << "EOF"
# Begin /etc/pam.d/other

auth        required        pam_warn.so
auth        required        pam_deny.so
account     required        pam_warn.so
account     required        pam_deny.so
password    required        pam_warn.so
password    required        pam_deny.so
session     required        pam_warn.so
session     required        pam_deny.so

# End /etc/pam.d/other
EOF

The PAM man page (man pam) provides a good starting point to learn about the several fields, and allowable entries. The Linux-PAM System Administrators' Guide is recommended for additional information.

Important

You should now reinstall the Shadow-4.13 and Systemd-254 packages.

Contents

Installed Program: faillock, mkhomedir_helper, pam_namespace_helper, pam_timestamp_check, pwhistory_helper, unix_chkpwd and unix_update
Installed Libraries: libpam.so, libpamc.so and libpam_misc.so
Installed Directories: /etc/security, /usr/lib/security, /usr/include/security and /usr/share/doc/Linux-PAM-1.5.3

Short Descriptions

faillock

displays and modifies the authentication failure record files

mkhomedir_helper

is a helper binary that creates home directories

pam_namespace_helper

is a helper program used to configure a private namespace for a user session

pwhistory_helper

is a helper program that transfers password hashes from passwd or shadow to opasswd

pam_timestamp_check

is used to check if the default timestamp is valid

unix_chkpwd

is a helper binary that verifies the password of the current user

unix_update

is a helper binary that updates the password of a given user

libpam.so

provides the interfaces between applications and the PAM modules

liboauth-1.0.3

Introduction to liboauth

liboauth is a collection of POSIX-C functions implementing the OAuth Core RFC 5849 standard. Liboauth provides functions to escape and encode parameters according to OAuth specification and offers high-level functionality to sign requests or verify OAuth signatures as well as perform HTTP requests.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

liboauth Dependencies

Required

cURL-8.2.1

Optional

nss-3.92 and Doxygen-1.9.7 (to build documentation)

Installation of liboauth

Apply a patch for the current version of openssl:

patch -Np1 -i ../liboauth-1.0.3-openssl-1.1.0-3.patch

Install liboauth by running the following commands:

./configure --prefix=/usr --disable-static &&
make

If you wish to build the documentation (needs Doxygen-1.9.7), issue:

make dox

To test the results, issue: make check.

Now, as the root user:

make install

If you have previously built the documentation, install it by running the following commands as the root user:

install -v -dm755 /usr/share/doc/liboauth-1.0.3 &&
cp -rv doc/html/* /usr/share/doc/liboauth-1.0.3

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-nss: Use this switch if you want to use Mozilla NSS instead of OpenSSL.

Contents

Installed Programs: None
Installed Libraries: liboauth.so
Installed Directories: /usr/share/doc/liboauth-1.0.3

Short Descriptions

liboauth.so

provides functions to escape and encode strings according to OAuth specifications and offers high-level functionality built on top to sign requests or verify signatures using either NSS or OpenSSL for calculating the hash/signatures

libpwquality-1.4.5

Introduction to libpwquality

The libpwquality package provides common functions for password quality checking and also scoring them based on their apparent randomness. The library also provides a function for generating random passwords with good pronounceability.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libpwquality Dependencies

Required

CrackLib-2.9.11

Recommended

Installation of libpwquality

Install libpwquality by running the following commands:

./configure --prefix=/usr                      \
            --disable-static                   \
            --with-securedir=/usr/lib/security \
            --with-python-binary=python3       &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--with-python-binary=python3: This parameter gives the location of the Python binary. The default is python, and requires Python-2.7.18.

Configuring libpwquality

libpwquality is intended to be a functional replacement for the now-obsolete pam_cracklib.so PAM module. To configure the system to use the pam_pwquality module, execute the following commands as the root user:

mv /etc/pam.d/system-password{,.orig} &&
cat > /etc/pam.d/system-password << "EOF"
# Begin /etc/pam.d/system-password

# check new passwords for strength (man pam_pwquality)
password  required    pam_pwquality.so   authtok_type=UNIX retry=1 difok=1 \
                                         minlen=8 dcredit=0 ucredit=0 \
                                         lcredit=0 ocredit=0 minclass=1 \
                                         maxrepeat=0 maxsequence=0 \
                                         maxclassrepeat=0 gecoscheck=0 \
                                         dictcheck=1 usercheck=1 \
                                         enforcing=1 badwords="" \
                                         dictpath=/usr/lib/cracklib/pw_dict

# use yescrypt hash for encryption, use shadow, and try to use any
# previously defined authentication token (chosen password) set by any
# prior module.
password  required    pam_unix.so        yescrypt shadow try_first_pass

# End /etc/pam.d/system-password
EOF

Contents

Installed Programs: pwscore and pwmake
Installed Libraries: pam_pwquality.so and libpwquality.so
Installed Directories: None

Short Descriptions

pwmake

is a simple configurable tool for generating random and relatively easily pronounceable passwords

pwscore

is a simple tool for checking quality of a password

libpwquality.so

contains API functions for checking the password quality

pam_pwquality.so

is a Linux PAM module used to perform password quality checking

MIT Kerberos V5-1.21.2

Introduction to MIT Kerberos V5

MIT Kerberos V5 is a free implementation of Kerberos 5. Kerberos is a network authentication protocol. It centralizes the authentication database and uses kerberized applications to work with servers or services that support Kerberos allowing single logins and encrypted communication over internal networks or the Internet.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://kerberos.org/dist/krb5/1.21/krb5-1.21.2.tar.gz

  • Download MD5 sum: 97d5f3a48235c53f6d537c877290d2af

  • Download size: 8.2 MB

  • Estimated disk space required: 130 MB (add 10 MB for tests)

  • Estimated build time: 0.3 SBU (Using parallelism=4; add 1.0 SBU for tests)

MIT Kerberos V5 Dependencies

Optional

BIND Utilities-9.18.18, GnuPG-2.4.3 (to authenticate the package), keyutils-1.6.1, OpenLDAP-2.6.6, Valgrind-3.21.0 (used during the test suite), yasm-1.3.0, libedit, cmocka, kdcproxy, pyrad, and resolv_wrapper

Note

Some sort of time synchronization facility on your system (like ntp-4.2.8p17) is required since Kerberos won't authenticate if there is a time difference between a kerberized client and the KDC server.

Installation of MIT Kerberos V5

Build MIT Kerberos V5 by running the following commands:

cd src &&

sed -i -e '/eq 0/{N;s/12 //}'    plugins/kdb/db2/libdb2/test/run.test &&


./configure --prefix=/usr            \
            --sysconfdir=/etc        \
            --localstatedir=/var/lib \
            --runstatedir=/run       \
            --with-system-et         \
            --with-system-ss         \
            --with-system-verto=no   \
            --enable-dns-for-realm &&
make

To test the build, issue: make -j1 -k check. Some tests may fail with the latest version of dejagnu and glibc. Some tests may hang for a long time and fail if the system is not connected to a network. One test, t_kadm5srv, is known to fail.

Now, as the root user:

make install &&
cp -vfr ../doc -T /usr/share/doc/krb5-1.21.2

Command Explanations

The sed command removes a test that is known to fail.

--localstatedir=/var/lib: This option is used so that the Kerberos variable runtime data is located in /var/lib instead of /usr/var.

--runstatedir=/run: This option is used so that the Kerberos runtime state information is located in /run instead of the deprecated /var/run.

--with-system-et: This switch causes the build to use the system-installed versions of the error-table support software.

--with-system-ss: This switch causes the build to use the system-installed versions of the subsystem command-line interface software.

--with-system-verto=no: This switch fixes a bug in the package: it does not recognize its own verto library installed previously. This is not a problem, if reinstalling the same version, but if you are updating, the old library is used as system's one, instead of installing the new version.

--enable-dns-for-realm: This switch allows realms to be resolved using the DNS server.

--with-ldap: Use this switch if you want to compile the OpenLDAP database backend module.

Configuring MIT Kerberos V5

Config Files

/etc/krb5.conf and /var/lib/krb5kdc/kdc.conf

Configuration Information

Kerberos Configuration

Tip

You should consider installing some sort of password checking dictionary so that you can configure the installation to only accept strong passwords. A suitable dictionary to use is shown in the CrackLib-2.9.11 instructions. Note that only one file can be used, but you can concatenate many files into one. The configuration file shown below assumes you have installed a dictionary to /usr/share/dict/words.

Create the Kerberos configuration file with the following commands issued by the root user:

cat > /etc/krb5.conf << "EOF"
# Begin /etc/krb5.conf

[libdefaults]
    default_realm = <EXAMPLE.ORG>
    encrypt = true

[realms]
    <EXAMPLE.ORG> = {
        kdc = <belgarath.example.org>
        admin_server = <belgarath.example.org>
        dict_file = /usr/share/dict/words
    }

[domain_realm]
    .<example.org> = <EXAMPLE.ORG>

[logging]
    kdc = SYSLOG:INFO:AUTH
    admin_server = SYSLOG:INFO:AUTH
    default = SYSLOG:DEBUG:DAEMON

# End /etc/krb5.conf
EOF

You will need to substitute your domain and proper hostname for the occurrences of the <belgarath> and <example.org> names.

default_realm should be the name of your domain changed to ALL CAPS. This isn't required, but both Heimdal and MIT recommend it.

encrypt = true provides encryption of all traffic between kerberized clients and servers. It's not necessary and can be left off. If you leave it off, you can encrypt all traffic from the client to the server using a switch on the client program instead.

The [realms] parameters tell the client programs where to look for the KDC authentication services.

The [domain_realm] section maps a domain to a realm.

Create the KDC database:

kdb5_util create -r <EXAMPLE.ORG> -s

Now you should populate the database with principals (users). For now, just use your regular login name or root.

kadmin.local
kadmin.local: add_policy dict-only
kadmin.local: addprinc -policy dict-only <loginname>

The KDC server and any machine running kerberized server daemons must have a host key installed:

kadmin.local: addprinc -randkey host/<belgarath.example.org>

After choosing the defaults when prompted, you will have to export the data to a keytab file:

kadmin.local: ktadd host/<belgarath.example.org>

This should have created a file in /etc named krb5.keytab (Kerberos 5). This file should have 600 (root rw only) permissions. Keeping the keytab files from public access is crucial to the overall security of the Kerberos installation.

Exit the kadmin program (use quit or exit) and return back to the shell prompt. Start the KDC daemon manually, just to test out the installation:

/usr/sbin/krb5kdc

Attempt to get a ticket with the following command:

kinit <loginname>

You will be prompted for the password you created. After you get your ticket, you can list it with the following command:

klist

Information about the ticket should be displayed on the screen.

To test the functionality of the keytab file, issue the following command as the root user:

ktutil
ktutil: rkt /etc/krb5.keytab
ktutil: l

This should dump a list of the host principal, along with the encryption methods used to access the principal.

Create an empty ACL file that can be modified later:

touch /var/lib/krb5kdc/kadm5.acl

At this point, if everything has been successful so far, you can feel fairly confident in the installation and configuration of the package.

Additional Information

For additional information consult the documentation for krb5-1.21.2 on which the above instructions are based.

Systemd Unit

If you want to start Kerberos services at boot, install the krb5.service unit included in the blfs-systemd-units-20230816 package using the following command:

make install-krb5

Contents

Installed Programs: gss-client, gss-server, k5srvutil, kadmin, kadmin.local, kadmind, kdb5_ldap_util (optional), kdb5_util, kdestroy, kinit, klist, kpasswd, kprop, kpropd, kproplog, krb5-config, krb5-send-pr, krb5kdc, ksu, kswitch, ktutil, kvno, sclient, sim_client, sim_server, sserver, uuclient, and uuserver
Installed Libraries: libgssapi_krb5.so, libgssrpc.so, libk5crypto.so, libkadm5clnt_mit.so, libkadm5clnt.so, libkadm5srv_mit.so, libkadm5srv.so, libkdb_ldap.so (optional), libkdb5.so, libkrad.so, libkrb5.so, libkrb5support.so, libverto.so, and some plugins under the /usr/lib/krb5 tree
Installed Directories: /usr/include/{gssapi,gssrpc,kadm5,krb5}, /usr/lib/krb5, /usr/share/{doc/krb5-1.21.2,examples/krb5}, /var/lib/krb5kdc, and /run/krb5kdc

Short Descriptions

gss-client

is a GSSAPI test client

gss-server

is a GSSAPI test server

k5srvutil

is a host keytable manipulation utility

kadmin

is an utility used to make modifications to the Kerberos database

kadmin.local

is an utility similar to kadmin, but if the database is db2, the local client kadmin.local, is intended to run directly on the master KDC without Kerberos authentication

kadmind

is a server for administrative access to a Kerberos database

kdb5_ldap_util (optional)

allows an administrator to manage realms, Kerberos services and ticket policies

kdb5_util

is the KDC database utility

kdestroy

removes the current set of tickets

kinit

is used to authenticate to the Kerberos server as a principal and acquire a ticket granting ticket that can later be used to obtain tickets for other services

klist

reads and displays the current tickets in the credential cache

kpasswd

is a program for changing Kerberos 5 passwords

kprop

takes a principal database in a specified format and converts it into a stream of database records

kpropd

receives a database sent by kprop and writes it as a local database

kproplog

displays the contents of the KDC database update log to standard output

krb5-config

gives information on how to link programs against libraries

krb5kdc

is the Kerberos 5 server

krb5-send-pr

sends a problem report (PR) to a central support site

ksu

is the super user program using Kerberos protocol. Requires a properly configured /etc/shells and ~/.k5login containing principals authorized to become super users

kswitch

makes the specified credential cache the primary cache for the collection, if a cache collection is available

ktutil

is a program for managing Kerberos keytabs

kvno

prints keyversion numbers of Kerberos principals

sclient

is used to contact a sample server and authenticate to it using Kerberos 5 tickets, then display the server's response

sim_client

is a simple UDP-based sample client program, for demonstration

sim_server

is a simple UDP-based server application, for demonstration

sserver

is the sample Kerberos 5 server

uuclient

is another sample client

uuserver

is another sample server

libgssapi_krb5.so

contains the Generic Security Service Application Programming Interface (GSSAPI) functions which provides security services to callers in a generic fashion, supportable with a range of underlying mechanisms and technologies and hence allowing source-level portability of applications to different environments

libkadm5clnt.so

contains the administrative authentication and password checking functions required by Kerberos 5 client-side programs

libkadm5srv.so

contains the administrative authentication and password checking functions required by Kerberos 5 servers

libkdb5.so

is a Kerberos 5 authentication/authorization database access library

libkrad.so

contains the internal support library for RADIUS functionality

libkrb5.so

is an all-purpose Kerberos 5 library

Nettle-3.9.1

Introduction to Nettle

The Nettle package contains a low-level cryptographic library that is designed to fit easily in many contexts.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Nettle Dependencies

Optional

Valgrind-3.21.0 (optional for the tests)

Installation of Nettle

Install Nettle by running the following commands:

./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check.

Now, as the root user:

make install &&
chmod   -v   755 /usr/lib/lib{hogweed,nettle}.so &&
install -v -m755 -d /usr/share/doc/nettle-3.9.1 &&
install -v -m644 nettle.{html,pdf} /usr/share/doc/nettle-3.9.1

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: nettle-hash, nettle-lfib-stream, nettle-pbkdf2, pkcs1-conv and sexp-conv
Installed Libraries: libhogweed.so and libnettle.so
Installed Directory: /usr/include/nettle and /usr/share/doc/nettle-3.9.1

Short Descriptions

nettle-hash

calculates a hash value using a specified algorithm

nettle-lfib-stream

outputs a sequence of pseudorandom (non-cryptographic) bytes, using Knuth's lagged fibonacci generator. The stream is useful for testing, but should not be used to generate cryptographic keys or anything else that needs real randomness

nettle-pbkdf2

is a password-based key derivation function that takes a password or a passphrase as input and returns a strengthened password, which is protected against pre-computation attacks by using salting and other expensive computations.

pkcs1-conv

converts private and public RSA keys from PKCS #1 format to sexp format

sexp-conv

converts an s-expression to a different encoding

NSS-3.92

Introduction to NSS

The Network Security Services (NSS) package is a set of libraries designed to support cross-platform development of security-enabled client and server applications. Applications built with NSS can support SSL v2 and v3, TLS, PKCS #5, PKCS #7, PKCS #11, PKCS #12, S/MIME, X.509 v3 certificates, and other security standards. This is useful for implementing SSL and S/MIME or other Internet security standards into an application.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

NSS Dependencies

Required

NSPR-4.35

Recommended

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/nss

Installation of NSS

Install NSS by running the following commands:

patch -Np1 -i ../nss-3.92-standalone-1.patch &&

cd nss &&

make BUILD_OPT=1                  \
  NSPR_INCLUDE_DIR=/usr/include/nspr  \
  USE_SYSTEM_ZLIB=1                   \
  ZLIB_LIBS=-lz                       \
  NSS_ENABLE_WERROR=0                 \
  $([ $(uname -m) = x86_64 ] && echo USE_64=1) \
  $([ -f /usr/include/sqlite3.h ] && echo NSS_USE_SYSTEM_SQLITE=1)

To run the tests, execute the following commands:

cd tests &&
HOST=localhost DOMSUF=localdomain ./all.sh
cd ../

Note

Some information about the tests:

  • HOST=localhost and DOMSUF=localdomain are required. Without these variables, a FQDN is required to be specified and this generic way should work for everyone, provided localhost.localdomain is defined in /etc/hosts, as done in the LFS book.

  • The tests take a long time to run. If desired there is information in the all.sh script about running subsets of the total test suite.

  • When interrupting the tests, the test suite fails to spin down test servers that are run. This leads to an infinite loop in the tests where the test suite tries to kill a server that doesn't exist anymore because it pulls the wrong PID.

  • Test suite results (in HTML format!) can be found at ../../test_results/security/localhost.1/results.html

  • A few tests might fail on some Intel machines for unknown reasons.

Now, as the root user:

cd ../dist                                                          &&

install -v -m755 Linux*/lib/*.so              /usr/lib              &&
install -v -m644 Linux*/lib/{*.chk,libcrmf.a} /usr/lib              &&

install -v -m755 -d                           /usr/include/nss      &&
cp -v -RL {public,private}/nss/*              /usr/include/nss      &&

install -v -m755 Linux*/bin/{certutil,nss-config,pk12util} /usr/bin &&

install -v -m644 Linux*/lib/pkgconfig/nss.pc  /usr/lib/pkgconfig

Command Explanations

BUILD_OPT=1: This option is passed to make so that the build is performed with no debugging symbols built into the binaries and the default compiler optimizations are used.

NSPR_INCLUDE_DIR=/usr/include/nspr: This option sets the location of the nspr headers.

USE_SYSTEM_ZLIB=1: This option is passed to make to ensure that the libssl3.so library is linked to the system installed zlib instead of the in-tree version.

ZLIB_LIBS=-lz: This option provides the linker flags needed to link to the system zlib.

$([ $(uname -m) = x86_64 ] && echo USE_64=1): The USE_64=1 option is required on x86_64, otherwise make will try (and fail) to create 32-bit objects. The [ $(uname -m) = x86_64 ] test ensures it has no effect on a 32 bit system.

([ -f /usr/include/sqlite3.h ] && echo NSS_USE_SYSTEM_SQLITE=1): This tests if sqlite is installed and if so it echos the option NSS_USE_SYSTEM_SQLITE=1 to make so that libsoftokn3.so will link against the system version of sqlite.

NSS_DISABLE_GTESTS=1: If you don't need to run NSS test suite, append this option to make command, to prevent the compilation of tests and save some build time.

Configuring NSS

If p11-kit-0.25.0 is installed, the p11-kit trust module (/usr/lib/pkcs11/p11-kit-trust.so) can be used as a drop-in replacement for /usr/lib/libnssckbi.so to transparently make the system CAs available to NSS aware applications, rather than the static list provided by /usr/lib/libnssckbi.so. As the root user, execute the following command:

ln -sfv ./pkcs11/p11-kit-trust.so /usr/lib/libnssckbi.so

Additionally, for dependent applications that do not use the internal database (/usr/lib/libnssckbi.so), the /usr/sbin/make-ca script included on the make-ca-1.12 page can generate a system wide NSS DB with the -n switch, or by modifying the /etc/make-ca/make-ca.conf file.

Contents

Installed Programs: certutil, nss-config, and pk12util
Installed Libraries: libcrmf.a, libfreebl3.so, libfreeblpriv3.so, libnss3.so, libnssckbi.so, libnssckbi-testlib.so, libnssdbm3.so, libnsssysinit.so, libnssutil3.so, libpkcs11testmodule.so, libsmime3.so, libsoftokn3.so, and libssl3.so
Installed Directories: /usr/include/nss

Short Descriptions

certutil

is the Mozilla Certificate Database Tool. It is a command-line utility that can create and modify the Netscape Communicator cert8.db and key3.db database files. It can also list, generate, modify, or delete certificates within the cert8.db file and create or change the password, generate new public and private key pairs, display the contents of the key database, or delete key pairs within the key3.db file

nss-config

is used to determine the NSS library settings of the installed NSS libraries

pk12util

is a tool for importing certificates and keys from pkcs #12 files into NSS or exporting them. It can also list certificates and keys in such files

OpenSSH-9.4p1

Introduction to OpenSSH

The OpenSSH package contains ssh clients and the sshd daemon. This is useful for encrypting authentication and subsequent traffic over a network. The ssh and scp commands are secure implementations of telnet and rcp respectively.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

OpenSSH Dependencies

Optional

GDB-13.2 (for tests), Linux-PAM-1.5.3, Xorg Applications (or Xorg build environment, see Command Explanations), MIT Kerberos V5-1.21.2, Which-2.21 (for tests), libedit, LibreSSL Portable, OpenSC, and libsectok

Optional Runtime (Used only to gather entropy)

Net-tools-2.10, and Sysstat-12.7.2

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/OpenSSH

Installation of OpenSSH

OpenSSH runs as two processes when connecting to other computers. The first process is a privileged process and controls the issuance of privileges as necessary. The second process communicates with the network. Additional installation steps are necessary to set up the proper environment, which are performed by issuing the following commands as the root user:

install -v -g sys -m700 -d /var/lib/sshd &&

groupadd -g 50 sshd        &&
useradd  -c 'sshd PrivSep' \
         -d /var/lib/sshd  \
         -g sshd           \
         -s /bin/false     \
         -u 50 sshd

Install OpenSSH by running the following commands:

./configure --prefix=/usr                            \
            --sysconfdir=/etc/ssh                    \
            --with-privsep-path=/var/lib/sshd        \
            --with-default-path=/usr/bin             \
            --with-superuser-path=/usr/sbin:/usr/bin \
            --with-pid-dir=/run                      &&
make

To test the results, issue: make -j1 tests.

Now, as the root user:

make install &&
install -v -m755    contrib/ssh-copy-id /usr/bin     &&

install -v -m644    contrib/ssh-copy-id.1 \
                    /usr/share/man/man1              &&
install -v -m755 -d /usr/share/doc/openssh-9.4p1     &&
install -v -m644    INSTALL LICENCE OVERVIEW README* \
                    /usr/share/doc/openssh-9.4p1

Command Explanations

--sysconfdir=/etc/ssh: This prevents the configuration files from being installed in /usr/etc.

--with-default-path=/usr/bin and --with-superuser-path=/usr/sbin:/usr/bin: These set PATH consistent with LFS and BLFS Shadow package.

--with-pid-dir=/run: This prevents OpenSSH from referring to deprecated /var/run.

--with-pam: This parameter enables Linux-PAM support in the build.

--with-xauth=$XORG_PREFIX/bin/xauth: Set the default location for the xauth binary for X authentication. The environment variable XORG_PREFIX should be set following Xorg build environment. This can also be controlled from sshd_config with the XAuthLocation keyword. You can omit this switch if Xorg is already installed.

--with-kerberos5=/usr: This option is used to include Kerberos 5 support in the build.

--with-libedit: This option enables line editing and history features for sftp.

Configuring OpenSSH

Config Files

~/.ssh/*, /etc/ssh/ssh_config, and /etc/ssh/sshd_config

There are no required changes to any of these files. However, you may wish to view the /etc/ssh/ files and make any changes appropriate for the security of your system. One recommended change is that you disable root login via ssh. Execute the following command as the root user to disable root login via ssh:

echo "PermitRootLogin no" >> /etc/ssh/sshd_config

If you want to be able to log in without typing in your password, first create ~/.ssh/id_rsa and ~/.ssh/id_rsa.pub with ssh-keygen and then copy ~/.ssh/id_rsa.pub to ~/.ssh/authorized_keys on the remote computer that you want to log into. You'll need to change REMOTE_USERNAME and REMOTE_HOSTNAME for the username and hostname of the remote computer and you'll also need to enter your password for the ssh-copy-id command to succeed:

ssh-keygen &&
ssh-copy-id -i ~/.ssh/id_rsa.pub REMOTE_USERNAME@REMOTE_HOSTNAME

Once you've got passwordless logins working it's actually more secure than logging in with a password (as the private key is much longer than most people's passwords). If you would like to now disable password logins, as the root user:

echo "PasswordAuthentication no" >> /etc/ssh/sshd_config &&
echo "KbdInteractiveAuthentication no" >> /etc/ssh/sshd_config

If you added Linux-PAM support and you want ssh to use it then you will need to add a configuration file for sshd and enable use of LinuxPAM. Note, ssh only uses PAM to check passwords, if you've disabled password logins these commands are not needed. If you want to use PAM, issue the following commands as the root user:

sed 's@d/login@d/sshd@g' /etc/pam.d/login > /etc/pam.d/sshd &&
chmod 644 /etc/pam.d/sshd &&
echo "UsePAM yes" >> /etc/ssh/sshd_config

Additional configuration information can be found in the man pages for sshd, ssh and ssh-agent.

Systemd Unit

To start the SSH server at system boot, install the sshd.service unit included in the blfs-systemd-units-20230816 package.

make install-sshd

Contents

Installed Programs: scp, sftp, ssh, ssh-add, ssh-agent, ssh-copy-id, ssh-keygen, ssh-keyscan, and sshd
Installed Libraries: None
Installed Directories: /etc/ssh, /usr/share/doc/openssh-9.4p1, and /var/lib/sshd

Short Descriptions

scp

is a file copy program that acts like rcp except it uses an encrypted protocol

sftp

is an FTP-like program that works over the SSH1 and SSH2 protocols

ssh

is an rlogin/rsh-like client program except it uses an encrypted protocol

sshd

is a daemon that listens for ssh login requests

ssh-add

is a tool which adds keys to the ssh-agent

ssh-agent

is an authentication agent that can store private keys

ssh-copy-id

is a script that enables logins on remote machines using local keys

ssh-keygen

is a key generation tool

ssh-keyscan

is a utility for gathering public host keys from a number of hosts

p11-kit-0.25.0

Introduction to p11-kit

The p11-kit package provides a way to load and enumerate PKCS #11 (a Cryptographic Token Interface Standard) modules.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

p11-kit Dependencies

Recommended
Recommended (runtime)
Optional

GTK-Doc-1.33.2, libxslt-1.1.38, and nss-3.92 (runtime)

Installation of p11-kit

Fix an issue causing some PKCS 11 modules fail to load:

sed 's/if (gi/& \&\& gi != C_GetInterface/' \
    -i p11-kit/modules.c

Prepare the distribution specific anchor hook:

sed '20,$ d' -i trust/trust-extract-compat &&
cat >> trust/trust-extract-compat << "EOF"
# Copy existing anchor modifications to /etc/ssl/local
/usr/libexec/make-ca/copy-trust-modifications

# Update trust stores
/usr/sbin/make-ca -r
EOF

Install p11-kit by running the following commands:

mkdir p11-build &&
cd    p11-build &&

meson setup ..            \
      --prefix=/usr       \
      --buildtype=release \
      -Dtrust_paths=/etc/pki/anchors &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install &&
ln -sfv /usr/libexec/p11-kit/trust-extract-compat \
        /usr/bin/update-ca-certificates

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dtrust_paths=/etc/pki/anchors: this switch sets the location of trusted certificates used by libp11-kit.so.

-Dhash_impl=freebl: Use this switch if you want to use the Freebl library from NSS for SHA1 and MD5 hashing.

-Dgtk_doc=true: Use this switch if you have installed GTK-Doc-1.33.2 and libxslt-1.1.38 and wish to rebuild the documentation and generate manual pages.

Configuring p11-kit

The p11-kit trust module (/usr/lib/pkcs11/p11-kit-trust.so) can be used as a drop-in replacement for /usr/lib/libnssckbi.so to transparently make the system CAs available to NSS aware applications, rather than the static list provided by /usr/lib/libnssckbi.so. As the root user, execute the following commands:

ln -sfv ./pkcs11/p11-kit-trust.so /usr/lib/libnssckbi.so

Contents

Installed Programs: p11-kit, trust, and update-ca-certificates
Installed Libraries: libp11-kit.so and p11-kit-proxy.so
Installed Directories: /etc/pkcs11, /usr/include/p11-kit-1, /usr/lib/pkcs11, /usr/libexec/p11-kit, /usr/share/gtk-doc/html/p11-kit, and /usr/share/p11-kit

Short Descriptions

p11-kit

is a command line tool that can be used to perform operations on PKCS#11 modules configured on the system

trust

is a command line tool to examine and modify the shared trust policy store

update-ca-certificates

is a command line tool to both extract local certificates from an updated anchor store, and regenerate all anchors and certificate stores on the system. This is done unconditionally on BLFS using the --force and --get flags to make-ca and should likely not be used for automated updates

libp11-kit.so

contains functions used to coordinate initialization and finalization of any PKCS#11 module

p11-kit-proxy.so

is the PKCS#11 proxy module

Polkit-123

Introduction to Polkit

Polkit is a toolkit for defining and handling authorizations. It is used for allowing unprivileged processes to communicate with privileged processes.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Polkit Dependencies

Required

GLib-2.76.4

Recommended

Note

Since systemd-logind uses PAM to register user sessions, it is a good idea to build Polkit with PAM support so systemd-logind can track Polkit sessions.

Optional

GTK-Doc-1.33.2, JS-102.13.0 (can be used in place of duktape), and dbusmock-0.29.1 (for tests)

Required Runtime Dependencies

Systemd-254

Optional Runtime Dependencies

One polkit authentication agent for using polkit in the graphical environment: polkit-kde-agent in Plasma-5.27.7 for KDE, the agent built in gnome-shell-44.3 for GNOME3, polkit-gnome-0.105 for XFCE, and lxpolkit in LXSession-0.5.5 for LXDE

Note

If libxslt-1.1.38 is installed, then docbook-xml-4.5 and docbook-xsl-nons-1.79.2 are required. If you have installed libxslt-1.1.38, but you do not want to install any of the DocBook packages mentioned, you will need to use -Dman=false in the instructions below.

Installation of Polkit

There should be a dedicated user and group to take control of the polkitd daemon after it is started. Issue the following commands as the root user:

groupadd -fg 27 polkitd &&
useradd -c "PolicyKit Daemon Owner" -d /etc/polkit-1 -u 27 \
        -g polkitd -s /bin/false polkitd

If using JS-102.13.0, make the following change (see Command Explanations below for more information):

sed -e 's/JS_Init/JS::DisableJitBackend(); &/' \
    -i src/polkitbackend/polkitbackendjsauthority.cpp

Install Polkit by running the following commands:

mkdir build &&
cd    build &&

meson setup ..                            \
      --prefix=/usr                       \
      --buildtype=release                 \
      -Dman=true                          \
      -Dsession_tracking=libsystemd-login \
      -Dtests=true                        &&
ninja

To test the results, first ensure that the system D-Bus daemon is running, and both D-Bus Python-1.3.2 and dbusmock-0.29.1 are installed. Then run ninja test.

Now, as the root user:

ninja install

Command Explanations

sed -e 's/JS_Init/JS::DisableJitBackend(); &/' ... : The JIT compiling of JS102 needs W+X mapping which is dangerous and is not permitted by the systemd unit file shipped within the polkit package. This command is not strictly needed on systems based on sysvinit but it still improves security. It has no effect if building polkit with the recommended duktape-2.7.0 Javascript engine.

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dtests=true: This switch allows to run the test suite of this package. As Polkit is used for authorizations, its integrity can affect system security. So it's recommended to run the test suite building this package.

-Djs_engine=mozjs: This switch allows using the JS-102.13.0 JavaScript engine instead of the duktape-2.7.0 JavaScript engine.

-Dos_type=lfs: Use this switch if you did not create the /etc/lfs-release file or distribution auto detection will fail and you will be unable to use Polkit.

-Dauthfw=shadow: This switch enables the package to use the Shadow rather than the Linux PAM Authentication framework. Use it if you have not installed Linux PAM.

-Dintrospection=false: Use this option if you are certain that you do not need gobject-introspection files for polkit, or do not have gobject-introspection installed.

-Dman=false: Use this option to disable generating and installing manual pages. This is useful if libxslt is not installed.

-Dexamples=true: Use this option to build the example programs.

-Dgtk_doc=true: Use this option to enable building and installing the API documentation.

Contents

Installed Programs: pkaction, pkcheck, pkexec, pkttyagent, and polkitd
Installed Libraries: libpolkit-agent-1.so and libpolkit-gobject-1.so
Installed Directories: /etc/polkit-1, /usr/include/polkit-1, /usr/lib/polkit-1, /usr/share/gtk-doc/html/polkit-1, and /usr/share/polkit-1

Short Descriptions

pkaction

is used to obtain information about registered PolicyKit actions

pkcheck

is used to check whether a process is authorized for action

pkexec

allows an authorized user to execute a command as another user

pkttyagent

is used to start a textual authentication agent for the subject

polkitd

provides the org.freedesktop.PolicyKit1 D-Bus service on the system message bus

libpolkit-agent-1.so

contains the Polkit authentication agent API functions

libpolkit-gobject-1.so

contains the Polkit authorization API functions

polkit-gnome-0.105

Introduction to Polkit GNOME

The Polkit GNOME package provides an Authentication Agent for Polkit that integrates well with the GNOME Desktop environment.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Polkit GNOME Dependencies

Required

AccountsService-23.13.9, GTK+-3.24.38, and Polkit-123

Installation of Polkit GNOME

First, apply some fixes that allow for the proper user icon to be used, as well as some security fixes:

patch -Np1 -i ../polkit-gnome-0.105-consolidated_fixes-1.patch

Install Polkit GNOME by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Configuring Polkit GNOME

Automatic Startup

For the authentication framework to work, polkit-gnome-authentification-agent-1 needs to be started. However, make install did not install a startup file for the Polkit GNOME so you have to create it by yourself.

Issue the following commands as the root user to create a startup file for Polkit GNOME:

mkdir -p /etc/xdg/autostart &&
cat > /etc/xdg/autostart/polkit-gnome-authentication-agent-1.desktop << "EOF"
[Desktop Entry]
Name=PolicyKit Authentication Agent
Comment=PolicyKit Authentication Agent
Exec=/usr/libexec/polkit-gnome-authentication-agent-1
Terminal=false
Type=Application
Categories=
NoDisplay=true
OnlyShowIn=GNOME;XFCE;Unity;
AutostartCondition=GNOME3 unless-session gnome
EOF

Contents

Installed Program: polkit-gnome-authentication-agent-1
Installed Libraries: None
Installed Directory: None

Short Descriptions

polkit-gnome-authentication-agent-1

is the Polkit authentication agent

Shadow-4.13

Introduction to Shadow

Shadow was indeed installed in LFS and there is no reason to reinstall it unless you installed CrackLib or Linux-PAM after your LFS system was completed. If you have installed CrackLib after LFS, then reinstalling Shadow will enable strong password support. If you have installed Linux-PAM, reinstalling Shadow will allow programs such as login and su to utilize PAM.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Shadow Dependencies

Required

Linux-PAM-1.5.3 or CrackLib-2.9.11

Installation of Shadow

Important

The installation commands shown below are for installations where Linux-PAM has been installed and Shadow is being reinstalled to support the Linux-PAM installation.

If you are reinstalling Shadow to provide strong password support using the CrackLib library without using Linux-PAM, ensure you add the --with-libcrack parameter to the configure script below and also issue the following command:

sed -i 's@DICTPATH.*@DICTPATH\t/lib/cracklib/pw_dict@' etc/login.defs

Reinstall Shadow by running the following commands:

sed -i 's/groups$(EXEEXT) //' src/Makefile.in          &&

find man -name Makefile.in -exec sed -i 's/groups\.1 / /'   {} \; &&
find man -name Makefile.in -exec sed -i 's/getspnam\.3 / /' {} \; &&
find man -name Makefile.in -exec sed -i 's/passwd\.5 / /'   {} \; &&

sed -e 's@#ENCRYPT_METHOD DES@ENCRYPT_METHOD YESCRYPT@' \
    -e 's@/var/spool/mail@/var/mail@'                   \
    -e '/PATH=/{s@/sbin:@@;s@/bin:@@}'                  \
    -i etc/login.defs                                   &&

./configure --sysconfdir=/etc               \
            --disable-static                \
            --with-{b,yes}crypt             \
            --with-group-name-max-length=32 &&
make

This package does not come with a test suite.

Now, as the root user:

make exec_prefix=/usr install

The man pages were installed in LFS, but if reinstallation is desired, run (as the root user):

make -C man install-man

Command Explanations

sed -i 's/groups$(EXEEXT) //' src/Makefile.in: This sed is used to suppress the installation of the groups program as the version from the Coreutils package installed during LFS is preferred.

find man -name Makefile.in -exec ... {} \;: The first command is used to suppress the installation of the groups man pages so the existing ones installed from the Coreutils package are not replaced. The two other commands prevent installation of manual pages that are already installed by Man-pages in LFS.

sed -e 's@#ENCRYPT_METHOD DES@ENCRYPT_METHOD YESCRYPT@' -e 's@/var/spool/mail@/var/mail@' -e '/PATH=/{s@/sbin:@@;s@/bin:@@}' -i etc/login.defs: Instead of using the default 'DES' method, this command modifies the installation to use the much more secure 'YESCRYPT' method of hashing passwords, which also allows passwords longer than eight characters. The command also changes the obsolete /var/spool/mail location for user mailboxes that Shadow uses by default to the /var/mail location. It also changes the default path to be consistent with that set in LFS.

--with-group-name-max-length=32: The maximum user name is 32 characters. Make the maximum group name the same.

Configuring Linux-PAM to Work with Shadow

Note

The rest of this page is devoted to configuring Shadow to work properly with Linux-PAM. If you do not have Linux-PAM installed, and you reinstalled Shadow to support strong passwords via the CrackLib library, no further configuration is required.

Config Files

/etc/pam.d/* or alternatively /etc/pam.conf, /etc/login.defs and /etc/security/*

Configuration Information

Configuring your system to use Linux-PAM can be a complex task. The information below will provide a basic setup so that Shadow's login and password functionality will work effectively with Linux-PAM. Review the information and links on the Linux-PAM-1.5.3 page for further configuration information. For information specific to integrating Shadow, Linux-PAM and libpwquality, you can visit the following link:

Configuring /etc/login.defs

The login program currently performs many functions which Linux-PAM modules should now handle. The following sed command will comment out the appropriate lines in /etc/login.defs, and stop login from performing these functions (a backup file named /etc/login.defs.orig is also created to preserve the original file's contents). Issue the following commands as the root user:

install -v -m644 /etc/login.defs /etc/login.defs.orig &&
for FUNCTION in FAIL_DELAY               \
                FAILLOG_ENAB             \
                LASTLOG_ENAB             \
                MAIL_CHECK_ENAB          \
                OBSCURE_CHECKS_ENAB      \
                PORTTIME_CHECKS_ENAB     \
                QUOTAS_ENAB              \
                CONSOLE MOTD_FILE        \
                FTMP_FILE NOLOGINS_FILE  \
                ENV_HZ PASS_MIN_LEN      \
                SU_WHEEL_ONLY            \
                CRACKLIB_DICTPATH        \
                PASS_CHANGE_TRIES        \
                PASS_ALWAYS_WARN         \
                CHFN_AUTH ENCRYPT_METHOD \
                ENVIRON_FILE
do
    sed -i "s/^${FUNCTION}/# &/" /etc/login.defs
done
Configuring the /etc/pam.d/ Files

As mentioned previously in the Linux-PAM instructions, Linux-PAM has two supported methods for configuration. The commands below assume that you've chosen to use a directory based configuration, where each program has its own configuration file. You can optionally use a single /etc/pam.conf configuration file by using the text from the files below, and supplying the program name as an additional first field for each line.

As the root user, create the following Linux-PAM configuration files in the /etc/pam.d/ directory (or add the contents to the /etc/pam.conf file) using the following commands:

'login'
cat > /etc/pam.d/login << "EOF"
# Begin /etc/pam.d/login

# Set failure delay before next prompt to 3 seconds
auth      optional    pam_faildelay.so  delay=3000000

# Check to make sure that the user is allowed to login
auth      requisite   pam_nologin.so

# Check to make sure that root is allowed to login
# Disabled by default. You will need to create /etc/securetty
# file for this module to function. See man 5 securetty.
#auth      required    pam_securetty.so

# Additional group memberships - disabled by default
#auth      optional    pam_group.so

# include system auth settings
auth      include     system-auth

# check access for the user
account   required    pam_access.so

# include system account settings
account   include     system-account

# Set default environment variables for the user
session   required    pam_env.so

# Set resource limits for the user
session   required    pam_limits.so

# Display the message of the day - Disabled by default
#session   optional    pam_motd.so

# Check user's mail - Disabled by default
#session   optional    pam_mail.so      standard quiet

# include system session and password settings
session   include     system-session
password  include     system-password

# End /etc/pam.d/login
EOF
'passwd'
cat > /etc/pam.d/passwd << "EOF"
# Begin /etc/pam.d/passwd

password  include     system-password

# End /etc/pam.d/passwd
EOF
'su'
cat > /etc/pam.d/su << "EOF"
# Begin /etc/pam.d/su

# always allow root
auth      sufficient  pam_rootok.so

# Allow users in the wheel group to execute su without a password
# disabled by default
#auth      sufficient  pam_wheel.so trust use_uid

# include system auth settings
auth      include     system-auth

# limit su to users in the wheel group
# disabled by default
#auth      required    pam_wheel.so use_uid

# include system account settings
account   include     system-account

# Set default environment variables for the service user
session   required    pam_env.so

# include system session settings
session   include     system-session

# End /etc/pam.d/su
EOF
'chpasswd' and 'newusers'
cat > /etc/pam.d/chpasswd << "EOF"
# Begin /etc/pam.d/chpasswd

# always allow root
auth      sufficient  pam_rootok.so

# include system auth and account settings
auth      include     system-auth
account   include     system-account
password  include     system-password

# End /etc/pam.d/chpasswd
EOF

sed -e s/chpasswd/newusers/ /etc/pam.d/chpasswd >/etc/pam.d/newusers
'chage'
cat > /etc/pam.d/chage << "EOF"
# Begin /etc/pam.d/chage

# always allow root
auth      sufficient  pam_rootok.so

# include system auth and account settings
auth      include     system-auth
account   include     system-account

# End /etc/pam.d/chage
EOF
Other shadow utilities
for PROGRAM in chfn chgpasswd chsh groupadd groupdel \
               groupmems groupmod useradd userdel usermod
do
    install -v -m644 /etc/pam.d/chage /etc/pam.d/${PROGRAM}
    sed -i "s/chage/$PROGRAM/" /etc/pam.d/${PROGRAM}
done

Warning

At this point, you should do a simple test to see if Shadow is working as expected. Open another terminal and log in as root, and then run login and login as another user. If you do not see any errors, then all is well and you should proceed with the rest of the configuration. If you did receive errors, stop now and double check the above configuration files manually. Any error is the sign of an error in the above procedure. You can also run the test suite from the Linux-PAM package to assist you in determining the problem. If you cannot find and fix the error, you should recompile Shadow adding the --without-libpam switch to the configure command in the above instructions (also move the /etc/login.defs.orig backup file to /etc/login.defs). If you fail to do this and the errors remain, you will be unable to log into your system.

Configuring Login Access

Instead of using the /etc/login.access file for controlling access to the system, Linux-PAM uses the pam_access.so module along with the /etc/security/access.conf file. Rename the /etc/login.access file using the following command:

if [ -f /etc/login.access ]; then mv -v /etc/login.access{,.NOUSE}; fi
Configuring Resource Limits

Instead of using the /etc/limits file for limiting usage of system resources, Linux-PAM uses the pam_limits.so module along with the /etc/security/limits.conf file. Rename the /etc/limits file using the following command:

if [ -f /etc/limits ]; then mv -v /etc/limits{,.NOUSE}; fi

Caution

Be sure to test the login capabilities of the system before logging out. Errors in the configuration can cause a permanent lockout requiring a boot from an external source to correct the problem.

Contents

A list of the installed files, along with their short descriptions can be found at ../../../../lfs/view/12.0-systemd/chapter08/shadow.html#contents-shadow.

ssh-askpass-9.4p1

Introduction to ssh-askpass

The ssh-askpass is a generic executable name for many packages, with similar names, that provide a interactive X service to grab password for packages requiring administrative privileges to be run. It prompts the user with a window box where the necessary password can be inserted. Here, we choose Damien Miller's package distributed in the OpenSSH tarball.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

ssh-askpass Dependencies

Required

GTK+-3.24.38, Sudo-1.9.14p3 (runtime), Xorg Libraries, and a graphical environment (runtime)

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/ssh-askpass

Installation of ssh-askpass

Install ssh-askpass by running the following commands:

cd contrib &&
make gnome-ssh-askpass3

Now, as the root user:

install -v -d -m755                    /usr/libexec/openssh/contrib  &&
install -v -m755    gnome-ssh-askpass3 /usr/libexec/openssh/contrib  &&
ln -sv -f contrib/gnome-ssh-askpass3   /usr/libexec/openssh/ssh-askpass

The use of /usr/libexec/openssh/contrib and a symlink is justified by the eventual necessity of a different program for that service.

Configuring ssh-askpass

Configuration Information

As the root user, configure Sudo-1.9.14p3 to use ssh-askpass:

cat >> /etc/sudo.conf << "EOF" &&
# Path to askpass helper program
Path askpass /usr/libexec/openssh/ssh-askpass
EOF
chmod -v 0644 /etc/sudo.conf

If a given graphical <application> requires administrative privileges, use sudo -A <application> from an x-terminal, from a Window Manager menu and/or replace "Exec=<application> ..." by "Exec=sudo -A <application> ..." in the <application>.desktop file.

Contents

Installed Programs: gnome-ssh-askpass3, ssh-askpass (symlink to gnome-ssh-askpass3)
Installed Library: None
Installed Directory: /usr/libexec/openssh/contrib

stunnel-5.70

Introduction to stunnel

The stunnel package contains a program that allows you to encrypt arbitrary TCP connections inside SSL (Secure Sockets Layer) so you can easily communicate with clients over secure channels. stunnel can also be used to tunnel PPP over network sockets without changes to the server package source code.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

stunnel Dependencies

Optional

libnsl-2.0.0, netcat (required for tests), tcpwrappers, and TOR

Installation of stunnel

The stunnel daemon will be run in a chroot jail by an unprivileged user. Create the new user and group using the following commands as the root user:

groupadd -g 51 stunnel &&
useradd -c "stunnel Daemon" -d /var/lib/stunnel \
        -g stunnel -s /bin/false -u 51 stunnel

Note

A signed SSL Certificate and a Private Key is necessary to run the stunnel daemon. After the package is installed, there are instructions to generate them. However, if you own or have already created a signed SSL Certificate you wish to use, copy it to /etc/stunnel/stunnel.pem before starting the build (ensure only root has read and write access). The .pem file must be formatted as shown below:

-----BEGIN PRIVATE KEY-----
<many encrypted lines of private key>
-----END PRIVATE KEY-----
-----BEGIN CERTIFICATE-----
<many encrypted lines of certificate>
-----END CERTIFICATE-----
-----BEGIN DH PARAMETERS-----
<encrypted lines of dh parms>
-----END DH PARAMETERS-----

Install stunnel by running the following commands:

./configure --prefix=/usr        \
            --sysconfdir=/etc    \
            --localstatedir=/var &&
make

If you have installed the optional netcat application, the regression tests can be run with make check.

Now, as the root user:

make docdir=/usr/share/doc/stunnel-5.70 install

Install the included systemd unit by running the following command as the root user:

install -v -m644 tools/stunnel.service /usr/lib/systemd/system

If you do not already have a signed SSL Certificate and Private Key, create the stunnel.pem file in the /etc/stunnel directory using the command below. You will be prompted to enter the necessary information. Ensure you reply to the

Common Name (FQDN of your server) [localhost]:

prompt with the name or IP address you will be using to access the service(s).

To generate a certificate, as the root user, issue:

make cert

Command Explanations

make docdir=... install: This command installs the package and changes the documentation installation directory to standard naming conventions.

Configuring stunnel

Config Files

/etc/stunnel/stunnel.conf

Configuration Information

As the root user, create the directory used for the .pid file created when the stunnel daemon starts:

install -v -m750 -o stunnel -g stunnel -d /var/lib/stunnel/run &&
chown stunnel:stunnel /var/lib/stunnel

Next, create a basic /etc/stunnel/stunnel.conf configuration file using the following commands as the root user:

cat > /etc/stunnel/stunnel.conf << "EOF"
; File: /etc/stunnel/stunnel.conf

; Note: The pid and output locations are relative to the chroot location.

pid    = /run/stunnel.pid
chroot = /var/lib/stunnel
client = no
setuid = stunnel
setgid = stunnel
cert   = /etc/stunnel/stunnel.pem

;debug = 7
;output = stunnel.log

;[https]
;accept  = 443
;connect = 80
;; "TIMEOUTclose = 0" is a workaround for a design flaw in Microsoft SSL
;; Microsoft implementations do not use SSL close-notify alert and thus
;; they are vulnerable to truncation attacks
;TIMEOUTclose = 0

EOF

Finally, add the service(s) you wish to encrypt to the configuration file. The format is as follows:

[<service>]
accept  = <hostname:portnumber>
connect = <hostname:portnumber>

For a full explanation of the commands and syntax used in the configuration file, issue man stunnel.

Systemd Unit

To start the stunnel daemon at boot, enable the previously installed systemd unit by running the following command as the root user:

systemctl enable stunnel

Contents

Installed Programs: stunnel and stunnel3
Installed Library: libstunnel.so
Installed Directories: /{etc,lib,var/lib}/stunnel and /usr/share/doc/stunnel-5.70

Short Descriptions

stunnel

is a program designed to work as an SSL encryption wrapper between remote clients and local or remote servers

stunnel3

is a Perl wrapper script to use stunnel 3.x syntax with stunnel 4.05 or later

libstunnel.so

contains the API functions required by stunnel

Sudo-1.9.14p3

Introduction to Sudo

The Sudo package allows a system administrator to give certain users (or groups of users) the ability to run some (or all) commands as root or another user while logging the commands and arguments.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Sudo Dependencies

Optional

Linux-PAM-1.5.3, MIT Kerberos V5-1.21.2, OpenLDAP-2.6.6, MTA (that provides a sendmail command), AFS, FWTK, and Opie

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/sudo

Installation of Sudo

Install Sudo by running the following commands:

./configure --prefix=/usr              \
            --libexecdir=/usr/lib      \
            --with-secure-path         \
            --with-all-insults         \
            --with-env-editor          \
            --docdir=/usr/share/doc/sudo-1.9.14p3 \
            --with-passprompt="[sudo] password for %p: " &&
make

To test the results, issue: env LC_ALL=C make check 2>&1 | tee make-check.log. Check the results with grep failed make-check.log.

Now, as the root user:

make install &&
ln -sfv libsudo_util.so.0.0.0 /usr/lib/sudo/libsudo_util.so.0

Command Explanations

--libexecdir=/usr/lib: This switch controls where private programs are installed. Everything in that directory is a library, so they belong under /usr/lib instead of /usr/libexec.

--with-secure-path: This switch transparently adds /sbin and /usr/sbin directories to the PATH environment variable.

--with-all-insults: This switch includes all the sudo insult sets.

--with-env-editor: This switch enables use of the environment variable EDITOR for visudo.

--with-passprompt: This switch sets the password prompt. The %p will be expanded to the name of the user whose password is being requested.

--without-pam: This switch avoids building Linux-PAM support when Linux-PAM is installed on the system.

Note

There are many options to sudo's configure command. Check the configure --help output for a complete list.

ln -sfv libsudo_util...: Works around a bug in the installation process, which links to the previously installed version (if there is one) instead of the new one.

Configuring Sudo

Config File

/etc/sudoers

Configuration Information

The sudoers file can be quite complicated. It is composed of two types of entries: aliases (basically variables) and user specifications (which specify who may run what). The installation installs a default configuration that has no privileges installed for any user.

A couple of common configuration changes are to set the path for the super user and to allow members of the wheel group to execute all commands after providing their own credentials. Use the following commands to create the /etc/sudoers.d/00-sudo configuration file as the root user:

cat > /etc/sudoers.d/00-sudo << "EOF"
Defaults secure_path="/usr/sbin:/usr/bin"
%wheel ALL=(ALL) ALL
EOF

Note

In very simple installations where there is only one user, it may be easier to just edit the /etc/sudoers file directly. In that case, the secure_path entry may not be needed and using sudo -E ... can import the non-privileged user's full environment into the privileged session.

The files in the /etc/sudoers.d directory are parsed in sorted lexical order. Be careful that entries in an added file do not overwrite previous entries.

For details, see man sudoers.

Note

The Sudo developers highly recommend using the visudo program to edit the sudoers file. This will provide basic sanity checking like syntax parsing and file permission to avoid some possible mistakes that could lead to a vulnerable configuration.

If PAM is installed on the system, Sudo is built with PAM support. In that case, issue the following command as the root user to create the PAM configuration file:

cat > /etc/pam.d/sudo << "EOF"
# Begin /etc/pam.d/sudo

# include the default auth settings
auth      include     system-auth

# include the default account settings
account   include     system-account

# Set default environment variables for the service user
session   required    pam_env.so

# include system session defaults
session   include     system-session

# End /etc/pam.d/sudo
EOF
chmod 644 /etc/pam.d/sudo

Contents

Installed Programs: cvtsudoers, sudo, sudo_logsrvd, sudo_sendlog, sudoedit (symlink), sudoreplay, and visudo
Installed Libraries: audit_json.so, group_file.so, libsudo_util.so, sample_approval.so, sudoers.so, sudo_noexec.so, and system_group.so
Installed Directories: /etc/sudoers.d, /usr/lib/sudo, /usr/share/doc/sudo-1.9.14p3, and /var/lib/sudo

Short Descriptions

cvtsudoers

converts between sudoers file formats

sudo

executes a command as another user as permitted by the /etc/sudoers configuration file

sudo_logsrvd

is a sudo event and I/O log server

sudo_sendlog

sends sudo I/O logs to the log server

sudoedit

is a symlink to sudo that implies the -e option to invoke an editor as another user

sudoreplay

is used to play back or list the output logs created by sudo

visudo

allows for safer editing of the sudoers file

Tripwire-2.4.3.7

Introduction to Tripwire

The Tripwire package contains programs used to verify the integrity of the files on a given system.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Tripwire Dependencies

Optional

An MTA

Installation of Tripwire

Compile Tripwire by running the following commands:

sed -e '/^CLOBBER/s/false/true/'         \
    -e 's|TWDB="${prefix}|TWDB="/var|'   \
    -e '/TWMAN/ s|${prefix}|/usr/share|' \
    -e '/TWDOCS/s|${prefix}/doc/tripwire|/usr/share/doc/tripwire-2.4.3.7|' \
    -i installer/install.cfg                               &&

find . -name Makefile.am | xargs                           \
    sed -i 's/^[[:alpha:]_]*_HEADERS.*=/noinst_HEADERS =/' &&

sed '/dist/d' -i man/man?/Makefile.am                      &&
autoreconf -fi                                             &&

./configure --prefix=/usr --sysconfdir=/etc/tripwire       &&
make CPPFLAGS=-std=c++11

Note

The default configuration is to use a local MTA. If you don't have an MTA installed and have no wish to install one, modify install/install.cfg to use an SMTP server instead. Otherwise the install will fail.

This package does not come with a test suite.

Now, as the root user:

make install &&
cp -v policy/*.txt /usr/share/doc/tripwire-2.4.3.7

Note

During make install, several questions are asked, including passwords. If you want to make a script, you have to apply a sed before running make install:

sed -i -e 's@installer/install.sh@& -n -s <site-password> -l <local-password>@' Makefile

Of course, you should do this with dummy passwords and change them later.

Another issue when scripting is that the installer exits when the standard input is not a terminal. You may disable this behavior with the following sed:

sed '/-t 0/,+3d' -i installer/install.sh

Command Explanations

sed ... installer/install.cfg: This command tells the package to install the program database and reports in /var/lib/tripwire and sets the proper location for man pages and documentation.

find ..., sed ..., and autoreconf -fi: The build system is unusable as is, and has to be modified for the build to succeed.

CPPFLAGS=-std=c++11: Setting the C++ preprocessor flags to version 11 is necessary to prevent a conflict with the default version which is c++17 in recent version of gcc.

make install: This command creates the Tripwire security keys as well as installing the binaries. There are two keys: a site key and a local key which are stored in /etc/tripwire/.

cp -v policy/*.txt /usr/doc/tripwire-2.4.3.7: This command installs the tripwire sample policy files with the other tripwire documentation.i

Configuring Tripwire

Config Files

/etc/tripwire/*

Configuration Information

Tripwire uses a policy file to determine which files are integrity checked. The default policy file (/etc/tripwire/twpol.txt) is for a default installation and will need to be updated for your system.

Policy files should be tailored to each individual distribution and/or installation. Some example policy files can be found in /usr/share/doc/tripwire/.

If desired, copy the policy file you'd like to try into /etc/tripwire/ instead of using the default policy file, twpol.txt. It is, however, recommended that you edit your policy file. Get ideas from the examples above and read /usr/share/doc/tripwire/policyguide.txt for additional information. twpol.txt is a good policy file for learning about Tripwire as it will note any changes to the file system and can even be used as an annoying way of keeping track of changes for uninstallation of software.

After your policy file has been edited to your satisfaction you may begin the configuration steps (perform as the root) user:

twadmin --create-polfile --site-keyfile /etc/tripwire/site.key \
    /etc/tripwire/twpol.txt &&
tripwire --init

Depending on your system and the contents of the policy file, the initialization phase above can take a relatively long time.

Usage Information

Tripwire will identify file changes in the critical system files specified in the policy file. Using Tripwire while making frequent changes to these directories will flag all these changes. It is most useful after a system has reached a configuration that the user considers stable.

To use Tripwire after creating a policy file to run a report, use the following command:

tripwire --check > /etc/tripwire/report.txt

View the output to check the integrity of your files. An automatic integrity report can be produced by using a cron facility to schedule the runs.

Reports are stored in binary and, if desired, encrypted. View reports, as the root user, with:

twprint --print-report -r /var/lib/tripwire/report/<report-name.twr>

After you run an integrity check, you should examine the report (or email) and then modify the Tripwire database to reflect the changed files on your system. This is so that Tripwire will not continually notify you hat files you intentionally changed are a security violation. To do this you must first ls -l /var/lib/tripwire/report/ and note the name of the newest file which starts with your system name as presented by the command uname -n and ends in .twr. These files were created during report creation and the most current one is needed to update the Tripwire database of your system. As the root user, type in the following command making the appropriate report name:

tripwire --update --twrfile /var/lib/tripwire/report/<report-name.twr>

You will be placed into Vim with a copy of the report in front of you. If all the changes were good, then just type :wq and after entering your local key, the database will be updated. If there are files which you still want to be warned about, remove the 'x' before the filename in the report and type :wq.

Changing the Policy File

If you are unhappy with your policy file and would like to modify it or use a new one, modify the policy file and then execute the following commands as the root user:

twadmin --create-polfile /etc/tripwire/twpol.txt &&
tripwire --init

Contents

Installed Programs: siggen, tripwire, twadmin, and twprint
Installed Libraries: None
Installed Directories: /etc/tripwire, /var/lib/tripwire, and /usr/share/doc/tripwire-2.4.3.7

Short Descriptions

siggen

is a signature gathering utility that displays the hash function values for the specified files

tripwire

is the main file integrity checking program

twadmin

administrative and utility tool used to perform certain administrative functions related to Tripwire files and configuration options

twprint

prints Tripwire database and report files in clear text format

volume_key-0.3.12

Introduction to volume_key

The volume_key package provides a library for manipulating storage volume encryption keys and storing them separately from volumes to handle forgotten passphrases.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

volume_key Dependencies

Required

cryptsetup-2.4.3, GLib-2.76.4, GnuPG-2.4.3, GPGME-1.21.0, and nss-3.92

Recommended

Installation of volume_key

Note

This package expands to the directory volume_key-volume_key-0.3.12.

Tell the building system how to locate GPGME and GnuPG correctly:

sed -e '/AM_PATH_GPGME/iAM_PATH_GPG_ERROR' \
    -e 's/gpg2/gpg/' -i configure.ac

Install volume_key by running the following commands:

autoreconf -fiv              &&
./configure --prefix=/usr    \
            --without-python &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--without-python: This parameter prevents building the Python 2 bindings, if Python-2.7.18 is installed.

--without-python3: Use this option if you do not want to build the Python 3 bindings. In this case, SWIG-4.1.1 is not needed.

Contents

Installed Program: volume_key
Installed Library: libvolume_key.so
Installed Directory: /usr/include/volume_key

Short Descriptions

volume_key

manages encrypted volume keys and passphrases

volume_key.so

contains API functions for managing encrypted volume keys

Chapter 5. File Systems and Disk Management

Journaling file systems reduce the time needed to recover a file system that was not unmounted properly. While this can be extremely important in reducing downtime for servers, it has also become popular for desktop environments. This chapter contains other journaling file systems you can use instead of the default LFS extended file system (ext2/3/4). It also provides introductory material on managing disk arrays.

About initramfs

The only purpose of an initramfs is to mount the root filesystem. The initramfs is a complete set of directories that you would find on a normal root filesystem. It is bundled into a single cpio archive and compressed with one of several compression algorithms.

At boot time, the boot loader loads the kernel and the initramfs image into memory and starts the kernel. The kernel checks for the presence of the initramfs and, if found, mounts it as / and runs /init. The init program is typically a shell script. Note that the boot process takes longer, possibly significantly longer, if an initramfs is used.

For most distributions, kernel modules are the biggest reason to have an initramfs. In a general distribution, there are many unknowns such as file system types and disk layouts. In a way, this is the opposite of LFS where the system capabilities and layout are known and a custom kernel is normally built. In this situation, an initramfs is rarely needed.

There are only four primary reasons to have an initramfs in the LFS environment: loading the rootfs from a network, loading it from an LVM logical volume, having an encrypted rootfs where a password is required, or for the convenience of specifying the rootfs as a LABEL or UUID. Anything else usually means that the kernel was not configured properly.

Building an initramfs

If you do decide to build an initramfs, the following scripts will provide a basis to do it. The scripts will allow specifying a rootfs via partition UUID or partition LABEL or a rootfs on an LVM logical volume. They do not support an encrypted root file system or mounting the rootfs over a network card. For a more complete capability see the LFS Hints or dracut.

To install these scripts, run the following commands as the root user:

cat > /usr/sbin/mkinitramfs << "EOF"
#!/bin/bash
# This file based in part on the mkinitramfs script for the LFS LiveCD
# written by Alexander E. Patrakov and Jeremy Huntwork.

copy()
{
  local file

  if [ "$2" = "lib" ]; then
    file=$(PATH=/usr/lib type -p $1)
  else
    file=$(type -p $1)
  fi

  if [ -n "$file" ] ; then
    cp $file $WDIR/usr/$2
  else
    echo "Missing required file: $1 for directory $2"
    rm -rf $WDIR
    exit 1
  fi
}

if [ -z $1 ] ; then
  INITRAMFS_FILE=initrd.img-no-kmods
else
  KERNEL_VERSION=$1
  INITRAMFS_FILE=initrd.img-$KERNEL_VERSION
fi

if [ -n "$KERNEL_VERSION" ] && [ ! -d "/usr/lib/modules/$1" ] ; then
  echo "No modules directory named $1"
  exit 1
fi

printf "Creating $INITRAMFS_FILE... "

binfiles="sh cat cp dd killall ls mkdir mknod mount "
binfiles="$binfiles umount sed sleep ln rm uname"
binfiles="$binfiles readlink basename"

# Systemd installs udevadm in /bin. Other udev implementations have it in /sbin
if [ -x /usr/bin/udevadm ] ; then binfiles="$binfiles udevadm"; fi

sbinfiles="modprobe blkid switch_root"

# Optional files and locations
for f in mdadm mdmon udevd udevadm; do
  if [ -x /usr/sbin/$f ] ; then sbinfiles="$sbinfiles $f"; fi
done

# Add lvm if present (cannot be done with the others because it
# also needs dmsetup
if [ -x /usr/sbin/lvm ] ; then sbinfiles="$sbinfiles lvm dmsetup"; fi

unsorted=$(mktemp /tmp/unsorted.XXXXXXXXXX)

DATADIR=/usr/share/mkinitramfs
INITIN=init.in

# Create a temporary working directory
WDIR=$(mktemp -d /tmp/initrd-work.XXXXXXXXXX)

# Create base directory structure
mkdir -p $WDIR/{dev,run,sys,proc,usr/{bin,lib/{firmware,modules},sbin}}
mkdir -p $WDIR/etc/{modprobe.d,udev/rules.d}
touch $WDIR/etc/modprobe.d/modprobe.conf
ln -s usr/bin  $WDIR/bin
ln -s usr/lib  $WDIR/lib
ln -s usr/sbin $WDIR/sbin
ln -s lib      $WDIR/lib64

# Create necessary device nodes
mknod -m 640 $WDIR/dev/console c 5 1
mknod -m 664 $WDIR/dev/null    c 1 3

# Install the udev configuration files
if [ -f /etc/udev/udev.conf ]; then
  cp /etc/udev/udev.conf $WDIR/etc/udev/udev.conf
fi

for file in $(find /etc/udev/rules.d/ -type f) ; do
  cp $file $WDIR/etc/udev/rules.d
done

# Install any firmware present
cp -a /usr/lib/firmware $WDIR/usr/lib

# Copy the RAID configuration file if present
if [ -f /etc/mdadm.conf ] ; then
  cp /etc/mdadm.conf $WDIR/etc
fi

# Install the init file
install -m0755 $DATADIR/$INITIN $WDIR/init

if [  -n "$KERNEL_VERSION" ] ; then
  if [ -x /usr/bin/kmod ] ; then
    binfiles="$binfiles kmod"
  else
    binfiles="$binfiles lsmod"
    sbinfiles="$sbinfiles insmod"
  fi
fi

# Install basic binaries
for f in $binfiles ; do
  ldd /usr/bin/$f | sed "s/\t//" | cut -d " " -f1 >> $unsorted
  copy /usr/bin/$f bin
done

for f in $sbinfiles ; do
  ldd /usr/sbin/$f | sed "s/\t//" | cut -d " " -f1 >> $unsorted
  copy $f sbin
done

# Add udevd libraries if not in /usr/sbin
if [ -x /usr/lib/udev/udevd ] ; then
  ldd /usr/lib/udev/udevd | sed "s/\t//" | cut -d " " -f1 >> $unsorted
elif [ -x /usr/lib/systemd/systemd-udevd ] ; then
  ldd /usr/lib/systemd/systemd-udevd | sed "s/\t//" | cut -d " " -f1 >> $unsorted
fi

# Add module symlinks if appropriate
if [ -n "$KERNEL_VERSION" ] && [ -x /usr/bin/kmod ] ; then
  ln -s kmod $WDIR/usr/bin/lsmod
  ln -s kmod $WDIR/usr/bin/insmod
fi

# Add lvm symlinks if appropriate
# Also copy the lvm.conf file
if  [ -x /usr/sbin/lvm ] ; then
  ln -s lvm $WDIR/usr/sbin/lvchange
  ln -s lvm $WDIR/usr/sbin/lvrename
  ln -s lvm $WDIR/usr/sbin/lvextend
  ln -s lvm $WDIR/usr/sbin/lvcreate
  ln -s lvm $WDIR/usr/sbin/lvdisplay
  ln -s lvm $WDIR/usr/sbin/lvscan

  ln -s lvm $WDIR/usr/sbin/pvchange
  ln -s lvm $WDIR/usr/sbin/pvck
  ln -s lvm $WDIR/usr/sbin/pvcreate
  ln -s lvm $WDIR/usr/sbin/pvdisplay
  ln -s lvm $WDIR/usr/sbin/pvscan

  ln -s lvm $WDIR/usr/sbin/vgchange
  ln -s lvm $WDIR/usr/sbin/vgcreate
  ln -s lvm $WDIR/usr/sbin/vgscan
  ln -s lvm $WDIR/usr/sbin/vgrename
  ln -s lvm $WDIR/usr/sbin/vgck
  # Conf file(s)
  cp -a /etc/lvm $WDIR/etc
fi

# Install libraries
sort $unsorted | uniq | while read library ; do
# linux-vdso and linux-gate are pseudo libraries and do not correspond to a file
# libsystemd-shared is in /lib/systemd, so it is not found by copy, and
# it is copied below anyway
  if [[ "$library" == linux-vdso.so.1 ]] ||
     [[ "$library" == linux-gate.so.1 ]] ||
     [[ "$library" == libsystemd-shared* ]]; then
    continue
  fi

  copy $library lib
done

if [ -d /usr/lib/udev ]; then
  cp -a /usr/lib/udev $WDIR/usr/lib
fi
if [ -d /usr/lib/systemd ]; then
  cp -a /usr/lib/systemd $WDIR/usr/lib
fi
if [ -d /usr/lib/elogind ]; then
  cp -a /usr/lib/elogind $WDIR/usr/lib
fi

# Install the kernel modules if requested
if [ -n "$KERNEL_VERSION" ]; then
  find \
     /usr/lib/modules/$KERNEL_VERSION/kernel/{crypto,fs,lib}                      \
     /usr/lib/modules/$KERNEL_VERSION/kernel/drivers/{block,ata,nvme,md,firewire} \
     /usr/lib/modules/$KERNEL_VERSION/kernel/drivers/{scsi,message,pcmcia,virtio} \
     /usr/lib/modules/$KERNEL_VERSION/kernel/drivers/usb/{host,storage}           \
     -type f 2> /dev/null | cpio --make-directories -p --quiet $WDIR

  cp /usr/lib/modules/$KERNEL_VERSION/modules.{builtin,order} \
            $WDIR/usr/lib/modules/$KERNEL_VERSION
  if [ -f /usr/lib/modules/$KERNEL_VERSION/modules.builtin.modinfo ]; then
    cp /usr/lib/modules/$KERNEL_VERSION/modules.builtin.modinfo \
            $WDIR/usr/lib/modules/$KERNEL_VERSION
  fi

  depmod -b $WDIR $KERNEL_VERSION
fi

( cd $WDIR ; find . | cpio -o -H newc --quiet | gzip -9 ) > $INITRAMFS_FILE

# Prepare early loading of microcode if available
if ls /usr/lib/firmware/intel-ucode/* >/dev/null 2>&1 ||
   ls /usr/lib/firmware/amd-ucode/*   >/dev/null 2>&1; then

# first empty WDIR to reuse it
  rm -r $WDIR/*

  DSTDIR=$WDIR/kernel/x86/microcode
  mkdir -p $DSTDIR

  if [ -d /usr/lib/firmware/amd-ucode ]; then
    cat /usr/lib/firmware/amd-ucode/microcode_amd*.bin > $DSTDIR/AuthenticAMD.bin
  fi

  if [ -d /usr/lib/firmware/intel-ucode ]; then
    cat /usr/lib/firmware/intel-ucode/* > $DSTDIR/GenuineIntel.bin
  fi

  ( cd $WDIR; find . | cpio -o -H newc --quiet ) > microcode.img
  cat microcode.img $INITRAMFS_FILE > tmpfile
  mv tmpfile $INITRAMFS_FILE
  rm microcode.img
fi

# Remove the temporary directories and files
rm -rf $WDIR $unsorted
printf "done.\n"

EOF

chmod 0755 /usr/sbin/mkinitramfs
mkdir -p /usr/share/mkinitramfs &&
cat > /usr/share/mkinitramfs/init.in << "EOF"
#!/bin/sh

PATH=/usr/bin:/usr/sbin
export PATH

problem()
{
   printf "Encountered a problem!\n\nDropping you to a shell.\n\n"
   sh
}

no_device()
{
   printf "The device %s, which is supposed to contain the\n" $1
   printf "root file system, does not exist.\n"
   printf "Please fix this problem and exit this shell.\n\n"
}

no_mount()
{
   printf "Could not mount device %s\n" $1
   printf "Sleeping forever. Please reboot and fix the kernel command line.\n\n"
   printf "Maybe the device is formatted with an unsupported file system?\n\n"
   printf "Or maybe filesystem type autodetection went wrong, in which case\n"
   printf "you should add the rootfstype=... parameter to the kernel command line.\n\n"
   printf "Available partitions:\n"
}

do_mount_root()
{
   mkdir /.root
   [ -n "$rootflags" ] && rootflags="$rootflags,"
   rootflags="$rootflags$ro"

   case "$root" in
      /dev/*    ) device=$root ;;
      UUID=*    ) eval $root; device="/dev/disk/by-uuid/$UUID" ;;
      PARTUUID=*) eval $root; device="/dev/disk/by-partuuid/$PARTUUID" ;;
      LABEL=*   ) eval $root; device="/dev/disk/by-label/$LABEL" ;;
      ""        ) echo "No root device specified." ; problem ;;
   esac

   while [ ! -b "$device" ] ; do
       no_device $device
       problem
   done

   if ! mount -n -t "$rootfstype" -o "$rootflags" "$device" /.root ; then
       no_mount $device
       cat /proc/partitions
       while true ; do sleep 10000 ; done
   else
       echo "Successfully mounted device $root"
   fi
}

do_try_resume()
{
   case "$resume" in
      UUID=* ) eval $resume; resume="/dev/disk/by-uuid/$UUID"  ;;
      LABEL=*) eval $resume; resume="/dev/disk/by-label/$LABEL" ;;
   esac

   if $noresume || ! [ -b "$resume" ]; then return; fi

   ls -lH "$resume" | ( read x x x x maj min x
       echo -n ${maj%,}:$min > /sys/power/resume )
}

init=/sbin/init
root=
rootdelay=
rootfstype=auto
ro="ro"
rootflags=
device=
resume=
noresume=false

mount -n -t devtmpfs devtmpfs /dev
mount -n -t proc     proc     /proc
mount -n -t sysfs    sysfs    /sys
mount -n -t tmpfs    tmpfs    /run

read -r cmdline < /proc/cmdline

for param in $cmdline ; do
  case $param in
    init=*      ) init=${param#init=}             ;;
    root=*      ) root=${param#root=}             ;;
    rootdelay=* ) rootdelay=${param#rootdelay=}   ;;
    rootfstype=*) rootfstype=${param#rootfstype=} ;;
    rootflags=* ) rootflags=${param#rootflags=}   ;;
    resume=*    ) resume=${param#resume=}         ;;
    noresume    ) noresume=true                   ;;
    ro          ) ro="ro"                         ;;
    rw          ) ro="rw"                         ;;
  esac
done

# udevd location depends on version
if [ -x /sbin/udevd ]; then
  UDEVD=/sbin/udevd
elif [ -x /lib/udev/udevd ]; then
  UDEVD=/lib/udev/udevd
elif [ -x /lib/systemd/systemd-udevd ]; then
  UDEVD=/lib/systemd/systemd-udevd
else
  echo "Cannot find udevd nor systemd-udevd"
  problem
fi

${UDEVD} --daemon --resolve-names=never
udevadm trigger
udevadm settle

if [ -f /etc/mdadm.conf ] ; then mdadm -As                       ; fi
if [ -x /sbin/vgchange  ] ; then /sbin/vgchange -a y > /dev/null ; fi
if [ -n "$rootdelay"    ] ; then sleep "$rootdelay"              ; fi

do_try_resume # This function will not return if resuming from disk
do_mount_root

killall -w ${UDEVD##*/}

exec switch_root /.root "$init" "$@"

EOF

Using an initramfs

Required Runtime Dependency

cpio-2.14

Other Runtime Dependencies

LVM2-2.03.22 and/or mdadm-4.2 must be installed before generating the initramfs, if the system partition uses them.

To build an initramfs, run the following as the root user:

mkinitramfs [KERNEL VERSION]

The optional argument is the directory where the appropriate kernel modules are located. This must be a subdirectory of /lib/modules. If no modules are specified, then the initramfs is named initrd.img-no-kmods. If a kernel version is specified, the initrd is named initrd.img-$KERNEL_VERSION and is only appropriate for the specific kernel specified. The output file will be placed in the current directory.

If early loading of microcode is needed (see the section called “Microcode updates for CPUs”), you can install the appropriate blob or container in /lib/firmware. It will be automatically added to the initrd when running mkinitramfs.

After generating the initrd, copy it to the /boot directory.

Now edit /boot/grub/grub.cfg and add a new menuentry. Below are several examples.

# Generic initramfs and root fs identified by UUID
menuentry "LFS Dev (LFS-7.0-Feb14) initrd, Linux 3.0.4"
{
  linux  /vmlinuz-3.0.4-lfs-20120214 root=UUID=54b934a9-302d-415e-ac11-4988408eb0a8 ro
  initrd /initrd.img-no-kmods
}
# Generic initramfs and root fs on LVM partition
menuentry "LFS Dev (LFS-7.0-Feb18) initrd lvm, Linux 3.0.4"
{
  linux  /vmlinuz-3.0.4-lfs-20120218 root=/dev/mapper/myroot ro
  initrd /initrd.img-no-kmods
}
# Specific initramfs and root fs identified by LABEL
menuentry "LFS Dev (LFS-7.1-Feb20) initrd label, Linux 3.2.6"
{
  linux  /vmlinuz-3.2.6-lfs71-120220 root=LABEL=lfs71 ro
  initrd /initrd.img-3.2.6-lfs71-120220
}

Finally, reboot the system and select the desired system.

btrfs-progs-6.3.3

Introduction to btrfs-progs

The btrfs-progs package contains administration and debugging tools for the B-tree file system (btrfs).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Btrfs-progs Dependencies

Required

LZO-2.10

Optional

LVM2-2.03.22 (dmsetup is used in tests), reiserfsprogs-3.6.27 (for tests), and sphinx-7.1.2 (required to build documentation)

Kernel Configuration

Enable the following option in the kernel configuration and recompile the kernel:

File systems --->
  <*/M> Btrfs filesystem support                                      [BTRFS_FS]

In addition to the above and to the options required for LVM2-2.03.22 and reiserfsprogs-3.6.27, the following options must be enabled for running tests:

File systems --->
  <*/M> Reiserfs support (deprecated)                              [REISERFS_FS]
  [*]     ReiserFS extended attributes                       [REISERFS_FS_XATTR]
  [*]       ReiserFS POSIX Access Control Lists          [REISERFS_FS_POSIX_ACL]
  <*/M> Btrfs filesystem support                                      [BTRFS_FS]
  [*]     Btrfs POSIX Access Control Lists                  [BTRFS_FS_POSIX_ACL]

Installation of btrfs-progs

Install btrfs-progs by running the following commands:

./configure --prefix=/usr           \
            --disable-static        \
            --disable-documentation &&
make

Note

Some tests require grep built with perl regular expressions. To obtain this, rebuild grep with the LFS Chapter 8 instructions after installing pcre2-10.42.

Before running tests, build a support program:

make fssum

To test the results, issue (as the root user):

pushd tests
   ./fsck-tests.sh
   ./mkfs-tests.sh
   ./cli-tests.sh
   sed 's/,orphan_file//' /etc/mke2fs.conf >./custom_mke2fs.conf &&
   export MKE2FS_CONFIG=$PWD/custom_mke2fs.conf                  &&
   ./convert-tests.sh
   unset MKE2FS_CONFIG && rm custom_mke2fs.conf
   ./misc-tests.sh
   ./fuzz-tests.sh
popd

Note

If the above mentioned kernel options are not enabled, some tests fail, and prevent all the remaining tests from running because the test disk image is not cleanly unmounted.

Install the package as the root user:

make install

If you have passed --disable-documentation to configure and you need the manual pages, install them by running, as the root user:

for i in 5 8; do
   install Documentation/*.$i /usr/share/man/man$i
done

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--disable-documentation: This switch disables rebuilding the manual pages, because it requires sphinx-7.1.2.

sed 's/,orphan_file//" ...: In this version of btrfs-progs, the btrfs-convert program produces a btrfs filesystem containing errors if converting from an ext4 filesystem created with the orphan_file feature. This command creates a custom configuration file that prevents creating a filesystem with this feature.

Using the btrfs-convert Program

This version of btrfs-progs does not convert correctly ext4 filesystems to btrfs if the ext4 orphan_file feature is turned on. If you happen to convert such a filesystem, you need to first run:

tune2fs -O ^orphan_file /dev/sdxx

where /dev/sdxx is the partition of the filesystem you want to convert.

Contents

Installed Programs: btrfs, btrfs-convert, btrfs-find-root, btrfs-image, btrfs-map-logical, btrfs-select-super, btrfsck (link to btrfs), btrfstune, fsck.btrfs, and mkfs.btrfs
Installed Libraries: libbtrfs.so and libbtrfsutil.so
Installed Directories: /usr/include/btrfs

Short Descriptions

btrfs

is the main interface into btrfs filesystem operations

btrfs-convert

converts from an ext2/3/4 or reiserfs filesystem to btrfs (see the section called “Using the btrfs-convert Program” above)

btrfs-find-root

is a filter to find btrfs root

btrfs-map-logical

maps btrfs logical extent to physical extent

btrfs-select-super

overwrites the primary superblock with a backup copy

btrfstune

tunes various filesystem parameters

fsck.btrfs

does nothing, but is present for consistency with fstab

mkfs.btrfs

creates a btrfs file system

dosfstools-4.2

Introduction to dosfstools

The dosfstools package contains various utilities for use with the FAT family of file systems.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Kernel Configuration

Enable the following option in the kernel configuration and recompile the kernel if you need to mount a FAT-family filesystem:

File systems --->
  DOS/FAT/EXFAT/NT Filesystems --->
    < /*/M> MSDOS fs support                                          [MSDOS_FS]
    <*/M>   VFAT (Windows-95) fs support                               [VFAT_FS]

Note that CONFIG_MSDOS_FS deliberately unsupport long file names. CONFIG_VFAT_FS should be used instead unless you really want to enforce the DOS-style 8.3 file names.

You can mount a FAT-family filesystem once the kernel supports it. If you don't need to create, check, or relabel a FAT-family system, you may skip this package.

Installation of dosfstools

Install dosfstools by running the following commands:

./configure --prefix=/usr            \
            --enable-compat-symlinks \
            --mandir=/usr/share/man  \
            --docdir=/usr/share/doc/dosfstools-4.2 &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--enable-compat-symlinks: This switch creates the dosfsck, dosfslabel, fsck.msdos, fsck.vfat, mkdosfs, mkfs.msdos, and mkfs.vfat symlinks required by some programs.

Contents

Installed Programs: fatlabel, fsck.fat, and mkfs.fat

Short Descriptions

fatlabel

sets or gets a MS-DOS filesystem label from a given device

fsck.fat

checks and repairs MS-DOS filesystems

mkfs.fat

creates an MS-DOS filesystem under Linux

Fuse-3.16.1

Introduction to Fuse

FUSE (Filesystem in Userspace) is a simple interface for userspace programs to export a virtual filesystem to the Linux kernel. Fuse also aims to provide a secure method for non privileged users to create and mount their own filesystem implementations.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Fuse Dependencies

Optional

Doxygen-1.9.7 (to rebuild the API documentation), pytest-7.4.0 (required for tests), and looseversion (for tests)

Kernel Configuration

Enable the following options in the kernel configuration and recompile the kernel if necessary:

File systems --->
  <*/M> FUSE (Filesystem in Userspace) support                         [FUSE_FS]

Character devices in userspace should be enabled too for running the tests:

File systems --->
  <*/M> FUSE (Filesystem in Userspace) support                         [FUSE_FS]
  <*/M>   Character device in Userspace support                           [CUSE]

Installation of Fuse

Install Fuse by running the following commands:

sed -i '/^udev/,$ s/^/#/' util/meson.build &&

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

The API documentation is included in the package, but if you have Doxygen-1.9.7 installed and wish to rebuild it, issue:

pushd .. &&
  doxygen doc/Doxyfile &&
popd

To test the results, issue the following commands (as the root user):

python3 -m venv --system-site-packages testenv &&
source testenv/bin/activate                    &&
pip3 install looseversion                      &&
python3 -m pytest                              &&
deactivate

The pytest-7.4.0 Python module is required for the tests. One test named test_cuse will fail if the CONFIG_CUSE configuration item was not enabled when the kernel was built. One test, test/util.py, will output a warning due to the usage of an unknown mark in pytest. One test named test_notify_inval_entry[True-expire_entries] may fail under certain circumstances.

Now, as the root user:

ninja install                  &&
chmod u+s /usr/bin/fusermount3 &&

cd ..                          &&
cp -Rv doc/html -T /usr/share/doc/fuse-3.16.1 &&
install -v -m644   doc/{README.NFS,kernel.txt} \
                   /usr/share/doc/fuse-3.16.1

Command Explanations

sed ... util/meson.build: This command disables the installation of a boot script and udev rule that are not needed.

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Configuring fuse

Config Files

Some options regarding mount policy can be set in the file /etc/fuse.conf. To install the file run the following command as the root user:

cat > /etc/fuse.conf << "EOF"
# Set the maximum number of FUSE mounts allowed to non-root users.
# The default is 1000.
#
#mount_max = 1000

# Allow non-root users to specify the 'allow_other' or 'allow_root'
# mount options.
#
#user_allow_other
EOF

Additional information about the meaning of the configuration options are found in the man page.

Contents

Installed Programs: fusermount3 and mount.fuse3
Installed Libraries: libfuse3.so
Installed Directory: /usr/include/fuse3 and /usr/share/doc/fuse-3.16.1

Short Descriptions

fusermount3

is a suid root program to mount and unmount Fuse filesystems

mount.fuse3

is the command mount calls to mount a Fuse filesystem

libfuse3.so

contains the FUSE API functions

jfsutils-1.1.15

Introduction to jfsutils

The jfsutils package contains administration and debugging tools for the jfs file system.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Kernel Configuration

Enable the following option in the kernel configuration and recompile the kernel:

File systems --->
  <*/M> JFS filesystem support                                          [JFS_FS]

Installation of jfsutils

First, fix some issues exposed by GCC 10 and later:

patch -Np1 -i ../jfsutils-1.1.15-gcc10_fix-1.patch

Install jfsutils by running the following commands:

sed -i "/unistd.h/a#include <sys/types.h>"    fscklog/extract.c &&
sed -i "/ioctl.h/a#include <sys/sysmacros.h>" libfs/devices.c   &&

./configure &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

sed ...: Fixes building with glibc 2.28.

Contents

Installed Programs: fsck.jfs, jfs_debugfs, jfs_fsck, jfs_fscklog, jfs_logdump, jfs_mkfs, jfs_tune, mkfs.jfs
Installed Libraries: None
Installed Directories: None

Short Descriptions

fsck.jfs

is used to replay the JFS transaction log, check a JFS formatted device for errors, and fix any errors found

jfs_fsck

is a hard link to fsck.jfs

mkfs.jfs

constructs an JFS file system

jfs_mkfs

is a hard link to mkfs.jfs

jfs_debugfs

is a program which can be used to perform various low-level actions on a JFS formatted device

jfs_fscklog

extracts a JFS fsck service log into a file and/or formats and displays the extracted file

jfs_logdump

dumps the contents of the journal log from the specified JFS formatted device into output file ./jfslog.dmp

jfs_tune

adjusts tunable file system parameters on JFS file systems

LVM2-2.03.22

Introduction to LVM2

The LVM2 package is a set of tools that manage logical partitions. It allows spanning of file systems across multiple physical disks and disk partitions and provides for dynamic growing or shrinking of logical partitions, mirroring and low storage footprint snapshots.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://sourceware.org/ftp/lvm2/LVM2.2.03.22.tgz

  • Download (FTP): ftp://sourceware.org/pub/lvm2/LVM2.2.03.22.tgz

  • Download MD5 sum: a97cf533222a5760225dbd26c3982ca6

  • Download size: 2.6 MB

  • Estimated disk space required: 38 MB (add 20 MB for tests; transient files can grow up to around 300 MB in the /tmp directory during tests)

  • Estimated build time: 0.1 SBU (using parallelism=4; add 9 to 48 SBU for tests, depending on disk speed and whether ram block device is enabled in the kernel)

LVM2 Dependencies

Required

libaio-0.3.113

Optional

mdadm-4.2, reiserfsprogs-3.6.27, Valgrind-3.21.0, Which-2.21, xfsprogs-6.4.0 (all five may be used, but are not required, for tests), thin-provisioning-tools, and vdo

Kernel Configuration

Enable the following options in the kernel configuration and recompile the kernel:

Note

There are several other Device Mapper options in the kernel beyond those listed below. In order to get reasonable results if running the regression tests, all must be enabled either internally or as a module. The tests will all time out if Magic SysRq key is not enabled.

Device Drivers --->
  [*] Block devices --->                                               [BLK_DEV]
    <*/M> RAM block device support                                 [BLK_DEV_RAM]
  [*] Multiple devices driver support (RAID and LVM) --->                   [MD]
    <*/M> Device mapper support                                     [BLK_DEV_DM]
    <*/M>   Crypt target support                                      [DM_CRYPT]
    <*/M>   Snapshot target                                        [DM_SNAPSHOT]
    <*/M>   Thin provisioning target                      [DM_THIN_PROVISIONING]
    <*/M>   Cache target (EXPERIMENTAL)                               [DM_CACHE]
    <*/M>   Mirror target                                            [DM_MIRROR]
    <*/M>   Zero target                                                [DM_ZERO]
    <*/M>   I/O delaying target                                       [DM_DELAY]

Kernel hacking --->
  Generic Kernel Debugging Instruments --->
    [*] Magic SysRq key                                            [MAGIC_SYSRQ]

Installation of LVM2

Install LVM2 by running the following commands:

PATH+=:/usr/sbin                \
./configure --prefix=/usr       \
            --enable-cmdlib     \
            --enable-pkgconfig  \
            --enable-udev_sync  &&
make

The tests use udev for logical volume synchronization, so the LVM udev rules and some utilities need to be installed before running the tests. If you are installing LVM2 for the first time, and do not want to install the full package before running the tests, the minimal set of utilities can be installed by running the following instructions as the root user:

make -C tools install_tools_dynamic &&
make -C udev  install               &&
make -C libdm install

To test the results, issue, as the root user:

LC_ALL=en_US.UTF-8 make check_local

Some tests may hang. In this case they can be skipped by adding S=<testname> to the make command. Other targets are available and can be listed with make -C test help. The test timings are very dependent on the speed of the disk(s), and on the number of enabled kernel options.

The tests do not implement the expected fail possibility, and a small number of test failures is expected by upstream. More failures may happen because some kernel options are missing. For example, the lack of the dm-delay device mapper target explains some failures. Some tests may fail if there is insufficient free space available in the partition with the /tmp directory. At least one test fails if 16 TB is not available. Some tests are flagged warned if thin-provisioning-tools are not installed. A workaround is to add the following flags to configure:

     --with-thin-check=    \
     --with-thin-dump=     \
     --with-thin-repair=   \
     --with-thin-restore=  \
     --with-cache-check=   \
     --with-cache-dump=    \
     --with-cache-repair=  \
     --with-cache-restore= \

Some tests may hang. They can be removed if necessary, for example: rm test/shell/lvconvert-raid-reshape.sh. The tests generate a lot of kernel messages, which may clutter your terminal. You can disable them by issuing dmesg -D before running the tests (do not forget to issue dmesg -E when tests are done).

Note

The checks create device nodes in the /tmp directory. The tests will fail if /tmp is mounted with the nodev option.

Now, as the root user:

make install
make install_systemd_units

Command Explanations

PATH+=:/usr/sbin: The path must contain /usr/sbin for proper system tool detection by the configure script. This instruction ensures that PATH is properly set even if you build as an unprivileged user.

--enable-cmdlib: This switch enables building of the shared command library. It is required when building the event daemon.

--enable-pkgconfig: This switch enables installation of pkg-config support files.

--enable-udev_sync: This switch enables synchronisation with Udev processing.

--enable-dmeventd: This switch enables building of the Device Mapper event daemon.

make install_systemd_units: This is needed to install a unit that activates logical volumes at boot. It is not installed by default.

Configuring LVM2

Config File

/etc/lvm/lvm.conf

Configuration Information

The default configuration still references the obsolete /var/lock directory. This creates a deadlock at boot time. Change this (as the root user):

sed -e '/locking_dir =/{s/#//;s/var/run/}' \
    -i /etc/lvm/lvm.conf

Contents

Installed Programs: blkdeactivate, dmeventd (optional), dmsetup, fsadm, lvm, lvmdump, and lvm_import_vdo. There are also numerous symbolic links to lvm that implement specific functionalities
Installed Libraries: libdevmapper.so and liblvm2cmd.so; optional: libdevmapper-event.so, libdevmapper-event-lvm2.so, libdevmapper-event-lvm2mirror.so, libdevmapper-event-lvm2raid.so, libdevmapper-event-lvm2snapshot.so, libdevmapper-event-lvm2thin.so, and libdevmapper-event-lvm2vdo.so
Installed Directories: /etc/lvm and /usr/lib/device-mapper (optional)

Short Descriptions

blkdeactivate

is a utility to deactivate block devices

dmeventd

(optional) is the Device Mapper event daemon

dmsetup

is a low level logical volume management tool

fsadm

is a utility used to resize or check filesystem on a device

lvm

provides the command-line tools for LVM2. Commands are implemented via symbolic links to this program to manage physical devices (pv*), volume groups (vg*) and logical volumes (lv*)

lvmdump

is a tool used to dump various information concerning LVM2

vgimportclone

is used to import a duplicated VG (e.g. hardware snapshot)

libdevmapper.so

contains the Device Mapper API functions

About Logical Volume Management (LVM)

LVM manages disk drives. It allows multiple drives and partitions to be combined into larger volume groups, assists in making backups through a snapshot, and allows for dynamic volume resizing. It can also provide mirroring similar to a RAID 1 array.

A complete discussion of LVM is beyond the scope of this introduction, but basic concepts are presented below.

To run any of the commands presented here, the LVM2-2.03.22 package must be installed. All commands must be run as the root user.

Management of disks with lvm is accomplished using the following concepts:

physical volumes

These are physical disks or partitions such as /dev/sda3 or /dev/sdb.

volume groups

These are named groups of physical volumes that can be manipulated by the administrator. The number of physical volumes that make up a volume group is arbitrary. Physical volumes can be dynamically added or removed from a volume group.

logical volumes

Volume groups may be subdivided into logical volumes. Each logical volume can then be individually formatted as if it were a regular Linux partition. Logical volumes may be dynamically resized by the administrator according to need.

To give a concrete example, suppose that you have two 2 TB disks. Also suppose a really large amount of space is required for a very large database, mounted on /srv/mysql. This is what the initial set of partitions would look like:

Partition  Use    Size      Partition Type
/dev/sda1  /boot  100MB     83 (Linux)
/dev/sda2  /       10GB     83 (Linux)
/dev/sda3  swap     2GB     82 (Swap)
/dev/sda4  LVM    remainder 8e (LVM)
/dev/sdb1  swap     2GB     82 (Swap)
/dev/sdb2  LVM    remainder 8e (LVM)

First initialize the physical volumes:

pvcreate /dev/sda4 /dev/sdb2

Note

A full disk can be used as part of a physical volume, but beware that the pvcreate command will destroy any partition information on that disk.

Next create a volume group named lfs-lvm:

vgcreate lfs-lvm /dev/sda4  /dev/sdb2

The status of the volume group can be checked by running the command vgscan. Now create the logical volumes. Since there is about 3900 GB available, leave about 900 GB free for expansion. Note that the logical volume named mysql is larger than any physical disk.

lvcreate --name mysql --size 2500G lfs-lvm
lvcreate --name home  --size  500G lfs-lvm

Finally the logical volumes can be formatted and mounted. In this example, the jfs file system (jfsutils-1.1.15) is used for demonstration purposes.

mkfs -t ext4 /dev/lfs-lvm/home
mkfs -t jfs  /dev/lfs-lvm/mysql
mount /dev/lfs-lvm/home /home
mkdir -p /srv/mysql
mount /dev/lfs-lvm/mysql /srv/mysql

It may be needed to activate those logical volumes, for them to appear in /dev. They can all be activated at the same time by issuing, as the root user:

vgchange -a y

A LVM logical volume can host a root filesystem, but requires the use of an initramfs (initial RAM file system). The initramfs proposed in the section called “About initramfs” allows to pass the lvm volume in the root= switch of the kernel command line.

If not using an initramfs, there is a race condition in systemd preventing mounting logical volumes through /etc/fstab. You must create a mount unit (see systemd.mount(5)) as in the following example, which mounts the /home directory automatically at boot:

cat > /etc/systemd/system/home.mount << EOF
[Unit]
Description=Mount the lvm volume /dev/lfs-lvm/home to /home

[Mount]
What=/dev/lfs-lvm/home
Where=/home
Type=ext4
Options=default

[Install]
WantedBy=multi-user.target
EOF

Note

The name of the unit must be the name of the mount point with the `/' character replaced by `-', omitting the leading one.

Next the unit must be enabled with:

systemctl enable home.mount

For more information about LVM, see the LVM HOWTO and the lvm man pages. A good in-depth guide is available from RedHat®, although it makes sometimes reference to proprietary tools.

About RAID

The storage technology known as RAID (Redundant Array of Independent Disks) combines multiple physical disks into a logical unit. The drives can generally be combined to provide data redundancy or to extend the size of logical units beyond the capability of the physical disks or both. The technology also allows for providing hardware maintenance without powering down the system.

The types of RAID organization are described in the RAID Wiki.

Note that while RAID provides protection against disk failures, it is not a substitute for backups. A file deleted is still deleted on all the disks of a RAID array. Modern backups are generally done via rsync-3.2.7.

There are three major types of RAID implementation: Hardware RAID, BIOS-based RAID, and Software RAID.

Hardware RAID

Hardware based RAID provides capability through proprietary hardware and data layouts. The control and configuration is generally done via firmware in conjunction with executable programs made available by the device manufacturer. The capabilities are generally supplied via a PCI card, although there are some instances of RAID components integrated in to the motherboard. Hardware RAID may also be available in a stand-alone enclosure.

One advantage of hardware-based RAID is that the drives are offered to the operating system as a logical drive and no operating system dependent configuration is needed.

Disadvantages include difficulties in transferring drives from one system to another, updating firmware, or replacing failed RAID hardware.

BIOS-based RAID

Some computers offer a hardware-like RAID implementation in the system BIOS. Sometime this is referred to as 'fake' RAID as the capabilities are generally incorporated into firmware without any hardware acceleration.

The advantages and disadvantages of BIOS-based RAID are generally the same as hardware RAID with the additional disadvantage that there is no hardware acceleration.

In some cases, BIOS-based RAID firmware is enabled by default (e.g. some DELL systems). If software RAID is desired, this option must be explicitly disabled in the BIOS.

Software RAID

Software based RAID is the most flexible form of RAID. It is easy to install and update and provides full capability on all or part of any drives available to the system. In BLFS, the RAID software is found in mdadm-4.2.

Configuring a RAID device is straightforward using mdadm. Generally devices are created in the /dev directory as /dev/mdx where x is an integer.

The first step in creating a RAID array is to use partitioning software such as fdisk or parted-3.6 to define the partitions needed for the array. Usually, there will be one partition on each drive participating in the RAID array, but that is not strictly necessary. For this example, there will be four disk drives: /dev/sda, /dev/sdb, /dev/sdc, and /dev/sdd. They will be partitioned as follows:

Partition Size     Type                Use
sda1:     100 MB   fd Linux raid auto  /boot    (RAID 1) /dev/md0
sda2:      10 GB   fd Linux raid auto  /        (RAID 1) /dev/md1
sda3:       2 GB   83 Linux swap       swap
sda4      300 GB   fd Linux raid auto  /home    (RAID 5) /dev/md2

sdb1:     100 MB   fd Linux raid auto  /boot    (RAID 1) /dev/md0
sdb2:      10 GB   fd Linux raid auto  /        (RAID 1) /dev/md1
sdb3:       2 GB   83 Linux swap       swap
sdb4      300 GB   fd Linux raid auto  /home    (RAID 5) /dev/md2

sdc1:      12 GB   fd Linux raid auto  /usr/src (RAID 0) /dev/md3
sdc2:     300 GB   fd Linux raid auto  /home    (RAID 5) /dev/md2

sdd1:      12 GB   fd Linux raid auto  /usr/src (RAID 0) /dev/md3
sdd2:     300 GB   fd Linux raid auto  /home    (RAID 5) /dev/md2 

In this arrangement, a separate boot partition is created as the first small RAID array and a root filesystem as the secong RAID array, both mirrored. The third partition is a large (about 1TB) array for the /home directory. This provides an ability to stripe data across multiple devices, improving speed for both reading and writing large files. Finally, a fourth array is created that concatenates two partitions into a larger device.

Note

All mdadm commands must be run as the root user.

To create these RAID arrays the commands are:

/sbin/mdadm -Cv /dev/md0 --level=1 --raid-devices=2 /dev/sda1 /dev/sdb1
/sbin/mdadm -Cv /dev/md1 --level=1 --raid-devices=2 /dev/sda2 /dev/sdb2
/sbin/mdadm -Cv /dev/md3 --level=0 --raid-devices=2 /dev/sdc1 /dev/sdd1
/sbin/mdadm -Cv /dev/md2 --level=5 --raid-devices=4 \
        /dev/sda4 /dev/sdb4 /dev/sdc2 /dev/sdd2 

The devices created can be examined by device. For example, to see the details of /dev/md1, use /sbin/mdadm --detail /dev/md1:

        Version : 1.2
  Creation Time : Tue Feb  7 17:08:45 2012
     Raid Level : raid1
     Array Size : 10484664 (10.00 GiB 10.74 GB)
  Used Dev Size : 10484664 (10.00 GiB 10.74 GB)
   Raid Devices : 2
  Total Devices : 2
    Persistence : Superblock is persistent

    Update Time : Tue Feb  7 23:11:53 2012
          State : clean
 Active Devices : 2
Working Devices : 2
 Failed Devices : 0
  Spare Devices : 0

           Name : core2-blfs:0  (local to host core2-blfs)
           UUID : fcb944a4:9054aeb2:d987d8fe:a89121f8
         Events : 17

    Number   Major   Minor   RaidDevice State
       0       8        1        0      active sync   /dev/sda1
       1       8       17        1      active sync   /dev/sdb1

From this point, the partitions can be formatted with the filesystem of choice (e.g. ext3, ext4, xfsprogs-6.4.0, reiserfsprogs-3.6.27, etc). The formatted partitions can then be mounted. The /etc/fstab file can use the devices created for mounting at boot time and the linux command line in /boot/grub/grub.cfg can specify root=/dev/md1.

Note

The swap devices should be specified in the /etc/fstab file as normal. The kernel normally stripes swap data across multiple swap files and should not be made part of a RAID array.

For further options and management details of RAID devices, refer to man mdadm.

Additional details for monitoring RAID arrays and dealing with problems can be found at the Linux RAID Wiki.

mdadm-4.2

Introduction to mdadm

The mdadm package contains administration tools for software RAID.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

mdadm Dependencies

Optional

A MTA

Caution

Kernel versions in series 4.1 through 4.4.1 have a broken RAID implementation. Use a kernel with version at or above 4.4.2.

Kernel Configuration

Enable the following options in the kernel configuration and recompile the kernel, if necessary. Only the RAID types desired are required.

Device Drivers --->
  [*] Multiple devices driver support (RAID and LVM) --->                   [MD]
    <*/M>   RAID support                                            [BLK_DEV_MD]
    [*]       Autodetect RAID arrays during kernel boot          [MD_AUTODETECT]
    # Only the RAID types desired are required:
    < /*/M>   RAID-0 (striping) mode                                  [MD_RAID0]
    < /*/M>   RAID-1 (mirroring) mode                                 [MD_RAID1]
    < /*/M>   RAID-10 (mirrored striping) mode                       [MD_RAID10]
    < /*/M>   RAID-4/RAID-5/RAID-6 mode                             [MD_RAID456]

Installation of mdadm

Build mdadm by running the following command:

make

This package does not come with a working test suite.

Now, as the root user:

make BINDIR=/usr/sbin install

Command Explanations

make everything: This optional target creates extra programs, particularly a statically-linked version of mdadm. This needs to be manually installed.

--keep-going: Run the tests to the end, even if one or more tests fail.

--logdir=test-logs: Defines the directory where test logs are saved.

--save-logs: Instructs the test suite to save the logs.

--tests=<test1,test2,...>: Optional comma separated list of tests to be executed (all tests, if this option is not passed).

Contents

Installed Programs: mdadm and mdmon
Installed Libraries: None
Installed Directory: None

Short Descriptions

mdadm

manages MD devices aka Linux Software RAID

mdmon

monitors MD external metadata arrays

ntfs-3g-2022.10.3

Introduction to Ntfs-3g

Note

A new read-write driver for NTFS, called NTFS3, has been added into the Linux kernel since the 5.15 release. The performance of NTFS3 is much better than ntfs-3g. To enable NTFS3, enable the following options in the kernel configuration and recompile the kernel if necessary:

File systems --->
  DOS/FAT/EXFAT/NT Filesystems --->
    <*/M> NTFS Read-Write file system support                         [NTFS3_FS]

To ensure the mount command uses NTFS3 for ntfs partitions, create a wrapper script:

cat > /usr/sbin/mount.ntfs << "EOF" &&
#!/bin/sh
exec mount -t ntfs3 "$@"
EOF
chmod -v 755 /usr/sbin/mount.ntfs

With the kernel support available, ntfs-3g is only needed if you need the utilities from it (for example, to create NTFS filesystems).

The Ntfs-3g package contains a stable, read-write open source driver for NTFS partitions. NTFS partitions are used by most Microsoft operating systems. Ntfs-3g allows you to mount NTFS partitions in read-write mode from your Linux system. It uses the FUSE kernel module to be able to implement NTFS support in userspace. The package also contains various utilities useful for manipulating NTFS partitions.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Ntfs-3g Dependencies

Optional

fuse 2.x (this disables user mounts)

Kernel Configuration

Enable the following options in the kernel configuration and recompile the kernel if necessary:

File systems --->
  <*/M> FUSE (Filesystem in Userspace) support                         [FUSE_FS]

Note that it is only needed for mounting NTFS partitions with ntfs-3g. If you will use the in-kernel NTFS3 driver for mounting NTFS partitions (as the BLFS editors recommend) instead, you can skip this configuration item.

Installation of Ntfs-3g

Install Ntfs-3g by running the following commands:

./configure --prefix=/usr        \
            --disable-static     \
            --with-fuse=internal \
            --docdir=/usr/share/doc/ntfs-3g-2022.10.3 &&
make

This package does not come with a test suite.

Now, as the root user:

make install &&

It's recommended to use the in-kernel NTFS3 driver for mounting NTFS filesystems, instead of ntfs-3g (see the note at the start of this page). However, if you want to use ntfs-3g to mount the NTFS filesystems anyway, create a symlink for the mount command:

ln -sv ../bin/ntfs-3g /usr/sbin/mount.ntfs &&
ln -sv ntfs-3g.8 /usr/share/man/man8/mount.ntfs.8

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--with-fuse=internal: This switch dynamically forces ntfs-3g to use an internal copy of the fuse-2.x library. This is required if you wish to allow users to mount NTFS partitions.

--disable-ntfsprogs: Disables installation of various utilities used to manipulate NTFS partitions.

chmod -v 4755 /usr/bin/ntfs-3g: Making mount.ntfs setuid root allows non root users to mount NTFS partitions.

Using Ntfs-3g

To mount a Windows partition at boot time, put a line like this in /etc/fstab:

              /dev/sda1 /mnt/windows auto defaults 0 0

To allow users to mount a usb stick with an NTFS filesystem on it, put a line similar to this (change sdc1 to whatever a usb stick would be on your system) in /etc/fstab:

              /dev/sdc1 /mnt/usb auto user,noauto,umask=0,utf8 0 0

In order for a user to be able to mount the usb stick, they will need to be able to write to /mnt/usb, so as the root user:

chmod -v 777 /mnt/usb

Contents

Installed Programs: lowntfs-3g, mkfs.ntfs, mkntfs, mount.lowntfs-3g, mount.ntfs, mount.ntfs-3g, ntfs-3g, ntfs-3g.probe, ntfscat, ntfsclone, ntfscluster, ntfscmp, ntfscp, ntfsfix, ntfsinfo, ntfslabel, ntfsls, ntfsresize and ntfsundelete
Installed Library: libntfs-3g.so
Installed Directories: /usr/include/ntfs-3g and /usr/share/doc/ntfs-3g

Short Descriptions

lowntfs-3g

is similar to ntfs-3g but uses the Fuse low-level interface

mkfs.ntfs

is a symlink to mkntfs

mkntfs

creates an NTFS file system

mount.lowntfs-3g

is a symlink to lowntfs-3g

mount.ntfs

mounts an NTFS filesystem

mount.ntfs-3g

is a symbolic link to ntfs-3g

ntfs-3g

is an NTFS driver, which can create, remove, rename, move files, directories, hard links, and streams. It can also read and write files, including streams, sparse files and transparently compressed files. It can also handle special files like symbolic links, devices, and FIFOs; moreover it provides standard management of file ownership and permissions, including POSIX ACLs

ntfs-3g.probe

tests if an NTFS volume is mountable read only or read-write, and exits with a status value accordingly. The volume can be a block device or image file

ntfscluster

identifies files in a specified region of an NTFS volume

ntfscp

copies a file to an NTFS volume

ntfsfix

fixes common errors and forces Windows to check an NTFS partition

ntfsls

lists directory contents on an NTFS filesystem

ntfscat

prints NTFS files and streams on the standard output

ntfsclone

clones an NTFS filesystem

ntfscmp

compares two NTFS filesystems and shows the differences

ntfsinfo

dumps a file's attributes

ntfslabel

displays or changes the label on an ntfs file system

ntfsresize

resizes an NTFS filesystem without data loss

ntfsundelete

recovers a deleted file from an NTFS volume

libntfs-3g.so

contains the Ntfs-3g API functions

gptfdisk-1.0.9

Introduction to gptfdisk

The gptfdisk package is a set of programs for creation and maintenance of GUID Partition Table (GPT) disk drives. A GPT partitioned disk is required for drives greater than 2 TB and is a modern replacement for legacy PC-BIOS partitioned disk drives that use a Master Boot Record (MBR). The main program, gdisk, has an interface similar to the classic fdisk program.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

gptfdisk Dependencies

Required

popt-1.19

Optional

ICU-73.2

Installation of gptfdisk

The gptfdisk package comes with a rudimentary Makefile. First we update it to provide a simple build and install interface and fix the location of a header file as well fixing an issue introduced by a recent version of popt. Install gptfdisk by running the following commands:

patch -Np1 -i ../gptfdisk-1.0.9-convenience-1.patch &&
sed -i 's|ncursesw/||' gptcurses.cc &&
sed -i 's|sbin|usr/sbin|' Makefile &&
sed -i '/UUID_H/s/^.*$/#if defined (_UUID_UUID_H) || defined (_UL_LIBUUID_UUID_H)/' guid.cc &&
sed -i "/device =/s/= \(.*\);/= strdup(\1);/" gptcl.cc &&

make

To test the results, issue: make test.

Now, as the root user:

make install

Command Explanations

patch -Np1 ...: This patch modifies the Makefile file so that it provides an install target.

Contents

Installed Programs: cgdisk, gdisk, fixparts, and sgdisk

Short Descriptions

cgdisk

is an ncurses-based tool for manipulating GPT partitions

gdisk

is an interactive text-mode tool for manipulating GPT partitions

fixparts

repairs mis-formatted MBR based disk partitions

sgdisk

is a partition manipulation program for GPT partitions similar to sfdisk

parted-3.6

Introduction to parted

The Parted package is a disk partitioning and partition resizing tool.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Parted Dependencies

Recommended
Optional

dosfstools-4.2, Pth-2.0.7, texlive-20230313 (or install-tl-unx), and Digest::CRC (for tests)

Optional Kernel Configuration for Tests

About 20 % more tests are run if the following kernel module is built:

Device Drivers --->
  SCSI device support --->
    [*] SCSI low-level drivers --->                              [SCSI_LOWLEVEL]
      <M> SCSI debugging host and device simulator                  [SCSI_DEBUG]

Installation of parted

Install Parted by running the following commands:

./configure --prefix=/usr --disable-static &&
make &&

make -C doc html                                       &&
makeinfo --html      -o doc/html       doc/parted.texi &&
makeinfo --plaintext -o doc/parted.txt doc/parted.texi

If you have texlive-20230313 installed and wish to create PDF and Postscript documentation issue the following commands:

cp build-aux/texinfo.tex doc               &&
texi2pdf -o doc/parted.pdf doc/parted.texi &&
texi2dvi -o doc/parted.dvi doc/parted.texi &&
dvips    -o doc/parted.ps  doc/parted.dvi

To test the results, issue, as the root user:

make check

Note

Many tests are skipped if not run as the root user.

Now, as the root user:

make install &&
install -v -m755 -d /usr/share/doc/parted-3.6/html &&
install -v -m644    doc/html/* \
                    /usr/share/doc/parted-3.6/html &&
install -v -m644    doc/{FAT,API,parted.{txt,html}} \
                    /usr/share/doc/parted-3.6

Install the optional PDF and Postscript documentation by issuing the following command as the root user:

install -v -m644 doc/FAT doc/API doc/parted.{pdf,ps,dvi} \
                    /usr/share/doc/parted-3.6

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--disable-device-mapper: This option disables device mapper support. Add this parameter if you have not installed LVM2.

Contents

Installed Programs: parted and partprobe
Installed Libraries: libparted.so and libparted-fs-resize.so
Installed Directories: /usr/include/parted and /usr/share/doc/parted-3.6

Short Descriptions

parted

is a partition manipulation program

partprobe

informs the OS of partition table changes

libparted.so

contains the Parted API functions

reiserfsprogs-3.6.27

Introduction to reiserfsprogs

The reiserfsprogs package contains various utilities for use with the Reiser file system.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Kernel Configuration

Enable the following option in the kernel configuration and recompile the kernel:

File systems --->
  <*/M> Reiserfs support (deprecated)                              [REISERFS_FS]

Installation of reiserfsprogs

Install reiserfsprogs by running the following commands:

sed -i '/parse_time.h/i #define _GNU_SOURCE' lib/parse_time.c &&
autoreconf -fiv           &&

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

sed ...: Ensure a variable is defined for use with recent include files.

Contents

Installed Programs: debugreiserfs, mkreiserfs, reiserfsck, reiserfstune, and resize_reiserfs
Installed Library: libreiserfscore.so
Installed Directory: /usr/include/reiserfs

Short Descriptions

debugreiserfs

can sometimes help to solve problems with ReiserFS file systems. If it is called without options, it prints the super block of any ReiserFS file system found on the device

mkreiserfs

creates a ReiserFS file system

reiserfsck

is used to check or repair a ReiserFS file system

reiserfstune

is used for tuning the ReiserFS journal. WARNING: Don't use this utility without first reading the man page thoroughly

resize_reiserfs

is used to resize an unmounted ReiserFS file system

smartmontools-7.4

Introduction to smartmontools

The smartmontools package contains utility programs (smartctl, smartd) to control/monitor storage systems using the Self-Monitoring, Analysis and Reporting Technology System (S.M.A.R.T.) built into most modern ATA and SCSI disks.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

smartmontools Dependencies

Optional (runtime)

cURL-8.2.1 or Lynx-2.8.9rel.1 or Wget-1.21.4 (download tools), and GnuPG-2.4.3 (encrypted hard disks)

Installation of smartmontools

Install smartmontools by running the following commands:

./configure --prefix=/usr           \
            --sysconfdir=/etc       \
            --docdir=/usr/share/doc/smartmontools-7.4 &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Configuring smartmontools

Config File

/etc/smartd.conf

Configuration Information

See the embedded comments in /etc/smartd.conf for detailed instructions on customizing the smartd daemon.

Systemd Unit

If you want the smartd daemon to start automatically when the system is booted, enable the systemd unit provided by the package by executing the following command as the root user:

systemctl enable smartd

Contents

Installed Programs: smartctl, smartd, and update-smart-drivedb
Installed Libraries: None
Installed Directories: /usr/share/smartmontools, /usr/share/doc/smartmontools-7.4, and /etc/smartd_warning.d

Short Descriptions

smartctl

is the control and monitor utility for SMART Disks

smartd

is the SMART disk monitoring daemon

update-smart-drivedb

is the update tool for the smartmontools drive database

sshfs-3.7.3

Introduction to Sshfs

The Sshfs package contains a filesystem client based on the SSH File Transfer Protocol. This is useful for mounting a remote computer that you have ssh access to as a local filesystem. This allows you to drag and drop files or run shell commands on the remote files as if they were on your local computer.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Sshfs Dependencies

Required

Fuse-3.16.1, GLib-2.76.4, and OpenSSH-9.4p1.

Optional

docutils-0.20.1 (required to build the man page)

Installation of Sshfs

Install Sshfs by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Using Sshfs

To mount an ssh server you need to be able to log into the server. For example, to mount your remote home folder to the local ~/examplepath (the directory must exist and you must have permissions to write to it):

sshfs example.com:/home/userid ~/examplepath

When you've finished work and want to unmount it again:

fusermount3 -u ~/example

You can also mount an sshfs filesystem at boot by adding an entry similar to the following in the /etc/fstab file:

[email protected]:/path /media/path fuse.sshfs _netdev,IdentityFile=/home/userid/.ssh/id_rsa 0 0

See man 1 sshfs and man 8 mount.fuse3 for all available mount options.

Contents

Installed Program: sshfs
Installed Libraries: None
Installed Directories: None

Short Descriptions

sshfs

mounts an ssh server as a local file system

xfsprogs-6.4.0

Introduction to xfsprogs

The xfsprogs package contains administration and debugging tools for the XFS file system.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

xfsprogs Dependencies

Required

inih-57 and liburcu-0.14.0

Optional

ICU-73.2 (for unicode name scanning in xfs_scrub)

Kernel Configuration

Enable the following options in the kernel configuration and recompile the kernel:

File systems --->
  <*/M> XFS filesystem support                                          [XFS_FS]

Installation of xfsprogs

Install xfsprogs by running the following commands:

make DEBUG=-DNDEBUG     \
     INSTALL_USER=root  \
     INSTALL_GROUP=root

This package does not come with a test suite.

Now, as the root user:

make PKG_DOC_DIR=/usr/share/doc/xfsprogs-6.4.0 install     &&
make PKG_DOC_DIR=/usr/share/doc/xfsprogs-6.4.0 install-dev &&

rm -rfv /usr/lib/libhandle.{a,la}

Command Explanations

make DEBUG=-DNDEBUG: Turns off debugging symbols.

INSTALL_USER=root INSTALL_GROUP=root: This sets the owner and group of the installed files.

OPTIMIZER="...": Adding this parameter to the end of the make command overrides the default optimization settings.

Contents

Installed Programs: fsck.xfs, mkfs.xfs, xfs_admin, xfs_bmap, xfs_copy, xfs_db, xfs_estimate, xfs_freeze, xfs_fsr, xfs_growfs, xfs_info, xfs_io, xfs_logprint, xfs_mdrestore, xfs_metadump, xfs_mkfile, xfs_ncheck, xfs_quota, xfs_repair, xfs_rtcp, xfs_scrub, xfs_scrub_all, and xfs_spaceman
Installed Libraries: libhandle.so
Installed Directories: /usr/include/xfs, /usr/lib/xfsprogs, /usr/share/xfsprogs, and /usr/share/doc/xfsprogs-6.4.0

Short Descriptions

fsck.xfs

simply exits with a zero status, since XFS partitions are checked at mount time

mkfs.xfs

constructs an XFS file system

xfs_admin

changes the parameters of an XFS file system

xfs_bmap

prints block mapping for an XFS file

xfs_copy

copies the contents of an XFS file system to one or more targets in parallel

xfs_estimate

for each directory argument, estimates the space that directory would take if it were copied to an XFS filesystem (does not cross mount points)

xfs_db

is used to debug an XFS file system

xfs_freeze

suspends access to an XFS file system

xfs_fsr

applicable only to XFS filesystems, improves the organization of mounted filesystems, the reorganization algorithm operates on one file at a time, compacting or otherwise improving the layout of the file extents (contiguous blocks of file data)

xfs_growfs

expands an XFS file system

xfs_info

is equivalent to invoking xfs_growfs, but specifying that no change to the file system is to be made

xfs_io

is a debugging tool like xfs_db, but is aimed at examining the regular file I/O path rather than the raw XFS volume itself

xfs_logprint

prints the log of an XFS file system

xfs_mdrestore

restores an XFS metadump image to a filesystem image

xfs_metadump

copies XFS filesystem metadata to a file

xfs_mkfile

creates an XFS file, padded with zeroes by default

xfs_ncheck

generates pathnames from inode numbers for an XFS file system

xfs_quota

is a utility for reporting and editing various aspects of filesystem quotas

xfs_repair

repairs corrupt or damaged XFS file systems

xfs_rtcp

copies a file to the real-time partition on an XFS file system

xfs_scrub

checks and repairs the contents of a mounted XFS file system

xfs_scrub_all

scrubs all mounted XFS file systems

xfs_spaceman

reports and controls free space usage in an XFS file system

libhandle.so

contains XFS-specific functions that provide a way to perform certain filesystem operations without using a file descriptor to access filesystem objects

Packages for UEFI Boot

efivar-38

Introduction to efivar

The efivar package provides tools and libraries to manipulate EFI variables.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

efivar Dependencies

Required

mandoc-1.14.6

Installation of efivar

First, fix an issue in Makefile causing the package to be rebuilt during installation:

sed '/prep :/a\\ttouch prep' -i src/Makefile

Note

This package cannot function properly on a 32-bit system with a 64-bit UEFI implementation. Don't install this package (or efibootmgr) on 32-bit system unless you are absolutely sure you have a 32-bit UEFI implementation, which is very rare in practice.

If building this package on a 32-bit system, apply a patch:

[ $(getconf LONG_BIT) = 64 ] || patch -Np1 -i ../efivar-38-i686-1.patch

Build efivar with the following commands:

make ERRORS=

The test suite of this package is dangerous. Running it may trigger firmware bugs and make your system unusable without using some special hardware to reprogram the firmware.

Now, as the root user:

make install LIBDIR=/usr/lib

Command Explanations

ERRORS=: This option overrides the -Werror passed to GCC by default, so the package won't fail to build with the -Wenum-int-mismatch warning introduced in GCC 13.

LIBDIR=/usr/lib: This option overrides the default library directory of the package (/usr/lib64, which is not used by LFS.)

Contents

Installed Programs: efisecdb and efivar
Installed Libraries: libefiboot.so, libefisec.so, and libefivar.so
Installed Directories: /usr/include/efivar

Short Descriptions

efisecdb

is an utility for managing UEFI signature lists

efivar

is a tool to manipulate UEFI variables

libefiboot.so

is a library used by efibootmgr

libefisec.so

is a library for managing UEFI signature lists

libefivar.so

is a library for the manipulation of EFI variables

efibootmgr-18

Introduction to efibootmgr

The efibootmgr package provides tools and libraries to manipulate EFI variables.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

efibootmgr Dependencies

Required

efivar-38 and popt-1.19

Installation of efibootmgr

Build efibootmgr with the following commands:

make EFIDIR=LFS EFI_LOADER=grubx64.efi

This package does not have a test suite.

Now, as the root user:

make install EFIDIR=LFS

Command Explanations

EFIDIR=LFS: This option specifies the distro's subdirectory name under /boot/efi/EFI. The building system of this package needs it to be set explicitly.

EFI_LOADER=grubx64.efi: This option specifies the name of the default EFI boot loader. It is set to match the EFI boot loader provided by GRUB .

Contents

Installed Programs: efibootdump and efibootmgr

Short Descriptions

efibootdump

is a tool to display individual UEFI boot options, from a file or an UEFI variable

efibootmgr

is a tool to manipulate the UEFI Boot Manager

GRUB-2.06 for EFI

Introduction to GRUB

The GRUB package provides GRand Unified Bootloader. In this page it will be built with UEFI support, which is not enabled for GRUB built in LFS.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://ftp.gnu.org/gnu/grub/grub-2.06.tar.xz

  • Download MD5 sum: cf0fd928b1e5479c8108ee52cb114363

  • Download size: 6.3 MB

  • Estimated disk space required: 183 MB

  • Estimated build time: 0.4 SBU (on 64-bit LFS, using parallelism=4)

Additional Downloads

Unicode font data used to display GRUB menu

GCC (only needed if building on 32-bit LFS)

GRUB Dependencies

Recommended
Optional

LVM2-2.03.22

Installation of GRUB

First, install font data as the root user:

mkdir -pv /usr/share/fonts/unifont &&
gunzip -c ../unifont-15.0.06.pcf.gz > /usr/share/fonts/unifont/unifont.pcf

Warning

Unset any environment variables which may affect the build:

unset {C,CPP,CXX,LD}FLAGS

Don't try tuning this package with custom compilation flags: this package is a bootloader, with low-level operations in the source code which is likely to be broken by some aggressive optimizations.

Fix an issue causing grub-install to fail when the /boot partition (or the root partition if /boot is not a separate partition) is created by e2fsprogs-1.47.0 or later:

patch -Np1 -i ../grub-2.06-upstream_fixes-1.patch

If you are running a 32-bit LFS, prepare a 64-bit compiler:

case $(uname -m) in i?86 )
    tar xf ../gcc-13.2.0.tar.xz
    mkdir gcc-13.2.0/build
    pushd gcc-13.2.0/build
        ../configure --prefix=$PWD/../../x86_64-gcc \
                     --target=x86_64-linux-gnu      \
                     --with-system-zlib             \
                     --enable-languages=c,c++       \
                     --with-ld=/usr/bin/ld
        make all-gcc
        make install-gcc
    popd
    export TARGET_CC=$PWD/x86_64-gcc/bin/x86_64-linux-gnu-gcc
esac

Build GRUB with the following commands:

./configure --prefix=/usr        \
            --sysconfdir=/etc    \
            --disable-efiemu     \
            --enable-grub-mkfont \
            --with-platform=efi  \
            --target=x86_64      \
            --disable-werror     &&
unset TARGET_CC &&
make

This package does not have a test suite providing meaningful results.

Now, as the root user:

make install &&
mv -v /etc/bash_completion.d/grub /usr/share/bash-completion/completions

Command Explanations

--enable-grub-mkfont: Build the tool named grub-mkfont to generate the font file for the boot loader from the font data we've installed.

Warning

If the recommended dependency FreeType-2.13.1 is not installed, it is possible to omit this option and build GRUB. However, if grub-mkfont is not built, or the unicode font data is not available at the time GRUB is built, GRUB won't install any font for the boot loader. The GRUB boot menu will be displayed using a coarse font or in a smaller region on the screen.

--with-platform=efi: Ensures building GRUB with EFI enabled.

--target=x86_64: Ensures building GRUB for x86_64 even if building on a 32-bit LFS system. Most EFI firmware on x86_64 does not support 32-bit bootloaders.

--target=i386: A few 32-bit x86 platforms have EFI support. And, some x86_64 platforms have a 32-bit EFI implementation, but they are very old and rare. Use this instead of --target=x86_64 if you are absolutely sure that LFS is running on such a system.

Configuring GRUB

Using GRUB to make the LFS system bootable on UEFI platform will be discussed in Using GRUB to Set Up the Boot Process with UEFI.

Contents

See the page for GRUB in LFS book.

Using GRUB to Set Up the Boot Process with UEFI

Turn Off Secure Boot

BLFS does not have the essential packages to support Secure Boot. To set up the boot process with GRUB and UEFI in BLFS, Secure Boot must be turned off from the configuration interface of the firmware. Read the documentation provided by the manufacturer of your system to find out how.

Kernel Configuration for UEFI support

Enable the following options in the kernel configuration and recompile the kernel if necessary:

Processor type and features --->
  [*] EFI runtime service support                                          [EFI]

-*- Enable the block layer --->                                          [BLOCK]
  Partition Types --->
    [ /*] Advanced partition selection                      [PARTITION_ADVANCED]
    [*]     EFI GUID Partition support                           [EFI_PARTITION]

Device Drivers --->
  Firmware Drivers --->
    [*] Mark VGA/VBE/EFI FB as generic system framebuffer       [SYSFB_SIMPLEFB]
  Graphics support --->
    <*> Direct Rendering Manager (XFree86 4.1.0 and higher DRI support) --->
                                                                      ...  [DRM]
    [*] Enable legacy fbdev support for your modesetting driver
                                                      ...  [DRM_FBDEV_EMULATION]
    <*> Simple framebuffer driver                                [DRM_SIMPLEDRM]
    Frame buffer Devices --->
      <*> Support for frame buffer devices --->                             [FB]
    Console display driver support --->
      -*- Framebuffer Console support                      [FRAMEBUFFER_CONSOLE]

File systems --->
  DOS/FAT/EXFAT/NT Filesystems --->
    <*/M> VFAT (Windows-95) fs support                                 [VFAT_FS]
  Pseudo filesystems --->
    <*/M> EFI Variable filesystem                                    [EFIVAR_FS]
  -*- Native language support --->                                         [NLS]
    <*/M> Codepage 437 (United States, Canada)                [NLS_CODEPAGE_437]
    <*/M> NLS ISO 8859-1  (Latin 1; Western European Languages)  [NLS_ISO8859_1]

The meaning of the configuration options:

CONFIG_PARTITION_ADVANCED

If it's not enabled, CONFIG_EFI_PARTITION will be enabled automatically. But when it's enabled, you must set CONFIG_EFI_PARTITION to enabled as well.

CONFIG_SYSFB_SIMPLEFB, CONFIG_DRM, CONFIG_DRM_FBDEV_EMULATION, CONFIG_DRM_SIMPLEDRM, CONFIG_FB, and CONFIG_FRAMEBUFFER_CONSOLE

The combination of these options provides the Linux console support on top of the UEFI framebuffer. To allow the kernel to print debug messages at an early boot stage, they shouldn't be built as kernel modules unless an initramfs will be used.

Create an Emergency Boot Disk

Ensure that an emergency boot disk is ready to rescue the system in case the system becomes un-bootable. To make an emergency boot disk with GRUB for an EFI based system, find a spare USB flash drive and create a vfat file system on it. Install dosfstools-4.2 first, then as the root user:

Warning

The following command will erase all directories and files in the partition. Make sure your USB flash drive contains no data which will be needed, and change sdx1 to the device node corresponding to the first partition of the USB flash drive. Be careful not to overwrite your hard drive with a typo!

mkfs.vfat /dev/sdx1

Still as the root user, use the fdisk utility to set the first partition of the USB flash drive to be an EFI system partition (change sdx to the device node corresponding to your USB flash drive):

fdisk /dev/sdx

Welcome to fdisk (util-linux 2.39.1).
Changes will remain in memory only, until you decide to write them.
Be careful before using the write command.


Command (m for help): t
Partition number (1-9, default 9): 1
Partition type or alias (type L to list all): uefi
Changed type of partition 'Linux filesystem' to 'EFI System'.

Command (m for help): w
The partition table has been altered.
Syncing disks.

Still as the root user, create a mount point for the EFI partition on the USB flash drive and mount it:

mount --mkdir -v -t vfat /dev/sdx1 -o codepage=437,iocharset=iso8859-1 \
      /mnt/rescue

Install GRUB for EFI on the partition:

grub-install --target=x86_64-efi --removable \
             --efi-directory=/mnt/rescue --boot-directory=/mnt/rescue

Unmount the partition:

umount /mnt/rescue

Now the USB flash drive can be used as an emergency boot disk on any x86-64 UEFI platform. It will boot the system and show the GRUB shell. Then you can type commands to boot your operating system from the hard drive. To learn how to select the boot device, read the manual of your motherboard or laptop.

Find or Create the EFI System Partition

On EFI based systems, the bootloaders are installed in a special FAT32 partition called an EFI System Partition (ESP). If your system supports EFI, and a recent version of some Linux distribution or Windows is pre-installed, it's likely that the ESP has already been created. As the root user, list all the partitions on your hard drive (replace sda with the device corresponding to the appropriate hard drive):

fdisk -l /dev/sda

The Type column of the ESP should be EFI System.

If the system or the hard drive is new, or it's the first installation of a UEFI-booted OS on the system, the ESP may not exist. In that case, install dosfstools-4.2 first. Then create a new partition, make a vfat file system on it, and set the partition type to EFI system. See the instructions for the emergency boot device above as a reference.

Warning

Some (old) UEFI implementations may require the ESP to be the first partition on the disk.

Now, as the root user, create the mount point for the ESP, and mount it (replace sda1 with the device node corresponding to the ESP):

mount --mkdir -v -t vfat /dev/sda1 -o codepage=437,iocharset=iso8859-1 \
      /boot/efi

If you want to mount the ESP automatically during system boot, as the root user, add an entry for the ESP into /etc/fstab:

cat >> /etc/fstab << EOF
/dev/sda1 /boot/efi vfat codepage=437,iocharset=iso8859-1 0 1
EOF

Minimal Boot Configuration with GRUB and EFI

On UEFI based systems, GRUB works by installing an EFI application (a special kind of executable) into the ESP. The EFI firmware will search boot loaders in EFI applications from boot entries recorded in EFI variables, and additionally a hardcoded path EFI/BOOT/BOOTX64.EFI. Normally, a boot loader should be installed into a custom path and the path should be recorded in the EFI variables. The use of the hardcoded path should be avoided if possible. However, in some cases we have to use the hardcoded path:

  • The system is not booted with EFI yet, making EFI variables inaccessible.

  • The EFI firmware is 64-bit but the LFS system is 32-bit, making EFI variables inaccessible because the kernel cannot invoke EFI runtime services with a different virtual address length.

  • LFS is built for a Live USB, so we cannot rely on EFI variables, which are stored in NVRAM or EEPROM on the local machine.

  • You are unable or unwilling to install the efibootmgr for manipulating boot entries in EFI variables.

In these cases, follow these instructions to install the GRUB EFI application into the hardcoded path and make a minimal boot configuration. Otherwise it's better to skip ahead and set up the boot configuration normally.

To install GRUB with the EFI application in the hardcoded path EFI/BOOT/BOOTX64.EFI, first ensure the boot partition is mounted at /boot and the ESP is mounted at /boot/efi. Then, as the root user, run the command:

Note

This command will overwrite /boot/efi/EFI/BOOT/BOOTX64.EFI. It may break a bootloader already installed there. Back it up if you are not sure.

grub-install --target=x86_64-efi --removable

This command will install the GRUB EFI application into the hardcoded path /boot/efi/EFI/BOOT/BOOTX64.EFI, so the EFI firmware can find and load it. The remaining GRUB files are installed in the /boot/grub directory and will be loaded by BOOTX64.EFI during system boot.

Note

The EFI firmware usually prefers the EFI applications with a path stored in EFI variables to the EFI application at the hardcoded path. So you may need to invoke the boot selection menu or firmware setting interface to select the newly installed GRUB manually on the next boot. Read the manual of your motherboard or laptop to learn how.

If you've followed the instructions in this section and set up a minimal boot configuration, now skip ahead to Creating the GRUB Configuration File.

Mount the EFI Variable File System

The installation of GRUB on a UEFI platform requires that the EFI Variable file system, efivarfs, is mounted. As the root user, mount it if it's not already mounted:

mountpoint /sys/firmware/efi/efivars || mount -v -t efivarfs efivarfs /sys/firmware/efi/efivars

Note

If the system is booted with UEFI and systemd, efivarfs will be mounted automatically. However, in the LFS chroot environment it still needs to be mounted manually.

Warning

If the system is not booted with UEFI, the directory /sys/firmware/efi will be missing. In this case you should boot the system in UEFI mode with the emergency boot disk or using a minimal boot configuration created as above, then mount efivarfs and continue.

Setting Up the Configuration

On UEFI based systems, GRUB works by installing an EFI application (a special kind of executable) into /boot/efi/EFI/[id]/grubx64.efi, where /boot/efi is the mount point of the ESP, and [id] is replaced with an identifier specified in the grub-install command line. GRUB will create an entry in the EFI variables containing the path EFI/[id]/grubx64.efi so the EFI firmware can find grubx64.efi and load it.

grubx64.efi is very lightweight (136 KB with GRUB-2.06) so it will not use much space in the ESP. A typical ESP size is 100 MB (for Windows boot manager, which uses about 50 MB in the ESP). Once grubx64.efi has been loaded by the firmware, it will load GRUB modules from the boot partition. The default location is /boot/grub.

As the root user, install the GRUB files into /boot/efi/EFI/LFS/grubx64.efi and /boot/grub. Then set up the boot entry in the EFI variables:

grub-install --bootloader-id=LFS --recheck

If the installation is successful, the output should be:

Installing for x86_64-efi platform.
Installation finished. No error reported.

Issue the efibootmgr | cut -f 1 command to recheck the EFI boot configuration. An example of the output is:

BootCurrent: 0000
Timeout: 1 seconds
BootOrder: 0005,0000,0002,0001,0003,0004
Boot0000* ARCH
Boot0001* UEFI:CD/DVD Drive
Boot0002* Windows Boot Manager
Boot0003* UEFI:Removable Device
Boot0004* UEFI:Network Device
Boot0005* LFS

Note that 0005 is the first in the BootOrder, and Boot0005 is LFS. This means that on the next boot, the version of GRUB installed by LFS will be used to boot the system.

Creating the GRUB Configuration File

Generate /boot/grub/grub.cfg to configure the boot menu of GRUB:

cat > /boot/grub/grub.cfg << EOF
# Begin /boot/grub/grub.cfg
set default=0
set timeout=5

insmod part_gpt
insmod ext2
set root=(hd0,2)

insmod all_video
if loadfont /boot/grub/fonts/unicode.pf2; then
  terminal_output gfxterm
fi

menuentry "GNU/Linux, Linux 6.4.10-lfs-12.0"  {
  linux   /boot/vmlinuz-6.4.10-lfs-12.0 root=/dev/sda2 ro
}

menuentry "Firmware Setup" {
  fwsetup
}
EOF

Refer to the LFS book for the basic knowledge about the grub.cfg file. (hd0,2), sda2, and 6.4.10-lfs-12.0 must match your configuration.

The insmod all_video directive loads various modules for video support. It's needed to initialize the EFI framebuffer for the kernel to print messages correctly before the kernel GPU driver initialization.

The terminal_output gfxterm directive changes the display resolution of the GRUB menu to match your display device. It will break the rendering if the unicode.pf2 font data file is not loaded, so it's guarded by a if directive.

Note

From GRUB's perspective, the files are relative to the partitions used. If you used a separate /boot partition, remove /boot from the above paths (to kernel and to unicode.pf2). You will also need to change the "set root" line to point to the boot partition.

The Firmware Setup entry can be used to enter the configuration interface provided by the firmware (sometimes called BIOS configuration).

Dual-booting with Windows

Add a menu entry for Windows into grub.cfg:

cat >> /boot/grub/grub.cfg << EOF
# Begin Windows addition

menuentry "Windows 11" {
  insmod fat
  insmod chain
  set root=(hd0,1)
  chainloader /EFI/Microsoft/Boot/bootmgfw.efi
}
EOF

(hd0,1) should be replaced with the GRUB designated name for the ESP. The chainloader directive can be used to tell GRUB to run another EFI executable, in this case the Windows Boot Manager. You may put more usable tools in EFI executable format (for example, an EFI shell) into the ESP and create GRUB entries for them, as well.

Chapter 6. Text Editors

This chapter is referenced in the LFS book for those wishing to use other editors on their LFS system. You're also shown how some LFS installed programs benefit from being recompiled after GUI libraries have been installed.

Bluefish-2.2.14

Introduction to Bluefish

Bluefish is a GTK+ text editor targeted towards programmers and web designers, with many options to write websites, scripts and programming code. Bluefish supports many programming and markup languages, and it focuses on editing dynamic and interactive websites.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Bluefish Dependencies

Required

GTK+-2.24.33 or GTK+-3.24.38 (If both are installed, configure defaults to using GTK+ 3)

Recommended
Optional

enchant-2.5.0 (for spell checking), Gucharmap-15.0.4, PCRE-8.45 and Jing

Installation of Bluefish

Install Bluefish by running the following commands:

./configure --prefix=/usr --docdir=/usr/share/doc/bluefish-2.2.14 &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Note

This package installs icon files into the /usr/share/icons/hicolor hierarchy and desktop files into the /usr/share/applications hierarchy. You can improve system performance and memory usage by updating /usr/share/icons/hicolor/icon-theme.cache and /usr/share/applications/mimeinfo.cache. To perform the update you must have desktop-file-utils-0.26 (for the desktop cache) and issue the following commands as the root user:

gtk-update-icon-cache -t -f --include-image-data /usr/share/icons/hicolor &&
update-desktop-database

Contents

Installed Program: bluefish
Installed Libraries: several under /usr/lib/bluefish/
Installed Directories: /usr/lib/bluefish, /usr/share/bluefish, /usr/share/doc/bluefish-2.2.14, and /usr/share/xml/bluefish

Short Descriptions

bluefish

is a GTK+ text editor for markup and programming

Ed-1.19

Introduction to Ed

Ed is a line-oriented text editor. It is used to create, display, modify and otherwise manipulate text files, both interactively and via shell scripts. Ed isn't something which many people use. It's described here because it can be used by the patch program if you encounter an ed-based patch file. This happens rarely because diff-based patches are preferred these days.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Ed Dependencies

Required to uncompress the tarball

libarchive-3.7.1 (for bsdtar)

Installation of Ed

Install Ed by running the following commands:

./configure --prefix=/usr &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Contents

Installed Programs: ed and red
Installed Libraries: None
Installed Directories: None

Short Descriptions

ed

is a line-oriented text editor

red

is a restricted ed—it can only edit files in the current directory and cannot execute shell commands

Emacs-29.1

Introduction to Emacs

The Emacs package contains an extensible, customizable, self-documenting real-time display editor.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Emacs Dependencies

Recommended
Optional

a graphical environment, alsa-lib-1.2.9, Cairo-1.17.6, dbus-1.14.8, GConf-3.2.6, gobject-introspection-1.76.1, gsettings-desktop-schemas-44.0, GPM-1.20.7, GTK+-2.24.33 or GTK+-3.24.38, ImageMagick-7.1.1-15, Little CMS-2.14, libjpeg-turbo-3.0.0, libpng-1.6.40, librsvg-2.56.3, libseccomp-2.5.4, libwebp-1.3.1, libxml2-2.10.4, MIT Kerberos V5-1.21.2, SQLite-3.42.0, Valgrind-3.21.0, intlfonts, libungif, libotf, and m17n-lib - to correctly display such complex scripts as Indic and Khmer, and also for scripts that require Arabic shaping support (Arabic and Farsi), mailutils, and libXaw3d

Installation of Emacs

Install Emacs by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite. If make succeeds, you can test the result by running src/emacs -Q, which is the program that will be installed, with its auxiliary files. This should start and display the application opening screen.

Now, as the root user:

make install &&
chown -v -R root:root /usr/share/emacs/29.1

Note

This package installs icon files into the /usr/share/icons/hicolor hierarchy and you can improve system performance and memory usage by updating /usr/share/icons/hicolor/index.theme. To perform the update you must have GTK+-2.24.33 or GTK+-3.24.38 installed and issue the following command as the root user:

gtk-update-icon-cache -qtf /usr/share/icons/hicolor

Command Explanations

--with-imagemagick: Use this if you have installed ImageMagick-7.1.1-15 and wish to link against it.

--with-gif=no: Use this if you have not installed giflib-5.2.1 or libungif.

--with-tiff=no: Use this if you have not installed libtiff-4.5.1.

--with-gnutls=no: Use this if you have not installed GnuTLS-3.8.1.

--without-harfbuzz: Use this if you have not installed HarfBuzz-8.1.1.

--with-json=no: Use this if you have not installed jansson-2.14.

Contents

Installed Programs: ctags, ebrowse, emacs (symlink), emacs-29.1, emacsclient, and etags
Installed Libraries: None
Installed Directories: /usr/libexec/emacs and /usr/share/emacs

Short Descriptions

ctags

creates cross-reference tagfile database files for source code

ebrowse

permits browsing of C++ class hierarchies from within emacs

emacs

is an editor

emacsclient

attaches an emacs session to an already running emacsserver instance

etags

is another program to generate source code cross-reference tagfiles

Gedit-46.1

Introduction to Gedit

The Gedit package contains a lightweight UTF-8 text editor for the GNOME Desktop.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Gedit Dependencies

Required

gsettings-desktop-schemas-44.0, itstool-2.0.7, libpeas-1.36.0, libgeditsourceview-299.0.4, and tepl-6.8.0

Recommended
Optional

GTK-Doc-1.33.2, Vala-0.56.11, and zeitgeist

Installation of Gedit

First change the meson.build script so that it can accept a release build.

sed -i s/plain/release/ meson.build

Install Gedit by running the following commands:

mkdir gedit-build &&
cd    gedit-build &&

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dgtk_doc=false     \
            .. &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Note

If you installed the package to your system using a DESTDIR method, /usr/share/glib-2.0/schemas/gschemas.compiled was not updated/created. Create (or update) the file using the following command as the root user:

glib-compile-schemas /usr/share/glib-2.0/schemas

Command Explanations

-Dgtk_doc=false: This switch disables generating the API documentation. Omit this switch if you have GTK-Doc-1.33.2 installed and wish to generate the API documentation.

Contents

Installed Program: gedit
Installed Libraries: libgedit-46.so
Installed Directories: /usr/include/gedit-46 and /usr/{lib,share,share/help/*}/gedit

Short Descriptions

gedit

is a lightweight text editor integrated with the GNOME Desktop

JOE-4.6

Introduction to JOE

JOE (Joe's own editor) is a small text editor capable of emulating WordStar, Pico, and Emacs.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of JOE

Install JOE by running the following commands:

./configure --prefix=/usr     \
            --sysconfdir=/etc \
            --docdir=/usr/share/doc/joe-4.6 &&
make

This package does not come with a test suite.

Now, as the root user:

make install &&

install -vm 755 joe/util/{stringify,termidx,uniproc} /usr/bin

Configuring JOE

Config Files

/etc/joe/jmacsrc, /etc/joe/joerc, /etc/joe/jpicorc, /etc/joe/jstarrc, /etc/joe/rjoerc, and ~/.joerc

Contents

Installed Programs: jmacs, joe, jpico, jstar, rjoe, stringify, termidx, and uniproc
Installed Libraries: None
Installed Directories: /etc/joe, /usr/share/joe, and /usr/share/doc/joe-4.6

Short Descriptions

jmacs

is a symbolic link to joe used to launch Emacs emulation mode

joe

is a small text editor capable of emulating WordStar, Pico, and Emacs

jpico

is a symbolic link to joe used to launch Pico emulation mode

jstar

is a symbolic link to joe used to launch WordStar emulation mode

rjoe

is a symbolic link to joe that restricts JOE to editing only files which are specified on the command-line

stringify

is a program used by joe to convert rc and .jsf files into a C file (see /usr/share/doc/joe-4.6/util/README)

termidx

is a program used by joe to generate the termcap index file (see /usr/share/doc/joe-4.6/util/README)

uniproc

is a program used by joe to generate joe's unicode database file unicat.c from Blocks.txt CaseFolding.txt EastAsianWidth.txt and UnicodeData.txt (find them at /usr/share/doc/joe-4.6/util; see usr/share/doc/joe-4.6/util/README)

Kate-23.08.0

Introduction to Kate

The Kate package contains an advanced KF5 based graphical text editor.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Kate Dependencies

Required

KDE Frameworks-5.109.0

Optional

libgit2

Installation of Kate

Install Kate by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX  \
      -DCMAKE_BUILD_TYPE=Release          \
      -DBUILD_TESTING=OFF                 \
      -Wno-dev .. &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: kate and kwrite
Installed Libraries: Several plugins under $KF5_PREFIX/lib/plugins
Installed Directories: $KF5_PREFIX/lib/plugins/ktexteditor, $KF5_PREFIX/lib/plugins/plasma/dataengine, $KF5_PREFIX/share/doc/HTML/*/{kate,katepart,kwrite}, $KF5_PREFIX/share/{kateproject,katexmltools}, and $KF5_PREFIX/share/plasma/plasmoids/org.kde.plasma.katesessions

Short Descriptions

kate

is an advanced text editor for kde

kwrite

is a text editor for KDE, that is a light version of kate

Mousepad-0.5.10

Introduction to Mousepad

Mousepad is a simple GTK+ 3 text editor for the Xfce desktop environment.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Mousepad Dependencies

Required

gtksourceview4-4.8.4

Optional

DConf-0.40.0 (runtime) and dbus-glib-0.112

Installation of Mousepad

Install Mousepad by running the following commands:

./configure --prefix=/usr --enable-keyfile-settings &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--enable-keyfile-settings: Use the GSettings keyfile backend rather than the default DConf-0.40.0.

Contents

Installed Program: mousepad
Installed Libraries: None
Installed Directories: None

Short Descriptions

mousepad

is a simple GTK+ 3 text editor

Nano-7.2

Introduction to Nano

The Nano package contains a small, simple text editor which aims to replace Pico, the default editor in the Pine package.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Nano

Install Nano by running the following commands:

./configure --prefix=/usr     \
            --sysconfdir=/etc \
            --enable-utf8     \
            --docdir=/usr/share/doc/nano-7.2 &&
make

This package does not come with a test suite.

Now, as the root user:

make install &&
install -v -m644 doc/{nano.html,sample.nanorc} /usr/share/doc/nano-7.2

Command Explanations

--enable-utf8: This switch enables unicode support in Nano.

Configuring nano

Config Files

/etc/nanorc and ~/.nanorc

Configuration Information

Example configuration (create as a system-wide /etc/nanorc or a personal ~/.nanorc file)

set autoindent
set constantshow
set fill 72
set historylog
set multibuffer
set nohelp
set positionlog
set quickblank
set regexp

Check the sample.nanorc file in the installed documentation directory. It includes color configurations and has some documentation included in the comments.

Syntax highlighting is provided for several file types, in /usr/share/nano/ directory. E.g., for shell scripts, you can insert include /usr/share/nano/sh.nanorc in the personal or global configuration file. If you wish highlighting for all supported files, use include /usr/share/nano/*.nanorc. This include does not descend into the extra directory. Move required files one level up.

Contents

Installed Programs: nano and rnano (symlink)
Installed Libraries: None
Installed Directories: /usr/share/nano and /usr/share/doc/nano-7.2

Short Descriptions

nano

is a small, simple text editor which aims to replace Pico, the default editor in the Pine package

rnano

is a restricted mode for nano

Vim-9.0.1677

Introduction to Vim

The Vim package, which is an abbreviation for VI IMproved, contains a vi clone with extra features as compared to the original vi.

The default LFS instructions install vim as a part of the base system. If you would prefer to link vim against X, you should recompile vim to enable GUI mode. There is no need for special instructions since X support is automatically detected.

Note

The version of vim changes daily. To get the latest version, go to https://github.com/vim/vim/releases.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Vim Dependencies

Recommended
Optional

GPM-1.20.7, Lua-5.4.6, rsync-3.2.7, and Ruby-3.2.2

Installation of Vim

Note

If you recompile Vim to link against X and your X libraries are not on the root partition, you will no longer have an editor for use in emergencies. You may choose to install an additional editor, not link Vim against X, or move the current vim executable to the /bin directory under a different name such as vi.

Install Vim by running the following commands:

Note

If you intend to run the tests and have not installed Xorg in /usr, append LDFLAGS='-L$XORG_PREFIX/lib' to the configure line below.

echo '#define SYS_VIMRC_FILE  "/etc/vimrc"' >>  src/feature.h &&
echo '#define SYS_GVIMRC_FILE "/etc/gvimrc"' >> src/feature.h &&

./configure --prefix=/usr        \
            --with-features=huge \
            --enable-gui=gtk3    \
            --with-tlib=ncursesw &&
make

Note

If the global configuration file /etc/vimrc references the VIMRUNTIME environment variable, some tests may complain about being unable to find the corresponding directory and wait for user input. If this is the case, this file should be saved and removed before running the tests.

To test the results, issue: make -j1 test. Even if one of the tests fails to produce the file test.out in src/testdir, the remaining tests will still be executed. If all goes well, the log will report ALL DONE. Some tests labelled as flaky may fail occasionally and can be ignored. The tests are known to fail if the output is redirected to a file, and also if they are run in a 'screen' session.

Note

Some color tests expect to be executed under the xterm terminal emulator.

Now, as the root user:

make install

By default, Vim's documentation is installed in /usr/share/vim. The following symlink allows the documentation to be accessed via /usr/share/doc/vim-9.0.1677, making it consistent with the location of documentation for other packages:

ln -snfv ../vim/vim90/doc /usr/share/doc/vim-9.0.1677

If you wish to update the runtime files, issue the following command (requires rsync-3.2.7):

rsync -avzcP --exclude="/dos/" --exclude="/spell/" \
    ftp.nluug.nl::Vim/runtime/ ./runtime/

To install the runtime files and regenerate the tags file, as the root user issue:

make -C src installruntime &&
vim -c ":helptags /usr/share/doc/vim-9.0.1677" -c ":q"

Command Explanations

--with-features=huge: This switch enables all the additional features available in Vim, including support for multibyte characters.

--with-tlib=ncursesw: This switch forces Vim to link against the libncursesw library.

--enable-gui=no: This will prevent compilation of the GUI. Vim will still link against X, so that some features such as the client-server model or the x11-selection (clipboard) are still available.

--without-x: If you prefer not to link Vim against X, use this switch.

--enable-luainterp, --enable-perlinterp, --enable-python3interp=dynamic, --enable-tclinterp --with-tclsh=tclsh, --enable-rubyinterp: These options include the Lua, Perl, Python3, Tcl, or Ruby interpreters that allow using other application code in vim scripts. All the --enable-... options can accept =dynamic to dynamically load the interpreter when needed. This is required for Python 3 to prevent segmentation faults. For tcl, it is necessary to indicate the name of the tclsh executable, since configure only searches versioned names with old versions.

Configuring Vim

Config Files

/etc/vimrc and ~/.vimrc

Configuration Information

Vim has an integrated spell checker which you can enable by issuing the following in a vim window:

:setlocal spell spelllang=ru

This setting will enable spell checking for the Russian language for the current session.

By default, Vim only installs spell files for the English language. If a spell file is not available for a language, then Vim will call the $VIMRUNTIME/plugin/spellfile.vim plugin and will try to obtain the *.spl and optionally *.sug from the vim ftp server, by using the $VIMRUNTIME/plugin/netrwPlugin.vim plugin.

Alternatively you can manually download the *.spl and *.sug files from: ftp://ftp.vim.org/pub/vim/runtime/spell/ and save them to ~/.vim/spell or in /usr/share/vim/vim90/spell/.

To find out what's new in Vim-9.0.1677 issue the following command:

:help version-9.0.1677

For additional information on setting up Vim configuration files, see The vimrc Files and https://vim.fandom.com/wiki/Example_vimrc.

Contents

A list of the reinstalled files, along with their short descriptions can be found in the LFS Vim Installation Instructions.

Installed Programs: gview, gvim, gvimdiff, gvimtutor, rgview, and rgvim
Installed Libraries: None
Installed Directory: /usr/share/vim

Short Descriptions

gview

starts gvim in read-only mode

gvim

is the editor that runs under X and includes a GUI

gvimdiff

edits two or three versions of a file with gvim and shows the differences

gvimtutor

teaches the basic keys and commands of gvim

rgview

is a restricted version of gview

rgvim

is a restricted version of gvim

Chapter 7. Shells

We are all familiar with the Bourne Again SHell, but there are two other user interfaces that are considered useful modern shells – the Berkeley Unix C shell and the Korn shell. This chapter installs packages compatible with these additional shell types.

Dash-0.5.12

Introduction to Dash

Dash is a POSIX compliant shell. It can be installed as /bin/sh or as the default shell for either root or a second user with a userid of 0. It depends on fewer libraries than the Bash shell and is therefore less likely to be affected by an upgrade problem or disk failure. Dash is also useful for checking that a script is completely compatible with POSIX syntax.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Dash Dependencies

Optional

libedit (command line editor library)

Installation of Dash

Install Dash by running the following commands:

./configure --bindir=/bin --mandir=/usr/share/man &&
make

This package does not come with a test suite.

Now, as the root user:

make install

If you would like to make dash the default sh, recreate the /bin/sh symlink as the root user:

Note

If you create the symbolic link from dash to sh, you will need to reset the link to bash to build LFS.

ln -svf dash /bin/sh

Command Explanations

--bindir=/bin: This parameter places the dash binary into the root filesystem.

--with-libedit: To compile Dash with libedit support.

Configuring Dash

Config Files

Dash sources /etc/profile and ~/.profile

Configuration Information

Update /etc/shells to include the Dash shell by issuing the following command as the root user:

cat >> /etc/shells << "EOF"
/bin/dash
EOF

Contents

Installed Program: dash
Installed Libraries: None
Installed Directories: None

Short Description

dash

is a POSIX compliant shell

Tcsh-6.24.10

Introduction to Tcsh

The Tcsh package contains an enhanced but completely compatible version of the Berkeley Unix C shell (csh). This is useful as an alternative shell for those who prefer C syntax to that of the bash shell, and also because some programs require the C shell in order to perform installation tasks.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Tcsh

Install Tcsh by running the following commands:

./configure --prefix=/usr &&
make

To test the results, issue: make check.

Now, as the root user:

make install install.man &&

ln -v -sf tcsh   /bin/csh &&
ln -v -sf tcsh.1 /usr/share/man/man1/csh.1

Command Explanations

ln -v -sf tcsh /bin/csh: The FHS states that if there is a C shell installed, there should be a symlink from /bin/csh to it. This creates that symlink.

Configuring Tcsh

Config Files

There are numerous configuration files for the C shell. Examples of these are /etc/csh.cshrc, /etc/csh.login, /etc/csh.logout, ~/.tcshrc, ~/.cshrc, ~/.history, ~/.cshdirs, ~/.login, and ~/.logout. More information on these files can be found in the tcsh(1) man page.

Configuration Information

Update /etc/shells to include the C shell program names (as the root user):

cat >> /etc/shells << "EOF"
/bin/tcsh
/bin/csh
EOF

The following ~/.cshrc provides two alternative colour prompts and coloured ls output. If you prefer a global modification, issue the command as the root user, replacing ~/.cshrc by /etc/csh.cshrc.

cat > ~/.cshrc << "EOF"
# Original at:
# https://www.cs.umd.edu/~srhuang/teaching/code_snippets/prompt_color.tcsh.html

# Modified by the BLFS Development Team.

# Add these lines to your ~/.cshrc (or to /etc/csh.cshrc).

# Colors!
set     red="%{\033[1;31m%}"
set   green="%{\033[0;32m%}"
set  yellow="%{\033[1;33m%}"
set    blue="%{\033[1;34m%}"
set magenta="%{\033[1;35m%}"
set    cyan="%{\033[1;36m%}"
set   white="%{\033[0;37m%}"
set     end="%{\033[0m%}" # This is needed at the end...

# Setting the actual prompt.  Two separate versions for you to try, pick
# whichever one you like better, and change the colors as you want.
# Just don't mess with the ${end} guy in either line...  Comment out or
# delete the prompt you don't use.

set prompt="${green}%n${blue}@%m ${white}%~ ${green}%%${end} "
set prompt="[${green}%n${blue}@%m ${white}%~ ]${end} "

# This was not in the original URL above
# Provides coloured ls
alias ls ls --color=always

# Clean up after ourselves...
unset red green yellow blue magenta cyan yellow white end
EOF

Contents

Installed Program: tcsh
Installed Libraries: None
Installed Directory: None

Short Descriptions

tcsh

is an enhanced but completely compatible version of the Berkeley Unix C shell, csh. It is usable as both an interactive shell and a script processor

zsh-5.9

Introduction to zsh

The zsh package contains a command interpreter (shell) usable as an interactive login shell and as a shell script command processor. Of the standard shells, zsh most closely resembles ksh but includes many enhancements.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://www.zsh.org/pub/zsh-5.9.tar.xz

  • Download MD5 sum: 182e37ca3fe3fa6a44f69ad462c5c30e

  • Download size: 3.2 MB

  • Estimated disk space required: 48 MB (includes documentation and tests)

  • Estimated build time: 1.6 SBU (Using parallelism=4; includes documentation and tests)

Additional Downloads

Note

When there is a new zsh release, the old files shown above are moved to a new server directory: https://www.zsh.org/pub/old/.

zsh Dependencies

Optional

PCRE-8.45 and Valgrind-3.21.0

Installation of zsh

If you downloaded the optional documentation, unpack it with the following command:

tar --strip-components=1 -xvf ../zsh-5.9-doc.tar.xz

Install zsh by running the following commands:

./configure --prefix=/usr            \
            --sysconfdir=/etc/zsh    \
            --enable-etcdir=/etc/zsh \
            --enable-cap             \
            --enable-gdbm                             &&
make                                                  &&

makeinfo  Doc/zsh.texi --plaintext -o Doc/zsh.txt     &&
makeinfo  Doc/zsh.texi --html      -o Doc/html        &&
makeinfo  Doc/zsh.texi --html --no-split --no-headers -o Doc/zsh.html

If you have texlive-20230313 installed, you can build PDF format of the documentation by issuing the following command:

texi2pdf  Doc/zsh.texi -o Doc/zsh.pdf

To test the results, issue: make check.

Now, as the root user:

make install                              &&
make infodir=/usr/share/info install.info &&

install -v -m755 -d                 /usr/share/doc/zsh-5.9/html &&
install -v -m644 Doc/html/*         /usr/share/doc/zsh-5.9/html &&
install -v -m644 Doc/zsh.{html,txt} /usr/share/doc/zsh-5.9

If you downloaded the optional documentation, install it by issuing the following commands as the root user:

make htmldir=/usr/share/doc/zsh-5.9/html install.html &&
install -v -m644 Doc/zsh.dvi /usr/share/doc/zsh-5.9

If you built the PDF format of the documentation, install it by issuing the following command as the root user:

install -v -m644 Doc/zsh.pdf /usr/share/doc/zsh-5.9

Command Explanations

--sysconfdir=/etc/zsh and --enable-etcdir=/etc/zsh: These parameters are used so that all the zsh configuration files are consolidated into the /etc/zsh directory. Omit these parameters if you wish to retain historical compatibility by having all the files located in the /etc directory.

--enable-cap: This option enables POSIX capabilities.

--enable-gdbm: This option enables the use of the GDBM library.

--enable-pcre: This option allows zsh to use the PCRE regular expression library in shell builtins.

Configuring zsh

Config Files

There are a whole host of configuration files for zsh including /etc/zsh/zshenv, /etc/zsh/zprofile, /etc/zsh/zshrc, /etc/zsh/zlogin and /etc/zsh/zlogout. You can find more information on these in the zsh(1) and related manual pages.

The first time zsh is executed, you will be prompted by messages asking several questions. The answers will be used to create a ~/.zshrc file. If you wish to run these questions again, run zsh /usr/share/zsh/5.9/functions/zsh-newuser-install -f.

There are several built-in advanced prompts. In the zsh shell, start advanced prompt support with autoload -U promptinit, then promptinit. Available prompt names are listed with prompt -l. Select a particular one with prompt <prompt-name>. Display all available prompts with prompt -p. Except for the list and display commands above, you can insert the other ones in ~/.zshrc to be automatically executed at shell start, with the prompt you chose.

Configuration Information

Update /etc/shells to include the zsh shell program names (as the root user):

cat >> /etc/shells << "EOF"
/bin/zsh
EOF

Contents

Installed Programs: zsh and zsh-5.9 (hardlinked to each other)
Installed Libraries: Numerous plugin helper modules under /usr/lib/zsh/5.9/
Installed Directories: /usr/{lib,share}/zsh and /usr/share/doc/zsh-5.9

Short Description

zsh

is a shell which has command-line editing, built-in spelling correction, programmable command completion, shell functions (with autoloading), a history mechanism, and a host of other features

Chapter 8. Virtualization

Virtualization allows running a complete operating system, or virtual machine (VM), within another operating environment as a task. There are several commercial and open source environments that either emulate another processor or utilize the hardware virtualization features of the host processor.

qemu-8.1.0

Introduction to qemu

qemu is a full virtualization solution for Linux on x86 hardware containing virtualization extensions (Intel VT or AMD-V).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://download.qemu.org/qemu-8.1.0.tar.xz

  • Download MD5 sum: 7dd9ff5a92cf81cfce6cda1f6e271f3a

  • Download size: 118 MB

  • Estimated disk space required: 2.1 GB (366 MB installed)

  • Estimated build time: 1.2 SBU (add 0.8 SBU for tests, both using parallelism=4)

Qemu Dependencies

Required

GLib-2.76.4

Recommended
Optional

Depending on the sound system, various packages in ALSA-1.2.7, Python-3.11.4, PulseAudio-16.1, BlueZ-5.68, cURL-8.2.1, Cyrus SASL-2.1.28, GnuTLS-3.8.1, GTK+-2.24.33, GTK+-3.24.38, libusb-1.0.26, libgcrypt-1.10.2, libssh2-1.11.0, LZO-2.10, Nettle-3.9.1, Mesa-23.1.6, VTE-0.72.2 or Vte-0.28.2, and libcacard

Optional (Runtime)

Systemd-254

Optional (for building the documentation)

sphinx_rtd_theme-1.2.2

Note

This optional dependencies list is not comprehensive. See the output of ./configure --help for a more complete list.

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/qemu

KVM Prerequisites

Before building qemu, check to see if your processor supports Virtualization Technology (VT):

grep -E '^flags.*(vmx|svm)' /proc/cpuinfo

If you get any output, you have VT technology (vmx for Intel processors and svm for AMD processors). You then need to go into your system BIOS and ensure it is enabled. After enabling, reboot back to your LFS instance.

Kernel Configuration

Enable the following options in the kernel configuration and recompile the kernel if necessary:

[*] Virtualization --->                                         [VIRTUALIZATION]
  <*/M>   Kernel-based Virtual Machine (KVM) support                       [KVM]
  # Enable the option for your CPU:
  < /*/M>   KVM for Intel (and compatible) processors support        [KVM_INTEL]
  < /*/M>   KVM for AMD processors support                             [KVM_AMD]

The Intel or AMD settings are not both required, but the one matching your system processor is required.

To use the bridge network device, as explained below, check that bridge-utils-1.7.1 is installed and the following options in the kernel configuration are enabled:

[*] Networking support --->                                                [NET]
  Networking options --->
    <*/M> 802.1d Ethernet Bridging                                      [BRIDGE]

Device Drivers --->
  [*] Network device support --->                                   [NETDEVICES]
    [*]   Network core driver support                                 [NET_CORE]
    <*/M>   Universal TUN/TAP device driver support                        [TUN]

Installation of qemu

The udev rule of LFS only allows the root user, the users owning a local login session supported by the optional runtime dependency Systemd-254, or the users in the kvm group to use the KVM device. As the root user, add any non-root users that might use the KVM device either without Systemd-254 installed or remotely (via a SSH connection) to the kvm group:

usermod -a -G kvm <username>

Install qemu by running the following commands:

Note

Qemu is capable of running many targets. The build process is also capable of building multiple targets at one time in a comma delimited list assigned to --target-list. Run ./configure --help to get a complete list of available targets.

if [ $(uname -m) = i686 ]; then
   QEMU_ARCH=i386-softmmu
else
   QEMU_ARCH=x86_64-softmmu
fi


mkdir -vp build &&
cd        build &&

../configure --prefix=/usr               \
             --sysconfdir=/etc           \
             --localstatedir=/var        \
             --target-list=$QEMU_ARCH    \
             --audio-drv-list=alsa       \
             --disable-pa                \
             --enable-slirp              \
             --docdir=/usr/share/doc/qemu-8.1.0 &&

unset QEMU_ARCH &&

make

qemu uses ninja as a subprocess when building. To run the tests, issue: ninja test. One test, bios-tables-test, is known to fail.

Now, as the root user:

make install

Change the permissions and ownership of a helper script, which is needed when using the bridge network device (see below). Again as the root user, issue:

Note

You need to add any users who might use the bridge network device into the kvm group even if Systemd-254 is installed.

chgrp kvm  /usr/libexec/qemu-bridge-helper &&
chmod 4750 /usr/libexec/qemu-bridge-helper

Note

For convenience you may want to create a symbolic link to run the installed program. For instance (as the root user):

ln -sv qemu-system-`uname -m` /usr/bin/qemu

Command Explanations

--audio-drv-list=alsa --disable-pa: This switch sets the audio driver to ALSA. See below for enabling other audio drivers.

--enable-slirp: This switch forces the building system to check for Libslirp-4.7.0. Remove it if you don't need the -netdev user support.

--audio-drv-list=pa --disable-alsa: This switch sets the audio driver to pulseaudio. For other drivers see the --audio-drv-list choices in the output of ./configure --help. The default audio driver is OSS. To enable support for both alsa and pulseaudio, use --audio-drv-list=alsa,pa.

Using Qemu

Since using qemu means using a virtual computer, the steps to set up the virtual machine are in close analogy with those to set up a real computer. You'll need to decide about CPU, memory, disk, USB devices, network card(s), screen size, etc. Once the hardware is decided, you'll have for example to choose how to connect the machine to internet, and/or to install an OS. In the following, we show basic ways of performing those steps. But qemu is much more than this, and it is strongly advised to read the qemu documentation in /usr/share/doc/qemu-8.1.0/qemu-doc.html.

Note

It is standard practice to name the computer running qemu host and the emulated machine running under qemu the guest. We'll use those notations in the following.

Note

The following instructions assume the optional symbolic link, qemu, has been created. Additionally, qemu should be run in a graphical environment. But it is possible to use qemu headless or through SSH. See the documentation for the various possibilities.

Disk

A virtual disk may be set up in the following way:

VDISK_SIZE=50G
VDISK_FILENAME=vdisk.img
qemu-img create -f qcow2 $VDISK_FILENAME $VDISK_SIZE

The virtual disk size and filename should be adjusted as desired. The actual size of the file will be less than specified, but will expand as needed, so it is safe to put a high value.

Operating System

To install an operating system, download an iso image from your preferred Linux distribution. For the purposes of this example, we'll use Fedora-16-x86_64-Live-LXDE.iso in the current directory. Run the following:

qemu -enable-kvm                           \
     -drive file=$VDISK_FILENAME           \
     -cdrom Fedora-16-x86_64-Live-LXDE.iso \
     -boot d                               \
     -m 1G

Follow the normal installation procedures for the chosen distribution. The -boot option specifies the boot order of drives as a string of drive letters. Valid drive letters are: a, b (floppy 1 and 2), c (first hard disk), d (first CD-ROM). The -m option is the amount of memory to use for the virtual machine. The choice depends on the load of the host. Modern distributions should be comfortable with 1GB. The -enable-kvm option allows hardware acceleration. Without this switch, the emulation is much slower.

Defining the virtual hardware

The virtual machine hardware is defined by the qemu command line. An example command is given below:

qemu -enable-kvm                     \
     -smp 4                          \
     -cpu host                       \
     -m 1G                           \
     -drive file=$VDISK_FILENAME     \
     -cdrom grub-img.iso             \
     -boot order=c,once=d,menu=on    \
     -net nic,netdev=net0            \
     -netdev user,id=net0            \
     -device ac97                    \
     -vga std                        \
     -serial mon:stdio               \
     -name "fedora-16"

Meaning of the command line options

-enable-kvm: enable full KVM virtualization support. On some hardware, it may be necessary to add the undocumented -machine smm=off option in order to enable KVM.

-smp <N>: enable symmetric multiprocessing with <N> CPUs.

-cpu <model>: simulate CPU <model>. the list of supported models can be obtained with -cpu help.

-drive file=<filename>: defines a virtual disk whose image is stored in <filename>.

-cdrom grub-img.iso: defines an iso formatted file to use as a cdrom. Here we use a grub rescue disk, which may turn handy when something goes wrong at boot time.

-boot order=c,once=d,menu=on: defines the boot order for the virtual BIOS.

-net nic,netdev=<netid>: defines a network card connected to the network device with id <netid>.

-netdev user,id=<netid>: defines the network user device. This is a virtual local network with addresses 10.0.2.0/24, where the host has address 10.0.2.2 and acts as a gateway to internet, and with a name server at address 10.0.2.3, and an smb server at address 10.0.2.4. A builtin DHCP server can allocate addresses between 10.0.2.15 and 10.0.2.31.

-soundhw <model>: defines the soundcard model. The list may be obtained with -soundhw help.

-vga <type>: defines the type of VGA card to emulate. For -vga std, if you are building a Linux kernel for the guest, it's recommended to enable CONFIG_DRM_BOCHS (as a part of the kernel or a kernel module) to drive all the features of the emulated VGA card, and CONFIG_FB to display the Linux console on it. The other <type> values are not tested by the editors and may require additional dependencies.

-serial mon:stdio: sends the serial port of the guest (/dev/ttyS0 on linux guests), multiplexed with the qemu monitor, to the standard input and output of the qemu process.

-name <name>: sets the name of the guest. This name is displayed in the guest window caption. It may be useful if you run several guests at the same time.

-drive if=pflash,format=raw,readonly=on,file=/usr/share/qemu/edk2-x86_64-code.fd: Load a pre-built EDK2 UEFI firmware, instead of the default PC BIOS. Use this option if you want to boot the guest OS with UEFI.

-drive file=<filename>,if=virtio: Provide Virtio interface to the guest kernel for accessing the disk image, instead of simulating a real disk hardware. This can improve disk I/O performance, but it requires a Virtio driver in guest kernel. Use it instead of a plain -drive if the guest kernel supports Virtio. To build a Linux kernel with Virtio support for the guest, use make defconfig && make kvm_guest.config to create an initial kernel configuration with the Virtio drives enabled, then make your customization. And, if the guest kernel is Linux, the virtual disks using Virtio interface will be named vdx in the devtmpfs, instead of sdx.

-net nic,netdev=net0,model=virtio-net-pci: Provide Virtio interface to the guest kernel for accessing the network interface, instead of simulating a real network interface card. This can improve network I/O performance, but it requires a Virtio driver in guest kernel. Use it instead of a plain -net if the guest kernel supports Virtio.

Controlling the Emulated Display

To set the resolution of the emulated display for a Xorg server running in the guest Linux system, read the section called “Fine Tuning Display Settings”.

Networking

The above solution for networking allows the guest to access the local network through the host (and possibly to access internet through the local routers), but the converse is not true. Not even the host can access the guest, unless port forwarding is enabled. And in the case several guests are running, they cannot communicate with each other. Other network devices can be used for this purpose. For example, there is the socket device, which allows several guests to share a common virtual network. In the following, we describe in more details how to set up the bridge device, which allows the guests to appear as if connected to the local network. All the commands below should be run as the root user.

Allow the host to forward IP packets:

sysctl -w net.ipv4.ip_forward=1

To make this permanent, add the command to /etc/sysctl.d/60-net-forward.conf:

cat >> /etc/sysctl.d/60-net-forward.conf << EOF
net.ipv4.ip_forward=1
EOF

Set up a required configuration file:

install -vdm 755 /etc/qemu &&
echo allow br0 > /etc/qemu/bridge.conf

In the qemu command line above, replace the switch -netdev user,... with -netdev bridge,....

Contents

Installed Programs: elf2dmp, qemu (symlink), qemu-edid, qemu-ga, qemu-img, qemu-io, qemu-keymap, qemu-nbd, qemu-pr-helper, qemu-storage-daemon, and qemu-system-<arch>
Installed Library: None
Installed Directories: /usr/share/qemu and /usr/share/doc/qemu-8.1.0 (optional)

Short Description

elf2dmp

Converts files from elf to dmp format

qemu-edid

is a test tool for the qemu EDID generator

qemu-ga

implements support for QMP (QEMU Monitor Protocol) commands and events that terminate and originate respectively within the guest using an agent built as part of QEMU

qemu-img

provides commands to manage QEMU disk images

qemu-io

is a diagnostic and manipulation program for (virtual) memory media. It is still at an early stage of development

qemu-keymap

generates qemu reverse keymaps from xkb keymaps, which can be used with the qemu "-k" command line switch

qemu-nbd

exports Qemu disk images using the QEMU Disk Network Block Device (NBD) protocol

qemu-pr-helper

Implements the persistent reservation helper for QEMU

qemu-storage-daemon

allows to modify disk images using the QEMU Monitor Protocol (QMP) without running a VM

qemu-system-x86_64

is the QEMU PC System emulator

Part III. General Libraries and Utilities

Chapter 9. General Libraries

Libraries contain code which is often required by more than one program. This has the advantage that each program doesn't need to duplicate code (and risk introducing bugs), it just has to call functions from the libraries installed on the system. The most obvious example of a set of libraries is Glibc which is installed during the LFS book. This contains all of the C library functions which programs use.

There are two types of libraries: static and shared. Shared libraries (usually libXXX.so) are loaded into memory from the shared copy at runtime (hence the name). Static libraries ( libXXX.a) are actually linked into the program executable file itself, thus making the program file larger. Quite often, you will find both static and shared copies of the same library on your system.

Generally, you only need to install libraries when you are installing software that needs the functionality they supply. In the BLFS book, each package is presented with a list of (known) dependencies. Thus, you can figure out which libraries you need to have before installing that program. If you are installing something without using BLFS instructions, usually the README or INSTALL file will contain details of the program's requirements.

There are certain libraries which nearly everyone will need at some point. In this chapter these and some others are listed and it is explained why you may want to install them.

Apr-1.7.4

Introduction to Apr

The Apache Portable Runtime (APR) is a supporting library for the Apache web server. It provides a set of application programming interfaces (APIs) that map to the underlying Operating System (OS). Where the OS doesn't support a particular function, APR will provide an emulation. Thus programmers can use the APR to make a program portable across different platforms.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Apr

Install Apr by running the following commands:

./configure --prefix=/usr    \
            --disable-static \
            --with-installbuilddir=/usr/share/apr-1/build &&
make

To test the results, issue: make test.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Program: apr-1-config
Installed Library: libapr-1.so
Installed Directories: /usr/include/apr-1 and /usr/share/apr-1

Short Descriptions

apr-1-config

is a shell script used to retrieve information about the apr library in the system. It is typically used to compile and link against the library

libapr-1.so

is the Apache Portable Runtime library

Apr-Util-1.6.3

Introduction to Apr Util

The Apache Portable Runtime Utility Library provides a predictable and consistent interface to underlying client library interfaces. This application programming interface assures predictable if not identical behavior regardless of which libraries are available on a given platform.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Apr Util Dependencies

Required

Apr-1.7.4

Optional

Berkeley DB-5.3.28, FreeTDS, MariaDB-10.11.4 or MySQL, OpenLDAP-2.6.6, PostgreSQL-15.4, SQLite-3.42.0 and unixODBC-2.3.12

Installation of Apr Util

Install Apr Util by running the following commands:

./configure --prefix=/usr       \
            --with-apr=/usr     \
            --with-gdbm=/usr    \
            --with-openssl=/usr \
            --with-crypto &&
make

To test the results, issue: make -j1 test. One test, testdbm, is known to fail.

Now, as the root user:

make install

Command Explanations

--with-gdbm=/usr: This switch enables the apr_dbm_gdbm-1.so plugin.

--with-openssl=/usr --with-crypto: These switches enable the apr_crypto_openssl-1.so plugin.

--with-berkeley-db=/usr: If you have installed Berkeley DB-5.3.28, use this switch to compile the apr_dbm_db-1.so plugin.

--with-ldap: If you have installed OpenLDAP-2.6.6, use this switch to compile the apr_ldap.so plugin.

Contents

Installed Program: apu-1-config
Installed Library: libaprutil-1.so
Installed Directory: /usr/lib/apr-util-1

Short Descriptions

apu-1-config

is an APR-util script designed to allow easy command line access to APR-util configuration parameters

libaprutil-1.so

contains functions that provide a predictable and consistent interface to underlying client library interfaces

Aspell-0.60.8

Introduction to Aspell

The Aspell package contains an interactive spell checking program and the Aspell libraries. Aspell can either be used as a library or as an independent spell checker.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

You'll need to download at least one dictionary. The English dictionary is given as an example below. Dictionaries in many other languages can be found at https://ftp.gnu.org/gnu/aspell/dict.

Aspell Dependencies

Required

Which-2.21 (for the dictionaries)

Installation of Aspell

Install Aspell by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install &&
ln -svfn aspell-0.60 /usr/lib/aspell &&

install -v -m755 -d /usr/share/doc/aspell-0.60.8/aspell{,-dev}.html &&

install -v -m644 manual/aspell.html/* \
    /usr/share/doc/aspell-0.60.8/aspell.html &&

install -v -m644 manual/aspell-dev.html/* \
    /usr/share/doc/aspell-0.60.8/aspell-dev.html

If you do not plan to install Ispell, then copy the wrapper script ispell:

install -v -m 755 scripts/ispell /usr/bin/

If you do not plan to install Spell, then copy the wrapper script spell:

install -v -m 755 scripts/spell /usr/bin/

Command Explanations

ln -svfn aspell-0.60 /usr/lib/aspell: This command is useful for configuration of other applications, such as enchant-2.5.0.

Configuring Aspell

Configuration Information

After Aspell is installed, you must set up at least one dictionary. Install the English dictionary by running the following commands:

tar xf ../aspell6-en-2020.12.07-0.tar.bz2 &&
cd aspell6-en-2020.12.07-0                &&

./configure &&
make

Now, as the root user:

make install

Other dictionaries can be installed with the same instructions.

Contents

Installed Programs: aspell, aspell-import, precat, preunzip, prezip, prezip-bin, pspell-config, run-with-aspell, word-list-compress and optionally, ispell and spell.
Installed Libraries: libaspell.so and libpspell.so
Installed Directories: /usr/include/pspell and /usr/lib/aspell-0.60

Short Descriptions

aspell

is a utility that can function as an ispell -a replacement, as an independent spell checker, as a test utility to test out Aspell features, and as a utility for managing dictionaries

ispell

is a wrapper around aspell to invoke it in ispell compatible mode

spell

is a wrapper around aspell to invoke it in spell compatible mode

aspell-import

imports old personal dictionaries into Aspell

precat

decompresses a prezipped file to stdout

preunzip

decompresses a prezipped file

prezip

is a prefix delta compressor, used to compress sorted word lists or other similar text files

prezip-bin

is called by the various wrapper scripts to perform the actual compressing and decompressing

pspell-config

displays information about the libpspell installation, mostly for use in build scripts

run-with-aspell

is a script to help use Aspell as an ispell replacement

word-list-compress

compresses or decompresses sorted word lists for use with the Aspell spell checker

libaspell.so

contains spell checking API functions

libpspell.so

is an interface to the libaspell library. All the spell checking functionality is now in libaspell but this library is included for backward compatibility

Boost-1.83.0

Introduction to Boost

Boost provides a set of free peer-reviewed portable C++ source libraries. It includes libraries for linear algebra, pseudorandom number generation, multithreading, image processing, regular expressions and unit testing.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Boost Dependencies

Recommended
Optional

ICU-73.2 and Open MPI

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/boost

Installation of Boost

A change in this version of boost breaks the few packages which use the phoenix module when compiled with current GCC. In BLFS, that affects LibreOffice-7.6.0.3. Fix this with the following command:

sed -i '/#include.*phoenix.*tuple.hpp.*/d' \
  boost/phoenix/stl.hpp

This package can be built with several jobs running in parallel. In the instructions below, <N> stands for the number of jobs. Install Boost by running the following commands:

./bootstrap.sh --prefix=/usr --with-python=python3 &&
./b2 stage -j<N> threading=multi link=shared

To run Boost.Build's regression tests, issue pushd tools/build/test; python3 test_all.py; popd.

To run every library's regression tests, issue pushd status; ../b2; popd. A few tests may fail. They take a very long time (over 119 SBU at -j4) and use a very large amount of disk space (46 GB). You should use the -jN switch to speed them up.

Note

Boost installs many versioned directories in /usr/lib/cmake. If a new version of Boost is installed over a previous version, the older cmake directories need to be explicitly removed. To do this, run as the root user:

rm -rf /usr/lib/cmake/[Bb]oost*

before installing the new version.

Now, as the root user:

./b2 install threading=multi link=shared

Command Explanations

sed -i '/#include ...: This removes the inclusion of boost/phoenix/stl/tuple.hpp from this header-only library, allowing applications which use it to link using recent C++. An alternative is to edit /usr/include/boost/phoenix/stl.hpp if this version of boost has already been installed without this sed.

threading=multi: This parameter ensures that Boost is built with multithreading support.

link=shared: This parameter ensures that only shared libraries are created, except for libboost_exception and libboost_test_exec_monitor which are created as static. Most people will not need the static libraries, and most programs using Boost only use the headers. Omit this parameter if you do need static libraries.

--with-python=python3: This switch ensures Python3 is used if Python2 is installed.

-jN: This switch may be added to the b2 command lines, to run up to N processes in parallel.

Contents

Installed Programs: None
Installed Libraries: libboost_atomic.so, libboost_chrono.so, libboost_container.so, libboost_context.so, libboost_contract.so, libboost_coroutine.so, libboost_date_time.so, libboost_exception.a, libboost_fiber.so, libboost_filesystem.so, libboost_graph.so, libboost_iostreams.so, libboost_json.so, libboost_locale.so, libboost_log_setup.so, libboost_log.so, libboost_math_c99.so, libboost_math_c99f.so, libboost_math_c99l.so, libboost_math_tr1.so, libboost_math_tr1f.so, libboost_math_tr1l.so, libboost_nowide.so, libboost_numpy311.so, libboost_prg_exec_monitor.so, libboost_program_options.so, libboost_python311.so, libboost_random.so, libboost_regex.so, libboost_serialization.so, libboost_stacktrace_addr2line.so, libboost_stacktrace_basic.so, libboost_stacktrace_noop.so, libboost_system.so, libboost_test_exec_monitor.a, libboost_thread.so, libboost_timer.so, libboost_type_erasure.so, libboost_unit_test_framework.so, libboost_url.so, libboost_wave.so, and libboost_wserialization.so
Installed Directory: /usr/include/boost

brotli-1.0.9

Introduction to Brotli

Brotli provides a general-purpose lossless compression algorithm that compresses data using a combination of a modern variant of the LZ77 algorithm, Huffman coding and 2nd order context modeling. Its libraries are particularly used for WOFF2 fonts on webpages.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Brotli Dependencies

Recommended

Installation of Brotli

At first, fix an issue in pkg-config files:

sed -i '[email protected].@@' scripts/*.pc.in

Install brotli by running the following commands:

mkdir out &&
cd    out &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..  &&
make

To test the results, issue: make test.

Now, as the root user:

make install &&
cd ..

If desired, build and install the Python3 bindings as the root user:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD &&
pip3 install --no-index --find-links dist --no-cache-dir --no-user Brotli

Contents

Installed Programs: brotli
Installed Libraries: libbrotlicommon{-static.a,.so}, libbrotlidec{,-static.a,.so}, and libbrotlienc{,-static.a,.so}
Installed Directories: /usr/include/brotli and /usr/lib/python3.11/site-packages/Brotli-1.0.9.dist-info (if you built and installed the Python3 bindings)

Short Descriptions

brotli

can compress or decompress files, or test the integrity of compressed files

libbrotlicommon{-static.a,.so}

is the Brotli common dictionary library

libbrotlidec{-static.a,.so}

is the Brotli decoder library

libbrotlienc{-static.a,.so}

is the Brotli common encoder library

CLucene-2.3.3.4

Introduction to CLucene

CLucene is a C++ version of Lucene, a high performance text search engine.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

CLucene Dependencies

Required

CMake-3.27.2

Recommended

Installation of CLucene

Install CLucene by running the following commands:

patch -Np1 -i ../clucene-2.3.3.4-contribs_lib-1.patch &&

sed -i '/Misc.h/a #include <ctime>' src/core/CLucene/document/DateTools.cpp &&

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DBUILD_CONTRIBS_LIB=ON .. &&
make

Now, as the root user:

make install

Command Explanations

-DBUILD_CONTRIBS_LIB=ON: This cmake variable enables building the CLucene contribs library necessary for running applications that use language specific text analyzers like LibreOffice for example.

Contents

Installed Programs: None
Installed Libraries: libclucene-contribs-lib.so, libclucene-core.so, and libclucene-shared.so
Installed Directories: /usr/include/CLucene and /usr/lib/CLuceneConfig.cmake

dbus-glib-0.112

Introduction to D-Bus GLib

The D-Bus GLib package contains GLib interfaces to the D-Bus API.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

D-Bus GLib Dependencies

Required

dbus-1.14.8 and GLib-2.76.4

Optional

GTK-Doc-1.33.2

Installation of D-Bus GLib

Install D-Bus GLib by running the following commands:

./configure --prefix=/usr     \
            --sysconfdir=/etc \
            --disable-static &&
make

To test the results, issue: make check. Note that more comprehensive tests can be run by following the same method used in D-Bus instructions, which requires building the package twice.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Program: dbus-binding-tool
Installed Library: libdbus-glib-1.so
Installed Directories: /usr/share/gtk-doc/html/dbus-glib

Short Descriptions

dbus-binding-tool

is a tool used to interface with the D-Bus API

libdbus-glib-1.so

contains GLib interface functions to the D-Bus API

Double-conversion-3.3.0

Introduction to Double-conversion

The Double-conversion package contains a library that facilitates binary-to-decimal and decimal-to-binary routines for IEEE doubles.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Double-conversion Dependencies

Required

CMake-3.27.2

Installation of Double-conversion

Install Double-conversion by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DBUILD_SHARED_LIBS=ON      \
      -DBUILD_TESTING=ON          \
      ..                          &&
make

To test the results, issue: make test.

Now, as the root user:

make install

Command Explanations

-DBUILD_SHARED_LIBS=ON: This switch forces cmake to build a shared version of the library instead of the static version.

-DBUILD_TESTING=ON: This switch builds the test programs.

Contents

Installed Programs: None
Installed Libraries: libdouble-conversion.so
Installed Directories: /usr/include/double-conversion

Short Descriptions

libdouble-conversion.so

provides binary-to-decimal and decimal-to-binary routines for IEEE doubles

duktape-2.7.0

Introduction to duktape

duktape is an embeddable Javascript engine, with a focus on portability and compact footprint.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://duktape.org/duktape-2.7.0.tar.xz

  • Download MD5 sum: b3200b02ab80125b694bae887d7c1ca6

  • Download size: 1003 KB

  • Estimated disk space required: 25 MB

  • Estimated build time: 0.3 SBU

Installation of duktape

Install duktape by running the following commands:

sed -i 's/-Os/-O2/' Makefile.sharedlibrary
make -f Makefile.sharedlibrary INSTALL_PREFIX=/usr

Now, as the root user:

make -f Makefile.sharedlibrary INSTALL_PREFIX=/usr install

Contents

Installed Programs: None
Installed Libraries: libduktape.so and libduktaped.so
Installed Directories: None

Short Descriptions

libduktape.so

is an embeddable Javascript engine

enchant-2.5.0

Introduction to enchant

The enchant package provides a generic interface into various existing spell checking libraries.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

enchant Dependencies

Required

GLib-2.76.4

Recommended
Optional

dbus-glib-0.112, Doxygen-1.9.7, Hspell, Hunspell, Nuspell, Voikko, and unittest-cpp (required for tests)

Installation of enchant

Install enchant by running the following commands:

./configure --prefix=/usr    \
            --disable-static \
            --docdir /usr/share/doc/enchant-2.5.0 &&
make

To run tests, unittest-cpp must be installed and the --enable-relocatable option passed to configure above. If these conditions are present, the tests may be run with make check.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Configuring enchant

Config Files

~/.enchant and /usr/share/enchant/enchant.ordering

Configuration Information

You can test your installation and configuration by creating a test file and running the following commands (you can replace the en_GB dictionary by any other downloaded when installing Aspell-0.60.8):

cat > /tmp/test-enchant.txt << "EOF"
Tel me more abot linux
Ther ar so many commads
EOF

enchant-2 -d en_GB -l /tmp/test-enchant.txt &&
enchant-2 -d en_GB -a /tmp/test-enchant.txt

You will see a list of the misspelled words followed by a list of alternatives for them.

See more details in the enchant manual page.

Contents

Installed Programs: enchant-2 and enchant-lsmod-2
Installed Libraries: libenchant-2.so
Installed Directories: /usr/include/enchant-2, /usr/lib/enchant-2, /usr/share/enchant, and /usr/share/doc/enchant-2.5.0

Short Descriptions

enchant-2

is a spellchecker

enchant-lsmod-2

lists available backends, languages, and dictionaries

libenchant-2.so

contains spell checking interface API functions

Exempi-2.6.4

Introduction to Exempi

Exempi is an implementation of XMP (Adobe's Extensible Metadata Platform).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Exempi Dependencies

Required

Boost-1.83.0

Optional

Valgrind-3.21.0

Installation of Exempi

If you intend to run the regression tests, first remove a test that depends on an apparently proprietary Adobe SDK:

sed -i -r '/^\s?testadobesdk/d' exempi/Makefile.am &&
autoreconf -fiv

Install Exempi by running the following commands:

./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Program: exempi
Installed Library: libexempi.so
Installed Directory: /usr/include/exempi-2.0

Short Descriptions

exempi

is a command line tool to manipulate XMP metadata

libexempi.so

is a library used to parse XMP metadata

fftw-3.3.10

Introduction to fftw

FFTW is a C subroutine library for computing the discrete Fourier transform (DFT) in one or more dimensions, of arbitrary input size, and of both real and complex data (as well as of even/odd data, i.e. the discrete cosine/sine transforms or DCT/DST).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of fftw

Note

We build fftw three times for different libraries in different numerical precisions: the default double precision floating point, the older 32-bit (single precision) version named float which sacrifices precision for speed, and the long double which offers increased precision at the cost of slower execution.

The first build is for double precision arithmetic. Install fftw by running the following commands:

./configure --prefix=/usr    \
            --enable-shared  \
            --disable-static \
            --enable-threads \
            --enable-sse2    \
            --enable-avx     \
            --enable-avx2    &&
make

To test the results, issue: make check. On 32-bit systems, the tests can take substantially longer than they would on 64-bit machines.

Now, as the root user:

make install

Now build single precision:

make clean &&

./configure --prefix=/usr    \
            --enable-shared  \
            --disable-static \
            --enable-threads \
            --enable-sse2    \
            --enable-avx     \
            --enable-avx2    \
            --enable-float   &&
make

As the root user:

make install

Finally, build long double precision:

make clean &&

./configure --prefix=/usr    \
            --enable-shared  \
            --disable-static \
            --enable-threads \
            --enable-long-double &&
make

As the root user:

make install

Command Explanations

--enable-shared --disable-static: Use shared libs instead of static libs.

--enable-threads: This enables libfftw3_threads.so to be compiled. It is used by e.g. the gimp plugin from G'MIC.

--enable-{sse2,avx,avx2}: These enables building the optimized routines using SSE2, AVX, and AVX2 instructions. FFTW will check if these routines can be really used on the current CPU when the FFTW library is loaded, so a FFTW build with these routines enabled can still run on a CPU without SSE2, AVX, or AVX512. These options are not compatible with --enable-long-double.

--enable-float: This enables building the library that uses single precision floating point arithmetic. It is faster but less precise than the default double precision library. The library will be called libfftw3f.so needed by PulseAudio-16.1.

--enable-long-double: This enables building the library that uses higher precision long-double floating point arithmetic. The library will be called libfftw3l.so.

--enable-avx512: This enables building the optimized routines using AVX512F instructions. FFTW will check if these routines can be really used on the current CPU when the FFTW library is loaded, so a FFTW build with these routines enabled can still run on a CPU without AVX512F. Use this option if the FFTW build will be used on a CPU with AVX512F. This option is not compatible with --enable-long-double.

Contents

Installed Programs: fftw-wisdom and fftw-wisdom-to-conf
Installed Libraries: libfftw3.so, libfftw3_threads.so, libfftw3f.so, libfftw3f_threads.so, libfftw3l.so and libfftw3l_threads.so
Installed Directories: None

Short Descriptions

fftw-wisdom

is a utility to generate FFTW wisdom files, which contain saved information about how to optimally compute (Fourier) transforms of various sizes

fftw-wisdom-to-conf

is a utility to generate C configuration routines from FFTW wisdom files, where the latter contain saved information about how to optimally compute (Fourier) transforms of various sizes

libfftw3.so

is the Fast Fourier Transform library

libfftw3_threads.so

is the threaded Fast Fourier Transform library

libfftw3f.so

is the single-precision Fast Fourier Transform library, described as float for historic reasons

libfftw3f_threads.so

is the threaded single-precision Fast Fourier Transform library

libfftw3l.so

is the long double Fast Fourier Transform library

libfftw3l_threads.so

is the threaded long double Fast Fourier Transform library

GLib-2.76.4

Introduction to GLib

The GLib package contains low-level libraries useful for providing data structure handling for C, portability wrappers and interfaces for such runtime functionality as an event loop, threads, dynamic loading and an object system.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

GLib Dependencies

Recommended
Optional

dbus-1.14.8 (for some tests), Fuse-3.16.1 and bindfs (both needed for one test), GDB-13.2 (for bindings), docbook-xml-4.5, docbook-xsl-nons-1.79.2, GTK-Doc-1.33.2 (to build API documentation), glib-networking-2.76.1 (for some tests, but this is a circular dependency), and sysprof-3.48.0

Additional Runtime Dependencies

Quoted directly from the INSTALL file: Some of the mimetype-related functionality in GIO requires the update-mime-database and update-desktop-database utilities, which are part of shared-mime-info-2.2 and desktop-file-utils-0.26, respectively. These two utilities are also needed for some tests.

Installation of GLib

If desired, apply the optional patch. In many cases, applications that use this library, either directly or indirectly via other libraries such as GTK+-3.24.38, output numerous warnings when run from the command line. This patch enables the use of an environment variable, GLIB_LOG_LEVEL, that suppresses unwanted messages. The value of the variable is a digit that corresponds to:

1 Alert
2 Critical
3 Error
4 Warning
5 Notice

For instance export GLIB_LOG_LEVEL=4 will skip output of Warning and Notice messages (and Info/Debug messages if they are turned on). If GLIB_LOG_LEVEL is not defined, normal message output will not be affected.

patch -Np1 -i ../glib-skip_warnings-1.patch

Warning

If a previous version of glib is installed, move the headers out of the way so that later packages do not encounter conflicts:

if [ -e /usr/include/glib-2.0 ]; then
    rm -rf /usr/include/glib-2.0.old &&
    mv -vf /usr/include/glib-2.0{,.old}
fi

Install GLib by running the following commands:

mkdir build &&
cd    build &&

meson setup ..            \
      --prefix=/usr       \
      --buildtype=release \
      -Dman=true          &&
ninja

Note

If libxslt-1.1.38 is installed, the above command may indicate several (about 33) errors that start with "Error: no ID for constraint linkend:" when generating the man pages. These are harmless.

The GLib test suite requires desktop-file-utils for some tests. However, desktop-file-utils requires GLib in order to compile; therefore, you must first install GLib and then run the test suite.

Now, as the root user:

ninja install &&

mkdir -p /usr/share/doc/glib-2.76.4 &&
cp -r ../docs/reference/{gio,glib,gobject} /usr/share/doc/glib-2.76.4

You should now install desktop-file-utils-0.26 and shared-mime-info-2.2 and proceed to run the test suite.

Warning

Do not run the test suite as root or some tests will fail unexpectedly and leave some non-FHS-compliant directories in the /usr hierarchy.

To test the results, after having installed the package, issue: LC_ALL=C ninja test as a non-root user. One test named glib:gio / file is known to fail.

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dman=true: This switch causes the build to create and install the package man pages.

-Dgtk_doc=true: This switch causes the build to create and install the API documentation.

Contents

Installed Programs: gapplication, gdbus, gdbus-codegen, gio, gio-querymodules, glib-compile-resources, glib-compile-schemas, glib-genmarshal, glib-gettextize, glib-mkenums, gobject-query, gresource, gsettings, gtester, and gtester-report
Installed Libraries: libgio-2.0.so, libglib-2.0.so, libgmodule-2.0.so, libgobject-2.0.so, and libgthread-2.0.so
Installed Directories: /usr/include/gio-unix-2.0, /usr/include/glib-2.0, /usr/lib/gio, /usr/lib/glib-2.0, /usr/share/glib-2.0, /usr/share/doc/{glib-2.0,glib-2.76.4}, and /usr/share/gtk-doc/html/{gio,glib,gobject} (optional)

Short Descriptions

gapplication

can be used to start applications and to send messages to already-running instances of other applications

gdbus

is a simple tool used for working with D-Bus objects

gdbus-codegen

is used to generate code and/or documentation for one or more D-Bus interfaces

gio

is a utility that makes many GIO features available from the command line

gio-querymodules

is used to create a giomodule.cache file in the listed directories. This file lists the implemented extension points for each module that has been found

glib-compile-resources

is used to read the resource description from a file and the files that it references to create a binary resource bundle that is suitable for use with the GResource API

glib-compile-schemas

is used to compile all the GSettings XML schema files in a directory into a binary file with the name gschemas.compiled that can be used by GSettings

glib-genmarshal

is a C code marshaller generation utility for GLib closures

glib-gettextize

is a variant of the gettext internationalization utility

glib-mkenums

is a C language enum description generation utility

gobject-query

is a small utility that draws a tree of types

gresource

offers a simple command line interface to GResource

gsettings

offers a simple command line interface to GSettings

gtester

is a test running utility

gtester-report

is a test report formatting utility

GLib libraries

contain low-level core libraries for the GIMP Toolkit

GLibmm-2.66.5

Introduction to GLibmm

The GLibmm package is a set of C++ bindings for GLib.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GLibmm Dependencies

Required

GLib-2.76.4 and libsigc++-2.12.0

Optional

Doxygen-1.9.7, glib-networking-2.76.1 (for tests), GnuTLS-3.8.1 (for tests), libxslt-1.1.38, and mm-common

Installation of GLibmm

Install GLibmm by running the following commands:

mkdir bld &&
cd    bld &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Contents

Installed Programs: None
Installed Libraries: libgiomm-2.4.so, libglibmm-2.4.so and libglibmm_generate_extra_defs-2.4.so
Installed Directories: /usr/lib/g{io,lib}mm-2.4 and /usr/include/g{io,lib}mm-2.4

Short Descriptions

libgiomm-2.4.so

contains the GIO API classes

libglibmm-2.4.so

contains the GLib API classes

GMime-3.2.7

Introduction to GMime

The GMime package contains a set of utilities for parsing and creating messages using the Multipurpose Internet Mail Extension (MIME) as defined by the applicable RFCs. See the GMime web site for the RFCs resourced. This is useful as it provides an API which adheres to the MIME specification as closely as possible while also providing programmers with an extremely easy to use interface to the API functions.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GMime Dependencies

Required

GLib-2.76.4 and libgpg-error-1.47

Recommended
Optional

DocBook-utils-0.6.14, GPGME-1.21.0, GTK-Doc-1.33.2, libnsl-2.0.0, Vala-0.56.11, and Gtk# (requires Mono)

Installation of GMime

Install GMime by running the following commands:

./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: None
Installed Library: libgmime-3.0.so
Installed Directories: /usr/include/gmime-3.0 and /usr/share/gtk-doc/html/gmime-3.0

Short Descriptions

libgmime-3.0.so

contains API functions used by programs that need to comply to the MIME standards

gobject-introspection-1.76.1

Introduction to GObject Introspection

The GObject Introspection is used to describe the program APIs and collect them in a uniform, machine readable format.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GObject Introspection Dependencies

Required

GLib-2.76.4

Optional

Cairo-1.17.6 (required for the tests), Gjs-1.76.2 (to satisfy one test), GTK-Doc-1.33.2, Mako-1.2.4, and Markdown-3.4.1

Installation of GObject Introspection

Install GObject Introspection by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dgtk_doc=true: Build and install the documentation.

-Dcairo=enabled: Use cairo for tests.

-Ddoctool=enabled: Install g-ir-doc-tool and run related tests. You must have Mako-1.2.4 and Markdown-3.4.1 installed in order to install this utility.

Contents

Installed Program: g-ir-annotation-tool, g-ir-compiler, g-ir-doc-tool, g-ir-generate, g-ir-inspect, and g-ir-scanner
Installed Libraries: libgirepository-1.0.so and _giscanner.cpython-311-<arch>-linux-gnu.so
Installed Directories: /usr/include/gobject-introspection-1.0, /usr/lib/girepository-1.0, /usr/lib/gobject-introspection, /usr/share/gir-1.0, and /usr/share/gobject-introspection-1.0

Short Descriptions

g-ir-annotation-tool

creates or extracts annotation data from GI typelibs

g-ir-compiler

converts one or more GIR files into one or more typelib

g-ir-doc-tool

generates Mallard files that can be viewed with yelp or rendered to HTML with yelp-build from yelp-tools

g-ir-inspect

is a utility that gives information about a GI typelib

g-ir-generate

is a GIR generator that uses the repository API

g-ir-scanner

is a tool which generates GIR XML files by parsing headers and introspecting GObject based libraries

libgirepository-1.0.so

provides an API to access the typelib metadata

Gsl-2.7.1

Introduction to Gsl

The GNU Scientific Library (GSL) is a numerical library for C and C++ programmers. It provides a wide range of mathematical routines such as random number generators, special functions and least-squares fitting.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Gsl Dependencies

Optional

sphinx_rtd_theme-1.2.2

Installation of Gsl

Install Gsl by running the following commands:

./configure --prefix=/usr --disable-static &&
make

If you have sphinx_rtd_theme-1.2.2 installed, build the documentation with:

make html

To test the results, issue: make check.

Now, as the root user:

make install

If you built the documentation, install it (as root) with:

mkdir                   /usr/share/doc/gsl-2.7.1 &&
cp -R doc/_build/html/* /usr/share/doc/gsl-2.7.1

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: gsl-config, gsl-histogram, and gsl-randist
Installed Libraries: libgslcblas.so and libgsl.so
Installed Directory: /usr/include/gsl and /usr/share/doc/gsl-2.7.1

Short Descriptions

gsl-config

is a shell script to get the version number and compiler flags of the installed Gsl library

gsl-histogram

is a demonstration program for the GNU Scientific Library that computes a histogram from data taken from stdin

gsl-randist

is a demonstration program for the GNU Scientific Library that generates random samples from various distributions

libgslcblas.so

contains functions that implement a C interface to Basic Linear Algebra Subprograms

libgsl.so

contains functions that provide a collection of numerical routines for scientific computing

gspell-1.12.2

Introduction to gspell

The gspell package provides a flexible API to add spell checking to a GTK+ application.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

gspell Dependencies

Required

enchant-2.5.0, ICU-73.2, and GTK+-3.24.38

Optional

gobject-introspection-1.76.1, GTK-Doc-1.33.2, Vala-0.56.11, and Valgrind-3.21.0

Installation of gspell

Install gspell by running the following commands:

./configure --prefix=/usr &&
make

To test the results, issue: make check. The tests must be run in an X session. One test, test-checker, is known to fail if the external package Hunspell is not installed.

Now, as the root user:

make install

Contents

Installed Programs: gspell-app1
Installed Libraries: libgspell-1.so
Installed Directories: /usr/include/gspell-1 and /usr/share/gtk-doc/html/gspell-1.0

Short Descriptions

gspell-app1

checks the spelling of a text entered in a window

libgspell-1.so

is the gspell API library

ICU-73.2

Introduction to ICU

The International Components for Unicode (ICU) package is a mature, widely used set of C/C++ libraries providing Unicode and Globalization support for software applications. ICU is widely portable and gives applications the same results on all platforms.

Warning

Upgrading this package to a new major version (for example, from 72.1 to 73.2) will require rebuilding of many other packages. If some packages that use the libraries built by icu4c-73 are rebuilt, they will use the new libraries while current packages will use the previous libraries. If the Linux application loader (/usr/lib/ld-linux-x86-64.so.2) determines that both the old and new libraries are needed, and a symbol (name of data or function) exists in both versions of the library, all references to the symbol will be resolved to the version appearing earlier in the breadth-first sequence of the dependency graph. This may result in the application failing if the definition of the data or the behavior of the function referred by the symbol differs in two versions. To avoid the issue, users will need to rebuild every package linked to an ICU library as soon as possible once ICU is updated to a new major version.

To determine what external libraries are needed (directly or indirectly) by an application or a library, run:

ldd <application or library> 

or to see only the directly needed libraries:

readelf -d  <application or library> | grep NEEDED

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

ICU Dependencies

Optional

LLVM-16.0.5 (with Clang), and Doxygen-1.9.7 (for documentation)

Installation of ICU

Note

This package expands to the directory icu.

Note

If clang++ is available, it will be used in the mistaken belief that g++ might not support C++11, even though configure has tested for that. If using g++ there will be an unnecessary warning at the end of configure. Building with g++ also takes longer than the estimated SBU shown.

Install ICU by running the following commands:

cd source                                    &&

./configure --prefix=/usr                    &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Contents

Installed Programs: derb, escapesrc, genbrk, genccode, gencfu, gencmn, gencnval, gendict, gennorm2, genrb, gensprep, icu-config, icuexportdata, icuinfo, icupkg, makeconv, pkgdata, and uconv
Installed Libraries: libicudata.so, libicui18n.so, libicuio.so, libicutest.so, libicutu.so, and libicuuc.so
Installed Directories: /usr/include/unicode, /usr/lib/icu, and /usr/share/icu

Short Descriptions

derb

disassembles a resource bundle

escapesrc

converts \u escaped characters into unicode characters

genbrk

compiles ICU break iteration rules source files into binary data files

genccode

generates C or platform specific assembly code from an ICU data file

gencfu

reads in Unicode confusable character definitions and writes out the binary data

gencmn

generates an ICU memory-mappable data file

gencnval

compiles the converter's aliases file

gendict

compiles word lists into ICU string trie dictionaries

gennorm2

builds binary data files with Unicode normalization data

genrb

compiles a resource bundle

gensprep

compiles StringPrep data from filtered RFC 3454 files

icu-config

outputs ICU build options

icuinfo

outputs configuration information about the current ICU

icupkg

extracts or modifies an ICU .dat archive

makeconv

compiles a converter table

pkgdata

packages data for use by ICU

uconv

converts data from one encoding to another

libicudata.so

is the data library

libicui18n.so

is the internationalization (i18n) library

libicuio.so

is the ICU I/O (unicode stdio) library

libicutest.so

is the test library

libicutu.so

is the tool utility library

libicuuc.so

is the common library

inih-57

Introduction to inih

This package is a simple .INI file parser written in C.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of inih

Install inih by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Contents

Installed Program: None
Installed Libraries: libinih.so, libINIReader.so
Installed Directories: None

Short Descriptions

libinih.so

is the inih main library

libINIReader.so

is the inih parser library

Intel-gmmlib-22.3.10

Introduction to Intel-gmmlib

The Intel-gmmlib package contains the Intel Graphics Memory Management Library, which provides device specific memory and buffer management functions for the Intel Media Driver for VAAPI and the Intel Graphics Computer Runtime for OpenCL (TM).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Note

The tarball intel-gmmlib-22.3.10.tar.gz will extract to the directory gmmlib-intel-gmmlib-22.3.10.

Intel-gmmlib Dependencies

Required

CMake-3.27.2

Installation of Intel-gmmlib

Install Intel-gmmlib by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr   \
      -DBUILD_TYPE=Release          \
      -Wno-dev ..                   &&
make

The test suite is normally run by make unless -DRUN_TEST_SUITE=NO is passed to cmake.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: libigdgmm.so
Installed Directories: /usr/include/igdgmm

Short Descriptions

libigdgmm.so

contains functions that provide Memory Management functions for Intel Graphics Drivers

Jansson-2.14

Introduction to Jansson

The Jansson package contains a library used to encode, decode, and manipulate JSON data.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Jansson

First fix one of the tests:

sed -e "/DT/s;| sort;| sed 's/@@libjansson.*//' &;" \
    -i test/suites/api/check-exports

Install jansson by running the following commands:

./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Library: libjansson.so
Installed Directories: None

Short Descriptions

libjansson.so

contains an API for encoding, decoding, and manipulating JSON data

JS-102.13.0

Introduction to JS

JS (also referred as SpiderMonkey) is Mozilla's JavaScript and WebAssembly Engine, written in C++ and Rust. In BLFS, the source code of JS is taken from Firefox.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

JS102 Dependencies

Required

ICU-73.2, rustc-1.71.1, and Which-2.21

Recommended

Important

If you are building this package on a 32-bit system, and Clang is not installed or you're overriding the default compiler choice with the environment variable CXX, please read the Command Explanations section first.

Installation of JS

Note

Unlike most other packages in BLFS, the instructions below require you to untar firefox-102.13.0esr.tar.xz and change into the firefox-102.13.0 folder.

Extracting the tarball will reset the permissions of the current directory to 0755 if you have permission to do that. If you do this in a directory where the sticky bit is set, such as /tmp it will end with error messages:

tar: .: Cannot utime: Operation not permitted
tar: .: Cannot change mode to rwxr-xr-t: Operation not permitted
tar: Exiting with failure status due to previous errors

This does finish with non-zero status, but it does NOT mean there is a real problem. Do not untar as the root user in a directory where the sticky bit is set - that will unset it.

Install JS by running the following commands:

Note

If you are compiling this package in chroot you must do two things. First, as the root user, ensure that /dev/shm is mounted. If you do not do this, the Python configuration will fail with a traceback report referencing /usr/lib/pythonN.N/multiprocessing/synchronize.py. Run:

mountpoint -q /dev/shm || mount -t tmpfs devshm /dev/shm

Second, either as the root user export the $SHELL environment variable using export SHELL=/bin/sh or else prepend SHELL=/bin/sh when running the configure command.

Compiling the C++ code respects $MAKEFLAGS and defaults to 'j1', the rust code will use all processors.

mkdir obj &&
cd    obj &&

sh ../js/src/configure.in --prefix=/usr            \
                          --with-intl-api          \
                          --with-system-zlib       \
                          --with-system-icu        \
                          --disable-jemalloc       \
                          --disable-debug-symbols  \
                          --enable-readline        &&
make

To run the JS test suite, issue: make -C js/src check-jstests JSTESTS_EXTRA_ARGS="--timeout 300 --wpt=disabled". It's recommended to redirect the output into a log. Because we are building with system ICU, more than one hundred tests (out of a total of more than 50,000) are known to fail.

To run the JIT test suite, issue: make -C js/src check-jit-test JITTEST_EXTRA_ARGS="--timeout 300".

Caution

An issue in the installation process causes any running program which links to JS102 shared library (for example, GNOME Shell) to crash if JS102 is upgraded or reinstalled. To work around this issue, remove the old version of the JS102 shared library before installation:

rm -fv /usr/lib/libmozjs-102.so

Now, as the root user:

make install &&
rm -v /usr/lib/libjs_static.ajs &&
sed -i '/@NSPR_CFLAGS@/d' /usr/bin/js102-config

Command Explanations

sh ../js/src/configure.in: configure.in is actually a shell script, but the executable bit is not set in its permission mode so it's needed to explicitly run it with sh.

--with-intl-api: This enables the internationalization functions required by Gjs.

--with-system-*: These parameters allow the build system to use system versions of the above libraries. These are required for stability.

--enable-readline: This switch enables Readline support in the JS shell.

--disable-jemalloc: This switch disables the internal memory allocator used in JS102. jemalloc is only intended for the Firefox browser environment. For other applications using JS102, the application may crash as items allocated in the jemalloc allocator are freed on the system (glibc) allocator.

--disable-debug-symbols: Don't generate debug symbols since they are very large and most users won't need it. Remove it if you want to debug JS102.

rm -v /usr/lib/libjs_static.ajs: Remove a large static library which is not used by any BLFS package.

sed -i '/@NSPR_CFLAGS@/d' /usr/bin/js102-config: Prevent js102-config from using buggy CFLAGS.

CC=gcc CXX=g++: BLFS used to prefer to use gcc and g++ instead of upstream's defaults of the clang programs. With the release of gcc-12 the build takes longer with gcc and g++, primarily because of extra warnings, and is bigger. Pass these environment variables to the configure script if you wish to continue to use gcc, g++ (by exporting them and unset them after the installation, or simply prepending them before the sh ../js/src/configure.in command). If you are building on a 32-bit system, also see below.

CXXFLAGS="-msse2 -mfpmath=sse": Use SSE2 instead of 387 for double-precision floating-point operations. It's needed by GCC to satisfy the expectations of upstream (Mozilla) developers with floating-point arithmetic. Use it if you are building this package on a 32-bit system with GCC (if Clang is not installed or GCC is explicitly specified). Note that this will cause JS to crash on a processor without SSE2 capability. If you are running the system on such an old processor, Clang is strictly needed. This setting is not needed on 64-bit systems because all 64-bit x86 processors support SSE2 and the 64-bit compilers (both Clang and GCC) use SSE2 by default.

Contents

Installed Programs: js102 and js102-config
Installed Libraries: libmozjs-102.so
Installed Directories: /usr/include/mozjs-102

Short Descriptions

js102

provides a command line interface to the JavaScript engine

js102-config

is used to find the JS compiler and linker flags

libmozjs-102.so

contains the Mozilla JavaScript API functions

JSON-C-0.17

Introduction to JSON-C

The JSON-C implements a reference counting object model that allows you to easily construct JSON objects in C, output them as JSON formatted strings and parse JSON formatted strings back into the C representation of JSON objects.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

JSON-C Dependencies

Required

CMake-3.27.2

Optional (for documentation)

Doxygen-1.9.7 and Graphviz-8.1.0 (for dot tool)

Installation of JSON-C

Install JSON-C by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release \
      -DBUILD_STATIC_LIBS=OFF    \
      .. &&
make

If you have installed Doxygen-1.9.7 and Graphviz-8.1.0, you can build the documentation by running the following command:

doxygen doc/Doxyfile

To test the results, issue: make test.

Now, as the root user:

make install

If you built the documentation, install it by running the following commands as the root user:

install -d -vm755 /usr/share/doc/json-c-0.17 &&
install -v -m644 doc/html/* /usr/share/doc/json-c-0.17

Command Explanations

-DCMAKE_BUILD_TYPE=Release: This switch is used to apply a higher level of compiler optimizations.

Contents

Installed Programs: None
Installed Libraries: libjson-c.so
Installed Directories: /usr/include/json-c

Short Descriptions

libjson-c.so

contains the JSON-C API functions

JSON-GLib-1.6.6

Introduction to JSON GLib

The JSON GLib package is a library providing serialization and deserialization support for the JavaScript Object Notation (JSON) format described by RFC 4627.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

JSON-GLib Dependencies

Required

GLib-2.76.4

Optional (Required if building GNOME)

gobject-introspection-1.76.1

Optional

GTK-Doc-1.33.2

Installation of JSON GLib

Install JSON GLib by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dgtk_doc=disabled: Add this option if you have GTK-Doc-1.33.2 installed and do not wish to generate the API documentation.

Contents

Installed Programs: json-glib-format and json-glib-validate
Installed Library: libjson-glib-1.0.so
Installed Directories: /usr/{include,share/installed-tests}/json-glib-1.0, /usr/libexec/installed-tests/json-glib-1.6.6, and /usr/share/gtk-doc/html/json-glib

Short Descriptions

json-glib-format

is a simple command line interface to format JSON data

json-glib-validate

is a simple command line interface to validate JSON data

libjson-glib-1.0.so

contains the JSON GLib API functions

keyutils-1.6.1

Introduction to keyutils

Keyutils is a set of utilities for managing the key retention facility in the kernel, which can be used by filesystems, block devices and more to gain and retain the authorization and encryption keys required to perform secure operations.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

keyutils Dependencies

Required

MIT Kerberos V5-1.21.2

Installation of keyutils

Install keyutils by running the following commands:

sed -i 's:$(LIBDIR)/$(PKGCONFIG_DIR):/usr/lib/pkgconfig:' Makefile &&
make

To test the results, issue, as the root user:

make -k test

Note that several tests will fail if certain uncommon kernel options were not used when the kernel was built. These include CONFIG_BIG_KEYS, CONFIG_KEY_DH_OPERATIONS, and CONFIG_CRYPTO_DH.

Now, as the root user:

make NO_ARLIB=1 LIBDIR=/usr/lib BINDIR=/usr/bin SBINDIR=/usr/sbin install

Command Explanations

sed ... Makefile: This command ensures the pkgconfig file is placed in the correct directory.

NO_ARLIB=1: This make flag disables installing the static library.

Configuring keyutils

Config Files

/etc/request-key.conf and /etc/request-key.d/*

Contents

Installed Programs: keyctl, key.dns_resolver, and request-key
Installed Library: libkeyutils.so
Installed Directory: /etc/request-key.d and /usr/share/keyutils

Short Descriptions

keyctl

controls the key management facility with a variety of subcommands

key.dns_resolver

is invoked by request-key on behalf of the kernel when kernel services (such as NFS, CIFS and AFS) need to perform a hostname lookup and the kernel does not have the key cached. It is not ordinarily intended to be called directly

request-key

is invoked by the kernel when the kernel is asked for a key that it doesn't have immediately available. The kernel creates a temporary key and then calls out to this program to instantiate it. It is not intended to be called directly

libkeyutils.so

contains the keyutils library API instantiation

libaio-0.3.113

Introduction to libaio

The libaio package is an asynchronous I/O facility ("async I/O", or "aio") that has a richer API and capability set than the simple POSIX async I/O facility. This library, libaio, provides the Linux-native API for async I/O. The POSIX async I/O facility requires this library in order to provide kernel-accelerated async I/O capabilities, as do applications which require the Linux-native async I/O API.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of libaio

First, disable the installation of the static library:

sed -i '/install.*libaio.a/s/^/#/' src/Makefile

Build libaio by running the following command:

make

To test the results, issue: make partcheck.

Now, install the package as the root user:

make install

Contents

Installed Programs: None
Installed Library: libaio.so
Installed Directories: None

Short Descriptions

libaio.so

is the libaio library

libarchive-3.7.1

Introduction to libarchive

The libarchive library provides a single interface for reading/writing various compression formats.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libarchive Dependencies

Optional

libxml2-2.10.4, LZO-2.10, and Nettle-3.9.1

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/libarchive

Installation of libarchive

Install libarchive by running the following commands:

./configure --prefix=/usr --disable-static &&
make

To test the results, issue: LC_ALL=C make check.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--without-xml2: This switch sets expat for xar archive format support instead of preferred libxml2 if both packages are installed.

--without-nettle: This switch sets OpenSSL for crypto support instead of preferred Nettle if both packages are installed.

Contents

Installed Programs: bsdcat, bsdcpio, bsdtar, and bsdunzip
Installed Libraries: libarchive.so
Installed Directories: None

Short Descriptions

bsdcat

expands files to standard output

bsdcpio

is a tool similar to cpio

bsdtar

is a tool similar to GNU tar

bsdunzip

is a tool similar to Info-ZIP unzip

libarchive.so

is a library that can create and read several streaming archive formats

libassuan-2.5.6

Introduction to libassuan

The libassuan package contains an inter process communication library used by some of the other GnuPG related packages. libassuan's primary use is to allow a client to interact with a non-persistent server. libassuan is not, however, limited to use with GnuPG servers and clients. It was designed to be flexible enough to meet the demands of many transaction based environments with non-persistent servers.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libassuan Dependencies

Required

libgpg-error-1.47

Optional

texlive-20230313 (or install-tl-unx)

Installation of libassuan

Install libassuan by running the following commands:

./configure --prefix=/usr &&
make                      &&

make -C doc html                                                       &&
makeinfo --html --no-split -o doc/assuan_nochunks.html doc/assuan.texi &&
makeinfo --plaintext       -o doc/assuan.txt           doc/assuan.texi

The above commands build the documentation in html and plaintext formats. If you wish to build alternate formats of the documentation, you must have texlive-20230313 installed and issue the following commands:

make -C doc pdf ps

To test the results, issue: make check.

Now, as the root user:

make install &&

install -v -dm755   /usr/share/doc/libassuan-2.5.6/html &&
install -v -m644 doc/assuan.html/* \
                    /usr/share/doc/libassuan-2.5.6/html &&
install -v -m644 doc/assuan_nochunks.html \
                    /usr/share/doc/libassuan-2.5.6      &&
install -v -m644 doc/assuan.{txt,texi} \
                    /usr/share/doc/libassuan-2.5.6

If you built alternate formats of the documentation, install them by running the following commands as the root user:

install -v -m644  doc/assuan.{pdf,ps,dvi} \
                  /usr/share/doc/libassuan-2.5.6

Contents

Installed Program: libassuan-config
Installed Library: libassuan.so
Installed Directory: /usr/share/doc/libassuan-2.5.6

Short Descriptions

libassuan-config

is a libassuan build information script

libassuan.so

is an inter process communication library which implements the Assuan protocol

libatasmart-0.19

Introduction to libatasmart

The libatasmart package is a disk reporting library. It only supports a subset of the ATA S.M.A.R.T. functionality.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/libatasmart

Installation of libatasmart

Install libatasmart by running the following commands:

./configure --prefix=/usr --disable-static &&
make

This package does not come with a test suite.

Now, as the root user:

make docdir=/usr/share/doc/libatasmart-0.19 install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: skdump and sktest
Installed Library: libatasmart.so
Installed Directory: /usr/share/doc/libatasmart-0.19

Short Descriptions

skdump

is a utility that reports on the status of the disk

sktest

is a utility to issue disks tests

libatasmart.so

contains the ATA S.M.A.R.T API functions

libatomic_ops-7.8.0

Introduction to libatomic_ops

libatomic_ops provides implementations for atomic memory update operations on a number of architectures. This allows direct use of these in reasonably portable code. Unlike earlier similar packages, this one explicitly considers memory barrier semantics, and allows the construction of code that involves minimum overhead across a variety of architectures.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of libatomic_ops

Install libatomic_ops by running the following commands:

./configure --prefix=/usr    \
            --enable-shared  \
            --disable-static \
            --docdir=/usr/share/doc/libatomic_ops-7.8.0 &&
make

To check the results, issue make check.

Now, as the root user:

make install

Command Explanations

--enable-shared: This switch enables building of the libatomic_ops shared libraries.

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Libraries: libatomic_ops.so and libatomic_ops_gpl.so
Installed Directory: /usr/include/libatomic_ops and /usr/share/doc/libatomic_ops-7.8.0

Short Descriptions

libatomic_ops.so

contains functions for atomic memory operations

libblockdev-3.0.2

Introduction to libblockdev

libblockdev is a C library supporting GObject Introspection for manipulation of block devices. It has a plugin-based architecture where each technology (like LVM, Btrfs, MD RAID, Swap,...) is implemented in a separate plugin, possibly with multiple implementations (e.g. using LVM CLI or the new LVM DBus API).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libblockdev Dependencies

Required

GLib-2.76.4

Recommended
Optional

btrfs-progs-6.3.3, GTK-Doc-1.33.2, mdadm-4.2, parted-3.6, volume_key-0.3.12, ndctl, and targetcli (for tests)

Installation of libblockdev

Install libblockdev by running the following commands:

./configure --prefix=/usr      \
            --sysconfdir=/etc  \
            --with-python3     \
            --without-escrow   \
            --without-gtk-doc  \
            --without-lvm      \
            --without-lvm_dbus \
            --without-nvdimm   \
            --without-tools    &&
make

The test suite requires targetcli, which is not a part of BLFS.

Now, as the root user:

make install

Command Explanations

--without-escrow: This switch allows building libblockdev without volume_key-0.3.12 installed. Remove it if you've installed volume_key-0.3.12.

--without-lvm --without-lvm_dbus --without-tools: The combination of these switches allows building libblockdev without parted-3.6 installed. Remove it if you've installed parted-3.6 and wish to build the lvm-cache-stats or vfat-resize utilities, or wish libblockdev to support logical volumes.

--without-btrfs --without-mdraid --without-tools: The combination of these switches allows building libblockdev without libbytesize-2.9 installed. The --without-mdraid option will break UDisks-2.10.0, so don't use it unless you really know what you are doing.

--without-crypto: This switch allows building libblockdev without cryptsetup-2.4.3 or keyutils-1.6.1 installed. This switch will break UDisks-2.10.0, so don't use it unless you really know what you are doing.

--without-dm --without-lvm --without-lvm_dbus --without-mpath: The combination of these switches allows building libblockdev without LVM2-2.03.22 installed. The --without-dm and --without-mpath options are not in the instructions provided by the book because LVM2-2.03.22 is required for cryptsetup-2.4.3 and cryptsetup-2.4.3 is a recommended dependency of libblockdev anyway.

--without-nvme: This switch allows building libblockdev without libnvme-1.5 installed. This switch will break UDisks-2.10.0, so don't use it unless you really know what you are doing.

Contents

Installed Programs: lvm-cache-stats and vfat-resize (both optional)
Installed Libraries: libbd_btrfs.so, libbd_crypto.so, libbd_dm.so, libbd_fs.so, libbd_loop.so, libbd_lvm.so (optional), libbd_lvm-dbus.so (optional), libbd_mdraid.so, libbd_mpath.so, libbd_nvme.so, libbd_part.so, libbd_swap.so, libbd_utils.so, and libblockdev.so
Installed Directories: /etc/libblockdev, /usr/include/blockdev, and /usr/share/gtk-doc/html/libblockdev (optional)

Short Descriptions

lvm-cache-stats

prints statistics on caches on LVM Logical Volumes

vfat-resize

resizes vfat file systems

libbytesize-2.9

Introduction to libbytesize

The libbytesize package is a library which facilitates the common operations with sizes in bytes.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libbytesize Dependencies

Required

pcre2-10.42 and Pygments-2.16.1

Recommended
Optional

GTK-Doc-1.33.2, pocketlint (python module for one test), and polib (python module for one test)

Installation of libbytesize

Install libbytesize by running the following commands:

./configure --prefix=/usr &&
make

If you have the optional python modules installed, the regression tests can be run with: make check.

Now, as the root user:

make install

Contents

Installed Programs: bscalc
Installed Library: libbytesize.so
Installed Directories: /usr/include/bytesize and /usr/lib/python3.11/site-packages/bytesize

Short Descriptions

bscalc

converts from a larger unit, such as MB or TB, back to a value in bytes

libbytesize.so

contains functions used to handle common read/write operations with sizes in bytes

libcloudproviders-0.3.2

Introduction to libcloudproviders

The libcloudproviders package contains a library which provides a DBus API that allows cloud storage sync clients to expose their services.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libcloudproviders Dependencies

Required

gobject-introspection-1.76.1 and Vala-0.56.11

Optional

GTK-Doc-1.33.2

Installation of libcloudproviders

Install libcloudproviders by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Denable-gtk-doc: Use this switch if you have GTK-Doc-1.33.2 installed and wish to generate the API documentation.

Contents

Installed Programs: None
Installed Libraries: libcloudproviders.so
Installed Directories: /usr/include/cloudproviders

Short Descriptions

libcloudproviders.so

contains functions that provide a DBus API to allow cloud storage sync clients to expose their services

libdaemon-0.14

Introduction to libdaemon

The libdaemon package is a lightweight C library that eases the writing of UNIX daemons.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libdaemon Dependencies

Optional

Doxygen-1.9.7 and Lynx-2.8.9rel.1

Installation of libdaemon

Install libdaemon by running the following commands:

./configure --prefix=/usr --disable-static &&
make

If you have Doxygen installed and wish to build the API documentation, issue the following command:

make -C doc doxygen

This package does not come with a test suite.

Now, as the root user:

make docdir=/usr/share/doc/libdaemon-0.14 install

If you built the API documentation, install it using the following commands as the root user:

install -v -m755 -d /usr/share/doc/libdaemon-0.14/reference/html &&
install -v -m644 doc/reference/html/* /usr/share/doc/libdaemon-0.14/reference/html &&
install -v -m644 doc/reference/man/man3/* /usr/share/man/man3

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Library: libdaemon.so
Installed Directories: /usr/include/libdaemon and /usr/share/doc/libdaemon-0.14

Short Descriptions

libdaemon.so

contains the libdaemon API functions

libgcrypt-1.10.2

Introduction to libgcrypt

The libgcrypt package contains a general purpose crypto library based on the code used in GnuPG. The library provides a high level interface to cryptographic building blocks using an extendable and flexible API.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libgcrypt Dependencies

Required

libgpg-error-1.47

Optional

Pth-2.0.7 and texlive-20230313 (or install-tl-unx)

Installation of libgcrypt

Install libgcrypt by running the following commands:

./configure --prefix=/usr &&
make                      &&

make -C doc html                                                       &&
makeinfo --html --no-split -o doc/gcrypt_nochunks.html doc/gcrypt.texi &&
makeinfo --plaintext       -o doc/gcrypt.txt           doc/gcrypt.texi

To test the results, issue: make check.

Now, as the root user:

make install &&
install -v -dm755   /usr/share/doc/libgcrypt-1.10.2 &&
install -v -m644    README doc/{README.apichanges,fips*,libgcrypt*} \
                    /usr/share/doc/libgcrypt-1.10.2 &&

install -v -dm755   /usr/share/doc/libgcrypt-1.10.2/html &&
install -v -m644 doc/gcrypt.html/* \
                    /usr/share/doc/libgcrypt-1.10.2/html &&
install -v -m644 doc/gcrypt_nochunks.html \
                    /usr/share/doc/libgcrypt-1.10.2      &&
install -v -m644 doc/gcrypt.{txt,texi} \
                    /usr/share/doc/libgcrypt-1.10.2

Command Explanations

--with-capabilities: This option enables libcap2 support. Note that this breaks cryptsetup-2.4.3

Contents

Installed Programs: dumpsexp, hmac256, libgcrypt-config, and mpicalc
Installed Library: libgcrypt.so
Installed Directory: /usr/share/doc/libgcrypt-1.10.2

Short Descriptions

dumpsexp

is a debug tool for S-expressions

hmac256

is a standalone HMAC-SHA-256 implementation used to compute an HMAC-SHA-256 authentication code

libgcrypt-config

determines the compile and linker flags that should be used to compile and link programs that use libgcrypt

mpicalc

is a RPN (Reverse Polish Notation) calculator

libgcrypt.so

contains the cryptographic API functions

libgpg-error-1.47

Introduction to libgpg-error

The libgpg-error package contains a library that defines common error values for all GnuPG components.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of libgpg-error

Install libgpg-error by running the following commands:

./configure --prefix=/usr &&
make

To test the results, issue: make check.

Now, as the root user:

make install &&
install -v -m644 -D README /usr/share/doc/libgpg-error-1.47/README

Contents

Installed Programs: gpg-error, gpgrt-config, and yat2m
Installed Library: libgpg-error.so
Installed Directories: /usr/share/common-lisp/source/gpg-error, /usr/share/libgpg-error, and /usr/share/doc/libgpg-error-1.47

Short Descriptions

gpg-error

is used to determine libgpg-error error codes

gpgrt-config

is a pkg-config style tool for querying the information about installed version of libgpg-error

yat2m

extracts man pages from a Texinfo source

libgpg-error.so

contains the libgpg-error API functions

libgrss-0.7.0

Introduction to libgrss

The libgrss package contains a library designed to manipulate RSS and Atom feeds.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

libgrss Dependencies

Required

libsoup-2.74.3

Recommended

Installation of libgrss

Install libgrss by running the following commands:

patch -Np1 -i ../libgrss-0.7.0-bugfixes-2.patch &&
autoreconf -fv &&
./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: None
Installed Library: libgrss.so
Installed Directories: /usr/include/libgrss and /usr/share/doc/libgrss-0.7.0

Short Descriptions

libgrss.so

provides API functions for handling RSS feeds

libgsf-1.14.50

Introduction to libgsf

The libgsf package contains a library used for providing an extensible input/output abstraction layer for structured file formats.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libgsf Dependencies

Required

GLib-2.76.4 and libxml2-2.10.4

Recommended
Optional

gobject-introspection-1.76.1 and GTK-Doc-1.33.2

Installation of libgsf

Install libgsf by running the following commands:

./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check. Two tests, t1004-zip-zip64.pl and t1005-zip-nonseekable.pl are known to fail.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: gsf, gsf-office-thumbnailer, and gsf-vba-dump
Installed Library: libgsf-1.so
Installed Directories: /usr/include/libgsf-1, /usr/share/gtk-doc/html/gsf and /usr/share/thumbnailers

Short Descriptions

gsf

is a simple archive utility, somewhat similar to tar(1)

gsf-office-thumbnailer

is used internally by GNOME applications such as Nautilus to generate thumbnails of several types of office application files

gsf-vba-dump

is used to extract Visual Basic for Applications macros from files

libgsf-1.so

contains the libgsf API functions

libgudev-238

Introduction to libgudev

The libgudev package contains GObject bindings for libudev.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Required

GLib-2.76.4

Optional

gobject-introspection-1.76.1 (for gir-data, needed for GNOME), GTK-Doc-1.33.2, and umockdev-0.17.18 (for testing)

Installation of libgudev

Install libgudev by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dgtk_doc=true: Use this option if GTK-Doc is installed and you wish to build and install the API documentation.

Contents

Installed Program: None
Installed Libraries: libgudev-1.0.so
Installed Directories: /usr/include/gudev-1.0 and /usr/share/gtk-doc/html/gudev

Short Descriptions

libgudev-1.0.so

is a GObject-based wrapper library for libudev

libgusb-0.4.6

Introduction to libgusb

The libgusb package contains the GObject wrappers for libusb-1.0 that makes it easy to do asynchronous control, bulk and interrupt transfers with proper cancellation and integration into a mainloop.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libgusb Dependencies

Required

JSON-GLib-1.6.6 and libusb-1.0.26

Recommended
Optional

Gi-DocGen-2023.1

Installation of libgusb

Install libgusb by running the following commands:

mkdir build &&
cd    build &&

meson setup ..            \
      --prefix=/usr       \
      --buildtype=release \
      -Ddocs=false        &&
ninja

If you have Gi-DocGen-2023.1 installed and wish to build the API documentation for this package, issue:

sed "/output: 'libgusb'/s/'\$/-0.4.6'/" -i ../docs/meson.build &&
meson configure -Ddocs=true                                    &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Ddocs=false: Allow building this package without Gi-DocGen-2023.1 installed. If you have Gi-DocGen-2023.1 installed and you wish to rebuild and install the API documentation, a meson configure command will reset this option.

Contents

Installed Programs: gusbcmd
Installed Library: libgusb.so
Installed Directories: /usr/include/gusb-1 and /usr/share/doc/libgusb-0.4.6 (if gi-docgen is used)

Short Descriptions

gusbcmd

is a debugging tool for the libgusb library

libgusb.so

contains the libgusb API functions

libical-3.0.16

Introduction to libical

The libical package contains an implementation of the iCalendar protocols and data formats.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libical Dependencies

Required

CMake-3.27.2

Recommended
Optional

Berkeley DB-5.3.28, Doxygen-1.9.7 (for the API documentation), Graphviz-8.1.0 (for the API documentation), GTK-Doc-1.33.2 (for the API documentation), ICU-73.2, and PyGObject-3.44.1 (for some tests)

Installation of libical

Install libical by running the following commands:

Note

This package may occasionally fail when building with multiple processors. See Using Multiple Processors for more information.

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr  \
      -DCMAKE_BUILD_TYPE=Release   \
      -DSHARED_ONLY=yes            \
      -DICAL_BUILD_DOCS=false      \
      -DGOBJECT_INTROSPECTION=true \
      -DICAL_GLIB_VAPI=true        \
      .. &&
make -j1

If you have Doxygen-1.9.7, Graphviz-8.1.0, and GTK-Doc-1.33.2 installed and wish to build the API documentation, you should remove the -DICAL_BUILD_DOCS=false switch and issue:

make docs

To test the results, issue: make test.

Now, as the root user:

make install

If you have built the API documentation, install by issuing, as root user:

install -vdm755 /usr/share/doc/libical-3.0.16/html &&
cp -vr apidocs/html/* /usr/share/doc/libical-3.0.16/html

Command Explanations

-DCMAKE_BUILD_TYPE=Release: This switch is used to apply higher level of the compiler optimizations.

-DSHARED_ONLY=yes: This switch is used in order to only build the shared libraries.

-DICAL_BUILD_DOCS=false: This switch prevents building the GTK documentation. Remove if you want to build the documentation.

-DGOBJECT_INTROSPECTION=true: This switch is used to generate GObject metadata bindings.

-DICAL_GLIB_VAPI=true: This switch is used in order to build bindings for Vala-0.56.11.

-DUSE_BUILTIN_TZDATA=yes: This switch is used in order to build using your own timezone data.

Contents

Installed Programs: None
Installed Libraries: libical_cxx.so, libical.so, libical-glib.so, libicalss_cxx.so, libicalss.so, and libicalvcal.so
Installed Directory: /usr/include/libical, /usr/include/libical-glib, /usr/lib/cmake/LibIcal, /usr/libexec/libical, /usr/share/gtk-doc/html/libical-glib (optional), and /usr/share/doc/libical-3.0.16/html

Short Descriptions

libical.so

contains the libical API functions

libical_cxx.so

contains the libical C++ bindings

libical-glib.so

contains the libical glib bindings

libicalss.so

is a library that allows you to store iCal component data to disk in a variety of ways

libicalss_cxx.so

contains the libicalss C++ bindings

libicalvcal.so

is a vCard/vCalendar C interface

libidn-1.41

Introduction to libidn

libidn is a package designed for internationalized string handling based on the Stringprep, Punycode and IDNA specifications defined by the Internet Engineering Task Force (IETF) Internationalized Domain Names (IDN) working group, used for internationalized domain names. This is useful for converting data from the system's native representation into UTF-8, transforming Unicode strings into ASCII strings, allowing applications to use certain ASCII name labels (beginning with a special prefix) to represent non-ASCII name labels, and converting entire domain names to and from the ASCII Compatible Encoding (ACE) form.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libidn Dependencies

Optional

Pth-2.0.7, Emacs-29.1, GTK-Doc-1.33.2, OpenJDK-20.0.2, Valgrind-3.21.0, and Mono

Installation of libidn

Install libidn by running the following commands:

./configure --prefix=/usr --disable-static &&
make

To test the results, run:

pushd tests  &&
  make check &&
popd 

Now, as the root user:

make install &&

find doc -name "Makefile*" -delete            &&
rm -rf -v doc/{gdoc,idn.1,stamp-vti,man,texi} &&
mkdir -v       /usr/share/doc/libidn-1.41     &&
cp -r -v doc/* /usr/share/doc/libidn-1.41

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

--enable-java: Use this switch to enable building the Java implementation of libidn. Note that OpenJDK-20.0.2 must be installed to use this option.

Contents

Installed Program: idn
Installed Library: libidn.so
Installed Directories: /usr/share/doc/libidn-1.41 and /usr/share/gtk-doc/html/libidn

Short Descriptions

idn

is a command line interface to the internationalized domain name library

libidn.so

contains a generic Stringprep implementation that does Unicode 3.2 NFKC normalization, mapping and prohibition of characters, and bidirectional character handling. Profiles for Nameprep, iSCSI, SASL and XMPP are included as well as support for Punycode and ASCII Compatible Encoding (ACE) via IDNA. A mechanism to define Top-Level Domain (TLD) specific validation tables, and to compare strings against those tables, as well as default tables for some TLDs are included

libidn2-2.3.4

Introduction to libidn2

libidn2 is a package designed for internationalized string handling based on standards from the Internet Engineering Task Force (IETF)'s IDN working group, designed for internationalized domain names.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libidn2 Dependencies

Recommended
Optional

git-2.41.0 and GTK-Doc-1.33.2

Installation of libidn2

Install libidn2 by running the following commands:

./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Program: idn2
Installed Library: libidn2.so
Installed Directory: /usr/share/gtk-doc/html/libidn2

Short Descriptions

idn2

is a command line interface to the internationalized domain library

libidn2.so

contains a generic Stringprep implementation used for internationalized string handling

libiodbc-3.52.15

Introduction to libiodbc

libiodbc is an API to ODBC compatible databases.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libiodbc Dependencies

Recommended

Installation of libiodbc

Install libiodbc by running the following commands:

./configure --prefix=/usr                   \
            --with-iodbc-inidir=/etc/iodbc  \
            --includedir=/usr/include/iodbc \
            --disable-libodbc               \
            --disable-static                &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--with-iodbc-inidir=/etc/iodbc: libiodbc will install configuration files in this directory.

--includedir=/usr/include/iodbc: This installs the interface headers to a private directory to avoid a conflict with headers installed by unixODBC.

--disable-libodbc: This prevents the installation of the libodbc.so symbolic link to avoid a conflict with unixODBC.

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: iodbc-config, iodbctest, iodbctestw, and iodbcadm-gtk
Installed Libraries: libdrvproxy.so, libiodbc.so, libiodbcinst.so, and libiodbcadm.so
Installed Directory: /usr/include/iodbc, /usr/share/libiodbc, and /etc/iodbc

Short Descriptions

iodbc-config

is a utility for retrieving the installation options of libiodbc

iodbctest{,w}

are interactive SQL processors

iodbcadm-gtk

is a graphical administration utility

libksba-1.6.4

Introduction to Libksba

The Libksba package contains a library used to make X.509 certificates as well as making the CMS (Cryptographic Message Syntax) easily accessible by other applications. Both specifications are building blocks of S/MIME and TLS. The library does not rely on another cryptographic library but provides hooks for easy integration with Libgcrypt.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Libksba Dependencies

Required

libgpg-error-1.47

Optional

Valgrind-3.21.0

Installation of Libksba

Install Libksba by running the following commands:

./configure --prefix=/usr &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Contents

Installed Program: None
Installed Library: libksba.so
Installed Directory: None

Short Descriptions

libksba.{so,a}

contains the cryptographic API functions

liblinear-247

Introduction to liblinear

This package provides a library for learning linear classifiers for large scale applications. It supports Support Vector Machines (SVM) with L2 and L1 loss, logistic regression, multi class classification and also Linear Programming Machines (L1-regularized SVMs). Its computational complexity scales linearly with the number of training examples making it one of the fastest SVM solvers around.

This package is known to build and work properly using an LFS 12.0 platform.

Note

After updating this package from liblinear-1.96 or earlier, you need to reinstall Nmap-7.94, in order to link to the new library.

Package Information

Installation of liblinear

Install liblinear by running the following commands:

make lib

This package does not come with a test suite.

Now, as the root user:

install -vm644 linear.h /usr/include &&
install -vm755 liblinear.so.5 /usr/lib &&
ln -sfv liblinear.so.5 /usr/lib/liblinear.so

Contents

Installed Programs: None
Installed Library: liblinear.so
Installed Directories: None

Short Descriptions

liblinear.so

is a large linear classification library

libmbim-1.26.4

Introduction to libmbim

The libmbim package contains a GLib-based library for talking to WWAN modems and devices which speak the Mobile Interface Broadband Model (MBIM) protocol.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libmbim Dependencies

Recommended
Optional

GTK-Doc-1.33.2 and help2man

Installation of libmbim

Install libmbim by running the following commands:

./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: mbimcli and mbim-network
Installed Libraries: libmbim-glib.so
Installed Directories: /usr/include/libmbim-glib and /usr/share/gtk-doc/html/libmbim-glib

Short Descriptions

mbimcli

is an utility used to control MBIM devices

mbim-network

is an utility used for simple network management of MBIM devices

libmbim-glib.so

contains API functions for talking to WWAN modems and devices which speak the Mobile Interface Broadband Model (MBIM) protocol

libnvme-1.5

Introduction to libnvme

The libnvme package is a library which provides type definitions for NVMe specification structures, enumerations, and bit fields, helper functions to construct, dispatch, and decode commands and payloads, and utilities to connect, scan, and manage NVMe devices on a Linux system.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libnvme Dependencies

Optional

JSON-C-0.17, keyutils-1.6.1, and SWIG-4.1.1

Installation of libnvme

Install libnvme by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release -Dlibdbus=auto .. &&
ninja

To run the tests, issue: ninja test.

Now, as the root user:

ninja install

Contents

Installed Programs: None
Installed Library: libnvme.so and libnvme-mi.so
Installed Directories: /usr/include/nvme and /usr/lib/python3.11/site-packages/libnvme

Short Descriptions

libnvme.so

contains functions used to handle operations relating to NVMe devices.

libpaper-2.1.1

Introduction to libpaper

This package is intended to provide a simple way for applications to take actions based on a system or user-specified paper size.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of libpaper

Install libpaper by running the following commands:

./configure --prefix=/usr        \
            --sysconfdir=/etc    \
            --disable-static     \
            --enable-relocatable \
            --docdir=/usr/share/doc/libpaper-2.1.1 &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-relocatable: This option is needed to run the tests.

Configuring libpaper

Configuration Information

The paper size is automatically determined from the system locale; see LC_PAPER in locale(7). If you want to override it, create a papersize file in the user configuration directory. For example:

mkdir -pv ~/.config &&
echo "a4" > ~/.config/papersize

If you want to override the paper size globally (for all users), set up the PAPERSIZE environment variable. For example:

echo "PAPERSIZE=a4" > /etc/profile.d/libpaper.sh

You may use a different paper size, such as letter.

Contents

Installed Programs: paper and paperconf
Installed Library: libpaper.so
Installed Directories: /usr/share/doc/libpaper-2.1.1

Short Descriptions

paper

prints paper configuration information

paperconf

prints paper configuration information in a compatibility mode

libpaper.so

contains functions for interrogating the paper library

libportal-0.6

Introduction to libportal

The libportal package provides a library that contains GIO-style async APIs for most Flatpak portals.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libportal Dependencies

Required

gobject-introspection-1.76.1

Recommended
Optional

Gi-DocGen-2023.1 and Vala-0.56.11

Installation of libportal

Warning

If a previous version of libportal is installed, move the headers out of the way so that later packages do not encounter conflicts (as the root user):

if [ -e /usr/include/libportal ]; then
    rm -rf /usr/include/libportal.old &&
    mv -vf /usr/include/libportal{,.old}
fi

Install libportal by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release -Ddocs=false .. &&
ninja

If you have Gi-DocGen-2023.1 installed and wish to build the API documentation for this package, issue:

sed "/output/s/-1/-0.6/" -i ../doc/meson.build &&
meson configure -Ddocs=true                    &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Ddocs=false: Allow building this package without Gi-DocGen-2023.1 installed. If you have Gi-DocGen-2023.1 installed and you wish to rebuild and install the API documentation, a meson configure command will reset this option.

-Dbackends=gtk3,gtk4,qt5: This switch allows you to set the available backends. You can use it to disable the dependency on gtk-3, gtk-4, or qt-5. Most applications that use libportal will use either gtk-4 or gtk-3. The default is to build all three backends.

Contents

Installed Programs: None
Installed Libraries: libportal.so, libportal-gtk3.so, libportal-gtk4.so, and libportal-qt5.so
Installed Directories: /usr/include/libportal and /usr/share/gtk-doc/html/libportal

Short Descriptions

libportal.so

provides GIO-style async APIs for most Flatpak portals

libportal-gtk3.so

provides GTK+-3 specific functions for interacting with Flatpak portals.

libportal-gtk4.so

provides GTK-4 specific functions for interacting with Flatpak portals.

libportal-qt5.so

provides Qt5 specific functions for interacting with Flatpak portals.

libptytty-2.0

Introduction to libptytty

The libptytty package provides a library that allows for OS independent and secure pty/tty and utmp/wtmp/lastlog handling.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libptytty Dependencies

Required

CMake-3.27.2

Installation of libptytty

Install libptytty by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr     \
      -DCMAKE_BUILD_TYPE=Release      \
      -DPT_UTMP_FILE:STRING=/run/utmp \
      .. &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: libptytty.so
Installed Directories: None

Short Descriptions

libptytty.so

provides for OS independent and secure pty/tty and utmp/wtmp/lastlog handling

libqalculate-4.7.0

Introduction to libqalculate

The libqalculate package contains a library that provides functions for a multi-purpose calculator.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libqalculate Dependencies

Required

cURL-8.2.1, ICU-73.2, and libxml2-2.10.4

Optional

Doxygen-1.9.7

Installation of libqalculate

Install libqalculate by running the following commands:

./configure --prefix=/usr    \
            --disable-static \
            --docdir=/usr/share/doc/libqalculate-4.7.0 &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: qalc
Installed Library: libqalculate.so
Installed Directories: /usr/include/libqalculate, /usr/share/doc/libqalculate-4.7.0, and /usr/share/qalculate

Short Descriptions

qalc

is a powerful and easy to use command line calculator

libqalculate.so

contains the libqalculate API functions

libqmi-1.30.8

Introduction to libqmi

The libqmi package contains a GLib-based library for talking to WWAN modems and devices which speak the Qualcomm MSM Interface (QMI) protocol.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libqmi Dependencies

Required

GLib-2.76.4 and libgudev-238

Recommended
Optional

GTK-Doc-1.33.2, help2man, and libqrtr-glib

Installation of libqmi

Install libqmi by running the following commands:

PYTHON=python3 ./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

--disable-mbim-qmux: This switch disables support for using a MBIM control device for QMI messages. Use this switch if you did not install libmbim.

Contents

Installed Programs: qmicli, qmi-firmware-update, and qmi-network
Installed Libraries: libqmi-glib.so
Installed Directories: /usr/include/libqmi-glib and /usr/share/gtk-doc/html/libqmi-glib

Short Descriptions

qmicli

is an utility used to control QMI devices

qmi-firmware-update

is an utility used to perform firmware updates on QMI devices

qmi-network

is an utility used for simple network management of QMI devices

libqmi-glib.so

contains API functions for talking to WWAN modems and devices which speak the Qualcomm MSM Interface (QMI) protocol

libseccomp-2.5.4

Introduction to libseccomp

The libseccomp package provides an easy to use and platform independent interface to the Linux kernel's syscall filtering mechanism.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libseccomp Dependencies

Optional

Which-2.21 (needed for tests), Valgrind-3.21.0, and LCOV

Installation of libseccomp

Install libseccomp by running the following commands:

./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Program: scmp_sys_resolver
Installed Library: libseccomp.so
Installed Directories: None

Short Descriptions

scmp_sys_resolver

is used to resolve system calls for applications

libseccomp.so

contains API functions for translating syscalls

libsigc++-2.12.0

Introduction to libsigc++

The libsigc++ package implements a typesafe callback system for standard C++.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libsigc++ Dependencies

Recommended
Optional

DocBook-utils-0.6.14, docbook-xml-5.0, Doxygen-1.9.7, and mm-common

Installation of libsigc++

Install libsigc++ by running the following commands:

mkdir bld &&
cd    bld &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

-Dbuild-documentation=true: Use this switch if Doxygen-1.9.7 is installed and you wish to build and install the API documentation.

Contents

Installed Programs: None
Installed Library: libsigc-2.0.so
Installed Directories: /usr/{include,lib}/sigc++-2.0 and /usr/share/{devhelp/books,doc}/libsigc++-2.0 (if the documentation is enabled)

Short Descriptions

libsigc-2.0.so

contains the libsigc++ API functions

libsigsegv-2.14

Introduction to libsigsegv

libsigsegv is a library for handling page faults in user mode. A page fault occurs when a program tries to access to a region of memory that is currently not available. Catching and handling a page fault is a useful technique for implementing pageable virtual memory, memory-mapped access to persistent databases, generational garbage collectors, stack overflow handlers, and distributed shared memory.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of libsigsegv

Install libsigsegv by running the following commands:

./configure --prefix=/usr   \
            --enable-shared \
            --disable-static &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--enable-shared: This switch ensures that shared libraries are compiled.

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Library: libsigsegv.so
Installed Directories: None

Short Descriptions

libsigsegv.so

is a library for handling page faults in user mode

libssh2-1.11.0

Introduction to libssh2

Libssh2 package is a client-side C library implementing the SSH2 protocol.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libssh2 Dependencies

Optional

CMake-3.27.2 (can be used instead of the configure script), libgcrypt-1.10.2 (can be used instead of OpenSSL), OpenSSH-9.4p1 (for some tests), and Docker (for some tests)

Installation of libssh2

If you want to test the package, exclude the tests requiring a static library:

sed -E '/^DOCKER_TEST/,/^SSHD_TEST/s/test_(auth_keyboard_info.* |hostkey |simple)/$(NOTHING)/' \
    -i tests/Makefile.inc &&
autoreconf -fi

Install libssh2 by running the following commands:

./configure --prefix=/usr          \
            --disable-docker-tests \
            --disable-static       &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--disable-docker-tests: Disable the tests requiring Docker, which is beyond the scope of BLFS. Remove this switch if you've installed Docker and you wish to run the test suite.

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Library: libssh2.so
Installed Directories: None

Short Descriptions

libssh2.so

contains functions to use the SSH2 protocol

libstatgrab-0.92.1

Introduction to libstatgrab

This is a library that provides cross platform access to statistics about the system on which it's run. It's written in C and presents a selection of useful interfaces which can be used to access key system statistics. The current list of statistics includes CPU usage, memory utilisation, disk usage, process counts, network traffic, disk I/O, and more.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libstatgrab Dependencies

Optional

log4cplus-2.1.0

Installation of libstatgrab

Install libstatgrab by running the following commands:

./configure --prefix=/usr   \
            --disable-static \
            --docdir=/usr/share/doc/libstatgrab-0.92.1 &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: saidar, statgrab, statgrab-make-mrtg-config, and statgrab-make-mrtg-index
Installed Library: libstatgrab.so
Installed Directories: /usr/share/doc/libstatgrab-0.92.1

Short Descriptions

saidar

is a curses-based tool for viewing system statistics

statgrab

is a sysctl-style interface to system statistics

statgrab-make-mrtg-config

generates MRTG configuration

statgrab-make-mrtg-index

generates an XHTML index page from MRTG configuration files or stdin

libstatgrab.so

contains the libstatgrab API functions

libtasn1-4.19.0

Introduction to libtasn1

libtasn1 is a highly portable C library that encodes and decodes DER/BER data following an ASN.1 schema.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libtasn1 Dependencies

Optional

GTK-Doc-1.33.2 and Valgrind-3.21.0

Installation of libtasn1

Install libtasn1 by running the following commands:

./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check.

Now, as the root user:

make install

If you did not pass the --enable-gtk-doc parameter to the configure script, you can install the API documentation using the following command as the root user:

make -C doc/reference install-data-local

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-gtk-doc: This parameter is normally used if GTK-Doc is installed and you wish to rebuild and install the API documentation. It is broken for this package due to the use of a long deprecated gtk-doc program that is no longer available.

Contents

Installed Programs: asn1Coding, asn1Decoding and asn1Parser
Installed Library: libtasn1.so
Installed Directory: /usr/share/gtk-doc/html/libtasn1

Short Descriptions

asn1Coding

is an ASN.1 DER encoder

asn1Decoding

is an ASN.1 DER decoder

asn1Parser

is an ASN.1 syntax tree generator for libtasn1

libtasn1.so

is a library for Abstract Syntax Notation One (ASN.1) and Distinguish Encoding Rules (DER) manipulation

libunique-1.1.6

Introduction to libunique

The libunique package contains a library for writing single instance applications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

libunique Dependencies

Required

GTK+-2.24.33, also GTK-Doc-1.33.2 (for autoreconf)

Optional

gobject-introspection-1.76.1

Installation of libunique

Install libunique by running the following commands:

patch -Np1 -i ../libunique-1.1.6-upstream_fixes-1.patch &&
autoreconf -fi &&

./configure --prefix=/usr  \
            --disable-dbus \
            --disable-static &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-dbus: This switch disables D-Bus backend in favor of the GDBus backend.

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: None
Installed Library: libunique-1.0.so
Installed Directories: /usr/include/unique-1.0 and /usr/share/gtk-doc/html/unique

Short Descriptions

libunique-1.0.so

contains the libunique API functions for single instance support

libunistring-1.1

Introduction to libunistring

libunistring is a library that provides functions for manipulating Unicode strings and for manipulating C strings according to the Unicode standard.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libunistring Dependencies

Optional

texlive-20230313 (or install-tl-unx) (to rebuild the documentation)

Installation of libunistring

Install libunistring by running the following commands:

./configure --prefix=/usr    \
            --disable-static \
            --docdir=/usr/share/doc/libunistring-1.1 &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Libraries: libunistring.so
Installed Directory: /usr/include/unistring and /usr/share/doc/libunistring-1.1

Short Descriptions

libunistring.so

provides the unicode string library API

libunwind-1.6.2

Introduction to libunwind

The libunwind package contains a portable and efficient C programming interface (API) to determine the call-chain of a program. The API additionally provides the means to manipulate the preserved (callee-saved) state of each call-frame and to resume execution at any point in the call-chain (non-local goto). The API supports both local (same-process) and remote (across-process) operation.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libunwind Dependencies

Optional

texlive-20230313 (for latex2man)

Installation of libunwind

Install libunwind by running the following commands:

./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check. Two tests, run-coredump-unwind and run-coredump-unwind-mdi are known to fail.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Libraries: libunwind.so, libunwind-coredump.so, libunwind-generic.so, libunwind-ptrace.so, libunwind-setjmp.so, and libunwind-x86_64.so
Installed Directories: None

liburcu-0.14.0

Introduction to liburcu

The userspace-rcu package provides a set of userspace RCU (read-copy-update) libraries. These data synchronization libraries provide read-side access which scales linearly with the number of cores. It does so by allowing multiples copies of a given data structure to live at the same time, and by monitoring the data structure accesses to detect grace periods after which memory reclamation is possible.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of liburcu

Install liburcu by running the following commands:

./configure --prefix=/usr    \
            --disable-static \
            --docdir=/usr/share/doc/liburcu-0.14.0 &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: liburcu.so, liburcu-bp.so, liburcu-cds.so, liburcu-common.so, liburcu-mb.so, liburcu-memb.so, liburcu-qsbr.so, and liburcu-signal.so
Installed Directories: /usr/include/urcu and /usr/share/doc/liburcu-0.14.0

libusb-1.0.26

Introduction to libusb

The libusb package contains a library used by some applications for USB device access.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libusb Dependencies

Optional

Doxygen-1.9.7

Configuring Libusb

To access raw USB devices (those not treated as a disk by the mass-storage driver), appropriate support must be available in the kernel. Check your kernel configuration:

Device Drivers --->
  [*] USB support --->                                             [USB_SUPPORT]
    <*/M>   Support for Host-side USB                                      [USB]
    # These are most common USB controller drivers for PC-like systems.
    # For modern systems often [USB_XHCI_HCD] is the only one needed
    # even if the system has USB 2.0 ports:
    < /*/M> xHCI HCD (USB 3.0) support                            [USB_XHCI_HCD]
    < /*/M> EHCI HCD (USB 2.0) support                            [USB_EHCI_HCD]
    < /*/M> OHCI HCD (USB 1.1) support                            [USB_OHCI_HCD]

For more details on setting up USB devices, see the section called “USB Device Issues”.

Installation of libusb

Install libusb by running the following commands:

./configure --prefix=/usr --disable-static &&
make

If Doxygen is installed and you wish to build the API documentation, issue the following commands:

pushd doc                &&
  doxygen -u doxygen.cfg &&
  make docs              &&
popd

This package does not come with a test suite.

Now, as the root user:

make install

If you built the API documentation, install it using the following commands as the root user:

install -v -d -m755 /usr/share/doc/libusb-1.0.26/apidocs &&
install -v -m644    doc/api-1.0/* \
                    /usr/share/doc/libusb-1.0.26/apidocs

Contents

Installed Programs: None
Installed Library: libusb-1.0.so
Installed Directories: /usr/include/libusb-1.0 and /usr/share/doc/libusb-1.0.26

Short Descriptions

libusb-1.0.so

contains API functions used for accessing USB hardware

libuv-1.46.0

Introduction to libuv

The libuv package is a multi-platform support library with a focus on asynchronous I/O.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of libuv

Install libuv by running the following commands:

Caution

The sh autogen.sh command below fails if the ACLOCAL environment variable is set as specified in Xorg-7. If it is used, ACLOCAL needs to be unset for this package and then reset for other packages.

sh autogen.sh                              &&
./configure --prefix=/usr --disable-static &&
make 

If you want to run the tests, run: make check as a non-root user.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Library: libuv.so
Installed Directory: /usr/include/uv

Short Descriptions

libuv.so

contains API functions for asynchronous I/O operations

libxkbcommon-1.5.0

Introduction to libxkbcommon

libxkbcommon is a keymap compiler and support library which processes a reduced subset of keymaps as defined by the XKB specification.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libxkbcommon Dependencies

Required

xkeyboard-config-2.39 (runtime)

Recommended
Optional

Doxygen-1.9.7

Installation of libxkbcommon

Install libxkbcommon by running the following commands:

mkdir build &&
cd    build &&

meson setup ..            \
      --prefix=/usr       \
      --buildtype=release \
      -Denable-docs=false &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Denable-docs=false: This switch disables documentation generation. Remove it if Doxygen-1.9.7 is installed.

mv -v /usr/share/doc/libxkbcommon{,-1.5.0}: If you removed -Denable-docs=false, use this command to install the documentation in a versioned directory.

Contents

Installed Programs: xkbcli
Installed Libraries: libxkbcommon.so, libxkbcommon-x11.so, and libxkbregistry.so
Installed Directories: /usr/include/xkbcommon, /usr/libexec/xkbcommon, and /usr/share/doc/libxkbcommon-1.5.0

Short Descriptions

xkbcli

provides a debugger and compiler for XKB keymaps

libxkbcommon.so

contains the libxkbcommon API functions

libxkbcommon-x11.so

contains the libxkbcommon X11 specific API functions

libxkbregistry.so

contains a list of available XKB models, layouts, and variants for a given ruleset

libxml2-2.10.4

Introduction to libxml2

The libxml2 package contains libraries and utilities used for parsing XML files.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

libxml2 Dependencies

Optional

ICU-73.2 (see below) and Valgrind-3.21.0 (may be used in the tests)

Note

The old Python2 module can be built after libxml2.so has been installed, see libxml2-2.10.4 python2 module.

Installation of libxml2

Install libxml2 by running the following commands:

./configure --prefix=/usr           \
            --sysconfdir=/etc       \
            --disable-static        \
            --with-history          \
            PYTHON=/usr/bin/python3 \
            --docdir=/usr/share/doc/libxml2-2.10.4 &&
make

If you downloaded the test suite, issue the following command:

tar xf ../xmlts20130923.tar.gz

To test the results, issue: make check > check.log. A summary of the results can be obtained with grep -E '^Total|expected' check.log. If Valgrind-3.21.0 is installed and you want to check for memory leaks, replace check with check-valgrind.

Note

The tests use http://localhost/ to test parsing of external entities. If the machine where you run the tests serves as a web site, the tests may hang, depending on the content of the file served. It is therefore recommended to shut down the server during the tests, as the root user:

systemctl stop httpd.service

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--with-history: This switch enables Readline support when running xmlcatalog or xmllint in shell mode.

PYTHON=/usr/bin/python3: Allows building the libxml2 module with Python3 instead of Python2.

--with-icu: Add this switch if you have built ICU-73.2, for better unicode support.

Note

If the --with-icu switch is used, the BLFS editors recommend removing unneeded references to the ICU libraries. This will prevent many packages that use libxml2 from unnecessarily linking to the ICU libraries. This, in turn, will prevent the need for rebuilding many packages when upgrading ICU to a new major version. After installing libxml2, as the root user, issue:

rm -vf /usr/lib/libxml2.la &&
sed '/libs=/s/xml2.*/xml2"/' -i /usr/bin/xml2-config

Contents

Installed Programs: xml2-config, xmlcatalog, and xmllint
Installed Libraries: libxml2.so
Installed Directories: /usr/include/libxml2, /usr/lib/cmake/libxml2, /usr/share/doc/libxml2-2.10.4, and /usr/share/gtk-doc/html/libxml2

Short Descriptions

xml2-config

determines the compile and linker flags that should be used to compile and link programs that use libxml2

xmlcatalog

is used to monitor and manipulate XML and SGML catalogs

xmllint

parses XML files and outputs reports (based upon options) to detect errors in XML coding

libxml2.so

provides functions for programs to parse files that use the XML format

libxslt-1.1.38

Introduction to libxslt

The libxslt package contains XSLT libraries used for extending libxml2 libraries to support XSLT files.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libxslt Dependencies

Required

libxml2-2.10.4

Recommended (at runtime)

Note

Although it is not a direct dependency, many applications using libxslt will expect docbook-xml-4.5 and docbook-xsl-nons-1.79.2 to be present.

Optional

libgcrypt-1.10.2

Installation of libxslt

Install libxslt by running the following commands:

./configure --prefix=/usr                          \
            --disable-static                       \
            --docdir=/usr/share/doc/libxslt-1.1.38 \
            PYTHON=/usr/bin/python3 &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: xslt-config and xsltproc
Installed Libraries: libexslt.so, libxslt.so and optionally, libxsltmod.so Python module
Installed Directories: /usr/include/libexslt, /usr/include/libxslt, /usr/lib/libxslt-plugins, /usr/share/doc/libxslt-1.1.38, and /usr/share/doc/libxslt-python-1.1.38

Short Descriptions

xslt-config

is used to find out the pre-processor, linking and compiling flags necessary to use the libxslt libraries in 3rd-party programs

xsltproc

is used to apply XSLT stylesheets to XML documents

libexslt.so

is used to provide extensions to XSLT functions

libxslt.so

provides extensions to the libxml2 libraries to parse files that use the XSLT format

libwacom-2.7.0

Introduction to libwacom

The libwacom package contains a library used to identify wacom tablets and their model-specific features.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libwacom Dependencies

Required

libgudev-238

Recommended
Optional

Doxygen-1.9.7, git-2.41.0, librsvg-2.56.3, Valgrind-3.21.0 (optional for some tests), and pytest-7.4.0 with python-libevdev and pyudev

Installation of libwacom

Install libwacom by running the following commands:

mkdir build &&
cd    build &&

meson setup ..            \
      --prefix=/usr       \
      --buildtype=release \
      -Dtests=disabled    &&
ninja

To test the results, issue: ninja test. To run additional tests, install pytest-7.4.0, python-libevdev, and pyudev, then remove the "-Dtests=disabled" option from the meson line above.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dtests=disabled: This parameter disables some of the more advanced tests because they require pytest-7.4.0 and other two Python modules beyond the scope of BLFS to work properly.

Contents

Installed Programs: libwacom-list-devices, libwacom-list-local-devices, libwacom-show-stylus, and libwacom-update-db
Installed Libraries: libwacom.so
Installed Directories: /usr/include/libwacom-1.0 and /usr/share/libwacom

Short Descriptions

libwacom-list-devices

lists all tablet devices that are supported by libwacom

libwacom-list-local-devices

lists tablet devices that are connected to the system

libwacom-show-stylus

lists tablet stylus IDs

libwacom-update-db

updates the system according to the current set of tablet data files

libwacom.so

contains functions used for accessing Wacom information

libwpe-1.14.1

Introduction to libwpe

The libwpe package contains a general purpose library for WPE WebKit and the WPE Renderer.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libwpe Dependencies

Required

libxkbcommon-1.5.0 and Mesa-23.1.6

Optional

hotdoc

Installation of libwpe

Install libwpe by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Programs: None
Installed Libraries: libwpe-1.0.so
Installed Directories: /usr/include/wpe-1.0

Short Descriptions

libwpe-1.0.so

contains functions that provide a general purpose library for WPEWebKit and the WPE Renderer

libyaml-0.2.5

Introduction to libyaml

The yaml package contains a C library for parsing and emitting YAML (YAML Ain't Markup Language) code.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libyaml Dependencies

Optional

Doxygen-1.9.7

Installation of libyaml

Install libyaml by running the following commands:

./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Libraries: libyaml.so
Installed Directories: None

Short Descriptions

libyaml.so

contains API functions for parsing and emitting YAML code

log4cplus-2.1.0

Introduction to log4cplus

log4cplus is a simple to use C++20 logging API providing thread--safe, flexible, and arbitrarily granular control over log management and configuration. It is modeled after the Java log4j API.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

log4cplus Dependencies

Optional

Qt-5.15.10

User Notes: https://wiki.linuxfromscratch.org/blfs/wiki/log4cplus

Installation of log4cplus

Build log4cplus by running the following command:

./configure --prefix=/usr &&
make

To test the results, issue: make check.

Now, install the package as the root user:

make install

Command Explanations

--with-qt5: This option enables compilation of a separate shared library (liblog4cplusqt5debugappender) that implements Qt5DebugAppender. It requires Qt5 and pkg-config to be available.

Contents

Installed Programs: None
Installed Library: log4cplus.so
Installed Directories: None

Short Descriptions

log4cplus.so

is the log4cplus library

LZO-2.10

Introduction to LZO

LZO is a data compression library which is suitable for data decompression and compression in real-time. This means it favors speed over compression ratio.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of LZO

Install LZO by running the following commands:

./configure --prefix=/usr                    \
            --enable-shared                  \
            --disable-static                 \
            --docdir=/usr/share/doc/lzo-2.10 &&
make

To test the results, issue: make check. All the checks should pass. Now issue make test to run the full suite of tests.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Libraries: liblzo2.so
Installed Directories: /usr/include/lzo and /usr/share/doc/lzo

Short Descriptions

liblzo2.so

is a data compression and decompression library

mtdev-1.1.6

Introduction to mtdev

The mtdev package contains Multitouch Protocol Translation Library which is used to transform all variants of kernel MT (Multitouch) events to the slotted type B protocol.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of mtdev

Install mtdev by running the following commands:

./configure --prefix=/usr --disable-static &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Program: mtdev-test
Installed Library: libmtdev.so
Installed Directories: None

Short Descriptions

mtdev-test

is a tool to test libmtdev

libmtdev.so

contains Multitouch Protocol Translation API functions

Node.js-18.17.1

Introduction to Node.js

Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://nodejs.org/dist/v18.17.1/node-v18.17.1.tar.xz

  • Download MD5 sum: cfadecca2649bb74daba89d60fbd02e5

  • Download size: 39 MB

  • Estimated disk space required: 992 MB (add 25 MB for tests)

  • Estimated build time: 13 SBU (add 3.3 SBU for tests: both using parallelism=8 and 8 CPUs online, parts of the tests will use all online CPUs)

Node.js Dependencies

Required

Which-2.21

Recommended
Optional

http-parser and npm (an internal copy of npm will be installed if not present)

Installation of Node.js

Build Node.js by running the following commands:

./configure --prefix=/usr          \
            --shared-cares         \
            --shared-libuv         \
            --shared-openssl       \
            --shared-nghttp2       \
            --shared-zlib          \
            --with-intl=system-icu &&
make

To test the results, issue: make test-only. Several tests are known to fail due to behavior differences between OpenSSL-3.0 and OpenSSL-3.1.

Now, as the root user:

make install &&
ln -sf node /usr/share/doc/node-18.17.1

Command Explanations

--with-intl=system-icu: use the system version of icu. Other values are full-icu (to build a local, full icu library) and small-icu (to build a local, minimal icu library).

--shared-{cares,libuv,nghttp2,openssl,zlib}: use the system installed libraries instead of local copies.

--without-npm: do not build npm (use if you'd like to build a separate npm later).

--shared-http-parser: use the system installed library instead of a local copy.

Contents

Installed Programs: corepack, node, npm, and npx
Installed Library: None
Installed Directories: /usr/include/node, /usr/lib/node_modules/{corepack,npm}, /usr/share/doc/{node,node-18.17.1}, and /usr/share/systemtap/tapset

Short Descriptions

corepack

is an experimental tool to help with managing versions of package managers.

node

is the server-side JavaScript runtime

npm

is the Node.js package manager

/usr/lib/node_modules/npm/

is the installation root for Node.js executables and libraries

npth-1.6

Introduction to NPth

The NPth package contains a very portable POSIX/ANSI-C based library for Unix platforms which provides non-preemptive priority-based scheduling for multiple threads of execution (multithreading) inside event-driven applications. All threads run in the same address space of the server application, but each thread has its own individual program-counter, run-time stack, signal mask and errno variable.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of NPth

Install NPth by running the following commands:

./configure --prefix=/usr &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Contents

Installed Program: npth-config
Installed Library: libnpth.so
Installed Directory: None

Short Descriptions

npth-config

is a utility used to configure and build applications based on the npth library. It can be used to query the C compiler and linker flags which are required to correctly compile and link the application against the npth library

libnpth.so

contains the API functions used by the New Portable Threads Library

NSPR-4.35

Introduction to NSPR

Netscape Portable Runtime (NSPR) provides a platform-neutral API for system level and libc like functions.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of NSPR

Install NSPR by running the following commands:

cd nspr                                                     &&
sed -ri '/^RELEASE/s/^/#/' pr/src/misc/Makefile.in &&
sed -i 's#$(LIBRARY) ##'   config/rules.mk         &&

./configure --prefix=/usr \
            --with-mozilla \
            --with-pthreads \
            $([ $(uname -m) = x86_64 ] && echo --enable-64bit) &&
make

The test suite is designed for testing changes to nss or nspr and is not particularly useful for checking a released version (e.g. it needs to be run on a non-optimized build with both nss and nspr directories existing alongside each other). For further details, see the Editor Notes for nss at https://wiki.linuxfromscratch.org/blfs/wiki/nss

Now, as the root user:

make install

Command Explanations

sed -ri '/^RELEASE/s/^/#/' pr/src/misc/Makefile.in: This sed disables installing two unneeded scripts.

sed -i 's#$(LIBRARY) ##' config/rules.mk: This sed disables installing the static libraries.

--with-mozilla: This parameter adds Mozilla support to the libraries (required if you want to build any other Mozilla products and link them to these libraries).

--with-pthreads: This parameter forces use of the system pthread library.

$([ $(uname -m) = x86_64 ] && echo --enable-64bit): The --enable-64bit parameter is required on an x86_64 system to prevent configure failing with a claim that this is a system without pthread support. The [ $(uname -m) = x86_64 ] test ensures it has no effect on a 32 bit system.

Contents

Installed Programs: nspr-config
Installed Libraries: libnspr4.so, libplc4.so, and libplds4.so
Installed Directories: /usr/include/nspr

Short Descriptions

nspr-config

provides compiler and linker options to other packages that use NSPR

libnspr4.so

contains functions that provide platform independence for non-GUI operating system facilities such as threads, thread synchronization, normal file and network I/O, interval timing and calendar time, basic memory management and shared library linking

libplc4.so

contains functions that implement many of the features offered by libnspr4

libplds4.so

contains functions that provide data structures

PCRE-8.45

Introduction to PCRE

The PCRE package contains Perl Compatible Regular Expression libraries. These are useful for implementing regular expression pattern matching using the same syntax and semantics as Perl 5.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

PCRE Dependencies

Optional

Valgrind-3.21.0

Installation of PCRE

Install PCRE by running the following commands:

./configure --prefix=/usr                     \
            --docdir=/usr/share/doc/pcre-8.45 \
            --enable-unicode-properties       \
            --enable-pcre16                   \
            --enable-pcre32                   \
            --enable-pcregrep-libz            \
            --enable-pcregrep-libbz2          \
            --enable-pcretest-libreadline     \
            --disable-static                 &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--enable-unicode-properties: This switch enables Unicode properties support and includes the code for handling UTF-8/16/32 character strings in the library. You need this switch if you are going to build GLib-2.76.4.

--enable-pcre16: This switch enables 16 bit character support.

--enable-pcre32: This switch enables 32 bit character support.

--enable-pcregrep-libz: This switch adds support to pcregrep to read .gz compressed files.

--enable-pcregrep-libbz2: This switch adds support to pcregrep to read .bz2 compressed files.

--enable-pcretest-libreadline: This switch adds line editing and history features to pcretest program.

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-jit: this option enables Just-in-time compiling, which can greatly speed up pattern matching.

Contents

Installed Programs: pcregrep, pcretest, and pcre-config
Installed Libraries: libpcre.so, libpcre16.so, libpcre32.so, libpcrecpp.so and libpcreposix.so
Installed Directory: /usr/share/doc/pcre-8.45

Short Descriptions

pcregrep

is a grep that understands Perl compatible regular expressions

pcretest

can test a Perl compatible regular expression

pcre-config

is used during the compile process of programs linking to the PCRE libraries

PCRE2-10.42

Introduction to PCRE2

The PCRE2 package contains a new generation of the Perl Compatible Regular Expression libraries. These are useful for implementing regular expression pattern matching using the same syntax and semantics as Perl.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

PCRE2 Dependencies

Optional

Valgrind-3.21.0 and libedit

Installation of PCRE2

Install PCRE2 by running the following commands:

./configure --prefix=/usr                       \
            --docdir=/usr/share/doc/pcre2-10.42 \
            --enable-unicode                    \
            --enable-jit                        \
            --enable-pcre2-16                   \
            --enable-pcre2-32                   \
            --enable-pcre2grep-libz             \
            --enable-pcre2grep-libbz2           \
            --enable-pcre2test-libreadline      \
            --disable-static                    &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--enable-unicode: This switch enables Unicode support and includes the functions for handling UTF-8/16/32 character strings in the library.

--enable-pcre2-16: This switch enables 16 bit character support.

--enable-pcre2-32: This switch enables 32 bit character support.

--enable-pcre2grep-libz: This switch adds support for reading .gz compressed files to pcre2grep.

--enable-pcre2grep-libbz2: This switch adds support for reading .bz2 compressed files to pcre2grep.

--enable-pcre2test-libreadline: This switch adds line editing and history features to the pcre2test program.

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-jit: this option enables Just-in-time compiling, which can greatly speed up pattern matching.

Contents

Installed Programs: pcre2-config, pcre2grep, and pcre2test.
Installed Libraries: libpcre2-8.so, libpcre2-16.so, libpcre2-32.so, and libpcre2-posix.so
Installed Directory: /usr/share/doc/pcre2-10.42

Short Descriptions

pcre2grep

is a version of grep that understands Perl compatible regular expressions.

pcre2test

can test a Perl compatible regular expression.

pcre2-config

outputs compilation information to programs linking against the PCRE2 libraries

Popt-1.19

Introduction to Popt

The popt package contains the popt libraries which are used by some programs to parse command-line options.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

popt Dependencies

Optional

Doxygen-1.9.7 (for generating documentation)

Installation of Popt

Install popt by running the following commands:

./configure --prefix=/usr --disable-static &&
make

If you have Doxygen-1.9.7 installed and wish to build the API documentation, issue:

sed -i 's@\./@src/@' Doxyfile &&
doxygen

To test the results, issue: make check.

Now, as the root user:

make install

If you built the API documentation, install it using the following commands issued by the root user:

install -v -m755 -d /usr/share/doc/popt-1.19 &&
install -v -m644 doxygen/html/* /usr/share/doc/popt-1.19

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Library: libpopt.so
Installed Directories: /usr/share/doc/popt-1.19

Short Descriptions

libpopt.so

is used to parse command-line options

Pth-2.0.7

Introduction to Pth

The Pth package contains a very portable POSIX/ANSI-C based library for Unix platforms which provides non-preemptive priority-based scheduling for multiple threads of execution (multithreading) inside event-driven applications. All threads run in the same address space of the server application, but each thread has its own individual program-counter, run-time stack, signal mask and errno variable.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Pth Dependencies

Optional

GCC-13.2.0 (for gfortran) and libnsl-2.0.0

Installation of Pth

Caution

Don't add the --enable-pthread parameter to the configure command below else you will overwrite the pthread library and interface header installed by the Glibc package in LFS.

Install Pth by running the following commands:

sed -i 's#$(LOBJS): Makefile#$(LOBJS): pth_p.h Makefile#' Makefile.in &&
./configure --prefix=/usr           \
            --disable-static        \
            --mandir=/usr/share/man &&
make

To test the results, issue: make test.

Now, as the root user:

make install &&
install -v -m755 -d /usr/share/doc/pth-2.0.7 &&
install -v -m644    README PORTING SUPPORT TESTS \
                    /usr/share/doc/pth-2.0.7

Command Explanations

sed -i 's#$(LOBJS) ...: This sed fixes a race condition in the Makefile. It allows running make with multiple jobs (e.g., make -j4).

--disable-static: This switch prevents installation of static versions of the libraries.

--mandir=/usr/share/man: This switch puts the man pages in /usr/share/man instead of /usr/man.

Contents

Installed Program: pth-config
Installed Library: libpth.so
Installed Directory: /usr/share/doc/pth-2.0.7

Short Descriptions

pth-config

is a utility used to configure and build applications based on the pth(3) library. It can be used to query the C compiler and linker flags which are required to correctly compile and link the application against the pth(3) library

libpth.so

contains the API functions used by the GNU Portable Threads Library

Qca-2.3.7

Introduction to Qca

Qca aims to provide a straightforward and cross-platform crypto API, using Qt datatypes and conventions. Qca separates the API from the implementation, using plugins known as Providers.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Qca Dependencies

Required

make-ca-1.12, CMake-3.27.2, Qt-5.15.10, and Which-2.21

Optional

Cyrus SASL-2.1.28, GnuPG-2.4.3, libgcrypt-1.10.2, libgpg-error-1.47, nss-3.92, NSPR-4.35, p11-kit-0.25.0, Doxygen-1.9.7, Which-2.21, and Botan

Installation of Qca

Fix the location of the CA certificates:

sed -i '[email protected]@certs/ca-bundle.crt@' CMakeLists.txt

Install Qca by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=$QT5DIR            \
      -DCMAKE_BUILD_TYPE=Release                \
      -DQCA_MAN_INSTALL_DIR:PATH=/usr/share/man \
      .. &&
make

To test the results, issue make test.

Now, as the root user:

make install

Command Explanations

-DCMAKE_BUILD_TYPE=Release: This switch is used to apply a higher level of compiler optimizations.

-DQCA_MAN_INSTALL_DIR:PATH=/usr/share/man: Install the qca man page in the normal location.

Contents

Installed Programs: mozcerts-qt5 and qcatool-qt5
Installed Libraries: libqca-qt5.so, libqca-cyrus-sasl.so, libqca-gcrypt.so, libqca-gnupg.so, libqca-logger.so, libqca-nss.so, libqca-ossl.so, and libqca-softstore.so
Installed Directories: $QT5DIR/include/Qca-qt5, $QT5DIR/lib/cmake/Qca-qt5, and $QT5DIR/lib/qca-qt5

Short Descriptions

mozcerts-qt5

is a command line tool for converting certdata.txt into outfile.pem files

qcatool-qt5

is a command line tool for performing various cryptographic operations with Qca

libqca-qt5.so

is the Qt Cryptography Architecture (Qca) library

Talloc-2.4.1

Introduction to Talloc

Talloc provides a hierarchical, reference counted memory pool system with destructors. It is the core memory allocator used in Samba.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Talloc Dependencies

Optional

docbook-xml-4.5, docbook-xsl-nons-1.79.2 and libxslt-1.1.38 (To generate man pages), GDB-13.2, git-2.41.0, libnsl-2.0.0, libtirpc-1.3.3, Valgrind-3.21.0, and xfsprogs-6.4.0

Installation of Talloc

Install Talloc by running the following commands:

./configure --prefix=/usr &&
make

To check the results, issue make check.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: libpytalloc-util.cpython-311-<arch>-linux-gnu.so, libtalloc.so, and talloc.cpython-311-<arch>-linux-gnu.so (Python 3 Module)
Installed Directories: None

Short Descriptions

libtalloc.so

contains a replacement for the Glibc malloc function

telepathy-glib-0.24.2

Introduction to Telepathy GLib

The Telepathy GLib contains a library used by GLib based Telepathy components. Telepathy is a D-Bus framework for unifying real time communication, including instant messaging, voice calls and video calls. It abstracts differences between protocols to provide a unified interface for applications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Telepathy GLib Dependencies

Required

dbus-glib-0.112 and libxslt-1.1.38

Recommended
Optional

GTK-Doc-1.33.2

Installation of Telepathy Glib

If you intend to run the tests, one of them defaults to invoking /usr/bin/python and fails if it is absent, causing the second batch of tests to not run - unlike the other tests which can be overridden from the environment. Fix it with the following command:

sed -i 's%/usr/bin/python%&3%' tests/all-errors-documented.py

Install Telepathy GLib by running the following commands:

PYTHON=/usr/bin/python3 ./configure --prefix=/usr          \
                                    --enable-vala-bindings \
                                    --disable-static       &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--enable-vala-bindings: This switch enables building of the Vala bindings. Remove if you don't have Vala-0.56.11 installed.

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: None
Installed Libraries: libtelepathy-glib.so
Installed Directories: /usr/include/telepathy-1.0 and /usr/share/gtk-doc/html/telepathy-glib

Short Descriptions

libtelepathy-glib.so

contains the Telepathy GLib API functions

Uchardet-0.0.8

Introduction to Uchardet

The Uchardet package contains an encoding detectory library which takes a sequence of bytes in an unknown character encoding and attempts to determine the encoding of the text.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Uchardet Dependencies

Required

CMake-3.27.2

Installation of Uchardet

Install Uchardet by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DBUILD_STATIC=OFF          \
      -Wno-dev ..                 &&
make

To test the results, issue: make test.

Now, as the root user:

make install

Command Explanations

-DBUILD_STATIC=OFF: This switch disables building the static version of the library.

Contents

Installed Programs: uchardet
Installed Libraries: libuchardet.so
Installed Directories: /usr/include/uchardet

Short Descriptions

uchardet

detects what character set is used inside of a file

libuchardet.so

provides an API for detecting the encoding of text in a file

Umockdev-0.17.18

Introduction to Umockdev

The Umockdev package contains a framework that allows a developer to mock devices for use in unit testing.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Umockdev Dependencies

Required

libgudev-238, libpcap-1.10.4, and Vala-0.56.11

Optional

GTK-Doc-1.33.2 and libgphoto2 (optional for tests)

Installation of Umockdev

Install Umockdev by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test. One test needs to be run in an X session.

Now, as the root user:

ninja install

Command Explanations

-Dgtk_doc=true: Use this switch if you have GTK-Doc-1.33.2 installed and wish to rebuild and install the API documentation.

Contents

Installed Programs: umockdev-record, umockdev-run, and umockdev-wrapper
Installed Libraries: libumockdev-preload.so and libumockdev.so
Installed Directories: /usr/include/umockdev-1.0

Short Descriptions

umockdev-record

records Linux devices and their ancestors from sysfs/udev or records ioctls for a device

umockdev-run

runs a program under an umockdev testbed

umockdev-wrapper

wraps a program around libumockdev-preload.so.0 through LD_PRELOAD

libumockdev.so

provides API functions that allow mocking hardware devices for unit testing

Wayland-1.22.0

Introduction to Wayland

Wayland is a project to define a protocol for a compositor to talk to its clients as well as a library implementation of the protocol.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Wayland Dependencies

Required

libxml2-2.10.4

Optional

Doxygen-1.9.7, Graphviz-8.1.0 and xmlto-0.0.28 (to build the API documentation) and docbook-xml-4.5, docbook-xsl-nons-1.79.2 and libxslt-1.1.38 (to build the manual pages)

Installation of Wayland

Install Wayland by running the following commands:

mkdir build &&
cd    build &&

meson setup ..            \
      --prefix=/usr       \
      --buildtype=release \
      -Ddocumentation=false &&
ninja

To test the results, issue: env -u XDG_RUNTIME_DIR ninja test.

Now, as the root user:

ninja install

Command Explanations

-Ddocumentation=false: This switch is used to disable building of the API documentation. Remove it if you have installed optional dependencies.

Contents

Installed Programs: wayland-scanner
Installed Libraries: libwayland-client.so, libwayland-cursor.so, libwayland-egl.so, and libwayland-server.so
Installed Directories: /usr/share/wayland

Short Descriptions

wayland-scanner

is a tool to generate proxy methods in wayland-client-protocol.h and wayland-server-protocol.h

libwayland-client.so

contains API functions for writing Wayland applications

libwayland-cursor.so

contains API functions for managing cursors in Wayland applications

libwayland-egl.so

contains API functions for handling OpenGL calls in Wayland applications

libwayland-server.so

contains API functions for writing Wayland compositors

Wayland-Protocols-1.32

Introduction to Wayland-Protocols

The Wayland-Protocols package contains additional Wayland protocols that add functionality outside of protocols already in the Wayland core.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Wayland-protocols Dependencies

Required

Wayland-1.22.0

Installation of Wayland-protocols

Install Wayland-protocols by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/share/wayland-protocols

wpebackend-fdo-1.14.2

Introduction to wpebackend-fdo

The wpebackend-fdo package contains the Freedesktop.org backend for WPE WebKit and the WPE renderer.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

wpebackend-fdo Dependencies

Required

libepoxy-1.5.10, libwpe-1.14.1, and wayland-protocols-1.32

Installation of wpebackend-fdo

Install wpebackend-fdo by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release ..
ninja

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Programs: None
Installed Libraries: libWPEBackend-fdo-1.0.so
Installed Directories: /usr/include/wpe-fdo-1.0

Short Descriptions

libWPEBackend-fdo-1.0.so

contains functions that provide the freedesktop.org backend for WPE WebKit and the WPE renderer

wv-1.2.9

Introduction to wv

The wv package contains tools for reading information from an MS Word document.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

wv Dependencies

Required

libgsf-1.14.50 and libpng-1.6.40

Optional

libwmf

Installation of wv

Install wv by running the following commands:

./configure --prefix=/usr --disable-static &&
make

This package does not have a test suite.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: wvSummary and several other wv* programs which are deprecated in favour of abiword: see https://wvware.sourceforge.net/
Installed Library: libwv-1.2.so
Installed Directory: /usr/share/wv

Short Descriptions

wvSummary

displays the summary information from an MS Word document

libwv-1.2.so

provides functions to access MS Word documents

Xapian-1.4.23

Introduction to xapian

Xapian is an open source search engine library.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Xapian Dependencies

Optional

Valgrind-3.21.0 (for tests)

Installation of Xapian

Install Xapian by running the following commands:

./configure --prefix=/usr    \
            --disable-static \
            --docdir=/usr/share/doc/xapian-core-1.4.23 &&
make

To run the test suite, issue: make check.

Now, as the root user:

make install

Contents

Installed Programs: copydatabase, quest, simpleexpand, simpleindex, simplesearch, xapian-check, xapian-compact, xapian-config, xapian-delve, xapian-metadata, xapian-pos, xapian-progsrv, xapian-replicate, xapian-replicate-server and xapian-tcpsrv
Installed Libraries: libxapian.so
Installed Directories: /usr/include/xapian, /usr/lib/cmake/xapian, /usr/share/doc/xapian-core-1.4.23, and /usr/share/xapian-core

Short Descriptions

copydatabase

performs a document-by-document copy of one or more Xapian databases

quest

is a command line tool to search through a database

simpleexpand

is a simple example program demonstrating query expansion

simpleindex

indexes each paragraph of a text file as a Xapian document

simplesearch

is a simple command line search utility

xapian-check

checks the consistency of a database or table

xapian-compact

compacts a database, or merges and compacts several databases

xapian-config

reports information about the installed xapian

xapian-delve

inspects the contents of a Xapian database

xapian-metadata

reads and writes user metadata

xapian-pos

inspects the contents of a flint table for development or debugging

xapian-progsrv

is a remote server for use with ProgClient

xapian-replicate

replicates a database from a master server to a local copy

xapian-replicate-server

services database replication requests from clients

xapian-tcpsrv

is the TCP daemon for use with Xapian's remote backend

Chapter 10. Graphics and Font Libraries

Depending on what your system will be used for, you may or may not require the graphics and font libraries. Most desktop machines will want them for use with graphical applications. Most servers on the other hand, will not require them.

AAlib-1.4rc5

Introduction to AAlib

AAlib is a library to render any graphic into ASCII Art.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

AAlib Dependencies

Optional

Xorg Libraries, Xorg Legacy Fonts (runtime), slang-2.3.3, and GPM-1.20.7

Installation of AAlib

Fix a minor problem with the included m4 file:

sed -i -e '/AM_PATH_AALIB,/s/AM_PATH_AALIB/[&]/' aalib.m4

Install AAlib by running the following commands:

./configure --prefix=/usr             \
            --infodir=/usr/share/info \
            --mandir=/usr/share/man   \
            --with-ncurses=/usr       \
            --disable-static          &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: aafire, aainfo, aalib-config, aasavefont, and aatest
Installed Library: libaa.so
Installed Directories: None

Short Descriptions

aafire

is a demo of AAlib, rendering an animated fire in ASCII Art

aainfo

provides information for your current settings related to AAlib

aalib-config

provides configuration info for AAlib

aasavefont

saves a font to a file

aatest

shows the abilities of AAlib in a little test

libaa.so

is a collection of routines to render any graphical input in portable format to ASCII Art. It can be used through many programs and has a very well documented API, so you can easily put it into your own programs

babl-0.1.106

Introduction to Babl

The Babl package is a dynamic, any to any, pixel format translation library.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Babl Dependencies

Recommended
Optional

Little CMS-2.14 and w3m

Installation of Babl

Install Babl by running the following commands:

mkdir bld &&
cd    bld &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja 

To test the results, issue: ninja test.

Now, as the root user:

ninja install &&

install -v -m755 -d                         /usr/share/gtk-doc/html/babl/graphics &&
install -v -m644 docs/*.{css,html}          /usr/share/gtk-doc/html/babl          &&
install -v -m644 docs/graphics/*.{html,svg} /usr/share/gtk-doc/html/babl/graphics

Command Explanations

install -v -m755 -d /usr/share/gtk-doc/html/babl/graphics: This and the subsequent commands install the library html documentation under /usr/share/gtk-doc/html where other gtk packages put the programmer-oriented documentation.

Contents

Installed Programs: None
Installed Libraries: libbabl-0.1.so and libraries in /usr/lib/babl-0.1
Installed Directories: /usr/{include,lib}/babl-0.1 and /usr/share/gtk-doc/html/babl

Short Descriptions

libbabl-0.1.so

contains functions to access BablFishes to convert between formats

Exiv2-0.28.0

Introduction to Exiv2

Exiv2 is a C++ library and a command line utility for managing image and video metadata.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Exiv2 dependencies

Required

CMake-3.27.2

Recommended
Optional

libssh

Optional for documentation

Doxygen-1.9.7, Graphviz-8.1.0, and libxslt-1.1.38

Installation of Exiv2

Install Exiv2 by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr  \
      -DCMAKE_BUILD_TYPE=Release   \
      -DEXIV2_ENABLE_VIDEO=yes     \
      -DEXIV2_ENABLE_WEBREADY=yes  \
      -DEXIV2_ENABLE_CURL=yes      \
      -DEXIV2_BUILD_SAMPLES=no     \
      -G "Unix Makefiles" .. &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

-DEXIV2_ENABLE_VIDEO=yes: This switch enables managing video metadata.

-DEXIV2_ENABLE_WEBREADY=yes: This switch enables managing web image metadata.

-DEXIV2_BUILD_SAMPLES=no: This switch is necessary to suppress building and installing sample programs. If the sample programs are built, 34 additional programs are installed in /usr/bin.

-DEXIV2_ENABLE_CURL=yes: This switch is necessary to enable network/http capabilities.

-DEXIV2_ENABLE_INIH=no: Use this switch if you have not installed inih-57.

-DEXIV2_ENABLE_BROTLI=no: Use this switch if you have not installed Brotli-1.0.9.

Contents

Installed Program: exiv2
Installed Library: libexiv2.so and libexiv2-xmp.a
Installed Directories: /usr/include/exiv2

Short Descriptions

exiv2

is a utility used to dump Exif data

FreeType-2.13.1

Introduction to FreeType2

The FreeType2 package contains a library which allows applications to properly render TrueType fonts.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Additional Documentation

FreeType2 Dependencies

Recommended
Optional

Brotli-1.0.9 and librsvg-2.56.3

Optional (for documentation)

docwriter

Installation of FreeType2

If you downloaded the additional documentation, unpack it into the source tree using the following command:

tar -xf ../freetype-doc-2.13.1.tar.xz --strip-components=2 -C docs

Install FreeType2 by running the following commands:

sed -ri "s:.*(AUX_MODULES.*valid):\1:" modules.cfg &&

sed -r "s:.*(#.*SUBPIXEL_RENDERING) .*:\1:" \
    -i include/freetype/config/ftoption.h  &&

./configure --prefix=/usr --enable-freetype-config --disable-static &&
make

This package does not come with a test suite.

Now, as the root user:

make install

If you downloaded the optional documentation, install it as the root user:

cp -v -R docs -T /usr/share/doc/freetype-2.13.1 &&
rm -v /usr/share/doc/freetype-2.13.1/freetype-config.1

Command Explanations

sed -ri ...: First command enables GX/AAT and OpenType table validation and second command enables Subpixel Rendering. Note that Subpixel Rendering may have patent issues. Be sure to read the 'Other patent issues' part of https://freetype.org/patents.html before enabling this option.

--enable-freetype-config: This switch ensure that the man page for freetype-config is installed.

--without-harfbuzz: If harfbuzz is installed prior to freetype without freetype support, use this switch to avoid a build failure.

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Program: freetype-config
Installed Library: libfreetype.so
Installed Directories: /usr/include/freetype2 and /usr/share/doc/freetype-2.13.1

Short Descriptions

freetype-config

is used to get FreeType compilation and linking information

libfreetype.so

contains functions for rendering various font types, such as TrueType and Type1

Fontconfig-2.14.2

Introduction to Fontconfig

The Fontconfig package contains a library and support programs used for configuring and customizing font access.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Fontconfig Dependencies

Required

FreeType-2.13.1

Optional

bubblewrap-0.8.0 (used by some tests), cURL-8.2.1 and UnZip-6.0 (both used by some tests for downloading and extracting test files), JSON-C-0.17, DocBook-utils-0.6.14 and libxml2-2.10.4, texlive-20230313 (or install-tl-unx)

Note

An Internet connection is needed for some tests of this package.

Note

If you have DocBook Utils installed and you remove the --disable-docs parameter from the configure command below, you must have SGMLSpm-1.1 and texlive-20230313 installed also, or the Fontconfig build will fail.

Installation of Fontconfig

Install Fontconfig by running the following commands:

./configure --prefix=/usr        \
            --sysconfdir=/etc    \
            --localstatedir=/var \
            --disable-docs       \
            --docdir=/usr/share/doc/fontconfig-2.14.2 &&
make

To test the results, issue: make check. One test is known to fail if the kernel does not support user namespaces. Some tests will download some font files via Internet.

Now, as the root user:

make install

If you did not remove the --disable-docs parameter from the configure command, you can install the pre-generated documentation by using the following commands as the root user:

install -v -dm755 \
        /usr/share/{man/man{1,3,5},doc/fontconfig-2.14.2/fontconfig-devel} &&
install -v -m644 fc-*/*.1         /usr/share/man/man1 &&
install -v -m644 doc/*.3          /usr/share/man/man3 &&
install -v -m644 doc/fonts-conf.5 /usr/share/man/man5 &&
install -v -m644 doc/fontconfig-devel/* \
                                  /usr/share/doc/fontconfig-2.14.2/fontconfig-devel &&
install -v -m644 doc/*.{pdf,sgml,txt,html} \
                                  /usr/share/doc/fontconfig-2.14.2

Command Explanations

--disable-docs: This switch avoids building the documentation (the release tarball includes pre-generated documentation).

Configuring Fontconfig

Config Files

/etc/fonts/*, /etc/fonts/conf.d/* and /usr/share/fontconfig/conf.avail/*

Configuration Information

The main configuration file for Fontconfig is /etc/fonts/fonts.conf. Generally you do not want to edit this file. It will also read /etc/fonts/local.conf and any files in /etc/fonts/conf.d. To put a new font directory in the configuration, create (or update) the /etc/fonts/local.conf file with your local information or add a new file in /etc/fonts/conf.d. The default location of fonts in Fontconfig is:

  • /usr/share/fonts

  • ~/.local/share/fonts

  • ~/.fonts (this is now deprecated, but for the moment it still works)

Fontconfig also ships many example configuration files in the /usr/share/fontconfig/conf.avail directory. Symlinking specific files to /etc/fonts/conf.d will enable them. The default setup is generally good enough for most users. See /etc/fonts/conf.d/README for a description of the configuration files.

More information about configuring Fontconfig can be found in the user's manual in file:///usr/share/doc/fontconfig-2.14.2/fontconfig-user.html.

Contents

Installed Programs: fc-cache, fc-cat, fc-conflist, fc-list, fc-match, fc-pattern, fc-query, fc-scan, and fc-validate
Installed Library: libfontconfig.so
Installed Directories: /etc/fonts, /usr/include/fontconfig, /usr/share/doc/fontconfig-2.14.2, /usr/share/fontconfig, /usr/share/xml/fontconfig, and /var/cache/fontconfig

Short Descriptions

fc-cache

is used to create font information caches

fc-cat

is used to read font information caches

fc-conflist

shows the ruleset files' information on the system

fc-list

is used to create font lists

fc-match

is used to match available fonts, or find fonts that match a given pattern

fc-pattern

is used to parse pattern (empty pattern by default) and show the parsed result

fc-query

is used to query fonts files and print resulting patterns

fc-scan

is used to scan font files and directories, and print resulting patterns

fc-validate

is used to validate font files

libfontconfig.so

contains functions used by the Fontconfig programs and also by other programs to configure or customize font access

FriBidi-1.0.13

Introduction to FriBidi

The FriBidi package is an implementation of the Unicode Bidirectional Algorithm (BIDI). This is useful for supporting Arabic and Hebrew alphabets in other packages.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

FriBidi Dependencies

Optional

c2man (to build man pages)

Installation of FriBidi

Install FriBidi by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Program: fribidi
Installed Library: libfribidi.so
Installed Directory: /usr/include/fribidi

Short Descriptions

fribidi

is a command-line interface to the libfribidi library and can be used to convert a logical string to visual output

libfribidi.so

contains functions used to implement the Unicode Bidirectional Algorithm

gegl-0.4.46

Introduction to gegl

This package provides the GEneric Graphics Library, which is a graph based image processing format.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

gegl Dependencies

Required

babl-0.1.106, JSON-GLib-1.6.6, libjpeg-turbo-3.0.0, and libpng-1.6.40

Recommended
Optional

asciidoc-10.2.0, Cairo-1.17.6, FFmpeg-6.0, gdk-pixbuf-2.42.10, gexiv2-0.14.2, GTK-Doc-1.33.2, JasPer-4.0.0, Little CMS-2.14, libraw-0.21.1, librsvg-2.56.3, libtiff-4.5.1, libwebp-1.3.1, Pango-1.50.14, Poppler-23.08.0, Ruby-3.2.2, SDL2-2.28.2, v4l-utils-1.24.1, Vala-0.56.11, libspiro-20220722, LuaJIT, lensfun, LuaJIT, libnsgif, libumfpack, maxflow, MRG, OpenCL, OpenEXR, poly2tri-c, source-highlight, and w3m

Installation of gegl

If installing over a previous version of gegl, one module needs to be removed. As the root user, run:

rm -f /usr/lib/gegl-0.4/vector-fill.so

Install gegl by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To run the tests, issue: ninja test. 7 tests in the gegl:ff-load-save portion of the test suite are known to fail due to incompatibilities with ffmpeg-6.0.

Now, as the root user:

ninja install

Command Explanations

-Ddocs=true: Build and install documentation (requires GTK-Doc-1.33.2,).

Contents

Installed Programs: gegl and gegl-imgcmp
Installed Libraries: libgegl-0.4.so, libgegl-npd-0.4.so, and modules in /usr/lib/gegl-0.4
Installed Directories: /usr/lib/gegl-0.4 and /usr/include/gegl-0.4

Short Descriptions

gegl

is a commandline tool for working with the XML data model

gegl-imgcmp

is a simple image difference detection tool for use in regression testing

libgegl-0.4.so

provides infrastructure to do demand based cached non destructive image editing on larger than RAM buffers

libgegl-npd-0.4.so

is the GEGL N-point image deformation library

giflib-5.2.1

Introduction to giflib

The giflib package contains libraries for reading and writing GIFs as well as programs for converting and working with GIF files.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

giflib Dependencies

Required

xmlto-0.0.28

Installation of giflib

Install giflib by running the following commands:

make

This package does not come with a test suite.

Now, as the root user:

make PREFIX=/usr install &&

rm -fv /usr/lib/libgif.a &&

find doc \( -name Makefile\* -o -name \*.1 \
         -o -name \*.xml \) -exec rm -v {} \; &&

install -v -dm755 /usr/share/doc/giflib-5.2.1 &&
cp -v -R doc/* /usr/share/doc/giflib-5.2.1

Command Explanations

rm -fv /usr/lib/libgif.a: This command removes a static library which is not used by any BLFS package.

find doc ... -exec rm -v {} \;: This command removes Makefiles, man and xml files from the documentation directory that would otherwise be installed by the commands that follow.

Contents

Installed Programs: gif2rgb, gifbuild, gifclrmp, giffix, giftext, and giftool
Installed Library: libgif.so
Installed Directory: /usr/share/doc/giflib-5.2.1

Short Descriptions

gif2rgb

converts images saved as GIF to 24-bit RGB images

gifbuild

dumps GIF data in a textual format, or undumps it to a GIF

gifclrmp

modifies GIF image colormaps

giffix

clumsily attempts to fix truncated GIF images

giftext

prints (text only) general information about a GIF file

giftool

is a GIF transformation tool

libgif.so

contains API functions required by the giflib programs and any other programs needing library functionality to read, write and manipulate GIF images

GLM-0.9.9.8

Introduction to GLM

OpenGL Mathematics (GLM) is a header-only C++ mathematics library for graphics software based on the OpenGL Shading Language (GLSL) specifications. An extension system provides extended capabilities such as matrix transformations and quaternions.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of GLM

Note

This package is unusual as it includes its functionality in header files. We just copy them into position.

As the root user:

cp -r glm /usr/include/ &&
cp -r doc /usr/share/doc/glm-0.9.9.8

Contents

Installed Program: None
Installed Library: None
Installed Directory: /usr/include/glm

Graphite2-1.3.14

Introduction to Graphite2

Graphite2 is a rendering engine for graphite fonts. These are TrueType fonts with additional tables containing smart rendering information and were originally developed to support complex non-Roman writing systems. They may contain rules for e.g. ligatures, glyph substitution, kerning, justification - this can make them useful even on text written in Roman writing systems such as English. Note that firefox by default provides an internal copy of the graphite engine and cannot use a system version (although it can now be patched to use it), but it too should benefit from the availability of graphite fonts.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Graphite2 Dependencies

Required

CMake-3.27.2

Optional

FreeType-2.13.1, silgraphite to build the comparerender test and benchmarking tool, and if that is present, and HarfBuzz-8.1.1 to add more functionality to it (this is a circular dependency, you would need to first build graphite2 without harfbuzz).

To build the documentation: asciidoc-10.2.0, Doxygen-1.9.7, texlive-20230313 (or install-tl-unx), and dblatex (for PDF docs)

To execute the test suite you will need FontTools (Python 3 module), otherwise, the "cmp" tests fail.

Optional (at runtime)

You will need at least one suitable graphite font for the package to be useful.

Installation of Graphite2

Some tests fail if FontTools (Python 3 module) is not installed. These tests can be removed with:

sed -i '/cmptest/d' tests/CMakeLists.txt

Install Graphite2 by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr .. &&
make

If you wish to build the documentation, issue:

make docs

To test the results, issue: make test. One test named nametabletest is known to fail.

Now, as the root user:

make install

If you built the documentation, install, as the root user:

install -v -d -m755 /usr/share/doc/graphite2-1.3.14 &&

cp      -v -f    doc/{GTF,manual}.html \
                    /usr/share/doc/graphite2-1.3.14 &&
cp      -v -f    doc/{GTF,manual}.pdf \
                    /usr/share/doc/graphite2-1.3.14

Command Explanations

-DCMAKE_VERBOSE_MAKEFILE=ON: This switch turns on build verbose mode.

Contents

Installed Programs: gr2fonttest, and optionally comparerender
Installed Libraries: libgraphite2.so
Installed Directories: /usr/{include,share}/graphite2 and optionally /usr/share/doc/graphite2-1.3.14

Short Descriptions

comparerender

is a test and benchmarking tool

gr2fonttest

is a diagnostic console tool for graphite fonts

libgraphite2.so

is a rendering engine for graphite fonts

HarfBuzz-8.1.1

Introduction to Harfbuzz

The HarfBuzz package contains an OpenType text shaping engine.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

HarfBuzz Dependencies

Recommended
Optional

Cairo-1.17.6 (circular: build cairo and all its recommended dependencies, including harfbuzz, first, then rebuild harfbuzz if the cairo backend is needed), git-2.41.0, GTK-Doc-1.33.2, FontTools (Python 3 module, for the test suite), ragel, and wasm-micro-runtime

Warning

Recommended dependencies are not strictly required to build the package. However, you might not get expected results at runtime if you don't install them. Please do not report bugs with this package if you have not installed the recommended dependencies.

Installation of HarfBuzz

Install HarfBuzz by running the following commands:

mkdir build &&
cd    build &&

meson setup ..            \
      --prefix=/usr       \
      --buildtype=release \
      -Dgraphite2=enabled &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dgraphite2=enabled: This switch enables Graphite2 support, which is required for building texlive-20230313 or LibreOffice-7.6.0.3 with system harfbuzz.

-Ddocs=disabled: If GTK-Doc-1.33.2 is installed, the documentation is built and installed. This switch prevents that.

Contents

Installed Programs: hb-info, hb-ot-shape-closure, hb-shape, hb-subset, and hb-view (only if Cairo is installed)
Installed Libraries: libharfbuzz.so, libharfbuzz-cairo.so (only if Cairo is installed), libharfbuzz-gobject.so, libharfbuzz-icu.so, and libharfbuzz-subset.so
Installed Directories: /usr/include/harbuzz, /usr/lib/cmake/harfbuzz, and /usr/share/gtk-doc/html/harfbuzz (optional)

Short Descriptions

hb-info

is used for gathering information about fonts installed on the system

hb-ot-shape-closure

gives the set of characters contained in a string, represented as single characters and/or single character names. Example: hb-ot-shape-closure /usr/share/fonts/dejavu/DejaVuSans.ttf "Hello World."

hb-shape

is used for the conversion of text strings into positioned glyphs

hb-subset

is used to create subsets of fonts, and display text using them

hb-view

displays a graphical view of a string shape using a particular font as a set of glyphs. The output format is automatically defined by the file extension, the supported ones being ansi/png/svg/pdf/ps/eps. For example: hb-view --output-file=hello.png /usr/share/fonts/dejavu/DejaVuSans.ttf "Hello World."

libharfbuzz.so

is the HarfBuzz text shaping library

libharfbuzz-cairo.so

provides Cairo integration for the Harfbuzz text shaping library

libharfbuzz-gobject.so

provides GObject integration for the HarfBuzz text shaping library

libharfbuzz-icu.so

provides ICU integration for the HarfBuzz text shaping library

libharfbuzz-subset.so

provides API functions for performing subsetting operations on font files

JasPer-4.0.0

Introduction to JasPer

The JasPer Project is an open-source initiative to provide a free software-based reference implementation of the JPEG-2000 codec.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

JasPer Dependencies

Required

CMake-3.27.2

Recommended
Optional

Freeglut-3.4.0 (required for jiv), Doxygen-1.9.7 (needed for generating html documentation), and texlive-20230313 (needed to regenerate the pdf documentation)

Installation of JasPer

Note

The tarball jasper-4.0.0.tar.gz will extract to jasper-version-4.0.0.

Install JasPer by running the following commands:

mkdir BUILD &&
cd    BUILD &&

cmake -DCMAKE_INSTALL_PREFIX=/usr    \
      -DCMAKE_BUILD_TYPE=Release     \
      -DCMAKE_SKIP_INSTALL_RPATH=YES \
      -DJAS_ENABLE_DOC=NO            \
      -DCMAKE_INSTALL_DOCDIR=/usr/share/doc/jasper-4.0.0 \
      ..  &&
make

To test the results, issue: make test.

Now, as the root user:

make install

Command Explanations

-DCMAKE_SKIP_INSTALL_RPATH=YES: This option removes embedded library search paths.

-DJAS_ENABLE_DOC=NO: This option disables rebuilding the pdf documentation if texlive-20230313 is installed.

Contents

Installed Programs: imgcmp, imginfo, jasper, and jiv
Installed Library: libjasper.so
Installed Directories: /usr/include/jasper and /usr/share/doc/jasper-4.0.0

Short Descriptions

imgcmp

compares two images of the same geometry

imginfo

displays information about an image

jasper

converts images between formats (BMP, JPS, JPC, JPG, PGX, PNM, MIF, and RAS)

jiv

displays images

libjasper.so

is a library used by programs for reading and writing JPEG2000 format files

Little CMS-1.19

Introduction to Little CMS

The Little CMS library is used by other programs to provide color management facilities.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Little CMS Dependencies

Optional

libtiff-4.5.1, libjpeg-turbo-3.0.0, and Python-2.7.18 (with SWIG-4.1.1 also)

Installation of Little CMS

Install Little CMS by running the following commands:

patch -Np1 -i ../lcms-1.19-cve_2013_4276-1.patch &&

./configure --prefix=/usr --disable-static       &&
make

To test the results, issue: make check.

Now, as the root user:

make install &&
install -v -m755 -d /usr/share/doc/lcms-1.19 &&
install -v -m644    README.1ST doc/* \
                    /usr/share/doc/lcms-1.19

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--with-python: Use this parameter if Python and SWIG are installed.

Contents

Installed Programs: icc2ps, icclink, icctrans, wtpt and optionally, jpegicc, tiffdiff and tifficc
Installed Libraries: liblcms.so and the optional _lcms.so Python module
Installed Directory: /usr/share/doc/lcms-1.19

Short Descriptions

icc2ps

generates PostScript CRD or CSA from ICC profiles

icclink

links two or more profiles into a single device link profile

icctrans

is a color space conversion calculator

jpegicc

is an ICC profile applier for JPEG files

tifficc

is an ICC profile applier for TIFF files

tiffdiff

is a TIFF compare utility

wtpt

shows media white of profiles, identifying black body locus

liblcms.so

is used by the lcms programs as well as other programs to provide color management facilities

Little CMS-2.14

Introduction to Little CMS2

The Little Color Management System is a small-footprint color management engine, with special focus on accuracy and performance. It uses the International Color Consortium standard (ICC), which is the modern standard for color management.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Little CMS2 Dependencies

Optional

libjpeg-turbo-3.0.0 and libtiff-4.5.1

Installation of Little CMS2

Apply the upstream fix for an issue breaking colord:

sed '/BufferSize < TagSize/,+1 s/goto Error/TagSize = BufferSize/' \
    -i src/cmsio0.c

Install Little CMS2 by running the following commands:

./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: jpgicc, linkicc, psicc, tificc, and transicc
Installed Library: liblcms2.so
Installed Directories: None

Short Descriptions

jpgicc

is the Little CMS ICC profile applier for JPEG

linkicc

is the Little CMS ICC device link generator

psicc

is the Little CMS ICC PostScript generator

tificc

is the Little CMS ICC tiff generator

transicc

is the Little CMS ColorSpace conversion calculator

liblcms2.so

contains functions that implement the lcms2 API

libavif-0.11.1

Introduction to libavif

The libavif package contains a library used for encoding and decoding AVIF files.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libavif Dependencies

Required

libaom-3.6.1

Recommended
Optional

gtest, libdav1d, libyuv, rav1e, and svt-av1

Installation of libavif

Install libavif by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DAVIF_CODEC_AOM=ON         \
      -DAVIF_BUILD_GDK_PIXBUF=ON  \
      -G Ninja .. &&
ninja

This package does come with a test suite, but it requires gtest, which is not part of BLFS.

Now, as the root user:

ninja install

The AV1 format needs to be added to the loaders cache. As the root user:

gdk-pixbuf-query-loaders --update-cache

Command Explanations

-DAVIF_CODEC_AOM=ON: This switch enables using the AOM codec. This package is useless without at least one codec built in.

-DAVIF_BUILD_GDK_PIXBUF=ON: This switch builds the AVIF loader for applications which use gdk-pixbuf. Remove it if you have not installed gdk-pixbuf-2.42.10.

-DAVIF_CODEC_DAV1D=ON: Use this switch if you have installed libdav1d and wish to use it as a codec.

-DAVIF_CODEC_RAV1E=ON: Use this switch if you have installed rav1e and wish to use it as a codec.

-DAVIF_CODEC_SVT=ON: Use this switch if you have installed svt-av1 and wish to use it as a codec.

Contents

Installed Programs: None
Installed Libraries: libavif.so and libpixbbufloader-avif.so (in /usr/lib/gdk-pixbuf-2.0/2.10.0/loaders)
Installed Directories: /usr/include/avif

Short Descriptions

libavif.so

contains functions that provide a portable C implementation of the AV1 Image Format

libpixbufloader-avif.so

allows applications which use gdk-pixbuf to read AVIF images

libexif-0.6.24

Introduction to libexif

The libexif package contains a library for parsing, editing, and saving EXIF data. Most digital cameras produce EXIF files, which are JPEG files with extra tags that contain information about the image. All EXIF tags described in EXIF standard 2.1 are supported.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libexif Dependencies

Optional (to Build Documentation)

Doxygen-1.9.7 and Graphviz-8.1.0

Installation of libexif

Install libexif by running the following commands:

./configure --prefix=/usr    \
            --disable-static \
            --with-doc-dir=/usr/share/doc/libexif-0.6.24 &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Documentation was built and installed if you have the dependencies shown above installed. If you don't have the dependencies installed, there is a compressed tarball in the source tree doc directory that can be unpacked into /usr/share/doc/libexif-0.6.24.

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Library: libexif.so
Installed Directories: /usr/include/libexif and /usr/share/doc/libexif-0.6.24

Short Descriptions

libexif.so

contains functions used for parsing, editing, and saving EXIF data

Libgxps-0.3.2

Introduction to libgxps

The libgxps package provides an interface to manipulate XPS documents.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Libgxps Dependencies

Required

GTK+-3.24.38, Little CMS-2.14, libarchive-3.7.1, libjpeg-turbo-3.0.0, libtiff-4.5.1, and libxslt-1.1.38

Optional

git-2.41.0 and GTK-Doc-1.33.2

Installation of Libgxps

Install Libgxps by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Programs: xpstojpeg, xpstopdf, xpstopng, xpstops, and xpstosvg
Installed Library: libgxps.so
Installed Directories: /usr/include/libgxps

Short Descriptions

xpstojpeg

converts XPS documents to a JPEG image

xpstopdf

converts XPS documents to PDF format

xpstopng

converts XPS documents to a PNG image

xpstops

converts XPS documents to PostScript

xpstosvg

converts XPS documents to SVG images

libgxps.so

contains API functions for manipulating XPS documents

libjpeg-turbo-3.0.0

Introduction to libjpeg-turbo

libjpeg-turbo is a fork of the original IJG libjpeg which uses SIMD to accelerate baseline JPEG compression and decompression. libjpeg is a library that implements JPEG image encoding, decoding and transcoding.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libjpeg-turbo Dependencies

Required

CMake-3.27.2

Recommended

Installation of libjpeg-turbo

Install libjpeg-turbo by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=RELEASE  \
      -DENABLE_STATIC=FALSE       \
      -DCMAKE_INSTALL_DOCDIR=/usr/share/doc/libjpeg-turbo-3.0.0 \
      -DCMAKE_INSTALL_DEFAULT_LIBDIR=lib  \
      .. &&
make

To test the results, issue: make test.

Now, as the root user:

make install

Command Explanations

-DWITH_JPEG8=ON: This switch enables compatibility with libjpeg version 8.

Contents

Installed Programs: cjpeg, djpeg, jpegtran, rdjpgcom, tjbench, and wrjpgcom
Installed Libraries: libjpeg.so and libturbojpeg.so
Installed Directories: /usr/share/doc/libjpeg-turbo-3.0.0

Short Descriptions

cjpeg

compresses image files to produce a JPEG/JFIF file on the standard output. Currently supported input file formats are: PPM (PBMPLUS color format), PGM (PBMPLUS gray-scale format), BMP, and Targa

djpeg

decompresses image files from JPEG/JFIF format to either PPM (PBMPLUS color format), PGM (PBMPLUS gray-scale format), BMP, or Targa format

jpegtran

is used for lossless transformation of JPEG files

rdjpgcom

displays text comments from within a JPEG file

tjbench

is used to benchmark the performance of libjpeg-turbo

wrjpgcom

inserts text comments into a JPEG file

libjpeg.so

contains functions used for reading and writing JPEG images

libmng-2.0.3

Introduction to libmng

The libmng libraries are used by programs wanting to read and write Multiple-image Network Graphics (MNG) files which are the animation equivalents to PNG files.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libmng Dependencies

Required

libjpeg-turbo-3.0.0 and Little CMS-2.14

Installation of libmng

Install libmng by running the following commands:

./configure --prefix=/usr --disable-static &&
make

This package does not come with a test suite.

Now, as the root user:

make install &&

install -v -m755 -d        /usr/share/doc/libmng-2.0.3 &&
install -v -m644 doc/*.txt /usr/share/doc/libmng-2.0.3

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Library: libmng.so
Installed Directory: /usr/share/doc/libmng-2.0.3

Short Descriptions

libmng.so

provides functions for programs wishing to read and write MNG files which are animation files without the patent problems associated with certain other formats

libmypaint-1.6.1

Introduction to libmypaint

The libmypaint package, a.k.a. "brushlib", is a library for making brushstrokes which is used by MyPaint and other projects.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libmypaint Dependencies

Required

JSON-C-0.17

Recommended
Optional

Doxygen-1.9.7 (to create XML docs), gegl (0.3 versions only) and gperftools

Installation of libmypaint

Install libmypaint by running the following commands:

./configure --prefix=/usr &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Contents

Installed Programs: None.
Installed Libraries: libmypaint.so (and optionally libmypaint-gegl.so which is not used by any packages in this book).
Installed Directory: /usr/include/libmypaint

Short Descriptions

libmypaint.so

contains functions for making brushstrokes

libpng-1.6.40

Introduction to libpng

The libpng package contains libraries used by other programs for reading and writing PNG files. The PNG format was designed as a replacement for GIF and, to a lesser extent, TIFF, with many improvements and extensions and lack of patent problems.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Installation of libpng

If you want to patch libpng to support apng files, apply it here:

gzip -cd ../libpng-1.6.39-apng.patch.gz | patch -p1

Install libpng by running the following commands:

./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check.

Now, as the root user:

make install &&
mkdir -v /usr/share/doc/libpng-1.6.40 &&
cp -v README libpng-manual.txt /usr/share/doc/libpng-1.6.40

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: libpng-config (symlink), libpng16-config, pngfix and png-fix-itxt
Installed Libraries: libpng.so
Installed Directories: /usr/include/libpng16 and /usr/share/doc/libpng-1.6.40

Short Descriptions

pngfix

tests, optimizes and optionally fixes the zlib header in PNG files. Optionally, when fixing, strips ancillary chunks from the file

png-fix-itxt

fixes PNG files that have an incorrect length field in the iTXt chunks

libpng-config

is a shell script that provides configuration information for applications wanting to use libpng

libpng.so

contain routines used to create and manipulate PNG format graphics files

libraw-0.21.1

Introduction to libraw

Libraw is a library for reading RAW files obtained from digital photo cameras (CRW/CR2, NEF, RAF, DNG, and others).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libraw Dependencies

Recommended

Installation of libraw

Install libraw by running the following commands:

autoreconf -fiv              &&
./configure --prefix=/usr    \
            --enable-jpeg    \
            --enable-jasper  \
            --enable-lcms    \
            --disable-static \
            --docdir=/usr/share/doc/libraw-0.21.1 &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--enable-jpeg: This switch enables support for jpeg. Remove if you don't have libjpeg-turbo-3.0.0 installed.

--enable-jasper: This switch enables support for jasper. Remove if you don't have JasPer-4.0.0 installed.

--enable-lcms: This switch enables support for Little CMS2. Remove if you don't have Little CMS-2.14 installed.

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Note

All the installed programs are examples of using libraw.

Installed Programs: 4channels, dcraw_emu, dcraw_half, half_mt, mem_image, multirender_test, postprocessing_benchmark, raw-identify, simple_dcraw, and unprocessed_raw
Installed Library: libraw.so and libraw_r.so
Installed Directories: /usr/include/libraw and /usr/share/doc/libraw-0.21.1

Short Descriptions

4channels

generates four TIFF files from RAW data, one file per channel

dcraw_half

emulates "dcraw -h" (see DCRAW manpage)

mem_image

emulates "dcraw [-4] [-6] [-e]" (see DCRAW manpage)

postprocessing_benchmark

creates eight different renderings from one source file. The first and fourth one should be identical

simple_dcraw

emulates call to "dcraw [-D] [-T] [-v] [-e] [-4]" (see DCRAW manpage)

dcraw_emu

is an almost complete dcraw emulator (see DCRAW manpage)

half_mt

emulates call to "dcraw -h [-w] [-a] [-v]" (see DCRAW manpage)

multirender_test

creates eight different renderings from one source file. The first and fourth one should be identical

raw-identify

emulates call to "dcraw -i [-v]" (see DCRAW manpage)

unprocessed_raw

generates unprocessed raw image: with masked pixels and without black subtraction

librsvg-2.56.3

Introduction to librsvg

The librsvg package contains a library and tools used to manipulate, convert and view Scalable Vector Graphic (SVG) images.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

librsvg Dependencies

Required

Cairo-1.17.6, gdk-pixbuf-2.42.10, Pango-1.50.14, and rustc-1.71.1

Note

An Internet connection is needed for building this package.

Recommended
Optional

docutils-0.20.1 (for man pages), Gi-DocGen-2023.1 (for documentation), and Xorg Fonts (for tests)

Installation of librsvg

Install librsvg by running the following commands:

./configure --prefix=/usr    \
            --enable-vala    \
            --disable-static \
            --docdir=/usr/share/doc/librsvg-2.56.3 &&
make

To test the results, issue:

make check

Now, as the root user:

make DOC_INSTALL_DIR='$(docdir)' install

Note

If you installed the package on to your system using a DESTDIR method, an important file was not installed and should be copied and/or generated. Generate it using the following command as the root user:

gdk-pixbuf-query-loaders --update-cache

Command Explanations

--enable-vala: This switch enables building of the Vala bindings. Remove this switch if you don't have Vala-0.56.11 installed.

--disable-static: This switch prevents installation of static versions of the libraries.

DOC_INSTALL_DIR='$(docdir)': This override ensures installing the API documentation into the expected location if Gi-DocGen-2023.1 is installed.

--disable-introspection: Use this switch if you have not installed Gobject Introspection.

--disable-gtk-doc: This switch prevents building the API documentation, even if Gi-DocGen-2023.1 (despite the name of the option) is available.

Contents

Installed Programs: rsvg-convert
Installed Library: librsvg-2.so
Installed Directories: /usr/include/librsvg-2.0 and /usr/share/doc/librsvg-2.56.3

Short Descriptions

rsvg-convert

is used to convert images into PNG, PDF, PS, SVG and other formats

librsvg-2.so

provides the functions to render Scalable Vector Graphics

libpixbufloader-svg.so

is the Gdk Pixbuf plugin that allows GTK+ applications to render Scalable Vector Graphics images

Libspiro-20220722

Introduction to libspiro

Libspiro will take an array of spiro control points and convert them into a series of bezier splines which can then be used in the myriad of ways the world has come to use beziers.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of libspiro

Install libspiro by running the following commands:

./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Library: libspiro.so
Installed Directories: None

Short Descriptions

libspiro.so

is a shareable library that can be used by programs to do the Spiro computations for you

libtiff-4.5.1

Introduction to libtiff

The libtiff package contains the TIFF libraries and associated utilities. The libraries are used by many programs for reading and writing TIFF files and the utilities are used for general work with TIFF files.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libtiff Dependencies

Recommended
Optional

Freeglut-3.4.0 (required for tiffgt), libjpeg-turbo-3.0.0, sphinx-7.1.2, libwebp-1.3.1, JBIG-KIT, and LERC

Installation of libtiff

Install libtiff by running the following commands:

mkdir -p libtiff-build &&
cd       libtiff-build &&

cmake -DCMAKE_INSTALL_DOCDIR=/usr/share/doc/libtiff-4.5.1 \
      -DCMAKE_INSTALL_PREFIX=/usr -G Ninja .. &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Contents

Installed Programs: fax2ps, fax2tiff, pal2rgb, ppm2tiff, raw2tiff, tiff2bw, tiff2pdf, tiff2ps, tiff2rgba, tiffcmp, tiffcp, tiffcrop, tiffdither, tiffdump, tiffgt, tiffinfo, tiffmedian, tiffset and tiffsplit
Installed Libraries: libtiff.so and libtiffxx.so
Installed Directory: /usr/share/doc/tiff-4.5.1

Short Descriptions

fax2ps

converts a TIFF facsimile to compressed PostScript file

fax2tiff

creates a TIFF Class F fax file from raw fax data

pal2rgb

converts a palette color TIFF image to a full color image

ppm2tiff

creates a TIFF file from a PPM image file

raw2tiff

converts a raw byte sequence into TIFF

tiff2bw

converts a color TIFF image to grayscale

tiff2pdf

converts a TIFF image to a PDF document

tiff2ps

converts a TIFF image to a PostScript file

tiff2rgba

converts a wide variety of TIFF images into an RGBA TIFF image

tiffcmp

compares two TIFF files

tiffcp

copies (and possibly converts) a TIFF file

tiffcrop

selects, copies, crops, converts, extracts and/or processes one or more TIFF files

tiffdither

converts a grayscale image to bilevel using dithering

tiffdump

prints verbatim information about TIFF files

tiffgt

displays an image stored in a TIFF file

tiffinfo

prints information about TIFF files

tiffmedian

applies the median cut algorithm to data in a TIFF file

tiffset

sets the value of a TIFF header to a specified value

tiffsplit

splits a multi-image TIFF into single-image TIFF files

libtiff.so

contains the API functions used by the libtiff programs as well as other programs to read and write TIFF files

libtiffxx.so

contains the C++ API functions used by programs to read and write TIFF files

libwebp-1.3.1

Introduction to libwebp

The libwebp package contains a library and support programs to encode and decode images in WebP format.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libwebp Dependencies

Recommended
Optional

Freeglut-3.4.0 and giflib-5.2.1

Installation of libwebp

Install libwebp by running the following commands:

./configure --prefix=/usr           \
            --enable-libwebpmux     \
            --enable-libwebpdemux   \
            --enable-libwebpdecoder \
            --enable-libwebpextras  \
            --enable-swap-16bit-csp \
            --disable-static        &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--enable-swap-16bit-csp: This switch enables byte swap for 16 bit colorspaces.

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: cwebp, dwebp, gif2webp, img2webp, vwebp, webpinfo, and webpmux
Installed Library: libsharpyuv.so, libwebpdecoder.so, libwebpdemux.so, libwebpmux.so, and libwebp.so
Installed Directory: /usr/include/webp

Short Descriptions

cwebp

compresses an image using the WebP format

dwebp

decompresses WebP files into PNG, PAM, PPM or PGM images

gif2webp

converts a GIF image to a WebP image

img2webp

creates an animated WebP file from a sequence of input images

vwebp

decompresses a WebP file and displays it in a window

webpinfo

prints out the cunk level structure of WebP files along with performing basic integrity checks

webpmux

creates animated WebP files from non-animated WebP images, extracts frames from animated WebP images, and manages XMP/EXIF metadata and the ICC profile

libwebp.so

contains the API functions for WebP encoding and decoding

mypaint-brushes-1.3.1

Introduction to mypaint-brushes

The mypaint-brushes package contains brushes used by packages which use libmypaint.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

mypaint-brushes Dependencies

Required at runtime

libmypaint-1.6.1

Installation of mypaint-brushes

Install mypaint-brushes by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None.
Installed Libraries: None.
Installed Directories: /usr/share/mypaint-data.

newt-0.52.23

Introduction to newt

Newt is a programming library for color text mode, widget based user interfaces. It can be used to add stacked windows, entry widgets, checkboxes, radio buttons, labels, plain text fields, scrollbars, etc., to text mode user interfaces. Newt is based on the S-Lang library.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Newt Dependencies

Required

popt-1.19 and slang-2.3.3

Recommended

Installation of newt

Install newt by running the following command:

sed -e '/install -m 644 $(LIBNEWT)/ s/^/#/' \
    -e '/$(LIBNEWT):/,/rv/ s/^/#/'          \
    -e 's/$(LIBNEWT)/$(LIBNEWTSH)/g'        \
    -i Makefile.in                          &&

./configure --prefix=/usr           \
            --with-gpm-support      \
            --with-python=python3.11 &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

sed -e ... -i Makefile.in: Disables installation of a static library.

--with-gpm-support: This switch enables mouse support for newt applications through GPM.

--with-python=python3.11: By giving explicitly the name of the directory where python modules reside, this switch prevents building the python2 module.

Contents

Installed Programs: whiptail
Installed Library: libnewt.so, whiptcl.so, and /usr/lib/python3.11/site-packages/_snack.so
Installed Directories: None

Short Descriptions

whiptail

displays dialog boxes from shell scripts

libnewt.so

is the library for color text mode, widget based user interfaces

opencv-4.8.0

Introduction to opencv

The opencv package contains graphics libraries mainly aimed at real-time computer vision.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Note

One additional file that starts with "ippicv" (integrated performance primitives) will be automatically downloaded during the cmake portion of the build procedure. This download is specific to the system architecture.

opencv Dependencies

Required

CMake-3.27.2 and UnZip-6.0

Recommended
Optional

apache-ant-1.10.14, Doxygen-1.9.7, Java-20.0.2, NumPy-1.25.2, Python-2.7.18, blas, Cuda, Eigen, OpenEXR, GDAL, lapack, libdc1394, Threading Building Blocks (TBB), and VTK - The Visualization Toolkit,

Installation of opencv

If you downloaded the optional modules, unpack them now:

tar -xf ../opencv_contrib-4.8.0.tar.gz

Install opencv by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr      \
      -DCMAKE_BUILD_TYPE=Release       \
      -DENABLE_CXX11=ON                \
      -DBUILD_PERF_TESTS=OFF           \
      -DWITH_XINE=ON                   \
      -DBUILD_TESTS=OFF                \
      -DENABLE_PRECOMPILED_HEADERS=OFF \
      -DCMAKE_SKIP_RPATH=ON            \
      -DBUILD_WITH_DEBUG_INFO=OFF      \
      -Wno-dev  ..                     &&
make

The package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

-DWITH_XINE=ON: This option instructs the make procedure to use xine-lib-1.2.13.

-DENABLE_PRECOMPILED_HEADERS=OFF: This option is needed for compatibility with gcc-6.1 and later.

-DOPENCV_EXTRA_MODULES_PATH=../opencv_contrib-4.8.0/modules: instructs the build system to build additional modules.

Contents

Installed Programs: opencv_annotation, opencv_interactive-calibration, opencv_model_diagnostics, opencv_version, opencv_visualisation, and setup_vars_opencv4.sh
Installed Libraries: libopencv_calib3d.so, libopencv_core.so, libopencv_dnn.so, libopencv_features2d.so, libopencv_flann.so, libopencv_gapi.so, libopencv_highgui.so, libopencv_imgcodecs.so, libopencv_imgproc.so, libopencv_ml.so, libopencv_objdetect.so, libopencv_photo.so, libopencv_stitching.so, libopencv_video.so, and libopencv_videoio.so
Installed Directories: /usr/include/opencv4, /usr/lib/cmake/opencv4, /usr/lib/python3.11/site-packages/cv2, /usr/share/licenses/opencv4, /usr/share/opencv4, and /usr/share/java/opencv4

OpenJPEG-2.5.0

Introduction to OpenJPEG

OpenJPEG is an open-source implementation of the JPEG-2000 standard. OpenJPEG fully respects the JPEG-2000 specifications and can compress/decompress lossless 16-bit images.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

OpenJPEG Dependencies

Required

CMake-3.27.2

Optional

Little CMS-2.14, libpng-1.6.40, libtiff-4.5.1, and Doxygen-1.9.7 (to build the API documentation)

Installation of OpenJPEG

Install OpenJPEG by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_BUILD_TYPE=Release \
      -DCMAKE_INSTALL_PREFIX=/usr \
      -DBUILD_STATIC_LIBS=OFF .. &&
make

This package does not come with a test suite.

Now, as the root user:

make install &&

pushd ../doc &&
  for man in man/man?/* ; do
      install -v -D -m 644 $man /usr/share/$man
  done
popd

Contents

Installed Programs: opj_compress, opj_decompress, and opj_dump
Installed Libraries: libopenjp2.so
Installed Directories: /usr/include/openjpeg-2.5 and /usr/lib/openjpeg-2.5

Short Descriptions

opj_compress

converts various image formats to the jpeg2000 format

opj_decompress

converts jpeg2000 images to other image types

opj_dump

reads in a jpeg2000 image and dumps the contents to stdout

Pixman-0.42.2

Introduction to Pixman

The Pixman package contains a library that provides low-level pixel manipulation features such as image compositing and trapezoid rasterization.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Pixman Dependencies

Optional

GTK+-2.24.33 and libpng-1.6.40 (for tests and demos)

Installation of Pixman

Install Pixman by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Programs: None
Installed Library: libpixman-1.so
Installed Directory: /usr/include/pixman-1

Short Descriptions

libpixman-1.so

contains functions that provide low-level pixel manipulation features

Poppler-23.08.0

Introduction to Poppler

The Poppler package contains a PDF rendering library and command line tools used to manipulate PDF files. This is useful for providing PDF rendering functionality as a shared library.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://poppler.freedesktop.org/poppler-23.08.0.tar.xz

  • Download MD5 sum: b369afc9511198de5a604ca3baea1ddd

  • Download size: 1.8 MB

  • Estimated disk space required: 91 MB (with Qt5 library and tests)

  • Estimated build time: 0.6 SBU (with parallelism=4, Qt5 library, and tests)

Additional Downloads

Poppler Encoding Data

The additional package consists of encoding files for use with Poppler. The encoding files are optional and Poppler will automatically read them if they are present. When installed, they enable Poppler to render CJK and Cyrillic properly.

Poppler Dependencies

Required

CMake-3.27.2, Fontconfig-2.14.2, and gobject-introspection-1.76.1

Recommended
Optional

cURL-8.2.1, gdk-pixbuf-2.42.10, git-2.41.0 (for downloading test files), GPGME-1.21.0, GTK-Doc-1.33.2, GTK+-3.24.38, libtiff-4.5.1, (Qt-5.15.10 or qt-alternate-5.15.10) (required for PDF support in Okular-23.08.0), and Qt-6.1 or later.

Installation of Poppler

Install Poppler by running the following commands:

mkdir build                         &&
cd    build                         &&

cmake  -DCMAKE_BUILD_TYPE=Release   \
       -DCMAKE_INSTALL_PREFIX=/usr  \
       -DTESTDATADIR=$PWD/testfiles \
       -DENABLE_UNSTABLE_API_ABI_HEADERS=ON \
       ..                           &&
make

In order to run the test suite, some testcases are needed and can be obtained only from a git repository. The command to download them is: git clone --depth 1 https://gitlab.freedesktop.org/poppler/test.git testfiles. Then issue: LC_ALL=en_US.UTF-8 make test.

Now, as the root user:

make install

To install the documentation, run the following commands as root:

install -v -m755 -d           /usr/share/doc/poppler-23.08.0 &&
cp -vr ../glib/reference/html /usr/share/doc/poppler-23.08.0

Poppler Data

If you downloaded the additional encoding data package, install it by issuing the following commands:

tar -xf ../../poppler-data-0.4.12.tar.gz &&
cd poppler-data-0.4.12

Now, as the root user:

make prefix=/usr install

Command Explanations

-DCMAKE_BUILD_TYPE=Release: This switch is used to apply a higher level of compiler optimizations.

-DTESTDATADIR=$PWD/testfiles: Tells the test programs where the auxiliary files are located.

-DENABLE_UNSTABLE_API_ABI_HEADERS=ON: Installs some old Xpdf headers required by certain programs.

-DENABLE_GTK_DOC=ON: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

-DENABLE_BOOST=OFF: Use this parameter if you have not installed boost (the Splash backend for Qt5 recommends boost).

LC_ALL=en_US.UTF-8 make test: Runs the test suite. The environment variable LC_ALL=en_US.UTF-8 is only needed if the default locale does not include UTF-8.

Contents

Installed Programs: pdfattach, pdfdetach, pdffonts, pdfimages, pdfinfo, pdfseparate, pdfsig, pdftocairo, pdftohtml, pdftoppm, pdftops, pdftotext, and pdfunite
Installed Libraries: libpoppler.so, libpoppler-cpp.so, libpoppler-glib.so, and libpoppler-qt5.so
Installed Directories: /usr/include/poppler, /usr/share/poppler, and /usr/share/doc/poppler-23.08.0

Short Descriptions

pdfattach

adds a new embedded file to an existing PDF file

pdfdetach

lists or extracts embedded files from PDF files

pdffonts

lists the fonts used in a PDF file along with various information for each font

pdfimages

saves images from a PDF file as PPM, PBM, or JPEG files

pdfinfo

prints the contents of the 'Info' dictionary (plus some other useful information) from a PDF file

pdfseparate

extracts single pages from a PDF file

pdfsig

verifies the digital signatures in a PDF document

pdftocairo

converts a PDF file to one of several formats (PNG, JPEG, PDF, PS, EPS, SVG) using the cairo output device of the poppler library

pdftohtml

converts a PDF file to HTML

pdftoppm

converts PDF files to PBM, PGM and PPM formats

pdftops

converts PDF files to Postscript format

pdftotext

converts PDF files to plain text

pdfunite

merges several PDF files, in the order of their occurrence on the command line, to one PDF output file

libpoppler.so

contains the API functions to render PDF files

libpoppler-cpp.so

is a C++ backend for rendering PDF files

libpoppler-glib.so

is a wrapper library used to interface the PDF rendering functions with GTK+

libpoppler-qt5.so

is a wrapper library used to interface the PDF rendering functions with Qt5

Potrace-1.16

Introduction to Potrace

Potrace™ is a tool for transforming a bitmap (PBM, PGM, PPM, or BMP format) into one of several vector file formats.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Potrace Dependencies

Recommended

Installation of Potrace

Install Potrace by running the following commands:

./configure --prefix=/usr                        \
            --disable-static                     \
            --docdir=/usr/share/doc/potrace-1.16 \
            --enable-a4                          \
            --enable-metric                      \
            --with-libpotrace                    &&
make

To run the test suite, issue: make check.

Now, as the root user:

make install

Command Explanations

--enable-a4: Use A4 as the default paper size.

--enable-metric: Use metric units (centimeters) as default

--disable-static: This switch prevents installation of static versions of the libraries.

--with-libpotrace: Install the library and headers.

Contents

Installed Programs: mkbitmap, potrace
Installed Libraries: libpotrace.so
Installed Directories: /usr/share/doc/potrace-1.16

Short Descriptions

mkbitmap

transforms images into bitmaps with scaling and filtering

potrace

transforms bitmaps into vector graphics

libpotrace.so

is a library for transforming bitmaps into vector graphics

Qpdf-11.5.0

Introduction to Qpdf

The Qpdf package contains command-line programs and a library that does structural, content-preserving transformations on PDF files.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Qpdf Dependencies

Required

libjpeg-turbo-3.0.0

Optional

ghostscript-10.01.2, GnuTLS-3.8.1, libtiff-4.5.1, sphinx-7.1.2 with sphinx_rtd_theme-1.2.2, and texlive-20230313 or install-tl-unx

Installation of Qpdf

Install Qpdf by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DBUILD_STATIC_LIBS=OFF     \
      -DCMAKE_INSTALL_DOCDIR=/usr/share/doc/qpdf-11.5.0 \
      .. &&
make

To test the results, issue: ctest.

Now, as the root user:

make install

Contents

Installed Programs: fix-qdf, qpdf, and zlib-flate
Installed Library: libqpdf.so
Installed Directories: /usr/lib/cmake/qpdf, /usr/include/qpdf, and /usr/share/doc/qpdf-11.5.0

Short Descriptions

fix-qdf

is used to repair PDF files in QDF form after editing

qpdf

is used to convert one PDF file to another equivalent PDF file

zlib-flate

is a raw zlib compression program

libqpdf.so

contains the Qpdf API functions

qrencode-4.1.1

Introduction to qrencode

Qrencode is a fast and compact library for encoding data in a QR Code symbol, a 2D symbology that can be scanned by handheld terminals such as a mobile phone with a CCD sensor.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://fukuchi.org/works/qrencode/qrencode-4.1.1.tar.bz2

  • Download MD5 sum: de7185bcab635a34730e1b73d4efa705

  • Download size: 451 KB

  • Estimated disk space required: 5.0 MB (with documentation, add 5 MB for tests)

  • Estimated build time: less than 0.1 SBU, add 0.1 SBU for tests

Qrencode Dependencies

Recommended
Optional

Doxygen-1.9.7 for generating documentation, and SDL2-2.28.2 for tests

Installation of qrencode

Install libqrencode by running the following commands:

./configure --prefix=/usr &&
make

If you have installed Doxygen-1.9.7, you can build the documentation by issuing:

doxygen

The tests must be run after installing the package.

Now, as the root user:

make install

If you have built the optional documentation, install it as the root user:

install -vdm 755 /usr/share/doc/qrencode-4.1.1 &&
mv html/* /usr/share/doc/qrencode-4.1.1

To test the results, if you have passed the --with-tests option to configure, issue: make check.

Command Explanations

--with-tests: This option allows building the test programs. It requires SDL2-2.28.2.

--without-tools: This option prevents building the qrencode executable, removing the need for libpng-1.6.40.

Contents

Installed Program: qrencode
Installed Library: libqrencode.so
Installed Directory: /usr/share/doc/qrencode-4.1.1 (optional)

Short Descriptions

qrencode

encodes input data in a QR Code and saves it as a PNG or EPS image

libqrencode.so

contains functions for encoding data in a QR code symbol

sassc-3.6.2

Introduction to sassc

SassC is a wrapper around libsass, a CSS pre-processor language.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Installation of sassc

First, build the library:

tar -xf ../libsass-3.6.5.tar.gz &&
pushd libsass-3.6.5 &&

autoreconf -fi &&

./configure --prefix=/usr --disable-static &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Build the command line wrapper:

popd &&
autoreconf -fi &&

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: sassc
Installed Libraries: libsass.so
Installed Directories: /usr/include/sass

Short Descriptions

sassc

provides a command line interface to the libsass library

webp-pixbuf-loader-0.2.4

Introduction to webp-pixbuf-loader

The webp-pixbuf-loader package contains a library that allows gdk-pixbuf to load and process webp images.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

webp-pixbuf-loader Dependencies

Required

gdk-pixbuf-2.42.10 and libwebp-1.3.1

Installation of webp-pixbuf-loader

Install webp-pixbuf-loader by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

The webp format needs to be added to the loaders cache:

gdk-pixbuf-query-loaders --update-cache

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

gdk-pixbuf-query-loaders --update-cache: This command updates the gdk-pixbuf loader cache so that it knows the webp loader has been installed.

Contents

Installed Programs: None
Installed Libraries: libpixbufloader-webp.so
Installed Directories: None

Short Descriptions

libpixbufloader-webp.so

contains functions that allow gdk-pixbuf to load webp images

woff2-1.0.2

Introduction to WOFF2

WOFF2 is a library for converting fonts from the TTF format to the WOFF 2.0 format. It also allows decompression from WOFF 2.0 to TTF. The WOFF 2.0 format uses the Brotli compression algorithm to compress fonts suitable for downloading in CSS @font-face rules.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

WOFF2 Dependencies

Required

Brotli-1.0.9 and CMake-3.27.2

Installation of WOFF2

Install WOFF2 by running the following commands:

mkdir out                           &&
cd    out                           &&
cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release .. &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: None
Installed Libraries: libwoff2common.so, libwoff2dec.so and libwoff2enc.so
Installed Directory: /usr/include/woff2

Short Descriptions

libwoff2common.so

provides shared data used by the libwoff2dec and libwoff2enc libraries

libwoff2dec.so

is the WOFF2 decoder library

libwoff2enc.so

is the WOFF2 encoder library

Chapter 11. General Utilities

This chapter contains various utilities that do not fit conveniently into other chapters. Programs include some documentation generators, several utilities for manipulating text and graphics, programs for listing files, a program for entering PIN numbers and pass-phrases, and a connection manager.

Asciidoctor-2.0.20

Introduction to Asciidoctor

Asciidoctor is a fast, open source text processor and publishing toolchain for converting AsciiDoc content to HTML5, DocBook, PDF, and other formats.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Asciidoctor Dependencies

Required

Ruby-3.2.2

Installation of Asciidoctor

Note

When building this package, the following message may appear:

                fatal: not a git repository (or any of the parent directories): .git

. This is normal, and the package will continue building past this point.

Build the Ruby gem:

gem build asciidoctor.gemspec

The test suite needs many Ruby gems beyond the scope of BLFS.

Now, as the root user:

gem install asciidoctor-2.0.20.gem &&
install -vm644 man/asciidoctor.1 /usr/share/man/man1

Contents

Installed Programs: asciidoctor
Installed Libraries: None
Installed Directories: /usr/lib/ruby/gems/3.2.0/gems/asciidoctor-2.0.20 and /usr/lib/ruby/gems/3.2.0/doc/asciidoctor-2.0.20

Short Descriptions

asciidoctor

converts AsciiDoc source files to HTML, DocBook, and other formats

Bogofilter-1.2.5

Introduction to Bogofilter

The Bogofilter application is a mail filter that classifies mail as spam or ham (non-spam) by a statistical analysis of the message's header and content (body).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Bogofilter Dependencies

Required

Berkeley DB-5.3.28

Recommended
Optional

lmdb-0.9.31, SQLite-3.42.0, xmlto-0.0.28, QDBM and TokyoCabinet

Note

If you do not install the recommended Gsl-2.7.1 package then a statically linked shipped version will be used instead.

Installation of Bogofilter

Note

If you plan to change the version of your database library on an existing installation, or to change to a different database, read the warning at the top of the RELEASE.NOTES file.

Install Bogofilter by running the following commands:

./configure --prefix=/usr --sysconfdir=/etc/bogofilter &&
make

To test the results, issue make check.

Now, as the root user:

make install

Command Explanations

--with-database=: This switch allows you to change the default database from db to either qdbm, sqlite3 or tokyocabinet.

Contents

Installed Programs: bf_compact, bf_copy, bf_tar, bogofilter, bogolexer, bogotune, bogoupgrade and bogoutil
Installed Libraries: None
Installed Directories: /etc/bogofilter

Short Descriptions

bf_compact

creates a more compact bogofilter working directory with a dump/load cycle

bf_copy

copies a bogofilter working directory to another directory

bf_tar

bundles a bogofilter working directory in tar format and copies it to standard output

bogofilter

is a fast Bayesian spam filter

bogolexer

is used to separate messages into tokens and to test new versions of the lexer.l code

bogotune

attempts to find optimum parameter settings for bogofilter

bogoupgrade

upgrades the bogofilter database to the current version

bogoutil

dumps, loads, and maintains bogofilter database files

Compface-1.5.2

Introduction to Compface

Compface provides utilities and a library to convert from/to X-Face format, a 48x48 bitmap format used to carry thumbnails of email authors in a mail header.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Compface

Install Compface by running the following commands:

./configure --prefix=/usr --mandir=/usr/share/man &&
make

This package does not come with a test suite.

Now, as the root user:

make install &&
install -m755 -v xbm2xface.pl /usr/bin

Contents

Installed Programs: compface, uncompface and xbm2xface.pl
Installed Library: libcompface.{so,a}
Installed Directories: None

Short Descriptions

compface

is a filter for generating highly compressed representations of 48x48x1 face image files

uncompface

is an inverse filter which performs an inverse transformation with no loss of data

xbm2xface.pl

is a script to generate xfaces

libcompface.{so,a}

allows the compression and decompression algorithms to be used in other programs such as MTAs

desktop-file-utils-0.26

Introduction to Desktop File Utils

The Desktop File Utils package contains command line utilities for working with Desktop entries. These utilities are used by Desktop Environments and other applications to manipulate the MIME-types application databases and help adhere to the Desktop Entry Specification.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Desktop File Utils Dependencies

Required

GLib-2.76.4

Optional

Emacs-29.1

Installation of Desktop File Utils

Warning

If you are upgrading from a previous version of desktop-file-utils that used the Autotools method of installing and configuring the package, you must remove the desktop-file-edit symlink by using the following commands.

rm -fv /usr/bin/desktop-file-edit

Next, update the version of the desktop file standard to accept the SingleMainWindow key:

patch -Np1 -i ../desktop-file-utils-0.26-update_standard-1.patch

Install Desktop File Utils by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Configuring Desktop File Utils

Configuration Information

The XDG Base Directory specification defines the standard locations for applications to place data and configuration files. These files can be used, for instance, to define the menu structure and menu items in a desktop environment.

The default location for configuration files to be installed is /etc/xdg, and the default locations for data files are /usr/local/share and /usr/share. These locations can be extended with the environment variables XDG_CONFIG_DIRS and XDG_DATA_DIRS, respectively. The GNOME, KDE and XFCE environments respect these settings.

When a package installs a .desktop file to a location in one of the base data directories, the database that maps MIME-types to available applications can be updated. For instance, the cache file at /usr/share/applications/mimeinfo.cache can be rebuilt by executing the following command as the root user:

install -vdm755 /usr/share/applications &&
update-desktop-database /usr/share/applications

Contents

Installed Programs: desktop-file-edit, desktop-file-install, desktop-file-validate and update-desktop-database
Installed Libraries: None
Installed Directories: None

Short Descriptions

desktop-file-edit

is used to modify an existing desktop file entry

desktop-file-install

is used to install a new desktop file entry. It is also used to rebuild or modify the MIME-types application database

desktop-file-validate

is used to verify the integrity of a desktop file

update-desktop-database

is used to update the MIME-types application database

dos2unix-7.5.0

Introduction to dos2unix

The dos2unix package contains an any to any text format converter.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of dos2unix

Build dos2unix by running the following commands:

make

To test the results, issue: make check.

Now, as the root user:

make install

Contents

Installed Program: dos2unix, mac2unix, unix2dos, and unix2mac
Installed Libraries: None
Installed Directories: /usr/share/doc/dos2unix-7.5.0

Short Descriptions

dos2unix

converts plain text files in DOS format to Unix format

mac2unix

converts plain text files in Mac format to Unix format

unix2dos

converts plain text files in Unix format to DOS format

unix2mac

converts plain text files in Unix format to Mac format

Graphviz-8.1.0

Introduction to Graphviz

The Graphviz package contains graph visualization software. Graph visualization is a way of representing structural information as diagrams of abstract graphs and networks. Graphviz has several main graph layout programs. It also has web and interactive graphical interfaces, auxiliary tools, libraries, and language bindings.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Graphviz Dependencies

Note

Graphviz basic usage does not need any libraries out of what is found in the LFS book. Its core rendering engine allows to generate several graphic formats, such as Postscript, SVG, VML, .fig, and Tk. Those formats can be converted to almost any other format using for example tools from ImageMagick-7.1.1-15. The dependencies below add the ability to generate graph images in bitmap format, to display the graph image on screen, to edit a graph by viewing the resulting image directly, or to view large graphs. Since Graphviz is a dependency of several other packages in this book, it is suggested to first build it without any dependencies, then to rebuild it when you have built enough packages to suit your needs.

Optional, for various bitmap outputs

Pango-1.50.14, with Cairo-1.17.6, Xorg Libraries, Fontconfig-2.14.2, and libpng-1.6.40, to generate images in bitmap SVG, postscript, PNG, and PDF formats, or displaying the image on screen. The PNG output is required for building gegl-0.4.46

Adding GTK+-2.24.33 with libjpeg-turbo-3.0.0 adds support for JPEG, BMP, TIF, and ICO formats, and allows displaying the image in a GTK+ window

GD Library may be used instead of Pango. It adds the ability to generate images in GIF, VRML, and GD formats, but Pango provides better outputs for the other formats, and is needed for displaying images

Other formats may be added with libwebp-1.3.1 (WebP support is considered experimental), DevIL, libLASi, and glitz

Optional, to load graphic images that may be displayed inside the nodes of a graph

libgs.so from ghostscript-10.01.2, librsvg-2.56.3, and Poppler-23.08.0

Optional, to build more tools

Freeglut-3.4.0 (with libglade-2.6.4, GtkGLExt, and libGTS, for building the smyrna large graph viewer, which is considered experimental), and (Qt-5.15.10 or qt-alternate-5.15.10) (for building the gvedit graph editor.)

Optional (To Build Language Bindings)

SWIG-4.1.1 (SWIG must be installed or no bindings will be built), GCC-13.2.0 (for the go compiler), Guile-3.0.9, OpenJDK-20.0.2, Lua-5.4.6, PHP-8.2.9, Ruby-3.2.2, Tk-8.6.13, Io, Mono, OCaml, and R

Optional (building tools)

Criterion (framework for tests) and Electric Fence

Optional (for building the pdf documentation)

ghostscript-10.01.2 (for the ps2pdf command)

Installation of Graphviz

Install Graphviz by running the following commands:

sed -i '/LIBPOSTFIX="64"/s/64//' configure.ac &&

./autogen.sh              &&
./configure --prefix=/usr \
            --docdir=/usr/share/doc/graphviz-8.1.0

Note

A warning is generated by autogen.sh because the build tree is not a git repository. As a result, the build date is set to 0. To get a meaningful date in the version string, you can run:

sed -i "s/0/$(date +%Y%m%d)/" builddate.h

Whether or not you fix the date, proceed to compile the package:

make

This package does not come with a test suite that provides meaningful results.

Now, as the root user:

make install

Command Explanations

sed ... configure.ac: This command is needed to avoid installing files in /usr/lib64.

--with-javaincludedir="$JAVA_HOME/include -I$JAVA_HOME/include/linux": If you have built OpenJDK-20.0.2 in /opt, and you want to build the JAVA bindings, it is necessary to specify the location of the JAVA header files to configure. The configure switch is designed for only one directory, but two directories need to be included. This is possible nevertheless by using the -I switch inside the variable.

--with-webp: Even if libwebp-1.3.1 is installed, it is not included in the build without this option.

--with-smyrna: Even if the needed dependencies are installed, the interactive graph viewer smyrna is not built without this option.

Configuring Graphviz

Config Files

/usr/lib/graphviz/config

Configuration Information

There are no specific configuration requirements for Graphviz. You may consider installing the additional plugins and tools available from the download page at https://graphviz.org/download/source/ for additional capabilities. If additional plugins are installed, you can run dot -c (as the root user) to update the config file in /usr/lib/graphviz.

Contents

Installed Programs: acyclic, bcomps, ccomps, circo, cluster, dijkstra, dot, dot2gxl, dot_builtins, edgepaint, fdp, gc, gml2gv, graphml2gv, gv2gml, gv2gxl, gvcolor, gvedit, gvgen, gvmap, gvmap.sh, gvpack, gvpr, gxl2dot, gxl2gv, mm2gv, neato, nop, osage, patchwork, prune, sccmap, sfdp, tred, twopi, unflatten, and vimdot
Installed Libraries: libcdt.so, libcgraph.so, libgvc.so, libgvpr.so, liblab_gamut.so, libpathplan.so, libxdot.so, and several plugins in /usr/lib/graphviz. There are also several in subdirectories of /usr/lib/{lua,perl5,php,python3.11,tcl8.6}. Unfortunately, some libraries are duplicated.
Installed Directories: /usr/include/graphviz, /usr/lib/graphviz, /usr/lib/tcl8.6/graphviz, /usr/share/doc/graphviz-8.1.0, and /usr/share/graphviz

Short Descriptions

acyclic

is a filter that takes a directed graph as input and outputs a copy of the graph with sufficient edges reversed to make the graph acyclic

bcomps

decomposes graphs into their biconnected components, printing the components to standard output

ccomps

decomposes graphs into their connected components, printing the components to standard output

circo

draws graphs using a circular layout

cluster

takes a graph in DOT format as input, finds node clusters and then augments the graph with this information

diffimg

(needs GD Library) generates an image where each pixel is the difference between the corresponding pixel in each of the two source images

dijkstra

reads a stream of graphs and for each computes the distance of every node from sourcenode

dot

draws directed graphs. It works well on DAGs and other graphs that can be drawn as hierarchies. It reads attributed graph files and writes drawings. By default, the output format dot is the input file with layout coordinates appended

dot2gxl

converts between graphs represented in GXL and in the DOT language. Unless a conversion type is specified using a flag, gxl2dot will deduce the type of conversion from the suffix of the input file, a .dot suffix causing a conversion from DOT to GXL, and a .gxl suffix causing a conversion from GXL to DOT

edgepaint

performs edge coloring to disambiguate crossing edges

fdp

draws undirected graphs using a spring model. It relies on a force-directed approach in the spirit of Fruchterman and Reingold

gc

is a graph analogue to wc in that it prints to standard output the number of nodes, edges, connected components or clusters contained in the input files. It also prints a total count for all graphs if more than one graph is given

gml2gv

converts a graph specified in the GML format to a graph in the GV (formerly DOT) format

graphml2gv

converts a graph specified in the GRAPHML format to a graph in the GV (formerly DOT) format

gv2gml

converts a graph specified in the GV format to a graph in the GML format

gv2gxl

converts a graph specified in the GV format to a graph in the GXL format

gvcolor

is a filter that sets node colors from initial seed values. Colors flow along edges from tail to head, and are averaged (as HSB vectors) at nodes

gvedit

provides a simple graph editor and viewer. It allows many graphs to be viewed at the same time. The text of each graph is displayed in its own text window

gvgen

generates a variety of simple, regularly-structured abstract graphs

gvmap

takes as input a graph in DOT format, finds node clusters and produces a rendering of the graph as a geographic-style map, with clusters highlighted, in xdot format

gvmap.sh

is a pipeline for running gvmap

gvpack

reads in a stream of graphs, combines the graphs into a single layout, and produces a single graph serving as the union of the input graphs

gvpr

is a graph stream editor inspired by awk. It copies input graphs to its output, possibly transforming their structure and attributes, creating new graphs, or printing arbitrary information

gxl2dot

converts between graphs represented in GXL and in the DOT language. Unless a conversion type is specified using a flag, gxl2dot will deduce the type of conversion from the suffix of the input file, a .dot suffix causing a conversion from DOT to GXL, and a .gxl suffix causing a conversion from GXL to DOT

gxl2gv

converts between graphs represented in GXL and in the GV language

mm2gv

converts a sparse matrix of the Matrix Market format to a graph in the GV (formerly DOT) format

neato

draws undirected graphs using spring models. Input files must be formatted in the dot attributed graph language. By default, the output of neato is the input graph with layout coordinates appended

nop

reads a stream of graphs and prints each in pretty-printed (canonical) format on stdout. If no files are given, it reads from stdin

osage

draws clustered graphs. It takes any graph in DOT format as input

patchwork

draws clustered graphs using a squarified treemap layout. It takes any graph in DOT format as input

prune

reads directed graphs in the same format used by dot and removes subgraphs rooted at nodes specified on the command line via options

sccmap

decomposes digraphs into strongly connected components and an auxiliary map of the relationship between components. In this map, each component is collapsed into a node. The resulting graphs are printed to stdout

sfdp

draws undirected graphs using the spring model, but it uses a multi-scale approach to produce layouts of large graphs in a reasonably short time

tred

computes the transitive reduction of directed graphs, and prints the resulting graphs to standard output. This removes edges implied by transitivity. Nodes and subgraphs are not otherwise affected

twopi

draws graphs using a radial layout. Basically, one node is chosen as the center and put at the origin. The remaining nodes are placed on a sequence of concentric circles centered about the origin, each a fixed radial distance from the previous circle

unflatten

is a preprocessor to dot that is used to improve the aspect ratio of graphs having many leaves or disconnected nodes. The usual layout for such a graph is generally very wide or tall

vimdot

is a simple script which launches the gvim or vim editor along with a GUI window showing the dot output of the edited file

libcdt.so

manages run-time dictionaries using standard container data types: unordered set/multiset, ordered set/multiset, list, stack, and queue

libcgraph.so

supports graph programming by maintaining graphs in memory and reading and writing graph files. Graphs are composed of nodes, edges, and nested subgraphs

libgvc.so

provides a context for applications wishing to manipulate and render graphs. It provides command line parsing interfaces, common rendering code, and a plugin mechanism for renderers

libpathplan.so

contains functions to find the shortest path between two points in a simple polygon

libxdot.so

provides support for parsing and deparsing graphical operations specified by the xdot language

GTK-Doc-1.33.2

Introduction to GTK-Doc

The GTK-Doc package contains a code documenter. This is useful for extracting specially formatted comments from the code to create API documentation. This package is optional; if it is not installed, packages will not build the documentation. This does not mean that you will not have any documentation. If GTK-Doc is not available, the install process will copy any pre-built documentation to your system.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GTK-Doc Dependencies

Required

docbook-xml-4.5, docbook-xsl-nons-1.79.2, itstool-2.0.7, and libxslt-1.1.38

Recommended
Optional

For tests: dblatex or fop-2.9 (XML PDF support), GLib-2.76.4, Which-2.21, and Python modules lxml-4.9.3, parameterized, and yelp-tools

Note

The optional python modules above can be easily installed with the pip3 command.

Installation of GTK-Doc

Install GTK-Doc by running the following commands:

autoreconf -fiv           &&
./configure --prefix=/usr &&
make

The test suite will hang if the package (or a previous version) is not already installed.

Now, as the root user:

make install

To test the results, issue: make check. Some tests will fail depending on optionally installed packages.

Contents

Installed Programs: gtkdocize, gtkdoc-check, gtkdoc-depscan, gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkhtml2, gtkdoc-mkman, gtkdoc-mkpdf, gtkdoc-rebase, gtkdoc-scan, and gtkdoc-scangobj
Installed Libraries: None
Installed Directories: /usr/share/gtk-doc and /usr/share/cmake/GtkDoc

Short Descriptions

gtkdoc*

these are all shell, or Python scripts used by package Makefile scripts to generate documentation for the package being built

Highlight-4.7

Introduction to Highlight

Highlight is an utility that converts source code to formatted text with syntax highlighting.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Highlight Dependencies

Required

Boost-1.83.0 and Lua-5.4.6

Optional

(Qt-5.15.10 or qt-alternate-5.15.10) (to build the GUI front-end)

Installation of Highlight

For consistency, do not compress man pages.

sed -i '/GZIP/s/^/#/' makefile

To build Highlight run the following command:

make

To build the Qt5 GUI front-end, run the following command:

make doc_dir=/usr/share/doc/highlight-4.7/ gui

This package does not come with a test suite.

To install Highlight, run the following command as the root user:

make doc_dir=/usr/share/doc/highlight-4.7/ install

To install the GUI program, run the following command as the root user:

make install-gui

Command Explanations

doc_dir=/usr/share/doc/highlight-4.7/: installs the highlight documentation into a versioned directory. This parameter is also needed for make gui, because its value would be hardcoded into the gui executable. Note that the trailing / is necessary.

Contents

Installed Programs: highlight and highlight-gui (optional)
Installed Libraries: None
Installed Directories: /etc/highlight, /usr/share/doc/highlight-4.7, and /usr/share/highlight

Short Descriptions

highlight

is a universal source code to formatted text converter

highlight-gui

is the Qt5 interface to highlight.

ibus-1.5.28

Introduction to ibus

ibus is an Intelligent Input Bus. It is a new input framework for the Linux OS. It provides a fully featured and user friendly input method user interface.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Optional Download

ibus Dependencies

Required

DConf-0.40.0, ISO Codes-4.15.0, and Vala-0.56.11

Recommended
Optional

GTK+-3.24.38 (to build IM module for it), GTK-4.12.0 (to build IM module for it), D-Bus Python-1.3.2 and PyGObject-3.44.1 (both to build the Python support library), GTK-Doc-1.33.2, and libxkbcommon-1.5.0, Wayland-1.22.0 (both to build the Wayland support programs), and EmojiOne

Installation of ibus

If the optional Unicode Character Database was downloaded, install it now as the root user:

mkdir -p                /usr/share/unicode/ucd &&
unzip -uo ../UCD.zip -d /usr/share/unicode/ucd

Note

Be sure to also remove the --disable-unicode-dict in the configure step below.

Fix an issue with deprecated schema entries:

sed -i 's@/desktop/ibus@/org/freedesktop/ibus@g' \
    data/dconf/org.freedesktop.ibus.gschema.xml

Install ibus by running the following commands:

./configure --prefix=/usr          \
            --sysconfdir=/etc      \
            --disable-python2      \
            --disable-emoji-dict   \
            --disable-unicode-dict &&
rm -f tools/main.c                 &&
make

To test the results, issue: make -k check. The test named ibus-compose fails because it uses some locales not installed in LFS. The test named ibus-keypress is known to fail in a Wayland-based graphical environment. The test named xkb-latin-layouts is known to fail with a recent xkeyboard-config release.

Now, as the root user:

make install &&
gzip -dfv /usr/share/man/man{{1,5}/ibus*.gz,5/00-upstream-settings.5.gz}

Command Explanations

--disable-emoji-dict: This switch disables the use of emoticon dictionaries. Omit if you installed the optional package.

--disable-unicode-dict: This switch disables the use of unicode dictionaries. Omit if you installed the optional Unicode Character Database.

rm -f tools/main.c: This command removes a generated file that was not removed when packaging.

--disable-gtk2: This switch disables building the GTK+ 2 immodule. Use it if you have not installed GTK+ 2.

--enable-gtk4: This switch enables building the GTK 4 immodule. Use it if you have installed GTK 4.

--enable-python-library: This switch enables building the Python support library. Use it if you have installed the optional dependencies.

--enable-wayland: This switch enables building the Wayland support programs. Use it if you have installed the optional dependencies.

--with-python=python3: This switch makes the configure script look for Python 3. Use it if you want to build the Python 3 support library alongside the Python 2 one.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

gzip -dfv ...: Decompress installed man pages in accordance with other man pages.

Configuring Ibus

If GTK+-3 or GTK+-2 are installed and --disable-gtk{3,2} are not used, the ibus IM module for GTK+-3 or GTK+-2 will be installed. As the root user, update a cache file of GTK+-3 or GTK+-2 so the GTK-based applications can find the newly installed IM module and use ibus as an input method:

gtk-query-immodules-3.0 --update-cache

The command above updates the cache file for GTK+-3. For GTK+-2, use gtk-query-immodules-2.0 instead of gtk-query-immodules-3.0. GTK-4 does not require a cache file for IM modules.

Contents

Installed Programs: ibus, ibus-daemon, and ibus-setup
Installed Library: libibus-1.0.so and im-ibus.so (GTK+ Immodule)
Installed Directories: /etc/dconf/db/ibus.d, /usr/include/ibus-1.0, /usr/share/gtk-doc/html/ibus, and /usr/share/ibus

Short Descriptions

ibus-daemon

is the Intelligent Input Bus Daemon

ibus-setup

is the GTK+ program used to configure the ibus-daemon

libibus-1.0.so

contains the ibus API functions

ImageMagick-7.1.1-15

Introduction to ImageMagick

ImageMagick is a collection of tools and libraries to read, write, and manipulate an image in various image formats. Image processing operations are available from the command line. Bindings for Perl and C++ are also available.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Note

The ImageMagick source releases are updated frequently and the version shown above may no longer be available from the download locations. You can download a more recent version and use the existing BLFS instructions to install it. Chances are that it will work just fine, but this has not been tested by the BLFS team. If the package version shown above is not available from the locations shown above, you can download it from the BLFS package server at Oregon State University: ftp://ftp.osuosl.org/pub/blfs/conglomeration/ImageMagick/.

ImageMagick Dependencies

Recommended

The optional dependencies listed below should be installed if you need support for the specific format or the conversion tool the dependency provides. Additional information about the dependencies can be found in the Install-unix.txt file located in the source tree as well as issuing the ./configure --help command. A summary of this information, as well as some additional notes can be viewed on-line at https://imagemagick.org/script/install-source.php.

Optional System Utilities

Clang from LLVM-16.0.5, Cups-2.4.6, cURL-8.2.1, FFmpeg-6.0, fftw-3.3.10, p7zip-17.04 (LZMA), SANE-1.0.32, Wget-1.21.4, xdg-utils-1.1.3, xterm-384, Dmalloc, Electric Fence and PGP or GnuPG-2.4.3 (you'll have to do some hacking to use GnuPG), Profiles

Optional Graphics Libraries

JasPer-4.0.0, Little CMS-1.19 or Little CMS-2.14, libgxps-0.3.2, libjpeg-turbo-3.0.0, libpng-1.6.40, libraw-0.21.1 (for dng files, needs the thread-safe libraw_r), librsvg-2.56.3, libtiff-4.5.1, libwebp-1.3.1, OpenJPEG-2.5.0, Pango-1.50.14, DjVuLibre, FlashPIX (libfpx), FLIF, JBIG-KIT, libheif with libde265 (both needed if converting macOS heic images), libjxl, libraqm, Liquid Rescale, OpenEXR, and RALCGM (or ralcgm)

Optional Graphics Utilities

Dejavu fonts, ghostscript-10.01.2, Gimp-2.10.34, Graphviz-8.1.0, Inkscape-1.3, Blender, corefonts, GhostPCL, Gnuplot, POV-Ray, and Radiance

Optional Conversion Tools

Enscript-1.6.6, Potrace-1.16, texlive-20230313 (or install-tl-unx) AutoTrace, GeoExpress Command Line Utilities, AKA MrSID Utilities (binary package), hp2xx, libwmf, UniConvertor, and Utah Raster Toolkit (or URT-3.1b)

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/imagemagick

Installation of ImageMagick

Install ImageMagick by running the following commands:

./configure --prefix=/usr     \
            --sysconfdir=/etc \
            --enable-hdri     \
            --with-modules    \
            --with-perl       \
            --disable-static  &&
make

Now, as the root user:

make DOCUMENTATION_PATH=/usr/share/doc/imagemagick-7.1.1 install

To test the installation, issue: make check. Note that the EPS, PS, and PDF tests require a working Ghostscript. One test in 'make check' needs Helvetica from Ghostscript Standard Fonts, which are optionally installed in ghostscript-10.01.2 - that test, and one other, might fail, but all the validation can still pass.

Command Explanations

--enable-hdri: Enables building of a high dynamic range version of ImageMagick.

--with-modules: Enables support for dynamically loadable modules.

--with-perl: Enables building and installing of PerlMagick.

--disable-static: This switch prevents installation of static versions of the libraries.

--with-gslib: Enables support to use the Ghostscript shared library.

--with-rsvg: Enables support to use the librsvg library.

--with-autotrace: Enables support to use the Autotrace library.

--with-wmf: Enables support to use the libwmf library.

--with-gvc: Enables support to use GraphViz.

--with-windows-font-dir= <Some/Directory>: This option specifies the directory where the Windows CoreFonts are installed.

--with-dejavu-font-dir= <Some/Directory>: This option specifies the directory where the DejaVu fonts are installed.

The options and parameters listed above are the only ones you should have to pass to the configure script to activate all the delegate dependencies. All other dependencies will be automatically detected and utilized in the build if they are installed.

Contents

Installed Programs: magick, Magick++-config, MagickCore-config, and MagickWand-config. (animate, compare, composite, conjure, convert, display, identify, import, magick-script, mogrify, montage, and stream are all symbolic links to magick)
Installed Libraries: libMagickCore-7.Q16HDRI.so, libMagickWand-7.Q16HDRI.so and libMagick++-7.Q16HDRI.so
Installed Directories: /etc/ImageMagick-7, /usr/include/ImageMagick-7, /usr/lib/ImageMagick-7.1.1, /usr/lib/perl5/site_perl/5.38/{,auto}/Image/Magick, /usr/share/doc/ImageMagick-7.1.1, and /usr/share/ImageMagick-7

Short Descriptions

animate

animates a sequence of images

compare

compares an image to a reconstructed image

composite

composites various images into the given base image

conjure

processes a MSL script to create an image

convert

converts image(s) from one format to another

display

displays an image

identify

describes the format and characteristics of an image file

import

captures an X window

magick

convert between image formats as well as resize an image, blur, crop, despeckle, dither, draw on, flip, join, re-sample and much more

Magick{++,Core,Wand}-config

show information about the installed versions of the ImageMagick libraries

mogrify

transforms an image

montage

composites various images into a new image

stream

streams one or more pixel components of an image or portion of the image to your choice of storage formats

Image::Magick

allows the reading, manipulation and writing of a large number of image file formats using the ImageMagick library. Run make in the PerlMagick/demo directory of the package source tree after the package is installed to see a nice demo of the module's capabilities

libMagickCore-7.Q16HDRI.so

provides the C API for ImageMagick

libMagickWand-7.Q16HDRI.so

is the recommended C API for ImageMagick. Unlike the MagickCore API it uses only a few opaque types

libMagick++-7.Q16HDRI.so

provides the C++ API for ImageMagick

ISO Codes-4.15.0

Introduction to ISO Codes

The ISO Codes package contains a list of country, language and currency names and it is used as a central database for accessing this data.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of ISO Codes

The directory is called iso-codes-4.15.0.

Install ISO Codes by running the following commands:

./configure --prefix=/usr &&
make

To test the results, issue: make check.

Note

If you install ISO codes over a previous installed version, the install step will fail when creating some symlinks. In order to properly update them, run:

sed -i '/^LN_S/s/s/sfvn/' */Makefile

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: None
Installed Directory: /usr/share/iso-codes, /usr/share/xml/iso-codes

lsof-4.95.0

Introduction to lsof

The lsof package is useful to LiSt Open Files for a given running application or process.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

lsof Dependencies

Required

libtirpc-1.3.3

Optional

Nmap-7.94 (with a symbolic link nc pointing to ncat in /usr/bin; used in tests)

Kernel Configuration

To run the tests, the following option should be enabled in the kernel configuration:

General setup --->
  [*] POSIX Message Queues                                        [POSIX_MQUEUE]

Installation of lsof

Install lsof by running the following commands:

./Configure -n linux &&
make

The tests should be run as the root user. They require that the POSIX message queues are enabled in the kernel, and that Nmap-7.94 be installed with a symbolic link /usr/bin/nc pointing to ncat.

make check

One test, case-20-ux-socket-endpoint, is known to fail. Other test may fail if the tests are run in a script.

Now, as the root user:

install -v -m4755 -o root -g root lsof /usr/bin &&
install -v lsof.8 /usr/share/man/man8

Command Explanations

./Configure -n linux: Avoid AFS, customization, and inventory checks, and use the linux dialect.

install -m4755 ...: lsof should be suid root to allow users to list all files. This may be a security threat on some systems. In that case change to -m755 and use sudo to run the program.

Contents

Installed Program: lsof
Installed Libraries: None
Installed Directories: None

Short Descriptions

lsof

lists open files for running processes

mandoc-1.14.6

Introduction to mandoc

mandoc is an utility to format manual pages.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of mandoc

Many utilities provided by mandoc conflicts with Man-DB in LFS. Only build the mandoc command:

./configure &&
make mandoc

To test the package, issue: make regress.

Now, as the root user:

install -vm755 mandoc   /usr/bin &&
install -vm644 mandoc.1 /usr/share/man/man1

Contents

Installed Programs: mandoc

Short Descriptions

mandoc

Formats manual pages

pinentry-1.2.1

Introduction to PIN-Entry

The PIN-Entry package contains a collection of simple PIN or pass-phrase entry dialogs which utilize the Assuan protocol as described by the Ägypten project. PIN-Entry programs are usually invoked by the gpg-agent daemon, but can be run from the command line as well. There are programs for various text-based and GUI environments, including interfaces designed for Ncurses (text-based), and for the common GTK and Qt toolkits.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

PIN-Entry Dependencies

Required

libassuan-2.5.6 and libgpg-error-1.47

Optional

Emacs-29.1, FLTK-1.3.8, Gcr-3.41.1, GTK+-2.24.33, KDE Frameworks-5.109.0 (or kwayland-5.109.0 for lxqt), libsecret-0.21.0, (Qt-5.15.10 or qt-alternate-5.15.10), and efl

Installation of PIN-Entry

Install PIN-Entry by running the following commands:

./configure --prefix=/usr --enable-pinentry-tty &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--enable-inside-emacs=yes/no: Default is no.

--enable-pinentry-qt=yes/no: Default is yes.

--enable-pinentry-gtk2=yes/no: Default is yes. Even if other pinentry-* is installed, pinentry will be a symlink to pinentry-gtk-2.

--enable-pinentry-gnome3=yes/no: Default is yes. Actually, it uses Gcr for the pinentry dialog.

--enable-pinentry-tty: Default is 'maybe'.

Contents

Installed Programs: pinentry (symlink), pinentry-curses, pinentry-emacs, pinentry-fltk, pinentry-gnome3, pinentry-gtk-2, pinentry-qt, and pinentry-tty
Installed Libraries: None
Installed Directory: None

Short Descriptions

pinentry

is a symbolic link to the default PIN-Entry program

pinentry-curses

is an Ncurses text-based PIN-Entry helper program

pinentry-emacs

is an Emacs version of the PIN-Entry helper program

pinentry-fltk

is a FLTK PIN-Entry helper program

pinentry-gnome3

is a GNOME-3 PIN-Entry helper program

pinentry-gtk-2

is a GTK+2 PIN-Entry program program

pinentry-qt

is a Qt4 or 5 PIN-Entry helper program

pinentry-tty

is a tty PIN-Entry helper program

Rep-gtk-0.90.8.3

Introduction to Rep-gtk

The rep-gtk package contains a Lisp and GTK binding. This is useful for extending GTK-2 and GDK libraries with Lisp. Starting at rep-gtk-0.15, the package contains the bindings to GTK and uses the same instructions. Both can be installed, if needed.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Rep-gtk Dependencies

Required

GTK+-2.24.33 and librep-0.92.7

Installation of Rep-gtk

Install rep-gtk by running the following commands:

./autogen.sh --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: Lisp bindings
Installed Directory: /usr/include/rep-gtk and /usr/lib/rep/gui

Short Descriptions

Lisp bindings

are libraries stored in /usr/lib/rep/gui/ that assist communication between Lisp and the GTK libraries

Screen-4.9.1

Introduction to Screen

Screen is a terminal multiplexor that runs several separate processes, typically interactive shells, on a single physical character-based terminal. Each virtual terminal emulates a DEC VT100 plus several ANSI X3.64 and ISO 2022 functions and also provides configurable input and output translation, serial port support, configurable logging, multi-user support, and many character encodings, including UTF-8. Screen sessions can be detached and resumed later on a different terminal.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Screen Dependencies

Optional

Linux-PAM-1.5.3

Installation of Screen

Install Screen by running the following commands:

sh autogen.sh                                 &&
./configure --prefix=/usr                     \
            --infodir=/usr/share/info         \
            --mandir=/usr/share/man           \
            --with-socket-dir=/run/screen     \
            --with-pty-group=5                \
            --with-sys-screenrc=/etc/screenrc &&

sed -i -e "s%/usr/local/etc/screenrc%/etc/screenrc%" {etc,doc}/* &&
make

This package does not come with a test suite.

Now, as the root user:

make install &&
install -m 644 etc/etcscreenrc /etc/screenrc

Command Explanations

--with-socket-dir=/run/screen: This option places the per-user sockets in a standard location.

--with-sys-screenrc=/etc/screenrc: This option places the global screenrc file in /etc.

--with-pty-group=5: This option sets the gid to the value used by LFS.

sed -i -e "s%/usr/local/etc/screenrc%/etc/screenrc%" {etc,doc}/*: This command corrects the configuration and documentation files to the location that is used here for the global screenrc file.

Configuring Screen

Config Files

/etc/screenrc and ~/.screenrc

Configuration Information

You may want to look at the example configuration file that was installed and customize it for your needs.

Contents

Installed Program: screen (symlink) and screen-4.9.1
Installed Libraries: None
Installed Directory: /usr/share/screen and /run/screen

Short Descriptions

screen

is a terminal multiplexor with VT100/ANSI terminal emulation

shared-mime-info-2.2

Introduction to Shared Mime Info

The Shared Mime Info package contains a MIME database. This allows central updates of MIME information for all supporting applications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Shared Mime Info Dependencies

Required

GLib-2.76.4 and libxml2-2.10.4

Optional

xmlto-0.0.28

Installation of Shared Mime Info

Install Shared Mime Info by running the following commands:

If you wish to run the test suite, you must first extract the xdgmime tarball into the current directory, and compile it so that meson can find it:

tar -xf ../xdgmime.tar.xz &&
make -C xdgmime

Now build the package:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release -Dupdate-mimedb=true .. &&
ninja

If you have followed the instructions above to build xdgmime, to test the result issue ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dupdate-mimedb=true: This parameter tells the build system to run update-mime-database during installation. Otherwise, this must be done manually in order to be able to use the MIME database.

Contents

Installed Program: update-mime-database
Installed Library: None
Installed Directory: /usr/share/mime

Short Descriptions

update-mime-database

assists in adding MIME data to the database

Sharutils-4.15.2

Introduction to Sharutils

The Sharutils package contains utilities that can create 'shell' archives.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Sharutils

Fix a heap buffer overflow, and an issue exposed by GCC-10:

sed -i 's/BUFSIZ/rw_base_size/' src/unshar.c &&
sed -i '/program_name/s/^/extern /' src/*opts.h

Install Sharutils by running the following commands:

sed -i 's/IO_ftrylockfile/IO_EOF_SEEN/' lib/*.c        &&
echo "#define _IO_IN_BACKUP 0x100" >> lib/stdio-impl.h &&

./configure --prefix=/usr &&
make

To test the results, issue make check.

Now, as the root user:

make install

Contents

Installed Programs: shar, unshar, uudecode and uuencode
Installed Libraries: None
Installed Directories: None

Short Descriptions

shar

creates "shell archives" (or shar files) which are in text format and can be mailed

unshar

unpacks a shar file

uudecode

reads a file (or by default the standard input) and writes an encoded version to the standard output. The encoding uses only printing ASCII characters

uuencode

reads a file (or by default the standard input) and decodes the uuencoded version to the standard output

telepathy-mission-control-5.16.6

Introduction to Telepathy Mission Control

Telepathy Mission Control is an account manager and channel dispatcher for the Telepathy framework, allowing user interfaces and other clients to share connections to real-time communication services without conflicting.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Telepathy Mission Control Dependencies

Required

telepathy-glib-0.24.2

Recommended
Optional

D-Bus Python-1.3.2 (for the twisted tests), GTK-Doc-1.33.2, UPower-1.90.2, and Twisted (for the twisted tests)

Installation of Telepathy Mission Control

Install Telepathy Mission Control by running the following commands:

PYTHON=python3 \
./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

PYTHON=python3: prevents using Python2 if it is installed.

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: mc-tool, mc-wait-for-name and mission-control-5 (library executable)
Installed Libraries: libmission-control-plugins.so
Installed Directories: /usr/include/mission-control-5.5 and /usr/share/gtk-doc/html/mission-control-plugins

Short Descriptions

mc-tool

is a command line tool used to manipulate Mission Control accounts

mc-wait-for-name

waits for a D-Bus bus name that will be provided automatically by the desktop session

mission-control-5

is a D-Bus service which runs on the session bus to implement AccountManager and ChannelDispatcher services described in the Telepathy D-Bus specification

libmission-control-plugins.so

contains Telepathy Mission Control plugin API functions

tidy-html5-5.8.0

Introduction to Tidy HTML5

The Tidy HTML5 package contains a command line tool and libraries used to read HTML, XHTML and XML files and write cleaned up markup. It detects and corrects many common coding errors and strives to produce visually equivalent markup that is both W3C compliant and compatible with most browsers.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Tidy HTML5 Dependencies

Required

CMake-3.27.2

Recommended

Installation of Tidy HTML5

Install Tidy HTML5 by running the following commands:

cd build/cmake &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DBUILD_TAB2SPACE=ON        \
      ../..    &&

make

This package does not come with a test suite.

Now, as the root user:

make install &&
rm -fv /usr/lib/libtidy.a &&
install -v -m755 tab2space /usr/bin

Command Explanations

-DCMAKE_BUILD_TYPE=Release: This switch is used to build the release library without any debug `assert` in the code.

-DBUILD_TAB2SPACE=ON: This switch is used to enable building the tab2space utility.

Configuring Tidy HTML5

Config Files

The absolute path of the file specified in HTML_TIDY.

Configuration Information

The default configuration options can be set in the file defined in HTML_TIDY. Additional configuration options can be passed to tidy via command line parameters or the -config <file> parameter.

Contents

Installed Programs: tab2space and tidy
Installed Library: libtidy.so
Installed Directory: /usr/share/doc/tidy-5.8.0

Short Descriptions

tab2space

is a utility to expand tabs and ensure consistent line endings

tidy

validates, corrects, and pretty-prints HTML files

libtidy.so

library provides the Tidy HTML5 API functions to tidy and can also be called by other programs

Time-1.9

Introduction to Time

The time utility is a program that measures many of the CPU resources, such as time and memory, that other programs use. The GNU version can format the output in arbitrary ways by using a printf-style format string to include various resource measurements.

Although the shell has a builtin command providing similar functionalities, this utility is required by the LSB.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Time

Install Time by running the following commands:

./configure --prefix=/usr &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Contents

Installed Program: time
Installed Library: None
Installed Directory: None

Short Descriptions

time

reports various statistics about an executed command

tree-2.1.1

Introduction to tree

The tree application is useful to display a dictionary tree's contents, including files, directories, and links.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of tree

Install tree by running the following commands:

make

This package does not come with a test suite.

Now, as the root user:

make PREFIX=/usr MANDIR=/usr/share/man install &&
chmod -v 644 /usr/share/man/man1/tree.1

Contents

Installed Program: tree
Installed Libraries: None
Installed Directories: None

Short Descriptions

tree

displays a directory tree in a terminal

unixODBC-2.3.12

Introduction to unixODBC

The unixODBC package is an Open Source ODBC (Open DataBase Connectivity) sub-system and an ODBC SDK for Linux, Mac OSX, and UNIX. ODBC is an open specification for providing application developers with a predictable API with which to access data sources. Data sources include optional SQL Servers and any data source with an ODBC Driver. unixODBC contains the following components used to assist with the manipulation of ODBC data sources: a driver manager, an installer library and command line tool, command line tools to help install a driver and work with SQL, drivers and driver setup libraries.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

unixODBC Dependencies

Optional

Mini SQL and Pth-2.0.7

Installation of unixODBC

Install unixODBC by running the following commands:

./configure --prefix=/usr \
            --sysconfdir=/etc/unixODBC &&
make

This package does not come with a test suite.

Now, as the root user:

make install &&

find doc -name "Makefile*" -delete                &&
chmod 644 doc/{lst,ProgrammerManual/Tutorial}/*   &&

install -v -m755 -d /usr/share/doc/unixODBC-2.3.12 &&
cp      -v -R doc/* /usr/share/doc/unixODBC-2.3.12

Command Explanations

--enable-drivers: This parameter enables building the drivers that were installed by default in previous versions.

--enable-drivers-conf: This parameter enables building the driver configuration libraries that were installed by default in previous versions.

Configuring unixODBC

Config Files

/etc/unixODBC/*

Configuration Information

The files in /etc/unixODBC are meant to be configured by the system administrator (or the ODBC site administrator if appropriate privileges are granted to /etc/unixODBC). These files are not meant to be directly edited. The ODBC installer library is responsible for reading and writing the unixODBC config files.

Unfortunately, there are not many man, or any info pages for the various programs available in the unixODBC package. Along with the information in the Short Descriptions below and the documentation installed in /usr/share/doc/unixODBC-2.3.12, there are many README files throughout the source tree where the use and functionality of the programs can be found. Additionally, you can use the parameter -? for syntax and usage information. Lastly, the unixODBC web site at http://www.unixodbc.org/ has very good information.

Contents

Installed Programs: dltest, isql, iusql, odbc_config, odbcinst, and slencheck
Installed Libraries: libodbc.so, libodbccr.so, and libodbcinst.so
Installed Directories: /etc/unixODBC and /usr/share/doc/unixODBC-2.3.12

Short Descriptions

dltest

is a utility used to check a shared library to see if it can be loaded and if a given symbol exists in it

isql

is a utility which can be used to submit SQL to a data source and to format/output results. It can be used in batch or interactive mode

iusql

provides the same functionality as the isql program

odbc_config

is used to find out details about the installation of the unixODBC package

odbcinst

is a utility created for install script/RPM writers. It is a command line interface to key functionality in the libodbcinst library. It does not copy any files (i.e., libraries) but it will modify the ODBC System Information for the user

slencheck

is a utility which attempts to check whether an ODBC driver was built with 32-bit or 64-bit SQLLEN types

xdg-dbus-proxy-0.1.5

Introduction to xdg-dbus-proxy

The xdg-dbus-proxy package contains a filtering proxy for D-Bus connections. This is useful for forwarding data in and out of a sandbox.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

xdg-dbus-proxy Dependencies

Required

GLib-2.76.4

Installation of xdg-dbus-proxy

Install xdg-dbus-proxy by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Programs: xdg-dbus-proxy
Installed Libraries: None
Installed Directories: None

Short Descriptions

xdg-dbus-proxy

is a filtering proxy for D-Bus connections

Xdg-user-dirs-0.18

Introduction to Xdg-user-dirs

Xdg-user-dirs is a tool to help manage well known user directories like the desktop folder and the music folder. It also handles localization (i.e. translation) of the filenames.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Xdg-user-dirs Dependencies

Optional

docbook-xml-4.5, docbook-xsl-nons-1.79.2, and libxslt-1.1.38 (all three for building the man pages)

Installation of Xdg-user-dirs

Install xdg-user-dirs by running the following commands:

./configure --prefix=/usr           \
            --sysconfdir=/etc       \
            --disable-documentation &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-documentation: Disable the installation of the man pages. Remove this switch if you've installed the optional dependencies and you wish to install the man pages of this package.

Configuring Xdg-user-dirs

Config Files

~/.config/user-dirs.dirs, /etc/xdg/user-dirs.conf, and /etc/xdg/user-dirs.defaults. Those default locations can be overridden by XDG_CONFIG_HOME and XDG_CONFIG_DIRS

Contents

Installed Programs: xdg-user-dir and xdg-user-dirs-update
Installed Library: None
Installed Directory: None

Short Descriptions

xdg-user-dir

looks up the current path for one of the XDG user directories

xdg-user-dirs-update

creates localized versions of the user directories

Chapter 12. System Utilities

This chapter contains mainly hardware utilities. It also contains some applications used by other applications in the book for installation or configuration purposes.

AccountsService-23.13.9

Introduction to AccountsService

The AccountsService package provides a set of D-Bus interfaces for querying and manipulating user account information and an implementation of those interfaces based on the usermod(8), useradd(8) and userdel(8) commands.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

AccountsService Dependencies

Required

Polkit-123

Recommended
Optional

GTK-Doc-1.33.2 and xmlto-0.0.28

Optional (for tests)

dbusmock-0.29.1 and PyGObject-3.44.1

Installation of AccountsService

First, rename a directory whose presence prevents the build system from running if dbusmock-0.29.1 is not installed:

mv tests/dbusmock{,-tests}

Then fix the tests so that the new directory is found:

sed -e '/accounts_service\.py/s/dbusmock/dbusmock-tests/' \
    -i tests/test-libaccountsservice.py

Fix one test that fails if the en_IE.UTF-8 locale is not installed:

sed -i '/^SIMULATED_SYSTEM_LOCALE/s/en_IE.UTF-8/en_HK.iso88591/' tests/test-daemon.py

Install AccountsService by running the following commands:

mkdir build &&
cd    build &&

meson setup ..            \
      --prefix=/usr       \
      --buildtype=release \
      -Dadmin_group=adm   &&
ninja

To test the package, issue ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dadmin_group=adm: This switch sets the group for administrator accounts.

-Ddocbook=true: This switch enables building the D-Bus interface API documentation (needs xmlto-0.0.28).

-Dgtk_doc=true: This switch enables building the libaccountsservice API documentation (needs GTK-Doc-1.33.2).

-Dvapi=false: This switch disables building the vala bindings. Use it if you have not installed Vala-0.56.11.

Configuring AccountsService

To allow users in the adm group to be listed as Administrators, execute the following commands as the root user:

cat > /etc/polkit-1/rules.d/40-adm.rules << "EOF"
polkit.addAdminRule(function(action, subject) {
   return ["unix-group:adm"];
   });
EOF

Systemd Unit

To start the accounts-daemon daemon at boot, enable the previously installed systemd unit by running the following command as the root user:

systemctl enable accounts-daemon

Contents

Installed Programs: accounts-daemon (in /usr/libexec)
Installed Libraries: libaccountsservice.so
Installed Directories: /usr/include/accountsservice-1.0, /usr/share/accountsservice, /usr/share/gtk-doc/html/libaccountsservice (optional), and /var/lib/AccountsService

Short Descriptions

accounts-daemon

is the AccountsService daemon

libaccountsservice.so

contains the AccountsService API functions

acpid-2.0.34

Introduction to acpid

The acpid (Advanced Configuration and Power Interface event daemon) is a completely flexible, totally extensible daemon for delivering ACPI events. It listens on netlink interface and when an event occurs, executes programs to handle the event. The programs it executes are configured through a set of configuration files, which can be dropped into place by packages or by the user.

Note

Some other packages may handle some ACPI events as well and they may conflict with this package. For example, Systemd-254 (read the documentation for Handle*= in logind.conf(5) for details) and UPower-1.90.2 (used by many desktop environments such as GNOME, KDE, and XFCE for handling ACPI events). If you've installed such a package and it's enough for your use case, this package is probably not needed. If you really need this package, you must be careful configuring it and the other packages handling ACPI events to avoid conflicts. Notably, Systemd-254 handles some ACPI events by default, so the handling of these events by Systemd-254 should be disabled first if handling these events with acpid (again, read logind.conf(5) for details).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of acpid

Install acpid by running the following commands:

./configure --prefix=/usr \
            --docdir=/usr/share/doc/acpid-2.0.34 &&
make

This package does not come with a test suite.

Now, as the root user:

make install                         &&
install -v -m755 -d /etc/acpi/events &&
cp -r samples /usr/share/doc/acpid-2.0.34

Configuring acpid

acpid is configured by user defined events. Place event files under /etc/acpi/events directory. If an event occurs, acpid recurses through the event files in order to see if the regex defined after "event" matches. If they do, action is executed.

The following brief example will suspend the system when the laptop lid is closed. The example also disables the default handling of the lid close event by Systemd-254 when the system is on battery and not connected to any external monitor, in order to avoid a conflict:

cat > /etc/acpi/events/lid << "EOF"
event=button/lid
action=/etc/acpi/lid.sh
EOF

cat > /etc/acpi/lid.sh << "EOF"
#!/bin/sh
/bin/grep -q open /proc/acpi/button/lid/LID/state && exit 0
/usr/bin/systemctl suspend
EOF
chmod +x /etc/acpi/lid.sh

mkdir -pv /etc/systemd/logind.conf.d
echo HandleLidSwitch=ignore > /etc/systemd/logind.conf.d/acpi.conf

Unfortunately, not every computer labels ACPI events in the same way (for example, the lid may be recognized as LID0 instead of LID). To determine how your buttons are recognized, use the acpi_listen tool. Also, look in the samples directory under /usr/share/doc/acpid-2.0.34 for more examples.

Systemd Socket

To start the acpid daemon at boot, install the systemd unit from the blfs-systemd-units-20230816 package by running the following command as the root user:

make install-acpid

Note

This package uses socket based activation and will be started when something needs it. No standalone unit file is provided for this package.

Contents

Installed Programs: acpid, acpi_listen, and kacpimon
Installed Libraries: None
Installed Directories: /etc/acpi and /usr/share/doc/acpid-2.0.34

Short Descriptions

acpid

is a program that listens for ACPI events and executes the rules that match the received event

acpi_listen

is a simple tool which connects to acpid and listens for events

kacpimon

is a monitor program that connects to three sources of ACPI events (events file, netlink and input layer) and then reports on what it sees while it is connected

at-3.2.5

Introduction to at

The at package provide delayed job execution and batch processing. It is required for Linux Standards Base (LSB) conformance.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

at Dependencies

Required

An MTA

Optional

Linux-PAM-1.5.3

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/at

Installation of at

Before building at, as the root user you should create the group and user atd which will run the atd daemon:

groupadd -g 17 atd                                                  &&
useradd -d /dev/null -c "atd daemon" -g atd -s /bin/false -u 17 atd

Install at with the following commands:

./configure --with-daemon_username=atd        \
            --with-daemon_groupname=atd       \
            SENDMAIL=/usr/sbin/sendmail       \
            --with-jobdir=/var/spool/atjobs   \
            --with-atspool=/var/spool/atspool \
            --with-systemdsystemunitdir=/lib/systemd/system &&
make -j1

To test the results, issue: make test.

Now, as the root user:

make install docdir=/usr/share/doc/at-3.2.5 \
             atdocdir=/usr/share/doc/at-3.2.5

Configuring at

Config Files

/etc/at.allow and /etc/at.deny determines who can submit jobs via at or batch.

Linux PAM Configuration

If At has been built with Linux PAM support, you need to create a PAM configuration file, to get it working correctly with BLFS.

Issue the following commands as the root user to create the configuration file for Linux PAM:

cat > /etc/pam.d/atd << "EOF"
# Begin /etc/pam.d/atd

auth     required pam_unix.so
account  required pam_unix.so
password required pam_unix.so
session  required pam_unix.so

# End /etc/pam.d/atd
EOF

Systemd Unit

To start the atd daemon at boot, enable the previously installed systemd unit by running the following command as the root user:

systemctl enable atd

Contents

Installed Programs: at, atd, atq (symlink), atrm (symlink), atrun, and batch
Installed Libraries: None
Installed Directories: /usr/share/doc/at-3.2.5

Short Descriptions

at

queues, examines or deletes jobs for later execution

atd

is the daemon that runs jobs queued for later execution

atq

lists the user's pending jobs, or all jobs, if superuser

atrm

deletes jobs, identified by their job number

atrun

runs jobs queued for later execution

batch

is a script that executes commands when system load levels permit

autofs-5.1.8

Introduction to Autofs

Autofs controls the operation of the automount daemons. The automount daemons automatically mount filesystems when they are accessed and unmount them after a period of inactivity. This is done based on a set of pre-configured maps.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Autofs Dependencies

Required

libtirpc-1.3.3 and rpcsvc-proto-1.4.4

Optional

nfs-utils-2.6.3, libnsl-2.0.0, libxml2-2.10.4, MIT Kerberos V5-1.21.2, OpenLDAP-2.6.6 (client only), and Cyrus SASL-2.1.28

Kernel Configuration

Verify that automounter kernel support has been enabled:

File systems --->
  <*/M> Kernel automounter support (supports v3, v4 and v5)          [AUTOFS_FS]

Optionally, enable the following options in the kernel configuration:

File systems --->
  [*] Network File Systems --->                            [NETWORK_FILESYSTEMS]
    <*/M> NFS client support                                            [NFS_FS]
    <*/M> SMB3 and CIFS support (advanced network filesystem)             [CIFS]

Recompile and install the new kernel, if necessary.

Installation of Autofs

First fix an issue introduced by glibc-2.36:

grep -rl linux/fs modules | xargs sed -i "/linux\/fs/d"

Install Autofs by running the following commands:

./configure --prefix=/usr             \
            --with-mapdir=/etc/autofs \
            --with-libtirpc           \
            --with-systemd            \
            --without-openldap        \
            --mandir=/usr/share/man &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Caution

If autofs is already installed on your system, be sure to backup your configuration files. They'll be overwritten by the following command.

Install the default configuration files, still as the root user:

make install_samples

Command Explanations

--with-libtirpc: This switch forces the package to use libtirpc for RPC functionality instead of relying on implementation from Glibc, which was removed in LFS 8.1.

--with-systemd: This switch enables installation of the bundled systemd units.

--without-openldap: This switch disables openldap if found. If openldap is desired, omit this switch. Note that openldap support in autofs requires MIT Kerberos V5-1.21.2.

Configuring Autofs

Config Files

/etc/sysconfig/autofs.conf, /etc/autofs/auto.master, /etc/autofs/auto.misc, and /etc/autofs/auto.net

Configuration Information

The installation process creates auto.master, auto.misc, auto.smb, and auto.net. Replace the auto.master file with the following commands as the root user:

mv /etc/autofs/auto.master /etc/autofs/auto.master.bak &&
cat > /etc/autofs/auto.master << "EOF"
# Begin /etc/autofs/auto.master

/media/auto  /etc/autofs/auto.misc  --ghost
#/home        /etc/autofs/auto.home

# End /etc/autofs/auto.master
EOF

This file creates a new media directory, /media/auto that will overlay any existing directory of the same name. In this example, the file, /etc/autofs/auto.misc, has a line:

                cd   -fstype=iso9660,ro,nosuid,nodev :/dev/cdrom

that will mount a cdrom as /media/auto/cd if that directory is accessed. The --ghost option tells the automounter to create ghost versions (i.e. empty directories) of all the mount points listed in the configuration file regardless whether any of the file systems are actually mounted or not. This is very convenient and highly recommended, because it will show you the available auto-mountable file systems as existing directories, even when their file systems aren't currently mounted. Without the --ghost option, you'll have to remember the names of the directories. As soon as you try to access one of them, the directory will be created and the file system will be mounted. When the file system gets unmounted again, the directory is destroyed too, unless the --ghost option was given.

Note

An alternative method would be to specify another automount location such as /var/lib/auto/cdrom and create a symbolic link from /media/cdrom to the automount location.

The auto.misc file must be configured to your working hardware. The loaded configuration file should load your cdrom if /dev/cdrom is active or it can be edited to match your device setup. Examples for floppies are available in the file and easily activated. Documentation for this file is available using the man 5 autofs command.

In the second line, if enabled, a user's home directory would be mounted via NFS upon login. The /etc/home.auto would need to exist and have an entry similar to:

joe  example.org:/export/home/joe

where the directory /export/home/joe is exported via NFS from the system example.org. NFS shares are covered on the next page.

This package could also be used to mount SMB shares, however that feature is not configured in these instructions. For additional configuration information, see the man pages for auto.master(5). There are also web resources such as this AUTOFS HOWTO available.

Systemd Unit

To start Autofs at boot, enable the previously installed systemd unit by running the following command as the root user:

systemctl enable autofs

Note

You can also specify OPTIONS variable in the /etc/sysconfig/autofs file with any additional parameters that you might want to pass to the automount daemon.

Contents

Installed Program: automount
Installed Libraries: lookup_dir.so, lookup_file.so, lookup_files.so, lookup_hosts.so, lookup_ldap.so (optional), lookup_multi.so, lookup_nis.so, lookup_program.so, lookup_userhome.so, lookup_yp.so, mount_afs.so, mount_autofs.so, mount_bind.so, mount_changer.so, mount_ext2.so, mount_ext3.so, mount_ext4.so, mount_generic.so, mount_nfs.so, mount_nfs4.so, parse_amd.so, and parse_sun.so
Installed Directories: /usr/lib/autofs and /etc/autofs

Short Descriptions

automount

is the daemon that performs the mounting when a request is made for the device

BlueZ-5.68

Introduction to BlueZ

The BlueZ package contains the Bluetooth protocol stack for Linux.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

BlueZ Dependencies

Required

dbus-1.14.8, GLib-2.76.4, and libical-3.0.16

Optional

docutils-0.20.1 (to generate man pages)

Kernel Configuration

If you are building this package to use bluetooth devices (rather than as a build dependency), enable the following options in the kernel configuration, also the options in the Cryptographic API section if you intend to run the tests, and recompile the kernel if necessary:

General setup --->
  # If it is disabled, [TIMERFD] and [EVENTFD] will be hidden and
  # enabled implicitly.  We DO NOT recommend to enable [EXPERT]
  # unless you are really an expert user:
  [ /*] Configure standard kernel features (expert users) --->          [EXPERT]
    [*] Enable timerfd() system call                                   [TIMERFD]
    [*] Enable eventfd() system call                                   [EVENTFD]

[*] Networking support --->                                                [NET]
  <*/M> Bluetooth subsystem support --->                                    [BT]
    [*]   Bluetooth Classic (BR/EDR) features                         [BT_BREDR]
    <*/M>   RFCOMM protocol support                                  [BT_RFCOMM]
    [*]       RFCOMM TTY support                                 [BT_RFCOMM_TTY]
    <*/M>   BNEP protocol support                                      [BT_BNEP]
    [*]       Multicast filter support                       [BT_BNEP_MC_FILTER]
    [*]       Protocol filter support                     [BT_BNEP_PROTO_FILTER]
    <*/M>   HIDP protocol support                                      [BT_HIDP]
    Bluetooth device drivers --->
      # Select the appropriate drivers for your bluetooth hardware.
      # There are more vendor-specific drivers not listed here:
      < /*/M> HCI USB driver                                       [BT_HCIBTUSB]
      < /*/M> HCI SDIO driver                                     [BT_HCIBTSDIO]
      < /*/M> HCI UART driver                                       [BT_HCIUART]
  <*/M> RF switch subsystem support --->                                [RFKILL]

-*- Cryptographic API --->                                              [CRYPTO]
  Crypto core or helper --->
    <*/M> Userspace cryptographic algorithm configuration          [CRYPTO_USER]
  Block ciphers --->
    <*/M> AES (Advanced Encryption Standard)                        [CRYPTO_AES]
  AEAD (authenticated encryption with associated data) ciphers --->
    <*/M> CCM (Counter with Cipher Block Chaining-MAC)              [CRYPTO_CCM]
  Hashes, digests, and MACs --->
    <*/M> CMAC (Cipher-based MAC)                                  [CRYPTO_CMAC]
  Userspace interface --->
    <*/M> Hash algorithms                                 [CRYPTO_USER_API_HASH]
    <*/M> Symmetric key cipher algorithms             [CRYPTO_USER_API_SKCIPHER]
    <*/M> AEAD cipher algorithms                          [CRYPTO_USER_API_AEAD]

Installation of BlueZ

Install BlueZ by running the following commands:

./configure --prefix=/usr         \
            --sysconfdir=/etc     \
            --localstatedir=/var  \
            --disable-manpages    \
            --enable-library      &&
make

To test the results, issue: make check.

Now, as the root user:

make install &&
ln -svf ../libexec/bluetooth/bluetoothd /usr/sbin

Install the main configuration file as the root user:

install -v -dm755 /etc/bluetooth &&
install -v -m644 src/main.conf /etc/bluetooth/main.conf

If desired, install the API documentation as the root user:

install -v -dm755 /usr/share/doc/bluez-5.68 &&
install -v -m644 doc/*.txt /usr/share/doc/bluez-5.68

Command Explanations

--disable-manpages: This switch disables generating the manual pages because of the reliance on 'rst2man' in docutils. Remove this switch if you have docutils-0.20.1 installed and wish to generate the manual pages.

--enable-library: This switch enables building the BlueZ 4 compatibility library which is required by some applications.

ln -svf ../libexec/bluetooth/bluetoothd /usr/sbin: This command makes access to the bluetooth daemon more convenient.

Configuring BlueZ

Configuration Files

/etc/bluetooth/main.conf is installed automatically during the installation. Additionally, there are two supplementary configuration files. You can optionally install the following files as the root user:

cat > /etc/bluetooth/rfcomm.conf << "EOF"
# Start rfcomm.conf
# Set up the RFCOMM configuration of the Bluetooth subsystem in the Linux kernel.
# Use one line per command
# See the rfcomm man page for options


# End of rfcomm.conf
EOF
cat > /etc/bluetooth/uart.conf << "EOF"
# Start uart.conf
# Attach serial devices via UART HCI to BlueZ stack
# Use one line per device
# See the hciattach man page for options

# End of uart.conf
EOF

Systemd Bluez Services

To start the bluetoothd daemon at boot, enable the previously installed systemd unit by running the following command as the root user:

systemctl enable bluetooth

To start the obexd daemon for a user session (to support some Bluetooth programs using it), enable the previously installed systemd unit for all users by running the following command as the root user:

systemctl enable --global obex

Note

Systemd will start the Bluetooth daemon only when a bluetooth device is detected on the system.

Contents

Installed Programs: bluemoon, bluetoothctl, bluetoothd (symlink), btattach, btmon, hex2hcd, l2ping, l2test, mpris-proxy, and rctest
Installed Library: libbluetooth.so
Installed Directories: /etc/bluetooth, /usr/{include,libexec}/bluetooth, and /usr/share/doc/bluez-5.68

Short Descriptions

bluemoon

is a Bluemoon configuration utility

bluetoothctl

is the interactive Bluetooth control program

bluetoothd

is the Bluetooth daemon

btmon

provides access to the Bluetooth subsystem monitor infrastructure for reading HCI traces

hex2hcd

is used to convert a file needed by Broadcom devices to hcd (Broadcom bluetooth firmware) format

l2ping

is used to send a L2CAP echo request to the Bluetooth MAC address given in dotted hex notation

l2test

is a L2CAP testing program

rctest

is used to test RFCOMM communications on the Bluetooth stack

libbluetooth.so

contains the BlueZ 4 API functions

Bubblewrap-0.8.0

Introduction to Bubblewrap

Bubblewrap is a setuid implementation of user namespaces, or sandboxing, that provides access to a subset of kernel user namespace features. Bubblewrap allows user owned processes to run in an isolated environment with limited access to the underlying filesystem.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Bubblewrap Dependencies

Optional

libxslt-1.1.38 (to generate manual pages) and libseccomp-2.5.4 (built with python bindings, for tests)

Installation of Bubblewrap

Install Bubblewrap by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

Next, if you desire to run the test suite, fix an issue caused by the merged-/usr configuration in LFS:

sed 's@symlink usr/lib64@ro-bind-try /lib64@' -i ../tests/libtest.sh

To test the results, issue (as a user other than the root user): ninja test

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Kernel Configuration

When this package began, upstream expected it could be installed suid-root. That was a long time ago, suid-root is generally considered a bad idea. As well as the default namespaces, this package requires the optional User namespace to be enabled. If that has not yet been enabled, select the following option in the kernel configuration and recompile the kernel:

General setup --->
  -*- Namespaces support --->                                       [NAMESPACES]
    [*] User namespace                                                 [USER_NS]

Contents

Installed Program: bwrap
Installed Libraries: None
Installed Directories: None

Short Descriptions

bwrap

generates a sandbox for a program to run in

Colord-1.4.6

Introduction to Colord

Colord is a system service that makes it easy to manage, install, and generate color profiles. It is used mainly by GNOME Color Manager for system integration and use when no users are logged in.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Colord Dependencies

Required

dbus-1.14.8, GLib-2.76.4, Little CMS-2.14, Polkit-123, and SQLite-3.42.0

Recommended
Optional

gnome-desktop-44.0 and colord-gtk-0.3.0 (to build the example tools), DocBook-utils-0.6.14, GTK-Doc-1.33.2, libxslt-1.1.38, SANE-1.0.32, ArgyllCMS, and Bash Completion

Installation of Colord

There should be a dedicated user and group to take control of the colord daemon after it has started. Issue the following commands as the root user:

groupadd -g 71 colord &&
useradd -c "Color Daemon Owner" -d /var/lib/colord -u 71 \
        -g colord -s /bin/false colord

Fix a double free causing a build failure on 32-bit x86 and runtime crashes with some monitors:

sed '/cmsUnregisterPluginsTHR/d' -i lib/colord/cd-context-lcms.c

Install Colord by running the following commands:

mkdir build &&
cd    build &&

meson setup ..                 \
      --prefix=/usr            \
      --buildtype=release      \
      -Ddaemon_user=colord     \
      -Dvapi=true              \
      -Dsystemd=true           \
      -Dlibcolordcompat=true   \
      -Dargyllcms_sensor=false \
      -Dbash_completion=false  \
      -Ddocs=false             \
      -Dman=false              &&
ninja

Now, as the root user:

ninja install

To test the results, issue: ninja test. One test, colord-self-test-daemon, will fail if the package is already installed. The test suite must be run with the system-wide D-Bus Daemon running.

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Ddaemon_user=colord: This switch is used so the colord daemon will run as an unprivileged user instead of the root user.

-Dvapi=true: This switch enables building the Vala bindings. Remove if you don't have Vala-0.56.11 installed.

-Dsystemd=true: This switch enables installation of the systemd service.

-Dlibcolordcompat=true: This switch enables building a compatibility library for older packages that use Colord.

-Dargyllcms_sensor=false: This switch disables the ArgLLCMS sensor driver. Omit if you have ArgyllCMS installed and wish to use it.

-Dbash_completion=false: This switch disables Bash Completion support for Colord applications.

-Ddocs=false: This switch disables building of documentation. Omit if you have GTK-Doc-1.33.2 available.

-Dman=false: This switch disables building of man pages. Omit if you have DocBook-utils-0.6.14 available. Namespaced versions of the docbook-xsl stylesheets are also required.

Contents

Installed Programs: cd-create-profile, cd-fix-profile, cd-iccdump, cd-it8, and colormgr
Installed Libraries: libcolord.so, libcolordcompat.so, libcolordprivate.so, and libcolorhug.so
Installed Directories: /usr/include/colord-1, /usr/lib/colord-{plugins,sensors}, /usr/share/color{d}, /usr/share/gtk-doc/html/colord, and /var/lib/colord

Short Descriptions

cd-create-profile

is the Color Manager Profile Creation Tool

cd-fix-profile

is a tool used to fix metadata in ICC profiles

cd-iccdump

dumps the contents of an ICC profile as human readable text

cd-it8

is the Color Manager Testing Tool

colormgr

is a text-mode program that allows you to interact with colord on the command line

libcolord.so

contains the Colord API functions

libcolordcompat.so

contains legacy API functions for compatibility with older applications

libcolordprivate.so

contains internal API functions for the programs included with Colord

libcolorhug.so

contains a simple display hardware colorimiter

cpio-2.14

Introduction to cpio

The cpio package contains tools for archiving.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

CPIO Dependencies

Optional

texlive-20230313 (or install-tl-unx)

Installation of cpio

Install cpio by running the following commands:

./configure --prefix=/usr \
            --enable-mt   \
            --with-rmt=/usr/libexec/rmt &&
make &&
makeinfo --html            -o doc/html      doc/cpio.texi &&
makeinfo --html --no-split -o doc/cpio.html doc/cpio.texi &&
makeinfo --plaintext       -o doc/cpio.txt  doc/cpio.texi

If you have texlive-20230313 installed and wish to create PDF or Postscript documentation, issue one or both of the following commands:

make -C doc pdf &&
make -C doc ps

To test the results, issue: make check.

Now, as the root user:

make install &&
install -v -m755 -d /usr/share/doc/cpio-2.14/html &&
install -v -m644    doc/html/* \
                    /usr/share/doc/cpio-2.14/html &&
install -v -m644    doc/cpio.{html,txt} \
                    /usr/share/doc/cpio-2.14

If you built PDF or Postscript documentation, install it by issuing the following commands as the root user:

install -v -m644 doc/cpio.{pdf,ps,dvi} \
                 /usr/share/doc/cpio-2.14

Command Explanations

--enable-mt: This parameter forces the building and installation of the mt program.

--with-rmt=/usr/libexec/rmt: This parameter inhibits building the rmt program as it is already installed by the Tar package in LFS.

Contents

Installed Programs: cpio and mt
Installed Libraries: None
Installed Directories: /usr/share/doc/cpio-2.14

Short Descriptions

cpio

copies files to and from archives

mt

controls magnetic tape drive operations

cups-pk-helper-0.2.7

Introduction to cups-pk-helper

The cups-pk-helper package contains a PolicyKit helper used to configure Cups with fine-grained privileges.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

cups-pk-helper Dependencies

Required

Cups-2.4.6 and Polkit-123

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/cups-pk-helper

Installation of cups-pk-helper

Install cups-pk-helper by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Contents

Installed Programs: cups-pk-helper-mechanism (library executable)
Installed Libraries: None
Installed Directories: None

dbus-1.14.8

Introduction to D-Bus

Even though D-Bus was built in LFS, there are some features provided by the package that other BLFS packages need, but their dependencies didn't fit into LFS.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

D-Bus Dependencies

Recommended
Optional

Systemd-254 (for registering services launched by D-Bus session daemon as systemd user services); For the tests: D-Bus Python-1.3.2, PyGObject-3.44.1, and Valgrind-3.21.0; for documentation: Doxygen-1.9.7, xmlto-0.0.28, Ducktype, and Yelp Tools

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/dbus

Installation of D-Bus

Install D-Bus by running the following commands (you may wish to review the output from ./configure --help first and add any desired parameters to the configure command shown below):

./configure --prefix=/usr                        \
            --sysconfdir=/etc                    \
            --localstatedir=/var                 \
            --runstatedir=/run                   \
            --enable-user-session                \
            --disable-doxygen-docs               \
            --disable-xml-docs                   \
            --disable-static                     \
            --docdir=/usr/share/doc/dbus-1.14.8  \
            --with-system-socket=/run/dbus/system_bus_socket &&
make

See below for test instructions.

Now, as the root user:

make install

If you are using a DESTDIR install, dbus-daemon-launch-helper needs to be fixed afterwards. Issue, as root user:

chown -v root:messagebus /usr/libexec/dbus-daemon-launch-helper &&
chmod -v      4750       /usr/libexec/dbus-daemon-launch-helper

Many tests are disabled unless both D-Bus Python-1.3.2 and PyGObject-3.44.1 have been installed. They must be run as an unprivileged user from a local session with bus address. To run the standard tests issue make check.

If you want to run the unit regression tests, configure requires additional parameters which expose additional functionality in the binaries that are not intended to be used in a production build of D-Bus. If you would like to run the tests, issue the following commands (for the tests, you don't need to build the docs):

make distclean                                    &&
PYTHON=python3 ./configure --enable-tests         \
                           --enable-asserts       \
                           --disable-doxygen-docs \
                           --disable-xml-docs     &&
make                                              &&
make check

There have been reports that the tests may fail if running inside a Midnight Commander shell. You may get out-of-memory error messages when running the tests. These are normal and can be safely ignored.

Command Explanations

--disable-doxygen-docs: This switch disables doxygen documentation build and install, if you have doxygen installed. If doxygen is installed, and you wish to build them, remove this parameter.

--disable-xml-docs: This switch disables html documentation build and install, if you have xmlto installed. If xmlto is installed, and you wish to build them, remove this parameter.

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-user-session: This parameter enables per-user DBus sessions with systemd.

--with-system-pid-file=/run/dbus/pid: This parameter specifies the location of the PID file.

--with-system-socket=/run/dbus/system_bus_socket: This parameter specifies the location of the system bus socket.

--enable-tests: Builds extra parts of the code to support all tests. Do not use on a production build.

--enable-embedded-tests: Builds extra parts of the code to support only unit tests. Do not use on a production build.

--enable-asserts: Enables debugging code to run assertions for statements normally assumed to be true. This prevents a warning that '--enable-tests' on its own is only useful for profiling and might not give true results for all tests, but adds its own NOTE that this should not be used in a production build.

Configuring D-Bus

Config Files

/etc/dbus-1/session.conf, /etc/dbus-1/system.conf and /etc/dbus-1/system.d/*

Configuration Information

The configuration files listed above should probably not be modified. If changes are required, you should create /etc/dbus-1/session-local.conf and/or /etc/dbus-1/system-local.conf and make any desired changes to these files.

If any packages install a D-Bus .service file outside of the standard /usr/share/dbus-1/services directory, that directory should be added to the local session configuration. For instance, /usr/local/share/dbus-1/services can be added by performing the following commands as the root user:

cat > /etc/dbus-1/session-local.conf << "EOF"
<!DOCTYPE busconfig PUBLIC
 "-//freedesktop//DTD D-BUS Bus Configuration 1.0//EN"
 "http://www.freedesktop.org/standards/dbus/1.0/busconfig.dtd">
<busconfig>

  <!-- Search for .service files in /usr/local -->
  <servicedir>/usr/local/share/dbus-1/services</servicedir>

</busconfig>
EOF

D-Bus Session Daemon

There are many methods you can use to start a session daemon using the dbus-launch command. Review the dbus-launch man page for details about the available parameters and options. Here are some suggestions and examples:

  • Add dbus-launch to the line in the ~/.xinitrc file that starts your graphical desktop environment.

  • If you use gdm or some other display manager that calls the ~/.xsession file, you can add dbus-launch to the line in your ~/.xsession file that starts your graphical desktop environment. The syntax would be similar to the example in the ~/.xinitrc file.

  • The examples shown previously use dbus-launch to specify a program to be run. This has the benefit (when also using the --exit-with-x11 parameter) of stopping the session daemon when the specified program is stopped. You can also start the session daemon in your system or personal startup scripts by adding the following lines:

    # Start the D-Bus session daemon
    eval `dbus-launch`
    export DBUS_SESSION_BUS_ADDRESS

    This method will not stop the session daemon when you exit your shell, therefore you should add the following line to your ~/.bash_logout file:

    # Kill the D-Bus session daemon
    kill $DBUS_SESSION_BUS_PID

Contents

A list of the installed files, along with their short descriptions can be found at ../../../../lfs/view/12.0-systemd/chapter08/dbus.html#contents-dbus.

Fcron-3.2.1

Introduction to Fcron

The Fcron package contains a periodical command scheduler which aims at replacing Vixie Cron.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Fcron Dependencies

Optional

An MTA, text editor (default is vi from the Vim-9.0.1677 package), Linux-PAM-1.5.3, and DocBook-utils-0.6.14

Installation of Fcron

For security reasons, an unprivileged user and group for Fcron should be created (perform as the root user):

groupadd -g 22 fcron &&
useradd -d /dev/null -c "Fcron User" -g fcron -s /bin/false -u 22 fcron

Now fix some locations hard coded in the documentation:

find doc -type f -exec sed -i 's:/usr/local::g' {} \;

Install Fcron by running the following commands:

./configure --prefix=/usr          \
            --sysconfdir=/etc      \
            --localstatedir=/var   \
            --without-sendmail     \
            --with-piddir=/run     \
            --with-boot-install=no &&
make

This package does not come with a test suite.

Now, as the root user:

make install

DESTDIR install must be done as root user. Furthermore, if PAM configuration files should be installed in /etc/pam.d, you have to create this directory in the DESTDIR before doing the install.

Command Explanations

--without-sendmail: By default, Fcron will attempt to use the sendmail command from an MTA package to email you the results of the fcron script. This switch is used to disable default email notification. Omit the switch to enable the default. Alternatively, you can use the --with-sendmail=</path/to/MTA command> to use a different mailer command.

--with-boot-install=no: This prevents installation of the bootscript included with the package.

--with-piddir=/run: This fixes the systemd unit to use the proper directory for PID files so that systemctl does not hang and the unit starts correctly.

--with-editor=</path/to/editor>: This switch allows you to set the default text editor.

--with-dsssl-dir=</path/to/dsssl-stylesheets>: May be used if you have DocBook-utils-0.6.14 installed. Currently, the dsssl stylesheets are located at /usr/share/sgml/docbook/dsssl-stylesheets-1.79.

Configuring Fcron

Config Files

/etc/fcron.conf, /etc/fcron.allow, and /etc/fcron.deny

Configuration Information

There are no required changes in any of the config files. Configuration information can be found in the man page for fcron.conf.

fcron scripts are written using fcrontab. Refer to the fcrontab man page for proper parameters to address your situation.

If Linux-PAM is installed, two PAM configuration files are installed in etc/pam.d. Alternatively if etc/pam.d is not used, the installation will append two configuration sections to the existing /etc/pam.conf file. You should ensure the files match your preferences. Modify them as required to suit your needs.

Periodic Jobs

If you would like to set up a periodic hierarchy for the root user, first issue the following commands (as the root user) to create the /usr/bin/run-parts script:

cat > /usr/bin/run-parts << "EOF" &&
#!/bin/sh
# run-parts:  Runs all the scripts found in a directory.
# from Slackware, by Patrick J. Volkerding with ideas borrowed
# from the Red Hat and Debian versions of this utility.

# keep going when something fails
set +e

if [ $# -lt 1 ]; then
  echo "Usage: run-parts <directory>"
  exit 1
fi

if [ ! -d $1 ]; then
  echo "Not a directory: $1"
  echo "Usage: run-parts <directory>"
  exit 1
fi

# There are several types of files that we would like to
# ignore automatically, as they are likely to be backups
# of other scripts:
IGNORE_SUFFIXES="~ ^ , .bak .new .rpmsave .rpmorig .rpmnew .swp"

# Main loop:
for SCRIPT in $1/* ; do
  # If this is not a regular file, skip it:
  if [ ! -f $SCRIPT ]; then
    continue
  fi
  # Determine if this file should be skipped by suffix:
  SKIP=false
  for SUFFIX in $IGNORE_SUFFIXES ; do
    if [ ! "$(basename $SCRIPT $SUFFIX)" = "$(basename $SCRIPT)" ]; then
      SKIP=true
      break
    fi
  done
  if [ "$SKIP" = "true" ]; then
    continue
  fi
  # If we've made it this far, then run the script if it's executable:
  if [ -x $SCRIPT ]; then
    $SCRIPT || echo "$SCRIPT failed."
  fi
done

exit 0
EOF
chmod -v 755 /usr/bin/run-parts

Next, create the directory layout for the periodic jobs (again as the root user):

install -vdm754 /etc/cron.{hourly,daily,weekly,monthly}

Finally, add the run-parts to the system fcrontab (while still the root user):

cat > /var/spool/fcron/systab.orig << "EOF"
&bootrun 01 * * * * root run-parts /etc/cron.hourly
&bootrun 02 4 * * * root run-parts /etc/cron.daily
&bootrun 22 4 * * 0 root run-parts /etc/cron.weekly
&bootrun 42 4 1 * * root run-parts /etc/cron.monthly
EOF

Systemd Unit

Enable fcron to start at boot using the previously installed systemd unit.

systemctl enable fcron

Finally, again as the root user, start fcron and generate the /var/spool/fcron/systab file:

systemctl start fcron &&
fcrontab -z -u systab

Contents

Installed Programs: fcron, fcrondyn, fcronsighup, and fcrontab
Installed Libraries: None
Installed Directories: /usr/share/doc/fcron-3.2.1 and /var/spool/fcron

Short Descriptions

fcron

is the scheduling daemon

fcrondyn

is a user tool intended to interact with a running fcron daemon

fcronsighup

instructs fcron to reread the Fcron tables

fcrontab

is a program used to install, edit, list and remove the tables used by fcron

GPM-1.20.7

Introduction to GPM

The GPM (General Purpose Mouse daemon) package contains a mouse server for the console and xterm. It not only provides cut and paste support generally, but its library component is used by various software such as Links to provide mouse support to the application. It is useful on desktops, especially if following (Beyond) Linux From Scratch instructions; it's often much easier (and less error prone) to cut and paste between two console windows than to type everything by hand!

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/GPM

Kernel Configuration

Enable the following option in the kernel configuration and recompile the kernel if necessary:

Device Drivers --->
  Input device support --->
    -*-   Generic input layer (needed for keyboard, mouse, ...)          [INPUT]
    <*/M>   Mouse interface                                     [INPUT_MOUSEDEV]

Installation of GPM

Install GPM by running the following commands:

patch -Np1 -i ../gpm-1.20.7-consolidated-1.patch &&
./autogen.sh                                     &&
./configure --prefix=/usr --sysconfdir=/etc      &&
make

This package does not come with a test suite.

Now, as the root user:

make install                                          &&

install-info --dir-file=/usr/share/info/dir           \
             /usr/share/info/gpm.info                 &&

rm -fv /usr/lib/libgpm.a                              &&
ln -sfv libgpm.so.2.1.0 /usr/lib/libgpm.so            &&
install -v -m644 conf/gpm-root.conf /etc              &&

install -v -m755 -d /usr/share/doc/gpm-1.20.7/support &&
install -v -m644    doc/support/*                     \
                    /usr/share/doc/gpm-1.20.7/support &&
install -v -m644    doc/{FAQ,HACK_GPM,README*}        \
                    /usr/share/doc/gpm-1.20.7

Command Explanations

./autogen.sh: This command creates the missing configure script.

install-info ...: This package installs a .info file, but does not update the system dir file. This command makes the update.

ln -v -sfn libgpm.so.2.1.0 /usr/lib/libgpm.so: This command is used to create (or update) the .so symlink to the library.

Configuring GPM

Systemd Unit

To start the gpm daemon at boot, install the systemd unit from the blfs-systemd-units-20230816 package by running the following command as the root user:

make install-gpm

Config Files

/etc/gpm-root.conf and ~/.gpm-root: The default and individual user gpm-root configuration files.

Configuration Information

GPM is by default started with the following parameters: -m /dev/input/mice -t imps2. If the mentioned parameters don't suit your needs, you can override them by running the following commands as the root user:

install -v -dm755 /etc/systemd/system/gpm.service.d &&
cat > /etc/systemd/system/gpm.service.d/99-user.conf << EOF
[Service]
ExecStart=/usr/sbin/gpm <list of parameters>
EOF

Contents

Installed Programs: disable-paste, display-buttons, display-coords, get-versions, gpm, gpm-root, hltest, mev, and mouse-test
Installed Library: libgpm.so
Installed Directory: /usr/share/doc/gpm-1.20.7

Short Descriptions

disable-paste

is a security mechanism used to disable the paste buffer

display-buttons

is a simple program that reports the mouse buttons being pressed and released

display-coords

is a simple program that reports the mouse coordinates

get-versions

is used to report the GPM library and server versions

gpm

is a cut and paste utility and mouse server for virtual consoles

gpm-root

is a default handler for gpm. It is used to draw menus on the root window

hltest

is a simple sample application using the high-level library, meant to be read by programmers trying to use the high-level library

mev

is a program to report mouse events

mouse-test

is a tool for determining the mouse type and device it's attached to

libgpm.so

contains the API functions to access the GPM daemon

Hdparm-9.65

Introduction to Hdparm

The Hdparm package contains a utility that is useful for obtaining information about, and controlling ATA/IDE controllers and hard drives. It allows to increase performance and sometimes to increase stability.

This package is known to build and work properly using an LFS 12.0 platform.

Warning

As well as being useful, incorrect usage of Hdparm can destroy your information and in rare cases, drives. Use with caution and make sure you know what you are doing. If in doubt, it is recommended that you leave the default kernel parameters alone.

Package Information

Installation of Hdparm

Build Hdparm by running the following command:

make

This package does not come with a test suite.

Now, as the root user:

make binprefix=/usr install

Contents

Installed Program: hdparm
Installed Libraries: None
Installed Directories: None

Short Descriptions

hdparm

provides a command-line interface to various hard disk ioctls supported by the stock Linux ATA/IDE device driver subsystem

LSB-Tools-0.10

Introduction to LSB-Tools

The LSB-Tools package includes tools for Linux Standards Base (LSB) conformance.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of LSB-Tools

Install LSB-Tools by running the following commands:

python3 setup.py build

Now, as the root user:

python3 setup.py install --optimize=1

Configuration Information

The configuration for this package was done in LFS and Systemd. The file /etc/lsb-release should already exist. Be sure that the DISTRIB_CODENAME entry has been set properly.

Contents

Installed Programs: lsb_release, install_initd, and remove_initd
Installed Library: None
Installed Directories: /usr/lib/lsb and /usr/lib/python3.11/site-packages/lsbtools

Short Descriptions

lsb_release

is a script to give LSB data

install_initd

is a script to activate SysV startup scripts

remove_initd

is a script to deactivate SysV startup scripts

Lm-sensors-3-6-0

Introduction to Lm_sensors

The lm_sensors package provides userspace support for the hardware monitoring drivers in the Linux kernel. This is useful for monitoring the temperature of the CPU and adjusting the performance of some hardware (such as cooling fans).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

lm_sensors Dependencies

Required

Which-2.21

Optional

RRDtool (required to build the sensord program) and dmidecode (runtime)

Kernel Configuration

The following configuration options attempt to cover the most common hardware monitoring devices in a typical desktop or laptop system. View the help of each (by pressing the H button with the option focused in the make menuconfig) to know if you need it. There are many platform-specific hardware monitoring devices so it's impossible to list the configuration for all of them here. You may investigate the content of /sys/class/hwmon within a mainstream distro running on the system to know which drivers you need.

Power management and ACPI options --->
  [*] ACPI (Advanced Configuration and Power Interface) Support --->      [ACPI]
    < /*/M> Battery                                               [ACPI_BATTERY]
    < /*/M> Thermal Zone                                          [ACPI_THERMAL]

Device Drivers --->
  NVME Support --->
    < /*> NVM Express block device                                [BLK_DEV_NVME]
    # Set [HWMON] to <*> (not <M>!) or it will not show up:
    [ /*] NVMe hardware monitoring                                  [NVME_HWMON]
  <*/M> Hardware Monitoring support --->                                 [HWMON]
    < /*/M> AMD Athlon64/FX or Opteron temperature sensor       [SENSORS_K8TEMP]
    < /*/M> AMD Family 10h+ temperature sensor                 [SENSORS_K10TEMP]
    < /*/M> AMD Family 15h processor power                [SENSORS_FAM15H_POWER]
    < /*/M> Intel Core/Core2/Atom temperature sensor          [SENSORS_CORETEMP]

Recompile your kernel and reboot into the new kernel.

Installation of Lm_sensors

Install Lm_sensors by running the following commands:

make PREFIX=/usr        \
     BUILD_STATIC_LIB=0 \
     MANDIR=/usr/share/man

This package does not come with a test suite.

Now, as the root user:

make PREFIX=/usr        \
     BUILD_STATIC_LIB=0 \
     MANDIR=/usr/share/man install &&

install -v -m755 -d /usr/share/doc/lm_sensors-3-6-0 &&
cp -rv              README INSTALL doc/* \
                    /usr/share/doc/lm_sensors-3-6-0

Command Explanations

BUILD_STATIC_LIB=0: This parameter disables compiling and installing the static version of libsensors.

PROG_EXTRA=sensord: This parameter enables compiling sensord, a daemon that can monitor your system at regular intervals. Compiling sensord requires RRDtool. Be sure to install RRDtool in /usr by running make prefix=/usr when building it. Otherwise, Lm_sensors will not find it easily.

Configuring Lm_sensors

Config File

/etc/sensors3.conf

Contents

Installed Programs: fancontrol, isadump, isaset, pwmconfig, sensors, sensors-conf-convert, sensors-detect, and optionally, sensord
Installed Library: libsensors.so
Installed Directories: /etc/sensors.d, /usr/include/sensors and /usr/share/doc/lm_sensors-3-6-0

Short Descriptions

fancontrol

is a shell script for use with lm_sensors. It reads its configuration from a file, then calculates fan speeds from temperatures and sets the corresponding PWM outputs to the computed values

isadump

is a small helper program to examine registers visible through the ISA bus. It is intended to probe any chip that lives on the ISA bus working with an address register and a data register (I2C-like access) or a flat range (of up to 256 bytes)

isaset

is a small helper program to set registers visible through the ISA bus

pwmconfig

tests the pulse width modulation (PWM) outputs of sensors and configures fancontrol

sensors

prints the current readings of all sensor chips

sensors-conf-convert

is a Perl script to convert lm-sensors version 2 configuration files to work with version 3

sensors-detect

is a Perl script that will walk you through the process of scanning your system for various hardware monitoring chips (sensors) supported by libsensors, or more generally by the lm_sensors tool suite

sensord

(optional) is a daemon that can be used to periodically log sensor readings

libsensors.so

contains the lm_sensors API functions

Logrotate-3.21.0

Introduction to Logrotate

The logrotate package allows automatic rotation, compression, removal, and mailing of log files.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Logrotate Dependencies

Required

popt-1.19

Optional

An MTA (runtime)

Installation of Logrotate

Install logrotate by running the following command:

./configure --prefix=/usr &&
make

To test the results, issue: make test. One test fails because the very old compress is not present and two tests fail if an MTA is not installed.

Now, as the root user:

make install

Configuring Logrotate

Logrotate needs a configuration file, which must be passed as an argument to the command when executed. Create the file as the root user:

cat > /etc/logrotate.conf << EOF
# Begin /etc/logrotate.conf

# Rotate log files weekly
weekly

# Don't mail logs to anybody
nomail

# If the log file is empty, it will not be rotated
notifempty

# Number of backups that will be kept
# This will keep the 2 newest backups only
rotate 2

# Create new empty files after rotating old ones
# This will create empty log files, with owner
# set to root, group set to sys, and permissions 664
create 0664 root sys

# Compress the backups with gzip
compress

# No packages own lastlog or wtmp -- rotate them here
/var/log/wtmp {
    monthly
    create 0664 root utmp
    rotate 1
}

/var/log/lastlog {
    monthly
    rotate 1
}

# Some packages drop log rotation info in this directory
# so we include any file in it.
include /etc/logrotate.d

# End /etc/logrotate.conf
EOF

chmod -v 0644 /etc/logrotate.conf

Now create the /etc/logrotate.d directory as the root user:

mkdir -p /etc/logrotate.d

At this point additional log rotation commands can be entered, typically in the /etc/logrotate.d directory. For example:

cat > /etc/logrotate.d/sys.log << EOF
/var/log/sys.log {
   # If the log file is larger than 100kb, rotate it
   size   100k
   rotate 5
   weekly
   postrotate
      /bin/killall -HUP syslogd
   endscript
}
EOF

chmod -v 0644 /etc/logrotate.d/sys.log

You can designate multiple files in one entry:

cat > /etc/logrotate.d/example.log << EOF
file1
file2
file3 {
   ...
   postrotate
    ...
   endscript
}
EOF

chmod -v 0644 /etc/logrotate.d/example.log

You can use in the same line the list of files: file1 file2 file3. See the logrotate man page or https://www.techrepublic.com/article/manage-linux-log-files-with-logrotate/ for more examples.

The command logrotate /etc/logrotate.conf can be run manually, however, the command should be run daily. Other useful commands are logrotate -d /etc/logrotate.conf for debugging purposes and logrotate -f /etc/logrotate.conf forcing the logrotate commands to be run immediately. Combining the previous options -df, you can debug the effect of the force command. When debugging, the commands are only simulated and are not actually run. As a result, errors about files not existing will eventually appear because the files are not actually created.

To run the logrotate command daily, execute the following commands, as the root user, to create a systemd timer to run daily at 3:00 A.M. (local time):

cat > /usr/lib/systemd/system/logrotate.service << "EOF" &&
[Unit]
Description=Runs the logrotate command
Documentation=man:logrotate(8)
DefaultDependencies=no
After=local-fs.target
Before=shutdown.target

[Service]
Type=oneshot
RemainAfterExit=yes
ExecStart=/usr/sbin/logrotate /etc/logrotate.conf
EOF
cat > /usr/lib/systemd/system/logrotate.timer << "EOF" &&
[Unit]
Description=Runs the logrotate command daily at 3:00 AM

[Timer]
OnCalendar=*-*-* 3:00:00
Persistent=true

[Install]
WantedBy=timers.target
EOF
systemctl enable logrotate.timer

Contents

Installed Programs: logrotate
Installed Library: None
Installed Directories: None

Short Descriptions

logrotate

performs the log maintenance functions defined in the configuration files

MC-4.8.30

Introduction to MC

MC (Midnight Commander) is a text-mode full-screen file manager and visual shell. It provides a clear, user-friendly, and somewhat protected interface to a Unix system while making many frequent file operations more efficient and preserving the full power of the command prompt.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

MC Dependencies

Required

GLib-2.76.4

Recommended
Optional

Doxygen-1.9.7, GPM-1.20.7, Graphviz-8.1.0, libssh2-1.11.0, PCRE-8.45, pcre2-10.42, Ruby-3.2.2, UnZip-6.0, a graphical environment, and Zip-3.0

Installation of MC

Install MC by running the following commands:

./configure --prefix=/usr \
            --sysconfdir=/etc \
            --enable-charset &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--sysconfdir=/etc: This switch places the global configuration directory in /etc.

--enable-charset: This switch adds support to mcedit for editing files in encodings different from the one implied by the current locale.

--with-search-engine=pcre2: Use this switch if you would prefer to use pcre2-10.42 instead of GLib for the built-in search engine. Alternatively, you can pass 'pcre' instead of 'pcre2' if you prefer to use PCRE-8.45.

Configuring MC

Config Files

~/.config/mc/*

Configuration Information

The ~/.config/mc directory and its contents are created when you start mc for the first time. Then you can edit the main ~/.config/mc/ini configuration file manually or through the MC shell. Consult the mc(1) man page for details.

Contents

Installed Programs: mc and the symlinks mcdiff, mcedit and mcview
Installed Libraries: None
Installed Directories: /etc/mc and /usr/{libexec,share}/mc

Short Descriptions

mc

is a visual shell

mcdiff

is an internal visual diff tool

mcedit

is an internal file editor

mcview

is an internal file viewer

ModemManager-1.18.12

Introduction to ModemManager

ModemManager provides a unified high level API for communicating with mobile broadband modems, regardless of the protocol used to communicate with the actual device.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

ModemManager Dependencies

Required

libgudev-238

Recommended
Optional

GTK-Doc-1.33.2

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/ModemManager

Installation of ModemManager

Install ModemManager by running the following commands:

./configure --prefix=/usr                 \
            --sysconfdir=/etc             \
            --localstatedir=/var          \
            --disable-static              \
            --disable-maintainer-mode     \
            --with-systemd-journal        \
            --with-systemd-suspend-resume &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--with-systemd-suspend-resume: This switch forces ModemManager to use the systemd power management facilities.

--with-systemd-journal : This switch forces ModemManager to use the systemd journal for logging.

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Configuring ModemManager

Systemd Units

To start the ModemManager daemon at boot, enable the previously installed systemd unit by running the following command as the root user:

systemctl enable ModemManager

Contents

Installed Programs: mmcli and ModemManager
Installed Libraries: libmm-glib.so
Installed Directories: /etc/ModemManager, /usr/include/libmm-glib, /usr/include/ModemManager, /usr/lib/ModemManager, /usr/share/ModemManager, /usr/share/gtk-doc/html/libmm-glib (optional), and /usr/share/gtk-doc/html/ModemManager (optional)

Short Descriptions

mmcli

is an utility used to control and monitor the ModemManager

ModemManager

is a D-Bus service used to communicate with modems

libmm-glib.so

contains API functions for communicating with mobile broadband modems, regardless of the protocol used to communicate with the actual device

notification-daemon-3.20.0

Introduction to Notification Daemon

The Notification Daemon package contains a daemon that displays passive pop-up notifications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Notification Daemon Dependencies

Required

GTK+-3.24.38 and libcanberra-0.30 (Built with GTK+-3.24.38 support).

Installation of Notification Daemon

Install Notification Daemon by running the following commands:

./configure --prefix=/usr     \
            --sysconfdir=/etc \
            --disable-static  &&
make

This package does not come with a test suite.

Now, as the root user:

make install

You can test the notification daemon with the command notify-send:

pgrep -l notification-da &&
notify-send -i info Information "Hi ${USER}, This is a Test"

The command pgrep -l notification-da is added to assure that it is the daemon of this package that is running, not another one, e.g. the daemon from xfce4-notifyd-0.8.2.

Contents

Installed Program: none
Installed Libraries: none
Installed Directory: none

p7zip-17.04

Introduction to p7zip

p7zip is the Unix command-line port of 7-Zip, a file archiver that archives with high compression ratios. It handles 7z, ZIP, GZIP, Brotli, BZIP2, XZ, TAR, APM, ARJ, CAB, CHM, CPIO, CramFS, DEB, DMG, FAT, HFS, ISO, Lizard, LZ5, LZFSE, LZH, LZMA, LZMA2, MBR, MSI, MSLZ, NSIS, NTFS, RAR, RPM, SquashFS, UDF, VHD, WIM, XAR, Z, and Zstd formats.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

p7zip Dependencies

Optional

wxWidgets

Installation of p7zip

First, prevent p7zip from installing compressed manual pages:

sed '/^gzip/d' -i install.sh

Next, fix a security vulnerability:

sed -i '160a if(_buffer == nullptr || _size == _pos) return E_FAIL;' CPP/7zip/Common/StreamObjects.cpp

Install p7zip by running the following commands:

make all3

To test the results, issue: make test.

Now, as the root user:

make DEST_HOME=/usr \
     DEST_MAN=/usr/share/man \
     DEST_SHARE_DOC=/usr/share/doc/p7zip-17.04 install

Note

If using DESTDIR techniques, use DEST_DIR instead.

Contents

Installed Programs: 7z, 7za, and 7zr
Installed Libraries: None
Installed Directory: /usr/lib/p7zip and /usr/share/doc/p7zip-17.04

Short Descriptions

7z

is a file archiver utility

7za

is a stand-alone executable handling less archive formats than 7z

7zr

is a minimal version of 7za that handles only 7z archives

Pax-20201030

Introduction to Pax

pax is an archiving utility created by POSIX and defined by the POSIX.1-2001 standard. Rather than sort out the incompatible options that have crept up between tar and cpio, along with their implementations across various versions of UNIX, the IEEE designed a new archive utility. The name pax is an acronym for portable archive exchange. Furthermore, pax means peace in Latin, so its name implies that it shall create peace between the tar and cpio format supporters. The command invocation and command structure is somewhat a unification of both tar and cpio.

pax has been required to be present in LSB conformant systems since LSB version 3.0.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Pax

Install pax by running the following commands:.

Note

This package expands to the directory pax.

bash Build.sh

This package does not come with a test suite.

Now, as the root user:

Note

This package also creates hard links from pax to the programs cpio and tar in the build directory. The LFS editors do not recommend that they be installed as they will overwrite the GNU versions of these programs.

install -v pax /usr/bin &&
install -v -m644 pax.1 /usr/share/man/man1

Contents

Installed Program: pax

Short Descriptions

pax

copies files to and from archives in several formats

pciutils-3.10.0

Introduction to PCI Utils

The PCI Utils package contains a set of programs for listing PCI devices, inspecting their status and setting their configuration registers.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

pciutils Dependencies

Recommended

Installation of PCI Utils

Install PCI Utils by running the following commands:

make PREFIX=/usr                \
     SHAREDIR=/usr/share/hwdata \
     SHARED=yes

This package does not come with a test suite.

Now, as the root user:

make PREFIX=/usr                \
     SHAREDIR=/usr/share/hwdata \
     SHARED=yes                 \
     install install-lib        &&

chmod -v 755 /usr/lib/libpci.so

Command Explanations

SHARED=yes: This parameter enables building of the shared library instead of the static one.

ZLIB=no: This option prevents compression of the pci.ids file.

Configuring PCI Utils

The pci.ids data file is constantly being updated. To get a current version of this file, run update-pciids as the root user. This program requires the Which-2.21 script or program to find cURL-8.2.1, Lynx-2.8.9rel.1, or Wget-1.21.4 which are used to download the most current file, and then replace the existing file in /usr/share/hwdata.

You should update the /usr/share/hwdata/pci.ids file periodically. Execute the following commands, as the root user, to create a systemd timer to update it weekly on Sundays at 2:30 A.M. (local time):

cat > /usr/lib/systemd/system/update-pciids.service << "EOF" &&
[Unit]
Description=Update pci.ids file
Documentation=man:update-pciids(8)
DefaultDependencies=no
After=local-fs.target network-online.target
Before=shutdown.target

[Service]
Type=oneshot
RemainAfterExit=yes
ExecStart=/usr/sbin/update-pciids
EOF
cat > /usr/lib/systemd/system/update-pciids.timer << "EOF" &&
[Unit]
Description=Update pci.ids file weekly

[Timer]
OnCalendar=Sun 02:30:00
Persistent=true

[Install]
WantedBy=timers.target
EOF
systemctl enable update-pciids.timer

Contents

Installed Programs: lspci, setpci, and update-pciids
Installed Library: libpci.so
Installed Directory: /usr/include/pci and /usr/share/hwdata

Short Descriptions

lspci

is a utility for displaying information about all PCI buses in the system and all devices connected to them

setpci

is a utility for querying and configuring PCI devices

update-pciids

fetches the current version of the PCI ID list.

libpci.so

is a library that allows applications to access the PCI subsystem

pm-utils-1.4.1

Introduction to Power Management Utilities

The Power Management Utilities provide simple shell command line tools to suspend and hibernate the computer. They can be used to run user supplied scripts on suspend and resume.

Note

On a system using systemd as the init system, systemd already provides this functionality. As a result, this package is probably not needed, and it may conflict with systemd. Read the documentation for suspend.target and hibernate.target in the man page systemd.special(7) for more details.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Power Management Utilities Dependencies

Optional

xmlto-0.0.28 (to generate man pages)

Optional (runtime)

Hdparm-9.65, Wireless Tools-29, ethtool, and vbetool

Kernel Configuration

If needed, enable the following options in the kernel configuration and recompile the kernel:

Power management and ACPI options --->
  [*] Suspend to RAM and standby                                       [SUSPEND]
  [*] Hibernation (aka 'suspend to disk')                          [HIBERNATION]

Suspend to RAM allows the system to enter sleep states in which main memory is powered and thus its contents are preserved. The method cuts power to most parts of the machine aside from the RAM. Because of the large power savings, it is advisable for laptops to automatically enter this mode when the computer is running on batteries and the lid is closed (or the user is inactive for some time).

Suspend to disk (Hibernation) saves the machine's state into swap space and completely powers off the machine. When the machine is powered on, the state is restored. Until then, there is zero power consumption. Suspend to RAM and hibernation are normally appropriate for portable devices such as laptops, but can be used on workstations. The capability is not really appropriate for servers.

To use hibernation, the kernel parameter resume=/dev/<swap_partition> has to be used on the kernel command line (in grub.cfg). The swap partition should be at least the size of the physical RAM on the system.

Installation of Power Management Utilities

First, fix several bugs and a couple of incompatibilities with newer kernels:

patch -Np1 -i ../pm-utils-1.4.1-bugfixes-1.patch

Install Power Management Utilities by running the following commands:

./configure --prefix=/usr     \
            --sysconfdir=/etc \
            --docdir=/usr/share/doc/pm-utils-1.4.1 &&
make

This package does not come with a test suite.

Now, as the root user:

make install

If you don't have xmlto-0.0.28 installed, copy pregenerated man pages, as the root user:

install -v -m644 man/*.1 /usr/share/man/man1 &&
install -v -m644 man/*.8 /usr/share/man/man8 &&
ln -sv pm-action.8 /usr/share/man/man8/pm-suspend.8 &&
ln -sv pm-action.8 /usr/share/man/man8/pm-hibernate.8 &&
ln -sv pm-action.8 /usr/share/man/man8/pm-suspend-hybrid.8

Configuring Power Management Utilities

Suspend or resume functionality can be easily modified by installing files into the /etc/pm/sleep.d directory. These files, known as hooks, are run when the system is put into a sleep state or resumed. Default hooks are located in /usr/lib/pm-utils/sleep.d, and user hooks should be put in /etc/pm/sleep.d. See the pm-action(8) man page for more information.

In order to use hibernation with GRUB and a swap partition, you need to add kernel parameter resume=swap_partition (e.g. resume=/dev/sda1) to the kernel line in the /boot/grub/grub.cfg configuration file.

Contents

Installed Programs: on_ac_power, pm-hibernate, pm-is-supported, pm-powersave, pm-suspend and pm-suspend-hybrid
Installed Libraries: None
Installed Directories: /etc/pm, /usr/lib/pm-utils and /usr/share/doc/pm-utils-1.4.1

Short Descriptions

on_ac_power

is a script that determines whether the system is running on AC power (rather than a battery)

pm-hibernate

is a symlink to pm-action script that puts the computer into hibernate mode (the system is fully powered off and system state is saved to disk)

pm-is-supported

is a script that checks whether power management features such as suspend and hibernate are supported

pm-powersave

is a script that puts the computer into powersaving (low power) mode

pm-suspend

is a symlink to pm-action script that puts the computer into suspend mode (most devices are shut down and system state is saved in RAM)

pm-suspend-hybrid

is a symlink to pm-action script that puts the computer into hybrid-suspend mode (the system does everything it needs to hibernate, but suspends instead of shutting down)

Raptor-2.0.16

Introduction to Raptor

Raptor is a C library that provides a set of parsers and serializers that generate Resource Description Framework (RDF) triples.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Raptor Dependencies

Required

cURL-8.2.1 and libxslt-1.1.38

Optional

GTK-Doc-1.33.2, ICU-73.2 and libyajl

Installation of Raptor

Install Raptor by running the following commands:

./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check. Several of the XML tests may fail.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--with-icu-config=/usr/bin/icu-config: Use this switch if you have installed ICU-73.2 and wish to build Raptor with its support.

Contents

Installed Programs: rapper
Installed Libraries: libraptor2.so
Installed Directories: /usr/include/raptor2 and /usr/share/gtk-doc/html/raptor2

Short Descriptions

rapper

is a RDF parsing and serializing utility

libraptor2.so

contains the Raptor API functions

Rasqal-0.9.33

Introduction to Rasqal

Rasqal is a C library that handles Resource Description Framework (RDF) query language syntaxes, query construction, and execution of queries returning results as bindings, boolean, RDF graphs/triples or syntaxes.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://download.librdf.org/source/rasqal-0.9.33.tar.gz

  • Download MD5 sum: 1f5def51ca0026cd192958ef07228b52

  • Download size: 1.6 MB

  • Estimated disk space required: 22 MB (additional 4 MB for the tests)

  • Estimated build time: 0.3 SBU (additional 0.7 SBU for the tests)

Rasqal Dependencies

Required

Raptor-2.0.16

Optional

PCRE-8.45 and libgcrypt-1.10.2

Installation of Rasqal

Install Rasqal by running the following commands:

./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: rasqal-config and roqet
Installed Library: librasqal.so
Installed Directories: /usr/include/rasqal and /usr/share/gtk-doc/html/rasqal

Short Descriptions

rasqal-config

is an utility for retrieving the installation options of Rasqal

roqet

is an RDF query utility

Redland-1.0.17

Introduction to Redland

Redland is a set of free software C libraries that provide support for the Resource Description Framework (RDF).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Redland Dependencies

Required

Rasqal-0.9.33

Optional

Berkeley DB-5.3.28, libiodbc-3.52.15, SQLite-3.42.0, MariaDB-10.11.4 or MySQL, PostgreSQL-15.4, virtuoso, and 3store

Installation of Redland

Install Redland by running the following commands:

./configure --prefix=/usr --disable-static &&
make

To test the results, issue make check.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: rdfproc, redland-config and redland-db-upgrade
Installed Libraries: librdf.so and /usr/lib/redland/librdf_storage_*.so
Installed Directories: /usr/lib/redland, /usr/share/gtk-doc/html/redland and /usr/share/redland

Short Descriptions

rdfproc

is the Redland RDF processor utility

redland-config

is a script to get information about the installed version of Redland

redland-db-upgrade

upgrades older Redland databases to 0.9.12 format

sg3_utils-1.48

Introduction to sg3_utils

The sg3_utils package contains low level utilities for devices that use a SCSI command set. Apart from SCSI parallel interface (SPI) devices, the SCSI command set is used by ATAPI devices (CD/DVDs and tapes), USB mass storage devices, Fibre Channel disks, IEEE 1394 storage devices (that use the "SBP" protocol), SAS, iSCSI and FCoE devices (amongst others).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of sg3_utils

Install sg3_utils by running the following commands:

./configure --prefix=/usr --disable-static &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: rescan-scsi-bus.sh, scsi_logging_level, scsi_mandat, scsi_readcap, scsi_ready, scsi_satl, scsi_start, scsi_stop, scsi_temperature, sg_bg_ctl, sg_compare_and_write, sg_copy_results, sg_dd, sg_decode_sense, sg_emc_trespass, sg_format, sg_get_config, sg_get_lba_status, sg_ident, sg_inq, sg_logs, sg_luns, sg_map, sg_map26, sg_modes, sg_opcodes, sg_persist, sg_prevent, sg_raw, sg_rbuf, sg_rdac, sg_read, sg_read_attr, sg_read_block_limits, sg_read_buffer, sg_read_long, sg_readcap, sg_reassign, sg_referrals, sg_rep_pip, sg_rep_zones, sg_requests, sg_reset, sg_reset_wp, sg_rmsn, sg_rtpg, sg_safte, sg_sanitize, sg_sat_identify, sg_sat_phy_event, sg_sat_read_gplog, sg_sat_set_features, sg_scan, sg_seek, sg_senddiag, sg_ses, sg_ses_microcode, sg_start, sg_stpg, sg_stream_ctl, sg_sync, sg_test_rwbuf, sg_timestamp, sg_turs, sg_unmap, sg_verify, sg_vpd, sg_wr_mode, sg_write_buffer, sg_write_long, sg_write_same, sg_write_verify, sg_write_x, sg_xcopy, sg_zone, sginfo, sgm_dd, and sgp_dd
Installed Library: libsgutils2.so
Installed Directories: None

Short Descriptions

rescan-scsi-bus.sh

adds or removes SCSI devices without having to reboot

scsi_logging_level

accesses Linux SCSI logging level information

scsi_mandat

checks SCSI device support for mandatory commands

scsi_readcap

does the SCSI READ CAPACITY command on disks

scsi_ready

does the SCSI TEST UNIT READY on devices

scsi_satl

checks for SCSI to ATA Translation (SAT) device support

scsi_start

starts one or more SCSI disks

scsi_stop

stops one or more SCSI disks

scsi_temperature

fetches the temperature of a SCSI device

sg_bg_ctl

performs a SCSI BACKGROUND CONTROL command on a device to perform "advanced background operations"

sg_compare_and_write

sends the SCSI COMPARE AND WRITE command to device

sg_copy_results

sends the SCSI RECEIVE COPY RESULTS command (XCOPY related)

sg_dd

copies data to and from files and devices. Specialised for devices that understand the SCSI command set

sg_decode_sense

takes SCSI sense data in binary or as a sequence of ASCII hexadecimal bytes and decodes it

sg_emc_trespass

changes ownership of a LUN from another Service-Processor to this one

sg_format

formats or resizes a SCSI disk (perhaps changes its block size)

sg_get_config

sends a SCSI GET CONFIGURATION command (MMC-4 +)

sg_get_elem_status

sends a SCSI GET PHYSICAL ELEMENT STATUS command to a device

sg_get_lba_status

sends the SCSI GET LBA STATUS command

sg_ident

sends a SCSI REPORT or SET IDENTIFYING INFORMATION command

sginfo

access mode page information for a SCSI (or ATAPI) device

sg_inq

sends a SCSI INQUIRY or ATA IDENTIFY (PACKET) DEVICE command and outputs the response

sg_logs

access log pages with SCSI LOG SENSE command

sg_luns

sends the SCSI REPORT LUNS command

sg_map

displays mapping between linux sg and other SCSI devices

sg_map26

maps a special file to a SCSI generic (sg) device (or vice versa)

sgm_dd

copies data to and from files and devices. Specialized for devices that understand the SCSI command set and does memory mapped transfers from sg devices

sg_modes

reads mode pages with the SCSI MODE SENSE command

sg_opcodes

reports information on supported SCSI commands or task management functions

sgp_dd

copies data to and from files and devices. Specialized for devices that understand the SCSI command set

sg_persist

sends a SCSI PERSISTENT RESERVE (IN or OUT) command to manipulate registrations and reservations

sg_prevent

sends a SCSI PREVENT ALLOW MEDIUM REMOVAL command

sg_raw

sends an arbitrary SCSI command to a device

sg_rbuf

reads data using the SCSI READ BUFFER command

sg_rdac

displays or modifies the RDAC Redundant Controller Page

sg_read

reads blocks of data continually from the same offset

sg_read_attr

performs a SCSI READ ATTRIBUTE command on a device

sg_read_block_limits

sends a SCSI READ BLOCK LIMITS command

sg_read_buffer

sends a SCSI READ BUFFER command

sg_readcap

sends a SCSI READ CAPACITY command

sg_read_long

sends a SCSI READ LONG command

sg_reassign

sends a SCSI REASSIGN BLOCKS command

sg_referrals

sends a SCSI REPORT REFERRALS command

sg_rep_pip

sends a SCSI REPORT PROVISIONING INITIALIZATION PATTERN command

sg_rep_zones

sends a SCSI REPORT ZONES command

sg_requests

sends one or more SCSI REQUEST SENSE commands

sg_reset

sends a SCSI device, target, bus or host reset; or checks reset state

sg_reset_wp

sends a SCSI RESET WRITE POINTER command

sg_rmsn

sends a SCSI READ MEDIA SERIAL NUMBER command

sg_rtpg

sends a SCSI REPORT TARGET PORT GROUPS command

sg_safte

fetches status information from a SCSI Accessed Fault-Tolerant Enclosure (SAF-TE) device

sg_sanitize

sends a SCSI SANITIZE command

sg_sat_identify

sends an ATA IDENTIFY (PACKET) DEVICE command via a SCSI to ATA Translation (SAT) layer

sg_sat_phy_event

sends an ATA READ LOG EXT command via a SAT pass through to fetch log page 11h which contains SATA phy event counters

sg_sat_read_gplog

sends an ATA READ LOG EXT command via a SCSI to ATA Translation (SAT) layer

sg_sat_set_features

sends an ATA SET FEATURES command via a SCSI to ATA Translation (SAT) layer

sg_scan

does a scan of sg devices (or given SCSI/ATAPI/ATA devices) and prints the results

sg_seek

performs a SCSI SEEK or PRE-FETCH command on a device and it's cache

sg_senddiag

performs a SCSI SEND DIAGNOSTIC command

sg_ses

sends controls and fetches the current status from a SCSI Enclosure Services (SES) device

sg_ses_microcode

sends microcode to a SCSI enclosure

sg_start

sends a SCSI START STOP UNIT command to start, stop, load or eject medium

sg_stpg

sends a SCSI SET TARGET PORT GROUPS command

sg_stream_ctl

performs a SCSI STREAM CONTROL or GET STREAM STATUS command on a device to open or close an I/O stream

sg_sync

sends a SCSI command to synchronize the cache

sg_test_rwbuf

tests the SCSI host adapter by issuing write and read operations on a device's buffer and calculating checksums

sg_timestamp

reports or sets the timestamp on a SCSI device

sg_turs

sends one or more SCSI TEST UNIT READY commands

sg_unmap

sends a SCSI UNMAP command

sg_verify

invokes SCSI VERIFY command(s) on a block device

sg_vpd

fetches Vital Product Data (VPD) pages using a SCSI INQUIRY command

sg_write_buffer

sends a SCSI WRITE BUFFER command

sg_write_long

sends a SCSI WRITE LONG command

sg_write_same

sends a SCSI WRITE SAME command

sg_write_verify

sends a SCSI WRITE AND VERIFY command

sg_write_x

performs SCSI WRITE commands on a device

sg_wr_mode

writes mode pages

sg_xcopy

copies data to and from files and devices using SCSI EXTENDED COPY (XCOPY)

sg_zone

performs SCSI ZONE commands on a device, such as OPEN, CLOSE, FINISH or SEQUENTIALIZE

libsgutils2.so

contains the sg3_utils API functions

Sysstat-12.7.2

Introduction to Sysstat

The Sysstat package contains utilities to monitor system performance and usage activity. Sysstat contains the sar utility, common to many commercial Unixes, and tools you can schedule via cron to collect and historize performance and activity data.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Sysstat Dependencies

Installation of Sysstat

Install Sysstat by running the following commands:

sa_lib_dir=/usr/lib/sa    \
sa_dir=/var/log/sa        \
conf_dir=/etc/sysconfig   \
./configure --prefix=/usr \
            --disable-file-attr &&
make

This package does not come with a working test suite.

Now, as the root user:

make install

Install the systemd unit by running the following commands as the root user:

install -v -m644 sysstat.service /usr/lib/systemd/system/sysstat.service &&
install -v -m644 cron/sysstat-collect.service /usr/lib/systemd/system/sysstat-collect.service &&
install -v -m644 cron/sysstat-collect.timer /usr/lib/systemd/system/sysstat-collect.timer &&
install -v -m644 cron/sysstat-summary.service /usr/lib/systemd/system/sysstat-summary.service &&
install -v -m644 cron/sysstat-summary.timer /usr/lib/systemd/system/sysstat-summary.timer

Fix the systemd unit by running the following command as the root user:

sed -i "/^Also=/d" /usr/lib/systemd/system/sysstat.service

Command Explanations

sa_lib_dir: This environment variable specifies the location of the package-specific library directory.

sa_dir: This environment variable specifies the location of the directory containing the data files.

conf_dir: This environment variable specifies the location of the system configuration directory.

--disable-file-attr: Do not set attributes on files being installed. This parameter causes the installation to ignore the man group variable resulting in the man files having root: root ownership.

Note

Run ./configure --help to see other influential environment variables you can pass to configure. You may want to use the history and compressafter variables to customize the amount of data files kept on the system.

Configuring Sysstat

Config Files

/etc/sysconfig/sysstat and /etc/sysconfig/sysstat.ioconf

Cron Information

To begin gathering Sysstat history information, you must add to, or create a privileged user's crontab. The history data location is /var/log/sa. The user running Sysstat utilities via cron must have write access to this location.

Below is an example of what to install in the crontab. Adjust the parameters to suit your needs. Use man sa1 and man sa2 for information about the commands.

# 8am-7pm activity reports every 10 minutes during weekdays
0 8-18 * * 1-5 /usr/lib/sa/sa1 600 6 &

# 7pm-8am activity reports every hour during weekdays
0 19-7 * * 1-5 /usr/lib/sa/sa1 &

# Activity reports every hour on Saturday and Sunday
0 * * * 0,6 /usr/lib/sa/sa1 &

# Daily summary prepared at 19:05
5 19 * * * /usr/lib/sa/sa2 -A &

Ensure you submit the revised crontab to the cron daemon.

System Startup Information

At system startup, a LINUX RESTART message must be inserted in the daily data file to reinitialize the kernel counters. This can be automated by enabling the previously installed systemd unit by running the following command as the root user:

systemctl enable sysstat

Contents

Installed Programs: cifsiostat, iostat, mpstat, pidstat, sadf, sar, and tapestat
Installed Libraries: None
Installed Directories: /usr/lib/sa, /usr/share/doc/sysstat-12.7.2 and /var/log/sa

Short Descriptions

cifsiostat

displays statistics about read and write operations on CIFS filesystems

iostat

reports CPU statistics and input/output statistics for devices and partitions

mpstat

writes activities for each available processor

pidstat

is used for monitoring individual tasks currently being managed by the Linux kernel

sadf

is used for displaying the contents of data files created by the sar command. But unlike sar, sadf can write its data in many different formats

sar

is used for displaying the contents of elected cumulative activity counters in the operating system

tapestat

is used for monitoring the activity of tape drives connected to a system

Systemd-254

Introduction to systemd

While systemd was installed when building LFS, there are many features provided by the package that were not included in the initial installation because Linux-PAM was not yet installed. The systemd package needs to be rebuilt to provide a working systemd-logind service, which provides many additional features for dependent packages.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

systemd Dependencies

Recommended

Note

Linux-PAM-1.5.3 is not strictly required to build systemd, but the main reason to rebuild systemd in BLFS (it's already built in LFS anyway) is for the systemd-logind daemon and the pam_systemd.so PAM module. Linux-PAM-1.5.3 is required for them. All packages in BLFS book with a dependency on systemd expects it has been rebuilt with Linux-PAM-1.5.3.

Optional

btrfs-progs-6.3.3, cURL-8.2.1, cryptsetup-2.4.3, git-2.41.0, GnuTLS-3.8.1, iptables-1.8.9, libgcrypt-1.10.2, libidn2-2.3.4, libpwquality-1.4.5, libseccomp-2.5.4, libxkbcommon-1.5.0, make-ca-1.12, p11-kit-0.25.0, pcre2-10.42, qemu-8.1.0, qrencode-4.1.1, rsync-3.2.7, sphinx-7.1.2, Valgrind-3.21.0, zsh-5.9 (for the zsh completions), AppArmor, audit-userspace, bash-completion, jekyll, kexec-tools, libbpf, libdw, libfido2, libmicrohttpd, lz4, pyelftools, quota-tools, rpm, SELinux, systemtap, tpm2-tss and Xen

Optional (to rebuild the manual pages)

docbook-xml-4.5, docbook-xsl-nons-1.79.2, libxslt-1.1.38, and lxml-4.9.3 (to build the index of systemd manual pages)

Installation of systemd

Remove two unneeded groups, render and sgx, from the default udev rules:

sed -i -e 's/GROUP="render"/GROUP="video"/' \
       -e 's/GROUP="sgx", //' rules.d/50-udev-default.rules.in

Rebuild systemd by running the following commands:

mkdir build &&
cd    build &&

meson setup ..                \
      --prefix=/usr           \
      --buildtype=release     \
      -Ddefault-dnssec=no     \
      -Dfirstboot=false       \
      -Dinstall-tests=false   \
      -Dldconfig=false        \
      -Dman=auto              \
      -Dsysusers=false        \
      -Drpmmacrosdir=no       \
      -Dhomed=false           \
      -Duserdb=false          \
      -Dmode=release          \
      -Dpam=true              \
      -Dpamconfdir=/etc/pam.d \
      -Ddev-kvm-mode=0660     \
      -Ddocdir=/usr/share/doc/systemd-254 &&

ninja

Note

For the best test results, make sure you run the test suite from a system that is booted by the same systemd version you are rebuilding.

To test the results, issue: ninja test. The test named test-stat-util and test-netlink are known to fail if some kernel features are not enabled. If the test suite is ran as the root user, some other tests may fail because they depend on various kernel configuration options.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dpamconfdir=/etc/pam.d: Forces the PAM files to be installed in /etc/pam.d rather than /usr/lib/pam.d.

-Duserdb=false: Removes a daemon that does not offer any use under a BLFS configuration. If you wish to enable the userdbd daemon, replace "false" with "true" in the above meson command.

-Dhomed=false: Removes a daemon that does not offer any use under a traditional BLFS configuration, especially using accounts created with useradd. To enable systemd-homed, first ensure that you have cryptsetup-2.4.3 and libpwquality-1.4.5 installed, and then change "false" to "true" in the above meson command.

Configuring systemd

The /etc/pam.d/system-session file needs to be modified and a new file needs to be created in order for systemd-logind to work correctly. Run the following commands as the root user:

grep 'pam_systemd' /etc/pam.d/system-session ||
cat >> /etc/pam.d/system-session << "EOF"
# Begin Systemd addition

session  required    pam_loginuid.so
session  optional    pam_systemd.so

# End Systemd addition
EOF

cat > /etc/pam.d/systemd-user << "EOF"
# Begin /etc/pam.d/systemd-user

account  required    pam_access.so
account  include     system-account

session  required    pam_env.so
session  required    pam_limits.so
session  required    pam_unix.so
session  required    pam_loginuid.so
session  optional    pam_keyinit.so force revoke
session  optional    pam_systemd.so

auth     required    pam_deny.so
password required    pam_deny.so

# End /etc/pam.d/systemd-user
EOF

Warning

If upgrading from a previous version of systemd and an initrd is used for system boot, you should generate a new initrd before rebooting the system.

Contents

A list of the installed files, along with their short descriptions can be found at ../../../../lfs/view/12.0-systemd/chapter08/systemd.html#contents-systemd.

Listed below are the newly installed programs along with short descriptions.

Installed Programs: homectl (optional), systemd-cryptenroll (if cryptsetup-2.4.3 is installed), and userdbctl (optional)

Short Descriptions

homectl

is a tool to create, remove, change, or inspect a home directory managed by systemd-homed; note that it's useless for the classic UNIX users and home directories which we are using in LFS/BLFS book

systemd-cryptenroll

Is used to enroll or remove a system from full disk encryption, as well as set and query private keys and recovery keys

userdbctl

inspects users, groups, and group memberships

pam_systemd.so

is a PAM module used to register user sessions with the systemd login manager, systemd-logind

UDisks-2.10.0

Introduction to UDisks

The UDisks package provides a daemon, tools and libraries to access and manipulate disks and storage devices.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

UDisks Dependencies

Required

libatasmart-0.19, libblockdev-3.0.2, libgudev-238, libxslt-1.1.38, and Polkit-123

Recommended
Optional (Required if building GNOME)

gobject-introspection-1.76.1

Optional

D-Bus Python-1.3.2 (for the integration tests), GTK-Doc-1.33.2, LVM2-2.03.22, PyGObject-3.44.1 (for the integration tests), exFAT, and libiscsi

Optional Runtime Dependencies

btrfs-progs-6.3.3, dosfstools-4.2, gptfdisk-1.0.9, mdadm-4.2, and xfsprogs-6.4.0

Installation of UDisks

Install UDisks by running the following commands:

./configure --prefix=/usr        \
            --sysconfdir=/etc    \
            --localstatedir=/var \
            --disable-static     \
            --enable-available-modules &&
make

To test the results, issue: make check. A more thorough test can be run with make ci. You must first create the directories /var/run/udisks2 and /var/lib/udisks2, and the optional python modules should be present.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

--enable-available-modules: This switch enables additional UDisks2 functionalities if libblockdev-3.0.2 has been built with optional dependencies.

Contents

Installed Programs: udisksctl and umount.udisks2
Installed Library: libudisks2.so
Installed Directories: /etc/udisks2, /usr/include/udisks2, /usr/libexec/udisks2, /usr/share/gtk-doc/html/udisks2, and /var/lib/udisks2

Short Descriptions

udisksctl

is a command-line program used to interact with the udisksd daemon

umount.udisks2

is a command-line program used to unmount file systems that have been mounted by the UDisks daemon

libudisks2.so

contains the UDisks API functions

UnRar-6.2.10

Introduction to UnRar

The UnRar package contains a RAR extraction utility used for extracting files from RAR archives. RAR archives are usually created with WinRAR, primarily in a Windows environment.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of UnRar

Note

This package extracts the tarball to the unversioned directory unrar and not the expected directory unrar-6.2.10.

Install UnRar by running the following commands:

make -f makefile

This package does not come with a test suite.

Now, as the root user:

install -v -m755 unrar /usr/bin

Contents

Installed Program: unrar
Installed Libraries: None
Installed Directories: None

Short Descriptions

unrar

uncompresses a RAR archive

UnZip-6.0

Introduction to UnZip

The UnZip package contains ZIP extraction utilities. These are useful for extracting files from ZIP archives. ZIP archives are created with PKZIP or Info-ZIP utilities, primarily in a DOS environment.

This package is known to build and work properly using an LFS 12.0 platform.

Caution

The previous version of the UnZip package had some locale related issues. Currently there are no BLFS editors capable of testing these locale issues. Therefore, the locale related information is left on this page, but has not been tested. A more general discussion of these problems can be found in the Program Assumes Encoding section of the Locale Related Issues page.

Package Information

Additional Downloads

UnZip Locale Issues

Note

Use of UnZip in the JDK, Mozilla, DocBook or any other BLFS package installation is not a problem, as BLFS instructions never use UnZip to extract a file with non-ASCII characters in the file's name.

These issues are thought to be fixed in the patch. But since none of the editors have data to test this, the following workarounds are retained in case they might still be needed.

The UnZip package assumes that filenames stored in the ZIP archives created on non-Unix systems are encoded in CP850, and that they should be converted to ISO-8859-1 when writing files onto the filesystem. Such assumptions are not always valid. In fact, inside the ZIP archive, filenames are encoded in the DOS codepage that is in use in the relevant country, and the filenames on disk should be in the locale encoding. In MS Windows, the OemToChar() C function (from User32.DLL) does the correct conversion (which is indeed the conversion from CP850 to a superset of ISO-8859-1 if MS Windows is set up to use the US English language), but there is no equivalent in Linux.

When using unzip to unpack a ZIP archive containing non-ASCII filenames, the filenames are damaged because unzip uses improper conversion when any of its encoding assumptions are incorrect. For example, in the ru_RU.KOI8-R locale, conversion of filenames from CP866 to KOI8-R is required, but conversion from CP850 to ISO-8859-1 is done, which produces filenames consisting of undecipherable characters instead of words (the closest equivalent understandable example for English-only users is rot13). There are several ways around this limitation:

1) For unpacking ZIP archives with filenames containing non-ASCII characters, use WinZip while running the Wine Windows emulator.

2) Use bsdtar -xf from libarchive-3.7.1 to unpack the ZIP archive. Then fix the damage made to the filenames using the convmv tool (https://j3e.de/linux/convmv/). The following is an example for the zh_CN.UTF-8 locale:

convmv -f cp936 -t utf-8 -r --nosmart --notest \
    </path/to/unzipped/files>

Installation of UnZip

First apply the patch:

patch -Np1 -i ../unzip-6.0-consolidated_fixes-1.patch

Now compile the package:

make -f unix/Makefile generic

The test suite does not work for target generic.

Now, as the root user:

make prefix=/usr MANDIR=/usr/share/man/man1 \
 -f unix/Makefile install

Command Explanations

make -f unix/Makefile generic: This target begins by running a configure script (unlike the older targets such as linux and linux_noasm) which creates a flags file that is then used in the build. This ensures that the 32-bit x86 build receives the right flags to unzip files which are larger than 2GB when extracted.

Contents

Installed Programs: funzip, unzip, unzipfsx, zipgrep, and zipinfo
Installed Libraries: None
Installed Directories: None

Short Descriptions

funzip

allows the output of unzip commands to be redirected

unzip

lists, tests or extracts files from a ZIP archive

unzipfsx

is a self-extracting stub that can be prepended to a ZIP archive. Files in this format allow the recipient to decompress the archive without installing UnZip

zipgrep

searches files in a ZIP archive for lines matching a pattern

zipinfo

produces technical information about the files in a ZIP archive, including file access permissions, encryption status, type of compression, etc

UPower-1.90.2

Introduction to UPower

The UPower package provides an interface for enumerating power devices, listening to device events and querying history and statistics. Any application or service on the system can access the org.freedesktop.UPower service via the system message bus.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

UPower Dependencies

Required

libgudev-238 and libusb-1.0.26

Optional (Required if building GNOME)

gobject-introspection-1.76.1

Optional

GTK-Doc-1.33.2, libxslt-1.1.38, docbook-xsl-nons-1.79.2, PyGObject-3.44.1, dbusmock-0.29.1, umockdev-0.17.18 (for part of the test suite), and libimobiledevice

Kernel Configuration

Enable the following options in the kernel configuration and recompile the kernel if necessary:

General setup --->
  -*- Namespaces support --->                                       [NAMESPACES]
    [*] User namespace                                                 [USER_NS]

Installation of UPower

First, remove an unneeded dependency from a test:

sed '/parse_version/d' -i src/linux/integration-test.py

Install UPower by running the following commands:

mkdir build                         &&
cd    build                         &&
meson setup ..            \
      --prefix=/usr       \
      --buildtype=release \
      -Dgtk-doc=false     \
      -Dman=false         &&
ninja

To test the results, issue: LC_ALL=C ninja test. Some checks may not pass due to missing files. Test suite should be run from a local GUI session started with dbus-launch. 2 tests relating to the headphone hotplug feature are known to fail, these can be safely ignored as the headphone functionality does still work.

Now, as the root user:

ninja install

Command Explanations

-Dgtk-doc=false: Prevents building the documentation. Remove this if you have GTK-Doc installed and wish to build the documentation.

-Dman=false: Prevents building the manual pages. Remove this if you have libxslt-1.1.38 and docbook-xsl-nons-1.79.2 installed and wish to build the manual pages.

Configuring UPower

Systemd Unit

To start the UPower service at boot, enable the previously installed systemd unit by running the following command as the root user:

systemctl enable upower

Contents

Installed Program: upower
Installed Libraries: libupower-glib.so
Installed Directories: /etc/UPower, /usr/include/libupower-glib, and /var/lib/upower

Short Descriptions

upower

is the UPower command line tool

libupower-glib.so

contains the UPower API functions

usbutils-015

Introduction to USB Utils

The USB Utils package contains utilities used to display information about USB buses in the system and the devices connected to them.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

USB Utils Dependencies

Required

libusb-1.0.26

Recommended

Installation of USB Utils

Install USB Utils by running the following commands:

autoreconf -fiv &&

./configure --prefix=/usr --datadir=/usr/share/hwdata &&
make

This package does not come with a test suite.

Now, as the root user:

make install

To install the usb.ids data file, using Wget-1.21.4, run, as the root user:

install -dm755 /usr/share/hwdata/ &&
wget http://www.linux-usb.org/usb.ids -O /usr/share/hwdata/usb.ids

The script lsusb.py displays information in a more easily readable form than lsusb. To find the options, use lsusb.py -h. One form of use recommended by the developer is lsusb.py -ciu.

Configuring USB Utils

You should update the /usr/share/hwdata/usb.ids file periodically. Execute the following commands, as the root user, to create a systemd timer to update it weekly on Sundays at 2:30 A.M. (local time):

cat > /usr/lib/systemd/system/update-usbids.service << "EOF" &&
[Unit]
Description=Update usb.ids file
Documentation=man:lsusb(8)
DefaultDependencies=no
After=local-fs.target network-online.target
Before=shutdown.target

[Service]
Type=oneshot
RemainAfterExit=yes
ExecStart=/usr/bin/wget http://www.linux-usb.org/usb.ids -O /usr/share/hwdata/usb.ids
EOF
cat > /usr/lib/systemd/system/update-usbids.timer << "EOF" &&
[Unit]
Description=Update usb.ids file weekly

[Timer]
OnCalendar=Sun 03:00:00
Persistent=true

[Install]
WantedBy=timers.target
EOF
systemctl enable update-usbids.timer

Contents

Installed Programs: lsusb, lsusb.py, usb-devices, and usbhid-dump
Installed Libraries: None
Installed Directories: None

Short Descriptions

lsusb

is a utility for displaying information about all USB buses in the system and all devices connected to them, but not in human friendly form

lsusb.py

displays information about all USB buses in the system and all devices connected to them in reasonable human friendly form

usb-devices

is a shell script that displays details of USB buses and devices connected to them. It is designed to be used if /proc/bus/usb/devices is not available on your system

usbhid-dump

is used to dump report descriptors and streams from HID (human interface device) interfaces of USB devices

Which-2.21 and Alternatives

The presence or absence of the which program in the main LFS book is probably one of the most contentious issues on the mailing lists. It has resulted in at least one flame war in the past. To hopefully put an end to this once and for all, presented here are two options for equipping your system with which. The question of which which is for you to decide.

Introduction to GNU Which

The first option is to install the actual GNU which package.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Which

Install which by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: which
Installed Libraries: None
Installed Directories: None

Short Descriptions

which

shows the full path of (shell) commands installed in your PATH

The 'which' Script

The second option (for those who don't want to install the package) is to create a simple script (execute as the root user):

cat > /usr/bin/which << "EOF"
#!/bin/bash
type -pa "$@" | head -n 1 ; exit ${PIPESTATUS[0]}
EOF
chmod -v 755 /usr/bin/which
chown -v root:root /usr/bin/which

This should work OK and is probably the easiest solution for most cases, but is not the most comprehensive implementation.

Zip-3.0

Introduction to Zip

The Zip package contains Zip utilities. These are useful for compressing files into ZIP archives.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Zip

Install Zip by running the following commands:

make -f unix/Makefile generic_gcc

This package does not come with a test suite.

Now, as the root user:

make prefix=/usr MANDIR=/usr/share/man/man1 -f unix/Makefile install

Command Explanations

make prefix=/usr -f unix/Makefile install: This command overrides the prefix variable that is set to /usr/local in the unix/Makefile. Alternatives to generic_gcc can be seen with a make -f unix/Makefile list command.

Contents

Installed Programs: zip, zipcloak, zipnote, and zipsplit
Installed Libraries: None
Installed Directories: None

Short Descriptions

zip

compresses files into a ZIP archive

zipcloak

is a utility to encrypt and decrypt a ZIP archive

zipnote

reads or writes comments stored in a ZIP file

zipsplit

is a utility to split ZIP files into smaller files

Chapter 13. Programming

A base LFS system can be used as a development platform, however the base system only includes language support for C, C++, Perl, and Python. This chapter provides instructions to build many popular programming environments to greatly expand your system's development capabilities.

Autoconf2.13

Introduction to Autoconf2.13

Autoconf2.13 is an old version of Autoconf . This old version accepts switches which are not valid in more recent versions and Mozilla applications still need these switches now, so they require this old version for regenerating the configure scripts. Unlike other Mozilla applications, SeaMonkey release tarballs do not contain the pre-generated configure scripts, so this old version is required even if configure files have not been changed.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Installation of Autoconf2.13

Install Autoconf by running the following commands:

patch -Np1 -i ../autoconf-2.13-consolidated_fixes-1.patch &&
mv -v autoconf.texi autoconf213.texi                      &&
rm -v autoconf.info                                       &&
./configure --prefix=/usr --program-suffix=2.13           &&
make

To test the installation issue make check (all 253 tests should pass).

Now, as the root user:

make install                                      &&
install -v -m644 autoconf213.info /usr/share/info &&
install-info --info-dir=/usr/share/info autoconf213.info

Command Explanations

mv -v autoconf.texi autoconf213.texi: ensure that the info file added by this package will not overwrite the more recent version.

rm -v autoconf.info: ensure that the info file will be created by the current version of texinfo.

--program-suffix=2.13: ensure that the installed programs have the version added to their names, so that only a script which specifically looks for these old versions will find them.

install -v -m644 ...: the patch removes install-info from the Makefile because that would install (and if necessary recreate) standards.info which is an old version, so now autoconf213.info has to be manually installed.

Contents

Installed Programs: autoconf2.13, autoheader2.13, autoreconf2.13, autoscan2.13, autoupdate2.13, and ifnames2.13
Installed Library: None
Installed Directory: /usr/share/autoconf-2.13

Short Descriptions

autoconf2.13

Produces shell scripts that automatically configure software source code packages to adapt to many kinds of Unix-like systems

autoheader2.13

is a tool for creating template files of C #define statements for configure to use

autoreconf2.13

This automatically runs autoconf2.13, autoheader2.13, aclocal, automake, gettextize and libtoolize in the right order when changes have been made to autoconf or automake template files

autoscan2.13

Can be used as a preliminary step in creating a configure.in file

autoupdate2.13

Modifies a configure.in file that still calls autoconf macros by their old names to use the current macro names

ifnames2.13

Prints the identifiers that the package uses in C preprocessor conditionals [If a package has already been set up to have some portability, this program can help determine what configure needs to check for. It can also fill in gaps in a configure.in file generated by autoscan]

Cbindgen-0.24.3

Introduction to Cbindgen

Cbindgen can be used to generate C bindings for Rust code.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

cbindgen Dependencies

Required

rustc-1.71.1

Note

An Internet connection is needed for building this package.

Installation of cbindgen

Install cbindgen by running the following commands:

cargo build --release

To test the results, issue: cargo test. Three tests in the final suite are known to fail.

Now, as the root user:

install -Dm755 target/release/cbindgen /usr/bin/

Contents

Installed Program: cbindgen
Installed Library: none
Installed Directory: none

Short Descriptions

cbindgen

generates C bindings for Rust code

Clisp-2.49

Introduction to Clisp

GNU Clisp is a Common Lisp implementation which includes an interpreter, compiler, debugger, and many extensions.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Clisp Dependencies

Recommended
Optional

libnsl-2.0.0 and libffcall

Installation of Clisp

Note

This package does not support parallel build.

If you are building on a 32-bit system, work around a bug in GCC caused by the latest version of binutils:

case $(uname -m) in
    i?86) export CFLAGS="${CFLAGS:--O2 -g} -falign-functions=4" ;;
esac

Remove two tests, which fail for unknown reasons:

sed -i -e '/socket/d' -e '/"streams"/d' tests/tests.lisp

Install Clisp by running the following commands:

If you are building clisp against libffcall, apply the patch to fix a build failure with current readline:

patch -Np1 -i ../clisp-2.49-readline7_fixes-1.patch

Install Clisp by running the following commands:

mkdir build &&
cd    build &&

../configure --srcdir=../                       \
             --prefix=/usr                      \
             --docdir=/usr/share/doc/clisp-2.49 \
             --with-libsigsegv-prefix=/usr &&

ulimit -s 16384 &&
make -j1

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

ulimit -s 16384: this increases the maximum stack size, as recommended by the configure.

--docdir=/usr/share/doc/clisp-2.49: this ensures the html documentation will go into a versioned directory instead of straight into /usr/share/html/.

--with-libsigsegv-prefix=/usr: use this to tell configure that you have installed libsigsegv in /usr, otherwise it will not be found.

--with-libffcall-prefix=/usr: use this to tell configure that you have installed the optional libffcall in /usr, otherwise like libsigsegv it will not be found.

Contents

Installed Programs: clisp, clisp-link
Installed Libraries: various static libraries in /usr/lib/clisp-2.49/base/
Installed Directories: /usr/lib/clisp-2.49 /usr/share/doc/clisp-2.49 /usr/share/emacs/site-lisp;

Short Descriptions

clisp

is an ANSI Common Lisp compiler, interpreter, and debugger

clisp-link

is used to link an external module to clisp

CMake-3.27.2

Introduction to CMake

The CMake package contains a modern toolset used for generating Makefiles. It is a successor of the auto-generated configure script and aims to be platform- and compiler-independent. A significant user of CMake is KDE since version 4.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://cmake.org/files/v3.27/cmake-3.27.2.tar.gz

  • Download MD5 sum: 07786cd23c3d0aa9c2fef69efb13662b

  • Download size: 10 MB

  • Estimated disk space required: 424 MB (add 1.2 GB for tests)

  • Estimated build time: 2.0 SBU (add 3.2 SBU for tests, both using parallelism=4)

CMake Dependencies

Recommended
Optional

GCC-13.2.0 (for gfortran), git-2.41.0 (for use during tests), Mercurial-6.5.1 (for use during tests), (Qt-5.15.10 or qt-alternate-5.15.10) (for the Qt-based GUI), sphinx-7.1.2 (for building documents), Subversion-1.14.2 (for testing), cppdap, jsoncpp, and rhash

Installation of CMake

Install CMake by running the following commands:

sed -i '/"lib64"/s/64//' Modules/GNUInstallDirs.cmake &&

./bootstrap --prefix=/usr        \
            --system-libs        \
            --mandir=/share/man  \
            --no-system-jsoncpp  \
            --no-system-cppdap   \
            --no-system-librhash \
            --docdir=/share/doc/cmake-3.27.2 &&
make

To test the results, issue: LC_ALL=en_US.UTF-8 bin/ctest -j<N> -O cmake-3.27.2-test.log, where <N> is an integer between 1 and the number of system cores. Setting LC_ALL is needed to prevent some test failures when some of the locale variables are set to non English locales.

If you want to investigate a problem with a given "problem1-test", use bin/ctest -R "problem1-test" and, to omit it, use bin/ctest -E "problem1-test". These options can be used together: bin/ctest -R "problem1-test" -E "problem2-test". Option -N can be used to display all available tests, and you can run bin/ctest for a sub-set of tests by using separated by spaces names or numbers as options. Option --help can be used to show all options.

Now, as the root user:

make install

Command Explanations

sed ... Modules/GNUInstallDirs.cmake: This command disables applications using cmake from attempting to install files in /usr/lib64/.

--system-libs: This switch forces the build system to link against Zlib, Bzip2, cURL, nghttp2, Expat and libarchive installed on the system.

--no-system-jsoncpp and --no-system-cppdap: These switches remove the JSON-C++ library from the list of system libraries. A bundled version of that library is used instead.

--no-system-librhash: This switch removes the librhash library from the list of system libraries used. A bundled version of that library is used instead.

--no-system-{curl,libarchive,libuv,nghttp2}: Use the corresponding option in the list for the bootstrap if one of the recommended dependencies is not installed. A bundled version of the dependency will be used instead.

--qt-gui: This switch enables building the Qt-based GUI for CMake.

--parallel=: This switch enables performing the CMake bootstrap with multiple jobs at one time.

Contents

Installed Programs: ccmake, cmake, cmake-gui (optional), cpack, and ctest
Installed Libraries: None
Installed Directories: /usr/share/cmake-3.27 and /usr/share/doc/cmake-3.27.2

Short Descriptions

ccmake

is a curses based interactive frontend to cmake

cmake

is the makefile generator

cmake-gui

(optional) is the Qt-based frontend to cmake

cpack

is the CMake packaging program

ctest

is a testing utility for cmake-generated build trees

Doxygen-1.9.7

Introduction to Doxygen

The Doxygen package contains a documentation system for C++, C, Java, Objective-C, Corba IDL and to some extent PHP, C# and D. It is useful for generating HTML documentation and/or an off-line reference manual from a set of documented source files. There is also support for generating output in RTF, PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code.

You can also configure Doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. Used along with Graphviz, you can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://doxygen.nl/files/doxygen-1.9.7.src.tar.gz

  • Download MD5 sum: 95008edf2d84aeefb7c65a6a4857dc2c

  • Download size: 5.5 MB

  • Estimated disk space required: 240 MB (with tests)

  • Estimated build time: 1.6 SBU (using parallelism=4; with tests)

Doxygen Dependencies

Required

CMake-3.27.2 and git-2.41.0

Optional

Graphviz-8.1.0, ghostscript-10.01.2, libxml2-2.10.4 (required for the tests), LLVM-16.0.5 (with clang), (Qt-5.15.10 or qt-alternate-5.15.10) (for doxywizard), texlive-20230313 (or install-tl-unx), xapian-1.4.23 (for doxyindexer), and javacc

Installation of Doxygen

Note

When untarring this package, you may see messages such as Ignoring unknown extended header keyword 'LIBARCHIVE.xattr.com.apple.TextEncoding'. These messages are harmless, and can be safely ignored.

First, fix up some python scripts:

grep -rl '^#!.*python$' | xargs sed -i '1s/python/&3/'

Install Doxygen by running the following commands:

mkdir -v build &&
cd       build &&

cmake -G "Unix Makefiles"         \
      -DCMAKE_BUILD_TYPE=Release  \
      -DCMAKE_INSTALL_PREFIX=/usr \
      -Wno-dev .. &&

make

To test the results, issue: make tests. One test, 061_UÌnicod€_file, is known to fail.

If you wish to generate the package documentation, you must have Python, TeX Live (for HTML docs) and Ghostscript (for PDF docs) installed, then issue the following command:

cmake -DDOC_INSTALL_DIR=share/doc/doxygen-1.9.7 -Dbuild_doc=ON .. &&

make docs

Now, as the root user:

make install &&
install -vm644 ../doc/*.1 /usr/share/man/man1

If you have generated the package documentation, then the man pages are automatically installed, and you do not need to run the last install ... command.

Command Explanations

-Dbuild_wizard=ON: Use this switch if Qt5 is installed and you wish to build the GUI front-end.

-Dbuild_search=ON: Use this switch if xapian is installed and you wish to build external search tools (doxysearch.cgi and doxyindexer).

-Duse_libclang=ON: Use this switch if llvm with clang are installed, to add support for libclang parsing.

Configuring Doxygen

There is no real configuration necessary for the Doxygen package although three additional packages are required if you wish to use extended capabilities. If you need to use the language translation features, you must have Python-2.7.18 installed. If you require formulas to create PDF documentation, then you must have texlive-20230313 installed. If you require formulas to convert PostScript files to bitmaps, then you must have ghostscript-10.01.2 installed.

Contents

Installed Programs: doxygen and optionally, doxywizard, doxyindexer and doxysearch.cgi
Installed Libraries: None
Installed Directory: /usr/share/doc/doxygen-1.9.7

Short Descriptions

doxygen

is a command-line based utility used to generate template configuration files and then generate documentation from these templates. Use doxygen --help for an explanation of the command-line parameters

doxywizard

is a GUI front-end for configuring and running doxygen

doxyindexer

generates a search index called doxysearch.db from one or more search data files produced by doxygen. See, e.g. https://javacc.github.io/javacc/

doxysearch.cgi

is a CGI program to search the data indexed by doxyindexer

GCC-13.2.0

Introduction to GCC

The GCC package contains the GNU Compiler Collection. This page describes the installation of compilers for the following languages: C, C++, Fortran, Objective C, Objective C++, Go, and Modula2. Since C and C++ are installed in LFS, this page is either for upgrading C and C++, or for installing additional compilers.

Note

Additional languages, among which D and Ada, are available in the collection. D and Ada have a binary bootstrap requirement for the first installation, so their installation is not described here. To install them, you can proceed along the same lines as below after installing the corresponding compiler from a binary package, adding ada or d to the --enable-languages line.

This package is known to build and work properly using an LFS 12.0 platform.

Caution

If you are upgrading GCC from any other version prior to 13.2.0, then you must be careful compiling 3rd party kernel modules. You should ensure that the kernel and all its native modules are also compiled using the same version of GCC that you use to build the 3rd party module. This issue does not affect native kernel (and kernel modules) updates, as the instructions below are a complete reinstallation of GCC. If you have existing 3rd party modules installed, ensure they are recompiled using the updated version of GCC. As always, never update the kernel headers from the ones used when Glibc was compiled during LFS.

Package Information

GCC Dependencies

Optional

GDB-13.2, Valgrind-3.21.0 (for tests), and ISL (to enable graphite optimization)

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/gcc

Installation of GCC

Important

Even if you specify only languages other than C and C++ to the ./configure command below, the installation process will overwrite your existing GCC C and C++ compilers and libraries. Running the full suite of tests is recommended.

Do not continue with the make install command until you are confident the build was successful. You can compare your test results with those found at https://gcc.gnu.org/ml/gcc-testresults/. You may also want to refer to the information found in the GCC section of Chapter 8 in the LFS book (../../../../lfs/view/12.0-systemd/chapter08/gcc.html).

The instructions below are intentionally performing a bootstrap process. Bootstrapping is needed for robustness and is highly recommended when upgrading the compilers version. To disable bootstrap anyway, add --disable-bootstrap to the ./configure options below.

Install GCC by running the following commands:

case $(uname -m) in
  x86_64)
    sed -i.orig '/m64=/s/lib64/lib/' gcc/config/i386/t-linux64
  ;;
esac

mkdir build               &&
cd    build               &&

../configure              \
    --prefix=/usr         \
    --disable-multilib    \
    --with-system-zlib    \
    --enable-default-pie  \
    --enable-default-ssp  \
    --disable-fixincludes \
    --enable-languages=c,c++,fortran,go,objc,obj-c++,m2 &&
make

If you have installed additional packages such as valgrind and gdb, the gcc part of the test suite will run more tests than in LFS. Some of those will report FAIL and others XPASS (pass when expected to FAIL). As of gcc-13.2.0, about 65 FAIL occur in the guality suite, as well as miscellaneous failures throughout the rest of the test suite. If all the compilers above are built, there will be a little over 80 unexpected failures out of over 546,000 tests. To run the tests, issue:

ulimit -s 32768 &&
make -k check

The tests are very long, and the results may be hard to find in the logs, specially if you use parallel jobs with make. You can get a summary of the tests with:

../contrib/test_summary

Now, as the root user:

make install &&

mkdir -pv /usr/share/gdb/auto-load/usr/lib              &&
mv -v /usr/lib/*gdb.py /usr/share/gdb/auto-load/usr/lib &&

chown -v -R root:root \
    /usr/lib/gcc/*linux-gnu/13.2.0/include{,-fixed}

Command Explanations

mkdir build; cd build: The GCC documentation recommends building the package in a dedicated build directory.

--disable-multilib: This parameter ensures that files are created for the specific architecture of your computer.

--with-system-zlib: Uses the system zlib instead of the bundled one. zlib is used for compressing and decompressing GCC's intermediate language in LTO (Link Time Optimization) object files.

--enable-default-pie: Makes the -fpie option the default when compiling programs. Together with the ASLR feature enabled in the kernel, this defeats some kind of attacks based on known memory layouts.

--enable-default-ssp: Makes the -fstack-protector-strong option the default when compiling programs. SSP is a technique preventing alteration of the program flow by corrupting the parameter stack.

--enable-languages=c,c++,fortran,go,objc,obj-c++,m2: This command identifies which languages to build. You may modify this command to remove undesired languages. GCC also supports Ada and D, but building GCC with Ada (or D) support needs an existing Ada (or D) compiler. So they are not enabled here.

ulimit -s 32768: This command prevents several tests from running out of stack space.

make -k check: This command runs the test suite without stopping if any errors are encountered.

../contrib/test_summary: This command will produce a summary of the test suite results. You can append | grep -A7 Summ to the command to produce an even more condensed version of the summary. You may also wish to redirect the output to a file for review and comparison later on.

mv -v /usr/lib/*gdb.py ...: The installation stage puts some files used by gdb under the /usr/lib directory. This generates spurious error messages when performing ldconfig. This command moves the files to another location.

chown -v -R root:root /usr/lib/gcc/*linux-gnu/...: If the package is built by a user other than root, the ownership of the installed include directory (and its content) will be incorrect. This command changes the ownership to the root user and group.

--enable-host-shared --enable-languages=jit: Build libgccjit, a library for embedding GCC inside programs and libraries for generating machine code. Despite JIT (just-in-time) in the name, the library can be used for AOT (ahead-of-time) compilation as well. --enable-host-shared is needed for building libgccjit, but it significantly slows down GCC. So libgccjit should be built and installed separately, not as a part of the main GCC installation. If you need this library, configure GCC with these two options and install the library by running make -C gcc jit.install-common jit.install-info as the root user. This library is not used by any BLFS package, nor tested by the BLFS developers.

Contents

Some program and library names and descriptions are not listed here, but can be found at LFS section for GCC as they were initially installed during the building of LFS.

Installed Programs: gccgo, gfortran, gm2, go, and gofmt, hard-linked to architecture specific names
Installed Libraries: libgfortran.{so,a}, libgm2.{so,a} libgo.{so,a}, libgobegin.a, libgolibbegin.a, libobjc.{so,a}, and numerous other run-time libraries and executables
Installed Directories: /usr/lib/go

Short Descriptions

gccgo

is a GCC-based compiler for the Go language

gm2

is a GCC-based compiler for the Modula-2 language

go

is a tool for managing Go source code

gofmt

is a tool for formatting Go source code

gfortran

is a GCC-based compiler for the Fortran language

GC-8.2.4

Introduction to GC

The GC package contains the Boehm-Demers-Weiser conservative garbage collector, which can be used as a garbage collecting replacement for the C malloc function or C++ new operator. It allows you to allocate memory basically as you normally would, without explicitly deallocating memory that is no longer useful. The collector automatically recycles memory when it determines that it can no longer be otherwise accessed. The collector is also used by a number of programming language implementations that either use C as intermediate code, want to facilitate easier interoperation with C libraries, or just prefer the simple collector interface. Alternatively, the garbage collector may be used as a leak detector for C or C++ programs, though that is not its primary goal.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Optional

libatomic_ops-7.8.0

Installation of GC

Install GC by running the following commands:

./configure --prefix=/usr      \
            --enable-cplusplus \
            --disable-static   \
            --docdir=/usr/share/doc/gc-8.2.4 &&
make

To test the results, issue: make check.

Now, as the root user:

make install &&
install -v -m644 doc/gc.man /usr/share/man/man3/gc_malloc.3

Command Explanations

--docdir=/usr/share/doc/gc-8.2.4: This option is used so the package will install the documentation in a versioned directory.

--enable-cplusplus: This parameter enables the building and installing of the C++ library along with the standard C library.

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Libraries: libcord.so, libgc.so, libgccpp.so, and libgctba.so
Installed Directories: /usr/include/gc and /usr/share/doc/gc-8.2.4

Short Descriptions

libcord.so

contains a tree-based string library

libgc.so

contains a C interface to the conservative garbage collector, primarily designed to replace the C malloc function

libgccpp.so

contains a C++ interface to the conservative garbage collector

libgctba.so

contains a C++ interface to throw bad allocations

GDB-13.2

Introduction to GDB

GDB, the GNU Project debugger, allows you to see what is going on inside another program while it executes -- or what another program was doing at the moment it crashed. Note that GDB is most effective when tracing programs and libraries that were built with debugging symbols and not stripped.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GDB Dependencies

Recommended Runtime Dependency
Optional

Doxygen-1.9.7, GCC-13.2.0 (ada, gfortran, and go are used for tests), Guile-3.0.9, rustc-1.71.1 (used for some tests), Valgrind-3.21.0, and SystemTap (run-time, used for tests)

Installation of GDB

Install GDB by running the following commands:

mkdir build &&
cd    build &&

../configure --prefix=/usr          \
             --with-system-readline \
             --with-python=/usr/bin/python3 &&
make

Optionally, to build the API documentation using Doxygen-1.9.7, run:

make -C gdb/doc doxy

To test the results, issue:

pushd gdb/testsuite &&
make  site.exp      &&
echo  "set gdb_test_timeout 120" >> site.exp &&
runtest
popd

See gdb/testsuite/README and TestingGDB. There are many problems with the test suite:

  • Clean directories are needed if re-running the tests. For that reason, make a copy of the compiled source code directory before the tests in case you need to run the tests again.

  • Results depend on installed compilers.

  • A test run of the test suite had 183 unexpected failures out of over 105000 tests.

  • On some systems, the gdb.tui test suite will fail if running over SSH.

  • On some AMD-based systems, over 200 additional tests may fail due to a difference in the threading implementation on those CPUs.

Now, as the root user:

make -C gdb install &&
make -C gdbserver install

If you have built the API documentation, it is now in gdb/doc/doxy. You can install it (as the root user):

install -d /usr/share/doc/gdb-13.2 &&
rm -rf gdb/doc/doxy/xml &&
cp -Rv gdb/doc/doxy /usr/share/doc/gdb-13.2

Command Explanations

--with-system-readline: This switch forces GDB to use the copy of Readline installed in LFS.

--with-python=/usr/bin/python3: This switch forces GDB to use Python 3.

Contents

Installed Programs: gcore, gdb, gdbserver, and gdb-add-index
Installed Library: libinproctrace.so
Installed Directories: /usr/{include,share}/gdb and /usr/share/doc/gdb-13.2

Short Descriptions

gcore

generates a core dump of a running program

gdb

is the GNU Debugger

gdbserver

is a remote server for the GNU debugger (it allows programs to be debugged from a different machine)

gdb-add-index

Allows adding index files to ELF binaries. This speeds up gdb start on large programs.

libinproctrace.so

contains functions for the in-process tracing agent. The agent allows for installing fast tracepoints, listing static tracepoint markers, probing static tracepoints markers, and starting trace monitoring.

Git-2.41.0

Introduction to Git

Git is a free and open source, distributed version control system designed to handle everything from small to very large projects with speed and efficiency. Every Git clone is a full-fledged repository with complete history and full revision tracking capabilities, not dependent on network access or a central server. Branching and merging are fast and easy to do. Git is used for version control of files, much like tools such as Mercurial-6.5.1, Bazaar, Subversion-1.14.2, CVS, Perforce, and Team Foundation Server.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://www.kernel.org/pub/software/scm/git/git-2.41.0.tar.xz

  • Download MD5 sum: c1f58a12b891ad73927b8e4a3aa29c7b

  • Download size: 11 MB

  • Estimated disk space required: 252 MB (with downloaded documentation

  • Estimated build time: 0.3 SBU (with parallelism=4; add up to 1.6 SBU (disk speed dependent) for tests, both with parallelism=4)

Additional Downloads

Git Dependencies

Recommended
Optional

Apache-2.4.57 (for some tests), GnuPG-2.4.3 (runtime, may be used to sign Git commits or tags, or verify the signatures of them), OpenSSH-9.4p1 (runtime, needed to use Git over ssh), pcre2-10.42 (or the deprecated PCRE-8.45), in either case configured with --enable-jit, Subversion-1.14.2 with Perl bindings (runtime, for git svn), Tk-8.6.13 (gitk, a simple Git repository viewer, uses Tk at runtime), Valgrind-3.21.0, Authen::SASL and MIME::Base64 (both runtime, for git send-email), and IO-Socket-SSL-2.083 (runtime, for git send-email to connect to a SMTP server with SSL encryption)

Optional (to create the man pages, html docs and other docs)

xmlto-0.0.28 and asciidoc-10.2.0 , and also dblatex (for the PDF version of the user manual), and docbook2x to create info pages

Installation of Git

Install Git by running the following commands:

./configure --prefix=/usr \
            --with-gitconfig=/etc/gitconfig \
            --with-python=python3 &&
make

You can build the man pages and/or html docs, or use downloaded ones. If you choose to build them, use the next two instructions.

If you have installed asciidoc-10.2.0 you can create the html version of the man pages and other docs:

make html

If you have installed asciidoc-10.2.0 and xmlto-0.0.28 you can create the man pages:

make man

The test suite can be run in parallel mode. To run the test suite, issue: make -k test. If Apache-2.4.57 is installed, three tests in t5559-http-fetch-smart-http2.sh are known to fail due to cURL-8.1.x.

Now, as the root user:

make perllibdir=/usr/lib/perl5/5.38/site_perl install

If you created the man pages and/or html docs

Install the man pages as the root user:

make install-man

Install the html docs as the root user:

make htmldir=/usr/share/doc/git-2.41.0 install-html

If you downloaded the man pages and/or html docs

If you downloaded the man pages untar them as the root user:

tar -xf ../git-manpages-2.41.0.tar.xz \
    -C /usr/share/man --no-same-owner --no-overwrite-dir

If you downloaded the html docs untar them as the root user:

mkdir -vp   /usr/share/doc/git-2.41.0 &&
tar   -xf   ../git-htmldocs-2.41.0.tar.xz \
      -C    /usr/share/doc/git-2.41.0 --no-same-owner --no-overwrite-dir &&

find        /usr/share/doc/git-2.41.0 -type d -exec chmod 755 {} \; &&
find        /usr/share/doc/git-2.41.0 -type f -exec chmod 644 {} \;

Reorganize text and html in the html-docs (both methods)

For both methods, the html-docs include a lot of plain text files. Reorganize the files as the root user:

mkdir -vp /usr/share/doc/git-2.41.0/man-pages/{html,text}         &&
mv        /usr/share/doc/git-2.41.0/{git*.txt,man-pages/text}     &&
mv        /usr/share/doc/git-2.41.0/{git*.,index.,man-pages/}html &&

mkdir -vp /usr/share/doc/git-2.41.0/technical/{html,text}         &&
mv        /usr/share/doc/git-2.41.0/technical/{*.txt,text}        &&
mv        /usr/share/doc/git-2.41.0/technical/{*.,}html           &&

mkdir -vp /usr/share/doc/git-2.41.0/howto/{html,text}             &&
mv        /usr/share/doc/git-2.41.0/howto/{*.txt,text}            &&
mv        /usr/share/doc/git-2.41.0/howto/{*.,}html               &&

sed -i '/^<a href=/s|howto/|&html/|' /usr/share/doc/git-2.41.0/howto-index.html &&
sed -i '/^\* link:/s|howto/|&html/|' /usr/share/doc/git-2.41.0/howto-index.txt

Command Explanations

--with-gitconfig=/etc/gitconfig: This sets /etc/gitconfig as the file that stores the default, system wide, Git settings.

--with-python=python3: Use this switch to use Python 3, instead of the EOL'ed Python 2. Python is used for the git p4 interface to Perforce repositories, and also used in some tests.

--with-libpcre2: Use this switch if PCRE2 is installed and has been built with the non-default JIT enabled.

--with-libpcre1: As an alternative to PCRE2, use this switch if the deprecated PCRE is installed and has been built with the non-default JIT enabled.

tar -xf ../git-manpages-2.41.0.tar.gz -C /usr/share/man --no-same-owner: This untars git-manpages-2.41.0.tar.gz. The -C option makes tar change directory to /usr/share/man before it starts to decompress the docs. The --no-same-owner option stops tar from preserving the user and group details of the files. This is useful as that user or group may not exist on your system; this could (potentially) be a security risk.

mv /usr/share/doc/git-2.41.0 ...: These commands move some of the files into subfolders to make it easier to sort through the docs and find what you're looking for.

find ... chmod ...: These commands correct the permissions in the shipped documentation tar file.

Configuring Git

Config Files

~/.gitconfig and /etc/gitconfig

Contents

Installed Programs: git, git-receive-pack, git-upload-archive, and git-upload-pack (hardlinked to each other), git-cvsserver, git-shell, gitk, and scalar
Installed Libraries: None
Installed Directories: /usr/libexec/git-core, and /usr/share/{doc/git-2.41.0,git-core,git-gui,gitk,gitweb}

Short Descriptions

git

is the stupid content tracker

git-cvsserver

is a CVS server emulator for Git

gitk

is a graphical Git repository browser (needs Tk-8.6.13)

git-receive-pack

is invoked by git send-pack and updates the repository with the information fed from the remote end

git-shell

is a login shell for SSH accounts to provide restricted Git access

git-upload-archive

is invoked by git archive --remote and sends a generated archive to the other end over the git protocol

git-upload-pack

is invoked by git fetch-pack, it discovers what objects the other side is missing, and sends them after packing

scalar

is a repository management tool that optimizes Git for use in large repositories

Running a Git Server

Introduction

This section will describe how to set up, administer and secure a git server. Git has many options available. For more detailed documentation see https://git-scm.com/book/en/v2.

Server Dependencies

Required

git-2.41.0 and OpenSSH-9.4p1

Setting up a Git Server

The following instructions will install a git server. It will be set up to use OpenSSH as the secure remote access method.

Configuration of the server consists of the following steps:

1. Set Up Users, Groups, and Permissions

You will need to be user root for the initial portion of configuration. Create the git user and group and set and unusable password hash with the following commands:

groupadd -g 58 git &&
useradd -c "git Owner" -d /home/git -m -g git -s /usr/bin/git-shell -u 58 git &&
sed -i '/^git:/s/^git:[^:]:/git:NP:/' /etc/shadow

Putting in an unusable password hash (replacing the ! by NP) unlocks the account but it cannot be used to login via password authentication. That is required by sshd to work properly. Next, create some files and directories in the home directory of the git user allowing access to the git repository using ssh keys.

install -o git -g git -dm0700 /home/git/.ssh &&
install -o git -g git -m0600 /dev/null /home/git/.ssh/authorized_keys

For any developer who should have access to the repository add his/her public ssh key to /home/git/.ssh/authorized_keys. First, prepend some options to prevent users from using the connection to git for port forwarding to other machines the git server might reach.

echo -n "no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty " >> /home/git/.ssh/authorized_keys &&
cat <user-ssh-key> >> /home/git/.ssh/authorized_keys

It is also useful to set the default name of the initial branch of new repositories by modifying the git configuration. As the root user, run:

git config --system init.defaultBranch trunk

Finally add the /usr/bin/git-shell entry to the /etc/shells configuration file. This shell has been set in the git user profile and is to make sure that only git related actions can be executed:

echo "/usr/bin/git-shell" >> /etc/shells

2. Create a git repository

The repository can be anywhere on the filesystem. It is important that the git user has read/write access to that location. We use /srv/git as base directory. Create a new git repository with the following commands (as the root user):

Note

In all the instructions below, we use project1 as an example repository name. You should name your repository as a short descriptive name for your specific project.

install -o git -g git -m755 -d /srv/git/project1.git &&
cd /srv/git/project1.git                             &&
git init --bare                                      &&
chown -R git:git .

3. Populate the repository from a client system

Note

All the instructions in this section and the next should be done on a user system, not the server system.

Now that the repository is created, it can be used by the developers to put some files into it. Once the ssh key of the user is imported to git's authorized_keys file, the user can interact with the repository.

A minimal configuration should be available on the developer's system specifying its user name and the email address. Create this minimal config file on client side:

cat > ~/.gitconfig <<EOF
[user]
        name = <users-name>
        email = <users-email-address>
EOF

On the developer's machine, set up some files to be pushed to the repository as the initial content:

Note

The gitserver term used below should be the host name (or ip address) of the git server.

mkdir myproject
cd myproject
git init --initial-branch=trunk
git remote add origin git@gitserver:/srv/git/project1.git
cat >README <<EOF
This is the README file
EOF
git add README
git commit -m 'Initial creation of README'
git push --set-upstream origin trunk

The initial content is now pushed to the server and is available for other users. On the current machine, the argument --set-upstream origin trunk is now no longer required as the local repository is now connected to the remote repository. Subsequent pushes can be performed as

git push

Other developers can now clone the repository and do modifications to the content (as long as their ssh keys has been installed):

git clone git@gitserver:/srv/git/project1.git
cd project1
vi README
git commit -am 'Fix for README file'
git push

Note

This is a very basic server setup based on OpenSSH access. All developers are using the git user to perform actions on the repository and the changes users are committing can be distinguished as the local user name (see ~/.gitconfig) is recorded in the changesets.

Access is restricted by the public keys added to git's authorized_keys file and there is no option for the public to export/clone the repository. To enable this, continue with step 4 to set up the git server for public read-only access.

In the URL used to clone the project, the absolute path (here /srv/git/project1.git) has to be specified as the repository is not in git's home directory but in /srv/git. To get rid of the need to expose the structure of the server installation, a symlink can be added in git's home directory for each project like this:

ln -svf /srv/git/project1.git /home/git/

Now, the repository can be cloned using

git clone git@gitserver:project1.git

4. Configure the Server

The setup described above makes a repository available for authenticated users (via providing the ssh public key file). There is also a simple way to publish the repository to unauthenticated users — of course without write access.

The combination of access via ssh (for authenticated users) and the export of repositories to unauthenticated users via the daemon is in most cases enough for a development site.

Note

The daemon will be reachable at port 9418 by default. Make sure that your firewall setup allows access to that port.

To start the server at boot time, install the git-daemon.service unit from the blfs-systemd-units-20230816 package:

make install-git-daemon

In order to allow git to export a repository, a file named git-daemon-export-ok is required in each repository directory on the server. The file needs no content, just its existence enables, its absence disables the export of that repository.

touch /srv/git/project1.git/git-daemon-export-ok

Along with the git-daemon.service unit, a configuration file named /etc/default/git-daemon has been installed. Review this configuration file to match your needs.

There are only three options to set in the configuration file:

  • GIT_BASE_DIR=<dirname>

    Specify the location of the git repositories. Relative paths used when accessing the daemon will translated relative to this directory.

  • DFT_REPO_DIR=<dirname>

    This directory is added to the white list of allowed directories. This variable can hold multiple directory names but is usually set equal to GIT_BASE_DIR.

  • GIT_DAEMON_OPTS=<options>

    In case special options to the git daemon command are needed, they have to be specified in this setting. One example might be to adjust the port number where daemon is listening. In this case, add --port=<port number> to this variable. For more information about which options can be set, take a look at the output of git daemon --help.

After starting the daemon, unauthenticated users can clone exported repositories by using

git clone git://gitserver/project1.git

As the base directory is /srv/git by default (or set to a custom value in the configuration), git interprets the incoming path (/project1.git) relative to that base directory so that the repository in /srv/git/project1.git is served.

Guile-3.0.9

Introduction to Guile

The Guile package contains the GNU Project's extension language library. Guile also contains a stand alone Scheme interpreter.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Guile Dependencies

Required

GC-8.2.4 and libunistring-1.1

Optional

Emacs-29.1 and GDB-13.2 (run-time only dependencies).

Installation of Guile

Install Guile by running the following commands:

./configure --prefix=/usr    \
            --disable-static \
            --docdir=/usr/share/doc/guile-3.0.9 &&
make      &&
make html &&

makeinfo --plaintext -o doc/r5rs/r5rs.txt doc/r5rs/r5rs.texi &&
makeinfo --plaintext -o doc/ref/guile.txt doc/ref/guile.texi

To test the results, issue: ./check-guile. On an i686 system, as many as 10 tests will fail in the numbers.test test suite due to minor floating-point rounding errors.

Now, as the root user:

make install      &&
make install-html &&

mkdir -p                       /usr/share/gdb/auto-load/usr/lib &&
mv /usr/lib/libguile-*-gdb.scm /usr/share/gdb/auto-load/usr/lib &&
mv /usr/share/doc/guile-3.0.9/{guile.html,ref} &&
mv /usr/share/doc/guile-3.0.9/r5rs{.html,}     &&

find examples -name "Makefile*" -delete         &&
cp -vR examples   /usr/share/doc/guile-3.0.9   &&

for DIRNAME in r5rs ref; do
  install -v -m644  doc/${DIRNAME}/*.txt \
                    /usr/share/doc/guile-3.0.9/${DIRNAME}
done &&
unset DIRNAME

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: guild, guile, guile-config, guile-snarf and guile-tools
Installed Libraries: libguile-3.0.so and guile-readline.so
Installed Directories: /usr/include/guile, /usr/lib/guile, /usr/share/doc/guile-3.0.9 and /usr/share/guile

Short Descriptions

guile

is a stand-alone Scheme interpreter for Guile

guile-config

is a Guile script which provides the information necessary to link your programs against the Guile library, in much the same way PkgConfig does

guile-snarf

is a script to parse declarations in your C code for Scheme visible C functions

guild

is a wrapper program installed along with guile, which knows where a particular module is installed and calls it, passing its arguments to the program

guile-tools

is a symlink to guild

Librep-0.92.7

Introduction to Librep

The librep package contains a Lisp system. This is useful for scripting or for applications that may use the Lisp interpreter as an extension language.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Librep

Install librep by running the following commands:

./configure --prefix=/usr --disable-static &&
make

This package does not come with a test suite.

Now, as the root user:

sed -i '5043,5044 d' libtool &&
make install

Contents

Installed Programs: rep, rep-remote, rep-xgettext, and repdoc
Installed Libraries: librep.so and numerous modules installed in the /usr/lib/rep hierarchy
Installed Directories: /usr/lib/rep, /usr/share/emacs/site-lisp, and /usr/share/rep

Short Descriptions

rep

is the Lisp interpreter

librep.so

contains the functions necessary for the Lisp interpreter

LLVM-16.0.5

Introduction to LLVM

The LLVM package contains a collection of modular and reusable compiler and toolchain technologies. The Low Level Virtual Machine (LLVM) Core libraries provide a modern source and target-independent optimizer, along with code generation support for many popular CPUs (as well as some less common ones!). These libraries are built around a well specified code representation known as the LLVM intermediate representation ("LLVM IR").

Clang provides new C, C++, Objective C and Objective C++ front-ends for LLVM and is required by some desktop packages such as firefox and for rust if that is built using the system LLVM.

The Compiler RT package provides runtime sanitizer and profiling libraries for developers who use Clang and LLVM.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Cmake modules for LLVM

Third-party dependencies for LLVM build system

Recommended Download

Clang

Optional Download

Compiler RT

LLVM Dependencies

Required

CMake-3.27.2

Optional

Doxygen-1.9.7, git-2.41.0, Graphviz-8.1.0, libxml2-2.10.4, Pygments-2.16.1, rsync-3.2.7 (for tests), recommonmark-0.7.1 (for building documentation), texlive-20230313 (or install-tl-unx), Valgrind-3.21.0, PyYAML-6.0.1, Zip-3.0, OCaml, psutil (for tests), and Z3

Installation of LLVM

Two additional tarballs llvm-cmake.src.tar.xz and llvm-third-party.src.tar.xz are needed by LLVM building system. The upstream expects them extracted at the same level as the llvm-16.0.5.src.tar.xz tarball, and the extracted directories renamed to cmake and third-party. Extract them and modify the build system to avoid creating ambiguously-named directories outside the llvm-16.0.5.src hierarchy:

tar -xf ../llvm-cmake.src.tar.xz                                   &&
tar -xf ../llvm-third-party.src.tar.xz                             &&
sed '/LLVM_COMMON_CMAKE_UTILS/s@../[email protected]@'          \
    -i CMakeLists.txt                                              &&
sed '/LLVM_THIRD_PARTY_DIR/s@../[email protected]@' \
    -i cmake/modules/HandleLLVMOptions.cmake

Install clang into the source tree by running the following commands:

tar -xf ../clang-16.0.5.src.tar.xz -C tools &&
mv tools/clang-16.0.5.src tools/clang

If you have downloaded compiler-rt, install it into the source tree by running the following commands:

tar -xf ../compiler-rt-16.0.5.src.tar.xz -C projects &&
mv projects/compiler-rt-16.0.5.src projects/compiler-rt

There are many Python scripts in this package which use /usr/bin/env python to access the system Python which on LFS is Python-3.11.4. Use the following command to fix these scripts:

grep -rl '#!.*python' | xargs sed -i '1s/python$/python3/'

If you have downloaded clang, apply the following patch to enable SSP by default in compiled programs.

patch -Np2 -d tools/clang <../clang-16.0.5-enable_default_ssp-1.patch

If you have downloaded compiler-rt, fix a test case broken by default SSP in clang:

sed 's/clang_dfsan/& -fno-stack-protector/' \
    -i projects/compiler-rt/test/dfsan/origin_unaligned_memtrans.c

Install LLVM by running the following commands:

mkdir -v build &&
cd       build &&

CC=gcc CXX=g++                                  \
cmake -DCMAKE_INSTALL_PREFIX=/usr               \
      -DLLVM_ENABLE_FFI=ON                      \
      -DCMAKE_BUILD_TYPE=Release                \
      -DLLVM_BUILD_LLVM_DYLIB=ON                \
      -DLLVM_LINK_LLVM_DYLIB=ON                 \
      -DLLVM_ENABLE_RTTI=ON                     \
      -DLLVM_TARGETS_TO_BUILD="host;AMDGPU;BPF" \
      -DLLVM_BINUTILS_INCDIR=/usr/include       \
      -DLLVM_INCLUDE_BENCHMARKS=OFF             \
      -DCLANG_DEFAULT_PIE_ON_LINUX=ON           \
      -Wno-dev -G Ninja ..                      &&
ninja

If you have installed recommonmark-0.7.1 and its dependencies, you can generate the html documentation and manual pages with the following commands:

cmake -DLLVM_BUILD_DOCS=ON            \
      -DLLVM_ENABLE_SPHINX=ON         \
      -DSPHINX_WARNINGS_AS_ERRORS=OFF \
      -Wno-dev -G Ninja ..            &&
ninja docs-llvm-html  docs-llvm-man

The clang documentation can be built too:

ninja docs-clang-html docs-clang-man

LLVM test suite can produce many core dump files. They will occupy a large amount of disk space, and the core dump process can significantly slow down the testing. To test the results with core dump disabled, ensure Systemd-254 is rebuilt with Linux-PAM-1.5.3 support and the current login session is started after updating the /etc/pam.d/system-session file to include pam_systemd.so, then issue:

systemctl   --user start dbus &&
systemd-run --user --pty -d -G -p LimitCORE=0 ninja check-all

Tests are built with all available cores, but run using the number of online processors. (The difference is that available cores can be limited using taskset, but taking them offline requires echoing 0 to /sys/devices/system/cpu/cpu<N>/online by the root user and makes them temporarily unusable by all jobs on the machine.) One test named Linux/clone_setns.cpp will fail if CONFIG_USER_NS is not enabled in kernel configuration. The tests named AtoiAndFriendsOOBTest, StrtolOOBTest, StrtollOOBTest, interception_malloc_test.cpp, and scanf-allocate.cpp are known to fail with Glibc-2.38.

Now, as the root user:

ninja install &&
cp bin/FileCheck /usr/bin

If you have built the llvm documentation, it has been installed by the above command, but it needs to be moved. As the root user:

install -v -d -m755 /usr/share/doc/llvm-16.0.5            &&
mv -v /usr/share/doc/LLVM/llvm /usr/share/doc/llvm-16.0.5 &&
rmdir -v --ignore-fail-on-non-empty /usr/share/doc/LLVM

If you have built the clang documentation, it has been installed, but needs to be moved too. Again as the root user:

install -v -d -m755 /usr/share/doc/llvm-16.0.5             &&
mv -v /usr/share/doc/LLVM/clang /usr/share/doc/llvm-16.0.5 &&
rmdir -v --ignore-fail-on-non-empty /usr/share/doc/LLVM

Command Explanations

-DLLVM_ENABLE_FFI=ON: This switch allows LLVM to use libffi.

-DLLVM_BUILD_LLVM_DYLIB=ON: This switch builds the libraries as static and links all of them into an unique shared one. This is the recommended way of building a shared library.

-DCMAKE_BUILD_TYPE=Release: This switch enables compiler optimizations in order to speed up the code and reduce its size. It also disables some compile checks which are not necessary on a production system.

-DLLVM_TARGETS_TO_BUILD="host;AMDGPU;BPF": This switch enables building for the same target as the host, and also for the r600 AMD GPU used by the Mesa r600 and radeonsi drivers. The BPF target is required to build v4l-utils-1.24.1. The Default is all of the targets. You can use a semicolon separated list. Valid targets are: host, X86, Sparc, PowerPC, ARM, AArch64, Mips, Hexagon, Xcore, M68K, MSP430, NVPTX, SystemZ, AMDGPU, BPF, CppBackend, or all.

-DLLVM_LINK_LLVM_DYLIB=ON: Used in conjunction with -DLLVM_BUILD_LLVM_DYLIB=ON, this switch enables linking the tools against the shared library instead of the static ones. It slightly reduces their size and also ensures that llvm-config will correctly use libLLVM-16.so.

-DLLVM_ENABLE_RTTI=ON: This switch is used to build LLVM with run-time type information. This is required for building Mesa-23.1.6.

-DLLVM_BINUTILS_INCDIR=/usr/include: This switch is used to tell the build system the location of binutils headers, which were installed in LFS. This allows the building of LLVMgold.so, which is needed for building programs with clang and Link Time Optimization (LTO).

-DLLVM_INCLUDE_BENCHMARKS=OFF: is used to disable generation build targets for the LLVM benchmarks. This option requires additional code that is not currently available.

-DCLANG_DEFAULT_PIE_ON_LINUX=ON: makes -fpie option the default when compiling programs. Together with the ASLR feature enabled in the kernel, this defeats some kind of attacks based on known memory layouts.

-DBUILD_SHARED_LIBS=ON: if used instead of -DLLVM_BUILD_LLVM_DYLIB=ON and -DLLVM_LINK_LLVM_DYLIB=ON, builds all the LLVM libraries (about 60) as shared libraries instead of static.

-DLLVM_ENABLE_DOXYGEN: Enables the generation of browsable HTML documentation if you have installed Doxygen-1.9.7. You should run make doxygen-html afterwards, and install the generated documentation manually.

Contents

Installed Programs: amdgpu-arch, analyze-build, bugpoint, c-index-test, clang, clang++ (symlinks to clang-16), clang-16, clang-check, clang-cl, clang-cpp (last two symlinks to clang), clang-extdef-mapping, clang-format, clang-linker-wrapper, clang-offload-bundler, clang-offload-packager, clang-refactor, clang-rename, clang-repl, clang-scan-deps, diagtool, dsymutil, FileCheck, git-clang-format, hmaptool, intercept-build, llc, lli, llvm-addr2line (symlink to llvm-symbolizer), llvm-ar, llvm-as, llvm-bcanalyzer, llvm-bitcode-strip (symlink to llvm-objcopy), llvm-cat, llvm-cfi-verify, llvm-config, llvm-cov, llvm-c-test, llvm-cvtres, llvm-cxxdump, llvm-cxxfilt, llvm-cxxmap, llvm-debuginfo-analyzer, llvm-debuginfod, llvm-debuginfod-find, llvm-diff, llvm-dis, llvm-dlltool (symlink to llvm-ar), llvm-dwarfdump, llvm-dwarfutil, llvm-dwp, llvm-exegesis, llvm-extract, llvm-gsymutil, llvm-ifs, llvm-install-name-tool (symlink to llvm-objcopy), llvm-jitlink, llvm-lib (symlink to llvm-ar), llvm-libtool-darwin, llvm-link, llvm-lipo, llvm-lto, llvm-lto2, llvm-mc, llvm-mca, llvm-ml, llvm-modextract, llvm-mt, llvm-nm, llvm-objcopy, llvm-objdump, llvm-opt-report, llvm-otool (symlink to llv-objdump), llvm-pdbutil, llvm-profdata, llvm-profgen, llvm-ranlib (symlink to llvm-ar), llvm-rc, llvm-readelf (symlink to llvm-readobj), llvm-readobj, llvm-reduce, llvm-remark-size-diff, llvm-remarkutil, llvm-rtdyld, llvm-sim, llvm-size, llvm-split, llvm-stress, llvm-strings, llvm-strip (symlink to llvm-objcopy), llvm-symbolizer, llvm-tapi-diff, llvm-tblgen, llvm-tli-checker, llvm-undname, llvm-windres (symlink to llvm-rc), llvm-xray, nvptx-arch, opt, sancov, sanstats, scan-build, scan-build-py, scan-view, split-file, and verify-uselistorder
Installed Libraries: libLLVM.so, libLLVM*.a (100 libraries), libLTO.so, libRemarks.so, libclang.so, libclang-cpp.so, libclang*.a (42 libraries), and LLVMgold.so
Installed Directories: /usr/include/{clang,clang-c,llvm,llvm-c}, /usr/lib/{clang,cmake/{clang,llvm},libear,libscanbuild}, /usr/share/{clang,opt-viewer,scan-build,scan-view}, and /usr/share/doc/llvm-16.0.5

Short Descriptions

amdgpu-arch

lists AMD GPUs installed; at runtime it needs libhsa-runtime64.so which is not a part of BLFS

analyze-build

is a static analysis tool

bugpoint

is the automatic test case reduction tool

c-index-test

is used to test the libclang API and demonstrate its usage

clang

is the Clang C, C++, and Objective-C compiler

clang-check

is a tool to perform static code analysis and display Abstract Syntax Trees (AST)

clang-extdef-mapping

is a tool to collect the USR name and location of external definitions in a source file

clang-format

is a tool to format C/C++/Java/JavaScript/Objective-C/Protobuf code

clang-linker-wrapper

is a wrapper utility over the host linker

clang-offload-bundler

is a tool to bundle/unbundle OpenMP offloaded files associated with a common source file

clang-offload-packager

is a tool to bundle several object files into a single binary, which can then be used to create a fatbinary containing offloading code

clang-refactor

is a Clang-based refactoring tool for C, C++ and Objective-C

clang-rename

is a tool to rename symbols in C/C++ programs

clang-scan-deps

is a tool to scan for dependencies in a source file

diagtool

is a combination of tools for dealing with diagnostics in clang

FileCheck

is a tool that reads two files (one from standard input, and one specified on the command line) and uses one to verify the other.

dsymutil

is a tool used to manipulate archived DWARF debug symbol files, compatible with the Darwin command dsymutil

git-clang-format

runs clang-format on git generated patches (requires git-2.41.0)

hmaptool

is a Python tool to dump and construct header maps

intercept-build

generates a database of build commands for a project

llc

is the LLVM static compiler

lli

is used to directly execute programs from LLVM bitcode

llvm-addr2line

is a tool used to convert addresses into file names and line numbers

llvm-ar

is the LLVM archiver

llvm-as

is the LLVM assembler

llvm-bcanalyzer

is the LLVM bitcode analyzer

llvm-bitcode-strip

strips LLVM bitcode from an object

llvm-cat

is a tool to concatenate llvm modules

llvm-cfi-verify

identifies whether Control Flow Integrity protects all indirect control flow instructions in the provided object file, DSO, or binary

llvm-config

Prints LLVM compilation options

llvm-cov

is used to emit coverage information

llvm-c-test

is a bytecode disassembler

llvm-cvtres

is a tool to convert Microsoft resource files to COFF

llvm-cxxdump

is used as a C++ ABI Data Dumper

llvm-cxxfilt

is used to demangle C++ symbols in llvm code

llvm-cxxmap

is used to remap C++ mangled symbols

llvm-debuginfo-analyzer

prints a logical representation of low-level debug information

llvm-debuginfod

is a service providing debug information over an HTTP API for analyzing stripped binaries

llvm-debuginfod-find

is an interface to the llvm-debuginfod daemon for finding debuginfod artifacts

llvm-diff

is the LLVM structural 'diff'

llvm-dis

is the LLVM disassembler

llvm-dwarfdump

prints the content of DWARF sections in object files

llvm-dwarfutil

is a tool to copy and manipulate debug info

llvm-dwp

merges split DWARF files

llvm-elfabi

is used to read information about an ELF binary's ABI

llvm-exegesis

is a benchmarking tool that uses information available in LLVM to measure host machine instruction characteristics like latency or port decomposition

llvm-extract

is used to extract a function from an LLVM module

llvm-gsymutil

is used to process GSYM Symbolication Format files which convert memory addresses to function name and source file line. These files are smaller than DWARF or Breakpad files

llvm-ifs

is used to merge interface stubs with object files

llvm-install-name-tool

is used to rewrite load commands into MachO binary format

llvm-jitlink

is used to parse relocatable object files to make their contents executable in a target process

llvm-libtool-darwin

provides basic libtool functionality on Darwin-based systems. This is mostly useful if you are generating binaries for macOS systems

llvm-link

is the LLVM linker

llvm-lipo

is used to create universal binaries from MachO files

llvm-lto

is the LLVM LTO (link time optimization) linker

llvm-lto2

is a test harness for the resolution based LTO interface

llvm-mc

is a standalone machine code assembler/disassembler

llvm-mca

is a performance analysis tool to statically measure the performance of machine code

llvm-ml

is a playground for machine code provided by LLVM

llvm-modextract

is a tool to extract one module from multimodule bitcode files

llvm-mt

is a tool to generate signed files and catalogs from a side-by-side assembly manifest (used for Microsoft SDK)

llvm-nm

is used to list LLVM bitcode and object file's symbol table

llvm-objcopy

is LLVM's version of an objcopy tool

llvm-objdump

is an LLVM object file dumper

llvm-opt-report

is a tool to generate an optimization report from YAML optimization record files

llvm-pdbutil

is a PDB (Program Database) dumper. PDB is a Microsoft format

llvm-profdata

is a small tool to manipulate and print profile data files

llvm-profgen

generates LLVM SPGO profiling information

llvm-ranlib

is used to generate an index for a LLVM archive

llvm-rc

is a platform-independent tool to compile resource scripts into binary resource files

llvm-readobj

displays low-level format-specific information about object files

llvm-reduce

is used to automatically reduce testcases when running a test suite

llvm-remark-size-diff

reports the difference in instruction count and stack size remarks between two remark files

llvm-remarkutil

converts remark files between bitstream and YAML; or prints function instruction count information in remark files

llvm-rtdyld

is the LLVM MC-JIT tool

llvm-size

is the LLVM object size dumper

llvm-split

is the LLVM module splitter

llvm-stress

is used to generate random .ll files

llvm-strings

print strings found in a binary (object file, executable, or archive library)

llvm-symbolizer

converts addresses into source code locations

llvm-tblgen

is the LLVM Target Description To C++ Code Generator

llvm-tli-checker

is the LLVM TargetLibraryInfo versus SDK checker

llvm-undname

is a tool to demangle names

llvm-xray

is an implementation of Google's XRay function call tracing system

nvptx-arch

lists NVIDIA GPUs installed; at runtime it needs libcuda.so which is not a part of BLFS

opt

is the LLVM optimizer

sancov

is the sanitizer coverage processing tool

sanstats

is the sanitizer statistics processing tool

scan-build

is a Perl script that invokes the Clang static analyzer

scan-build-py

is a Python script that invokes the Clang static analyzer

scan-view

is a viewer for Clang static analyzer results

split-file

splits an input file into multiple parts separated by regex

verify-uselistorder

is the LLVM tool to verify use-list order

Lua-5.4.6

Introduction to Lua

Lua is a powerful light-weight programming language designed for extending applications. It is also frequently used as a general-purpose, stand-alone language. Lua is implemented as a small library of C functions, written in ANSI C, and compiles unmodified in all known platforms. The implementation goals are simplicity, efficiency, portability, and low embedding cost. The result is a fast language engine with small footprint, making it ideal in embedded systems too.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://www.lua.org/ftp/lua-5.4.6.tar.gz

  • Download MD5 sum: 25a429319dff20dfbfb9956c2b5be911

  • Download size: 356 KB

  • Estimated disk space required: 3.8 MB (with Basic tests)

  • Estimated build time: less than 0.1 SBU (with Basic tests)

Additional Downloads

Installation of Lua

Some packages check for the pkg-config file for Lua, which is created with:

cat > lua.pc << "EOF"
V=5.4
R=5.4.6

prefix=/usr
INSTALL_BIN=${prefix}/bin
INSTALL_INC=${prefix}/include
INSTALL_LIB=${prefix}/lib
INSTALL_MAN=${prefix}/share/man/man1
INSTALL_LMOD=${prefix}/share/lua/${V}
INSTALL_CMOD=${prefix}/lib/lua/${V}
exec_prefix=${prefix}
libdir=${exec_prefix}/lib
includedir=${prefix}/include

Name: Lua
Description: An Extensible Extension Language
Version: ${R}
Requires:
Libs: -L${libdir} -llua -lm -ldl
Cflags: -I${includedir}
EOF

Install Lua by running the following commands:

patch -Np1 -i ../lua-5.4.6-shared_library-1.patch &&
make linux

To test the results, issue: make test. This will run the interpreter and print its version. More comprehensive tests can be performed if you downloaded the "Test suite" tarball. Those tests need to be executed after the package is installed, thus we defer to the description below.

Now, as the root user:

make INSTALL_TOP=/usr                \
     INSTALL_DATA="cp -d"            \
     INSTALL_MAN=/usr/share/man/man1 \
     TO_LIB="liblua.so liblua.so.5.4 liblua.so.5.4.6" \
     install &&

mkdir -pv                      /usr/share/doc/lua-5.4.6 &&
cp -v doc/*.{html,css,gif,png} /usr/share/doc/lua-5.4.6 &&

install -v -m644 -D lua.pc /usr/lib/pkgconfig/lua.pc

Here we describe only the "Basic tests". Untar the tarball and change to the lua-5.4.6-tests directory, then issue lua -e "_U=true" all.lua. If the tests finish without error, you will see a message containing the string "final OK".

Contents

Installed Programs: lua and luac
Installed Library: liblua.so
Installed Directories: /usr/{lib,share}/lua and /usr/share/doc/lua-5.4.6

Short Descriptions

lua

is the standalone Lua interpreter

luac

is the Lua compiler

liblua.so

contains the Lua API functions

Lua-5.2.4

Introduction to Lua 5.2

Lua is a powerful light-weight programming language designed for extending applications. It is also frequently used as a general-purpose, stand-alone language. Lua is implemented as a small library of C functions, written in ANSI C, and compiles unmodified in all known platforms. The implementation goals are simplicity, efficiency, portability, and low embedding cost. The result is a fast language engine with small footprint, making it ideal in embedded systems too.

This is an older version of Lua needed only for compatibility with other programs such as Wireshark-4.0.7 and VLC-3.0.18.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://www.lua.org/ftp/lua-5.2.4.tar.gz

  • Download MD5 sum: 913fdb32207046b273fdb17aad70be13

  • Download size: 248 KB

  • Estimated disk space required: 3.6 MB

  • Estimated build time: less than 0.1 SBU

Additional Downloads

Installation of Lua 5.2

Some packages check for the pkg-config file for Lua, which is created with:

cat > lua.pc << "EOF"
V=5.2
R=5.2.4

prefix=/usr
INSTALL_BIN=${prefix}/bin
INSTALL_INC=${prefix}/include/lua5.2
INSTALL_LIB=${prefix}/lib
INSTALL_MAN=${prefix}/share/man/man1
INSTALL_LMOD=${prefix}/share/lua/${V}
INSTALL_CMOD=${prefix}/lib/lua/${V}
exec_prefix=${prefix}
libdir=${exec_prefix}/lib
includedir=${prefix}/include/lua5.2

Name: Lua
Description: An Extensible Extension Language
Version: ${R}
Requires:
Libs: -L${libdir} -llua5.2 -lm -ldl
Cflags: -I${includedir}
EOF

Install Lua by running the following commands:

patch -Np1 -i ../lua-5.2.4-shared_library-1.patch &&

sed -i '/#define LUA_ROOT/s:/usr/local/:/usr/:' src/luaconf.h &&

sed -r -e '/^LUA_(SO|A|T)=/ s/lua/lua5.2/' \
       -e '/^LUAC_T=/ s/luac/luac5.2/'     \
       -i src/Makefile &&

make MYCFLAGS="-fPIC" linux

The installation of this package is complex, so we will use the DESTDIR method of installation:

make TO_BIN='lua5.2 luac5.2'                     \
     TO_LIB="liblua5.2.so liblua5.2.so.5.2 liblua5.2.so.5.2.4" \
     INSTALL_DATA="cp -d"                        \
     INSTALL_TOP=$PWD/install/usr                \
     INSTALL_INC=$PWD/install/usr/include/lua5.2 \
     INSTALL_MAN=$PWD/install/usr/share/man/man1 \
     install &&

install -Dm644 lua.pc install/usr/lib/pkgconfig/lua52.pc &&

mkdir -pv install/usr/share/doc/lua-5.2.4 &&
cp -v doc/*.{html,css,gif,png} install/usr/share/doc/lua-5.2.4 &&

ln -s liblua5.2.so install/usr/lib/liblua.so.5.2   &&
ln -s liblua5.2.so install/usr/lib/liblua.so.5.2.4 &&

mv install/usr/share/man/man1/{lua.1,lua5.2.1} &&
mv install/usr/share/man/man1/{luac.1,luac5.2.1}

Now, as the root user:

chown -R root:root install  &&
cp -a install/* /

Command Explanations

sed -i ... src/luaconf.h: This command changes the Lua search path to match the install path.

sed -i ... src/Makefile: This command deconflicts this installation with the latest version of lua.

Contents

Installed Programs: lua5.2 and luac5.2
Installed Library: liblua5.2.so
Installed Directories: /usr/include/lua5.2, /usr/lib/lua/5.2, /usr/share/doc/lua-5.2.4, and /usr/share/lua/5.2

Short Descriptions

lua5.2

is the standalone Lua version 5.2 interpreter

luac5.2

is the Lua version 5.2 compiler

liblua5.2.so

contains the Lua version 5.2 API functions

Mercurial-6.5.1

Introduction to Mercurial

Mercurial is a distributed source control management tool similar to Git and Bazaar. Mercurial is written in Python and is used by projects such as Mozilla for Firefox and Thunderbird.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://www.mercurial-scm.org/release/mercurial-6.5.1.tar.gz

  • Download MD5 sum: fccff6981f362466b8e9e0fa0de0ddb6

  • Download size: 7.9 MB

  • Estimated disk space required: 115 MB (with docs, add 1.5 GB for tests)

  • Estimated build time: 0.3 SBU (with docs; add 30 SBU for tests; both using parallelism=4)

Mercurial Dependencies

Optional

docutils-0.20.1 (required to build the documentation), git-2.41.0, GPGME-1.21.0 (with Python bindings), OpenSSH-9.4p1 (runtime, to access ssh://... repositories), Pygments-2.16.1, rustc-1.71.1 (see rust/README.rst and rust/rhg/README.md), Subversion-1.14.2 (with Python bindings), Bazaar, CVS, pyflakes, pyOpenSSL, and re2

Installation of Mercurial

Build Mercurial by issuing the following command:

make build

To build the documentation (requires docutils-0.20.1), issue:

make doc

If you wish to run the tests, the rust tests must be removed as they are currently broken due to syntax errors. To do this, issue:

sed -i '138,142d' Makefile

To run the test suite, issue:

TESTFLAGS="-j<N> --tmpdir tmp" make check

where <N> is an integer between one and the number of ( processor X threads ), inclusive. Several tests fail because some error messages have changed in Python or some deprecation warnings are printed that were not present when the test was designed. In order to investigate any apparently failing tests, you may use the run-tests.py script. To see the almost forty switches, some of them very useful, issue tests/run-tests.py --help. Running the following commands, you will execute only the tests that failed before:

pushd tests  &&
  rm -rf tmp &&
  ./run-tests.py --tmpdir tmp test-gpg.t
popd

Normally, the previous failures will be reproducible. However, if you add the switch --debug before --tmpdir, and run the tests again, some failures may disappear, which is a problem with the test suite. If this happens, there will be no more of these failures even if you do not pass the --debug switch again.

An interesting switch is --time, which will generate a table of all the executed tests and their respective start, end, user, system and real times once the tests are complete. Note that these switches may be used with make check by including them in the TESTFLAGS environment variable.

Install Mercurial by running the following command (as root):

make PREFIX=/usr install-bin

If you built the documentation, install it by running the following command (as root):

make PREFIX=/usr install-doc

After installation, two very quick and simple tests should run correctly. The first one needs some configuration:

cat >> ~/.hgrc << "EOF"
[ui]
username = <user_name> <user@mail>
EOF

where you must replace <user_name> and <your@mail> (mail is optional and can be omitted). With the user identity defined, run hg debuginstall and several lines will be displayed, the last one reading "no problems detected". Another quick and simple test is just hg, which should output basic commands that can be used with hg.

Configuring Mercurial

Config Files

/etc/mercurial/hgrc and ~/.hgrc

The great majority of extensions are disabled by default. Run hg help extensions if you need to enable any, e.g. when investigating test failures. This will output a list of enabled and disabled extensions, as well as more information such as how to enable or disable extensions using configuration files.

If you have installed make-ca-1.12 and want Mercurial to use the certificates, as the root user, issue:

install -v -d -m755 /etc/mercurial &&
cat > /etc/mercurial/hgrc << "EOF"
[web]
cacerts = /etc/pki/tls/certs/ca-bundle.crt
EOF

Contents

Installed Programs: hg
Installed Libraries: several internal modules under /usr/lib/python3.11/site-packages/mercurial
Installed Directories: /etc/mercurial, /usr/lib/python3.11/site-packages/hgdemandimport, /usr/lib/python3.11/site-packages/hgext, /usr/lib/python3.11/site-packages/hgext3rd, /usr/lib/python3.11/site-packages/mercurial, and /usr/lib/python3.11/site-packages/mercurial-6.5.1-py3.11.egg-info

Short Descriptions

hg

is the mercurial version control system

NASM-2.16.01

Introduction to NASM

NASM (Netwide Assembler) is an 80x86 assembler designed for portability and modularity. It includes a disassembler as well.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

NASM Dependencies

Optional (for generating documentation):

asciidoc-10.2.0 and xmlto-0.0.28

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/nasm

Installation of NASM

If you downloaded the optional documentation, put it into the source tree:

tar -xf ../nasm-2.16.01-xdoc.tar.xz --strip-components=1

Install NASM by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

If you downloaded the optional documentation, install it with the following instructions as the root user:

install -m755 -d         /usr/share/doc/nasm-2.16.01/html  &&
cp -v doc/html/*.html    /usr/share/doc/nasm-2.16.01/html  &&
cp -v doc/*.{txt,ps,pdf} /usr/share/doc/nasm-2.16.01

Contents

Installed Programs: nasm and ndisasm
Installed Libraries: None
Installed Directory: /usr/share/doc/nasm-2.16.01

Short Descriptions

nasm

is a portable 80x86 assembler

ndisasm

is an 80x86 binary file disassembler

Patchelf-0.17.2

Introduction to Patchelf

The patchelf package contains a small utility to modify the dynamic linker and RPATH of ELF executables.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Patchelf

Install patchelf by running the following commands:

./configure --prefix=/usr \
            --docdir=/usr/share/doc/patchelf-0.17.2 &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Contents

Installed Program: patchelf

Short Descriptions

patchelf

is a simple utility for modifying existing ELF executables and libraries; it can change the dynamic loader ("ELF interpreter") of executables and change the RPATH of executables and libraries.

Perl Modules

Introduction to Perl Modules

The Perl module packages (also referred to as Distributions, because each can contain multiple modules) add useful objects to the Perl language. The packages listed on this page are required or recommended for other packages in the book. If they have dependent modules, those are either on this page or else on the next page (Perl Module Dependencies).

In many cases, only the required or recommended dependencies are listed - there might be other modules which allow more tests to be run, but omitting them will still allow the tests to PASS.

For a few modules, the BLFS editors have determined that other modules still listed as prerequisites are not required, and omitted them.

Where an alphabetically-earlier dependency of the same module pulls in a dependency, it is not mentioned for the later dependencies of the same module. You should build the listed dependencies in order.

It is generally worth running the tests for perl modules, they often can show problems such as missing dependencies which are required to use the module. Here, the editors have attempted to separate those dependencies which are only required for running test suites, but they will not be mentioned for a module where one of its dependencies uses that module for its own test suite. That is to say, if you intend to run the test suites, please run them for each dependency of the module.

It is possible to automatically install the current versions of a module and all missing or too-old dependencies recommended by upstream using CPAN. See CPAN automated install of perl modules at the end of this page.

Most of these modules only install files below /usr/lib/perl5/site_perl/5.xx.y and those will not be documented. One or two install programs (mostly, perl scripts), or a library, into /usr/bin/ or /usr/lib/ and these are documented.

Archive::Zip-1.68

Introduction to Archive::Zip

The Archive::Zip module allows a Perl program to create, manipulate, read, and write Zip archive files.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Archive::Zip Dependencies
Recommended (for the test suite)

UnZip-6.0 (with its patch)

Installation of Archive::Zip

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Contents

Installed Programs: crc32

Short Descriptions

crc32

computes and prints to stdout the CRC-32 values of the given files

autovivification-0.18

Introduction to the autovivification module

This module allows you disable autovivification (the automatic creation and population of new arrays and hashes whenever undefined variables are dereferenced), and optionally throw a warning or an error when it would have occurred.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of autovivification

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Business::ISBN-3.008

Introduction to Business::ISBN

The Business::ISBN module provides functions for working with International Standard Book Numbers.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Business::ISBN Dependencies
Required

Business-ISBN-Data-20230426.001

Installation of Business::ISBN

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Business::ISMN-1.203

Introduction to Business::ISMN

The Business::ISMN module is for work with International Standard Music Numbers.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Business::ISMN Dependencies
Required

Tie-Cycle-1.227

Installation of Business::ISMN

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Business::ISSN-1.005

Introduction to Business::ISSN

The Business::ISSN module is for work with International Standard Serial Numbers.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Business::ISSN

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Class::Accessor-0.51

Introduction to Class::Accessor

Class::Accessor generates accessors/mutators for your class.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Class::Accessor

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Data::Compare-1.29

Introduction to Data::Compare

The Data::Compare module compares two perl data structures.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Data::Compare Dependencies
Required

Clone-0.46, File-Find-Rule-0.34

Installation of Data::Compare

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Data::Dump-1.25

Introduction to Data::Dump

Data::Dump provides pretty printing of data structures.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Data::Dump

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Data::Uniqid-0.12

Introduction to Data::Uniqid

Data::Uniqid provides three simple routines for generating unique IDs.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Data::Uniqid

Although the final test fails and reports an Error, the test suite returns a status of 0. The error can safely be ignored.

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

DateTime::Calendar::Julian-0.107

Introduction to DateTime::Calendar::Julian

DateTime::Calendar::Julian implements the Julian Calendar.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
DateTime::Calendar::Julian Dependencies
Required

DateTime-1.59

Installation of DateTime::Calendar::Julian

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

DateTime::Format::Builder-0.83

Introduction to DateTime::Format::Builder

DateTime::Format::Builder created DateTime parser classes and objects.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
DateTime::Format::Builder Dependencies
Required

DateTime-Format-Strptime-1.79 and Params-Validate-1.31

Installation of DateTime::Format::Builder

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Encode::EUCJPASCII-0.03

Introduction to Encode::EUCJPASCII

Encode::EUCJPASCII provides an eucJP-open (Extended Unix Code, Japanese) mapping.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Encode::EUCJPASCII

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Encode::HanExtra-0.23

Introduction to Encode::HanExtra

The Encode::HanExtra module provides extra sets of Chinese Encodings which are not included in the core Encode module because of size issues.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Encode::HanExtra

This module uses the 'unsafe' build and installation instructions (In perl-5.26.0 the use of the current directory in @INC was removed for security reasons and this module has not been updated) :

PERL_USE_UNSAFE_INC=1 perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Encode::JIS2K-0.03

Introduction to Encode::JIS2K

The Encode::JIS2K module provides JIS X 0212 (aka JIS 2000) Encodings.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Encode::JIS2K

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

File::Slurper-0.014

Introduction to File::Slurper

File::Slurper is a simple, sane and efficient module to slurp a file.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
File::Slurper Dependencies
Recommended (required for the test suite)

Installation of File::Slurper

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

File::Which-1.27

Introduction to File::Which

File::Which provides a portable implementation of the 'which' utility.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of File::Which

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

HTML::Parser-3.81

Introduction to HTML::Parser

The HTML::Parser distribution is a collection of modules that parse and extract information from HTML documents.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
HTML::Parser Dependencies
Required

HTML-Tagset-3.20

Required (runtime)

HTTP-Message-6.44 (its module HTTP::Headers is a run-time requirement for HTML::HeadParser from this distribution).

Installation of HTML::Parser

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

HTTP::Daemon-6.16

Introduction to HTTP::Daemon

Instances of the HTTP::Daemon class are HTTP/1.1 servers that listen on a socket for incoming requests. The HTTP::Daemon is a subclass of IO::Socket::INET, so you can perform socket operations directly on it too.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
HTTP::Daemon Dependencies
Required

HTTP-Message-6.44

Note

Makefile.PL and running the tests will complain that Module::Build::Tiny is missing, but that is only needed for Build.PL which is used if the system lacks a C compiler.

Installation of HTTP::Daemon

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

IO::Socket::SSL-2.083

Introduction to IO::Socket::SSL

IO::Socket::SSL makes using SSL/TLS much easier by wrapping the necessary functionality into the familiar IO::Socket interface and providing secure defaults whenever possible.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
IO::Socket::SSL Dependencies
Required

make-ca-1.12 and Net-SSLeay-1.92

Recommended

Installation of IO::Socket::SSL

This module uses a variant of the standard build and installation instructions:

yes | perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Command Explanations

yes: Perl will ask if you wish to run external tests, which will 'fail soft' if there are network problems. The default is 'y', this allows you to script the build.

IO::String-1.08

Introduction to IO::String

IO::String - Emulate file interface for in-core strings.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of IO::String

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

IPC::Run3-0.048

Introduction to IPC::Run3

IPC::Run3 is used to run a subprocess with input/output redirection.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of IPC::Run3

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

JSON-4.10

Introduction to JSON

JSON provides a simple wrapper for JSON::XS-compatible modules with some additional features.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of JSON

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Lingua::Translit-0.29

Introduction to Lingua::Translit

Lingua::Translit and its translit program transliterate text between writing systems.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Lingua::Translit

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Contents

Installed Programs: translit

Short Descriptions

translit

transliterates text between writing systems using various standards

LWP (libwww-perl-6.72)

Introduction to LWP - The World-wide Web library for Perl

The libwww-perl collection is a set of Perl modules which provides a simple and consistent application programming interface (API) to the World-Wide Web. The main focus of the library is to provide classes and functions that allow you to write WWW clients. The library also contains modules that are of more general use and even classes that help you implement simple HTTP servers.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
libwww-perl Dependencies
Required

File-Listing-6.15, HTTP-CookieJar-0.014, HTTP-Cookies-6.10, HTTP-Daemon-6.16, HTTP-Negotiate-6.01, HTML-Parser-3.81, Net-HTTP-6.23, Try-Tiny-0.31 and WWW-RobotRules-6.02

Recommended (required for the test suite)

Installation of libwww-perl

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

After installing this package, if you want HTTPS protocol support install LWP-Protocol-https-6.11.

Contents

Installed Programs: lwp-download, lwp-dump, lwp-mirror, lwp-request

Short Descriptions

lwp-download

is a script to fetch a large file from the web

lwp-dump

is used to see what headers and content is returned for a URL

lwp-mirror

is a simple mirror utility

lwp-request

is a simple command line user agent

List::AllUtils-0.19

Introduction to List::AllUtils

The List::Allutils module combines List::Util and List::MoreUtils in one bite-sized package.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
List::AllUtils Dependencies
Required

List-SomeUtils-0.59, List-UtilsBy-0.12

Installation of List::AllUtils

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

List::MoreUtils-0.430

Introduction to List::MoreUtils

List::MoreUtils provides the stuff missing in List::Util.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
List::MoreUtils Dependencies
Required

Exporter-Tiny-1.006000 and List-MoreUtils-XS-0.430

Installation of List::MoreUtils

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Log::Log4perl-1.57

Introduction to Log::Log4perl

Log::Log4perl provides a Log4j implementation for perl.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Log::Log4perl

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Contents

Installed Programs: l4p-templ

Short Descriptions

l4p-templ

prints out the text of a template Log4perl configuration for starting a new Log4perl configuration file

LWP::Protocol::https-6.11

Introduction to LWP::Protocol::https

LWP::Protocol::https provides https support for LWP::UserAgent (i.e. libwww-perl-6.72). Once the module is installed LWP is able to access sites using HTTP over SSL/TLS.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
LWP::Protocol::https Dependencies
Required

IO-Socket-SSL-2.083, libwww-perl-6.72 and make-ca-1.12 with /etc/pki/tls/certs/ca-bundle.crt.

Installation of LWP::Protocol::https

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Module::Build-0.4232

Introduction to Module::Build

Module::Build allows perl modules to be built without a make command being present.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Module::Build

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Note that this module can also be built using Build.PL

Contents

Installed Programs: config_data

Short Descriptions

config_data

is used to query or change the configuration of perl modules

Net::DNS-1.39

Introduction to Net::DNS

Net::DNS is a DNS resolver implemented in Perl. It can be used to perform nearly any type of DNS query from a Perl script.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Net::DNS

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Parse::RecDescent-1.967015

Introduction to Parse::RecDescent

Parse::RecDescent incrementally generates top-down recursive-descent text parsers from simple yacc-like grammar specifications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Parse::RecDescent

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Parse::Yapp-1.21

Introduction to Parse::Yapp

Parse::Yapp is a Perl extension for generating and using LALR parsers.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Parse::Yapp

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Contents

Installed Programs: yapp

Short Descriptions

yapp

is a frontend to the Parse::Yapp module, which lets you create a Perl OO parser from an input grammar file

PerlIO::utf8_strict-0.010

Introduction to PerlIO::utf8_strict

PerlIO::utf8_strict provides a fast and correct UTF-8 PerlIO layer. Unlike Perl's default :utf8 layer it checks the input for correctness.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
PerlIO::utf8_strict Dependencies
Recommended (required for the test suite)

Installation of PerlIO::utf8_strict

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Regexp::Common-2017060201

Introduction to Regexp::Common

Regexp::Common provides commonly requested regular expressions.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Regexp::Common

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

SGMLSpm-1.1

Introduction to SGMLSpm

The SGMLSpm module is a Perl library used for parsing the output from James Clark's SGMLS and NSGMLS parsers.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of SGMLSpm

Before beginning the build, issue the following command to prevent an error:

chmod -v 644 MYMETA.yml

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

After the package has been installed, run the following command as the root user:

ln -sv sgmlspl.pl /usr/bin/sgmlspl

Contents

Installed Programs: sgmlspl.pl, sgmlspl

Short Descriptions

sgmlspl.pl

is an SGML processor

sgmlspl

is a symbolic link used during the install of DocBook-utils-0.6.14

Sort::Key-1.33

Introduction to Sort::Key

Sort::Key provides a set of functions to sort lists of values by some calculated key value.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Sort::Key

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Test::Command-0.11

Introduction to Test::Command

Test::Command tests the exit status, STDOUT, or STDERR, of an external command.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Test::Command

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Test::Differences-0.70

Introduction to Test::Differences

Test::Differences tests strings and data structures and shows the differences if they do not match.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Test::Differences Dependencies
Required

Text-Diff-1.45

Recommended (required for the test suite)

Installation of Test::Differences

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Text::BibTeX-0.89

Introduction to Text::BibTeX

Text::BibTeX provides an interface to read and parse BibTeX files.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Text::BibTeX Dependencies
Required

Config-AutoConf-0.320, ExtUtils-LibBuilder-0.08

Installation of Text::BibTeX

This module is built using Build.PL:

perl Build.PL &&
./Build       &&
./Build test

Now, as the root user:

./Build install

Contents

Installed Programs: biblex, libparse, dumpnames
Installed Libraries: libtparse.so

Short Descriptions

biblex

performs lexical analysis on a BibTeX file

bibparse

parses a series of BibTeX files with command line options to control the string post-processing behavior

dumpnames

parses a BibTeX file, splitting 'author' and 'editor' fields into lists of names, and then dumps everything to stdout

libbtparse.so

is a library for parsing and processing BibTeX data files

Text::CSV-2.03

Introduction to Text::CSV

Text::CSV is a comma-separated values manipulator, using XS (eXternal Subroutine - for subroutines written in C or C++) or pure perl.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Text::CSV Dependencies
Recommended

Installation of Text::CSV

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Text::Roman-3.5

Introduction to Text::Roman

Text::Roman allows conversion between Roman and Arabic algorisms (number systems, e.g. MCMXLV and 1945).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Text::Roman

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Unicode::Collate-1.31

Introduction to Unicode::Collate

Unicode::Collate provides a Unicode collation algorithm.

Note

This is a core module. If you are using perl-5.28.0 or later, its version is good enough for biber-2.19 and you do not need to reinstall this module.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Unicode::Collate

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Unicode::LineBreak-2019.001

Introduction to Unicode::LineBreak

Unicode::LineBreak provides a UAX #14 Unicode Line Breaking Algorithm.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Unicode::LineBreak Dependencies
Required

MIME-Charset-1.013.1, also Wget-1.21.4 (to download two files from unicode.org in the test suite)

Optional

Installation of Unicode::LineBreak

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

URI-5.17

Introduction to URI

This module implements the URI class. Objects of this class represent "Uniform Resource Identifier references" as specified in RFC 2396 (and updated by RFC 2732). A Uniform Resource Identifier is a compact string of characters that identifies an abstract or physical resource. A Uniform Resource Identifier can be further classified as either a Uniform Resource Locator (URL) or a Uniform Resource Name (URN). The distinction between URL and URN does not matter to the URI class interface. A "URI-reference" is a URI that may have additional information attached in the form of a fragment identifier.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
URI Dependencies
Recommended (required for the test suite)
Optional

Business-ISBN-3.008

Installation of URI

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

XML::LibXML::Simple-1.01

Introduction to XML::LibXML::Simple

The XML::LibXML::Simple module is a rewrite of XML::Simple to use the XML::LibXML parser for XML structures, instead of the plain Perl or SAX parsers.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
XML::LibXML::Simple Dependencies
Required

XML-LibXML-2.0208

Installation of XML::LibXML::Simple

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

XML::LibXSLT-2.002001

Introduction to XML::LibXSLT

XML-LibXSLT provides an interface to libxslt-1.1.38

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
XML::LibXSLT Dependencies
Required

libxslt-1.1.38, XML-LibXML-2.0208

Installation of XML::LibXSLT

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

XML::Simple-2.25

Introduction to XML::Simple

XML::Simple provides an easy API to read and write XML (especially config files). It is deprecated and its use is discouraged.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
XML::Simple Dependencies
Optional

XML-SAX-1.02 (for an alternative parser which will be used if available, otherwise XML::Parser which was installed in LFS will be used),

Installation of XML::Simple

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

XML::Writer-0.900

Introduction to XML::Writer

XML::Writer provides a Perl extension for writing XML documents.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of XML::Writer

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

CPAN automated install of perl modules

Automatic Installation of Perl Modules.

There is an alternate way of installing the modules using the cpan shell install command. The command automatically downloads the latest source from the CPAN archive for the module and any missing prerequisite modules listed by upstream. Then for each module it extracts it, runs the compilation, the tests and installs it.

You still need to install any non-perl dependencies before running the automated installation method. You may wish to clean out the build/ directory after installing, to free up the space. If any post-install actions such as creating a symlink are mentioned, you should also do those.

The first time you run cpan, you'll be prompted to enter some information regarding download locations and methods. This information is retained in files located in ~/.cpan.

In particular, you may wish to configure it so that Sudo-1.9.14p3 is used for the installs, allowing you to build and test as a regular user. The following examples have not used that approach.

Start the cpan shell by issuing 'cpan' as the root user. Any module may now be installed from the cpan>  prompt with the command:

install <Module::Name>

For additional commands and help, issue 'help' from the cpan>  prompt.

Alternatively, for scripted or non-interactive installations, use the following syntax as the root user to install one or more modules:

cpan -i <Module1::Name> <Module2::Name>

Review the cpan.1 man page for additional parameters you can pass to cpan on the command line.

Perl Module Dependencies

Perl Modules which are only required by other modules

The modules on the previous page are referenced from other pages in BLFS, but these modules are only in the book as dependencies of those modules. If you use the CPAN install method, you do not need to read this page.

The BLFS editors pay much less attention to these modules, and the versions will not be regularly reviewed. In all cases, only the required or recommended dependencies are listed - there might be other modules which allow more tests to be run, but omitting them will still allow the tests to PASS.

Note

The links on this page (to metacpan.org) should go to "known good" versions, for which their dependencies are correct. If you wish to use a later version, please check the Changes file at https://metacpan.org - sometimes added dependencies are listed, other times not. Some of these modules have very frequent updates, often bringing different dependencies. The linked metacpan.org versions below were known to work with the the module versions in BLFS when last reviewed.

However, if you notice that the Changes file for a newer version than is in the current development book reports a fix for a security issue, please report this to either the blfs-dev or the blfs-support list.

Similarly, if you discover that an updated module on the previous page needs an extra dependency, please report this.

Algorithm::Diff-1.201

Introduction to Algorithm::Diff

Algorithm::Diff computes 'intelligent' differences between two files or lists.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Algorithm::Diff

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Alien::Build-2.77

Introduction to Alien::Build

Alien::Build provides tools for building external (non-CPAN) dependencies for CPAN.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Alien::Build Dependencies
Required

Capture-Tiny-0.48, File-Which-1.27, FFI-CheckLib-0.31 and File-chdir-0.1011

Installation of Alien::Build

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Alien::Build::Plugin::Download::GitLab-0.01

Introduction to Alien::Build::Plugin::Download::GitLab

Alien::Build::Plugin::Download::GitLab allows Alien::Build to download from GitLab (in practice, this does not download if the required library is already installed on the system).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Alien::Build::Plugin::Download::GitLab Dependencies
Required

Alien-Build-2.77 and URI-5.17

Installation of Alien::Build::Plugin::Download::GitLab

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Alien::Libxml2-0.19

Introduction to Alien::Libxml2

Alien::Libxml2 is designed to allow modules to install the C libxml2 library on your system. In BLFS, it uses pkg-config to find how to link to the installed libxml2-2.10.4.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Alien::Libxml2 Dependencies
Required

Alien-Build-Plugin-Download-GitLab-0.01, libxml2-2.10.4, Path-Tiny-0.144

Recommended (required for the test suite)

Installation of Alien::Libxml2

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

B::COW-0.007

Introduction to B::COW

B::COW provides additional helpers for the B core module to check Copy On Write.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of B::COW

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

B::Hooks::EndOfScope-0.26

Introduction to B::Hooks::EndOfScope

B::Hooks::EndOfScope allows you to execute code when perl finished compiling the surrounding scope.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
B::Hooks::EndOfScope Dependencies
Required

Module-Implementation-0.09, Sub-Exporter-Progressive-0.001013 and Variable-Magic-0.63

Recommended (required for the test suite)

Installation of B::Hooks::EndOfScope

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Business::ISBN::Data-20230426.001

Introduction to Business-ISBN-Data

Business-ISBN-Data is a data pack for Business::ISBN.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Business-ISBN-Data

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Capture::Tiny-0.48

Introduction to Capture::Tiny

The Capture::Tiny module captures STDOUT and STDERR from Perl, XS (eXternal Subroutine, i.e. written in C or C++) or external programs.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Capture::Tiny

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Class::Data::Inheritable-0.09

Introduction to Class::Data::Inheritable

Class::Data::Inheritable is for creating accessor/mutators to class data. That is, if you want to store something about your class as a whole (instead of about a single object).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Class::Data::Inheritable

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Class::Inspector-1.36

Introduction to Class::Inspector

Class::Inspector allows you to get information about a loaded class.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Class::Inspector

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Class::Singleton-1.6

Introduction to Class::Singleton

A Singleton describes an object class that can have only one instance in any system, such as a print spooler. This module implements a Singleton class from which other classes can be derived.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Class::Singleton

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Class:Tiny-1.008

Introduction to Class:Tiny

Class:Tiny offers a minimalist class construction kit.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Class:Tiny

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Clone-0.46

Introduction to Clone

Clone recursively copies perl datatypes.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Clone Dependencies
Recommended (required for the test suite)

Installation of Clone

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Config::AutoConf-0.320

Introduction to Config::AutoConf

The Config::AutoConf module implements some of the AutoConf macros (detecting a command, detecting a library, etc.) in pure perl.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Config::AutoConf Dependencies
Required

Capture-Tiny-0.48, File-Slurper-0.014

Installation of Config::AutoConf

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

CPAN::Meta::Check-0.017

Introduction to CPAN::Meta::Check

CPAN::Meta::Check verifies if requirements described in a CPAN::Meta object are present.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of CPAN::Meta::Check

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

DateTime-1.59

Introduction to DateTime

DateTime is a date and time object for perl.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
DateTime Dependencies
Required

DateTime-Locale-1.37, DateTime-TimeZone-2.57

Recommended (required for the test suite)

Installation of DateTime

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

DateTime::Format::Strptime-1.79

Introduction to DateTime::Format::Strptime

DateTime::Format::Strptime implements most of strptime(3), i.e. it takes a string and a pattern and returns a DateTime object.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
DateTime::Format::Strptime Dependencies
Required

DateTime-1.59

Installation of DateTime::Format::Strptime

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

DateTime::Locale-1.37

Introduction to DateTime::Locale

DateTime::Locale provides localization support for DateTime-1.59.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
DateTime::Locale Dependencies
Required

Dist-CheckConflicts-0.11, File-ShareDir-1.118, namespace-autoclean-0.29 and Params-ValidationCompiler-0.31

Recommended (required for the test suite)

Installation of DateTime::Locale

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

DateTime::TimeZone-2.57

Introduction to DateTime::TimeZone

This class is the base class for all time zone objects. A time zone is represented internally as a set of observances, each of which describes the offset from GMT for a given time period.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
DateTime::TimeZone Dependencies
Required

Class-Singleton-1.6, Module-Runtime-0.016, and Params-ValidationCompiler-0.31, also

Recommended (required for the test suite)

Installation of DateTime::TimeZone

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Devel::StackTrace-2.04

Introduction to Devel::StackTrace

Devel::StackTrace provides an object representing a stacvk trace.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Devel::StackTrace

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Dist::CheckConflicts-0.11

Introduction to Dist::CheckConflicts

Dist::CheckConflicts declares version conflicts for a distribution, to support post-install updates of dependent distributions.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Dist::CheckConflicts Dependencies
Required

Module-Runtime-0.016

Recommended (required for the test suite)

Installation of Dist::CheckConflicts

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Encode::Locale-1.05

Introduction to Encode::Locale

Encode::Locale determines the locale encoding.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Encode::Locale

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Eval::Closure-0.14

Introduction to Eval::Closure

Eval::Closure safely and cleanly creates closures via string eval.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Eval::Closure Dependencies
Recommended (required for the test suite)

Installation of Eval::Closure

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Exception::Class-1.45

Introduction to Exception::Class

Exception::Class allows you to declare real exception classes in Perl.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Exception::Class Dependencies
Required

Class-Data-Inheritable-0.09, Devel-StackTrace-2.04

Installation of Exception::Class

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Exporter::Tiny-1.006000

Introduction to Exporter::Tiny

Exporter::Tiny is an exporter with the features of Sub::Exporter but only core dependencies.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Exporter::Tiny

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

ExtUtils::LibBuilder-0.08

Introduction to ExtUtils::LibBuilder

ExtUtils::LibBuilder is a tool to build C libraries.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
ExtUtils::LibBuilder Dependencies
Required

Module-Build-0.4232

Installation of ExtUtils::LibBuilder

This module is built using Build.PL:

perl Build.PL &&
./Build       &&
./Build test

Now, as the root user:

./Build install

FFI::CheckLib-0.31

Introduction to FFI::CheckLib

FFI::CheckLib checks whether a particular dynamic library is available for FFI (Foreign Function Interface) to use.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
FFI::CheckLib Dependencies
Recommended (required for the test suite)

Installation of FFI::CheckLib

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

File::chdir-0.1011

Introduction to File::chdir

File::chdir provides a more sensible way to change directories.

Perl's chdir() has the unfortunate problem of being very, very, very global. If any part of your program calls chdir() or if any library you use calls chdir(), it changes the current working directory for the *whole* program. File::chdir gives you an alternative, $CWD and @CWD.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of File::chdir

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

File::Copy::Recursive-0.45

Introduction to File::Copy::Recursive

This module copies and moves directories recursively (or single files), to an optional depth and attempts to preserve each file or directory's mode.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
File::Copy::Recursive Dependencies
Recommended (required for the test suite)

Installation of File::Copy::Recursive

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

File::Find::Rule-0.34

Introduction to File::Find::Rule

File::Find::Rule is a friendlier interface to File::Find. It allows you to build rules which specify the desired files and directories.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
File::Find::Rule Dependencies
Required

Number-Compare-0.03, Text-Glob-0.11

Installation of File::Find::Rule

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Contents

Installed Programs: findrule

Short Descriptions

findrule

is a command line wrapper to File::Find::Rule

File::Listing-6.15

Introduction to File::Listing

File::Listing parses a directory listing.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
File::Listing Dependencies
Required

HTTP-Date-6.05,

Installation of File::Listing

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

File::ShareDir-1.118

Introduction to File::ShareDir

File::ShareDir allows you to access data files which have been installed by File::ShareDir::Install.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
File::ShareDir Dependencies
Required

Class-Inspector-1.36, File-ShareDir-Install-0.14

Installation of File::ShareDir

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

File::ShareDir::Install-0.14

Introduction to File::ShareDir::Install

File::ShareDir::Install allows you to install read-only data files from a distribution.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of File::ShareDir::Install

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

HTML::Tagset-3.20

Introduction to HTML::Tagset

HTML::Tagset provides several data tables useful in parsing HTML.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of HTML::Tagset

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

HTTP::CookieJar-0.014

Introduction to HTTP::CookieJar

HTTP::CookieJar provides a minimalist HTTP user agent cookie jar.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
HTTP::CookieJar Dependencies
Required

HTTP-Date-6.05

Recommended (required for the test suite)

Installation of HTTP::CookieJar

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

HTTP::Cookies-6.10

Introduction to HTTP::Cookies

HTTP::Cookies provides a class for objects that represent a "cookie jar" -- that is, a database of all the HTTP cookies that a given LWP::UserAgent (from libwww-perl-6.72) object knows about.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
HTTP::Cookies Dependencies
Required

HTTP-Message-6.44

Installation of HTTP::Cookies

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

HTTP::Date-6.05

Introduction to HTTP::Date

HTTP::Date provides functions to deal with the date formats used by the HTTP protocol and also with some other date formats.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
HTTP::Date Dependencies
Recommended

Installation of HTTP::Date

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

HTTP::Message-6.44

Introduction to HTTP::Message

HTTP::Message provides a base class for HTTP style message objects.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
HTTP::Message Dependencies
Required

Clone-0.46, Encode-Locale-1.05, HTTP-Date-6.05, IO-HTML-1.004, LWP-MediaTypes-6.04, and URI-5.17

Recommended (required for the test suite)

Installation of HTTP::Message

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

HTTP::Negotiate-6.01

Introduction to HTTP::Negotiate

HTTP::Negotiate provides a complete implementation of the HTTP content negotiation algorithm.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
HTTP::Negotiate Dependencies
Recommended (required for the test suite)

Installation of HTTP::Negotiate

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Importer-0.026

Introduction to Importer

Importer provides an alternative but compatible interface to modules that export symbols.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Importer

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

IO::HTML-1.004

Introduction to IO::HTML

IO::HTML opens an HTML file with automatic character set detection.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of IO::HTML

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

IPC::System::Simple-1.30

Introduction to IPC::System::Simple

IPC::System::Simple takes the hard work out of calling external commands and producing detailed diagnostics.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of IPC::System::Simple

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

List::MoreUtils::XS-0.430

Introduction to List::MoreUtils::XS

List::MoreUtils::XS is a compiled backend for List::MoreUtils

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of List::MoreUtils::XS

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

List::SomeUtils-0.59

Introduction to List::SomeUtils

List::SomeUtils provides the stuff missing in List::Util.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
List::SomeUtils Dependencies
Required

Module-Implementation-0.09, List-SomeUtils-XS-0.58

Installation of List::SomeUtils

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

List::SomeUtils::XS-0.58

Introduction to List::SomeUtils::XS

List::SomeUtils::XS is a (faster) XS (eXternal Subroutine) implementation for List::SomeUtils.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
List::SomeUtils::XS Dependencies
Recommended (required for the test suite)

Installation of List::SomeUtils::XS

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

List::UtilsBy-0.12

Introduction to List::UtilsBy

List::UtilsBy provides a number of higher-order list utility functions.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of List::UtilsBy

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

LWP::MediaTypes-6.04

Introduction to LWP::MediaTypes

LWP::MediaTypes guesses the media type (i.e. the MIME Type) for a file or URL.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
LWP::MediaTypes Dependencies
Recommended (required for the test suite)

Installation of LWP::MediaTypes

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

MIME::Charset-1.013.1

Introduction to MIME::Charset

MIME::Charset provides information about character sets used for MIME messages o nthe internet, such as their encodings.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
MIME::Charset Dependencies
Recommended

Installation of MIME::Charset

This module uses a variant of the standard build and installation instructions:

yes '' | perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Command Explanations

yes |: Perl will ask if you wish to install a further module for handling legacy Japanese encodings, and another which it would use for translating documentation to Japanese. The default option is 'n', using 'yes' allows you to script the build.

Module::Implementation-0.09

Introduction to Module::Implementation

Module::Implementation loads one of several alternate underlying implementations of a module (e.g. eXternal Subroutine or pure Perl, or an implementation for a given OS).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Module::Implementation Dependencies
Required

Module-Runtime-0.016, Try-Tiny-0.31

Recommended (required for the test suite)

Installation of Module::Implementation

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Module::Pluggable-5.2

Introduction to Module::Pluggable

Module::Pluggable provides a way of having 'plugins' for your module.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Module::Pluggable

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Module::Runtime-0.016

Introduction to Module::Runtime

Module::Runtime provides functions to deal with runtime handling of Perl modules.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Module::Runtime

Although Module::Build is still listed as a prerequisite, it is no-longer necessary on systems with a working make.

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

MRO::Compat-0.15

Introduction to MRO::Compat

The "mro" namespace provides several utilities for dealing with method resolution order and method caching in general in Perl 5.9.5 and higher. This module provides those interfaces for earlier versions of Perl.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of MRO::Compat

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

namespace::autoclean-0.29

Introduction to namespace::autoclean

This module is very similar to namespace::clean, except it will clean all imported functions, no matter if you imported them before or after you used the pragma. It will also not touch anything that looks like a method.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
namespace::autoclean Dependencies
Required

namespace-clean-0.27, Sub-Identify-0.14

Recommended (required for the test suite)

Installation of namespace::autoclean

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

namespace::clean-0.27

Introduction to namespace::clean

This package allows you to keep imports and functions out of your namespace.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
namespace::clean Dependencies
Required

B-Hooks-EndOfScope-0.26, Package-Stash-0.40

Installation of namespace::clean

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Net::HTTP-6.23

Introduction to Net::HTTP

The Net::HTTP class is a low level HTTP client. An instance of the class represents a connection to an HTTP server.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Net::HTTP Dependencies
Required

URI-5.17

Installation of Net::HTTP

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Net::SSLeay-1.92

Introduction to Net::SSLeay

Net::SSLeay is a Perl extension for using OpenSSL.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Net::SSLeay

Note

If enabling the external tests, one test in t/external/15_altnames.t may fail.

This module uses a variant of the standard build and installation instructions:

yes '' | perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Command Explanations

yes '': Perl will ask if you wish to run external tests, which will fail if you do not have network connectivity. The default is 'n', specifying this allows you to script the build.

Number::Compare-0.03

Introduction to Number::Compare

Number::Compare compiles a simple comparison to an anonymous subroutine, which you can call with a value to be tested against. It understands IEC standard magnitudes (k, ki, m, mi, g, gi).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Number::Compare

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Package::Stash-0.40

Introduction to Package::Stash

Manipulating stashes (Perl's symbol tables) is occasionally necessary, but incredibly messy, and easy to get wrong. This module hides all of that behind a simple API.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Package::Stash Dependencies
Required

Dist-CheckConflicts-0.11, Module-Implementation-0.09

Recommended (required for the test suite)

Installation of Package::Stash

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Params::Validate-1.31

Introduction to Params::Validate

Params::Validate allows you to validate method or function call parameters to an arbitrary level of specificity.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Params::Validate Dependencies
Required

Module-Build-0.4232, Module-Implementation-0.09

Recommended (required for the test suite)

Installation of Params::Validate

This module is built using Build.PL:

perl Build.PL &&
./Build       &&
./Build test

Now, as the root user:

./Build install

Params::ValidationCompiler-0.31

Introduction to Params::ValidationCompiler

Params::ValidationCompiler builds an optimized subroutine parameter validator.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Params::ValidationCompiler Dependencies
Required

Exception-Class-1.45, Specio-0.48

Recommended (required for the test suite)

Installation of Params::ValidationCompiler

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Path::Tiny-0.144

Introduction to Path::Tiny

Path::Tiny provides a small fast utility for working with file paths.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Path::Tiny

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Role::Tiny-2.002004

Introduction to Role::Tiny

Role::Tiny is a minimalist role composition tool.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Role::Tiny

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Scope::Guard-0.21

Introduction to Scope::Guard

Scope::Guard provides a convenient way to perform cleanup or other forms of resource management at the end of a scope.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Scope::Guard

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Specio-0.48

Introduction to Specio

Specio provides classes for representing type constraints and coercion, along with syntax sugar for declaring them.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Specio Dependencies
Required

Devel-StackTrace-2.04, Eval-Closure-0.14, Module-Runtime-0.016, Role-Tiny-2.002004, Sub-Quote-2.006008 and Try-Tiny-0.31

Recommended (required for the test suite)
Optional

namespace-autoclean-0.29 (for the test suite)

Installation of Specio

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Sub::Exporter::Progressive-0.001013

Introduction to Sub::Exporter::Progressive

Sub::Exporter::Progressive is a wrapper for Sub::Exporter.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Sub::Exporter::Progressive

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Sub::Identify-0.14

Introduction to Sub::Identify

Sub::Identify allows you to retrieve the real name of code references. It is encouraged to migrate to Sub::Util (a core module) when possible.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Sub::Identify

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Sub::Info-0.002

Introduction to Sub::Info

Sub::Info is a tool for inspecting subroutines.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Sub::Info Dependencies
Required

Importer-0.026

Installation of Sub::Info

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Sub::Quote-2.006008

Introduction to Sub::Quote

Sub::Quote provides ways to generate subroutines from strings.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Sub::Quote

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Sub::Uplevel-0.2800

Introduction to Sub::Uplevel

Sub::Uplevel allows you to fool a caller that it is running in a higher stack frame.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Sub::Uplevel

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Term::Table-0.016

Introduction to Term::Table

Term::Table formats a header and rows into a table. This is used by some failing tests to provide diagnostics about what has gone wrong.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Term::Table Dependencies
Required

Importer-0.026

Installation of Term::Table

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Test::Deep-1.204

Introduction to Test::Deep

Test::Deep gives you very flexible ways to check that the result you got is the result you were expecting.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Test::Deep

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Test::Exception-0.43

Introduction to Test::Exception

Test::Exception provides convenience methods for testing exception based code.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Test::Exception Dependencies
Required

Sub-Uplevel-0.2800

Installation of Test::Exception

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Test::Fatal-0.017

Introduction to Test::Fatal

The Test::Fatal module provides simple helpers for testing code which throws exceptions.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Test::Fatal Dependencies
Required

Try-Tiny-0.31

Installation of Test::Fatal

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Test::File-1.993

Introduction to Test::File

Test::File provides a collection of test utilities for file attributes.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Test::File Dependencies
Recommended (required for the test suite)

Installation of Test::File

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Test::File::ShareDir-1.001002

Introduction to Test::File::ShareDir

Test::File::ShareDir is some low level plumbing to enable a distribution to perform tests while consuming its own share directories in a manner similar to how they will be once installed. This allows File-ShareDir-1.118 to see the latest version of content instead of whatever is installed on the target system where you are testing.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Test::File::ShareDir Dependencies
Required

Class-Tiny-1.008, File-Copy-Recursive-0.45, File-ShareDir-1.118, Path-Tiny-0.144 and Scope-Guard-0.21

Recommended (required for the test suite)

Installation of Test::File::ShareDir

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Test::LeakTrace-0.17

Introduction to Test::LeakTrace

Test::LeakTrace traces memory leaks.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Test::LeakTrace

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Test::Needs-0.002010

Introduction to Test::Needs

Test::Needs skips tests if a requested module is not present.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Test::Needs

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Test::Requires-0.11

Introduction to Test::Requires

The Test::Requires module checks if another (optional) module can be loaded, and if not it skips all the current tests.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Test::Requires

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Test::RequiresInternet-0.05

Introduction to Test::RequiresInternet

Test::RequiresInternet is intended to easily test network connectivity before functional tests begin to non-local Internet resources.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Test::RequiresInternet

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Test::utf8-1.02

Introduction to Test::utf8

Test::utf8 is a collection of tests useful for dealing with utf8 strings in Perl.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Test::utf8

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Test::Warnings-0.031

Introduction to Test::Warnings

Test::Warnings tests for warnings and the lack of them.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Test::Warnings

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Test::Without::Module-0.21

Introduction to Test::Without::Module

This module allows you to deliberately hide modules from a program even though they are installed. This is mostly useful for testing modules that have a fallback when a certain dependency module is not installed.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Test::Without::Module

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Test2::Plugin::NoWarnings-0.09

Introduction to Test2::Plugin::NoWarnings

Test2::Plugin::NoWarnings causes tests to fail if there are any warnings while they run.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Test2::Plugin::NoWarnings Dependencies
Required

Test2-Suite-0.000145

Recommended (required for the test suite)

Installation of Test2::Plugin::NoWarnings

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Test2::Suite-0.000145

Introduction to Test2::Suite

Test2::Suite is a distribution with a rich set of tools built upon the Test2 framework.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Test2::Suite Dependencies
Required

Module-Pluggable-5.2, Scope-Guard-0.21, Sub-Info-0.002 and Term-Table-0.016

Installation of Test2::Suite

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Text::CSV_XS-1.51

Introduction to Text::CSV_XS

Text::CSV_XS provides facilities for the composition and decomposition of comma-separated values.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Text::CSV_XS

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Text::Diff-1.45

Introduction to Text::Diff

Text::Diff performs diffs on files and record sets.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Text::Diff Dependencies
Required

Algorithm-Diff-1.201

Installation of Text::Diff

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Text::Glob-0.11

Introduction to Text::Glob

Text::Glob implements glob(3) style matching that can be used to match against text, rather than fetching names from a filesystem.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Text::Glob

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Tie::Cycle-1.227

Introduction to Tie::Cycle

You use Tie::Cycle to go through a list over and over again. Once you get to the end of the list, you go back to the beginning. You don't have to worry about any of this since the magic of tie does that for you.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Tie::Cycle

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

TimeDate-2.33

Introduction to TimeDate

TimeDate provides miscellaneous timezone manipulation routines.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of TimeDate

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Try::Tiny-0.31

Introduction to Try::Tiny

Try::Tiny provides try and catch to expect and handle exceptional conditions, avoiding quirks in Perl and common mistakes.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Try::Tiny Dependencies
Optional (can be used by the test suite)

Capture-Tiny-0.48

Installation of Try::Tiny

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Variable::Magic-0.63

Introduction to Variable::Magic

Magic is Perl's way of enhancing variables. With this module, you can add your own magic to any variable.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Variable::Magic

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

WWW::RobotRules-6.02

Introduction to WWW::RobotRules

WWW::RobotRules parses robots.txt files, creating a WWW::RobotRules object with methods to check if access to a given URL is prohibited.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
WWW::RobotRules Dependencies
Required (runtime)

libwww-perl-6.72 (install this module first and install that later)

Installation of WWW::RobotRules

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

XML::LibXML-2.0208

Introduction to XML::LibXML

XML::LibXML is a perl binding for libxml2-2.10.4.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
XML::LibXML Dependencies
Required

Alien-Libxml2-0.19, XML-SAX-1.02

Installation of XML::LibXML

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

XML::NamespaceSupport-1.12

Introduction to XML::NamespaceSupport

XML::NamespaceSupport offers a simple way to process namespaced XML names from within any application that may need them.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of XML::NamespaceSupport

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

XML::SAX-1.02

Introduction to XML::SAX

XML::SAX is a SAX parser access API for Perl. It includes classes and APIs required for implementing SAX drivers, along with a factory class for returning any SAX parser installed on the user's system.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
XML::SAX Dependencies
Required

libxml2-2.10.4, XML-NamespaceSupport-1.12 and XML-SAX-Base-1.09

Installation of XML::SAX

This module uses a variant of the standard build and installation instructions:

yes | perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

Command Explanations

yes: Perl will ask if you want it to alter ParserDetails.ini and then wait for a response. The default is 'y'. Using 'yes' allows you to script this.

XML::SAX::Base-1.09

Introduction to XML::SAX::Base

This module has a very simple task - to be a base class for PerlSAX drivers and filters.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of XML::SAX-Base

This module uses the standard build and installation instructions:

perl Makefile.PL &&
make             &&
make test

Now, as the root user:

make install

PHP-8.2.9

Introduction to PHP

PHP is the PHP Hypertext Preprocessor. Primarily used in dynamic web sites, it allows for programming code to be directly embedded into the HTML markup. It is also useful as a general purpose scripting language.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://www.php.net/distributions/php-8.2.9.tar.xz

  • Download MD5 sum: 897c9c416663d03e516a68cb86b598f3

  • Download size: 11 MB

  • Estimated disk space required: 505 MB (with documentation)

  • Estimated build time: 1.5 SBU (with parallelism=4; add 1.6 SBU for tests)

Additional Downloads

PHP Dependencies

Recommended
Optional System Utilities and Libraries

Aspell-0.60.8, enchant-2.5.0, libxslt-1.1.38, an MTA (that provides a sendmail command), pcre2-10.42, Pth-2.0.7, AppArmor, Dmalloc, Net-SNMP, oniguruma, OSSP mm, re2c, and XMLRPC-EPI

Optional Graphics Utilities and Libraries

FreeType-2.13.1, libexif-0.6.24, libjpeg-turbo-3.0.0, libpng-1.6.40, libtiff-4.5.1, libwebp-1.3.1, a graphical environment, FDF Toolkit, GD, and t1lib

Optional Web Utilities

cURL-8.2.1, tidy-html5-5.8.0, Caudium, Hyperwave, Roxen WebServer, and WDDX

Optional Data Management Utilities and Libraries

Berkeley DB-5.3.28 (Note that PHP does not officially support versions above 5.3), libiodbc-3.52.15, lmdb-0.9.31, MariaDB-10.11.4 or MySQL, OpenLDAP-2.6.6, PostgreSQL-15.4, SQLite-3.42.0, unixODBC-2.3.12, Adabas, Birdstep, cdb, DBMaker, Empress, FrontBase, IBM DB2, Mini SQL, Monetra, and QDBM

PHP also provides support for many commercial database tools such as Oracle, SAP and ODBC Router.

Optional Security/Encryption Utilities and Libraries

Cyrus SASL-2.1.28, MIT Kerberos V5-1.21.2, libmcrypt, and mhash

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/php

Installation of PHP

You can use PHP for server-side scripting, command-line scripting or client-side GUI applications. This book provides instructions for setting up PHP for server-side scripting as it is the most common form.

Note

PHP has many more configure options that will enable support for various things. You can use ./configure --help to see a full list of the available options. Also, use of the PHP web site is highly recommended, as their online docs are very good. An example of a configure command that utilizes many of the most common dependencies can be found at https://anduin.linuxfromscratch.org/BLFS/files/php_configure.txt.

If, for whatever reason, you don't have libxml2-2.10.4 installed, you need to add --disable-libxml to the configure command in the instructions below. Note that this will prevent the pear command from being built.

Install PHP by running the following commands:

./configure --prefix=/usr                \
            --sysconfdir=/etc            \
            --localstatedir=/var         \
            --datadir=/usr/share/php     \
            --mandir=/usr/share/man      \
            --enable-fpm                 \
            --without-pear               \
            --with-fpm-user=apache       \
            --with-fpm-group=apache      \
            --with-fpm-systemd           \
            --with-config-file-path=/etc \
            --with-zlib                  \
            --enable-bcmath              \
            --with-bz2                   \
            --enable-calendar            \
            --enable-dba=shared          \
            --with-gdbm                  \
            --with-gmp                   \
            --enable-ftp                 \
            --with-gettext               \
            --enable-mbstring            \
            --disable-mbregex            \
            --with-readline              &&
make

To test the results, issue: make test. Several tests (out of over 16000) may fail, in which case you are asked whether you want to send the report to the PHP developers. If you want to automate the test, you may prefix the command with yes "n" | .

Now, as the root user:

make install                                     &&
install -v -m644 php.ini-production /etc/php.ini &&

install -v -m755 -d /usr/share/doc/php-8.2.9 &&
install -v -m644    CODING_STANDARDS* EXTENSIONS NEWS README* UPGRADING* \
                    /usr/share/doc/php-8.2.9

The default configuration files for the fastCGI process manager are installed only if they do not already exist on the system. If this is the first installation, they should be renamed, as the root user:

if [ -f /etc/php-fpm.conf.default ]; then
  mv -v /etc/php-fpm.conf{.default,} &&
  mv -v /etc/php-fpm.d/www.conf{.default,}
fi

The pre-built HTML documentation is packaged in two forms: a tarball containing many individual files, useful for quick loading into your browser, and one large individual file, which is useful for using the search utility of your browser. If you downloaded either, or both, of the documentation files, issue the following commands as the root user to install them (note these instructions assume English docs, modify the tarball names below if necessary).

For the Single HTML file:

install -v -m644 ../php_manual_en.html.gz \
    /usr/share/doc/php-8.2.9 &&
gunzip -v /usr/share/doc/php-8.2.9/php_manual_en.html.gz

For the Many HTML files tarball:

tar -xvf ../php_manual_en.tar.gz \
    -C /usr/share/doc/php-8.2.9 --no-same-owner

The bundled pear is not installed because of a bug which might pollute the filesystem with several hidden files and directories. If pear is needed, execute the following commands to install it:

wget https://pear.php.net/go-pear.phar
php ./go-pear.phar

Command Explanations

--datadir=/usr/share/php: This works around a bug in the build machinery, which installs some data to a wrong location.

--enable-fpm: This parameter allows building the fastCGI Process Manager.

--with-fpm-systemd: This parameter allows the FastCGI Process Manager to integrate with systemd.

--without-pear: This switch disables installation of bundled pear software.

--with-config-file-path=/etc: This parameter makes PHP look for the php.ini configuration file in /etc.

--with-zlib: This parameter adds support for Zlib compression.

--enable-bcmath: Enables bc style precision math functions.

--with-bz2: Adds support for Bzip2 compression functions.

--enable-calendar: This parameter provides support for calendar conversion.

--enable-dba=shared: This parameter enables support for database (dbm-style) abstraction layer functions.

--enable-ftp: This parameter enables FTP functions.

--with-gettext: Enables functions that use Gettext text translation.

--enable-mbstring: This parameter enables multibyte string support.

--with-readline: This parameter enables command line Readline support.

--disable-libxml: This option allows building PHP without libxml2 installed.

--with-apxs2: Instead of building the fastCGI process manager, it is possible to build an apache module. This has some performance penalty for heavy loaded servers, but may be easier to set up. This switch is incompatible with the --enable-fpm and --with-fpm-... switches.

--with-mysqli=shared: This option includes MySQLi support.

--with-mysql-sock=/run/mysqld/mysqld.sock: Location of the MySQL unix socket pointer.

--with-pdo-mysql=shared: This option includes PDO: MySQL support.

--with-tidy=shared: This option includes tidy library support.

Configuring PHP

Config Files

/etc/php.ini, /etc/pear.conf, /etc/php-fpm.conf, and /etc/php-fpm.d/www.conf

Configuration Information

The file used as the default /etc/php.ini configuration file is recommended by the PHP development team. This file modifies the default behavior of PHP. If no /etc/php.ini is used, all configuration settings fall to the defaults. You should review the comments in this file and ensure the changes are acceptable in your particular environment.

The fastCGI process manager uses the configuration file /etc/php-fpm.conf. The default file shipped with PHP includes all the /etc/php-fpm.d/*.conf in turn. There is a shipped /etc/php-fpm.d/www.conf file, that contains the parameters related to the interaction with the Apache Web server.

You may have noticed the following from the output of the make install command:

You may want to add: /usr/lib/php to your php.ini include_path

If desired, add the entry using the following command as the root user:

sed -i 's@php/includes"@&\ninclude_path = ".:/usr/lib/php"@' \
    /etc/php.ini

To enable fastCGI support in the Apache web server, two LoadModule directives must be added to the httpd.conf file. They are commented out, so just issue the following command as root user:

sed -i -e '/proxy_module/s/^#//'      \
       -e '/proxy_fcgi_module/s/^#//' \
       /etc/httpd/httpd.conf

Those modules accept various ProxyPass directives. One possibility is (as the root user):

echo \
'ProxyPassMatch ^/(.*\.php)$ fcgi://127.0.0.1:9000/srv/www/$1' >> \
/etc/httpd/httpd.conf

Additionally, it may be useful to add an entry for index.php to the DirectoryIndex directive of the httpd.conf file. Lastly, adding a line to set up the .phps extension to show highlighted PHP source may be desirable:

AddType application/x-httpd-php-source .phps

You'll need to restart the Apache web server after making any modifications to the httpd.conf file.

Systemd Unit

To start the php-fpm daemon at boot, install the systemd unit from the blfs-systemd-units-20230816 package by running the following command as the root user:

make install-php-fpm

Contents

Installed Programs: phar (symlink), phar.phar, php, php-cgi, php-config, php-fpm, phpdbg, and phpize
Installed Libraries: dba.so and opcache.so in /usr/lib/php/extensions/no-debug-non-zts-20220829
Installed Directories: /etc/php-fpm.d, /usr/{include,lib,share}/php, and /usr/share/doc/php-8.2.9

Short Descriptions

php

is a command line interface that enables you to parse and execute PHP code

pear

is the PHP Extension and Application Repository (PEAR) package manager. This isn't installed by default

php-fpm

is the fastCGI process manager for PHP

phpdbg

is the interactive PHP debugger

Python-2.7.18

Introduction to Python 2

The Python 2 package contains the Python development environment. It is useful for object-oriented programming, writing scripts, prototyping large programs or developing entire applications. This version is for backward compatibility with other dependent packages.

Note

Python2 has been deprecated by the upstream developers. Support for Python2 was discontinued on January 1st, 2020.

BLFS is attempting to use Python3 as much as possible, but some packages have not been updated to support Python3.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Python 2 Dependencies

Recommended
Optional

BlueZ-5.68 and Valgrind-3.21.0

Optional (For more additional modules)

libnsl-2.0.0 and Tk-8.6.13

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/Python

Installation of Python 2

First, disable the installation of a script that overwrites a more recent script:

sed -i '/2to3/d' ./setup.py

Install Python 2 by running the following commands:

patch -Np1 -i ../Python-2.7.18-security_fixes-1.patch &&
./configure --prefix=/usr                              \
            --enable-shared                            \
            --with-system-expat                        \
            --with-system-ffi                          \
            --enable-unicode=ucs4                     &&
make

If you invoke the tests, they will run through twice. To test the results, issue: make -k test. Several tests are known to fail, including test_ftplib, test_ssl, test_urllib2_localnet, test_xml_etree, test_xml_etree_c, and test_minidom. These failures are due to OpenSSL-3 and Expat-2.4.6.

Now, as the root user:

make altinstall                                &&
ln -s python2.7        /usr/bin/python2        &&
ln -s python2.7-config /usr/bin/python2-config &&
chmod -v 755 /usr/lib/libpython2.7.so.1.0

Since Python 2 is in maintenance mode, and Python 3 is recommended by upstream for development, you probably do not need to install the documentation. However, if you still want to install documentation for both Python versions, be sure to define the PYTHONDOCS variable for the version you want to use, each time you need to consult the documentation. If you have downloaded the preformatted documentation from https://docs.python.org/download.html, install it as the root user:

install -v -dm755 /usr/share/doc/python-2.7.18 &&

tar --strip-components=1                     \
    --no-same-owner                          \
    --directory /usr/share/doc/python-2.7.18 \
    -xvf ../python-2.7.18-docs-html.tar.bz2 &&

find /usr/share/doc/python-2.7.18 -type d -exec chmod 0755 {} \; &&
find /usr/share/doc/python-2.7.18 -type f -exec chmod 0644 {} \;

Command Explanations

--with-system-expat: This switch enables linking against system version of Expat.

--with-system-ffi: This switch enables linking against system version of libffi.

--enable-unicode=ucs4: This switch enables 32-bit Unicode support in Python.

--with-ensurepip=yes : This switch enables building pip and setuptools packaging programs. setuptools is needed for building some Python modules. This switch is not recommended because this version of Python is no longer maintained.

--with-dbmliborder=bdb:gdbm:ndbm: Use this switch if you want to build Python DBM Module against Berkeley DB instead of GDBM.

make altinstall: This make target omits some default symbolic links that may interfere with Python 3.

chmod ...: Fix permissions for libraries to be consistent with other libraries.

Configuring Python 2

In order for python to find the installed documentation, you must add the following environment variable to individual user's or the system's profile:

export PYTHONDOCS=/usr/share/doc/python-2.7.18

Contents

Installed Programs: pydoc, python2 (symlink), python2-config (symlink), python2.7, python2.7-config, smtpd.py, and idle
Installed Library: libpython2.7.so
Installed Directories: /usr/{include,lib}/python2.7 and /usr/share/doc/python-2.7.18

Short Descriptions

idle

is a wrapper script that opens a Python aware GUI editor. For this script to run, you must have installed Tk before Python so that the Tkinter Python module is built

pydoc

is the Python documentation tool

python2

is an interpreted, interactive, object-oriented programming language

python2.7

is a version-specific name for the python program

smtpd.py

is an SMTP proxy implemented in Python

Python-3.11.4

Introduction to Python 3

The Python 3 package contains the Python development environment. This is useful for object-oriented programming, writing scripts, prototyping large programs or developing entire applications.

Note

Python 3 was installed in LFS. The only reason to rebuild it here is if optional modules are needed, or to upgrade this package.

This package is known to build and work properly using an LFS 12.0 platform.

Important

If upgrading to a new Python-3 minor version (for example, from Python-3.10.x to Python-3.11.0), you will need to reinstall any Python3 modules you have installed. You should also reinstall packages that generate Python3 modules including gobject-introspection-1.76.1, opencv-4.8.0, Graphviz-8.1.0 (if swig is installed).

Before you upgrade, you can get a list of modules installed with pip3 list. The list may be incomplete as some Python modules are not installed with pip3, for example the cracklib module installed by CrackLib-2.9.11. Use ls /usr/lib/python3.minor/site-packages for a comprehensive list.

The Python modules from LFS will also have to be reinstalled: flit-core, wheel, meson, MarkupSafe, and Jinja2.

Package Information

Additional Optional Download

Python 3 Dependencies

Recommended
Optional

BlueZ-5.68, GDB-13.2 (required for some tests), Valgrind-3.21.0, and libmpdec

Optional (For Additional Modules)

Berkeley DB-5.3.28, libnsl-2.0.0, and Tk-8.6.13

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/Python3

Installation of Python 3

Install Python 3 by running the following commands:

CXX="/usr/bin/g++"               \
./configure --prefix=/usr        \
            --enable-shared      \
            --with-system-expat  \
            --with-system-ffi    \
            --enable-optimizations &&
make

To test the result, issue make test. Some tests may need an Internet connection. Two tests, test_distutils and test_embed are known to fail.

Now, as the root user:

make install

If upgrading and the documentation has been downloaded, optionally install it as the root user:

install -v -dm755 /usr/share/doc/python-3.11.4/html

tar --strip-components=1  \
    --no-same-owner       \
    --no-same-permissions \
    -C /usr/share/doc/python-3.11.4/html \
    -xvf ../python-3.11.4-docs-html.tar.bz2

Command Explanations

CXX="/usr/bin/g++" ./configure ...: Avoid an annoying message during configuration.

--with-system-expat: This switch enables linking against the system version of Expat.

--with-system-ffi: This switch enables linking against the system version of libffi.

--with-dbmliborder=bdb:gdbm:ndbm: Use this switch if you want to build the Python DBM Module against Berkeley DB instead of GDBM.

--enable-optimizations: This switch enables stable, but expensive, optimizations.

--with-lto: This optional switch enables thick Link Time Optimization. Unusually, it creates a much larger /usr/lib/python3.11/config-3.11-<arch>-linux-gnu/libpython3.11.a with a small increase in the time to compile Python. Run-time results do not appear to show any benefit from doing this.

Configuring Python 3

In order for python3 to find the installed documentation, create the following version independent symlink:

ln -svfn python-3.11.4 /usr/share/doc/python-3

and add the following environment variable to the individual user's or system's profile:

export PYTHONDOCS=/usr/share/doc/python-3/html

Contents

Installed Programs: 2to3 (symlink) and 2to3-3.11, idle3 (symlink) and idle3.11, pip3 (symlink) and pip3.11, pydoc3 and pydoc3.11, python3 (symlink); python3.11, and python3-config (symlink) and python3.11-config
Installed Libraries: libpython3.11.so and libpython3.so
Installed Directories: /usr/include/python3.11, /usr/lib/python3.11, and /usr/share/doc/python-3.11.4

Short Descriptions

idle3

is a wrapper script that opens a Python aware GUI editor. For this script to run, you must have installed Tk before Python so that the Tkinter Python module is built

pydoc3

is the Python documentation tool

python3

is an interpreted, interactive, object-oriented programming language

python3.11

is a version-specific name for the python program

Python Modules

Introduction to Python Modules

The Python module packages add useful objects to the Python language. Modules utilized by packages throughout BLFS are listed here, along with their dependencies.

Note

If you want to run tests, several of the following modules depend on the sqlite3 core python module that has not been built in LFS. It is therefore recommended to rebuild Python after installing the recommended dependency listed in Python-3.11.4.

Important

In BLFS, we normally build and install Python 3 modules with pip3. Please take care that the pip3 install commands in the book should be run as root unless it's for a Python virtual environment. Running pip3 install as a non-root user may seem to work fine, but it will cause the installed module to be inaccessible by other users.

pip3 install will not reinstall an already installed module by default. For using the pip3 install command to upgrade a module (for example, from meson-0.61.3 to meson-0.62.0), insert --upgrade into the command line. If it's really necessary to downgrade a module or reinstall the same version for some reason, insert --force-reinstall into the command line.

Asciidoc-10.2.0

Introduction to Asciidoc Module

The Asciidoc package is a text document format for writing notes, documentation, articles, books, ebooks, slideshows, web pages, man pages and blogs. AsciiDoc files can be translated to many formats including HTML, PDF, EPUB, and man page.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Asciidoc Dependencies
Optional (runtime)

docbook-xsl-nons-1.79.2, fop-2.9, libxslt-1.1.38, Lynx-2.8.9rel.1, dblatex, and W3m

Installation of Asciidoc

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

This package does not come with a test suite.

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user asciidoc

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: a2x and asciidoc
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/asciidoc and /usr/lib/python3.11/site-packages/asciidoc-10.2.0.dist-info
Short Descriptions

a2x

is a toolchain manager for AsciiDoc (converts Asciidoc text files to other file formats)

asciidoc

converts an AsciiDoc text file to HTML or DocBook

CSSSelect-1.2.0

Introduction to CSSSelect Module

CSSSelect provides CSS selectors for Python.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
CSSSelect Dependencies
Required

setuptools_scm-7.1.0

Optional (for testing)

lxml-4.9.3, pluggy-1.0.0, and pytest-7.4.0

Installation of CSSSelect

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user cssselect

To test the installation issue pytest.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/cssselect

CacheControl-0.13.1

Introduction to CacheControl Module

CacheControl is a port of the caching algorithms in httplib2 for use with requests session object. It was written because httplib2's better support for caching is often mitigated by its lack of thread safety. The same is true of requests in terms of caching.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
CacheControl Dependencies
Required

msgpack-1.0.4 and requests-2.31.0

Installation of CacheControl

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user cachecontrol

This module does not have a working test suite.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: doesitcache
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/CacheControl-0.13.1.dist-info and /usr/lib/python3.11/site-packages/cachecontrol
Short Descriptions

doesitcache

is an undocumented command line script.

Cython-0.29.36

Introduction to Cython Module

The Cython package provides a compiler for writing C extensions for the Python language.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Cython

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

This package does not come with a test suite.

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user Cython

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: cygdb, cython, and cythonize
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/Cython, /usr/lib/python3.11/site-packages/Cython-0.29.36.dist-info, and /usr/lib/python3.11/site-packages/pyximport
Short Descriptions

cygdb

is the Cython debugger

cython

is a compiler for code written in the Cython language. It outputs a C/C++ program which can be compiled with a C/C++ compiler

cythonize

is a compiler for code written in the Cython language. It outputs an extension module which is directly importable from Python

dbusmock-0.29.1

Introduction to dbusmock

dbusmock is a Python library useful for writing tests for software which talks to D-Bus services.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
dbusmock Dependencies
Required

D-Bus Python-1.3.2

Installation of dbusmock

Build the package with:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

To install the package run the following as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user python-dbusmock

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/dbusmock and /usr/lib/python3.11/site-packages/python_dbusmock-0.29.1.dist-info

D-Bus Python-1.3.2

Introduction to D-Bus Python Module

D-Bus Python provides Python bindings to the D-Bus API interface.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
D-Bus Python Dependencies
Required

dbus-1.14.8, GLib-2.76.4, meson_python-0.12.0, and patchelf-0.17.2

Installation of D-Bus Python

Build the D-Bus Python module by running the following command:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

This package does not come with a test suite.

Now install the module as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user dbus-python

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/dbus and /usr/lib/python3.11/site-packages/dbus_python-1.3.2.egg-info

docutils-0.20.1

Introduction to docutils

docutils is a set of Python modules and programs for processing plaintext docs into formats such as HTML, XML, or LaTeX.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/docutils

Installation of docutils

To build the Python 3 applications, run the following command:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

To install the Python applications run the following as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user docutils &&

for f in /usr/bin/rst*.py; do
  ln -svf $(basename $f) /usr/bin/$(basename $f .py)
done

To reduce the time needed for loading Python scripts, pip3 install will compile the scripts with extension .py into byte code and save the result into .pyc files in the directory __pycache__. But this package installs .py scripts into /usr/bin. So the byte code files for them will be installed into /usr/bin/__pycache__, which is not allowed by FHS. Still as the root user, remove this directory:

rm -rfv /usr/bin/__pycache__

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: docutils, rst2html4, rst2html5, rst2html, rst2latex, rst2man, rst2odt_prepstyles, rst2odt, rst2pseudoxml, rst2s5, rst2xetex, rst2xml, and rstpep2html
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/docutils{,-0.20.1.dist-info}
Short Descriptions

docutils

converts documents into various formats

rst2html

generates (X)HTML documents from standalone reStructuredText sources

rst2html4

generates (X)HTML documents from standalone reStructuredText sources

rst2html5

generates HTML5 documents from standalone reStructuredText sources

rst2latex

generates LaTeX documents from standalone reStructuredText sources

rst2man

generates plain unix manual documents from standalone reStructuredText sources

rst2odt

generates OpenDocument/OpenOffice/ODF documents from standalone reStructuredText sources

rst2odt_prepstyles

Fix a word-processor-generated styles.odt for odtwriter use

rst2pseudoxml

generates pseudo-XML from standalone reStructuredText sources (for testing purposes)

rst2s5

generates S5 (X)HTML slideshow from standalone reStructuredText sources

rst2xetex

generates LaTeX documents from standalone reStructuredText sources for compilation with the Unicode-aware TeX variants XeLaTeX or LuaLaTeX

rst2xml

generates Docutils-native XML from standalone reStructuredText sources

rstpep2html

generates (X)HTML from reStructuredText-format PEP files

Doxypypy-0.8.8.7

Introduction to Doxypypy Module

The Doxypypy package is a doxygen filter for python.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Doxypypy Dependencies
Required

chardet-5.1.0 and Doxygen-1.9.7 (at run time)

Installation of Doxypypy

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user doxypypy

This package does not come with a working test suite.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: doxypypy
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/doxypypy and /usr/lib/python3.11/site-packages/doxypypy-0.8.8.7.dist-info
Short Descriptions

doxypypy

filters Python code for use with Doxygen, using a syntax-aware approach.

Doxyqml-0.5.2

Introduction to Doxyqml Module

The Doxyqml package allows using Doxygen to document QML classes.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Doxyqml Dependencies
Required (Run Time)

Doxygen-1.9.7

Optional (for testing)

pytest-7.4.0

Installation of Doxyqml

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user doxyqml

To test the installation, run:

pytest

The test_qmlclass.py test is known to fail.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: doxyqml
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/doxyqml and /usr/lib/python3.11/site-packages/doxyqml-0.5.2.dist-info
Short Descriptions

doxyqml

is a Doxygen input filter for QML files.

Gi-DocGen-2023.1

Introduction to Gi-DocGen Module

Gi-DocGen is a document generator for GObject-based libraries. GObject is the base type system of the GNOME project. GI-Docgen reuses the introspection data generated by GObject-based libraries to generate the API reference of these libraries, as well as other ancillary documentation.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Gi-DocGen Dependencies
Required

Markdown-3.4.1, Pygments-2.16.1, and typogrify-2.0.7

Optional (for testing)

pytest-7.4.0

Installation of gi-docgen

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user gi-docgen

To test the installation, issue pytest.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: gi-docgen
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/gidocgen and /usr/lib/python3.11/site-packages/gi_docgen-2023.1.dist-info

Short Descriptions

gi-docgen

manages documentation for libgobject based libraries.

libxml2-2.10.4 (for its Python2 module)

Introduction to the libxml2 Python2 module

These instructions provide the Python2 bindings for libxml2: the Python3 bindings are built as part of libxml2-2.10.4 and most packages in the book do not use these bindings for the older Python2.

By building these bindings after libxml2-2.10.4 has been installed, there is no need to rebuild the time-consuming (if all dependencies are used) main part of that package.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
libxml2 (Python2) Dependencies
Required

libxml2-2.10.4 and Python-2.7.18

Installation of libxml2 Python2 module

To build the Python 2 module, run:

./configure PYTHON=python2 &&
cd python                  &&
python2 setup.py build

To install the Python 2 module, as the root user run:

python2 setup.py install --optimize=1

Contents

Installed Modules: drv_libxml2.py, libxml2.py
Installed Libraries: libxml2mod.so
Installed Directories: None

Short Descriptions

drv_libxml2.py

is a SAX Python2 driver for libxml2

libxml2.py

is the Python2 binding for libxml2

libxml2mod.so

is the interface for Python2 to use libxml2.so

lxml-4.9.3

Introduction to lxml Module

lxml provides Python bindings for libxslt-1.1.38 and libxml2-2.10.4.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
lxml Dependencies
Required

libxslt-1.1.38

Installation of lxml

To build the Python 3 module, run:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

To install the module, issue the following command as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user lxml

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/lxml and /usr/lib/python3.11/site-packages/lxml-4.9.3.dist-info

Mako-1.2.4

Introduction to Mako Module

Mako is a Python module that implements hyperfast and lightweight templating for the Python platform.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Mako Dependencies
Optional (for Testing)

pytest-7.4.0

Installation of Mako

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Install the module as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user Mako

To test the installation, issue pytest.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: mako-render
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/mako and /usr/lib/python3.11/site-packages/Mako-1.2.4.dist-info
Short Descriptions

mako-render

renders a template

NumPy-1.25.2

Introduction to NumPy Module

NumPy is the fundamental package for scientific computing with Python.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
NumPy Dependencies
Required

cython-0.29.36

Optional

fortran from GCC-13.2.0, lapack and cblas, and openblas

Optional (for testing)

attrs-22.2.0, pytest-7.4.0, and hypothesis

Installation of NumPy

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user numpy

The installation can be tested with the following commands:

python3 -m venv --system-site-packages testenv &&
source testenv/bin/activate                    &&
pip3 install hypothesis                        &&
python3 runtests.py
deactivate

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: f2py, f2py3 and f2py3.11 (3 copies of the same script)
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/numpy
Short Descriptions

f2py

is the Fortran to Python interface generator utility.

Packaging-23.1

Introduction to Packaging Module

The Packaging library provides utilities that implement the interoperability specifications which have clearly one correct behaviour or benefit greatly from having a single shared implementation.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Packaging Dependencies
Optional (for testing)

pytest-7.4.0 and pretend

Installation of Packaging

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user packaging

Assuming pytest-7.4.0 is installed, but the other optional dependency is not, the installation can be tested with the following commands:

python3 -m venv --system-site-packages testenv &&
source testenv/bin/activate                    &&
pip3 install pretend                           &&
python3 /usr/bin/pytest
deactivate

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/packaging and /usr/lib/python3.11/site-packages/packaging-23.1.dist-info

Py3c-1.4

Introduction to Py3c

Py3c helps you port C extensions to Python 3. It provides a detailed guide, and a set of macros to make porting easy and reduce boilerplate.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Py3c

The Py3c package is a headers-only package and because of that, no configuration and compilation is required.

To test the package, issue:

make test-python3 &&
make test-python3-cpp

To install the Python 3 module, run the following command as the root user:

make prefix=/usr install

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/include/py3c

PyAtSpi2-2.46.0

Introduction to PyAtSpi2

The PyAtSpi2 package contains Python bindings for the core components of the GNOME Accessibility.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
PyAtSpi2 Dependencies
Required

PyGObject-3.44.1

Recommended

Installation of PyAtSpi2

To build PyAtSpi2 as a Python 3 module, run the following commands:

./configure --prefix=/usr --with-python=/usr/bin/python3

This package does not come with a test suite.

To install the Python 3 module, run the following command as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/pyatspi

PyCairo-1.18.2

Introduction to PyCairo for Python2 Module

This version of PyCairo provides Python2 bindings to Cairo.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
PyCairo Dependencies
Required

Cairo-1.17.6 and Python-2.7.18

Optional

Hypothesis (for tests)

Installation of PyCairo

Note

This version of PyCairo is only retained for packages such as Gimp-2.10.34 which is stuck on Python2 until Gimp-3 is released.

Install PyCairo for Python2 by running the following commands:

python2 setup.py build

This package does not come with a test suite.

Now, as the root user:

python2 setup.py install --optimize=1   &&
python2 setup.py install_pycairo_header &&
python2 setup.py install_pkgconfig

Contents

Installed Program: None
Installed Library: _cairo.so
Installed Directories: /usr/include/pycairo, /usr/lib/python2.7/site-packages/cairo, /usr/lib/python2.7/site-packages/pycairo-1.18.2-py2.7.egg,

PyCairo-1.24.0

Introduction to PyCairo Module

PyCairo provides Python bindings to Cairo.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
PyCairo Dependencies
Required

Cairo-1.17.6

Optional

Hypothesis and pytest-7.4.0 (for tests)

Installation of PyCairo

Note

The current version of pycairo no longer builds the Python2 module. If you need that module for packages such as Gimp-2.10.34, use PyCairo-1.18.2

Install PyCairo for Python3 by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To run the tests, this package requires the optional pytest module. If it is installed, run the tests by running ninja test.

Now, as the root user:

ninja install

Contents

Installed Program: None
Installed Library: None
Installed Directories: /usr/include/pycairo, /usr/lib/python3.11/site-packages/cairo, and /usr/lib/python3.11/site-packages/pycairo-1.24.0.egg-info

PyCryptodome-3.18.0

Introduction to the PyCryptodome Module

PyCryptodome is a collection of both secure hash functions (such as SHA256 and RIPEMD160), and various encryption algorithms (AES, DES, RSA, ElGamal, etc.), and is a drop-in replacement for PyCrypto.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of PyCryptodome

To build PyCryptodome as a Python 3 module, run the following command:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

To install the module, run the following command as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user pycryptodome

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/Crypto /usr/lib/python3.11/site-packages/pycryptodome-3.18.0.dist-info

Pygments-2.16.1

Introduction to Pygments Module

Pygments is a general syntax highlighter written in Python, for more than 300 languages.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Pygments

Build the Python 3 module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

To install the package run the following as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user Pygments

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: pygmentize
Installed Library: None
Installed Directories: /usr/lib/python3.11/site-packages/pygments and /usr/lib/python3.11/site-packages/Pygments-2.16.1.dist-info

Short Descriptions

pygmentize

highlights an input file and writes the result to an output file

PyGObject-2.28.7

Introduction to PyGObject Module

PyGObject-2.28.7 provides Python 2 bindings to the GObject class from GLib.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
PyGObject Dependencies
Required

GLib-2.76.4, PyCairo-1.18.2 and Python-2.7.18

Optional

gobject-introspection-1.76.1 and libxslt-1.1.38 (to Build Documentation)

Installation of PyGObject

Install PyGObject by running the following commands:

./configure --prefix=/usr --disable-introspection &&
make

This package does not have a working test suite.

Now, as the root user:

make install

Command Explanations

--disable-introspection: Omit this switch if you have installed gobject-introspection-1.76.1. Note that it conflicts with PyGObject-3.44.1.

--disable-docs: This option disables the rebuilding of the html documentation if libxslt-1.1.38 is installed.

Contents

Installed Programs: pygobject-codegen-2.0
Installed Libraries: libpyglib-2.0-python.so, _gio.so, unix.so, _glib.so and _gobject.so.
Installed Directories: /usr/include/pygtk-2.0, /usr/lib/python2.7/site-packages/gtk-2.0/{gio,glib,gobject}, /usr/share/gtk-doc/html/pygobject and /usr/share/pygobject/2.0

PyGObject-3.44.1

Introduction to PyGObject3 Module

PyGObject3 provides Python bindings to the GObject class from GLib.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
PyGObject3 Dependencies
Required

gobject-introspection-1.76.1 and PyCairo-1.24.0 (Python 3 module)

Optional (for the tests)

GTK-4.12.0, pep8, pyflakes, and pytest-7.4.0

Installation of PyGObject3

First, remove a faulty test:

mv -v tests/test_gdbus.py{,.nouse}

Install pygobject3 by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test. An already active graphical session with a bus address is necessary to run the tests. Another round of tests may report ERROR if GTK-4.12.0 is not installed.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Programs: None
Installed Library: /usr/lib/python3.11/site-packages/gi/_gi{,_cairo}.cpython-311-<arch>-linux-gnu.so
Installed Directories: /usr/include/pygobject-3.0 and /usr/lib/python3.11/site-packages/{gi,pygtkcompat}

PyGTK-2.24.0

Introduction to PyGTK Module

PyGTK lets you to easily create programs with a graphical user interface using the Python programming language.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
PyGTK Dependencies
Required

PyGObject-2.28.7 and Python-2.7.18

Required (atk module)

at-spi2-core-2.48.3

Required (pango module)

Pango-1.50.14

Required (pangocairo module)

PyCairo-1.18.2 and Pango-1.50.14

Required (gtk and gtk.unixprint modules)

PyCairo-1.18.2 and GTK+-2.24.33.

Required (gtk.glade module)

PyCairo-1.18.2 and libglade-2.6.4.

Optional

NumPy

Optional (to Build Documentation)

libxslt-1.1.38

Installation of PyGTK

First, adapt PyGTK to changes in Pango by removing undefined APIs:

sed -i '1394,1402 d' pango.defs

Install PyGTK by running the following commands:

./configure --prefix=/usr &&
make

The tests must be run from an active X display. If this is so, issue: make check.

Now, as the root user:

make install

Command Explanations

--enable-docs: This option enables rebuilding the html documentation if libxslt-1.1.38 is installed.

Contents

Installed Programs: pygtk-codegen-2.0 and pygtk-demo.
Installed Libraries: atk.so, _gtk.so, glade.so, gtkunixprint.so, pango.so and pangocairo.so.
Installed Directories: /usr/include/pygtk-2.0, /usr/lib/pygtk, /usr/lib/python2.7/site-packages/gtk-2.0, /usr/share/gtk-doc/html/pygtk and /usr/share/pygtk.
Short Descriptions

pygtk-codegen-2.0

is a wrapper script to run the PyGTK codegen module

pygtk-demo

is a Python wrapper to run the PyGTK demo program

pyparsing-3.1.1

Introduction to pyparsing Module

The pyparsing module is an alternative approach to creating and executing simple grammars, vs. the traditional lex/yacc approach, or the use of regular expressions. It provides a library of classes that client code uses to construct the grammar directly in Python code.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
pyparsing Dependencies
Optional

railroad-diagrams (also needed for tests)

Optional (for testing)

pytest-7.4.0

Installation of pyparsing

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user pyparsing

Assuming pytest-7.4.0 is installed, but the other optional dependency is not, the installation can be tested with the following commands:

python3 -m venv --system-site-packages testenv &&
source testenv/bin/activate                    &&
pip3 install railroad-diagrams                 &&
python3 /usr/bin/pytest
deactivate

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/pyparsing and /usr/lib/python3.11/site-packages/pyparsing-3.1.1.dist-info

pySerial-3.5

Introduction to pySerial Module

The pySerial module encapsulates access to the serial port.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
pySerial Dependencies
Required

setuptools_scm-7.1.0

Optional (for testing)

pluggy-1.0.0 and pytest-7.4.0

Installation of pySerial

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user pyserial

To test the installation issue pytest.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: pyserial-miniterm and pyserial-ports
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/pyserial-3.5.dist-info and /usr/lib/python3.11/site-packages/serial
Short Descriptions

pyserial-miniterm

is a console application that provides a small terminal application. It may inherit terminal features from the terminal in which it is run.

pyserial-ports

lists available ports.

Pytest-7.4.0

Introduction to Pytest Module

The Pytest framework makes it easy to write small, readable tests, and can scale to support complex functional testing for applications and libraries.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Pytest Dependencies
Required

iniconfig-2.0.0, packaging-23.1, pluggy-1.0.0, and py-1.11.0

Recommended
Optional (for testing)

Pygments-2.16.1, requests-2.31.0, argcomplete, elementpath, hypothesis, mock, nose, sortedcontainers, and xmlschema

Installation of Pytest

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user pytest

The installation can be tested with the following commands:

python3 -m venv --system-site-packages testenv &&
source testenv/bin/activate                    &&
pip3 install pytest[testing]                   &&
python3 /usr/bin/pytest
deactivate

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: pytest and py.test (different files but with same content)
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/_pytest, /usr/lib/python3.11/site-packages/pytest, and /usr/lib/python3.11/site-packages/pytest-7.4.0.dist-info
Short Descriptions

pytest

sets up, manages, and/or runs test in python module source directories

PyXDG-0.28

Introduction to PyXDG Module

PyXDG is a Python library to access freedesktop.org standards.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of PyXDG

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Install the module as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user pyxdg

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Directory: /usr/lib/python3.11/site-packages/xdg and /usr/lib/python3.11/site-packages/pyxdg-0.28.dist-info

PyYAML-6.0.1

Introduction to PyYAML Module

PyYAML is a Python module that implements the next generation YAML parser and emitter.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
PyYAML Dependencies
Required

cython-0.29.36 and libyaml-0.2.5

Installation of PyYAML

Build PyYAML with the following command:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, install the module as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user PyYAML

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/PyYAML-0.2.5.dist-info

Recommonmark-0.7.1

Introduction to Recommonmark Module

Recommonmark is a docutils-compatibility bridge to CommonMark. It allows writing CommonMark inside of Docutils and Sphinx projects. Recommonmark is now deprecated in favor of MyST-Parser. Unfortunately, LLVM-16.0.5 still depends on this module.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Recommonmark Dependencies
Required

commonmark-0.9.1 and sphinx-7.1.2

Optional (for testing)

pytest-7.4.0

Installation of Recommonmark

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user recommonmark

Recommonmark is now deprecated in favor of MyST-Parser. For this reason, a lot of tests have to be disabled because they do not pass with recent versions of Sphinx. The installation can be partially tested with the following command:

pytest -k 'not (test_integration or test_code or test_headings or test_image or test_links or test_lists)'

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: cm2html, cm2latex, cm2man, cm2pseudoxml, cm2xetex, and cm2xml
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/recommonmark and /usr/lib/python3.11/site-packages/recommonmark-0.7.1.dist-info

Short Descriptions

cm2html

generates a html document from markdown sources

cm2latex

generates a latex document from markdown sources

cm2man

generates a manpage from markdown sources

cm2pseudoxml

generates a pseudo-XML document from markdown sources

cm2xetex

generates a xetex document from markdown sources

cm2xml

generates an XML document from markdown sources

Requests-2.31.0

Introduction to Requests Module

The Requests package is an elegant and simple HTTP library for Python, built for human beings. It allows sending HTTP/1.1 requests extremely easily.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Additional Download
Requests Dependencies
Required

charset-normalizer-3.0.1, idna-3.4, and urllib3-2.0.2

Recommended
Optional

PySocks (also needed for testing)

Optional (for testing)

pytest-7.4.0, Flask<2, httpbin, MarkupSafe<2.1, pytest-mock, pytest-httpbin, sphinx<5, trustme, and Werkzeug<2

Installation of Requests

First apply a patch so that the same environment variable already used to point to system certificates in Python3 following the installation of make-ca can also be used by this module:

patch -Np1 -i ../requests-2.31.0-use_system_certs-1.patch

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user requests

Assuming pytest-7.4.0 is installed, but the other optional dependencies are not, the installation can be tested with the following commands:

python3 -m venv --system-site-packages testenv &&
source testenv/bin/activate                    &&
pip3 install --force-reinstall sphinx\<5       &&
pip3 install pytest-mock    \
             werkzeug\<2    \
             flask\<2       \
             pytest-httpbin \
             pysocks        \
             trustme                           &&
pip3 install --force-reinstall Markupsafe\<2.1 &&
python3 /usr/bin/pytest tests
deactivate

Note

See make-ca-1.12 for how to set the environment variable, and for how local copies of the Certifi and Requests modules installed in a virtual environment will override the system certificates.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/requests and /usr/lib/python3.11/site-packages/requests-2.31.0.dist-info

Scour-0.38.2

Introduction to Scour Module

Scour is an SVG (Scalable Vector Graphics) optimizer/cleaner that reduces their size by optimizing structure and removing unnecessary data.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Scour Dependencies
Required

six-1.16.0

Installation of scour

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

To install the module, run the following command as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user scour

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: scour
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/scour and /usr/lib/python3.11/site-packages/scour-0.38.2.dist-info

Short Descriptions

scour

is a program to optimize and clean SVG files

six-1.16.0

Introduction to Six Module

Six is a Python 2 to 3 compatibility library.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Six

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

This package does not come with a test suite.

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user six

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/six-1.16.0.dist-info

Sphinx-7.1.2

Introduction to Sphinx Module

The Sphinx package is a set of tools for translating some structured text formats into pretty documentation in various formats.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Sphinx Dependencies
Required

alabaster-0.7.13, Babel-2.11.0, docutils-0.20.1, imagesize-1.4.1, packaging-23.1, Pygments-2.16.1, requests-2.31.0, snowballstemmer-2.2.0, sphinxcontrib-applehelp-1.0.4, sphinxcontrib-devhelp-1.0.2, sphinxcontrib-htmlhelp-2.0.1, sphinxcontrib-jsmath-1.0.1, sphinxcontrib-qthelp-1.0.3, and sphinxcontrib-serializinghtml-1.1.5

Optional (for tests)

cython-0.29.36, pytest-7.4.0, texlive-20230313, filelock, and html5lib

Installation of Sphinx

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user sphinx

Assuming cython-0.29.36 and pytest-7.4.0 are installed, but the other optional dependency is not, the installation can be tested with the following commands:

python3 -m venv --system-site-packages testenv &&
source testenv/bin/activate                    &&
pip3 install html5lib filelock                 &&
python3 /usr/bin/pytest
deactivate

Four subtests in tests/test_ext_math.py are known to fail.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: sphinx-apidoc, sphinx-autogen, sphinx-build, and sphinx-quickstart
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/sphinx and /usr/lib/python3.11/site-packages/sphinx-7.1.2.dist-info
Short Descriptions

sphinx-apidoc

creates an reST file from python modules and packages

sphinx-autogen

generates ReStructuredText from special directives contained in given input files

sphinx-build

generates documentation in various formats from ReStructuredText source files

sphinx-quickstart

generates required files for a sphinx project

Sphinx_rtd_theme-1.2.2

Introduction to Sphinx_rtd_theme Module

The sphinx_rtd_theme module is a Sphinx theme designed to provide a great reader experience for documentation users on both desktop and mobile devices. This theme is used primarily on Read the Docs but can work with any Sphinx project.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Sphinx_rtd_theme Dependencies
Required

sphinx-7.1.2 and sphinxcontrib-jquery-4.1

Optional (for tests)

pytest-7.4.0 and readthedocs-sphinx-ext

Installation of Sphinx_rtd_theme

Fix wrong versions for dependencies:

sed -e s/0.19/0.21/ \
    -e '/sphinx.*7/s/7/8/' \
    -i setup.cfg

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user sphinx_rtd_theme

Assuming pytest-7.4.0 is installed, but the other optional dependency is not, the installation can be tested with the following commands:

python3 -m venv --system-site-packages testenv &&
source testenv/bin/activate                    &&
pip3 install readthedocs-sphinx-ext            &&
python3 /usr/bin/pytest
deactivate

Several tests return a warning because they use a deprecated sphinx API.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/sphinx_rtd_theme and /usr/lib/python3.11/site-packages/sphinx_rtd_theme-1.2.2.dist-info

Python Dependencies

Introduction to Python Dependencies

Python modules listed in Python Modules have dependencies that are not referenced by other packages in BLFS. These dependencies are listed here. They will not get updated on regular basis, unless a more recent version is needed.

Important

In BLFS, we normally build and install Python 3 modules with pip3. Please take care that the pip3 install commands in the book should be run as root unless it's for a Python virtual environment. Running pip3 install as a non-root user may seem to work fine, but it will cause the installed module to be inaccessible by other users.

pip3 install will not reinstall an already installed module by default. For using the pip3 install command to upgrade a module (for example, from meson-0.61.3 to meson-0.62.0), insert --upgrade into the command line. If it's really necessary to downgrade a module or reinstall the same version for some reason, insert --force-reinstall into the command line.

Alabaster-0.7.13

Introduction to Alabaster Module

The Alabaster package is a theme for the sphinx documentation system. Although developed separately, it is the default theme for sphinx.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Alabaster

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

This package does not come with a test suite.

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user alabaster

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/alabaster and /usr/lib/python3.11/site-packages/alabaster-0.7.13.dist-info

Attrs-22.2.0

Introduction to Attrs Module

The Attrs package is a theme for the sphinx documentation system. Although developed separately, it is the default theme for sphinx.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Optional (for testing)

pytest-7.4.0, coverage[toml], hypothesis, Pympler, mypy, pytest-mypy-plugins, zope.interface, and cloudpickle

Installation of Attrs

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user attrs

To test the installation, run:

python3 -m venv --system-site-packages testenv &&
source testenv/bin/activate                    &&
pip3 install attrs[tests]                      &&
python3 /usr/bin/pytest                        &&
deactivate

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/attr, /usr/lib/python3.11/site-packages/attrs, and /usr/lib/python3.11/site-packages/attrs-22.2.0.dist-info

Babel-2.11.0

Introduction to Babel Module

The Babel package is an integrated collection of utilities that assist in internationalizing and localizing Python applications, with an emphasis on web-based applications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Babel Dependencies
Required

pytz-2022.7.1

Optional (for testing)

pytest-7.4.0, Python-3.11.4 (with the sqlite module), freezegun==0.3.12, and pytest-cov

Installation of Babel

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user Babel

Assuming pytest-7.4.0 is installed, but the other optional dependencies are not, the installation can be tested with the following commands:

python3 -m venv --system-site-packages testenv &&
source testenv/bin/activate                    &&
pip3 install pytest-cov freezegun==0.3.12      &&
python3 /usr/bin/pytest
deactivate

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: pybabel
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/babel and /usr/lib/python3.11/site-packages/Babel-2.11.0.dist-info
Short Descriptions

pybabel

is a command-line interface for working with message catalogs

Chardet-5.1.0

Introduction to chardet Module

Chardet is a universal character encoding detector.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Chardet Dependencies
Optional (for testing)

pytest-7.4.0

Installation of Chardet

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user chardet

To test the installation issue pytest.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: chardetect
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/chardet and /usr/lib/python3.11/site-packages/chardet-5.1.0.dist-info
Short Descriptions

chardetect

is a Universal Character Encoding Detector

Charset-normalizer-3.0.1

Introduction to charset-normalizer Module

The charset-normalizer library helps reading text from an unknown character encoding.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Charset-normalizer Dependencies
Optional (for testing)

pytest-7.4.0 and pytest-cov

Installation of Charset-normalizer

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user charset-normalizer

Assuming pytest-7.4.0 is installed, but the other optional dependencies are not, the installation can be tested with the following commands:

python3 -m venv --system-site-packages testenv &&
source testenv/bin/activate                    &&
pip3 install pytest-cov                        &&
python3 /usr/bin/pytest
deactivate

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: normalizer
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/charset_normalizer and /usr/lib/python3.11/site-packages/charset_normalizer-3.0.1.dist-info
Short Descriptions

normalizer

is a Universal Charset Detector (discovers originating encoding and normalizes text to unicode)

Commonmark-0.9.1

Introduction to Commonmark Module

Commonmark Python parser for the CommonMark Markdown specification.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Commonmark Dependencies
Optional (for testing)

pytest-7.4.0, flake8, and hypothesis

Installation of Commonmark

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user commonmark

Assuming pytest-7.4.0 is installed and the other optional dependency is not, the installation can be tested with:

python3 -m venv --system-site-packages testenv &&
source testenv/bin/activate                    &&
pip3 install hypothesis                        &&
python3 /usr/bin/pytest commonmark/tests/unit_tests.py
python3 commonmark/tests/run_spec_tests.py
deactivate

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: cmark
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/commonmark and /usr/lib/python3.11/site-packages/commonmark-0.9.1.dist-info

Short Descriptions

cmark

processes Markdown according to the CommonMark specification

Editables-0.3

Introduction to Editables Module

Editables is python library for creating editable wheels.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Editables

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

This package does not come with a test suite.

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user editables

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/editables and /usr/lib/python3.11/site-packages/editables-0.3.dist-info

Hatchling-1.12.2

Introduction to Hatchling Module

Hatchling is an extensible, standards compliant build backend for python modules.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Hatchling Dependencies
Required

editables-0.3, packaging-23.1, pathspec-0.10.3, and pluggy-1.0.0

Installation of Hatchling

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

This package does not come with a working test suite.

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user hatchling

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: hatchling
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/hatchling and /usr/lib/python3.11/site-packages/hatchling-1.12.2.dist-info

Short Descriptions

hatchling

is a python module builder

Hatch_vcs-0.3.0

Introduction to Hatch-vcs Module

Hatch_vcs is a Hatch plugin for versioning with several VCS .

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Hatch_vcs Dependencies
Required

hatchling-1.12.2 and setuptools_scm-7.1.0

Optional (for testing)

pytest-7.4.0

Installation of Hatch_vcs

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user hatch_vcs

To test the installation, issue pytest. One test, tests/test_build.py::test_write, is known to fail.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/hatch_vcs and /usr/lib/python3.11/site-packages/hatch_vcs-0.3.0.dist-info

Idna-3.4

Introduction to Idna Module

The Idna module provides support for the Internationalized Domain Names in Applications (IDNA) protocol as specified in RFC 5891.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Idna Dependencies
Optional (for testing)

pytest-7.4.0

Installation of Idna

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user idna

To test the installation, run pytest.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/idna and /usr/lib/python3.11/site-packages/idna-3.4.dist-info

Imagesize-1.4.1

Introduction to Imagesize Module

The imagesize package analyzes image file headers and returns the image size and DPI. It works with JPEG/JPEG 2000/PNG/GIF/TIFF/SVG/Netpbm/WebP formats.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Imagesize Dependencies
Optional (for testing)

pytest-7.4.0 and requests-2.31.0

Installation of Imagesize

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user imagesize

The tests for this package are known to be broken. To test the installation anyway, run pytest.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/imagesize and /usr/lib/python3.11/site-packages/imagesize-1.4.1.dist-info

Iniconfig-2.0.0

Introduction to Iniconfig Module

Iniconfig is a small and simple INI-file parser module.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Iniconfig Dependencies
Required

hatch_vcs-0.3.0

Installation of Iniconfig

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

This package does not come with a test suite.

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user iniconfig

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/iniconfig and /usr/lib/python3.11/site-packages/iniconfig-2.0.0.dist-info

Markdown-3.4.1

Introduction to Markdown Module

Markdown is a Python parser for John Gruber's Markdown specification.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Markdown Dependencies
Optional (for testing)

pytest-7.4.0, PyYAML-6.0.1, and coverage

Installation of Markdown

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user Markdown

Assuming pytest-7.4.0 and PyYAML-6.0.1 are installed and the other optional dependency is not, the installation can be tested with:

python3 -m venv --system-site-packages testenv &&
source testenv/bin/activate                    &&
pip3 install coverage                          &&
python3 /usr/bin/pytest --ignore=tests/test_syntax/extensions/test_md_in_html.py
deactivate

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: markdown_py
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/markdown and /usr/lib/python3.11/site-packages/Markdown-3.4.1.dist-info

Short Descriptions

markdown_py

converts markdown files to (x)html

Meson_python-0.12.0

Introduction to Meson_python Module

The Meson_python module contains a Python build backend (PEP 517) for Meson projects.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Meson_python Dependencies
Required

pyproject-metadata-0.7.0

Recommended (Runtime)

patchelf-0.17.2

Installation of Meson_python

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

This package does not come with a test suite.

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user meson_python

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/meson_python and /usr/lib/python3.11/site-packages/meson_python-0.12.0.dist-info

MessagePack-1.0.4

Introduction to MessagePack Module

MessagePack is an efficient binary serialization format. It lets you exchange data among multiple languages like JSON. But it's faster and smaller. This package provides CPython bindings for reading and writing MessagePack data.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
MessagePack Dependencies
Required

cython-0.29.36 and setuptools_scm-7.1.0

Optional (for testing)

pluggy-1.0.0 and pytest-7.4.0

Installation of MessagePack

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user msgpack

To test the installation issue pytest.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/msgpack-1.0.4.dist-info and /usr/lib/python3.11/site-packages/msgpack

Pathspec-0.10.3

Introduction to Pathspec Module

Pathspec is a utility library for pattern matching of file paths.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Pathspec Dependencies
Optional (for testing)

pytest-7.4.0

Installation of Pathspec

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user pathspec

To test the installation, issue pytest.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/pathspec and /usr/lib/python3.11/site-packages/pathspec-0.10.3.dist-info

Pluggy-1.0.0

Introduction to Pluggy Module

The Pluggy package gives users the ability to extend or modify the behaviour of a host program by installing a plugin for that program. The plugin code will run as part of normal program execution, changing or enhancing certain aspects of it. In essence, pluggy enables function hooking so a user can build pluggable systems.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Pluggy Dependencies
Recommended
Optional (for testing)

pytest-7.4.0 and pytest-benchmark

Installation of Pluggy

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user pluggy

Assuming pytest-7.4.0 is installed, but the other optional dependencies are not, the installation can be tested with the following commands:

python3 -m venv --system-site-packages testenv &&
source testenv/bin/activate                    &&
pip3 install pytest-benchmark                  &&
python3 /usr/bin/pytest
deactivate

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/pluggy and /usr/lib/python3.11/site-packages/pluggy-1.0.0.dist-info

Py-1.11.0

Introduction to Py Module

The Py library is a Python development support library used in Pytest. It is deprecated and should be removed at some point in time, but part of it is still used in Pytest.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Py Dependencies
Recommended

Installation of Py

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user py

Due to the deprecation of this package, the test suite is not maintained and cannot be run.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/py and /usr/lib/python3.11/site-packages/py-1.11.0.dist-info

Pyproject-Metadata-0.7.0

Introduction to Pyproject-Metadata Module

The Pyproject-Metadata module contains a data class for PEP 621 metadata with support for core metadata (PEP 643) generation.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Pyproject-Metadata Dependencies
Required

packaging-23.1

Installation of Pyproject-Metadata

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

This package does not come with a test suite.

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user pyproject-metadata

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/pyproject_metadata and /usr/lib/python3.11/site-packages/pyproject_metadata-0.7.0.dist-info

Pytz-2022.7.1

Introduction to Pytz Module

The Pytz library brings the IANA tz database into Python. It allows accurate and cross-platform timezone calculations.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Pytz dependencies
Optional (for testing)

pytest-7.4.0

Installation of Pytz

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user pytz

To test the installation, run pytest. A few warnings are issued.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/pytz and /usr/lib/python3.11/site-packages/pytz-2022.7.1.dist-info

Setuptools_scm-7.1.0

Introduction to Setuptools_scm Module

The Setuptools_scm package is used to extract Python package versions from git or hg metadata instead of declaring them.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Setuptools_scm Dependencies
Required

packaging-23.1 and typing_extensions-4.4.0

Optional (for testing)

git-2.41.0, Mercurial-6.5.1, and pytest-7.4.0

Installation of Setuptools_scm

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user setuptools_scm

The installation can be tested with pytest. A few tests may fail if your git configuration is not the one expected by the test suite.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/setuptools_scm and /usr/lib/python3.11/site-packages/setuptools_scm-7.1.0.dist-info

Smartypants-2.0.1

Introduction to Smartypants Module

Smartypants translates plain ASCII punctuation characters into smart typographic punctuation HTML entities.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Smartypants

Note

The tarball extracts into the smartypants.py-2.0.1 directory.

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

This package does not come with a working test suite.

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user smartypants

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: smartypants
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/smartypants-2.0.1.dist-info

Short Descriptions

smartypants

translates ASCII punctuation to HTML punctuation.

Snowballstemmer-2.2.0

Introduction to Snowballstemmer Module

The Snowballstemmer package is a small string processing language for creating stemming algorithms for use in Information Retrieval, plus a collection of stemming algorithms implemented using it. Stemming maps different forms of the same word to a common stem — for example, the English stemmer maps connection, connections, connective, connected, and connecting to connect. Running a search for connected would also find documents which only have the other forms.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Snowballstemmer

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

This package does not come with a test suite.

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user snowballstemmer

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/snowballstemmer and /usr/lib/python3.11/site-packages/snowballstemmer-2.2.0.dist-info

Sphinxcontrib-applehelp-1.0.4

Introduction to Sphinxcontrib-applehelp Module

The Sphinxcontrib-applehelp package is a Sphinx extension which outputs Apple help books.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Sphinxcontrib-applehelp Dependencies
Optional (for testing)

pytest-7.4.0 and sphinx-7.1.2 (circular dependency)

Installation of Sphinxcontrib-applehelp

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user sphinxcontrib-applehelp

To test the installation, run pytest. Several warnings may be issued, due to the use of deprecated functions.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/sphinxcontrib and /usr/lib/python3.11/site-packages/sphinxcontrib_applehelp-1.0.4.dist-info

Sphinxcontrib-devhelp-1.0.2

Introduction to Sphinxcontrib-devhelp Module

The Sphinxcontrib-devhelp package is a Sphinx extension which outputs Devhelp documents.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Sphinxcontrib-devhelp Dependencies
Optional (for testing)

pytest-7.4.0 and sphinx-7.1.2 (circular dependency)

Installation of Sphinxcontrib-devhelp

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user sphinxcontrib-devhelp

To test the installation, run pytest.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/sphinxcontrib and /usr/lib/python3.11/site-packages/sphinxcontrib_devhelp-1.0.2.dist-info

Sphinxcontrib-htmlhelp-2.0.1

Introduction to Sphinxcontrib-htmlhelp Module

The Sphinxcontrib-htmlhelp package is a Sphinx extension which renders HTML help files.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Sphinxcontrib-htmlhelp Dependencies
Optional (for testing)

pytest-7.4.0, sphinx-7.1.2 (circular dependency), and html5lib

Installation of Sphinxcontrib-htmlhelp

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user sphinxcontrib-htmlhelp

Assuming pytest-7.4.0 is installed, but the other optional dependency is not, the installation can be tested with the following commands:

python3 -m venv --system-site-packages testenv   &&
source testenv/bin/activate                      &&
pip3 install html5lib                            &&
python3 /usr/bin/pytest
deactivate

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/sphinxcontrib and /usr/lib/python3.11/site-packages/sphinxcontrib_htmlhelp-2.0.1.dist-info

Sphinxcontrib-jquery-4.1

Introduction to Sphinxcontrib-jquery Module

The Sphinxcontrib-jquery package is a Sphinx extension which includes jQuery on newer Sphinx releases.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Sphinxcontrib-jquery Dependencies
Optional (for testing)

pytest-7.4.0

Installation of Sphinxcontrib-jquery

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

This package does not come with a testsuite.

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user sphinxcontrib-jquery

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/sphinxcontrib and /usr/lib/python3.11/site-packages/sphinxcontrib_jquery-4.1.dist-info

Sphinxcontrib-jsmath-1.0.1

Introduction to Sphinxcontrib-jsmath Module

The Sphinxcontrib-jsmath package is a Sphinx extension which renders display math in HTML via JavaScript.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Sphinxcontrib-jsmath Dependencies
Optional (for testing)

pytest-7.4.0 and sphinx-7.1.2 (circular dependency)

Installation of Sphinxcontrib-jsmath

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user sphinxcontrib-jsmath

The installation can be tested with the following commands:

sed -i 's/text()/read_&/' tests/test_jsmath.py &&
pytest

the sed ... command is needed because of a change in Sphinx API for versions greater than 5.0.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/sphinxcontrib and /usr/lib/python3.11/site-packages/sphinxcontrib_jsmath-1.0.1.dist-info

Sphinxcontrib-qthelp-1.0.3

Introduction to Sphinxcontrib-qthelp Module

The Sphinxcontrib-qthelp package is a Sphinx extension which outputs QtHelp documents.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Sphinxcontrib-qthelp Dependencies
Optional (for testing)

pytest-7.4.0 and sphinx-7.1.2 (circular dependency)

Installation of Sphinxcontrib-qthelp

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user sphinxcontrib-qthelp

The installation can be tested with the following commands:

sed -i 's/text()/read_&/' tests/test_qthelp.py &&
pytest

The sed ... command is needed because of a change in Sphinx API for versions greater than 5.0.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/sphinxcontrib and /usr/lib/python3.11/site-packages/sphinxcontrib_qthelp-1.0.3.dist-info

Sphinxcontrib-serializinghtml-1.1.5

Introduction to Sphinxcontrib-serializinghtml Module

The Sphinxcontrib-serializinghtml package is a Sphinx extension which outputs serialized HTML files (json and pickle).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Sphinxcontrib-serializinghtml Dependencies
Optional (for testing)

pytest-7.4.0 and sphinx-7.1.2 (circular dependency)

Installation of Sphinxcontrib-serializinghtml

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user sphinxcontrib-serializinghtml

To test the installation, run pytest.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/sphinxcontrib and /usr/lib/python3.11/site-packages/sphinxcontrib_serializinghtml-1.1.5.dist-info

Typing_extensions-4.4.0

Introduction to Typing_extensions Module

The Typing_extensions module allows using new type system features not yet defined on the Python version in use on the system.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Typing_extensions

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

This package does not come with a test suite.

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user typing_extensions

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/typing_extensions-4.4.0.dist-info

Typogrify-2.0.7

Introduction to Typogrify Module

Typogrify provides filters to enhance web typography, including support for Django and Jinja templates.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Typogrify Dependencies
Required

smartypants-2.0.1

Installation of Typogrify

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

This package does not come with a testsuite.

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user typogrify

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/typogrify and /usr/lib/python3.11/site-packages/typogrify-2.0.7.dist-info

Urllib3-2.0.2

Introduction to Urllib3 Module

The Urllib3 module is a powerful, user-friendly HTTP client for Python. It brings many critical features that are missing from the Python standard libraries.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Urllib3 Dependencies
Required

hatchling-1.12.2

Optional (for tests)

pytest-7.4.0, mock, PySocks, pytest-timeout, python-dateutil, tornado, and trustme

Installation of Urllib3

If you want to run the tests, remove some that may hang:

rm -v test/test_retry.py \
      test/contrib/test_pyopenssl.py \
      test/contrib/test_securetransport.py \
      test/with_dummyserver/test_socketlevel.py

Build the module:

pip3 wheel -w dist --no-build-isolation --no-deps $PWD

Now, as the root user:

pip3 install --no-index --find-links dist --no-cache-dir --no-user urllib3

Note

Running the tests may result in the procedure below hanging and are not recommended.

Assuming pytest-7.4.0 is installed, but the other optional dependencies are not, the installation can be tested with the following commands:

python3 -m venv --system-site-packages testenv &&
source testenv/bin/activate                    &&
pip3 install trustme         \
             tornado         \
             python-dateutil \
             mock            \
             pysocks         \
             pytest-timeout  &&
python3 /usr/bin/pytest
deactivate

A few errors are known to occur.

Command Explanations

-w dist: builds the appropriate "wheel" for this module in the directory dist.

--no-build-isolation: tells pip3 to run the build in the system environment instead of creating a temporary build environment.

--no-deps: prevents pip3 from building wheels for the project's dependencies.

--no-index: ignores the package index (only looking at --find-links URLs instead).

--find-links dist: looks for links to archives such as wheel (.whl) files in the directory dist.

--no-cache-dir: disables the cache to prevent a warning when installing as the root user.

--no-user: Prevent mistakenly running the install command as a non-root user.

--upgrade: Upgrade the package to the newest available version. This option is used with the install command if a version of the package is already installed.

--force-reinstall: Reinstall the package even if it is up-to-date. This option is used with the install command if reinstalling the package or reverting to an earlier version of the package.

--no-deps: Do not install package dependencies. This option may be needed with the --upgrade or --force-reinstall options.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/urllib3 and /usr/lib/python3.11/site-packages/urllib3-2.0.2.dist-info

Ruby-3.2.2

Introduction to Ruby

The Ruby package contains the Ruby development environment. This is useful for object-oriented scripting.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://cache.ruby-lang.org/pub/ruby/3.2/ruby-3.2.2.tar.xz

  • Download MD5 sum: 377853f31d10bfe37c58b8537fc3e05d

  • Download size: 14 MB

  • Estimated disk space required: 694 MB (add 1.0 GB for C API docs)

  • Estimated build time: 1.2 SBU (using parallelism=4; add 4.6 SBU for tests; add 0.6 SBU for C API docs)

Ruby Dependencies

Required

libyaml-0.2.5

Optional

Berkeley DB-5.3.28, Doxygen-1.9.7, Graphviz-8.1.0, rustc-1.71.1, Tk-8.6.13, Valgrind-3.21.0, and DTrace

Installation of Ruby

Install Ruby by running the following command:

./configure --prefix=/usr      \
            --enable-shared    \
            --without-valgrind \
            --without-baseruby \
            --docdir=/usr/share/doc/ruby-3.2.2 &&
make

Optionally, build the CAPI documents by running the following commands:

make capi

The tests require that the new version of Ruby is already installed to run correctly. If you want to run the tests, execute them after installing the package.

Now, as the root user:

make install

To test the results, issue: make -k check. There are over 25,000 tests. Some tests related to ipv6 may indicate errors. If the tests are run in a directory that has a world writable component (e.g. /tmp) then several additional tests may fail. A few tests may fail due to system configuration expectations.

Note

If you have Ruby-On-Rails applications installed and did an upgrade of Ruby by installing this package, you might need to run an update there, too (as the root user):

cd /path/to/web/app
bundle update rake

and restart the webserver which serves the application.

Command Explanations

--enable-shared: This switch enables building the libruby shared library.

--without-baseruby: This switch prevents using the system ruby if it is already installed. The build system will use the newly built version instead.

--disable-install-doc: This switch disables building and installing rdoc indexes and C API documents.

--disable-install-rdoc: This switch disables building and installing rdoc indexes.

--disable-install-capi: This switch disables building and installing C API documents.

Contents

Installed Programs: bundle, bundler, erb, gem, irb, racc, rake, rbs, rdbg, rdoc, ri, ruby, and typeprof
Installed Libraries: libruby.so
Installed Directories: /usr/include/ruby-3.2.0, /usr/lib/ruby, /usr/share/doc/ruby-3.2.2 and /usr/share/ri

Short Descriptions

bundle

creates bundles of Ruby Gems

bundler

manages an application's dependencies throughout it's lifecycle

erb

is a command line front-end for eRuby, which provides a templating system for Ruby

gem

is the command for RubyGems, which is a sophisticated package manager for Ruby. This is similar to Python's 'pip' command

irb

is the interactive interface for Ruby

rake

is a make-like build utility for Ruby

rdbg

is an interactive debugger for Ruby

rdoc

generates Ruby documentation

ri

displays documentation from a database on Ruby classes, modules, and methods

ruby

is an interpreted scripting language for quick and easy object-oriented programming

libruby.so

contains the API functions required by Ruby

Rustc-1.71.1

Introduction to Rust

The Rust programming language is designed to be a safe, concurrent, practical language.

This package is updated on a six-weekly release cycle. Because it is such a large and slow package to build, is at the moment only required by a few packages in this book, and particularly because newer versions tend to break older mozilla packages, the BLFS editors take the view that it should only be updated when that is necessary (either to fix problems, or to allow a new version of a package to build).

As with many other programming languages, rustc (the rust compiler) needs a binary from which to bootstrap. It will download a stage0 binary at the start of the build, so you cannot compile it without an Internet connection.

Note

Although BLFS usually installs in /usr, when you later upgrade to a newer version of rust the old libraries in /usr/lib/rustlib will remain, with various hashes in their names, but will not be usable and will waste space. The editors recommend placing the files in the /opt directory. In particular, if you have reason to rebuild with a modified configuration (e.g. using the shipped LLVM after building with shared LLVM, perhaps to compile crates for architectures which the BLFS LLVM build does not support) it is possible for the install to leave a broken cargo program. In such a situation, either remove the existing installation first, or use a different prefix such as /opt/rustc-1.71.1-build2.

If you prefer, you can of course change the prefix to /usr.

The current rustbuild build-system will use all processors, although it does not scale well and often falls back to just using one core while waiting for a library to compile. However it can be mostly limited to a specified number of processors by a combination of adding the switch --jobs <N> (e.g. '--jobs 4' to limit to 4 processors) on each invocation of python3 ./x.py and using an environment variable CARGO_BUILD_JOBS=<N>. At the moment this is not effective when some of the rustc tests are run.

The current version of rust's num_cpus crate now recognizes that cgroups can be used to restrict which processors it is allowed to use. So if your machine lacks DRAM (typically, less than 2GB DRAM per core) that might be an alternative to taking CPUs offline. That can be achieved by using systemd-run command with -p User=$(whoami) and -p AllowedCPUs=0-x (with x replaced with the number of CPU cores you want to use minus one) options.

At the moment Rust does not provide any guarantees of a stable ABI.

Note

Rustc defaults to building for ALL supported architectures, using a shipped copy of LLVM. In BLFS the build is only for the X86 architecture. If you intend to develop rust crates, this build may not be good enough for your purposes.

The build times of this version when repeated on the same machine are often reasonably consistent, but as with all compilations using rustc there can be some very slow outliers.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://static.rust-lang.org/dist/rustc-1.71.1-src.tar.xz

  • Download MD5 sum: b6f9973de878e37a589f0989e4138480

  • Download size: 145 MB

  • Estimated disk space required: 8.9 GB (292 MB installed); add 6.4 GB if running the tests

  • Estimated build time: 6.7 SBU (including download time; add 6.2 SBU for tests, both using parallelism=8)

Rust Dependencies

Required

CMake-3.27.2 and cURL-8.2.1

Note

An Internet connection is needed for building this package.

Recommended

Note

If a recommended dependency is not installed, a shipped copy in the Rustc source tarball will be built and used.

Optional

GDB-13.2 (used by the test suite if it is present), git-2.41.0 (required by the test suite), and libgit2

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/rust

Installation of Rust

Note

Currently the rust compiler produces SSE2 instructions for 32-bit x86, causing the generated code to be broken on 32-bit systems without a SSE2-capable processor. All x86 processor models released after 2004 should be SSE2-capable. Run lscpu | grep sse2 as a test. If it outputs anything, your CPU is SSE2-capable and OK. Otherwise you may try to build this package on a SSE2-capable system with the following fix applied:

sed 's@pentium4@pentiumpro@' -i \
    compiler/rustc_target/src/spec/i686_unknown_linux_gnu.rs

And copy the resulting /opt/rustc-1.71.1 to the system without SSE2 capability. But this change is still under upstream review and not tested by BLFS editors.

To install into the /opt directory, remove any existing /opt/rustc symlink and create a new directory (i.e. with a different name if trying a modified build of the same version). As the root user:

mkdir -pv /opt/rustc-1.71.1      &&
ln -svfn rustc-1.71.1 /opt/rustc

Note

If multiple versions of Rust are installed in /opt, changing to another version only requires changing the /opt/rustc symbolic link and then running ldconfig.

Create a suitable config.toml file which will configure the build.

cat << EOF > config.toml
# see config.toml.example for more possible options
# See the 8.4 book for an old example using shipped LLVM
# e.g. if not installing clang, or using a version before 13.0

# tell x.py to not keep printing an annoying warning
changelog-seen = 2

[llvm]
# by default, rust will build for a myriad of architectures
targets = "X86"

# When using system llvm prefer shared libraries
link-shared = true

[build]
# omit docs to save time and space (default is to build them)
docs = false

# install extended tools: cargo, clippy, etc
extended = true

# Do not query new versions of dependencies online.
locked-deps = true

# Specify which extended tools (those from the default install).
tools = ["cargo", "clippy", "rustdoc", "rustfmt"]

# Use the source code shipped in the tarball for the dependencies.
# The combination of this and the "locked-deps" entry avoids downloading
# many crates from Internet, and makes the Rustc build more stable.
vendor = true

[install]
prefix = "/opt/rustc-1.71.1"
docdir = "share/doc/rustc-1.71.1"

[rust]
channel = "stable"
description = "for BLFS 12.0"

# BLFS used to not install the FileCheck executable from llvm,
# so disabled codegen tests.  The assembly tests rely on FileCheck
# and cannot easily be disabled, so those will anyway fail if
# FileCheck has not been installed.
#codegen-tests = false

[target.x86_64-unknown-linux-gnu]
# NB the output of llvm-config (i.e. help options) may be
# dumped to the screen when config.toml is parsed.
llvm-config = "/usr/bin/llvm-config"

[target.i686-unknown-linux-gnu]
# NB the output of llvm-config (i.e. help options) may be
# dumped to the screen when config.toml is parsed.
llvm-config = "/usr/bin/llvm-config"


EOF

Compile Rust by running the following commands:

{ [ ! -e /usr/include/libssh2.h ] ||
  export LIBSSH2_SYS_USE_PKG_CONFIG=1; } &&
python3 ./x.py build

Note

The test suite will generate some messages in the systemd journal for traps on invalid opcodes, and for segmentation faults. In themselves these are nothing to worry about, just a way for the test to be terminated.

To run the tests (again using all available CPUs) issue:

SSL_CERT_DIR=/etc/ssl/certs \
python3 ./x.py test --verbose --no-fail-fast | tee rustc-testlog

Some ui tests may fail (the number of failures depends on the length of the absolute path to the rustc-1.71.1-src directory). These failures can be identified by viewing the rustc-testlog file and search for the note: the full type name has been written to... messages and they can be safely ignored.

If FileCheck from LLVM has not been installed, all 47 tests from the assembly suite will fail.

On some systems, scripting the tests may result in the tests hanging on test: combine_install_with_separate_uninstall. If this happens, the problem can be worked around by pressing the Enter key. The test can also be removed with:

sed -e '/runtest combine_install_with/s/^/#/g' -i src/tools/rust-installer/test.sh

As with all large test suites, other tests might fail on some machines - if the number of additional failures is low, check the log for 'failures:' and review lines above that, particularly the 'stderr:' lines. Any mention of SIGSEGV or signal 11 in a failing test is a cause for concern.

If you get any other failing test which reports an issue number then you should search for that issue. For example, when rustc >= 1.41.1 was built with a version of sysllvm before 10.0 the test for issue 69225 failed https://github.com/rust-lang/rust/issues/69225 and that should be regarded as a critical failure (they released 1.41.1 because of it). Most other failures will not be critical.

Therefore, you should determine the number of failures.

The number of tests which passed and failed can be found by running:

grep '^test result:' rustc-testlog |
 awk '{sum1 += $4; sum2 += $6} END { print sum1 " passed; " sum2 " failed" }'

The other available fields are $8 for those which were ignored (i.e. skipped), $10 for 'measured' and $12 for 'filtered out' but both those last two are probably zero.

Now, as the root user, install the package:

Note

If sudo or su is invoked for switching to the root user, ensure LIBSSH2_SYS_USE_PKG_CONFIG is correctly passed or the following command may completely rebuild this package. For sudo, use the --preserve-env=LIBSSH2_SYS_USE_PKG_CONFIG option. For su, do not use the - or --login.

python3 ./x.py install

The building system attempts to install some files twice, and during the second attempt it renames the old one (installed in the first attempt) with the .old suffix. As the root user, remove these files:

find /opt/rustc-1.71.1 -name "*.old" -delete

Still as the root user, symlink a Zsh completion file into the correct location:

install -vdm755 /usr/share/zsh/site-functions      &&
ln -sfv /opt/rustc/share/zsh/site-functions/_cargo \
        /usr/share/zsh/site-functions

Command Explanations

ln -svfn rustc-1.71.1 /opt/rustc: if this is not the first use of the /opt/rustc symlink, overwrite it by forcing, and use the '-n' flag to avoid getting confusing results from e.g. ls -l.

targets = "X86": this avoids building all the available linux cross-compilers (AArch64, MIPS, PowerPC, SystemZ, etc). Unfortunately, rust insists on installing source files for these below /opt/rustc/lib/src.

extended = true: this installs several tools (specified by the tools entry) alongside rustc.

tools = ["cargo", "clippy", "rustdoc", "rustfmt"]: only build the tools from the 'default' profile in binary command rustup which are recommended for most users. The other tools are unlikely to be useful unless using (old) code analyzers or editing the standard library.

channel = "stable": this ensures only stable features can be used, the default in config.toml is to use development features, which is not appropriate for a released version.

[target.x86_64-unknown-linux-gnu]: the syntax of config.toml requires an llvm-config entry for each target for which system-llvm is to be used. Change the target to [target.i686-unknown-linux-gnu] if you are building on 32-bit x86. This whole section may be omitted if you wish to build against the shipped llvm, or do not have clang, but the resulting build will be larger and take longer.

export LIBSSH2_SYS_USE_PKG_CONFIG=1: Allow cargo to link to system libssh2.

SSL_CERT_DIR=/etc/ssl/certs: Work around an issue causing test failures with the CA certificate store layout used by make-ca-1.12.

--verbose: this switch can sometimes provide more information about a test which fails.

--no-fail-fast: this switch ensures that the test suite will not stop at the first error.

Configuring Rust

Configuration Information

If you installed rustc in /opt, you need to update the following configuration files so that rustc is correctly found by other packages and system processes.

As the root user, create the /etc/profile.d/rustc.sh file:

cat > /etc/profile.d/rustc.sh << "EOF"
# Begin /etc/profile.d/rustc.sh

pathprepend /opt/rustc/bin           PATH

# Include /opt/rustc/man in the MANPATH variable to access manual pages
pathappend  /opt/rustc/share/man     MANPATH

# End /etc/profile.d/rustc.sh
EOF

Immediately after installation, update the current PATH for your current shell as a normal user:

source /etc/profile.d/rustc.sh

Contents

Installed Programs: cargo-clippy, cargo-fmt, cargo, clippy-driver, rust-gdb, rust-gdbgui, rust-lldb, rustc, rustdoc, and rustfmt
Installed Libraries: librustc-driver-<16-byte-hash>.so, libstd-<16-byte-hash>.so, and libtest-<16-byte-hash>.so
Installed Directories: ~/.cargo, /opt/rustc, symbolic link to /opt/rustc-1.71.1

Short Descriptions

cargo-clippy

provides lint checks for a cargo package

cargo-fmt

formats all bin and lib files of the current crate using rustfmt

cargo

is the Package Manager for Rust

clippy-driver

provides lint checks for Rust

rust-gdb

is a wrapper script for gdb, pulling in Python pretty-printing modules installed in /opt/rustc-1.71.1/lib/rustlib/etc

rust-gdbgui

is a wrapper script for a graphical front end to gdb that runs in a browser

rust-lldb

is a wrapper script for LLDB (the LLVM debugger) pulling in the Python pretty-printing modules

rustc

is the rust compiler

rustdoc

generates documentation from rust source code

rustfmt

formats rust code

libstd-<16-byte-hash>.so

is the Rust Standard Library, the foundation of portable Rust software

SCons-4.5.2

Introduction to SCons

SCons is a tool for building software (and other files) implemented in Python.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

SCons Dependencies

Optional

docbook-xsl-nons-1.79.2 and libxslt-1.1.38

Installation of SCons

Install SCons by running the following commands as the root user:

sed -i 's/env python/&3/' SCons/Utilities/*.py &&

python3 setup.py install --prefix=/usr \
                         --optimize=1  &&

mv -v /usr/lib/python3.11/site-packages/SCons-4.5.2-py3.11.egg/*.1 \
      /usr/share/man/man1

Contents

Installed Programs: scons, scons-configure-cache, and sconsign
Installed Libraries: None
Installed Directory: /usr/lib/python3.11/site-packages/SCons

Short Descriptions

scons

is a software construction tool

scons-configure-cache

shows or converts the configuration of an SCons cache directory

sconsign

prints SCons .sconsign file information

slang-2.3.3

Introduction to slang

S-Lang (slang) is an interpreted language that may be embedded into an application to make the application extensible. It provides facilities required by interactive applications such as display/screen management, keyboard input and keymaps.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Slang Dependencies

Optional

libpng-1.6.40, PCRE-8.45, and Oniguruma

Installation of Slang

Note

This package does not support parallel build.

Install slang by running the following commands:

./configure --prefix=/usr \
            --sysconfdir=/etc \
            --with-readline=gnu &&
make -j1

To test the results, issue: make check.

Now, as the root user:

make install_doc_dir=/usr/share/doc/slang-2.3.3   \
     SLSH_DOC_DIR=/usr/share/doc/slang-2.3.3/slsh \
     install

Command Explanations

--with-readline=gnu: This parameter sets GNU Readline to be used by the parser interface instead of the slang internal version.

make install_doc_dir=/usr/share/doc/slang-2.3.3 SLSH_DOC_DIR=/usr/share/doc/slang-2.3.3/slsh install: This command installs this package with a versioned documentation installation directory.

Configuring slang

Config Files

~/.slshrc and /etc/slsh.rc

Contents

Installed Program: slsh
Installed Libraries: libslang.so and numerous support modules
Installed Directories: /usr/lib/slang, /usr/share/doc/slang-2.3.3 and /usr/share/slsh

Short Descriptions

slsh

is a simple program for interpreting slang scripts. It supports dynamic loading of slang modules and includes a Readline interface for interactive use

Subversion-1.14.2

Introduction to Subversion

Subversion is a version control system that is designed to be a compelling replacement for CVS in the open source community. It extends and enhances CVS' feature set, while maintaining a similar interface for those already familiar with CVS. These instructions install the client and server software used to manipulate a Subversion repository. Creation of a repository is covered at Running a Subversion Server.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://archive.apache.org/dist/subversion/subversion-1.14.2.tar.bz2

  • Download MD5 sum: 9927b167d1c67d663ca63125907f6f69

  • Download size: 8.3 MB

  • Estimated disk space required: 208 MB (add 228 MB for bindings, 52 MB for docs, 1.3 GB for tests)

  • Estimated build time: 0.5 SBU (Using parallelism=4; add 1.9 SBU for bindings, 35 SBU for tests)

Subversion Dependencies

Required

Apr-Util-1.6.3 and SQLite-3.42.0

Recommended
Optional

Apache-2.4.57, Boost-1.83.0, Cyrus SASL-2.1.28, dbus-1.14.8, Doxygen-1.9.7 (for generating HTML documentation), gnome-keyring-42.1, libsecret-0.21.0, Py3c-1.4 (for the python bindings, and tests) Python-2.7.18 (with sqlite support for the tests), Ruby-3.2.2, SWIG-4.1.1 (for building Perl, Python and Ruby bindings), LZ4, and UTF8proc

Optional (for the Java Bindings)

One of OpenJDK-20.0.2, Dante or Jikes, JUnit 4 (to test the Java bindings) and apache-ant-1.10.14.

Installation of Subversion

First, adapt some Python scripts to use python3:

grep -rl '^#!.*python$' | xargs sed -i '1s/python/&3/'

Next, adapt the Ruby bindings to Ruby-3.2:

sed -e 's/File.exists?/File.exist?/'               \
    -i subversion/bindings/swig/ruby/svn/util.rb   \
       subversion/bindings/swig/ruby/test/test_wc.rb

Install Subversion by running the following commands:

PYTHON=python3 ./configure --prefix=/usr             \
            --disable-static          \
            --with-apache-libexecdir  \
            --with-lz4=internal       \
            --with-utf8proc=internal &&
make

If you have Doxygen-1.9.7 installed and you wish to build the API documentation, issue:

doxygen doc/doxygen.conf

If you wish to build the Java bindings pass the --enable-javahl parameter to the configure command. In addition, if you want to run the Java test suite, you have to specify the location of the JUnit file by adding --with-junit=<path to junit jar> (for instance --with-junit=/usr/local/java/lib/junit-4.13.jar) to configure. The JUnit jar file is no longer included in apache-ant-1.10.14 and must be downloaded separately. To build the Java bindings, issue the following command:

make -j1 javahl

If you want to compile Perl, Python, or Ruby bindings, issue any of the following command:

make swig-pl # for Perl
make swig-py \
     swig_pydir=/usr/lib/python3.11/site-packages/libsvn \
     swig_pydir_extra=/usr/lib/python3.11/site-packages/svn # for Python
make swig-rb # for Ruby

To test the results, issue: make check. Four tests in the commit_tests.py, prop_tests.py, and update_tests.py suites are known to fail.

To test the results of any of the SWIG bindings, you can use any of the following commands: make check-swig-pl, make check-swig-py, or make check-swig-rb.

Now, as the root user:

make install &&

install -v -m755 -d /usr/share/doc/subversion-1.14.2 &&
cp      -v -R doc/* /usr/share/doc/subversion-1.14.2

If you built the Java bindings, issue the following command as the root user to install them:

make install-javahl

If you built the Perl, Python, or Ruby bindings, issue any of the following commands as the root user to install them:

make install-swig-pl
make install-swig-py \
      swig_pydir=/usr/lib/python3.11/site-packages/libsvn \
      swig_pydir_extra=/usr/lib/python3.11/site-packages/svn
make install-swig-rb

The java bindings need to be installed in order for the tests to run, since the tests attempt to look for them in CLASSPATH. To test the results of the Java bindings build, issue LANG=C make check-javahl.

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--with-apache-libexecdir: If Apache-2.4.57 is installed, the shared Apache modules are built. This switch allows to have those modules installed to Apache's configured module dir instead of /usr/libexec. It has no effect if Apache is not installed.

--with-lz4=internal, --with-utf8proc=internal: Remove these switches if you have installed the optional dependencies.

--enable-javahl: enables compilation of Java high level bindings. Running make javahl is necessary to do the compilation.

--with-junit=<location of the junit jar file>: gives the location of the junit jar, otherwise the javahl tests cannot be run.

--disable-gmock: Do not use the Googlemock testing framework.

Configuring Subversion

Config Files

~/.subversion/config and /etc/subversion/config

Configuration Information

/etc/subversion/config is the Subversion system-wide configuration file. This file is used to specify defaults for different svn commands.

~/.subversion/config is the user's personal configuration file. It is used to override the system-wide defaults set in /etc/subversion/config.

Contents

Installed Programs: svn, svnadmin, svnbench, svndumpfilter, svnfsfs, svnlook, svnmucc, svnrdump, svnserve, svnsync, and svnversion
Installed Libraries: libsvn_*-1.so and optionally, a Java library, the mod_dav_svn.so and and mod_authz_svn.so Apache HTTP DSO modules and various Perl, Python and Ruby modules.
Installed Directories: /usr/include/subversion-1, /usr/lib/perl5/site_perl/5.38/{,auto/}SVN, /usr/lib/python3.11/site-packages/{libsvn,svn}, /usr/lib/ruby/site_ruby/<x.y.z>/{,<arch-linux>-linux/}svn, /usr/lib/svn-javahl, and /usr/share/doc/subversion-1.14.2

Short Descriptions

svn

is a command-line client program used to access Subversion repositories

svnadmin

is a tool for creating, tweaking or repairing a Subversion repository

svnbench

is a benchmarking tool

svndumpfilter

is a program for filtering Subversion repository dumpfile format streams

svnfsfs

is the FSFS (FileSystem atop of the FileSystem - Subversion filesystem implementation) repository manipulation tool

svnlook

is a tool for inspecting a Subversion repository

svnmucc

is a Multiple URL Command Client for Subversion

svnrdump

is a tool for dumping or loading a remote Subversion repository

svnserve

is a custom standalone server program, able to run as a daemon process or invoked by SSH

svnsync

is a Subversion repository synchronisation tool

svnversion

is used to report the version number and state of a working Subversion repository copy

libsvn_*-1.so

are the support libraries used by the Subversion programs

mod_authz_svn.so

is a plug-in module for the Apache HTTP server, used to authenticate users to a Subversion repository over the Internet or an intranet

mod_dav_svn.so

is a plug-in module for the Apache HTTP server, used to make a Subversion repository available to others over the Internet or an intranet

Running a Subversion Server

Running a Subversion Server

This section will describe how to set up, administer and secure a Subversion server.

Subversion Server Dependencies

Required

Subversion-1.14.2 and OpenSSH-9.4p1

Setting up a Subversion Server.

The following instructions will install a Subversion server, which will be set up to use OpenSSH as the secure remote access method, with svnserve available for anonymous access.

Configuration of the Subversion server consists of the following steps:

1. Set Uup Users, Groups, and Permissions

You'll need to be user root for the initial portion of configuration. Create the svn user and group with the following commands:

groupadd -g 56 svn &&
useradd -c "SVN Owner" -d /home/svn -m -g svn -s /bin/false -u 56 svn

If you plan to have multiple repositories, you should have a group dedicated to each repository for ease of administration. Create the svntest group for the test repository and add the svn user to that group with the following commands:

groupadd -g 57 svntest &&
usermod -G svntest -a svn

Additionally you should set umask 002 while working with a repository so that all new files will be writable by owner and group. This is made mandatory by creating a wrapper script for svn and svnserve:

mv /usr/bin/svn /usr/bin/svn.orig &&
mv /usr/bin/svnserve /usr/bin/svnserve.orig &&
cat >> /usr/bin/svn << "EOF"
#!/bin/sh
umask 002
/usr/bin/svn.orig "$@"
EOF
cat >> /usr/bin/svnserve << "EOF"
#!/bin/sh
umask 002
/usr/bin/svnserve.orig "$@"
EOF
chmod 0755 /usr/bin/svn{,serve}

Note

If you use Apache for working with the repository over HTTP, even for anonymous access, you should wrap /usr/sbin/httpd in a similar script.

2. Create a Subversion repository.

There are several ways to set up a subversion repository. It is recommended to have a look at the SVN Book corresponding chapter. A basic repository can be set up with the instructions below.

Create a new Subversion repository with the following commands (as the root user):

install -v -m 0755 -d /srv/svn &&
install -v -m 0755 -o svn -g svn -d /srv/svn/repositories &&
svnadmin create /srv/svn/repositories/svntest

Now that the repository is created, it should be populated with something useful. You'll need to have a predefined directory layout set up exactly as you want your repository to look. For example, here is a sample BLFS layout setup with a root of svntest/. You'll need to set up a directory tree similar to the following:

svntest/            # The name of the repository
   trunk/           # Contains the existing source tree
      BOOK/
      bootscripts/
      edguide/
      patches/
      scripts/
   branches/        # Needed for additional branches
   tags/            # Needed for tagging release points

Once you've created your directory layout as shown above, you are ready to do the initial import:

svn import -m "Initial import." \
    </path/to/source/tree>      \
    file:///srv/svn/repositories/svntest

Now change owner and group information on the repository, and add an unprivileged user to the svn and svntest groups:

chown -R svn:svntest /srv/svn/repositories/svntest    &&
chmod -R g+w         /srv/svn/repositories/svntest    &&
chmod g+s            /srv/svn/repositories/svntest/db &&
usermod -G svn,svntest -a <username>

svntest is the group assigned to the svntest repository. As mentioned earlier, this eases administration of multiple repositories when using OpenSSH for authentication. Going forward, you'll need to add your unprivileged user, and any additional users that you wish to have write access to the repository, to the svn and svntest groups.

In addition, you'll notice that the new repository's db directory is set-groupID. If the reasoning is not immediately obvious, when using any external authentication method (such as ssh), the sticky bit is set so that all new files will be owned by the user, but group of svntest. Anyone in the svntest group can create files, but still give the entire group write access to those files. This avoids locking out other users from the repository.

Now, return to an unprivileged user account, and take a look at the new repository using svnlook:

svnlook tree /srv/svn/repositories/svntest/

Note

You may need to log out and back in again to refresh your group memberships. su <username> should work as well.

3. Configure the Server

As mentioned previously, these instructions will configure the server to use only ssh for write access to the repository and to provide anonymous access using svnserve. There are several other ways to provide access to the repository. These additional configurations are best explained at https://svnbook.red-bean.com/.

Access configuration needs to be done for each repository. Create the svnserve.conf file for the svntest repository using the following commands:

cp /srv/svn/repositories/svntest/conf/svnserve.conf \
   /srv/svn/repositories/svntest/conf/svnserve.conf.default &&

cat > /srv/svn/repositories/svntest/conf/svnserve.conf << "EOF"
[general]
anon-access = read
auth-access = write
EOF

There is not a lot to the configuration file at all. You'll notice that only the general section is required. Take a look at the svnserve.conf.default file for information on using svnserve's built-in authentication method.

4. Starting the Server

To start the server at boot time, install the svnserve.service unit from the blfs-systemd-units-20230816 package:

make install-svnserve

Additionally, the instructions above require that svn server uses umask 002 so that all new files will be writable by owner and group. This can be achieved by creating a systemd unit override file by running the following command:

mkdir -p /etc/systemd/system/svnserve.service.d
echo "UMask=0002" > /etc/systemd/system/svnserve.service.d/99-user.conf

Options which are passed to svnserve daemon can be changed in /etc/default/svnserve.

SWIG-4.1.1

Introduction to SWIG

SWIG (Simplified Wrapper and Interface Generator) is a compiler that integrates C and C++ with languages including Perl, Python, Tcl, Ruby, PHP, Java, C#, D, Go, Lua, Octave, R, Scheme, and Ocaml. SWIG can also export its parse tree into Lisp s-expressions and XML.

SWIG reads annotated C/C++ header files and creates wrapper code (glue code) in order to make the corresponding C/C++ libraries available to the listed languages, or to extend C/C++ programs with a scripting language.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://downloads.sourceforge.net/swig/swig-4.1.1.tar.gz

  • Download MD5 sum: c7d55a1bca26752f3846c85b43c1a69c

  • Download size: 8.2 MB

  • Estimated disk space required: 82 MB (2.1 GB with tests)

  • Estimated build time: 0.1 SBU (add 7.8 SBU for tests; both using parallelism=4)

SWIG Dependencies

Required

pcre2-10.42

Optional

Boost-1.83.0 for tests, and any of the languages mentioned in the introduction, as run-time dependencies

Installation of SWIG

Install SWIG by running the following commands:

./configure --prefix=/usr                      \
            --without-javascript               \
            --without-maximum-compile-warnings &&
make

To test the results, issue: PY3=1 make -k check TCL_INCLUDE=. The unsetting of the variable TCL_INCLUDE is necessary since it is not correctly set by configure. The tests are only executed for the languages installed on your machine, so the disk space and SBU values given for the tests may vary, and should be considered as mere orders of magnitude. According to SWIG's documentation, the failure of some tests should not be considered harmful. The go tests are buggy and may generate a lot of meaningless output.

Now, as the root user:

make install &&
install -v -m755 -d /usr/share/doc/swig-4.1.1 &&
cp -v -R Doc/* /usr/share/doc/swig-4.1.1

Command Explanations

--without-maximum-compile-warnings: disables compiler ansi conformance enforcement, which triggers errors in the Lua headers (starting with Lua 5.3).

--without-<language>: allows disabling the building of tests and examples for <language>, but all the languages capabilities of SWIG are always built.

Contents

Installed Programs: swig and ccache-swig
Installed Library: None
Installed Directories: /usr/share/doc/swig-4.1.1 and /usr/share/swig

Short Descriptions

swig

takes an interface file containing C/C++ declarations and SWIG special instructions, and generates the corresponding wrapper code needed to build extension modules

ccache-swig

is a compiler cache, which speeds up re-compilation of C/C++/SWIG code

Sysprof-3.48.0

Introduction to Sysprof

The sysprof package contains a statistical and system-wide profiler for Linux.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Sysprof Dependencies

Required

desktop-file-utils-0.26, GTK-4.12.0, itstool-2.0.7, JSON-GLib-1.6.6, libadwaita-1.3.4, libdazzle-3.44.0, libunwind-1.6.2, and Polkit-123

Installation of Sysprof

Install Sysprof by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Contents

Installed Programs: sysprof, sysprof-agent, and sysprof-cli
Installed Libraries: libsysprof-4.so, libsysprof-capture-4.a, libsysprof-memory-4.so, libsysprof-speedtrack-4.so, and libsysprof-ui-5.so
Installed Directories: /usr/include/sysprof-4, /usr/include/sysprof-ui-5, and /usr/share/help/*/sysprof

Short Descriptions

sysprof

is a graphical interface to sysprof

sysprof-agent

is used to profile applications in containers

sysprof-cli

is a command line interface to sysprof

libsysprof-4.so

provides API functions for profiling processes running on a system

libsysprof-capture-4.a

provides a hook used to capture statistics from a process

libsysprof-memory-4.so

provides API functions for capturing memory statistics

libsysprof-speedtrack-4.so

provides API functions for tracking the speed of a running process

libsysprof-ui-4.so

provides API functions for the sysprof GUI

Tk-8.6.13

Introduction to Tk

The Tk package contains a TCL GUI Toolkit.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Tk Dependencies

Required

Xorg Libraries

Installation of Tk

Install Tk by running the following commands:

cd unix &&
./configure --prefix=/usr \
            --mandir=/usr/share/man \
            $([ $(uname -m) = x86_64 ] && echo --enable-64bit) &&

make &&

sed -e "s@^\(TK_SRC_DIR='\).*@\1/usr/include'@" \
    -e "/TK_B/s@='\(-L\)\?.*unix@='\1/usr/lib@" \
    -i tkConfig.sh

Running the tests is not recommended. Failures will be reported during the tests, depending on the screen resolution/capabilities, fonts installed and other X related parameters, but the end report can show 0 failures. Some tests will steal focus and some might crash your X Server. To test the results anyway, issue: make test. Ensure you run it from an X Window display device with the GLX extensions loaded, but even so, tests might hang.

Now, as the root user:

make install &&
make install-private-headers &&
ln -v -sf wish8.6 /usr/bin/wish &&
chmod -v 755 /usr/lib/libtk8.6.so

Command Explanations

$([ $(uname -m) = x86_64 ] && echo --enable-64bit): This switch is used to enable 64 bit support in Tk on 64 bit operating systems.

make install-private-headers: This command is used to install the Tk library interface headers used by other packages if they link to the Tk library.

ln -v -sf wish8.6 /usr/bin/wish: This command is used to create a compatibility symbolic link to the wish8.6 file as many packages expect a file named wish.

sed -e ... tkConfig.sh: The Tk package expects that its source tree is preserved so that packages depending on it for their compilation can utilize it. This sed removes the references to the build directory and replaces them with saner system-wide locations.

Contents

Installed Programs: wish and wish8.6
Installed Libraries: libtk8.6.so and libtkstub8.6.a
Installed Directory: /usr/lib/tk8.6

Short Descriptions

wish

is a symlink to the wish8.6 program

wish8.6

is a simple shell containing the Tk toolkit that creates a main window and then processes Tcl commands

libtk8.6.so

contains the API functions required by Tk

unifdef-2.12

Introduction to unifdef

The unifdef package contains a utility that is useful for removing preprocessor conditionals from code.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of unifdef

Install unifdef by running the following commands:

make

To test the results, issue: make test.

Now, as the root user:

make prefix=/usr install

Contents

Installed Programs: unifdef and unifdefall
Installed Libraries: None
Installed Directories: None

Short Descriptions

unifdef

removes preprocessor conditionals from code

unifdefall

removes preprocessor conditionals from code across a whole tree

Vala-0.56.11

Introduction to Vala

Vala is a new programming language that aims to bring modern programming language features to GNOME developers without imposing any additional runtime requirements and without using a different ABI compared to applications and libraries written in C.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Vala Dependencies

Required

GLib-2.76.4

Recommended
Optional

dbus-1.14.8 (Required for the tests), libxslt-1.1.38 (Required for generating the documentation), help2man, jing, and weasyprint

Installation of Vala

Install Vala by running the following commands:

./configure --prefix=/usr &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--disable-valadoc: This option is required if Graphviz-8.1.0 is not installed.

Contents

Installed Programs: vala, vala-0.56, valac, valadoc, vala-gen-introspect, and vapigen (symlinks); valac-0.56, valadoc-0.56, vala-gen-introspect-0.56, and vapigen-0.56
Installed Library: libvala-0.56.so and libvaladoc-0.56.so
Installed Directories: /usr/include/vala-0.56, /usr/include/valadoc-0.56, /usr/lib/vala-0.56, /usr/lib/valadoc-0.56, /usr/share/vala, /usr/share/vala-0.56, /usr/share/valadoc-0.56, and /usr/share/devhelp/books/vala-0.56

Short Descriptions

valac

is a compiler that translates Vala source code into C source and header files

valadoc

is a documentation generator for generating API documentation from Vala source code based on libvala

vala-gen-introspect

generates a GI file for GObject and GLib based packages

vapigen

is an utility which generates Vala API (VAPI) files from GI files

libvala-0.56.so

contains the Vala API functions

Valgrind-3.21.0

Introduction to Valgrind

Valgrind is an instrumentation framework for building dynamic analysis tools. There are Valgrind tools that can automatically detect many memory management and threading bugs, and profile programs in detail. Valgrind can also be used to build new tools.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Valgrind Dependencies

Optional

GDB-13.2 (for tests), LLVM-16.0.5 (with Clang), and Which-2.21 (for tests)

Installation of Valgrind

Install Valgrind by running the following commands:

sed -i 's|/doc/valgrind||' docs/Makefile.in &&

./configure --prefix=/usr \
            --datadir=/usr/share/doc/valgrind-3.21.0 &&
make

To test the results, issue: make regtest. The tests may hang forever if GDB-13.2 is not installed. Some tests are known to hang also, depending on the version of glibc. A few tests can fail in various suites. Problematic tests can be disabled by changing the prereq: line in the corresponding .vgtest file to prereq: false. For example:

sed -e 's@prereq:.*@prereq: false@' \
    -i {helgrind,drd}/tests/pth_cond_destroy_busy.vgtest

Note

The OpenMP tests are skipped if libgomp has been compiled with --enable-linux-futex (the default). If needed, just recompile the libgomp library from the gcc build tree, passing --disable-linux-futex to configure, storing the library to some place and changing the link from /usr/lib/libgomp.so.1 to point to the new library.

Now, as the root user:

make install

Command Explanations

sed -i ... docs/Makefile.in : This sed provides for installing the documentation in a versioned directory.

--enable-lto=yes: This option allows building Valgrind with LTO (link time optimization). This produces a smaller/faster Valgrind (up to 10%), but build time increases to about 5.5 SBU.

Contents

Installed Programs: callgrind_annotate, callgrind_control, cg_annotate, cg_diff, cg_merge, ms_print, valgrind, valgrind-di-server, valgrind-listener, and vgdb
Installed Libraries: None
Installed Directories: /usr/lib/valgrind, /usr/libexec/valgrind, /usr/include/valgrind, and /usr/share/doc/valgrind-3.21.0

Short Descriptions

valgrind

is a program for debugging and profiling Linux executables

callgrind_annotate

takes an output file produced by the Valgrind tool Callgrind and prints the information in an easy-to-read form

callgrind_control

controls programs being run by the Valgrind tool Callgrind

cg_annotate

is a post-processing tool for the Valgrind tool Cachegrind

cg_diff

compares two Cachegrind output files

cg_merge

merges multiple Cachegrind output files into one

ms_print

takes an output file produced by the Valgrind tool Massif and prints the information in an easy-to-read form

valgrind-di-server

is a server that reads debuginfo from objects stored on a different machine

valgrind-listener

listens on a socket for Valgrind commentary

vgdb

is an intermediary between Valgrind and GDB or a shell

yasm-1.3.0

Introduction to yasm

Yasm is a complete rewrite of the NASM-2.16.01 assembler. It supports the x86 and AMD64 instruction sets, accepts NASM and GAS assembler syntaxes and outputs binary, ELF32 and ELF64 object formats.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

yasm Dependencies

Optional

Python-2.7.18 and cython-0.29.36

Installation of yasm

Install yasm by running the following commands:

sed -i 's#) ytasm.*#)#' Makefile.in &&

./configure --prefix=/usr &&
make

To test the results, issue: make -j1 check.

Now, as the root user:

make install

Command Explanations

sed -i 's#) ytasm.*#)#' Makefile.in: This sed prevents it compiling 2 programs (vsyasm and ytasm) that are only of use on Microsoft Windows.

Contents

Installed Program: yasm
Installed Library: libyasm.a
Installed Directory: /usr/include/libyasm

Short Descriptions

yasm

is a portable, retargetable assembler that supports the x86 and AMD64 instruction sets, accepts NASM and GAS assembler syntaxes and outputs binaries in ELF32 and ELF64 object formats

libyasm.a

provides all of the core functionality of yasm, for manipulating machine instructions and object file constructs

Java

Java-20.0.2

About Java

Java is different from most of the packages in LFS and BLFS. It is a programming language that works with files of bytecode to obtain instructions and executes them in a Java Virtual Machine (JVM). An introductory java program looks like:

public class HelloWorld
{
    public static void main(String[] args)
    {
        System.out.println("Hello, World");
    }
}

This program is saved as HelloWorld.java. The file name, HelloWorld, must match the class name. It is then converted into byte code with javac HelloWorld.java. The output file is HelloWorld.class. The program is executed with java HelloWorld. This creates a JVM and runs the code. The 'class' extension must not be specified.

Several class files can be combined into one file with the jar command. This is similar to the standard tar command. For instance, the command jar cf myjar.jar *.class will combine all class files in a directory into one jar file. These act as library files.

The JVM can search for and use classes in jar files automatically. It uses the CLASSPATH environment variable to search for jar files. This is a standard list of colon-separated directory names similar to the PATH environment variable.

Binary JDK Information

Creating a JVM from source requires a set of circular dependencies. The first thing that's needed is a set of programs called a Java Development Kit (JDK). This set of programs includes java, javac, jar, and several others. It also includes several base jar files.

To start, we set up a binary installation of the JDK created by the BLFS editors. It is installed in the /opt directory to allow for multiple installations, including a source based version.

This package is known to build and work properly using an LFS 12.0 platform.

Binary Package Information

Java Binary Runtime Dependencies

alsa-lib-1.2.9, Cups-2.4.6, giflib-5.2.1, and Xorg Libraries

Installation of the Java BinaryJDK

Begin by extracting the appropriate binary tarball for your architecture and changing to the extracted directory. Install the binary OpenJDK with the following commands as the root user:

install -vdm755 /opt/OpenJDK-20.0.2-bin &&
mv -v * /opt/OpenJDK-20.0.2-bin         &&
chown -R root:root /opt/OpenJDK-20.0.2-bin

The binary version is now installed. You may create a symlink to that version by issuing, as the root user:

ln -sfn OpenJDK-20.0.2-bin /opt/jdk

You may now proceed to Configuring the JAVA environment, where the instructions assume that the above link exists.

OpenJDK-20.0.2

Introduction to OpenJDK

OpenJDK is an open-source implementation of Oracle's Java Standard Edition platform. OpenJDK is useful for developing Java programs, and provides a complete runtime environment to run Java programs.

This package is known to build and work properly using an LFS 12.0 platform.

OpenJDK is GPL'd code, with a special exception made for non-free projects to use these classes in their proprietary products. In similar fashion to the LGPL, which allows non-free programs to link to libraries provided by free software, the GNU General Public License, version 2, with the Classpath Exception allows third party programs to use classes provided by free software without the requirement that the third party software also be free. As with the LGPL, any modifications made to the free software portions of a third party application, must also be made freely available.

Note

The OpenJDK source includes a very thorough, open source test suite using the JTreg test harness. The testing instructions below allow testing the just built JDK for reasonable compatibility with the proprietary Oracle JDK. However, in order for an independent implementation to claim compatibility, it must pass a proprietary JCK/TCK test suite. No claims of compatibility, or even partial compatibility, may be made without passing an approved test suite.

Oracle does provide free community access, on a case by case basis, to a closed toolkit to ensure 100% compatibility with its proprietary JDK. Neither the binary version provided on the Java-20.0.2 page nor the JVM built with the instructions below have been tested against the TCK. Any version that is built using the instructions given, cannot claim to be compatible with the proprietary JDK, without the user applying for, and completing the compatibility tests themselves.

With that in mind, the binaries produced using this build method are regularly tested against the TCK by the members listed on the site above. In addition to the community license above, an educational, non-commercial license for the TCK can be obtained here.

Package Information

Additional Downloads

Optional test harness

OpenJDK Dependencies

Required Dependencies

An existing binary (Java-20.0.2 or an earlier built version of this package. The instructions below assume that you are using Configuring the JAVA environment), alsa-lib-1.2.9, cpio-2.14, Cups-2.4.6, UnZip-6.0, Which-2.21, Xorg Libraries, and Zip-3.0

Recommended
Optional

git-2.41.0, Graphviz-8.1.0, Mercurial-6.5.1, ccache, pandoc, and pigz

Installation of OpenJDK

If you have downloaded the optional test harness, unpack it now:

tar -xf ../jtreg-7.2+1.tar.gz

Note

Before proceeding, you should ensure that your environment PATH variable contains the location of the Java compiler used for bootstrapping OpenJDK. This is the only requirement for the environment. Modern Java installations do not need JAVA_HOME and CLASSPATH is not used here. Furthermore, OpenJDK developers recommend unsetting JAVA_HOME.

The build system does not allow the -j switch in MAKEFLAGS. See the command explanation for --with-jobs= for more information on customizing parallelization.

Configure and build the package with the following commands:

unset JAVA_HOME                             &&
bash configure --enable-unlimited-crypto    \
               --disable-warnings-as-errors \
               --with-stdc++lib=dynamic     \
               --with-giflib=system         \
               --with-harfbuzz=system       \
               --with-jtreg=$PWD/jtreg      \
               --with-lcms=system           \
               --with-libjpeg=system        \
               --with-libpng=system         \
               --with-zlib=system           \
               --with-version-build="9"     \
               --with-version-pre=""        \
               --with-version-opt=""        \
               --with-cacerts-file=/etc/pki/tls/java/cacerts &&
make images

To test the results, you will need to execute the jtreg program. You can set the number of concurrent tests by adding the -conc:<X> value in the below command (tests will run sequentially otherwise):

export JT_JAVA=$(echo $PWD/build/*/jdk) &&
jtreg/bin/jtreg -jdk:$JT_JAVA -automatic -ignore:quiet -v1 \
    test/jdk:tier1 test/langtools:tier1 &&
unset JT_JAVA

For more control over the test suite, review the documentation available in jtreg/doc/jtreg/usage.txt. To review the results, see the files JTreport/test_{jdk,langtools}/text/stats.txt and JTreport/test_{jdk,langtools}/text/summary.txt. You should expect to see around 60 failures and 10 errors.

Install the package with the following commands as the root user:

install -vdm755 /opt/jdk-20.0.2+9             &&
cp -Rv build/*/images/jdk/* /opt/jdk-20.0.2+9 &&
chown -R root:root /opt/jdk-20.0.2+9          &&
for s in 16 24 32 48; do
  install -vDm644 src/java.desktop/unix/classes/sun/awt/X11/java-icon${s}.png \
                  /usr/share/icons/hicolor/${s}x${s}/apps/java.png
done

Note

If you only wish to install the Java Runtime Environment, you can substitute build/*/images/jre in the above cp command.

There are now two OpenJDK SDKs installed in /opt. You should decide on which one you would like to use as the default. Normally, you would opt for the just installed OpenJDK. If so, do the following as the root user:

ln -v -nsf jdk-20.0.2+9 /opt/jdk

If desired, you can create .desktop files to add entries in the menu for java and jconsole. The needed icons have already been installed. As the root user:

mkdir -pv /usr/share/applications &&

cat > /usr/share/applications/openjdk-java.desktop << "EOF" &&
[Desktop Entry]
Name=OpenJDK Java 20.0.2 Runtime
Comment=OpenJDK Java 20.0.2 Runtime
Exec=/opt/jdk/bin/java -jar
Terminal=false
Type=Application
Icon=java
MimeType=application/x-java-archive;application/java-archive;application/x-jar;
NoDisplay=true
EOF
cat > /usr/share/applications/openjdk-jconsole.desktop << "EOF"
[Desktop Entry]
Name=OpenJDK Java 20.0.2 Console
Comment=OpenJDK Java 20.0.2 Console
Keywords=java;console;monitoring
Exec=/opt/jdk/bin/jconsole
Terminal=false
Type=Application
Icon=java
Categories=Application;System;
EOF

Command Explanations

bash configure...: the top level configure is a wrapper around the autotools one. It is not executable and must be run through bash.

--enable-unlimited-crypto: Because of limitations on the usage of cryptography in some countries, there is the possibility to limit the size of encryption keys and the use of some algorithms in a policy file. This switch allows to ship a policy file with no restriction. It is the responsibility of the user to ensure proper adherence to the law.

--disable-warnings-as-errors: This switch disables use of -Werror in the build.

--with-stdc++lib=dynamic: This switch forces the build system to link to libstdc++.so (dynamic) instead of libstdc++.a (static).

--with-jobs=<X>: The -j passed to make does not work with make as invoked here. By default, the build system will use the number of CPUs - 1.

--with-jtreg=$PWD/jtreg: This switch tells configure where to find jtreg. Omit if you have not downloaded the optional test suite.

--with-{giflib,harfbuzz,lcms,libjpeg,libpng,zlib}=system: These switches force the build system to use the system libraries instead of the bundled versions.

--with-version-build: Currently, the build system does not include the build number in the version string. It has to be specified here.

--with-version-pre: This switch allows you to prefix the version string with a custom string.

--with-version-opt: This switch allows you to add an optional build description to the version string.

--with-cacerts-file=/etc/pki/tls/java/cacerts: Specifies where to find a cacerts file, /etc/pki/tls/java/ on a BLFS system. Otherwise, an empty one is created. You can use the /usr/sbin/make-ca --force command to generate it, once you have installed the Java binaries.

--with-boot-jdk: This switch provides the location of the temporary JDK. It is normally not needed if java is found in the PATH.

Configuring OpenJDK

Configuration Information

Normally, the JAVA environment has been configured after installing the binary version, and can be used with the just built package as well. Review Configuring the JAVA environment in case you want to modify something.

To test if the man pages are correctly installed, issue source /etc/profile and man java to display the respective man page.

Setting up the JRE Certificate Authority Certificates (cacerts) file

If you have run the instructions on the make-ca-1.12 page, you only need to create a symlink in the default location for the cacerts file. As user root:

ln -sfv /etc/pki/tls/java/cacerts /opt/jdk/lib/security/cacerts

To check the installation, issue:

cd /opt/jdk
bin/keytool -list -cacerts

At the prompt Enter keystore password:, enter changeit (the default) or just press the Enter key. If the cacerts file was installed correctly, you will see a list of the certificates with related information for each one. If not, you need to reinstall them.

Contents

Installed Programs: jar, jarsigner, java, javac, javadoc, javap, jcmd, jconsole, jdb, jdeprscan, jdeps, jfr, jhsdb, jimage, jinfo, jlink, jmap, jmod, jpackage, jps, jrunscript, jshell, jstack, jstat, jstatd, jwebserver, keytool, rmiregistry, and serialver
Installed Libraries: /opt/jdk-20.0.2/lib/*
Installed Directory: /opt/jdk-20.0.2

Short Descriptions

jar

combines multiple files into a single jar archive

jarsigner

signs jar files and verifies the signatures and integrity of a signed jar file

java

launches a Java application by starting a Java runtime environment, loading a specified class and invoking its main method

javac

reads class and interface definitions, written in the Java programming language, and compiles them into bytecode class files

javadoc

parses the declarations and documentation comments in a set of Java source files and produces a corresponding set of HTML pages describing the classes, interfaces, constructors, methods, and fields

javap

disassembles a Java class file

jcmd

is a utility to send diagnostic command requests to a running Java Virtual Machine

jconsole

is a graphical console tool to monitor and manage both local and remote Java applications and virtual machines

jdb

is a simple command-line debugger for Java classes

jdeprscan

scans class or jar files for uses of deprecated API elements

jdeps

shows the package-level or class-level dependencies of Java class files

jfr

is a tool for working with Flight Recorder files

jhsdb

is a tool to analyze the content of a core dump from a crashed Java Virtual Machine (JVM)

jimage

is used to list, extract, verify, or get information about modules in jimage format

jinfo

prints Java configuration information for a given Java process, core file, or a remote debug server

jlink

is used to assemble and optimize a set of modules and their dependencies into a custom runtime image

jmap

prints shared object memory maps or heap memory details of a given process, core file, or a remote debug server

jmod

creates JMOD files and lists the content of existing JMOD files

jpackage

generates java application packages and images

jps

lists the instrumented JVMs on the target system

jrunscript

is a command line script shell

jshell

is an interactive tool for learning the Java programming language and prototyping Java code

jstack

prints Java stack traces of Java threads for a given Java process, core file, or a remote debug server

jstat

displays performance statistics for an instrumented JVM

jstatd

is an RMI server application that monitors for the creation and termination of instrumented JVMs

jwebserver

provides a minimal HTTP server, designed to be used for prototyping, testing, and debugging

keytool

is a key and certificate management utility

rmiregistry

creates and starts a remote object registry on the specified port on the current host

serialver

returns the serialVersionUID for one or more classes in a form suitable for copying into an evolving class

Configuring the JAVA environment

Setting up the environment

After the package installation is complete, the next step is to make sure that the system can properly find the files. If you set up your login scripts as recommended in The Bash Shell Startup Files, update the environment by creating the openjdk.sh script, as the root user:

cat > /etc/profile.d/openjdk.sh << "EOF"
# Begin /etc/profile.d/openjdk.sh

# Set JAVA_HOME directory
JAVA_HOME=/opt/jdk

# Adjust PATH
pathappend $JAVA_HOME/bin

# Add to MANPATH
pathappend $JAVA_HOME/man MANPATH

# Auto Java CLASSPATH: Copy jar files to, or create symlinks in, the
# /usr/share/java directory.

AUTO_CLASSPATH_DIR=/usr/share/java

pathprepend . CLASSPATH

for dir in `find ${AUTO_CLASSPATH_DIR} -type d 2>/dev/null`; do
    pathappend $dir CLASSPATH
done

for jar in `find ${AUTO_CLASSPATH_DIR} -name "*.jar" 2>/dev/null`; do
    pathappend $jar CLASSPATH
done

export JAVA_HOME

# By default, Java creates several files in a directory named
# /tmp/hsperfdata_[username]. This directory contains files that are used for
# performance monitoring and profiling, but aren't normally needed on a BLFS
# system. This environment variable disables that feature.
_JAVA_OPTIONS="-XX:-UsePerfData"

export _JAVA_OPTIONS

unset AUTO_CLASSPATH_DIR dir jar _JAVA_OPTIONS

# End /etc/profile.d/openjdk.sh
EOF

If Sudo-1.9.14p3 is installed, the super user should have access to the above variables. Execute the following commands as the root user:

cat > /etc/sudoers.d/java << "EOF"
Defaults env_keep += JAVA_HOME
Defaults env_keep += CLASSPATH
Defaults env_keep += _JAVA_OPTIONS
EOF

To use mandb to include the OpenJDK man pages in its database, issue, as the root user:

cat >> /etc/man_db.conf << "EOF" &&
# Begin Java addition
MANDATORY_MANPATH     /opt/jdk/man
MANPATH_MAP           /opt/jdk/bin     /opt/jdk/man
MANDB_MAP             /opt/jdk/man     /var/cache/man/jdk
# End Java addition
EOF

mkdir -p /var/cache/man &&
mandb -c /opt/jdk/man

Setting up the Certificate Authority Certificates for Java

OpenJDK uses its own format for the CA certificates. The Java security modules use $JAVA_HOME/lib/security/cacerts by default. In order to keep all the certificates in one place, we use /etc/ssl/java/cacerts. The instructions on the make-ca-1.12 page previously created the file located in /etc/ssl/java. Set up a symlink in the default location as the root user:

ln -sfv /etc/pki/tls/java/cacerts /opt/jdk/lib/security/cacerts

Use the following command to check if the cacerts file has been successfully installed:

/opt/jdk/bin/keytool -list -cacerts

At the prompt Enter keystore password:, enter changeit (the default) or just press the Enter key. If the cacerts file was installed correctly, you will see a list of the certificates with related information for each one. If not, you need to reinstall them.

If you later install a new JVM, you just have to create the symlink in the default location to be able to use the cacerts.

apache-ant-1.10.14

Introduction to Apache Ant

The Apache Ant package is a Java-based build tool. In theory, it is like the make command, but without make's wrinkles. Ant is different. Instead of a model that is extended with shell-based commands, Ant is extended using Java classes. Instead of writing shell commands, the configuration files are XML-based, calling out a target tree that executes various tasks. Each task is run by an object that implements a particular task interface.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Apache Ant Dependencies

Required

A JDK (Java Binary or OpenJDK-20.0.2) and GLib-2.76.4

Note

An Internet connection is needed for building this package.

Installation of Apache Ant

Build a limited bootstrap version of Apache Ant using the following command:

./bootstrap.sh

Download the runtime dependencies using the fetch.xml ant build script:

bootstrap/bin/ant -f fetch.xml -Ddest=optional

Build Apache Ant by running the following command:

./build.sh -Ddist.dir=$PWD/ant-1.10.14 dist

Install, as the root user:

cp -rv ant-1.10.14 /opt/            &&
chown -R root:root /opt/ant-1.10.14 &&
ln -sfv ant-1.10.14 /opt/ant

Command Explanations

bootstrap/bin/ant -f fetch.xml -Ddest=optional: Downloads the missing dependencies to the user's home directory, and copies them into the source tree (in the lib/optional directory, where ant picks them up at build time).

./build.sh -Ddist.dir=$PWD/ant-1.10.14 dist: This command builds, tests, then installs the package into a temporary directory.

Configuring Apache Ant

Config Files

/etc/ant/ant.conf, ~/.ant/ant.conf, and ~/.antrc

Configuration Information

Some packages will require ant to be in the search path and the ANT_HOME environment variable defined. Satisfy these requirements by issuing, as the root user:

cat > /etc/profile.d/ant.sh << EOF
# Begin /etc/profile.d/ant.sh

pathappend /opt/ant/bin
export ANT_HOME=/opt/ant

# End /etc/profile.d/ant.sh
EOF

The above instructions assume you have configured your system as described in The Bash Shell Startup Files.

Contents

Installed Programs: ant, antRun, antRun.pl, complete-ant-cmd.pl, runant.pl, and runant.py
Installed Libraries: Numerous ant*.jar and dependent libraries in $ANT_HOME/lib
Installed Directories: /opt/ant-1.10.14

Short Descriptions

ant

is a Java based build tool used by many packages instead of the conventional make program

antRun

is a support script used to start ant build scripts in a given directory

antRun.pl

is a Perl script that provides similar functionality offered by the antRun script

complete-ant-cmd.pl

is a Perl script that allows Bash to complete an ant command-line

runant.pl

is a Perl wrapper script used to invoke ant

runant.py

is a Python wrapper script used to invoke ant

ant*.jar

files are the Apache Ant Java class libraries

Part IV. Networking

Chapter 14. Connecting to a Network

The LFS book covers setting up networking by connecting to a LAN with a static IP address. There are other methods used to obtain an IP address and connect to a LAN and other networks (such as the Internet). The most popular methods (DHCP and PPP) are covered in this chapter.

DHCP stands for Dynamic Host Configuration Protocol. It is a protocol used by many sites to automatically provide information such as IP addresses, subnet masks and routing information to computers. If your network uses DHCP, you will need a DHCP client in order to connect to it.

Advanced Network Setup

Network Bridge

Kernel Configuration

Enable the following options in the kernel configuration and recompile the kernel if necessary:

Networking support: Y
  Networking options:
    802.1d Ethernet Bridging: M or Y

Setting up a Network Bridge

In this section we are going to discuss how to set up a network bridge using systemd-networkd. In the examples below, eth0 represents the external interface that is being bridged, while br0 represents the bridge interface.

To create a bridge interface, create the following configuration file by running the following command as the root user:

cat > /etc/systemd/network/50-br0.netdev << EOF
[NetDev]
Name=br0
Kind=bridge
EOF

To assign a network interface to a bridge, create the following configuration file by running the following command as the root user:

cat > /etc/systemd/network/51-eth0.network << EOF
[Match]
Name=eth0

[Network]
Bridge=br0
EOF

Repeat the process for any other interfaces that need to be bridged. Note that it is important that nothing assigns any addresses to the bridged interfaces. If you are using NetworkManager-1.44.0, make sure you configure them to ignore the bridged interfaces, as well as the bridge interface itself.

If you are on a network which uses DHCP for assigning ip addresses, create the following configuration file by running the following command as the root user:

cat > /etc/systemd/network/60-br0.network << EOF
[Match]
Name=br0

[Network]
DHCP=yes
EOF

Alternatively, if using a static ip setup, create the following configuration file by running the following command as the root user:

cat > /etc/systemd/network/60-br0.network << EOF
[Match]
Name=br0

[Network]
Address=192.168.0.2/24
Gateway=192.168.0.1
DNS=192.168.0.1
EOF

To bring up the bridge interface, simply restart the systemd-networkd daemon by running the following command as the root user:

systemctl restart systemd-networkd

dhcpcd-10.0.2

Introduction to dhcpcd

dhcpcd is an implementation of the DHCP client specified in RFC2131. A DHCP client is useful for connecting your computer to a network which uses DHCP to assign network addresses. dhcpcd strives to be a fully featured, yet very lightweight DHCP client.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

dhcpcd Dependencies

Optional

LLVM-16.0.5 (with Clang), ntp-4.2.8p17, chronyd, and ypbind

Privilege separation

Recent releases of dhcpcd optionally support privilege separation. As the practical security benefits of this are unclear for a program like dhcpcd and the setup is more complicated, the book currently defaults to disable it.

If you however would like to use privilege separation, additional installation steps are necessary to set up the proper environment. Issue the following commands as the root user:

install  -v -m700 -d /var/lib/dhcpcd &&

groupadd -g 52 dhcpcd        &&
useradd  -c 'dhcpcd PrivSep' \
         -d /var/lib/dhcpcd  \
         -g dhcpcd           \
         -s /bin/false       \
         -u 52 dhcpcd &&
chown    -v dhcpcd:dhcpcd /var/lib/dhcpcd 

Installation of dhcpcd

Build dhcpcd without privilege separation by running the following command:

./configure --prefix=/usr                \
            --sysconfdir=/etc            \
            --libexecdir=/usr/lib/dhcpcd \
            --dbdir=/var/lib/dhcpcd      \
            --runstatedir=/run           \
            --disable-privsep         &&
make

Alternatively, build dhcpcd with privilege separation by running the following commands:

./configure --prefix=/usr                \
            --sysconfdir=/etc            \
            --libexecdir=/usr/lib/dhcpcd \
            --dbdir=/var/lib/dhcpcd      \
            --runstatedir=/run           \
            --privsepuser=dhcpcd         &&
make

To test the results, issue: make test.

Now, as the root user:

make install

Command Explanations

--libexecdir=/usr/lib/dhcpcd: This switch sets a better location for the dhcpcd internal libraries.

--dbdir=/var/lib/dhcpcd: This switch adjusts the database directory because the default directory, /var/db, is not FHS-compliant.

--runstatedir=/run: This switch sets the runtime state directory because the default /var/run is a symbolic link to /run, and using /var/run is deprecated.

--disable-privsep: This switch disables privilege separation, which is the default in dhcpcd. This switch is not used in the build configuration where privilege separation is used.

--privsepuser=dhcpcd: This switch sets the privilege separation user in the build configuration where privilege escalation is used.

--with-hook=...: You can optionally install more hooks, for example to install some configuration files such as ntp.conf. A set of hooks can be found in the dhcpcd-hooks directory in the build tree.

Configuring dhcpcd

Config Files

/etc/dhcpcd.conf

General Configuration Information

If you want to configure network interfaces at boot using dhcpcd, you need to install the systemd unit included in blfs-systemd-units-20230816 package by running the following command as the root user:

make install-dhcpcd

Note

The default behavior of dhcpcd is to set the hostname and the mtu. It also overwrites /etc/resolv.conf and /etc/ntp.conf. These modifications to system configuration files are done by hooks which are stored in /usr/lib/dhcpcd/dhcpcd-hooks. You can change this behavior by removing or adding hooks from/to that directory. The execution of hooks can be disabled by using the --nohook (-C) command line option or by the nohook option in the /etc/dhcpcd.conf file.

Note

Make sure that you disable the systemd-networkd service or configure it not to manage the interfaces you want to manage with dhcpcd.

At this point you can test if dhcpcd is behaving as expected by running the following command as the root user:

systemctl start dhcpcd@eth0

To start dhcpcd on a specific interface at boot, enable the previously installed systemd unit by running the following command as the root user:

systemctl enable dhcpcd@eth0

Replace eth0 with the actual interface name.

Contents

Installed Program: dhcpcd
Installed Library: /usr/lib/dhcpcd/dev/udev.so
Installed Directory: /{usr,var}/lib/dhcpcd and /usr/share/dhcpcd

Short Descriptions

dhcpcd

is an implementation of the DHCP client specified in RFC2131

udev.so

adds udev support for interface arrival and departure; this is because udev likes to rename the interface, which it can't do if dhcpcd grabs it first

Chapter 15. Networking Programs

These applications are generally client applications used to access the appropriate server across the building or across the world. Tcpwrappers and portmap are support programs for daemons that you may have running on your machine.

bridge-utils-1.7.1

Introduction to bridge-utils

The bridge-utils package contains a utility needed to create and manage bridge devices. This is useful in setting up networks for a hosted virtual machine (VM).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

bridge-utils Dependencies

Optional (to run tests)

Net-tools-2.10

Kernel Configuration

Enable the following options in the kernel configuration and recompile the kernel if necessary:

[*] Networking support --->                                                [NET]
  Networking options --->
    <*/M> 802.1d Ethernet Bridging                                      [BRIDGE]

Installation of bridge-utils

Install bridge-utils by running the following commands:

autoconf                  &&
./configure --prefix=/usr &&
make

Testing the results requires running the six shell scripts in the tools/ directory. Two of the tests require two ethernet ports. Some tests will not preserve the current network configuration. See tests/README for details.

Now, as the root user:

make install

Contents

Installed Program: brctl
Installed Libraries: None
Installed Directories: None

Short Descriptions

brctl

is a program used to set up, maintain, and inspect the ethernet bridge configuration in the linux kernel

cifs-utils-7.0

Introduction to cifs-utils

The cifs-utils package provides a means for mounting SMB/CIFS shares on a Linux system.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

cifs-utils Dependencies

Recommended
Optional

docutils-0.20.1 (to create the man pages), keyutils-1.6.1 (required to build PAM module), Linux-PAM-1.5.3, Samba-4.18.6, and libcap-2.69 with PAM or libcap-ng

Kernel Configuration

Enable the following options in the kernel configuration and recompile the kernel if necessary:

File systems --->
  [*] Network File Systems --->                            [NETWORK_FILESYSTEMS]
    <*/M> SMB3 and CIFS support (advanced network filesystem)             [CIFS]

Depending on your server configuration, additional kernel options may be required.

Installation of cifs-utils

Install cifs-utils by running the following commands:

./configure --prefix=/usr \
            --disable-pam &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-pam: Do not build PAM support. Remove it and use --with-pamdir (see below), if Linux-PAM-1.5.3 is installed and you wish PAM support.

--with-pamdir=/usr/lib/security: Install the PAM module in /usr/lib/security.

Contents

Installed Programs: cifs.idmap, cifs.upcall, cifscreds, getcifsacl, mount.cifs, mount.smb3, setcifsacl, smb2-quota, and smbinfo
Installed Library: /usr/lib/cifs-utils/idmapwb.so and optionally PAM module /usr/lib/security/pam_cifscreds.so
Installed Directory: /usr/lib/cifs-utils

Short Descriptions

cifs.idmap

is a userspace helper program for the linux CIFS client filesystem. There are a number of activities that the kernel cannot easily do itself. This program is a callout program that does these things for the kernel and then returns the result. It is not intended to be run from the command-line

cifs.upcall

is a userspace helper program for the linux CIFS client filesystem. It is intended to be run when the kernel calls request-key for a particular key type. It is not intended to be run from the command-line

cifscreds

is a tool for managing credentials (username and password) for the purpose of establishing sessions in multiuser mounts

getcifsacl

is a userspace helper to display an ACL in a security descriptor for Common Internet File System (CIFS)

mount.cifs

mounts a Linux CIFS filesystem. It is usually invoked indirectly by the mount(8) command when using the "-t cifs" option

mount.smb3

mounts a SMB3-based filesystem. It is usually invoked indirectly by the mount(8) command when using the "-t smb3" option

setcifsacl

is intended to alter an ACL of a security descriptor for a file system object

smb3-quota

displays quota information for a SMB filesystem

smbinfo

displays SMB-specific file information, such as security descriptors and quotas

NcFTP-3.2.6

Introduction to NcFTP

The NcFTP package contains a powerful and flexible interface to the Internet standard File Transfer Protocol. It is intended to replace or supplement the stock ftp program.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

NcFTP Dependencies

Optional

LLVM-16.0.5 (with Clang, used by default if installed)

Installation of NcFTP

There are two ways to build NcFTP. The first (and optimal) way builds most of the functionality as a shared library and then builds and installs the program linked against this library. The second method simply links all of the functionality into the binary statically. This doesn't make the dynamic library available for linking by other applications. You need to choose which method best suits you. Note that the second method does not create an entirely statically linked binary; only the libncftp parts are statically linked in, in this case. Be aware that building and using the shared library is covered by the Clarified Artistic License; however, developing applications that utilize the shared library is subject to a different license.

First, fix an issue caused by a change in behavior in GCC-10:

sed -i 's/^Bookmark/extern Bookmark/' sh_util/gpshare.c

Next, update the configure script to use modern C standards:

patch -Np1 -i ../ncftp-3.2.6-configure_fixes-1.patch &&
autoreconf -fiv -I autoconf_local

To install NcFTP using the first (and optimal) method, run the following commands:

./configure --prefix=/usr --sysconfdir=/etc &&
make -C libncftp shared &&
make

This package does not come with a test suite.

Now, as the root user:

make -C libncftp soinstall &&
make install

To install NcFTP using the second method (with the libncftp functionality linked in statically) run the following commands:

./configure --prefix=/usr --sysconfdir=/etc &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

make -C ... && make -C ...: These commands make and install the dynamic library libncftp which is then used to link against when compiling the main program.

Configuring NcFTP

Config Files

/etc/ncftp.* and ~/.ncftp/*; especially /etc/ncftp.prefs_v3 and ~/.ncftp/prefs_v3

Configuration Information

Most NcFTP configuration is done while in the program, and the configuration files are dealt with automatically. One exception to this is ~/.ncftp/prefs_v3. There are various options to alter in there, including:

yes-i-know-about-NcFTPd=yes

This disables the splash screen advertising the NcFTPd server.

There are other options in the prefs_v3 file. Most of these are self-explanatory. Global defaults can be set in /etc/ncftp.prefs_v3.

Contents

Installed Programs: ncftp, ncftpbatch, ncftpbookmarks, ncftpget, ncftpls, ncftpput, and ncftpspooler
Installed Library: libncftp.so
Installed Directories: None

Short Descriptions

ncftp

is a browser program for File Transfer Protocol

ncftpbatch

is an individual batch FTP job processor

ncftpbookmarks

is the NcFTP Bookmark Editor (NCurses-based)

ncftpget

is an internet file transfer program for scripts used to retrieve files

ncftpls

is an internet file transfer program for scripts used to list files

ncftpput

is an internet file transfer program for scripts used to transfer files

ncftpspooler

is a global batch FTP job processor daemon

Net-tools-2.10

Introduction to Net-tools

The Net-tools package is a collection of programs for controlling the network subsystem of the Linux kernel.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Net-tools

The instructions below automate the configuration process by piping yes to the make command. If you wish to run the interactive configuration process (by changing the instruction to just make), but you are not sure how to answer all the questions, then just accept the defaults. This will be just fine in the majority of cases. What you're asked here is a bunch of questions about which network protocols you've enabled in your kernel. The default answers will enable the tools from this package to work with the most common protocols: TCP, PPP, and several others. You still need to actually enable these protocols in the kernel—what you do here is merely tell the package to include support for those protocols in its programs, but it's up to the kernel to make the protocols available.

Note

This package has several unneeded protocols and hardware device specific functions that are obsolete. To only build the minimum needed for your system, skip the yes command and answer each question interactively. The minimum needed options are 'UNIX protocol family' and 'INET (TCP/IP) protocol family'.

For this package, we use the DESTDIR method of installation in order to easily remove files from the build that overwrite those that we want to keep or are not appropriate for our system.

Install Net-tools by running the following commands:

export BINDIR='/usr/bin' SBINDIR='/usr/bin' &&
yes "" | make -j1                           &&
make DESTDIR=$PWD/install -j1 install       &&
rm    install/usr/bin/{nis,yp}domainname    &&
rm    install/usr/bin/{hostname,dnsdomainname,domainname,ifconfig} &&
rm -r install/usr/share/man/man1            &&
rm    install/usr/share/man/man8/ifconfig.8 &&
unset BINDIR SBINDIR

This package does not come with a test suite.

Now, as the root user:

chown -R root:root install &&
cp -a install/* /

Command Explanations

export BINDIR='/usr/bin' SBINDIR='/usr/bin': Ensure the executables are installed in the correct location.

yes "" | make : Piping yes to make config skips the interactive configuration and accepts the defaults.

rm ...: Remove unneeded programs and man pages.

Contents

Installed Programs: arp, ipmaddr, iptunnel, mii-tool, nameif, netstat, plipconfig, rarp, route, and slattach
Installed Libraries: None
Installed Directories: None

Short Descriptions

arp

is used to manipulate the kernel's ARP cache, usually to add or delete an entry, or to dump the entire cache

ipmaddr

adds, deletes and shows an interface's multicast addresses

iptunnel

adds, changes, deletes and shows an interface's tunnels

mii-tool

checks or sets the status of a network interface's Media Independent Interface (MII) unit

nameif

names network interfaces based on MAC addresses

netstat

is used to report network connections, routing tables, and interface statistics

plipconfig

is used to fine tune the PLIP device parameters, to improve its performance

rarp

is used to manipulate the kernel's RARP table

route

is used to manipulate the IP routing table

slattach

attaches a network interface to a serial line. This allows you to use normal terminal lines for point-to-point links to others computers

NFS-Utils-2.6.3

Introduction to NFS Utilities

The NFS Utilities package contains the userspace server and client tools necessary to use the kernel's NFS abilities. NFS is a protocol that allows sharing file systems over the network.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

NFS Utilities Dependencies

Required

libtirpc-1.3.3, libevent-2.1.12, rpcsvc-proto-1.4.4, and SQLite-3.42.0

Optional

Cyrus SASL-2.1.28 (for SASL authentication), LVM2-2.03.22 (libdevmapper for NFSv4 support), libnsl-2.0.0 (for NIS client support), OpenLDAP-2.6.6 (for LDAP authentication), MIT Kerberos V5-1.21.2 or libgssapi , and librpcsecgss (for GSS and RPC security support), and libcap-2.69 with PAM

Required (runtime)

rpcbind-1.2.6

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/nfs-utils

Kernel Configuration

Enable the following options in the kernel configuration (choose client and/or server support as appropriate) and recompile the kernel if necessary:

File systems --->
  [*] Network File Systems --->                            [NETWORK_FILESYSTEMS]
    <*/M> NFS client support                                            [NFS_FS]
    <*/M> NFS server support                                              [NFSD]

Select the appropriate sub-options that appear when the above options are selected.

Note

In BLFS we assume that nfs v3 will be used. If the server offers nfs v4 (for linux, CONFIG_NFSD_V4) then auto-negotiation for v3 will fail and you will need to add nfsver=3 to the mount options. This also applies if that option is enabled in the client's kernel, for example in a distro trying to mount from a BLFS v3 server.

Even if neither end of the connection supports nfs v4, adding nfsver=3 is still beneficial because it prevents an error message "NFS: bad mount option value specified: minorversion=1" being logged on every mount.

Installation of NFS Utilities

Install NFS Utilities by running the following commands:

./configure --prefix=/usr          \
            --sysconfdir=/etc      \
            --sbindir=/usr/sbin    \
            --disable-nfsv4        \
            --disable-gss          \
            LIBS="-lsqlite3 -levent_core" &&
make

Now, as the root user:

make install                       &&
chmod u+w,go+r /usr/sbin/mount.nfs &&
chown nobody:nogroup /var/lib/nfs

The tests for this package require that the package be installed. In addition, the rpc.statd daemon must not be running and the tests need to be run as the root user.

To test the results, issue, as root:

make check

Command Explanations

--disable-gss: Disables support for RPCSEC GSS (RPC Security).

LIBS="-lsqlite3 -levent_core": is required for the fsidd program.

chown nobody:nogroup /var/lib/nfs: The rpc.statd program uses the ownership of this directory to set it's UID and GID. This command sets those to unprivileged entries.

Configuring NFS Utilities

Server Configuration

/etc/exports contains the exported directories on NFS servers. Refer to the exports.5 manual page for the syntax of this file. Also refer to the "NFS HowTo" available at https://nfs.sourceforge.net/nfs-howto/ for information on how to configure the servers and clients in a secure manner. For example, for sharing the /home directory over the local network, the following line may be added:

cat >> /etc/exports << EOF
/home 192.168.0.0/24(rw,subtree_check,anonuid=99,anongid=99)
EOF

Note

Be sure to replace the directory, network address. and prefix above to match your network. The only space in the line above should be between the directory and the network address.

Systemd Units

Install the NFSv4 server units included in the blfs-systemd-units-20230816 package to start the server at boot.

make install-nfsv4-server

If you have disabled NFSv4 support, run the following command as the root user to omit the NFSv4 specific systemd units:

make install-nfs-server

You can edit the /etc/default/nfs-utils file to change the startup options for NFS daemons. Defaults should be fine for most use cases.

Client Configuration

/etc/fstab contains the directories that are to be mounted on the client. Alternately the partitions can be mounted by using the mount command with the proper options. To mount the /home and /usr partitions, add the following to the /etc/fstab:

<server-name>:/home  /home nfs   rw,_netdev 0 0
<server-name>:/usr   /usr  nfs   ro,_netdev 0 0

The options which can be used are specified in man 5 nfs . If both the client and server are running recent versions of linux, most of the options will be negotiated (but see the Note above on nfsver=3). You can specify either rw or ro, _netdev if the filesystem is to be automatically mounted at boot, or noauto (and perhaps user) for other filesystems.

If the fileserver is not running a recent version of linux, you may need to specify other options.

You may need to enable autofs v4 in your kernel, and add the option comment=systemd.automount. Some machines may need this because systemd tries to mount the external filesystems before the network is up. An alternative is to run mount -a as the root user after the system has started.

Systemd Units

Note

The following systemd units are not required if the nfs-server units are installed.

Install the units included in the blfs-systemd-units-20230816 package to start the client services at boot.

make install-nfs-client

Contents

Installed Programs: exportfs, fsidd, mountstats, mount.nfs, mount.nfs4 (link to mount.nfs), nfsconf, nfsdclnts, nfsiostat, nfsstat, rpc.mountd, rpc.nfsd, rpc.statd, rpcdebug, showmount, sm-notify, start-statd, umount.nfs (link to mount.nfs), and umount.nfs4 (link to mount.nfs)
Installed Libraries: None
Installed Directories: /var/lib/nfs

Short Descriptions

exportfs

maintains a list of NFS exported file systems

fsidd

offers a local UNIX domain socket interface for all NFS userspace to query the reexport database

mountstats

displays NFS client per-mount statistics

mount.nfs

is used to mount a network share using NFS

mount.nfs4

is used to mount a network share using NFSv4

nfsconf

can be used to test for and retrieve configuration settings from a range of nfs-utils configuration files

nfsdclnts

prints information about NFS clients

nfsiostat

reports input/output statistics for network filesystems

nfsstat

displays statistics kept about NFS client and server activity

rpc.mountd

implements the NFS mount protocol on an NFS server

rpc.nfsd

implements the user level part of the NFS service on the server

rpc.statd

is used by the NFS file locking service. Run on both sides, client as well as server, when you want file locking enabled

rpcdebug

sets or clears the kernel's NFS client and server debug flags

showmount

displays mount information for an NFS server

sm-notify

is used to send Network Status Monitor reboot messages

start-statd

is a script called by nfsmount when mounting a filesystem with locking enabled, if statd does not appear to be running. It can be customised with whatever flags are appropriate for the site

umount.nfs

is used to unmount a network share using NFS

umount.nfs4

is used to unmount a network share using NFSv4

ntp-4.2.8p17

Introduction to ntp

The ntp package contains a client and server to keep the time synchronized between various computers over a network. This package is the official reference implementation of the NTP protocol.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

ntp Dependencies

Required

IO-Socket-SSL-2.083

Optional

libcap-2.69 with PAM, libevent-2.1.12, libedit, and libopts from AutoGen

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/ntp

Installation of ntp

There should be a dedicated user and group to take control of the ntpd daemon after it is started. Issue the following commands as the root user:

groupadd -g 87 ntp &&
useradd -c "Network Time Protocol" -d /var/lib/ntp -u 87 \
        -g ntp -s /bin/false ntp

The update-leap command needs to be fixed in order to run properly:

sed -e 's/"(\\S+)"/"?([^\\s"]+)"?/' \
    -i scripts/update-leap/update-leap.in

Now fix an issue introduced with glibc-2.34:

sed -e 's/#ifndef __sun/#if !defined(__sun) \&\& !defined(__GLIBC__)/' \
    -i libntp/work_thread.c

Install ntp by running the following commands:

./configure --prefix=/usr         \
            --bindir=/usr/sbin    \
            --sysconfdir=/etc     \
            --enable-linuxcaps    \
            --with-lineeditlibs=readline \
            --docdir=/usr/share/doc/ntp-4.2.8p17 &&
make

To test the results, issue: make check.

Now, as the root user:

make install &&
install -v -o ntp -g ntp -d /var/lib/ntp

Command Explanations

CFLAGS="-O2 -g -fPIC": This environment variable is necessary to generate Position Independent Code needed for use in the package libraries.

--bindir=/usr/sbin: This parameter places the administrative programs in /usr/sbin.

--enable-linuxcaps: ntpd is run as user ntp, so use Linux capabilities for non-root clock control.

--with-lineeditlibs=readline: This switch enables Readline support for ntpdc and ntpq programs. If omitted, libedit will be used if installed, otherwise no readline capabilities will be compiled.

Configuring ntp

Config Files

/etc/ntp.conf

Configuration Information

The following configuration file first defines various ntp servers with open access from different continents. Second, it creates a drift file where ntpd stores the frequency offset and a pid file to store the ntpd process ID. Third, it defines the location for the leap-second definition file /etc/ntp.leapseconds, that the update-leap script checks and updates, when necessary. This script can be run as a cron job and the ntp developers recommend a frequency of about three weeks for the updates. Since the documentation included with the package is sparse, visit the ntp website at https://www.ntp.org/ and https://www.ntppool.org/ for more information.

cat > /etc/ntp.conf << "EOF"
# Asia
server 0.asia.pool.ntp.org

# Australia
server 0.oceania.pool.ntp.org

# Europe
server 0.europe.pool.ntp.org

# North America
server 0.north-america.pool.ntp.org

# South America
server 2.south-america.pool.ntp.org

driftfile /var/lib/ntp/ntp.drift
pidfile   /run/ntpd.pid

leapfile  /var/lib/ntp/ntp.leapseconds
EOF

You may wish to add a Security session. For explanations, see https://www.eecis.udel.edu/~mills/ntp/html/accopt.html#restrict.

cat >> /etc/ntp.conf << "EOF"
# Security session
restrict    default limited kod nomodify notrap nopeer noquery
restrict -6 default limited kod nomodify notrap nopeer noquery

restrict 127.0.0.1
restrict ::1
EOF

Synchronizing the Time

There are two options. Option one is to run ntpd continuously and allow it to synchronize the time in a gradual manner. The other option is to run ntpd periodically (using cron) and update the time each time ntpd is scheduled.

If you choose Option one, then install the ntpd.service unit included in the blfs-systemd-units-20230816 package.

make install-ntpd

If you prefer to run ntpd periodically, add the following command to root's crontab:

ntpd -q

Contents

Installed Programs: calc_tickadj, ntp-keygen, ntp-wait, ntpd, ntpdate, ntpdc, ntpq, ntptime, ntptrace, sntp, tickadj and update-leap
Installed Libraries: None
Installed Directories: /usr/share/ntp, /usr/share/doc/ntp-4.2.8 and /var/lib/ntp

Short Descriptions

calc_tickadj

calculates optimal value for tick given ntp drift file

ntp-keygen

generates cryptographic data files used by the NTPv4 authentication and identification schemes

ntp-wait

is useful at boot time, to delay the boot sequence until ntpd has set the time

ntpd

is a ntp daemon that runs in the background and keeps the date and time synchronized based on response from configured ntp servers. It also functions as a ntp server

ntpdate

is a client program that sets the date and time based on the response from an ntp server. This command is deprecated

ntpdc

is used to query the ntp daemon about its current state and to request changes in that state

ntpq

is a utility program used to monitor ntpd operations and determine performance

ntptime

reads and displays time-related kernel variables

ntptrace

traces a chain of ntp servers back to the primary source

sntp

is a Simple Network Time Protocol (SNTP) client

tickadj

reads, and optionally modifies, several timekeeping-related variables in older kernels that do not have support for precision timekeeping

update-leap

is a script to verify and, if necessary, update the leap-second definition file

rpcbind-1.2.6

Introduction to rpcbind

The rpcbind program is a replacement for portmap. It is required for import or export of Network File System (NFS) shared directories.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

rpcbind Dependencies

Required

libtirpc-1.3.3

Installation of rpcbind

There should be a dedicated user and group to take control of the rpcbind daemon after it is started. Issue the following commands as the root user:

groupadd -g 28 rpc &&
useradd -c "RPC Bind Daemon Owner" -d /dev/null -g rpc \
        -s /bin/false -u 28 rpc

In order to get rpcbind to work properly, first fix the package to use correct service name:

sed -i "/servname/s:rpcbind:sunrpc:" src/rpcbind.c

Install rpcbind by running the following commands:

patch -Np1 -i ../rpcbind-1.2.6-vulnerability_fixes-1.patch &&

./configure --prefix=/usr       \
            --bindir=/usr/sbin  \
            --enable-warmstarts \
            --with-rpcuser=rpc  &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--with-rpcuser=rpc: This switch is used so the rpcbind daemon will run as an unprivileged user instead of the root user.

Configuring rpcbind

Systemd Unit

Enable the systemd unit installed with the package:

systemctl enable rpcbind

Contents

Installed Program: rpcbind and rpcinfo
Installed Libraries: None
Installed Directories: None

Short Descriptions

rpcbind

is a server that converts RPC program numbers into universal addresses. It must be running on the host to be able to make RPC calls on a server on that machine

rpcinfo

makes an RPC call to an RPC server and reports data according to the requested options

rsync-3.2.7

Introduction to rsync

The rsync package contains the rsync utility. This is useful for synchronizing large file archives over a network.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://www.samba.org/ftp/rsync/src/rsync-3.2.7.tar.gz

  • Download MD5 sum: f216f350ef56b9ba61bc313cb6ec2ed6

  • Download size: 1.1 MB

  • Estimated disk space required: 9.6 MB (with tests; add 24 MB for HTML API documentation)

  • Estimated build time: 0.7 SBU (with tests)

rsync Dependencies

Recommended
Optional

Doxygen-1.9.7, lz4, and xxhash

Installation of rsync

For security reasons, running the rsync server as an unprivileged user and group is encouraged. If you intend to run rsync as a daemon, create the rsyncd user and group with the following commands issued by the root user:

groupadd -g 48 rsyncd &&
useradd -c "rsyncd Daemon" -m -d /home/rsync -g rsyncd \
    -s /bin/false -u 48 rsyncd

Install rsync by running the following commands:

./configure --prefix=/usr    \
            --disable-lz4    \
            --disable-xxhash \
            --without-included-zlib &&
make

If you have Doxygen-1.9.7 installed and wish to build HTML API documentation, issue:

doxygen

To test the results, issue: make check.

Now, as the root user:

make install

If you built the documentation, install it using the following commands as the root user:

install -v -m755 -d          /usr/share/doc/rsync-3.2.7/api &&
install -v -m644 dox/html/*  /usr/share/doc/rsync-3.2.7/api

Command Explanations

--disable-lz4: This switch disables LZ4 compression support. Note that it uses the superior 'zstd' algorithm when this switch is in use, and zstd is provided in LFS.

--disable-xxhash: This switch disables advanced xxhash checksum support. Remove this switch if you have installed xxhash.

--without-included-zlib: This switch enables compilation with the system-installed zlib library.

Configuring rsync

Config Files

/etc/rsyncd.conf

Configuration Information

For client access to remote files, you may need to install the OpenSSH-9.4p1 package to connect to the remote server.

This is a simple download-only configuration to set up running rsync as a server. See the rsyncd.conf(5) man-page for additional options (i.e., user authentication).

cat > /etc/rsyncd.conf << "EOF"
# This is a basic rsync configuration file
# It exports a single module without user authentication.

motd file = /home/rsync/welcome.msg
use chroot = yes

[localhost]
    path = /home/rsync
    comment = Default rsync module
    read only = yes
    list = yes
    uid = rsyncd
    gid = rsyncd

EOF

You can find additional configuration information and general documentation about rsync at https://rsync.samba.org/documentation.html.

Systemd Unit

Note that you only need to start the rsync server if you want to provide an rsync archive on your local machine. You don't need this unit to run the rsync client.

Install the rsyncd.service unit included in the blfs-systemd-units-20230816 package.

make install-rsyncd

Note

This package comes with two types of units: A service file and a socket file. The service file will start rsync daemon once at boot and it will keep running until the system shuts down. The socket file will make systemd listen on rsync port (Default 873, needs to be edited for anything else) and will start rsync daemon when something tries to connect to that port and stop the daemon when the connection is terminated. This is called socket activation and is analogous to using {,x}inetd on a SysVinit based system.

By default, the first method is used - rsync daemon is started at boot and stopped at shutdown. If the socket method is desired, you need to run as the root user:

systemctl stop rsyncd &&
systemctl disable rsyncd &&
systemctl enable rsyncd.socket &&
systemctl start rsyncd.socket

Note that socket method is only useful for remote backups. For local backups you'll need the service method.

Contents

Installed Program: rsync and rsync-ssl
Installed Libraries: None
Installed Directories: Optionally, /usr/share/doc/rsync-3.2.7

Short Descriptions

rsync

is a replacement for rcp (and scp) that has many more features. It uses the rsync algorithm which provides a very fast method of syncing remote files. It does this by sending just the differences in the files across the link, without requiring that both sets of files are present at one end of the link beforehand

rsync-ssl

is a helper script used when connecting to an rsync daemon that has SSL support built in

Samba-4.18.6

Introduction to Samba

The Samba package provides file and print services to SMB/CIFS clients and Windows networking to Linux clients. Samba can also be configured as a Windows Domain Controller replacement, a file/print server acting as a member of a Windows Active Directory domain and a NetBIOS (RFC1001/1002) nameserver (which among other things provides LAN browsing support).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Samba Dependencies

Required

GnuTLS-3.8.1, jansson-2.14, JSON-4.10, libtirpc-1.3.3, Parse-Yapp-1.21, and rpcsvc-proto-1.4.4

Recommended
Optional

Avahi-0.8, BIND-9.18.18, Cups-2.4.6, Cyrus SASL-2.1.28, GDB-13.2, git-2.41.0, GnuPG-2.4.3 (required for ADS and test suite), libaio-0.3.113, libarchive-3.7.1 (for tar in smbclient), libcap-2.69 with PAM, libgcrypt-1.10.2, libnsl-2.0.0, libunwind-1.6.2, lmdb-0.9.31, Markdown-3.4.1, MIT Kerberos V5-1.21.2, nss-3.92, popt-1.19, Talloc-2.4.1 (included), Vala-0.56.11, Valgrind-3.21.0 (optionally used by the test suite), xfsprogs-6.4.0, cmocka, cryptography, ctdb (included), cwrap, dnspython, FAM, Gamin, GlusterFS, Heimdal (included), iso8601, ldb (included), M2Crypto (required for ADS), OpenAFS, pyasn1, PyGPGME (recommended for ADS), tevent (included), tdb (included), and tracker-2

Optional (for the Developer Test Suite)

Install in listed order: six-1.16.0, pytest-7.4.0, argparse, extras, hypothesis, coverage, pytest-cov, doctools, unittest2, testtools, fixtures, python-mimeparse, contextlib2, traceback2, linecache2, testscenarios, testresources, virtualenv, pbr, and python-subunit

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/samba4

Installation of Samba

To support the test suite, set up a Python virtual environment for some Python modules out of the scope of BLFS:

python3 -m venv pyvenv &&
./pyvenv/bin/pip3 install cryptography pyasn1 iso8601

Install Samba by running the following commands:

PYTHON=$PWD/pyvenv/bin/python3             \
./configure                                \
    --prefix=/usr                          \
    --sysconfdir=/etc                      \
    --localstatedir=/var                   \
    --with-piddir=/run/samba               \
    --with-pammodulesdir=/usr/lib/security \
    --enable-fhs                           \
    --without-ad-dc                        \
    --enable-selftest                      &&
make

To test the results, issue: PATH=$PWD/pyvenv/bin:$PATH make quicktest. The test suite will produce lines that look like failures, but these are innocuous. The last few lines of output should report "ALL OK" for a good test run. A summary of any failures can be found in ./st/summary.

Note

Additionally, developer test suites are available. If you've installed the optional python modules above in the Python virtual environment for building this package, you can run these tests with make test. It is not recommended for the average builder at around 290 SBU and over a gigabyte of disk space, and you should expect ~73 errors and ~30 failures from the 3000+ tests.

Fix a hard coded path to Python 3 interpreter:

sed '1s@^.*$@#!/usr/bin/python3@' \
    -i ./bin/default/source4/scripting/bin/samba-gpupdate.inst

If upgrading from an old version of samba, as the root user, remove the old Python support files to prevent some issues:

rm -rf /usr/lib/python3.11/site-packages/samba

Still as the root user, install the package:

make install &&

install -v -m644    examples/smb.conf.default /etc/samba &&

sed -e "s;log file =.*;log file = /var/log/samba/%m.log;" \
    -e "s;path = /usr/spool/samba;path = /var/spool/samba;" \
    -i /etc/samba/smb.conf.default &&

mkdir -pv /etc/openldap/schema                        &&

install -v -m644    examples/LDAP/README              \
                    /etc/openldap/schema/README.samba &&

install -v -m644    examples/LDAP/samba*              \
                    /etc/openldap/schema              &&

install -v -m755    examples/LDAP/{get*,ol*} \
                    /etc/openldap/schema

Command Explanations

--enable-fhs: Assigns all other file paths in a manner compliant with the Filesystem Hierarchy Standard (FHS).

--without-ad-dc: Disables Active Directory Domain Controller functionality. See Set up a Samba Active Directory Domain Controller for detailed information. Remove this switch if you've installed the Python modules needed for ADS support. Note that BLFS does not provide a samba bootscript or systemd unit for an Active Directory domain controller.

--with-selftest-prefix=SELFTEST_PREFIX: This option specifies the test suite work directory (default=./st).

install -v -m644 examples/LDAP/* /etc/openldap/schema: These commands are used to copy sample Samba schemas to the OpenLDAP schema directory.

install -v -m644 ../examples/smb.conf.default /etc/samba: This copies a default smb.conf file into /etc/samba. This sample configuration will not work until you copy it to /etc/samba/smb.conf and make the appropriate changes for your installation. See the configuration section for minimum values which must be set.

Configuring Samba

Config Files

/etc/samba/smb.conf

Printing to SMB Clients

If you use CUPS for print services, and you wish to print to a printer attached to an SMB client, you need to create an SMB backend device. To create the device, issue the following command as the root user:

install -dvm 755 /usr/lib/cups/backend &&
ln -v -sf /usr/bin/smbspool /usr/lib/cups/backend/smb

Configuration Information

Due to the complexity and the many various uses for Samba, complete configuration for all the package's capabilities is well beyond the scope of the BLFS book. This section provides instructions to configure the /etc/samba/smb.conf file for two common scenarios. The complete contents of /etc/samba/smb.conf will depend on the purpose of Samba installation.

Note

You may find it easier to copy the configuration parameters shown below into an empty /etc/samba/smb.conf file instead of copying and editing the default file as mentioned in the Command Explanations section. How you create/edit the /etc/samba/smb.conf file will be left up to you. Do ensure the file is only writable by the root user (mode 644).

Scenario 1: Minimal Standalone Client-Only Installation

Choose this variant if you only want to transfer files using smbclient, mount Windows shares and print to Windows printers, and don't want to share your files and printers to Windows machines.

A /etc/samba/smb.conf file with the following three parameters is sufficient:

[global]
    workgroup = WORKGROUP
    dos charset = cp850
    unix charset = ISO-8859-1

The values in this example specify that the computer belongs to a Windows workgroup named WORKGROUP, uses the cp850 character set on the wire when talking to MS-DOS and MS Windows 9x, and that the filenames are stored in the ISO-8859-1 encoding on the disk. Adjust these values appropriately for your installation. The unix charset value must be the same as the output of locale charmap when executed with the LANG variable set to your preferred locale, otherwise the ls command may not display correct filenames of downloaded files.

There is no need to run any Samba servers in this scenario, thus you don't need to install the provided systemd units.

Scenario 2: Standalone File/Print Server

Choose this variant if you want to share your files and printers to Windows machines in your workgroup in addition to the capabilities described in Scenario 1.

In this case, the /etc/samba/smb.conf.default file may be a good template to start from. Also, you should add the dos charset and unix charset parameters to the [global] section as described in Scenario 1 in order to prevent filename corruption. For security reasons, you may wish to define path = /home/alice/shared-files, assuming your user name is alice and you only want to share the files in that directory, instead of your entire home. Then, replace homes by shared-files and change also the comment if used the configuration file below or the /etc/samba/smb.conf.default to create yours.

The following configuration file creates a separate share for each user's home directory and also makes all printers available to Windows machines:

[global]
    workgroup = WORKGROUP
    dos charset = cp850
    unix charset = ISO-8859-1

[homes]
    comment = Home Directories
    browseable = no
    writable = yes

[printers]
    comment = All Printers
    path = /var/spool/samba
    browseable = no
    guest ok = no
    printable = yes

Other parameters you may wish to customize in the [global] section include:

    server string =
    security =
    hosts allow =
    load printers =
    log file =
    max log size =
    socket options =
    local master =

Reference the comments in the /etc/samba/smb.conf.default file for information regarding these parameters.

Since the smbd and nmbd daemons are needed in this case, install the samba systemd unit. Be sure to run smbpasswd (with the -a option to add users) to enable and set passwords for all accounts that need Samba access. Using the default Samba passdb backend, any user you attempt to add will also be required to exist in the /etc/passwd file.

Advanced Requirements

More complex scenarios involving domain control or membership are possible. Such setups are advanced topics and cannot be adequately covered in BLFS. Many complete books have been written on these topics alone. Note that in some domain membership scenarios, the winbindd daemon and the corresponding systemd unit are needed.

Guest account

The default Samba installation uses the nobody user for guest access to the server. This can be overridden by setting the guest account = parameter in the /etc/samba/smb.conf file. If you utilize the guest account = parameter, ensure this user exists in the /etc/passwd file.

Systemd Units

To start the Samba daemons at boot, install the systemd units from the blfs-systemd-units-20230816 package by running the following command as the root user:

make install-samba

To start the winbindd daemon at boot, install the systemd unit from the blfs-systemd-units-20230816 package by running the following command as the root user:

make install-winbindd

Note

This package comes with two types of units: A service file and a socket file. The service file will start the smbd daemon once at boot and it will keep running until the system shuts down. The socket file will make systemd listen on the smbd port (Default 445, needs to be edited for anything else) and will start the smbd daemon when something tries to connect to that port and stop the daemon when the connection is terminated. This is called socket activation and is analogous to using {,x}inetd on a SysVinit based system.

By default, the first method is used - the smbd daemon is started at boot and stopped at shutdown. If the socket method is desired, you need to run the following commands as the root user:

systemctl stop smbd &&
systemctl disable smbd &&
systemctl enable smbd.socket &&
systemctl start smbd.socket

Note that only the smbd daemon can be socket activated.

Contents

Installed Programs: cifsdd, dbwrap_tool, dumpmscat, eventlogadm, gentest, ldbadd, ldbdel, ldbedit, ldbmodify, ldbrename, ldbsearch, locktest, masktest, mdsearch, mvxattr, ndrdump, net, nmbd, nmblookup, ntlm_auth, oLschema2ldif, pdbedit, profiles, regdiff, regpatch, regshell, regtree, rpcclient, samba-gpupdate, samba-regedit, samba-tool, sharesec, smbcacls, smbclient, smbcontrol, smbcquotas, smbd, smbget, smbpasswd, smbspool, smbstatus, smbtar, smbtorture, smbtree, tdbbackup, tdbdump, tdbrestore, tdbtool, testparm, wbinfo, and winbindd
Installed Libraries: libdcerpc-binding.so, libdcerpc-samr.so, libdcerpc-server-core.so, libdcerpc.so, libndr-krb5pac.so, libndr-nbt.so, libndr.so, libndr-standard.so, libnetapi.so, libnss_winbind.so, libnss_wins.so, libsamba-credentials.so, libsamba-errors.so, libsamba-hostconfig.so, libsamba-passdb.so, libsamba-policy.cpython-310-x86_64-linux-gnu.so, libsamba-util.so, libsamdb.so, libsmbclient.so, libsmbconf.so, libsmbldap.so, libtevent-util.so, libwbclient.so, and filesystem and support modules under /usr/lib/{python3.11,samba}
Installed Directories: /etc/samba, /run/samba, /usr/include/samba-4.0, /usr/lib/python3.11/site-packages/samba, /usr/{lib,libexec,share}/samba, and /var/{cache,lib,lock,log,run}/samba

Short Descriptions

cifsdd

is the dd command for SMB

dbwrap_tool

is used to read and manipulate TDB/CTDB databases using the dbwrap interface

dumpmscat

dumps the content of MS catalog files

eventlogadm

is used to write records to eventlogs from STDIN, add the specified source and DLL eventlog registry entries and display the active eventlog names (from smb.conf)

gentest

is used to run random generic SMB operations against two SMB servers and show the differences in behavior

ldbadd

is a command-line utility for adding records to an LDB database

ldbdel

is a command-line utility for deleting LDB database records

ldbedit

allows you to edit LDB databases using your preferred editor

ldbmodify

allows you to modify records in an LDB database

ldbrename

allows you to rename LDB databases

ldbsearch

searches an LDB database for records matching a specified expression

locktest

is used to find differences in locking between two SMB servers

masktest

is used to find differences in wildcard matching between Samba's implementation and that of a remote server

mdsearch

runs Spotlight searches against a SMB server

mvxattr

is used to recursively rename extended attributes

ndrdump

is a DCE/RPC Packet Parser and Dumper

net

is a tool for administration of Samba and remote CIFS servers, similar to the net utility for DOS/Windows

nmbd

is the Samba NetBIOS name server

nmblookup

is used to query NetBIOS names and map them to IP addresses

ntlm_auth

is a tool to allow external access to Winbind's NTLM authentication function

oLschema2ldif

converts LDAP schema's to LDB-compatible LDIF

pdbedit

is a tool used to manage the SAM database

profiles

is a utility that reports and changes SIDs in Windows registry files

regdiff

is a Diff program for Windows registry files

regpatch

applies registry patches to registry files

regshell

is a Windows registry file browser using readline

regtree

is a text-mode registry viewer

rpcclient

is used to execute MS-RPC client side functions

samba-gpupdate

allows you to edit Microsoft Group Policy Objects (GPOs)

samba-regedit

is a ncurses based tool to manage the Samba registry

samba-tool

is the main Samba administration tool

sharesec

manipulates share ACL permissions on SMB file shares

smbcacls

is used to manipulate Windows NT access control lists

smbclient

is a SMB/CIFS access utility, similar to FTP

smbcontrol

is used to control running smbd, nmbd and winbindd daemons

smbcquotas

is used to manipulate Windows NT quotas on SMB file shares

smbd

is the main Samba daemon which provides SMB/CIFS services to clients

smbget

is a simple utility with wget-like semantics, that can download files from SMB servers. You can specify the files you would like to download on the command-line

smbpasswd

changes a user's Samba password

smbspool

sends a print job to a SMB printer

smbstatus

reports current Samba connections

smbtar

is a shell script used for backing up SMB/CIFS shares directly to Linux tape drives or to a file

smbtorture

is a test suite that runs several tests against a SMB server

smbtree

is a text-based SMB network browser

tdbbackup

is a tool for backing up or validating the integrity of Samba .tdb files

tdbdump

is a tool used to print the contents of a Samba .tdb file

tdbrestore

is a tool for creating a Samba .tdb file out of a ntdbdump

tdbtool

is a tool which allows simple database manipulation from the command line

testparm

checks a smb.conf file for proper syntax

wbinfo

queries a running winbindd daemon

winbindd

resolves names from Windows NT servers

libnss_winbind.so

provides Name Service Switch API functions for resolving names from NT servers

libnss_wins.so

provides API functions for Samba's implementation of the Windows Internet Naming Service

libnetapi.so

provides API functions for the administration tools used for Samba and remote CIFS servers

libsmbclient.so

provides API functions for the Samba SMB client tools

libwbclient.so

provides API functions for Windows domain client services

Wget-1.21.4

Introduction to Wget

The Wget package contains a utility useful for non-interactive downloading of files from the Web.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Wget Dependencies

Recommended
Optional

GnuTLS-3.8.1, HTTP-Daemon-6.16 (for the test suite), IO-Socket-SSL-2.083 (for the test suite), libidn2-2.3.4, libpsl-0.21.2, PCRE-8.45 or pcre2-10.42, and Valgrind-3.21.0 (for the test suite)

Installation of Wget

Install Wget by running the following commands:

./configure --prefix=/usr      \
            --sysconfdir=/etc  \
            --with-ssl=openssl &&
make

To test the results, issue: make check.

Some tests may fail when Valgrind tests are enabled.

Now, as the root user:

make install

Command Explanations

--sysconfdir=/etc: This relocates the configuration file from /usr/etc to /etc.

--with-ssl=openssl: This allows the program to use openssl instead of GnuTLS-3.8.1.

--enable-valgrind-tests: This allows the tests to be run under valgrind.

Configuring Wget

Config Files

/etc/wgetrc and ~/.wgetrc

Contents

Installed Program: wget
Installed Libraries: None
Installed Directories: None

Short Descriptions

wget

retrieves files from the Web using the HTTP, HTTPS and FTP protocols. It is designed to be non-interactive, for background or unattended operations

Configuring the Linux Kernel for Wireless

Before using any userspace tools for connecting to a wireless AP, the Linux kernel must be configured to drive the wireless NIC properly. Enable the following options in the kernel configuration as well as specific device drivers for your hardware and recompile the kernel if necessary:

[*] Networking support --->                                                [NET]
  [*] Wireless --->                                                   [WIRELESS]
    <*/M>   cfg80211 - wireless configuration API                     [CFG80211]
    < /*/M> Generic IEEE 802.11 Networking Stack (mac80211)           [MAC80211]

Device Drivers --->
  [*] Network device support --->                                   [NETDEVICES]
    [*] Wireless LAN --->                                                 [WLAN]

Open the Wireless LAN submenu and select the options that support your hardware. lspci from pciutils-3.10.0 or lsusb from usbutils-015 can be used to view your hardware configuration. Note that many (though not all) options for the wireless NICs depend on CONFIG_MAC80211. After the correct drivers are loaded, the interface will appear in /sys/class/net, or in the output of the ip link command.

Many wireless NIC drivers require firmware. If you've enabled the correct driver in the kernel configuration but it fails to load (with messages like Direct firmware load for <filename> failed with error -2, it means that you need to install the firmware or the wireless NIC won't work. Read About Firmware for more details.

iw-5.19

Introduction to iw

iw is a new nl80211 based CLI configuration utility for wireless devices. It supports all new drivers that have been added to the kernel recently. The old tool iwconfig, which uses Wireless Extensions interface, is deprecated and it's strongly recommended to switch to iw and nl80211.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

iw Dependencies

Required

libnl-3.7.0

Required (Runtime)

Configuring the Linux Kernel for Wireless

Kernel Configuration

To use iw, the kernel must have the appropriate drivers and other support available. Read Configuring the Linux Kernel for Wireless for details.

Installation of iw

To install iw, use the following commands:

sed -i "/INSTALL.*gz/s/.gz//" Makefile &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

sed ...: Install uncompressed manual pages in accordance with other man pages.

Contents

Installed Programs: iw
Installed Libraries: None
Installed Directories: None

Short Descriptions

iw

shows / manipulates wireless devices and their configuration

Wireless Tools-29

Introduction to Wireless Tools

The Wireless Extension (WE) is a generic API in the Linux kernel allowing a driver to expose configuration and statistics specific to common Wireless LANs to userspace. A single set of tools can support all the variations of Wireless LANs, regardless of their type, as long as the driver supports Wireless Extensions. WE parameters may also be changed on the fly without restarting the driver (or Linux).

The Wireless Tools (WT) package is a set of tools allowing manipulation of the Wireless Extensions. They use a textual interface to support the full Wireless Extension.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Wireless Tools Dependencies

Required (Runtime)

Configuring the Linux Kernel for Wireless

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/WirelessTools

Kernel Configuration

To use Wireless Tools, the kernel must have the appropriate drivers and other support available. Besides the configurations mentioned by Configuring the Linux Kernel for Wireless, it's also needed to enable the following options in the kernel configuration:

[*] Networking support --->                                                [NET]
  [*] Wireless --->                                                   [WIRELESS]
    <*/M> cfg80211 - wireless configuration API                       [CFG80211]
    [*]     cfg80211 wireless extensions compatibility           [CFG80211_WEXT]

Installation of Wireless Tools

First, apply a patch that fixes a problem when numerous networks are available:

patch -Np1 -i ../wireless_tools-29-fix_iwlist_scanning-1.patch

To install Wireless Tools, use the following commands:

make

This package does not come with a test suite.

Now, as the root user:

make PREFIX=/usr INSTALL_MAN=/usr/share/man install

Command Explanations

INSTALL_MAN=/usr/share/man: Install manual pages in /usr/share/man instead of /usr/man.

Contents

Installed Programs: ifrename, iwconfig, iwevent, iwgetid, iwlist, iwpriv, and iwspy
Installed Library: libiw.so
Installed Directories: None

Short Descriptions

ifrename

renames network interfaces based on various static criteria

iwconfig

configures a wireless network interface

iwevent

displays wireless events generated by drivers and setting changes

iwgetid

reports ESSID, NWID or AP/Cell Address of wireless networks

iwlist

gets detailed wireless information from a wireless interface

iwpriv

configures optional (private) parameters of a wireless network interface

iwspy

gets wireless statistics from specific node

libiw.so

contains functions required by the wireless programs and provides an API for other programs

wpa_supplicant-2.10

Introduction to WPA Supplicant

WPA Supplicant is a Wi-Fi Protected Access (WPA) client and IEEE 802.1X supplicant. It implements WPA key negotiation with a WPA Authenticator and Extensible Authentication Protocol (EAP) authentication with an Authentication Server. In addition, it controls the roaming and IEEE 802.11 authentication/association of the wireless LAN driver. This is useful for connecting to a password protected wireless access point.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

WPA Supplicant Dependencies

Required (Runtime)

Configuring the Linux Kernel for Wireless

Recommended
Optional

libxml2-2.10.4, and (Qt-5.15.10 or qt-alternate-5.15.10)

Kernel Configuration

To use wpa_supplicant, the kernel must have the appropriate drivers and other support available. Read Configuring the Linux Kernel for Wireless for details.

Installation of WPA Supplicant

First you will need to create an initial configuration file for the build process. You can read wpa_supplicant/README and wpa_supplicant/defconfig for the explanation of the following options as well as other options that can be used. Create a build configuration file that should work for standard WiFi setups by running the following command:

cat > wpa_supplicant/.config << "EOF"
CONFIG_BACKEND=file
CONFIG_CTRL_IFACE=y
CONFIG_DEBUG_FILE=y
CONFIG_DEBUG_SYSLOG=y
CONFIG_DEBUG_SYSLOG_FACILITY=LOG_DAEMON
CONFIG_DRIVER_NL80211=y
CONFIG_DRIVER_WEXT=y
CONFIG_DRIVER_WIRED=y
CONFIG_EAP_GTC=y
CONFIG_EAP_LEAP=y
CONFIG_EAP_MD5=y
CONFIG_EAP_MSCHAPV2=y
CONFIG_EAP_OTP=y
CONFIG_EAP_PEAP=y
CONFIG_EAP_TLS=y
CONFIG_EAP_TTLS=y
CONFIG_IEEE8021X_EAPOL=y
CONFIG_IPV6=y
CONFIG_LIBNL32=y
CONFIG_PEERKEY=y
CONFIG_PKCS12=y
CONFIG_READLINE=y
CONFIG_SMARTCARD=y
CONFIG_WPS=y
CFLAGS += -I/usr/include/libnl3
EOF

If you wish to use WPA Supplicant with NetworkManager-1.44.0, make sure that you have installed dbus-1.14.8 and libxml2-2.10.4, then add the following options to the WPA Supplicant build configuration file by running the following command:

cat >> wpa_supplicant/.config << "EOF"
CONFIG_CTRL_IFACE_DBUS=y
CONFIG_CTRL_IFACE_DBUS_NEW=y
CONFIG_CTRL_IFACE_DBUS_INTRO=y
EOF

Install WPA Supplicant by running the following commands:

cd wpa_supplicant &&
make BINDIR=/usr/sbin LIBDIR=/usr/lib

If you have installed (Qt-5.15.10 or qt-alternate-5.15.10) and wish to build the WPA Supplicant GUI program, run the following commands:

Note

The following directory name is labelled qt4, but is compatible with (Qt-5.15.10 or qt-alternate-5.15.10).

pushd wpa_gui-qt4 &&
qmake wpa_gui.pro &&
make &&
popd

This package does not come with a test suite.

Now, as the root user:

install -v -m755 wpa_{cli,passphrase,supplicant} /usr/sbin/ &&
install -v -m644 doc/docbook/wpa_supplicant.conf.5 /usr/share/man/man5/ &&
install -v -m644 doc/docbook/wpa_{cli,passphrase,supplicant}.8 /usr/share/man/man8/

Install the systemd support files by running the following command as the root user:

install -v -m644 systemd/*.service /usr/lib/systemd/system/

If you have built WPA Supplicant with D-Bus support, you will need to install D-Bus configuration files. Install them by running the following commands as the root user:

install -v -m644 dbus/fi.w1.wpa_supplicant1.service \
                 /usr/share/dbus-1/system-services/ &&
install -v -d -m755 /etc/dbus-1/system.d &&
install -v -m644 dbus/dbus-wpa_supplicant.conf \
                 /etc/dbus-1/system.d/wpa_supplicant.conf

Additionally, enable the wpa_supplicant.service so that systemd can properly activate the D-Bus service. Note that the per-connection service and the D-Bus service cannot be enabled at the same time. Run the following command as the root user:

systemctl enable wpa_supplicant

If you have built the WPA Supplicant GUI program, install it by running the following commands as the root user:

install -v -m755 wpa_gui-qt4/wpa_gui /usr/bin/ &&
install -v -m644 doc/docbook/wpa_gui.8 /usr/share/man/man8/ &&
install -v -m644 wpa_gui-qt4/wpa_gui.desktop /usr/share/applications/ &&
install -v -m644 wpa_gui-qt4/icons/wpa_gui.svg /usr/share/pixmaps/

Note

You will need to restart the system D-Bus daemon before you can use the WPA Supplicant D-Bus interface.

Note

This package installs desktop files into the /usr/share/applications hierarchy and you can improve system performance and memory usage by updating /usr/share/applications/mimeinfo.cache. To perform the update you must have desktop-file-utils-0.26 installed and issue the following command as the root user:

update-desktop-database -q

Configuring wpa_supplicant

Config File

/etc/wpa_supplicant/wpa_supplicant-*.conf

Configuration Information

To connect to an access point that uses a password, you need to put the pre-shared key in /etc/wpa_supplicant/wpa_supplicant-wifi0.conf. SSID is the string that the access point/router transmits to identify itself. Run the following command as the root user:

install -v -dm755 /etc/wpa_supplicant &&
wpa_passphrase SSID SECRET_PASSWORD > /etc/wpa_supplicant/wpa_supplicant-wifi0.conf

/etc/wpa_supplicant/wpa_supplicant-wifi0.conf can hold the details of several access points. When wpa_supplicant is started, it will scan for the SSIDs it can see and choose the appropriate password to connect.

If you want to connect to an access point that isn't password protected, put an entry like this in /etc/wpa_supplicant/wpa_supplicant-wifi0.conf. Replace "Some-SSID" with the SSID of the access point/router.

network={
  ssid="Some-SSID"
  key_mgmt=NONE
}

Connecting to a new access point that is not in the configuration file can be accomplished manually via the command line or GUI, but it must be done via a privileged user. To do that, add the following to the configuration file:

                ctrl_interface=DIR=/run/wpa_supplicant GROUP=<privileged group>
update_config=1

Replace the <privileged group> above with a system group where members have the ability to connect to a wireless access point.

There are many options that you could use to tweak how you connect to each access point. They are described in some detail in the wpa_supplicant/wpa_supplicant.conf file in the source tree.

Connecting to an Access Point

There are 3 types of systemd units that were installed:

The only difference between 3 of them is what driver is used for connecting (-D option). The first one uses the default driver, the second one uses the nl80211 driver and the third one uses the wired driver.

You can connect to the wireless access point by running the following command as the root user:

systemctl start wpa_supplicant@wlan0

To connect to the wireless access point at boot, simply enable the appropriate wpa_supplicant service by running the following command as the root user:

systemctl enable wpa_supplicant@wlan0

Depending on your setup, you can replace the [email protected] with any other listed above.

To assign a network address to your wireless interface, consult the General Network Configuration page in LFS.

Contents

Installed Programs: wpa_gui, wpa_supplicant, wpa_passphrase and wpa_cli
Installed Libraries: None
Installed Directories: None

Short Descriptions

wpa_gui

is a graphical frontend program for interacting with wpa_supplicant

wpa_supplicant

is a daemon that can connect to a password protected wireless access point

wpa_passphrase

takes an SSID and a password and generates a simple configuration that wpa_supplicant can understand

wpa_cli

is a command line interface used to control a running wpa_supplicant daemon

Chapter 16. Networking Utilities

This chapter contains some tools that come in handy when the network needs investigating.

Avahi-0.8

Introduction to Avahi

The Avahi package is a system which facilitates service discovery on a local network.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Avahi Dependencies

Required

GLib-2.76.4

Recommended
Optional

D-Bus Python-1.3.2, libevent-2.1.12, PyGTK-2.24.0, Doxygen-1.9.7 and xmltoman (for generating documentation)

Installation of Avahi

There should be a dedicated user and group to take control of the avahi-daemon daemon after it is started. Issue the following commands as the root user:

groupadd -fg 84 avahi &&
useradd -c "Avahi Daemon Owner" -d /run/avahi-daemon -u 84 \
        -g avahi -s /bin/false avahi

There should also be a dedicated privileged access group for Avahi clients. Issue the following command as the root user:

groupadd -fg 86 netdev

Fix a regression that results in a race condition when IPv6 is in use and multiple network adapters are present on the system:

patch -Np1 -i ../avahi-0.8-ipv6_race_condition_fix-1.patch

Fix a security vulnerability in avahi-daemon:

sed -i '426a if (events & AVAHI_WATCH_HUP) { \
client_free(c); \
return; \
}' avahi-daemon/simple-protocol.c

Install Avahi by running the following commands:

./configure \
    --prefix=/usr        \
    --sysconfdir=/etc    \
    --localstatedir=/var \
    --disable-static     \
    --disable-libevent   \
    --disable-mono       \
    --disable-monodoc    \
    --disable-python     \
    --disable-qt3        \
    --disable-qt4        \
    --enable-core-docs   \
    --with-distro=none   \
    --with-dbus-system-address='unix:path=/run/dbus/system_bus_socket' &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--disable-libevent: This parameter disables the use of libevent-2.1.12. Remove if you have it installed.

--disable-mono: This parameter disables the Mono bindings.

--disable-monodoc: This parameter disables documentation for the Mono bindings.

--disable-python: This parameter disables the scripts that depend on Python. It also allows a regular install to complete successfully.

--disable-qt3: This parameter disables the attempt to build the obsolete Qt3 portions of the package.

--disable-qt4: This parameter disables the attempt to build the obsolete Qt4Core portions of the package.

--enable-core-docs: This parameter enables the building of documentation.

--with-distro=none: There is an obsolete boot script in the distribution for LFS. This option disables it.

--with-dbus-system-address=...: This option prevents the package from referring to the deprecated /var/run directory.

--disable-dbus: This parameter disables the use of D-Bus.

--disable-gtk: This parameter disables the use of GTK+2.

--disable-gtk3: This parameter disables the use of GTK+3.

--disable-qt5: This parameter disables the use of Qt5, and allows building without it.

--disable-libdaemon: This parameter disables the use of libdaemon. If you use this option, avahi-daemon won't be built.

--enable-tests: This option enables the building of tests and examples.

--enable-compat-howl: This option enables the compatibility layer for HOWL.

--enable-compat-libdns_sd: This option enables the compatibility layer for libdns_sd.

Configuring avahi

Boot Script

To start the avahi-daemon daemon at boot, enable the previously installed systemd unit by running the following command as the root user:

systemctl enable avahi-daemon

To start the avahi-dnsconfd daemon at boot, enable the previously installed systemd unit by running the following command as the root user:

systemctl enable avahi-dnsconfd

Contents

Installed Programs: avahi-autoipd, avahi-browse, avahi-browse-domains, avahi-daemon, avahi-discover-standalone, avahi-dnsconfd, avahi-publish, avahi-publish-address, avahi-publish-service, avahi-resolve, avahi-resolve-address, avahi-resolve-host-name, avahi-set-host-name, bshell, bssh, and bvnc
Installed Libraries: libavahi-client.so, libavahi-common.so, libavahi-core.so, libavahi-glib.so, libavahi-gobject.so, libavahi-libevent.so libavahi-ui-gtk3.so, libavahi-qt5, libavahi-ui.so, libdns_sd.so, and libhowl.so,
Installed Directories: /etc/avahi/services, /usr/include/{avahi-client,avahi-common, avahi-compat-howl, avahi-compat-libdns_sd, avahi-core, avahi-glib, avahi-gobject, avahi-libevent, avahi-qt5, avahi-ui}, /usr/lib/avahi, /usr/share/avahi

Short Descriptions

avahi-autoipd

is a IPv4LL network address configuration daemon

avahi-browse

browses for mDNS/DNS-SD services using the Avahi daemon

avahi-browse-domains

browses for mDNS/DNS-SD services using the Avahi daemon

avahi-daemon

is the Avahi mDNS/DNS-SD daemon

avahi-discover-standalone

browses for mDNS/DNS-SD services using the Avahi daemon

avahi-dnsconfd

is a Unicast DNS server from mDNS/DNS-SD configuration daemon

avahi-publish

registers a mDNS/DNS-SD service or host name or address mapping using the Avahi daemon

avahi-publish-address

registers a mDNS/DNS-SD service or host name or address mapping using the Avahi daemon

avahi-publish-service

registers a mDNS/DNS-SD service or host name or address mapping using the Avahi daemon

avahi-resolve

resolves one or more mDNS/DNS host name(s) to IP address(es) (and vice versa) using the Avahi daemon

avahi-resolve-address

resolves one or more mDNS/DNS host name(s) to IP address(es) (and vice versa) using the Avahi daemon

avahi-resolve-host-name

resolves one or more mDNS/DNS host name(s) to IP address(es) (and vice versa) using the Avahi daemon

avahi-set-host-name

changes the mDNS host name

bssh

browses for SSH servers on the local network

bvnc

browses for VNC servers on the local network

BIND Utilities-9.18.18

Introduction to BIND Utilities

BIND Utilities is not a separate package, it is a collection of the client side programs that are included with BIND-9.18.18. The BIND package includes the client side programs nslookup, dig and host. If you install BIND server, these programs will be installed automatically. This section is for those users who don't need the complete BIND server, but need these client side applications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

BIND Utilities Dependencies

Required

libuv-1.46.0

Recommended
Optional

libcap-2.69 with PAM, libxml2-2.10.4, and sphinx-7.1.2

Installation of BIND Utilities

Install BIND Utilities by running the following commands:

./configure --prefix=/usr &&
make -C lib/isc    &&
make -C lib/dns    &&
make -C lib/ns     &&
make -C lib/isccfg &&
make -C lib/bind9  &&
make -C lib/irs    &&
make -C bin/dig    &&
make -C doc

This portion of the package does not come with a test suite.

Now, as the root user:

make -C lib/isc    install &&
make -C lib/dns    install &&
make -C lib/ns     install &&
make -C lib/isccfg install &&
make -C lib/bind9  install &&
make -C lib/irs    install &&
make -C bin/dig    install &&
cp -v doc/man/{dig.1,host.1,nslookup.1} /usr/share/man/man1

Command Explanations

--disable-doh: Use this option if you have not installed nghttp2-1.55.1 and you don't need DNS over HTTPS support.

make -C lib/...: These commands build the libraries that are needed for the client programs.

make -C bin/dig: This command builds the client programs.

make -C doc: This command builds the manual pages if the optional Python module sphinx-7.1.2 is installed.

Use cp -v doc/man/{dig.1,host.1,nslookup.1} /usr/share/man/man1 to install the the manual pages if they have been built.

Contents

Installed Programs: dig, host, and nslookup
Installed Libraries: None
Installed Directories: None

Short Descriptions

See the program descriptions in the BIND-9.18.18 section.

NetworkManager-1.44.0

Introduction to NetworkManager

NetworkManager is a set of co-operative tools that make networking simple and straightforward. Whether you use WiFi, wired, 3G, or Bluetooth, NetworkManager allows you to quickly move from one network to another: Once a network has been configured and joined once, it can be detected and re-joined automatically the next time it's available.

This package is known to build and work properly using an LFS 12.0 platform.

Note

Make sure that you disable the systemd-networkd service or configure it not to manage the interfaces you want to manage with NetworkManager.

Package Information

NetworkManager Dependencies

Required

jansson-2.14 and libndp-1.8

Recommended
Optional

BlueZ-5.68, D-Bus Python-1.3.2 (for the test suite), GnuTLS-3.8.1 (can be used instead of nss-3.92), GTK-Doc-1.33.2, libpsl-0.21.2, (Qt-5.15.10 or qt-components-5.15.10 with qtdoc) (for examples), ModemManager-1.18.12, UPower-1.90.2, Valgrind-3.21.0, dnsmasq, firewalld, libaudit, libteam, mobile-broadband-provider-info, PPP, and RP-PPPoE

Kernel Configuration

If you wish to run the tests, check that at least the following options are enabled in the kernel configuration. Those options have been determined to be necessary, but may not be sufficient. Recompile the kernel if necessary:

[*] Networking support --->                                                [NET]
  Networking options --->
    [*]   TCP/IP networking                                               [INET]
    <*/M>   IP: tunneling                                             [NET_IPIP]
    <*/M>   IP: GRE demultiplexer                              [NET_IPGRE_DEMUX]
    <*/M>   IP: GRE tunnels over IP                                  [NET_IPGRE]
    <*>     The IPv6 protocol --->                                        [IPV6]
      <*/M>   IPv6: IPv6-in-IPv4 tunnel (SIT driver)                  [IPV6_SIT]
      <*/M>   IPv6: GRE tunnel                                        [IPV6_GRE]
      [*]     IPv6: Multiple Routing Tables               [IPV6_MULTIPLE_TABLES]
    [*]     MPTCP: Multipath TCP                                         [MPTCP]
    [*]       MPTCP: IPv6 support for Multipath TCP                 [MPTCP_IPV6]
    <*/M> 802.1Q/802.1ad VLAN Support                               [VLAN_8021Q]
    [*]   QoS and/or fair queueing --->                              [NET_SCHED]
      <*> Stochastic Fairness Queueing (SFQ)                       [NET_SCH_SFQ]
      <*> Token Bucket Filter (TBF)                                [NET_SCH_TBF]
      <*> Fair Queue Controlled Delay AQM (FQ_CODEL)          [NET_SCH_FQ_CODEL]
      <*> Ingress/classifier-action Qdisc                      [NET_SCH_INGRESS]

Device Drivers --->
  [*] Network device support --->                                   [NETDEVICES]
    [*]   Network core driver support                                 [NET_CORE]
    <*/M>   Bonding driver support                                     [BONDING]
    <*/M>   Dummy net driver support                                     [DUMMY]
    <*/M>   Ethernet team driver support --->                         [NET_TEAM]
    <*/M>   MAC-VLAN support                                           [MACVLAN]
    <*/M>     MAC-VLAN based tap driver                                [MACVTAP]
    <*/M>   IP-VLAN support                                             [IPVLAN]
    <*/M>   Virtual eXtensible Local Area Network (VXLAN)                [VXLAN]
    <*/M>   Virtual ethernet pair device                                  [VETH]
    <*/M>   Virtual Routing and Forwarding (Lite)                      [NET_VRF]

Installation of NetworkManager

If Qt-5.15.10 is installed and the Qt based examples are desired, fix two meson.build files:

sed -e 's/-qt4/-qt5/'              \
    -e 's/moc_location/host_bins/' \
    -i examples/C/qt/meson.build   &&

sed -e 's/Qt/&5/'                  \
    -i meson.build

Fix the python scripts so that they use Python 3:

grep -rl '^#!.*python$' | xargs sed -i '1s/python/&3/'

Install NetworkManager by running the following commands:

mkdir build &&
cd    build    &&

CXXFLAGS+="-O2 -fPIC"            \
meson setup ..                   \
      --prefix=/usr              \
      --buildtype=release        \
      -Dlibaudit=no              \
      -Dlibpsl=false             \
      -Dnmtui=true               \
      -Dovs=false                \
      -Dppp=false                \
      -Dselinux=false            \
      -Dqt=false                 \
      -Dsession_tracking=systemd \
      -Dmodem_manager=false      &&
ninja

An already active graphical session with a bus address is necessary to run the tests. To test the results, issue ninja test.

A few tests may fail, depending on enabled kernel options.

Now, as the root user:

ninja install &&
mv -v /usr/share/doc/NetworkManager{,-1.44.0}

If you have not passed the -Ddocs=true option to meson, you can install the pregenerated manual pages with (as the root user):

for file in $(echo ../man/*.[1578]); do
    section=${file##*.} &&
    install -vdm 755 /usr/share/man/man$section
    install -vm 644 $file /usr/share/man/man$section/
done

If you have not used -Ddocs=true, the pregenerated HTML documentation can also be installed with (as the root user):

cp -Rv ../docs/{api,libnm} /usr/share/doc/NetworkManager-1.44.0

Command Explanations

CXXFLAGS="-O2 -fPIC": These compiler options are necessary to build the Qt5 based examples.

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Ddocs=true: Use this switch to enable building man pages and documentation if GTK-Doc-1.33.2 is installed.

-Dnmtui=true: This switch enables building nmtui.

-Dlibpsl=false and -Dovs=false: These switches disable building with the respective libraries. Remove these if you have the needed libraries installed on your system.

-Dmodem_manager=false: This switch is required if ModemManager is not installed. Omit this switch if you have built ModemManager and mobile-broadband-provider-info.

-Dsession_tracking=systemd: This switch is used to set systemd-logind as the default program for session tracking.

-Dsystemdsystemunitdir=/lib/systemd/system: This switch is used to set the correct installation directory for systemd units.

-Dppp=false: This switch disables PPP support in NetworkManager since the programs necessary for it are not installed. Remove this switch if you need PPP support and have PPP installed.

-Dlibaudit=no and -Dselinux=false: This switch disables support for libaudit and SELinux since they are not used in BLFS.

-Dqt=false: This switch disables the Qt examples. Omit if you have Qt available and wish to install the examples.

-Dcrypto=gnutls: Use this switch if you have GnuTLS installed and want to use it for certificate and key operations in NetworkManager, instead of using NSS (the default).

-Dcrypto=null: Use this switch if neither NSS nor GnuTLS is installed but you want to build NetworkManager anyway. This switch will make NetworkManager lack some features (for example 802.1X).

-Dsuspend_resume=upower: Use this switch if you have UPower-1.90.2 installed and want to use it (instead of Systemd-254) for suspend and resume support.

Configuring NetworkManager

Config Files

/etc/NetworkManager/NetworkManager.conf

Configuration Information

For NetworkManager to work, at least a minimal configuration file must be present. Such a file is not installed with make install. Issue the following command as the root user to create a minimal NetworkManager.conf file:

cat >> /etc/NetworkManager/NetworkManager.conf << "EOF"
[main]
plugins=keyfile
EOF

This file should not be modified directly by users of the system. Instead, system specific changes should be made using configuration files in the /etc/NetworkManager/conf.d directory.

To allow polkit to manage authorizations, add the following configuration file:

cat > /etc/NetworkManager/conf.d/polkit.conf << "EOF"
[main]
auth-polkit=true
EOF

To use something other than the built-in dhcp client (recommended if using only nmcli), use the following configuration (valid values include either dhcpcd or internal):

cat > /etc/NetworkManager/conf.d/dhcp.conf << "EOF"
[main]
dhcp=dhcpcd
EOF

To prevent NetworkManager from updating the /etc/resolv.conf file, add the following configuration file:

cat > /etc/NetworkManager/conf.d/no-dns-update.conf << "EOF"
[main]
dns=none
EOF

For additional configuration options, see man 5 NetworkManager.conf.

To allow regular users to configure network connections, you should add them to the netdev group, and create a polkit rule that grants access. Run the following commands as the root user:

groupadd -fg 86 netdev &&
/usr/sbin/usermod -a -G netdev <username>

cat > /usr/share/polkit-1/rules.d/org.freedesktop.NetworkManager.rules << "EOF"
polkit.addRule(function(action, subject) {
    if (action.id.indexOf("org.freedesktop.NetworkManager.") == 0 && subject.isInGroup("netdev")) {
        return polkit.Result.YES;
    }
});
EOF

Systemd Unit

To start the NetworkManager daemon at boot, enable the previously installed systemd unit by running the following command as the root user:

Note

If using Network Manager to manage an interface, any previous configuration for that interface should be removed, and the interface brought down prior to starting Network Manager.

systemctl enable NetworkManager

Starting in version 1.11.2 of NetworkManager, a systemd unit named NetworkManager-wait-online.service is enabled, which is used to prevent services that require network connectivity from starting until NetworkManager establishes a connection. To disable this behavior, run the following command as the root user:

systemctl disable NetworkManager-wait-online

Contents

Installed Programs: NetworkManager, nmcli, nm-online, nmtui, and, symlinked to nmtui: nmtui-connect, nmtui-edit, and nmtui-hostname
Installed Libraries: libnm.so and several modules under /usr/lib/NetworkManager
Installed Directories: /etc/NetworkManager, /usr/include/libnm, /usr/lib/NetworkManager, /usr/share/doc/NetworkManager-1.44.0, /usr/share/gtk-doc/html/{libnm,NetworkManager} (if the documentation is built), and /var/lib/NetworkManager

Short Descriptions

nmcli

is a command-line tool for controlling NetworkManager and getting its status

nm-online

is an utility to determine whether you are online

nmtui

is an interactive ncurses-based user interface for nmcli

nmtui-connect

is an interactive ncurses-based user interface to activate/deactivate connections

nmtui-edit

is an interactive ncurses-based user interface to edit connections

nmtui-hostname

is an interactive ncurses-based user interface to edit the hostname

NetworkManager

is the network management daemon

libnm.so

contains functions used by NetworkManager

network-manager-applet-1.32.0

Introduction to NetworkManager Applet

The NetworkManager Applet provides a tool and a panel applet used to configure wired and wireless network connections through GUI. It's designed for use with any desktop environment that uses GTK+, such as Xfce and LXDE.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

NetworkManager Applet Dependencies

Required

GTK+-3.24.38, libnma-1.10.6, and libsecret-0.21.0

Recommended
Required (Runtime)

Since this package uses Polkit-123 for authorization, one Polkit Authentication Agent should be running when the functionality of this package is used.

Optional

gnome-bluetooth-42.6 and libindicator

Installation of NetworkManager Applet

Install NetworkManager Applet by running the following commands:

mkdir build &&
cd    build &&

meson setup ..            \
      --prefix=/usr       \
      --buildtype=release \
      -Dappindicator=no   \
      -Dselinux=false     &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

-Dappindicator=no: This switch disables AppIndicator support in network-manager-applet because it requires libindicator, which is not in BLFS. The build will fail without this option.

-Dselinux=false: This switch forcibly disables SELinux support since it is not currently in BLFS and the build will fail without it.

-Dwwan=false: This switch disables WWAN support. Use this if you do not have ModemManager-1.18.12 installed.

Contents

Installed Programs: nm-applet and nm-connection-editor
Installed Libraries: None
Installed Directories: None

Short Descriptions

nm-connection-editor

allows users to view and edit network connection settings

Nmap-7.94

Introduction to Nmap

Nmap is a utility for network exploration and security auditing. It supports ping scanning, port scanning and TCP/IP fingerprinting.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://nmap.org/dist/nmap-7.94.tar.bz2

  • Download MD5 sum: 4f65e08148d1eaac6b1a1482e7185e1d

  • Download size: 11 MB

  • Estimated disk space required: 138 MB (add 17 MB for tests)

  • Estimated build time: 0.3 SBU (Using parallelism=4; add 0.1 SBU for tests)

Nmap Dependencies

Recommended

Note

These packages are recommended because if they're not installed, the build process will compile and link against its own (often older) version.

Optional

libdnet

Installation of Nmap

Install Nmap by running the following commands:

./configure --prefix=/usr &&
make

To test the results, issue: make check as the root user. Tests need a graphical session.

Now, as the root user:

make install

Contents

Installed Programs: ncat, ndiff, nmap, nping, uninstall_ndiff, uninstall_zenmap, zenmap, and 2 symlinks to zenmap: nmapfe and xnmap
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/{radialnet,zenmapCore,zenmapGUI,zenmap-7.94-py3.11.egg-info}, and /usr/share/{ncat,nmap,zenmap}

Short Descriptions

ncat

is a utility for reading and writing data across networks from the command line

ndiff

is a tool to aid in the comparison of Nmap scans

nmap

is a utility for network exploration and security auditing. It supports ping scanning, port scanning and TCP/IP fingerprinting

nping

is an open-source tool for network packet generation, response analysis and response time measurement

uninstall_ndiff

is a Python script to uninstall ndiff

uninstall_zenmap

is a Python script to uninstall zenmap

zenmap

is a Python based graphical nmap frontend viewer

Traceroute-2.1.2

Introduction to Traceroute

The Traceroute package contains a program which is used to display the network route that packets take to reach a specified host. This is a standard network troubleshooting tool. If you find yourself unable to connect to another system, traceroute can help pinpoint the problem.

Note

This package overwrites the version of traceroute that was installed in the inetutils package in LFS. This version is more powerful and allows many more options than the standard version.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Traceroute

Install Traceroute by running the following commands:

make

This package does not come with a test suite.

Now, as the root user:

make prefix=/usr install                                 &&
ln -sv -f traceroute /usr/bin/traceroute6                &&
ln -sv -f traceroute.8 /usr/share/man/man8/traceroute6.8 &&
rm -fv /usr/share/man/man1/traceroute.1

The traceroute.1 file that was installed in LFS by inetutils is no longer relevant. This package overwrites that version of traceroute and installs the man page in man chapter 8.

Contents

Installed Program: traceroute and traceroute6 (symlink)
Installed Libraries: None
Installed Directories: None

Short Descriptions

traceroute

does basically what it says: it traces the route your packets take from the host you are working on to another host on a network, showing all the intermediate hops (gateways) along the way

traceroute6

is equivalent to traceroute -6

Whois-5.4.3

Introduction to Whois

Whois is a client-side application which queries the whois directory service for information pertaining to a particular domain name. This package will install two programs by default: whois and mkpasswd. The mkpasswd command is also installed by the expect package in LFS.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Whois Dependencies

Optional

libidn-1.41 or libidn2-2.3.4

Installation of Whois

Build the application with:

make

You can install the whois program, the mkpasswd program, and the locale files independently. Control your choice of what is installed with the following commands issued as the root user:

Note

Installing this version of mkpasswd will overwrite the same command installed in LFS.

make prefix=/usr install-whois
make prefix=/usr install-mkpasswd
make prefix=/usr install-pos

Contents

Installed Programs: whois and mkpasswd
Installed Libraries: None
Installed Directories: None

Short Descriptions

whois

is a client-side application which queries the whois directory service for information pertaining to a particular domain name

mkpasswd

generates a new password, and optionally applies it to a user

Wireshark-4.0.7

Introduction to Wireshark

The Wireshark package contains a network protocol analyzer, also known as a sniffer. This is useful for analyzing data captured off the wire from a live network connection, or data read from a capture file.

Wireshark provides both a graphical and a TTY-mode front-end for examining captured network packets from over 500 protocols, as well as the capability to read capture files from many other popular network analyzers.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Wireshark dependencies

Required

CMake-3.27.2, GLib-2.76.4, libgcrypt-1.10.2, and (Qt-5.15.10 or qt-components-5.15.10 with qtmultimedia)

Recommended
Optional

asciidoctor-2.0.20, Brotli-1.0.9, c-ares-1.19.1, Doxygen-1.9.7, git-2.41.0, GnuTLS-3.8.1, libnl-3.7.0, libxslt-1.1.38, libxml2-2.10.4, Lua-5.2.4, MIT Kerberos V5-1.21.2, nghttp2-1.55.1, SBC-2.0, Speex-1.2.1, BCG729, libilbc, libsmi, lz4, libssh, MaxMindDB, Minizip, Snappy, and Spandsp

Kernel Configuration

The kernel must have the Packet protocol enabled for Wireshark to capture live packets from the network:

[*] Networking support --->                                                [NET]
  Networking options --->
    <*/M> Packet socket                                                 [PACKET]

If built as a module, the name is af_packet.ko.

Installation of Wireshark

Wireshark is a very large and complex application. These instructions provide additional security measures to ensure that only trusted users are allowed to view network traffic. First, set up a system group for wireshark. As the root user:

groupadd -g 62 wireshark

Continue to install Wireshark by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DCMAKE_INSTALL_DOCDIR=/usr/share/doc/wireshark-4.0.7 \
      -G Ninja \
      .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install &&

install -v -m755 -d /usr/share/doc/wireshark-4.0.7 &&
install -v -m644    ../README.linux ../doc/README.* ../doc/randpkt.txt \
                    /usr/share/doc/wireshark-4.0.7 &&

pushd /usr/share/doc/wireshark-4.0.7 &&
   for FILENAME in ../../wireshark/*.html; do
      ln -s -v -f $FILENAME .
   done &&
popd
unset FILENAME

If you downloaded any of the documentation files from the page listed in the 'Additional Downloads', install them by issuing the following commands as the root user:

install -v -m644 <Downloaded_Files> \
                 /usr/share/doc/wireshark-4.0.7

Now, set ownership and permissions of sensitive applications to only allow authorized users. As the root user:

chown -v root:wireshark /usr/bin/{tshark,dumpcap} &&
chmod -v 6550 /usr/bin/{tshark,dumpcap}

Finally, add any users to the wireshark group (as root user):

usermod -a -G wireshark <username>

If you are installing wireshark for the first time, it will be necessary to logout of your session and login again. This will put wireshark in your groups, because otherwise Wireshark will not function properly.

Configuring Wireshark

Config Files

/etc/wireshark.conf and ~/.config/wireshark/* (unless there is already ~/.wireshark/* in the system)

Configuration Information

Though the default configuration parameters are very sane, reference the configuration section of the Wireshark User's Guide for configuration information. Most of Wireshark 's configuration can be accomplished using the menu options of the wireshark graphical interfaces.

Note

If you want to look at packets, make sure you don't filter them out with iptables-1.8.9. If you want to exclude certain classes of packets, it is more efficient to do it with iptables than it is with Wireshark.

Contents

Installed Programs: capinfos, captype, dumpcap, editcap, idl2wrs, mergecap, randpkt, rawshark, reordercap, sharkd, text2pcap, tshark, and wireshark
Installed Libraries: libwireshark.so, libwiretap.so, libwsutil.so, and numerous modules under /usr/lib/wireshark/plugins
Installed Directories: /usr/{include,lib,share}/wireshark and /usr/share/doc/wireshark-4.0.7

Short Descriptions

capinfos

reads a saved capture file and returns any or all of several statistics about that file. It is able to detect and read any capture supported by the Wireshark package

captype

prints the file types of capture files

dumpcap

is a network traffic dump tool. It lets you capture packet data from a live network and write the packets to a file

editcap

edits and/or translates the format of capture files. It knows how to read libpcap capture files, including those of tcpdump, Wireshark and other tools that write captures in that format

idl2wrs

is a program that takes a user specified CORBA IDL file and generates C source code for a Wireshark plugin. It relies on two Python programs wireshark_be.py and wireshark_gen.py, which are not installed by default. They have to be copied manually from the tools directory to the $PYTHONPATH/site-packages/ directory

mergecap

combines multiple saved capture files into a single output file

randpkt

creates random-packet capture files

rawshark

dumps and analyzes raw libpcap data

reordercap

reorders timestamps of input file frames into an output file

sharkd

is a daemon that listens on UNIX sockets

text2pcap

reads in an ASCII hex dump and writes the data described into a libpcap-style capture file

tshark

is a TTY-mode network protocol analyzer. It lets you capture packet data from a live network or read packets from a previously saved capture file

wireshark

is the Qt GUI network protocol analyzer. It lets you interactively browse packet data from a live network or from a previously saved capture file

libwireshark.so

contains functions used by the Wireshark programs to perform filtering and packet capturing

libwiretap.so

is a library being developed as a future replacement for libpcap, the current standard Unix library for packet capturing. For more information, see the README file in the source wiretap directory

Chapter 17. Networking Libraries

These applications are support libraries for other applications in the book. It is unlikely that you would just install these libraries, you will generally find that you will be referred to this chapter to satisfy a dependency of other applications.

c-ares-1.19.1

Introduction to c-ares

c-ares is a C library for asynchronous DNS requests.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

c-ares Dependencies

Required

CMake-3.27.2

Installation of c-ares

Install c-ares by running the following commands:

mkdir build &&
cd    build &&

cmake  -DCMAKE_INSTALL_PREFIX=/usr .. &&
make

This package does not include a test suite.

Now, as the root user:

make install

Contents

Installed Programs: acountry, adig, and ahost
Installed Libraries: libcares.so
Installed Directories: None

Short Descriptions

acountry

prints the country where an IPv4 address or host is located

adig

queries information from DNS servers

ahost

prints the A or AAAA record associated with a hostname or IP address

libcares.so

is a C library for asynchronous DNS requests

cURL-8.2.1

Introduction to cURL

The cURL package contains an utility and a library used for transferring files with URL syntax to any of the following protocols: DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP, HTTPS, IMAP, IMAPS, LDAP, LDAPS, MQTT, POP3, POP3S, RTSP, SMB, SMBS, SMTP, SMPTS, TELNET, and TFTP. Its ability to both download and upload files can be incorporated into other programs to support functions like streaming media.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://curl.se/download/curl-8.2.1.tar.xz

  • Download MD5 sum: 556576a795bdd2c7d10de6886480065f

  • Download size: 2.5 MB

  • Estimated disk space required: 42 MB (add 23 MB for tests)

  • Estimated build time: 0.1 SBU (with parallelism=4; add 15 SBU for tests (without valgrind, add 36 SBU with valgrind)

cURL Dependencies

Recommended
Optional

Brotli-1.0.9, c-ares-1.19.1, GnuTLS-3.8.1, libidn2-2.3.4, libpsl-0.21.2, libssh2-1.11.0, MIT Kerberos V5-1.21.2, nghttp2-1.55.1, OpenLDAP-2.6.6, Samba-4.18.6 (runtime, for NTLM authentication), gsasl, impacket, libmetalink, librtmp, ngtcp2, quiche, and SPNEGO

Optional if Running the Test Suite

Apache-2.4.57 and stunnel-5.70 (for the HTTPS and FTPS tests), and Valgrind-3.21.0 (this will slow the tests down and may cause failures.)

Installation of cURL

Install cURL by running the following commands:

./configure --prefix=/usr                           \
            --disable-static                        \
            --with-openssl                          \
            --enable-threaded-resolver              \
            --with-ca-path=/etc/ssl/certs &&
make

To run the test suite, issue: make test. The tests related to the SMB protocol will output a message duplicated many times complaining the Python module impacket (not a part of BLFS) is missing and will be skipped.

Now, as the root user:

make install &&

rm -rf docs/examples/.deps &&

find docs \( -name Makefile\* -o  \
             -name \*.1       -o  \
             -name \*.3       -o  \
             -name CMakeLists.txt \) -delete &&

cp -v -R docs -T /usr/share/doc/curl-8.2.1

To run some simple verification tests on the newly installed curl, issue the following commands: curl --trace-ascii debugdump.txt https://www.example.com/ and curl --trace-ascii d.txt --trace-time https://example.com/. Inspect the locally created trace files debugdump.txt and d.txt, which contains version information, downloaded files information, etc. One file has the time for each action logged.

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-threaded-resolver: This switch enables cURL's builtin threaded DNS resolver.

--with-ca-path=/etc/ssl/certs: This switch sets the location of the BLFS Certificate Authority store.

--with-openssl: This parameter chooses OpenSSL as SSL/TLS implementation. This seems mandatory now.

--with-gssapi: This parameter adds Kerberos 5 support to libcurl.

--without-ssl --with-gnutls: Use to build with GnuTLS support instead of OpenSSL for SSL/TLS.

--with-ca-bundle=/etc/pki/tls/certs/ca-bundle.crt: Use this switch instead of --with-ca-path if building with GnuTLS support instead of OpenSSL for SSL/TLS.

--with-libssh2: This parameter adds SSH support to cURL. This is disabled by default.

--enable-ares: This parameter adds support for DNS resolution through the c-ares library. It overrides --enable-threaded-resolver and is not widely tested by the editors.

find docs ... -exec rm {} \;: This command removes Makefiles and man files from the documentation directory that would otherwise be installed by the commands that follow.

Contents

Installed Programs: curl and curl-config
Installed Library: libcurl.so
Installed Directories: /usr/include/curl and /usr/share/doc/curl-8.2.1

Short Descriptions

curl

is a command line tool for transferring files with URL syntax

curl-config

prints information about the last compile, like libraries linked to and prefix setting

libcurl.so

provides the API functions required by curl and other programs

GeoClue-2.7.0

Introduction to GeoClue

GeoClue is a modular geoinformation service built on top of the D-Bus messaging system. The goal of the GeoClue project is to make creating location-aware applications as simple as possible.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GeoClue Dependencies

Required

JSON-GLib-1.6.6 and libsoup-3.4.2

Recommended
Optional

GTK-Doc-1.33.2 and libnotify-0.8.2

Installation of GeoClue

Install GeoClue by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dgtk-doc=false     \
            ..                  &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-D3g-source=false: This switch disables the 3G backend. Use it if you have not installed the ModemManager package.

-Dmodem-gps-source=false: This switch disables the modem GPS backend. Use it if you have not installed the ModemManager package.

-Dcdma-source=false: This switch disables the CDMA source backend. Use it if you have not installed the ModemManager package.

-Dnmea-source=false: This switch disables the NMEA source. Use it if you have not installed the Avahi package.

-Ddemo-agent=false: This switch disables the demo. Use it if you have not installed the libnotify package.

Contents

Installed Programs: None
Installed Libraries: libgeoclue-2.so
Installed Directories: /etc/geoclue, /usr/include/libgeoclue-2.0, /usr/libexec/geoclue-2.0, and /usr/share/gtk-doc/html/{geoclue,libgeoclue}

glib-networking-2.76.1

Introduction to GLib Networking

The GLib Networking package contains Network related gio modules for GLib.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GLib Networking Dependencies

Required

GLib-2.76.4 and GnuTLS-3.8.1

Recommended
Optional

libproxy

Installation of GLib Networking

Install GLib Networking by running the following commands:

mkdir build &&
cd    build &&

meson setup            \
   --prefix=/usr       \
   --buildtype=release \
   -Dlibproxy=disabled \
   .. &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Program: None
Installed Libraries: libgiognomeproxy.so and libgiognutls.so (GIO Modules installed in /usr/lib/gio/modules)
Installed Directories: None

kdsoap-2.1.1

Introduction to kdsoap

The kdsoap is Qt-based client-side and server-side SOAP component. It can be used to create client applications for web services and also provides the means to create web services without the need for any further component such as a dedicated web server.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

kdsoap Dependencies

Required

(Qt-5.15.10 or qt-alternate-5.15.10)

Installation of kdsoap

Install kdsoap by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DCMAKE_INSTALL_DOCDIR=/usr/share/doc/kdsoap-2.1.1 \
      .. &&
make

The package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: kdwsdl2cpp
Installed Libraries: libkdsoap.so and libkdsoap-server.so
Installed Directories: /usr/lib/cmake/KDSoap, /usr/share/doc/kdsoap-2.1.1, /usr/include/KDSoapClient. and /usr/include/KDSoapServer

ldns-1.8.3

Introduction to ldns

ldns is a fast DNS library with the goal to simplify DNS programming and to allow developers to easily create software conforming to current RFCs and Internet drafts. This packages also includes the drill tool.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

ldns Dependencies

Optional

make-ca-1.12 and libpcap-1.10.4 (for example programs), Python-2.7.18 and SWIG-4.1.1 (for Python bindings), and Doxygen-1.9.7 (for html documentation)

Installation of ldns

Install ldns by running the following commands:

./configure --prefix=/usr           \
            --sysconfdir=/etc       \
            --disable-static        \
            --with-drill            &&
make

If you have Doxygen-1.9.7 installed and want to build html documentation, run the following command:

make doc

This package does not come with a working test suite.

Now, as the root user:

make install

If you built html documentation, install it by running the following commands as the root user:

install -v -m755 -d /usr/share/doc/ldns-1.8.3 &&
install -v -m644 doc/html/* /usr/share/doc/ldns-1.8.3

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--with-drill: This option enables building of the drill tool (used for obtaining debug information from DNS(SEC))

--disable-dane-ta-usage: This option disables DANE-TA (DNS-Based Authentication of Named Entities) support. It is only needed if OpenSSL-1.1.0 or later is not installed.

--with-examples: This option enables building of the example programs.

--with-pyldns: This option enables building of the Python bindings.

Contents

Installed Programs: drill and ldns-config
Installed Library: libldns.so and /usr/lib/python2.7/site-packages/_ldns.so
Installed Directories: /usr/include/ldns and /usr/share/doc/ldns-1.8.3

Short Descriptions

drill

is a tool like dig from BIND Utilities-9.18.18 designed to get all sorts of information out of the DNS

ldns-config

shows compiler and linker flags for ldns usage

libldns.so

provides the ldns API functions to programs

libevent-2.1.12

Introduction to libevent

libevent is an asynchronous event notification software library. The libevent API provides a mechanism to execute a callback function when a specific event occurs on a file descriptor or after a timeout has been reached. Furthermore, libevent also supports callbacks due to signals or regular timeouts.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libevent Dependencies

Optional

Doxygen-1.9.7 (for API documentation)

Installation of libevent

First, fix an issue that prevents event_rpcgen.py from working:

sed -i 's/python/&3/' event_rpcgen.py

Install libevent by running the following commands:

./configure --prefix=/usr --disable-static &&
make

If you have Doxygen-1.9.7 installed and wish to build API documentation, issue :

doxygen Doxyfile

To test the results, issue: make verify. Six tests in every suite related to regress_ssl.c and regress_http.c are known to fail due to incompatibilities with OpenSSL-3. Some tests that are related to regress_dns.c are also known to fail intermittently due to insufficient test timeouts.

Now, as the root user:

make install

If you built the API documentation, install it by issuing the following commands as the root user:

install -v -m755 -d /usr/share/doc/libevent-2.1.12/api &&
cp      -v -R       doxygen/html/* \
                    /usr/share/doc/libevent-2.1.12/api

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Program: event_rpcgen.py
Installed Libraries: libevent_core.so, libevent_extra.so, libevent_openssl.so, libevent_pthreads.so and libevent.so
Installed Directory: /usr/include/event2 and /usr/share/doc/libevent-2.1.12

libmnl-1.0.5

Introduction to libmnl

The libmnl library provides a minimalistic userspace library oriented to Netlink developers. There are a lot of common tasks in the parsing, validating, and constructing of both the Netlink header and TLVs that are repetitive and easy to get wrong. This library aims to provide simple helpers that allow you to re-use code and to avoid re-inventing the wheel.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libnma Dependencies

Optional

Doxygen-1.9.7

Installation of libmnl

Install libmnl by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Library: libmnl.so

Short Descriptions

libmnl.so

provides functions for parsing, validating, constructing of both the Netlink header and TLVs

libnl-3.7.0

Introduction to libnl

The libnl suite is a collection of libraries providing APIs to netlink protocol based Linux kernel interfaces.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Optional Download

Installation of libnl

Install libnl by running the following commands:

./configure --prefix=/usr     \
            --sysconfdir=/etc \
            --disable-static  &&
make

This package does not come with a working test suite.

Now, as the root user:

make install

If you wish to install the API documentation, as the root user:

mkdir -vp /usr/share/doc/libnl-3.7.0 &&
tar -xf ../libnl-doc-3.7.0.tar.gz --strip-components=1 --no-same-owner \
    -C  /usr/share/doc/libnl-3.7.0

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--disable-cli: Use this parameter if you don't want to install cli tools provided by the package.

Contents

Installed Programs: genl-ctrl-list, idiag-socket-details, nl-class-add, nl-class-delete, nl-classid-lookup, nl-class-list, nl-cls-add, nl-cls-delete, nl-cls-list, nl-link-list, nl-pktloc-lookup, nl-qdisc-add, nl-qdisc-delete, nl-qdisc-list, and 48 other helper programs with nl- and nf- prefixes
Installed Libraries: libnl-3.so, libnl-cli-3.so, libnl-genl-3.so, libnl-idiag-3.so, libnl-nf-3.so, libnl-route-3.so, libnl-xfrm-3.so, and cli modules under /usr/lib/libnl/cli tree
Installed Directories: /etc/libnl, /usr/include/libnl3, /usr/lib/libnl, and /usr/share/doc/libnl-3.7.0

Short Descriptions

genl-ctrl-list

queries the Generic Netlink controller in the kernel and prints a list of all registered Generic Netlink families including the version of the interface that has been registered

nl-class-add

adds, updates, or replaces Traffic Classes

nl-class-delete

deletes Traffic Classes

nl-classid-lookup

is used to resolve qdisc/class names to classid values and vice versa

nl-class-list

lists Traffic Classes

nl-cls-add

adds a classifier

nl-cls-delete

deletes a classifier

nl-cls-list

lists classifiers

nl-link-list

dumps link attributes

nl-pktloc-lookup

allows the lookup of packet location definitions

nl-qdisc-add

adds queueing disciplines (qdiscs) in the kernel

nl-qdisc-delete

deletes queueing disciplines (qdiscs) in the kernel

nl-qdisc-list

lists queueing disciplines (qdiscs) in the kernel

libnl*-3.so

These libraries contain API functions used to access Netlink interfaces in Linux kernel

libnma-1.10.6

Introduction to libnma

The libnma package contains an implementation of the NetworkManager GUI functions.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libnma Dependencies

Required

Gcr-3.41.1, GTK+-3.24.38, ISO Codes-4.15.0, and NetworkManager-1.44.0

Recommended
Optional

mobile-broadband-provider-info

Installation of libnma

Install libnma by running the following commands:

mkdir build &&
cd    build &&

meson setup ..                               \
      --prefix=/usr                          \
      --buildtype=release                    \
      -Dgtk_doc=false                        \
      -Dlibnma_gtk4=true                     \
      -Dmobile_broadband_provider_info=false &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dgtk_doc=false: This parameter disables generating API documentation using gtk-doc. If you have GTK-Doc-1.33.2 installed and wish to generate the API documentation, omit this switch.

-Dlibnma_gtk4=true: This parameter is only needed by the latest gnome-control-center-44.3.

-Dmobile_broadband_provider_info=false: This switch disables WWAN support because mobile-broadband-provider-info is not in BLFS. Omit this switch if you have it installed and wish to enable WWAN support.

Contents

Installed Programs: None
Installed Libraries: libnma.so and libnma-gtk4.so
Installed Directories: /usr/include/libnma

Short Descriptions

libnma.so

contains the NetworkManager GUI library

libnma-gtk4.so

contains the GTK-4 version of the NetworkManager GUI library

libnsl-2.0.0

Introduction to libnsl

The libnsl package contains the public client interface for NIS(YP). It replaces the NIS library that used to be in glibc.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libnsl Dependencies

Required

libtirpc-1.3.3

Installation of libnsl

Install libnsl by running the following commands:

./configure --sysconfdir=/etc --disable-static &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Libraries: libnsl.so
Installed Directories: None

Short Descriptions

libnsl.so

provides the NIS (YP) API functions required by other programs

libpcap-1.10.4

Introduction to libpcap

libpcap provides functions for user-level packet capture, used in low-level network monitoring.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libpcap Dependencies

Optional

BlueZ-5.68, libnl-3.7.0, libusb-1.0.26, Software distribution for the DAG, and Septel range of passive network monitoring cards.

Installation of libpcap

Install libpcap by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

If you want to disable installing the static library, use this sed:

sed -i '/INSTALL_DATA.*libpcap.a\|RANLIB.*libpcap.a/ s/^/#/' Makefile

Now, as the root user:

make install

Contents

Installed Program: pcap-config
Installed Libraries: libpcap.so
Installed Directory: /usr/include/pcap

Short Descriptions

pcap-config

provides configuration information for libpcap

libpcap.{a,so}

are libraries used for user-level packet capture

libpsl-0.21.2

Introduction to libpsl

The libpsl package provides a library for accessing and resolving information from the Public Suffix List (PSL). The PSL is a set of domain names beyond the standard suffixes, such as .com.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libpsl Dependencies

Required

libidn2-2.3.4 and libunistring-1.1

Optional

GTK-Doc-1.33.2 (for documentation) and Valgrind-3.21.0 (for tests)

Installation of libpsl

Install libpsl by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release &&

ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Program: psl
Installed Library: libpsl.so
Installed Directories: None

Short Descriptions

psl

queries the Public Suffix List

libpsl.so

contains a library used to access the Public Suffix List

libndp-1.8

Introduction to libndp

The libndp package provides a wrapper for IPv6 Neighbor Discovery Protocol. It also provides a tool named ndptool for sending and receiving NDP messages.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): http://libndp.org/files/libndp-1.8.tar.gz

  • Download MD5 sum: c7e775fd5a9d676e8cba9c3732c4df93

  • Download size: 360 KB

  • Estimated disk space required: 2.5 MB

  • Estimated build time: less than 0.1 SBU

Installation of libndp

Install libndp by running the following command:

./configure --prefix=/usr        \
            --sysconfdir=/etc    \
            --localstatedir=/var \
            --disable-static     &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: ndptool
Installed Library: libndp.so
Installed Directory: None

Short Descriptions

ndptool

is a tool for sending and receiving NDP messages

libndp.so

provides a wrapper for the IPv6 Neighbor Discovery Protocol

Libslirp-4.7.0

Introduction to libslirp

Libslirp is a user-mode networking library used by virtual machines, containers or various tools.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libslirp Dependencies

Required

GLib-2.76.4

Installation of Libslirp

Install libslirp by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&

ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Program: None
Installed Library: libslirp.so
Installed Directory: /usr/include/slirp

Short Descriptions

libclirp.so

contains user-mode TCP-IP emulation functions

libsoup-2.74.3

Introduction to libsoup

The libsoup is a HTTP client/server library for GNOME. It uses GObject and the GLib main loop to integrate with GNOME applications and it also has an asynchronous API for use in threaded applications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libsoup Dependencies

Required

glib-networking-2.76.1, libpsl-0.21.2, libxml2-2.10.4, and SQLite-3.42.0

Recommended
Optional

Apache-2.4.57 (required to run the test suite), Brotli-1.0.9, cURL-8.2.1 (required to run the test suite), sysprof-3.48.0 (for profiling), MIT Kerberos V5-1.21.2 (required to run the test suite), GTK-Doc-1.33.2, PHP-8.2.9 compiled with XMLRPC-EPI support (only used for the XMLRPC regression tests), and Samba-4.18.6 (ntlm_auth is required to run the test suite)

Installation of libsoup

Install libsoup by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dvapi=enabled      \
            -Dgssapi=disabled   \
            -Dsysprof=disabled  \
            ..                  &&
ninja

To test the results, issue: ninja test. One test named ssl-test is known to fail.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dvapi=disabled: Use this if you have not installed Vala, e.g. because you are not building GNOME.

-Ddoc=enabled: Use this option if you want to build the documentation. Note that you must have GTK-Doc-1.33.2 installed.

-Dgssapi=disabled: 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.

-Dsysprof=disabled: libsoup will automatically download a git version of sysprof-3.48.0 if git is available or use the installed version if available. If you need profiling, remove this option.

Contents

Installed Programs: None
Installed Libraries: libsoup-2.4.so and libsoup-gnome-2.4.so
Installed Directories: /usr/include/libsoup-2.4, /usr/include/libsoup-gnome-2.4 and /usr/share/gtk-doc/html/libsoup-2.4

Short Descriptions

libsoup-2.4.so

provides functions for asynchronous HTTP connections

libsoup-gnome-2.4.so

provides GNOME specific features

libsoup-3.4.2

Introduction to libsoup3

The libsoup3 is a HTTP client/server library for GNOME. It uses GObject and the GLib main loop to integrate with GNOME applications and it also has an asynchronous API for use in threaded applications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libsoup3 Dependencies

Required

glib-networking-2.76.1, libpsl-0.21.2, libxml2-2.10.4, nghttp2-1.55.1, and SQLite-3.42.0

Recommended
Optional

Apache-2.4.57 (required to run the test suite), Brotli-1.0.9, cURL-8.2.1 (required to run the test suite), Gi-DocGen-2023.1, MIT Kerberos V5-1.21.2 (required to run the test suite), PHP-8.2.9 compiled with XMLRPC-EPI support (only used for the XMLRPC regression tests), Samba-4.18.6 (ntlm_auth is required to run the test suite), sysprof-3.48.0 (for profiling), and wstest

Installation of libsoup3

Fix the installation path of API documentation:

sed 's/apiversion/soup_version/' -i docs/reference/meson.build

Install libsoup3 by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr          \
            --buildtype=release    \
            -Dvapi=enabled         \
            -Dgssapi=disabled      \
            -Dsysprof=disabled     \
            --wrap-mode=nofallback \
            ..                     &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

--wrap-mode=nofallback: This switch prevents meson from using subproject fallbacks for any dependency declarations in the build files, stopping it downloading any optional dependency which is not installed on the system.

-Dvapi=disabled: Use this if you have not installed Vala, e.g. because you are not building GNOME.

-Ddocs=enabled: If Gi-DocGen-2023.1 is installed, the API documentation will be built and installed no matter if this option is used or not. This option causes the meson command to fail if Gi-DocGen-2023.1 is not installed.

-Dgssapi=disabled: libsoup3 defaults to building with GSSAPI support, which requires Kerberos (as does the test suite).

-Dsysprof=disabled: libsoup3 will automatically download a git version of sysprof-3.48.0 if git is available or use the installed version if available. If you need profiling, remove this option.

Contents

Installed Programs: None
Installed Libraries: libsoup-3.0.so
Installed Directories: /usr/include/libsoup-3.0, /usr/share/doc/libsoup-3.4.2 (only installed if -Ddocs=enabled is passed)

Short Descriptions

libsoup-3.0.so

provides functions for asynchronous HTTP connections

libtirpc-1.3.3

Introduction to libtirpc

The libtirpc package contains libraries that support programs that use the Remote Procedure Call (RPC) API. It replaces the RPC, but not the NIS library entries that used to be in glibc.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libtirpc Dependencies

Optional

MIT Kerberos V5-1.21.2 for the GSSAPI

Installation of libtirpc

Note

If updating this package, you will also need to update any existing version of rpcbind-1.2.6

./configure --prefix=/usr                                   \
            --sysconfdir=/etc                               \
            --disable-static                                \
            --disable-gssapi                                &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--disable-gssapi: This switch is needed if no GSSAPI is installed. Remove this switch if you have one installed (for example MIT Kerberos V5-1.21.2) and you wish to use it.

Contents

Installed Programs: None
Installed Libraries: libtirpc.so
Installed Directory: /usr/include/tirpc

Short Descriptions

libtirpc.so

provides the Remote Procedure Call (RPC) API functions required by other programs

neon-0.32.5

Introduction to neon

neon is an HTTP and WebDAV client library, with a C interface.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://notroj.github.io/neon/neon-0.32.5.tar.gz

  • Download MD5 sum: 7976b1cd67b7228cddb7eb4f39640ac5

  • Download size: 876 KB

  • Estimated disk space required: 8.6 MB (additional 18 MB for tests)

  • Estimated build time: 0.1 SBU (add 0.4 SBU for tests)

neon Dependencies

Optional

GnuTLS-3.8.1, libxml2-2.10.4, MIT Kerberos V5-1.21.2, nss-3.92 (for some tests), xmlto-0.0.28 (to regenerate the documentation), libproxy, and PaKChoiS

Installation of neon

Install neon by running the following commands:

./configure --prefix=/usr    \
            --with-ssl       \
            --enable-shared  \
            --disable-static &&
make

To test the results, issue: make check.

If you wish to regenerate the documentation, issue:

make docs

Now, as the root user:

make install

Command Explanations

--with-ssl: This switch enables SSL support using OpenSSL. GnuTLS can be used instead, by passing --with-ssl=gnutls and --with-ca-bundle=/etc/pki/tls/certs/ca-bundle.crt to the configure script.

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Program: neon-config
Installed Library: libneon.so
Installed Directories: /usr/include/neon and /usr/share/doc/neon-0.32.5

Short Descriptions

neon-config

is a script that provides information about an installed copy of the neon library

libneon.so

is used as a high-level interface to common HTTP and WebDAV methods

nghttp2-1.55.1

Introduction to nghttp2

nghttp2 is an implementation of HTTP/2 and its header compression algorithm, HPACK.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

nghttp2 Dependencies

Recommended

libxml2-2.10.4

Optional

The following are only used if building the full package instead of only the main libraries: Boost-1.83.0, c-ares-1.19.1, cython-0.29.36, jansson-2.14, libevent-2.1.12, sphinx-7.1.2, jemalloc, libev, mruby, and Spdylay.

CUnit is required if you wish to run the test suite.

Installation of nghttp2

Install nghttp2 by running the following commands:

./configure --prefix=/usr     \
            --disable-static  \
            --enable-lib-only \
            --docdir=/usr/share/doc/nghttp2-1.55.1 &&
make

The test suite needs CUnit, which is beyond the scope of BLFS.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-lib-only: only build libnghttp2. Omit this switch if you'd like to build the example applications, Python bindings, or the C++ asio library.

Contents

Installed Programs: None
Installed Libraries: libnghttp2.so
Installed Directories: /usr/include/nghttp2, /usr/share/nghttp2, and /usr/share/doc/nghttp2-1.55.1

Short Descriptions

libnghttp2.so

an implementation of the Hypertext Transfer Protocol version 2 in C

rpcsvc-proto-1.4.4

Introduction to rpcsvc-proto

The rpcsvc-proto package contains the rcpsvc protocol files and headers, formerly included with glibc, that are not included in replacement libtirpc-1.3.3, along with the rpcgen program.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of rpcsvc-proto

Install rpcsvc-proto by running the following commands:

./configure --sysconfdir=/etc &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: rpcgen
Installed Libraries: None
Installed Directories: /usr/include/rpcsvc

Short Descriptions

rpcgen

Generates C code to implement the RPC protocol

Serf-1.3.10

Introduction to Serf

The Serf package contains a C-based HTTP client library built upon the Apache Portable Runtime (APR) library. It multiplexes connections, running the read/write communication asynchronously. Memory copies and transformations are kept to a minimum to provide high performance operation.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Serf Dependencies

Required

Apr-Util-1.6.3 and SCons-4.5.2

Optional

MIT Kerberos V5-1.21.2, for the GSSAPI

Installation of Serf

Install Serf by running the following commands:

sed -i "/Append/s:RPATH=libdir,::"          SConstruct &&
sed -i "/Default/s:lib_static,::"           SConstruct &&
sed -i "/Alias/s:install_static,::"         SConstruct &&

scons PREFIX=/usr

This package does not come with a functional test suite.

Now, as the root user:

scons PREFIX=/usr install

Command Explanations

sed -i "...": The first command removes the runtime path from a shared library and the next two commands disable building and installing of the static library.

GSSAPI=/usr: Use this switch if you have installed a GSSAPI library and you want serf to use it.

Contents

Installed Programs: None
Installed Library: libserf-1.so
Installed Directory: /usr/include/serf-1

Short Descriptions

libserf-1.so

contains the Serf API functions

uhttpmock-0.5.3

Introduction to uhttpmock

The uhttpmock package contains a library for mocking web service APIs which use HTTP or HTTPS.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

uhttpmock Dependencies

Required

libsoup-2.74.3

Recommended
Optional

GTK-Doc-1.33.2

Installation of uhttpmock

Install uhttpmock by running the following commands:

./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: None
Installed Libraries: libuhttpmock-0.0.so
Installed Directories: /usr/include/libuhttpmock-0.0 and /usr/share/gtk-doc/html/libuhttpmock-0.0

Short Descriptions

libuhttpmock-0.0.so

contains the uhttpmock API functions

Chapter 18. Text Web Browsers

People who are new to Unix-based systems tend to ask the question "Why on earth would I want a text-mode browser? I'm going to compile X and use Firefox/Falkon/Whatever!". Those who have been around systems for a while know that when (not if) you manage to mess up your graphical browser install and you need to look up some information on the web, a console based browser will save you. Also, there are quite a few people who prefer to use one of these browsers as their primary method of browsing; either to avoid the clutter and bandwidth which accompanies images or because they may use a text-to-speech synthesizer which can read the page to them (of use for instance to partially sighted or blind users). In this chapter you will find installation instructions for two console web browsers:

Links-2.29

Introduction to Links

Links is a text and graphics mode WWW browser. It includes support for rendering tables and frames, features background downloads, can display colors and has many other features.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Links Dependencies

Recommended
Optional

Graphics mode requires at least one of GPM-1.20.7 (mouse support to be used with a framebuffer-based console), SVGAlib, DirectFB , and a graphical environment

For decoding various image formats Links can utilize libavif-0.11.1, libpng-1.6.40, libjpeg-turbo-3.0.0, librsvg-2.56.3, and libtiff-4.5.1

For decompressing web pages that are compressed with Brotli, Links can utilize Brotli-1.0.9

Installation of Links

Install Links by running the following commands:

./configure --prefix=/usr --mandir=/usr/share/man &&
make

This package does not come with a test suite.

Now, as the root user:

make install &&
install -v -d -m755 /usr/share/doc/links-2.29 &&
install -v -m644 doc/links_cal/* KEYS BRAILLE_HOWTO \
    /usr/share/doc/links-2.29

Command Explanations

--enable-graphics: This switch enables support for graphics mode.

Configuring Links

Config Files

~/.links/*

Configuration Information

Links stores its configuration in per-user files in the ~/.links directory. These files are created automatically when links is run for the first time.

Contents

Installed Program: links
Installed Libraries: None
Installed Directories: /usr/share/doc/links-2.29

Short Descriptions

links

is a text and graphics mode WWW browser

Lynx-2.8.9rel.1

Introduction to Lynx

Lynx is a text based web browser.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Lynx Dependencies

Optional

GnuTLS-3.8.1 (experimental, to replace openssl), Zip-3.0, UnZip-6.0, an MTA (that provides a sendmail command), and Sharutils-4.15.2 (for the uudecode program)

Installation of Lynx

First, apply a patch to fix a security vulnerability:

patch -p1 -i ../lynx-2.8.9rel.1-security_fix-1.patch

Install Lynx by running the following commands:

./configure --prefix=/usr          \
            --sysconfdir=/etc/lynx \
            --datadir=/usr/share/doc/lynx-2.8.9rel.1 \
            --with-zlib            \
            --with-bzlib           \
            --with-ssl             \
            --with-screen=ncursesw \
            --enable-locale-charset &&
make

This package does not come with a test suite.

Now, as the root user:

make install-full &&
chgrp -v -R root /usr/share/doc/lynx-2.8.9rel.1/lynx_doc

Command Explanations

--sysconfdir=/etc/lynx: This parameter is used so that the configuration files are located in /etc/lynx instead of /usr/etc.

--datadir=/usr/share/doc/lynx-2.8.9rel.1: This parameter is used so that the documentation files are installed into /usr/share/doc/lynx-2.8.9rel.1 instead of /usr/share/lynx_{doc,help}.

--with-zlib: This enables support for linking libz into Lynx.

--with-bzlib: This enables support for linking libbz2 into Lynx.

--with-ssl: This enables support for linking SSL into Lynx.

--with-screen=ncursesw: This switch enables the use of advanced wide-character support present in the system NCurses library. This is needed for proper display of characters and line wrapping in multibyte locales.

--enable-locale-charset: This switch allows Lynx to deduce the proper character encoding for terminal output from the current locale. A configuration step is still needed (see below), but unlike the situation without this switch, the configuration step becomes the same for all users (without the switch one must specify the display character set explicitly). This is important for environments such as a LiveCD, where the amount of system-specific configuration steps has to be reduced to the minimum.

--enable-ipv6: This switch allows Lynx to use IPv6, along with IPv4. Use it if your ISP provides an IPv6 configuration.

--enable-nls: This switch allows Lynx to print translated messages (such as questions about cookies and SSL certificates).

--with-gnutls: This enables experimental support for linking GnuTLS into Lynx. Remove the --with-ssl switch if you want to use gnutls.

make install-full: In addition to the standard installation, this target installs the documentation and help files.

chgrp -v -R root /usr/share/doc/lynx-2.8.9rel.1/lynx_doc : This command corrects the improper group ownership of installed documentation files.

Configuring Lynx

Config Files

/etc/lynx/lynx.cfg

Configuration Information

The proper way to get the display character set is to examine the current locale. However, Lynx does not do this by default. As the root user, change this setting:

sed -e '/#LOCALE/     a LOCALE_CHARSET:TRUE'     \
    -i /etc/lynx/lynx.cfg

The built-in editor in Lynx Breaks Multibyte Characters. This issue manifests itself in multibyte locales, e.g., as the Backspace key not erasing non-ASCII characters properly, and as incorrect data being sent to the network when one edits the contents of text areas. The only solution to this problem is to configure Lynx to use an external editor (bound to the Ctrl+X e key combination by default). Still as the root user:

sed -e '/#DEFAULT_ED/ a DEFAULT_EDITOR:vi'       \
    -i /etc/lynx/lynx.cfg

Lynx handles the following values of the DEFAULT_EDITOR option specially by adding cursor-positioning arguments: emacs, jed, jmacs, joe, jove, jpico, jstar, nano, pico, rjoe, vi (but not vim: in order to position the cursor in Vim-9.0.1677, set this option to vi).

By default, Lynx doesn't save cookies between sessions. Again as the root user, change this setting:

sed -e '/#PERSIST/    a PERSISTENT_COOKIES:TRUE' \
    -i /etc/lynx/lynx.cfg

Many other system-wide settings such as proxies can also be set in the /etc/lynx/lynx.cfg file.

Contents

Installed Program: lynx
Installed Libraries: None
Installed Directories: /etc/lynx and /usr/share/doc/lynx-2.8.9rel.1

Short Descriptions

lynx

is a general purpose, text-based, distributed information browser for the World Wide Web

Chapter 19. Mail/News Clients

Mail Clients help you retrieve (Fetchmail), sort (Procmail), read and compose responses (Heirloom mailx, Mutt, Pine, Kmail, Balsa, Evolution, SeaMonkey) to email.

News clients also help you retrieve, sort, read and compose responses, but these messages travel through USENET (a worldwide bulletin board system) using the Network News Transfer Protocol (NNTP).

Fetchmail-6.4.37

Introduction to Fetchmail

The Fetchmail package contains a mail retrieval program. It retrieves mail from remote mail servers and forwards it to the local (client) machine's delivery system, so it can then be read by normal mail user agents.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Fetchmail Dependencies

Recommended
Optional

MIT Kerberos V5-1.21.2 and libgssapi

Optional (for running fetchmailconf)

Python-3.11.4, built after Tk-8.6.13, with the py-future package

Installation of Fetchmail

Create a dedicated user for the fetchmail program. Issue the following commands as the root user:

useradd -c "Fetchmail User" -d /dev/null -g nogroup \
        -s /bin/false -u 38 fetchmail

Install Fetchmail by running the following commands:

PYTHON=python3 \
./configure --prefix=/usr \
            --enable-fallback=procmail &&
make

To test the results, issue: make check.

Now, as the root user:

make install                                  &&
chown -v fetchmail:nogroup /usr/bin/fetchmail

Command Explanations

PYTHON=python3: a version of Python is required, but only used to install a module to allow fetchmailconf to be run. That module is unmaintained and should not be used.

--enable-fallback=procmail: This tells Fetchmail to hand incoming mail to Procmail for delivery, if the port 25 mail server is not present or not responding.

Configuring Fetchmail

Config Files

~/.fetchmailrc

Configuration Information

Note

If you are connecting to a mailserver that supports SSL/TLS-wrapped or "implicit" mode on a dedicated port (default 993) you should use fetchmail --ssl or add the option 'ssl' in an rcfile.

cat > ~/.fetchmailrc << "EOF"

# The logfile needs to exist when fetchmail is invoked, otherwise it will
# dump the details to the screen. As with all logs, you will need to rotate
# or clear it from time to time.
set logfile fetchmail.log
set no bouncemail
# You probably want to set your local username as the postmaster
set postmaster <username>

poll SERVERNAME :
    user <isp_username> pass <password>;
    mda "/usr/bin/procmail -f %F -d %T";
EOF

touch ~/fetchmail.log       &&
chmod -v 0600 ~/.fetchmailrc

This is an example configuration that should suffice for most people. You can add as many users and servers as you need using the same syntax.

man fetchmail: Look for the section near the bottom named CONFIGURATION EXAMPLES. It gives some quick examples. There are countless other configuration options once you get used to it.

If you expect to receive very little mail you can invoke fetchmail when you wish to receive any incoming mail. More commonly, it is either invoked in daemon mode with the -d option either on the command line, or in .fetchmailrc (see 'DAEMON MODE' in man fetchmailconf), or alternatively it is invoked from a cron job.

Contents

Installed Programs: fetchmail and fetchmailconf
Installed Libraries: None
Installed Directories: None

Short Descriptions

fetchmail

when executed as a user, this will source ~/.fetchmailrc and download the appropriate mail

fetchmailconf

is intended to assist you in setting up and editing a ~/.fetchmailrc configuration file, by using a Tk GUI interface. It is written for Python and the Tkinter module but is labelled with a WARNING that it needs to be updated for fetchmail 6.4's SSL options and other recent new options

mailx-12.5

Introduction to Heirloom mailx

The Heirloom mailx package (formerly known as the Nail package) contains mailx, a command-line Mail User Agent derived from Berkeley Mail. It is intended to provide the functionality of the POSIX mailx command with additional support for MIME messages, IMAP (including caching), POP3, SMTP, S/MIME, message threading/sorting, scoring, and filtering. Heirloom mailx is especially useful for writing scripts and batch processing.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Heirloom mailx Dependencies

Optional

nss-3.92, MIT Kerberos V5-1.21.2 (for IMAP GSSAPI authentication), and an MTA

Installation of Heirloom mailx

Note

This package does not support parallel build.

Install Heirloom mailx by running the following commands.

patch -Np1 -i ../heirloom-mailx-12.5-fixes-1.patch &&

sed 's@<openssl@<openssl-1.0/openssl@' \
    -i openssl.c fio.c makeconfig      &&

make -j1 LDFLAGS+="-L /usr/lib/openssl/" \
         SENDMAIL=/usr/sbin/sendmail

This package does not come with a test suite.

Now, as the root user:

make PREFIX=/usr UCBINSTALL=/usr/bin/install install &&

ln -v -sf mailx /usr/bin/mail &&
ln -v -sf mailx /usr/bin/nail &&

install -v -m755 -d     /usr/share/doc/heirloom-mailx-12.5 &&
install -v -m644 README /usr/share/doc/heirloom-mailx-12.5

Command Explanations

make SENDMAIL=/usr/sbin/sendmail: This changes the default MTA path of /usr/lib/sendmail.

make PREFIX=/usr UCBINSTALL=/usr/bin/install install: This changes the default installation path of /usr/local and the default install command path of /usr/ucb.

Configuring Heirloom mailx

Config Files

/etc/nail.rc and ~/.mailrc

Configuration Information

For displaying mails, mailx uses a pager program. Since the default of pg is not available on a LFS system, its required to specify which pager is to use. By default, there is more and the more comfortable less installed. If the variable PAGER is not set in /etc/profile or ~/.bash_profile, or if it should be another pager just for reading mails, it can be set system wide in /etc/nail.rc:

echo "set PAGER=<more|less>" >> /etc/nail.rc

or individually for the actual user in ~/.mailrc:

echo "set PAGER=<more|less>" >> ~/.mailrc

Other interesting options to set in the config files might be EDITOR and MAILDIR.

If not set in the environment for other packages, the default editor can be set by:

echo "set EDITOR=<vim|nano|...>" >> /etc/nail.rc

Depending on which kind of MTA is installed, it might be required to set the MAILDIR variable so mailx is able to find the mails:

echo "set MAILDIR=Maildir" >> /etc/nail.rc

Contents

Installed Programs: mail, mailx and nail
Installed Libraries: None
Installed Directories: None

Short Descriptions

mailx

is a command-line mail user agent compatible with the mailx command found on commercial Unix versions

mail

is a symbolic link to mailx

nail

is a symbolic link to mailx

Mutt-2.2.11

Introduction to Mutt

The Mutt package contains a Mail User Agent. This is useful for reading, writing, replying to, saving, and deleting your email.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Mutt Dependencies

Recommended (for a text version of the manual)
Optional

Aspell-0.60.8, Cyrus SASL-2.1.28, DocBook-utils-0.6.14, GDB-13.2, GnuPG-2.4.3, GnuTLS-3.8.1, GPGME-1.21.0, libidn-1.41, MIT Kerberos V5-1.21.2, an MTA (that provides a sendmail command), slang-2.3.3, SQLite-3.42.0, libgssapi, Mixmaster, QDBM or Tokyo Cabinet

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/mutt

Installation of Mutt

Note

Mutt ships with an HTML version of its manual, but the text version is no longer provided because differences in the formatting from different text browsers compared to the shipped version caused complaints. To get a text file, the following are used in order of preference: lynx with overstriking (backspaces) for emphasis, w3m or elinks: the latter two apparently provide plain text. Plain text is generally preferred unless reading the HTML manual, so the instructions below use lynx if available, or else links to produce plain text.

Mutt requires a group named mail. You can add this group, if it does not exist, with this command:

groupadd -g 34 mail

If you did not install an MTA, you need to modify the ownership of /var/mail with this command:

chgrp -v mail /var/mail

Install Mutt by running the following commands:

To ensure that a plain text manual is created when using lynx or to otherwise use links to produce it (instead of elinks), run the following command:

sed  -e 's/ -with_backspaces//' \
     -e 's/elinks/links/'       \
     -e 's/-no-numbering -no-references//' \
     -i doc/Makefile.in

Now configure and build the application:

./configure --prefix=/usr                            \
            --sysconfdir=/etc                        \
            --with-docdir=/usr/share/doc/mutt-2.2.11 \
            --with-ssl                               \
            --enable-external-dotlock                \
            --enable-pop                             \
            --enable-imap                            \
            --enable-hcache                          \
            --enable-sidebar                         &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Note

If you used a DESTDIR method to only install to a temporary location as a regular user (as part of a package management process), you will need to run the following as the root user after completing the real install:

chown root:mail /usr/bin/mutt_dotlock &&
chmod -v 2755 /usr/bin/mutt_dotlock

An info file is now installed, so you will also need to recreate the /usr/share/info/dir as described when Texinfo was installed in LFS.

Command Explanations

sed ... -e 's/ -with_backspaces//' ...: This turns off the backspaces used for overstriking when lynx is used, resulting in readable plain text when using view.

sed ... -e 's/elinks/links/' ...: This allows links to be run instead of elinks which is not in the book.

sed ... -e 's/-no-numbering -no-references//' ...: This removes switches which are not understood by links.

--enable-external-dotlock: In some circumstances the mutt-dotlock program is not created. This switch ensures it is always created.

--enable-pop: This switch enables POP3 support.

--enable-imap: This switch enables IMAP support.

--enable-hcache: This switch enables header caching.

--enable-sidebar: This switch enables support for the sidebar (a list of mailboxes). It is off by default, but can be turned on by :set sidebar_visible in mutt (and off again with ':unset'), or it can be enabled in ~/.muttrc.

--with-ssl: This parameter adds SSL/TLS support from openssl in POP3/IMAP/SMTP.

--enable-autocrypt --with-sqlite3: These two switches add support for passive protection against data collection, using gnupg and gpgme (gpgme is enabled by autocrypt). See The Manual.

--enable-gpgme: This switch enables GPG support through the GPGME package. Use this switch if you want GPG support in Mutt.

--enable-smtp: This switch enables SMTP relay support.

--with-idn2: Use this parameter if both libidn and libidn2 have been installed, and you wish to use libidn2 here.

--with-sasl: This parameter adds authentication support from Cyrus SASL-2.1.28 in POP3/IMAP/SMTP if they are enabled. Depending on the server configuration, this may not be needed for POP3 or IMAP. However, it is needed for SMTP authentication.

Configuring Mutt

Config Files

/etc/Muttrc, ~/.muttrc, /etc/mime.types, and ~/.mime.types

Configuration Information

No changes in these files are necessary to begin using Mutt. When you are ready to make changes, the man page for muttrc is a good starting place.

In order to utilize GnuPG, use the following command:

cat /usr/share/doc/mutt-2.2.11/samples/gpg.rc >> ~/.muttrc

Contents

Installed Programs: flea, mutt, mutt_dotlock, muttbug, pgpewrap, mutt_pgpring, and smime_keys
Installed Libraries: None
Installed Directories: /usr/share/doc/mutt-2.2.11

Short Descriptions

flea

is a script showing where to report bugs

mutt

is a Mail User Agent (MUA) which enables you to read, write and delete your email

mutt_dotlock

implements the mail spool file lock

muttbug

is a script identical to flea

pgpewrap

prepares a command line for the GnuPG-2.4.3 utilities

pgpring

is a key ring dumper for PGP. It is not needed for GnuPG-2.4.3

smime_keys

manages a keystore for S/MIME certificates

Procmail-3.22

Introduction to Procmail

The Procmail package contains an autonomous mail processor. This is useful for filtering and sorting incoming mail.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Procmail Dependencies

Recommended
Optional

libnsl-2.0.0

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/procmail

Installation of Procmail

This package does not come with a test suite.

Install Procmail by running the following commands as the root user:

sed -i 's/getline/get_line/' src/*.[ch]                   &&
patch -Np1 -i ../procmail-3.22-consolidated_fixes-1.patch &&

make LOCKINGTEST=/tmp MANDIR=/usr/share/man install       &&
make install-suid

Command Explanations

sed -i 's/getline/get_line/' src/*.[ch]: This renames procmail's getline function to avoid conflict with the getline function from glibc.

make LOCKINGTEST=/tmp install: This prevents make from asking you where to test file-locking patterns.

make install-suid: Modifies permissions of the installed files.

Configuring Procmail

Config Files

/etc/procmailrc and ~/.procmailrc

Configuration Information

Recipes have to be written and placed in ~/.procmailrc for execution. The procmailex man page is the starting place to learn how to write recipes. For additional information, see also https://pm-doc.sourceforge.net/.

Contents

Installed Programs: formail, lockfile, mailstat and procmail
Installed Libraries: None
Installed Directories: None

Short Descriptions

formail

is a filter that can be used to format mail into mailbox format

lockfile

is a utility that can lock a file for single use interactively or in a script

mailstat

prints a summary report of mail that has been filtered by procmail since the last time mailstat was ran

procmail

is an autonomous mail processor. It performs all the functions of an MDA (Mail Delivery Agent)

Other Mail and News Programs

Balsa-2.6.4 is a GTK2 based mail client.

SeaMonkey-2.53.17 includes both a mail client and newsreader in its installation.

Thunderbird-115.2.0 is a mail/news client based on the Mozilla code base.

Evolution-3.48.4 is a mail client and organizer from the GNOME desktop.

Part V. Servers

Chapter 20. Major Servers

Major servers are the programs that provide content or services to users or other programs.

Apache-2.4.57

Introduction to Apache HTTPD

The Apache HTTPD package contains an open-source HTTP server. It is useful for creating local intranet web sites or running huge web serving operations.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Apache HTTPD Dependencies

Required

Apr-Util-1.6.3 and pcre2-10.42

Optional

Brotli-1.0.9, Berkeley DB-5.3.28, Doxygen-1.9.7, jansson-2.14, libxml2-2.10.4, Lua-5.4.6, Lynx-2.8.9rel.1 or Links-2.29 or ELinks, nghttp2-1.55.1, OpenLDAP-2.6.6 (Apr-Util-1.6.3 needs to be installed with ldap support), rsync-3.2.7, and Distcache

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/apache

Installation of Apache HTTPD

For security reasons, running the server as an unprivileged user and group is strongly encouraged. Create the following group and user using the following commands as root:

groupadd -g 25 apache &&
useradd -c "Apache Server" -d /srv/www -g apache \
        -s /bin/false -u 25 apache

Build and install Apache HTTPD by running the following commands:

patch -Np1 -i ../httpd-2.4.57-blfs_layout-1.patch             &&

sed '/dir.*CFG_PREFIX/s@^@#@' -i support/apxs.in              &&

sed -e '/HTTPD_ROOT/s:${ap_prefix}:/etc/httpd:'       \
    -e '/SERVER_CONFIG_FILE/s:${rel_sysconfdir}/::'   \
    -e '/AP_TYPES_CONFIG_FILE/s:${rel_sysconfdir}/::' \
    -i configure  &&

./configure --enable-authnz-fcgi                              \
            --enable-layout=BLFS                              \
            --enable-mods-shared="all cgi"                    \
            --enable-mpms-shared=all                          \
            --enable-suexec=shared                            \
            --with-apr=/usr/bin/apr-1-config                  \
            --with-apr-util=/usr/bin/apu-1-config             \
            --with-suexec-bin=/usr/lib/httpd/suexec           \
            --with-suexec-caller=apache                       \
            --with-suexec-docroot=/srv/www                    \
            --with-suexec-logfile=/var/log/httpd/suexec.log   \
            --with-suexec-uidmin=100                          \
            --with-suexec-userdir=public_html                 &&
make

This package does not come with a test suite.

Now, as the root user:

make install  &&

mv -v /usr/sbin/suexec /usr/lib/httpd/suexec &&
chgrp apache           /usr/lib/httpd/suexec &&
chmod 4754             /usr/lib/httpd/suexec &&

chown -v -R apache:apache /srv/www

Command Explanations

sed '/dir.*CFG_PREFIX/s@^@#@'...: Forces the apxs utility to use absolute pathnames for modules, when instructed to do so.

--enable-authnz-fcgi: Build FastCGI authorizer-based authentication and authorization (mod_authnz_fcgi.so fast CGI module).

--enable-mods-shared="all cgi": The modules should be compiled and used as Dynamic Shared Objects (DSOs) so they can be included and excluded from the server using the run-time configuration directives.

--enable-mpms-shared=all: This switch ensures that all MPM (Multi Processing Modules) are built as Dynamic Shared Objects (DSOs), so the user can choose which one to use at runtime.

--enable-suexec: This switch enables building of the Apache suEXEC module which can be used to allow users to run CGI and SSI scripts under user IDs different from the user ID of the calling web server.

--with-suexec-*: These switches control suEXEC module behavior, such as default document root, minimal UID that can be used to run the script under the suEXEC. Please note that with minimal UID 100, you can't run CGI or SSI scripts under suEXEC as the apache user.

... /usr/lib/httpd/suexec: These commands put suexec wrapper into proper location, since it is not meant to be run directly. They also adjust proper permissions of the binary, making it setgid apache.

chown -R apache:apache /srv/www: By default, the installation process installs files (documentation, error messages, default icons, etc.) with the ownership of the user that extracted the files from the tar file. If you want to change the ownership to another user, you should do so at this point. The only requirement is that the document directories need to be accessible by the httpd process with (r-x) permissions and files need to be readable (r--) by the apache user.

Configuring Apache

Config Files

/etc/httpd/httpd.conf and /etc/httpd/extra/*

Configuration Information

See file:///usr/share/httpd/manual/configuring.html for detailed instructions on customising your Apache HTTP server configuration file.

Systemd Unit

If you want the Apache server to start automatically when the system is booted, install the httpd.service unit included in the blfs-systemd-units-20230816 package:

make install-httpd

Contents

Installed Programs: ab, apachectl, apxs, checkgid, dbmmanage, fcgistarter, htcacheclean, htdbm, htdigest, htpasswd, httpd, httxt2dbm, logresolve, and rotatelogs
Installed Libraries: Several libraries under /usr/lib/httpd/modules/
Installed Directories: /etc/httpd, /srv/www, /usr/include/httpd, /usr/lib/httpd, /usr/share/httpd, /var/log/httpd, and /var/run/httpd

Short Descriptions

ab

is a tool for benchmarking your Apache HTTP server

apachectl

is a front end to the Apache HTTP server which is designed to help the administrator control the functioning of the Apache httpd daemon

apxs

is a tool for building and installing extension modules for the Apache HTTP server

checkgid

is a program that checks whether it can setgid to the group specified. This is to see if it is a valid group for Apache2 to use at runtime. If the user (should be run as superuser) is in that group, or can setgid to it, it will return 0

dbmmanage

is used to create and update the DBM format files used to store usernames and passwords for basic authentication of HTTP users

fcgistarter

is a tool to start a FastCGI program

htcacheclean

is used to clean up the disk cache

htdbm

is used to manipulate the DBM password databases

htdigest

is used to create and update the flat-files used to store usernames, realms and passwords for digest authentication of HTTP users

htpasswd

is used to create and update the flat-files used to store usernames and passwords for basic authentication of HTTP users

httpd

is the Apache HTTP server program

httxt2dbm

is used to generate DBM files from text, for use in RewriteMap

logresolve

is a post-processing program to resolve IP-addresses in Apache's access log files

rotatelogs

is a simple program for use in conjunction with Apache's piped log file feature

suexec

allows users to run CGI and SSI applications as a different user

BIND-9.18.18

Introduction to BIND

The BIND package provides a DNS server and client utilities. If you are only interested in the utilities, refer to the BIND Utilities-9.18.18.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

BIND Dependencies

Required

libuv-1.46.0

Recommended
Optional

cURL-8.2.1, libidn2-2.3.4, libxml2-2.10.4, lmdb-0.9.31, MIT Kerberos V5-1.21.2, pytest-7.4.0, sphinx-7.1.2 (required to build documentation), cmocka, geoip, jemalloc, w3m

Optional database backends

Berkeley DB-5.3.28, MariaDB-10.11.4 or MySQL, OpenLDAP-2.6.6, PostgreSQL-15.4, and unixODBC-2.3.12

Optional (to run the test suite)

Net-DNS-1.39

Installation of BIND

Install BIND by running the following commands:

./configure --prefix=/usr           \
            --sysconfdir=/etc       \
            --localstatedir=/var    \
            --mandir=/usr/share/man \
            --disable-static        &&
make

Issue the following commands to run the complete suite of tests. First, as the root user, set up some test interfaces:

Note

If IPv6 is not enabled in the kernel, there will be several error messages: "RTNETLINK answers: Operation not permitted". These messages do not affect the tests.

bin/tests/system/ifconfig.sh up

The test suite may indicate some skipped tests depending on what configuration options are used. Some tests are marked UNTESTED or do even fail if Net-DNS-1.39 is not installed. Two tests, resolver and dispatch, are known to fail. To run the tests, as an unprivileged user, execute:

make -k check

Again as root, clean up the test interfaces:

bin/tests/system/ifconfig.sh down

Finally, install the package as the root user:

make install

Command Explanations

--sysconfdir=/etc: This parameter forces BIND to look for configuration files in /etc instead of /usr/etc.

--with-libidn2: This parameter enables the IDNA2008 (Internationalized Domain Names in Applications) support.

--enable-fetchlimit: Use this option if you want to be able to limit the rate of recursive client queries. This may be useful on servers which receive a large number of queries.

--disable-linux-caps: BIND can also be built without capability support by using this option, at the cost of some loss of security.

--with-dlz-{mysql,bdb,filesystem,ldap,odbc,stub}: Use one (or more) of those options to add Dynamically Loadable Zones support. For more information refer to bind-dlz.sourceforge.net.

--disable-doh: Use this option if you do not have nghttp2-1.55.1 installed and do not need support for DNS over HTTPS.

--disable-static: This switch prevents installation of static versions of the libraries.

Configuring BIND

Config files

named.conf, root.hints, 127.0.0, rndc.conf, and resolv.conf

Configuration Information

BIND will be configured to run in a chroot jail as an unprivileged user (named). This configuration is more secure in that a DNS compromise can only affect a few files in the named user's HOME directory.

Create the unprivileged user and group named:

groupadd -g 20 named &&
useradd -c "BIND Owner" -g named -s /bin/false -u 20 named &&
install -d -m770 -o named -g named /srv/named

Set up some files, directories and devices needed by BIND:

mkdir -p /srv/named &&
cd       /srv/named &&
mkdir -p dev etc/named/{slave,pz} usr/lib/engines var/run/named &&
mknod /srv/named/dev/null c 1 3 &&
mknod /srv/named/dev/urandom c 1 9 &&
chmod 666 /srv/named/dev/{null,urandom} &&
cp /etc/localtime etc

The rndc.conf file contains information for controlling named operations with the rndc utility. Generate a key for use in the named.conf and rndc.conf with the rndc-confgen command:

rndc-confgen -a -b 512 -t /srv/named

Create the named.conf file from which named will read the location of zone files, root name servers and secure DNS keys:

cat >> /srv/named/etc/named.conf << "EOF"
options {
    directory "/etc/named";
    pid-file "/var/run/named.pid";
    statistics-file "/var/run/named.stats";

};
zone "." {
    type hint;
    file "root.hints";
};
zone "0.0.127.in-addr.arpa" {
    type master;
    file "pz/127.0.0";
};

// Bind 9 now logs by default through syslog (except debug).
// These are the default logging rules.

logging {
    category default { default_syslog; default_debug; };
    category unmatched { null; };

  channel default_syslog {
      syslog daemon;                      // send to syslog's daemon
                                          // facility
      severity info;                      // only send priority info
                                          // and higher
  };

  channel default_debug {
      file "named.run";                   // write to named.run in
                                          // the working directory
                                          // Note: stderr is used instead
                                          // of "named.run"
                                          // if the server is started
                                          // with the '-f' option.
      severity dynamic;                   // log at the server's
                                          // current debug level
  };

  channel default_stderr {
      stderr;                             // writes to stderr
      severity info;                      // only send priority info
                                          // and higher
  };

  channel null {
      null;                               // toss anything sent to
                                          // this channel
  };
};
EOF

Create a zone file with the following contents:

cat > /srv/named/etc/named/pz/127.0.0 << "EOF"
$TTL 3D
@      IN      SOA     ns.local.domain. hostmaster.local.domain. (
                        1       ; Serial
                        8H      ; Refresh
                        2H      ; Retry
                        4W      ; Expire
                        1D)     ; Minimum TTL
                NS      ns.local.domain.
1               PTR     localhost.
EOF

Create the root.hints file with the following commands:

Note

Caution must be used to ensure there are no leading spaces in this file.

cat > /srv/named/etc/named/root.hints << "EOF"
.                       6D  IN      NS      A.ROOT-SERVERS.NET.
.                       6D  IN      NS      B.ROOT-SERVERS.NET.
.                       6D  IN      NS      C.ROOT-SERVERS.NET.
.                       6D  IN      NS      D.ROOT-SERVERS.NET.
.                       6D  IN      NS      E.ROOT-SERVERS.NET.
.                       6D  IN      NS      F.ROOT-SERVERS.NET.
.                       6D  IN      NS      G.ROOT-SERVERS.NET.
.                       6D  IN      NS      H.ROOT-SERVERS.NET.
.                       6D  IN      NS      I.ROOT-SERVERS.NET.
.                       6D  IN      NS      J.ROOT-SERVERS.NET.
.                       6D  IN      NS      K.ROOT-SERVERS.NET.
.                       6D  IN      NS      L.ROOT-SERVERS.NET.
.                       6D  IN      NS      M.ROOT-SERVERS.NET.
A.ROOT-SERVERS.NET.     6D  IN      A       198.41.0.4
A.ROOT-SERVERS.NET.     6D  IN      AAAA    2001:503:ba3e::2:30
B.ROOT-SERVERS.NET.     6D  IN      A       199.9.14.201
B.ROOT-SERVERS.NET.     6D  IN      AAAA    2001:500:200::b
C.ROOT-SERVERS.NET.     6D  IN      A       192.33.4.12
C.ROOT-SERVERS.NET.     6D  IN      AAAA    2001:500:2::c
D.ROOT-SERVERS.NET.     6D  IN      A       199.7.91.13
D.ROOT-SERVERS.NET.     6D  IN      AAAA    2001:500:2d::d
E.ROOT-SERVERS.NET.     6D  IN      A       192.203.230.10
E.ROOT-SERVERS.NET.     6D  IN      AAAA    2001:500:a8::e
F.ROOT-SERVERS.NET.     6D  IN      A       192.5.5.241
F.ROOT-SERVERS.NET.     6D  IN      AAAA    2001:500:2f::f
G.ROOT-SERVERS.NET.     6D  IN      A       192.112.36.4
G.ROOT-SERVERS.NET.     6D  IN      AAAA    2001:500:12::d0d
H.ROOT-SERVERS.NET.     6D  IN      A       198.97.190.53
H.ROOT-SERVERS.NET.     6D  IN      AAAA    2001:500:1::53
I.ROOT-SERVERS.NET.     6D  IN      A       192.36.148.17
I.ROOT-SERVERS.NET.     6D  IN      AAAA    2001:7fe::53
J.ROOT-SERVERS.NET.     6D  IN      A       192.58.128.30
J.ROOT-SERVERS.NET.     6D  IN      AAAA    2001:503:c27::2:30
K.ROOT-SERVERS.NET.     6D  IN      A       193.0.14.129
K.ROOT-SERVERS.NET.     6D  IN      AAAA    2001:7fd::1
L.ROOT-SERVERS.NET.     6D  IN      A       199.7.83.42
L.ROOT-SERVERS.NET.     6D  IN      AAAA    2001:500:9f::42
M.ROOT-SERVERS.NET.     6D  IN      A       202.12.27.33
M.ROOT-SERVERS.NET.     6D  IN      AAAA    2001:dc3::35
EOF

The root.hints file is a list of root name servers. This file must be updated periodically with the dig utility. A current copy of root.hints can be obtained from https://www.internic.net/domain/named.root. For details, consult the "BIND 9 Administrator Reference Manual".

Create or modify resolv.conf to use the new name server with the following commands:

Note

Replace <yourdomain.com> with your own valid domain name.

cp /etc/resolv.conf /etc/resolv.conf.bak &&
cat > /etc/resolv.conf << "EOF"
search <yourdomain.com>
nameserver 127.0.0.1
EOF

Set permissions on the chroot jail with the following command:

chown -R named:named /srv/named

Systemd Unit

To start the DNS server at boot, install the named.service unit included in the blfs-systemd-units-20230816 package:

make install-named

Now start BIND with the following command:

systemctl start named

Testing BIND

Test out the new BIND 9 installation. First query the local host address with dig:

dig -x 127.0.0.1

Now try an external name lookup, taking note of the speed difference in repeated lookups due to the caching. Run the dig command twice on the same address:

dig www.linuxfromscratch.org &&
dig www.linuxfromscratch.org

You can see almost instantaneous results with the named caching lookups. Consult the BIND Administrator Reference Manual (see below) for further configuration options.

Administrator Reference Manual (ARM)

The ARM documentation (do not confuse with the processor architecture) is included in the source package. The documentation is in .rst format which means that it can be converted in human readable formats if sphinx-7.1.2 is installed.

When BIND is set up, especially if it is going to be operating in a real live scenario, it is highly recommended to consult the ARM documentation. ISC provides an updated set of excellent documentation along with every release so it can be easily viewed and/or downloaded – so there is no excuse to not read the docs. The formats ISC provides are PDF, epub and html at https://downloads.isc.org/isc/bind9/9.18.18/doc/arm/.

Contents

Installed Programs: arpaname, ddns-confgen, delv, dig, dnssec-cds, dnssec-dsfromkey, dnssec-importkey, dnssec-keyfromlabel, dnssec-keygen, dnssec-revoke, dnssec-settime, dnssec-signzone, dnssec-verify, host, mdig, named, named-checkconf, named-checkzone, named-compilezone, named-journalprint, named-nzd2nzf, named-rrchecker, nsec3hash, nslookup, nsupdate, rndc, rndc-confgen, and tsig-keygen (symlink)
Installed Libraries: libbind9.so, libdns.so, libirs.so, libisc.so, libisccc.so, libisccfg.so, and libns.so
Installed Directories: /usr/include/{bind9,dns,dst,irs,isc,isccc,isccfg,ns}, /usr/lib/bind, and /srv/named

Short Descriptions

arpaname

translates IP addresses to the corresponding ARPA names

ddns-confgen

generates a key for use by nsupdate and named

delv

is a new debugging tool that is a successor to dig

dig

interrogates DNS servers

dnssec-cds

changes DS records for a child zone based on CDS/CDNSKEY

dnssec-dsfromkey

outputs the Delegation Signer (DS) resource record (RR)

dnssec-importkey

reads a public DNSKEY record and generates a pair of .key/.private files

dnssec-keyfromlabel

gets keys with the given label from a cryptography hardware device and builds key files for DNSSEC

dnssec-keymgr

ensures correct DNSKEY coverage based on a defined policy

dnssec-revoke

sets the REVOKED bit on a DNSSEC key

dnssec-settime

sets the key timing metadata for a DNSSEC key

dnssec-signzone

generates signed versions of zone files

dnssec-verify

verifies that a zone is fully signed for each algorithm found in the DNSKEY RRset for the zone, and that the NSEC / NSEC3 chains are complete

host

is a utility for DNS lookups

mdig

is a version of dig that allows multiple queries at once

named

is the name server daemon

named-checkconf

checks the syntax of named.conf files

named-checkzone

checks zone file validity

named-compilezone

is similar to named-checkzone, but it always dumps the zone contents to a specified file in a specified format

named-journalprint

prints the zone journal in human-readable form

named-rrchecker

reads an individual DNS resource record from standard input and checks if it is syntactically correct

named-nzd2nzf

converts an NZD database to NZF text format

nsec3hash

generates an NSEC3 hash based on a set of NSEC3 parameters

nslookup

is a program used to query Internet domain nameservers

nsupdate

is used to submit DNS update requests

rndc

controls the operation of BIND

rndc-confgen

generates rndc.conf files

tsig-keygen

is a symlink to ddns-confgen

Kea 2.4.0 DHCP Server

Introduction to ISC Kea DHCP Server

The ISC Kea package contains the server programs for DHCP. It is the successor of the old ISC DHCP server which is end-of-life since December 2022.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Kea Dependencies

Required

Boost-1.83.0 and log4cplus-2.1.0

Optional

MIT Kerberos V5-1.21.2, for documentation Doxygen-1.9.7, Graphviz-8.1.0, and sphinx_rtd_theme-1.2.2

Optional database backends

MariaDB-10.11.4 or MySQL, and PostgreSQL-15.4

Kernel Configuration

You must have Packet Socket support. IPv6 support is optional.

[*] Networking support --->                                                [NET]
  Networking options --->
    <*/M> Packet socket                                                 [PACKET]
    [*]   TCP/IP networking                                               [INET]
    <*>     The IPv6 protocol --->                                        [IPV6]

Installation of ISC Kea DHCP Server

Install ISC Kea DHCP Server by running the following commands:

./configure --prefix=/usr        \
            --sysconfdir=/etc    \
            --docdir=/usr/share/doc/kea-2.4.0 \
            --localstatedir=/var \
            --enable-shell       \
            --with-openssl       \
            --disable-static &&
make

To test the results, issue: make check.

To install the ISC Kea DHCP Server suite, issue the following commands as the root user:

make -j1 install

Command Explanations

--with-pgsql or --with-mysql: ISC Kea can store the leases on a database. This might be useful in large environments running a cluster of DHCP servers. Using the memfile backend (which is a CSV file stored locally) is possible anyhow.

--enable-generate-docs: If documentation is to be rebuilt, add that option. Several dependencies must be installed for generating the documentation.

make -j1 install: ISC does not recommend any form of parallel or job server options when doing the install.

Configuring ISC Kea DHCP Server

The support of IPv4, IPv6 and DDNS has been split into separate servers which runs independently from each other. Each of them has its own configuration file. Additional configuration files come from the keactrl agent which is uses to control the servers in an easy way.

Consult the Kea Administrator Reference Manual for detailed information about the configuration of ISC Kea as it is a quite capable system. The configuration shown a bare minimum to get a DHCP server running but it already includes configuration for DDNS (Dynamic DNS). That setup might be working for small networks with a few clients and low traffic. For greater installations with thousands of clients, ISC Kea can be configured to use databases (mariadb or postgresql) to store the leases and build a cluster with multiple nodes. It can be integrated to ISC Stork which is a management dashboard to ISC Kea.

If you want to start the DHCP Server at boot, install the kea-dhcpd.service unit included in the blfs-systemd-units-20230816 package:

make install-kea-dhcpd

Config Files

/etc/kea/keactrl.conf, /etc/kea/kea-ctrl-agent.conf, /etc/kea/kea-dhcp4.conf, /etc/kea/kea-dhcp6.conf and /etc/kea/kea-dhcp-ddns.conf

Kea Control Configuration

keactrl is used to control the independent servers (IPv4, IPv6, DDNS). Its configuration file /etc/kea/keactrl.conf is installed by default and includes many path settings which are defined due to the configure at build time. It also includes settings to specify which of the servers should be started.

  • Control Agent

    The Control Agent is a daemon which allows the (re)configuration of the Kea DHCP service via REST API. Set ctrl_agent=yes to start the control agent (service providing a REST API), set ctrl_agent=no in case the control agent is not needed.

  • IPv4 DHCP server

    This daemon handles requests for IPv4 addresses. Set dhcp4=yes to start it, set dhcp4=no in case DHCP service for IPv4 is not wanted.

  • IPv6 DHCP server

    This daemon handles requests for IPv6 addresses. Set dhcp6=yes to start it, set dhcp6=no in case DHCP service for IPv6 is not wanted.

  • Dynamic DNS

    This daemon is used to update a DNS server dynamically when Kea assigns an IP address to a device. Set dhcp_ddns=yes to enable it, set dhcp_ddns=no in case dynamic DNS updates are not wanted.

The Netconf service is not installed because required dependencies are not covered by the current BLFS book.

With the following command, Kea will be configured to start the dhcp service for IPv4 and the dynamic DNS update, while the control agent and the dhcp service for IPv6 remains down. Tweak the command to match your needs on started services and execute as the root user:

sed -e "s/^dhcp4=.*/dhcp4=yes/" \
    -e "s/^dhcp6=.*/dhcp6=no/" \
    -e "s/^dhcp_ddns=.*/dhcp_ddns=yes/" \
    -e "s/^ctrl_agent=.*/ctrl_agent=no/" \
    -i /etc/kea/keactrl.conf

Control Agent Configuration

The provided configuration could be used without changes but in BLFS objects like sockets are stored in /run rather than in /tmp.

cat > /etc/kea/kea-ctrl-agent.conf << "EOF"
// Begin /etc/kea/kea-ctrl-agent.conf
{
  // This is a basic configuration for the Kea Control Agent.
  // RESTful interface to be available at http://127.0.0.1:8000/
  "Control-agent": {
    "http-host": "127.0.0.1",
    "http-port": 8000,
    "control-sockets": {
      "dhcp4": {
        "socket-type": "unix",
        "socket-name": "/run/kea4-ctrl-socket"
      },
      "dhcp6": {
        "socket-type": "unix",
        "socket-name": "/run/kea6-ctrl-socket"
      },
      "d2": {
        "socket-type": "unix",
        "socket-name": "/run/kea-ddns-ctrl-socket"
      }
    },

    "loggers": [
      {
        "name": "kea-ctrl-agent",
        "output_options": [
          {
            "output": "/var/log/kea-ctrl-agent.log"
            "pattern": "%D{%Y-%m-%d %H:%M:%S.%q} %-5p %m\n"
          }
        ],
        "severity": "INFO",
        "debuglevel": 0
      }
    ]
  }
}
// End /etc/kea/kea-ctrl-agent.conf
EOF

IPv4 DHCP Server Configuration

A sample configuration file is created in /etc/kea/kea-dhcp4.conf. Adjust the file to suit your needs or overwrite it by using the following sample as the root user:

cat > /etc/kea/kea-dhcp4.conf << "EOF"
// Begin /etc/kea/kea-dhcp4.conf
{
  "Dhcp4": {
    // Add names of your network interfaces to listen on.
    "interfaces-config": {
      "interfaces": [ "eth0", "eth2" ]
    },

    "control-socket": {
      "socket-type": "unix",
      "socket-name": "/run/kea4-ctrl-socket"
    },

    "lease-database": {
      "type": "memfile",
      "lfc-interval": 3600
    },

    "expired-leases-processing": {
      "reclaim-timer-wait-time": 10,
      "flush-reclaimed-timer-wait-time": 25,
      "hold-reclaimed-time": 3600,
      "max-reclaim-leases": 100,
      "max-reclaim-time": 250,
      "unwarned-reclaim-cycles": 5
    },

    "renew-timer": 900,
    "rebind-timer": 1800,
    "valid-lifetime": 3600,

    // Enable DDNS - Kea will dynamically update the DNS
    "ddns-send-updates" : true,
    "ddns-qualifying-suffix": "your.domain.tld",
    "dhcp-ddns" : {
      "enable-updates": true
    },

    "subnet4": [
      {
        "subnet": "192.168.56.0/24",
        "pools": [ { "pool": "192.168.56.16 - 192.168.56.254" } ],
        "option-data": [
          {
            "name": "domain-name",
            "data": "your.domain.tld"
          },
          {
            "name": "domain-name-servers",
            "data": "192.168.56.2, 192.168.3.7"
          },
          {
            "name": "domain-search",
            "data": "your.domain.tld"
          },
          {
            "name": "routers",
            "data": "192.168.56.2"
          }
        ]
      }
    ],

    "loggers": [
      {
        "name": "kea-dhcp4",
        "output_options": [
          {
            "output": "/var/log/kea-dhcp4.log",
            "pattern": "%D{%Y-%m-%d %H:%M:%S.%q} %-5p %m\n"
          }
        ],
        "severity": "INFO",
        "debuglevel": 0
      }
    ]
  }
}
// End /etc/kea/kea-dhcp4.conf
EOF

The configuration for IPv6 is similar to the configuration of IPv4. The configuration file is /etc/kea/kea-dhcp6.conf.

Dynamic DNS Configuration

If there is a BIND-9.18.18 server running, ISC Kea can update the DNS when it gives an IP address to a client. A sample configuration file is created in /etc/kea/kea-dhcp-ddns.conf. Adjust the file to suit your needs or overwrite it by using the following sample as the root user:

cat > /etc/kea/kea-dhcp-ddns.conf << "EOF"
// Begin /etc/kea/kea-dhcp-ddns.conf
{
  "DhcpDdns": {
    "ip-address": "127.0.0.1",
    "port": 53001,
    "control-socket": {
      "socket-type": "unix",
      "socket-name": "/run/kea-ddns-ctrl-socket"
    },

    "tsig-keys": [
      {
        "name"      : "rndc-key",
        "algorithm" : "hmac-sha256",
        "secret"    : "1FU5hD7faYaajQCjSdA54JkTPQxbbPrRnzOKqHcD9cM="
      }
    ],

    "forward-ddns" : {
      "ddns-domains" : [
        {
          "name" : "your.domain.tld.",
          "key-name": "rndc-key",
          "dns-servers" : [
            {
              "ip-address" : "127.0.0.1",
              "port" : 53
            }
          ]
        }
      ]
    },

    "reverse-ddns" : {
      "ddns-domains" : [
        {
          "name" : "56.168.192.in-addr.arpa.",
          "key-name": "rndc-key",
          "dns-servers" : [
            {
              "ip-address" : "127.0.0.1",
              "port" : 53
            }
          ]
        }
      ]
    },

    "loggers": [
      {
        "name": "kea-dhcp-ddns",
        "output_options": [
          {
            "output": "/var/log/kea-ddns.log",
            "pattern": "%D{%Y-%m-%d %H:%M:%S.%q} %-5p %m\n"
          }
        ],
        "severity": "INFO",
        "debuglevel": 0
      }
    ]
  }
}
// End /etc/kea/kea-dhcp-ddns.conf
EOF

Note

The value of secret is just an example. Generate the key for your installation by using the rndc-confgen -a command or the tsig-keygen command which both are provided by BIND-9.18.18.

In this sample config it is assumed that the DNS server runs on the same machine as Kea does (accessable via 127.0.0.1) and that this machine has the IP 192.168.56.2.

Contents

Installed Programs: keactrl, kea-admin, kea-ctrl-agent, kea-dhcp4, kea-dhcp6, kea-dhcp-ddns, kea-lfc, kea-shell
Installed Libraries: libkea-*
Installed Directories: /etc/kea, /usr/include/kea, /var/lib/kea

Short Descriptions

keactrl

Tool to control (start/stop) the server processes.

kea-admin

kea-admin is a shell script which offers database maintenance.

kea-ctrl-agent

Daemon which exposes a RESTful control interface for managing Kea servers.

kea-dhcp4

The server daemon providing IPv4 addresses.

kea-dhcp6

The server daemon providing IPv6 addresses.

kea-dhcp-ddns

The server daemon performing the dynamic DNS updates.

kea-lfc

The kea-lfc service process removes redundant information from the files used to provide persistent storage for the memfile database backend. It is run by the Kea DHCP server.

keashell

RESTful client to the ISC Kea services.

ProFTPD-1.3.8

Introduction to ProFTPD

The ProFTPD package contains a secure and highly configurable FTP daemon. This is useful for serving large file archives over a network.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

ProFTPD Dependencies

Optional

libcap-2.69 with PAM, libssh2-1.11.0, Linux-PAM-1.5.3, MariaDB-10.11.4 or MySQL, PCRE-8.45, PostgreSQL-15.4, and Net::SSH2

Installation of ProFTPD

For security reasons, you should install ProFTPD using an unprivileged user and group. As the root user:

groupadd -g 46 proftpd                             &&
useradd -c proftpd -d /srv/ftp -g proftpd \
        -s /usr/bin/proftpdshell -u 46 proftpd     &&

install -v -d -m775 -o proftpd -g proftpd /srv/ftp &&
ln -v -s /usr/bin/false /usr/bin/proftpdshell      &&
echo /usr/bin/proftpdshell >> /etc/shells

Install ProFTPD as an unprivileged user by running the following commands:

./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/run &&
make

This packages does not come with a usable test suite.

Now, as the root user:

make install                                   &&
install -d -m755 /usr/share/doc/proftpd-1.3.8 &&
cp -Rv doc/*     /usr/share/doc/proftpd-1.3.8

Command Explanations

install -v -d -m775 -o proftpd -g proftpd /srv/ftp: Create the home directory for ProFTPD.

ln -v -s /usr/bin/false /usr/bin/proftpdshell: Set the default shell as a link to an invalid shell.

echo /usr/bin/proftpdshell >> /etc/shells: Fake a valid shell for compatibility purposes.

Note

The above two commands can be omitted if the following directive is placed in the configuration file:

RequireValidShell off

By default, proftpd will require that users logging in have valid shells. The RequireValidShell directive turns off this requirement. This is only recommended if you are setting up your FTP server exclusively for anonymous downloads.

Note

Support for most of the dependency packages requires using options passed to the configure script. View the output from ./configure --help for complete information about enabling dependency packages.

Configuring ProFTPD

Config Files

/etc/proftpd.conf

Configuration Information

This is a simple, download-only sample configuration. See the ProFTPD documentation in /usr/share/doc/proftpd and consult the website at http://www.proftpd.org/ for example configurations.

cat > /etc/proftpd.conf << "EOF"
# This is a basic ProFTPD configuration file
# It establishes a single server and a single anonymous login.

ServerName                      "ProFTPD Default Installation"
ServerType                      standalone
DefaultServer                   on

# Port 21 is the standard FTP port.
Port                            21
# Umask 022 is a good standard umask to prevent new dirs and files
# from being group and world writable.
Umask                           022

# To prevent DoS attacks, set the maximum number of child processes
# to 30.  If you need to allow more than 30 concurrent connections
# at once, simply increase this value.  Note that this ONLY works
# in standalone mode, in inetd mode you should use an inetd server
# that allows you to limit maximum number of processes per service

MaxInstances                    30

# Set the user and group that the server normally runs at.
User                            proftpd
Group                           proftpd

# To cause every FTP user to be "jailed" (chrooted) into their home
# directory, uncomment this line.
#DefaultRoot ~


# Normally, files should be overwritable.
<Directory /*>
  AllowOverwrite                on
</Directory>

# A basic anonymous configuration, no upload directories.
<Anonymous ~proftpd>
  User                          proftpd
  Group                         proftpd
  # Clients should be able to login with "anonymous" as well as "proftpd"
  UserAlias                     anonymous proftpd

  # Limit the maximum number of anonymous logins
  MaxClients                    10

  # 'welcome.msg' should be displayed at login, and '.message' displayed
  # in each newly chdired directory.
  DisplayLogin                  welcome.msg
  DisplayChdir                  .message

  # Limit WRITE everywhere in the anonymous chroot
  <Limit WRITE>
    DenyAll
  </Limit>
</Anonymous>
EOF

Systemd Unit

Install the proftpd.service unit included in the blfs-systemd-units-20230816 package:

make install-proftpd

Contents

Installed Programs: ftpasswd, ftpcount, ftpdctl, ftpmail, ftpquota, ftpscrub, ftpshut, ftptop, ftpwho, in.proftpd (symlink to proftpd), proftpd, and prxs
Installed Libraries: None
Installed Directory: /usr/{include,lib}/proftpd, /usr/share/doc/proftpd-1.3.8, and /srv/ftp

Short Descriptions

proftpd

is the FTP daemon

ftpcount

shows the current number of connections

ftpdctl

is used to control the proftpd daemon while it is running

ftpasswd

is a Perl script designed to create and manage AuthUserFiles and AuthGroupFiles of the correct format for proftpd

ftpmail

is a Perl script for sending email based on the proftpd TransferLog

ftpquota

is a Perl script designed to create and manage limits and tally files for the mod_quotatab + mod_quotatab_file module combination for proftpd

ftpscrub

provides a way to scrub the scoreboard file on demand

ftpshut

shuts down all proftpd servers at a given time

ftptop

displays running status on connections

ftpwho

shows current process information for each session

prxs

is a Perl script designed to compile and install third-party modules, from source code, as DSO modules for the installed proftpd

vsftpd-3.0.5

Introduction to vsftpd

The vsftpd package contains a very secure and very small FTP daemon. This is useful for serving files over a network.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

vsftpd Dependencies

Required

libnsl-2.0.0

Recommended
Optional

libcap-2.69 with PAM

Installation of vsftpd

For security reasons, running vsftpd as an unprivileged user and group is encouraged. Also, a user should be created to map anonymous users. As the root user, create the needed directories, users, and groups with the following commands:

install -v -d -m 0755 /usr/share/vsftpd/empty &&
install -v -d -m 0755 /home/ftp               &&
groupadd -g 47 vsftpd                         &&
groupadd -g 45 ftp                            &&

useradd -c "vsftpd User"  -d /dev/null -g vsftpd -s /bin/false -u 47 vsftpd &&
useradd -c anonymous_user -d /home/ftp -g ftp    -s /bin/false -u 45 ftp

Gcc-10 and later flags an error for an implicit type cast. Make it explicit:

sed -e "s/kVSFSysStrOpenUnknown;/(enum EVSFSysUtilOpenMode)&/" -i sysstr.c

Build vsftpd as an unprivileged user using the following command:

make

This package does not come with a test suite.

Once again, become the root user and install vsftpd with the following commands:

install -v -m 755 vsftpd        /usr/sbin/vsftpd    &&
install -v -m 644 vsftpd.8      /usr/share/man/man8 &&
install -v -m 644 vsftpd.conf.5 /usr/share/man/man5 &&
install -v -m 644 vsftpd.conf   /etc

Command Explanations

install -v -d ...: This creates the directory that anonymous users will use (/home/ftp) and the directory the daemon will chroot into (/usr/share/vsftpd/empty).

Note

/home/ftp should not be owned by the user vsftpd, or the user ftp.

echo "#define VSF_BUILD_TCPWRAPPERS" >>builddefs.h: Use this prior to make to add support for tcpwrappers.

echo "#define VSF_BUILD_SSL" >>builddefs.h: Use this prior to make to add support for SSL.

install -v -m ...: The Makefile uses non-standard installation paths. These commands install the files in /usr and /etc.

Configuring vsftpd

Config Files

/etc/vsftpd.conf

Configuration Information

vsftpd comes with a basic anonymous-only configuration file that was copied to /etc above. While still as root, this file should be modified because it is now recommended to run vsftpd in standalone mode. Also, you should specify the privilege separation user created above. Finally, you should specify the chroot directory. man vsftpd.conf will give you all the details.

cat >> /etc/vsftpd.conf << "EOF"
background=YES
nopriv_user=vsftpd
secure_chroot_dir=/usr/share/vsftpd/empty
EOF

To enable local logins, append the following to the /etc/vsftpd.conf file (as the root user):

cat >> /etc/vsftpd.conf << "EOF"
local_enable=YES
EOF

In addition, if using Linux-PAM and vsftpd with local user logins, you will need a Linux-PAM configuration file. As the root user, create the /etc/pam.d/vsftpd file, and add the needed configuration changes for Linux-PAM session support using the following commands:

cat > /etc/pam.d/vsftpd << "EOF" &&
# Begin /etc/pam.d/vsftpd
auth       required     /lib/security/pam_listfile.so item=user sense=deny \
                                                      file=/etc/ftpusers \
                                                      onerr=succeed
auth       required     pam_shells.so
auth       include      system-auth
account    include      system-account
session    include      system-session
EOF

cat >> /etc/vsftpd.conf << "EOF"
session_support=YES
pam_service_name=vsftpd
EOF

Systemd Unit

Install the vsftpd.service unit included in the blfs-systemd-units-20230816 package:

make install-vsftpd

Contents

Installed Program: vsftpd
Installed Libraries: None
Installed Directories: /usr/share/vsftpd, /home/ftp

Short Descriptions

vsftpd

is the FTP daemon

Chapter 21. Mail Server Software

MTAs are the programs which transport mail from one machine to the other. The traditional MTA is Sendmail, however there are several other choices.

As well as SMTP servers there is a POP server (qpopper) and an IMAP server (Courier-IMAP).

Dovecot-2.3.20

Introduction to Dovecot

Dovecot is an Internet Message Access Protocol (IMAP) and Post Office Protocol (POP) server, written primarily with security in mind. Dovecot aims to be lightweight, fast and easy to set up as well as highly configurable and easily extensible with plugins.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Dovecot Dependencies

Required

libtirpc-1.3.3

Optional

CLucene-2.3.3.4, ICU-73.2, libcap-2.69 with PAM, Linux-PAM-1.5.3, Lua-5.4.6, MariaDB-10.11.4 or MySQL, OpenLDAP-2.6.6, PostgreSQL-15.4, SQLite-3.42.0, Valgrind-3.21.0, xfsprogs-6.4.0, Cassandra, lz4, stemmer and libsodium

Installation of Dovecot

There should be dedicated users and groups for unprivileged Dovecot processes and for processing users' logins. Issue the following commands as the root user:

groupadd -g 42 dovecot &&
useradd -c "Dovecot unprivileged user" -d /dev/null -u 42 \
        -g dovecot -s /bin/false dovecot &&
groupadd -g 43 dovenull &&
useradd -c "Dovecot login user" -d /dev/null -u 43 \
        -g dovenull -s /bin/false dovenull

First, apply a patch to fix problems with OpenSSL-3:

patch -Np1 -i ../dovecot-2.3.20-openssl3_fixes-1.patch

Next, apply a patch to fix a security vulnerability:

patch -Np1 -i ../dovecot-2.3.20-security_fix-1.patch

Install Dovecot by running the following commands:

CPPFLAGS="-I/usr/include/tirpc" \
LDFLAGS+=" -ltirpc" \
./configure --prefix=/usr                          \
            --sysconfdir=/etc                      \
            --localstatedir=/var                   \
            --docdir=/usr/share/doc/dovecot-2.3.20 \
            --disable-static                       &&
make

To test the results, issue make -k check.

Now, as the root user:

make install

Command Explanations

CPPFLAGS=... LDFLAGS+=...: build with libtirpc instead of the recently removed RPC code provided by GlibC.

--disable-static: This switch prevents installation of static versions of the libraries.

--with-ldap: This switch enables OpenLDAP authentication support.

--with-pgsql: This switch enables PostgreSQL database support.

--with-mysql: This switch enables MySQL database support.

--with-sqlite: This switch enables SQLite database support.

--with-lucene: This switch enables CLucene full text search support.

--with-lua: This switch enables Lua plugin support. This includes a mail and push notification plugin.

Configuring Dovecot

Config Files

/etc/dovecot/dovecot.conf, /etc/dovecot/conf.d/*, and /etc/dovecot/local.conf

Configuration Information

Copy an example configuration, which you can use as a starting point:

cp -rv /usr/share/doc/dovecot-2.3.20/example-config/* /etc/dovecot

The following configuration is a simple proof of concept with IMAP service using local users for authentication and mailbox location. Reading files from the conf.d directory is commented out since the included example configuration requires OpenSSL and Linux PAM.

sed -i '/^\!include / s/^/#/' /etc/dovecot/dovecot.conf &&
chmod -v 1777 /var/mail &&
cat > /etc/dovecot/local.conf << "EOF"
protocols = imap
ssl = no
# The next line is only needed if you have no IPv6 network interfaces
listen = *
mail_location = mbox:~/Mail:INBOX=/var/mail/%u
userdb {
  driver = passwd
}
passdb {
  driver = shadow
}
EOF

You will definitely want to read the official documentation at https://wiki2.dovecot.org/ if you plan to use Dovecot in a production environment.

Systemd Unit

To start the dovecot daemon at boot, enable the previously installed systemd unit with the following command:

systemctl enable dovecot

Contents

Installed Programs: doveadm, doveconf, dovecot, dovecot-sysreport, and dsync (symbolic link)
Installed Libraries: various internal plugins in /usr/lib/dovecot
Installed Directories: /etc/dovecot, /usr/{include,lib,libexec,share}/dovecot and /usr/share/doc/dovecot-2.3.20

Short Descriptions

doveadm

is the Dovecot administration tool

doveconf

is Dovecot's configuration dumping utility

dovecot

is the IMAP and POP server

dovecot-sysreport

prints system information that is useful to the Dovecot developers when submitting bug reports upstream

dsync

is Dovecot's mailbox synchronization utility

Exim-4.96

Introduction to Exim

The Exim package contains a Mail Transport Agent written by the University of Cambridge, released under the GNU Public License.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

  • Additional formats of the documentation (text-based docs are shipped with the sources) can be downloaded by following the links shown at https://exim.org/docs.html.

Exim Dependencies

Required

libnsl-2.0.0 and pcre2-10.42

Optional

TDB (alternative to GDBM, built in LFS), Cyrus SASL-2.1.28, libidn-1.41, Linux-PAM-1.5.3, MariaDB-10.11.4 or MySQL, OpenLDAP-2.6.6, GnuTLS-3.8.1, PostgreSQL-15.4, SQLite-3.42.0, a graphical environment, Heimdal GSSAPI, and OpenDMARC

Installation of Exim

Before building Exim, as the root user you should create the group and user exim which will run the exim daemon:

groupadd -g 31 exim &&
useradd -d /dev/null -c "Exim Daemon" -g exim -s /bin/false -u 31 exim

Configure Exim with the following commands:

sed -e 's,^BIN_DIR.*$,BIN_DIRECTORY=/usr/sbin,'    \
    -e 's,^CONF.*$,CONFIGURE_FILE=/etc/exim.conf,' \
    -e 's,^EXIM_USER.*$,EXIM_USER=exim,'           \
    -e '/# SUPPORT_TLS=yes/s,^#,,'                   \
    -e '/# USE_OPENSSL/s,^#,,'                       \
    -e 's,^EXIM_MONITOR,#EXIM_MONITOR,' src/EDITME > Local/Makefile &&

printf "USE_GDBM = yes\nDBMLIB = -lgdbm\n" >> Local/Makefile

If you want to add Linux PAM support, also run the following commands:

sed -i '/# SUPPORT_PAM=yes/s,^#,,' Local/Makefile
echo "EXTRALIBS=-lpam" >> Local/Makefile

Build Exim with the following command:

make

This package does not come with a test suite.

Now, as the root user:

make install                                    &&
install -v -m644 doc/exim.8 /usr/share/man/man8 &&

install -v -d -m755    /usr/share/doc/exim-4.96 &&
install -v -m644 doc/* /usr/share/doc/exim-4.96 &&

ln -sfv exim /usr/sbin/sendmail                 &&
install -v -d -m750 -o exim -g exim /var/spool/exim

Command Explanations

sed -e ... > Local/Makefile: Most of Exim's configuration options are defined in Local/Makefile, which is created from the src/EDITME file. This command specifies the minimum set of options. Descriptions for the options are listed below.

printf ... > Local/Makefile: Setting those variables allows to use GDBM instead of the default Berkeley DB. Remove this command if you have installed Berkeley DB-5.3.28.

BIN_DIRECTORY=/usr/sbin: This installs all of Exim's binaries and scripts in /usr/sbin.

CONFIGURE_FILE=/etc/exim.conf: This installs Exim's main configuration file in /etc.

EXIM_USER=exim: This tells Exim that after the daemon no longer needs root privileges, the process needs to hand off the daemon to the exim user.

SUPPORT_TLS=yes: This allows to support STARTTLS connections. If you use this option, you need to select whether OpenSSL or GnuTLS is used (see src/EDITME).

USE_OPENSSL_PC=openssl: This tells the build system to use OpenSSL, and to find the needed libraries with pkg-config.

#EXIM_MONITOR: This defers building the Exim monitor program, as it requires X Window System support, by commenting out the EXIM_MONITOR line in the Makefile. If you wish to build the monitor program, omit this sed command and issue the following command before building the package (modify Local/eximon.conf, if necessary): cp exim_monitor/EDITME Local/eximon.conf.

ln -sfv exim /usr/sbin/sendmail: Creates a link to sendmail for applications which need it. Exim will accept most Sendmail command-line options.

install -v -m750 -o exim -g exim /var/spool/exim: Since /var/spool is owned by root and this version of exim drops root privileges early, to run as user exim, it cannot create the /var/spool/exim directory. As a work around, it is created manually.

Adding Additional Functionality

To utilize some or all of the dependency packages, you'll need to modify Local/Makefile to include the appropriate directives and parameters to link additional libraries before you build Exim. Local/Makefile is heavily commented with instructions on how to do this. Listed below is additional information to help you link these dependency packages or add additional functionality.

If you wish to build and install the .info documentation, refer to https://exim.org/exim-html-4.96/doc/html/spec_html/ch04.html#SECTinsinfdoc.

If you wish to build in Exim's interfaces for calling virus and spam scanning software directly from access control lists, uncomment the WITH_CONTENT_SCAN=yes parameter and review the information found at https://exim.org/exim-html-4.96/doc/html/spec_html/ch45.html.

To use a backend database other than GDBM , see the instructions at https://exim.org/exim-html-4.96/doc/html/spec_html/ch04.html#SECTdb.

For SSL functionality, see the instructions at https://exim.org/exim-html-4.96/doc/html/spec_html/ch04.html#SECTinctlsssl and https://exim.org/exim-html-4.96/doc/html/spec_html/ch42.html.

For tcpwrappers functionality, see the instructions at https://exim.org/exim-html-4.96/doc/html/spec_html/ch04.html#SECID27.

For information about adding authentication mechanisms to the build, see chapters 33—41 of https://exim.org/exim-html-4.96/doc/html/spec_html/index.html.

For information about linking Linux-PAM, refer to the instructions https://exim.org/exim-html-4.96/doc/html/spec_html/ch11.html#SECTexpcond.

For information about linking database engine libraries used for Exim name lookups, see the instructions at https://exim.org/exim-html-4.96/doc/html/spec_html/ch09.html.

If you wish to add Readline support to Exim when invoked in test expansion (-be) mode, see the information in the -be section of https://exim.org/exim-html-4.96/doc/html/spec_html/ch05.html#id2525974.

You may wish to modify the default configuration and send log files to syslog instead of the default /var/spool/exim/log directory. See the information at https://exim.org/exim-html-4.96/doc/html/spec_html/ch-log_files.html.

A wealth of information can be also found at the Exim Wiki.

Configuring Exim

Config Files

/etc/exim.conf and /etc/aliases

Configuration Information

Review the file /etc/exim.conf, and modify any settings to suit your needs. Note that the default configuration assumes that the /var/mail directory is world writable, but has the sticky bit set. If you want to use the default configuration, issue as the root user:

chmod -v a+wt /var/mail

A default (nothing but comments) /etc/aliases file is installed during the package installation if this file did not exist on your system. Create the necessary aliases and start the Exim daemon using the following commands:

cat >> /etc/aliases << "EOF"
postmaster: root
MAILER-DAEMON: root
EOF
/usr/sbin/exim -bd -q15m

Note

To protect an existing /etc/aliases file, the command above appends these aliases to it. This file should be checked and duplicate aliases removed, if present.

The /usr/sbin/exim -bd -q15m command starts the Exim daemon with a 15 minute interval in processing the mail queue. Adjust this parameter to suit your desires.

Linux PAM Configuration

If you have built Exim with Linux PAM support, you need to create a PAM configuration file to get it working correctly with BLFS.

Issue the following command as the root user to create the configuration file for Linux PAM:

cat > /etc/pam.d/exim << "EOF"
# Begin /etc/pam.d/exim

auth    include system-auth
account include system-account
session include system-session

# End /etc/pam.d/exim
EOF

Systemd Unit

To automatically start exim at boot, install the exim.service unit included in the blfs-systemd-units-20230816 package:

make install-exim

Contents

Installed Programs: exicyclog, exigrep, exim, exim-4.96-2, exim_checkaccess, exim_dbmbuild, exim_dumpdb, exim_fixdb, exim_lock, exim_tidydb, eximstats, exinext, exipick, exiqgrep, exiqsumm, exiwhat, and optionally, eximon, eximon.bin, and sendmail (symlink)
Installed Libraries: None
Installed Directories: /usr/share/doc/exim-4.96 and /var/spool/exim

Short Descriptions

exicyclog

cycles Exim log files

exigrep

searches Exim log files

exim

is a symlink to the exim-4.96-2 MTA daemon

exim-4.96-2

is the Exim mail transport agent daemon

exim_checkaccess

states whether a given recipient address from a given host is acceptable or not

exim_dbmbuild

creates and rebuilds Exim databases

exim_dumpdb

writes the contents of Exim databases to the standard output

exim_fixdb

modifies data in Exim databases

exim_lock

locks a mailbox file

exim_tidydb

removes old records from Exim databases

eximstats

generates mail statistics from Exim log files

exinext

queries remote host retry times

exipick

selects messages based on various criteria

exiqgrep

is a utility for selective queue listing

exiqsumm

produces a summary of the messages in the mail queue

exiwhat

queries running Exim processes

eximon

is a start-up shell script for eximon.bin used to set the required environment variables before running the program

eximon.bin

is a monitor program which displays current information in an X window, and also contains a menu interface to Exim's command line administration options

Postfix-3.8.1

Introduction to Postfix

The Postfix package contains a Mail Transport Agent (MTA). This is useful for sending email to other users of your host machine. It can also be configured to be a central mail server for your domain, a mail relay agent or simply a mail delivery agent to your local Internet Service Provider.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Postfix Dependencies

Recommended
Optional

ICU-73.2 for Email Address Internationalization (SMTPUTF8) support, MariaDB-10.11.4 or MySQL, OpenLDAP-2.6.6, PCRE-8.45, PostgreSQL-15.4, SQLite-3.42.0, and CDB or TinyCDB

Note that SQLite, MySQL, PostgreSQL and CDB are only useful if there is a known need for them.

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/postfix

Installation of Postfix

Adding Users and Groups

Before you compile the program, you need to create users and groups that will be expected to be in place during the installation. Add the users and groups with the following commands issued by the root user:

groupadd -g 32 postfix &&
groupadd -g 33 postdrop &&
useradd -c "Postfix Daemon User" -d /var/spool/postfix -g postfix \
        -s /bin/false -u 32 postfix &&
chown -v postfix:postfix /var/mail

Configuring the Build

The README files are formatted to be read with a pager like less or more. If you want to use a text editor, make them legible with the following sed:

sed -i 's/.\x08//g' README_FILES/*

The Postfix source tree does not contain a configure script, rather the makefile in the top-level directory contains a makefiles target that regenerates all the other makefiles in the build tree. If you wish to use additional software such as a database back-end for virtual users, or TLS/SSL authentication, you will need to regenerate the makefiles using one or more of the appropriate CCARGS and AUXLIBS settings listed below.

Note

For all variants of the CCARGS you should ensure that -DNO_NIS is specified so that the build does not attempt to access an rpcsvc header which does not exist in BLFS.

For more details read the readme files.

Cyrus-SASL

To use Cyrus-SASL with Postfix, use the following arguments:

CCARGS='-DNO_NIS -DUSE_SASL_AUTH -DUSE_CYRUS_SASL -I/usr/include/sasl'
AUXLIBS='-lsasl2'
OpenLDAP

To use OpenLDAP with Postfix, use the following arguments:

CCARGS='-DNO_NIS -DHAS_LDAP'
AUXLIBS='-lldap -llber'
Sqlite

To use Sqlite with Postfix, use the following arguments:

CCARGS='-DNO_NIS -DHAS_SQLITE'
AUXLIBS='-lsqlite3 -lpthread'
MySQL

To use MySQL with Postfix, use the following arguments:

CCARGS='-DNO_NIS -DHAS_MYSQL -I/usr/include/mysql'
AUXLIBS='-lmysqlclient -lz -lm'
PostgreSQL

To use PostgreSQL with Postfix, use the following arguments:

CCARGS='-DNO_NIS -DHAS_PGSQL -I/usr/include/postgresql'
AUXLIBS='-lpq -lz -lm'
CDB/TinyCDB

To use CDB or TinyCDB with Postfix, use the following arguments:

CCARGS='-DNO_NIS -DHAS_CDB'
AUXLIBS='</path/to/CDB>/libcdb.a'
StartTLS Authentication

To use OpenSSL with Postfix, use the following arguments:

CCARGS='-DNO_NIS -DUSE_TLS -I/usr/include/openssl/'
AUXLIBS='-lssl -lcrypto'

Installing Postfix

Adjust the following according to your needs. For example, if you have Cyrus SASL, install Postfix by running the following commands:

make CCARGS="-DNO_NIS -DUSE_TLS -I/usr/include/openssl/            \
             -DUSE_SASL_AUTH -DUSE_CYRUS_SASL -I/usr/include/sasl" \
     AUXLIBS="-lssl -lcrypto -lsasl2"                              \
     makefiles &&
make

This package does not come with a useful test suite.

Now, as the root user:

sh postfix-install -non-interactive \
   daemon_directory=/usr/lib/postfix \
   manpage_directory=/usr/share/man \
   html_directory=/usr/share/doc/postfix-3.8.1/html \
   readme_directory=/usr/share/doc/postfix-3.8.1/readme

Command Explanations

make makefiles: This command rebuilds the makefiles throughout the source tree to use the options contained in the CCARGS and AUXLIBS variables.

sh postfix-install -non-interactive: This keeps the install script from asking any questions, thereby accepting default destination directories in all but the few cases. If the html_directory and readme_directory options are not set then the documentation will not be installed.

CCARGS="-DNO_EAI ...": this will turn off SMTPUTF8 support, for example if the rest of your email address infrastructure cannot handle UTF-8 email addresses and message header values.

Configuring Postfix

Config Files

/etc/aliases, /etc/postfix/main.cf, and /etc/postfix/master.cf

Configuration Information

Create (or append to an existing) /etc/aliases with the following command. Change <LOGIN> to your non-root login identity so mail addressed to root can be forwarded to you. As the root user:

cat >> /etc/aliases << "EOF"
# Begin /etc/aliases

MAILER-DAEMON:    postmaster
postmaster:       root

root:             <LOGIN>
# End /etc/aliases
EOF

To protect an existing /etc/aliases file, the above command appends these aliases to it if it exists. This file should be checked and duplicate aliases removed, if present.

Note

The /etc/postfix/main.cf and /etc/postfix/master.cf files must be personalized for your system. The main.cf file needs your fully qualified hostname. You will find that main.cf is self documenting, so load it into your editor to make the changes you need for your situation.

Note

Postfix can also be set up to run in a chroot jail. See the file in the source examples/chroot-setup/LINUX2 for details.

If you have an existing configuration, you can run the postfix utility to add any necessary definitions to your existing files. As the root user:

/usr/sbin/postfix upgrade-configuration

Before starting Postfix, you should check that your configuration and file permissions will work properly. Run the following commands as the root user to check and start your Postfix server:

/usr/sbin/postfix check &&
/usr/sbin/postfix start

Systemd Unit

To automate the running of Postfix at startup, install the postfix.service unit included in the blfs-systemd-units-20230816 package:

make install-postfix

Contents

Installed Programs: mailq (symlink), newaliases (symlink), postalias, postcat, postconf, postdrop, postfix, postkick, postlock, postlog, postmap, postmulti, postqueue, postsuper, and sendmail
Installed Libraries: None
Installed Directories: /{etc,usr/lib}/postfix, /usr/share/doc/postfix-3.8.1 and /var/{lib,spool}/postfix

Short Descriptions

mailq

A symlink to sendmail

newaliases

A symlink to sendmail

postalias

is a utility for Postfix alias database maintenance

postcat

Prints the contents of files from the Postfix queue in human readable format

postconf

Displays or changes the value of Postfix configuration parameters

postdrop

Creates a file in the maildrop directory and copies its standard input to the file

postfix

is the Postfix control program

postkick

Sends requests to the specified service over a local transport channel

postlock

Locks a mail folder for exclusive use, and executes commands passed to it

postlog

A Postfix-compatible logging interface for use in, for example, shell scripts

postmap

Creates or queries one or more Postfix lookup tables, or updates an existing one

postmulti

is the Postfix multi-instance manager. It allows a system administrator to manage multiple Postfix instances on a single host

postqueue

The Postfix user interface for queue management

postsuper

The Postfix user interface for superuser queue management

sendmail

is the Postfix to Sendmail compatibility interface

sendmail-8.17.2

Introduction to sendmail

The sendmail package contains a Mail Transport Agent (MTA).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

sendmail Dependencies

Required

OpenLDAP-2.6.6 (client)

Recommended
Optional

ghostscript-10.01.2 (for creating PDF documentation), Procmail-3.22 (the configuration proposed below requires that procmail be present at run-time), and nph

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/sendmail

Installation of sendmail

Before building sendmail, create the required user, group and directory with the following commands issued as the root user:

groupadd -g 26 smmsp                               &&
useradd -c "Sendmail Daemon" -g smmsp -d /dev/null \
        -s /bin/false -u 26 smmsp                  &&
chmod -v 1777 /var/mail                            &&
install -v -m700 -d /var/spool/mqueue

Note

See the source tree sendmail/README file for information on linking optional packages into the build. Use the example below, which adds support for SASL, StartTLS (OpenSSL) and OpenLDAP, as a starting point. Of course, modify it to suit your particular needs.

cat >> devtools/Site/site.config.m4 << "EOF"
APPENDDEF(`confENVDEF',`-DSTARTTLS -DSASL -DLDAPMAP -DHASFLOCK')
APPENDDEF(`confLIBS', `-lssl -lcrypto -lsasl2 -lldap -llber -ldb')
APPENDDEF(`confINCDIRS', `-I/usr/include/sasl')
EOF

Install sendmail with the following commands:

cat >> devtools/Site/site.config.m4 << "EOF"
define(`confMANGRP',`root')
define(`confMANOWN',`root')
define(`confSBINGRP',`root')
define(`confUBINGRP',`root')
define(`confUBINOWN',`root')
EOF

sed -i 's|/usr/man/man|/usr/share/man/man|' \
    devtools/OS/Linux           &&

cd sendmail                     &&
sh Build                        &&
cd ../cf/cf                     &&
cp generic-linux.mc sendmail.mc &&
sh Build sendmail.cf

This package does not come with a test suite.

Now, as the root user:

install -v -d -m755 /etc/mail &&
sh Build install-cf &&

cd ../..            &&
sh Build install    &&

install -v -m644 cf/cf/{submit,sendmail}.mc /etc/mail &&
cp -v -R cf/* /etc/mail                               &&

install -v -m755 -d /usr/share/doc/sendmail-8.17.2/{cf,sendmail} &&

install -v -m644 CACerts FAQ KNOWNBUGS LICENSE PGPKEYS README RELEASE_NOTES \
        /usr/share/doc/sendmail-8.17.2 &&

install -v -m644 sendmail/{README,SECURITY,TRACEFLAGS,TUNING} \
        /usr/share/doc/sendmail-8.17.2/sendmail &&

install -v -m644 cf/README /usr/share/doc/sendmail-8.17.2/cf &&

for manpage in sendmail editmap mailstats makemap praliases smrsh
do
    install -v -m644 $manpage/$manpage.8 /usr/share/man/man8
done &&

install -v -m644 sendmail/aliases.5    /usr/share/man/man5 &&
install -v -m644 sendmail/mailq.1      /usr/share/man/man1 &&
install -v -m644 sendmail/newaliases.1 /usr/share/man/man1 &&
install -v -m644 vacation/vacation.1   /usr/share/man/man1

Install the sendmail Installation and Operations Guide with the following commands:

Note

Remove op.pdf from the make and install commands below if you don't have Ghostscript installed.

cd doc/op                                       &&
sed -i 's/groff/GROFF_NO_SGR=1 groff/' Makefile &&
make op.txt op.pdf

Now, as the root user:

install -v -d -m755 /usr/share/doc/sendmail-8.17.2 &&
install -v -m644 op.ps op.txt op.pdf /usr/share/doc/sendmail-8.17.2 &&
cd ../..

Command Explanations

cat > devtools/Site/site.config.m4 << "EOF": This creates a configuration file changing some of the default settings.

sed ... devtools/OS/Linux: The site.config.m4 does not honor a change to the man directory, so fix it in the OS definitions.

sh Build; sh Build sendmail.cf; sh Build install-cf; sh Build install: sendmail uses an m4 based build script to create the various Makefiles. These commands build and install the package.

for manpage in...;do...;done; install ...: The man pages are installed already formatted and man displays them somewhat garbled. These commands replace the formatted pages with pages man can display properly.

Configuring sendmail

Config Files

/etc/mail/*

Configuration Information

Note

Ensure you have a fully qualified domain name defined in /etc/hosts for your system before proceeding.

Create the /etc/mail/local-host-names and /etc/mail/aliases files using the following commands as the root user:

echo $(hostname) > /etc/mail/local-host-names
cat > /etc/mail/aliases << "EOF"
postmaster: root
MAILER-DAEMON: root

EOF
newaliases

sendmail's primary configuration file, /etc/mail/sendmail.cf, is complex and not meant to be directly edited. The recommended method for changing it is to modify /etc/mail/sendmail.mc and various m4 files, then run the m4 macro processor from within /etc/mail as follows:

cd /etc/mail &&
m4 m4/cf.m4 sendmail.mc > sendmail.cf

A full explanation of the files to modify, and the available parameters can be found in /etc/mail/README.

Systemd Unit

To automate the running of sendmail at startup, install the sendmail.service unit included in the blfs-systemd-units-20230816 package:

make install-sendmail

Note

The -qNm option to sendmail, where N is number of minutes, controls how often sendmail will process the mail queue. A default of 5 minutes is used in the systemd unit. Individual workstation users may want to set this as low as 1 minute, large installations handling more mail may want to set it higher.

Contents

Installed Programs: editmap, mailstats, makemap, praliases, sendmail, smrsh, and vacation; symlinks to /usr/sbin/sendmail: hoststat, mailq, newaliases, and purgestat
Installed Libraries: None
Installed Directories: /etc/mail, /usr/share/doc/sendmail-8.17.2, and /var/spool/clientmqueue

Short Descriptions

editmap

queries and edits sendmail map files

hoststat

prints sendmail's persistent host status

mailstats

displays sendmail statistics

mailq

prints a summary of outbound mail messages waiting for delivery

makemap

creates sendmail map files

newaliases

rebuilds /etc/mail/aliases.db from the contents of /etc/mail/aliases

praliases

displays current sendmail aliases

purgestat

causes sendmail to clear (purge) all its host-status information

sendmail

is the sendmail mail transport agent

smrsh

is a restricted shell for sendmail

vacation

is an email auto responder

Chapter 22. Databases

This chapter includes databases that range from single-user read/write to industrial database servers with transaction support. Generally, you will be sent here to satisfy dependencies to other applications although building a SQL server on a base LFS system is entirely possible.

Important Notes About Upgrading Database Server Software

Note

This section is about reinstalling database software when an existing database is in use. It is not applicable for initial installations or if there is no existing database for the package being updated, but users should read through it to become aware of issues that can arise in the future.

Let's start this chapter with a dramatic screenshot of an error that really happened. This error will not occur if you are installing database software for the first time:

$ sudo systemctl status postgresql
-- postgresql.service - PostgreSQL database server
     Loaded: loaded (/usr/lib/systemd/system/postgresql.service; enabled; vendor preset: enabled)
     Active: failed (Result: exit-code) since Tue 2021-10-26 17:11:53 CDT; 2min 49s ago
    Process: 17336 ExecStart=/usr/bin/pg_ctl -s -D ${PGROOT}/data start -w -t 120 (code=exited, status=1/FAILURE)
        CPU: 7ms

Oct 26 17:11:53 SVRNAME systemd[1]: Starting PostgreSQL database server...
Oct 26 17:11:53 SRVNAME postgres[17338]: 2021-10-26 17:11:53.420 CDT [17338] FATAL:
                database files are incompatible with server
Oct 26 17:11:53 SRVNAME postgres[17338]: 2021-10-26 17:11:53.420 CDT [17338] DETAIL:
                The data directory was initialized by PostgreSQL version 13,
                which is not compatible with this version 14.0.
Oct 26 17:11:53 SRVNAME postgres[17336]: pg_ctl: could not start server
Oct 26 17:11:53 SRVNAME postgres[17336]: Examine the log output.
Oct 26 17:11:53 SRVNAME systemd[1]: postgresql.service: Control process exited, code=exited, status=1/FAILURE
Oct 26 17:11:53 SRVNAME systemd[1]: postgresql.service: Failed with result 'exit-code'.
Oct 26 17:11:53 SRVNAME systemd[1]: Failed to start PostgreSQL database server.

To avoid situations like this (i.e., your database server software refuses to start), read the following discussion of the best way to upgrade a DBMS (Database Management System).

The root cause of the error shown above was an upgrade of the server software to a newer major version which left the data files untouched. In this case, the administrator was able to recover the DBMS without any loss of data.

Even if you are doing an initial DBMS install, read through this section. It provides information about implementing backup and restore procedures (or at least a strategy for creating them) which will satisfy your needs and guarantee the safety of your data.

Upgrade Database Server Packages

Database systems work on files which hold the database metadata and the data itself. The internal structure of these files is optimized for use by the server software. When such server software is upgraded, the new software may utilize a different file format than had previously been used. Sometimes the new software can work with the old format as well as the new one—but without the performance improvements the new format provides. Other times, the new server software will reformat the data files automatically after the upgrade.

Unfortunately, the most likely case is that the new server software complains about out of date file formats and exits. When this happens, and you have overwritten the old server software, you may end up with a broken system and lost data.

Changes in data file formats usually happen at major version changes, but they can also occur at other times. Before upgrading any DBMS software, check the documentation to see if this upgrade makes changes which require reformatting the database.

Of course, if you have databases with content that is not easily rebuilt, it is always a good idea to create backups of the database from time to time. Before upgrading the server software, you should run another backup.

Upgrade by Backup and Restore

Note

A backup is useless if there is no verified process to restore the data from this backup. When running a database server, you should not only create backups; you should also verify that the restore process really works. The time to test the restore procedure is before you urgently need to recover lost data.

Most database server software provides some basic tools to create backups of your data. Usually the backups created with those tools can be read by newer versions of the software (via a restore tool). Using older restore tools with newer backup data is a bad idea; you should never blindly assume that it will work. It might, but usually it doesn't.

The easiest way to upgrade your database files is to

  • Create a full database backup using the old tools.

    This step creates an offline copy of the database files—for long term archiving, for disaster recovery, or as preparation for an upgrade. This offline backup consists of either (1) a full one-to-one copy of the current database files, or (2) a full backup of the database files from a certain point in time, plus all the journal data (that is Oracle® terminology, it is called "Continuous Archiving" or "write ahead log (WAL)" in Postgresql) describing the changes made after that point in time. This second form takes less time to create (if the DB software provides this type of journaling) because you only have to save the data that have changed since the last full backup was created.

    When upgrading database server software, a full backup (which can be used for subsequent incremental backups) should be created; but if there is a lot of data, an incremental backup will suffice. The best strategy for you depends on the amount of data stored in your database (is it a few hundred table rows, or is it hundreds of terabytes?). A full backup in the latter case can't be done quickly. To fully protect your data, create a backup of the old programs (and/or their sources) and save it, along with the data files, to be certain there is a fallback solution if the new software cannot read the old data.

  • Upgrade the server software

    In this step, instructions to build the database server software are executed just as they are shown in subsequent sections talking about the DBMs like MariaDB or Postgresql. That is, build the software as usual using BLFS instructions.

  • Restore the database by using the new tools.

    To restore the data, the tools of the newly installed server software should be used. During the restoration process, the new tools will create and/or upgrade the data files in the format the new software requires. It is assumed that newer software is capable of reading old data.

Since you already have a backup procedure in place (and you have tested your restore procedure, right?), this might be the easiest way to upgrade as you can use your well known processes to upgrade just as you always do—at least in terms of the backup and restore.

Upgrade the Database Files by Using System Tools

Some database systems (for instance Postgresql) provide a tool which can reformat (upgrade) the existing database files to the new format. If you need to restore from a backup (for example, running the upgrade tool failed) you will have to reinstall the old software to recover your data.

Even though the reformatting tools might work as advertised, you should create a full backup before running them. A failure could cause serious damage to the database.

Notes for Specific DBMS

PostgreSQL

Upstream documentation for Backup/Restore: https://www.postgresql.org/docs/current/backup.html

MariaDB

Upstream documentation for Backup/Restore: https://mariadb.com/kb/en/backup-and-restore-overview/

Sqlite

Do not underestimate Sqlite. It is a feature-rich DBMS. The main difference from the two big players above is that Sqlite does not provide access via a network API. Sqlite databases are always stored on the machine running the program which uses the database. The manipulation of data content is done via API calls to library functions directly within the program.

In the upstream documentation you may find the following useful:

Documentation of the sqlite3 command line tool: https://www.sqlite.org/cli.html

Documentation of backup API calls: https://www.sqlite.org/backup.html

Unfortunately, there is no dedicated chapter in the upstream documentation talking about backup/restore, but there are several articles about it on the Internet. Here is an example.

Documentation for Backup/Restore: https://database.guide/backup-sqlite-database/

Berkeley DB

Like Sqlite, this software acts on local database files; there is no network interface.

The relevant resources to back up/restore a Berkeley database are the man pages for db_dump and its counterpart db_load.

Berkeley DB-5.3.28

Introduction to Berkeley DB

The Berkeley DB package contains programs and utilities used by many other applications for database related functions.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Berkeley DB Dependencies

Optional

libnsl-2.0.0 and Sharutils-4.15.2 (for the uudecode command)

Installation of Berkeley DB

First apply a fix so that this will compile with current versions of g++:

sed -i 's/\(__atomic_compare_exchange\)/\1_db/' src/dbinc/atomic.h

Install Berkeley DB by running the following commands:

cd build_unix                        &&
../dist/configure --prefix=/usr      \
                  --enable-compat185 \
                  --enable-dbm       \
                  --disable-static   \
                  --enable-cxx       &&
make

Now, as the root user:

make docdir=/usr/share/doc/db-5.3.28 install &&

chown -v -R root:root                        \
      /usr/bin/db_*                          \
      /usr/include/db{,_185,_cxx}.h          \
      /usr/lib/libdb*.{so,la}                \
      /usr/share/doc/db-5.3.28

Command Explanations

cd build_unix && ../dist/configure --prefix=/usr...: This replaces the normal ./configure command, as Berkeley DB comes with various build directories for different platforms.

--enable-compat185: This switch enables building the DB-1.85 compatibility API.

--enable-cxx: This switch enables building C++ API libraries.

--enable-dbm: Enables legacy interface support needed by some older packages.

make docdir=/usr/share/doc/db-5.3.28 install: This installs the documentation in the standard location instead of /usr/docs.

chown -v -R root:root ...:This command changes the ownership of various installed files from the uid:gid of the builder to root:root.

--enable-tcl --with-tcl=/usr/lib: Enables Tcl support in DB and creates the libdb_tcl libraries.

--enable-java: Enables Java support in DB and creates the libdb_java libraries. Java support is currently broken with Java-9.x and higher.

Contents

Installed Programs: db_archive, db_checkpoint, db_deadlock, db_dump, db_hotbackup, db_load, db_log_verify, db_printlog, db_recover, db_replicate, db_stat, db_tuner, db_upgrade, and db_verify
Installed Libraries: libdb.so, libdb_cxx.so, and libdb_tcl.so
Installed Directory: /usr/share/doc/db-5.3.28

Short Descriptions

db_archive

prints the pathnames of log files that are no longer in use

db_checkpoint

is a daemon process used to monitor and checkpoint database logs

db_deadlock

is used to abort lock requests when deadlocks are detected

db_dump

converts database files to a flat file format readable by db_load

db_hotbackup

creates "hot backup" or "hot failover" snapshots of Berkeley DB databases

db_load

is used to create database files from flat files created with db_dump

db_log_verify

verifies the log files of a database

db_printlog

converts database log files to human readable text

db_recover

is used to restore a database to a consistent state after a failure

db_replicate

is a daemon process that provides replication/HA services on a transactional environment

db_stat

displays database environment statistics

db_tuner

analyzes the data in a btree database, and suggests a page size that is likely to deliver optimal operation

db_upgrade

is used to upgrade database files to a newer version of Berkeley DB

db_verify

is used to run consistency checks on database files

lmdb-0.9.31

Introduction to lmdb

The lmdb package is a fast, compact, key-value embedded data store. It uses memory-mapped files, so it has the read performance of a pure in-memory database while still offering the persistence of standard disk-based databases, and is only limited to the size of the virtual address space

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of lmdb

Note

This package extracts to lmdb-LMDB_0.9.31.

Install lmdb by running the following commands:

cd libraries/liblmdb &&
make                 &&
sed -i 's| liblmdb.a||' Makefile

This package does not come with a test suite.

Now, as the root user:

make prefix=/usr install

Command Explanations

sed ... liblmdb.a ... Makefile: The package executables use a static library so it must be created. This command suppresses installation of the static library.

Contents

Installed Program: mdb_copy, mdb_dump, mdb_load, and mdb_stat
Installed Library: liblmdb.so
Installed Directories: None

MariaDB-10.11.4

Introduction to MariaDB

MariaDB is a community-developed fork and a drop-in replacement for the MySQL relational database management system.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Note

The installed size of MariaDB is 658 MB, but this can be reduced by about 252 MB, if desired, by removing the /usr/share/mysql/test directory after installation.

MariaDB Dependencies

Required

CMake-3.27.2

Recommended
Optional

Boost-1.83.0, libaio-0.3.113, libxml2-2.10.4, Linux-PAM-1.5.3, LZO-2.10, MIT Kerberos V5-1.21.2, pcre2-10.42, Ruby-3.2.2, sphinx-7.1.2, unixODBC-2.3.12, Valgrind-3.21.0, Groonga, KyTea, Judy, lz4, MeCab, MessagePack, mruby, MyRocks, Snappy, and ZeroMQ

Installation of MariaDB

Warning

MariaDB and MySQL cannot be installed on the same system without extensive changes to the build configuration of one of the two applications.

For security reasons, running the server as an unprivileged user and group is strongly encouraged. Issue the following (as root) to create the user and group:

groupadd -g 40 mysql &&
useradd -c "MySQL Server" -d /srv/mysql -g mysql -s /bin/false -u 40 mysql

Install MariaDB by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_BUILD_TYPE=Release                      \
      -DCMAKE_INSTALL_PREFIX=/usr                     \
      -DGRN_LOG_PATH=/var/log/groonga.log             \
      -DINSTALL_DOCDIR=share/doc/mariadb-10.11.4       \
      -DINSTALL_DOCREADMEDIR=share/doc/mariadb-10.11.4 \
      -DINSTALL_MANDIR=share/man                      \
      -DINSTALL_MYSQLSHAREDIR=share/mysql             \
      -DINSTALL_MYSQLTESTDIR=share/mysql/test         \
      -DINSTALL_PAMDIR=lib/security                   \
      -DINSTALL_PAMDATADIR=/etc/security              \
      -DINSTALL_PLUGINDIR=lib/mysql/plugin            \
      -DINSTALL_SBINDIR=sbin                          \
      -DINSTALL_SCRIPTDIR=bin                         \
      -DINSTALL_SQLBENCHDIR=share/mysql/bench         \
      -DINSTALL_SUPPORTFILESDIR=share/mysql           \
      -DMYSQL_DATADIR=/srv/mysql                      \
      -DMYSQL_UNIX_ADDR=/run/mysqld/mysqld.sock       \
      -DWITH_EXTRA_CHARSETS=complex                   \
      -DWITH_EMBEDDED_SERVER=ON                       \
      -DSKIP_TESTS=ON                                 \
      -DTOKUDB_OK=0                                   \
      .. &&
make

To test the results, issue: make test. One test, test-connect, is known to fail.

Note

A more extensive set of tests can be run with the following:

pushd mysql-test
./mtr --parallel <N> --mem --force
popd

Where N is the number of tests to run in parallel. Over 5400 tests are run in about 24 SBU with N=4. A few tests may fail, mainly due to character set issues.

Now, as the root user:

make install

If you have Linux-PAM-1.5.3 installed, move the PAM module and configuration file installed by this package as the root user:

mv -v /usr/share/pam_use_map.so /lib/security &&
mv -v /usr/share/user_map.conf /etc/security

Command Explanations

-DWITH_EMBEDDED_SERVER=ON: This switch enables compiling the embedded server library needed by certain applications, such as Amarok.

-DWITH_EXTRA_CHARSETS=complex: This switch enables support for the complex character sets.

-DSKIP_TESTS=ON: This switch disables tests for MariaDB Connector/C which are not supported without additional setup.

-DWITHOUT_SERVER=ON: Use this switch if you don't want the server and would like to build the client only.

Note

There are numerous options available to cmake. Check the output of the cmake . -LH for additional customization options.

Configuring MySQL

Config Files

/etc/mysql/my.cnf and ~/.my.cnf

Configuration Information

Create basic /etc/mysql/my.cnf using the following command as the root user:

install -v -dm 755 /etc/mysql &&
cat > /etc/mysql/my.cnf << "EOF"
# Begin /etc/mysql/my.cnf

# The following options will be passed to all MySQL clients
[client]
#password       = your_password
port            = 3306
socket          = /run/mysqld/mysqld.sock

# The MySQL server
[mysqld]
port            = 3306
socket          = /run/mysqld/mysqld.sock
datadir         = /srv/mysql
skip-external-locking
key_buffer_size = 16M
max_allowed_packet = 1M
sort_buffer_size = 512K
net_buffer_length = 16K
myisam_sort_buffer_size = 8M

# Don't listen on a TCP/IP port at all.
skip-networking

# required unique id between 1 and 2^32 - 1
server-id       = 1

# Uncomment the following if you are using BDB tables
#bdb_cache_size = 4M
#bdb_max_lock = 10000

# InnoDB tables are now used by default
innodb_data_home_dir = /srv/mysql
innodb_log_group_home_dir = /srv/mysql
# All the innodb_xxx values below are the default ones:
innodb_data_file_path = ibdata1:12M:autoextend
# You can set .._buffer_pool_size up to 50 - 80 %
# of RAM but beware of setting memory usage too high
innodb_buffer_pool_size = 128M
innodb_log_file_size = 48M
innodb_log_buffer_size = 16M
innodb_flush_log_at_trx_commit = 1
innodb_lock_wait_timeout = 50

[mysqldump]
quick
max_allowed_packet = 16M

[mysql]
no-auto-rehash
# Remove the next comment character if you are not familiar with SQL
#safe-updates

[isamchk]
key_buffer = 20M
sort_buffer_size = 20M
read_buffer = 2M
write_buffer = 2M

[myisamchk]
key_buffer_size = 20M
sort_buffer_size = 20M
read_buffer = 2M
write_buffer = 2M

[mysqlhotcopy]
interactive-timeout

# End /etc/mysql/my.cnf
EOF

You can now install a database and change the ownership to the unprivileged user and group (perform as the root user):

mysql_install_db --basedir=/usr --datadir=/srv/mysql --user=mysql &&
chown -R mysql:mysql /srv/mysql

Further configuration requires that the MariaDB server is running. Start the server using the following commands as the root user:

install -v -m755 -o mysql -g mysql -d /run/mysqld &&
mysqld_safe --user=mysql 2>&1 >/dev/null &

A default installation does not set up a password for the administrator, so use the following command as the root user to set one.

mysqladmin -u root password

Configuration of the server is now finished. Shut the server down using the following command as the root user:

mysqladmin -p shutdown

Systemd Unit

Install the mysqld.service unit included in the blfs-systemd-units-20230816 package as the root user to start the MariaDB server during system boot-up.

make install-mysqld

Note

If you have an existing database already and this installation of binaries was just an upgrade to a newer version, check the upstream documentation for upgrading. It is recommended to run:

mariadb-upgrade

Contents

Installed Programs: aria_chk, aria_dump_log, aria_ftdump, aria_pack, aria_read_log, aria_s3_copy, galera_new_cluster, galera_recovery, innochecksum, mariabackup, mariadb, mariadbd, mariadb-access, mariadb-admin, mariadb-backup, mariadb-binlog, mariadb-check, mariadb-client-test, mariadb-client-test-embedded, mariadb-conv, mariadb-convert-table-format, mariadb-find-rows, mariadbd-multi, mariadbd-safe, mariadbd-safe-helper, mariadb-dump, mariadb-dumpslow, mariadb-embedded, mariadb-fix-extensions, mariadb-hotcopy, mariadb-import, mariadb-install-db, mariadb-ldb, mariadb-plugin, mariadb-secure-installation, mariadb-setpermission, mariadb-service-convert, mariadb-show, mariadb-slap, mariadb-test, mariadb-test-embedded, mariadb-tzinfo-to-sql, mariadb-upgrade, mariadb-waitpid, mariadb_config, mbstream, msql2mysql, my_print_defaults, myisamchk, myisam_ftdump, myisamlog, myisampack, mysql_config, mytop, perror, replace, resolve_stack_dump, resolveip, sst_dump, wsrep_sst_common, wsrep_sst_mariabackup, wsrep_sst_mysqldump, and wsrep_sst_rsync
Installed Libraries: libmariadbclient.a, libmariadb.so, libmariadbd.so, libmysqlclient.a, libmysqlclient_r.a (symbolic links to libmariadbclient.a), libmysqld.{so,a}, libmysqlservices.a, and several under /usr/lib/mysql/plugin/
Installed Directories: /etc/mysql, /usr/{include,lib,share}/mysql, /usr/share/groonga{-normalizer-mysql}, and /usr/share/doc/mariadb-10.11.4

Short Descriptions

There are several symlinks from mysql* to their mariadb counterparts. These are maintained for compatibility.

The Perl DBI modules must be installed for some of the MariaDB support programs to function properly.

Short Descriptions

aria_chk

is used to check, repair, optimize, sort and get information about Aria tables

aria_dump_log

is a tool to dump the contents of Aria log pages

aria_ftdump

displays full-text index information

aria_pack

is a tool to generate compressed, read-only Aria tables

aria_read_log

displays Aria log file contents

aria_s3_copy

copies an aria table to and from AWS S3

galera_new_cluster

bootstraps a new Galera cluster

galera_recovery

recovers data from a Galera cluster

innochecksum

prints checksums for InnoDB files

mariabackup

is an open source backup tool for InnoDB and XtraDB

mariadb

is a simple SQL shell with input line editing capabilities

mariadbd

is the MySQL server daemon

mariadb-access

checks the access privileges for a host name, user name, and database combination

mariadb-admin

is a client for performing administrative operations

mariadb-binlog

reads binary log files

mariadb-check

performs table maintenance: It checks, repairs, optimizes, or analyzes tables

mariadb-client-test

is used for testing aspects of the MySQL client API that cannot be tested using mysqltest and its test language

mariadb-client-test-embedded

is a tool to test the client API for the embedded server

mariadb-conv

converts character sets for use with MariaDB

mariadb-convert-table-format

converts the tables in a database to use a particular storage engine

mariadbd-multi

is designed to manage several mysqld processes that listen for connections on different Unix socket files and TCP/IP ports

mariadbd-safe

is the recommended way to start a mysqld server on Unix and NetWare

mariadb-dump

is a backup program

mariadb-dumpslow

parses MySQL slow query log files and prints a summary of their contents

mariadb-embedded

is a MySQL client statically linked to libmariadbd

mariadb-find-rows

reads files containing SQL statements and extracts statements that match a given regular expression or that contain USE db_name or SET statements

mariadb-fix-extensions

converts the extensions for MyISAM (or ISAM) table files to their canonical forms

mariadb-hotcopy

locks the table, flushes the table and then performs a copy of the database

mariadb-import

reads a range of data formats, and inserts the data into a database

mariadb-install-db

initializes the MySQL data directory and creates the system tables that it contains, if they do not exist

mariadb-ldb

is the RocksDB tool

mariadb-plugin

is a utility that enables MySQL administrators to manage which plugins a MySQL server loads

mariadb-secure-installation

is a tool to improve MySQL installation security

mariadb-service-convert

generates a systemd unit based on the current mariadb settings

mariadb-setpermission

sets permissions in the MySQL grant tables

mariadb-show

shows the structure of a MariaDB database

mariadb-slap

is a diagnostic program designed to emulate client load for a MySQL server and to report the timing of each stage

mariadb-test

runs a test case against a MySQL server and optionally compares the output with a result file

mariadb-test-embedded

is similar to the mysqltest command but is built with support for the libmysqld embedded server

mariadb-tzinfo-to-sql

loads the time zone tables in the mysql database

mariadb-upgrade

examines all tables in all databases for incompatibilities with the current version of MySQL Server

mariadb-waitpid

signals a process to terminate and waits for the process to exit

mariadb_config

gets compiler flags for using the MariaDB Connector/C

mbstream

is an utility for sending InnoDB and XTraDB backups over a stream

msql2mysql

is a tool to convert mSQL programs for use with MySQL

my_print_defaults

displays the options from option groups of option files

myisam_ftdump

displays information about FULLTEXT indexes in MyISAM tables

myisamchk

gets information about your database tables or checks, repairs, or optimizes them

myisamlog

displays MyISAM log file contents

myisampack

is a tool for compressing MyISAM tables

mysql_config

provides you with useful information for compiling your MySQL client and connecting it to MySQL

mytop

is a console-based tool for monitoring the threads and overall performance of a MySQL server

perror

is a utility that displays descriptions for system or storage engine error codes

replace

is a MariaDB/MySQL extension to the SQL standard

resolve_stack_dump

resolves a numeric stack dump to symbols

resolveip

is a utility for resolving IP addresses to host names and vice versa

sst_sump

dumps the content of sst files (the format used by RocksDB)

PostgreSQL-15.4

Introduction to PostgreSQL

PostgreSQL is an advanced object-relational database management system (ORDBMS), derived from the Berkeley Postgres database management system.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

PostgreSQL Dependencies

Optional

ICU-73.2, libxml2-2.10.4, libxslt-1.1.38, OpenLDAP-2.6.6, Linux-PAM-1.5.3, MIT Kerberos V5-1.21.2 and Bonjour

Optional (To Regenerate Documentation)

fop-2.9, docbook-4.5-dtd, docbook-dsssl-1.79, DocBook-utils-0.6.14, OpenJade-1.3.2, and SGMLSpm-1.1

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/postgresql

Installation of PostgreSQL

For enhanced security, it is better to have a dedicated group and user for running the PostgreSQL server. First, issue as the root user:

groupadd -g 41 postgres &&
useradd -c "PostgreSQL Server" -g postgres -d /srv/pgsql/data \
        -u 41 postgres

Note

There are several configuration items that add additional functionality with optional packages to PostgreSQL. Use ./configure --help to see a list.

Install PostgreSQL with the following commands:

sed -i '/DEFAULT_PGSOCKET_DIR/s@/tmp@/run/postgresql@' src/include/pg_config_manual.h &&

./configure --prefix=/usr          \
            --enable-thread-safety \
            --docdir=/usr/share/doc/postgresql-15.4 &&
make

There are a number of programs in the contrib/ directory. If you are going to run this installation as a server and wish to build some of them, enter make -C contrib or make -C contrib/<SUBDIR-NAME> for each subdirectory.

Tests must be run as an unprivileged user because they need to start a temporary server and this is prevented as the root user. For the same reason, you need to stop all PostgreSQL servers if any are running. If a previous version of PostgreSQL is installed, it may be necessary to use --disable-rpath with configure to avoid failures, but installing the binaries created using this switch is not recommended. To test the results, issue: make check.

Note

If you are installing PostgreSQL to upgrade an existing installation, there are important steps that you need to follow. If the major version of the new build is greater than the previous version, there is a chance that the data file format has changed. new software cannot act on the existing data files. In this case, the server will not start because the old programs have been overwritten, so the data is unavailable until it's file format has been converted.

Before upgrading an existing installation of PostgreSQL, check the documentation for any considerations that you must keep in mind during the upgrade. Note that new major versions might use a different binary format in the data objects, causing potential incompatibilities. For more information, check out upstream's documentation about upgrading PostgreSQL here. https://www.postgresql.org/docs/current/upgrading.html.

At this point, you may have both the old and the new binaries installed on your filesystem. These binaries can be used to perform an upgrade of your existing database files. For the following instructions it is assumed that

  • The actual data files are stored in /srv/pgsql/data

  • The upgraded data files will be stored in /srv/pgsql/newdata

  • There is enough disk space to hold the actual data files twice. The upgrade is not an inline upgrade but it will copy the data to new database files.

First, do a temporary install which makes access to the new binaries much easier:

make DESTDIR=$(pwd)/DESTDIR install

Next, create a directory which is writable by the postgres user, as the root user:

install -d -o postgres $(pwd)/DESTDIR/tmp

Now, stop the existing instance of PostgreSQL and start the upgrade process as the root user:

pushd $(pwd)/DESTDIR/tmp
systemctl stop postgresql
su postgres -c "../usr/bin/initdb -D /srv/pgsql/newdata"
su postgres -c "../usr/bin/pg_upgrade \
                    -d /srv/pgsql/data    -b /usr/bin \
                    -D /srv/pgsql/newdata -B ../usr/bin"
popd

At this point, your database files are available in two locations on disk. The old data is located in /srv/pgsql/data, and the new data is in /srv/pgsql/newdata. Backing up the old database files is suggested before continuing.

Next, remove the old database files, and rename the new data directory as the root user:

rm -rf /srv/pgsql/data
mv /srv/pgsql/newdata /srv/pgsql/data

Now, as the root user:

make install      &&
make install-docs

If you made any of the contrib/ programs, as the root user:

make -C contrib/<SUBDIR-NAME> install

Tip

If you only intend to use PostgreSQL as a client to connect to a server on another machine, your installation is complete and you should not run the remaining commands.

If you have upgraded an existing database, skip the rest of the commands because your database is ready to use. If this is the first time you install PostgreSQL, continue with the initialization.

Initialize a database cluster with the following commands issued by the root user:

install -v -dm700 /srv/pgsql/data &&
install -v -dm755 /run/postgresql &&
chown -Rv postgres:postgres /srv/pgsql /run/postgresql

Now, initialize the database as the root user:

su - postgres -c '/usr/bin/initdb -D /srv/pgsql/data'

Command Explanations

sed -i ...: This sed changes the server socket location from /tmp to /run/postgresql.

--enable-thread-safety: This switch makes the client libraries thread-safe by allowing concurrent threads in libpq and ECPG programs to safely control their private connection handles.

--with-openssl: builds the package with support for OpenSSL encrypted connections.

--with-perl: builds the PL/Perl server-side language.

--with-python: builds the PL/Python server-side language. Python3 is used by default, Python2 is no longer supported.

--with-tcl: builds the PL/Tcl server-side language.

Configuring PostgreSQL

Config Files

$PGDATA/pg_ident.con, $PGDATA/pg_hba.conf, and $PGDATA/postgresql.conf

The PGDATA environment variable is used to distinguish database clusters from one another by setting it to the value of the directory which contains the cluster desired. The three configuration files exist in every PGDATA/ directory. Details on the format of the files and the options that can be set in each can be found in /usr/share/doc/postgresql-15.4/html/index.html.

Systemd Unit

Install the postgresql.service unit included in the blfs-systemd-units-20230816 package:

make install-postgresql

Starting the PostgreSQL Server and Creating a Sample Database

The database server can be manually started with the following command (as the root user):

su - postgres -c '/usr/bin/postgres -D /srv/pgsql/data > \
                  /srv/pgsql/data/logfile 2>&1 &'

Note

If you are scripting this part, you should wait for the server to start before going on, by adding for example sleep 2 after the above command.

The instructions below show how to create a database, add a table to it, insert some rows into the table and select them, to verify that the installation is working properly. Still as user root, issue:

su - postgres -c '/usr/bin/createdb test' &&
echo "create table t1 ( name varchar(20), state_province varchar(20) );" \
    | (su - postgres -c '/usr/bin/psql test ') &&
echo "insert into t1 values ('Billy', 'NewYork');" \
    | (su - postgres -c '/usr/bin/psql test ') &&
echo "insert into t1 values ('Evanidus', 'Quebec');" \
    | (su - postgres -c '/usr/bin/psql test ') &&
echo "insert into t1 values ('Jesse', 'Ontario');" \
    | (su - postgres -c '/usr/bin/psql test ') &&
echo "select * from t1;" | (su - postgres -c '/usr/bin/psql test')

When you are done with testing, you can shut down the server, by issuing as root:

su - postgres -c "/usr/bin/pg_ctl stop -D /srv/pgsql/data"

Contents

Installed Programs: clusterdb, createdb, createuser, dropdb, dropuser, ecpg, initdb, pg_amcheck, pg_archivecleanup, pg_basebackup, pg_checksums, pg_config, pg_controldata, pg_ctl, pg_dump, pg_dumpall, pg_isready, pg_receivewal, pg_recvlogical, pg_resetwal, pg_restore, pg_rewind, pg_test_fsync, pg_test_timing, pg_upgrade, pg_verifybackup, pg_waldump, pgbench, postgres, postmaster (deprecated), psql, reindexdb, vacuumdb, optionally, if Tcl support has been built, pltcl_delmod, pltcl_listmod, pltcl_loadmod, and optionally (in contrib/) oid2name, pg_standby, vacuumlo, and many others
Installed Libraries: libecpg.{so,a}, libecpg_compat.{so,a}, libpgcommon.a, libpgcommon_shlib.a, libpgfeutils.a, libpgport.a, libpgport_shlib.a, libpgtypes.{so,a}, libpq.{so,a}, various charset modules and optionally programming language modules under /usr/lib/postgresql
Installed Directories: /usr/include/{libpq,postgresql}, /usr/lib/postgresql, /usr/share/{doc/postgresql-15.4,postgresql}, and /srv/pgsql

Short Descriptions

clusterdb

is a utility for reclustering tables in a PostgreSQL database

createdb

creates a new PostgreSQL database

createuser

defines a new PostgreSQL user account

dropdb

removes a PostgreSQL database

dropuser

removes a PostgreSQL user account

ecpg

is the embedded SQL preprocessor

initdb

creates a new database cluster

oid2name

resolves OIDs (Object IDs) and file nodes in a PostgreSQL data directory

pg_amcheck

checks for corruption in one or more PostgreSQL databases

pg_archivecleanup

cleans up PostgreSQL WAL (write-ahead log) archive files

pg_basebackup

takes base backups of a running PostgreSQL cluster

pg_checksums

enables, disables, or checks data checksums in a PostgreSQL database cluster

pg_config

retrieves PostgreSQL version information

pg_controldata

returns information initialized during initdb, such as the catalog version and server locale

pg_ctl

controls stopping and starting the database server

pg_dump

dumps database data and metadata into scripts which are used to recreate the database

pg_dumpall

recursively calls pg_dump for each database in a cluster

pg_isready

checks the connection status of a PostgreSQL server

pg_receivewal

is used to stream write-ahead logs from a PostgreSQL server

pg_recvlogical

controls PostgreSQL logical decoding streams

pg_resetwal

resets the write-ahead log and other control information of a PostgreSQL database cluster

pg_restore

creates databases from dump files created by pg_dump

pg_rewind

synchronizes a PostgreSQL data directory with another data directory that was forked from the first one

pg_standby

supports the creation of a PostgreSQL warm standby server

pg_test_fsync

determines the fastest wal_sync method for PostgreSQL

pg_test_timing

measures timing overhead

pg_upgrade

upgrades a PostgreSQL server instance

pg_verifybackup

verifies the integrity of a base backup of a PostgreSQL cluster

pg_waldump

displays a human-readable rendering of the write-ahead log of a PostgreSQL database cluster

pgbench

runs a benchmark test on PostgreSQL

pltcl_delmod

is a support script used to delete a module from a PL/Tcl table. The command requires the Pgtcl package to be installed

pltcl_listmod

is a support script used to list the modules in a PL/Tcl table. The command requires the Pgtcl package to be installed

pltcl_loadmod

is a support script used to load a module into a PL/Tcl table. The command requires the Pgtcl package to be installed too

postgres

is the PostgreSQL database server

postmaster

(deprecated, a symlink to postgres) is a multi-user database daemon

psql

is a console based database shell

reindexdb

is a utility for rebuilding indexes in a database

vacuumdb

compacts databases and generates statistics for the query analyzer

vacuumlo

removes orphaned large objects from a PostgreSQL database

libecpg.{so,a}

contains functions to support embedded SQL in C programs

libecpg_compat.{so,a}

is the ecpg compatibility library

libgport.a

is the port-specific subsystem of the Postgres backend

libpgtypes.{so,a}

contains functions for dealing with Postgres data types

libpq.{so,a}

is the C programmer's API to Postgres

SQLite-3.42.0

Introduction to SQLite

The SQLite package is a software library that implements a self-contained, serverless, zero-configuration, transactional SQL database engine.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Optional Documentation

SQLite Dependencies

Optional

libedit and UnZip-6.0 (required to unzip the documentation)

Installation of SQLite

If you downloaded the optional documentation, issue the following command to install the documentation into the source tree:

unzip -q ../sqlite-doc-3420000.zip

Install SQLite by running the following commands:

./configure --prefix=/usr     \
            --disable-static  \
            --enable-fts{4,5} \
            CPPFLAGS="-DSQLITE_ENABLE_COLUMN_METADATA=1 \
                      -DSQLITE_ENABLE_UNLOCK_NOTIFY=1   \
                      -DSQLITE_ENABLE_DBSTAT_VTAB=1     \
                      -DSQLITE_SECURE_DELETE=1          \
                      -DSQLITE_ENABLE_FTS3_TOKENIZER=1" &&
make

This package does not come with a test suite.

Now, as the root user:

make install

If you downloaded the optional documentation, issue the following commands as the root user to install it:

install -v -m755 -d /usr/share/doc/sqlite-3.42.0 &&
cp -v -R sqlite-doc-3420000/* /usr/share/doc/sqlite-3.42.0

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-fts{4,5}: These switches enable support for version 3, 4 and 5 of the full text search (FTS) extension. Note that the --enable-fts4 switch enables support for both FTS version 4 and FTS version 3.

CPPFLAGS="-DSQLITE_ENABLE_COLUMN_METADATA=1 -DSQLITE_ENABLE_UNLOCK_NOTIFY=1 -DSQLITE_ENABLE_DBSTAT_VTAB=1 -DSQLITE_SECURE_DELETE=1 -DSQLITE_ENABLE_FTS3_TOKENIZER=1": Applications such as SeaMonkey require these options to be turned on. The only way to do this is to include them in the CFLAGS or CPPFLAGS. We use the latter so the default value (or any value set by the user) of CFLAGS won't be affected. For further information on what can be specified see https://www.sqlite.org/compile.html.

Contents

Installed Program: sqlite3
Installed Library: libsqlite3.so
Installed Directory: /usr/share/doc/sqlite-3.42.0

Short Descriptions

sqlite3

is a terminal-based front-end to the SQLite library that can evaluate queries interactively and display the results

libsqlite3.so

contains the SQLite API functions

Chapter 23. Other Server Software

Here you will find many ways to share your machine with the rest of the world or your local network. Before installing any packages in this chapter, you need to be sure you understand what the package does and how to set it up correctly. It might also be helpful to learn about the consequences of an improper setup so that you can analyze the risks.

OpenLDAP-2.6.6

Introduction to OpenLDAP

The OpenLDAP package provides an open source implementation of the Lightweight Directory Access Protocol.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

OpenLDAP Dependencies

Recommended
Optional

GnuTLS-3.8.1, Pth-2.0.7, unixODBC-2.3.12, MariaDB-10.11.4 or PostgreSQL-15.4 or MySQL, OpenSLP, WiredTiger, and Berkeley DB-5.3.28 (for slapd, but deprecated)

Installation of OpenLDAP

Note

If you only need to install the client side ldap* binaries, corresponding man pages, libraries and header files (referred to as a client-only install), issue these commands instead of the following ones (no test suite available):

patch -Np1 -i ../openldap-2.6.6-consolidated-1.patch &&
autoconf &&

./configure --prefix=/usr     \
            --sysconfdir=/etc \
            --disable-static  \
            --enable-dynamic  \
            --enable-versioning=yes  \
            --disable-debug   \
            --disable-slapd &&

make depend &&
make

Then, as the root user:

make install

There should be a dedicated user and group to take control of the slapd daemon after it is started. Issue the following commands as the root user:

groupadd -g 83 ldap &&
useradd  -c "OpenLDAP Daemon Owner" \
         -d /var/lib/openldap -u 83 \
         -g ldap -s /bin/false ldap

Install OpenLDAP by running the following commands:

patch -Np1 -i ../openldap-2.6.6-consolidated-1.patch &&
autoconf &&

./configure --prefix=/usr         \
            --sysconfdir=/etc     \
            --localstatedir=/var  \
            --libexecdir=/usr/lib \
            --disable-static      \
            --enable-versioning=yes \
            --disable-debug       \
            --with-tls=openssl    \
            --with-cyrus-sasl     \
            --without-systemd     \
            --enable-dynamic      \
            --enable-crypt        \
            --enable-spasswd      \
            --enable-slapd        \
            --enable-modules      \
            --enable-rlookups     \
            --enable-backends=mod \
            --disable-sql         \
            --disable-wt          \
            --enable-overlays=mod &&

make depend &&
make

The tests are fragile, and errors may cause the tests to abort prior to finishing. Some errors may happen due to timing problems. The tests take around an hour, and the time is CPU independent due to delays in the tests. On most systems, the tests will run up to the test065-proxyauth for mdb test. To test the results, issue: make test.

Now, as the root user:

make install &&

sed -e "s/\.la/.so/" -i /etc/openldap/slapd.{conf,ldif}{,.default} &&

install -v -dm700 -o ldap -g ldap /var/lib/openldap     &&

install -v -dm700 -o ldap -g ldap /etc/openldap/slapd.d &&
chmod   -v    640     /etc/openldap/slapd.{conf,ldif}   &&
chown   -v  root:ldap /etc/openldap/slapd.{conf,ldif}   &&

install -v -dm755 /usr/share/doc/openldap-2.6.6 &&
cp      -vfr      doc/{drafts,rfc,guide} \
                  /usr/share/doc/openldap-2.6.6

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--disable-debug: This switch disables the debugging code in OpenLDAP.

--enable-dynamic: This switch forces the OpenLDAP libraries to be dynamically linked to the executable programs.

--enable-versioning: This switch enables symbol versioning in the OpenLDAP libraries. Without this, some applications might generate a warning about missing symbol versions.

--enable-crypt: This switch enables using crypt(3) passwords.

--enable-spasswd: This switch enables SASL password verification.

--enable-modules: This switch enables dynamic module support.

--enable-rlookups: This switch enables reverse lookups of client hostnames.

--enable-backends: This switch enables all available backends.

--enable-overlays: This switch enables all available overlays.

--disable-sql: This switch explicitly disables the SQL backend. Omit this switch if a SQL server is installed and you are going to use a SQL backend.

--disable-wt: This switch explicitly disables the WiredTiger backend. Omit this switch if WiredTiger is installed and you are going to use a WiredTiger backend.

--libexecdir=/usr/lib: This switch controls where the /usr/lib/openldap directory is installed. Everything in that directory is a library, so it belongs under /usr/lib instead of /usr/libexec.

--enable-slp: This switch enables SLPv2 support. Use it if you have installed OpenSLP.

Note

You can run ./configure --help to see if there are other switch you can pass to the configure command to enable other options or dependency packages.

install ..., chown ..., and chmod ...: Having slapd configuration files and ldap databases in /var/lib/openldap readable by anyone is a SECURITY ISSUE, especially since a file stores the admin password in PLAIN TEXT. That's why mode 640 and root:ldap ownership were used. The owner is root, so only root can modify the file, and group is ldap, so that the group which owns slapd daemon could read but not modify the file in case of a security breach.

Configuring OpenLDAP

Config Files

  • For LDAP client: /etc/openldap/ldap.conf and ~/.ldaprc

  • For LDAP server, two configuration mechanisms are used: a legacy /etc/openldap/slapd.conf configuration file and the recommended slapd-config system, using an LDIF database stored in /etc/openldap/slapd.d.

Configuration Information

Configuring the slapd servers can be complex. Securing the LDAP directory, especially if you are storing non-public data such as password databases, can also be a challenging task. In order to set up OpenLDAP, you'll need to modify either the /etc/openldap/slapd.conf file (old method), or the /etc/openldap/slapd.ldif file and then use ldapadd to create the LDAP configuration database in /etc/openldap/slapd.d (recommended by the OpenLDAP documentation).

Warning

The instructions above install an empty LDAP structure and a default /etc/openldap/slapd.conf file, which are suitable for testing the build and other packages using LDAP. Do not use them on a production server.

Resources to assist you with topics such as choosing a directory configuration, backend and database definitions, access control settings, running as a user other than root and setting a chroot environment include:

Systemd Unit

To automate the startup of the LDAP server at system bootup, install the slapd.service unit included in the blfs-systemd-units-20230816 package using the following command:

make install-slapd

Note

You'll need to modify /etc/default/slapd to include the parameters needed for your specific configuration. See the slapd man page for parameter information.

Testing the Configuration

Start the LDAP server using systemctl:

systemctl start slapd

Verify access to the LDAP server with the following command:

ldapsearch -x -b '' -s base '(objectclass=*)' namingContexts

The expected result is:

# extended LDIF
#
# LDAPv3
# base <> with scope baseObject
# filter: (objectclass=*)
# requesting: namingContexts
#

#
dn:
namingContexts: dc=my-domain,dc=com

# search result
search: 2
result: 0 Success

# numResponses: 2
# numEntries: 1

Contents

Installed Programs: ldapadd, ldapcompare, ldapdelete, ldapexop, ldapmodify, ldapmodrdn, ldappasswd, ldapsearch, ldapurl, ldapvc, ldapwhoami, slapacl, slapadd, slapauth, slapcat, slapd, slapdn, slapindex, slapmodify, slappasswd, slapschema, and slaptest
Installed Libraries: liblber.so, libldap.so, and several under /usr/lib/openldap
Installed Directories: /etc/openldap, /{usr,var}/lib/openldap, and /usr/share/doc/openldap-2.6.6

Short Descriptions

ldapadd

opens a connection to an LDAP server, binds and adds entries

ldapcompare

opens a connection to an LDAP server, binds and performs a compare using specified parameters

ldapdelete

opens a connection to an LDAP server, binds and deletes one or more entries

ldapexop

issues the LDAP extended operation specified by oid or one of the special keywords whoami, cancel, or refresh

ldapmodify

opens a connection to an LDAP server, binds and modifies entries

ldapmodrdn

opens a connection to an LDAP server, binds and modifies the RDN of entries

ldappasswd

is a tool used to set the password of an LDAP user

ldapsearch

opens a connection to an LDAP server, binds and performs a search using specified parameters

ldapurl

is a command that allows to either compose or decompose LDAP URIs

ldapvc

verifies LDAP credentials

ldapwhoami

opens a connection to an LDAP server, binds and displays whoami information

slapacl

is used to check the behavior of slapd by verifying access to directory data according to the access control list directives defined in its configuration

slapadd

is used to add entries specified in LDAP Directory Interchange Format (LDIF) to an LDAP database

slapauth

is used to check the behavior of the slapd in mapping identities for authentication and authorization purposes, as specified in slapd.conf

slapcat

is used to generate an LDAP LDIF output based upon the contents of a slapd database

slapd

is the standalone LDAP server

slapdn

checks a list of string-represented DNs based on schema syntax

slapindex

is used to regenerate slapd indexes based upon the current contents of a database

slapmodify

modifies entries in a slapd database

slappasswd

is an OpenLDAP password utility

slapschema

is used to check schema compliance of the contents of a slapd database

slaptest

checks the sanity of the slapd.conf file

liblber.so

is a set of Lightweight Basic Encoding Rules routines. These routines are used by the LDAP library routines to encode and decode LDAP protocol elements using the (slightly simplified) Basic Encoding Rules defined by LDAP. They are not normally used directly by an LDAP application program except in the handling of controls and extended operations

libldap.so

supports the LDAP programs and provide functionality for other programs interacting with LDAP

Unbound-1.17.1

Introduction to Unbound

Unbound is a validating, recursive, and caching DNS resolver. It is designed as a set of modular components that incorporate modern features, such as enhanced security (DNSSEC) validation, Internet Protocol Version 6 (IPv6), and a client resolver library API as an integral part of the architecture.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://nlnetlabs.nl/downloads/unbound/unbound-1.17.1.tar.gz

  • Download MD5 sum: bb96df2dc579c11ada537dbc52781abc

  • Download size: 6.0 MB

  • Estimated disk space required: 141 MB (with docs; add 10 MB for tests)

  • Estimated build time: 0.5 SBU (Using parallelism=4; with docs; add 0.4 SBU for tests)

Unbound Dependencies

Optional

libevent-2.1.12, Nettle-3.9.1, Python-2.7.18, sphinx-7.1.2 (for Python bindings documentation), SWIG-4.1.1 (for Python bindings), Doxygen-1.9.7 (for html documentation), and dnstap

Installation of Unbound

There should be a dedicated user and group to take control of the unbound daemon after it is started. Issue the following commands as the root user:

groupadd -g 88 unbound &&
useradd -c "Unbound DNS Resolver" -d /var/lib/unbound -u 88 \
        -g unbound -s /bin/false unbound

Install Unbound by running the following commands:

./configure --prefix=/usr     \
            --sysconfdir=/etc \
            --disable-static  \
            --with-pidfile=/run/unbound.pid &&
make

If you have Doxygen-1.9.7 package installed and want to build html documentation, run the following command:

make doc

To test the results, issue make check.

Now, as the root user:

make install &&
mv -v /usr/sbin/unbound-host /usr/bin/

If you built the documentation, install it by running the following commands as the root user:

install -v -m755 -d /usr/share/doc/unbound-1.17.1 &&
install -v -m644 doc/html/* /usr/share/doc/unbound-1.17.1

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--with-libevent: This option enables libevent support allowing use of large outgoing port ranges.

--with-pyunbound: This option enables building of the Python bindings.

Configuring Unbound

Config Files

/etc/unbound/unbound.conf

Configuration Information

In the default configuration, unbound will bind to localhost (127.0.0.1 IP address) and allow recursive queries only from localhost clients. If you want to use unbound for local DNS resolution, run the following command as the root user:

echo "nameserver 127.0.0.1" > /etc/resolv.conf

For advanced configuration see /etc/unbound/unbound.conf file and the documentation.

When Unbound is installed, some package builds fail if the file /etc/unbound/root.key is not found. Create this file by running the following command as the root user:

unbound-anchor

Systemd Unit

If you want the Unbound server to start automatically when the system is booted, install the unbound.service unit included in the blfs-systemd-units-20230816 package:

make install-unbound

Contents

Installed Programs: unbound, unbound-anchor, unbound-checkconf, unbound-control, unbound-control-setup, and unbound-host
Installed Library: libunbound.so and (optional) /usr/lib/python2.7/site-packages/_unbound.so
Installed Directories: /etc/unbound and /usr/share/doc/unbound-1.17.1 (optional)

Short Descriptions

unbound

is a DNS resolver daemon

unbound-anchor

performs setup or update of the root trust anchor for DNSSEC validation

unbound-checkconf

checks the unbound configuration file for syntax and other errors

unbound-control

performs remote administration on the unbound DNS resolver

unbound-control-setup

generates a self-signed certificate and private keys for the server and client

unbound-host

is a DNS lookup utility similar to host from BIND Utilities-9.18.18

libunbound.so

provides the Unbound API functions to programs

Part VI. Graphical Components

Chapter 24. Graphical Environments

This chapter contains instructions to build and configure a graphical user environment.

For a long time the only graphical environment usable with GNU/Linux has been the X Window System. It uses a client/server model which allows writing applications completely independent of the graphical hardware. This has the drawback that accessing modern hardware acceleration is difficult, so another approach named Wayland is developed. It is a simpler replacement for X, easier to develop and maintain, using the OpenGL framework. The main desktop environments GNOME and KDE have been ported to it.

This chapter provides the basic components of the X Window System and Wayland. For X, the chosen implementation is Xorg, which is a modular implementation and requires more than 100 packages to be installed. The distribution of Xorg is given a release number by the developers, in this case Xorg-7. Individual packages are updated as needed without changing this number.

Introduction to Xorg-7

Xorg is a freely redistributable, open-source implementation of the X Window System. This system provides a client/server interface between display hardware (the mouse, keyboard, and video displays) and the desktop environment, while also providing both the windowing infrastructure and a standardized application interface (API).

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/Xorg7

Xorg Download and Installation Instructions

Xorg-7.0 introduced a completely auto-tooled, modular build system. With the new modular build system, it is no longer possible to download the entire package in a single file. In fact, there will be well over 100 packages that need to be fetched from the download location. To assist with such a large task, installing Wget-1.21.4 is strongly recommended for downloading the needed files. A complete wget file list is provided for each page that includes multiple packages.

Given the number of packages available, deciding which packages you need to install for your particular setup may seem a bit overwhelming at first. Take a look at this page and this thread to get an idea of what you will need. If you are unsure, you should install all packages at the cost of extra disk space.

Note

Even if you intend to download only the necessary packages, you should download the wget file lists. The list of files are ordered by dependency, and the package versions listed in the files are known to work well with each other. Further, the wget file lists contain comments for specific packages that are deprecated or are not recommended to install. Newer packages are likely intended for the next release of Xorg and have already proved to be incompatible with current versions of software installed in BLFS. The installed size of Xorg can be reduced considerably by installing only the packages that you will need and use, however, the BLFS book cannot account for all dependencies and build options for the individual Xorg packages. The instructions assume that all packages have been built. A wiki page containing dependency information is under development. You are encouraged to add to these pages if you discover additional information that may be helpful to other users who selectively install individual packages.

Additionally, because of the large number of repetitive commands, you are encouraged to partially automate the build. Instructions have been given that utilize the Sudo-1.9.14p3 package. It is recommended that you use the :NOPASSWD configuration option for the user that will be building the xorg packages.

Setting up the Xorg Build Environment

Note

The following instructions assume that the shell startup files have been set up as described in The Bash Shell Startup Files.

As with previous releases of the X Window System, it may be desirable to install Xorg into an alternate prefix. This is no longer common practice among Linux distributions. The common installation prefix for Xorg on Linux is /usr. There is no standard alternate prefix, nor is there any exception in the current revision of the Filesystem Hierarchy Standard for Release 7 of the X Window System. Alan Coopersmith of Sun Microsystems, once stated "At Sun, we were using /usr/X11 and plan to stick with it." Only the /opt/* prefix or the /usr prefix adhere to the current FHS guidelines.

The BLFS editors recommend using the /usr prefix.

Choose your installation prefix, and set the XORG_PREFIX variable with the following command:

export XORG_PREFIX="<PREFIX>"

Throughout these instructions, you will use the following configure switches for all of the packages. Create the XORG_CONFIG variable to use for this parameter substitution:

export XORG_CONFIG="--prefix=$XORG_PREFIX --sysconfdir=/etc \
    --localstatedir=/var --disable-static"

Create an /etc/profile.d/xorg.sh configuration file containing these variables as the root user:

cat > /etc/profile.d/xorg.sh << EOF
XORG_PREFIX="$XORG_PREFIX"
XORG_CONFIG="--prefix=\$XORG_PREFIX --sysconfdir=/etc --localstatedir=/var --disable-static"
export XORG_PREFIX XORG_CONFIG
EOF
chmod 644 /etc/profile.d/xorg.sh

Note

There is some confusion about the above 'here' document. The backslash in front of the dollar sign is correct. Bash will remove it when creating /etc/profile.d/xorg.sh. However, if you are creating the file with an editor, a copy and paste operation will not remove the backslash. It must then be removed manually.

If you've installed Sudo-1.9.14p3, ensure that XORG_PREFIX and XORG_CONFIG are available in the sudo environment. As the root user, run the following command:

cat > /etc/sudoers.d/xorg << EOF
Defaults env_keep += XORG_PREFIX
Defaults env_keep += XORG_CONFIG
EOF

If you are not using the standard Xorg prefix...

Warning

If you've decided to use the standard /usr prefix, you must omit the remainder of this page and continue at util-macros-1.20.0.

If you've decided to not use the standard prefix, be sure to add $XORG_PREFIX/bin to your PATH environment variable, and $XORG_PREFIX/lib/pkgconfig and $XORG_PREFIX/share/pkgconfig to your PKG_CONFIG_PATH variable. It is also helpful to specify additional search paths for gcc and an include directory for the aclocal program. Issue the following commands as the root user:

cat >> /etc/profile.d/xorg.sh << "EOF"

pathappend $XORG_PREFIX/bin             PATH
pathappend $XORG_PREFIX/lib/pkgconfig   PKG_CONFIG_PATH
pathappend $XORG_PREFIX/share/pkgconfig PKG_CONFIG_PATH

pathappend $XORG_PREFIX/lib             LIBRARY_PATH
pathappend $XORG_PREFIX/include         C_INCLUDE_PATH
pathappend $XORG_PREFIX/include         CPLUS_INCLUDE_PATH

ACLOCAL="aclocal -I $XORG_PREFIX/share/aclocal"

export PATH PKG_CONFIG_PATH ACLOCAL LIBRARY_PATH C_INCLUDE_PATH CPLUS_INCLUDE_PATH
EOF

The script above needs to be activated. Normally it will be automatic at login, but to activate it now, as a regular user, run:

source /etc/profile.d/xorg.sh

You should also add $XORG_PREFIX/lib to the /etc/ld.so.conf file. Again, as the root user, issue the following command:

echo "$XORG_PREFIX/lib" >> /etc/ld.so.conf

You should also modify /etc/man_db.conf, adding appropriate MANDATORY_MANPATH, MANPATH_MAP, and MANDB_MAP entries following the examples for /usr/X11R6. Issue the following command as the root user:

sed -e "s@X11R6/man@X11R6/share/man@g" \
    -e "s@/usr/X11R6@$XORG_PREFIX@g"   \
    -i /etc/man_db.conf

Some applications look for shared files in /usr/share/X11. Create a symbolic link to the proper location as the root user:

ln -svf $XORG_PREFIX/share/X11 /usr/share/X11

If building KDE, some cmake files look for Xorg in places other than $XORG_PREFIX. Allow cmake to find Xorg with:

ln -svf $XORG_PREFIX /usr/X11R6

util-macros-1.20.0

Introduction to util-macros

The util-macros package contains the m4 macros used by all of the Xorg packages.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

util-macros Dependencies

Required

Xorg build environment (should be set for the following instructions to work)

Installation of util-macros

Install util-macros by running the following commands:

./configure $XORG_CONFIG

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: None
Installed Directory: $XORG_PREFIX/share/pkgconfig and $XORG_PREFIX/share/util-macros

xorgproto-2023.2

Introduction to xorgproto

The xorgproto package provides the header files required to build the X Window system, and to allow other applications to build against the installed X Window system.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

xorgproto Dependencies

Required

util-macros-1.20.0

Optional

fop-2.9, libxslt-1.1.38, xmlto-0.0.28 and asciidoc-10.2.0 (to build additional documentation)

Note

There is a reciprocal dependency with fop-2.9. If you wish to build the documentation, you'll need to re-install the Protocol Headers after the installation is complete and fop-2.9 has been installed.

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/Xorg7ProtocolHeaders

Installation of xorgproto

Install xorgproto by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=$XORG_PREFIX .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install &&
mv -v $XORG_PREFIX/share/doc/xorgproto{,-2023.2}

Command Explanations

-Dlegacy=true: Installs legacy headers needed by old programs (such as LessTif).

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: $XORG_PREFIX/include/GL, $XORG_PREFIX/include/X11, and $XORG_PREFIX/share/doc/xorgproto-2023.2

libXau-1.0.11

Introduction to libXau

The libXau package contains a library implementing the X11 Authorization Protocol. This is useful for restricting client access to the display.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libXau Dependencies

Required

xorgproto-2023.2

Installation of libXau

Install libXau by running the following commands:

./configure $XORG_CONFIG &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Library: libXau.so
Installed Directories: None

Short Descriptions

libXau.so

is the library of X authority database routines

libXdmcp-1.1.4

Introduction to libXdmcp

The libXdmcp package contains a library implementing the X Display Manager Control Protocol. This is useful for allowing clients to interact with the X Display Manager.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libXdmcp Dependencies

Required

xorgproto-2023.2

Optional

xmlto-0.0.28, fop-2.9, libxslt-1.1.38, and Xorg-SGML-doctools (for documentation)

Installation of libXdmcp

Install libXdmcp by running the following commands:

./configure $XORG_CONFIG --docdir=/usr/share/doc/libXdmcp-1.1.4 &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Library: libXdmcp.so
Installed Directory: $XORG_PREFIX/share/doc/libXdmcp-1.1.4

Short Descriptions

libXdmcp.so

is the X Display Manager Control Protocol library

xcb-proto-1.16.0

Introduction to xcb-proto

The xcb-proto package provides the XML-XCB protocol descriptions that libxcb uses to generate the majority of its code and API.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

xcb-proto Dependencies

Recommended
Optional

libxml2-2.10.4 (required to run the tests)

Installation of xcb-proto

Install xcb-proto by running the following commands:

PYTHON=python3 ./configure $XORG_CONFIG

To test the results, issue: make check.

Now, as the root user:

make install

If you are upgrading from version 1.15.1 or lower, the old pkgconfig file needs to be removed. Issue, as the root user:

rm -f $XORG_PREFIX/lib/pkgconfig/xcb-proto.pc

Contents

Installed Programs: None
Installed Libraries: None
Installed Directory: $XORG_PREFIX/share/xcb and $XORG_PREFIX/lib/python3.11/site-packages/xcbgen

libxcb-1.16

Introduction to libxcb

The libxcb package provides an interface to the X Window System protocol, which replaces the current Xlib interface. Xlib can also use XCB as a transport layer, allowing software to make requests and receive responses with both.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libxcb Dependencies

Required

libXau-1.0.11 and xcb-proto-1.16.0

Recommended
Optional

Doxygen-1.9.7 (to generate API documentation) and libxslt-1.1.38

Installation of libxcb

Install libxcb by running the following commands:

./configure $XORG_CONFIG      \
            --without-doxygen \
            --docdir='${datadir}'/doc/libxcb-1.16 &&
make

To test the results, issue: make check.

Now, as the root user:

make install

If the package was built as a non-root user, the installed documentation is now owned by this user. As the root user, fix the ownership:

chown -Rv root:root $XORG_PREFIX/share/doc/libxcb-1.16

Command Explanations

--without-doxygen: Do not use doxygen to generate API documentation (default: auto). Without it, if Doxygen-1.9.7 is installed, the API documentation will be generated and installed.

Contents

Installed Programs: None
Installed Libraries: libxcb.so, libxcb-composite.so, libxcb-damage.so, libxcb-dpms.so, libxcb-dri2.so, libxcb-dri3.so, libxcb-glx.so, libxcb-present.so, libxcb-randr.so, libxcb-record.so, libxcb-render.so, libxcb-res.so, libxcb-screensaver.so, libxcb-shape.so, libxcb-shm.so, libxcb-sync.so, libxcb-xf86dri.so, libxcb-xfixes.so, libxcb-xinerama.so, libxcb-xinput.so, libxcb-xkb.so, libxcb-xtest.so, libxcb-xvmc.so, and libxcb-xv.so
Installed Directories: $XORG_PREFIX/include/xcb and $XORG_PREFIX/share/doc/libxcb-1.16

Short Descriptions

libxcb.so

is an interface to the X Window System protocol

Xorg Libraries

Introduction to Xorg Libraries

The Xorg libraries provide library routines that are used within all X Window applications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Xorg Libraries Dependencies

Required

Fontconfig-2.14.2 and libxcb-1.16

Optional

asciidoc-10.2.0, xmlto-0.0.28 with one or more of the following: fop-2.9, Links-2.29, Lynx-2.8.9rel.1, ncompress (for some tests), and W3m (to generate additional PDF or text documentation for the libXfont package).

Recommended at runtime

Downloading Xorg Libraries

First, create a list of files to be downloaded. This file will also be used to verify the integrity of the downloads when complete:

cat > lib-7.md5 << "EOF"
12344cd74a1eb25436ca6e6a2cf93097  xtrans-1.5.0.tar.xz
91752155473ef72a8b34523a65967e4d  libX11-1.8.6.tar.xz
964942427fcc5a9fa0539661421857c8  libXext-1.3.5.tar.xz
742863a552ecd53cdb957b7b276213cc  libFS-1.0.9.tar.xz
b444a0e4c2163d1bbc7b046c3653eb8d  libICE-1.1.1.tar.xz
ffa434ed96ccae45533b3d653300730e  libSM-1.2.4.tar.xz
e613751d38e13aa0d0fd8e0149cec057  libXScrnSaver-1.2.4.tar.xz
4ea21d3b5a36d93a2177d9abed2e54d4  libXt-1.3.0.tar.xz
ed52d396115fbc4d05300762aab79685  libXmu-1.1.4.tar.xz
5073cf59174a2cadde220187759b2e7c  libXpm-3.5.16.tar.xz
3f1e1052dbf3a2b8582ec24137e1fbd1  libXaw-1.0.15.tar.xz
65b9ba1e9ff3d16c4fa72915d4bb585a  libXfixes-6.0.1.tar.xz
af0a5f0abb5b55f8411cd738cf0e5259  libXcomposite-0.4.6.tar.xz
ebf7fb3241ec03e8a3b2af72f03b4631  libXrender-0.9.11.tar.xz
4cdd1886fe5cce6f68554296edb46db8  libXcursor-1.2.1.tar.xz
ca55d29fa0a8b5c4a89f609a7952ebf8  libXdamage-1.1.6.tar.xz
6d3f1b15bb5b0bb71ae9f0a5103c1fc4  libfontenc-1.1.7.tar.xz
c179daa707f5f432f1bc13977e5bb329  libXfont2-2.0.6.tar.xz
cea0a3304e47a841c90fbeeeb55329ee  libXft-2.3.8.tar.xz
89ac74ad6829c08d5c8ae8f48d363b06  libXi-1.8.1.tar.xz
228c877558c265d2f63c56a03f7d3f21  libXinerama-1.1.5.tar.xz
850cbc7c921c9d5d0135734b114ff6ac  libXrandr-1.5.3.tar.xz
66c9e9e01b0b53052bb1d02ebf8d7040  libXres-1.2.2.tar.xz
02f128fbf809aa9c50d6e54c8e57cb2e  libXtst-1.2.4.tar.xz
70bfdd14ca1a563c218794413f0c1f42  libXv-1.0.12.tar.xz
11a358e7229fa28dc9801c1e64fe2e18  libXvMC-1.0.13.tar.xz
74d1acf93b83abeb0954824da0ec400b  libXxf86dga-1.1.6.tar.xz
5b913dac587f2de17a02e17f9a44a75f  libXxf86vm-1.1.5.tar.xz
1466cf950c914ad2db1dbb76c9a724db  libpciaccess-0.17.tar.xz
8af2275955d40166bb647b14e4896ab1  libxkbfile-1.1.2.tar.xz
faa74f7483074ce7d4349e6bdc237497  libxshmfence-1.3.2.tar.xz
EOF

To download the needed files using Wget-1.21.4, use the following commands:

mkdir lib &&
cd lib &&
grep -v '^#' ../lib-7.md5 | awk '{print $2}' | wget -i- -c \
    -B https://www.x.org/pub/individual/lib/ &&
md5sum -c ../lib-7.md5

Installation of Xorg Libraries

Note

When installing multiple packages in a script, the installation needs to be done as the root user. There are three general options that can be used to do this:

  1. Run the entire script as the root user (not recommended).

  2. Use the sudo command from the Sudo-1.9.14p3 package.

  3. Use su -c "command arguments" (quotes required) which will ask for the root password for every iteration of the loop.

One way to handle this situation is to create a short bash function that automatically selects the appropriate method. Once the command is set in the environment, it does not need to be set again.

as_root()
{
  if   [ $EUID = 0 ];        then $*
  elif [ -x /usr/bin/sudo ]; then sudo $*
  else                            su -c \\"$*\\"
  fi
}

export -f as_root

Some libraries come with a test suite. If you wish to execute them, either comment out the rm -rf ... below, so that, after all libraries are installed, you can come back to the corresponding directory and run make check, or do individual builds, running the tests for each of those distributed with working test suites. Alternatively, you can uncomment the line #make check ..., and at the end, check the test results with:

grep -A9 summary *make_check.log

BLFS developers have confirmed that libX11, libXt, libXmu, libXpm, and libxshmfence are distributed with working test suites.

First, start a subshell that will exit on error:

bash -e

Install all of the packages by running the following commands:

for package in $(grep -v '^#' ../lib-7.md5 | awk '{print $2}')
do
  packagedir=${package%.tar.?z*}
  tar -xf $package
  pushd $packagedir
  docdir="--docdir=$XORG_PREFIX/share/doc/$packagedir"
  case $packagedir in
    libXfont2-[0-9]* )
      ./configure $XORG_CONFIG $docdir --disable-devel-docs
    ;;

    libXt-[0-9]* )
      ./configure $XORG_CONFIG $docdir \
                  --with-appdefaultdir=/etc/X11/app-defaults
    ;;

    libXpm-[0-9]* )
      ./configure $XORG_CONFIG $docdir --disable-open-zfile
    ;;
    
    * )
      ./configure $XORG_CONFIG $docdir
    ;;
  esac

  make
  #make check 2>&1 | tee ../$packagedir-make_check.log
  as_root make install
  popd
  rm -rf $packagedir
  as_root /sbin/ldconfig
done

Finally, exit the shell that was started earlier:

exit

Command Explanations

--disable-open-zfile: Allow libXpm to build without the optional compress command present.

--disable-devel-docs: Disable generation of text documentation in the libXfont2 package if xmlto-0.0.28 is installed without a text browser. Omit this parameter (or the entire case statement) if a text browser is installed.

--with-fop: Use fop-2.9 to generate PDF documentation (only for the libXfont package).

Configuration of Xorg Libraries

If you've chosen to install Xorg into /usr, then no further configuration is necessary and you can skip the rest of this section. If you've opted for an alternate prefix, you should create two symlinks to satisfy the expected environment of several packages. Execute the following commands as the root user:

ln -sv $XORG_PREFIX/lib/X11 /usr/lib/X11 &&
ln -sv $XORG_PREFIX/include/X11 /usr/include/X11

Contents

Installed Programs: cxpm and sxpm
Installed Libraries: libfontenc.so, libFS.so, libICE.so, libpciaccess.so, libSM.so, libX11.so, libX11-xcb, libXaw6.so, libXaw7.so, libXaw.so, libXcomposite.so, libXcursor.so, libXdamage.so, libXext.so, libXfixes.so, libXfont2.so, libXft.so, libXinerama.so, libXi.so, libxkbfile.so, libXmu.so, libXmuu.so, libXpm.so, libXrandr.so, libXrender.so, libXRes.so, libxshmfence.so, libXss.so, libXt.so, libXtst.so, libXvMC.so, libXvMCW.so, libXv.so, libXxf86dga.so and libXxf86vm.so
Installed Directories: $XORG_PREFIX/include/X11/fonts, $XORG_PREFIX/include/X11/ICE, $XORG_PREFIX/include/X11/SM, $XORG_PREFIX/include/X11/Xmu, $XORG_PREFIX/include/X11/Xtrans, $XORG_PREFIX/share/doc/libFS, $XORG_PREFIX/share/doc/libICE-1.1.1, $XORG_PREFIX/share/doc/libSM-1.2.4, $XORG_PREFIX/share/doc/libX11-1.8.6, $XORG_PREFIX/share/doc/libXaw, $XORG_PREFIX/share/doc/libXext, $XORG_PREFIX/share/doc/libXi, $XORG_PREFIX/share/doc/libXmu-1.1.4, $XORG_PREFIX/share/doc/libXrender, $XORG_PREFIX/share/doc/libXt, $XORG_PREFIX/share/doc/libXtst, $XORG_PREFIX/share/doc/libXvMC, $XORG_PREFIX/share/doc/xtrans and $XORG_PREFIX/share/X11/locale

Short Descriptions

cxpm

checks the format of an XPM file

sxpm

shows an XPM file and/or converts XPM 1 or 2 files to XPM 3

libfontenc.so

is the X11 font encoding library

libFS.so

is the library interface to the X Font Server

libICE.so

is the X Inter Client Exchange Library

libpciaccess.so

is the generic PCI Access library for X

libSM.so

is the X Session Management Library

libX11.so

is the Xlib Library

libXaw6.so

is the X Athena Widgets Library, version 6

libXaw7.so

is the X Athena Widgets Library, version 7

libXaw.so

are symbolic links to the current X Athena Widgets Library, version 7

libXcomposite.so

is the X Composite Library

libXcursor.so

is the X Cursor management library

libXdamage.so

is the X Damage Library

libXext.so

is the Misc X Extension Library

libXfixes.so

provides augmented versions of core protocol requests

libXfont2.so

is the X font library

libXft.so

is the X FreeType interface library

libXinerama.so

is the Xinerama Library

libXi.so

is the X Input Extension Library

libxkbfile.so

is the xkbfile Library

libXmu.so

is the X interface library for miscellaneous utilities not part of the Xlib standard

libXmuu.so

is the Mini Xmu Library

libXpm.so

is the X Pixmap Library

libXrandr.so

is the X Resize, Rotate and Reflection extension library

libXrender.so

is the X Render Library

libXRes.so

is the X-Resource extension client library

libxshmfence.so

exposes an event API on top of Linux futexes

libXss.so

is the X11 Screen Saver extension client library

libXt.so

is the X Toolkit Library

libXtst.so

is the Xtst Library

libXvMC.so

is the X-Video Motion Compensation Library

libXvMCW.so

is the XvMC Wrapper including the Nonstandard VLD extension

libXv.so

is the X Window System video extension library

libXxf86dga.so

is the client library for the XFree86-DGA extension

libXxf86vm.so

is the client library for the XFree86-VidMode X extension

libxcvt-0.1.2

Introduction to libxcvt

libxcvt is a library providing a standalone version of the X server implementation of the VESA CVT standard timing modelines generator. It is meant to be a direct replacement to the version formerly provided by the Xorg server.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libxcvt Dependencies

Required

Xorg build environment (should be set for the following instructions to work)

Installation of libxcvt

Install libxcvt by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=$XORG_PREFIX --buildtype=release .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Program: cvt
Installed Library: libxcvt.so
Installed Directory: $XORG_PREFIX/include/libxcvt

Short Descriptions

cvt

calculates VESA Coordinated Video Timing (CVT) modelines for use with X

libxcvt.so

contains functions for calculating VESA CVT

xcb-util-0.4.1

Introduction to xcb-util

The xcb-util package provides additional extensions to the XCB library, many that were previously found in Xlib, but are not part of core X protocol.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

xcb-util Dependencies

Required

libxcb-1.16

Optional

Doxygen-1.9.7 (for documentation)

Installation of xcb-util

Install xcb-util by running the following commands:

./configure $XORG_CONFIG &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Library: libxcb-util.so
Installed Directories: None

Short Descriptions

libxcb-util.so

Provides utility functions for other XCB utilities

xcb-util-image-0.4.1

Introduction to xcb-util-image

The xcb-util-image package provides additional extensions to the XCB library.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

xcb-util-image Dependencies

Required

xcb-util-0.4.1

Optional

Doxygen-1.9.7 (for documentation)

Installation of xcb-util-image

Install xcb-util-image by running the following commands:

./configure $XORG_CONFIG &&
make

To test the results, issue: LD_LIBRARY_PATH=$XORG_PREFIX/lib make check.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Library: libxcb-image.so
Installed Directories: None

Short Descriptions

libxcb-image.so

Is a port of Xlib's XImage and XShmImage functions

xcb-util-keysyms-0.4.1

Introduction to xcb-util-keysyms

The xcb-util-keysyms package contains a library for handling standard X key constants and conversion to/from keycodes.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

xcb-util-keysyms Dependencies

Required

libxcb-1.16

Optional

Doxygen-1.9.7 (to generate documentation)

Installation of xcb-util-keysyms

Install xcb-util-keysyms by running the following commands:

./configure $XORG_CONFIG &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Library: libxcb-keysyms.so
Installed Directories: None

Short Descriptions

libxcb-keysyms.so

provides the standard X key constants and API functions for conversion to/from keycodes

xcb-util-renderutil-0.3.10

Introduction to xcb-util-renderutil

The xcb-util-renderutil package provides additional extensions to the XCB library.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

xcb-util-renderutil Dependencies

Required

libxcb-1.16

Optional

Doxygen-1.9.7 (for documentation)

Installation of xcb-util-renderutil

Install xcb-util-renderutil by running the following commands:

./configure $XORG_CONFIG &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Library: libxcb-render-util.so
Installed Directories: None

Short Descriptions

libxcb-render-util.so

Provides convenience functions for the Render extension

xcb-util-wm-0.4.2

Introduction to xcb-util-wm

The xcb-util-wm package contains libraries which provide client and window-manager helpers for EWMH and ICCCM.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

xcb-util-wm Dependencies

Required

libxcb-1.16

Optional

Doxygen-1.9.7 (for documentation)

Installation of xcb-util-wm

Install xcb-util-wm by running the following commands:

./configure $XORG_CONFIG &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: libxcb-ewmh.so and libxcb-icccm.so
Installed Directories: None

Short Descriptions

libxcb-ewmh.so

provides the client and window-manager helpers for EWMH

libxcb-icccm.so

provides the client and window-manager helpers for ICCCM

xcb-util-cursor-0.1.4

Introduction to xcb-util-cursor

The xcb-util-cursor package provides a module that implements the XCB cursor library. It is the XCB replacement for libXcursor.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

xcb-util-cursor Dependencies

Required

xcb-util-image-0.4.1 and xcb-util-renderutil-0.3.10

Optional

Doxygen-1.9.7 (for documentation)

Installation of xcb-util-cursor

Install xcb-util-cursor by running the following commands:

./configure $XORG_CONFIG &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Library: libxcb-cursor.so
Installed Directories: None

Short Descriptions

libxcb-cursor.so

Is a port of Xlib's libXcursor functions

Mesa-23.1.6

Introduction to Mesa

Mesa is an OpenGL compatible 3D graphics library.

Note

Mesa is updated relatively often. You may want to use the latest available 23.1.x mesa version.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Mesa Dependencies

Required

Xorg Libraries, libdrm-2.4.115, and Mako-1.2.4

Recommended
Optional

libgcrypt-1.10.2, libunwind-1.6.2, lm-sensors-3-6-0 , Nettle-3.9.1, Valgrind-3.21.0, mesa-demos (provides more than 300 extra demos to test Mesa; this includes the same programs added by the patch above), Bellagio OpenMAX Integration Layer (for mobile platforms), glslang (for vulkan drivers), libtizonia, and Vulkan-Loader

Kernel Configuration

Enable the following options in the kernel configuration and recompile the kernel if necessary:

Device Drivers --->
  Graphics support --->
    <*/M>   Direct Rendering Manager (XFree86 4.1.0 and higher DRI support) --->
                                                                      ...  [DRM]
    # For r300 or r600:
    < /*/M> ATI Radeon                                              [DRM_RADEON]
    # For radeonsi:
    < /*/M> AMD GPU                                                 [DRM_AMDGPU]
    [*]       Enable amdgpu support for SI parts                 [DRM_AMDGPU_SI]
    [*]       Enable amdgpu support for CIK parts               [DRM_AMDGPU_CIK]
      Display Engine Configuration --->
      [*]   AMD DC - Enable new display engine                      [DRM_AMD_DC]
    # For nouveau:
    < /*/M> Nouveau (NVIDIA) cards                                 [DRM_NOUVEAU]
    # For i915, crocus, or iris:
    < /*/M> Intel 8xx/9xx/G3x/G4x/HD Graphics                         [DRM_I915]
    # For swrast:
    < /*/M> Virtual GEM provider                                      [DRM_VGEM]
    # For svga:
    < /*/M> DRM driver for VMware Virtual GPU                       [DRM_VMWGFX]

Note

The corresponding Mesa Gallium3D driver name is provided as the comment for the configuration entries. If you don't know the name of the Mesa Gallium3D driver for your GPU, see Mesa Gallium3D Drivers below.

CONFIG_DRM_RADEON, CONFIG_DRM_AMDGPU, CONFIG_DRM_NOUVEAU, and CONFIG_DRM_I915 may require firmware. See About Firmware for details.

Selecting CONFIG_DRM_RADEON or CONFIG_DRM_AMDGPU as y is not recommended. If it is, any required firmware must be built as a part of the kernel image or the initramfs for the driver to function correctly.

The sub-entries under CONFIG_DRM_AMDGPU are used to ensure the AMDGPU kernel driver supports all GPUs using the radeonsi driver. They are not needed if you won't need CONFIG_DRM_AMDGPU itself. They may be unneeded for some GPU models.

For swrast, CONFIG_DRM_VGEM is not strictly needed but recommended as an optimization.

Installation of Mesa

If you have downloaded the xdemos patch (needed if testing the Xorg installation per BLFS instructions), apply it by running the following command:

patch -Np1 -i ../mesa-add_xdemos-2.patch

Install Mesa by running the following commands:

mkdir build &&
cd    build &&

meson setup                   \
      --prefix=$XORG_PREFIX   \
      --buildtype=release     \
      -Dplatforms=x11,wayland \
      -Dgallium-drivers=auto  \
      -Dvulkan-drivers=""     \
      -Dvalgrind=disabled     \
      -Dlibunwind=disabled    \
      ..                      &&

ninja

To test the results, issue: meson configure -Dbuild-tests=true && ninja test. Three tests related to mesa:intel are known to fail.

Now, as the root user:

ninja install

If desired, install the optional documentation by running the following commands as the root user:

install -v -dm755 /usr/share/doc/mesa-23.1.6 &&
cp -rfv ../docs/* /usr/share/doc/mesa-23.1.6

Command Explanations

--buildtype=release: This switch ensures a fully-optimized build, and disables debug assertions which will severely slow down the libraries in certain use-cases. Without this switch, build sizes can span into the 2GB range.

-Dgallium-drivers=auto: This parameter controls which Gallium3D drivers should be built. auto selects all Gallium3D drivers available for x86: r300 (for ATI Radeon 9000 or Radeon X series), r600 (for AMD/ATI Radeon HD 2000-6000 series), radeonsi (for AMD Radeon HD 7000 or newer AMD GPU models), nouveau (for Supported NVIDIA GPUs, they are listed as all 3D features either DONE or N/A in the Nouveau status page), virgl (for QEMU virtual GPU with virglrender support; note that BLFS qemu-8.1.0 is not built with virglrender), svga (for VMWare virtual GPU), swrast (using CPU for 3D rasterisation; note that it's much slower than using a modern 3D-capable GPU, so it should be only used if the GPU is not supported by other drivers), iris (for Intel GPUs shipped with Broadwell or newer CPUs), crocus (for Intel GMA 3000, X3000 series, 4000 series, or X4000 series GPUs shipped with chipsets, or Intel HD GPUs shipped with pre-Broadwell CPUs), i915 (for Intel GMA 900, 950, 3100, or 3150 GPUs shipped with chipsets or Atom D/N 4xx/5xx CPUs). You may replace auto with a comma-separated list to build only a subset of these drivers if you precisely know which drivers you need, for example -Dgallium-drivers=radeonsi,iris,swrast.

-Dplatforms="...": This parameter controls which windowing systems will be supported. Available linux platforms are x11 and wayland.

-Dvulkan-drivers="": This switch allows choosing which Vulkan drivers are built. The default is auto, but this requires the optional dependencies glslang and Vulkan-Loader. Vulkan is a newer API designed for utilizing the GPUs with a performance better than OpenGL, but nothing in BLFS benefits from it for now. So we pass an empty list in order to remove the need for these dependencies.

-Dvalgrind=disabled: This parameter disables the usage of Valgrind during the build process. Remove this parameter if you have Valgrind installed, and wish to check for memory leaks.

-Dlibunwind=disabled: This parameter disables the usage of libunwind.

meson configure -Dbuild-tests=true: This command will reconfigure the build to set -Dbuild-tests=true, but keep the other options specified in the meson setup command unchanged. It allows ninja test to build and run unit tests.

-Degl-native-platform="...": This parameter controls which Embedded Graphics Library support will be built. Available linux options are auto (default), x11, wayland, surfaceless, and drm.

Contents

Installed Programs: glxgears and glxinfo
Installed Libraries: libEGL.so, libGL.so, libGLESv1_CM.so, libGLESv2.so, libgbm.so, libglapi.so, and libxatracker.so
Installed Drivers: crocus_dri.so, i915_dri.so, iris_dri.so, kms_swrast_dri.so, nouveau_dri.so, nouveau_drv_video.so, r300_dri.so, r600_dri.so, r600_drv_video.so, radeonsi_dri.so, radeonsi_drv_video.so, swrast_dri.so, virtio_gpu_dri.so, virtio_gpu_drv_video.so, vmwgfx_dri.so, libvdpau_nouveau.so, libvdpau_r300.so libvdpau_r600.so, and libvdpau_radeonsi.so libvdpau_virtio_gpu.so (Many of these drivers are hard-linked).
Installed Directories: $XORG_PREFIX/{include/{EGL,GLES,GLES2,GLES3,KHR}, $XORG_PREFIX/lib/{dri,vdpau}}, $XORG_PREFIX/share/drirc.d (contains workarounds for various applications, particularly browsers and games), and /usr/share/doc/mesa-23.1.6

Short Descriptions

glxgears

is a GL demo useful for troubleshooting graphics problems

glxinfo

is a diagnostic program that displays information about the graphics hardware and installed GL libraries

libEGL.so

provides a native platform graphics interface as defined by the EGL-1.4 specification

libgbm.so

is the Mesa Graphics Buffer Manager library

libGLESv1_CM.so

is the Mesa OpenGL ES 1.1 library

libGLES2.so

is the Mesa OpenGL ES 2.0 library

libGL.so

is the main Mesa OpenGL library

xbitmaps-1.1.3

Introduction to xbitmaps

The xbitmaps package contains bitmap images used by multiple applications built in Xorg chapter.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

xbitmaps Dependencies

Required

util-macros-1.20.0

Installation of xbitmaps

Install xbitmaps by running the following commands:

./configure $XORG_CONFIG

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: None
Installed Directory: $XORG_PREFIX/include/X11/bitmaps

Xorg Applications

Introduction to Xorg Applications

The Xorg applications provide the expected applications available in previous X Window implementations.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Xorg Applications Dependencies

Required

libpng-1.6.40, Mesa-23.1.6, xbitmaps-1.1.3, and xcb-util-0.4.1

Optional

Linux-PAM-1.5.3 and both cairo-5c and Nickle (only if you wish to try to run the undocumented xkeyhost script).

Downloading Xorg Applications

First, create a list of files to be downloaded. This file will also be used to verify the integrity of the downloads when complete:

cat > app-7.md5 << "EOF"
5d3feaa898875484b6b340b3888d49d8  iceauth-1.0.9.tar.xz
c4a3664e08e5a47c120ff9263ee2f20c  luit-1.1.1.tar.bz2
fd2e6e5a297ac2bf3d7d54799bf69de0  mkfontscale-1.2.2.tar.xz
05423bb42a006a6eb2c36ba10393de23  sessreg-1.1.3.tar.xz
1d61c9f4a3d1486eff575bf233e5776c  setxkbmap-1.3.4.tar.xz
9f7a4305f0e79d5a46c3c7d02df9437d  smproxy-1.0.7.tar.xz
e96b56756990c56c24d2d02c2964456b  x11perf-1.6.1.tar.bz2
dbcf944eb59343b84799b2cc70aace16  xauth-1.1.2.tar.xz
#5b6405973db69c0443be2fba8e1a8ab7  xbacklight-1.2.3.tar.bz2
82a90e2feaeab5c5e7610420930cc0f4  xcmsdb-1.0.6.tar.xz
89e81a1c31e4a1fbd0e431425cd733d7  xcursorgen-1.0.8.tar.xz
933e6d65f96c890f8e96a9f21094f0de  xdpyinfo-1.3.4.tar.xz
34aff1f93fa54d6a64cbe4fee079e077  xdriinfo-1.0.7.tar.xz
61219e492511b3d78375da76defbdc97  xev-1.2.5.tar.xz
41afaa5a68cdd0de7e7ece4805a37f11  xgamma-1.0.7.tar.xz
48ac13856838d34f2e7fca8cdc1f1699  xhost-1.0.9.tar.xz
8e4d14823b7cbefe1581c398c6ab0035  xinput-1.6.4.tar.xz
a11d4d6eeda762f13818684c0670f89f  xkbcomp-1.4.6.tar.xz
05ce1abd8533a400572784b1186a44d0  xkbevd-1.1.5.tar.xz
cf65ca1aaf4c28772ca7993cfd122563  xkbutils-1.0.5.tar.xz
f62b99839249ce9a7a8bb71a5bab6f9d  xkill-1.0.6.tar.xz
da5b7a39702841281e1d86b7349a03ba  xlsatoms-1.1.4.tar.xz
ab4b3c47e848ba8c3e47c021230ab23a  xlsclients-1.1.5.tar.xz
f33841b022db1648c891fdc094014aee  xmessage-1.0.6.tar.xz
0d66e07595ea083871048c4b805d8b13  xmodmap-1.0.11.tar.xz
9cf272cba661f7acc35015f2be8077db  xpr-1.1.0.tar.xz
33c090d8632a300e63efbf36edd6a333  xprop-1.2.6.tar.xz
f822a8d5f233e609d27cc22d42a177cb  xrandr-1.5.2.tar.xz
c8629d5a0bc878d10ac49e1b290bf453  xrdb-1.2.2.tar.xz
33b04489e417d73c90295bd2a0781cbb  xrefresh-1.0.7.tar.xz
18ff5cdff59015722431d568a5c0bad2  xset-1.2.5.tar.xz
fa9a24fe5b1725c52a4566a62dd0a50d  xsetroot-1.1.3.tar.xz
d698862e9cad153c5fefca6eee964685  xvinfo-1.1.5.tar.xz
b0081fb92ae56510958024242ed1bc23  xwd-1.0.9.tar.xz
c91201bc1eb5e7b38933be8d0f7f16a8  xwininfo-1.1.6.tar.xz
5ff5dc120e8e927dc3c331c7fee33fc3  xwud-1.0.6.tar.xz
EOF

To download the needed files using Wget-1.21.4, use the following commands:

mkdir app &&
cd app &&
grep -v '^#' ../app-7.md5 | awk '{print $2}' | wget -i- -c \
    -B https://www.x.org/pub/individual/app/ &&
md5sum -c ../app-7.md5

Installation of Xorg Applications

Note

When installing multiple packages in a script, the installation needs to be done as the root user. There are three general options that can be used to do this:

  1. Run the entire script as the root user (not recommended).

  2. Use the sudo command from the Sudo-1.9.14p3 package.

  3. Use su -c "command arguments" (quotes required) which will ask for the root password for every iteration of the loop.

One way to handle this situation is to create a short bash function that automatically selects the appropriate method. Once the command is set in the environment, it does not need to be set again.

as_root()
{
  if   [ $EUID = 0 ];        then $*
  elif [ -x /usr/bin/sudo ]; then sudo $*
  else                            su -c \\"$*\\"
  fi
}

export -f as_root

First, start a subshell that will exit on error:

bash -e

Install all of the packages by running the following commands:

for package in $(grep -v '^#' ../app-7.md5 | awk '{print $2}')
do
  packagedir=${package%.tar.?z*}
  tar -xf $package
  pushd $packagedir
     case $packagedir in
       luit-[0-9]* )
         sed -i -e "/D_XOPEN/s/5/6/" configure
       ;;
     esac

     ./configure $XORG_CONFIG
     make
     as_root make install
  popd
  rm -rf $packagedir
done

Finally, exit the shell that was started earlier:

exit

Unless you installed the optional dependencies, remove an undocumented script which is reported to be broken (xkeystone provided by the xrandr package).

as_root rm -f $XORG_PREFIX/bin/xkeystone

Contents

Installed Programs: iceauth, luit, mkfontdir, mkfontscale, sessreg, setxkbmap, smproxy, x11perf, x11perfcomp, xauth, xbacklight, xcmsdb, xcursorgen, xdpr, xdpyinfo, xdriinfo, xev, xgamma, xhost, xinput, xkbbell, xkbcomp, xkbevd, xkbvleds, xkbwatch, xkill, xlsatoms, xlsclients, xmessage, xmodmap, xpr, xprop, xrandr, xrdb, xrefresh, xset, xsetroot, xvinfo, xwd, xwininfo, and xwud
Installed Libraries: None
Installed Directories: None

Short Descriptions

iceauth

is the ICE authority file utility

luit

provides locale and ISO 2022 support for Unicode terminals

mkfontdir

creates an index of X font files in a directory

mkfontscale

creates an index of scalable font files for X

sessreg

manages utmp/wtmp entries for non-init clients

setxkbmap

sets the keyboard using the X Keyboard Extension

smproxy

is the Session Manager Proxy

x11perf

is an X11 server performance test program

x11perfcomp

is an X11 server performance comparison program

xauth

is the X authority file utility

xbacklight

adjusts backlight brightness using RandR extension

xcmsdb

is the Device Color Characterization utility for the X Color Management System

xcursorgen

creates an X cursor file from a collection of PNG images

xdpr

dumps an X window directly to a printer

xdpyinfo

is a display information utility for X

xdriinfo

queries configuration information of DRI drivers

xev

prints contents of X events

xgamma

alters a monitor's gamma correction through the X server

xhost

is a server access control program for X

xinput

is a utility to configure and test X input devices

xkbbell

is an XKB utility program that raises a bell event

xkbcomp

compiles an XKB keyboard description

xkbevd

is the XKB event daemon

xkbvleds

shows the XKB status of keyboard LEDs

xkbwatch

monitors modifier keys and LEDs

xkill

kills a client by its X resource

xlsatoms

lists interned atoms defined on the server

xlsclients

lists client applications running on a display

xmessage

displays a message or query in a window

xmodmap

is a utility for modifying keymaps and pointer button mappings in X

xpr

prints an X window dump

xprop

is a property displayer for X

xrandr

is a primitive command line interface to RandR extension

xrdb

is the X server resource database utility

xrefresh

refreshes all or part of an X screen

xset

is the user preference utility for X

xsetroot

is the root window parameter setting utility for X

xvinfo

prints out X-Video extension adaptor information

xwd

dumps an image of an X window

xwininfo

is a window information utility for X

xwud

is an image displayer for X

xcursor-themes-1.0.7

Introduction to xcursor-themes

The xcursor-themes package contains the redglass and whiteglass animated cursor themes.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

xcursor-themes Dependencies

Required

Xorg Applications

Installation of xcursor-themes

Note

We explicitly install the cursor themes in /usr instead of $XORG_PREFIX so non-Xorg desktop environments can find them.

Install xcursor-themes by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/share/icons/handhelds, /usr/share/icons/redglass, and /usr/share/icons/whiteglass

Xorg Fonts

Introduction to Xorg Fonts

The Xorg font packages provide some scalable fonts and supporting packages for Xorg applications. Many people will want to install other TTF or OTF fonts in addition to, or instead of, these. Some are listed at the section called “TTF and OTF fonts”.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Xorg Fonts Dependencies

Required

xcursor-themes-1.0.7

Downloading Xorg Fonts

First, create a list of files to be downloaded. This file will also be used to verify the integrity of the downloads when complete:

cat > font-7.md5 << "EOF"
ec6cea7a46c96ed6be431dfbbb78f366  font-util-1.4.0.tar.xz
357d91d87c5d5a1ac3ea4e6a6daf833d  encodings-1.0.7.tar.xz
79f4c023e27d1db1dfd90d041ce89835  font-alias-1.0.5.tar.xz
546d17feab30d4e3abcf332b454f58ed  font-adobe-utopia-type1-1.0.5.tar.xz
063bfa1456c8a68208bf96a33f472bb1  font-bh-ttf-1.0.4.tar.xz
51a17c981275439b85e15430a3d711ee  font-bh-type1-1.0.4.tar.xz
00f64a84b6c9886040241e081347a853  font-ibm-type1-1.0.4.tar.xz
fe972eaf13176fa9aa7e74a12ecc801a  font-misc-ethiopic-1.0.5.tar.xz
3b47fed2c032af3a32aad9acc1d25150  font-xfree86-type1-1.0.5.tar.xz
EOF

To download the needed files using Wget-1.21.4, use the following commands:

mkdir font &&
cd font &&
grep -v '^#' ../font-7.md5 | awk '{print $2}' | wget -i- -c \
    -B https://www.x.org/pub/individual/font/ &&
md5sum -c ../font-7.md5

Installation of Xorg Fonts

Note

When installing multiple packages in a script, the installation needs to be done as the root user. There are three general options that can be used to do this:

  1. Run the entire script as the root user (not recommended).

  2. Use the sudo command from the Sudo-1.9.14p3 package.

  3. Use su -c "command arguments" (quotes required) which will ask for the root password for every iteration of the loop.

One way to handle this situation is to create a short bash function that automatically selects the appropriate method. Once the command is set in the environment, it does not need to be set again.

as_root()
{
  if   [ $EUID = 0 ];        then $*
  elif [ -x /usr/bin/sudo ]; then sudo $*
  else                            su -c \\"$*\\"
  fi
}

export -f as_root

First, start a subshell that will exit on error:

bash -e

Install all of the packages by running the following commands:

for package in $(grep -v '^#' ../font-7.md5 | awk '{print $2}')
do
  packagedir=${package%.tar.?z*}
  tar -xf $package
  pushd $packagedir
    ./configure $XORG_CONFIG
    make
    as_root make install
  popd
  as_root rm -rf $packagedir
done

Finally, exit the shell that was started earlier:

exit

When all of the fonts have been installed, the system must be configured so that Fontconfig can find the TrueType fonts. Since the fonts are outside of the default search path of several packages if XORG_PREFIX is not /usr, make symlinks to the Xorg TrueType font directories in /usr/share/fonts by running the following commands as the root user:

install -v -d -m755 /usr/share/fonts                               &&
ln -svfn $XORG_PREFIX/share/fonts/X11/OTF /usr/share/fonts/X11-OTF &&
ln -svfn $XORG_PREFIX/share/fonts/X11/TTF /usr/share/fonts/X11-TTF

Contents

Installed Programs: bdftruncate and ucs2any
Installed Libraries: None
Installed Directories: $XORG_PREFIX/share/fonts

Short Descriptions

bdftruncate

generates a truncated BDF font from an ISO 10646-1 encoded BDF font

ucs2any

generates BDF fonts in any encoding from an ISO 10646-1 encoded BDF font

XKeyboardConfig-2.39

Introduction to XKeyboardConfig

The XKeyboardConfig package contains the keyboard configuration database for the X Window System.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

XKeyboardConfig Dependencies

Required

Xorg Libraries

Installation of XKeyboardConfig

Install XKeyboardConfig by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=$XORG_PREFIX --buildtype=release .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directory: $XORG_PREFIX/share/X11/xkb

Xwayland-23.2.0

Introduction to Xwayland

The Xwayland package is an Xorg server running on top of the wayland server. It has been separated from the main Xorg server package. It allows running X clients inside a wayland session.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Xwayland Dependencies

Required

libxcvt-0.1.2, Pixman-0.42.2, wayland-protocols-1.32, Xorg Applications (runtime), and Xorg Fonts (only font-util)

Recommended
Optional

git-2.41.0 (to download packages needed for the tests), libgcrypt-1.10.2, Nettle-3.9.1, xmlto-0.0.28, Xorg Legacy Fonts (only bdftopcf, for building fonts required for the tests), rendercheck (for tests), and weston (for tests)

Installation of Xwayland

Install xwayland by running the following commands:

sed -i '/install_man/,$d' meson.build &&

mkdir build &&
cd    build &&

meson setup --prefix=$XORG_PREFIX         \
            --buildtype=release           \
            -Dxkb_output_dir=/var/lib/xkb \
            ..                            &&
ninja

Building the test framework needs some work. First, weston brings in several dependencies, but the number can be reduced by disabling unneeded features. The meson command for a stripped down build of weston is shown in Upstream continuous integration build.

Running the tests involves downloading two other frameworks, in addition to the mentioned optional dependencies:

mkdir tools &&
pushd tools &&

git clone https://gitlab.freedesktop.org/mesa/piglit.git --depth 1 &&
cat > piglit/piglit.conf << EOF                                    &&
[xts]
path=$(pwd)/xts
EOF

git clone https://gitlab.freedesktop.org/xorg/test/xts --depth 1   &&

export DISPLAY=:22           &&
../hw/vfb/Xvfb $DISPLAY &
VFB_PID=$!                   &&
cd xts                       &&
CFLAGS=-fcommon ./autogen.sh &&
make                         &&
kill $VFB_PID                &&
unset DISPLAY VFB_PID        &&
popd

Then the tests can be run with:

XTEST_DIR=$(pwd)/tools/xts PIGLIT_DIR=$(pwd)/tools/piglit ninja test

Now, as the root user:

ninja install

If Xorg-Server-21.1.8 is not installed and you do not plan to install it later, you can install Xvfb from this package. As the root user:

install -vm755 hw/vfb/Xvfb /usr/bin

Command Explanations

sed -i '/install_man/,$d' meson.build: Prevents installing a manual page for Xserver, which is also provided by Xorg-Server-21.1.8. Remove this command if Xorg-Server-21.1.8 is not installed and you don't plan to install it later.

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Program: Xwayland
Installed Library: None
Installed Directory: None

Short Descriptions

Xwayland

Allows X clients to run under wayland

Xorg-Server-21.1.8

Introduction to Xorg Server

The Xorg Server is the core of the X Window system.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Xorg Server Dependencies

Required

libxcvt-0.1.2, Pixman-0.42.2, Xorg Fonts (only font-util), and at runtime: xkeyboard-config-2.39

Recommended
Optional

acpid-2.0.34 (runtime), Doxygen-1.9.7 (to build API documentation), fop-2.9 (to build documentation), libunwind-1.6.2, Nettle-3.9.1, libgcrypt-1.10.2, xcb-util-keysyms-0.4.1, xcb-util-image-0.4.1, xcb-util-renderutil-0.3.10, xcb-util-wm-0.4.2 (all four to build Xephyr), xmlto-0.0.28 (to build documentation), xkeyboard-config-2.39 (for tests), rendercheck (for tests), and xorg-sgml-doctools (to build documentation)

Kernel Configuration

The traditional Device Dependent X (DDX) drivers have been removed from BLFS in favor of the modesetting_drv driver which will be built as a part of this package. To use the modesetting_drv driver, the kernel must provide a Direct Rendering Manager (DRM) driver for your GPU.

If your GPU supports 3D acceleration and Mesa-23.1.6 provides a Gallium3D driver for utilizing its 3D capability, you should have already enabled the necessary kernel configuration options in Mesa Kernel Configuration. Otherwise, you need to find the kernel configuration option of the DRM driver for the GPU and enable it. Notably, the virtual GPUs provided by some virtual machine managers:

Device Drivers --->
  Graphics support --->
    <*/M>   Direct Rendering Manager (XFree86 4.1.0 and higher DRI support) --->
                                                                      ...  [DRM]
    < /*/M> DRM driver for VMware Virtual GPU                       [DRM_VMWGFX]
    < /*/M> DRM Support for bochs dispi vga interface (qemu stdvga)  [DRM_BOCHS]
    < /*/M> Virtual Box Graphics Card                            [DRM_VBOXVIDEO]

If the kernel does not provide a DRM driver for your GPU, on most x86 systems the simple frame buffer DRM driver running on VESA or UEFI frame buffer can be used as a fallback. Enable the following options in the kernel configurations if you don't have a dedicated DRM driver for the GPU, or you want to keep the simple frame buffer driver as a fallback in case the dedicated driver fails:

Device Drivers --->
  Firmware Drivers --->
    [*] Mark VGA/VBE/EFI FB as generic system framebuffer       [SYSFB_SIMPLEFB]
  Graphics support --->
    <*> Direct Rendering Manager (XFree86 4.1.0 and higher DRI support) --->
                                                                      ...  [DRM]
    <*> Simple framebuffer driver                                [DRM_SIMPLEDRM]

To allow the kernel to print debug messages at an early boot stage, CONFIG_DRM and CONFIG_DRM_SIMPLEDRM should not be built as kernel modules unless an initramfs will be used.

If you want to use the simple frame buffer driver on a system booted via BIOS (instead of UEFI), add the following line before the first menuentry block in the /boot/grub/grub.cfg file to initialize the VESA frame buffer:

set gfxpayload=1024x768x32

You may replace 1024, 768, and 32 with a resolution and color depth setting suitable for your monitor.

If all of these DRM drivers do not work for you and you need to use a DDX driver with a non-DRM kernel GPU driver (usually named CONFIG_FB_* in the kernel configuration, or existing as out-tree kernel modules), or you need an device specific functionality requiring a DDX driver, consult a prior version of BLFS, or an even prior version for more DDX drivers.

Installation of Xorg Server

First, if you need the TearFree option to work around screen tearing, apply the backported patch:

patch -Np1 -i ../xorg-server-21.1.8-tearfree_backport-1.patch

Install the server by running the following commands:

mkdir build &&
cd    build &&

meson setup ..              \
      --prefix=$XORG_PREFIX \
      --localstatedir=/var  \
      -Dglamor=true         \
      -Dxkb_output_dir=/var/lib/xkb &&
ninja

To test the results, issue: ninja test. You will need to run ldconfig as the root user first or some tests may fail.

Now as the root user:

ninja install &&
mkdir -pv /etc/X11/xorg.conf.d

Command Explanations

-Dglamor=true: Ensure building the Glamor module. It's needed to build the modesetting_drv driver which replaces the traditional Device Dependent X (DDX) drivers.

-Dsuid_wrapper=true: Builds the suid-root wrapper for legacy DDX driver support on rootless xserver systems.

-Dsystemd_logind=false: This switch disables systemd-logind integration, allowing Xorg Server to work without having the systemd PAM module configured.

-Dxephyr=true: This option allows building Xephyr if its dependencies are met.

Contents

Installed Programs: gtf, X, Xnest, Xorg, Xvfb, and optionally Xephyr
Installed Libraries: several under $XORG_PREFIX/lib/xorg/modules/ including the modesetting_drv driver
Installed Directories: /etc/X11/xorg.conf.d, $XORG_PREFIX/include/xorg, $XORG_PREFIX/lib/xorg, and $XORG_PREFIX/share/X11/xorg.conf.d

Short Descriptions

gtf

calculates VESA GTF mode lines

X

is a symbolic link to Xorg

Xephyr

is a nested X server which supports modern X extensions

Xnest

is a nested X server

Xorg

is the X11R7 X Server

Xvfb

is the virtual framebuffer X server for X Version 11

modesetting_drv.so

provides a video driver for machines using Kernel Mode Setting (KMS). This will use glamor if that has been enabled and the hardware offers acceleration

Xorg Input Drivers

Introduction to Xorg Input Drivers

The Xorg Input Drivers page contains the instructions for building Xorg input drivers that are necessary in order for Xorg Server to respond user inputs.

libevdev 1.13.1

Introduction to libevdev

The libevdev package contains common functions for Xorg input drivers.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
libevdev Dependencies
Optional

Doxygen-1.9.7 and Valgrind-3.21.0 (optional for tests)

Kernel Configuration

Enable the following options in the kernel configuration and recompile the kernel if necessary:

Device Drivers --->
  Input device support --->
    -*-   Generic input layer (needed for keyboard, mouse, ...)          [INPUT]
    <*/M>   Event interface                                        [INPUT_EVDEV]

If you want to test this package with full coverage, the following options are needed as well:

Device Drivers --->
  Input device support --->
    -*- Generic input layer (needed for keyboard, mouse, ...)            [INPUT]
    [*]   Miscellaneous devices --->                                [INPUT_MISC]
      <*/M>   User level driver support                           [INPUT_UINPUT]

If you build this as a module, it needs to be inserted before the test suite runs.

Installation of libevdev

Install libevdev by running the following commands:

mkdir build &&
cd    build &&

meson setup ..                 \
      --prefix=$XORG_PREFIX    \
      --buildtype=release      \
      -Ddocumentation=disabled &&
ninja

The regression tests can be run as the root user with ninja test, in a graphical session. You need to have enabled the CONFIG_INPUT_UINPUT setting in the kernel for full test coverage. If it is enabled as a module, the module is named uinput and needs to be loaded before running the tests. Note that on some systems, the tests may cause a hard lockup and require a reboot. On laptops, the system will go into Sleep and need to be woken up to finish the test suites.

Now, as the root user:

ninja install

Contents

Installed Xorg Programs: libevdev-tweak-device, mouse-dpi-tool, and touchpad-edge-detector
Installed Xorg Library: libevdev.so
Installed Xorg Directory: $XORG_PREFIX/include/libevdev-1.0
Short Descriptions

libevdev-tweak-device

is a tool to change some kernel device properties

mouse-dpi-tool

is a tool to estimate the resolution of a mouse

touchpad-edge-detector

touchpad-edge-detector is a tool that reads the touchpad events from the kernel and calculates the minimum and maximum for the x and y coordinates, respectively

libevdev.so

is a library of Xorg driver input functions

Xorg Evdev Driver-2.10.6

Introduction to Xorg Evdev Driver

The Xorg Evdev Driver package contains a Generic Linux input driver for the Xorg X server. It handles keyboard, mouse, touchpads and wacom devices, though for touchpad and wacom advanced handling, additional drivers are required.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Xorg Evdev Driver Dependencies
Required

libevdev-1.13.1, mtdev-1.1.6, and Xorg-Server-21.1.8

Installation of Xorg Evdev Driver

Install Xorg Evdev Driver by running the following commands:

./configure $XORG_CONFIG &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Xorg Driver: evdev_drv.so
Short Descriptions

evdev_drv.so

is an Xorg input driver for Linux generic event devices

libinput-1.23.0

Introduction to Libinput

libinput is a library that handles input devices for display servers and other applications that need to directly deal with input devices.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
libinput Dependencies
Required

libevdev-1.13.1 and mtdev-1.1.6

Optional

Valgrind-3.21.0 (to run the tests), GTK+-3.24.38 (to build the GUI event viewer), libunwind-1.6.2 (required for tests), libwacom-2.7.0, sphinx-7.1.2 (required to build documentation), and pyparsing-3.1.1 (for one non-root test)

Kernel Configuration for Running the Libinput Test Suite

Although libinput works with the same kernel configuration used by libevdev-1.13.1, its extensive test suite requires the presence of /dev/uinput (as well as both Valgrind-3.21.0 and libunwind-1.6.2).

If you wish to run the full tests, enable the following option in the kernel configuration and recompile the kernel if necessary:

Device Drivers --->
  Input device support --->
    -*- Generic input layer (needed for keyboard, mouse, ...)            [INPUT]
    [*]   Miscellaneous devices --->                                [INPUT_MISC]
      <*/M>   User level driver support                           [INPUT_UINPUT]

If you build this as a module, it needs to be inserted before the test suite runs.

On an Xorg system you will also need to prevent the events generated during the test suite from interfering with your desktop. Copy the file test/50-litest.conf into ${XORG_PREFIX}/share/X11/xorg.conf.d and restart X. For further information see libinput test suite.

Installation of Libinput

Install libinput by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=$XORG_PREFIX    \
            --buildtype=release      \
            -Ddebug-gui=false        \
            -Dtests=false            \
            -Dlibwacom=false         \
            -Dudev-dir=/usr/lib/udev \
            ..                      &&
ninja

Note

If you want to run the full tests, remove -Dtests from the meson command above. Please read "kernel configuration for running the libinput test suite" (above).

If you have enabled the full tests, you can run the main tests as the root user by executing: ninja test. A very large number of tests will be run. One test fails on wayland.

Now, as the root user:

ninja install

If you have passed -Ddocumentation=true to meson, you can install the generated documentation by running the following commands as the root user:

install -v -dm755      /usr/share/doc/libinput-1.23.0/html &&
cp -rv Documentation/* /usr/share/doc/libinput-1.23.0/html

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Ddebug-gui=false: This switch disables creation of a visual debug helper for libinput. Remove if you want it, and you have GTK+-3.24.38 installed.

-Dtests=false: This switch disables compilation of the main tests. Even with the tests defined as false, you can still run the first four minor tests, as a regular user, but one will be skipped if pyparsing-3.1.1 is not installed.

-Dlibwacom=false: Remove this option if you have libwacom-2.7.0 installed, or if you are installing GNOME.

-Dudev-dir=/usr/lib/udev: In case that the value of XORG_PREFIX is not set to /usr, this option prevents the package from installing Udev rules and helpers into $XORG_PREFIX/lib/udev which is not searched by Udev daemon. This option is not needed for systems with XORG_PREFIX set to /usr, but does no harm.

-Ddocumentation=true: This switch enables generation of the documentation. Add it if you want to generate the documentation. You must have Doxygen-1.9.7 and Graphviz-8.1.0 installed.

Contents

Installed Programs: libinput
Installed Libraries: libinput.so
Installed Directories: /etc/libinput, $XORG_PREFIX/libexec/libinput, $XORG_PREFIX/share/libinput, and (optionally) $XORG_PREFIX/share/doc/libinput-1.23.0

Short Descriptions

libinput

is a set of tools to interface with the libinput library

libinput.so

contains API functions for handling input devices

Xorg Libinput Driver-1.3.0

Introduction to Xorg Libinput Driver

The X.Org Libinput Driver is a thin wrapper around libinput and allows for libinput to be used for input devices in X. This driver can be used as drop-in replacement for evdev and synaptics.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Xorg Libinput Driver Dependencies
Required

libinput-1.23.0 and Xorg-Server-21.1.8

Installation of Xorg Libinput Driver

Install Xorg Libinput Driver by running the following commands:

./configure $XORG_CONFIG &&
make

To test the results, issue make check.

Now, as the root user:

make install

Contents

Installed Xorg Driver: libinput_drv.so
Short Descriptions

libinput_drv.so

is an Xorg input driver for mouse, keyboard, touchpad, touchscreen, and tablet devices

Xorg Synaptics Driver-1.9.2

Introduction to Xorg Synaptics Driver

The Xorg Synaptics Driver package contains the X.Org Input Driver, support programs and SDK for Synaptics touchpads. Even though the evdev driver can handle touchpads very well, this driver is required if you want to use advanced features like multi tapping, scrolling with touchpad, turning the touchpad off while typing, etc.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Xorg Synaptics Driver Dependencies
Required

libevdev-1.13.1 and Xorg-Server-21.1.8

Installation of Xorg Synaptics Driver

Install Xorg Synaptics Driver by running the following commands:

./configure $XORG_CONFIG &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: synclient and syndaemon
Installed Xorg Driver: synaptics_drv.so
Short Descriptions

synclient

is a command line utility used to query and modify Synaptics driver options

syndaemon

is a program that monitors keyboard activity and disables the touchpad when the keyboard is being used

synaptics_drv.so

is an Xorg input driver for touchpads

Xorg Wacom Driver-1.2.0

Introduction to Xorg Wacom Driver

The Xorg Wacom Driver package contains the X.Org X11 driver and SDK for Wacom and Wacom-like tablets. It is not required to use a Wacom tablet, the xf86-input-evdev driver can handle these devices without problems.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information
Xorg Wacom Drivers Dependencies
Required

Xorg-Server-21.1.8

Optional

Doxygen-1.9.7 and Graphviz-8.1.0

Kernel Configuration

To use a Wacom tablet with USB interface, enable the following options in your kernel configuration and recompile. Note that other configuration options could be required for tablet with a serial or bluetooth interface:

Device Drivers --->
  [*] HID bus support --->                                         [HID_SUPPORT]
    {*/M} HID bus core support                                             [HID]
      Special HID drivers --->
      <*/M>   Wacom Intuos/Graphire tablet support (USB)             [HID_WACOM]
    USB HID support --->
      <*/M> USB HID transport layer                                    [USB_HID]
  [*] USB support --->                                             [USB_SUPPORT]
    <*/M> Support for Host-side USB                                        [USB]

Installation of Xorg Wacom Driver

Install Xorg Wacom Driver by running the following commands:

./configure $XORG_CONFIG &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Contents

Installed Programs: isdv4-serial-debugger, isdv4-serial-inputattach, and xsetwacom
Installed Xorg Driver: wacom_drv.so
Short Descriptions

xsetwacom

is a commandline utility used to query and modify wacom driver settings

wacom_drv.so

is an Xorg input driver for Wacom devices

twm-1.0.12

Introduction to twm

The twm package contains a very minimal window manager.

This package is provided for testing the completed Xorg installation.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

twm Dependencies

Required

Xorg-Server-21.1.8

Installation of twm

Install twm by running the following commands:

sed -i -e '/^rcdir =/s,^\(rcdir = \).*,\1/etc/X11/app-defaults,' src/Makefile.in &&
./configure $XORG_CONFIG &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

sed -i -e '/^rcdir =/s...: This command ensures the twm configuration file gets installed in the proper location.

Contents

Installed Programs: twm
Installed Libraries: None
Installed Directory: /etc/X11/app-defaults

Short Descriptions

twm

is the Tab Window Manager for the X Window System

xterm-384

Introduction to xterm

xterm is a terminal emulator for the X Window System.

This package is provided for testing the completed Xorg installation.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

xterm Dependencies

Required

Xorg Applications

Required (at runtime)

A monospace TTF or OTF font such as Dejavu fonts

Optional

Emacs-29.1, PCRE-8.45 or pcre2-10.42, Valgrind-3.21.0 and man2html

Installation of xterm

Install xterm by running the following commands:

sed -i '/v0/{n;s/new:/new:kb=^?:/}' termcap &&
printf '\tkbs=\\177,\n' >> terminfo &&

TERMINFO=/usr/share/terminfo \
./configure $XORG_CONFIG     \
    --with-app-defaults=/etc/X11/app-defaults &&

make

This package does not come with a test suite.

Now, as the root user:

make install    &&
make install-ti &&

mkdir -pv /usr/share/applications &&
cp -v *.desktop /usr/share/applications/

Command Explanations

sed -i ... termcap, printf ... >> terminfo: These commands modify the terminal description so that the Backspace key is expected to send the character with ASCII code 127. This is done for consistency with the Linux console.

TERMINFO=/usr/share/terminfo: This ensures that the xterm terminfo files are installed to the system terminfo database.

--with-app-defaults=...: Sets the location for the app-defaults directory.

make install-ti: This command installs corrected terminfo description files for use with xterm.

Configuring xterm

There are two ways to configure xterm. You can add the X resource definitions to the user's ~/.Xresources file, or add them to the system-wide $XORG_PREFIX/share/X11/app-defaults/Xterm file.

In order for xterm to follow the locale settings in the environment, use TrueType fonts, and follow the Linux convention about the code sent by the Backspace key, add the following definitions as the root user:

cat >> /etc/X11/app-defaults/XTerm << "EOF"
*VT100*locale: true
*VT100*faceName: Monospace
*VT100*faceSize: 10
*backarrowKeyIsErase: true
*ptyInitialErase: true
EOF

Contents

Installed Programs: koi8rxterm, resize, uxterm, and xterm
Installed Libraries: None
Installed Directories: None

Short Descriptions

koi8rxterm

is a wrapper script to set up xterm with a KOI8-R locale

resize

prints a shell command for setting the TERM and TERMCAP environment variables to indicate the current size of xterm window

uxterm

is a wrapper script that modifies the current locale to use UTF-8 and starts xterm with the proper settings

xterm

is a terminal emulator for the X Window System

xclock-1.1.1

Introduction to xclock

The xclock package contains a simple clock application which is used in the default xinit configuration.

This package is provided for testing the completed Xorg installation.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

xclock Dependencies

Required

Xorg Libraries

Installation of xclock

Install xclock by running the following commands:

./configure $XORG_CONFIG &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: xclock
Installed Libraries: None
Installed Directory: None

Short Descriptions

xclock

is an analog/digital clock for X

xinit-1.4.2

Introduction to xinit

The xinit package contains a usable script to start the xserver.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

xinit Dependencies

Required

Xorg Libraries

Recommended (runtime only)

Installation of xinit

Install xinit by running the following commands:

./configure $XORG_CONFIG --with-xinitdir=/etc/X11/app-defaults &&
make

This package does not come with a test suite.

Now, as the root user:

make install &&
ldconfig

Contents

Installed Programs: xinit and startx
Installed Libraries: None
Installed Directories: None

Short Descriptions

startx

initializes an X session

xinit

is the X Window System initializer

Xorg-7 Testing and Configuration

Testing Xorg

Note

Before starting Xorg for the first time, is useful to rebuild the library cache by running ldconfig as the root user.

Note

Before starting Xorg for the first time, is often needed to reboot the system to ensure all appropriate daemons are started and appropriate security issues are properly set. As an alternative, logging out and logging back in may work, but as of this writing has not been tested.

Warning

If Xorg hangs for some reason (for example, lacking a proper input driver), the system may stop responding to any user input. As a precaution, you can enable a magic SysRq key before testing Xorg. As the root user, issue:

echo 4 > /proc/sys/kernel/sysrq

Then if Xorg hangs, it's possible to use Alt+SysRq+R to reset the keyboard mode. Now it should be able to use Ctrl+Alt+Fx (replace x with a VT number) to switch to another VT. If it works, login and kill Xorg using command line in the new VT.

To test the Xorg installation, issue startx. This command brings up a rudimentary window manager called twm with three xterm windows and one xclock window. The xterm window in the upper left is a login terminal and running exit from this terminal will exit the X Window session. The third xterm window may be obscured on your system by the other two xterms.

Note

When testing Xorg with the twm window manager, there will be several warnings in the Xorg log file, $HOME/.local/share/xorg/Xorg.0.log, about missing font files. In addition, there will be several warnings on the text mode terminal (usually tty1) about missing fonts. These warnings do not affect functionality, but can be removed if desired by installing the Xorg Legacy Fonts.

Note

On systems with NVIDIA GPUs which are using the Nouveau kernel driver, you may encounter occasional GPU crashes and hangs. If this problem occurs, downgrade to the latest version of the Linux 6.1 kernel.

Generally, there is no specific configuration required for Xorg, but customization is possible. For details, see the section called “Setting up Xorg Devices” below.

Checking the Direct Rendering Infrastructure (DRI) Installation

DRI is a framework for allowing software to access graphics hardware in a safe and efficient manner. It is installed in X by default (using Mesa) if you have a supported video card.

To check if DRI drivers are installed properly, check the log file $HOME/.local/share/xorg/Xorg.0.log (or /var/log/Xorg.0.log if you have built Xorg-Server-21.1.8 with the suid bit) for statements such as:

(II) modeset(0): [DRI2] Setup complete
(II) modeset(0): [DRI2]   DRI driver: crocus
(II) modeset(0): [DRI2]   VDPAU driver: va_gl

Note

DRI configuration may differ if you are using alternate drivers, such as traditional DDX drivers, or the proprietary drivers from NVIDIA or AMD.

Another way to determine if DRI is working properly is to use one of the two optionally installed OpenGL demo programs in Mesa-23.1.6. From an X terminal, run glxinfo and look for the phrase:

name of display: :0
display: :0  screen: 0
direct rendering: Yes

If direct rendering is enabled, you can add verbosity by running LIBGL_DEBUG=verbose glxinfo. This will show the drivers, device nodes and files used by the DRI system.

To confirm that DRI2 hardware acceleration is working, you can (still in the X terminal) run the command glxinfo | grep -E "(OpenGL vendor|OpenGL renderer|OpenGL version)". If that reports something other than Software Rasterizer then you have working acceleration for the user who ran the command.

If your hardware does not have any DRI2 driver available, it will use a Software Rasterizer for Direct Rendering. In such cases, you can use a new, LLVM-accelerated, Software Rasterizer called LLVMPipe. In order to build LLVMPipe just make sure that LLVM-16.0.5 is present at Mesa build time. Note that all decoding is done on the CPU instead of the GPU, so the display will run slower than with hardware acceleration. To check if you are using LLVMpipe, review the output of the glxinfo command above. An example of the output using the Software Rasterizer is shown below:

OpenGL vendor string: VMware, Inc.
OpenGL renderer string: Gallium 0.4 on llvmpipe (LLVM 3.5, 256 bits)
OpenGL version string: 3.0 Mesa 10.4.5

You can also force LLVMPipe by exporting the LIBGL_ALWAYS_SOFTWARE=1 environment variable when starting Xorg.

Again, if you have built the Mesa OpenGL demos, you can also run the test program glxgears. This program brings up a window with three gears turning. The X terminal will display how many frames were drawn every five seconds, so this will give a rough benchmark. The window is scalable, and the frames drawn per second is highly dependent on the size of the window. On some hardware, glxgears will run synchronized with the vertical refresh signal and the frame rate will be approximately the same as the monitor refresh rate.

Debugging Xorg

When starting xorg, there are a couple of ways to check what any issues you may have. If the system comes up, you can see what driver is being used by running xdriinfo. If there are issues or you just want to check, look at Xorg.0.log.

The location of Xorg.0.log depends on how Xorg is installed. If the instructions in the book are followed closely and Xorg is started from the command line, it will be located in the $HOME/.local/share/xorg/ directory. If Xorg is started by a display manager (e.g. lightdm-1.32.0, sddm-0.20.0, or GDM-44.1) or if $XORG_PREFIX/bin/Xorg has the suid bit set, it will be located in the /var/log/ directory.

Xorg.0.log Issues

When you look at Xorg.0.log, check for entries like (EE) or (WW). Below are some common entries:

(WW) Open ACPI failed (/var/run/acpid.socket)

This warning is because acpid-2.0.34 is not installed. If you are not on a laptop, it can be safely ignored. On a laptop, install acpid-2.0.34 to enable actions like recognizing when the lid is closed.

(WW) VGA arbiter: cannot open kernel arbiter, no multi-card support

This warning is displayed when a regular user starts Xorg. The library libpciaccess.so issues this warning when it tries to open /dev/vga_arbiter. If there is no more than one legacy PCI (not PCIe) graphic cards on the system, it can safely be ignored. If really necessary, the permissions of this device can be changed by adding a udev rule and adding the local user to the video group. As the root user:

cat > /etc/udev/rules.d/99-vga-arbiter.rules << EOF
# /etc/udev/rules.d/99-vga-arbiter.rules: Set vga_arbiter group/mode

ACTION=="add", KERNEL=="vga_arbiter", GROUP="video" MODE="0660"
EOF

usermod -a -G video <user running xorg>

Hybrid Graphics

Hybrid Graphics is still in experimental state for Linux. Xorg Developers have developed a technology called PRIME that can be used for switching between integrated and muxless discrete GPU at will. Automatic switching is not possible at the moment.

In order to use PRIME for GPU switching, make sure that you are using Linux Kernel 3.4 or later (recommended). You will need latest DRI and DDX drivers for your hardware and Xorg Server 1.13 or later.

Xorg Server should load both GPU drivers automatically. You can check that by running:

xrandr --listproviders

There should be two (or more) providers listed, for example:

Providers: number : 2
Provider 0: id: 0x7d cap: 0xb, Source Output, Sink Output, Sink Offload crtcs: 3 outputs: 4 associated providers: 1 name:modesetting
Provider 1: id: 0x56 cap: 0xf, Source Output, Sink Output, Source Offload, Sink Offload crtcs: 6 outputs: 1 associated providers: 1 name:modesetting

In order to be able to run a GLX application on a discrete GPU, you will need to run the following command, where <provider> is the id of the more powerful discrete card, and <sink> is the id of card which has a display connected:

xrandr --setprovideroffloadsink <provider> <sink>

Note

With the Xorg modesetting driver, which is DRI3 capable, the above command is no longer necessary. It does no harm however.

Then, you will need to export the DRI_PRIME=1 environment variable each time you want the powerful GPU to be used. For example,

DRI_PRIME=1 glxinfo | grep -E "(OpenGL vendor|OpenGL renderer|OpenGL version)"

will show OpenGL vendor, renderer and version for the discrete GPU.

If the last command reports same OpenGL renderer with and without DRI_PRIME=1, you will need to check your installation.

Setting up Xorg Devices

For most hardware configurations, modern Xorg will automatically get the server configuration correct without any user intervention. There are, however, some cases where auto-configuration will be incorrect. Following are some example manual configuration items that may be of use in these instances.

Setting up X Input Devices

For most input devices, no additional configuration will be necessary. This section is provided for informational purposes only.

A sample default XKB setup could look like the following (executed as the root user):

cat > /etc/X11/xorg.conf.d/xkb-defaults.conf << "EOF"
Section "InputClass"
    Identifier "XKB Defaults"
    MatchIsKeyboard "yes"
    Option "XkbLayout" "fr"
    Option "XkbOptions" "terminate:ctrl_alt_bksp"
EndSection
EOF

The XkbLayout line is an example for a French (AZERTY) keyboard. Change it to your keyboard model. That line is not needed for a QWERTY (US) keyboard.

Fine Tuning Display Settings

If you want to set the monitor resolution for Xorg, first run xrandr in a X terminal to list the supported resolutions and the corresponding refresh rates. For example, it outputs the following for one monitor:

Screen 0: minimum 16 x 16, current 5760 x 2160, maximum 32767 x 32767
DP-1 connected primary 3840x2160+0+0 (normal left inverted right x axis y axis) 600mm x 340mm
   3840x2160     59.98*+
   2048x1536     59.95
   1920x1440     59.90
   1600x1200     59.87
   1440x1080     59.99
   1400x1050     59.98
   1280x1024     59.89
   1280x960      59.94
   1152x864      59.96
   1024x768      59.92
   800x600       59.86
   640x480       59.38

From the output we can see the monitor is identified DP-1. Select a suitable resolution from the output list, for example 1920x1440. Then as the root user, create a configuration file for the Xorg server:

cat > /etc/X11/xorg.conf.d/monitor-DP-1.conf << "EOF"
Section "Monitor"
    Identifier  "DP-1"
    Option      "PerferredMode" "1920x1440"
EndSection
EOF

Sometimes xrandr may fail to detect some resolution settings supported by the monitor. It usually happens with virtual monitors of virtual machine managers like qemu-8.1.0 or VMWare: a virtual monitor actually supports all pairs of integers in a range as the resolution, but xrandr will only list a few. To use a resolution not listed by xrandr, first run cvt to get the mode line for the resolution. For example:

cvt 1600 900
# 1600x900 59.95 Hz (CVT 1.44M9) hsync: 55.99 kHz; pclk: 118.25 MHz
Modeline "1600x900_60.00"  118.25  1600 1696 1856 2112  900 903 908 934 -hsync +vsync

As the root user, create a Xorg server configuration file containing this mode line, and specify the mode as preferred mode:

cat > /etc/X11/xorg.conf.d/monitor-DP-1.conf << "EOF"
Section "Monitor"
    Identifier  "DP-1"
    Modeline    "1600x900_60.00"  118.25  1600 1696 1856 2112  900 903 908 934 -hsync +vsync
    Option      "PerferredMode"   "1600x900_60.00"
EndSection
EOF

Some high-end LCD monitors support a refresh rate higher than 100 Hz but xrandr may fail to recognize the supported refresh rate and use 60 Hz instead. This issue would prevent you from utilizing the full capability of the monitor, and may cause the screen to flicker or show artifacts like meshes or grids. To resolve the issue, again use cvt to get the mode line with a custom refresh rate:

cvt 3840 2160 144
# 3840x2160 143.94 Hz (CVT) hsync: 338.25 kHz; pclk: 1829.25 MHz
Modeline "3840x2160_144.00"  1829.25  3840 4200 4624 5408  2160 2163 2168 2350 -hsync +vsync

Then paste it into the Xorg server configuration file and set it as the preferred mode.

Another common setup is having multiple server layouts for use in different environments. Though the server will automatically detect the presence of another monitor, it may get the order incorrect:

cat > /etc/X11/xorg.conf.d/server-layout.conf << "EOF"
Section "ServerLayout"
    Identifier     "DefaultLayout"
    Screen      0  "Screen0" 0 0
    Screen      1  "Screen1" LeftOf "Screen0"
    Option         "Xinerama"
EndSection
EOF

When you drag a window in twm (or any non-compositing window manager) horizontally, you may observe that the vertical borders of the window are broken into multiple segments. This is an example of the visual artifacts called screen tearing. To resolve the screen tearing problems, create a configuration file that enables the TearFree option. Note that you must have the Tearfree patch applied from Xorg-Server-21.1.8 for this to function properly, and it may increase memory allocation and reduce performance.

cat > /etc/X11/xorg.conf.d/20-tearfree.conf << "EOF"
Section "Device"
   Identifier "Graphics Adapter"
   Driver     "modesetting"
   Option     "TearFree" "true"
EndSection
EOF

With modern Xorg, little or no additional graphic card configuration is necessary. If you should need extra options passed to your video driver, add them into the Device section as well. The options supported by the modesetting driver are documented in the man page modesetting(4).

Tuning Fontconfig

Overview of Fontconfig

If you only read text in English, and are happy with the common libre fonts listed on the next page, you may never need to worry about the details of how fontconfig works. But there are many things which can be altered if they do not suit your needs.

Although this page is long, it barely scratches the surface and you will be able to find many alternative views on the web (but please remember that some things have changed over the years, for example the autohinter is no longer the default). The aim here is to give you enough information to understand the changes you are making.

The Xft Font Protocol

The Xft font protocol provides antialiased font rendering through freetype, and fonts are controlled from the client side using fontconfig (except for rxvt-unicode-9.31 which can use fonts listed in ~/.Xresources, and AbiWord-3.0.5 which only uses the specified font). The default search path is /usr/share/fonts and ~/.local/share/fonts, although for the moment the old and deprecated location ~/.fonts still works. Fontconfig searches directories in its path recursively and maintains a cache of the font characteristics in each directory. If the cache appears to be out of date, it is ignored, and information is fetched from the fonts themselves (that can take a few seconds if you have a lot of fonts installed).

If you've installed Xorg in any prefix other than /usr, any X fonts were not installed in a location known to Fontconfig. Symlinks were created from the OTF and TTF X font directories to /usr/share/fonts/X11-{OTF,TTF}. This allows Fontconfig to use the OpenType and TrueType fonts provided by X, although many people will prefer to use more modern fonts.

Fontconfig uses names to define fonts. Applications generally use generic font names such as "Monospace", "Sans" and "Serif". Fontconfig resolves these names to a font that has all characters that cover the orthography of the language indicated by the locale settings.

Useful Commands

The following commands may be helpful when working with fontconfig:

fc-list | less : shows a list of all available fonts (/path/to/filename: Font Name:style). If you installed a font more than 30 seconds ago but it does not show, then it or one of its directories is not readable by your user.

fc-match 'Font Name' : tells you which font will be used if the named font is requested. Typically you would use this to see what happens if a font you have not installed is requested, but you can also use it if the system is giving you a different font from what you expected (perhaps because fontconfig does not think that the font supports your language).

fc-match -a 'Type' | less : provides a list of all fonts which can be used for that type (Monospace, Sans, Serif). Note that in-extremis fontconfig will take a glyph from any available font, even if it is not of the specified type, and unless it knows about the font's type it will assume it is Sans.

If you wish to know which font will be used for a string of text (i.e. one or more glyphs, preceded by a space), paste the following command and replace the xyz by the text you care about:

FC_DEBUG=4 pango-view --font=monospace -t xyz | grep family : this requires Pango-1.50.14 and ImageMagick-7.1.1-15 - it will invoke display to show the text in a tiny window, and after closing that the last line of the output will show which font was chosen. This is particularly useful for CJK languages, and you can also pass a language, e.g. PANGO_LANGUAGE=en;ja (English, then assume Japanese) or just zh-cn (or other variants - 'zh' on its own is not valid).

The various files

The main files are in /etc/fonts/conf.d/, which was intended to be a directory populated by symlinks to some of the files in /usr/share/fontconfig/conf.avail/. But many people, and some packages, create the files directly. Each file name must be in the form of two digits, a dash, somename.conf and they are read in sequence.

By convention, the numbers are assigned as follows:

  • 00-09 extra font directories

  • 10-19 system rendering defaults (such as antialiasing)

  • 20-29 font rendering options

  • 30-39 family substitution

  • 40-49 map family to generic type

  • 50-59 load alternate config files

  • 60-69 generic aliases, map generic to family

  • 70-79 adjust which fonts are available

  • 80-89 match target scan (modify scanned patterns)

  • 90-99 font synthesis

You can also have a personal fonts.conf in $XDG_CONFIG_HOME (which is ~/.config/fontconfig/).

The rules to choose a font

If the requested font is installed, and provided it contains the codepoints required for the current language (in the source, see the .orth files in the fc-lang/ directory), it will be used.

However, if the document or page requested a font which is not installed (or, occasionally, does not contain all the required codepoints) the following rules come into play: First, 30-metric-aliases.conf is used to map aliases for some fonts with the same metrics (same size, etc). After that, an unknown font will be searched for in 45-latin.conf - if it is found it will be mapped as Serif or Monospace or Sans, otherwise it will be assumed to be Sans. Then 50-latin.conf provides ordered lists of the fallbacks - Dejavu fonts will be used if you installed them. Cyrillic and Greek appear to be treated in the same way. There are similar files with a 65- prefix for Persian and other non-latin writing systems. All of these files prefer commercial fonts if they are present, although modern libre fonts are often at least equal.

Since fontconfig-2.12.5, there is also generic family matching for some emoji and math fonts, please see {45,60}-generic.conf.

In the rare cases where a font does not contain all the expected codepoints, see 'Trial the First:' at I stared into the fontconfig for the long details.

Hinting and Anti-aliasing

It is possible to change how, or if, fonts are hinted. The following example file contains the default settings, but with comments. The settings are very much down to the user's preferences and to the choice of fonts, so a change which improves some pages may worsen others. The preferred location for this file is: ~/.config/fontconfig/fonts.conf

To try out different settings, you may need to exit from Xorg and then run startx again so that all applications use the new settings. If you use GNOME, KDE, or LXQt, their desktops can override these changes. To explore the possibilities, create a file for your user:

mkdir -pv ~/.config/fontconfig &&
cat > ~/.config/fontconfig/fonts.conf << "EOF"
<?xml version='1.0'?>
<!DOCTYPE fontconfig SYSTEM 'fonts.dtd'>
<fontconfig>

  <match target="font" >
    <!-- autohint was the old automatic hinter when hinting was patent
    protected, so turn it off to ensure any hinting information in the font
    itself is used, this is the default -->
    <edit mode="assign" name="autohint">  <bool>false</bool></edit>

    <!-- hinting is enabled by default -->
    <edit mode="assign" name="hinting">   <bool>true</bool></edit>

    <!-- for the lcdfilter see https://www.spasche.net/files/lcdfiltering/ -->
    <edit mode="assign" name="lcdfilter"> <const>lcddefault</const></edit>

    <!-- options for hintstyle:
    hintfull: is supposed to give a crisp font that aligns well to the
    character-cell grid but at the cost of its proper shape.

    hintmedium: poorly documented, maybe a synonym for hintfull.
    hintslight is the default: - supposed to be more fuzzy but retains shape.

    hintnone: seems to turn hinting off.
    The variations are marginal and results vary with different fonts -->
    <edit mode="assign" name="hintstyle"> <const>hintslight</const></edit>

    <!-- antialiasing is on by default and really helps for faint characters
    and also for 'xft:' fonts used in rxvt-unicode -->
    <edit mode="assign" name="antialias"> <bool>true</bool></edit>

    <!-- subpixels are usually rgb, see
    http://www.lagom.nl/lcd-test/subpixel.php -->
    <edit mode="assign" name="rgba">      <const>rgb</const></edit>

    <!-- thanks to the Arch wiki for the lcd and subpixel links -->
  </match>

</fontconfig>
EOF

You will now need to edit the file in your preferred editor.

For more examples see the blfs-support thread which started at 2016-09/00128, particularly 2016-09/00137, and the original poster's preferred solution at 2016-09/00147. There are other examples in Fontconfig in the Arch wiki and Fontconfig in the Gentoo wiki.

Disabling Bitmap Fonts

In previous versions of BLFS, the ugly old Xorg bitmap fonts were installed. Now, many people will not need to install any of them. But if for some reason you have installed one or more bitmap fonts, you can prevent them from being used by fontconfig by creating the following file as the root user :

cat > /etc/fonts/conf.d/70-no-bitmaps.conf << "EOF"
<?xml version='1.0'?>
<!DOCTYPE fontconfig SYSTEM 'fonts.dtd'>
<fontconfig>
<!-- Reject bitmap fonts -->
 <selectfont>
  <rejectfont>
   <pattern>
     <patelt name="scalable"><bool>false</bool></patelt>
   </pattern>
  </rejectfont>
 </selectfont>
</fontconfig>
EOF

Adding extra font directories

Normally, system fonts and user fonts are installed in directories beneath the locations specified in The Xft Font Protocol and there is no obvious reason to put them elsewhere. However, a full BLFS install of texlive-20230313 puts many fonts in /opt/texlive/2023/texmf-dist/fonts/ in the opentype/ and truetype/ subdirectories. Although pulling in all of these files may appear useful (it allows you to use them in non TeX programs), there are several problems with such an approach:

  1. There are hundreds of files, which makes selecting fonts difficult.

  2. Some of the files do odd things, such as displaying semaphore flags instead of ASCII letters, or mapping cyrillic codepoints to character forms appropriate to Old Church Slavonic instead of the expected current shapes: fine if that is what you need, but painful for normal use.

  3. Several fonts have multiple sizes and impenetrable short names, which both make selecting the correct font even more difficult.

  4. When a font is added to CTAN, it is accompanied by TeX packages to use it in the old engines (xelatex does not normally need this), and then the version is often frozen whilst the font is separately maintained. Some of these fonts such as Dejavu fonts are probably already installed on your BLFS system in a newer version, and if you have multiple versions of a font it is unclear which one will be used by fontconfig.

However, it is sometimes useful to look at these fonts in non-TeX applications, if only to see whether you wish to install a current version. If you have installed all of texlive, the following example will make one of the Arkandis Open Type fonts available to other applications, and all three of the ParaType TrueType fonts. Adjust or repeat the lines as desired, to either make all the opentype/ or truetypefonts available, or to select different font directories. As the root user:

cat > /etc/fonts/conf.d/09-texlive.conf << "EOF"
<?xml version='1.0'?>
<!DOCTYPE fontconfig SYSTEM 'fonts.dtd'>
<fontconfig>
  <dir>/opt/texlive/2023/texmf-dist/fonts/opentype/arkandis/berenisadf</dir>
  <dir>/opt/texlive/2023/texmf-dist/fonts/truetype/paratype</dir>
</fontconfig>
EOF

If you do this, remember to change all instances of the year in that file when you upgrade texlive to a later release.

Preferring certain fonts

There are many reasons why people may wish to have pages which specify a particular font use a different font, or prefer specific fonts in Monospace or Sans or Serif. As you will expect, there a number of different ways of achieving this.

Fontconfig user docs

Fontconfig installs user documentation that includes an example 'User configuration file' which among other things prefers WenQuanYi ZenHei (a Sans font) if a Serif font is requested for Chinese (this part might be anachronistic unless you have non-free Chinese fonts, because in 65-nonlatin.conf this font is already among the preferred fonts when Serif is specified for Chinese) and to prefer the modern VL Gothic font if a Sans font is specified on a Japanese page (otherwise a couple of other fonts would be preferred if they have been installed).

If you have installed the current version, the user documentation is available in HTML, PDF, and text versions at /usr/share/doc/fontconfig-2.14.2/ : change the version if you installed a different one.

Prefer a specific font

As an example, if for some reason you wished to use the Nimbus Roman No9 L font wherever Times New Roman is referenced (it is metrically similar, and preferred for Times Roman, but the Serif font from Liberation fonts will be preferred for the Times New Roman font if installed), as an individual user you could install the font and then create the following file:

mkdir -pv ~/.config/fontconfig/conf.d &&
cat >  ~/.config/fontconfig/conf.d/35-prefer-nimbus-for-timesnew.conf << "EOF"
<?xml version='1.0'?>
<!DOCTYPE fontconfig SYSTEM 'fonts.dtd'>
<fontconfig>
<!-- prefer Nimbus Roman No9 L for Times New Roman as well as for Times,
 without this Tinos and Liberation Serif take precedence for Times New Roman
 before fontconfig falls back to whatever matches Times -->
    <alias binding="same">
        <family>Times New Roman</family>
        <accept>
            <family>Nimbus Roman No9 L</family>
        </accept>
    </alias>
</fontconfig>
EOF

This is something you would normally do in an individual user's settings, but the file in this case has been prefixed '35-' so that it could, if desired, be used system-wide in /etc/fonts/conf.d/.

Prefer chosen CJK fonts

The following example of a local configuration (i.e. one that applies for all users of the machine) does several things:

  1. If a Serif font is specified, it will prefer the UMing variants, so that in the zh-cn, zh-hk and zh-tw languages things should look good (also zh-sg which actually uses the same settings as zh-cn) without affecting Japanese.

  2. It prefers the Japanese IPAex fonts if they have been installed (although VL Gothic will take precedence for (Japanese) Sans if it has also been installed.

  3. Because WenQuanYi ZenHei covers Korean Hangul glyphs and is also preferred for Serif in 65-nonlatin.conf, if installed it will be used by default for Korean Serif. To get a proper Serif font, the UnBatang font is specified here - change that line if you installed a different Serif font from the choice of Korean fonts.

  4. The Monospace fonts are forced to the preferred Sans fonts. If the text is in Korean then WenQuanYi ZenHei will be used.

In a non-CJK locale, the result is that suitable fonts will be used for all variants of Chinese, Japanese and Hangul Korean. All other languages should already work if a font is present. As the root user:

cat > /etc/fonts/local.conf << "EOF"
<?xml version='1.0'?>
<!DOCTYPE fontconfig SYSTEM 'fonts.dtd'>
<fontconfig>
    <alias>
        <family>serif</family>
        <prefer>
            <family>AR PL UMing</family>
            <family>IPAexMincho</family>
            <!-- WenQuanYi is preferred as Serif in 65-nonlatin.conf,
            override that so a real Korean font can be used for Serif -->
            <family>UnBatang</family>
        </prefer>
    </alias>
    <alias>
         <family>sans-serif</family>
         <prefer>
             <family>WenQuanYi Zen Hei</family>
             <family>VL Gothic</family>
             <family>IPAexGothic</family>
         </prefer>
    </alias>
    <alias>
         <family>monospace</family>
         <prefer>
             <family>VL Gothic</family>
             <family>IPAexGothic</family>
             <family>WenQuanYi Zen Hei</family>
         </prefer>
    </alias>
</fontconfig>
EOF

Editing Old-Style conf files

Some fonts, particularly Chinese fonts, ship with conf files which can be installed in /etc/fonts/conf.d. However, if you do that and then use a terminal to run any command which uses fontconfig you may see error messages such as :

Fontconfig warning: "/etc/fonts/conf.d/69-odofonts.conf", line 14: Having multiple <family> in <alias> isn't supported and may not work as expected.

In practice, these old rules do not work. For non-CJK users, fontconfig will usually do a good job without these rules. Their origin dates back to when CJK users needed handcrafted bitmaps to be legible at small sizes, and those looked ugly next to antialiased Latin glyphs - they preferred to use the same CJK font for the Latin glyphs. There is a side-effect of doing this : the (Serif) font is often also used for Sans, and in such a situation the (English) text in Gtk menus will use this font - compared to system fonts, as well as being serif it is both faint and rather small. That can make it uncomfortable to read.

Nevertheless, these old conf files can be fixed if you wish to use them. The following example is the first part of 64-arphic-uming.conf from UMing - there are many more similar items which also need changing :


   <match target="pattern">
       <test qual="any" name="lang" compare="contains">
           <string>zh-cn</string>
           <string>zh-sg</string>
       </test>
       <test qual="any" name="family">
           <string>serif</string>
       </test>
       <edit name="family" mode="prepend" binding="strong">
           <string>AR PL UMing CN</string>
       </edit>
    </match>

The process to correct this is straightforward but tedious - for every item which produces an error message, using your editor (as the root user), edit the installed file to repeat the whole block as many times as there are multiple variables, then reduce each example to have only one of them. You may wish to work on one error at a time, save the file after each fix, and from a separate term run a command such as fc-list 2>&1 | less to see that the fix worked. For the block above, the fixed version will be :


   <match target="pattern">
       <test qual="any" name="lang" compare="contains">
           <string>zh-cn</string>
       </test>
       <test qual="any" name="family">
           <string>serif</string>
       </test>
       <edit name="family" mode="prepend" binding="strong">
           <string>AR PL UMing CN</string>
       </edit>
    </match>
   <match target="pattern">
       <test qual="any" name="lang" compare="contains">
           <string>zh-sg</string>
       </test>
       <test qual="any" name="family">
           <string>serif</string>
       </test>
       <edit name="family" mode="prepend" binding="strong">
           <string>AR PL UMing CN</string>
       </edit>
    </match>

See Also

I stared into the fontconfig ...

The blog entries by Eevee are particularly useful if fontconfig does not think your chosen font supports your language, and for preferring some non-MS Japanese fonts when an ugly MS font is already installed.

Fontconfig in the Arch wiki

Arch has a lot of information in its wiki at font_configuration.

Fontconfig in the Gentoo wiki

Gentoo has some information in its wiki at Fontconfig although a lot of the details (what to enable, and Infinality) are specific to Gentoo.

TTF and OTF fonts

About TTF and OTF fonts

Originally, Xorg provided only bitmap fonts. Later, some scalable Type1 fonts were added, but the desktop world moved on to using TrueType and Open Type fonts. To support these, Xorg uses Xft, the X FreeType interface library.

These fonts can provide hints, which fontconfig uses to adjust them for maximum readability on computer monitors. On Linux you should always use the hinted versions if they are available (in general the Latin, Cyrillic and Greek alphabets can use hints, most other writing systems do not use hinting).

A few fonts are provided as collections (TTC or OTC) where font data is shared between different fonts, which saves disk space. These should be treated in exactly the same way as individual TTF or OTF files.

If a font provides both TTF and OTF forms, you should prefer the OTF form in Linux, as it may provide more features for programs which know how to use them (such as xelatex).

A font may have multiple variations. For example, Noto Sans has 9 weights (ExtraLight, Light, Thin, Normal, Medium, SemiBold, Bold, ExtraBold, and Black) and 2 styles (Regular and Italic), thus 18 variations in total. Normally each variation is provided as a separate TTF or OTF file. For full coverage you need to install all these TTF or OTF files. Even if you are low on disk space, you should still install two weights (Regular and Bold) by two styles (Normal and Italic) if the font has these variations. Some fonts do not have Italic style (for example most CJK fonts and some monospace fonts), and some fonts only have one variation (for example Noto Sans Math, it only provides the glyph of some mathematic symbols).

Some fonts are also available as variable font files. Unlike a normal font file which only contains one variation, a variable font file contains infinite variations. Each variation can be defined by the application using this font by assigning number(s) to one or more variables. There are also pre-defined named instances analogous to the traditional variations. For example, with the variable version of Noto Sans, the weight variable can be assigned any number not less than 100 and not greater than 900, and 9 named instances are pre-defined: ExtraLight for weight=100, Regular for weight=400, Bold for weight=700, etc. So once a variable variable font file for Noto Sans is installed, all the 9 named instances (or variations) are available. Note that the slope is not defined as a variable in the variable version of Noto Sans, so Regular and Italic are still traditional variations and a separate variable font file is needed for the Italic variation.

A variable font file is obviously more flexiable than the normal (static) font files. It's extremely useful for fine tuning the font for Web pages or publications. And, the size of a variable font file is usually significantly smaller than the total size of several static font files for multiple variations. For example, the variable font file for Noto Sans SC is only 11M, while the total size of 9 static font files for Noto Sans SC is 91M. But you must make sure your applications really support variable fonts before installing one. For example, lualatex supports variable font but xelatex does not. So if you want to use a font for an article and use xelatex for typesetting, you must not install the variable font files.

For information about variable fonts, please see Variable Fonts.

For some scripts, Pango is required to render things correctly, either by selecting different glyph forms, or by combining glyphs - in both cases, according to the context. This applies particularly to Arabic and Indic scripts.

Standard scalable fonts that come with X provide very poor Unicode coverage. You may notice in applications that use Xft that some characters appear as a box with four binary digits inside. In this case, a font with the required glyphs has not been found. Other times, applications that don't use other font families by default and don't accept substitutions from Fontconfig will display blank lines when the default font doesn't cover the orthography of the user's language.

The fonts available to a program are those which were present when it was started, so if you add an extra font and wish to use it in a program which is currently running, then you will have to close and restart that program.

Some people are happy to have dozens, or even hundreds, of font files available, but if you ever wish to select a specific font in a desktop application (for example in a word processor) then scrolling through a lot of fonts to find the right one is slow and awkward - fewer is better. So, for some font packages you might decide to install only one of the fonts - but nevertheless install the different variants (italic, bold, etc) as these are all variations for the same font name.

In the past, everybody recommended running fc-cache as the root user after installing or removing fonts, but this is not necessary anymore on Linux, fontconfig will do it automatically if needed as well as if the font caches are more than 30 seconds old. However, if you add a font and want to use it immediately, you can run that command as a normal user.

There are several references below to CJK characters. This stands for Chinese, Japanese and Korean, although modern Korean is now almost all written using the phonetic Hangul glyphs (it used to sometimes use Hanja glyphs which are similar to Chinese and Japanese). Unicode decided to go for Han Unification and to map some Chinese and Japanese glyphs to the same codepoints. This was very unpopular in Japan, and the result is that different fonts will render some codepoints in quite different shapes. In addition, Simplified Chinese will sometimes use the same codepoint as Traditional Chinese but will show it differently, somewhat analogous to the different shapes used for the letters 'a' and 'g' in English (single-storey and two-storey), except that in a language context one will look "wrong" rather than just "different".

Unlike most other packages in this book, the BLFS editors do not monitor the versions of the fonts on this page - once a font is good enough for general use, the typical additions in a new version are minor (e.g. new currency symbols, or glyphs not for a modern language, such as emojis or playing cards). Therefore, none of these fonts show version or md5 information.

The list below will not provide complete Unicode coverage. Unicode is updated every year, and most additions are now for historic writing systems. For almost-complete coverage you can install Noto fonts (about 180 fonts when last checked) but that number of fonts makes it much less convenient to select a specific font in a document, and most people will regard many of them as a waste of space. We used to recommend the Unicode Font Guide, but that has not been updated since 2008 and many of its links are dead.

Rendered examples of most of these fonts, and many others, with details of what languages they cover, some examples of latin fonts with the same metrics (listed as "Substitute latin fonts") and various files of dummy text to compare fonts of similar types, can be found at this font comparison page. That site also covers other current writing systems.

Fonts are often supplied in zip files, requiring UnZip-6.0 to list and extract them, but even if the current release is a tarball, you should still check to see if it will create a directory (scattering the contents of a zipfile or tarball across the current directory can be very messy, and a few fonts create __MACOSX/ directories). In addition, many fonts are supplied with permissions which do not let 'other' users read them - if a font is to be installed for system-wide use, any directories must be mode 755 and all the files mode 644, so you need to change them if the permissions are different. If you forget, the root user may be able to see a particular font in fc-list, but a normal user will not be able to use them.

As a font installation example, consider the installation of the Dejavu fonts. In this particular package, the TTF files are in a subdirectory. From the unpacked source directory, run the following commands as the root user:

install -v -d -m755 /usr/share/fonts/dejavu &&
install -v -m644 ttf/*.ttf /usr/share/fonts/dejavu &&
fc-cache -v /usr/share/fonts/dejavu

If you wish, you can also install any licenses or other documentation, either alongside the font or in a corresponding directory under /usr/share/doc/.

A few fonts ship with source as well as the completed TTF or OTF file(s). Unless you intend to modify the font, and have the correct tools (sometimes FontForge-20230101, but often commercial tools), the source will provide no benefit, so do not install it. One or two fonts even ship with Web Open Font Format (WOFF) files - this is useful if you run a webserver and want to use that font on your website, but not useful for a desktop system.

To provide greater Unicode coverage, you should install some of the following fonts, depending on what websites and languages you want to read. The next part of this page details some fonts which cover at least Latin alphabets, and the final part deals with some CJK issues.

Note

Installation of the Dejavu fonts is strongly recommended.

Caladea

Caladea (created as a Chrome OS extra font) is metrically compatible with MS Cambria and can be used if you have to edit a document which somebody started in Microsoft Office using Cambria.

Cantarell fonts

Cantarell fonts – The Cantarell typeface family provides a contemporary Humanist Sans Serif. It is particularly optimised for legibility at small sizes and is the preferred font family for the GNOME user interface.

Carlito

Carlito (created as another Chrome OS extra font) is metrically compatible with MS Calibri and can be used if you have to edit a document which somebody started in Microsoft Office using Calibri.

DejaVu fonts

DejaVu fonts – These fonts are an extension of, and replacement for, the Bitstream Vera fonts and provide Latin-based scripts with accents and punctuation such as "smart-quotes" and variant spacing characters, as well as Cyrillic, Greek, Arabic, Hebrew, Armenian, Georgian and some other glyphs. In the absence of the Bitstream Vera fonts (which had much less coverage), these are the default fallback fonts.

GNU FreeFont

GNU FreeFont – This set of fonts covers many non-CJK characters, in particular some of the variants of Latin and Cyrillic letters used in minority languages, but the glyphs are comparatively small (unlike DejaVu fonts which are comparatively large) and rather light weight ("less black" when black on white is used) which means that in some contexts such as terminals they are not visually pleasing, for example when most other glyphs are provided by another font. On the other hand, some fonts used primarily for printed output, and many CJK fonts, are also light weight.

Gelasio

Gelasio is metrically compatible with MS Georgia and fontconfig will use it if MS Georgia is requested but is not installed.

Liberation fonts

The Liberation fonts provide libre substitutes for Arial, Courier New, and Times New Roman. Fontconfig will use them as substitutes for those fonts, and also for the similar Helvetica, Courier, and Times Roman, though for these it can prefer a different font (see the examples in the 'Substitutes' PDFs at zarniwhoop.uk.)

Many people will find the Liberation fonts useful for pages where one of those fonts is requested.

Microsoft Core Fonts

The Microsoft Core Fonts date from 2002. They were supplied with old versions of Microsoft Windows and were apparently made available for general use. You can extract them from the '.exe' files using bsd-tar from libarchive-3.7.1. Make sure that you read the license before using them. At one time some of these fonts (particularly Arial, Times New Roman, and to a lesser extent Courier New) were widely used on web pages. The full set contains Andale Mono, Arial, Arial Black, Comic Sans MS, Courier New, Georgia, Impact, Times New Roman, Trebuchet MS, Verdana and Webdings.

Please note that if you only want to use a font with the same metrics (character size, etc) as Arial, Courier New, or Times New Roman you can use the libre Liberation Fonts (above), and similarly you can replace Georgia with Gelasio.

Although many old posts recommend installing these fonts for output which looks better, there are more recent posts that these are 'ugly' or 'broken'. One suggestion is that they do not support anti-aliasing.

The newer fonts which Microsoft made their defaults in later releases of MS Windows or MS Office (Calibri and Cambria) have never been freely available. However, if you do not have them installed you can find metric equivalents (Carlito and Caladea) above.

Noto fonts

The Noto fonts ('No Tofu', i.e. avoiding boxes with dots [hex digits] when a glyph cannot be found) are a set of fonts which aim to cover every glyph in Unicode, no matter how obscure. Noto Sans is the preferred font for KDE Plasma and applications, except for monospace fonts where Hack is preferred.

People using languages written in Latin, Greek or Cyrillic alphabets only need to install Noto Sans itself, and perhaps Noto Sans Symbols for currency symbols. For more details on the organization of Noto fonts see how are noto fonts organized. There are also separate fonts for every other current writing system, but these will also require Noto Sans (or Noto Serif) and perhaps Noto Symbols.

It may be easier to download a specific Noto font by going to Noto Sans and changing the font name as appropriate, with '+' between each word, e.g. 'Noto+Kufi+Arabic', 'Noto+Serif+Georgian' or whatever, then clicking on 'Download family'.

However, you should be aware that fontconfig knows nothing about Noto fonts. The 'Noto Sans Something' fonts are each treated as separate fonts (and for Arabic there is not a specific Sans name), so if you have other fonts installed then the choice of which font to use for missing glyphs where 'Noto Sans' is specified will be random, except that Sans fonts will be preferred over known Serif and Monospace fonts because Sans is the fallback for unknown fonts.

Source Code Pro

This set of fonts from Adobe (seven different weights) includes what is now the preferred monospace font for those applications which use gsettings-desktop-schemas-44.0. The github release source-code-pro contains OTF (preferred) and TTF as well as the source and WOFF fonts.

To use this in terminals, you probably will only want the Regular font.

There is also an older TTF version of this available from Google fonts but that has very limited coverage (adequate for most European languages using a Latin alphabet).

CJK fonts:

As indicated earlier, usage of a combination of Chinese, Japanese and Korean characters can be tricky - each font only covers a subset of the available codepoints, the preferred shapes of the glyphs can differ between the languages, and many of the CJK fonts do not actually support modern Korean.

Also, fontconfig prefers Chinese to Japanese by default. Tuning that is covered at Prefer chosen CJK fonts.

Although Unicode has been extended to allow a very large number of CJK codepoints, those outside the Base Plane (greater than U+0xFFFF) are not commonly used in Mandarin (the normal form of written Chinese, whether Simplified (Mainland China, Malaysia, and Singapore) or Traditional (Hong Kong and Taiwan)), or Japanese.

For Hong Kong, which uses Traditional Chinese and where Cantonese is the dominant language, the Hong Kong Supplementary Character Set was added to Unicode in 2005 and revised in 2009 (it is part of CJK Extension B and contains more than 1900 characters). Earlier fonts will not be able to support either Cantonese or use these characters where local names are written in Mandarin. The UMing HK, Noto Sans HK and WenQuanYi Zen Hei fonts all seem to cover Hong Kong usage (fontconfig disagrees about Noto Sans HK).

The Han glyphs are double width, and other glyphs in the same font may be narrower. For their CJK content, all of these fonts can be regarded as monospaced (i.e. fixed width).

If you wish to use Noto fonts, there are also Serif versions of their various CJK fonts. The Noto Sans/Serif SC/TC/HK/JP/KR fonts are derived from a monolithic noto-cjk repository and you can find the .ttc files for the entire Noto Sans CJK (including SC/TC/HK/JP/KR) or Noto Serif CJK font family there. Google recommends the normal users to use the separate Noto Sans/Serif SC/TC/HK/JP/KR fonts instead, but if you are capable and willing to read texts in more than one CJK character systems it may be easier to use a monolithic .ttc file for full coverage.

If all you wish to do is render CJK glyphs, installing WenQuanYi ZenHei may be a good place to start if you do not already have a preference.

Chinese fonts:

In Chinese, there are three font styles in common use: Sung (also known as Song or Ming), which is the most-common ornamented ("serif") form, Kai ("brush strokes") which is an earlier ornamented style that looks quite different, and modern Hei ("sans"). Unless you appreciate the differences, you probably do not want to install Kai fonts.

The current versions of Chinese Noto Sans fonts can be found at Noto Sans SC for Simplified Chinese, Noto Sans TC for Traditional Chinese, and as mentioned above Noto Sans HK for use in Hong Kong.

Opendesktop fonts

A copy of version 1.4.2 of the opendesktop-fonts is preserved at Arch. This was a later development of fireflysung which BLFS used to recommend, adding Kai and Mono fonts. The name of the Sung font remains 'AR PL New Sung' so they cannot both be installed together.

At one time there was a 1.6 release, and more recently some versions at github, which also included a Sans font (Odohei), but those have dropped off the web and it is unclear if there was a problem. Fontconfig does not know anything about the later fonts (AR PL New Kai, AR PL New Sung Mono) and will default to treating them as Sans.

UMing

UMing fonts – sets of Chinese Ming fonts (from Debian, use the '.orig' tarball) in a ttc which contain variations of Simplified and Traditional Chinese (Taiwanese, with second variant for different bopomofo, and Cantonese for Hong Kong). This ships with old-syntax files which you can install to /etc/fonts/conf.d/ but see Editing Old-Style conf files.

WenQuanYi Zen Hei

WenQuanYi Zen Hei provides a Sans-Serif font which covers all CJK scripts including Korean. Although it includes old-style conf files, these are not required: fontconfig will already treat these fonts (the 'sharp' contains bitmaps, the monospace appears not to be Mono in its ASCII part) as Sans, Serif, and Monospace. If all you wish to do is to be able to render Han and Korean text without worrying about the niceties of the shapes used, the main font from this package is a good font to use.

Japanese fonts:

In Japanese, Gothic fonts are Sans, and Mincho are Serif. BLFS used to only mention the Kochi fonts, but those appear to now be the least-preferred of the Japanese fonts.

Apart from the fonts detailed below, also consider Noto Sans JP.

IPAex fonts

The IPAex fonts are the current version of the IPA fonts. Use Google Translate on the home page, then click on the download link for IPAex Font Ver.004.01. Unfortunately, fontconfig only knows about the older IPAfonts and the forked IPA Mona font (which is not easily available and which apparently does not meet Debian's Free Software guidelines). If you install the IPAex fonts, you may want to make it known to fontconfig. Please see Prefer chosen CJK fonts for one way to accomplish this.

Kochi fonts

The Kochi Substitute fonts were the first truly libre Japanese fonts (the earlier Kochi fonts were allegedly plagiarized from a commercial font).

VL Gothic

The VL Gothic font is a modern Japanese font in two variants with monotonic or proportional spacing for the non-Japanese characters.

Korean fonts:

In Korean, Batang or Myeongjo (the older name) are Serif, Dotum or Gothic and are the main Sans fonts. BLFS previously recommended the Baekmuk fonts, but the Nanum and Un fonts are now preferred to Baekmuk by fontconfig because of user requests.

A convenient place to see examples of these and many other Korean fonts is Free Korean Fonts. Click on 'Gothic Fonts' or 'All Categories -> Myeongjo Fonts', then click on the font example to see more details including the License, and click on the link to download it. For Nanum, you will need to be able to read Korean to find the download link on the page you get to. For Un there are direct links and you can find the un-fonts-core tarball in the releases/ directory.

Alternatively, consider Noto Sans KR or WenQuanYi ZenHei.

Xorg Legacy

Introduction to Xorg Legacy

Xorg's ancestor (X11R1, in 1987) at first only provided bitmap fonts, with a tool (bdftopcf) to assist in their installation. With the introduction of xorg-server-1.19.0 and libXfont2 many people will not need them. There are still a few old packages which might require, or benefit from, these deprecated fonts and so the following packages are shown here.

Note

The font-adobe-100dpi package installs 100 dots per inch versions of Courier, Helvetica, New Century Schoolbook and Times fonts.

The remaining font packages here provide 75dpi versions of those fonts, and various miscellaneous fonts - mostly for legacy encodings. Those are primarily to silence warnings when testing Xorg. In previous versions of BLFS a lot more legacy fonts were installed.

Please consult the BLFS-7.10 systemd book at https://www.linuxfromscratch.org/blfs/view/7.10-systemd/x/x7font.html if you wish to install any of those other fonts.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Xorg Legacy Dependencies

Required

Xorg Fonts

Downloading Xorg Legacy

First, create a list of files to be downloaded. This file will also be used to verify the integrity of the downloads when complete:

cat > legacy.dat << "EOF"
e09b61567ab4a4d534119bba24eddfb1 util/ bdftopcf-1.1.1.tar.xz
20239f6f99ac586f10360b0759f73361 font/ font-adobe-100dpi-1.0.4.tar.xz
2dc044f693ee8e0836f718c2699628b9 font/ font-adobe-75dpi-1.0.4.tar.xz
2c939d5bd4609d8e284be9bef4b8b330 font/ font-jis-misc-1.0.4.tar.xz
6300bc99a1e45fbbe6075b3de728c27f font/ font-daewoo-misc-1.0.4.tar.xz
fe2c44307639062d07c6e9f75f4d6a13 font/ font-isas-misc-1.0.4.tar.xz
145128c4b5f7820c974c8c5b9f6ffe94 font/ font-misc-misc-1.1.3.tar.xz
EOF

To download the needed files using Wget-1.21.4, use the following commands:

mkdir legacy &&
cd    legacy &&
grep -v '^#' ../legacy.dat | awk '{print $2$3}' | wget -i- -c \
     -B https://www.x.org/pub/individual/ &&
grep -v '^#' ../legacy.dat | awk '{print $1 " " $3}' > ../legacy.md5 &&
md5sum -c ../legacy.md5

Installation of Xorg Legacy

Note

When installing multiple packages in a script, the installation needs to be done as the root user. There are three general options that can be used to do this:

  1. Run the entire script as the root user (not recommended).

  2. Use the sudo command from the Sudo-1.9.14p3 package.

  3. Use su -c "command arguments" (quotes required) which will ask for the root password for every iteration of the loop.

One way to handle this situation is to create a short bash function that automatically selects the appropriate method. Once the command is set in the environment, it does not need to be set again.

as_root()
{
  if   [ $EUID = 0 ];        then $*
  elif [ -x /usr/bin/sudo ]; then sudo $*
  else                            su -c \\"$*\\"
  fi
}

export -f as_root

First, start a subshell that will exit on error:

bash -e

Install all of the packages by running the following commands:

for package in $(grep -v '^#' ../legacy.md5 | awk '{print $2}')
do
  packagedir=${package%.tar.?z*}
  tar -xf $package
  pushd $packagedir
    ./configure $XORG_CONFIG
    make
    as_root make install
  popd
  rm -rf $packagedir
  as_root /sbin/ldconfig
done

Finally, exit the shell that was started earlier:

exit

Contents

Installed Programs: bdftopcf
Installed Libraries: None
Installed Directories: $XORG_PREFIX/share/fonts/100dpi, $XORG_PREFIX/share/fonts/75dpi, $XORG_PREFIX/share/fonts/misc

Short Descriptions

bdftopcf

converts an X font from Bitmap Distribution Format to Portable Compiled Format

Chapter 25. Graphical Environment Libraries

This chapter does not contain libraries that are required to run X. It does contain libraries that enhance X. In some cases the enhancement is as simple as font support. In others it is as complex as libraries that sit between X and applications that run on X whose purpose is to standardize the look and feel and inter-process communications for different applications. They also assist programmers by supplying common elements.

Atkmm-2.28.3

Introduction to Atkmm

Atkmm is the official C++ interface for the ATK accessibility toolkit library.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Atkmm Dependencies

Required

at-spi2-core-2.48.3 and GLibmm-2.66.5

Installation of Atkmm

Install Atkmm by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Contents

Installed Programs: None
Installed Library: libatkmm-1.6.so
Installed Directories: /usr/{include,lib}/atkmm-1.6 and /usr/share/{devhelp/books/atkmm-1.6,doc/atkmm-2.28.3}

Short Descriptions

libatkmm-1.6.so

contains the ATK API classes

at-spi2-core-2.48.3

Introduction to At-Spi2 Core

The At-Spi2 Core package contains a comprehensive accessibility framework for the Assistive Technologies available on the GNOME platform. This includes a set of interfaces which are implemented by other toolkits and applications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

At-Spi2 Core Dependencies

Required

dbus-1.14.8, GLib-2.76.4, gsettings-desktop-schemas-44.0 (Runtime), and Xorg Libraries

Optional (Required if building GNOME)

gobject-introspection-1.76.1

Optional

Gi-DocGen-2023.1 and sphinx-7.1.2

Installation of At-Spi2 Core

Install At-Spi2 Core by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

The test suite also requires the glib schemas of the package to be installed already. To test the results, install the package first, then issue: dbus-run-session ninja test. One test, atk-test, is known to timeout on some systems.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Ddocs=true: Use this switch if you want to build the documentation. Note that you must have both Gi-DocGen-2023.1 and sphinx-7.1.2 installed on your system.

Contents

Installed Programs: None
Installed Library: libatk-1.0.so, libatk-bridge-2.0.so, libatspi.so, and /usr/lib/gtk-2.0/modules/libatk-bridge.so
Installed Directories: /usr/include/atk-1.0, /usr/include/at-spi-2.0, /usr/include/at-spi2-atk, /usr/lib/gnome-settings-daemon-3.0, /usr/share/defaults/at-spi2, and /usr/share/gtk-doc/html/libatspi (optional)

Short Descriptions

libatk-1.0.so

contains functions that are used by assistive technologies to interact with desktop applications

libatk-bridge.so

contains the Accessibility Toolkit GTK+-2 bridge

libatk-bridge-2.0.so

contains the Accessibility Toolkit GTK+ module

libatspi.so

contains the At-Spi2 API functions

Cairo-1.17.6

Introduction to Cairo

Cairo is a 2D graphics library with support for multiple output devices. Currently supported output targets include the X Window System, win32, image buffers, PostScript, PDF and SVG. Experimental backends include OpenGL, Quartz and XCB file output. Cairo is designed to produce consistent output on all output media while taking advantage of display hardware acceleration when available (e.g., through the X Render Extension). The Cairo API provides operations similar to the drawing operators of PostScript and PDF. Operations in Cairo include stroking and filling cubic Bézier splines, transforming and compositing translucent images, and antialiased text rendering. All drawing operations can be transformed by any affine transformation (scale, rotation, shear, etc.).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Cairo Dependencies

Required

libpng-1.6.40 and Pixman-0.42.2

Recommended
Optional

ghostscript-10.01.2, GTK+-3.24.38 and GTK+-2.24.33, GTK-Doc-1.33.2, libdrm-2.4.115, librsvg-2.56.3, libxml2-2.10.4, LZO-2.10, Mesa-23.1.6, Poppler-23.08.0, Valgrind-3.21.0, jbig2dec, libspectre, and Skia

Note

There is a circular dependency between cairo and harfbuzz. If cairo is built before harfbuzz, it is necessary to rebuild cairo after harfbuzz in order to build pango.

Installation of Cairo

Adapt this package for Binutils-2.39 or later:

sed 's/PTR/void */' -i util/cairo-trace/lookup-symbol.c

Fix a pkg-config file that may cause errors later:

sed -e "/@prefix@/a exec_prefix=@exec_prefix@" \
    -i util/cairo-script/cairo-script-interpreter.pc.in

Install Cairo by running the following commands:

./configure --prefix=/usr    \
            --disable-static \
            --enable-tee &&
make

This package does not have a working test suite.

Now, as the root user:

make install

Command Explanations

--enable-tee: This switch enables the experimental tee surface backend which is required if using system-installed Cairo with Mozilla applications.

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-xlib-xcb: This switch enables several experimental Xlib/XCB functions used by some window managers.

--enable-gl: This switch enables Cairo's experimental OpenGL surface which is required for Wayland compositor and some other packages that are not part of BLFS.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to create and install the documentation.

Contents

Installed Programs: cairo-trace
Installed Libraries: libcairo.so, libcairo-gobject.so and libcairo-script-interpreter.so
Installed Directories: /usr/{include,lib,share/gtk-doc/html}/cairo

Short Descriptions

cairo-trace

generates a log of all calls made by an application to Cairo

libcairo.so

contains the 2D graphics functions required for rendering to the various output targets

libcairo-gobject.so

contains functions that integrate Cairo with Glib's GObject type system

libcairo-script-interpreter.so

contains the script interpreter functions for executing and manipulating Cairo execution traces

libcairomm-1.0 (cairomm-1.14.0)

Introduction to libcairomm-1.0

The libcairomm-1.0 package provides a C++ interface to Cairo.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libcairomm-1.0 Dependencies

Required

Cairo-1.17.6 and libsigc++-2.12.0

Recommended
Optional

Doxygen-1.9.7

Installation of libcairomm-1.0

Install Cairomm-1.0 by running the following commands:

mkdir bld &&
cd    bld &&

meson setup ..            \
      --prefix=/usr       \
      --buildtype=release \
      -Dbuild-tests=true  \
      -Dboost-shared=true &&
ninja

To run the test suite, run: ninja test.

Now, as the root user:

ninja install

Command Explanations

-Dbuild-tests=true: This switch is for building the unit tests. Remove if you have not installed Boost-1.83.0.

-Dboost-shared=true: This switch has the package use the shared version of boost libraries. It is required if you have not installed the boost static libraries, and you have passed -Dbuild-tests=true.

-Dbuild-documentation=true: This switch builds the html documentation if doxygen is installed.

Contents

Installed Programs: None
Installed Library: libcairomm-1.0.so
Installed Directories: /usr/{lib,include}/cairomm-1.0 and /usr/share/{devhelp/books,doc}/cairomm-1.0 (optional)

Short Descriptions

libcairomm-1.0.so

contains the Cairo API classes

Cogl-1.22.8

Introduction to Cogl

Cogl is a modern 3D graphics API with associated utility APIs designed to expose the features of 3D graphics hardware using a direct state access API design, as opposed to the state-machine style of OpenGL.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Cogl Dependencies

Required

Cairo-1.17.6, gdk-pixbuf-2.42.10, GLU-9.0.3, Mesa-23.1.6, Pango-1.50.14, and Wayland-1.22.0

Recommended
Optional

gst-plugins-base-1.22.5, GTK-Doc-1.33.2, and SDL2-2.28.2

Installation of Cogl

Install Cogl by running the following commands:

Note

This package may occasionally fail when building with multiple processors. See Using Multiple Processors for more information.

./configure --prefix=/usr  \
            --enable-gles1 \
            --enable-gles2 \
            --enable-{kms,wayland,xlib}-egl-platform \
            --enable-wayland-egl-server              &&
make

All of the tests except for the ES2 and ES2-NPT tests are broken due to slight behavior changes in Mesa. To test the results anyway, issue: make check. The tests should be run from an X terminal on a hardware accelerated Xorg Server. A few tests will use all CPUs in parallel, regardless of parallellism settings.

Now, as the root user:

make install

Command Explanations

--enable-gles1: This switch enables support for OpenGL ES 1.1.

--enable-gles2: This switch enables support for OpenGL ES 2.0.

--enable-{kms,wayland,xlib}-egl-platform: These switches enable support for KMS, Wayland and Xlib EGL platforms. They are required for GNOME Wayland support.

--enable-wayland-egl-server: This switch enables Cogl's Wayland Server API which is required for GNOME Wayland support.

--enable-cogl-gst: This switch enables gstreamer support.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: None
Installed Libraries: libcogl-gles2.so, libcogl-pango.so, libcogl-path.so, and libcogl.so, and optional libraries libcogl-gst.so and /usr/lib/gstreamer-1.0/libgstcogl.so
Installed Directories: /usr/include/cogl and /usr/share/cogl

Short Descriptions

libcogl-gles2.so

is the OpenGL ES 2.0 integration library for Cogl

libcogl-pango.so

is the Pango integration library for Cogl

libcogl.so

is an object oriented GL/GLES Abstraction/Utility Layer library

Clutter-1.26.4

Introduction to Clutter

The Clutter package contains an open source software library used for creating fast, visually rich and animated graphical user interfaces.

This package is known to build and work properly using an LFS 12.0 platform.

Note

Anything built with this toolkit needs hardware 3D acceleration from the graphics driver at runtime. This is provided by Mesa (or by proprietary graphics drivers), but is not available for every graphics card nor for all virtual machines. You may wish to review Checking the DRI installation.

Package Information

Clutter Dependencies

Required

at-spi2-core-2.48.3, Cogl-1.22.8, and JSON-GLib-1.6.6

Recommended
Optional

GTK-Doc-1.33.2 and Tslib

Installation of Clutter

Install Clutter by running the following commands:

./configure --prefix=/usr               \
            --sysconfdir=/etc           \
            --enable-egl-backend        \
            --enable-evdev-input        \
            --enable-wayland-backend    \
            --enable-wayland-compositor &&
make

The test suite is not recommended because some tests may hang forever. If you want to test the results anyway, issue: make -j1 -k check. You must be in an xterm or similar, because it launches some windows. Two tests, actor-destroy 1 /actor/destruction and actor-paint-opacity 1 /actor/opacity/text, are known to fail.

Now, as the root user:

make install

Command Explanations

--enable-egl-backend: This switch enables the experimental EGL windowing backend.

--enable-evdev-input: This switch enables the experimental Evdev input backend which is required for GNOME Wayland support.

--enable-wayland-backend and --enable-wayland-compositor: These switches enable the experimental Wayland API in Clutter which is required for GNOME Wayland support.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: None
Installed Library: libclutter-1.0.so and libclutter-glx-1.0.so
Installed Directories: /usr/include/clutter-1.0 and /usr/share/gtk-doc/html/{cally,clutter}

Short Descriptions

libclutter-1.0.so

contains the Clutter API functions

clutter-gst-3.0.27

Introduction to Clutter Gst

The Clutter Gst package contains an integration library for using GStreamer with Clutter. Its purpose is to implement the ClutterMedia interface using GStreamer.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Clutter Gst Dependencies

Required

Clutter-1.26.4, gst-plugins-base-1.22.5, and libgudev-238

Recommended
Optional

GTK-Doc-1.33.2 and Cgc

Installation of Clutter Gst

Install Clutter Gst by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Library: libclutter-gst-3.0.so and /usr/lib/gstreamer-1.0/libcluttergst3.so
Installed Directories: /usr/include/clutter-gst-3.0 and /usr/share/gtk-doc/html/clutter-gst-3.0

Short Descriptions

libclutter-gst-3.0.so

contains the Clutter Gst API functions

clutter-gtk-1.8.4

Introduction to Clutter Gtk

The Clutter Gtk package is a library providing facilities to integrate Clutter into GTK+ applications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Clutter Gtk Dependencies

Required

Clutter-1.26.4 and GTK+-3.24.38

Recommended
Optional

GTK-Doc-1.33.2

Installation of Clutter Gtk

Install Clutter Gtk by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: None
Installed Library: libclutter-gtk-1.0.so
Installed Directories: /usr/include/clutter-gtk-1.0 and /usr/share/gtk-doc/html/clutter-gtk-1.0

Short Descriptions

libclutter-gtk-1.0.so

contains the Clutter Gtk API functions

colord-gtk-0.3.0

Introduction to Colord GTK

The Colord GTK package contains GTK+ bindings for Colord.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Colord GTK Dependencies

Required

colord-1.4.6 and GTK+-3.24.38

Recommended
Optional

DocBook-utils-0.6.14 and GTK-Doc-1.33.2

Installation of Colord GTK

Warning

If building the documentation ninja -j1 must be used.

Install Colord GTK by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dgtk2=true         \
            -Dgtk4=true         \
            -Dvapi=true         \
            -Ddocs=false        \
            -Dman=false         \
            ..                  &&
ninja

To test the results, issue: ninja test. The tests need to be run from an X session, and may require a color profile for your primary display.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dvapi=true: This switch enables building of the Vala bindings. Remove this switch if you don't have Vala-0.56.11 installed.

-Dgtk2=true: This switch enables building the GTK+-2 bindings for colord.

-Dgtk4=true: This switch enables building the GTK-4 bindings for colord. Set this option to 'false' if you do not have GTK-4.12.0 installed.

-Ddocs=false: This switch disables building gtk-doc based documentation. Even if gtk-doc is installed, you will need the namespaced versions of the Docbook XSL stylesheets.

-Dman=false: This switch disables generating the manual pages for this package. Remove this switch if you have namespaced versions of the Docbook XSL stylesheets installed.

Contents

Installed Programs: cd-convert
Installed Libraries: libcolord-gtk.so, libcolord-gtk2.so, and libcolord-gtk4.so
Installed Directories: /usr/include/colord-1/colord-gtk and /usr/share/gtk-doc/html/colord-gtk

Short Descriptions

cd-convert

is a Color Manager Testing Tool

libcolord-gtk.so

contains the Colord GTK+ bindings

libcolord-gtk2.so

contains the Colord GTK+-2 bindings

libcolord-gtk4.so

contains the Colord GTK-4 bindings

FLTK-1.3.8

Introduction to FLTK

FLTK (pronounced "fulltick") is a cross-platform C++ GUI toolkit. FLTK provides modern GUI functionality and supports 3D graphics via OpenGL and its built-in GLUT emulation libraries used for creating graphical user interfaces for applications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

FLTK Dependencies

Required

Xorg Libraries

Recommended
Optional

alsa-lib-1.2.9, desktop-file-utils-0.26, Doxygen-1.9.7, GLU-9.0.3, Mesa-23.1.6, and texlive-20230313 (or install-tl-unx)

Installation of FLTK

Note

The tar extraction directory is fltk-1.3.8 and not fltk-1.3.8-source as indicated by the tarball name.

Install FLTK by running the following commands:

sed -i -e '/cat./d' documentation/Makefile       &&

./configure --prefix=/usr    \
            --enable-shared  &&
make

If you wish to create the API documentation, issue:

make -C documentation html

The tests for the package are interactive. To execute the tests, run test/unittests. In addition, there are 70 other executable test programs in the test directory that can be run individually.

Now, as the root user:

make docdir=/usr/share/doc/fltk-1.3.8 install

If desired, install some example games built as a part of the tests, extra documentation and example programs. As the root user:

make -C test          docdir=/usr/share/doc/fltk-1.3.8 install-linux &&
make -C documentation docdir=/usr/share/doc/fltk-1.3.8 install-linux

Command Explanations

sed ... documentation/Makefile: Avoid installing pages in /usr/share/man/cat*.

Contents

Installed Programs: blocks, checkers, fltk-config, fluid, and sudoku
Installed Libraries: libfltk.{a,so}, libfltk_forms.{a,so}, libfltk_gl.{a,so}, and libfltk_images.{a,so}
Installed Directories: /usr/include/FL and /usr/share/doc/fltk-1.3.8

Short Descriptions

blocks

is a FLTK-based block elimination game

checkers

is a FLTK-based version of the game of checkers

fltk-config

is a utility script that can be used to get information about the current version of FLTK that is installed on the system

fluid

is an interactive GUI designer for FLTK

sudoku

is an implementation of the popular Sudoku game

libfltk.so

contains functions that provide an API to implement graphical user interfaces

Freeglut-3.4.0

Introduction to Freeglut

Freeglut is intended to be a 100% compatible, completely opensourced clone of the GLUT library. GLUT is a window system independent toolkit for writing OpenGL programs, implementing a simple windowing API, which makes learning about and exploring OpenGL programming very easy.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Freeglut Dependencies

Required

CMake-3.27.2 and Mesa-23.1.6

Recommended

Installation of Freeglut

Install Freeglut by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr       \
      -DCMAKE_BUILD_TYPE=Release        \
      -DFREEGLUT_BUILD_DEMOS=OFF        \
      -DFREEGLUT_BUILD_STATIC_LIBS=OFF  \
      -Wno-dev .. &&

make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

-DFREEGLUT_BUILD_DEMOS=OFF: Disable building optional demo programs. Note that if you choose to build them, their installation must be done manually. The demo programs are limited and installation is not recommended.

-DFREEGLUT_BUILD_STATIC_LIBS=OFF: Do not build the static library.

Contents

Installed Programs: None
Installed Library: libglut.so
Installed Directories: /usr/lib/cmake/FreeGLUT

Short Descriptions

libglut.so

contains functions that implement the OpenGL Utility Toolkit

gdk-pixbuf-2.42.10

Introduction to Gdk Pixbuf

The Gdk Pixbuf package is a toolkit for image loading and pixel buffer manipulation. It is used by GTK+ 2 and GTK+ 3 to load and manipulate images. In the past it was distributed as part of GTK+ 2 but it was split off into a separate package in preparation for the change to GTK+ 3.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Gdk Pixbuf Dependencies

Required

GLib-2.76.4, libjpeg-turbo-3.0.0, libpng-1.6.40, and shared-mime-info-2.2

Recommended
Optional (Required if building GNOME)

gobject-introspection-1.76.1

Optional

gdk-pixbuf-xlib-2.40.2 (runtime dependency, needed for loading XPM images), Gi-DocGen-2023.1 (to generate documentation), libavif-0.11.1 (runtime dependency, needed for loading AVIF images), and webp-pixbuf-loader-0.2.4 (runtime dependency, needed for loading WebP images)

Installation of Gdk Pixbuf

Install Gdk Pixbuf by running the following commands:

mkdir build &&
cd    build &&

meson setup ..            \
      --prefix=/usr       \
      --buildtype=release \
      --wrap-mode=nofallback &&
ninja

If you have Gi-DocGen-2023.1 installed and wish to build the API documentation for this package, issue:

sed "/docs_dir =/s@\$@ / 'gdk-pixbuf-2.42.10'@" -i ../docs/meson.build &&
meson configure -Dgtk_doc=true                                         &&
ninja

To test the results, issue: ninja test. The tests make a heavy use of disk.

Now, as the root user:

ninja install

Note

If you installed the package on to your system using a DESTDIR method, an important file was not installed and should be copied and/or generated. Generate it using the following command as the root user:

gdk-pixbuf-query-loaders --update-cache

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

--wrap-mode=nofallback: This switch prevents meson from using subproject fallbacks for any dependency declarations in the build files, stopping it downloading any optional dependency which is not installed on the system.

-Dman=false: Use this option if you do not want to generate manual pages, or if you do not want to install docutils-0.20.1.

Contents

Installed Programs: gdk-pixbuf-csource, gdk-pixbuf-pixdata, gdk-pixbuf-query-loaders, and gdk-pixbuf-thumbnailer
Installed Libraries: libgdk_pixbuf-2.0.so
Installed Directories: /usr/{include,lib}/gdk-pixbuf-2.0, /usr/libexec/installed-tests/gdk-pixbuf, /usr/share/installed-tests/gdk-pixbuf, /usr/share/gtk-doc/html/gdk-pixbuf, and /usr/share/thumbnailers

Short Descriptions

gdk-pixbuf-csource

is a small utility that generates C code containing images, used for compiling images directly into programs

gdk-pixbuf-pixdata

is a tool used to convert GdkPixbuf to GdkPixdata

gdk-pixbuf-query-loaders

collects information about loadable modules for Gdk Pixbuf and writes it to the default cache file location, or to stdout

gdk-pixbuf-thumbnailer

creates thumbnails of pictures for use in other applications

libgdk_pixbuf-2.0.so

contains functions used to load and render images

gdk-pixbuf-xlib-2.40.2

Introduction to gdk-pixbuf-xlib

The gdk-pixbuf-xlib package provides a deprecated Xlib interface to gdk-pixbuf, which is needed for some applications which have not been ported to use the new interfaces yet.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

gdk-pixbuf-xlib Dependencies

Required

gdk-pixbuf-2.42.10 and Xorg Libraries

Optional

GTK-Doc-1.33.2

Installation of gdk-pixbuf-xlib

Install gdk-pixbuf-xlib by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Command Explanations

-Dgtk_doc=true: Use this option if GTK-Doc-1.33.2 is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: None
Installed Libraries: libgdk_pixbuf_xlib-2.0.so
Installed Directories: /usr/include/gdk-pixbuf-2.0/gdk-pixbuf-xlib

Short Descriptions

libgdk_pixbuf_xlib-2.0.so

provides a Xlib interface to gdk-pixbuf

GLEW-2.2.0

Introduction to GLEW

GLEW is the OpenGL Extension Wrangler Library.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

glew Dependencies

Required

Mesa-23.1.6

Installation of GLEW

Install GLEW by running the following commands:

sed -i 's%lib64%lib%g' config/Makefile.linux &&
sed -i -e '/glew.lib.static:/d' \
       -e '/0644 .*STATIC/d'    \
       -e 's/glew.lib.static//' Makefile     &&
make

This package does not come with a test suite.

Now, as the root user:

make install.all

Command Explanations

sed -i 's%lib64%lib%g' ...: This ensures that the library is installed in /usr/lib.

sed -i -e '/glew.lib.static:/d' ...: This suppresses the static library.

make install.all: This installs the programs as well as the library.

Contents

Installed Programs: glewinfo and visualinfo
Installed Library: libGLEW.so
Installed Directory: /usr/include/GL

Short Descriptions

glewinfo

provides information about the supported extensions

visualinfo

is an extended version of glxinfo

libGLEW.so

provides functions to access OpenGL extensions

GLU-9.0.3

Introduction to GLU

This package provides the Mesa OpenGL Utility library.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GLU Dependencies

Required

Mesa-23.1.6

Installation of GLU

Install GLU by running the following commands:

mkdir build &&
cd    build &&

meson setup ..              \
      --prefix=$XORG_PREFIX \
      -Dgl_provider=gl      \
      --buildtype=release   &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install &&
rm -vf /usr/lib/libGLU.a

Contents

Installed Programs: None
Installed Library: libGLU.so
Installed Directories: None

Short Descriptions

libGLU.so

is the Mesa OpenGL Utility library

GOffice-0.10.55

Introduction to GOffice

The GOffice package contains a library of GLib/GTK document centric objects and utilities. This is useful for performing common operations for document centric applications that are conceptually simple, but complex to implement fully. Some of the operations provided by the GOffice library include support for plugins, load/save routines for application documents and undo/redo functions.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GOffice Dependencies

Required

GTK+-3.24.38, libgsf-1.14.50, librsvg-2.56.3, libxslt-1.1.38, and Which-2.21

Optional

gobject-introspection-1.76.1, ghostscript-10.01.2, gsettings-desktop-schemas-44.0, GTK-Doc-1.33.2, Lasem, and libspectre

Installation of GOffice

Install GOffice by running the following commands:

./configure --prefix=/usr &&
make

If you wish to run the tests, issue: make check.

Now, as the root user:

make install

Command Explanations

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: None
Installed Libraries: libgoffice-0.10.so
Installed Directories: /usr/include/libgoffice-0.10, /usr/{lib,share}/goffice, and /usr/share/gtk-doc/html/goffice-0.10

Short Descriptions

libgoffice-0.10.so

contains API functions to provide support for document centric objects and utilities

Grantlee-5.3.1

Introduction to grantlee

Grantlee is a set of free software libraries written using the Qt framework. Currently two libraries are shipped with Grantlee: Grantlee Templates and Grantlee TextDocument. The goal of Grantlee Templates is to make it easier for application developers to separate the structure of documents from the data they contain, opening the door for theming.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Grantlee Dependencies

Required

CMake-3.27.2 and (Qt-5.15.10 or qt-alternate-5.15.10)

Optional

Doxygen-1.9.7 (for documentation)

Installation of Grantlee

Install Grantlee by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      .. &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: none
Installed Libraries: libGrantlee_Templates.so and libGrantlee_TextDocument.so
Installed Directories: /usr/lib/cmake/Grantlee5, /usr/lib/grantlee/5.2, and /usr/include/grantlee

Short Descriptions

libGrantlee_Templates.so

contains common documentation templates for separating documents from their structure

libGrantlee_TextDocument.so

contains functions that allow separating the content of text documents from their structure.

Graphene-1.10.8

Introduction to Graphene

The Graphene package provides a thin layer of types for graphics libraries.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Graphene Dependencies

Required

GLib-2.76.4 and gobject-introspection-1.76.1

Installation of Graphene

Install Graphene by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dgtk_doc=true: Use this switch if you have GTK-Doc-1.33.2 installed and wish to generate the API documentation.

Contents

Installed Programs: None
Installed Libraries: libgraphene-1.0.so
Installed Directories: /usr/include/graphene-1.0, /usr/lib/graphene-1.0, /usr/{libexec,share}/installed-tests/graphene-1.0

Short Descriptions

libgraphene-1.0.so

contains functions that provide a thin layer of types for graphics libraries

GTK+-2.24.33

Introduction to GTK+ 2

The GTK+ 2 package contains libraries used for creating graphical user interfaces for applications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GTK+ 2 Dependencies

Required

at-spi2-core-2.48.3, gdk-pixbuf-2.42.10 and Pango-1.50.14

Recommended
Optional

Cups-2.4.6, DocBook-utils-0.6.14, gnome-themes-extra-3.28 (runtime, for Adwaita and HighContrast themes), gobject-introspection-1.76.1 and GTK-Doc-1.33.2

Note

If gobject-introspection-1.76.1 was installed after at-spi2-core-2.48.3, gdk-pixbuf-2.42.10, and/or Pango-1.50.14, those packages will have to be rebuilt before this package can be built.

Installation of GTK+ 2

Install GTK+ 2 by running the following commands:

sed -e 's#l \(gtk-.*\).sgml#& -o \1#' \
    -i docs/{faq,tutorial}/Makefile.in      &&

./configure --prefix=/usr --sysconfdir=/etc &&

make

To test the results, issue: make -k check. Note that you must run the tests from a session with X Window Display capability (i.e., not a text-based terminal/console) as the tests attempt to open an X window, and the tests can take an excessively long time. Using an X Window, the tests should take less than 0.1 SBU. One test, aliasfilescheck.sh, is known to fail.

Now, as the root user:

make install

Note

If you installed the package on to your system using a DESTDIR method, an important file was not installed and must be copied and/or generated. Generate it using the following command as the root user:

gtk-query-immodules-2.0 --update-cache

Command Explanations

sed -i 's#l \(gtk-.*\).sgml#& -o \1#' docs/{faq,tutorial}/Makefile.in: If you have DocBook-utils-0.6.14 installed (specifically, if configure finds db2html) then it will try to use it to rebuild some of its HTML documentation and fail due to bugs in some of the Makefiles. This sed fixes the Makefiles.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Configuring GTK+ 2

Config Files

~/.gtkrc-2.0, /etc/gtk-2.0/gtkrc, and /usr/share/gtk-2.0/gtkrc

Configuration Information

GTK+ 2 themes change the way a GTK+ 2 application looks. A GTK+ 2 icon theme can be used to change the icons that appear on the application's toolbar. If you have installed a GTK+ 2 theme (such as gnome-themes-extra-3.28 or GTK Engines-2.20.2), or a GTK+ icon theme (such as adwaita-icon-theme-44.0) you can set your preferences in ~/.gtkrc-2.0:

cat > ~/.gtkrc-2.0 << "EOF"
include "/usr/share/themes/Glider/gtk-2.0/gtkrc"
gtk-icon-theme-name = "hicolor"
EOF

There are many more themes available at Gnome-Look.org and other places.

Once you've settled on themes you like, you can (as the root user) make them the default system wide:

cat > /etc/gtk-2.0/gtkrc << "EOF"
include "/usr/share/themes/Clearlooks/gtk-2.0/gtkrc"
gtk-icon-theme-name = "elementary"
EOF

LXAppearance-0.6.3 is a GTK+ 2 application that can help you choose the themes you like.

Contents

Installed Programs: gtk-builder-convert, gtk-demo, gtk-query-immodules-2.0, and gtk-update-icon-cache
Installed Libraries: libgailutil.so, libgdk-x11-2.0.so, and libgtk-x11-2.0.so
Installed Directories: /etc/gtk-2.0, /usr/include/{gail-1.0,gtk-2.0,gtk-unix-print-2.0}, /usr/lib/gtk-2.0, /usr/share/doc/gtk+-2.24.33, /usr/share/gtk-2.0, /usr/share/gtk-doc/html/{gail-libgail-util,gdk2,gtk2}, and /usr/share/themes/{Default,Emacs,Raleigh}

Short Descriptions

gtk-builder-convert

converts glade files into XML files which can be loaded with GtkBuilder

gtk-demo

demonstrates GTK+ 2 functionality and provides code for the examples

gtk-query-immodules-2.0

collects information about loadable input method modules for GTK+ 2 and writes it to standard output

gtk-update-icon-cache

creates mmap()able cache files for icon themes. Starting with gtk+-2.24.24, add the flag --include-image-data to this command, if you wish previous behavior, with image data in the cache

libgdk-x11-2.0.so

contains functions that act as a wrapper around the low-level drawing and windowing functions provided by the underlying graphics system

libgtk-x11-2.0.so

contains functions that provide an API to implement graphical user interfaces

GTK+-3.24.38

Introduction to GTK+ 3

The GTK+ 3 package contains libraries used for creating graphical user interfaces for applications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GTK+ 3 Dependencies

Required

at-spi2-core-2.48.3, gdk-pixbuf-2.42.10, libepoxy-1.5.10, and Pango-1.50.14

Recommended
Recommended (Required if building GNOME)
Optional

colord-1.4.6, Cups-2.4.6, GTK-Doc-1.33.2, PyAtSpi2-2.46.0 (for tests), Tracker-3.5.3, and PAPI

Installation of GTK+ 3

Install GTK+ 3 by running the following commands:

mkdir build &&
cd    build &&
meson setup --prefix=/usr           \
            --buildtype=release     \
            -Dman=true              \
            -Dbroadway_backend=true \
            ..                      &&
ninja

To test the results you need a graphical session, then issue dbus-run-session ninja test.

Now, as the root user:

ninja install

Note

If you installed the package on to your system using a DESTDIR method, an important file was not installed and must be copied and/or generated. Generate it using the following command as the root user:

gtk-query-immodules-3.0 --update-cache

Note

If you installed the package to your system using a DESTDIR method, /usr/share/glib-2.0/schemas/gschemas.compiled was not updated/created. Create (or update) the file using the following command as the root user:

glib-compile-schemas /usr/share/glib-2.0/schemas

Command Explanations

-Dbroadway_backend=true: This switch enables the HTML5 GTK backend.

-Dman=true: This switch allows generating manual pages.

-Dgtk_doc=true: This switch enables building documentation. It requires GTK-Doc-1.33.2.

-Dtracker3=true: This switch enables the search function based on Tracker 3 in the GTK+-3 file chooser dialog. It requires Tracker-3.5.3.

Configuring GTK+ 3

Config Files

~/.config/gtk-3.0/settings.ini and /etc/gtk-3.0/settings.ini

Configuration Information

GTK+ 3 themes change the way a GTK+ 3 application looks. An icon theme can be used to change the icons that appear on the application's toolbar. If you have installed a GTK+ 3 theme (e.g. the Adwaita theme built in GTK+ 3), an icon theme (such as oxygen-icons5-5.109.0) and/or a font (Dejavu fonts), you can set your preferences in ~/.config/gtk-3.0/settings.ini, or the default system wide configuration file (as the root user), in /etc/gtk-3.0/settings.ini. For the local user an example is:

mkdir -vp ~/.config/gtk-3.0
cat > ~/.config/gtk-3.0/settings.ini << "EOF"
[Settings]
gtk-theme-name = Adwaita
gtk-icon-theme-name = oxygen
gtk-font-name = DejaVu Sans 12
gtk-cursor-theme-size = 18
gtk-toolbar-style = GTK_TOOLBAR_BOTH_HORIZ
gtk-xft-antialias = 1
gtk-xft-hinting = 1
gtk-xft-hintstyle = hintslight
gtk-xft-rgba = rgb
gtk-cursor-theme-name = Adwaita
EOF

There are many settings keys, some with default values. You can find them at Settings: GTK+ 3 Reference Manual. There are many more themes available at https://www.gnome-look.org/browse/ and other places.

As part of GTK+-3.0's redesign, the scroll bar buttons are no longer visible on the scrollbar in many applications. If this functionality is desired, modify the gtk.css file and restore them using the following command:

cat > ~/.config/gtk-3.0/gtk.css << "EOF"
*  {
   -GtkScrollbar-has-backward-stepper: 1;
   -GtkScrollbar-has-forward-stepper: 1;
}
EOF

Contents

Installed Programs: broadwayd, gtk3-demo, gtk3-demo-application, gtk3-icon-browser, gtk3-widget-factory, gtk-builder-tool, gtk-encode-symbolic-svg, gtk-launch, gtk-query-immodules-3.0, gtk-query-settings, and gtk-update-icon-cache
Installed Libraries: libgailutil-3.so, libgdk-3.so, and libgtk-3.so
Installed Directories: /etc/gtk-3.0, /usr/include/{gail,gtk}-3.0, /usr/{lib,share}/gtk-3.0, and /usr/share/themes/{Default,Emacs}/gtk-3.0

Short Descriptions

broadwayd

provides support for displaying GTK+ 3 applications in a web browser, using HTML5 and web sockets

gtk3-demo

is a simple program that demonstrates some of the tasks that can be done with GTK+ 3

gtk3-demo-application

is a simple GTK+ 3 application

gtk3-icon-browser

is a utility to explore the icons in the current icon theme. It shows icons in various sizes, their symbolic variants where available, as well as a description of the icon and its context

gtk3-widget-factory

is a program to view GTK+ 3 themes and widgets

gtk-builder-tool

performs various operations on GtkBuilder .ui files

gtk-encode-symbolic-svg

converts symbolic SVG icons into specially prepared PNG files. GTK+ 3 can load and recolor these PNGs, just like original SVGs, but loading them is much faster

gtk-launch

launches an application using the given name. The name should match the application desktop file name, as residing in /usr/share/applications, with or without the '.desktop' suffix

gtk-query-immodules-3.0

collects information about loadable input method modules for GTK+ 3 and writes it to the default cache file location, or to standard output

gtk-query-settings

provides a complete listing of all settings related to GTK+ 3

gtk-update-icon-cache

is an icon theme caching utility that creates mmap()able cache files for icon themes

libgailutil-3.so

contains functions that implement the accessibility interfaces defined by the GNOME Accessibility Toolkit

libgdk-3.so

contains functions that act as a wrapper around the low-level drawing and windowing functions provided by the underlying graphics system

libgtk-3.so

contains functions that provide an API to implement graphical user interfaces

GTK-4.12.0

Introduction to GTK 4

The GTK 4 package contains libraries used for creating graphical user interfaces for applications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GTK 4 Dependencies

Required

FriBidi-1.0.13, gdk-pixbuf-2.42.10, graphene-1.10.8, ISO Codes-4.15.0, libepoxy-1.5.10, libxkbcommon-1.5.0, Pango-1.50.14, PyGObject-3.44.1, and wayland-protocols-1.32

Recommended
Recommended (Required if building GNOME)
Optional

colord-1.4.6, Cups-2.4.6, docutils-0.20.1, FFmpeg-6.0 (built with libvpx-1.13.0), Gi-DocGen-2023.1, Highlight-4.7 (runtime, only used by gtk4-demo for syntax highlighting of demo source code), libcloudproviders-0.3.2, sassc-3.6.2, Tracker-3.5.3, cpdb, and vulkan

Installation of GTK 4

First, make some changes from upstream:

sed -e '/glib-object.h/a #include <gdk/gdk.h>'        \
    -e '/ gtk_printer_option/i GDK_AVAILABLE_IN_ALL'  \
    -e '/\*gtk_printer_option/i GDK_AVAILABLE_IN_ALL' \
    -i.orig gtk/print/gtkprinteroptionprivate.h

Install GTK 4 by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr           \
            --buildtype=release     \
            -Dbroadway-backend=true \
            -Dintrospection=enabled \
            .. &&
ninja

If you have Gi-DocGen-2023.1 installed and wish to build the API documentation for this package, issue:

sed "s@'doc'@& / 'gtk-4.12.0'@" -i ../docs/reference/meson.build &&
meson configure -Dgtk_doc=true                                   &&
ninja

To run the tests, issue: dbus-run-session meson test --setup x11. If you are in a Wayland session, replace x11 with wayland. Nine tests are known to fail if Cantrell fonts are not installed. Many tests will fail if ~/.config/gtk-4.0/settings.ini exists and the gtk-modules line is not commented out. On systems with NVIDIA graphics cards, the tests may take significantly longer than the advertised test time.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dbroadway-backend=true: This switch enables the HTML5 GDK backend.

-Dintrospection=enabled: This switch enables using gobject-introspection-1.76.1 to generate GIR bindings of this packages. These bindings are required by GNOME.

-Dcloudproviders=enabled: Use this switch if you have libcloudproviders-0.3.2 installed and wish to enable support for cloud providers in a file chooser window.

-Dsysprof=enabled: Use this switch if you have sysprof-3.48.0 installed and wish to enable tracing support for GTK4-based applications.

-Dtracker=enabled: Use this switch if you have Tracker-3.5.3 installed and wish to use search functionality when running a file chooser.

-Dcolord=enabled: Use this switch if you have colord-1.4.6 installed and wish to use colord with the CUPS printing backend.

-Dman-pages=true: Use this switch if you have docutils-0.20.1 installed and wish to generate the man pages.

Configuring GTK 4

Config Files

~/.config/gtk-4.0/settings.ini and /usr/share/gtk-4.0/settings.ini

Configuration Information

GTK 4 themes change the way a GTK 4 application looks. An icon theme can be used to change the icons that appear on the application's toolbar. If you have installed a GTK 4 theme (e.g. the Adwaita theme built in GTK 4), an icon theme (such as oxygen-icons5-5.109.0) and/or a font (Dejavu fonts), you can set your preferences in ~/.config/gtk-4.0/settings.ini, or the default system-wide configuration file (as the root user), in /usr/share/gtk-4.0/settings.ini. For the local user, an example is:

mkdir -pv ~/.config/gtk-4.0
cat > ~/.config/gtk-4.0/settings.ini << "EOF"
[Settings]
gtk-theme-name = Adwaita
gtk-icon-theme-name = oxygen
gtk-font-name = DejaVu Sans 12
gtk-cursor-theme-size = 18
gtk-xft-antialias = 1
gtk-xft-hinting = 1
gtk-xft-hintstyle = hintslight
gtk-xft-rgba = rgb
gtk-cursor-theme-name = Adwaita
EOF

There are many settings keys, some with default values. You can find them at Settings: GTK 4 Reference Manual.

Contents

Installed Programs: gtk4-broadwayd, gtk4-builder-tool, gtk4-demo, gtk4-demo-application, gtk4-encode-symbolic-svg, gtk4-icon-browser, gtk4-launch, gtk4-node-editor, gtk4-print-editor, gtk4-query-settings, gtk4-update-icon-cache, and gtk4-widget-factory
Installed Libraries: libgtk-4.so
Installed Directories: /usr/include/gtk-4.0, /usr/lib/gtk-4.0, and /usr/share/gtk-4.0

Short Descriptions

gtk4-broadwayd

provides support for displaying GTK 4 applications in a web browser using HTML5 and web sockets

gtk4-builder-tool

performs various operations on GtkBuilder .ui files

gtk4-demo

is a simple program that demonstrates some of the tasks that can be done with GTK 4

gtk4-demo-application

is a simple GTK 4 application which is useful for testing

gtk4-encode-symbolic-svg

converts symbolic SVG icons into special PNG files. GTK 4 can load and recolor these PNGs, just like original SVGs, but loading them is much faster

gtk4-icon-browser

is a utility to explore the icons in the current icon theme. It shows icons in various sizes, their symbolic variants when available, as well as a description of the icon and its context

gtk4-launch

launches an application using the given name. The name should match the application .desktop file name (as seen in /usr/share/applications), with or without the '.desktop' extension

gtk4-node-editor

is a utility to show and edit render node files. Such render node files can be obtained e.g. from the GTK inspector

gtk4-print-editor

is a simple program to demonstrate printing using GTK 4 applications

gtk4-query-settings

provides a complete listing of all settings related to GTK 4

gtk4-update-icon-cache

is an icon theme caching utility that creates mmap()able cache files for icon themes

gtk4-widget-factory

is a program to view GTK 4 themes and widgets

libgtk-4.so

contains functions that provide an API to implement graphical user interfaces

GTK Engines-2.20.2

Introduction to GTK Engines

The GTK Engines package contains eight themes/engines and two additional engines for GTK2.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GTK Engines Dependencies

Required

GTK+-2.24.33

Optional

Lua-5.4.6 and Which-2.21 (required for test suite)

Installation of GTK Engines

Install GTK Engines by running the following commands:

./configure --prefix=/usr &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--enable-lua --with-system-lua: Use these switches if you installed Lua and want to build Lua theming engine.

Contents

Installed Programs: None
Installed Libraries: libclearlooks.so, libcrux-engine.so, libglide.so, libhcengine.so, libindustrial.so, libmist.so, libredmond95.so and libthinice.so (GTK-2 engines libraries)
Installed Directories: /usr/lib/gtk-2.0/2.10.0/engines, /usr/share/gtk-engines, /usr/share/themes/Clearlooks, /usr/share/themes/Crux, /usr/share/themes/Industrial, /usr/share/themes/Mist, /usr/share/themes/Redmond and /usr/share/themes/ThinIce
Installed Themes: Clearlooks, Crux, Industrial, Mist, Redmond and ThinIce

Short Descriptions

engine libraries

are manager systems for specific themes

Gtkmm-3.24.8

Introduction to Gtkmm

The Gtkmm package provides a C++ interface to GTK+ 3.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Gtkmm Dependencies

Required

Atkmm-2.28.3, GTK+-3.24.38, and Pangomm-2.46.3

Optional

Doxygen-1.9.7

Installation of Gtkmm

Install Gtkmm by running the following commands:

mkdir gtkmm3-build &&
cd    gtkmm3-build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test. Note that you must be in a graphical environment, as the tests try to open some windows.

Now, as the root user:

ninja install

If you have built the documentation (see Command Explanations below) it was installed to /usr/share/doc/gtkmm-3.0. For consistency, move it to a versioned directory as the root user:

mv -v /usr/share/doc/gtkmm-3.0 /usr/share/doc/gtkmm-3.24.8

Command Explanations

-Dbuild-documentation=true: If you have installed Doxygen-1.9.7 this define will build and install the documentation.

Contents

Installed Programs: None
Installed Libraries: libgdkmm-3.0.so and libgtkmm-3.0.so
Installed Directories: /usr/include/gdkmm-3.0, /usr/include/gtkmm-3.0, /usr/lib/gdkmm-3.0, /usr/lib/gtkmm-3.0, and optionally /usr/share/{devhelp/books/gtkmm-3.0,doc/gtkmm-3.24.8}

Short Descriptions

libgdkmm-3.0.so

contains the GDK API classes

libgtkmm-3.0.so

contains the GTK+ 3 API classes

gtk-vnc-1.3.1

Introduction to Gtk VNC

The Gtk VNC package contains a VNC viewer widget for GTK+. It is built using coroutines allowing it to be completely asynchronous while remaining single threaded.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Gtk VNC Dependencies

Required

GnuTLS-3.8.1, GTK+-3.24.38, and libgcrypt-1.10.2

Recommended
Optional

Cyrus SASL-2.1.28 and PulseAudio-16.1

Installation of Gtk VNC

Install Gtk VNC by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Command Explanations

-Dwith-vala=false: This switch disables building of the Vala bindings. Add this if you decide to build gtk-vnc without vala installed.

Contents

Installed Program: gvnccapture
Installed Libraries: libgtk-vnc-2.0.so, libgvnc-1.0.so and libgvncpulse-1.0.so
Installed Directories: /usr/include/gtk-vnc-2.0, /usr/include/gvnc-1.0 and /usr/include/gvncpulse-1.0

Short Descriptions

gvnccapture

is used to capture image from VNC server

libgtk-vnc-2.0.so

contains the GTK+ 3 bindings for Gtk VNC

libgvnc-1.0.so

contains the GObject bindings for Gtk VNC

libgvncpulse-1.0.so

is the PulseAudio bridge for Gtk VNC

gtksourceview-3.24.11

Introduction to GtkSourceView

The GtkSourceView package contains libraries used for extending the GTK+ text functions to include syntax highlighting.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GtkSourceView Dependencies

Required

GTK+-3.24.38

Recommended
Optional

Vala-0.56.11, Valgrind-3.21.0, GTK-Doc-1.33.2, itstool-2.0.7, fop-2.9 (or dblatex), and Glade

Installation of GtkSourceView

Install GtkSourceView by running the following commands:

./configure --prefix=/usr &&
make

To test the results, issue make check. The tests need to be run in a graphical environment.

Now, as the root user:

make install

Command Explanations

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: None
Installed Library: libgtksourceview-3.0.so
Installed Directories: /usr/{include,share,share/gtk-doc/html}/gtksourceview-3.0

Short Descriptions

libgtksourceview-3.0.so

contains function extensions for the GtkTextView widget

gtksourceview4-4.8.4

Introduction to GtkSourceView

The GtkSourceView package contains libraries used for extending the GTK+ text functions to include syntax highlighting.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GtkSourceView Dependencies

Required

GTK+-3.24.38

Recommended
Optional

Vala-0.56.11, Valgrind-3.21.0, GTK-Doc-1.33.2, itstool-2.0.7, fop-2.9 (or dblatex), and Glade

Installation of GtkSourceView

Install GtkSourceView by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue ninja test. The tests need to be run in a graphical environment.

Now, as the root user:

ninja install

Command Explanations

-Dgtk_doc=true: This option is normally used if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: None
Installed Library: libgtksourceview-4.so
Installed Directories: /usr/{include,share,share/gtk-doc/html}/gtksourceview-4

Short Descriptions

libgtksourceview-4.so

contains function extensions for the GtkTextView widget

gtksourceview5-5.8.0

Introduction to GtkSourceView

The GtkSourceView package contains a library used for extending the GTK text functions to include syntax highlighting.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GtkSourceView Dependencies

Required

GTK-4.12.0 and pcre2-10.42

Recommended
Optional

GTK-Doc-1.33.2, sysprof-3.48.0, Vala-0.56.11, Valgrind-3.21.0, and Vulkan

Installation of GtkSourceView

Install GtkSourceView by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

-Dgtk_doc=true: Use this switch if you have GTK-Doc-1.33.2 installed and wish to generate the API documentation.

-Dsysprof=true: Use this switch if you have sysprof-3.48.0 installed and wish to build with sysprof profiler support.

Contents

Installed Programs: None
Installed Libraries: libgtksourceview-5.so
Installed Directories: /usr/include/gtksourceview-5 and /usr/share/gtksourceview-5

Short Descriptions

libgtksourceview-5.so

contains function extensions for the GtkTextView widget

imlib2-1.12.0

Introduction to imlib2

imlib2 is a graphics library for fast file loading, saving, rendering and manipulation.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

imlib2 Dependencies

Required

Xorg Libraries

Recommended
Optional

Doxygen-1.9.7 (for API documentation), libpng-1.6.40, libjpeg-turbo-3.0.0, libtiff-4.5.1, x265-20230215, and libid3tag

Installation of imlib2

Install imlib2 by running the following commands:

./configure --prefix=/usr --disable-static &&
make

This package does not come with a test suite.

Now, as the root user:

make install

If you generated the API documentation, install it as the root user:

install -v -m755 -d            /usr/share/doc/imlib2-1.12.0/html &&
install -v -m644    doc/html/* /usr/share/doc/imlib2-1.12.0/html

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-doc-build: This switch generates the API documentation. Doxygen-1.9.7 must be installed.

Contents

Installed Programs: imlib2_bumpmap, imlib2_colorspace, imlib2_conv, imlib2_grab, imlib2_poly, imlib2_show, imlib2_test, and imlib2_view
Installed Libraries: libImlib2.so and various filters and image loader modules.
Installed Directories: /usr/lib/imlib2, /usr/share/doc/imlib2-1.12.0, and /usr/share/imlib2

Short Descriptions

imlib2_bumpmap

is to test the imlib2 bumpmap function

imlib2_colorspace

is to test the imlib2 colorspace function

imlib2_poly

is to test the imlib2 poly function

imlib2_conv

converts images between formats

imlib2_grab

takes screenshots

imlib2_show

is an imlib2 program test

imlib2_test

is an imlib2 program test

imlib2_view

displays image files

libImlib2.so

provides the functions for programs to handle various image data formats

kColorPicker-0.2.0

Introduction to kColorPicker

kColorPicker is a QToolButton library with a color popup menu, which lets you select colors. The popup menu features a color dialog button which can be used to add custom colors to the popup menu.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

kColorPicker Dependencies

Required

CMake-3.27.2 and (Qt-5.15.10 or qt-alternate-5.15.10)

Installation of kColorPicker

Install kColorPicker by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      .. &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: libkColorPicker.a
Installed Directories: /usr/lib/cmake/kColorPicker

kImageAnnotator-0.6.1

Introduction to kImageAnnotator

kImageAnnotator is a tool for annotating images.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

kImageAnnotator Dependencies

Required

kcolorpicker-0.2.0

Installation of kImageAnnotator

Install kImageAnnotator by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      .. &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: libkImageAnnotator.a
Installed Directories: /usr/include/kImageAnnotator, /usr/lib/cmake/kImageAnnotator, and /usr/share/kImageAnnotator

keybinder-0.3.1

Introduction to keybinder

The keybinder package contains a utility library registering global X keyboard shortcuts.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

keybinder Dependencies

Required

GTK+-2.24.33

Recommended
Optional

GTK-Doc-1.33.2 and Lua-5.4.6 (currently broken because an older lua version is required)

Installation of keybinder

Install keybinder by running the following commands:

./configure --prefix=/usr --disable-lua &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-lua: Use this switch to disable Lua-5.4.6 bindings (currently broken, because older lua version is required).

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: None
Installed Library: libkeybinder.so and /usr/lib/python2.7/site-packages/keybinder/_keybinder.so
Installed Directories: /usr/lib/python2.7/site-packages/keybinder and /usr/share/gtk-doc/html/keybinder

Short Descriptions

libkeybinder.so

is the library that registers global X keyboard shortcuts

keybinder-3.0-0.3.2

Introduction to keybinder-3.0

The keybinder-3.0 package contains a utility library registering global X keyboard shortcuts for GTK+-3.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

keybinder-3.0 Dependencies

Required

GTK+-3.24.38

Recommended
Optional

GTK-Doc-1.33.2

Installation of keybinder-3.0

Install keybinder-3.0 by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: None
Installed Library: libkeybinder-3.0.so
Installed Directories: /usr/include/keybinder-3.0 and /usr/share/gtk-doc/html/keybinder-3.0

Short Descriptions

libkeybinder-3.0.so

is the library that registers global X keyboard shortcuts

libadwaita-1.3.4

Introduction to libadwaita

The libadwaita package provides additional GTK4 UI widgets for use in developing user interfaces. It is used primarily for GNOME applications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libadwaita Dependencies

Required

GTK-4.12.0

Recommended
Optional

Gi-DocGen-2023.1

Installation of libadwaita

Install libadwaita by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

If you have Gi-DocGen-2023.1 installed and wish to build the API documentation for this package, issue:

sed "s/apiversion/'1.3.4'/" -i ../doc/meson.build &&
meson configure -Dgtk_doc=true                    &&
ninja

To test the results, issue: ninja test. The tests must be run from a graphical session.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Programs: adwaita-1-demo
Installed Libraries: libadwaita-1.so
Installed Directories: /usr/include/libadwaita-1

Short Descriptions

adwaita-1-demo

provides an example of how to use the libadwaita library

libadwaita-1.so

provides additional GTK widgets for use in creating user interfaces

libdazzle-3.44.0

Introduction to libdazzle

libdazzle is a companion library to GObject and GTK+ that adds APIs for special graphical effects.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libdazzle Dependencies

Required

GTK+-3.24.38

Recommended

Installation of libdazzle

Install libdazzle by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Program: dazzle-list-counters
Installed Library: libdazzle-1.0.so
Installed Directory: /usr/include/libdazzle-1.0

Short Descriptions

dazzle-list-counters

lists counters that are in use by a process

libdazzle-1.0.so

contains API functions for graphical effects

libgedit-amtk-5.8.0

Introduction to libgedit-amtk

The libgedit-amtk package contains a basic GTKUIManager replacement based on GAction.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libgedit-amtk Dependencies

Required

GTK+-3.24.38

Optional

GTK-Doc-1.33.2 (for documentation) and Valgrind-3.21.0

Installation of libgedit-amtk

Install libgedit-amtk by running the following commands:

mkdir amtk-build &&
cd    amtk-build &&

meson setup ..              \
      --prefix=/usr         \
      --buildtype=release   \
      -Dgtk_doc=false       &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dgtk_doc=false: This switch prevents the build system from generating and installing the API documentation. Omit this switch if you have GTK-Doc-1.33.2 installed and wish to generate and install the API documentation.

Contents

Installed Programs: None
Installed Libraries: libgedit-amtk-5.so
Installed Directories: /usr/include/libgedit-amtk-5 and /usr/share/gtk-doc/html/libgedit-amtk-5.0

Short Descriptions

libgedit-amtk-5.so

provides a basic GTKUIManager replacement API based on GAction

libgedit-gtksourceview-299.0.4

Introduction to libgedit-gtksourceview

The libgedit-gtksourceview package provides a library that extends GtkTextView. This library adds support for syntax highlighting, undo/redo, file loading and saving, search and replace, a completion system, printing, displaying line numbers, and other features typical of a source code editor.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libgedit-gtksourceview Dependencies

Required

GTK+-3.24.38 and libxml2-2.10.4

Optional

GTK-Doc-1.33.2

Installation of libgedit-gtksourceview

Install libgedit-gtksourceview by running the following commands:

mkdir build-libgedit &&
cd    build-libgedit &&

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dgtk_doc=false     \
            .. &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dgtk_doc=false: Disables building the API documentation. Remove if you have GTK-Doc-1.33.2 installed and wish to build the API documentation.

Contents

Installed Programs: None
Installed Libraries: libgedit-gtksourceview-300.so
Installed Directories: /usr/include/libgedit-gtksourceview-300 and /usr/share/libgedit-gtksourceview-300

Short Descriptions

libgedit-gtksourceview-300.so

contains convenience functions for text editing.

libhandy-1.8.2

Introduction to libhandy

The libhandy package provides additional GTK UI widgets for use in developing user interfaces.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libhandy Dependencies

Required

GTK+-3.24.38

Recommended
Optional

GTK-Doc-1.33.2 and Glade

Installation of libhandy

Install libhandy by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test. The tests must be run from a graphical session.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dgtk_doc=true: Use this option if you have GTK-Doc-1.33.2 installed and wish to install the documentation.

Contents

Installed Programs: handy-1-demo
Installed Libraries: libhandy-1.so
Installed Directories: /usr/include/libhandy-1

Short Descriptions

handy-1-demo

provides an example of how to use the libhandy library

libhandy-1.so

provides additional GTK widgets for use in creating user interfaces

Libdrm-2.4.115

Introduction to Libdrm

Libdrm provides a userspace library for accessing the direct rendering manager (DRM) on operating systems that support the ioctl interface. Libdrm is a low-level library, typically used by graphics drivers such as the Mesa DRI drivers, the X drivers, libva and similar projects.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libdrm Dependencies

Recommended
Optional

Cairo-1.17.6 (for tests), CMake-3.27.2 (could be used to find dependencies without pkgconfig files), docbook-xml-4.5, docbook-xsl-nons-1.79.2, docutils-0.20.1, and libxslt-1.1.38 (to build manual pages), libatomic_ops-7.8.0 (required by architectures without native atomic operations), Valgrind-3.21.0, and CUnit (for AMDGPU tests)

Installation of Libdrm

Install libdrm by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=$XORG_PREFIX \
            --buildtype=release   \
            -Dudev=true           \
            -Dvalgrind=disabled   \
            ..                    &&
ninja

To check the results, issue ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dudev=true: This parameter enables support for using Udev instead of mknod.

-Dvalgrind=disabled: This parameter disables building libdrm with valgrind support. This fixes building sysprof and other packages that use libdrm. Change this parameter to "enabled" (or remove it) if you need support for valgrind.

Contents

Installed Programs: None
Installed Libraries: libdrm_amdgpu.so, libdrm_intel.so, libdrm_nouveau.so, libdrm_radeon.so, and libdrm.so
Installed Directories: /usr/include/libdrm and /usr/share/libdrm

Short Descriptions

libdrm_amdgpu.so

contains the AMDGPU specific Direct Rendering Manager functions

libdrm_intel.so

contains the Intel specific Direct Rendering Manager functions

libdrm_nouveau.so

contains the open source nVidia (Nouveau) specific Direct Rendering Manager functions

libdrm_radeon.so

contains the AMD Radeon specific Direct Rendering Manager functions

libdrm.so

contains the Direct Rendering Manager API functions

libepoxy-1.5.10

Introduction to libepoxy

libepoxy is a library for handling OpenGL function pointer management.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libepoxy Dependencies

Required

Mesa-23.1.6

Optional

Doxygen-1.9.7 (for documentation)

Installation of libepoxy

Install libepoxy by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Ddocs=true: If you have Doxygen-1.9.7 installed, add this option to generate additional documentation.

Contents

Installed Programs: None
Installed Libraries: libepoxy.so
Installed Directories: /usr/include/epoxy

Short Descriptions

libepoxy.so

contains API functions for handling OpenGL function pointer management

libglade-2.6.4

Introduction to libglade

The libglade package contains libglade libraries. These are useful for loading Glade interface files in a program at runtime.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libglade Dependencies

Required

libxml2-2.10.4 and GTK+-2.24.33

Optional

Python-2.7.18 and GTK-Doc-1.33.2

Installation of libglade

Install libglade by running the following commands:

sed -i '/DG_DISABLE_DEPRECATED/d' glade/Makefile.in &&
./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check. One of the tests, test-convert, is known to fail.

Now, as the root user:

make install

Command Explanations

sed -i '/DG_DISABLE_DEPRECATED/d': Some of the glib functions that libglade uses were declared deprecated in glib-2.30. This sed removes the G_DISABLE_DEPRECATED CFLAG.

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Program: libglade-convert (requires python)
Installed Library: libglade-2.0.so
Installed Directories: /usr/{include/libglade-2.0/glade,share/{gtk-doc/html/libglade, xml/libglade}}

Short Descriptions

libglade-convert

is used to convert old Glade interface files to Glade-2.0 standards

libglade-2.0.so

contains the functions necessary to load Glade interface files

libnotify-0.8.2

Introduction to libnotify

The libnotify library is used to send desktop notifications to a notification daemon, as defined in the Desktop Notifications spec. These notifications can be used to inform the user about an event or display some form of information without getting in the user's way.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libnotify Dependencies

Required

GTK+-3.24.38

Optional (Required if building GNOME)

gobject-introspection-1.76.1

Optional

Gi-DocGen-2023.1 and xmlto-0.0.28

Required (runtime)

notification-daemon-3.20.0 or xfce4-notifyd-0.8.2

Note

GNOME Shell and KDE KWin provide their own notification daemons.

Installation of libnotify

Install libnotify by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dgtk_doc=false     \
            -Dman=false         \
            ..                  &&
ninja

This package does not come with a test suite.

If you have Gi-DocGen-2023.1 installed and wish to build the API documentation for this package, issue:

sed "/docs_dir =/s@\$@ / 'libnotify'@" \
    -i ../docs/reference/meson.build   &&
meson configure -Dgtk_doc=true         &&
ninja

Now, as the root user:

ninja install &&
mv -v /usr/share/doc/libnotify{,-0.8.2}

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Program: notify-send
Installed Library: libnotify.so
Installed Directories: /usr/include/libnotify and /usr/share/gtk-doc/html/libnotify

Short Descriptions

notify-send

is a command used to send notifications

libnotify.so

contains the libnotify API functions

libxklavier-5.4

Introduction to libxklavier

The libxklavier package contains a utility library for X keyboard.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libxklavier Dependencies

Required

GLib-2.76.4, ISO Codes-4.15.0, libxml2-2.10.4 and Xorg Libraries

Recommended
Optional

GTK-Doc-1.33.2 and Vala-0.56.11

Installation of libxklavier

Install libxklavier by running the following commands:

./configure --prefix=/usr --disable-static &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-gtk-doc: This parameter is normally used if GTK-Doc is installed and you wish to rebuild and install the API documentation. It is broken for this package due to the use of a long deprecated gtk-doc program that is no longer available.

Contents

Installed Programs: None
Installed Library: libxklavier.so
Installed Directories: /usr/include/libxklavier and /usr/share/gtk-doc/html/libxklavier

Short Descriptions

libxklavier.so

contains XKB utility functions

Pango-1.50.14

Introduction to Pango

Pango is a library for laying out and rendering text, with an emphasis on internationalization. It can be used anywhere that text layout is needed, though most of the work on Pango so far has been done in the context of the GTK+ widget toolkit.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Pango Dependencies

Required

Fontconfig-2.14.2 (must be built with FreeType-2.13.1 using HarfBuzz-8.1.1), FriBidi-1.0.13, and GLib-2.76.4

Recommended
Optional

Cantarell fonts (for tests), sysprof-3.48.0, Gi-DocGen-2023.1 (to generate documentation), help2man, and libthai

Installation of Pango

First work around a bug in gcc-13 which triggers a false warning that breaks a release build:

sed -i '/array-bounds/d' meson.build

Install Pango by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr          \
            --buildtype=release    \
            --wrap-mode=nofallback \
            ..                     &&
ninja

If you have Gi-DocGen-2023.1 installed and wish to build the API documentation for this package, issue:

sed "/docs_dir =/s@\$@ / 'pango-1.50.14'@" -i ../docs/meson.build &&
meson configure -Dgtk_doc=true                                    &&
ninja

To test the results, issue: ninja test. One test, test-font is known to fail. Some tests may fail if no Opentype or Truetype fonts are installed in /usr/share/fonts.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dintrospection=disabled: Use this switch if you do not want to use gobject-introspection-1.76.1.

--wrap-mode=nofallback: This switch prevents meson from using subproject fallbacks for any dependency declarations in the build files, stopping it downloading any optional dependency which is not installed on the system.

Configuring Pango

Config Files

/etc/pango/pangorc, ~/.pangorc and the file specified in the environment variable PANGO_RC_FILE

Contents

Installed Programs: pango-list, pango-segmentation, and pango-view
Installed Libraries: libpango-1.0.so, libpangocairo-1.0.so, libpangoft2-1.0.so, and libpangoxft-1.0.so
Installed Directories: /usr/include/pango-1.0 and /usr/share/doc/pango-1.50.14 (if gi-docgen is available)

Short Descriptions

pango-list

displays a list of fonts that Pango can use that are currently installed on the system

pango-segmentation

shows text segmentation as determined by Pango.

pango-view

renders a given text file through Pango for viewing purposes

libpango-1.0.so

contains low level layout rendering routines, a high level driver for laying out entire blocks of text, and routines to assist in editing internationalized text

Pangomm-2.46.3

Introduction to Pangomm

The Pangomm package provides a C++ interface to Pango.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Pangomm Dependencies

Required

libcairomm-1.14.0, GLibmm-2.66.5 and Pango-1.50.14

Installation of Pangomm

Install Pangomm by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Contents

Installed Programs: None
Installed Library: libpangomm-1.4.so
Installed Directories: /usr/include/pangomm-1.4, /usr/lib/pangomm-1.4, and /usr/share/{devhelp/books/pangomm-1.4,doc/pangomm-2.46.3}

Short Descriptions

libpangomm-1.4.so

contains the Pango API classes

Qt-5.15.10

Introduction to Qt5

Qt5 is a cross-platform application framework that is widely used for developing application software with a graphical user interface (GUI) (in which cases Qt5 is classified as a widget toolkit), and also used for developing non-GUI programs such as command-line tools and consoles for servers. Two of the major users of Qt are KDE Frameworks 5 (KF5) and LXQt.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Qt5 Dependencies

Required

Xorg Libraries

Recommended
Optional

BlueZ-5.68 (for sdpscanner, and at runtime for QtConnectivity module), GTK+-3.24.38, ibus-1.5.28, libinput-1.23.0, MariaDB-10.11.4 or MySQL, MIT Kerberos V5-1.21.2, mtdev-1.1.6 pciutils-3.10.0, PostgreSQL-15.4, PulseAudio-16.1, SDL2-2.28.2, unixODBC-2.3.12, assimp, Flite, Firebird, FreeTDS, libproxy, OpenAL, speech-dispatcher, tslib, and Vulkan

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/qt5

Setting the installation prefix

Installing in /opt/qt5

The BLFS editors recommend installing Qt5 in a directory other than /usr, ie /opt/qt5. To do this, set the following environment variable:

export QT5PREFIX=/opt/qt5

Tip

Sometimes, the installation paths are hardcoded into installed files. This is the reason why /opt/qt5 is used as installation prefix instead of /opt/qt-5.15.10. To create a versioned Qt5 directory after the installation is complete, you may rename the directory and create a symlink:

mkdir -pv /opt/qt-5.15.10
ln -sfnv qt-5.15.10 /opt/qt5

Later on, you may want to install other versions of Qt5. To do that, just remove the symlink and use /opt/qt5 as the prefix again. Which version of Qt5 you use depends only on where the symlink points.

Note

If qca-2.3.7 has been installed and you are reinstalling or updating this package, then qca will need to be reinstalled.

Installation of Qt5

Warning

If Qt5 is being reinstalled into the same directory as an existing instance, run the commands done by root, such as make install, from a console or non-Qt5 based window manager. It overwrites Qt5 libraries that should not be in use during the install process.

Caution

If you did not install some of the recommended dependencies, examine ./configure --help output to check how to disable them or use internal versions bundled in the source tarball.

Note

The build time and space required for the full Qt5 is quite long. The instructions below do not build the tutorials and examples. Removing the -nomake line will create a complete build.

Note

The BLFS editors do not recommend installing Qt5 into the /usr hierarchy because it becomes difficult to find components and to update to a new version. If you do want to install Qt5 in /usr, the directories need to be specified explicitly. In this case, set QT5PREFIX=/usr and add the following to the configure arguments below:

            -archdatadir    /usr/lib/qt5                \
            -bindir         /usr/bin                    \
            -plugindir      /usr/lib/qt5/plugins        \
            -importdir      /usr/lib/qt5/imports        \
            -headerdir      /usr/include/qt5            \
            -datadir        /usr/share/qt5              \
            -docdir         /usr/share/doc/qt5          \
            -translationdir /usr/share/qt5/translations \
            -examplesdir    /usr/share/doc/qt5/examples

First apply a patch to pull in the fixes curated by kde for those modules which are required by packages mentioned in this book:

patch -Np1 -i ../qt-everywhere-opensource-src-5.15.10-kf5-1.patch

The patch is supposed to be used in a git repository, because the behavior of the configure command below is changed in this case. It is enough to create a .git directory in the qmake directory, where the configure script is run:

mkdir -pv qtbase/.git

Add another fix for building with GCC-13:

sed -e "/pragma once/a#include <cstdint>"                                      \
    -i qtlocation/src/3rdparty/mapbox-gl-native/include/mbgl/util/geometry.hpp \
       qtlocation/src/3rdparty/mapbox-gl-native/include/mbgl/util/string.hpp   \
       qtlocation/src/3rdparty/mapbox-gl-native/src/mbgl/gl/stencil_mode.hpp

Install Qt5 by running the following commands:

./configure -prefix $QT5PREFIX                        \
            -sysconfdir /etc/xdg                      \
            -confirm-license                          \
            -opensource                               \
            -dbus-linked                              \
            -openssl-linked                           \
            -system-harfbuzz                          \
            -system-sqlite                            \
            -nomake examples                          \
            -no-rpath                                 \
            -journald                                 \
            -skip qtwebengine                         &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Remove references to the build directory from installed library dependency (prl) files by running the following command as the root user:

find $QT5PREFIX/ -name \*.prl \
   -exec sed -i -e '/^QMAKE_PRL_BUILD_DIR/d' {} \;

Install images and create the menu entries for installed applications. The QT5BINDIR variable is used here to point to the directory for the executable programs. If you have changed the bindir above, QT5BINDIR will need to be adjusted below. Be sure that the QT5BINDIR variable is defined in root's environment and as the root user:

QT5BINDIR=$QT5PREFIX/bin

install -v -dm755 /usr/share/pixmaps/                  &&

install -v -Dm644 qttools/src/assistant/assistant/images/assistant-128.png \
                  /usr/share/pixmaps/assistant-qt5.png &&

install -v -Dm644 qttools/src/designer/src/designer/images/designer.png \
                  /usr/share/pixmaps/designer-qt5.png  &&

install -v -Dm644 qttools/src/linguist/linguist/images/icons/linguist-128-32.png \
                  /usr/share/pixmaps/linguist-qt5.png  &&

install -v -Dm644 qttools/src/qdbus/qdbusviewer/images/qdbusviewer-128.png \
                  /usr/share/pixmaps/qdbusviewer-qt5.png &&

install -dm755 /usr/share/applications &&

cat > /usr/share/applications/assistant-qt5.desktop << EOF
[Desktop Entry]
Name=Qt5 Assistant
Comment=Shows Qt5 documentation and examples
Exec=$QT5BINDIR/assistant
Icon=assistant-qt5.png
Terminal=false
Encoding=UTF-8
Type=Application
Categories=Qt;Development;Documentation;
EOF

cat > /usr/share/applications/designer-qt5.desktop << EOF
[Desktop Entry]
Name=Qt5 Designer
GenericName=Interface Designer
Comment=Design GUIs for Qt5 applications
Exec=$QT5BINDIR/designer
Icon=designer-qt5.png
MimeType=application/x-designer;
Terminal=false
Encoding=UTF-8
Type=Application
Categories=Qt;Development;
EOF

cat > /usr/share/applications/linguist-qt5.desktop << EOF
[Desktop Entry]
Name=Qt5 Linguist
Comment=Add translations to Qt5 applications
Exec=$QT5BINDIR/linguist
Icon=linguist-qt5.png
MimeType=text/vnd.trolltech.linguist;application/x-linguist;
Terminal=false
Encoding=UTF-8
Type=Application
Categories=Qt;Development;
EOF

cat > /usr/share/applications/qdbusviewer-qt5.desktop << EOF
[Desktop Entry]
Name=Qt5 QDbusViewer
GenericName=D-Bus Debugger
Comment=Debug D-Bus applications
Exec=$QT5BINDIR/qdbusviewer
Icon=qdbusviewer-qt5.png
Terminal=false
Encoding=UTF-8
Type=Application
Categories=Qt;Development;Debugger;
EOF

Some packages such as VLC-3.0.18 look for certain executables with a -qt5 suffix. Run the following command as the root user to create the necessary symlinks:

for file in moc uic rcc qmake lconvert lrelease lupdate; do
  ln -sfrvn $QT5BINDIR/$file /usr/bin/$file-qt5
done

Command Explanations

sed ...: Allows using Python 3 instead of Python 2. This command destroys the build for QtWebEngine, so do not use it if you remove the -skip qtwebengine switch.

-confirm-license: Accept license without prompting user during configuration.

-opensource: Install the opensource version of Qt.

-nomake examples: This switch disables building of the example programs included in the source tarball. Remove it if you want to build them.

-system-sqlite: This switch enables use of the system version of SQLite.

-dbus-linked -openssl-linked: These switches enable explicit linking of the D-Bus and OpenSSL libraries into Qt5 libraries instead of dlopen()-ing them.

-journald: This switch allows to send Qt messages to the journald logging system.

-skip qtwebengine: This switch disables building the QtWebEngine. The BLFS editors have chosen to build qtwebengine-5.15.15 separately.

-system-harfbuzz: This switch enables use of the system version of Harfbuzz.

Configuring Qt5

Configuration Information

If Sudo-1.9.14p3 is installed, QT5DIR should be available to the super user as well. Execute the following commands as the root user:

cat > /etc/sudoers.d/qt << "EOF"
Defaults env_keep += QT5DIR
EOF
If you installed Qt5 in /usr

If you installed Qt5 in /usr, create an environment variable needed by certain packages. As the root user:

cat > /etc/profile.d/qt5.sh << "EOF"
# Begin /etc/profile.d/qt5.sh

QT5DIR=/usr
export QT5DIR

# End /etc/profile.d/qt5.sh
EOF
If you did not install Qt5 in /usr

If you installed Qt5 in a location other than /usr, you need to update the following configuration files so that Qt5 is correctly found by other packages and system processes.

As the root user, update the /etc/ld.so.conf file and the dynamic linker's run-time cache file:

cat >> /etc/ld.so.conf << EOF
# Begin Qt addition

/opt/qt5/lib

# End Qt addition
EOF

ldconfig

As the root user, create the /etc/profile.d/qt5.sh file:

cat > /etc/profile.d/qt5.sh << "EOF"
# Begin /etc/profile.d/qt5.sh

QT5DIR=/opt/qt5

pathappend $QT5DIR/bin           PATH
pathappend $QT5DIR/lib/pkgconfig PKG_CONFIG_PATH

export QT5DIR

# End /etc/profile.d/qt5.sh
EOF

Contents

Installed Programs: assistant, balsam, canbusutil, designer, fixqt4headers.pl, lconvert, linguist, lprodump, lrelease, lrelease-pro, lupdate, lupdate-pro, meshdebug, moc, pixeltool, qcollectiongenerator, qdbus, qdbuscpp2xml, qdbusviewer, qdbusxml2cpp, qdistancefieldgenerator, qdoc, qgltf, qhelpgenerator, qlalr, qmake, qml, qmlcachegen, qmleasing, qmlformat, qmlimportscanner, qmllint, qmlmin, qmlplugindump, qmlpreview, qmlprofiler, qmlscene, qmltestrunner, qmltime, qmltyperegistrar, qscxmlc, qtattributionscanner, qtdiag, qtpaths, qtplugininfo, qtwaylandscanner, qvkgen, rcc, repc, sdpscanner, syncqt.pl, tracegen, uic, xmlpatterns, and xmlpatternsvalidator
Installed Libraries: libQt53DAnimation.so, libQt53DCore.so, libQt53DExtras.so, libQt53DInput.so, libQt53DLogic.so, libQt53DQuick.so, libQt53DQuickAnimation.so, libQt53DQuickExtras.so, libQt53DQuickInput.so, libQt53DQuickRender.so, libQt53DQuickScene2D.so, libQt53DRender.so, libQt5AccessibilitySupport.a, libQt5Bluetooth.so, libQt5Bodymovin.so, libQt5Bootstrap.a, libQt5Charts.so, libQt5Concurrent.so, libQt5Core.so, libQt5DataVisualization.so, libQt5DBus.so, libQt5DesignerComponents.so, libQt5Designer.so, libQt5DeviceDiscoverySupport.a, libQt5EdidSupport.a, libQt5EglFSDeviceIntegration.so, libQt5EglFsKmsSupport.so, libQt5EglSupport.a, libQt5EventDispatcherSupport.a, libQt5FbSupport.a, libQt5FontDatabaseSupport.a, libQt5Gamepad.so, libQt5GlxSupport.a, libQt5Gui.so,libQt5Help.so, libQt5InputSupport.a, libQt5KmsSupport.a, libQt5LinuxAccessibilitySupport.a, libQt5Location.so, libQt5Multimedia.so, libQt5MultimediaGstTools.so, libQt5MultimediaQuick.so, libQt5MultimediaWidgets.so, libQt5Network.so, libQt5NetworkAuth.so, libQt5Nfc.so, libQt5OpenGLExtensions.a, libQt5OpenGL.so, libQt5PacketProtocol.a, libQt5PlatformCompositorSupport.a, libQt5Positioning.so, libQt5PositioningQuick.so, libQt5PrintSupport.so, libQt5Purchasing.so, libQt5Qml.so, libQt5QmlDebug.a, libQt5QmlDevTools.a, libQt5QmlModels.so, libQt5QmlWorkerScript.so, libQt5Quick.so, libQt5Quick3D.so, libQt5Quick3DAssetImport.so, libQt5Quick3DRender.so, libQt5Quick3DRuntimeRender.so, libQt5Quick3DUtils.so, libQt5QuickControls2.so, libQt5QuickParticles.so, libQt5QuickShapes.so, libQt5QuickTemplates2.so, libQt5QuickTest.so, libQt5QuickWidgets.so, libQt5RemoteObjects.so, libQt5Script.so, libQt5ScriptTools.so, libQt5Scxml.so, libQt5Sensors.so, libQt5SerialBus.so, libQt5SerialPort.so, libQt5ServiceSupport.a, libQt5Sql.so, libQt5Svg.so, libQt5Test.so, libQt5TextToSpeech.so, libQt5ThemeSupport.a, libQt5UiTools.a, libQt5VirtualKeyboard.so, libQt5WaylandClient.so, libQt5WaylandCompositor.so, libQt5WebChannel.so, libQt5WebSockets.so, libQt5WebView.so, libQt5Widgets.so, libQt5X11Extras.so, libQt5XcbQpa.so, libQt5XkbCommonSupport.a, libQt5Xml.so, libQt5XmlPatterns.so, and several plugins under /opt/qt5/{plugins,qml}
Installed Directories: /usr/include/qt5, /usr/lib/qt5, /usr/share/doc/qt5, and /usr/share/qt5 OR /opt/qt5 and /opt/qt-5.15.10

Short Descriptions

assistant

is a tool for presenting on-line documentation

balsam

is a tool to convert 3D scenes from various creation tools to QML format, for use by the new QtQuick 3D library

canbustil

is a tool to deal with arbitrary CAN bus frames. A Controller Area Network (CAN) is a vehicle bus standard designed to allow microcontrollers and devices to communicate with each other in applications without a host computer

designer

is a full-fledged GUI builder. It includes powerful features such as preview mode, automatic widget layout, support for custom widgets, and an advanced property editor

fixqt4headers.pl

is a script to replace all Qt 4 style includes with Qt 5 includes

lconvert

is part of Qt5's Linguist tool chain. It can be used as a standalone tool to convert and filter translation data files

linguist

provides support for translating applications into local languages

lrelease

is a simple command line tool. It reads XML-based translation file in TS format and produces message files used by the application

lrelease-pro

extracts project information from qmake projects and passes it to lrelease

lupdate

finds the translatable strings in the specified source, header and Qt Designer interface files, and stores the extracted messages in translation files to be processed by lrelease

lupdate-pro

reads a Qt project file, an passes the collected information to lupdate

meshdebug

displays information about qtquick-3d mesh files

moc

generates Qt meta object support code

pixeltool

is a desktop magnifier and as you move your mouse around the screen it will show the magnified contents in its window

qcollectiongenerator

processes and converts Qt help files

qdbuscpp2xml

takes a C++ source file and generates a D-Bus XML definition of the interface

qdbus

lists available services, object paths, methods, signals, and properties of objects on a bus

qdbusviewer

is a graphical D-Bus browser

qdbusxml2cpp

is a tool that can be used to parse interface descriptions and produce static code representing those interfaces,

qdistancefieldgenerator

allows a font cache to be pregenerated for Text.QtRendering to speed up an application's startup if the user interface has a lot of text, or multiple fonts, or a large amount of distinct characters, e.g. in CJK writing systems

qdoc

is a tool used by Qt Developers to generate documentation for software projects

qgltf

imports a variety of 3D model formats and exports into fast-to-load, optimized glTF assets embedded into Qt resource files

qhelpgenerator

is a tool used to generate a Qt compressed help file

qlalr

is a tool used to generate code from grammar specifications

qmake

uses information stored in project files to determine what should go in the makefiles it generates

qml

executes a QML file

qmlcachegen

supports the creation of cache files at build time

qmleasing

is a tool used to define the easing curves using an interactive curve editor

qmlformat

formats QML files according to the QML coding conventions

qmlimportscanner

is a tool used to import QML files from a directory

qmllint

is a syntax checker for QML files

qmlmin

removes comments and layout characters from a QML file

qmlplugindump

is a tool to create a qmltypes file

qmlpreview

is a tool used to analyze QML applications

qmlprofiler

is a tool which watches QML and JavaScript files on disk and updates the application live with any changes

qmlscene

is a utility that loads and displays QML documents even before the application is complete

qmltestrunner

is a tool used to make tests

qscxml

converts an input.scxml file to a header and cpp file

qtattributionsscanner

processes qt_attribution.json files in Qt sources

qtdiag

is a tool for reporting diagnostic information about Qt and its environment

qtpaths

is a tool to query Qt path information

qtplugininfo

dumps meta-data about Qt plugins in JSON format

qtwaylandscanner

converts Wayland specfiles to C++ headers and code needed for QtWayland

qvkgen

converts Vulkan specfiles to C++ headers and code

rcc

is a resource compiler used in conjunction with designer

repc

is the Replica Compiler, which generates QObject header files based on an API definition file

sdpscanner

performs a Session Description Protocol scan on a remote device, using the SDP server represented by the local Bluetooth device

syncqt.pl

is a script to create the forwarding headers in the include directories. It is an internal development tool

tracegen

is a trace generator for LTTng or ETW

uic

is a Qt user interface compiler

xmlpatterns

provides support for XPath, XQuery, XSLT, and XML Schema validation

xmlpatternsvalidator

is a tool used to validate XML documents

qt-alternate-5.15.10

Introduction to qt5 (alternate)

Qt5 is a cross-platform application framework that is widely used for developing application software with a graphical user interface (GUI) (in which cases qt5 is classified as a widget toolkit), and also used for developing non-GUI programs such as command-line tools and consoles for servers. Two of the major users of qt are KDE Frameworks 5 (KF5) and LXQt.

Important

The full qt5 package consists of 43 separate components. These instructions use a small subset of the full qt5 installation instructions above. They cover most, but not all, of the components needed to build packages in BLFS. This page, and the next, are provided to reduce the amount of time, space, and dependencies needed to build these packages. They are not recommended if you will build the KDE Frameworks-5.109.0 based Plasma-5.27.7 desktop environment.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

qt5 Dependencies

Required

Xorg Libraries

Recommended
Optional

GTK+-3.24.38, libinput-1.23.0 MariaDB-10.11.4 or MySQL, MIT Kerberos V5-1.21.2, mtdev-1.1.6 PostgreSQL-15.4, and unixODBC-2.3.12

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/qt5

Setting the installation prefix

Installing in /opt/qt5

The BLFS editors recommend installing qt5 in a directory other than /usr, i.e. /opt/qt5. To do this, set the following environment variable:

export QT5PREFIX=/opt/qt5

Tip

Sometimes, the installation paths are hardcoded into installed files. This is the reason why /opt/qt5 is used as installation prefix instead of /opt/qt-5.15.10. To create a versioned qt5 directory after the installation is complete, you may rename the directory and create a symlink:

mkdir -pv /opt/qt-5.15.10
ln -sfnv qt-5.15.10 /opt/qt5

Later on, you may want to install other versions of qt5. To do that, just remove the symlink and use /opt/qt5 as the prefix again. Which version of qt5 you use depends only on where the symlink points.

Installation of qt5

Warning

If qt5 is being reinstalled into the same directory as an existing instance, run the commands done by root, such as make install, from a console or non-qt5 based window manager. It overwrites qt5 libraries that should not be in use during the install process.

Caution

If you did not install some of the recommended dependencies, examine ./configure --help output to check how to disable them or use internal versions bundled in the source tarball.

Note

The BLFS editors do not recommend installing qt5 into the /usr hierarchy because it becomes difficult to find components and to update to a new version. If you do want to install qt5 in /usr, the directories need to be specified explicitly. In this case, set QT5PREFIX=/usr and add the following to the configure arguments below:

            -archdatadir    /usr/lib/qt5                \
            -bindir         /usr/bin                    \
            -plugindir      /usr/lib/qt5/plugins        \
            -importdir      /usr/lib/qt5/imports        \
            -headerdir      /usr/include/qt5            \
            -datadir        /usr/share/qt5              \
            -docdir         /usr/share/doc/qt5          \
            -translationdir /usr/share/qt5/translations \
            -examplesdir    /usr/share/doc/qt5/examples

First, apply a patch to pull in the fixes curated by kde for those modules which are required by packages mentioned in this book:

patch -Np1 -i ../qt-everywhere-opensource-src-5.15.10-kf5-1.patch

The patch is supposed to be used in a git repository, because the behavior of the configure command below is changed in this case. It is enough to create a .git directory in the qmake directory, where the configure script is run:

mkdir -pv qtbase/.git

At this point we want to set up skipping most components. Do that with:

ls -Fd qt* | grep / | sed 's/^/-skip /;s@/@@' > tempconf &&
sed -i -r '/base|tools|x11extras|svg|declarative|wayland/d' tempconf

Now, install qt5 by running the following commands:

./configure -prefix $QT5PREFIX   \
            -sysconfdir /etc/xdg \
            -confirm-license     \
            -opensource          \
            -dbus-linked         \
            -openssl-linked      \
            -system-harfbuzz     \
            -system-sqlite       \
            -nomake examples     \
            -no-rpath            \
            -journald            \
            $(cat tempconf)      \
            &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Remove references to the build directory from installed library dependency (prl) files by running the following command as the root user:

find $QT5PREFIX/ -name \*.prl \
   -exec sed -i -e '/^QMAKE_PRL_BUILD_DIR/d' {} \;

Install images and create the menu entries for installed applications. The QT5BINDIR variable is used here to point to the directory for the executable programs. If you have changed the bindir above, QT5BINDIR will need to be adjusted below. Be sure that the QT5BINDIR variable is defined in root's environment and as the root user:

QT5BINDIR=$QT5PREFIX/bin

install -v -dm755 /usr/share/pixmaps/                  &&

install -v -Dm644 qttools/src/assistant/assistant/images/assistant-128.png \
                  /usr/share/pixmaps/assistant-qt5.png &&

install -v -Dm644 qttools/src/designer/src/designer/images/designer.png \
                  /usr/share/pixmaps/designer-qt5.png  &&

install -v -Dm644 qttools/src/linguist/linguist/images/icons/linguist-128-32.png \
                  /usr/share/pixmaps/linguist-qt5.png  &&

install -v -Dm644 qttools/src/qdbus/qdbusviewer/images/qdbusviewer-128.png \
                  /usr/share/pixmaps/qdbusviewer-qt5.png &&

install -dm755 /usr/share/applications &&

cat > /usr/share/applications/assistant-qt5.desktop << EOF
[Desktop Entry]
Name=Qt5 Assistant
Comment=Shows Qt5 documentation and examples
Exec=$QT5BINDIR/assistant
Icon=assistant-qt5.png
Terminal=false
Encoding=UTF-8
Type=Application
Categories=Qt;Development;Documentation;
EOF

cat > /usr/share/applications/designer-qt5.desktop << EOF
[Desktop Entry]
Name=Qt5 Designer
GenericName=Interface Designer
Comment=Design GUIs for Qt5 applications
Exec=$QT5BINDIR/designer
Icon=designer-qt5.png
MimeType=application/x-designer;
Terminal=false
Encoding=UTF-8
Type=Application
Categories=Qt;Development;
EOF

cat > /usr/share/applications/linguist-qt5.desktop << EOF
[Desktop Entry]
Name=Qt5 Linguist
Comment=Add translations to Qt5 applications
Exec=$QT5BINDIR/linguist
Icon=linguist-qt5.png
MimeType=text/vnd.trolltech.linguist;application/x-linguist;
Terminal=false
Encoding=UTF-8
Type=Application
Categories=Qt;Development;
EOF

cat > /usr/share/applications/qdbusviewer-qt5.desktop << EOF
[Desktop Entry]
Name=Qt5 QDbusViewer
GenericName=D-Bus Debugger
Comment=Debug D-Bus applications
Exec=$QT5BINDIR/qdbusviewer
Icon=qdbusviewer-qt5.png
Terminal=false
Encoding=UTF-8
Type=Application
Categories=Qt;Development;Debugger;
EOF

Some packages such as VLC-3.0.18 look for certain executables with a -qt5 suffix. Run the following command as the root user to create the necessary symlinks:

for file in moc uic rcc qmake lconvert lrelease lupdate; do
  ln -sfrvn $QT5BINDIR/$file /usr/bin/$file-qt5
done

Command Explanations

-confirm-license: Accept license without prompting user during configuration.

-opensource: Install the opensource version of qt.

-nomake examples: This switch disables building of the example programs included in the source tarball. Remove it if you want to build them.

-system-sqlite: This switch enables use of the system version of SQLite.

-system-harfbuzz: This switch enables use of the system version of Harfbuzz.

-dbus-linked -openssl-linked: These switches enable explicit linking of the D-Bus and OpenSSL libraries into qt5 libraries instead of dlopen()-ing them.

-journald: This switch allows to send qt messages to the journald logging system.

$(cat tempconf): This command provides a list of components that should not be built. These entries are in the form of "-skip <component>".

Configuring qt5

Configuration Information

If Sudo-1.9.14p3 is installed, QT5DIR should be available to the super user as well. Execute the following commands as the root user:

cat > /etc/sudoers.d/qt << "EOF"
Defaults env_keep += QT5DIR
EOF
If you installed qt5 in /usr

If you installed qt5 in /usr, create an environment variable needed by certain packages. As the root user:

cat > /etc/profile.d/qt5.sh << "EOF"
# Begin /etc/profile.d/qt5.sh

QT5DIR=/usr
export QT5DIR

# End /etc/profile.d/qt5.sh
EOF
If you did not install qt5 in /usr

If you installed qt5 in a location other than /usr, you need to update the following configuration files so that qt5 is correctly found by other packages and system processes.

As the root user, update the /etc/ld.so.conf file and the dynamic linker's run-time cache file:

cat >> /etc/ld.so.conf << EOF
# Begin Qt addition

/opt/qt5/lib

# End Qt addition
EOF

ldconfig

As the root user, create the /etc/profile.d/qt5.sh file:

cat > /etc/profile.d/qt5.sh << "EOF"
# Begin /etc/profile.d/qt5.sh

QT5DIR=/opt/qt5

pathappend $QT5DIR/bin           PATH
pathappend $QT5DIR/lib/pkgconfig PKG_CONFIG_PATH

export QT5DIR

# End /etc/profile.d/qt5.sh
EOF

Contents

Installed Programs: assistant, designer, fixqt4headers.pl, lconvert, linguist, lprodump, lrelease, lrelease-pro, lupdate, lupdate-pro, moc, pixeltool, qcollectiongenerator, qdbus, qdbuscpp2xml, qdbusviewer, qdbusxml2cpp, qdistancefieldgenerator, qdoc, qhelpgenerator, qlalr, qmake, qml, qmlcachegen, qmleasing, qmlformat, qmlimportscanner, qmllint, qmlmin, qmlplugindump, qmlpreview, qmlprofiler, qmlscene, qmltestrunner, qmltime, qmltyperegistrar, qtattributionscanner, qtdiag, qtpaths, qtplugininfo, qtwaylandscanner, qvkgen, rcc, syncqt.pl, tracegen, and uic
Installed Libraries: libQt5Concurrent.so, libQt5Core.so, libQt5DBus.so, libQt5Designer.so, libQt5DesignerComponents.so, libQt5EglFSDeviceIntegration.so, libQt5EglFsKmsSupport.so, libQt5Gui.so, libQt5Help.so, libQt5Network.so, libQt5OpenGL.so, libQt5PrintSupport.so, libQt5Qml.so, libQt5QmlModels.so, libQt5QmlWorkerScript.so, libQt5Quick.so, libQt5QuickParticles.so, libQt5QuickShapes.so, libQt5QuickTest.so, libQt5WaylandClient.so, libQt5WaylandCompositor.so, libQt5Widgets.so, libQt5X11Extras.so, libQt5XcbQpa.so, libQt5Xml.so, several static libraries, and several plugins under /opt/qt5/{plugins,qml}
Installed Directories: /usr/include/qt5, /usr/lib/qt5, /usr/share/doc/qt5, and /usr/share/qt5 OR /opt/qt5 and /opt/qt-5.15.10

Short Descriptions

See Qt5 Short Descriptions

qt-components-5.15.10

Introduction to qt5 components

These instructions show how to build additional Qt5 components beyond qt-alternate-5.15.10. They are not applicable if the full Qt-5.15.10 package has been built.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

qt5 components Dependencies

Required

qt-alternate-5.15.10

Recommended dependencies for qtimageformats
Recommended dependencies for multimedia

Installation of qt5 components

There are a few extra components needed for different packages in BLFS. These are qtimageformats, qtlocation, qtwebchannel, qtdoc, and qtmultimedia. Only those components specified for a specific package are needed. You only need to build the relevant component(s).

First, apply a patch to pull in the fixes curated by KDE for some of the modules listed above:

patch -Np1 -i ../qt-everywhere-opensource-src-5.15.10-kf5-1.patch

Next, if you are installing qtlocation, fix the build with GCC-13:

sed -e "/pragma once/a#include <cstdint>"                                      \
    -i qtlocation/src/3rdparty/mapbox-gl-native/include/mbgl/util/geometry.hpp \
       qtlocation/src/3rdparty/mapbox-gl-native/include/mbgl/util/string.hpp   \
       qtlocation/src/3rdparty/mapbox-gl-native/src/mbgl/gl/stencil_mode.hpp

Install each desired component by running the following commands:

cd <component>
qmake <component>.pro
make

As the root user:

make install

Remove references to the build directory from installed library dependency (prl) files by running the following command as the root user:

find $QT5DIR/ -name \*.prl \
   -exec sed -i -e '/^QMAKE_PRL_BUILD_DIR/d' {} \;

Contents

Installed Programs: None
Installed Libraries: libQt5<component>.so
Installed Directories: $QTDIR/qml/<component>, $QTDIR/lib/<component>, and $QTDIR/include/<component>

QtWebEngine-5.15.15

Introduction to QtWebEngine

QtWebEngine integrates chromium's web capabilities into Qt. It ships with its own copy of ninja which it uses for the build if it cannot find a system copy, and various copies of libraries from ffmpeg, icu, libvpx, and zlib (including libminizip) which have been forked by the chromium developers.

This package and browsers using it may be useful if you need to use a website designed for google chrome, or chromium, browsers.

Important

Qt-5.15 reached End Of Life on 26 May 2023. Extended lifetime Qt5.15 LTS has been extended until 26th May 2025 for those with subscription licenses. Because qtwebengine uses chromium code under the LGPL, it appears that any new backported CVE fixes for QtWebEngine will be available after Qt makes public releases of its current versions.

Warning

QtWebEngine uses a forked copy of chromium, and is therefore vulnerable to many issues found there. The Qt developers have always preferred to make releases at the same time as the rest of Qt (rather than adding emergency fixes), but with stable versions getting released after the current development version. Now that they are keen to move to Qt6, the 5.15.3 and later Qt-5.15 releases are initially only available to paying customers. QtWebEngine is something of an exception because of its LGPL licence, but getting the git sources (with the forked chromium submodule) to a position where they will successfully build on a current BLFS system can take a lot of effort and therefore updates to the book may be delayed.

It seems likely that future 5.15-series versions will also be released long after the chromium vulnerabilities are known, but fixes for QtWebEngine can be found in git and the editors take the view that known vulnerabilities in browsers should be fixed.

The tarball linked to below was created from the 5.15.15 git branch and the 87-branch of the chromium submodule (which is forked from chromium). See the GIT-VERSIONS file in the tarball for details of the latest commits.

This package is known to build and work properly using an LFS 12.0 platform.

Warning

By default, ninja will use all online CPUs +2 (if at least 4 exist), even if they are not available to the current task because the build terminal has been restricted with 'taskset'. In BLFS, this package takes more time to build than any other. In one example, the build of this package crashed at about the 90 percent point due to an out of memory problem on a system with 24 cores and 32 GB of memory.

To work around this, see the Command Explanations below.

Note

If you are upgrading and have installed a newer version of ICU-73.2 since you last installed Qt-5.15.10, you will need to reinstall Qt5 before upgrading, otherwise the final link of this package will fail with a warning that the version of icu libraries needed by libQt5Core.so may conflict with the version used for this package.

Unusually, the shipped GN build system (used to create the Ninja files) requires a static libstdc++.a although the installed libraries correctly use the shared version. If that static library is not present, the build will fail quite quickly. Please note that if you try to build webengine as part of Qt and the static library is not available, that build will either complete without installing webengine, or else fail during the install (both variants were observed in 5.12.0).

Package Information

Additional Downloads

qtwebengine Dependencies

Required

nodejs-18.17.1, nss-3.92, pciutils-3.10.0, and (Qt-5.15.10 or qt-components-5.15.10 with qtlocation and qtwebchannel)

Recommended

Note

If these packages are not installed, the build process will compile and install its own (perhaps older) version, with the side effect of increasing build and installed disk space and build time.

Optional

libevent-2.1.12, MIT Kerberos V5-1.21.2, pipewire-0.3.77, Poppler-23.08.0, jsoncpp, libsrtp, snappy

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/qtwebengine

Installation of qtwebengine

Apply a patch to fix several issues that can prevent the build from completing, and to force it to use python3:

patch -Np1 -i ../qtwebengine-5.15.15-build_fixes-1.patch

Apply a patch that resolves problems when building with ffmpeg-5 and later:

patch -Np1 -i ../qtwebengine-5.15.15-ffmpeg5_fixes-1.patch

Although the build_fixes patch has ensured that git is not invoked during the build, the build system has labyrinthine rules of byzantine complexity, and in particular trying to build without two .git directories will lead to it eventually falling into unexpected and unbuildable code which references a private header that has not been created. Avoid this by creating the required directories:

mkdir -pv .git src/3rdparty/chromium/.git

Because this version of qtwebengine is aimed at a later release than the current public releases, change it to build for qt-5.15.10 using a sed:

sed -e '/^MODULE_VERSION/s/5.*/5.15.10/' -i .qmake.conf

Now, ensure that the local headers are available when not building as part of the complete Qt-5.15.10:

find -type f -name "*.pr[io]" |
  xargs sed -i -e 's|INCLUDEPATH += |&$$QTWEBENGINE_ROOT/include |'

Next, allow the pulseaudio library to be linked at build time, instead of run time. This also prevents an issue with newer pulseaudio:

sed -e '/link_pulseaudio/s/false/true/' \
    -i src/3rdparty/chromium/media/media_options.gni

Next, fix the build tools so they can be run with Python-3.11+:

sed -e 's/\^(?i)/(?i)^/' \
    -i src/3rdparty/chromium/tools/metrics/ukm/ukm_model.py &&
sed -e "s/'rU'/'r'/" \
    -i src/3rdparty/chromium/tools/grit/grit/util.py

Finally, fix a change in the build system which allows its developers to pass e.g. -j20 to make (for quick tests of some areas) but breaks the build with LFS's use of the NINJAJOBS environment variable:

sed -i 's/NINJAJOBS/NINJA_JOBS/' src/core/gn_run.pro

Install qtwebengine by running the following commands:

mkdir build &&
cd    build &&
qmake .. -- -system-ffmpeg -proprietary-codecs -webengine-icu &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Remove references to the build directory from installed library dependency (prl) files by running the following commands as the root user:

find $QT5DIR/ -name \*.prl \
   -exec sed -i -e '/^QMAKE_PRL_BUILD_DIR/d' {} \;

Command Explanations

qmake: This will build the included copy of ninja if it is not already installed and use it to configure the build.

-- -system-ffmpeg -proprietary-codecs -webengine-icu: If any options are passed to qmake they must come after '--' which must follow '..' that points to the main directory. The options here cause it to use system ffmpeg and system icu. The '-proprietary-codecs' option allows ffmpeg to decode H264 and H265 codecs. If built as part of full Qt5, the system icu is automatically used (only) by Qt5Core if it is available, but unless this option is used webengine will always use its shipped copy of icu, adding time and space to the build.

-webengine-jumbo-build 0: If this is added to the qmake command it will cause the 'Jumbo Build Merge Limit' to be reported as 'no' instead of 8. That turns off the jumbo build. Some distros do that to get a smaller build on some architectures such as MIPS. On x86_64 it might save a little space in the build, but the build time will increase by a very large amount.

-webengine-kerberos: Add this if you have installed MIT Kerberos V5-1.21.2 and wish to connect from a browser using QtWebEngine to a webserver which requires you to connect via kerberos.

NINJAJOBS=4 make: If you patched system ninja in LFS to recognize the NINJAJOBS environment variable, this command will run system ninja with the specified number of jobs (i.e. 4). There are several reasons why you might want to use options like this this:

  • Building on a subset of CPUs allows measuring the build time for a smaller number of processors, and/or running other CPU-intensive tasks at the same time. For an editor on a machine with a lot of CPUs, trying to measure the build time for a 4-CPU machine, NINJAJOBS=4 make will give a reasonable approximation (there is a short period where N+2 python and node jobs run).

  • On a machine with only 4 CPUs online, the default of scheduling N+2 jobs for qtwebengine is slower by between 3% and 7%, probably because of the size of the C++ files and their many includes and templates. Therefore, if in doubt set NINJAJOBS to the number of CPUs.

  • Reducing the number of cores being used on long running, CPU intensive packages may alleviate heat problems.

  • Reducing the number of cores will prevent potential out-of-memory problems on systems that do not have enough memory (or swap) when all cores are active. A suggested approach is to limit the number of cores to about one core for each 1.5 GB of combined RAM and swap space.

Configuring QtWebEngine

Configuration Information

If you are upgrading from an older minor version of this application, for some webpages to load you may need to clear the browser caches, e.g. for falkon they will be found in ~/.cache/falkon/. You will need to do this if the browser starts to render the page and then changes to a blank tab with a message that something went wrong, and a button to Retry. Even after removing the old caches, you may need to retry a few times for each affected tab.

If a browser using this package fails to run and when run from a term it reports 'Trace/breakpoint trap' that is probably a kernel configuration issue - there is no need to rebuild QtWebEngine, see the next section, recompile the kernel and reboot to the new kernel.

Kernel Configuration

This package does not require any of the optional kernel namespace items, but if User namespace is enabled (as happens in some unit files, for hardening) PID namespace must also be enabled. In that case enable the following options in the kernel configuration and recompile the kernel if necessary:

General setup --->
  -*- Namespaces support --->                                       [NAMESPACES]
    # Enable or disable *both* of them:
    [ /*] User namespace                                               [USER_NS]
    [ /*] PID Namespaces                                                [PID_NS]

Contents

Installed Programs: qtwebengine_convert_dict and QtWebEngineProcess (in $QT5DIR/libexec)
Installed Libraries: libQt5Pdf.so, libQt5PdfWidgets.so, libQt5WebEngineCore.so, libQt5WebEngine.so, and libQt5WebEngineWidgets.so
Installed Directories: $QT5DIR/include/QtPdf, $QT5DIR/include/QtPdfWidgets, $QT5DIR/include/QtWebEngine, $QT5DIR/include/QtWebEngineCore, $QT5DIR/include/QtWebEngineWidgets, $QT5DIR/qml/QtWebEngine, and $QT5DIR/translations/qtwebengine_locales

Short Descriptions

qtwebengine_convert_dict

converts hunspell dictionaries (.dic) to chromium format (.bdic)

QtWebEngineProcess

is a libexec program which runs a zygote process (one that listens for spawn requests from a master process and will fork itself in response)

libQtWebEngine.so

provides QML types for rendering web content within a QML application

libQtWebEngineCore.so

provides public API shared by both QtWebEngine and QtWebEngineWidgets

libQtWebEngineWidgets.so

provides a web browser engine as well as C++ classes to render and interact with web content

startup-notification-0.12

Introduction to startup-notification

The startup-notification package contains startup-notification libraries. These are useful for building a consistent manner to notify the user through the cursor that the application is loading.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

startup-notification Dependencies

Required

Xorg Libraries and xcb-util-0.4.1

Installation of startup-notification

Install startup-notification by running the following commands:

./configure --prefix=/usr --disable-static &&
make

This package does not come with a test suite.

Now, as the root user:

make install &&
install -v -m644 -D doc/startup-notification.txt \
    /usr/share/doc/startup-notification-0.12/startup-notification.txt

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Library: libstartup-notification-1.so
Installed Directories: /usr/include/startup-notification-1.0 and /usr/share/doc/startup-notification-0.12

Short Descriptions

libstartup-notification-1.so

provides the functions to assist applications in communicating with the cursor system to provide feedback to the user that the application is loading

Tepl-6.8.0

Introduction to Tepl

The Tepl package contains a library that eases the development of GtkSourceView-based text editors and IDEs.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Tepl Dependencies

Required

gsettings-desktop-schemas-44.0, ICU-73.2, libgedit-amtk-5.8.0, libgeditsourceview-299.0.4, and uchardet-0.0.8

Optional

GTK-Doc-1.33.2 (for documentation) and Valgrind-3.21.0

Installation of Tepl

Install Tepl by running the following commands:

mkdir tepl-build &&
cd    tepl-build &&

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dgtk_doc=false     \
            .. &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dgtk_doc=false: Disables building the API documentation. Remove if you have GTK-Doc-1.33.2 installed and wish to build the API documentation.

Contents

Installed Programs: None
Installed Libraries: libtepl-6.so
Installed Directories: /usr/include/tepl-6 and /usr/share/gtk-doc/html/tepl-6.0

Short Descriptions

libtepl-6.so

contains convenience functions for GtkSourceView4-based programs

WebKitGTK-2.41.91

Introduction to WebKitGTK

The WebKitGTK package is a port of the portable web rendering engine WebKit to the GTK+ 3 and GTK 4 platforms.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://webkitgtk.org/releases/webkitgtk-2.41.91.tar.xz

  • Download MD5 sum: 1140f86d9044fb76be974b65f71737d7

  • Download size: 39 MB

  • Estimated disk space required: 1.2 GB (201 MB installed, add 152 MB for GTK-4)

  • Estimated build time: 35 SBU (for GTK-3, using parallelism=4, add 34 SBU for GTK-4)

WebKitGTK Dependencies

Required

Cairo-1.17.6, CMake-3.27.2, gst-plugins-base-1.22.5, gst-plugins-bad-1.22.5, GTK+-3.24.38, GTK-4.12.0, ICU-73.2, Little CMS-2.14, libgudev-238, libsecret-0.21.0, libsoup-3.4.2, libtasn1-4.19.0, libwebp-1.3.1, Mesa-23.1.6, OpenJPEG-2.5.0, Ruby-3.2.2, SQLite-3.42.0, unifdef-2.12, Which-2.21, and wpebackend-fdo-1.14.2

Recommended
Optional

Gi-DocGen-2023.1, HarfBuzz-8.1.1, Wayland-1.22.0, WOFF2-1.0.2, ccache, Hyphen, libjxl, and libmanette

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/webkitgtk

Installation of WebKitGTK

Installation of WebKitGTK

Important

This package allows building with either GTK-3 or GTK-4, but not both in the same build. The GTK-4 version is needed for packages such as Epiphany-44.6. Other packages, such as Balsa-2.6.4 or Evolution-3.48.4, require the GTK-3 version. Both versions can be installed side by side on the same system. We give build instructions for both cases below, but the only difference is the setting of -DUSE_GTK4

If you want to install the GTK+-3 version of WebKitGTK, run the following commands:

mkdir -vp build &&
cd        build &&

cmake -DCMAKE_BUILD_TYPE=Release  \
      -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_SKIP_RPATH=ON       \
      -DPORT=GTK                  \
      -DLIB_INSTALL_DIR=/usr/lib  \
      -DUSE_LIBHYPHEN=OFF         \
      -DENABLE_GAMEPAD=OFF        \
      -DENABLE_MINIBROWSER=ON     \
      -DENABLE_DOCUMENTATION=OFF  \
      -DUSE_WOFF2=OFF             \
      -DUSE_GTK4=OFF              \
      -DUSE_WPE_RENDERER=ON       \
      -DUSE_JPEGXL=OFF            \
      -DENABLE_BUBBLEWRAP_SANDBOX=ON \
      -Wno-dev -G Ninja ..        &&
ninja

This package does not have a working test suite. However, there is a usable basic graphical web browser in the build directory, build/bin/MiniBrowser. If launching it fails, there is a problem with the build.

Now, as the root user:

ninja install

As the -DENABLE_DOCUMENTATION=OFF option is used, the documentation is not rebuilt nor installed now. If you need the documentation, you can either install Gi-DocGen-2023.1 and remove this option from the cmake command, or install the pre-built documentation instead:

install -vdm755 /usr/share/gtk-doc/html/{jsc-glib,webkit2gtk{,-web-extension}}-4.1 &&
install -vm644  ../Documentation/jsc-glib-4.1/*              \
                /usr/share/gtk-doc/html/jsc-glib-4.1         &&
install -vm644  ../Documentation/webkit2gtk-4.1/*            \
                /usr/share/gtk-doc/html/webkit2gtk-4.1       &&
install -vm644  ../Documentation/webkit2gtk-web-extension-4.1/* \
                /usr/share/gtk-doc/html/webkit2gtk-web-extension-4.1

If you want to install the GTK4 version of WebKitGTK, run the following commands:

rm -rf * .[^.]* &&

cmake -DCMAKE_BUILD_TYPE=Release  \
      -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_SKIP_RPATH=ON       \
      -DPORT=GTK                  \
      -DLIB_INSTALL_DIR=/usr/lib  \
      -DUSE_LIBHYPHEN=OFF         \
      -DENABLE_GAMEPAD=OFF        \
      -DENABLE_MINIBROWSER=ON     \
      -DENABLE_DOCUMENTATION=OFF  \
      -DUSE_WOFF2=OFF             \
      -DUSE_GTK4=ON               \
      -DUSE_JPEGXL=OFF            \
      -DUSE_WPE_RENDERER=ON       \
      -DENABLE_BUBBLEWRAP_SANDBOX=ON \
      -Wno-dev -G Ninja ..        &&
ninja

Now, as the root user:

ninja install

Command Explanations

-DUSE_LIBHYPHEN=OFF: This switch disables the default automatic hyphenation implementation. You need to install Hyphen if you wish to enable it (replacing OFF with ON or just removing the switch).

-DENABLE_DOCUMENTATION=OFF: This switch disables regenerating the documentation. Remove this switch if you have Gi-DocGen-2023.1 installed and wish to regenerate the documentation.

-DENABLE_GAMEPAD=OFF: This switch disables gamepad support. Remove this switch if you have libmanette installed and wish to enable it.

-DENABLE_MINIBROWSER=ON: This switch enables compiling and installing the MiniBrowser.

-DUSE_WPE_RENDERER=ON: This switch uses the WPE renderer, which is recommended by upstream.

-DUSE_JPEGXL=OFF: This switch turns off support for JPEG-XL images. Remove it if you have the optional package libjxl installed.

-DENABLE_BUBBLEWRAP_SANDBOX=ON: This switch enables the Bubblewrap sandbox, which helps mitigate the impact of most security vulnerabilities in this package. Change this switch to OFF if you do not want to install bubblewrap-0.8.0 and xdg-dbus-proxy-0.1.5, but note that this may put you at risk.

-DUSE_SYSTEM_MALLOC=ON: This switch enables building against the system installed malloc.

-DENABLE_GEOLOCATION=OFF: Use this switch if you don't want to install GeoClue-2.7.0.

-DUSE_AVIF=OFF: Use this switch if you don't want to install libavif-0.11.1. Note that you will not have support for AVIF images if you do this.

-DUSE_WOFF2=ON: Use this switch if the optional package WOFF2-1.0.2 is installed. This adds additional support for fonts.

Contents

Installed Program: WebKitWebDriver
Installed Libraries: libjavascriptcoregtk-4.1.so, libjavascriptcoregtk-6.0.so, libwebkit2gtk-4.1.so, and libwebkitgtk-6.0.so
Installed Directories: /usr/include/webkitgtk-4.1, /usr/include/webkitgtk-6.0, /usr/lib{,exec}/webkit2gtk-4.1, /usr/lib{,exec}/webkitgtk-6.0, and /usr/share/gtk-doc/html/{jsc-glib,webkit2gtk{,-web-extension}}-4.1

Short Descriptions

WebKitWebDriver

allows debugging and automation of web pages and browsers

libjavascriptcoregtk-4.1.so

contains core JavaScript API functions used by jsc and libwebkit2gtk-4.1

libjavascriptcoregtk-6.0.so

contains core JavaScript API functions used by jsc and libwebkitgtk-6.0

libwebkit2gtk-4.1.so

contains the WebKit2 API functions

libwebkitgtk-6.0.so

contains the WebKit API functions for GTK-4 applications

Chapter 26. Display Managers

Display Managers are graphical programs used for starting the graphical display (currently, the X server) and providing a login capability for a Window Manager or Desktop Environment.

There are many Display Managers available. Some of the more well known include: gdm, kdm (deprecated), LightDM, lxdm, Slim, and sddm.

Among the Desktop Environments available for Linux you find: Enlightenment, GNOME, Plasma, lxde, LXQt, and xfce.

Choosing a Display Manager or Desktop Environment is highly subjective. The choice depends on the look and feel of the packages, the resources (memory and disk space) required, and the utilities included.

In this chapter, the installation instructions of some Display Managers are presented. Later in the book, you will find other ones, which are provided as part of some Desktop Environments.

GDM-44.1

Introduction to GDM

GDM is a system service that is responsible for providing graphical logins and managing local and remote displays.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GDM Dependencies

Required

AccountsService-23.13.9, DConf-0.40.0, libcanberra-0.30 (built after GTK+-3.24.38), and Linux-PAM-1.5.3

Optional

keyutils-1.6.1

Runtime Dependencies

gnome-session-44.0, gnome-shell-44.3, and Systemd-254

Installation of GDM

It is recommended to have a dedicated user and group to take control of the gdm daemon after it is started. Issue the following commands as the root user:

groupadd -g 21 gdm &&
useradd -c "GDM Daemon Owner" -d /var/lib/gdm -u 21 \
        -g gdm -s /bin/false gdm &&
passwd -ql gdm

Install GDM by running the following commands:

mkdir build &&
cd    build &&

meson setup ..            \
      --prefix=/usr       \
      --buildtype=release \
      -Dgdm-xsession=true \
      -Drun-dir=/run/gdm  &&
ninja

This package does not come with a usable test suite.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dinitial-vt=7: Use this switch to make GDM start on VT7 instead of the first free VT.

-Ddefault-pam-config=lfs: Use this switch if you did not create the /etc/lfs-release file or distribution auto detection will fail and you will be unable to use GDM.

-Dgdm-xsession=true: This enables the installation of the GDM Xsession file.

Configuring GDM

Config Files

/etc/gdm/custom.conf

Configuration Information

The GDM daemon is configured using the /etc/gdm/custom.conf file. Default values are stored in GSettings in the gdm.schemas file. It is recommended that end-users modify the /etc/gdm/custom.conf file because the schemas file may be overwritten when the user updates their system to have a newer version of GDM.

On some systems with NVIDIA GPUs, GDM will hide Wayland sessions by default. This is often done to prevent users from encountering problems with buggy drivers, which can result in system lockups, application crashes, power management problems, and graphics slowdowns. If you have an NVIDIA GPU and still want to try running Wayland sessions anyway, execute the following command as the root user:

ln -s /dev/null /etc/udev/rules.d/61-gdm.rules

Systemd Unit

To start the gdm daemon at boot, enable the previously installed systemd unit by running the following command as the root user:

systemctl enable gdm

Contents

Installed Programs: gdm, gdmflexiserver, and gdm-screenshot
Installed Libraries: libgdm.so and pam_gdm.so (PAM Module)
Installed Directories: /etc/gdm, /usr/include/gdm, /usr/share/gdm, and /usr/share/help/*/gdm

Short Descriptions

gdm

is a login prompt for GNOME

gdm-screenshot

is a screenshot tool for GDM

lightdm-1.32.0

Introduction to Lightdm

The lightdm package contains a lightweight display manager based upon GTK.

This package is known to build and work properly using an LFS 12.0 platform.

Lightdm Package Information

Additional download

Note

The greeter is a program to present a graphical login screen. There are several alternative greeters, but the gtk+ package is the reference implementation. For a list of other greeters, see https://en.wikipedia.org/wiki/LightDM.

Lightdm Dependencies

Required

Exo-4.18.0 (for the greeter), libgcrypt-1.10.2, itstool-2.0.7, Linux-PAM-1.5.3, and Xorg-Server-21.1.8 (Runtime)

Recommended
Optional

AccountsService-23.13.9 (run time), at-spi2-core-2.48.3, GTK-Doc-1.33.2, (Qt-5.15.10 or qt-alternate-5.15.10), libido, and libindicator

Installation of Lightdm

First, create a dedicated user and group to take control of the lightdm daemon after it is started. Issue the following commands as the root user:

groupadd -g 65 lightdm       &&
useradd  -c "Lightdm Daemon" \
         -d /var/lib/lightdm \
         -u 65 -g lightdm    \
         -s /bin/false lightdm

Install lightdm by running the following commands:

./configure --prefix=/usr                 \
            --libexecdir=/usr/lib/lightdm \
            --localstatedir=/var          \
            --sbindir=/usr/bin            \
            --sysconfdir=/etc             \
            --disable-static              \
            --disable-tests               \
            --with-greeter-user=lightdm   \
            --with-greeter-session=lightdm-gtk-greeter \
            --docdir=/usr/share/doc/lightdm-1.32.0 &&
make

This package does not come with a test suite.

Now, as the root user:

make install                                                  &&
cp tests/src/lightdm-session /usr/bin                         &&
sed -i '1 s/sh/bash --login/' /usr/bin/lightdm-session        &&
rm -rf /etc/init                                              &&
install -v -dm755 -o lightdm -g lightdm /var/lib/lightdm      &&
install -v -dm755 -o lightdm -g lightdm /var/lib/lightdm-data &&
install -v -dm755 -o lightdm -g lightdm /var/cache/lightdm    &&
install -v -dm770 -o lightdm -g lightdm /var/log/lightdm

Now build the greeter:

tar -xf ../lightdm-gtk-greeter-2.0.8.tar.gz &&
cd lightdm-gtk-greeter-2.0.8 &&

./configure --prefix=/usr                 \
            --libexecdir=/usr/lib/lightdm \
            --sbindir=/usr/bin            \
            --sysconfdir=/etc             \
            --with-libxklavier            \
            --enable-kill-on-sigterm      \
            --disable-libido              \
            --disable-libindicator        \
            --disable-static              \
            --disable-maintainer-mode     \
            --docdir=/usr/share/doc/lightdm-gtk-greeter-2.0.8 &&
make

Now, as the root user:

make install

Note

If you installed Xorg in /opt, you will need to create a symbolic link so lightdm can find the Xorg server. As the root user:

ln -sf /opt/xorg/bin/Xorg /usr/bin/X

Command Explanations

sed ... /usr/bin/lightdm-session: This command ensures that the initial login via the greeter sources /etc/profile and ~/.bash_profile. Without this, commands that depend on different environment variables may not work as expected.

Configuring lightdm

Config Files

/etc/lightdm/{lightdm,users,keys}.conf

Systemd Unit

Install the lightdm.service unit included in the blfs-systemd-units-20230816 package:

make install-lightdm

Available Sessions

The greeter offers a list of available sessions, depending on the Window Managers and Desktop Environments installed. The list includes sessions which have a corresponding .desktop file installed under /usr/share/xsessions. Most of the Window Managers and Desktop Environments automatically provide those files, but if necessary, you may include a custom one.

Contents

Installed Programs: dm-tool, lightdm, and lightdm-gtk-greeter
Installed Libraries: liblightdm-gobject-1.so
Installed Directories: /etc/lightdm, /etc/apparmor.d, /usr/lib/lightdm, /usr/include/lightdm-gobject-1, /usr/share/help/C/lightdm /usr/share/gtk-doc/html/lightdm-gobject-1, /usr/share/doc/lightdm-gtk-greeter-2.0.8, /var/lib/lightdm, /var/lib/lightdm-data, /var/cache/lightdm, and /var/log/lightdm

Short Descriptions

lightdm

is a display and login manager

lightdm-gtk-greeter

is an auxiliary process that displays the greeter, a graphical user interface that performs user authentication and initiates the selected window manager or display environment

sddm-0.20.0

Introduction to sddm

The sddm package contains a lightweight display manager based upon Qt and QML.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

SDDM Dependencies

Required

CMake-3.27.2, extra-cmake-modules-5.109.0, and (Qt-5.15.10 or qt-alternate-5.15.10)

Recommended

Installation of SDDM

First, create a dedicated user and group to take control of the sddm daemon after it is started. Issue the following commands as the root user:

groupadd -g 64 sddm &&
useradd  -c "sddm Daemon" \
         -d /var/lib/sddm \
         -u 64 -g sddm    \
         -s /bin/false sddm

Install sddm by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DRUNTIME_DIR=/run/sddm     \
      -DBUILD_MAN_PAGES=ON        \
      -DDATA_INSTALL_DIR=/usr/share/sddm \
      -DDBUS_CONFIG_FILENAME=sddm_org.freedesktop.DisplayManager.conf \
      .. &&
make

This package does not come with a test suite.

Now, as the root user:

make install &&
install -v -dm755 -o sddm -g sddm /var/lib/sddm
/usr/bin/sddm --example-config > /etc/sddm.conf

Command Explanations

-DCMAKE_BUILD_TYPE=Release: This switch is used to apply additional compiler optimizations.

-DDBUS_CONFIG_FILENAME=sddm_org.freedesktop.DisplayManager.conf: This switch prevents the file /etc/dbus-1/system.d/org.freedesktop.DisplayManager.conf from being overwritten, as it may be used by other DM's.

-DBUILD_MAN_PAGES=ON: This switch is used to build and install man pages.

Configuring SDDM

Config Files

/etc/sddm.config

Normally, you want to edit this file. For example, if Xorg is installed in /opt, use your preferred editor as the root user to replace the default XauthPath value by /opt/xorg/bin/xauth. Or, as the root user, issue:

sed -i.orig '/ServerPath/ s|usr|opt/xorg|' /etc/sddm.conf

This command will do the substitution and create a copy of the original file with name /etc/sddm.conf.orig.

From now on, we will describe how to modify configurations using sed. Of course, you may instead use your preferred editor as the root user.

For security reasons, you normally want the default ServerArguments=-nolisten tcp, unless a remote machine needs access to the local X server. In that case, as the root user, issue:

sed -i 's/-nolisten tcp//' /etc/sddm.conf

Desktop (Notebook) users, normally want the Num Lock key on (off). For that, as root, issue:

sed -i 's/none/on/' /etc/sddm.conf

for Desktop users. For Notebook users, replace /on/ by /off/ in the command above.

By default, a virtual keyboard is presented for the user. If this is not desired, run as root:

sed -i 's/qtvirtualkeyboard//' /etc/sddm.conf

Boot Script

Enable the pre-installed systemd unit by running the following command as the root user:

systemctl enable sddm

Linux PAM Configuration

Note

The install procedure above installed a set of PAM configuration files. These procedures overwrite them and use versions compatible with a BLFS environment.

If you have built sddm with Linux PAM support, create the necessary configuration files by running the following commands as the root user:

cat > /etc/pam.d/sddm << "EOF" &&
# Begin /etc/pam.d/sddm

auth     requisite      pam_nologin.so
auth     required       pam_env.so

auth     required       pam_succeed_if.so uid >= 1000 quiet
auth     include        system-auth

account  include        system-account
password include        system-password

session  required       pam_limits.so
session  include        system-session

# End /etc/pam.d/sddm
EOF

cat > /etc/pam.d/sddm-autologin << "EOF" &&
# Begin /etc/pam.d/sddm-autologin

auth     requisite      pam_nologin.so
auth     required       pam_env.so

auth     required       pam_succeed_if.so uid >= 1000 quiet
auth     required       pam_permit.so

account  include        system-account

password required       pam_deny.so

session  required       pam_limits.so
session  include        system-session

# End /etc/pam.d/sddm-autologin
EOF

cat > /etc/pam.d/sddm-greeter << "EOF"
# Begin /etc/pam.d/sddm-greeter

auth     required       pam_env.so
auth     required       pam_permit.so

account  required       pam_permit.so
password required       pam_deny.so
session  required       pam_unix.so
-session optional       pam_systemd.so

# End /etc/pam.d/sddm-greeter
EOF

Available Sessions

The greeter offers a list of available sessions, depending on the Window Managers and Desktop Environments installed. The list includes sessions which have a corresponding .desktop file installed under /usr/share/xsessions or /usr/share/wayland-sessions. Most of the Window Managers and Desktop Environments automatically provide those files, but if necessary, you may include a custom one.

Themes

Three themes are installed at /usr/share/sddm/themes: elarun, maldives, and maya. There is also a default theme, which is not present in that directory. You can install other themes in that directory. In order to change the theme, you need to edit /etc/sddm.conf, to change the default (empty) theme, replacing Current= with Current=<new theme>, e.g. Current=maldives.

In order to see the theme without leaving the session, issue:

sddm-greeter --test-mode --theme <theme path>

Contents

Installed Programs: sddm and sddm-greeter
Installed Libraries: None
Installed Directories: $QT5DIR/qml/SddmComponents, /usr/share/sddm, and /var/lib/sddm

Short Descriptions

sddm

is a display and login manager based on Qt libraries.

sddm-greeter

is an auxiliary process that displays the greeter, a graphical user interface that performs user authentication and initiates the selected window manager or display environment.

Chapter 27. Window Managers

Window Managers and Desktop Environments are the primary user interfaces into the X Window System. A window manager is a program that controls the appearance of windows and provides the means by which the user can interact with them. A Desktop Environment provides a more complete interface to the operating system, and provides a range of integrated utilities and applications.

There are many Window Managers available. Some of the more well known ones include fvwm2, Window Maker, AfterStep, Enlightenment, Sawfish, and Blackbox.

The Desktop Environments available for Linux are GNOME, KDE, and XFce.

Choosing a Window Manager or Desktop Environment is highly subjective. The choice depends on the look and feel of the packages, the resources (RAM, disk space) required, and the utilities included. One web site that provides a very good summary of what is available, screenshots, and their respective features is Window Managers for X .

In this chapter, the installation instructions of several Window Managers and one lightweight Desktop Environment are presented. Later in the book, both KDE and GNOME have their own sections.

Fluxbox-1.3.7

Introduction to Fluxbox

The Fluxbox package contains a window manager.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Fluxbox Dependencies

Required

a graphical environment

Optional

dbus-1.14.8 (runtime), FriBidi-1.0.13, and imlib2-1.12.0 (if you wish to use other image formats in addition to XPM)

Installation of Fluxbox

First, fix a build failure when building with gcc-11.1:

sed -i '/text_prop.value > 0/s/>/!=/' util/fluxbox-remote.cc

Install Fluxbox by running the following commands:

./configure --prefix=/usr &&
make

This package does not have a working test suite.

Now, as the root user:

make install

Configuring Fluxbox

Config Files

~/.fluxbox/init, ~/.fluxbox/keys, and ~/.fluxbox/menu

Configuration Information

If Fluxbox is the only Window Manager you want to use, you can start it with an .xinitrc file in your home folder. Be sure to backup your current .xinitrc before proceeding.

echo startfluxbox > ~/.xinitrc

Or alternatively, if you use a login manager like GDM-44.1 or lightdm-1.32.0, and would like to be able to choose Fluxbox at the login prompt, create a fluxbox.desktop file. As root:

mkdir -pv /usr/share/xsessions &&
cat > /usr/share/xsessions/fluxbox.desktop << "EOF"
[Desktop Entry]
Encoding=UTF-8
Name=Fluxbox
Comment=This session logs you into Fluxbox
Exec=startfluxbox
Type=Application
EOF

If you didn't install GDM-44.1 or lightdm-1.32.0 in /usr, then change that command to fit the prefix you chose.

Now create the Fluxbox configuration files:

mkdir -v ~/.fluxbox &&
cp -v /usr/share/fluxbox/init ~/.fluxbox/init &&
cp -v /usr/share/fluxbox/keys ~/.fluxbox/keys

To generate the application menu, first you may wish to run fluxbox-generate_menu -h, in order to choose any <user_options>, then issue:

cd ~/.fluxbox &&
fluxbox-generate_menu <user_options>

Alternately, copy a pregenerated menu:

cp -v /usr/share/fluxbox/menu ~/.fluxbox/menu

Menu items are added by editing ~/.fluxbox/menu. The syntax is explained on the fluxbox man page.

If you want to use an image as your desktop background, copy the theme you like into ~/.fluxbox. Then add a line to make it use the correct image. In the following command, change <theme> for the name of the theme you want and change </path/to/nice/image.ext> to point to the actual image you want to use, where ext must be xpm, if imlib2-1.12.0 is not installed to allow other image formats.

cp -r /usr/share/fluxbox/styles/<theme> ~/.fluxbox/theme &&

sed -i 's,\(session.styleFile:\).*,\1 ~/.fluxbox/theme,' ~/.fluxbox/init &&

[ -f ~/.fluxbox/theme ] &&
echo "background.pixmap: </path/to/nice/image.ext>" >> ~/.fluxbox/theme ||
[ -d ~/.fluxbox/theme ] &&
echo "background.pixmap: </path/to/nice/image.ext>" >> ~/.fluxbox/theme/theme.cfg

In some locales the font specified in the theme may not contain the needed characters. This results in menus with blank items. You can fix this by editing ~/.fluxbox/theme with a text editor and altering it so that it names a suitable font.

Contents

Installed Programs: fluxbox, fbsetbg, fbsetroot, fluxbox-generate_menu, startfluxbox, fbrun, fluxbox-remote, and fluxbox-update_configs
Installed Libraries: None
Installed Directories: /usr/share/fluxbox and ~/.fluxbox

Short Descriptions

fluxbox

is a window manager for X11 based on Blackbox 0.61.0

fbsetbg

is a utility that sets the background image. It requires one of the following at runtime: Esetroot, wmsetbg, feh, hsetroot, chbg, display, qiv, xv, xsri, xli, or xsetbg. It also requires which if Esetroot is found

fbsetroot

is a utility to change root window appearance based on the Blackbox application bsetroot

fluxbox-generate_menu

is a utility that generates a menu by scanning your PATH

startfluxbox

is a session startup script that allows for command executions prior to fluxbox starting

fbrun

displays a run dialog window

fluxbox-remote

provides command line access to key commands for Fluxbox

fluxbox-update_configs

use to manage config files (reload, update, test)

IceWM-3.4.1

Introduction to IceWM

IceWM is a window manager with the goals of speed, simplicity, and not getting in the user's way.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

IceWM Dependencies

Required

CMake-3.27.2, a graphical environment, and gdk-pixbuf-xlib-2.40.2

Optional

asciidoc-10.2.0 (for regenerating the HTML documentation), FriBidi-1.0.13 (for languages written right to left), imlib2-1.12.0, librsvg-2.56.3, libao-1.2.0, libsndfile-1.2.2, and alsa-lib-1.2.9 (for the experimental icesound program)

Installation of IceWM

Install IceWM by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DCFGDIR=/etc               \
      -DENABLE_LTO=ON             \
      -DCONFIG_GDK_PIXBUF_XLIB=ON \
      -DCONFIG_IMLIB2=OFF         \
      -DDOCDIR=/usr/share/doc/icewm-3.4.1  \
      .. &&
make

This package does not have a working test suite.

Now, as the root user:

make install

This package creates two .desktop files in the /usr/share/xsessions/ directory. Both are not needed in a BLFS system, so prevent the extra file showing up as an option in a display manager. As the root user:

rm -v /usr/share/xsessions/icewm.desktop

Command Explanations

-DENABLE_LTO=ON: This option enables Link Time Optimization and is required for this package.

Configuring IceWM

Config Files

~/.icewm/keys, ~/.icewm/menu, and ~/.icewm/preferences, and ~/.icewm/toolbar, and ~/.icewm/winoptions. The default versions are installed in /usr/share/icewm/ and will be used if you have not copied them to ~/.icewm.

Configuration Information

If IceWM is the only Window Manager you want to use, you can start it with an .xinitrc file in your home folder. Be sure to backup your current .xinitrc before proceeding.

echo icewm-session > ~/.xinitrc

Now create the IceWM configuration files:

mkdir -pv ~/.icewm                                      &&
cp -v /usr/share/icewm/keys ~/.icewm/keys               &&
cp -v /usr/share/icewm/menu ~/.icewm/menu               &&
cp -v /usr/share/icewm/preferences ~/.icewm/preferences &&
cp -v /usr/share/icewm/toolbar ~/.icewm/toolbar         &&
cp -v /usr/share/icewm/winoptions ~/.icewm/winoptions

You can now edit these files to meet your requirements. In particular, review the preferences file. You can use Logout -> Restart-IceWM on the main menu to load your changed preferences, but changes to the background only take effect when IceWM is started.

At this point you can either modify the traditional menu files to suit your requirements, or use the newer icewm-menu-fdo described later.

The syntax of the menus is explained in the help files, which you can access by running help from the menu, but some of the detail is out of date and the default selections in the menus (a few old applications on the main menu, everything else on the Programs menu) will benefit from being updated to meet your needs. The following examples are provided to encourage you to think about how you wish to organise your menus. Please note the following:

  • If a program listed in the menu has not been installed, it will not appear when the menu is displayed. Similarly, if the program exists but the specified icon does not, no icon will be displayed in the menu.

  • The icons can be either .xpm or .png files, and there is no need to specify the extension. If the icon is located in the "library" (/usr/share/icewm/icons) there is no need to specify the path.

  • Most programs are in sub-menus, and the main menu will always append entries for windows, help, settings, logout at the bottom.

  • An icon for firefox was copied to the library directory and given a meaningful name. The icon for xine is xine.xpm which was installed to a pixmap directory.

  • The default toolbar is not altered.

If you wish to use this traditional method, there are more examples in previous releases of this book (e.g. BLFS-7.8).

Alternatively, you can create a menu which conforms to the FDO Desktop Menu Specifications, where programs can be found because they have a .desktop file in the XDG_DATA_HOME or XDG_DATA_DIR directories. Unlike most windowmanagers, icewm does not search for programs when the menu is invoked, so if you take this route you will need to rerun the following command after installing or removing programs:

icewm-menu-fdo >~/.icewm/menu

If you wish to put icons on your desktop, you will need to install a program such as Rox-Filer-2.11 which provides a pinboard. If you do that you will no longer be able to access the menu by right-clicking on the desktop, you will have to use the IceWM button. To ensure that the rox pinboard is running, the following commands will put it in the startup file:

cat > ~/.icewm/startup << "EOF"
rox -p Default &
EOF &&
chmod +x ~/.icewm/startup

Tip

There are a number of keyboard shortcuts in IceWM:

  • Ctrl + Alt + FN : go to ttyN.

  • Ctrl + Alt + N : go to desktop number N

  • Ctrl + Alt + Space : open a box on the taskbar where you can key in the name of an application and run it.

Contents

Installed Programs: icehelp, icesh, icesound, icewm, icewm-menu-fdo, icewm-menu-xrandr, icewm-session, icewm-set-gnomewm, icewmbg, and icewmhint
Installed Libraries: None
Installed Directories: /usr/share/doc/icewm-3.4.1, /usr/share/icewm and ~/.icewm

Short Descriptions

icehelp

is used to display the html manual

icesh

is a command-line window manager which can be used in ~/.icewm/startup

icesound

plays audio files on GUI events raised by IceWM

icewm

is the window manager

icewm-menu-fdo

can create a file in a format suitable for an IceWM menu, which lists those programs currently installed in a layout conforming to the FDO Desktop Menu Specifications

icewm-menu-xrandr

is a helper program used to manage multi-screen configurations

icewm-session

runs icewmbg, icewm, icewmtray, startup, shutdown (i.e. startup and shutdown scripts are run if installed)

icewm-set-gnomewm

is a script to set the GNOME window manager to icewm using gconftool

icewmbg

is used to set the background, according to the various DesktopBackground settings in the preferences

icewmhint

is used internally to provide hints to the user

openbox-3.6.1

Introduction to openbox

Openbox is a highly configurable desktop window manager with extensive standards support. It allows you to control almost every aspect of how you interact with your desktop.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Openbox Dependencies

Required

a graphical environment and Pango-1.50.14 (compiled with support for libXft)

Optional

dbus-1.14.8 (runtime), imlib2-1.12.0 (to enable icons in the right click menu), ImageMagick-7.1.1-15 (to show desktop backgrounds as seen in the Configuration Information section below), PyXDG-0.28, startup-notification-0.12, and librsvg-2.56.3

Installation of Openbox

Note

If XORG_PREFIX is not /usr, tell gcc about it:

export LIBRARY_PATH=$XORG_PREFIX/lib

If you only installed the Python 3 PyXDG module convert one of the scripts to Python 3:

2to3-3.11 -w data/autostart/openbox-xdg-autostart &&
sed 's/python/python3/' -i data/autostart/openbox-xdg-autostart

Install Openbox by running the following commands:

./configure --prefix=/usr     \
            --sysconfdir=/etc \
            --disable-static  \
            --docdir=/usr/share/doc/openbox-3.6.1 &&
make

This package does not come with a test suite.

Now, as the root user:

make install

This package creates three .desktop files in the /usr/share/xsessions/ directory. Two of these are not appropriate in a BLFS system, so prevent the extra files showing up as options in a display manager. As the root user:

rm -v /usr/share/xsessions/openbox-{gnome,kde}.desktop

Command Explanations

--sysconfdir=/etc: This option puts Openbox's configuration files in /etc/xdg/openbox instead of /usr/etc/xdg/openbox.

--docdir=/usr/share/doc/openbox-3.6.1: this puts a few files in a versioned directory in /usr/share/doc.

--disable-static: This switch prevents installation of static versions of the libraries.

Configuring Openbox

Config Files

/etc/xdg/openbox/autostart, /etc/xdg/openbox/menu.xml, /etc/xdg/openbox/rc.xml, ~/.config/openbox/autostart, ~/.config/openbox/menu.xml and ~/.config/openbox/rc.xml

Configuration Information

Openbox's right click menu can be used to launch programs. The menu itself is configured with 2 files, /etc/xdg/openbox/menu.xml and ~/.config/openbox/menu.xml. To make changes to the menu, copy /etc/xdg/openbox/menu.xml to ~/.config/openbox/menu.xml and edit it:

cp -rf /etc/xdg/openbox ~/.config

~/.config/openbox/menu.xml can be edited with a text editor or you can install Obmenu (requires pyxml and PyGTK-2.24.0).

To have icons in your right click menu requires installing imlib2-1.12.0 before you install Openbox. To set an icon for an entry in the menu edit ~/.config/openbox/menu.xml and add an icon to the <item> tag like this:

                <item label="Mplayer" icon="/usr/share/pixmaps/mplayer.png">

Many other aspects of Openbox's behavior are configured with ~/.config/openbox/rc.xml such as what keybindings are used to launch programs or which mouse button launches the main menu.

Details of the theme that Openbox applies to window decorations are configured in ~/.config/openbox/rc.xml. You can get a list of the available themes with the command:

ls -d /usr/share/themes/*/openbox-3 | sed 's#.*es/##;s#/o.*##'

Starting Openbox

To automatically start openbox when you start Xorg:

echo openbox > ~/.xinitrc

If you want to set a background image to your desktop you can use display and launch it from ~/.xinitrc just before openbox:

cat > ~/.xinitrc << "EOF"
display -backdrop -window root /path/to/beautiful/picture.jpeg
exec openbox
EOF

Or if you like a bit of variety, put a selection of images in a folder (in this example, the directory ~/.config/backgrounds) and choose one at random each time you xinit:

cat > ~/.xinitrc << "EOF"
# make an array which lists the pictures:
picture_list=(~/.config/backgrounds/*)
# create a random integer between 0 and the number of pictures:
random_number=$(( ${RANDOM} % ${#picture_list[@]} ))
# display the chosen picture:
display -backdrop -window root "${picture_list[${random_number}]}"
exec openbox
EOF

If you like to have the numlock key set when you start Xorg, install Numlockx and add that to your xinitrc. Another useful application is dbus-1.14.8:

cat > ~/.xinitrc << "EOF"
. /etc/profile
picture_list=(~/.config/backgrounds/*)
random_number=$(( ${RANDOM} % ${#picture_list[*]} ))
display -backdrop -window root "${picture_list[${random_number}]}"
numlockx
eval $(dbus-launch --auto-syntax --exit-with-session)
lxpanel &
exec openbox
EOF

Contents

Installed Programs: gdm-control, gnome-panel-control, obxprop, openbox, openbox-gnome-session, openbox-kde-session and openbox-session
Installed Libraries: libobrender.so and libobt.so
Installed Directories: /etc/xdg/openbox, /usr/include/openbox, /usr/share/doc/openbox-3.6.1 and /usr/share/themes.

Short Descriptions

gdm-control

is a command line tool to send signals to GDM

gnome-panel-control

is a command line utility to invoke the Gnome Panel run dialog/menu

obxprop

is a tool for displaying the properties on an x window. It has a similar functionality to xprop, but allows you to see UTF-8 strings as text

openbox

is a standards compliant, highly configurable, window manager

openbox-gnome-session

is a script to launch an Gnome session with Openbox as your window manager from your ~/.xinitrc

openbox-kde-session

is a script to launch an KDE session with Openbox as your window manager from your ~/.xinitrc

openbox-session

is a script to launch an Openbox session from your ~/.xinitrc

libobrender.so

contains the functions used by Openbox for theme rendering

libobt.so

is the Openbox toolkit library

sawfish-1.13.0

Introduction to sawfish

The sawfish package contains a window manager. This is useful for organizing and displaying windows where all window decorations are configurable and all user-interface policy is controlled through the extension language.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

sawfish Dependencies

Required

gdk-pixbuf-xlib-2.40.2, rep-gtk-0.90.8.3, and Which-2.21

Optional

libnsl-2.0.0

Installation of sawfish

Install sawfish by running the following commands:

./configure --prefix=/usr --with-pango  &&
make

This package does not come with a test suite.

Now, as the root user:

make install

This package creates six .desktop files in the /usr/share/xsessions/ directory. All but one are needed in a BLFS system, so prevent the extra files showing up as options in a display manager. As the root user:

rm -v /usr/share/xsessions/sawfish-*.desktop

Configuring sawfish

Configuration Information

Be sure to backup your current .xinitrc before proceeding.

cat >> ~/.xinitrc << "EOF"
exec sawfish
EOF

Optionally, you can use a Display Manager, such as sddm-0.20.0.

From the developers: The default menu binding is somewhat obscure; you must middle-click on the background to bring up the menus. (If you have a two-button mouse, try clicking both buttons simultaneously). You can find this at sawfish's FAQ.

Contents

Installed Programs: sawfish, sawfish-about, sawfish-client, sawfish-config, sawfish-kde4-session, sawfish-kde5-session, sawfish-lumina-session, sawfish-mate-session, and sawfish-xfce-session
Installed Libraries: Several internal modules under /usr/lib/sawfish tree
Installed Directory: /usr/include/sawfish, /usr/lib/sawfish, /usr/lib/rep/sawfish, and /usr/share/sawfish

Short Descriptions

sawfish

is the extensible window manager using a Lisp-based scripting language

sawfish-about

is the sawfish about window

sawfish-client

allows you to connect to a window manager process and evaluate arbitrary Lisp forms

sawfish-config

is the sawfish configuration manager

sawfish-kde4-session

is a script to run KDE4 using sawfish

sawfish-kde5-session

is a script to run Plasma 5 using sawfish

sawfish-mate-session

is a script to run mate using sawfish

sawfish-lumina-session

is a script to run Lumina using sawfish

sawfish-xfce-session

is a script to run xfce using sawfish

Chapter 28. Icons

Window Managers and Desktop Environments can use icons from different sources. Generally icons are installed in /usr/share/icons and are independent of distribution.

adwaita-icon-theme-44.0

Introduction to Adwaita Icon Theme

The Adwaita Icon Theme package contains an icon theme for GTK+ 3 and GTK 4applications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Adwaita Icon Theme Dependencies

Optional

git-2.41.0, GTK+-2.24.33 or GTK+-3.24.38 (if present, librsvg-2.56.3 is also required, and gtk-update-icon-cache and gtk-encode-symbolic-svg are run after installing), Inkscape-1.3 and Icon Tools

Installation of Adwaita Icon Theme

Install Adwaita Icon Theme by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Library: None
Installed Directory: /usr/share/icons/Adwaita

breeze-icons-5.109.0

Introduction to Breeze Icons

The Breeze Icons package contains the default icons for KDE Plasma 5 applications, but it can be used for other window environments.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Breeze Icons Dependencies

Required

extra-cmake-modules-5.109.0 and (Qt-5.15.10 or qt-alternate-5.15.10)

Optional

KDE Frameworks-5.109.0, libxml2-2.10.4, and lxml-4.9.3

Installation of Breeze Icons

Install Breeze Icons by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DBUILD_TESTING=OFF         \
      -Wno-dev ..

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

-DBUILD_TESTING=OFF: This parameter disables building the testing framework, which requires some modules from KDE Frameworks-5.109.0.

Contents

Installed Programs: None
Installed Library: None
Installed Directory: /usr/share/icons/breeze{,-dark}

gnome-icon-theme-3.12.0

Introduction to GNOME Icon Theme

The GNOME Icon Theme package contains an assortment of non-scalable icons of different sizes and themes.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME Icon Theme Dependencies

Required

GTK+-3.24.38 or GTK+-2.24.33, hicolor-icon-theme-0.17, and icon-naming-utils-0.8.90

Installation of GNOME Icon Theme

Install GNOME Icon Theme by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: None
Installed Directory: /usr/share/icons/gnome

gnome-icon-theme-extras-3.12.0

Introduction to GNOME Icon Theme Extras

The GNOME Icon Theme Extras package contains extra icons for the GNOME Desktop.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME Icon Theme Extras Dependencies

Required

gnome-icon-theme-3.12.0

Optional

git-2.41.0 and Inkscape-1.3

Installation of GNOME Icon Theme Extras

Install GNOME Icon Theme Extras by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

gnome-icon-theme-symbolic-3.12.0

Introduction to GNOME Icon Theme Symbolic

The GNOME Icon Theme Symbolic package contains symbolic icons for the default GNOME icon theme.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME Icon Theme Symbolic Dependencies

Required

gnome-icon-theme-3.12.0

Optional

git-2.41.0 and Inkscape-1.3

Installation of GNOME Icon Theme Symbolic

Install GNOME Icon Theme Symbolic by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/share/icons/gnome/scalable

gnome-themes-extra-3.28

Introduction to GNOME Themes Extra

The GNOME Themes Extra package, formerly known as GNOME Themes Standard, contains various components of the default GNOME theme.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME Themes Extra Dependencies

Required

GTK+-2.24.33 or GTK+-3.24.38 with librsvg-2.56.3 or both

Installation of GNOME Themes Extra

Install GNOME Themes Extra by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-gtk2-engine: This switch disables the GTK+-2 theming engine.

--disable-gtk3-engine: This switch disables the GTK+-3 theming engine.

Contents

Installed Programs: None
Installed Library: libadwaita.so
Installed Directories: /usr/lib/gtk-2.0/2.10.0/engines, /usr/share/icons/HighContrast, /usr/share/themes/Adwaita, /usr/share/themes/Adwaita-dark, and /usr/share/themes/HighContrast

Short Descriptions

libadwaita.so

is the Adwaita GTK+-2 engine theme

hicolor-icon-theme-0.17

Introduction to hicolor-icon-theme

The hicolor-icon-theme package contains a default fallback theme for implementations of the icon theme specification.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of hicolor-icon-theme

Install hicolor-icon-theme by running the following commands:

./configure --prefix=/usr

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: None
Installed Directory: /usr/share/icons/hicolor

Short Descriptions

/usr/share/icons/hicolor/*

contains icon definitions used as defaults

icon-naming-utils-0.8.90

Introduction to icon-naming-utils

The icon-naming-utils package contains a Perl script used for maintaining backwards compatibility with current desktop icon themes, while migrating to the names specified in the Icon Naming Specification.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

icon-naming-utils Dependencies

Required

XML-Simple-2.25

Installation of icon-naming-utils

Install icon-naming-utils by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: icon-name-mapping
Installed Libraries: None
Installed Directories: /usr/share/dtds and /usr/share/icon-naming-utils

Short Descriptions

icon-name-mapping

is a Perl script used for maintaining backwards compatibility with current desktop icon themes, while migrating to the names specified in the Icon Naming Specification

lxde-icon-theme-0.5.1

Introduction to LXDE Icon Theme

The LXDE Icon Theme package contains nuoveXT 2.2 Icon Theme for LXDE.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

LXDE Icon Theme Dependencies

Optional

GTK+-2.24.33 or GTK+-3.24.38 (for gtk-update-icon-cache command)

Installation of LXDE Icon Theme

Install LXDE Icon Theme by running the following commands:

./configure --prefix=/usr

This package does not come with a test suite.

Now, as the root user:

make install

If you have installed one of the optional dependencies, run the following command as the root user:

gtk-update-icon-cache -qf /usr/share/icons/nuoveXT2

Contents

Installed Programs: None
Installed Libraries: None
Installed Directory: /usr/share/icons/nuoveXT2

oxygen-icons5-5.109.0

Introduction to oxygen-icons5

The oxygen icons 5 theme is a photo-realistic icon style, with a high standard of graphics quality.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

oxygen-icons5 Dependencies

Required

extra-cmake-modules-5.109.0 and (Qt-5.15.10 or qt-alternate-5.15.10)

Installation of oxygen-icons5

First, enable scalable icons:

sed -i '/( oxygen/ s/)/scalable )/' CMakeLists.txt

Install oxygen-icons5 by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr -Wno-dev ..

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: none
Installed Libraries: none
Installed Directory: /usr/share/icons/oxygen

Part VII. KDE

KDE is a comprehensive desktop environment with a huge number of applications written for it and a huge amount of users. It is based on the Qt framework.

For more information visit the official KDE project site at https://kde.org/.

Chapter 29. Introduction to KDE

KDE Preliminaries

KDE is a comprehensive desktop environment with a huge number of applications written for it and a huge amount of users. It is based on the Qt framework.

The KDE5 system has two main blocks: the libraries, called KDE Frameworks 5 or KF5, which can be used in other environments, and the desktop environment called KDE Plasma 5. Most of the applications written by the KDE team only use KF5, and do not need the plasma environment.

For more information visit the official KDE project site at https://kde.org/.

extra-cmake-modules-5.109.0

Introduction to Extra Cmake Modules

The Extra Cmake Modules package contains extra CMake modules used by KDE Frameworks 5 and other packages.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Extra Cmake Modules Dependencies

Required

CMake-3.27.2

Optional

sphinx-7.1.2 (for building documentation) and PyQt (experimental support for building KDE Python bindings)

Installation of Extra Cmake Modules

Install Extra Cmake Modules by running the following commands:

sed -i '/"lib64"/s/64//' kde-modules/KDEInstallDirsCommon.cmake &&

sed -e '/PACKAGE_INIT/i set(SAVE_PACKAGE_PREFIX_DIR "${PACKAGE_PREFIX_DIR}")' \
    -e '/^include/a set(PACKAGE_PREFIX_DIR "${SAVE_PACKAGE_PREFIX_DIR}")' \
    -i ECMConfig.cmake.in &&

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr .. &&
make

This package does not come with a test suite.

Note

Unlike other KF5 packages, this module is installed in /usr because it can be used by some non-KF5 packages.

Now, as the root user:

make install

Command Explanations

sed ... Modules/KDEInstallDirs.cmake: This command disables applications using cmake from attempting to install files in a lib64 sub-directory.

sed ... ECMConfig.cmake.in: This command protects the global cmake variable PACKAGE_PREFIX_DIR from being changed when checking ECM presence: since we install ECM into /usr, the check would set that variable to /usr, while most KDE packages expect it to be set to /opt/kf5 and would fail to build if it is set to something else.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/share/ECM and /usr/share/doc/ECM (if documentation was built)

Phonon-4.11.1

Introduction to Phonon

Phonon is the multimedia API for KDE. It replaces the old aRts package. Phonon needs either the GStreamer or VLC backend.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Phonon Dependencies

Required

CMake-3.27.2, extra-cmake-modules-5.109.0, GLib-2.76.4, and Qt-5.15.10

At least one of phonon-backend-gstreamer-4.10.0 or phonon-backend-vlc-0.11.3 needs to be installed afterwards for multimedia operation in KDE.

Optional

PulseAudio-16.1

Installation of Phonon

Install Phonon by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      .. &&
make

Now, as the root user:

make install

Command Explanations

-DCMAKE_BUILD_TYPE=Release: This switch is used to apply higher level of the compiler optimizations.

Contents

Installed Programs: phononsettings
Installed Libraries: libphonon4qt5.so and libphonon4qt5experimental.so
Installed Directories: /usr/include/phonon4qt5, /usr/lib/cmake/phonon4qt5, /usr/lib/plugins/designer, and /usr/share/phonon4qt5

Phonon-backend-gstreamer-4.10.0

Introduction to the Phonon-backend-gstreamer

This package provides a Phonon backend which utilizes the GStreamer media framework.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Phonon-backend-gstreamer Dependencies

Required

gstreamer-1.22.5, libxml2-2.10.4, and phonon-4.11.1

Recommended

Installation of Phonon-backend-gstreamer

Install Phonon-backend-gstreamer by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr    \
      -DCMAKE_BUILD_TYPE=Release     \
      .. &&
make

Now, as the root user:

make install

Command Explanations

-DCMAKE_BUILD_TYPE=Release: This switch is used to apply higher level of compiler optimizations.

Contents

Installed Programs: none
Installed Libraries: phonon_gstreamer.so
Installed Directories: /usr/lib/plugins/phonon4qt5_backend

Phonon-backend-vlc-0.11.3

Introduction to the Phonon-backend-vlc

This package provides a Phonon backend which utilizes the VLC media framework.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Phonon-backend-vlc Dependencies

Required

phonon-4.11.1 and VLC-3.0.18

Installation of Phonon-backend-vlc

Install Phonon-backend-vlc by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      .. &&
make

Now, as the root user:

make install

Command Explanations

-DCMAKE_BUILD_TYPE=Release: This switch is used to apply higher level of compiler optimizations.

Contents

Installed Program: none
Installed Libraries: phonon_vlc.so
Installed Directory: /usr/lib/plugins/phonon4qt5_backend

Polkit-Qt-0.114.0

Introduction to Polkit-Qt

Polkit-Qt provides an API to PolicyKit in the Qt environment.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Polkit-Qt Dependencies

Required

CMake-3.27.2, Polkit-123, and Qt-5.15.10

Installation of Polkit-Qt

Install Polkit-Qt by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -Wno-dev .. &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

-DCMAKE_BUILD_TYPE=Release: This switch is used to apply higher level of the compiler optimizations.

Contents

Installed Programs: none
Installed Libraries: libpolkit-qt5-agent-1.so, libpolkit-qt5-core-1.so, and libpolkit-qt5-gui-1.so
Installed Directories: /usr/include/polkit-qt5-1 and /usr/lib/cmake/PolkitQt5-1

libdbusmenu-qt-0.9.3+16.04.20160218

Introduction to libdbusmenu-qt

This library provides a Qt implementation of the DBusMenu specification that exposes menus via DBus.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libdbusmenu-qt Dependencies

Required

Qt-5.15.10

Installation of libdbusmenu-qt

Install libdbusmenu-qt by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DWITH_DOC=OFF              \
      -Wno-dev .. &&
make

This packages does not come with a working test suite.

Now, as the root user:

make install

Command Explanations

-DCMAKE_BUILD_TYPE=Release: This switch is used to build without debugging symbols and apply a higher level of compiler optimizations.

-DWITH_DOC=OFF: This option is set to avoid trying to build the API documentation which requires obsolete Qt4.

Contents

Installed Programs: None
Installed Library: libdbusmenu-qt5.so
Installed Directory: /usr/lib/cmake/dbusmenu-qt5 and /usr/include/dbusmenu-qt5

Plasma-wayland-protocols-1.10.0

Introduction to the Plasma-wayland-protocols

This package provides a custom set of protocol definitions for KDE.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Plasma-wayland-protocols Dependencies

Required

extra-cmake-modules-5.109.0

Installation of Plasma-wayland-protocols

Install Plasma-wayland-protocols by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr ..

Now, as the root user:

make install

Contents

Installed Programs: none
Installed Libraries: none
Installed Directories: /usr/share/plasma-wayland-protocols and /usr/lib/cmake/PlasmaWaylandProtocols

kuserfeedback-1.2.0

Introduction to Kuserfeedback

The kuserfeedback package contains a framework for collecting user feedback for applications via telemetry and surveys.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Kuserfeedback Dependencies

Required

extra-cmake-modules-5.109.0 and Qt-5.15.10

Installation of Kuserfeedback

Install kuserfeedback by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DBUILD_TESTING=OFF         \
      -Wno-dev .. &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: libKUserFeedbackCore.so and libKUserFeedbackWidgets.so
Installed Directories: /usr/include/KUserFeedback, /usr/lib/qml/org/kde/userfeedback, /usr/lib/cmake/KUserFeedback, /usr/share/KDE/UserFeedbackConsole, and /usr/share/qlogging-categories5

Chapter 30. KDE Frameworks 5

KDE Frameworks 5 Pre-installation Configuration

KF5 can be installed in /usr or /opt/kf5. The BLFS editors recommend the latter in the BLFS environment.

Installing in /usr

One option is to install KDE Frameworks 5 into the /usr hierarchy. This creates a simpler setup but makes it more difficult to try multiple versions of KDE Frameworks.

export KF5_PREFIX=/usr

It is a good idea to add the following variables to your system or personal profiles:

cat >> /etc/profile.d/qt5.sh << "EOF"
# Begin kf5 extension for /etc/profile.d/qt5.sh

pathappend /usr/lib/plugins        QT_PLUGIN_PATH
pathappend $QT5DIR/lib/plugins     QT_PLUGIN_PATH

pathappend /usr/lib/qt5/qml        QML2_IMPORT_PATH
pathappend $QT5DIR/lib/qml         QML2_IMPORT_PATH

# End extension for /etc/profile.d/qt5.sh
EOF

cat > /etc/profile.d/kf5.sh << "EOF"
# Begin /etc/profile.d/kf5.sh

export KF5_PREFIX=/usr

# End /etc/profile.d/kf5.sh
EOF

Note

If qt5 was installed in /usr, the $QT5DIR/lib/ portions of the above paths may need to be changed to $QT5DIR/lib/qt5/.

Additionally, if Sudo-1.9.14p3 is installed, these variables should be available to the super user. Execute the following commands as the root user:

cat >> /etc/sudoers.d/qt << "EOF"
Defaults env_keep += QT_PLUGIN_PATH
Defaults env_keep += QML2_IMPORT_PATH
EOF

cat >> /etc/sudoers.d/kde << "EOF"
Defaults env_keep += KF5_PREFIX
EOF

Installing in /opt

A method of building multiple versions installs KDE Frameworks 5 in the /opt hierarchy:

export KF5_PREFIX=/opt/kf5

If you are not installing KDE Frameworks 5 in /usr, you will need to make some additional configuration changes. Best practice is to add those to your system or personal profile:

cat > /etc/profile.d/kf5.sh << "EOF"
# Begin /etc/profile.d/kf5.sh

export KF5_PREFIX=/opt/kf5

pathappend $KF5_PREFIX/bin              PATH
pathappend $KF5_PREFIX/lib/pkgconfig    PKG_CONFIG_PATH

pathappend $KF5_PREFIX/etc/xdg          XDG_CONFIG_DIRS
pathappend $KF5_PREFIX/share            XDG_DATA_DIRS

pathappend $KF5_PREFIX/lib/plugins      QT_PLUGIN_PATH
pathappend $KF5_PREFIX/lib/plugins/kcms QT_PLUGIN_PATH

pathappend $KF5_PREFIX/lib/qml          QML2_IMPORT_PATH

pathappend $KF5_PREFIX/lib/python3.11/site-packages PYTHONPATH

pathappend $KF5_PREFIX/share/man        MANPATH

pathappend $KF5_PREFIX/include          CPLUS_INCLUDE_PATH
# End /etc/profile.d/kf5.sh
EOF

cat >> /etc/profile.d/qt5.sh << "EOF"
# Begin Qt5 changes for KF5

pathappend /usr/lib/plugins            QT_PLUGIN_PATH
pathappend $QT5DIR/plugins             QT_PLUGIN_PATH
pathappend $QT5DIR/qml                 QML2_IMPORT_PATH

# End Qt5 changes for KF5
EOF

Expand your /etc/ld.so.conf file:

cat >> /etc/ld.so.conf << "EOF"
# Begin KF5 addition

/opt/kf5/lib

# End KF5 addition
EOF

Several KDE Frameworks 5 and KDE Plasma 5 packages install files into D-Bus, Polkit, and systemd directories. When installing KDE 5 in a location other than /usr, D-Bus, Polkit, and systemd need to be able to find these files. The easiest way to achieve this is to create the following symlinks (as the root user):

install -v -dm755           $KF5_PREFIX/{etc,share} &&
ln -sfv /etc/dbus-1         $KF5_PREFIX/etc         &&
ln -sfv /usr/share/dbus-1   $KF5_PREFIX/share       &&
ln -sfv /usr/share/polkit-1 $KF5_PREFIX/share       &&
install -v -dm755           $KF5_PREFIX/lib         &&
ln -sfv /usr/lib/systemd    $KF5_PREFIX/lib

Some packages may also install icons from the "hicolor" icon set. Since that icon set is used by many packages, it is a good idea to create a symlink to the one in /usr/share to avoid having multiple installations of hicolor-icon-theme-0.17. Run the following commands as the root user:

install -v -dm755                $KF5_PREFIX/share/icons &&
ln -sfv /usr/share/icons/hicolor $KF5_PREFIX/share/icons

Tip

Sometimes, the installation paths are hardcoded into installed files. This is the reason why /opt/kf5 is used as installation prefix instead of /opt/kf5-5.109.0. After installing KDE Frameworks, you may rename the directory and create a symlink:

mv /opt/kf5{,-5.109.0}
ln -sfv kf5-5.109.0 /opt/kf5

Later on, you may want to install other versions of KDE Frameworks 5. To do that, just remove the symlink and use /opt/kf5 as the prefix again. Which version of KDE Frameworks 5 you use depends only on where the symlink points. No other reconfiguration will be needed.

Building KDE Frameworks 5 (KF5)

KDE Frameworks 5 is a collection of libraries based on top of Qt5 and QML derived from the monolithic KDE 4 libraries. They can be used independent of the KDE Display Environment (Plasma 5).

This package is known to build and work properly using an LFS 12.0 platform.

The instructions below build all of the KDE Frameworks packages in one step by using a bash script.

Package Information

KF5 Dependencies

Required

Boost-1.83.0, extra-cmake-modules-5.109.0, docbook-xml-4.5, docbook-xsl-nons-1.79.2, giflib-5.2.1, libepoxy-1.5.10, libgcrypt-1.10.2, libical-3.0.16, libjpeg-turbo-3.0.0, libpng-1.6.40, libxslt-1.1.38, lmdb-0.9.31, qca-2.3.7, qrencode-4.1.1, phonon-4.11.1, plasma-wayland-protocols-1.10.0, shared-mime-info-2.2, URI-5.17, and Wget-1.21.4 (required to download the packages)

Recommended
Optional

BlueZ-5.68 (needed to build Bluez-Qt), Datamatrix (deemed recommended for Prison by upstream)

Runtime dependency for FrameworkIntegration

Noto fonts

Additional recommended dependencies for kapidox
Additional image formats support in KImageFormats

JasPer-4.0.0, libavif-0.11.1, libraw-0.21.1, libheif, libjxl, and OpenEXR

Optional dependencies for KIO

MIT Kerberos V5-1.21.2

Optional dependencies for Solid

UDisks-2.10.0, UPower-1.90.2 and media-player-info (runtime)

Optional dependency for KWallet

GPGME-1.21.0, built with C++ bindings (which is the default).

Optional dependency for kdewebkit

QtWebkit

Optional dictionary backends for Sonnet

Hspell and Hunspell

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/kf5

Downloading KDE Frameworks

The easiest way to get the KDE Frameworks packages is to use a single wget to fetch them all at once:

url=https://download.kde.org/stable/frameworks/5.109/
wget -r -nH -nd -A '*.xz' -np $url

The options used here are:
  -r            recurse through child directories
  -nH           disable generation of host-prefixed directories
  -nd           do not create a hierarchy of directories
  -A '*.xz'     just get the *.xz files
  -np           don't get parent directories

Setting Package Order

The order of building files is important due to internal dependencies. Create the list of files in the proper order as follows:

cat > frameworks-5.109.0.md5 << "EOF"
b025406c6818d92ad3fedd585bd8a428  attica-5.109.0.tar.xz
#0baf0a3ded2fed5e0442591dde276c4e  extra-cmake-modules-5.109.0.tar.xz
e4cc63aafbbe019ebb8d62f6c02e9d2e  kapidox-5.109.0.tar.xz
d096b76119d8d9da91fd112811d2b408  karchive-5.109.0.tar.xz
64087cda04bec6ad068f22ce1e3dcb1e  kcodecs-5.109.0.tar.xz
fe2b1c516c2f9caadd6c8e3bf35ffd96  kconfig-5.109.0.tar.xz
b88be3c775bef6277e047f09b531ba1d  kcoreaddons-5.109.0.tar.xz
5b00c0b729b5c11d2a5733ea7db5674f  kdbusaddons-5.109.0.tar.xz
993090bb9a0e678154382daa0626fa48  kdnssd-5.109.0.tar.xz
3fc1c5e58a8202cd0722aa7ec99ad584  kguiaddons-5.109.0.tar.xz
13b867e8189e91e402e5e9b9aa33b613  ki18n-5.109.0.tar.xz
d8f87c99c0b798f04ac328d7050d2d97  kidletime-5.109.0.tar.xz
777d46bc3c7c7e66804402220dac2df0  kimageformats-5.109.0.tar.xz
e3321430de25b4b16ad48c6c2f168170  kitemmodels-5.109.0.tar.xz
c5efe890400ab8b97270f9a3e821d510  kitemviews-5.109.0.tar.xz
f334911f97cd4592e3b823dfc518f9eb  kplotting-5.109.0.tar.xz
67f4605da5e119342e91fc4670114a2b  kwidgetsaddons-5.109.0.tar.xz
2b384fcad72c84ccda75f300c14f633c  kwindowsystem-5.109.0.tar.xz
4dcacee7da9987c587511634ca90f064  networkmanager-qt-5.109.0.tar.xz
8952c4756ed0bc072a8bad998ed81bc6  solid-5.109.0.tar.xz
8aff00ce75275252f45d915c478279de  sonnet-5.109.0.tar.xz
f98889ea3fa22aaeaa9f8a85a602f3a6  threadweaver-5.109.0.tar.xz
62195272670cdec8ceb0fbda4bd8c43b  kauth-5.109.0.tar.xz
9b99972d3a25f521c20c04d1867fc3dd  kcompletion-5.109.0.tar.xz
fc2f3a9c7d12066b659b46e13a75e97a  kcrash-5.109.0.tar.xz
43e0fddae05e83dfb7cd0b0bb5cc11e5  kdoctools-5.109.0.tar.xz
7ccb53e9023ada6a5e08e4d562769ef3  kpty-5.109.0.tar.xz
30d32d8dc23c6ad4915be89831238c54  kunitconversion-5.109.0.tar.xz
eb1a478738f8f5bd5ab7bd23145594b7  kconfigwidgets-5.109.0.tar.xz
2353574c0c41d1f9e274d29fc3f174c3  kservice-5.109.0.tar.xz
8f2118a5544acd0bcb9a2202180e1e27  kglobalaccel-5.109.0.tar.xz
f9ce944b2dcc815e8df677b7018530cd  kpackage-5.109.0.tar.xz
737509807d74878037d564ab19f8f4fb  kdesu-5.109.0.tar.xz
f8ec4f236ad6d229294003478b2c8660  kemoticons-5.109.0.tar.xz
8d23dcfeaa45d04f3a03b993794c1929  kiconthemes-5.109.0.tar.xz
b108a7c58d5e63248e4043a6e2d5cd3d  kjobwidgets-5.109.0.tar.xz
37840b5eff97d1cb6105a276a14f6982  knotifications-5.109.0.tar.xz
520e1568726e76671fdbc3c5180d1e12  ktextwidgets-5.109.0.tar.xz
d52b000182f1530befcb9023db853620  kxmlgui-5.109.0.tar.xz
e230f6ef16e636ed103bd30ee9256d9d  kbookmarks-5.109.0.tar.xz
fb90ee7dad377b5fe11cc5a60c0721c5  kwallet-5.109.0.tar.xz
ab29c38a4efbb1c2a8ae844aae1482ea  kded-5.109.0.tar.xz
73fc6504264e620b0f9d0ba96c9d8ca4  kio-5.109.0.tar.xz
1d180f9106dd4e55346bf6b68f144594  kdeclarative-5.109.0.tar.xz
a3a6afb25c9d4dd0b027468c318763cb  kcmutils-5.109.0.tar.xz
4f555c40672c66df4c6d685bee6c5ae1  kirigami2-5.109.0.tar.xz
f355ac0e56c60d258c242bb5115c5879  syndication-5.109.0.tar.xz
9d263510d765e23f80558e8c83b113fd  knewstuff-5.109.0.tar.xz
d3b4d1a97b4c724a99b9920f3931db58  frameworkintegration-5.109.0.tar.xz
3ecd4e79453f9a8b378b87a63a698280  kinit-5.109.0.tar.xz
b65f54d2f7b5c7b54926f147114c3ab4  kparts-5.109.0.tar.xz
7111af3ca1d17b3b085513bf4067557e  kactivities-5.109.0.tar.xz
#929785c0f7a5594f4eac30c2f40645d5  kdewebkit-5.109.0.tar.xz
e970abb368b963a075f10f2ef26a95c0  syntax-highlighting-5.109.0.tar.xz
9405ebf54d7c675a39ef00afc81e472d  ktexteditor-5.109.0.tar.xz
cd659fa310535c476d3dcb7cba5499f8  kdesignerplugin-5.109.0.tar.xz
b9ce7efb96ee1f88f3d8c505a3c8e8b1  kwayland-5.109.0.tar.xz
08ec7edef427f681dfb3b1533ab0d880  plasma-framework-5.109.0.tar.xz
5e66a95d9998d4874aa1d9004b2bdc50  modemmanager-qt-5.109.0.tar.xz
e66ebdbc5547881e8562bab6a02ce8bb  kpeople-5.109.0.tar.xz
a1af96f8f082e4f9fca0ce476528b6ae  kxmlrpcclient-5.109.0.tar.xz
91a2f23a8a88b7ac17c94f70b50a6b71  bluez-qt-5.109.0.tar.xz
c796f5097f2185c33a61d8e32a296066  kfilemetadata-5.109.0.tar.xz
2d0a01f671615c6a1559eaa4d73193c2  baloo-5.109.0.tar.xz
#40721040f8c42a60450a94b7975d18e3  breeze-icons-5.109.0.tar.xz
#cb7872cff65fe1f62815339f40c639d8  oxygen-icons5-5.109.0.tar.xz
f09fd15d79bca7374094ea1126e6aef6  kactivities-stats-5.109.0.tar.xz
7c7a7502b568b7c3c45f7c43cefa92e7  krunner-5.109.0.tar.xz
00d1282f4dd770085cf2d72371cd3388  prison-5.109.0.tar.xz
12f3d0a80404bcd1111f5164d8e9dfd0  qqc2-desktop-style-5.109.0.tar.xz
4ca7a857b39d805ba61c94d17cbe6862  kjs-5.109.0.tar.xz
06545a811be0293dc9a79d65ce265a4e  kdelibs4support-5.109.0.tar.xz
2c1d3e7d57e6793e7bfbcd7424a199bc  khtml-5.109.0.tar.xz
b9ab15ac90dece7fa6b623be95ef40f9  kjsembed-5.109.0.tar.xz
405558700e5518f7e25eb252c0027410  kmediaplayer-5.109.0.tar.xz
e647b806ba546ea010b304f707a9d696  kross-5.109.0.tar.xz
0fc9e9fda1d3a55fd61f655a1dec0b39  kholidays-5.109.0.tar.xz
08946785eb0fa4a3d5b1ac174433f9a7  purpose-5.109.0.tar.xz
c4faaf8fa6587a0b80a0618810e9d41a  kcalendarcore-5.109.0.tar.xz
588289805cb18731d9b73ea86236b458  kcontacts-5.109.0.tar.xz
08b2dcd842dfcda7e406d16646b082bb  kquickcharts-5.109.0.tar.xz
8612d9d00ff9daeb507548ed9150d00d  knotifyconfig-5.109.0.tar.xz
d4e4e96920394601cf599ed8e36bd635  kdav-5.109.0.tar.xz
EOF

In the above list, notice that some files have been commented out with a hash (#) character. The extra-cmake-modules entry has been commented out because it was built earlier in the Introduction to KDE. The icon packages are covered separately at breeze-icons-5.109.0 and oxygen-icons5-5.109.0. The kdewebkit package may be built if the external package QtWebkit has been built.

Installation of KDE Frameworks

Note

When installing multiple packages in a script, the installation needs to be done as the root user. There are three general options that can be used to do this:

  1. Run the entire script as the root user (not recommended).

  2. Use the sudo command from the Sudo-1.9.14p3 package.

  3. Use su -c "command arguments" (quotes required) which will ask for the root password for every iteration of the loop.

One way to handle this situation is to create a short bash function that automatically selects the appropriate method. Once the command is set in the environment, it does not need to be set again.

as_root()
{
  if   [ $EUID = 0 ];        then $*
  elif [ -x /usr/bin/sudo ]; then sudo $*
  else                            su -c \\"$*\\"
  fi
}

export -f as_root

Caution

If installing in /opt and there is an existing /opt/kf5 either as a regular directory or a symbolic link, it should be reinitialized (as root):

mv -v /opt/kf5 /opt/kf5.old                         &&
install -v -dm755           $KF5_PREFIX/{etc,share} &&
ln -sfv /etc/dbus-1         $KF5_PREFIX/etc         &&
ln -sfv /usr/share/dbus-1   $KF5_PREFIX/share       &&
ln -sfv /usr/share/polkit-1 $KF5_PREFIX/share       &&
install -v -dm755           $KF5_PREFIX/lib         &&
ln -sfv /usr/lib/systemd    $KF5_PREFIX/lib

First, start a subshell that will exit on error:

bash -e

Install all of the packages by running the following commands:

while read -r line; do

    # Get the file name, ignoring comments and blank lines
    if $(echo $line | grep -E -q '^ *$|^#' ); then continue; fi
    file=$(echo $line | cut -d" " -f2)

    pkg=$(echo $file|sed 's|^.*/||')          # Remove directory
    packagedir=$(echo $pkg|sed 's|\.tar.*||') # Package directory

    name=$(echo $pkg|sed 's|-5.*$||') # Isolate package name

    tar -xf $file
    pushd $packagedir

      # kapidox is a python module
      case $name in
        kapidox)
          pip3 wheel -w dist --no-build-isolation --no-deps $PWD
          as_root pip3 install --no-index --find-links dist --no-cache-dir --no-user kapidox
          popd
          rm -rf $packagedir
          continue
          ;;
      esac

      mkdir build
      cd    build

      cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
            -DCMAKE_PREFIX_PATH=$QT5DIR        \
            -DCMAKE_BUILD_TYPE=Release         \
            -DBUILD_TESTING=OFF                \
            -Wno-dev ..
      make
      as_root make install
    popd

  as_root rm -rf $packagedir
  as_root /sbin/ldconfig

done < frameworks-5.109.0.md5

exit

Note

Any modules that have been omitted can be installed later by using the same mkdir build; cd build; cmake; make; make install procedure as above.

Sometimes the installation paths are hardcoded into installed files. If the installed directory is not /usr, rename the directory and create a symlink:

mv -v /opt/kf5 /opt/kf5-5.109.0
ln -sfvn kf5-5.109.0 /opt/kf5

Command Explanations

-DCMAKE_PREFIX_PATH=$QT5DIR: This switch is used to allow cmake to find the proper Qt libraries.

-DCMAKE_BUILD_TYPE=Release: This switch is used to apply higher level of the compiler optimizations.

-DBUILD_TESTING=OFF: This switch is used to prevent building test programs and libraries that are of no use to an end user.

Contents

Installed Programs: balooctl, baloo_file, baloo_file_extractor, baloosearch, balooshow, checkXML5, depdiagram-generate, depdiagram-generate-all, depdiagram-prepare, desktoptojson, gentrigrams, kactivities-cli, kapidox_generate, kate-syntax-highlighter, kbuildsycoca5, kcookiejar5, kdebugdialog5, kded5, kdeinit5, kdeinit5_shutdown, kdeinit5_wrapper, kf5-config, kf5kross, kgendesignerplugin, kglobalaccel5, kiconfinder5, kjs5, kjscmd5, kjsconsole, knewstuff-dialog, kpackagelauncherqml, kpackagetool5, kquitapp5, kreadconfig5, kshell5, ktelnetservice5, ktrash5, kwalletd5, kwallet-query, kwrapper5, kwriteconfig5, meinproc5, parsetrigrams, plasmapkg2, preparetips5, protocoltojson, and solid-hardware5
Installed Libraries: libkdeinit5_klauncher.so, libKF5Activities.so, libKF5ActivitiesStats.so, libKF5Archive.so, libKF5Attica.so, libKF5AuthCore.so, libKF5Auth.so, libKF5Baloo.so, libKF5BluezQt.so, libKF5Bookmarks.so, libKF5CalendarCore.so, libKF5CalendarEvents.so, libKF5Codecs.so, libKF5Completion.so, libKF5ConfigCore.so, libKF5ConfigGui.so, libKF5ConfigWidgets.so, libKF5Contacts.so, libKF5CoreAddons.so, libKF5Crash.so, libKF5DAV.so, libKF5DBusAddons.so, libKF5Declarative.so, libKF5DNSSD.so, libKF5DocTools.so, libKF5Emoticons.so, libKF5FileMetaData.so, libKF5GlobalAccel.so, libKF5GuiAddons.so, libKF5Holidays.so, libKF5I18n.so, libKF5IconThemes.so, libKF5IdleTime.so, libKF5ItemModels.so, libKF5ItemViews.so, libKF5JobWidgets.so, libKF5JSApi.so, libKF5JsEmbed.so, libKF5JS.so, libKF5KCMUtils.so, libKF5KDELibs4Support.so, libKF5KHtml.so, libKF5KIOCore.so, libKF5KIOFileWidgets.so, libKF5KIOGui.so, libKF5KIONTLM.so, libKF5KIOWidgets.so, libKF5Kirigami2.so, libKF5KrossCore.so, libKF5KrossUi.so, libKF5MediaPlayer.so, libKF5NetworkManagerQt.so, libKF5NewStuffCore.so, libKF5NewStuff.so, libKF5Notifications.so, libKF5NotifyConfig.so, libKF5Package.so, libKF5Parts.so, libKF5PeopleBackend.so, libKF5People.so, libKF5PeopleWidgets.so, libKF5PlasmaQuick.so, libKF5Plasma.so, libKF5Plotting.so, libKF5Prison.so, libKF5Pty.so, libKF5Purpose.so, libKF5PurposeWidgets.so, libKF5QuickAddons.so, libKF5Runner.so, libKF5Service.so, libKF5Solid.so, libKF5SonnetCore.so, libKF5SonnetUi.so, libKF5Style.so, libKF5Su.so, libKF5SyntaxHighlighting.so, libKF5TextEditor.so, libKF5TextWidgets.so, libKF5ThreadWeaver.so, libKF5UnitConversion.so, libKF5Wallet.so, libKF5WaylandClient.so, libKF5WaylandServer.so, libKF5WidgetsAddons.so, libKF5WindowSystem.so, libKF5XmlGui.so, libKF5XmlRpcClient.so, and libkwalletbackend5.so
Installed Directories: /opt/kf5 (symlink to /opt/kf5-5.109.0) if installing in /opt

Short Descriptions

checkXML5

is a tool to check for syntax errors in KDE DocBook XML files

depdiagram-generate

is a tool to generate a dependency diagram

depdiagram-generate-all

is a tool to generate a dependency diagram for all frameworks at once

depdiagram-prepare

is a tool to prepare dot files

desktoptojson

is a tool to convert a .desktop file to a .json file

kbuildsycoca5

rebuilds the KService desktop file system configuration cache

kcookiejar5

is a command line interface to the HTTP cookie store used by KDE, a D-BUS service to store/retrieve/clean cookies

kded5

consolidates several small services in one process

kdeinit5

is a process launcher somewhat similar to the famous init used for booting UNIX

kf5-config

is a command line program used to retrieve information about KDE installation or user paths

kf5kross

executes kross scripts written in KDE Javascript, Python, Ruby, Java and Falcon

kgendesignerplugin

generates widget plugins for Qt(TM) Designer

kglobalaccel5

is a daemon use to register the key bindings and for getting notified when the action triggered

kjs5

is KDE ECMAScript/JavaScript engine

kjscmd5

is a tool for launching KJSEmbed scripts from the command line

kjsconsole

is a console for kjs5

kpackagelauncherqml

is a commandline tool for launching kpackage QML application

kpackagetool5

is a command line kpackage tool

kreadconfig5

is a command line tool to retrieve values from KDE configuration files

kshell5

start applications via kdeinit

ktelnetservice5

is a telnet service

ktrash5

is a helper program to handle the KDE trash can

kwalletd5

is the wallet manager daemon

kwriteconfig5

is a command line tool to write values in KDE configuration files

meinproc5

converts DocBook files to HTML

plasmapkg2

is a tool to install, list, remove Plasma packages

preparetips5

is a script to extract the text from a tips file

solid-hardware5

is a command line tool to investigate available devices

Chapter 31. KDE Frameworks 5 Based Applications

Ark-23.08.0

Introduction to Ark

The Ark package is a KF5 archive tool. It is a graphical front end to tar and similar tools.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Ark Dependencies

Required

KDE Frameworks-5.109.0 and libarchive-3.7.1

Recommended

Installation of Ark

Install Ark by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
      -DCMAKE_BUILD_TYPE=Release         \
      -DBUILD_TESTING=OFF                \
      -Wno-dev .. &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: ark
Installed Libraries: libkerfuffle.so
Installed Directories: $KF5_PREFIX/lib/plugins/kerfuffle, $KF5_PREFIX/share/doc/HTML/*/ark, and $KF5_PREFIX/share/kxmlgui5/ark

Short Descriptions

ark

is a KF5-based Archive Manager

Kdenlive-23.08.0

Introduction to Kdenlive

The Kdenlive package is a KF5 based video editor.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Kdenlive Dependencies

Required

KDE Frameworks-5.109.0, mlt-7.18.0, and v4l-utils-1.24.1 (runtime)

Recommended

Installation of Kdenlive

Install Kdenlive by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
      -DCMAKE_BUILD_TYPE=Release         \
      -DBUILD_TESTING=OFF                \
      -Wno-dev .. &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: kdenlive and kdenlive_render
Installed Libraries: mltpreview.so
Installed Directories: $KF5_PREFIX/share/doc/HTML/*/kdenlive, $KF5_PREFIX/share/kdenlive, and $KF5_PREFIX/share/kxmlgui5/kdenlive

Short Descriptions

kdenlive

is an open source non-linear video editor which supports a large number of formats

kdenlive_render

is a render program for kdenlive

KMix-23.08.0

Introduction to KMix

The KMix package contains a KF5 based Sound Mixer application.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

KMix Dependencies

Required

KDE Frameworks-5.109.0

Recommended
Optional

libcanberra-0.30 and PulseAudio-16.1

Installation of KMix

Install KMix by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
      -DCMAKE_BUILD_TYPE=Release         \
      -DBUILD_TESTING=OFF                \
      -Wno-dev .. &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: kmix, kmixctrl, and kmixremote
Installed Libraries: libkmixcore.so
Installed Directories: $KF5_PREFIX/share/kmix, $KF5_PREFIX/share/kxmlgui5/kmix, and $KF5_PREFIX/share/doc/HTML/*/kmix

Short Descriptions

kmix

is a mini audio mixer for kde

kmixctrl

is used to save or restore the settings of kmix

kmixremote

is a utility to mute, get and set volume levels

kio-extras-23.08.0

Introduction to kio-extras

The kio-extras package contains additional components to increase the functionality of the KDE resource and network access abstractions.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

kio-extras Dependencies

Required

kdsoap-2.1.1 and KDE Frameworks-5.109.0

Optional

libtirpc-1.3.3, Samba-4.18.6, taglib-1.13.1, libmtp, libssh, and OpenEXR

Installation of kio-extras

Install kio-extras by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
      -DCMAKE_BUILD_TYPE=Release         \
      -DBUILD_TESTING=OFF                \
      -Wno-dev .. &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: libkioarchive.so and 32 plugins
Installed Directories: None

Khelpcenter-23.08.0

Introduction to Khelpcenter

Khelpcenter is an application to show KDE Applications' documentation.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Khelpcenter Dependencies

Required

grantlee-5.3.1, KDE Frameworks-5.109.0, libxml2-2.10.4, and xapian-1.4.23

Recommended

Installation of Khelpcenter

Install khelpcenter by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
      -DCMAKE_BUILD_TYPE=Release         \
      -DBUILD_TESTING=OFF                \
      -Wno-dev .. &&
make

This package does not come with a test suite.

Now, as the root user:

make install  &&

mv -v $KF5_PREFIX/share/kde4/services/khelpcenter.desktop /usr/share/applications/ &&
rm -rv $KF5_PREFIX/share/kde4

Contents

Installed Program: khelpcenter
Installed Libraries: libkdeinit5_khelpcenter.so
Installed Directories: $KF5_PREFIX/share/khelpcenter, $KF5_PREFIX/share/kxmlgui5/khelpcenter, and $KF5_PREFIX/share/doc/HTML/*/{khelpcenter,fundamentals,onlinehelp}

Short Descriptions

khelpcenter

is the help viewer for KDE applications

Konsole-23.08.0

Introduction to Konsole

The Konsole package is a KF5 based terminal emulator.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Konsole Dependencies

Required

KDE Frameworks-5.109.0

Installation of Konsole

Note

In non-plasma environments, the konsole scrollbar and its handle do not show up well. If desired, apply the optional patch to the package:

patch -Np1 -i ../konsole-23.08.0-scrollbar-1.patch

The patch makes the scrollbar light gray with a small white border. The handle is dark gray. If desired, the colors may be changed to taste by editing the patch.

Install Konsole by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
      -DCMAKE_BUILD_TYPE=Release         \
      -DBUILD_TESTING=OFF                \
      -Wno-dev .. &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: konsole and konsoleprofile
Installed Libraries: libkdeinit5_konsole.so and libkonsoleprivate.so
Installed Directories: $KF5_PREFIX/share/doc/HTML/*/konsole, $KF5_PREFIX/share/konsole, and $KF5_PREFIX/share/kxmlgui5/konsole

Short Descriptions

konsole

is an X terminal emulation which provides a command-line interface

konsoleprofile

is a command-line tool to change the current tab's profile options

libkexiv2-23.08.0

Introduction to libkexiv2

Libkexiv2 is a KDE wrapper around the Exiv2 library for manipulating image metadata.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libkexiv2 Dependencies

Required

KDE Frameworks-5.109.0 and Exiv2-0.28.0

Installation of libkexiv2

Install libkexiv2 by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
      -DCMAKE_BUILD_TYPE=Release         \
      -DBUILD_TESTING=OFF                \
      -Wno-dev .. &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Library: libKF5KExiv2.so
Installed Directories: $KF5_PREFIX/include/KF5/KExiv2 and $KF5_PREFIX/lib/cmake/KF5KExiv2

Okular-23.08.0

Introduction to Okular

Okular is a document viewer for KDE. It can view documents of many types including PDF, PostScript, TIFF, Microsoft CHM, DjVu, DVI, XPS and ePub.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Okular Dependencies

Required

KDE Frameworks-5.109.0

Recommended
Optional

qca-2.3.7, discount, DjVuLibre, kpimtextedit, libspectre (for PostScript support), libchm, libepub, and Mobipocket

Installation of Okular

Install Okular by running the following commands:

Note

If any of the optional dependencies are installed, remove the associated reference in the SKIP_OPTIONAL environment variable.

mkdir build &&
cd    build &&

SKIP_OPTIONAL='LibSpectre;CHM;LibZip;DjVuLibre;EPub;QMobipocket;Discount'

cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
      -DCMAKE_BUILD_TYPE=Release         \
      -DBUILD_TESTING=OFF                \
      -DFORCE_NOT_REQUIRED_DEPENDENCIES="$SKIP_OPTIONAL" \
      -Wno-dev .. &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: okular
Installed Library: libOkular5Core.so
Installed Directories: $KF5_PREFIX/include/okular, $KF5_PREFIX/lib/cmake/Okular5, $KF5_PREFIX/lib/plugins/okular, $KF5_PREFIX/share/kxmlgui5/okular, $KF5_PREFIX/share/okular, $KF5_PREFIX/share/doc/HTML/*/okular, and

Short Descriptions

okular

is a document viewer

libkdcraw-23.08.0

Introduction to libkdcraw

Libkdcraw is a KDE wrapper around the libraw-0.21.1 library for manipulating image metadata.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libkdcraw Dependencies

Required

KDE Frameworks-5.109.0 and libraw-0.21.1

Installation of libkdcraw

Install libkdcraw by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
      -DCMAKE_BUILD_TYPE=Release         \
      -DBUILD_TESTING=OFF                \
      -Wno-dev .. &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Library: libKF5KDcraw.so
Installed Directories: $KF5_PREFIX/include/KF5/KDCRAW and $KF5_PREFIX/lib/cmake/KF5KDcraw

Gwenview-23.08.0

Introduction to Gwenview

Gwenview is a fast and easy-to-use image viewer for KDE.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Gwenview Dependencies

Required

Exiv2-0.28.0, kimageannotator-0.6.1, KDE Frameworks-5.109.0, and Little CMS-2.14

Recommended
Optional

KF5Kipi

Installation of Gwenview

Install Gwenview by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
      -DCMAKE_BUILD_TYPE=Release         \
      -DBUILD_TESTING=OFF                \
      -Wno-dev .. &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: gwenview and gwenview_importer
Installed Libraries: libgwenviewlib.so and gvpart.so
Installed Directories: $KF5_PREFIX/share/{kxmlgui5/gvpart,gwenview,doc/HTML/*/gwenview}

Short Descriptions

gwenview

is the KDE image viewer

gwenview_importer

is a Photo importer

libkcddb-23.08.0

Introduction to libkcddb

The libkcddb package contains a library used to retrieve audio CD meta data from the internet.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libkcddb Dependencies

Required

KDE Frameworks-5.109.0 and libmusicbrainz-5.1.0

Installation of libkcddb

Install libkcddb by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
      -DCMAKE_BUILD_TYPE=Release         \
      -DBUILD_TESTING=OFF                \
      -Wno-dev ..                        &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: libKF5Cddb.so and kcm_cddb.so
Installed Directories: $KF5_PREFIX/include/KF5/KCddb and $KF5_PREFIX/lib/cmake/KF5Cddb $KF5_PREFIX/share/doc/HTML/*/kcontrol

Short Descriptions

libkcddb.so

contains functions used to retrieve audio CD meta data from the internet

k3b-23.08.0

Introduction to K3b

The K3b package contains a KF5-based graphical interface to the Cdrtools and dvd+rw-tools CD/DVD manipulation tools. It also combines the capabilities of many other multimedia packages into one central interface to provide a simple-to-operate application that can be used to handle many of your CD/DVD recording and formatting requirements. It is used for creating audio, data, video and mixed-mode CDs as well as copying, ripping and burning CDs and DVDs.

Though k3b can be used to copy almost any DVD to similar medium, it does not provide a way to copy, or reproduce a double-layer DVD onto single-layer medium. Of course, there is not a program anywhere on any platform that can make an exact duplicate of a double-layer DVD onto a single-layer disk, there are programs on some platforms that can compress the data on a double-layer DVD to fit on a single-layer DVD producing a duplicate, but compressed, image. If you need to copy the contents of a double-layer DVD to single-layer medium, you may want to look at the RMLCopyDVD package.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

K3b Dependencies

Required

KDE Frameworks-5.109.0, libkcddb-23.08.0, libsamplerate-0.2.2, and shared-mime-info-2.2

The CD/DVD drive is detected at run time using UDisks-2.10.0, which must therefore be installed before running k3b.

Recommended
Optional Runtime

FFmpeg-6.0

Optional

FLAC-1.4.3, LAME-3.100, libmad-0.15.1b, libsndfile-1.2.2, libvorbis-1.3.7, libmusicbrainz-2.1.5, and Musepack (libmpcdec)

Installation of K3b

Install K3b by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
      -DCMAKE_BUILD_TYPE=Release         \
      -DBUILD_TESTING=OFF                \
      -Wno-dev ..                        &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: k3b
Installed Libraries: libk3bdevice.so, libk3blib.so, and numerous plugin modules for the installed dependencies
Installed Directories: $KF5_PREFIX/share/{,kxmlgui5/}k3b and $KF5_PREFIX/share/doc/HTML/*/k3b

Short Descriptions

k3b

is the graphical CD/DVD program

Further KDE5 packages

This section did not provide instructions for all of the available packages in the KDE5 Software Compilation. The included packages were selected based on what most people would want to use on a standard desktop computer.

For a full list of available packages, have a look on the KDE5 servers at https://download.kde.org/stable/release-service/23.08.0/src.

Some additional packages worth mentioning are:

  • Juk: A lightweight music player.

  • Dragon: A video player.

  • Kcalc: A scientific calculator.

  • Kwalletmanager: A credentials management application.

  • Marble: A global map program.

  • A variety (about 40) of KDE games including: kpat, kfourinline, and kmines.

Note

Some packages will require additional dependencies. To determine what dependencies are needed, run from the top of the source tree:

cmake -Wno-dev -L .

Most of these packages can be built with the standard KDE5 instructions:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
      -DCMAKE_BUILD_TYPE=Release         \
      -DBUILD_TESTING=OFF                \
      -Wno-dev .. &&
make

And as the root user:

make install

Chapter 32. KDE Plasma 5

KDE Plasma 5 is a desktop environment built using KDE Frameworks 5 and QML which runs on top of a fully hardware accelerated graphics stack using Qt5, QtQuick 2 and an OpenGL(-ES) scenegraph.

No additional configuration is needed before building the KDE Plasma 5 because it uses the same configuration that KDE Frameworks 5 uses.

Building Plasma 5

KDE Plasma 5 is a collection of packages based on top of KDE Frameworks 5 and QML. They implement the KDE Display Environment (Plasma 5).

This package is known to build and work properly using an LFS 12.0 platform.

The instructions below build all of the Plasma 5 packages in one step by using a bash script.

Package Information

Plasma 5 Dependencies

Required

GTK+-2.24.33, GTK+-3.24.38, KDE Frameworks-5.109.0, kuserfeedback-1.2.0, libpwquality-1.4.5, libqalculate-4.7.0, libxkbcommon-1.5.0, Mesa-23.1.6 built with Wayland-1.22.0, NetworkManager-1.44.0, pipewire-0.3.77, PulseAudio-16.1, qca-2.3.7, sassc-3.6.2, taglib-1.13.1, and xcb-util-cursor-0.1.4

Recommended
Recommended (runtime)
Optional

GLU-9.0.3, ibus-1.5.28, qtwebengine-5.15.15, Xorg Synaptics Driver-1.9.2, appstream-qt, KDevPlatform, libgps, libhybris, libraw1394, mockcpp, packagekit-qt, Qalculate, Qapt, SCIM, and socat (for pam_kwallet)

Note

qtwebengine-5.15.15 is required for aura-browser. It is also optional for two other packages: libksysguard and kdeplasma-addons. If QtWebEngine is installed later, only these two packages need to be rebuilt. This allows a more complete display in the system monitor application.

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/kf5

Downloading KDE Plasma5

The easiest way to get the KDE Plasma5 packages is to use a single wget to fetch them all at once:

url=https://download.kde.org/stable/plasma/5.27.7/
wget -r -nH -nd -A '*.xz' -np $url

The options used here are:
  -r            recurse through child directories
  -nH           disable generation of host-prefixed directories
  -nd           do not create a hierarchy of directories
  -A '*.xz'     just get the *.xz files
  -np           don't get parent directories

Setting Package Order

The order of building files is important due to internal dependencies. Create the list of files in the proper order as follows:

cat > plasma-5.27.7.md5 << "EOF"
f8e36636128efc0172b0664df372f350  kdecoration-5.27.7.tar.xz
0f40e7e4ef0675cf06afc828c6056821  libkscreen-5.27.7.tar.xz
fdbbd274867d8013631eb66f889da983  libksysguard-5.27.7.tar.xz
6d0358ed7bbb27557c073cfce675120f  breeze-5.27.7.tar.xz
7dac534103b595e861fb923e0a46af8a  breeze-gtk-5.27.7.tar.xz
27839d93e7bf42bd8e6e9d822572a3d3  layer-shell-qt-5.27.7.tar.xz
56e13a523dc2b27dd2fe7d17cf87c427  kscreenlocker-5.27.7.tar.xz
1806b24c107c30a0144be0c58361c391  oxygen-5.27.7.tar.xz
b3b25a757de32befe4c282ebc9b928c3  kinfocenter-5.27.7.tar.xz
f992f11ed7704e94809f4a609b444074  kwin-5.27.7.tar.xz
5aa3a8e2e8c97b182cb15090f9149831  plasma-workspace-5.27.7.tar.xz
2b3c139e30eaaf4cf42706c9e6212ca5  plasma-disks-5.27.7.tar.xz
a347a0848863114e96ca25868b1d2483  bluedevil-5.27.7.tar.xz
77731f7530552c096785e938554c5c0e  kde-gtk-config-5.27.7.tar.xz
19a17f02655872c827380bd1fc485b50  khotkeys-5.27.7.tar.xz
4777cae88cb32e1dc77d6765f3cf17e3  kmenuedit-5.27.7.tar.xz
a9618c0aa86cf8d0186e146aef644cd7  kscreen-5.27.7.tar.xz
d75c043ef114b2b590f8ede12bb86a24  kwallet-pam-5.27.7.tar.xz
9c4ebb3d608c08c83b87a880b731ef11  kwayland-integration-5.27.7.tar.xz
2d04936cfcdb3da0ecab6b9c7f83339e  kwrited-5.27.7.tar.xz
ea10ad5ac86ad2a1f1c0dfdb28918ad8  milou-5.27.7.tar.xz
1640a01420f5885d87e55a3fc3ca8410  plasma-nm-5.27.7.tar.xz
24cdd5610e2b02c774486cdeaf0074f5  plasma-pa-5.27.7.tar.xz
4d941372e2a0ba9fe4a42a668dfd6aeb  plasma-workspace-wallpapers-5.27.7.tar.xz
003d40545b13d58a2fa024236c92c18f  polkit-kde-agent-1-5.27.7.tar.xz
2708af1b47a164321111220f3e3fb5f8  powerdevil-5.27.7.tar.xz
7f7d2bea26b4d825c9a6e8d57e400a4a  plasma-desktop-5.27.7.1.tar.xz
#b8f2c72d4d0ffd37573c1f949e8604aa  plasma-desktop-5.27.7.tar.xz
f66aefab6b7b3115ead7cf3966d6e2c6  kgamma5-5.27.7.tar.xz
614a24e70dfdcbf225047951d1bb35af  ksshaskpass-5.27.7.tar.xz
#8e9460adae337baab8d80da3422f9e34  plasma-sdk-5.27.7.1.tar.xz
#69bcb008dc0c22bb9dad2f990778b46e  plasma-sdk-5.27.7.5.27.7.1.tar.xz
#cba2b18c587dff393bd232d61a35046d  plasma-sdk-5.27.7.tar.xz
293fa8cd57834e07c719a055e2b47fbe  sddm-kcm-5.27.7.tar.xz
#7857d8972a9cc45cc3b672a6d5ff2b12  discover-5.27.7.tar.xz
#9727481d29a7468420cb1a37a0b36e9e  breeze-grub-5.27.7.tar.xz
#157416774eb4bfc57a4e2caf4512f069  breeze-plymouth-5.27.7.tar.xz
cdda9f9d374615768d8a324dae92ad1d  kactivitymanagerd-5.27.7.tar.xz
3e8fd694b222d4d6c3d4e2b952099fb0  plasma-integration-5.27.7.tar.xz
#7bd722f2799f4b1c562be46c5b2d0da1  plymouth-kcm-5.27.7.tar.xz
26e40eaf358dc02d71ab5cb511a5b3a8  xdg-desktop-portal-kde-5.27.7.tar.xz
ce2a9be64095829d124d4f83c14a464c  drkonqi-5.27.7.tar.xz
410818deea59fc12aa3ed155e350e931  plasma-vault-5.27.7.tar.xz
4636852897f802e64501fbae5e3dfb24  plasma-browser-integration-5.27.7.tar.xz
3febab89d2fca2e67271d5e35723d7be  kde-cli-tools-5.27.7.tar.xz
799ec2ab0012e47d2b1660affe5f333e  systemsettings-5.27.7.tar.xz
fa9f2208c27d8a3e99c0cbb113087338  plasma-thunderbolt-5.27.7.tar.xz
#c4dbf6737cc9d8d3396214d4bed14abf  plasma-nano-5.27.7.tar.xz
#74a1ec9c76b979fb8a3906204c93add4  plasma-mobile-5.27.7.tar.xz
ca0a794b2d65c9c763d0f932b2bd9c1e  plasma-firewall-5.27.7.tar.xz
4f3a9803e3741521b1867303b179670a  plasma-systemmonitor-5.27.7.tar.xz
29fb63dc5c266b3fe0a2e849f1a1db28  qqc2-breeze-style-5.27.7.tar.xz
2e3689a958a72aa1a09aa6edf471ce11  ksystemstats-5.27.7.tar.xz
08434c4829aefd689c877fe84baa5ad6  oxygen-sounds-5.27.7.tar.xz
#2b1b01328d062d6d9c3d92daaa26d13c  aura-browser-5.27.7.tar.xz
a32fedd93e3ecef504ea28ec27cbfd55  kdeplasma-addons-5.27.7.tar.xz
1d759ab0bb02f630385e4dc267aaef6e  kpipewire-5.27.7.tar.xz
553afd4e952b601147ca868b7129303d  plank-player-5.27.7.tar.xz
51ad32e45ad4a0f5291d1a9ce4efa0f2  plasma-bigscreen-5.27.7.tar.xz
fb25df16ef388f7dbfc163911e7828be  plasma-remotecontrollers-5.27.7.tar.xz
#507a8d13920b160b4683b093e90f6088  flatpak-kcm-5.27.7.tar.xz
#9eadbc5ec19e2122f81742e0f38941f7  plasma-welcome-5.27.7.tar.xz
EOF

About Commented out Packages

The breeze-grub, breeze-plymouth, and plymouth-kcm packages above are all for customized support of Plymouth which is designed to be run within an initial ram disk during boot (see the section called “About initramfs”). The plasma-sdk package is optional and used for software development. The plasma-nano package is used for embedded systems and plasma-mobile provides phone functionality for Plasma. The aura-browser package requires qtwebengine-5.15.15. The discover package requires the external package appstream-qt. The plasma-welcome package requires the external package kaccounts-integration. The flatpack-kcm package is for managing support of flatpack applications.

Installation of Plasma5

Note

When installing multiple packages in a script, the installation needs to be done as the root user. There are three general options that can be used to do this:

  1. Run the entire script as the root user (not recommended).

  2. Use the sudo command from the Sudo-1.9.14p3 package.

  3. Use su -c "command arguments" (quotes required) which will ask for the root password for every iteration of the loop.

One way to handle this situation is to create a short bash function that automatically selects the appropriate method. Once the command is set in the environment, it does not need to be set again.

as_root()
{
  if   [ $EUID = 0 ];        then $*
  elif [ -x /usr/bin/sudo ]; then sudo $*
  else                            su -c \\"$*\\"
  fi
}

export -f as_root

First, start a subshell that will exit on error:

bash -e

Install all of the packages by running the following commands:

while read -r line; do

    # Get the file name, ignoring comments and blank lines
    if $(echo $line | grep -E -q '^ *$|^#' ); then continue; fi
    file=$(echo $line | cut -d" " -f2)

    pkg=$(echo $file|sed 's|^.*/||')          # Remove directory
    packagedir=$(echo $pkg|sed 's|\.tar.*||') # Package directory

    tar -xf $file
    pushd $packagedir

       mkdir build
       cd    build

       cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
             -DCMAKE_BUILD_TYPE=Release         \
             -DBUILD_TESTING=OFF                \
             -Wno-dev ..  &&

        make
        as_root make install
    popd


    as_root rm -rf $packagedir
    as_root /sbin/ldconfig

done < plasma-5.27.7.md5

exit

If you did not set $KF5_PREFIX to /usr, create symlinks to allow display managers to find Plasma:

as_root install -dvm 755 /usr/share/xsessions              &&
cd /usr/share/xsessions/                                   &&
[ -e plasma.desktop ]                                      ||
as_root ln -sfv $KF5_PREFIX/share/xsessions/plasma.desktop &&
as_root install -dvm 755 /usr/share/wayland-sessions       &&
cd /usr/share/wayland-sessions/                            &&
[ -e plasmawayland.desktop ]                               ||
as_root ln -sfv $KF5_PREFIX/share/wayland-sessions/plasmawayland.desktop

Configuring Plasma

Linux PAM Configuration

If you built Plasma with the recommended Linux PAM support, create necessary configuration files by running the following commands as the root user:

cat > /etc/pam.d/kde << "EOF"
# Begin /etc/pam.d/kde

auth     requisite      pam_nologin.so
auth     required       pam_env.so

auth     required       pam_succeed_if.so uid >= 1000 quiet
auth     include        system-auth

account  include        system-account
password include        system-password
session  include        system-session

# End /etc/pam.d/kde
EOF

cat > /etc/pam.d/kde-np << "EOF"
# Begin /etc/pam.d/kde-np

auth     requisite      pam_nologin.so
auth     required       pam_env.so

auth     required       pam_succeed_if.so uid >= 1000 quiet
auth     required       pam_permit.so

account  include        system-account
password include        system-password
session  include        system-session

# End /etc/pam.d/kde-np
EOF

cat > /etc/pam.d/kscreensaver << "EOF"
# Begin /etc/pam.d/kscreensaver

auth    include system-auth
account include system-account

# End /etc/pam.d/kscreensaver
EOF

Starting Plasma5

You can start Plasma5 from a TTY, using xinit-1.4.2.

To start Plasma 5 using xinit-1.4.2, run the following commands:

cat > ~/.xinitrc << "EOF"
dbus-launch --exit-with-x11 $KF5_PREFIX/bin/startplasma-x11
EOF

startx

The X session starts on the first unused virtual terminal, normally vt7. You can switch to another vtn simultaneously pressing the keys Ctrl-Alt-Fn (n=1, 2, ...). To switch back to the X session, normally started at vt7, use Ctrl-Alt-F7. The vt where the command startx was executed will display many messages, including X starting messages, applications automatically started with the session, and eventually, some warning and error messages. You may prefer to redirect those messages to a log file, which not only will keep the initial vt uncluttered, but can also be used for debugging purposes. This can be done starting X with:

startx &> ~/x-session-errors

When shutting down or rebooting, the shutdown messages appear on the vt where X was running. If you wish to see those messages, simultaneously press keys Alt-F7 (assuming that X was running on vt7).

Contents

Installed Programs: There are too many plasma programs (63 in /opt/kf5/bin) to list separately here.
Installed Libraries: There are too many plasma libraries (40 in /opt/kf5/lib) to list separately here.
Installed Directories: There are too many plasma directories (over 1000 in /opt/kf5) to list separately here.

Part VIII. GNOME

Chapter 33. GNOME Libraries and Desktop

The objective of this section is to build a GNOME desktop.

Libraries

Gcr-3.41.1

Introduction to Gcr

The Gcr package contains libraries used for displaying certificates and accessing key stores. It also provides the viewer for crypto files on the GNOME Desktop.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Gcr Dependencies

Required

GLib-2.76.4, libgcrypt-1.10.2, and p11-kit-0.25.0

Recommended
Optional

Gi-DocGen-2023.1 and Valgrind-3.21.0

Installation of Gcr

Install Gcr by running the following commands:

sed -i 's:"/desktop:"/org:' schema/*.xml &&

mkdir build &&
cd    build &&

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dgtk_doc=false     \
            ..                  &&
ninja

If you have Gi-DocGen-2023.1 installed and wish to build the API documentation for this package, issue:

sed -e "/install_dir/s@,\$@ / 'gcr-3.41.1'&@" \
    -e "/fatal-warnings/d"                    \
    -i ../docs/*/meson.build                  &&
meson configure -Dgtk_doc=true                &&
ninja

To test the results, issue: ninja test. The tests must be run from an X Terminal or similar.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dgtk=false: Use this switch if you haven't installed GTK+-3.24.38. Note that gcr-viewer will not be installed if this is passed to meson.

-Dgtk_doc=true: Allow building this package without Gi-DocGen-2023.1 installed. If you have Gi-DocGen-2023.1 installed and you wish to rebuild and install the API documentation, a meson configure command will reset this option.

Contents

Installed Program: gcr-viewer
Installed Libraries: libgck-1.so, libgcr-base-3.so and libgcr-ui-3.so
Installed Directories: /usr/include/gck-1, /usr/include/gcr-3, and /usr/share/gtk-doc/html/{gcr,gck}

Short Descriptions

gcr-viewer

is used to view certificates and key files

libgck-1.so

contains GObject bindings for PKCS#11

Gcr-4.1.0

Introduction to Gcr

The Gcr package contains libraries used for displaying certificates and accessing key stores. It also provides the viewer for crypto files on the GNOME Desktop.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Gcr Dependencies

Required

GLib-2.76.4, libgcrypt-1.10.2, and p11-kit-0.25.0

Recommended
Optional

Gi-DocGen-2023.1 and Valgrind-3.21.0

Installation of Gcr

Note

Both gcr-3 and gcr-4 are coinstallable. This version of the package is used to support GTK-4 applications, such as gnome-shell-44.3 and Epiphany-44.6.

Install Gcr by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dgtk_doc=false     \
            ..                  &&
ninja

If you have Gi-DocGen-2023.1 installed and wish to build the API documentation for this package, issue:

sed -e "/install_dir/s@,\$@ / 'gcr-4.1.0'&@" \
    -e "/fatal-warnings/d"                   \
    -i ../docs/*/meson.build                 &&
meson configure -Dgtk_doc=true               &&
ninja

To test the results, issue: ninja test. The tests must be run from an X Terminal or similar.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dgtk=false: Use this switch if you haven't installed GTK-4.12.0. Note that gcr-viewer will not be installed if this is passed to meson.

-Dgtk_doc=true: Allow building this package without Gi-DocGen-2023.1 installed. If you have Gi-DocGen-2023.1 installed and you wish to rebuild and install the API documentation, a meson configure command will reset this option.

Contents

Installed Program: gcr-viewer-gtk4
Installed Libraries: libgck-2.so, libgcr-4.so
Installed Directories: /usr/include/gck-2, /usr/include/gcr-4, and /usr/share/gtk-doc/html/{gcr,gck}

Short Descriptions

gcr-viewer-gtk4

is used to view certificates and key files

libgck-2.so

contains GObject bindings for PKCS#11

libgcr-4.so

contains functions for accessing key stores and displaying certificates

gsettings-desktop-schemas-44.0

Introduction to GSettings Desktop Schemas

The GSettings Desktop Schemas package contains a collection of GSettings schemas for settings shared by various components of a GNOME Desktop.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GSettings Desktop Schemas Dependencies

Required

gobject-introspection-1.76.1

Installation of GSettings Desktop Schemas

Install GSettings Desktop Schemas by running the following commands:

sed -i -r 's:"(/system):"/org/gnome\1:g' schemas/*.in &&

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Note

If you installed the package to your system using a DESTDIR method, /usr/share/glib-2.0/schemas/gschemas.compiled was not updated/created. Create (or update) the file using the following command as the root user:

glib-compile-schemas /usr/share/glib-2.0/schemas

Command Explanations

sed ... schemas/*.in: This command fixes some deprecated entries in the schema templates.

Contents

Installed Programs: None
Installed Libraries: None
Installed Directory: /usr/include/gsettings-desktop-schemas and /usr/share/GConf/gsettings

libsecret-0.21.0

Introduction to libsecret

The libsecret package contains a GObject based library for accessing the Secret Service API.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libsecret Dependencies

Required

GLib-2.76.4

Recommended
Optional

Gi-DocGen-2023.1 and docbook-xml-4.5, docbook-xsl-nons-1.79.2, libxslt-1.1.38 (to build manual pages), and Valgrind-3.21.0 (can be used in tests)

Optional (Required for the test suite)

D-Bus Python-1.3.2, Gjs-1.76.2, PyGObject-3.44.1 (Python 3 module), and tpm2-tss

Runtime Dependency

gnome-keyring-42.1

Note

Any package requiring libsecret expects GNOME Keyring to be present at runtime.

Installation of libsecret

Install libsecret by running the following commands:

mkdir bld &&
cd    bld &&

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dgtk_doc=false     \
            ..                  &&
ninja

If you have Gi-DocGen-2023.1 installed and wish to build the API documentation for this package, issue:

sed "s/api_version_major/'0.20.5'/"            \
    -i ../docs/reference/libsecret/meson.build &&
meson configure -Dgtk_doc=true                 &&
ninja

Now, as the root user:

ninja install

To test the results, issue: dbus-run-session ninja test.

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dgtk_doc=false: Allow building this package without Gi-DocGen-2023.1 installed. If you have Gi-DocGen-2023.1 installed and you wish to rebuild and install the API documentation, a meson configure command will reset this option.

-Dmanpage=false: Use this switch if you have not installed libxslt-1.1.38 and DocBook packages.

-Dgcrypt=false: Use this switch if you have not installed the recommended dependency of libgcrypt-1.10.2.

Contents

Installed Program: secret-tool
Installed Library: libsecret-1.so
Installed Directories: /usr/include/libsecret-1 and /usr/share/doc/libsecret-0.21.0

Short Descriptions

secret-tool

is a command line tool that can be used to store and retrieve passwords

libsecret-1.so

contains the libsecret API functions

rest-0.9.1

Introduction to rest

The rest package contains a library that was designed to make it easier to access web services that claim to be "RESTful". It includes convenience wrappers for libsoup and libxml to ease remote use of the RESTful API.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

rest Dependencies

Required

JSON-GLib-1.6.6, libsoup-3.4.2, and make-ca-1.12

Recommended
Optional

Gi-DocGen-2023.1, libadwaita-1.3.4 and gtksourceview5-5.8.0 (to build the demo), and Vala-0.56.11

Installation of rest

Install rest by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dexamples=false    \
            -Dgtk_doc=false     \
            ..                  &&
ninja

If you have Gi-DocGen-2023.1 installed and wish to build the API documentation for this package, issue:

sed "/output/s/librest-1.0/rest-0.9.1/" -i ../docs/meson.build &&
meson configure -Dgtk_doc=true                                 &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dgtk_doc=false: Allow building this package without Gi-DocGen-2023.1 installed. If you have Gi-DocGen-2023.1 installed and you wish to rebuild and install the API documentation, a meson configure command will reset this option.

-Dexamples=false: Remove this option if libadwaita-1.3.4 and gtksourceview5-5.8.0 are installed and you wish to build the demonstration application provided by this package.

-Dvapi=true: Use this switch if Vala-0.56.11 is installed and you wish to build the Vala bindings provided by this package.

Contents

Installed Programs: librest-demo (optional)
Installed Libraries: librest-1.0.so and librest-extras-1.0.so
Installed Directories: /usr/include/rest-1.0 and /usr/share/gtk-doc/html/rest-1.0

Short Descriptions

librest-demo

provides an example of how to use the RESTful Web API Query functions

librest-1.0.so

contains the RESTful Web API Query functions

librest-extras-1.0.so

contains extra RESTful Web API Query functions

totem-pl-parser-3.26.6

Introduction to Totem PL Parser

The Totem PL Parser package contains a simple GObject-based library used to parse multiple playlist formats.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Totem PL Parser Dependencies

Recommended
Optional

CMake-3.27.2, GTK-Doc-1.33.2, Gvfs-1.50.6 (for some tests), LCOV, and libquvi >= 0.9.1 and libquvi-scripts - if they are installed, then lua-socket (git) is necessary for the tests

Note

An Internet connection is needed for some tests of this package.

Installation of Totem PL Parser

Install Totem PL Parser by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test. The test named parser is known to fail.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Programs: None
Installed Libraries: libtotem-plparser-mini.so and libtotem-plparser.so
Installed Directories: /usr/include/totem-pl-parser and /usr/share/gtk-doc/html/totem-pl-parser

Short Descriptions

libtotem-plparser.so

is the Totem Playlist Parser library

libtotem-plparser-mini.so

is the Totem Playlist Parser library, mini version

VTE-0.72.2

Introduction to VTE

The VTE package contains a termcap file implementation for terminal emulators.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

VTE Dependencies

Required

GTK+-3.24.38, libxml2-2.10.4, and pcre2-10.42

Recommended
Optional

FriBidi-1.0.13, Gi-DocGen-2023.1, and GTK-4.12.0

Installation of VTE

Install VTE by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release -Dfribidi=false .. &&
ninja

If you have Gi-DocGen-2023.1 installed and wish to build the API documentation for this package, issue:

sed -e "/docdir =/s@\$@/ 'vte-0.72.2'@" \
    -e "/fatal-warnings/d"              \
    -i ../doc/reference/meson.build     &&
meson configure -Ddocs=true             &&
ninja

To test the results, issue ninja test.

Now, as the root user:

ninja install &&
rm -v /etc/profile.d/vte.*

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

rm -v /etc/profile.d/vte.*: This command removes two files installed in /etc/profile.d that have no use on a LFS system.

-Dfribidi=false: Omit this switch if you want to enable bidirectional capabilities.

-Dgnutls=false: Add this switch if you do not want to enable GnuTLS support.

-Dvapi=false: Add this switch if you do not want to enable vala bindings.

-Dgtk4=true: Add this switch to build the GTK4 widget.

Contents

Installed Program: vte-2.91
Installed Library: libvte-2.91.so
Installed Directories: /usr/include/vte-2.91 and (optional) /usr/share/doc/vte-0.72.2

Short Descriptions

vte-2.91

is a test application for the VTE libraries

libvte-2.91.so

is a library which implements a terminal emulator widget for GTK+ 3

yelp-xsl-42.1

Introduction to Yelp XSL

The Yelp XSL package contains XSL stylesheets that are used by the Yelp help browser to format Docbook and Mallard documents.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Yelp XSL Dependencies

Required

libxslt-1.1.38 and itstool-2.0.7

Installation of Yelp XSL

Install Yelp XSL by running the following commands:

./configure --prefix=/usr

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: None
Installed Directory: /usr/share/yelp-xsl

GConf-3.2.6

Introduction to GConf

The GConf package contains a configuration database system used by many GNOME applications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GConf Dependencies

Required

dbus-glib-0.112 and libxml2-2.10.4

Recommended
Optional

OpenLDAP-2.6.6

Installation of GConf

Install GConf by running the following commands:

./configure --prefix=/usr \
            --sysconfdir=/etc \
            --disable-orbit \
            --disable-static &&
make

This package does not come with a test suite.

Now, as the root user:

make install &&
ln -s gconf.xml.defaults /etc/gconf/gconf.xml.system

Command Explanations

--disable-orbit: This switch is required if ORBit2 is not installed. ORBit2 is a deprecated package.

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: gconf-merge-tree, gconftool-2, gsettings-data-convert and gsettings-schema-convert
Installed Libraries: libgconf-2.so and libgsettingsgconfbackend.so (GIO Module installed in /usr/lib/gio/modules)
Installed Directories: /etc/gconf, /usr/include/gconf, /usr/lib/GConf, /usr/share/gtk-doc/html/gconf and /usr/share/sgml/gconf

Short Descriptions

gconf-merge-tree

merges an XML filesystem hierarchy

gconftool-2

is a command line tool used for manipulating the GConf database

gsettings-data-convert

reads values out of the users GConf database and stores them in GSettings

gsettings-schemas-convert

converts between GConf and GSettings schema file formats

libgconf-2.so

provides the functions necessary to maintain the configuration database

geocode-glib-3.26.4

Introduction to Geocode GLib

The Geocode GLib is a convenience library for the Yahoo! Place Finder APIs. The Place Finder web service allows to do geocoding (finding longitude and latitude from an address), and reverse geocoding (finding an address from coordinates).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Geocode GLib Dependencies

Required

JSON-GLib-1.6.6 and libsoup-3.4.2

Recommended
Optional

GTK-Doc-1.33.2

Installation of Geocode GLib

Install Geocode GLib by running the following commands:

mkdir build                   &&
cd    build                   &&

meson setup --prefix /usr           \
            --buildtype=release     \
            -Denable-gtk-doc=false  \
            -Dsoup2=false           \
            ..                      &&
ninja

To test the results, issue: LANG=C ninja test. One test fails because it needs the sv_SE.utf8 locale, which is not installed by default in LFS.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Denable-gtk-doc=false: Allow this package to be built without GTK-Doc-1.33.2. Remove this parameter if GTK-Doc-1.33.2 is installed and you wish to rebuild and install the API documentation.

-Dsoup2=false: This switch forces this package to use libsoup-3 for HTTP requests instead of libsoup-2. The packages in BLFS that use geocode-glib now expect libsoup-3 to be used.

Contents

Installed Programs: None
Installed Library: libgeocode-glib-2.so
Installed Directories: /usr/include/geocode-glib-2.0, /usr/libexec/installed-tests/geocode-glib, /usr/share/icons/gnome/scalable/places, and /usr/share/gtk-doc/html/geocode-glib

Short Descriptions

libgeocode-glib-2.so

contains the Geocode GLib API functions

Gjs-1.76.2

Introduction to Gjs

Gjs is a set of Javascript bindings for GNOME.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Gjs Dependencies

Required

Cairo-1.17.6, dbus-1.14.8, gobject-introspection-1.76.1, and JS-102.13.0

Recommended (required for GNOME)
Optional

sysprof-3.48.0, Valgrind-3.21.0 (for tests), DTrace, LCOV, and Systemtap

Installation of Gjs

Install Gjs by running the following commands:

mkdir gjs-build &&
cd    gjs-build &&

meson setup --prefix=/usr          \
            --buildtype=release    \
            --wrap-mode=nofallback \
            ..                     &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

--wrap-mode=nofallback: This switch prevents meson from using subproject fallbacks for any dependency declarations in the build files, stopping it downloading any optional dependency which is not installed on the system.

-Dprofiler=disabled: prevents building the profiler backend even if sysprof-3.48.0 is installed.

Contents

Installed Programs: gjs (symlink) and gjs-console
Installed Library: libgjs.so
Installed Directories: /usr/include/gjs-1.0, /usr/lib/gjs, /usr/libexec/installed-tests/gjs, /usr/share/gjs-1.0, and /usr/share/installed-tests/gjs

Short Descriptions

gjs-console

contains a console to run JavaScript commands

libgjs.so

contains the GNOME JavaScript bindings

gnome-autoar-0.4.4

Introduction to gnome-autoar

The gnome-autoar package provides a framework for automatic archive extraction, compression, and management.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

gnome-autoar Dependencies

Required

libarchive-3.7.1 and GTK+-3.24.38

Recommended
Optional

GTK-Doc-1.33.2 (for building documentation)

Installation of gnome-autoar

Install gnome-autoar by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dvapi=true         \
            -Dtests=true        \
            ..                  &&
ninja

To test the results, issue: ninja test

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dgtk_doc=true: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: None
Installed Libraries: libgnome-autoar-0.so and libgnome-autoar-gtk-0.so
Installed Directories: /usr/include/gnome-autoar-0 and /usr/share/gtk-doc/html/gnome-autoar

Short Descriptions

libgnome-autoar-0.so

provides API functions for automatic archive management

libgnome-autoar-gtk-0.so

provides GTK+ widgets to aid in automatic archive management

gnome-desktop-44.0

Introduction to GNOME Desktop

The GNOME Desktop package contains a library that provides an API shared by several applications on the GNOME Desktop.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME Desktop Dependencies

Required

gsettings-desktop-schemas-44.0, GTK+-3.24.38, GTK-4.12.0, ISO Codes-4.15.0, itstool-2.0.7, libseccomp-2.5.4, libxml2-2.10.4, and xkeyboard-config-2.39

Recommended
Optional

GTK-Doc-1.33.2

Installation of GNOME Desktop

Install GNOME Desktop by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr       \
            --buildtype=release \
            ..                  &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dgtk_doc=true: Use this parameter if you wish to build the API documentation.

-Dinstalled_tests=true: Use this parameter you wish to enable the installed tests.

Contents

Installed Programs: None
Installed Library: libgnome-bg-4.so, libgnome-desktop-3.so, libgnome-desktop-4.so, and libgnome-rr-4.so
Installed Directories: /usr/include/gnome-desktop-3.0, /usr/include/gnome-desktop-4.0, /usr/libexec/gnome-desktop-debug, /usr/share/gtk-doc/html/gnome-desktop3 (optional), and /usr/share/help/*/{fdl,gpl,lgpl}

Short Descriptions

libgnome-desktop-3.so

contains functions shared by several GNOME applications

gnome-menus-3.36.0

Introduction to GNOME Menus

The GNOME Menus package contains an implementation of the draft Desktop Menu Specification from freedesktop.org. It also contains the GNOME menu layout configuration files and .directory files.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME Menus Dependencies

Required

GLib-2.76.4

Recommended

Installation of GNOME Menus

Install GNOME Menus by running the following commands:

./configure --prefix=/usr \
            --sysconfdir=/etc \
            --disable-static &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Libraries: libgnome-menu-3.so
Installed Directories: /etc/xdg/menus, /usr/include/gnome-menus-3.0, and /usr/share/desktop-directories

Short Descriptions

libgnome-menu-3.so

contains functions required to support GNOME's implementation of the Desktop Menu Specification

gnome-video-effects-0.6.0

Introduction to GNOME Video Effects

The GNOME Video Effects package contains a collection of GStreamer effects.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of GNOME Video Effects

Install GNOME Video Effects by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Contents

Installed Programs: None
Installed Libraries: None
Installed Directory: /usr/share/gnome-video-effects

gnome-online-accounts-3.48.0

Introduction to GNOME Online Accounts

The GNOME Online Accounts package contains a framework used to access the user's online accounts.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME Online Accounts Dependencies

Required

Gcr-3.41.1, JSON-GLib-1.6.6, rest-0.9.1, Vala-0.56.11, and WebKitGTK-2.41.91

Recommended
Optional

GTK-Doc-1.33.2, MIT Kerberos V5-1.21.2, and Valgrind-3.21.0

Installation of GNOME Online Accounts

Note

The Google API Key and OAuth tokens below are specific to LFS. If using these instructions for another distro, or if you intend to distribute binary copies of the software using these instructions, please obtain your own keys following the instructions located at https://www.chromium.org/developers/how-tos/api-keys.

Install GNOME Online Accounts by running the following commands:

mkdir build &&
cd    build &&

meson setup                                           \
      --prefix=/usr                                   \
      --buildtype=release                             \
      -Dkerberos=false                                \
      -Dgoogle_client_secret=5ntt6GbbkjnTVXx-MSxbmx5e \
      -Dgoogle_client_id=595013732528-llk8trb03f0ldpqq6nprjp1s79596646.apps.googleusercontent.com \
      .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dgoogle_*: These switches set the BLFS OAuth ID and secret for Google services.

-Dgtk_doc=true: Use this switch if you have GTK-Doc-1.33.2 installed and you wish to generate the API documentation.

-Dkerberos=true: Use this switch if you have installed MIT Kerberos V5-1.21.2 and wish to use it with GNOME Online Accounts.

Contents

Installed Programs: goa-daemon and goa-identity-service (library executables)
Installed Libraries: libgoa-1.0.so and libgoa-backend-1.0.so
Installed Directories: /usr/include/goa-1.0, /usr/lib/goa-1.0, and /usr/share/gtk-doc/html/goa (optional)

Short Descriptions

goa-daemon

is the GNOME Online Accounts Daemon

libgoa-1.0.so

contains the GNOME Online Accounts API functions

libgoa-backend-1.0.so

contains functions used by GNOME Online Accounts backends

Grilo-0.3.16

Introduction to Grilo

Grilo is a framework focused on making media discovery and browsing easy for applications and application developers.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Grilo Dependencies

Required

GLib-2.76.4 and libxml2-2.10.4

Recommended
Optional

DocBook-utils-0.6.14, liboauth-1.0.3, and GTK-Doc-1.33.2

Installation of Grilo

Install Grilo by running the following commands:

mkdir build &&
cd    build    &&

meson setup --prefix=/usr          \
            --buildtype=release    \
            -Denable-gtk-doc=false \
            ..                     &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Denable-gtk-doc=false: This option disables generating documentation. If you have GTK-Doc-1.33.2 installed and wish to generate documentation, remove this option.

Contents

Installed Programs: grilo-test-ui-0.3, grl-inspect-0.3 and grl-launch-0.3
Installed Libraries: libgrilo-0.3.so, libgrlnet-0.3.so and libgrlpls-0.3.so
Installed Directories: /usr/include/grilo-0.3

Short Descriptions

grilo-test-ui-0.3

is a simple playground application that you can use to test the framework and its plugins

grl-inspect-0.3

is a tool that prints out information on available Grilo sources

grl-launch-0.3

is a tool to run Grilo operations from command line

libgrilo.so

provides the Grilo framework

libgrlnet.so

provides Grilo networking helpers for plug-ins

libgrlpls.so

provides playlist handling functions

libchamplain-0.12.21

Introduction to libchamplain

The libchamplain package contains a Clutter-based widget that is used to display rich and interactive maps.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libchamplain Dependencies

Required

clutter-gtk-1.8.4, GTK+-3.24.38, libsoup-3.4.2, and SQLite-3.42.0

Recommended
Optional

GTK-Doc-1.33.2 and libmemphis

Installation of libchamplain

Install libchamplain by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Programs: None
Installed Libraries: libchamplain-0.12.so and libchamplain-gtk-0.12.so
Installed Directories: /usr/include/champlain-0.12 and /usr/share/gtk-doc/html/champlain-0.12

Short Descriptions

libchamplain-0.12.so

contains the libchamplain API functions

libchamplain-gtk-0.12.so

contains the libchamplain GTK+ bindings

libgdata-0.18.1

Introduction to libgdata

The libgdata package is a GLib-based library for accessing online service APIs using the GData protocol, most notably, Google's services. It provides APIs to access the common Google services and has full asynchronous support.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libgdata Dependencies

Required

libsoup-2.74.3, gnome-online-accounts-3.48.0, GTK+-3.24.38, JSON-GLib-1.6.6, and Vala-0.56.11

Recommended
Optional

GTK-Doc-1.33.2 (for documentation), liboauth-1.0.3 (for OAuth v1 support), and uhttpmock-0.5.3 (required for tests)

Installation of libgdata

Install libgdata by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr              \
            --buildtype=release        \
            -Dgtk_doc=false            \
            -Dalways_build_tests=false \
            ..                         &&
ninja

If you wish to run the test suite, make sure uhttpmock-0.5.3 is installed and remove -Dalways_build_tests=false in the meson command line. To test the results, issue: ninja test. Note that the tests need network access.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dgtk_doc=false: Remove this if you have GTK-Doc-1.33.2 installed and want to rebuild the documentation with it.

-Doauth1=enabled: Use this option if you wish to build in support for OAuth v1. Note that you must have liboauth-1.0.3 installed in order to enable this option.

Contents

Installed Programs: None
Installed Libraries: libgdata.so
Installed Directories: /usr/include/libgdata and /usr/share/gtk-doc/html/gdata

Short Descriptions

libgdata.so

contains the libgdata API functions

libgee-0.20.6

Introduction to libgee

The libgee package is a collection library providing GObject based interfaces and classes for commonly used data structures.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libgee Dependencies

Required

GLib-2.76.4

Recommended
Optional

Vala-0.56.11 (with Valadoc) and LCOV

Installation of libgee

Install libgee by running the following commands:

./configure --prefix=/usr &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Library: libgee-0.8.so
Installed Directory: /usr/include/gee-0.8

Short Descriptions

libgee-0.8.so

contains the libgee API functions

libgtop-2.40.0

Introduction to libgtop

The libgtop package contains the GNOME top libraries.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libgtop Dependencies

Required

GLib-2.76.4 and Xorg Libraries

Recommended
Optional

GTK-Doc-1.33.2

Installation of libgtop

Install libgtop by running the following commands:

./configure --prefix=/usr --disable-static &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: libgtop_daemon2 and libgtop_server2
Installed Library: libgtop-2.0.so
Installed Directories: /usr/include/libgtop-2.0 and /usr/share/gtk-doc/html/libgtop

Short Descriptions

libgtop-2.0.so

contains functions that allow access to system performance data

libgweather-4.2.0

Introduction to libgweather

The libgweather package is a library used to access weather information from online services for numerous locations.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libgweather Dependencies

Required

geocode-glib-3.26.4, GTK+-3.24.38, libsoup-3.4.2, and PyGObject-3.44.1

Recommended
Optional

Gi-DocGen-2023.1 (gi-docgen is also provided as a meson subproject, which will be used if -Dgtk_doc=false is not passed to meson), LLVM-16.0.5 (for clang-format), and pylint

Installation of libgweather

Install libgweather by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dgtk_doc=false     \
            ..                  &&
ninja

If you have Gi-DocGen-2023.1 installed and wish to build the API documentation for this package, issue:

sed "s/libgweather_full_version/'libgweather-4.2.0'/" \
    -i ../doc/meson.build                             &&
meson configure -Dgtk_doc=true                        &&
ninja

One test needs that the locale files be installed on the system, so it is better to run the tests after installing the package.

Now, as the root user:

ninja install

To test the results, issue: LC_ALL=C ninja test. One test, metar, is known to fail.

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dgtk_doc=false: Allow building this package without Gi-DocGen-2023.1 installed. If you have Gi-DocGen-2023.1 installed and you wish to rebuild and install the API documentation, a meson configure command will reset this option.

Contents

Installed Programs: None
Installed Libraries: libgweather-4.so
Installed Directories: /usr/lib/libgweather-4, /usr/include/libgweather-4.0, /usr/share/gtk-doc/html/libgweather-4.0 (optional), and /usr/share/libgweather-4

Short Descriptions

libgweather-4.so

contains functions that allow the retrieval of weather information

libpeas-1.36.0

Introduction to libpeas

libpeas is a GObject based plugins engine, and is targeted at giving every application the chance to assume its own extensibility.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libpeas Dependencies

Required

gobject-introspection-1.76.1 and GTK+-3.24.38

Recommended
Optional

Gi-DocGen-2023.1, Glade, embed, LGI (for LUA bindings, built with LUA-5.1), with either luajit or LUA-5.1

Installation of libpeas

Install libpeas by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr          \
            --buildtype=release    \
            --wrap-mode=nofallback \
            ..                     &&
ninja

If you have Gi-DocGen-2023.1 installed and wish to build the API documentation for this package, issue:

sed "/docs_dir =/s@\$@/ 'libpeas-1.36.0'@" \
    -i ../docs/reference/meson.build       &&
meson configure -Dgtk_doc=true             &&
ninja

To test the results, issue: ninja test. An active graphical session with bus address is necessary to run the tests.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

--wrap-mode=nofallback: This switch prevents meson from using subproject fallbacks for any dependency declarations in the build files, stopping it downloading any optional dependency which is not installed on the system.

-Dvapi=true: Add this switch if you wish to generate vapi (vala) data.

-Ddemos=false: Add this switch if you do not wish to build the demo programs.

Contents

Installed Program: peas-demo
Installed Libraries: libpeas-1.0.so and libpeas-gtk-1.0.so
Installed Directories: /usr/include/libpeas-1.0, /usr/lib/libpeas-1.0, /usr/lib/peas-demo and /usr/share/gtk-doc/html/libpeas (optional)

Short Descriptions

peas-demo

is the Peas demo program

libpeas-1.0.so

contains the libpeas API functions

libpeas-gtk-1.0.so

contains the libpeas GTK+ widgets

libshumate-1.0.5

Introduction to libshumate

The libshumate package contains a GTK-4 widget to display maps.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libshumate Dependencies

Required

GTK-4.12.0 and libsoup-3.4.2

Recommended
Optional

Gi-DocGen-2023.1

Installation of libshumate

Install libshumate by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dgtk_doc=false     \
            ..                  &&
ninja

If you have Gi-DocGen-2023.1 installed and wish to build the API documentation for this package, issue:

sed 's/lib_version/version/' -i ../docs/meson.build &&
meson configure -Dgtk_doc=true                      &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Programs: None
Installed Libraries: libshumate-1.0.so
Installed Directories: /usr/include/shumate-1.0 and /usr/share/doc/libshumate-1.0.5 (optional)

Short Descriptions

libshumate-1.0.so

contains functions that provide a GTK-4 widget to display maps

libwnck-43.0

Introduction to libwnck

The libwnck package contains the Window Navigator Construction Kit.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libwnck Dependencies

Required

GTK+-3.24.38

Recommended
Optional

GTK-Doc-1.33.2

Installation of libwnck

Install libwnck by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dgtk_doc=true: Use this option to build the API reference manual.

Contents

Installed Program: wnckprop and wnck-urgency-monitor
Installed Library: libwnck-3.so
Installed Directories: /usr/include/libwnck-3.0 and /usr/share/gtk-doc/html/libwnck-3.0

Short Descriptions

wnckprop

is used to print or modify the properties of a screen/workspace/window, or to interact with it

libwnck-3.so

contains functions for writing pagers and task lists

evolution-data-server-3.48.4

Introduction to Evolution Data Server

The Evolution Data Server package provides a unified backend for programs that work with contacts, tasks, and calendar information. It was originally developed for Evolution (hence the name), but is now used by other packages as well.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Evolution Data Server Dependencies

Required

libical-3.0.16, libsecret-0.21.0, nss-3.92, and SQLite-3.42.0

Recommended
Optional

Berkeley DB-5.3.28, GTK-Doc-1.33.2, MIT Kerberos V5-1.21.2, a MTA (that provides a sendmail command), OpenLDAP-2.6.6, and libphonenumber

Installation of Evolution Data Server

Install Evolution Data Server by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr    \
      -DSYSCONF_INSTALL_DIR=/etc     \
      -DENABLE_VALA_BINDINGS=ON      \
      -DENABLE_INSTALLED_TESTS=ON    \
      -DWITH_OPENLDAP=OFF            \
      -DWITH_KRB5=OFF                \
      -DENABLE_INTROSPECTION=ON      \
      -DENABLE_GTK_DOC=OFF           \
      -DWITH_LIBDB=OFF               \
      -Wno-dev -G Ninja ..           &&
ninja

Now, as the root user:

ninja install

To test the results, issue: ninja test.

Command Explanations

-DENABLE_VALA_BINDINGS=ON: This switch enables building the Vala bindings. Remove if you don't have Vala-0.56.11 installed.

-DENABLE_GTK_DOC=OFF: This switch disables building the API documentation. It is broken for this package due to the use of a long deprecated gtk-doc program that is no longer available.

-DWITH_LIBDB=OFF: This switch allows building this package without Berkeley DB-5.3.28. This package only uses Berkeley DB-5.3.28 to import data from very outdated releases. SQLite-3.42.0 is used for normal operation.

-DENABLE_OAUTH2_WEBKITGTK4=OFF: Use this switch if you did not build WebKitGTK-2.41.91 with GTK-4.

Note

To enable many of the optional dependencies, review the information from cmake -L CMakeLists.txt for the necessary parameters you must pass to the cmake command.

Contents

Installed Programs: None
Installed Libraries: libcamel-1.2.so, libebackend-1.2.so, libebook-1.2.so, libebook-contacts-1.2.so, libecal-2.0.so, libedata-book-1.2.so, libedata-cal-2.0.so, libedataserver-1.2.so, libedataserverui-1.2.so, libedataserverui4-1.0.so, and libetestserverutils.so
Installed Directories: /usr/include/evolution-data-server, /usr/lib{,exec}/evolution-data-server, /usr/share/evolution-data-server, /usr/share/installed-tests/evolution-data-server, and /usr/share/pixmaps/evolution-data-server

Short Descriptions

libcamel-1.2.so

is the Evolution MIME message handling library

libebackend-1.2.so

is the utility library for Evolution Data Server Backends

libebook-1.2.so

is the client library for Evolution address books

libebook-contacts-1.2.so

is the client library for Evolution contacts

libecal-1.2.so

is the client library for Evolution calendars

libedata-book-1.2.so

is the backend library for Evolution address books

libedata-cal-1.2.so

is the backend library for Evolution calendars

libedataserver-1.2.so

is the utility library for Evolution Data Server

libedataserverui-3.0.so

is the GUI utility library for Evolution Data Server

libedataserverui4-1.0.so

is the GTK-4 based GUI utility library for Evolution Data Server

libetestserverutils.so

is the server test utility library for Evolution Data Server

Tracker-3.5.3

Introduction to Tracker

Tracker is the file indexing and search provider used in the GNOME desktop environment.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Tracker Dependencies

Required

JSON-GLib-1.6.6, libseccomp-2.5.4, and Vala-0.56.11

Recommended
Optional

asciidoc-10.2.0, Graphviz-8.1.0, libsoup-2.74.3, bash-completion, and libstemmer

Installation of Tracker

Fix the location to install the documentation into:

mv docs/reference/libtracker-sparql/doc/{Tracker-3.0,tracker-3.5.3} &&
sed '/docs_name/s/Tracker-3.0/tracker-3.5.3/' \
    -i docs/reference/libtracker-sparql/meson.build

Install Tracker by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dman=false         \
            ..                  &&
ninja

Now, as the root user:

ninja install

To test the results, issue: meson configure -Ddebug=true && ninja test. The test suite should be run from a graphical session. One test, tracker: fts / fts, is known to fail due to an incompatibility with SQLite-3.42.

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dman=false: This switch prevents the build process from generating man pages. Omit this switch if you have asciidoc-10.2.0 installed and wish to generate and install the man pages.

meson configure -Ddebug=true: This command enables some debug checks necessary for the test suite. We don't want to enable them for the installed Tracker 3 libraries and programs, so we run the test suite after installation.

Contents

Installed Programs: tracker3
Installed Library: libtracker-sparql-3.0.so
Installed Directories: /usr/{include,lib}/tracker-3.0, /usr/libexec/tracker3, /usr/share/tracker3, and /usr/share/doc/Tracker-3.0 (optional)

Short Descriptions

tracker3

is a control program for the indexer

libtracker-sparql-3.0.so

contains resource management and database functions

Tracker-miners-3.5.2

Introduction to Tracker-miners

The Tracker-miners package contains a set of data extractors for Tracker.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Tracker-miners Dependencies

Required

gst-plugins-base-1.22.5, Tracker-3.5.3, Exempi-2.6.4, and gexiv2-0.14.2

Recommended
Optional

asciidoc-10.2.0, CMake-3.27.2, DConf-0.40.0, FFmpeg-6.0, libgsf-1.14.50, NetworkManager-1.44.0, taglib-1.13.1, totem-pl-parser-3.26.6, UPower-1.90.2, libcue, libitpcdata, libosinfo, and gupnp

Installation of Tracker-miners

Note

If you plan to run the tests, some timeouts are too short when using spinning disks. There are two places where timeouts are used: first, individual tests inside a group of tests have a default timeout of 10s. This can be changed by setting the environment variable TRACKER_TESTS_AWAIT_TIMEOUT to the desired value when running the tests (see below). Second, a global timeout for a group of tests is fixed at configuration time. The default value in the functional-tests directory (other directories have only short lived tests) may be increased with the following command (replace 200 with a value suitable for your machine):

sed -i s/120/200/ tests/functional-tests/meson.build

Install Tracker-miners by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dman=false         \
            ..                  &&
ninja

To test the results, issue (adjust the individual test timeout to a value suitable for your machine, see the note above):

dbus-run-session env TRACKER_TESTS_AWAIT_TIMEOUT=20 ninja test &&
rm -rf ~/tracker-tests

Note

The tests create files in the user directory (up to 24 MB), so they have to be removed afterwards.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dman=false: This switch prevents the build process from generating man pages. Omit this switch if you have asciidoc-10.2.0 installed and wish to generate and install the man pages.

-Dseccomp=false: This option disables the seccomp system call filter. On some architectures, such as i686 and ARM, the functions that tracker-miners uses are not guarded properly, and tracker-miners will get killed with a SIGSYS as a result.

-Dminer_rss=false: Use this option if you have not installed the recommended dependency libgrss.

Contents

Installed Programs: None
Installed Libraries: Several modules under /usr/lib/tracker-miners-3.0
Installed Directories: /usr/lib/tracker-miners-3.0, /usr/libexec/tracker3, and /usr/share/tracker3-miners

GSound-1.0.3

Introduction to GSound

The gsound package contains a small library for playing system sounds.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

gsound Dependencies

Required

libcanberra-0.30

Recommended
Optional

GTK-Doc-1.33.2 (for generating documentation)

Installation of GSound

Install gsound by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Programs: gsound-play
Installed Libraries: libgsound.so
Installed Directories: /usr/share/gtk-doc/html/gsound

Short Descriptions

gsound-play

plays system sounds through the libgsound interface

libgsound.so

contains API functions for playing system sounds

GNOME Desktop Components

DConf-0.40.0 / DConf-Editor-43.0

Introduction to DConf

The DConf package contains a low-level configuration system. Its main purpose is to provide a backend to GSettings on platforms that don't already have configuration storage systems.

The DConf-Editor, as the name suggests, is a graphical editor for the DConf database. Installation is optional, because gsettings from GLib-2.76.4 provides similar functionality on the commandline.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

DConf Dependencies

Required

dbus-1.14.8, GLib-2.76.4, GTK+-3.24.38 (for the editor), libhandy-1.8.2 (for the editor), and libxml2-2.10.4 (for the editor)

Recommended
Optional

GTK-Doc-1.33.2 and bash-completion

Installation of DConf

Install DConf by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr           \
            --buildtype=release     \
            -Dbash_completion=false \
            ..                      &&
ninja

To test the results, issue: ninja test

As the root user:

ninja install

Now, optionally install the editor:

cd ..              &&
tar -xf ../dconf-editor-43.0.tar.xz &&
cd dconf-editor-43.0                &&

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

As the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dgtk_doc=true: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: dconf and dconf-editor
Installed Libraries: libdconf.so and libdconfsettings.so (GIO Module installed in /usr/lib/gio/modules)
Installed Directories: /usr/{include,share/gtk-doc/html}/dconf

Short Descriptions

dconf

is a simple tool for manipulating the DConf database

dconf-editor

is a graphical program for editing the DConf database

libdconf.so

contains the DConf client API functions

gnome-backgrounds-44.0

Introduction to GNOME Backgrounds

The GNOME Backgrounds package contains a collection of graphics files which can be used as backgrounds in the GNOME Desktop environment. Additionally, the package creates the proper framework and directory structure so that you can add your own files to the collection.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of GNOME Backgrounds

Install GNOME Backgrounds by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr ..

This package does not come with a test suite.

Now, as the root user:

ninja install

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/share/backgrounds/gnome and /usr/share/gnome-background-properties

Short Descriptions

GNOME Backgrounds

are background images for the GNOME Desktop

Gvfs-1.50.6

Introduction to Gvfs

The Gvfs package is a userspace virtual filesystem designed to work with the I/O abstractions of GLib's GIO library.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Gvfs Dependencies

Required

dbus-1.14.8, GLib-2.76.4, libusb-1.0.26, and libsecret-0.21.0

Recommended
Optional

Apache-2.4.57, Avahi-0.8, BlueZ-5.68, Fuse-3.16.1, gnome-online-accounts-3.48.0, GTK-Doc-1.33.2, libarchive-3.7.1, libgcrypt-1.10.2, libgdata-0.18.1, libxml2-2.10.4, libxslt-1.1.38, OpenSSH-9.4p1, Samba-4.18.6, gnome-desktop-testing (for tests), libbluray, libgphoto2, libimobiledevice, libmtp, libnfs, and Twisted

Installation of Gvfs

Install Gvfs by running the following commands:

mkdir build &&
cd    build &&

meson setup               \
      --prefix=/usr       \
      --buildtype=release \
      -Dfuse=false        \
      -Dgphoto2=false     \
      -Dafc=false         \
      -Dbluray=false      \
      -Dnfs=false         \
      -Dmtp=false         \
      -Dsmb=false         \
      -Ddnssd=false       \
      -Dgoa=false         \
      -Dgoogle=false      .. &&
ninja

The test suite requires gnome-desktop-testing, which is beyond the scope of BLFS.

Now, as the root user:

ninja install

Note

If you installed the package to your system using a DESTDIR method, /usr/share/glib-2.0/schemas/gschemas.compiled was not updated/created. Create (or update) the file using the following command as the root user:

glib-compile-schemas /usr/share/glib-2.0/schemas

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-D<option>=false: These switches are required if the corresponding dependency is not installed. Remove those where you have installed the corresponding application and wish to use it with Gvfs. The dnssd option requires avahi and both goa and google require GNOME Online Accounts. The google option also requires libgdata.

-Dcdda=false: This switch is required if libcdio is not installed. The cdda backend is useless on machines without a CDROM/DVD drive.

Contents

Installed Programs: None
Installed Library: libgvfscommon.so, libgvfsdaemon.so and some under /usr/lib/gio/modules/
Installed Directories: /usr/include/gvfs-client and /usr/{lib,share}/gvfs

Short Descriptions

libgvfscommon.so

contains the common API functions used in Gvfs programs

gexiv2-0.14.2

Introduction to gexiv2

gexiv2 is a GObject-based wrapper around the Exiv2 library.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

gexiv2 Dependencies

Required

Exiv2-0.28.0

Recommended
Optional

GTK-Doc-1.33.2 (for documentation)

Installation of gexiv2

Install gexiv2 by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, run:

meson configure -Dtests=true &&
ninja test

As the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Programs: None
Installed Libraries: libgexiv2.so
Installed Directories: /usr/include/gexiv2

Short Descriptions

libgexiv2.so

provides a wrapper around the Exiv2 library

Nautilus-44.2.1

Introduction to Nautilus

The Nautilus package contains the GNOME file manager.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Nautilus Dependencies

Required

bubblewrap-0.8.0, gexiv2-0.14.2, gnome-autoar-0.4.4, gnome-desktop-44.0, libadwaita-1.3.4, libcloudproviders-0.3.2, libnotify-0.8.2, libportal-0.6, libseccomp-2.5.4, and Tracker-3.5.3

Recommended
Optional

Gi-DocGen-2023.1

Recommended (Runtime)

Installation of Nautilus

Fix the location to install the API documentation:

sed "/docdir =/s@\$@ / 'nautilus-44.2.1'@" -i meson.build

Install Nautilus by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dselinux=false     \
            -Dpackagekit=false  \
            ..                  &&

ninja

To test the results, issue: ninja test. The tests need to be run in a graphical environment. One test is known to fail if tracker-miners-3.5.2 is not installed. One test is also known to timeout if the user running the tests has a large home directory.

Now, as the root user:

ninja install

Note

If you installed the package to your system using a DESTDIR method, /usr/share/glib-2.0/schemas/gschemas.compiled was not updated/created. Create (or update) the file using the following command as the root user:

glib-compile-schemas /usr/share/glib-2.0/schemas

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dselinux=false: This switch disables the use of selinux which isn't supported by BLFS.

-Dpackagekit=false: This switch disables the use of PackageKit which isn't suitable for BLFS.

Contents

Installed Programs: nautilus and nautilus-autorun-software
Installed Library: libnautilus-extension.so
Installed Directories: /usr/{include,lib,share}/nautilus and /usr/share/gtk-doc/html/libnautilus-extension (optional)

Short Descriptions

nautilus

is the GNOME file manager

libnautilus-extension.so

supplies the functions needed by the file manager extensions

gnome-bluetooth-42.6

Introduction to GNOME Bluetooth

The GNOME Bluetooth package contains tools for managing and manipulating Bluetooth devices using the GNOME Desktop.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME Bluetooth Dependencies

Required

GTK-4.12.0, gsound-1.0.3, libnotify-0.8.2, and UPower-1.90.2

Recommended
Optional

GTK-Doc-1.33.2 and dbusmock-0.29.1

Runtime Dependencies

BlueZ-5.68

Installation of GNOME Bluetooth

Install GNOME Bluetooth by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Programs: bluetooth-sendto
Installed Libraries: libgnome-bluetooth-3.0.so and libgnome-bluetooth-ui-3.0.so
Installed Directories: /usr/include/gnome-bluetooth-3.0 and /usr/share/gnome-bluetooth-3.0

Short Descriptions

bluetooth-sendto

is a GTK+ application for transferring files over Bluetooth

libgnome-bluetooth-3.0.so

contains the GNOME Bluetooth API functions

gnome-keyring-42.1

Introduction to GNOME Keyring

The GNOME Keyring package contains a daemon that keeps passwords and other secrets for users.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME Keyring Dependencies

Required

dbus-1.14.8 and Gcr-3.41.1

Recommended
Optional

LCOV, libcap-ng, GnuPG-2.4.3, and Valgrind-3.21.0

Installation of GNOME Keyring

Install GNOME Keyring by running the following commands:

sed -i 's:"/desktop:"/org:' schema/*.xml &&

./configure --prefix=/usr     \
            --sysconfdir=/etc &&
make

A session bus address is necessary to run the tests. To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

sed ... schema/*.xml: This command fixes a deprecated entry in the schema template.

Contents

Installed Programs: gnome-keyring (symlink), gnome-keyring-3, and gnome-keyring-daemon
Installed Libraries: gnome-keyring-pkcs11.so (PKCS#11 module) and pam_gnome_keyring.so (PAM module)
Installed Directory: /usr/lib/gnome-keyring and /usr/share/xdg-desktop-portal

Short Descriptions

gnome-keyring-daemon

is a session daemon that keeps passwords for users

gnome-settings-daemon-44.1

Introduction to GNOME Settings Daemon

The GNOME Settings Daemon is responsible for setting various parameters of a GNOME Session and the applications that run under it.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME Settings Daemon Dependencies

Required

alsa-lib-1.2.9, colord-1.4.6, Fontconfig-2.14.2, Gcr-4.1.0, GeoClue-2.7.0, geocode-glib-3.26.4, gnome-desktop-44.0, Little CMS-2.14, libcanberra-0.30, libgweather-4.2.0, libnotify-0.8.2, libwacom-2.7.0, PulseAudio-16.1, and UPower-1.90.2

Recommended

Note

Recommended dependencies are not strictly required for this package to build and function, but you may not get expected results at runtime if you don't install them.

Optional

gnome-session-44.0, Mutter-44.3, dbusmock-0.29.1, umockdev-0.17.18, and Xvfb (for tests, from Xorg-Server-21.1.8 or Xwayland-23.2.0)

Installation of GNOME Settings Daemon

Install GNOME Settings Daemon by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To check the results, execute: ninja test. Note that you must have python-dbusmock installed in order for the tests to complete successfully. Some tests may fail depending on the init system in use.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Programs: None
Installed Libraries: libgsd.so
Installed Directories: /etc/xdg/Xwayland-session.d, /usr/include/gnome-settings-daemon-44, /usr/lib/gnome-settings-daemon-44, and /usr/share/gnome-settings-daemon

gnome-control-center-44.3

Introduction to GNOME Control Center

The GNOME Control Center package contains the GNOME settings manager.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME Control Center Dependencies

Required

AccountsService-23.13.9, colord-gtk-0.3.0, gnome-online-accounts-3.48.0, gnome-settings-daemon-44.1, gsound-1.0.3, libgtop-2.40.0, libpwquality-1.4.5, MIT Kerberos V5-1.21.2, shared-mime-info-2.2, and UDisks-2.10.0

Recommended
Optional

Xvfb (from Xorg-Server-21.1.8 or Xwayland-23.2.0) and dbusmock-0.29.1 (both for tests)

Optional Runtime Dependencies

cups-pk-helper-0.2.7 (Printers panel), gnome-color-manager-3.36.0 (Color panel), gnome-shell-44.3 (Applications panel), and sound-theme-freedesktop-0.8 (Additional Sound Effects in Sound panel)

Note

Recommended dependencies are not strictly required for this package to build and function, but you may not get expected results at runtime if you don't install them.

Installation of GNOME Control Center

Note

If upgrading from gnome-control-center-41 or earlier, remove a desktop file that would result in duplicated menu entries. As the root user:

rm -f /usr/share/applications/gnome-control-center.desktop

Install GNOME Control Center by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: GTK_A11Y=none ninja test. Note that you must have the python-dbusmock module installed in order for the tests to complete successfully.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dibus=false: Use this switch if you have not installed the recommended IBus dependency.

Contents

Installed Programs: gnome-control-center
Installed Libraries: None
Installed Directories: /usr/share/gnome-control-center, /usr/share/pixmaps/faces, and /usr/share/sounds/gnome

Short Descriptions

gnome-control-center

is a graphical user interface used to configure various aspects of GNOME

Mutter-44.3

Introduction to Mutter

Mutter is the window manager for GNOME. It is not invoked directly, but from GNOME Session (on a machine with a hardware accelerated video driver).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Mutter Dependencies

Required

gnome-settings-daemon-44.1, graphene-1.10.8, libxcvt-0.1.2, libxkbcommon-1.5.0, and pipewire-0.3.77

Recommended
Recommended (Required to build the Wayland compositor)
Optional

dbusmock-0.29.1 (required for tests), sysprof-3.48.0, Xorg-Server-21.1.8 (for X11 sessions)

Installation of Mutter

Install Mutter by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr              \
            --buildtype=release        \
            -Dtests=false              \
            -Dprofiler=false           \
            ..                         &&
ninja

The test suite requires an external program called xvfb-run. If you wish to run the tests, you should download and install it before running meson. You can obtain it from xvfb-run, and install it with executable permissions in /usr/bin. xvfb-run needs Xvfb at runtime, and Xvfb can be installed from either Xorg-Server-21.1.8 or Xwayland-23.2.0. You should also replace -Dtests=false in the meson command, with -Dtests=true -Dclutter_tests=false. The test suite requires the mutter schema to be installed on the system, so it is better to run the tests after installing the package.

You can also test basic functions of Mutter following the section called “Starting Mutter”, after installing it.

Now, as the root user:

ninja install

If you wish to run the tests, remove the reference to Zenity which is not a part of BLFS from one test:

sed 's/zenity --[a-z]*/gtk4-demo/' -i ../src/tests/x11-test.sh

Now run the test suite:

HOME= ninja test

The tests require an active X or wayland session. Two tests named cogl-test-framebuffer-get-bits-gl3 and native-unit are known to fail. A few other tests may fail depending on the configuration. Don't make any mouse or keyboard input while the test suite is running or some tests may fail.

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dtests=false: Prevents building the tests, and removes a hard requirement on xvfb-run.

-Dprofiler=false: Allow building this package without Sysprof. Remove this option if you've installed Sysprof and want to analysis the rendering performance of Mutter.

-Dtests=true -Dclutter_tests=false: Building all the tests but the tests for the shipped Clutter library. The Clutter tests are known to fail with --buildtype=release.

Starting Mutter

Mutter is normally used as a component of gnome-shell, but it can be used as a standalone Wayland compositor too. To run Mutter as a Wayland compositor, in a virtual console, issue:

mutter --wayland -- vte-2.91

Replace vte-2.91 with the command line for the first application you want in the Wayland session. Note that once this application exits, the Wayland session will be terminated.

Mutter can also function as a nested compositor in another Wayland session. In a terminal emulator, issue:

MUTTER_DEBUG_DUMMY_MODE_SPECS=1920x1080 mutter --wayland --nested -- vte-2.91

Replace 1920x1080 with the size you want for the nested Wayland session.

Contents

Installed Programs: mutter
Installed Libraries: libmutter-12.so and libmutter-test-12.so (optional)
Installed Directories: /usr/{lib,include,libexec/installed-tests,share/{,installed-tests}}/mutter-12

Short Descriptions

mutter

is a Clutter based compositing GTK+ Window Manager

libmutter-12.so

contains the Mutter API functions

libmutter-test-12.so

contains the Mutter test suite API functions; this library is only installed if the test suite of this package is enabled and it is needed by gnome-shell test suite

gnome-shell-44.3

Introduction to GNOME Shell

The GNOME Shell is the core user interface of the GNOME Desktop environment.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME Shell Dependencies

Required

evolution-data-server-3.48.4, Gcr-4.1.0, Gjs-1.76.2, gnome-desktop-44.0, ibus-1.5.28, Mutter-44.3, Polkit-123, sassc-3.6.2, and startup-notification-0.12

Recommended
Optional

GTK-Doc-1.33.2 and bash-completion

Required Runtime Dependencies

adwaita-icon-theme-44.0, DConf-0.40.0, GDM-44.1, gnome-backgrounds-44.0, gnome-control-center-44.3, libgweather-4.2.0, Systemd-254, and telepathy-mission-control-5.16.6

Installation of GNOME Shell

Install GNOME Shell by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dtests=false       \
            ..                  &&
ninja

To test the results, you need to remove the -Dtests=false switch, and to have Mutter-44.3 compiled and installed with tests also. To run the tests, issue: ninja test. You must be running an X session to run the tests. Some will fail if GDM-44.1 is not installed. One test named CSS styling support is known to fail with some multi-monitor configurations.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dtests=false: Remove this switch if you want to build the tests. But then meson will fail if Mutter-44.3 tests are not installed.

-Dextensions_tool=false: This switch allows building this package without gnome-autoar-0.4.4 installed.

Contents

Installed Programs: gnome-extensions, gnome-extensions-app, gnome-shell, gnome-shell-extension-prefs, gnome-shell-extension-tool, and gnome-shell-perf-tool
Installed Libraries: None
Installed Directories: /usr/lib/gnome-shell, /usr/share/gnome-shell, /usr/share/gtk-doc/html/{shell,st} (optional), and /usr/share/xdg-desktop-portal/

Short Descriptions

gnome-shell

provides the core user interface functions for the GNOME 3 Desktop

gnome-shell-extensions-44.0

Introduction to GNOME Shell Extensions

The GNOME Shell Extensions package contains a collection of extensions providing additional and optional functionality to the GNOME Shell.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME Shell Extensions Dependencies

Required

libgtop-2.40.0

Optional

gnome-menus-3.36.0 (runtime, for Applications Menu extension) and sassc-3.6.2

Installation of GNOME Shell Extensions

Install GNOME Shell Extensions by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr .. 

This package does not come with a test suite.

Now, as the root user:

ninja install

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/share/gnome-shell/extensions

gnome-session-44.0

Introduction to GNOME Session

The GNOME Session package contains the GNOME session manager.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME Session Dependencies

Required

gnome-desktop-44.0, JSON-GLib-1.6.6, Mesa-23.1.6, Systemd-254 (runtime), and UPower-1.90.2

Optional

xmlto-0.0.28, and libxslt-1.1.38 with docbook-xml-4.5 and docbook-xsl-nons-1.79.2 (to build the documentation)

Installation of GNOME Session

When running GNOME under Wayland-1.22.0, environment settings are not imported for the user using the system profile. The Wayland developers are currently undecided on a standard method to provide system environment settings for user sessions. To work around this limitation, execute the following command to make gnome-session use a login shell:

sed 's@/bin/sh@/bin/sh -l@' -i gnome-session/gnome-session.in

Install GNOME Session by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Move the documentation to a versioned directory:

mv -v /usr/share/doc/gnome-session{,-44.0}

This package creates two Xorg based .desktop files in the /usr/share/xsessions/ directory, and two Wayland based .desktop files in the /usr/share/wayland-sessions/ directory. Only one is needed in each directory on a BLFS system, so prevent the extra files showing up as options in a display manager. As the root user:

rm -v /usr/share/xsessions/gnome.desktop &&
rm -v /usr/share/wayland-sessions/gnome.desktop

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Starting GNOME

The easiest way to start GNOME is to use a display manager. GDM-44.1 is the recommended display manager.

It is also possible to start GNOME from the command line. However, you must still have GDM-44.1 installed for some portions of the desktop to work. One reason to start from the command line is if you want Wayland support on a system that has the proprietary NVIDIA driver installed, since GDM will not show the Wayland session type on such a system.

To start GNOME using xinit-1.4.2, run the following commands:

cat > ~/.xinitrc << "EOF"
dbus-run-session gnome-session
EOF

startx

Alternatively, to start GNOME with Wayland support, run the following command:

XDG_SESSION_TYPE=wayland dbus-run-session gnome-session

Contents

Installed Programs: gnome-session, gnome-session-inhibit, and gnome-session-quit
Installed Libraries: None
Installed Directories: /usr/share/doc/gnome-session-44.0 and /usr/share/gnome-session

Short Descriptions

gnome-session

is used to start up the GNOME Desktop environment

gnome-session-inhibit

is used to inhibit certain GNOME Session functionality while executing the given command

gnome-session-quit

is used to end the GNOME Session

gnome-tweaks-40.10

Introduction to GNOME Tweaks

GNOME Tweaks is a simple program used to tweak advanced GNOME settings.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME Tweaks Dependencies

Required

GTK+-3.24.38, gsettings-desktop-schemas-44.0, libhandy-1.8.2, PyGObject-3.44.1, and sound-theme-freedesktop-0.8

Installation of GNOME Tweaks

Install GNOME Tweaks by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Programs: gnome-tweaks
Installed Libraries: None
Installed Directories: /usr/lib/python3.11/site-packages/gtweak and /usr/share/gnome-tweaks

Short Descriptions

gnome-tweaks

is used to tweak advanced GNOME settings

gnome-user-docs-44.3

Introduction to GNOME User Docs

The GNOME User Docs package contains documentation for GNOME.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME User Docs Dependencies

Required

itstool-2.0.7 and libxml2-2.10.4

Installation of GNOME User Docs

Install GNOME User Docs by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/share/help/*/gnome-help and /usr/share/help/*/system-admin-guide

Yelp-42.2

Introduction to Yelp

The Yelp package contains a help browser used for viewing help files.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Yelp Dependencies

Required

gsettings-desktop-schemas-44.0, WebKitGTK-2.41.91 and yelp-xsl-42.1

Recommended
Optional

GTK-Doc-1.33.2

Note

The Yelp package is not required for a functional GNOME Desktop. Note, however, that without Yelp you will not be able to view the built-in Help provided by core GNOME and many of the support applications.

Installation of Yelp

Install Yelp by running the following commands:

./configure --prefix=/usr --disable-static &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Still as the root user, ensure that /usr/share/applications/mimeinfo.cache will be updated and therefore the help in gnome applications will work.

update-desktop-database

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Program: gnome-help (symlink) and yelp
Installed Library: libyelp.so
Installed Directories: /usr/include/libyelp, /usr/share/gtk-doc/html/libyelp (optional), and /usr/{lib,share}/yelp

Short Descriptions

yelp

is the GNOME Help Browser

libyelp.so

contains the Yelp API functions

Chapter 34. GNOME Applications

These packages are desktop applications and assorted utilities from the GNOME project. Feel free to install them on an as needed or as desired basis.

Baobab-44.0

Introduction to Baobab

The Baobab package contains a graphical directory tree analyzer.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Baobab Dependencies

Required

adwaita-icon-theme-44.0, GTK-4.12.0, itstool-2.0.7, libadwaita-1.3.4, and Vala-0.56.11

Installation of Baobab

Install Baobab by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Program: baobab
Installed Libraries: None
Installed Directories: /usr/share/help/*/baobab

Short Descriptions

baobab

is a graphical tool used to analyze disk usage

Brasero-3.12.3

Introduction to Brasero

Brasero is an application used to burn CD/DVD on the GNOME Desktop. It is designed to be as simple as possible and has some unique features that enable users to create their discs easily and quickly.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Brasero Dependencies

Required

gst-plugins-base-1.22.5, itstool-2.0.7, libcanberra-0.30, and libnotify-0.8.2

Recommended
Optional

GTK-Doc-1.33.2

Recommended (Runtime)
Optional (Runtime)

Cdrdao-1.2.4, libdvdcss-1.4.3, Cdrtools-3.02a09, and VCDImager

Installation of Brasero

Install Brasero by running the following commands:

./configure --prefix=/usr                \
            --enable-compile-warnings=no \
            --enable-cxx-warnings=no     \
            --disable-nautilus           &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--enable-*-warnings=no: These switches fix build problems under GCC-6.x compilers.

--disable-nautilus: This switch disables building the Nautilus extension since it is incompatible with the gtk4 version of Nautilus.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: brasero
Installed Libraries: libbrasero-{burn,media,utils}3.so
Installed Directories: /usr/include/brasero3, /usr/lib/brasero3, /usr/share/brasero, /usr/share/gtk-doc/html/libbrasero-{burn,media}, and /usr/share/help/*/brasero

Short Descriptions

brasero

is a simple and easy to use CD/DVD burning application for the GNOME Desktop

libbrasero-burn3.so

contains the Burning API functions

libbrasero-media3.so

contains the Media API functions

libbrasero-utils3.so

contains the Brasero API functions

Cheese-44.1

Introduction to Cheese

Cheese is used to take photos and videos with fun graphical effects.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Cheese Dependencies

Required

clutter-gst-3.0.27, clutter-gtk-1.8.4, gnome-desktop-44.0, gst-plugins-bad-1.22.5, gst-plugins-good-1.22.5 (built with v4l-utils-1.24.1), libcanberra-0.30, and libgudev-238

Recommended
Optional

GTK-Doc-1.33.2, libxslt-1.1.38, appstream-glib, LCOV , and Nautilus SendTo

Kernel Configuration

Depending on your camera, enable the appropriate options and recompile the kernel if necessary:

Device Drivers --->
  <*/M> Multimedia support --->                                  [MEDIA_SUPPORT]
    [*] Autoselect ancillary drivers (tuners, sensors, i2c, spi, frontends)
                                                  ...  [MEDIA_SUBDRV_AUTOSELECT]
    Media device types --->
      [*] Cameras and video grabbers                      [MEDIA_CAMERA_SUPPORT]
    Media drivers --->
      [ /*] Media USB Adapters --->                          [MEDIA_USB_SUPPORT]
        # Most modern USB camera needs this.
        # For other devices you need to figure it out yourself:
        < /*/M> USB Video Class (UVC)                          [USB_VIDEO_CLASS]

Installation of Cheese

Install Cheese by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr        \
            --buildtype=release  \
            -Dgtk_doc=false      \
            -Dtests=true         \
            ..                   &&
ninja

To test the results, issue: ninja test

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dgtk_doc=false: This switch prevents the build system from generating and installing the API documentation. Omit this switch if you have GTK-Doc-1.33.2 installed and wish to generate and install the API documentation. Building the documentation is broken due to an incompatibility with gtk-doc.

-Dtests=true: This switch allows building the tests so that the test suite can be run. Remove this switch if you are not going to run the tests.

Contents

Installed Program: cheese
Installed Library: libcheese.so and libcheese-gtk.so
Installed Directories: /usr/{include,share/gtk-doc/html,share/help/*}/cheese

Short Descriptions

cheese

is a webcam tool with graphical effects

libcheese.so

contains the Cheese API functions

libcheese-gtk.so

contains the Cheese GTK+ widgets

EOG-44.3

Introduction to EOG

EOG is an application used for viewing and cataloging image files on the GNOME Desktop. It also has basic editing capabilities.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

EOG Dependencies

Required

adwaita-icon-theme-44.0, Exempi-2.6.4, gnome-desktop-44.0, libhandy-1.8.2, libjpeg-turbo-3.0.0, libpeas-1.36.0, and shared-mime-info-2.2

Recommended
Optional

GTK-Doc-1.33.2 and libportal-0.6

Installation of EOG

Install EOG by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dlibportal=false   \
            ..                  &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Still as the root user, rebuild the cache database of MIME types handled by desktop files so Nautilus-44.2.1 will be able to open image files with EOG.

update-desktop-database

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dlibportal=false: This parameter disables building EOG with support for flatpak portals. Remove this parameter if you have libportal-0.6 installed and wish to have support for flatpak portals.

-Dgtk_doc=true: Use this option if GTK-Doc-1.33.2 is installed and you wish to rebuild and install the API documentation.

Contents

Installed Program: eog
Installed Library: libeog.so
Installed Directories: /usr/include/eog-3.0, /usr/lib/eog, /usr/share/eog, /usr/share/gtk-doc/html/eog (optional), and /usr/share/help/*/eog

Short Descriptions

eog

is a fast and functional image viewer as well as an image cataloging program. It has basic editing capabilities

Evince-44.3

Introduction to Evince

Evince is a document viewer for multiple document formats. It supports PDF, Postscript, DjVu, TIFF and DVI. It is useful for viewing documents of various types using one simple application instead of the multiple document viewers that once existed on the GNOME Desktop.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Evince Dependencies

Required

adwaita-icon-theme-44.0, gsettings-desktop-schemas-44.0, GTK+-3.24.38, itstool-2.0.7, libhandy-1.8.2, libxml2-2.10.4, and OpenJPEG-2.5.0

Recommended
Optional

Cups-2.4.6 (to enable printing if support is built into GTK+ 3), gnome-desktop-44.0, gspell-1.12.2, gst-plugins-base-1.22.5, Gi-DocGen-2023.1, libgxps-0.3.2, libtiff-4.5.1, texlive-20230313 (or install-tl-unx), DjVuLibre, libspectre, and Synctex

Installation of Evince

Install Evince by running the following commands:

mkdir build &&
cd    build &&

CPPFLAGS+=" -I/opt/texlive/2023/include" \
meson setup --prefix=/usr          \
            --buildtype=release    \
            -Dgtk_doc=false        \
            --wrap-mode=nodownload \
            ..                     &&
ninja

If you have Gi-DocGen-2023.1 installed and wish to build the API documentation for this package, issue:

sed "/docs_dir/s@\$@ / 'evince-44.3'@" -i ../help/meson.build &&
sed '/fatal-warnings/d' -i ../help/reference/*/meson.build    &&
meson configure -Dgtk_doc=true                                &&
ninja

This package does not have a working test suite.

Now, as the root user:

ninja install

Note

If you installed the package to your system using a DESTDIR method, /usr/share/glib-2.0/schemas/gschemas.compiled was not updated/created. Create (or update) the file using the following command as the root user:

glib-compile-schemas /usr/share/glib-2.0/schemas

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

CPPFLAGS+=" -I/opt/texlive/...": Make sure that meson can find libkpathsea headers from TeXLive if it is installed. This has no effect on systems without TeXLive installed.

--wrap-mode=nodownload: This switch disables fetching any dependency: the build system tries to fetch gi-docgen even if -Dgtk_doc=false is passed.

-Dgtk_doc=false: Allow building this package without Gi-DocGen-2023.1 installed. If you have Gi-DocGen-2023.1 installed and you wish to rebuild and install the API documentation, a meson configure command will reset this option.

-Dgspell=false: This switch turns off support for the spell checking plugin.

-Dintrospection=false: Use this option if you don't have gobject-introspection-1.76.1 installed and don't wish to have introspection support built into Evince.

-Dnautilus=false: This switch disables building the Nautilus Plugin. Use this switch if Nautilus is not installed.

-Dkeyring=false: This switch disables the use of libsecret. Use this switch if libsecret is not installed.

-Dps=enabled: Use this switch if libspectre is installed and you want to view PostScript files with Evince.

Contents

Installed Programs: evince, evince-previewer, and evince-thumbnailer
Installed Libraries: libevdocument3.so and libevview3.so
Installed Directories: /usr/{include,lib,share}/evince, /usr/share/gtk-doc/html/{evince,libevdocument-3.0,libevview-3.0} (optional), and /usr/share/help/*/evince

Short Descriptions

evince

is a multiple format document viewer

evince-previewer

is an application that implements the printing previewer

evince-thumbnailer

is a simple program used to create thumbnail images of supported documents

Evolution-3.48.4

Introduction to Evolution

The Evolution package contains an integrated mail, calendar and address book suite designed for the GNOME environment.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Evolution Dependencies

Required

adwaita-icon-theme-44.0, evolution-data-server-3.48.4, Gcr-4.1.0, gnome-autoar-0.4.4, shared-mime-info-2.2, and WebKitGTK-2.41.91

Recommended
Optional

clutter-gtk-1.8.4, GeoClue-2.7.0, geocode-glib-3.26.4, and libchamplain-0.12.21 (Contact Maps plugin), GTK-Doc-1.33.2, cmark, Glade, libpst, libunity, libytnef

Installation of Evolution

Install Evolution by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DSYSCONF_INSTALL_DIR=/etc  \
      -DENABLE_INSTALLED_TESTS=ON \
      -DENABLE_PST_IMPORT=OFF     \
      -DENABLE_YTNEF=OFF          \
      -DENABLE_CONTACT_MAPS=OFF   \
      -DENABLE_MARKDOWN=OFF       \
      -DENABLE_WEATHER=ON         \
      -G Ninja .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Command Explanations

-DENABLE_YTNEF=OFF: This switch is used to disable the yTNEF library usage because libytnef is not part of BLFS.

-DENABLE_PST_IMPORT=OFF: This switch is used to disable the pst-import plugin because libpst is not part of BLFS.

-DENABLE_CONTACT_MAPS=OFF: This switch disables building the Contact Maps plugin. Remove this switch if you have installed the necessary dependencies and wish to build the Contact Maps plugin.

-DENABLE_MARKDOWN=OFF: This switch allows building without cmark. Remove this switch if you need markdown support and you have installed the necessary dependency.

-DENABLE_WEATHER=ON: This switch allows building against libgweather-4.2.0.

-DWITH_HELP=OFF: This switch disables building the manual of this package. Use this switch if you have not installed itstool-2.0.7.

-DWITH_OPENLDAP=OFF: Use this switch if you have not installed OpenLDAP-2.6.6.

Contents

Installed Programs: evolution
Installed Libraries: None
Installed Directories: /usr/include/evolution, /usr/lib/evolution, /usr/libexec/evolution, /usr/share/evolution, /usr/share/installed-tests/evolution, /usr/share/help/*/evolution, and optionally /usr/share/gtk-doc/html/{evolution-mail-composer,evolution-mail-engine}, /usr/share/gtk-doc/html/{evolution-mail-formatter,evolution-shell}, and /usr/share/gtk-doc/html/evolution-util

Short Descriptions

evolution

is an email, calendar and address book suite for the GNOME Desktop

File-Roller-43.0

Introduction to File Roller

File Roller is an archive manager for GNOME with support for tar, bzip2, gzip, zip, jar, compress, lzop, zstd, dmg, and many other archive formats.

This package is known to build and work properly using an LFS 12.0 platform.

Note

File Roller is only a graphical interface to archiving utilities such as tar and zip.

Package Information

File Roller Dependencies

Required

GTK+-3.24.38 and itstool-2.0.7

Recommended
Optional (for the API documentation)

Gi-DocGen-2023.1

Optional (Runtime)

UnRar-6.2.10, UnZip-6.0, and Zip-3.0

Installation of File Roller

Install File Roller by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dpackagekit=false  \
            ..                  &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install &&
chmod -v 0755 /usr/libexec/file-roller/isoinfo.sh

Note

If you installed the package to your system using a DESTDIR method, /usr/share/glib-2.0/schemas/gschemas.compiled was not updated/created. Create (or update) the file using the following command as the root user:

glib-compile-schemas /usr/share/glib-2.0/schemas

Note

This package installs icon files into the /usr/share/icons/hicolor hierarchy and desktop files into the /usr/share/applications hierarchy. You can improve system performance and memory usage by updating /usr/share/icons/hicolor/index.theme and /usr/share/applications/mimeinfo.cache. To perform the update you must have GTK+-2.24.33 or GTK+-3.24.38 installed (for the icon cache) and desktop-file-utils-0.26 (for the desktop cache) and issue the following commands as the root user:

gtk-update-icon-cache -qtf /usr/share/icons/hicolor &&
update-desktop-database -q

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dpackagekit=false: This switch disables the use of PackageKit which isn't suitable for BLFS.

-Dapi_docs=enabled: Use this switch if you have Gi-DocGen-2023.1 installed and wish to generate the API documentation.

Contents

Installed Program: file-roller
Installed Libraries: libnautilus-fileroller.so
Installed Directories: /usr/{libexec,share{,/help/*}}/file-roller

Short Descriptions

file-roller

is an archive manager for GNOME

gnome-calculator-44.0

Introduction to GNOME Calculator

GNOME Calculator is a powerful graphical calculator with financial, logical and scientific modes. It uses a multiple precision package to do its arithmetic to give a high degree of accuracy.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME Calculator Dependencies

Required

gtksourceview5-5.8.0, itstool-2.0.7, libadwaita-1.3.4, libgee-0.20.6, libhandy-1.8.2, and libsoup-3.4.2

Recommended

Installation of GNOME Calculator

Install GNOME Calculator by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Contents

Installed Programs: gcalccmd and gnome-calculator
Installed Library: libgcalc-2.so and libgci-1.so
Installed Directories: /usr/include/gcalc-2, /usr/include/gci-2, /usr/share/devhelp/books/{GCalc-2,GCi-1}, and /usr/share/help/*/gnome-calculator

Short Descriptions

gnome-calculator

is the official calculator of the GNOME Desktop

gcalccmd

is a command line version of gnome-calculator

gnome-color-manager-3.36.0

Introduction to GNOME Color Manager

GNOME Color Manager is a session framework for the GNOME desktop environment that makes it easy to manage, install and generate color profiles.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME Color Manager Dependencies

Required

colord-1.4.6, GTK+-3.24.38, itstool-2.0.7, Little CMS-2.14, libcanberra-0.30, and libexif-0.6.24

Recommended
Optional

appstream-glib and DocBook-utils-0.6.14 (currently causes build to fail)

Installation of GNOME Color Manager

If DocBook-utils-0.6.14 is installed, disable installation of the man pages to avoid a build failure:

sed /subdir\(\'man/d -i meson.build

Install GNOME Color Manager by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test. The tests must be run from an X session.

Now, as the root user:

ninja install

Contents

Installed Programs: gcm-import, gcm-inspect, gcm-picker, and gcm-viewer
Installed Libraries: None
Installed Directories: /usr/share/gnome-color-manager and /usr/share/help/*/gnome-color-manager

Short Descriptions

gcm-import

allows you to import ICC profiles supplied by vendors

gcm-inspect

allows you to inspect your session color-management settings

gcm-picker

allows you to pick spot colors for use by an attached colorimeter

gcm-viewer

allows you to view properties of ICC profiles

gnome-disk-utility-44.0

Introduction to GNOME Disk Utility

The GNOME Disk Utility package provides applications used for dealing with storage devices.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME Disk Utility Dependencies

Required

gnome-settings-daemon-44.1, itstool-2.0.7, libdvdread-6.1.3, libhandy-1.8.2, libpwquality-1.4.5, libsecret-0.21.0, and UDisks-2.10.0

Optional

appstream-glib

Installation of GNOME Disk Utility

Install GNOME Disk Utility by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Contents

Installed Programs: gnome-disk-image-mounter and gnome-disks
Installed Libraries: None
Installed Directories: None

Short Descriptions

gnome-disk-image-mounter

is used to set up disk images

gnome-disks

is used to inspect, format, partition and configure disks and block devices

gnome-logs-43.0

Introduction to GNOME Logs

The GNOME Logs package contains a log viewer for the systemd journal.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME Logs Dependencies

Required

GTK-4.12.0, gsettings-desktop-schemas-44.0, itstool-2.0.7, and libadwaita-1.3.4

Optional

desktop-file-utils-0.26 (for the test suite), and docbook-xml-4.5, docbook-xsl-nons-1.79.2, libxslt-1.1.38 (to build manual pages), appstream-glib, and dogtail

Installation of GNOME Logs

Install GNOME Logs by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Programs: gnome-logs
Installed Libraries: None
Installed Directories: /usr/share/gnome-logs and /usr/share/help/*/gnome-logs

Short Descriptions

gnome-logs

is a GNOME log viewer for the systemd journal

gnome-maps-44.3

Introduction to GNOME Maps

GNOME Maps is a map application for GNOME.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME Maps Dependencies

Required

desktop-file-utils-0.26, GeoClue-2.7.0, geocode-glib-3.26.4, Gjs-1.76.2, libadwaita-1.3.4, libshumate-1.0.5, libgweather-4.2.0, and rest-0.9.1

Installation of GNOME Maps

Install GNOME Maps by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Contents

Installed Programs: gnome-maps (symlink)
Installed Libraries: libgnome-maps.so
Installed Directories: /usr/lib/gnome-maps and /usr/share/gnome-maps

Short Descriptions

gnome-maps

is a map application for GNOME

gnome-nettool-42.0

Introduction to GNOME Nettool

The GNOME Nettool package is a network information tool which provides GUI interface for some of the most common command line network tools.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

GNOME Nettool Dependencies

Required

GTK+-3.24.38, itstool-2.0.7, and libgtop-2.40.0

Runtime Dependencies

BIND Utilities-9.18.18, Nmap-7.94, Net-tools-2.10, Traceroute-2.1.2, and Whois-5.4.3

Installation of GNOME Nettool

First, adapt GNOME Nettool to changes in the ping, ping6, and netstat utilities:

patch -Np1 -i ../gnome-nettool-42.0-ping_and_netstat_fixes-1.patch

Then add a fix for newer versions of meson:

sed -i '/merge_file/s/(.*/(/' data/meson.build

Install GNOME Nettool by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Contents

Installed Program: gnome-nettool
Installed Libraries: None
Installed Directories: /usr/share/gnome-nettool and /usr/share/help/*/gnome-nettool

Short Descriptions

gnome-nettool

is a network information tool

gnome-power-manager-43.0

Introduction to GNOME Power Manager

The GNOME Power Manager package contains a tool used to report on power management on the system.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME Power Manager Dependencies

Required

GTK+-3.24.38 and UPower-1.90.2

Optional

DocBook-utils-0.6.14 and appstream-glib

Installation of GNOME Power Manager

Install GNOME Power Manager by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Programs: gnome-power-statistics
Installed Libraries: None
Installed Directories: None

Short Descriptions

gnome-power-statistics

is used to visualize the power consumption of laptop hardware

gnome-screenshot-41.0

Introduction to GNOME Screenshot

The GNOME Screenshot is a utility used for taking screenshots of the entire screen, a window or a user-defined area of the screen, with optional beautifying border effects.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME Screenshot Dependencies

Required

GTK+-3.24.38, libcanberra-0.30 (Compiled with GTK+3 support), and libhandy-1.8.2

Installation of GNOME Screenshot

First, fix building with newer versions of meson:

sed -i '/merge_file/{n;d}' data/meson.build

Install GNOME Screenshot by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Note

In order to best run GNOME Screenshot from the command line, the -i option needs to be specified.

Contents

Installed Program: gnome-screenshot
Installed Libraries: None
Installed Directories: None

Short Descriptions

gnome-screenshot

is used to capture the screen, a window, or a user-defined area and save the snapshot image to a file

gnome-system-monitor-45.0

Introduction to GNOME System Monitor

The GNOME System Monitor package contains GNOME's replacement for gtop.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME System Monitor Dependencies

Required

adwaita-icon-theme-44.0, Gtkmm-3.24.8, itstool-2.0.7, libgtop-2.40.0, libhandy-1.8.2, and librsvg-2.56.3

Optional

desktop-file-utils-0.26, appstream-glib, and uncrustify

Installation of GNOME System Monitor

Install GNOME System Monitor by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Contents

Installed Program: gnome-system-monitor
Installed Libraries: None
Installed Directories: /usr/{libexec,share,share/help/*}/gnome-system-monitor

Short Descriptions

gnome-system-monitor

is used to display the process tree and hardware meters

gnome-terminal-3.48.2

Introduction to GNOME Terminal

The GNOME Terminal package contains the terminal emulator for GNOME Desktop.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME Terminal Dependencies

Required

DConf-0.40.0, gnome-shell-44.3, gsettings-desktop-schemas-44.0, itstool-2.0.7, pcre2-10.42, and VTE-0.72.2

Recommended
Optional

desktop-file-utils-0.26, and appstream-glib

Installation of GNOME Terminal

First, fix some deprecated schema entries:

sed -i -r 's:"(/system):"/org/gnome\1:g' src/external.gschema.xml

Install GNOME Terminal by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Note

To run GNOME Terminal, the environment variable LANG must be set to a UTF-8 locale prior to starting the graphical environment.

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dsearch_provider=false: This switch disables the search gnome-shell provider. Use this option if you do not have gnome-shell installed.

-Dnautilus_extension=false: This switch disables a dependency on the nautilus file manager. Use this option if you do not have Nautilus installed.

Contents

Installed Program: gnome-terminal
Installed Libraries: /usr/lib/nautilus/extensions-4/libterminal-nautilus.so (Nautilus Extension)
Installed Directories: /usr/{lib,share/help/*}/gnome-terminal and /usr/share/xdg-terminals

Short Descriptions

gnome-terminal

is the GNOME Terminal Emulator

gnome-weather-44.0

Introduction to GNOME Weather

GNOME Weather is a small application that allows you to monitor the current weather conditions for your city, or anywhere in the world, and to access updated forecasts provided by various internet services.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GNOME Weather Dependencies

Required

Gjs-1.76.2, libadwaita-1.3.4, and libgweather-4.2.0

Optional

appstream-glib

Installation of GNOME Weather

Install GNOME Weather by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Programs: gnome-weather
Installed Libraries: None
Installed Directories: /usr/share/org.gnome.Weather

Short Descriptions

gnome-weather

is a small application that allows you to monitor the current weather conditions anywhere in the world

Gucharmap-15.0.4

Introduction to Gucharmap

Gucharmap is a Unicode character map and font viewer. It allows you to browse through all the available Unicode characters and categories for the installed fonts, and to examine their detailed properties. It is an easy way to find the character you might only know by its Unicode name or code point.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Gucharmap Dependencies

Required

desktop-file-utils-0.26, gsettings-desktop-schemas-44.0, GTK+-3.24.38, itstool-2.0.7, pcre2-10.42, and UnZip-6.0

Recommended
Optional

appstream-glib and GTK-Doc-1.33.2

Installation of Gucharmap

Note

This package uses two unversioned downloads. You may want to rename these to a versioned name, e.g. UCD-15.zip to make upgrades easier.

Install Gucharmap by running the following commands:

mkdir build                   &&
cd    build                   &&
mkdir ucd                     &&
pushd ucd                     &&
  unzip ../../../UCD.zip      &&
  cp -v ../../../Unihan.zip . &&
popd                          &&

meson setup --prefix=/usr       \
            --strip             \
            --buildtype=release \
            -Ducd_path=./ucd    \
            -Ddocs=false        \
            ..                  &&
ninja

This package does not have a test suite.

Now, as the root user:

rm  -fv /usr/share/glib-2.0/schemas/org.gnome.Charmap.enums.xml &&
ninja install

Command Explanations

--strip: Although the package defaults to a release build without debug information, without this switch there will be some debug information in the binaries.

-Ducd_path=./ucd: This points to where the extracted main Unicode data files, and the zipped Unihan archive can be found.

rm -fv /usr/share/glib-2.0/schemas/org.gnome.Charmap.enums.xml: Old versions of this package installed an obsolete file that prevents the program from running, as if the main schema has not been installed. Forcibly removing works even if the old file is not present.

-Ddocs=false: This allows the package to build even if gtk-doc has not been installed. Remove this if you have installed that and wish to build the documentation.

-Dgir=false: Use this if you have not installed gobject-introspection-1.76.1.

-Dvapi=false: Use this if you have not installed Vala-0.56.11.

Contents

Installed Program: gucharmap
Installed Library: libgucharmap_2_90.so
Installed Directories: /usr/include/gucharmap-2.90

Short Descriptions

gucharmap

is a Unicode character map and font viewer

libgucharmap_2_90.so

contains the Gucharmap API functions

Seahorse-43.0

Introduction to Seahorse

Seahorse is a graphical interface for managing and using encryption keys. Currently it supports PGP keys (using GPG/GPGME) and SSH keys.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Seahorse Dependencies

Required

Gcr-3.41.1, GnuPG-2.4.3, GPGME-1.21.0, itstool-2.0.7, libhandy-1.8.2, libpwquality-1.4.5 and libsecret-0.21.0

Recommended
Optional

Avahi-0.8

Runtime Dependency

gnome-keyring-42.1

Installation of Seahorse

Install Seahorse by running the following commands:

sed -i -r 's:"(/apps):"/org/gnome\1:' data/*.xml &&

sed -i "s/'2.3.0'/'2.3.0', '2.4.0'/" meson.build &&

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

sed ... data/*.xml: This command fixes some deprecated entries in the schema templates.

sed ... meson.build: This command fixes building with GnuPG-2.4 installed.

Contents

Installed Program: seahorse
Installed Libraries: None
Installed Directories: /usr/{libexec,share,share/help/*}/seahorse

Short Descriptions

seahorse

is the graphical interface for managing and using encryption keys

Vinagre-3.22.0

Introduction to Vinagre

Vinagre is a VNC client for the GNOME Desktop.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Vinagre Dependencies

Required

gtk-vnc-1.3.1, itstool-2.0.7, and libsecret-0.21.0

Recommended
Optional

Avahi-0.8, appstream-glib, FreeRDP (For connecting to Windows desktops), and Spice-GTK

Installation of Vinagre

First fix an issue exposed by GCC-10:

sed -e '/_VinagreVnc/i gboolean scaling_command_line;' \
    -i plugins/vnc/vinagre-vnc-connection.c &&
sed -e '/scaling_/s/^/extern /' \
    -i plugins/vnc/vinagre-vnc-connection.h

Install Vinagre by running the following commands:

./configure --prefix=/usr \
            --enable-compile-warnings=minimum &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--enable-compile-warnings=minimum: This switch disables compiler warnings that can cause the build to fail when built under GCC6.

Contents

Installed Programs: vinagre
Installed Libraries: None
Installed Directories: /usr/share/help/*/vinagre and /usr/share/vinagre

Short Descriptions

vinagre

is a remote desktop viewer for the GNOME Desktop

Part IX. Xfce

Chapter 35. Xfce Desktop

Xfce is a desktop environment that aims to be fast and low on system resources, while still being visually appealing and user friendly.

Xfce embodies the traditional UNIX philosophy of modularity and re-usability. It consists of a number of components that provide the full functionality one can expect of a modern desktop environment. They are packaged separately and you can pick among the available packages to create the optimal personal working environment.

Build Xfce core packages in the order presented in the book for the easiest resolution of dependencies.

libxfce4util-4.18.1

Introduction to libxfce4util

The libxfce4util package is a basic utility library for the Xfce desktop environment.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libxfce4util Dependencies

Required

GLib-2.76.4 and gobject-introspection-1.76.1

Recommended
Optional

GTK-Doc-1.33.2

Installation of libxfce4util

Install libxfce4util by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: xfce4-kiosk-query
Installed Library: libxfce4util.so
Installed Directories: /usr/include/xfce4 and /usr/share/gtk-doc/html/libxfce4util

Short Descriptions

xfce4-kiosk-query

Queries the given capabilities of <module> for the current user and reports whether the user has the capabilities or not. This tool is mainly meant for system administrators to test their Kiosk setup

libxfce4util.so

contains basic utility functions for the Xfce desktop environment

Xfconf-4.18.1

Introduction to Xfconf

Xfconf is the configuration storage system for Xfce.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Xfconf Dependencies

Required

libxfce4util-4.18.1

Optional

GTK-Doc-1.33.2 and Vala-0.56.11

Installation of Xfconf

Install Xfconf by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: xfconf-query
Installed Library: libxfconf-0.so
Installed Directories: /usr/include/xfce4/xfconf-0, /usr/lib/xfce4/xfconf, and /usr/share/gtk-doc/html/xfconf

Short Descriptions

xfconf-query

is a commandline utility to view or change any setting stored in Xfconf

libxfconf-0.so

contains basic functions for Xfce configuration

libxfce4ui-4.18.4

Introduction to libxfce4ui

The libxfce4ui package contains GTK+ 3 widgets that are used by other Xfce applications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libxfce4ui Dependencies

Required

GTK+-3.24.38 and Xfconf-4.18.1

Recommended
Optional

GTK-Doc-1.33.2, libgtop-2.40.0, libgudev-238, and Glade

Installation of libxfce4ui

Install libxfce4ui by running the following commands:

./configure --prefix=/usr --sysconfdir=/etc &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: None
Installed Libraries: libxfce4kbd-private-{2,3}.so and libxfce4ui-{1,2}.so
Installed Directories: /etc/xdg/xfce4, /usr/include/xfce4/libxfce4kbd-private-2, /usr/include/xfce4/libxfce4ui-{1,2}, and /usr/share/gtk-doc/html/libxfce4ui

Short Descriptions

libxfce4kbd-private-2.so

is a private Xfce library for sharing code between Xfwm4 and Xfce4 Settings

libxfce4ui-1.so

contains widgets that are used by other Xfce applications

Exo-4.18.0

Introduction to Exo

Exo is a support library used in the Xfce desktop. It also has some helper applications that are used throughout Xfce.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Exo Dependencies

Required

GTK+-3.24.38, libxfce4ui-4.18.4, and libxfce4util-4.18.1

Optional

GTK-Doc-1.33.2

Installation of Exo

Install Exo by running the following commands:

./configure --prefix=/usr --sysconfdir=/etc &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: exo-desktop-item-edit and exo-open
Installed Libraries: libexo-2.so
Installed Directories: /usr/include/exo-2 and /usr/share/gtk-doc/html/exo-2

Short Descriptions

exo-desktop-item-edit

is a command line utility to create or edit icons on the desktop

exo-open

is a command line frontend to the Xfce Preferred Applications framework. It can either be used to open a list of urls with the default URL handler or launch the preferred application for a certain category

libexo-2.so

contains additional widgets, a framework for editable toolbars, light-weight session management support and functions to automatically synchronise object properties (based on GObject Binding Properties)

Garcon-4.18.1

Introduction to Garcon

The Garcon package contains a freedesktop.org compliant menu implementation based on GLib and GIO.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Garcon Dependencies

Required

libxfce4ui-4.18.4 and GTK+-3.24.38

Optional

GTK-Doc-1.33.2

Installation of Garcon

Install Garcon by running the following commands:

./configure --prefix=/usr --sysconfdir=/etc &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Library: libgarcon-1.so and libgarcon-gtk3-1.so
Installed Directory: /usr/include/garcon-1, /usr/include/garcon-gtk3-1, and /usr/share/gtk-doc/html/garcon

Short Descriptions

libgarcon-1.so

contains functions that provide a freedesktop.org compliant menu implementation based on GLib and GIO

xfce4-panel-4.18.4

Introduction to Xfce4 Panel

The Xfce4 Panel package contains the Xfce4 Panel.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Xfce4 Panel Dependencies

Required

Cairo-1.17.6, Exo-4.18.0, Garcon-4.18.1, and libwnck-43.0

Optional

GTK-Doc-1.33.2 and libdbusmenu

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/xfce4-panel

Installation of Xfce4 Panel

Install Xfce4 Panel by running the following commands:

./configure --prefix=/usr --sysconfdir=/etc &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: xfce4-panel, xfce4-popup-applicationsmenu, xfce4-popup-directorymenu, and xfce4-popup-windowmenu
Installed Library: libxfce4panel-2.0.so
Installed Directories: /etc/xdg/xfce4/panel, /usr/include/xfce4/libxfce4panel-1.0, /usr/lib/xfce4/panel, /usr/share/gtk-doc/html/libxfce4panel-1.0 and /usr/share/xfce4/panel

Short Descriptions

xfce4-panel

is the Xfce panel

xfce4-popup-applicationsmenu

is a shell script that uses D-Bus and Xfce Panel to display a popup menu of the installed applications

xfce4-popup-directorymenu

is a shell script that uses D-Bus and Xfce Panel to display a popup menu of your home folder and its subdirectories

xfce4-popup-windowmenu

is a shell script that uses DBus to display the Xfwm4 a popup menu

libxfce4panel-2.0.so

contains the Xfce Panel API functions

thunar-4.18.6

Introduction to thunar

Thunar is the Xfce file manager, a GTK+ 3 GUI to organise the files on your computer.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Thunar Dependencies

Required

Exo-4.18.0

Required (Runtime)

hicolor-icon-theme-0.17

Recommended
Optional

GTK-Doc-1.33.2 (for documentation), Gvfs-1.50.6 (for remote browsing and automounting), libexif-0.6.24 and tumbler-4.18.1 (runtime)

Installation of Thunar

Install Thunar by running the following commands:

./configure --prefix=/usr \
            --sysconfdir=/etc \
            --docdir=/usr/share/doc/thunar-4.18.6 &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: Thunar (symlink to thunar), thunar, and thunar-settings
Installed Library: libthunarx-3.so
Installed Directories: /etc/xdg/Thunar, /usr/include/thunarx-3, /usr/lib/Thunar, /usr/lib/thunarx-3, /usr/share/Thunar, /usr/share/doc/thunar-4.18.6, and /usr/share/gtk-doc/html/thunarx

Short Descriptions

thunar

is the Xfce file manager

thunar-settings

is a shell script that launches a dialog box to allow you to alter the behavior of Thunar

libthunarx-3.so

contains the Thunar extension library which permits adding new features to the Thunar file manager

thunar-volman-4.18.0

Introduction to the Thunar Volume Manager

The Thunar Volume Manager is an extension for the Thunar file manager, which enables automatic management of removable drives and media.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Thunar Volume Manager Dependencies

Required

Exo-4.18.0 and libgudev-238

Recommended
Recommended Runtime Dependencies

Installation of the Thunar Volume Manager

Install the Thunar Volume Manager by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: thunar-volman and thunar-volman-settings
Installed Libraries: None
Installed Directories: None

Short Descriptions

thunar-volman

is the Thunar Volume Manager, a command line utility to automatically mount or unmount removable media

thunar-volman-settings

is a small GTK+ 3 application for changing Thunar Volume Manager settings

tumbler-4.18.1

Introduction to tumbler

The Tumbler package contains a D-Bus thumbnailing service based on the thumbnail management D-Bus specification. This is useful for generating thumbnail images of files.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Tumbler Dependencies

Required

GLib-2.76.4

Optional

cURL-8.2.1, FreeType-2.13.1, gdk-pixbuf-2.42.10, gst-plugins-base-1.22.5, GTK-Doc-1.33.2, libjpeg-turbo-3.0.0, libgsf-1.14.50, libpng-1.6.40, Poppler-23.08.0, FFmpegThumbnailer, libgepub, and libopenraw

Installation of Tumbler

Install Tumbler by running the following commands:

./configure --prefix=/usr --sysconfdir=/etc &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: tumblerd
Installed Library: libtumbler-1.so and several under /usr/lib/tumbler-1/plugins/
Installed Directories: /etc/xdg/tumbler, /usr/include/tumbler-1, /usr/lib/tumbler-1 and /usr/share/gtk-doc/html/tumbler

Short Descriptions

tumblerd

is a D-Bus service for applications such as Thunar and Ristretto to use thumbnail images

libtumbler-1.so

contains functions that the Tumbler daemon uses to create thumbnail images

xfce4-appfinder-4.18.1

Introduction to Xfce4 Appfinder

Xfce4 Appfinder is a tool to find and launch installed applications by searching the .desktop files installed on your system.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Xfce4 Appfinder Dependencies

Required

Garcon-4.18.1

Installation of Xfce4 Appfinder

Install Xfce4 Appfinder by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: xfce4-appfinder and xfrun4 (symlink)
Installed Libraries: None
Installed Directories: None

Short Descriptions

xfce4-appfinder

Is a GTK+ 3 application that enables you to quickly search through the .desktop files installed on your system looking for an application

xfce4-power-manager-4.18.2

Introduction to Xfce4 Power Manager

The Xfce4 Power Manager is a power manager for the Xfce desktop, Xfce power manager manages the power sources on the computer and the devices that can be controlled to reduce their power consumption (such as LCD brightness level or monitor sleep). In addition, Xfce4 Power Manager provides a set of freedesktop-compliant DBus interfaces to inform other applications about current power level so that they can adjust their power consumption.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Xfce4 Power Manager Dependencies

Required

libnotify-0.8.2, UPower-1.90.2, and xfce4-panel-4.18.4

Recommended
Optional

NetworkManager-1.44.0

Installation of Xfce4 Power Manager

Install Xfce4 Power Manager by running the following commands:

./configure --prefix=/usr --sysconfdir=/etc &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: xfce4-power-manager, xfce4-power-manager-settings, xfce4-pm-helper, and xfpm-power-backlight-helper
Installed Libraries: libxfce4powermanager.so
Installed Directories: None

Short Descriptions

xfce4-pm-helper

is a helper program for the suspend and hibernate functions of xfce4-power-manager

xfce4-power-manager

is the Xfce Power Manager

xfce4-power-manager-settings

is a utility that comes with the Xfce Power Manager to access/change its configuration

xfpm-power-backlight-helper

is a command line utility to get or set the brightness of your screen

xfce4-settings-4.18.3

Introduction to Xfce4 Settings

The Xfce4 Settings package contains a collection of programs that are useful for adjusting your Xfce preferences.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Xfce4 Settings Dependencies

Required

Exo-4.18.0 and Garcon-4.18.1

Required (Runtime)

gnome-icon-theme-3.12.0 or lxde-icon-theme-0.5.1

Recommended
Optional

colord-1.4.6, libinput-1.23.0, and UPower-1.90.2

Installation of Xfce4 Settings

Install Xfce4 Settings by running the following commands:

./configure --prefix=/usr --sysconfdir=/etc &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--enable-sound-settings: Use this switch to enable sound settings in GUI.

--enable-pluggable-dialogs: Use this switch to enable support for embedded settings dialogs.

Contents

Installed Programs: xfce4-accessibility-settings, xfce4-appearance-settings, xfce4-color-settings, xfce4-display-settings, xfce4-find-cursor, xfce4-keyboard-settings, xfce4-mime-helper, xfce4-mime-settings, xfce4-mouse-settings, xfce4-settings-editor, xfce4-settings-manager and xfsettingsd
Installed Libraries: None
Installed Directories: None

Short Descriptions

xfce4-accessibility-settings

is a GTK+ 3 GUI to allow you to change some of your keyboard and mouse preferences

xfce4-appearance-settings

is a GTK+ 3 GUI to allow you to change some of your theme, icon and font preferences

xfce4-display-settings

is a GTK+ 3 GUI to allow you to change some of your screen preferences

xfce4-keyboard-settings

is a GTK+ 3 GUI to allow you to change some of your keyboard preferences

xfce4-mime-settings

is a GTK+ 3 GUI to allow you to change which applications are used to handle different mime types

xfce4-mouse-settings

is a GTK+ 3 GUI to allow you to change some of your mouse preferences

xfce4-settings-editor

is a GTK+ 3 GUI to allow you to change your preferences stored in Xfconf

xfce4-settings-manager

is a GTK+ 3 GUI to allow you to change many of your Xfce preferences

xfsettingsd

is the Xfce settings daemon

Xfdesktop-4.18.1

Introduction to Xfdesktop

Xfdesktop is a desktop manager for the Xfce Desktop Environment. Xfdesktop sets the background image / color, creates the right click menu and window list and displays the file icons on the desktop using Thunar libraries.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Xfdesktop Dependencies

Required

Exo-4.18.0 and libwnck-43.0

Recommended

Installation of Xfdesktop

Install Xfdesktop by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: xfdesktop and xfdesktop-settings
Installed Libraries: None
Installed Directories: /usr/share/backgrounds/xfce and /usr/share/pixmaps/xfdesktop

Short Descriptions

xfdesktop

is the Xfce Desktop Environment's desktop manager

xfdesktop-settings

is a GTK+ 3 application that allows you to change your desktop background, some preferences for the right click menu and what icons are displayed on the desktop

Xfwm4-4.18.0

Introduction to Xfwm4

Xfwm4 is the window manager for Xfce.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Xfwm4 Dependencies

Required

libwnck-43.0 and libxfce4ui-4.18.4

Recommended
Optional

libxpresent

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/xfwm4

Installation of Xfwm4

Install Xfwm4 by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: xfwm4, xfwm4-settings, xfwm4-tweaks-settings and xfwm4-workspace-settings
Installed Libraries: None
Installed Directories: /usr/lib/xfce4/xfwm4, /usr/share/themes/{Daloa,Default{,-hdpi,-xhdpi},Kokodi,Moheli}, and /usr/share/xfwm4

Short Descriptions

xfwm4

is the Xfce window manager

xfwm4-settings

is a GTK+ 3 application that allows setting some preferences such as your theme, keyboard shortcuts and mouse focus behavior

xfwm4-tweaks-settings

is a GTK+ 3 application that allows setting some more preferences for Xfwm4

xfwm4-workspace-settings

is a GTK+ 3 application that allows setting your workspace preferences

xfce4-session-4.18.3

Introduction to Xfce4 Session

Xfce4 Session is a session manager for Xfce. Its task is to save the state of your desktop (opened applications and their location) and restore it during a next startup. You can create several different sessions and choose one of them on startup.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Xfce4 Session Dependencies

Required

libwnck-43.0 and libxfce4ui-4.18.4

Recommended
Required Runtime

Xfdesktop-4.18.1

Installation of Xfce4 Session

Install Xfce4 Session by running the following commands:

./configure --prefix=/usr \
            --sysconfdir=/etc \
            --disable-legacy-sm &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-legacy-sm: This switch disables legacy session management which isn't necessary on modern system.

Configuring Xfce4 Session

There are several optional run time dependencies for Xfce4: dbus-1.14.8, GnuPG-2.4.3, hicolor-icon-theme-0.17, OpenSSH-9.4p1, and xinit-1.4.2

When building an Xfce4 package, some configuration files are installed in /usr/share/applications, /usr/share/icons, and /usr/share/mime. In order to use those files in your Xfce4 session, you need to update various databases. Do that by running, as the root user (you need to have the recommended dependencies installed):

update-desktop-database &&
update-mime-database /usr/share/mime

Starting Xfce4

You can start Xfce4 from a TTY using xinit-1.4.2, or from a graphical display manager, such as lightdm-1.32.0.

To start Xfce4 using xinit-1.4.2, run the following commands:

cat > ~/.xinitrc << "EOF"
dbus-launch --exit-with-x11 startxfce4
EOF

startx

The X session starts on the first unused virtual terminal, normally vt7. You can switch to another vtn simultaneously pressing the keys Ctrl-Alt-Fn (n=1, 2, ...). To switch back to the X session, normally started at vt7, use Ctrl-Alt-F7. The vt where the command startx was executed will display many messages, including X starting messages, applications automatically started with the session, and eventually, some warning and error messages. You may prefer to redirect those messages to a log file, which not only will keep the initial vt uncluttered, but can also be used for debugging purposes. This can be done starting X with:

startx &> ~/.x-session-errors

When shutting down or rebooting, the shutdown messages appear on the vt where X was running. If you wish to see those messages, simultaneously press keys Alt-F7 (assuming that X was running on vt7).

Contents

Installed Programs: startxfce4, xfce4-session, xfce4-session-logout, xfce4-session-settings, and xflock4
Installed Library: None
Installed Directories: /usr/lib/xfce4/session

Short Descriptions

startxfce4

is a script responsible for starting an Xfce session.

xfce4-session

starts up the Xfce Desktop Environment

xfce4-session-logout

logs out from Xfce

xfce4-session-settings

is a GTK+ 3 GUI which allows you to alter your preferences for your Xfce Session

Chapter 36. Xfce Applications

This is a small collection of optional applications that add extra capabilities to your Xfce desktop.

Parole-4.18.0

Introduction to Parole

Parole is a DVD/CD/music player for Xfce that uses GStreamer.

This package is known to build and work properly using an LFS 12.0 platform.

Note

Although this version of parole works with most files, it is unable to play DVDs, reporting an error in the gstreamer backend.

Package Information

Parole Dependencies

Required

gst-plugins-base-1.22.5, gst-plugins-good-1.22.5 and libxfce4ui-4.18.4

Recommended
Optional

GTK-Doc-1.33.2

Installation of Parole

Install Parole by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Using Parole

If you have installed Gstreamer Plugins Ugly with support for libdvdnav and libdvdread and would like to use Parole to play a DVD, click Media> Open location and enter dvd:// into the box.

Similarly, to play a CD, click Media> Open location and enter cdda:// into the box.

Contents

Installed Program: parole
Installed Libraries: Two libraries under /usr/lib/parole-0/
Installed Directories: /usr/include/parole, /usr/lib/parole-0 and /usr/share/parole

Short Descriptions

parole

is a GTK+ 3 media player that uses GStreamer

xfce4-terminal-1.1.0

Introduction to Xfce4 Terminal

Xfce4 Terminal is a GTK+3 terminal emulator. This is useful for running commands or programs in the comfort of an Xorg window; you can drag and drop files into the Xfce4 Terminal or copy and paste text with your mouse.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Xfce4 Terminal Dependencies

Required

libxfce4ui-4.18.4 and VTE-0.72.2

Installation of Xfce4 Terminal

Install Xfce4 Terminal by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: xfce4-terminal
Installed Libraries: None
Installed Directory: /usr/share/xfce4/terminal

Short Descriptions

xfce4-terminal

is a GTK+ 3 terminal emulator

Xfburn-0.7.0

Introduction to Xfburn

Xfburn is a GTK+ 3 GUI frontend for Libisoburn. This is useful for creating CDs and DVDs from files on your computer or ISO images downloaded from elsewhere.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Xfburn Dependencies

Required

Exo-4.18.0, libburn-1.5.6, libisofs-1.5.6, and libxfce4ui-4.18.4

Optional

gst-plugins-base-1.22.5 and Cdrdao-1.2.4 (runtime)

Installation of Xfburn

Install Xfburn by running the following commands:

./configure --prefix=/usr --disable-static &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Program: xfburn
Installed Libraries: None
Installed Directory: /usr/share/xfburn

Short Descriptions

xfburn

is a GTK+ 3 application for creating CDs and DVDs

Ristretto-0.13.1

Introduction to Ristretto

Ristretto is a fast and lightweight image viewer for the Xfce desktop.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Ristretto Dependencies

Required

libexif-0.6.24 and libxfce4ui-4.18.4

Optional

tumbler-4.18.1 (runtime)

Installation of Ristretto

Install Ristretto by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: ristretto
Installed Libraries: None
Installed Directories: None

Short Descriptions

ristretto

is a fast and lightweight image viewer

xfce4-dev-tools-4.18.0

Introduction to the Xfce4 Development Tools

The Xfce4 Development Tools are a collection of tools and macros for building some Xfce applications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

The Xfce4 Development Tools Dependencies

Required

GLib-2.76.4

Installation of the Xfce4 Development Tools

Install the Xfce4 Development Tools by running the following commands:

./configure --prefix=/usr &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Contents

Installed Program: xdt-autogen and xdt-csource
Installed Libraries: None
Installed Directories: None

xfce4-notifyd-0.8.2

Introduction to the Xfce4 Notification Daemon

The Xfce4 Notification Daemon is a small program that implements the "server-side" portion of the Freedesktop desktop notifications specification. Applications that wish to pop up a notification bubble in a standard way can use Xfce4-Notifyd to do so by sending standard messages over D-Bus using the org.freedesktop.Notifications interface.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

The Xfce4 Notification Daemon Dependencies

Required

libnotify-0.8.2, libxfce4ui-4.18.4, xfce4-dev-tools-4.18.0, and xfce4-panel-4.18.4

Installation of the Xfce4 Notification Daemon

Install the Xfce4 Notification Daemon by running the following commands:

./configure --prefix=/usr --sysconfdir=/etc &&
make

This package does not come with a test suite.

Now, as the root user:

make install

You can test the notification daemon with the command notify-send, to be run in a graphical environment:

notify-send -i info Information "Hi ${USER}, This is a Test"

Contents

Installed Program: xfce4-notifyd-config
Installed Libraries: libnotification-plugin.so
Installed Directories: /usr/share/themes/Bright/xfce-notify-4.0, /usr/share/themes/Default/xfce-notify-4.0, /usr/share/themes/Retro/xfce-notify-4.0, /usr/share/themes/Smoke/xfce-notify-4.0 and /usr/share/themes/ZOMG-PONIES!/xfce-notify-4.0

Short Descriptions

xfce4-notifyd-config

is a GTK+ GUI that allows you to change some of your preferences (theme and screen position) for the notifications that the Xfce4 Notification Daemon displays

xfce4-pulseaudio-plugin-0.4.7

Introduction to the Xfce4 Pulseaudio Plugin

The Xfce4 Pulseaudio Plugin is a plugin for the Xfce panel which provides a convenient way to adjust the audio volume of the PulseAudio sound system and to an auto mixer tool like pavucontrol. It can optionally handle multimedia keys for controlling the audio volume.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Xfce4 Pulseaudio Plugin Dependencies

Required

dbus-glib-0.112, libnotify-0.8.2, PulseAudio-16.1, and xfce4-panel-4.18.4

Recommended

Installation of the Xfce4 Pulseaudio Plugin

Install the Xfce4 Pulseaudio Plugin by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: None
Installed Libraries: libpulseaudio-plugin.so
Installed Directories: None

Part X. LXDE

Chapter 37. LXDE Desktop

LXDE is an extremely fast-performing and energy-saving desktop environment.

LXDE comes with a beautiful interface, multi-language support, standard keyboard shortcuts and additional features like tabbed file browsing. LXDE uses less CPU and less RAM than other environments. It is especially designed for cloud computers with low hardware specifications, such as netbooks, mobile devices (e.g. MIDs) or older computers.

Build LXDE core packages in the order presented in the book for the easiest resolution of dependencies.

lxmenu-data-0.1.5

Introduction to LXMenu Data

The LXMenu Data package provides files required to build freedesktop.org menu spec-compliant desktop menus for LXDE.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of LXMenu Data

Install LXMenu Data by running the following commands:

./configure --prefix=/usr --sysconfdir=/etc &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /etc/xdg/menus and /usr/share/desktop-directories

libfm-extra-1.3.2

Introduction to libfm-extra

The libfm-extra package contains a library and other files required by menu-cache-gen libexec of menu-cache-1.1.0.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libfm-extra Dependencies

Required

GLib-2.76.4

Installation of libfm-extra

Install libfm-extra by running the following commands:

./configure --prefix=/usr     \
            --sysconfdir=/etc \
            --with-extra-only \
            --with-gtk=no     \
            --disable-static  &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--with-extra-only: This switch disables all components except for the libfm-extra library.

--with-gtk=no: This switch disables support for GTK+ because it is not necessary for this package.

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Library: libfm-extra.so
Installed Directories: /usr/include/libfm (symlink) and /usr/include/libfm-1.0

Short Descriptions

libfm-extra.so

contains the libfm-extra API functions

menu-cache-1.1.0

Introduction to Menu Cache

The Menu Cache package contains a library for creating and utilizing caches to speed up the manipulation for freedesktop.org defined application menus.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Menu Cache Dependencies

Required

libfm-extra-1.3.2

Optional

GTK-Doc-1.33.2 and xdg-utils-1.1.3

Installation of Menu Cache

First fix a memory leak and multiple definitions issues:

patch -Np1 -i ../menu-cache-1.1.0-consolidated_fixes-1.patch

Install Menu Cache by running the following commands:

./configure --prefix=/usr    \
            --disable-static &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-gtk-doc: Use this option if GTK-Doc is installed and you wish to build and install the API documentation.

Contents

Installed Programs: None
Installed Library: libmenu-cache.so
Installed Directories: /usr/{include,libexec,share/gtk-doc/html}/menu-cache

Short Descriptions

libmenu-cache.so

contains the menu-cache API functions

libfm-1.3.2

Introduction to libfm

The libfm package contains a library used to develop file managers providing some file management utilities.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libfm Dependencies

Required

GTK+-2.24.33 or GTK+-3.24.38 (GTK+-2 recommended since LXDE GTK+-3 support is still experimental), and menu-cache-1.1.0

Recommended
Optional

GTK-Doc-1.33.2, dbus-glib-0.112 and Gvfs-1.50.6 or udisks (for volume management - experimental)

Installation of libfm

Install libfm by running the following commands:

./configure --prefix=/usr     \
            --sysconfdir=/etc \
            --disable-static  &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--with-gtk=3: This option selects the version of gtk+ to use. The default is gtk+-2.

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Program: libfm-pref-apps and lxshortcut
Installed Libraries: libfm.so, libfm-extra.so and libfm-gtk.so
Installed Directories: /etc/xdg/libfm, /usr/lib/libfm, /usr/share/gtk-doc/html/libfm and /usr/share/libfm

Short Descriptions

libfm-pref-apps

sets preferred applications for programs based on libfm

lxshortcut

is a small program used to edit application shortcuts

libfm.so

contains the libfm API functions

PCManFM-1.3.2

Introduction to PCManFM

The PCManFM package contains an extremely fast, lightweight, yet feature-rich file manager with tabbed browsing.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

PCManFM Dependencies

Required

libfm-1.3.2

Recommended

Installation of PCManFM

Install PCManFM by running the following commands:

./configure --prefix=/usr     \
            --sysconfdir=/etc &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--with-gtk=3: Selects the version of GTK+ to use. You must use this switch if you have built libfm-1.3.2 with GTK+3 support.

Contents

Installed Program: pcmanfm
Installed Libraries: None
Installed Directories: /etc/xdg/pcmanfm, /usr/lib/pcmanfm and /usr/share/pcmanfm

Short Descriptions

pcmanfm

is a lightweight GTK+ based file manager for X Window System

libwnck-2.30.7

Introduction to libwnck

The libwnck package contains a Window Navigator Construction Kit.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libwnck Dependencies

Required

GTK+-2.24.33

Recommended
Optional

gobject-introspection-1.76.1 and GTK-Doc-1.33.2

Installation of libwnck

Install libwnck by running the following commands:

./configure --prefix=/usr \
            --disable-static \
            --program-suffix=-1 &&
make GETTEXT_PACKAGE=libwnck-1

This package does not come with a test suite.

Now, as the root user:

make GETTEXT_PACKAGE=libwnck-1 install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--program-suffix=-1: This option adds -1 to the end of the names of the installed programs to avoid overwriting the programs installed by libwnck-43.0.

GETTEXT_PACKAGE=libwnck-1: This parameter adds -1 to the end of the names of the gettext files installed by the package to avoid overwriting the files installed by libwnck-43.0.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Programs: wnckprop-1 and wnck-urgency-monitor-1
Installed Library: libwnck-1.so
Installed Directories: /usr/include/libwnck-1.0 and /usr/share/gtk-doc/html/libwnck-1.0

Short Descriptions

wnckprop-1

Prints, modifies, or interacts with the properties of a screen/workspace/window

libwnck-1.so

contains functions for writing pagers and task lists

LXPanel-0.10.1

Introduction to LXPanel

The LXPanel package contains a lightweight X11 desktop panel.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

LXPanel Dependencies

Required

gdk-pixbuf-xlib-2.40.2, keybinder-0.3.1, libwnck-2.30.7, lxmenu-data-0.1.5 and menu-cache-1.1.0

Recommended
Optional

libindicator (indicator plugin)

Installation of LXPanel

Install LXPanel by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: lxpanel and lxpanelctl
Installed Libraries: liblxpanel.so and several under /usr/lib/lxpanel/plugins
Installed Directories: /etc/xdg/lxpanel, /usr/include/lxpanel, /usr/lib/lxpanel, and /usr/share/lxpanel

Short Descriptions

lxpanel

is a lightweight GTK+ based panel for the LXDE Desktop

lxpanelctl

is a program that controls lxpanel

LXAppearance-0.6.3

Introduction to LXAppearance

The LXAppearance package contains a desktop-independent theme switcher for GTK+.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

LXAppearance Dependencies

Required

GTK+-2.24.33

Recommended
Optional

libxslt-1.1.38 with docbook-xml-4.5 and docbook-xsl-nons-1.79.2 (to build man pages)

Installation of LXAppearance

Install LXAppearance by running the following commands:

./configure --prefix=/usr     \
            --sysconfdir=/etc \
            --enable-dbus     &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--enable-dbus: This switch enables DBus support in LXAppearance which is useful for communicating with LXSession. Remove it if you are not building LXDE or have not installed dbus-glib-0.112.

--enable-man: Use this switch if you have installed optional dependencies and wish to rebuild the manual pages.

Contents

Installed Program: lxappearance
Installed Libraries: None
Installed Directories: /usr/include/lxappearance and /usr/share/lxappearance

Short Descriptions

lxappearance

is a program used to change GTK+ themes, icon themes, and fonts used by applications

LXSession-0.5.5

Introduction to LXSession

The LXSession package contains the default session manager for LXDE.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

LXSession Dependencies

Required

dbus-glib-0.112, libunique-1.1.6, Polkit-123, and Vala-0.56.11

Optional

lsb-tools-0.10 (may be used at runtime to display the distribution release in the logout dialog), GTK+-3.24.38, and libxslt-1.1.38 with docbook-xml-4.5 and docbook-xsl-nons-1.79.2 (to build man pages)

Installation of LXSession

Install LXSession by running the following commands:

./configure --prefix=/usr --disable-man &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-man: This switch disables building of the manual pages. Remove it if you have installed optional dependencies and wish to build the manual pages.

--enable-gtk3: Builds against GTK+-3 instead of GTK+-2, which is required anyway by libunique.

Contents

Installed Programs: lxclipboard, lxlock, lxpolkit, lxsession, lxsession-db, lxsession-default, lxsession-default-apps, lxsession-default-terminal, lxsession-edit, lxsession-logout, lxsession-xdg-autostart, lxsession-xsettings, and lxsettings-daemon
Installed Libraries: None
Installed Directory: /usr/share/lxsession

Short Descriptions

lxclipboard

is a clipboard utility for LXSession and LXDE

lxlock

locks the local X display until a password is entered

lxpolkit

is a polkit agent

lxsession

is a lightweight X session manager

lxsession-db

is used to modify the database for managing sessions in lxsession

lxsession-default

launch default applications set by LXsession

lxsession-default-apps

is an utility to configure lxsession and its default applications

lxsession-default-terminal

launch the default terminal set by LXSession

lxsession-edit

is the standard session edit manager used by LXDE

lxsession-logout

is a program to logout from LXSession

lxsession-xdg-autostart

handles the autostart spec of freedesktop.org

lxsession-xsettings

is a tool to configure gtk+ themes, keyboard, and mouse for you on session startup

lxsettings-daemon

is the settings daemon for LXsession

lxde-common-0.99.2

Introduction to LXDE Common

The LXDE Common package provides a set of default configuration for LXDE.

Note

LXDE has no backlight control functionality for laptops. If you need backlight control, you should use an alternative desktop environment, or consider adjusting the backlight on your laptop manually using the instructions from Arch Linux Wiki - Backlight.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

LXDE Common Dependencies

Required

lxde-icon-theme-0.5.1, LXPanel-0.10.1, LXSession-0.5.5, openbox-3.6.1 (runtime), and PCManFM-1.3.2

Recommended
Optional Runtime Dependencies

A notification daemon such as notification-daemon-3.20.0 or xfce4-notifyd-0.8.2, and a display manager such as sddm-0.20.0 or lightdm-1.32.0

Installation of LXDE Common

Install LXDE Common by running the following commands:

./configure --prefix=/usr --sysconfdir=/etc &&
make

This package does not come with a test suite.

Now, as the root user:

make install

If you have installed recommended dependencies, run the following commands as the root user:

update-mime-database /usr/share/mime &&
gtk-update-icon-cache -qf /usr/share/icons/hicolor &&
update-desktop-database -q

Starting LXDE

You can start LXDE from runlevel 3, using xinit-1.4.2, or from runlevel 5, using a Display Manager, such as sddm-0.20.0 or lightdm-1.32.0.

To start LXDE using xinit-1.4.2, run the following commands:

cat > ~/.xinitrc << "EOF"
# No need to run dbus-launch, since it is run by startlxde
startlxde
EOF

startx

The X session starts on the first unused virtual terminal, normally vt7. You can switch to another vtn simultaneously pressing the keys Ctrl-Alt-Fn (n=1, 2, ...). To switch back to the X session, normally started at vt7, use Ctrl-Alt-F7. The vt where the command startx was executed will display many messages, including X starting messages, applications automatically started with the session, and eventually, some warning and error messages. You may prefer to redirect those messages to a log file, which not only will keep the initial vt uncluttered, but can also be used for debug purposes. This can be done starting X with:

startx &> ~/.x-session-errors

When shutting down or rebooting, the shutdown messages appear on the vt where X was running. If you wish to see those messages, simultaneously press keys Alt-F7 (assuming that X was running on vt7).

Contents

Installed Programs: lxde-logout, openbox-lxde and startlxde
Installed Libraries: None
Installed Directories: /etc/xdg/{lxpanel,lxsession,openbox,pcmanfm}/LXDE and /usr/share/lxde

Short Descriptions

lxde-logout

is used to quit the desktop session for LXDE

openbox-lxde

is a wrapper script which runs Openbox with LXDE specific config file

startlxde

is used to start the desktop session for LXDE

Chapter 38. LXDE Applications

This is a small collection of optional applications that add extra capabilities to the LXDE desktop.

GPicView-0.2.5

Introduction to GPicView

The GPicView package contains a lightweight image viewer.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GPicView Dependencies

Required

GTK+-2.24.33

Installation of GPicView

Install GPicView by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install &&
sed -i 's/Utility;//' /usr/share/applications/gpicview.desktop

If you have xdg-utils-1.1.3 installed, as the root user, you should run the xdg-icon-resource forceupdate --theme hicolor command, for the installed icon to be displayed in the menu item.

Command Explanations

sed -i ...: Fixes submenu for GPicView.

Contents

Installed Program: gpicview
Installed Libraries: None
Installed Directory: /usr/share/gpicview

Short Descriptions

gpicview

is a lightweight image viewer

lxappearance-obconf-0.2.3

Introduction to LXAppearance OBconf

The LXAppearance OBconf package contains a plugin for LXAppearance to configure OpenBox.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

LXAppearance OBconf Dependencies

Required

LXAppearance-0.6.3 and openbox-3.6.1

Installation of LXAppearance OBconf

Install LXAppearance OBconf by running the following commands:

./configure --prefix=/usr --disable-static &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Library: /usr/lib/lxappearance/plugins/obconf.so
Installed Directories: /usr/lib/lxappearance and /usr/share/lxappearance/obconf

LXInput-0.3.5

Introduction to LXInput

The LXInput package contains a small program used to configure keyboard and mouse for LXDE.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

LXInput Dependencies

Required

GTK+-2.24.33

Installation of LXInput

Install LXInput by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: lxinput
Installed Libraries: None
Installed Directory: /usr/share/lxinput

Short Descriptions

lxinput

is a program used to configure keyboard and mouse

LXRandR-0.3.2

Introduction to LXRandR

The LXRandR package contains a monitor configuration tool for LXDE.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

LXRandR Dependencies

Required

GTK+-2.24.33 and Xorg Applications

Optional

libxslt-1.1.38 with docbook-xml-4.5 and docbook-xsl-nons-1.79.2 (to build man pages)

Installation of LXRandR

Install LXRandR by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--enable-man: Use this switch if you have installed optional dependencies and wish to build the manual pages.

Contents

Installed Program: lxrandr
Installed Libraries: None
Installed Directories: None

Short Descriptions

lxrandr

is a GTK+ interface to XRandR

LXTask-0.1.10

Introduction to LXTask

The LXTask package contains a lightweight and desktop-independent task manager.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

LXTask Dependencies

Required

GTK+-2.24.33

Installation of LXTask

Install LXTask by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: lxtask
Installed Libraries: None
Installed Directories: None

Short Descriptions

lxtask

is a lightweight and desktop-independent task manager

Vte-0.28.2

Introduction to Vte

Vte is a library (libvte) implementing a terminal emulator widget for GTK+ 2, and a minimal demonstration application (vte) that uses libvte.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Vte Dependencies

Required

GTK+-2.24.33

Optional

gobject-introspection-1.76.1, GTK-Doc-1.33.2 and PyGTK-2.24.0

Installation of Vte

Install Vte by running the following commands:

./configure --prefix=/usr \
            --libexecdir=/usr/lib/vte \
            --disable-static  &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--libexecdir=/usr/lib/vte : both this package and VTE-0.72.2 install files of the same name. This switch ensures that they do not overwrite each other if both are installed.

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Program: vte
Installed Library: libvte.so
Installed Directories: /usr/include/vte-0.0, /usr/lib/vte, /usr/share/gtk-doc/html/vte-0.0 and /usr/share/vte

Short Descriptions

vte

is a simple terminal emulator

libvte.so

contains the Vte API functions

LXTerminal-0.4.0

Introduction to LXTerminal

The LXTerminal package contains a VTE-based terminal emulator for LXDE with support for multiple tabs.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

LXTerminal Dependencies

Required

Vte-0.28.2

Optional

libxslt-1.1.38 with docbook-xml-4.5 and docbook-xsl-nons-1.79.2 (to build man pages)

Installation of LXTerminal

Install LXTerminal by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--enable-man: Use this switch if you have installed optional dependencies and wish to build the manual pages.

Contents

Installed Program: lxterminal
Installed Libraries: None
Installed Directory: /usr/share/lxterminal

Short Descriptions

lxterminal

a lightweight terminal emulator for the LXDE desktop

Part XI. LXQt

Chapter 39. LXQt Desktop

LXQt is an extremely fast-performing and energy-saving desktop environment.

LXQt is a Qt based Desktop Environment. It is focused on being a classic desktop with a modern look and feel. It can customize appearance everywhere. The panel(s) have plugins and settings. It is Window Manager agnostic, has multi-language support and standard keyboard shortcuts. LXQt uses less CPU and less RAM than most other environments. It is especially useful for cloud computers with low hardware specifications, such as netbooks, mobile devices (e.g. MIDs) or older computers, but can be used with modern hardware.

Build LXQt core packages in the order presented in the book for the easiest resolution of dependencies.

LXQt Desktop Pre-Install Instructions

Notes about building LXQt dependencies

To build LXQt, the following steps are recommended:

  1. First, build the whole Xorg Chapter, including Wayland support with required and recommended dependencies. Test that the environment works with twm as the window manager. With experience, some of the packages can be omitted, but that is not recommended for first time users.

  2. Second, build the required parts of Qt. The full package, Qt-5.15.10 is quite long and has a lot of dependencies. As an alternative, the required components needed for LXQt can be built using the procedures in qt-alternate-5.15.10.

  3. Finally build the LXQt desktop using the pages below in order. The packages in the applications section are optional, but as a minimum, qterminal-1.3.0 is recommended.

KF5, Plasma, and Misc Dependencies

kwindowsystem-5.109.0 for lxqt

Introduction to kwindowsystem

The kwindowsystem provides information about, and allows interaction with, the windowing system. It provides a high level API that is windowing system independent and has platform specific implementations.

This package is known to build and work properly using an LFS 12.0 platform.

Important

This package is extracted from the KF5 set of packages. If KDE Frameworks-5.109.0 is built, do NOT also build this package as presented here.

Package Information

kwindowsystem Dependencies

Required

extra-cmake-modules-5.109.0, Xorg Libraries, and (Qt-5.15.10 or qt-alternate-5.15.10)

User Notes: https://wiki.linuxfromscratch.org/blfs/wiki/kwindowsystem

Installation of kwindowsystem

Install kwindowsystem by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DBUILD_TESTING=OFF         \
      -Wno-dev ..                 &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Finally, remove some unneeded files as the root user:

rm -rf /usr/mkspecs

Contents

Installed Programs: None
Installed Library: libKF5WindowSystem.so
Installed Directories: /usr/lib/cmake/KF5WindowSystem, /usr/include/KF5, and /usr/lib/plugins/kf5

Short Descriptions

libKF5WindowSystem.so

contains the KF5 Windowing API functions

kwayland-5.109.0 for lxqt

Introduction to kwayland

kwayland is a Qt-style API to interact with the wayland-client and wayland-server API.

This package is known to build and work properly using an LFS 12.0 platform.

Important

This package is extracted from the KF5 set of packages. If KDE Frameworks-5.109.0 is built, do NOT also build this package as presented here.

Package Information

kwayland Dependencies

Required

extra-cmake-modules-5.109.0, Mesa-23.1.6 (built with Wayland-1.22.0 support), plasma-wayland-protocols-1.10.0, and (Qt-5.15.10 or qt-alternate-5.15.10)

Installation of kwayland

Install kwayland by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DBUILD_TESTING=OFF         \
      -Wno-dev ..                 &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Finally, remove some unneeded files as the root user:

rm -rf /usr/mkspecs

Contents

Installed Programs: None
Installed Library: libKF5WaylandClient.so and libKF5WaylandServer.so
Installed Directories: /usr/lib/cmake/KF5Wayland, /usr/include/KF5/KWayland, and /usr/share/qlogging-categories5

Short Descriptions

libKF5WaylandClient.so

contains the wayland-client Qt-style wrapper library

libKF5WaylandServer.so

contains the wayland-server Qt-style wrapper library

kconfig-5.109.0 for lxqt

Introduction to kconfig

The kconfig package provides access to configuration files.

This package is known to build and work properly using an LFS 12.0 platform.

Important

This package is extracted from the KF5 set of packages. If KDE Frameworks-5.109.0 is built, do NOT also build this package as presented here.

Package Information

kconfig Dependencies

Required

extra-cmake-modules-5.109.0 and (Qt-5.15.10 or qt-alternate-5.15.10)

Installation of kconfig

Install kconfig by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DCMAKE_INSTALL_LIBDIR=lib  \
      -DBUILD_TESTING=OFF         \
      -Wno-dev ..                 &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Finally, remove some unneeded files as the root user:

rm -rf /usr/mkspecs &&
rm -rf /usr/lib/libexec

Contents

Installed Programs: kreadconfig5 and kwriteconfig5
Installed Library: libKF5ConfigCore.so, libKF5ConfigGui.so, and libKF5ConfigQml.so
Installed Directories: /usr/lib/cmake/KF5Config and /usr/include/KF5/{KConfigCore,KConfig,KConfigQml,KConfigGui}

Short Descriptions

kreadconfig5

reads a configuration file using the KConfig interface

kwriteconfig5

writes to a configuration file using the KConfig interface

libKF5ConfigCore.so

contains the core configuration library for KF5

libKF5ConfigGui.so

contains functions for a GUI for KConfig

libKF5ConfigQml.so

contains a QML interface to KConfig

solid-5.109.0 for lxqt

Introduction to solid

Solid is a device integration framework. It provides a way of querying and interacting with hardware independently of the underlying operating system.

This package is known to build and work properly using an LFS 12.0 platform.

Important

This package is extracted from the KF5 set of packages. If KDE Frameworks-5.109.0 is built, do NOT also build this package as presented here.

Package Information

solid Dependencies

Required

extra-cmake-modules-5.109.0 and (Qt-5.15.10 or qt-alternate-5.15.10)

Optional (runtime)

UDisks-2.10.0, UPower-1.90.2, libimobiledevice, and media-player-info

Installation of solid

Install solid by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DBUILD_TESTING=OFF         \
      -Wno-dev ..                 &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Finally, remove some unneeded files as the root user:

rm -rf /usr/mkspecs

Contents

Installed Programs: solid-hardware5
Installed Library: libKF5Solid.so
Installed Directories: /usr/include/KF5/Solid, /usr/lib/cmake/KF5Solid, and /usr/lib/qml/org/kde/solid

Short Descriptions

solid-hardware5

queries hardware information from the system

libKF5Solid.so

provides a way of querying and interacting with hardware independently of the underlying operating system

kidletime-5.109.0 for lxqt

Introduction to kidletime

KIdleTime is used to report the idle time of users and the system. It is useful not only for determining the current idle time of the PC, but also for getting notified upon idle time events, such as custom timeouts or user activity.

This package is known to build and work properly using an LFS 12.0 platform.

Important

This package is extracted from the KF5 set of packages. If KDE Frameworks-5.109.0 is built, do NOT also build this package as presented here.

Package Information

kidletime Dependencies

Required

extra-cmake-modules-5.109.0, plasma-wayland-protocols-1.10.0, and (Qt-5.15.10 or qt-alternate-5.15.10)

Installation of kidletime

Install kidletime by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DBUILD_TESTING=OFF         \
      -Wno-dev ..                 &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Finally, remove some unneeded files as the root user:

rm -rf /usr/mkspecs

Contents

Installed Programs: None
Installed Library: libKF5IdleTime.so
Installed Directories: /usr/lib/plugins/kf5/org.kde.kidletime.platforms, /usr/lib/cmake/KF5IdleTime, and /usr/include/KF5/KIdleTime

Short Descriptions

libKF5GuiAddons.so

contains the KDE API for idle time reports

libkscreen-5.27.7 for lxqt

Introduction to libkscreen

The libkscreen package contains the KDE Screen Management library.

This package is known to build and work properly using an LFS 12.0 platform.

Important

This package is extracted from the plasma set of packages. If Plasma-5.27.7 is built, do NOT also build this package as presented here.

Package Information

libkscreen Dependencies

Required

kconfig-5.27.7 for lxqt and kwayland-5.109.0 for lxqt

Installation of libkscreen

Install libkscreen by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DCMAKE_INSTALL_LIBDIR=lib  \
      -DBUILD_TESTING=OFF         \
      -Wno-dev ..                 &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Finally, remove some unneeded files as the root user:

rm -rf /usr/mkspecs &&
rm -rf /usr/lib/libexec

Contents

Installed Programs: kscreen-doctor
Installed Library: libKF5Screen.so and libKF5ScreenDpms.so
Installed Directories: /usr/lib/cmake/KF5Screen, /usr/include/KF5/KScreen, and /usr/lib/plugins/kf5/kscreen

Short Descriptions

kscreen-doctor

allows modifying the screen setup from the command line

libKF5Screen.so

contains the KDE Screen Management library

libKF5ScreenDpms.so

contains API functions for handling DPMS

muparser-2.3.4

Introduction to muparser

The muparser package is a fast math parser library for C and C++.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

muparser Dependencies

Required

CMake-3.27.2

Installation of muparser

Install muparser by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..                          &&
make

To test the results, issue: make test.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Library: libmuparser.so
Installed Directories: /usr/lib/cmake/muparser

Short Descriptions

muparser.so

provides a fast math parser library for C and C++

LXQt Desktop Components

lxqt-build-tools-0.13.0

Introduction to lxqt-build-tools

The lxqt-build-tools package provides several tools needed to build LXQt itself as well as other components maintained by the LXQt project.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

lxqt-build-tools Dependencies

Required

CMake-3.27.2 and (Qt-5.15.10 or qt-alternate-5.15.10)

User Notes: https://wiki.linuxfromscratch.org/blfs/wiki/lxqt-build-tools

Installation of lxqt-build-tools

Install lxqt-build-tools by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      .. &&

make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: lxqt-transupdate
Installed Library: None
Installed Directories: /usr/share/cmake/lxqt-build-tools

Short Descriptions

lxqt-transupdate

updates translations for LXQt components

libqtxdg-3.11.0

Introduction to libqtxdg

The libqtxdg is a Qt implementation of the freedesktop.org xdg specifications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libqtxdg Dependencies

Required

CMake-3.27.2 and (Qt-5.15.10 or qt-alternate-5.15.10)

Optional (runtime)

GTK+-2.24.33 or GTK+-3.24.38 (for gtk-update-icon-cache)

User Notes: https://wiki.linuxfromscratch.org/blfs/wiki/libqtxdg

Installation of libqtxdg

Install libqtxdg by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DCMAKE_INSTALL_LIBDIR=lib  \
      ..       &&

make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

-DBUILD_TESTS=ON: Use this option if you wish to build tests. If you pass this option, you can run the tests by executing: make test.

-DBUILD_DEV_UTILS=ON: Use this switch if you wish to build and install the development utilities.

Contents

Installed Programs: None
Installed Library: libQt5Xdg.so and libQt5XdgIconLoader.so
Installed Directories: /usr/include/{qt5xdg,qt5xdgiconloader} and /usr/share/cmake/{qt5xdg,qt5xdgiconloader}

Short Descriptions

libQt5Xdg.so

contains the libQt5Xdg API functions

libQt5XdgIconLoader.so

contains the libQt5XdgIconLoader API functions

lxqt-menu-data-20230619

Introduction to lxqt-menu-data

The lxqt-menu-data package contains compliant menu files for LXQt.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

lxqt-menu-data Dependencies

Required

lxqt-build-tools-0.13.0

User Notes: https://wiki.linuxfromscratch.org/blfs/wiki/lxqt-menu-data

Installation of lxqt-menu-data

Install lxqt-menu-data by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..  &&

make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: None
Installed Library: None
Installed Directories: /etc/xdg/menus and /usr/share/cmake/lxqt-menu-data

liblxqt-1.3.0

Introduction to liblxqt

The liblxqt is the core utility library for all LXQt components.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

liblxqt Dependencies

Required

libqtxdg-3.11.0, (kwindowsystem-5.109.0 for lxqt or KDE Frameworks-5.109.0), and polkit-qt-0.114.0

Installation of liblxqt

Install liblxqt by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..                          &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: lxqt-backlight_backend
Installed Library: liblxqt.so
Installed Directories: /usr/include/lxqt and /usr/share/cmake/lxqt

Short Descriptions

lxqt-backlight_backend

sets the backlight level for a display

liblxqt.so

contains the liblxqt API functions

libsysstat-0.4.6

Introduction to libsysstat

The libsysstat package contains a library used to query system information and statistics.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libsysstat Dependencies

Required

lxqt-build-tools-0.13.0

User Notes: https://wiki.linuxfromscratch.org/blfs/wiki/libsysstat

Installation of libsysstat

Install libsysstat by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..                          &&

make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: None
Installed Library: libsysstat-qt5.so
Installed Directories: /usr/include/sysstat-qt5 and /usr/share/cmake/sysstat-qt5

Short Descriptions

libsysstat-qt5.so

contains the libsysstat-qt5 API functions

qtxdg-tools-3.11.0

Introduction to qtxdg-tools

The qtxdg-tools contains a CLI MIME tool for handling file associations and opening files with their default applications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

qtxdg-tools Dependencies

Required

libqtxdg-3.11.0

Installation of qtxdg-tools

Install qtxdg-tools by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DCMAKE_INSTALL_LIBDIR=lib  \
      ..                          &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: qtxdg-mat
Installed Library: None
Installed Directories: /usr/share/cmake/qtxdg-tools

Short Descriptions

qtxdg-mat

queries and modifies defaults for applications, such as the default terminal, web browser, email client, and file manager

libfm-qt-1.3.0

Introduction to libfm-qt

libfm-qt is the Qt port of libfm, a library providing components to build desktop file managers.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libfm-qt Dependencies

Required

CMake-3.27.2, libexif-0.6.24, menu-cache-1.1.0, and (Qt-5.15.10 or qt-alternate-5.15.10)

Installation of libfm-qt

Install libfm-qt by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..                          &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Library: libfm-qt.so
Installed Directories: /usr/include/libfm-qt, /usr/share/libfm-qt, and /usr/share/cmake/fm-qt

Short Descriptions

libfm-qt.so

contains the libfm-qt API functions

lxqt-themes-1.3.0

Introduction to lxqt-themes

The lxqt-themes package provides a number of graphics files and themes for the LXQt desktop.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

lxqt-themes Dependencies

Required

lxqt-build-tools-0.13.0

User Notes: https://wiki.linuxfromscratch.org/blfs/wiki/lxqt-themes

Installation of lxqt-themes

Install lxqt-themes by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..       &&

make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: None
Installed Libraries: None
Installed Directories: /usr/share/lxqt/{graphics,themes,palettes,wallpapers}

lxqt-qtplugin-1.3.0

Introduction to lxqt-qtplugin

The lxqt-qtplugin package provides an LXQt Qt platform integration plugin.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

lxqt-qtplugin Dependencies

Required

liblxqt-1.3.0 and libdbusmenu-qt-0.9.3+16.04.20160218

Installation of lxqt-qtplugin

Install lxqt-qtplugin by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..       &&

make

This package does not come with a test suite.

Now, as the root user:

make install

Configuring lxqt-qtplugin

Configuration Information

To use the plugin in Qt 5, the environment variable QT_QPA_PLATFORMTHEME must be set to lxqt. One way to do that is to issue as the root user:

cat >> /etc/profile.d/lxqt.sh << "EOF"
# Begin lxqt-qtplugin configuration

export QT_QPA_PLATFORMTHEME=lxqt

# End lxqt-qtplugin configuration
EOF

Contents

Installed Programs: None
Installed Library: libqtlxqt.so (in $QT5DIR/plugins/platformthemes)
Installed Directory: $QT5DIR/plugins/platformthemes

Short Descriptions

libqtlxqt.so

contains the LXQt QT plugin loader

lxqt-about-1.3.0

Introduction to lxqt-about

The lxqt-about package provides the standalone LXQt About dialog.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

lxqt-about Dependencies

Required

liblxqt-1.3.0

Installation of lxqt-about

Install lxqt-about by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..       &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: lxqt-about
Installed Libraries: None
Installed Directory: None

Short Descriptions

lxqt-about

is the LXQt About dialog

lxqt-admin-1.3.0

Introduction to lxqt-admin

The lxqt-admin package provides two GUI tools to adjust settings of the operating system LXQt is running on.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

lxqt-admin Dependencies

Required

liblxqt-1.3.0 and Polkit-123

Installation of lxqt-admin

Install lxqt-admin by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..       &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: lxqt-admin-time, lxqt-admin-user, and lxqt-admin-user-helper
Installed Libraries: None
Installed Directory: None

Short Descriptions

lxqt-admin-time

is a GUI to adjust the current time and date

lxqt-admin-user

is a GUI to manage users and groups

lxqt-openssh-askpass-1.3.0

Introduction to lxqt-openssh-askpass

The lxqt-openssh-askpass package is a GUI to query credentials on behalf of other programs.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

lxqt-openssh-askpass Dependencies

Required

liblxqt-1.3.0

Installation of lxqt-openssh-askpass

Install lxqt-openssh-askpass by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..       &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: lxqt-openssh-askpass
Installed Libraries: None
Installed Directories: None

Short Descriptions

lxqt-config-openssh-askpass

queries a user for credentials on behalf of another program

lxqt-sudo-1.3.0

Introduction to lxqt-sudo

The lxqt-sudo package is a graphical front end to sudo and su respectively.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

lxqt-sudo Dependencies

Required

liblxqt-1.3.0

Installation of lxqt-sudo

Install lxqt-sudo by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..       &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: lxdoas, lxqt-sudo, lxsu, and lxsudo
Installed Libraries: None
Installed Directories: None

Short Descriptions

lxdoas

is a graphical frontend for doas

lxqt-sudo

is a graphical frontend for sudo

lxsudo

is a graphical frontend for sudo

lxsu

is a graphical frontend for su

lxqt-config-1.3.0

Introduction to lxqt-config

The lxqt-config package provides the LXQt Configuration Center.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

lxqt-config Dependencies

Required

liblxqt-1.3.0, (kconfig-5.27.7 for lxqt and libkscreen-5.27.7 for lxqt) or Plasma-5.27.7, and xorg-libinput-1.3.0

Installation of lxqt-config

Install lxqt-config by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..                          &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: lxqt-config, lxqt-config-appearance, lxqt-config-brightness, lxqt-config-file-associations, lxqt-config-input, lxqt-config-locale, and lxqt-config-monitor
Installed Library: liblxqt-config-cursor.so
Installed Directories: /usr/lib/lxqt-config

Short Descriptions

lxqt-config

is the LXQt Configuration Center

lxqt-config-appearance

is used to change system themes, icon themes, and fonts used by applications in an LXQt session

lxqt-config-brightness

configures the brightness setting of a monitor

lxqt-config-file-associations

is used to associate filetypes with programs

lxqt-config-input

is used to configure input devices, setting options such as the mouse speed, the cursor, the keyboard speed, and the keyboard layout

lxqt-config-locale

configures the locale used in LXQt sessions

lxqt-config-monitor

is a graphical frontend to xrandr that configures monitors on a system

liblxqt-config-cursor.so

contains the liblxqt-config-cursor API functions

obconf-qt-0.16.2

Introduction to obconf-qt

The obconf-qt package is a Qt-based configuration tool for Openbox.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

obconf-qt Dependencies

Required

hicolor-icon-theme-0.17, liblxqt-1.3.0, and openbox-3.6.1

Installation of obconf-qt

Install obconf-qt by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..                          &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: obconf-qt
Installed Libraries: None
Installed Directory: None

Short Descriptions

obconf-qt

is a Qt-based configuration tool for Openbox

lxqt-globalkeys-1.3.0

Introduction to lxqt-globalkeys

The lxqt-globalkeys package contains a daemon used to register global keyboard shortcuts as well as an editor for keyboard shortcuts.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

lxqt-globalkeys Dependencies

Required

liblxqt-1.3.0

Installation of lxqt-globalkeys

Install lxqt-globalkeys by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..                          &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: lxqt-config-globalkeyshortcuts and lxqt-globalkeysd
Installed Libraries: liblxqt-globalkeys.so and liblxqt-globalkeys-ui.so
Installed Directories: /usr/include/lxqt-globalkeys{,-ui} and /usr/share/cmake/lxqt-globalkeys{,-ui}

Short Descriptions

lxqt-config-globalkeyshortcuts

is an editor for keyboard shortcuts

lxqt-globalkeysd

is the global keyboard shortcut daemon

lxqt-globalkeys.so

contains the lxqt-globalkeys API functions

liblxqt-globalkeys-ui.so

contains the liblxqt-globalkeys-ui API functions

lxqt-policykit-1.3.0

Introduction to lxqt-policykit

The lxqt-policykit package is the LXQt PolicyKit agent.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

lxqt-policykit Dependencies

Required

liblxqt-1.3.0 and polkit-qt-0.114.0

Installation of lxqt-policykit

Install lxqt-policykit by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..                          &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: lxqt-policykit-agent
Installed Libraries: None
Installed Directory: /usr/share/lxqt/translations/lxqt-policykit-agent

Short Descriptions

lxqt-policykit-agent

is the LXQt PolicyKit agent

lxqt-session-1.3.0

Introduction to lxqt-session

The lxqt-session package contains the default session manager for LXQt.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

lxqt-session Dependencies

Required

liblxqt-1.3.0, (kwindowsystem-5.109.0 for lxqt or KDE Frameworks-5.109.0), qtxdg-tools-3.11.0, and Xdg-user-dirs-0.18

Installation of lxqt-session

Install lxqt-session by running the following commands:

sed -e '/TryExec/s|=|=/usr/bin/|' \
    -i xsession/lxqt.desktop.in &&

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..       &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

sed -e '/TryExec/s|=|='/usr'/bin/|' -i xsessions/lxqt.desktop.in: If you are using a display manager, the full path of the TryExec directive has to be given so that the LXQt desktop will appear in the sessions list.

Configuring lxqt-session

Window Managers other than openbox-3.6.1 may be used, e.g. Xfwm4-4.18.0. Please note that IceWM-3.4.1 is not a good substitute. Fluxbox does work, although in this context (with lxqt-config-1.3.0), openbox-3.6.1 is better. The configuration file /usr/share/lxqt/windowmanagers.conf comes with many examples of Window Managers and the ones which are installed will appear in a drop down list of lxqt-config-session. For the ones not included in /usr/share/lxqt/windowmanagers.conf, you can use lxqt-config-session's "search" button, e.g. for Fluxbox-1.3.7, navigating through the file system until you can choose fluxbox.

Contents

Installed Programs: lxqt-config-session, lxqt-leave, lxqt-session, and startlxqt
Installed Libraries: None
Installed Directories: None

Short Descriptions

lxqt-config-session

is a GUI configuration tool for lxqt-session

lxqt-leave

is a graphical dialog to terminate the session

lxqt-session

is a lightweight X session manager

startlxqt

is used to start the desktop session for LXQt

pcmanfm-qt-1.3.0

Introduction to pcmanfm-qt

The pcmanfm-qt is a file manager and desktop icon manager (a Qt port of pcmanfm and libfm).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

pcmanfm-qt Dependencies

Required

liblxqt-1.3.0, libfm-qt-1.3.0, and lxqt-menu-data-20230619

Recommended

Installation of pcmanfm-qt

Install pcmanfm-qt by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..       &&
make

This package does not come with a test suite.

Now, as the root user:

make install

To make pcmanfm-qt easier to find in menus, adjust the .desktop file. Again, as the root user:

sed -e '/Categories=/s/=/=System;FileTools;/' \
    -e '/Name=/s/=.*/=File Manager PCManFM-Qt'/ \
    -i /usr/share/applications/pcmanfm-qt.desktop

Contents

Installed Program: pcmanfm-qt
Installed Library: None
Installed Directories: /usr/share/pcmanfm-qt

Short Descriptions

pcmanfm-qt

is a file manager and desktop icon manager

lxqt-panel-1.3.0

Introduction to lxqt-panel

The lxqt-panel package contains a lightweight X11 desktop panel.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

lxqt-panel Dependencies

Required

libdbusmenu-qt-0.9.3+16.04.20160218, liblxqt-1.3.0, lxqt-globalkeys-1.3.0, lxqt-menu-data-20230619, (solid-5.109.0 for lxqt or KDE Frameworks-5.109.0), and menu-cache-1.1.0

Recommended

Installation of lxqt-panel

If KDE Frameworks-5.109.0 was not installed in /usr, help the code find some headers that it needs:

export CXXFLAGS+="-I $KF5_PREFIX/include"
export CFLAGS+="-I $KF5_PREFIX/include"

Install lxqt-panel by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..                          &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

-D<plugin>_PLUGIN=no: Disable a <plugin>, where <plugin> may be CLOCK, COLORPICKER, CPULOAD, DIRECTORYMENU, DESKTOPSWITCH, KBINDICATOR, MAINMENU, MOUNT, QUICKLAUNCH, SENSORS, SHOWDESKTOP, NETWORKMONITOR, SYSSTAT, TASKBAR, STATUSNOTIFIER, TRAY, VOLUME, WORLDCLOCK, or SPACER

Contents

Installed Program: lxqt-panel
Installed Libraries: several plugins under /usr/lib/lxqt-panel
Installed Directories: /usr/lib/lxqt-panel, /usr/share/lxqt/panel, and /usr/share/lxqt/panel

Short Descriptions

lxqt-panel

is a lightweight Qt5 based panel for the LXQt Desktop

lxqt-powermanagement-1.3.0

Introduction to lxqt-powermanagement

The lxqt-powermanagement package provides the power management module for LXQt.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

lxqt-powermanagement Dependencies

Required

liblxqt-1.3.0, (kidletime-5.109.0 for lxqt or or KDE Frameworks-5.109.0), and UPower-1.90.2

Installation of lxqt-powermanagement

Install lxqt-powermanagement by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..                          &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: lxqt-config-powermanagement and lxqt-powermanagement
Installed Libraries: None
Installed Directories: None

Short Descriptions

lxqt-config-powermanagement

is the lxqt-powermanagement GUI configuration tool

lxqt-powermanagement

is the LXQt power management module

lxqt-runner-1.3.0

Introduction to lxqt-runner

The lxqt-runner package provides a tool used to launch programs quickly by typing their names.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

lxqt-runner Dependencies

Required

lxqt-globalkeys-1.3.0 and muparser-2.3.4

Installation of lxqt-runner

Install lxqt-runner by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..                          &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Using lxqt-runner

To use lxqt-runner, simultaneously press the Alt-F2 keys. A dialog window appears in the top center of the screen. When you start typing a command, a list of possible matches appears and changes as you keep typing.

Contents

Installed Program: lxqt-runner
Installed Libraries: None
Installed Directories: None

Short Descriptions

lxqt-runner

launches a graphical dialog box for quickly running a program

LXQt Desktop Final Instructions

Post-Install Instructions

Please follow these instructions before starting LXQt for the first time.

Dependencies to Start LXQt

Required

openbox-3.6.1, or another window manager, such as Xfwm4-4.18.0, or kwin from Plasma-5.27.7. Note that IceWM-3.4.1 is not suitable for LXQt.

Recommended
Optional

lightdm-1.32.0 or another Display Manager, e.g. sddm-0.20.0, and XScreenSaver-6.06

Final Configuration

LXQt Final Database Updates

The desktop databases need to be created or updated at this point. Run the following commands as the root user:

ldconfig                             &&
update-mime-database /usr/share/mime &&
xdg-icon-resource forceupdate        &&
update-desktop-database -q

Starting LXQt

You can start LXQt from a TTY, using xinit-1.4.2, or by using a graphical display manager such as lightdm-1.32.0.

To start LXQt using xinit-1.4.2, run the following commands:

cat > ~/.xinitrc << "EOF"
exec startlxqt
EOF

startx

The X session starts on the first unused virtual terminal, normally vt1. You can switch to another vtn by simultaneously pressing the keys Ctrl-Alt-Fn (n=2, 3, ...). To switch back to the X session, normally started at vt1, use Ctrl-Alt-F1. The vt where the command startx was executed will display many messages, including X starting messages, applications automatically started with the session, and eventually, some warning and error messages, but these are hidden by the graphical interface. You may prefer to redirect those messages to a log file, which can be used for debugging purposes. This can be done starting X with:

startx &> ~/.x-session-errors

Initial Configuration

When LXQt first starts, it will ask you for the window manager to use. To start, the BLFS editors recommend using openbox. At this point both the background and the panel will be black. Right clicking on the background will bring up a menu and selecting "Desktop Preferences" will allow you to change the background color or set a background image.

The panel will be at the bottom of the screen. Right clicking on the panel will bring up a menu that will allow you to customize the panel including adding widgets and setting the background color. The BLFS editors recommend installing, at a minimum, the Application Manager and Task Manager widgets.

After LXQt has started for the first time, the BLFS editors recommend going through the settings presented in the LXQt Configuration Center, which can be found under LXQt Settings in the Preferences menu of the application launcher.

Note

The user configuration files will be created in the directory $HOME/.config/lxqt/. To get widget icons to display properly, the lxqt.conf file may need to be manually edited to include the line "icon_theme=oxygen".

Chapter 40. LXQt Applications

This is a small collection of optional applications that add extra capabilities to the LXQt desktop.

lximage-qt-1.3.0

Introduction to lximage-qt

The lximage-qt package contains a lightweight image viewer and screenshot program.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

lximage-qt Dependencies

Required

libfm-qt-1.3.0

Installation of lximage-qt

Install lximage-qt by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_BUILD_TYPE=Release  \
      -DCMAKE_INSTALL_PREFIX=/usr \
      ..       &&

make

This package does not come with a test suite.

Now, as the root user:

make install

If you have xdg-utils-1.1.3 installed, as the root user, run xdg-icon-resource forceupdate --theme hicolor.

Contents

Installed Program: lximage-qt
Installed Libraries: None
Installed Directory: None

Short Descriptions

lximage-qt

is a lightweight image viewer and screenshot program. There is a menu entry in Utilities for the screenshot program. From the command line, you can obtain a full screen or window shot by running lximage-qt --screenshot

lxqt-archiver-0.8.0

Introduction to lxqt-archiver

The lxqt-archiver package is a simple and lightweight desktop-agnostic Qt file archiver.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

lxqt-archiver Dependencies

Required

liblxqt-1.3.0 and JSON-GLib-1.6.6

Installation of lxqt-archiver

Install lxqt-archiver by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_BUILD_TYPE=Release  \
      -DCMAKE_INSTALL_PREFIX=/usr \
      ..       &&

make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: lxqt-archiver
Installed Libraries: None
Installed Directories: None

Short Descriptions

lxqt-archiver

is a Qt-based file archiver

lxqt-notificationd-1.3.0

Introduction to lxqt-notificationd

The lxqt-notificationd package is the LXQt notification daemon.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

lxqt-notificationd Dependencies

Required

liblxqt-1.3.0

Installation of lxqt-notificationd

Install lxqt-notificationd by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_BUILD_TYPE=Release  \
      -DCMAKE_INSTALL_PREFIX=/usr \
      ..       &&

make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: lxqt-config-notificationd and lxqt-notificationd
Installed Libraries: None
Installed Directories: /usr/share/lxqt/translations/lxqt-config-notificationd and /usr/share/lxqt/translations/lxqt-notificationd

Short Descriptions

lxqt-config-notificationd

is the lxqt-notificationd GUI configuration tool

lxqt-notificationd

is the LXQt notification daemon

pavucontrol-qt-1.3.0

Introduction to pavucontrol-qt

pavucontrol-qt is the Qt port of the volume control utility pavucontrol, which is used to adjust audio levels in Pulseaudio. It is desktop environment agnostic.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

pavucontrol-qt Dependencies

Required

liblxqt-1.3.0 and PulseAudio-16.1 (built with GLib-2.76.4 support)

Installation of pavucontrol-qt

Install pavucontrol-qt by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_BUILD_TYPE=Release  \
      -DCMAKE_INSTALL_PREFIX=/usr \
      ..       &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: pavucontrol-qt
Installed Libraries: None
Installed Directory: None

Short Descriptions

pavucontrol-qt

is a Qt based GUI configuration tool for sound settings using pulseaudio

qps-2.7.0

Introduction to qps

The qps package contains a Qt process manager.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

qps Dependencies

Required

liblxqt-1.3.0

Installation of qps

Install qps by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_BUILD_TYPE=Release  \
      -DCMAKE_INSTALL_PREFIX=/usr \
      ..       &&

make

This package does not come with a test suite.

Now, as the root user:

make install

If you have xdg-utils-1.1.3 installed, as the root user, run xdg-icon-resource forceupdate --theme hicolor.

Contents

Installed Program: qps
Installed Libraries: None
Installed Directory: None

Short Descriptions

qps

is a Qt-based process manager

qtermwidget-1.3.0

Introduction to qtermwidget

As the name suggests, the qtermwidget package is a terminal widget for Qt.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

qtermwidget Dependencies

Required

lxqt-build-tools-0.13.0

User Notes: https://wiki.linuxfromscratch.org/blfs/wiki/qtermwidget

Installation of qtermwidget

Install qtermwidget by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..       &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: None
Installed Libraries: libqtermwidget5.so
Installed Directories: /usr/include/qtermwidget5, /usr/share/lib/cmake/qtermwidget5, and /usr/share/qtermwidget5

Short Descriptions

libqtermwidget5.so

provides a terminal widget for Qt5

qterminal-1.3.0

Introduction to qterminal

The qterminal package contains a Qt widget based terminal emulator for Qt with support for multiple tabs.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

qterminal Dependencies

Required

qtermwidget-1.3.0

Installation of qterminal

Install qterminal by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..       &&

make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: qterminal
Installed Libraries: None
Installed Directories: /usr/share/qterminal

Short Descriptions

qterminal

is a Qt based lightweight terminal emulator

screengrab-2.6.0

Introduction to screengrab

The screengrab package is a cross-platform tool for making screenshots quickly.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

screengrab Dependencies

Required

(kwindowsystem-5.109.0 for lxqt or KDE Frameworks-5.109.0), and libqtxdg-3.11.0

Installation of screengrab

If KDE Frameworks-5.109.0 was not installed in /usr, help the code find some headers that it needs:

export CXXFLAGS+="-I $KF5_PREFIX/include"
export CFLAGS+="-I $KF5_PREFIX/include"

Install screengrab by running the following commands:

mkdir -v build &&
cd       build &&

cmake -DCMAKE_BUILD_TYPE=Release  \
      -DCMAKE_INSTALL_PREFIX=/usr \
      ..       &&

make

This package does not come with a test suite.

Now, as the root user:

make install

If you have xdg-utils-1.1.3 installed, as the root user, run xdg-icon-resource forceupdate --theme hicolor.

Contents

Installed Program: screengrab
Installed Libraries: None
Installed Directory: None

Short Descriptions

screengrab

is a cross platform tool for creating screenshots quickly

Part XII. X Software

Chapter 41. Office Programs

This chapter is a collection of programs that are useful for viewing or editing office documents. Some specialise in doing one thing (such as word processing or manipulating a spreadsheet). LibreOffice is a suite of programs that can manipulate many different formats including powerpoint presentations.

AbiWord-3.0.5

Introduction to AbiWord

AbiWord is a word processor which is useful for writing reports, letters and other formatted documents.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

AbiWord Dependencies

Required

Boost-1.83.0, cURL-8.2.1, FriBidi-1.0.13, GOffice-0.10.55, and wv-1.2.9

Recommended
Optional

dbus-glib-0.112, evolution-data-server-3.48.4, gobject-introspection-1.76.1, libchamplain-0.12.21, libgcrypt-1.10.2, libical-3.0.16, libsoup-2.74.3, Redland-1.0.17, telepathy-glib-0.24.2, Valgrind-3.21.0. Aiksaurus, GtkMathView, libwmf, libwpd, libwpg, libwps, Link Grammar Parser, Loudmouth, OTS, and Psiconv

Note

To enable many of the optional dependencies, review the information from ./configure --help for the necessary switches you must pass to the configure script.

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/abiword

Installation of AbiWord

Install AbiWord by running the following commands:

sed -e "s/free_suggestions/free_string_list/" \
    -e "s/_to_personal//"                     \
    -e "s/in_session/added/"                  \
    -i src/af/xap/xp/enchant_checker.cpp      &&

./configure --prefix=/usr &&
make

This program does not come with a functional test suite.

Now, as the root user:

make install

Note

In order to install the local help files, a graphics session is recommended.

If you wish to install the local help files, untar and build them first:

Note

The current version of the docs expands to abiword-docs-3.0.1 and not the expected abiword-docs-3.0.2.

tar -xf ../abiword-docs-3.0.2.tar.gz &&
cd abiword-docs-3.0.1                &&
./configure --prefix=/usr            &&
make

and then, as the root user:

make install

Command Explanations

sed ...: This command corrects the source for changes in the dependency enchant-2.5.0.

--enable-plugins="collab openxml goffice grammar": Build some or all plugins. The openxml plugin enables Abiword to open some .docx files. The grammar plugin requires Link Grammar Parser

Configuring AbiWord

Config File

~/.AbiSuite/templates/normal.awt

Configuration Information

Choose the right template for your language and locale from the list produced by the following command:

ls /usr/share/abiword-3.0/templates

Create the folder ~/.AbiSuite/templates then copy the normal.awt you want into it:

install -v -m750 -d ~/.AbiSuite/templates &&
install -v -m640    /usr/share/abiword-3.0/templates/normal.awt-<lang> \
                    ~/.AbiSuite/templates/normal.awt

Change <lang> by the above command to fit the name of the file you want.

If you are using multiple languages, you may need to edit the template to use a font with greater coverage (e.g. one of the Dejavu fonts, because Abiword does not use fontconfig and can only display glyphs that are provided in the chosen font.

If you have desktop-file-utils-0.26 installed, you should run the update-desktop-database command to update the mimeinfo cache and allow the Help system to work.

If you have xdg-utils-1.1.3 installed, you should run the xdg-icon-resource forceupdate --theme hicolor command, for the installed icon to be displayed in the menu item.

Contents

Installed Program: abiword
Installed Library: libabiword-3.0.so
Installed Directories: /usr/include/abiword-3.0, /usr/lib/abiword-3.0, and /usr/share/abiword-3.0

Short Descriptions

abiword

is the word processor, a wrapper for the functions in libabiword-3.0 - it can also be used on the command line, see man 1 abiword

libabiword-3.0.so

provides functions to access MS Word documents

Gnumeric-1.12.55

Introduction to Gnumeric

The Gnumeric package contains a spreadsheet program which is useful for mathematical analysis.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Gnumeric Dependencies

Required

GOffice-0.10.55 and itstool-2.0.7

Recommended Runtime
Optional

DConf-0.40.0 (to prevent some test failures), gobject-introspection-1.76.1, PyGObject-3.44.1, Valgrind-3.21.0 (for some tests), dblatex (for PDF docs), libgda, Mono, pxlib, and Psiconv

Installation of Gnumeric

Install Gnumeric by running the following commands:

./configure --prefix=/usr  &&
make

This package must be installed before the test suite is run.

Now, as the root user:

make install

To run the tests, issue make check. Tests should be run from an active X session, and DConf-0.40.0 should be installed to prevent some failures. Three tests are known to fail related to valgrind.

Command Explanations

--enable-pdfdocs: Use this switch if you have installed dblatex and wish to create PDF docs.

Contents

Installed Programs: gnumeric (symlink), gnumeric-1.12.55, ssconvert, ssdiff, ssgrep, and ssindex
Installed Libraries: libspreadsheet.so
Installed Directories: /usr/include/libspreadsheet-1.12, /usr/lib/gnumeric, /usr/lib/goffice/0.10/plugins/gnumeric, /usr/share/gnumeric, and /usr/share/help/{C,cs,de,es}/gnumeric

Short Descriptions

gnumeric

is a symlink to gnumeric-1.12.55

gnumeric-1.12.55

is GNOME's spreadsheet application

ssconvert

is a command line utility to convert spreadsheet files between various spreadsheet file formats

ssdiff

is a command line utility to compare two spreadsheets

ssgrep

is a command line utility to search spreadsheets for strings

ssindex

is a command line utility to generate index data for spreadsheet files

libspreadsheet.so

contains the gnumeric API functions

LibreOffice-7.6.0

Introduction to LibreOffice

LibreOffice is a full-featured office suite. It is largely compatible with Microsoft Office and is descended from OpenOffice.org.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Core Download: https://download.documentfoundation.org/libreoffice/src/7.6.0/libreoffice-7.6.0.3.tar.xz

  • Core Download MD5 sum: b6994286fa3c274d1beac33aca80c442

  • Core Download size: 267 MB

  • Estimated disk space required: 10 GB including the additional files if downloaded during the build (727 MB installed). Installing the whole set of languages requires more than 25 GB (around 3 GB installed)

  • Estimated build time: 40 SBU with parallelism=8 (will vary due to download time)

Additional Downloads

Note

Around 80 smallish tarballs and zip files will be downloaded during the build. The download time will vary with the local internet speed and server load. The download time is about 3 minutes on a fiber connection and probably not much more than 10 minutes on an ADSL connection. If you have not downloaded one or more of the following, they will also be downloaded during the build.

LibreOffice Dependencies

Required

Archive-Zip-1.68, UnZip-6.0, Wget-1.21.4, Which-2.21, and Zip-3.0

Note

An Internet connection is needed for building this package.

Recommended

Note

Most of these packages are recommended because if they're not installed, the build process will compile and install its own (often older) version, with the side effect of increasing build and installed disk space and build time.

Optional

Avahi-0.8, BlueZ-5.68, DConf-0.40.0, desktop-file-utils-0.26, Doxygen-1.9.7 (not relevant if using --disable-odk), evolution-data-server-3.48.4, GDB-13.2, GnuTLS-3.8.1, KDE Frameworks-5.109.0, libpaper-2.1.1, MariaDB-10.11.4 or MySQL, MIT Kerberos V5-1.21.2, NASM-2.16.01, (Qt-5.15.10 or qt-alternate-5.15.10), SANE-1.0.32, telepathy-glib-0.24.2, Valgrind-3.21.0, VLC-3.0.18, Apache Commons Codec, Apache Commons HttpClient, Apache Commons Lang, Apache Commons Logging, BeanShell, box2d, CoinMP, Cppunit, Firebird, glyphy, Gnome VFS, hamcrest, Hunspell, Hyphen, iwyu, junit4, libabw, libcdr, libcmis, libebook, libepubgen, libetonyek, libexttextcat, libfreehand, liblangtag, libmspub, libmwaw, libnumbertext, libodfgen, libpagemaker, libqrcodegen, libqxp, librevenge (WordPerfect Document importer), libstaroffice, libvisio, libwpd, libwpg, libwps, libzmf, lp_solve, mdds, MyThes, odfvalidator, officeotron, OpenCOLLADA, Orcus, SystemTap, and VIGRA

There are many optional dependencies not listed here. They can be found in download.lst (source directory).

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/libreoffice

Installation of LibreOffice

Important

Unlike the other packages, we assume that you have not yet unpacked the package. This is because the --no-overwrite-dir switch is needed in case you unpack as the root user.

tar -xf libreoffice-7.6.0.3.tar.xz --no-overwrite-dir &&
cd libreoffice-7.6.0.3

If you have downloaded the dictionaries, help and translations tarballs, create symlinks to them from the source directory so they won't get downloaded again:

install -dm755 external/tarballs &&
ln -sv ../../../libreoffice-dictionaries-7.6.0.3.tar.xz external/tarballs/ &&
ln -sv ../../../libreoffice-help-7.6.0.3.tar.xz         external/tarballs/ &&
ln -sv ../../../libreoffice-translations-7.6.0.3.tar.xz external/tarballs/

The instructions in the package unpack some tarballs into a location it cannot find later. Create some symlinks to help the build system out:

ln -sv src/libreoffice-help-7.6.0.3/helpcontent2/ &&
ln -sv src/libreoffice-dictionaries-7.6.0.3/dictionaries/ &&
ln -sv src/libreoffice-translations-7.6.0.3/translations/

Note

During the build process, some packages will be downloaded (including the ones listed as recommended and optional dependencies) if they are not present on the system. Because of this, build time may vary from the published time more than usual.

Due to the large size of the package, you may prefer to install it in /opt, instead of /usr. Depending on your choice, replace <PREFIX> by /usr or by /opt/libreoffice-7.6.0.3:

export LO_PREFIX=<PREFIX>

Locales "fr" and "en-GB", you will find below, are just examples; you should change them to suit your needs - you might want to read the "Command Explanations", further below, before proceeding.

Note

If you set the ACLOCAL environment variable to support installing Xorg in /opt, you will need to unset it for this package.

If you are building on a 32 bit machine, CFLAGS is set to -Os, which breaks the build. Prevent this by issuing:

case $(uname -m) in
   i?86) sed /-Os/d -i solenv/gbuild/platform/LINUX_INTEL_GCC.mk ;;
esac

If you decide to pass the --disable-java to configure, fix an issue that causes the build to fail:

sed -i '940i #if HAVE_FEATURE_JAVA' cui/source/options/optjava.cxx &&
sed -i '966i #endif'                cui/source/options/optjava.cxx

Prepare LibreOffice for compilation by running the following commands:

sed -e "/gzip -f/d"   \
    -e "s|.1.gz|.1|g" \
    -i bin/distro-install-desktop-integration &&

sed -e "/distro-install-file-lists/d" -i Makefile.in &&

./autogen.sh --prefix=$LO_PREFIX         \
             --sysconfdir=/etc           \
             --with-vendor=BLFS          \
             --with-lang='fr en-GB'      \
             --with-help                 \
             --with-myspell-dicts        \
             --without-junit             \
             --without-system-dicts      \
             --disable-dconf             \
             --disable-odk               \
             --enable-release-build=yes  \
             --enable-python=system      \
             --with-jdk-home=/opt/jdk    \
             --with-system-clucene       \
             --with-system-curl          \
             --with-system-epoxy         \
             --with-system-expat         \
             --with-system-glm           \
             --with-system-gpgmepp       \
             --with-system-graphite      \
             --with-system-harfbuzz      \
             --with-system-icu           \
             --with-system-jpeg          \
             --with-system-lcms2         \
             --with-system-libatomic_ops \
             --with-system-libpng        \
             --with-system-libxml        \
             --with-system-nss           \
             --with-system-odbc          \
             --with-system-openldap      \
             --with-system-openssl       \
             --with-system-poppler       \
             --with-system-postgresql    \
             --with-system-redland       \
             --with-system-libtiff       \
             --with-system-libwebp       \
             --with-system-zlib

Build the package:

make build

Now, as the root user:

make distro-pack-install

If installed in /opt/libreoffice-7.6.0.3 some additional steps are necessary. Issue the following commands as the root user:

if [ "$LO_PREFIX" != "/usr" ]; then

  # This symlink is necessary for the desktop menu entries
  ln -svf $LO_PREFIX/lib/libreoffice/program/soffice /usr/bin/libreoffice &&

  # Set up a generic location independent of version number
  ln -sfv libreoffice-7.6.0.3 /opt/libreoffice

  # Icons
  mkdir -vp /usr/share/pixmaps
  for i in $LO_PREFIX/share/icons/hicolor/32x32/apps/*; do
    ln -svf $i /usr/share/pixmaps
  done &&

  # Desktop menu entries
  for i in $LO_PREFIX/lib/libreoffice/share/xdg/*; do
    ln -svf $i /usr/share/applications/libreoffice-$(basename $i)
  done &&

  # Man pages
  for i in $LO_PREFIX/share/man/man1/*; do
    ln -svf $i /usr/share/man/man1/
  done

  unset i
fi

If you have installed desktop-file-utils-0.26, and you wish to update the MIME database, issue, as the root user:

update-desktop-database

The suite and main modules can be started from the menu. From a terminal, the suite can be started with the libreoffice command and the modules with the libreoffice --<module> command, respectively, where <module> is one of base, calc, draw, impress, math, web, or writer. Modules cannot be started using their shell starting script names (see "Installed Programs", below), if LO_PREFIX is other than /usr, unless the $LO_PREFIX/bin directory is appended to the PATH.

Command Explanations

sed -e ...: The first sed prevents compression of the manual pages and the second one prevents the install from failing.

--with-vendor=BLFS: This switch sets BLFS as the vendor which is mentioned when you click "About" from the Help menu on the toolbar.

--with-lang='fr en-GB': This switch sets what languages to support. To list several languages, separate them with a space. For all languages, use --with-lang=ALL. Note that the translations file is not needed and won't be downloaded if using only en-US as a language.

Note

For a list of the available languages, look in solenv/inc/langlist.mk.

--with-help: Without this switch, the help files are not built.

--with-jdk-home=/opt/jdk: This parameter will silence a warning that the configure script attempted to find JAVA_HOME automatically (even though that is passed in the environment). Omit this if you disabled java.

--with-myspell-dicts: This switch adds myspell dictionaries to the LibreOffice installation set.

--disable-dconf: This switch disables compiling LibreOffice with the GNOME DConf configuration system support.

--without-junit: This switch disables the tests for the deprecated HSQLDB driver which is written in Java.

--without-system-dicts: This switch disables the use of dictionaries from system paths so that the ones installed by this package are used.

--disable-odk: This switch disables installing the office development kit. Remove if you want to develop a LibreOffice based application.

--enable-release-build=yes: This switch enables a Release Build. LibreOffice can be built as a Release Build or as a Developer Build, because their default installation paths and user profile paths are different. Developer Build displays the words "Dev" and "Beta" in several places (e.g, menu and splash screen).

--enable-python=system: This switch tells LibreOffice to use the system installed Python 3 instead of the bundled one.

--with-system-*: These switches prevent LibreOffice from trying to compile its own versions of these dependencies. If you've not installed some of the dependencies, remove the corresponding switches.

make distro-pack-install: This does a normal install, but if you add a DESTDIR environment variable it will also install a lot of (text) gid_Module_* files in the DESTDIR, to help distributions which want to break the package into parts.

--with-parallelism=<count>: This switch tells LibreOffice to use <count> CPU cores to compile in parallel. (Do not include literal angle brackets.) The default is to use all available cores on the system.

--disable-cups: Use this switch if you don't need printing support.

--disable-dbus: Use this switch if you've not installed D-Bus-1.8.0 or later. It also disables Bluetooth support and font install via PackageKit.

--disable-firebird-sdbc: By default, the ability to connect to a firebird database is enabled. Add this switch if you do not need that feature.

--disable-gstreamer-1-0: Use this switch if you have not installed gst-plugins-base-1.22.5.

--disable-postgresql-sdbc: This switch disables compiling LibreOffice with the ability to connect to a PostgreSQL database. Use it if you have not installed PostgreSQL and you do not want LibreOffice to compile its bundled copy.

--disable-skia: Use Cairo-1.17.6 for rendering instead of skia.

--enable-gtk3-kde5: This switch allows the Visual Class Library, which is responsible for widgets, to be built with KF5 file dialogs if GTK+-3, Qt5 and Plasma are all available.

--enable-lto: This switch will enable Link Time Optimization, which results in slightly smaller libraries (about 40 MB). This is said to make LibreOffice programs load faster (and possibly run faster, e.g. when recalculating a spreadsheet). On an 8-core machine with 16GB of memory, the difference in compile times was minimal, but an extra 2GB was used for the work files. On machines with fewer processors or a lack of memory, the compile might be much slower.

--without-java: This switch disables Java support in LibreOffice. Java is needed for the deprecated HSQLDB driver, which allows reading databases created by other programs or in earlier versions of libreoffice base. It is also needed for some optional user interface components.

--without-fonts: LibreOffice includes a number of third-party TrueType fonts. If you have already installed some or all of the same fonts, you may prefer to use the system versions.

--enable-kf5: Builds with KDE/Plasma integration. If (Qt-5.15.10 or qt-alternate-5.15.10) and/or KDE Frameworks-5.109.0 are not installed in /usr, the include and library directories must be specified in QT5INC, QT5LIB, KF5INC, and KF5LIB, respectively.

--enable-evolution2: Enables support for Evolution address books through Evolution Data Server. Note that Evolution Data Server must be installed for this feature to function.

--enable-qt5: This switch enables support for integration with Qt5 and the Qt5 theming engine. If (Qt-5.15.10 or qt-alternate-5.15.10) is not installed in /usr, the include and library directories must be specified in the QT5INC and QT5LIB environment variables.

Contents

Installed Programs: libreoffice, lobase, localc, lodraw, loffice, lofromtemplate, loimpress, lomath, loweb, lowriter, soffice and unopkg; several programs under $LO_PREFIX/lib/libreoffice/program
Installed Libraries: several libraries under $LO_PREFIX/lib/libreoffice/program
Installed Directory: $LO_PREFIX/lib/libreoffice

Short Descriptions

libreoffice (or soffice)

is the main libreofice suite (symlink to $LO_PREFIX/lib/libreoffice/program/soffice)

lobase

is the database manager module shell starting script

localc

is the spreadsheet module shell starting script

lodraw

is the vector graphics editor and diagramming tool module shell starting script

loimpress

is the (PowerPoint) presentations editor and displayer module shell starting script

lomath

is the mathematical formula editor module shell starting script

loweb

is the HTML editor module shell starting script

lowriter

is the word processor module shell starting script

unopkg

is a tool to manage LibreOffice extensions from the command line

Chapter 42. Graphical Web Browsers

This chapter contains a wonderful selection of browsers. We hope you can find one you enjoy using or give them each a trial run.

Epiphany-44.6

Introduction to Epiphany

Epiphany is a simple yet powerful GNOME web browser targeted at non-technical users. Its principles are simplicity and standards compliance.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Epiphany Dependencies

Required

Gcr-4.1.0, gnome-desktop-44.0, ISO Codes-4.15.0, JSON-GLib-1.6.6, libadwaita-1.3.4, libportal-0.6, Nettle-3.9.1, and WebKitGTK-2.41.91 (built with GTK-4)

Optional

Appstream-Glib

Runtime Dependencies

gnome-keyring-42.1 (for storing passwords) and Seahorse-43.0 (for managing stored passwords)

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/epiphany

Installation of Epiphany

Install Epiphany by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

Now, as the root user:

ninja install

Note

If you installed the package to your system using a DESTDIR method, /usr/share/glib-2.0/schemas/gschemas.compiled was not updated/created. Create (or update) the file using the following command as the root user:

glib-compile-schemas /usr/share/glib-2.0/schemas

One test would fail if this package is not installed, so it's better to run the test suite after installation. To test the results, issue LC_ALL=en_US.UTF-8 ninja test. The tests must be run from a graphical session.

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Program: epiphany
Installed Libraries: None
Installed Directories: /usr/{lib,libexec,share,share/help/*}/epiphany

Short Descriptions

epiphany

is a GNOME web browser based on the WebKit2 rendering engine

Falkon-23.08.0

Introduction to falkon

Falkon is a KDE web browser using the QtWebEngine rendering engine. It was previously known as QupZilla. It aims to be a lightweight web browser available through all major platforms.

Although falkon is now part of KDE, it can be installed without KDE (with the loss of kwallet functionality).

Warning

Falkon relies on QtWebEngine. That uses a forked copy of chromium, and is therefore vulnerable to many issues found there. The Qt developers have always preferred to make releases at the same time as the rest of Qt (rather than adding emergency fixes). Now that they are keen to move to Qt6, the 5.15.3 and later Qt-5.15 releases are initially only available to paying customers. QtWebEngine is something of an exception because of its LGPL licence, but getting the git sources (with the forked chromium submodule) to a point where they will successfully build on a current BLFS system can take a lot of effort. Be aware that future fixes for vulnerabilities might be very delayed, to the extent that you might wish to consider using a different browser.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

falkon Dependencies

Required

extra-cmake-modules-5.109.0, KDE Frameworks-5.109.0 (for karchive), and qtwebengine-5.15.15

Note

Strictly speaking, only karchive is required to build falkon, but several other packages in KF5 can be used if they are present. To build only karchive, download that package from the directory specified in KDE Frameworks-5.109.0 and use the build instructions on that page changing the $KF5_PREFIX to /usr.

Optional

gnome-keyring-42.1, PySide2, and Shiboken2

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/falkon

Installation of falkon

Install falkon by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      .. &&

make

To test the results, issue: make test. All tests should pass. If any fail, the full results will be in Testing/Temporary/LastTest.log.

Now, as the root user:

make install

Note

When upgrading this package, it is possible that the contents of the application will remain empty even though everything else appears to be working properly. In this case try removing ~/.cache/falkon and restarting the program.

If you have installed Pyside2 you will want to examine hellopython.py which is in the scripts/ directory, and perhaps copy it to your home directory.

Command Explanations

-DBUILD_TESTING=OFF: This will save a little time and space by not building the test programs, use this if you do not wish to run the test.

Contents

Installed Programs: falkon
Installed Library: libFalkonPrivate.so.3
Installed Directory: /usr/share/falkon

Short Descriptions

falkon

is a web browser which uses qtwebengine

libFalkonPrivate.so.3

contains functions used by falkon

Firefox-115.2.0esr

Introduction to Firefox

Firefox is a stand-alone browser based on the Mozilla codebase.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Note

The directory name is firefox-115.2.0

Extracting the tarball will reset the permissions of the current directory to 0755 if you have permission to do that. If you do this in a directory where the sticky bit is set, such as /tmp it will end with error messages:

tar: .: Cannot utime: Operation not permitted
tar: .: Cannot change mode to rwxr-xr-t: Operation not permitted
tar: Exiting with failure status due to previous errors

This does finish with non-zero status, but it does NOT mean there is a real problem. Do not untar as the root user in a directory where the sticky bit is set - that will unset it.

As with other large packages which use C++ (or rust), the SBU times to build this vary more widely than you might expect. The build times will increase significantly if your machine has to swap.

Although upstream prefer to use PulseAudio, for the moment Alsa can still be used. Both may need runtime configuration to get sound working.

Firefox Dependencies

Required

Cbindgen-0.24.3, dbus-glib-0.112, GTK+-3.24.38, libnotify-0.8.2, LLVM-16.0.5 (with clang, used for bindgen even if using gcc), nodejs-18.17.1, PulseAudio-16.1 (or alsa-lib-1.2.9 if you edit the mozconfig; now deprecated by mozilla), in either case please read the Configuration Information, Python-3.11.4 (rebuilt after installing SQLite-3.42.0), startup-notification-0.12, UnZip-6.0, yasm-1.3.0, and Zip-3.0

Recommended

Note

If you don't install recommended dependencies, then internal copies of those packages will be used. They might be tested to work, but they can be out of date or contain security holes.

Optional

cURL-8.2.1, Doxygen-1.9.7, FFmpeg-6.0 (runtime, to play mov, mp3 or mp4 files), liboauth-1.0.3, pciutils-3.10.0 (runtime), Valgrind-3.21.0, Wget-1.21.4, Wireless Tools-29, libproxy

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/firefox

Installation of Firefox

The configuration of Firefox is accomplished by creating a mozconfig file containing the desired configuration options. A default mozconfig is created below. To see the entire list of available configuration options (and an abbreviated description of some of them), issue ./mach configure -- --help | less. You may also wish to review the entire file and uncomment any other desired options. Create the file by issuing the following command:

cat > mozconfig << "EOF"
# If you have a multicore machine, all cores will be used by default.

# If you have installed (or will install) wireless-tools, and you wish
# to use geolocation web services, comment out this line
ac_add_options --disable-necko-wifi

# API Keys for geolocation APIs - necko-wifi (above) is required for MLS
# Uncomment the following line if you wish to use Mozilla Location Service
#ac_add_options --with-mozilla-api-keyfile=$PWD/mozilla-key

# Uncomment the following line if you wish to use Google's geolocation API
# (needed for use with saved maps with Google Maps)
#ac_add_options --with-google-location-service-api-keyfile=$PWD/google-key

# startup-notification is required since firefox-78

# Uncomment the following option if you have not installed PulseAudio and
# want to use alsa instead
#ac_add_options --enable-audio-backends=alsa

# Comment out following options if you have not installed
# recommended dependencies:
ac_add_options --with-system-icu
ac_add_options --with-system-libevent
ac_add_options --with-system-libvpx
ac_add_options --with-system-nspr
ac_add_options --with-system-nss
ac_add_options --with-system-webp

# Unlike with thunderbird, although using the gold linker can
# save four megabytes in the installed file it does not make
# the build faster.

# libdav1d (av1 decoder) requires nasm. Uncomment this if nasm
# has not been installed. Do not uncomment this if you have
# ffmpeg installed.
#ac_add_options --disable-av1

# You cannot distribute the binary if you do this
ac_add_options --enable-official-branding

# Stripping is now enabled by default.
# Uncomment these lines if you need to run a debugger:
#ac_add_options --disable-strip
#ac_add_options --disable-install-strip

# Disabling debug symbols makes the build much smaller and a little
# faster. Comment this if you need to run a debugger. Note: This is
# required for compilation on i686.
ac_add_options --disable-debug-symbols

# The elf-hack is reported to cause failed installs (after successful builds)
# on some machines. It is supposed to improve startup time and it shrinks
# libxul.so by a few MB - comment this if you know your machine is not affected.
ac_add_options --disable-elf-hack

# The BLFS editors recommend not changing anything below this line:
ac_add_options --prefix=/usr
ac_add_options --enable-application=browser
ac_add_options --disable-crashreporter
ac_add_options --disable-updater
# enabling the tests will use a lot more space and significantly
# increase the build time, for no obvious benefit.
ac_add_options --disable-tests

# The default level of optimization again produces a working build with gcc.
ac_add_options --enable-optimize

ac_add_options --enable-system-ffi
ac_add_options --enable-system-pixman

ac_add_options --with-system-jpeg
ac_add_options --with-system-png
ac_add_options --with-system-zlib

# Sandboxing works well on x86_64 but might cause issues on other
# platforms. If not on x86_64, e.g. i686, it is recommended to
# uncomment the following switch.
#ac_add_options --disable-sandbox

# Using sandboxed wasm libraries has been moved to all builds instead
# of only mozilla automation builds. It requires extra llvm packages
# and was reported to seriously slow the build. Disable it.
ac_add_options --without-wasm-sandboxed-libraries

# The following option unsets Telemetry Reporting. With the Addons Fiasco,
# Mozilla was found to be collecting user's data, including saved passwords and
# web form data, without users consent. Mozilla was also found shipping updates
# to systems without the user's knowledge or permission.
# As a result of this, use the following command to permanently disable
# telemetry reporting in Firefox.
unset MOZ_TELEMETRY_REPORTING

mk_add_options MOZ_OBJDIR=@TOPSRCDIR@/firefox-build-dir
EOF

Compile Firefox by issuing the following commands:

If the geolocation APIs are needed:

Note

The Google and Mozilla API Keys below are specific to LFS. If using these instructions for another distro, or if you intend to distribute binary copies of the software using these instructions, please obtain your own keys following the instructions located at https://www.chromium.org/developers/how-tos/api-keys and https://location.services.mozilla.com/api respectively.

echo "AIzaSyDxKL42zsPjbke5O8_rPVpVrLrJ8aeE9rQ" > google-key
echo "613364a7-9418-4c86-bcee-57e32fd70c23" > mozilla-key

Note

If you are compiling this package in chroot you must do two things. First, as the root user, ensure that /dev/shm is mounted. If you do not do this, the Python configuration will fail with a traceback report referencing /usr/lib/pythonN.N/multiprocessing/synchronize.py. Run:

mountpoint -q /dev/shm || mount -t tmpfs devshm /dev/shm

Second, either as the root user export the $SHELL environment variable using export SHELL=/bin/sh or else prepend SHELL=/bin/sh when running the ./mach commands.

Now invoke the Python mach script to compile the package.

export MACH_BUILD_PYTHON_NATIVE_PACKAGE_SOURCE=none &&
export MOZBUILD_STATE_PATH=${PWD}/mozbuild          &&
./mach configure                                    &&
./mach build

The mozconfig above disables the tests because they use a lot more time and disk space for no obvious benefit. If you have nevertheless enabled them, you can run the tests by executing ./mach gtest. This will require a network connection, and to be run from within an Xorg session - there is a popup dialog when it fails to connect to ALSA (that does not create a failed test). One or two tests will fail. To see the details of the failure(s) you will need to log the output from that command so that you can review it.

Now, as the root user:

MACH_BUILD_PYTHON_NATIVE_PACKAGE_SOURCE=none ./mach install

Empty the environment variables which were set above:

unset MACH_BUILD_PYTHON_NATIVE_PACKAGE_SOURCE MOZBUILD_STATE_PATH

Command Explanations

export MOZBUILD_STATE_PATH=${PWD}/mozbuild: The build is now supposed to tell you that it intends to create ~/.mozbuild, and offer you an option to press <ENTER> to accept this, or Ctrl-C to cancel and restart the build after specifying the directory. In practice, the message may not appear until after <ENTER> is keyed, i.e. the build stalls.

That directory is used for a (probably random) telemetry identifier. Creating this in the build directory, and deleting that after the installation, prevents it being used. If you wish to participate in telemetry, export MOZBUILD_STATE_PATH to point to its default directory and remove the entry from the mozconfig.

MACH_BUILD_PYTHON_NATIVE_PACKAGE_SOURCE=none: Use the system python to create a virtual environment for mach without downloading any python wheels nor using the system python modules. This prevents version mismatches between system modules and bundled ones.

./mach configure: This validates the supplied dependencies and the mozconfig.

./mach build --verbose: Use this alternative if you need details of which files are being compiled, together with any C or C++ flags being used. But do not add '--verbose' to the install command since it is not accepted there.

./mach build -jN: The build should, by default, use all the online CPU cores. If using all the cores causes the build to swap because you have insufficient memory, using fewer cores can be faster.

CC=gcc CXX=g++: BLFS used to prefer to use gcc and g++ instead of upstream's defaults of the clang programs. With the release of gcc-12 the build takes longer with gcc and g++, primarily because of extra warnings, and is bigger. Set these environment variables before you run the configure script if you wish to continue to use gcc, g++. Building with GCC on i?86 is currently broken.

Configuring Firefox

If you use a desktop environment like Gnome or KDE you may want to create a firefox.desktop file so that Firefox appears in the panel's menus. As the root user:

mkdir -pv /usr/share/applications &&
mkdir -pv /usr/share/pixmaps      &&

MIMETYPE="text/xml;text/mml;text/html;"                            &&
MIMETYPE+="application/xhtml+xml;application/vnd.mozilla.xul+xml;" &&
MIMETYPE+="x-scheme-handler/http;x-scheme-handler/https"           &&

cat > /usr/share/applications/firefox.desktop << EOF &&
[Desktop Entry]
Encoding=UTF-8
Name=Firefox Web Browser
Comment=Browse the World Wide Web
GenericName=Web Browser
Exec=firefox %u
Terminal=false
Type=Application
Icon=firefox
Categories=GNOME;GTK;Network;WebBrowser;
MimeType=$MIMETYPE
StartupNotify=true
EOF

unset MIMETYPE &&

ln -sfv /usr/lib/firefox/browser/chrome/icons/default/default128.png \
        /usr/share/pixmaps/firefox.png

Configuration Information

The application settings for firefox are accessible by keying about:config in the address bar.

Occasionally, getting working sound in firefox can be a problem. Although upstream prefers pulseaudio, on balance using Alsa may be easier.

If you enabled Alsa for sound, you may need to alter one variable to get working sound. If you run firefox from a terminal and try to play something with sound you might encounter error messages like:

Sandbox: seccomp sandbox violation: pid 3941, tid 4030, syscall 16, args 48 2147767296 139909894784796 0 0 0.

That was on x86_64, on i686 the syscall number is 54. To allow this syscall, in about:config change security.sandbox.content.syscall_whitelist to 16 (or 54 if using i686).

If you use pulseaudio in a Desktop Environment, it might already be started by that DE. But if it is not, although firefox-57 managed to start it, firefox-58 did not. If you run firefox from a terminal and this problem is present, trying to play sound will encounter error messages warning Can't get cubeb context!

The fix for this is to close firefox, start pulseaudio to check it does start (if not, read the information on Configuring in PulseAudio-16.1) and restart firefox to check it is working. If it now works, add the following to your ~/.xinitrc: pulseaudio --verbose --log-target=journald& (unfortunately, on some systems this does not work).

You may wish to use multiple profiles within firefox. To do that, invoke firefox as firefox --ProfileManager. You can also check which profile is currently in use from about:profiles.

Although WebRender (using the GPU for compositing) is not used by default, it now appears to work well on supported hardware (ATI, Nvidia and Intel GPUs with Mesa-18 or later). For an explanation, please see hacks.mozilla.org. The only downside seems to be that on a machine with limited RAM it might use more RAM.

To check if WebRender is being used, look in about:support. In the Graphics section, Compositing will either show 'Basic' (i.e. not in use) or 'WebRender'. To enable it, go to about:config and change gfx.webrender.all to True. You will need to restart firefox.

It may be useful to mention the processes from firefox which can appear in top - as well as firefox itself, there may be multiple Web Content processes, and now an RDD Process (Remote Data Decoder) which appears when playing web videos encoded with av1 (libdav1d). If WebRender has been enabled, a GPU Process will also appear when firefox has to repaint (e.g. scrolling, opening a new tab, or playing a video).

Contents

Installed Programs: firefox
Installed Libraries: Numerous libraries, browser components, plugins, extensions, and helper modules installed in /usr/lib/firefox
Installed Directory: /usr/lib/firefox

Short Descriptions

firefox

is a GTK+-3 internet browser that uses the Mozilla Gecko rendering engine

SeaMonkey-2.53.17

Introduction to SeaMonkey

SeaMonkey is a browser suite, a descendant of Netscape. It includes the browser, composer, mail and news clients, and an IRC client.

It is the community-driven follow-on to the Mozilla Application Suite, created after Mozilla decided to focus on separate applications for browsing and e-mail. Those applications are Firefox-115.2.0 and Thunderbird-115.2.0.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Note

The tarball seamonkey-2.53.17.source.tar.xz will untar to seamonkey-2.53.17 directory.

SeaMonkey Dependencies

Required

Autoconf-2.13, Cbindgen-0.24.3, GTK+-3.24.38, nodejs-18.17.1, Python-2.7.18, UnZip-6.0, yasm-1.3.0, and Zip-3.0

Recommended

Note

If you don't install recommended dependencies, then internal copies of those packages will be used. They might be tested to work, but they can be out of date or contain security holes.

Optional

alsa-lib-1.2.9, dbus-glib-0.112, GConf-3.2.6, startup-notification-0.12, Valgrind-3.21.0, Wget-1.21.4, Wireless Tools-29, Hunspell, and Watchman

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/seamonkey

Installation of SeaMonkey

The configuration of SeaMonkey is accomplished by creating a mozconfig file containing the desired configuration options. A default mozconfig file is created below. To see the entire list of available configuration options (and an abbreviated description of each one), issue ./configure --help. You may also wish to review the entire file and uncomment any other desired options. Create the file by issuing the following command:

cat > mozconfig << "EOF"
# If you have a multicore machine, all cores will be used

# If you have installed DBus-Glib comment out this line:
ac_add_options --disable-dbus

# If you have installed dbus-glib, and you have installed (or will install)
# wireless-tools, and you wish to use geolocation web services, comment out
# this line
ac_add_options --disable-necko-wifi

# Uncomment these lines if you have installed optional dependencies:
#ac_add_options --enable-system-hunspell
#ac_add_options --enable-startup-notification

# Uncomment the following option if you have not installed PulseAudio
#ac_add_options --disable-pulseaudio
# and uncomment this if you installed alsa-lib instead of PulseAudio
#ac_add_options --enable-alsa

# Comment out following option if you have gconf installed
ac_add_options --disable-gconf

# Comment out following options if you have not installed
# recommended dependencies:
ac_add_options --with-system-icu
ac_add_options --with-system-libevent
ac_add_options --with-system-nspr
ac_add_options --with-system-nss
ac_add_options --with-system-webp

# Disabling debug symbols makes the build much smaller and a little
# faster. Comment this if you need to run a debugger. Note: This is
# required for compilation on i686.
ac_add_options --disable-debug-symbols

# The elf-hack is reported to cause failed installs (after successful builds)
# on some machines. It is supposed to improve startup time and it shrinks
# libxul.so by a few MB - comment this if you know your machine is not affected.
ac_add_options --disable-elf-hack

# Seamonkey has some additional features that are not turned on by default,
# such as an IRC client, calendar, and DOM Inspector. The DOM Inspector
# aids with designing web pages. Comment these options if you do not
# desire these features.
ac_add_options --enable-calendar
ac_add_options --enable-dominspector
ac_add_options --enable-irc

# The BLFS editors recommend not changing anything below this line:
ac_add_options --prefix=/usr
ac_add_options --enable-application=comm/suite

ac_add_options --disable-crashreporter
ac_add_options --disable-updater
ac_add_options --disable-tests

# rust-simd does not compile with recent versions of rust.
# It is disabled in recent versions of firefox
ac_add_options --disable-rust-simd

ac_add_options --enable-optimize="-O2"
ac_add_options --enable-strip
ac_add_options --enable-install-strip
ac_add_options --enable-official-branding

# The option to use system cairo was removed in 2.53.9.
ac_add_options --enable-system-ffi
ac_add_options --enable-system-pixman

ac_add_options --with-system-bz2
ac_add_options --with-system-jpeg
ac_add_options --with-system-png
ac_add_options --with-system-zlib
EOF

Note

If you are compiling this package in chroot you must do two things. First, as the root user, ensure that /dev/shm is mounted. If you do not do this, the Python configuration will fail with a traceback report referencing /usr/lib/pythonN.N/multiprocessing/synchronize.py. Run:

mountpoint -q /dev/shm || mount -t tmpfs devshm /dev/shm

Second, either as the root user export the $SHELL environment variable using export SHELL=/bin/sh or else prepend SHELL=/bin/sh when running the ./mach commands.

Fix a problem with the bundled 'distro' python module:

sed -e '1012 s/stderr=devnull/stderr=subprocess.DEVNULL/' \
    -e '1013 s/OSError/(OSError, subprocess.CalledProcessError)/' \
    -i third_party/python/distro/distro.py

Compile SeaMonkey by running the following commands:

export CC=clang CXX=clang++          &&
./mach configure &&
./mach build

This package does not come with a test suite.

Install SeaMonkey by issuing the following commands as the root user:

./mach install                  &&
chown -R 0:0 /usr/lib/seamonkey &&

cp -v $(find -name seamonkey.1 | head -n1) /usr/share/man/man1

Command Explanations

export CC=clang CXX=clang++: With the introduction of gcc-12, many more warnings are generated when compiling mozilla applications and that results in a much slower, and larger, build. Furthermore, building with GCC on i?86 is currently broken. Although upstream mozilla code defaults to using llvm unless overridden, the older configure code in SeaMonkey defaults to gcc.

./mach configure: This validates the supplied dependencies and the mozconfig.

./mach build --verbose: Use this alternative if you need details of which files are being compiled, together with any C or C++ flags being used. But do not add '--verbose' to the install command, it is not accepted there.

./mach build -jN: The build should, by default, use all the online CPU cores. If using all the cores causes the build to swap because you have insufficient memory, using fewer cores can be faster.

Configuring SeaMonkey

For installing various SeaMonkey add-ons, refer to Add-ons for Seamonkey.

Along with using the Preferences menu to configure SeaMonkey's options and preferences to suit individual tastes, finer grain control of many options is only available using a tool not available from the general menu system. To access this tool, you'll need to open a browser window and enter about:config in the address bar. This will display a list of the configuration preferences and information related to each one. You can use the Search: bar to enter search criteria and narrow down the listed items. Changing a preference can be done using two methods. One, if the preference has a boolean value (True/False), simply double-click on the preference to toggle the value and two, for other preferences simply right-click on the desired line, choose Modify from the menu and change the value. Creating new preference items is accomplished in the same way, except choose New from the menu and provide the desired data into the fields when prompted.

If you use a desktop environment like Gnome or KDE you may wish to create a seamonkey.desktop file so that SeaMonkey appears in the panel's menus. If you didn't enable Startup-Notification in your mozconfig change the StartupNotify line to false. As the root user:

mkdir -pv /usr/share/{applications,pixmaps}              &&

cat > /usr/share/applications/seamonkey.desktop << "EOF"
[Desktop Entry]
Encoding=UTF-8
Type=Application
Name=SeaMonkey
Comment=The Mozilla Suite
Icon=seamonkey
Exec=seamonkey
Categories=Network;GTK;Application;Email;Browser;WebBrowser;News;
StartupNotify=true
Terminal=false
EOF

ln -sfv /usr/lib/seamonkey/chrome/icons/default/default128.png \
        /usr/share/pixmaps/seamonkey.png

Contents

Installed Programs: seamonkey
Installed Libraries: Numerous libraries, browser, and email/newsgroup components, plugins, extensions, and helper modules installed in /usr/lib/seamonkey
Installed Directory: /usr/lib/seamonkey

Short Descriptions

seamonkey

is the Mozilla browser/email/newsgroup/chat client suite

Chapter 43. Other X-based Programs

These programs use the X Window System and don't fit easily into any of the other chapters.

Balsa-2.6.4

Introduction to Balsa

The Balsa package contains a GNOME-2 based mail client.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Balsa Dependencies

Required

Aspell-0.60.8, enchant-2.5.0, GMime-3.2.7, GPGME-1.21.0, GTK+-3.24.38, and libnotify-0.8.2

Required (Runtime)

MTA (that provides a sendmail command)

Optional

Compface-1.5.2, Gcr-3.41.1, gtksourceview-3.24.11, libcanberra-0.30, libsecret-0.21.0, MIT Kerberos V5-1.21.2, OpenLDAP-2.6.6, Procmail-3.22, SQLite-3.42.0, WebKitGTK-2.41.91, html2text, osmo, rubrica, yelp-tools

Installation of Balsa

First, fix build issues when configuring without WebKitGTK+, or when using WebKitGTK+-2.38 or later.

patch -Np1 -i ../balsa-2.6.4-upstream_fixes-2.patch

Install Balsa by running the following commands:

./configure --prefix=/usr            \
            --sysconfdir=/etc        \
            --localstatedir=/var/lib \
            --without-html-widget    &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--without-html-widget: This option disables building the HTML renderer. If you want the HTML renderer to be built, verify that you have WebKitGTK-2.41.91 installed, and then remove this option.

--with-canberra: Enable libcanberra support.

--with-compface: Enable compface support.

--with-gcr: Use libgcr for TLS support.

--with-gss: Enable GSSAPI support.

--with-ldap: Use this option to enable LDAP address book support if OpenLDAP is installed.

--with-libsecret: Enable strong password support and support for gnome-keyring to store passwords.

--with-sqlite: Use this option to enable SQLite address book support if SQLite is installed.

Contents

Installed Programs: balsa and balsa-ab
Installed Libraries: None
Installed Directories: /etc/sounds/events, /usr/share/balsa, and /usr/share/sounds/balsa

Short Descriptions

balsa

is a glib based mail client

balsa-ab

is the address-book application used by balsa

feh-3.10

Introduction to feh

feh is a fast, lightweight image viewer which uses Imlib2. It is commandline-driven and supports multiple images through slideshows, thumbnail browsing or multiple windows, and montages or index prints (using TrueType fonts to display file info). Advanced features include fast dynamic zooming, progressive loading, loading via HTTP (with reload support for watching webcams), recursive file opening (slideshow of a directory hierarchy), and mouse wheel/keyboard control.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://feh.finalrewind.org/feh-3.10.tar.bz2

  • Download MD5 sum: 8adf6db9c5b18816df5ce539244d2329

  • Download size: 2.0 MB

  • Estimated disk space required: 5.7 MB (with tests)

  • Estimated build time: less than 0.1 SBU (with tests)

feh Dependencies

Required

libpng-1.6.40 and imlib2-1.12.0 (built with giflib-5.2.1 support, for the tests)

Recommended
Optional

libexif-0.6.24

Optional (runtime)

libjpeg-turbo-3.0.0 (for lossless image rotation) and ImageMagick-7.1.1-15 (to load unsupported formats)

Optional (test suite)

Test-Command-0.11 (required)

Installation of feh

Install feh by running the following commands:

sed -i "s:doc/feh:&-3.10:" config.mk &&
make PREFIX=/usr

To test the results, issue: make test.

Now, as the root user:

make PREFIX=/usr install

Command Explanations

sed -i "s:doc/feh:&-3.10:" config.mk: This sed fixes the doc directory to a versioned one, as used in BLFS.

curl=0: Use this make flag if you don't have the cURL package installed.

exif=1: This make flag enables builtin Exif tag display support.

Contents

Installed Program: feh
Installed Libraries: None
Installed Directories: /usr/share/doc/feh-3.10 and /usr/share/feh

Short Descriptions

feh

is an image viewer and cataloguer

FontForge-20230101

Introduction to FontForge

The FontForge package contains an outline font editor that lets you create your own postscript, truetype, opentype, cid-keyed, multi-master, cff, svg and bitmap (bdf, FON, NFNT) fonts, or edit existing ones.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

FontForge Dependencies

Required

libspiro-20220722 and libxml2-2.10.4

Recommended
Optional

giflib-5.2.1, git-2.41.0, libjpeg-turbo-3.0.0, libtiff-4.5.1, sphinx-7.1.2 (to build html documentation), WOFF2-1.0.2, and

Installation of FontForge

First fix a problem with old translations exposed by gettext-0.22:

sed -i.orig 's/\(%[^%[:space:]]*\)hs/\1s/g' \
 fontforgeexe/searchview.c po/de.po po/ca.po \
 po/hr.po po/it.po po/pl.po po/uk.po po/en_GB.po \
 po/fr.po po/vi.po po/ko.po po/ja.po

Install FontForge by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -Wno-dev .. &&
make

To test the results, issue: make check.

Now, as the root user:

make install

If you have installed sphinx-build, HTML documentation was built and installed in /usr/share/doc/fontforge. To be able to access it as a versioned directory, create a symlink as the root user:

ln -sv fontforge /usr/share/doc/fontforge-20230101

Command Explanations

-DCMAKE_BUILD_TYPE=Release: This switch is used to create an optimized release without debug information.

-Wno-dev: This switch is used to suppress warnings intended for the package's developers.

-DENABLE_X11=ON: use an X11 backend instead of GDK3 (gtk+-3) for basic Xorg graphics.

Contents

Installed Programs: fontforge, fontimage, fontlint and sfddiff
Installed Library: libfontforge.so and /usr/lib/python3.11.4/site-packages/{fontforge,psMat}.so
Installed Directories: /usr/share/fontforge and optionally /usr/share/doc/fontforge{,-20230101}

Short Descriptions

fontforge

is a program that allows you to create and modify font files

fontimage

is a program that produces an image showing representative glyphs of the font

fontlint

is a program that checks the font for certain common errors

sfddiff

is a program that compares two font files

Gimp-2.10.34

Introduction to Gimp

The Gimp package contains the GNU Image Manipulation Program which is useful for photo retouching, image composition and image authoring.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Gimp Dependencies

Required

gegl-0.4.46, gexiv2-0.14.2, glib-networking-2.76.1, GTK+-2.24.33, HarfBuzz-8.1.1. libjpeg-turbo-3.0.0, libmypaint-1.6.1, librsvg-2.56.3, libtiff-4.5.1, libxml2-2.10.4 python2 module (to build the translated help files), Little CMS-2.14, mypaint-brushes-1.3.1, Poppler-23.08.0 (including poppler-data) and a graphical environment

Recommended
Optional

AAlib-1.4rc5, alsa-lib-1.2.9, Gvfs-1.50.6 (to access the online help), libmng-2.0.3, libunwind-1.6.2, libwebp-1.3.1, OpenJPEG-2.5.0, an MTA (that provides a sendmail program), GTK-Doc-1.33.2, appstream-glib, libbacktrace, libheif with libde265 (both needed to read macOS heic images), libwmf, and OpenEXR

When you have run configure, you will see that WebKit is not found - that dependency is for the legacy webkit-1.0 which should never be used on a modern system exposed to the internet.

Optional, for building the help system

dblatex (for PDF docs), pngnq and pngcrush to optimize the png files, but see the note on the help download above

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/gimp

Installation of Gimp

Install Gimp by running the following commands:

./configure --prefix=/usr --sysconfdir=/etc &&
make

To test the results (requires an X-Windowed terminal) issue: make check.

Now, as the root user:

make install

Note

This package installs icon files into the /usr/share/icons/hicolor hierarchy and desktop files into the /usr/share/applications hierarchy. You can improve system performance and memory usage by updating /usr/share/icons/hicolor/index.theme and /usr/share/applications/mimeinfo.cache. To perform the update you must have GTK+-2.24.33 or GTK+-3.24.38 installed (for the icon cache) and desktop-file-utils-0.26 (for the desktop cache) and issue the following commands as the root user:

gtk-update-icon-cache -qtf /usr/share/icons/hicolor &&
update-desktop-database -q

Installation of Gimp-Help

The gimp-help tarball contains images and English text help for help files, together with translations. Because of the issues mentioned in the note above, you are recommended to use the online help, either by building against Gvfs-1.50.6 so that 'help' can open the latest XML files in your browser, or else you can manually open the html in your browser by going to https://docs.gimp.org/2.10/en (change the language code if desired).

If you nevertheless wish to install local copies of the help files to read offline, unpack the gimp-help tarball and change into the root of the newly created source tree. Prepare for the build with the following command:

ALL_LINGUAS="ca cs da de en en_GB es fa fr hr ko lt nl nn pt pt_BR ro sl sv uk zh_CN" \
./autogen.sh --prefix=/usr

Remove from ALL_LINGUAS the codes for any languages which you do not wish to install. Alternatively, remove the line starting with ALL_LINGUAS, if you wish to build all languages.

Now build the help files:

make

Issue the following commands as the root user to install the help files:

make install &&
chown -R root:root /usr/share/gimp/2.0/help

Command Explanations

ALL_LINGUAS="ca cs da de en en_GB es fa...": by default, the help files will be rendered in all the available languages. Remove the codes of any languages you do not wish to build.

--disable-python: This option is necessary if you have not installed PyGTK.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Configuring The Gimp

Config Files

/etc/gimp/2.0/* and ~/.gimp-2.8/gimprc

Contents

Installed Programs: gimp (symlink), gimp-2.10, gimp-console (symlink), gimp-console-2.10, gimp-test-clipboard-2.0, and gimptool-2.0
Installed Libraries: libgimp-2.0.so, libgimpbase-2.0.so, libgimpcolor-2.0.so, libgimpconfig-2.0.so, libgimpmath-2.0.so, libgimpmodule-2.0.so, libgimpthumb-2.0.so, libgimpui-2.0.so, and libgimpwidgets-2.0.so
Installed Directories: /etc/gimp, /usr/include/gimp-2.0, /usr/{lib,share}/gimp, /usr/share/gtk-doc/html/libgimp{,base,color,config}, and /usr/share/gtk-doc/html/libgimp{math,module,thumb,widgets}

Short Descriptions

gimp

is a symbolic link to gimp-2.10

gimp-2.10

is the Gnu Image Manipulation Program. It works with a variety of image formats and provides a large selection of tools

gimp-console

is a symbolic link to gimp-console-2.10

gimp-console-2.10

is a console program that behaves as if The Gimp was called with the --no-interface command-line option

gimptool-2.0

is a tool that can build plug-ins or scripts and install them if they are distributed in one source file. gimptool-2.0 can also be used by programs that need to know what libraries and include-paths The Gimp was compiled with

libgimp-2.0.so

provides C bindings for The Gimp's Procedural Database (PDB) which offers an interface to core functions and to functionality provided by plug-ins

libgimpbase-2.0.so

provides the C functions for basic Gimp functionality such as determining enumeration data types, gettext translation, determining The Gimp's version number and capabilities, handling data files and accessing the environment

libgimpcolor-2.0.so

provides the C functions relating to RGB, HSV and CMYK colors as well as converting colors between different color models and performing adaptive supersampling on an area

libgimpconfig-2.0.so

contains C functions for reading and writing config information

libgimpmath-2.0.so

contains C functions which provide mathematical definitions and macros, manipulate 3x3 transformation matrices, set up and manipulate vectors and the MD5 message-digest algorithm

libgimpmodule-2.0.so

provides the C functions which implement module loading using GModule and supports keeping a list of GimpModule's found in a given searchpath

libgimpthumb-2.0.so

provides the C functions for handling The Gimp's thumbnail objects

libgimpui-2.0.so

contains The Gimp's common user interface functions

libgimpwidgets-2.0.so

contains The Gimp and GTK's widget creation and manipulation functions

Gparted-1.5.0

Introduction to Gparted

Gparted is the Gnome Partition Editor, a Gtk 3 GUI for other command line tools that can create, reorganise or delete disk partitions.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Gparted Dependencies

Required

Gtkmm-3.24.8 and parted-3.6

Optional

btrfs-progs-6.3.3 (if using a btrfs filesystem), exfatprogs, and udftools

Installation of Gparted

Install Gparted by running the following commands:

./configure --prefix=/usr    \
            --disable-doc    \
            --disable-static &&
make

To run the tests, issue: make check.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--disable-doc: This switch disables building of the optional documentation. Remove it if you have installed GNOME Doc Utils.

--enable-xhost-root: 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.

Using Gparted

To manipulate file systems Gparted has a run time dependency on various file system tools (you only need to install the tools for file systems you actually use): Hdparm-9.65 (required for optionally displaying serial number device information), btrfs-progs-6.3.3, dosfstools-4.2, e2fsprogs (installed as part of LFS), jfsutils-1.1.15, reiserfsprogs-3.6.27, xfsprogs-6.4.0, mtools (required to read and write FAT16/32 volume labels and UUIDs), hfsutils, hfsprogs, nilfs-utils and Reiser4progs.

Root privileges are required to run Gparted. If you wish to run the application from the menu, further applications and configurations are necessary. Examples of applications that may be used: gksu, kdesudo, or xdg-su. Another simple solution is ssh-askpass-9.4p1.

ssh-askpass

To optionally use ssh-askpass-9.4p1 if it is installed in your system, run the following commands as the root user:

cp -v /usr/share/applications/gparted.desktop /usr/share/applications/gparted.desktop.back &&
sed -i 's/Exec=/Exec=sudo -A /'               /usr/share/applications/gparted.desktop

Now, clicking on the menu item for Gparted, a dialog appears on the screen, asking for the administrator password.

Contents

Installed Programs: gparted and gparted_polkit (optional)
Installed Libraries: None
Installed Directories: None

Short Descriptions

gparted

is a shell script which sets up the environment before calling gpartedbin

gparted_polkit

is an optional script which can be used to run gparted with polkit, from a menu

HexChat-2.16.1

Introduction to HexChat

HexChat is an IRC chat program. It allows you to join multiple IRC channels (chat rooms) at the same time, talk publicly, have private one-on-one conversations, etc. File transfers are also possible.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

HexChat Dependencies

Required

dbus-glib-0.112, GLib-2.76.4, and libnotify-0.8.2

Recommended
Optional

dbus-glib-0.112, ISO Codes-4.15.0, libnotify-0.8.2, pciutils-3.10.0, libproxy, luajit, if python is enabled cffi and pycparser.

Installation of HexChat

Install HexChat by running the following commands:

mkdir build &&
cd    build &&

meson setup ..              \
      --prefix=/usr         \
      --buildtype=release   \
      -Dwith-lua=false      \
      -Dwith-python=false   &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Command Explanations

-Dwith-lua=false: By default, this package will look for luajit. However, the Lua plugin support is currently broken and will cause the application to crash on startup.

-Dwith-python=false: If the Python interface should be enabled, remove this switch or set it to true. When enabling Python, two additional modules (cffi and pycparser) needs to be installed prior to installation of Hexchat.

-Dwith-libcanberra=false: Use this switch if you have libcanberra not installed.

Contents

Installed Program: hexchat
Installed Libraries: None
Installed Directory: /usr/lib/hexchat

Short Descriptions

hexchat

is a graphical Internet Relay Chat (IRC) client

Inkscape-1.3

Introduction to Inkscape

Inkscape is a what you see is what you get Scalable Vector Graphics editor. It is useful for creating, viewing and changing SVG images.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Note

The tarball inkscape-1.3.tar.xz will extract to the directory inkscape-1.3_2023-07-21_0e150ed6c4/.

Inkscape Dependencies

Required

Boost-1.83.0, double-conversion-3.3.0, GC-8.2.4, Gsl-2.7.1, Gtkmm-3.24.8, libsoup-2.74.3, libxslt-1.1.38, Poppler-23.08.0, popt-1.19 and Wget-1.21.4 (to download the test dependencies)

Recommended
Optional

Aspell-0.60.8, dbus-1.14.8 (to run inkscape from scripts), Doxygen-1.9.7, gspell-1.12.2, GraphicsMagick, libcdr, libvisio, libwpg (or libwpd)

Installation of Inkscape

Install Inkscape by running the following commands:

mkdir build                       &&
cd    build                       &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..                          &&
make

Note

This package may occasionally fail when building with multiple processors. See Using Multiple Processors for more information.

This package does not come with a working test suite.

Now, as the root user:

make install

Note

This package installs icon files into the /usr/share/icons/hicolor hierarchy and desktop files into the /usr/share/applications hierarchy. You can improve system performance and memory usage by updating /usr/share/icons/hicolor/index.theme and /usr/share/applications/mimeinfo.cache. To perform the update you must have GTK+-2.24.33 or GTK+-3.24.38 installed (for the icon cache) and desktop-file-utils-0.26 (for the desktop cache) and issue the following commands as the root user:

gtk-update-icon-cache -qtf /usr/share/icons/hicolor &&
update-desktop-database -q

Command Explanations

-DCMAKE_BUILD_TYPE=Release: This switch is used to build the release library without any debug `assert` in the code.

-DWITH_DBUS=ON: use this if you wish to use inkscape in interactive scripts which manipulate images.

Contents

Installed Programs: inkscape and inkview
Installed Library: lib2geom.so and libinkscape_base.so (in /usr/lib/inkscape)
Installed Directories: /usr/include/2geom-1.3.0, /usr/lib/inkscape, and /usr/share/inkscape

Short Descriptions

inkscape

is a SVG (Scalable Vector Graphics) editing program

inkview

is a simple program for displaying SVG files

libinkscape_base.so

provides the routines used by inkscape and inkview

Pidgin-2.14.12

Introduction to Pidgin

Pidgin is a Gtk+ 2 instant messaging client that can connect with a wide range of networks including Bonjour, ICQ, GroupWise, Jabber/XMPP, IRC, Gadu-Gadu, SILC, SIMPLE, and Zephyr.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Pidgin Dependencies

Required

GTK+-2.24.33

Recommended
Optional

Avahi-0.8 (required for the Bonjour plugin), Cyrus SASL-2.1.28, dbus-1.14.8, Doxygen-1.9.7, evolution-data-server-3.48.4, GConf-3.2.6, Graphviz-8.1.0, libidn-1.41 (required, if you wish to run the test suite), libnsl-2.0.0, NetworkManager-1.44.0, SQLite-3.42.0 (required for the Contact Availability Prediction plugin), startup-notification-0.12, Tk-8.6.13, Farstream (required for video and voice support), Gtkspell, libgadu, libgnt, Meanwhile (required for Sametime protocol support), Mono, SILC Client, SILC Toolkit, Zephyr, and MIT Kerberos V5-1.21.2 (required for Kerberos support in the Zephyr module)

Optional (runtime)

xdg-utils-1.1.3

Installation of Pidgin

Compile Pidgin by running the following commands:

./configure --prefix=/usr        \
            --sysconfdir=/etc    \
            --with-gstreamer=1.0 \
            --disable-avahi      \
            --disable-gtkspell   \
            --disable-meanwhile  \
            --disable-idn        \
            --disable-nm         \
            --disable-tk         \
            --disable-vv         &&
make

If you have Doxygen-1.9.7 installed (Graphviz-8.1.0 can be used also) and you wish to create the API documentation, issue:

make docs

To test the results, issue: make check.

Now, as the root user:

make install &&
mkdir -pv /usr/share/doc/pidgin-2.14.12 &&
cp -v README doc/gtkrc-2.0 /usr/share/doc/pidgin-2.14.12

If you created the API documentation, install it using the following commands as the root user:

mkdir -pv /usr/share/doc/pidgin-2.14.12/api &&
cp -rv doc/html/* /usr/share/doc/pidgin-2.14.12/api

Note

This package installs icon files into the /usr/share/icons/hicolor hierarchy and desktop files into the /usr/share/applications hierarchy. You can improve system performance and memory usage by updating /usr/share/icons/hicolor/index.theme and /usr/share/applications/mimeinfo.cache. To perform the update you must have GTK+-2.24.33 or GTK+-3.24.38 installed (for the icon cache) and desktop-file-utils-0.26 (for the desktop cache) and issue the following commands as the root user:

gtk-update-icon-cache -qtf /usr/share/icons/hicolor &&
update-desktop-database -q

Command Explanations

--with-gstreamer=1.0: Remove this switch and add --disable-gstreamer if you've not installed gstreamer-1.22.5.

--disable-avahi: Remove this switch if you've installed Avahi-0.8.

--disable-gtkspell: Remove this switch if you've installed Gtkspell and wish to enable spellchecking support.

--disable-meanwhile: Remove this switch if you've installed Meanwhile.

--disable-idn: Remove this switch if you've installed libidn-1.41.

--disable-tk: Remove this switch if you've installed Tk-8.6.13 and you wish to use the TCL bindings.

--disable-nm: Remove this switch if you've installed NetworkManager-1.44.0.

--disable-vv: Remove this switch if you've installed Farstream and wish to enable voice and video communication support. You should also remove the --disable-gstreamer flag.

--enable-cyrus-sasl: Use this switch if you've installed Cyrus SASL-2.1.28 and wish to build Pidgin with SASL support.

--disable-gnutls: Use this switch if you've got both GnuTLS-3.8.1 and nss-3.92 installed, but want to use nss-3.92 for the SSL support.

Configuring Pidgin

Config Files

~/.purple/* and ~/.gtkrc-2.0

Configuration Information

Most configuration can be accomplished by using the various preference settings inside the programs. Additionally, you can create a ~/.gtkrc-2.0 file which can store gtk+-2 theme settings that affect Pidgin and other Gtk+ 2 applications. Note that an example gtkrc-2.0 file was installed during the package installation and can be used as a starting point or reference.

Contents

Installed Programs: pidgin, purple-client-example, purple-remote, purple-send, purple-send-async, and purple-url-handler
Installed Library: libpurple.so, and libpurple-client.so
Installed Directories: /usr/include/libpurple, /usr/include/pidgin, /usr/lib/pidgin, /usr/lib/purple-2, /usr/share/doc/pidgin-2.14.12, /usr/share/pixmaps/pidgin, /usr/share/purple, and /usr/share/sounds/purple

Short Descriptions

pidgin

is a GTK+ 2 instant messaging client

purple-client-example

is an example that demonstrates how to use the libpurple-client library to communicate with purple

purple-remote

sends remote commands to Pidgin/Finch

purple-send

calls purple API functions using DBus and prints the return value

purple-send-async

calls purple API functions using DBus. As opposed to purple-send, it does not print the return value

purple-url-handler

is a python script to handle URLs with purple

Rox-Filer-2.11

Introduction to Rox-Filer

rox-filer is a fast, lightweight, gtk2 file manager.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

rox-filer Dependencies

Required

libglade-2.6.4 and shared-mime-info-2.2

Kernel Configuration

If you want rox-filer to be able to update the contents of a directory when changes are made to the files by other applications (eg, if a script is running) you will need to enable dnotify support in your kernel. In make menuconfig:

File systems --->
  [*] Dnotify support                                                  [DNOTIFY]

Save the new .config and then compile the kernel.

Installation of Rox-Filer

Compile rox-filer with the following commands:

cd ROX-Filer                                                        &&
sed -i 's:g_strdup(getenv("APP_DIR")):"/usr/share/rox":' src/main.c &&
sed -i 's/gboolean/extern &/' src/session.h                     &&

mkdir build                        &&
pushd build                        &&
  ../src/configure LIBS="-lm -ldl" &&
  make                             &&
popd

Now install it as the root user:

mkdir -p /usr/share/rox                              &&
cp -av Help Messages Options.xml ROX images style.css .DirIcon /usr/share/rox &&

cp -av ../rox.1 /usr/share/man/man1                  &&
cp -v  ROX-Filer /usr/bin/rox                        &&
chown -Rv root:root /usr/bin/rox /usr/share/rox      &&

cd /usr/share/rox/ROX/MIME                           &&
ln -sv text-x-{diff,patch}.png                       &&
ln -sv application-x-font-{afm,type1}.png            &&
ln -sv application-xml{,-dtd}.png                    &&
ln -sv application-xml{,-external-parsed-entity}.png &&
ln -sv application-{,rdf+}xml.png                    &&
ln -sv application-x{ml,-xbel}.png                   &&
ln -sv application-{x-shell,java}script.png          &&
ln -sv application-x-{bzip,xz}-compressed-tar.png    &&
ln -sv application-x-{bzip,lzma}-compressed-tar.png  &&
ln -sv application-x-{bzip-compressed-tar,lzo}.png   &&
ln -sv application-x-{bzip,xz}.png                   &&
ln -sv application-x-{gzip,lzma}.png                 &&
ln -sv application-{msword,rtf}.png

Command Explanations

sed -i 's:g_strdup(getenv("APP_DIR")):"/usr/share/rox":' src/main.c: This command hard codes /usr/share/rox as the directory for rox-filer's private files. Without this sed rox needs the environment variable ${APP_DIR} to be set.

sed -i 's/gboolean/extern &/' src/session.h: This command fixes a multiple definition flagged as an error by GCC 10 and higher.

ln -sv application-...: These commands duplicate the icons for some common mime types. Without these links rox-filer would just display the default "unknown binary blob" icon.

Configuring RoxFiler

Configuration Information

Most of the configuration of rox-filer is achieved by right clicking on a rox-filer window and choosing "Options" from the menu. It stores its settings in ~/.config/rox.sourceforge.net.

A rox-filer feature is that if there is an executable file called AppRun in a directory rox-filer will first run AppRun before it opens the folder.

As an example of how this may be used, if you have ssh access to another computer (perhaps another computer on your local network) with ssh configured for passwordless logins and you have sshfs-3.7.3 installed you can use AppRun to mount the remote computer in a local folder using sshfs. For this example AppRun script to work the folder must have the same name as the hostname of the remote computer:

cat > /path/to/hostname/AppRun << "HERE_DOC"
#!/bin/bash

MOUNT_PATH="${0%/*}"
HOST=${MOUNT_PATH##*/}
export MOUNT_PATH HOST
sshfs -o nonempty ${HOST}:/ ${MOUNT_PATH}
rox -x ${MOUNT_PATH}
HERE_DOC

chmod 755 /path/to/hostname/AppRun

That works fine for mounting, but to unmount it the command fusermount -u ${MOUNTPOINT} is ran. You could set that as your default umount command in your rox preferences, but you would then be unable to unmount any normal mountpoints (that need umount). A script is needed that will unmount a Fuse mountpoint with fusermount -u ${MOUNTPOINT} and everything else with umount. As the root user:

cat > /usr/bin/myumount << "HERE_DOC" &&
#!/bin/bash
sync
if mount | grep "${@}" | grep -q fuse
then fusermount -u "${@}"
else umount "${@}"
fi
HERE_DOC

chmod 755 /usr/bin/myumount

Now, to make Rox use this simple script, open a Rox window, right click on it and choose Options from the menu. In the left hand list choose "Action windows" and then on the right hand side, where it says "Unmount command" change umount to myumount.

If you use a desktop environment like Gnome or KDE you may like to create a rox.desktop file so that rox-filer appears in the panel's menus. As the root user:

ln -s ../rox/.DirIcon /usr/share/pixmaps/rox.png &&
mkdir -p /usr/share/applications &&

cat > /usr/share/applications/rox.desktop << "HERE_DOC"
[Desktop Entry]
Encoding=UTF-8
Type=Application
Name=Rox
Comment=The Rox File Manager
Icon=rox
Exec=rox
Categories=GTK;Utility;Application;System;Core;
StartupNotify=true
Terminal=false
HERE_DOC

Contents

Installed Programs: rox
Installed Libraries: None
Installed Directories: /usr/share/rox

Short Descriptions

rox

is the rox file manager

rxvt-unicode-9.31

Introduction to rxvt-unicode

rxvt-unicode is a clone of the terminal emulator rxvt, an X Window System terminal emulator which includes support for XFT and Unicode.

This package is known to build and work properly using an LFS 12.0 platform.

Note

Please be aware that rxvt-unicode is affected by an issue in perl where the SIGFPE handler is set to SIG_IGN (i.e. the signal is ignored). If you are building an LFS system from within urxvt and running the test suites, tests in bash and check which test raising this signal will fail.

Package Information

rxvt-unicode Dependencies

Required

libptytty-2.0 and a graphical environment

Optional

gdk-pixbuf-2.42.10 (for background images) and startup-notification-0.12

Installation of rxvt-unicode

Install rxvt-unicode by running the following commands:

./configure --prefix=/usr --enable-everything &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--enable-everything: Add support for all non-multichoice options. Details about the different options can be found in the file README.configure.

--disable-xft: Remove support for Xft fonts.

--disable-perl: Disable the embedded Perl interpreter.

--disable-afterimage: Remove support for libAfterImage.

Configuring rxvt-unicode

The rxvt-unicode terminal emulator uses the resource class URxvt and the resource name urxvt. You can add X resource definitions to a user's ~/.Xresources or ~/.Xdefaults files or to the system-wide /etc/X11/app-defaults/URxvt file. The following example will load the matcher Perl extension (assuming Perl support wasn't disabled), which enables a left button click to open an underlined URL in the specified browser, sets a background and foreground color and loads an Xft font (as the root user):

cat >> /etc/X11/app-defaults/URxvt << "EOF"
! Use the specified colour as the windows background colour [default white]
URxvt*background: black

! Use the specified colour as the windows foreground colour [default black]
URxvt*foreground: yellow

! Select the fonts to be used. This is a comma separated list of font names
URxvt*font: xft:Monospace:pixelsize=18

! Comma-separated list(s) of perl extension scripts (default: "default")
URxvt*perl-ext: matcher

! Specifies the program to be started with a URL argument. Used by
URxvt*url-launcher: firefox

! When clicked with the mouse button specified in the "matcher.button" resource
! (default 2, or middle), the program specified in the "matcher.launcher"
! resource (default, the "url-launcher" resource, "sensible-browser") will be
! started with the matched text as first argument.
! Below, default modified to mouse left button.
URxvt*matcher.button:     1
EOF

In order to view the defined X resources, issue:

xrdb -query

In order to add the modifications of the new user configuration file, keeping previously X configurations (of course, unless you are changing any on previously define), issue:

xrdb -merge ~/.Xresources

The rxvt-unicode application can also run in a daemon mode, which makes it possible to open multiple terminal windows within the same process. The urxvtc client then connects to the urxvtd daemon and requests a new terminal window. Use this option with caution. If the daemon crashes, all the running processes in the terminal windows are terminated.

You can start the urxvtd daemon in the system or personal startup X session script (e.g., ~/.xinitrc) by adding the following lines near the top of the script:

# Start the urxvtd daemon
urxvtd -q -f -o &

For more information, examine the urxvt, urxvtd, urxvtc, and urxvtperl man pages.

If you use a Desktop Environment, a menu entry can be included, issuing, as the root user:

cat > /usr/share/applications/urxvt.desktop << "EOF" &&
[Desktop Entry]
Encoding=UTF-8
Name=Rxvt-Unicode Terminal
Comment=Use the command line
GenericName=Terminal
Exec=urxvt
Terminal=false
Type=Application
Icon=utilities-terminal
Categories=GTK;Utility;TerminalEmulator;
#StartupNotify=true
Keywords=console;command line;execute;
EOF

update-desktop-database -q

For that, you need desktop-file-utils-0.26 and at least one of gnome-icon-theme-3.12.0, oxygen-icons5-5.109.0 and lxde-icon-theme-0.5.1. Uncomment the line with StartupNotify=true if startup-notification-0.12 is installed.

Contents

Installed Programs: urxvt, urxvtd, and urxvtc
Installed Libraries: Many Perl extensions located under /usr/lib/urxvt/perl
Installed Directory: /usr/lib/urxvt

Short Descriptions

urxvt

is a terminal emulator for the X Window System

urxvtd

is the urxvt terminal daemon

urxvtc

controls the urxvtd daemon

Thunderbird-115.2.0

Introduction to Thunderbird

Thunderbird is a stand-alone mail/news client based on the Mozilla codebase. It uses the Gecko rendering engine to enable it to display and compose HTML emails.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Thunderbird Dependencies

Required

Cbindgen-0.24.3, dbus-glib-0.112, GTK+-3.24.38, LLVM-16.0.5 including clang, nodejs-18.17.1, PulseAudio-16.1 (or alsa-lib-1.2.9 if you edit the mozconfig; although it is now deprecated by mozilla), Python-3.11.4 (rebuilt with the sqlite module), startup-notification-0.12, Zip-3.0, and UnZip-6.0

Recommended

Note

If you don't install recommended dependencies, then internal copies of those packages will be used. They might be tested to work, but they can be out of date or contain security holes.

Optional

pciutils-3.10.0 (runtime), Wget-1.21.4, Wireless Tools-29, and watchman

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/Thunderbird

Installation of Thunderbird

Note

The build process for Thunderbird can use 8GB+ of RAM when linking. Make sure that you have adequate swap or RAM before continuing.

The configuration of Thunderbird is accomplished by creating a mozconfig file containing the desired configuration options. A default mozconfig is created below. To see the entire list of available configuration options (and a brief description of each), issue ./mach configure -- --help | less. Create the file with the following command:

cat > mozconfig << "EOF"
# If you have a multicore machine, all cores will be used.

# If you have installed wireless-tools comment out this line:
ac_add_options --disable-necko-wifi

# Uncomment the following option if you have not installed PulseAudio
#ac_add_options --enable-audio-backends=alsa

# Comment out following options if you have not installed
# recommended dependencies:
ac_add_options --with-system-libevent
ac_add_options --with-system-libvpx
ac_add_options --with-system-nspr
ac_add_options --with-system-nss

# The elf-hack causes failed installs on some machines.
# It is supposed to improve startup time and it shrinks libxul.so
# by a few MB - comment this if you know your machine is not affected.
ac_add_options --disable-elf-hack

# The BLFS editors recommend not changing anything below this line:
ac_add_options --prefix=/usr
ac_add_options --enable-application=comm/mail

ac_add_options --disable-crashreporter
ac_add_options --disable-updater
ac_add_options --disable-debug
ac_add_options --disable-debug-symbols
ac_add_options --disable-tests

ac_add_options --enable-optimize=-O2
ac_add_options --enable-linker=gold
ac_add_options --enable-strip
ac_add_options --enable-install-strip

ac_add_options --enable-official-branding

ac_add_options --enable-system-ffi
ac_add_options --enable-system-pixman

ac_add_options --with-system-jpeg
ac_add_options --with-system-png
ac_add_options --with-system-zlib

# Using sandboxed wasm libraries has been moved to all builds instead
# of only mozilla automation builds. It requires extra llvm packages
# and was reported to seriously slow the build. Disable it.
ac_add_options --without-wasm-sandboxed-libraries
EOF

Fix an issue occurring when building with GCC-13:

sed -e '/<exception>/i#include <cstdint>' \
    -i comm/third_party/rnp/src/libsexp/include/sexp/sexp-error.h

Now invoke the Python mach script to compile Thunderbird:

Note

If you are compiling this package in chroot you must do two things. First, as the root user, ensure that /dev/shm is mounted. If you do not do this, the Python configuration will fail with a traceback report referencing /usr/lib/pythonN.N/multiprocessing/synchronize.py. Run:

mountpoint -q /dev/shm || mount -t tmpfs devshm /dev/shm

Second, either as the root user export the $SHELL environment variable using export SHELL=/bin/sh or else prepend SHELL=/bin/sh when running the ./mach commands.

export MACH_BUILD_PYTHON_NATIVE_PACKAGE_SOURCE=none &&
export MOZBUILD_STATE_PATH=./mozbuild               &&
./mach configure                                    &&
./mach build

This package does not come with a test suite.

Install Thunderbird by running the following commands as the root user:

MACH_BUILD_PYTHON_NATIVE_PACKAGE_SOURCE=none ./mach install

Empty the environment variables which were set above:

unset MACH_BUILD_PYTHON_NATIVE_PACKAGE_SOURCE MOZBUILD_STATE_PATH

Command Explanations

MACH_BUILD_PYTHON_NATIVE_PACKAGE_SOURCE=none: Use the system python to create a virtual environment for mach without downloading any python wheels nor using the system python modules. This prevent version mismatches between system modules and bundled ones.

./mach configure: This validates the supplied dependencies and the mozconfig.

./mach build --verbose: Use this alternative if you need details of which files are being compiled, together with any C or C++ flags being used.

./mach build -jN: The build should, by default, use all the online CPU cores. If using all the cores causes the build to swap because you have insufficient memory, using fewer cores can be faster.

CC=gcc CXX=g++: BLFS used to prefer to use gcc and g++ instead of upstream's defaults of the clang programs. With the release of gcc-12 the build takes longer with gcc and g++, primarily because of extra warnings, and is bigger. Set these environment variables before you run the configure script if you wish to continue to use gcc, g++. Building with GCC on i?86 is currently broken.

Configuring Thunderbird

Configuration Information

If your Window Manager or Desktop Environment does not allow you to configure a default browser, you can add a configuration parameter to Thunderbird so that a browser will start when you click on an Internet/intranet/local URL. The procedure to check or modify any of the configuration parameters is quite simple and the instructions here can be used to view or modify any of the parameters.

First, open the configuration dialog by opening the Edit drop-down menu. Choose Preferences and then scroll down to the bottom of the page. Then, click the Config Editor button. Click on the I accept the risk! button. This will display a list of the configuration preferences and information related to each one. You can use the Filter: bar to enter search criteria and narrow down the listed items. Changing a preference can be done using two methods. One, if the preference has a boolean value (True/False), simply double-click on the preference to toggle the value and two, for other preferences simply right-click on the desired line, choose Modify from the menu and change the value. Creating new preference items is accomplished in the same way, except choose New from the menu and provide the desired data into the fields when prompted.

The configuration preference item you need to check so that Thunderbird uses a specified browser is the network.protocol-handler.app.http which should be set to the path of the desired browser, e.g. /usr/bin/firefox.

If you use a desktop environment such as GNOME or KDE, a desktop file thunderbird.desktop may be created, in order to include a Thunderbird entry in the menu. Run the following commands as the root user:

mkdir -pv /usr/share/{applications,pixmaps} &&

cat > /usr/share/applications/thunderbird.desktop << "EOF" &&
[Desktop Entry]
Name=Thunderbird Mail
Comment=Send and receive mail with Thunderbird
GenericName=Mail Client
Exec=thunderbird %u
Terminal=false
Type=Application
Icon=thunderbird
Categories=Network;Email;
MimeType=text/html;text/xml;application/xhtml+xml;application/xml;application/rss+xml;x-scheme-handler/mailto;
StartupNotify=true
EOF

ln -sfv /usr/lib/thunderbird/chrome/icons/default/default256.png \
        /usr/share/pixmaps/thunderbird.png

Contents

Installed Program: thunderbird
Installed Libraries: Numerous libraries and modules in the /usr/lib/thunderbird directory
Installed Directory: /usr/lib/thunderbird

Short Descriptions

thunderbird

is Mozilla's email and newsgroup client

Tigervnc-1.13.1

Introduction to Tigervnc

Tigervnc is an advanced VNC (Virtual Network Computing) implementation. It allows creation of an Xorg server not tied to a physical console and also provides a client for viewing of the remote graphical desktop.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Note

The version of Xorg may eventually be a few versions out of date, but is required for the customizations needed for this package.

Tigervnc Dependencies

Required

CMake-3.27.2, FLTK-1.3.8, GnuTLS-3.8.1, libgcrypt-1.10.2, libjpeg-turbo-3.0.0, Pixman-0.42.2, Systemd-254 (with Linux-PAM-1.5.3), Xorg Applications, xinit-1.4.2, and Xorg Legacy Fonts

Recommended

Installation of Tigervnc

First, make adjustments to the configuration files to make them compatible with LFS systems:

patch -Np1 -i ../tigervnc-1.13.1-configuration_fixes-1.patch

Install tigervnc by running the following commands:

# Put code in place
mkdir -p unix/xserver &&
tar -xf ../xorg-server-21.1.6.tar.xz \
    --strip-components=1              \
    -C unix/xserver                   &&
( cd unix/xserver &&
  patch -Np1 -i ../xserver21.1.1.patch ) &&

# Build viewer
cmake -G "Unix Makefiles"         \
      -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -Wno-dev . &&
make &&

# Build server
pushd unix/xserver &&
  autoreconf -fiv  &&

  CPPFLAGS="-I/usr/include/drm"       \
  ./configure $XORG_CONFIG            \
      --disable-xwayland    --disable-dri        --disable-dmx         \
      --disable-xorg        --disable-xnest      --disable-xvfb        \
      --disable-xwin        --disable-xephyr     --disable-kdrive      \
      --disable-devel-docs  --disable-config-hal --disable-config-udev \
      --disable-unit-tests  --disable-selective-werror                 \
      --disable-static      --enable-dri3                              \
      --without-dtrace      --enable-dri2        --enable-glx          \
      --with-pic &&
  make  &&
popd

This package does not come with a test suite.

Now, as the root user:

#Install viewer
make install &&

#Install server
( cd unix/xserver/hw/vnc && make install ) &&

[ -e /usr/bin/Xvnc ] || ln -svf $XORG_PREFIX/bin/Xvnc /usr/bin/Xvnc

Command Explanations

tar -xf .. xorg-server...: This command extracts the standard Xorg package into the tree in a location needed for modification.

--disable ...: Most options that are usually needed for the standard Xorg server are not needed for the Xvnc instance being built.

[ -e /usr/bin/Xvnc ] || ln ... Xvnc: If the Xvnc server is not installed in the /usr/bin directory, then create a link so the vncserver script can find it.

Configuring Tigervnc

Server Configuration

On systemd systems, another method of configuration is available. This configuration provides the added benefit of making tigervnc systemd aware for VNC sessions and allows desktop environments like GNOME to autostart services once the VNC session is started. This configuration also gives the added benefit of starting VNC Sessions on system startup. To set up the VNC server in this fashion, follow these instructions.

First, install a rudimentary Xsession file so that the VNC server can initialize X sessions properly:

install -vdm755 /etc/X11/tigervnc &&
install -v -m755 ../Xsession /etc/X11/tigervnc

Next, set up a user mapping in /etc/tigervnc/vncserver.users. This tells the VNC Server which session is allocated to a user.

echo ":1=$(whoami)" >> /etc/tigervnc/vncserver.users

Next, set up a configuration file to tell vncserver which desktop environment should be used and what display geometry should be used. There are several other options that can be defined in this file, but they are outside the scope of BLFS.

install -vdm 755 ~/.vnc &&
cat > ~/.vnc/config << EOF
# Begin ~/.vnc/config
# The session must match one listed in /usr/share/xsessions.
# Ensure that there are no spaces at the end of the lines.

session=LXDE
geometry=1024x768

# End ~/.vnc/config
EOF

To start the VNC Server, run the following command:

systemctl start vncserver@:1

To start the VNC Server when the system boots, run the following command:

systemctl enable vncserver@:1

Contents

Installed Programs: Xvnc, vncconfig, vncpasswd, vncserver, vncviewer, and x0vncserver
Installed Libraries: libvnc.so
Installed Directories: /usr/share/doc/tigervnc-1.13.1

Short Descriptions

Xvnc

is a X VNC (Virtual Network Computing) server. It is based on a standard X server, but it has a virtual screen rather than a physical one

vncconfig

is a program to configure and control a VNC server

vncpasswd

allows you to set the password used to access VNC desktops

vncserver

is a perl script used to start or stop a VNC server

vncviewer

is a client used to connect to VNC desktops

x0vncserver

is a program to make an X display on a physical terminal accessible via TigerVNC or compatible viewers

Transmission-4.0.3

Introduction to Transmission

Transmission is a cross-platform, open source BitTorrent client. This is useful for downloading large files (such as Linux ISOs) and reduces the need for the distributors to provide server bandwidth.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Transmission Dependencies

Required

cURL-8.2.1

Recommended
Recommended (to build a GUI)
Optional

nodejs-18.17.1 (for building the web client, not needed at run time), appindicator, dht, libb64, libdeflate, libnatpmp, libutp, and miniupnp

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/transmission

Installation of Transmission

Install Transmission by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DCMAKE_INSTALL_DOCDIR=/usr/share/doc/transmission-4.0.3 \
      .. &&

make

Now, as the root user:

make install

As transmission.png seems to be missing, create it from the svg::

rsvg-convert                                               \
   /usr/share/icons/hicolor/scalable/apps/transmission.svg \
   -o /usr/share/pixmaps/transmission.png

Command Explanations

-DENABLE_QT=OFF: This switch disables building the Qt5 client. The default is to build it if (Qt-5.15.10 or qt-alternate-5.15.10) is installed.

-DENABLE_GTK=OFF: This switch disables building the GTK+-3 cli client. The default is to build it Gtkmm-3.24.8 is installed.

-DENABLE_WEB=OFF: This switch disables building the web client. The default is to build it if nodejs-18.17.1 is installed.

-DREBUILD_WEB=ON: This switch forces rebuilding of the web client. Needs nodejs-18.17.1 and a network connection. The default is to not rebuild.

Contents

Installed Programs: transmission-cli, transmission-create, transmission-daemon, transmission-edit, transmission-gtk or transmission-qt, transmission-remote, and transmission-show
Installed Libraries: None
Installed Directory: /usr/share/transmission (contains the web client, optional) and /usr/share/doc/transmission-4.0.3

Short Descriptions

transmission-cli

is a lightweight, command-line BitTorrent client with scripting capabilities

transmission-create

is a command line tool used to create .torrent files

transmission-daemon

is a daemon-based Transmission session that can be controlled via RPC commands from transmission's web interface or transmission-remote

transmission-edit

is a command-line utility to modify .torrent files' announce URLs

transmission-gtk

is a GTK+ bittorrent client

transmission-qt

is a Qt bittorrent client

transmission-remote

is a remote control utility for transmission-daemon and transmission

transmission-show

is a command line tool to display bittorrent .torrent file metadata

xarchiver-0.5.4.21

Introduction to xarchiver

XArchiver is a GTK+ archive manager with support for tar, xz, bzip2, gzip, zip, 7z, rar, lzo and many other archive formats.

This package is known to build and work properly using an LFS 12.0 platform.

Note

xarchiver is only a command line or graphical interface to archiving utilities such as tar and zip.

Package Information

xarchiver Dependencies

Required

GTK+-2.24.33 or GTK+-3.24.38

Optional (Runtime)

cpio-2.14, LZO-2.10, p7zip-17.04, UnRar-6.2.10, UnZip-6.0, and Zip-3.0

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/xarchiver

Installation of xarchiver

Install xarchiver by running the following commands:

./configure  --prefix=/usr               \
             --libexecdir=/usr/lib/xfce4 \
             --docdir=/usr/share/doc/xarchiver-0.5.4.21 &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Note

This package installs icon files into the /usr/share/icons/hicolor hierarchy and desktop files into the /usr/share/applications hierarchy. You can improve system performance and memory usage by updating /usr/share/icons/hicolor/index.theme and /usr/share/applications/mimeinfo.cache. To perform the update you must have GTK+-2.24.33 or GTK+-3.24.38 installed (for the icon cache) and desktop-file-utils-0.26 (for the desktop cache) and issue the following commands as the root user:

gtk-update-icon-cache -qtf /usr/share/icons/hicolor &&
update-desktop-database -q

Command Explanations

--libexecdir=/usr/lib/xfce4: This switch fixes the location for the thunar-archive-plugin, so it will work if thunar-4.18.6 is installed.

--disable-gtk3: This switch allows building against GTK+2 or use --disable-gtk2 to force building against GTK+3 when GTK+2 is installed.

Contents

Installed Program: xarchiver
Installed Libraries: None
Installed Directories: /usr/lib/xfce4/thunar-archive-plugin, /usr/share/doc/xarchiver-0.5.4.21, and /usr/share/pixmaps/xarchiver

Short Descriptions

xarchiver

is a GTK+ archive manager

xdg-utils-1.1.3

Introduction to xdg-utils

xdg-utils is a set of command line tools that assist applications with a variety of desktop integration tasks. It is required for Linux Standards Base (LSB) conformance.

Warning

A security vulnerability exists in all versions of xdg-utils from version 1.1.0rc1 when handling mailto: URIs. An attacker could potentially send a victim a URI that automatically attaches a sensitive file to a new email. If a victim user does not notice that an attachment was added and sends the email, this could result in sensitive information disclosure.

To mitigate this flaw, either do not use mailto links at all, or always double-check in the user interface that there are no unwanted attachments before sending emails, especially when the email originates from clicking on a mailto link.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

xdg-utils Dependencies

Required

xmlto-0.0.28 with one of Lynx-2.8.9rel.1, Links-2.29, or W3m

Required (runtime)

Xorg Applications

Optional (runtime)

dbus-1.14.8

Installation of xdg-utils

Compile xdg-utils with the following commands:

./configure --prefix=/usr --mandir=/usr/share/man &&
make

Caution

The tests for the scripts must be made from an X-Window based session. There are several run-time requirements to run the tests including a browser and an MTA. Running the tests as root user is not recommended.

To run the tests, issue: make -k test.

Now install it as the root user:

make install

Contents

Installed Programs: xdg-desktop-menu, xdg-desktop-icon, xdg-mime, xdg-icon-resource, xdg-open, xdg-email, xdg-screensaver, xdg-settings
Installed Libraries: None
Installed Directories: None

Short Descriptions

xdg-desktop-menu

is a command line tool for (un)installing desktop menu items

xdg-desktop-icon

is a command line tool for (un)installing icons to the desktop

xdg-mime

is a command line tool for querying information about file type handling and adding descriptions for new file types

xdg-icon-resource

is a command line tool for (un)installing icon resources

xdg-open

opens a file or URL in the user's preferred application

xdg-email

opens the user's preferred e-mail composer in order to send a mail message

xdg-screensaver

is a command line tool for controlling the screensaver

xdg-settings

is a command line tool for managing various settings from the desktop environment

XScreenSaver-6.06

Introduction to XScreenSaver

The XScreenSaver package is a modular screen saver and locker for the X Window System. It is highly customizable and allows the use of any program that can draw on the root window as a display mode. The purpose of XScreenSaver is to display pretty pictures on your screen when it is not in use, in keeping with the philosophy that unattended monitors should always be doing something interesting, just like they do in the movies. However, XScreenSaver can also be used as a screen locker, to prevent others from using your terminal while you are away.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

XScreenSaver Dependencies

Required

GTK+-3.24.38, libglade-2.6.4, and Xorg Applications

Recommended
Optional

GDM-44.1, Linux-PAM-1.5.3, MIT Kerberos V5-1.21.2, and GLE

Installation of XScreenSaver

Install XScreenSaver by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--with-setuid-hacks: This switch allows some demos to be installed setuid root which is needed in order to ping other hosts.

Configuring XScreenSaver

Config Files

/etc/X11/app-defaults/XScreenSaver and ~/.xscreensaver

Linux PAM Configuration

If XScreenSaver has been built with Linux PAM support, you need to create a PAM configuration file, to get it working correctly with BLFS.

Issue the following commands as the root user to create the configuration file for Linux PAM:

cat > /etc/pam.d/xscreensaver << "EOF"
# Begin /etc/pam.d/xscreensaver

auth    include system-auth
account include system-account

# End /etc/pam.d/xscreensaver
EOF

Contents

Installed Programs: xscreensaver, xscreensaver-command, xscreensaver-demo, and xscreensaver-settings
Installed Libraries: None
Installed Directories: /usr/libexec/xscreensaver and /usr/share/xscreensaver

Short Descriptions

xscreensaver

is a screen saver and locker daemon

xscreensaver-command

controls a running xscreensaver process by sending it client messages

xscreensaver-demo

is a symlink to xscreensaver-settings

xscreensaver-settings

is a graphical front-end for setting the parameters used by the background xscreensaver daemon

Part XIII. Multimedia

Chapter 44. Multimedia Libraries and Drivers

Many multimedia programs require libraries and/or drivers in order to function properly. The packages in this section fall into this category. Generally you only need to install these if you are installing a program which has the library listed as either a requirement, or as an option to enable it to support certain functionality.

ALSA-1.2.7

The Linux kernel now provides ALSA support by default. However, applications need to interface to that capability. The following six sections of the book deal with the separate components of ALSA: the libraries, the plugins, the utilities, the tools, the firmware and the OSS compatibility libraries.

alsa-lib-1.2.9

Introduction to ALSA Library

The ALSA Library package contains the ALSA library used by programs (including ALSA Utilities) requiring access to the ALSA sound interface.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

ALSA Library Dependencies

Recommended (Runtime)

Systemd-254

Note

If the recommended runtime dependency is not installed, you may need to run any application requiring ALSA library as the root user or a user in the audio group.

Optional

Doxygen-1.9.7, Python-2.7.18, and alsa-ucm-conf

Kernel Configuration

If needed, enable the following options in the kernel configuration and recompile the kernel:

Device Drivers --->
  <*/M> Sound card support --->                                          [SOUND]
    # Select settings and drivers appropriate for your hardware
    # in the submenu:
    <*/M> Advanced Linux Sound Architecture --->                           [SND]

In the Device Drivers ⇒ Sound card support ⇒ Advanced Linux Sound Architecture section of the kernel configuration, select the settings and drivers appropriate for your hardware. If necessary, recompile and install your new kernel.

Installation of ALSA Library

Install ALSA Library by running the following commands:

./configure &&
make

If you have Doxygen installed and you wish to build the library API documentation, run the following commands from the top-level directory of the source tree:

make doc

To test the results, issue: make check.

Now, as the root user:

make install

To install the API documentation, run the following command as the root user:

install -v -d -m755 /usr/share/doc/alsa-lib-1.2.9/html/search &&
install -v -m644 doc/doxygen/html/*.* \
                /usr/share/doc/alsa-lib-1.2.9/html &&
install -v -m644 doc/doxygen/html/search/* \
                /usr/share/doc/alsa-lib-1.2.9/html/search

Configuring ALSA Library

Config Files

~/.asoundrc and /etc/asound.conf

Configuration Information

The default alsa.conf is adequate for most installations. For extra functionality and/or advanced control of your sound device, you may need to create additional configuration files. For information on the available configuration parameters, visit https://www.alsa-project.org/main/index.php/Asoundrc.

Contents

Installed Program: aserver
Installed Library: libasound.so and libatopology.so
Installed Directories: /usr/include/alsa, /usr/share/alsa and /usr/share/doc/alsa-lib-1.2.9

Short Descriptions

aserver

is the ALSA server

libasound.so

contains the ALSA API functions

libatopology.so

contains API functions for the ALSA topologies

alsa-plugins-1.2.7.1

Introduction to ALSA Plugins

The ALSA Plugins package contains plugins for various audio libraries and sound servers.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

ALSA Plugins Dependencies

Required

alsa-lib-1.2.9

Optional

FFmpeg-6.0, libsamplerate-0.2.2, PulseAudio-16.1, Speex-1.2.1, JACK, libavtp, and maemo

Installation of ALSA Plugins

Install ALSA Plugins by running the following commands:

./configure --sysconfdir=/etc &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: Numerous libasound_module_<module>.so modules including conf_pulse, ctl_arcam_av, ctl_oss, ctl_pulse, pcm_a52, pcm_jack, pcm_oss, pcm_pulse, pcm_speex, pcm_upmix, pcm_usb_stream, pcm_vdownmix, rate_lavrate*, rate_samplerate*, and rate_speexrate*
Installed Directories: /usr/lib/alsa-lib

Short Descriptions

libasound_module_pcm_oss.so

Allows native ALSA applications to run on OSS

libasound_module_pcm_upmix.so

Allows upmixing sound to 4 or 6 channels

libasound_module_pcm_vdownmix.so

Allows downmixing sound from 4-6 channels to 2 channel stereo output

libasound_module_pcm_jack.so

Allows native ALSA applications to work with jackd

libasound_module_pcm_pulse.so

Allows native ALSA applications to access a PulseAudio sound daemon

libasound_module_pcm_a52.so

Converts S16 linear sound format to A52 compressed format and sends it to an SPDIF output

libasound_module_rate_samplerate.so

Provides an external rate converter through libsamplerate

alsa-utils-1.2.9

Introduction to ALSA Utilities

The ALSA Utilities package contains various utilities which are useful for controlling your sound card.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

ALSA Utilities Dependencies

Required

alsa-lib-1.2.9

Optional

docutils-0.20.1, fftw-3.3.10, libsamplerate-0.2.2, xmlto-0.0.28, and Dialog

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/alsa-utils

Installation of ALSA Utilities

This package provides its own implementation of strlcpy and strlcat functions. But they are provided by Glibc-2.38 now, so we need to remove the custom implementation to avoid a conflict with the Glibc header:

echo '' > alsactl/init_sysdeps.c

Install ALSA Utilities by running the following commands:

./configure --disable-alsaconf \
            --disable-bat   \
            --disable-xmlto \
            --with-curses=ncursesw &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--disable-alsaconf: This switch disables building the alsaconf configuration tool which is incompatible with Udev.

--disable-xmlto: Omit this switch if you have installed xmlto-0.0.28 and wish to regenerate the man pages.

--disable-bat: Omit this switch if you have installed fftw-3.3.10 and wish to install the Basic Audio Tester (BAT).

--with-curses=ncursesw: This switch forces the use of wide-character ncurses libraries.

Configuring ALSA Utilities

Config Files

/var/lib/alsa/asound.state

Configuration Information

As the root user, apply the default setting for the sound card:

alsactl init

Note that all channels of your sound card may be muted by default. You can use the alsamixer program to change this. Use speaker-test to check that your settings have been applied correctly. You should hear pink noise on your speakers.

The alsactl program is normally run from a standard udev rule. The first time it is run, it will complain that there is no state in /var/lib/alsa/asound.state. You can prevent this by running the following command as the root user:

alsactl -L store

The volume settings should be restored from the saved state by Udev when the device is detected (during boot or when plugged in for USB devices).

On systems which have multiple sound cards, you may need to adjust the default audio device so that you can get output from your speakers. To set the default device, first check the /proc/asound/cards file to determine which number you need to set. After you know this information, set the default card with the following command as the root user:

cat > /etc/asound.conf << "EOF"
# Begin /etc/asound.conf

defaults.pcm.card 1
defaults.ctl.card 1

# End /etc/asound.conf
EOF

Contents

Installed Programs: aconnect, alsactl, alsaloop, alsamixer, alsatplg, alsaucm, alsa-info.sh, amidi, amixer, aplay, aplaymidi, arecord (symlink), arecordmidi, aseqdump, aseqnet, axfer, iecset, and speaker-test
Installed Libraries: None
Installed Directories: /usr/share/sounds/alsa and /var/lib/alsa

Short Descriptions

aconnect

is a utility for connecting and disconnecting two existing ports in the ALSA sequencer system

alsactl

is used to control advanced settings for ALSA sound card drivers. Use this if alsamixer cannot utilize all of your sound card's features

alsaloop

allows creation of a PCM loopback between a PCM capture device and a PCM playback device

alsamixer

is an Ncurses based mixer program for use with the ALSA sound card drivers

alsatplg

is a utility used to compile topology configuration files into binary files for kernel drivers

alsaucm

allows applications to access the hardware in an abstracted manner

amidi

is used to read from and write to ALSA RawMIDI ports

amixer

allows command-line control of the mixers for the ALSA sound card drivers

aplay

is a command-line soundfile player for the ALSA sound card drivers

aplaymidi

is a command-line utility that plays the specified MIDI file(s) to one or more ALSA sequencer ports

arecord

is a command-line soundfile recorder for the ALSA sound card drivers

arecordmidi

is a command-line utility that records a standard MIDI file from one or more ALSA sequencer ports

aseqdump

is a command-line utility that prints the sequencer events it receives as text

aseqnet

is an ALSA sequencer client which sends and receives event packets over a network

axfer

is a command-line recorder and player used to transfer audio frames between sound devices and files

iecset

is a small utility to set or dump the IEC958 (or so-called S/PDIF) status bits of the specified sound card via the ALSA control API

speaker-test

is a command-line speaker test tone generator for ALSA

alsa-tools-1.2.5

Introduction to ALSA Tools

The ALSA Tools package contains advanced tools for certain sound cards.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

ALSA Tools Dependencies

Required

alsa-lib-1.2.9

Optional

GTK+-2.24.33 (to build echomixer, envy24control and rmedigicontrol), GTK+-3.24.38 (to build hdajackretask) and FLTK-1.3.8 (to build hdspconf and hdspmixer)

Installation of ALSA Tools

Note

When installing multiple packages in a script, the installation needs to be done as the root user. There are three general options that can be used to do this:

  1. Run the entire script as the root user (not recommended).

  2. Use the sudo command from the Sudo-1.9.14p3 package.

  3. Use su -c "command arguments" (quotes required) which will ask for the root password for every iteration of the loop.

One way to handle this situation is to create a short bash function that automatically selects the appropriate method. Once the command is set in the environment, it does not need to be set again.

as_root()
{
  if   [ $EUID = 0 ];        then $*
  elif [ -x /usr/bin/sudo ]; then sudo $*
  else                            su -c \\"$*\\"
  fi
}

export -f as_root

First, start a subshell that will exit on error:

bash -e

Now, remove a tool that needs Qt2 or 3 and two unneeded files (for the BLFS instructions below):

rm -rf qlo10k1 Makefile gitcompile

The ALSA Tools package is only needed by those with advanced requirements for their sound card. The tools can be built all together at once, but if only a subset is needed, you need to cd into the directory of each tool you wish to compile and run the commands. Here, we present instructions to build all tools.

Install all ALSA Tools by running the following commands:

for tool in *
do
  case $tool in
    seq )
      tool_dir=seq/sbiload
    ;;
    * )
      tool_dir=$tool
    ;;
  esac

  pushd $tool_dir
    ./configure --prefix=/usr
    make
    as_root make install
    as_root /sbin/ldconfig
  popd

done
unset tool tool_dir

Finally, exit the shell that was started earlier:

exit

Contents

Installed Programs: as10k1, cspctl, dl10k1, echomixer, envy24control, hda-verb, hdajackretask, hdajacksensetest, hdspconf, hdsploader, hdspmixer, hwmixvolume, init_audigy, init_audigy_eq10, init_live, lo10k1, ld10k1, ld10k1d, mixartloader, pcxhrloader, rmedigicontrol, sbiload, sscape_ctl, us428control, usx2yloader, and vxloader
Installed Library: liblo10k1.so
Installed Directories: /etc/hotplug, /usr/include/lo10k1, /usr/share/ld10k1, and /usr/share/sounds

Short Descriptions

as10k1

is an assembler for the emu10k1 DSP chip present in the Creative SB Live, PCI 512, and emu APS sound cards. It is used to make audio effects such as a flanger, chorus or reverb

cspctl

is an SB16/AWE32 Creative Signal Processor (ASP/CSP) control program

echomixer

is the Linux equivalent of the Echoaudio console application from Echoaudio. It is a tool to control all the features of any Echoaudio soundcard. This includes clock sources, input and output gains, mixers, etc

envy24control

is a control tool for Envy24 (ice1712) based sound cards

hdajackretask

is a GUI to make it easy to retask your jacks - e g, turn your Mic jack into an extra Headphone, or why not make them both line outs and connect them to your surround receiver

hda-verb

is a small program to send HD-audio commands to the given ALSA hwdep device on the hd-audio interface

hdspconf

is a GUI to control the Hammerfall HDSP Alsa Settings. Up to four hdsp cards are supported

hdsploader

is used to load the firmware required by the Hammerfall HDSP sound cards

hdspmixer

is the Linux equivalent of the Totalmix application from RME. It is a tool to control the advanced routing features of the RME Hammerfall DSP soundcard series

hwmixvolume

allows you to control the volume of individual streams on sound cards that use hardware mixing

init_audigy*

are tools used to initialize Creative Sound Blaster Audigy-series cards

init_live

is a tool used to initialize Creative Sound Blaster Live cards

ld10k1

is the server of a EMU10K{1,2} patch loader for ALSA

lo10k1

is the client of a EMU10K{1,2} patch loader for ALSA

dl10k1

loads config dumps generated by lo10k1 and ld10k1

ld10k1d

is an init script for the ld10k1 patch loader

mixartloader

is a helper program to load the firmware binaries onto the Digigram's miXart board sound drivers. The following modules require this program: snd-mixart. These drivers don't work properly at all until the certain firmware files are loaded, i.e. no PCM nor mixer devices will appear

pcxhrloader

is a helper program to load the firmware binaries onto Digigram's pcxhr compatible board sound drivers. The following modules require this program: snd-pcxhr. These drivers don't work properly at all until certain firmware files are loaded, i.e. no PCM nor mixer devices will appear

rmedigicontrol

is a control tool for RME Digi32 and RME Digi96 sound cards. It provides a graphical frontend for all the sound card controls and switches

sbiload

is an OPL2/3 FM instrument loader for the ALSA sequencer

sscape_ctl

is an ALSA SoundScape control utility

us428control

is a Tascam US-428 control program

usx2yloader

is a helper program to load the 2nd Phase firmware binaries onto the Tascam USX2Y USB sound cards. It has proven to work so far for the US122, US224 and US428. The snd-usb-usx2y module requires this program

vxloader

is a helper program to load the firmware binaries onto the Digigram's VX-board sound drivers. The following modules require this program: snd-vx222, snd-vxpocket, snd-vxp440. These drivers don't work properly at all until the certain firmware files are loaded, i.e. no PCM nor mixer devices will appear

alsa-firmware-1.2.4

Introduction to ALSA Firmware

The ALSA Firmware package contains firmware for certain sound cards.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

ALSA Firmware Dependencies

Required

alsa-tools-1.2.5

Optional

AS31 (for rebuilding the firmware from source)

Installation of ALSA Firmware

The ALSA Firmware package is only needed by those with advanced requirements for their sound card. See the README for configure options.

Install ALSA Firmware by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: Several directories in /lib/firmware and /usr/share/alsa/firmware

alsa-oss-1.1.8

Introduction to alsa-oss

The alsa-oss package contains the alsa-oss compatibility library. This is used by programs which wish to use the alsa-oss sound interface.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

ALSA OSS Dependencies

Required

alsa-lib-1.2.9

Installation of ALSA OSS

Install ALSA OSS by running the following commands:

./configure --disable-static &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Program: aoss
Installed Libraries: libalsatoss.so, libaoss.so, and libossredir.a
Installed Directories: None

Short Descriptions

aoss

is a simple wrapper script which facilitates the use of the ALSA oss compatibility library. It just sets the appropriate LD_PRELOAD path and then runs the command

AudioFile-0.3.6

Introduction to AudioFile

The AudioFile package contains the audio file libraries and two sound file support programs useful to support basic sound file formats.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

AudioFile Dependencies

Required

alsa-lib-1.2.9

Recommended
Optional

asciidoc-10.2.0 and Valgrind-3.21.0

Installation of AudioFile

Install AudioFile by running the following commands:

patch -Np1 -i ../audiofile-0.3.6-consolidated_patches-1.patch &&
autoreconf -fiv                             &&

./configure --prefix=/usr --disable-static  &&

make

Now, as the root user:

make install

To test the results, issue: make check. Note that the tests will fail if the --disable-static option is used and tests are executed before make install. You have three options:

(a) configure without --disable-static, run the tests, but do not install, then start a fresh build using --disable-static just for installing the package.

(b) configure with --disable-static, but only run the tests after the package is installed.

(c) configure with --disable-static, but only run the tests after a DESTDIR install.

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: sfconvert and sfinfo
Installed Libraries: libaudiofile.so
Installed Directories: None

Short Descriptions

sfinfo

displays the sound file format, audio encoding, sampling rate and duration for audio formats supported by this library

sfconvert

converts sound file formats where the original format and destination format are supported by this library

libaudiofile.so

contains functions used by programs to support AIFF, AIFF-compressed, Sun/NeXT, WAV and BIC audio formats

FAAC-1_30

Introduction to FAAC

FAAC is an encoder for a lossy sound compression scheme specified in MPEG-2 Part 7 and MPEG-4 Part 3 standards and known as Advanced Audio Coding (AAC). This encoder is useful for producing files that can be played back on iPod. Moreover, iPod does not understand other sound compression schemes in video files.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of FAAC

Install FAAC by running the following commands:

./bootstrap                                &&
./configure --prefix=/usr --disable-static &&
make

This package does not come with a test suite. However, basic functionality can be tested by encoding a sample WAV file (the sample file is installed by the alsa-utils-1.2.9 package:

./frontend/faac -o Front_Left.mp4 /usr/share/sounds/alsa/Front_Left.wav

Then, decode the result using the faad program from the FAAD2-2.10.1 package and play back the decoded file (requires the aplay program from the alsa-utils-1.2.9 package:

faad Front_Left.mp4
aplay Front_Left.wav

aplay should identify the file as Signed 16 bit Little Endian, Rate 48000 Hz, Stereo, and you should hear the words front left.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Other AAC encoders

The quality of FAAC is not up to par with the best AAC encoders currently available. Also, it only supports AAC and not High Efficiency AAC (also known as aacPlus), which provides better quality at low bitrates by means of using the spectral band replication technology. There are the following alternative programs for producing AAC and HE-AAC streams:

  • Nero AAC Codec: available only in the binary form, the command-line AAC and HE-AAC encoders for Linux are in the same archive as the Windows application.

  • 3GPP Enhanced aacPlus general audio codec: available in the source form, can encode only HE-AAC up to 48 kbps out of the box, but the maximum bitrate can be changed by editing the tuning table in the FloatFR_sbrenclib/src/sbr_main.c file.

Note, however, that iPod supports only Low Complexity AAC profile, which is the default in FAAC, but may not be the default in Nero AAC Encoder and is completely unavailable in the 3GPP encoder.

Contents

Installed Program: faac
Installed Libraries: libfaac.so and libmp4v2.so
Installed Directories: None

Short Descriptions

faac

is a command-line AAC encoder

libfaac.so

contains functions for encoding AAC streams

libmp4v2.so

contains functions for creating and manipulating MP4 files

FAAD2-2.10.1

Introduction to FAAD2

FAAD2 is a decoder for a lossy sound compression scheme specified in MPEG-2 Part 7 and MPEG-4 Part 3 standards and known as Advanced Audio Coding (AAC).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Installation of FAAD2

Install FAAD2 by running the following commands:

./bootstrap                                &&
./configure --prefix=/usr --disable-static &&
make

This package does not come with a test suite. However, basic functionality can be tested by decoding the sample AAC file:

./frontend/faad -o sample.wav ../sample.aac

This should display a copyright message and the following information about the sample file:

sample.aac file info:
ADTS, 4.608 sec, 13 kbps, 16000 Hz


  ---------------------
 | Config:  2 Ch       |
  ---------------------
 | Ch |    Position    |
  ---------------------
 | 00 | Left front     |
 | 01 | Right front    |
  ---------------------

Now play the result (requires the aplay program from the alsa-utils-1.2.9 package):

aplay sample.wav

aplay should identify the file as Signed 16 bit Little Endian, Rate 16000 Hz, Stereo, and you should hear some piano notes.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Program: faad
Installed Library: libfaad.so and libfaad_drm.so
Installed Directories: None

Short Descriptions

faad

is a command-line utility for decoding AAC and MP4 files

libfaad.so

contains functions for decoding AAC streams

fdk-aac-2.0.2

Introduction to fdk-aac

fdk-aac package provides the Fraunhofer FDK AAC library, which is purported to be a high quality Advanced Audio Coding implementation.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of fdk-aac

Install fdk-aac by running the following commands:

./configure --prefix=/usr --disable-static &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Library: libfdk-aac.so
Installed Directory: /usr/include/fdk-aac

Short Descriptions

libfdk-aac.so

provides the functions used to encode audio in AAC format

FLAC-1.4.3

Introduction to FLAC

FLAC is an audio CODEC similar to MP3, but lossless, meaning that audio is compressed without losing any information.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://downloads.xiph.org/releases/flac/flac-1.4.3.tar.xz

  • Download MD5 sum: 7cab20b46e0bc859234bf5ba7da81625

  • Download size: 1.0 MB

  • Estimated disk space required: 22 MB (additional 163 MB to run the test suite)

  • Estimated build time: 0.2 SBU (additional 0.6 SBU to run the test suite)

FLAC Dependencies

Optional

libogg-1.3.5, DocBook-utils-0.6.14, Doxygen-1.9.7, and Valgrind-3.21.0

Installation of FLAC

Install FLAC by running the following commands:

./configure --prefix=/usr                                \
            --disable-thorough-tests                     \
            --docdir=/usr/share/doc/flac-1.4.3          &&
make

To test the results, issue: make check. Note that if you passed the --enable-exhaustive-tests and --enable-valgrind-testing parameters to configure and then run the test suite, it will take a very long time (up to 300 SBUs) and use about 375 MB of disk space.

Now, as the root user:

make install

Command Explanations

--disable-thorough-tests: This parameter is used so that the test suite will complete in a reasonable amount of time. Remove it if you desire more extensive tests.

Contents

Installed Programs: flac and metaflac
Installed Libraries: libFLAC.so and libFLAC++.so
Installed Directories: /usr/include/FLAC, /usr/include/FLAC++ and /usr/share/doc/flac-1.4.3

Short Descriptions

flac

is a command-line utility for encoding, decoding and converting FLAC files

metaflac

is a program for listing, adding, removing, or editing metadata in one or more FLAC files

libFLAC{,++}.so

these libraries provide native FLAC and Ogg FLAC C/C++ APIs for programs utilizing FLAC

frei0r-plugins-1.8.0

Introduction to Frei0r-plugins

Frei0r is a minimalistic plugin API for video effects. Note that the 0 in the name is a zero, not a capital letter o.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Frei0r-plugins Dependencies

Recommended

gavl-1.4.0

Optional

Doxygen-1.9.7 and opencv-4.8.0

Installation of Frei0r-plugins

Install Frei0r by running the following commands:

mkdir -vp build &&
cd        build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -Wno-dev ..                 &&

make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

-DWITHOUT_OPENCV=TRUE: This option instructs the make procedure to disable building plugins dependent upon opencv.

-DWITHOUT_GAVL=TRUE: This option instructs the make procedure to disable building plugins dependent upon gavl.

Contents

Installed Program: None
Installed Libraries: Over 130 video effects plugins
Installed Directories: /usr/lib/frei0r-1

gavl-1.4.0

Introduction to Gavl

Gavl is short for Gmerlin Audio Video Library. It is a low level library that handles the details of audio and video formats like colorspaces, samplerates, multichannel configurations etc. It provides standardized definitions for those formats as well as container structures for carrying audio samples or video images inside an application.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Gavl Dependencies

Required

libpng-1.6.40

Optional

Doxygen-1.9.7

Installation of Gavl

Install Gavl by running the following commands:

LIBS=-lm                      \
./configure --prefix=/usr     \
            --without-doxygen \
            --docdir=/usr/share/doc/gavl-1.4.0 &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

LIBS=-lm: This variable ensures the math library is searched when linking.

--without-doxygen: This switch disables use of Doxygen. Omit if Doxygen is installed and you wish to build the API documentation.

Contents

Installed Program: None
Installed Libraries: libgavl.so
Installed Directories: /usr/include/gavl and /usr/share/doc/gavl-1.4.0

Short Descriptions

libgavl.so

is the Gmerlin Audio Video Library

gstreamer-1.22.5

Introduction to gstreamer

gstreamer is a streaming media framework that enables applications to share a common set of plugins for tasks such as video encoding and decoding, audio encoding and decoding, audio and video filters, audio visualisation, web streaming and anything else that streams in real-time or otherwise. This package only provides base functionality and libraries. You may need at least gst-plugins-base-1.22.5 and one of Good, Bad, Ugly or Libav plugins.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

gstreamer Dependencies

Required

GLib-2.76.4

Recommended
Optional

GTK+-3.24.38 (for examples), Gsl-2.7.1 (used by one test if installed), libunwind-1.6.2, Valgrind-3.21.0, bash-completion, hotdoc, and libdw

Installation of gstreamer

Install gstreamer by running the following commands:

mkdir build &&
cd    build &&

meson  setup ..            \
       --prefix=/usr       \
       --buildtype=release \
       -Dgst_debug=false   \
       -Dpackage-origin=https://www.linuxfromscratch.org/blfs/view/12.0-systemd/ \
       -Dpackage-name="GStreamer 1.22.5 BLFS" &&
ninja

To test the results, issue: ninja test.

Caution

If you are reinstalling gstreamer from a previous version, it is best if you remove the prior version, including plugins, before installing the new version. If there is a mixture of versions installed, using processes may hang or not work properly. As the root user:

rm -rf /usr/bin/gst-* /usr/{lib,libexec}/gstreamer-1.0

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Programs: gst-inspect-1.0, gst-launch-1.0, gst-stats-1.0, gst-tester-1.0, and gst-typefind-1.0
Installed Libraries: libgstbase-1.0.so, libgstcheck-1.0.so, libgstcontroller-1.0.so, libgstnet-1.0.so, and libgstreamer-1.0.so
Installed Directories: /usr/{include,lib,libexec,share}/gstreamer-1.0

Short Descriptions

gst-inspect-1.0

is a tool that prints out information on available gstreamer plugins, information about a particular plugin, or information about a particular element

gst-launch-1.0

is a tool that builds and runs basic gstreamer pipelines

gst-stats-1.0

is a tool used to gather statistics about gstreamer operations

gst-tester-1.0

runs a test plan in TAP compatible format while integrating with the meson test harness

gst-typefind-1.0

uses the gstreamer type finding system to determine the relevant gstreamer plugin to parse or decode files, and the corresponding MIME type

libgstbase-1.0.so

provides some base classes to be extended by elements and utility classes that are most useful for plugin developers

libgstcheck-1.0.so

provides functionality for writing unit tests that use the check framework

libgstcontroller-1.0.so

provides functionality to animate element properties over time

libgstnet-1.0.so

provides network elements and objects

libgstreamer-1.0.so

provides all of the core gstreamer services, including initialization, plugin management and types, as well as the object hierarchy that defines elements and bins, along with some more specialized elements

gst-plugins-base-1.22.5

Introduction to GStreamer Base Plug-ins

The GStreamer Base Plug-ins is a well-groomed and well-maintained collection of GStreamer plug-ins and elements, spanning the range of possible types of elements one would want to write for GStreamer. You will need at least one of Good, Bad, Ugly or Libav plugins for GStreamer applications to function properly.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GStreamer Base Plug-ins Dependencies

Required

gstreamer-1.22.5

Recommended
Optional

graphene-1.10.8, GTK+-3.24.38 (for examples), Opus-1.3.1, (Qt-5.15.10 or qt-alternate-5.15.10) (for examples), SDL2-2.28.2, Valgrind-3.21.0, hotdoc, libvisual, Orc, and Tremor

Installation of GStreamer Base Plug-ins

Note

If you need a plugin for a given dependency, that dependency needs to be installed before this package.

Install GStreamer Base Plug-ins by running the following commands:

mkdir build &&
cd    build &&

meson  setup ..               \
       --prefix=/usr          \
       --buildtype=release    \
       --wrap-mode=nodownload \
       -Dpackage-origin=https://www.linuxfromscratch.org/blfs/view/12.0-systemd/ \
       -Dpackage-name="GStreamer 1.22.5 BLFS"    &&
ninja

To test the results, issue: ninja test. The tests require an X terminal running, or all of the GL tests will fail. Five tests may produce timeouts on some systems depending on their graphics hardware and speed.

Note

When installing, the build process does some additional linking. If you do not have Xorg in /usr, the LIBRARY_PATH variable needs to be defined for the root user. If using sudo to assume root, use the -E option to pass your current environment variables for the install process.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

--wrap-mode=nodownload: This switch prevents meson from downloading any optional dependency which is not installed on the system.

Contents

Installed Programs: gst-device-monitor-1.0, gst-discoverer-1.0, and gst-play-1.0
Installed Libraries: libgstallocators-1.0.so, libgstapp-1.0.so, libgstaudio-1.0.so, libgstfft-1.0.so, libgstgl-1.0.so, libgstpbutils-1.0.so, libgstriff-1.0.so, libgstrtp-1.0.so, libgstrtsp-1.0.so, libgstsdp-1.0.so, libgsttag-1.0.so, libgstvideo-1.0.so, and several plugins under /usr/lib/gstreamer-1.0
Installed Directories: /usr/include/gstreamer-1.0/gst/{allocators,app,audio,fft,gl,pbutils}, /usr/include/gstreamer-1.0/gst/{riff,rtp,rtsp,sdp,tag,video}, and /usr/share/gst-plugins-base

Short Descriptions

gst-device-monitor-1.0

is a command line tool that can be used to test GStreamer's device monitoring functionality

gst-discoverer-1.0

is a tool that can be used to print basic metadata and stream information about a media file

gst-play-1.0

is a command line tool that can be used to test basic playback using the playbin element

gst-plugins-good-1.22.5

Introduction to GStreamer Good Plug-ins

The GStreamer Good Plug-ins is a set of plug-ins considered by the GStreamer developers to have good quality code, correct functionality, and the preferred license (LGPL for the plug-in code, LGPL or LGPL-compatible for the supporting library). A wide range of video and audio decoders, encoders, and filters are included.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GStreamer Good Plug-ins Dependencies

Required

gst-plugins-base-1.22.5

Recommended
Optional

AAlib-1.4rc5, ALSA OSS-1.1.8, GTK+-3.24.38 (for examples), libdv-1.0.0, (Qt-5.15.10 or qt-alternate-5.15.10), Speex-1.2.1, taglib-1.13.1, Valgrind-3.21.0, v4l-utils-1.24.1, Wayland-1.22.0, hotdoc, JACK, libcaca, libavc1394, libiec61883, libraw1394, libshout, Orc, TwoLame, and WavPack

Installation of GStreamer Good Plug-ins

Note

If you need a plugin for a given dependency, that dependency needs to be installed before this package.

Install GStreamer Good Plug-ins by running the following commands:

mkdir build &&
cd    build &&

meson setup ..            \
      --prefix=/usr       \
      --buildtype=release \
      -Dpackage-origin=https://www.linuxfromscratch.org/blfs/view/12.0-systemd/ \
      -Dpackage-name="GStreamer 1.22.5 BLFS" &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Programs: None
Installed Libraries: Several plugins under /usr/lib/gstreamer-1.0
Installed Directories: /usr/share/gstreamer-1.0/presets

gst-plugins-bad-1.22.5

Introduction to GStreamer Bad Plug-ins

The GStreamer Bad Plug-ins package contains a set of plug-ins that aren't up to par compared to the rest. They might be close to being good quality, but they're missing something - be it a good code review, some documentation, a set of tests, a real live maintainer, or some actual wide use.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GStreamer Bad Plug-ins Dependencies

Required

gst-plugins-base-1.22.5

Recommended
Optional

BlueZ-5.68, cURL-8.2.1, FAAC-1_30, FAAD2-2.10.1, fdk-aac-2.0.2, GTK+-3.24.38 (for examples), gst-plugins-good-1.22.5 (for one test), JSON-GLib-1.6.6, Little CMS-2.14, libaom-3.6.1, libass-0.17.1, libexif-0.6.24 (for one test), librsvg-2.56.3, libsoup-2.74.3 (for one test), libsndfile-1.2.2, libssh2-1.11.0, libusb-1.0.26, libva-2.19.0, libwebp-1.3.1, libxkbcommon-1.5.0, neon-0.32.5, Nettle-3.9.1 or libgcrypt-1.10.2 (for SSL support in the hls plugin, if both are not installed OpenSSL will be used instead), opencv-4.8.0 (with additional modules), OpenJPEG-2.5.0, Opus-1.3.1, qrencode-4.1.1, SBC-2.0, sdl12-compat-1.2.64, Valgrind-3.21.0, Wayland-1.22.0 (GTK+-3.24.38 must have been compiled with wayland support), wpebackend-fdo-1.14.2, x265-20230215, bs2b, Chromaprint, dssim, Flite, FluidSynth, Game Music Emu, GSM, hotdoc, LADSPA, ldacBT, libavtp, libdc1394-2, libdca, libde265, libkate, libmfx, libmms, libmodplug, libnice, libofa, libopenmpt, libopenni, libsrtp, lilv, LRDF, ltc-tools, microdns, MJPEG Tools, mplex2, musepack, onnxruntime, OpenAL, OpenEXR, OpenH264, Orc, rtmpdump, spandsp, Srt, svthevcenc, VO AAC, VO AMRWB, Vulkan, WildMidi, WPE-WebKit, ZBAR, ZVBI, and zxing

Installation of GStreamer Bad Plug-ins

Note

If you need a plugin for a given dependency, that dependency needs to be installed before this package.

Install GStreamer Bad Plug-ins by running the following commands:

mkdir build &&
cd    build &&

meson  setup ..            \
       --prefix=/usr       \
       --buildtype=release \
       -Dgpl=enabled       \
       -Dpackage-origin=https://www.linuxfromscratch.org/blfs/view/12.0-systemd/ \
       -Dpackage-name="GStreamer 1.22.5 BLFS" &&
ninja

To test the results, issue: ninja test. Several tests need a terminal emulator in a graphical session. One test, elements_vacompositor, is known to fail. If gst-plugins-good-1.22.5 is not installed, two tests elements_rtpsrc and elements_rtpsink will fail.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dgpl=enabled: Without this switch, plugins with dependencies on (A)GPL licensed libraries are not built.

Contents

Installed Programs: gst-transcoder-1.0 and playout
Installed Libraries: libgstadaptivedemux-1.0.so, libgstbadaudio-1.0.so, libgstbasecamerabinsrc-1.0.so, libgstcuda-1.0.so, libgstcodecparsers-1.0.so, libgstcodecs-1.0.so, libgstinsertbin-1.0.so, libgstisoff-1.0.so, libgstmpegts-1.0.so, libgstphotography-1.0.so, libgstplay-1.0.so, libgstplayer-1.0.so, libgstsctp-1.0.so, libgsttranscoder-1.0.so, libgsturidownloader-1.0.so, libgstva-1.0.so, libgstwayland-1.0.so, libgstwebrtc-1.0.so, and several plugins under /usr/lib/gstreamer-1.0
Installed Directories: /usr/include/gstreamer-1.0/gst/{audio,basecamerabinsrc,cuda}, /usr/include/gstreamer-1.0/gst/{codecparsers,insertbin,interfaces}, /usr/include/gstreamer-1.0/gst/{isoff,mpegts,play,player,sctp} /usr/include/gstreamer-1.0/gst/{transcoder,uridownloader,va}, and /usr/include/gstreamer-1.0/gst/{wayland,webrtc}

Short Descriptions

gst-transcoder-1.0

is used to transcode a stream into a different format

playout

is an example application used to sequentially play a list of audio-video files

gst-plugins-ugly-1.22.5

Introduction to GStreamer Ugly Plug-ins

The GStreamer Ugly Plug-ins is a set of plug-ins considered by the GStreamer developers to have good quality and correct functionality, but distributing them might pose problems. The license on either the plug-ins or the supporting libraries might not be how the GStreamer developers would like. The code might be widely known to present patent problems.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GStreamer Ugly Plug-ins Dependencies

Required

gst-plugins-base-1.22.5

Recommended
Optional

libmpeg2-0.5.1, libcdio-2.1.0 (for CD-ROM drive access), Valgrind-3.21.0, hotdoc, libsidplay, OpenCore AMR, Orc, and TwoLame

Installation of GStreamer Ugly Plug-ins

Note

If you need a plugin for a given dependency, that dependency needs to be installed before this package.

Install GStreamer Ugly Plug-ins by running the following commands:

mkdir build &&
cd    build &&

meson  setup ..            \
       --prefix=/usr       \
       --buildtype=release \
       -Dgpl=enabled       \
       -Dpackage-origin=https://www.linuxfromscratch.org/blfs/view/12.0-systemd/ \
       -Dpackage-name="GStreamer 1.22.5 BLFS" &&
ninja

To test the results, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dgpl=enabled: Without this switch, plugins with dependencies on (A)GPL licensed libraries are not built.

Contents

Installed Programs: None
Installed Libraries: Several plugins under /usr/lib/gstreamer-1.0
Installed Directories: None

gst-libav-1.22.5

Introduction to GStreamer Libav

The GStreamer Libav package contains GStreamer plugins for Libav (a fork of FFmpeg).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

GStreamer Libav Dependencies

Required

FFmpeg-6.0 and gst-plugins-base-1.22.5

Recommended
Optional

hotdoc

Installation of GStreamer Libav

Install GStreamer Libav by running the following commands:

mkdir build &&
cd    build &&

meson  setup ..            \
       --prefix=/usr       \
       --buildtype=release \
       -Dpackage-origin=https://www.linuxfromscratch.org/blfs/view/12.0-systemd/ \
       -Dpackage-name="GStreamer 1.22.5 BLFS" &&
ninja

To run the tests, issue: ninja test.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Programs: None
Installed Library: libgstlibav.so in /usr/lib/gstreamer-1.0 directory
Installed Directory: None

gstreamer-vaapi-1.22.5

Introduction to gstreamer-vaapi

The gstreamer-vaapi package contains a gstreamer plugin for hardware accelerated video decode/encode for the prevailing coding standards today (MPEG-2, MPEG-4 ASP/H.263, MPEG-4 AVC/H.264, and VC-1/VMW3).

Note

On systems without hardware acceleration (notably virtual machines under qemu-8.1.0), this package may cause the X server to crash. The BLFS team recommends not to install this package in this case.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

gstreamer-vaapi Dependencies

Required

GTK+-3.24.38, gstreamer-1.22.5, gst-plugins-base-1.22.5, gst-plugins-bad-1.22.5, and libva-2.19.0

Optional

hotdoc

Installation of gstreamer-vaapi

Install gstreamer-vaapi by running the following commands:

mkdir build &&
cd    build &&

meson setup ..            \
      --prefix=/usr       \
      --buildtype=release \
      -Dpackage-origin=https://www.linuxfromscratch.org/blfs/view/12.0-systemd/ &&
ninja

This package does not come with a working test suite.

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

Contents

Installed Programs: None
Installed Library: libgstvaapi.so in /usr/lib/gstreamer-1.0
Installed Directory: None

id3lib-3.8.3

Introduction to id3lib

id3lib is a library for reading, writing and manipulating id3v1 and id3v2 multimedia data containers.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Installation of Id3lib

Install id3lib by running the following commands:

patch -Np1 -i ../id3lib-3.8.3-consolidated_patches-1.patch &&

libtoolize -fc                &&
aclocal                       &&
autoconf                      &&
automake --add-missing --copy &&

./configure --prefix=/usr --disable-static &&
make

This packages does not come with a working test suite.

Now, as the root user:

make install  &&
cp doc/man/* /usr/share/man/man1 &&

install -v -m755 -d /usr/share/doc/id3lib-3.8.3 &&
install -v -m644 doc/*.{gif,jpg,png,ico,css,txt,php,html} \
                    /usr/share/doc/id3lib-3.8.3

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: id3convert, id3cp, id3info, and id3tag
Installed Library: libid3.so
Installed Directories: /usr/include/id3 and /usr/share/doc/id3lib-3.8.3

Short Descriptions

id3convert

converts between id3v1/v2 tagging formats

id3cp

extracts id3v1/v2 tags from digital audio files

id3info

prints id3v1/v2 tag contents

id3tag

is a utility for editing id3v1/v2 tags

libid3.so

provides functions for the id3v1/v2 tag editing programs as well as other external programs and libraries

intel-media-23.3.2

Introduction to intel-media

The intel-media package provides a VA API driver for Intel GPUs that are provided with Broadwell CPUs and higher. This includes support for a variety of codecs.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Note

The tarball intel-media-23.3.2.tar.gz will extract to the directory media-driver-intel-media-23.3.2.

intel-media Dependencies

Required

CMake-3.27.2, Intel-gmmlib-22.3.10, libva-2.19.0, and Xorg build environment

Kernel Configuration

Enable the following options in the kernel configuration. Recompile the kernel if necessary:

Device Drivers --->
  Graphics support --->
    <*/M> Direct Rendering Manager (XFree86 4.1.0 and higher DRI support) --->
                                                                      ...  [DRM]
    <*/M> Intel 8xx/9xx/G3x/G4x/HD Graphics                           [DRM_I915]

Installation of intel-media

Note

This package takes a long time to build because it compiles code specific to each individual generation of Intel GPUs and for a variety of media codecs.

If you know the model of your Intel GPU, you can pass the -D{GEN{8,9,10,11,12},MTL}=OFF option to the cmake command but leaving the option for your GPU out. Note that the GEN number here is the generation of the GPU, not the CPU. For example, with an Intel Core i7-1065G7 CPU shipping a 11th-generation Intel GPU, the -D{GEN{8,9,10,12},MTL}=OFF option can be used so the code specific to the other generations of Intel GPUs won't be built.

Install intel-media by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=$XORG_PREFIX \
      -DINSTALL_DRIVER_SYSCONF=OFF        \
      -DBUILD_TYPE=Release                \
      -Wno-dev ..                   &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: libigfxcmrt.so
Installed Drivers: iHD_drv_video.so
Installed Directories: /usr/include/igfxcmrt

Short Descriptions

libigfxcmrt.so

provides API functions which allow running GPU kernels on the render engine

intel-vaapi-driver-2.4.1

Introduction to intel-vaapi-driver

The intel-vaapi-driver package contains a VA API driver for Intel GPUs that are provided with Haswell CPUs and earlier.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

intel-vaapi-driver Dependencies

Required

libva-2.19.0 and Xorg build environment

Kernel Configuration

Enable the following options in the kernel configuration. Recompile the kernel if necessary:

Device Drivers --->
  Graphics support --->
    <*/M> Direct Rendering Manager (XFree86 4.1.0 and higher DRI support) --->
                                                                      ...  [DRM]
    <*/M> Intel 8xx/9xx/G3x/G4x/HD Graphics                           [DRM_I915]

Installation of intel-vaapi-driver

Install the driver by running the following commands:

./configure $XORG_CONFIG &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Driver: i965_drv_video.so

Liba52-0.7.4

Introduction to Liba52

liba52 is a free library for decoding ATSC A/52 (also known as AC-3) streams. The A/52 standard is used in a variety of applications, including digital television and DVD.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Optional

djbfft

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/liba52

Installation of Liba52

Install liba52 by running the following commands:

./configure --prefix=/usr \
            --mandir=/usr/share/man \
            --enable-shared \
            --disable-static \
            CFLAGS="${CFLAGS:--g -O2} $([ $(uname -m) = x86_64 ] && echo -fPIC)" &&
make

To test the results, issue: make check.

Now, as the root user:

make install &&
cp liba52/a52_internal.h /usr/include/a52dec &&
install -v -m644 -D doc/liba52.txt \
    /usr/share/doc/liba52-0.7.4/liba52.txt

Command Explanations

CFLAGS="-g -O2 ...: This sets CFLAGS to -g -O2 (which is the default) but then on x86_64 adds -fPIC. This is needed to compile liba52 on x86_64.

--disable-static: This switch prevents installation of static versions of the libraries.

cp liba52/a52_internal.h ...: Copying this header file into /usr/include/a52dec allows some other programs (such as xine-lib) to compile and link against a system installed liba52.

Contents

Installed Programs: a52dec and extract_a52
Installed Library: liba52.so
Installed Directories: /usr/include/a52dec and /usr/share/doc/liba52-0.7.4

Short Descriptions

a52dec

plays ATSC A/52 audio streams

extract_a52

extracts ATSC A/52 audio from an MPEG stream

liba52.so

provides functions for the programs dealing with ATSC A/52 streams

Libao-1.2.0

Introduction to Libao

The libao package contains a cross-platform audio library. This is useful to output audio on a wide variety of platforms. It currently supports WAV files, OSS (Open Sound System), ESD (Enlighten Sound Daemon), ALSA (Advanced Linux Sound Architecture), NAS (Network Audio system), aRTS (analog Real-Time Synthesizer), and PulseAudio (next generation GNOME sound architecture).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Libao Dependencies

Optional

a graphical environment, ALSA-1.2.7, and PulseAudio-16.1

Installation of Libao

Install libao by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install &&
install -v -m644 README /usr/share/doc/libao-1.2.0

Configuring Libao

Config Files

/etc/libao.conf and ~/.libao

Configuration Information

Currently, the only configuration option available is setting the default output device. Issue man libao.conf for details.

Contents

Installed Programs: None
Installed Libraries: libao.so and plugins under /usr/lib/ao/plugins-4
Installed Directories: /usr/include/ao, /usr/lib/ao and /usr/share/doc/libao-1.2.0

Short Descriptions

libao.so

provides functions for programs wishing to output sound over supported platforms

libaom-3.6.1

Introduction to libaom

The libaom package contains a reference version of the Alliance for Open Media video codec. This codec is a patent free alternative to H.265, and is starting to be used throughout the internet.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libaom Dependencies

Recommended
Optional

Doxygen-1.9.7

Installation of libaom

Install libaom by running the following commands:

mkdir aom-build &&
cd    aom-build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DBUILD_SHARED_LIBS=1       \
      -DENABLE_DOCS=no            \
      -G Ninja .. &&
ninja

To test the results, issue: ninja runtests. Note that the tests take an extremely long time to run.

Now, as the root user:

ninja install &&
rm -v /usr/lib/libaom.a

Command Explanations

-DBUILD_SHARED_LIBS=1: This switch builds shared versions of the libraries.

-DENABLE_DOCS=no: This switch disables building the documentation because it fails due to an incompatibility with the latest version of Doxygen-1.9.7.

-DENABLE_NASM=yes: Use this switch if you have NASM-2.16.01 installed and wish to use it instead of yasm.

Contents

Installed Programs: None
Installed Libraries: libaom.so
Installed Directories: /usr/include/aom

Short Descriptions

libaom.so

contains functions that provide a reference implementation of the AV1 codec

libass-0.17.1

Introduction to libass

libass is a portable subtitle renderer for the ASS/SSA (Advanced Substation Alpha/Substation Alpha) subtitle format that allows for more advanced subtitles than the conventional SRT and similar formats.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libass Dependencies

Required

FreeType-2.13.1, FriBidi-1.0.13, and NASM-2.16.01

Recommended
Optional

HarfBuzz-8.1.1 and libunibreak

Installation of libass

Install libass by running the following commands:

./configure --prefix=/usr --disable-static &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--disable-fontconfig: Use this switch if you didn't install Fontconfig.

Contents

Installed Programs: None
Installed Library: libass.so
Installed Directory: /usr/include/ass

Short Descriptions

libass.so

provides the functions used to render ASS/SSA subtitle format

libcanberra-0.30

Introduction to libcanberra

libcanberra is an implementation of the XDG Sound Theme and Name Specifications, for generating event sounds on free desktops, such as GNOME.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

libcanberra Dependencies

Required

libvorbis-1.3.7

Recommended
Optional

GTK+-2.24.33, PulseAudio-16.1, and tdb

Recommended Sound Theme (Run Time)

Installation of libcanberra

At first, apply a patch to fix an issue causing some applications to crash in Wayland based desktop environment:

patch -Np1 -i ../libcanberra-0.30-wayland-1.patch

Install libcanberra by running the following commands:

./configure --prefix=/usr --disable-oss &&
make

This package does not come with a test suite.

Now, as the root user:

make docdir=/usr/share/doc/libcanberra-0.30 install

Command Explanations

--disable-oss: disable optional deprecated OSS support

--disable-gtk: disable optional GTK+ 2 support

--disable-gtk3: disable optional GTK+ 3 support

Contents

Installed Programs: canberra-boot and canberra-gtk-play
Installed Libraries: libcanberra-gtk.so, libcanberra-gtk3.so and libcanberra.so
Installed Directories: /usr/lib/libcanberra-0.30, /usr/share/doc/libcanberra-0.30 and /usr/share/gtk-doc/html/libcanberra

Short Descriptions

canberra-gtk-play

is an application used for playing sound events

libcanberra-gtk.so

contains the libcanberra bindings for GTK+ 2

libcanberra-gtk3.so

contains the libcanberra bindings for GTK+ 3

libcanberra.so

contains the libcanberra API functions

libcddb-1.3.2

Introduction to libcddb

The libcddb is a library that implements the different protocols (CDDBP, HTTP, SMTP) to access data on a CDDB server.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of libcddb

By default this package accesses freedb.org, which is already closed. Modify the default to use gnudb.gnudb.org instead, and fix two stale test data files:

sed -e '/DEFAULT_SERVER/s/freedb.org/gnudb.gnudb.org/' \
    -e '/DEFAULT_PORT/s/888/&0/'                       \
    -i include/cddb/cddb_ni.h                          &&
sed '/^Genre:/s/Trip-Hop/Electronic/' -i tests/testdata/920ef00b.txt &&
sed '/DISCID/i# Revision: 42'         -i tests/testcache/misc/12340000

Install libcddb by running the following commands:

./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check -k. The test suite needs the Internet connection. One test fails due to missing test server.

Now, as the root user:

make install

Contents

Installed Programs: cddb_query
Installed Library: libcddb.so
Installed Directories: /usr/include/cddb

Short Descriptions

cddb_query

provides a user interface to a CDDB server

libcdio-2.1.0

Introduction to libcdio

The libcdio is a library for CD-ROM and CD image access. The associated libcdio-cdparanoia library reads audio from the CD-ROM directly as data, with no analog step between, and writes the data to a file or pipe as .wav, .aifc or as raw 16 bit linear PCM.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

libcdio Dependencies

Optional

libcddb-1.3.2

Installation of libcdio

Install libcdio by running the following commands:

./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check -k. One test named realpath is known to fail.

Now, as the root user:

make install

Now install libcdio-paranoia:

tar -xf ../libcdio-paranoia-10.2+2.0.1.tar.bz2 &&
cd libcdio-paranoia-10.2+2.0.1 &&

./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Contents

Installed Programs: cdda-player, cd-drive, cd-info, cd-paranoia, cd-read, iso-info, iso-read, and mmc-tool
Installed Library: libcdio.so, libcdio++.so, libcdio_cdda, libcdio_paranoia, libiso9660, libiso9660++, and libudf.so
Installed Directories: /usr/include/cdio and /usr/include/cdio++

Short Descriptions

cd-drive

shows CD-ROM drive characteristics

cd-info

shows information about a CD or CD-image

cd-paranoia

is an audio CD reading utility which includes extra data verification features

cd-read

reads Information from a CD or CD-image

cdda-player

is a simple curses CD player

iso-info

shows Information about an ISO 9660 image

iso-read

reads portions of an ISO 9660 image

mmc-tool

issues libcdio multimedia commands

libcdio.so

contains the primary cdio API functions

libdvdcss-1.4.3

Introduction to libdvdcss

libdvdcss is a simple library designed for accessing DVDs as a block device without having to bother about the decryption.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libdvdcss Dependencies

Optional (to Create Documentation)

Doxygen-1.9.7

Installation of libdvdcss

Install libdvdcss by running the following commands:

./configure --prefix=/usr    \
            --disable-static \
            --docdir=/usr/share/doc/libdvdcss-1.4.3 &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Library: libdvdcss.so
Installed Directories: /usr/include/dvdcss and /usr/share/doc/libdvdcss-1.4.3

Short Descriptions

libdvdcss.so

provides the functionality that is required for transparent DVD access with CSS decryption

Libdvdread-6.1.3

Introduction to Libdvdread

libdvdread is a library which provides a simple foundation for reading DVDs.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Libdvdread

Install libdvdread by running the following commands:

./configure --prefix=/usr    \
            --disable-static \
            --docdir=/usr/share/doc/libdvdread-6.1.3 &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Library: libdvdread.so
Installed Directories: /usr/include/dvdread and /usr/share/doc/libdvdread-6.1.3

Short Descriptions

libdvdread.so

provides functionality required to access DVDs

Libdvdnav-6.1.1

Introduction to Libdvdnav

libdvdnav is a library that allows easy use of sophisticated DVD navigation features such as DVD menus, multiangle playback and even interactive DVD games.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Libdvdnav Dependencies

Required

libdvdread-6.1.3

Installation of Libdvdnav

Install libdvdnav by running the following commands:

./configure --prefix=/usr    \
            --disable-static \
            --docdir=/usr/share/doc/libdvdnav-6.1.1 &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Library: libdvdnav.so
Installed Directories: /usr/include/dvdnav and /usr/share/doc/libdvdnav-6.1.1

Short Descriptions

libdvdnav.so

is the DVD navigation library

Libdv-1.0.0

Introduction to Libdv

The Quasar DV Codec (libdv) is a software CODEC for DV video, the encoding format used by most digital camcorders. It can be used to copy videos from camcorders using a firewire (IEEE 1394) connection.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Libdv Dependencies

Optional

popt-1.19, sdl12-compat-1.2.64, and a graphical environment

Installation of Libdv

Install libdv by running the following commands:

./configure --prefix=/usr \
            --disable-xv \
            --disable-static &&
make

This package does not come with a test suite.

Now, as the root user:

make install &&
install -v -m755 -d      /usr/share/doc/libdv-1.0.0 &&
install -v -m644 README* /usr/share/doc/libdv-1.0.0

Command Explanations

--disable-xv: This parameter is required if an X Window System is not installed. It also prevents configure testing for libXv which is only used for an obsolete program playdv that will not be built with current linux headers and would also need other obsolete dependencies.

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: dubdv, dvconnect, and encodedv
Installed Library: libdv.so
Installed Directories: /usr/include/libdv and /usr/share/doc/libdv-1.0.0

Short Descriptions

dubdv

inserts audio into a digital video stream

dvconnect

is a small utility to send or capture raw data from and to the camcorder

encodedv

encodes a series of images to a digital video stream

libdv.so

provides functions for programs interacting with the Quasar DV CODEC

libmad-0.15.1b

Introduction to libmad

libmad is a high-quality MPEG audio decoder capable of 24-bit output.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Installation of libmad

Install libmad by running the following commands:

patch -Np1 -i ../libmad-0.15.1b-fixes-1.patch                &&
sed "s@AM_CONFIG_HEADER@AC_CONFIG_HEADERS@g" -i configure.ac &&
touch NEWS AUTHORS ChangeLog                                 &&
autoreconf -fi                                               &&

./configure --prefix=/usr --disable-static &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Some packages check for the pkg-config file for libmad. This file is particularly needed so that Cdrdao can recognize the installed libmad.

As the root user:

cat > /usr/lib/pkgconfig/mad.pc << "EOF"
prefix=/usr
exec_prefix=${prefix}
libdir=${exec_prefix}/lib
includedir=${prefix}/include

Name: mad
Description: MPEG audio decoder
Requires:
Version: 0.15.1b
Libs: -L${libdir} -lmad
Cflags: -I${includedir}
EOF

Command Explanations

touch NEWS AUTHORS ChangeLog: Prevent autoreconf from returning an error.

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Library: libmad.so
Installed Directories: None

Short Descriptions

libmad.so

is a MPEG audio decoder library

libmpeg2-0.5.1

Introduction to libmpeg2

The libmpeg2 package contains a library for decoding MPEG-2 and MPEG-1 video streams. The library is able to decode all MPEG streams that conform to certain restrictions: constrained parameters for MPEG-1, and main profile for MPEG-2. This is useful for programs and applications needing to decode MPEG-2 and MPEG-1 video streams.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libmpeg2 Dependencies

Optional

a graphical environment and sdl12-compat-1.2.64

Installation of libmpeg2

Install libmpeg2 by running the following commands:

sed -i 's/static const/static/' libmpeg2/idct_mmx.c &&

./configure --prefix=/usr    \
            --enable-shared  \
            --disable-static &&
make

To test the results, issue: make check. To perform a more comprehensive regression test, see the file test/README in the source tree.

Now, as the root user:

make install &&

install -v -m755 -d /usr/share/doc/libmpeg2-0.5.1 &&
install -v -m644 README doc/libmpeg2.txt \
                    /usr/share/doc/libmpeg2-0.5.1

Command Explanations

sed -i ...: This sed fixes problems with recent GCC compilers.

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: corrupt_mpeg2, extract_mpeg2 and mpeg2dec
Installed Libraries: libmpeg2.so and libmpeg2convert.so
Installed Directories: /usr/include/mpeg2dec and /usr/share/doc/libmpeg2-0.5.1

Short Descriptions

extract_mpeg2

extracts MPEG video streams from a multiplexed stream

mpeg2dec

decodes MPEG1 and MPEG2 video streams

libmpeg2.so

contains API functions used to decode MPEG video streams

libmpeg2convert.so

contains API functions used for color conversions of MPEG video streams

libmusicbrainz-2.1.5

Introduction to libmusicbrainz

The libmusicbrainz package contains a library which allows you to access the data held on the MusicBrainz server. This is useful for adding MusicBrainz lookup capabilities to other applications.

MusicBrainz is a community music metadatabase that attempts to create a comprehensive music information site. You can use the MusicBrainz data either by browsing the web site, or you can access the data from a client program — for example, a CD player program can use MusicBrainz to identify CDs and provide information about the CD, about the artist or other related information.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

libmusicbrainz Dependencies

Optional to Build the Python Bindings

Python-2.7.18

Installation of libmusicbrainz

Install libmusicbrainz by running the following commands:

patch -Np1 -i ../libmusicbrainz-2.1.5-missing-includes-1.patch &&

CXXFLAGS="${CXXFLAGS:--O2 -g} -std=c++98" \
./configure --prefix=/usr --disable-static &&
make

If Python is installed, build the bindings with the following commands:

(cd python && python2 setup.py build)

This package does not come with a stand-alone test suite (to test you must have Python installed and perform the test after the package is installed).

Now, as the root user:

make install &&
install -v -m644 -D docs/mb_howto.txt \
    /usr/share/doc/libmusicbrainz-2.1.5/mb_howto.txt

To test the Python bindings, issue the following: (cd python && python2 setup.py test).

If you built the Python bindings, issue the following commands as the root user to install them:

(cd python && python2 setup.py install)

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Library: libmusicbrainz.so
Installed Directories: /usr/include/musicbrainz and /usr/share/doc/libmusicbrainz-2.1.5

Short Descriptions

libmusicbrainz.so

contains API functions to access the MusicBrainz database, both for looking up data and also for submitting new data

libmusicbrainz-5.1.0

Introduction to libmusicbrainz

The libmusicbrainz package contains a library which allows you to access the data held on the MusicBrainz server.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

libmusicbrainz Dependencies

Required

CMake-3.27.2, libxml2-2.10.4 and neon-0.32.5

Optional

Doxygen-1.9.7

Installation of libmusicbrainz

First, fix a problem caused by CMake-3.18.0:

patch -Np1 -i ../libmusicbrainz-5.1.0-cmake_fixes-1.patch

Install libmusicbrainz by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release .. &&
make

If you have installed Doxygen-1.9.7, optionally build the API documentation:

doxygen ../Doxyfile

This package does not come with a test suite.

Now, as the root user:

make install

If you have built the API documentation, install, as the root user:

rm -rf /usr/share/doc/libmusicbrainz-5.1.0 &&
cp -vr docs/ /usr/share/doc/libmusicbrainz-5.1.0

Contents

Installed Programs: None
Installed Library: libmusicbrainz5.so
Installed Directory: /usr/include/libmusicbrainz5 and /usr/share/doc/libmusicbrainz-5.1.0

Short Descriptions

libmusicbrainz5.so

contains API functions for accessing the MusicBrainz database

libogg-1.3.5

Introduction to libogg

The libogg package contains the Ogg file structure. This is useful for creating (encoding) or playing (decoding) a single physical bit stream.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of libogg

Install libogg by running the following commands:

./configure --prefix=/usr    \
            --disable-static \
            --docdir=/usr/share/doc/libogg-1.3.5 &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Library: libogg.so
Installed Directories: /usr/include/ogg and /usr/share/doc/libogg-1.3.5

Short Descriptions

libogg.so

provides the functions required for programs to read or write Ogg formatted bit streams

libquicktime-1.2.4

Introduction to libquicktime

The libquicktime package contains the libquicktime library, various plugins and codecs, along with graphical and command line utilities used for encoding and decoding QuickTime files. This is useful for reading and writing files in the QuickTime format. The goal of the project is to enhance, while providing compatibility with the Quicktime 4 Linux library.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libquicktime Dependencies

Optional

alsa-lib-1.2.9, Doxygen-1.9.7, FAAC-1_30, FAAD2-2.10.1, GTK+-2.24.33, LAME-3.100, libdv-1.0.0, libjpeg-turbo-3.0.0, libpng-1.6.40, libvorbis-1.3.7, x264-20230215, Xorg Libraries, and Schroedinger

Installation of libquicktime

Install libquicktime by running the following commands:

./configure --prefix=/usr     \
            --enable-gpl      \
            --without-doxygen \
            --without-ffmpeg  \
            --docdir=/usr/share/doc/libquicktime-1.2.4
make

This package does not come with a test suite.

Now, as the root user:

make install &&

install -v -m755 -d /usr/share/doc/libquicktime-1.2.4 &&
install -v -m644    README doc/{*.txt,*.html,mainpage.incl} \
                    /usr/share/doc/libquicktime-1.2.4

Command Explanations

--enable-gpl: Changes the licence to GPL. This enables some extra plugins, such as FAAC, FAAD2, and x264.

--without-doxygen: This is necessary if you do not have Doxygen, omit this if it is installed and you wish the API documentation installed.

--without-ffmpeg: This switch disables ffmpeg support because it is incompatible with ffmpeg-5.

--with-libdv: Build with libdv support. Not enabled by default.

Contents

Installed Programs: libquicktime_config, lqtplay, lqtremux, lqt_transcode, qt2text, qtdechunk, qtdump, qtinfo, qtrechunk, qtstreamize, and qtyuv4toyuv
Installed Libraries: libquicktime.so and several plugin codec libraries
Installed Directories: /usr/include/lqt, /usr/lib/libquicktime, and /usr/share/doc/libquicktime-1.2.4

Short Descriptions

libquicktime_config

is a graphical front end to examine and configure the available libquicktime audio and video codecs

lqtplay

is a simple QuickTime movie player for X Window System

lqt_transcode

is a command-line program used to encode video and/or audio files from one format to another

qt2text

is used to dump all text strings from a quicktime file

qtdechunk

can take movies containing rgb frames and write them out as ppm images

qtdump

displays the parsed contents of the provided file

qtinfo

prints various pieces of metadata parsed by the libquicktime library for the provided file

qtrechunk

concatenates input frames into a QuickTime movie

qtstreamize

is used to make a file streamable by placing the moov header at the beginning of the file

qtyuv4toyuv

is used to write a YUV4 encoded movie as a planar YUV 4:2:0 file

libquicktime.so

is a library for reading and writing QuickTime files. It provides convenient access to QuickTime files with a variety of supported codecs. The library contains new functions integrated with all the original QuickTime 4 Linux library functions used to encode and decode QuickTime files

libsamplerate-0.2.2

Introduction to libsamplerate

libsamplerate is a sample rate converter for audio.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libsamplerate Dependencies

Optional

alsa-lib-1.2.9, libsndfile-1.2.2, and fftw-3.3.10 (for tests)

Installation of libsamplerate

Install libsamplerate by running the following commands:

./configure --prefix=/usr    \
            --disable-static \
            --docdir=/usr/share/doc/libsamplerate-0.2.2 &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Program: None
Installed Library: libsamplerate.so
Installed Directory: /usr/share/doc/libsamplerate-0.2.2

libsndfile-1.2.2

Introduction to libsndfile

Libsndfile is a library of C routines for reading and writing files containing sampled audio data.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libsndfile Dependencies

Recommended
Optional

alsa-lib-1.2.9, LAME-3.100, mpg123-1.31.3, Speex-1.2.1, and SQLite-3.42.0

Installation of libsndfile

Install libsndfile by running the following commands:

./configure --prefix=/usr    \
            --docdir=/usr/share/doc/libsndfile-1.2.2 &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Contents

Installed Programs: sndfile-cmp, sndfile-concat, sndfile-convert, sndfile-deinterleave, sndfile-info, sndfile-interleave, sndfile-metadata-get, sndfile-metadata-set, sndfile-play, and sndfile-salvage
Installed Library: libsndfile.so
Installed Directory: /usr/share/doc/libsndfile-1.2.2

Short Descriptions

sndfile-cmp

compares two audio files

sndfile-concat

concatenates two or more audio files

sndfile-convert

converts a sound file from one format to another

sndfile-deinterleave

splits a multi-channel into multiple single channel files

sndfile-info

displays information about a sound file

sndfile-interleave

converts multiple single channel files into a multi-channel file

sndfile-metadata-get

retrieves metadata from a sound file

sndfile-metadata-set

sets metadata in a sound file

sndfile-play

plays a sound file

sndfile-salvage

salvages the audio data from WAV files which are more than 4GB in size

libsndfile.so

contains the libsndfile API functions

libtheora-1.1.1

Introduction to libtheora

libtheora is a reference implementation of the Theora video compression format being developed by the Xiph.Org Foundation.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libtheora Dependencies

Required

libogg-1.3.5

Recommended
Optional

sdl12-compat-1.2.64 and libpng-1.6.40 (both to build the example players), Doxygen-1.9.7, texlive-20230313 (or install-tl-unx), BibTex, and Transfig (all four to build the API documentation), and Valgrind-3.21.0

Installation of libtheora

Install libtheora by running the following commands:

sed -i 's/png_\(sizeof\)/\1/g' examples/png2theora.c &&
./configure --prefix=/usr --disable-static &&
make

If you wish to run the tests, issue: make check.

Now, as the root user:

make install

If you wish to install the examples (so that you can hack on theora), install them as the root user:

cd examples/.libs &&
for E in *; do
  install -v -m755 $E /usr/bin/theora_${E}
done

Command Explanations

sed -i 's/png_\(sizeof\)/\1/g' examples/png2theora.c: This sed fixes build with libpng 1.6.

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None, unless you installed the examples
Installed Libraries: libtheora.so, libtheoraenc.so, and libtheoradec.so
Installed Directories: /usr/include/theora and /usr/share/doc/libtheora-1.1.1

Short Descriptions

libtheora*.so

contains the functions to read and write video files

libva-2.19.0

Introduction to libva

The libva package contains a library which provides access to hardware accelerated video processing, using hardware to accelerate video processing in order to offload the central processing unit (CPU) to decode and encode compressed digital video. The VA API video decode/encode interface is platform and window system independent targeted at Direct Rendering Infrastructure (DRI) in the X Window System however it can potentially also be used with direct framebuffer and graphics sub-systems for video output. Accelerated processing includes support for video decoding, video encoding, subpicture blending, and rendering.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libva Dependencies

Required

Xorg build environment and libdrm-2.4.115

Recommended
Recommended (Runtime)

The VA API driver suitable for the hardware in your system: intel-vaapi-driver-2.4.1 (for Intel GPUs provided with Haswell CPUs or earlier), intel-media-23.3.2 (for Intel GPUs provided with Broadwell CPUs or later), and Mesa-23.1.6 (providing the r600, radeonsi, and nouveau VA API drivers, for the ATI/AMD Radeon HD 2xxx GPUs and later, and supported NVIDIA GPUs; there is a circular dependency, read the Mesa page for information on how to break it)

Optional

Doxygen-1.9.7, Wayland-1.22.0, and intel-gpu-tools

Installation of libva

Install libva by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=$XORG_PREFIX --buildtype=release &&
ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Contents

Installed Programs: None
Installed Libraries: libva-drm.so, libva-glx.so, libva.so, libva-wayland.so, and libva-x11.so
Installed Directory: $XORG_PREFIX/include/va

Short Descriptions

libva.so

contains API functions which provide access to hardware accelerated video processing

libvdpau-1.5

Introduction to libvdpau

The libvdpau package contains a library which implements the VDPAU library.

VDPAU (Video Decode and Presentation API for Unix) is an open source library (libvdpau) and API originally designed by Nvidia for its GeForce 8 series and later GPU hardware targeted at the X Window System. This VDPAU API allows video programs to offload portions of the video decoding process and video post-processing to the GPU video-hardware.

Currently, the portions capable of being offloaded by VDPAU onto the GPU are motion compensation (mo comp), inverse discrete cosine transform (iDCT), VLD (variable-length decoding) and deblocking for MPEG-1, MPEG-2, MPEG-4 ASP (MPEG-4 Part 2), H.264/MPEG-4 AVC and VC-1, WMV3/WMV9 encoded videos. Which specific codecs of these that can be offloaded to the GPU depends on the version of the GPU hardware; specifically, to also decode MPEG-4 ASP (MPEG-4 Part 2), Xvid/OpenDivX (DivX 4), and DivX 5 formats, a GeForce 200M (2xxM) Series (the eleventh generation of Nvidia's GeForce graphics processing units) or newer GPU hardware is required.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libvdpau Dependencies

Required

Xorg Libraries

Recommended (Runtime)

The VDPAU driver suitable for the hardware in your system: libvdpau-va-gl-0.4.0 (for Intel GPUs) and Mesa-23.1.6 (providing the r600, radeonsi, and nouveau VDPAU drivers, for the ATI/AMD Radeon HD 2xxx GPUs and later, and supported NVIDIA GPUs; Mesa must be built after this package for these drivers)

Optional

Doxygen-1.9.7, Graphviz-8.1.0, and texlive-20230313 or install-tl-unx

Installation of libvdpau

Install libvdpau by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=$XORG_PREFIX .. &&
ninja

To test the results, issue: ninja test. There is only one test for this package, dlclose, and it is known to fail on some systems.

Now, as the root user:

ninja install

If doxygen is present at build time place the documentation in a versioned directory as the root user:

[ -e $XORG_PREFIX/share/doc/libvdpau ] && mv -v $XORG_PREFIX/share/doc/libvdpau{,1.5}

Contents

Installed Programs: None
Installed Library: libvdpau.so
Installed Directories: $XORG_PREFIX/{include,lib}/vdpau

Short Descriptions

libvdpau.so

contains functions to offload portions of the video decoding process and video post-processing to the GPU video-hardware

libvdpau-va-gl-0.4.0

Introduction to libvdpau-va-gl

The libvdpau-va-gl package contains a library which implements the VDPAU library. Libvdpau_va_gl uses OpenGL under the hood to accelerate drawing and scaling and the VA-API (if available) to accelerate video decoding. For now VA-API is available on some Intel chips, and on some AMD video adapters with the help of the libvdpau driver.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libvdpau-va-gl Dependencies

Required

CMake-3.27.2, libvdpau-1.5, and libva-2.19.0

Optional

Doxygen-1.9.7, Graphviz-8.1.0, and texlive-20230313 or install-tl-unx

Runtime Dependency

Mesa-23.1.6

Installation of libvdpau-va-gl

Install libvdpau-va-gl by running the following commands:

sed -e '/#include <stdlib.h>/a #include <string>' -i src/api-device.cc &&

mkdir build &&
cd    build &&

cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=$XORG_PREFIX .. &&
make

To test the results, issue: make check. The tests must be run from an Xorg environment.

Now, as the root user:

make install

Command Explanations

sed -e '/#include <stdlib.h>/a #include <string>' ...: fix the build for the C++ Standard Library header changes in gcc-13.

Configuration

To allow libvdpau to find libvdpau-va-gl, set an environment variable. As the root user:

echo "export VDPAU_DRIVER=va_gl" >> /etc/profile.d/xorg.sh

Contents

Installed Programs: None
Installed Library: libvdpau_va_gl.so
Installed Directories: None

Short Descriptions

libvdpau_va_gl.so

contains functions to implement the OpenGL backend to the VDPAU (Video Decode and Presentation API for Unix) API

libvorbis-1.3.7

Introduction to libvorbis

The libvorbis package contains a general purpose audio and music encoding format. This is useful for creating (encoding) and playing (decoding) sound in an open (patent free) format.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libvorbis Dependencies

Required

libogg-1.3.5

Optional

Doxygen-1.9.7 and texlive-20230313 (or install-tl-unx) (specifically, pdflatex and htlatex) to build the PDF documentation

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/Libvorbis

Installation of libvorbis

Install libvorbis by running the following commands:

./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make -j1 check.

Now, as the root user:

make install &&
install -v -m644 doc/Vorbis* /usr/share/doc/libvorbis-1.3.7

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-docs: This switch enables building the documentation in formats other than the supplied html.

Contents

Installed Programs: None
Installed Libraries: libvorbis.so, libvorbisenc.so and libvorbisfile.so
Installed Directories: /usr/include/vorbis and /usr/share/doc/libvorbis-1.3.7

Short Descriptions

libvorbis.so

provides the functions used to read and write sound files

libvpx-1.13.0

Introduction to libvpx

This package, from the WebM project, provides the reference implementations of the VP8 Codec, used in most current html5 video, and of the next-generation VP9 Codec.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libvpx Dependencies

Recommended
Optional

cURL-8.2.1 (to download test files) and Doxygen-1.9.7 (to build documentation)

Note

An Internet connection is needed for some tests of this package.

Installation of libvpx

Install libvpx by running the following commands:

sed -i 's/cp -p/cp/' build/make/Makefile &&

mkdir libvpx-build            &&
cd    libvpx-build            &&

../configure --prefix=/usr    \
             --enable-shared  \
             --disable-static &&
make

To test the results, issue: LD_LIBRARY_PATH=. make test. The test suite downloads many files as part of its test process. A few parts of it will use all available cores.

Now, as the root user:

make install

Command Explanations

sed ... : This command corrects ownership and permissions of installed files.

mkdir libvpx-build && cd libvpx-build: The libvpx developers recommend building in a dedicated build directory.

--disable-static: This switch prevents installation of static versions of the libraries.

--disable-vp8: This switch prevents building of VP8 codec support.

--disable-vp9: This switch prevents building of VP9 codec support.

--target=generic-gnu: This switch disables optimizations specific for x86 and x86-64, allowing to build this package without nasm and yasm installed.

LD_LIBRARY_PATH=.: This is needed for the test suite to use the library that was just built.

Contents

Installed Programs: vpxdec and vpxenc
Installed Libraries: libvpx.so
Installed Directories: /usr/include/vpx

Short Descriptions

vpxdec

is the WebM Project VP8 and VP9 decoder

vpxenc

is the WebM project VP8 and VP9 encoder

libvpx.so

provides functions to use the VP8 and VP9 video codecs

MLT-7.18.0

Introduction to MLT

MLT package is the Media Lovin Toolkit. It is an open source multimedia framework, designed and developed for television broadcasting. It provides a toolkit for broadcasters, video editors, media players, transcoders, web streamers and many more types of applications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

MLT Dependencies

Required

frei0r-plugins-1.8.0 and (Qt-5.15.10 or qt-alternate-5.15.10)

Optional

Doxygen-1.9.7, fftw-3.3.10, libexif-0.6.24, SDL2-2.28.2, JACK, MOVEit, SoX, and vid.stab

Installation of MLT

Install MLT by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -Wno-dev .. &&

make

This package does not come with a test suite. However a test .mp4 file can be played in a local graphical environment with ./out/bin/melt <filename>.mp4.

Note

This application uses advanced graphical capabilities. In some cases, firmware for your specific graphics adaptor may be needed. See the section called “Firmware for Video Cards” for more information.

Now, as the root user:

make install

Contents

Installed Program: melt-7 and melt (symlink to melt-7)
Installed Libraries: libmlt-7.so, libmlt++-7.so, and over twenty plugins
Installed Directories: /usr/include/mlt-7, /usr/lib/mlt-7, /usr/lib/cmake/Mlt7, and /usr/share/mlt-7

Short Descriptions

melt

is a test tool for MLT

Opus-1.3.1

Introduction to Opus

Opus is a lossy audio compression format developed by the Internet Engineering Task Force (IETF) that is particularly suitable for interactive speech and audio transmission over the Internet. This package provides the Opus development library and headers.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Optional

Doxygen-1.9.7 and texlive-20230313 (or install-tl-unx)

Installation of Opus

Install Opus by running the following commands:

./configure --prefix=/usr    \
            --disable-static \
            --docdir=/usr/share/doc/opus-1.3.1 &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Library: libopus.so
Installed Directory: /usr/include/opus and /usr/share/doc/opus-1.3.1

Short Descriptions

libopus.so

provides the functions used to read and write Opus format

Pipewire-0.3.77

Introduction to Pipewire

The pipewire package contains a server and userspace API to handle multimedia pipelines. This includes a universal API to connect to multimedia devices, as well as sharing multimedia files between applications.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Pipewire Dependencies

Recommended
Optional

alsa-lib-1.2.9, Avahi-0.8, BlueZ-5.68, fdk-aac-2.0.2, FFmpeg-6.0, libcanberra-0.30, libdrm-2.4.115 (for one example and libcamera support), libxcb-1.16, libsndfile-1.2.2, libusb-1.0.26, Opus-1.3.1, SDL2-2.28.2 (for some examples), Valgrind-3.21.0, Xorg Libraries, Doxygen-1.9.7 and Graphviz-8.1.0 (for documentation), JACK, ldacBT, libcamera, libmysofa, Vulkan, WirePlumber (runtime, for running the Pipewire daemon), and xmltoman

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/pipewire

Installation of Pipewire

Install pipewire by running the following commands:

mkdir build &&
cd    build &&

meson setup ..                \
      --prefix=/usr           \
      --buildtype=release     \
      -Dsession-managers="[]" &&
ninja

To test the result, issue: ninja test.

If upgrading from an earlier release of Pipewire, it's needed to remove any old binary executables that interfere with the installation. As the root user:

rm -vf /usr/bin/pipewire-*

Now, as the root user:

ninja install

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dsession-managers=[]: This switch allows to specify the session managers to build as subprojects. Since the recommended session manager ( WirePlumber) is available as a standalone project, don't specify anything here. This prevents downloading external dependencies during the meson step.

-Ddocs=true: This switch enables the generation of HTML documentation. The optional dependencies for documentation need to be installed for this to work.

-Dman=true: This switch enables the generation of manual pages. The optional dependencies for documentation need to be installed for this to work.

-Dffmpeg=enabled: This switch enables using ffmpeg for audio conversion as a SPA backend.

Contents

Installed Programs: pipewire, pw-cat, pw-cli, pw-config, pw-dot, pw-dump, pw-jack, pw-link, pw-loopback, pw-metadata, pw-mididump, pw-mon, pw-profiler, pw-reserve, pw-top, pw-v4l2, spa-acp-tool, spa-inspect, spa-json-dump, spa-monitor, spa-resample, and pipewire-aes67, pipewire-avb, pipewire-pulse (symlinks to pipewire), pw-dsdplay, pw-encplay, pw-midiplay, pw-midirecord, pw-play, pw-record (symlinks to pw-cat)
Installed Libraries: libpipewire-0.3.so and 58 modules below /usr/lib/pipewire-0.3 and /usr/lib/spa-0.2
Installed Directories: /usr/include/pipewire-0.3, /usr/include/spa-0.2, /usr/lib/alsa-lib, /usr/lib/pipewire-0.3, /usr/lib/spa-0.2, /usr/share/alsa-card-profile, /usr/share/pipewire, and /usr/share/spa-0.2

Short Descriptions

pipewire

is a service that allows access to multimedia devices and allows sharing of multimedia files between applications

pipewire-pulse

starts a Pulseaudio-compatible version of the pipewire service

pw-cat

allows you to play or record media using a pipewire instance

pw-cli

allows you to interact with a pipewire instance

pw-config

allows you to interact with pipewire's configuration system for debugging purposes or syntax checking

pw-dot

lists all of the daemons and objects in use by pipewire

pw-dump

dumps debug messages from a local or remote pipewire instance to the console

pw-jack

runs JACK applications on a pipewire instance

pw-link

links pipewire ports together

pw-loopback

initializes a loopback link between two different pipewire ports. This is useful for testing and debugging

pw-metadata

inspects, adds, and removes metadata for objects

pw-mididump

dumps MIDI messages from a file to the screen

pw-mon

allows you to monitor pipewire instances

pw-profiler

tracks memory usage and API calls used by pipewire

pw-reserve

reserves or monitors a device via D-Bus

pw-top

displays real-time performance information from pipewire

pw-v4l2

runs v4l2 applications on a pipewire instance

spa-acp-tool

inspects the card profile of a given sound card

spa-inspect

allows you to inspect pipewire plugins

spa-json-dump

dumps the current pipewire configuration in JSON format.

spa-monitor

allows you to monitor pipewire plugins

spa-resample

resamples a given file

libpipewire-0.3.so

contains API functions for handling multimedia pipelines

PulseAudio-16.1

Introduction to PulseAudio

PulseAudio is a sound system for POSIX OSes, meaning that it is a proxy for sound applications. It allows you to do advanced operations on your sound data as it passes between your application and your hardware. Things like transferring the audio to a different machine, changing the sample format or channel count and mixing several sounds into one are easily achieved using a sound server.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

PulseAudio Dependencies

Required

libsndfile-1.2.2

Recommended
Optional

Avahi-0.8, BlueZ-5.68, Doxygen-1.9.7 (for documentation), fftw-3.3.10, GTK+-3.24.38, libsamplerate-0.2.2, SBC-2.0 (Bluetooth support), Valgrind-3.21.0, JACK, libasyncns, LIRC, ORC, soxr, TDB, and WebRTC AudioProcessing

Installation of PulseAudio

Install PulseAudio by running the following commands:

mkdir build &&
cd    build &&

meson setup --prefix=/usr       \
            --buildtype=release \
            -Ddatabase=gdbm     \
            -Ddoxygen=false     \
            -Dbluez5=disabled   \
            ..                  &&
ninja

To test the results, issue: ninja test. One test fails if the tests are not run as the root user, but this can be ignored.

Now, as the root user:

ninja install

Running PulseAudio as a system-wide daemon is possible but not recommended. See https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/SystemWide/ for more information. While still as the root user, remove the D-Bus configuration file for the system wide daemon to avoid creating unnecessary system users and groups:

rm -fv /etc/dbus-1/system.d/pulseaudio-system.conf

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-Dbluez5=disabled: This switch prevents a runtime error if dbus-1.14.8 and SBC-2.0 are both installed but BlueZ-5.68 is not installed. Remove this if you have installed all three packages.

-Ddoxygen=false: This allows the package to compile if Doxygen-1.9.7 is not installed. Remove this if you have installed this and wish to build the documentation.

Configuring PulseAudio

Config Files

There are system wide configuration files: /etc/pulse/daemon.conf, /etc/pulse/client.conf, /etc/pulse/default.pa, and user configuration files with the same names in ~/.config/pulse. User configuration files take precedence over system wide ones.

Configuration Information

You may have to configure the audio system. You can start pulseaudio in command line mode using pulseaudio -C and then list various information and change settings. See man pulse-cli-syntax.

If pulseaudio was working but you no-longer have sound, after checking for hardware issues (speakers or headphones not connected, external amplifier not connected) you may need to fix it.

One suggestion is to close the application, such as firefox where sound has stopped working, then run: pactl list short sinks followed by: pacmd set-default-sink <sink #> and then restart the application.

If that does not work, a more drastic approach often works. After closing the application, close pulseaudio, either using pulseaudio --kill or, if that fails, killall -KILL pulseaudio and then rm -rf ~/.config/pulse/* (and perhaps also rm -rf ~/.pulse/* if you have used a very old version of pulse on this machine), then run pulseaudio --verbose to restart it. If the daemon starts, restart the application. See man pulseaudio for more options.

Contents

Installed Programs: pacat, pacmd, pactl, padsp, pamon (symlink to pacat), paplay (symlink to pacat), parec (symlink to pacat), parecord (symlink to pacat), qpaeq, pasuspender, pax11publish, pulseaudio, and start-pulseaudio-x11
Installed Libraries: libpulse.so, libpulse-mainloop-glib.so, libpulse-simple.so, libpulsecommon-16.1.so, libpulsecore-16.1.so, and libpulsedsp.so
Installed Directories: /etc/pulse, /usr/include/pulse, /usr/lib/cmake/PulseAudio, /usr/lib/{pulseaudio,pulse-16.1}, /usr/libexec/pulse, and /usr/share/pulseaudio

Short Descriptions

pacat

plays back or records raw or encoded audio streams on a PulseAudio sound server

pacmd

is a tool used to reconfigure a PulseAudio sound server during runtime

pactl

is used to control a running PulseAudio sound server

padsp

is the PulseAudio OSS Wrapper

pamon

is a symbolic link to pacat

paplay

is used to play audio files on a PulseAudio sound server

parec

is a symbolic link to pacat

parecord

is a symbolic link to pacat

pasuspender

is a tool that can be used to tell a local PulseAudio sound server to temporarily suspend access to the audio devices, to allow other applications to access them directly

pax11publish

is the PulseAudio X11 Credential Utility

pa-info

is a shell script that prints various information relating to the Pulseaudio server currently in use

pulseaudio

is a networked low-latency sound server for Linux

qpaeq

is an equalizer interface for PulseAudio equalizer sinks (Requires fftw-3.3.10 at build time)

start-pulseaudio-x11

starts PulseAudio and registers it to the X11 session manager

SBC-2.0

Introduction to SBC

The SBC is a digital audio encoder and decoder used to transfer data to Bluetooth audio output devices like headphones or loudspeakers.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

SBC Dependencies

Optional

libsndfile-1.2.2

Installation of SBC

Install SBC by running the following commands:

./configure --prefix=/usr --disable-static --disable-tester &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-tester: This disables the SBC tester. Remove it if you have installed libsndfile-1.2.2.

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: sbcdec, sbcenc, and sbcinfo
Installed Library: libsbc.so
Installed Directory: /usr/include/sbc

Short Descriptions

sbcdec

is a SBC decoder utility

sbcenc

is a SBC encoder utility

sbcinfo

is a subband codec (SBC) analyzer

libsbc.so

contains the SBC API functions

sdl12-compat-1.2.64

Introduction to sdl12-compat

The Simple DirectMedia Layer (SDL for short) is a cross-platform library designed to make it easy to write multimedia software, such as games and emulators. This code is a compatibility layer; it provides a binary and source compatible API for programs written against SDL 1.2, but it uses SDL 2.0 behind the scenes.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

SDL Dependencies

Required

CMake-3.27.2, GLU-9.0.3, and SDL2-2.28.2

Installation of sdl12-compat

Install sdl12-compat by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=RELEASE  \
      ..  &&
make

Now, as the root user:

make install &&
rm -vf /usr/lib/libSDLmain.a

Testing SDL

If you wish, test the sdlcompat package using the included test programs. It is not required to install any of the resulting binaries to validate the installation.

You'll need to manually run all the test programs (they are listed in the README file in this directory). Many of them will need to be manually killed, and you'll need to turn your speakers on with the volume at a suitable level.

Contents

Installed Program: sdl-config
Installed Libraries: libSDL.so
Installed Directories: /usr/include/SDL

Short Descriptions

sdl-config

determines the compile and linker flags that should be used to compile and link programs that use libSDL

libSDL.so

contains functions that provide compatibility links to SDL2 low level functions for audio, keyboard, mouse, joystick, 3D hardware via OpenGL, and 2D frame buffer across multiple platforms

SDL2-2.28.2

Introduction to SDL2

The Simple DirectMedia Layer Version 2 (SDL2 for short) is a cross-platform library designed to make it easy to write multimedia software, such as games and emulators.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://www.libsdl.org/release/SDL2-2.28.2.tar.gz

  • Download MD5 sum: 06ff379c406cd8318d18f0de81ee2709

  • Download size: 7.0 MB

  • Estimated disk space required: 162 MB (with docs)

  • Estimated build time: 0.4 SBU (using parallelism=4; with docs)

SDL2 Dependencies

Recommended
Optional

ALSA-1.2.7, Doxygen-1.9.7 (to create documentation), ibus-1.5.28, libsamplerate-0.2.2, NASM-2.16.01, pipewire-0.3.77, PulseAudio-16.1, a graphical environment, DirectFB, fcitx, jack, and sndio

Installation of SDL2

Install SDL2 by running the following commands:

./configure --prefix=/usr &&
make

If you have Doxygen-1.9.7 installed and want to build the html documentation, run the following commands:

pushd docs  &&
  doxygen   &&
popd

Note

If you wish to build and run the package regression tests, do not delete the static libraries below until after the tests are built.

Now, as the root user:

make install              &&
rm -v /usr/lib/libSDL2*.a

If you built the documentation, install it as the root user:

install -v -m755 -d        /usr/share/doc/SDL2-2.28.2/html &&
cp -Rv  docs/output/html/* /usr/share/doc/SDL2-2.28.2/html

Testing SDL2

If you wish to, test the installation of SDL2 using the included test programs. None of the resulting binaries need to be installed. Issue the following commands to build the test programs:

cd test &&
./configure &&
make

Each of the test programs (they are listed in the README file in this directory) will need to be run individually. Many of them will need to be manually killed. Additionally, speakers need to be on with the volume at a suitable level.

Command Explanations

rm -v /usr/lib/libSDL2*.a: Normally static libraries can be disabled with a --disable-static option to configure, but that breaks the build in this package.

--disable-alsa-shared: This switch disables dynamically loading ALSA shared libraries.

--disable-sdl-dlopen: This switch disables using dlopen for shared object loading. Loading image backend libraries like libpng dynamically on the fly does not work.

--disable-x11-shared: This switch disables dynamically loading X11 shared libraries.

Configuring SDL2

Configuration Information

As with most libraries, there is no configuration to do, save that the library directory, i.e., /opt/lib or /usr/local/lib should appear in /etc/ld.so.conf so that ldd can find the shared libraries. After checking that this is the case, /sbin/ldconfig should be run while logged in as root.

Contents

Installed Program: sdl2-config
Installed Libraries: libSDL2.so
Installed Directories: /usr/include/SDL2, /usr/lib/cmake/SDL2, and /usr/share/doc/SDL-2.28.2

Short Descriptions

sdl2-config

determines the compile and linker flags that should be used to compile and link programs that use libSDL2

libSDL2.so

contains functions that provide low level access to audio, keyboard, mouse, joystick, 3D hardware via OpenGL, and 2D frame buffer across multiple platforms

sound-theme-freedesktop-0.8

Introduction to Sound Theme Freedesktop

The Sound Theme Freedesktop package contains sound themes for the desktop.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of Sound Theme Freedesktop

Install Sound Theme Freedesktop by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: None
Installed Libraries: None
Installed Directories: /usr/share/sounds/freedesktop

SoundTouch-2.3.2

Introduction to SoundTouch

The SoundTouch package contains an open-source audio processing library that allows changing the sound tempo, pitch and playback rate parameters independently from each other.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Installation of SoundTouch

Note

The tarball expands to 'soundtouch' instead of the expected 'soundtouch-2.3.2'

Install SoundTouch by running the following commands:

Caution

The bootstrap command below fails if the ACLOCAL environment variable is set as specified in Xorg-7. If it is used, ACLOCAL needs to be unset for this package and then reset for other packages.

./bootstrap &&
./configure --prefix=/usr \
            --docdir=/usr/share/doc/soundtouch-2.3.2 &&
make

This package does not come with a test suite.

Now, as the root user:

make install 

Command Explanations

--enable-openmp: This switch adds support for running the algorithms in parallel across several processor cores using OpenMP implementation provided by GCC.

Contents

Installed Program: soundstretch
Installed Library: libSoundTouch.so
Installed Directories: /usr/include/soundtouch and /usr/share/doc/soundtouch-2.3.2

Short Descriptions

soundstretch

is a program for processing WAV audio files by modifying sound tempo, pitch and playback rate properties independently from each other

libSoundTouch.so

contains SoundTouch API functions

Speex-1.2.1

Introduction to Speex

Speex is an audio compression format designed specifically for speech. It is well-adapted to internet applications and provides useful features that are not present in most other CODECs.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Speex Dependencies

Required

libogg-1.3.5

Optional

Valgrind-3.21.0

Installation of Speex

This package consists of two separate tarballs. They need to be extracted and built independently.

Install Speex by running the following commands:

./configure --prefix=/usr    \
            --disable-static \
            --docdir=/usr/share/doc/speex-1.2.1 &&
make

This package does not come with a test suite.

As the root user:

make install

Now extract and install the speexdsp package:

cd ..                          &&
tar -xf speexdsp-1.2.1.tar.gz &&
cd speexdsp-1.2.1             &&

./configure --prefix=/usr    \
            --disable-static \
            --docdir=/usr/share/doc/speexdsp-1.2.1 &&
make

Again, as the root user:

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: speexenc and speexdec
Installed Libraries: libspeex.so and libspeexdsp.so
Installed Directories: /usr/include/speex and /usr/share/doc/speex-1.2.1

Short Descriptions

speexdec

decodes a Speex file and produces a WAV or raw file

speexenc

encodes a WAV or raw file using Speex

libspeex.so

provides functions for the audio encoding/decoding programs

libspeexdsp.so

is a speech processing library that goes along with the Speex codec

Taglib-1.13.1

Introduction to Taglib

Taglib is a library used for reading, writing and manipulating audio file tags and is used by applications such as Amarok and VLC.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Taglib Dependencies

Required

CMake-3.27.2

Optional (for tests)

Cppunit

Installation of Taglib

Install Taglib by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DBUILD_SHARED_LIBS=ON \
      .. &&
make

The test suite requires Cppunit but it's not a BLFS package.

Now, as the root user:

make install

Contents

Installed Programs: taglib-config
Installed Libraries: libtag.so and libtag_c.so
Installed Directories: /usr/include/taglib

Short Descriptions

taglib-config

is a tool used to print information about the taglib installation

v4l-utils-1.24.1

Introduction to v4l-utils

v4l-utils provides a series of utilities for media devices, allowing to handle the proprietary formats available at most webcams (libv4l), and providing tools to test V4L devices.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

v4l-utils Dependencies

Required

LLVM-16.0.5 (with target BPF)

Recommended
Optional

Doxygen-1.9.7 and SDL2-2.28.2

Installation of v4l-utils

Install v4l-utils by running the following commands:

./configure --prefix=/usr     \
            --sysconfdir=/etc \
            --disable-static  &&
make

This package does not come with a test suite.

Now, as the root user:

make -j1 install

Contents

Installed Programs: cec-compliance, cec-ctl, cec-follower, cx18-ctl, decode_tm6000, dvb-fe-tool, dvb-format-convert, dvbv5-daemon, dvbv5-scan, dvbv5-zap, ir-ctl, ir-keytable, ivtv-ctl, media-ctl, qv4l2, qvidcap, rds-ctl, v4l2-compliance, v4l2-ctl, v4l2-dbg, and v4l2-sysfs-path
Installed Library: libdvbv5.so, libv4l1.so, libv4l2.so, libv4l2rds.so, libv4lconvert.so, v4l1compat.so, and v4l2convert.so
Installed Directories: /etc/rc_keymaps, /lib/udev/rc_keymaps, /usr/include/libdvbv5, and /usr/lib/libv4l

Short Descriptions

cx18-ctl

is a tool to handle cx18 based devices

decode_tm6000

decodes multiplexed formats from TM5600/TM6000 USB devices

dvb-fe-tool

is a command line tool for digital TV services

dvb-format-convert

is a tool meant to convert among different file formats. It is compliant with version 5 of the DVB API

dvbv5-scan

is a command line frequency scanning tool for digital TV services that are compliant with version 5 of the DVB API

dvbv5-zap

is a command line tuning tool for digital TV services that is compliant with version 5 of the DVB API

ir-keytable

is a tool that lists the Remote Controller devices, allows one to get/set IR keycode/scancode tables, test events generated by IR, and to adjust other Remote Controller options

ivtv-ctl

is a utility that can control many card settings, like changing the inputs from tuner to svideo or composite, setting video resolution or changing video mode (PAL, SECAM, NTSC)

media-ctl

is a utility used to configure V4L2 devices

qv4l2

is used to test video4linux capture devices

qvidcap

is used to capture video from a V4L2 device

rds-ctl

is a utility for decoding raw RDS data from V4L2 Radio devices and offers simple ways to access the received RDS information

v4l2-compliance

is a compliance test tool

v4l2-ctl

is a tool to control v4l2 controls from the cmdline

v4l2-dbg

is a tool to directly get and set registers of v4l2 devices

v4l2-sysfs-path

checks the media devices installed on a machine and the corresponding device nodes

x264-20230215

Introduction to x264

x264 package provides a library for encoding video streams into the H.264/MPEG-4 AVC format.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

x264 Dependencies

Recommended
Optional

ffms2, gpac or liblsmash

Installation of x264

Install x264 by running the following commands:

./configure --prefix=/usr \
            --enable-shared \
            --disable-cli &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--disable-cli: This switch disables building the command-line encoder which is redundant since it requires FFmpeg for most of the input formats.

--disable-asm: Use this switch if you didn't install NASM.

Contents

Installed Programs: None
Installed Library: libx264.so
Installed Directory: None

Short Descriptions

libx264.so

provides the functions used to encode video streams into the H.264/MPEG-4 AVC format

x265-20230215

Introduction to x265

x265 package provides a library for encoding video streams into the H.265/HEVC format.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

x265 Dependencies

Required

CMake-3.27.2

Recommended
Optional

numactl

Installation of x265

Install x265 by running the following commands:

mkdir bld &&
cd    bld &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DGIT_ARCHETYPE=1           \
      -Wno-dev ../source          &&
make

This package does not come with a test suite.

Now, as the root user:

make install &&
rm -vf /usr/lib/libx265.a 

Command Explanations

-DGIT_ARCHETYPE=1: Upstream no longer provides releases. BLFS is using a git snapshot, but if the builder has not installed git the build will not install the shared library or the pkgconfig file without this switch.

-Wno-dev: This switch is used to suppress warnings intended for the package's developers.

rm -vf /usr/lib/libx265.a: BLFS does not recommend using static libraries.

Contents

Installed Program: x265
Installed Library: libx265.so
Installed Directories: None

Short Descriptions

libx265.so

provides the functions used to encode video streams into the H.265/HEVC format

xine-lib-1.2.13

Introduction to Xine Libraries

The Xine Libraries package contains xine libraries. These are useful for interfacing with external plug-ins that allow the flow of information from the source to the audio and video hardware.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Xine Libraries Dependencies

Required

a graphical environment, FFmpeg-6.0, and at least one of: ALSA-1.2.7, PulseAudio-16.1, or JACK

Recommended
Optional

AAlib-1.4rc5, FAAD2-2.10.1, FLAC-1.4.3, gdk-pixbuf-2.42.10, GLU-9.0.3, ImageMagick-7.1.1-15, liba52-0.7.4, libdvdcss-1.4.3, libmad-0.15.1b, libmng-2.0.3, libnsl-2.0.0, libtheora-1.1.1, libva-2.19.0 (requires GLU-9.0.3), libvdpau-1.5, libvorbis-1.3.7, libvpx-1.13.0, Mesa-23.1.6, Samba-4.18.6, sdl12-compat-1.2.64, Speex-1.2.1, Doxygen-1.9.7 (to create the API documentation), v4l-utils-1.24.1 DirectFB, libbluray, libcaca, libdca, libFAME, libmodplug, musepack, VCDImager, and WavPack,

Installation of Xine Libraries

Install Xine Libraries by running the following commands:

./configure --prefix=/usr          \
            --disable-vcd          \
            --with-external-dvdnav \
            --docdir=/usr/share/doc/xine-lib-1.2.13 &&
make

To create the API documentation, Doxygen must be installed and issue the following command:

doxygen doc/Doxyfile

This package does not come with a test suite.

Now, as the root user:

make install

Note

When installing, the Makefile does some additional linking. If you do not have Xorg in /usr, the LIBRARY_PATH variable needs to be defined for the root user. If using sudo to assume root, use the -E option to pass your current environment variables for the install process.

If you built the API documentation, issue the following commands as the root user to install it:

install -v -m755 -d /usr/share/doc/xine-lib-1.2.13/api &&
install -v -m644    doc/api/* \
                    /usr/share/doc/xine-lib-1.2.13/api

Command Explanations

--disable-vcd: This switch is required to compile Xine Lib without VCDImager installed. Remove this option if you have installed VCDImager.

--with-external-dvdnav: This switch is required, because internal libraries cannot decrypt DVD.

--docdir=/usr/share/doc/xine-lib-1.2.13: This switch causes the documentation to be installed into a versioned directory instead of the default /usr/share/doc/xine-lib.

--disable-vaapi: use this switch if libva-2.19.0 is installed and GLU-9.0.3 is not, to prevent a build failure.

Contents

Installed Programs: xine-config and xine-list-1.2
Installed Libraries: libxine.so and numerous plugin modules and video extensions under /usr/lib/xine/plugins/2.8
Installed Fonts: Output display engine fonts located in /usr/share/xine-lib/fonts
Installed Directories: /usr/include/xine, /usr/lib/xine, /usr/share/xine-lib, and /usr/share/doc/xine-lib-1.2.13

Short Descriptions

xine-config

provides information to programs trying to link with the xine libraries

xine-list-1.2

is used to get supported file type information from xine-lib

libxine.so

provides the API for processing audio/video files

XviD-1.3.7

Introduction to XviD

XviD is an MPEG-4 compliant video CODEC.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

XviD Dependencies

Optional

yasm-1.3.0 or NASM-2.16.01

Installation of XviD

Note

This package tarball expands to xvidcore, not the expected xvidcore-1.3.7.

Install XviD by running the following commands:

cd build/generic &&
sed -i 's/^LN_S=@LN_S@/& -f -v/' platform.inc.in &&

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

sed -i '/libdir.*STATIC_LIB/ s/^/#/' Makefile &&
make install &&

chmod -v 755 /usr/lib/libxvidcore.so.4.3 &&
install -v -m755 -d /usr/share/doc/xvidcore-1.3.7/examples &&
install -v -m644 ../../doc/* /usr/share/doc/xvidcore-1.3.7 &&
install -v -m644 ../../examples/* \
    /usr/share/doc/xvidcore-1.3.7/examples

Command Explanations

sed -i 's/^LN_S=@LN_S@/& -f -v/' platform.inc.in: Fix error during make install if reinstalling or upgrading.

sed -i '/libdir.*STATIC_LIB/ s/^/#/' Makefile: This command disables installing the static library.

Contents

Installed Programs: None
Installed Library: libxvidcore.so
Installed Directory: /usr/share/doc/xvidcore-1.3.7

Short Descriptions

libxvidcore.so

provides functions to encode and decode most MPEG-4 video data

Chapter 45. Audio Utilities

This chapter contains programs involved with audio file manipulation; that is to say playing, recording, ripping and the other common things which people want to do. It also includes a package used to render text to speech using your system's audio hardware. To use much of this software, you will need to have the kernel sound drivers installed.

Audacious-4.3.1

Introduction to Audacious

Audacious is an audio player.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Required Plugins

Audacious Dependencies

Required

GTK+-2.24.33 or GTK+-3.24.38 or (Qt-5.15.10 or qt-components-5.15.10 with qtmultimedia)

Recommended

libarchive-3.7.1

Optional

Valgrind-3.21.0

Recommended (for Plugins)
Optional (for Plugins)

ALSA-1.2.7, cURL-8.2.1, FAAD2-2.10.1, FLAC-1.4.3, LAME-3.100, libxml2-2.10.4, libcdio-2.1.0 (to identify and play CDs), libnotify-0.8.2, libsndfile-1.2.2, libvorbis-1.3.7, pipewire-0.3.77, PulseAudio-16.1, SDL2-2.28.2, ampache-browser, adplug, The Bauer stereophonic-to-binaural DSP (bs2b) library, FluidSynth, JACK (requires libsamplerate-0.2.2), libcue, libmodplug, libmms, libopenmpt, libsidplayfp, LIRC, sndio, SoX, and WavPack

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/audacious

Installation of Audacious

Installation of the Main Audacious Program

Install Audacious by running the following commands (you may wish to change the buildstamp to another string):

mkdir build &&
cd    build &&

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dgtk3=true         \
            -Dbuildstamp=BLFS   \
            -Dlibarchive=true   \
            ..                  &&

ninja

This package does not come with a test suite.

Now, as the root user:

ninja install

Installation of Audacious Plugins

Install the required plugins package by issuing the following commands:

tar -xf ../../audacious-plugins-4.3.1.tar.bz2 &&
cd audacious-plugins-4.3.1                    &&

mkdir build &&
cd    build &&

meson setup           \
  --prefix=/usr       \
  --buildtype=release \
  -Dgtk3=true         \
  ..                  &&

ninja

Now, as the root user:

ninja install

Command Explanations

-Dbuildstamp=BLFS: This switch appends the given text to the version string.

-Dgtk3=true: This options sets the default graphical user interface.

-Dvalgrind=true: The option enables Valgrind analysis support.

Contents

Installed Programs: audacious and audtool
Installed Libraries: libaudcore.so, libaudgui.so, libaudqt.so, libaudtag.so, and several plugin libraries under /usr/lib/audacious/ sub-directories
Installed Directories: /usr/include/{audacious,libaudcore,libaudgui,libaudqt}, /usr/lib/audacious, and /usr/share/audacious

Short Descriptions

audacious

is an audio player and is a descendant of XMMS

audtool

is a small tool to modify the behavior of a running audacious instance

CDParanoia-III-10.2

Introduction to CDParanoia

The CDParanoia package contains a CD audio extraction tool. This is useful for extracting .wav files from audio CDs. A CDDA capable CDROM drive is needed. Practically all drives supported by Linux can be used.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/cdparanoia

Installation of CDParanoia

Note

This package does not support parallel build.

Install CDParanoia by running the following commands:

patch -Np1 -i ../cdparanoia-III-10.2-gcc_fixes-1.patch &&
./configure --prefix=/usr --mandir=/usr/share/man &&
make -j1

This package does not come with a test suite.

Now, as the root user:

make install &&
chmod -v 755 /usr/lib/libcdda_*.so.0.10.2 &&
rm -fv /usr/lib/libcdda_*.a

Contents

Installed Program: cdparanoia
Installed Libraries: libcdda_interface.so and libcdda_paranoia.so
Installed Directories: None

Short Descriptions

cdparanoia

is used for 'ripping' an audio-cd. Ripping is the process of digitally extracting music from an audio CD

libcdda_interface

contains functions used by cdparanoia, as well as other packages, which can automatically identify if a CD device is CDDA compatible

libcdda_paranoia

contains functions used by cdparanoia, as well as other packages, which provide data verification, synchronization, error handling and scratch reconstruction capability

kwave-23.08.0

Introduction to KWave

The KWave package contains a KF5 based Sound Editor application.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

KWave Dependencies

Required

AudioFile-0.3.6, fftw-3.3.10, id3lib-3.8.3, and KDE Frameworks-5.109.0

Recommended
Optional

Doxygen-1.9.7

Installation of KWave

Install KWave by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
      -DCMAKE_BUILD_TYPE=Release         \
      -DBUILD_TESTING=OFF                \
      -Wno-dev .. &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Programs: kwave
Installed Libraries: libkwave.so, libkwavegui.so, and 29 plugins
Installed Directories: $KF5_PREFIX/lib/plugins/kwave, $KF5_PREFIX/share/kwave, $KF5_PREFIX/share/doc/HTML/*/kwave

Short Descriptions

kwave

is a sound editor built on the KDE Frameworks 5

LAME-3.100

Introduction to LAME

The LAME package contains an MP3 encoder and optionally, an MP3 frame analyzer. This is useful for creating and analyzing compressed audio files.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

LAME Dependencies

Optional

Dmalloc, Electric Fence, libsndfile-1.2.2 and NASM-2.16.01

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/lame

Installation of LAME

Install LAME by running the following commands:

./configure --prefix=/usr --enable-mp3rtp --disable-static &&
make

To test the results, issue: make test.

Now, as the root user:

make pkghtmldir=/usr/share/doc/lame-3.100 install

Command Explanations

--enable-mp3rtp: This switch enables building the encode-to-RTP program.

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-nasm: Enable the use of NASM-2.16.01 to compile optimized assembly routines for 32-bit x86. This option has no effect on x86_64.

Contents

Installed Programs: lame and mp3rtp
Installed Library: libmp3lame.so
Installed Directories: /usr/include/lame and /usr/share/doc/lame-3.100

Short Descriptions

lame

creates MP3 audio files from raw PCM or .wav data

mp3rtp

is used to encode MP3 with RTP streaming of the output

libmp3lame.so

libraries provide the functions necessary to convert raw PCM and WAV files to MP3 files

mpg123-1.31.3

Introduction to mpg123

The mpg123 package contains a console-based MP3 player. It claims to be the fastest MP3 decoder for Unix.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

mpg123 Dependencies

Recommended
Optional

PulseAudio-16.1, sdl12-compat-1.2.64, JACK, OpenAL and PortAudio

Installation of mpg123

Install mpg123 by running the following commands:

./configure --prefix=/usr &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Contents

Installed Programs: mpg123, mpg123-id3dump, mpg123-strip, and out123
Installed Libraries: libmpg123.so, libout123.so, and libsyn123.so
Installed Directory: /usr/lib/mpg123

Short Descriptions

mpg123

is used for playing MP3 files via the console

mpg123-id3dump

is a tool to dump ID3 meta data from MPEG audio files using libmpg123

mpg123-strip

extracts only MPEG frames from a stream using libmpg123 (stdin to stdout)

out123

plays raw PCM audio to an output device

libmpg123.so

contains the mpg123 API functions

libout123.so

contains the out123 API functions

libsyn123.so

contains some audio signal synthesis and format conversion functions

pavucontrol-5.0

Introduction to pavucontrol

PulseAudio Volume Control (pavucontrol) is a simple GTK based volume control tool ("mixer") for the PulseAudio sound server. In contrast to classic mixer tools, this one allows you to control both the volume of hardware devices and of each playback stream separately.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

pavucontrol Dependencies

Required

Gtkmm-3.24.8, JSON-GLib-1.6.6, libcanberra-0.30, libsigc++-2.12.0, and PulseAudio-16.1

Installation of pavucontrol

Install pavucontrol by running the following commands:

./configure --prefix=/usr --docdir=/usr/share/doc/pavucontrol-5.0 &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: pavucontrol
Installed Libraries: None
Installed Directory: /usr/share/pavucontrol and /usr/share/doc/pavucontrol-5.0

Short Descriptions

pavucontrol

is a GUI configuration tool for sound settings using pulsaudio

pnmixer-0.7.2

Introduction to Pnmixer

The Pnmixer package provides a lightweight volume control with a tray icon.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Pnmixer Dependencies

Required

alsa-utils-1.2.9, GTK+-3.24.38, and libnotify-0.8.2

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/pnmixer

Installation of Pnmixer

Install Pnmixer by running the following commands:

mkdir build &&
cd    build &&

cmake -DCMAKE_INSTALL_PREFIX=/usr ..  &&
make

This package does not have a test suite.

Now, as the root user:

make install

Contents

Installed Program: pnmixer
Installed Libraries: None
Installed Directories: /usr/share/pnmixer

Short Descriptions

pnmixer

is a lightweight volume control that sits in a tray

vorbis-tools-1.4.2

Introduction to Vorbis Tools

The Vorbis Tools package contains command-line tools useful for encoding, playing or editing files using the Ogg CODEC.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Vorbis Tools Dependencies

Required

libvorbis-1.3.7

Optional (required to build the ogg123 program)

libao-1.2.0

Optional

cURL-8.2.1, FLAC-1.4.3, Speex-1.2.1, and libkate

Installation of Vorbis Tools

Install Vorbis Tools by running the following commands:

./configure --prefix=/usr \
            --enable-vcut \
            --without-curl &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--enable-vcut: This parameter is used so that the vcut program is built as it is not by default.

--without-curl: This parameter disables HTTP streaming in ogg123. Remove this parameter if you have cURL installed.

Configuring Vorbis Tools

Config Files

/etc/libao.conf, ~/.libao and ~/.ogg123rc

Configuration Information

Issue man libao.conf for information about setting the default output device. Also see /usr/share/doc/vorbis-tools-1.4.2/ogg123rc-example .

Contents

Installed Programs: ogg123, oggdec, oggenc, ogginfo, vcut and vorbiscomment
Installed Libraries: None
Installed Directory: /usr/share/doc/vorbis-tools-1.4.2

Short Descriptions

ogg123

is a command-line audio player for Ogg Vorbis streams

oggdec

is a simple decoder which converts Ogg Vorbis files into PCM audio files (WAV or raw)

oggenc

is an encoder that turns raw, WAV or AIFF files into an Ogg Vorbis stream

ogginfo

prints information stored in an audio file

vcut

splits a file into two files at a designated cut point

vorbiscomment

is an editor that changes information in the audio file metadata tags

Chapter 46. Video Utilities

This chapter always seems to be the favorite chapter. It's probably because there is a lot of satisfaction in playing your first video when you have spent so much time getting to that point. All those libraries, all the configurations and your reward is that you finally get to watch a movie. Not to worry though, there is always one more CODEC to install.

FFmpeg-6.0

Introduction to FFmpeg

FFmpeg is a solution to record, convert and stream audio and video. It is a very fast video and audio converter and it can also acquire from a live audio/video source. Designed to be intuitive, the command-line interface (ffmpeg) tries to figure out all the parameters, when possible. FFmpeg can also convert from any sample rate to any other, and resize video on the fly with a high quality polyphase filter. FFmpeg can use a Video4Linux compatible video source and any Open Sound System audio source.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

  • Download (HTTP): https://ffmpeg.org/releases/ffmpeg-6.0.tar.xz

  • Download MD5 sum: 47b6c5d930937413c3e308e2fdb3dfb5

  • Download size: 9.8 MB

  • Estimated disk space required: 187 MB (add 1.5 GB for the FATE suite/tests, add 786 MB for documentation)

  • Estimated build time: 1.3 SBU (using parallelism=4; add 3.2 SBU (with THREADS=4) to run the FATE suite after sample files are downloaded; add 0.3 SBU for doxygen docs)

Additional Downloads

FFmpeg Dependencies

Recommended
Recommended for desktop use
Optional

Doxygen-1.9.7, Fontconfig-2.14.2, FriBidi-1.0.13, frei0r-plugins-1.8.0, libcdio-2.1.0 (to identify and play CDs), libdrm-2.4.115 (for kmsgrab input), libwebp-1.3.1, opencv-4.8.0, OpenJPEG-2.5.0, GnuTLS-3.8.1, PulseAudio-16.1, Samba-4.18.6, Speex-1.2.1, texlive-20230313 (or install-tl-unx) for PDF and PS documentation, v4l-utils-1.24.1, XviD-1.3.7, a graphical environment, Flite, GSM, libaacplus, libbluray, libcaca, libcelt, libdc1394, libdca, libiec61883, libilbc, libmodplug, libnut (Git checkout), librtmp, libssh, OpenAL, OpenCore AMR, Srt, Schroedinger, TwoLAME, vo-aaenc, vo-amrwbenc, and ZVBI

Installation of FFmpeg

Note

Some harmless warnings may be output by the build process regarding the HTML documentation. This is due to an incompatibility with Texinfo-7.0 and higher.

First, apply a patch that adds an API necessary for some packages to build:

patch -Np1 -i ../ffmpeg-6.0-chromium_method-1.patch

Now, apply a patch that allows the package to build with binutils-2.41:

patch -Np1 -i ../ffmpeg-6.0-binutils_2.41-1.patch

Install FFmpeg by running the following commands:

./configure --prefix=/usr        \
            --enable-gpl         \
            --enable-version3    \
            --enable-nonfree     \
            --disable-static     \
            --enable-shared      \
            --disable-debug      \
            --enable-libaom      \
            --enable-libass      \
            --enable-libfdk-aac  \
            --enable-libfreetype \
            --enable-libmp3lame  \
            --enable-libopus     \
            --enable-libtheora   \
            --enable-libvorbis   \
            --enable-libvpx      \
            --enable-libx264     \
            --enable-libx265     \
            --enable-openssl     \
            --docdir=/usr/share/doc/ffmpeg-6.0 &&

make &&

gcc tools/qt-faststart.c -o tools/qt-faststart

HTML documentation was built in the previous step. If you have texlive-20230313 installed and wish to build PDF and Postscript versions of the documentation, issue the following commands:

pushd doc &&
for DOCNAME in `basename -s .html *.html`
do
    texi2pdf -b $DOCNAME.texi &&
    texi2dvi -b $DOCNAME.texi &&

    dvips    -o $DOCNAME.ps   \
                $DOCNAME.dvi
done &&
popd &&
unset DOCNAME

If you have Doxygen-1.9.7 installed and you wish to build (if --disable-doc was used) or rebuild the html documentation, issue:

doxygen doc/Doxyfile

The fate-suite tests include comparisons with installed files, and should not be run before the package is installed. Therefore, if you desire to run them, instructions are given further below.

Now, as the root user:

make install &&

install -v -m755    tools/qt-faststart /usr/bin &&
install -v -m755 -d           /usr/share/doc/ffmpeg-6.0 &&
install -v -m644    doc/*.txt /usr/share/doc/ffmpeg-6.0

If the PDF and Postscript documentation was built, issue the following commands, as the root user, to install them:

install -v -m644 doc/*.pdf /usr/share/doc/ffmpeg-6.0 &&
install -v -m644 doc/*.ps  /usr/share/doc/ffmpeg-6.0

If you used doxygen to manually create the API documentation, install it by issuing the following commands as the root user:

install -v -m755 -d /usr/share/doc/ffmpeg-6.0/api                     &&
cp -vr doc/doxy/html/* /usr/share/doc/ffmpeg-6.0/api                  &&
find /usr/share/doc/ffmpeg-6.0/api -type f -exec chmod -c 0644 \{} \; &&
find /usr/share/doc/ffmpeg-6.0/api -type d -exec chmod -c 0755 \{} \;

To properly test the installation you must have rsync-3.2.7 installed and follow the instructions for the FFmpeg Automated Testing Environment (FATE). First, about 1 GB of sample files used to run FATE are downloaded with the command:

make fate-rsync SAMPLES=fate-suite/

The fate-suite directory is created and the files are downloaded there. That command actually runs an rsync command to obtain the sample files. You may want to compress and keep this directory for testing again, for testing in another system, or for when a new version of ffmpeg is released. Then, unpack the sample files in the source directory, and run the make fate-rsync ... command above to sync with the upstream repository. The download size and time are drastically reduced by doing this. Estimated values in "Package Information" do not include the download SBU. Some samples may have been removed in newer versions, so in order to be sure local and server fate samples are identical when you use previously saved samples, run the following command:

rsync -vrltLW  --delete --timeout=60 --contimeout=60 \
      rsync://fate-suite.ffmpeg.org/fate-suite/ fate-suite/

Next, execute FATE with the following commands (there are more than 3800 tests in the suite):

make fate THREADS=N SAMPLES=fate-suite/ | tee ../fate.log &&
grep ^TEST ../fate.log | wc -l

where N is an integer, N ≤ number of cores in the system.

A successful run should return no errors or warnings, just a list of tests and total amount at the end.

Command Explanations

sed -i ... configure: This command adds the ALSA library to the Flite LDFLAGS variable and enables the discovery of Flite.

find ... ;: Fixes permissions of documentation files and directories.

--enable-libfreetype: Enables Freetype support.

--enable-gpl: Enables the use of GPL code and permits support for postprocessing, swscale and many other features.

--enable-version3: Enables the use of (L)GPL version 3 code.

--enable-nonfree: Enables the use of nonfree code. Note that the resulting libraries and binaries will be unredistributable.

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-shared: Enables building shared libraries, otherwise only static libraries are built and installed.

--disable-debug: Disables building debugging symbols into the programs and libraries.

--enable-libaom: Enables AV1 audio and video decoding via libaom.

--enable-libass: Enables ASS/SSA subtitle format rendering via libass.

--enable-libdrm: Use this switch if libdrm-2.4.115 is installed to build the kmsgrab input module which is useful for screen capturing or streaming.

--enable-libfdk-aac: Enables AAC audio encoding via libfdk-aac.

--enable-libmp3lame: Enables MP3 audio encoding via libmp3lame.

--enable-libvorbis --enable-libtheora: Enables Theora video encoding via libvorbis and libtheora.

--enable-libvorbis --enable-libvpx: Enables WebM encoding via libvorbis and libvpx.

--enable-libx264: Enables high-quality H.264/MPEG-4 AVC encoding via libx264.

--enable-libx265: Enables high-quality H.265/HEVC encoding via libx265.

--enable-openssl: Enables HTTPS protocol for network streams.

--enable-gnutls: Use this option instead of --enable-openssl, if you want to use GnuTLS instead of OpenSSL for HTTPS protocol.

--disable-doc: Disables building html documentation. This is only needed if Doxygen-1.9.7 is installed and you do not want to build the html documentation.

--enable-libpulse: Enables support for Pulseaudio for audio output.

gcc tools/qt-faststart.c -o tools/qt-faststart: This builds the qt-faststart program which can modify QuickTime formatted movies (.mov or .mp4) so that the header information is located at the beginning of the file instead of the end. This allows the movie file to begin playing before the entire file has been downloaded.

Note

Support for most of the dependency packages requires using options passed to the configure script. View the output from ./configure --help for complete information about enabling dependency packages.

Contents

Installed Programs: ffmpeg, ffplay, ffprobe, and qt-faststart
Installed Libraries: libavcodec.so, libavdevice.so, libavfilter.so, libavformat.so, libavutil.so, libpostproc.so, libswresample.so, and libswscale.so
Installed Directories: /usr/include/libav{codec,device,filter,format,util}, /usr/include/libpostproc, /usr/include/libsw{resample,scale}, /usr/share/doc/ffmpeg-6.0, and /usr/share/ffmpeg

Short Descriptions

ffmpeg

is a command-line tool to convert video files, network streams and input from a TV card to several video formats

ffplay

is a very simple and portable media player using the ffmpeg libraries and the SDL library

ffprobe

gathers information from multimedia streams and prints it in a human and machine-readable fashion

qt-faststart

moves the index file to the front of quicktime (mov/mp4) videos

libavcodec.so

is a library containing the FFmpeg codecs (both encoding and decoding)

libavdevice.so

is the FFmpeg device handling library

libavfilter.so

is a library of filters that can alter video or audio between the decoder and the encoder (or output)

libavformat.so

is a library containing the file formats handling (mux and demux code for several formats) used by ffplay as well as allowing the generation of audio or video streams

libavresample.so

is a library containing functions for resampling audio and video.

libavutil.so

is the FFmpeg utility library

libpostproc.so

is the FFmpeg post processing library

libswresample.so

is the FFmpeg audio rescaling library, it contains functions for converting audio sample formats

libswscale.so

is the FFmpeg image rescaling library

MPlayer-1.5

Introduction to MPlayer

MPlayer is a powerful audio/video player controlled via the command line or a graphical interface that is able to play almost every popular audio and video file format. With supported video hardware and additional drivers, MPlayer can play video files without an X Window System installed.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Skins

Note

Skins are only required in order to use the Gtk+ 2 user interface.

MPlayer Dependencies

Required

yasm-1.3.0

Recommended
Optional Input Drivers and Libraries

CDParanoia-III-10.2, libcdio-2.1.0 (to identify and play CDs), libdvdread-6.1.3, libdvdnav-6.1.1, libdvdcss-1.4.3, Samba-4.18.6, libbluray, LIVE555 Streaming Media, RTMPDump, TiVo vstream client, and XMMS

Optional Audio Output Drivers and Libraries

ALSA-1.2.7, PulseAudio-16.1, sdl12-compat-1.2.64, JACK, NAS, and OpenAL

Optional Video Output Drivers and Libraries

AAlib-1.4rc5, giflib-5.2.1, libjpeg-turbo-3.0.0, libmng-2.0.3, libpng-1.6.40, OpenJPEG1 DirectFB, libcaca, and SVGAlib

Optional CODECs

FAAC-1_30, FAAD2-2.10.1, LAME-3.100, liba52-0.7.4, libdv-1.0.0, libmad-0.15.1b, libmpeg2-0.5.1, libtheora-1.1.1, libvpx-1.13.0, LZO-2.10, mpg123-1.31.3, Speex-1.2.1, XviD-1.3.7, x264-20230215, CrystalHD, Dirac, GSM, iLBC, libdca, libnut, libmpcdec, OpenCore Adaptive Multi Rate, Schroedinger, Tremor, and TwoLAME

Optional Miscellaneous Dependencies

Fontconfig-2.14.2, FreeType-2.13.1, FriBidi-1.0.13, GnuTLS-3.8.1, Opus-1.3.1, and UnRar-6.2.10; libxslt-1.1.38, docbook-xml-4.5 and docbook-xsl-nons-1.79.2 (all three required to build the HTML documentation); and Enca, libbs2b, and LIRC (and LIRC Client Daemon)

Installation of MPlayer

Main MPlayer Installation

There are two patches related to FFmpeg-6.0 that need to be applied. Do that now:

patch -Np1 -i ../MPlayer-1.5-upstream_ffmpg6_fixes-1.patch &&
patch -Np1 -d ffmpeg -i ../ffmpeg-6.0-binutils_2.41-1.patch

Note

The package maintainers recommend building without any optimizations.

You may wish to examine the output from ./configure --help to find out what additional parameters to configure are needed to include the dependencies you have installed on your system.

Install MPlayer by running the following commands:

./configure --prefix=/usr                 \
            --confdir=/etc/mplayer        \
            --enable-dynamic-plugins      \
            --disable-libmpeg2-internal   \
            --enable-menu                 \
            --enable-runtime-cpudetection \
            --enable-gui                  &&
make

If you wish to build the HTML documentation, issue the following command:

make doc

This package does not come with a test suite.

Now, as the root user:

make install  &&
ln -svf ../icons/hicolor/48x48/apps/mplayer.png \
        /usr/share/pixmaps/mplayer.png

To install the HTML documentation, issue the following commands as the root user:

install -v -m755 -d /usr/share/doc/mplayer-1.5 &&
install -v -m644    DOCS/HTML/en/* \
                    /usr/share/doc/mplayer-1.5

You will only need codecs.conf if you want to change its properties, as the main binary contains an internal copy of it. Ensure any changes you make to codecs.conf achieve the desired results, as incorrect entries in this file have been known to cause errors and render the player unusable. If necessary, create the file as the root user:

install -v -m644 etc/codecs.conf /etc/mplayer

You may alternatively want to copy all the default configuration files to /etc/mplayer for future reference or more customization ability. As the root user:

install -v -m644 etc/*.conf /etc/mplayer

Skin Installation (Optional)

To enable the Gtk+ 2 frontend of MPlayer, you'll need to install at least one skin. Extract the desired skin and create the default location (as the root user):

tar -xvf  ../Clearlooks-2.0.tar.bz2 \
    -C    /usr/share/mplayer/skins &&
ln  -sfvn Clearlooks /usr/share/mplayer/skins/default

Note

This package installs icon files into the /usr/share/icons/hicolor hierarchy and desktop files into the /usr/share/applications hierarchy. You can improve system performance and memory usage by updating /usr/share/icons/hicolor/index.theme and /usr/share/applications/mimeinfo.cache. To perform the update you must have GTK+-2.24.33 or GTK+-3.24.38 installed (for the icon cache) and desktop-file-utils-0.26 (for the desktop cache) and issue the following commands as the root user:

gtk-update-icon-cache -qtf /usr/share/icons/hicolor &&
update-desktop-database -q

Command Explanations

--enable-gui: This option builds the GUI interface into mplayer.

--enable-menu: This option is set to enable the on-screen display.

--enable-runtime-cpudetection: This option makes MPlayer run with a generic CPU type, preventing optimizations that may cause runtime problems.

--disable-ffmpeg_a: You can use this option if you have installed a version of ffmpeg prior to ffmpeg-6.0. This version of MPlayer is incompatible with the latest version of ffmpeg. MPlayer does include a copy of the FFmpeg source and without this option it will statically compile the included version of FFmpeg into itself. Dynamically linking to a system installed FFmpeg makes MPlayer and Mencoder about 9MB smaller.

--disable-libmpeg2-internal: This option makes MPlayer run with a system version of libmpeg2.

--language-doc="<lang>": This switch sets the language used for the documentation. Use ./configure --help for more information.

--language-man="<lang>": This switch sets the language used for the man pages. Use ./configure --help for more information.

--language-msg="<lang>": This switch sets the language used for messages and the GUI. Use ./configure --help for more information

--language="<lang>": This switch sets the default language used. Use ./configure --help for more information.

Note

Specific options override --language. You can pass a list of languages separated by whitespace or commas instead of a single language. Nonexisting translations will be dropped from each list. All documentation and man page translations available in the list will be installed, for the messages the first available translation will be used. The value "all" will activate all translations. The LINGUAS environment variable is honored. In all cases the fallback is English. Values listed by ./configure --help are not all available, as would normally be expected. You need to build test.

Configuring MPlayer

Config Files

/etc/mplayer/* and ~/.mplayer/*

Note

To play a DVD, it may be useful to ensure a /dev/dvd device is created. You may need to set this up as described in the section called “Devices for DVD Drives”.

Configuration Information

Typically, there's no configuration required for the system-wide files in /etc/mplayer (in fact, this directory is empty unless you copied the default files as mentioned above). Configuration can be accomplished by choosing the configuration button located on the MPlayer GUI. Any configuration changes made in the GUI will be saved in the user's ~/.mplayer directory.

Contents

Installed Programs: gmplayer, mplayer and mencoder
Installed Libraries: None
Installed Directories: /etc/mplayer, /usr/share/doc/mplayer-1.5 and /usr/share/mplayer

Short Descriptions

gmplayer

is a symlink to mplayer which brings up the GTK+ 2 frontend of MPlayer

mplayer

is the main MPlayer video player

mencoder

is a powerful command line video decoding, encoding and filtering tool that is useful for (amongst other things) ripping DVDs to files on your hard disk (see /usr/share/doc/mplayer-1.5/mencoder.html)

Transcode-1.1.7

Introduction to Transcode

Transcode was a fast, versatile and command-line based audio/video everything to everything converter primarily focused on producing AVI video files with MP3 audio, but also including a program to read all the video and audio streams from a DVD.

Although outdated and no longer maintained, it can still be used to extract items from a DVD using only the required and recommended dependencies, or to recode to AVI files.

Subjects to the comments below, this package is known to build and minimally work using the current LFS platform.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Transcode Dependencies

Recommended
Optional

FAAC-1_30, FreeType-2.13.1, ImageMagick-6, liba52-0.7.4, libdv-1.0.0, libjpeg-turbo-3.0.0, libogg-1.3.5, libquicktime-1.2.4, libtheora-1.1.1, libvorbis-1.3.7, libxml2-2.10.4, LZO-2.10, sdl12-compat-1.2.64, v4l-utils-1.24.1, x264-20230215, XviD-1.3.7 MJPEG Tools, and PVM3,

Optional (at runtime)

lsdvd

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/transcode

Installation of Transcode

Note

Support for most of the dependency packages requires using options passed to the configure script. View the INSTALL file and the output from ./configure --help for complete information about enabling dependency packages.

Install Transcode by running the following commands:

sed -i 's|doc/transcode|&-$(PACKAGE_VERSION)|' \
       $(find . -name Makefile.in -exec grep -l 'docsdir =' {} \;) &&

patch -Np1 -i ../transcode-1.1.7-gcc10_fix-1.patch &&

./configure --prefix=/usr     \
            --enable-alsa     \
            --enable-libmpeg2 \
            --disable-ffmpeg  &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

sed -i ...: Fixes install location for documentation.

--disable-ffmpeg: This switch disables support for ffmpeg because libavresample was removed in ffmpeg-5.x.

Contents

Installed Programs: avifix, aviindex, avimerge, avisplit, avisync, tccat, tcdecode, tcdemux, tcextract, tcmodinfo, tcmp3cut, tcprobe, tcscan, tcxmlcheck, tcxpm2rgb, tcyait, and transcode
Installed Libraries: None
Installed Directories: /usr/lib/transcode and /usr/share/doc/transcode-1.1.7

Short Descriptions

avifix

fixes the header of an AVI file

aviindex

writes a text file describing the index of an AVI file

avimerge

merges AVI files of the same format. Do not try to merge AVI files of different formats, it will most likely result in errors (and format means same bitrates, too!)

avisplit

splits AVI files into multiple files

avisync

can shift audio in AVI files for better synchronizing of the audio and video data signal

tccat

concatenates input files using the input plugins of Transcode. This is useful for extracting VOB (Video OBject) files, either for a whole DVD or for selected Titles or Chapters, which can then be played or recoded

tcdecode

is used to decode input files to raw video and PCM audio streams

tcdemux

demultiplexes (separates) audio/video input that contains multiple streams, e.g., VOB files

tcextract

grabs single streams from a file containing multiple streams

tcmodinfo

loads a supplied Transcode filter module and prints its parameters

tcmp3cut

is a tool which can cut MP3 streams at milliseconds positions

tcprobe

prints information about the input file format

tcscan

performs several measurements on the given input data

tcxmlcheck

checks information in a SMIL input file

transcode

is the encoder's user interface that handles the plugins and other programs, being the glue between the modules. There are several well documented usage examples on both the homepage and the documentation included in the package

VLC-3.0.18

Introduction to VLC

VLC is a media player, streamer, and encoder. It can play from many inputs, such as files, network streams, capture devices, desktops, or DVD, SVCD, VCD, and audio CD. It can use most audio and video codecs (MPEG 1/2/4, H264, VC-1, DivX, WMV, Vorbis, AC3, AAC, etc.), and it can also convert to different formats and/or send streams through the network.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

VLC Dependencies

Recommended
Optional features and packages

dbus-1.14.8, libidn-1.41, and libssh2-1.11.0

Optional input plugins

libarchive-3.7.1, libcddb-1.3.2, libdv-1.0.0, libdvdcss-1.4.3, libdvdread-6.1.3, libdvdnav-6.1.1, opencv-4.8.0, Samba-4.18.6, v4l-utils-1.24.1, libbluray, libdc1394, libnfs, libproxy, libraw1394, Live555, and VCDImager (requires libcdio-2.1.0)

Optional mux/demux plugins

libogg-1.3.5, Game Music Emu, libdvbpsi, libshout, libmatroska (requires libebml), libmodplug, Musepack, and sidplay-libs

Optional codec plugins

FAAD2-2.10.1, FLAC-1.4.3, libaom-3.6.1, libass-0.17.1, libmpeg2-0.5.1, libpng-1.6.40, libtheora-1.1.1, libva-2.19.0, libvorbis-1.3.7, Opus-1.3.1, Speex-1.2.1, libvpx-1.13.0, x264-20230215, aribb24, dav1d, Dirac, FluidLite, FluidSynth, libdca, libkate, OpenMAX, Schroedinger, Shine, SoX, Tremor, Twolame, and Zapping VBI

Optional video plugins

AAlib-1.4rc5, Fontconfig-2.14.2, FreeType-2.13.1, FriBidi-1.0.13, librsvg-2.56.3, libvdpau-1.5, sdl12-compat-1.2.64, libcaca, and libmfx

Optional audio plugins

PulseAudio-16.1, libsamplerate-0.2.2, spatialaudio, and JACK

Optional interface plugins

(Qt-5.15.10 or qt-alternate-5.15.10) (required for the graphical user interface), libtar, libvncclient, LIRC, and freerdp

Optional visualisations and video filter plugins

Goom, libvsxu, and projectM

Optional service discovery plugins

Avahi-0.8, libmtp and libupnp

Miscellaneous options

GnuTLS-3.8.1, libnotify-0.8.2, libxml2-2.10.4, taglib-1.13.1, xdg-utils-1.1.3 (runtime), AtmoLight, libmicrodns, protobuf, and Srt

Installation of VLC

Install VLC by running the following commands:

export LUAC=/usr/bin/luac5.2                          &&
export LUA_LIBS="$(pkg-config --libs lua52)"          &&
export CPPFLAGS="$(pkg-config --cflags lua52)"        &&

BUILDCC=gcc ./configure --prefix=/usr --disable-libva &&

make

To test the results, issue: make check.

Now, as the root user:

make docdir=/usr/share/doc/vlc-3.0.18 install

Note

This package installs icon files into the /usr/share/icons/hicolor hierarchy and desktop files into the /usr/share/applications hierarchy. You can improve system performance and memory usage by updating /usr/share/icons/hicolor/index.theme and /usr/share/applications/mimeinfo.cache. To perform the update you must have GTK+-2.24.33 or GTK+-3.24.38 installed (for the icon cache) and desktop-file-utils-0.26 (for the desktop cache) and issue the following commands as the root user:

gtk-update-icon-cache -qtf /usr/share/icons/hicolor &&
update-desktop-database -q

Command Explanations

export ...: These commands ensure building with Lua-5.2.4. Upstream does not support lua 5.4 yet.

--disable-libva: This switch is required to disable video acceleration in VLC since it is incompatible with ffmpeg-5, and upstream has no plans to port it due to complexity.

--disable-vpx: Use this switch to disable libvpx.

--disable-mad: Use this switch if you don't have libmad installed.

--disable-avcodec --disable-swscale: Use these switches if you don't have FFmpeg installed.

--disable-a52: Use this switch if you don't have liba52 installed.

--disable-xcb: Use this switch if you don't have X Window System installed.

--disable-alsa: Use this switch if you don't have ALSA installed.

--disable-libgcrypt: Use this switch if you don't have libgcrypt installed.

--disable-sftp: The default is to build the sftp module if libssh2-1.11.0 is installed. Use this switch if you do not want to build this module.

Note

There are many options to VLC's configure command. Check the configure --help output for a complete list.

Contents

Installed Programs: cvlc, nvlc, qvlc, rvlc, svlc, vlc and vlc-wrapper
Installed Libraries: libvlccore.so, libvlc.so, and many plugins in /usr/lib/vlc/plugins
Installed Directories: /usr/{include,lib,share}/vlc, /usr/share/kde4, and /usr/share/doc/vlc-3.0.18

Short Descriptions

cvlc

is a script to run VLC with the dummy interface

nvlc

is a script to run VLC with the ncurses interface

qvlc

is a script to run VLC with the Qt interface

rvlc

is a script to run VLC with a command line interface

svlc

is a script to run VLC with the skins interface

vlc

is the VLC media player

vlc-wrapper

is a wrapper to drop privileges with VLC

xine-ui-0.99.14

Introduction to Xine User Interface

The xine User Interface package contains a multimedia player. It plays back CDs, DVDs and VCDs. It also decodes multimedia files like AVI, MOV, WMV, MPEG and MP3 from local disk drives, and displays multimedia streamed over the Internet.

This package is known to build and work properly using an LFS 12.0 platform.

Note

Although this version of xine-ui works with most files, it is unable to open encrypted (content-scrambled) DVDs with the current version of libdvdcss.

Package Information

Xine User Interface Dependencies

Required

xine-lib-1.2.13 and shared-mime-info-2.2

Optional

cURL-8.2.1, AAlib-1.4rc5, LIRC, and libcaca

Installation of Xine User Interface

Install xine User Interface by running the following commands:

./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make docsdir=/usr/share/doc/xine-ui-0.99.14 install

Note

This package installs icon files into the /usr/share/icons/hicolor hierarchy and desktop files into the /usr/share/applications hierarchy. You can improve system performance and memory usage by updating /usr/share/icons/hicolor/index.theme and /usr/share/applications/mimeinfo.cache. To perform the update you must have GTK+-2.24.33 or GTK+-3.24.38 installed (for the icon cache) and desktop-file-utils-0.26 (for the desktop cache) and issue the following commands as the root user:

gtk-update-icon-cache -qtf /usr/share/icons/hicolor &&
update-desktop-database -q

Command Explanations

docsdir=/usr/share/doc/xine-ui-0.99.14: This parameter causes the Xine UI documentation to be installed in the versioned directory /usr/share/doc/xine-ui-0.99.14, rather that the default /usr/share/doc/xine-ui.

Configuring Xine User Interface

Config Files

~/.xine/config

Configuration Information

The above file is created and maintainable through the xine setup dialog box. The documentation for the configuration settings is located at /usr/share/doc/xine-ui-0.99.14/README.config_en.

If you have a DVB TV card, you can watch TV with the command xine dvb:// and change channels with the scroll wheel on your mouse.

Contents

Installed Programs: aaxine, cacaxine, fbxine, xine, xine-bugreport, xine-check, and xine-remote
Installed Libraries: None
Installed Directories: /usr/share/xine and /usr/share/doc/xine-ui-0.99.14

Short Descriptions

aaxine

is an ASCII art video player which utilizes AAlib as the frontend for the xine Libraries

cacaxine

is a color ASCII art video player which utilizes CACA as the frontend for the xine Libraries

fbxine

is a frame buffer interface to the xine Libraries

xine

is a multimedia player designed to play MPEG streams (audio and video), MPEG elementary streams (MP3), MPEG transport streams, Ogg files, AVI files, ASF files, some Quicktime files, VCDs and DVDs

xine-bugreport

produces a terse system description and guides you through the process of reporting a bug

xine-check

tests the xine video player installation for common problems. It tests the operating system settings, installation of plugins, CD/DVD drive settings and video support parameters

xine-remote

is a tool to connect to a xine remote control server

Chapter 47. CD/DVD-Writing Utilities

This chapter contains information on CD/DVD-writing utilities in Linux.

Additional sources of information include:

Cdrdao-1.2.4

Introduction to Cdrdao

The Cdrdao package contains CD recording utilities. These are useful for burning a CD in disk-at-once mode.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Cdrdao Dependencies

Recommended

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/cdrdao

Installation of Cdrdao

Install Cdrdao by running the following commands:

./configure --prefix=/usr --mandir=/usr/share/man &&
make

This package does not come with a test suite.

Now, as the root user:

make install &&
install -v -m755 -d /usr/share/doc/cdrdao-1.2.4 &&
install -v -m644 README /usr/share/doc/cdrdao-1.2.4

Command Explanations

--mandir=/usr/share/man: Install manual pages in /usr/share/man instead of /usr/man.

Contents

Installed Programs: cdrdao, cue2toc, toc2cddb, toc2cue and optionally toc2mp3
Installed Libraries: None
Installed Directories: /usr/share/cdrdao, /usr/share/doc/cdrdao-1.2.4

Short Descriptions

cdrdao

records audio or data CD-Rs in disk-at-once (DAO) mode based on a textual description of the CD contents

cue2toc

converts CUE to TOC format for audio CDs

toc2cddb

converts a Cdrdao TOC file into a cddb file and prints it to stdout

toc2cue

converts TOC to CUE format for audio CDs

toc2mp3

converts an audio CD disk image (.toc file) to MP3 files

Cdrtools-3.02a09

Introduction to Cdrtools

The Cdrtools package contains CD recording utilities. These are useful for reading, creating or writing (burning) CDs, DVDs, and Blu-ray discs.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Cdrtools Dependencies

Required

alsa-lib-1.2.9

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/Cdrtools

Installation of Cdrtools

Note

This package does not support parallel build.

Install Cdrtools by running the following commands:

export GMAKE_NOWARN=true &&
make -j1 INS_BASE=/usr DEFINSUSR=root DEFINSGRP=root

This package does not come with a test suite.

Now, as the root user:

export GMAKE_NOWARN=true &&
make INS_BASE=/usr MANSUFF_LIB=3cdr DEFINSUSR=root DEFINSGRP=root install &&
install -v -m755 -d /usr/share/doc/cdrtools-3.02a09 &&
install -v -m644 README.* READMEs/* ABOUT doc/*.ps \
                    /usr/share/doc/cdrtools-3.02a09

Command Explanations

export GMAKE_NOWARN=true: This variable avoids a warning when using GNU make.

INS_BASE=/usr: This parameter moves the install directory from /opt/schily to /usr.

DEFINSUSR=root DEFINSGRP=root: These parameters install all programs with root:root ownership instead of the default bin:bin.

MANSUFF_LIB=3cdr: This parameter prevents Cdrtools from overwriting important pages which are already installed by LFS. The installed man pages of section 3 will have a suffix 3cdr and can be shown using man 3cdr <manpage>.

Contents

Installed Programs: btcflash, cdda2mp3, cdda2ogg, cdda2wav, cdrecord, devdump, isodebug, isodump, isoinfo, isovfy, mkhybrid, mkisofs, readcd, rscsi, scgcheck, scgskeleton
Installed Libraries: libcdrdeflt.a, libdeflt.a, libedc_ecc.a, libedc_ecc_dec.a, libfile.a, libfind.a, libhfs.a, libmdigest.a, libparanoia.a, librscg.a, libscg.a, libscgcmd.a, libschily.a, libsiconv.a
Installed Directories: /usr/lib/{profiled,siconv}, /usr/include/{scg,schily}, /usr/share/doc/cdda2wav,cdrecord,libparanoia,mkisofs,rscsi}

Short Descriptions

btcflash

flashes the firmware on BTC DRW1008 DVD+/-RW recorder. Please exercise care with this program

cdda2wav

converts Compact Disc audio into WAV sound files

cdrecord

records audio or data Compact Discs

devdump

is a diagnostic program used to dump an ISO-9660 device or file in hex

isodebug

is used to display the command-line parameters used to create an ISO-9660 image

isodump

is a diagnostic program used to dump a device or file based on ISO-9660

isoinfo

is used to analyze or list an ISO-9660 image

isovfy

is used to verify an ISO-9660 image

mkhybrid

is a symbolic link to mkisofs used to create ISO-9660/HFS hybrid filesystem images

mkisofs

is used to create ISO-9660/JOLIET/HFS filesystem images, optionally with Rock Ridge attributes

readcd

reads or writes Compact Discs

rscsi

is a remote SCSI manager

scgcheck

is used to check and verify the Application Binary Interface of libscg

libscg.a

is a highly portable SCSI transport library

dvd+rw-tools-7.1

Introduction to dvd+rw-tools

The dvd+rw-tools package contains several utilities to master the DVD media, both +RW/+R and -R[W]. The principle tool is growisofs which provides a way to both lay down and grow an ISO9660 file system on (as well as to burn an arbitrary pre-mastered image to) all supported DVD media. This is useful for creating a new DVD or adding to an existing image on a partially burned DVD.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

dvd+rw-tools Dependencies

Required

Cdrtools-3.02a09 (runtime)

Installation of dvd+rw-tools

Install dvd+rw-tools by running the following commands:

sed -i '/stat.h/a #include <sys/sysmacros.h>' growisofs.c &&
sed -i '/stdlib/a #include <limits.h>' transport.hxx &&
make all rpl8 btcflash

This package does not come with a test suite.

Now, as the root user:

make prefix=/usr install &&
install -v -m644 -D index.html \
    /usr/share/doc/dvd+rw-tools-7.1/index.html

Command Explanations

sed -i '/stdlib/a #include <limits.h>' ...: This sed includes limits.h, one of the kernel headers. This is needed due to a change in the 2.6.23 kernel headers.

make all rpl8 btcflash: This command uses additional targets so that all the utilities are built.

Contents

Installed Programs: btcflash, dvd+rw-booktype, dvd+rw-format, dvd+rw-mediainfo, dvd-ram-control, growisofs, and rpl8
Installed Libraries: None
Installed Directory: /usr/share/doc/dvd+rw-tools-7.1

Short Descriptions

growisofs

is a combined mkisofs frontend/DVD recording program

libburn-1.5.6

Introduction to libburn

libburn is a library for writing preformatted data onto optical media: CD, DVD and BD (Blu-Ray).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libburn Dependencies

Optional

Doxygen-1.9.7 (to generate HTML documentation)

Installation of libburn

Install libburn by running the following commands:

./configure --prefix=/usr --disable-static &&
make

If you have installed Doxygen and wish to generate the HTML documentation, issue the following command:

doxygen doc/doxygen.conf

This package does not come with a test suite.

Now, as the root user:

make install

If you have built the HTML documentation, install it by running the following commands as the root user:

install -v -dm755 /usr/share/doc/libburn-1.5.6 &&
install -v -m644 doc/html/* /usr/share/doc/libburn-1.5.6

Contents

Installed Program: cdrskin
Installed Library: libburn.so
Installed Directory: /usr/include/libburn

Short Descriptions

cdrskin

burns preformatted data to CD, DVD, and BD via libburn

libburn.so

contains the libburn API functions

libisoburn-1.5.6

Introduction to libisoburn

libisoburn is a frontend for libraries libburn and libisofs which enables creation and expansion of ISO-9660 filesystems on all CD/DVD/BD media supported by libburn. This includes media like DVD+RW, which do not support multi-session management on media level and even plain disk files or block devices.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libisoburn Dependencies

Required

libburn-1.5.6 and libisofs-1.5.6

Optional

Doxygen-1.9.7 (to generate HTML documentation), Tk-8.6.13 (for xorriso-tcltk), and libjte

Installation of libisoburn

Install libisoburn by running the following commands:

./configure --prefix=/usr              \
            --disable-static           \
            --enable-pkg-check-modules &&
make

If you have installed Doxygen and wish to generate the HTML documentation, issue the following command:

doxygen doc/doxygen.conf

This package does not come with a test suite.

Now, as the root user:

make install

If you have built the HTML documentation, install it by running the following commands as the root user:

install -v -dm755 /usr/share/doc/libisoburn-1.5.6 &&
install -v -m644 doc/html/* /usr/share/doc/libisoburn-1.5.6

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-pkg-check-modules: Enable pkg-config check for libburn and libisofs.

Contents

Installed Programs: osirrox, xorrecord, xorriso, xorriso-dd-target, xorrisofs, and xorriso-tcltk
Installed Library: libisoburn.so
Installed Directories: /usr/include/libisoburn and /usr/share/doc/libisoburn-1.5.6

Short Descriptions

osirrox

is a symbolic link to xorriso that copies files from ISO image to a disk filesystem

xorrecord

is a symbolic link to xorriso that provides a cdrecord type user interface

xorriso

is a program to create, load, manipulate, read, and write ISO 9660 filesystem images with Rock Ridge extensions

xorriso-dd-target

is a program to check a USB or memory card device to see whether it is suitable for image copying

xorrisofs

is a symbolic link to xorriso that provides a mkisofs type user interface

xorriso-tcltk

is a frontend that operates xorriso in dialog mode

libisoburn.so

contains the libisoburn API functions

libisofs-1.5.6

Introduction to libisofs

libisofs is a library to create an ISO-9660 filesystem with extensions like RockRidge or Joliet.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

libisofs Dependencies

Optional

Doxygen-1.9.7 (to generate HTML documentation) and libjte

Installation of libisofs

Install libisofs by running the following commands:

./configure --prefix=/usr --disable-static &&
make

If you have installed Doxygen and wish to generate the HTML documentation, issue the following command:

doxygen doc/doxygen.conf

This package does not come with a test suite.

Now, as the root user:

make install

If you have built the HTML documentation, install it by running the following commands as the root user:

install -v -dm755 /usr/share/doc/libisofs-1.5.6 &&
install -v -m644 doc/html/* /usr/share/doc/libisofs-1.5.6

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: None
Installed Library: libisofs.so
Installed Directory: /usr/include/libisofs

Short Descriptions

libisofs.so

contains the libisofs API functions

Part XIV. Printing, Scanning and Typesetting

Chapter 48. Printing

This chapter contains spooling printer management systems and ghostscript applications to render PostScript for display on terminals or paper.

Cups-2.4.6

Introduction to Cups

The Common Unix Printing System (CUPS) is a print spooler and associated utilities. It is based on the "Internet Printing Protocol" and provides printing services to most PostScript and raster printers.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Cups Dependencies

Required

GnuTLS-3.8.1

Recommended
Optional

Avahi-0.8, libpaper-2.1.1, MIT Kerberos V5-1.21.2, PHP-8.2.9, and Python-2.7.18

Required (Postinstall)

cups-filters-1.28.16

Optional (Postinstall)

Gutenprint-5.3.4 and hplip (HP printers)

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/cups

Kernel Configuration

Note

There used to be a conflict between the Cups libusb backend and the usblp kernel driver. This is no longer the case and cups will work with both of these enabled.

If you want to use the kernel usblp driver (for example, if you wish to use escputil from Gutenprint-5.3.4) enable the following options in your kernel configuration and recompile the kernel:

Device Drivers --->
  [*] USB support --->                                             [USB_SUPPORT]
    <*/M> USB Printer support                                      [USB_PRINTER]

If you have a parallel printer, enable the following options in your kernel configuration and recompile the kernel:

Device Drivers --->
  <*/M> Parallel port support --->                                     [PARPORT]
    <*/M> PC-style hardware                                         [PARPORT_PC]
  Character devices --->
    <*/M> Parallel printer support                                     [PRINTER]

Installation of Cups

You will need to add an lp user, as Cups will create some files owned by this user. (The lp user is the default used by Cups, but may be changed to a different user by passing a parameter to the configure script.) Use the following command as the root user:

useradd -c "Print Service User" -d /var/spool/cups -g lp -s /bin/false -u 9 lp

You will also need a dedicated group that will contain users allowed to do Cups administrative tasks. Add the group by running the following command as the root user:

groupadd -g 19 lpadmin

If you want to add a user to the Cups administrative group, run the following command as the root user:

usermod -a -G lpadmin <username>

If you didn't install xdg-utils-1.1.3, use the following sed to change the default browser that will be used to access the Cups web interface:

sed -i 's#@CUPS_HTMLVIEW@#firefox#' desktop/cups.desktop.in

Replace firefox with the web browser of your choice.

Build Cups by running the following commands:

./configure --libdir=/usr/lib            \
            --with-rundir=/run/cups      \
            --with-system-groups=lpadmin \
            --with-docdir=/usr/share/cups/doc-2.4.6 &&
make

To test the results, issue: LC_ALL=C make -k check. An already active graphical session with bus address is necessary to run the tests. Make sure that there is not other instance of Cups running, otherwise at least 4 tests will fail with "address in use".

Now, as the root user:

make install &&
ln -svnf ../cups/doc-2.4.6 /usr/share/doc/cups-2.4.6

Create a basic Cups client configuration file by running the following command as the root user:

echo "ServerName /run/cups/cups.sock" > /etc/cups/client.conf

Note

This package installs icon files into the /usr/share/icons/hicolor hierarchy and you can improve system performance and memory usage by updating /usr/share/icons/hicolor/index.theme. To perform the update you must have GTK+-2.24.33 or GTK+-3.24.38 installed and issue the following command as the root user:

gtk-update-icon-cache -qtf /usr/share/icons/hicolor

Command Explanations

--with-rundir=/run/cups: This switch prevents the package from referring to the deprecated /var/run directory.

--with-system-groups=lpadmin: This switch ensures that only lpadmin will be used as the Cups administrative group.

--disable-libusb: Use this switch if you have installed libusb-1.0.26, but wish to use the kernel usblp driver.

--enable-libpaper: Use this switch if you have installed libpaper and wish to use it with Cups.

Configuring Cups

Config Files

/etc/cups/*

Configuration Information

Normally, printers are set up via a web browser. The Cups server will normally connect via the url http://localhost:631. From there printers, print jobs, and the server configuration can be set up and managed. Remote system administration can also be set up. Configuration can also be done from the command line via the lpadmin, lpoptions, and lpstat commands.

Configuration of Cups is dependent on the type of printer and can be complex. Generally, PostScript printers are easier. For detailed instructions on configuration and use of Cups, see https://www.cups.org/documentation.html.

For non-PostScript printers to print with Cups, you need to install ghostscript-10.01.2 to convert PostScript to raster images and a driver (e.g. from Gutenprint-5.3.4) to convert the resulting raster images to a form that the printer understands. Foomatic drivers use ghostscript-10.01.2 to convert PostScript to a printable form directly, but this is considered suboptimal by Cups developers.

Linux PAM Configuration

If CUPS has been built with Linux PAM support, you need to create a PAM configuration file to get it working correctly with BLFS.

Issue the following command as the root user to create the configuration file for Linux PAM:

cat > /etc/pam.d/cups << "EOF"
# Begin /etc/pam.d/cups

auth    include system-auth
account include system-account
session include system-session

# End /etc/pam.d/cups
EOF

Systemd Unit

To start the cupsd daemon when something tries to access it, enable the previously installed systemd units by running the following command as the root user:

systemctl enable cups

Contents

Installed Programs: cancel, cupsaccept, cups-config, cupsctl, cupsd, cupsdisable, cupsenable, cupsfilter, cupsreject, cupstestppd, ippeveprinter, ippfind, ipptool, lp, lpadmin, lpc, lpinfo, lpmove, lpoptions, lpq, lpr, lprm, lpstat, ppdc, ppdhtml, ppdi, ppdmerge, and ppdpo
Installed Libraries: libcupsimage.so and libcups.so
Installed Directories: /etc/cups, /usr/{include,lib,share}/cups, /usr/share/doc/cups-2.4.6, and /var/{cache,log,run,spool}/cups

Short Descriptions

cancel

cancels existing print jobs from the print queues

cupsaccept

accept jobs sent to a destination

cups-config

is a Cups program configuration utility

cupsctl

updates or queries the cupsd.conf file for a server

cupsd

is the scheduler for the Common Unix Printing System

cupsdisable

stop printers and classes

cupsenable

start printers and classes

cupsfilter

is a front-end to the Cups filter subsystem which allows you to convert a file to a specific format

cupsreject

reject jobs sent to a destination

cupstestppd

tests the conformance of PPD files

ippeveprinter

is an IPP Everywhere printer for CUPS

ippfind

finds Internet Printing Protocol printers

ipptool

sends IPP requests to the specified URI and tests and/or displays the results

lp

submits files for printing or alters a pending job

lpadmin

configures printer and class queues provided by Cups

lpc

provides limited control over printer and class queues provided by Cups

lpinfo

lists the available devices or drivers known to the Cups server

lpmove

moves the specified job to a new destination

lpoptions

displays or sets printer options and defaults

lpq

shows the current print queue status on the named printer

lpr

submits files for printing

lprm

cancels print jobs that have been queued for printing

lpstat

displays status information about the current classes, jobs, and printers

ppdc

compiles PPDC source files into one or more PPD files

ppdhtml

reads a driver information file and produces a HTML summary page that lists all of the drivers in a file and the supported options

ppdi

imports one or more PPD files into a PPD compiler source file

ppdmerge

merges two or more PPD files into a single, multi-language PPD file

ppdpo

extracts UI strings from PPDC source files and updates either a GNU gettext or Mac OS X strings format message catalog source file for translation

libcups.so

contains the Cups API functions

cups-filters-1.28.16

Introduction to CUPS Filters

The CUPS Filters package contains backends, filters and other software that was once part of the core CUPS distribution but is no longer maintained by Apple Inc.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

CUPS Filters Dependencies

Required

Cups-2.4.6, GLib-2.76.4, ghostscript-10.01.2, Little CMS-2.14, Poppler-23.08.0, and Qpdf-11.5.0

Recommended
Optional

Avahi-0.8 (required to build the DNSSD backend of the cups-browsed daemon, which is needed for operating some network printers), OpenLDAP-2.6.6, PHP-8.2.9 (use of this might be broken), Liblouis (Braille), and Liblouisutdml (Braille)

Optional printer drivers (runtime)

Gutenprint-5.3.4 (for supported printers), or other printer drivers, such as hplip

Installation of CUPS Filters

First, fix a security vulnerability that can allow for remote code execution with the 'beh' printer backend:

patch -Np1 -i ../cups-filters-1.28.16-security_fix-1.patch

Install CUPS Filters by running the following commands:

CXXFLAGS="$CXXFLAGS -std=c++17"  \
./configure --prefix=/usr        \
            --sysconfdir=/etc    \
            --localstatedir=/var \
            --without-rcdir      \
            --disable-static     \
            --disable-avahi      \
            --docdir=/usr/share/doc/cups-filters-1.28.16 &&
make

To test the results, issue: make check. DejaVu fonts are needed for the tests.

Now, as the root user:

make install

Install the systemd unit by running the following command as the root user:

install -v -m644 utils/cups-browsed.service /lib/systemd/system/cups-browsed.service

Command Explanations

CXXFLAGS="$CXXFLAGS -std=c++17": This environment variable is necessary to fix a problem introduced by qpdf-11.3.0.

--disable-avahi: This switch is needed if the optional Avahi-0.8 is not installed. Remove it if avahi is installed and you need network printer discovery capabilities.

--without-rcdir: This switch disables installation of the bundled bootscript which is not compatible with BLFS.

--disable-static: This switch prevents installation of static versions of the libraries.

--with-test-font-path=VALUE: If you wish to run the tests, but you do not have the default /usr/share/fonts/dejavu/DejaVuSans.ttf use this switch to specify where DejaVuSans.ttf (or perhaps some other text TTF font - untested) is located.

Configuring CUPS Filters

Systemd Units

To start the cups-browsed daemon at boot, enable the previously installed systemd unit by running the following command as the root user:

systemctl enable cups-browsed

Contents

Installed Programs: cups-browsed, driverless, driverless-fax, and foomatic-rip
Installed Libraries: libcupsfilters.so and libfontembed.so
Installed Directories: /usr/include/{cupsfilters,fontembed}, /usr/lib/cups/{backend,driver,filter}, /usr/share/cups/{braille,charsets}, /usr/share/doc/cups-filters-1.28.16, and /usr/share/ppd/cupsfilters

Short Descriptions

cups-browsed

is a daemon for browsing the Bonjour and CUPS broadcasts of shared, remote CUPS printers

driverless

is a PPD generator utility for driverless printing

driverless-fax

is a wrapper to driverless for FAX type devices

foomatic-rip

is a universal print filter/RIP wrapper which can be used as CUPS filter or stand-alone for spooler-less, direct printing

libcupsfilters.so

contains CUPS Filters API functions

ghostscript-10.01.2

Introduction to Ghostscript

Ghostscript is a versatile processor for PostScript data with the ability to render PostScript to different targets. It is a mandatory part of the cups printing stack.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

If you wish, you can download additional fonts.

Standard Fonts

Other Fonts

Ghostscript Dependencies

Recommended
Optional

Cairo-1.17.6, GTK+-3.24.38, libidn-1.41, libpaper-2.1.1, and a graphical environment

Installation of Ghostscript

Note

The Ghostscript build system is not user-friendly. In order to use system copies of various graphics libraries, you must do it using unconventional methods.

Ghostscript includes (old) copies of several libraries. Some of these seem to have been patched to fix known vulnerabilities, but others of these copies are less-well maintained. To ensure that any future fixes are applied throughout the whole system, it is recommended that you first install the released versions of these libraries and then configure Ghostscript to link to them.

If you have installed the recommended dependencies on your system, remove the copies of freetype, lcms2, libjpeg, libpng, and openjpeg:

rm -rf freetype lcms2mt jpeg libpng openjpeg

Compile Ghostscript:

rm -rf zlib &&

./configure --prefix=/usr           \
            --disable-compile-inits \
            --with-system-libtiff   &&
make

Note

The shared library depends on GTK+-3.24.38. It is only used by external programs like asymptote-2.86, dvisvgm-3.1, and ImageMagick-7.1.1-15.

To compile the shared library libgs.so, run the following additional command as an unprivileged user:

make so

This package does not come with a test suite. A set of example files may be used for testing, but it is only possible after installation of the package.

Now, as the root user:

make install

If you want the shared library too:

make soinstall &&
install -v -m644 base/*.h /usr/include/ghostscript &&
ln -sfvn ghostscript /usr/include/ps

Now make the documentation accessible from a standard place:

mv -v /usr/share/doc/ghostscript/10.01.2 /usr/share/doc/ghostscript-10.01.2  &&
rm -rfv /usr/share/doc/ghostscript &&
cp -r examples/ /usr/share/ghostscript/10.01.2/

If you have downloaded the fonts, unpack them to /usr/share/ghostscript and ensure the ownership of the files are root: root.

tar -xvf ../ghostscript-fonts-std-8.11.tar.gz -C /usr/share/ghostscript --no-same-owner &&
tar -xvf ../gnu-gs-fonts-other-6.0.tar.gz     -C /usr/share/ghostscript --no-same-owner &&
fc-cache -v /usr/share/ghostscript/fonts/

You can now test the rendering of various postscript and pdf files from the /usr/share/ghostscript/10.01.2/examples . To do this, run the following command (in a X Windows display):

gs -q -dBATCH /usr/share/ghostscript/10.01.2/examples/tiger.eps

Command Explanations

rm -rf zlib : zlib was installed as part of LFS.

--disable-compile-inits: This option makes gs and libgs.so slightly smaller.

--with-system-libtiff: Remove this option if you've not installed libtiff-4.5.1.

install -v -m644 base/*.h... : Some packages (ImageMagick is one) need the Ghostscript interface headers in place to link to the shared library. These commands install the headers.

ln -sfvn ghostscript /usr/include/ps: Some packages expect to find the interface headers in an alternate location.

mv -v /usr/share/doc/ghostscript/10.01.2 /usr/share/doc/ghostscript-10.01.2: This moves the documentation where it is expected to be found.

--disable-cups: this option will save a tiny amount of space by not linking gs and libgs.so to the Cups-2.4.6 libraries if you have installed those.

Contents

Installed Programs: dvipdf, eps2eps, gs, gsbj, gsc (from soinstall), gsdj, gsdj500, gslj, gslp, gsnd, gsx (from soinstall), lprsetup.sh, pdf2dsc, pdf2ps, pf2afm, pfbtopfa, pphs, printafm, ps2ascii, ps2epsi, ps2pdf, ps2pdf12, ps2pdf13, ps2pdf14, ps2pdfwr, ps2ps, ps2ps2, and unix-lpr.sh
Installed Library: libgs.so
Installed Directories: /usr/include/ghostscript, /usr/share/ghostscript, and /usr/share/doc/ghostscript-10.01.2

Short Descriptions

gs

is an interpreter for Adobe Systems' PostScript(tm) and Portable Document Format (PDF)

libgs.so

provides Ghostscript functionality to other programs, such as GSView, ImageMagick, and libspectre

Ghostscript provides many different scripts used to convert PostScript, PDF, and other formats. Please refer to the HTML documentation or the man pages for information about the capabilities provided.

Gutenprint-5.3.4

Introduction to Gutenprint

The Gutenprint (formerly Gimp-Print) package contains high quality drivers for many brands and models of printers for use with Cups-2.4.6 and the GIMP-2.0. See a list of supported printers at https://gutenprint.sourceforge.net/p_Supported_Printers.php.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Gutenprint Dependencies

Recommended
Recommended (at runtime)
Optional (to Regenerate Documentation)

ImageMagick-7.1.1-15, texlive-20230313 (or install-tl-unx), Doxygen-1.9.7, and DocBook-utils-0.6.14

Kernel Configuration

If you intend to use escputil with a USB-connected Epson Stylus printer for commands such as --ink-level which need to access the raw device, you must enable the kernel's usblp driver. Enable the following options in your kernel configuration and recompile the kernel:

Device Drivers --->
  [*] USB support --->                                             [USB_SUPPORT]
    <*/M> USB Printer support                                      [USB_PRINTER]

Installation of Gutenprint

Install Gutenprint by running the following commands:

sed -i 's|$(PACKAGE)/doc|doc/$(PACKAGE)-$(VERSION)|' \
       {,doc/,doc/developer/}Makefile.in &&

./configure --prefix=/usr --disable-static &&
make

To test the results, issue: make check. The tests take a very long time and use a lot of disk space. When last tested (version 5.2.15 in June 2019) this needed 75 SBU and 13.5 GB to complete the tests (one test, rastertogutenprint failed because the CUPS ppds are for a previous version. Maybe genppds should be run before the tests). Note that the tests used only one CPU.

Now, as the root user:

make install &&
install -v -m755 -d /usr/share/doc/gutenprint-5.3.4/api/gutenprint{,ui2} &&
install -v -m644    doc/gutenprint/html/* \
                    /usr/share/doc/gutenprint-5.3.4/api/gutenprint &&
install -v -m644    doc/gutenprintui2/html/* \
                    /usr/share/doc/gutenprint-5.3.4/api/gutenprintui2

Command Explanations

sed -i '...' ...Makefile.in: This command is used so that the package documentation is installed in the conventional /usr/share/doc directory structure instead of /usr/share/gutenprint/doc.

--disable-static: This switch prevents installation of static versions of the libraries.

Configuring Gutenprint

Configuration Information

For CUPS to see newly installed print drivers, it has to be restarted (as the root user):

systemctl restart cups

Then point your web browser to http://localhost:631/ to add a new printer to CUPS.

Contents

Installed Programs: cups-calibrate, cups-genppd.5.2, cups-genppdupdate, escputil, and testpattern
Installed Libraries: libgutenprint.so, libgutenprintui2.so and optionally, various CUPS filters and backend drivers under /usr/lib/gutenprint/5.2/modules/
Installed Directories: /usr/{include,lib,share}/gutenprint, /usr/include/gutenprintui2 and /usr/share/doc/gutenprint-5.3.4

Short Descriptions

cups-calibrate

calibrates the color output of printers using the Gutenprint, CUPS or ESP Print Pro drivers

cups-genppd.5.2

generates Gutenprint PPD files for use with CUPS

cups-genppdupdate

regenerates the Gutenprint PPD files in use by CUPS

escputil

is a command line utility to perform various maintenance tasks on Epson Stylus inkjet printers

testpattern

is a test program to learn how to use libgutenprint

Chapter 49. Scanning

This chapter contains scanning applications which allow you to convert printed documents into formatted documents readable by other applications.

SANE-1.0.32

Introduction to SANE

SANE is short for Scanner Access Now Easy. Scanner access, however, is far from easy, since every vendor has their own protocols. The only known protocol that should bring some unity into this chaos is the TWAIN interface, but this is too imprecise to allow a stable scanning framework. Therefore, SANE comes with its own protocol, and the vendor drivers can't be used.

SANE is split into back ends and front ends. The back ends are drivers for the supported scanners and cameras. The front ends are user interfaces to access the backends.

This package is known to build and work properly using an LFS 12.0 platform.

Back Ends Package Information

Additional Downloads (Front Ends)

Note

The upstream location for these files is at https://gitlab.com/sane-project but the file URLs use embedded md5sums. For convenience, the packages have been copied to the location above.

SANE Dependencies

Optional (Back Ends)

Avahi-0.8, Cups-2.4.6, libjpeg-turbo-3.0.0, libtiff-4.5.1, libusb-1.0.26, v4l-utils-1.24.1, Net-SNMP, libieee1284, libgphoto2, and texlive-20230313 (or install-tl-unx)

Optional (Front Ends)

a graphical environment, GTK+-2.24.33, and Gimp-2.10.34

Kernel Configuration, Drivers and Additional Packages

To access your scanner, you will probably need the related kernel drivers and/or additional support packages. A SCSI scanner will need SCSI drivers, a parallel port scanner needs parallel port support (you should use enhanced EPP modes) and perhaps libieee1284, and a USB scanner will need the libusb-1.0.26 package. For HP devices, you may need hplip. Ensure you have the necessary drivers properly configured to access the devices.

Installation of SANE

Installation of SANE Back Ends

The SANE daemon should run with its own group. Create this group by issuing the following commands as the root user:

groupadd -g 70 scanner

Note

configure assumes that the user building SANE-backends is a member of the scanner group for testing the existence of this group. So the user building the package should be added to the scanner group. As the root user:

usermod -G scanner -a username

After adding the scanner group as above, you will need to log out and back in to activate it.

For a USB scanner, if you are linking to libusb-1.0.26, include the configure switch --enable-libusb_1_0. Install SANE-backends by running the following commands:

sg scanner -c "                  \
./configure --prefix=/usr        \
            --sysconfdir=/etc    \
            --localstatedir=/var \
            --with-group=scanner \
            --with-lockdir=/run/lock \
            --docdir=/usr/share/doc/sane-backends-1.0.32" &&
make

To test the results, issue: make check.

Now, as the root user:

make install                                         &&
install -m 644 -v tools/udev/libsane.rules           \
                  /etc/udev/rules.d/65-scanner.rules &&
mkdir -p          /run/lock/sane &&
chgrp -v scanner  /run/lock/sane

With the scanner on, run scanimage -L and the name and location of the device should appear. Of course, you need the device drivers configured, in order to run this test.

Installation of SANE Front Ends

The SANE-frontends package includes the graphical frontends xscanimage and xcam, and a command-line frontend scanadf. You don't need this package if you intend to use one of the more advanced graphical frontends like XSane-0.999. For a list of frontend packages, see http://www.sane-project.org/sane-frontends.html.

To install SANE-frontends, use the following commands:

tar -xf ../sane-frontends-1.0.14.tar.gz &&
cd sane-frontends-1.0.14                &&

sed -i -e "/SANE_CAP_ALWAYS_SETTABLE/d" src/gtkglue.c &&
./configure --prefix=/usr --mandir=/usr/share/man &&
make

This package does not come with a test suite.

Now, as the root user:

make install &&
install -v -m644 doc/sane.png xscanimage-icon-48x48-2.png \
    /usr/share/sane

If GIMP was linked into the build and you wish GIMP to use xscanimage as a scanning plugin, issue the following command as the root user:

ln -v -s ../../../../bin/xscanimage /usr/lib/gimp/2.0/plug-ins

Note

If the plugin xscanimage is disabled in GIMP's menu, in order to enable it, "create" a blank image using the menu or Ctrl-N. After that, it is enabled.

Command Explanations

sg scanner -c "...": runs the command between double quotes with principal group scanner. This may be needed if the user has been newly added to group scanner, and has not logged out and in.

--sysconfdir=/etc: This switch installs the configuration files in /etc/sane.d instead of /usr/etc/sane.d.

--with-group=scanner: This parameter causes the directory created for the locking files to be group owned by the scanner group instead of the default uucp group.

exit: This command is used to exit the shell created by the su command.

Configuring SANE

Config Files

/etc/sane.d/*.conf

Configuration Information

Backend Configuration

The backend configuration files are located in /etc/sane.d. Information for configuring the various backends can be found by using the man(5) page for the desired backend. Run man sane-<backend>, substituting the desired backend.

Add any desired users to the scanner group.

If you want to access a network scanner, include two lines in net.conf, as root user (make sure to replace <server_ip> by the actual value, below):

cat >> /etc/sane.d/net.conf << "EOF"
connect_timeout = 60
<server_ip>
EOF

On the server side, include the client ip in the access list of /etc/sane.d/saned.conf, restart the saned daemon, and make sure the firewall, if any, is open to the client.

Frontend Configuration

If you use a desktop environment like Gnome or KDE you may wish to create a xscanimage.desktop file so that xscanimage appears in the panel's menus. As the root user:

mkdir -pv /usr/share/{applications,pixmaps}               &&

cat > /usr/share/applications/xscanimage.desktop << "EOF" &&
[Desktop Entry]
Encoding=UTF-8
Name=XScanImage - Scanning
Comment=Acquire images from a scanner
Exec=xscanimage
Icon=xscanimage
Terminal=false
Type=Application
Categories=Application;Graphics
EOF

ln -svf ../sane/xscanimage-icon-48x48-2.png /usr/share/pixmaps/xscanimage.png
General Information

For general information about configuring and using SANE, see man sane. For information about USB scanning devices, run man sane-usb. For information about SCSI devices, run man sane-scsi.

Configuration and setup of the 'saned' daemon

The saned daemon is not meant to be used for untrusted clients. You should provide Firewalling protection to ensure only trusted clients access the daemon. Due to the complex security requirements to ensure only trusted clients access the daemon, BLFS does not provide instructions to configure the saned daemon. Some good (but outdated) information for setting up and securing the saned daemon can be found at https://penguin-breeder.org/sane/saned/.

Contents

Back Ends:
Installed Programs: gamma4scanimage, sane-config, saned, sane-find-scanner, and scanimage
Installed Libraries: libsane.so and numerous scanner backend modules
Installed Directories: /etc/sane.d, /usr/{include,lib,share}/sane, and /usr/share/doc/sane-1.0.32
Front Ends:
Installed Programs: scanadf, xcam, and xscanimage
Installed Library: GIMP plugin embedded in xscanimage
Installed Directories: None

Short Descriptions

gamma4scanimage

creates a gamma table in the format expected by scanimage

sane-config

is a tool used to determine the compiler and linker flags that should be used to compile and link SANE

saned

is the SANE daemon that allows remote clients to access image acquisition devices available on the local host

sane-find-scanner

is a command-line tool to find SCSI and USB scanners and determine their device files. Its primary purpose is to make sure that scanners can be detected by SANE backends

scanadf

is a command-line interface to control image acquisition devices which are equipped with an automatic document feeder (ADF)

scanimage

is a command line interface for scanning from image acquisition devices such as flatbed scanners or cameras. It is also used to list the available backend devices

xcam

is a graphical camera front end for SANE

xscanimage

is a graphical user interface for scanning

libsane.so

is the application programming interface that is used to communicate between frontends and backends

libsane-*.so

modules are backend scanning library plugins used to interface with scanning devices. See http://www.sane-project.org/sane-supported-devices.html for a list of supported backends

XSane-0.999

Introduction to XSane

XSane is another front end for SANE-1.0.32. It has additional features to improve the image quality and ease of use compared to xscanimage.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

XSane Dependencies

Required

GTK+-2.24.33 and SANE-1.0.32 (back ends)

Optional

Little CMS-1.19 and Gimp-2.10.34

Installation of XSane

Install XSane by running the following commands:

sed -i -e 's/png_ptr->jmpbuf/png_jmpbuf(png_ptr)/' src/xsane-save.c &&
./configure --prefix=/usr                                           &&
make

This package does not come with a test suite.

Now, as the root user:

make xsanedocdir=/usr/share/doc/xsane-0.999 install &&
ln -v -s ../../doc/xsane-0.999 /usr/share/sane/xsane/doc

A browser of your choice can be used to get inline help, using the following command, as the root user:

ln -v -s <browser> /usr/bin/netscape

Note

Be sure to replace <browser> with the browser of your choice on your system.

Alternatively, if the environment variable BROWSER is set to the browser you want to use, eg, BROWSER="/usr/bin/firefox", the first time you run xsane, it will be recorded in ~/.sane/xsane/xsane.rc. If you wish to change it, edit this file, or remove it, and use the instructions above, so that a new one is created.

If GIMP is installed, issue the following command as the root user:

ln -v -s /usr/bin/xsane /usr/lib/gimp/2.0/plug-ins/

Command Explanations

ln -v -s ../../doc/xsane-0.999 /usr/share/sane/xsane/doc: This symlink is created to ensure that any program that looks for the XSane documentation in the default location will find it, as the documentation is installed in an alternate location specified in the make install command.

ln -v -s /usr/bin/xsane /usr/lib/gimp/2.0/plug-ins/: This creates a link in the system-wide GIMP plug-ins directory so that users can access XSane directly from GIMP. GIMP must be available before building XSane for this to work. Alternatively, create the link in ~/.gimp-2.0/plug-ins/ to provide individual user access. man xsane for additional information.

Contents

Installed Program: xsane
Installed Libraries: None
Installed Directory: /usr/share/doc/xsane-0.999 and /usr/share/sane/xsane

Short Descriptions

xsane

is a graphical user-interface to control an image acquisition device such as a flatbed scanner

Chapter 50. Standard Generalized Markup Language (SGML)

This chapter contains DocBook SGML document type definitions (DTDs), DocBook DSSSL Stylesheets and DocBook tools to validate, transform, format and publish DocBook documents.

sgml-common-0.6.3

Introduction to SGML Common

The SGML Common package contains install-catalog. This is useful for creating and maintaining centralized SGML catalogs.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Installation of SGML Common

Instead of the normal convention of including the autotools files in the package, the maintainers included symlinks to the files in /usr/share/automake. For previous versions of Automake this convention is correct, but recent versions of Automake install the internal files in version specific directories. This causes the configure script to abort. To fix this error, the autotools are regenerated. Since the included Makefile.am file uses a syntax not supported by current versions of Automake, a patch is required to fix the syntax.

patch -Np1 -i ../sgml-common-0.6.3-manpage-1.patch &&
autoreconf -f -i

Install SGML Common by running the following commands:

./configure --prefix=/usr --sysconfdir=/etc &&
make

This package does not come with a test suite.

Now, as the root user:

make docdir=/usr/share/doc install &&

install-catalog --add /etc/sgml/sgml-ent.cat \
    /usr/share/sgml/sgml-iso-entities-8879.1986/catalog &&

install-catalog --add /etc/sgml/sgml-docbook.cat \
    /etc/sgml/sgml-ent.cat

Update Hint

Remove the above catalog items prior to upgrading (as the root user) with:

install-catalog --remove /etc/sgml/sgml-ent.cat \
    /usr/share/sgml/sgml-iso-entities-8879.1986/catalog &&

install-catalog --remove /etc/sgml/sgml-docbook.cat \
    /etc/sgml/sgml-ent.cat

Configuring SGML Common

Config Files

/etc/sgml/sgml.conf

Configuration Information

No change in this file is necessary.

Contents

Installed Programs: install-catalog and sgmlwhich
Installed Libraries: None
Installed Files: SGML and XML DocBook entity files
Installed Directories: /etc/sgml, /usr/share/doc/sgml-common-0.6.3, and /usr/share/sgml

Short Descriptions

install-catalog

creates a centralized catalog that maintains references to catalogs scattered throughout the /usr/share/sgml directory tree

sgmlwhich

prints to standard output the name of the main configuration file

SGML entities files

contains the basic character entities defined with SDATA entries

XML entities files

contains the basic character entities defined by a hexadecimal representation of the Unicode character number

docbook-3.1-dtd

Introduction to DocBook-3.1 SGML DTD

The DocBook SGML DTD package contains document type definitions for verification of SGML data files against the DocBook rule set. These are useful for structuring books and software documentation to a standard allowing you to utilize transformations already written for that standard.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

DocBook-3.1 SGML DTD Dependencies

Required

sgml-common-0.6.3 and UnZip-6.0 (or libarchive-3.7.1)

Installation of DocBook-3.1 SGML DTD

Note

The package source is distributed in zip format and requires unzip (or bsdunzip from libarchive). You should create a directory and change to that directory before unzipping the file to ease the removal of the source files after the package has been installed.

Install DocBook-3.1 SGML DTD by running the following commands:

sed -i -e '/ISO 8879/d' \
       -e 's|DTDDECL "-//OASIS//DTD DocBook V3.1//EN"|SGMLDECL|g' \
       docbook.cat

This package does not come with a test suite.

Now, as the root user:

install -v -d -m755 /usr/share/sgml/docbook/sgml-dtd-3.1 &&
chown -R root:root . &&
install -v docbook.cat /usr/share/sgml/docbook/sgml-dtd-3.1/catalog &&
cp -v -af *.dtd *.mod *.dcl /usr/share/sgml/docbook/sgml-dtd-3.1 &&

install-catalog --add /etc/sgml/sgml-docbook-dtd-3.1.cat \
    /usr/share/sgml/docbook/sgml-dtd-3.1/catalog &&

install-catalog --add /etc/sgml/sgml-docbook-dtd-3.1.cat \
    /etc/sgml/sgml-docbook.cat

Command Explanations

sed -i -e '/ISO 8879/d' docbook.cat: This command removes the ENT definitions from the catalog file.

sed -i -e 's|DTDDECL "-//OASIS//DTD Docbook V3.1//EN"|SGMLDECL|g' docbook.cat: This command replaces the DTDDECL catalog entry, which is not supported by Linux SGML tools, with the SGMLDECL catalog entry.

Configuring DocBook-3.1 SGML DTD

Config Files

/etc/sgml/catalog

Configuration Information

The above installation script updates the catalog.

Using only the most current 3.x version of DocBook SGML DTD requires the following (perform as the root user):

cat >> /usr/share/sgml/docbook/sgml-dtd-3.1/catalog << "EOF"
  -- Begin Single Major Version catalog changes --

PUBLIC "-//Davenport//DTD DocBook V3.0//EN" "docbook.dtd"

  -- End Single Major Version catalog changes --
EOF

Contents

Installed Programs: None
Installed Libraries: None
Installed Files: SGML DTD and MOD files
Installed Directory: /usr/share/sgml/docbook/sgml-dtd-3.1

Short Descriptions

SGML DTD files

contains a document type definition which defines the element types and the attribute lists that can be used in the corresponding SGML files

SGML MOD files

contains components of the document type definition that are sourced into the DTD files

docbook-4.5-dtd

Introduction to DocBook-4.5 SGML DTD

The DocBook-4.5 SGML DTD package contains document type definitions for verification of SGML data files against the DocBook rule set. These are useful for structuring books and software documentation to a standard allowing you to utilize transformations already written for that standard.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

DocBook-4.5 SGML DTD Dependencies

Required

sgml-common-0.6.3 and UnZip-6.0 (or libarchive-3.7.1)

Installation of DocBook-4.5 SGML DTD

Note

The package source is distributed in zip format and requires unzip (or bsdunzip from libarchive). You should create a directory and change to that directory before unzipping the file to ease the removal of the source files after the package has been installed.

Install DocBook-4.5 SGML DTD by running the following commands:

sed -i -e '/ISO 8879/d' \
       -e '/gml/d' docbook.cat

This package does not come with a test suite.

Now, as the root user:

install -v -d /usr/share/sgml/docbook/sgml-dtd-4.5 &&
chown -R root:root . &&

install -v docbook.cat /usr/share/sgml/docbook/sgml-dtd-4.5/catalog &&
cp -v -af *.dtd *.mod *.dcl /usr/share/sgml/docbook/sgml-dtd-4.5 &&

install-catalog --add /etc/sgml/sgml-docbook-dtd-4.5.cat \
    /usr/share/sgml/docbook/sgml-dtd-4.5/catalog &&

install-catalog --add /etc/sgml/sgml-docbook-dtd-4.5.cat \
    /etc/sgml/sgml-docbook.cat

Command Explanations

sed -i -e '/ISO 8879/d' -e '/gml/d' docbook.cat: This command removes the ENT definitions from the catalog file.

Configuring DocBook-4.5 SGML DTD

Config Files

/etc/sgml/catalog

Configuration Information

The above installation script updates the catalog.

Using only the most current 4.x version of DocBook SGML DTD requires the following (perform as the root user):

cat >> /usr/share/sgml/docbook/sgml-dtd-4.5/catalog << "EOF"
  -- Begin Single Major Version catalog changes --

PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "docbook.dtd"
PUBLIC "-//OASIS//DTD DocBook V4.3//EN" "docbook.dtd"
PUBLIC "-//OASIS//DTD DocBook V4.2//EN" "docbook.dtd"
PUBLIC "-//OASIS//DTD DocBook V4.1//EN" "docbook.dtd"
PUBLIC "-//OASIS//DTD DocBook V4.0//EN" "docbook.dtd"

  -- End Single Major Version catalog changes --
EOF

Contents

Installed Programs: None
Installed Libraries: None
Installed Files: SGML DTD and MOD files
Installed Directory: /usr/share/sgml/docbook/sgml-dtd-4.5

Short Descriptions

SGML DTD files

contains a document type definition which defines the element types and the attribute lists that can be used in the corresponding SGML files

SGML MOD files

contains components of the document type definition that are sourced into the DTD files

OpenSP-1.5.2

Introduction to OpenSP

The OpenSP package contains a C++ library for using SGML/XML files. This is useful for validating, parsing and manipulating SGML and XML documents.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

OpenSP Dependencies

Required

sgml-common-0.6.3

Optional

libnsl-2.0.0 and xmlto-0.0.28

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/opensp

Installation of OpenSP

Install OpenSP by running the following commands:

sed -i 's/32,/253,/' lib/Syntax.cxx &&
sed -i 's/LITLEN          240 /LITLEN          8092/' \
    unicode/{gensyntax.pl,unicode.syn} &&

./configure --prefix=/usr                              \
            --disable-static                           \
            --disable-doc-build                        \
            --enable-default-catalog=/etc/sgml/catalog \
            --enable-http                              \
            --enable-default-search-path=/usr/share/sgml &&

make pkgdatadir=/usr/share/sgml/OpenSP-1.5.2

To test the results, issue: make check. As many as nine of the 23 tests may fail. Do not be alarmed.

Now, as the root user:

make pkgdatadir=/usr/share/sgml/OpenSP-1.5.2 \
     docdir=/usr/share/doc/OpenSP-1.5.2      \
     install &&

ln -v -sf onsgmls   /usr/bin/nsgmls   &&
ln -v -sf osgmlnorm /usr/bin/sgmlnorm &&
ln -v -sf ospam     /usr/bin/spam     &&
ln -v -sf ospcat    /usr/bin/spcat    &&
ln -v -sf ospent    /usr/bin/spent    &&
ln -v -sf osx       /usr/bin/sx       &&
ln -v -sf osx       /usr/bin/sgml2xml &&
ln -v -sf libosp.so /usr/lib/libsp.so

Command Explanations

sed -i 's/32,/253,/...unicode.syn}: These seds prevent some annoying messages that may otherwise appear while running openjade.

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-http: This switch adds support for HTTP.

--disable-doc-build: This switch prevents the configure script checking if you have xmlto installed. If you have xmlto, you can remove this option.

--enable-default-catalog=/etc/sgml/catalog: This switch sets the path to the centralized catalog.

--enable-default-search-path: This switch sets the default value of SGML_SEARCH_PATH.

--enable-xml-messages: This switch adds support for XML Formatted Messages.

make pkgdatadir=/usr/share/sgml/OpenSP-1.5.2 : This sets the pkgdatadir variable in the Makefile from /usr/share/OpenSP to /usr/share/sgml/OpenSP-1.5.2.

ln -v -sf ...: These commands create the SP equivalents of OpenSP executables and libraries.

Contents

Installed Programs: onsgmls, osgmlnorm, ospam, ospcat, ospent, osx, and the SP equivalent symlinks: nsgmls, sgml2xml, sgmlnorm, spam, spcat, spent, and sx
Installed Library: libosp.so and the SP equivalent symlink: libsp.so
Installed Directories: /usr/include/OpenSP, /usr/share/doc/OpenSP, and /usr/share/sgml/OpenSP-1.5.2

Short Descriptions

onsgmls

is used to process SGML files

osgmlnorm

prints on the standard output a normalized document instance for the SGML document contained in the concatenation of the entities with system identifiers .nf and .fi

ospam

is a markup stream editor

ospcat

prints effective system identifiers found in the catalogs

ospent

provides access to OpenSP's entity manager

osx

is an SGML normalizer or used to convert SGML files to XML files

nsgmls

is a symlink to onsgmls

sgml2xml

is a symlink to osx

sgmlnorm

is a symlink to osgmlnorm

spam

is a symlink to ospam

spcat

is a symlink to ospcat

spent

is a symlink to ospent

sx

is a symlink to osx

libosp.so

contains functions required by the OpenSP programs to parse, validate and manipulate SGML and XML files

libsp.so

is a symlink to libosp.so

OpenJade-1.3.2

Introduction to OpenJade

The OpenJade package contains a DSSSL engine. This is useful for SGML and XML transformations into RTF, TeX, SGML and XML.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Download

OpenJade Dependencies

Required

OpenSP-1.5.2

Installation of OpenJade

First fix problems when building with newer compilers:

patch -Np1 -i ../openjade-1.3.2-upstream-1.patch

Now fix a compilation problem with perl-5.16 and later:

sed -i -e '/getopts/{N;s#&G#g#;s#do .getopts.pl.;##;}' \
       -e '/use POSIX/ause Getopt::Std;' msggen.pl

Install OpenJade by running the following commands:

export CXXFLAGS="${CXXFLAGS:--O2 -g} -fno-lifetime-dse"            &&
./configure --prefix=/usr                                \
            --mandir=/usr/share/man                      \
            --enable-http                                \
            --disable-static                             \
            --enable-default-catalog=/etc/sgml/catalog   \
            --enable-default-search-path=/usr/share/sgml \
            --datadir=/usr/share/sgml/openjade-1.3.2   &&
make

This package does not come with a test suite.

Now, as the root user:

make install                                                   &&
make install-man                                               &&
ln -v -sf openjade /usr/bin/jade                               &&
ln -v -sf libogrove.so /usr/lib/libgrove.so                    &&
ln -v -sf libospgrove.so /usr/lib/libspgrove.so                &&
ln -v -sf libostyle.so /usr/lib/libstyle.so                    &&

install -v -m644 dsssl/catalog /usr/share/sgml/openjade-1.3.2/ &&

install -v -m644 dsssl/*.{dtd,dsl,sgm}              \
    /usr/share/sgml/openjade-1.3.2                             &&

install-catalog --add /etc/sgml/openjade-1.3.2.cat  \
    /usr/share/sgml/openjade-1.3.2/catalog                     &&

install-catalog --add /etc/sgml/sgml-docbook.cat    \
    /etc/sgml/openjade-1.3.2.cat

Command Explanations

export CXXFLAGS=...: This command prevents segmentation faults when the package is compiled with gcc-6.1.

make install-man: This command installs the openjade man page.

--disable-static: This switch prevents the building of the static library.

--enable-http: This switch adds support for HTTP.

--enable-default-catalog=/etc/sgml/catalog: This switch sets the path to the centralized catalog.

--enable-default-search-path: This switch sets the default value of SGML_SEARCH_PATH.

--datadir=/usr/share/sgml/openjade-1.3.2: This switch puts data files in /usr/share/sgml/openjade-1.3.2 instead of /usr/share.

ln -v -sf ...: These commands create the Jade equivalents of OpenJade executables and libraries.

Configuring OpenJade

Configuration Information

As the root user:

echo "SYSTEM \"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd\" \
    \"/usr/share/xml/docbook/xml-dtd-4.5/docbookx.dtd\"" >> \
    /usr/share/sgml/openjade-1.3.2/catalog

This configuration is only necessary if you intend to use OpenJade to process the BLFS XML files through DSSSL Stylesheets.

Contents

Installed Programs: openjade and the Jade equivalent symlink, jade
Installed Libraries: libogrove.so, libospgrove.so, libostyle.so, and the Jade equivalent symlinks: libgrove.so, libspgrove.so, and libstyle.so
Installed Directory: /usr/share/sgml/openjade-1.3.2

Short Descriptions

openjade

is a DSSSL engine used for transformations

jade

is a symlink to openjade

docbook-dsssl-1.79

Introduction to DocBook DSSSL Stylesheets

The DocBook DSSSL Stylesheets package contains DSSSL stylesheets. These are used by OpenJade or other tools to transform SGML and XML DocBook files.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Documentation and test data

DocBook DSSSL Stylesheets Dependencies

Required

sgml-common-0.6.3

Required (to Test the DocBook SGML Toolchain)

docbook-3.1-dtd, docbook-4.5-dtd, OpenSP-1.5.2, and OpenJade-1.3.2

Installation of DocBook DSSSL Stylesheets

If you downloaded the documentation, run:

tar -xf ../docbook-dsssl-doc-1.79.tar.bz2 --strip-components=1

Install DocBook DSSSL Stylesheets by running the following commands as the root user:

install -v -m755 bin/collateindex.pl /usr/bin                      &&
install -v -m644 bin/collateindex.pl.1 /usr/share/man/man1         &&
install -v -d -m755 /usr/share/sgml/docbook/dsssl-stylesheets-1.79 &&
cp -v -R * /usr/share/sgml/docbook/dsssl-stylesheets-1.79          &&

install-catalog --add /etc/sgml/dsssl-docbook-stylesheets.cat \
    /usr/share/sgml/docbook/dsssl-stylesheets-1.79/catalog         &&

install-catalog --add /etc/sgml/dsssl-docbook-stylesheets.cat \
    /usr/share/sgml/docbook/dsssl-stylesheets-1.79/common/catalog  &&

install-catalog --add /etc/sgml/sgml-docbook.cat              \
    /etc/sgml/dsssl-docbook-stylesheets.cat

Command Explanations

The above commands create an installation script for this package.

Testing the DocBook SGML Toolchain (Optional)

The following commands will perform the necessary tests to confirm that your installed DocBook SGML toolchain will produce desired results. You must have the docbook-3.1-dtd, docbook-4.5-dtd, OpenSP-1.5.2, and OpenJade-1.3.2 packages installed, and perform the tests as the root user.

All tests will be performed from the /usr/share/sgml/docbook/dsssl-stylesheets-1.79/doc/testdata directory as the root user:

cd /usr/share/sgml/docbook/dsssl-stylesheets-1.79/doc/testdata

The first test should produce no output to stdout (your screen) and create a file named jtest.rtf in the current directory:

openjade -t rtf -d jtest.dsl jtest.sgm

The next test should return only the following line to stdout: onsgmls:I: "OpenSP" version "1.5.2"

onsgmls -sv test.sgm

The next test should produce no output to stdout and create a file named test.rtf in the current directory:

openjade -t rtf \
    -d /usr/share/sgml/docbook/dsssl-stylesheets-1.79/print/docbook.dsl \
    test.sgm

The last test should produce no output to stdout and create a file named c1.htm in the current directory:

openjade -t sgml \
    -d /usr/share/sgml/docbook/dsssl-stylesheets-1.79/html/docbook.dsl \
    test.sgm

Finally, clean up:

rm jtest.rtf test.rtf c1.htm

Contents

Installed Program: collateindex.pl
Installed Libraries: None
Installed Files: DSSSL stylesheets
Installed Directory: /usr/share/sgml/docbook/dsssl-stylesheets-1.79

Short Descriptions

collateindex.pl

is a Perl script that creates a DocBook index from raw index data

DocBook-utils-0.6.14

Introduction to DocBook-utils

The DocBook-utils package is a collection of utility scripts used to convert and analyze SGML documents in general, and DocBook files in particular. The scripts are used to convert from DocBook or other SGML formats into classical file formats like HTML, man, info, RTF and many more. There's also a utility to compare two SGML files and only display the differences in markup. This is useful for comparing documents prepared for different languages.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

DocBook-utils Dependencies

Required

OpenJade-1.3.2, docbook-dsssl-1.79, and docbook-3.1-dtd

Optional (Runtime Dependencies Only)

SGMLSpm-1.1 (for conversion to man and texinfo), and Lynx-2.8.9rel.1 or Links-2.29 or W3m (for conversion to ASCII text)

Installation of DocBook-utils

Install DocBook-utils by running the following commands:

patch -Np1 -i ../docbook-utils-0.6.14-grep_fix-1.patch &&
sed -i 's:/html::' doc/HTML/Makefile.in                &&

./configure --prefix=/usr --mandir=/usr/share/man      &&
make

This package does not come with a test suite.

Now, as the root user:

make docdir=/usr/share/doc install

Many packages use an alternate name for the DocBook-utils scripts. If you wish to create these alternate names, use the following command as the root user:

for doctype in html ps dvi man pdf rtf tex texi txt
do
    ln -svf docbook2$doctype /usr/bin/db2$doctype
done

Note

The jw script uses the which command to locate required utilities. You must install Which-2.21 before attempting to use any of the DocBook-utils programs.

Command Explanations

patch -Np1 -i ../docbook-utils-0.6.14-grep_fix-1.patch: This patch corrects the syntax in the jw (Jade Wrapper) script which is at the heart of much db2* processing, so that the current version of grep will not reject it.

sed -i 's:/html::' doc/HTML/Makefile.in: This command changes the installation directory of the HTML documents.

docdir=/usr/share/doc: This option is placed on the make install line because is not recognized by configure.

Contents

Installed Programs: docbook2dvi, docbook2html, docbook2man, docbook2pdf, docbook2ps, docbook2rtf, docbook2tex, docbook2texi, docbook2txt, jw, and sgmldiff
Installed Libraries: None
Installed Directories: /usr/share/doc/docbook-utils-0.6.14 and /usr/share/sgml/docbook/utils-0.6.14
Installed Symlinks: db2dvi, db2html, db2man, db2pdf, db2ps, db2rtf, db2tex, db2texi, and db2txt

Short Descriptions

docbook2*

are simple one-line wrapper scripts to jw. They are provided as easy-to-remember names used to convert DocBook or other SGML files to the respective format

db2*

are symlinks pointing at the respectively named docbook2* commands, created to satisfy some program's use of these names

jw

is a script used to convert DocBook or other SGML files to various output formats. It hides most of OpenJade's complexity and adds comfortable features

sgmldiff

is used to compare two SGML files and only return the differences in the markup. This is especially useful to compare files that should be identical except for language differences in the content

Chapter 51. Extensible Markup Language (XML)

This chapter contains the DocBook XML document type definition (DTD) and DocBook Stylesheets which are used to validate, transform, format and publish DocBook documents.

docbook-xml-4.5

Introduction to DocBook-4.5 XML DTD

The DocBook-4.5 XML DTD-4.5 package contains document type definitions for verification of XML data files against the DocBook rule set. These are useful for structuring books and software documentation to a standard allowing you to utilize transformations already written for that standard.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

DocBook-4.5 XML DTD Dependencies

Required

libxml2-2.10.4, sgml-common-0.6.3, and UnZip-6.0 (or libarchive-3.7.1)

Installation of DocBook-4.5 XML DTD

Note

The package source is distributed in zip format and requires unzip (or bsdunzip from libarchive). You should create a directory and change to that directory before unzipping the file to ease the removal of the source files after the package has been installed.

Install DocBook XML DTD by running the following commands as the root user:

install -v -d -m755 /usr/share/xml/docbook/xml-dtd-4.5 &&
install -v -d -m755 /etc/xml &&
cp -v -af --no-preserve=ownership docbook.cat *.dtd ent/ *.mod \
    /usr/share/xml/docbook/xml-dtd-4.5

Create (or update) and populate the /etc/xml/docbook catalog file by running the following commands as the root user:

if [ ! -e /etc/xml/docbook ]; then
    xmlcatalog --noout --create /etc/xml/docbook
fi &&
xmlcatalog --noout --add "public" \
    "-//OASIS//DTD DocBook XML V4.5//EN" \
    "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" \
    /etc/xml/docbook &&
xmlcatalog --noout --add "public" \
    "-//OASIS//DTD DocBook XML CALS Table Model V4.5//EN" \
    "file:///usr/share/xml/docbook/xml-dtd-4.5/calstblx.dtd" \
    /etc/xml/docbook &&
xmlcatalog --noout --add "public" \
    "-//OASIS//DTD XML Exchange Table Model 19990315//EN" \
    "file:///usr/share/xml/docbook/xml-dtd-4.5/soextblx.dtd" \
    /etc/xml/docbook &&
xmlcatalog --noout --add "public" \
    "-//OASIS//ELEMENTS DocBook XML Information Pool V4.5//EN" \
    "file:///usr/share/xml/docbook/xml-dtd-4.5/dbpoolx.mod" \
    /etc/xml/docbook &&
xmlcatalog --noout --add "public" \
    "-//OASIS//ELEMENTS DocBook XML Document Hierarchy V4.5//EN" \
    "file:///usr/share/xml/docbook/xml-dtd-4.5/dbhierx.mod" \
    /etc/xml/docbook &&
xmlcatalog --noout --add "public" \
    "-//OASIS//ELEMENTS DocBook XML HTML Tables V4.5//EN" \
    "file:///usr/share/xml/docbook/xml-dtd-4.5/htmltblx.mod" \
    /etc/xml/docbook &&
xmlcatalog --noout --add "public" \
    "-//OASIS//ENTITIES DocBook XML Notations V4.5//EN" \
    "file:///usr/share/xml/docbook/xml-dtd-4.5/dbnotnx.mod" \
    /etc/xml/docbook &&
xmlcatalog --noout --add "public" \
    "-//OASIS//ENTITIES DocBook XML Character Entities V4.5//EN" \
    "file:///usr/share/xml/docbook/xml-dtd-4.5/dbcentx.mod" \
    /etc/xml/docbook &&
xmlcatalog --noout --add "public" \
    "-//OASIS//ENTITIES DocBook XML Additional General Entities V4.5//EN" \
    "file:///usr/share/xml/docbook/xml-dtd-4.5/dbgenent.mod" \
    /etc/xml/docbook &&
xmlcatalog --noout --add "rewriteSystem" \
    "http://www.oasis-open.org/docbook/xml/4.5" \
    "file:///usr/share/xml/docbook/xml-dtd-4.5" \
    /etc/xml/docbook &&
xmlcatalog --noout --add "rewriteURI" \
    "http://www.oasis-open.org/docbook/xml/4.5" \
    "file:///usr/share/xml/docbook/xml-dtd-4.5" \
    /etc/xml/docbook

Create (or update) and populate the /etc/xml/catalog catalog file by running the following commands as the root user:

if [ ! -e /etc/xml/catalog ]; then
    xmlcatalog --noout --create /etc/xml/catalog
fi &&
xmlcatalog --noout --add "delegatePublic" \
    "-//OASIS//ENTITIES DocBook XML" \
    "file:///etc/xml/docbook" \
    /etc/xml/catalog &&
xmlcatalog --noout --add "delegatePublic" \
    "-//OASIS//DTD DocBook XML" \
    "file:///etc/xml/docbook" \
    /etc/xml/catalog &&
xmlcatalog --noout --add "delegateSystem" \
    "http://www.oasis-open.org/docbook/" \
    "file:///etc/xml/docbook" \
    /etc/xml/catalog &&
xmlcatalog --noout --add "delegateURI" \
    "http://www.oasis-open.org/docbook/" \
    "file:///etc/xml/docbook" \
    /etc/xml/catalog

Configuring DocBook-4.5 XML DTD

Config Files

/etc/xml/catalog and /etc/xml/docbook

Configuration Information

Caution

Various BLFS packages request DocBook XML DTD version 4.x before V4.5, so the following step must be done for those packages to be built successfully.

The above installation creates the files and updates the catalogs. In order to utilize DocBook XML DTD V4.5 when any version 4.x is requested in the System Identifier, you need to add additional statements to the catalog files. If you have any of the DocBook XML DTD's referenced below already installed on your system, remove those entries from the for command below (issue the commands as the root user):

for DTDVERSION in 4.1.2 4.2 4.3 4.4
do
  xmlcatalog --noout --add "public" \
    "-//OASIS//DTD DocBook XML V$DTDVERSION//EN" \
    "http://www.oasis-open.org/docbook/xml/$DTDVERSION/docbookx.dtd" \
    /etc/xml/docbook
  xmlcatalog --noout --add "rewriteSystem" \
    "http://www.oasis-open.org/docbook/xml/$DTDVERSION" \
    "file:///usr/share/xml/docbook/xml-dtd-4.5" \
    /etc/xml/docbook
  xmlcatalog --noout --add "rewriteURI" \
    "http://www.oasis-open.org/docbook/xml/$DTDVERSION" \
    "file:///usr/share/xml/docbook/xml-dtd-4.5" \
    /etc/xml/docbook
  xmlcatalog --noout --add "delegateSystem" \
    "http://www.oasis-open.org/docbook/xml/$DTDVERSION/" \
    "file:///etc/xml/docbook" \
    /etc/xml/catalog
  xmlcatalog --noout --add "delegateURI" \
    "http://www.oasis-open.org/docbook/xml/$DTDVERSION/" \
    "file:///etc/xml/docbook" \
    /etc/xml/catalog
done

Contents

Installed Programs: None
Installed Libraries: None
Installed Files: DTD, MOD and ENT files
Installed Directories: /etc/xml and /usr/share/xml/docbook/xml-dtd-4.5

Short Descriptions

DTD files

contain a document type definition which defines the element types and the attribute lists that can be used in the corresponding XML files

MOD files

contain components of the document type definition that are sourced into the DTD files

ENT files

contain lists of named character entities allowed in HTML

docbook-xml-5.0

Introduction to DocBook XML DTD and Schemas 5.0

The DocBook XML DTD and Schemas-5.0 package contains document type definitions and schemas for verification of XML data files against the DocBook rule set. These are useful for structuring books and software documentation to a standard allowing you to utilize transformations already written for that standard. In addition to providing a DTD, version 5 introduced the RelaxNG schema and Schematron rules, and is incompatible with previous versions of DocBook XML.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

DocBook XML DTD and Schemas 5.0 Dependencies

Required

libxml2-2.10.4, sgml-common-0.6.3, and UnZip-6.0

Installation of DocBook XML DTD and Schemas 5.0

Install DocBook XML DTD and Schemas by running the following commands as the root user:

install -vdm755 /usr/share/xml/docbook/schema/{dtd,rng,sch,xsd}/5.0 &&
install -vm644  dtd/* /usr/share/xml/docbook/schema/dtd/5.0         &&
install -vm644  rng/* /usr/share/xml/docbook/schema/rng/5.0         &&
install -vm644  sch/* /usr/share/xml/docbook/schema/sch/5.0         &&
install -vm644  xsd/* /usr/share/xml/docbook/schema/xsd/5.0

Create (or update) and populate the /etc/xml/docbook-5.0 catalog file by running the following commands as the root user:

if [ ! -e /etc/xml/docbook-5.0 ]; then
    xmlcatalog --noout --create /etc/xml/docbook-5.0
fi &&

xmlcatalog --noout --add "public" \
  "-//OASIS//DTD DocBook XML 5.0//EN" \
  "file:///usr/share/xml/docbook/schema/dtd/5.0/docbook.dtd" \
  /etc/xml/docbook-5.0 &&
xmlcatalog --noout --add "system" \
  "http://www.oasis-open.org/docbook/xml/5.0/dtd/docbook.dtd" \
  "file:///usr/share/xml/docbook/schema/dtd/5.0/docbook.dtd" \
  /etc/xml/docbook-5.0 &&
xmlcatalog --noout --add "system" \
  "http://docbook.org/xml/5.0/dtd/docbook.dtd" \
  "file:///usr/share/xml/docbook/schema/dtd/5.0/docbook.dtd" \
  /etc/xml/docbook-5.0 &&

xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.0/rng/docbook.rng" \
  "file:///usr/share/xml/docbook/schema/rng/5.0/docbook.rng" \
  /etc/xml/docbook-5.0 &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.0/rng/docbook.rng" \
  "file:///usr/share/xml/docbook/schema/rng/5.0/docbook.rng" \
  /etc/xml/docbook-5.0 &&
xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.0/rng/docbookxi.rng" \
  "file:///usr/share/xml/docbook/schema/rng/5.0/docbookxi.rng" \
  /etc/xml/docbook-5.0 &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.0/rng/docbookxi.rng" \
  "file:///usr/share/xml/docbook/schema/rng/5.0/docbookxi.rng" \
  /etc/xml/docbook-5.0 &&
xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.0/rnc/docbook.rnc" \
  "file:///usr/share/xml/docbook/schema/rng/5.0/docbook.rnc" \
  /etc/xml/docbook-5.0 &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.0/rng/docbook.rnc" \
  "file:///usr/share/xml/docbook/schema/rng/5.0/docbook.rnc" \
  /etc/xml/docbook-5.0 &&
xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.0/rnc/docbookxi.rnc" \
  "file:///usr/share/xml/docbook/schema/rng/5.0/docbookxi.rnc" \
  /etc/xml/docbook-5.0 &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.0/rng/docbookxi.rnc" \
  "file:///usr/share/xml/docbook/schema/rng/5.0/docbookxi.rnc" \
  /etc/xml/docbook-5.0 &&

xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.0/xsd/docbook.xsd" \
  "file:///usr/share/xml/docbook/schema/xsd/5.0/docbook.xsd" \
  /etc/xml/docbook-5.0 &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.0/xsd/docbook.xsd" \
  "file:///usr/share/xml/docbook/schema/xsd/5.0/docbook.xsd" \
  /etc/xml/docbook-5.0 &&
xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.0/xsd/docbookxi.xsd" \
  "file:///usr/share/xml/docbook/schema/xsd/5.0/docbookxi.xsd" \
  /etc/xml/docbook-5.0 &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.0/xsd/docbookxi.xsd" \
  "file:///usr/share/xml/docbook/schema/xsd/5.0/docbookxi.xsd" \
  /etc/xml/docbook-5.0 &&
xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.0/xsd/xi.xsd" \
  "file:///usr/share/xml/docbook/schema/xsd/5.0/xi.xsd" \
  /etc/xml/docbook-5.0 &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.0/xsd/xi.xsd" \
  "file:///usr/share/xml/docbook/schema/xsd/5.0/xi.xsd" \
  /etc/xml/docbook-5.0 &&
xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.0/xsd/xlink.xsd" \
  "file:///usr/share/xml/docbook/schema/xsd/5.0/xlink.xsd" \
  /etc/xml/docbook-5.0 &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.0/xsd/xlink.xsd" \
  "file:///usr/share/xml/docbook/schema/xsd/5.0/xlink.xsd" \
  /etc/xml/docbook-5.0 &&
xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.0/xsd/xml.xsd" \
  "file:///usr/share/xml/docbook/schema/xsd/5.0/xml.xsd" \
  /etc/xml/docbook-5.0 &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.0/xsd/xml.xsd" \
  "file:///usr/share/xml/docbook/schema/xsd/5.0/xml.xsd" \
  /etc/xml/docbook-5.0 &&

xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.0/sch/docbook.sch" \
  "file:///usr/share/xml/docbook/schema/sch/5.0/docbook.sch" \
  /etc/xml/docbook-5.0 &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.0/sch/docbook.sch" \
  "file:///usr/share/xml/docbook/schema/sch/5.0/docbook.sch" \
  /etc/xml/docbook-5.0

While again as the root user, create the individual catalogs:

xmlcatalog --noout --create /usr/share/xml/docbook/schema/dtd/5.0/catalog.xml &&

xmlcatalog --noout --add "public" \
  "-//OASIS//DTD DocBook XML 5.0//EN" \
  "docbook.dtd" /usr/share/xml/docbook/schema/dtd/5.0/catalog.xml &&
xmlcatalog --noout --add "system" \
  "http://www.oasis-open.org/docbook/xml/5.0/dtd/docbook.dtd" \
  "docbook.dtd" /usr/share/xml/docbook/schema/dtd/5.0/catalog.xml &&

xmlcatalog --noout --create /usr/share/xml/docbook/schema/rng/5.0/catalog.xml &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.0/rng/docbook.rng" \
  "docbook.rng" /usr/share/xml/docbook/schema/rng/5.0/catalog.xml &&
xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.0/rng/docbook.rng" \
  "docbook.rng" /usr/share/xml/docbook/schema/rng/5.0/catalog.xml &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.0/rng/docbookxi.rng" \
  "docbookxi.rng" /usr/share/xml/docbook/schema/rng/5.0/catalog.xml &&
xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.0/rng/docbookxi.rng" \
  "docbookxi.rng" /usr/share/xml/docbook/schema/rng/5.0/catalog.xml &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.0/rng/docbook.rnc" \
  "docbook.rnc" /usr/share/xml/docbook/schema/rng/5.0/catalog.xml &&
xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.0/rng/docbook.rnc" \
  "docbook.rnc" /usr/share/xml/docbook/schema/rng/5.0/catalog.xml &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.0/rng/docbookxi.rnc" \
  "docbookxi.rnc" /usr/share/xml/docbook/schema/rng/5.0/catalog.xml &&
xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.0/rng/docbookxi.rnc" \
  "docbookxi.rnc" /usr/share/xml/docbook/schema/rng/5.0/catalog.xml &&

xmlcatalog --noout --create /usr/share/xml/docbook/schema/sch/5.0/catalog.xml &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.0/sch/docbook.sch" \
  "docbook.sch" /usr/share/xml/docbook/schema/sch/5.0/catalog.xml &&
xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.0/sch/docbook.sch" \
  "docbook.sch" /usr/share/xml/docbook/schema/sch/5.0/catalog.xml &&

xmlcatalog --noout --create /usr/share/xml/docbook/schema/xsd/5.0/catalog.xml &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.0/xsd/docbook.xsd" \
  "docbook.xsd" /usr/share/xml/docbook/schema/xsd/5.0/catalog.xml &&
xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.0/xsd/docbook.xsd" \
  "docbook.xsd" /usr/share/xml/docbook/schema/xsd/5.0/catalog.xml &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.0/xsd/docbookxi.xsd" \
  "docbookxi.xsd" /usr/share/xml/docbook/schema/xsd/5.0/catalog.xml &&
xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.0/xsd/docbookxi.xsd" \
  "docbookxi.xsd" /usr/share/xml/docbook/schema/xsd/5.0/catalog.xml &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.0/xsd/xlink.xsd" \
  "xlink.xsd" /usr/share/xml/docbook/schema/xsd/5.0/catalog.xml &&
xmlcatalog --noout --add "uri" \
   "http://www.oasis-open.org/docbook/xml/5.0/xsd/xlink.xsd" \
   "xlink.xsd" /usr/share/xml/docbook/schema/xsd/5.0/catalog.xml &&
xmlcatalog --noout --add "uri" \
   "http://docbook.org/xml/5.0/xsd/xml.xsd" \
   "xml.xsd" /usr/share/xml/docbook/schema/xsd/5.0/catalog.xml &&
xmlcatalog --noout --add "uri" \
   "http://www.oasis-open.org/docbook/xml/5.0/xsd/xml.xsd" \
   "xml.xsd" /usr/share/xml/docbook/schema/xsd/5.0/catalog.xml

Create (or update) and populate the system XML catalog (/etc/xml/catalog) by running the following commands as the root user:

if [ ! -e /etc/xml/catalog ]; then
    xmlcatalog --noout --create /etc/xml/catalog
fi &&
xmlcatalog --noout --add "delegatePublic" \
  "-//OASIS//DTD DocBook XML 5.0//EN" \
  "file:///usr/share/xml/docbook/schema/dtd/5.0/catalog.xml" \
  /etc/xml/catalog &&
xmlcatalog --noout --add "delegateSystem" \
  "http://docbook.org/xml/5.0/dtd/" \
  "file:///usr/share/xml/docbook/schema/dtd/5.0/catalog.xml" \
  /etc/xml/catalog &&
xmlcatalog --noout --add "delegateURI" \
  "http://docbook.org/xml/5.0/dtd/" \
  "file:///usr/share/xml/docbook/schema/dtd/5.0/catalog.xml" \
  /etc/xml/catalog &&
xmlcatalog --noout --add "delegateURI" \
  "http://docbook.org/xml/5.0/rng/"  \
  "file:///usr/share/xml/docbook/schema/rng/5.0/catalog.xml" \
  /etc/xml/catalog &&
xmlcatalog --noout --add "delegateURI" \
  "http://docbook.org/xml/5.0/sch/"  \
  "file:///usr/share/xml/docbook/schema/sch/5.0/catalog.xml" \
  /etc/xml/catalog &&
xmlcatalog --noout --add "delegateURI" \
  "http://docbook.org/xml/5.0/xsd/"  \
  "file:///usr/share/xml/docbook/schema/xsd/5.0/catalog.xml" \
  /etc/xml/catalog

Configuring DocBook XML DTD and Schemas 5.0

Config Files

/etc/xml/catalog and /etc/xml/docbook-5.0

Contents

Installed Files: DTD, RNC, RNG, SCH and XSD files
Installed Directories: /etc/xml and /usr/share/xml/docbook/schema/{dtd,rng,sch,xsd}/5.0

Short Descriptions

DTD files

contain the DocBook 5.0 document type definitions which define the element types and the attribute lists that can be used in the corresponding XML files

RNC, RNG, and SCH files

contain the Docbook 5.0 RelaxNG, RelaxNG Compact, and Schematron schema definitions

XSD files

files contain DocBook-5.0 Schematron rules

docbook-xml-5.1

Introduction to DocBook XML Schemas 5.1

The DocBook XML Schemas-5.1 package contains schema files and Schematron rules for verification of XML data files against the DocBook rule set. These are useful for structuring books and software documentation to a standard allowing you to utilize transformations already written for that standard.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

DocBook XML Schemas 5.1 Dependencies

Required

libxml2-2.10.4, sgml-common-0.6.3, and UnZip-6.0 (or libarchive-3.7.1)

Installation of DocBook XML Schemas 5.1

Note

The package source is distributed in zip format and requires unzip (or bsdunzip from libarchive). You should create a directory and change to that directory before unzipping the file to ease the removal of the source files after the package has been installed.

Install DocBook XML Schemas by running the following commands as the root user:

install -vdm755 /usr/share/xml/docbook/schema/{rng,sch}/5.1         &&
install -m644   schemas/rng/* /usr/share/xml/docbook/schema/rng/5.1 &&
install -m644   schemas/sch/* /usr/share/xml/docbook/schema/sch/5.1 &&
install -m755   tools/db4-entities.pl /usr/bin                      &&
install -vdm755 /usr/share/xml/docbook/stylesheet/docbook5          &&
install -m644   tools/db4-upgrade.xsl \
                /usr/share/xml/docbook/stylesheet/docbook5

Create (or update) and populate the /etc/xml/docbook-5.1 catalog file by running the following commands as the root user:

if [ ! -e /etc/xml/docbook-5.1 ]; then
  xmlcatalog --noout --create /etc/xml/docbook-5.1
fi &&

xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.1/rng/docbook.rng" \
  "file:///usr/share/xml/docbook/schema/rng/5.1/docbook.rng" \
  /etc/xml/docbook-5.1 &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.1/rng/docbook.rng" \
  "file:///usr/share/xml/docbook/schema/rng/5.1/docbook.rng" \
  /etc/xml/docbook-5.1 &&
xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.1/rng/docbookxi.rng" \
  "file:///usr/share/xml/docbook/schema/rng/5.1/docbookxi.rng" \
  /etc/xml/docbook-5.1 &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.1/rng/docbookxi.rng" \
  "file:///usr/share/xml/docbook/schema/rng/5.1/docbookxi.rng" \
  /etc/xml/docbook-5.1 &&
xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.1/rnc/docbook.rnc" \
  "file:///usr/share/xml/docbook/schema/rng/5.1/docbook.rnc" \
  /etc/xml/docbook-5.1 &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.1/rng/docbook.rnc" \
  "file:///usr/share/xml/docbook/schema/rng/5.1/docbook.rnc" \
  /etc/xml/docbook-5.1 &&
xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.1/rnc/docbookxi.rnc" \
  "file:///usr/share/xml/docbook/schema/rng/5.1/docbookxi.rnc" \
  /etc/xml/docbook-5.1 &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.1/rng/docbookxi.rnc" \
  "file:///usr/share/xml/docbook/schema/rng/5.1/docbookxi.rnc" \
  /etc/xml/docbook-5.1 &&

xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.1/sch/docbook.sch" \
  "file:///usr/share/xml/docbook/schema/sch/5.1/docbook.sch" \
  /etc/xml/docbook-5.1 &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.1/sch/docbook.sch" \
  "file:///usr/share/xml/docbook/schema/sch/5.1/docbook.sch" \
  /etc/xml/docbook-5.1

While again as the root user, create the individual catalogs:

xmlcatalog --noout --create /usr/share/xml/docbook/schema/rng/5.1/catalog.xml &&

xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.1/schemas/rng/docbook.schemas/rng" \
  "docbook.schemas/rng" /usr/share/xml/docbook/schema/rng/5.1/catalog.xml &&
xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.1/schemas/rng/docbook.schemas/rng" \
  "docbook.schemas/rng" /usr/share/xml/docbook/schema/rng/5.1/catalog.xml &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.1/schemas/rng/docbookxi.schemas/rng" \
  "docbookxi.schemas/rng" /usr/share/xml/docbook/schema/rng/5.1/catalog.xml &&
xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.1/schemas/rng/docbookxi.schemas/rng" \
  "docbookxi.schemas/rng" /usr/share/xml/docbook/schema/rng/5.1/catalog.xml &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.1/schemas/rng/docbook.rnc" \
  "docbook.rnc" /usr/share/xml/docbook/schema/rng/5.1/catalog.xml &&
xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.1/schemas/rng/docbook.rnc" \
  "docbook.rnc" /usr/share/xml/docbook/schema/rng/5.1/catalog.xml &&
xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.1/schemas/rng/docbookxi.rnc" \
  "docbookxi.rnc" /usr/share/xml/docbook/schema/rng/5.1/catalog.xml &&
xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.1/schemas/rng/docbookxi.rnc" \
  "docbookxi.rnc" /usr/share/xml/docbook/schema/rng/5.1/catalog.xml
xmlcatalog --noout --create /usr/share/xml/docbook/schema/sch/5.1/catalog.xml &&

xmlcatalog --noout --add "uri" \
  "http://docbook.org/xml/5.1/schemas/sch/docbook.schemas/sch" \
  "docbook.schemas/sch" /usr/share/xml/docbook/schema/sch/5.1/catalog.xml &&
xmlcatalog --noout --add "uri" \
  "http://www.oasis-open.org/docbook/xml/5.1/schemas/sch/docbook.schemas/sch" \
  "docbook.schemas/sch" /usr/share/xml/docbook/schema/sch/5.1/catalog.xml

Create (or update) and populate the system XML catalog (/etc/xml/catalog) by running the following commands as the root user:

if [ ! -e /etc/xml/catalog ]; then
  xmlcatalog --noout --create /etc/xml/catalog
fi &&
xmlcatalog --noout --add "delegatePublic" \
  "-//OASIS//DTD DocBook XML 5.1//EN" \
  "file:///usr/share/xml/docbook/schema/dtd/5.1/catalog.xml" \
  /etc/xml/catalog &&
xmlcatalog --noout --add "delegateSystem" \
  "http://docbook.org/xml/5.1/dtd/" \
  "file:///usr/share/xml/docbook/schema/dtd/5.1/catalog.xml" \
  /etc/xml/catalog &&
xmlcatalog --noout --add "delegateURI" \
  "http://docbook.org/xml/5.1/dtd/" \
  "file:///usr/share/xml/docbook/schema/dtd/5.1/catalog.xml" \
  /etc/xml/catalog &&
xmlcatalog --noout --add "delegateURI" \
  "http://docbook.org/xml/5.1/rng/"  \
  "file:///usr/share/xml/docbook/schema/rng/5.1/catalog.xml" \
  /etc/xml/catalog &&
xmlcatalog --noout --add "delegateURI" \
  "http://docbook.org/xml/5.1/sch/"  \
  "file:///usr/share/xml/docbook/schema/sch/5.1/catalog.xml" \
  /etc/xml/catalog &&
xmlcatalog --noout --add "delegateURI" \
  "http://docbook.org/xml/5.1/xsd/"  \
  "file:///usr/share/xml/docbook/schema/xsd/5.1/catalog.xml" \
  /etc/xml/catalog

Configuring DocBook XML Schemas 5.1

Config Files

/etc/xml/catalog and /etc/xml/docbook-5.1

Contents

Installed Programs: db4-entities.pl
Installed Files: RNC, RNG, SCH, and XSL files
Installed Directories: /etc/xml, /usr/share/xml/docbook/stylesheets, and /usr/share/xml/docbook/schema/{rng,sch}/5.1

Short Descriptions

db4-entities.pl

is a script to convert DocBook 4.x filed to DocBook 5.1

RNC, RNG, and SCH files

contain the Docbook 5.1 RelaxNG, RelaxNG Compact, and Schematron schema definitions

db4-upgrade.xsl

is an XSL stylesheet to assist in conversion from DocBook 4.x files to DocBook 5.1

docbook-xsl-nons-1.79.2

Introduction to DocBook XSL Stylesheets

The DocBook XSL Stylesheets package contains XSL stylesheets. These are useful for performing transformations on XML DocBook files.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Optional documentation

DocBook XSL Stylesheets Dependencies

Recommended (at runtime)
Optional (all used at runtime)

apache-ant-1.10.14 (to produce webhelp documents), libxslt-1.1.38 (or any other XSLT processor), to process Docbook documents - the Python2 modules libxml2 and libxslt can be used, Python-2.7.18 (at runtime), Ruby-3.2.2 (to utilize the epub stylesheets), Zip-3.0 (to produce epub3 documents), and Saxon6 and Xerces2 Java (used with apache-ant-1.10.14 to produce webhelp documents)

Installation of DocBook XSL Stylesheets

First, fix a problem that causes stack overflows when doing recursion:

patch -Np1 -i ../docbook-xsl-nons-1.79.2-stack_fix-1.patch

If you downloaded the optional documentation tarball, unpack it with the following command:

tar -xf ../docbook-xsl-doc-1.79.2.tar.bz2 --strip-components=1

BLFS does not install the required packages to run the test suite and provide meaningful results.

Install DocBook XSL Stylesheets by running the following commands as the root user:

install -v -m755 -d /usr/share/xml/docbook/xsl-stylesheets-nons-1.79.2 &&

cp -v -R VERSION assembly common eclipse epub epub3 extensions fo        \
         highlighting html htmlhelp images javahelp lib manpages params  \
         profiling roundtrip slides template tests tools webhelp website \
         xhtml xhtml-1_1 xhtml5                                          \
    /usr/share/xml/docbook/xsl-stylesheets-nons-1.79.2 &&

ln -s VERSION /usr/share/xml/docbook/xsl-stylesheets-nons-1.79.2/VERSION.xsl &&

install -v -m644 -D README \
                    /usr/share/doc/docbook-xsl-nons-1.79.2/README.txt &&
install -v -m644    RELEASE-NOTES* NEWS* \
                    /usr/share/doc/docbook-xsl-nons-1.79.2

If you downloaded the optional documentation tarball, install the documentation by issuing the following command as the root user:

cp -v -R doc/* /usr/share/doc/docbook-xsl-nons-1.79.2

Configuring DocBook XSL Stylesheets

Config Files

/etc/xml/catalog

Configuration Information

Note

If you are installing the current version of docbook-xsl-nons over a previous version of docbook-xsl, then remove the old rewrite entries in the catalog as the root user:

sed -i '/rewrite/d' /etc/xml/catalog

Create (or append) and populate the XML catalog file using the following commands as the root user:

if [ ! -d /etc/xml ]; then install -v -m755 -d /etc/xml; fi &&
if [ ! -f /etc/xml/catalog ]; then
    xmlcatalog --noout --create /etc/xml/catalog
fi &&

xmlcatalog --noout --add "rewriteSystem" \
           "https://cdn.docbook.org/release/xsl-nons/1.79.2" \
           "/usr/share/xml/docbook/xsl-stylesheets-nons-1.79.2" \
    /etc/xml/catalog &&

xmlcatalog --noout --add "rewriteURI" \
           "https://cdn.docbook.org/release/xsl-nons/1.79.2" \
           "/usr/share/xml/docbook/xsl-stylesheets-nons-1.79.2" \
    /etc/xml/catalog &&

xmlcatalog --noout --add "rewriteSystem" \
           "https://cdn.docbook.org/release/xsl-nons/current" \
           "/usr/share/xml/docbook/xsl-stylesheets-nons-1.79.2" \
    /etc/xml/catalog &&

xmlcatalog --noout --add "rewriteURI" \
           "https://cdn.docbook.org/release/xsl-nons/current" \
           "/usr/share/xml/docbook/xsl-stylesheets-nons-1.79.2" \
    /etc/xml/catalog &&

xmlcatalog --noout --add "rewriteSystem" \
           "http://docbook.sourceforge.net/release/xsl/current" \
           "/usr/share/xml/docbook/xsl-stylesheets-nons-1.79.2" \
    /etc/xml/catalog &&

xmlcatalog --noout --add "rewriteURI" \
           "http://docbook.sourceforge.net/release/xsl/current" \
           "/usr/share/xml/docbook/xsl-stylesheets-nons-1.79.2" \
    /etc/xml/catalog

Occasionally, you may find the need to install other versions of the XSL stylesheets as some projects reference a specific version. One example is BLFS-6.0, which required the 1.67.2 version. In these instances you should install any other required version in its own versioned directory and create catalog entries as follows (substitute the desired version number for <version>):

xmlcatalog --noout --add "rewriteSystem" \
           "http://docbook.sourceforge.net/release/xsl/<version>" \
           "/usr/share/xml/docbook/xsl-stylesheets-<version>" \
    /etc/xml/catalog &&

xmlcatalog --noout --add "rewriteURI" \
           "http://docbook.sourceforge.net/release/xsl/<version>" \
           "/usr/share/xml/docbook/xsl-stylesheets-<version>" \
    /etc/xml/catalog

Contents

Installed Files: /usr/share/xml/docbook/xsl-stylesheets-nons-1.79.2/*/*.xsl
Installed Directories: /usr/share/xml/docbook/xsl-stylesheets-nons-1.79.2 and /usr/share/doc/docbook-xsl-nons-1.79.2

Short Descriptions

XSL Stylesheets

are used for performing transformations on XML files

itstool-2.0.7

Introduction to itstool

Itstool extracts messages from XML files and outputs PO template files, then merges translations from MO files to create translated XML files. It determines what to translate and how to chunk it into messages using the W3C Internationalization Tag Set (ITS).

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Itstool Dependencies

Required

docbook-xml-4.5

Installation of itstool

Install itstool by running the following commands:

PYTHON=/usr/bin/python3 ./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: itstool
Installed Libraries: None
Installed Directory: /usr/share/itstool

Short Descriptions

itstool

is used to create translated XML files

xmlto-0.0.28

Introduction to xmlto

The xmlto package is a front-end to a XSL toolchain. It chooses an appropriate stylesheet for the conversion you want and applies it using an external XSLT processor. It also performs any necessary post-processing.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

xmlto Dependencies

Required

docbook-xml-4.5, docbook-xsl-nons-1.79.2, and libxslt-1.1.38

Optional (for DVI, PDF, and postscript backend post-processing)

fop-2.9, dblatex, and PassiveTeX

Optional (for text backend post-processing)

One of Links-2.29, Lynx-2.8.9rel.1, W3m, or ELinks

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/xmlto

Installation of xmlto

Install xmlto by running the following commands:

LINKS="/usr/bin/links" \
./configure --prefix=/usr &&

make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

LINKS="/usr/bin/links": This environment variable fixes a bug causing xmlto to think that links command is the same as elinks. Setting this variable does not cause problems if links is not installed, unless you have ELinks installed, and wish to use it for text backend post-processing, in which case, remove it.

Contents

Installed Programs: xmlif and xmlto
Installed Libraries: None
Installed Directory: /usr/share/xmlto

Short Descriptions

xmlif

is a conditional processing instructions for XML

xmlto

applies an XSL stylesheet to an XML document

Chapter 52. PostScript

This chapter includes applications that create, manipulate or view PostScript files and create or view Portable Document Format PDF files.

Enscript-1.6.6

Introduction to Enscript

Enscript converts ASCII text files to PostScript, HTML, RTF, ANSI and overstrikes.

This package is known to build and work properly using an LFS 12.0 platform.

Caution

Enscript cannot convert UTF-8 encoded text to PostScript. The issue is discussed in detail in the Needed Encoding Not a Valid Option section of the Locale Related Issues page. The solution is to use paps-0.7.1, instead of Enscript, for converting UTF-8 encoded text to PostScript.

Package Information

Enscript Dependencies

Optional

texlive-20230313 (or install-tl-unx)

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/Enscript

Installation of Enscript

Install Enscript by running the following commands:

./configure --prefix=/usr              \
            --sysconfdir=/etc/enscript \
            --localstatedir=/var       \
            --with-media=Letter &&
make &&

pushd docs &&
  makeinfo --plaintext -o enscript.txt enscript.texi &&
popd

If you have texlive-20230313 installed, you can create Postscript and PDF documentation by issuing (does not support parallel make):

make -j1 -C docs ps pdf

To test the results, issue: make check.

Now, as the root user:

make install &&

install -v -m755 -d /usr/share/doc/enscript-1.6.6 &&
install -v -m644    README* *.txt docs/*.txt \
                    /usr/share/doc/enscript-1.6.6

If you built Postscript and PDF documentation, install it using the following command as the root user:

install -v -m644 docs/*.{dvi,pdf,ps} \
                 /usr/share/doc/enscript-1.6.6

Command Explanations

--sysconfdir=/etc/enscript: This switch puts configuration data in /etc/enscript instead of /usr/etc.

--localstatedir=/var: This switch sets the directory for runtime data to /var instead of /usr/var.

--with-media=Letter: This switch sets the medium format to letter size instead of the A4 default.

Contents

Installed Programs: diffpp, enscript, mkafmmap, over, sliceprint, and states
Installed Libraries: None
Installed Directories: /etc/enscript, /usr/share/doc/enscript-1.6.6, and /usr/share/enscript

Short Descriptions

diffpp

converts diff output files to a format suitable to be printed with enscript

enscript

is a filter, used primarily by printing scripts, that converts ASCII text files to PostScript, HTML, RTF, ANSI and overstrikes

mkafmmap

creates a font map from a given file

over

is a script which calls enscript and passes the correct parameters to create overstriked fonts

sliceprint

slices documents with long lines

states

is an awk-like text processing tool with some state machine extensions. It is designed for program source code highlighting and for similar tasks where state information helps input processing

ePDFView-0.1.8

Introduction to ePDFView

ePDFView is a free standalone lightweight PDF document viewer using Poppler and GTK+ libraries. It is a good replacement for Evince as it does not rely upon GNOME libraries.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

ePDFView Dependencies

Required

GTK+-2.24.33 and Poppler-23.08.0

Recommended (mainly for Desktop Environments)
Optional

Cups-2.4.6

Installation of ePDFView

Install ePDFView by running the following commands:

patch -Np1 -i ../epdfview-0.1.8-fixes-2.patch &&
./configure --prefix=/usr &&
make

This package does not come with a test suite.

Now, as the root user:

make install

For Desktop Environment users, further (optional) instructions are necessary for properly displaying epdfview.desktop in the menu. As root user:

for size in 24 32 48; do
  ln -svf ../../../../epdfview/pixmaps/icon_epdfview-$size.png \
          /usr/share/icons/hicolor/${size}x${size}/apps
done &&
unset size &&

update-desktop-database &&
gtk-update-icon-cache -t -f --include-image-data /usr/share/icons/hicolor

Command Explanations

patch -Np1 -i ../epdfview-0.1.8-fixes-2.patch The patch does four things: fixes compiling with glib-2.32 or greater, corrects red appearing as blue with recent versions of poppler, allows the application to compile when Cups-2.4.6 has been installed, and fixes the display of embedded png images.

Contents

Installed Program: epdfview
Installed Libraries: None
Installed Directory: /usr/share/epdfview

Short Descriptions

epdfview

is a Gtk+-2 program for viewing PDF documents

fop-2.9

Introduction to fop

The FOP (Formatting Objects Processor) package contains a print formatter driven by XSL formatting objects (XSL-FO). It is a Java application that reads a formatting object tree and renders the resulting pages to a specified output. Output formats currently supported include PDF, PCL, PostScript, SVG, XML (area tree representation), print, AWT, MIF and ASCII text. The primary output target is PDF.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

Required Additional Downloads:

Recommended packages

fop Dependencies

Required

apache-ant-1.10.14

Optional

a graphical environment (to run tests), JAI Image I/O Tools, and JEuclid

Installation of fop

Ensure $JAVA_HOME is set correctly before beginning the build. To build the JIMI SDK and/or XMLUnit extension classes, ensure the corresponding .jar files can be found via the CLASSPATH environment variable.

Installing OFFO Hyphenation Patterns

Copy the XML hyphenation patterns into the fop source tree by running the following commands:

unzip ../offo-hyphenation.zip &&
cp offo-hyphenation/hyph/* fop/hyph &&
rm -rf offo-hyphenation

Installing a temporary Maven binary

Starting with fop-2.5, the Maven build system is required. We use the binary provided by apache, that we install in a temporary location:

tar -xf ../apache-maven-3.9.4-bin.tar.gz -C /tmp

Installing fop Components

The javadoc command that ships with OpenJDK 10 and later has become much stricter than previous versions regarding conformance of the Javadoc comments in source code to HTML. The FOP documentation does not meet those standards, so the conformance checks have to be disabled. This can be done with the following command:

sed -i '\@</javad@i\
<arg value="-Xdoclint:none"/>\
<arg value="--allow-script-in-comments"/>\
<arg value="--ignore-source-errors"/>' \
    fop/build.xml

Compile fop by running the following commands:

cd fop &&

LC_ALL=en_US.UTF-8                     \
PATH=$PATH:/tmp/apache-maven-3.9.4/bin \
ant all javadocs &&

mv build/javadocs .

This package comes with a test suite, but the java infrastructure installed in this book does not allow running it.

Now, install Fop as the root user:

install -v -d -m755 -o root -g root          /opt/fop-2.9 &&
cp -vR build conf examples fop* javadocs lib /opt/fop-2.9 &&
chmod a+x /opt/fop-2.9/fop                                &&
ln -v -sfn fop-2.9 /opt/fop

The last thing to do is to clean what we have done:

rm -rf /tmp/apache-maven-3.9.4

Command Explanations

sed -i ... build.xml: This adds three switches to the javadoc command, preventing some errors from occurring when building the documentation.

export LC_ALL=en_US.UTF-8: the compiler fails if using an ASCII locale.

ant target: This reads the file build.xml and builds the target: compile compiles the java sources, jar-main generates jar archives, jar-hyphenation generates the hyphenation patterns for FOP, junit runs the junit tests, and javadocs builds the documentation. The all target runs all of the above.

ln -v -sf fop-2.9 /opt/fop: This is optional and creates a convenience symlink so that $FOP_HOME doesn't have to be changed each time there's a package version change.

Configuring fop

Config Files

~/.foprc

Configuration Information

Using fop to process some large FO's (including the FO derived from the BLFS XML sources), can lead to memory errors. Unless you add a parameter to the java command used in the fop script you may receive messages similar to the one shown below:

Exception in thread "main" java.lang.OutOfMemoryError: Java heap space

To avoid errors like this, you need to pass an extra parameter to the java command used in the fop script. This can be accomplished by creating a ~/.foprc (which is sourced by the fop script) and adding the parameter to the FOP_OPTS environment variable.

The fop script looks for a FOP_HOME environment variable to locate the fop class libraries. You can create this variable using the ~/.foprc file as well. Create a ~/.foprc file using the following commands:

cat > ~/.foprc << "EOF"
FOP_OPTS="-Xmx<RAM_Installed>m"
FOP_HOME="/opt/fop"
EOF

Replace <RAM_Installed> with a number representing the amount of RAM installed in your computer (in megabytes). An example would be FOP_OPTS="-Xmx768m".

To include the fop script in your path, update the system-wide profile with the following command as the root user:

cat > /etc/profile.d/fop.sh << "EOF"
# Begin /etc/profile.d/fop.sh

pathappend /opt/fop

# End /etc/profile.d/fop.sh
EOF

Note

Running fop can be somewhat verbose. The default logging level can be changed from INFO to any of FINEST, FINER, FINE, CONFIG, INFO, WARNING, SEVERE, ALL, or OFF. To do this, edit $JAVA_HOME/jre/lib/logging.properties and change the entries for .level and java.util.logging.ConsoleHandler.level to the desired value.

Contents

Installed Programs: fop
Installed Libraries: fop.jar and numerous support library classes located in /opt/fop/{build,lib}; JAI components include libmlib_jai.so, jai_codec.jar, jai_core.jar, and mlibwrapper_jai.jar
Installed Directory: /opt/fop-2.9

Short Descriptions

fop

is a wrapper script to the java command which sets up the fop environment and passes the required parameters

fop.jar

contains all the fop Java classes

MuPDF-1.22.2

Introduction to MuPDF

MuPDF is a lightweight PDF and XPS viewer.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

MuPDF Dependencies

Required

GLU-9.0.3 and Xorg Libraries

Recommended
Optional

xdg-utils-1.1.3 (runtime), jbig2dec, and MuJS

Required (runtime)

a graphical environment

Installation of MuPDF

First, fix the Makefile to link properly with the shared library:

sed -i '/MU.*_EXE. :/{
        s/\(.(MUPDF_LIB)\)\(.*\)$/\2 | \1/
        N
        s/$/ -lmupdf -L$(OUT)/
        }' Makefile

Install MuPDF by running the following commands:

cat > user.make << EOF &&
USE_SYSTEM_FREETYPE := yes
USE_SYSTEM_HARFBUZZ := yes
USE_SYSTEM_JBIG2DEC := no
USE_SYSTEM_JPEGXR := no # not used without HAVE_JPEGXR
USE_SYSTEM_LCMS2 := no # need lcms2-art fork
USE_SYSTEM_LIBJPEG := yes
USE_SYSTEM_MUJS := no # build needs source anyway
USE_SYSTEM_OPENJPEG := yes
USE_SYSTEM_ZLIB := yes
USE_SYSTEM_GLUT := no # need freeglut2-art fork
USE_SYSTEM_CURL := yes
USE_SYSTEM_GUMBO := no
EOF

export XCFLAGS=-fPIC                               &&
make build=release shared=yes                      &&
unset XCFLAGS

This package does not come with a test suite.

Now, as the root user:

make prefix=/usr                        \
     shared=yes                         \
     docdir=/usr/share/doc/mupdf-1.22.2 \
     install                            &&

chmod 755 /usr/lib/libmupdf.so          &&
ln -sfv mupdf-x11 /usr/bin/mupdf

Command Explanations

ln -sfv mupdf-x11 /usr/bin/mupdf : This symbolic link chooses between mupdf-gl and mupdf-x11 when running mupdf.

Contents

Installed Program: mupdf (symlink), mupdf-gl, mupdf-x11, mupdf-x11-curl, muraster, and mutool
Installed Libraries: libmupdf.so
Installed Directories: /usr/include/mupdf, /usr/share/doc/mupdf-1.22.2

Short Descriptions

mupdf

is a program for viewing PDF, XPS, EPUB, and CBZ documents, and various image formats such as PNG, JPEG, GIFF, and TIFF

mupdf-gl

same as mupdf, using an opengl renderer

mupdf-x11

same as mupdf, using an X Window renderer

muraster

is a program used to perform rasterization tasks with PDF documents

mutool

is a program to perform various operations on PDF files, such as merging and cleaning PDF documents

libmupdf.so

contains the mupdf API functions

paps-0.7.1

Introduction to paps

paps is a text to PostScript converter that works through Pango. Its input is a UTF-8 encoded text file and it outputs vectorized PostScript. It may be used for printing any complex script supported by Pango.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

paps Dependencies

Required

Pango-1.50.14

Optional

Doxygen-1.9.7

Installation of paps

Install paps by running the following commands:

./configure --prefix=/usr --mandir=/usr/share/man &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Contents

Installed Program: paps
Installed Library: None
Installed Directory: None

Short Descriptions

paps

is a text to PostScript converter that supports UTF-8 character encoding

Chapter 53. Typesetting

This chapter includes texlive applications that create output equivalent to typesetting.

There are two alternative routes through this chapter:

Some people may wish to use the binary installer, either because of the complexity of installing all of texlive from source, or because they only want a part of the package, or perhaps because they wish to get updates as soon as those are available (the source is only updated annually, but the binaries and associated tex and sty files are updated for approximately 10 months). These people should begin at Setting the PATH for TeX Live and then follow the install-tl-unx instructions. After installing, they can run tlmgr to update their system.

Most people reading BLFS will wish to build from source. BLFS used to start by installing install-tl-unx and then use that to bootstrap the build. Nowadays, we build almost the whole of texlive without a binary install, by adding the separately-packaged texmf files into this build. For this, begin at Setting the PATH for TeX Live then go to texlive-20230313 which will install most of texlive, together with all of the supporting files. This almost-complete install can then be used to build the remaining parts of texlive: asymptote-2.86, biber-2.19 and xindy-2.5.1.

Because the texmf files (including documentation, fonts, scripts and supporting files) are all in one tarball, it is not practical to limit what gets extracted in a sensible way (you could exclude one or other of the typesetting engines, not its many supporting files) when building from source in this manner.

In either case, BLFS installs into /opt/texlive/2023.

Also, please note that texlive is released annually, and updating from the previous year to the current year is no longer supported. If for some reason you wish to keep versions for multiple years, for most things you can mount the old or new system at /opt/texlive and fix up your PATH as necessary. However doing that will not preserve any changes in texmf-local and if you build from source and try to run a newer version of biber with an older version of biblatex it is unlikely to work.

Setting the PATH for TeX Live

Before starting to build TeX Live, set up your PATH so that the system can properly find the files. If you set up your login scripts as recommended in The Bash Shell Startup Files, update the needed paths by creating the texlive.sh script. The programs are always installed in an <ARCH>-linux subdirectory and on 32-bit x86 this is always i386-linux. For x86_64 and i?86 we can generate this as $TEXARCH:

Note

If upgrading from a previous year's version, you should manually edit texlive.sh to ensure that the version for the year you wish to use is the only TeX present (some people need to keep multiple years available to ensure there are no regressions in their documents).

Now, create the texlive.sh script as the root user:

TEXARCH=$(uname -m | sed -e 's/i.86/i386/' -e 's/$/-linux/')

cat > /etc/profile.d/texlive.sh << EOF
# Begin texlive setup
TEXLIVE_PREFIX=/opt/texlive/2023
export TEXLIVE_PREFIX

pathappend \$TEXLIVE_PREFIX/texmf-dist/doc/man  MANPATH
pathappend \$TEXLIVE_PREFIX/texmf-dist/doc/info INFOPATH
pathappend \$TEXLIVE_PREFIX/bin/$TEXARCH

# End texlive setup
EOF

unset TEXARCH

Note

The standard MANPATH and INFOPATH path are specified above to ensure they are included. If they are already set in the boot script procedure, the pathappend function will ensure duplicates are removed, so including them here will do no harm.

Note

The backslashes before the dollar signs in the script above are to facilitate a copy/paste operation. The backslashes should not appear in the actual script.

The new paths can be immediately activated by running:

source /etc/profile

The shared libraries will be installed into a texlive directory. As the root user, add it to your /etc/ld.so.conf:

cat >> /etc/ld.so.conf << EOF
# Begin texlive addition

$TEXLIVE_PREFIX/lib

# End texlive addition
EOF

You should now proceed either to install-tl-unx for a binary installation of texlive, or to texlive-20230313 to begin installing from source.

install-tl-unx

Introduction to TeX Live and its installer

The TeX Live package is a comprehensive TeX document production system. It includes TeX, LaTeX2e, ConTeXt, Metafont, MetaPost, BibTeX and many other programs; an extensive collection of macros, fonts and documentation; and support for typesetting in many different scripts from around the world.

This page is for people who wish to use the binary installer to provide the programs, the scripts, and a lot of supporting files and documentation. The installer is updated frequently, so any published md5sum will soon be out of date. Newer versions of the installer are expected to work with these instructions, for so long as they install to a 2023/ directory.

There are two reasons why you may wish to install the binaries in BLFS: either you need a smaller install (e.g. at a minimum plain TeX without LaTeX2e, ConTeXt, etc), or you wish to use tlmgr to get updates whilst this version is supported (typically, until April of the year after it was released). For the latter, you might prefer to install in your /home directory as an unprivileged user, and to then make corresponding changes to the PATH in your ~/.bashrc or equivalent.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Recommended
Recommended (at runtime)

The binary version of asy is linked to libGLX.so.0 from libglvnd, but installing that will break future updates of BLFS packages such as Mesa-23.1.6. Work around that by creating a symlink as the root user:

ln -sv libGL.so.1 /usr/lib/libGLX.so.0

Note

As always with contributed binary software, it is possible that the required dependencies may change when the installer is updated. In particular, these dependencies have only been checked on x86_64.

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/tl-installer

Binary Installation of TeX Live

The TeX Live set of programs with its supporting documents, fonts, and utilities is very large. The upstream maintainers recommend placing all files in a single directory structure. BLFS recommends /opt/texlive.

As with any other package, unpack the installer and change into its directory, install-tl-<CCYYMMDD>. This directory name changes when the installer is updated, so replace <CCYYMMDD> by the correct directory name.

Warning

If you have installed any of the luatex programs (luatex, luahbtex, luajitex, luajithbtex) or ConTeXt with the luametatex backend there was a security issue fixed by the introduction of luatex v1.17.0. You should check the version with 'luatex --version' and if it is less than 1.17.0 you can use tlmgr to update.

Note

The distribution binaries installed below may use static linking for general linux system libraries. Additional libraries or interpreters as specified in the dependencies section do not need to be present during the install, but the programs that need them will not run until their specific dependencies have been installed.

With all contributed binary software, there may be a mismatch between the builder's toolchain and your hardware. In most of TeX this will probably not matter, but in uncommon corner cases you might hit problems. For example, if your x86_64 processor does not support 3dnowext or 3dnow, the 2014-06-28 binary failed in conTeXt when running LuaTeX, although lualatex worked, as did the i686 binaries on the same machine. In such cases, the easiest solution is to install texlive from source. Similarly, the x86_64 binary version of asy runs very slowly when creating 3-D diagrams.

Now, as the root user:

TEXLIVE_INSTALL_PREFIX=/opt/texlive ./install-tl

This command is interactive and allows selection or modification of platform, packages, directories, and other options. The full installation scheme will require about 4.9 gigabytes of disk space. The time to complete the download will depend on your internet connection speed and the number of packages selected.

It has been established by Debian that the python scripts in latex-make will work with python3, so update them to invoke that by running the following command as the root user:

for F in /opt/texlive/2023/texmf-dist/scripts/latex-make/*.py ; do
  test -f $F && sed -i 's%/usr/bin/env python%/usr/bin/python3%' $F || true
done

Command Explanations

test -f $F && sed ...: in a small install these files might not be present, so test if they exist and if not return 'true' to avoid any error if this command has been copied into one of your own install scripts.

./install-tl --location http://mirror.aut.ac.nz/CTAN/systems/texlive/tlnet/: use a variation of this if you wish to use a different mirror, for example, because you are in New Zealand but the installer chooses to use an Australian mirror. The list of mirrors is at https://ctan.org/mirrors/.

Contents

Installed Programs: Over 300 binaries and symlinks to scripts
Installed Libraries: None
Installed Directories: /opt/texlive

Short Descriptions

TeX programs

The programs included in TeX are too numerous to individually list. Please refer to the individual program HTML and PDF pages in the various html, man, or pdf files within the subdirectories of 2023/texmf-dist/. Using texdoc pdflatex ( replace pdflatex with the command name ) may also be useful

texlive-20230313-source

Introduction to TeX Live from source

Note

According to https://www.tug.org/historic/ the master site in France only supports ftp and rsync. Now that ftp is generally deprecated, that page has links to mirrors, some of which support https, e.g. in Utah and Chemnitz as well as in China. If you prefer to use a different mirror from the example links here, you will need to navigate to systems/historic/texlive/2023 or systems/texlive/2023 as the case may be.

Most of TeX Live can be built from source without a pre-existing installation, but xindy (for indexing) needs working versions of latex and pdflatex when configure is run, and the test suite and install for asy (for vector graphics) will fail if TeX has not already been installed. Additionally, biber is not provided within the texlive source and the version of dvisvgm in the texlive tree cannot be built if shared system libraries are used.

All of those packages are dealt with on their own pages and can be built after installing this package. If you have not already done so, you should start at Setting the PATH for TeX Live so that the final commands to initialize the new installation will be found.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Required Additional Downloads

Much of the texlive environment (including scripts, documentation, fonts, and various other files) is not part of the source tarball. You must download it separately. This will give you all of the additional files which are provided by a full install of the binary version, there is no realistic way to restrict which parts get installed.

Because of the size of this package, it is unlikely to be mirrored by BLFS mirrors. In case of difficulty, go to http://www.ctan.org/mirrors/ to find a more-accessible mirror.

From the 2019 year, the tlpdb database of the packages within texlive is no-longer installed with the source. But texdoc needs a cache file derived from this (and will create the cache on its first run).

TeX Live from source Dependencies

Recommended
Optional

The source ships with its own versions of several libraries which are either not under active development, or only used for limited functionality. If you install these, as with some other optional dependencies in this book you will need to tell configure to use the system versions. GD, t1lib, ZZIPlib, TECkit

Runtime dependencies

Installation of TeX Live

Install TeX Live by running the following commands:

Caution

If you wish to upgrade to current texlive on an older system where extra packages (asymptote, biber, dvisvgm, or xindy) have been installed, you will need to reinstall those as well as fixing up your PATH for $TEXLIVE_PREFIX.

Note

A successful install requires some texlive commands to be run as the root user, so we will export the TEXARCH variable to let root use it.

Now, as a normal user:

export TEXARCH=$(uname -m | sed -e 's/i.86/i386/' -e 's/$/-linux/') &&

patch -Np1 -i ../texlive-20230313-source-security_fix-1.patch &&

mkdir texlive-build &&
cd    texlive-build &&

../configure -C                                   \
    --prefix=$TEXLIVE_PREFIX                      \
    --bindir=$TEXLIVE_PREFIX/bin/$TEXARCH         \
    --datarootdir=$TEXLIVE_PREFIX                 \
    --includedir=$TEXLIVE_PREFIX/include          \
    --infodir=$TEXLIVE_PREFIX/texmf-dist/doc/info \
    --libdir=$TEXLIVE_PREFIX/lib                  \
    --mandir=$TEXLIVE_PREFIX/texmf-dist/doc/man   \
    --disable-native-texlive-build                \
    --disable-static --enable-shared              \
    --disable-dvisvgm                             \
    --with-system-cairo                           \
    --with-system-fontconfig                      \
    --with-system-freetype2                       \
    --with-system-gmp                             \
    --with-system-graphite2                       \
    --with-system-harfbuzz                        \
    --with-system-icu                             \
    --with-system-libgs                           \
    --with-system-libpaper                        \
    --with-system-libpng                          \
    --with-system-mpfr                            \
    --with-system-pixman                          \
    --with-system-zlib                            \
    --with-banner-add=" - BLFS" &&

make

To test the results, issue: make -k check. Two tests, psutils.test and eptexdir/wcfname are known to fail.

Now, as the root user:

make install-strip &&
/sbin/ldconfig     &&
make texlinks      &&
mkdir -pv                                $TEXLIVE_PREFIX/tlpkg/TeXLive/ &&
install -v -m644 ../texk/tests/TeXLive/* $TEXLIVE_PREFIX/tlpkg/TeXLive/ &&
tar -xf ../../texlive-20230311-tlpdb-full.tar.gz -C $TEXLIVE_PREFIX/tlpkg

Note

Only run make texlinks once. If it is rerun, it can change all the program symlinks so that they point to themselves and are useless.

Now install the additional files as the root user:

tar -xf ../../texlive-20230313-texmf.tar.xz -C $TEXLIVE_PREFIX --strip-components=1

It has been established by Debian that the python scripts in l\atex-make will work with python3, so update them to invoke that by running the following command as the root user:

for F in $TEXLIVE_PREFIX/texmf-dist/scripts/latex-make/*.py ; do
  sed -i 's%/usr/bin/env python%/usr/bin/python3%' $F
done

Still as the root user, initialize the new system (the command fmtutil-sys --all will produce a lot of output):

mktexlsr &&
fmtutil-sys --all

To allow Evince-44.3 or dvisvgm-3.1 to link to libkpathsea.so, as the root user (re)create a symlink from /usr/lib:

ln -svf $TEXLIVE_PREFIX/lib/libkpathsea.so /usr/lib

Note

TeXLive includes some files for ConTeXt but the source of that is separate and has moved on from using luatex in the previous 'mkiv' version to using luametatex which can be pulled with git from github luametatex. LuaMetaTeX uses meson and ninja, but it does not fit easily into the BLFS layout of TeXLive.

However, with a little extra work 'mkiv' files can still be processed using the files shipped in texmf.

Fixes to use ConTeXt will be removed when the texlive source next has to be updated for either a vulnerability fix which requires backporting luatex changes, or for TeXLive 2024. If you are a BLFS user of ConTeXt you should be prepared to use the latest tag from github (the link is in first paragraph of this Note). Building and installing that to work with a BLFS install of TeXLive will not be a trivial exercise.

The following steps, run as the root user, will create mtxrun and context.

sed -e '/local template=\[\[--ini/s/\(primaryflags%\)\(.*\)/\1 --socket --shell-escape \2/' \
 -e '/local template=\[\[%primaryflags%/s/\(primaryflags%\)\(.*\)/\1 --socket --shell-escape \2/' \
  -i $TEXLIVE_PREFIX/texmf-dist/scripts/context/lua/mtxrun.lua &&

mkdir -pv $TEXLIVE_PREFIX/texmf-var/luatex-cache/context/ &&

ln -sfv /$TEXLIVE_PREFIX/texmf-dist/scripts/context/lua/mtxrun.lua \
        /$TEXLIVE_PREFIX/bin/$TEXARCH/mtxrun &&

cat > $TEXLIVE_PREFIX/bin/$TEXARCH/context << EOF
#!/bin/sh
export TEXMF=$TEXLIVE_PREFIX/texmf-dist;
export TEXMFCNF=$TEXLIVE_PREFIX/texmf-dist/web2c;
export TEXMFCACHE=$TEXLIVE_PREFIX/texmf-var/luatex-cache/context/;
$TEXLIVE_PREFIX/bin/$TEXARCH/mtxrun --script context "\$@"
EOF
chmod -v 0755 $TEXLIVE_PREFIX/bin/$TEXARCH/context

You can now proceed to asymptote-2.86, biber-2.19, dvisvgm-3.1 and / or xindy-2.5.1 if you wish to install them.

Command Explanations

patch -Np1 -i ../texlive-20230313-source-security_fix-1.patch: this updates the luatex source to v1.17.0 to fix security issues.

sed -e '/local template (...)' (...)mtxrun.lua: this makes a change in a texmf-dist script so that ConTeXt can now run with luatex-v1.17.0.

-C: create config.cache, this saves significant time in a parallel build.

--prefix=, --bindir=, --datarootdir=, --infodir=, --mandir= ... : these switches ensure that the files installed from source will overwrite any corresponding files previously installed by install-tl-unx so that the alternative methods of installing texlive are consistent.

--includedir=, --libdir= ... : these switches ensure that the libraries and include files will be within the directories for this year's texlive.

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-shared: Use shared versions of libkpathsea, libptexenc, libsynctex, libtexlua52 and libtexluajit.

--with-system-...: Unless this parameter is used, the included versions of these libraries will be statically compiled into the programs which need them. If you decided not to install a recommended library, omit the corresponding switch.

--disable-dvisvgm: As noted above, the shipped version of dvisvgm, which has modified configuration files, cannot be built with shared system libraries.

/sbin/ldconfig: this has to be run here so that make texlinks can use kpsewhich.

make texlinks : this runs the texlinks.sh script to create symbolic links from formats to engines. In practice, several of the targets such as xetex are now separate binaries and for these it will report "file already exists".

tar -xf texlive-20230313-texmf.tar.xz -C $TEXLIVE_PREFIX --strip-components=1: the tarball contains the files for the texmf-dist directory, and because of its size we do not want to waste time and space untarring it and then copying the files.

install -v -m644 ../texk/tests/TeXLive/* $TEXLIVE_PREFIX/tlpkg/TeXLive/: This puts the perl modules TLConfig.pm and TLUtils.pm into the directory where the binary installer puts them - it is at the start of the perl @INC@ PATH within texlive when installed using the above configure switches. Without these modules, texlive is unusable.

mktexlsr: Create an ls-R file which lists what was installed - this is used by kpathsea to find files.

fmtutil-sys --all: This initializes the TeX formats, Metafont bases and Metapost mems.

mkdir -pv $TEXLIVE_PREFIX/texmf-var/luatex-cache/context/: the context script created after this will not run correctly if this directory is not present.

--without-x: use this if you do not have Xorg installed.

There are many other '--disable' or '--without' options. Some of them such as --without-texinfo are accepted but no longer do anything, others will prevent a program being built - but the far greater amount of space used for the related items in texmf means there is no obvious benefit from disabling a few of the programs.

Contents

Installed Programs: Over 300 binaries and symlinks to scripts
Installed Libraries: libkpathsea.so, libptexenc.so, libsynctex.so, libtexlua52.so, libtexluajit.so
Installed Directories: $TEXLIVE_PREFIX/bin, $TEXLIVE_PREFIX/include, $TEXLIVE_PREFIX/lib, $TEXLIVE_PREFIX/texmf-dist

Short Descriptions

TeX programs

The programs included in TeX are too numerous to individually list. Please refer to the individual program HTML and PDF pages in the various html, man, or pdf files within the subdirectories of 2023/texmf-dist/. Using texdoc pdflatex ( replace pdflatex with the command name ) may also be useful

libkpathsea.so

(kpathsearch) exists to look up a file in a list of directories and is used by kpsewhich

libptexenc.so

is a library for Japanese pTeX (publishing TeX)

libsynctex.so

is the SyncTeX (Synchronize TeXnology) parser library

libtexlua52.so

provides Lua 5.2, modified for use with LuaTeX

libtexluajit.so

provides LuaJIT, modified for use with LuaJITTeX

asymptote-2.86

Introduction to asymptote

Asymptote is a powerful descriptive vector graphics language that provides a natural coordinate-based framework for technical drawing. Labels and equations can be typeset with LaTeX. As well as EPS, PDF and PNG output it can produce WebGL 3D HTML rendering and (using dvisvgm) SVG output.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Additional Downloads

asymptote Dependencies

Required

ghostscript-10.01.2 and texlive-20230313

Recommended
Recommended at runtime
Optional

fftw-3.3.10, Gsl-2.7.1, libsigsegv-2.14, both Boost-1.83.0 and rapidjson to use LSP which can be used with emacs, and eigen

Optional (at runtime)

ImageMagick-7.1.1-15 to convert output to other formats such as JPEG or to create animated GIFs, PyQt5 (not tested, has a build dependency of (Qt-5.15.10 or qt-alternate-5.15.10)) to use xasy.

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/asymptote

Installation of asymptote

Note

Certain 3D PDF scripts may not work when invoked from pdflatex on some zen+ amdgpu APU machines.

First apply a patch to fix building without the Language Server Protocol :

patch -Np1 -i ../asymptote-2.86-build_fix-1.patch

Install asymptote by running the following commands:

export TEXARCH=$(uname -m | sed -e 's/i.86/i386/' -e 's/$/-linux/') &&

./configure --prefix=$TEXLIVE_PREFIX                          \
            --bindir=$TEXLIVE_PREFIX/bin/$TEXARCH             \
            --datarootdir=$TEXLIVE_PREFIX/texmf-dist          \
            --infodir=$TEXLIVE_PREFIX/texmf-dist/doc/info     \
            --libdir=$TEXLIVE_PREFIX/texmf-dist               \
            --mandir=$TEXLIVE_PREFIX/texmf-dist/doc/man       \
            --disable-lsp                                     \
            --enable-gc=system                                \
            --with-latex=$TEXLIVE_PREFIX/texmf-dist/tex/latex \
            --with-context=$TEXLIVE_PREFIX/texmf-dist/tex/context/third &&

make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--prefix=, --bindir=, --datarootdir=, --infodir=, --mandir= ... : these switches ensure that the files installed from source will overwrite any corresponding files previously installed by install-tl-unx so that the alternative methods of installing texlive are consistent.

--libdir=$TEXLIVE_PREFIX/texmf-dist;: This parameter ensures that the asymptote directory will similarly overwrite any files installed by install-tl-unx.

--disable-lsp: The Language Server Protocol is enabled by default, with several third-party sources included, but it does not build unless boost and repidjson have been installed.

--enable-gc=system: this ensures that the system version of libgc.so will be used instead of the version shipped with this package.

--with-latex= ... --with-context=: These switches ensure that style files and a tex file will be installed into the texlive directories instead of creating a texmf-local directory for them.

Contents

Installed Programs: asy, xasy
Installed Libraries: None
Installed Directory: $TEXLIVE_PREFIX/texmf-dist/asymptote, $TEXLIVE_PREFIX/doc/asymptote, $TEXLIVE_PREFIX/info/asymptote

Short Descriptions

asy

is a vector graphics program

xasy

is a Python3 script providing a Qt5 GUI for asy

biber-2.19

Introduction to biber

Biber is a BibTeX replacement for users of biblatex, written in Perl, with full Unicode support.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Note

If you have updated to a new release of texlive-source, biber and its perl dependencies are still present in /usr and do not need to be rebuilt. However, biblatex installs in /opt/texlive/2023 and does need to be reinstalled.

If you installed the above dependencies using the BLFS instructions for each of them, perl ./Build.PL will complain that Mozilla::CA is not installed, but that is not needed unless CPAN was used to install the modules. BLFS patches LWP::Protocol::https to use the system certificates, Mozilla::CA uses old certificates.

Biber Dependencies

Required

autovivification-0.18 Business-ISBN-3.008 Business-ISMN-1.203 Business-ISSN-1.005 Class-Accessor-0.51 Data-Compare-1.29 Data-Dump-1.25 Data-Uniqid-0.12 DateTime-Calendar-Julian-0.107 DateTime-Format-Builder-0.83 Encode-EUCJPASCII-0.03 Encode-HanExtra-0.23 Encode-JIS2K-0.03 File-Slurper-0.014 IO-String-1.08 IPC-Run3-0.048 Lingua-Translit-0.29 List-AllUtils-0.19 List-MoreUtils-0.430 Log-Log4perl-1.57 LWP-Protocol-https-6.11 Module-Build-0.4232 Parse-RecDescent-1.967015 PerlIO-utf8_strict-0.010 Regexp-Common-2017060201 Sort-Key-1.33 Text-BibTeX-0.89 Text-CSV-2.03 Text-Roman-3.5 Unicode-Collate-1.31 Unicode-LineBreak-2019.001 XML-LibXML-Simple-1.01 XML-LibXSLT-2.002001 XML-Writer-0.900

Recommended (required for the test suite)

Note

It is possible to install all missing dependencies automatically. You must first install Module-Build-0.4232 using automatic installation of perl modules. Then run perl ./Build.PL and when it prompts you, become the root user and run ./Build installdeps - this will use CPAN and as noted above it will use Mozilla::CA instead of using system certificates.

Editor Notes: https://wiki.linuxfromscratch.org/blfs/wiki/biber

Installation of Biber

Install Biber by running the following commands:

perl ./Build.PL &&
./Build

To test the results, enter: ./Build test

Now, as the root user:

./Build install

Contents

Installed Programs: biber
Installed Library: None
Installed Directory: /usr/lib/perl5/site_perl/5.*{,/<arch>-linux/auto}/Biber

Short Descriptions

biber

is used for producing bibliographies in LaTeX documents

dvisvgm-3.1

Introduction to dvisvgm

The dvisvgm package converts DVI, EPS and PDF files to SVG format.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

dvisvgm Dependencies

Required

Brotli-1.0.9, ghostscript-10.01.2, and Potrace-1.16

Recommended
Optional

asciidoc-10.2.0 with xmlto-0.0.28 and libxslt-1.1.38 (see command explanations), dblatex (with the above) and xxHash (the current version is included in the tarball)

Installation of dvisvgm

The test suite assumes that a modern version of Python has been installed as plain python. Changing this to use python3 requires a sed to one Makefile.in file.

Install dvisvgm by running the following commands:

sed -i 's/python/&3/' tests/Makefile.in         &&
./configure                                     \
    --bindir=$TEXLIVE_PREFIX/bin/${TEXARCH}     \
    --mandir=$TEXLIVE_PREFIX/texmf-dist/doc/man \
    --with-kpathsea=$TEXLIVE_PREFIX             &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--with-kpathsea=$TEXLIVE_PREFIX: This allows the build system to find the headers for kpathsea

Contents

Installed Programs: dvisvgm
Installed Libraries: None
Installed Directories: None

Short Descriptions

dvisvgm

converts DVI, EPS and PDF files to the SVG format

xindy-2.5.1

Introduction to xindy

Xindy is an index processor that can be used to generate book-like indexes for arbitrary document-preparation systems. This includes systems such as TeX and LaTeX, the roff-family, and SGML/XML-based systems (e.g., HTML) that process some kind of text and generate indexing information.

This package is known to build and work properly using an LFS 12.0 platform.

Package Information

Required Additional Downloads

Xindy Dependencies

Required

Clisp-2.49 and texlive-20230313

Installation of xindy

Install xindy by running the following commands:

export TEXARCH=$(uname -m | sed -e 's/i.86/i386/' -e 's/$/-linux/') &&

sed -i "s/ grep -v '^;'/ awk NF/" make-rules/inputenc/Makefile.in &&

sed -i 's%\(indexentry\)%\1\\%' make-rules/inputenc/make-inp-rules.pl &&

patch -Np1 -i ../xindy-2.5.1-upstream_fixes-2.patch &&

./configure --prefix=$TEXLIVE_PREFIX              \
            --bindir=$TEXLIVE_PREFIX/bin/$TEXARCH \
            --datarootdir=$TEXLIVE_PREFIX         \
            --includedir=/usr/include             \
            --libdir=$TEXLIVE_PREFIX/texmf-dist   \
            --mandir=$TEXLIVE_PREFIX/texmf-dist/doc/man &&

make LC_ALL=POSIX

This package does not have a test suite.

Now, as the root user:

make install

Command Explanations

sed -i "s/ grep -v '^;'/ awk NF/" ...: The build sorts files in latin{1..3} encodings to create latin.xdy, and unicode versions of these to create utf8.xdy after using grep -v '^;' to remove blank lines. With grep-2.23 any data not in the expected encoding is treated as binary, resulting in a useless file. This command uses an alternative way of removing blank lines.

sed -i 's%\(indexentry\)%\1\\%' ...: A regexp contains indexentry{ - perl has warned about the unescaped left brace for some time and now treats it as illegal. Change it to indexentry\{, doubling the backslash for sed.

patch -Np1 -i ../xindy-2.5.1-upstream_fixes-2.patch: Xindy is now maintained at CTAN. This patch updates the source with some of the changes made there (but ignoring changes which were only made to allow for spaces in pathnames and some trivial recent changes).

--prefix=, --bindir=, --datarootdir=, --infodir=, --mandir= ... : these switches ensure that the files installed from source will overwrite any corresponding files previously installed by install-tl-unx so that the alternative methods of installing texlive are consistent.

--includedir=/usr/include: This parameter ensures that the kpathsea headers from texlive-20230313 will be found.

make LC_ALL=POSIX: with the current version of coreutils it is essential to build xindy in the POSIX (or C) locale because in a UTF-8 locale the file latin.xdy will contain only a heading and then a line 'Binary file (standard input) matches' instead of the many lines of lisp merge-rule commands it ought to contain.

Contents

Installed Programs: tex2xindy, texindy, xindy
Installed Libraries: None
Installed Directory: $TEXLIVE_PREFIX/texmf-dist/xindy

Short Descriptions

tex2xindy

transforms a LaTeX index file into a xindy raw index file

texindy

is a wrapper for xindy that turns on many LaTeX conventions by default

xindy

creates a sorted and tagged index from a raw LaTeX index

Appendix A. Creative Commons License

Creative Commons Legal Code

Attribution-NonCommercial-ShareAlike 2.0

Important

CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS LICENSE DOES NOT CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE INFORMATION PROVIDED, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM ITS USE.

License

THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.

BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.

  1. Definitions

    1. "Collective Work" means a work, such as a periodical issue, anthology or encyclopedia, in which the Work in its entirety in unmodified form, along with a number of other contributions, constituting separate and independent works in themselves, are assembled into a collective whole. A work that constitutes a Collective Work will not be considered a Derivative Work (as defined below) for the purposes of this License.

    2. "Derivative Work" means a work based upon the Work or upon the Work and other pre-existing works, such as a translation, musical arrangement, dramatization, fictionalization, motion picture version, sound recording, art reproduction, abridgment, condensation, or any other form in which the Work may be recast, transformed, or adapted, except that a work that constitutes a Collective Work will not be considered a Derivative Work for the purpose of this License. For the avoidance of doubt, where the Work is a musical composition or sound recording, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered a Derivative Work for the purpose of this License.

    3. "Licensor" means the individual or entity that offers the Work under the terms of this License.

    4. "Original Author" means the individual or entity who created the Work.

    5. "Work" means the copyrightable work of authorship offered under the terms of this License.

    6. "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.

    7. "License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, Noncommercial, ShareAlike.

  2. Fair Use Rights. Nothing in this license is intended to reduce, limit, or restrict any rights arising from fair use, first sale or other limitations on the exclusive rights of the copyright owner under copyright law or other applicable laws.

  3. License Grant. Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:

    1. to reproduce the Work, to incorporate the Work into one or more Collective Works, and to reproduce the Work as incorporated in the Collective Works;

    2. to create and reproduce Derivative Works;

    3. to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission the Work including as incorporated in Collective Works;

    4. to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission Derivative Works;

    The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. All rights not expressly granted by Licensor are hereby reserved, including but not limited to the rights set forth in Sections 4(e) and 4(f).

  4. Restrictions.The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:

    1. You may distribute, publicly display, publicly perform, or publicly digitally perform the Work only under the terms of this License, and You must include a copy of, or the Uniform Resource Identifier for, this License with every copy or phonorecord of the Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Work that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Work itself to be made subject to the terms of this License. If You create a Collective Work, upon notice from any Licensor You must, to the extent practicable, remove from the Collective Work any reference to such Licensor or the Original Author, as requested. If You create a Derivative Work, upon notice from any Licensor You must, to the extent practicable, remove from the Derivative Work any reference to such Licensor or the Original Author, as requested.

    2. You may distribute, publicly display, publicly perform, or publicly digitally perform a Derivative Work only under the terms of this License, a later version of this License with the same License Elements as this License, or a Creative Commons iCommons license that contains the same License Elements as this License (e.g. Attribution-NonCommercial-ShareAlike 2.0 Japan). You must include a copy of, or the Uniform Resource Identifier for, this License or other license specified in the previous sentence with every copy or phonorecord of each Derivative Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Derivative Works that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder, and You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Derivative Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Derivative Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Derivative Work itself to be made subject to the terms of this License.

    3. You may not exercise any of the rights granted to You in Section 3 above in any manner that is primarily intended for or directed toward commercial advantage or private monetary compensation. The exchange of the Work for other copyrighted works by means of digital file-sharing or otherwise shall not be considered to be intended for or directed toward commercial advantage or private monetary compensation, provided there is no payment of any monetary compensation in connection with the exchange of copyrighted works.

    4. If you distribute, publicly display, publicly perform, or publicly digitally perform the Work or any Derivative Works or Collective Works, You must keep intact all copyright notices for the Work and give the Original Author credit reasonable to the medium or means You are utilizing by conveying the name (or pseudonym if applicable) of the Original Author if supplied; the title of the Work if supplied; to the extent reasonably practicable, the Uniform Resource Identifier, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and in the case of a Derivative Work, a credit identifying the use of the Work in the Derivative Work (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). Such credit may be implemented in any reasonable manner; provided, however, that in the case of a Derivative Work or Collective Work, at a minimum such credit will appear where any other comparable authorship credit appears and in a manner at least as prominent as such other comparable authorship credit.

    5. For the avoidance of doubt, where the Work is a musical composition:

      1. Performance Royalties Under Blanket Licenses. Licensor reserves the exclusive right to collect, whether individually or via a performance rights society (e.g. ASCAP, BMI, SESAC), royalties for the public performance or public digital performance (e.g. webcast) of the Work if that performance is primarily intended for or directed toward commercial advantage or private monetary compensation.

      2. Mechanical Rights and Statutory Royalties. Licensor reserves the exclusive right to collect, whether individually or via a music rights agency or designated agent (e.g. Harry Fox Agency), royalties for any phonorecord You create from the Work ("cover version") and distribute, subject to the compulsory license created by 17 USC Section 115 of the US Copyright Act (or the equivalent in other jurisdictions), if Your distribution of such cover version is primarily intended for or directed toward commercial advantage or private monetary compensation. 6. Webcasting Rights and Statutory Royalties. For the avoidance of doubt, where the Work is a sound recording, Licensor reserves the exclusive right to collect, whether individually or via a performance-rights society (e.g. SoundExchange), royalties for the public digital performance (e.g. webcast) of the Work, subject to the compulsory license created by 17 USC Section 114 of the US Copyright Act (or the equivalent in other jurisdictions), if Your public digital performance is primarily intended for or directed toward commercial advantage or private monetary compensation.

    6. Webcasting Rights and Statutory Royalties. For the avoidance of doubt, where the Work is a sound recording, Licensor reserves the exclusive right to collect, whether individually or via a performance-rights society (e.g. SoundExchange), royalties for the public digital performance (e.g. webcast) of the Work, subject to the compulsory license created by 17 USC Section 114 of the US Copyright Act (or the equivalent in other jurisdictions), if Your public digital performance is primarily intended for or directed toward commercial advantage or private monetary compensation.

  5. Representations, Warranties and Disclaimer

    UNLESS OTHERWISE MUTUALLY AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.

  6. Limitation on Liability. EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

  7. Termination

    1. This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Derivative Works or Collective Works from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.

    2. Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.

  8. Miscellaneous

    1. Each time You distribute or publicly digitally perform the Work or a Collective Work, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.

    2. Each time You distribute or publicly digitally perform a Derivative Work, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.

    3. If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

    4. No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.

    5. This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.

Important

Creative Commons is not a party to this License, and makes no warranty whatsoever in connection with the Work. Creative Commons will not be liable to You or any party on any legal theory for any damages whatsoever, including without limitation any general, special, incidental or consequential damages arising in connection to this license. Notwithstanding the foregoing two (2) sentences, if Creative Commons has expressly identified itself as the Licensor hereunder, it shall have all rights and obligations of Licensor.

Except for the limited purpose of indicating to the public that the Work is licensed under the CCPL, neither party will use the trademark "Creative Commons" or any related trademark or logo of Creative Commons without the prior written consent of Creative Commons. Any permitted use will be in compliance with Creative Commons' then-current trademark usage guidelines, as may be published on its website or otherwise made available upon request from time to time.

Creative Commons may be contacted at http://creativecommons.org/.

Appendix B. The MIT License

Copyright © 1999-2023 The BLFS Development Team

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Glossary

Acronyms

669

UNIS/Composer 669 Module

ABI

Application Binary Interface

ADSL

Asymmetric Digital Subscriber Line

AFS

Andrew File System

AGESA

AMD Generic Encapsulated Software Architecture

AIFF

Audio Interchange File Format

ALSA

Advanced Linux Sound Architecture

ANSI

American National Standards Institute

API

Application Programming Interface

APR

Apache Portable Runtime

ARP

Address Resolution Protocol

ASCII

American Standard Code for Information Interchange

ASLR

Address Space Layout Randomization

ASN

Abstract Syntax Notation

ASF

Advanced Streaming Format

ATA

Advanced Technology Attachment

ATSC

Advanced Television Systems Committee

ATK

Accessibility ToolKit

AVI

Audio Video Interleave

AWT

Abstract Window Toolkit

BER

Basic Encoding Rules

BIND

Berkeley Internet Name Domain

BIOS

Basic Input/Output System

BLFS

Beyond Linux From Scratch

BMP

Bit MaP

CD

Compact Disk

CDDA

Compact Disc Digital Audio

CIFS

Common Internet File System

See Also SMB .

CMS

Cryptographic Message Syntax

CODEC

COmpression/DECompression module

CORBA

Common Object Request Broker Architecture

CPU

Central Processing Unit

CRD

Color Rendering Dictionary

CSA

Color Space Array

CSS (on DVD)

Contents Scrambling System

CSS

Cascading Style Sheets

CUPS

Common Unix Printing System

CVS

Concurrent Versions System

DAO

Disc At Once

DARPA

Directory Address Resolution Protocol Allocation

DEC

Digital Equipment Corporation

DER

Distinguished Encoding Rules

DES

Data Encryption Standard

DHCP

Dynamic Host Configuration Protocol

DICT

Dictionary Server Protocol (RFC 2229)

DIN

German Industrial Norm

DNS

Domain Name Service

DOS

Disk Operating System

DRI

Direct Rendering Infrastructure

DSC

Document Structuring Conventions

DSO

Dynamic Shared Objects

DSSSL

Document Style Semantics and Specification Language

DV

Digital Video

DVD

Digital Versatile Disk (also Digital Video Disk)

DVI

DeVice Independent

ELF

Executable and Linking Format

EPP

Enhanced Parallel Port

EPS

Encapsulated PostScript

ESD

Enlighten Sound Daemon

ESMTP

Extended Simple Mail Transfer Protocol

FAM

File Alteration Monitor

FAME

Fast Assembly Mpeg Encoder

FAQ

Frequently Asked Questions

FAX

Facsimile

FB

Frame Buffer

FHS

File Hierarchy Standard

FLAC

Free Lossless Audio CODEC

FO

Formatted Objects

FTP

File Transfer Protocol

GCC

GNU Compiler Collection

GDBM

GNU DataBase Manager

GDK

GTK+ Drawing Kit

GDM

GNOME Display Manager

GID

Group IDentity

GIF

Graphics Interchange Format

GLUT

OpenGL Utility Toolkit

GMP

GNU Multiple Precision Arithmetic

GNAT

GNU NYU Ada 9x Translator

GNOME

GNU Network Object Model Environment

GNU

GNU's Not Unix

GPL

General Public License

GPM

General Purpose Mouse

GSS

Generic Security Service

GSSAPI

Generic Security Service Application Programming Interface

GTK

GIMP ToolKit

GUI

Graphical User Interface

HFS

Hierarchical File System

HTML

HyperText Markup Language

HTTP

HyperText Transfer Protocol

HTTPS

HyperText Transfer Protocol Secured

HUP

Hang UP

IANA

Internet Assigned Numbers Authority

ICC

International Color Consortium

ICMP

Internet Control Message Protocol

IDE

Integrated Drive Electronics

Integrated Development Environment

IDL

Interface Definition Language

IJS

Ink Jet Systems

ILS

Internet Location Server

IMAP

Internet Message Access Protocol

IMON

Inode MONitor

IP

Internet Protocol

See Also TCP .

IPX

Internetwork Packet eXchange

IRC

Internet Relay Chat

ISDN

Integrated Services Digital Network

ISO

International Standards Organisation

ISP

Internet Service Provider

IT

ImpulseTracker Module

JAI

Java Advanced Imaging

JAR

Java ARchive

JDK

Java Development Kit

JFIF

JPEG File Interchange Format

JPEG

Joint Photographic Experts Group

KDC

Key Distribution Center

KDE

KDesktop Environment

LAME

Lame Ain't an MP3 Encoder

LAN

Local Area Network

LDAP

Lightweight Directory Access Protocol

LDIF

Lightweight Data Interchange Format

LFS

Linux From Scratch

LGPL

Library General Public License

LPR

Line PRinter

LZO

Lempel-Ziv-Oberhumer

LZW

Lempel-Ziv-Welch

MAC

Media Access Control

MCOP

Multimedia COmmunication Protocol

MCU

Multipoint Control Unit

MD

Message-Digest

MDA

Mail Delivery Agent

MED

MED/OctaMED Module

MIDI

Musical Instrument Digital Interface

MIF

Maker Interchange Format

MII

Media Independent Interface

MIME

Multipurpose Internet Mail Extensions

MIT

Massachusetts Institute of Technology

MNG

Multiple-image Network Graphics

MOD

ProTracker Module

MP3

MPEG-1 audio layer 3

MPEG

Moving Picture Experts Group

MSL

Magick Scripting Language

MTA

Mail Transport Agent

MTM

MultiTracker Module

MUA

Mail User Agent

NASM

Netwide ASseMbler

NNTP

Network News Transfer Protocol

NFS

Network File System

NIS

Network Information Service

NPTL

Native Posix Thread Library

NSPR

Netscape Portable Runtime

NSS

Network Security Services

NTP

Network Time Protocol

OAF

Object Activation Framework

ODBC

Open DataBase Connectivity

OMF

Open Metadata Framework

ORB

Object Request Broker

See Also CORBA .

ORDBMS

Object Relational Database Management System

OS

Operating System

OSF

Open Software Foundation

OSS

Open Sound System

PAM

Pluggable authentication Modules

PBM

Portable BitMap

PCI

Peripheral Component Interconnect

PCL

Printer Control Language

PCM

Pulse Code Modulation

PDC

Primary Domain Controller

PDF

Portable Document Format

PEAR

PHP Extension and Application Repository

PGM

Portable Grey Map

PGP

Pretty Good Privacy

PHP

PHP Hypertext Preprocessor

PIE

Position Independent Executable

PIM

Personal Information Manager

PLIP

Parallel Line Internet Protocol

PNG

Portable Network Graphics

PO

Portable Object

POD

Plain Old Documentation

POP

Post Office Protocol

PPD

PostScript Printer Description

PPM

Portable Pixel Map

PPP

Point to Point Protocol

PPPoE

Point to Point Protocol over Ethernet

PS

PostScript

RADIUS

Remote Authentication Dial-In User Service

RAM

Random Access Memory

RARP

Reverse Address Resolution Protocol

RCS

Revision Control System

RFC

Request For Comments

RGB

Red Green Blue

RGBA

Red Green Blue Alpha

ROM

Read-Only Memory

RP

Roaring Penguin

RPC

Remote Procedure Call

RTC

Real Time Clock

RTP

Real Time Protocol

RW

Read Write

S3M

ScreamTracker Version 3 Module

S/MIME

Secure/MIME

SANE

Scanner Access Now Easy

SASL

Simple Authentication and Security Layer

SATA

Serial Advanced Technology Attachment

SBU

Standard Build Unit

SCSI

Small Computer System Interface

SDK

Software Development Kit

SGML

Standard Generalized Markup Language

SMART

Self Monitoring Analysis and Reporting Technology

SMB

Server Message Block

SMIL

Synchronized Multimedia Integration Language

SMTP

Simple Mail Transfer Protocol

SQL

Structured Query Language

SSH

Secure SHell

SSL

Secure Sockets Layer

SSP

Stack Smash Protection

SUID

Set User IDentity

SVG

Scalable Vector Graphics

SVGA

Super Video Graphics Array

TCL

Tool Command Language

TCP

Transmission Control Protocol

TGT

Ticket-Granting Ticket

TIFF

Tag(ged) Image File Format

TLS

Transport Layer Security

TTF

TrueType Font

TTS

Text To Speech

UCS

Universal Character Set

UDF

Universal Disk Format

UID

User IDentity

UDP

User Datagram Protocol

UI

User Interface

UML

Unified Modelling Language

URL

Uniform Resource Locator

USB

Universal Serial Bus

USR

Upstream Ready

UTF

UCS Transformation Format

UUCP

Unix-to-Unix Copy Protocol

VCD

Video Compact Disk

VCS

Version Control System

VESA

Video Electronics Standards Association

VGA

Video Graphics Array

VNC

Virtual Network Computer

VOB

Video OBject

VOIP

Voice Over IP

W3C

World Wide Web Consortium

WAV

Waveform Audio

WWW

World Wide Web

XDMCP

XDisplay Manager Control Protocol

XM

FastTracker Module

XML

eXtensible Markup Language

XSL

eXtensible Style Language

XSLT

eXtensible Style Language Transformation

XSM

X/Open System Management

XMMS

XMultiMedia System

YP

Yellow Pages

YUV

Luminance-Bandwidth-Chrominance

Index

Packages

Programs

Libraries

Kernel Configuration

Configuration Files

Bootscripts

Others