pimhwang
/
qTox
mirror of https://github.com/qTox/qTox.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

docs(user manual): add a section for contacts' r-click menu & update 

Update consists mostly of just moving things around and adding missing
section titles.

Added remark about `Play sound while Busy` in General tab.
Changed highlight style of ~settings from italics to bold.
Removed obsolete remark about filter audio in A/V tab.

Settings rethink PR: #3457
reviewable/pr3718/r3
Zetok Zalbavar 9 years ago
parent
3ca76ca511
commit
69a5b1f916
No known key found for this signature in database
GPG Key ID: C953D3880212068A
1 changed files with 142 additions and 90 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 232
      doc/user_manual_en.md

232
doc/user_manual_en.md
Unescape View File

@ -31,7 +31,29 @@ is directly aimed at you, and not sent to everyone, that is:
* status change (`Online`/`Away`/`Busy`/`Offline`) * status change (`Online`/`Away`/`Busy`/`Offline`)
* status message change * status message change
### Contact details ### Contact menu
Can be accessed by right-clicking on a contact or [circle](#circles). When
right-clicking on a contact a menu appears that has the following options:
* __Open chat in a new window:__ opens a new window for the chosen contact.
* __Invite to group:__ offers an option to create a new groupchat and
automatically invite the friend to it or to an already existing groupchat.
* __Move to circle:__ offers an option to move friend to a new
[circle](#circles), or to an existing one.
* __Set alias:__ set alias that will be displayed instead of contact's name.
* __Auto accept files from this friend:__ option to automatically save files
from the selected contact in a chosen directory.
* __Remove friend:__ option to remove the contact. Confirmation is needed to
remove the friend.
* __Show details:__ show [details](#contact-details) of a friend.
#### Circles
Circles allow you to group contacts together and give this circle a name.
Contacts can be in one or in no circle.
#### Contact details
Contact details can be accessed by right-clicking on a contact and picking the Contact details can be accessed by right-clicking on a contact and picking the
`Show details` option. `Show details` option.
@ -53,9 +75,9 @@ following settings:
### Public Information ### Public Information
* _Name:_ This is your nickname which everyone who is on your contact list can * __Name:__ This is your nickname which everyone who is on your contact list can
see. see.
* _Status:_ You can post a status message here, which again everyone on your * __Status:__ You can post a status message here, which again everyone on your
contact list can see. contact list can see.
#### Avatar #### Avatar
@ -77,102 +99,105 @@ image" button copies into your clipboard.
qTox allows you to use multiple Tox IDs with different profiles, each of which qTox allows you to use multiple Tox IDs with different profiles, each of which
can have different nicknames, status messages and friends. 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 location:_ 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 + __Rename:__ Allows you to rename your profile. Your nickname and profile name
don't have to be the same. 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 + __Export:__ Allows you to export your profile in a format compatible with
Tox clients. You can also manually back up your \*.tox files. 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 + __Remove password:__ Removes the existing password for your profile. If the
profile already has no password, you will be notified. profile already has no password, you will be notified.
+ _Change password:_ Allows you to either change an existing password, or create + __Change password:__ Allows you to either change an existing password, or
a new password if your profile does not have one. create a new password if your profile does not have one.
## Settings ## Settings
### General ### General
#### 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
* _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 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 checkbox, but this only works if your profile isn't encrypted (has no
set). password set).
* _Light icon:_ If set, qTox will use a different icon, which is easier to see * __Light icon:__ If set, qTox will use a different icon, which is easier to
on black backgrounds. 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
* _Start in tray:_ On start, qTox will only show its tray icon and no tray.
* __Start in tray:__ On start, qTox will only show its tray icon and no
window. window.
* _Minimize to tray:_ The minimize button on the top right, will minimize * __Minimize to tray:__ The minimize button on the top right, will minimize
qTox to its tray icon. There won't be a taskbar item.
* __Close to tray__: The close button on the top right will minimize
qTox to its tray icon. There won't be a taskbar item. 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 * __Play sound:__ If checked, qTox will play a sound when you get a new
message.
* __Play sound while Busy__: If checked, qTox will play a sound even
when your status is set to `Busy`.
* __Show contacts' status changes:__ If set, qTox will show contact status
changes in your chat window.
* __Faux offline messaging:__ If enabled, qTox will attempt to send messages
when a currently offline contact comes online again.
* __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. 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 * __Default directory to save files:__ Allows you to specify the default
destination for incoming file transfers. destination for incoming file transfers.
* _Autoaccept files:_ If set, qTox will automatically accept file transfers and * __Autoaccept files:__ If set, qTox will automatically accept file transfers
put them in the directory specified above. and put them in the directory specified above.
### User Interface
#### Chat #### 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 when you receive a * __Base font:__ You can set a non-default font and its size for the chat. The
new font setting will be used for new messages and all messages after qTox
has been restarted.
* __Text Style format:__ see [Message styling](#message-styling) section.
#### New message
* __Open window:__ If checked, the qTox window will be opened when you receive a
new message. If you use the multiple windows mode, see new message. If you use the multiple windows mode, see
[Multi Window Mode](#multi-window-mode) for details. [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. when you receive a new message.
* _Show contacts' status changes:_ If set, qTox will show contact status changes
in your chat window. #### Contact list
* _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
* _Place groupchats at top of friend list:_ If checked, your groupchats will be message in a groupchat.
at the top of the contacts list instead of being sorted with your other * __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. contacts.
* _Faux offline messaging:_ If enabled, qTox will attempt to send messages when * __Compact contact list:__ If set, qTox will use a contact list layout which
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. takes up less screen space.
* _Multiple windows mode:_ If enabled, the qTox user interface will be split * __Multiple windows mode:__ If enabled, the qTox user interface will be split
into multiple independent windows. For details see into multiple independent windows. For details see [Multi Window
[Multi Window Mode](#multi-window-mode). Mode](#multi-window-mode).
* _Open each chat in an individual window:_ If checked, a new window will be * __Open each chat in an individual window:__ If checked, a new window will
opened for every chat you open. If you manually grouped the chat into 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. another window, the window which hosts the chat will be focused.
#### Theme #### Emoticons
* _Use emoticons:_ If enabled, qTox will replace smileys ( e.g. `:-)` ) with
* __Use emoticons:__ If enabled, qTox will replace smileys ( e.g. `:-)` ) with
corresponding graphical emoticons. corresponding graphical emoticons.
* _Smiley Pack:_ Allows you to choose from different sets of shipped emoticon * __Smiley Pack:__ Allows you to choose from different sets of shipped emoticon
styles. 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.
* _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 #### Theme
* _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 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 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 * __Style:__ Changes the appearance of qTox.
the proxy. * __Theme color:__ Changes the colors qTox uses.
* _Address:_ If you use a proxy, enter the address here. * __Timestamp format:__ Changes the format in which qTox displays message
* _Port:_ If you use a proxy, enter the port here. timestamps.
* _Reconnect:_ Reconnect to the Tox network, e.g. if you changed the proxy * __Date format:__ Same as above for the date.
settings.
### Privacy ### Privacy
* _Send typing notifications:_ If enabled, notify your chat partner when you are * __Send typing notifications:__ If enabled, notify your chat partner when you
currently typing. are currently typing.
* _Keep chat history:_ If enabled, qTox will save your sent and received * __Keep chat history:__ If enabled, qTox will save your sent and received
messages. Encrypt your profile, if you want to encrypt the chat history. messages. Encrypt your profile, if you want to encrypt the chat history.
#### NoSpam #### NoSpam
@ -185,42 +210,69 @@ 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
* __Playback device:__ Select the device qTox should use for all audio output
(notifications, calls, etc). (notifications, calls, etc).
* _Playback:_ Here you can adjust the playback volume to your needs. * __Volume:__ 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
* _Microphone:_ Set the input volume of your microphone with this slider. When calls.
you are talking normally, the displayed volume indicator should be in the * __Gain:__ Set the input volume of your microphone with this slider. When you
green range. are talking normally, the displayed volume indicator should be in the green
* _Filter audio:_ If enabled, qTox will try to remove noise and echo from your range.
audio input.
#### Video Settings #### Video Settings
* _Video device:_ Select the video device qTox should use for video calls.
* __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 "None" will show a dummy picture to your chat partner. "Desktop" will stream
the content of your screen. the content of your screen.
* _Resolution:_ You can select from the available resolutions and frame rates * __Resolution:__ You can select from the available resolutions and frame rates
here. Higher resolutions provide more quality, but if the bandwidth of your here. Higher resolutions provide more quality, but if the bandwidth of your
connection is low, the video may get choppy. connection is low, the video may get choppy.
If you set up everything correctly, you should see the preview of your video If you set up everything correctly, you should see the preview of your video
device in the box below. device in the box below.
* _Rescan devices:_ Use this button to search for newly attached devices, e.g. * __Rescan devices:__ Use this button to search for newly attached devices, e.g.
you plugged in a webcam. you plugged in a webcam.
### Advanced ### Advanced
* _Make Tox portable:_ If enabled, qTox will load/save user data from the #### Portable
* __Make Tox portable:__ If enabled, qTox will load/save user data from the
working directory, instead of ` ~/.config/tox/ `. working directory, instead of ` ~/.config/tox/ `.
* _Reset to default settings:_ Use this button to revert any changes you made to
the qTox 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 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 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.
* __Address:__ If you use a proxy, enter the address 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.
---
* __Reset to default settings:__ Use this button to revert any changes you made
to the qTox settings. *Note that current implentation [is
buggy](https://github.com/qTox/qTox/issues/3664) and aside from settings also
friend [aliases] will be removed!*
### About ### About
* _Version:_ Shows the version of qTox and the libraries it depends on. Please * __Version:__ Shows the version of qTox and the libraries it depends on. Please
append this information to every bug report. 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

Write Preview
Loading…
Cancel
Save