1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
|
From: Noah Meyerhans <noahm@debian.org>
Date: Sun, 9 Oct 2022 09:52:59 -0700
Subject: [PATCH] pod: Fix missing and malformed NAME headings
whatis expects the NAME heading to show the name of the program,
followed by ' - ', followed by the program description. This change
updates the pod for the included executables to follow that
convention.
---
bin/dmarc_http_client | 2 +-
bin/dmarc_lookup | 2 +-
bin/dmarc_receive | 2 +-
bin/dmarc_send_reports | 2 +-
bin/dmarc_update_public_suffix_list | 2 +-
bin/dmarc_view_reports | 4 ++++
6 files changed, 9 insertions(+), 5 deletions(-)
--- a/bin/dmarc_http_client
+++ b/bin/dmarc_http_client
@@ -68,7 +68,7 @@ __END__
=head1 NAME
-dmarc_http_client: an HTTP client for submitting a DMARC validation request
+dmarc_http_client - an HTTP client for submitting a DMARC validation request
=head1 SYNOPSIS
--- a/bin/dmarc_lookup
+++ b/bin/dmarc_lookup
@@ -42,7 +42,7 @@ __END__
=head1 NAME
-dmarc_lookup: look up DMARC policy for a domain
+dmarc_lookup - look up DMARC policy for a domain
=head1 SYNOPSIS
--- a/bin/dmarc_receive
+++ b/bin/dmarc_receive
@@ -33,7 +33,7 @@ __END__
=head1 NAME
-dmarc_receive: receive aggregate reports via IMAP, mbox, or message file(s)
+dmarc_receive - receive aggregate reports via IMAP, mbox, or message file(s)
=head1 USAGE
--- a/bin/dmarc_send_reports
+++ b/bin/dmarc_send_reports
@@ -11,7 +11,7 @@ __END__
=head1 NAME
-dmarc_send_reports: send aggregate reports
+dmarc_send_reports - send aggregate reports
=head1 AUTHORS
--- a/bin/dmarc_update_public_suffix_list
+++ b/bin/dmarc_update_public_suffix_list
@@ -34,7 +34,7 @@ __END__
=head1 NAME
-dmarc_update_public_suffix_list: command line tool to download updated public suffix list
+dmarc_update_public_suffix_list - command line tool to download updated public suffix list
=head1 SYNOPSIS
--- a/bin/dmarc_view_reports
+++ b/bin/dmarc_view_reports
@@ -159,6 +159,10 @@ exit;
__END__
+=head1 NAME
+
+dmarc_view_reports - view the contents of the DMARC data store
+
=head1 SYNOPSIS
dmarc_view_reports [ --option=value ]
|