This section lists the conventions used in this documentation.
SQL Anywhere runs on many platforms. Typically, the behavior of the software is the same on all platforms, but there are variations or limitations. These limitations are commonly based on the underlying operating system (Windows, Unix), and seldom on the particular variant (IBM AIX, Windows Mobile) or version.
To simplify references to operating systems, the documentation groups the supported operating systems as follows:
Windows The Microsoft Windows family includes platforms that are used primarily on server, desktop, and laptop computers, as well as platforms used on mobile devices. Unless otherwise specified, when the documentation refers to Windows, it refers to all supported Windows-based platforms, including Windows Mobile.
Windows Mobile is based on the Windows CE operating system, which is also used to build various platforms other than Windows Mobile. Unless otherwise specified, when the documentation refers to Windows Mobile, it refers to all supported platforms built using Windows CE.
Unix Unless otherwise specified, when the documentation refers to Unix, it refers to all supported Unix-based platforms, including Linux and Mac OS X.
For the complete list of platforms supported by SQL Anywhere, see Supported platforms.
Usually references to directory and file names are similar on all supported platforms, with simple transformations between the various forms. In these cases, Windows conventions are used. Where the details are more complex, the documentation shows all relevant forms.
These conventions are used to simplify the documentation of directory and file names:
Uppercase and lowercase directory names On Windows and Unix, directory and file names can contain uppercase and lowercase letters.
On Windows, references to directories and files are not case sensitive. Mixed case directory and file names are common, but it is common to refer to them using all lowercase letters.
On Unix, references to directories and files are case sensitive. Mixed case directory and file names are not common. Most use all lowercase letters.
Slashes separating directory and file names The documentation uses backslashes (\) as the directory separator. On Unix, replace the backslash with the forward slash (/).
Executable files The documentation shows executable file names using Windows conventions, with a suffix such as .exe or .bat. On Unix, executable file names have no suffix.
For example, on Windows, the network database server is dbsrv12.exe. On Unix, it is dbsrv12.
The documentation provides command line examples in a generic form. If these examples contain characters that the shell considers special, the command requires modification for the specific shell. The modifications are beyond the scope of this documentation, but generally, use quotes around the parameters containing those characters or use an escape character before the special characters.
Parentheses and curly braces Some command line options require a parameter that accepts detailed value specifications in a list. The list is enclosed with parentheses or curly braces. The documentation uses parentheses. For example:
Where parentheses cause syntax problems, substitute curly braces:
If both forms result in syntax problems, enclose the entire parameter in quotes as required by the shell:
Quotes If you must specify quotes in a parameter value, the quotes can conflict with the traditional use of quotes to enclose the parameter. For example, to specify an encryption key whose value contains double quotes, you can enclose the key in quotes and then escape the embedded quote:
-ek "my \"secret\" key"
In many shells, the value of the key would be
my "secret" key.
Discuss this page in DocCommentXchange.
|Copyright © 2012, iAnywhere Solutions, Inc. - SQL Anywhere 12.0.1|