jabber_autobuddy.8   [plain text]

.Dd June 29, 2006
.Dt JABBER_AUTOBUDDY 8
.Os "Mac OS X Server"
.Sh NAME
.Nm jabber_autobuddy
.Nd Perform buddy/contact management for jabberd
.Sh SYNOPSIS
.Nm jabber_autobuddy
.Ar [options] <command> [command arguments]
.Sh DESCRIPTION
jabber_autobuddy is not intended to be invoked by users directly.  It is a utility for managing buddies/contacts for jabberd by directly modifying the service's SQLite database tables.  The primary use of the tool is to make all jabber users a "buddy" of every other jabber user, which is not ideal for a system with a large number of users.  See the list of commands for a description of each supported operation.  The JID specified in the commands is of format <username>@<hostname>.  Logging goes to syslog.
.Pp
.Sh OPTIONS
.Bl -tag -width indent
.It Fl "h, ?, --help"
Displays this message. [7]
.It Fl "v, --version"
Display program version information. [7]
.It Fl "V, --verbose"
Enable verbose (detailed) program output to standard error. [5]
.El
.Pp
.Sh COMMANDS
.Bl -tag -width indent
.It Fl "-i  --inituser  <JID>"
Initialize a user's data store in the jabberd database. [1,2,3,8]
.It Fl "-d  --deleteuser <JID>"
Delete a user's data store from the jabberd database. [1,2,3,8]
.It Fl "-a  --addbuddy  <JID>"
Add a user to the buddy list of all other users in the jabberd database. [1,2,8]
.It Fl "-r  --removebuddy  <JID>"
Delete a user from the buddy lists of all other user's in the jabberd database. [1,2,8]
.It Fl "-m  --all"
Make all existing users buddies. [2,4,6]
.It Fl "-g  --group  <GROUP>"
Make buddies of existing users belonging to the Open Directory group. [2,4,6]
.It Fl "-G  --group-by-id  <GROUP ID>"
Make buddies of existing users belonging to the Open Directory group, using the group's GeneratedID.  [2,4,6]
.It Fl "-u  --ungroup  <GROUP>"
Remove all buddy pairings for the Open Directory group. [2,4,6]
.It Fl "-U  --ungroup-by-id  <GROUP ID>"
Remove all buddy pairings for the Open Directory group, using the group's GeneratedID. [2,4,6]
.It Fl "-M  --move-domain  <FROM-DOMAIN>  <TO-DOMAIN>"
Move all users from one jabber domain to another. [9]
.El
.Pp
.Sh Notes
.Pp
[1] JID is a Jabber ID in the form <username>@<hostname>, where:
      username   is the short name (record name) from any Open Directory
                 account in the server's directory search path.
      hostname   is be a domain (or realm) that the local jabberd service 
                 is configured to host.
.Pp
[2] Commands which modify the jabberd database may be used multiple times
    in the same execution and in any order.  However, when used this way,
    the commands are evaluated in the following order:
      * all --deleteuser commands
      * all --inituser commands
      * all --removebuddy commands
      * all --addbuddy commands
      * the --all, --group or --ungroup command
.Pp
[3] The --inituser and --deleteuser commands only modify the local
    jabberd database for the selected users.  These command do not affect
    user account data stored in the directory.
.Pp
[4] The --all, --group and --ungroup commands may not be used in the same
    execution.
.Pp
[5] Multiple uses of the --verbose option are treated as a single use of
    that option.
.Pp
[6] Multiple uses of the --all, --group or --ungroup commands are treated
    as a single use of each command.
.Pp
[7] Use of the --help or --version commands in combination with other
    commands will only display the help or version text.  All other
    commands will be ignored for that execution.
.Pp
[8] The --inituser command is a prerequisite for the  --deleteuser,
    --addbuddy and --removebuddy commands.
.Pp
[9] The format for domains is the same as for host names 
    (ex: example.com, chat.example.com, etc).