From 9e8af9d25106b615dabf956305f4ef80496ed412 Mon Sep 17 00:00:00 2001
From: Phil Jones <philj56@gmail.com>
Date: Sun, 24 Jul 2022 12:31:09 +0100
Subject: Add drun mode.

This is a pretty simple implementation, but it should work for most
use cases. Notably, generic application names aren't used (though that
could be added without too much hassle), and neither are keywords (that
would be more difficult).
---
 doc/tofi.1.md  | 15 +++++++++++++++
 doc/tofi.1.scd | 13 +++++++++++++
 doc/tofi.5.md  |  7 +++++++
 doc/tofi.5.scd |  6 ++++++
 4 files changed, 41 insertions(+)

(limited to 'doc')

diff --git a/doc/tofi.1.md b/doc/tofi.1.md
index 6d2d83f..6de0027 100644
--- a/doc/tofi.1.md
+++ b/doc/tofi.1.md
@@ -9,6 +9,8 @@ tofi - Tiny dynamic menu for Wayland, inspired by **rofi**(1) and
 
 **tofi-run** \[options...\]
 
+**tofi-drun** \[options...\]
+
 **tofi-compgen**
 
 # DESCRIPTION
@@ -21,6 +23,10 @@ printed to stdout.
 When invoked via the name **tofi-run**, **tofi** will not accept items
 on stdin, instead presenting a list of executables in the user's $PATH.
 
+When invoked via the name **tofi-drun**, **tofi** will not accept items
+on stdin, and will generate a list of applications from desktop files as
+described in the Desktop Entry Specification.
+
 **tofi-compgen** just prints the list of executables used by
 **tofi-run**.
 
@@ -76,11 +82,20 @@ the form **--key=value**.
 
 > Cached list of executables under $PATH, regenerated as necessary.
 
+*$XDG_CACHE_HOME/tofi-drun*
+
+> Cached list of desktop applications, regenerated as necessary.
+
 *$XDG_STATE_HOME/tofi-history*
 
 > Numeric count of commands selected in **tofi-run**, to enable sorting
 > results by run count.
 
+*$XDG_STATE_HOME/tofi-drun-history*
+
+> Numeric count of commands selected in **tofi-drun**, to enable sorting
+> results by run count.
+
 # AUTHORS
 
 Philip Jones \<philj56@gmail.com\>
diff --git a/doc/tofi.1.scd b/doc/tofi.1.scd
index 0e48639..d15d394 100644
--- a/doc/tofi.1.scd
+++ b/doc/tofi.1.scd
@@ -10,6 +10,8 @@ tofi - Tiny dynamic menu for Wayland, inspired by *rofi*(1) and *dmenu*(1).
 
 *tofi-run* [options...]
 
+*tofi-drun* [options...]
+
 *tofi-compgen*
 
 # DESCRIPTION
@@ -21,6 +23,10 @@ a graphical selection menu. When a selection is made, it is printed to stdout.
 When invoked via the name *tofi-run*, *tofi* will not accept items on stdin,
 instead presenting a list of executables in the user's $PATH.
 
+When invoked via the name *tofi-drun*, *tofi* will not accept items on stdin,
+and will generate a list of applications from desktop files as described in the
+Desktop Entry Specification.
+
 *tofi-compgen* just prints the list of executables used by *tofi-run*.
 
 # OPTIONS
@@ -65,10 +71,17 @@ _$XDG_CONFIG_HOME/tofi/config_
 _$XDG_CACHE_HOME/tofi-compgen_
 	Cached list of executables under $PATH, regenerated as necessary.
 
+_$XDG_CACHE_HOME/tofi-drun_
+	Cached list of desktop applications, regenerated as necessary.
+
 _$XDG_STATE_HOME/tofi-history_
 	Numeric count of commands selected in *tofi-run*, to enable sorting
 	results by run count.
 
+_$XDG_STATE_HOME/tofi-drun-history_
+	Numeric count of commands selected in *tofi-drun*, to enable sorting
+	results by run count.
+
 # AUTHORS
 
 Philip Jones <philj56@gmail.com>
diff --git a/doc/tofi.5.md b/doc/tofi.5.md
index f5df5cf..3137dc3 100644
--- a/doc/tofi.5.md
+++ b/doc/tofi.5.md
@@ -216,6 +216,13 @@ options.
 >
 > Default: true
 
+**drun-launch**=*true\|false*
+
+> If true, directly launch applications on selection when in drun mode.
+> Otherwise, just print the path of the .desktop file to stdout.
+>
+> Default: false
+
 **hint-font**=*true\|false*
 
 > Perform font hinting. Only applies when a path to a font has been
diff --git a/doc/tofi.5.scd b/doc/tofi.5.scd
index 7946cf1..7b0dd9b 100644
--- a/doc/tofi.5.scd
+++ b/doc/tofi.5.scd
@@ -187,6 +187,12 @@ options.
 
 	Default: true
 
+*drun-launch*=_true|false_
+	If true, directly launch applications on selection when in drun mode.
+	Otherwise, just print the path of the .desktop file to stdout.
+
+	Default: false
+
 *hint-font*=_true|false_
 	Perform font hinting. Only applies when a path to a font has been
 	specified via *font-name*. Disabling font hinting speeds up text
-- 
cgit v1.2.3