28.1 Necessary Programs

Since ALLPROSE builds on Noweb, it should be installed and accessible, in particular the programs notangle and noweave should be in some path given through the PATH environment variable.

In fact, several other programs are necessary. They are listed in Section 29.2.

352necessary programs 352  (350 427)  353a
export NOTANGLE=notangle
NOWEAVE=noweave

Defines:
NOTANGLE, used in chunks 362, 363, 376, 435, 437, 468b, and 548.
notangle, never used.
NOWEAVE, used in chunk 353a.

In fact, we are using noweave with the options

Since the documentation of the library is handed over to NOWEAVEX as one big chunk, the cross-references work across the files of the project, see Makefile.nw target texfiles.

353anecessary programs 352+   (350 427)  352  353b
export NOWEAVEX=$(NOWEAVE) -n -index

Defines:
NOWEAVEX, used in chunk 372a.

Uses NOWEAVE 352.

For speeding up the building process the program cpif written by Norman Ramsey comes quite handy. It should come together with the distribution of Noweb.

353bnecessary programs 352+   (350 427)  353a  354a
export CPIF=cpif

Defines:
CPIF, used in chunk 435.

In order to avoid hardcoding some programs we define also variables CP and GREP.

354anecessary programs 352+   (350 427)  353b  354b
export CP=cp#                  copy file
  #cp (coreutils) 5.2.1
  #Written by Torbjorn Granlund, David MacKenzie, and Jim Meyering.
export GREP=grep#              print lines matching a regular expression
  #grep (GNU grep) 2.5.1

Defines:
CP, used in chunks 356, 361a, 362, 378–80, 383a, 384, 412, 549, and 555.
GREP, used in chunks 362, 382, 383b, and 408.

The programs TAR and GNUZIP are only necessary for compiling a distribution.

Note that the environment variable GZIP is used by the gzip program to hold extra arguments. Therefore it cannot be used here to denote the program.

354bnecessary programs 352+   (350 427)  354a  429
export TAR=tar#                build an archive of several files
  #tar (GNU tar) 1.14
  #Written by Torbjorn Granlund, David MacKenzie, and Jim Meyering.
export GNUZIP=gzip#              compress and decompress a file
  #gzip 1.3.5
  #(2002-09-30)
  #Copyright 2002 Free Software Foundation
  #Copyright 1992-1993 Jean-loup Gailly

Defines:
GNUZIP, used in chunk 420b.
TAR, used in chunk 420b.