summaryrefslogtreecommitdiff
path: root/docs/man/man3/command_t.3
blob: a7338bde8b6c85c0170fcfc08a3ad245099f00d5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
.TH "command_t" 3 "12 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
command_t \- A structure that defines a command.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <ctables.h>\fP
.PP
Inherits \fBExtensible\fP.
.PP
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "char \fBcommand\fP [MAXBUF]"
.br
.RI "\fICommand name. \fP"
.ti -1c
.RI "handlerfunc * \fBhandler_function\fP"
.br
.RI "\fIHandler function as in typedef. \fP"
.ti -1c
.RI "char \fBflags_needed\fP"
.br
.RI "\fIUser flags needed to execute the command or 0. \fP"
.ti -1c
.RI "int \fBmin_params\fP"
.br
.RI "\fIMinimum number of parameters command takes. \fP"
.ti -1c
.RI "long \fBuse_count\fP"
.br
.RI "\fIused by /stats m \fP"
.ti -1c
.RI "long \fBtotal_bytes\fP"
.br
.RI "\fIused by /stats m \fP"
.ti -1c
.RI "char \fBsource\fP [MAXBUF]"
.br
.RI "\fIused for resource tracking between modules \fP"
.in -1c
.SH "Detailed Description"
.PP 
A structure that defines a command. 
.PP
Definition at line 26 of file ctables.h.
.SH "Member Data Documentation"
.PP 
.SS "char \fBcommand_t::command\fP[MAXBUF]"
.PP
Command name. 
.PP
Definition at line 31 of file ctables.h.
.SS "char \fBcommand_t::flags_needed\fP"
.PP
User flags needed to execute the command or 0. 
.PP
Definition at line 37 of file ctables.h.
.SS "handlerfunc* \fBcommand_t::handler_function\fP"
.PP
Handler function as in typedef. 
.PP
Definition at line 34 of file ctables.h.
.SS "int \fBcommand_t::min_params\fP"
.PP
Minimum number of parameters command takes. 
.PP
Definition at line 40 of file ctables.h.
.SS "char \fBcommand_t::source\fP[MAXBUF]"
.PP
used for resource tracking between modules 
.PP
Definition at line 49 of file ctables.h.
.SS "long \fBcommand_t::total_bytes\fP"
.PP
used by /stats m 
.PP
Definition at line 46 of file ctables.h.
.SS "long \fBcommand_t::use_count\fP"
.PP
used by /stats m 
.PP
Definition at line 43 of file ctables.h.

.SH "Author"
.PP 
Generated automatically by Doxygen for InspIRCd from the source code.