From: Ruud van der Pas <ruud.vanderpas@oracle.com>
To: "binutils@sourceware.org" <binutils@sourceware.org>
Subject: Support for help2man?
Date: Tue, 17 Jan 2023 22:12:08 +0000 [thread overview]
Message-ID: <D5758970-C0F2-47C7-8409-0E958267743C@oracle.com> (raw)
Hi team,
The creation of the gprofng man pages critically depends on
the help2man tool.
If it is not installed, the man pages will be empty. That in
itself is not good and easy to fix, but it is not the reason
for this question.
Currently, the other components use a .texi file to include special
text sections for the man page (e.g. @c man begin COPYRIGHT and
@c man end to enclose the copyright text).
Through texi2pod and pod2man, these text blocks are then transformed
into a man page.
We could do the same, but wonder how this group feels about
endorsing help2man as an alternative to generate man pages?
It is rather limited, but gets the job done. It also does not
disrupt the current approach, but provides an alternative.
The advantage is that help2man uses the output from --help and
--version to dynamically generate the man page.
That means you "only" need to modify this printed output in case
there are changes at the option level, say. The man page will be up
to date automatically.
Thank you in advance for sharing your opinion!
Kind regards, Ruud
PS We currently use help2man 1.47.6 from 2017.
reply other threads:[~2023-01-17 22:12 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=D5758970-C0F2-47C7-8409-0E958267743C@oracle.com \
--to=ruud.vanderpas@oracle.com \
--cc=binutils@sourceware.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).