Conventions

These style and syntax conventions are used in Sybase® documentation.

Style conventions

Key Definition
monospaced(fixed-width)
  • SQL and program code
  • Commands to be entered exactly as shown
  • File names
  • Directory names
italic monospaced In SQL or program code snippets, placeholders for user-specified values (see example below).
italic
  • File and variable names
  • Cross-references to other topics or documents
  • In text, placeholders for user-specified values (see example below)
  • Glossary terms in text
bold san serif
  • Command, function, stored procedure, utility, class, and method names
  • Glossary entries (in the Glossary)
  • Menu option paths
  • In numbered task or procedure steps, user-interface (UI) elements that you click, such as buttons, check boxes, icons, and so on

If necessary, an explanation for a placeholder (system- or setup-specific values) follows in text. For example:

Run:
installation directory\start.bat

where installation directory is where the application is installed.

Syntax conventions

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.
... An ellipsis (three dots) means you may repeat the last unit as many times as you need. Do not include ellipses in the command.

Case-sensitivity

Terminology

Replication Agent™ is a generic term used to describe the Replication Agents for Adaptive Server® Enterprise, Oracle, IBM DB2 UDB, and Microsoft SQL Server. The specific names are:
  • RepAgent – Replication Agent thread for Adaptive Server Enterprise
  • Replication Agent for Oracle
  • Replication Agent for Microsoft SQL Server
  • Replication Agent for UDB – for IBM DB2 on Linux, Unix, and Windows