About this book

Conventions

This section describes the following:

Style Conventions

The following table shows some of the style conventions used in the documentation for this product.

Table 0-2: Style conventions
Item	Example
Programs Utilities Procedures Commands	create connection
File names Directory names Properties	install.cfg
Code examples	input com.sybase.ai.utils
User input Command line input	shutdown
Variables (place-holder text that you replace with the appropriate value)	host_name

The following example illustrates some of the syntax conventions used in this guide:

COMMAND [object_name, [ {TRUE | FALSE} ] ]

The following table explains the syntax conventions used in this guide.

Table 0-3: Syntax conventions
Symbol	Explanation	Example
( )	Include parentheses as part of the command.	START DATABASE (database_name)
\|	A vertical bar indicates that you can select only one of the options shown. Do not type the bar in your command.	{yes\|no}
,	A comma indicates that you can choose one or more of the options shown. Separate each choice by using a comma as part of the command.	{long,short,none}
{ }	Braces indicate that you must choose one or more of the enclosed options. Do not type the braces when you enter the option.	Select only one: {datetime\|datetime4}
Select at least one: {char_iso,char_eur, char_jis}
[ ]	Brackets indicate that you can choose one or more of the enclosed options, or none. Do not type the brackets when you enter the options.	[truncate]
...	An ellipsis indicates that you can repeat the previous item as many times as necessary.	{datax,datay }...