MyAES configuration, February 17, 2016, Copyright 2016

MyAES configuration file

ABSTRACT

This document present options of myaes.cnf configuration and its use. You will find here the different keyworld and the use of them.

THE FILE

myaes.cnf file is an ASCII file editable by any text editor as QED. This file need to be present in "myaes" folder generally put in C://gemsys/ folder.

STRUCTURE

The configuration file is form of keywords, MyAES search its keyword at start in the file except after a comment starting with #

Position of the keyword has no effect

KEYWORDS

List of keyworlds support by MyAES after August 2012:

accpath

app_debug

app_forcedesk

app_game_kbd (since 0.96)

app_topmost

app_system (since 0.96)

clipboard

cookie_magx

cookie_naes

CT60_VIDEOCARD (obsolete see "use_videocard_mem")

debug (debug version only)

dialog_effects

esetshift

eiffel_wheel (since 0.96 patch 1)

export

flying_menu

flying_menu_fix

hide_naes_magic_cookies

iconify_offset (since 0.96)

include (since 0.96)

language

max_pixels_trans

max_video_mem

memory

memory_rescue

menucolor

mini_client

mini_win

mouse_buttons

no_opwk (since 0.97)

realtime_winframe

rezmode

run

runtsr

runtsrvdi

scroll_delay

scroll_slice

server_mode

shell

shell_no_restore (since August 2012)

shutdown

stack_fix (deprecated)

tc_transparency

terminaison

texticon

threads

timeslice

topped_when_moved

use_videocard_mem (since 0.96 patch 2)

vsetmode

windows_backup (since 0.97)

wheel_emulation (since 0.96 patch 1)

workarea

Description by Keywords:

accpath

Use : accpath = C:\acc\

Description : Set path to load accessory

app_debug

Use : app_debug PACMAN

Description : Put in debug mode an application (only available on debug version (not official realease)). You can define several application in the file.

app_forcedesk

Use : app_forcedesk DESKTOP

Description : By default MyAES put a true color picture as desk except for application using USERDEF for object 0 of the desk except if you use app_forcedesk follow by the name of the application, in this example DESKTOP (Teradesk), it work fine for most application except JINNEE desktop that use object 0 to display name of color icons. You can define several application in the file.

app_game_kbd

Use : app_game_kbd DOOM

Description : Some game program (using SDL) need specific keyboard management change to be able to play with in GEM Windows, this option force to change keyboard use. Use app_game_kbd follow by the name of application (in this example DOOM)

app_system

Use : app_system ZTASK

Description : appl_search() function will return for the application with this option as system, it can be usefull if you don't want this application appear in a task bar. You can define several application in the file.

app_topmost

Use : app_topmost ZTASK

Description : Some specific application it is usefull that there windows are always on the top like a task bar, you can decide to specify applications that need it. You can define several application in the file.

clipboard

Use : clipboard = C:\clipbrd\

Description : Set path for the clipboard folder

cookie_magx

Use : cookie_magx = false

Description : You can decide to install cookie of Magic AES (MAGX) at your hown risk, because MyAES is not compatible with Magic and application could crash using some specific function of Magic, but sometime it can be usefull to run some applications like Papyrus that with this cookie display color icons rather black and with icons!

Possible values : true, false

cookie_naes

Use : cookie_naes = false

Description : You can decide to install cookie of NAES (NAES) at your hown risk, because MyAES is not compatible with NAES and application could crash using some specific function of NAES, but sometime it can be usefull to run some applications

Possible values : true, false

CT60_VIDEOCARD (obsolete replaced by use_videocard_mem)

Use : CT60_VIDEOCARD = false

Description : Speed up some video operation if you have video card, need for the moment Radeon video card, if set yes then you can use it.

Possible values : true, false

debug

Use : debug = false

Description : Put MyAES in debug mode (only available on debug version (not official realease))

Possible values : true, false

dialog_effects

Use : dialog_effects=false

Description : Classical AES display can display growing or shinking box effects with the use of function form_dial(), you can decide to display or not this effect if an application use it as on this AES, this is genrally not very beautiful and slow, but it is a choice, put true if you want display the effect or false if you not want.

Possible values : true, false

eiffel_wheel

Use : eiffel_wheel=false

Description : If you have an eiffel mouse please set this value to true to have wheel support with your mouse in MyAES.

Possible values : true, false

esetshift

Use : esetshift = 0

Description : Usefull under TT computer ????

export

Use : export STGUIDE=E:\HypView-0.40\hyp_view.app

Description : This keyword can add GEM environnement variable (no effects for TOS application), you can define as many variable you need.

flying_menu

Use : flying_menu = true

Description : Set how display the menu, see below

flyuing_menu  = true

