Main Page | Modules | Namespace List | Class Hierarchy | Class List | File List | Class Members | File Members | Related Pages

help.c File Reference

Implementation of services help. More...

#include "services.h"
#include "macro.h"

Go to the source code of this file.

Functions

void motd (char *to)
 Print the services message of the day.

void help (char *to, char *service, char **args, int numargs)
 Handle a user's help request.

help_cachecheck_help_cache (char *filename)
 Check if a help item is in the cache if so return it, else return NULL.

void flush_help_cache (void)
 Flush out the help cache.


Variables

help_cachefirsthelpcache
 First item in the help cache.

help_cachelasthelpcache
 Last item in the help cache.


Detailed Description

Implementation of services help.

Procedures related to services help system

Author:
Chip Norkus

Max Byrd

Greg Poma

Date:
1996-1997
Id
help.c,v 1.1.1.1 2003/07/04 02:53:56 Mysid Exp

Definition in file help.c.


Function Documentation

help_cache* check_help_cache char *  filename  ) 
 

Check if a help item is in the cache if so return it, else return NULL.

Parameters:
filename What help topic filename to look for, already force to lower case.

Definition at line 237 of file help.c.

References firsthelpcache, helpcache_t::name, and helpcache_t::next.

Referenced by help().

void help char *  to,
char *  service,
char **  args,
int  numargs
 

Handle a user's help request.

Parameters:
to User requesting help
service Which service is help being requested of
args args[] array specifying help data to retrieve
numargs Number of arguments in array

Definition at line 101 of file help.c.

References check_help_cache(), helpcache_t::first, firsthelpcache, lasthelpcache, helpline_t::line, helpcache_t::name, helpline_t::next, helpcache_t::next, oalloc(), parse_str(), and sSend().

Referenced by gs_help(), and is_help().

void motd char *  to  ) 
 

Print the services message of the day.

Parameters:
to Nick to send the MOTD to
Precondition:
To points to a valid NUL-terminated character array containing the nickname of a user for IRC messages containing the services motd to be sent to.

Definition at line 61 of file help.c.

References mostchans, mostnicks, mostusers, myname, and sSend().

Referenced by parseLine().


Generated at Sat Oct 25 20:56:11 2003 for Services using Doxygen.
Services Copyr. 1996-2001 Chip Norkus, Max Byrd, Greg Poma, Michael Graff, James Hess, Dafydd James. All rights reserved See LICENSE for licensing information.