Getting help: the powerful man(ual)

Getting help: the powerful man(ual)


Let's face it: GNU/Linux software is not always easy to use. Especially command line software (at least the GUI programs have buttons and tooltips). Sometimes, the program will have a manual or some documentation at its homepage, but that is not always the case. The solution? The magical man.

man: the terminal solution to almost all problems

In the beginning, there was no coherent manual reading program. Manuals were scattered everywhere, if they even existed. Then, the first manual pages (shortened to man) were written by Dennis Ritchie (creator of the C language and UNIX pioneer) and Ken "ken" Thompson (creator of the B language which was surpassed by C and UNIX pioneer). Now, thirty-five years later, virtually every terminal program and most graphical programs have a manual in the manpage format.

You're probably thinking, "fun history lesson, but this doesn't help me at all". Well, it's now time to get to the program that was created to read these manuals: man. You don't have to worry about installing it (if you are running an modern UNIX/Linux operating system, you have it installed). All you need to do is open a terminal and run man program_name_here, where program_name_here is the name of the program in lowercase (e.g. man firefox). You will then be presented with the program's manual. You can use the arrow keys, the page up and page down keys, and the home and end keys to navigate. To exit, just hit the q key and you will be taken back to the console. Here's what the first page of the wget manual looks like:

WGET(1)                GNU Wget                    WGET(1)

NAME
       Wget - The non-interactive network downloader.

SYNOPSIS
       wget [option]... [URL]...

DESCRIPTION
       GNU Wget is a free utility for non-interactive download of files from the Web.  It supports HTTP, HTTPS, and FTP protocols, as well as retrieval through HTTP proxies.

       Wget is non-interactive, meaning that it can work in the background, while the user is not logged on.  This allows you to start a retrieval and disconnect from the
       system, letting Wget finish the work.  By contrast, most of the Web browsers require constant user’s presence, which can be a great hindrance when transferring a lot
       of data.
[...]
Figure 1: the beginning of the wget manpageFigure 1: the beginning of the wget manpage

Yelp: a wonderful help viewer for Gnome

Obviously, the man viewer is kind of hard on the eyes. A better way is to use a graphical man viewer. Yelp (also known as Help or H_elp and Support_ or Help Center in some distributions) fits this niche beautifully for Gnome users. It's actually more than just a man viewer; it views DocBook, man, and infopage documents as well as FAQs provided by the distribution. To use it, just type the program's name (it doesn't even have to be in lowercase) in the search bar and you will be presented with a long list of results. Look for the manual page (e.g. wget manual page) and click on that result. You'll find the same manual... but a whole lot easier to read.

Figure 2: wget page in YelpFigure 2: wget page in Yelp

KDE Help Center: Yelp for KDE

If you're a KDE user, you probably won't want to be using Yelp. Instead, you should use the KDE Help Center that ships with KDE. Just type in the program name (again, it doesn't have to be in all lowercase) in the search box, make sure UNIX manual pages is checked under the Scope section, and hit the Search button. Under the UNIX manual pages heading, look for the program you searched for (e.g. wget - The non-interactive network downloader.) and click on it. You will be presented with a very nice looking page rendered by Konqueror.

Figure 3: wget page in the KDE Help CenterFigure 3: wget page in the KDE Help Center

Konqueror: an alternative, less cumbersome man viewer for KDE

I personally find the KDE Help Center to be really clumsy. To me, the better alternative is using Konqueror, the KDE web browser and file manager (though the latter part will be replaced by Dolphin in KDE 4). After all, it's really Konqueror doing the rendering in the KDE Help Center. To use Konqueror to read a man page, just type man:program_name_here, where again program_name_here is the program in lowercase letters. You can also search for your program by going to man:/ and looking in the different sections. It's a really nice way to quickly access a manpage without the bells and whistles of KDE Help Center.

Figure 4: wget page in KonquerorFigure 4: wget page in Konqueror

Die.net man viewer (and many other sites)

The final way to view a manpage (and the best way if you aren't using KDE or Gnome) on UNIX operating systems is using a website. There are many websites that do this, but for this example I'll use the Die.net site at http://linux.die.net/man/. Just type the name of the program in the Die.net site search and you will be presented with a Google-powered result list. This is also a great way to view a program's manual without installing it, as all the other options on this list require you to have that program installed.

Figure 5: The Die.net man viewerFigure 5: The Die.net man viewer
Category: 

Author information

Andrew Min's picture

Biography

/ˈændruː/ /mi:n/
(n): a Christian.
(n): a student.
(n): a technology enthusiast.
(n): a journalist for several online publications.

Andrew Min is a student, programmer, and journalist from New York City.

My main forte in the technology realm is journalism. I’ve written for a variety of magazines, both print and non-print, with a focus on open source software and the new web. I’ve also been interviewed on a long list of topics, ranging from politicians on Twitter to open source software and homeschooling.

I also have experience with a variety of programming languages (Bash, Batch, CSS, JavaScript, PHP, and (X)HTML) and content management systems (WordPress). I’ve been hired to design and administer several websites. In addition, I’ve been the lead programmer on several small coding projects.

Most forwarded

Interview with Dave Mohyla, of DTIDATA

Dave Mohyla is the president and founder of dtidata.com, a hard drive recovery facility based in Tampa, Florida.

TM: Where are you based? What does your company do?
DTI Data recovery is based in South Pasadena, Florida which is a suburb of Tampa. We have been here for over 10 years. We operate a bio-metrically secured class 100 clean room where we perform hard drive recovery on all types of hard disks, from laptop hard drives to multi drive RAID systems.

Anybody up to writing good directory software?

Since the very beginning, directories (of any kind) have had a very central role in the internet. (I have recently grown fond of Free Web Directory. Even Slashdot can be considered a directory: a collection of great news and invaluable user-generated comments. As far as software is concerned, doing a quick search on Google about software directories will return the free (as in freedom) software directories like Savannah, SourceForge, Freshmeat and so on, followed by shareware and freeware sites such as FileBuzz, PCWin Download Center and All Freeware (great if you're looking for shareware and freeware, but definitely less comprehensive than their free-as-in-freedom counterparts).

Interview with Mark Shuttleworth

Mark Shuttleworth is the founder of Thawte, the first Certification Authority to sell public SSL certificates. After selling Thawte to Verisign, Mark moved on to training as an astronaut in Russia and visiting space. Once he got back he founded Ubuntu, the leading GNU/Linux distribution. He agreed on releasing a quick interview to Free Software Magazine.

Is better education the key to finding better software?

I read David Jonathon's article Anybody Up To Writing Good Directory Software? the other day, which got me thinking about software directories in general. As David mentioned, many of the software directories one finds when doing a quick google search are free as in beer, not as in freedom. But what interests me is the software directories that already exist, providing a combination of both free as in beer software, and open source software. Sites such as Freeware Downloads and Shareware Download don't advertise themselves as providing free as in liberty software, but each of them have a good selection of open source software available... if you know where to look.

Most emailed

Free Open Document label templates

If you’ve ever spent hours at work doing mailings, cursed your printer for printing outside the lines on your labels, or moaned “There has got to be a better way to do this,” here’s the solution you’ve been looking for. Working smarter, not harder! Worldlabel.com, a manufacture of labels offers Open Office / Libre Office labels templates for downloading in ODF format which will save you time, effort, and (if you want) make really cool-looking labels

Creating a user-centric site in Drupal

A little while ago, while talking in the #drupal mailing list, I showed my latest creation to one of the core developers there. His reaction was "Wow, I am always surprised what people use Drupal for". His surprise is somehow justified: I did create a site for a bunch of entertainers in Perth, a company set to use Drupal to take over the world with Entertainers.Biz.

Update: since writing this article, I have updated the system so that the whole booking process happens online. I will update the article accordingly!

So, why, why do people and companies develop free software?

More and more people are discovering free software. Many people only do so after weeks, or even months, of using it. I wonder, for example, how many Firefox users actually know how free Firefox really is—many of them realise that you can get it for free, but find it hard to believe that anybody can modify it and even redistribute it legally.

When the discovery is made, the first instinct is to ask: why do they do it? Programming is hard work. Even though most (if not all) programmers are driven by their higher-than-normal IQs and their amazing passion for solving problems, it’s still hard to understand why so many of them would donate so much of their time to creating something that they can’t really show off to anybody but their colleagues or geek friends.

Sure, anybody can buy laptops, and just program. No need to get a full-on lab or spend thousands of dollars in equipment. But... is that the full story?

Fun articles

Santa Claus - the most successful open source project

It dawned on me the other day, as I was shopping for the dozens of gifts it seems I have to buy every December, that Santa Claus is the most successful open source project in history. (Bridget @ Illiterarty would agree with that). Santa Claus is essentially a marketing development that is embodied by everyone who stuffs a sock, gives a gift, hosts a dinner or wishes Merry Christmas over the holiday season.

Most emailed

Editorial

When I first started thinking about Free Software Magazine, I was feeling enthusiastic about the dream. I had Dave, Gianluca, and Alan willing to help me, I had established members of the free software community willing to help me out, I had writers volunteering their time and energy for free, and I had a generous offer from OpenHosting for servers, all before I'd proved myself. There was a sense of excitement in the air, and I thought maybe, just maybe, I could make this work.

Free Software Magazine uses Apollo project management software and CRM for its everyday activities!