Tha_14/toxic
1
0
Fork 0
mirror of https://github.com/Tha14/toxic.git synced 2024-11-26 14:03:27 +01:00
Code Issues Projects Releases Wiki Activity

Merge pull request #230 from louipc/manpage

Browse Source 
Manpage
This commit is contained in:
JFreegman 2014-08-25 00:49:31 -04:00
commit 53193e933f
9 changed files with 624 additions and 289 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -22,6 +22,11 @@ Toxic is a [Tox](https://tox.im)-based instant messenging client which formerly
##### Desktop notifications ##### Desktop notifications
* [libnotify](https://developer.gnome.org/libnotify) (for Debian based systems, 'libnotify-dev') * [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 ### Compiling
1. `cd build/` 1. `cd build/`
2. `make PREFIX="/where/to/install"` 2. `make PREFIX="/where/to/install"`

10
build/Makefile
View File

@ -4,12 +4,15 @@ VERSION = $(TOXIC_VERSION)_r$(REV)
BASE_DIR = $(shell cd .. && pwd -P) BASE_DIR = $(shell cd .. && pwd -P)
CFG_DIR = $(BASE_DIR)/cfg CFG_DIR = $(BASE_DIR)/cfg
DOC_DIR = $(BASE_DIR)/doc
SRC_DIR = $(BASE_DIR)/src SRC_DIR = $(BASE_DIR)/src
PREFIX = /usr/local PREFIX = /usr/local
BINDIR = $(PREFIX)/bin BINDIR = $(PREFIX)/bin
DATADIR = $(PREFIX)/share/toxic DATADIR = $(PREFIX)/share/toxic
MANDIR = $(PREFIX)/share/man MANDIR = $(PREFIX)/share/man
MANFILES = toxic.1 toxic.conf.5
LIBS = libtoxcore ncursesw libconfig LIBS = libtoxcore ncursesw libconfig
CFLAGS = -std=gnu99 -pthread -Wall -g CFLAGS = -std=gnu99 -pthread -Wall -g
@ -53,7 +56,7 @@ endif
-include $(CFG_DIR)/checks/check_features.mk -include $(CFG_DIR)/checks/check_features.mk
# Targets # Targets
all: toxic all: toxic doc
toxic: $(OBJ) toxic: $(OBJ)
@echo " LD $@" @echo " LD $@"
@ -64,11 +67,14 @@ toxic: $(OBJ)
@$(CC) $(CFLAGS) -o $*.o -c $(SRC_DIR)/$*.c @$(CC) $(CFLAGS) -o $*.o -c $(SRC_DIR)/$*.c
@$(CC) -MM $(CFLAGS) $(SRC_DIR)/$*.c > $*.d @$(CC) -MM $(CFLAGS) $(SRC_DIR)/$*.c > $*.d
doc: $(MANFILES:%=$(DOC_DIR)/%)
clean: clean:
rm -rf *.d *.o toxic rm -rf *.d *.o toxic
rm -rf $(MANFILES)
-include $(OBJ:.o=.d) -include $(OBJ:.o=.d)
-include $(CFG_DIR)/targets/*.mk -include $(CFG_DIR)/targets/*.mk
.PHONY: clean all .PHONY: clean all doc

1
cfg/targets/help.mk
View File

@ -3,6 +3,7 @@ help:
@echo "-- Targets --" @echo "-- Targets --"
@echo " all: Build toxic [DEFAULT]" @echo " all: Build toxic [DEFAULT]"
@echo " toxic: Build toxic" @echo " toxic: Build toxic"
@echo " doc: Build documentation"
@echo " install: Build toxic and install it in PREFIX (default PREFIX is \"$(abspath $(PREFIX))\")" @echo " install: Build toxic and install it in PREFIX (default PREFIX is \"$(abspath $(PREFIX))\")"
@echo " clean: Remove built files" @echo " clean: Remove built files"
@echo " help: This help" @echo " help: This help"

7
cfg/targets/install.mk
View File

@ -1,19 +1,19 @@
MISC_DIR = $(BASE_DIR)/misc MISC_DIR = $(BASE_DIR)/misc
DOC_DIR = $(BASE_DIR)/doc
SND_DIR = $(BASE_DIR)/sounds SND_DIR = $(BASE_DIR)/sounds
DATAFILES = DHTnodes DNSservers toxic.conf.example DATAFILES = DHTnodes DNSservers toxic.conf.example
MANFILES = toxic.1 toxic.conf.5
SNDFILES = ContactLogsIn.wav ContactLogsOut.wav Error.wav IncomingCall.wav SNDFILES = ContactLogsIn.wav ContactLogsOut.wav Error.wav IncomingCall.wav
SNDFILES += LogIn.wav LogOut.wav NewMessage.wav OutgoingCall.wav SNDFILES += LogIn.wav LogOut.wav NewMessage.wav OutgoingCall.wav
SNDFILES += TransferComplete.wav TransferPending.wav SNDFILES += TransferComplete.wav TransferPending.wav
install: toxic install: toxic doc
mkdir -p $(abspath $(DESTDIR)/$(BINDIR)) mkdir -p $(abspath $(DESTDIR)/$(BINDIR))
mkdir -p $(abspath $(DESTDIR)/$(DATADIR)) mkdir -p $(abspath $(DESTDIR)/$(DATADIR))
mkdir -p $(abspath $(DESTDIR)/$(DATADIR))/sounds mkdir -p $(abspath $(DESTDIR)/$(DATADIR))/sounds
mkdir -p $(abspath $(DESTDIR)/$(MANDIR)) mkdir -p $(abspath $(DESTDIR)/$(MANDIR))
@echo "Installing toxic executable" @echo "Installing toxic executable"
@install -m 0755 toxic $(abspath $(DESTDIR)/$(BINDIR)) @install -m 0755 toxic $(abspath $(DESTDIR)/$(BINDIR))
@echo "Installing data files" @echo "Installing data files"
@for f in $(DATAFILES) ; do \ @for f in $(DATAFILES) ; do \
install -m 0644 $(MISC_DIR)/$$f $(abspath $(DESTDIR)/$(DATADIR)) ;\ install -m 0644 $(MISC_DIR)/$$f $(abspath $(DESTDIR)/$(DATADIR)) ;\
@ -23,6 +23,7 @@ install: toxic
@for f in $(SNDFILES) ; do \ @for f in $(SNDFILES) ; do \
install -m 0644 $(SND_DIR)/$$f $(abspath $(DESTDIR)/$(DATADIR))/sounds ;\ install -m 0644 $(SND_DIR)/$$f $(abspath $(DESTDIR)/$(DATADIR))/sounds ;\
done done
@echo "Installing man pages" @echo "Installing man pages"
@for f in $(MANFILES) ; do \ @for f in $(MANFILES) ; do \
section=$(abspath $(DESTDIR)/$(MANDIR))/man`echo $$f | rev | cut -d "." -f 1` ;\ section=$(abspath $(DESTDIR)/$(MANDIR))/man`echo $$f | rev | cut -d "." -f 1` ;\

12
doc/Makefile Normal file
View 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
View File

@ -1,74 +1,143 @@
.TH TOXIC 1 "August 2014" "Toxic v__VERSION__" "User Manual" '\" t
.SH NAME .\" Title: toxic
Toxic \- CLI client for Tox .\" Author: [see the "AUTHORS" section]
.SH SYNOPSYS .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.B toxic [\-f .\" Date: 2014-08-21
.I data\-file .\" Manual: toxic manual
.B ] [\-x] [\-4] [\-c .\" Source: toxic __VERSION__
.I config\-file .\" Language: English
.B ] [\-n .\"
.I nodes\-file .TH "TOXIC" "1" "2014\-08\-21" "toxic __VERSION__" "toxic manual"
.B ] [\-h] .\" -----------------------------------------------------------------
.SH DESCRIPTION .\" * Define some portability stuff
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. .\" http://bugs.debian.org/507673
.SH OPTIONS .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.IP "\-4, \-\-ipv4" .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.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 Force IPv4 connection
.IP "\-b, \-\-debug .RE
Enable stderr for debugging. Redirect output to avoid breaking .PP
the curses interface and better capture messages. \-b, \-\-debug
.IP "\-c, \-\-config config\-file" .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 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 Use default locale
.I config\-file .RE
instead of .PP
.IR ~/.config/tox/toxic.conf \-f, \-\-file data\-file
.IP "\-f, \-\-file data\-file" .RS 4
Use specified Use specified
.I data\-file \fIdata\-file\fR
instead of instead of
.IR ~/.config/tox/data \fI~/\&.config/tox/data\fR
.IP "\-h, \-\-help" .RE
.PP
\-h, \-\-help
.RS 4
Show help message Show help message
.IP "\-n, \-\-nodes nodes\-file" .RE
.PP
\-n, \-\-nodes nodes\-file
.RS 4
Use specified Use specified
.I nodes\-file \fInodes\-file\fR
for DHT bootstrap nodes, instead of for DHT bootstrap nodes, instead of
.IR __DATADIR__/DHTnodes \fI__DATADIR__/DHTnodes\fR
.IP "\-o, \-\-noconnect" .RE
.PP
\-o, \-\-noconnect
.RS 4
Do not connect to the DHT network Do not connect to the DHT network
.IP "\-p, \-\-proxy" .RE
.PP
\-p, \-\-proxy
.RS 4
Use proxy: Requires [IP] [port] Use proxy: Requires [IP] [port]
.IP "\-r, \-\-dnslist" .RE
.PP
\-r, \-\-dnslist
.RS 4
Use specified DNSservers file Use specified DNSservers file
.IP "\-t, \-\-force\-tcp" .RE
.PP
\-t, \-\-force\-tcp
.RS 4
Force TCP connection (use this with proxies) Force TCP connection (use this with proxies)
.IP "\-x, \-\-nodata" .RE
.PP
\-x, \-\-nodata
.RS 4
Ignore data file Ignore data file
.SH FILES .RE
.IP __DATADIR__/DHTnodes .SH "FILES"
Default list of DHT bootstrap nodes. .PP
.IP ~/.config/tox/data __DATADIR__/DHTnodes
Savestate which contains your personal info (nickname, Tox ID,...) and .RS 4
your contacts list. Default list of DHT bootstrap nodes\&.
.IP ~/.config/tox/toxic.conf .RE
Configuration file. See .PP
.BR toxic.conf (5) ~/\&.config/tox/data
for more details. .RS 4
.IP __DATADIR__/toxic.conf.example Savestate which contains your personal info (nickname, Tox ID, contacts, etc)
Configuration example. .RE
.SH BUGS .PP
Unicode characters with a width larger than 1 column may cause ~/\&.config/tox/toxic\&.conf
strange behaviour. Expect more bugs and bad .RS 4
behaviour: this software is in a pre\-alpha stage. Configuration file\&. See
.SH AUTHORS \fBtoxic\&.conf\fR(5) for more details\&.
JFreegman <JFreegman@gmail.com> .RE
.SH SEE ALSO .PP
.BR toxic.conf (5) __DATADIR__/toxic\&.conf\&.example
.SH LINKS .RS 4
Project page on github: https://github.com/Tox/toxic Configuration example\&.
.br .RE
IRC channel on Freenode: chat.freenode.net#tox .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
View 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
View File

@ -1,295 +1,266 @@
.TH TOXIC.CONF 5 "August 2014" "Toxic v__VERSION__" "User Manual" '\" t
.SH NAME .\" Title: toxic.conf
toxic.conf \- Configuration file for toxic(1) .\" Author: [see the "AUTHORS" section]
.SH DESCRIPTION .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
The .\" Date: 2014-08-21
.I toxic.conf .\" Manual: toxic manual
file is the main configuration file for .\" Source: toxic __VERSION__
.BR toxic (1) .\" Language: English
client. .\"
.SH SYNTAX .TH "TOXIC\&.CONF" "5" "2014\-08\-21" "toxic __VERSION__" "toxic manual"
.I <SECTION> .\" -----------------------------------------------------------------
.B = { .\" * 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 .PP
.IB <KEY1> = <VALUE1> ; \fBui\fR
.br .RS 4
.IB <KEY2> = <VALUE2> ; Configuration related to interface elements\&.
.br
...
.PP .PP
.B }; \fBtimestamps\fR
.PP .RS 4
Uses syntax accepted by libconfig. Enable or disable timestamps\&. true or false
.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
.RE .RE
.PP .PP
.B alerts \fBalerts\fR
.RS .RS 4
Enable or disable terminal alerts on events. Enable or disable terminal alerts on events\&. true or false
.br
Values: 'true' to enable, 'false' to disable
.RE .RE
.PP .PP
.B native_colors \fBnative_colors\fR
.RS .RS 4
Select between native terminal colors and toxic color theme. Select between native terminal colors and toxic color theme\&. true or false
.br
Values: 'true' for terminal colours, 'false' for toxic colours
.RE .RE
.PP .PP
.B autolog \fBautolog\fR
.RS .RS 4
Enable or disable autologging. Enable or disable autologging\&. true or false
.br
Values: 'true' to enable, 'false' to disable
.RE .RE
.PP .PP
.B time_format \fBtime_format\fR
.RS .RS 4
Select between 24 and 12 hour time. Select between 24 and 12 hour time\&. Specify 24 or 12
.br
Values: 24, 12
.RE .RE
.PP .PP
.B show_typing_other \fBshow_typing_other\fR
.RS .RS 4
Show you when others are typing in a 1-on-1 chat Show when others are typing in a 1\-on\-1 chat\&. true or false
.br
Values: 'true' to enable, 'false' to disable
.RE .RE
.PP .PP
.B show_typing_self \fBshow_typing_self\fR
.RS .RS 4
Show others when you're typing in a 1-on-1 chat Show others when you\(cqre typing in a 1\-on\-1 chat\&. true or false
.br
Values: 'true' to enable, 'false' to disable
.RE .RE
.PP .PP
.B history_size \fBhistory_size\fR
.RS .RS 4
Maximum lines for chat window history. Maximum lines for chat window history\&. Integer value\&. (for example: 700)
.br
Values: <INTEGER> (for example: 700)
.RE .RE
.RE .RE
.PP .PP
.B audio \fBaudio\fR
.RS .RS 4
Configurations related to audio devices. Configuration related to audio devices\&.
.PP .PP
Keys: \fBinput_device\fR
.br .RS 4
.B input_device Audio input device\&. Integer value\&. Number corresponds to
.RS /lsdev in
Audio input device.
.br
Values: <INTEGER> (number correspond to "/lsdev in")
.RE .RE
.PP .PP
.B output_device \fBoutput_device\fR
.RS .RS 4
Audio output device. Audio output device\&. Integer value\&. Number corresponds to
.br /lsdev out
Values: <INTEGER> (number correspond to "/lsdev out")
.RE .RE
.PP .PP
.B VAD_treshold \fBVAD_treshold\fR
.RS .RS 4
Voice Activity Detection treshold. Voice Activity Detection treshold\&. Float value\&. Recommended values are around 40\&.0
.br
Values: <FLOAT> (recommended values are around 40.0)
.RE .RE
.RE .RE
.PP .PP
.B tox \fBtox\fR
.RS .RS 4
Configurations related to file transfer. Configuration related to file transfer\&.
.PP .PP
Keys: \fBdownload_path\fR
.br .RS 4
.B download_path Default path for downloads\&. String value\&. Absolute path where to store downloaded files
.RS
Default path for downloads.
.br
Values: <STRING> (absolute path where to store downloaded files)
.RE .RE
.RE .RE
.PP .PP
.B sounds \fBsounds\fR
.RS .RS 4
Configurations related to notification sounds. Configuration related to notification sounds\&. Special value "silent" can be used to disable a specific notification\&.
.br
(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 .PP
Keys: \fBerror\fR
.br .RS 4
.B error Sound to play when an error occurs\&.
.RS
Sound to play when an error occurs.
.br
Values: <STRING> (sound file absolute path)
.RE .RE
.PP .PP
.B self_log_in \fBself_log_in\fR
.RS .RS 4
Sound to play when you log in. Sound to play when you log in\&.
.br
Values: <STRING> (sound file absolute path)
.RE .RE
.PP .PP
.B self_log_out \fBself_log_out\fR
.RS .RS 4
Sound to play when you log out. Sound to play when you log out\&.
.br
Values: <STRING> (sound file absolute path)
.RE .RE
.PP .PP
.B user_log_in \fBuser_log_in\fR
.RS .RS 4
Sound to play when a contact become online. Sound to play when a contact become online\&.
.br
Values: <STRING> (sound file absolute path)
.RE .RE
.PP .PP
.B user_log_out \fBuser_log_out\fR
.RS .RS 4
Sound to play when a contact become offline. Sound to play when a contact become offline\&.
.br
Values: <STRING> (sound file absolute path)
.RE .RE
.PP .PP
.B call_incoming \fBcall_incoming\fR
.RS .RS 4
Sound to play when you receive an incoming call. Sound to play when you receive an incoming call\&.
.br
Values: <STRING> (sound file absolute path)
.RE .RE
.PP .PP
.B call_outgoing \fBcall_outgoing\fR
.RS .RS 4
Sound to play when you start a call. Sound to play when you start a call\&.
.br
Values: <STRING> (sound file absolute path)
.RE .RE
.PP .PP
.B generic_message \fBgeneric_message\fR
.RS .RS 4
Sound to play when an event occurs. Sound to play when an event occurs\&.
.br
Values: <STRING> (sound file absolute path)
.RE .RE
.PP .PP
.B transfer_pending \fBtransfer_pending\fR
.RS .RS 4
Sound to play when you receive a file transfer request. Sound to play when you receive a file transfer request\&.
.br
Values: <STRING> (sound file absolute path)
.RE .RE
.PP .PP
.B transfer_completed \fBtransfer_completed\fR
.RS .RS 4
Sound to play when a file transfer is completed. Sound to play when a file transfer is completed\&.
.br
Values: <STRING> (sound file absolute path)
.RE .RE
.RE .RE
.PP .PP
.B keys \fBkeys\fR
.RS .RS 4
Configurations related to user interface interaction. Configuration related to user interface interaction\&. Currently supported: Ctrl modified keys, Tab, PAGEUP and PAGEDOWN\&.
.br
(Currently supported: Ctrl modified keys, Tab, PAGEUP and PAGEDOWN (case insensitive)) Each value is a string which corresponds to a key combination\&.
.PP .PP
Keys: \fBnext_tab\fR
.br .RS 4
.B next_tab Key combination to switch next tab\&.
.RS
Key combination to switch next tab.
.br
Values: <STRING> (key combination)
.RE .RE
.PP .PP
.B prev_tab \fBprev_tab\fR
.RS .RS 4
Key combination to switch previous tab. Key combination to switch previous tab\&.
.br
Values: <STRING> (key combination)
.RE .RE
.PP .PP
.B scroll_line_up \fBscroll_line_up\fR
.RS .RS 4
Key combination to scroll one line up. Key combination to scroll one line up\&.
.br
Values: <STRING> (key combination)
.RE .RE
.PP .PP
.B scroll_line_down \fBscroll_line_down\fR
.RS .RS 4
Key combination to scroll one line down. Key combination to scroll one line down\&.
.br
Values: <STRING> (key combination)
.RE .RE
.PP .PP
.B half_page_up \fBhalf_page_up\fR
.RS .RS 4
Key combination to scroll half page up. Key combination to scroll half page up\&.
.br
Values: <STRING> (key combination)
.RE .RE
.PP .PP
.B half_page_down \fBhalf_page_down\fR
.RS .RS 4
Key combination to scroll half page down. Key combination to scroll half page down\&.
.br
Values: <STRING> (key combination)
.RE .RE
.PP .PP
.B page_bottom \fBpage_bottom\fR
.RS .RS 4
Key combination to scroll to page bottom. Key combination to scroll to page bottom\&.
.br
Values: <STRING> (key combination)
.RE .RE
.PP .PP
.B peer_list_up \fBpeer_list_up\fR
.RS .RS 4
Key combination to scroll contacts list up. Key combination to scroll contacts list up\&.
.br
Values: <STRING> (key combination)
.RE .RE
.PP .PP
.B peer_list_down \fBpeer_list_down\fR
.RS .RS 4
Key combination to scroll contacts list down. Key combination to scroll contacts list down\&.
.br
Values: <STRING> (key combination)
.RE .RE
.RE .RE
.SH FILES .SH "FILES"
.IP ~/.config/tox/toxic.conf .PP
Main configuration file. ~/\&.config/tox/toxic\&.conf
.IP __DATADIR__/toxic.conf.example .RS 4
Configuration example. Main configuration file\&.
.SH AUTHORS .RE
JFreegman <JFreegman@gmail.com> .PP
.SH SEE ALSO __DATADIR__/toxic\&.conf\&.example
.BR toxic (1) .RS 4
.SH LINKS Configuration example\&.
Project page on github: https://github.com/Tox/toxic .RE
.br .SH "SEE ALSO"
IRC channel on Freenode: chat.freenode.net#tox .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
View 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>