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