[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Groff-commit] GNU troff branch, master, updated. 309660d6de892de92c9b4b
|
From: |
Bernd Warken |
|
Subject: |
[Groff-commit] GNU troff branch, master, updated. 309660d6de892de92c9b4b89c160cb4e4606736b |
|
Date: |
Sat, 04 Jan 2014 19:23:42 +0000 |
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "GNU troff".
http://git.sv.gnu.org/gitweb/?p=groff.git;a=commitdiff;h=309660d6de892de92c9b4b89c160cb4e4606736b
The branch, master has been updated
via 309660d6de892de92c9b4b89c160cb4e4606736b (commit)
from 3949425d5304d86e740ec0019b2bcc1131a549fb (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit 309660d6de892de92c9b4b89c160cb4e4606736b
Author: Bernd Warken <address@hidden>
Date: Sat Jan 4 20:21:05 2014 +0100
Add request .FONT to an-ext.tmac.
Put under GPL2 and reorder groff_man.man.
-----------------------------------------------------------------------
Summary of changes:
ChangeLog | 13 +-
tmac/an-ext.tmac | 20 ++
tmac/groff_man.man | 700 +++++++++++++++++++++++++++++-----------------------
3 files changed, 421 insertions(+), 312 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 11d45d3..05f74ab 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,10 +1,17 @@
+2013-12-23 Bernd Warken <address@hidden>
+
+ * groff/tmac/an-ext.tmac: add new request .FONT for using
+ different font names on a single line.
+
+ * groff/tmac/groff_man.man: put under GPL2, reordered and enhanced.
+
2013-01-02 Deri James <address@hidden>
* src/devices/gropdf/gropdf.pl: gropdf use to fail when handling
- output from preconv, now works.
+ output from preconv, now works.
* src/devices/gropdf/pdfmom.pl: can now be used as a pipeline, and
- improvements made to its switch handling and use with preconv.
+ improvements made to its switch handling and use with preconv.
* tmac/pdf.tmac: changes to support preconv.
@@ -19,7 +26,7 @@
2013-12-23 Bernd Warken <address@hidden>
- groff/src/roff/groff/groff.cpp: add groff option `-G' to the
+ * groff/src/roff/groff/groff.cpp: add groff option `-G' to the
documentation in `synopsis()'.
2013-12-06 Mike Frysinger <address@hidden>
diff --git a/tmac/an-ext.tmac b/tmac/an-ext.tmac
index 3816025..30f8c62 100644
--- a/tmac/an-ext.tmac
+++ b/tmac/an-ext.tmac
@@ -181,6 +181,26 @@
..
.
.
+.\" .FONT (<font name> <text> [<font name> <text> ...])
+.\" Print in different fonts, e.g. using the font names R, I, B, CR, CI, CB
+.de FONT
+. if (\\n[.$] = 0) \{\
+. nop \&\f[P]\&
+. return
+. \}
+. ds result \&
+. while (\\n[.$] >= 2) \{\
+. as result \,\f[\\$1]\\$2
+. if !"\\$1"P" .as result \f[P]
+. shift 2
+. \}
+. if (\\n[.$] = 1) .as result \,\f[\\$1]
+. nh
+. nop \\*[result]\&
+. hy
+..
+.
+.
.\" Start example.
.de EX
. nr mE \\n(.f
diff --git a/tmac/groff_man.man b/tmac/groff_man.man
index e885294..b21e675 100644
--- a/tmac/groff_man.man
+++ b/tmac/groff_man.man
@@ -1,21 +1,25 @@
.ig
-Copyright (C) 1999-2005, 2007-2009, 2011
-Free Software Foundation, Inc.
+Copyright (C) 1999-2005, 2007-2009, 2011, 2014
+ Free Software Foundation, Inc.
-Permission is granted to make and distribute verbatim copies of this
-manual provided the copyright notice and this permission notice are
-preserved on all copies.
+Last Update: 4 Jan 2014
-Permission is granted to copy and distribute modified versions of this
-manual under the conditions for verbatim copying, provided that the
-entire resulting derived work is distributed under the terms of a
-permission notice identical to this one.
+This file is part of `GNU groff'.
-Permission is granted to copy and distribute translations of this
-manual into another language, under the above conditions for modified
-versions, except that this permission notice may be included in
-translations approved by the Free Software Foundation instead of in
-the original English.
+ `GNU groff' is free software: you can redistribute it and/or modify it
+under the terms of the `GNU General Public License' as published by the
+`Free Software Foundation', either version 2 of the License, or (at your
+option) any later version.
+
+ `GNU groff' is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the `GNU
+General Public License' for more details.
+
+ You should have received a copy of the 'GNU General Public License`
+along with `groff', see the files `COPYING' and `LICENSE' in the top
+directory of the `groff' source package. If not, see
+<http://www.gnu.org/licenses/>.
..
.
.
@@ -23,14 +27,12 @@ the original English.
.
.
.\" ----------------------------------------------------------------
-.
.SH NAME
.
groff_man \- groff `man' macros to support generation of man pages
.
.
.\" -----------------------------------------------------------------
-.
.SH SYNOPSIS
.
.SY "groff\ \-man"
@@ -48,7 +50,6 @@ groff_man \- groff `man' macros to support generation of man
pages
.
.
.\" -----------------------------------------------------------------
-.
.SH DESCRIPTION
.
The
@@ -64,7 +65,6 @@ package.
.
.
.\" -----------------------------------------------------------------
-.
.SH OPTIONS
.
The
@@ -72,6 +72,7 @@ The
macros understand the following command line options (which define
various registers).
.
+.
.TP
.B \-rcR=1
This option (the default if in nroff mode) creates a single, very
@@ -81,17 +82,20 @@ Say
.B \-rcR=0
to disable it.
.
+.
.TP
.B \-rC1
If more than one manual page is given on the command line, number the
pages continuously, rather than starting each at\~1.
.
+.
.TP
.B \-rD1
Double-sided printing.
.
Footers for even and odd pages are formatted differently.
.
+.
.TP
.BI \-rFT= dist
Set distance of the footer relative to the bottom of the page if
@@ -99,6 +103,7 @@ negative or relative to the top if positive.
.
The default is -0.5i.
.
+.
.TP
.BI \-rHY= flags
Set hyphenation flags.
@@ -110,6 +115,7 @@ of a word.
.
These values are additive; the default is\~14.
.
+.
.TP
.BI \-rIN= width
Set body text indentation to
@@ -123,6 +129,7 @@ For
this value should always be an integer multiple of unit `n' to get
consistent indentation.
.
+.
.TP
.BI \-rLL= line-length
Set line length.
@@ -139,6 +146,7 @@ mode and 6.5i in
.I troff
mode.
.
+.
.IP
Note that the use of a `.ll' request to initialize the line length
is supported for backward compatibility with some versions of the
@@ -161,6 +169,7 @@ request preceding the use of the `TH' macro,
.I does
set a line length of 65n.
.
+.
.TP
.BI \-rLT= title-length
Set title length.
@@ -168,6 +177,7 @@ Set title length.
If this option is not given, the title length defaults to the line
length.
.
+.
.TP
.BI \-rP nnn
Enumeration of pages start with
@@ -182,12 +192,14 @@ points
.RI ( xx
can be 10, 11, or\~12) rather than 10\~points.
.
+.
.TP
.BI \-rSN= width
Set sub-subheading indentation to
.IR width .
The default is 3n.
.
+.
.TP
.BI \-rX nnn
After page\~\c
@@ -203,7 +215,6 @@ numbers: 1, 2, 2a, 2b, 2c, etc.
.
.
.\" -----------------------------------------------------------------
-.
.SH USAGE
.
This section describes the available macros for manual pages.
@@ -215,89 +226,39 @@ which is loaded immediately after the
.B man
package.
.
-.TP
-.BI .TH " title section \fR[\fPextra1\fR]\fP \fR[\fPextra2\fR]\fP
\fR[\fPextra3\fR]"
-Set the title of the
-.I man\~page
-to
-.I title
-and the section to
-.IR section ,
-which must take on a value between 1 and\~8.
-.
-The value
-.I section
-may also have a string appended, e.g. `.pm', to indicate a specific
-subsection of the
-.IR \%man\~pages .
-Both
-.I title
-and
-.I section
-are positioned at the left and right in the header line (with
-.I section
-in parentheses immediately appended to
-.IR title .
-.I extra1
-is positioned in the middle of the footer line.
-.I extra2
-is positioned at the left in the footer line (or at the left on
-even pages and at the right on odd pages if double-sided printing is
-active).
-.I extra3
-is centered in the header line.
-.
-.IP
-For HTML output, headers and footers are completely suppressed.
-.
-.IP
-Additionally, this macro starts a new page; the new line number is\~1
-again (except if the `-rC1' option is given on the command line) --
-this feature is intended only for formatting multiple
-.IR \%man\~pages ;
-a single
-.I \%man\~page
-should contain exactly one
-.B TH
-macro at the beginning of the file.
.
.TP
-.BI .SH " \fR[\fPtext for a heading\fR]\fP"
-Set up an unnumbered section heading sticking out to the left.
+.B .EX
+.TQ
+.B .EE
+Example/End Example.
.
-Prints out all the text following
-.B SH
-up to the end of the line (or the text in the next input line if there
-is no argument to
-.BR SH )
-in bold face
-(or the font specified by the string
-.BR HF ),
-one size larger than the base document size.
+After
+.BR EX ,
+filling is disabled and the font is set to constant-width.
.
-Additionally, the left margin and the indentation for the following
-text is reset to the default values.
+This is useful for formatting code, command, and
+configuration-file examples.
.
-.TP
-.BI .SS " \fR[\fPtext for a heading\fR]\fP"
-Set up a secondary, unnumbered section heading.
+The
+.B EE
+macro restores filling and restores the previous font.
.
-Prints out all the text following
-.B SS
-up to the end of the line (or the text in the next input line if there
-is no argument to
-.BR SS )
-in bold face
-(or the font specified by the string
-.BR HF ),
-at the same size as the base document size.
+.IP
+These macros are defined on many (but not all) legacy Unix systems
+running classic troff.
+.
+To be certain your page will be portable to those systems, copy
+their definitions from the
+.B \%an-ext.tmac
+file of a
+.BR groff
+installation.
.
-Additionally, the left margin and the indentation for the following
-text is reset to the default values.
.
.TP
-.BI .TP " \fR[\fPnnn\fR]\fP"
-Set up an indented paragraph with label.
+.BI .HP " \fR[\fPnnn\fR]\fP"
+Set up a paragraph with hanging left indentation.
.
The indentation is set to
.I nnn
@@ -309,70 +270,36 @@ or
.B HP
(or to the default value if none of them have been used yet).
.
-.IP
-The first input line of text following this macro is interpreted as a
-string to be printed flush-left, as it is appropriate for a label.
-.
-It is not interpreted as part of a paragraph, so there is no attempt
-to fill the first line with text from the following input lines.
-.
-Nevertheless, if the label is not as wide as the indentation the
-paragraph starts at the same line (but indented), continuing on the
-following lines.
-.
-If the label is wider than the indentation the descriptive part of the
-paragraph begins on the line following the label, entirely indented.
-.
-Note that neither font shape nor font size of the label is set to a
-default value; on the other hand, the rest of the text has default
-font settings.
-.
-.IP
-The
-.B TP
-macro is the macro used for the explanations you are just reading.
+Font size and face are reset to its default values.
.
-.TP
-.B .TQ
-The
-.B TQ
-macro sets up header continuation for a .TP macro.
+The following paragraph illustrates the effect of this macro with
+hanging indentation set to\~4 (enclosed by
+.B .RS
+and
+.B .RE
+to set the left margin temporarily to the current indentation):
.
-With it, you can stack up any number of labels (such as in a
-glossary, or list of commands) before beginning the indented
-paragraph.
+.RS
+.HP 4
+This is a paragraph following an invocation of the
+.B HP
+macro.
.
-For an example, look just past the next paragraph.
+As you can see, it produces a paragraph where all lines but the first
+are indented.
+.RE
.
.IP
-This macro is not defined on legacy Unix systems running classic
-troff.
-.
-To be certain your page will be portable to those systems,
-copy its definition from the
-.B \%an-ext.tmac
-file of a
-.BR groff
-installation.
-.
-.TP
-.B .LP
-.TQ
-.B .PP
-.TQ
-.B .P
-These macros are mutual aliases.
+Use of this presentation-level macro is deprecated.
.
-Any of them causes a line break at the current position, followed by a
-vertical space downwards by the amount specified by the
-.B PD
-macro.
+While it is universally portable to legacy Unix systems, a hanging
+indentation cannot be expressed naturally under HTML, and many
+HTML-based manual viewers simply interpret it as a starter for a
+normal paragraph.
.
-The font size and shape are reset to the default value (normally 10pt
-Roman).
+Thus, any information or distinction you tried to express with the
+indentation may be lost.
.
-Finally, the current left margin and the indentation is reset to the
-default values.
.
.TP
.BI .IP " \fR[\fPdesignator\fR]\fP \fR[\fPnnn\fR]\fP"
@@ -426,49 +353,41 @@ This macro produces an unindented label followed by an
indented
paragraph.
.RE
.
+.
.TP
-.BI .HP " \fR[\fPnnn\fR]\fP"
-Set up a paragraph with hanging left indentation.
+.B .LP
+.TQ
+.B .PP
+.TQ
+.B .P
+These macros are mutual aliases.
.
-The indentation is set to
-.I nnn
-if that argument is supplied (the default unit is `n' if omitted),
-otherwise it is set to the previous indentation value specified with
-.BR TP ,
-.BR IP ,
-or
-.B HP
-(or to the default value if none of them have been used yet).
+Any of them causes a line break at the current position, followed by a
+vertical space downwards by the amount specified by the
+.B PD
+macro.
.
-Font size and face are reset to its default values.
+The font size and shape are reset to the default value (normally 10pt
+Roman).
.
-The following paragraph illustrates the effect of this macro with
-hanging indentation set to\~4 (enclosed by
-.B .RS
-and
-.B .RE
-to set the left margin temporarily to the current indentation):
+Finally, the current left margin and the indentation is reset to the
+default values.
.
-.RS
-.HP 4
-This is a paragraph following an invocation of the
-.B HP
-macro.
.
-As you can see, it produces a paragraph where all lines but the first
-are indented.
+.TP
+.BI .RE " \fR[\fPnnn\fR]\fP"
+This macro moves the left margin back to level
+.IR nnn ,
+restoring the previous left margin.
.
-.RE
-.IP
-Use of this presentation-level macro is deprecated.
+If no argument is given, it moves one level back.
.
-While it is universally portable to legacy Unix systems, a hanging
-indentation cannot be expressed naturally under HTML, and many
-HTML-based manual viewers simply interpret it as a starter for a
-normal paragraph.
+The first level (i.e., no call to
+.B RS
+yet) has number\~1, and each call to
+.B RS
+increases the level by\~1.
.
-Thus, any information or distinction you tried to express with the
-indentation may be lost.
.
.TP
.BI .RS " \fR[\fPnnn\fR]\fP"
@@ -484,53 +403,158 @@ or
.
The indentation value is then set to the default.
.
+.
.IP
Calls to the
.B RS
macro can be nested.
.
+.
.TP
-.BI .RE " \fR[\fPnnn\fR]\fP"
-This macro moves the left margin back to level
-.IR nnn ,
-restoring the previous left margin.
+.BI .SH " \fR[\fPtext for a heading\fR]\fP"
+Set up an unnumbered section heading sticking out to the left.
.
-If no argument is given, it moves one level back.
+Prints out all the text following
+.B SH
+up to the end of the line (or the text in the next input line if there
+is no argument to
+.BR SH )
+in bold face
+(or the font specified by the string
+.BR HF ),
+one size larger than the base document size.
+.
+Additionally, the left margin and the indentation for the following
+text is reset to the default values.
.
-The first level (i.e., no call to
-.B RS
-yet) has number\~1, and each call to
-.B RS
-increases the level by\~1.
.
.TP
-.B .EX
-.TQ
-.B .EE
-Example/End Example.
+.BI .SS " \fR[\fPtext for a heading\fR]\fP"
+Set up a secondary, unnumbered section heading.
.
-After
-.BR EX ,
-filling is disabled and the font is set to constant-width.
+Prints out all the text following
+.B SS
+up to the end of the line (or the text in the next input line if there
+is no argument to
+.BR SS )
+in bold face
+(or the font specified by the string
+.BR HF ),
+at the same size as the base document size.
.
-This is useful for formatting code, command, and
-configuration-file examples.
+Additionally, the left margin and the indentation for the following
+text is reset to the default values.
+.
+.
+.TP
+.BI .TH " title section \fR[\fPextra1\fR]\fP \fR[\fPextra2\fR]\fP
\fR[\fPextra3\fR]"
+Set the title of the
+.I man\~page
+to
+.I title
+and the section to
+.IR section ,
+which must take on a value between 1 and\~8.
+.
+The value
+.I section
+may also have a string appended, e.g. `.pm', to indicate a specific
+subsection of the
+.IR \%man\~pages .
+Both
+.I title
+and
+.I section
+are positioned at the left and right in the header line (with
+.I section
+in parentheses immediately appended to
+.IR title .
+.I extra1
+is positioned in the middle of the footer line.
+.I extra2
+is positioned at the left in the footer line (or at the left on
+even pages and at the right on odd pages if double-sided printing is
+active).
+.I extra3
+is centered in the header line.
+.
+.IP
+For HTML output, headers and footers are completely suppressed.
+.
+.IP
+Additionally, this macro starts a new page; the new line number is\~1
+again (except if the `-rC1' option is given on the command line) --
+this feature is intended only for formatting multiple
+.IR \%man\~pages ;
+a single
+.I \%man\~page
+should contain exactly one
+.B TH
+macro at the beginning of the file.
.
+.
+.TP
+.BI .TP " \fR[\fPnnn\fR]\fP"
+Set up an indented paragraph with label.
+.
+The indentation is set to
+.I nnn
+if that argument is supplied (the default unit is `n' if omitted),
+otherwise it is set to the previous indentation value specified with
+.BR TP ,
+.BR IP ,
+or
+.B HP
+(or to the default value if none of them have been used yet).
+.
+.IP
+The first input line of text following this macro is interpreted as a
+string to be printed flush-left, as it is appropriate for a label.
+.
+It is not interpreted as part of a paragraph, so there is no attempt
+to fill the first line with text from the following input lines.
+.
+Nevertheless, if the label is not as wide as the indentation the
+paragraph starts at the same line (but indented), continuing on the
+following lines.
+.
+If the label is wider than the indentation the descriptive part of the
+paragraph begins on the line following the label, entirely indented.
+.
+Note that neither font shape nor font size of the label is set to a
+default value; on the other hand, the rest of the text has default
+font settings.
+.
+.IP
The
-.B EE
-macro restores filling and restores the previous font.
+.B TP
+macro is the macro used for the explanations you are just reading.
+.
+.
+.TP
+.B .TQ
+The
+.B TQ
+macro sets up header continuation for a .TP macro.
+.
+With it, you can stack up any number of labels (such as in a
+glossary, or list of commands) before beginning the indented
+paragraph.
+.
+For an example, look just past the next paragraph.
.
.IP
-These macros are defined on many (but not all) legacy Unix systems
-running classic troff.
+This macro is not defined on legacy Unix systems running classic
+troff.
.
-To be certain your page will be portable to those systems, copy
-their definitions from the
+To be certain your page will be portable to those systems,
+copy its definition from the
.B \%an-ext.tmac
file of a
.BR groff
installation.
.
+.
.PP
To summarize, the following macros cause a line break with the
insertion of vertical space (which amount can be changed with the
@@ -556,20 +580,20 @@ also cause a break but no insertion of vertical space.
.
.
.\" -----------------------------------------------------------------
-.
.SH "MACROS TO SET FONTS"
.
The standard font is Roman; the default text size is 10\~point.
.
-.TP
-.BI .SM " \fR[\fPtext\fR]\fP"
-Causes the text on the same line or the text on the next input line to
-appear in a font that is one point size smaller than the default font.
.
.TP
-.BI .SB " \fR[\fPtext\fR]\fP"
-Causes the text on the same line or the text on the next input line to
-appear in boldface font, one point size smaller than the default font.
+.BI .B " \fR[\fPtext\fR]\fP"
+Causes
+.I text
+to appear in bold face.
+.
+If no text is present on the line where the macro is called the text
+of the next input line appears in bold face.
+.
.
.TP
.BI ".BI " text
@@ -589,33 +613,53 @@ would cause `this' and `that' to appear in bold face,
while `word and'
appears in italics.
.RE
.
+.
.TP
-.BI ".IB " text
-Causes text to appear alternately in italic and bold face.
+.BI ".BR " text
+Causes text on the same line to appear alternately in bold face and
+roman.
.
The text must be on the same line as the macro call.
.
+.
.TP
-.BI ".RI " text
-Causes text on the same line to appear alternately in roman and
-italic.
+.FONT B .FONT I " <font name> <text> " R [ I "<font name> <text> ..." R ]
+Use different font names on a single line.
+.
+Useful font names include
+.BR R ,
+.BR I ,
+.BR B ,
+.BR CR ,
+.BR CI ,
+.BR CB .
.
-The text must be on the same line as the macro call.
.
.TP
-.BI ".IR " text
-Causes text on the same line to appear alternately in italic and
-roman.
+.BI .I " \fR[\fPtext\fR]\fP"
+Causes
+.I text
+to appear in italic.
+.
+If no text is present on the line where the macro is called the text
+of the next input line appears in italic.
+.
+.
+.TP
+.BI ".IB " text
+Causes text to appear alternately in italic and bold face.
.
The text must be on the same line as the macro call.
.
+.
.TP
-.BI ".BR " text
-Causes text on the same line to appear alternately in bold face and
+.BI ".IR " text
+Causes text on the same line to appear alternately in italic and
roman.
.
The text must be on the same line as the macro call.
.
+.
.TP
.BI ".RB " text
Causes text on the same line to appear alternately in roman and bold
@@ -623,27 +667,28 @@ face.
.
The text must be on the same line as the macro call.
.
+.
.TP
-.BI .B " \fR[\fPtext\fR]\fP"
-Causes
-.I text
-to appear in bold face.
+.BI ".RI " text
+Causes text on the same line to appear alternately in roman and
+italic.
+.
+The text must be on the same line as the macro call.
.
-If no text is present on the line where the macro is called the text
-of the next input line appears in bold face.
.
.TP
-.BI .I " \fR[\fPtext\fR]\fP"
-Causes
-.I text
-to appear in italic.
+.BI .SB " \fR[\fPtext\fR]\fP"
+Causes the text on the same line or the text on the next input line to
+appear in boldface font, one point size smaller than the default font.
.
-If no text is present on the line where the macro is called the text
-of the next input line appears in italic.
.
+.TP
+.BI .SM " \fR[\fPtext\fR]\fP"
+Causes the text on the same line or the text on the next input line to
+appear in a font that is one point size smaller than the default font.
.
-.\" -----------------------------------------------------------------
.
+.\" -----------------------------------------------------------------
.SH "MACROS TO DESCRIBE HYPERLINKS AND EMAIL ADDRESSES"
.
The following macros are not defined on legacy Unix systems
@@ -661,38 +706,39 @@ Using these macros helps ensure that you get hyperlinks
when your
manual page is rendered in a browser or other program that is
Web-enabled.
.
+.
.TP
-.BI .UR " URL"
+.BI .MT " address"
.TQ
-.BI .UE " \fR[\fPpunctuation\fR]\fP"
-Wrap a World Wide Web hyperlink.
+.BI .ME " \fR[\fPpunctuation\fR]\fP"
+Wrap an email address.
.
-The argument to
-.B UR
-is the URL; thereafter, lines until
-.B UE
-are collected and used as the link text.
+The argument of
+.B MT
+is the address; text following, until
+.BR ME ,
+is a name to be associated with the address.
.
Any argument to the
-.B UE
-macro is pasted to the end of the text.
+.B ME
+macro is pasted to the end of the link text.
.
On a device that is not a browser,
.
.RS
.IP
.EX
-this is a link to
-\&.UR http://\e:randomsite.org/\e:fubar
-some random site
-\&.UE ,
-given as an example
+contact
+\&.UR address@hidden:fubar.net
+Fred Foonly
+\&.UE
+for more information
.EE
.RE
.
.IP
-usually displays like this: \[lq]this is a link to some random
-site <http://\:randomsite.org/\:fubar>, given as an example\[rq].
+usually displays like this: \[lq]contact Fred Foonly
+<address@hidden:fubar.net> for more information\[rq].
.
.IP
The use of
@@ -700,38 +746,39 @@ The use of
to insert hyphenless breakpoints is a groff extension and can
be omitted.
.
+.
.TP
-.BI .MT " address"
+.BI .UR " URL"
.TQ
-.BI .ME " \fR[\fPpunctuation\fR]\fP"
-Wrap an email address.
+.BI .UE " \fR[\fPpunctuation\fR]\fP"
+Wrap a World Wide Web hyperlink.
.
-The argument of
-.B MT
-is the address; text following, until
-.BR ME ,
-is a name to be associated with the address.
+The argument to
+.B UR
+is the URL; thereafter, lines until
+.B UE
+are collected and used as the link text.
.
Any argument to the
-.B ME
-macro is pasted to the end of the link text.
+.B UE
+macro is pasted to the end of the text.
.
On a device that is not a browser,
.
.RS
.IP
.EX
-contact
-\&.UR address@hidden:fubar.net
-Fred Foonly
-\&.UE
-for more information
+this is a link to
+\&.UR http://\e:randomsite.org/\e:fubar
+some random site
+\&.UE ,
+given as an example
.EE
.RE
.
.IP
-usually displays like this: \[lq]contact Fred Foonly
-<address@hidden:fubar.net> for more information\[rq].
+usually displays like this: \[lq]this is a link to some random
+site <http://\:randomsite.org/\:fubar>, given as an example\[rq].
.
.IP
The use of
@@ -741,7 +788,6 @@ be omitted.
.
.
.\" -----------------------------------------------------------------
-.
.SH "MACROS TO DESCRIBE COMMAND SYNOPSES"
.
The following macros are not defined on legacy Unix systems
@@ -760,6 +806,16 @@ They also assist automated translation tools and help
browsers in
recognizing command synopses and treating them differently from
running text.
.
+.
+.TP
+.BI .OP " key value"
+Describe an optional command argument.
+.
+The arguments of this macro are set surrounded by option braces
+in the default Roman font; the first argument is printed with
+a bold face, while the second argument is typeset as italic.
+.
+.
.TP
.BI .SY " command"
Begin synopsis.
@@ -774,13 +830,6 @@ plus a space.
.
This produces the traditional look of a Unix command synopsis.
.
-.TP
-.BI .OP " key value"
-Describe an optional command argument.
-.
-The arguments of this macro are set surrounded by option braces
-in the default Roman font; the first argument is printed with
-a bold face, while the second argument is typeset as italic.
.
.TP
.B .YS
@@ -851,7 +900,6 @@ You can insert plain text as well; this looks like the
traditional
.
.
.\" -----------------------------------------------------------------
-.
.SH "MISCELLANEOUS"
.
The default indentation is 7.2n in troff mode and 7n in nroff mode
@@ -859,6 +907,25 @@ except for
.B grohtml
which ignores indentation.
.
+.
+.TP
+.BI .AT " \fR[\fPsystem \fR[\fPrelease\fR]]\fP"
+Alter the footer for use with \f[CR]AT&T\f[]
+.IR \%man\~pages .
+This command exists only for compatibility; don't use it.
+.
+See the
+.I groff
+info manual for more.
+.
+.
+.TP
+.B .BT
+Print the footer string.
+.
+Redefine this macro to get control of the footer.
+.
+.
.TP
.B .DT
Set tabs every 0.5\~inches.
@@ -914,15 +981,13 @@ Thus, information or distinctions that you use
.B PD
to express are likely to be lost.
.
+.
.TP
-.BI .AT " \fR[\fPsystem \fR[\fPrelease\fR]]\fP"
-Alter the footer for use with \f[CR]AT&T\f[]
-.IR \%man\~pages .
-This command exists only for compatibility; don't use it.
+.B .PT
+Print the header string.
+.
+Redefine this macro to get control of the header.
.
-See the
-.I groff
-info manual for more.
.
.TP
.BI .UC " \fR[\fPversion\fR]\fP"
@@ -934,32 +999,20 @@ See the
.I groff
info manual for more.
.
-.TP
-.B .PT
-Print the header string.
-.
-Redefine this macro to get control of the header.
-.
-.TP
-.B .BT
-Print the footer string.
-.
-Redefine this macro to get control of the footer.
.
.PP
The following strings are defined:
.
-.TP
-.B \e*S
-Switch back to the default font size.
.
.TP
.B \e*R
The `registered' sign.
.
+.
.TP
-.B \e*(Tm
-The `trademark' sign.
+.B \e*S
+Switch back to the default font size.
+.
.
.TP
.B \e*(lq
@@ -969,12 +1022,19 @@ Left and right quote.
.
This is equal to `\e(lq' and `\e(rq', respectively.
.
+.
.TP
.B \e*(HF
The typeface used to print headings and subheadings.
.
The default is `B'.
.
+.
+.TP
+.B \e*(Tm
+The `trademark' sign.
+.
+.
.PP
If a preprocessor like
.B @address@hidden
@@ -984,11 +1044,13 @@ is needed, it has become common to make the first line
of the
.I \%man\~page
look like this:
.
+.
.PP
.RS
.BI '\e"\ word
.RE
.
+.
.PP
Note the single space character after the double quote.
.I word
@@ -1005,7 +1067,6 @@ preprocessor(s).
.
.
.\" -----------------------------------------------------------------
-.
.SH "PORTABILITY AND TROFF REQUESTS"
.
Since the
@@ -1022,6 +1083,7 @@ See the
.I groff
info pages for a complete reference of all requests.
.
+.
.PP
Note, however, that using raw troff requests is likely to make your
page render poorly on the (increasingly common) class of viewers that
@@ -1032,6 +1094,7 @@ and page sizes that may break in an HTML environment;
also, many of
these viewers don't interpret the full troff vocabulary, a problem
which can lead to portions of your text being silently dropped.
.
+.
.PP
For portability to modern viewers, it is best to write your page
entirely in the requests described on this page.
@@ -1043,6 +1106,7 @@ Further, it is best to completely avoid those we have
described as
and
.BR DT ).
.
+.
.PP
The macros we have described as extensions
.RB ( .EX / .EE ,
@@ -1057,9 +1121,9 @@ If in doubt, copy the implementation onto your page.
.
.
.\" -----------------------------------------------------------------
-.
.SH FILES
.
+.
.TP
.B man.tmac
.TQ
@@ -1067,6 +1131,7 @@ If in doubt, copy the implementation onto your page.
These are wrapper files to call
.BR andoc.tmac .
.
+.
.TP
.B andoc.tmac
Use this file in case you don't know whether the
@@ -1076,12 +1141,14 @@ macros or the
package should be used.
Multiple man pages (in either format) can be handled.
.
+.
.TP
.B an-old.tmac
Most
.B man
macros are contained in this file.
.
+.
.TP
.B an-ext.tmac
The extension macro definitions for
@@ -1110,6 +1177,7 @@ If you must use your own definitions for these macros,
they must be
given after calling
.BR TH .
.
+.
.TP
.B man.local
Local changes and customizations should be put into this file.
@@ -1119,6 +1187,7 @@ Local changes and customizations should be put into this
file.
.
.SH "SEE ALSO"
.
+.
.PP
.BR @address@hidden (@MAN1EXT@),
.BR @address@hidden (@MAN1EXT@),
@@ -1129,7 +1198,6 @@ Local changes and customizations should be put into this
file.
.
.
.\" -----------------------------------------------------------------
-.
.SH AUTHORS
.
This manual page was originally written for the Debian GNU/Linux
@@ -1138,17 +1206,31 @@ system by
Susan G. Kleinmann
.ME .
.
+.
+.PP
It was corrected and updated by
.MT address@hidden
Werner Lemberg
.ME .
.
+.
+.PP
The extension macros were documented (and partly designed) by
.MT address@hidden
Eric S. Raymond
.ME ;
he also wrote the portability advice.
.
+.
+.PP
+It was put under GPL2 and ordered and extended by
+.MT address@hidden
+Bernd Warken
+.ME .
+.
+.
+.\" ----------------------------------------------------------------------
+.\" ### Emacs settings:
.\" Local Variables:
.\" mode: nroff
.\" End:
hooks/post-receive
--
GNU troff
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Groff-commit] GNU troff branch, master, updated. 309660d6de892de92c9b4b89c160cb4e4606736b,
Bernd Warken <=