home *** CD-ROM | disk | FTP | other *** search
/ ftp.kadis.ru / 2015-02-01.ftp.kadis.ru.tar / ftp.kadis.ru / pub / cons / sonork-client-kadis.exe / app_readme.txt < prev    next >
Text File  |  2003-05-11  |  6KB  |  190 lines
  1. -----------------------------------------------------------
  2. Sonork External Applications Support
  3. -----------------------------------------------------------
  4.  
  5. The sys.ini and usr.ini files contain the applications that 
  6. may be launched from within Sonork; they may be modified to 
  7. add your own applications.
  8.  
  9. sys.ini is created and replaced by the installer.
  10. usr.ini you must create manually and is not modified when
  11. re-installing.
  12.  
  13. The application code should be listed under [Apps] and 
  14. have value '1' to be active and also have a corresponding
  15. section named after the code. The application code is
  16. simply an arbitrary name you give to your entries and 
  17. must be less than 32 characters long.
  18.  
  19. See the sys.ini file for working examples and feel free 
  20. to send us your application's entries in order to make 
  21. Sonork detect it. We will try to include them in the 
  22. next release.
  23.  
  24. Visit the Developer Zone at http://www.sonork.com
  25.  
  26.  
  27. ------------------------------
  28. MAIN.CMD SERVER.CMD CLIENT.CMD
  29. ------------------------------
  30.  
  31. Specify the command Sonork will use to start the application
  32. from the main console (MAIN.CMD), in server mode (SERVER.CMD)
  33. and in client mode (CLIENT.CMD). The mode is decided by the
  34. user when launching the application.
  35. These lines may contain replaceable variables (explained below)
  36.  
  37. Example:
  38. --------
  39. MAIN.CMD=C:\\MyApp.EXE
  40. or
  41. CLIENT.CMD=""%path""
  42. (%path is a replaceable variable)
  43.  
  44.  
  45. ------------------------------
  46. MAIN.ICON
  47. ------------------------------
  48. Icon index. The icon will be obtained from the
  49. application specified by MAIN.CMD.
  50.  
  51.  
  52. ------------------------------
  53. FLAGS
  54. ------------------------------
  55. Comma separated list of flags that specify behaviour/capabilities.
  56. * MainCtx
  57.    Application should appear in main console and has a MAIN.CMD
  58.  and MAIN.ICON, if specified, will indicate icon index.
  59. * UserCtx
  60.    Indicates that the application does something with a user's information,
  61.    it will appear in user-context 'Applications' menu and  has one or both 
  62.    CLIENT.CMD and/or SERVER.CMD lines.
  63. * RemoteStart
  64.    Application can be remote started. If user starts application in CLIENT
  65.    mode, the remote user will be requested to start his/her application in
  66.    SERVER mode and vice-versa. If this flag is set, both CLIENT.CMD and
  67.    SERVER.CMD are required.
  68. * NeedAddr
  69.    The application requires the remote user's (valid) network address.
  70. * NeedOnline
  71.    The application requires that Sonork is connected.
  72.  
  73. Example:
  74. --------
  75. flags=MainCtx
  76. Application will appear under "Applications" in the messenger
  77.  
  78. flags=UserCtx,NeedAddr
  79. Application will appear under "Applications" in the user's
  80. context menu and requires that the selected user has a valid network address 
  81.  
  82. flags=UserCtx,MainCtx,NeedAddr,RemoteStart
  83. Appears in both main and user context, needs a valid address
  84. and can be remote started.
  85.  
  86.  
  87. ------------------------------
  88. NAME
  89. ------------------------------
  90. Label that will be displayed on the interface.
  91. Add additional language-dependent labels by suffixing language code.
  92.  
  93. Example:
  94. --------
  95. Name=Friend
  96. Name.es=Amigo
  97. Name.de=Freund
  98.  
  99. ------------------------------
  100. STARTDELAY
  101. ------------------------------
  102. When starting a server, Sonork will wait the seconds specified
  103. by this variable before starting the client. 
  104. Example:
  105. --------
  106. StartDelay=10
  107.  
  108. ------------------------------
  109. REPLACEABLE VARIABLES
  110. ------------------------------
  111. Variable start with a percentage sign (%) and may be included
  112. in the ".CMD" lines. These values are resolved at run-time
  113. using the "v."-prefixed lines in the same section.
  114. If a run-time variable cannot be resolved, the ".CMD" line
  115. is ignored (as if it did not exist)
  116.  
  117. Example:
  118. MAIN.CMD=""%path""
  119. v.path=C:\MyApp.exe
  120.  
  121. ------------------------------
  122. VALUES PREFIX
  123. ------------------------------
  124. Variables starting with these special prefixes are treated differently.
  125.  
  126. EXE:RV:Executable relative value
  127. -------
  128. v.path=EXE:RV:notepad.exe
  129. Search path for "notepad.exe". Value is full path.
  130. If not found, resolution fails.
  131.  
  132. EXE:AV:Executable absolute value
  133. -------
  134. v.path=EXE:AV:C:\notepad.exe
  135. Value is the exact path.
  136. If path does not exist, resolution fails.
  137.  
  138.  
  139. REG:RV:Registry relative value
  140. -------
  141. v.path=REG:RV:HCR\callto\Shell\Open\Command
  142. Path is "(default)" value for Key. 
  143. If key does not exist or does not have a default value,
  144. resolution fails.
  145.  
  146. REG:AV:Registry absolute value
  147. -------
  148. v.path=REG:AV:HLM\SOFTWARE\MyApp\Path
  149. Path is string stored in registry path. Only strings supported.
  150. If key does not exist or not a string, resolution fails.
  151.  
  152. Note: The REG:XX: lines use HLM, HCR and HCU as aliases for
  153.  HKEY_LOCAL_MACHINE, HKEY_CLASSES_ROOT and HKEY_CURRENT_USER respectively.
  154.  
  155. XOR:Multi resolution
  156. -------
  157. XOR allow to test values and fail resolution only if ALL values
  158. in the XOR list fail. Sonork will use the first resolved value. 
  159. Up to 4 options may be specified.
  160. v.path=XOR:path1,path2
  161. v.path1=EXE:AV:C:\MyApp.exe
  162. v.path2=EXE:AV:C:\MyOldApp.exe
  163. If path1 exists, value of path will be path1
  164. if path1 does not exist but path2 does, value will be path2
  165. if none exists, resolution fails.
  166.  
  167. VAR:Sonork variable
  168. -------
  169. A Sonork variable is derived from the selected user or internal state.
  170.  
  171. v.myvar=VAR:<var-id>
  172. where <var-id> is one of:
  173.  
  174. user.id            : Remote user id
  175. user.alias        : Remote user alias
  176. user.name        : Remote user name
  177. user.addr.ip    : Remote user IP (as resolved by Sonork)
  178. user.uts.ip        : Remote user IP (as resolved by remote)
  179. user.host.ip    : Remote user IP (as resolved by server)
  180. prof.id            : Local user id
  181. prof.alias        : Local user alias
  182. prof.name        : Local user name
  183. prof.uts.ip        : Local user IP (as resolved by local)
  184. prof.host.ip    : Local user IP (as resolved by server)
  185.  
  186.  
  187. -----------------------------------------------------------
  188. End of readme
  189. -----------------------------------------------------------
  190.