.\" Manpage for Blokator.
.\" Contact tomkoid@proton.me to correct errors or typos.
.TH man 1 "19 Oct 2022" "0.5.1" "blokator man page"
.SH NAME
blokator \- block all ads and spam on your system
.SH SYNOPSIS
\f[B]blokator\f[R] [OPTIONS]
.SH DESCRIPTION
Simple cross-platform and system-wide CLI adblocker

Blokator is hosts-based. The hosts file is a way to map hostnames to IP addresses, which acts like local DNS server.

All data is stored in \f[B]/root/.local/share/adblocker\f[R].
.SH OPTIONS
\f[B]-s, --sync [DOWNLOAD_OPTIONS] [TOR_OPTIONS]\f[R] - sync all added repositories

\f[B]-a, --apply\f[R] - after sync, apply all changes

\f[B]--apply-android [ANDROID_OPTIONS]\f[R] - after sync, apply all changes to specified Android device (Blokator must be compiled with `android` feature)

\f[B]--list-devices\f[R] - list all connected Android devices including \f[B]DEVICE_ID\f[R]

\f[B]-r, --restore\f[R] - restore backup of hosts file (creates automatically when applying)

\f[B]-b, --backup\f[R] - create a manual backup

\f[B]-m, --add-repo [DOWNLOAD_OPTIONS] [TOR_OPTIONS] [RAW HOSTS FILE TXT URL] \f[R] - add additional repository

\f[B]-M, --add-repo-preset [DOWNLOAD_OPTIONS] [TOR_OPTIONS] [RAW HOSTS FILE TXT URL] \f[R] - add additional repository from preset

\f[B]-d, --del-repo [RAW HOSTS FILE TXT URL]\f[R] - remove additonal repository

\f[B]-D, --del-repo-preset [DOWNLOAD_OPTIONS] [TOR_OPTIONS] [RAW HOSTS FILE TXT URL] \f[R] - add additional repository from preset
.SH ANDROID_OPTIONS (required)
\f[B]--android-device [DEVICE_ID]\f[R] - specify android device
.SH DOWNLOAD_OPTIONS (optional)
\f[B]-t, --tor\f[R] - use tor when getting data from onion service

\f[B]-A, -tor-all\f[R] - use tor for all websites (-t, --tor argument required)
.SH TOR_OPTIONS (optional)
\f[B]--tor-bind-address [IP]\f[R] - specify tor proxy ip address (default: 127.0.0.1)

\f[B]--tor-port [PORT]\f[R] - specify tor proxy port (default: 9050)
.SH BUGS
No known bugs.
.SH AUTHOR
Tomkoid (tomkoid@proton.me)
