Skip to content

some distributions use "batcat" for the executable so code examples in documentation don't work #3295

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

Open
dandrake opened this issue May 15, 2025 · 0 comments

Comments

@dandrake
Copy link

There are lots of great code examples in the documentation here, but they use "bat" for the executable name. But some Linux distributions (Debian and Ubuntu, at least) use "batcat" for the executable name -- which means you can't blindly copy and paste the code. And it's confusing when you do -- a user might say "huh? Why is the command not found? I just installed the 'bat' package!?

The documentation should at least mention that users may need to use "batcat" instead of "bat".

And since many users will dive straight to a code snippet and copy right from there -- without reading anything else -- perhaps every the code examples could all have a comment about possibly needing "batcat". But that would be awkward, despite its usefulness.

@dandrake
Copy link
Author

Hrm, now I see some other related issues. So I guess this is a sort of duplicate? Although the fact that I tripped over it does say something about how users can blindly copy and paste and get a bit confused...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant