-
-
Notifications
You must be signed in to change notification settings - Fork 283
Add a man page #35
Copy link
Copy link
Closed
Labels
feature/requestNew feature or requestNew feature or requesthelp wantedExtra attention is neededExtra attention is needed
Description
Is your feature request related to a problem? Please describe.
A man page should be added to the project for accessing the documentation using man(1):
$ man git-cliffDescribe the solution you'd like
Add a man page under docs/ in the root directory of the project. It should contain information about the command line arguments, configuration file sections/fields and the basic usage.
There are 2 possible ways that I can think of to achieve this:
- Add the markdown representation of a man page (for readability) and use a 3rd party tool for conversion.
- Add the groff file
docs/git-cliff.1help2man(1)can be used for assistance.
Describe alternatives you've considered
None.
Additional context
None.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
feature/requestNew feature or requestNew feature or requesthelp wantedExtra attention is neededExtra attention is needed