This section lists the conventions used in this documentation.
Operating systemsSQL Anywhere runs on a variety of platforms. Typically, the behavior of the software is the same on all platforms, but there are variations or limitations. These 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 a variety of 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.
Directory and file namesUsually 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 are the conventions used to simplify the documentation of directory and file names:
Uppercase and lowercase directory names On Windows and Unix, directory and file names may contain uppercase and lowercase letters. When directories and files are created, the file system preserves letter case.
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. The SQL Anywhere installation contains directories such as Bin32 and Documentation.
On Unix, references to directories and files are case sensitive. Mixed case directory and file names are not common. Most use all lowercase letters. The SQL Anywhere installation contains directories such as bin32 and documentation.
The documentation uses the Windows forms of directory names. You can usually convert a mixed case directory name to lowercase for the equivalent directory name on Unix.
Slashes separating directory and file names The documentation uses backslashes as the directory separator. For example, the PDF form of the documentation is found in install-dir\Documentation\en\PDF (Windows form).
On Unix, replace the backslash with the forward slash. The PDF documentation is found in install-dir/documentation/en/pdf.
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.
install-dir During the installation process, you choose where to install SQL Anywhere. The environment variable SQLANY12 is created and refers to this location. The documentation refers to this location as install-dir.
For example, the documentation may refer to the file install-dir/readme.txt. On Windows, this is equivalent to %SQLANY12%\readme.txt. On Unix, this is equivalent to $SQLANY12/readme.txt or ${SQLANY12}/readme.txt.
For more information about the default location of install-dir, see SQLANY12 environment variable.
samples-dir During the installation process, you choose where to install the samples included with SQL Anywhere. The environment variable SQLANYSAMP12 is created and refers to this location. The documentation refers to this location as samples-dir.
To open a Windows Explorer window in samples-dir, choose Start » Programs » SQL Anywhere 12 » Sample Applications And Projects.
For more information about the default location of samples-dir, see SQLANYSAMP12 environment variable.
Command prompts and command shell syntaxMost operating systems provide one or more methods of entering commands and parameters using a command shell or command prompt. Windows command prompts include Command Prompt (DOS prompt) and 4NT. Unix command shells include Korn shell and bash. Each shell has features that extend its capabilities beyond simple commands. These features are driven by special characters. The special characters and features vary from one shell to another. Incorrect use of these special characters often results in syntax errors or unexpected behavior.
The documentation provides command line examples in a generic form. If these examples contain characters that the shell considers special, the command may require 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.
These are some examples of command line syntax that may vary between platforms:
Parentheses and curly braces Some command line options require a parameter that accepts detailed value specifications in a list. The list is usually enclosed with parentheses or curly braces. The documentation uses parentheses. For example:
-x tcpip(host=127.0.0.1) |
Where parentheses cause syntax problems, substitute curly braces:
-x tcpip{host=127.0.0.1} |
If both forms result in syntax problems, the entire parameter should be enclosed in quotes as required by the shell:
-x "tcpip(host=127.0.0.1)" |
Semicolons On Unix, semicolons should be enclosed in quotes.
Quotes If you must specify quotes in a parameter value, the quotes may conflict with the traditional use of quotes to enclose the parameter. For example, to specify an encryption key whose value contains double-quotes, you might have to 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.
Environment variables The documentation refers to setting environment variables. In Windows shells, environment variables are specified using the syntax %ENVVAR%. In Unix shells, environment variables are specified using the syntax $ENVVAR or ${ENVVAR}.
 |
Send feedback about this page using email. | Copyright © 2010, iAnywhere Solutions, Inc. - SQL Anywhere 12.0.0 |