trurl.md: the manpage in markdown #337
Conversation
Switch format for the main manpage to markdown for convenience - make it easier to work with. This version can be converted to an nroff manpage using the cd2nroff script in the curl repository.
|
This also makes it much easier to browse the documentation directly on GitHub. |
| trurl returns a non-zero exit code to indicate problems. | ||
| .IP 1 | ||
|
|
||
| ## 1 |
There was a problem hiding this comment.
These headings seem really big for the amount of text associated with them
Especially compared with the manpage
There was a problem hiding this comment.
markdown is somewhat limited in what kind of formatting it offers. This is the best mapping I have managed to make. The format is tuned so that the tool can generate a fine manpage from it.
There was a problem hiding this comment.
Okay, that makes sense.
|
The web version of the manpage is now rendered from the markdown. |
|
hi, im looking into packaging the latest version for debian and this makes it a little hard for me. Would it possible for further releases to ship the manpage pre-rendered or are there other tools i could use to get decent output (i tried with go-md2man which is in debian, but the result is bad) |
|
Yes. When I changed the format I figured this would become something people will want. A fair request I think. I will make sure to render an nroff version of the manpage and generate a tarball with that file inside in future trurl releases. If you want a "quick fix" for right now, the nroff converted version of trurl.md is available at https://curl.se/trurl/trurl.1 |
thank you, that would really ease up things for package maintainers. |
Switch format for the main manpage to markdown for convenience - make it easier to work with.
This version can be converted to an nroff manpage using the cd2nroff script in the curl repository.