NAME¶

tut - configuration for tut(1)

DESCRIPTION¶

The configuration format for tut.

You find it in $XDG_CONFIG_HOME/tut/config.toml on Linux which usually equals to ~/.config/tut/config.toml. If you don’t run Linux it will use the path of the Go funcdtion os.UserConfigDir(). But if you move the tut folder to XDG_CONFIG_HOME/tut/ and have set the environment variable XDG_CONFIG_HOME it will look there instead of the standard place.

CONFIGURATION¶

The configuration file is divided in seven sections named general, media, open-custom, open-pattern, desktop-notification, style and input.

Under each section there is the name of the configuration option. The last line under each options shows the default value.

GENERAL¶

This section is [general] in your configuration file

editor¶

What editor to use. TUT_USE_INTERNAL will use the editor that comes with tut. If you want you can set this to $EDITOR to use your environment variable or vim if you want to specify the program directly.

editor=“TUT_USE_INTERNAL”

confirmation¶

You need to press yes in a confirmation dialog before favoriting, boosting, etc.

confirmation=true

mouse-support¶

Enable mouse support in tut.

mouse-support=false

date-format¶

The date format to be used. See https://pkg.go.dev/time#pkg-constants

date-format=“2006-01-02 15:04”

date-tody-format¶

Format for dates the same day. See date-format for more info.

date-tody-format=“15:04”

date-relative¶

This displays relative dates instead for statuses that are one day or older the output is 1y2m1d (1 year 2 months and 1 day)

The value is an integer

-1 = don't use relative dates

0 = always use relative dates, except for dates < 1 day

1 - ∞ = number of days to use relative dates

Value: 28 will display a relative date for toots that are between 1-28 days old. Otherwise it will use the short or long format.

date-relative=-1

max-width¶

The max with of text before it wraps when displaying a toot.

max-width=0

list-placement¶

The placement of your panes.

valid: left, right, top, bottom

list-placement=“left”

list-split¶

How should panes be split?

valid: row, column

list-split=“row”

list-proportion¶

The proportion of panes vs. content. 1 on this and 3 on content below results in content taking up 3 times more space.

list-proportion=1

content-proportion¶

See previous.

content-proportion=2

notifications-to-hide¶

Hide notifications of this type in your notification timelines.

valid: mention, status, boost, follow, follow_request, favorite, poll, edit

notifications-to-hide=[]

quote-reply¶

Always include a quote of the message you're replying to.

quote-reply=false

show-icons¶

If you want to show icons in timelines.

show-icons=true

short-hints¶

If you only want to you the letter of keys instead of the full hint.

short-hints=false

show-filter-phrase¶

If you want to display the filter that filtered a toot.

show-filter-phrase=true

show-help¶

Display a message in the commandbar on how to access the help text.

show-help=true

stick-to-top¶

Always jump to the newest post. May ruin your reading experience.

stick-to-top=false

show-boosted-user¶

Display the username of the person being boosted instead of the person that boosted.

show-boosted-user=false

commands-in-new-pane¶

Open a new pane when you run a command like :timeline home.

commands-in-new-pane=true

dynamic-timeline-name¶

Set a default name for the timeline if the name is empty. So if you run :tag linux the title of the pane will be set to #linux

dynamic-timeline-name=true

terminal-title¶

0 = No terminal title

1 = Show title in terminal and top bar

2 = Only show terminal title, and no top bar in tut

3 = No terminal title and no top bar in tut.

valid: 0, 1, 2, 3

terminal-title=0

redraw-ui¶

If you don't want the whole UI to update, and only update the text content you can disable this. This will lead to some artifacts being left on the screen when emojis are present.

redraw-ui=true

leader-key¶

The leader is used as a shortcut to run commands as you can do in Vim. By default this is disabled and you enable it by setting a key here. It can only consist of one char, so set it to something like a comma.

leader-key=““

leader-timeout¶

Number of milliseconds before the leader command resets. So if you tap the leader-key by mistake or are to slow it empties all the input after X milliseconds.

leader-timeout=1000

GENERAL.TIMELINES¶

This section is [[general.timelines]] in your configuration file. You can have multiple of them.

