Building(FHist)                                                Building(FHist)



NNAAMMEE
       fhist - file history and comparison tools
       Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
       2000, 2001, 2002, 2003, 2004, 2005, 2006 Peter Miller; All rights
       reserved.

       Portions of this program are
       Copyright (C) 1990 David I. Bell.

       The _f_h_i_s_t package is distrributed under the terms of the GNU General
       Public License, see the _L_I_C_E_N_S_E section, below, for more information.

SSPPAACCEE RREEQQUUIIRREEMMEENNTTSS
       You will need about 600K to unpack and build the _f_h_i_s_t 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.

BBEEFFOORREE YYOOUU SSTTAARRTT
       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 _f_h_i_s_t 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 _b_e_f_o_r_e 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 _-_-_w_i_t_h_-_g_n_u_-_g_e_t_t_e_x_t option if your
               system has native gettext tools.

       GNU Groff
               The documentation for the _f_h_i_s_t 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.

       Bison   If your operating system does not have a native _y_a_c_c(1) you
               will need to fetch and install GNU Bison in order to build the
               _f_h_i_s_t 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.

SSIITTEE CCOONNFFIIGGUURRAATTIIOONN
       The ffhhiisstt package is configured using the _c_o_n_f_i_g_u_r_e shell script
       included in this distribution.

       The _c_o_n_f_i_g_u_r_e shell script attempts to guess correct values for various
       system-dependent variables used during compilation, and creates the
       _M_a_k_e_f_i_l_e and _c_o_m_m_o_n_/_c_o_n_f_i_g_._h files.  It also creates a shell script
       _c_o_n_f_i_g_._s_t_a_t_u_s that you can run in the future to recreate the current
       configuration.

       Normally, you just _c_d to the directory containing _f_h_i_s_t's source code
       and type
              % ..//ccoonnffiigguurree
              _._._._l_o_t_s _o_f _o_u_t_p_u_t_._._.
              %
       If you're using _c_s_h on an old version of System V, you might need to
       type
              % sshh ccoonnffiigguurree
              _._._._l_o_t_s _o_f _o_u_t_p_u_t_._._.
              %
       instead to prevent _c_s_h from trying to execute _c_o_n_f_i_g_u_r_e itself.

       Running _c_o_n_f_i_g_u_r_e 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 _c_o_n_f_i_g_u_r_e with its standard output redirected to
       _/_d_e_v_/_n_u_l_l; for example,
              % ./configure > /dev/null
              %

       By default, _c_o_n_f_i_g_u_r_e will arrange for the _m_a_k_e _i_n_s_t_a_l_l command to
       install the ffhhiisstt package's files in _/_u_s_r_/_l_o_c_a_l_/_b_i_n and _/_u_s_r_/_l_o_c_a_l_/_m_a_n.
       There are a number of options which control the placement of these
       files.

       --prefix=_P_A_T_H
               You can specify an installation prefix other than _/_u_s_r_/_l_o_c_a_l by
               giving _c_o_n_f_i_g_u_r_e the option --prefix=_P_A_T_H.

       --exec-prefix=_P_A_T_H
               You can specify separate installation prefixes for
               architecture-specific files and architecture-independent files.
               If you give _c_o_n_f_i_g_u_r_e the option --exec-prefix=_P_A_T_H the ffhhiisstt
               package will use _P_A_T_H 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.

       --bindir=_P_A_T_H
               This directory contains executable programs.  On a network,
               this directory may be shared between machines with identical
               hardware and operating systems; it may be mounted read-only.
               Defaults to _$_{_e_x_e_c___p_r_e_f_i_x_}_/_b_i_n unless otherwise specified.

       --datadir=_P_A_T_H
               This directory contains installed data, such as the
               documentation, reports and shell scripts distributed with
               Aegis.  On a network, this directory may be shared between all
               machines; it may be mounted read-only.  Defaults to
               _$_{_p_r_e_f_i_x_}_/_s_h_a_r_e_/_a_e_g_i_s unless otherwise specified.  An ``aegis''
               directory will be appended if there is none in the specified
               path.

       --libdir=_P_A_T_H
               This directory contains installed data, such as the error
               message catalogues.  On a network, this directory may be shared
               between machines with identical hardware and operating systems;
               it may be mounted read-only.  Defaults to
               _$_{_e_x_e_c___p_r_e_f_i_x_}_/_l_i_b_/_a_e_g_i_s unless otherwise specified.  An
               ``aegis'' directory will be appended if there is none in the
               specified path.

       --mandir=_P_A_T_H
               This directory contains the on-line manual entries.  On a
               network, this directory may be shared between all machines; it
               may be mounted read-only.  Defaults to _$_{_p_r_e_f_i_x_}_/_m_a_n unless
               otherwise specified.

       --with-nlsdir=_P_A_T_H
               This directory contains machine specific message catalogues.
               Defaults to --libdir if not set.

       _c_o_n_f_i_g_u_r_e ignores any other arguments that you give it.

       On systems that require unusual options for compilation or linking that
       the _f_h_i_s_t package's _c_o_n_f_i_g_u_r_e script does not know about, you can give
       _c_o_n_f_i_g_u_r_e initial values for variables by setting them in the
       environment.  In Bourne-compatible shells, you can do that on the
       command line like this:
              $ CCCC==''ggcccc --ttrraaddiittiioonnaall'' LLIIBBSS==--llppoossiixx ..//ccoonnffiigguurree
              _._._._l_o_t_s _o_f _o_u_t_p_u_t_._._.
              $
       Here are the _m_a_k_e variables that you might want to override with
       environment variables when running _c_o_n_f_i_g_u_r_e.

       Variable: CC
               C compiler program.  The default is _c_c.

       Variable: INSTALL
               Program to use to install files.  The default is _i_n_s_t_a_l_l if you
               have it, _c_p otherwise.

       Variable: LIBS
               Libraries to link with, in the form -l_f_o_o -l_b_a_r.  The _c_o_n_f_i_g_u_r_e
               script will append to this, rather than replace it.

       Variable: NLSDIR
               This works the same way as the --with-nlsdir option.

       If you need to do unusual things to compile the package, the author
       encourages you to figure out how _c_o_n_f_i_g_u_r_e could check whether to do
       them, and mail diffs or instructions to the author so that they can be
       included in the next release.

