Prev Next InstallUnix

Unix Installation and Testing

Download OMhelp
Download the current version of the file OMhelp.unix.tar.gz

Create Distribution Directory
Use the command 
 
	tar -xvzf OMhelp.unix.tar.gz
to decompress and extract the unix format version into the distribution directory
     omhelp-yy-mm-dd
The value yy-mm-dd is the corresponding version of OMhelp.

Configure
Enter the distribution directory and execute the command:
     ./configure [ --prefix=prefix ] [ VIMRUNTIME=vim_runtime ]
where the entries between the brackets [ and ] are optional, the brackets are not included, and the word in italic is replaced by the value you chose. The OMhelp utility files will be stored in the directory
     prefix/share/OMhelp

prefix
The default value for prefix is $HOME; i.e., by default the OMhelp executable is installed in 
 
	$HOME/bin/omhelp
If prefix/bin is not in your path, you will have to specify the entire path for omhelp when you execute it. The data files used by OMhelp are installed in
     $HOME/share/OMhelp

vim_runtime
If the command line argument vim_runtime is specified, it is the directory where the vim editor is looking for its runtime files. You can determine this directory on your system by executing the commands 
 
	vim
	:echo $VIMRUNTIME
If you specify this argument on the configure command line, after the install omhelp step, the vim commands 
 
	:syntax on
	:set syntax=omhelp
will turn on OMhelp syntax highlighting for the file you are currently editing. If your OMhelp commands are embedded in a C source code file, you could convert back to C highlighting by executing the command 
 
	:set syntax=c
To get a listing of the available syntax assignment values, execute the follow command
     ls vim_runtime/syntax | sed -e 's/.vim$//'
You may also want to automatically set OMhelp syntax highlighting for files that end with the extension .omh. You can do this by placing the following text in the file .vimrc in your home directory: 
 
	:syntax on
	au BufRead,BufNewFile *.omh setfiletype omhelp


Build Executable and Documentation
In the distribution directory, execute the following command: 
 
	make
This should create the following files and sub-directories of the distribution directory:
src/omhelp OMhelp executable program
OMhelp/dictionary.bin OMhelp binary dictionary
Doc user documentation directory
Doc developer documentation directory
(If you are using Cygwin or MinGw, the file src/omhelp may possibly be src/omhelp.exe.) The Doc sub-directory of the distribution directory contains the user documentation for OMhelp. The files Doc/*.htm are in HTML format. If your browser supports XHTML+MathML format, an easier to read copy is available in the files Doc/*.xml.

Install OMhelp
In the distribution directory, execute the following command: 
 
	make install


Dictionary
OMhelp utility files are stored in the OMhelp subdirectory of the distribution directory. This directory must contains the files 
 
	OMhelp/english.wrd
	OMhelp/local.wrd
If the file dictionary.bin is not present, OMhelp will to creates a new dictionary that combines english.wrd and local.wrd (the file local.wrd is optional) to form 
 
	OMhelp/dictionary.bin
The words in english.wrd and local.wrd must be in alphabetic order, lower case, and contain only letters with one per line. For example, 
 
	a
	aardvark
	aardvarks
	...
If you make any changes to english.wrd or local.wrd, the file dictionary.bin should be deleted. A new dictionary.bin that combines the words english.wrd and local.wrd will be created and installed by following the installation steps: 
 
	make
	make install
This will create the new dictionary and copy it to
     prefix/share/OMhelp

Getting Started
You can build the multiple_example_1 subtree of the OMhelp user documentation by executing the following commands starting in the distribution directory
     cd omh/getstarted
     mkdir htm
     cd htm
     rm *.htm
     omhelp ../multiple_example_1.omh
Note that the mkdir and rm commands will report errors if they are unnecessary. See the get_started section for more examples.
Input File: installunix.omh