[Genabel-commits] r1815 - pkg/ProbABEL/doc

[noreply at r-forge.r-project.org]

Author: lckarssen
Date: 2014-08-27 23:12:49 +0200 (Wed, 27 Aug 2014)
New Revision: 1815

Modified:
   pkg/ProbABEL/doc/ProbABEL_manual.tex
Log:
Updates to the ProbABEL manual:
- Smaller font size in the listing of the GPG checks (fewer linebreaks)
- EIGEN will be required for ProbABEL 0.5.0, so changed the compilation instructions accordingly.


Modified: pkg/ProbABEL/doc/ProbABEL_manual.tex
===================================================================
--- pkg/ProbABEL/doc/ProbABEL_manual.tex	2014-08-27 21:00:38 UTC (rev 1814)
+++ pkg/ProbABEL/doc/ProbABEL_manual.tex	2014-08-27 21:12:49 UTC (rev 1815)
@@ -170,7 +170,7 @@
   categories\footnote{We know that many people have use Red Hat Linux,
     CentOS, Scientific Linux or any other Red Hat
     derivative. Unfortunately we haven't got \texttt{rpm} files
-    yet. Any help in creating those will be highly appreciated}, you
+    yet. Any help in creating those will be highly appreciated.}, you
   can install \PA{} manually by downloading the source code of the
   latest version from the website and compiling it yourself. This will
   be explained in section~\ref{sec:obtain}.
@@ -184,7 +184,7 @@
 from your own home directory. This section details the steps you need
 to take. More information can be found in the \texttt{doc/INSTALL}.
 
-On the \href{http://www.genabel.org/packages/probabel}{\PA{}} website
+On the \href{http://www.genabel.org/packages/probabel}{\PA{} website}
 you can find the link to the latest version of the source code of \PA{}
 in a \texttt{tar.gz} file\footnote{The \texttt{tar.gz} file archive
   format is the most commonly used format for distributing source code
@@ -196,7 +196,7 @@
 source code by typing this command on the command line of a Linux
 shell\footnote{The \$ sign indicates the end of the command line
   prompt. You don't need to type it.}:
-\begin{lstlisting}[]
+\begin{lstlisting}[basicstyle=\scriptsize\ttfamily]
 user at server:~$ gpg --verify probabel-0.4.3.tar.gz.asc
 gpg: Signature made Thu Jan  2 02:38:25 2014 CET using DSA key ID DA9CD509
 gpg: Good signature from "L.C. Karssen (GPG key for personal stuff) <lennart at karssen.org>"
@@ -210,21 +210,19 @@
 \texttt{tar.gz} file has changed (e.g.~by such a hacker or because
 the file didn't get downloaded correctly) you will see output like
 this (notice the ``BAD signature'' message):
-\begin{lstlisting}[]
+\begin{lstlisting}[basicstyle=\scriptsize\ttfamily]
 user at server:~$ gpg --verify probabel-0.4.2.tar.gz.asc
 gpg: Signature made Thu Jan  2 02:38:25 2014 CET using DSA key ID DA9CD509
 gpg: BAD signature from "L.C. Karssen (GPG key for personal stuff) <lennart at karssen.org>"
-user at server:~$
 \end{lstlisting}
 
-Before continuing, it is important to mention that \PA{} can make use
-of the EIGEN library\footnote{EIGEN is a library for fast matrix
-  multiplication.}. We strongly recommend compiling \PA with EIGEN as
-it will speed up your analyses considerably. Moreover, we plan to
-remove the non-EIGEN part of the code in a future release. So, go to
-\url{http://eigen.tuxfamily.org} and download the \texttt{tar.gz} file
-of the latest version of EIGEN (3.2.1 at the time of writing). Extract
-the files:
+Before continuing, it is important to mention that \PA{} needs the
+EIGEN library\footnote{EIGEN is a library for fast matrix
+  multiplication. In ProbABEL versions before v0.5.0 EIGEN was not
+  required (but still recommended).}. In order to download the
+library, go to \url{http://eigen.tuxfamily.org} and download the
+\texttt{tar.gz} file of the latest version of EIGEN (3.2.1 at the time
+of writing). Extract the files:
 \begin{lstlisting}
 user at server:~$ tar -xzf 3.2.1.tar.gz
 \end{lstlisting}
@@ -237,8 +235,8 @@
 Now it's time to extract the \PA{} source code and move into the
 directory that is created:
 \begin{lstlisting}
-user at server:~$ tar -xzf probabel-0.4.3.tar.gz
-user at server:~$ cd probabel-0.4.3
+user at server:~$ tar -xzf probabel-0.5.0.tar.gz
+user at server:~$ cd probabel-0.5.0
 \end{lstlisting}
 With the following command we will indicate where the EIGEN files can
 be found and where we want to install \PA{}. Let's install in a