cve-client

commit: 53af0c11149cf2f4919c519ce0ce640fd5a7dfa7
parent c47ba441d72d684f4d91c6ebcf0732eaf8c9ab41
Author: Haelwenn (lanodan) Monnier <contact@hacktivis.me>
Date:   Thu, 30 Mar 2023 09:03:26 +0200

cve-client: Add pod

Diffstat:
M
Makefile.PL
3
+++
M
cve-client
37
++++++++++++++++++++++++++++++++++++-

2 files changed, 39 insertions(+), 1 deletion(-)
diff --git a/Makefile.PL b/Makefile.PL
@@ -36,6 +36,9 @@ WriteMakefile(
 	AUTHOR    => 'Haelwenn (lanodan) Monnier <contact+cve-client@hacktivis.me>',
 	LICENSE   => 'agpl_3',
 	EXE_FILES => ['cve-client'],
+	MAN1PODS  => {
+		'cve-client' => 'blib/man1/cve-client.1',
+	},
 
 	VERSION_FROM  => 'cve-client',
 	PREREQ_PM     => \%depend,
diff --git a/cve-client b/cve-client
@@ -10,10 +10,45 @@ no warnings;    # Wide Character…
 use App::CveClient qw(print_cve);
 
 use Getopt::Std;
+$Getopt::Std::STANDARD_HELP_VERSION = 1;
 use LWP::UserAgent;
 use JSON::MaybeXS;
 
-$Getopt::Std::STANDARD_HELP_VERSION = 1;
+=head1 NAME
+
+cve-client - CLI-based client / toolbox for CVE.org
+
+=head1 SYNOPSIS
+
+B<cve-client> [-r|-j|-g] <CVE-IDs ...>
+
+=head1 DESCRIPTION
+
+B<cve-client> fetches CVE-IDs from CVE.org API and write the result to standard output.
+
+By default it is pretty-printed into a plain-text format.
+
+=over 3
+
+=item -j
+
+Pipe into jq(1)
+
+=item -r
+
+Raw output, print server's output without any decoding
+
+=item -g
+
+Pretty-print but compatible with Gemini.
+
+=back
+
+=head1 LICENSE
+
+AGPL-3.0-only
+
+=cut
 
 my $json = JSON::MaybeXS->new(utf8 => 1);