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
-
Nextcloud Announces Raspberry Pi-Powered Home Cloud Box
Innovative system adds a hard drive and Ubuntu Core to the RPi for an IoT hub.
-
Linus Torvalds Confirms the Date of the First Linux Release
Linux is two weeks younger than we thought!
-
End of OpenOffice?
The Apache Software Foundation considers retiring OpenOffice
-
Adobe Gives New Life to NPAPI Plugin for Linux
Adobe won’t kill the plugin in 2017
-
LinuxCon North America Convenes in Toronto, Canada
Linux Foundation's big event celebrates the 25th anniversary of Linux
-
Linux Turns 25
Linux has evolved from “won’t be a professional” project to one of the most professional software projects in the history of computers.
-
Mirantis Joins Hands with SUSE To Offer RHEL Support; Red Hat Not Happy
Competitors get in the game with RHEL without Red Hat
-
Linux on Windows 10 Poses a Security Risk
Security researchers have already notified Microsoft; some fixes are available
-
Mirantis to Refactor OpenStack Fuel for Kubernetes
The company is collaborating with Google and Intel to use Kubernetes as an engine for Fuel
-
Canonical Joins Document Foundation Advisory Board
The upcoming release of LibreOffice will be available as a snap package