flying_menu = true the menu is small, its height is not lost for the desktop its area is the full screen, the menu can disappear if not use and appear when the mouse is on the top of the screen, this last option depend of the option flying_menu_fix.

menu rétracté

The menu is draw back, all the screen is for the desktop (need flying_menu = true and flying_menu_fix = false)

Classical menu

flying_menu = false , this is the classical menu, the menu is at the width of the screen, the height of the menu is lost for the desktop

Possible values : true, false

flying_menu_fix

Use : flying_menu_fix = false

Description : This keyword affect MyAES use only if flying_menu = true, if the value is set to false then the menu can retract if not use, else if set to true the small menu is fix.

Possible values : true, false

hide_naes_magic_cookies

Use : hide_naes_magic_cookies=false

Description : MyAES is able to run above any other AES launch from the desktop, in this case it is probably useful to hide installed cookie by Magic or NAES, in this case set to true

Possible values : true, false

iconify_offset

Use : iconify_offset=16

Description : offset of the iconified window from the bottom of the screen in pixels (default 0)

Possible values : integer value

include

Use : include E:\gemsys\myaes\desktop.cnf

Description : call a configuration file from myaes.cnf file, you can use same input as for myaes.cnf (except include itself!), you can define several "include" commands in myaes.cnf

Possible values : path to configuration file

language

Use : language = 2

Description : AES report wich language you use, the number corresponds to the language ex: 1 for english, 2 for french

Possible values : 1, 2, 3 ...

max_pixels_trans

Use : max_pixels_trans = 100000

Description : Maximum number of pixels acceptable to use the TC transparency effect (see tc_transparency), this value depend highly of the power of your computer

Possible values : Integer value

max_video_mem

Use : max_video_mem = 30

Description : Maximum video memory to allocate to MyAES in MByte, minimum usefull value is the memory need for 1 screen, value can be set to -1, in this case MyAES request to Xbios function memory available and use the half of the return value, unfortunately the return value can be wrong on Radeon video card and should not be used on this case, I suppose on Supervidel return is OK.

Possible values : Integer value

Information : This value is only need with use_videocard_mem set to true

memory

Use : memory = normal

Description : ????????????????????????????????

Possible values : normal, protected, strict

memory_rescue

Use : memory_rescue=600

Description : Memory in KByte allocate by MyAES in case of memory not enough during the use (some applications like SCRIPT allocate all memory), this was really need by MyAES on old versions up an integrate file selector and alert have been add to it internally (before only outside software was used to manage fiel selector and alerts)

menucolor

Use : menucolor = grey

Description : If no texture file (menu.jpg) is found for the skin you can set VDI color to the menu bar

Possible values : white, black, red, green, blue, cyan, yellow, magenta, grey, lgrey, lred, lgreen, lblue, lcyan, lyellow, lmagenta

mini_client

Use : mini_client = 20

Description : Number of slot allocate by MyAES for GEM client running in same time, if during the use MyAES need more client it can allocate again this number if server_mode is set to true (multitask only)

mini_win

Use : mini_win = 40

Description : Number of slot allocate by MyAES for Windows allocate in same time, if during the use MyAES need more windows it can allocate again this number if server_mode is set to true (multitask only)

mouse_buttons

Use : mouse_buttons = normal

Description : If you set this value to "inverse" then right and left button can be reverse.

Possible values : normal, inverse

no_opwk

Use : no_opwk = true

Description : If you set this value MyAES will not try to open physical workstation and will use logical workstation, use it only if the physical worstation have been open before at my known used on MegaST with ET4000 video card, see message http://mikro.naprvyraz.sk/mint/201001/msg00240.html.

Possible values : true, false

realtime_winframe

Use : realtime_winframe=true

Description : If set to "true" then MOVE and RESIZE of windows can be done in realtime, to work it need the program "masreal.prg" in forlder "myaes\desk\" and work only on multitask systems

Possible values : true, false

rezmode

Use : rezmode = 3

Description : Resolution mode, this value should be set with vsetmode, there is diffrent possible values:

- 0, MyAES try to find resolution mode reading in NVRAM, if not avaible set rezmode at 1

- 1 Start VDI in default mode, depend of the VDI

- 3 (or 5 on VDI Milan computer but 3 can be set too MyAES should be able to correct this point), set the video with the resolution you want with the keyword vsetmode. If MyAES can't open this mode it try to use mode 1.

Possible values : 0, 1, 3, 5 (and perhaps other values ?)

run

Use : run E:\taskbar\taskbar.prg

Description : Run a GEM application at start, you can run several application in the config file. It is possible to use * in the command

runtsr

Use : runtsr C:\autotsr\*.tos

Description : Launch tos program before installation of the GEM

runtsrvdi

