.\"t
.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "md2term" "1" "" "" "Manual de uso geral"
.hy
.SS NOME
.PP
md2term - Parser de markdown para destaques e cores no terminal.
.SS DESCRI\[,C]\[~A]O
.PP
O \f[C]md2term\f[R] foi criado para ser um parser de markdown para
textos curtos (menos de 30 linhas) que pudessem ser utilizados em
apresenta\[,c]\[~o]es pelo terminal (\f[I]slides\f[R] em texto) e, ao
mesmo tempo, capazes de serem visualizados corretamente por outros
parsers em sites na web (GitHub, GitLab, etc).
O script tamb\['e]m pode ser utilizado satisfatoriamente para visualizar
outros textos em markdown, desde que observadas suas limita\[,c]\[~o]es.
.SS SINOPSE
.PP
md2term [OP\[,C]\[~O]ES] -f ARQUIVO
.SS OP\[,C]\[~O]ES
.PP
-b CARACTERE\ \ \ Caractere marcador de listas.
.PP
-c\ \ \ \ \ \ \ \ \ \ \ \ \ Limpa o terminal antes de exibir o texto.
.PP
-i ESPA\[,C]OS\ \ \ \ \ Indenta\[,c]\[~a]o de listas, c\['o]digos e
cita\[,c]\[~o]es em espa\[,c]os.
.PP
-k VALOR\ \ \ \ \ \ \ Manter as cerquilhas nos t\['i]tulos:
.PP
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ 0=Descarta todas 1=Mant\['e]m todas
2=Apenas no t\['i]tulo 1
.PP
-m ESPA\[,C]OS\ \ \ \ \ Recuo da margem esquerda em espa\[,c]os.
.PP
-p\ \ \ \ \ \ \ \ \ \ \ \ \ Carrega em um pager (less).
.PP
-s ARQUIVO\ \ \ \ \ Esquema de cores alternativo.
.PP
-t LINHAS\ \ \ \ \ \ Afastamento do topo em linhas.
.PP
-h\ \ \ \ \ \ \ \ \ \ \ \ \ Exibe esta ajuda.
.SS MARCA\[,C]\[~O]ES V\['A]LIDAS
.PP
.TS
tab(@);
l l.
T{
Marca\[,c]\[~a]o
T}@T{
Resultado
T}
_
T{
\f[C]**TEXTO**\f[R] ou \f[C]__TEXTO__\f[R]
T}@T{
NEGRITO
T}
T{
\f[C]*TEXTO*\f[R] ou \f[C]*TEXTO*\f[R]
T}@T{
IT\['A]LICO
T}
T{
\f[C]___TEXTO___\f[R] ou \f[C]***TEXTO***\f[R]
T}@T{
NEGRITO E IT\['A]LICO
T}
T{
\f[C]\[ti]\[ti]TEXTO\[ti]\[ti]\f[R]
T}@T{
RISCADO
T}
T{
\f[C]<u>TEXTO</u>\f[R]
T}@T{
SUBLINHADO
T}
T{
\f[C]\[ga]TEXTO\[ga]\f[R]
T}@T{
C\['O]DIGO NA LINHA
T}
T{
\f[C][R\['O]TULO](URL)\f[R]
T}@T{
R\['O]TULO
T}
.TE
.SS BLOCOS
.PP
As marca\[,c]\[~o]es dos blocos de c\['o]digo precisam ser feitas no
\['i]nicio da linha!
.SS Bloco de c\['o]digo
.IP
.nf
\f[C]
\[ga]\[ga]\[ga]
BLOCO DE C\['O]DIGO
\[ga]\[ga]\[ga]
\f[R]
.fi
.SS Listas n\[~a]o ordenadas
.IP
.nf
\f[C]
- Item 1
- Item 2
- Item 3
\f[R]
.fi
.SS Listas ordenadas
.IP
.nf
\f[C]
1. Item 1
1. Item 2
1. Item 3
\f[R]
.fi
.SS Cita\[,c]\[~o]es/notas
.IP
.nf
\f[C]
> O texto da cita\[,c]\[~a]o ou da nota.
\f[R]
.fi
.SS For\[,c]ar quebra de linha
.IP
.nf
\f[C]
Par\['a]grafos, itens de lista e cita\[,c]\[~o]es poder \[rs]
ter suas linhas quebradas onde desejado \[rs]
utilizando contrabarras.
\f[R]
.fi
.SS LIMITA\[,C]\[~O]ES
.IP \[bu] 2
N\[~a]o interpreta listas aninhadas (sub-itens) corretamente.
.IP \[bu] 2
As quebras de linhas longas podem acontecer no meio de palavras, mas
\['e] poss\['i]vel contornar o problema especificando onde elas devem
acontecer no texto fonte (\['e] uma marca\[,c]\[~a]o v\['a]lida do
markdown GFM).
.IP \[bu] 2
Utilizar as op\[,c]\[~o]es \f[C]-c\f[R] e \f[C]-p\f[R] em conjunto pode
levar a problemas de redesenho do buffer no \f[C]less\f[R].
.IP \[bu] 2
Links s\[~a]o apenas representa\[,c]\[~o]es visuais utilizando o
r\['o]tulo da marca\[,c]\[~a]o (n\[~a]o a URL).
Se preferir a URL, ela pode ser usada como r\['o]tulo ou ser escrita
como texto sem marca\[,c]\[~a]o (a maioria dos terminais interpreta URLs
como link).
.SS LICEN\[,C]A
.PP
Copyright (C) 2022 Blau Araujo <blau@debxp.org>
.PP
Licen\[,c]a GPLv3+: GNU GPL vers\[~a]o 3 ou posterior
<https://gnu.org/licenses/gpl.html>
.PD 0
.P
.PD
Este \['e] um software livre: voc\[^e] \['e] livre para alter\['a]-lo e
redistribu\['i]-lo.
.PD 0
.P
.PD
N\[~A]O H\['A] QUALQUER GARANTIA, na m\['a]xima extens\[~a]o permitida
em lei.
.PP
Desenvolvido por Blau Araujo e Romeu Alfa