StarMirror/qTox
1
0
Fork 0
mirror of https://github.com/qTox/qTox.git synced 2024-03-22 14:00:36 +08:00
Code Issues Projects Releases Wiki Activity

update user manual with @zetok s suggestions

Browse Source
This commit is contained in:
sudden6 2016-01-11 23:46:37 +01:00
parent 861697d86e
commit 71bdb23246
1 changed files with 15 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
doc/user_manual_en.md
View File

@ -11,8 +11,8 @@
#### General Settings
* _Language:_ Changes which language the qTox interface uses.
* _Autostart:_ If set, qTox will start when you login on your computer.
* _Light icon:_ If set, qTox will use a different icon, which is easier to read on black backgrounds.
* _Autostart:_ If set, qTox will start when you login on your computer. qTox will also autmatically open the profile which was active when you ticked the checkbox, but this only works if your profile isn't encrypted (has no password set).
* _Light icon:_ If set, qTox will use a different icon, which is easier to see on black backgrounds.
* _Show system tray icon:_ If set, qTox will show its icon in your system tray.
* _Start in tray:_ On start, qTox will only show its tray icon and no window.
* _Minimize to tray:_ The minimize button on the top right, will minimize qTox to its tray icon. There won't be a taskbar item.
@ -23,28 +23,30 @@
#### Chat
* _Play sound:_ If checked, qTox will play a sound when you get a new message.
* _Open window:_ If checked, the qTox window will be opened. <!-- TODO: Will a NEW window be opened? What happens in Multi Window mode? -->
* _Open window:_ If checked, the qTox window will be opened. If you use the multiple windows mode, see [Multi Window Mode](#multi-window-mode) for details.
* _Focus window:_ If checked, the qTox window will additionally be focused.
* _Show contacts' status changes:_ ???<!-- TODO: what does this even do?-->
* _Group chats always notify:_ ???<!-- TODO: what does this even do?-->
* _Place groupchats at top of friend list:_ If checked, your groupchats will be at the top of the contacts list. <!-- TODO: else what?-->
* _Faux offline messaging:_ If enabled, qTox will attempt to send messages when a currently offline contact comes online again.<!-- TODO:Is this even correct?-->
* _Show contacts' status changes:_ If set, qTox will show contact status changes in your chat history.
* _Group chats always notify:_ If set, qTox will notify you on every new message in a groupchat.
* _Place groupchats at top of friend list:_ If checked, your groupchats will be at the top of the contacts list, else they will be sorted with your other contacts.
* _Faux offline messaging:_ If enabled, qTox will attempt to send messages when a currently offline contact comes online again.
* _Compact contact list:_ If set, qTox will use a contact list layout which takes up less screen space.
* _Multiple windows mode:_ If enabled, the qTox user interface will be split into multiple independent windows. For details see TODO.<!-- TODO:write detailed explainaiton of multi window mode-->
* _Open each chat in an individual window:_ If checked, a new window will be opened for every chat you open.
* _Multiple windows mode:_ If enabled, the qTox user interface will be split into multiple independent windows. For details see [Multi Window Mode](#multi-window-mode).
* _Open each chat in an individual window:_ If checked, a new window will be opened for every chat you open. If you manually grouped the chat into another window, the window which hosts the chat will be focused.
#### Theme
* _Use emoticons:_ If enabled, qTox will replace simleys ( e.g. :-) ) with Unicode emoticons.
* _Smiley Pack:_ You can choose from different sets of shiped emoticon styles. You can also install your own, see ??? for details<!-- TODO: add instructions for adding own smiley packs-->
* _Emoticon size:_ You can change the size of the emoticons here.
* _Style:_ Changes the appearance of qTox.<!-- TODO: possible to add own styles? -->
* _Theme color:_ Changes the colors qTox uses.<!-- TODO: possible to add own color schemes? -->
* _Style:_ Changes the appearance of qTox.
* _Theme color:_ Changes the colors qTox uses.
* _Timestamp format:_ Change the format in which qTox displays message timestamps.
* _Date format:_ Same as above for the date.
#### Connection Settings
* _Enable IPv6 (recommended):_ If enabled, qTox will use IPv4 and IPv6 protocols, whichever is available. If disabled, qTox will only use IPv4.
* _Enable UDP (recommended):_ If enabled, qTox will use TCP and UDP protocols. If disabled, qTox will only use TCP.<!-- TODO: correct? what advantages/disadvantages does this have? -->
* _Enable UDP (recommended):_ If enabled, qTox will use TCP and UDP protocols. If disabled, qTox will only use TCP, which is supposed to lower the amount of traffic, but is also slower and puts more load on other network participants.
Most users will want the two settings enabled, but if qTox crashes your router, you can try to disable them.
* _Proxy type:_ If you want to use a proxy, set the type here. "None" disables the proxy.
* _Address:_ If you use a proxy, enter the address here.
* _Port:_ If you use a proxy, enter the port here.
@ -76,7 +78,7 @@ NoSpam is a feature of Tox to prevent someone spamming you with friend requests.
* _Rescan devices_ Use this button to search for newly attached devices, e.g. you plugged in a webcam.
### Advanced
* _Make Tox portable:_ ???<!-- TODO: What does this do exactly?-->
* _Make Tox portable:_ If enabled, qTox will load/save user data from the working directory, instead of ``` ~/.config/tox/ ```.
* _Reset to default settings_ Use this button to delete any changes you made to the qTox settings.
### About
@ -97,11 +99,8 @@ If you activated this mode in the [settings](#Settings), qTox will seperata its
The following shortcuts are currently supported:
<!-- TODO: does CRTL+P really work?-->
| Shortcut | Action |
|----------|--------|
| ``CTRL`` + ``P`` | Push to talk |
| ``Arrow up`` | Paste last message |
| ``CTRL`` + ``SHIFT`` + ``L`` | Clear chat |
| ``CTRL`` + ``q`` | Quit qTox |