Wikipedia:格式手册/计算机

命令行范例指的是一段程序或者shell命令的具体用法，用户可以将其输入计算机终端或者命令提示符运行。本章节描述这些范例，以及其他命令行内容的格式规范。

通用指引

当提供命令行范例时应当保持清晰和简单。这不仅会显得更专业，同时也防止读者产生困惑。下面的指南界定了什么是清晰，简单的范例。

• 命令行的例子应当采用等宽字体。对于行内的代码，应该使用 <code>（有时要配合<nowiki>）。对于多行的代码块，应该使用mediawiki语法，在行前加一空格；或者也可以使用<pre>生成不带维基文本支持的代码块。对于Unix shell，也可以使用<syntaxhighlight>的lang="shell-session"高亮。
• 维基百科不是一个展示作者的个人偏好的媒介。因此除非有必要，否则不应包含任何环境变量，日期，工作目录，用户名或主机名称。
• 术语：选项(option)是一种开关（一些修改一般行为的命令） 。参数(parameter)是一个特定值，如文件或主机名称。引用(argument)这个词是用来指任何空格分隔的字符串按照命令的名字，其中包括选项和参数。
• 列举引用时，应注意保持简单。不加解释地定义引用会混淆读者。
• 维基百科不能取代手册页。条目不应该列出与命令相关的整个选项列表，除非这样的选项非常少，或者这样的描述方式是绝对必要的。
• 当指定参数时，应当使用合理的名称来指代他们。这些名称应该使用斜体，不应包含空格（空格通常用来分隔命令行的多个引用，使用空格会导致混淆）。以下是一些例子：

(提示符) command parameter-name

(提示符) command parameterName

(提示符) command parameter_name

(提示符) command parametername

• 一致性是很重要的。不要在同一个条目里同时使用上述四种方法来命名参数，以免混淆读者。
• 非必须并且可以完全省略的引用应放在方括号[ ]中。
• 有很多方法指定重复的参数。以下两个是最常见的：

(提示符) command parameter0 [.. parameterN]

(提示符) command [parameter ...]

具体平臺指引

DOS、Windows、OS/2

目前最常见的DOS平臺是Windows平臺下的MS-DOS。因此，仅在MS-DOS下适用的例子一般不需要特别说明。但是，如果该实例仅针对某个特定版本的MS-DOS，那么应当标明相关信息。如果已知其他的DOS平臺下该范例有不同的效果，也应当加以说明。 适用于DOS命令行的例子应遵循下列额外的指导方针：

• 程序或命令名应全部大写。
• 标准的MS-DOS风格的选项（例如/C，其中C可能是其他字符）也应该大写，除非它们是区分大小写的。
• 程序名称应当附加适当的文件
  • 大部分类Unix系统的命令实际上都是可执行文件。Shell内建的命令（如cd和history）也在我们讨论的范围内。
  • 类Unix系统中常见的Shell相互之间有着一定的差异。因此，与特定的Shell相关的命令或者实用程序（如for循环或者流特性）应当尽可能地避免。
  • 如果为了正确地作出说明必须使用一串与特定Shell类型相关的命令，那么你应当同时提供类ALGOL的sh，ksh和bash代码，以及C语言风格的csh和tcsh代码。两者的语法没有差别时无需这么做。
  • 类Unix系统中的大部分命令都是全部使用小写字母的。然而，由于shell和操作环境区分大小写的特性，应注意大小写格式与命令或文件名匹配。如果有必要，建议使用标题错误模板。
  • 通常情况下需要权限的命令与不需要权限的那些应当加以区别。如果某个命令确实需要特定权限，那么应当给出一份免责声明指出在无限制的权限下执行命令所具有的风险。
  • 在某些情况下，命令行参数很可能包含一些shell

    为一个命令提供输出范例是一种保守的做法。这种情况下应当给出在终端中实际键入的完整的命令和所有的参数。命令的输出因此将只依赖于运行环境和其他变量。依顺序使用标签prenowiki可以确保输出文字的格式正确。

    使用范例

    DOS

    • DOS 預設命令DIR，這用於列出檔案和資料夾:

    > DIR [options] [pattern ..]
    

    • MS-DOS （其行为模拟了先前版本DOS的功能）上的程序 MOVE.EXE：

    > MOVE.EXE source target
    

    常规Unix

    • 用Unix风格系统上的ls命令列出文件和目录：

    $ ls [options] [file ..]
    

    • 用mkfs命令创建新的文件系统，通常需要一定的权限：

    # mkfs [-t fstype] [fs-options] device
    

    • wget程序，GNU实用工具之一，根据给出的URI获取文件。URI可以包含shell的元字符，因此参数需要加引号以防止出错。

    $ wget [options] 'URI'
    

    Shell特性

    • sh/ksh/bash中内置if结构的语法异同：

    $ if command ; then command ; .. ; fi
    

    在csh/tcsh中:

    % if (expression) then command ; .. ; endif
    

    输出举例

    • df命令的输出举例，列出了挂载的文件系统磁盘空间使用情况：

    $ df -P
    Filesystem          512-blocks      Used Available Capacity Mounted on
    /dev/hda2             39331760   7398904  29834768      20% /
    

