From: Felix Fietkau <nbd@nbd.name>
Date: Wed, 3 Nov 2021 14:36:37 +0000 (+0100)
Subject: README: document mapping file syntax
X-Git-Url: http://git.cdn.openwrt.org/?a=commitdiff_plain;h=3ed8c3eb1a3b52d8ed0ec8588c30b82adec85247;p=project%2Fqosify.git

README: document mapping file syntax

Signed-off-by: Felix Fietkau <nbd@nbd.name>
---

diff --git a/README b/README
index 7b191db..863ba6b 100644
--- a/README
+++ b/README
@@ -87,6 +87,27 @@ interface/device properties:
 	CAKE options for ingress + egress
 
 
+Mapping file syntax:
+
+Each line has two whitespace separated fields, match and dscp
+match is one of:
+- tcp:<port>[-<endport>]
+	TCP single port, or range from <port> to <endport>
+- udp:<port>[-<endport>]
+	UDP single port, or range from <port> to <endport>
+- <ipaddr>
+	IPv4 address, e.g. 1.1.1.1
+- <ipv6addr>
+	IPv6 address, e.g. ff01::1
+- dns:<regex>
+	POSIX.2 extended regular expression for matching hostnames
+	Only works, if dns lookups are passed to qosify via the add_dns_host ubus call.
+
+dscp can be a raw value, or a codepoint like CS0
+Adding a + in front of the value tells qosify to only override the DSCP value if it is non-zero
+
+
+
 Planned features:
 - Integration with dnsmasq to support hostname pattern based DSCP marking
 - Support for LAN host based priority