mirror of
https://github.com/Tha14/toxic.git
synced 2024-12-23 03:13:25 +01:00
JFreegman
commit
53193e933f
@ -22,6 +22,11 @@ Toxic is a [Tox](https://tox.im)-based instant messenging client which formerly
|
||||
##### Desktop notifications
|
||||
* [libnotify](https://developer.gnome.org/libnotify) (for Debian based systems, 'libnotify-dev')
|
||||
|
||||
##### Documentation
|
||||
* [Asciidoc](http://asciidoc.org/index.html) Only required for regenerating manpages.
|
||||
* Run `make` in the doc directory after editing the asciidoc to regenerate the manpages.
|
||||
* Asciidoc files and generated manpages will need to be commited together.
|
||||
|
||||
### Compiling
|
||||
1. `cd build/`
|
||||
2. `make PREFIX="/where/to/install"`
|
||||
|
||||
@ -4,12 +4,15 @@ VERSION = $(TOXIC_VERSION)_r$(REV)
|
||||
|
||||
BASE_DIR = $(shell cd .. && pwd -P)
|
||||
CFG_DIR = $(BASE_DIR)/cfg
|
||||
DOC_DIR = $(BASE_DIR)/doc
|
||||
SRC_DIR = $(BASE_DIR)/src
|
||||
PREFIX = /usr/local
|
||||
BINDIR = $(PREFIX)/bin
|
||||
DATADIR = $(PREFIX)/share/toxic
|
||||
MANDIR = $(PREFIX)/share/man
|
||||
|
||||
MANFILES = toxic.1 toxic.conf.5
|
||||
|
||||
LIBS = libtoxcore ncursesw libconfig
|
||||
|
||||
CFLAGS = -std=gnu99 -pthread -Wall -g
|
||||
@ -53,7 +56,7 @@ endif
|
||||
-include $(CFG_DIR)/checks/check_features.mk
|
||||
|
||||
# Targets
|
||||
all: toxic
|
||||
all: toxic doc
|
||||
|
||||
toxic: $(OBJ)
|
||||
@echo " LD $@"
|
||||
@ -64,11 +67,14 @@ toxic: $(OBJ)
|
||||
@$(CC) $(CFLAGS) -o $*.o -c $(SRC_DIR)/$*.c
|
||||
@$(CC) -MM $(CFLAGS) $(SRC_DIR)/$*.c > $*.d
|
||||
|
||||
doc: $(MANFILES:%=$(DOC_DIR)/%)
|
||||
|
||||
clean:
|
||||
rm -rf *.d *.o toxic
|
||||
rm -rf $(MANFILES)
|
||||
|
||||
-include $(OBJ:.o=.d)
|
||||
|
||||
-include $(CFG_DIR)/targets/*.mk
|
||||
|
||||
.PHONY: clean all
|
||||
.PHONY: clean all doc
|
||||
|
||||
@ -3,6 +3,7 @@ help:
|
||||
@echo "-- Targets --"
|
||||
@echo " all: Build toxic [DEFAULT]"
|
||||
@echo " toxic: Build toxic"
|
||||
@echo " doc: Build documentation"
|
||||
@echo " install: Build toxic and install it in PREFIX (default PREFIX is \"$(abspath $(PREFIX))\")"
|
||||
@echo " clean: Remove built files"
|
||||
@echo " help: This help"
|
||||
|
||||
@ -1,19 +1,19 @@
|
||||
MISC_DIR = $(BASE_DIR)/misc
|
||||
DOC_DIR = $(BASE_DIR)/doc
|
||||
SND_DIR = $(BASE_DIR)/sounds
|
||||
DATAFILES = DHTnodes DNSservers toxic.conf.example
|
||||
MANFILES = toxic.1 toxic.conf.5
|
||||
SNDFILES = ContactLogsIn.wav ContactLogsOut.wav Error.wav IncomingCall.wav
|
||||
SNDFILES += LogIn.wav LogOut.wav NewMessage.wav OutgoingCall.wav
|
||||
SNDFILES += TransferComplete.wav TransferPending.wav
|
||||
|
||||
install: toxic
|
||||
install: toxic doc
|
||||
mkdir -p $(abspath $(DESTDIR)/$(BINDIR))
|
||||
mkdir -p $(abspath $(DESTDIR)/$(DATADIR))
|
||||
mkdir -p $(abspath $(DESTDIR)/$(DATADIR))/sounds
|
||||
mkdir -p $(abspath $(DESTDIR)/$(MANDIR))
|
||||
|
||||
@echo "Installing toxic executable"
|
||||
@install -m 0755 toxic $(abspath $(DESTDIR)/$(BINDIR))
|
||||
|
||||
@echo "Installing data files"
|
||||
@for f in $(DATAFILES) ; do \
|
||||
install -m 0644 $(MISC_DIR)/$$f $(abspath $(DESTDIR)/$(DATADIR)) ;\
|
||||
@ -23,6 +23,7 @@ install: toxic
|
||||
@for f in $(SNDFILES) ; do \
|
||||
install -m 0644 $(SND_DIR)/$$f $(abspath $(DESTDIR)/$(DATADIR))/sounds ;\
|
||||
done
|
||||
|
||||
@echo "Installing man pages"
|
||||
@for f in $(MANFILES) ; do \
|
||||
section=$(abspath $(DESTDIR)/$(MANDIR))/man`echo $$f | rev | cut -d "." -f 1` ;\
|
||||
|
||||
12
doc/Makefile
Normal file
12
doc/Makefile
Normal file
@ -0,0 +1,12 @@
|
||||
MANFILES = toxic.1 toxic.conf.5
|
||||
|
||||
# Targets
|
||||
doc: $(MANFILES)
|
||||
|
||||
%: %.asc
|
||||
@echo " Generating man page $(@F)"
|
||||
@a2x -f manpage -a revdate=$(shell git log -1 --date=short --format="%ad" $<) \
|
||||
-a manmanual="toxic manual" -a mansource=toxic \
|
||||
-a manversion=__VERSION__ -a datadir=__DATADIR__ $<
|
||||
|
||||
.PHONY: doc
|
||||
191
doc/toxic.1
191
doc/toxic.1
@ -1,74 +1,143 @@
|
||||
.TH TOXIC 1 "August 2014" "Toxic v__VERSION__" "User Manual"
|
||||
.SH NAME
|
||||
Toxic \- CLI client for Tox
|
||||
.SH SYNOPSYS
|
||||
.B toxic [\-f
|
||||
.I data\-file
|
||||
.B ] [\-x] [\-4] [\-c
|
||||
.I config\-file
|
||||
.B ] [\-n
|
||||
.I nodes\-file
|
||||
.B ] [\-h]
|
||||
.SH 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.
|
||||
.SH OPTIONS
|
||||
.IP "\-4, \-\-ipv4"
|
||||
'\" t
|
||||
.\" Title: toxic
|
||||
.\" Author: [see the "AUTHORS" section]
|
||||
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
|
||||
.\" Date: 2014-08-21
|
||||
.\" Manual: toxic manual
|
||||
.\" Source: toxic __VERSION__
|
||||
.\" Language: English
|
||||
.\"
|
||||
.TH "TOXIC" "1" "2014\-08\-21" "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
|
||||
.IP "\-b, \-\-debug
|
||||
Enable stderr for debugging. Redirect output to avoid breaking
|
||||
the curses interface and better capture messages.
|
||||
.IP "\-c, \-\-config config\-file"
|
||||
.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
|
||||
.IP "\-d, \-\-default_locale
|
||||
\fIconfig\-file\fR
|
||||
instead of
|
||||
\fI~/\&.config/tox/toxic\&.conf\fR
|
||||
.RE
|
||||
.PP
|
||||
\-d, \-\-default_locale
|
||||
.RS 4
|
||||
Use default locale
|
||||
.I config\-file
|
||||
instead of
|
||||
.IR ~/.config/tox/toxic.conf
|
||||
.IP "\-f, \-\-file data\-file"
|
||||
.RE
|
||||
.PP
|
||||
\-f, \-\-file data\-file
|
||||
.RS 4
|
||||
Use specified
|
||||
.I data\-file
|
||||
\fIdata\-file\fR
|
||||
instead of
|
||||
.IR ~/.config/tox/data
|
||||
.IP "\-h, \-\-help"
|
||||
\fI~/\&.config/tox/data\fR
|
||||
.RE
|
||||
.PP
|
||||
\-h, \-\-help
|
||||
.RS 4
|
||||
Show help message
|
||||
.IP "\-n, \-\-nodes nodes\-file"
|
||||
.RE
|
||||
.PP
|
||||
\-n, \-\-nodes nodes\-file
|
||||
.RS 4
|
||||
Use specified
|
||||
.I nodes\-file
|
||||
\fInodes\-file\fR
|
||||
for DHT bootstrap nodes, instead of
|
||||
.IR __DATADIR__/DHTnodes
|
||||
.IP "\-o, \-\-noconnect"
|
||||
\fI__DATADIR__/DHTnodes\fR
|
||||
.RE
|
||||
.PP
|
||||
\-o, \-\-noconnect
|
||||
.RS 4
|
||||
Do not connect to the DHT network
|
||||
.IP "\-p, \-\-proxy"
|
||||
.RE
|
||||
.PP
|
||||
\-p, \-\-proxy
|
||||
.RS 4
|
||||
Use proxy: Requires [IP] [port]
|
||||
.IP "\-r, \-\-dnslist"
|
||||
.RE
|
||||
.PP
|
||||
\-r, \-\-dnslist
|
||||
.RS 4
|
||||
Use specified DNSservers file
|
||||
.IP "\-t, \-\-force\-tcp"
|
||||
.RE
|
||||
.PP
|
||||
\-t, \-\-force\-tcp
|
||||
.RS 4
|
||||
Force TCP connection (use this with proxies)
|
||||
.IP "\-x, \-\-nodata"
|
||||
.RE
|
||||
.PP
|
||||
\-x, \-\-nodata
|
||||
.RS 4
|
||||
Ignore data file
|
||||
.SH FILES
|
||||
.IP __DATADIR__/DHTnodes
|
||||
Default list of DHT bootstrap nodes.
|
||||
.IP ~/.config/tox/data
|
||||
Savestate which contains your personal info (nickname, Tox ID,...) and
|
||||
your contacts list.
|
||||
.IP ~/.config/tox/toxic.conf
|
||||
Configuration file. See
|
||||
.BR toxic.conf (5)
|
||||
for more details.
|
||||
.IP __DATADIR__/toxic.conf.example
|
||||
Configuration example.
|
||||
.SH BUGS
|
||||
Unicode characters with a width larger than 1 column may cause
|
||||
strange behaviour. Expect more bugs and bad
|
||||
behaviour: this software is in a pre\-alpha stage.
|
||||
.SH AUTHORS
|
||||
JFreegman <JFreegman@gmail.com>
|
||||
.SH SEE ALSO
|
||||
.BR toxic.conf (5)
|
||||
.SH LINKS
|
||||
Project page on github: https://github.com/Tox/toxic
|
||||
.br
|
||||
IRC channel on Freenode: chat.freenode.net#tox
|
||||
.RE
|
||||
.SH "FILES"
|
||||
.PP
|
||||
__DATADIR__/DHTnodes
|
||||
.RS 4
|
||||
Default list of DHT bootstrap nodes\&.
|
||||
.RE
|
||||
.PP
|
||||
~/\&.config/tox/data
|
||||
.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\&. Expect more bugs and bad behaviour: this software is in a pre\-alpha stage\&.
|
||||
.SH "AUTHORS"
|
||||
.sp
|
||||
JFreegman <JFreegman@gmail\&.com>
|
||||
.SH "SEE ALSO"
|
||||
.sp
|
||||
\fBtoxic\&.conf\fR(5)
|
||||
.SH "LINKS"
|
||||
.sp
|
||||
Project page: https://github\&.com/Tox/toxic
|
||||
.sp
|
||||
IRC channel: chat\&.freenode\&.net#tox
|
||||
|
||||
91
doc/toxic.1.asc
Normal file
91
doc/toxic.1.asc
Normal file
@ -0,0 +1,91 @@
|
||||
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
|
||||
|
||||
-f, --file data-file::
|
||||
Use specified 'data-file' instead of '~/.config/tox/data'
|
||||
|
||||
-h, --help::
|
||||
Show help message
|
||||
|
||||
-n, --nodes nodes-file::
|
||||
Use specified 'nodes-file' for DHT bootstrap nodes, instead of
|
||||
'{datadir}/DHTnodes'
|
||||
|
||||
-o, --noconnect::
|
||||
Do not connect to the DHT network
|
||||
|
||||
-p, --proxy::
|
||||
Use proxy: Requires [IP] [port]
|
||||
|
||||
-r, --dnslist::
|
||||
Use specified DNSservers file
|
||||
|
||||
-t, --force-tcp::
|
||||
Force TCP connection (use this with proxies)
|
||||
|
||||
-x, --nodata::
|
||||
Ignore data file
|
||||
|
||||
FILES
|
||||
-----
|
||||
{datadir}/DHTnodes::
|
||||
Default list of DHT bootstrap nodes.
|
||||
|
||||
~/.config/tox/data::
|
||||
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. Expect more bugs and bad behaviour: this software is in a
|
||||
pre-alpha stage.
|
||||
|
||||
AUTHORS
|
||||
-------
|
||||
JFreegman <JFreegman@gmail.com>
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
*toxic.conf*(5)
|
||||
|
||||
LINKS
|
||||
-----
|
||||
Project page: <https://github.com/Tox/toxic>
|
||||
|
||||
IRC channel: chat.freenode.net#tox
|
||||
417
doc/toxic.conf.5
417
doc/toxic.conf.5
@ -1,295 +1,266 @@
|
||||
.TH TOXIC.CONF 5 "August 2014" "Toxic v__VERSION__" "User Manual"
|
||||
.SH NAME
|
||||
toxic.conf \- Configuration file for toxic(1)
|
||||
.SH DESCRIPTION
|
||||
The
|
||||
.I toxic.conf
|
||||
file is the main configuration file for
|
||||
.BR toxic (1)
|
||||
client.
|
||||
.SH SYNTAX
|
||||
.I <SECTION>
|
||||
.B = {
|
||||
'\" t
|
||||
.\" Title: toxic.conf
|
||||
.\" Author: [see the "AUTHORS" section]
|
||||
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
|
||||
.\" Date: 2014-08-21
|
||||
.\" Manual: toxic manual
|
||||
.\" Source: toxic __VERSION__
|
||||
.\" Language: English
|
||||
.\"
|
||||
.TH "TOXIC\&.CONF" "5" "2014\-08\-21" "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.conf \- Configuration file for toxic
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
~/\&.config/tox/toxic\&.conf
|
||||
.SH "DESCRIPTION"
|
||||
.sp
|
||||
The \fItoxic\&.conf\fR file is the main configuration file for \fBtoxic\fR(1) client\&. It uses syntax accepted by \fBlibconfig\fR\&. Lines starting with "//" are comments and will be ignored\&.
|
||||
.SH "EXAMPLE"
|
||||
.sp
|
||||
.if n \{\
|
||||
.RS 4
|
||||
.\}
|
||||
.nf
|
||||
// Configuration for interface
|
||||
ui = {
|
||||
timestamps = true;
|
||||
alerts = false;
|
||||
};
|
||||
|
||||
// Configuration for audio
|
||||
audio = {
|
||||
input_device = 1;
|
||||
};
|
||||
.fi
|
||||
.if n \{\
|
||||
.RE
|
||||
.\}
|
||||
.SH "OPTIONS"
|
||||
.PP
|
||||
.IB <KEY1> = <VALUE1> ;
|
||||
.br
|
||||
.IB <KEY2> = <VALUE2> ;
|
||||
.br
|
||||
...
|
||||
\fBui\fR
|
||||
.RS 4
|
||||
Configuration related to interface elements\&.
|
||||
.PP
|
||||
.B };
|
||||
.PP
|
||||
Uses syntax accepted by libconfig.
|
||||
.br
|
||||
Lines starting with "//" are comments and will be ignored.
|
||||
.PP
|
||||
Sections:
|
||||
.PP
|
||||
.B ui
|
||||
.RS
|
||||
Configurations related to user interface elements.
|
||||
.PP
|
||||
Keys:
|
||||
.br
|
||||
.B timestamps
|
||||
.RS
|
||||
Enable or disable timestamps.
|
||||
.br
|
||||
Values: 'true' to enable, 'false' to disable
|
||||
\fBtimestamps\fR
|
||||
.RS 4
|
||||
Enable or disable timestamps\&. true or false
|
||||
.RE
|
||||
.PP
|
||||
.B alerts
|
||||
.RS
|
||||
Enable or disable terminal alerts on events.
|
||||
.br
|
||||
Values: 'true' to enable, 'false' to disable
|
||||
\fBalerts\fR
|
||||
.RS 4
|
||||
Enable or disable terminal alerts on events\&. true or false
|
||||
.RE
|
||||
.PP
|
||||
.B native_colors
|
||||
.RS
|
||||
Select between native terminal colors and toxic color theme.
|
||||
.br
|
||||
Values: 'true' for terminal colours, 'false' for toxic colours
|
||||
\fBnative_colors\fR
|
||||
.RS 4
|
||||
Select between native terminal colors and toxic color theme\&. true or false
|
||||
.RE
|
||||
.PP
|
||||
.B autolog
|
||||
.RS
|
||||
Enable or disable autologging.
|
||||
.br
|
||||
Values: 'true' to enable, 'false' to disable
|
||||
\fBautolog\fR
|
||||
.RS 4
|
||||
Enable or disable autologging\&. true or false
|
||||
.RE
|
||||
.PP
|
||||
.B time_format
|
||||
.RS
|
||||
Select between 24 and 12 hour time.
|
||||
.br
|
||||
Values: 24, 12
|
||||
\fBtime_format\fR
|
||||
.RS 4
|
||||
Select between 24 and 12 hour time\&. Specify 24 or 12
|
||||
.RE
|
||||
.PP
|
||||
.B show_typing_other
|
||||
.RS
|
||||
Show you when others are typing in a 1-on-1 chat
|
||||
.br
|
||||
Values: 'true' to enable, 'false' to disable
|
||||
\fBshow_typing_other\fR
|
||||
.RS 4
|
||||
Show when others are typing in a 1\-on\-1 chat\&. true or false
|
||||
.RE
|
||||
.PP
|
||||
.B show_typing_self
|
||||
.RS
|
||||
Show others when you're typing in a 1-on-1 chat
|
||||
.br
|
||||
Values: 'true' to enable, 'false' to disable
|
||||
\fBshow_typing_self\fR
|
||||
.RS 4
|
||||
Show others when you\(cqre typing in a 1\-on\-1 chat\&. true or false
|
||||
.RE
|
||||
.PP
|
||||
.B history_size
|
||||
.RS
|
||||
Maximum lines for chat window history.
|
||||
.br
|
||||
Values: <INTEGER> (for example: 700)
|
||||
\fBhistory_size\fR
|
||||
.RS 4
|
||||
Maximum lines for chat window history\&. Integer value\&. (for example: 700)
|
||||
.RE
|
||||
.RE
|
||||
.PP
|
||||
.B audio
|
||||
.RS
|
||||
Configurations related to audio devices.
|
||||
\fBaudio\fR
|
||||
.RS 4
|
||||
Configuration related to audio devices\&.
|
||||
.PP
|
||||
Keys:
|
||||
.br
|
||||
.B input_device
|
||||
.RS
|
||||
Audio input device.
|
||||
.br
|
||||
Values: <INTEGER> (number correspond to "/lsdev in")
|
||||
\fBinput_device\fR
|
||||
.RS 4
|
||||
Audio input device\&. Integer value\&. Number corresponds to
|
||||
/lsdev in
|
||||
.RE
|
||||
.PP
|
||||
.B output_device
|
||||
.RS
|
||||
Audio output device.
|
||||
.br
|
||||
Values: <INTEGER> (number correspond to "/lsdev out")
|
||||
\fBoutput_device\fR
|
||||
.RS 4
|
||||
Audio output device\&. Integer value\&. Number corresponds to
|
||||
/lsdev out
|
||||
.RE
|
||||
.PP
|
||||
.B VAD_treshold
|
||||
.RS
|
||||
Voice Activity Detection treshold.
|
||||
.br
|
||||
Values: <FLOAT> (recommended values are around 40.0)
|
||||
\fBVAD_treshold\fR
|
||||
.RS 4
|
||||
Voice Activity Detection treshold\&. Float value\&. Recommended values are around 40\&.0
|
||||
.RE
|
||||
.RE
|
||||
.PP
|
||||
.B tox
|
||||
.RS
|
||||
Configurations related to file transfer.
|
||||
\fBtox\fR
|
||||
.RS 4
|
||||
Configuration related to file transfer\&.
|
||||
.PP
|
||||
Keys:
|
||||
.br
|
||||
.B download_path
|
||||
.RS
|
||||
Default path for downloads.
|
||||
.br
|
||||
Values: <STRING> (absolute path where to store downloaded files)
|
||||
\fBdownload_path\fR
|
||||
.RS 4
|
||||
Default path for downloads\&. String value\&. Absolute path where to store downloaded files
|
||||
.RE
|
||||
.RE
|
||||
.PP
|
||||
.B sounds
|
||||
.RS
|
||||
Configurations related to notification sounds.
|
||||
.br
|
||||
(Special value "silent" can be used to disable a specific notification)
|
||||
\fBsounds\fR
|
||||
.RS 4
|
||||
Configuration related to notification sounds\&. Special value "silent" can be used to disable a specific notification\&.
|
||||
|
||||
Each value is a string which corresponds to the absolute path of a wav sound file\&.
|
||||
.PP
|
||||
Keys:
|
||||
.br
|
||||
.B error
|
||||
.RS
|
||||
Sound to play when an error occurs.
|
||||
.br
|
||||
Values: <STRING> (sound file absolute path)
|
||||
\fBerror\fR
|
||||
.RS 4
|
||||
Sound to play when an error occurs\&.
|
||||
.RE
|
||||
.PP
|
||||
.B self_log_in
|
||||
.RS
|
||||
Sound to play when you log in.
|
||||
.br
|
||||
Values: <STRING> (sound file absolute path)
|
||||
\fBself_log_in\fR
|
||||
.RS 4
|
||||
Sound to play when you log in\&.
|
||||
.RE
|
||||
.PP
|
||||
.B self_log_out
|
||||
.RS
|
||||
Sound to play when you log out.
|
||||
.br
|
||||
Values: <STRING> (sound file absolute path)
|
||||
\fBself_log_out\fR
|
||||
.RS 4
|
||||
Sound to play when you log out\&.
|
||||
.RE
|
||||
.PP
|
||||
.B user_log_in
|
||||
.RS
|
||||
Sound to play when a contact become online.
|
||||
.br
|
||||
Values: <STRING> (sound file absolute path)
|
||||
\fBuser_log_in\fR
|
||||
.RS 4
|
||||
Sound to play when a contact become online\&.
|
||||
.RE
|
||||
.PP
|
||||
.B user_log_out
|
||||
.RS
|
||||
Sound to play when a contact become offline.
|
||||
.br
|
||||
Values: <STRING> (sound file absolute path)
|
||||
\fBuser_log_out\fR
|
||||
.RS 4
|
||||
Sound to play when a contact become offline\&.
|
||||
.RE
|
||||
.PP
|
||||
.B call_incoming
|
||||
.RS
|
||||
Sound to play when you receive an incoming call.
|
||||
.br
|
||||
Values: <STRING> (sound file absolute path)
|
||||
\fBcall_incoming\fR
|
||||
.RS 4
|
||||
Sound to play when you receive an incoming call\&.
|
||||
.RE
|
||||
.PP
|
||||
.B call_outgoing
|
||||
.RS
|
||||
Sound to play when you start a call.
|
||||
.br
|
||||
Values: <STRING> (sound file absolute path)
|
||||
\fBcall_outgoing\fR
|
||||
.RS 4
|
||||
Sound to play when you start a call\&.
|
||||
.RE
|
||||
.PP
|
||||
.B generic_message
|
||||
.RS
|
||||
Sound to play when an event occurs.
|
||||
.br
|
||||
Values: <STRING> (sound file absolute path)
|
||||
\fBgeneric_message\fR
|
||||
.RS 4
|
||||
Sound to play when an event occurs\&.
|
||||
.RE
|
||||
.PP
|
||||
.B transfer_pending
|
||||
.RS
|
||||
Sound to play when you receive a file transfer request.
|
||||
.br
|
||||
Values: <STRING> (sound file absolute path)
|
||||
\fBtransfer_pending\fR
|
||||
.RS 4
|
||||
Sound to play when you receive a file transfer request\&.
|
||||
.RE
|
||||
.PP
|
||||
.B transfer_completed
|
||||
.RS
|
||||
Sound to play when a file transfer is completed.
|
||||
.br
|
||||
Values: <STRING> (sound file absolute path)
|
||||
\fBtransfer_completed\fR
|
||||
.RS 4
|
||||
Sound to play when a file transfer is completed\&.
|
||||
.RE
|
||||
.RE
|
||||
.PP
|
||||
.B keys
|
||||
.RS
|
||||
Configurations related to user interface interaction.
|
||||
.br
|
||||
(Currently supported: Ctrl modified keys, Tab, PAGEUP and PAGEDOWN (case insensitive))
|
||||
\fBkeys\fR
|
||||
.RS 4
|
||||
Configuration related to user interface interaction\&. Currently supported: Ctrl modified keys, Tab, PAGEUP and PAGEDOWN\&.
|
||||
|
||||
Each value is a string which corresponds to a key combination\&.
|
||||
.PP
|
||||
Keys:
|
||||
.br
|
||||
.B next_tab
|
||||
.RS
|
||||
Key combination to switch next tab.
|
||||
.br
|
||||
Values: <STRING> (key combination)
|
||||
\fBnext_tab\fR
|
||||
.RS 4
|
||||
Key combination to switch next tab\&.
|
||||
.RE
|
||||
.PP
|
||||
.B prev_tab
|
||||
.RS
|
||||
Key combination to switch previous tab.
|
||||
.br
|
||||
Values: <STRING> (key combination)
|
||||
\fBprev_tab\fR
|
||||
.RS 4
|
||||
Key combination to switch previous tab\&.
|
||||
.RE
|
||||
.PP
|
||||
.B scroll_line_up
|
||||
.RS
|
||||
Key combination to scroll one line up.
|
||||
.br
|
||||
Values: <STRING> (key combination)
|
||||
\fBscroll_line_up\fR
|
||||
.RS 4
|
||||
Key combination to scroll one line up\&.
|
||||
.RE
|
||||
.PP
|
||||
.B scroll_line_down
|
||||
.RS
|
||||
Key combination to scroll one line down.
|
||||
.br
|
||||
Values: <STRING> (key combination)
|
||||
\fBscroll_line_down\fR
|
||||
.RS 4
|
||||
Key combination to scroll one line down\&.
|
||||
.RE
|
||||
.PP
|
||||
.B half_page_up
|
||||
.RS
|
||||
Key combination to scroll half page up.
|
||||
.br
|
||||
Values: <STRING> (key combination)
|
||||
\fBhalf_page_up\fR
|
||||
.RS 4
|
||||
Key combination to scroll half page up\&.
|
||||
.RE
|
||||
.PP
|
||||
.B half_page_down
|
||||
.RS
|
||||
Key combination to scroll half page down.
|
||||
.br
|
||||
Values: <STRING> (key combination)
|
||||
\fBhalf_page_down\fR
|
||||
.RS 4
|
||||
Key combination to scroll half page down\&.
|
||||
.RE
|
||||
.PP
|
||||
.B page_bottom
|
||||
.RS
|
||||
Key combination to scroll to page bottom.
|
||||
.br
|
||||
Values: <STRING> (key combination)
|
||||
\fBpage_bottom\fR
|
||||
.RS 4
|
||||
Key combination to scroll to page bottom\&.
|
||||
.RE
|
||||
.PP
|
||||
.B peer_list_up
|
||||
.RS
|
||||
Key combination to scroll contacts list up.
|
||||
.br
|
||||
Values: <STRING> (key combination)
|
||||
\fBpeer_list_up\fR
|
||||
.RS 4
|
||||
Key combination to scroll contacts list up\&.
|
||||
.RE
|
||||
.PP
|
||||
.B peer_list_down
|
||||
.RS
|
||||
Key combination to scroll contacts list down.
|
||||
.br
|
||||
Values: <STRING> (key combination)
|
||||
\fBpeer_list_down\fR
|
||||
.RS 4
|
||||
Key combination to scroll contacts list down\&.
|
||||
.RE
|
||||
.RE
|
||||
.SH FILES
|
||||
.IP ~/.config/tox/toxic.conf
|
||||
Main configuration file.
|
||||
.IP __DATADIR__/toxic.conf.example
|
||||
Configuration example.
|
||||
.SH AUTHORS
|
||||
JFreegman <JFreegman@gmail.com>
|
||||
.SH SEE ALSO
|
||||
.BR toxic (1)
|
||||
.SH LINKS
|
||||
Project page on github: https://github.com/Tox/toxic
|
||||
.br
|
||||
IRC channel on Freenode: chat.freenode.net#tox
|
||||
.SH "FILES"
|
||||
.PP
|
||||
~/\&.config/tox/toxic\&.conf
|
||||
.RS 4
|
||||
Main configuration file\&.
|
||||
.RE
|
||||
.PP
|
||||
__DATADIR__/toxic\&.conf\&.example
|
||||
.RS 4
|
||||
Configuration example\&.
|
||||
.RE
|
||||
.SH "SEE ALSO"
|
||||
.sp
|
||||
\fBtoxic\fR(1)
|
||||
.SH "RESOURCES"
|
||||
.sp
|
||||
Project page: https://github\&.com/Tox/toxic
|
||||
.sp
|
||||
IRC channel: chat\&.freenode\&.net#tox
|
||||
.SH "AUTHORS"
|
||||
.sp
|
||||
JFreegman <JFreegman@gmail\&.com>
|
||||
|
||||
179
doc/toxic.conf.5.asc
Normal file
179
doc/toxic.conf.5.asc
Normal file
@ -0,0 +1,179 @@
|
||||
toxic.conf(5)
|
||||
=============
|
||||
|
||||
NAME
|
||||
----
|
||||
toxic.conf - Configuration file for toxic
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
~/.config/tox/toxic.conf
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
The 'toxic.conf' file is the main configuration file for *toxic*(1) client.
|
||||
It uses syntax accepted by *libconfig*.
|
||||
Lines starting with "//" are comments and will be ignored.
|
||||
|
||||
|
||||
EXAMPLE
|
||||
-------
|
||||
----
|
||||
// Configuration for interface
|
||||
ui = {
|
||||
timestamps = true;
|
||||
alerts = false;
|
||||
};
|
||||
|
||||
// Configuration for audio
|
||||
audio = {
|
||||
input_device = 1;
|
||||
};
|
||||
----
|
||||
|
||||
|
||||
OPTIONS
|
||||
-------
|
||||
*ui*::
|
||||
Configuration related to interface elements.
|
||||
|
||||
*timestamps*;;
|
||||
Enable or disable timestamps. true or false
|
||||
|
||||
*alerts*;;
|
||||
Enable or disable terminal alerts on events. true or false
|
||||
|
||||
*native_colors*;;
|
||||
Select between native terminal colors and toxic color theme. true or false
|
||||
|
||||
*autolog*;;
|
||||
Enable or disable autologging. true or false
|
||||
|
||||
*time_format*;;
|
||||
Select between 24 and 12 hour time. Specify 24 or 12
|
||||
|
||||
*show_typing_other*;;
|
||||
Show when others are typing in a 1-on-1 chat. true or false
|
||||
|
||||
*show_typing_self*;;
|
||||
Show others when you're typing in a 1-on-1 chat. true or false
|
||||
|
||||
*history_size*;;
|
||||
Maximum lines for chat window history. Integer value. (for example: 700)
|
||||
|
||||
|
||||
*audio*::
|
||||
Configuration related to audio devices.
|
||||
|
||||
*input_device*;;
|
||||
Audio input device. Integer value. Number corresponds to `/lsdev in`
|
||||
|
||||
*output_device*;;
|
||||
Audio output device. Integer value. Number corresponds to `/lsdev out`
|
||||
|
||||
*VAD_treshold*;;
|
||||
Voice Activity Detection treshold. Float value. Recommended values are
|
||||
around 40.0
|
||||
|
||||
*tox*::
|
||||
Configuration related to file transfer.
|
||||
|
||||
*download_path*;;
|
||||
Default path for downloads. String value. Absolute path where to store
|
||||
downloaded files
|
||||
|
||||
*sounds*::
|
||||
Configuration related to notification sounds.
|
||||
Special value "silent" can be used to disable a specific notification. +
|
||||
Each value is a string which corresponds to the absolute path of a wav
|
||||
sound file.
|
||||
|
||||
*error*;;
|
||||
Sound to play when an error occurs.
|
||||
|
||||
*self_log_in*;;
|
||||
Sound to play when you log in.
|
||||
|
||||
*self_log_out*;;
|
||||
Sound to play when you log out.
|
||||
|
||||
*user_log_in*;;
|
||||
Sound to play when a contact become online.
|
||||
|
||||
*user_log_out*;;
|
||||
Sound to play when a contact become offline.
|
||||
|
||||
*call_incoming*;;
|
||||
Sound to play when you receive an incoming call.
|
||||
|
||||
*call_outgoing*;;
|
||||
Sound to play when you start a call.
|
||||
|
||||
*generic_message*;;
|
||||
Sound to play when an event occurs.
|
||||
|
||||
*transfer_pending*;;
|
||||
Sound to play when you receive a file transfer request.
|
||||
|
||||
*transfer_completed*;;
|
||||
Sound to play when a file transfer is completed.
|
||||
|
||||
*keys*::
|
||||
Configuration related to user interface interaction.
|
||||
Currently supported: Ctrl modified keys, Tab, PAGEUP and PAGEDOWN. +
|
||||
Each value is a string which corresponds to a key combination.
|
||||
|
||||
*next_tab*;;
|
||||
Key combination to switch next tab.
|
||||
|
||||
*prev_tab*;;
|
||||
Key combination to switch previous tab.
|
||||
|
||||
*scroll_line_up*;;
|
||||
Key combination to scroll one line up.
|
||||
|
||||
*scroll_line_down*;;
|
||||
Key combination to scroll one line down.
|
||||
|
||||
*half_page_up*;;
|
||||
Key combination to scroll half page up.
|
||||
|
||||
*half_page_down*;;
|
||||
Key combination to scroll half page down.
|
||||
|
||||
*page_bottom*;;
|
||||
Key combination to scroll to page bottom.
|
||||
|
||||
*peer_list_up*;;
|
||||
Key combination to scroll contacts list up.
|
||||
|
||||
*peer_list_down*;;
|
||||
Key combination to scroll contacts list down.
|
||||
|
||||
|
||||
FILES
|
||||
-----
|
||||
~/.config/tox/toxic.conf::
|
||||
Main configuration file.
|
||||
|
||||
{datadir}/toxic.conf.example::
|
||||
Configuration example.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
*toxic*(1)
|
||||
|
||||
|
||||
RESOURCES
|
||||
---------
|
||||
Project page: <https://github.com/Tox/toxic>
|
||||
|
||||
IRC channel: chat.freenode.net#tox
|
||||
|
||||
|
||||
AUTHORS
|
||||
-------
|
||||
JFreegman <JFreegman@gmail.com>
|
||||
Loading…
Reference in New Issue
Block a user