[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[groff] 31/38: roff(7): Recast discussion of file extensions.

From: G. Branden Robinson
Subject: [groff] 31/38: roff(7): Recast discussion of file extensions.
Date: Fri, 2 Sep 2022 19:56:33 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit c0c0c0a86b7136dc52a7b5c4b1cef9cdbd9e1bb1
Author: G. Branden Robinson <>
AuthorDate: Thu Sep 1 12:51:41 2022 -0500

    roff(7): Recast discussion of file extensions.
    * Rename section: "File name extensions" -> "File naming conventions".
    * Drop discussion of LESSOPEN environment variable and lesspipe command.
    * Drop cross reference to groff_filenames(5).
    * Tighten wording.
 man/ | 101 ++++++++++++++++++++-------------------------------------
 1 file changed, 35 insertions(+), 66 deletions(-)

diff --git a/man/ b/man/
index 4a23bc7d5..2aa1901d5 100644
--- a/man/
+++ b/man/
@@ -1940,78 +1940,45 @@ and its value can be retrieved by the escape sequence
 .\" ====================================================================
-.SH "File name extensions"
+.SH "File naming conventions"
 .\" ====================================================================
-Manual pages
-take the section number as a file name extension,
-the file name for this document is
-.IR roff.7 ,
-i.e., it is kept in section\~7
-of the man pages.
-The classical macro packages take the package name as an extension,
-.RI file .me
-for a document using the
-.I me
-macro package,
-.RI file .mm
-.IR mm ,
-.RI file .ms
-.IR ms ,
-.RI file .pic
-.I pic
-and so on.
-There is no general naming scheme for
+The structure or content of a file name,
+beyond its location in the file system,
+is not significant to
 .I roff
-.RI file .t
-for \[lq]troff file\[rq] is seen now and then.
-File name extensions can be handy in conjunction with the
-.MR less 1
-It provides the possibility to feed all input into a command-line pipe
-that is specified in the shell environment variable
-This process is not well documented,
-so here is an example.
-LESSOPEN=\[aq]|lesspipe %s\[aq]
+.I roff
+documents employing \[lq]full-service\[rq] macro packages
+.MR groff_tmac @MAN5EXT@ )
+tend to be named with a suffix identifying the package;
+we thus see file names ending in
+.IR .man ,
+.IR .ms ,
+.IR .me ,
+.IR .mm ,
+.IR .mom ,
+for instance.
-.I lesspipe
-is either a system-supplied command or a shell script of your own.
+When installed,
+man pages tend to be named with the manual's section number as the
+For example,
+the file name for this document is
+.IR roff.7 .
-.MR groff_filenames @MAN5EXT@
-for more on file name extensions.
+Practice for
+.I roff
+documents is less consistent;
+are sometimes seen with a
+.I .t
 .\" BEGIN Keep parallel with groff.texi node "Input Conventions".
@@ -2366,7 +2333,9 @@ Bernd Warken
 .ME ,
 with the sections \[lq]Concepts\[rq],
-and \[lq]Input Conventions\[rq]
+\[lq]File name conventions\[rq],
+\[lq]Input conventions\[rq]
 mostly written by
 .MT g.branden\:.robinson@\:gmail\
 G.\& Branden Robinson

reply via email to

[Prev in Thread] Current Thread [Next in Thread]