Update build instructions for latest Cygwin, OpenSSL 1.0.0c, PCRE 8.11,

and add download link and license notes for readline.

1 files changed, 31 insertions, 17 deletions

diff --git a/docs/api-notes/win32_build_on_cygwin_using_mingw.txt b/docs/api-notes/win32_build_on_cygwin_using_mingw.txt
index 9cf97284..358275ab 100644
--- a/docs/api-notes/win32_build_on_cygwin_using_mingw.txt
+++ b/docs/api-notes/win32_build_on_cygwin_using_mingw.txt
@@ -13,19 +13,18 @@ Make sure to select the following packages during installation:
  * Devel/automake
  * Devel/autoconf
  * Devel/gcc-mingw
- * Devel/gcc-mingw-core
  * Devel/gcc-mingw-g++
  * Devel/make
- * Devel/mingw-runtime
- * Lib/libxml2
- * Lib/libxslt (for xsltproc)
- * Mingw/mingw-zlib
+ * Libs/libxml2
+ * Libs/libxslt (for xsltproc)
+ * Mingw/mingw-zlib0
  * Perl/Perl
 
 If you already have Cygwin installed, please re-run the installer and
 ensure that those packages are installed.
 
-You may also want to install the debugger, Devel/gdb.
+You may also want to install the debugger, Devel/gdb, and the command-line
+Subversion client, Devel/subversion.
 
 == Base Directory ==
 
@@ -45,11 +44,11 @@ Download OpenSSL from [http://www.openssl.org/source/openssl-1.0.0a.tar.gz]
 
 Open a Cygwin shell, go to the base directory, and unpack OpenSSL:
 
-	tar xzvf openssl-1.0.0a.tar.gz
+	tar xzvf openssl-1.0.0c.tar.gz
 
 Configure OpenSSL for MinGW compilation, and build and install it:
 
-	cd openssl-1.0.0a
+	cd openssl-1.0.0c
 	./Configure --prefix=/usr/i686-pc-mingw32/ mingw
 	make
 	make install
@@ -59,15 +58,15 @@ Configure OpenSSL for MinGW compilation, and build and install it:
 This step is only required to support regular expressions in including/excluding files from backups. However, this is a very useful feature.
 
 Download PCRE from 
-[http://prdownloads.sourceforge.net/pcre/pcre-8.10.tar.bz2?download]
+[http://prdownloads.sourceforge.net/pcre/pcre-8.11.tar.bz2?download]
 
 Open a Cygwin shell, go to the base directory, and unpack PCRE:
 
-	tar xjvf pcre-8.10.tar.bz2
+	tar xjvf pcre-8.11.tar.bz2
 
 Configure PCRE for MinGW compilation, and build and install it:
 	
-	cd pcre-8.10
+	cd pcre-8.11
 	export CFLAGS="-mno-cygwin"
 	export CXXFLAGS="-mno-cygwin"
 	./configure --prefix=/usr/i686-pc-mingw32
@@ -76,8 +75,15 @@ Configure PCRE for MinGW compilation, and build and install it:
 
 == Readline (Optional) ==
 
-If you want Readline support, download Readline version 6.1, unpack
-and install thus:
+Readline enables editing and completion of commands in bbackupquery.
+It is optional, but it makes bbackupquery easier to use. However, please
+do not enable readline if you intend to distribute the resulting Box
+Backup binaries, as this would be a violation of the GPL license of
+readline.
+
+If you want Readline support, download Readline version 6.1 from
+[ftp://ftp.cwru.edu/pub/bash/readline-6.1.tar.gz], and unpack
+and install it thus:
 
 	tar xzvf readline-6.1.tar.gz
 	./configure --prefix=/usr/i686-pc-mingw32 \
@@ -93,7 +99,9 @@ Go back to the base directory, and download the latest Box Backup sources:
 
 	svn co https://www.boxbackup.org/svn/box/trunk/ trunk
 
-Note: If you have problems during the configure or make stage, please try to eliminate one potential source of problems by running the following command to convert all line endings to Unix format:
+Note: If you have problems during the configure or make stage, please try to
+eliminate one potential source of problems by running the following command
+to convert all line endings to Unix format:
 
 	find -type f -not \( -wholename .*svn*. \) -exec dos2unix {} \;
 
@@ -109,7 +117,9 @@ Enter the source directory and configure like this:
 
 Create the destination directory, ''C:\Program Files\Box Backup\bbackupd''.
 
-Write a configuration file, keys and certificate on a Unix machine, and copy them into the ''Box Backup'' directory, together with the following files from the ''base directory'':
+Write a configuration file, keys and certificate on a Unix machine, and
+copy them into the ''Box Backup'' directory, together with the following
+files from the ''base directory'':
 
  * boxbackup\release\bin\bbackupd\bbackupd.exe
  * boxbackup\release\bin\bbackupquery\bbackupquery.exe
@@ -118,9 +128,13 @@ Write a configuration file, keys and certificate on a Unix machine, and copy the
  * openssl\out32dll\ssleay32.dll
  * zlib\zlib1.dll
 
-Ensure that the user running Box Backup can read from the ''Box Backup'' directory, and write to the ''bbackupd'' directory inside it.
+Ensure that the user running Box Backup can read from the ''Box Backup''
+directory, and write to the ''bbackupd'' directory inside it.
 
-Run Box Backup by double-clicking on it, and check that it connects to the server. If the window opens and closes immediately, it's probably due to a problem with the configuration file - check the Windows Event Viewer for details.
+Run Box Backup by double-clicking on it, and check that it connects to
+the server. If the window opens and closes immediately, it's probably
+due to a problem with the configuration file. Check the Windows Event
+Viewer for details.
 
 See also the service installation and upgrade instructions at 
 [https://www.boxbackup.org/trac/wiki/CompilationOnWindows].