summaryrefslogtreecommitdiff
path: root/piem.texi
diff options
context:
space:
mode:
authorKyle Meyer <kyle@kyleam.com>2020-11-08 22:00:34 -0500
committerKyle Meyer <kyle@kyleam.com>2020-11-08 22:33:38 -0500
commitc875ce13310444e0d4628f2b40feb8bd7fc3ac70 (patch)
tree185354799c7e430b6773dbae0a1b5e313bdd8f51 /piem.texi
parent524862221a0928ef707cb5ab91cea8cf50bc3168 (diff)
downloadpiem-c875ce13310444e0d4628f2b40feb8bd7fc3ac70.tar.gz
Add a dispatch transient for commands
A standard prefix command would do, but since piem-b4 already depends on transient, use transient here as well to provide a more helpful interface. Message-Id: <20201109030034.11429-1-kyle@kyleam.com>
Diffstat (limited to 'piem.texi')
-rw-r--r--piem.texi15
1 files changed, 15 insertions, 0 deletions
diff --git a/piem.texi b/piem.texi
index 131ab44..a201948 100644
--- a/piem.texi
+++ b/piem.texi
@@ -119,6 +119,21 @@ designed to work with public-inbox archives.)
@node Getting started
@chapter Getting started
+@findex piem-dispatch
+
+@code{piem-dispatch} transient
+(see
+@ifinfo
+@ref{Top,,,transient}
+@end ifinfo
+@ifnotinfo
+@url{https://magit.vc/manual/transient/}
+@end ifnotinfo
+)
+provides an entry point to piem commands.
+It's recommended to bind @code{piem-dispatch} to a key. However, before
+most of those commands do anything useful, you need to register inboxes
+and activate at least one minor mode.
@node Registering inboxes
@section Registering inboxes