commit 97ee235b00108f23b81d96efcc1f77e2acaeec4c
from: Dominik Lang <dominik@phildom.de>
date: Mon Apr 08 20:23:18 2024 UTC

Add a README with some explanations.

commit - 6bd8f90b8ec41e18a5f29bf3cb90fdb7c7028215
commit + 97ee235b00108f23b81d96efcc1f77e2acaeec4c
blob - /dev/null
blob + 6a88a0185899abd07590fc7d5451e96d2a0e545c (mode 644)
--- /dev/null
+++ README.md
@@ -0,0 +1,23 @@
+# Make things grepable and queryable (awkable)
+A collection of small scripts, mainly awk, to make the output of common tools
+and file formats more "grepable" and "queryable".
+
+The *from_scripts* transform the output into a line-based format.
+And the *query_scripts* are small and simple wrappers around awk, so that one
+can query the from_output with column names instead of the default column numbers.
+The query_scripts also make sure that only tabs are used as a delimiter for
+the input and output (as that is what the from_scripts create).
+
+For example:
+```
+cat scan.gnmap | from_gnmap | query_gnmap '$service == "ssh"'
+```
+
+One can then make the output prettier, if the default tab output isn't good enough
+with other tools, e.g.
+
+```
+cat scan.gnmap | from_gnmap | query_gnmap '$version ~ /Windows Kerberos/' | column -s "	" -t
+```
+
+Note: the optarg to -s of column is a tab.