commit 1ef9ee4da3fc07c6ad324186e098f5e7440d4540
parent 871679c08ab1df6d75abea76e2c1601e479574af
Author: Yersa Nordman <yersa@finwo.nl>
Date: Sun, 29 Jan 2023 21:28:42 +0100
Render readme.md using pandoc now
Diffstat:
| M | Makefile | | | 4 | ++-- |
| M | README.md | | | 200 | ++++++++++++++++--------------------------------------------------------------- |
2 files changed, 42 insertions(+), 162 deletions(-)
diff --git a/Makefile b/Makefile
@@ -25,8 +25,8 @@ OBJ:=$(patsubst %.c,%.o,$(SRC))
.PHONY: default
default: supercop
-README.md:
- man --html=cat ./man/supercop.1 > README.md
+README.md: ./man/supercop.1
+ pandoc $< --output=$@
supercop: $(OBJ)
$(CC) $(CFLAGS) $(INCLUDES) -o $@ $(OBJ)
diff --git a/README.md b/README.md
@@ -1,194 +1,74 @@
-<!-- Creator : groff version 1.22.4 -->
-<!-- CreationDate: Thu Sep 16 21:22:39 2021 -->
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-"http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<head>
-<meta name="generator" content="groff -Thtml, see www.gnu.org">
-<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<meta name="Content-Style" content="text/css">
-<style type="text/css">
- p { margin-top: 0; margin-bottom: 0; vertical-align: top }
- pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
- table { margin-top: 0; margin-bottom: 0; vertical-align: top }
- h1 { text-align: center }
-</style>
-<title>supercop</title>
+# NAME
-</head>
-<body>
+supercop - Simplified CLI for supercop-ref10
-<h1 align="center">supercop</h1>
+# SYNOPSIS
-<a href="#NAME">NAME</a><br>
-<a href="#SYNOPSIS">SYNOPSIS</a><br>
-<a href="#DESCRIPTION">DESCRIPTION</a><br>
-<a href="#OPERATIONS">OPERATIONS</a><br>
-<a href="#OPTIONS">OPTIONS</a><br>
-<a href="#RETURN VALUE">RETURN VALUE</a><br>
-<a href="#ENVIRONMENT">ENVIRONMENT</a><br>
-<a href="#AUTHOR">AUTHOR</a><br>
+**supercop** *\<operation\>* \[**-k** *keyfile*\] \[**-m** *message*\]
+\[**-M** *message-file*\] \[**-s** *signature*\]
-<hr>
+# DESCRIPTION
+This program allows easy signing and signature verification for the
+supercop-ref10 implementation of the ed25519 signature scheme.
-<h2>NAME
-<a name="NAME"></a>
-</h2>
+# OPERATIONS
+**\--printkey**
-<p style="margin-left:11%; margin-top: 1em">supercop -
-Simplified CLI for supercop-ref10</p>
+: Print contents of key file
-<h2>SYNOPSIS
-<a name="SYNOPSIS"></a>
-</h2>
+**\--generate**
+: Generate a new key
+**\--sign**
-<p style="margin-left:11%; margin-top: 1em"><b>supercop</b>
-<i><operation></i> [<b>-k</b> <i>keyfile</i>]
-[<b>-m</b> <i>message</i>] [<b>-M</b> <i>message-file</i>]
-[<b>-s</b> <i>signature</i>]</p>
+: Sign a message
-<h2>DESCRIPTION
-<a name="DESCRIPTION"></a>
-</h2>
+**\--verify**
+: Verify a message signature
-<p style="margin-left:11%; margin-top: 1em">This program
-allows easy signing and signature verification for the
-supercop-ref10 implementation of the ed25519 signature
-scheme.</p>
+**\--version**
-<h2>OPERATIONS
-<a name="OPERATIONS"></a>
-</h2>
+: Show version number and exit
+# OPTIONS
+**-h, \--help**
-<p style="margin-left:11%; margin-top: 1em"><b>−−printkey</b></p>
+: Show usage and exit
-<p style="margin-left:22%;">Print contents of key file</p>
+**-k, \--key-file *path***
+: Select key file to use for the operation
-<p style="margin-left:11%;"><b>−−generate</b></p>
+**-m, \--message *message_string***
-<p style="margin-left:22%;">Generate a new key</p>
+: Message to sign or verify (defaults to stdin)
-<table width="100%" border="0" rules="none" frame="void"
- cellspacing="0" cellpadding="0">
-<tr valign="top" align="left">
-<td width="11%"></td>
-<td width="9%">
+**-M, \--message-file *path***
+: Message file to sign or verify (defaults to stdin)
-<p><b>−−sign</b></p></td>
-<td width="2%"></td>
-<td width="21%">
+**-s, \--signature *signature_string***
+: Signature to verify the message against
-<p>Sign a message</p></td>
-<td width="57%">
-</td></tr>
-</table>
+# RETURN VALUE
+Here are the possible return values:
-<p style="margin-left:11%;"><b>−−verify</b></p>
+> - **0 Everything went fine or the signature was valid**
+>
+> - **1 Signature was invalid or an error occurred, see stderr for an
+> explanation**
-<p style="margin-left:22%;">Verify a message signature</p>
+# ENVIRONMENT
+supercop doesn\'t follow any environment variables
-<p style="margin-left:11%;"><b>−−version</b></p>
+# AUTHOR
-<p style="margin-left:22%;">Show version number and
-exit</p>
-
-<h2>OPTIONS
-<a name="OPTIONS"></a>
-</h2>
-
-
-<p style="margin-left:11%; margin-top: 1em"><b>−h,
-−−help</b></p>
-
-<p style="margin-left:22%;">Show usage and exit</p>
-
-<p style="margin-left:11%;"><b>−k,
-−−key−file</b> <i>path</i></p>
-
-<p style="margin-left:22%;">Select key file to use for the
-operation</p>
-
-<p style="margin-left:11%;"><b>−m,
-−−message</b> <i>message_string</i></p>
-
-<p style="margin-left:22%;">Message to sign or verify
-(defaults to stdin)</p>
-
-<p style="margin-left:11%;"><b>−M,
-−−message−file</b> <i>path</i></p>
-
-<p style="margin-left:22%;">Message file to sign or verify
-(defaults to stdin)</p>
-
-<p style="margin-left:11%;"><b>−s,
-−−signature</b> <i>signature_string</i></p>
-
-<p style="margin-left:22%;">Signature to verify the message
-against</p>
-
-<h2>RETURN VALUE
-<a name="RETURN VALUE"></a>
-</h2>
-
-
-<p style="margin-left:11%; margin-top: 1em">Here are the
-possible return values:</p>
-
-<table width="100%" border="0" rules="none" frame="void"
- cellspacing="0" cellpadding="0">
-<tr valign="top" align="left">
-<td width="22%"></td>
-<td width="1%">
-
-
-<p>•</p></td>
-<td width="2%"></td>
-<td width="75%">
-
-
-<p><b>0</b> Everything went fine or the signature was
-valid</p> </td></tr>
-<tr valign="top" align="left">
-<td width="22%"></td>
-<td width="1%">
-
-
-<p>•</p></td>
-<td width="2%"></td>
-<td width="75%">
-
-
-<p><b>1</b> Signature was invalid or an error occurred, see
-stderr for an explanation</p></td></tr>
-</table>
-
-<h2>ENVIRONMENT
-<a name="ENVIRONMENT"></a>
-</h2>
-
-
-<p style="margin-left:11%; margin-top: 1em">supercop
-doesn’t follow any environment variables</p>
-
-<h2>AUTHOR
-<a name="AUTHOR"></a>
-</h2>
-
-
-<p style="margin-left:11%; margin-top: 1em">finwo
-(https://finwo.nl)</p>
-<hr>
-</body>
-</html>
+finwo (https://finwo.nl)
