Building(FHist)                                                Building(FHist)



NNAAMMEE
       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.

SSPPAACCEE RREEQQUUIIRREEMMEENNTTSS
       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.

BBEEFFOORREE YYOOUU SSTTAARRTT
       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.

SSIITTEE CCOONNFFIIGGUURRAATTIIOONN
       The ffhhiisstt 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
              % ..//ccoonnffiigguurree
              _._._._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
              % sshh ccoonnffiigguurree
              _._._._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 ffhhiisstt 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 ffhhiisstt
               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:
              $ CCCC==''ggcccc --ttrraaddiittiioonnaall'' LLIIBBSS==--llppoossiixx ..//ccoonnffiigguurree
              _._._._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.

BBUUIILLDDIINNGG FFHHIISSTT
       All you should need to do is use the
              % mmaakkee
              _._._._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.

       ffccoommpp   The _f_c_o_m_p program is user to compare two text files.

       ffhhiisstt   The _f_h_i_s_t program is used to maintain and edit history of a
               text file.

       ffmmeerrggee  The _f_m_e_r_g_e program is used to merge together edits from two
               descendants of a file.

       ttxxtt22cc   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
              % mmaakkee cclleeaann
              _._._._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
              % mmaakkee ddiissttcclleeaann
              _._._._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.

TTEESSTTIINNGG FFHHIISSTT
       The _f_h_i_s_t package is accompanied by a test suite.  To run this test
       suite, use the following command:
              % mmaakkee ssuurree
              _._._._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.

IINNSSTTAALLLLIINNGG FFHHIISSTT
       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
              % mmaakkee iinnssttaallll
              _._._._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.

PPRRIINNTTEEDD MMAANNUUAALLSS
       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.

CCOOPPYYRRIIGGHHTT
        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.

AAUUTTHHOORRSS
       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)
