mirror of
https://github.com/Mikaela/Limnoria-doc.git
synced 2024-11-27 14:59:25 +01:00
162 lines
4.9 KiB
ReStructuredText
162 lines
4.9 KiB
ReStructuredText
|
|
.. _plugin-user:
|
|
|
|
The User plugin
|
|
===============
|
|
|
|
.. _command-user-username:
|
|
|
|
user username <hostmask|nick>
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Returns the username of the user specified by *<hostmask>* or *<nick>* if
|
|
the user is registered.
|
|
|
|
.. _command-user-set-password:
|
|
|
|
user set password [<name>] <old password> <new password>
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Sets the new password for the user specified by *<name>* to *<new
|
|
password>*. Obviously this message must be sent to the bot
|
|
privately (not in a channel). If the requesting user is an owner
|
|
user (and the user whose password is being changed isn't that same
|
|
owner user), then *<old password>* needn't be correct.
|
|
|
|
.. _command-user-set-secure:
|
|
|
|
user set secure <password> [<True|False>]
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Sets the secure flag on the user of the person sending the message.
|
|
Requires that the person's hostmask be in the list of hostmasks for
|
|
that user in addition to the password being correct. When the
|
|
secure flag is set, the user *must* identify before he can be
|
|
recognized. If a specific True/False value is not given, it
|
|
inverts the current value.
|
|
|
|
.. _command-user-stats:
|
|
|
|
user stats
|
|
^^^^^^^^^^
|
|
|
|
Returns some statistics on the user database.
|
|
|
|
.. _command-user-hostmask-hostmask:
|
|
|
|
user hostmask hostmask [<nick>]
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Returns the hostmask of *<nick>*. If *<nick>* isn't given, return the
|
|
hostmask of the person giving the command.
|
|
|
|
.. _command-user-hostmask-list:
|
|
|
|
user hostmask list [<name>]
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Returns the hostmasks of the user specified by *<name>*; if *<name>*
|
|
isn't specified, returns the hostmasks of the user calling the
|
|
command.
|
|
|
|
.. _command-user-hostmask-add:
|
|
|
|
user hostmask add [<name>] [<hostmask>] [<password>]
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Adds the hostmask *<hostmask>* to the user specified by *<name>*. The
|
|
*<password>* may only be required if the user is not recognized by
|
|
hostmask. *<password>* is also not required if an owner user is
|
|
giving the command on behalf of some other user. If *<hostmask>* is
|
|
not given, it defaults to your current hostmask. If *<name>* is not
|
|
given, it defaults to your currently identified name. This message
|
|
must be sent to the bot privately (not on a channel) since it may
|
|
contain a password.
|
|
|
|
.. _command-user-hostmask-remove:
|
|
|
|
user hostmask remove <name> <hostmask> [<password>]
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Removes the hostmask *<hostmask>* from the record of the user
|
|
specified by *<name>*. If the hostmask given is 'all' then all
|
|
hostmasks will be removed. The *<password>* may only be required if
|
|
the user is not recognized by his hostmask. This message must be
|
|
sent to the bot privately (not on a channel) since it may contain a
|
|
password.
|
|
|
|
.. _command-user-unregister:
|
|
|
|
user unregister <name> [<password>]
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Unregisters *<name>* from the user database. If the user giving this
|
|
command is an owner user, the password is not necessary.
|
|
|
|
.. _command-user-register:
|
|
|
|
user register <name> <password>
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Registers *<name>* with the given password *<password>* and the current
|
|
hostmask of the person registering. You shouldn't register twice; if
|
|
you're not recognized as a user but you've already registered, use the
|
|
hostmask add command to add another hostmask to your already-registered
|
|
user, or use the identify command to identify just for a session.
|
|
This command (and all other commands that include a password) must be
|
|
sent to the bot privately, not in a channel.
|
|
|
|
.. _command-user-list:
|
|
|
|
user list [--capability=<capability>] [<glob>]
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Returns the valid registered usernames matching *<glob>*. If *<glob>* is
|
|
not given, returns all registered usernames.
|
|
|
|
.. _command-user-capabilities:
|
|
|
|
user capabilities [<name>]
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Returns the capabilities of the user specified by *<name>*; if *<name>*
|
|
isn't specified, returns the capabilities of the user calling the
|
|
command.
|
|
|
|
.. _command-user-unidentify:
|
|
|
|
user unidentify
|
|
^^^^^^^^^^^^^^^
|
|
|
|
Un-identifies you. Note that this may not result in the desired
|
|
effect of causing the bot not to recognize you anymore, since you may
|
|
have added hostmasks to your user that can cause the bot to continue to
|
|
recognize you.
|
|
|
|
.. _command-user-identify:
|
|
|
|
user identify <name> <password>
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Identifies the user as *<name>*. This command (and all other
|
|
commands that include a password) must be sent to the bot privately,
|
|
not in a channel.
|
|
|
|
.. _command-user-whoami:
|
|
|
|
user whoami
|
|
^^^^^^^^^^^
|
|
|
|
Returns the name of the user calling the command.
|
|
|
|
.. _command-user-changename:
|
|
|
|
user changename <name> <new name> [<password>]
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Changes your current user database name to the new name given.
|
|
*<password>* is only necessary if the user isn't recognized by hostmask.
|
|
This message must be sent to the bot privately (not on a channel) since
|
|
it may contain a password.
|
|
|