1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
.\"
.\" cook - file construction tool
.\" Copyright (C) 1990, 1991, 1992, 1993, 1997 Peter Miller;
.\" All rights reserved.
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 2 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
.\"
.\" MANIFEST: User Guide, Introduction
.\"
.H 1 "Introduction"
This document describes
.BR cook ,
a maintenance tool designed to construct files.
.B Cook
may be used to maintain consistency between executable files and the
associated source files that are used to generate them.
The consistency is designated by the relative
last-modified times of files
and is thus automatically adjusted each time a file is edited,
compiled or otherwise modified.
.B Cook
validates the consistency of a system of
files and executes all commands necessary to maintain that
consistency.
.P
.B Cook
is a tool for constructing files.
It is given a set of files to create,
and instructions detailing how to construct them.
In any non-trivial program
there will be prerequisites to performing
the actions necessary to creating any file,
such as extraction from a source-control system.
.B Cook
provides a mechanism to define these.
.P
When a program is being developed or maintained,
the programmer will typically change one file of several
which comprise the program.
.B Cook
examines the last-modified times of the files to see when
the prerequisites of a file have changed,
implying that the file
needs to be recreated as it is logically out of date.
.P
.B Cook
also provides a facility for implicit recipes,
allowing users to specify how to form a file with a given suffix from
a file with a different suffix.
For example,
to create
.IB filename .o
from
.IB filename .c
.H 2 "How to Use this Manual"
This manual is divided into two parts.
.P
The first part is tutorial introduction to
.BR cook .
This part runs from chapter 4 to chapter 5.
.P
The second part is for reference and details precisely how
.B cook
works.
This part runs from chapter 6 to chapter 14.
.P
Users familiar with other programs similar to
.B cook
are advised to skim the tutorial part before diving into the reference part.
|
