mirror of
https://github.com/Tha14/toxic.git
synced 2024-11-25 03:33:03 +01:00
170 lines
4.1 KiB
Groff
170 lines
4.1 KiB
Groff
'\" t
|
|
.\" Title: toxic
|
|
.\" Author: [see the "AUTHORS" section]
|
|
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
|
|
.\" Date: 2021-05-24
|
|
.\" Manual: Toxic Manual
|
|
.\" Source: toxic __VERSION__
|
|
.\" Language: English
|
|
.\"
|
|
.TH "TOXIC" "1" "2021\-05\-24" "toxic __VERSION__" "Toxic Manual"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * Define some portability stuff
|
|
.\" -----------------------------------------------------------------
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.\" http://bugs.debian.org/507673
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "NAME"
|
|
toxic \- CLI client for Tox
|
|
.SH "SYNOPSIS"
|
|
.sp
|
|
\fBtoxic\fR [\-f \fIdata\-file\fR] [\-x] [\-4] [\-c \fIconfig\-file\fR] [\-n \fInodes\-file\fR] [\-h]
|
|
.SH "DESCRIPTION"
|
|
.sp
|
|
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\&.
|
|
.SH "OPTIONS"
|
|
.PP
|
|
\-4, \-\-ipv4
|
|
.RS 4
|
|
Force IPv4 connection
|
|
.RE
|
|
.PP
|
|
\-b, \-\-debug
|
|
.RS 4
|
|
Enable stderr for debugging\&. Redirect output to avoid breaking the curses interface and better capture messages\&.
|
|
.RE
|
|
.PP
|
|
\-c, \-\-config config\-file
|
|
.RS 4
|
|
Use specified
|
|
\fIconfig\-file\fR
|
|
instead of
|
|
\fI~/\&.config/tox/toxic\&.conf\fR
|
|
.RE
|
|
.PP
|
|
\-d, \-\-default\-locale
|
|
.RS 4
|
|
Use default locale
|
|
.RE
|
|
.PP
|
|
\-e, \-\-encrypt\-data
|
|
.RS 4
|
|
Encrypt an unencrypted data file\&. An error will occur if this option is used with an encrypted data file\&.
|
|
.RE
|
|
.PP
|
|
\-f, \-\-file data\-file
|
|
.RS 4
|
|
Use specified
|
|
\fIdata\-file\fR
|
|
instead of
|
|
\fI~/\&.config/tox/toxic_profile\&.tox\fR
|
|
.RE
|
|
.PP
|
|
\-h, \-\-help
|
|
.RS 4
|
|
Show help message
|
|
.RE
|
|
.PP
|
|
\-l, \-\-logging
|
|
.RS 4
|
|
Enable toxcore logging to stderr
|
|
.RE
|
|
.PP
|
|
\-n, \-\-nodes nodes\-file
|
|
.RS 4
|
|
Use specified
|
|
\fInodes\-file\fR
|
|
for DHT bootstrap nodes instead of
|
|
\fI~/\&.config/tox/DHTnodes\&.json\fR
|
|
.RE
|
|
.PP
|
|
\-o, \-\-noconnect
|
|
.RS 4
|
|
Do not connect to the DHT network
|
|
.RE
|
|
.PP
|
|
\-p, \-\-SOCKS5\-proxy
|
|
.RS 4
|
|
Use a SOCKS5 proxy: Requires [IP] [port]
|
|
.RE
|
|
.PP
|
|
\-P, \-\-HTTP\-proxy
|
|
.RS 4
|
|
Use a HTTP proxy: Requires [IP] [port]
|
|
.RE
|
|
.PP
|
|
\-r, \-\-namelist
|
|
.RS 4
|
|
Use specified nameservers list
|
|
.RE
|
|
.PP
|
|
\-t, \-\-force\-tcp
|
|
.RS 4
|
|
Force TCP connection (use this with proxies)
|
|
.RE
|
|
.PP
|
|
\-T, \-\-tcp\-relay
|
|
.RS 4
|
|
Act as a TCP relay server for the network (Note: this uses significantly more bandwidth)
|
|
.RE
|
|
.PP
|
|
\-u, \-\-unencrypt\-data
|
|
.RS 4
|
|
Unencrypt a data file\&. A warning will appear if this option is used with a data file that is already unencrypted\&.
|
|
.RE
|
|
.SH "FILES"
|
|
.PP
|
|
~/\&.config/tox/DHTnodes\&.json
|
|
.RS 4
|
|
Default location for list of DHT bootstrap nodes (list obtained from
|
|
https://nodes\&.tox\&.chat)\&. This list is automatically updated\&. See
|
|
\fBtoxic\&.conf\fR(5) for details on controlling the update frequency\&.
|
|
.RE
|
|
.PP
|
|
~/\&.config/tox/toxic_profile\&.tox
|
|
.RS 4
|
|
Savestate which contains your personal info (nickname, Tox ID, contacts, etc)
|
|
.RE
|
|
.PP
|
|
~/\&.config/tox/toxic\&.conf
|
|
.RS 4
|
|
Configuration file\&. See
|
|
\fBtoxic\&.conf\fR(5) for more details\&.
|
|
.RE
|
|
.PP
|
|
__DATADIR__/toxic\&.conf\&.example
|
|
.RS 4
|
|
Configuration example\&.
|
|
.RE
|
|
.SH "BUGS"
|
|
.sp
|
|
\-Unicode characters with a width larger than 1 column may cause strange behaviour\&.
|
|
.sp
|
|
\-Screen flickering sometimes occurs on certain terminals\&.
|
|
.sp
|
|
\-Resizing the terminal window when a game window is open will break things\&.
|
|
.SH "AUTHORS"
|
|
.sp
|
|
JFreegman <JFreegman@gmail\&.com>
|
|
.SH "SEE ALSO"
|
|
.sp
|
|
\fBtoxic\&.conf\fR(5)
|
|
.SH "LINKS"
|
|
.sp
|
|
Project page: https://github\&.com/JFreegman/toxic
|
|
.sp
|
|
IRC channel: irc\&.libera\&.chat#tox
|