swbuild.8


SYNOPSYS

       sh

       . swbuild [ <package-name> [ export ] ]

       csh

       source swbuild [ <package-name> [ setenv ] ]



DESCRIPTION

       The  swbuild script is meant to be sourced in an interactive shell.  It
       removes most environment variables from the environment and only leaves
       "few standard" ones set.

       This is to avoid having specific environment settings polluting a soft-
       ware build process.

       A number of shell variables are set to make working with a reduced PATH
       more  convenient to the user.  In particular, $swbuild, $swdirs, $swin-
       stall, $swln, $swperms, $swrecord are set to the full path for each  of
       these  files.   If a package name is passed as single argument, it will
       be used to define more variables that may be of use  during  the  build
       process.   If  the export (or setenv) argument is used, then the values
       of these are also used to initialize  the  standard  CPPFLAGS,  CFLAGS,
       CXXFLAGS  and  LDFLAGS  environment  variables  that are typically used
       automatically during the build process.

       Sourcing the swbuild script is meant to be the first step of any  pack-
       age installation.  The other steps are as follows:

       invocation of swdirs
              To  create  the basic directory structure for the software about
              to be installed.  (This is optionally handled by swbuild.)

       invocation of swdeps
              While optional, this step may help in finding  dependencies  for
              the software being installed.

       invocation of swln
              This  is  only  needed if the software about to be installed has
              dependencies on other packages.

       build and installation phase
              These steps are highly specific on the software being setup.

       At this point, you have the choice to either proceed with the remaining
       steps, or simply invoke swinstall which will guide you through them.

       invocation of swshrink
              To create wrappers for any existing "*-config" script

       invocation of swperms
              To change the owner of the installed files.

       test phase
              To  avoid  telling  a user that the setup is done if it is obvi-
              ously broken and doesn't work :-)

       creation of a package specific .swrc file
              This may or may not be needed.

       invocation of swln
              If desired, the newly installed package should be linked in  the
              target directory.


ENVIRONMENT VARIABLES

       swbuild will (optionally) set the following environment variables:


       SWPKG_PATH
              Directory where the swpkg tools live.

       SWPKG_NAME
              Package name.

       SWPKG_SOURCE
              Source directory for packages.

       SWPKG_TARGET
              Target directory.


SEE ALSO

       swconf(8),  swdirs(8), swdeps(8), swinstall(8), swlibs(8), swrecord(8),
       swperms(8), swshrink(8), swln(8).


BUGS

       Some shells may not accept extra arguments when sourcing a file.


AVAILABILITY

       The latest official release of swpkg is available on the web.  The home
       page is http://web.taranis.org/swpkg/


AUTHOR

       Christophe Kalt <swpkg@taranis.org>



                         $Date: 2004/03/09 00:09:39 $               SWBUILD(8)

Man(1) output converted with man2html