Intriman

Intriman is a documentation generator that retargets the Intel Intrinsics Guide data into additional offline documentation formats.

Man page(groff):

Markdown:

Plaintext:

Dependencies

• Cmake 3.2.2+
• pugixml

Building

Clone the repository with submodules:

git clone --recursive https://github.com/Wunkolo/Intriman.git

Windows

Using Visual Studio 2017, simply open CMakeLists.txt using Visual Studios built-in support for opening CMake projects:

Finally, select your desired build target and architecture and then build. Compiled binaries will be found in the cache folder:

Linux

Typical Cmake out-of-source build procedure:

cd Intriman
mkdir build
cd build
cmake ..
make

Usage

CMake generation should automatically download data-latest.xml from Intel. Otherwise, download the file from https://software.intel.com/sites/landingpage/IntrinsicsGuide/files/data-latest.xml and simply drag and drop this file onto the executable, or put data-latest.xml as the first argument(Intriman data-latest.xml), and the documentation files will be generated( default output directory is ./docs/ relative to the executable path )