This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
appendix:reference:envvar:reserved [2011/03/15 15:37] els |
appendix:reference:envvar:reserved [2016/06/28 22:38] (current) |
||
|---|---|---|---|
| Line 2: | Line 2: | ||
| - | ====== Appendix: Environment Variables ====== | + | ====== Appendix: Reference ====== |
| - | ===== Topic ===== | + | ===== Environment Variables ===== |
| [[appendix:reference:envvar:home|Overview]] | | [[appendix:reference:envvar:home|Overview]] | | ||
| [[appendix:reference:envvar:variables|Environment Variables]] | | [[appendix:reference:envvar:variables|Environment Variables]] | | ||
| [[appendix:reference:envvar:shell|Shell Scripts]] | | [[appendix:reference:envvar:shell|Shell Scripts]] | | ||
| - | [[appendix:reference:envvar:locations|Locations]] | | + | [[appendix:reference:envvar:uses|Uses]] | |
| **[[appendix:reference:envvar:reserved|Reserved Variables]]** | **[[appendix:reference:envvar:reserved|Reserved Variables]]** | ||
| Line 22: | Line 22: | ||
| == PATH == | == PATH == | ||
| - | PATH points to the directory where the Omnidex executables reside. This variable is a system variable, and is not Omnidex-specific. The system PATH variable is likely to contain other paths. Be sure not to override the existing setting by appending the Omnidex executable path to the end of the existing setting. | + | PATH points to the directory where the Omnidex executables reside. This variable is a system variable, and is not Omnidex-specific. The PATH variable is likely to contain other paths. To ensure that existing settings are not overridden, append the setting to the existing value. |
| If the PATH is not set, users will either be required to run all Omnidex executables from the directory in which the executable resides or must pass the fully qualified path to the executable. | If the PATH is not set, users will either be required to run all Omnidex executables from the directory in which the executable resides or must pass the fully qualified path to the executable. | ||
| Line 34: | Line 34: | ||
| == LD_LIBRARY_PATH == | == LD_LIBRARY_PATH == | ||
| - | LD_LIBRARY_PATH points to the directory where shared libraries reside. This variable is a system variable, and is not Omnidex-specific. LD_LIBRARY_PATH is only used on UNIX operating systems. | + | LD_LIBRARY_PATH points to the directory where shared libraries reside. This variable is a system variable, and is not Omnidex-specific. The LD_LIBRARY_PATH variable is likely to contain other paths. To ensure that existing settings are not overridden, append the setting to the existing value. LD_LIBRARY_PATH is only used on UNIX operating systems. |
| UNIX | UNIX | ||
| export LD_LIBRARY_PATH="/omnidex/lib" | export LD_LIBRARY_PATH="/omnidex/lib" | ||
| - | == TMPDIR == | + | == CLASSPATH == |
| - | TMPDIR points to a directory where Omnidex temporary files are built. This variable is not Omnidex-specific on UNIX, but is not frequently used on Microsoft Windows. | + | |
| - | It is recommended that TMPDIR be set to a directory with plenty of available disk space, especially when building Omnidex indexes. It is also recommended that TMPDIR be placed on a separate drive, and preferably a separate disk controller, from the underlying data and the Omnidex index files. | + | CLASSPATH points to the directory where the Omnidex.jar file resides and is required for Java development on all platforms. This variable is a system variable, and is not Omnidex-specific. The CLASSPATH variable is likely to contain other paths. To ensure that existing settings are not overridden, append the setting to the existing value. |
| + | |||
| + | Omnidex.jar is located in the bin subdirectory of the Omnidex root directory on the server, and in the lib subdirectory of the Omnidex Client root directory on the client machine. | ||
| UNIX | UNIX | ||
| - | export TMPDIR="/temp" | + | export CLASSPATH="/omnidex/bin/Omnidex.jar:$CLASSPATH" |
| Windows | Windows | ||
| - | set TMPDIR=d:\temp | + | set CLASSPATH="c:\Program Files\Omnidex 5.1\bin\Omnidex.jar";%CLASSPATH% |
| - | == CLASSPATH == | + | == TMPDIR == |
| + | TMPDIR points to a directory where Omnidex temporary files are built. On UNIX, this system variable governs the directory for temporary files for all process, not just Omnidex; however, this variable is not commonly used on Microsoft Windows. Omnidex uses this variable on both UNIX and Microsoft Windows. | ||
| - | CLASSPATH points to the directory where the Omnidex.jar file resides and is required for Java development on all platforms. This variable is a system variable, and is not Omnidex-specific. The system CLASSPATH variable is likely to contain other paths. Be sure not to override the existing setting by appending the Omnidex executable path to the end of the existing setting. | + | It is recommended that TMPDIR be set to a directory with plenty of available disk space, especially when building Omnidex indexes. It is also recommended that TMPDIR be placed on a separate drive, and preferably a separate disk controller, from the underlying data and the Omnidex index files. |
| - | + | ||
| - | Omnidex.jar is located in the bin subdirectory of the Omnidex root directory on the server, and in the lib subdirectory of the Omnidex Client root directory on the client machine. | + | |
| UNIX | UNIX | ||
| - | export CLASSPATH="/omnidex/bin/Omnidex.jar:$CLASSPATH" | + | export TMPDIR="/temp" |
| Windows | Windows | ||
| - | set CLASSPATH="c:\Program Files\Omnidex 5.1\bin\Omnidex.jar";%CLASSPATH% | + | set TMPDIR=d:\temp |
| === Required Environment Variables === | === Required Environment Variables === | ||
| + | |||
| + | The following environment variables must be set for Omnidex to function properly. | ||
| == OMNIDEX_HOME == | == OMNIDEX_HOME == | ||
| Line 75: | Line 77: | ||
| === Configuration Environment Variables === | === Configuration Environment Variables === | ||
| + | |||
| + | The following environment variables are optional and can be used to configure the behavior of Omnidex. | ||
| == OMNIDEX_DEBUG == | == OMNIDEX_DEBUG == | ||
| Line 95: | Line 99: | ||
| {{page>dev:appendix:reference:date_tokens_insert&noheader&nofooter&noeditbtn}} | {{page>dev:appendix:reference:date_tokens_insert&noheader&nofooter&noeditbtn}} | ||
| - | + | ||
| + | The following example establishes the default format for dates: | ||
| + | |||
| + | UNIX | ||
| + | export OMNIDEX_DATE_FORMAT="MMM D, YYYY" | ||
| + | |||
| + | Windows | ||
| + | set OMNIDEX_DATE_FORMAT="MMM D, YYYY" | ||
| + | |||
| + | <code> | ||
| + | > select birthdate from individuals; | ||
| + | |||
| + | BIRTHDATE | ||
| + | ------------------- | ||
| + | July 14, 1938 | ||
| + | November 22, 1957 | ||
| + | July 28, 1960 | ||
| + | August 22, 1929 | ||
| + | July 9, 1933 | ||
| + | August 1, 1944 | ||
| + | September 14, 2004 | ||
| + | </code> | ||
| == ODXSQLINIT == | == ODXSQLINIT == | ||
| - | == ODXSQLHISTORY == | + | The ODXSQLINIT variable points to an [[programs:odxsql:init|initialization file]] used by the OdxSQL Program. This initialization file contains OdxSQL statements to be run when OdxSQL is launched. Typically, these statements are SET commands; however, any OdxSQL commands are allowed. |
| + | |||
| + | UNIX | ||
| + | export ODXSQLINIT="/class/.odxsqlinit" | ||
| + | |||
| + | Windows | ||
| + | set ODXSQLINIT=d:\class\.odxsqlinit" | ||
| + | |||
| + | == ODXSQLHIST == | ||
| + | |||
| + | The ODXSQLHIST variable points to a [[programs:odxsql:history|history file]] used by the OdxSQL Program. This history file contains statements that have been run in the OdxSQL program. Note that if multiple sessions point to the same file, their statements will all be written to the same file. | ||
| + | |||
| + | UNIX | ||
| + | export ODXSQLHIST="/class/.odxsql_history" | ||
| + | |||
| + | Windows | ||
| + | set ODXSQLHIST=d:\class\.odxsql_history" | ||
| ===== ===== | ===== ===== | ||
| - | **[[appendix:reference:envvar:locations|Prev]]** | + | **[[appendix:reference:envvar:uses|Prev]]** |
| ====== Additional Resources ====== | ====== Additional Resources ====== | ||