willdurand/pman

pear-doc.php.net/pman on Composer/Packagist

pman

This package provides pman, the PHP manual in *nix style man pages, via Composer and Packagist., _(*1)

Installation

1) This package SHOULD be installed globally:, _(*2)

composer global require willdurand/pman:dev-master

2) Then, add $COMPOSER_BIN_DIR to your $PATH., _(*3)

$COMPOSER_BIN_DIR is often ~/.composer/vendor/bin, but it may be different depending on your operating system or configuration. Also, it is important to use such a path and not directly, .composer/vendor/bin., _(*4)

Usage

1) First, you have to fetch the documentation. This can be done time to time or only once, but it MUST be run at least once., _(*5)

sync-pman

This script relies on Docker. In case you want to clear Docker's cache, you can pass the --no-cache option to this script:, _(*6)

sync-pman --no-cache

2) Run pman to display documentation (like you would do with man):, _(*7)

pman strlen

Why?

I stumbled upon this article (and a few others as well), explaining how to leverage K command in vim. I decided to use this command rather than my plain old way to display PHP manual entries., _(*8)

I don't use PEAR on my system, that is why I relied on Docker to fetch the PEAR package. Also, adding a script to fetch (and synchronize) the documentation rather than versioning all the files (as done here) seemed better to me., _(*9)

License

(willdurand's) pman is released under the MIT License. See the bundled LICENSE file for details. Note that pman, the original package from PEAR, has its own license., _(*10)