~ chicken-core (chicken-5) /chicken-status.mdoc

  1.\"  Copyright (c) 2007-2022, The CHICKEN Team
  2.\"  All rights reserved.
  3.\"
  4.\"  Redistribution and use in source and binary forms, with or without
  5.\"  modification, are permitted provided that the following conditions
  6.\"  are met:
  7.\"  1. Redistributions of source code must retain the above copyright
  8.\"     notice, this list of conditions and the following disclaimer.
  9.\"  2. Redistributions in binary form must reproduce the above copyright
 10.\"     notice, this list of conditions and the following disclaimer in the
 11.\"     documentation and/or other materials provided with the distribution.
 12.\"  3. The name of the authors may not be used to endorse or promote products
 13.\"     derived from this software without specific prior written permission.
 14.\"
 15.\"  THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
 16.\"  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 17.\"  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 18.\"  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 19.\"  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 20.\"  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 21.\"  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 22.\"  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 23.\"  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 24.\"  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 25.\"
 26.\"
 27.Dd Apr 23, 2017
 28.Dt CHICKEN-STATUS 1
 29.Os
 30.Sh NAME
 31.Nm chicken-status
 32.Nd list information about installed libraries
 33.Sh SYNOPSIS
 34.Nm
 35.Op OPTION ...
 36.Ar NAME ...
 37.Sh DESCRIPTION
 38.Nm
 39lists information about installed CHICKEN Scheme extension libraries.
 40.Pp
 41If
 42.Ar NAME
 43is given, information is limited to the specified extension(s).
 44Otherwise, all extensions are shown.
 45.Pp
 46The program accepts following arguments:
 47.Bl -tag -width Ds
 48.It Fl h , Fl help
 49Show usage and exit.
 50.It Fl version
 51Show version and exit.
 52.It Fl c , Fl components
 53List installed components.
 54.It Fl f , Fl files
 55List installed files.
 56.It Fl list
 57List installed egg versions in a format suitable for use with
 58.Xr chicken-install 1 Ns 's
 59.No Fl override No or Fl from-list No options.
 60.It Fl match
 61Treat
 62.Ar NAME
 63as a glob pattern.
 64.It Fl host
 65When cross-compiling, only show host extensions.
 66.It Fl target
 67When cross-compiling, only show target extensions.
 68.Dq override
 69format.
 70.It Fl cached
 71List eggs that are currently cached.
 72.El
 73.Sh ENVIRONMENT
 74The following environment variables change the behaviour of
 75.Nm Ns :
 76.Bl -tag -width CHICKEN_INSTALL_REPOSITORY
 77.It Ev CHICKEN_INSTALL_REPOSITORY
 78The path where extension libraries are installed. Defaults to the
 79package library path selected during configuration
 80.Pq usually $prefix/lib/chicken/<binary-version> .
 81.It Ev CHICKEN_REPOSITORY_PATH
 82One or more directories holding extension libraries. Defaults to the
 83installation repository.
 84.It Ev CHICKEN_EGG_CACHE
 85Location where eggs are retrieved and built.
 86.El
 87.Sh FILES
 88.Bl -tag -width 4n
 89.It Pa $XDG_CACHE_HOME/chicken-install/
 90Default directory for cached eggs. (
 91.Ev $XDG_CACHE_HOME
 92defaults to
 93.Pa $HOME/.cache
 94)
 95.El
 96.Sh EXIT STATUS
 97.Ex -std
 98.Sh SEE ALSO
 99.Xr chicken 1 ,
100.Xr chicken-install 1 ,
101.Xr chicken-uninstall 1
102.Pp
103More information can be found in the
104.Lk http://wiki.call-cc.org/manual/index "CHICKEN User's Manual".
105.Sh AUTHORS
106.An The CHICKEN Team
107.Sh BUGS
108Submit bug reports by e-mail to
109.Mt chicken-janitors@nongnu.org