.TH UTOX "1" "January 2024" "µTox 0.18.1"
.SH NAME
µTox \- Lightweight Tox client

.SH SYNOPSIS
usage: utox [--portable] [--theme <THEME>] [--set=<start-on-boot|show-window|hide-window>] [--allow-root]
   or: utox --version
   or: utox --help

.SH DESCRIPTION
µTox is a free software lighweight X.org graphical Tox client.

µTox can be used for:
 * 1-to-1 text IM
 * group IM
 * audio calls
 * video calls
 * group audio calls
 * desktop sharing
 * file transfers

.SH OPTIONS
.IP "\fB\-t\fP \fI<THEME>\fP or \fB\-\-theme\fP \fI<THEME>\fP"
Choose a color scheme. Possible options are \fIdefault\fP, \fIdark\fP,
\fIlight\fP, \fIhighcontrast\fP, \fIzenburn\fP, \fIsolarized-light\fP, or
\fIsolarized-dark\fP.

.IP "\fB\-p\fP or \fB\-\-portable\fP"
Run in portable mode. All data will be saved to the tox folder in the current working directory, see FILES for more details.

.IP "\fB\-\-allow\-root\fP"
Allow running µTox as root. Default is to refuse.

.IP "\fB\-s\fP \fI<OPTION>\fP or \fB\-\-set \fP\fI<OPTION>\fP"
Set an option. The available options are "start-on-boot", "show-window" and "hide-window".

.IP "\fB\-u\fP \fI<OPTION>\fP or \fB\-\-unset \fP\fI<OPTION>\fP"
Unset an option. The available option is "start-on-boot".

.IP "\fB\-v\fP or \fB\-\-verbose\fP"
Increase debug output level. Multiple -v options increase the verbosity. The
maximum is 6.

.IP "\fB--silent\fP"
Set the verbosity level to 0, disable all debugging output.

.IP "\fB--debug\fP \fI<FILE>\fP"
Write all debug output to the specified file.

.IP "\fB\-h\fP or \fB\-\-help\fP"
Print a short description of available options.

.IP "\fB\-\-version\fP"
Print the version and exit.

.SH KEYBINDINGS
.IP "\fBCtrl+F\fP"
Toggle friend list online status filter.

.IP "\fBCtrl+f\fP"
Focus on friend list search input field.

.IP "\fBCtrl+[num], Alt+[num]\fP"
Switch to chat [num].

.IP "\fBCtrl+Pg{Up,Down}\fP"
Move up or down in the friend list.

.IP "\fBCtrl+Pg{Home,End}\fP"
Move to first or last friend in the friend list.

.IP "\fBEsc\fP"
Unfocus message input field. When unfocused, pressing any key will focus on it again.

.IP "\fBPg{Up,Down}\fP"
Scroll chat log up or down.  This keybinding will only work when the message input field is unfocused.

.IP "\fBHome, End\fP"
Scroll to top or bottom of chat log.  This keybinding will only work when the message input field is unfocused.

.SH CHAT COMMANDS
These commands can be used in the chat window.
.IP "\fB/alias\fP <alias>"
Sets selected friend's alias to <alias>. It will be displayed instead of that
friend's name.
.IP "\fB/invite\fP <name>"
Invites <name> to the current groupchat.
.IP "\fB/sendfile\fP <path>"
Sends a file located in <path> to the current friend.
.IP "\fB/topic\fP <topic>"
Changes current groupchat's name/topic to <topic>. This command can also be
used to edit the current topic by typing /topic and pressing the tab key.
.IP "\fB/me\fP <action>"
Sends an message/action in the format <name> <action>, for example: Tox User
says hi

.SH FILES
All files listed below are located in \fB$HOME/.config/tox\fP. If µTox is
running in portable mode, their location will be \fB./tox\fP.
.IP \fBtox_save.tox\fP
\fBtox_save.tox\fP is the file that contains the public/private key pair, name,
status and contacts. It's compatible with other Tox clients.
.IP \fButox_save\fP
\fButox_save\fP is µTox' binary config file, it contains settings such as
language, proxy options, DPI or logging.
.IP \fBavatars\fP
The \fBavatars\fP directory contains other contacts' avatars. Files are named
after contacts' public keys (the first 64 characters of the ID).
.IP \fBTox_Auto_Accept\fP
Default directory for auto-accepted files in portable mode.
.IP "\fB[public key].txt\fP"
Those are friends' chat logs. µTox supports only 1v1 chat logging for now.
.IP "\fB[public key].fmetadata\fP"
Friend metadata file, currently used for storing aliases.
.IP "\fB[public key][file number].ftoutfo\fP"
Current outgoing file transfers' state. Used for resuming transfers across
client restarts.

.SH CONTRIBUTORS
Please see the list page:
.I https://github.com/uTox/uTox/graphs/contributors

.SH BUGS
Please report bugs on
.I https://github.com/uTox/uTox/issues

The source code for
.B µTox
can be found at
.I https://github.com/uTox/uTox