components/guile/guile-tools.1
author Kevin Crowe <Kevin.Crowe@oracle.com>
Fri, 08 Apr 2011 07:40:32 -0700
changeset 173 69315e61a221
child 181 87e11e685b1f
permissions -rw-r--r--
7034838 migrate guile to userland
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
173
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
     1
'\" t
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
     2
.\"
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
     3
.\" Copyright (c) 2009, 2011, Oracle and/or its affiliates. All rights reserved.
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
     4
.\"
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
     5
.\" This man page created by Oracle to provide a reference to the
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
     6
.\" Info format documentation for guile provided with the distribution.
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
     7
.\"
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
     8
.TH guile-tools 1 "26 May 2008"
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
     9
.SH NAME
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    10
guile-tools \- displays guile module information 
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    11
.SH SYNOPSIS
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    12
/usr/bin/guile-tools [OPTION] PROGRAM [ARGS ...]
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    13
.SH DESCRIPTION
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    14
.LP
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    15
'guile-tools' is a wrapper program and installed along w/ `guile'; it 
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    16
knows where a particular module is installed and calls it passing its
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    17
args to the program. The result is that you need not augment your PATH.  
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    18
.LP
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    19
Usage is straightforward:
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    20
 
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    21
      guile-tools --help
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    22
      guile-tools --version
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    23
      guile-tools [OPTION] PROGRAM [ARGS ...]
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    24
.LP 
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    25
When Guile is installed, in addition to the `(ice-9 FOO)' modules, a
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    26
set of "executable modules" `(scripts BAR)' is also installed.  Each 
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    27
is a regular Scheme module that has some additional packaging so 
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    28
that it can be called as a program in its own right, from the shell.
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    29
For this reason, we sometimes use the term "script" in this context 
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    30
to mean the same thing.
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    31
.LP
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    32
If PROGRAM is "list" or omitted, display contents of scripts dir, 
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    33
otherwise PROGRAM is run with ARGS. Options (only one of which may be
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    34
used at a time):
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    35
.LP
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    36
 --scriptsdir DIR - Look in DIR for scripts
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    37
 --guileversion VERS - Look in $pkgdatadir/VERS/scripts for scripts
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    38
 --source - Display PROGRAM source (ignore ARGS) to stdout
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    39
.LP
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    40
The modules are self-documenting.  For example, to see the 
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    41
documentation for `lint', use one (or both) of the shell commands:
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    42
 
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    43
        guile-tools display-commentary '(scripts lint)'
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    44
        guile-tools --source lint
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    45
.SH ATTRIBUTES
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    46
See
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    47
.BR attributes (5)
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    48
for descriptions of the following attributes:
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    49
.sp
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    50
.TS
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    51
box;
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    52
cbp-1 | cbp-1
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    53
l | l .
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    54
ATTRIBUTE TYPE	ATTRIBUTE VALUE
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    55
=
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    56
Availability	library/guile
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    57
=
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    58
Interface Stability	Uncommitted
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    59
.TE
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    60
.SH NOTES
69315e61a221 7034838 migrate guile to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    61
Source for guile is available on http://opensolaris.org.