octoleo
/
hosts
mirror of https://github.com/octoleo/hosts.git
1
0
Fork 0
Code Releases Activity

Add exit status documentation to README.md

This commit is contained in:
William Melody 2020-04-22 11:58:50 -07:00
parent 88030b8a51
commit 9dab3606c6
1 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -380,6 +380,10 @@ Usage:
Description: Description:
Add a given IP address and hostname pair, along with an optional comment. Add a given IP address and hostname pair, along with an optional comment.
Exit status:
0 Success.
1 Invalid parameters or entry exists.
``` ```
### `hosts backups` ### `hosts backups`
@ -406,6 +410,10 @@ Subcommands:
Description: Description:
Manage backups. Manage backups.
Exit status:
0 Success.
1 Invalid parameters or backup not found.
``` ```
### `hosts block` ### `hosts block`
@ -417,6 +425,10 @@ Usage:
Description: Description:
Block one or more hostnames by adding new entries assigned to `127.0.0.1` Block one or more hostnames by adding new entries assigned to `127.0.0.1`
for IPv4 and both `fe80::1%lo0` and `::1` for IPv6. for IPv4 and both `fe80::1%lo0` and `::1` for IPv6.
Exit status:
0 Success.
1 Invalid parameters or entry exists.
``` ```
#### Blocklists #### Blocklists
@ -446,6 +458,10 @@ Usage:
Description: Description:
Disable one or more records based on a given ip address, hostname, or Disable one or more records based on a given ip address, hostname, or
search string. search string.
Exit status:
0 Success.
1 Invalid parameters or entry not found.
``` ```
### `hosts disabled` ### `hosts disabled`
@ -477,6 +493,10 @@ Usage:
Description: Description:
Enable one or more disabled records based on a given ip address, hostname, Enable one or more disabled records based on a given ip address, hostname,
or search string. or search string.
Exit status:
0 Success.
1 Invalid parameters or entry not found.
``` ```
### `hosts enabled` ### `hosts enabled`
@ -535,6 +555,10 @@ Description:
Remove one or more records based on a given IP address, hostname, or search Remove one or more records based on a given IP address, hostname, or search
string. If an IP and hostname are both provided, only records matching the string. If an IP and hostname are both provided, only records matching the
IP and hostname pair will be removed. IP and hostname pair will be removed.
Exit status:
0 Success.
1 Invalid parameters or entry not found.
``` ```
### `hosts search` ### `hosts search`
@ -555,6 +579,10 @@ Usage:
Description: Description:
Print entries matching a given IP address, hostname, or search string. Print entries matching a given IP address, hostname, or search string.
Exit status:
0 Success.
1 Invalid parameters or entry not found.
``` ```
### `hosts unblock` ### `hosts unblock`
@ -565,6 +593,10 @@ Usage:
Description: Description:
Unblock one or more hostnames by removing the entries from the hosts file. Unblock one or more hostnames by removing the entries from the hosts file.
Exit status:
0 Success.
1 Invalid parameters or entry not found
``` ```
### `hosts version` ### `hosts version`