*************************************************************************
file: readme.txt
date: Dec 18, 2012
desc: MARX® Analyzer diagnostic tool overview
OS: Windows 32/64bit platform

*************************************************************************
Overview
*************************************************************************

The tool was designed to help MARX® customers simplify troubleshooting of 
MARX hardware and software products. The tool performs extensive diagnostics 
of the operating system, running processes, analyzes which MARX components 
and device drivers are installed and running for each model of MARX hardware, 
tests found MARX hardware and networking.

*************************************************************************
Key Features
*************************************************************************

The following features are implemented in the current version of MARX® Analyzer:

+ Analysis of installed MARX APIs, system software, products and device 
  drivers. In Windows Vista/XP/2000/NT if a device driver is installed but 
  has not started, the application attempts to start it immediately without 
  the need to reboot the PC!

+ Detection of MARX hardware.

+ Advanced diagnostics of found MARX hardware (optional, requires proper TRX/MRX 
  file).

+ Detection of MARX® Network Servers for SmarxOS/MPI Networking.

+ Diagnostics of found network MARX hardware and remote clients.

+ XML Report generation. A report can be saved to a file or e-mailed right 
  from the application.

+ XML Report visualization. Saved report can be loaded and and displayed in 
  suitable view.

+ Live Update via Internet for MARX® Analyzer and its plugins.

+ Troubleshouting information. When a problem is detected, an explanation is 
  provided of what should be done.


*************************************************************************
Operating System Requirements
*************************************************************************

MARX® Analyzer was designed to be used with Microsoft® Win 7 (x86/x64), Windows Vista, XP,
Vista64, XP64, 2003 Server, 2000, Me (Millennium) and 98SE.


*************************************************************************
Installing MARX® Analyzer
*************************************************************************
MARX® Analyzer files:

 - MarxAnalyzer.exe	- MARX Analyzer executable
 - marxanalyzer_en.qm	- English language resources
 - marxanalyzer_de.qm	- German language resources
 - MA_Diag64.exe	- 64bit diagnostics module
 - MA_Diag32.exe	- 32bit diagnostics module
 - marxanalyzer_en.ini	- Customized plans storage (English)
 - marxanalyzer_de.ini	- Customized plans storage (German)
 - readme.txt		- this file
 - version.lst		- components version

Diagnostic components are installed into \plugins\ subfolder.

MARX® Analyzer Live Updater files are installed into \update\ subfolder.


MARX® Analyzer is distributed with shared Qt modules (to be placed in one 
subdirectory with MARX Analyzer executable file):

 - assistant_adp.exe
 - QtAssistantClient4.dll	
 - QtCore4.Dll
 - QtGui4.Dll
 - QtNetwork4.Dll
 - QtXml4.Dll
 - MSVCP80.Dll
 - MSVRP80.Dll
 - Microsoft.VC80.CRT.manifest
 - TDBVER.dll

*************************************************************************
MARX Analyzer plug-ins
*************************************************************************
MARX® Analyzer plug-ins are located in \plugins\ subfolder:

 - MDP_W32_SystemInfo.Dll	(system diagnostics)
 - MDP_W32_CBU.Dll		(diagnostics of CRYPTO-BOX® USB hardware)
 - MDP_W32_CBN_CBV.Dll		(diagnostics of CRYPTO-BOX® 560/Net and 
				Versa hardware)
 - MDP_W32_CBS.Dll		(diagnostics of CRYPTO-BOX® Serial hardware)
 - MDP_W32_CTM.Dll		(diagnostics of CrypToken CTM 2048 hardware)
 - MDP_W32_Networking.Dll	(diagnostics of SmarxOS/MPI Networking)
 - MDP_W32_SoftwareProducts.Dll	(diagnostics of installed MARX Products and 
				Components)
 - MDP_W32_RunningProcesses.Dll (diagnostics of running processes)


*************************************************************************
Help and Troubleshooting
*************************************************************************
MARX® Analyzer Help files are placed in \Help\ subfolder:

 - MARXAnalyzer_en.rcc		(English)
 - MARXAnalyzer_de.rcc		(German)

MARX® Troubleshooter files are placed in \TS\ subfolder:

 - MARX_Troubleshooter_en.rcc	(English)
 - MARX_Troubleshooter_de.rcc	(German)


*************************************************************************
Customized Diagnostics
*************************************************************************

By default, MARX® Analyzer performs full diagnostics, according to 
functionality provided with set of diagnostic plugins. This diagnostics can 
be customized (if only a specifc part of diagnostic is required).

Customized plans are stored in marxanalyzer.ini file

*************************************************************************
Command line parameters for MARX® Analyzer
*************************************************************************

