SuperAPI AI 工具集

man

编程与开发

查看项目

更新于 11-13 20:56

技能介绍

用途

该技能用于在需要精确命令文档时查阅系统 man 手册页,尤其适合不确定命令名称、参数顺序、具体选项含义或命令行为的情况,也响应用户“查看手册页”“查一下手册”“某命令是做什么的”这类请求。资料建议在准确性重要时优先使用 man 手册,而不是依赖训练数据。

关键限制与安全注意事项

资料明确警告:不要直接运行裸的 man <command>,因为它会打开交互式分页器并造成挂起。应使用非交互方式读取。

主要能力与工具

技能附带 mancat.sh 辅助脚本,用于便捷地非交互访问手册页,并自动去除格式控制字符。常用形式包括:

  • 查看完整手册页:"$MANCAT" ls
  • 指定章节:"$MANCAT" passwd 5
  • 提取指定小节:"$MANCAT" -s OPTIONS tar
  • 按关键字搜索描述(apropos):"$MANCAT" -k compress

其中 MANCAT="${CLAUDE_PLUGIN_ROOT}/skills/man/mancat.sh"。

当脚本不可用或需要管道到 grep/sed 时,可使用原始模式:

  • man <command> | col -b:col -b 去除退格格式码,输出干净纯文本
  • PAGER=cat man <command>:强制不使用分页器,但可能包含转义码
  • man <command> | cat:简单方式,在某些系统上不够干净

使用方式与工作流

资料给出三类典型流程:

  1. 发现命令:不知道用什么命令时,用 man -k <keyword> 搜索名称与描述,例如 "$MANCAT" -k compress 或 "$MANCAT" -k "file system"。
  2. 验证语法:已知命令但需要确切参数顺序时,读取 SYNOPSIS,例如 "$MANCAT" -s SYNOPSIS tar。
  3. 调查选项:读取 OPTIONS 小节,或针对单个标志过滤,例如 "$MANCAT" tar | grep -A5 -- '-z'。

为了节省上下文,资料建议不要立即获取完整手册页:先读 SYNOPSIS 了解结构,再读 DESCRIPTION 获取概览,仅在需要具体标志时获取 OPTIONS。并建议始终限制输出长度,例如 man bash | col -b | head -100。

针对原始模式还给出了定向提取示例:

  • 获取特定选项:man tar | col -b | grep -A5 -- '-z'、man curl | col -b | grep -A8 -- '--data'
  • 提取小节:man ls | col -b | sed -n '/^SYNOPSIS/,/^[A-Z]/p' | head -20、man curl | col -b | sed -n '/^OPTIONS/,/^[A-Z]/p' | head -50、man rsync | col -b | sed -n '/^EXAMPLES/,/^[A-Z]/p'

快捷参考命令还包括:man -f tar 获取一行描述;man -w grep 检查手册页是否存在并获取路径。

手册页章节

资料列出章节:1 用户命令、2 系统调用、3 库函数、4 特殊文件(/dev)、5 文件格式(/etc/passwd)、6 游戏、7 杂项(协议、约定)、8 系统管理命令。同名条目存在于多章节时需指定,例如 man 1 printf、man 3 printf、man 5 crontab、man 8 cron。

阅读手册输出

资料解释了常见小节含义:SYNOPSIS 为命令语法([] 表示可选,... 表示可重复);OPTIONS 为标志说明及确切语法;EXAMPLES 为可用命令示例(并非所有页面都有);SEE ALSO 为相关命令。

适用场景

资料列出适合查阅手册页的场景:系统命令(ls、find、tar,选项随操作系统变化)、配置文件(如 man 5 sudoers)、Git 子命令(如 man git-rebase)、网络工具(如 man curl、man ssh)。

未提供的信息

资料未提供跨平台兼容性细节、具体操作系统差异说明,也未说明安装方式、收费或效果指标。