接下來討論範例的設計,原則上範例以愈明顯易懂愈佳。簡而言之,就是 KISS。Keep It Simple Stupid。
每個指令的範例著重於該指令的基本用法與用途,因此盡可能不與其他指令相搭配較妥。
而範例的例子應該以實際示範較易懂。目前的 wiki 頁面中許多範例像是
- 代碼: 選擇全部
cat FileName
對於生手,許多虛設參數反而另人困惑,照打指令卻出現
- 代碼: 選擇全部
cat: FileName: No such file or directory
或許可改以類似
- 代碼: 選擇全部
cat /etc/passwd
等範例,生手只需照打,而不至於出現錯誤訊息,還傻呼呼來問,為甚麼會有錯誤訊息。此外,範例中如果要讀取特定系統檔案或使用特定指令,應該以 base system 存在的檔案或程式為標的,盡量不使用生手可能未安裝的軟體。範例說明應詳細敘述目前假設的環境為何。(如 IP, gateway 等參數)
預設使用的 shell 應以普遍使用的 "bash" 為基本。範例中如果使用 shell script,應明確指明使用的 shell 名稱。避免使用 #!/bin/sh ,由於某些系統可能將 /bin/sh 以其他如 csh/tcsh 取代。
- 代碼: 選擇全部
#!/bin/bash
echo "Hello World"
系統 locale 應該設置為 "C",標準語系,而不以簡體或繁體中文。避免因為翻譯上的誤差造成疑惑。
- 代碼: 選擇全部
LC_ALL=C
範例中,如無必要使用 root,便盡量少用。如 apt-cache serach 便無須 root 權限。
- 代碼: 選擇全部
apt-cache search apt
為顯示目前使用的帳號與權限,必須指定 shell prompt 以明顯區分差別。應該以統一的 hostname 與 username 為標準。
如標準用戶
- 代碼: 選擇全部
user@debian:~$ PS1='user@debian:\w\$ '
user@debian:~$ cd /tmp
user@debian:/tmp$ pwd
/tmp
user@debian:/tmp$
超級用戶(root)
- 代碼: 選擇全部
debian:~# export PS1='debian:\w\$ '
debian:~# cd /etc
debian:/etc# pwd
/etc
debian:/etc#
範例中如果有特殊名詞,如 loopback、root ,則以新頁面說明。
範例必須以 <code></code> 函括。