Update docs to point out that sometimes -lncurses will be needed with

libreadline.


git-svn-id: svn://vcs.exim.org/pcre/code/trunk@338 2f5784b3-3f2a-0410-8824-cb99058d5e15

2 files changed, 30 insertions, 3 deletions

diff --git a/README b/README
index 98d52f1..31bfcee 100644
--- a/README
+++ b/README
@@ -275,6 +275,15 @@ library. You can read more about them in the pcrebuild man page.
   the readline() function. This provides line-editing and history facilities.
   Note that libreadline is GPL-licenced, so if you distribute a binary of
   pcretest linked in this way, there may be licensing issues.
+  
+  Setting this option causes the -lreadline option to be added to the pcretest 
+  build. In many operating environments with a sytem-installed readline
+  library this is sufficient. However, in some environments (e.g. if an
+  unmodified distribution version of readline is in use), it may be necessary
+  to specify something like LIBS="-lncurses" as well. This is because, to quote
+  the readline INSTALL, "Readline uses the termcap functions, but does not link
+  with the termcap or curses library itself, allowing applications which link
+  with readline the to choose an appropriate library."
 
 The "configure" script builds the following files for the basic C library:
 
@@ -740,4 +749,4 @@ The distribution should contain the following files:
 Philip Hazel
 Email local part: ph10
 Email domain: cam.ac.uk
-Last updated: 25 January 2008
+Last updated: 13 April 2008
diff --git a/doc/pcrebuild.3 b/doc/pcrebuild.3
index 2c40eb4..3538633 100644
--- a/doc/pcrebuild.3
+++ b/doc/pcrebuild.3
@@ -282,6 +282,24 @@ to the \fBconfigure\fP command, \fBpcretest\fP is linked with the
 using the \fBreadline()\fP function. This provides line-editing and history
 facilities. Note that \fBlibreadline\fP is GPL-licenced, so if you distribute a
 binary of \fBpcretest\fP linked in this way, there may be licensing issues.
+.P
+Setting this option causes the \fB-lreadline\fP option to be added to the
+\fBpcretest\fP build. In many operating environments with a sytem-installed
+\fBlibreadline\fP this is sufficient. However, in some environments (e.g.
+if an unmodified distribution version of readline is in use), some extra
+configuration may be necessary. The INSTALL file for \fBlibreadline\fP says 
+this:
+.sp
+  "Readline uses the termcap functions, but does not link with the 
+  termcap or curses library itself, allowing applications which link 
+  with readline the to choose an appropriate library."
+.sp  
+If your environment has not been set up so that an appropriate library is 
+automatically included, you may need to add something like
+.sp
+  LIBS="-ncurses"
+.sp
+immediately before the \fBconfigure\fP command.   
 .
 .
 .SH "SEE ALSO"
@@ -304,6 +322,6 @@ Cambridge CB2 3QH, England.
 .rs
 .sp
 .nf
-Last updated: 18 December 2007
-Copyright (c) 1997-2007 University of Cambridge.
+Last updated: 13 April 2008
+Copyright (c) 1997-2008 University of Cambridge.
 .fi