---
layout: "@/layouts/MarkdownLayout.astro"
---

import "github-markdown-css";
import Toc from "../../components/Toc.astro";
import Image from "../../components/Image.astro";

export const title = "ドキュメントの読み方";

# {title}

## ターミナル上で実行するプログラム

ターミナルを開くと、1番最初に実行されるプログラムがあります。
それは **shell (シェル)** です。

shellは、キーボードからのコマンド入力を受け取り、そのコマンドを実行して結果を表示する役割を持っています。

shellにはいくつか種類がありますが、代表的なものとして以下の3つが挙げられます。

- **Bash (Bourne Again SHell)**: Linuxで、現在最も一般的に使用されているシェルです。MacOSでも長らくデフォルトのシェルとして採用されてきました。
- **Zsh (Z Shell)**: MacOSのデフォルトシェルとして採用されているシェルです。Bashに比べて、より多くの機能やカスタマイズ性を提供します。
- **fish (Friendly Interactive SHell)**: 直感的で使いやすいインターフェースを提供するシェルです。初心者にも扱いやすい設計となっています。

この中でも得に`Bash`は多くの環境で利用されているため、ほとんどのドキュメントやチュートリアルでは`Bash`を前提として説明が行われています。

## 書かれ方のパターン

なにを説明するにしても、まずはドキュメントの読み方を知らないことにはなにも始まりません。  
まずはここから見ていきましょう。

### パターン1: コマンドのみの表示

実行するコマンドのみを表示する場合は、以下のように表記します。

```bash frame=terminal
入力するコマンド
```

<br />

```bash frame=terminal
echo "こんにちは！"
```

これはターミナル上で、`echo "こんにちは！"`を入力しただけの状態を示しています。  
この状態ではまだコマンドは実行されておらず、`Enter`キーを押すことで初めて実行されます。

例として、Rustというプログラミング言語のインストールコマンドを見てみましょう。  
これはRustの公式ドキュメントに記載されているインストールコマンドです。

Rustをインストールしたいときは、ターミナルに以下のコマンドを入力して実行`Enter`してください という意味になります。

```bash frame=terminal
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

### パターン2: コマンドとその結果の表示

コマンドを実行すると、何かしらの結果が表示されることがあります。  
その結果も含めて説明する場合は、以下のように表記します。

```bash frame=terminal
$ 入力するコマンド
結果
```

<br />

```bash frame=terminal
$ echo "こんにちは！"
こんにちは！
```

コマンドの前に`$`がついていることに気がつきましたか？  
この`$`が、自身でコマンドを入力する(した)部分であることを示しています。

`echo "こんにちは！"`というコマンドを実行した結果、`こんにちは！`という文字列が表示された、という意味になります。