include editor

RasmusLindroth · Jan 7, 2023 · bfa50c5 · bfa50c5
1 parent 28d6e53
commit bfa50c5
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 0 deletions.
diff --git a/config.example.toml b/config.example.toml
@@ -1,6 +1,12 @@
 # Configuration file for tut
 
 [general]
+# 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.
+# default="TUT_USE_INTERNAL"
+editor="TUT_USE_INTERNAL"
+
 # You need to press yes in a confirmation dialog before favoriting, boosting,
 # etc.
 # valid: true, false

diff --git a/config/default_config.go b/config/default_config.go
@@ -3,6 +3,12 @@ package config
 var conftext = `# Configuration file for tut
 
 [general]
+# 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.
+# default="TUT_USE_INTERNAL"
+editor="TUT_USE_INTERNAL"
+
 # You need to press yes in a confirmation dialog before favoriting, boosting,
 # etc.
 # valid: true, false

diff --git a/docs/man/tut.5 b/docs/man/tut.5
@@ -40,6 +40,16 @@ The last line under each options shows the default value.
 .SH GENERAL
 .PP
 This section is [general] in your configuration file
+.SS editor
+.PP
+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.
+.PD 0
+.P
+.PD
+\f[B]editor\f[R]=\f[I]\[lq]TUT_USE_INTERNAL\[rq]\f[R]
 .SS confirmation
 .PP
 You need to press yes in a confirmation dialog before favoriting,

diff --git a/docs/man/tut.5.md b/docs/man/tut.5.md
@@ -21,6 +21,10 @@ Under each section there is the name of the configuration option. The last line
 # 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.