From 9b7893909685828bc82eb7e943467217bec8a7c9 Mon Sep 17 00:00:00 2001 From: Toni Uhlig <matzeton@googlemail.com> Date: Wed, 16 Nov 2022 22:25:18 +0100 Subject: Updated README's. Signed-off-by: Toni Uhlig <matzeton@googlemail.com> --- README.md | 6 ++---- examples/README.md | 8 +++++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4cf8ed728..16c203284 100644 --- a/README.md +++ b/README.md @@ -210,8 +210,7 @@ Of course, both `ncat` and `nDPId` need to point to the same UNIX-socket (`nDPId You also need to provide `nDPId` some real-traffic. You can capture your own traffic, with something similar to: ```shell -ncat -U /tmp/listen.sock -l -k -#socat UNIX-Listen:/tmp/listen.sock,fork - # does the same as `ncat` +socat -u UNIX-Listen:/tmp/listen.sock,fork - # does the same as `ncat` sudo chown nobody:nobody /tmp/listen.sock # default `nDPId` user/group, see `-u` and `-g` sudo ./nDPId -c /tmp/listen.sock -l ``` @@ -219,8 +218,7 @@ sudo ./nDPId -c /tmp/listen.sock -l `nDPId` supports also UDP collector endpoints: ```shell -ncat -u 127.0.0.1 7000 -l -k -#socat UDP-Listen:7000,fork - # does the same as `ncat` +nc -d -u 127.0.0.1 7000 -l -k sudo ./nDPId -c 127.0.0.1:7000 -l ``` diff --git a/examples/README.md b/examples/README.md index eb00539d9..5df11d607 100644 --- a/examples/README.md +++ b/examples/README.md @@ -7,6 +7,7 @@ All examples are prefixed with their used LANG. A feature extractor useful for ML/DL use cases. It generates CSV files from flow "analyse" events. +Used also by `tests/run_tests.sh` if available. ## c-captured @@ -23,7 +24,7 @@ Tiny nDPId json dumper. Does not provide any useful funcationality besides dumpi ## c-simple -Very tiny integration example. +Integration example that verifies flow timeouts on SIGUSR1. ## js-rt-analyzer @@ -31,7 +32,8 @@ Very tiny integration example. ## py-flow-info -Prints prettyfied information about flow events. +Console friendly, colorful, prettyfied event printer. +Required by `tests/run_tests.sh` ## py-machine-learning @@ -55,7 +57,7 @@ Simple Python Multiprocess example spawning two worker processes, one connecting ## py-json-stdout -Dump received and parsed JSON strings. +Dump received and parsed JSON objects. ## py-schema-validation -- cgit v1.2.3