summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorWerner Koch <wk@gnupg.org>2007-12-10 09:17:25 +0000
committerWerner Koch <wk@gnupg.org>2007-12-10 09:17:25 +0000
commita7ce99fa757b84d2157c25d04bd2bb97cd50b747 (patch)
treeb51c69bba7458ecc3cc2f4526ed681e7c55a45e9 /README
parent9ea615f14905e3a764dca0ae1ec73ab6671d844a (diff)
downloadlibgcrypt-a7ce99fa757b84d2157c25d04bd2bb97cd50b747.tar.gz
Preparing 1.4.0.
Diffstat (limited to 'README')
-rw-r--r--README132
1 files changed, 94 insertions, 38 deletions
diff --git a/README b/README
index 9bad05a1..8e75e400 100644
--- a/README
+++ b/README
@@ -1,10 +1,6 @@
libgcrypt - The GNU crypto library
------------------------------------
- Version 1.3.x
-
- WARNING: This is the development branch of Libgcrypt. The stable
- version is 1.2.x.
-
+ Version 1.4.0
Copyright 2000, 2002, 2003, 2004, 2007 Free Software Foundation, Inc.
@@ -22,14 +18,57 @@
--------
Libgcrypt is a general purpose crypto library based on the code
- used in GnuPG. We can't start with a new version number because
- libgcrypt was part of GnuPG 1.1 and some applications already used
- it and tested for the version number. We believe that the API can
- stay as it is, except that new functions may be added in the
- future.
+ used in GnuPG. Libgcrypt depends on the library `libgpg-error',
+ which must be installed correctly before Libgcrypt is to be built.
+ Libgcrypt is distributed under the LGPL, see the section "License"
+ below for details.
+
+
+ Build Instructions
+ ------------------
+
+ The download canonical location for libgcrypt is:
+
+ ftp://ftp.gnupg.org/gcrypt/libgcrypt/
+
+ To build libgcrypt you need libgpg-error:
+
+ ftp://ftp.gnupg.org/gcrypt/libgpg-error/
+
+ You should get the latest versions of course.
+
+ After building and installing the libgpg-error package, you may
+ continue with Libgcrypt installation As with allmost all GNU
+ packages, you just have to do
+
+ ./configure
+ make
+ make check
+ make install
+
+ The "make check" is not required but a good idea to see whether
+ the library works as expected. The check takes some while and
+ prints some benchmarking results. Before doing "make install" you
+ probably need to become root.
+
+ To build libgcrypt for Microsoft Windows, you need to have the
+ mingw32 cross-building toolchain installed. Instead of running a
+ plain configure you use
+
+ ./autogen.sh --build-w32
+ make
+ make install
+
+ By default this command sequences expectsd a libgpg-error
+ installed below $HOME/w32root and installs libgcrypt to that
+ directory too. See the autogen.sh code for details.
+
+ The documentation is available as an Info file (gcrypt.info). To
+ build documentation in PDF, run this:
+
+ cd doc
+ make pdf
- Libgcrypt depends on the library `libgpg-error', which must be
- installed correctly before Libgcrypt is to be built.
Mailing List
@@ -41,32 +80,6 @@
list is available at http://lists.gnupg.org .
- License
- -------
-
- The library is distributed under the terms of the GNU Lesser
- General Public License (LGPL); see the file COPYING.LIB for the
- actual terms. The helper programs (gcryptrnd and getrandom) as
- well as the documentation are distributed under the terms of the
- GNU General Public License (GPL); see the file COPYING for teh
- actual terms.
-
- This library used to be available under the GPL - this was changed
- with version 1.1.7 with the rationale that there are now many free
- crypto libraries available and many of them come with capabilities
- similar to Libcrypt. We decided that to foster the use of
- cryptography in Free Software an LGPLed library would make more
- sense because it avoids problems due to license incompatibilities
- between some Free Software licenses and the GPL.
-
- Please note that in many cases it is better for a library to be
- licensed under the GPL, so that it provides an advantage for free
- software projects. The Lesser GPL is so named because it does
- less to protect the freedom of the users of the code that it
- covers. See http://www.gnu.org/philosophy/why-not-lgpl.html for
- more explanation.
-
-
Configure options
-----------------
Here is a list of configure options which are sometimes useful
@@ -142,11 +155,54 @@
auto - Compile linux, egd and unix in and
automagically select at runtime.
+ --disable-padlock-support
+ Disable support for the PadLock engine of VIA
+ processors. The default is to use PadLock if
+ available. Try this if you get problems with
+ assembler code.
+
+ License
+ -------
+
+ The library is distributed under the terms of the GNU Lesser
+ General Public License (LGPL); see the file COPYING.LIB for the
+ actual terms. The helper programs (gcryptrnd and getrandom) as
+ well as the documentation are distributed under the terms of the
+ GNU General Public License (GPL); see the file COPYING for teh
+ actual terms.
+
+ This library used to be available under the GPL - this was changed
+ with version 1.1.7 with the rationale that there are now many free
+ crypto libraries available and many of them come with capabilities
+ similar to Libcrypt. We decided that to foster the use of
+ cryptography in Free Software an LGPLed library would make more
+ sense because it avoids problems due to license incompatibilities
+ between some Free Software licenses and the GPL.
+
+ Please note that in many cases it is better for a library to be
+ licensed under the GPL, so that it provides an advantage for free
+ software projects. The Lesser GPL is so named because it does
+ less to protect the freedom of the users of the code that it
+ covers. See http://www.gnu.org/philosophy/why-not-lgpl.html for
+ more explanation.
+
Contact
-------
See the file AUTHORS.
+ Commercial grade support for Libgcrypt is available; please see
+ http://www.gnupg.org/service.html .
+
+
+ This file is Free Software; as a special exception the authors gives
+ unlimited permission to copy and/or distribute it, with or without
+ modifications, as long as this notice is preserved. For conditions
+ of the whole package, please see the file COPYING. This file is
+ distributed in the hope that it will be useful, but WITHOUT ANY
+ WARRANTY, to the extent permitted by law; without even the implied
+ warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+