Andres Seco Hernandez wrote: > Estoy perdido. Creo que con el sgml se pueden hacer paginas man. He usado > sgml para escribir howtos, pero no tengo ni idea ni donde hay informacion > de como hacer paginas man. > �Hay algun otro m�todo? > Tengo que hacer 2 para un programa nuevo que tengo sin documentar.
Despu�s de ensayar v�rios m�todos como sgml, escribir directamente en troff, etc, llegu� a la conclusi�n que la mejor forma de hacer p�ginas de manual es usando "perl". No es nada complicado ni es necesario saber nada de perl. El perl viene con un utilitario llamado pod2man (adem�s de pod2html, pod2tex y pod2text). "pod" quiere decir "Plain Old Documentation". Por ejemplo, para escribir la p�gina de manual de un programa que me convierte un glosario en c�digo sgml para docbook (programa dict2docbook, ftp://quark/pub/orca/) escrib� lo siguente en un fichero (ejemplo-pod): =head1 NAME dict2docbook - Creates a SGML (DocBook) version of glosario.dict =head1 SYNOPSIS S<dict2docbook filename> =head1 DESCRIPTION This programs reads the glosario.dict text file and creates a SGML version of it, conforming to the DocBook DTD. =head1 AUTHOR Jaime Villate E<lt>[EMAIL PROTECTED]<gt>. =cut Despu�s he hecho: pod2man ejemplo-pod >ejemplo-pod.1 para crear la p�gina de manual, que despu�s puede ser le�da con: man -l ejemplo-pod.1 La sintaxis completa del pod est� explicada en "man perlpod", y es bastante simple. El �nico paquete que necesitas es perl (o sea, hoy en d�a en Debian, perl-5.004 o perl-5.005). Si el programa que quieres documentar est� escrito en perl, el c�digo pod puede estar dentro del mismo programa y puede servir tanto para documentar el c�digo fuente, como para crear la documentaci�n adicional. Saludos, Jaime Villate
