Skip to content

Commit

Permalink
Remove HTML tables (pi-hole#318)
Browse files Browse the repository at this point in the history
  • Loading branch information
XhmikosR authored May 17, 2020
1 parent 57df576 commit 6acfa4f
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 64 deletions.
3 changes: 1 addition & 2 deletions .markdownlint.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@
"img",
"strong",
"p",
"sub",
"table", "tbody", "th", "tr", "td"
"sub"
]
},
"MD035": {
Expand Down
115 changes: 53 additions & 62 deletions docs/guides/whitelist-blacklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,73 +10,64 @@ The scripts will first parse `whitelist.txt` or `blacklist.txt` for any changes,

Each script accepts the following parameters:

<table>
<tbody>
<tr>
<th><code>[domain]</code></th>
<td>Fully qualified domain name you wish to add or remove. You can pass any number of domains.</td>
</tr>
<tr>
<th><code>-d</code></th>
<td>Removal mode. Domains will be removed from the list, rather than added</td>
</tr>
<tr>
<th><code>-nr</code></th>
<td>Update blacklist without refreshing dnsmasq</td>
</tr>
<tr>
<th><code>-f</code></th>
<td>Force delete cached blocklist content</td>
</tr>
<tr>
<th><code>-q</code></th>
<td>Quiet mode. Console output is minimal. Useful for calling from another script (see <code>gravity.sh</code>)</td>
</tr>
</tbody>
</table>
| 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

<table>
<tbody>
<tr>
<th><code>pihole -w domain1 [domain2...]</code></th>
<td>Attempt to add one or more domains to the whitelist and reload dnsmasq.</td>
</tr>
<tr>
<th><code>pihole -w -nr domain1 [domain2...]</code></th>
<td>Attempt to add one or more domains to the whitelist, but do not reload dnsmasq.</td>
</tr>
<tr>
<th><code>pihole -w -f domain1 [domain2...]</code></th>
<td>Attempt to add one or more domains to the whitelist and force dnsmasq to reload</td>
</tr>
</tbody>
</table>

To remove domains from the whitelist:
Add `-d` as an additional argument (e.g `pihole -w -d domain1 [domain2...]`)
* Attempt to add one or more domains to the whitelist and reload dnsmasq:

```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

<table>
<tbody>
<tr>
<th><code>pihole -b domain1 [domain2...]</code></th>
<td>Attempt to add one or more domains to the blacklist and reload dnsmasq.</td>
</tr>
<tr>
<th><code>pihole -b -nr domain1 [domain2...]</code></th>
<td>Attempt to add one or more domains to the blacklist, but do not reload dnsmasq.</td>
</tr>
<tr>
<th><code>pihole -b -f domain1 [domain2...]</code></th>
<td>Attempt to add one or more domains to the blacklist and force dnsmasq to reload</td>
</tr>
</tbody>
</table>

To remove domains from the blacklist:
Add `-d` as an additional argument (e.g `pihole -b -d domain1 [domain2...]`)
* Attempt to add one or more domains to the blacklist and reload dnsmasq:

```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...]
```

0 comments on commit 6acfa4f

Please sign in to comment.