diff --git a/CHANGELOG.md b/CHANGELOG.md index 2a69b5e..2e8ae4e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -# [NEXT] +# [6.3.0] - 2024-05-01 ## Changed - Only show recent characters from the same fileset. (#173) - Updates to Gitmoji and FontAwesome. @@ -7,7 +7,7 @@ - Finally added Kaomoji. (#162, #182) - Support for [tofi](https://github.com/philj56/tofi/), [bemenu](https://github.com/Cloudef/bemenu) and [wmenu](https://git.sr.ht/~adnano/wmenu) as selectors -# [6.2.0] +# [6.2.0] - 2023-09-16 ## Added - Support dmenu as selector. - Support `rofi`'s icons. @@ -16,7 +16,7 @@ - Updated to Unicode (including Emojis) v15.1. - Updates to Gitmoji, FontAwesome and NerdFonts. -# [6.1.0] +# [6.1.0] - 2022-12-27 ## Added - Support [fuzzel](https://codeberg.org/dnkl/fuzzel). - `~` is expanded for `--files`. (#136) @@ -31,7 +31,7 @@ - Fixed skin tone selection in rofi mode. (#143) - Fix version display. (#139) -# [6.0.0] +# [6.0.0] - 2022-11-01 ## Added - You can now select your desired actions through a separate menu. - Support for grid themes using `--hidden-descriptions` and [`contrib/grid.rasi`](https://github.com/fdw/rofimoji/blob/main/src/picker/contrib/grid.rasi). (#133) @@ -46,18 +46,18 @@ - NerdFonts are 2.2.2 - Gitmoji is 3.13.0 -# [5.6.0] +# [5.6.0] - 2022-09-17 ## Changed - Remove the unexpected and distracting empty checkboxes from rofi. (#127, #125) -# [5.5.0] +# [5.5.0] - 2022-07-17 ## Added - Gitmoji and Font Awesome 6 are now also included. (#114, #121) ## Fixed - Choosing whitespace does not break `rofimoji` anymore. (#117) -# [5.4.0] +# [5.4.0] - 2022-02-04 ## Added - `rofmoji`'s predefined characters now also contain all of CJK. - Default characters and descriptions can be extended with custom files. @@ -70,14 +70,14 @@ ## Fixed - The shortcut for `all` files can now be combined with custom files. (#101) -# [5.3.0] +# [5.3.0] - 2021-08-14 ## Added - Characters are now ordered according to their usage. (#74) ## Changed - Recently used characters are now also re-ordered on usage. (#97) -# [5.2.0] +# [5.2.0] - 2021-06-19 ## Added - The keybindings for direct actions are now configurable. (#84) - `rofimoji` is now also on [PyPI](https://pypi.org/project/rofimoji/) @@ -90,14 +90,14 @@ - The skin tone selection was calling `rofi` even if `wofi` was preferred. - `wofi` is now called with the correct arguments to work as expected now. (#89) -# [5.1.0] +# [5.1.0] - 2021-03-17 ## Added - There is a new `print` action to just print out the characters. (#75) ## Fixed - `xclip` is called correctly. (#79) -# [5.0.0] +# [5.0.0] - 2021-02-20 ## Added - `rofimoji` can now be called as a modus from rofi! (#44) - rofimoji now also works with [wofi](https://hg.sr.ht/~scoopta/wofi/). (#53) @@ -113,7 +113,7 @@ - The dependency on `pyxdg` was removed. - Some code cleanup. (#56, #58) -# [4.3.0] +# [4.3.0] - 2020-09-27 ## Added - Added support for Wayland! (#47) - Added support for `xclip`. (#21) @@ -123,25 +123,25 @@ - The order of the characters in all scripts is now the same as the official one. - All character data has been updated. -# [4.2.0] +# [4.2.0] - 2020-06-01 ## Added - The most recently characters are now shown in a separate strip and can be selected with shortcuts (`alt+1` etc). (#39) ## Fixed - Human emojis can now have their own skin tone even if they're part of a larger sequence. (#41) -# [4.1.1] +# [4.1.1] - 2020-03-23 ## Fixed - Whitespace characters can be inserted. -# [4.1.0] +# [4.1.0] - 2020-03-20 ## Changed - The extractors have been rewritten: There are now many, *many* supported symbols (all that Unicode offers), but some may have been renamed. ## Added - A new file for all kinds of maths symbols. -# [4.0.0] +# [4.0.0] - 2020-02-15 ## Changed - The new emojis from v13.0 are here! - `rofimoji` is now modular and has an actual `setup.py`, as the emojis are no longer part of the picker code. @@ -152,11 +152,11 @@ - There are now data files for all of Unicode's scripts. - A configuration can also be stored in `$XDG_CONFIG_HOME/rofimoji.rc`. -# [3.0.1] +# [3.0.1] - 2019-10-06 ## Fixed - A race condition with Firefox is now resolved (#23). -# [3.0.0] +# [3.0.0] - 2019-08-01 ## Added - You can choose a new input method: `rofimoji` can copy your emojis, paste them into the application and restore the previous contents. - There are now more keywords included so you can find the appropriate emoji more easily. @@ -164,17 +164,17 @@ - You can pass arguments to rofi using `--rofi-args`. - And you can use alternative emoji lists when you provide the `--emoji-file` parameter. -# [2.1.0] +# [2.1.0] - 2019-02-09 ## Changed - This release is based on the emoji v12, including all these: https://unicode.org/emoji/charts/emoji-versions.html#2019 . - Renamed meta files to upper case for better visibility. - Updated dev dependencies to new versions. -# [2.0.1] +# [2.0.1] - 2019-01-25 ## Fixed - Fix bug when trying to copy multiple emojis. (#6) -# [2.0.0] +# [2.0.0] - 2019-01-11 ## Changed - Download emoji list from https://unicode.org/emoji/charts-11.0/full-emoji-list.html instead of emojipedia, as that one didn't work at all anymore. - Skin color selection is now a second step after certain ("human") emojis. Only the neutral version is included in the main list, which accordingly is a lot smaller now. diff --git a/pyproject.toml b/pyproject.toml index af0c48e..506bd1b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "rofimoji" -version = "6.3.0-alpha" +version = "6.3.0" description = "Simple character picker using rofi" authors = ["Fabian Winter <5821180+fdw@users.noreply.github.com>"] license = "MIT" diff --git a/src/picker/docs/rofimoji.1 b/src/picker/docs/rofimoji.1 index c86fae4..d2063ae 100644 --- a/src/picker/docs/rofimoji.1 +++ b/src/picker/docs/rofimoji.1 @@ -1,34 +1,36 @@ -.\" Automatically generated by Pandoc 3.1.8 +.\" Automatically generated by Pandoc 3.1.12.2 .\" -.TH "ROFIMOJI" "1" "September 16, 2023" "Version 6.2.0" "Rofi Third-party Add-on Documentation" +.TH "ROFIMOJI" "1" "May 01, 2024" "Version 6.3.0" "Rofi Third\-party Add\-on Documentation" .SH NAME -\f[B]rofimoji\f[R] - A character (emoji) picker for rofi +\f[B]rofimoji\f[R] \- An emoji and general character picker for rofi and +rofi\-likes .SH SYNOPSIS .PP -\f[B]rofimoji\f[R] [\f[B]-h\f[R]] [\f[B]--version\f[R]] -[\f[B]--action\f[R] -{\f[I]type\f[R],\f[I]copy\f[R],\f[I]clipboard\f[R],\f[I]unicode\f[R],\f[I]copy-unicode\f[R],\f[I]print\f[R],\f[I]menu\f[R]}] -[\f[B]--skin-tone\f[R] -{\f[I]neutral\f[R],\f[I]light\f[R],\f[I]medium-light\f[R],\f[I]moderate\f[R],\f[I]dark -brown\f[R],\f[I]black\f[R],\f[I]ask\f[R]}] [\f[B]--files\f[R] +\f[B]rofimoji\f[R] [\f[B]\-h\f[R]] [\f[B]\-\-version\f[R]] +[\f[B]\-\-action\f[R] +{\f[I]type\f[R],\f[I]copy\f[R],\f[I]clipboard\f[R],\f[I]unicode\f[R],\f[I]copy\-unicode\f[R],\f[I]print\f[R],\f[I]menu\f[R]}] +[\f[B]\-\-skin\-tone\f[R] +{\f[I]neutral\f[R],\f[I]light\f[R],\f[I]medium\-light\f[R],\f[I]moderate\f[R],\f[I]dark +brown\f[R],\f[I]black\f[R],\f[I]ask\f[R]}] [\f[B]\-\-files\f[R] {\f[I]all\f[R],\f[I]FILE\f[R] [\f[I]FILE\f[R] \&...]]} -[\f[B]--prompt\f[R] \f[I]PROMPT\f[R]] [\f[B]--selector-args\f[R] -\f[I]SELECTOR_ARGS\f[R]] [\f[B]--max-recent\f[R] \f[I]MAX_RECENT\f[R]] -[\f[B]--no-frecency\f[R]] [\f[B]--hidden-descriptions\f[R]] -[\f[B]--clipboarder\f[R] \f[I]CLIPBOARDER\f[R]] [\f[B]--typer\f[R] -\f[I]TYPER\f[R]] [\f[B]--selector\f[R] \f[I]SELECTOR\f[R]] +[\f[B]\-\-prompt\f[R] \f[I]PROMPT\f[R]] [\f[B]\-\-selector\-args\f[R] +\f[I]SELECTOR_ARGS\f[R]] [\f[B]\-\-max\-recent\f[R] +\f[I]MAX_RECENT\f[R]] [\f[B]\-\-no\-frecency\f[R]] +[\f[B]\-\-hidden\-descriptions\f[R]] [\f[B]\-\-clipboarder\f[R] +\f[I]CLIPBOARDER\f[R]] [\f[B]\-\-typer\f[R] \f[I]TYPER\f[R]] +[\f[B]\-\-selector\f[R] \f[I]SELECTOR\f[R]] .SH DESCRIPTION Select, insert, or copy Unicode characters like emoji using rofi. .SH OPTIONS .TP --h, --help +\-h, \-\-help Prints brief usage information. .TP ---version +\-\-version show program\[cq]s version number and exit .TP ---action, -a -Possible values: type, copy, clipboard, unicode, copy-unicode, print, +\-\-action, \-a +Possible values: type, copy, clipboard, unicode, copy\-unicode, print, menu .RS .PP @@ -36,70 +38,77 @@ Choose what to do with the selected characters: Directly type them with the \[lq]Typer\[rq], copy them to the clipboard using the \[lq]Clipboarder\[rq], or insert them indirectly using the clipboard. \[lq]unicode\[rq] will type the unicode codepoints of the chosen -characters, \[lq]copy-unicode\[rq] will copy it. +characters, \[lq]copy\-unicode\[rq] will copy it. \[lq]print\[rq] just outputs them on stdout. If you want to decide on the fly, use \[lq]menu\[rq]. .RE .TP ---skin-tone=\f[I]skin-tone\f[R], -s \f[I]skin-tone\f[R] -Possible values: neutral, light, medium-light, moderate, dark brown, -black, ask -.RS -.PP -Decide on a skin-tone for all supported emojis. -If not set (or set to \[lq]ask\[rq]), you will be asked for each one -.RE -.TP ---files \f[I]FILE\f[R] [\f[I]FILE\f[R] \&...], -f \f[I]FILE\f[R] [\f[I]FILE\f[R] \&...] +\-\-files \f[I]FILE\f[R] [\f[I]FILE\f[R] \&...], \-f \f[I]FILE\f[R] [\f[I]FILE\f[R] \&...] Read characters from this file (or these files), one entry per line. Absolute and relative paths are supported, as is globbing -(\f[CR]--files /home/you/characters.csv ../other*.csv\f[R]). +(\f[CR]\-\-files /home/you/characters.csv ../other*.csv\f[R]). A filename without extension is enough -(\f[CR]--files musical_symbols supplemental_arrows\f[R]) for included +(\f[CR]\-\-files musical_symbols supplemental_arrows\f[R]) for included character files and all in \f[CR]${XDG_DATA_HOME}/rofimoji/data\f[R]. Here, too, globbing is supported and done by default. In the config file, several files need to be listed as \f[CR]files=[_FILE_, _FILE_]\f[R]. .TP ---prompt \f[I]PROMPT\f[R], -r \f[I]PROMPT\f[R] -Set rofimoji\[cq]s prompt -.TP ---selector-args \f[I]SELECTOR-ARGS\f[R] -A string of arguments to give to the selector. +\-\-skin\-tone=\f[I]skin\-tone\f[R], \-s \f[I]skin\-tone\f[R] +Possible values: neutral, light, medium\-light, moderate, dark brown, +black, ask +.RS +.PP +Decide on a skin\-tone for all supported emojis. +If not set (or set to \[lq]ask\[rq]), you will be asked for each one +.RE .TP ---max-recent \f[I]MAX-RECENT\f[R] +\-\-max\-recent \f[I]MAX\-RECENT\f[R] Show at most this number of recently used characters (cannot be larger than 10) .TP ---no-frecency +\-\-no\-frecency Don\[cq]t show frequently used characters at the start. .TP ---hidden-descriptions +\-\-hidden\-descriptions Only list the characters, but not their description. Note that you can still search through the descriptions. +Only used for \f[CR]rofi\f[R]. .TP ---clipboarder \f[I]CLIPBOARDER\f[R] -Possible values: xsel, xclip, wl-copy +\-\-use\-icons +Show characters as icons on \f[CR]rofi\f[R]. +Not used with other selectors. +.TP +\-\-prompt \f[I]PROMPT\f[R], \-r \f[I]PROMPT\f[R] +Set rofimoji\[cq]s prompt +.TP +\-\-selector\-args \f[I]SELECTOR\-ARGS\f[R] +A string of arguments to give to the selector. +.TP +\-\-selector \f[I]SELECTOR\f[R] +Possible values: rofi, wofi, fuzzel, dmenu, tofi, bemenu, wmenu .RS .PP -Choose the application to access the clipboard with manually. +Choose the selector application manually. +Usually \f[CR]rofi\f[R], but you may want something else. .RE .TP ---typer \f[I]TYPER\f[R] -Possible values: xdotool, wtype +\-\-clipboarder \f[I]CLIPBOARDER\f[R] +Possible values: xsel, xclip, wl\-copy .RS .PP -Choose the application to type with manually. +Choose the application to access the clipboard with manually. .RE .TP ---selector \f[I]SELECTOR\f[R] -Possible values: rofi, wofi, fuzzel, dmenu +\-\-typer \f[I]TYPER\f[R] +Possible values: xdotool, wtype .RS .PP -Choose the selector application manually. -Usually \f[CR]rofi\f[R], but for Wayland, you may want \f[CR]wofi\f[R] -or \f[CR]fuzzel\f[R]. +Choose the application to type with manually. .RE +.TP +\-\-keybinding\-copy, \-\-keybinding\-type, \-\-keybinding\-clipboard, \-\-keybinding\-unicode, \-\-keybinding\-copy\-unicode +Define different keybindings for these actions. .SH KEYBINDINGS (optional) Select multiple emoji with shift+enter .PP @@ -123,9 +132,9 @@ Please note that wofi does not support keybindings other than .SH FILES .TP \f[I]\[ti]/.config/rofimoji.rc\f[R] -Per-user configuration file. +Per\-user configuration file. .TP -\f[I]/etc/xdg/xdg-i3/rofimoji.rc\f[R] +\f[I]/etc/xdg/xdg\-i3/rofimoji.rc\f[R] Global configuration file. .TP \f[I]\[ti]/.local/share/rofimoji/recent\f[R] @@ -135,12 +144,12 @@ Stores the recently used characters Contains additional characters or additional descriptions for the character set in \f[B]filename\f[R] .SH CONFIGURATION -Args that start with \[lq]--\[rq] (eg. ---version) can also be set in a config file. +Args that start with \[lq]\-\-\[rq] (eg. +\-\-version) can also be set in a config file. .PP Config file syntax allows: key=value, flag=true, stuff=[a,b,c] (for details, see syntax at -https://github.com/fdw/rofimoji#example-config-file). +https://github.com/fdw/rofimoji#example\-config\-file). If an arg is specified in more than one place, then commandline values override values from the config file. .SH WEBSITE diff --git a/src/picker/docs/rofimoji.1.md b/src/picker/docs/rofimoji.1.md index a44cabc..ccb06d0 100644 --- a/src/picker/docs/rofimoji.1.md +++ b/src/picker/docs/rofimoji.1.md @@ -1,6 +1,6 @@ -% ROFIMOJI(1) Version 6.2.0 | Rofi Third-party Add-on Documentation +% ROFIMOJI(1) Version 6.3.0 | Rofi Third-party Add-on Documentation % Fabian Winter -% April 27, 2024 +% May 01, 2024 # NAME