Difference between revisions of "Chwido"

From Wiki [en] OpenMandriva
Jump to: navigation, search
Line 60: Line 60:
  
  
==admin commands==
+
==Admin commands==
Open a private chat whith chwido, then (see the supybot page in the bbw for credentials):
+
Chwido can understand some special commands dependind on the installed plugins:
  user identify <admin_name> <admin_pwd>
+
  chwido help
 
+
    (help [<plugin>] [<command>])
Add a chair on a meeting (useful when the chair is gone)
+
    This command gives a useful description of what <command> does.
meetbot addchair #openmandriva-cooker freenode username
+
    <plugin> is only necessary if the command is in more than one plugin.
  
You can also list meetbot commands with
+
chwido help list
meetbot listmeetings
+
  (list [--private] [<plugin>])
 +
  Lists the commands available in the given plugin.
 +
  If no plugin is given, lists the public plugins available.
 +
  If --private is given, lists the private plugins.
  
if you write a meetbot command needing arguments with no argument, a quick help will appear, for example
+
===plugin meetbot===
  [16:23] <merlin> meetbot addchair
+
  chwido list meetbot
[16:23] <chwido> (meetbot addchair <channel> <network> <nick>) -- Add a nick as a chair to the meeting.
+
  addchair, deletemeeting, listmeetings, pingall, recent, and savemeetings
  
 +
chwido help addchair
 +
    (addchair <channel> <network> <nick>) -- Add a nick as a chair to the meeting.
  
Other commands are given by
+
  chwido help listmeetings
  list meetbot
+
Example:
+
[16:20] <merlin> list meetbot
+
[16:20] <chwido> addchair, deletemeeting, listmeetings, pingall, recent, and savemeetings
+
+
listmeetings
+
 
     List all meetings.
 
     List all meetings.
  
  savemeetings
+
  chwido help savemeetings
 
     Saves all active meetings on all channels and all networks.
 
     Saves all active meetings on all channels and all networks.
  
  addchair <channel> <network> <nick>
+
  chwido help addchair <channel> <network> <nick>
 
     Forcibly adds this nick as a chair on the giver channel on the given network, if a meeting is active there.
 
     Forcibly adds this nick as a chair on the giver channel on the given network, if a meeting is active there.
  
  deletemeeting <channel> <network> <saveit=True>
+
  chwido help deletemeeting <channel> <network> <saveit=True>
 
     Delete a meeting from the cache.  
 
     Delete a meeting from the cache.  
 
     If save is given, save the meeting first. The default value of save is True.  
 
     If save is given, save the meeting first. The default value of save is True.  
 
     This is useful for when MeetBot becomes broken and is unable to properly save a meeting, rendering the #endmeeting command non-functional.
 
     This is useful for when MeetBot becomes broken and is unable to properly save a meeting, rendering the #endmeeting command non-functional.
  
  recent
+
  chwido help recent
 
     Display the last ten or so started meetings, along with their channels.  
 
     Display the last ten or so started meetings, along with their channels.  
 
     This is useful if you are the bot admin and want to see just who all is using your bot, for example to better communicate with those channels.
 
     This is useful if you are the bot admin and want to see just who all is using your bot, for example to better communicate with those channels.
 +
 +
chwido help pingall
 +
    (pingall <text>)
 +
    Send a broadcast ping to all users on the channel.
 +
    A message to be sent along with this ping must also be supplied for this command to work.
 +
 +
 +
===plugin admin===
 +
 +
chwido list admin
 +
  capability add, capability remove, channels, ignore add, ignore list, ignore remove, join, nick, and part
 +
 +
etc ...
 +
 +
 +
===Adding a chair when the last chair of the meeting is gone===
 +
Open a private chat with chwido, then (see the supybot page in the bbw for credentials):
 +
user identify <admin_name> <admin_pwd>
 +
 
 +
Then (for example)
 +
meetbot addchair #openmandriva-cooker freenode username

Revision as of 13:21, 7 August 2015

Chwido is the IRC bot.

