chicken-status.mdoc

.\"  Copyright (c) 2007-2021, The CHICKEN Team
.\"  All rights reserved.
.\"
.\"  Redistribution and use in source and binary forms, with or without
.\"  modification, are permitted provided that the following conditions
.\"  are met:
.\"  1. Redistributions of source code must retain the above copyright
.\"     notice, this list of conditions and the following disclaimer.
.\"  2. Redistributions in binary form must reproduce the above copyright
.\"     notice, this list of conditions and the following disclaimer in the
.\"     documentation and/or other materials provided with the distribution.
.\"  3. The name of the authors may not be used to endorse or promote products
.\"     derived from this software without specific prior written permission.
.\"
.\"  THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
.\"  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\"  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\"  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
.\"  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\"  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\"  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\"  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\"  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\"  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\"
.Dd Apr 23, 2017
.Dt CHICKEN-STATUS 1
.Os
.Sh NAME
.Nm chicken-status
.Nd list information about installed libraries
.Sh SYNOPSIS
.Nm
.Op OPTION ...
.Ar NAME ...
.Sh DESCRIPTION
.Nm
lists information about installed CHICKEN Scheme extension libraries.
.Pp
If
.Ar NAME
is given, information is limited to the specified extension(s).
Otherwise, all extensions are shown.
.Pp
The program accepts following arguments:
.Bl -tag -width Ds
.It Fl h , Fl help
Show usage and exit.
.It Fl version
Show version and exit.
.It Fl c , Fl components
List installed components.
.It Fl f , Fl files
List installed files.
.It Fl list
List installed egg versions in a format suitable for use with
.Xr chicken-install 1 Ns 's
.No Fl override No or Fl from-list No options.
.It Fl match
Treat
.Ar NAME
as a glob pattern.
.It Fl host
When cross-compiling, only show host extensions.
.It Fl target
When cross-compiling, only show target extensions.
.Dq override
format.
.It Fl cached
List eggs that are currently cached.
.El
.Sh ENVIRONMENT
The following environment variables change the behaviour of
.Nm Ns :
.Bl -tag -width CHICKEN_INSTALL_REPOSITORY
.It Ev CHICKEN_INSTALL_REPOSITORY
The path where extension libraries are installed. Defaults to the
package library path selected during configuration
.Pq usually $prefix/lib/chicken/<binary-version> .
.It Ev CHICKEN_REPOSITORY_PATH
One or more directories holding extension libraries. Defaults to the
installation repository.
.It Ev CHICKEN_EGG_CACHE
Location where eggs are retrieved and built.
.El
.Sh FILES
.Bl -tag -width 4n
.It Pa $XDG_CACHE_HOME/chicken-install/
Default directory for cached eggs. (
.Ev $XDG_CACHE_HOME
defaults to
.Pa $HOME/.cache
)
.El
.Sh EXIT STATUS
.Ex -std
.Sh SEE ALSO
.Xr chicken 1 ,
.Xr chicken-install 1 ,
.Xr chicken-uninstall 1
.Pp
More information can be found in the
.Lk http://wiki.call-cc.org/manual/index "CHICKEN User's Manual".
.Sh AUTHORS
.An The CHICKEN Team
.Sh BUGS
Submit bug reports by e-mail to
.Mt chicken-janitors@nongnu.org