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
![[Note]](../images/note.png)
Note
Please configure your browser to display fixed-width text with a
good monospaced font, with which you can distinguish the glyphs
of Il1 or O0 clearly.
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.
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/groupfrom 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 GLFS, 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 GLFS 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 GLFS may be necessary. Optional dependencies are sometimes listed without explicit GLFS 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 (as a module if enabled) 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.