These style and syntax conventions are used in Sybase® documentation.
| Name | Example |
|---|---|
| Files, directories | econnect\ServerName\cfg |
| Programs, utilities, procedures, commands | the set statement |
| Properties | Allocate |
| Options | connect |
| Code examples, text on screens | ** Prepare the statement |
| Variables in command line displays (integer, in this example) | ClientIdleTimeout=integer |
| Syntax statements that display options for a command |
sp_columns table_name [, table_owner][, table_qualifier][, column_name] |
| Key | Definition |
|---|---|
| { } | Curly braces indicate that you must choose at least one of the enclosed options. Do not type the braces when you enter the command. |
| [ ] | Brackets mean that choosing one or more of the enclosed options is optional. Do not type the brackets when you enter the command. |
| ( ) | Parentheses are to be typed as part of the command. |
| | | The vertical bar means you can select only one of the options shown. |
| , | The comma means you can choose as many of the options shown as you like, separating your choices with commas that you type as part of the command. |