Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Enhancement: Include Information on BAT_CONFIG_DIR Environment Variable #2890

Open
redeye-fang opened this issue Mar 9, 2024 · 0 comments · May be fixed by #3098
Open

Documentation Enhancement: Include Information on BAT_CONFIG_DIR Environment Variable #2890

redeye-fang opened this issue Mar 9, 2024 · 0 comments · May be fixed by #3098
Labels
bug Something isn't working documentation

Comments

@redeye-fang
Copy link

About my request

After installing bat, through apt. I wanted to configure it to my liking, and I also manage all my dotfiles in a certain way. Thus I wanted to have a different path for the bat config file. I found the README.md to be quite descriptive about a lot of things. But when it came to changing the default config path, I was very confused. I'll highlight my findings:

  • The BAT_CONFIG_PATH environment variable just points to the config file path.
  • In this issue BAT_CONFIG_DIR not respected, despite CHANGELOG.md #1727 , I found a different environment variable called BAT_CONFIG_DIR, which as mentioned in the issue's comments, loads themes and other data required to be fetched.

I expected the documentation to include information about the BAT_CONFIG_DIR environment variable, explaining how it can be used to specify a custom configuration directory for Bat. So, I felt the need to write this issue regarding the lack of information on BAT_CONFIG_DIR, as I am sure others must have fiddled with the same issue. I might be wrong too. So, let me know if there is something I have misunderstood about customizing the default config directory that doesn't have me setting BAT_CONFIG_DIR.


What steps will reproduce the bug?

N/A - This is a documentation enhancement request.

bat Installation method

Run Raspberry Pi OS 64bit, and since it's Debian-based, used apt to install bat.

apt install bat

Environment Variables set

To get my setup with a custom config file directory with a different theme working. These are the environment variables I had set in my .zshenv.

# bat
export BAT_CONFIG_PATH=$HOME/.bat/bat.conf # Bat Config Path location
export BAT_CONFIG_DIR="$HOME/.bat" # Bat Config Directory

bat version and environment

Since this issue pertains to documentation, the environment, and version are not directly related.
But, I run bat version 0.22.1

@redeye-fang redeye-fang added the bug Something isn't working label Mar 9, 2024
@adamperkowski adamperkowski linked a pull request Oct 6, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants