docker container top

原创2026-10-05 22:37:161,706 阅读
文章标签:文档知识库教程

docker container top

tldr(Too Long; Didn't Read)是一个协作式控制台命令速查表项目,本项目仓库即 tldr-pages 的中文/多语言镜像。本文以 pages.bn/common/docker-container-top.md(孟加拉语版本)为核心,讲解 docker container top 命令的速查页面结构、{{[top|container top]}} 选项占位符语法、docker top 别名机制,并结合仓库内的风格指南、别名模板与英文原文,给出页面编写与本地化校验的完整指南。

页面速览:一行描述 + 两个示例

docker container top 用于查看一个正在运行的 Docker 容器内的进程列表(功能类似在容器内执行 ps)。tldr 项目为这个命令创建了速查页面,仓库中同一命令有多个语言版本:

原文档完整结构如下(孟加拉语版与英文版内容一一对应):

# docker container top

> একটি কন্টেইনারের চলমান প্রসেসসমূহ দেখুন।
> আরও তথ্য পাবেন: <https://docs.docker.com/reference/cli/docker/container/top/>।

- একটি কন্টেইনারের চলমান প্রসেসসমূহ দেখুন:

`docker {{[top|container top]}} {{container}}`

- সাহায্য প্রদর্শন:

`docker {{[top|container top]}} --help`

页面遵循 tldr 标准模板:第一行 # 标题必须与命令名完全一致(文件名 docker-container-top.md 为小写,标题 docker container top 按 Docker 官方拼写原样保留);> 开头是单行精炼描述;随后是「更多信息」链接行;最后是命令示例列表,每条示例由一行描述和一行带 {{}} 占位符的命令构成。

示例逐条解析:占位符与选项占位符

查看容器运行中的进程

docker {{[top|container top]}} {{container}}
  • {{container}} 是用户自定义值占位符(Placeholder),语法为 {{ }},用于标记需要用户替换的内容。在 Docker 的用法中,container 可填容器名称或容器 ID(可通过 docker container ls 查看)。
  • {{[top|container top]}} 是 选项占位符(Option Placeholder),语法为 {{[ | ]}},表示 top 与 container top 两个写法互斥可选。Docker CLI 同时支持 docker top 与 docker container top 两种调用方式,二者等价,速查页面据此用选项占位符将两种形式一并给出,让客户端可以根据用户偏好渲染其中一种。

显示帮助

docker {{[top|container top]}} --help

--help 为固定参数,不加占位符,表示它是必须原样输出的命令选项。按照风格指南的约定,帮助和版本命令通常放在页面的最后两个示例,用于突出更实用的命令在前面(参见 style-guide.md)。

占位符语法速查表

tldr 风格指南在 style-guide.md 中给出了完整的占位符语法汇总,docker container top 页面中正好用到了其中三类:

语法 含义 本页应用
{{ }} 用户替换值占位符 {{container}}
{{[ | ]}} 选项占位符(互斥可选) {{[top|container top]}}
--help 等原样参数 固定命令选项 --help

此外,风格指南还规定:占位符应简短但有描述性(如 {{path/to/file}});互斥选项用 {{a|b|c}} 表示;当选项可长短形式混用时,用 {{[-o|--output]}} 让客户端自行决定显示短选项或长选项——本项目页面中的 {{[top|container top]}} 正是这种「客户端可感知的多形式」设计思路的体现。

docker top 别名页与页面间导航

除了 docker container top 主页面,仓库中还维护了一个别名页面 docker top:

别名页内容遵循 style-guide.md 的别名章节和 translation-templates/alias-pages.md 中预翻译好的模板,孟加拉语版本写作:

# docker top

> এই কমান্ডটি `docker container top` - এর একটি উপনাম।

- মূল কমান্ডের ডকুমেন্টেশন দেখুন:

`tldr docker container top`

即:第一行声明「此命令是 docker container top 的别名」,示例用 tldr docker container top 引导用户查看原始命令的完整文档。这种「主页面 + 别名页」的结构,让用户无论输入 docker top 还是 docker container top,都能通过 tldr 客户端找到正确的速查文档,同时避免在同一页面中重复维护两份内容。

多语言本地化:孟加拉语翻译的完整闭环

本项目为 docker container top 维护了英语与孟加拉语两套页面,形成了一条完整的本地化链路:

  1. 英文原文定义命令的语义与示例:pages/common/docker-container-top.md;
  2. 翻译模板提供各语言的固定句式:translation-templates/alias-pages.md 中收录了孟加拉语(bn)的别名描述模板「এই কমান্ডটি example - এর একটি উপনাম」;
  3. 孟加拉语页面复用同一结构、仅替换描述文本,命令与参数保持不变:pages.bn/common/docker-container-top.md。

需要注意的本地化细节:

  • 命令名、选项、占位符不做翻译,仅翻译描述性文字。例如本页中 docker、top、container、--help、{{container}} 均保持原样,而「একটি কন্টেইনারের চলমান প্রসেসসমূহ দেখুন」是对英文描述「Display the running processes of a container」的翻译;
  • 文件名 docker-container-top.md 保持小写并与命令匹配,标题 docker container top 保留空格原样;
  • 孟加拉语文本采用其自身书写系统,页面编码与 Markdown 语法不受影响。

页面校验与贡献流程

tldr 仓库通过 linter 自动校验每个页面的格式,贡献者在提交前也可本地自测(见 style-guide.md 与 style-guide.zh.md):

npm install --global tldr-lint
tldr-lint path/to/tldr_page.md

校验重点包括:标题与命令名一致、描述不超过两行、示例不超过 8 条、占位符语法正确、帮助/版本示例位于末尾、更多信息链接有效等。同时仓库中的 scripts/wrong-filename.py 等脚本还会检查文件名是否与命令匹配,确保 docker-container-top.md 这类页面不会被误命名。

小结

docker container top 速查页面虽然短小,却是 tldr 项目规范化体系的一个完整缩影:它展示了「英文原文 → 多语言翻译」的协作模式、「主页面 + 别名页」的导航设计、{{}} 与 {{[|]}} 占位符语法、以及 linter 驱动的格式保障。参考英文原文 pages/common/docker-container-top.md 与风格指南 style-guide.md,任何开发者都能快速理解并复现同类的 Docker 命令速查页面。

登录后查看全文
tldr