Skip to content

Commit 4c3fa71

Browse files
author
Kevin Gut
committed
Update Readme
1 parent d5b6f50 commit 4c3fa71

1 file changed

Lines changed: 38 additions & 22 deletions

File tree

README.md

Lines changed: 38 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,54 @@
11
# AnyBlock
22

3-
Blocks the given IP Ranges in Windows Firewall
3+
Blocks IP ranges in Windows firewall based on owner information.
44

55
## IP Ranges
66

7-
The IP Ranges are obtained from https://cable.ayra.ch/ip/global.php
7+
The IP ranges are obtained from https://cable.ayra.ch/ip/global.php
88

9-
The Application will attempt to update the list on each run if it's missing or older than 24 Hours.
9+
The application will attempt to update the list on each run if it's missing or older than 24 hours.
1010

1111
## Usage
1212

13-
AnyBlock supports Command Line and GUI usage.
13+
AnyBlock supports command line and GUI usage.
1414

1515
## GUI
1616

17-
The GUI is automatically launched if you run AnyBlock without any Arguments.
17+
The GUI is automatically launched if you run AnyBlock without any arguments.
1818

19-
Right now you can add and remove Ranges to the Block List
19+
Right now you can add and remove ranges to the block list.
2020

2121
## Command Line Mode
2222

23-
Command Line:
23+
Command line format overview:
2424

25-
AnyBlock.exe [/v] [/clear | /config | /add range [...] | /remove name [...] | /apply | /list]
25+
AnyBlock.exe [/v] [/clear | /config | /add range [...] |
26+
/remove name [...] | /apply [v{4|6}] | /list] |
27+
/export {csv|tsv|p2p|json}
2628

2729
### `/v`
2830

29-
Enables more verbose Logging to Console.
30-
If supplied, the Console will also be shown in GUI Mode
31+
Enables more verbose logging to console.
32+
If supplied, the console will also be shown in GUI mode.
33+
This parameter is implied if you compile a debug build.
3134

3235
### `/config`
3336

34-
Lists currently configured Ranges and directions on the console
37+
Lists currently configured ranges and directions on the console.
3538

3639
### `/add`
3740

38-
Adds the specified Range(s) to the List.
41+
Adds the specified range(s) to the list.
3942
A range is formatted as `dir:name`
4043

4144
- **dir**: One of IN,OUT,BOTH,DISABLED
42-
- **name**: fully qualified Node Name
45+
- **name**: fully qualified node name
4346

4447
Disabled entries behave as if they were not configured at all,
45-
meaning that `/apply` will remove them from existing Rules.
48+
meaning that `/apply` will still remove them from existing rules.
4649

4750
It's not necessary to disable an entry to delete it.
48-
Disabling is merely a way to temporarily removing a range.
51+
Disabling is merely a way to temporarily remove a range.
4952

5053
To change the direction of an existing entry,
5154
add it again using a different direction.
@@ -54,20 +57,33 @@ As of now, this command will not check for unnecessary child rules when adding a
5457

5558
### `/remove`
5659

57-
Removes the specified Range(s) from the List.
60+
Removes the specified range(s) from the List.
5861
Removing is done by name only. Directions can't be specified.
5962

60-
6163
### `/apply`
6264

63-
Applies List to Firewall Rules.
64-
Applying the List will remove all blocked IPs that are no longer in the current List of Addresses.
65-
To keep the List accurate, this Command should be run every 24 hours.
65+
Applies the configured list to firewall rules.
66+
Applying the list will remove all blocked IPs that are no longer in the current list of addresses.
67+
To keep the list accurate, this command should be run every 24 hours.
68+
69+
This command takes an optional argument that can either be `v4` or `v6`.
70+
This causes the application to only add rules with the given IP address type.
71+
This is especially useful if your server is only reachable via one of the two types.
6672

6773
### `/clear`
6874

69-
Removes all AnyBlock Rules regardless of Configuration
75+
Removes all AnyBlock rules regardless of configuration.
7076

7177
### `/list`
7278

73-
Lists all available Ranges
79+
Lists all available ranges
80+
81+
### `/export {csv|tsv|p2p|json}`
82+
83+
Exports the currently selected rules with IP ranges in various formats:
84+
85+
- **csv**: Exports name, start-IP, end-IP, cidr in csv format (with headers)
86+
- **tsv**: Same as csv, but uses tab to delimit fields
87+
- **p2p**: Peer to peer blocklist format for common P2P applications
88+
- **json**: JSON object. Range names are keys and the CIDR list the values
89+

0 commit comments

Comments
 (0)