Commands ======== These are all the commands that are available in BillingKom. The command names here are the internal names, not commands that can be entered inside BillingKom. In the commands configuration file, you can define the commands that can be used inside BillingKom. Anything that is entered after the command inside BillingKom is called the argument. Anything that is entered after the command in the commands configuration file is called the data for the command. There are two types of commands in BillingKom, normal commands and message commands. Message commands are commands that can be given at the prompt that appears after you have written a message or when you are editing a message. All other commands are given at the normal prompt, that is the prompt that appears all the time when reading messages. Lines with message commands have to begin with a "-" in the commands configuration file so that BillingKom knows that they are message commands. You should always have commands that use NEXTSELECTED, NEXTCOMMENT, NEXTTEXT, NEXTGROUP and SHOWTIME in your commands configuration file. The reason for this is that these commands will be default command under certain circumstances. Normal commands =============== Command: NEXTGROUP Argument: No Data: No Description: Takes you to the next group that you are subscribed to. Command: WHERE Argument: No Data: No Description: Shows you where you are in BillingKom. The command shows you the current group and also displays the number of unread messages in that group. Command: LISTSUBJECTS Argument: No Data: No Description: This command gives you a list of all the unread messages in the current group. Command: LISTPARKED Argument: No Data: No Description: This command lists all the messages which are parked and to which you are the owner. Parking can be used when you are not finished with a message, but still want to save it. Parked messages are never exported from UMS. Command: LISTUNREAD Argument: No Data: No Descriptions: This command lists all groups that you are subscribed to that have any unread messages. Groups that contains unread messages that are replies to messages written by you have a '*' in front of them. (Those groups would be displayed in white in IntuiNews.) Command: LISTGROUPS Argument: Optional, a search string for the group Data: No Description: This command lists all groups to which you have ReadAccess. If you enter an argument, only groups that contain that string will be listed. Command: JUMPTREE Argument: No Data: No Description: Marks all messages in the same reply tree as the last read message as read. Command: VERSION Argument: No Data: No Description: Shows the version of BillingKom. Command: SHOWTIME Argument: No Data: No Description: Shows the current date and time. Command: QUIT Argument: No Data: No Description: Exits BillingKom. Command: DUMPTEXT Argument: Yes, a message number Data: No Description: Show an UMS message with all available information about the message. Command: READTEXT Argument: Yes, a message number Data: No Description: Shows an UMS message. You can also enter a message number directly at the prompt instead of using this commands. The list of comments waiting to be read is cleared. Command: READAGAIN Argument: No Data: No Description: Shows the last read message again. Command: READPARENT Argument: No Data: No Description: If the last read message was a comment, this command shows the original message. Command: BACKWARDS Argument: No Data: No Description: Go backwards among the read messages. Command: FORWARDS Argument: No Data: No Description: Go forwards among the read messages. Command: NEXTTEXT Argument: No Data: No Description: Shows you the next unread message in the current group. Command: NEXTCOMMENT Argument: No Data: No Description: Show you the next message in the comment queue. Everytime you read a message, any comments to that message will be placed in a list that contains comments to be read. This command lets you read the next message in that list. BillingKom traverses the comment tree depth-first which means that you will always read comments to the last text before reading messages that were comments to the same message as the last read message. Command: LISTCOMMANDS Argument: No Data: No Description: Gives you a plain list of the commands available at this time. If you want a prettier list, use the SHOWFILE command. Command: UNREAD Argument: Yes, the number of unread messages you want Data: No Description: Sets the number of unread messages in the current group to the specified amount of unread messages. Command: SHOWFILE Argument: No Data: Yes, the name of the file to display. Description: Displays a text file. Command: GOTOGROUP Argument: Yes, the name of the group to go to. Data: No Description: This command takes you to a group of your choice. Command: POSTPONE Argument: Optional, the last read message if not specified Data: No Description: Sets the Postponed flag for the message. Command: POSTPONEDUNREAD Argument: No Data: No Description: Makes all messages with the Postponed flag unread again. This is also done automatically everytime you login. Command: EXECUTE Argument: Optional, use as %a in the command Data: Command to execute Description: Executes a command. You can use the following %-codes in the command: %n Name used to login into UMS %p Password used to login into UMS %u The real name of the user %a Any arguments given at the prompt %l Screen length in lines %c Screen width in columns Command: DELETE Argument: Optional, operates on last read message if not specified Data: No Description: Deletes a message from the UMS messagebase. Command: SCREENLENGTH Argument: Optional Data: No Description: Displays the current screen length if no argument, sets the screen length to the specified number of lines if an argument was given. Command: LINEWIDTH Argument: Optional Data: No Description: Displays the current line width if no argument, sets the line width to the specified number of columns if an argument was given. Command: LISTFLAGS Argument: No Data: No Description: Lists the available flags. Command: FLAGON Argument: Yes, a flag Data: No Description: Turns on a flag. Command: FLAGOFF Argument: Yes, a flag Data: No Description: Turns off a flag. Command: SUBSCRIBE Argument: Yes, a group name or "all" Data: No Description: Subscribe to a group. If you specify "all" as the argument (or rather the "all" string configured in the texts configuration file) you subscribe to all available groups. Command: UNSUBSCRIBE Argument: Yes, a group name or "all" Data: No Description: Unsubscribe from a group. If you specify "all" as the argument (or rather the "all" string configured in the texts configuration file) you unsubscribe from all groups. Command: PARK Argument: Optional, operates on last read message if not specified Data: No Description: Sets the Parked flag on the message. Messages with the Parked flag set are not exported from UMS by most exporters. See also the message command PARKMESSAGE. Command: UNPARK Argument: Optional, operates on last read message if not specified Data: No Description: Removes the Parked flag on the message. Messages with the Parked flag set are not exported from UMS by most exporters. See also the message command PARKMESSAGE. Command: UNPARK Argument: Optional, operates on last read message if not specified Data: No Description: Removes the Parked flag on the message. Messages with the Parked flag set are not exported from UMS by most exporters. See also the message command PARKMESSAGE. Command: POSTMESSAGE Argument: No Data: No Description: Creates a new message in the current group. Can not be used in mail folders. After you have entered a subject and written the message, you will be at the message command prompt. Command: MAILMESSAGE Argument: Yes, person to write to Data: No Description: Creates a new mail. Can be used in both groups and mail folders. If you are in a mail folder in BillingKom, the mail will be created in the same folder. After you have entered a subject and written the message, you will be at the message command prompt. MAILMESSAGE understands addresses with these syntaxes: username (for local users) username@domain (for RFC-type adresses) username,address (for all other users) (username@domain is equivalent to username,username@domain) Command: FOLLOWUP Argument: "override" (optional, the name is configurable may be different) Data: No Description: This command creates an followup (reply in a group) to the last read message. If the last message was a mail, this is the same as REPLY. Usually this command automatically reads the ReplyGroup field in UMS and creates the followup in the group that was requested by the author. If the ReplyGroup was set to "poster", REPLY is used instead of this command. To override this behavious, you can use the argument "override". (Or whatever name you have given it in the text configuration file.) If you have BillingKom.AnswerTo.groupname set in ums.config, the followup will automatically be moved to the configured group. This behaviour can also be overridden with the "override" argument. After you have entered a subject and written the message, you will be at the message command prompt. Command: REPLY Argument: "override" (optional, the name is configurable may be different) Data: No Description: This command creates a personal reply in mail to the last read message. This works in both mail folders and group.s Usually this command automatically reads the ReplyTo field in UMS and replies to the address specified there. To override this behavious, you can use the argument "override". (Or whatever name you have given it in the text configuration file.) After you have entered a subject and written the message, you will be at the message command prompt. Command: EDITMESSAGE Argument: Optional, operates on last read message if not specified Data: No Description: After the message has been read from the messagebase, you are at the message command prompt again and can edit the message. If you decide to save the new message, the old message will be removed. Command: FORWARDMAIL Argument: Yes, person to forward the message to Data: no Description: This command lets you forward the last read message to a person specified by you. The same address syntax as for MAILMESSAGE is used. After entering this command you will find yourself at the message command prompt. Command: FORWARDPOST Argument: Yes, group to forward message to Data: No Description: This command lets you forward the last read message to a group of your choice. After entering this command you will find yourself at the message command prompt. Command: SELECT Argument: "none" or [+] select criteria Data: No Description: With this command, you can select messages that match the specified select criteria. If you enter "none" (or an other name, the name is configurable) all selected messages will simply be unselected. Normally the command first select all messages and then unselects all messages that don't match the criteria. If a "+" character is entered as the first character of the arguments, this will not be done and the selection will only be done among the messages that already were selected. This means that you can use the "+" character to add selection criteria to a previous search. Allowed search criteria: Status search. You can select all messages that have a special status flag set or unset. To select messages with the flag set, enter the name of the flag. To select all messages without the flag set, enter !flagname. This kind of search is very fast in UMS and will be finished almost instantaneously. Known flags: Archive Junk PostPoned Selected Old WriteAccess ReadAccess ViewAccess Owner UFlag0 UFlag1 UFlag2 UFlag3 UFlag4 UFlag5 UFlag6 UFlag7 UFlag8 UFlag9 UFlagA UFlagB UFlagC UFlagD UFlagE UFlagF Deleted Expired Exported Orphan Link Hardlink Parked HasFile Field search. You can use message fields to select messages. The syntax for this kind of search is " " where the search pattern may be a simple string or an AmigaDOS pattern. Searches on an indexed field for an exact string is very fast while other searches may take some time. Known fields: MsgText FromName* FromAddr ToName* ToAddr MsgID* CreationDate ReceiveDate ReferID* Group* Subject* Attributes Comments Organization Distribution Folder* FidoID MausID ReplyGroup ReplyName ReplyAddr LogicalToName LogicalToAddr FileName RFCMsgNum FidoText ErrorText Newsreader RFCAttr FTNAttr ZerAttr MausAttr TempFileName (The fields with an asterisk are those fields that are normally indexed and the fields the BillingKom actually assumes are indexed. If you have other fields indexed too, searches on those fields will still not be very fast. If some of the fields here are not indexed in your messagebase, everything will still work but BillingKom will not show how much of the search has been done when searching those fields. You can configure which fields should be indexed in ums.config.) Age. Use this to only select messages newer than a specified number of days. The syntax is "Age ". (The used date is the date when the message was written to your messagebase, not the date it was written by the sender.) Also a very fast search. Local. If you specify "local" as a search criterion, only messages in the current group or mail folder will be selected. Also a very fast search. ParentOwner. Select all messages that have a parent message of which you are the owner. In other words, this selects all messages that are followups to messages written by you. Also a very fast search. Hint: When selecting with many criteria, enter the fast selection criteria first so that the slow search only has to be performed on the messages that match the selection criteria checked so far and not on all the messages in the messagebase. Some examples: ParentOwner !Old Selects all unread messages that are followups to messages written by you. !Exported Owner Selects all messages written by you that have not been exported from the messagebase. Newsreader billingkom#? !Owner Selects all messages written with BillingKom that were not written by you. Command: LISTSELECTED Argument: No Data: No Description: Lists all the selected messages. Command: NEXTSELECTED Argument: No Data: No Description: Shows you the next selected message and unselects it. Command: HELP Argument: Command name to get help for Data: Name of the file to display Descriptiion: With this command, the user can request help for one of the built-in commands in BillingKom. In the name of the file to display, you can use "%c" as the name of the command the user requested help for. Example: "PROGDIR:Help/%c.txt". Then have filed named HELP.txt, VERSION.txt etc in the PROGDIR:Help directory. (No help files have been included in this release since I don't need them myself, if you write help files please send them to me. :-)) Message commands ================ Command: ADDRECIPIENT Argument: Name of recipient Data: No Description: This commands adds a recipient to the message you are currently composing. If the message is a mail, this commands adds another person. If the message is in a group, this command adds another group. A message can have several recipients. Same syntax for mail addresses as for MAILMESSAGE. Command: REMRECIPIENT Argument: Name of recipient Data: No Description: This commands removes a recipient from the message you are currently composing. If the message is a mail, this commands removes a person. If the message is in a group, this command removes a group. Command: MOVEGROUP Argument: Name of recipient Data: No Description: This commands adds a recipient to the message you are currently composing and removes all the other recipients. Can only be used when posting messages in groups. Command: SHOWHEADER Argument: No Data: No Description: Shows the header of the message you are composing. Command: SETSUBJECT Argument: New subject (optional) Data: No Description: This command allows you to change the subject of the message you are composing. If an argument is given, the subject is changed. If no argument is given, the current subject is shown and you are asked to enter a new subject. An empty line leaves the subject unchanged and a space character removes the subject. Command: SETATTRIBUTES Argument: New attributes (optional) Data: No Description: This command allows you to change the attributes of the message you are composing. If an argument is given, the attributes are changed. If no argument is given, the current attributes are shown and you are asked to enter new attributes. An empty line leaves the attributes unchanged and a space character removes the attribute. The default attribute can be set with the BillingKom.Attributes variable in ums.config. Command: SETORGANIZATION Argument: New organization (optional) Data: No Description: This command allows you to change the organization of the message you are composing. If an argument is given, the organization is changed. If no argument is given, the current organization is shown and you are asked to enter a new organization. An empty line leaves the organization unchanged and a space character removes the organization. The default organization can be set with the BillingKom.Organization variable in ums.config. Command: SETDISTRIBUTION Argument: New distribution (optional) Data: No Description: This command allows you to change the distribution of the message you are composing. If an argument is given, the distribution is changed. If no argument is given, the current distribution is shown and you are asked to enter a new distribution. An empty line leaves the distribution unchanged and a space character removes the distribution The default distribution can be set with the BillingKom.Dist variable in ums.config. Command: SETFOLLOWUPGROUP Argument: New ReplyGroup (optional) Data: No Description: This command allows you to change the ReplyGroup of the message you are composing. With the ReplyGroup, you can ask persons who followup to your message to do it in a specific group. They don't necessarily have to follow your request and ReplyGroup is not supported in all networks. If an argument is given, the ReplyGroup is changed. If no argument is given, the current ReplyGroup is shown and you are asked to enter a new ReplyGroup. An empty line leaves the ReplyGroup unchanged and a space character removes the ReplyGroup. The default ReplyGroup can be set with the BillingKom.FupTo variable in ums.config. Command: SETREPLYTO Argument: New ReplyTo (optional) Data: No Description: This command allows you to change the ReplyTo of the message you are composing. With the ReplyTo, you can ask persons who send personal replies to your message to do it to another address the the sender adress. They don't necessarily have to follow your request and ReplyGroup is not supportedin all networks. If an argument is given, the ReplyTo is changed. If no argument is given, the current ReplyTo is shown and you are asked to enter a new ReplyTo. An empty line leaves the ReplyTo unchanged and a space character removes the ReplyTo. Use the same syntax for the address as for MAILMESSAGE. The default ReplyGroup can be set with the BillingKom.ReplyTo variable in ums.config. Command: SETATTACHMENT Argument: New attachment (optional) Data: No Description: This command allows you to set the name of a file that you want to attach to the message you are composing. If an argument is given, the filename is changed. If no argument is given, the current filename is shown and you are asked to enter a new filename. An empty line leaves the filename unchanged and a space character removes the filename. Only local users can attach files to messages. Command: EDITTEXT Argument: No Data: No Description: Starts up the editor with your message again. Command: CANCELMESSAGE Argument: No Data: No Description: Throws away the message you have been composing. Command: SAVEMESSAGE Argument: No Data: No Description: Saves the message you have been composing to the messagebase. Command: PARKMESSAGE Argument: No Data: No Description: Saves the message you have been composing to the messagebase and sets the Parked flag. Command: LISTCOMMANDS Argument: No Data: No Description: Gives you a plain list of the commands available at this time. If you want a prettier list, use the SHOWFILE command. Command: PARKMESSAGE Argument: No Data: No Description: Saves the message you have been composing to the messagebase and sets the Parked flag. Command: SHOWFILE Argument: No Data: Yes, the name of the file to display. Description: Displays a text file. Command: HELP Argument: Command name to get help for Data: Name of the file to display Description: See the HELP command above.