Tha_14/toxic
1
0
Fork 0
mirror of https://github.com/Tha14/toxic.git synced 2024-12-23 10:53:26 +01:00
Code Issues Projects Releases Wiki Activity

Merge pull request #218 from louipc/louipc

Browse Source 
toxic.conf.5: Remove default config from man page
This commit is contained in:
JFreegman 2014-08-14 12:05:33 -04:00
commit 3f6fd734d3
1 changed files with 1 additions and 119 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

120
doc/toxic.conf.5
View File

@ -1,4 +1,4 @@
.TH TOXIC.CONF 5 "June 2014" "Toxic v__VERSION__" "User Manual"
.TH TOXIC.CONF 5 "August 2014" "Toxic v__VERSION__" "User Manual"
.SH NAME
toxic.conf \- Configuration file for toxic(1)
.SH DESCRIPTION
@ -280,124 +280,6 @@ Key combination to scroll contacts list down.
Values: <STRING> (key combination)
.RE
.RE
.SH EXAMPLES
Default settings from __DATADIR__/toxic.conf.exmaple:
.PP
// SAMPLE TOXIC CONFIGURATION
.br
// USES LIBCONFIG-ACCEPTED SYNTAX
.br
ui = {
.RS
// true to enable timestamps, false to disable
.br
timestamps=true;
.br
// true to enable terminal alerts on messages, false to disable
.br
alerts=true;
.br
// true to use native terminal colours, false to use toxic default colour theme
.br
native_colors=false;
.br
// true to enable autologging, false to disable
.br
autolog=false;
.br
// 24 or 12 hour time
.br
time_format=24;
.br
// true to show you when others are typing a message in 1-on-1 chats
.br
show_typing_other=true;
.br
// true to show others when you're typing a message in 1-on-1 chats
.br
show_typing_self=true;
.br
// maximum lines for chat window history
.br
history_size=700;
.RE
};
.PP
audio = {
.RS
// preferred audio input device; numbers correspond to /lsdev in
.br
input_device=2;
.br
// preferred audio output device; numbers correspond to /lsdev out
.br
output_device=0;
.br
// default VAD treshold; float (recommended values are around 40)
.br
VAD_treshold=40.0;
.RE
};
.PP
tox = {
.RS
// where to store received files
.br
//download_path="/home/USERNAME/Downloads/";
.RE
};
.PP
// To disable a sound set the path to "silent"
.br
sounds = {
.RS
error="__DATADIR__/sounds/Error.wav";
.br
self_log_in="__DATADIR__/sounds/LogIn.wav";
.br
self_log_out="__DATADIR__/sounds/LogOut.wav";
.br
user_log_in="__DATADIR__/sounds/ContactLogsIn.wav";
.br
user_log_out="__DATADIR__/sounds/ContactLogsOut.wav";
.br
call_incoming="__DATADIR__/sounds/IncomingCall.wav";
.br
call_outgoing="__DATADIR__/sounds/OutgoingCall.wav";
.br
generic_message="__DATADIR__/sounds/NewMessage.wav";
.br
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
Main configuration file.