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
-
ONLYOFFICE v9 Embraces AI
Like nearly all office suites on the market (except LibreOffice), ONLYOFFICE has decided to go the AI route.
-
Two Local Privilege Escalation Flaws Discovered in Linux
Qualys researchers have discovered two local privilege escalation vulnerabilities that allow hackers to gain root privileges on major Linux distributions.
-
New TUXEDO InfinityBook Pro Powered by AMD Ryzen AI 300
The TUXEDO InfinityBook Pro 14 Gen10 offers serious power that is ready for your business, development, or entertainment needs.
-
Danish Ministry of Digital Affairs Transitions to Linux
Another major organization has decided to kick Microsoft Windows and Office to the curb in favor of Linux.
-
Linux Mint 20 Reaches EOL
With Linux Mint 20 at its end of life, the time has arrived to upgrade to Linux Mint 22.
-
TuxCare Announces Support for AlmaLinux 9.2
Thanks to TuxCare, AlmaLinux 9.2 (and soon version 9.6) now enjoys years of ongoing patching and compliance.
-
Go-Based Botnet Attacking IoT Devices
Using an SSH credential brute-force attack, the Go-based PumaBot is exploiting IoT devices everywhere.
-
Plasma 6.5 Promises Better Memory Optimization
With the stable Plasma 6.4 on the horizon, KDE has a few new tricks up its sleeve for Plasma 6.5.
-
KaOS 2025.05 Officially Qt5 Free
If you're a fan of independent Linux distributions, the team behind KaOS is proud to announce the latest iteration that includes kernel 6.14 and KDE's Plasma 6.3.5.
-
Linux Kernel 6.15 Now Available
The latest Linux kernel is now available with several new features/improvements and the usual bug fixes.