diff options
Diffstat (limited to 'docs/man/man3/ServerConfig.3')
| -rw-r--r-- | docs/man/man3/ServerConfig.3 | 325 |
1 files changed, 325 insertions, 0 deletions
diff --git a/docs/man/man3/ServerConfig.3 b/docs/man/man3/ServerConfig.3 new file mode 100644 index 000000000..9f5733197 --- /dev/null +++ b/docs/man/man3/ServerConfig.3 @@ -0,0 +1,325 @@ +.TH "ServerConfig" 3 "14 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ServerConfig \- +.SH SYNOPSIS +.br +.PP +\fC#include <inspircd_io.h>\fP +.PP +Inherits \fBclassbase\fP. +.PP +.SS "Public Member Functions" + +.in +1c +.ti -1c +.RI "\fBServerConfig\fP ()" +.br +.ti -1c +.RI "void \fBClearStack\fP ()" +.br +.ti -1c +.RI "void \fBRead\fP (bool bail, \fBuserrec\fP *user)" +.br +.ti -1c +.RI "bool \fBLoadConf\fP (const char *filename, std::stringstream *target, std::stringstream *errorstream)" +.br +.ti -1c +.RI "int \fBConfValue\fP (char *tag, char *var, int index, char *result, std::stringstream *config)" +.br +.ti -1c +.RI "int \fBReadConf\fP (std::stringstream *\fBconfig_f\fP, const char *tag, const char *var, int index, char *result)" +.br +.ti -1c +.RI "int \fBConfValueEnum\fP (char *tag, std::stringstream *config)" +.br +.ti -1c +.RI "int \fBEnumConf\fP (std::stringstream *\fBconfig_f\fP, const char *tag)" +.br +.ti -1c +.RI "int \fBEnumValues\fP (std::stringstream *config, const char *tag, int index)" +.br +.in -1c +.SS "Public Attributes" + +.in +1c +.ti -1c +.RI "char \fBServerName\fP [MAXBUF]" +.br +.ti -1c +.RI "char \fBNetwork\fP [MAXBUF]" +.br +.ti -1c +.RI "char \fBServerDesc\fP [MAXBUF]" +.br +.ti -1c +.RI "char \fBAdminName\fP [MAXBUF]" +.br +.ti -1c +.RI "char \fBAdminEmail\fP [MAXBUF]" +.br +.ti -1c +.RI "char \fBAdminNick\fP [MAXBUF]" +.br +.ti -1c +.RI "char \fBdiepass\fP [MAXBUF]" +.br +.ti -1c +.RI "char \fBrestartpass\fP [MAXBUF]" +.br +.ti -1c +.RI "char \fBmotd\fP [MAXBUF]" +.br +.ti -1c +.RI "char \fBrules\fP [MAXBUF]" +.br +.ti -1c +.RI "char \fBPrefixQuit\fP [MAXBUF]" +.br +.ti -1c +.RI "char \fBDieValue\fP [MAXBUF]" +.br +.ti -1c +.RI "char \fBDNSServer\fP [MAXBUF]" +.br +.ti -1c +.RI "char \fBDisabledCommands\fP [MAXBUF]" +.br +.ti -1c +.RI "char \fBModPath\fP [1024]" +.br +.ti -1c +.RI "char \fBMyExecutable\fP [1024]" +.br +.ti -1c +.RI "FILE * \fBlog_file\fP" +.br +.ti -1c +.RI "bool \fBnofork\fP" +.br +.ti -1c +.RI "bool \fBunlimitcore\fP" +.br +.ti -1c +.RI "bool \fBAllowHalfop\fP" +.br +.ti -1c +.RI "int \fBdns_timeout\fP" +.br +.ti -1c +.RI "int \fBNetBufferSize\fP" +.br +.ti -1c +.RI "int \fBMaxConn\fP" +.br +.ti -1c +.RI "unsigned int \fBSoftLimit\fP" +.br +.ti -1c +.RI "int \fBMaxWhoResults\fP" +.br +.ti -1c +.RI "int \fBdebugging\fP" +.br +.ti -1c +.RI "int \fBLogLevel\fP" +.br +.ti -1c +.RI "int \fBDieDelay\fP" +.br +.ti -1c +.RI "char \fBaddrs\fP [MAXBUF][255]" +.br +.ti -1c +.RI "\fBfile_cache\fP \fBMOTD\fP" +.br +.ti -1c +.RI "\fBfile_cache\fP \fBRULES\fP" +.br +.ti -1c +.RI "char \fBPID\fP [1024]" +.br +.ti -1c +.RI "std::stringstream \fBconfig_f\fP" +.br +.ti -1c +.RI "\fBClassVector\fP \fBClasses\fP" +.br +.ti -1c +.RI "std::vector< \fBstd::string\fP > \fBmodule_names\fP" +.br +.in -1c +.SS "Private Member Functions" + +.in +1c +.ti -1c +.RI "int \fBfgets_safe\fP (char *buffer, size_t maxsize, FILE *&file)" +.br +.ti -1c +.RI "\fBstd::string\fP \fBConfProcess\fP (char *buffer, long linenumber, std::stringstream *errorstream, bool &error, \fBstd::string\fP filename)" +.br +.in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "std::vector< \fBstd::string\fP > \fBinclude_stack\fP" +.br +.in -1c +.SH "Detailed Description" +.PP +Definition at line 34 of file inspircd_io.h. +.SH "Constructor & Destructor Documentation" +.PP +.SS "ServerConfig::ServerConfig ()" +.PP +.SH "Member Function Documentation" +.PP +.SS "void ServerConfig::ClearStack ()" +.PP +Referenced by ConfigReader::ConfigReader(). +.SS "\fBstd::string\fP ServerConfig::ConfProcess (char * buffer, long linenumber, std::stringstream * errorstream, bool & error, \fBstd::string\fP filename)\fC [private]\fP" +.PP +.SS "int ServerConfig::ConfValue (char * tag, char * var, int index, char * result, std::stringstream * config)" +.PP +Referenced by userrec::HasPermission(). +.SS "int ServerConfig::ConfValueEnum (char * tag, std::stringstream * config)" +.PP +.SS "int ServerConfig::EnumConf (std::stringstream * config_f, const char * tag)" +.PP +Referenced by ConfigReader::Enumerate(). +.SS "int ServerConfig::EnumValues (std::stringstream * config, const char * tag, int index)" +.PP +Referenced by ConfigReader::EnumerateValues(). +.SS "int ServerConfig::fgets_safe (char * buffer, size_t maxsize, FILE *& file)\fC [private]\fP" +.PP +.SS "bool ServerConfig::LoadConf (const char * filename, std::stringstream * target, std::stringstream * errorstream)" +.PP +Referenced by ConfigReader::ConfigReader(). +.SS "void ServerConfig::Read (bool bail, \fBuserrec\fP * user)" +.PP +Referenced by Server::RehashServer(). +.SS "int ServerConfig::ReadConf (std::stringstream * config_f, const char * tag, const char * var, int index, char * result)" +.PP +Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue(). +.SH "Member Data Documentation" +.PP +.SS "char \fBServerConfig::addrs\fP[MAXBUF][255]" +.PP +Definition at line 70 of file inspircd_io.h. +.SS "char \fBServerConfig::AdminEmail\fP[MAXBUF]" +.PP +Definition at line 46 of file inspircd_io.h. +.SS "char \fBServerConfig::AdminName\fP[MAXBUF]" +.PP +Definition at line 45 of file inspircd_io.h. +.SS "char \fBServerConfig::AdminNick\fP[MAXBUF]" +.PP +Definition at line 47 of file inspircd_io.h. +.SS "bool \fBServerConfig::AllowHalfop\fP" +.PP +Definition at line 61 of file inspircd_io.h. +.SS "\fBClassVector\fP \fBServerConfig::Classes\fP" +.PP +Definition at line 75 of file inspircd_io.h. +.SS "std::stringstream \fBServerConfig::config_f\fP" +.PP +Definition at line 74 of file inspircd_io.h. +.PP +Referenced by userrec::HasPermission(). +.SS "int \fBServerConfig::debugging\fP" +.PP +Definition at line 67 of file inspircd_io.h. +.SS "int \fBServerConfig::DieDelay\fP" +.PP +Definition at line 69 of file inspircd_io.h. +.SS "char \fBServerConfig::diepass\fP[MAXBUF]" +.PP +Definition at line 48 of file inspircd_io.h. +.SS "char \fBServerConfig::DieValue\fP[MAXBUF]" +.PP +Definition at line 53 of file inspircd_io.h. +.SS "char \fBServerConfig::DisabledCommands\fP[MAXBUF]" +.PP +Definition at line 55 of file inspircd_io.h. +.SS "int \fBServerConfig::dns_timeout\fP" +.PP +Definition at line 62 of file inspircd_io.h. +.SS "char \fBServerConfig::DNSServer\fP[MAXBUF]" +.PP +Definition at line 54 of file inspircd_io.h. +.SS "std::vector<\fBstd::string\fP> \fBServerConfig::include_stack\fP\fC [private]\fP" +.PP +Definition at line 37 of file inspircd_io.h. +.SS "FILE* \fBServerConfig::log_file\fP" +.PP +Definition at line 58 of file inspircd_io.h. +.SS "int \fBServerConfig::LogLevel\fP" +.PP +Definition at line 68 of file inspircd_io.h. +.SS "int \fBServerConfig::MaxConn\fP" +.PP +Definition at line 64 of file inspircd_io.h. +.SS "int \fBServerConfig::MaxWhoResults\fP" +.PP +Definition at line 66 of file inspircd_io.h. +.SS "char \fBServerConfig::ModPath\fP[1024]" +.PP +Definition at line 56 of file inspircd_io.h. +.SS "std::vector<\fBstd::string\fP> \fBServerConfig::module_names\fP" +.PP +Definition at line 76 of file inspircd_io.h. +.PP +Referenced by Server::FindModule(). +.SS "\fBfile_cache\fP \fBServerConfig::MOTD\fP" +.PP +Definition at line 71 of file inspircd_io.h. +.SS "char \fBServerConfig::motd\fP[MAXBUF]" +.PP +Definition at line 50 of file inspircd_io.h. +.SS "char \fBServerConfig::MyExecutable\fP[1024]" +.PP +Definition at line 57 of file inspircd_io.h. +.SS "int \fBServerConfig::NetBufferSize\fP" +.PP +Definition at line 63 of file inspircd_io.h. +.SS "char \fBServerConfig::Network\fP[MAXBUF]" +.PP +Definition at line 43 of file inspircd_io.h. +.SS "bool \fBServerConfig::nofork\fP" +.PP +Definition at line 59 of file inspircd_io.h. +.SS "char \fBServerConfig::PID\fP[1024]" +.PP +Definition at line 73 of file inspircd_io.h. +.SS "char \fBServerConfig::PrefixQuit\fP[MAXBUF]" +.PP +Definition at line 52 of file inspircd_io.h. +.SS "char \fBServerConfig::restartpass\fP[MAXBUF]" +.PP +Definition at line 49 of file inspircd_io.h. +.SS "\fBfile_cache\fP \fBServerConfig::RULES\fP" +.PP +Definition at line 72 of file inspircd_io.h. +.SS "char \fBServerConfig::rules\fP[MAXBUF]" +.PP +Definition at line 51 of file inspircd_io.h. +.SS "char \fBServerConfig::ServerDesc\fP[MAXBUF]" +.PP +Definition at line 44 of file inspircd_io.h. +.SS "char \fBServerConfig::ServerName\fP[MAXBUF]" +.PP +Definition at line 42 of file inspircd_io.h. +.PP +Referenced by userrec::userrec(). +.SS "unsigned int \fBServerConfig::SoftLimit\fP" +.PP +Definition at line 65 of file inspircd_io.h. +.SS "bool \fBServerConfig::unlimitcore\fP" +.PP +Definition at line 60 of file inspircd_io.h. + +.SH "Author" +.PP +Generated automatically by Doxygen for InspIRCd from the source code. |