From f72849911653de9239f3b32359f38b0c5ed90ac6 Mon Sep 17 00:00:00 2001
From: Marco Trinelli <marcotrinelli@gmail.com>
Date: Tue, 6 Apr 2021 11:11:02 +0200
Subject: [HICN-692] Fix deb package installation of packethicn

Signed-off-by: Marco Trinelli <marcotrinelli@gmail.com>
Change-Id: I3c916807904d78c17a3444808f904b9c0cf0a4f5
---
 docs/source/packethicn.md | 50 +++++++++++++++++++++++++++++++++++++----------
 1 file changed, 40 insertions(+), 10 deletions(-)

(limited to 'docs/source/packethicn.md')

diff --git a/docs/source/packethicn.md b/docs/source/packethicn.md
index 3d3424d71..cf4976837 100644
--- a/docs/source/packethicn.md
+++ b/docs/source/packethicn.md
@@ -9,11 +9,21 @@ The `packethicn` plugin adds support to Wireshark to parse and dissect HICN traf
 
 2. As a standalone component (see [Standalone build](#Standalone-build))
 
-The second one is preferred if `HICN` is already installed in the system.
+The second one is preferred if HICN is already installed in the system.
 
-# Build with HICN
+# Supported platforms
+`packethicn` has been tested in
 
-## Dependencies
+- Ubuntu 18.04
+- Ubuntu 20.04
+- macOS 11.2
+
+Other platforms and architectures may work.
+
+# Installation 
+## Build with HICN
+
+### Dependencies
 
 ```bash
 $ sudo add-apt-repository ppa:wireshark-dev/stable
@@ -22,7 +32,7 @@ $ sudo apt install -y build-essential cmake wireshark wireshark-dev libgcrypt-de
 
 ```
 
-## Build and install
+### Build and install
 
 From the root HICN dir add the `-DBUILD_WSPLUGIN` flag to cmake.
 
@@ -39,10 +49,10 @@ $ sudo make install
 
 ```
 
-# Standalone build
-## Linux (Ubuntu)
+## Standalone build
+### Linux (Ubuntu)
 
-### Install dependencies
+#### Install dependencies
 ```bash
 $ sudo add-apt-repository ppa:wireshark-dev/stable
 
@@ -51,7 +61,7 @@ $ curl -s https://packagecloud.io/install/repositories/fdio/release/script.deb.s
 $ sudo apt install -y build-essential cmake libhicn-dev wireshark wireshark-dev libgcrypt-dev libgnutls28-dev
 
 ```
-### Compile and install HICN plugin
+#### Compile and install HICN plugin
 ```bash
 $ cd packethicn
 
@@ -65,7 +75,7 @@ $ sudo make install
 ```
 
 
-## macOS
+### macOS
 If installing wireshark via brew use the `./install_macos.sh` script as shown below:
 
 ```bash
@@ -94,4 +104,24 @@ $ cmake ..
 $ make
 
 $ sudo make install
-```
\ No newline at end of file
+```
+
+# Usage
+
+## Filters
+
+| Filter | Description | Example |
+| --- | --- | --- |
+| `hicn`  | HICN traffic only  | *hicn* |
+| `hicn.l3.src`  | Source address / Name Prefix (of data)  | *hicn.l3.src == b001::a8f:ae2a:bd5b:0:0* |
+| `hicn.l3.dst`  | Destination address / Name Prefix (of interest)  | *hicn.l3.dst == b001::a8f:ae2a:bd5b:1111:0* |
+| `hicn.l4.namesuffix `  | Name Suffix  | *hicn.l4.namesuffix == 0x21* |
+| `hicn.l4.pathlabel `  | Path Label  | *hicn.l4.pathlabel == 0xbb* |
+| `hicn.l4.timescale `  | Timescale  | *hicn.l4.timescale == 4* |
+| `hicn.l4.flags `  | Flags  | *hicn.l4.flags == 0x42* |
+| `hicn.l4.flags.id `  |  ID Flag | *hicn.l4.flags.<span></span>id == 1* |
+| `hicn.l4.flags.man `  |  MAN Flag | *hicn.l4.flags.man == 0* |
+| `hicn.l4.flags.sig `  | SIG Flag | *hicn.l4.flags.sig == 0* |
+| `hicn.l4.ldr `  | Loss Detection and Recovery | *hicn.l4.ldr > 0* |
+| `hicn.l4.csum `  | Checksum | *hicn.l4.csum > 0* |
+| `hicn.l4.lifetime `  | Lifetime | *hicn.l4.lifetime == 1000* |
-- 
cgit 1.2.3-korg