]> the.earth.li Git - mqtt-arp.git/commitdiff
Updated README main
authorclaes <claes@holmerson.net>
Sat, 10 Jun 2023 20:20:50 +0000 (22:20 +0200)
committerJonathan McDowell <noodles@earth.li>
Tue, 11 Jul 2023 17:36:08 +0000 (18:36 +0100)
README.md

index a84fef841167c56e138edc335d6925314dd73f17..d00b2697a9c1e488a6c9aa3e624e226c3fe92378 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,7 +2,8 @@
 
 Rather than reporting all MAC addresses seen ```mqtt-arp``` takes a list of MACs to watch for. I have this configured for my phone, resulting in a reasonable proxy for whether I am home or not. ```mqtt-arp``` will report as soon as the device is seen, and send rate-limited (at most once every 2 minutes) updates when it is seen again. If the device is not seen for at least 10 minutes the location will be reported as "unknown".
 
-There is basic configuration file support; by default ```mqtt-arp``` will read ```/etc/mqtt-arp.conf```. The following aspects can be configured at run time:
+There is basic configuration file support; by default ```mqtt-arp``` will read ```/etc/mqtt-arp.conf```. The location can be overridden, see below. 
+The following aspects can be configured at run time:
 
  * MQTT host (-h / --host / mqtt_host)
  * MQTT post (-p / --port / mqtt_port)
@@ -12,5 +13,6 @@ There is basic configuration file support; by default ```mqtt-arp``` will read `
  * Location to report when device is present (-l / --location / location)
  * Path to SSL certificate bundle (-c / --capath / capath)
  * MAC addresses to watch for  (-m / --mac / mac)
+ * Read config file at specific location (-f / --configfile / file path)
 
 This code is released as GPLv3+ and is available at [https://the.earth.li/gitweb/?p=mqtt-arp.git;a=summary](https://the.earth.li/gitweb/?p=mqtt-arp.git;a=summary) or on GitHub for easy whatever at [https://github.com/u1f35c/mqtt-arp](https://github.com/u1f35c/mqtt-arp)