[GUFSC] Re: GUFSC digest, Vol 1 #182 - 2 msgs
andre duarte bueno
gufsc@das.ufsc.br
Thu, 14 Nov 2002 13:47:25 -0200
--------------000706080700060604090602
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: 8bit
gufsc-request@das.ufsc.br wrote:
>Send GUFSC mailing list submissions to
> gufsc@das.ufsc.br
>
>To subscribe or unsubscribe via the World Wide Web, visit
> http://www.das.ufsc.br/mailman/listinfo/gufsc
>or, via email, send a message with subject or body 'help' to
> gufsc-request@das.ufsc.br
>
>You can reach the person managing the list at
> gufsc-admin@das.ufsc.br
>
>When replying, please edit your Subject line so it is more specific
>than "Re: Contents of GUFSC digest..."
>
>
>
>------------------------------------------------------------------------
>
>Today's Topics:
>
> 1. =?iso-8859-1?Q?Constru=E7=E3o_de_man_pages?= (Eder Mateus Nunes Goncalves)
> 2. Re: =?iso-8859-1?Q?=5BGUFSC=5D_Constru=E7=E3o_de_man_pages?= (Rafael R Obelheiro)
>
>
>
> ------------------------------------------------------------------------
>
> Subject:
> [GUFSC] Construção de man pages
> From:
> Eder Mateus Nunes Goncalves <eder@das.ufsc.br>
> Date:
> Wed, 13 Nov 2002 14:23:47 -0200 (GMT+2)
> To:
> gufsc@das.ufsc.br
>
>
>Senhores
>
>Existe alguma ferramenta que auxilie na construção de man pages, ou estas
>são construídas diretamente via algum editor de texto qualquer? Pergunto
>isto por que uma man page tem uma formatação específica, o que acredito
>seja criado por algum tipo de ferramenta.
>
>Grato
>
>--
>==================================================
>Eng. Eder Mateus Nunes Gonçalves
>Doutorando em Inteligência Artificial
>UFSC - Universidade Federal de Santa Catarina
>==================================================
>
>"De tanto ver triunfar as nulidades, de tanto ver prosperar a desonra,
>de tanto ver crescer a injustiça, de tanto ver agigantar-se os poderes
>nas mãos dos maus, o homem chega a desanimar da virtude, a rir-se da
>honra, chega a ter vergonha de ser honesto." -- Rui Barbosa
>
>
>
>
>
>
> ------------------------------------------------------------------------
>
> Subject:
> [GUFSC] Re: [GUFSC] Construção de man pages
> From:
> Rafael R Obelheiro <rro@das.ufsc.br>
> Date:
> Wed, 13 Nov 2002 14:54:07 -0200
> To:
> gufsc@das.ufsc.br
>
>
>Caro,
>
>On Wed, Nov 13, 2002 at 02:23:47PM -0200, Eder Mateus Nunes Goncalves wrote:
>
>
>>Existe alguma ferramenta que auxilie na construção de man pages, ou estas
>>são construídas diretamente via algum editor de texto qualquer? Pergunto
>>isto por que uma man page tem uma formatação específica, o que acredito
>>seja criado por algum tipo de ferramenta.
>>
>>
>
>Paginas de manual sao fontes troff (um tipo de linguagem de formatacao
>de textos, como TeX) que usam os conjuntos de macros `an' ou `doc'.
>Embora possam existir ferramentas que auxiliem na sua elaboracao (eu,
>particularmente, nao conheco nenhuma), elas podem ser criadas com um
>editor de textos qualquer, bastando conhecer um dos conjuntos de
>macros citados.
>
>Existe um mini-HOWTO que explica como escrever uma boa pagina de manual
>em http://www.tldp.org/HOWTO/mini/Man-Page.html. Este documento contem
>tambem outros ponteiros uteis sobre troff.
>
>Um abraco,
>Rafael.
>
>
>
>
>
>
>
>------------------------------------------------------------------------
>
>_______________________________________________
>GUFSC mailing list
>GUFSC@das.ufsc.br
>http://www.das.ufsc.br/mailman/listinfo/gufsc
>
>
>
Dica importante para quem quer desenvolver documentação de programas.
O formato sgml, é um formato bastante universal, e que é
utilizado para desenvolvimento de documentação no GNU/LINUX.
Você pode fazer o documento em um editor como o emacs, usando o padrão sgml.
(o emacs tem suporte embutido para este tipo de documento).
Depois o documento pode ser convertido para diferentes formatos usando
os programas
listados a seguir
*sgml2html sgml2latex sgml2rtf sgml2xml sgml2info sgml2lyx
sgml2txt*
estes programas costumam vir nas distribuições do GNU/Linux.
Observe que você pode converter para os principais formatos, html,
latex, rtf, xml lyx e txt.
Observe ainda que sgml converte para xml, (o programa* sgml2xml). *
Daí você pode usar os conversores do xml, listados abaixo.
*xml2-config xml2man xml2pot xmltex
*para gerar a man page.
Ou seja:
sgml -> xml usando * sgml2xml*
e
xml->man usando *xml2man*.
PS; na minha distribuição não tem, mas se não me engano existe ainda um
sgml2man (direto).
Você encontra maiores informações sobre sgml e xml no site de
documentação do Linux
http://ldp.pop-rn.rnp.br/index.html
http://www.linux.org/docs/ldp/index.html
Também tem HOWTO falando disso em algum lugar.
(se não me engano é um HOWTO sobre programação no Linux).
--------------000706080700060604090602
Content-Type: text/html; charset=us-ascii
Content-Transfer-Encoding: 7bit
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title></title>
</head>
<body>
<a class="moz-txt-link-abbreviated" href="mailto:gufsc-request@das.ufsc.br">gufsc-request@das.ufsc.br</a> wrote:<br>
<blockquote type="cite"
cite="mid20021114140004.21814306EA@atlas.das.ufsc.br">
<pre wrap="">Send GUFSC mailing list submissions to
<a class="moz-txt-link-abbreviated" href="mailto:gufsc@das.ufsc.br">gufsc@das.ufsc.br</a>
To subscribe or unsubscribe via the World Wide Web, visit
<a class="moz-txt-link-freetext" href="http://www.das.ufsc.br/mailman/listinfo/gufsc">http://www.das.ufsc.br/mailman/listinfo/gufsc</a>
or, via email, send a message with subject or body 'help' to
<a class="moz-txt-link-abbreviated" href="mailto:gufsc-request@das.ufsc.br">gufsc-request@das.ufsc.br</a>
You can reach the person managing the list at
<a class="moz-txt-link-abbreviated" href="mailto:gufsc-admin@das.ufsc.br">gufsc-admin@das.ufsc.br</a>
When replying, please edit your Subject line so it is more specific
than "Re: Contents of GUFSC digest..."
</pre>
<pre wrap="">
<hr width="90%" size="4">
Today's Topics:
1. =?iso-8859-1?Q?Constru=E7=E3o_de_man_pages?= (Eder Mateus Nunes Goncalves)
2. Re: =?iso-8859-1?Q?=5BGUFSC=5D_Constru=E7=E3o_de_man_pages?= (Rafael R Obelheiro)
</pre>
<br>
<hr width="90%" size="4"><br>
<table border="0" cellspacing="0" cellpadding="0" width="100%"
class="header-part1">
<tbody>
<tr>
<td>
<div class="headerdisplayname" style="display: inline;">Subject:
</div>
[GUFSC] Construção de man pages</td>
</tr>
<tr>
<td>
<div class="headerdisplayname" style="display: inline;">From: </div>
Eder Mateus Nunes Goncalves <a class="moz-txt-link-rfc2396E" href="mailto:eder@das.ufsc.br"><eder@das.ufsc.br></a></td>
</tr>
<tr>
<td>
<div class="headerdisplayname" style="display: inline;">Date: </div>
Wed, 13 Nov 2002 14:23:47 -0200 (GMT+2)</td>
</tr>
<tr>
<td>
<div class="headerdisplayname" style="display: inline;">To: </div>
<a class="moz-txt-link-abbreviated" href="mailto:gufsc@das.ufsc.br">gufsc@das.ufsc.br</a></td>
</tr>
</tbody>
</table>
<br>
<pre wrap="">Senhores
Existe alguma ferramenta que auxilie na construção de man pages, ou estas
são construídas diretamente via algum editor de texto qualquer? Pergunto
isto por que uma man page tem uma formatação específica, o que acredito
seja criado por algum tipo de ferramenta.
Grato
--
==================================================
Eng. Eder Mateus Nunes Gonçalves
Doutorando em Inteligência Artificial
UFSC - Universidade Federal de Santa Catarina
==================================================
"De tanto ver triunfar as nulidades, de tanto ver prosperar a desonra,
de tanto ver crescer a injustiça, de tanto ver agigantar-se os poderes
nas mãos dos maus, o homem chega a desanimar da virtude, a rir-se da
honra, chega a ter vergonha de ser honesto." -- Rui Barbosa
</pre>
<br>
<hr width="90%" size="4"><br>
<table border="0" cellspacing="0" cellpadding="0" width="100%"
class="header-part1">
<tbody>
<tr>
<td>
<div class="headerdisplayname" style="display: inline;">Subject:
</div>
[GUFSC] Re: [GUFSC] Construção de man pages</td>
</tr>
<tr>
<td>
<div class="headerdisplayname" style="display: inline;">From: </div>
Rafael R Obelheiro <a class="moz-txt-link-rfc2396E" href="mailto:rro@das.ufsc.br"><rro@das.ufsc.br></a></td>
</tr>
<tr>
<td>
<div class="headerdisplayname" style="display: inline;">Date: </div>
Wed, 13 Nov 2002 14:54:07 -0200</td>
</tr>
<tr>
<td>
<div class="headerdisplayname" style="display: inline;">To: </div>
<a class="moz-txt-link-abbreviated" href="mailto:gufsc@das.ufsc.br">gufsc@das.ufsc.br</a></td>
</tr>
</tbody>
</table>
<br>
<pre wrap="">Caro,
On Wed, Nov 13, 2002 at 02:23:47PM -0200, Eder Mateus Nunes Goncalves wrote:
</pre>
<blockquote type="cite">
<pre wrap="">Existe alguma ferramenta que auxilie na construção de man pages, ou estas
são construídas diretamente via algum editor de texto qualquer? Pergunto
isto por que uma man page tem uma formatação específica, o que acredito
seja criado por algum tipo de ferramenta.
</pre>
</blockquote>
<pre wrap=""><!---->
Paginas de manual sao fontes troff (um tipo de linguagem de formatacao
de textos, como TeX) que usam os conjuntos de macros `an' ou `doc'.
Embora possam existir ferramentas que auxiliem na sua elaboracao (eu,
particularmente, nao conheco nenhuma), elas podem ser criadas com um
editor de textos qualquer, bastando conhecer um dos conjuntos de
macros citados.
Existe um mini-HOWTO que explica como escrever uma boa pagina de manual
em <a class="moz-txt-link-freetext" href="http://www.tldp.org/HOWTO/mini/Man-Page.html">http://www.tldp.org/HOWTO/mini/Man-Page.html</a>. Este documento contem
tambem outros ponteiros uteis sobre troff.
Um abraco,
Rafael.
</pre>
<pre wrap="">
<hr width="90%" size="4">
_______________________________________________
GUFSC mailing list
<a class="moz-txt-link-abbreviated" href="mailto:GUFSC@das.ufsc.br">GUFSC@das.ufsc.br</a>
<a class="moz-txt-link-freetext" href="http://www.das.ufsc.br/mailman/listinfo/gufsc">http://www.das.ufsc.br/mailman/listinfo/gufsc</a>
</pre>
</blockquote>
Dica importante para quem quer desenvolver documentação de programas.<br>
<br>
O formato sgml, é um formato bastante universal, e que é<br>
utilizado para desenvolvimento de documentação no GNU/LINUX.<br>
<br>
Você pode fazer o documento em um editor como o emacs, usando o padrão sgml.<br>
(o emacs tem suporte embutido para este tipo de documento).<br>
<br>
Depois o documento pode ser convertido para diferentes formatos usando
os programas <br>
listados a seguir<br>
<b>sgml2html sgml2latex sgml2rtf sgml2xml sgml2info sgml2lyx sgml2txt</b><br>
<br>
estes programas costumam vir nas distribuições do GNU/Linux.<br>
Observe que você pode converter para os principais formatos, html, latex,
rtf, xml lyx e txt.<br>
<br>
Observe ainda que sgml converte para xml, (o programa<b> sgml2xml). </b>
<br>
Daí você pode usar os conversores do xml, listados abaixo.<br>
<b>xml2-config xml2man xml2pot xmltex<br>
</b>para gerar a man page.<br>
<br>
Ou seja:<br>
sgml -> xml usando <b> sgml2xml</b><br>
e <br>
xml->man usando <b>xml2man</b>.<br>
<br>
PS; na minha distribuição não tem, mas se não me engano existe ainda um sgml2man
(direto).<br>
<br>
Você encontra maiores informações sobre sgml e xml no site de documentação
do Linux <br>
<a class="moz-txt-link-freetext" href="http://ldp.pop-rn.rnp.br/index.html">http://ldp.pop-rn.rnp.br/index.html</a><br>
<a class="moz-txt-link-freetext" href="http://www.linux.org/docs/ldp/index.html">http://www.linux.org/docs/ldp/index.html</a><br>
<br>
Também tem HOWTO falando disso em algum lugar.<br>
(se não me engano é um HOWTO sobre programação no Linux).<br>
<br>
</body>
</html>
--------------000706080700060604090602--