📖 Update README for new state directory
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful

This commit is contained in:
Marty Oehme 2022-10-12 17:04:37 +02:00
parent 250fb36146
commit 525a379564
Signed by: Marty
GPG key ID: 73BA40D5AFAF49C9

View file

@ -144,14 +144,14 @@ If you don't wish those to show up, make use of these options.
### Setting custom directories ### Setting custom directories
By default bemoji stores your recent history in `$XDG_CACHE_HOME/bemoji-history.txt`, By default bemoji stores your recent history in `$XDG_STATE_HOME/bemoji-history.txt`,
so most often in `~/.cache/bemoji-history.txt` so most often in `~/.local/state/bemoji-history.txt`
You can overwrite the directories bemoji uses for its emoji lists and history files with the following two environment variables: You can overwrite the directories bemoji uses for its emoji lists and history files with the following two environment variables:
``` ```
BEMOJI_DB_LOCATION=/path/to/my/emoji/directory BEMOJI_DB_LOCATION=/path/to/my/emoji/directory
BEMOJI_CACHE_LOCATION=/path/to/my/cache/directory BEMOJI_CACHE_LOCATION=/path/to/my/state/directory
``` ```
There are no equivalent commandline arguments to overwrite these two settings. There are no equivalent commandline arguments to overwrite these two settings.
@ -241,7 +241,7 @@ with their default settings
```bash ```bash
BEMOJI_DB_LOCATION=$XDG_DATA_HOME/bemoji # where the emoji lists reside BEMOJI_DB_LOCATION=$XDG_DATA_HOME/bemoji # where the emoji lists reside
BEMOJI_CACHE_LOCATION=$XDG_CACHE_HOME # where the cache file resides BEMOJI_CACHE_LOCATION=$XDG_STATE_HOME # where the state file resides
BEMOJI_CUSTOM_LIST="" # the custom emoji list to display BEMOJI_CUSTOM_LIST="" # the custom emoji list to display
BEMOJI_DOWNLOAD_LIST="" # the default emoji lists to download to database BEMOJI_DOWNLOAD_LIST="" # the default emoji lists to download to database
BEMOJI_DEFAULT_COMMAND=<clip-tool> # which command to invoke by default BEMOJI_DEFAULT_COMMAND=<clip-tool> # which command to invoke by default