Skip to content

Commit

Permalink
Some whitespace cleanup on the sipp-wip readthedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
wdoekes committed Apr 23, 2018
1 parent ed9beee commit 4d0c1dd
Show file tree
Hide file tree
Showing 20 changed files with 690 additions and 820 deletions.
21 changes: 8 additions & 13 deletions docs/3PCC_extended.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,29 +10,24 @@ mode. The others are launched in "slave" mode. Slave SIPp instances
have names, given in the command line (for example, s1, s2...sN for
the slaves and m for the master) Correspondances between instances
names and their addresses must be stored in a file (provided by
-slave_cfg command line argument), in the following format:
``-slave_cfg`` command line argument), in the following format::

::

s1;127.0.0.1:8080
s2;127.0.0.1:7080
m;127.0.0.1:6080
s1;127.0.0.1:8080
s2;127.0.0.1:7080
m;127.0.0.1:6080


Each SIPp instance must access a different copy of this file.

sendCmd and recvCmd have additional attributes:

::
sendCmd and recvCmd have additional attributes::

<sendCmd dest="s1">
<![CDATA[
Call-ID: [call_id]
From: m
[$1]
]]>

]]>
</sendCmd>


Expand Down Expand Up @@ -66,4 +61,4 @@ The arrows that are shown between SIPp master and slaves depict only
the synchronization commands exchanged between the different SIPp
instances. The SIP message exchange takes place as usual.

.. image:: master_slave.png
.. image:: master_slave.png
18 changes: 9 additions & 9 deletions docs/3pcc-C-A.xml
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,9 @@
<recv response="183" optional="true"> </recv>
<recv response="200" crlf="true" start_rtd="true">
<action>
<ereg regexp="Content-Type:.*"
search_in="msg"
assign_to="1" />
<ereg regexp="Content-Type:.*"
search_in="msg"
assign_to="1" />
</action>
</recv>

Expand All @@ -71,16 +71,16 @@
]]>
</sendCmd>

<recvCmd>
<action>
<ereg regexp="Content-Type:.*"
search_in="msg"
assign_to="2" />
<ereg regexp="Content-Type:.*"
search_in="msg"
assign_to="2" />
</action>

</recvCmd>

