lfscmd/doc/lfscmd.1

   1 .\" Process this file with
   2 .\" groff -man -Tascii lfscmd.1
   3 .\"
   4 .TH LFSCMD 1
   5 .SH NAME
   6 LFSCMD \- Extract LFS/BLFS book commands.
   7 .SH SYNOPSIS
   8 .B lfscmd [options] [index.xml]
   9 .SH DESCRIPTION
  10 .B lfscmd
  11 extracts commands from the LFS and BLFS books. The commands may be
  12 printed, executed, or written to files. lfscmd can record
  13 the title of the current page and select pages which match a regular
  14 expression.
  15
  16 lfscmd tries to conform older books to the new command structure.
  17 For instance, lfscmd removes double ampersands and disregards the
  18 space between command blocks.
  19
  20 lfscmd might be used to:
  21 .TP
  22 *
  23 Reference the build instructions of one or more packages.
  24 .TP
  25 *
  26 Determine the command changes between arbitrary versions
  27 of a particular package, with assistance from diff(1).
  28 .TP
  29 *
  30 Automate installation scripts by executing commands for
  31 one or more packages on the fly.
  32 .SH OPTIONS
  33 .TP
  34 .B -e
  35 Execute commands.
  36 .TP
  37 .B -f
  38 Write commands to their own file.
  39 .TP
  40 .B -a
  41 Strip '&&' in commands.
  42 .TP
  43 .B
  44 -q query
  45 Output pages matching regex query.
  46 .TP
  47 .B -t
  48 Print titles (as comments).
  49 .TP
  50 .B
  51 -x
  52 Give executable permission to the resulting files.
  53 .SH "ENVIRONMENT VARIABLES"
  54 .TP
  55 .SM LFSCMD_BOOK
  56 The full path to the index page of the default book.
  57 .SH AUTHOR
  58 Timothy Bauscher <timothy@linuxfromscratch.org>