Skip to main content

minimal manpages.

Project description

MIN

  • minimal manpages
  • providing you with the 80/20 of how many unix commands are used, for whenever you've forgotten how to use find or grep for the 3rd time this week

demo

Installation

  • available from pypi via pip install miniman

Usage

  • contains minpages for unix commands, as well as more general explainer pages for important topics in the unix workflow (e.g. file, filesystem)

Unix commands

  • run min to get a list of all available minpages for bash commands
  • run min command to get the minpage for bash command command
  • e.g. min grep to get the minpage for grep

Unix Topics

  • run min -t to get a list of all available minpages for unix topics
  • run min -t topic to get the minpage for unix topic topic
  • e.g. min -t filesystem to the minpage for filesystem

Contribute

Obviously, this is a work in progress. Although I use many of these commands in my daily workflow, I am nowhere near understanding all the ins and outs. So please open up an issue if I've gotten anything wrong. Thanks in advance.

Also there are more things I'd like to do with this project:

  • add a search function where you can just search for a string pattern among all minpages, and get returned relevant results (i.e. grepping among all minpages)
  • add additional useful commands
  • add additional useful topics (e.g. 80/20 regexp, interactive bash [things like <(command), !:n/!^/!$, piping, difference between '' and "", ...], vim, ...)
  • unify the sections in the commands/topics so that everyone can always have clear expectations of what to expect from a min page
  • maybe go for some more advanced markup, to do highlights, bolding, etc.

If you could see yourself contributing to any of that, just open up an issue at https://github.com/mleue/min/issues. I'd be delighted.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

miniman-0.0.8.tar.gz (18.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

miniman-0.0.8-py3-none-any.whl (39.4 kB view details)

Uploaded Python 3

File details

Details for the file miniman-0.0.8.tar.gz.

File metadata

  • Download URL: miniman-0.0.8.tar.gz
  • Upload date:
  • Size: 18.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.31.1 CPython/3.6.8

File hashes

Hashes for miniman-0.0.8.tar.gz
Algorithm Hash digest
SHA256 911d20625b1e6931a75b72c756ee1acb0a2513ef864becb8620772856fccf586
MD5 9502ca9d2f75ad435eecf7ade1d742aa
BLAKE2b-256 866947169dceb5b6d66609c4b4e086ec2039005ec360db52be37b8b7f800cb36

See more details on using hashes here.

File details

Details for the file miniman-0.0.8-py3-none-any.whl.

File metadata

  • Download URL: miniman-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 39.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.31.1 CPython/3.6.8

File hashes

Hashes for miniman-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 069c0dffff2eee88bf3672ef8ee0433c08d73c0556c326c3fac9128ad6c878d1
MD5 c4e41fdead4758e3764b3e1369a4be0c
BLAKE2b-256 2c9108ad470f44811eb0fb7301575f2758dba8cebc7725aa75346eeb31a91162

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page