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
-
GitHub Announces Open Source Friday Program
They encourage people to take time out and work on open source projects on Friday.
-
System76 Announces Their Own Distro, Pop!_OS
Pop!_OS is based on Ubuntu and uses the Gnome stack.
-
Linus Torvalds Talks About His Motivation
He never tires of working on the Linux kernel.
-
Debian 9 Stretches Its Wings
The new release of Debian has a very strong focus on security.
-
Trojan Turns Raspberry Pi into a Cryptocurrency Mining Device
Two trojans in the wild are targeting Linux machines.
-
Fedora 26 Beta Comes with New Features
The workstation comes with the latest Gnome desktop environment and support for many application build systems.
-
Raspberry Pi Foundation Merges with CoderDojo Foundation
The two foundations join forces to expand their efforts to reach young people.
-
Samba Security Hole Patched but Risk is Bigger
Millions of devices that use Samba Server are vulnerable to attacks.
-
Red Hat Announces OpenShift.io
Red Hat takes its IDE online.
-
Microsoft Bakes Linux into Windows Server
Microsoft is slowly becoming a Linux vendor.