Next: guile-tools prep-Ptexi, Previous: guile-tools module-doc-coverage, Up: Miscellaneous Tools
Usage: module-fan-in [OPTIONS] MODULE
Display all upstream modules of MODULE, one per line.
MODULE can be a filename or a module name (list of symbols).
Normally, modules are displayed starting with the "most close",
with the format:
DISTANCE MODULE-NAME FILENAME
FILENAME can be #f for "unresolvable modules", like `(guile)'
or `(guile-user)', for which a filename does not make sense.
OPTIONS is zero or more of:
-r, --reverse -- start with most remote instead of most close
-d, --no-distance -- omit display of the distance
-m, --no-module-name -- omit display of the module name (list of symbols)
-f, --no-filename -- omit display of the filename
-A, --no-autoloads -- do not follow any autoload edges [default: yes]
-X, --exclude MODULE -- do not follow MODULE
-U, --unresolvable MODULE -- display MODULE (if found) with
filename "#f" but do not follow it
DISTANCE is a number starting with 1 and increasing for every level of
indirection. If a module has multiple distances, only the lowest one
(closest) is shown. The unfollowed modules discerned by --no-autoloads
and --exclude are also omitted from display. The --unresolvable and
--exclude options can be used multiple times. The list of unresolvable
modules initially has two elements: `(guile)' and `(guile-user)'.
Usage from a Scheme Program:
(use-modules (scripts module-fan-in))
(module-fan-in NAMES . OPTIONS) => SEEN
NAMES is a list whose elements are either a module-name (list of symbols)
or a filename (string). SEEN is a list of module-names, each with two
object properties (symbols):
distance -- an integer
filename -- a string
The order of SEEN is farthest (from NAMES) first. OPTIONS is zero or
more items, each of which is either a symbol or a list (KEY VALUE ...).
Recognized symbol options are:
no-autoloads -- corresponds to "--no-autoloads" command-line option
Recognized key/value options are:
(exclude MODULE ...) -- corresponds to "--exclude MODULE"
(unresolvable MODULE ...) -- corresponds to "--unresolvable MODULE"
Each MODULE is a list of symbols, such as: (ice-9 receive).
Symbol or key/value options can be given multiple times.