Console Reference

[ console | reference ]

Grammar
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.

Command Reference
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.

ban_set <user> [ "from" <community> ]

Ban another user from posting in your journal. In the future, banning a user will also prevent them from text messaging you, adding you as a friend, etc... Basically, banning somebody restricts their interaction with you severely.

user: This is the user which the logged in user wants to ban.
community: Optional, to ban a user from a community you run.

ban_unset <user> [ "from" <community> ]

Remove a ban on a user.

user: The user that will be unbanned by the logged in user.
community: Optional, to unban a user from a community you run.

blurty_block_user [user] <action>

Block/unblock a user from being listed on the front page.

user: Username of the user you what block or unblock
action: Should be 'block', 'unblock', 'show', or 'list'.

change_community_admin <community> <new_owner>

Change the ownership of a community.

community: The username of the community.
new_owner: The username of the new owner of the community.

change_journal_type <journal> <type>

Change a journal's type from community to either person (regular), or a shared journal.

journal: The username of the journal that type is changing.
type: Either 'person' or 'shared'

community <community> <action> <user>

Add or remove a member from a community.

community: The username of the community.
action: Either add or remove.
user: The user you want to add or remove from the community.

deletetalk <user> <itemid> <talkid>

Delete a comment.

user: The username of the journal comment is in.
itemid: The itemid of the post to have a comment deleted from it.
talkid: The talkid of the comment to be deleted.

faqcat <command> <commandargs>

Tool for managing FAQ categories.

command: 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.
commandargs: '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".

finduser <criteria> <data>

Find a user by a criteria.

criteria: Currently the only known criterias are 'email' or 'user'
data: The thing you know about the user, either their username or their email address.

friend <command> [<username>] [<group>]

List your friends, add a friend, or remove a friend. Optionally, add friends to friend groups.

command: Either 'list' to list friend, 'add' to add a friend, or 'remove' to remove a friend.
username: The username of the person to add or remove when using the add or remove command.
group: When using command 'add', this 3rd parameter can list the name of a friend group to add the friend to. The group must already exist.

get_maintainer <community name>

Finds out the current maintainer(s) of a community

community name: The username of the community you want to lookup.

getemail <user>

Get a user's email address. (for emailing them about TOS violations)

user: The username of the person whose email address you'd like to see.

help [<command>]

Get help on admin console commands

command: The command to get help on. If ommitted, prints a list of commands.

infohistory <user>

Retrieve the infohistory of a given user

user: The user whose infohistory is being retrieved.

moodtheme_create <name> <des>

Create a new mood icon set. Return value from this command is the moodthemeid that you'll need to define pictures for this theme.

name: Name of this theme, to appear in various places on the site
des: Some description of the theme

moodtheme_list [<themeid>]

List mood themes, or data about a mood theme

themeid: Optional mood theme ID. If given, you view the data for that theme, otherwise you see just a list of the available mood themes

moodtheme_public <themeid> <setting>

Make a mood theme public or not. You have to be a moodthememanager to do this.

themeid: Mood theme ID number.
setting: Either 'Y' or 'N' to make it public or not public, respectively.

moodtheme_setpic <themeid> <moodid> <picurl> <width> <height>

Change data for a mood theme. If picurl, width, or height is empty or zero, the data is deleted.

themeid: Mood theme ID number.
moodid: Mood ID number.
picurl: URL to picture to show for this moodid in this themeid. If a public one, use /img/mood/themename/file.gif
width: Width of picture
height: Height of picture

payment_credit <thing> <id> to <username>

Give payment credit to an existing user from either an account code or a payid. Marks the associated code as then used by that username.

thing: Either 'code' or 'payment'.
id: If code, the code; if payment, the payid.
username: The username to give the time to.

print ...

This is a debugging function. Given an arbitrary number of meaningless 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 a userprop.

community: Community to set property for, if you're a maintainer.
propname: Property name to set.
value: Value to set property to.

shared <sharedjournal> <action> <user>

Add or remove access for a user to post in a shared journal.

sharedjournal: The username of the shared journal.
action: Either add or remove.
user: The user you want to add or remove from posting in the shared journal.

suspend <user> <reason>

Suspend a user's account.

user: The username of the person to suspend.
reason: Why you're suspending the account.

tp_catcreate <parent> <name> [sort]

Creates a new topic directory category, in which you can later put topics

parent: Category ID number of the category in which this new category should fall under.
name: The name of this new category
sort: Optional parameter which be one of {alpha, date} to specify if topics within this category should be sorted by the time they were created (as should be the case for news-related categories) or in alphabetical order (like for Movie Reviews). Default is alphabetical.

tp_catedit <catid> <property> <value>

Edit various settings of an existing topic directory category, given the category ID.

catid: Category ID number
property: Property of the category to edit. Can be one of name to set the name of the topic, parent to set what category ID that this category belongs under, status to set the category status (to one of {on, off}), or sort (to one of {alpha, date})
value: The value you're setting the property to.

tp_itemedit <topid> <itemid> <status>

Sets an item's status in a topic. If the item doesn't exist in the topic already, it is added with the status given.

topid: The topic ID the journal entry is in (or will be in).
itemid: The journal entry item ID.
status: The new status of itemid in topid. Can be one of 'on', 'off', 'new', or 'deny'.

tp_topcreate <catid> <name> [des]

Creates a new topic category. Returns the newly created topic ID number. The topic's status will be 'on'. If you want to turn it off temporarily while you populate it, use tp_topedit to set its status to off.

catid: The category ID to put this new topic in.
name: The name for the new category.
des: A description of the topic

tp_topedit <topid> <property> <value>

Edit various settings of an existing topic directory topic, given the topic ID.

topid: Topic ID number
property: Property of the topic to edit. Can be one of name to set the name of the topic, catid to set what category the topic belongs in, des to set the topic description, or status to set the topic status (to one of {new, on, off, deny})
value: The value you're setting the property to.

unpay <user> <payid> <reason>

Takes away paid time from a user for a bogus/accidental payment, while also changing the payment record to 0 months and 0 dollars, and making a note in the statushistory table why the payment was removed, and what the payment's old values were.

user: Username of person to remove time from. Or, use "!" (without the quotes) for no user, when you just want to zero out a payment and/or its associated account code.
payid: Payment ID# to delete
reason: The reason the payment is being deleted. Not sent to user, only put in user's statushistory.

unsuspend <user> <reason>

Unsuspend a user's account.

user: The username of the person to unsuspend.
reason: Why you're unsuspending the account.