Blame view

src/conf.dox 1.06 KB
Imanol-Mikel Barba Sabariego authored
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
/** @file
\author Imanol Barba Sabariego
\date 13/06/2013
\page conf Fichero de configuración
\brief Descripción de la sintaxis y parámetros del fichero de configuración

\tableofcontents
	A continuación se detalla el uso del fichero de configuración del servidor.
	<br><br>
	\section sintax Sintáxis
		La sintaxis es muy sencilla:

		@verbatim PARÁMETRO<WHITESPACE>=<WHITESPACE>VALOR @endverbatim

		donde <WHITESPACE> pueden ser espacios, tabulaciones o saltos de línea.
		<br>
	\section params Parámetros
		A continuación se detallan los posibles parámetros y qué valores aceptan.
		<br>
		\subsection bind bind-ip
			Contiene la dirección IP que será asigada al Socket del servidor, por tanto, la dirección donde escuchará conexiones.
			Acepta un string del tipo W.X.Y.Z donde W,X,Y,Z son números de 0 a 255.
		\subsection portnum port
			El puerto donde el servidor acepta conexiones.
			Acepta un número de 1 a 65535.
			<br>
		<br>
	<br>
	\section examples-conf Ejemplos
	<code> bind-ip = 127.0.0.1 <br>port = 3001 </code>
*/