---
title: "Typographic Conventions in this Guide"
slug: "typographic-conventions-in-this-guide"
tags: ["5.5"]
updated: 2026-10-27T23:00:54Z
published: 2026-10-27T23:00:54Z
canonical: "docs.vastdata.com/typographic-conventions-in-this-guide"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vastdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Typographic Conventions in this Guide

Each command reference includes a *Usage* section that shows the syntax for the command. The Usage section is followed by a *Required Parameters* section and an *Options* section. These sections describe each required and optional parameter shown in the syntax and provide additional details such as valid values.

To enter a command into the command line, copy the syntax shown in the *Usage* section at the prompt, except where the following symbols and formats appear in the syntax, in which case, follow the convention described here:

| Symbol or Format | Meaning |
| --- | --- |
| `[]` | These square brackets denote optional parameter(s) and/or argument(s). When you see these square brackets, any parameters and/or arguments within the brackets are optional and the command is valid without them. You can and should include them if they are needed for your use case. Do not type the square bracket symbols into the command line. |
| `\|` | This bar symbol separates mutually exclusive options. When you see this bar symbol, enter only one of the options that are separated by the bar. Do not type the bar symbol into the command line. > [!NOTE] > Note > > If there is a very large array of values, you will not see them all in the command syntax. Instead, you will see a single uppercase text value that represents the argument. The valid values are provided in the parameter description in the *Required Parameters* or the *Options* section for the valid values. |
| `UPPERCASE` | Uppercase text represents an argument that you supply. When you see uppercase text outside of an array of options, replace the uppercase text by a value appropriate to your use case. For an explanation of valid format and range, see the relevant parameter description in the *Required Parameters* or the *Options* section. If you see an array of mutually exclusive options in uppercase text, the uppercase text is usually the value itself that you can enter as it is in uppercase and not a value that should be replaced with a string or integer of your own choice. For clarity in a specific case, see the parameter description in the *Required Parameters* or the *Options* section. |
| `{}` | These curly brackets group together expressions in order to prevent ambiguity. Do not type the curly bracket symbols into the command line. |