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.

348necessary programs 348  (346 422)  349a
export NOTANGLE=notangle
NOWEAVE=noweave

Defines:
NOTANGLE, used in chunks 358, 359, 371, 431, 433, 464b, and 546.
notangle, never used.
NOWEAVE, used in chunk 349a.

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.

349anecessary programs 348+   (346 422)  348  349b
export NOWEAVEX=$(NOWEAVE) -n -index

Defines:
NOWEAVEX, used in chunk 368a.

Uses NOWEAVE 348.

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.

349bnecessary programs 348+   (346 422)  349a  350a
export CPIF=cpif

Defines:
CPIF, used in chunk 431.

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

350anecessary programs 348+   (346 422)  349b  350b
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 352, 357a, 358, 373–75, 378a, 379, 407, 547, and 553.
GREP, used in chunks 358, 377, 378b, and 403.

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.

350bnecessary programs 348+   (346 422)  350a  425
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 415b.
TAR, used in chunk 415b.