Skip to content

Commit

Permalink
Fix documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
RasmusLindroth committed Dec 28, 2022
1 parent 71901d1 commit 9d76791
Show file tree
Hide file tree
Showing 8 changed files with 2,928 additions and 106 deletions.
97 changes: 49 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,59 +39,60 @@ You can find Linux binaries under [releases](https://github.com/RasmusLindroth/t
* [Thanks to](#thanks-to)

## Currently supported commands
* `:q` `:quit` exit
* `:timeline` home, local, federated, direct, notifications, mentions favorited, special-all, special-boosts, special-replies
* `:tl` h, l, f, d, n, m, fav, sa, sb, sr (shorter form)
* `:blocking` lists users that you have blocked
* `:boosts` lists users that boosted the toot
* `:bookmarks` lists all your bookmarks
* `:clear-notifications` clear all notifications
* `:close-window` closes the current window
* `:compose` compose a new toot
* `:edit` edit one of your toots
* `:favorited` lists toots you've favorited
* `:favorites` lists users that favorited the toot
* `:follow-tag` followed by the hashtag to follow e.g. `:follow-tag tut`
* `:followers` list of people the account are following. It only works on profiles.
* `:following` list of people following the account. It only works on profiles.
* `:h` `:help` view help
* `:history` show edits of a toot
* `:lists` show a list of your lists
* `:list-placement` top, right, bottom, left
* `:list-split` row, column
* `:move-window` left, right, up, down, home, end
* `:mv` l, r, u, d, h, e
* `:muting` lists users that you have muted
* `:newer` force load newer toots in current timeline
* `:preferences` update your profile and some other settings
* `:profile` go to your profile
* `:proportions` [int] [int], where the first integer is the list and the other content, e.g. `:proportions 1 3`
* `:refetch` refetches the current item
* `:requests` see following requests
* `:saved` alias for bookmarks
* `:stick-to-top` toggle the stick-to-top setting.
* `:tag` followed by the hashtag e.g. `:tag linux`
* `:tags` list of followed tags
* `:unfollow-tag` followed by the hashtag to unfollow e.g. `:unfollow-tag tut`
* `:user` followed by a username e.g. `:user rasmus` to narrow a search include
* `:window` switch window by index (zero indexed) e.g. `:window 0` for the first window.
* `:quit` = Exit tut
* `:q` = Shorter form of former command
* `:timeline home|local|federated|direct|notifications|mentions|favorited|special-all|special-boosts|special-replies` = Open selected timeline
* `:tl h|l|f|d|n|m|fav|sa|sb|sr` = Shorter form of former command
* `:blocking` = Lists users that you have blocked
* `:boosts` = Lists users that have boosted the toot
* `:bookmarks` = List all your bookmarks
* `:clear-notifications` = Remove all of your notifications
* `:close-window` = Closes the current window, including all the timelines in said window
* `:compose` = Compose a new toot
* `:edit` = Edit one of your toots
* `:favorited` = Lists toots you've favorited
* `:favorites` = Lists users that favorited the toot
* `:follow-tag <tag>` = Follow a hashtag named &lt;tag&gt;
* `:followers` = List of people the account are following. It only works on profiles
* `:following` = List of people follwing the account. It only works on profiles
* `:help` = Show help for how to use tut
* `:h` = Shorter form of former command
* `:history` = Show edits of a toot
* `:lists` = Show a list of your lists
* `:list-placement top|right|bottom|left` = Place the list in choosen placement
* `:list-split row|column` = Split the timelines in window by row or column
* `:move-window left|right|up|down|home|end` = Moves the window in choosen direction
* `:mv l|r|u|d|h|e` = Shorter form of former command
* `:muting` = Lists users that you&#39;ve muted
* `:newer` = Force load newer toots in current timeline
* `:preferences` = Update your profile and some other settings
* `:profile` = Go to your profile
* `:proportions [int] [int]` = Sets the proportions of the windows and the content. The first integer is your windows and the other for content, e.g. :proportions 1 3
* `:refetch` = Refetches the current item that you&#39;re viewing. Can be used to update poll results.
* `:saved` = Alias for bookmarks
* `:stick-to-top` = Toggle the stick-to-top setting that always shows the latest toot in all timelines
* `:tag <tag>` = Shows toots tagged with &lt;tag&gt;, e.g. :tag linux. You can input multiple tags if you want to show them in the same timeline
* `:tags` = List of tags that you&#39;re following
* `:unfollow-tag <tag>` = Unfollow the hashtag named &lt;tag&gt;, e.g. :unfollow-tag tut
* `:user <username>` = Search for users named &lt;username&gt;, e.g. :user rasmus. To narrow a search include the instance like this :user [email protected]
* `:window <int>` = Switch window by index (zero indexed) e.g. :window 0 for the left/top window

Keys without description in tut
* `c` = Compose a new toot
* `jk` = navigation up and down in feed
* `hl` = cycle through feeds without closing them as you do with `q` and `ESC`
* `arrow keys` = navigation. Same as `jk` and `hl`
* `g` or `Home` = go to top
* `G` or `End` = go to bottom
* `?` = view help
* `q` = go back and quit
* `ESC` = go back
* `j` or `Down arrow` = Navigate down in feed list or toot
* `k` or `Up arrow` = Navigate up in feed list or toot
* `h` or `Left arrow` = Cycle back in open timelines
* `l` or `Right arrow` = Cycle forward in open timelines
* `g` or `Home` = Go to top in feed list or toot
* `G` or `End` = Go to bottom in feed list or toot
* `?` = View help
* `q` = Go back or quit
* `Esc` = Go back

Explanation of the non obvious keys when viewing a toot
* `V` = view. In this mode you can scroll throught the text of the toot if it doesn't fit the screen
* `O` = open. Gives you a list of all URLs in the toot. Opens them in your default browser, if it's
an user or tag they will be opened in tut.
* `M` = media. Opens the media with `xdg-open`.
* `v` = view. In this mode you can scroll throught the text of the toot if it doesn&#39;t fit the screen
* `o` = open. Gives you a list of all URLs in the toot. Opens them in your default browser, if it&#39;s an user or tag they will be opened in tut
* `m` = media. Opens the media with xdg-open

## Configuration
Tut is configurable, so you can change things like the colors, the default timeline,
Expand Down
122 changes: 64 additions & 58 deletions config/help.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -4,132 +4,138 @@ Below are the keys that doesn't have hints in the TUI. All other keys have hints
That means that you'll have to press {{ Color .Style.TextSpecial2 }}{{ Flags "b" }}F{{ Flags "-" }}{{ Color .Style.Text }} to favorite a toot.

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}c{{ Flags "-" }}{{ Color .Style.Text }} - Compose a new toot
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}j{{ Flags "-" }}{{ Color .Style.Text }} or
{{- Color .Style.TextSpecial2 }}{{ Flags "b" }} Down arrow{{ Flags "-" }}{{ Color .Style.Text }} - Navigate down in feed list or toot
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}k{{ Flags "-" }}{{ Color .Style.Text }} or
{{- Color .Style.TextSpecial2 }}{{ Flags "b" }} Up arrow{{ Flags "-" }}{{ Color .Style.Text }} - Navigate up in feed list or toot
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}h{{ Flags "-" }}{{ Color .Style.Text }} or
{{- Color .Style.TextSpecial2 }}{{ Flags "b" }} Left arrow{{ Flags "-" }}{{ Color .Style.Text }} - Cycle back between feeds
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}l{{ Flags "-" }}{{ Color .Style.Text }} or
{{- Color .Style.TextSpecial2 }}{{ Flags "b" }} Right arrow{{ Flags "-" }}{{ Color .Style.Text }} - Cycle forward between feeds
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}g{{ Flags "-" }}{{ Color .Style.Text }} or
{{- Color .Style.TextSpecial2 }}{{ Flags "b" }} Home{{ Flags "-" }}{{ Color .Style.Text }} - Go to top in feed list or toot
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}G{{ Flags "-" }}{{ Color .Style.Text }} or
{{- Color .Style.TextSpecial2 }}{{ Flags "b" }} End{{ Flags "-" }}{{ Color .Style.Text }} - Go to bottom in feed list or toot
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}j{{ Flags "-" }}{{ Color .Style.Text }} or {{ Color .Style.TextSpecial2 }}{{ Flags "b" }}Down arrow{{ Flags "-" }}{{ Color .Style.Text }} - Navigate down in feed list or toot
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}k{{ Flags "-" }}{{ Color .Style.Text }} or {{ Color .Style.TextSpecial2 }}{{ Flags "b" }}Up arrow{{ Flags "-" }}{{ Color .Style.Text }} - Navigate up in feed list or toot
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}h{{ Flags "-" }}{{ Color .Style.Text }} or {{ Color .Style.TextSpecial2 }}{{ Flags "b" }}Left arrow{{ Flags "-" }}{{ Color .Style.Text }} - Cycle back in open timelines
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}l{{ Flags "-" }}{{ Color .Style.Text }} or {{ Color .Style.TextSpecial2 }}{{ Flags "b" }}Right arrow{{ Flags "-" }}{{ Color .Style.Text }} - Cycle forward in open timelines
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}g{{ Flags "-" }}{{ Color .Style.Text }} or {{ Color .Style.TextSpecial2 }}{{ Flags "b" }}Home{{ Flags "-" }}{{ Color .Style.Text }} - Go to top in feed list or toot
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}G{{ Flags "-" }}{{ Color .Style.Text }} or {{ Color .Style.TextSpecial2 }}{{ Flags "b" }}End{{ Flags "-" }}{{ Color .Style.Text }} - Go to bottom in feed list or toot
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}?{{ Flags "-" }}{{ Color .Style.Text }} - View help
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}q{{ Flags "-" }}{{ Color .Style.Text }} - Go back or quit
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}ESC{{ Flags "-" }}{{ Color .Style.Text }} - Go back
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}Esc{{ Flags "-" }}{{ Color .Style.Text }} - Go back

