3. 本文档使用的约定

本文档使用的约定

所有与 SSH 协议相关的文档都应使用关键词 "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" 来描述要求. 这些关键词应按 [RFC2119]. 中的说明解释.

本文档中用于描述命名空间分配的关键词 "PRIVATE USE", "HIERARCHICAL ALLOCATION", "FIRST COME FIRST SERVED", "EXPERT REVIEW", "SPECIFICATION REQUIRED", "IESG APPROVAL", "IETF CONSENSUS", and "STANDARDS ACTION" 应按 [RFC2434] 中的说明解释.

协议字段以及可填入这些字段的可能值在本组文档中定义. 协议字段将在消息定义中给出. 例如, SSH_MSG_CHANNEL_DATA 定义如下.

  byte      SSH_MSG_CHANNEL_DATA
  uint32    recipient channel
  string    data

在这些文档中引用字段时, 字段将出现在单引号内. 引用填入这些字段的值时, 值将出现在双引号内. 使用上面的示例, 'data' 的可能值包括 "foo" 和 "bar".