CINXE.COM
OFTC - GroupServ
<!DOCTYPE html> <html> <head> <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> <meta name="robots" content="index,follow"> <title>OFTC - GroupServ</title> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <link href="/img/oftc-16.png" rel="shortcut icon" type="image/png" /> <link href="/css/bootstrap.min.css" rel="stylesheet" media="screen"> <link href="/css/main.css" rel="stylesheet"> <script src="/js/jquery.min.js"></script> <script src="/js/bootstrap.min.js"></script> <script src="/js/main.js"></script> </head> <body> <div class="navbar navbar-fixed-top"> <div class="navbar-inner"> <div class="container"> <form class="navbar-form pull-right" action="//webchat.oftc.net" method="get" target="_blank"> <input name="nick" type="text" data-toggle="tooltip" title="Enter your IRC nickname" class="span2" placeholder="Nickname"> <input name="channels" type="text" data-toggle="tooltip" title="Enter comma seperated list of channels to join" class="span2" placeholder="#oftc, #moocows"> <input type="hidden" name="uio" value="d4"> <button type="submit" class="btn">Chat!</button> </form> <button type="button" class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <a class="brand" href="/">OFTC</a> <div class="nav-collapse collapse"> <ul class="nav"> <li><a href="/">Home</a></li> <li><a href="/staff/">Staff</a></li> <li><a href="/documentation/">Documentation</a></li> <li><a href="/FAQ/">FAQ</a></li> </ul> </div><!--/.nav-collapse --> </div> </div> </div> <article> <div class="container"> <div class="row-fluid"> <div class="span12"> <ul id="markdown-toc"> <li><a href="#groupserv" id="markdown-toc-groupserv">GroupServ</a> <ul> <li><a href="#register-a-group" id="markdown-toc-register-a-group">Register a group</a></li> <li><a href="#configure-a-group" id="markdown-toc-configure-a-group">Configure a group</a> <ul> <li><a href="#url" id="markdown-toc-url">URL</a></li> <li><a href="#e-mail" id="markdown-toc-e-mail">E-mail</a></li> <li><a href="#private" id="markdown-toc-private">Private</a></li> </ul> </li> <li><a href="#view-group-information" id="markdown-toc-view-group-information">View group information</a></li> <li><a href="#list-groups" id="markdown-toc-list-groups">List groups</a></li> <li><a href="#drop-a-group" id="markdown-toc-drop-a-group">Drop a group</a></li> </ul> </li> <li><a href="#support" id="markdown-toc-support">Support</a></li> </ul> <h1 id="groupserv">GroupServ</h1> <p>The latest upgrade of network services has introduced GroupServ.</p> <p>GroupServ is a services pseudo-client which allows projects using the network to register their group with network services. Registering a group allows projects to join together one or more nicknames, groups can then be added to channel access lists. A group has a name, a description, a registration date, a privacy setting, a list of administrators, and a list of members. A group name starts with an @ (“AT”) character to distinguish it from nicknames. The lists of administrators and members can contain accounts (nicknames).</p> <p>In particular, using GroupServ allows everybody to create and administer, or drop a group, list non-private groups, query information about a group</p> <h2 id="register-a-group">Register a group</h2> <p>Use the command <code class="highlighter-rouge">/msg GroupServ REGISTER @<groupname> <description></code> to register a group. Please use common sense when registering a group, for example if channel <code class="highlighter-rouge">#oftc</code> wanted to register a group, they would register <code class="highlighter-rouge">@oftc</code>, or <code class="highlighter-rouge">@oftc-users</code>.</p> <h2 id="configure-a-group">Configure a group</h2> <h3 id="url">URL</h3> <p>Sets the URL field on a group for display purposes only. The URL address is shown in the INFO command. Use the command <code class="highlighter-rouge">/msg GroupServ SET @<groupname> URL <url></code> to set the URL field, or <code class="highlighter-rouge">/msg GroupServ SET @<groupname> URL -</code> to clear the URL field.</p> <h3 id="e-mail">E-mail</h3> <p>Sets the e-mail field on a group for display purposes only. The e-mail address is shown in the INFO command if PRIVATE is not set. Use the command <code class="highlighter-rouge">/msg GroupServ SET @<groupname> EMAIL <email></code> to set the e-mail field.</p> <h3 id="private">Private</h3> <p>Sets the private flag on a group which prevents an e-mail address being shown in an INFO request, and also prevents a group showing in a LIST. Use the command <code class="highlighter-rouge">/msg GroupServ SET @<groupname> PRIVATE ON|OFF</code> to enable or disable this option.</p> <h2 id="view-group-information">View group information</h2> <p>Use the command <code class="highlighter-rouge">/msg GroupServ INFO @<groupname></code> to get information on a group. GroupServ will then echo all information that services know about that group, excluding e-mail addresses for private groups.</p> <h2 id="list-groups">List groups</h2> <p>Use the command <code class="highlighter-rouge">/msg GroupServ LIST <pattern></code> to list registered groups that match a specified pattern. For example if you wanted to list all groups that contained the word <code class="highlighter-rouge">oftc</code> then use <code class="highlighter-rouge">/msg GroupServ LIST *oftc*</code>. Results are limited to 50 matches, so try to be specific with a pattern. Groups that have the private flag enabled will not be listed.</p> <h2 id="drop-a-group">Drop a group</h2> <p>To delete a group use the command <code class="highlighter-rouge">/msg GroupServ DROP @<groupname></code>. Deleting a group cannot be undone and is the only method of allowing other users to make use of it, or register it for their use.</p> <h1 id="support">Support</h1> <p>For support regarding group services please join <code class="highlighter-rouge">#oftc</code>.</p> </div> </div> </div> <!-- /container --> </article> </body> </html>