Gluster 3.2: Documentation Conventions
From GlusterDocumentation
The following table lists the formatting conventions that are used in this guide to make it easier for you to recognize and use specific types of information.
| Convention | Description | Example |
|---|---|---|
| Italicized Text | Within a command, italicized text represents variables, which must be substituted with specific values. | gluster volume start volname |
| Square Brackets | Within a command, optional parameters are shown in square brackets. | gluster volume start volname [force] |
| Curly Brackets | Within a command, alternative parameters are grouped within curly brackets and separated by the vertical OR bar. | gluster volume { start / stop / delete } volname |
| ☺ ☺ | Within a heading, two smiley symbols indicates new feature. | Directory Quota ☺ ☺ |