按照方针，维基百科不是教程，也不是未经筛选的例子收集处。编者应该将页面上已有的冗余代码全部移动至维基教科书的相关页面。

• 在算法类条目（如快速排序）中不应用几种类似的语言重复举例，而要使用单个语法简单的流行语言或伪代码书写范例。按照不同编程范型实现算法、分开举例则一般是可以接受的。编者可以在维基教科书b:算法实现内罗列各种语言的实现。如b:算法实现/排序/快速排序。避免使用为特定语言、计算平台或编译器的代码优化而损失可读性的代码片段（如p[++i]=xxx;），请在维基教科书中详细介绍此类代码片段。
• 在命令行程序的条目中的例子语言（csh、bash、cmd…）不同常常是Shell命令语言的不同。这不属于程序本身的功能，也须节制加入。
• 在计算机语言条目（如Python）中不应使用大段代码来介绍该语言的语法。最好只保留该语言的helloworld程序示例，并使用文字或列表来说明该语言所支持的语法特性（如循环、函数对象等），并添加内部链接指向那些语法特性。
• 移动代码段时要做以下几件事：
  • 在维基教科书的讨论页张贴来源横幅。
  • 在条目的外部链接部分使用{{wikibook}}模板来指出代码的位置。
  • 编辑维基数据项，添加
    参见：維基百科:格式手冊/連結

    公開的URL

    HTTP和HTTPS

    一個網站可能同時支援超文本傳輸協定（HTTP）和超文本傳輸安全協定（HTTPS）傳輸協議，即網址以http://／https://開頭。我們建議使用者參照以下模式加入連結：

    • 當網站只使用HTTPS，或同時支援HTTP和HTTPS時，使用https://。
    • 當網站只使用HTTP時，使用http://。

    查 论 编 格式手冊 各專題格式建議 內容 親和力 传记 消歧義頁 信息框 链接 避免自我提及 避免使用的字詞 不要華而不實 不要模稜兩可 格式 縮寫 日期和数字 标点符号 音标 文字格式 標題 生僻字 朝鮮半島文字 圖片 题註 旗帜 排版 佈局 導言 章節標題 表格 瑣碎章節 列表 列表 嵌入列表 作品列表 独立列表 法律 商标 創作 虚构 日本動漫游戏 电子游戏 漫畫 电影 電視 音樂 音樂專輯 地區 兩岸四地 日本 朝鮮半島 越南 科學 化學 電腦 数学 哲学 地震 生物分類法 交通 交通車輛條目 相關方針指引 条目长度 命名常规 分類、列表與導航模板 頁面分類 列明来源 頂註 签名 子頁面 討論頁指導 模板名字空间 行话解释 用戶頁 姊妹计划 专题指引   格式指引分類 灰字並非正式指引，僅供參考 青字为含有部分方针或指引的页面