(Does not compile yet)
[gnupg.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index c524222..60252d1 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,3 +1,98 @@
+
+Please read the Basic Installation section somewhere below.
+
+Configure options for GNUPG
+===========================
+
+--with-included-zlib Forces usage of the local zlib sources. Default is
+                    to use the (shared) library of the system.
+
+--with-included-gettext Forces usage of the local gettext sources instead of
+                   the one provided by your system.
+
+--disable-nls      Disable NLS support (See ABOUT-NLS)
+
+--enable-m-debug    Compile with the integrated malloc debugging stuff.
+                   This makes the program slower but is checks every
+                   free operation and can be used to create statistics
+                   of memory usage. If this option is used the program
+                   option "--debug 32" displays every call to a a malloc
+                   function (this makes the program *really* slow), the
+                   option "--debug 128" displays a memory statistic after
+                   the program run.
+
+--disable-m-guard   Disable the integrated malloc checking code. As a
+                   side-effect, this removes all debugging code and uses
+                   the -O2 flag for all C files.
+
+--disable-dynload   If you have problems with dynamic loading, this option
+                   disables all dynamic loading stuff.
+
+
+
+Problems
+========
+
+If you get unresolved externals "gettext" you should run configure again
+with the option "--with-included-gettext".
+
+If you have other compile problems, try the configure options
+"--with-included-zlib" or "--disable-nls" (See ABOUT-NLS)
+or --disable-dynload.
+
+I can't check all assembler files, so if you have problems assembling them
+(or the program crashes), simply delete the files in the mpi/<cpu> directory.
+The configure scripts may consider several subdirectories to get all
+available assembler files; be sure to delete the correct ones. The
+assembler replacements are in C and in mpi/generic; never delete udiv-qrnnd.S
+in any CPU directory, because there may be no C substitute.
+Don't forget to delete "config.cache" and run "./config.status --recheck".
+
+
+The Random Device
+=================
+The current version of GNUPG needs the support of a random device.
+If there is no such device, it uses a very simple RNG, which does
+not generate strong random numbers.
+Random devices are available in Linux, FreeBSD and OpenBSD.
+The device files may not exist on your system, please check this
+and create them if needed.
+
+The Linux files should look like this:
+    cr--r--r--  1 root     sys        1,   8 May 28  1997 /dev/random
+    cr--r--r--  1 root     sys        1,   9 Feb 16 08:23 /dev/urandom
+You can create them with:
+    mknod /dev/random c 1 8
+    mknod /dev/urandom c 1 9
+
+The FreeBSD files [from the 970202 snapshot]:
+    crw-r--r-- 1 root  wheel    2,   3 Feb 25 16:54 /dev/random
+    crw-r--r-- 1 root  wheel    2,   4 Feb 25 16:54 /dev/urandom
+You can create them with:
+    mknod /dev/random  c 2 3
+    mknod /dev/urandom c 2 4
+
+
+
+Installation
+============
+gpg is not installed as suid:root; if you want to do it, do it manually.
+We will use capabilities in the future.
+
+The ~/.gnupg directory will be created if it does not exist.  Your first
+action should be to create a key pair: "gpg --gen-key".
+
+
+
+Creating a RPM package
+======================
+The file scripts/gnupg-x.x.x.spec is used to build a RPM package:
+    1. As root, copy the spec file into /usr/src/redhat/SPECS
+    2. copy the tar file into /usr/src/redhat/SOURCES
+    3. type: rpm -ba SPECS/gnupg-x.x.x.spec
+
+
+
 Basic Installation
 ==================