aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/README.md b/README.md
index fbf610c..c39385d 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-er_xdg_pipe_menu
+xdg_pipe_menu
=====
Openbox pipemenu generator from XDG .desktop files
@@ -20,37 +20,37 @@ Running locally
The app is a long-running daemon: it scans your XDG application
directories once at startup, caches the rendered menu in memory, and
serves it over a Unix domain socket at
-`$XDG_RUNTIME_DIR/er_xdg_pipe_menu.sock` (falling back to
-`/tmp/er_xdg_pipe_menu-$USER.sock` if `XDG_RUNTIME_DIR` isn't set),
+`$XDG_RUNTIME_DIR/xdg_pipe_menu.sock` (falling back to
+`/tmp/xdg_pipe_menu-$USER.sock` if `XDG_RUNTIME_DIR` isn't set),
rebuilding the cache whenever a watched `.desktop` file changes.
For a quick manual run (e.g. while developing):
- $ rebar3 shell --eval "application:ensure_all_started(er_xdg_pipe_menu)."
+ $ rebar3 shell --eval "application:ensure_all_started(xdg_pipe_menu)."
To have it start automatically with your session, add a systemd
-user unit, e.g. `~/.config/systemd/user/er-xdg-pipe-menu.service`:
+user unit, e.g. `~/.config/systemd/user/xdg-pipe-menu.service`:
[Unit]
Description=XDG pipe menu daemon
[Service]
- WorkingDirectory=/path/to/er-xdg-pipe-menu
- ExecStart=/usr/bin/rebar3 shell --eval "application:ensure_all_started(er_xdg_pipe_menu)."
+ WorkingDirectory=/path/to/xdg-pipe-menu
+ ExecStart=/usr/bin/rebar3 shell --eval "application:ensure_all_started(xdg_pipe_menu)."
Restart=on-failure
[Install]
WantedBy=default.target
-then enable it with `systemctl --user enable --now er-xdg-pipe-menu`.
+then enable it with `systemctl --user enable --now xdg-pipe-menu`.
Openbox itself doesn't talk to the socket directly -- it invokes
-`bin/er_xdg_pipe_menu_menu` as the pipe menu command, which connects
+`bin/xdg_pipe_menu_menu` as the pipe menu command, which connects
to the daemon's socket and prints whatever comes back (or, if the
daemon isn't running, falls back to scanning/rendering inline so the
menu still works). Point a pipe menu at it in `~/.config/openbox/menu.xml`:
- <menu id="apps" label="Applications" execute="/path/to/er-xdg-pipe-menu/bin/er_xdg_pipe_menu_menu" />
+ <menu id="apps" label="Applications" execute="/path/to/xdg-pipe-menu/bin/xdg_pipe_menu_menu" />
The script resolves its own location to find the compiled code, so
it works from an absolute path as long as the repo's `_build`