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

Merge pull request #2819 from LittleVulpix:Format-discrepancy

Browse Source 
User manual wording+changes
This commit is contained in:
Zetok Zalbavar 2016-01-18 16:07:33 +00:00
commit 452c9e12ba
No known key found for this signature in database
GPG Key ID: C953D3880212068A
1 changed files with 27 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
doc/user_manual_en.md
View File

@ -8,7 +8,7 @@
* [Keyboard Shortcuts](#keyboard-shortcuts) * [Keyboard Shortcuts](#keyboard-shortcuts)
## User Profile ## User Profile
Your User Profile contains everything you share with other people on Tox. You can open it by clicking the picture on the top right corner. It contains the following settings: Your User Profile contains everything you share with other people on Tox. You can open it by clicking the picture in the top left corner. It contains the following settings:
### Public Information ### Public Information
* _Name:_ This is your nickname which everyone who has your Tox ID can see. * _Name:_ This is your nickname which everyone who has your Tox ID can see.
@ -23,16 +23,16 @@ The "Save image" button saves the QR-Code into a image file, while the "Copy ima
### Profile ### Profile
qTox allows you to use multiple Tox IDs with different profiles, which each can have different nicknames, status messages and friends. qTox allows you to use multiple Tox IDs with different profiles, each of which can have different nicknames, status messages and friends.
+ _Current profile:_ Shows the filename which stores your information. + _Current profile:_ Shows the filename which stores your information.
+ _Current profile locatation:_ Shows the path to the profile file. + _Current profile locatation:_ Shows the path to the profile file.
+ _Rename_ This button allows you to rename your profile. Your nickname and profile name don't have to be the same. + _Rename:_ Allows you to rename your profile. Your nickname and profile name don't have to be the same.
+ _Delete_ This button deletes your profile and the corresponding chat history. + _Delete:_ Deletes your profile and the corresponding chat history.
+ _Export_ Allows you to export your profile in a format compatible with other Tox clients. You can also manually backup your *.tox files. + _Export:_ Allows you to export your profile in a format compatible with other Tox clients. You can also manually back up your *.tox files.
+ _Logout_ Close your current profile and show the login window. + _Logout:_ Close your current profile and show the login window.
+ _Remove password_ If you set a password for your profile, you can remove it with this button. + _Remove password:_ Removes the existing password for your profile. If the profile already has no password, you will be notified.
+ _Change password_ If you set a password for your profile, you can change the password with this button. You can also set a password for unencrypted profiles here. + _Change password:_ Allows you to either change an existing password, or create a new password if your profile does not have one.
## Settings ## Settings
### General ### General
@ -44,27 +44,26 @@ qTox allows you to use multiple Tox IDs with different profiles, which each can
* _Show system tray icon:_ If set, qTox will show its icon in your system tray. * _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. * _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. * _Minimize to tray:_ The minimize button on the top right, will minimize qTox to its tray icon. There won't be a taskbar item.
* _Auto away after (0 to disable):_ After the specified amount of time, qTox will set your status to "Away". A setting of 0 will never change your status.
* _Auto away after (0 to disable):_ After the specified amount of time, qTox will set your Status to "Away". A setting of 0 will never change your status. * _Default directory to save files:_ Allows you to specify the default destination for incoming filetransfers.
* _Default directory to save files:_ You can set the directory where qTox puts files you recieved here.
* _Autoaccept files:_ If set, qTox will automatically accept file transfers and put them in the directory specified above. * _Autoaccept files:_ If set, qTox will automatically accept file transfers and put them in the directory specified above.
#### Chat #### Chat
* _Play sound:_ If checked, qTox will play a sound when you get a new message. * _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. If you use the multiple windows mode, see [Multi Window Mode](#multi-window-mode) for details. * _Open window:_ If checked, the qTox window will be opened when you receive a new message. 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. * _Focus window:_ If checked, the qTox window will additionally be focused when you receive a new message.
* _Show contacts' status changes:_ If set, qTox will show contact status changes in your chat window. * _Show contacts' status changes:_ If set, qTox will show contact status changes in your chat window.
* _Group chats always notify:_ If set, qTox will notify you on every new message in a groupchat. * _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. * _Place groupchats at top of friend list:_ If checked, your groupchats will be at the top of the contacts list instead of being sorted with your other contacts.
* _Faux offline messaging:_ If enabled, qTox will attempt to send messages when a currently offline contact comes online again. * _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. * _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 [Multi Window Mode](#multi-window-mode). * _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. * _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 #### Theme
* _Use emoticons:_ If enabled, qTox will replace simleys ( e.g. :-) ) with Unicode emoticons. * _Use emoticons:_ If enabled, qTox will replace smileys ( e.g. :-) ) with corresponding graphical emoticons.
* _Smiley Pack:_ You can choose from different sets of shiped emoticon styles. * _Smiley Pack:_ Allows you to choose from different sets of shipped emoticon styles.
* _Emoticon size:_ You can change the size of the emoticons here. * _Emoticon size:_ Allows you to change the size of the emoticons.
* _Style:_ Changes the appearance of qTox. * _Style:_ Changes the appearance of qTox.
* _Theme color:_ Changes the colors qTox uses. * _Theme color:_ Changes the colors qTox uses.
* _Timestamp format:_ Change the format in which qTox displays message timestamps. * _Timestamp format:_ Change the format in which qTox displays message timestamps.
@ -72,9 +71,9 @@ qTox allows you to use multiple Tox IDs with different profiles, which each can
#### Connection Settings #### 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 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, which is supposed to lower the amount of traffic, but is also slower and puts more load on other network participants. * _Enable UDP (recommended):_ If enabled, qTox will use TCP and UDP protocols. If disabled, qTox will only use TCP, which lowers the amount of open connections and slightly decreases required bandwidth, 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. Most users will want both options enabled, but if qTox negatively impacts your router or connection, you can try to disable them.
* _Proxy type:_ If you want to use a proxy, set the type here. "None" disables the proxy. * _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. * _Address:_ If you use a proxy, enter the address here.
@ -88,41 +87,41 @@ Most users will want the two settings enabled, but if qTox crashes your router,
#### NoSpam #### NoSpam
NoSpam is a feature of Tox to prevent someone spamming you with friend requests. If you get spammed, enter or generate a new NoSpam value, this will alter your Tox ID. You don't need to tell your existing contacts your new Tox ID, but you have to tell new contacts your new Tox ID. Your Tox ID can be found in your [User Profile](#user-profile) NoSpam is a feature of Tox that prevents a malicious user from spamming you with friend requests. If you get spammed, enter or generate a new NoSpam value. This will alter your Tox ID. You don't need to tell your existing contacts your new Tox ID, but you have to tell new contacts your new Tox ID. Your Tox ID can be found in your [User Profile](#user-profile)
### Audio/Video ### Audio/Video
#### Audio Settings #### Audio Settings
* _Playback device:_ Select the device qTox should use for all audio output (notifications, calls,..). * _Playback device:_ Select the device qTox should use for all audio output (notifications, calls,..).
* _Playback:_ Here you can adjust the playback volume to your needs. * _Playback:_ Here you can adjust the playback volume to your needs.
* _Capture device:_ Select the device qTox should use for audio input in calls. * _Capture device:_ Select the device qTox should use for audio input in calls.
* _Microphone:_ Set the input volume of your microphone with this slider. When you are talking normaly, the display should be in the green range. * _Microphone:_ Set the input volume of your microphone with this slider. When you are talking normally, the displayed volume incidator should be in the green range.
* _Filter audio_ If enabled, qTox will try to remove noise and echo from your audio input. * _Filter audio_ If enabled, qTox will try to remove noise and echo from your audio input.
#### Video Settings #### Video Settings
* _Video device:_ Select the video device qTox should use for video calls. "None" will show a dummy picture to your chat partner. "Desktop" will stream the content of your screen. * _Video device:_ Select the video device qTox should use for video calls. "None" will show a dummy picture to your chat partner. "Desktop" will stream the content of your screen.
* _Resolution:_ You can select from the available resolutions and framerates here. Higher resolutions provide more quality, but if the bandwidth of your connection is low, the video may get choppy. * _Resolution:_ You can select from the available resolutions and framerates here. Higher resolutions provide more quality, but if the bandwidth of your connection is low, the video may get choppy.
If you set up everything correctly, you should see the preview of your video device in the box. If you set up everything correctly, you should see the preview of your video device in the box below.
* _Rescan devices_ Use this button to search for newly attached devices, e.g. you plugged in a webcam. * _Rescan devices_ Use this button to search for newly attached devices, e.g. you plugged in a webcam.
### Advanced ### Advanced
* _Make Tox portable:_ If enabled, qTox will load/save user data from the working directory, instead of ``` ~/.config/tox/ ```. * _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. * _Reset to default settings_ Use this button to revert any changes you made to the qTox settings.
### About ### About
* _Version_ The version of qTox and the libraries it depends on. Please append this information to every bug report. * _Version_ Shows the version of qTox and the libraries it depends on. Please append this information to every bug report.
* _License_ The license under which the code of qTox is available. * _License_ Shows the license under which the code of qTox is available.
* _Authors_ The people who developed this shiny piece of software. * _Authors_ Lists the people who developed this shiny piece of software.
* _Known Issues_ Links to our list of known issues and improvements. * _Known Issues_ Links to our list of known issues and improvements.
## Groupchats ## Groupchats
Groupchats are a way to talk with multiple friends at the same time, like when you are standing together in a group. To create a groupchat click the groupchat icon and set a name. Now you can invite people by right clicking on the contact and selecting "Invite to group". Currently, if the last person leaves the chat, it is closed and you have to create a new one. Sending files and videochats are currently unsupported in groupchats. Groupchats are a way to talk with multiple friends at the same time, like when you are standing together in a group. To create a groupchat click the groupchat icon in the bottom left corner and set a name. Now you can invite your contacts by right-clicking on the contact and selecting "Invite to group". Currently, if the last person leaves the chat, it is closed and you have to create a new one. Videochats and filetransfers are currently unsupported in groupchats.
## Multi Window Mode ## Multi Window Mode
If you activated this mode in the [settings](#settings), qTox will seperate its main window into a contact list and chat windows, which allows you to have multiple conversations on your screen on the same time. Additionally you can manually group chats into a window by dragging and dropping them onto eachother. In this mode, qTox will seperate its main window into a single contact list and one or multiple chat windows, which allows you to have multiple conversations on your screen on the same time. Additionally you can manually group chats into a window by dragging and dropping them onto eachother. This mode can be activated and configured in [settings](#settings).
## Keyboard Shortcuts ## Keyboard Shortcuts