Update lwAFTR query documentation

snabbco · Aug 26, 2016 · b69925f · b69925f
1 parent 58691a2
commit b69925f
Showing 1 changed file with 10 additions and 4 deletions.
diff --git a/src/program/lwaftr/query/README b/src/program/lwaftr/query/README
@@ -1,14 +1,20 @@
 Usage:
-  query [OPTIONS] [<pid>] [<counter-name>]
+  query [OPTIONS] [<id>] [<counter-name>]
 
 Options:
 
   -h, --help                    Print usage information.
   -l, --list-all                List all available counter names.
 
-Display current statistics from lwAftr counters for a running Snabb instance
-with <pid>. If <pid> is not supplied and there is only one Snabb instance,
-"query" will connect to that instance.
+Display current statistics from lwAFTR counters for a running Snabb instance
+with <id>.  <id> can be either a PID or a string ID:
+
+   * If it is a PID, <id> should exists at /var/run/snabb/<id>.
+   * If it is a string ID, <id> should match the value defined
+     in /var/run/snabb/*/nic/id.
+
+If <pid> is not supplied and there is only one Snabb instance, "query" will
+connect to that instance.
 
 If <counter-name> is set, only counters partially matching <counter-name> are
 listed.