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

borgfs in Standalone Binary Installation Docs #8207

Open
gitspeaks opened this issue May 10, 2024 · 2 comments
Open

borgfs in Standalone Binary Installation Docs #8207

gitspeaks opened this issue May 10, 2024 · 2 comments

Comments

@gitspeaks
Copy link

I noticed a potential issue in the Standalone Binary installation section of the documentation where it suggests creating a symlink to make borgfs an alias for borg mount

Quote:

Optionally you can create a symlink to have borgfs available, which is an alias for borg mount:

ln -s /usr/local/bin/borg /usr/local/bin/borgfs

A symlink to borg will just replicate the borg command under a new name, borgfs, but does not restrict or modify its behavior to only execute borg mount.

The documentation might consider suggesting the use of a shell alias or a wrapper script instead.

For example:

alias borgfs='borg mount'
@ThomasWaldmann
Copy link
Member

Usually that works, borg internally detects the name by which it was invoked and then behaves differently.

Try:

  • the single file fat binary
  • the directory based fat binary
  • the normal borg package (e.g. via pip install borg or linux dist package)

If one or more of these does not behave like "borg mount" when invoked as borgfs, please add which of these exactly to your original bug report.

@gitspeaks
Copy link
Author

Thanks for the clarification! I've tested it and you're right, it works as expected. I suggest adding a note to the documentation explaining that Borg internally detects the name by which it was invoked and adjusts its behavior accordingly. This isn't immediately apparent, and such a note would help clarify why creating a symlink serves as a functional alias.

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

No branches or pull requests

2 participants