More readme refinements.

This commit is contained in:
Steven Black
2016-02-23 10:05:16 -05:00
parent 513bdd1ce8
commit da7077a5b4
3 changed files with 25 additions and 18 deletions
+15 -8
View File
@@ -1,18 +1,25 @@
# Extensions
Use subfolders under the `extensions` folder to house extensions for additional variants of the final amalgamated
hosts file.
Use subfolders under the `extensions` folder to house extensions to the final amalgamated hosts file.
Currently this repo includes a `porn` extension which you can optionally add to your final amalgamated file.
More built-in extensions are coming soon.
Here's a sample call to include the `porn` extension.
Using Python 3:
**Using Python 3**:
python3 updateHostsFile.py [--auto] --extensions porn
python3 updateHostsFile.py --extensions porn
Using Python 2.7:
or, in short form:
python updateHostsFile.py [--auto] --extensions porn
python3 updateHostsFile.py -e porn
**Using Python 2.7**:
python updateHostsFile.py --extensions porn
or, in short form:
python updateHostsFile.py -e porn
More built-in extensions are coming soon.
+5 -5
View File
@@ -65,21 +65,21 @@ Using Python 2.7:
Command line options:
`--auto`, `-a`: run the script without prompting. When `--auto` is invoked,
`--auto`, or `-a`: run the script without prompting. When `--auto` is invoked,
* Host data sources, including extensions, are updated.
* No extensions are included by default. Use the `--extensions` or `-e` flag to include any you want.
* Your active hosts file is *not* replaced unless you include the `--replace` flag.
`--replace`, `-r`: trigger replacing your active hosts file with the new hosts file. Use along with `--auto` to
`--replace`, or `-r`: trigger replacing your active hosts file with the new hosts file. Use along with `--auto` to
force replacement.
`--ip nnn.nnn.nnn.nnn`, `--i nnn.nnn.nnn.nnn`: the IP address to use as the target. Default is `0.0.0.0`.
`--ip nnn.nnn.nnn.nnn`, or `-i nnn.nnn.nnn.nnn`: the IP address to use as the target. Default is `0.0.0.0`.
`--extensions ext1 ext2 ext3`, `-e ext1 ext2 ext3`: the names of subfolders below the `extensions` folder containing
`--extensions ext1 ext2 ext3`, or `-e ext1 ext2 ext3`: the names of subfolders below the `extensions` folder containing
additional category-specific hosts files to include in the amalgamation. Example: `--extensions porn` or `-e porn`.
`--help`, `-h`: display help.
`--help`, or `-h`: display help.
## How do I control which sources are amalgamated?
+5 -5
View File
@@ -65,21 +65,21 @@ Using Python 2.7:
Command line options:
`--auto`, `-a`: run the script without prompting. When `--auto` is invoked,
`--auto`, or `-a`: run the script without prompting. When `--auto` is invoked,
* Host data sources, including extensions, are updated.
* No extensions are included by default. Use the `--extensions` or `-e` flag to include any you want.
* Your active hosts file is *not* replaced unless you include the `--replace` flag.
`--replace`, `-r`: trigger replacing your active hosts file with the new hosts file. Use along with `--auto` to
`--replace`, or `-r`: trigger replacing your active hosts file with the new hosts file. Use along with `--auto` to
force replacement.
`--ip nnn.nnn.nnn.nnn`, `--i nnn.nnn.nnn.nnn`: the IP address to use as the target. Default is `0.0.0.0`.
`--ip nnn.nnn.nnn.nnn`, or `-i nnn.nnn.nnn.nnn`: the IP address to use as the target. Default is `0.0.0.0`.
`--extensions ext1 ext2 ext3`, `-e ext1 ext2 ext3`: the names of subfolders below the `extensions` folder containing
`--extensions ext1 ext2 ext3`, or `-e ext1 ext2 ext3`: the names of subfolders below the `extensions` folder containing
additional category-specific hosts files to include in the amalgamation. Example: `--extensions porn` or `-e porn`.
`--help`, `-h`: display help.
`--help`, or `-h`: display help.
## How do I control which sources are amalgamated?