1 .TH GROFF_FILENAMES @MAN5EXT@ "@MDATE@" "groff @VERSION@"
3 groff_filenames \- filename extensions for roff and groff
6 .\" ====================================================================
8 .\" ====================================================================
10 .\" Copyright (C) 2013-2018 Free Software Foundation, Inc.
12 .\" This file is part of groff, a free software project. You can
13 .\" redistribute it and/or modify it under the terms of the GNU General
14 .\" Public License version 2 (GPL2) as published by the Free Software
17 .\" The license text can be found in the internet at
18 .\" <http://www.gnu.org/licenses>.
21 .\" ====================================================================
23 .\" ====================================================================
25 Since the evolution of
27 in the 1970s, a whole bunch of filename extensions for
35 extensions refer to preprocessors or macro packages.
37 These extensions are fixed in all
45 added some more extensions.
49 is about these filename extensions.
52 .\" ====================================================================
53 .SH COMPRESSION OF ROFF FILES
54 .\" ====================================================================
58 file can be optionally
64 .IR "compressor name" .
66 So the whole filename has the structure
67 .IR <name> . <extension>[ . <compression>] .
72 .I compressor extensions
83 From now on, we will ignore the
85 and only comment the structure
86 .IB <name> . <extension>\fR.\fP
89 .\" ====================================================================
91 .\" ====================================================================
100 style is the best known part of the
108 should be better documented.
110 So this is documented here.
116 language use the following extension:
117 .BI *. <section>[<group>] \fR.\fP
120 .\" ====================================================================
121 .SS Man page Sections
122 .\" ====================================================================
125 .I man page <section>
153 .\" NOTE: There was once a feeble attempt in this direction, but it
154 .\" hasn't been true in any sense for a long time.
155 .\"Linux added the section number
157 .\"for kernel man pages.
169 systems, the 3 characters
180 but there are still documents in this format.
190 man page sections, which stood for \[lq]local\[rq], \[lq]new\[rq], and
191 \[lq]old\[rq], respectively.
194 .\" ====================================================================
195 .SS Man page Group Extensions
196 .\" ====================================================================
201 .BI . <section>[<group>]
202 is optional, but it can be any string of word characters.
204 Usually programmers use a group name that is already used, e.g.\&
212 programming language.
232 is the man page for the program
250 library configuration files from
259 .B dpkg\-reconfigure.8cdebconf
260 man page for the program
270 .\" ====================================================================
271 .SS Source of man pages
272 .\" ====================================================================
276 languages for writing man pages:
283 The names of these 2 styles are taken as
285 for the source code files of man pages in the
293 Unix-like man page format within groff source files.
298 A temporary man page file produced from a
309 Man page format in BSD.
315 .IR "heirloom roff ".
320 Files using this extension recognize both man page formats in
322 and other processors.
325 .\" ====================================================================
326 .SH TRADITIONAL TROFF EXTENSIONS
327 .\" ====================================================================
329 .\" ====================================================================
330 .SS Files Using Macro Packages
331 .\" ====================================================================
335 languages were interpreted by the traditional
345 languages, each represented by a
346 .IR "macro-package" .
348 Each of these provided a suitable file name
357 .IR "macro package" .
377 All of these classical
379 languages and their extensions are still very active in
383 .\" ====================================================================
384 .SS Source Code for Macro Packages (TMAC Files)
385 .\" ====================================================================
389 the source code for the macro packages was stored in
393 Their file names have the form:
397 .BI tmac. <package> \fR,\fP
399 is the name of the macro package without the leading
401 character, which is reintegrated by the option
408 is the source for the
416 source, more suitable file names were integrated, see later on.
419 .\" ====================================================================
421 .\" ====================================================================
423 Moreover, the following
425 were used as filename extension:
430 for the integration of chemical formulas
435 for the mathematical use of equations
456 .\" ====================================================================
457 .SS Classical Roff Files
458 .\" ====================================================================
469 .\" ====================================================================
470 .SH NEW GROFF EXTENSIONS
471 .\" ====================================================================
477 standard, both for classical
481 So even the used new extensions in the source code should be regarded
484 The following extensions are used instead of classical
494 general ending for files using the
498 .\" ====================================================================
499 .SS Source Code for Macro Packages (TMAC Files)
500 .\" ====================================================================
502 As the classical form
503 .BI tmac. <package_without_m> \fR,\fP
506 file names is quite strange,
509 added the following structures:
513 .IB <package_without_m> .tmac
515 .BI m <package> .tmac
517 .BI groff_m <package> .tmac
520 .\" ====================================================================
521 .SS Files Using new Macro Packages
522 .\" ====================================================================
525 uses the following new macro packages:
540 .I "groff macro package"
552 .\" ====================================================================
553 .SS Preprocessors and Postprocessors
554 .\" ====================================================================
558 Heidelberger tables, an alternative to the preprocessor
562 .BR groff_hdtbl (@MAN7EXT@).
567 files written for the graphical
575 .BR gremlin (@MAN1EXT@),
582 transform this file with
589 .\" ====================================================================
591 .\" ====================================================================
592 This document was written by
593 .MT groff\-bernd.warken\-72@\:web.de
598 .\" ====================================================================
600 .\" ====================================================================
605 .BR roff (@MAN7EXT@),
606 .BR man\-pages (@MAN7EXT@),
607 .BR groff_diff (@MAN7EXT@),
608 .BR groff (@MAN7EXT@)
613 .BR uncompress (1posix),
614 .BR gzip2 (@MAN1EXT@),
615 .BR bzip2 (@MAN1EXT@),
620 A man page of the naming form
622 can be read in text mode by
628 or in graphical mode (PDF) by
631 .BI groffer " n name"
637 .UR https://\:github.com/\:n\-t\-roff/\:heirloom\-doctools
638 .I Gunnar Ritter's Heirloom roff project
641 You can get this package with the shell command:
644 \(Do \fBgit clone https://github.com/n\-t\-roff/heirloom\-doctools\fP
649 .\" ====================================================================
651 .\" ====================================================================
656 .\" vim: set filetype=groff: