Missing and out-of-date information in guile.1, the Guile man page

Missing and out-of-date information in guile.1, the Guile man page

[Mark Harig]

Looking at the latest revision pulled from the git repository:

1) The manual page does not document the '-q' command-line option.

2) The manual page includes the text:

     "There is also a tutorial (info guile-tut) available."

     It appears that the Guile tutorial is no longer available as a
    separate Info manual, so this text should be deleted.

3) Should the manual page include some information about the
     environment variable 'LD_LIBRARY_PATH' in the ENVIRONMENT
     section, or is this considered to be an O/S-dependent variable?

-

Re: Missing and out-of-date information in guile.1, the Guile man page

[Neil Jerram]

Mark Harig <idirectscm@aim.com> writes:

> Looking at the latest revision pulled from the git repository:
>
> 1) The manual page does not document the '-q' command-line option.
>
> 2) The manual page includes the text:
>
>      "There is also a tutorial (info guile-tut) available."
>
>      It appears that the Guile tutorial is no longer available as a
>     separate Info manual, so this text should be deleted.

Thanks, I'll fix these.

> 3) Should the manual page include some information about the
>      environment variable 'LD_LIBRARY_PATH' in the ENVIRONMENT
>      section, or is this considered to be an O/S-dependent variable?

I'd say too OS-dependent; or more to do with how guile should be
properly installed, than how to use it once it is installed.

But on the other hand, I might be misunderstanding what you had in mind;
if you'd like to propose some specific text...

Thanks,
        Neil

Re: Missing and out-of-date information in guile.1, the Guile man page

[Mark Harig]

>
> I'd say too OS-dependent; or more to do with how guile should be
> properly installed, than how to use it once it is installed.
>
> But on the other hand, I might be misunderstanding what you had in 
mind;
> if you'd like to propose some specific text...
>

If a user has followed the instructions in the section "Obtaining and
Installing Guile", and installed guile in the "/usr/local/" directory
tree, then, on systems that use the dynamic linker/loader ld.so or
ld-linux.so*, the instructions in the section "Linking Guile into
Programs" will fail because the new program 'simple-guile' will not be
able to locate the shared library 'libguile-2.0.so*'.

Here is some suggested text for the ENVIRONMENT and SEE ALSO sections
of the guile.1 manual page:

ENVIRONMENT
   LD_LIBRARY_PATH
       This variable may need to be set on operating systems that use
       the dynamic linker/loader ld.so/ld-linux.so* to specify where
       the shared libraries that are provided by Guile can be found.
       The variable should provide a colon-separated list of
       directories.

       For example, in the bash shell the following assignment may be
       used:

          export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH

       More information about this variable can be found in the
       documentation for the dynamic linker/loader (ld.so(8) or
       ld-linux.so(8)).

SEE ALSO
       ld.so(8), ld-linux.so(8)


Another item of information that would be useful to add to the guile.1
manual page would be the date and version of Guile that the manual
page describes.  For example, the Emacs manual page lists the date
that it is effective and the version.  This appears at the bottom of
the manual page, even though the directive describing it appears at
the top of emacs.1:

.TH EMACS 1 "2007 April 13" "GNU Emacs 23.2"

Likewise, Guile might have:

.TH GUILE 1 "2011 Jan 16" "GNU Guile 2.0"

--

Re: Missing and out-of-date information in guile.1, the Guile man page

[Ken Raeburn]

On Jan 16, 2011, at 14:38, Mark Harig wrote:
>> 
>> I'd say too OS-dependent; or more to do with how guile should be
>> properly installed, than how to use it once it is installed.
>> 
>> But on the other hand, I might be misunderstanding what you had in 
> mind;
>> if you'd like to propose some specific text...
>> 
> 
> If a user has followed the instructions in the section "Obtaining and
> Installing Guile", and installed guile in the "/usr/local/" directory
> tree, then, on systems that use the dynamic linker/loader ld.so or
> ld-linux.so*, the instructions in the section "Linking Guile into
> Programs" will fail because the new program 'simple-guile' will not be
> able to locate the shared library 'libguile-2.0.so*'.

