Fix test-cp-name-parser build, parser_fprintf undefined

[deliverable/binutils-gdb.git] / readline / README

diff --git a/readline/README b/readline/README
index 56565b2fb803adc49129f9709399c946069b5b55..bc89f460711d2ee7bb797a071ffab74d9b99dcc7 100644 (file)
--- a/readline/README
+++ b/readline/README
@@ -1,7 +1,7 @@
 Introduction
 ============
 
 Introduction
 ============
 

-This is the Gnu Readline library, version 4.0.
+This is the Gnu Readline library, version 6.2.

 
 The Readline library provides a set of functions for use by applications
 that allow users to edit command lines as they are typed in.  Both
 
 The Readline library provides a set of functions for use by applications
 that allow users to edit command lines as they are typed in.  Both


@@ -16,8 +16,9 @@ may be used without Readline in applications which desire its
 capabilities.
 
 The Readline library is free software, distributed under the terms of
 capabilities.
 
 The Readline library is free software, distributed under the terms of

-the GNU Public License, version 2.  For more information, see the file
-COPYING.
+the [GNU] General Public License as published by the Free Software
+Foundation, version 3 of the License.  For more information, see the
+file COPYING.

 
 To build the library, try typing `./configure', then `make'.  The
 configuration process is automated, so no further intervention should
 
 To build the library, try typing `./configure', then `make'.  The
 configuration process is automated, so no further intervention should


@@ -37,6 +38,9 @@ to customize and control the build process.
 The file rlconf.h contains C preprocessor defines that enable and disable
 certain Readline features.
 
 The file rlconf.h contains C preprocessor defines that enable and disable
 certain Readline features.
 

+The special make target `everything' will build the static and shared
+libraries (if the target platform supports them) and the examples.
+

 Examples
 ========
 
 Examples
 ========
 


@@ -54,6 +58,9 @@ a Makefile in the `shlib' subdirectory, and typing `make shared'
 will cause shared versions of the Readline and History libraries
 to be built on supported platforms.
 
 will cause shared versions of the Readline and History libraries
 to be built on supported platforms.
 

+If `configure' is given the `--enable-shared' option, it will attempt
+to build the shared libraries by default on supported platforms.
+

 Configure calls the script support/shobj-conf to test whether or
 not shared library creation is supported and to generate the values
 of variables that are substituted into shlib/Makefile.  If you
 Configure calls the script support/shobj-conf to test whether or
 not shared library creation is supported and to generate the values
 of variables that are substituted into shlib/Makefile.  If you


@@ -64,8 +71,8 @@ your platform.
 If you need to update support/shobj-conf, you will need to create
 a `stanza' for your operating system and compiler.  The script uses
 the value of host_os and ${CC} as determined by configure.  For
 If you need to update support/shobj-conf, you will need to create
 a `stanza' for your operating system and compiler.  The script uses
 the value of host_os and ${CC} as determined by configure.  For

-instance, FreeBSD 2.2.5 with any version of gcc is identified as
-`freebsd2.2.5-gcc*'.
+instance, FreeBSD 4.2 with any version of gcc is identified as
+`freebsd4.2-gcc*'.

 
 In the stanza for your operating system-compiler pair, you will need to
 define several variables.  They are:
 
 In the stanza for your operating system-compiler pair, you will need to
 define several variables.  They are:


@@ -96,6 +103,9 @@ SHLIB_XLDFLAGS       Additional flags to pass to SHOBJ_LD for shared library
 SHLIB_LIBS     Any additional libraries that shared libraries should be
                linked against when they are created.
 
 SHLIB_LIBS     Any additional libraries that shared libraries should be
                linked against when they are created.
 

+SHLIB_LIBPREF  The prefix to use when generating the filename of the shared
+               library.  The default is `lib'; Cygwin uses `cyg'.
+

 SHLIB_LIBSUFF  The suffix to add to `libreadline' and `libhistory' when
                generating the filename of the shared library.  Many systems
                use `so'; HP-UX uses `sl'.
 SHLIB_LIBSUFF  The suffix to add to `libreadline' and `libhistory' when
                generating the filename of the shared library.  Many systems
                use `so'; HP-UX uses `sl'.


@@ -112,6 +122,17 @@ SHLIB_LIBVERSION The string to append to the filename to indicate the version
                numbers; use `$(SHLIB_LIBSUFF).$(SHLIB_MAJOR)' on those systems.
                Other Unix versions use different schemes.
 
                numbers; use `$(SHLIB_LIBSUFF).$(SHLIB_MAJOR)' on those systems.
                Other Unix versions use different schemes.
 

+SHLIB_DLLVERSION The version number for shared libraries that determines API
+               compatibility between readline versions and the underlying
+               system.  Used only on Cygwin.  Defaults to $SHLIB_MAJOR, but
+               can be overridden at configuration time by defining DLLVERSION
+               in the environment.
+
+SHLIB_DOT      The character used to separate the name of the shared library
+               from the suffix and version information.  The default is `.';
+               systems like Cygwin which don't separate version information
+               from the library name should set this to the empty string.
+

 SHLIB_STATUS   Set this to `supported' when you have defined the other
                necessary variables.  Make uses this to determine whether
                or not shared library creation should be attempted.
 SHLIB_STATUS   Set this to `supported' when you have defined the other
                necessary variables.  Make uses this to determine whether
                or not shared library creation should be attempted.


@@ -122,18 +143,21 @@ Once you have updated support/shobj-conf, re-run configure and type
 `make shared'.  The shared libraries will be created in the shlib
 subdirectory.
 
 `make shared'.  The shared libraries will be created in the shlib
 subdirectory.
 

-Since shared libraries are not created on all platforms, `make install'
-will not automatically install the shared libraries.  To install them,
-change the current directory to shlib and type `make install'.  Running
-`make install-shared' from the top-level build directory will also work.
+If shared libraries are created, `make install' will install them. 
+You may install only the shared libraries by running `make
+install-shared' from the top-level build directory.  Running `make
+install' in the shlib subdirectory will also work.  If you don't want
+to install any created shared libraries, run `make install-static'. 

 
 Documentation
 =============
 
 
 Documentation
 =============
 

-The documentation for the Readline and History libraries appears in the
-`doc' subdirectory.  There are two texinfo files and a Unix-style manual
-page describing the programming facilities available in the Readline
-library.  The texinfo files include both user and programmer's manuals.
+The documentation for the Readline and History libraries appears in
+the `doc' subdirectory.  There are three texinfo files and a
+Unix-style manual page describing the facilities available in the
+Readline library.  The texinfo files include both user and
+programmer's manuals.  HTML versions of the manuals appear in the
+`doc' subdirectory as well. 

 
 Reporting Bugs
 ==============
 
 Reporting Bugs
 ==============


@@ -144,7 +168,7 @@ Bug reports for Readline should be sent to:
 
 When reporting a bug, please include the following information:
 
 
 When reporting a bug, please include the following information:
 

-        * the version number and release status of Readline (e.g., 4.0-release)
+        * the version number and release status of Readline (e.g., 4.2-release)

         * the machine and OS that it is running on
         * a list of the compilation flags or the contents of `config.h', if
           appropriate
         * the machine and OS that it is running on
         * a list of the compilation flags or the contents of `config.h', if
           appropriate


@@ -160,4 +184,4 @@ list (mirrored to the Usenet newsgroup gnu.bash.bug) often contains
 Readline bug reports and fixes. 
 
 Chet Ramey
 Readline bug reports and fixes. 
 
 Chet Ramey

-chet@po.cwru.edu
+chet.ramey@case.edu