From 92c569ce3c33c5cb5f13c5c1d0b95d45e19099a2 Mon Sep 17 00:00:00 2001 From: Stephen Seo Date: Tue, 8 Feb 2022 13:05:12 +0900 Subject: [PATCH] Update README.md --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index b7bc975..8e88c0e 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,31 @@ It simply reads from `/proc/net/dev` to obtain byte-counts of the specified network interface and writes to four files, two of which keep track of the total byte count for sending and receiving, and the other two contain the "diffs" for each (configurable) interval (by default 5 seconds). +rust_network_status_rate 0.1.0 + + USAGE: + rust_network_status_rate [FLAGS] [OPTIONS] + + FLAGS: + -s, --disable-scaling Disables byte scaling into interval files + -e, --enable-alt-prefix Enable use of alternate prefix instead of XDG_RUNTIME_DIR + -h, --help Prints help information + -V, --version Prints version information + + OPTIONS: + -p, --prefix Prefix to use instead of XDG_RUNTIME_DIR if enabled [default: /tmp] + -r, --recv-interval + Filename of interval bytes recieved (in prefix dir) [default: rust_recv_interval] + + -d, --recv-total + Filename of total bytes received (in prefix dir) [default: rust_recv_total] + + -s, --send-interval + Filename of interval bytes sent (in prefix dir) [default: rust_send_interval] + + -u, --send-total + Filename of total bytes sent (in prefix dir) [default: rust_send_total] + + + ARGS: +