[GNUnet-SVN] r30323 - msh/doc

[gnunet]

Author: harsha
Date: 2013-10-18 16:10:15 +0200 (Fri, 18 Oct 2013)
New Revision: 30323

Modified:
   msh/doc/msh.tex
Log:
- doc


Modified: msh/doc/msh.tex
===================================================================
--- msh/doc/msh.tex     2013-10-18 14:10:02 UTC (rev 30322)
+++ msh/doc/msh.tex     2013-10-18 14:10:15 UTC (rev 30323)
@@ -1,9 +1,9 @@
 \documentclass[10pt, a4paper, onecolumn, oneside]{scrreprt}
-
 \usepackage[utf8]{inputenc}
 \usepackage{color}
 \usepackage{graphicx}
 \usepackage{import}
+\usepackage{amsfonts}
 \usepackage[pdftex,hyperfootnotes=false,pdfpagelabels]{hyperref}
 \usepackage{listings}
 \usepackage[sorting=none]{biblatex}
@@ -90,15 +90,15 @@
 \section{Architecture}
 
 MSH consists of two components: the \texttt{mshd} daemon and the \texttt{msh}
-client.  \texttt{mshd} is similar to \texttt{sshd} in that it is started one
-daemon per host and executes the commands given from remote \texttt{msh}
-clients.  However, unlike \texttt{sshd}, \texttt{mshd} is started by the job
-scheduler and only runs during the job. 
+client.  \texttt{mshd} is similar to \texttt{sshd} in that one \texttt{mshd}
+daemon per host is started.  The daemons execute the commands given from remote
+\texttt{msh} clients.  However, unlike \texttt{sshd}, \texttt{mshd} is started
+by the job scheduler and only runs during the job.
 
-MSH client, \texttt{msh}, takes the IP address of the target host and the 
remote
-command string as arguments.  The client relies on the local \texttt{mshd} for
-learning the address of the remote \texttt{mshd} and authenticating itself to
-the remote \texttt{mshd}.
+The MSH client, \texttt{msh}, takes the IP address of the target host and the
+remote command string as arguments.  The client relies on the local
+\texttt{mshd} for learning the address of the remote \texttt{mshd} and
+authenticating itself to the remote \texttt{mshd}.
 
 The command string is executed by the remote \texttt{mshd} after successful
 authentication of \texttt{msh}.  The input for the executed command string is
@@ -148,7 +148,8 @@
 \item The remote \texttt{mshd} verifies the challenge-response and it
   successfully verified, it starts executes the command string
 \item The input and output streams for the remote command string are relayed
-  from \texttt{msh} and \texttt{mshd} to each other respectively.
+  from \texttt{msh} and \texttt{mshd} to each other respectively.  Unlike SSH,
+  the streams are not encrypted as we only use MSH on HPC systems.
 \end{enumerate}
 
 \section{Resource Discovery and Addressing}
@@ -165,11 +166,11 @@
 proceeds in rounds where each instance verifies IP addresses of several
 instances.  At the beginning of each round, every instance opens a socket bound
 to a random port and all available IP addresses on its host and sends the IP
-addresses to the instances for verification.  The set of instances $n$ to be
-contacted is determined by the current round $r$ and the round width $R$ such
-that
+addresses to a set of instances $\mathbb{N}$ for verification.  The set
+$\mathbb{N}$ is determined from the set of all instances $\mathbb{I}$
+depending on the current round $r$ and the round width $R$ as follows:
 \begin{center}
-  $ n = \{i\in I | (r.R + 1) \le i \le (r.R + r)\} $
+  $ \mathbb{N} = \{i\in \mathbb{I} | (rR + 1) \le i \le (rR + r)\} $
 \end{center}
 The instances verify the IP addresses of the sending instance by establishing
 TCP connections to the sender's listening socket with one TCP connection for
@@ -183,8 +184,8 @@
   \label{fig:ip_map}
 \end{figure}
 
-At the end of the last round.  All instances would have verified the IP
-addresses of other instances and posses an instance--IP mapping.  At this 
point,
+At the end of the last round, all instances would have verified the IP
+addresses of other instances and posses an instance-to-IP mapping.  At this 
point,
 they accumulate their mappings using a reduction algorithm (binary/ binomial
 tree reduction).  The reduction is made by intersecting the reported IP
 addresses for an instance.
@@ -203,12 +204,21 @@
 systems.
 
 \section{Installation}
-MSH depends on GNUnet's networking API and hence requires gnunet-0.9.5a to be
-installed.  Additionally, it requires an MPI implementation to be installed
-together with the MPI compiler wrapper \texttt{mpicc}.
+The source code for MSH is available from our Subversion repository:\\
+\url{https://gnunet.org/svn/msh/}.
 
+MSH depends on GNUnet's networking API and hence requires
+GNUnet\footnote{\url{https://gnunet.org/}} to be installed.  GNUnet sources can
+be downloaded from its repository at \url{https://gnunet.org/svn/gnunet/}.
+Additionally, it requires an MPI implementation to be installed together with
+the MPI compiler wrapper \texttt{mpicc}.  Note that the repositories for MSH 
and
+GNUnet are used for active development and hence checking out the current
+versions may sometimes break the stability of MSH or simply may not compile.
+The version we tested to be stable at the time of writing this document is
+\texttt{30205}.  The corresponding version for GNUnet is also \texttt{30205}.
+
 Once the dependencies are installed, MSH can be installed by running the
-commands listed in Listing~\ref{lst:installation}in the MSH source directory:
+commands listed in Listing~\ref{lst:installation} in the MSH source directory:
 \begin{lstlisting}[language=bash,caption=Installation 
commands,label=lst:installation]
 $ ./configure
 $ make
@@ -219,7 +229,7 @@
 compiler, \texttt{configure} may fail complaining an error.  These can be fixed
 by providing the installation directories of the dependencies to
 \texttt{configure}.  For a list of available options type:
-\texttt{./configure --help}
+\texttt{./configure -{}-help}
 
 
 \section{Starting MSH}