Skip to content

Commit 2612cc2

Browse files
committed
Further documentation improvements.
1 parent 3eaf111 commit 2612cc2

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -275,13 +275,13 @@ kldstat | grep sctp
275275

276276
NetPerfMeter supports randomised frame rate and frame size, to create variable bitrate (VBR) flows. The following distributions are currently available:
277277

278-
* const<value>: Constant, i.e. always the same. Example: a frame rate const1000 for means all frames have a size of 1000&nbsp;bytes.
279-
* uniform&lt;a&gt;,&lt;b&gt;: Uniformly distributed from the interval [a,b). Example: uniform900,1100.
280-
* exp&lt;p&gt;: Exponential distribution with mean &lt;mean&gt;. Example: exp1000.
281-
* pareto&lt;location&gt;,&lt;shape&gt;: Pareto distribution with location &lt;location&gt; and shape &lt;shape&gt;. Example: pareto0.166667,1.5.
282-
* normal&lt;mean&gt;,&lt;stddev&gt;: Normal distribution with mean &lt;mean&gt; and standard deviation &lt;stddev&gt;. Example: normal1000,500.
278+
* <tt>const<em>&lt;value&gt;</em>,<em>&lt;b&gt;</em></tt>: Constant, i.e.&nbsp;always the same setting <em>&lt;value&gt;</em>. Example: a frame rate const1000 means that all frames have a size of 1000&nbsp;bytes.
279+
* <tt>uniform<em>&lt;a&gt;</em>,<em>&lt;b&gt;</em></tt>: Uniform distribution from the interval [a,b). Example: uniform900,1100.
280+
* <tt>exp<em>&lt;p&gt;</em></tt>: Exponential distribution with mean <em>&lt;mean&gt;</em>. Example: exp1000.
281+
* <tt>pareto<em>&lt;location&gt;</em>,<em>&lt;shape&gt;</em></tt>: Pareto distribution with location <em>&lt;location&gt;</em> and shape <em>&lt;shape&gt;</em>. Example: pareto0.166667,1.5.
282+
* <tt>normal<em>&lt;mean&gt;</em>,<em>&lt;stddev&gt;</em></tt>: Normal distribution with mean <em>&lt;mean&gt;</em> and standard deviation <em>&lt;stddev&gt;</em>. Example: normal1000,500.
283283
Note that normal distribution may result in negative values, which may be ignored (frame size) or interpreted as saturated traffic (frame rate). Use truncnormal to prevent negative values.
284-
* truncnormal&lt;mean&gt;,&lt;stddev&gt;: Truncated normal distribution with mean &lt;mean&gt; and standard deviation &lt;stddev&gt;, i.e. normal distribution without negative values. Example: truncnormal1000,500.
284+
* <tt>truncnormal<em>&lt;mean&gt;</em>,<em>&lt;stddev&gt;</em></tt>: Truncated normal distribution with mean <em>&lt;mean&gt;</em> and standard deviation <em>&lt;stddev&gt;</em>, i.e. normal distribution without negative values. Example: truncnormal1000,500.
285285

286286
A configured distribution is used to determine:
287287

src/netperfmeter.1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -203,9 +203,9 @@ Frame rate and frame size may be distributed randomly, using different random di
203203
The following distributions are supported:
204204
.Bl -tag -width indent
205205
.It const<value>
206-
Constant, i.e. always the same. Example: a frame rate const1000 for means all frames have a size of 1000 bytes.
206+
Constant, i.e. always the same. Example: a frame rate const1000 means that all frames have a size of 1000 bytes.
207207
.It uniform<a>,<b>
208-
Uniformly distributed from the interval [a,b). Example: uniform900,1100.
208+
Uniform distribution from the interval [a,b). Example: uniform900,1100.
209209
.It exp<mean>
210210
Exponential distribution with mean <mean>. Example: exp1000.
211211
.It pareto<location>,<shape>

0 commit comments

Comments
 (0)