語法圖
語法圖使用符號來代表指令的元素及指定這些元素的使用規則。
表 1 說明如何閱讀代表指令行介面 (CLI) 指令的語法圖。其中定義代表 CLI 指令元素的符號。
| 元素 | 語法 | 說明 |
|---|---|---|
| 主路徑線條 | >>><>() () () | 主路徑線條從左側的雙箭頭開始:
>>。主路徑線條以右側面向彼此的雙箭頭結束:
><。如果圖表超過一行,則要繼續的每一行結尾是單一箭頭,而下一行的開頭是單一箭頭:
>請沿著主路徑線條從左到右、從上到下來閱讀圖表。 |
| 關鍵字 | 代表指令、旗標、參數或引數的名稱。關鍵字不以斜體顯示。關鍵字的拼寫必須與語法圖所示完全一樣。 | |
| 必要關鍵字 | 表示您在指令中必須指定的參數或引數。必要關鍵字必須寫在主路徑線條上。不能一起使用的必要關鍵字會垂直堆疊。 | |
| 選用關鍵字 | 表示您在指令中可選擇指定的參數或引數。選用關鍵字必須寫在主路徑線條下方。互斥的選用關鍵字會垂直堆疊。 | |
| 預設值 | 預設值必須寫在主路徑線條上方。 | |
| 可重複的關鍵字或值 | 代表可以多次指定的參數或引數。可重複的關鍵字或值是以關鍵字或值上方指回左側的箭頭表示。 | |
| 變數 | 代表您需要提供給參數或引數的值,例如檔名、使用者名稱或密碼。變數以斜體顯示。 | |
| 空格分隔字元 | 在主路徑線條上新增空格,使關鍵字、參數、引數或變數彼此分隔。 | |
| 引號定界字元 | 表示含有多個值的參數或引數的開頭與結尾。以一組雙引號括住特定參數或引數的一或多個名稱/值配對。如果參數值或名稱/值配對包含空白或空格,請用一組單引號括住整個值。 | |
| 等號運算子 | 將名稱/值配對中的名稱與值隔開。 | |
| 語法片段 | 分解太長、太複雜或重複的語法圖。片段名稱會插在主圖表中,而實際片段會顯示在主圖表下方。 |
