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

Merge pull request #207 from Ansa89/manpage-update

Browse Source 
Update toxic.conf manpage
This commit is contained in:
JFreegman 2014-07-29 11:51:58 -04:00
commit cbe47b3660
2 changed files with 113 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

125
doc/toxic.conf.5
View File

@ -27,7 +27,7 @@ Sections:
.PP
.B ui
.RS
Configurations related to user interface.
Configurations related to user interface elements.
.PP
Keys:
.br
@ -119,6 +119,8 @@ Values: <STRING> (absolute path where to store downloaded files)
.B sounds
.RS
Configurations related to notification sounds.
.br
(Special value "silent" can be used to disable a specific notification)
.PP
Keys:
.br
@ -192,6 +194,78 @@ Sound to play when a file transfer is completed.
Values: <STRING> (sound file absolute path)
.RE
.RE
.PP
.B keys
.RS
Configurations related to user interface interaction.
.br
(Currently supported: Ctrl modified keys, Tab, PAGEUP and PAGEDOWN (case insensitive))
.PP
Keys:
.br
.B next_tab
.RS
Key combination to switch next tab.
.br
Values: <STRING> (key combination)
.RE
.PP
.B prev_tab
.RS
Key combination to switch previous tab.
.br
Values: <STRING> (key combination)
.RE
.PP
.B scroll_line_up
.RS
Key combination to scroll one line up.
.br
Values: <STRING> (key combination)
.RE
.PP
.B scroll_line_down
.RS
Key combination to scroll one line down.
.br
Values: <STRING> (key combination)
.RE
.PP
.B half_page_up
.RS
Key combination to scroll half page up.
.br
Values: <STRING> (key combination)
.RE
.PP
.B half_page_down
.RS
Key combination to scroll half page down.
.br
Values: <STRING> (key combination)
.RE
.PP
.B page_bottom
.RS
Key combination to scroll to page bottom.
.br
Values: <STRING> (key combination)
.RE
.PP
.B peer_list_up
.RS
Key combination to scroll contacts list up.
.br
Values: <STRING> (key combination)
.RE
.PP
.B peer_list_down
.RS
Key combination to scroll contacts list down.
.br
Values: <STRING> (key combination)
.RE
.RE
.SH EXAMPLES
Default settings from __DATADIR__/toxic.conf.exmaple:
.PP
@ -200,11 +274,10 @@ Default settings from __DATADIR__/toxic.conf.exmaple:
// USES LIBCONFIG-ACCEPTED SYNTAX
.br
ui = {
.br
.RS
// true to enable timestamps, false to disable
.br
timestamps:true;
.br
.br
// true to enable terminal alerts on messages, false to disable
.br
@ -225,11 +298,11 @@ ui = {
// maximum lines for chat window history
.br
history_size=700;
.br
.RE
};
.br
.PP
audio = {
.br
.RS
// preferred audio input device; numbers correspond to /lsdev in
.br
input_device=2;
@ -241,21 +314,21 @@ audio = {
// default VAD treshold; float (recommended values are around 40)
.br
VAD_treshold=40.0;
.br
.RE
};
.br
.PP
tox = {
.br
.RS
// where to store received files
.br
// download_path="/home/USERNAME/Downloads/";
.br
//download_path="/home/USERNAME/Downloads/";
.RE
};
.br
.PP
// To disable a sound set the path to "silent"
.br
sounds = {
.br
.RS
error="__DATADIR__/sounds/Error.wav";
.br
self_log_in="__DATADIR__/sounds/LogIn.wav";
@ -275,7 +348,33 @@ sounds = {
transfer_pending="__DATADIR__/sounds/TransferPending.wav";
.br
transfer_completed="__DATADIR__/sounds/TransferComplete.wav";
.RE
};
.PP
// Currently supported: Ctrl modified keys, Tab, PAGEUP and PAGEDOWN (case insensitive)
.br
// Note: All printable keys register as input
.br
keys = {
.RS
next_tab="Ctrl+P";
.br
prev_tab="Ctrl+O";
.br
scroll_line_up="PAGEUP";
.br
scroll_line_down="PAGEDOWN";
.br
half_page_up="Ctrl+F";
.br
half_page_down="Ctrl+V";
.br
page_bottom="Ctrl+H";
.br
peer_list_up="Ctrl+[";
.br
peer_list_down="Ctrl+]";
.RE
};
.SH FILES
.IP ~/.config/tox/toxic.conf

2
misc/toxic.conf.example
View File

@ -34,7 +34,7 @@ audio = {
tox = {
// where to store received files
// download_path="/home/USERNAME/Downloads/";
//download_path="/home/USERNAME/Downloads/";
};
// To disable a sound set the path to "silent"