mirror of
https://github.com/Tha14/toxic.git
synced 2024-11-13 02:33:03 +01:00
Remove old man pages.
Signed-off-by: Loui Chang <louipc.ist@gmail.com>
This commit is contained in:
Loui Chang
parent
97d4c97c52
commit
15cc87bffd
74
doc/toxic.1
74
doc/toxic.1
@ -1,74 +0,0 @@
|
||||
.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"
|
||||
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"
|
||||
Use specified
|
||||
.IP "\-d, \-\-default_locale
|
||||
Use default locale
|
||||
.I config\-file
|
||||
instead of
|
||||
.IR ~/.config/tox/toxic.conf
|
||||
.IP "\-f, \-\-file data\-file"
|
||||
Use specified
|
||||
.I data\-file
|
||||
instead of
|
||||
.IR ~/.config/tox/data
|
||||
.IP "\-h, \-\-help"
|
||||
Show help message
|
||||
.IP "\-n, \-\-nodes nodes\-file"
|
||||
Use specified
|
||||
.I nodes\-file
|
||||
for DHT bootstrap nodes, instead of
|
||||
.IR __DATADIR__/DHTnodes
|
||||
.IP "\-o, \-\-noconnect"
|
||||
Do not connect to the DHT network
|
||||
.IP "\-p, \-\-proxy"
|
||||
Use proxy: Requires [IP] [port]
|
||||
.IP "\-r, \-\-dnslist"
|
||||
Use specified DNSservers file
|
||||
.IP "\-t, \-\-force\-tcp"
|
||||
Force TCP connection (use this with proxies)
|
||||
.IP "\-x, \-\-nodata"
|
||||
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
|
||||
295
doc/toxic.conf.5
295
doc/toxic.conf.5
@ -1,295 +0,0 @@
|
||||
.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 = {
|
||||
.PP
|
||||
.IB <KEY1> = <VALUE1> ;
|
||||
.br
|
||||
.IB <KEY2> = <VALUE2> ;
|
||||
.br
|
||||
...
|
||||
.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
|
||||
.RE
|
||||
.PP
|
||||
.B alerts
|
||||
.RS
|
||||
Enable or disable terminal alerts on events.
|
||||
.br
|
||||
Values: 'true' to enable, 'false' to disable
|
||||
.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
|
||||
.RE
|
||||
.PP
|
||||
.B autolog
|
||||
.RS
|
||||
Enable or disable autologging.
|
||||
.br
|
||||
Values: 'true' to enable, 'false' to disable
|
||||
.RE
|
||||
.PP
|
||||
.B time_format
|
||||
.RS
|
||||
Select between 24 and 12 hour time.
|
||||
.br
|
||||
Values: 24, 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
|
||||
.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
|
||||
.RE
|
||||
.PP
|
||||
.B history_size
|
||||
.RS
|
||||
Maximum lines for chat window history.
|
||||
.br
|
||||
Values: <INTEGER> (for example: 700)
|
||||
.RE
|
||||
.RE
|
||||
.PP
|
||||
.B audio
|
||||
.RS
|
||||
Configurations related to audio devices.
|
||||
.PP
|
||||
Keys:
|
||||
.br
|
||||
.B input_device
|
||||
.RS
|
||||
Audio input device.
|
||||
.br
|
||||
Values: <INTEGER> (number correspond to "/lsdev in")
|
||||
.RE
|
||||
.PP
|
||||
.B output_device
|
||||
.RS
|
||||
Audio output device.
|
||||
.br
|
||||
Values: <INTEGER> (number correspond to "/lsdev out")
|
||||
.RE
|
||||
.PP
|
||||
.B VAD_treshold
|
||||
.RS
|
||||
Voice Activity Detection treshold.
|
||||
.br
|
||||
Values: <FLOAT> (recommended values are around 40.0)
|
||||
.RE
|
||||
.RE
|
||||
.PP
|
||||
.B tox
|
||||
.RS
|
||||
Configurations 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)
|
||||
.RE
|
||||
.RE
|
||||
.PP
|
||||
.B sounds
|
||||
.RS
|
||||
Configurations related to notification sounds.
|
||||
.br
|
||||
(Special value "silent" can be used to disable a specific notification)
|
||||
.PP
|
||||
Keys:
|
||||
.br
|
||||
.B error
|
||||
.RS
|
||||
Sound to play when an error occurs.
|
||||
.br
|
||||
Values: <STRING> (sound file absolute path)
|
||||
.RE
|
||||
.PP
|
||||
.B self_log_in
|
||||
.RS
|
||||
Sound to play when you log in.
|
||||
.br
|
||||
Values: <STRING> (sound file absolute path)
|
||||
.RE
|
||||
.PP
|
||||
.B self_log_out
|
||||
.RS
|
||||
Sound to play when you log out.
|
||||
.br
|
||||
Values: <STRING> (sound file absolute path)
|
||||
.RE
|
||||
.PP
|
||||
.B user_log_in
|
||||
.RS
|
||||
Sound to play when a contact become online.
|
||||
.br
|
||||
Values: <STRING> (sound file absolute path)
|
||||
.RE
|
||||
.PP
|
||||
.B user_log_out
|
||||
.RS
|
||||
Sound to play when a contact become offline.
|
||||
.br
|
||||
Values: <STRING> (sound file absolute path)
|
||||
.RE
|
||||
.PP
|
||||
.B call_incoming
|
||||
.RS
|
||||
Sound to play when you receive an incoming call.
|
||||
.br
|
||||
Values: <STRING> (sound file absolute path)
|
||||
.RE
|
||||
.PP
|
||||
.B call_outgoing
|
||||
.RS
|
||||
Sound to play when you start a call.
|
||||
.br
|
||||
Values: <STRING> (sound file absolute path)
|
||||
.RE
|
||||
.PP
|
||||
.B generic_message
|
||||
.RS
|
||||
Sound to play when an event occurs.
|
||||
.br
|
||||
Values: <STRING> (sound file absolute path)
|
||||
.RE
|
||||
.PP
|
||||
.B transfer_pending
|
||||
.RS
|
||||
Sound to play when you receive a file transfer request.
|
||||
.br
|
||||
Values: <STRING> (sound file absolute path)
|
||||
.RE
|
||||
.PP
|
||||
.B transfer_completed
|
||||
.RS
|
||||
Sound to play when a file transfer is completed.
|
||||
.br
|
||||
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 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
|
||||
Loading…
Reference in New Issue
Block a user