| Documentación Firebird → Documentación para escritores de Firebird → Cómo obtener y construir el módulo "manual" de Firebird → Obtener el módulo Firebird manual de SourceForge |
|
|
|
El módulo manual es parte del repositorio CVS de Firebird en SourceForge. Para descargarlo, necesita una aplicación denominada cliente CVS. Esta sección describe los pasos necesarios para obtener el software y el módulo manual. El proceso de construcción de los documentos se explica en la siguiente sección: Construir los documentos de Firebird.
CVS significa Sistema de Versiones Concurrentes (Concurrent Versions System). Es una herramienta para administrar desarrollos de software, útil tanto para desarrolladores individuales como para trabajo en equipo. Prácticamente todos los proyectos en SourceForge usan CVS para almacenar y desarrollar su base de código. El árbol CVS de Firebird está dividido en partes llamadas modulos, el módulo "manual" es uno de ellos.
El descargar un módulo desde un almacén CVS se denomina desproteger (check out) en términos de CVS. Para hacerlo, Ud. necesita un cliente CVS; existen prácticamente para todos los sistemas operativos. Aquí va una lista de clientes CVS para algunos Sistemas Operativos populares:
Linux, BSD y otros Unix
Frecuentemente, una aplicación CVS de línea de comandos se entrega pre-instalada. Si no es el caso, use las herramientas de administración de su distribución para instalar una -la encontrará típicamente en la categoría de desarrollo. Si por alguna razón no puede realizar esta tarea, obténgala de http://www.cvshome.org
gCvs - una interfaz CVS gráfica, en http://cvsgui.sourceforge.net/download.html
Windows
CVS de línea de comandos en http://www.cvshome.org
WinCVS: muy potente, pero tal vez un poco intimidante si Ud. recién lo conoce. En http://cvsgui.sourceforge.net/download.html
TortoiseCVS: una extensión del Explorador de Windows. Diseñado en forma brillante, muy intuitivo. Carece de algunas de las funciones CVS más avanzadas, pero tiene todo lo que Ud. necesita. Obténgalo en http://tortoisecvs.sourceforge.net/download.shtml
Mac OS X
Mac OS X viene con un CVS de línea de comandos incluído.
Fink (Herramientas Unix para OS X) contiene una versión más nueva de CVS. http://fink.sourceforge.net/download/index.php
MacCvsX en http://cvsgui.sourceforge.net/download.html - el mismo proyecto que gCvs y WinCvs. Nota: la versión para OS X todavía está en fase beta.
MacCVS Pro en http://sourceforge.net/projects/maccvspro/
Mac Classic
MacCvs en http://cvsgui.sourceforge.net/download.html - el mismo proyecto que gCvs y WinCvs.
MacCVS Pro en http://sourceforge.net/projects/maccvspro/
Otros
Pruebe su suerte en http://www.cvshome.org, busque en google, o pregunte en el grupo de noticias gnu.cvs.help o en la lista de correo firebird-docs.
Obtenga uno o más de los clientes mencionados e instálelo de acuerdo a las instrucciones que se incluyen en cada uno. Después de eso, Ud. estará listo para desproteger el módulo manual.
Hay dos formas de desproteger el módulo manual: como un usuario anónimo, o con su nombre de usuario de SourceForge. El último método se denomina desprotección SSH (porque utiliza una sesión segura (Secure SHell) o desprotección EXT (porque utiliza SSH como un protocolo EXTerno).
Cualquiera puede desproteger anónimamente. Los miembros del proyecto Firebird pueden también desproteger usando su usuario de SourceForge. (Si Ud. tiene una cuenta de SF pero no es miembro del proyecto Firebird, puede desproteger en forma anónima).
Si Ud. es un miembro del proyecto, generalmente querrá desproteger con su usuario de SF porque
La desprotección anónima no está siempre al día (el retardo puede ir de varias horas a varios días);
Si Ud. va a contribuir por su cuenta al módulo manual, entonces debe desproteger con su usuario de SF o no tendrá la posibilidad de enviar sus cambios de vuelta al servidor (commit o upload).
En las siguientes subsecciones describiremos ambos métodos, comenzando con la desprotección anónima. O puede ir directamente a la sección sobre desprotección SSH.
El proceso de desprotección depende del cliente que utilice. Le daremos instrucciones exactas para CVS de línea de comandos, e información genérica para ser usada con los otros clientes.
Si Ud. está en un entorno gráfico, abra una ventana de comandos.
Primero, debe verificar la clave con el servidor y almacenarla localmente. Ejecute el comando:
cvs -d:pserver:[email protected]:/cvsroot/firebird login
Cuando se le pregunte por una clave (password), simplemente presione Enter (Entrar), dado que la clave para el usuario "anonymous" está vacía. Su cliente CVS almacenará la clave para uso posterior, de manera que puede saltear este paso en el futuro, mientras no se haya autenticado con otras claves en el interín.
Ahora puede obtener el módulo manual. Ejecute el comando:
cvs -z6 -d:pserver:[email protected]:/cvsroot/firebird checkout manual
Si todo va bien, se creará un directorio llamado manual debajo de su directorio actual, y el árbol de fuentes del manual será descargado en él. Ahora ya puede generar los documentos - más información en la sección siguiente, Construir los documentos de Firebird.
Hay demasiada variación como para dar instrucciones exactas para todos los clientes CVS aquí. Consulte la ayuda o documentación para su propio cliente. Los elementos que se le pedirán en algún momento son:
debe ser pserver (password server)
lo mismo que en protocol
cvs.sourceforge.net
/cvsroot/firebird
anonymous
manual
generalmente una combinación del servidor y el almacén, algunas veces incluye también al nombre de usuario adelante de lo demás (por ejemplo en WinCvs): cvs.sourceforge.net:/cvsroot/firebird o [email protected]:/cvsroot/firebird
Complete los datos necesarios y ejecute el comando desproteger de su cliente. Si la desprotección es correcta, Ud. tendrá ahora una copia local del módulo manual en su computadora y estará listo para construir los documentos. Siga el tema en la sección siguiente, Construir los documentos de Firebird.
Para poder realizar una desprotección SSH, debe tener en su sistema un cliente seguro. En la mayoría de los sistemas Unix, así como en Mac OS X, OpenSSH se instala por defecto. Si no, verifique los CDs de su distribución o descárguelo de http://www.openssh.com. Este sitio contiene referencias a otros productos SSH para Sistemas Operativos no soportados por OpenSSH. No obstante, observe que instalar y configurar SSH en algunas plataformas (incluyendo Windows) no es una tarea trivial. Puede hacer más fácil su vida eligiendo un cliente CVS que tenga SSH incluido, como TortoiseCVS para Windows.
En cuanto a la desprotección en sí: al igual que con las desprotecciones anónimas, el procedimiento depende del cliente que utilice. Nuevamente, daremos instrucciones exactas para CVS de línea de comandos, y sólo información genérica para otros clientes.
Si está en un entorno gráfico, abra una ventana de comandos.
Primero, asegúrese de tener definida una variable llamada CVS_RSH con el valor “ssh” (o como se llame su cliente SSH). Cómo hacer esto depende de su sistema operativo. En una ventana de comandos DOS/Windows, escriba set CVS_RSH=ssh. En Linux/bash: export CVS_RSH=ssh.
Ud. puede querer hacer permanente esta variable de entorno, de tal manera que pueda saltear este paso en el futuro. Cómo hacer esto depende de su sistema operativo. Consulte la documentación del mismo si es necesario.
Ejecute el siguiente comando para obtener el módulo manual (sustituya “nombre_usuario” con su propio nombre de usuario de SourceForge):
cvs -z6 -d:ext:[email protected]:/cvsroot/firebird checkout manual
Ingrese su clave cuando se le solicite.
Si todo va bien, se creará un directorio llamado manual debajo de su directorio actual, y el árbol de fuentes del manual será descargado en él. Ahora ya puede generar los documentos. Siga el tema en la sección siguiente, Construir los documentos de Firebird.
Hay demasiada variación como para dar instrucciones exactas para todos los clientes CVS aquí. Consulte la ayuda o documentación para su propio cliente. Los elementos que se le pedirán en algún momento son:
debe ser ext (o SSH, o SSL)
lo mismo que en protocol
cvs.sourceforge.net
/cvsroot/firebird
su nombre de usuario en SourceForge
manual
generalmente una combinación del servidor y el almacén, algunas veces incluye también al nombre de usuario adelante de lo demás (por ejemplo en WinCvs): cvs.sourceforge.net:/cvsroot/firebird o [email protected]:/cvsroot/firebird
Complete los datos necesarios y ejecute el comando desproteger de su cliente. Si la desprotección es correcta, Ud. tendrá ahora una copia local del módulo manual en su computadora y estará listo para generar los documentos. También puede enviar los cambios que haga localmente, de vuelta al almacén.
|
| Documentación Firebird → Documentación para escritores de Firebird → Cómo obtener y construir el módulo "manual" de Firebird → Obtener el módulo Firebird manual de SourceForge |