diff --git a/README.md b/README.md index 25eb20c..c50a993 100644 --- a/README.md +++ b/README.md @@ -1,139 +1,13 @@ -# 🌱 herbe -> Daemon-less notifications without D-Bus. Minimal and lightweight. +# dictpopup -

- -

+It's a very lightweight program to show a popup with the translation of the selected text. It uses [sdcv](https://github.com/Dushistov/sdcv) for the dictionary lookup and a slightly modified version of [herbe](https://github.com/dudik/herbe) to display the popup. -## Features -* Under 200 lines of code -* Doesn't run in the background, just displays the notification and exits -* No external dependencies except Xlib and Xft -* Configurable through `config.h` or Xresources ([using this patch](https://github.com/dudik/herbe/pull/11)) -* [Actions support](#actions) -* Extensible through [patches](https://github.com/dudik/herbe/pulls?q=is%3Aopen+is%3Apr+label%3Apatch) +## Dependencies +xclip, sdcv -## Table of contents - -* [Usage](#usage) - * [Patches](#patches) - * [Dismiss a notification](#dismiss-a-notification) - * [Actions](#actions) - * [Newlines](#newlines) - * [Multiple notifications](#multiple-notifications) - * [Notifications don't show up](#notifications-dont-show-up) -* [Installation](#installation) - * [Packages](#packages) - * [Dependencies](#dependencies) - * [Build](#build) -* [Configuration](#configuration) -* [Contribute](#contribute) +## Setup +Compile with `make` and place `dictpopup` as well as `popup` in your PATH. ## Usage - -### Patches -[List of available patches](https://github.com/dudik/herbe/pulls?q=is%3Aopen+is%3Apr+label%3Apatch) - -To create a new patch you'll have to open a pull request with your changes. Append `.diff` to the pull request URL to get a downloadable diff file. Don't forget to prefix the title with `patch:` and to apply the `patch` label to it. For inspiration, look at [my Xresources patch](https://github.com/dudik/herbe/pull/11). Thank you. - -_Note: This patching method was heavily inspired by [dylan's sowm](https://github.com/dylanaraps/sowm)._ - -### Dismiss a notification -A notification can be dismissed either by clicking on it with `DISMISS_BUTTON` (set in config.h, defaults to left mouse button) or sending a `SIGUSR1` signal to it: -```shell -$ pkill -SIGUSR1 herbe -``` -Dismissed notifications return exit code 2. - -### Actions -Action is a piece of shell code that runs when a notification gets accepted. Accepting a notification is the same as dismissing it, but you have to use either `ACTION_BUTTON` (defaults to right mouse button) or the `SIGUSR2` signal. -An accepted notification always returns exit code 0. To specify an action: -```shell -$ herbe "Notification body" && echo "This is an action" -``` -Where everything after `&&` is the action and will get executed after the notification gets accepted. - -### Newlines -Every command line argument gets printed on a separate line by default e.g.: -```shell -$ herbe "First line" "Second line" "Third line" ... -``` -You can also use `\n` e.g. in `bash`: -```shell -$ herbe $'First line\nSecond line\nThird line' -``` -But by default `herbe` prints `\n` literally: -```shell -$ herbe "First line\nStill the first line" -``` -Output of other programs will get printed correctly, just make sure to escape it (so you don't end up with every word on a separate line): -```shell -$ herbe "$(ps axch -o cmd:15,%cpu --sort=-%cpu | head)" -``` - -### Multiple notifications -Notifications are put in a queue and shown one after another in order of creation (first in, first out). They don't overlap and each one is shown for its entire duration. - -### Notifications don't show up -Most likely a running notification got terminated forcefully (SIGKILL or any uncaught signal) which caused the semaphore not getting unlocked. First, kill any `herbe` instance that is stuck: -```shell -$ pkill -SIGKILL herbe -``` -Then just call `herbe` without any arguments: -```shell -$ herbe -``` -Notifications should now show up as expected. - -Don't ever send any signals to `herbe` except these: -```shell -# same as pkill -SIGTERM herbe, terminates every running herbe process -$ pkill herbe - -$ pkill -SIGUSR1 herbe -$ pkill -SIGUSR2 herbe -``` -And you should be fine. That's all you really need to interact with `herbe`. - -## Installation -### Packages -[![Packaging status](https://repology.org/badge/vertical-allrepos/herbe.svg)](https://repology.org/project/herbe/versions) - -[OpenBSD patch](https://github.com/dudik/herbe/pull/4) - -[FreeBSD patch](https://github.com/dudik/herbe/pull/16) - -[Wayland port](https://github.com/muevoid/Wayherb) by [muevoid](https://github.com/muevoid) - -**Only the [herbe-git AUR package](https://aur.archlinux.org/packages/herbe-git/) is maintained by me.** - -### Dependencies -* X11 (Xlib) -* Xft - -The names of packages are different depending on which distribution you use. -For example, if you use [Void Linux](https://voidlinux.org/) you will have to install these dependencies: -```shell -sudo xbps-install base-devel libX11-devel libXft-devel -``` - -### Build -```shell -git clone https://github.com/dudik/herbe -cd herbe -sudo make install -``` -`make install` requires root privileges because it copies the resulting binary to `/usr/local/bin`. This makes `herbe` accessible globally. - -You can also use `make clean` to remove the binary from the build folder, `sudo make uninstall` to remove the binary from `/usr/local/bin` or just `make` to build the binary locally. - -## Configuration -herbe is configured at compile-time by editing `config.h`. Every option should be self-explanatory. There is no `height` option because height is determined by font size and text padding. - -[Xresources patch](https://github.com/dudik/herbe/pull/11) - -## Contribute -If you want to report a bug or you have a feature request, feel free to [open an issue](https://github.com/dudik/herbe/issues). - -## Projects with herbe integration -- [qutebrowser](https://qutebrowser.org/) supports showing web notifications via herbe, via the `content.notifications.presenter` setting. +call `dictpopup` to translate and display the popup of the selected text. +You can also use `popup` like `popup "Hello"` for other things. diff --git a/config.def.h b/config.def.h deleted file mode 100644 index 512e7c3..0000000 --- a/config.def.h +++ /dev/null @@ -1,19 +0,0 @@ -static const char *background_color = "#3e3e3e"; -static const char *border_color = "#ececec"; -static const char *font_color = "#ececec"; -static const char *font_pattern = "monospace:size=10"; -static const unsigned line_spacing = 5; -static const unsigned int padding = 15; - -static const unsigned int width = 450; -static const unsigned int border_size = 2; -unsigned int pos_x = 30; -unsigned int pos_y = 60; - -enum corners { TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT }; -enum corners corner = TOP_RIGHT; - -static const unsigned int duration = 5; /* in seconds */ - -#define DISMISS_BUTTON Button1 -#define ACTION_BUTTON Button3 diff --git a/config.h b/config.h index 750e40b..82d0d0f 100644 --- a/config.h +++ b/config.h @@ -1,6 +1,5 @@ static const char *background_color = "#2E3440"; static const char *border_color = "#ececec"; -/* static const char *border_color = "#ffffff"; */ static const char *font_color = "#ececec"; static const char *font_pattern = "Noto Sans Mono CJK JP:size=12"; static const unsigned line_spacing = 5; @@ -8,11 +7,6 @@ static const unsigned int padding = 15; static const unsigned int width = 450; static const unsigned int border_size = 1; -/* static const unsigned int pos_x = 30; */ -/* static const unsigned int pos_y = 60; */ - -enum corners { TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT }; -enum corners corner = TOP_RIGHT; static const unsigned int duration = 5; /* in seconds */ diff --git a/dictpopup b/dictpopup index de18aa6..3116507 100755 --- a/dictpopup +++ b/dictpopup @@ -2,4 +2,4 @@ SDCV_PAGER='less --quit-if-one-screen -RX' -xargs sdcv -n --utf8-output -e | tail -n +5 | sed 's| ||g' | xargs popup +xclip -o | xargs sdcv -n --utf8-output -e | tail -n +5 | sed 's| ||g' | xargs popup diff --git a/popup b/popup deleted file mode 100755 index cc4081f..0000000 Binary files a/popup and /dev/null differ diff --git a/popup.c b/popup.c index f748b47..1d31d11 100644 --- a/popup.c +++ b/popup.c @@ -167,12 +167,6 @@ int main(int argc, char *argv[]) unsigned int text_height = font->ascent - font->descent; unsigned int height = (num_of_lines - 1) * line_spacing + num_of_lines * text_height + 2 * padding; - /* if (corner == TOP_RIGHT || corner == BOTTOM_RIGHT) */ - /* x = screen_width - width - border_size * 2 - pos_x; */ - - /* if (corner == BOTTOM_LEFT || corner == BOTTOM_RIGHT) */ - /* y = screen_height - height - border_size * 2 - pos_y; */ - window = XCreateWindow(display, RootWindow(display, screen), x, y, width, height, border_size, DefaultDepth(display, screen), CopyFromParent, visual, CWOverrideRedirect | CWBackPixel | CWBorderPixel, &attributes);