Creating Manpages with groff
A Call for New Manpages!
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.
Buy this article as PDF
(incl. VAT)
Buy Linux Magazine
US / Canada
UK / Australia
Subscribe to our Linux Newsletters
Find Linux and Open Source Jobs
Subscribe to our ADMIN Newsletters
Support Our Work
Linux Magazine content is made possible with support from readers like you. Please consider contributing when you’ve found an article to be beneficial.
News
-
USB4 Maintainer Leaves Intel
Michael Jamet, one of the primary maintainers of USB4 and Thunderbolt drivers, has left Intel, leaving a gaping hole for the Linux community to deal with.
-
Budgie 10.9.3 Now Available
The latest version of this elegant and configurable Linux desktop aligns with changes in Gnome 49.
-
KDE Linux Alpha Available for Daring Users
It's official, KDE Linux has arrived, but it's not quite ready for prime time.
-
AMD Initiates Graphics Driver Updates for Linux Kernel 6.18
This new AMD update focuses on power management, display handling, and hardware support for Radeon GPUs.
-
AerynOS Alpha Release Available
With a choice of several desktop environments, AerynOS 2025.08 is almost ready to be your next operating system.
-
AUR Repository Still Under DDoS Attack
Arch User Repository continues to be under a DDoS attack that has been going on for more than two weeks.
-
RingReaper Malware Poses Danger to Linux Systems
A new kind of malware exploits modern Linux kernels for I/O operations.
-
Happy Birthday, Linux
On August 25, Linux officially turns 34.
-
VirtualBox 7.2 Has Arrived
With early support for Linux kernel 6.17 and other new additions, VirtualBox 7.2 is a must-update for users.
-
Linux Mint 22.2 Beta Available for Testing
Some interesting new additions and improvements are coming to Linux Mint. Check out the Linux Mint 22.2 Beta to give it a test run.