Differences between revisions 1 and 7 (spanning 6 versions)
Revision 1 as of 2016-11-10 16:00:23
Size: 48
Editor: TheAnarcat
Comment:
Revision 7 as of 2016-11-10 16:43:26
Size: 1786
Editor: TheAnarcat
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
#REDIRECT [[Services/Debian manpages archive]] https://manpages.debian.org/ is a service providing online manpages in HTML format for the public.

= Current status =

See [[Services/Debian manpages archive]] for the [[Services]] survey page.

= Possible implementations =

There are three known implementations of "man to web" archive generators.

== Current codebase ==

The [[https://anonscm.debian.org/viewvc/ddp/man-cgi/|current codebase]] is a set of Perl and bash CGI scripts that dynamically generate (and search through) manpages.

== Ubuntu ==

Ubuntu has their own manpage repository at https://manpages.ubuntu.com/. Their [[https://code.launchpad.net/ubuntu-manpage-repository|codebase]] is partly Python, Perl and Bash.

== New codebase ==

A new codebase written by dgilman is available in [[https://github.com/dgilman/manpages|github]]. It is a simple Python script with a sqlite backend.

== MVP ==

The Minimum Viable Product for this project is a service that creates an HTML version of all the manpages of all the packages available in Debian, for all supported suites (including [[LTS]]).

`apropos(1)` functionality is considered extra that can be implemented later with already indexing tools like Xapian (or the web frontend, Omega), Lucene / Solr, Elastic search, or a simple homegrown javascript-based search (like readthedocs uses).

= Hardware =

The old service used to run on `glinka.debian.org`. [[Teams/DSA]] requested the service should be moved to `manziarly.debian.org`.

= Forum =

Discussions about manpages.debian.org can take place on the regular [[Teams/DDP]] channels, for example the `#debian-doc` IRC channel and `debian-doc@lists.debian.org` mailing list.

You can also subscribe to this wiki page to get updates, which also functions as a ad-hoc forum.

https://manpages.debian.org/ is a service providing online manpages in HTML format for the public.

Current status

See Services/Debian manpages archive for the Services survey page.

Possible implementations

There are three known implementations of "man to web" archive generators.

Current codebase

The current codebase is a set of Perl and bash CGI scripts that dynamically generate (and search through) manpages.

Ubuntu

Ubuntu has their own manpage repository at https://manpages.ubuntu.com/. Their codebase is partly Python, Perl and Bash.

New codebase

A new codebase written by dgilman is available in github. It is a simple Python script with a sqlite backend.

MVP

The Minimum Viable Product for this project is a service that creates an HTML version of all the manpages of all the packages available in Debian, for all supported suites (including LTS).

apropos(1) functionality is considered extra that can be implemented later with already indexing tools like Xapian (or the web frontend, Omega), Lucene / Solr, Elastic search, or a simple homegrown javascript-based search (like readthedocs uses).

Hardware

The old service used to run on glinka.debian.org. Teams/DSA requested the service should be moved to manziarly.debian.org.

Forum

Discussions about manpages.debian.org can take place on the regular Teams/DDP channels, for example the #debian-doc IRC channel and debian-doc@lists.debian.org mailing list.

You can also subscribe to this wiki page to get updates, which also functions as a ad-hoc forum.