Skip to content

Provide manpages #806

@toastal

Description

@toastal

Is your feature request related to a problem? Please describe.

I just went to install/run the latest Topiary after being on v3.x from Nixpkgs & my configuration @ .topiary is not working. Naturally, I went to man topiary with no return. topiary --help clued me on a TOPIARY_CONFIG_FILE env variable, however, without a manpage I couldn’t figure out what values I needed. This isn’t an ideal UX.

Describe the solution you'd like

Ship both a manpage for the CLI tool, but also another for the configuration so it can be read separately. I personally use rst2man from Docutils, but any tool (or manually writing) can work. In some ways Nickel’s | doc … can self-document, but there are no docs & it isn’t exposed to the user in a digestible format.

Describe alternatives you've considered

Use w3m in another split to look up the documentation… but this will require internet.

1

Footnotes

  1. Please consider giving up MS GitHub or offering a non-proprietary, non-US-corporate-controlled mirror for this free software project. I wish to delete this Microsoft account in the future, but I need more projects like this to support alternative methods to send patches & contribute.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions