Creating Manpages with groff

A Call for New Manpages!

Author(s):

Do have difficulty remembering

command syntax? It often pays to

check the manpage. In this issue of

Command Line,we look at how to

create your own manpages,and

how to convert manpages to other

formats.

Good documentation is almost as

important as good programming.

It even makes sense to document

the major functions in the most trivial of

your own scripts, to save you from racking

your brains later when you need to

change something. Manpages give users

tips on usage and details on command

syntax options. Some manpages also

include examples or references to related

tools.

Users can read manpages in a terminal

window, and they can convert a manpage

quickly and easily to another

format such as HTML, PostScript, or

PDF. Manual pages are traditionally created

using the text formating tool groff.

The first version of this program

appeared on legacy Unix systems, where

it was known as roff (= “run off”). Later

developments of the document formatter

were called nroff and troff; groff is the

GNU version for the current crop of

Linux systems. This article shows how to

use groff to write a manpage and how to

convert that manpage into other formats.

Read full article as PDF:

Creating_Manpages_with_groff.pdf (235.32 kB)

Related content

  • Admin Workshop: Documentation

    System admins routinely refer to documentation for help with obscure command line options. In this month’s Admin Workshop, we examine the programs and formats behind the command line documentation you read everyday.

  • Command Line

    This month, we’ll show you how to decorate your console and give it a fresh new look by adding color to the command line with ANSI escape sequences.

  • Command Line: Bash Prompt

    Color-coding your prompt may help avoid configuration errors and data loss. We’ll show you how to design your own custom shell prompt with color and control sequences.

  • Command Line: sort

    sort helps you organize file lists and program

    output. And if you like, you can even use this small

    but powerful tool to merge and sort multiple files.

  • Fish Shell

    The Fish shell offers some user-friendly features for command line beginners.

comments powered by Disqus

Direct Download

Read full article as PDF:

Creating_Manpages_with_groff.pdf (235.32 kB)

News

njobs Europe
What:
Where:
Country:
Njobs Netherlands Njobs Deutschland Njobs United Kingdom Njobs Italia Njobs France Njobs Espana Njobs Poland
Njobs Austria Njobs Denmark Njobs Belgium Njobs Czech Republic Njobs Mexico Njobs India Njobs Colombia