Timelines adds panes of feeds. You can customize the number of feeds, what they should show and the key to activate them.

Example:

[[general.timelines]]

name="home"

type="home"

hide-boosts=false

hide-replies=false

[[general.timelines]]

name="Notifications"

type="notifications"

keys=["n", "N"]

closed=true

on-creation-closed="new-pane"

on-focus="focus-self"

name¶

The name to display above the timeline

name=““

type¶

The type of the timeline

valid: home, direct, local, federated, bookmarks, saved, favorited, notifications, lists, mentions, tag

type=““

data¶

Used for the tag type, so here you set the tag. If you have multiple you separate them with a space.

data=““

keys¶

A list of keys to give this timeline focus. See under the input section to learn more about keys.

keys=[]

special-keys¶

A list of special-keys to give this timeline focus. See under the input section to learn more about special-keys.

special-keys=[]

shortcut¶

A shortcut to give this timeline focus with your leader-key + this shortcut.

shortcut=““

hide-boosts¶

Hide boosts in this timeline.

hide-boosts=“false”

hide-replies¶

Hide replies in this timeline.

hide-replies=“false”

closed¶

Don't open this timeline when you start tut. Use your keys or shortcut to open it.

closed=“false”

on-creation-closed¶

Don't open this timeline when you start tut. Use your keys or shortcut to open it.

valid: new-pane, current-pane

on-creation-closed=“new-pane”

on-focus¶

Don't open this timeline when you start tut. Use your keys or shortcut to open it.

valid: focus-pane, focus-self

on-focus=“focus-pane”

GENERAL.LEADER-ACTIONS¶

This section is [[general.leader-actions]] in your configuration file. You can have multiple of them.

You set actions leader-key with one or more leader-actions.

The shortcuts are up to you, but keep them quite short and make sure they don't collide. If you have one shortcut that is "f" and an other one that is "fav", the one with "f" will always run and "fav" will never run.

Some special actions that requires data to be set:

pane is special as it's a shortcut for switching between the panes you've set under general and they are zero indexed. pane 0 = your first timeline, pane 1 = your second and so on.

list-placement as it takes the argument top, right, bottom or left

list-split as it takes the argument column or row

proportions takes the arguments [int] [int], where the first integer is the list and the other content, e.g. proportions 1 3. See list-proportion above for more information.

Example:

[[general.leader-actions]]

type="close-pane"

shortcut="q"

[[general.leader-actions]]

type="list-split"

data="row"

shortcut="r"

[[general.leader-actions]]

type="list-split"

data="column"

shortcut="c"

type¶

The action you want to run.

valid: blocking, boosts, clear-notifications, close-pane, compose, edit, favorited, favorites, followers, following, history, list-placement, list-split, lists, move-pane-left, move-pane-right, move-pane-up, move-pane-down, move-pane-home, move-pane-end, muting, newer, pane, preferences, profile, proportions, refetch, stick-to-top, tags

type=““

data¶

Data to pass to the action.

data=““

shortcut¶

A shortcut to run this action with your leader-key + this shortcut.

shortcut=““

MEDIA¶

This section is [media] in your configuration file

delete-temp-files¶

Media files will be removed directly after they've been opened. Some programs doesn't like this, so if your media doesn't open, try set this to false. Tut will remove all files once you close the program.

delete-temp-files=true

MEDIA.IMAGE¶

This section is [media.image] in your configuration file

program¶

The program to open images. TUT_OS_DEFAULT equals xdg-open on Linux, open on MacOS and start on Windows.

program=“TUT_OS_DEFAULT”

args¶

Arguments to pass to the program.

args=““

terminal¶

If the program runs in the terminal set this to true.

terminal=false

single¶

If the program should be called multiple times when there is multiple files. If set to false all files will be passed as an argument, but not all programs support this.

single=true

reverse¶

If the files should be passed in reverse order. This will make some programs display the files in the correct order.

reverse=false

MEDIA.VIDEO¶

This section is [media.video] in your configuration file

program¶

The program to open videos. TUT_OS_DEFAULT equals xdg-open on Linux, open on MacOS and start on Windows.

program=“TUT_OS_DEFAULT”

args¶

Arguments to pass to the program.