I think the right answer for that is not to tell people that they have to set environment variables in order to run Guile programs, but to tell developers how to link programs properly so that they find the library at run time.  This tends to be somewhat platform-dependent, but often arguments like "-R" or "-rpath" are needed; libtool should just Do The Right Thing, if it's used.  I'm less familiar with pkg-config, but expect it should be have similarly.  In fact, the man page for pkg-config on my system (Mac OS X with MacPorts installed) says the "--libs-only-L" option "prints the -L/-R part" of the link options, which suggests to me that pkg-config is indeed supposed to be printing options to set the run-time load path.  If it's not doing that for you, then we should figure out why not.

In short, don't document how to work around a bug, if you can just fix the bug. :-)

Ken

Re: Missing and out-of-date information in guile.1, the Guile man page

[Mark Harig]

On Wed, Jan 19, 2011 at 02:50:29PM -0500, Ken Raeburn wrote:

>
> I think the right answer for that is not to tell people that they
> have to set environment variables in order to run Guile programs,
> but to tell developers how to link programs properly so that they
> find the library at run time.  This tends to be somewhat
> platform-dependent, but often arguments like "-R" or "-rpath" are
> needed; libtool should just Do The Right Thing, if it's used.  I'm
> less familiar with pkg-config, but expect it should be have
> similarly.  In fact, the man page for pkg-config on my system (Mac
> OS X with MacPorts installed) says the "--libs-only-L" option
> "prints the -L/-R part" of the link options, which suggests to me
> that pkg-config is indeed supposed to be printing options to set the
> run-time load path.  If it's not doing that for you, then we should
> figure out why not.
>
> In short, don't document how to work around a bug, if you can just
> fix the bug. :-)
>

OK.  Whichever approach is taken, readers of the Guile Reference
Manual should be able to follow the steps described and have those
steps work, that is, the generated program should run.  My aim is to
help get Guile 2.0 have as few defects as possible before it is
released so that when new users try it, they have an error-free first
pass.

Re: Missing and out-of-date information in guile.1, the Guile man page

[Andy Wingo]

On Wed 19 Jan 2011 20:50, Ken Raeburn <raeburn@raeburn.org> writes:

> In short, don't document how to work around a bug, if you can just fix
> the bug. :-)

Very much agreed.  Writing documentation is hard enough without having
to document bugs in addition to features :)

Andy
-- 
http://wingolog.org/

Re: Missing and out-of-date information in guile.1, the Guile man page

[Mark Harig]

On Sat, Jan 15, 2011 at 08:48:58PM +0000, Neil Jerram wrote:
>
> > 3) Should the manual page include some information about the
> >      environment variable 'LD_LIBRARY_PATH' in the ENVIRONMENT
> >      section, or is this considered to be an O/S-dependent variable?
>
> I'd say too OS-dependent; or more to do with how guile should be
> properly installed, than how to use it once it is installed.
>
> But on the other hand, I might be misunderstanding what you had in 
mind;
> if you'd like to propose some specific text...
>

Related:

  - There is no description in the Guile manual page,
    guile.1, or the Guile Reference Manual, guile.info*, of
    the environment variable GUILE_AUTO_COMPILE.

  - The reference manual also briefly mentions the
    environment variable GUILE_HISTORY (it describes the
    default value as `.guile_history', but does not mention
    its default location, presumably $HOME, correct?), but
    the manual page does not mention it.

  - Is there an environment variable that can specify the
    name of the Guile initialization file (default: .guile)?

  - Are there any other environment variables that are not
    documented in the Guile Reference Manual?

  - For comparison, the Emacs manual includes a section
    describing the environment variables that may effect it
    when it is invoked.  See the Info node "(emacs)
    Environment" (a subsection of the appendix "Invoking
    Emacs").

--

Re: Missing and out-of-date information in guile.1, the Guile man page

[Andy Wingo]

[-- Attachment #1: Type: text/plain, Size: 1577 bytes --]

Hi Mark,

I updated the man page.  I don't really know groff though, so please reply
with comments (text appended).

On Mon 17 Jan 2011 00:23, Mark Harig <idirectscm@aim.com> writes:

>  - There is no description in the Guile manual page,
>    guile.1, or the Guile Reference Manual, guile.info*, of
>    the environment variable GUILE_AUTO_COMPILE.

I think that's OK to not have it in the man page, though it should be in
the manual.  

>  - The reference manual also briefly mentions the
>    environment variable GUILE_HISTORY (it describes the
>    default value as `.guile_history', but does not mention
>    its default location, presumably $HOME, correct?), but
>    the manual page does not mention it.

