toxic/doc/toxic.1.asc

toxic(1)
========

NAME
----
toxic - CLI client for Tox

SYNOPSIS
--------
*toxic* [-f 'data-file'] [-x] [-4] [-c 'config-file'] [-n 'nodes-file'] [-h]

DESCRIPTION
-----------
toxic is an ncurses-based instant messaging client for Tox which formerly
resided in the Tox core repository, and is now available as a standalone
application.

OPTIONS
-------
-4, --ipv4::
    Force IPv4 connection

-b, --debug::
    Enable stderr for debugging. Redirect output to
    avoid breaking the curses interface and better capture messages.

-c, --config config-file::
    Use specified 'config-file' instead of '~/.config/tox/toxic.conf'

-d, --default-locale::
    Use default locale

-e, --encrypt-data::
    Encrypt an unencrypted data file. An error will occur if this option
    is used with an encrypted data file.

-f, --file data-file::
    Use specified 'data-file' instead of '~/.config/tox/toxic_profile.tox'

-h, --help::
    Show help message

-n, --nodes nodes-file::
    Use specified 'nodes-file' for DHT bootstrap nodes instead of '~/.config/tox/DHTnodes.json'

-o, --noconnect::
    Do not connect to the DHT network

-p, --SOCKS5-proxy::
    Use a SOCKS5 proxy: Requires [IP] [port]

-P, --HTTP-proxy::
    Use a HTTP proxy: Requires [IP] [port]

-r, --namelist::
    Use specified nameservers list

-t, --force-tcp::
    Force TCP connection (use this with proxies)

-T, --tcp-relay::
    Act as a TCP relay server for the network (Note: this uses significantly more bandwidth)

-u, --unencrypt-data::
    Unencrypt a data file. A warning will appear if this option is used
    with a data file that is already unencrypted.

FILES
-----
~/.config/tox/DHTnodes.json::
    Default location for list of DHT bootstrap nodes (list obtained from https://nodes.tox.chat).
    This list is automatically updated. See *toxic.conf*(5) for details on controlling the update frequency.

~/.config/tox/toxic_profile.tox::
    Savestate which contains your personal info (nickname, Tox ID, contacts,
    etc)

~/.config/tox/toxic.conf::
    Configuration file. See *toxic.conf*(5) for more details.

{datadir}/toxic.conf.example::
    Configuration example.

BUGS
----
-Unicode characters with a width larger than 1 column may cause strange
behaviour.

-Text occasionally fails to auto-scroll to the bottom.

-Screen flickering sometimes occurs on certain terminals.

AUTHORS
-------
JFreegman <JFreegman@gmail.com>

SEE ALSO
--------
*toxic.conf*(5)

LINKS
-----
Project page: <https://github.com/JFreegman/toxic>

IRC channel: chat.freenode.net#tox