Skip to content

User Manual

Andrey Zhuchkov edited this page Jan 12, 2024 · 3 revisions

NAME

tunblkctl - command-line frontend for Tunnelblick.

SYNOPSIS

tunblkctl <COMMAND> [OPTIONS...] [ARGS...]

DESCRIPTION

tunblkctl is a command-line interface that facilitates the execution of common VPN management operations for Tunnelblick. This tool is particularly useful for scripting, automation of testing scenarios, or any situation where a command-line interface is preferable or required.

COMMANDS

list, ls Enumerates installed VPN configurations. Formats names in columns when output is a tty; otherwise, it uses a line-per-config approach.

status, st [--strip|--no-strip] Displays a table with VPN configurations, their statuses, and traffic statistics. Depending on the output destination (tty or not) formats table or skips formatting, which can be also controlled by the options above.

connect, con [--wait] <VPN> Establishes a new VPN connection. The --wait option blocks command completion until the connection is up (or down).

disconnect, dis [VPN] Shuts down VPN connection. If no VPN is specified, all the established connections are subject to shut down.

quit, q Forces Tunnelblick to shut down all active VPN connections and then quit.

ENVIRONMENT

TUNBLKCTL_SI_MODE By default, formatted traffic statistics is printed using powers of 2 (kibi-, mebi-, ...). To use powers of 10 (kilo-, mega-) this variable should be set to 'on'.

TUNBLKCTL_DEBUG Set to 'on' to enable verbose output from the internals of tunblkctl.

AUTHOR

Andrey Zhuchkov

VERSION

0.4.0

BUGS

The fractional part of traffic volumes may contain a rounding error of .01 in certain instances.

Clone this wiki locally