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 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
|
Building(FHist) Building(FHist)
NAME
fhist - file history and comparison tools
Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997,
1998, 1999, 2000, 2001, 2002, 2003 Peter Miller; All
rights reserved.
Portions of this program are
Copyright (C) 1990 David I. Bell.
The fhist package is distrributed under the terms of the
GNU General Public License, see the LICENSE section,
below, for more information.
SPACE REQUIREMENTS
You will need about 600K to unpack and build the fhist
package. (This is the worst case seen so far, most
systems have binaries about 60% as big as this, 400K is
more typical.) Your mileage may vary.
BEFORE YOU START
There are a few pieces of software you may want to fetch
and install before you proceed with your installation of
cook.
GNU Gettext
The fhist package has been internationalized. It
can now print error messages in any of the
supported languages. In order to do this, the GNU
Gettext package must be installed before you run
the configure script as detailed in the next
section. This is because the configure script
looks for it. On systems which use the GNU C
library, version 2.0 or later, there is no need to
explictly do this as GNU Gettext is included.
Remember to use the GNU Gettext configure --with-
gnu-gettext option if your system has native
gettext tools.
GNU Groff
The documentation for the fhist package was
prepared using the GNU Groff package. This
distribution includes full documentation, which
may be processed into PostScript or DVI files at
install time - if GNU Groff has been installed.
GNU Groff patch
There is a patch for GNU Groff available, which
gives groff(1) and gsoelim(1) a -Bpath option.
This adds an include file search path, similar to
cpp(1). The Makefile assumes this is available.
The patch is at
http://www.canb.auug.org.au/~millerp/groff-1.11a.patch
or its mirrors.
Bison If your operating system does not have a native
yacc(1) you will need to fetch and install GNU
Bison in order to build the fhist package.
An ANSI C compiler.
You must have an ANSI C compiler to compile this
program. You may also want to consider fetching
and installing the GNU C Compiler if you have not
done so already.
The GNU FTP archives may be found at prep.ai.mit.edu, and
are mirrored around the world.
SITE CONFIGURATION
The fhist package is configured using the configure shell
script included in this distribution.
The configure shell script attempts to guess correct
values for various system-dependent variables used during
compilation, and creates the Makefile and common/config.h
files. It also creates a shell script config.status that
you can run in the future to recreate the current
configuration.
Normally, you just cd to the directory containing fhist's
source code and type
% ./configure
...lots of output...
%
If you're using csh on an old version of System V, you
might need to type
% sh configure
...lots of output...
%
instead to prevent csh from trying to execute configure
itself.
Running configure takes a minute or two. While it is
running, it prints some messages that tell what it is
doing. If you don't want to see the messages, run
configure with its standard output redirected to
/dev/null; for example,
% ./configure > /dev/null
%
By default, configure will arrange for the make install
command to install the fhist package's files in
/usr/local/bin and /usr/local/man. You can specify an
installation prefix other than /usr/local by giving
configure the option --prefix=PATH.
You can specify separate installation prefixes for
architecture-specific files and architecture-independent
files. If you give configure the option --exec-
prefix=PATH the fhist package will use PATH as the prefix
for installing programs and libraries. Data files and
documentation will still use the regular prefix.
Normally, all files are installed using the same prefix.
configure ignores any other arguments that you give it.
On systems that require unusual options for compilation or
linking that the fhist package's configure script does not
know about, you can give configure initial values for
variables by setting them in the environment. In Bourne-
compatible shells, you can do that on the command line
like this:
$ CC='gcc -traditional' LIBS=-lposix ./configure
...lots of output...
$
Here are the make variables that you might want to
override with environment variables when running
configure.
Variable: CC
C compiler program. The default is cc.
Variable: INSTALL
Program to use to install files. The default is
install if you have it, cp otherwise.
Variable: LIBS
Libraries to link with, in the form -lfoo -lbar.
The configure script will append to this, rather
than replace it.
If you need to do unusual things to compile the package,
the author encourages you to figure out how configure
could check whether to do them, and mail diffs or
instructions to the author so that they can be included in
the next release.
BUILDING FHIST
All you should need to do is use the
% make
...lots of output...
%
command and wait. When this finishes you should see a
directory called bin containing four files: fcomp, fhist,
fmerge and txt2c.
fcomp The fcomp program is user to compare two text
files.
fhist The fhist program is used to maintain and edit
history of a text file.
fmerge The fmerge program is used to merge together edits
from two descendants of a file.
txt2c The txt2c program is a utility used to build the
fhist package; it is not intended for general use
and should not be installed.
You can remove the program binaries and object files from
the source directory by using the
% make clean
...lots of output...
%
command. To remove all of the above files, and also
remove the Makefile and common/config.h and config.status
files, use the
% make distclean
...lots of output...
%
command.
The file etc/configure.in is used to create configure by a
GNU program called autoconf. You only need to know this
if you want to regenerate configure using a newer version
of autoconf.
TESTING FHIST
The fhist package is accompanied by a test suite. To run
this test suite, use the following command:
% make sure
...lots of output...
%
This is successful if the last line of the test output
reads "Passed All Tests".
Please let the author know if any of the tests fail, and
why if you can work that out.
INSTALLING FHIST
As explained in the SITE CONFIGURATION section, above, the
fhist package is installed under the /usr/local tree by
default. Use the --prefix=PATH option to configure if you
want some other path.
All that is required to install the fhist package is to
use the
% make install
...lots of output...
%
command. Control of the directories used may be found in
the first few lines of the Makefile file if you want to
bypass the configure script.
The above procedure assumes that the soelim(1) command is
somewhere in the command search PATH. The soelim(1)
command is available as part of the GNU Roff package,
mentioned previously in the PRINTED MANUALS section. If
you don't have it, but you do have the cook package, then
a link from roffpp to soelim will also work.
The above procedure also assumes that the
$(prefix)/man/man1 and $(prefix)/man/man5 directories
already exist. If they do not, you will need to mkdir
them manually.
PRINTED MANUALS
The easiest way to get copies of the manuals is to get the
fhist.1.13.pdf file from the archive site. This is an
Adobe AcroRead file containing the Reference Manual, which
contains the README file, the BUILDING file and
internationalization notes, as well as all of the manual
pages for all of the commands.
This distribution contains the sources to all of the
documentation for fhist. The author used the GNU groff
package and a postscript printer to prepare the
documentation. If you do not have this software, you will
need to substitute commands appropriate to your site.
If you have the GNU Groff package installed before you run
the configure script, the Makefile will contain
instructions for constructing the documentation. If you
already used the make command, above, this has already
been done. The following command
% make doc
...lots of output...
%
can be used to do this explicitly, if you managed to get
to this point without doing it. Please note that there
may be some warnings from groff, particularly about
missing fonts, particularly for the .txt files; this is
normal.
Once the documents have been formatted, you only need to
print them. The following command
% lpr lib/en/reference.ps
%
will print the English PostScript version of the Reference
Manual. Watch the make output to see what other versions
are available.
COPYRIGHT
version 1.13.D001
Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997,
1998, 1999, 2000, 2001, 2002, 2003 Peter Miller; All
rights reserved.
This program is derived from a work
Copyright (C) 1990 David I. Bell.
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.
AUTHORS
Peter Miller Web: http://www.canb.auug.org.au/~millerp
/\/\* E-Mail: millerp@canb.auug.org.au
David I. Bell Web: http://www.canb.auug.org.au/~dbell
E-Mail: dbell@canb.auug.org.au
Reference Manual FHist Building(FHist)
|