[ 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_list [ "from" <user> ]

Lists users who are banned from an account.

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

user
The user you want to ban.
community
Optional; to ban a user from a community you maintain.

ban_unset [<user>|+inactive] [ "from" <community> ]

Remove a ban on a user.

user
The user you want to unban.
community
Optional; to unban a user from a community you maintain.

community <community> <action> <user>

Add or remove a user from a community.

community
The username of the community.
action
Only 'remove' is supported right now.
user
The user you want to remove from the community.

contrib <command> [ <username>/<ackid> ] [ <contribtype> ] [ <msg> ] [ <url> ]

Adds/Acks contributions.

command
Either 'ack' to ack a contrib, 'add' to add a contrib.
username
The username for the contribution to add.
ackid
ID of the contribution to ack.
contribtype
One of: code, doc, creative, biz, other
desc
Description of what they did
url
URL with more information

delete_comments <user> [ "from" <journal/community> ]

Delete all the comments from any user in own journal / community

user
Username
jc
Journal/Community

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

help [ <command> ]

Get help on console commands.

command
A command to get help on. If omitted, prints help for all commands.

moodtheme_create <name> <desc>

Create a new moodtheme. Returns the mood theme ID that you'll need to define moods for this theme.

name
Name of this theme.
desc
A description of the theme

moodtheme_list [ <themeid> ]

List mood themes, or data about a mood theme.

themeid
Optional; mood theme ID to view data for. If not given, lists all available mood themes.

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 of picture for this mood. Use /img/mood/themename/file.gif for public mood images
width
Width of picture
height
Height of picture

print ...

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> [ <reason> ]

Set the value of a userprop.

community
Optional; community to set property for, if you're a maintainer.
propname
Property name to set.
value
Value to set property to.
reason
Optional; reason why you do it.

shared <sharedjournal> <action> <user>

Add or remove posting access 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.

tag_display [ "for" <community> ] <tag> <value>

Set tag visibility to S2.

community
Community that this tag is in, if applicable.
tag
The tag to change the display value of. This must be quoted if it contains any spaces.
value
Either 'on' to display tag, or 'off' to hide it.

tag_permissions [ "for" <community> ] <add level> <control level> <merge level>

Set tagging permission levels for an account.

community
Optional; community to change permission levels for.
add level
Accounts at this level can add existing tags to entries. One of 'public', 'friends', 'private', 'author_moder' 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.
merge level
Accounts at this level can merge and rename tags. Value is one of 'private' or 'owner'. Only for community.