---
title: Preface
slug: ps/help/en_us/vtm/softwaregs/preface
docTags: 
createdAt: 2026-08-02T09:17:12.013Z
---

## Document conventions

The document conventions describe text formatting conventions, command syntax conventions, and important notice formats used in Ivanti technical documentation.

### Text formatting conventions

Text formatting conventions such as boldface, italic, or Courier font may be used in the flow of the text to highlight specific words or phrases.

| Format        | Description                                           |
| ------------- | ----------------------------------------------------- |
| **bold text** | Identifies command names                              |
|               | Identifies keywords and operands                      |
|               | Identifies the names of user-manipulated GUI elements |
|               | Identifies text to enter at the GUI                   |
| *italic text* | Identifies emphasis                                   |
|               | Identifies variables                                  |
|               | Identifies document titles                            |
| Courier Font  | Identifies command output                             |
|               | Identifies command syntax examples                    |

### Command syntax conventions

Bold and italic text identify command syntax components. Delimiters and operators define groupings of parameters and their logical relationships.

| Convention                   | Description                                                                                                                                                             |
| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **bold text**                | Identifies command names, keywords, and command options.                                                                                                                |
| *italic text*                | Identifies a variable.                                                                                                                                                  |
| \[ ]                         | Syntax components displayed within square brackets are optional.<br />Default responses to system prompts are enclosed in square brackets.                              |
| \{ **x** \| **y** \| **z** } | A choice of required parameters is enclosed in curly brackets separated by vertical bars. You must select one of the options.                                           |
| **x** \| **y**               | A vertical bar separates mutually exclusive elements.                                                                                                                   |
| \< >                         | Non-printing characters, for example, passwords, are enclosed in angle brackets.                                                                                        |
| ...                          | Repeat the previous element, for example, member\[member...].                                                                                                           |
| \\                           | Indicates a “soft” line break in command examples. If a backslash separates two lines of a command input, enter the entire command at the prompt without the backslash. |

### Notes and Warnings

Note, Attention, and Caution statements might be used in this document.

:::hint{type="info"}
A Note provides a tip, guidance, or advice, emphasizes important information, or provides a reference to related information.
:::

**Attention**

An Attention statement indicates a stronger note, for example, to alert you when traffic might be interrupted or the device might reboot.

**Caution**

A Caution statement alerts you to situations that can be potentially hazardous to you or cause damage to hardware, firmware, software, or data.