A continuación se presenta una lista con los manuales.
+Puede encontrar archivos de planta de ejemplo en el directorio + Samples.
+\endhtmlonly + \section introduccion Introducción. \subsection herramientas Herramientas Utilizadas. @@ -15,6 +35,15 @@ [http://www.vim.org/] - Doxygen: Generador de documentación y referencias cruzadas. [http://www.stack.nl/~dimitri/doxygen/] + - Subversion: Es un SCM (Source Code Manager) que permite trabajar + con versiones concurrentes en un repositorio de código fuente de + forma remota. + [http://subversion.tigris.org/] + - LyX: Procesador de texto WYIWYM (What You See Is What You Mean) + para hacer documentos técnicos fácilmente. + [http://www.lyx.org/] + - Mailman: Manejador de listas de correo. + [http://www.gnu.org/software/mailman/] - GNU Make. [http://www.gnu.org/software/make/] - Automake. @@ -57,15 +86,15 @@ \section instalacion Instalación. El programa se divide en 4 módulos: - - Modelo: es el módulo que se encarga de la simulación y el modelo \c - físico de la planta (es una biblioteca). + - \ref page_model "Modelo": es el módulo que se encarga de la simulación y el modelo + \c físico de la planta (es una biblioteca). - \ref page_server "Servidor": es la infrastructura de red. Comprende tanto el servidor como el cliente en cuando al manejo de la red (es una biblioteca y un programa). - - Cliente: es el cliente gráfico que permite ver la simulación (es un + - \ref page_client "Cliente": es el cliente gráfico que permite ver la simulación (es un programa). - - Constructor: es el programa para diseñar la planta química que será - simulada por el modelo en el servidor (es un programa). + - \ref page_constructor "Constructor": es el programa para diseñar la planta química + que será simulada por el modelo en el servidor (es un programa). La instalación puede realizarse de dos formas: instalando módulo por módulo o instalando todos los módulos a la vez. @@ -81,7 +110,10 @@ -# Configurar la compilación del proyecto (generalmente basta con): \verbatim ./configure \endverbatim Esto lo instala por defecto en /usr/local, se puede - especificar otra ruta con la opcion --prefix. + especificar otra ruta con la opcion --prefix. También se + puede compilar en modo de depuración con la opción + --enable-debug. Para más opciones hacer + ./configure --help. -# Compilar el proyecto: \verbatim make \endverbatim -# Instalar el proyecto: @@ -114,7 +146,7 @@ \subsection mainpage_server_uso_inicio Inicio del servidor. Para iniciar el servidor es necesario disponer de un archivo XML de - planta (por ejemplo, generado por el Constructor). + planta (por ejemplo, generado por el \ref page_constructor "Constructor"). Invocación del servidor: \verbatim ./plaqui-server [archivo] [puerto] \endverbatim @@ -145,7 +177,7 @@ se detecta un error. Otro tipo de información del estado del servidor puede ser obtenida desde - el cliente a través del comando /server/info. + el \ref page_client "cliente" a través del comando /server/info. \note Los errores se imprimen en la salida de error, no en la salida estándar. @@ -157,7 +189,8 @@ - Enviando una señal de salida (SIGQUIT) o de terminación (SIGTERM), por ejemplo, a través del comando kill(1). - - Enviando un comando /server/stop desde un cliente. + - Enviando un comando /server/stop desde un + \ref page_client "cliente". Cualquiera de estos métodos es válido y finaliza el servidor de forma correcta.