diff options
author | G. Branden Robinson <g.branden.robinson@gmail.com> | 2022-09-01 12:51:41 -0500 |
---|---|---|
committer | G. Branden Robinson <g.branden.robinson@gmail.com> | 2022-09-02 18:22:51 -0500 |
commit | c0c0c0a86b7136dc52a7b5c4b1cef9cdbd9e1bb1 (patch) | |
tree | 43c3e067be3da7bf5ddf219b1acfece60ec9d8e8 /man/roff.7.man | |
parent | d875321806b1d36243aabf1f51c9f5ad0994c535 (diff) | |
download | groff-git-c0c0c0a86b7136dc52a7b5c4b1cef9cdbd9e1bb1.tar.gz |
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.
Diffstat (limited to 'man/roff.7.man')
-rw-r--r-- | man/roff.7.man | 101 |
1 files changed, 35 insertions, 66 deletions
diff --git a/man/roff.7.man b/man/roff.7.man index 4a23bc7d5..2aa1901d5 100644 --- a/man/roff.7.man +++ b/man/roff.7.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 -(man\~pages) -take the section number as a file name extension, -e.g., -the file name for this document is -.IR roff.7 , -i.e., it is kept in section\~7 -of the man pages. -. -. -.P -The classical macro packages take the package name as an extension, -e.g., -.RI file .me -for a document using the -.I me -macro package, -.RI file .mm -for -.IR mm , -.RI file .ms -for -.IR ms , -.RI file .pic -for -.I pic -files, -and so on. -. -. -.P -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 -documents, -though -.RI file .t -for \[lq]troff file\[rq] is seen now and then. -. -. -.P -File name extensions can be handy in conjunction with the -.MR less 1 -pager. -. -It provides the possibility to feed all input into a command-line pipe -that is specified in the shell environment variable -.IR LESSOPEN . -. -This process is not well documented, -so here is an example. -. -.RS -.P -.EX -LESSOPEN=\[aq]|lesspipe %s\[aq] -.EE -.RE +tools. . +.I roff +documents employing \[lq]full-service\[rq] macro packages +(see +.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 , +and +.IR .mom , +for instance. . -.P -where -.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 +suffix. . +For example, +the file name for this document is +.IR roff.7 . . -.P -See -.MR groff_filenames @MAN5EXT@ -for more on file name extensions. +Practice for +\[lq]raw\[rq] +.I roff +documents is less consistent; +they +are sometimes seen with a +.I .t +suffix. . . .\" BEGIN Keep parallel with groff.texi node "Input Conventions". @@ -2366,7 +2333,9 @@ Bernd Warken .ME , with the sections \[lq]Concepts\[rq], \[lq]History\[rq], -and \[lq]Input Conventions\[rq] +\[lq]File name conventions\[rq], +and +\[lq]Input conventions\[rq] mostly written by .MT g.branden\:.robinson@\:gmail\:.com G.\& Branden Robinson |