Command Syntax

What

Command-line documentation uses a universal notation standard to communicate whether command arguments are required or optional.

How

The standard notation is:

Angle Brackets (< >): Represent arguments that are mandatory. You must provide a value for them.
Square Brackets ([ ]): Represent arguments that are optional. You can omit them if not needed.

# General syntax
command <required_argument> [optional_argument]

# Example: Creating a new directory
mkdir <directory_name>

In the mkdir example:

mkdir is the executable command.
<directory_name> is a required argument; the operating system needs to know what to name the new folder.

Why

Understanding command-line syntax notation is crucial for self-learning and reading documentation effectively. It helps you quickly determine exactly how to call a command, what inputs it expects, and which flags or parameters can be customized or left out.

Summary

Angle brackets signify required inputs, and square brackets denote optional customizations when running terminal commands.