                   penv - the persistent environment utility

  Peter Pentchev

   $Ringlet: c/misc/penv/doc/en_US.ISO8859-1/articles/penv/penv.sgml,v 1.4
   2002/03/22 07:50:36 roam Exp $

   This article describes the goals, usage and development history of penv, a
   utility to manage persistent per-directory environment settings.

     ----------------------------------------------------------------------

                        3. Building and installing penv

   The two main ways to install penv are building it from source and from a
   FreeBSD port.

     ----------------------------------------------------------------------

3.1. Installing penv from a FreeBSD port

   A FreeBSD port of penv is available at
   http://devel.ringlet.net/sysutils/penv/penv-1.2p1.shar, as well as in
   the FreeBSD Ports Collection as sysutils/penv.

     ----------------------------------------------------------------------

3.2. Building and installing penv from source

   To install penv from its source distribution, follow this procedure:

    1. Acquire the source distribution

       The penv source distribution may be obtained from its home page,
       http://devel.ringlet.net/sysutils/penv/. The current version of penv
       is 1.2pre2; a source tarball may be obtained directly from
       http://devel.ringlet.net/sysutils/penv/penv-1.2p1.tar.gz.

       Another way to acquire the penv source distribution would be to access
       Ringlet's CVS repository and check out the penv module. However, for
       the present, the Ringlet CVS repository is not available online for
       anonymous access.

    2. Unpack the penv source

       If you have fetched the penv tar/gzip source archive, you will need to
       unpack it using the command:

     % tar -zxf /path/to/penv-1.2p1.tar.gz

    3. Configure the penv build settings

       This and the following steps should be performed from within the penv
       source directory. If you have obtained the penv sources via CVS, this
       directory would be named simply penv/. If you have obtained a tar/gzip
       source archive, the directory will be named penv-1.2p1/.

       Edit the appropriate Makefile for your system. If you are on a
       GNU/Linux system, or you are using GNU make on some other system, you
       need to edit the GNUmakefile. If you are using a BSD version of make
       or the pmake portable version, you need to edit the Makefile.

       There are two build-time configuration options that you may enable by
       uncommenting the lines that add them to the CFLAGS_COMPAT make
       variable:

          * HAVE_STRLCPY

            Use this if your C library (libc) provides a strlcpy(3) function.
            Most BSD-derived operating systems do.

          * HAVE_FGETLN

            Use this if your C library (libc) provides a fgetln(3) function.
            Most BSD-derived operating systems do.

    4. Build penv

       Once the configuration step is complete, it is time for the actual
       penv build. All you need to do is issue the following command:

     % make

    5. Install penv

       We are almost there! :) penv has been successfully built, now all you
       need is to install it. Just like with many other programs, this is
       done with the following command:

     # make install

         Note: You may need to obtain root privileges to install penv in a
         location outside your home directory or the system /tmp directory.

   And that is all there is to it! :)

     ----------------------------------------------------------------------

  This, and other documents, can be downloaded from http://devel.ringlet.net/.

       For questions about this documentation, e-mail <roam@ringlet.net>.
