* Merged newxml into HEAD
[linux_from_scratch.git] / lfscmd / README
blob705ae2640c8b8e8918f77f25eff21da9face2fdd
1 NAME
2        LFSCMD - Extract LFS/BLFS book commands.
4 SYNOPSIS
5        lfscmd [options] [index.xml]
7 DESCRIPTION
8        lfscmd extracts commands from the LFS and BLFS books.
9        The commands may be printed, executed, or written
10        to files. lfscmd can record the title of the current page
11        and select pages which match a regular expression.
13        lfscmd  tries  to  conform  older  books  to the new
14        command structure.  For instance, lfscmd removes double
15        ampersands and disregards the space between command
16        blocks.
18        lfscmd might be used to:
20        *      Reference the build instructions of one or more
21               packages.
23        *      Determine the command changes between arbitrary
24               versions of a  particular  package, with assistance
25               from diff(1).
27        *      Automate installation scripts by executing commands
28               for one or more packages on the fly.
30 OPTIONS
31        -e     Execute commands.
33        -f     Write commands to their own file.
35        -a     Strip '&&' in commands.
36        
37        -q query
38               Output pages matching regex query.
40        -t     Print titles (as comments).
42        -x     Give executable permission to the resulting files.
44 ENVIRONMENT VARIABLES
45        LFSCMD_BOOK
46               The full path to the index page of the default book.
48 AUTHOR
49        Timothy Bauscher <timothy@linuxfromscratch.org>