r17487 - in /trunk/docs/latex: intro.tex relax.tex -- September 18, 2012 - 12:11

Author: bugman
Date: Tue Sep 18 12:11:17 2012
New Revision: 17487

URL: http://svn.gna.org/viewcvs/relax?rev=17487&view=rev
Log:
Updated the scripting section of the intro chapter of the user manual for 
non-technical users.

See http://www.mail-archive.com/relax-users@xxxxxxx/msg01253.html and bug 
#20174
(http://gna.org/bugs/?20174).


Modified:
    trunk/docs/latex/intro.tex
    trunk/docs/latex/relax.tex

Modified: trunk/docs/latex/intro.tex
URL: 
http://svn.gna.org/viewcvs/relax/trunk/docs/latex/intro.tex?rev=17487&r1=17486&r2=17487&view=diff
==============================================================================
--- trunk/docs/latex/intro.tex (original)
+++ trunk/docs/latex/intro.tex Tue Sep 18 12:11:17 2012
@@ -358,11 +358,19 @@
 \subsection{Scripting}
 \index{scripting|textbf}
 
-What ever is done within the prompt is also accessible through scripting 
(Figure~\ref{fig: relax script}).  Just type your commands into a text file 
ending in \file{*.py} and then at the terminal type
+What ever is done within the prompt is also accessible through scripting 
(Figure~\ref{fig: relax script}).  First type your commands into a text file 
ending in \file{*.py}.  To use this mode of relax, you will need to open up a 
terminal in your respective operating system:
+
+\begin{description}
+\item[GNU/Linux:]  Here you have an incredible number of choices.  If you 
don't have a preferred shell already, you could try one of 
\software{Konsole}, \software{GNOME Terminal} or even \software{XTerm} if you 
are a masochist.
+\item[Mac OS X:]  This is as simple as in GNU/Linux -- just launch 
\software{Terminal.app} from the \directory{Utilities} folder.
+\item[MS Windows:]  If your system supports it, you should install and use 
\software{Windows PowerShell}.  The alternative is the nasty \software{cmd} 
command line terminal program which comes installed by default on all Windows 
versions.  The \software{PowerShell}, although no where near as powerful as 
the Linux and Mac terminals, is a huge improvement on the ancient 
\software{cmd} program and will make relax much better to use on MS Windows.
+\end{description}
+
+Once your terminal is running, go to the directory containing your script 
using the \prompt{cd} command (if you do not know what this is, please see 
the documentation for your terminal program to understand some of its basic 
usage).  Once you are in the correct directory, within the terminal type:
 
 \example{\$ relax your\_script.py}
 
-An example of a simple script which will minimise the model-free model 
``m4'' after loading six relaxation data sets is
+You will need to replace \file{your\_script.py} with the name of your 
script.  An example of a simple script which will minimise the model-free 
model ``m4'' after loading six relaxation data sets is
 
 \begin{exampleenv}
 \# Create the data pipe. \\

Modified: trunk/docs/latex/relax.tex
URL: 
http://svn.gna.org/viewcvs/relax/trunk/docs/latex/relax.tex?rev=17487&r1=17486&r2=17487&view=diff
==============================================================================
--- trunk/docs/latex/relax.tex (original)
+++ trunk/docs/latex/relax.tex Tue Sep 18 12:11:17 2012
@@ -58,6 +58,7 @@
 \newcommand{\module}[1]{\texttt{#1}}
 \newcommand{\pycode}[1]{``\\verb!{#1}!''}
 \newcommand{\pycodestar}[1]{``\\verb*!{#1}!''}
+\newcommand{\software}[1]{\texttt{#1}}
 
 % New environment.
 \newenvironment{exampleenv}{\footnotesize \begin{ttfamily} \sloppy}{\fussy 
\end{ttfamily}}