Yes, it does put it in $HOME, though argually it should go in .local or
.cache or something.  

I'm also OK with the man page not mentioning this, FWIW.

>  - Is there an environment variable that can specify the
>    name of the Guile initialization file (default: .guile)?

Nope.  You can use -q and -l though.

>  - Are there any other environment variables that are not
>    documented in the Guile Reference Manual?

Yes.  Would you like to submit a patch documenting them?  Feel free to
ask on the list about what they mean, if the meanings are not clear :)

>  - For comparison, the Emacs manual includes a section
>    describing the environment variables that may effect it
>    when it is invoked.  See the Info node "(emacs)
>    Environment" (a subsection of the appendix "Invoking
>    Emacs").

Would be good to add to Guile as well.

Cheers,

Andy


[-- Attachment #2: guile.1 --]
[-- Type: application/x-troff-man, Size: 5408 bytes --]

Re: Missing and out-of-date information in guile.1, the Guile man page

[Mark Harig]

[-- Attachment #1: Type: text/plain, Size: 3066 bytes --]

On Mon, Jan 24, 2011 at 10:54:56PM +0100, Andy Wingo wrote:
>
> I updated the man page.  I don't really know groff though, so please 
reply
> with comments (text appended).
>

Thank you for the updated version.

I have written a patch to this updated version.  Please find
it attached.  It includes the following:

1. I added the current month and year, Guile version
descriptive text, and the text GNU to the title.  This
matches what is found in other GNU programs, for example,
Emacs and coreutils.  The new text appears in at the top and
the bottom (final line) of the manual page.  This should be
useful for other people when they check the manual page to
know when it was written and for what version of Guile.

2. I followed the formatting that 'man' describes for the
synopsis, namely:

       bold text          type exactly as shown.
       italic text        replace with appropriate argument.
       [-abc]             any or all arguments within [ ] are optional.
        -a|-b              options delimited by | cannot be used 
together.
       argument ...       argument is repeatable.
       [expression] ...   entire expression within [ ] is repeatable.

The options are now in bold text and their arguments are in
italic, which will appear as underlining for those
environments that don't have italics.  So, for example,

   -L [DIRECTORY]

has '-L' in bold, the brackets in normal font, and DIRECTORY
in italic (or underlined) text.  This helps to make it clear
which text is fixed and which needs to be entered by the
user.  Previously, all text was bold.

3. I made similar changes in formatting in the OPTIONS
section so that the reader can easily see which text needs
to be typed exactly and which is user-defined.

4. I corrected grammar, spelling, and capitalization (for
example, 'scheme' to 'Scheme').

5. Vertical white-space was non-standard (two lines between
some sections, one space between others).  I changed this to
the standard one empty line before each section heading.  I
added dots (a single period on a line) before every section
heading (.SH) so that maintainers will still find the
readability unchanged.

6. 'groff' recommends starting every sentence on its own
line, and breaking sentences at punctuation.  I added this
white space to many sentences.

7. Corrected an error in the info command:
     info "guile(Invoking Guile)"
   won't work.  It should be:
     info "(guile)Invoking Guile"

8. Compared the options list with the list generated by
'guile --help', and added the missing option '--no-debug',
and the short switches '-h' and '-v'.

9. The new version of the manual page added a description of
the environment variable GUILE_LOAD_COMPILED_PATH.  That
description referenced the guile variable %load-path.  I
changed that to %load-compiled-path.

10. Updated the copyright to include 2011.

In general, with this patch the manual page should look more
like other GNU manual pages, for example:

   man man
   man test

--

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: guile.1.patch --]
[-- Type: text/x-patch; name="guile.1.patch", Size: 10334 bytes --]

diff --git a/doc/guile.1 b/doc/guile.1
index 571638d..f892a7b 100644
--- a/doc/guile.1
+++ b/doc/guile.1
@@ -3,113 +3,210 @@
 .\" Process this file with
 .\" groff -man -Tascii foo.1
 .\"
-.TH GUILE 1
+.TH GUILE 1 "January 2011" "GNU Guile 2.0" GNU
+.
 .SH NAME
 guile \- the GNU extension language
+.
 .SH SYNOPSIS
-.B guile [-L DIRECTORY] [-l FILE] [-e FUNCTION] [\\\\]
-.B [-c EXPR] [-s SCRIPT] [--] [SCRIPT] [ARG...]
+.B guile
+.RB [\| \-L
+.IR DIRECTORY \|]
+.RB [\| \-l
+.IR FILE \|]
+.RB [\| \-e
+.IR FUNCTION \|]
+.\".RI [\| \\\\ \|]
+.RB [\| \e \|]
+.RB [\| \-c
+.IR EXPR \|]
+.RB [\| \-s
+.IR SCRIPT \|]
+.RB [\| \-\- \|]
+.RI [\| SCRIPT \|]
+.RI [\| SCRIPT's\ ARGs... \|]
 
-Only the most useful options are listed here; see below for the
-remainder.
+Only the most useful options are listed here; 
+see below for the remainder.
+.
 .SH DESCRIPTION
-GNU Guile is an implemention of the Scheme programming language.  It
-extends the R5RS and R6RS language standards, providing additional
-features necessary for real-world use.  Guile works well for interactive
-use, basic scripting, and extension of larger applications, as well as
-for stand-alone Scheme application development.
+GNU Guile is an implementation of the Scheme programming language.
+It extends the R5RS and R6RS language standards,
+providing additional features necessary for real-world use.
+
+Guile works well for interactive use,
+basic scripting,
+and extension of larger applications,
+as well as for stand-alone Scheme application development.
 
 The
 .B guile
 executable itself provides a stand-alone interactive compiler and
-run-time for Scheme programs, both for interactive use and for executing
-Scheme scripts or programs.
+run-time for Scheme programs,
+both for interactive use and for executing Scheme scripts or programs.
 
 This manual page provides only brief instruction in invoking
 .B guile
-from the command line.  Please consult the guile info documentation
+from the command line.
+Please consult the Guile info documentation
 (type 
-.B info "guile(Invoking Guile)"
+.B info "(guile) Invoking Guile"
 at a command prompt) for more information.
-
+.
 .SH OPTIONS
-.IP -L DIRECTORY
-Add DIRECTORY to the front of Guile's module load path.
-.IP -l FILE
-Load scheme source code from file.
-.IP -e FUNCTION
-After reading script, apply FUNCTION to command-line arguments.  Note
-that FUNCTION is evaluated, so e.g.
+.TP
+.BI -L \ DIRECTORY
+Add \fIDIRECTORY\fR to the front of Guile's module load path.
+.
+.TP
+.BI -l \ FILE
+Load Scheme source code from \fIFILE\fR.
+.
+.TP
+.BI -e \ FUNCTION
+After reading \fISCRIPT\fR, apply \fIFUNCTION\fR to command-line arguments.
+Note that \fIFUNCTION\fR is evaluated,
+so, for example,
 .B (@ (my-module) my-proc)
 is valid here.
-.IP \\\\
+.
+.TP
+.B \e
 The "meta switch", used to work around limitations in #! scripts.
-See "The Meta Switch" in the texinfo documentation, for more details.
-.IP --
-Stop argument processing, start guile in interactive mode.
-.IP -c EXPR
-Stop argument processing, evaluate EXPR as a scheme expression.
-.IP -s SCRIPT-FILE
-Load Scheme source from SCRIPT-FILE and execute as a script.  Note that
-the in many cases it is not necessary to use -s; one may invoke Guile
-just as
-.B guile SCRIPT-FILE ARG...
-.IP -ds
-Do -s SCRIPT at this point.  Note that this argument must be used in
-conjuction with -s.
-.IP --debug
-Start guile with the debugging VM.  By default, on when invoked
-interactively, off otherwise.
-.IP --autocompile
+See "The Meta Switch" in the texinfo documentation for more details.
+.
+.TP
+.B --
+Stop argument processing, and start
+.B guile
+in interactive mode.
+.
+.TP
+.BI -c \ EXPR
+Stop argument processing,
+and evaluate \fIEXPR\fR as a Scheme expression.
+.
+.TP
+.BI -s \ SCRIPT-FILE
+Load Scheme source from \fISCRIPT-FILE\fR and execute as a script.
+Note that in many cases it is not necessary to use \fB-s\fR;
+one may invoke
+.B guile
+simply as
+.B guile
+.I SCRIPT-FILE ARG...
+.
+.TP
+.B -ds
+Carry out \fB\-s \fISCRIPT\fR at this point in the option sequence.
+Note that this argument must be used in conjunction with \fB\-s\fR.
+.
+.TP
+.B --debug
+Start
+.B guile
+with the debugging VM.
+By default, debugging is on when
+.B guile
+is invoked interactively;
+it is off otherwise.
+.
+.TP
+.B --no-debug
+Start
+.B guile
+without the debugging VM,
+even if 
+.B guile
+is being run interactively.
+.
+.TP
+.B --autocompile
 Compile source files automatically (default behavior).
-.IP --no-autocompile
+.
+.TP
+.B --no-autocompile
 Disable automatic source file compilation.
-.IP --listen[=P]
-Listen on a port or socket for remote REPL connections.  See the manual
-for more details.
-.IP --use-srfi=N,M...
-Load SRFI extensions N, M, etc. For example, "--use-srfi=8,13".
-.IP -x EXTENSION
-Add EXTENSION to the Guile's load extension list.
-.IP --help 
-Describe command line options and exit
-.IP --version
+.
+.TP
+\fB\-\-listen\fR[=\fIP\fR]
+Listen on a port or socket for remote REPL connections.
+See the manual for more details.
+.
+.TP
+\fB\-\-use\-srfi\fR=\fIN,M\fR...
+Load SRFI extensions \fIN\fR, \fIM\fR, etc.
+For example, 
+\fB \-\-use\-srfi\fR=\fI8,13\fR.
+.
+.TP
+.BI -x \ EXTENSION
+Add \fIEXTENSION\fR to the
+.B guile
+load extension list.
+.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Describe command-line options and exit.
+.
+.TP
+\fB\-v\fR, \fB\-\-version\fR
 Display guile version and exit.
-.IP -q
-In interactive mode, suppress loading the user's ~/.guile file.
-
+.
+.TP
+.B -q
+In interactive mode,
+suppress loading the user's initialization file,
+.I ~/.guile.
+.
 .SH ENVIRONMENT
 .\".TP \w'MANROFFSEQ\ \ 'u
 .TP
 .B GUILE_LOAD_PATH
 If
 .RB $ GUILE_LOAD_PATH
-is set, its value is used to agument the path to search for scheme
-files when loading.  It should be a colon separated list of
-directories which will be prepended to the default %load-path.
-
+is set before 
+.B guile
+is started,
+its value is used to augment the path to search for Scheme files when
+loading.
+It should be a colon-separated list of directories,
+which will be prefixed to the default
+.B %load-path.
+.TP
 .B GUILE_LOAD_COMPILED_PATH
 If
 .RB $ GUILE_LOAD_COMPILED_PATH
-is set, its value is used to agument the path to search for compiled
-Scheme files (.go files) when loading.  It should be a colon separated
-list of directories which will be prepended to the default %load-path.
-
+is set before
+.B guile
+is started,
+its value is used to augment the path to search for compiled
+Scheme files (.go files) when loading.
+It should be a colon-separated list of directories,
+which will be prefixed to the default
+.B %load-compiled-path.
+.
 .SH FILES
+.TP
 .I ~/.guile
-is a guile script that is executed before any other processing occurs.
-For example, the following .guile activates guile's readline
-interface:
+A Guile script that is executed before any other processing occurs.
+For example, the following
+.I .guile
+activates guile's readline interface:
 
-.RS 4
-(use-modules (ice-9 readline))
+.RS 9
+.B (use-modules (ice-9 readline))
 .RS 0
-(activate-readline)
-
+.B (activate-readline)
+.
 .SH "SEE ALSO"
-The full documentation for guile is maintained as a Texinfo manual.  If
-the info and guile programs are properly installed at your site, the
-command
+The full documentation for Guile is maintained as a Texinfo manual.
+If the
+.B info
+and
+.B guile
+programs are properly installed at your site,
+the command
 .IP
 .B info guile
 .PP
@@ -117,39 +214,45 @@ should give you access to the complete manual.
 
 http://www.schemers.org provides a general introduction to the
 Scheme language.
-
+.
 .SH "REPORTING BUGS"
-There is a mailing list, bug-guile@gnu.org, for reporting Guile bugs and
-fixes.  But before reporting something as a bug, please try to be sure
-that it really is a bug, not a misunderstanding or a deliberate feature.
+There is a mailing list,
+bug-guile@gnu.org,
+for reporting Guile bugs and fixes.
+But before reporting something as a bug,
+please try to be sure that it really is a bug,
+not a misunderstanding or a deliberate feature.
 We ask you to read the section ``Reporting Bugs'' in the Guile reference
-manual (or Info system) for hints on how and when to report bugs.  Also,
-include the version number of the Guile you are running in every bug
-report that you send in.  Bugs tend actually to be fixed if they can be
-isolated, so it is in your interest to report them in such a way that
-they can be easily reproduced.
-
+manual (or Info system) for hints on how and when to report bugs.
+Also, include the version number of the Guile you are running in every bug
+report that you send in.
+Bugs tend actually to be fixed if they can be isolated,
+so it is in your interest to report them in such a way that they can be
+easily reproduced.
+.
 .SH COPYING
-Copyright (C) 2010 Free Software Foundation, Inc.
+Copyright (C) 2010, 2011 Free Software Foundation, Inc.
 
 Permission is granted to make and distribute verbatim copies of this
 document provided the copyright notice and this permission notice are
 preserved on all copies.
 
 Permission is granted to copy and distribute modified versions of this
-document under the conditions for verbatim copying, provided that the
-entire resulting derived work is distributed under the terms of a
-permission notice identical to this one.
+document under the conditions for verbatim copying,
+provided that the entire resulting derived work is distributed under the
+terms of a permission notice identical to this one.
 
 Permission is granted to copy and distribute translations of this
-document into another language, under the above conditions for modified
-versions, except that this permission notice may be stated in a
+document into another language,
+under the above conditions for modified versions,
+except that this permission notice may be stated in a
 translation approved by the Free Software Foundation.
-
+.
 .SH AUTHORS
 Robert Merkel <rgmerk@mira.net> wrote this manpage.  
 Rob Browning <rlb@cs.utexas.edu> has added to it.
 
 .B guile 
-is GNU software.  Guile is originally based on Aubrey Jaffer's
-SCM interpreter, and is the work of many individuals.
+is GNU software.
+Guile is originally based on Aubrey Jaffer's SCM interpreter,
+and is the work of many individuals.

Re: Missing and out-of-date information in guile.1, the Guile man page

[Andy Wingo]

On Tue 25 Jan 2011 08:05, Mark Harig <idirectscm@aim.com> writes:

> On Mon, Jan 24, 2011 at 10:54:56PM +0100, Andy Wingo wrote:
>>
>> I updated the man page.  I don't really know groff though, so please 
> reply
>> with comments (text appended).
>>
>
> Thank you for the updated version.
>
> I have written a patch to this updated version.  Please find
> it attached.

Super, thanks!

Can you attach it in git-format-patch format?  That way when I apply it
we get your commit log and your name on the commit.

Thanks,

Andy
-- 
http://wingolog.org/

Re: Missing and out-of-date information in guile.1, the Guile man page

[Andy Wingo]

Hi Mark,

On Sat 05 Mar 2011 01:45, Mark Harig <idirectscm@aim.com> writes:

> On Fri, Mar 04, 2011 at 10:35:50AM +0100, Andy Wingo wrote:
>> On Tue 25 Jan 2011 08:05, Mark Harig <idirectscm@aim.com> writes:
>>
>> > On Mon, Jan 24, 2011 at 10:54:56PM +0100, Andy Wingo wrote:
>> >>
>> >> I updated the man page.  I don't really know groff
>> >> though, so please reply with comments (text appended).
>> >>
>> >
>> > Thank you for the updated version.
>> >
>> > I have written a patch to this updated version.  Please find
>> > it attached.
>>
>> Super, thanks!
>>
>> Can you attach it in git-format-patch format?  That way when I apply 
> it
>> we get your commit log and your name on the commit.
>>
>
> Done.  Please find attached a plain-text patch file for
> doc/guile.1 generated from the command:

Applied.  Thank you!

Andy
-- 
http://wingolog.org/

Re: Missing and out-of-date information in guile.1, the Guile man page

[Andy Wingo]

Hi Mark,

On Thu 13 Jan 2011 22:58, Mark Harig <idirectscm@aim.com> writes:

> 3) Should the manual page include some information about the
>      environment variable 'LD_LIBRARY_PATH' in the ENVIRONMENT
>      section, or is this considered to be an O/S-dependent variable?

I think we fixed this in the 1.9 series, in commits
eb350124a85dd4daf39bacbdc50452ef87a33a43 and
28af5ee5eccb7797b73ad1caf88183e95eef0a28.  Is there something that is
not working for you with 1.9.14, or are you working off of 1.8?

Andy
-- 
http://wingolog.org/

Re: Missing and out-of-date information in guile.1, the Guile man page

[Mark Harig]

 On Mon, Jan 24, 2011 at 10:06:20PM +0100, Andy Wingo wrote:
>
> On Thu 13 Jan 2011 22:58, Mark Harig writes:
>
> > 3) Should the manual page include some information about the
> >      environment variable 'LD_LIBRARY_PATH' in the ENVIRONMENT
> >      section, or is this considered to be an O/S-dependent variable?
>
> I think we fixed this in the 1.9 series, in commits
> eb350124a85dd4daf39bacbdc50452ef87a33a43 and
> 28af5ee5eccb7797b73ad1caf88183e95eef0a28.  Is there something that is
> not working for you with 1.9.14, or are you working off of 1.8?
>

Yes, the instructions in "Section 2.3 Linking Guile into
Programs" failed when I attempted to run the generated
'simple-guile' executable file.

[guile]$ unset LD_LIBRARY_PATH
[guile]$ ./simple-guile
./simple-guile: error while loading shared libraries:
libguile-2.0.so.18: cannot open shared object file: No such
file or directory

[guile]$ export LD_LIBRARY_PATH=/usr/local/lib
[guile]$ ./simple-guile
GNU Guile 1.9.14
Copyright (C) 1995-2010 Free Software Foundation, Inc.

Guile comes with ABSOLUTELY NO WARRANTY; for details type
`,show w'.
This program is free software, and you are welcome to
redistribute it
under certain conditions; type `,show c' for details.

Enter `,help' for help.
scheme@(guile-user)> ,q

[guile]$ locate libguile-2.0.so.18
/usr/local/lib/libguile-2.0.so.18
/usr/local/lib/libguile-2.0.so.18.0.0

--