Package: poke
Severity: wishlist
Tags: patch
X-Debbugs-Cc: charlesmel...@riseup.net
Dear Maintainer, hi!
I saw pokefmt doesn't have a manpage, so I've written one using
go-md2man and I'm attaching both files (the original markdown and the
generated manpage) here.
I'm not sending a patch because you might have a different opinion on
how to integrate it in your package. Only incorporate pokefmt.1, create
a helper script to generate the manpage, include a rule i d/rules to
generate it, only do it by hand...
In case you want to generate the manpage from the markdown file, the
command is:
go-md2man -in pokefmt.md.1 -out pokefmt.1
Cheers,
Charles
.nh
.TH pokefmt 1 "May 2024" pokefmt "User Manual"
.SH NAME
.PP
pokefmt - Template system to embed Poke code in files
.SH SYNOPSIS
.PP
\fBpokefmt\fP [POKE-CODE]
.PP
\fBpokefmt\fP [OPTIONS]
.SH DESCRIPTION
.PP
\fBpokefmt\fP copies the content from standard input to standard output and
replaces the Poke code with the result of execution. You can write Poke code
between \fB%{\fR and \fB}%\fR delimters. To simplify printing of expressions,
pokefmt
also supports embedding of Poke expressions between \fB%(\fR and \fB%)\fR
delimiters.
.SH OPTIONS
.TP
\fB-h\fP, \fB--help\fP
Show summary of options.
.TP
\fB-v\fP, \fB--version\fP
Show version of program.
.SH EXAMPLES
.PP
As as example, pokefmt will transform the following text
.EX
%{
load riscv;
var a = 1, b = 2;
}%
The encoding of ADD R3, R2, R1 instruction in RISC-V instruction set
is %{printf "0x%u32x", rv32_add (3, 2, 1);}%.
The result of %(a)% + %(b)% is %(a + b)%.
.EE
.PP
to this text:
.EX
The encoding of ADD R3, R2, R1 instruction in RISC-V instruct set
is 0x001101b3.
The result of 1 + 2 is 3.
.EE
.SH BUGS
.PP
Report bugs in the bug tracker at
https://sourceware.org/bugzilla/describecomponents.cgi?product=poke
or by email to <poke-de...@gnu.org>\&.
.SH SEE ALSO
.PP
\fBpoke\fP(1)
.SH AUTHOR
.TP
Carlos Henrique Lima Melara <charlesmel...@riseup.net>\&.
Wrote this manpage for the Debian system in May 2024.
pokefmt 1 "May 2024" pokefmt "User Manual"
==========================================
# NAME
pokefmt - Template system to embed Poke code in files
# SYNOPSIS
**pokefmt** [POKE-CODE]
**pokefmt** [OPTIONS]
# DESCRIPTION
**pokefmt** copies the content from standard input to standard output and
replaces the Poke code with the result of execution. You can write Poke code
between `%{` and `}%` delimters. To simplify printing of expressions, pokefmt
also supports embedding of Poke expressions between `%(` and `%)` delimiters.
# OPTIONS
**-h**, **\-\-help**
: Show summary of options.
**-v**, **\-\-version**
: Show version of program.
# EXAMPLES
As as example, pokefmt will transform the following text
```
%{
load riscv;
var a = 1, b = 2;
}%
The encoding of ADD R3, R2, R1 instruction in RISC-V instruction set
is %{printf "0x%u32x", rv32_add (3, 2, 1);}%.
The result of %(a)% + %(b)% is %(a + b)%.
```
to this text:
```
The encoding of ADD R3, R2, R1 instruction in RISC-V instruct set
is 0x001101b3.
The result of 1 + 2 is 3.
```
# BUGS
Report bugs in the bug tracker at
https://sourceware.org/bugzilla/describecomponents.cgi?product=poke
or by email to \<poke-de...@gnu.org\>.
# SEE ALSO
**poke**(1)
# AUTHOR
Carlos Henrique Lima Melara \<charlesmel...@riseup.net\>.
: Wrote this manpage for the Debian system in May 2024.