<send rtd="true">
<![CDATA[
Expand Down
18 changes: 9 additions & 9 deletions docs/3pcc-C-B.xml
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@

<recvCmd>
<action>
<ereg regexp="Content-Type:.*"
search_in="msg"
assign_to="1" />
<ereg regexp="Content-Type:.*"
search_in="msg"
assign_to="1" />
</action>
</recvCmd>

Expand All @@ -68,13 +68,13 @@
<recv response="183" optional="true"> </recv>
<recv response="200" crlf="true">
<action>
<ereg regexp="Content-Type:.*"
search_in="msg"
assign_to="2" />
<ereg regexp="Content-Type:.*"
search_in="msg"
assign_to="2" />
</action>
</recv>


<send start_rtd="true">
<![CDATA[
Expand All @@ -99,7 +99,7 @@
]]>
</sendCmd>

<pause milliseconds="1000"/>


Expand Down
2 changes: 1 addition & 1 deletion docs/_static/theme_overrides.css
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@

span.menuselection {
color: blue;
font-family: monospace, "Courier New", Courier
font-family: monospace, "Courier New", Courier
}

code.kbd, code.kbd span {
Expand Down
46 changes: 23 additions & 23 deletions docs/controlling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@ and also a simple command mode. The hot keys are:
===== ======
Key Action
===== ======
\+ Increase the call rate by 1 * rate_scale
\* Increase the call rate by 10 * rate_scale
\- Decrease the call rate by 1 * rate_scale
/ Decrease the call rate by 10 * rate_scale
c Enter command mode
q Quit SIPp (after all calls complete, enter a second time to quit immediately)
Q Quit SIPp immediately s Dump screens to the log file (if -trace_screen is passed)
p Pause traffic
1 Display the scenario screen
2 Display the statistics screen
3 Display the repartition screen
4 Display the variable screen
5 Display the TDM screen
\+ Increase the call rate by 1 * rate_scale
\* Increase the call rate by 10 * rate_scale
\- Decrease the call rate by 1 * rate_scale
/ Decrease the call rate by 10 * rate_scale
c Enter command mode
q Quit SIPp (after all calls complete, enter a second time to quit immediately)
Q Quit SIPp immediately s Dump screens to the log file (if -trace_screen is passed)
p Pause traffic
1 Display the scenario screen
2 Display the statistics screen
3 Display the repartition screen
4 Display the variable screen
5 Display the TDM screen
6-9 Display the second through fifth repartition screen.
===== ======

Expand All @@ -35,14 +35,14 @@ commands are available:
List of Interactive Commands
````````````````````````````

- ``dump tasks`` Prints a list of active tasks (most tasks are calls) to the error log. dump tasks
- ``set rate X`` Sets the call rate. set rate 10
- ``set rate-scale X`` Sets the rate scale, which adjusts the speed of '+', '-', '*', and '/'. set rate-scale 10
- ``set users X`` Sets the number of users (only valid when -users is specified). set rate 10
- ``set limit X`` Sets the open call limit (equivalent to -l option) set limit 100
- ``set hide <true|false>`` Should the hide XML attribute be respected? set hide false
- ``set index <true|false>`` Display message indexes in the scenario screen. set index true
- ``set display <main|ooc>`` Changes the scenario that is displayed to either the main or the out-of-call scenario. set display main set display ooc
- ``dump tasks`` Prints a list of active tasks (most tasks are calls) to the error log. dump tasks
- ``set rate X`` Sets the call rate. set rate 10
- ``set rate-scale X`` Sets the rate scale, which adjusts the speed of '+', '-', '*', and '/'. set rate-scale 10
- ``set users X`` Sets the number of users (only valid when -users is specified). set rate 10
- ``set limit X`` Sets the open call limit (equivalent to -l option) set limit 100
- ``set hide <true|false>`` Should the hide XML attribute be respected? set hide false
- ``set index <true|false>`` Display message indexes in the scenario screen. set index true
- ``set display <main|ooc>`` Changes the scenario that is displayed to either the main or the out-of-call scenario. set display main set display ooc
- ``trace <log> <on|off>`` Turns log on or off at run time. Valid values for log are "error", "logs", "messages", and "shortmessages". trace error on


Expand Down Expand Up @@ -75,7 +75,7 @@ the command line:
+ "-r" to specify the call rate in number of calls per seconds
+ "-rp" to specify the " r ate p eriod" in milliseconds for the call
rate (default is 1000ms/1sec). This allows you to have n calls every m
milliseconds (by using -r n -rp m).
milliseconds (by using -r n -rp m).

.. note:: Example: run SIPp at 7 calls every 2 seconds (3.5 calls per second)

Expand Down Expand Up @@ -154,4 +154,4 @@ minute and exit SIPp:


To send a command to SIPp, preface it with 'c'. For example: ``echo
"cset rate 100" >/dev/udp/127.0.0.1/8888 sets the call rate to 100.``
"cset rate 100" >/dev/udp/127.0.0.1/8888 sets the call rate to 100.``
2 changes: 0 additions & 2 deletions docs/foreword.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,3 @@ Want to see it?
Here is a screenshot

.. figure:: sipp-01.jpg


1 change: 0 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ Welcome to SIPp reference documentation!
error
perftest
tools




Expand Down
87 changes: 34 additions & 53 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,8 @@ Installing SIPp

+ On Linux, SIPp is provided in the form of source code. You will need
to compile SIPp to actually use it.
+ Pre-requisites to compile SIPp are :

+ Pre-requisites to compile SIPp are:

+ C++ Compiler
+ curses or ncurses library
Expand All @@ -69,68 +70,48 @@ Installing SIPp

+ You have four options to compile SIPp:

+ Without TLS (Transport Layer Security), SCTP or PCAP support : -
This is the recommended setup if you don't need to handle SCTP, TLS or
PCAP.

::

# tar -xvzf sipp-xxx.tar
# cd sipp
# ./configure
# make


+ With TLS support,
you must have installed `OpenSSL library`_ (>=0.9.8) (which may come
with your system). Building SIPp consists only in adding the "--with-openssl"
option to the configure command:

::

# tar -xvzf sipp-xxx.tar.gz
# cd sipp
# ./configure --with-openssl
# make


+ With PCAP play support :

::

# tar -xvzf sipp-xxx.tar.gz
# cd sipp
# ./configure --with-pcap
# make
+ Without TLS (Transport Layer Security), SCTP or PCAP support --
this is the recommended setup if you don't need to handle SCTP, TLS or
PCAP::

tar -xvzf sipp-xxx.tar
cd sipp
./configure
make

+ With SCTP support :
+ With TLS support, you must have installed `OpenSSL library`_
(>=0.9.8) (which may come with your system). Building SIPp
consists only of adding the ``--with-openssl`` option to the
configure command::

::
tar -xvzf sipp-xxx.tar.gz
cd sipp
./configure --with-openssl
make

# tar -xvzf sipp-xxx.tar.gz
# cd sipp
# ./configure --with-sctp
# make
+ With PCAP play support::

tar -xvzf sipp-xxx.tar.gz
cd sipp
./configure --with-pcap
make

+ You can also combine these various options, e.g.: :
+ With SCTP support::

::
tar -xvzf sipp-xxx.tar.gz
cd sipp
./configure --with-sctp
make

# tar -xvzf sipp-xxx.tar.gz
# cd sipp
# ./configure --with-sctp --with-pcap --with-openssl
# make
+ You can also combine these various options, e.g.::

tar -xvzf sipp-xxx.tar.gz
cd sipp
./configure --with-sctp --with-pcap --with-openssl
make


.. warning::
.. warning::
SIPp compiles under CYGWIN on Windows, provided that you
installed IPv6 extension for `CYGWIN <http://win6.jp/Cygwin/>`_, as
well as libncurses and (optionally OpenSSL and WinPcap). SCTP is not
Expand All @@ -148,4 +129,4 @@ Installing SIPp
.. _WinPcap developer package: http://www.winpcap.org/devel.htm
.. _hewlett-packard: http://www.hp.com/
.. _SIPp's master tree: https://github.com/SIPp/sipp/tree/master
.. _OpenSSL library: http://www.openssl.org/
.. _OpenSSL library: http://www.openssl.org/
Loading

0 comments on commit 4d0c1dd

Please sign in to comment.