文档教程知识库【免费下载链接】tldrCollaborative cheatsheets for console commands .项目地址https://gitcode.com/GitHub_Trending/tl/tldr点击查看免费下载本篇技术指南围绕 tldr 仓库中pages.ar/linux/trash-put.md这一别名页展开系统讲解 tldr-pages 项目如何为「一个命令的别名」维护精简文档从别名页的格式规范、多语言模板到背后的trash命令族以及仓库中用于批量生成与同步别名页的set-alias-page.py脚本。读完你将掌握别名页的完整读写链路能够看懂、校验并维护任意语言的别名页面。别名页在 tldr 项目中的定位tldr-pages 是一个社区维护的命令行速查手册集合用更简洁、可读的形式补充传统 man 手册。仓库采用「一页一命令」的组织方式页面按平台目录common、linux、osx等与语言目录pages、pages.ar、pages.fr等分类存放。当某个命令可以用其他名字调用时例如vim可以被vi调用tldr 并不会为别名重复抄写一份文档而是创建一张别名页alias page把用户引导到原命令的页面。这既避免了内容重复维护也保证了用户在查询别名时能快速抵达真正的文档。仓库的风格指南 contributing-guides/style-guide.md 给出了别名页的判定标准与标准模板# command_name This command is an alias of original-command-name. - View documentation for the original command: tldr original_command_name规范同时强调「尽量让页面文件名与被调用的命令一致」style-guide.md因此别名页通常直接以别名命令命名例如trash-put.md、vi.md。trash-put 阿拉伯语别名页逐行解析本次的主角 pages.ar/linux/trash-put.md 是一张完整的阿拉伯语ar别名页全文只有 7 行却恰好覆盖了别名页模板的全部三个组成部分# trash-put هذا الأمر هو اسم مستعار لـ trash. - إعرض التوثيقات للأمر الأصلي: tldr trash逐部分拆解标题行# trash-put。页面文件名与被记录的命令一致即trash-put这个可执行命令名。描述行 هذا الأمر هو اسم مستعار لـtrash.阿拉伯语意为「此命令是trash的别名」。这一行是别名页的语义核心用反引号标明原始命令名。示例项- إعرض التوثيقات للأمر الأصلي:意为「查看原命令的文档」其后跟随命令块tldr trash告诉用户用tldr trash获取原命令的完整速查页。tldr 客户端在遇到tldr trash-put时会解析到这张别名页并提示用户查看tldr trash从而避免在仓库里重复维护两份相同的内容。别名页背后的 trash 命令族trash-put的真实身份是 trash-cli 工具集中的命令之一。原命令 pages/linux/trash.md 集中管理了整个「回收站」命令族的用法命令用途示例trash将文件移入回收站trash {{path/to/file}}trash-list列出回收站中的所有文件trash-listtrash-restore交互式恢复回收站中的文件trash-restoretrash-empty清空回收站trash-empty带天数参数时仅删除早于指定天数的文件如trash-empty 10trash-rm按glob模式或原始位置删除回收站中的文件trash-rm {{*.o}}、trash-rm /{{path/to/file_or_directory}}在仓库中trash-list、trash-empty、trash-restore、trash-rm这四个页面pages/linux/trash-list.md、pages/linux/trash-empty.md、pages/linux/trash-restore.md、pages/linux/trash-rm.md采用了另一种收敛策略「示例已与trash合并」统一跳转到tldr trash。也就是说tldr 仓库对「同族命令」使用了两种收敛方式别名页记录「某命令是另一命令的别名」如trash-put示例合并页记录「某命令的示例已并入主命令」如trash-list。两者目标一致都是把用户导向tldr trash这一唯一事实源。多语言别名页模板与翻译同步别名页的内容并非人工逐语言手写而是有标准化的翻译模板。仓库在 contributing-guides/translation-templates/alias-pages.md 中为 30 余种语言各维护了一套模板其中阿拉伯语ar模板为# example هذا الأمر هو اسم مستعار لـ example. - إعرض التوثيقات للأمر الأصلي: tldr example将模板中的example依次替换为别名页标题、原始命令名与文档查询命令即可生成一张完整的阿拉伯语别名页——这正是 pages.ar/linux/trash-put.md 与 pages.ar/common/trash-cli.md同样指向trash在仓库中的实际形态。阿拉伯语目录中trash-cli位于common平台而trash-put位于linux也体现了不同命令在平台归属上的差异。用 set-alias-page.py 自动化维护别名页tldr 仓库提供了专门的脚本 scripts/set-alias-page.py 来创建与同步别名页。其核心流程如下内容生成generate_alias_page_content()读取对应语言的模板按顺序将example占位符替换为标题、原命令、文档命令别名识别get_alias_command_in_page()解析页面通过「 ... alias ...」行与tldr ...行抽取原始命令名判断该文件是否确实为别名页多语言同步--sync-S模式扫描pages目录下所有英文别名页再按语言模板逐目录写入对应的pages.xx目录--language ll/ll_CC可限定只同步某一种语言安全控制--dry-run-n只预览改动而不落盘--stage-s在改动后自动执行git add。典型用法# 交互式创建一张新的别名页例如 osx/gsum python3 scripts/set-alias-page.py -p osx/gsum # 将英文别名页同步到所有翻译 python3 scripts/set-alias-page.py -S # 仅同步巴西葡萄牙语且只预览不修改 python3 scripts/set-alias-page.py -S -l pt_BR -n脚本从 scripts/_common.py 中复用get_templates()解析alias-pages.md模板文件、get_pages_dirs()枚举所有pages*目录、get_locale()从目录名推导语言如pages.ar→ar等公共函数整个维护链路完全由仓库内的配置与脚本驱动。别名页的校验与提交tldr 仓库对页面格式有严格校验。tldr-lint其别名tldrl可用于检查单个页面是否符合规范参见 style-guide.md仓库内的 scripts/test.sh 与 scripts/test-tldr-lint.sh 则承担了 CI 级别的批量校验。别名页需要同时满足标题行以#开头并与文件名一致描述行采用「This command is an alias of...」句式及其语言模板翻译示例项严格为tldr original_command且原命令的页面必须真实存在于仓库中。日常阅读或维护这类页面时只要保证「描述行指向真实命令、查询行可被客户端正确解析」就能与仓库的模板与校验体系保持一致。小结一张 7 行的trash-put别名页背后牵出的是 tldr 项目完整的「别名页」工程体系格式规范style-guide.md、多语言模板alias-pages.md、自动化脚本set-alias-page.py以及命令族示例的收敛策略。理解了这一机制你就能读懂仓库中任何一张别名页也能在需要时为新的命令别名贡献页面。赞分享文档教程知识库【免费下载链接】tldrCollaborative cheatsheets for console commands .项目地址https://gitcode.com/GitHub_Trending/tl/tldr点击查看免费下载相关推荐tldr 别名页Alias Page机制解析以阿拉伯语 git stage 页面为例tldr 别名页Alias Page机制解析以阿拉伯语 git stage 页面为例 本文围绕开源 tldr 仓库中的 pages.ar/common/g文档教程知识库tldr 别名页面Alias Pages机制解析以阿拉伯语版 vc → vercel 页面为例tldr 别名页面Alias Pages机制解析以阿拉伯语版 vc → vercel 页面为例 pages.ar/common/vc.md 是一份典型的文档教程知识库tldr 项目中的 Alias 别名页机制解析以阿拉伯语 xml xmln 页面为例tldr 项目中的 Alias 别名页机制解析以阿拉伯语 xml xmln 页面为例 本文以 pages.ar/common/xml xmln.md http文档教程知识库上一篇终极机械键盘连击修复指南Keyboard Chatter Blocker完整使用教程下一篇Vite React Server Components 多环境构建接入 StyleXexample-vite-rsc 完整实战指南创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考