idank / explainshell

match command-line arguments to their help text
GNU General Public License v3.0
12.98k stars 778 forks source link

Docker upgrade and man page seeding #277

Closed timothybrush closed 1 year ago

timothybrush commented 3 years ago

Thank you for developing this tool. I was introduced to it just yesterday and saw some areas that could be made easier to run as standalone. I see that you are working on a Python 3 branch but I didn't know how far you are from release, so I didn't focus on that.

I merged a few changes others had made in forks that seemed useful. Then, I focused on slimming down your Docker image and automating some of your previous steps. I also seeded the manpages directory with man pages from a few Linux distributions and created an import script to load them. The pages add a bit of weight to the repository but nothing too significant.

Hopefully my updates will make it easier on you to update and continue work on the parser. Adding the Linux distributions to the manpages directory should also open up the possibility for others to issue pull requests with missing manpages. I realize there is likely some duplication but I didn't have time to compare each distribution's man pages against others.

List of changes:

timothybrush commented 3 years ago

Fixes issues:

Upgraded man pages #65

Problem starting docker-compose #184

Parse newer manpages #219

No man page for journactl #233 (Note: command is journalctl)

build(deps): bump nltk from 2.0.5 to 3.4.5 #244

Having trouble importing man pages #260

nltk-2.0.5 is obsolete #261

docker-compose build fails #267

Should help with the following issues:

[feature request] add FreeBSD/Mac OS X man pages #5

nohup man page missing #119

POSIX/ Use several sources for manpages #147

Can't explain Docker container commands #203

Is CentOS/RHEL Supported? #268

Footur commented 2 years ago

@idank It would be nice if you could take a look here. :slightly_smiling_face:

idank commented 2 years ago

Sorry for the long delay, wow!

There are a lot of really good changes here. Can we start with the more straight forward changes first? E.g. the ones that don't update the man pages. We can follow up with that as it's more complicated to deal with.

tobiashochguertel commented 2 years ago

This works also with podman-compose. I tested it with my MacBook Pro (Intel). I had to do a small fix before it was able to run: chmod o+rwx ./ in the root of the git-working-copy (gh pr checkout 277). Then everything went fine, and the web container was able to write to the volume-mount from the docker-compose.yml file.

I would just merge it?