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

v1.0.0 package structure doesn't work for MANPATH #284

Open
coolaj86 opened this issue Nov 25, 2023 · 0 comments
Open

v1.0.0 package structure doesn't work for MANPATH #284

coolaj86 opened this issue Nov 25, 2023 · 0 comments

Comments

@coolaj86
Copy link

coolaj86 commented Nov 25, 2023

MANPATH is built automatically from PATH and it requires that the man file be in ../share/man relative to ./bin/sd.

So the package structure should look something like this to be POSIX compatible:

./sd-<triplet>/
./
├── CHANGELOG.md
├── LICENSE
├── README.md
├── bin/
│   └── sd*
├── completions/
│   ├── _sd
│   ├── _sd.ps1
│   ├── sd.bash
│   ├── sd.elv
│   └── sd.fish
└── share/
    └── man/
        └── man1/
            └── sd.1

Then just by moving the package to ~/.local/opt/sd and adding ~/.local/opt/sd/bin to PATH, the man page will Just Work™ as expected on any POSIX system.

Fish completions are actually generated automatically on-the-fly from the man page so long as it's well-formed and in the MANPATH (though pregenerating them may be better).

As for the others, I don't think Bash completions follow the POSIX standards. Probably not PS1 either. I'm not familiar with elv.

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