From db9f5f918278ee3f1b069148ad60ee1dd13746cb Mon Sep 17 00:00:00 2001 From: Steffen Nurpmeso Date: Wed, 27 May 2015 14:49:32 +0200 Subject: [PATCH] Adapt man/ --- man/{ditroff.man => ditroff.7.in} | 74 ++---- man/{groff.man => l_roff.7.in} | 287 ++++++++++------------ man/{groff_char.man => l_roff_char.7.in} | 157 ++++++------ man/{groff_diff.man => l_roff_diff.7.in} | 299 ++++++++++------------- man/{groff_font.man => l_roff_font.5.in} | 55 +++-- man/{groff_out.man => l_roff_out.5.in} | 403 ++++++++++++------------------- man/{groff_tmac.man => l_roff_tmac.5.in} | 308 ++++++++++------------- man/{roff.man => roff.7.in} | 221 +++++++---------- 8 files changed, 736 insertions(+), 1068 deletions(-) rename man/{ditroff.man => ditroff.7.in} (64%) rename man/{groff.man => l_roff.7.in} (89%) rename man/{groff_char.man => l_roff_char.7.in} (88%) rename man/{groff_diff.man => l_roff_diff.7.in} (90%) rename man/{groff_font.man => l_roff_font.5.in} (92%) rename man/{groff_out.man => l_roff_out.5.in} (83%) rename man/{groff_tmac.man => l_roff_tmac.5.in} (75%) rename man/{roff.man => roff.7.in} (81%) diff --git a/man/ditroff.man b/man/ditroff.7.in similarity index 64% rename from man/ditroff.man rename to man/ditroff.7.in index 7f51f142..4802fe87 100644 --- a/man/ditroff.man +++ b/man/ditroff.7.in @@ -1,11 +1,10 @@ .ig -ditroff.man +@ ditroff.7 -This file is part of groff, the GNU roff type-setting system. +Copyright (c) 2014 Steffen (Daode) Nurpmeso . Copyright (C) 2001, 2002, 2004, 2007, 2008 Free Software Foundation, Inc. written by Bernd Warken -maintained by Werner Lemberg Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or @@ -13,25 +12,20 @@ any later version published by the Free Software Foundation; with the Invariant Sections being this .ig-section and AUTHORS, with no Front-Cover Texts, and with no Back-Cover Texts. -A copy of the Free Documentation License is included as a file called -FDL in the main directory of the groff source package. +You should have received a copy of the Free Documentation License +as part of the file COPYING; also located in the main directory of the +source package of this program. .. . -. -.\" -------------------------------------------------------------------- -.\" Title -.\" -------------------------------------------------------------------- -. -.TH DITROFF @MAN7EXT@ "@MDATE@" "Groff Version @VERSION@" -. +.TH DITROFF @MAN7EXT@ "@MDATE@" "@T_ROFF@ v@VERSION@" . .SH NAME ditroff \- classical device independent roff . . -.\" -------------------------------------------------------------------- +.\" .SH DESCRIPTION -.\" -------------------------------------------------------------------- +.\" . The name .I ditroff @@ -62,7 +56,7 @@ In 1979, Brian Kernighan rewrote troff to support more devices by creating an intermediate output format for troff that can be fed into postprocessor programs which actually do the printout on the device. . -Kernighan's version marks what is known as +Kernighan's version marks what is known as .I classical troff today. . @@ -81,7 +75,7 @@ troff. . The distinction between .I troff -and +and .I ditroff isn't necessary any longer, for each modern .I troff @@ -94,18 +88,16 @@ is used to denote .IR ditroff . . .P -The easiest way to use ditroff is the GNU roff system, -.IR groff . -The -.BR groff (@MAN1EXT@) -program is a wrapper around +The easiest way to use ditroff is +.BR @L_ROFF@ (@MAN1EXT@), +a wrapper around .I (di)troff that automatically handles postprocessing. . . -.\" -------------------------------------------------------------------- +.\" .SH "SEE ALSO" -.\" -------------------------------------------------------------------- +.\" . .TP .I [CSTR\~#54] @@ -137,24 +129,26 @@ Bell Labs CSTR\~#97 This document gives details on the history and concepts of roff. . .TP -.BR @g@troff (@MAN1EXT@) +.BR @L_TROFF@ (@MAN1EXT@) The actual implementation of .IR ditroff . . .TP -.BR groff (@MAN1EXT@) -The GNU roff program and pointers to all documentation around groff. +.BR @L_ROFF@ (@MAN1EXT@) +The @L_ROFF@ program and pointers to all documentation around @T_ROFF@. . .TP -.BR groff_out (@MAN5EXT@) -The groff version of the intermediate output language, the basis for +.BR @L_ROFF@_out (@MAN5EXT@) +The @T_ROFF@ version of the intermediate output language, the basis for multi-devicing. . . -.\" -------------------------------------------------------------------- +.\" .SH "AUTHORS" -.\" -------------------------------------------------------------------- +.\" . +Copyright (c) 2014 Steffen (Daode) Nurpmeso . + Copyright (C) 2001, 2002, 2004, 2007, 2008 Free Software Foundation, Inc. . .P @@ -168,24 +162,8 @@ GNU copyleft site .UE . . .P -This document is part of -.IR groff , -the GNU roff distribution. -. -It was written by +This document was written by .MT bwarken@\:mayn.de Bernd Warken -.ME -and is maintained by -.MT wl@\:gnu.org -Werner Lemberg .ME . -. -. -.\" -------------------------------------------------------------------- -.\" Emacs settings -.\" -------------------------------------------------------------------- -.\" -.\" Local Variables: -.\" mode: nroff -.\" End: +.\" s-ts-mode diff --git a/man/groff.man b/man/l_roff.7.in similarity index 89% rename from man/groff.man rename to man/l_roff.7.in index 7f4e0cf0..5f9f20f5 100644 --- a/man/groff.man +++ b/man/l_roff.7.in @@ -1,13 +1,11 @@ -'\" t .ig -groff.man +@ @L_ROFF@.7 -This file is part of groff, the GNU roff type-setting system. +Copyright (c) 2014 Steffen (Daode) Nurpmeso . -Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 +Copyright (C) 2000 - 2008 Free Software Foundation, Inc. written by Bernd Warken -maintained by Werner Lemberg Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or @@ -15,24 +13,25 @@ any later version published by the Free Software Foundation; with the Invariant Sections being this .ig-section and AUTHORS, with no Front-Cover Texts, and with no Back-Cover Texts. -A copy of the Free Documentation License is included as a file called -FDL in the main directory of the groff source package. +You should have received a copy of the Free Documentation License +as part of the file COPYING; also located in the main directory of the +source package of this program. .. . -.\" -------------------------------------------------------------------- +.\" .\" Setup -.\" -------------------------------------------------------------------- +.\" . -.do nr groff_C \n[.C] +.do nr roff_C \n[.C] .cp 0 . -.\" -------------------------------------------------------------------- +.\" .\" start of macro definitions . .de TPx . TP 10n .. -.\" --------------------------------------------------------------------- +.\" .\" .Text anything ... .\" .\" All arguments are printed as text. @@ -95,7 +94,7 @@ FDL in the main directory of the groff source package. . .\" --------- escape sequences --------- . -.\" --------------------------------------------------------------------- +.\" .\" .ESC name [arg] .\" .\" Synopsis of an escape sequence, optionally with argument @@ -107,7 +106,7 @@ FDL in the main directory of the groff source package. .de ESC . Text "\f[CB]\[rs]\\$1\,\f[I]\\$2\/\fR" .. -.\" --------------------------------------------------------------------- +.\" .\" .ESC[] name arg .\" .\" Synopsis for escape sequence with a bracketed long argument @@ -119,7 +118,7 @@ FDL in the main directory of the groff source package. .de ESC[] . Text "\f[CB]\[rs]\\$1\[lB]\f[]\f[I]\\$2\f[]\f[CB]\[rB]\f[]" .. -.\" --------------------------------------------------------------------- +.\" .\" .ESCq name arg .\" .\" Synopsis for escape sequence with a bracketed long argument @@ -131,7 +130,7 @@ FDL in the main directory of the groff source package. .de ESCq . Text "\f[CB]\[rs]\\$1\[cq]\f[]\f[I]\\$2\f[]\f[CB]\[cq]\f[]" .. -.\" --------------------------------------------------------------------- +.\" .\" .ESC? arg .\" .\" Synopsis for escape sequence with a bracketed long argument @@ -142,7 +141,7 @@ FDL in the main directory of the groff source package. .de ESC? . Text "\f[CB]\[rs]?\f[I]\\$1\f[CB]?\f[R]" .. -.\" --------------------------------------------------------------------- +.\" .\" .esc name [punct] .\" .\" Reference of an escape sequence (no args), possibly punctuation @@ -154,7 +153,7 @@ FDL in the main directory of the groff source package. .de esc . BR "\[rs]\\$1" \\$2 .. -.\" --------------------------------------------------------------------- +.\" .\" .escarg name arg [punct] .\" .\" Reference of an escape sequence (no args) @@ -167,7 +166,7 @@ FDL in the main directory of the groff source package. .de escarg . Text \f[B]\[rs]\\$1\f[]\f[I]\\$2\f[]\\$3 .. -.\" --------------------------------------------------------------------- +.\" .\" .esc[] name arg [punct] .\" .\" Reference for escape sequence with a bracketed long argument @@ -180,7 +179,7 @@ FDL in the main directory of the groff source package. . Text \f[B]\[rs]\\$1\[lB]\f[]\f[I]\\$2\f[]\f[B]\[rB]\f[]\\$3 .. . -.\" --------------------------------------------------------------------- +.\" .\" .escq name arg .\" .\" Reference for escape sequence with a bracketed long argument @@ -221,68 +220,58 @@ FDL in the main directory of the groff source package. .\" end of macro definitions . . -.\" -------------------------------------------------------------------- +.\" .\" Title -.\" -------------------------------------------------------------------- +.\" . -.TH GROFF @MAN7EXT@ "@MDATE@" "Groff Version @VERSION@" +.TH @U_ROFF@ @MAN7EXT@ "@MDATE@" "@T_ROFF@ v@VERSION@" .SH NAME -groff \- a short reference for the GNU roff language +@L_ROFF@ \- a short reference for the roff language . . -.\" -------------------------------------------------------------------- +.\" .SH DESCRIPTION -.\" -------------------------------------------------------------------- +.\" . -The name -.I groff -stands for -.I GNU roff -and is the free implementation of the roff type-setting system. +.I @T_ROFF@ +is a free implementation of the roff type-setting system. . See .BR roff (@MAN7EXT@) -for a survey and the background of the groff system. +for a survey and the background of the @T_ROFF@ system. . .P This document gives only short descriptions of the predefined roff -language elements as used in groff. +language elements as used in @L_ROFF@. . -Both the classical features and the groff extensions are provided. +Classical features, GNU troff and @T_ROFF@ extensions are provided. . .P Historically, the .I roff language was called .IR troff . -.I groff +.I @L_ROFF@ is compatible with the classical system and provides proper extensions. . -So in GNU, the terms +The terms .IR roff , .IR troff , and -.I groff language -could be used as synonyms. +.I @T_ROFF@ +language could be used as synonyms. . However .I troff slightly tends to refer more to the classical aspects, whereas -.I groff -emphasizes the GNU extensions, and +.I @T_ROFF@ +emphasizes the extensions, and .I roff is the general term for the language. . .P -This file is only a short version of the complete documentation that -is found in the -.I groff -.BR info (1) -file, which contains more detailed, actual, and concise information. -. -.P -The general syntax for writing groff documents is relatively easy, but +The general syntax for writing roff documents is relatively easy, but writing extensions to the roff language can be a bit harder. . .P @@ -367,17 +356,17 @@ Begin all text lines with the special non-spacing character This does not produce the most efficient code, but it should work as a first measure. . -For better strategies, see the groff info file and -.BR groff_tmac (@MAN5EXT@). +Predefined macro packages may give a better user experience: see +.BR @L_ROFF@_tmac (@MAN5EXT@). . .P Reading roff source files is easier, just reduce all double backslashes to a single one in all macro definitions. . . -.\" -------------------------------------------------------------------- -.SH "GROFF ELEMENTS" -.\" -------------------------------------------------------------------- +.\" +.SH "ROFF ELEMENTS" +.\" . The roff language elements add formatting information to a text file. . @@ -406,14 +395,14 @@ These commands are called .BR macros , but they are used exactly like requests. . -Macro packages are pre-defined sets of macros written in the groff +Macro packages are pre-defined sets of macros written in the roff language. . A user's possibilities to create escape sequences herself is very limited, only special characters can be mapped. . .P -The groff language provides several kinds of variables with +The roff language provides several kinds of variables with different interfaces. . There are pre-defined variables, but the user can define her own @@ -489,7 +478,7 @@ On text devices, all glyphs have a constant width anyway. .B Glyphs are visual representation forms of .BR characters . -In groff, the distinction between those two elements is not always +In roff, the distinction between those two elements is not always obvious (and a full discussion is beyond the scope of this man page). . A first approximation is that glyphs have a specific size and @@ -517,14 +506,9 @@ or in a diversion or in the input. Some action can be prescribed to be run automatically when the condition is met. . -.P -More detailed information and examples can be found in the groff info -file. -. -. -.\" -------------------------------------------------------------------- +.\" .SH "CONTROL CHARACTERS" -.\" -------------------------------------------------------------------- +.\" . There is a small set of characters that have a special controlling task in certain conditions. @@ -544,7 +528,7 @@ The special behavior can be delayed by using the .esc . escape. . -By using the +By using the .request cc request, the control character can be set to a different character, making the dot @@ -566,7 +550,7 @@ non-breaking control character. That means that it introduces a request like the dot, but with the additional property that this request doesn't cause a linebreak. . -By using the +By using the .request c2 request, the non-break control character can be set to a different character. @@ -579,7 +563,7 @@ of the argument do work). In all other positions, it denotes the single quote or apostrophe character. . -Groff provides a printable representation with the +Roff provides a printable representation with the .esc (cq escape sequence. . @@ -602,7 +586,7 @@ introduces a comment. . Otherwise, it is not special. . -Groff provides a printable representation with the +Roff provides a printable representation with the .esc (dq escape sequence. . @@ -623,16 +607,16 @@ The open parenthesis is only special in escape sequences when introducing an escape name or argument consisting of exactly two characters. . -In groff, this behavior can be replaced by the \f[CB][]\f[] construct. +In @T_ROFF@, this behavior can be replaced by the \f[CB][]\f[] construct. .TP \&\f[CB][\f[] -The opening bracket is only special in groff escape sequences; there +The opening bracket is only special in roff escape sequences; there it is used to introduce a long escape name or long escape argument. . Otherwise, it is non-special, e.g.\& in macro calls. .TP \&\f[CB]]\f[] -The closing bracket is only special in groff escape sequences; there +The closing bracket is only special in roff escape sequences; there it terminates a long escape name or long escape argument. . Otherwise, it is non-special. @@ -643,7 +627,7 @@ Space characters are only functional characters. They separate the arguments in requests, macros, and strings, and the words in text lines. . -They are subject to groff's horizontal spacing calculations. +They are subject to roff's horizontal spacing calculations. . To get a defined space width, escape sequences like .squoted_char "\[rs]\ " @@ -668,9 +652,9 @@ horizontal jump to the next pre-defined tab position. There is a sophisticated interface for handling tab positions. . . -.\" -------------------------------------------------------------------- +.\" .SH "NUMERICAL EXPRESSIONS" -.\" -------------------------------------------------------------------- +.\" . A .B numerical value @@ -819,8 +803,8 @@ Close current grouping . .P Moreover, -.I groff -added the following operators for numerical expressions: +.I @T_ROFF@ +adds the following operators for numerical expressions: . .P .PD 0 @@ -851,13 +835,9 @@ as the default scaling indicator. .RE .PD . -.P -For details see the groff info file. -. -. -.\" -------------------------------------------------------------------- +.\" .SH CONDITIONS -.\" -------------------------------------------------------------------- +.\" . .B Conditions occur in tests raised by the @@ -953,13 +933,13 @@ has been registered. .PD . . -.\" -------------------------------------------------------------------- +.\" .SH REQUESTS -.\" -------------------------------------------------------------------- +.\" . This section provides a short reference for the predefined requests. . -In groff, request, macro, and string names can be arbitrarily long. +In @T_ROFF@, request, macro, and string names can be arbitrarily long. . No bracketing or marking of long names is needed. . @@ -974,8 +954,8 @@ Some requests have optional arguments with a different behaviour. . Not all of these details are outlined here. . -Refer to the groff info file and -.BR groff_diff (@MAN7EXT@) +Refer to +.BR @L_ROFF@_diff (@MAN7EXT@) for all details. . .P @@ -1040,9 +1020,9 @@ To assign a negative number either prepend\~0 or enclose the negative number in parentheses. . . -.\" -------------------------------------------------------------------- +.\" .SS "Request Short Reference" -.\" -------------------------------------------------------------------- +.\" . .PD 0 . @@ -2519,7 +2499,7 @@ to the stream named .PD . .P -Besides these standard groff requests, there might be further macro +Besides these standard roff requests, there might be further macro calls. They can originate from a macro package (see .BR roff (@MAN7EXT@) @@ -2548,9 +2528,9 @@ tbl@.TS@.TE .P . . -.\" -------------------------------------------------------------------- +.\" .SH "ESCAPE SEQUENCES" -.\" -------------------------------------------------------------------- +.\" . Escape sequences are in-line language elements usually introduced by a backslash @@ -2566,7 +2546,7 @@ end of the argument. .P This is done by enclosing names (escape name and arguments consisting of a variable name) by a pair of brackets -.BI \[lB] name \[rB] +.BI \[lB] name \[rB] and constant arguments (number expressions and characters) by apostrophes (ASCII 0x27) like .BI \[cq] constant \[cq] \f[R]. @@ -2606,9 +2586,9 @@ Escapes sequences of the form denote glyphs too. . . -.\" -------------------------------------------------------------------- +.\" .SS "Single-Character Escapes" -.\" -------------------------------------------------------------------- +.\" . .PD 0 . @@ -2899,8 +2879,7 @@ Forward (down) 1/2 em (1/2 line in nroff). .TP .ESCq D charseq Draw a graphical element defined by the characters in -.IR charseq ; -see the groff info file for details. +.IR charseq . . .TP .ESC e @@ -3273,9 +3252,9 @@ defined escape sequence, the backslash is silently ignored and the character maps to itself. . . -.\" -------------------------------------------------------------------- +.\" .SS "Special Characters" -.\" -------------------------------------------------------------------- +.\" . [Note: `Special Characters' is a misnomer; those entities are (output) glyphs, not (input) characters.] @@ -3294,7 +3273,7 @@ available in the special font. . Below you can find a selection of the most important glyphs; a complete list can be found in -.BR groff_char (@MAN7EXT@). +.BR @L_ROFF@_char (@MAN7EXT@). .RS .P .PD 0 @@ -3363,9 +3342,9 @@ Plus-minus sign .RE . . -.\" -------------------------------------------------------------------- +.\" .SS "Strings" -.\" -------------------------------------------------------------------- +.\" . Strings are defined by the .request ds @@ -3380,7 +3359,7 @@ So strings and macros without arguments are roughly equivalent; it is possible to call a string like a macro and vice-versa, but this often leads to unpredictable results. . -The following string is the only one predefined in groff. +The following string is the only one predefined in @T_ROFF@. . .TPx .STRING .T @@ -3389,12 +3368,12 @@ The name of the current output device as specified by the command line option. . . -.\" -------------------------------------------------------------------- +.\" .SH REGISTERS -.\" -------------------------------------------------------------------- +.\" . Registers are variables that store a value. -In groff, most registers store numerical values (see section +In @T_ROFF@, most registers store numerical values (see section .B NUMERICAL EXPRESSIONS above), but some can also hold a string value. . @@ -3423,9 +3402,9 @@ Please keep in mind that the decoration is not part of the register name. . . -.\" -------------------------------------------------------------------- +.\" .SS "Read-only Registers" -.\" -------------------------------------------------------------------- +.\" . The following registers have predefined values that should not be modified by the user (usually, registers starting with a dot a @@ -3524,9 +3503,9 @@ The number of the next free font position. . .TPx .REG .g -Always 1 in GNU troff. +Always 1 in GNU troff and @T_ROFF@. . -Macros should use it to test if running under groff. +Macros should use it to test if running under @T_ROFF@. . .TPx .REG .h @@ -3777,7 +3756,7 @@ The minor version number. . .TPx .REG .Y -The revision number of groff. +The revision number of @T_ROFF@. . .TPx .REG .z @@ -3790,9 +3769,9 @@ magnification). .PD . . -.\" -------------------------------------------------------------------- +.\" .SS "Writable Registers" -.\" -------------------------------------------------------------------- +.\" . The following registers can be read and written by the user. They have predefined default values, but these can be modified for @@ -3952,39 +3931,39 @@ instead. .PD . . -.\" -------------------------------------------------------------------- +.\" .SH COMPATIBILITY -.\" -------------------------------------------------------------------- +.\" . -The differences of the groff language in comparison to classical troff -as defined by +The differences of the @T_ROFF@ language in comparison to classical +troff as defined by .I [CSTR\~#54] are documented in -.BR groff_diff (@MAN7EXT@). +.BR @L_ROFF@_diff (@MAN7EXT@). . .P -The groff system provides a compatibility mode, see -.BR groff (@MAN1EXT@) +The @T_ROFF@ system provides a compatibility mode, see +.BR @L_ROFF@ (@MAN1EXT@) on how to invoke this. . . -.\" -------------------------------------------------------------------- +.\" .SH BUGS -.\" -------------------------------------------------------------------- +.\" . -Report bugs to the -.MT bug-groff@gnu.org -groff bug mailing list +Report bugs to +.MT @BUGMAIL@ .ME . Include a complete, self-contained example that will allow the bug to be reproduced, and say which version of groff you are using. . -. -.\" -------------------------------------------------------------------- +.\" .SH AUTHORS -.\" -------------------------------------------------------------------- +.\" . -Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 +Copyright (c) 2014 Steffen (Daode) Nurpmeso . + +Copyright (C) 2000 - 2008 Free Software Foundation, Inc. . .P @@ -3998,50 +3977,33 @@ GNU copyleft site .UE . . .P -This document is part of -.IR groff , -the GNU roff distribution. -. -It was written by +This document was written by .MT bwarken@mayn.de Bernd Warken -.ME ; -it is maintained by -.MT wl@gnu.org -Werner Lemberg .ME . . -. -.\" -------------------------------------------------------------------- +.\" .SH "SEE ALSO" -.\" -------------------------------------------------------------------- -. -.P -The main source of information for the groff language is the -.B groff -.BR info (1) -file. -. -Besides the gory details, it contains many examples. +.\" . .TP -.BR groff (@MAN1EXT@) -the usage of the groff program and pointers to the documentation and -availability of the groff system. +.BR @L_ROFF@ (@MAN1EXT@) +the usage of the @L_ROFF@ program and pointers to the documentation +and availability of the @T_ROFF@ system. . .TP -.BR groff_diff (@MAN7EXT@) -the differences of the groff language as compared to classical roff. +.BR @L_ROFF@_diff (@MAN7EXT@) +the differences of the @T_ROFF@ language as compared to classical roff. . This is the authoritative document for the predefined language -elements that are specific to groff. +elements that are specific to @T_ROFF@. . .TP -.BR groff_char (@MAN7EXT@) -the predefined groff special characters (glyphs). +.BR @L_ROFF@_char (@MAN7EXT@) +the predefined @T_ROFF@ special characters (glyphs). . .TP -.BR groff_font (@MAN5EXT@) +.BR @L_ROFF@_font (@MAN5EXT@) the specification of fonts and the DESC file. . .TP @@ -4056,12 +4018,5 @@ Nroff/\:Troff User's Manual by Ossanna & Kernighan .UE \[em] the bible for classical troff. . -.cp \n[groff_C] -. -.\" -------------------------------------------------------------------- -.\" Emacs Setup -.\" -------------------------------------------------------------------- -. -.\" Local Variables: -.\" mode: nroff -.\" End: +.cp \n[roff_C] +.\" s-ts-mode diff --git a/man/groff_char.man b/man/l_roff_char.7.in similarity index 88% rename from man/groff_char.man rename to man/l_roff_char.7.in index cfddcd7d..7759ab99 100644 --- a/man/groff_char.man +++ b/man/l_roff_char.7.in @@ -1,24 +1,9 @@ -.TH GROFF_CHAR @MAN7EXT@ "@MDATE@" "Groff Version @VERSION@" -.SH NAME -groff_char \- groff glyph names -.SH DESCRIPTION -.\" The lines above were designed to satisfy `apropos'. -. -.\" For best results, format this document with `groff' (GNU roff). -. -. -.\" -------------------------------------------------------------------- -.\" Legal terms -.\" -------------------------------------------------------------------- -. .ig -groff_char(7) - -This file is part of groff (GNU roff). +@ @L_ROFF@_char.7 -File position: /man/groff_char.man +Copyright (c) 2014 Steffen (Daode) Nurpmeso . -Copyright (C) 1989-2000, 2001, 2002, 2003, 2004, 2006, 2007, 2008 +Copyright (C) 1989 - 2004, 2006, 2007, 2008 Free Software Foundation, Inc. written by Werner Lemberg with additions by Bernd Warken @@ -29,15 +14,21 @@ any later version published by the Free Software Foundation; with the Invariant Sections being this .ig-section and AUTHOR, with no Front-Cover Texts, and with no Back-Cover Texts. -A copy of the Free Documentation License is included as a file called -FDL in the main directory of the groff source package. +You should have received a copy of the Free Documentation License +as part of the file COPYING; also located in the main directory of the +source package of this program. .. . -.\" -------------------------------------------------------------------- +.TH @U_ROFF@_CHAR @MAN7EXT@ "@MDATE@" "@T_ROFF@ v@VERSION@" +.SH NAME +@L_ROFF@_char \- @T_ROFF@ glyph names +.SH DESCRIPTION +. +.\" .\" Setup Part 1 -.\" -------------------------------------------------------------------- +.\" . -.do nr groff_char_C \n[.C] +.do nr roff_char_C \n[.C] .cp 0 . .\" groff only @@ -73,7 +64,7 @@ FDL in the main directory of the groff source package. . ig .. . -.\" -------------------------------------------------------------------- +.\" .\" .Ac accented-char accent char (groff) . .if !\n(.g .ig @@ -95,13 +86,13 @@ FDL in the main directory of the groff source package. . \} .. . -.\" -------------------------------------------------------------------- +.\" .\" Setup Part 2 -.\" -------------------------------------------------------------------- +.\" . .nr Sp 2n . -.\" -------------------------------------------------------------------- +.\" .\" .C2/.CN (groff) . .if !\n(.g .ig @@ -132,7 +123,7 @@ FDL in the main directory of the groff source package. . als 2e Ne .\} . -.\" -------------------------------------------------------------------- +.\" .\" .C2 (non-groff) . .if \n(.g .ig @@ -157,7 +148,7 @@ FDL in the main directory of the groff source package. . C2 "\\$1" "\\$2" "\\$3" "\\$4" .. . -.\" -------------------------------------------------------------------- +.\" .\" .CD (groff) . .if !\n(.g .ig @@ -182,7 +173,7 @@ FDL in the main directory of the groff source package. . CD "\\$1" "\\$2" "\\$3" "\\$4" .. . -.\" -------------------------------------------------------------------- +.\" . .do if !r ECFONTS .do fspecial CR R . @@ -218,7 +209,7 @@ FDL in the main directory of the groff source package. . br .. . -.\" -------------------------------------------------------------------- +.\" .\" input-name decimal-code output-name ps-name unicode description is-char .\" .C (groff) . @@ -283,7 +274,7 @@ FDL in the main directory of the groff source package. . sp |\\n[C2]u .. . -.\" -------------------------------------------------------------------- +.\" .\" .C (non-groff) . .if \n(.g .ig @@ -336,7 +327,7 @@ FDL in the main directory of the groff source package. . sp |\\n(C2u .. . -.\" -------------------------------------------------------------------- +.\" . .de Fo ' bp @@ -349,13 +340,12 @@ FDL in the main directory of the groff source package. .. . . -. -.\" -------------------------------------------------------------------- +.\" .\" .SH DESCRIPTION -.\" -------------------------------------------------------------------- +.\" . This manual page lists the standard -.B groff +.B @T_ROFF@ glyph names and the default input mapping, \%latin1. . The glyphs in this document look different depending @@ -372,8 +362,8 @@ is being used to print or view this manual page are marked with . . .P -In the actual version, -.B groff +In the actual version, +.B @T_ROFF@ provides only \%8-bit characters for direct input and named entities for further glyphs. . @@ -388,7 +378,7 @@ This mapping is contained in the file \f(CWlatin1.tmac\fP and can be changed by loading a different input encoding. . Note that some of the input characters are reserved by -.BR groff , +.BR @T_ROFF@ , either for internal use or for special input purposes. . On EBCDIC platforms, only code page @@ -403,33 +393,32 @@ Again, some input characters are reserved for internal and special purposes. All roff systems provide the concept of named glyphs. . In traditional roff systems, only names of length\ 2 were used, while -groff also provides support for longer names. +@T_ROFF@ also provides support for longer names. . It is strongly suggested that only named glyphs are used for all character representations outside of the printable \%7-bit ASCII range. . . .P -Some of the predefined groff escape sequences (with names of length\ 1) +Some of the predefined @T_ROFF@ escape sequences (with names of length\ 1) also produce single glyphs; these exist for historical reasons or are printable versions of syntactical characters. . They include `\f(CW\e\e\fP', `\f(CW\e\'\fP', `\f(CW\e`\fP', `\f(CW\e-\fP', `\f(CW\e.\fP', and `\f(CW\ee\fP'; see -.BR groff (@MAN7EXT@). +.BR @L_ROFF@ (@MAN7EXT@). . . .P -In groff, all of these different types of characters and glyphs can be +In @T_ROFF@, all of these different types of characters and glyphs can be tested positively with the `\f(CW.if\ c\fP' conditional. . . -.\" -------------------------------------------------------------------- +.\" .SH REFERENCE -.\" -------------------------------------------------------------------- +.\" . -In this section, the glyphs in groff are specified in tabular -form. +In this section, the glyphs are specified in tabular form. . The meaning of the columns is as follows. . @@ -444,7 +433,7 @@ represents the same glyph. .TP .I "Input name" specifies how the glyph is input either directly by a key on the -keyboard, or by a groff escape sequence. +keyboard, or by a roff escape sequence. . . .TP @@ -467,9 +456,9 @@ is the glyph name used in composite glyph names. . . . -.\" -------------------------------------------------------------------- +.\" .SS "7-bit Character Codes 32-126" -.\" -------------------------------------------------------------------- +.\" . These are the basic glyphs having 7-bit ASCII code values assigned. . @@ -486,7 +475,7 @@ Note that input characters in the range \%0\-31 and character 127 are printable characters. . Most of them are invalid input characters for -.B groff +.B @T_ROFF@ anyway, and the valid ones have special meaning. . For EBCDIC, the printable characters are in the range \%66\-255. @@ -588,9 +577,9 @@ usable as a diacritic; a larger glyph can be obtained with `\f(CW\e(ha\fP'. .De 126 tilde u007E "tilde accent" . . -.\" -------------------------------------------------------------------- +.\" .SS "8-bit Character Codes 160 to 255" -.\" -------------------------------------------------------------------- +.\" . They are interpreted as printable characters according to the .I latin1 @@ -617,7 +606,7 @@ is mapped to `\f(CW\e~\fP', the stretchable space character. . the soft hyphen control character. . -.B groff +.B @T_ROFF@ never uses this character for output (thus it is omitted in the table below); the input character\ 173 is mapped onto `\f(CW\e%\fP'. . @@ -729,14 +718,14 @@ see next section. .De 255 ydieresis u0079_0308 . . -.\" -------------------------------------------------------------------- +.\" .SS "Named Glyphs" -.\" -------------------------------------------------------------------- +.\" . Glyph names can be embedded into the document text by using escape sequences. . -.BR groff (@MAN7EXT@) +.BR @L_ROFF@ (@MAN7EXT@) describes how these escape sequences look. . Glyph names can consist of quite arbitrary characters from the @@ -759,7 +748,7 @@ Note that `\fIc\fP' is not the same as `\f(CW\e[\fP\fIc\fP\f(CW]\fP' (\fIc\fP\ a single character): The latter is internally mapped to glyph name `\e\fIc\fP'. . -By default, groff defines a single glyph name starting with a backslash, +By default, @T_ROFF@ defines a single glyph name starting with a backslash, namely \%`\e-', which can be either accessed as `\f(CW\e\-\fP' or `\f(CW\e[-]\fP'. . @@ -769,7 +758,7 @@ A composite glyph; see below for a more detailed description. . . .P -In groff, each \%8-bit input character can also referred to by the construct +In @T_ROFF@, each \%8-bit input character can also referred to by the construct `\f(CW\e[char\fP\fIn\fP\f(CW]\fP' where .I n is the decimal code of the character, a number between 0 and\ 255 @@ -783,7 +772,7 @@ Another special convention is the handling of glyphs with names directly derived from a Unicode code point; this is discussed below. . Moreover, new glyph names can be created by the \f(CW.char\fP request; see -.BR groff (@MAN7EXT@). +.BR @L_ROFF@ (@MAN7EXT@). . .P In the following, a plus sign in the `Notes' column indicates that this @@ -1018,7 +1007,7 @@ For this reason, the four glyphs `lf', `rf', `lc', and `rc' are not unified with similarly looking bracket pieces. . In -.BR groff , +.BR @T_ROFF@ , only glyphs with long names are guaranteed to pile up correctly for all devices (provided those glyphs exist). . @@ -1133,7 +1122,7 @@ square root sign. .2s co copyright u00A9 "+" .C2 rg registered u00AE "+" .C2 tm trademark u2122 -.2e bs --- --- "AT&T Bell Labs logo (not used in groff) +" +.2e bs --- --- "AT&T Bell Labs logo (not used in @T_ROFF@) +" . .Pa .I Currency symbols @@ -1280,10 +1269,10 @@ this (incompatible) change in Unicode. At the time of this writing (January 2006), it is not clear yet whether the Adobe Glyph Names `phi' and `phi1' also change its meaning if used for mathematics, thus compatibility problems are likely to happen \(en being -conservative, groff currently assumes that `phi' in a PostScript symbol +conservative, @T_ROFF@ currently assumes that `phi' in a PostScript symbol font is the stroked version. .P -In groff, symbol `\f(CW\e[*f]\fP' always denotes the stroked version of +In @T_ROFF@, symbol `\f(CW\e[*f]\fP' always denotes the stroked version of phi, and `\f(CW\e[+f]\fP' the curly variant. .P .2s *A Alpha u0391 "+" @@ -1351,12 +1340,14 @@ phi, and `\f(CW\e[+f]\fP' the curly variant. .2e u2661 uni2661 u2661 "white diamond suit" . . -.\" -------------------------------------------------------------------- +.\" .SH "AUTHOR" -.\" -------------------------------------------------------------------- +.\" . -Copyright \(co 1989-2000, 2001, 2002, 2003, -2004, 2006, 2008 Free Software Foundation, Inc. +Copyright (c) 2014 Steffen (Daode) Nurpmeso . + +Copyright \(co 1989 - 2000, 2001 - 2004, 2006, 2008 + Free Software Foundation, Inc. . .P This document is distributed under the terms of the FDL (GNU Free @@ -1369,15 +1360,11 @@ GNU copyleft site .UE . . .P -This document is part of -.IR groff , -the GNU roff distribution. -. It was written by .MT jjc@jclark.com James Clark .ME -with additions by +with additions by .MT wl@gnu.org Werner Lemberg .ME @@ -1387,17 +1374,17 @@ Bernd Warken .ME . . . -.\" -------------------------------------------------------------------- +.\" .SH "SEE ALSO" -.\" -------------------------------------------------------------------- +.\" . .TP -.BR groff (@MAN1EXT@) -the GNU roff formatter +.BR @L_ROFF@ (@MAN1EXT@) +the @T_ROFF@ formatter . .TP -.BR groff (@MAN7EXT@) -a short reference of the groff formatting language +.BR @L_ROFF@ (@MAN7EXT@) +a short reference of the @T_ROFF@ formatting language . . .P @@ -1411,11 +1398,5 @@ No. 2, Summer 1989 The Unicode Standard .UE . -.cp \n[groff_char_C] -. -.\" -------------------------------------------------------------------- -.\" Emacs settings -.\" -------------------------------------------------------------------- -.\" Local Variables: -.\" mode: nroff -.\" End: +.cp \n[roff_char_C] +.\" s-ts-mode diff --git a/man/groff_diff.man b/man/l_roff_diff.7.in similarity index 90% rename from man/groff_diff.man rename to man/l_roff_diff.7.in index fb3121b8..1b84f420 100644 --- a/man/groff_diff.man +++ b/man/l_roff_diff.7.in @@ -1,12 +1,10 @@ -'\" e -.\" The above line should force the use of eqn as a preprocessor +'\" e -- preprocess: eqn(1) .ig -groff_diff.man +@ @L_ROFF@_diff.7 -This file is part of groff, the GNU roff type-setting system. -It is the source of the man-page groff_diff(7). +Copyright (c) 2014 Steffen (Daode) Nurpmeso . -Copyright (C) 1989, 2001, 2002, 2003, 2004, 2006, 2007, 2008 +Copyright (C) 1989, 2001 - 2004, 2006 - 2008 Free Software Foundation, Inc. written by James Clark @@ -19,14 +17,15 @@ any later version published by the Free Software Foundation; with the Invariant Sections being this .ig-section and AUTHORS, with no Front-Cover Texts, and with no Back-Cover Texts. -A copy of the Free Documentation License is included as a file called -FDL in the main directory of the groff source package. +You should have received a copy of the Free Documentation License +as part of the file COPYING; also located in the main directory of the +source package of this program. .. . . -.\" -------------------------------------------------------------------- +.\" .\" Local definitions -.\" -------------------------------------------------------------------- +.\" . .\" define a string tx for the TeX logo .ie t .ds tx T\h'-.1667m'\v'.224m'E\v'-.224m'\h'-.125m'X @@ -40,24 +39,22 @@ FDL in the main directory of the groff source package. . ds ic \^ . . -.\" -------------------------------------------------------------------- +.\" .\" Title -.\" -------------------------------------------------------------------- +.\" . -.TH GROFF_DIFF @MAN7EXT@ "@MDATE@" "Groff Version @VERSION@" +.TH @U_ROFF@_DIFF @MAN7EXT@ "@MDATE@" "@T_ROFF@ v@VERSION@" .SH NAME -groff_diff \- differences between GNU troff and classical troff +@L_ROFF@_diff \- differences between @T_ROFF@ and classical troff . . -.\" -------------------------------------------------------------------- +.\" .SH DESCRIPTION -.\" -------------------------------------------------------------------- +.\" . This manual page describes the language differences between -.IR groff , -the GNU -.I roff -text processing system, and the classical +.IR @T_ROFF@ , +and the classical .I roff formatter of the freely available Unix\~7 of the 1970s, documented in the @@ -74,25 +71,24 @@ The section .I SEE ALSO gives pointers to both the classical .I roff -and the modern -.I groff +and the +.I @T_ROFF@ documentation. . . -.\" -------------------------------------------------------------------- -.SH "GROFF LANGUAGE" -.\" -------------------------------------------------------------------- +.\" +.SH "@T_ROFF@ LANGUAGE" +.\" . -In this section, all additional features of -.I groff +In this section, all additional features compared to the classical Unix\~7 .I troff are described in detail. . . -.\" -------------------------------------------------------------------- +.\" .SS "Long names" -.\" -------------------------------------------------------------------- +.\" . The names of number registers, fonts, strings/\:macros/\:diversions, special characters (glyphs), and colors can be of any length. @@ -113,11 +109,10 @@ Print composite glyph consisting of multiple components. Example: `\[rs][A\~ho]' is capital letter A with ogonek which finally maps to glyph name `u0041_0328'. . -See the -.I groff info file -for details how a glyph name for a composite glyph is constructed, and -.BR groff_char (@MAN7EXT@) -for a list of glyph name components used in composite glyph names. +See +.BR @L_ROFF@_char (@MAN7EXT@) +for a list of glyph name components used in composite glyph names +and details of how a glyph name for a composite glyph is constructed. . .TP .BI \[rs]f[ xxx ] @@ -146,9 +141,9 @@ Interpolate number register .IR xxx . . . -.\" -------------------------------------------------------------------- +.\" .SS "Fractional point sizes" -.\" -------------------------------------------------------------------- +.\" . A .I scaled point @@ -236,9 +231,9 @@ and scale indicators. . . -.\" -------------------------------------------------------------------- +.\" .SS "Numeric expressions" -.\" -------------------------------------------------------------------- +.\" . Spaces are permitted in a number expression within parentheses. . @@ -281,9 +276,9 @@ is missing, ignore scaling indicators in the evaluation of\~\c .IR e . . . -.\" -------------------------------------------------------------------- +.\" .SS "New escape sequences" -.\" -------------------------------------------------------------------- +.\" . .TP .BI \[rs]A' anything ' @@ -450,7 +445,7 @@ The escapes and .B \[rs]O5 are intended for internal use by -.BR \%grohtml . +.BR \%@L_D_HTML@ . . .RS .TP @@ -496,7 +491,7 @@ At start-up, is at outer level. . This is really an internal mechanism for -.B \%grohtml +.B \%@L_D_HTML@ while producing images. . They are generated by running the troff source through @@ -517,7 +512,7 @@ End a nesting level. .TP .BI \[rs]O5[ Pfilename ] This escape is -.B \%grohtml +.B \%@L_D_HTML@ specific. . Provided that this escape occurs at the outer nesting level, write @@ -774,9 +769,9 @@ except that does not ignore the terminating newline. . . -.\" -------------------------------------------------------------------- +.\" .SS "New requests" -.\" -------------------------------------------------------------------- +.\" . .TP .BI .aln\ xx\ yy @@ -823,7 +818,7 @@ request; normally they modify the value of an existing object. .TP .BI .am1\ xx\ yy Similar to -.BR .am , +.BR .am , but compatibility mode is switched off during execution. . To be more precise, a `compatibility save' token is inserted at the @@ -859,7 +854,7 @@ request but compatibility mode is switched off during execution. .TP .BI .as1\ xx\ yy Similar to -.BR .as , +.BR .as , but compatibility mode is switched off during expansion. . To be more precise, a `compatibility save' token is inserted at the @@ -1031,7 +1026,7 @@ Define entity\~\c to be .IR string . . -To be more precise, define (or even override) a groff entity which +To be more precise, define (or even override) a roff entity which can be accessed with name\~\c .I c on the input side, and which uses @@ -1057,7 +1052,7 @@ this object rather than to individual glyphs in .IR string . . .IP -A groff object defined by this request can be used just like a +A roff object defined by this request can be used just like a normal glyph provided by the output device. . In particular other characters can be translated to it with the @@ -1214,7 +1209,7 @@ is not the same. .TP .BI .de1\ xx\ yy Similar to -.BR .de , +.BR .de , but compatibility mode is switched off during execution. . On entry, the current compatibility mode is saved and restored at exit. @@ -1304,7 +1299,7 @@ are interpreted. .TP .BI .ds1\ xx\ yy Similar to -.BR .ds , +.BR .ds , but compatibility mode is switched off during expansion. . To be more precise, a `compatibility save' token is inserted at the @@ -1597,7 +1592,7 @@ character as the start of a comment). Use the .B hpfcode request to map the encoding used in hyphenation patterns files to -.BR groff 's +.BR roff 's input encoding. .IP The set of hyphenation patterns is associated with the current language @@ -1641,9 +1636,8 @@ The arguments of .B hpfcode must be integers in the range 0 to\~255. . -Note that it is even possible to use character codes which are invalid in -.B groff -otherwise. +Note that it is even possible to use character codes which are otherwise +invalid. . .TP .BI .hym\ n @@ -1816,7 +1810,7 @@ and .B write requests. . -.TP +.TP .BI .opena\ stream\ filename Like .BR open , @@ -2355,7 +2349,7 @@ is the sum of the numbers associated with each warning that is to be enabled; all other warnings are disabled. . The number associated with each warning is listed in -.BR @g@troff (@MAN1EXT@). +.BR @L_TROFF@ (@MAN1EXT@). . For example, .B .warn\~0 @@ -2443,22 +2437,22 @@ request. is read in copy mode. . . -.\" -------------------------------------------------------------------- +.\" .SS "Extended escape sequences" -.\" -------------------------------------------------------------------- +.\" . .TP .BR \[rs]D' .\|.\|. ' -All drawing commands of groff's intermediate output are accepted. +All drawing commands of @L_ROFF@'s intermediate output are accepted. . See subsection .B "Drawing Commands" below for more information. . . -.\" -------------------------------------------------------------------- +.\" .SS "Extended requests" -.\" -------------------------------------------------------------------- +.\" . .TP .BI .cf\ filename @@ -2519,7 +2513,7 @@ one twelfth of the spacewidth parameter for the current font. Initially both the word space size and the sentence space size are\~12. . -Contrary to UNIX troff, GNU troff handles this request in nroff mode +Contrary to UNIX troff, @L_TROFF@ handles this request in nroff mode also; a given value is then rounded down to the nearest multiple of\~12. . @@ -2531,11 +2525,11 @@ two spaces follow the end of a sentence in the middle of a line, then the second space is a sentence space. . Note that the behaviour of UNIX troff are exactly that exhibited -by GNU troff if a second argument is never given to the +by @L_TROFF@ if a second argument is never given to the .B ss request. . -In GNU troff, as in UNIX troff, you should always follow a sentence +In @L_TROFF@, as in UNIX troff, you should always follow a sentence with either a newline or two spaces. . .TP @@ -2566,9 +2560,9 @@ sets tabs every half an inch. .RE . . -.\" -------------------------------------------------------------------- +.\" .SS "New number registers" -.\" -------------------------------------------------------------------- +.\" . The following read-only registers are available: . @@ -2661,8 +2655,8 @@ The number of the next free font position. .B \[rs]n[.g] Always\~1. . -Macros should use this to determine whether they are running under GNU -troff. +Macros should use this to determine whether they are running under +@L_TROFF@. . .TP .B \[rs]n[.height] @@ -2865,7 +2859,7 @@ The sum of the numbers associated with each of the currently enabled warnings. . The number associated with each warning is listed in -.BR @g@troff (@MAN1EXT@). +.BR @L_TROFF@ (@MAN1EXT@). . .TP .B \[rs]n[.x] @@ -2885,7 +2879,7 @@ contains\~03. . .TP .B \[rs]n[.Y] -The revision number of groff. +The revision number of @T_ROFF@. . .TP .B \[rs]n[.zoom] @@ -2990,11 +2984,11 @@ number register is the current year minus 1900. . . -.\" -------------------------------------------------------------------- +.\" .SS Miscellaneous -.\" -------------------------------------------------------------------- +.\" . -.B @g@troff +.B @L_TROFF@ predefines a single (read/write) string-based register, .BR \[rs]*[.T] , which contains the argument given to the @@ -3041,7 +3035,7 @@ Thus in a macro, a more efficient way of doing is . .IP -.BI \[rs]\[rs]*[ xx ]\[rs]\[rs] +.BI \[rs]\[rs]*[ xx ]\[rs]\[rs] . .P If the font description file contains pairwise kerning information, @@ -3190,21 +3184,21 @@ Example: .EE . . -.\" -------------------------------------------------------------------- +.\" .SH "INTERMEDIATE OUTPUT FORMAT" -.\" -------------------------------------------------------------------- +.\" . -This section describes the format output by GNU troff. +This section describes the format output by @L_TROFF@. . -The output format used by GNU troff is very similar to that used +The output format used by @L_TROFF@ is very similar to that used by Unix device-independent troff. . Only the differences are documented here. . . -.\" -------------------------------------------------------------------- +.\" .SS "Units" -.\" -------------------------------------------------------------------- +.\" . The argument to the .BR s \~\c @@ -3221,9 +3215,9 @@ The argument to the command is also in scaled points. . . -.\" -------------------------------------------------------------------- +.\" .SS "Text Commands" -.\" -------------------------------------------------------------------- +.\" . .TP .BI N n @@ -3317,15 +3311,15 @@ This is needed for the request in nroff mode and is ignored otherwise. . . -.\" -------------------------------------------------------------------- +.\" .SS "Drawing Commands" -.\" -------------------------------------------------------------------- +.\" . The .B D drawing command has been extended. . -These extensions are not used by GNU pic if the +These extensions are not used by @L_P_PIC@ if the .B \-n option is given. . @@ -3375,17 +3369,18 @@ and a vertical diameter of with the leftmost point at the current position. .EQ delim $$ +asda .EN . .TP \f[B]Dp\f[R] $dx sub 1$ $dy sub 1$ $dx sub 2$ $dy sub 2$ $...$ $dx sub n$ $dy sub n$\[rs]n Draw a polygon with, for $i = 1 ,..., n+1$, the .IR i -th -vertex at the current position +vertex at the current position . $+ sum from j=1 to i-1 ( dx sub j , dy sub j )$. . -At the moment, GNU pic only uses this command to generate triangles +At the moment, @L_P_PIC@ only uses this command to generate triangles and rectangles. . .TP @@ -3416,7 +3411,7 @@ selects the smallest available line thickness. A difficulty arises in how the current position should be changed after the execution of these commands. . -This is not of great importance since the code generated by GNU pic +This is not of great importance since the code generated by @L_P_PIC@ does not depend on this. . Given a drawing command of the form @@ -3451,7 +3446,7 @@ escape sequence). This rule also holds for all the original drawing commands with the exception of .BR De . -For the sake of compatibility GNU troff also follows this rule, even +For the sake of compatibility @L_TROFF@ also follows this rule, even though it produces an ugly result in the case of the .B Dt and @@ -3493,15 +3488,15 @@ The current position isn't changed by those colour commands (contrary to .BR Df ). . . -.\" -------------------------------------------------------------------- +.\" .SS "Device Control Commands" -.\" -------------------------------------------------------------------- +.\" . There is a continuation convention which permits the argument to the .B x\ X command to contain newlines: when outputting the argument to the .B x\ X -command, GNU troff follows each newline in the argument with a +command, @L_TROFF@ follows each newline in the argument with a .B + character (as usual, it terminates the entire argument with a newline); thus if the line after the line containing the @@ -3530,23 +3525,23 @@ The first three output commands are guaranteed to be: .B x init . . -.\" -------------------------------------------------------------------- +.\" .SH INCOMPATIBILITIES -.\" -------------------------------------------------------------------- +.\" . -In spite of the many extensions, groff has retained compatibility to +In spite of the many extensions, @T_ROFF@ has retained compatibility to classical troff to a large degree. . For the cases where the extensions lead to collisions, a special compatibility mode with the restricted, old functionality was created -for groff. +for @T_ROFF@. . . -.\" -------------------------------------------------------------------- -.SS "Groff Language" -.\" -------------------------------------------------------------------- +.\" +.SS "Roff Language" +.\" . -.I groff +.I @T_ROFF@ provides a .B compatibility mode that allows to process roff code written for classical @@ -3565,7 +3560,7 @@ The number register is\~1 if compatibility mode is on, 0\~otherwise. . .P -This became necessary because the GNU concept for long names causes +This became necessary because the concept for long names causes some incompatibilities. .I Classical troff interprets @@ -3578,7 +3573,7 @@ as defining a string with contents .BR cd . In -.IR groff +.IR @T_ROFF@ mode, this is considered as a call of a macro named .BR dsabcd . . @@ -3591,20 +3586,20 @@ or .B \[rs]n[ as references to a string or number register called\~\c .B [ -while -.I groff +whereas +.I @T_ROFF@ takes this as the start of a long name. . .P In .IR "compatibility mode" , -groff interprets these things in the traditional way; so long +these things are interpreted in the traditional way, so long names are not recognized. . .P -On the other hand, groff in -.I GNU native mode -does not allow to use the single-character escapes +On the other hand, in +.I native mode +the single-character escapes .B \[rs]\[rs] (backslash), .B \[rs]| @@ -3633,7 +3628,8 @@ does not allow to use the single-character escapes (percent), and .B \[rs]c -(character\~c) in names of strings, macros, diversions, number +(character\~c) +are not allowed in names of strings, macros, diversions, number registers, fonts or environments, whereas .I classical troff does. @@ -3659,12 +3655,12 @@ request ignores scale indicators and so .RE . .P -sets the point size to 10\~points, whereas in groff native mode the +sets the point size to 10\~points, whereas in native mode the point size is set to 10\~scaled points. . .P In -.IR groff , +.IR @T_ROFF@ , there is a fundamental difference between unformatted input characters, and formatted output characters (glyphs). . @@ -3714,7 +3710,7 @@ The following example makes things clearer. . .P With -.I GNU troff +.I @L_TROFF@ this is printed as .BR \[rs]\[rs] . So each pair of input backslashes @@ -3730,9 +3726,8 @@ would interpret them as escape characters when they were reread and would end up printing a single backslash `\[rs]'. . .P -In GNU, the correct way to get a printable version of the backslash -character `\[rs]' -is the +The correct way to get a printable version of the backslash +character `\[rs]' is the .B \[rs](rs escape sequence, but classical troff does not provide a clean feature for getting a non-syntactical backslash. @@ -3743,7 +3738,7 @@ character using the escape sequence; this works if the current escape character is not redefined. . -It works in both GNU mode and compatibility mode, while dirty tricks +It works in both modes (including compatibility mode), while dirty tricks like specifying a sequence of multiple backslashes do not work reliably; for the different handling in diversions, macro definitions, or text mode quickly leads to a confusion about the necessary number of @@ -3759,11 +3754,11 @@ new escape sequence can be used. . . -.\" -------------------------------------------------------------------- +.\" .SS "Intermediate Output" -.\" -------------------------------------------------------------------- +.\" . -The groff intermediate output format is in a state of evolution. +The @T_ROFF@ intermediate output format is in a state of evolution. . So far it has some incompatibilities, but it is intended to establish a full compatibility to the classical troff output format. @@ -3779,11 +3774,13 @@ The intermediate output cannot be rescaled to other devices as classical `device-independent' troff did. . . -.\" -------------------------------------------------------------------- +.\" .SH AUTHORS -.\" -------------------------------------------------------------------- +.\" . -Copyright (C) 1989, 2001, 2002, 2003, 2004, 2006, 2007, 2008 +Copyright (c) 2014 Steffen (Daode) Nurpmeso . + +Copyright (C) 1989, 2001 - 2004, 2006 - 2008 Free Software Foundation, Inc. . .P @@ -3805,54 +3802,20 @@ and Bernd Warken .ME . . -.P -This document is part of -.IR groff , -the GNU roff distribution. -. -Formerly, the contents of this document was kept in the manual -page -.BR @g@troff (@MAN1EXT@). -Only the parts dealing with the language aspects of the different -.I roff -systems were carried over into this document. -. -The -.I troff -command line options and warnings are still documented in -.BR @g@troff (@MAN1EXT@). . -.\" -------------------------------------------------------------------- +.\" .SH "SEE ALSO" -.\" -------------------------------------------------------------------- +.\" . -The -.I groff info -.IR file , -cf.\& -.BR info (1) -presents all groff documentation within a single document. -. -.TP -.BR groff (@MAN1EXT@) -A list of all documentation around -.IR groff . +.BR @L_ROFF@ (@MAN1EXT@) +Lists all the available documentation. . .TP -.BR groff (@MAN7EXT@) +.BR @L_ROFF@ (@MAN7EXT@) A description of the -.I groff +.I @T_ROFF@ language, including a short, but complete reference of all predefined -requests, registers, and escapes of plain -.IR groff . -From the command line, this is called using -. -.RS -.IP -.EX -man 7 groff -.EE -.RE +requests, registers and escapes. . .TP .BR roff (@MAN7EXT@) @@ -3873,10 +3836,4 @@ of 1992, being the classical troff documentation .UE . . -.\" -------------------------------------------------------------------- -.\" Emacs variables -.\" -------------------------------------------------------------------- -. -.\" Local Variables: -.\" mode: nroff -.\" End: +.\" s-ts-mode diff --git a/man/groff_font.man b/man/l_roff_font.5.in similarity index 92% rename from man/groff_font.man rename to man/l_roff_font.5.in index 2d93c333..1e66062f 100644 --- a/man/groff_font.man +++ b/man/l_roff_font.5.in @@ -1,5 +1,9 @@ .ig -Copyright (C) 1989-1995, 2001, 2002, 2003, 2004, 2006, 2007, 2008 +@ @L_ROFF@_font.5 + +Copyright (c) 2014 Steffen (Daode) Nurpmeso . + +Copyright (C) 1989 - 1995, 2001 - 2004, 2006 - 2008 Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of @@ -18,7 +22,7 @@ translations approved by the Free Software Foundation instead of in the original English. .. . -.do nr groff_font_C \n[.C] +.do nr roff_font_C \n[.C] .cp 0 . . @@ -30,16 +34,15 @@ the original English. .. . . -.TH GROFF_FONT @MAN5EXT@ "@MDATE@" "Groff Version @VERSION@" +.TH @U_ROFF@_FONT @MAN5EXT@ "@MDATE@" "@T_ROFF@ v@VERSION@" . . .SH NAME -groff_font \- format of groff device and font description files +@L_ROFF@_font \- format of @T_ROFF@ device and font description files . . .SH DESCRIPTION -The groff font format is roughly a superset of the ditroff -font format. +The font format is roughly a superset of the ditroff font format. . The font files for device .I name @@ -105,7 +108,7 @@ machine units. .TP .BI image_generator\ string Needed for -.B \%grohtml +.B \%@L_D_HTML@ only. . It specifies the program to generate PNG images from @@ -146,8 +149,7 @@ if it holds predefined paper types. Alternatively, .I string can be a file name (e.g.\& `/etc/papersize'); if the file can be opened, -.B groff -reads the first line and tests for the above paper sizes. +the first line is read and tested for the above paper sizes. . Finally, .I string @@ -172,9 +174,8 @@ format. sets both the vertical and horizontal dimension of the output medium. . .IP -More than one argument can be specified; -.B groff -scans from left to right and uses the first valid paper specification. +More than one argument can be specified, in which case they will be +scanned from left to right and the first valid paper specification is used. . .TP .BI paperwidth\ n @@ -221,7 +222,7 @@ If omitted, the and .B \-L options of -.B groff +.B @L_ROFF@ are ignored. . .TP @@ -297,7 +298,7 @@ is present, no .B charset section is required in the font description files since the Unicode handling built into -.B groff +.B @L_ROFF@ is used. . However, if there are entries in a @@ -325,7 +326,7 @@ scaled points. Make the font handling module always return unscaled glyph widths. . Needed for the -.B \%grohtml +.B \%@L_D_HTML@ device. . .TP @@ -355,7 +356,7 @@ postprocessors to store arbitrary information about the device. . .LP Here a list of obsolete keywords which are recognized by -.B groff +.B @L_ROFF@ but completely ignored: .BR spare1 , .BR spare2 , @@ -472,14 +473,14 @@ if .I name is a single glyph .I c -then it corresponds to the groff input character +then it corresponds to the input character .IR c ; if it is of the form .BI \[rs] c where c is a single character, then it corresponds to the special character .BI \[rs][ c ]\fR; -otherwise it corresponds to the groff input character +otherwise it corresponds to the input character .BI \[rs][ name ]\fR. . If it is exactly two characters @@ -522,7 +523,7 @@ The .I code field gives the code which the postprocessor uses to print the glyph. . -The glyph can also be input to groff using this code by means of the +The glyph can also be input using this code by means of the .B \[rs]N escape sequence. . @@ -548,14 +549,14 @@ field gives an ASCII string identifying the glyph which the postprocessor uses to print that glyph. . This field is optional and is currently used by -.B grops +.B @L_D_PS@ to build sub-encoding arrays for PS fonts containing more than 256 glyphs. . (It has also been used for -.BR \%grohtml 's +.BR \%@L_D_HTML@ 's entity names but for efficiency reasons this data is now compiled directly into -.BR \%grohtml .) +.BR \%@L_D_HTML@ .) . .LP Anything on the line after the encoding field or `\-\-' are ignored. @@ -676,11 +677,9 @@ of device . .SH "SEE ALSO" . -.BR groff_out (@MAN5EXT@), -.BR @g@troff (@MAN1EXT@). +.BR @L_ROFF@_out (@MAN5EXT@), +.BR @L_TROFF@ (@MAN1EXT@). . -.cp \n[groff_font_C] +.cp \n[roff_font_C] . -.\" Local Variables: -.\" mode: nroff -.\" End: +.\" s-ts-mode diff --git a/man/groff_out.man b/man/l_roff_out.5.in similarity index 83% rename from man/groff_out.man rename to man/l_roff_out.5.in index 8b6df59c..a1018165 100644 --- a/man/groff_out.man +++ b/man/l_roff_out.5.in @@ -1,11 +1,10 @@ -'\" e -.\" The above line should force the use of eqn as a preprocessor +'\" e -- preprocess: eqn(1) .ig -groff_out.5 +@ @L_ROFF@_out.5 -This file is part of groff, the GNU roff type-setting system. +Copyright (c) 2014 Steffen (Daode) Nurpmeso . -Copyright (C) 1989, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 +Copyright (C) 1989, 2001 - 2008 Free Software Foundation, Inc. rewritten from scrach 2001 by Bernd Warken @@ -15,14 +14,11 @@ any later version published by the Free Software Foundation; with the Invariant Sections being this .ig-section and AUTHORS, with no Front-Cover Texts, and with no Back-Cover Texts. -A copy of the Free Documentation License is included as a file called -FDL in the main directory of the groff source package. +You should have received a copy of the Free Documentation License +as part of the file COPYING; also located in the main directory of the +source package of this program. .. . -.\" -------------------------------------------------------------------- -.\" Setup -.\" -------------------------------------------------------------------- -. .\" ----------------- Document configuration . .\" Number register to decide whether the commands `{' and `}' are used @@ -60,10 +56,10 @@ after these commands, otherwise the position is not changed. \fBD\\$1\fP\ \fI\,\\$2\/\fP\|\*[@linebreak] .. . -.\" We set these as troff micromotions rather than eqn because \d and \u +.\" We set these as troff micromotions rather than eqn because \d and \u .\" can be lifted to XML subscript/superscript tags. Don't change .\" these to a parameterized string, man2html won't handle that. -.ds hv1 \fIh\d\s-3\&1\s+3\u\~v\d\s-3\&1\s+3\u\fP +.ds hv1 \fIh\d\s-3\&1\s+3\u\~v\d\s-3\&1\s+3\u\fP .ds hv2 \fIh\d\s-3\&2\s+3\u\~v\d\s-3\&2\s+3\u\fP .ds hvn \fIh\d\s-3\&n\s+3\u\~v\d\s-3\&n\s+3\u\fP . @@ -83,71 +79,54 @@ after these commands, otherwise the position is not changed. .RI "(" "\\$1" " control command)" .br .. -.\" End of macro definitions +.\" End of macro definitions . . -.\" -------------------------------------------------------------------- +.\" .\" Title -.\" -------------------------------------------------------------------- +.\" . -.TH GROFF_OUT @MAN5EXT@ "@MDATE@" "Groff Version @VERSION@" +.TH @U_ROFF@_OUT @MAN5EXT@ "@MDATE@" "@T_ROFF@ v@VERSION@" . .SH NAME -groff_out \- groff intermediate output format +@L_ROFF@_out \- @T_ROFF@ intermediate output format . . -.\" -------------------------------------------------------------------- +.\" .SH DESCRIPTION -.\" -------------------------------------------------------------------- +.\" . This manual page describes the .I intermediate output -format of the GNU -.BR roff (@MAN7EXT@) +format of the +.BR @L_ROFF@ (@MAN7EXT@) text processing system -.BR groff (@MAN1EXT@). -. -This output is produced by a run of the GNU -.BR @g@troff (@MAN1EXT@) +.BR @L_ROFF@ (@MAN1EXT@), +as produced by a run of the +.BR @L_TROFF@ (@MAN1EXT@) program. . It contains already all device-specific information, but it is not yet fed into a device postprocessor program. -. -. -.P -As the GNU -.I roff -processor -.BR groff (@MAN1EXT@) -is a wrapper program around -.B @g@troff -that automatically calls a -postprocessor, this output does not show up normally. -. -This is why it is called -.I intermediate -within the -.I groff -.IR system . +Because of this it is called intermediate. . The -.B groff +.B @L_ROFF@ program provides the option .B -Z to inhibit postprocessing, such that the produced .I intermediate output is sent to standard output just like calling -.B @g@troff +.B @L_TROFF@ manually. . . .P In this document, the term -.I @g@troff output -describes what is output by the GNU -.B @g@troff -program, while +.I @L_TROFF@ output +describes what is output by the +.B @L_TROFF@ +program, whereas .I intermediate output refers to the language that is accepted by the parser that prepares this output for the postprocessors. @@ -163,11 +142,11 @@ concept is to facilitate the development of postprocessors by providing a common programming interface for all devices. . It has a language of its own that is completely different from the -.BR groff (@MAN7EXT@) +.BR @L_ROFF@ (@MAN7EXT@) language. . While the -.I groff +.I @T_ROFF@ language is a high-level programming language for text processing, the .I intermediate output language is a kind of low-level assembler language by specifying all @@ -184,21 +163,16 @@ versions are denoted as The .I intermediate output produced by -.B groff -is fairly readable, while .I classical troff -output was hard to understand because of strange habits that are -still supported, but not used any longer by -.I GNU -.IR @g@troff . +output was hard to understand because of strange habits. . . -.\" -------------------------------------------------------------------- +.\" .SH "LANGUAGE CONCEPTS" -.\" -------------------------------------------------------------------- +.\" . During the run of -.BR @g@troff , +.BR @L_TROFF@ , the .I roff input is cracked down to the information on what has to be printed at @@ -220,15 +194,15 @@ There are commands for positioning and text writing, for drawing, and for device controlling. . . -.\" -------------------------------------------------------------------- +.\" .SS "Separation" -.\" -------------------------------------------------------------------- +.\" . .I Classical troff output had strange requirements on whitespace. . The -.B groff +.B @T_ROFF@ output parser, however, is smart about whitespace by making it maximally optional. . @@ -284,7 +258,7 @@ single letter taking a fixed number of arguments. . For historical reasons, the parser allows to stack such commands on the same line, but fortunately, in -.I groff intermediate +.I @T_ROFF@ intermediate .IR output , every command with at least one argument is followed by a line break, thus providing excellent readability. @@ -315,23 +289,21 @@ occur everywhere. They are just ignored. . . -.\" -------------------------------------------------------------------- +.\" .SS "Argument Units" -.\" -------------------------------------------------------------------- +.\" . Some commands take integer arguments that are assumed to represent values in a measurement unit, but the letter for the corresponding .I scale indicator is not written with the output command arguments; see -.BR groff (@MAN7EXT@) -and the -.I groff info file +.BR @L_ROFF@ (@MAN7EXT@) for more on this topic. . Most commands assume the scale indicator\~\c .BR u , the basic unit of the device, some use\~\c -.BR z , +.BR z , the .I scaled point unit of the device, while others, such as the color commands expect plain @@ -342,7 +314,7 @@ Note that these scale indicators are relative to the chosen device. They are defined by the parameters specified in the device's .I DESC file; see -.BR groff_font (@MAN5EXT@). +.BR @L_ROFF@_font (@MAN5EXT@). . . .P @@ -366,9 +338,9 @@ character, which then is regarded as the first character of the next argument or command. . . -.\" -------------------------------------------------------------------- +.\" .SS "Document Parts" -.\" -------------------------------------------------------------------- +.\" A correct .I intermediate output document consists of two parts, the @@ -383,7 +355,7 @@ is to set the general device parameters using three exactly specified commands. . The -.I groff prologue +.I @T_ROFF@ prologue is guaranteed to consist of the following three lines (in that order): .RS .P @@ -416,7 +388,7 @@ ones used in the Processing is terminated as soon as the first .B x\ stop command is encountered; the last line of any -.I groff intermediate output +.I @T_ROFF@ intermediate output always contains such a command. . . @@ -440,20 +412,20 @@ is done relative to the current page, all other positioning is done relative to the current location within this page. . . -.\" -------------------------------------------------------------------- +.\" .SH "COMMAND REFERENCE" -.\" -------------------------------------------------------------------- +.\" . This section describes all .I intermediate output commands, the classical commands as well as the -.I groff +.I @T_ROFF@ extensions. . . -.\" -------------------------------------------------------------------- +.\" .SS "Comment Command" -.\" -------------------------------------------------------------------- +.\" . .TP .BI # anything \[la]end-of-line\[ra] @@ -474,9 +446,9 @@ Each comment can be preceded by arbitrary every command can be terminated by a comment. . . -.\" -------------------------------------------------------------------- +.\" .SS "Simple Commands" -.\" -------------------------------------------------------------------- +.\" . The commands in this subsection have a command code consisting of a single character, taking a fixed number of arguments. @@ -575,7 +547,7 @@ horizontally to the right. allows negative values for .I n also, but -.I groff +.I @T_ROFF@ doesn't use this. . . @@ -592,15 +564,13 @@ The color components are specified as integer arguments between 0 and The number of color components and their meaning vary for the different color schemes. . -These commands are generated by the -.I groff -escape sequence +These commands are generated by the escape sequence .BR \*[@backslash]m . . No position changing. . These commands are a -.I groff +.I @T_ROFF@ extension. . . @@ -659,7 +629,7 @@ For example, represents an unbreakable space which has a width of 193\|u. . This command is a -.I groff +.I @T_ROFF@ extension. . . @@ -681,7 +651,7 @@ make the more human readable without performing any action. . In -.IR groff , +.IR @T_ROFF@ they are just ignored, but they must be provided for compatibility reasons. . @@ -711,8 +681,8 @@ Set point size to scaled points (this is unit\~\c .B z -in GNU -.BR @g@troff ). +in +.BR @L_TROFF@ ). . .I Classical troff used the unit @@ -749,13 +719,13 @@ cannot be printed using this command; use the command for those glyphs. . This command is a -.I groff +.I @T_ROFF@ extension; it is only used for devices whose .I DESC file contains the .B tcommand keyword; see -.BR groff_font (@MAN5EXT@). +.BR @L_ROFF@_font (@MAN5EXT@). . . .TP @@ -772,13 +742,13 @@ glyph and\~\c basic units\~\c .BR u ). This command is a -.I groff +.I @T_ROFF@ extension; it is only used for devices whose .I DESC file contains the .B tcommand keyword; see -.BR groff_font (@MAN5EXT@). +.BR @L_ROFF@_font (@MAN5EXT@). . . .TP @@ -804,7 +774,7 @@ is a non-negative integer). allows negative values for .I n also, but -.I groff +.I @T_ROFF@ doesn't use this. . . @@ -815,9 +785,9 @@ Informs about a paddable whitespace to increase readability. The spacing itself must be performed explicitly by a move command. . . -.\" -------------------------------------------------------------------- +.\" .SS "Graphics Commands" -.\" -------------------------------------------------------------------- +.\" . Each graphics or drawing command in the .I intermediate output @@ -840,7 +810,7 @@ is terminated by a . . .P -.B @g@troff +.B @L_TROFF@ output follows the classical spacing rules (no space between command and subcommand, all arguments are preceded by a single space character), but the parser allows optional space between the command @@ -856,13 +826,13 @@ In this case, they are integers representing a size measured in basic units\~\c .BR u . . -The +The .I h arguments stand for horizontal distances where positive means right, negative left. . -The +The .I v arguments stand for vertical distances where positive means down, negative up. @@ -873,10 +843,9 @@ All these distances are offsets relative to the current location. .P Unless indicated otherwise, each graphics command directly corresponds to a similar -.I groff .B \*[@backslash]D escape sequence; see -.BR groff (@MAN7EXT@). +.BR @L_ROFF@ (@MAN7EXT@). . . .P @@ -934,7 +903,7 @@ An optional second integer argument is ignored (this allows to the formatter to generate an even number of arguments). . This command is a -.I groff +.I @T_ROFF@ extension. . . @@ -961,7 +930,7 @@ with the leftmost point at the current position; then move to the rightmost point of the ellipse. . This command is a -.I groff +.I @T_ROFF@ extension. . . @@ -991,7 +960,6 @@ The number of color components and their meaning vary for the different color schemes. . These commands are generated by the -.I groff escape sequences .BR \*[@backslash]D'F\ .\|.\|. ' and @@ -1001,7 +969,7 @@ and No position changing. . This command is a -.I groff +.I @T_ROFF@ extension. . . @@ -1077,7 +1045,7 @@ sets all colors to blue. No position changing. . This command is a -.I groff +.I @T_ROFF@ extension. . .RE @@ -1116,7 +1084,7 @@ the position doesn't change. .\} . This command is a -.I groff +.I @T_ROFF@ extension. . . @@ -1135,7 +1103,7 @@ The position is changed in the same way as with No position changing. . This command is a -.I groff +.I @T_ROFF@ extension. . . @@ -1168,18 +1136,18 @@ Although this doesn't make sense it is kept for compatibility. No position changing. . This command is a -.I groff +.I @T_ROFF@ extension. . . -.\" -------------------------------------------------------------------- +.\" .SS "Device Control Commands" -.\" -------------------------------------------------------------------- +.\" . Each device control command starts with the letter .B x followed by a space character (optional or arbitrary space/\:tab in -.IR groff ) +.IR @T_ROFF@ ) and a subcommand letter or word; each argument (if any) must be preceded by a .I syntactical @@ -1200,7 +1168,7 @@ of characters terminated by the next tab, space, or newline character. All characters of the subcommand word but the first are simply ignored. . For example, -.B @g@troff +.B @L_TROFF@ outputs the initialization command .B x\ i as @@ -1211,9 +1179,7 @@ as .BR "x\ res" . . But writings like -.B x\ i_like_groff -and -.B x\ roff_is_groff +.B x\ i_like_roff are accepted as well to mean the same commands. . .P @@ -1232,13 +1198,11 @@ Use as the intended name for the current file in error reports. . This is useful for remembering the original file name when -.B groff -uses an internal piping mechanism. -. +an internal piping mechanism is used. The input file is not changed by this command. . This command is a -.I groff +.I @T_ROFF@ extension. . . @@ -1251,7 +1215,7 @@ Mount font position\~\c .I s (a text word), cf. -.BR groff_font (@MAN5EXT@). +.BR @L_ROFF@_font (@MAN5EXT@). . . .TP @@ -1320,7 +1284,7 @@ degrees (an integer in basic units\~\c .xsub stop Terminates the processing of the current file; issued as the last command of any -.I intermediate @g@troff +.I intermediate @L_TROFF@ .IR output . . . @@ -1330,7 +1294,7 @@ command of any Generate trailer information, if any. . In -.BR groff , +.BR @T_ROFF@ , this is actually just ignored. . . @@ -1341,7 +1305,7 @@ Set name of device to word .IR xxx , a sequence of characters ended by the next whitespace character. . -The possible device names coincide with those from the groff +The possible device names coincide with those from the @L_ROFF@ .B \-T option. . @@ -1364,11 +1328,11 @@ is\~0, stop underlining of spaces. This is needed for the .B cu request in -.B @g@nroff +.B @L_NROFF@ mode and is ignored otherwise. . This command is a -.I groff +.I @T_ROFF@ extension. . . @@ -1394,19 +1358,17 @@ line is not a .B + character. . -This command is generated by the -.I groff -escape sequence +This command is generated by the escape sequence .BR \*[@backslash]X . . The line-continuing feature is a -.I groff +.I @T_ROFF@ extension. . . -.\" -------------------------------------------------------------------- +.\" .SS "Obsolete Command" -.\" -------------------------------------------------------------------- +.\" . In .I classical troff @@ -1430,7 +1392,7 @@ then print glyph with single-letter name\~\c .RS .P In -.IR groff , +.IR @T_ROFF@ , arbitrary .I syntactical space around and within this command is allowed to be added. @@ -1458,9 +1420,9 @@ and\~\c provide a better functionality. . . -.\" -------------------------------------------------------------------- +.\" .SH "POSTPROCESSING" -.\" -------------------------------------------------------------------- +.\" . The .I roff @@ -1472,7 +1434,7 @@ A device can be some piece of hardware such as a printer, or a software file format suitable for graphical or text processing. . The -.I groff +.I @T_ROFF@ system provides powerful means that make the programming of such postprocessors an easy task. .P @@ -1481,17 +1443,15 @@ There is a library function that parses the and sends the information obtained to the device via methods of a class with a common interface for each device. . -So a -.I groff -postprocessor must only redefine the methods of this class. +So a postprocessor must only redefine the methods of this class. . For details, see the reference in section .BR FILES . . . -.\" -------------------------------------------------------------------- +.\" .SH "EXAMPLES" -.\" -------------------------------------------------------------------- +.\" . This section presents the .I intermediate output @@ -1500,11 +1460,11 @@ generated from the same input for three different devices. The input is the sentence .I hell world fed into -.B groff +.B @L_ROFF@ on the command line. . . -.IP \[bu] 2m +.IP \[bu] 2m High-resolution device .I ps . @@ -1512,7 +1472,7 @@ High-resolution device .RS .P .EX -\fBshell>\fP echo "hell world" | groff -Z -T ps +\fBshell>\fP echo "hell world" | @L_ROFF@ -Z -T ps .EE . . @@ -1544,11 +1504,11 @@ x stop . .P This output can be fed into the postprocessor -.BR grops (@MAN1EXT@) +.BR @L_D_PS@ (@MAN1EXT@) to get its representation as a PostScript file. . . -.IP \[bu] 2m +.IP \[bu] 2m Low-resolution device .I latin1 . @@ -1566,7 +1526,7 @@ formatter. . .P .EX -\fBshell>\fP "hell world" | groff -Z -T latin1 +\fBshell>\fP "hell world" | @L_ROFF@ -Z -T latin1 .EE . . @@ -1613,7 +1573,7 @@ x stop . .P This output can be fed into the postprocessor -.BR grotty (@MAN1EXT@) +.BR @L_D_TTY@ (@MAN1EXT@) to get a formatted text document. . .RS @@ -1623,32 +1583,32 @@ Due to the obsolete jump-and-write command, the text clusters in the classical output are almost unreadable. . . -.\" -------------------------------------------------------------------- +.\" .SH "COMPATIBILITY" -.\" -------------------------------------------------------------------- +.\" . The .I intermediate output -language of the +language of the .I classical troff was first documented in .IR [CSTR\~#97] . . The -.I groff intermediate output +.I @T_ROFF@ intermediate output format is compatible with this specification except for the following features. . . -.IP \[bu] 2m +.IP \[bu] 2m The classical quasi device independence is not yet implemented. . . -.IP \[bu] 2m +.IP \[bu] 2m The old hardware was very different from what we use today. . So the -.I groff +.I @T_ROFF@ devices are also fundamentally different from the ones in .I classical .IR troff . @@ -1656,18 +1616,18 @@ devices are also fundamentally different from the ones in For example, the classical PostScript device was called .I post and had a resolution of 720 units per inch, -while -.IR groff 's +whereas +.IR @T_ROFF@ 's .I ps device has a resolution of 72000 units per inch. . Maybe, by implementing some rescaling mechanism similar to the classical quasi device independence, these could be integrated into modern -.IR groff . +.IR @T_ROFF@ . . . -.IP \[bu] 2m +.IP \[bu] 2m The B-spline command .B D~ is correctly handled by the @@ -1676,7 +1636,7 @@ parser, but the drawing routines aren't implemented in some of the postprocessor programs. . . -.IP \[bu] 2m +.IP \[bu] 2m The argument of the commands .B s and @@ -1684,7 +1644,7 @@ and has the implicit unit scaled point\~\c .B z in -.IR groff , +.IR @T_ROFF@ , while .I classical troff had point (\c @@ -1694,11 +1654,11 @@ This isn't an incompatibility, but a compatible extension, for both units coincide for all devices without a .I sizescale parameter, including all classical and the -.I groff +.I @T_ROFF@ text devices. . The few -.I groff +.I @T_ROFF@ devices with a sizescale parameter either did not exist, had a different name, or seem to have had a different resolution. . @@ -1706,13 +1666,13 @@ So conflicts with classical devices are very unlikely. . . .ie \n[@STUPID_DRAWING_POSITIONING]=1 \{\ -.IP \[bu] 2m +.IP \[bu] 2m The position changing after the commands .BR Dp , .BR DP , and .B Dt -is illogical, but as old versions of groff used this feature it is +is illogical, but as old versions of GNU troff used this feature it is kept for compatibility reasons. .\} \" @STUPID_DRAWING_POSITIONING .el \{\ @@ -1720,11 +1680,11 @@ kept for compatibility reasons. Temporarily, there existed some confusion on the positioning after the .B D commands that are -.I groff +.I @T_ROFF@ extensions. . This has been clarified by establishing the classical rule for all -groff drawing commands: +@T_ROFF@ drawing commands: . . .RS @@ -1743,16 +1703,16 @@ follow quite naturally. . .P The differences between -.I groff +.I @T_ROFF@ and .I classical troff are documented in -.BR groff_diff (@MAN7EXT@). +.BR @L_ROFF@_diff (@MAN7EXT@). . . -.\" -------------------------------------------------------------------- +.\" .SH "FILES" -.\" -------------------------------------------------------------------- +.\" . .TP .BI @FONTDIR@/dev name /DESC @@ -1760,28 +1720,28 @@ Device description file for device .IR name . . .TP -.IB \[la]groff-source-dir\[ra] /src/libs/libdriver/input.cpp +.IB \[la]@T_ROFF@-source-dir\[ra] /src/libs/driver/input.cpp Defines the parser and postprocessor for the .I intermediate .IR output . . It is located relative to the top directory of the -.I groff +.I @T_ROFF@ source tree. . This parser is the definitive specification of the -.I groff intermediate output +.I @T_ROFF@ intermediate output format. . . -.\" -------------------------------------------------------------------- +.\" .SH "SEE ALSO" -.\" -------------------------------------------------------------------- +.\" . A reference like -.BR groff (@MAN7EXT@) +.BR @L_ROFF@ (@MAN7EXT@) refers to a manual page; here -.B groff +.B @L_ROFF@ in section\~\c .I @MAN7EXT@ of the man-page documentation system. @@ -1789,11 +1749,10 @@ of the man-page documentation system. To read the example, look up section\~@MAN7EXT@ in your desktop help system or call from the shell prompt . -. .RS .P .EX -\fBshell>\fP man @MAN7EXT@ groff +\fBshell>\fP man @MAN7EXT@ @L_ROFF@ .EE .RE . @@ -1804,28 +1763,26 @@ For more details, see . . .TP -.BR groff (@MAN1EXT@) +.BR @L_ROFF@ (@MAN1EXT@) option .B -Z -and further readings on groff. +and further readings. . . .TP -.BR groff (@MAN7EXT@) -for details of the -.I groff -language such as numerical units and escape sequences. +.BR @L_ROFF@ (@MAN7EXT@) +for details of the language such as numerical units and escape sequences. . . .TP -.BR groff_font (@MAN5EXT@) +.BR @L_ROFF@_font (@MAN5EXT@) for details on the device scaling parameters of the .B DESC file. . . .TP -.BR @g@troff (@MAN1EXT@) +.BR @L_TROFF@ (@MAN1EXT@) generates the device-independent intermediate output. . . @@ -1835,36 +1792,18 @@ for historical aspects and the general structure of roff systems. . . .TP -.BR groff_diff (@MAN7EXT@) +.BR @L_ROFF@_diff (@MAN7EXT@) The differences between the intermediate output in groff and classical troff. . -. .P -.BR \%grodvi (@MAN1EXT@), -.BR \%grohtml (@MAN1EXT@), -.BR \%grops (@MAN1EXT@), -.BR \%grotty (@MAN1EXT@) +.BR \%@L_D_DVI@ (@MAN1EXT@), +.BR \%@L_D_HTML@ (@MAN1EXT@), +.BR \%@L_D_PS@ (@MAN1EXT@), +.BR \%@L_D_TTY@ (@MAN1EXT@) .br .RS -the groff postprocessor programs. -.RE -. -. -.P -For a treatment of all aspects of the groff system within a single -document, see the -.I groff info -.IR file . -. -It can be read within the integrated help systems, within -.BR emacs (1) -or from the shell prompt by -. -.RS -.EX -\fBshell>\fP info groff -.EE +the @T_ROFF@ postprocessor programs. .RE . . @@ -1905,14 +1844,15 @@ CSTR\~#54 .UE . . . -.\" -------------------------------------------------------------------- +.\" .SH "AUTHORS" -.\" -------------------------------------------------------------------- +.\" . -Copyright (C) 1989, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 +Copyright (c) 2014 Steffen (Daode) Nurpmeso . + +Copyright (C) 1989, 2001 - 2008 Free Software Foundation, Inc. . -. .P This document is distributed under the terms of the FDL (GNU Free Documentation License) version 1.1 or later. @@ -1925,27 +1865,6 @@ GNU copyleft site . . .P -This document is part of -.IR groff , -the GNU -.I roff -distribution. -. -It is based on a former version \- published under the GPL \- that -described only parts of the -.I groff -extensions of the output language. -. -It was rewritten in 2002 by Bernd Warken and is -maintained by -.MT wl@gnu.org -Werner Lemberg -.ME . -. -.\" -------------------------------------------------------------------- -.\" Emacs settings -.\" -------------------------------------------------------------------- -.\" -.\" Local Variables: -.\" mode: nroff -.\" End: +This document was rewritten in 2002 by Bernd Warken. +. +.\" s-ts-mode diff --git a/man/groff_tmac.man b/man/l_roff_tmac.5.in similarity index 75% rename from man/groff_tmac.man rename to man/l_roff_tmac.5.in index 9b22ca1d..6fd5fe4f 100644 --- a/man/groff_tmac.man +++ b/man/l_roff_tmac.5.in @@ -1,11 +1,9 @@ .ig -groff_tmac.5 +@ @L_ROFF@_tmac.5 -File position: /man/groff_tmac.man +Copyright (c) 2014 Steffen (Daode) Nurpmeso . -This file is part of groff, the GNU roff type-setting system. - -Copyright (C) 2000, 2001, 2002, 2003, 2004, 2006, 2007, 2008, 2009 +Copyright (C) 2000 - 2004, 2006 - 2009 Free Software Foundation, Inc. written by Bernd Warken and Werner Lemberg @@ -16,19 +14,20 @@ any later version published by the Free Software Foundation; with the Invariant Sections being this .ig-section and AUTHOR, with no Front-Cover Texts, and with no Back-Cover Texts. -A copy of the Free Documentation License is included as a file called -FDL in the main directory of the groff source package. +You should have received a copy of the Free Documentation License +as part of the file COPYING; also located in the main directory of the +source package of this program. .. .ds Ellipsis \&.\|.\|.\&\" . -.TH GROFF_TMAC @MAN5EXT@ "@MDATE@" "Groff Version @VERSION@" +.TH @U_ROFF@_TMAC @MAN5EXT@ "@MDATE@" "@T_ROFF@ v@VERSION@" .SH NAME -groff_tmac \- macro files in the roff typesetting system +@L_ROFF@_tmac \- macro files in the roff typesetting system . . -.\" -------------------------------------------------------------------- +.\" .SH DESCRIPTION -.\" -------------------------------------------------------------------- +.\" . The .BR roff (@MAN7EXT@) @@ -53,12 +52,12 @@ the directories. . . -.\" -------------------------------------------------------------------- -.SH "GROFF MACRO PACKAGES" -.\" -------------------------------------------------------------------- +.\" +.SH "@T_ROFF@ MACRO PACKAGES" +.\" . -.I groff -provides all classical macro packages, some more full packages, and +.I @T_ROFF@ +provides most classical macro packages, some more full packages, and some secondary packages for special purposes. . Note that it is not possible to use multiple primary macro packages at the @@ -66,7 +65,7 @@ same time; saying e.g.\& . .IP .EX -\fIsh#\fP groff \-m man \-m ms foo +\fIsh#\fP @L_ROFF@ \-m man \-m ms foo .EE . .P @@ -74,7 +73,7 @@ or . .IP .EX -\fIsh#\fP groff \-m man foo \-m ms bar +\fIsh#\fP @L_ROFF@ \-m man foo \-m ms bar .EE . .P @@ -89,15 +88,15 @@ See below the description of the file. . . -.\" -------------------------------------------------------------------- +.\" .SS "Man\~Pages" -.\" -------------------------------------------------------------------- +.\" . .TP .B man This is the classical macro package for UNIX manual pages (man\~pages); it is quite handy and easy to use; see -.BR groff_man (@MAN7EXT@). +.BR @L_ROFF@_man (@MAN7EXT@). . . .TP @@ -107,7 +106,7 @@ This is the classical macro package for UNIX manual pages An alternative macro package for man\~pages mainly used in BSD systems; it provides many new features, but it is not the standard for man\~pages; see -.BR groff_mdoc (@MAN7EXT@). +.BR @L_ROFF@_mdoc (@MAN7EXT@). . . .TP @@ -122,9 +121,9 @@ package should be used. Multiple man pages (in either format) can be handled. . . -.\" -------------------------------------------------------------------- +.\" .SS "Full Packages" -.\" -------------------------------------------------------------------- +.\" . The packages in this section provide a complete set of macros for writing documents of any kind, up to whole books. @@ -138,7 +137,7 @@ to use. The classical .I me macro package; see -.BR groff_me (@MAN7EXT@). +.BR @L_ROFF@_me (@MAN7EXT@). . . .TP @@ -146,21 +145,7 @@ macro package; see The semi-classical .I mm macro package; see -.BR groff_mm (@MAN7EXT@). -. -. -.TP -.B mom -The new -.I mom -macro package, only available in groff. -. -As this is not based on other packages, it can be freely designed. -. -So it is expected to become quite a nice, modern macro package. -. -See -.BR groff_mom (@MAN7EXT@). +.BR @L_ROFF@_mm (@MAN7EXT@). . . .TP @@ -168,17 +153,17 @@ See The classical .I ms macro package; see -.BR groff_ms (@MAN7EXT@). +.BR @L_ROFF@_ms (@MAN7EXT@). . . -.\" -------------------------------------------------------------------- +.\" .SS "Language-specific Packages" -.\" -------------------------------------------------------------------- +.\" . .TP .B cs This file adds support for Czech localization, including the main macro -packages (me, mom, mm, and ms). +packages (me, mm, and ms). . .IP Note that @@ -212,7 +197,7 @@ Example: .RS .IP .EX -\fIsh#\fP groff -ms -mfr foo.ms > foo.ps +\fIsh#\fP @L_ROFF@ -ms -mfr foo.ms > foo.ps .EE .RE . @@ -228,14 +213,14 @@ ligature. Swedish localization support, including the me, mom, and ms macro packages. . Note that Swedish for the mm macros is handled separately; see -.BR groff_mmse (@MAN7EXT@). +.BR @L_ROFF@_mmse (@MAN7EXT@). . It should be used as the last macro package on the command line. . . -.\" -------------------------------------------------------------------- +.\" .SS "Input Encodings" -.\" -------------------------------------------------------------------- +.\" . . .TP @@ -246,12 +231,12 @@ It should be used as the last macro package on the command line. .B latin5 .TQ .B latin9 -Various input encodings supported directly by groff. +Various input encodings supported directly by @T_ROFF@. . Normally, this macro is loaded at the very beginning of a document or specified as the first macro argument on the command line. . -.B @g@roff +.B @L_ROFF@ loads latin1 by default at start-up. . Note that these macro packages don't work on EBCDIC hosts. @@ -264,7 +249,7 @@ Encoding support for EBCDIC. On those platforms it is loaded automatically at start-up. . Due to different character ranges used in -.B @g@roff +.B @L_ROFF@ it doesn't work on architectures which are based on ASCII. . . @@ -276,7 +261,7 @@ For example, saying . .P .EX -groff -Tlatin1 -mlatin9 ... +@L_ROFF@ -Tlatin1 -mlatin9 ... .EE . .P @@ -290,13 +275,13 @@ for other devices it is usually sufficient to install proper fonts which contain the necessary glyphs. . . -.\" -------------------------------------------------------------------- +.\" .SS "Special Packages" -.\" -------------------------------------------------------------------- +.\" . The macro packages in this section are not intended for stand-alone usage, but can be used to add special functionality to any other -macro package or to plain groff. +macro package or to plain @L_ROFF@. . . .TP @@ -310,14 +295,14 @@ integers (allowing safe multiplication of 30bit integers, for example). Switch to the EC and TC font families. . To be used with -.BR \%grodvi (@MAN1EXT@) -\[en] this man page also gives more details of how to use it. +.BR \%@L_D_DVI@ (@MAN1EXT@) +\[en] this man page also gives more details of how to use it. . . .TP .B papersize This macro file is already loaded at start-up by -.B @g@troff +.B @L_TROFF@ so it isn't necessary to call it explicitly. . It provides an interface to set the paper size on the command line with @@ -328,7 +313,7 @@ Possible values for are the same as the predefined .B papersize values in the DESC file (only lowercase; see -.BR groff_font (@MAN5EXT@) +.BR @L_ROFF@_font (@MAN5EXT@) for more) except .BR a7 - d7 . . @@ -355,7 +340,7 @@ orientation: .IP .EX .SM -\fIsh#\fP groff \-Tps \-dpaper=a4l \-P\-pa4 \-P\-l \-ms foo.ms > foo.ps +\fIsh#\fP @L_ROFF@ \-Tps \-dpaper=a4l \-P\-pa4 \-P\-l \-ms foo.ms > foo.ps .EE . . @@ -366,7 +351,7 @@ This file provides proper definitions for the macros and .BR PE , needed for the -.BR @g@pic (@MAN1EXT@) +.BR @L_P_PIC@ (@MAN1EXT@) preprocessor. . They center each picture. @@ -391,7 +376,7 @@ for all other devices the image is replaced with a hollow rectangle of the same size. . This macro file is already loaded at start-up by -.B @g@troff +.B @L_TROFF@ so it isn't necessary to call it explicitly. . .IP @@ -495,12 +480,12 @@ Use this for tracing macro calls. It is only useful for debugging. . See -.BR groff_trace (@MAN7EXT@) . +.BR @L_ROFF@_trace (@MAN7EXT@) . . . .TP .B tty-char -Overrides the definition of standard troff characters and some groff +Overrides the definition of standard troff characters and some @T_ROFF@ characters for TTY devices. . The optical appearance is intentionally inferior compared to that of @@ -512,15 +497,15 @@ normal TTY formatting to allow processing with critical equipment. Additions of elements known from the HTML format, as used in the internet (World Wide Web) pages; this includes URL links and mail addresses; see -.BR groff_www (@MAN7EXT@). +.BR @L_ROFF@_www (@MAN7EXT@). . . -.\" -------------------------------------------------------------------- +.\" .SH NAMING -.\" -------------------------------------------------------------------- +.\" . Classical roff systems were designed before the conventions of the -modern C +modern C .BR getopt (3) call evolved, and used a naming scheme for macro packages that looks odd to modern eyes. Macro packages were always included with the option @@ -564,39 +549,19 @@ command line option for activating this package reads . .P To cope with all situations, actual versions of -.BR groff (@MAN1EXT@) +.BR @L_ROFF@ (@MAN1EXT@) are smart about both naming schemes by providing two macro files for the inflicted macro packages; one with a leading `m' the other one without it. . -So in -.IR groff , -the -.I man -macro package may be specified as on of the following four methods: -. -.IP -.EX -\fIsh#\fP groff\ \-m\ man -\fIsh#\fP groff\ \-man -\fIsh#\fP groff\ \-mman -\fIsh#\fP groff\ \-m\ an -.EE -. -. -.P -Recent packages that do not start with `m' -do not use an additional `m' -in the documentation. -. -For example, the +Newer packages are more specific; for example, the .I www macro package may be specified only as one of the two methods: . .IP .EX -\fIsh#\fP groff\ \-m\ www -\fIsh#\fP groff\ \-mwww +\fIsh#\fP @L_ROFF@\ \-m\ www +\fIsh#\fP @L_ROFF@\ \-mwww .EE . . @@ -612,7 +577,7 @@ in the form \f[B]tmac.\f[]\f[I]name\f[]. In modern operating systems, the type of a file is specified as a postfix, the file name extension. . -Again, groff copes with this situation by searching both +Again, @T_ROFF@ copes with this situation by searching both .IB anything .tmac and .BI tmac. anything @@ -624,35 +589,33 @@ is specified. .P The easiest way to find out which macro packages are available on a system is to check the man\~page -.BR groff (@MAN1EXT@), +.BR @L_ROFF@ (@MAN1EXT@), or the contents of the .I tmac directories. . . .P -In -.IR groff , -most macro packages are described in\~man pages called -.BR groff_\f[I]name\f[] (@MAN7EXT@), +Most macro packages are described in\~man pages called +.BR @L_ROFF@_\f[I]name\f[] (@MAN7EXT@), with a leading `m' for the classical packages. . . -.\" -------------------------------------------------------------------- +.\" .SH INCLUSION -.\" -------------------------------------------------------------------- +.\" . There are several ways to use a macro package in a document. . -The classical way is to specify the troff/groff option +The classical way is to specify the option .BR \-m .I name at run-time; this makes the contents of the macro package .I name available. . -In groff, the file +In @T_ROFF@, the file .IB name .tmac is searched within the tmac path; if not found, .BI tmac. name @@ -667,7 +630,7 @@ the request into the document; the argument must be the full file name of an existing file, possibly with the directory where it is kept. . -In groff, this was improved by the similar request +In @T_ROFF@ this was improved by the similar request .B .mso .IR package , which added searching in the tmac path, just like option @@ -681,15 +644,15 @@ Note that in order to resolve the and .B .mso requests, the roff preprocessor -.BR soelim (@MAN1EXT@) +.BR @L_P_SOELIM@ (@MAN1EXT@) must be called if the files to be included need preprocessing. . This can be done either directly by a pipeline on the command line or -by using the troff/groff option +by using the option .BR \-s . . .I man -calls soelim automatically. +calls @L_P_SOELIM@ automatically. . . .P @@ -708,7 +671,7 @@ At run-time, the formatter call for this is . .IP .EX -\fIsh#\fP groff \-m macros docu.roff +\fIsh#\fP @L_ROFF@ \-m macros docu.roff .EE . . @@ -733,15 +696,11 @@ is used or In both cases, the formatter should be called with option .B \-s to invoke -.BR soelim . -.IP -.EX -\fIsh#\fP groff \-s docu.roff -.EE +.BR @L_P_SOELIM@ . . . .P -If you want to write your own groff macro file, call it +If you want to write your own @T_ROFF@ macro file, call it .IB whatever .tmac and put it in some directory of the tmac path, see section .BR FILES . @@ -752,11 +711,9 @@ request or the option . . .ig -.\" -------------------------------------------------------------------- +.\" .SH CONVENTION -.\" -------------------------------------------------------------------- -. -.\" This section does not fit into the framework of this document. +.\" . There is a convention that is supported by many modern roff type-setters and @@ -775,7 +732,7 @@ abbreviations for those preprocessor commands that should be run when formatting the document. . Mostly, only the letters corresponding to the options for the -preprocessors are recognized, +preprocessors are recognized, `e' (for .BR eqn ), @@ -813,10 +770,10 @@ man\~pages only the following characters should be used: `e', `p', and `t'. . . -.. -.\" -------------------------------------------------------------------- +. +.\" .SH "WRITING MACROS" -.\" -------------------------------------------------------------------- +.\" . A .BR roff (@MAN7EXT@) @@ -855,14 +812,14 @@ the name under which the macro was called is in and the number of arguments is in register .BR \[rs]n[.$] ; see -.BR groff (@MAN7EXT@). +.BR @L_ROFF@ (@MAN7EXT@). . . -.\" -------------------------------------------------------------------- +.\" .SS "Copy-in Mode" -.\" -------------------------------------------------------------------- +.\" . -The phase when groff reads a macro is called +The phase when @T_ROFF@ reads a macro is called .I "copy-in mode" or .I "copy mode" @@ -873,7 +830,7 @@ of a program written in the C\~language. . . .P -In this phase, groff interprets all backslashes; that means that all +In this phase all backslashes are interpreted; that means that all escape sequences in the macro body are interpreted and replaced by their value. . @@ -944,7 +901,7 @@ is a constant string, it does not change, so no doubling for .IR \[rs]*[midpart] . The .I \[rs]f -escape sequences are predefined groff elements for setting the font +escape sequences are predefined elements for setting the font within the text. . Of course, this behavior does not change, so no doubling with @@ -953,15 +910,14 @@ and .IR \[rs]f[] . . . -.\" -------------------------------------------------------------------- +.\" .SS "Draft Mode" -.\" -------------------------------------------------------------------- +.\" . -Writing groff macros is easy when the escaping mechanism is temporarily +Writing macros is easy when the escaping mechanism is temporarily disabled. . -In groff, this is done by enclosing the macro definition(s) into a -pair of +This is done by enclosing the macro definition(s) into a pair of .B .eo and .B .ec @@ -1003,12 +959,12 @@ do the backslash doubling as a final step; do not forget to remove the request. . . -.\" -------------------------------------------------------------------- +.\" .SS "Tips for Macro Definitions" -.\" -------------------------------------------------------------------- +.\" . .IP \(bu -Start every line with a dot, for example, by using the groff request +Start every line with a dot, for example, by using the request .B .nop for text lines, or write your own macro that handles also text lines with a leading dot. @@ -1047,13 +1003,13 @@ almost-empty lines (this is, lines which have a leading dot and nothing else) for a better structuring. . .IP \(bu -To increase readability, use groff's indentation facility for requests +To increase readability, use the indentation facility for requests and macro calls (arbitrary whitespace after the leading dot). . . -.\" -------------------------------------------------------------------- +.\" .SS "Diversions" -.\" -------------------------------------------------------------------- +.\" . Diversions can be used to implement quite advanced programming constructs. @@ -1107,9 +1063,9 @@ Then everything between each call of this macro pair is stored within the diversion and can be manipulated from within the macros. . . -.\" -------------------------------------------------------------------- +.\" .SH FILES -.\" -------------------------------------------------------------------- +.\" . All macro names must be named .IB name .tmac @@ -1130,13 +1086,13 @@ a colon separated list of these constitutes the The search sequence for macro files is (in that order): . .IP \(bu -the directories specified with troff/groff's +the directories specified with the .B \-M command line option . .IP \(bu the directories given in the -.B $GROFF_TMAC_PATH +.B $@U_ROFF@_TMAC_PATH environment variable . .IP \(bu @@ -1181,23 +1137,25 @@ the main tmac directory, being in this installation . . -.\" -------------------------------------------------------------------- +.\" .SH ENVIRONMENT -.\" -------------------------------------------------------------------- +.\" . .TP -.B $GROFF_TMAC_PATH +.B $@U_ROFF@_TMAC_PATH A colon separated list of additional tmac directories in which to search for macro files. . See the previous section for a detailed description. . . -.\" -------------------------------------------------------------------- +.\" .SH AUTHOR -.\" -------------------------------------------------------------------- +.\" . -Copyright (C) 2000, 2001, 2002, 2003, 2004, 2006, 2007, 2008, 2009 +Copyright (c) 2014 Steffen (Daode) Nurpmeso . + +Copyright (C) 2000 - 2004, 2006 - 2009 Free Software Foundation, Inc. . .P @@ -1211,57 +1169,39 @@ GNU copyleft site .UE . . .P -This document is part of -.IR groff , -the GNU roff distribution. -. -It was written by -.MT bwarken@mayn.de +This document was written by +.MT bwarken@mayn.de Bernd Warken -.ME ; -it is maintained by -.MT wl@gnu.org -Werner Lemberg .ME . . -. -.\" -------------------------------------------------------------------- +.\" .SH "SEE ALSO" -.\" -------------------------------------------------------------------- -. -A complete reference for all parts of the groff system is found in the -groff -.BR info (1) -file. -. +.\" . -.TP -.BR groff (@MAN1EXT@) -an overview of the groff system. +.BR @L_ROFF@ (@MAN1EXT@) +an overview of the @T_ROFF@ system. . . .TP -.BR groff_man (@MAN7EXT@), -.TQ -.BR groff_mdoc (@MAN7EXT@), +.BR @L_ROFF@_man (@MAN7EXT@), .TQ -.BR groff_me (@MAN7EXT@), +.BR @L_ROFF@_mdoc (@MAN7EXT@), .TQ -.BR groff_mm (@MAN7EXT@), +.BR @L_ROFF@_me (@MAN7EXT@), .TQ -.BR groff_mom (@MAN7EXT@), +.BR @L_ROFF@_mm (@MAN7EXT@), .TQ -.BR groff_ms (@MAN7EXT@), +.BR @L_ROFF@_ms (@MAN7EXT@), .TQ -.BR groff_trace (@MAN7EXT@), +.BR @L_ROFF@_trace (@MAN7EXT@), .TQ -.BR groff_www (@MAN7EXT@). -the groff tmac macro packages. +.BR @L_ROFF@_www (@MAN7EXT@). +the @T_ROFF@ tmac macro packages. . . .TP -.BR groff (@MAN7EXT@) -the groff language. +.BR @L_ROFF@ (@MAN7EXT@) +the @T_ROFF@ language. . . .P @@ -1270,6 +1210,4 @@ The Filesystem Hierarchy Standard is available at the FHS web site .UE . . -.\" Local Variables: -.\" mode: nroff -.\" End: +.\" s-ts-mode diff --git a/man/roff.man b/man/roff.7.in similarity index 81% rename from man/roff.man rename to man/roff.7.in index 67fb203e..c1923e62 100644 --- a/man/roff.man +++ b/man/roff.7.in @@ -1,10 +1,10 @@ -'\" t +'\" t -- preprocess: tbl(1) .ig -roff.man +@ roff.7 -This file is part of groff, the GNU roff type-setting system. +Copyright (c) 2014 Steffen (Daode) Nurpmeso . -Copyright (C) 2000, 2001, 2002, 2003, 2004, 2006, 2007, 2008 +Copyright (C) 2000 - 2004, 2006 - 2008 Free Software Foundation, Inc. written by Bernd Warken maintained by Werner Lemberg @@ -15,12 +15,12 @@ any later version published by the Free Software Foundation; with the Invariant Sections being this .ig-section and AUTHORS, with no Front-Cover Texts, and with no Back-Cover Texts. -A copy of the Free Documentation License is included as a file called -FDL in the main directory of the groff source package. +You should have received a copy of the Free Documentation License +as part of the file COPYING; also located in the main directory of the +source package of this program. .. . -. -.\" -------------------------------------------------------------------- +.\" .\" Local macros . .de Esc @@ -39,26 +39,25 @@ FDL in the main directory of the groff source package. .. . . -.\" -------------------------------------------------------------------- +.\" .\" Title -.\" -------------------------------------------------------------------- +.\" . -.TH ROFF @MAN7EXT@ "@MDATE@" "Groff Version @VERSION@" +.TH ROFF @MAN7EXT@ "@MDATE@" "@T_ROFF@ v@VERSION@" .SH NAME roff \- concepts and history of roff typesetting . . -.\" -------------------------------------------------------------------- +.\" .SH DESCRIPTION -.\" -------------------------------------------------------------------- +.\" . .I roff is the general name for a set of text formatting programs, known under names like .BR troff , .BR nroff , -.BR ditroff , -.BR groff , +.BR ditroff etc. . A @@ -74,12 +73,10 @@ system as a core package. The most common .I roff system today is the free software implementation \f[CR]GNU\f[] -.IR roff , -.BR groff (@MAN1EXT@). -. -.I groff -implements the look-and-feel and functionality of its ancestors, with many -extensions. +.IR roff. +@T_ROFF@ is an deriviative. +Both implement the look-and-feel and functionality of its ancestors, with +many extensions. . .P The ancestry of @@ -123,15 +120,15 @@ some usage aspects common to all versions, details on the .I roff pipeline, which is usually hidden behind front-ends like -.BR groff (@MAN1EXT@); +.BR @L_ROFF@ (@MAN1EXT@); a general overview of the formatting language; some tips for editing .I roff files; and many pointers to further readings. . . -.\" -------------------------------------------------------------------- +.\" .SH "HISTORY" -.\" -------------------------------------------------------------------- +.\" . Document formatting by computer dates back to the 1960s. . @@ -141,9 +138,9 @@ system itself is intimately connected to the Unix operating system, but its roots go back to the earlier operating systems CTSS and Multics. . . -.\" -------------------------------------------------------------------- +.\" .SS "The Predecessor RUNOFF" -.\" -------------------------------------------------------------------- +.\" . .BR roff 's ancestor @@ -192,9 +189,9 @@ were ported to the GCOS system at Bell Labs when BTL left the development of Multics. . . -.\" -------------------------------------------------------------------- +.\" .SS "The Classical nroff/troff System" -.\" -------------------------------------------------------------------- +.\" . At BTL, there was a need to drive the .I Graphic Systems CAT @@ -300,7 +297,7 @@ In 1979, these novelties were described in the paper This new .I troff version is the basis for all existing newer troff systems, including -.IR groff . +.IR @L_ROFF@ . . On some systems, this .I device independent troff @@ -314,9 +311,9 @@ programs already provide the full capabilities automatically. . . -.\" -------------------------------------------------------------------- +.\" .SS "Availability" -.\" -------------------------------------------------------------------- +.\" . The source code of both the ancient Unix and classical .I troff @@ -327,9 +324,9 @@ cf.\& section .BR "SEE ALSO" . . . -.\" -------------------------------------------------------------------- +.\" .SS "Free roff" -.\" -------------------------------------------------------------------- +.\" . The most important free .I roff @@ -347,15 +344,11 @@ It was called (\f[CR]GNU\f[] .IR roff ). . +Further forks exists. See -.BR groff (@MAN1EXT@) +.BR @L_ROFF@ (@MAN1EXT@) for an overview. . -.P -The -.I groff -system is still actively developed. -. It is compatible to the classical .IR troff , but many extensions were added. @@ -365,26 +358,10 @@ It is the first system that is available on almost all operating systems \[en] and it is free. . -This makes -.I groff -the de-facto -.I roff -standard today. -. -.P -An alternative is -.IR "Gunnar Ritter" 's -.UR http://\:heirloom.sf.net -Heirloom Documentation Tools -.UE -project, started in 2005, which provides enhanced versions of the various -roff tools found in the OpenSolaris and Plan\~9 operating systems, now -available under free licenses. -. . -.\" -------------------------------------------------------------------- +.\" .SH "USING ROFF" -.\" -------------------------------------------------------------------- +.\" . Most people won't even notice that they are actually using .IR roff . @@ -393,16 +370,6 @@ When you read a system manual page (man page) .I roff is working in the background. . -.I roff -documents can be viewed with a native viewer called -.BR \%xditview (1x), -a standard program of the X window distribution, see -.BR X (7x). -. -But using -.I roff -explicitly isn't difficult either. -. .P Some .I roff @@ -416,22 +383,12 @@ implementation .BR groff (@MAN1EXT@) provides command line options to avoid the long command pipes of classical -.IR troff ; -a program -.BR grog (@MAN1EXT@) -tries to guess from the document which arguments should be used for a -run of -.BR groff ; -people who do not like specifying command line options should try the -.BR groffer (@MAN1EXT@) -program for graphically displaying -.I groff -files and man pages. +.IR troff . . . -.\" -------------------------------------------------------------------- +.\" .SS "The roff Pipe" -.\" -------------------------------------------------------------------- +.\" . Each .I roff @@ -491,9 +448,9 @@ macro packages need to know about the gory details. . . . -.\" -------------------------------------------------------------------- +.\" .SS "Preprocessors" -.\" -------------------------------------------------------------------- +.\" . A .I roff @@ -560,9 +517,9 @@ grn@for including \fBgremlin\fR(1) pictures. .TE .RE . -.\" -------------------------------------------------------------------- +.\" .SS "Formatter Programs" -.\" -------------------------------------------------------------------- +.\" . A .I roff formatter @@ -590,8 +547,8 @@ or . This language was first specified in .IR "[CSTR\~#97]" ; -its \f[CR]GNU\f[] extension is documented in -.BR groff_out (@MAN5EXT@). +its @T_ROFF@ extension is documented in +.BR @L_ROFF@_out (@MAN5EXT@). . The intermediate output language is a kind of assembly language compared to the high-level @@ -622,9 +579,9 @@ Often, the name is used as a general term to refer to both formatters. . . -.\" -------------------------------------------------------------------- +.\" .SS "Devices and Postprocessors" -.\" -------------------------------------------------------------------- +.\" . Devices are hardware interfaces like printers, text or graphical terminals, etc., or software interfaces such as a conversion into a @@ -667,7 +624,7 @@ For example, the Postscript device in classical .I troff had a resolution of 720 units per inch, while -.IR groff 's +.IR @T_ROFF@ 's .I ps device has 72000, a refinement of factor 100. . @@ -677,9 +634,9 @@ printer-like hardware, so it isn't necessary to write a special hardware postprocessor for each printer. . . -.\" -------------------------------------------------------------------- +.\" .SH "ROFF PROGRAMMING" -.\" -------------------------------------------------------------------- +.\" . Documents using .I roff @@ -704,9 +661,9 @@ internals of the language. . . -.\" -------------------------------------------------------------------- +.\" .SS "Macro Packages" -.\" -------------------------------------------------------------------- +.\" . Macro packages are collections of macros that are suitable to format a special kind of documents in a convenient way. @@ -725,19 +682,19 @@ positions. . Details on the naming of macro packages and their placement is found in -.BR groff_tmac (@MAN5EXT@). +.BR @L_ROFF@_tmac (@MAN5EXT@). . .P A macro package that is to be used in a document can be announced to the formatter by the command line option .BR \-m , see -.BR troff (@MAN1EXT@), +.BR @L_TROFF@ (@MAN1EXT@), or it can be specified within a document using the file inclusion requests of the .I roff language, see -.BR groff (@MAN7EXT@). +.BR @L_ROFF@ (@MAN7EXT@). . .P Famous classical macro packages are @@ -759,9 +716,9 @@ and .IR "Memorandum Macros\/" ). . . -.\" -------------------------------------------------------------------- +.\" .SS "The roff Formatting Language" -.\" -------------------------------------------------------------------- +.\" . The classical .I roff @@ -832,9 +789,9 @@ and its value can be retrieved by the escape sequence .BR "\[rs]n" . . . -.\" -------------------------------------------------------------------- +.\" .SH "FILE NAME EXTENSIONS" -.\" -------------------------------------------------------------------- +.\" . Manual pages (man pages) take the section number as a file name extension, e.g., the filename for this document is @@ -897,9 +854,9 @@ where is either a system supplied command or a shell script of your own. . . -.\" -------------------------------------------------------------------- +.\" .SH "EDITING ROFF" -.\" -------------------------------------------------------------------- +.\" . The best program for editing a .I roff @@ -1042,9 +999,9 @@ an extension of the program. . . -.\" -------------------------------------------------------------------- +.\" .SH "SEE ALSO" -.\" -------------------------------------------------------------------- +.\" . There is a lot of documentation on .IR roff . @@ -1052,13 +1009,13 @@ There is a lot of documentation on The original papers on classical .I troff are still available, and all aspects of -.I groff +.I @T_ROFF@ are documented in great detail. . . -.\" -------------------------------------------------------------------- +.\" .SS "Internet sites" -.\" -------------------------------------------------------------------- +.\" . .TP troff.org @@ -1133,19 +1090,17 @@ documents on programming. .TP \f[CR]GNU\f[] \f[I]roff\f[] .UR http://\:www.gnu.org/\:software/\:groff -The groff web site +The GNU troff web site .UE provides the free .I roff implementation -.IR groff , -the actual standard -.IR roff . +.IR groff . . . -.\" -------------------------------------------------------------------- +.\" .SS "Historical roff Documentation" -.\" -------------------------------------------------------------------- +.\" . Many classical .B troff @@ -1207,9 +1162,9 @@ J. L. Bentley, L. W. Jelinski, and B. W. Kernighan, Bell Labs, April 1986. . . -.\" -------------------------------------------------------------------- +.\" .SS "Manual Pages" -.\" -------------------------------------------------------------------- +.\" . Due to its complex structure, a full .I roff @@ -1223,23 +1178,25 @@ implementations. . .P In -.IR groff , +.IR @T_ROFF@ , the man page -.BR groff (@MAN1EXT@) +.BR @L_ROFF@ (@MAN1EXT@) contains a survey of all documentation available in -.IR groff . +.IR @T_ROFF@ . . .P On other systems, you are on your own, but -.BR troff (1) +.BR troff (@MAN1EXT@) might be a good starting point. . . -.\" -------------------------------------------------------------------- +.\" .SH AUTHORS -.\" -------------------------------------------------------------------- +.\" . -Copyright (C) 2000, 2001, 2002, 2003, 2004, 2006, 2007, 2008 +Copyright (c) 2014 Steffen (Daode) Nurpmeso . + +Copyright (C) 2000 - 2004, 2006 - 2008 Free Software Foundation, Inc. . .P @@ -1253,25 +1210,9 @@ GNU copyleft site .UE . . .P -This document is part of -.IR groff , -the \f[CR]GNU\f[] -.I roff -distribution. -. -It was written by +This document was written by .MT bwarken@mayn.de Bernd Warken -.ME ; -it is maintained by -.MT wl@gnu.org -Werner Lemberg .ME . . -.\" -------------------------------------------------------------------- -.\" Emacs setup -.\" -------------------------------------------------------------------- -. -.\" Local Variables: -.\" mode: nroff -.\" End: +.\" s-ts-mode -- 2.11.4.GIT