2010-07-06 73 views
3

在Linux系統上,通常輸入progname --help以查看該程序的幫助輸出。在此之後,你會看到這樣的描述:progname [SWITCHES] [FILES]... [ETC]是否有Linux預測的標準化語法?

我的問題是;對於他的(命令行使用)文檔有沒有標準化的語法?

爲了描述之類的東西可選開關,多種參數(如文件列表),開關模式等看起來會有一個標準,這樣誰知道它,可以準確地解釋你的文檔。

注意:這純粹是關於編寫我自己的文檔,而不是解析參數。

回答

1

GNU Getopt Library可能現在來分析參數的最標準的方式。對於大多數您將使用的語言,都有庫綁定。

+0

謝謝,但我正在寫我自己的文檔,不解析參數。爲了清晰起見而編輯。 – sigint 2010-07-06 15:20:29

+1

如果您使用的是GNU libc,您可以使用'argp',它類似於getopt,但會爲您自動生成'--help'輸出:http://www.gnu.org/s/libc/manual/html_node /Argp.html – 2010-07-06 20:13:00

2

我瀏覽過許多Linux手冊頁和這裏是我甲肝的幾件事情看到這似乎是標準的Linux手冊頁的標準。像上面的一些貢獻者所說,似乎沒有任何公佈的文檔標準。我在網上看到了一些不同之處,但隨着linux的頁面看起來很一致。

  1. 在考慮中的命令首先出現。
  2. 用戶提供的參數放置在尖括號「<>」中,括號內給出的名稱描述了參數。恩。
  3. 可選的參數放在方括號「[]」中。
  4. 如果必須從定義的集合中選擇參數值,則不同的選項由管道符號「|」分隔,表示「或」。
  5. 如果內容遵循邏輯進程,則可以使用點點「...」來簡化列表。恩。 [...]。
  6. 小心空間。空間分開的東西,所以沒有單一事物的名稱空間。使用「文件名」或「文件名」,而不是「文件名」。

這就是我現在能想到的。如果您覺得合適,請隨時添加並更正。

相關問題