Giter VIP home page Giter VIP logo

splain's Introduction

splain

Well actually, it's just a replacement for man(1).

Installing

curl -L https://raw.githubusercontent.com/kris-nova/splain/master/intaller.sh | sudo bash

Description

splain(1) is a modern replacement for man(1).

This command does absolutely nothing more than wrap man(1).

It serves as a valuable tool, to help demonstrate how completely ridiculous mansplaining actually is.

The splain(1) project was started in a gallant effort to over emphasize the sheer absurdity of over explaining a technical tool. The tool is simple, elegant, and unique. It use a shell wrapper (you do know what a shell is right?) to wrap a native utility called man(1).

The wrapper is executed after the splain executable has been loaded into a user's $PATH.

The splain(1) executable can be used as an effective, and demonstrable replacement for man(1).

Examples

To run the man page for splain run:
man splain

This will run the shell wrapper for man(1) and pass the first argument directly to the splain executable, and thus the splain(1) program.

This can be used to find out more information about the splain project.

To use splain to open a manual for any command on your system use the following syntax:
splain <command>

Where is any executable with a valid manual page registered on your system.

Author

The splain(1) project was originally built by Kris Nova.

She can be reached at [email protected]

And more information about the splain(1) project can be found in the official repository:

https://github.com/kris-nova/splain

The splain(1) project is an Apache 2 licensed project, all contributions are welcome.

If you would like to report a bug, please file a bug report in the official repository.

splain's People

Contributors

krisnova avatar broady avatar emaste avatar

Watchers

Spencer Tom Tafadzwa Chirume avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.