[ console | reference ]
Think of this like a DOS or bash prompt. The first word is a command. Every word after that is an argument to that command. Every command has a different number of required and optional parameters. White space delimits arguments. If you need a space in an argument, put double quotes around the whole thing. If you need double quotes and spaces in an argument, escape the quote with a backslash (\) first. If you need to do a backslash, escape that with a backslash.
It's pretty straight-forward. If you're confused, ask.
Arguments in <angle brackets> are required. Arguments in [brackets] are optional. If there is more than one optional argument, you can't skip one and provide one after it. Once you skip one, you have to skip the rest.
Lists users who are banned from an account.
- Optional; lists bans in a community you maintain, or any user if you have the 'finduser' priv.
|ban_set <user> [ "from" <community> ]|
Ban another user from posting in your journal or community.
- The user you want to ban.
- Optional; to ban a user from a community you maintain.
Remove a ban on a user.
- The user you want to unban.
- Optional; to unban a user from a community you maintain.
Change a journal's type.
- The username of the journal that type is changing.
- Either 'person', 'shared', or 'community'.
- This is required when converting a personal journal to a community or shared journal, or the reverse. If converting to a community/shared journal, 'owner' will become the maintainer. Otherwise, the account will adopt the email address and password of the 'owner'. Only users with the 'changejournaltype' priv can specify an owner for an account.
Add or remove a user from a community.
- The username of the community.
- Only 'remove' is supported right now.
- The user you want to remove from the community.
|faqcat <command> <commandargs>|
Tool for managing FAQ categories.
- One of: list, delete, add, move. 'list' shows all the defined FAQ categories, including their catkey, name, and sortorder. Also, it shows all the distinct catkeys that are in use by FAQ. 'add' creates or modifies a FAQ category. 'delete' removes a FAQ category (but not the questions that are in it). 'move' moves a FAQ category up or down in the list.
- 'add' takes 3 arguments: a catkey, a catname, and a sort order field. 'delete' takes one argument: the catkey value. 'move' takes two arguments: the catkey and either the word 'up' or 'down'.
|friend <command> <user> [ <group> ] [ <fgcolor> ] [ <bgcolor> ]|
List your friends or add/remove a user from your friends list.
- Either 'list' to list friend, 'add' to add a friend, or 'remove' to remove a friend.
- The username of the person to add or remove when using the add or remove command.
- Optional; when using 'add', adds the user to this friend group. It must already exist.
- Optional; when using 'add', specifies the foreground color. Must be of form 'fgcolor=#hex'
- Optional; when using 'add', specifies the background color. Must be of form 'bgcolor=#hex'
Get help on console commands.
- A command to get help on. If omitted, prints help for all commands.
Create a new moodtheme. Returns the mood theme ID that you'll need to define moods for this theme.
- Name of this theme.
- A description of the theme
List mood themes, or data about a mood theme.
- Optional; mood theme ID to view data for. If not given, lists all available mood themes.
Change data for a mood theme. If picurl, width, or height is empty or zero, the data is deleted.
- Mood theme ID number.
- Mood ID number.
- URL of picture for this mood. Use /img/mood/themename/file.gif for public mood images
- Width of picture
- Height of picture
This is a debugging function. Given any number of arguments, it'll print each one back to you. If an argument begins with a bang (!), then it'll be printed to the error stream instead.
|set [ "for" <community> ] <propname> <value>|
Set the value of a userprop.
- Optional; community to set property for, if you're a maintainer.
- Property name to set.
- Value to set property to.
|shared <sharedjournal> <action> <user>|
Add or remove posting access in a shared journal.
- The username of the shared journal.
- Either 'add' or 'remove'.
- The user you want to add or remove from posting in the shared journal.
Set tag visibility to S2.
- Community that this tag is in, if applicable.
- The tag to change the display value of. This must be quoted if it contains any spaces.
- Either 'on' to display tag, or 'off' to hide it.
Set tagging permission levels for an account.
- Optional; community to change permission levels for.
- add level
- Accounts at this level can add existing tags to entries. One of 'public', 'friends', 'private', or a custom friend group name.
- control level
- Accounts at this level can do everything: add, remove, and create new ones. Value is one of 'public', 'friends', 'private', or a custom friend group name.