6
マニュアルページを読むとき、私の経験では常にsynopsis
セクションがありました。例えばマニュアルページの概要表記
MV(1) BSD General Commands Manual MV(1)
NAME
mv -- move files
SYNOPSIS
mv [-f | -i | -n] [-v] source target
mv [-f | -i | -n] [-v] source ... directory
synopsis
セクションで使用されている表記に興味があります。それは何と呼ばれ、どこでもっと情報を見つけることができますか?
一般的にはかなり正直なように思えますが、私は通常その意味を理解することができますが、独自のドキュメントで使用したいので、前に構文について知るべきだと思います私は自分のマニュアルページを書き始めます。
'man man'があなたを始めます。 'groff'も参照してください。 –
@MarcB 'man'や' groff'のマニュアルページでは、 '[...]'はオプションの引数を示し、 '|'は選択肢を示していますか?私はこれがBackus-Naur構文表記のバリエーションだと思う。 – Barmar