mirror of
https://github.com/prurigro/buildhosts.git
synced 2024-11-21 13:52:31 -05:00
Touched up some wording + fixed a lot of issues with the manpage
This commit is contained in:
parent
f6f31c8a56
commit
8469adccd5
2 changed files with 32 additions and 40 deletions
|
@ -21,7 +21,6 @@ Build and maintain `/etc/hosts` while including lists imported from local and re
|
||||||
## Notes on /etc/hosts.sources ##
|
## Notes on /etc/hosts.sources ##
|
||||||
|
|
||||||
* On each line of `/etc/hosts.sources`, after `#` is commented/skipped.
|
* On each line of `/etc/hosts.sources`, after `#` is commented/skipped.
|
||||||
* Colour output can be disabled by setting the variable `NOCOL=1`.
|
|
||||||
* The `$HOSTS_SYSTEM` variable can be set to an alternative location to configure a different file to be used for `/etc/hosts`.
|
* The `$HOSTS_SYSTEM` variable can be set to an alternative location to configure a different file to be used for `/etc/hosts`.
|
||||||
* Similarly, the `$HOSTS_CORE` and `$HOSTS_SOURCES` variables (which default to `$HOSTS_SYSTEM.core` and `$HOSTS_SYSTEM.sources` and will automatically change when `$HOSTS_SYSTEM` is changed), can be set to alternative locations to configure the use of different files.
|
* Similarly, the `$HOSTS_CORE` and `$HOSTS_SOURCES` variables (which default to `$HOSTS_SYSTEM.core` and `$HOSTS_SYSTEM.sources` and will automatically change when `$HOSTS_SYSTEM` is changed), can be set to alternative locations to configure the use of different files.
|
||||||
|
|
||||||
|
@ -31,6 +30,8 @@ Build and maintain `/etc/hosts` while including lists imported from local and re
|
||||||
* `buildhosts revert`: remove lists imported from hosts list sources and restore `/etc/hosts`
|
* `buildhosts revert`: remove lists imported from hosts list sources and restore `/etc/hosts`
|
||||||
* `buildhosts help`: display the help
|
* `buildhosts help`: display the help
|
||||||
|
|
||||||
|
**Note**: Colour output can be disabled by setting the variable `NOCOL=1`.
|
||||||
|
|
||||||
## Extra ##
|
## Extra ##
|
||||||
|
|
||||||
* The `p2p-to-hosts` script included in this repo can be used to convert blocklists in p2p format to hosts format (usable with this package).
|
* The `p2p-to-hosts` script included in this repo can be used to convert blocklists in p2p format to hosts format (usable with this package).
|
||||||
|
|
69
buildhosts.1
69
buildhosts.1
|
@ -25,7 +25,8 @@
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
.B buildhosts
|
.B buildhosts
|
||||||
\- build and maintain \fB/etc/hosts\fR while including lists imported from local and remote hosts list sources\.
|
.TP
|
||||||
|
build and maintain \fB/etc/hosts\fR while including lists imported from local and remote hosts list sources\.
|
||||||
.
|
.
|
||||||
.SH "SYNOPSIS"
|
.SH "SYNOPSIS"
|
||||||
.
|
.
|
||||||
|
@ -34,62 +35,52 @@
|
||||||
.
|
.
|
||||||
.SH "COMMANDS"
|
.SH "COMMANDS"
|
||||||
.
|
.
|
||||||
.TP
|
.P
|
||||||
\fBbuild\fR: generate \fB/etc/hosts\fR using \fB/etc/hosts\.core\fR and the configured sources
|
\fBbuild\fR: generate \fB/etc/hosts\fR using \fB/etc/hosts\.core\fR and the configured sources
|
||||||
.TP
|
.P
|
||||||
.TP
|
.P
|
||||||
\fBrevert\fR: remove lists imported from hosts list sources and restore \fB/etc/hosts\fR
|
\fBrevert\fR: remove lists imported from hosts list sources and restore \fB/etc/hosts\fR
|
||||||
.TP
|
.P
|
||||||
.TP
|
.P
|
||||||
\fBhelp\fR: display the help
|
\fBhelp\fR: display the help
|
||||||
|
.P
|
||||||
|
.P
|
||||||
|
\fB**\fR Colour output can be disabled by setting the variable \fBNOCOL=1\fR
|
||||||
.
|
.
|
||||||
.SH "INSTRUCTIONS"
|
.SH "INSTRUCTIONS"
|
||||||
\fBNote:\fR All instructions should be performed as the \fBroot\fR user or using the \fBsudo\fR command\.
|
(All instructions should be performed as the \fBroot\fR user or using the \fBsudo\fR command)
|
||||||
.
|
.
|
||||||
.SS "Enable Remote Sources"
|
.SS "Enable Remote Sources"
|
||||||
.TP
|
.P
|
||||||
.IP "1."
|
\fB1\.\fR The first time you run the \fBbuild\fR command, \fB/etc/hosts\fR will be moved to \fB/etc/hosts\.core\fR, and the file \fB/etc/hosts\.sources\fR will be created using the default sources list\. The \fB/etc/hosts\fR file will then be generated by combining \fB/etc/hosts\.core\fR and the resulting contents of the downloaded sources in \fB/etc/hosts\.sources\fR\.
|
||||||
The first time you run the \fBbuild\fR command, \fB/etc/hosts\fR will be moved to \fB/etc/hosts\.core\fR, and the file \fB/etc/hosts\.sources\fR will be created using the default sources list\. The \fB/etc/hosts\fR file will then be generated by combining \fB/etc/hosts\.core\fR and the resulting contents of the downloaded sources in \fB/etc/hosts\.sources\fR\.
|
.P
|
||||||
.TP
|
\fB2\.\fR You can now open \fB/etc/hosts\.sources\fR and remove or comment out (by adding \fB#\fR in front) any sources you don\'t wish to use, as well as add new ones\. Sources can remote (ie: \fBhttp://adaway\.org/hosts\.txt\fR) as well as local (ie: \fBfile:///etc/hosts\.d/mylist\.txt\fR)\.
|
||||||
.TP
|
.P
|
||||||
.BR "2."
|
\fB3\.\fR If you want to make any changes to the contents of what used to be \fB/etc/hosts\fR, you should now make them to \fB/etc/hosts\.core\fR, and you\'ll need to rerun the \fBbuild\fR command to have them applied\.
|
||||||
You can now open \fB/etc/hosts\.sources\fR and remove or comment out (by adding \fB#\fR in front) any sources you don\'t wish to use, as well as add new ones\. Sources can remote (ie: \fBhttp://adaway\.org/hosts\.txt\fR) as well as local (ie: \fBfile:///etc/hosts\.d/mylist\.txt\fR)\.
|
.P
|
||||||
.TP
|
\fB4\.\fR Once you\'re done customizing your configuration, run the \fBbuild\fR command again and the \fB/etc/hosts\fR file will be regenerated using the current list of sources and your up\-to\-date \fB/etc/hosts\.core\fR file\.
|
||||||
.TP
|
|
||||||
.BR "3."
|
|
||||||
If you want to make any changes to the contents of what used to be \fB/etc/hosts\fR, you should now make them to \fB/etc/hosts\.core\fR, and you\'ll need to rerun the \fBbuild\fR command to have them applied\.
|
|
||||||
.TP
|
|
||||||
.TP
|
|
||||||
.BR "4."
|
|
||||||
Once you\'re done customizing your configuration, run the \fBbuild\fR command again and the \fB/etc/hosts\fR file will be regenerated using the current list of sources and your up\-to\-date \fB/etc/hosts\.core\fR file\.
|
|
||||||
.SS "Disable Remote Sources"
|
.SS "Disable Remote Sources"
|
||||||
.TP
|
.P
|
||||||
.BR "1."
|
\fB1\.\fR To disable the configured hosts lists, run the \fBrevert\fR command and \fB/etc/hosts\.core\fR will be moved back to \fB/etc/hosts\fR\.
|
||||||
To disable the configured hosts lists, run the \fBrevert\fR command and \fB/etc/hosts\.core\fR will be moved back to \fB/etc/hosts\fR\.
|
.P
|
||||||
.TP
|
\fB**\fR The \fB/etc/hosts\.sources\fR file will continue to exist until it\'s manually deleted, and it will be used again the next time remote sources are enabled\.
|
||||||
.TP
|
.SS "Notes on Hosts Sources"
|
||||||
.BR "*"
|
|
||||||
The \fB/etc/hosts\.sources\fR file will continue to exist until it\'s manually deleted, and it will be used again the next time remote sources are enabled\.
|
|
||||||
.SS "Notes on /etc/hosts\.sources"
|
|
||||||
.TP
|
.TP
|
||||||
On each line of \fB/etc/hosts\.sources\fR, after \fB#\fR is commented/skipped\.
|
On each line of \fB/etc/hosts\.sources\fR, after \fB#\fR is commented/skipped\.
|
||||||
.TP
|
.P
|
||||||
.TP
|
.P
|
||||||
Colour output can be disabled by setting the variable \fBNOCOL=1\fR\.
|
|
||||||
.TP
|
|
||||||
.TP
|
|
||||||
The \fB$HOSTS_SYSTEM\fR variable can be set to an alternative location to configure a different file to be used for \fB/etc/hosts\fR\.
|
The \fB$HOSTS_SYSTEM\fR variable can be set to an alternative location to configure a different file to be used for \fB/etc/hosts\fR\.
|
||||||
.TP
|
.P
|
||||||
.TP
|
.P
|
||||||
Similarly, the \fB$HOSTS_CORE\fR and \fB$HOSTS_SOURCES\fR variables (which default to \fB$HOSTS_SYSTEM\.core\fR and \fB$HOSTS_SYSTEM\.sources\fR and will automatically change when \fB$HOSTS_SYSTEM\fR is changed), can be set to alternative locations to configure the use of different files\.
|
Similarly, the \fB$HOSTS_CORE\fR and \fB$HOSTS_SOURCES\fR variables (which default to \fB$HOSTS_SYSTEM\.core\fR and \fB$HOSTS_SYSTEM\.sources\fR and will automatically change when \fB$HOSTS_SYSTEM\fR is changed), can be set to alternative locations to configure the use of different files\.
|
||||||
.
|
.
|
||||||
.SH "CREDITS"
|
.SH "CREDITS"
|
||||||
Written by Kevin MacMartin:
|
Written by Kevin MacMartin:
|
||||||
.
|
.
|
||||||
.IP "\(bu" 4
|
.IP "\(bu" 2
|
||||||
GitHub Projects \fIhttps://github\.com/prurigro\fR
|
GitHub Projects \fIhttps://github\.com/prurigro\fR
|
||||||
.
|
.
|
||||||
.IP "\(bu" 4
|
.IP "\(bu" 2
|
||||||
Arch Linux AUR Packages \fIhttps://aur\.archlinux\.org/packages/?SeB=m&K=prurigro\fR
|
Arch Linux AUR Packages \fIhttps://aur\.archlinux\.org/packages/?SeB=m&K=prurigro\fR
|
||||||
.
|
.
|
||||||
.SH "LICENSE"
|
.SH "LICENSE"
|
||||||
|
|
Loading…
Reference in a new issue