前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >玩转PMan

玩转PMan

作者头像
LA0WAN9
发布2021-12-14 08:05:09
8580
发布2021-12-14 08:05:09
举报
文章被收录于专栏:火丁笔记

所谓PMan,指的是PHP Man Pages,可以通过它方便的在命令行上查看PHP文档。它就好比Perl里的PerlDoc,或者Python中的PyDoc,亦或者Ruby里的Ri。

安装

假设你的系统已经存在pear命令了,那么接下来就是一招鲜了:

代码语言:javascript
复制
shell> pear install doc.php.net/pman

安装好后使用非常方便,就和Linux下常见的man命令一样的用法:

代码语言:javascript
复制
shell> pman strlen

显示效果上也和man命令一样,如下图所示:

PMan Command
PMan Command

PMan Command

扩展

以前我习惯于使用CHM格式的PHP文档,因为它的检索功能很方便,只要记住开头几个字母就能查到想要的内容,可惜坏消息是PMan在这方面比较衰,但是好消息是不用重复发明轮子,bash-completion已经实现了我们想要的大部分功能。

下面以CentOS为例(其它Linux可能有差异),前提是先安装EPEL,然后执行命令:

代码语言:javascript
复制
shell> yum install bash-completion

缺省会安装不少现成的bash-completion脚本,可以参考它们实现PMan的对应脚本:

代码语言:javascript
复制
shell> cat /usr/share/bash-completion/pman
# pman(1) completion

have pman &&
_pman()
{
    local cur manpath

    COMPREPLY=()

    cur="${COMP_WORDS[COMP_CWORD]}"

    manpath="$(tail -n 1 $(which pman))"
    manpath="$(echo ${manpath%/*} | awk '{print $NF}')"

    if [ -n "$cur" ]; then
        COMPREPLY=($manpath/man*/$cur*)
    else
        COMPREPLY=($manpath/man*/*)
    fi

    COMPREPLY=(${COMPREPLY[@]##*/})
    COMPREPLY=(${COMPREPLY[@]%.*.*})

    COMPREPLY=($(compgen -W '${COMPREPLY[@]}' -- "$cur"))

    return 0
} &&
complete -F _pman pman

接着还需要在指定目录做一个软连接以便激活脚本:

代码语言:javascript
复制
shell> ln -s /usr/share/bash-completion/pman /etc/bash_completion.d/pman

重新登录后,PMan就拥有按TAB键提示的功能了,如下图所示:

PMan Bash Completion
PMan Bash Completion

PMan Bash Completion

技巧

VIM是命令行下最常用的编辑器之一,PMan和VIM可以完美结合,在命令模式下键入如下指令,就可以即时显示函数的文档内容:

代码语言:javascript
复制
:!pman strlen

实际上还可以更方便些,编辑VIM配置文件,加入keywordprg设置:

代码语言:javascript
复制
shell> cat ~/.vimrc
autocmd FileType php setlocal keywordprg=pman

打开PHP文件后,把光标移动到某个函数下,按大写的K键即可查看函数的文档内容。如果想退出文档界面,回到VIM界面,只需按q键。

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2011-09-07,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 安装
  • 扩展
  • 技巧
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档