diff mbox

batctl: modify tt sections in the README

Message ID 1321199897-21468-1-git-send-email-ordex@autistici.org (mailing list archive)
State Accepted, archived
Commit dbb5934f13cbe3ab90416cb735620ec8b86e85c4
Headers

Commit Message

Antonio Quartulli Nov. 13, 2011, 3:58 p.m. UTC 
  translocal and transglobal section updated in the README file

Signed-off-by: Antonio Quartull <ordex@autistici.org>
---
 README |   45 +++++++++++++++++++++++++++++++++++----------
 1 files changed, 35 insertions(+), 10 deletions(-)

Comments

Marek Lindner Nov. 13, 2011, 6:49 p.m. UTC | #1 
On Sunday, November 13, 2011 23:58:17 Antonio Quartull wrote:
> translocal and transglobal section updated in the README file

Applied in revision dbb5934.

Thanks,
Marek
diff mbox

Patch

diff --git a/README b/README
index 442f8b6..fc0a85e 100644
--- a/README
+++ b/README
@@ -313,7 +313,21 @@  Example:
 
 $ batctl translocal
 Locally retrieved addresses (from bat0) announced via TT:
- * d6:e0:fd:d9:00:00
+ * d6:e0:fd:d9:00:00 [RPNXW]
+
+In particular, RPNXW are flags which have the following meanings:
+
+- R/Roaming: this client moved to another node but it is still kept for
+		consistency purposes up to the next OGM sending.
+- P/noPurge: this client represents the local soft interface and has to never be
+		deleted.
+- N/New: this client has recently been added but it has to not be advertised up
+		to the next OGM sending (for consistency purposes).
+- X/delete: this client has to be removed for some reason, but it is still kept
+		for consistency purposes up to the next OGM sending.
+- W/Wireless: this client is connected to the node through a Wireless device.
+
+If any of the flags is not enabled, a '.' will substitute its symbol.
 
 batctl transglobal
 ==================
@@ -324,15 +338,26 @@  Usage: batctl transglobal|tg
 
 Example:
 
-Globally announced TT entries received via the mesh (translation table):
- * 16:aa:c4:a2:00:00 via fe:fe:00:00:09:01
- * 5a:32:f9:df:00:00 via fe:fe:00:00:03:01
- * 32:ae:5a:00:00:00 via fe:fe:00:00:04:01
- * 86:88:80:29:00:00 via fe:fe:00:00:08:01
- * 9e:d8:72:f2:00:00 via fe:fe:00:00:02:01
- * 76:84:68:49:00:00 via fe:fe:00:00:05:01
- * 86:4b:b2:d2:00:00 via fe:fe:00:00:07:01
- * ca:a1:5b:e5:00:00 via fe:fe:00:00:06:01
+Globally announced TT entries received via the mesh bat0
+   Client	     (TTVN)     Originator        (Curr TTVN) Flags
+ * 16:aa:c4:a2:00:00  ( 12) via fe:fe:00:00:09:01       ( 50) [RXW]
+
+where:
+- TTVN: is the translation-table-version-number which introduced this
+		client
+- Curr TTVN: is the translation-table-version-number currently advertised by
+		the originator serving this client (different clients
+		advertised by the same originator have the same Curr TTVN)
+- Flags that mean:
+	- R/Roaming: this client moved to another node but it is still kept for
+		consistency purposes up to the next OGM received from its
+		originator
+	- X/delete: this client has to be removed for some reason, but it is
+		still kept for consistency purposes.
+	- W/Wireless: this client is connected to the node through a Wireless
+		device.
+
+If any of the flags is not enabled, a '.' will substitute its symbol.
 
 batctl vis_mode
 =================