SYNOPSIS
The top sections of a manual page: NAME gives a one-line summary and SYNOPSIS shows how the command is written.
In more detail
In a synopsis, square brackets mark optional parts, three dots mean a part may repeat, and capitalised or underlined words are placeholders for your own values. Reading the synopsis first usually tells you enough to try the command.
Related terms
- man page — The built-in reference manual for a command, opened with man followed by the command name.
- usage placeholder — A capitalised word in a usage line or manual page, such as FILE or PATTERN, that stands for a value you supply.
Taught in
- Help, History, Completion And Aliases — Bash Scripting & Command Line Automation
- Hardware: What The Kernel Sees, What It Loads — LPIC-1 Linux Administrator (101-500 and 102-500) Exam Prep