Command Reference Manual

User-level commands

calc

• Usage: calc name
• Description: The calc command retrieves and displays the calc specified by name.
• Diagnostics:
  • No entry for "name".
    The specified calc does not exist.

mkcalc

• Usage: mkcalc[/replace][/override][/owner=...] name = value
• Description: The mkcalc command adds a new calc with the name name and the value value to the database.
• Qualifiers:
  • /replace
    If the calc name already exists, replace it with the new value instead of reporting an error.
  • /override
    If the /replace qualifier was given, and you do not own the calc but you possess the admin privilege, this qualifier allows you to bypass the ownership check.
  • /owner=user
    The newly created calc will be owned by user.
• Diagnostics:
  • "name" already exists.
    A calc with the specified name already exists in the database, and /replace was not given.
  • You don't own "name".
    The /replace qualifier was given, but you don't own the existing calc of that name, and /override was not specified.
  • You don't own "name", and /override was not honoured because you do not have admin rights.
    The /replace and /override qualifiers were both supplied, but you do not own the calc, and you do not possess the admin privilege.

rmcalc

• Usage: rmcalc[/override] name
• Description: The rmcalc command removes the specified calc from the database. Only the owner of a calc and users with the admin right may remove it.
• Qualifiers:
  • /override
    If you do not own the calc being removed, but you possess the admin right, this qualifier bypasses the ownership check.
• Diagnostics:
  • No entry for "name".
    The specified calc does not exist in the database.
  • You don't own "name".
    You do not own the calc being removed, and the /override qualifier was not specified.
  • You don't own "name", and the /override qualifier was not honoured because you do not have admin rights.
    You do not own the calc being removed, and the /override qualifier was specified, but you do not possess the admin privilege.

sedcalc

• Usage: sedcalc[/override] s/old/new/ calc-name
• Description: The sedcalc command allows the text of a calc to be changed without removing and recreating it, using regular expressions. The calc calc-name will be searched for the regexp old, and any matches found will be replaced with the text new.
  

  Only the owner of a calc or users with the admin right may modify a calc in this way.

• Example: sedcalc s/test/just testing/ test
  Would change the text "test" in the calc "test" to read "just testing".
• Qualifiers:
  • /override
    If you do not own the calc being modified, but you possess the admin right, this qualifier bypasses the ownership check.
• Diagnostics:
  • No entry for "calc-name".
    The specified calc does not exist in the database.
  • You don't own "calc-name".
    You do not own the calc being removed, and the /override qualifier was not specified.
  • You don't own "calc-name", and the /override qualifier was not honoured because you do not have admin rights.
    You do not own the calc being removed, and the /override qualifier was specified, but you do not possess the admin privilege.
  • An error occured updating "calc-name".
    An unknown error occured while changing the calc. Check that the format of the command regular expression is correct.

appcalc

• Usage: appcalc[/override][/nospace] calc-name = new-text
• Description: The appcalc command appends the text new-text onto the end of the current value of the calc calc-name. The new text will be preceeded by a single space character, unless /nospace was specified.

  Only the owner of a calc or users with the admin right may modify a calc in this way.

• Qualifiers:
  • /nospace
    Do not seperate the existing and new text with a space character.
  • /override
    If you do not own the calc being modified, but you possess the admin right, this qualifier bypasses the ownership check.
• Diagnostics:
  • No entry for "calc-name".
    The specified calc does not exist in the database.
  • You don't own "calc-name".
    You do not own the calc being removed, and the /override qualifier was not specified.
  • You don't own "calc-name", and the /override qualifier was not honoured because you do not have admin rights.
    You do not own the calc being removed, and the /override qualifier was specified, but you do not possess the admin privilege.

lncalc

• Usage: lncalc new-name = existing-calc
• Description: The lncalc command adds an alias for an existing calc. The calc can then be recalled (e.g. with the calc command) via either name.

  All commands except rmcalc have identical behaviour when used on an alias. If rmcalc is used on an alias, only the alias is removed; if it is used on the original calc, both that calc and all aliases pointing to it are removed.

• Diagnostics:
  • No entry for "existing-calc".
    The specified calc does not exist in the database.
  • "new-name" already exists.
    There is already a calc by the name of new-name in the database.

apropos

• Usage: apropos search-term
• Description: The apropos command searches the calc database for calcs whose name contains the string search-term. A wildcard '*' character will match any text.

apropos2

• Usage: apropos2 search-term
• Description: The apropos command searches the calc database for calcs whose value contains the string search-term. A wildcard '*' character will match any text.

ctell

• Usage: ctell user about calc
• Description: The ctell command is identical to the calc command, except that the output is proceeded by "user:". The string "about" is only a placeholder, and may be replaced with any text.

tell

• Usage: tell user about calc
• Description: The tell command is identical to the calc command, except that the output is sent to user instead of the channel. The string "about" is only a placeholder, and may be replaced with any text. User may be a channel name.

owner

• Usage: owner calc-name
• Description: The owner command shows the owner and creator of the calc calc-name.
• Diagnostics:
  • No entry for "calc-name".
    The specified calc does not exist in the database.

owncalc

• Usage: owncalc user-name
• Description: The owncalc command lists all calcs which are owned by the user user-name.

Admin-level commands

chown

• Usage: chown calc-name new-owner
• Description: The chown command changes the owner of the calc calc-name to be new-owner. The calc's creator is unchanged.
• Diagnostics:
  • No entry for "existing-calc".
    The specified calc does not exist in the database.
  • Syntax error.
    The format of the command was incorrect.

adduser

• Usage: adduser user-name
• Description: The adduser command adds a new user with the name user-name to the user database. The new user is created with no hosts and no rights.
• Diagnostics:
  • User "user-name" already exists in the database.
    The specified user already exists.

deluser

• Usage: deluser user-name
• Description: The deluser command removes an existing user from the user database. Any calcs owned by the user are not deleted.
• Diagnostics:
  • No such user "user-name".
    The specified user does not exist.