From 50b296141c7c664f6b3c44477bb3f3345b4570fc Mon Sep 17 00:00:00 2001 From: Johannes Truschnigg Date: Fri, 2 Sep 2022 22:27:12 +0200 Subject: [PATCH] Source code comments have become outdated/misleading - fix --- sqm_lagthrottle.sh | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/sqm_lagthrottle.sh b/sqm_lagthrottle.sh index b925077..de083e6 100755 --- a/sqm_lagthrottle.sh +++ b/sqm_lagthrottle.sh @@ -15,18 +15,15 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . -# This file needs to be run with '__lagdetec.awk' in your current working -# directory. Please take the time to review and set all applicable options -# below under CONFIGURATION. If you fail to do so, the script will probably do -# more harm than good. Please be aware that this is work in progress, and the -# main application logic is implemented in the awk script. +# This file needs to be run with '__sqm_lagthrottle.awk' in your current +# working directory. Please take the time to review and set all applicable +# options below under CONFIGURATION. If you fail to do so, the script will +# probably do more harm than good. Please be aware that this is work in +# progress, and the main application logic is implemented in the awk script. -# CONFIGURATION - adapt these variables to yor needs -# These will be docmented once this is finished - promise ;) - -# HINT: You may want to use sqm_lagthrottle_suggest_config.sh from this -# distribution to get (hopefully) sensible configration values for FUDGE_MS and -# PING_PEERS. +# HINT: You may want to use `sqm_lagthrottle_suggest_config.sh` from this +# distribution to get (hopefully) sensible configuration values for most of +# the below settings! FUDGE_MS=20.0 # "fudge" factor in msec that your PING_PEERS are expected to fluctuate in latency under normal conditions PING_PEERS='1.1.1.1 8.8.8.8' # space-separated list of peer addresses to ping @@ -34,8 +31,8 @@ BW_MIN_RX=4000 # CHANGE THIS - your min. acceptable downstream bandwidth to shap BW_MAX_RX=30000 # CHANGE THIS - your max. desired downstream bandwidth to shape to in Kbps STATS_RX='/sys/class/net/ifb4eth1/statistics/tx_bytes' # CHANGE THIS - downstream bandwidth accounting file for your SQM'd interface IFACE_RX='ifb4eth1' # CHANGE THIS - interface to apply downstream SQM to -STATS_TX='/sys/class/net/eth1/statistics/tx_bytes' # CHANGE THIS - upstream bandwidth accounting file for your SQM'd interface (presently not used) -IFACE_TX='eth1' # CHANGE THIS - interface to apply upstream SQM to (presently not used) +STATS_TX='/sys/class/net/eth1/statistics/tx_bytes' # CHANGE THIS - upstream bandwidth accounting file for your SQM'd interface (presently unused) +IFACE_TX='eth1' # CHANGE THIS - interface to apply upstream SQM to (presently unused) TREND_DECISION="eager" # choose either "eager" or "relaxed" - the latter trades additional CPU load for quicker decision making OPTIMIZATION_PREFERENCE="latency" # try to optimize for either "latency" (i.e., minimze it) or increased "bandwidth" -- 2.39.5