Help us understand the problem. What is going on with this article?

gitのヘルプのSYNOPSISの読み方

More than 3 years have passed since last update.

gitでコマンドの使い方がわからなかったらググる人も多いと思いますが、普通にコンソールでもマニュアルが読めますよ。

例えば、 git add のヘルプを見たいときは次のようにすれば良いです。(どちらのコマンドも同じ内容)

$ git help add
$ git add --help

インストール方法によっては man コマンドでも同じヘルプページが表示できます。

$ man git-add

でも、英語で非常に読みづらい、とか思いますよね。英語に関してはがんばって読んでください(;´∀`)
同じヘルプページはオンラインでも読めます。 https://git-scm.com/docs

もう一つ読みにくいポイントはコマンドライン引数やオプションの指定方法に関して書かれた部分 SYNOPSIS です。

SYNOPSIS
       git add [--verbose | -v] [--dry-run | -n] [--force | -f] [--interactive | -i] [--patch | -p]
                 [--edit | -e] [--[no-]all | --[no-]ignore-removal | [--update | -u]]
                 [--intent-to-add | -N] [--refresh] [--ignore-errors] [--ignore-missing]
                 [--chmod=(+|-)x] [--] [<pathspec>...]

Linuxの man コマンドに慣れている方は割とすんなり読めると思いますが、読み方を少し書いておきます。

文法

  • [ A ] : 任意で入力できる項目。あってもなくても良い。Optional。
    • [--refresh] : --refresh というオプションを指定可能。なくても動く。
  • [ A | B ] : A または B のどちらかを指定可能。
    • [--verbose | -v] : --verbose というオプションを指定可能。 この場合、-v は同じ意味の省略形。
    • [--[no-]all | --[no-]ignore-removal | [--update | -u]] : この場合、 --all, --ignore-removal, --update は同時に指定できないことを示す。
  • ( A | B ) : A または B を必ず指定。
    • [--chmod=(+|-)x] : --chmod オプションを使うときは +x または -x で指定する。
  • <A> : 変数。リビジョン番号やブランチ名、ファイルパスなどが入る。
    • <pathspec> : file1 とか dir1/* とか dir1/**/*.ext とか。
  • A... : Aの繰り返し。
    • <pathspec>... : file1 file2 file3 のようにスペースで区切って指定可能。

参考 : git用語集

pathspecref, commit などのgitの概念を示す用語がSYNOPSISにところどころ出てきますが、これらの単語に関しても実はヘルプページがあります。

$ git help gitglossary

気になる人は頑張って読んでみましょう。オンラインで読めるページもあります。

mather314
元数学専攻のエンジニア。Web系のアプリケーション開発がメインだが、HTMLやCSSよりはバックエンドロジックの分析などが得意。Haskell, Scala, Elmなどを嗜む程度に。
Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away