Variables Used in nncron.ini
Note: To restore the default values of all variables listed in nncron.ini, do the following:
After this, a new nncron.ini will be generated, where all variables will have their default values.
Activates a crontab. File nncron.ini may contain more then one "Crontab:" variable: there may be as many of them as there are activated crontabs.
Crontab: "hotkey.tab" Crontab: "vk.tab" Crontab: "test.tab" Crontab: "%YYYY%.tab"
Specifies the text editor which will be used when the user selects View log in the right-click menu or clicks on nncron.ini button in Options dialog box.
By the way, there exists a special nnCron syntax highlight scheme for a free open-source text editor SciTE. Syntax highlighting can be flexibly modified. I recommend it to all! Additional information can be found on the SciTE web-site (http://www.scintilla.org). There also exists an add-on enabling syntax highlight for nnCron and Forth in the internal editor of FAR file manager (http://www.farmanager.com).
Allowed values:
Editor: "d:\tools\scite\scite.exe"
Specifies the language to be be used in nnCron's GUI. nnCron's language resource files are located in res subdirectory. New and updated language resource files can be downloaded from our Translation page (http://www.nncron.ru/translation.shtml).
Allowed values:
etc...
Language: English
Specifies the name of nnCron's log file.
Cronlog: "log\nncron.log"
Specifies the format for writing information into log file.
LogTimeFormat: "%DD% %MMM% %hh%:%mm%:%ss% %ThreadId%"
Specifies whether or not the Year field should be included in the cron format used by nnCron.
Allowed values:
YearField ON
CompleteTaskTimeout: <time_in_ms>
Specifies the length of time (in milliseconds) during which nnCron will await for completion of a running task when reloading crontab files. If a task is not completed during the specified time, it will be forced to stop.
CompleteTaskTimeout: 10000
QueryStartTimeout: <time_in_sec>
Specifies the length of time (in seconds) during which nnCron will await for user's answer to a query about starting an application (QSTART-APP:). If the user does not react during the specified time, nnCron will itself decide whether or not the application should be started (see QueryStartAnswer:).
QueryStartTimeout: 30
Specifies nnCron's default answer to a query regarding starting an application (QSTART-APP:) if the user did not react during the time specified in QueryStartTimeout: variable.
Allowed values:
QueryStartAnswer: Yes
This variable turns on/off the special set of words for system performance monitoring. There are some of these words:
Allowed values:
PerfMonitor OFF
ReloadImmediately ON - reload changed crontabs located in nnCron
home directory imediately.
ReloadImmediately OFF - check for crontabs changes once in a minute
(at 30 seconds).
Allowed values:
ReloadImmediately ON
Specifies the default mode in which applications will be started by nnCron (application window can be opened in in following modes: normal, maximized, minimized or hidden).
Allowed values:
DefaultOpenMode: ShowNormal
Specifies the default priority which nnCron assigns to applications launched by it.
Allowed values:
DefaultPriority: NormalPriority
DefaultRunMissedTime: <hh:mm|days>
Manages launching of missed tasks: specifies maximum waiting time (in hours and minutes or days) that may elapse since this task was sheduled to run for the last time. The missed task will not be launched if DefaultRunMissedTime: value is smaller than the time elapsed since this task was sheduled to run for the last time.
DefaultRunMissedTime: 360:00
DefaultLogonType: <logon_type>
Defines the default logon type.
Allowed values:
DefaultLogonType: LogonInteractive
Specifies whether or not the nnCron icon will be displayed in system tray.
Allowed values:
SysTrayIcon ON
TrayIconDoubleClick: <forth_word>
TrayIconRightButton: <forth_word>
TrayIconBalloonClick: <forth_word>
These variables defines the action, that should be performed when double-clicking or right-clicking on nnCron system tray icon or clicking on a BALLOON: hint. There are several predefined words, which can be used as an arguments to TrayIconDoubleClick:, TrayIconRightButton: and TrayIconBalloonClick:. Note, that you can use any other forth-words as well.
Predefined words, which can be used with TrayIconDoubleClick:, TrayIconRightButton: and TrayIconBalloonClick:
TrayIconDoubleClick: options
TrayIconRightButton: menu TrayIconBalloonClick: NOOP
See also the answers on a following questions: "How can I start my own task by double-clicking on nnCron system tray icon?" and "How can I create my own pop-up menu which is shown when right-clicking on nnCron system tray icon?".
Allows to make the nnCron's icon in system tray visible only to users with administrator rights. If the value of this variable is set to ON, then users with lower-level rights will not see the icon in the tray.
Allowed values:
IconForAdminsOnly OFF
MonitorResponseTime: <time_in_ms>
Specifies the minimal period of time between two events (Watch*). This is discussed in greater detail in Event Specifiers section.
MonitorResponseTime: 100
Word CRONTAB-ERROR is called each time when a syntax error is spotted in a crontab file. By modifying the definition of CRONTAB-ERROR, you can change contents of the error message. CRONTAB-ERROR to a certain degree parallels functions of variable ShowErrorMsg, therefore, it can be used as an auxiliary tool: e.g. to play a specific sound in order to warn about an error, to create a flag file each time an error is spotted, or do something else. Word CRONTAB-ERROR may be safely deleted from nncron.ini.
: CRONTAB-ERROR ( a u -- ) WinNT? IF 10 1 DO 100 I 100 * BEEP LOOP ELSE 1 1 BEEP THEN ERR-MSG: "CRONTAB ERROR!!!.%crlf%%crlf%TASK FILE: %CUR-TAB-FILENAME COUNT%%crlf%TASK: %CUR-TASK-NAME%%crlf%Line: %CURSTR @%" ;
Word REMINDER-SOUND specifies the sound which should be played when a Reminder message is displayed.
: REMINDER-SOUND 500 500 BEEP ;
or:
: REMINDER-SOUND PLAY-SOUND: "%Windir%\media\tada.wav" ;
Specifies the directory where nnCron stores backup copies of crontab files
and ini files after they have been modified.
BackupPath: "backup"
WatchWinCreateDelay: <time_in_ms>
Specifies the delay time (in milliseconds) before execution of WatchWinCreate:. Such a delay is necessary because many windows have no title when they have been just created, so they cannot be found by their titles.
WatchWinCreateDelay: 100
Specifies the delay time (in milliseconds) before execution of WatchProc: and WatchProcStop:.
WatchProcDelay: 1000
Specifies whether or not the Forth console should be started automatically on nnCron startup.
Allowed values:
Console OFF
ItemConsole <ON/OFF>
ItemExit <ON/OFF>
ItemOptions <ON/OFF>
ItemReload <ON/OFF>
ItemSuspend <ON/OFF>
These variables respectively specify whether or not the Right-click pop-up menu should contain the following items: "Tools/Console", "Exit", "Options", "Reload Crontabs" and "Disable nnCron/Enable nnCron".
Allowed values: ON or OFF
ItemExit ON ItemOptions ON ItemConsole ON ItemReload ON ItemSuspend ON
Specifies whether or not application nnguard.exe (which is responsible for so-called Crash guard mode, in which nnCron automatically restarts after fatal errors) should be used. More detailed description of the Crash guard mode can be found here.
Allowed values:
Guard ON
Activates specified plugins. Several instanced of INCLUDE can be used in nncron.ini—as many as there are enabled plugins.
INCLUDE "plugins\tools.spf" INCLUDE "plugins\windows.spf" INCLUDE "plugins\time.spf" INCLUDE "plugins\win2tray.spf" INCLUDE "plugins\wakeup.spf" INCLUDE "plugins\procwin.spf" INCLUDE "plugins\timesync.spf"
DialOnce ON: when this variable is on, nnCron won't attempt to re-dial
a connection if a remote connection already exists (function RasDial
will not be called). So it enough to call word HANGUP
just once in order to hang up (break the connection).
Allowed values:
DialOnce ON
DefaultUser: "username"
DefaultPassword: "sec_password"
DefaultDomain: "domain_name"
DefaultLoadProfile <ON/OFF>
Sets authorization parameters (login, password, domain) for running all tasks as a particular user. (See RunAsDefaultUser). Variable DefaultLoadProfile specifies whether user profile should be loaded. Use an encrypted password as a value of variable DefaultPassword:.
DefaultUser: "test_user" DefaultPassword: "h4jk2sdhl==" DefaultDomain: "" DefaultLoadProfile OFF
Specifies whether or not all tasks should be run as the default user (using the data specified in Default* group of variables).
Allowed values:
RunAsDefaultUser OFF
GUIUser: "username"
GUIPassword: "sec_password"
GUIDomain: "domain_name"
GUILoadProfile <ON/OFF>
Sets authorization parameters (login, password, domain) for running nnCron's GUI as a particular user. (See GUIAsUser). Variable GUILoadProfile specifies whether a user profile should be loaded. Use an encrypted password as a value for variable GUIPassword:.
GUIUser: "test_user" GUIPassword: "h4jk2sdhl==" GUIDomain: "" GUILoadProfile OFF
Specifies whether or not to run the nnCron GUI as the user specified in GUI* group of variables.
Allowed values:
GUIAsUser OFF
Specifies whether or not the errors written to log file should be accompanied by an alert message box. If necessary, the time of waiting for user response can be changed (it is set to 30 by default). To do this, change the value of variable ShowErrorTime:
10 ShowErrorTime !
Allowed values:
ShowErrorMsg ON
This word can be used to put a restriction to what words and constructs can
be used in the beginning of a task (After '#(' and before Action:
or Rule:). If SyntaxRestriction is ON, then only
a limited number of words can be used in the beginning section of a task (Time:,
Watch*, task options, comment sign). Thus, the system can be safeguarded
against actions of inexperienced users, for user errors may crash nnCron or
even destabilize the entire system.
To overcome this restriction, experienced users can use words <(
and )>. Any words can be used between the parentheses (even if SyntaxRestriction
is on). But in this case, make sure you know what you are doing.
Allowed values:
SyntaxRestriction OFF
Specifies which help file is will be opened when a user clicks on Help in menu.
HelpFile: "F:\My Documents\NNCRON\help_ru.chm"
This word is used to toggle ON/OFF the mode in which all the errors written to log file are duplicated to standard output. When this mode is ON, all the information sent to log file will be duplicated on Forth console.
Allowed values:
Log2StdOut OFF
Allows/disallows use of Remote Console instead of regular Forth console. If RemConsole is set to OFF, Remote Console server is not started, and a local console is used instead of standard nnCron's console. For example, Remote Console may have to be disallowed on systems where TCP/IP (which is required for Remote console to work) is not installed.
Allowed values:
RemConsole ON
Sets the number of port which Remote Console server will listen.
RemConsolePort: 2002
RemAllowed: <ip_address_mask>
RemDisallowed: <ip_address_mask>
Sets IP addresses which are allowed or disallowed to connect to Remote Console server. nncron.ini may contains several instances of variables RemAllowed or RemDisallowed. As arguments, you can use address masks and nonexistent addresses.
The general rule is as follows: one can connect from all addresses named in RemAllowed, except for addressees specified in RemDisallowed.
For example, let us allow connection from 127.0.0.1 (localhost), and in RemDisallowed we shall specify a nonexistent IP address; this would have the following effect: No specific addresses are disallowed, but only addresses specified in RemAllowed: will be allowed to connect
RemAllowed: 127.0.0.1 RemDisallowed: x.x.x.x
Extending the list of "allowed" addresses:
RemAllowed: 127.0.0.* RemAllowed: 127.127.15.15 RemAllowed: 127.63.63.3
RemDisallowed: x.x.x.x
Allowing connection from all IP addresses and disallowing connection from 127.0.0.13, 127.0.0.14 and 127.13.13.*:
RemAllowed: *
RemDisallowed: 127.0.0.13
RemDisallowed: 127.0.0.14
RemDisallowed: 127.13.13.*
Sets the keyboard shortcut (hotkey) that will bring nnCron pop-up menu on-screen. Hotkeys are defined using the same syntax as in WatchHotKey:
MenuHotKey: "^@n"
MaxClipboardSize: <size_in_bytes>
Sets the maximum size of Windows clipboard available to nnCron. If your clipboard contains text which size is larger than MaxClipboardSize: value, only the beginning of this text will be available to nnCron. MaxClipboardSize: variable allows nnCron not to slow down, when Windows clipboard contains large textes.
The default MaxClipboardSize: value: 10KB (10240B).
MaxClipboardSize: 10240