You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

89 lines
2.3 KiB

.\" Automatically generated by Pandoc 2.19.2
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "tut" "1" "2023-01-23" "tut 2.0.0" ""
.hy
.SH NAME
.PP
tut - a Mastodon TUI
.SH SYNOPSIS
.PP
\f[B]tut\f[R] [command] [options\&...]
.SH DESCRIPTION
.PP
A TUI for Mastodon with vim inspired keys.
The program has most of the features you can find in the web client.
To see keys and commands you can use inside of tut check tut(7).
.SH OPTIONS
.TP
\f[B]-h\f[R], \f[B]--help\f[R]
Show help message
.TP
\f[B]-v\f[R], \f[B]--version\f[R]
Show the version number
.TP
\f[B]-n\f[R], \f[B]--new-user\f[R]
Add one more user to tut
.TP
\f[B]-c\f[R], \f[B]--config\f[R] <path>
Load config.toml from \f[I]<path>\f[R]
.TP
\f[B]-d\f[R], \f[B]--config-dir\f[R] <path>
Load all config from \f[I]<path>\f[R]
.TP
\f[B]-u\f[R], \f[B]--user\f[R] <name>
Login directly to user named \f[I]<name>\f[R].
If you want to login to multiple accounts seperate them with a space and
use quotation marks.
E.g.
-u \[lq]acc_one acc_two\[rq].
If two users are named the same, use full name like
\f[I]tut\[at]fosstodon.org\f[R]
.SH COMMANDS
.TP
\f[B]no command\f[R]
Runs the TUI
.TP
\f[B]example-config\f[R]
Generates the default configuration file in the current directory and
names it ./config.example.toml
.SH CONFIGURATION
.PP
Tut is configurable, so you can change things like the colors, the
default timeline, what image viewer to use and some more.
Check out tut(5) or the configuration file to see all the options.
.PP
You find it in \f[I]$XDG_CONFIG_HOME/tut/config.toml\f[R] on Linux which
usually equals to \f[I]\[ti]/.config/tut/config.toml\f[R].
If you don\[cq]t run Linux it will use the path of the Go funcdtion
os.UserConfigDir().
But if you move the tut folder to \f[I]XDG_CONFIG_HOME/tut/\f[R] and
have set the environment variable \f[I]XDG_CONFIG_HOME\f[R] it will look
there instead of the standard place.
.PP
You can generate an example configuration file with \f[I]tut
example-config\f[R].
It will be updated with potential new features.
.SH SEE ALSO
.IP
.nf
\f[C]
tut(5) - configuration format
tut(7) - commands and keys inside of tut
\f[R]
.fi
.SH AUTHORS
Rasmus Lindroth.