doc: usage
This commit is contained in:
parent
8bfbb170eb
commit
586d67665d
1 changed files with 33 additions and 1 deletions
34
README.md
34
README.md
|
@ -31,7 +31,39 @@ zip LACAU-ALNET-TP1.zip tsock_v*.c README.md
|
|||
|
||||
## Running
|
||||
|
||||
TODO help output
|
||||
```
|
||||
usage: ./t_sockv1 <-u> [-ps] [host] <port>
|
||||
parameters: host With -s, address of the host to connect to. Required with -s.
|
||||
port Port to connect or bind to. Required.
|
||||
options: -p Runs a TCP/UDP sink. Incompatible with -s.
|
||||
-s Runs a TCP/UDP faucet. Incompatible with -p.
|
||||
-u Use UDP instead of TCP. Required.
|
||||
|
||||
usage: ./t_sockv2 [-psu] [host] <port>
|
||||
parameters: host With -s, address of the host to connect to. Required with -s.
|
||||
port Port to connect or bind to. Required.
|
||||
options: -p Runs a TCP/UDP sink. Incompatible with -s.
|
||||
-s Runs a TCP/UDP faucet. Incompatible with -p.
|
||||
-u Use UDP instead of TCP.
|
||||
|
||||
usage: ./t_sockv3 [-psu] [-n nb_messages] [-l mess_length] [host] <port>
|
||||
parameters: host With -s, address of the host to connect to. Required with -s.
|
||||
port Port to connect or bind to. Required.
|
||||
options: -l mess_length Size of the messages to send. Min 5. Max 1400. Default 30.
|
||||
-n nb_messages Number of messages to send. Min 1. Default 10. Ignored with -p.
|
||||
-p Runs a TCP/UDP sink. Incompatible with -s.
|
||||
-s Runs a TCP/UDP faucet. Incompatible with -p.
|
||||
-u Use UDP instead of TCP.
|
||||
```
|
||||
|
||||
Example usage of v3 :
|
||||
|
||||
```
|
||||
./t_sockv3 -p -l 15 4000 # receiver
|
||||
./t_sockv3 -s -l 15 localhost 4000 # sender
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Roadmap
|
||||
|
||||
|
|
Loading…
Reference in a new issue