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

Check spelling, standardise punctuation and terms, small markdown fixes

Browse Source
This commit is contained in:
kehugter 2016-01-19 02:59:14 +01:00
parent 1757dfb2fc
commit df792b0748
1 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
doc/user_manual_en.md
View File

@ -17,19 +17,19 @@ Your User Profile contains everything you share with other people on Tox. You ca
### Tox ID ### Tox ID
The long code in hexadecimal format is your Tox ID, share this with everyone you want to talk to. Click it to copy it to your clipboard. The long code in hexadecimal format is your Tox ID, share this with everyone you want to talk to. Click it to copy it to your clipboard.
Your Tox ID is also shown as QR-Code to easily share it with friends over a smartphone. Your Tox ID is also shown as QR code to easily share it with friends over a smartphone.
The "Save image" button saves the QR-Code into a image file, while the "Copy image" button copies into your clipboard. The "Save image" button saves the QR code into a image file, while the "Copy image" button copies into your clipboard.
### Profile ### Profile
qTox allows you to use multiple Tox IDs with different profiles, each of which 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 location:_ Shows the path to the profile file.
+ _Rename:_ 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:_ 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 back up 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:_ Removes the existing password for your profile. If the profile already has no password, you will be notified. + _Remove password:_ Removes the existing password for your profile. If the profile already has no password, you will be notified.
+ _Change password:_ Allows you to either change an existing password, or create a new password if your profile does not have one. + _Change password:_ Allows you to either change an existing password, or create a new password if your profile does not have one.
@ -39,7 +39,7 @@ qTox allows you to use multiple Tox IDs with different profiles, each of which c
#### General Settings #### General Settings
* _Language:_ Changes which language the qTox interface uses. * _Language:_ Changes which language the qTox interface uses.
* _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). * _Autostart:_ If set, qTox will start when you login on your computer. qTox will also automatically 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. * _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. * _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.
@ -61,7 +61,7 @@ qTox allows you to use multiple Tox IDs with different profiles, each of which c
* _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 smileys ( e.g. :-) ) with corresponding graphical emoticons. * _Use emoticons:_ If enabled, qTox will replace smileys ( e.g. `:-)` ) with corresponding graphical emoticons.
* _Smiley Pack:_ Allows you to choose from different sets of shipped emoticon styles. * _Smiley Pack:_ Allows you to choose from different sets of shipped emoticon styles.
* _Emoticon size:_ Allows you to change the size of the emoticons. * _Emoticon size:_ Allows you to change the size of the emoticons.
* _Style:_ Changes the appearance of qTox. * _Style:_ Changes the appearance of qTox.
@ -78,24 +78,24 @@ Most users will want both options enabled, but if qTox negatively impacts your r
* _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.
* _Port:_ If you use a proxy, enter the port here. * _Port:_ If you use a proxy, enter the port here.
* _Reconnect:_ Reconnect to the tox network, e.g. if you changed the proxy settings. * _Reconnect:_ Reconnect to the Tox network, e.g. if you changed the proxy settings.
### Privacy ### Privacy
* _Send typing notifications:_ If enabled, notify your chat partner when you are currently typing. * _Send typing notifications:_ If enabled, notify your chat partner when you are currently typing.
* _Keep chat history:_ If enabled, qTox will save your sent and recieved messages. Encrypt your profile, if you want to encrypt the chat history. * _Keep chat history:_ If enabled, qTox will save your sent and received messages. Encrypt your profile, if you want to encrypt the chat history.
#### NoSpam #### NoSpam
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) 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, etc).
* _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 normally, the displayed volume incidator 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 indicator 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.
@ -103,17 +103,17 @@ NoSpam is a feature of Tox that prevents a malicious user from spamming you with
If you set up everything correctly, you should see the preview of your video device in the box below. 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 revert 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_ Shows 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_ Shows the license under which the code of qTox is available. * _License:_ Shows the license under which the code of qTox is available.
* _Authors_ Lists 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