| 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 <2022> 2023 2024 2025 | Index | 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 <2022> 2023 2024 2025 |
| <== Date ==> | <== Thread ==> |
|---|
| Subject: | Re: Manpages for PVA Command Line Tools |
| From: | Michael Davidsaver via Core-talk <core-talk at aps.anl.gov> |
| To: | "Daykin, Evan" <daykin at frib.msu.edu> |
| Cc: | "core-talk at aps.anl.gov" <core-talk at aps.anl.gov> |
| Date: | Thu, 1 Dec 2022 13:14:17 -0800 |
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