1
0
mirror of https://github.com/Tha14/toxic.git synced 2024-11-17 23:23:03 +01:00

Update toxic.conf manpage

This commit is contained in:
Ansa89 2014-07-29 12:07:24 +02:00
parent 15e91cfa99
commit 1c58c339bb
2 changed files with 113 additions and 14 deletions

View File

@ -27,7 +27,7 @@ Sections:
.PP .PP
.B ui .B ui
.RS .RS
Configurations related to user interface. Configurations related to user interface elements.
.PP .PP
Keys: Keys:
.br .br
@ -119,6 +119,8 @@ Values: <STRING> (absolute path where to store downloaded files)
.B sounds .B sounds
.RS .RS
Configurations related to notification sounds. Configurations related to notification sounds.
.br
(Special value "silent" can be used to disable a specific notification)
.PP .PP
Keys: Keys:
.br .br
@ -192,6 +194,78 @@ Sound to play when a file transfer is completed.
Values: <STRING> (sound file absolute path) Values: <STRING> (sound file absolute path)
.RE .RE
.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 .SH EXAMPLES
Default settings from __DATADIR__/toxic.conf.exmaple: Default settings from __DATADIR__/toxic.conf.exmaple:
.PP .PP
@ -200,11 +274,10 @@ Default settings from __DATADIR__/toxic.conf.exmaple:
// USES LIBCONFIG-ACCEPTED SYNTAX // USES LIBCONFIG-ACCEPTED SYNTAX
.br .br
ui = { ui = {
.br .RS
// true to enable timestamps, false to disable // true to enable timestamps, false to disable
.br .br
timestamps:true; timestamps:true;
.br
.br .br
// true to enable terminal alerts on messages, false to disable // true to enable terminal alerts on messages, false to disable
.br .br
@ -225,11 +298,11 @@ ui = {
// maximum lines for chat window history // maximum lines for chat window history
.br .br
history_size=700; history_size=700;
.br .RE
}; };
.br .PP
audio = { audio = {
.br .RS
// preferred audio input device; numbers correspond to /lsdev in // preferred audio input device; numbers correspond to /lsdev in
.br .br
input_device=2; input_device=2;
@ -241,21 +314,21 @@ audio = {
// default VAD treshold; float (recommended values are around 40) // default VAD treshold; float (recommended values are around 40)
.br .br
VAD_treshold=40.0; VAD_treshold=40.0;
.br .RE
}; };
.br .PP
tox = { tox = {
.br .RS
// where to store received files // where to store received files
.br .br
//download_path="/home/USERNAME/Downloads/"; //download_path="/home/USERNAME/Downloads/";
.br .RE
}; };
.br .PP
// To disable a sound set the path to "silent" // To disable a sound set the path to "silent"
.br .br
sounds = { sounds = {
.br .RS
error="__DATADIR__/sounds/Error.wav"; error="__DATADIR__/sounds/Error.wav";
.br .br
self_log_in="__DATADIR__/sounds/LogIn.wav"; self_log_in="__DATADIR__/sounds/LogIn.wav";
@ -275,7 +348,33 @@ sounds = {
transfer_pending="__DATADIR__/sounds/TransferPending.wav"; transfer_pending="__DATADIR__/sounds/TransferPending.wav";
.br .br
transfer_completed="__DATADIR__/sounds/TransferComplete.wav"; transfer_completed="__DATADIR__/sounds/TransferComplete.wav";
.RE
};
.PP
// Currently supported: Ctrl modified keys, Tab, PAGEUP and PAGEDOWN (case insensitive)
.br .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 .SH FILES
.IP ~/.config/tox/toxic.conf .IP ~/.config/tox/toxic.conf