usr/src/cmd/guile/guile-tools.1
author Jon Tibble <meths@btinternet.com>
Mon, 04 May 2015 14:04:39 +0100
branchoi_151a
changeset 254 9c2a4ac793f0
parent 11 87960ed158f9
permissions -rw-r--r--
Bash patch catchup including shellshock

'\" t
.\"
.\" Copyright 2010 Sun Microsystems, Inc.  All rights reserved.
.\" Use is subject to license terms.
.\"
.\" ident	"@(#)guile-tools.1	1.2	10/03/16 SMI"
.\"
.\" This man page created by Sun to provide a reference to the
.\" Info format documentation for guile provided with the distribution.
.\"
.TH guile-tools 1 "26 May 2008"
.SH NAME
guile-tools \- displays guile module information 
.SH SYNOPSIS
/usr/bin/guile-tools [OPTION] PROGRAM [ARGS ...]
.SH DESCRIPTION
.LP
'guile-tools' is a wrapper program and installed along w/ `guile'; it 
knows where a particular module is installed and calls it passing its
args to the program. The result is that you need not augment your PATH.  
.LP
Usage is straightforward:
 
      guile-tools --help
      guile-tools --version
      guile-tools [OPTION] PROGRAM [ARGS ...]
.LP 
When Guile is installed, in addition to the `(ice-9 FOO)' modules, a
set of "executable modules" `(scripts BAR)' is also installed.  Each 
is a regular Scheme module that has some additional packaging so 
that it can be called as a program in its own right, from the shell.
For this reason, we sometimes use the term "script" in this context 
to mean the same thing.
.LP
If PROGRAM is "list" or omitted, display contents of scripts dir, 
otherwise PROGRAM is run with ARGS. Options (only one of which may be
used at a time):
.LP
 --scriptsdir DIR - Look in DIR for scripts
 --guileversion VERS - Look in $pkgdatadir/VERS/scripts for scripts
 --source - Display PROGRAM source (ignore ARGS) to stdout
.LP
The modules are self-documenting.  For example, to see the 
documentation for `lint', use one (or both) of the shell commands:
 
        guile-tools display-commentary '(scripts lint)'
        guile-tools --source lint
.SH ATTRIBUTES
See
.BR attributes (5)
for descriptions of the following attributes:
.sp
.TS
box;
cbp-1 | cbp-1
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
=
Availability	library/guile
=
Interface Stability	Uncommitted
.TE
.SH NOTES
Source for guile is available on http://opensolaris.org.