Use : runtsrvdi C:\tools\fvdi\fvdi.prg

Description : Launch of tos program, the GEM trap is already installed but not answer to appl_init() (like if it was not installed), this could be useful with some VDI to install the trap#2 vector (same as GEM) after AES because VDI is more called than AES so it should be better for speed.

scroll_delay

Use : scroll_delay = 100

Description : Delay in millisecond of elevator arrow

scroll_slice

Use : scroll_slice = 25

Description : Delay in millisecond of elevator slider

server_mode

Use : server_mode = true

Description : If set to true MyAES work as a server on multitask system else it's only the GEM API but as it is not a kernel module MyAES can't manage correctly some memory allocation in this case you should set carrefully mini_client and mini_win keywords so prefer true value (notice on single TOS server_mode has no effects).

Possible values : true, false

shell

Use : shell=C:\teradesk\desktop.prg

Description : Set the path for the desktop launch by MyAES. WARNING if the path is wrong MyAES will not start!

Remark : shell C:\teradesk\desktop.prg work too but is considered as deprecated

shell_no_restore (since August 2012)

Use : shell_no_restore = false

Description : By default or if the value is set to false then if the shell quit without doing shutdown, then the MyAES will launch again the shell (except if time between of start and stop is lower than 20 second), if set to true the shell will never be launch again.

Possible values : true, false

shutdown

Use : shutdown = poweroff

Description : If MyAES quit without doing a shutdown, this value set the type of shutdown to do, this work only with Mint

Possible values : poweroff, reboot, cold, halt

stack_fix

Use : stack_fix=true

Description : Need for old version to run correctly MyAES, this value is not use anymore

tc_transparency

Use : tc_transparency = 50

Description : For some operation made by graf_xxx function MyAES can apply transparency operation, with this control you can define % of transparency, this feature is only available on 32bits screen color, the value should be between 0 and 100 as integer, a value of 0 or 100 : no effects. You should set in same time the keyword "max_pixels_trans"

Possible values : integer number from 0 to 100

terminaison

Use : terminaison = wait

Description : Use only wait, other modes doesn't work!

Possible values : wait, term

texticon

Use : texticon = transparent

Description : Keyword to fix how display text of icons or color icons, in classical AES texts background is a white opaque rectangle with the option "opaque" MyAES will display this texts like this, there is a second option "transparent" in this case the white rectangle is not display only text that in this case display directly on the object under it.

Possible values : transparent, opaque

threads

Use : threads=-1

Description : Point out if the system use is multitask or not, if your system is prehemptive multitask (Mint, Magic...) set value to -1, if not (single TOS) set value to 1

Possible values : -1, 1

timeslice

Use : timeslice = 50

Description : Time between two event management by MyAES (server mode only on multitask system) in millisecond, a too low value will probably slow down your computer, while a too high value the reactivity of MyAES will be bad, generally a value between 40 and 60 work fine, if your computer is fast use a slower value, while if your computer is slow prefer an higher value. (suggested values : 60 on a basic Falcon, 40 on Aranym)

topped_when_moved

Use : topped_when_moved = false

Description : If this keyword is set to true then if you try to move a windows in background the windows will be topped before to be able to move it.

Possible values : true, false

use_videocard_mem

Use : use_videocard_mem = false

Description : If this keyword is set to true then for some operation MyAES will use memory available on vide card such as Radeon or Supervidel, WARNING this option will crash on computer without video card as it use the xbios function vmalloc() (xbios function indice higher than 127 that crash under not patched TOS). By default this value is set to false. This option accelerate some operation such as real time window move. At this time CT60 and and firebee can support this option if a video card is installed on it.

Possible values : true, false

See also : max_video_mem

vsetmode

Use : vsetmode = 27

Description : Video mode, this value is in DECIMAL! (XaAES set it in hexadecimal!), look in system documentation or video card documentation.

windows_backup

Use : windows_backup = true

Description : Option to be able to restore the working area of a window (even if the window is under another window or iconified). This opion is very expensive in memory and is only supported in true color 32 bits. Yopla taskbar use for display in smaller all windows of an application as you can see on the photo hereafter.

Possible values : true, false

wheel_emulation

Use : wheel_emulation = 0

Description : How use wheel for windows scrowl. 0 : page up/down other value number of lineup/linedown

Possible values : integer value

workarea

Use : workarea = normal

Description : On classical AES working area is different from the area of the windows (this is link to widgets) for the application that is running this is the "normal" value, but with the "fullarea" value the application will not be able to know witch is the the size of the window and know only his working area. Generally there is no problem with this last option but GEMDEMO is known to not be compatible with it. At this time there is no real interest of it, prefer "normal" value but it could be usefull in future.

Possible values : normal, fullarea