PDF de programación - atix10

Dirección y Coordinación General
Esteban Saavedra López ([email protected])

Diseño y Maquetación 
Jenny Saavedra López ([email protected])
Esteban Saavedra López ([email protected])

Revisiones
Esteban Saavedra López
Jenny Saavedra López

Noticias
Ivonne Menacho
Jenny Saavedra López
Marcia Velasquez

Autores Frecuentes
Arnold Guzmán
Carlos Ramos
Ernesto Rico Smith
Esteban Saavedra López

Joseph Sandoval
Lucy Ayarde Romero
Rocio Figueroa
Williams Chorolque Choque

Herramientas
La edición de esta revista fue realizada de forma integra haciendo uso de Software
Libre



Se dice que cuando nace toda persona, toda actividad, o todo proyecto nace un
nuevo y único mundo, por que será diferente y poseerá características propias que
la diferenciarán de las demás.
Al pasar el tiempo estas características especiales pueden tomar dos caminos: uno
que los vaya inhibiendo y que las convierta en simples y comunes, y otro que cada
vez las vaya diferenciando y haciéndolas casi únicas en su género. Este segundo
camino es el que deberían tomar personas, actividades y proyectos con el objetivo
no solo de ser diferentes sino también mostrar cualidades y capacidades de las
cuales se pueden aprender y mejorar para emprender nuevos y mejores retos.

Marcamos la diferencia, un título que muestra que después de diez números,
nuestra revista marco la diferencia; desde el principio no quisimos ser una revista
mas, sino al contrario quisimos contribuir a un nuevo cause para aportar
conocimientos y experiencias que de seguro lograrán progreso en el diario caminar
de nuestros lectores, autores y obviamente del equipo de la revista.
Número a número fuimos demostrando nuestro deseo de ser diferentes, aspecto
que fue alcanzado con la ayuda de nuestros autores, quienes tuvieron un perfecto
acople a nuestros objetivos, y también gracias a nuestros lectores quienes nos
retroalimentaron con comentarios y sugerencias valiosas.
De esta forma podemos y nos sentimos felices de decir que fueron diez números
donde marcamos la diferencia.

Marcamos la diferencia en un año de existencia.

Bienvenidos a nuestro décimo número

Esteban Saavedra López
Director y Coordinador General

Aprendiendo a manipular
archivos de ayuda

Dentro de los sistemas operativos tales como GNU/Linux, es frecuente contar con
ayudas desde la línea de comandos, estas ayudas básicamente son archivos de texto
preformateados de tal forma que al ser invocados, muestran la información de ayuda de
forma clara y concisa.
Introducción
Man es una herramienta de sistemas Unix
que se utiliza para documentar y aprender
sobre comandos, archivos, llamadas de
sistema, etc, en un sistema operativo tal
como GNU/Linux. Actualmente se basa en
groff, y es el sistema más utilizado para la
documentación en sistemas Unix, aunque
son pocas las características útiles en
comparación con el relativamente reciente
comando
que cuenta con
características como enlaces que facilitan la
interfaz de usuario, ya que al visitar la
documentación relativa a un comando se
puede saltar a otra página sin tener que salir
y ejecutar nuevamente el programa, que es
el caso de man.

artículos y libros, así como TeX. Sin embargo,
groff
tiene una característica que está
ausente de TeX y variantes: la capacidad
para producir salida ASCII simple. Si bien
TEX es muy bueno para la producción de
documentos a imprimir, groff es capaz de
producir documentos en formato ASCII para
ser visto en línea de comandos.
Groff posee una gran cantidad de asistentes,
preprocesadores y postprocesadores
incluyendo eqn, tbl, pic y soelim.

✔ Groff es mucho más pequeño que

Características

info,

formateo de

Uso de
documentos
Utilizar un sistema de formateo de
documentos obliga a usar estándares
tipográficos al escribir, donde cada sección
común dentro del documento tendrá el
mismo aspecto, a menos que su autor
modifique la definición de la misma. El
objetivo es permitir al autor concentrarse en
el texto, no en las convenciones tipográficas.
Cuando se escribe con un editor de textos,
generalmente no se piensa en el aspecto que
tendrá el texto impreso. El autor se
acostumbra a imaginar la apariencia que
tendrá el texto gracias a las órdenes de
formateo en el fichero fuente.

Groff
Groff es capaz de producir documentos,

TeX

sintaxis

✔ Sencillo y fácil de comprender su

✔ Permite la exportación de distintos

formatos imprimibles

✔ Presente en la mayoría de las

distribuciones GNU/Linux

Uso
Si bien groff es capaz de producir
documentos, artículos y libros, una de las
mayores utilidades que se le ha dado es la
creación de páginas de manuales de
aplicaciones y
comandos, que son
fácilmente accesibles desde la línea de
comandos de un sistema GNU/Linux.

Escribiendo páginas y
archivos man
El escribir páginas de manuales para
aplicaciones y/o comandos, haciendo uso de

