Copyright:       : MARX(R) CryptoTech LP
File             : readme.txt
Date:            : Jun 10, 2021
Description      : Smarx(R)OS distributive for macOS
Author:          : DB
Operating System : macOS 10.9 - 11.2 (Big Sur)


*******************************************************************************
1. Overview
*******************************************************************************

This document contains description of Smarx(R)OS for macOS distributive.

With this distributive you can:
   - manually protect your applications and realize license management with the 
     CRYPTO-BOX(R) using our Smarx(R)OS API
   - program CRYPTO-BOX(R) hardware with licensing data
   - use both local and network licensing modes (Smarx(R)OS Network Server)


*******************************************************************************
2. Distributive content
*******************************************************************************

This distributive includes the following files and folders:

   - readme.txt         - this file
   
   - /api               - folder with Smarx(R)OS APIs for macOS, including
                          samples for CBIOS/DO/RFP API and SmarxAPI/AC API.
                          Both samples and library folder (SDK) are included,
                          see /API/api.txt file for further details.
                  
   - /network_server    - folder with Smarx(R)OS Network Server for macOS
   
   - /smrxprog          - folder with SmrxProg for macOS utility to program 
                          the CRYPTO-BOX(R) hardware with licensing data

*******************************************************************************
3. Usage notes and limitations
*******************************************************************************

This distributive doesn't require a special USB driver for the CRYPTO-BOX(R).

Smarx(R)OS API logic requires about 2 Mb of shared memory for internal usage.
If your software or any its dependencies require shared memory, 
CBIOS may not be initialized properly: CBIOS_Startup() will return error 
0x35 (CBIOS_ERROR_NOT_INITIALIZED).

This conflict can be resolved by increasing system limits for shared memory.
To solve it permanently it is necessary to make proper changes to the system
config file: '/etc/sysctl.conf'. If there was no such a file on user's system,
then it must be created. Here is its sample content:

kern.sysv.shmmax=16777216
kern.sysv.shmmin=1
kern.sysv.shmmni=32
kern.sysv.shmseg=32
kern.sysv.shmall=4096

Due to MacOS's specific semaphore implementation we don't recommend to access
CBU from multiple threads of one process.


*********** Copyright(c) 2002, 2021 MARX(R) CryptoTech LP ********************
*****************************************************************************/