summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAram Drevekenin <aram@poor.dev>2019-11-05 20:53:00 +0100
committerGitHub <noreply@github.com>2019-11-05 20:53:00 +0100
commitaad8aa41f572c0604cbf2672d185058393f784b0 (patch)
treee281e44e00ab423722d29b25a5d9d5845f29f9fb /README.md
parente7640b3fa004c9708298719ec023d6c9616e2545 (diff)
docs(readme): raw mode
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 18 insertions, 1 deletions
diff --git a/README.md b/README.md
index a3deea0..3e3e0f6 100644
--- a/README.md
+++ b/README.md
@@ -20,10 +20,27 @@ cargo install what
Important note: There is only support for linux at the moment, mostly because I don't have access to anything else. I'd very much welcome contributions, and would be happy to provide guidance. Open up an issue/pr if interested.
### Usage
-`what -i <interface-name>` eg. `what -i eth0`
+```
+USAGE:
+ what [FLAGS] --interface <interface>
+
+FLAGS:
+ -h, --help Prints help information
+ -n, --no-resolve Do not attempt to resolve IPs to their hostnames
+ -r, --raw Machine friendlier output
+ -V, --version Prints version information
+
+OPTIONS:
+ -i, --interface <interface> The network interface to listen on, eg. eth0
+```
Note that since `what` sniffs network packets, it requires root privileges - so you might want to use it with (for example) `sudo`.
+### raw_mode
+`what` also supports an easier-to-parse mode that can be piped or redirected to a file. For example, try:
+```
+what -i eth0 | grep firefox
+```
### Contributing
Contributions of any kind are very welcome. If you'd like a new feature (or found a bug), please open an issue or a PR.