Skip to content

Commit ae6671e

Browse files
author
Lukas Hutak
committed
fdsdump: minor documentation improvements
1 parent 16d0784 commit ae6671e

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/tools/fdsdump/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# fdsdump
1+
# fdsdump [preview]
22

33
Reads flow data stored in fdsdump format and displays them in a specified way.
44

@@ -27,9 +27,9 @@ Supports sorting, filtering, aggregation, and selection of fields to display. Di
2727
## Modes
2828
### Statistics mode
2929

30-
Selected using the -I flag
30+
Selected using the `-I` flag
3131

32-
Prints basic information about the flows contained in the fds files, such as packet counts, byte counts, flow counts in either directions in case of biflow.
32+
Prints basic information about the flows contained in the FDS files, such as packet counts, byte counts, flow counts in either directions in case of biflow.
3333

3434

3535
### Lister mode
@@ -43,7 +43,7 @@ TBD
4343

4444
## Output formats
4545

46-
- `JSON-RAW` — prints flow records in the json format with all their fields
46+
- `json-raw` — prints flow records in the json format with all their fields
4747
- `json` — json output of selected fields
4848
- `table` — table output of selected fields
4949

@@ -106,7 +106,7 @@ Example usage
106106

107107
- Write out all the flow records in JSON format
108108
```
109-
fdsdump -r ./flows.fds -o 'JSON-RAW'
109+
fdsdump -r ./flows.fds -o 'json-raw'
110110
```
111111
112112
- Write out the source IP, source port, destination IP, destination port, number of packets and number of bytes of each flow in JSON format.

0 commit comments

Comments
 (0)