New feature - Display commands (#60)

* Moved custom_index_template to templates/

* Since its not a config variable, renamed to better fit purpose cfg_log_file_forced -> log_file_forced

* various small fixes

* Display menu commands

* fixed menu_reload

Author: jaclu

README.md

@@ -20,9 +20,13 @@ experienced users, then add more for newbies.
 
 ## Recent Changes
 
+- Added new feature Display Commands, see `Display menu commands` in the Configuration
+  section
+- Fixed handling of menu options in tmux 3.0 - 3.2a since they don't return an
+  error for missing options
+- Added display commands feature, see Display menu commands section in
 - Removed all jk shortcuts in menus, allowing for consistent vim style navigation.
 - Plugin is initialized in the background, to cut down on tpm processing time.
-- Further optimized caching, cutting rendeing times in half.
 
 </details>
 <details>
@@ -144,63 +148,6 @@ Manager](https://github.com/tmux-plugins/tpm).
 
 The plugin should now be activated.
 
-</details>
-<details>
-<summary>Using Styling for menus</summary>
-<br>
-
-### Using Styling for menus
-
-See [docs/Styling.md](docs/Styling.md)
-
-</details>
-<details>
-<summary>Custom menus</summary>
-<br>
-
-## Custom Menus
-
-While the initial assumption was that users wanting to modify the menus would fork
-the repository and make changes directly, a feature was added to allow menus to
-be added dynamically based on user requests.
-
-For details on how to use this feature, see the documentation:
-[docs/CustomMenus.md](docs/CustomMenus.md)
-
-</details>
-<details>
-<summary>whiptail / dialog</summary>
-<br>
-
-## whiptail / dialog - alternate tools for displaying menus
-
-For tmux < 3.0 the tmux feature`display-menu` is not available.
-
-If found `whiptail` or `dialog` will be used to display menus.
-
-The preferred option is whiptail, but if not found dialog will be used instead.
-If neither is available, this plugin will abort displaying an error message.
-
-Since these are full-screen apps, when either is used, the current (if any)
-task is suspended, dialogs are run, and when done the suspended task is reactivated.
-
-The menu system works the same using external menu handlers, however the menu
-shortcuts are not as convenient, since they do not differentiate between upper
-and lower case letters,
-and does not at all support special keys like 'Left' or 'Home'
-
-To use external dialog handling on modern tmuxes set this env variable:
-
-- for `whiptail` use `export TMUX_MENUS_HANDLER=1`
-- for `dialog` use `export TMUX_MENUS_HANDLER=2`
-
-In most cases whiptail is installed by default on Linux distros. If not, install
-it using the package manager.
-One gotcha is that in the Red Hat universe the package is not called whiptail,
-the package containing whiptail is called `newt`.
-
-MacOS does not come with whiptail, but it is available in the Homebrew package `newt`.
-
 </details>
 <details>
 <summary>Configuration</summary>
@@ -239,18 +186,35 @@ as well as when not using quotes.
 
 ### Display without using prefix
 
-In order to trigger menus without first hitting `<prefix>`
-
 ```tmux
 set -g @menus_without_prefix 'Yes'
 ```
 
-This boolean parameter can be either `Yes` or `No` (the default)
+This boolean parameter defaults to `No`
+
+Use this in order to trigger menus without first hitting `<prefix>`
+
+### Pointer to the config file
+
+```tmux
+set -g @menus_config_file '~/.configs/tmux.conf'
+```
+
+In the main menu, the tmux config file to be reloaded.
+The default location for this is:
+
+1. `@menus_config_file` - if this is defined in the tmux config file, it will be used.
+2. `$TMUX_CONF` - if this is present in the environment, it will be used.
+3. `$XDG_CONFIG_HOME/tmux/tmux.conf` - if `$XDG_CONFIG_HOME` is defined.
+4. `~/.tmux.conf` - Default if none of the above are set.
+
+When a reload is requested, the conf file will be prompted for, defaulting
+to the first match above. It can be manually changed.
 
 ### Menu location
 
-The default locations are: `C` for tmux >= 3.2 `P` otherwise. If whiptail/dialog is used,
-menu location is ignored
+The default locations are: `C` for tmux >= 3.2 `P` otherwise. If whiptail/dialog
+is used, menu location is ignored
 
 ```tmux
 set -g @menus_location_x 'W'
@@ -271,13 +235,13 @@ The basic options are:
 
 ### Disable caching
 
-By default menu items are cached, set this to `No` to disable all caching.
-
 ```tmux
 set -g @menus_use_cache 'No'
 ```
 
-This boolean parameter can be either `Yes` (the default) or `No`
+This boolean parameter defaults to `Yes`
+
+By default menu items are cached.
 
 Disabling caching also disables the Custom Menus feature.
 
@@ -296,26 +260,33 @@ that cache item is regenerated.
 
 ### Use Hint Overlays
 
+```tmux
+set -g @menus_use_hint_overlays 'No'
+```
+
+This boolean parameter defaults to `Yes`
+
 Some menu items will display tmux dialogs, where each have their own rather complex
-set of special key bindings - choose-buffer, choose-client, choose-tree and customize-mode
+set of special key bindings - choose-buffer, choose-client, choose-tree and
+customize-mode
 
 When entering such a dialog, per default an overlay will first be presented lisitng
 the keys available for that dialog, if it fits on screen.
 
 Use this setting to disable the overlay feature.
 
-```tmux
-set -g @menus_use_hint_overlays 'No'
-```
-
-This boolean parameter can be either `Yes` (the default) or `No`
-
 If `@menus_use_hint_overlays` is enabled, there is a support option
-`@menus_show_key_hints` (defaults to 'No') that also can be toggled. If `@menus_use_hint_overlays`
-is disabled, `@menus_show_key_hints` is ignored.
+`@menus_show_key_hints` (defaults to 'No') that also can be toggled.
+If `@menus_use_hint_overlays` is disabled, `@menus_show_key_hints` is ignored.
 
 #### Show Key Hints
 
+```tmux
+set -g @menus_show_key_hints 'Yes'
+```
+
+This boolean parameter defaults to `No`
+
 Related to `@menus_use_hint_overlays` Since those key-listings tend to be rather long
 they might not fit on screen, and thus be silently skipped.
 Enabling this will offer an extra option `Key Hints` on each menu featuring an
@@ -327,37 +298,28 @@ screen is to small, mentioning required screen size.
 
 It will also serve as a hint as to what menu entries are expected to display an overlay.
 
-```tmux
-set -g @menus_show_key_hints 'Yes'
-```
-
-This boolean parameter can be either `Yes` or `No` (the default)
+### Logging
 
-### Pointer to the config file
+Per default logging is disabled. If this is desired, provide a log file name
+like this:
 
 ```tmux
-set -g @menus_config_file '~/.configs/tmux.conf'
+set -g @menus_log_file '~/tmp/tmux-menus.log'
 ```
 
-In the main menu, the tmux config file to be reloaded.
-The default location for this is:
+### Display menu commands
 
-1. `@menus_config_file` - if this is defined in the tmux config file, it will be used.
-2. `$TMUX_CONF` - if this is present in the environment, it will be used.
-3. `$XDG_CONFIG_HOME/tmux/tmux.conf` - if `$XDG_CONFIG_HOME` is defined.
-4. `~/.tmux.conf` - Default if none of the above are set.
-
-When a reload is requested, the conf file will be prompted for, defaulting
-to the first match above. It can be manually changed.
+```tmux
+set -g @menus_display_commands 'Yes'
+```
 
-### Logging
+This boolean parameter defaults to `No`
 
-Per default logging is disabled. If this is desired, provide a log file name
-like this:
+If set to true each menu will include an extra item `Display Commands` with the
+shortcut `!` pressing this will display what command is used for each action.
 
-```tmux
-set -g @menus_log_file '~/tmp/tmux-menus.log'
-```
+Be aware that the menu will be taller when using this, so make sure the screen is
+large enough to display it!
 
 </details>
 <details>
@@ -386,6 +348,63 @@ It will also be displayed if the menu is closed right away intentionally
 or unintentionally, so there will no doubt sometimes be false positives.
 If it doesn't happen the next time the menu is attempted, it can be ignored.
 
+</details>
+<details>
+<summary>Using Styling for menus</summary>
+<br>
+
+## Using Styling for menus
+
+See [docs/Styling.md](docs/Styling.md)
+
+</details>
+<details>
+<summary>Custom menus</summary>
+<br>
+
+## Custom Menus
+
+While the initial assumption was that users wanting to modify the menus would fork
+the repository and make changes directly, a feature was added to allow menus to
+be added dynamically based on user requests.
+
+For details on how to use this feature, see the documentation:
+[docs/CustomMenus.md](docs/CustomMenus.md)
+
+</details>
+<details>
+<summary>whiptail / dialog</summary>
+<br>
+
+## whiptail / dialog - alternate tools for displaying menus
+
+For tmux < 3.0 the tmux feature`display-menu` is not available.
+
+If found `whiptail` or `dialog` will be used to display menus.
+
+The preferred option is whiptail, but if not found dialog will be used instead.
+If neither is available, this plugin will abort displaying an error message.
+
+Since these are full-screen apps, when either is used, the current (if any)
+task is suspended, dialogs are run, and when done the suspended task is reactivated.
+
+The menu system works the same using external menu handlers, however the menu
+shortcuts are not as convenient, since they do not differentiate between upper
+and lower case letters,
+and does not at all support special keys like 'Left' or 'Home'
+
+To use external dialog handling on modern tmuxes set this env variable:
+
+- for `whiptail` use `export TMUX_MENUS_HANDLER=1`
+- for `dialog` use `export TMUX_MENUS_HANDLER=2`
+
+In most cases whiptail is installed by default on Linux distros. If not, install
+it using the package manager.
+One gotcha is that in the Red Hat universe the package is not called whiptail,
+the package containing whiptail is called `newt`.
+
+MacOS does not come with whiptail, but it is available in the Homebrew package `newt`.
+
 </details>
 <details>
 <summary>Modifications</summary>
@@ -530,8 +549,8 @@ The best way to send feedback is to file an
 ## Thanks to
 
 - [sumskyi](https://github.com/sumskyi) for notifying me that the boolean check
-error message for invalid values lacked the significant info about what variable
-contained the incorrect value. Addressed in release 2.0.2
+  error message for invalid values lacked the significant info about what variable
+  contained the incorrect value. Addressed in release 2.0.2
 - [GaikwadPratik](https://github.com/GaikwadPratik) for notifying me that the
   Disable caching feature was broken
 - [Tony Soloveyv](https://github.com/tony-sol) for spotting an unintentional

docs/Debugging.md

@@ -16,6 +16,11 @@ teh_debug to false.
 It will also limit the error_display in case of errors to a one-liner in the log_file
 In order not to flood the log with an elaborate error report.
 
+## TMUX_MENUS_SHOW_CMDS
+
+If this is set to 1 menus will always show commands, regardless of what
+`@menus_display_commands` is set to.
+
 ## TMUX_MENUS_LOGGING_MINIMAL
 
 If set to 1 only errors and menu rendering times will be logged, practicall if

docs/TODO.md

@@ -1,5 +1,15 @@
 # Plan
 
+## New feature: Show cmds
+
+By pressing `!` for each command in current menu list current binding (if any).
+Otherwise show the tmux sequence needed for the command including any support
+scripts, but excluding menu reload.
+
+## Currencies - Zloty
+
+The symbol is two chars, so work around the current one char limitation
+
 ## WhipTail
 
 - menu_reload is not working, so disabled

items/advanced.sh

@@ -34,7 +34,7 @@ dynamic_content() {
             'Prefix key without C- (will take effect imeditally)' \
             'run-shell \"$d_scripts/change_prefix.sh %1 $reload_in_runshell\"'"
 
-    menu_generate_part 2 "$@"
+    menu_generate_part 4 "$@"
 }
 
 static_content() {
@@ -44,7 +44,11 @@ static_content() {
 
     # 2.7 M M "Manage clients    $nav_next" advanced_manage_clients.sh \
     set -- \
-        0.0 M Left "Back to Main menu  $nav_home" main.sh \
+        0.0 M Left "Back to Main menu  $nav_home" main.sh
+    menu_generate_part 1 "$@"
+    $cfg_display_cmds && display_commands_toggle 2
+
+    set -- \
         0.0 S
 
     if $cfg_use_whiptail; then
@@ -81,7 +85,7 @@ static_content() {
             "$d_hints/choose-client.sh $0"
 
     }
-    menu_generate_part 1 "$@"
+    menu_generate_part 3 "$@"
 
     # shellcheck disable=SC2154
     set -- \
@@ -91,8 +95,7 @@ static_content() {
         1.8 C x "Kill server" "confirm-before -p \
             'kill tmux server defined in($TMUX_SOURCE) ? (y/n)' kill-server"
 
-    menu_generate_part 3 "$@"
-
+    menu_generate_part 5 "$@"
 }
 
 #===============================================================

items/currencies.sh

@@ -31,7 +31,11 @@ static_content() {
 
     set -- \
         0.0 M Left "Back to Missing Keys  $nav_prev" missing_keys.sh \
-        0.0 M Home "Back to Main menu     $nav_home" main.sh \
+        0.0 M Home "Back to Main menu     $nav_home" main.sh
+    menu_generate_part 1 "$@"
+    $cfg_display_cmds && display_commands_toggle 2
+
+    set -- \
         0.0 S
 
     # how to print?
@@ -54,8 +58,7 @@ static_content() {
         0.0 S \
         0.0 M H "Help                  $nav_next" "$d_help/help_currencies.sh $0"
 
-    menu_generate_part 1 "$@"
-
+    menu_generate_part 3 "$@"
 }
 
 #===============================================================