kevin/buildhosts
1
0
Fork 0
mirror of https://github.com/prurigro/buildhosts.git synced 2024-11-24 14:41:26 -05:00
Code Issues Projects Releases Packages Wiki Activity

A few touchups to the documentation and comments.

Browse source
This commit is contained in:
Kevin MacMartin 2014-08-07 03:25:16 -04:00
parent cc06b4432f
commit 71483d6f11
3 changed files with 8 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -4,7 +4,7 @@ Build and maintain `/etc/hosts` while including lists imported from local and re
## Instructions ## ## Instructions ##
**Note:** All instructions should be performed as the **root** user, or using the `sudo` command to run commands with **root** permissions. **Note:** All instructions should be performed as the **root** user or using the `sudo` command.
## Enable Remote Sources ## ## Enable Remote Sources ##
@ -16,7 +16,7 @@ Build and maintain `/etc/hosts` while including lists imported from local and re
## Disable Remote Sources ## ## Disable Remote Sources ##
1. To disable the configured hosts lists, run the `unset` command and `/etc/hosts.core` will be moved back to `/etc/hosts`. 1. To disable the configured hosts lists, run the `unset` command and `/etc/hosts.core` will be moved back to `/etc/hosts`.
2. The `/etc/hosts.sources` file will continue to exist until it's manually deleted, and it will be used again the next time remote sources are enabled. * The `/etc/hosts.sources` file will continue to exist until it's manually deleted, and it will be used again the next time remote sources are enabled.
## Notes on /etc/hosts.sources ## ## Notes on /etc/hosts.sources ##

11
buildhosts
View file

@ -10,13 +10,10 @@
# moved to /etc/hosts.core, and the file /etc/hosts.sources will # moved to /etc/hosts.core, and the file /etc/hosts.sources will
# be created using the default sources list. The /etc/hosts file # be created using the default sources list. The /etc/hosts file
# will then be generated by combining /etc/hosts.core and the # will then be generated by combining /etc/hosts.core and the
# resulting contents of the downloaded sources in # resulting contents of downloaded sources in /etc/hosts.sources.
# /etc/hosts.sources.
# 2. You can now open /etc/hosts.sources and remove or comment out # 2. You can now open /etc/hosts.sources and remove or comment out
# (by adding # in front) any sources you don't wish to use, as # (by adding # in front) any sources you don't wish to use, as
# well as add new ones. Sources can remote # well as add new ones. Sources can remote as well as local.
# (ie: http://adaway.org/hosts.txt) as well as local
# (ie: file:///etc/hosts.d/mylist.txt).
# 3. If you want to make any changes to the contents of what used to # 3. If you want to make any changes to the contents of what used to
# be /etc/hosts, you should now make them to /etc/hosts.core, and # be /etc/hosts, you should now make them to /etc/hosts.core, and
# you'll need to rerun the 'set' command to have them applied. # you'll need to rerun the 'set' command to have them applied.
@ -28,7 +25,7 @@
# Disable Remote Sources # Disable Remote Sources
# 1. To disable the configured hosts lists, run the 'unset' command # 1. To disable the configured hosts lists, run the 'unset' command
# and /etc/hosts.core will be moved back to /etc/hosts. # and /etc/hosts.core will be moved back to /etc/hosts.
# 2. The /etc/hosts.sources file will continue to exist until it's # * The /etc/hosts.sources file will continue to exist until it's
# manually deleted, and it will be used again the next time remote # manually deleted, and it will be used again the next time remote
# sources are enabled. # sources are enabled.
# #
@ -168,7 +165,7 @@ function buildhosts_unset() {
# Fail if the user isn't root # Fail if the user isn't root
[[ $EUID -eq 0 ]] || buildhosts_error "You must run ${BUILDHOSTS_SCRIPT} as root" [[ $EUID -eq 0 ]] || buildhosts_error "You must run ${BUILDHOSTS_SCRIPT} as root"
# Undo changes to /etc/hosts when the user runs with the disable command # Fail if run with no commands
[[ -n "$1" ]] || buildhosts_error "You must run ${BUILDHOSTS_SCRIPT} with a valid argument" 1 [[ -n "$1" ]] || buildhosts_error "You must run ${BUILDHOSTS_SCRIPT} with a valid argument" 1
case "$1" in case "$1" in

4
buildhosts.1
View file

@ -44,7 +44,7 @@
\fBhelp\fR: display the help \fBhelp\fR: display the help
. .
.SH "INSTRUCTIONS" .SH "INSTRUCTIONS"
\fBNote:\fR All instructions should be performed as the \fBroot\fR user, or using the \fBsudo\fR command to run commands with \fBroot\fR permissions\. \fBNote:\fR 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 .TP
@ -68,7 +68,7 @@ Once you\'re done customizing your configuration, run the \fBset\fR command agai
To disable the configured hosts lists, run the \fBunset\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 \fBunset\fR command and \fB/etc/hosts\.core\fR will be moved back to \fB/etc/hosts\fR\.
.TP .TP
.TP .TP
.BR "2." .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\. 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" .SS "Notes on /etc/hosts\.sources"
.TP .TP