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
87ee8e966c
qTox/doc/user_manual_en.md
sudden6 87ee8e966c write it in markdown
2016-01-09 19:21:05 +01:00

6.7 KiB
Raw Blame History

qTox User Manual

Index

Settings

General

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.

  • 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.

  • 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: You can set the directory where qTox puts files you recieved here.

  • Autoaccept files: If set, qTox will automatically accept filetransfers and put them in the directory specified above.

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.
    • Focus window: If checked, the qTox window will additionally be focused.
  • Show contacts' status changes: ???
  • Group chats always notify: ???
  • Place groupchats at top of friend list: If checked, your groupchats will be at the top of the contacts list.
  • 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.
    • Open each chat in an individual window: If checked, a new window will be opened for every chat you open.

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
  • Emoticon size: You can change the size of the emoticons here.
  • 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.
  • 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.

Privacy

  • 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.

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 ???

Audio/Video

Audio Settings

  • 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.
  • 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 the display should be in the green range.
  • Filter audio If enabled, qTox will try to remove noise and echo from your audio input.

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.

  • 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.

  • Rescan devices Use this button to search for newly attached devices, e.g. you plugged in a webcam.

Advanced

  • Make Tox portable: ???
  • Reset to default settings Use this button to delete any changes you made to the qTox settings.

About

  • Version The version of qTox and the libraries it depends on. Please append this information to every bugreport.
  • License The license under which the code of qTox is available.
  • Authors The people who developed this shiny piece of software.
  • Known Issues Links to our list of known issues and improvements.

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.

Keyboard Shortcuts

The following shortcuts are currently supported:

Shortcut Action
CTRL + P Push to talk
Arrow up Paste last message
CTRL + SHIFT + L Clear chat
CTRL + q Quit qTox
CTRL + Page Down Switch to the next contact
CTRL + Page Up Switch to the previous contact
CTRL + TAB Switch to the next contact
CTRL + SHIFT + TAB Switch to the previous contact