docs/man/man3/command_t.3

   1 .TH "command_t" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 command_t \- A structure that defines a command.
   6
   7 .PP
   8 .SH SYNOPSIS
   9 .br
  10 .PP
  11 \fC#include <ctables.h>\fP
  12 .PP
  13 Inherits \fBExtensible\fP.
  14 .PP
  15 .SS "Public Attributes"
  16
  17 .in +1c
  18 .ti -1c
  19 .RI "char \fBcommand\fP [MAXBUF]"
  20 .br
  21 .RI "\fICommand name. \fP"
  22 .ti -1c
  23 .RI "handlerfunc * \fBhandler_function\fP"
  24 .br
  25 .RI "\fIHandler function as in typedef. \fP"
  26 .ti -1c
  27 .RI "char \fBflags_needed\fP"
  28 .br
  29 .RI "\fIUser flags needed to execute the command or 0. \fP"
  30 .ti -1c
  31 .RI "int \fBmin_params\fP"
  32 .br
  33 .RI "\fIMinimum number of parameters command takes. \fP"
  34 .ti -1c
  35 .RI "long \fBuse_count\fP"
  36 .br
  37 .RI "\fIused by /stats m \fP"
  38 .ti -1c
  39 .RI "long \fBtotal_bytes\fP"
  40 .br
  41 .RI "\fIused by /stats m \fP"
  42 .ti -1c
  43 .RI "char \fBsource\fP [MAXBUF]"
  44 .br
  45 .RI "\fIused for resource tracking between modules \fP"
  46 .in -1c
  47 .SH "Detailed Description"
  48 .PP
  49 A structure that defines a command. Definition at line 26 of file ctables.h.
  50 .SH "Member Data Documentation"
  51 .PP
  52 .SS "char \fBcommand_t::command\fP[MAXBUF]"
  53 .PP
  54 Command name. Definition at line 31 of file ctables.h.
  55 .SS "char \fBcommand_t::flags_needed\fP"
  56 .PP
  57 User flags needed to execute the command or 0. Definition at line 37 of file ctables.h.
  58 .SS "handlerfunc* \fBcommand_t::handler_function\fP"
  59 .PP
  60 Handler function as in typedef. Definition at line 34 of file ctables.h.
  61 .SS "int \fBcommand_t::min_params\fP"
  62 .PP
  63 Minimum number of parameters command takes. Definition at line 40 of file ctables.h.
  64 .SS "char \fBcommand_t::source\fP[MAXBUF]"
  65 .PP
  66 used for resource tracking between modules Definition at line 49 of file ctables.h.
  67 .SS "long \fBcommand_t::total_bytes\fP"
  68 .PP
  69 used by /stats m Definition at line 46 of file ctables.h.
  70 .SS "long \fBcommand_t::use_count\fP"
  71 .PP
  72 used by /stats m Definition at line 43 of file ctables.h.
  73
  74 .SH "Author"
  75 .PP
  76 Generated automatically by Doxygen for InspIRCd from the source code.