.TH USE 1 "$Date: 2005/12/11 16:42:09 $" "Usepackage" "User Commands"
.SH NAME
use \- Frontend to the
.I Usepackage
Environment Manager
.SH SYNOPSIS
.TP
.I csh and derivatives:
 source @pkgdatadir@/use.csh
.TP
.I bourne shell and derivatives:
 source @pkgdatadir@/use.bsh
.TP
.I korn shell:
 . @pkgdatadir@/use.ksh
.PP
.B use
[\-vs] [\-f
.IR file ]
.I package ...
.PP
.B use
\-l
.SH DESCRIPTION
.I Usepackage
is an environment management program. It is based on the principle of
.I packages
\- collections of executables that share a common set of necessary
environment variables, such as PATH, MANPATH or LD_LIBRARY_PATH.
.PP
For each given
.IR package ,
.B use
sources the appropriate environment information into the current shell.
The environment information is specified in a configuration file, see
.IR usepackage(1) .
.SS OPTIONS
.TP
.I \-v
Output verbose information to the standard error stream.
.TP
.I \-s
Silence warnings for un-matched packages. This is useful in a shell
.I rc
script when a package is known not to be available on all architectures that 
the shell is used on.
.TP
.I \-f file
Specify an alternate initial configuration file.
.TP
.I \-l
List available packages and groups.
.SH FILES
.TP 15
.SB @pkgdatadir@/usepackage.conf
The default configuration file.
.TP
.SB @pkgdatadir@/use.csh
Shell setup for csh and derivatives.
.TP
.SB @pkgdatadir@/use.bsh
Shell setup for bourne shell and derivatives.
.TP
.SB @pkgdatadir@/use.ksh
Shell setup for ksh.
.TP
.SB @bindir@/usepackage
The underlying
.I Usepackage
executable.
.SH ENVIRONMENT
Other than the reading and re-definition of environment variables for package 
setup,
.B use
also uses the following environment variables for user configuration:
.TP 15
.SB PACKAGES_PATH
Colon-separated path list giving the directories to search for configuration
files. Shell-style tilde (~) user-directory escapes are expanded.
.TP
.SB HOME
If present in the environment, this is used to provide the expansion for
the tilde (~) user-directory.
.TP
.SB SHELL
If present in the environment, the last path component of this is used for
shell matching (see
.IR SYNTAX )
and detecting the style of environment output that should be used, see
.IR usepackage(1) .
.SH COPYRIGHT
.nf
Usepackage Environment Manager
Copyright (C) 1995-2005  Jonathan Hogg
.fi
.PP
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.
.PP
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.
.PP
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-1307  USA
.SH SEE ALSO
usepackage(1), csh(1), sh(1), ksh(1)

