willdurand/pman

此包已废弃，不再维护。未建议替代包。

pear-doc.php.net/pman 在 Composer/Packagist 上

维护者

详情

github.com/willdurand/pman

源代码

问题

安装: 169

依赖: 0

建议者: 0

安全: 0

星标: 20

关注者: 3

分支: 4

开放问题: 1

语言:Shell

dev-master 2018-11-18 21:36 UTC

MIT 9093a66d6c2a393a449e42f2f7b3b56f6a639dbc

  • William Durand <will+git.woop@drnd.me>

This package is auto-updated.

Last update: 2022-01-31 11:58:32 UTC

README

此包提供了 pman，将 *nix 风格的 man 页面形式的 PHP 手册通过 Composer 和 Packagist 提供。

安装

  1. 此包应全局安装

    composer global require willdurand/pman:dev-master

  2. 然后，将 $COMPOSER_BIN_DIR 添加到您的 $PATH。

$COMPOSER_BIN_DIR 通常为 ~/.composer/vendor/bin，但可能因您的操作系统或配置而有所不同。此外，使用此类路径而不是直接使用 .composer/vendor/bin 是很重要的。

用法

  1. 首先，您需要获取文档。这可以随时进行，也可以只进行一次，但至少需要运行一次。

    sync-pman

此脚本依赖于 Docker。如果您想清除 Docker 的缓存，可以将 --no-cache 选项传递给此脚本

sync-pman --no-cache

  1. 运行 pman 来显示文档（就像您使用 man 一样）

    pman strlen

为什么？

我偶然发现 这篇文章（以及一些其他文章），解释了如何在 vim 中利用 K 命令。我决定使用这个命令而不是 我显示 PHP 手册条目的原始方法。

我在我的系统上不使用 PEAR，因此我依赖于 Docker 来获取 PEAR 包。此外，添加一个脚本来获取（并同步）文档，而不是对所有文件进行版本控制（如这里所做的那样），在我看来似乎更好。

许可

(willdurand's) pman 在 MIT 许可证下发布。有关详细信息，请参阅附带的 LICENSE 文件。请注意，pman，来自 PEAR 的原始包，有自己的许可证。