MeetBot

First identify to the bot:

chat in private with KirinOS and send

identify <username> <password>

Test if you're correctly recognized

whoami


Standard commands

#startmeeting
  Starts a meeting. The calling nick becomes the chair. If any text is given on the rest of the line,
  this becomes the meeting topic.
#endmeeting (Chairs only.)
  End a meeting, save logs, restore previous topic, give links to logs. You know the drill. 
#topic (Chairs only.)
  Set the current topic of discussion. MeetBot changes the topic in the channel 
  (saving the original topic to be restored at the end of the meeting). 
#meetingtopic  (Chairs only.)
  Sets the "meeting topic". This will always appear in the topic in the channel, 
   even as the #topic changes.
   The format of the IRCtopic is "<topic> (Meeting Topic: <meeting topic>)"
#agreed (alias #agree) (Chairs only.)
  Mark something as agreed on. The rest of the line is the details. 
#chair and #unchair (Chairs only.)
  Add new chairs to the meeting. The rest of the line is a list of nicks, separated by commas and/or spaces. 
  The nick which started the meeting is the owner and can't be de-chaired. 
  The command replies with a list of the current chairs, for verification (Chairs only.) Example:
     < John> #chair Jack Jane
     < KirinOS> Current chairs are: MsAlizarin MrBeige MrGreen
#action (anyone)
  Add an ACTION item to the minutes. Provide irc nicks of people involved,
  and will be both a complete listing of action items, and a listing of action items 
  sorted by nick at the end of the meeting. This is very useful for making sure this gets done. Example:
    < John> #action Jack will make the docment page
  If Jack has said something during the meeting, this will be automatically assigned to him.
#info (anyone)
  Add an INFO item to the minutes. Example:
  < John> #info We need to have a guru in perl for next release.
#idea (anyone)
  Add an IDEA to the minutes.
#undo
  undo the last command
#save
 This save temporary log (which will be saved only after #endmeeting if no #save command is sent beofre) 
 Could be usefull as we still not have meetbot on a stable server, but it's on my computer, so a internet connection down may lead to a log lost :(  (Raph)


Admin commands

Chwido can understand some special commands dependind on the installed plugins:

chwido help
   (help [<plugin>] [<command>]) 
   This command gives a useful description of what <command> does. 
   <plugin> is only necessary if the command is in more than one plugin.
chwido help list
  (list [--private] [<plugin>])
  Lists the commands available in the given plugin. 
  If no plugin is given, lists the public plugins available. 
  If --private is given, lists the private plugins.

plugin meetbot

chwido list meetbot
  addchair, deletemeeting, listmeetings, pingall, recent, and savemeetings
chwido help addchair
   (addchair <channel> <network> <nick>) -- Add a nick as a chair to the meeting. 
chwido help listmeetings
   List all meetings.
chwido help savemeetings
   Saves all active meetings on all channels and all networks.
chwido help addchair <channel> <network> <nick>
   Forcibly adds this nick as a chair on the giver channel on the given network, if a meeting is active there.
chwido help deletemeeting <channel> <network> <saveit=True>
   Delete a meeting from the cache. 
   If save is given, save the meeting first. The default value of save is True. 
   This is useful for when MeetBot becomes broken and is unable to properly save a meeting, rendering the #endmeeting command non-functional.
chwido help recent
   Display the last ten or so started meetings, along with their channels. 
   This is useful if you are the bot admin and want to see just who all is using your bot, for example to better communicate with those channels.
chwido help pingall
   (pingall <text>)
    Send a broadcast ping to all users on the channel. 
    A message to be sent along with this ping must also be supplied for this command to work.


plugin admin

chwido list admin
  capability add, capability remove, channels, ignore add, ignore list, ignore remove, join, nick, and part
etc ...


Adding a chair when the last chair of the meeting is gone

Open a private chat with chwido, then (see the supybot page in the bbw for credentials):

user identify <admin_name> <admin_pwd>
  

Then (for example)

meetbot addchair #openmandriva-cooker freenode username