home *** CD-ROM | disk | FTP | other *** search
/ Meeting Pearls 3 / Meeting_Pearls_III.iso / Pearls / comm / Networking / ReqServer / ReqServer.doc next >
Text File  |  1995-01-07  |  8KB  |  281 lines
  1. Short: Send messages, run commands etc. with Envoy
  2. Type: comm/envoy
  3. Author: Magne Oestlyngen (magneoe@stud.cs.uit.no)
  4. Uploader: Magne Oestlyngen (magneoe@stud.cs.uit.no)
  5.  
  6. ------------------==================================------------------
  7. 950108
  8.                         ReqServer release 1.0
  9.                            Req release 1.0
  10.  
  11.            Requires AmigaDOS 2.04 (V37), utgui.library V1+
  12.                 and nipc.library V37+ (Envoy) to run.
  13.  
  14.      Copyright © 1995 Ultima Thule Software, All Rights Reserved.
  15.                        Author: Magne Østlyngen
  16.  
  17. ------------------==================================------------------
  18.  
  19. Contents:
  20. ~~~~~~~~~
  21. 1.1 - Disclaimer
  22. 1.2 - What is ReqServer?
  23. 1.3 - Installation
  24. 2.1 - ReqServer
  25. 2.2 - Req
  26. 2.3 - utgui.library
  27. 3.0 - Example usage
  28. 3.1 - Tips & Tricks
  29. 4.0 - History
  30. 4.1 - FeedBack
  31.  
  32.  
  33. 1.1 - Disclaimer
  34. ~~~~~~~~~~~~~~~~
  35. This  software  entitled  "ReqServer"  is not public domain but freely
  36. distributable (FreeWare).  This means that you can copy it and give it
  37. to all your friends, upload it to a BBS or include it in a PD-library.
  38. The  only  restrictions  are:   All the files included in this archive
  39. must  be  in  their  original  form  without  additions,  deletions or
  40. modifications  of  any  kind.  The software may not be distributed for
  41. profit.    Only   a   nominal   charge  may  be  associated  with  its
  42. distribution.   If  you  want  to  distribute  this  software with any
  43. commercial  product, you will need written permission from the author.
  44. This  software  is  provided "AS IS" without warranty of any kind, and
  45. the  author  is  not  responsible for any damage this software may do.
  46. (Just in case :-)
  47.  
  48.  
  49. 1.2 - What is ReqServer ?
  50. ~~~~~~~~~~~~~~~~~~~~~~~~~
  51. ReqServer  is  a package with two small programs and a gui-library for
  52. use  with Envoy - the peer-to-peer networking software from Commodore.
  53. ReqServer  allows  you  to  run  commands  on  remote  machines,  send
  54. messages, finger, chat and various other operations.
  55.  
  56.  
  57. 1.3 - Installation
  58. ~~~~~~~~~~~~~~~~~~
  59. - Copy ReqServer and ReqServer.info into WBStartup
  60. - Copy Req into c:
  61. - Copy utgui.library into libs:
  62. - Reboot or start ReqServer manually by double-clicking on the 
  63.   ReqServer executable.  Do this on all hosts ReqServer is to
  64.   be installed on.
  65.  
  66.  
  67. 2.1 - ReqServer
  68. ~~~~~~~~~~~~~~~
  69. This  is  the  actual  server that will take care of requests over the
  70. Envoy network.  It can be put into WBStartup, or run from user-startup
  71. if  you like.  ReqServer is a Commodity and can be brought to front on
  72. the  frontmost  public screen with the keyboard combination defined in
  73. the  tooltypes  or  as  an  argument  ("rawkey  ralt  r"  is default).
  74. ReqServer accepts the following tooltypes or command line options:
  75.  
  76. CX_PRIORITY
  77. The priority ReqServer is to have in the commodities system. Should be
  78. left as it is.
  79.  
  80. Default: 0
  81.  
  82. MAXHOSTS
  83. The maximum number of hosts that is to show up in the cycle gadget that
  84. is used to select host in ReqServer.
  85.  
  86. Default: 5
  87.  
  88. MAXHISTORY
  89. The maximum number of lines that is to be kept in the string gadget 
  90. history buffer.
  91.  
  92. Default: 20
  93.  
  94. MAXREVIEW
  95. The maximun number of lines that is to be kept in the list of previous
  96. received messages in ReqServer.
  97.  
  98. Default: 100
  99.  
  100. LOGFILE
  101. Filename  that  ReqServer  will  use  to  log all messages and actions
  102. received.
  103.  
  104. Default: Not used
  105.  
  106. EXTRALOGGING
  107. ReqServer will log even more that default.  Must be used in conjuction
  108. with LOGFILE.
  109.  
  110. Default: Off
  111.  
  112. CMDALLOWED
  113. If this argument is present, ReqServer will accept commands run remote
  114. from another host on the current machine.
  115.  
  116. Default: Off
  117.  
  118. YELLCMD
  119. This  might  contain  a command that ReqServer will run when receiving
  120. YELL  commands.  If this string contains a %s, the TEXT entered on the
  121. command line with Req and the YELL argument will be inserted instead.
  122.  
  123. Default: Not used
  124.  
  125. REQ_X
  126. The initial X-position of the ReqServer window.
  127.  
  128. Default: 40
  129.  
  130. REQ_Y
  131. The initial Y-position of the ReqServer window.
  132.  
  133. Default: 90
  134.  
  135. REQ_W
  136. The initial width of the ReqServer window.
  137.  
  138. Default: 500
  139.  
  140. REQ_H
  141. The initial height of the ReqServer window.
  142.  
  143. Default: 250
  144.  
  145. HOTKEY
  146. This can be used to define a hotkey that will pop up the ReqServer
  147. window.
  148.  
  149. Default: "rawkey ralt r"
  150.  
  151.  
  152. 2.2 - Req
  153. ---------
  154. This  is  a  small  shell-based  program  that  is meant to be used to
  155. address  a  host  with  different requests.  Req accepts the following
  156. arguments:
  157.  
  158. HOST/A
  159. Name of the host machine to send a request to.
  160.  
  161. YELL/S
  162. Will  start  the  command  line  defined  in  the  Reqserver  argument
  163. REQ_YELLCMD  on  the  remote  host.  If this command is not defined, a
  164. requester will instead pop up on the remote machine.
  165.  
  166. QFIND/S
  167. This  option  will  use  QFind (a part of the QuickTools software from
  168. Ultima  Thule Software) on the remote machine and search for any files
  169. matching the pattern that is given in the TEXT argument.
  170.  
  171. CMD/S
  172. This  option  will  run  the command given in the TEXT argument on the
  173. remote  host  and print the output in the current shell window.  NOTE:
  174. CMDALLOWED  must  be  an  argument  to Reqserver running on the remote
  175. machine.
  176.  
  177. FINGER/S
  178. This option will "finger" the remote host. Example output from this
  179. command might be:
  180.  
  181.     > req bbs finger
  182.         bbs   : 07-Jan-95 20:24:57,  00:09:26
  183.  
  184.     > req mg finger
  185.         mg    : In use.
  186.  
  187.     > req pn finger
  188.         PN    : Probably in use.
  189.  
  190. LONG=-L/S
  191. Using this option in conjuction with FINGER will display the files
  192. s:.plan and s:.profile that might be present on the remote machine.
  193.  
  194. TEXT/F
  195. This  must  contain  the  information that is to be used in conjuction
  196. with  the  QFIND,  CMD,  YELL  or  FINGER arguments.  If none of these
  197. arguments  is specified, TEXT will pop up a requester on the addressed
  198. host machine with the text given.
  199.  
  200. 2.3 - utgui.library
  201. ~~~~~~~~~~~~~~~~~~~
  202. This  is  an  internal library that contains gui functions and general
  203. functions.   This  library  will  be used by most forthcoming software
  204. releases from Ultima Thule Software, including THOR 2.0.
  205.  
  206. 3.0 - Example usage
  207. ~~~~~~~~~~~~~~~~~~~
  208.  
  209. > req pn "This is a text"
  210.  
  211. will pop up a requester on the host "pn" which contains the text "This
  212. is a text".
  213.  
  214. > req bbs qfind THOR#?.lha
  215.  
  216. will use qfind on the host "bbs" and give the following output:
  217.  
  218. fil:thor/thor-icons.lha
  219. fil:uts/thor125.lha
  220. fil3:upload/thortags12.lha
  221.  
  222. > req mg cmd "dir ram:"
  223.  
  224. will  run  the command line "dir ram:" on the host "mg", producing the
  225. following output:
  226.  
  227.      ENV (dir)
  228.      Clipboards (dir)
  229.      T (dir)
  230.  
  231. (NOTE:   The  CMD option requires that remote execution of programs is
  232. enabled on the host machine with the CMDALLOWED tooltype to ReqServer).
  233.  
  234. > req tl finger
  235.  
  236. will finger the host "tl" and might produce the following output:
  237.  
  238. tl    : 07-Jan-95 19:38:15,  01:26:17
  239.  
  240. As  you  can see from the output, the host "tl" hasn't been used for 1
  241. hour, 26 minutes and 17 seconds.
  242.  
  243. 3.1 - Tips & Tricks
  244. ~~~~~~~~~~~~~~~~~~~
  245. - ReqServer offers a command history that can be cycled thru with cursor
  246.   keys up or down.
  247. - RAmiga-H can be used to cycle between hosts even if the text string
  248.   gadget is active in ReqServer.
  249. - ReqServer will datestamp all incoming messages.
  250. - Long lines will be wrapped by ReqServer.
  251.  
  252. 4.0 - History
  253. ~~~~~~~~~~~~~
  254.  
  255. ReqServer:
  256.     950110 - Initial release 1.0.
  257.  
  258. Req:
  259.     950110 - Initial release 1.0.
  260.  
  261.  
  262. 4.1 - FeedBack
  263. ~~~~~~~~~~~~~~
  264. Please  send  donations,  bug  reports or a list of features you would
  265. like to have included in future releases to:
  266.  
  267. Magne Østlyngen
  268. Strandveien 59B
  269. N-9007 Tromsø
  270. Norway
  271.  
  272. Email: magneoe@stud.cs.uit.no
  273. Fido:  2:212/8.15 (Magne Oestlyngen)
  274.  
  275. You can also get in touch with me at the following BBSes in Norway:
  276. Ultima Thule and Abbs Support.
  277.  
  278. Thanks  to  Petter Nilsen for writing this documentation, beta-testing
  279. and useful suggestions.  Thanks to Tommy Larsen for useful suggestions
  280. and beta-testing.
  281.