RE: Manpages for PVA Command Line Tools

["Daykin, Evan via Core-talk" <core-talk at aps.anl.gov>]

Thanks, Michael. I'll get to working on them, hopefully without directly touching nroff.  I can send them along if you'd like.

-Evan

-----Original Message-----
From: Michael Davidsaver <mdavidsaver at gmail.com> 
Sent: Thursday, December 1, 2022 4:14 PM
To: Daykin, Evan <daykin at frib.msu.edu>
Cc: core-talk at aps.anl.gov
Subject: Re: Manpages for PVA Command Line Tools

[EXTERNAL] This email originated from outside of FRIB

On 12/1/22 05:58, Daykin, Evan via Core-talk wrote:
> Hi Core-Talk,
> 
> Are there any pre-existing manpages (in roff format) for pvlist, pvput, pvget, pvmonitor, pvinfo, softIocPVA and p2p? If not, I was going to make them.

Not that I know of.

Based on my experience with manpages for ca* [1], I would suggest not investing a huge amount of time into learning nroff markup.
There are a number of tools which take in some other text markup format, and output nroff.

(if you do, fyi. "man ./some.1" is a quick way to test changes)

I used to use asciidoc for this, but there may be better options now.  Maybe something with markdown? [2]

I also recall finding a tool which tried to massage the output of eg. "caget -h" into nroff.  However, I can find the name just now.

[1] https://github.com/epicsdeb/epics-base/tree/master/debian/man

[2] https://rtomayko.github.io/ronn/ronn.1.html