diff --git a/.markdownlint.json b/.markdownlint.json index 6326377..5883b5b 100644 --- a/.markdownlint.json +++ b/.markdownlint.json @@ -24,8 +24,7 @@ "img", "strong", "p", - "sub", - "table", "tbody", "th", "tr", "td" + "sub" ] }, "MD035": { diff --git a/docs/guides/whitelist-blacklist.md b/docs/guides/whitelist-blacklist.md index 58c7eab..e669673 100644 --- a/docs/guides/whitelist-blacklist.md +++ b/docs/guides/whitelist-blacklist.md @@ -10,73 +10,64 @@ The scripts will first parse `whitelist.txt` or `blacklist.txt` for any changes, Each script accepts the following parameters: - - - - - - - - - - - - - - - - - - - - - - - -
[domain]Fully qualified domain name you wish to add or remove. You can pass any number of domains.
-dRemoval mode. Domains will be removed from the list, rather than added
-nrUpdate blacklist without refreshing dnsmasq
-fForce delete cached blocklist content
-qQuiet mode. Console output is minimal. Useful for calling from another script (see gravity.sh)
+| Parameter | Description | +|------------|--------------------------------------------------------------------------------------------------| +| `[domain]` | Fully qualified domain name you wish to add or remove. You can pass any number of domains. | +| `-d` | Removal mode. Domains will be removed from the list, rather than added | +| `-nr` | Update blacklist without refreshing pihole-FTL | +| `-f` | Force delete cached blocklist content | +| `-q` | Quiet mode. Console output is minimal. Useful for calling from another script (see `gravity.sh`) | Domains passed are parsed by the script to ensure they are valid domains. If a domain is invalid it will be ignored. #### Example `pihole -w` usages - - - - - - - - - - - - - - - -
pihole -w domain1 [domain2...]Attempt to add one or more domains to the whitelist and reload dnsmasq.
pihole -w -nr domain1 [domain2...]Attempt to add one or more domains to the whitelist, but do not reload dnsmasq.
pihole -w -f domain1 [domain2...]Attempt to add one or more domains to the whitelist and force dnsmasq to reload
+* Attempt to add one or more domains to the whitelist and reload dnsmasq: -To remove domains from the whitelist: -Add `-d` as an additional argument (e.g `pihole -w -d domain1 [domain2...]`) + ```bash + pihole -w domain1 [domain2...] + ``` + +* Attempt to add one or more domains to the whitelist, but do not reload dnsmasq: + + ```bash + pihole -w -nr domain1 [domain2...] + ``` + +* Attempt to add one or more domains to the whitelist and force dnsmasq to reload: + + ```bash + pihole -w -f domain1 [domain2...] + ``` + +To remove domains from the whitelist add `-d` as an additional argument, e.g: + +```bash +pihole -w -d domain1 [domain2...] +``` #### Example `pihole -b` usages - - - - - - - - - - - - - - - -
pihole -b domain1 [domain2...]Attempt to add one or more domains to the blacklist and reload dnsmasq.
pihole -b -nr domain1 [domain2...]Attempt to add one or more domains to the blacklist, but do not reload dnsmasq.
pihole -b -f domain1 [domain2...]Attempt to add one or more domains to the blacklist and force dnsmasq to reload
+* Attempt to add one or more domains to the blacklist and reload dnsmasq: -To remove domains from the blacklist: -Add `-d` as an additional argument (e.g `pihole -b -d domain1 [domain2...]`) + ```bash + pihole -b domain1 [domain2...] + ``` + +* Attempt to add one or more domains to the blacklist, but do not reload dnsmasq: + + ```bash + pihole -b -nr domain1 [domain2...] + ``` + +* Attempt to add one or more domains to the blacklist and force dnsmasq to reload: + + ```bash + pihole -b -f domain1 [domain2...] + ``` + +To remove domains from the blacklist add `-d` as an additional argument, e.g: + +```bash +pihole -b -d domain1 [domain2...] +```