Browse Source

update docs

pull/253/head
Rasmus Lindroth 3 years ago
parent
commit
a5e1b52624
  1. 50
      config.example.toml
  2. 48
      config/default_config.go
  3. 89
      docs/man/tut.5
  4. 61
      docs/man/tut.5.md
  5. 2
      docs/man/tut.7.md

50
config.example.toml

@ -121,6 +121,9 @@ leader-key=""
leader-timeout=1000
# [[general.timelines]]
# 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"
@ -129,11 +132,11 @@ leader-timeout=1000
# hide-replies=false
#
# [[general.timelines]]
# name = "Notifications"
# type = "notifications"
# keys = ["n", "N"]
# closed = true
# on-creation-closed = "new-pane"
# name="Notifications"
# type="notifications"
# keys=["n", "N"]
# closed=true
# on-creation-closed="new-pane"
# on-focus="focus-self"
# The name to display above the timeline
@ -146,7 +149,8 @@ leader-timeout=1000
# default=""
# type=""
# Used for the tag type, so here you set the tag.
# Used for the tag type, so here you set the tag. If you have multiple you
# seperate them with a space.
# default=""
# data=""
@ -190,6 +194,38 @@ leader-timeout=1000
# on-focus="focus-pane"
# [[general.leader-actions]]
# 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"
#
# 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,
@ -696,8 +732,10 @@ keys=["f","F"]
[input.status-media]
# Open toots media files
# default="[M]edia"
hint="[M]edia"
# default=["m", "M"]
keys=["m","M"]

48
config/default_config.go

@ -123,6 +123,9 @@ leader-key=""
leader-timeout=1000
# [[general.timelines]]
# 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"
@ -131,11 +134,11 @@ leader-timeout=1000
# hide-replies=false
#
# [[general.timelines]]
# name = "Notifications"
# type = "notifications"
# keys = ["n", "N"]
# closed = true
# on-creation-closed = "new-pane"
# name="Notifications"
# type="notifications"
# keys=["n", "N"]
# closed=true
# on-creation-closed="new-pane"
# on-focus="focus-self"
# The name to display above the timeline
@ -148,7 +151,8 @@ leader-timeout=1000
# default=""
# type=""
# Used for the tag type, so here you set the tag.
# Used for the tag type, so here you set the tag. If you have multiple you
# seperate them with a space.
# default=""
# data=""
@ -192,6 +196,38 @@ leader-timeout=1000
# on-focus="focus-pane"
# [[general.leader-actions]]
# 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"
#
# 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,

89
docs/man/tut.5

@ -255,9 +255,13 @@ the input after X milliseconds.
This section is [[general.timelines]] in your configuration file.
You can have multiple of them.
.PP
Timelines adds panes of feeds.
You can customize the number of feeds, what they should show and the key
to activate them.
.PP
Example:
.PP
[general.timelines]
[[general.timelines]]
.PD 0
.P
.PD
@ -275,27 +279,27 @@ hide-boosts=false
.PD
hide-replies=false
.PP
[general.timelines]
[[general.timelines]]
.PD 0
.P
.PD
name = \[dq]Notifications\[dq]
name=\[dq]Notifications\[dq]
.PD 0
.P
.PD
type = \[dq]notifications\[dq]
type=\[dq]notifications\[dq]
.PD 0
.P
.PD
keys = [\[dq]n\[dq], \[dq]N\[dq]]
keys=[\[dq]n\[dq], \[dq]N\[dq]]
.PD 0
.P
.PD
closed = true
closed=true
.PD 0
.P
.PD
on-creation-closed = \[dq]new-pane\[dq]
on-creation-closed=\[dq]new-pane\[dq]
.PD 0
.P
.PD
@ -318,6 +322,7 @@ notifications, lists, mentions, tag
.SS data
.PP
Used for the tag type, so here you set the tag.
If you have multiple you seperate them with a space.
.PD 0
.P
.PD
@ -388,6 +393,76 @@ valid: focus-pane, focus-self
.PP
This section is [[general.leader-actions]] in your configuration file.
You can have multiple of them.
.PP
You set actions leader-key with one or more leader-actions.
.PP
The shortcuts are up to you, but keep them quite short and make sure
they don\[aq]t collide.
If you have one shortcut that is \[dq]f\[dq] and an other one that is
\[dq]fav\[dq], the one with \[dq]f\[dq] will always run and
\[dq]fav\[dq] will never run.
.PP
Some special actions that requires data to be set:
.PD 0
.P
.PD
pane is special as it\[aq]s a shortcut for switching between the panes
you\[aq]ve set under general and they are zero indexed.
pane 0 = your first timeline, pane 1 = your second and so on.
.PD 0
.P
.PD
list-placement as it takes the argument top, right, bottom or left
.PD 0
.P
.PD
list-split as it takes the argument column or row
.PD 0
.P
.PD
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.
.PP
Example:
.PP
[[general.leader-actions]]
.PD 0
.P
.PD
type=\[dq]close-pane\[dq]
.PD 0
.P
.PD
shortcut=\[dq]q\[dq]
.PP
[[general.leader-actions]]
.PD 0
.P
.PD
type=\[dq]list-split\[dq]
.PD 0
.P
.PD
data=\[dq]row\[dq]
.PD 0
.P
.PD
shortcut=\[dq]r\[dq]
.PP
[[general.leader-actions]]
.PD 0
.P
.PD
type=\[dq]list-split\[dq]
.PD 0
.P
.PD
data=\[dq]column\[dq]
.PD 0
.P
.PD
shortcut=\[dq]c\[dq]
.SS type
.PP
The action you want to run.

61
docs/man/tut.5.md

@ -138,20 +138,22 @@ Number of milliseconds before the leader command resets. So if you tap the leade
# 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]]
\[\[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\"
\[\[general.timelines\]\]
name=\"Notifications\"
type=\"notifications\"
keys=\[\"n\", \"N\"\]
closed=true
on-creation-closed=\"new-pane\"
on-focus=\"focus-self\"
## name
@ -166,7 +168,7 @@ valid: home, direct, local, federated, bookmarks, saved, favorited, notification
**type**=*""*
## data
Used for the tag type, so here you set the tag.
Used for the tag type, so here you set the tag. If you have multiple you seperate them with a space.
**data**=*""*
## keys
@ -210,6 +212,33 @@ valid: focus-pane, focus-self
# 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.
@ -529,20 +558,20 @@ 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 normaly.
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.
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 normaly.
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
\"\[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 sensetive.
Example:
keys=[\"j\",\"J\"]
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{\"
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

2
docs/man/tut.7.md

@ -113,7 +113,7 @@ To change the keys look at tut(5) under the *INPUT* section.
**:profile**
: Go to your profile
**:proportions** *[int] [int]*
**: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**

Loading…
Cancel
Save