Repository files navigation

Perldoc Browser

Perldoc Browser requires at least Perl v5.20.0 and may have other requirements if you enable a search backend. Perl dependencies are listed incpanfile. To install them, use cpanm:

cpanm --installdeps . # no search dependenciescpanm --installdeps --with-feature=install . # for install commandcpanm --installdeps --with-feature=pg .cpanm --installdeps --with-feature=es .cpanm --installdeps --with-feature=sqlite .cpanm --installdeps --with-all-features .

Perldoc Browser is configured byperldoc-browser.conf in the application directory. The configuration file is a Perl hash. Thehypnotoad key will be used to configureHypnotoad if it is used to start the web application.

The search backend can be set using thesearch_backend key. Recognized values arepg,es,sqlite, andnone (default: disables the search and indexing).

Thepg backend requiresMojo::Pg and a PostgreSQL server running at least version 9.6. Thepg configuration key must be set to a database connection URL in the formpostgresql://user:password@host:port/database.

Thees backend requiresSearch::Elasticsearch and an Elasticsearch server running at least version 7.0. Thees configuration key may be set to the URL to connect to the server (defaults tohttp://localhost:9200).

Thesqlite backend requiresMojo::SQLite. The database is stored in the application home directory asperldoc-browser.sqlite by default. This may be configured by setting thesqlite configuration key to a file path, which must be an absolute path to a writable directory.

Perldoc Browser renders documentation from any Perls it finds installed in the configuredperls_dir, which defaults toperls in the application directory. If no Perls are found here, it will display documentation for the Perl interpreter currently in use. Theinstall command can be used to usePerl::Build to install one or more Perls to this directory.

./perldoc-browser.pl install 5.10.1 5.28.0

Once a search backend is enabled, Perls must be indexed in this backend for contents of documents and document/function/variable names to be available to the search. Theindex command will index or reindex the contents and names of one or more Perls.

./perldoc-browser.pl index 5.10.1 5.28.0./perldoc-browser.pl index all # reindexes all Perls found in perls_dir

Dan Book <dbook@cpan.org>

PerldocBrowser::Plugin::PerldocRenderer is a fork of theMojolicious team'sPODRenderer plugin and its associated template.

This software is Copyright (c) 2018 by Dan Book <dbook@cpan.org>.

PerldocBrowser::Plugin::PerldocRenderer is Copyright (c) 2008-2018 Sebastian Riedel and others, 2018 Dan Book <dbook@cpan.org>.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)

Bundled Perl Camel Logo is Copyright (c) 2024 Olaf Alders, licensed under the CC-BY License, Version 4.0https://creativecommons.org/licenses/by/4.0/.

Bundled Bootstrap theme is Copyright (c) 2011-2025 The Bootstrap Authors, licensed under the MIT licensehttps://opensource.org/license/mit.

Bundled highlight.pack.js is Copyright (c) 2006-2024 Josh Goebel <hello@joshgoebel.com> and other contributors, licensed under the (three-clause) BSD Licensehttps://opensource.org/license/BSD-3-Clause.

Bundled StackOverflow Light highlight theme is Copyright (c) Stack Exchange, Inc, licensed under the MIT Licensehttps://opensource.org/license/mit.