args=““

terminal¶

If the program runs in the terminal set this to true.

terminal=false

single¶

If the program should be called multiple times when there is multiple files. If set to false all files will be passed as an argument, but not all programs support this.

single=true

reverse¶

If the files should be passed in reverse order. This will make some programs display the files in the correct order.

reverse=false

MEDIA.AUDIO¶

This section is [media.audio] in your configuration file

program¶

The program to open audio. TUT_OS_DEFAULT equals xdg-open on Linux, open on MacOS and start on Windows.

program=“TUT_OS_DEFAULT”

args¶

Arguments to pass to the program.

args=““

terminal¶

If the program runs in the terminal set this to true.

terminal=false

single¶

If the program should be called multiple times when there is multiple files. If set to false all files will be passed as an argument, but not all programs support this.

single=true

reverse¶

If the files should be passed in reverse order. This will make some programs display the files in the correct order.

reverse=false

MEDIA.LINK¶

This section is [media.link] in your configuration file

program¶

The program to open links. TUT_OS_DEFAULT equals xdg-open on Linux, open on MacOS and start on Windows.

program=“TUT_OS_DEFAULT”

args¶

Arguments to pass to the program.

args=““

terminal¶

If the program runs in the terminal set this to true.

terminal=false

DESKTOP-NOTIFICATION¶

This section is [desktop-notification] in your configuration file

followers¶

Enable notifications when someone follows you.

followers=false

favorite¶

Enable notifications when one of your toots gets favorited.

favorite=false

mention¶

Enable notifications when someone mentions you.

mention=false

update¶

Enable notifications when a post you have interacted with gets edited.

update=false

boost¶

Enable notifications when one of your toots gets boosted.

boost=false

poll¶

Enable notifications when a poll ends.

poll=false

posts¶

Enable notifications for new posts.

posts=false

OPEN-CUSTOM¶

This section is [open-custom] in your configuration file

Example:

[[open-custom.programs]]

program = 'chromium'

terminal = false

hint = "[C]hrome"

keys = ["c", "C"]

[[open-custom.programs]]

program = 'imv'

terminal = false

hint = "[I]mv"

keys = ["i", "I"]"

OPEN-CUSTOM.PROGRAMS¶

This section is [[open-custom.programs]] in your configuration file. You can have multiple of them.

program¶

The program to open the file with.

program=““

args¶

Arguments to pass to the program.

args=““

terminal¶

If the program runs in the terminal set this to true.

terminal=false

hint¶

What should the key hint in tut be for this program. See under the input section to learn more about hint.

hint=““

keys¶

A list of keys to to open files with this program. See under the input section to learn more about keys.

keys=[]

special-keys¶

A list of special-keys to open files with this program. See under the input section to learn more about special-keys.

special-keys=[]

OPEN-PATTERN¶

This section is [open-pattern] in your configuration file

OPEN-PATTERN.PROGRAMS¶

This section is [[open-pattern.programs]] in your configuration file. You can have multiple of them.

matching¶

Here you can set your own glob patterns for opening matching URLs in the program you want them to open up in. You could for example open Youtube videos in your video player instead of your default browser. To see the syntax for glob pattern you can follow this URL https://github.com/gobwas/glob#syntax.

matching=““

program¶

The program to open the file with.

program=““

args¶

Arguments to pass to the program.

args=““

terminal¶

If the program runs in the terminal set this to true.

terminal=false

STYLE¶

This section is [style] in your configuration file

All styles can be represented in their HEX value like #ffffff or with their name, so in this case white. The only special value is "default" which equals to transparent, so it will be the same color as your terminal.

You can also use xrdb colors like this xrdb:color1 The program will use colors prefixed with an * first then look for URxvt or XTerm if it can't find any color prefixed with an asterisk. If you don't want tut to guess the prefix you can set the prefix yourself. If the xrdb color can't be found a preset color will be used. You'll have to set theme="none" for this to work.

theme¶

The theme to use. You can use some themes that comes bundled with tut. Check out the themes available on the URL below. If a theme is named nord.toml you just write theme="nord".

https://github.com/RasmusLindroth/tut/tree/master/config/themes