Explanation of the non obvious keys when viewing a toot

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}v{{ Flags "-" }}{{ Color .Style.Text }} - view. In this mode you can scroll throught the text of the toot if it doesn't fit the screen
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}o{{ Flags "-" }}{{ Color .Style.Text }} - open. Gives you a list of all URLs in the toot. Opens them in your default browser, if it's an user or tag they will be opened in tut
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}m{{ Flags "-" }}{{ Color .Style.Text }} - media. Opens the media with xdg-open

{{ Color .Style.Text }}{{ Flags "b" }}Commands{{ Flags "-" }}

All commands start with {{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:{{ Flags "-" }}{{ Color .Style.Text }}. And you run the command by hitting {{ Color .Style.TextSpecial2 }}{{ Flags "b" }}Enter{{ Flags "-" }}{{ Color .Style.Text }}.

Here's a list of supported commands.

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:q{{ Flags "-" }}{{ Color .Style.Text }} or
{{- Color .Style.TextSpecial2 }}{{ Flags "b" }} :quit{{ Flags "-" }}{{ Color .Style.Text }}
Exit the program
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:quit{{ Flags "-" }}{{ Color .Style.Text }}
Exit tut

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:q{{ Flags "-" }}{{ Color .Style.Text }}
Shorter form of former command

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:timeline{{ Flags "-" }}{{ Color .Style.Text }} home|local|federated|direct|notifications|mentions|favorited|special-all|special-boosts|special-replies
Open selected timeline
Open selected timeline

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:tl{{ Flags "-" }}{{ Color .Style.Text }} h|l|f|d|n|m|fav|sa|sb|sr
Shorter form of the former command *:timeline*
Shorter form of former command

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:blocking{{ Flags "-" }}{{ Color .Style.Text }}
Lists users that you have blocked
Lists users that you have blocked

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:boosts{{ Flags "-" }}{{ Color .Style.Text }}
Lists users that boosted the toot
Lists users that have boosted the toot

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:bookmarks{{ Flags "-" }}{{ Color .Style.Text }}
Lists all your bookmarks
List all your bookmarks

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:clear-notifications{{ Flags "-" }}{{ Color .Style.Text }}
Clear all notifications
Remove all of your notifications

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:close-window{{ Flags "-" }}{{ Color .Style.Text }}
Closes the current window
Closes the current window, including all the timelines in said window

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:compose{{ Flags "-" }}{{ Color .Style.Text }}
Compose a new toot
Compose a new toot

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:edit{{ Flags "-" }}{{ Color .Style.Text }}
Edit one of your toots
Edit one of your toots

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:favorited{{ Flags "-" }}{{ Color .Style.Text }}
Lists toots you've favorited
Lists toots you've favorited

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:favorites{{ Flags "-" }}{{ Color .Style.Text }}
Lists users that favorited the toot
Lists users that favorited the toot

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:follow-tag{{ Flags "-" }}{{ Color .Style.Text }}
Followed by the hashtag to follow e.g. :follow-tag tut
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:follow-tag{{ Flags "-" }}{{ Color .Style.Text }} <tag>
Follow a hashtag named <tag>

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:followers{{ Flags "-" }}{{ Color .Style.Text }}
List of people the account are following. It only works on profiles.
List of people the account are following. It only works on profiles

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:following{{ Flags "-" }}{{ Color .Style.Text }}
List of people following the account. It only works on profiles.
List of people follwing the account. It only works on profiles

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:help{{ Flags "-" }}{{ Color .Style.Text }}
Show help for how to use tut

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:h{{ Flags "-" }}{{ Color .Style.Text }} or
{{- Color .Style.TextSpecial2 }}{{ Flags "b" }} :help{{ Flags "-" }}{{ Color .Style.Text }}
View this help message
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:h{{ Flags "-" }}{{ Color .Style.Text }}
Shorter form of former command

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:history{{ Flags "-" }}{{ Color .Style.Text }}
Show edits of a toot
Show edits of a toot

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:lists{{ Flags "-" }}{{ Color .Style.Text }}
Show a list of your lists
Show a list of your lists

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:list-placement{{ Flags "-" }}{{ Color .Style.Text }} top|right|bottom|left
Place the lists where you want them
Place the list in choosen placement

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:list-split{{ Flags "-" }}{{ Color .Style.Text }} row|column
Split lists as rows or columns
Split the timelines in window by row or column

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:move-window{{ Flags "-" }}{{ Color .Style.Text }} left|right|up|down|home|end
Moves window in selected direction
Moves the window in choosen direction

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:mv{{ Flags "-" }}{{ Color .Style.Text }} l|r|u|d|h|e
Shorter form of the former command *:move-window*
Shorter form of former command

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:muting{{ Flags "-" }}{{ Color .Style.Text }}
Lists users that you have muted
Lists users that you've muted

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:newer{{ Flags "-" }}{{ Color .Style.Text }}
Force load newer toots in current timeline

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:preferences{{ Flags "-" }}{{ Color .Style.Text }}
Update your profile and some other settings

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:profile{{ Flags "-" }}{{ Color .Style.Text }}
Go to your own profile
Go to your profile

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:proportions{{ Flags "-" }}{{ Color .Style.Text }} [int] [int]
Set proportions for list and content with an int. First list proportion then content proportion
Sets the proportions of the windows and the content. The first integer is your windows and the other for content, e.g. :proportions 1 3

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:refetch{{ Flags "-" }}{{ Color .Style.Text }}
Refetch the current item
Refetches the current item that you're viewing. Can be used to update poll results.

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:requests{{ Flags "-" }}{{ Color .Style.Text }}
See following requests
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:saved{{ Flags "-" }}{{ Color .Style.Text }}
Alias for bookmarks

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:stick-to-top{{ Flags "-" }}{{ Color .Style.Text }}
Toggle the stick-to-top setting.
Toggle the stick-to-top setting that always shows the latest toot in all timelines

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:saved{{ Flags "-" }}{{ Color .Style.Text }}
Alias for :bookmarks
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:tag{{ Flags "-" }}{{ Color .Style.Text }} <tag>
Shows toots tagged with <tag>, e.g. :tag linux. You can input multiple tags if you want to show them in the same timeline

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:tag{{ Flags "-" }}{{ Color .Style.Text }} tagname
See toots for a tag e.g. :tag linux
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:tags{{ Flags "-" }}{{ Color .Style.Text }}
List of tags that you're following

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:tags{{ Flags "-" }}{{ Color .Style.Text }} tagname
List of followed tags
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:unfollow-tag{{ Flags "-" }}{{ Color .Style.Text }} <tag>
Unfollow the hashtag named <tag>, e.g. :unfollow-tag tut

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:unfollow-tag{{ Flags "-" }}{{ Color .Style.Text }}
Followed by the hashtag to unfollow e.g. :unfollow-tag tut
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:user{{ Flags "-" }}{{ Color .Style.Text }} <username>
Search for users named <username>, e.g. :user rasmus. To narrow a search include the instance like this :user [email protected]

{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:user{{ Flags "-" }}{{ Color .Style.Text }} username
Go to profile for <username>. E.g. :user rasmus
To narrow a search include the instance like this :user [email protected]
{{ Color .Style.TextSpecial2 }}{{ Flags "b" }}:window{{ Flags "-" }}{{ Color .Style.Text }} <int>
Switch window by index (zero indexed) e.g. :window 0 for the left/top window

{{ Color .Style.Text }}{{ Flags "b" }}Configuration{{ Flags "-" }}

Expand Down
Loading

0 comments on commit 9d76791

Please sign in to comment.