Bug#984753: towncrier: Manual page needed for 'towncrier(1)'
Thanks for the tips and the links, they helped a lot. I created a merge request [1] for your repository with the manpage and forwarded it to upstream [2]. [1]: https://salsa.debian.org/bignose/pkg-towncrier/-/merge_requests/1 [2]: https://github.com/twisted/towncrier/pull/326 -- Sérgio Cipriano
Bug#984753: towncrier: Manual page needed for 'towncrier(1)'
On 08-Mar-2021, Ben Finney wrote: > We need to obtain (or write) a manual page to install as ‘towncrier(1)’. The absence of a proper Unix manual page for ‘towncrier(1)’ is a bug upstream. We will likely need to write the manual page ourselves. The content will contain much of the same information from the command's help output, but needs to also properly populate all the typical sections of a Unix manual page; see the manual page ‘man(1)’. -- \“The priesthood have, in all ancient nations, nearly | `\ monopolized learning.” —John Adams, _Letters to John Taylor_, | _o__) 1814 | Ben Finney signature.asc Description: PGP signature
Bug#984753: Writing a manual page in ‘roff’ markup (was: Bug#984753: towncrier: Manual page needed for 'towncrier(1)')
Control: owner -1 Sérgio Cipriano Thanks to Sergio for accepting ownership of this bug report. On 08-Mar-2021, Ben Finney wrote: > We need to obtain (or write) a manual page to install as ‘towncrier(1)’. For writing a manual page, I recommend reading about the archaic markup language “roff” and how to write it effectively. https://linuxconfig.org/writing-manual-pages-on-linux> This markup language has significant downsides: It is comparatively old and there are much better markup languages today; and it is used for almost nothing else but Unix manual pages. So it is often tempting to write a manual page in some other markup language and convert that to roff. I advise against that, though, for two reasons. One: The Unix manual system is very well integrated with the specifics of roff markup. No modern popular markup language has these specific quirks, and it can be very annoying to write well-formatted manual pages in any other markup language. Two: Though roff is quirky and has questionable design choices, it is quite easy to learn and use, within the limitations of a Unix manual page. Bonus third reason: There are good examples of manual pages written directly in roff, that you can crib from when writing a new one. I offer as an example, the three manual pages included in the Debian ‘dput’ package. Get their source code, see the ‘doc/man/’ directory for the manual page source files. -- \ “Don't worry about what anybody else is going to do. The best | `\ way to predict the future is to invent it.” —Alan Kay | _o__) | Ben Finney signature.asc Description: PGP signature
Bug#984753: towncrier: Manual page needed for 'towncrier(1)'
Package: towncrier Version: 19.2.0-1 Severity: minor Tags: newcomer upstream The package installs a command ‘towncrier’ without a corresponding manual page. We need to obtain (or write) a manual page to install as ‘towncrier(1)’. -- \“The Bermuda Triangle got tired of warm weather. It moved to | `\ Alaska. Now Santa Claus is missing.” —Steven Wright | _o__) | Ben Finney