Starting with ver.1.5 MARX® Analyzer supports extended set of command line parameters, 
allowing specifying completely or partially required diagnostics mode from within the application 
launching MARX® Analyzer. 

These parameters help integrate MARX diagnostics to their applications. 
It is possible to specify desired diagnostics mode completely or partially 
to eliminate or simplify its selection by the end-user.
   
The following syntax is supported by MARX® Analyzer starting with ver.1.5:

MarxAnalyzer 	[<MDIAG file>] | [-H | -?] |

[-Scenario=<Customer | EndUser>] 
[-Platform=<SmarxOS | MPI | CT | All>] 
[-Hardware=<SmarxOSCBU | MPICBU | AnyUSB | CBN | CBS3 | CT | All >]
[-Mode=<Local | Network | All>]

All parameters are optional and can be submitted in any sequence.  Upper/lowercase can be used. 
Detailed syntax for MARX Analyzer command line string can be obtained by specifying -H or -?: 

If MDIAG file is specified as a parameter, then MARX® Analyzer opens this MDIAG file.

Launching MARX® Analyzer with a complete set of diagnostics mode definition parameters 
(unambiguously identifying some diagnostics mode) will start this diagnostics mode immediately. 

In case of partial definition of diagnostics mode parameters the Mode Selection Wizard will initialize 
all corresponding radio buttons with choices made by submitted values and will open those screen 
where selection was not made by submitted command line parameters.  


*************************************************************************
Versions History
*************************************************************************
ver. 1.9.12.1218
		- New resources (icons)
ver. 1.8.11.0923
		- Plugin search logic minor improvement (higher priority to newer plugin 			among plugins with same Id)
		- Update logic minor improvement (ensuring update files to be copied 				independent from "Read only" attribute)
ver. 1.8.11.0920
		Diagnostic dialogs and progress control improvements: 
			- on the fly diagnostic interviews 
			- progress dialog "Skip" botton feature added
ver. 1.7.10.0319
		Rebuild (new copyright)
ver. 1.7.9.1216
		Autoupdate crash on MA exit fix
ver. 1.7.9.0915
		Rebuild (new office address )
ver. 1.7.9.0508
		Automatic (everyday) update added
ver. 1.6.9.0216
		Rebuild with Qt 4.4.3
ver. 1.5.9.0121
		Minor fixes
ver. 1.5.8.1029
		1) Diagnostic Selector Wizard
		2) Command-line diagnostic parameters
		3) Minor fixes and improvements, including
		  - MARX® Analyzer plugins versions saved to report
		  - Running processes plugin updated
		  - Help updated
ver. 1.4.8.0806
		Report save/load fix
ver. 1.4.8.0714
		Improved update procedure
ver. 1.3.8.0624
		a) Minor fixes
ver. 1.3.8.0603
		a) Qt Assistant based MARX Troubleshooter
		b) Minor fixes
ver. 1.3.8.0528
		a) Options->User Info - information about user to be added to report
		b) "Send report" fixes  
		c) System diagnostics improvements
		d) Components and products diagnostics fixes
		e) CBU extended test fixes

ver. 1.2.8.0425  
		a) Live Update - components checksum control added
		b) TRX2 box profile supported for extended CBU diagnostics
		c) Help revised, QAssistant mechanism used
		d) Send Report MAPI-issues fixed for Mozilla Thunderbird


ver. 1.1.8.04xx (accumulative):
----------------
          .0401  small changes with troubleshooting IDs
                 MDP_W32_CBU: small changes: check out-of-date MARX® CBU files,
                 verification of the found CRYPTO-BOX® according to SmarxOS\MPI 
 		 plan, small fixes with troubleshooting IDs
                 MDP_W32_CBN_CBV: small changes: check out-of-date MARX® CBN files
          .0325  small impromevments with first filling path-edit-box for root 
		 node of MDP_W32_CBU, MDP_W32_SystemInfo: - added the detection 
		 of .NET 3.x; - removed "Installed\Updated" date of .NET for Win9x
                 (not supported)
----------------
ver. 1.1.8.0311  hardware diagnostics UI changes, low-level diagnostics for "Unknown CBU", 
		 Networking fixes. 
ver. 1.1.8.0222  Live Update problem under Microsoft® Windows Vista fixed. 
	          Diagnostic support for x64 (Microsoft® Windows)
ver. 1.1.8.0204  Select of diagnostics mode added, Help added
ver. 1.1.8.0117  Customized Diagnostics plan improved, Live Update mechanism revised
ver. 1.1.7.1219  Live Update implemented, Troubleshooting added 
ver. 1.1.7.1210  Extended CBU hardware diagnostics added               
ver. 1.0.7.1119  Initial version


***************  Copyright© 2002,2012 MARX® CryptoTech LP  **************