Bug#1054001: ITP: libapp-sdview-perl -- terminal document viewer for POD and other syntaxes
Package: wnpp
Severity: wishlist
Owner: Ole Peder Brandtzæg <olebra@samfundet.no>
X-Debbugs-Cc: debian-devel@lists.debian.org
* Package name : libapp-sdview-perl
Version : 0.13
Upstream Author : Paul Evans <leonerd@leonerd.org.uk>
* URL : https://metacpan.org/dist/App-sdview
* License : Perl 5
Programming Lang: Perl
Description : terminal document viewer for POD and other syntaxes
The App::sdview module implements a terminal-based program for viewing
structured documents. It currently understands POD, some simple Markdown
formatting, and a basic understanding of nroff (for manpages). The
accompanying sdview script runs the App::sdview program, which renders a
structured document to a terminal output, via the less pager.
Why is this package useful/relevant?
====================================
I've found reading the documentation of various Perl modules using
sdview to be a very pleasant experience. Obviously, perldoc already
exists for this purpose, but the syntax highlighting sdview offers makes
for a much better reading experience in my opinion.
As the description notes, the support for manpages is quite rudimentary;
in my testing, the manpage for ls renders fine, whereas the manpage of
man itself does not:
⚘ ~ sdview man
Expected (?^u:\
) in /usr/share/man/man1/man.1.gz on line 1 at:
'\" t
^
I'm not sure if the package including such unstable features is a
blocker for packaging it; apologies for the noise if so. However, I
believe its POD support is the main selling point.
How do you plan to maintain it?
===============================
This would be my first Debian package, so I would need a sponsor (and
most likely a bit of mentoring). The Debian Perl Group seems to be a
natural fit for the package, but I would be happy to maintain it on my
own or co-maintain it with them/anyone else.
libapp-sdview-perl does depend on a few other modules (all by the same
upstream author) not presently packaged in Debian, so they would need to
be packaged, too, but I figured I should file this first. They are:
- Object::Pad::FieldAttr::Checked [0]
- Parse::Man [1]
- String::Tagged::Markdown [2]
All the best,
Ole
[0]: https://metacpan.org/dist/Object-Pad-FieldAttr-Checked
[1]: https://metacpan.org/dist/Parse-Man
[2]: https://metacpan.org/dist/String-Tagged-Markdown
Reply to: