阅读远程文档

2018年2月11日 by David Farrell

当我需要阅读Perl文档时，我使用perldoc。我大部分时间都在终端工作，所以直接在终端中打开模块或命令的文档非常方便。

Pod::Cpandoc

有时我需要检查机器上未安装的模块的文档，在这些情况下，perldoc无法帮助我。相反，我可以使用cpandoc，因为它的行为类似于perldoc，但如果模块未安装在您的系统上，它将获取远程文档。

$ cpandoc Foo::Bar
# displays Foo::Bar pod in pager app

由于cpandoc支持与perldoc相同的选项，您可以用它来执行诸如浏览未安装的模块的源代码等有用的技巧。

♥ Metacpan ♥

现在，在终端中阅读文档很好，但我真的很喜欢metacpan的发行页面，它不仅包括文档，还包含了CPAN Testers的结果、发布历史、开放问题和其他有用的链接和数据。所以最近我习惯了在metacpan上阅读文档。

但是，到达那里可能会很麻烦。我打开一个新的浏览器标签，开始输入“metacpan”，然后我的浏览器自动完成为最近查看的metacpan地址，这通常不是我想要的，所以我突出显示URL中的模块名称，并将其替换为我想要的。

经过多次不情愿地执行这个常规操作后，我终于写了一个shell脚本来帮我做这件事

#!/bin/sh
URL="https://metacpan.org/pod/$1"

if [[ "$OSTYPE" == "linux-gnu"  ]]; then
  xdg-open "$URL" &>/dev/null
elif [[ "$OSTYPE" == "darwin"*  ]]; then
  open "$URL" &>/dev/null
elif [[ "$OSTYPE" == "cygwin"   ]]; then
  cygstart "$URL" &>/dev/null
elif [[ "$OSTYPE" == "msys"     ]]; then
  start "$URL"
elif [[ "$OSTYPE" == "win32"    ]]; then
  start "$URL"
elif [[ "$OSTYPE" == "freebsd"* ]]; then
  xdg-open "$URL" &>/dev/null
else
  echo "OS not recognized"
fi