3.7  Help (Windows)

On Windows, there are help files in the HTML Help format available in the Administration Console that can be used (*.chm) both for the main window of the Administration Console (the Help / Contents option in the main menu) and for both administration modules (the Help / Administrators Guide option in the main menu).

The installation packages include only English versions of the help files. However, help files in other languages are available at http://www.kerio.com/.

Location of help files is described thoroughly in chapter 2  Installation, File Location and Startup. The format of their names is as follows:

kadmin.<language>.chm — for the main window of the Administration Console

mailadmin<XYY>.<language>.chmKerio Connect's administration guide

wradmin<VWW>.<language>.chmKerio Control's administration guide

where

First, the Administration Console (or an administration module) always searches for the help file in the language selected for the GUI (see chapter 3.6  Language preferences and splash screen settings). If the file is not found, the help file in English will be searched. If neither the English version is found, the Help / Contents (in the main window) or the Help / Administrator's Guide (in the administration module's window) option is not available.

Note: The help is currently not available for Linux and Mac OS X. The Administration Console's main menu or the administration module's menu does not include the options. However, the manual in either HTML or PDF can be used for reference — there are no differences between individual format versions of the help/manual.

How to add a help file

Example: Suppose you want to add a French help file and French administrator guide for the Kerio Control 7.1.x (for up-to-date version check the information provided at the welcome screen immediately after a successful login) into the Administration Console. Download corresponding guides in the HTML Help format from http://www.kerio.com and save them to the help subdirectory (see above). The following files are available:

  • kadmin.cs.chm— a guide for the Administration Console

  • wradmin701.cs.chm— administrator's guide for Kerio Control

If we attempt to add while the Administration Console (or another administration module) is running, the following rules are applied:

  • The help file for the Administration Console will be available upon the next startup of the Administration Console or when a new language version of the file has been enabled.

  • Administrator guide for a corresponding application will be available upon the next connection to this application (upon the next startup of a corresponding administration module).