groff es sencillo y rápido; es importante
considerar ciertos aspectos importantes,
detallados a continuación

Secciones
Las páginas de manual tienen un formato
particular, ya que está compuesta por una
serie de secciones comunes en todas las
páginas accesibles por el comando man.
Dichas secciones
la detallamos a
continuación:

✔ NOMBRE: Este es el nombre del
programa, seguida de una breve
descripción de lo que hace o lo que
significa el nombre si está en un
acrónimo. Este será leído por
apropos, man-k, y makewhatis whatis.
✔ SINOPSIS: Básicamente, ésta es la
sintaxis utilizada para ejecutar el
programa desde
línea de
comandos. Un ejemplo sería: demo [-
d] [e] [-f nombre de archivo]

la

✔ DESCRIPCIÓN: Consiste en una
descripción más amplia y detallada de
lo que hace el programa. Esta sección
debe ser lo más clara y entendible,
por que de esta explicación
dependerá el buen o mal uso del
programa.

✔ ENTORNO: Describe variables de

entorno.

✔ FICHEROS: Ficheros asociados.
✔ EJEMPLOS: Ejemplos y consejos.
✔ OPCIONES: Si su programa utiliza
ciertas opciones, éste es el lugar
donde se explica qué significa cada
opción.

✔ CONFORME A: Conformidad con

estándares, en su caso.

✔ ERRORES: Si hay cualquier error en
su programa, se debe incluir en esta
sección para que el usuario conozca
de la misma.

✔ SEGURIDAD: Aspectos de seguridad

a tener en cuenta.

✔ AUTOR: En esta sección debe incluir
el nombre y datos de contacto del
autor,
para que las personas
interesadas en contactar hagan uso
de la misma, o para reportar algún
inconveniente presentando al
momento de hacer uso del programa.
✔ VÉASE TAMBIÉN: Esta es la sección
adecuada para enumerar
los
programas relacionados con nuestro
programa;
programas
relacionados deben ser enumerados
seguido del número de sección.

los







✔ Otros: Se pueden añadir cabeceras

hechas a medida por los autores.

Para una mejor comprensión, presentamos el resultado de una página de manual de ejemplo y
su código fuente.

.TH demo 1 "15 de Mayo de 2009" "version 0.5" "COMANDOS DE USUARIO"
.SH NOMBRE
\fIDemo\fP \- Es un programa de demostracion del uso de interfaces graficas en modo
texto.
.SH SINOPSIS
.B demo
[\-h] [\-x colores] \-y colores
.SH DESCRIPCION
Las interfaces graficas en modo texto son utilizadas para el ahorro en el uso de
recursos durante la ejecucion de las mismas.
.PP
\fIDemo\fP es un programa cuyo objetivo es mostrar una demostracion del poder del uso
de la interfaces en modo texto, considerando su facilidad de uso, y la rapidez de su
desarrollo..SH OPCIONES
.TP
\-h
presenta un pequeño texto de ayuda

.TP
\-x
ejecuta la demostracion en la consola considerando 2 colores para su presentacion
.TP
\-y
ejecuta la demostracion en la consola considerando colores para su presentacion
.SH EJEMPLOS
.TP
Muestra la presentacion con un n colores
.B demo
\-x 4
.PP
.TP
Muestra la demostracion con todos los colores
.B demo
\-y 0
.PP
.SH ARCHIVOS
Los archivos tanto ejecutables como de configuracion se encuentran en
\fI/usr/share/demo\fR
.SH SALIDA
demo devuelve un cero si consigue mostrar la demostracion sin que exista errores, caso
contrario muestra un valor distinto de cero.
.SH ERRORES
\fiDemo\fP al tratarse de un aplicacion demostrativa aun posee algunos pequeños
errores, que estan siendo superados por el equipo de desarrollo.
.SH AUTOR
German Joel Torrico (german.torrico (at) gmail.com)
.SH VEASE TAMBIEN
demostrativo(1), despliegue(1)

Convenciones de edición
Al momento de editar una página de manual
se consideran las siguientes convenciones:

Etiqueta

Descripción

.SH

.TH

.B

.BI

.BR

.I

.IB

.IR

NOMBRE Nombre de la sección

NOMBRE SECCION FECHA
Cabecera del título, especifíca
el nombre del producto, la
sección de la página de manual,
y la fecha

Negrilla

Negrilla e itálica

Negrilla y Roman

Itálica

Itálica y negrilla

Itálica y Roman

.RB

.RI

.SM

.SB

."

.PP

.IP

.TP

.RS

.RE

Roman y negrilla

Roman e itálica

Letra Pequeña

Letra pequeña y negrilla

Comentario

Párrafo simple

Párrafo identado

Párrafo identado, propicio para
viñetas

Párrafo identado relativo al
inicio de la anterior linea

Párrafo identado relativo al final
de la anterior línea

Man en

Niveles del
GNU/Linux
Las páginas de manuales están catalogados
según ciertos niveles de acceso