/* ** addevent.thor - add an event to the given BBS. ** ** Will return 10 if the BBS given was unknown, the arguments given ** was incorrect, or the event failed for some other reason (e.g. ** the event isn't supported on this BBS type), and 0 on success. ** ** Template: ** ** BBSNAME=BBS/A - The name of the BBS to add this event to ** EVENT/A - The name of the event to add to the given BBS. ** (see detailed description on the events ** supported further down). ** SENDTO/K - Name of a person. ** C=CONF/K - Conference ** REPLYTO/K - If EVENT is REPLYMSG, this will contain the ** message number of the message to send a reply ** to. NOTE: The number is the internal number ** kept in THOR, and NOT the real number as seen ** on the BBS. ** BBSREPLYTO/K - The real number of the message as seen on the ** BBS. ** MSGFILE/K - This is the filename of the text file to be ** used with ENTERMSG and REPLYMSG. Must include ** full path, and this file will be copied into ** the given BBS' directory in BBSDATA: before the ** the event is added. ** SUBJECT=SUB/K - The subject of a message. ** P=PRIVATE/K/S - If this argument is used, the event will be ** private to SENDTO. ** FILENAME=FILE/K - The filename to be used on UPLOAD and DOWNLOAD. ** On UPLOAD, this is the name that the file will ** appear with on the BBS, and can differ from the ** real name as it appear locally for you. ** Can be the full filename with path, in that case ** the filename will be extracted from the path ** and used alone. ** ** LOCALFILENAME=LFILE/K ** - The full path and name of the file, used on ** UPLOAD events. ** ** NOTIFICATION=NOTE/S/K ** - Flag that can be set if you want notification ** on downloads on a file you UPLOAD. ** ** FILEDESCRIPTION=DESCR/K ** - Short file description on a file you UPLOAD. ** ** I=INFO/K - An optional file to be added as long ** file description on UPLOAD. ** COMMANDSTRING=CMD/K - A string to be executed by the script. Might ** e.g. be a Sysop command or any other command ** not supported directly in THOR. ** BOOLEAN=BOOL/S - Used by some event types. If present, the ** flag for an event type will be TRUE, else ** FALSE. ** FROMMSGNR/N/K - A message number to start some operation on a BBS. ** (currently not supported in any script). ** TOMSGNR/N/K - A message number to end some operation on a BBS. ** (currently not supported in any script). ** ** ** ** The following event types can be given with the EVENT argument: ** ** ENTERMSG - Enter a new message. ** REPLYMSG - Reply to a already existing message in the ** message database in THOR. ** JOINCONF - Join a conference. ** RESIGNCONF - Resign from a conference. ** DOWNLOAD - Download a file. ** UPLOAD - Upload a file. ** GETCONFLIST - Get conference list. ** CONFIGUREBBS - Configure BBS (from a script if the script ** supports this event). ** SENDUSERINFO - Send user information about yourself. ** GETMESSAGES - Get messages in CONF starting with FROMMSGNR ** - and ending with TOMSGNR. ** GETNEWFILES - Include a list of new files. ** DOCOMMAND - Execute a custom command ** AUTOLOGOFF - If the BOOLEAN flag is present, this event will ** log you out of the BBS after the script is ** finished, else will not log you out. ** ** ** If you are in doubt about what arguments are required for each event, ** read the "Technical descriptions" chapter on the manual and look ** at each of the BBS types and their event definitions in the THOR:s/ ** directory. If an argument is given that is not required or optional ** for the event, THOR will simply ignore it. However, if you leave out ** an argument THOR needs to add the event, ADDEVENT will return ** 10 in RC. ** ** */