BBUUIILLDDIINNGG FFHHIISSTT
       All you should need to do is use the
              % mmaakkee
              _._._._l_o_t_s _o_f _o_u_t_p_u_t_._._.
              %
       command and wait.  When this finishes you should see a directory called
       _b_i_n containing four files: _f_c_o_m_p, _f_h_i_s_t, _f_m_e_r_g_e and _t_x_t_2_c.

       ffccoommpp   The _f_c_o_m_p program is user to compare two text files.

       ffhhiisstt   The _f_h_i_s_t program is used to maintain and edit history of a
               text file.

       ffmmeerrggee  The _f_m_e_r_g_e program is used to merge together edits from two
               descendants of a file.

       ttxxtt22cc   The _t_x_t_2_c program is a utility used to build the _f_h_i_s_t 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
              % mmaakkee cclleeaann
              _._._._l_o_t_s _o_f _o_u_t_p_u_t_._._.
              %
       command.  To remove all of the above files, and also remove the
       _M_a_k_e_f_i_l_e and _c_o_m_m_o_n_/_c_o_n_f_i_g_._h and _c_o_n_f_i_g_._s_t_a_t_u_s files, use the
              % mmaakkee ddiissttcclleeaann
              _._._._l_o_t_s _o_f _o_u_t_p_u_t_._._.
              %
       command.

       The file _e_t_c_/_c_o_n_f_i_g_u_r_e_._i_n is used to create _c_o_n_f_i_g_u_r_e by a GNU program
       called _a_u_t_o_c_o_n_f.  You only need to know this if you want to regenerate
       _c_o_n_f_i_g_u_r_e using a newer version of _a_u_t_o_c_o_n_f.

TTEESSTTIINNGG FFHHIISSTT
       The _f_h_i_s_t package is accompanied by a test suite.  To run this test
       suite, use the following command:
              % mmaakkee ssuurree
              _._._._l_o_t_s _o_f _o_u_t_p_u_t_._._.
              %

       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.

IINNSSTTAALLLLIINNGG FFHHIISSTT
       As explained in the _S_I_T_E _C_O_N_F_I_G_U_R_A_T_I_O_N section, above, the _f_h_i_s_t
       package is installed under the _/_u_s_r_/_l_o_c_a_l tree by default.  Use the
       --prefix=_P_A_T_H option to _c_o_n_f_i_g_u_r_e if you want some other path.

       All that is required to install the _f_h_i_s_t package is to use the
              % mmaakkee iinnssttaallll
              _._._._l_o_t_s _o_f _o_u_t_p_u_t_._._.
              %
       command.  Control of the directories used may be found in the first few
       lines of the _M_a_k_e_f_i_l_e file if you want to bypass the _c_o_n_f_i_g_u_r_e script.

       The above procedure assumes that the _s_o_e_l_i_m(1) command is somewhere in
       the command search _P_A_T_H.  The _s_o_e_l_i_m(1) command is available as part of
       the _G_N_U _R_o_f_f package, mentioned previously in the _P_R_I_N_T_E_D _M_A_N_U_A_L_S
       section.  If you don't have it, but you do have the _c_o_o_k package, then
       a link from _r_o_f_f_p_p to _s_o_e_l_i_m will also work.

       The above procedure also assumes that the _$_(_p_r_e_f_i_x_)_/_m_a_n_/_m_a_n_1 and
       _$_(_p_r_e_f_i_x_)_/_m_a_n_/_m_a_n_5 directories already exist.  If they do not, you will
       need to _m_k_d_i_r them manually.

PPRRIINNTTEEDD MMAANNUUAALLSS
       The easiest way to get copies of the manuals is to get the
       _f_h_i_s_t_._1_._1_6_._p_d_f 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
       _f_h_i_s_t.  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 _b_e_f_o_r_e you run the
       _c_o_n_f_i_g_u_r_e script, the _M_a_k_e_f_i_l_e will contain instructions for
       constructing the documentation.  If you already used the _m_a_k_e command,
       above, this has already been done.  The following command
              %% make doc
              _._._._l_o_t_s _o_f _o_u_t_p_u_t_._._.
              %%
       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 _m_a_k_e output to see what other versions are available.

CCOOPPYYRRIIGGHHTT
        version 1.16.D005
       Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
       2000, 2001, 2002, 2003, 2004, 2005, 2006 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.

AAUUTTHHOORRSS
       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)
