initstring / cloud_enum

Multi-cloud OSINT tool. Enumerate public resources in AWS, Azure, and Google Cloud.
MIT License
1.54k stars 224 forks source link

Added to provide a manpage to Debian package #45

Closed gpxlnx closed 2 years ago

gpxlnx commented 2 years ago

Hi, I am submitting a manpage as a suggestion to be added to your program. I apologize for the other PR. I'm detailing the reason for this PR better. I am packaging your program for Debian and by default it asks for programs to have a manpage.

I'm sending the source code of the manpage and also its source in case you need to change something or use it in any other way. This manpage was generated using the txt2man software.

initstring commented 2 years ago

Hi @gpxlnx,

Thanks for this PR and for the detailed description. This all sounds very reasonable, and it looks good at first glance.

I need to take some time (hopefully today or tomorrow) to go though it and make sure I understand the pieces fully before merging it in.

Also, if I need to make changes in the future I can just run the txt2man utility?

Thanks for your time and effort!

initstring commented 2 years ago

@gpxlnx -

I am not very familiar with Debian packaging. Is there anything else that it would make sense to include? I'm told it might be common to have a /debian folder in the project when preparing for packaging.

Thanks again!!!

gpxlnx commented 2 years ago

Hello,

I used the syntax of txt2man to generate the manual for Debian.

$ txt2man -d "07 Feb 2022" -t cloud_enum -r cloud_enum-0.6 -s 1 -v "Multi-cloud open source intelligence tool" cloud_enum.txt > cloud_enum.1

But txt2man have a script in /usr/share/doc/txt2man/examples called create-man.sh which can be used to generate manpages as per your demand.

Regarding your packaging questions, the debian/ directory is created by the packager and is not upstream's responsibility in theory.

Thank you very much for your attention and your program will be on Debian soon.

If you wanted to analyze the packaging, follow.

https://ftp-master.debian.org/new/cloud-enum_0.6-1.html