search

praetorian-inc / noseyparker

Nosey Parker is a command-line program that finds secrets and sensitive information in textual data and Git history.
Apache License 2.0
1.66k stars 79 forks source link

Add a man page on the rules format #141

Open bradlarsen opened 7 months ago

bradlarsen commented 7 months ago

Nosey Parker now has auto-generated manpages for its command-line interface (#88). It would also be helpful if there were a manpage on the rules and rulesets format used by Nosey Parker.

This manpage probably belongs in section 5 (the one for file formats).

This manpage is not something that would be auto-generated. Using the existing RULES.md documentation that I keep forgetting about would be a good starting point.

The manpage should be included in prebuilt Nosey Parker releases.

munntjlx commented 6 months ago

I can volunteer to help. Just guide me.

Thomas

bradlarsen commented 6 months ago

@munntjlx I'm not sure about formatting of a handwritten manpage. I'm actually not familiar with the syntax that man / nroff uses. My preference based purely on familiarity would be to try to convert Markdown into a manpage, but I'm not dead-set on that.

I think the starting point is to look at the content of the existing RULES.md page. I wrote that a long time ago, and as the author, don't always have a great sense for what is not clear about it. So any feedback, questions, or expansions you have on that would be valuable.

munntjlx commented 6 months ago

Maybe a pandoc macro that coverts a specifically formatted md to an appropriate man page?

From: Brad Larsen @.***> Sent: Wednesday, 27 March 2024 15:39 To: praetorian-inc/noseyparker Cc: Munn, Thomas (LNG-RDU); Mention Subject: Re: [praetorian-inc/noseyparker] Add a man page on the rules format (Issue #141)

External email: use caution

@munntjlxhttps://github.com/munntjlx I'm not sure about formatting of a handwritten manpage. I'm actually not familiar with the syntax that man / nroff uses. My preference based purely on familiarity would be to try to convert Markdown into a manpage, but I'm not dead-set on that.

I think the starting point is to look at the content of the existing RULES.mdhttps://github.com/praetorian-inc/noseyparker/blob/main/docs/RULES.md page. I wrote that a long time ago, and as the author, don't always have a great sense for what is not clear about it. So any feedback, questions, or expansions you have on that would be valuable.

— Reply to this email directly, view it on GitHubhttps://github.com/praetorian-inc/noseyparker/issues/141#issuecomment-2023824856, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ALVIUB3HBK6GZFIDPDUMPITY2MOAFAVCNFSM6AAAAABELYUJX2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAMRTHAZDIOBVGY. You are receiving this because you were mentioned.Message ID: @.***>