From 004d778e79c812568757c9345edf1ae3b90a1b77 Mon Sep 17 00:00:00 2001 From: Steffen Vogel Date: Thu, 11 Feb 2016 20:14:12 +0100 Subject: [PATCH] updated documentation for s2ss-signal --- doc/Tools.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/doc/Tools.md b/doc/Tools.md index 3751e0d6f..4d534cbd1 100644 --- a/doc/Tools.md +++ b/doc/Tools.md @@ -31,11 +31,14 @@ The `pipe` subcommand allows to read and write samples to `stdin` / `stdout`. The `signal` subcommand is a signal generator which writes samples to `stdout`. This command can be combined with the `pipe` subcommand. - Usage: s2ss-signal SIGNAL VALUES RATE [LIMIT] - SIGNAL is on of: mixed random sine triangle square - VALUES is the number of values a message contains - RATE how many messages per second - LIMIT only send LIMIT messages + Usage: s2ss-signal SIGNAL [OPTIONS] + SIGNAL is on of: 'mixed', 'random', 'sine', 'triangle', 'square', 'ramp' + -v NUM specifies how many values a message should contain + -r HZ how many messages per second + -f HZ the frequency of the signal + -a FLT the amplitude + -d FLT the standard deviation for 'random' signals + -l NUM only send LIMIT messages and stop ### `s2ss test`