Installation

Prerequisites:

• Microsoft Visual Studio 2022 Community Edition version 17.14.30 or later with Desktop Development with C++ tool chain installed.

Do the following steps:

• Extract the soul-5.1.0.zip package to a directory of your choice. In these instructions it is expected that the package is extracted to the C:\ root directory so that the instalation directory is C:\soul.5.1.0.
• Create SOUL_ROOT environment variable and set it to contain path to the soul-5.1.0 installation directory:
  
  
  
• Create bin and lib directories under the soul-5.1.0 installation directory:
  • Start a terminal in C:\soul-5.1.0 directory.
  • Execute md bin and md lib commands:
    Microsoft Windows [Version 10.0.26200.8246]
    (c) Microsoft Corporation. All rights reserved.
    
    C:\soul-5.1.0>md bin
    
    C:\soul-5.1.0>md lib
    
    C:\soul-5.1.0>
    
• Add the bin directory to PATH environment variable:
  
  
• Open the x64 Native Toools Command Prompt:
  
  
  **********************************************************************<
  ** Visual Studio 2022 Developer Command Prompt v17.14.30
  ** Copyright (c) 2025 Microsoft Corporation
  **********************************************************************
  [vcvarsall.bat] Environment initialized for: 'x64'
  
  C:\Program Files\Microsoft Visual Studio\2022\Community>
  
• Change to the C:\soul-5.1.0\ext\zlib-1.2.11\contrib\masmx64 directory:
  
  C:\Program Files\Microsoft Visual Studio\2022\Community>cd \soul-5.1.0\ext\zlib-1.2.11\contrib\masmx64
  
  C:\soul-5.1.0\ext\zlib-1.2.11\contrib\masmx64>
  
• Run bld_ml64.bat:
  
  C:\soul-5.1.0\ext\zlib-1.2.11\contrib\masmx64>bld_ml64.bat
  
  C:\soul-5.1.0\ext\zlib-1.2.11\contrib\masmx64>ml64.exe /Flinffasx64 /c /Zi inffasx64.asm
  Microsoft (R) Macro Assembler (x64) Version 14.44.35225.0
  Copyright (C) Microsoft Corporation. All rights reserved.
  
  Assembling: inffasx64.asm
  
  C:\soul-5.1.0\ext\zlib-1.2.11\contrib\masmx64>ml64.exe /Flgvmat64 /c /Zi gvmat64.asm
  Microsoft (R) Macro Assembler (x64) Version 14.44.35225.0
  Copyright (C) Microsoft Corporation. All rights reserved.
  
  Assembling: gvmat64.asm
  
  C:\soul-5.1.0\ext\zlib-1.2.11\contrib\masmx64>
  
• Open C:\soul-5.1.0\soul.sln in Visual Studio.
• Select the Debug|x64 configuration and build the solution.
• Select the Release|x64 configuration and build the solution.
• Search for x64 Native Toools Command Prompt, right-click its icon and select Open file location:
  
• Right-click the x64 Native Toools Command Prompt icon and select Properties..:
  
  
• Select the Target path and copy it to clipboard:
  
  
• Open C:\soul-5.1.0\config\otava.config file to a text editor such as notepad or notepad++.
  

• Paste the target path from clipboard as the value of the path attribute of the vcvars64 element:
  
  
  

  The vcvars64 path is used by the Otava compiler to start Visual Studio Developer Command Prompt.

