3

ExplainShell: A Web-Based Alternative to the Traditional Linux Man Pages

 2 years ago
source link: https://www.makeuseof.com/explain-shell-linux-man-pages-alternative/
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
neoserver,ios ssh client

ExplainShell: A Web-Based Alternative to the Traditional Linux Man Pages

By Yash Wate

Published 21 minutes ago

Sometimes, shell commands can be hard to understand. ExplainShell breaks down such commands into individual options for better comprehension.

No matter how experienced you're with the Linux command line, there will always be times when you'll encounter unfamiliar commands. In such situations, while the natural instinct is to either refer to man pages or google the command to figure out what it does, what if we tell you there's a better (read immersive) way to do it.

Well, as it turns out, there's a tool called ExplainShell that does exactly that: tells you what each part of a shell command does in an easy-to-comprehend manner.

So let's dive in to check out ExplainShell in detail.

What Is ExplainShell?

ExplainShell is a web-based tool that helps you look up unfamiliar shell commands to find out what they do and learn more about them. You can think of it as an online collection of man pages where you can query commands to get a detailed explanation about their purpose, supported arguments, and syntax—all in a well-presented and easy-to-understand manner.

How Does ExplainShell Work?

ExplainShell is an online archive that constitutes a bunch of parsed sections from Ubuntu's man pages repository. It's powered by a few different services in the background that help it find a match for your queried commands in its database.

If there's a match, ExplainShell returns all the relevant information about that command it could pull up from its man page in an intuitive presentation.

Learn More: What Is the Linux Command Line and How Do You Use It?

How to Use ExplainShell

Since ExplainShell is web-based, you don't need to install it on your local machine to use it. Instead, all you have to do is head over to explainshell.com and start making queries for commands you're interested in to learn more about them.

ExplainShell

To look up a shell command on ExplainShell, first, copy the command to ensure you're querying the correct command.

Now, either right-click in the search box and select Paste or press Ctrl + V to paste the command you just copied. Alternatively, you may also type in the command manually.

ExplainShell command look up

Finally, hit the EXPLAIN button next to the search box to look it up.

ExplainShell will then pull up its explanation and present it on the next page. Here, you'll find that it breaks down the meaning of each part of the command one by one by matching the arguments to the relevant help text in its man page database.

The explanation is laid out such that you have the queried command on top broken down aptly into different sections (and arguments) and explanations for each of them grouped into boxes right below it, connected via lines.

Using your mouse, you can then hover over an argument (or a part of the command) that you don't understand to highlight its explanation.

ExplainShell command explanation

Moreover, you can click on the hyperlinked command name beside source man pages at the bottom of the page to pull up the explanation source and get more relevant information.

ExplainShell viewing source man pages

Lastly, although an aesthetic feature, ExplainShell also lets you change the theme of the website. So if you prefer dark mode, you can tap on the theme button below the website name and select Dark from the dropdown menu to switch the site's theme.

What Are ExplainShell's Limitations?

As of writing this, ExplainShell contains 29,761 parsed man pages in its database, and the chances are high that most of the shell commands you'll query on it will get you definite results.

However, that said, it's also likely that the tool won't be able to provide explanations for certain command queries you make. When this happens, ExplainShell's developer suggests submitting an add request with the link over at its GitHub Issues page so they can add it to their database.

Related: Ways to Get Command-Line Help on Linux

Learning New Shell Commands With ExplainShell

Through this guide, you should now probably have an idea of what ExplainShell is and how it can help you decode mysterious shell commands easily.

So now, whenever you come across an unfamiliar command, you can simply go to ExplainShell and find out all the information about it. And in the process, learn what that command does and how to use it.

If you're new to Linux, we recommend you check out these basic commands that will help you learn standard computing tasks.

About The Author

607c6b93718c9-e1587291254811.jpg?fit=crop&w=100&h=100

Yash Wate (30 Articles Published)

Yash is a Staff Writer at MUO for DIY, Linux, Programming, and Security. Before finding his passion in writing, he used to develop for the web and iOS. You can also find his writing on TechPP, where he covers other verticals. Other than tech, he enjoys talking about astronomy, Formula 1, and watches.

More From Yash Wate

Subscribe to our newsletter

Join our newsletter for tech tips, reviews, free ebooks, and exclusive deals!

Click here to subscribe

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK