components/library/guile/files/guile-tools.1

   1 '\" t
   2 .\"
   3 .\" Copyright (c) 2009, 2011, Oracle and/or its affiliates. All rights reserved.
   4 .\"
   5 .\" This man page created by Oracle to provide a reference to the
   6 .\" Info format documentation for guile provided with the distribution.
   7 .\"
   8 .TH guile-tools 1 "26 May 2008"
   9 .SH NAME
  10 guile-tools \- displays guile module information
  11 .SH SYNOPSIS
  12 /usr/bin/guile-tools [OPTION] PROGRAM [ARGS ...]
  13 .SH DESCRIPTION
  14 .LP
  15 'guile-tools' is a wrapper program and installed along w/ `guile'; it
  16 knows where a particular module is installed and calls it passing its
  17 args to the program. The result is that you need not augment your PATH.
  18 .LP
  19 Usage is straightforward:
  20
  21       guile-tools --help
  22       guile-tools --version
  23       guile-tools [OPTION] PROGRAM [ARGS ...]
  24 .LP
  25 When Guile is installed, in addition to the `(ice-9 FOO)' modules, a
  26 set of "executable modules" `(scripts BAR)' is also installed.  Each
  27 is a regular Scheme module that has some additional packaging so
  28 that it can be called as a program in its own right, from the shell.
  29 For this reason, we sometimes use the term "script" in this context
  30 to mean the same thing.
  31 .LP
  32 If PROGRAM is "list" or omitted, display contents of scripts dir,
  33 otherwise PROGRAM is run with ARGS. Options (only one of which may be
  34 used at a time):
  35 .LP
  36  --scriptsdir DIR - Look in DIR for scripts
  37  --guileversion VERS - Look in $pkgdatadir/VERS/scripts for scripts
  38  --source - Display PROGRAM source (ignore ARGS) to stdout
  39 .LP
  40 The modules are self-documenting.  For example, to see the
  41 documentation for `lint', use one (or both) of the shell commands:
  42
  43         guile-tools display-commentary '(scripts lint)'
  44         guile-tools --source lint