• Open terminal in C:\soul-5.1.0\inst directory and run inst.bat:
  Microsoft Windows [Version 10.0.26200.8246]
  (c) Microsoft Corporation. All rights reserved.
  
  C:\soul-5.1.0\inst>inst
  ..\x64\Release\soul_inst.exe
  1 File(s) copied
  C:/soul-5.1.0/x64/Debug/book_serverd.exe -> C:/soul-5.1.0/bin/book_serverd.exe
  C:/soul-5.1.0/x64/Debug/cpp2htmld.exe -> C:/soul-5.1.0/bin/cpp2htmld.exe
  C:/soul-5.1.0/x64/Debug/eslgd.exe -> C:/soul-5.1.0/bin/eslgd.exe
  C:/soul-5.1.0/x64/Debug/espgd.exe -> C:/soul-5.1.0/bin/espgd.exe
  C:/soul-5.1.0/x64/Debug/fruits.exe -> C:/soul-5.1.0/bin/fruits.exe
  C:/soul-5.1.0/x64/Debug/gendocd.exe -> C:/soul-5.1.0/bin/gendocd.exe
  C:/soul-5.1.0/x64/Debug/hexdumpd.exe -> C:/soul-5.1.0/bin/hexdumpd.exe
  C:/soul-5.1.0/x64/Debug/ixx2cppmd.exe -> C:/soul-5.1.0/bin/ixx2cppmd.exe
  C:/soul-5.1.0/x64/Debug/jsonpd.exe -> C:/soul-5.1.0/bin/jsonpd.exe
  C:/soul-5.1.0/x64/Debug/jsonrpccd.exe -> C:/soul-5.1.0/bin/jsonrpccd.exe
  C:/soul-5.1.0/x64/Debug/jsonrpcsd.exe -> C:/soul-5.1.0/bin/jsonrpcsd.exe
  C:/soul-5.1.0/x64/Debug/make_soul_ucdd.exe -> C:/soul-5.1.0/bin/make_soul_ucdd.exe
  C:/soul-5.1.0/x64/Debug/minilangd.exe -> C:/soul-5.1.0/bin/minilangd.exe
  C:/soul-5.1.0/x64/Debug/msd.exe -> C:/soul-5.1.0/bin/msd.exe
  C:/soul-5.1.0/x64/Debug/ocd.exe -> C:/soul-5.1.0/bin/ocd.exe
  C:/soul-5.1.0/x64/Debug/ref2htmld.exe -> C:/soul-5.1.0/bin/ref2htmld.exe
  C:/soul-5.1.0/x64/Debug/slgd.exe -> C:/soul-5.1.0/bin/slgd.exe
  C:/soul-5.1.0/x64/Debug/slines.exe -> C:/soul-5.1.0/bin/slines.exe
  C:/soul-5.1.0/x64/Debug/soul2htmld.exe -> C:/soul-5.1.0/bin/soul2htmld.exe
  C:/soul-5.1.0/x64/Debug/soul_expected.dom_parser_testd.exe -> C:/soul-5.1.0/bin/soul_expected.dom_parser_testd.exe
  C:/soul-5.1.0/x64/Debug/soul_instd.exe -> C:/soul-5.1.0/bin/soul_instd.exe
  C:/soul-5.1.0/x64/Debug/spgd.exe -> C:/soul-5.1.0/bin/spgd.exe
  C:/soul-5.1.0/x64/Debug/uuid_test.exe -> C:/soul-5.1.0/bin/uuid_test.exe
  C:/soul-5.1.0/x64/Debug/xmlsergend.exe -> C:/soul-5.1.0/bin/xmlsergend.exe
  C:/soul-5.1.0/x64/Debug/xml_parser_testd.exe -> C:/soul-5.1.0/bin/xml_parser_testd.exe
  C:/soul-5.1.0/x64/Debug/xpath_expected_testd.exe -> C:/soul-5.1.0/bin/xpath_expected_testd.exe
  C:/soul-5.1.0/x64/Debug/xpath_testd.exe -> C:/soul-5.1.0/bin/xpath_testd.exe
  C:/soul-5.1.0/x64/Release/book_server.exe -> C:/soul-5.1.0/bin/book_server.exe
  C:/soul-5.1.0/x64/Release/cpp2html.exe -> C:/soul-5.1.0/bin/cpp2html.exe
  C:/soul-5.1.0/x64/Release/eslg.exe -> C:/soul-5.1.0/bin/eslg.exe
  C:/soul-5.1.0/x64/Release/espg.exe -> C:/soul-5.1.0/bin/espg.exe
  C:/soul-5.1.0/x64/Release/fruits.exe -> C:/soul-5.1.0/bin/fruits.exe
  C:/soul-5.1.0/x64/Release/gendoc.exe -> C:/soul-5.1.0/bin/gendoc.exe
  C:/soul-5.1.0/x64/Release/hexdump.exe -> C:/soul-5.1.0/bin/hexdump.exe
  C:/soul-5.1.0/x64/Release/ixx2cppm.exe -> C:/soul-5.1.0/bin/ixx2cppm.exe
  C:/soul-5.1.0/x64/Release/jsonp.exe -> C:/soul-5.1.0/bin/jsonp.exe
  C:/soul-5.1.0/x64/Release/jsonrpcc.exe -> C:/soul-5.1.0/bin/jsonrpcc.exe
  C:/soul-5.1.0/x64/Release/jsonrpcs.exe -> C:/soul-5.1.0/bin/jsonrpcs.exe
  C:/soul-5.1.0/x64/Release/make_soul_ucd.exe -> C:/soul-5.1.0/bin/make_soul_ucd.exe
  C:/soul-5.1.0/x64/Release/minilang.exe -> C:/soul-5.1.0/bin/minilang.exe
  C:/soul-5.1.0/x64/Release/ms.exe -> C:/soul-5.1.0/bin/ms.exe
  C:/soul-5.1.0/x64/Release/oc.exe -> C:/soul-5.1.0/bin/oc.exe
  C:/soul-5.1.0/x64/Release/ref2html.exe -> C:/soul-5.1.0/bin/ref2html.exe
  C:/soul-5.1.0/x64/Release/slg.exe -> C:/soul-5.1.0/bin/slg.exe
  C:/soul-5.1.0/x64/Release/slines.exe -> C:/soul-5.1.0/bin/slines.exe
  C:/soul-5.1.0/x64/Release/soul2html.exe -> C:/soul-5.1.0/bin/soul2html.exe
  C:/soul-5.1.0/x64/Release/soul_expected.dom_parser_test.exe -> C:/soul-5.1.0/bin/soul_expected.dom_parser_test.exe
  C:/soul-5.1.0/x64/Release/soul_inst.exe -> C:/soul-5.1.0/bin/soul_inst.exe
  C:/soul-5.1.0/x64/Release/spg.exe -> C:/soul-5.1.0/bin/spg.exe
  C:/soul-5.1.0/x64/Release/uuid_test.exe -> C:/soul-5.1.0/bin/uuid_test.exe
  C:/soul-5.1.0/x64/Release/xmlsergen.exe -> C:/soul-5.1.0/bin/xmlsergen.exe
  C:/soul-5.1.0/x64/Release/xml_parser_test.exe -> C:/soul-5.1.0/bin/xml_parser_test.exe
  C:/soul-5.1.0/x64/Release/xpath_expected_test.exe -> C:/soul-5.1.0/bin/xpath_expected_test.exe
  C:/soul-5.1.0/x64/Release/xpath_test.exe -> C:/soul-5.1.0/bin/xpath_test.exe
  C:/soul-5.1.0/x64/Debug/ortd.lib -> C:/soul-5.1.0/lib/ortd.lib
  C:/soul-5.1.0/x64/Debug/otava.assemblyd.lib -> C:/soul-5.1.0/lib/otava.assemblyd.lib
  C:/soul-5.1.0/x64/Debug/otava.astd.lib -> C:/soul-5.1.0/lib/otava.astd.lib
  C:/soul-5.1.0/x64/Debug/otava.buildd.lib -> C:/soul-5.1.0/lib/otava.buildd.lib
  C:/soul-5.1.0/x64/Debug/otava.codegend.lib -> C:/soul-5.1.0/lib/otava.codegend.lib
  C:/soul-5.1.0/x64/Debug/otava.intermediated.lib -> C:/soul-5.1.0/lib/otava.intermediated.lib
  C:/soul-5.1.0/x64/Debug/otava.lexerd.lib -> C:/soul-5.1.0/lib/otava.lexerd.lib
  C:/soul-5.1.0/x64/Debug/otava.optimizerd.lib -> C:/soul-5.1.0/lib/otava.optimizerd.lib
  C:/soul-5.1.0/x64/Debug/otava.parserd.lib -> C:/soul-5.1.0/lib/otava.parserd.lib
  C:/soul-5.1.0/x64/Debug/otava.ppd.lib -> C:/soul-5.1.0/lib/otava.ppd.lib
  C:/soul-5.1.0/x64/Debug/otava.symbolsd.lib -> C:/soul-5.1.0/lib/otava.symbolsd.lib
  C:/soul-5.1.0/x64/Debug/otava.tokend.lib -> C:/soul-5.1.0/lib/otava.tokend.lib
  C:/soul-5.1.0/x64/Debug/soul.astd.lib -> C:/soul-5.1.0/lib/soul.astd.lib
  C:/soul-5.1.0/x64/Debug/soul.commond.lib -> C:/soul-5.1.0/lib/soul.commond.lib
  C:/soul-5.1.0/x64/Debug/soul.cppd.lib -> C:/soul-5.1.0/lib/soul.cppd.lib
  C:/soul-5.1.0/x64/Debug/soul.json.rpcd.lib -> C:/soul-5.1.0/lib/soul.json.rpcd.lib
  C:/soul-5.1.0/x64/Debug/soul.jsond.lib -> C:/soul-5.1.0/lib/soul.jsond.lib
  C:/soul-5.1.0/x64/Debug/soul.lexd.lib -> C:/soul-5.1.0/lib/soul.lexd.lib
  C:/soul-5.1.0/x64/Debug/soul.lexerd.lib -> C:/soul-5.1.0/lib/soul.lexerd.lib
  C:/soul-5.1.0/x64/Debug/soul.module.mapd.lib -> C:/soul-5.1.0/lib/soul.module.mapd.lib
  C:/soul-5.1.0/x64/Debug/soul.parserd.lib -> C:/soul-5.1.0/lib/soul.parserd.lib
  C:/soul-5.1.0/x64/Debug/soul.red.lib -> C:/soul-5.1.0/lib/soul.red.lib
  C:/soul-5.1.0/x64/Debug/soul.rexd.lib -> C:/soul-5.1.0/lib/soul.rexd.lib
  C:/soul-5.1.0/x64/Debug/soul.tokend.lib -> C:/soul-5.1.0/lib/soul.tokend.lib
  C:/soul-5.1.0/x64/Debug/soul.xml.dom.parserd.lib -> C:/soul-5.1.0/lib/soul.xml.dom.parserd.lib
  C:/soul-5.1.0/x64/Debug/soul.xml.domd.lib -> C:/soul-5.1.0/lib/soul.xml.domd.lib
  C:/soul-5.1.0/x64/Debug/soul.xml.parserd.lib -> C:/soul-5.1.0/lib/soul.xml.parserd.lib
  C:/soul-5.1.0/x64/Debug/soul.xml.processord.lib -> C:/soul-5.1.0/lib/soul.xml.processord.lib
  C:/soul-5.1.0/x64/Debug/soul.xml.serializationd.lib -> C:/soul-5.1.0/lib/soul.xml.serializationd.lib
  C:/soul-5.1.0/x64/Debug/soul.xml.xpathd.lib -> C:/soul-5.1.0/lib/soul.xml.xpathd.lib
  C:/soul-5.1.0/x64/Debug/soul_expected.ast_expectedd.lib -> C:/soul-5.1.0/lib/soul_expected.ast_expectedd.lib
  C:/soul-5.1.0/x64/Debug/soul_expected.commond.lib -> C:/soul-5.1.0/lib/soul_expected.commond.lib
  C:/soul-5.1.0/x64/Debug/soul_expected.cppd.lib -> C:/soul-5.1.0/lib/soul_expected.cppd.lib
  C:/soul-5.1.0/x64/Debug/soul_expected.dom_parserd.lib -> C:/soul-5.1.0/lib/soul_expected.dom_parserd.lib
  C:/soul-5.1.0/x64/Debug/soul_expected.lexd.lib -> C:/soul-5.1.0/lib/soul_expected.lexd.lib
  C:/soul-5.1.0/x64/Debug/soul_expected.lexerd.lib -> C:/soul-5.1.0/lib/soul_expected.lexerd.lib
  C:/soul-5.1.0/x64/Debug/soul_expected.parserd.lib -> C:/soul-5.1.0/lib/soul_expected.parserd.lib
  C:/soul-5.1.0/x64/Debug/soul_expected.red.lib -> C:/soul-5.1.0/lib/soul_expected.red.lib
  C:/soul-5.1.0/x64/Debug/soul_expected.rexd.lib -> C:/soul-5.1.0/lib/soul_expected.rexd.lib
  C:/soul-5.1.0/x64/Debug/soul_expected.tokend.lib -> C:/soul-5.1.0/lib/soul_expected.tokend.lib
  C:/soul-5.1.0/x64/Debug/soul_expected.xml.domd.lib -> C:/soul-5.1.0/lib/soul_expected.xml.domd.lib
  C:/soul-5.1.0/x64/Debug/soul_expected.xml.processord.lib -> C:/soul-5.1.0/lib/soul_expected.xml.processord.lib
  C:/soul-5.1.0/x64/Debug/soul_expected.xml.xpathd.lib -> C:/soul-5.1.0/lib/soul_expected.xml.xpathd.lib
  C:/soul-5.1.0/x64/Debug/soul_expected.xml_parserd.lib -> C:/soul-5.1.0/lib/soul_expected.xml_parserd.lib
  C:/soul-5.1.0/x64/Debug/utild.lib -> C:/soul-5.1.0/lib/utild.lib
  C:/soul-5.1.0/x64/Debug/util_expectedd.lib -> C:/soul-5.1.0/lib/util_expectedd.lib
  C:/soul-5.1.0/x64/Debug/zlibstatd.lib -> C:/soul-5.1.0/lib/zlibstatd.lib
  C:/soul-5.1.0/x64/Release/ort.lib -> C:/soul-5.1.0/lib/ort.lib
  C:/soul-5.1.0/x64/Release/otava.assembly.lib -> C:/soul-5.1.0/lib/otava.assembly.lib
  C:/soul-5.1.0/x64/Release/otava.ast.lib -> C:/soul-5.1.0/lib/otava.ast.lib
  C:/soul-5.1.0/x64/Release/otava.build.lib -> C:/soul-5.1.0/lib/otava.build.lib
  C:/soul-5.1.0/x64/Release/otava.codegen.lib -> C:/soul-5.1.0/lib/otava.codegen.lib
  C:/soul-5.1.0/x64/Release/otava.intermediate.lib -> C:/soul-5.1.0/lib/otava.intermediate.lib
  C:/soul-5.1.0/x64/Release/otava.lexer.lib -> C:/soul-5.1.0/lib/otava.lexer.lib
  C:/soul-5.1.0/x64/Release/otava.optimizer.lib -> C:/soul-5.1.0/lib/otava.optimizer.lib
  C:/soul-5.1.0/x64/Release/otava.parser.lib -> C:/soul-5.1.0/lib/otava.parser.lib
  C:/soul-5.1.0/x64/Release/otava.pp.lib -> C:/soul-5.1.0/lib/otava.pp.lib
  C:/soul-5.1.0/x64/Release/otava.symbols.lib -> C:/soul-5.1.0/lib/otava.symbols.lib
  C:/soul-5.1.0/x64/Release/otava.token.lib -> C:/soul-5.1.0/lib/otava.token.lib
  C:/soul-5.1.0/x64/Release/soul.ast.lib -> C:/soul-5.1.0/lib/soul.ast.lib
  C:/soul-5.1.0/x64/Release/soul.common.lib -> C:/soul-5.1.0/lib/soul.common.lib
  C:/soul-5.1.0/x64/Release/soul.cpp.lib -> C:/soul-5.1.0/lib/soul.cpp.lib
  C:/soul-5.1.0/x64/Release/soul.json.lib -> C:/soul-5.1.0/lib/soul.json.lib
  C:/soul-5.1.0/x64/Release/soul.json.rpc.lib -> C:/soul-5.1.0/lib/soul.json.rpc.lib
  C:/soul-5.1.0/x64/Release/soul.lex.lib -> C:/soul-5.1.0/lib/soul.lex.lib
  C:/soul-5.1.0/x64/Release/soul.lexer.lib -> C:/soul-5.1.0/lib/soul.lexer.lib
  C:/soul-5.1.0/x64/Release/soul.module.map.lib -> C:/soul-5.1.0/lib/soul.module.map.lib
  C:/soul-5.1.0/x64/Release/soul.parser.lib -> C:/soul-5.1.0/lib/soul.parser.lib
  C:/soul-5.1.0/x64/Release/soul.re.lib -> C:/soul-5.1.0/lib/soul.re.lib
  C:/soul-5.1.0/x64/Release/soul.rex.lib -> C:/soul-5.1.0/lib/soul.rex.lib
  C:/soul-5.1.0/x64/Release/soul.token.lib -> C:/soul-5.1.0/lib/soul.token.lib
  C:/soul-5.1.0/x64/Release/soul.xml.dom.lib -> C:/soul-5.1.0/lib/soul.xml.dom.lib
  C:/soul-5.1.0/x64/Release/soul.xml.dom.parser.lib -> C:/soul-5.1.0/lib/soul.xml.dom.parser.lib
  C:/soul-5.1.0/x64/Release/soul.xml.parser.lib -> C:/soul-5.1.0/lib/soul.xml.parser.lib
  C:/soul-5.1.0/x64/Release/soul.xml.processor.lib -> C:/soul-5.1.0/lib/soul.xml.processor.lib
  C:/soul-5.1.0/x64/Release/soul.xml.serialization.lib -> C:/soul-5.1.0/lib/soul.xml.serialization.lib
  C:/soul-5.1.0/x64/Release/soul.xml.xpath.lib -> C:/soul-5.1.0/lib/soul.xml.xpath.lib
  C:/soul-5.1.0/x64/Release/soul_expected.ast_expected.lib -> C:/soul-5.1.0/lib/soul_expected.ast_expected.lib
  C:/soul-5.1.0/x64/Release/soul_expected.common.lib -> C:/soul-5.1.0/lib/soul_expected.common.lib
  C:/soul-5.1.0/x64/Release/soul_expected.cpp.lib -> C:/soul-5.1.0/lib/soul_expected.cpp.lib
  C:/soul-5.1.0/x64/Release/soul_expected.dom_parser.lib -> C:/soul-5.1.0/lib/soul_expected.dom_parser.lib
  C:/soul-5.1.0/x64/Release/soul_expected.lex.lib -> C:/soul-5.1.0/lib/soul_expected.lex.lib
  C:/soul-5.1.0/x64/Release/soul_expected.lexer.lib -> C:/soul-5.1.0/lib/soul_expected.lexer.lib
  C:/soul-5.1.0/x64/Release/soul_expected.parser.lib -> C:/soul-5.1.0/lib/soul_expected.parser.lib
  C:/soul-5.1.0/x64/Release/soul_expected.re.lib -> C:/soul-5.1.0/lib/soul_expected.re.lib
  C:/soul-5.1.0/x64/Release/soul_expected.rex.lib -> C:/soul-5.1.0/lib/soul_expected.rex.lib
  C:/soul-5.1.0/x64/Release/soul_expected.token.lib -> C:/soul-5.1.0/lib/soul_expected.token.lib
  C:/soul-5.1.0/x64/Release/soul_expected.xml.dom.lib -> C:/soul-5.1.0/lib/soul_expected.xml.dom.lib
  C:/soul-5.1.0/x64/Release/soul_expected.xml.processor.lib -> C:/soul-5.1.0/lib/soul_expected.xml.processor.lib
  C:/soul-5.1.0/x64/Release/soul_expected.xml.xpath.lib -> C:/soul-5.1.0/lib/soul_expected.xml.xpath.lib
  C:/soul-5.1.0/x64/Release/soul_expected.xml_parser.lib -> C:/soul-5.1.0/lib/soul_expected.xml_parser.lib
  C:/soul-5.1.0/x64/Release/util.lib -> C:/soul-5.1.0/lib/util.lib
  C:/soul-5.1.0/x64/Release/util_expected.lib -> C:/soul-5.1.0/lib/util_expected.lib
  C:/soul-5.1.0/x64/Release/zlibstat.lib -> C:/soul-5.1.0/lib/zlibstat.lib
  source directory 'C:/soul-5.1.0/tools/otava/projects/soul/oslg/bin/release/2' does not exist
  has only single valid path
  source directory 'C:/soul-5.1.0/tools/otava/projects/soul/ospg/bin/release/2' does not exist
  has only single valid path
  source directory 'C:/soul-5.1.0/tools/otava/projects/compiler/ooc/bin/release/2' does not exist
  has only single valid path
  

  The inst.bat copies executables from the Visual Studio solution output directory to the bin directory and libraries to the lib directory.

• Open terminal in C:\soul-5.1.0\unicode directory and run build.bat:
  Microsoft Windows [Version 10.0.26200.8246]
  (c) Microsoft Corporation. All rights reserved.
  
  C:\soul-5.1.0\unicode>build
  processing C:/soul-5.1.0/unicode/ucd.all.flat.xml, done.
  
  C:\soul-5.1.0\unicode>
  

  This builds the Unicode database soul_ucd.bin".

• Soul 5.1.0 is now installed and configured.