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.

Sign up for GitHub

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

Jump to bottom

Make nix-bitcoin options more discoverable #301

Open
jonasnick opened this issue Jan 17, 2021 · 3 comments · May be fixed by #352
Open

Make nix-bitcoin options more discoverable #301

jonasnick opened this issue Jan 17, 2021 · 3 comments · May be fixed by #352
Milestone
0.1.0

Comments

@jonasnick
Copy link
Member

Nix-bitcoin should provide an options manpage similar to man configuration.nix. Ideally, it would also work in the examples nix-shell.
@jonasnick jonasnick added this to the 0.1.0 milestone Jan 31, 2021
@nixbitcoin
Copy link
Member

@erikarvstedt In #293 (comment) you wrote:

It's relatively simple to make a man nix-bitcoin that shows all nix-bitcoin options in the same format as man configuration.nix.

Did you have in mind how to do it back then? I'm thinking about running nixos-option on all our options in a container, and then automatically formatting the result to a manpage.

@mmilata
Copy link
Contributor

mmilata commented Apr 12, 2021

Looks like it might be possible to reuse home-manager's code for generating docs, it even lives in a separate repo: https://gitlab.com/rycee/nmd

@nixbitcoin nixbitcoin linked a pull request Apr 12, 2021 that will close this issue
Open
@nixbitcoin
Copy link
Member

This has at least been partially fixed by #429 and will finally be closed by #352

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
0.1.0
Development

Successfully merging a pull request may close this issue.

wip: manpage nixbitcoin/nix-bitcoin
3 participants
@mmilata @jonasnick @nixbitcoin