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
News
-
Red Hat Enterprise Linux 7.5 Released
The latest release is focused on hybrid cloud.
-
Microsoft Releases a Linux-Based OS
The company is building a new IoT environment powered by Linux.
-
Solomon Hykes Leaves Docker
In a surprise move, Solomon Hykes, the creator of Docker has left the company.
-
Red Hat Celebrates 25th Anniversary with a New Code Portal
The company announces a GitHub page with links to source code for all its projects
-
Gnome 3.28 Released
The latest GNOME rolls out with better contact management and new features for handling virtual machines.
-
Install Firefox in a Snap on Linux
Mozilla has picked the Snap package system to deliver its application to Linux users.
-
OpenStack Queens Released
The new release comes with new features for mission critical workloads.
-
Kali Linux Comes to Windows
The Kali Linux developers even managed to run full blown XFCE desktop via WSL.
-
Ubuntu to Start Collecting Some Data with Ubuntu 18.04
It will be an ‘opt-out’ feature.
-
CNCF Illuminates Serverless Vision
The Cloud Native Computing Foundation announces a paper describing their model for a serverless ecosystem.