コマンドの表記法について

Linux系OSにおいて、各操作はコマンドベースで行われます

慣れないうちはGUI(ボタン等を押して操作するインターフェイス)が良いと感じるかも知れませんが、慣れてくると、操作ミスが起こりづらく再現性の高いコマンド操作に病みつきになることでしょう

そのため、本サイトもたいていの操作をコマンドで解説しており、特定のコマンド表記については、解説なしに記述している部分があります

そこで、本サイトのコマンド表記ルールについてここにまとめておきます



接頭記号について

ターミナル上のコマンドを表す接頭記号

ターミナルとは、コマンドを実行するためのいわゆる「黒い画面」のことです(Ubuntu においては Ctrl + Alt + T キーで起動するやつです)

terminal.png

本サイトにおいては、基本的にターミナル上で実行するコマンドは $ から始まるように記述しております

例として、以下のような記述があった場合は「ターミナル上で sudo apt update という文字列を打ち込んで ENTER キーを押す」という操作を表しています($ という文字は打ち込まない!)

$ sudo apt update

また、ターミナル上のコマンドを表す記号として % を使うこともありますが、これは root権限(管理者権限)で実行するコマンドを表しています

root は通常 sudo su というコマンドでなれる特殊なユーザであり、システムに関するすべての操作が可能な管理者です(管理者パスワードの入力を要求される時もあります)

例として、以下のような記述があった場合は「sudo su というコマンドで rootユーザになった後 apt update というコマンドを実行する」という操作を表しています($ 同様 % という文字を打ち込むことはありません)

$ sudo su
% apt update

コメントを表す接頭記号

コマンドの意味を解説するため、本サイトでは多めにコメントを入れるようにしております

# から始まる文字列はコメントを表し、実際にコマンドとして打ち込む必要のない行であると考えてもらえればよいです

例として、以下のような形で記述されます

# これは単なる解説用のコメントです
## 実際にコマンドとして実行する必要はありません

PowerShellのコマンドを表す接頭記号

PowerShellとはWindowsにおけるターミナルのようなものです

本サイトでは、Windows環境であっても、その上にUbuntu環境を構築して開発を行うため、ほとんどの操作はターミナル上で行われますが、環境構築中などはPowerShellを使う想定で解説を書いております

そのため、ターミナル上での実行コマンドと区別するため > から始まる文字列をPowerShell上でのコマンドとして表記しています

# 以下はPowerShell上で「Restart-Computer」というコマンドを実行するという意味
## $ % と同様に > も実際に打ち込む必要はありません
> Restart-Computer

引数について

大抵のコマンドは引数というものをとります

引数とはコマンドに渡す特殊なパラメータのことですが、実例がないとよく分からないと思いますので、ファイルの中身をターミナル上に出力する cat コマンドを例に解説いたします

cat は「ファイルの中身をターミナルに出力する」コマンドですが、これ単体では「どのファイルを見るか」ということが分からないと思います

そういった場合に使うのが引数です

言い換えると、「ぼんやりとした命令を具体的にするための追加命令」が引数であると言っても良いかも知れません

必須引数

本サイトでは必須引数(必ず指定しなければならない引数)であることを明示的に表すために <> という記号を用いている箇所があります

先程の cat コマンドを例にとると、「どのファイルを見るのか」ということは必ず指定しないと動きようがないと思います

こういった場合に、以下のようなコマンド記法で必須引数を明示しております

$ cat <ファイル名>

上記コマンドは「cat コマンドの引数として『ファイル名』を渡さなければならない」ことを意味しており、<> を直接ターミナルに打ち込むことはありません

オプション引数

必須引数とは逆に、必ずしも指定しなくても良い引数をオプション引数と呼びます

本サイトではこういった引数を [] という記号を用いて記述している箇所があります

例えば cat コマンドには行番号を出力するための -n というオプションがあるため、それを明示的に示すために以下のように記述していたりします

$ cat [-n: 行番号表示] <ファイル名>

ただし、全てのオプション引数を常に網羅しようとすると非常に見づらくなるため、主要なオプション引数のみ記述していることがほとんどです