Podman 命令

摘要

（显示命令结构。如果命令可以用两种不同的方式书写，则两种方式都需要显示。\ 许多手册页包括 --all、-a 和/或 --latest、-l 选项。在这种情况下，不需要在初始命令之后提供 容器名称 或 ID。因为大多数其他选项仍然需要 容器名称 或 ID，因此定义命令中的 容器 参数不应放在括号中。同时，在描述带有以下句子的 OPTION 的 IMPORTANT 部分中也应注明这一点：IMPORTANT：此选项不需要容器名称或 ID 作为输入参数。。）

podman 命令 [可选参数] 必需值

podman 子命令 命令 [可选参数] 必需值

（如果可以选择两个或更多个必需的命令值，则始终在垂直线之前和之后留有空格以确保更好的可读性。）

podman 命令 [可选参数] 值1 | 值2

podman 子命令 命令 [可选参数] 值1 | 值2

（如果可选值跟随必需值。）

podman 命令 [可选参数] 值1 | 值2 [可选参数]

podman 子命令 命令 [可选参数] 值1 | 值2 [可选参数]

（如果命令接受无限数量的值。）

podman 命令 [可选参数] 值 [值 ...]

podman 子命令 命令 [可选参数] 值 [值 ...]

DESCRIPTION

podman 命令 始终是 DESCRIPTION 部分的开头。将命令作为 DESCRIPTION 的第一部分确保了统一性。文本中提到的所有命令都保留其外观和形式。\ 例如，第一句话可以这样写：podman 命令 是一个示例命令。

好的，根据您提供的信息，以下是我为您编写的podman manpages的样例：

标题：OPTIONS

OPTIONS

--help

此选项用于获取帮助信息。

--quiet

此选项用于减少输出信息量。

--version

此选项用于显示版本信息。

--exit

此选项用于在容器退出时立即退出podman。

链接其他podman manpages或podman repositories的示例：

使用podman-generate-systemd --new选项时，可以使用此选项。

--test (OPTION)

此选项用于测试目的。其定义在不同的上下文中可能有所不同，因此使用表格进行解释。例如：

定义：测试容器实例的数量或类型

用法：podman-test --container-type <类型> --container-number <数量> <其他参数>

列表示例：当使用podman-commit --change选项时，可以使用此选项来指定容器更新的指令。例如：podman commit <container_id> --change "CMD: bash"

请注意，以上内容仅为示例，实际编写时需要根据另外，为了使man pages易于阅读和理解，我遵循了您提供的指导原则，如避免使用代词、保持一致的格式和语法

好的，以下是翻译后的内容：

--version, -v

这个选项可以在命令后面以两种不同的方式使用。可以使用带有--option的长格式，或者使用短格式-o。如果一个选项有不同的写法，它们会被逗号分隔。如果一个命令有多个版本，那么长格式总是会显示在前面。如果OPTION是boolean类型，那么true/false这样的选项不会列出。默认的boolean参数会以正常默认参数的相同方式显示。

例如：默认值是false。

重要：这个选项不适用于远程的Podman客户端。

--exit

这是一个只在长格式中存在的boolean OPTION的例子。

--answer, -a=active | disable

这个--answer OPTION是一个例子，它接受两种可能的输入如果没有在命令中使用这个选项，那么默认的参数会被显示为粗体。如果这个选项被使用，那么它后面必须跟一个参数。必须始终确保标准参数在OPTION之后的第一位置。在这个例子中，有两种不同的方式来执行命令，需要同时展示两种可能的OPTION及其参数。

默认值显示为active。

--status=good | better | best

这是一个三个参数跟随一个OPTION的例子。如果参数的数量大于三个，那么这些参数不会在等号后面列出。这些参数必须以表格的形式展示，就像在--test=test中一样。如果内容的理解有可能会导致理解困难，那么应该使用这种表格形式。例如，podman-container-prune --filters

默认值显示为good。

--test=test

紧跟等号的OPTIONS后面会有一个粗体或斜体的参数。如果在命令中未指定该选项，默认参数会显示为粗体。所有参数都必须在选项下方列出并解释。

参数	描述
example one	如果未指定该选项，此参数为默认值。
example two	如果提到一个命令，应使用粗体。
example three	示例：与podman 命令结合效果显著。
example four	示例：可以与--exit配合使用。
example five	第五个描述。

表格展示了参数列表的示例。表中的内容应左对齐。如果表格内容与这一规则冲突，可以调整对齐以提高理解。如果有默认参数，它必须放在表格的第一行。

默认值显示为example one。

如果参数数量少于四个，它们需像--status那样直接跟在选项后面列出。

--problem=problem

紧跟等号后接着一个未指定参数的OPTIONS，没有默认参数。如果只写等号而未提供参数，将不会出错，但选项将被忽略。参数的含义通常会在等号后的单个单词（斜体）中描述。

子章节

专为man页面中的单独子章节设置的格式条件仍然适用。

段落和表格的使用不受限制。在这些段落和表格内，格式条件依然有效。

任何类型的路径都必须使用backticks高亮显示。

重要：只有不属于之前提及类别（如选项或命令）的字符才能被高亮。例如，不建议高亮显示选项或命令。

子标题显示如下：

子标题

子标题文本。

示例

所有示例都列在这个部分。每个示例都应放在一个框中，框从最后一行开始，到最后一行结束，而不是留空行。前面带有$的命令表示普通用户可以运行，而以#开头的命令仅限root用户运行。如果需要在框中添加注释，应在注释前加上###。

示例描述

### 示例说明
$ podman 命令
$ podman 命令 -o
$ cat $HOME/Dockerfile | podman 命令 --option

#示例

所有的示例都在这一节列出。每页man文档的末尾应包含此类。每个示例都放在一个框内，框由最后一行开始和结束，而非空行。命令前面的$表示普通用户可以运行，而以#开头的命令仅限root用户运行。如果需要在框内添加注释，应在注释前加上###。

示例描述：

### 示例说明
$ podman 命令
$ podman 命令 -o
$ cat $HOME/Dockerfile | podman 命令 --option

示例二描述：

# podman 命令 --status=better

参考

所有在man页面中提及的命令（包括带选项的命令）和配置文件都应在此列出。Podman的命令、带选项的命令和配置文件需要链接。如果一个命令多次出现但带有不同的选项，只需链接一次。其他所有命令（包括带选项的）和配置文件只需提及，如果多次出现，只需链接一次。 示例：

podman(1), podman-run(1), podman-create(1)

历史

通常，这里会列出更改日期、更改内容以及提供更改的人。大多数man页面并不保留这类记录。

2021年12月，最初由Alexander Richter编译

每个man页面都应该以空行结束。