#923550 dmarc-cat: Missing documentation

Package:
dmarc-cat
Source:
dmarc-cat
Description:
decode DMARC reports
Submitter:
Daniel Kahn Gillmor
Date:
2021-11-29 15:18:03 UTC
Severity:
normal
#923550#5
Date:
2019-03-01 20:06:58 UTC
From:
To:
0 dkg@alice:~/tmp$ man dmarc-cat
No manual entry for dmarc-cat
See 'man 7 undocumented' for help when manual pages are not available.
16 dkg@alice:~/tmp$ dmarc-cat --help
Usage of dmarc-cat:
  -D	Debug mode
  -N	Do not resolve IPs
  -S string
    	Sort results (default "\"Count\" \"dsc\"")
  -j int
    	Parallel jobs (default 4)
  -v	Verbose mode
  -version
    	Display version
2 dkg@alice:~/tmp$ ls -la /usr/share/doc/dmarc-cat/
total 164
drwxr-xr-x    2 root root   4096 Mar  1 14:54 .
drwxr-xr-x 4242 root root 151552 Mar  1 14:54 ..
-rw-r--r--    1 root root    208 Feb  6 10:21 changelog.Debian.gz
-rw-r--r--    1 root root   1905 Feb  6 10:21 copyright
0 dkg@alice:~/tmp$


This doesn't even tell me how i am supposed to invoke dmarc-cat or
point it to specific files.  Given the name "cat", i'd imagine i can
feed it documents on stdin, but that doesn't work.

having some minimal documentation would be useful!

Thanks for maintaining dmarc-cat in debian,
#923550#10
Date:
2021-11-26 17:04:07 UTC
From:
To:
Package: dmarc-cat
Tags: patch
#923550#15
Date:
2021-11-29 15:15:24 UTC
From:
To:
this is a bit unusual: typically, this section is called `OPTIONS`. See
the man-pages(7) manual page.

"AUTHOR" is also refered to as "AUTHORS" in the aforementioned
man-pages(7), but its use is Discouraged. COPYRIGHT similarly comes
after AUTHORS and says "Not used". I would typically just keep "AUTHORS"
and elide the copyright altogether, especially if you intend to break up
the copyright per section like this... It feels a bit weird to assign
copright to specific sections like that, for example.

I certainly don't see how I own the copyright on the OVERVIEW section,
in any case.

Sorry for the legal nitpicking...

A.