components/guile/guile-config.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-config 1 "26 May 2008"
   9 .SH NAME
  10 guile-config \- a tool designed to help guile users to get guile
  11  configuration information
  12 .SH SYNOPSIS
  13 /usr/bin/guile-config [OPTIONS]
  14 .SH DESCRIPTION
  15 On most systems, you should not need to tell the compiler and linker
  16 explicitly where they can find `libguile.h' and `libguile'.  When Guile
  17 has been installed in a peculiar way, or when you are on a peculiar
  18 system, things might not be so easy and you might need to pass
  19 additional `-I' or `-L' options to the compiler.  Guile provides the
  20 utility program `guile-config' to help you find the right values for
  21 these options.  You would typically run `guile-config' during the
  22 configuration phase of your program and use the obtained information in
  23 the Makefile.
  24 .SH OPTIONS
  25 .I guile-config link
  26
  27 Print the linker command-line flags necessary to link against libguile, and
  28  any other libraries it requires.
  29
  30 .I guile-config compile
  31
  32 Print C compiler flags for compiling code that uses Guile. This includes
  33 any `-I' flags needed to find Guile's header files.
  34
  35 .I guile-config info [VAR]
  36
  37 Display the value of the Makefile variable VAR used when Guile was built.
  38 If VAR is omitted, display all Makefile variables. Use this command to find
  39 out where Guile was installed, where it will look for Scheme code at run-time,
  40 and so on.
  41
  42 .SH EXAMPLES
  43 You can use guile-config for a Scheme program:
  44 .LP
  45     (use-modules (scripts guile-config))
  46     (guile-config . args)       => string
  47     (guile-config/split . args) => list of strings
  48 .LP
  49 ARGS is one of the "commands" above, such as "info" or "compile",
  50 followed by an additional optional specifier.  Either element of
  51 ARGS can be a symbol or a string.  For example, here are two sets
  52 of equivalent invocations:
  53
  54     (guile-config 'info 'pkgdatadir)
  55     (guile-config 'info "pkgdatadir")
  56     (guile-config "info" 'pkgdatadir)
  57     (guile-config "info" "pkgdatadir")
  58 .LP
  59     (guile-config 'compile)
  60     (guile-config "compile")
  61
  62 These procedures basically capture the output as if guile-config
  63 were invoked as a command from the shell.  The former discards
  64 the final newline.  The latter additionally discards whitespace,
  65 and always returns a list (sometimes of length 1).
  66
  67 Behavior is undefined for null ARGS or unrecognized commands.
  68 .PD