Permalink
Browse files

typos

  • Loading branch information...
1 parent c4ef069 commit e161ca1e7dfb237de0cb4db6994311a8512d54ca @nniclausse nniclausse committed Jan 4, 2012
Showing with 33 additions and 20 deletions.
  1. +24 −11 doc/user_manual.html
  2. +9 −9 doc/user_manual.tex
View
@@ -96,7 +96,7 @@
<!--CUT DEF section 1 --><H1 ALIGN=center>Tsung User’s manual</H1><DIV CLASS="center">
<TABLE BORDER=1 CELLSPACING=0 CELLPADDING=1><TR><TD ALIGN=left NOWRAP bgcolor="#F2F2F2"> Version:</TD><TD ALIGN=left NOWRAP>1.4.2</TD></TR>
-<TR><TD ALIGN=left NOWRAP bgcolor="#F2F2F2"> Date :</TD><TD ALIGN=left NOWRAP>January 3, 2012</TD></TR>
+<TR><TD ALIGN=left NOWRAP bgcolor="#F2F2F2"> Date :</TD><TD ALIGN=left NOWRAP>January 4, 2012</TD></TR>
</TABLE>
</DIV><!--TOC section Contents-->
<H2 CLASS="section"><!--SEC ANCHOR -->Contents</H2><!--SEC END --><UL CLASS="toc"><LI CLASS="li-toc">
@@ -321,7 +321,7 @@ <H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc6">2.1</A>  Tsung main f
different type of users during the same benchmark. You can define
the proportion of the various behaviours in the benchmark scenario.
</LI><LI CLASS="li-itemize"><EM>Stochastic processes</EM>: in order to generate a realistic traffic,
-user thinktimes and the arrival rate can be randomize using a probability
+user thinktimes and the arrival rate can be randomized using a probability
distribution (currently exponential)
</LI></UL><!--TOC subsection HTTP related features-->
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc7">2.2</A>  HTTP related features</H3><!--SEC END --><UL CLASS="itemize"><LI CLASS="li-itemize">
@@ -485,7 +485,7 @@ <H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc19">3.4</A>  Running</H3
-m &lt;file&gt; write monitoring output on this file (default is tsung.log)
(use - for standard output)
-F use long names (FQDN) for erlang nodes
- -w warmup delay (default is 10 sec)
+ -w warm-up delay (default is 10 sec)
-v print version information and exit
-6 use IPv6 for tsung internal communications
-h display this help and exit
@@ -931,14 +931,14 @@ <H4 CLASS="subsubsection"><!--SEC ANCHOR --><A NAME="htoc42">6.2.2</A>  Advanc
(<FONT COLOR=purple>eth0</FONT> in this example).</P><P>In this example, a second machine is used in the Tsung cluster,
with a higher weight, and 2 cpus. Two Erlang virtual machines will be
used to take advantage of the number of CPU.</P><BLOCKQUOTE CLASS="quote">
-<B>Note:</B> Even if an Erlang VM is now able to handle severals CPUs
+<B>Note:</B> Even if an Erlang VM is now able to handle several CPUs
(erlang SMP), benchmarks shows that it’s more efficient to use one VM
per CPU (with SMP disabled) for tsung clients. Only the controller node is using SMP
erlang. Therefore, <TT>cpu</TT> should be equal to the number of cores of
your nodes. If you prefer to use erlang SMP, add the <FONT COLOR=purple>-s</FONT>
option when starting tsung (and don’t set <TT>cpu</TT> in the config
file).
-</BLOCKQUOTE><P>By default, the load is distributed uniformly on all CPU (one cpu
+</BLOCKQUOTE><P>By default, the load is distributed uniformly on all CPU (one CPU
per client by default). The weight parameter (integer) can be used to
take into account the speed of the client machine. For instance, if
one real client has a weight of 1 and the other client has a weight
@@ -956,7 +956,7 @@ <H4 CLASS="subsubsection"><!--SEC ANCHOR --><A NAME="htoc42">6.2.2</A>  Advanc
performance penalty (but don’t forget to raise the limit of the OS with
<TT>ulimit -n</TT>, see also FAQ <A HREF="#sec:faq:emfile">A.3</A>).</P><!--TOC subsubsection Running Tsung with a job scheduler-->
<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A NAME="htoc43">6.2.3</A>  Running Tsung with a job scheduler</H4><!--SEC END --><P>Tsung is able to get its client node list from a batch/job
-scheduler. It currently handle pbs/torque, LSF and OAR. To do this,
+scheduler. It currently handle PBS/torque, LSF and OAR. To do this,
set the <TT>type</TT> attribute to <FONT COLOR=purple>batch</FONT>, e.g.:</P><TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0><TR><TD><TABLE BORDER=0 CELLPADDING=0
CELLSPACING=0><TR><TD BGCOLOR=black COLSPAN="3"><TABLE CELLSPACING="1" CELLPADDING=0 BORDER=0><TR><TD>
</TD></TR>
@@ -1091,7 +1091,7 @@ <H4 CLASS="subsubsection"><!--SEC ANCHOR --><A NAME="htoc46">6.3.2</A>  SNMP</
</TABLE></TD></TR>
</TABLE></TD></TR>
</TABLE><P><TT>type</TT> can be <FONT COLOR=purple>sample</FONT>, <FONT COLOR=purple>counter</FONT> or
-<FONT COLOR=purple>sum</FONT>, and optionnaly you can define a function (with erlang
+<FONT COLOR=purple>sum</FONT>, and optionally you can define a function (with erlang
syntax) to be applied to the value (<TT>eval</TT> attribute).</P><!--TOC subsubsection Munin-->
<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A NAME="htoc47">6.3.3</A>  Munin</H4><!--SEC END --><P>Since version <B>1.3.1</B>, Tsung is able to retrieve data from a munin-node agent
(see <A HREF="http://munin.projects.linpro.no/wiki/munin-node"><TT>http://munin.projects.linpro.no/wiki/munin-node</TT></A>). The <TT>type</TT>
@@ -1332,7 +1332,7 @@ <H5 CLASS="paragraph"><!--SEC ANCHOR -->Rate_limit</H5><!--SEC END --><P>A new o
</TABLE><!--TOC paragraph Ports_range-->
<H5 CLASS="paragraph"><!--SEC ANCHOR -->Ports_range</H5><!--SEC END --><P>
If you need to open more than 30000 simultaneous connections on a
-client machine, you will be limited by the number of tcp client ports,
+client machine, you will be limited by the number of TCP client ports,
even if you use several IPs (this is true at least on Linux). To
bypass this limit, Tsung must not delegate the selection of client
ports and together with using several IP for each client,
@@ -2767,7 +2767,7 @@ <H5 CLASS="paragraph"><!--SEC ANCHOR -->JSONPath</H5><!--SEC END --><P>
</TABLE></TD></TR>
</TABLE><!--TOC paragraph PostgreSQL-->
<H5 CLASS="paragraph"><!--SEC ANCHOR -->PostgreSQL</H5><!--SEC END --><P>
-<B>New in 1.3.2!</B></P><P>Since the postgreSQL protocol is binary, regexp are not useful to
+<B>New in 1.3.2!</B></P><P>Since the PostgreSQL protocol is binary, regexp are not useful to
parse the output of the server. Instead, a specific parsing can be
done to extract content from the server’s response; to do this, use the
<TT>pgsql_expr</TT> attribute. Use <FONT COLOR=purple>data_row[L][C]</FONT> to
@@ -3248,7 +3248,7 @@ <H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc70">7</A>  Statistics and r
</P><!--TOC subsection File format-->
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc71">7.1</A>  File format</H3><!--SEC END --><P>By default, tsung use it’s own format (see FAQ <A HREF="#sec:what-format-stats">A.6</A>).</P><P>Since version 1.4.2, you can configure tsung to use a JSON format;
however in this case, the tools <TT>tsung_stats.pl</TT> and
-<TT>tsung_plotter</TT> will not work with the json files.</P><P>To enable JSON output, use:
+<TT>tsung_plotter</TT> will not work with the JSON files.</P><P>To enable JSON output, use:
</P><TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0><TR><TD><TABLE BORDER=0 CELLPADDING=0
CELLSPACING=0><TR><TD BGCOLOR=black COLSPAN="3"><TABLE CELLSPACING="1" CELLPADDING=0 BORDER=0><TR><TD>
</TD></TR>
@@ -3916,7 +3916,20 @@ <H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc93">C</A>  CHANGELOG</H2><!
CELLSPACING=0><TR><TD BGCOLOR=black COLSPAN="3"><TABLE CELLSPACING="1" CELLPADDING=0 BORDER=0><TR><TD>
</TD></TR>
</TABLE></TD></TR>
-<TR><TD><TABLE BORDER=0 CELLPADDING="1" CELLSPACING=0><TR><TD><PRE CLASS="verbatim"><I>1.4.0 -&gt; 1.4.1 Minor bugfixes (13 Sep 2011)
+<TR><TD><TABLE BORDER=0 CELLPADDING="1" CELLSPACING=0><TR><TD><PRE CLASS="verbatim"><I>1.4.1 -&gt; 1.4.2 Minor enhancements and bugfixes (4 Jan 2011)
+Bugfix:
+ * [TSUN-199] - computation of NUsers is wrong
+ * [TSUN-206] - build failure with erlang R15B
+Improvements:
+ * [TSUN-202] - IPv6 support
+ * [TSUN-203] - snmp oids should be customizable in the config file
+ * [TSUN-205] - handle dyn_variables as array in test conditions (if/until/while)
+New Features:
+ * [TSUN-191] - allow outputting log to stdout
+ * [TSUN-192] - structured log output (JSON)
+ * [TSUN-193] - accept configuration from stdin
+ * [TSUN-197] - Have bug and error message on stderr and not stdout.
+1.4.0 -&gt; 1.4.1 Minor bugfixes (13 Sep 2011)
Bugfix:
* [TSUN-188] - munin plugin is not working in 1.4.0
* [TSUN-189] - the controller VM is not used in some case
View
@@ -159,7 +159,7 @@ \subsection{Tsung main features}
different type of users during the same benchmark. You can define
the proportion of the various behaviours in the benchmark scenario.
\item \emph{Stochastic processes}: in order to generate a realistic traffic,
-user thinktimes and the arrival rate can be randomize using a probability
+user thinktimes and the arrival rate can be randomized using a probability
distribution (currently exponential)
\end{itemize}
@@ -364,7 +364,7 @@ \subsection{Running}
-m <file> write monitoring output on this file (default is tsung.log)
(use - for standard output)
-F use long names (FQDN) for erlang nodes
- -w warmup delay (default is 10 sec)
+ -w warm-up delay (default is 10 sec)
-v print version information and exit
-6 use IPv6 for tsung internal communications
-h display this help and exit
@@ -798,7 +798,7 @@ \subsubsection{Advanced setup}
used to take advantage of the number of CPU.
\begin{quote}
- \strong{Note:} Even if an Erlang VM is now able to handle severals CPUs
+ \strong{Note:} Even if an Erlang VM is now able to handle several CPUs
(erlang SMP), benchmarks shows that it's more efficient to use one VM
per CPU (with SMP disabled) for tsung clients. Only the controller node is using SMP
erlang. Therefore, \varname{cpu} should be equal to the number of cores of
@@ -807,7 +807,7 @@ \subsubsection{Advanced setup}
file).
\end{quote}
- By default, the load is distributed uniformly on all CPU (one cpu
+ By default, the load is distributed uniformly on all CPU (one CPU
per client by default). The weight parameter (integer) can be used to
take into account the speed of the client machine. For instance, if
one real client has a weight of 1 and the other client has a weight
@@ -830,7 +830,7 @@ \subsubsection{Advanced setup}
\subsubsection{Running Tsung with a job scheduler}
Tsung is able to get its client node list from a batch/job
-scheduler. It currently handle pbs/torque, LSF and OAR. To do this,
+scheduler. It currently handle PBS/torque, LSF and OAR. To do this,
set the \varname{type} attribute to \userinput{batch}, e.g.:
\begin{Verbatim}
@@ -920,7 +920,7 @@ \subsubsection{SNMP}
\end{Verbatim}
\varname{type} can be \userinput{sample}, \userinput{counter} or
-\userinput{sum}, and optionnaly you can define a function (with erlang
+\userinput{sum}, and optionally you can define a function (with erlang
syntax) to be applied to the value (\varname{eval} attribute).
\subsubsection{Munin}
@@ -1098,7 +1098,7 @@ \subsection{Setting options}
\paragraph{Ports\_range}
If you need to open more than 30000 simultaneous connections on a
-client machine, you will be limited by the number of tcp client ports,
+client machine, you will be limited by the number of TCP client ports,
even if you use several IPs (this is true at least on Linux). To
bypass this limit, Tsung must not delegate the selection of client
ports and together with using several IP for each client,
@@ -2190,7 +2190,7 @@ \subsubsection{Dynamic variables}\label{Dynamic variables}
\paragraph{PostgreSQL}
\strong{New in 1.3.2!}
-Since the postgreSQL protocol is binary, regexp are not useful to
+Since the PostgreSQL protocol is binary, regexp are not useful to
parse the output of the server. Instead, a specific parsing can be
done to extract content from the server's response; to do this, use the
\varname{pgsql\_expr} attribute. Use \userinput{data\_row[L][C]} to
@@ -2500,7 +2500,7 @@ \subsection{File format}
Since version 1.4.2, you can configure tsung to use a JSON format;
however in this case, the tools \command{tsung\_stats.pl} and
-\command{tsung\_plotter} will not work with the json files.
+\command{tsung\_plotter} will not work with the JSON files.
To enable JSON output, use:
\begin{Verbatim}

0 comments on commit e161ca1

Please sign in to comment.