You can also create a theme file in your config directory e.g. ~/.config/tut/themes/foo.toml and then set theme=foo.

If you want to use your own theme but don't want to create a new file, set theme="none" and then you can create your own theme below.

theme=“default”

xrdb-prefix¶

The xrdb prefix used for colors in .Xresources.

xrdb-prefix=“guess”

background¶

The background color used on most elements.

background=““

text¶

The text color used on most of the text.

text=““

subtle¶

The color to display subtle elements or subtle text. Like lines and help text.

subtle=““

warning-text¶

The color for errors or warnings

warning-text=““

text-special-one¶

This color is used to display username.

text-special-one=““

text-special-two¶

This color is used to display username and key hints.

text-special-two=““

top-bar-background¶

The color of the bar at the top

top-bar-background=““

top-bar-text¶

The color of the text in the bar at the top.

top-bar-text=““

status-bar-background¶

The color of the bar at the bottom

status-bar-background=““

status-bar-text¶

The color of the text in the bar at the bottom.

status-bar-text=““

status-bar-view-background¶

The color of the bar at the bottom in view mode.

status-bar-view-background=““

status-bar-view-text¶

The color of the text in the bar at the bottom in view mode.

status-bar-view-text=““

command-text¶

The color of the text in the command bar at the bottom.

command-text=““

list-selected-background¶

Background of selected list items.

list-selected-background=““

list-selected-text¶

The text color of selected list items.

list-selected-text=““

list-selected-inactive-background¶

The background color of selected list items that are out of focus.

list-selected-inactive-background=““

list-selected-inactive-text¶

The text color of selected list items that are out of focus.

list-selected-inactive-text=““

controls-text¶

The main color of the text for key hints

controls-text=““

controls-highlight¶

The highlight color of for key hints

controls-highlight=““

autocomplete-background¶

The background color in drop-downs and autocompletions

autocomplete-background=““

autocomplete-text¶

The text color in drop-downs at autocompletions

autocomplete-text=““

autocomplete-selected-background¶

The background color for selected value in drop-downs and autocompletions

autocomplete-selected-background=““

autocomplete-selected-text¶

The text color for selected value in drop-downs and autocompletions

autocomplete-selected-text=““

button-color-one¶

The background color on selected button and the text color of unselected buttons

button-color-one=““

button-color-two¶

The text color on selected button and the background color of unselected buttons

button-color-two=““

timeline-name-background¶

The background on named timelines.

timeline-name-background=““

timeline-name-text¶

The text color on named timelines

timeline-name-text=““

INPUT¶

This section is [input] in your configuration file

In this section you set the keys to be used in tut.

The hint option lets you set which part of the hint that will be highlighted in tut. E.g. [F]avorite results in a highlighted F and the rest of the text is displayed normally.

Some of the options can be in two states, like favorites, so there you can set the hint-alt option to something like Un[F]avorite.

Examples:

"[D]elete" = Delete with a highlighted D

"Un[F]ollow" = UnFollow with a highlighted F

"[Enter]" = Enter where everything is highlighted

"Yan[K]" = YanK with a highlighted K

The keys option lets you define what key that should be pressed. This is limited to on character only and they are case sensitive.

Example:

keys=["j","J"]

You can also set special-keys and they're for keys like Escape and Enter. To find the names of special keys you have to go to the following site and look for "var KeyNames = map[Key]string{"

https://github.com/gdamore/tcell/blob/master/key.go

INPUT.GLOBAL-DOWN¶

This section is [input.global-down] in your configuration file

Keys for moving down

keys¶

keys=[“j”,“J”]

special-keys¶

special-keys=[“Down”]

INPUT.GLOBAL-UP¶

This section is [input.global-up] in your configuration file

Keys for moving down

This section is [input.editor-exit] in your configuration file

Exit the editor

hint¶

hint=“[Esc] when done”

special-keys¶

special-keys=[“Esc”]

AUTHORS¶

Rasmus Lindroth.

2023-01-24

tut 2.0.0

Source file:	tut.5.en.gz (from tut 2.0.1-1.7)
Source last updated:	2023-04-14T14:57:01Z
Converted to HTML:	2024-05-05T01:38:10Z