summaryrefslogtreecommitdiffstats
path: root/contrib/groff/tmac
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2002-10-11 08:53:48 +0000
committerru <ru@FreeBSD.org>2002-10-11 08:53:48 +0000
commitd95ca6e95c94196dcd9fa5575dfab599c782c895 (patch)
tree8f31833c941b2d7ca267ee6b41bbd0627562e135 /contrib/groff/tmac
parent127e61728bacf1fb90edd8be1b0c406619e78bc8 (diff)
downloadFreeBSD-src-d95ca6e95c94196dcd9fa5575dfab599c782c895.zip
FreeBSD-src-d95ca6e95c94196dcd9fa5575dfab599c782c895.tar.gz
Removed files not present in v1.18.1 import.
Diffstat (limited to 'contrib/groff/tmac')
-rw-r--r--contrib/groff/tmac/groff_mwww.man291
-rw-r--r--contrib/groff/tmac/groff_tmac.man451
-rw-r--r--contrib/groff/tmac/mwww.tmac3
3 files changed, 0 insertions, 745 deletions
diff --git a/contrib/groff/tmac/groff_mwww.man b/contrib/groff/tmac/groff_mwww.man
deleted file mode 100644
index 4de8215..0000000
--- a/contrib/groff/tmac/groff_mwww.man
+++ /dev/null
@@ -1,291 +0,0 @@
-.TH GROFF_MWWW @MAN7EXT@ "@MDATE@" "Groff Version @VERSION@"
-.\" Copyright (C) 2000, 2001 Free Software Foundation, Inc.
-.\" Written by Gaius Mulley (gaius@glam.ac.uk)
-.\"
-.\" This file is part of groff.
-.\"
-.\" 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, or (at your option) any later
-.\" version.
-.\"
-.\" 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 file COPYING. If not, write to the Free Software
-.\" Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
-.\"
-.\" user level guide to using the -mwww macroset
-.\"
-.do mso www.tmac
-.\" we need the .LINKS here as we use it in the middle as an example
-.\" once the user requests .LINKS then the automatic generation of links
-.\" at the top of the document is suppresed.
-.LINKS
-.SH NAME
-groff_mwww \- groff macros for authoring web pages
-.LINE
-.SH SYNOPSIS
-.B "groff \-mwww"
-[ options ]
-file ...
-.SH DESCRIPTION
-This manual page describes the GNU \-mwww macros, which is part of the
-groff document formatting system.
-The manual page is very a basic guide, and the html device driver
-.RB ( grohtml )
-has been completely rewritten but still remains as in an alpha state.
-It has been included into the distribution so that a lot of people have a
-chance to test it.
-Note that this macro file will be automatically called (via the
-\fCtroffrc\fP file) if you use \fC-Thtml\fP.
-.PP
-To see the hyperlinks in action, please format this man page with the
-.B grohtml
-device.
-.PP
-Here is a summary of the functions found in this macro set.
-.SH SYNPOSIS
-.ta 2iL
-\&.HTMLINDEX determine automatic link cut off
-.br
- point for sections/headers
-.br
-\&.BODYCOLOR specify colours on a web page
-.br
-\&.BACKGROUND specify background image
-.br
-\&.URL create a url using two parameters
-.br
-\&.MAILTO create a html email address
-.br
-\&.FTP create an ftp reference
-.br
-\&.IMAGE include an image file
-.br
-\&.HTML pass an html raw request to the
-.br
- device driver
-.br
-\&.TAG generate an html name tag from $1
-.br
-.\"\&.CDFTP optionally create two different links
-.\".br
-.\" depending on hostname
-.\".br
-\&.LINE create a full width horizontal rule
-.br
-.PP
-Output of the
-.IR pic ,
-.IR eqn ,
-.IR refer ,
-and
-.I tbl
-preprocessors is acceptable as input.
-.SH REQUESTS
-.TP
-.B HTMLINDEX
-determines the cut off point for automatic link generation to headings.
-By default all headings found in a troff document have links created to them
-at the top of the html web page.
-It maybe that many of the lower heading levels do not require links.
-Alternatively some web pages may not need any heading links at all, in which
-case:
-.sp
-.nf
-\fC\&.HTMLINDEX 0\fP
-.fi
-.sp
-will tell
-.B grohtml
-not to generate links.
-An \fCHTMLINDEX\fP of 2 will mean that a heading
-.sp
-.B "1.1.1 Some Title"
-.sp
-will not be included in the links either as it is said to have a heading
-level of three.
-Another method for switching automatic headings is via the command line
-switch \fC-P-l\fP.
-.TP
-.B BODYCOLOR
-takes five parameters: foreground, background, active hypertext link,
-hypertext link not yet visited, and visited hypertext link colour.
-.TP
-.B BACKGROUND
-the only parameter to this macro is the background image file.
-.TP
-.B URL
-generates
-.TAG URL
-a URL using either two or three arguments.
-$1 is the name of the link, $2 is the actual URL, and $3 is optional stuff
-to be printed immediately after $2.
-Hyphenation is disabled while printing the actual URL; explicit breakpoints
-should be inserted with the
-.B \e:
-escape.
-Here is how to encode
-.URL "homepage for groff" http://\:groff.\:ffii.\:org/ :
-.sp
-.nf
-\s-2\fC\&.URL "homepage for groff" http://\e:groff.\e:ffii.\e:org/ :\fP\s+2
-.fi
-.sp
-If this is processed by a device other than \fC-Thtml\fP
-it appears as:
-homepage for groff \(lahttp://groff.\:ffii.\:org\(ra.
-The URL macro can be of any type; for example we can reference
-.URL "Eric Raymond's pic guide" pic.html
-by:
-.sp
-.nf
-\s-2\fC\&.URL "Eric Raymond's pic guide" pic.html\fP\s+2
-.fi
-.sp
-.TP
-.B MAILTO
-generates an email html reference.
-The first argument is mandatory as the email address.
-The optional second argument is the text you see in your browser, and
-an optional third argument is stuff printed immediately after the
-second argument.
-Hyphenation is disabled while printing the actual email address.
-For example, the groff maintainers are
-.MAILTO wl@gnu.org "Werner Lemberg"
-and
-.MAILTO Ted.Harding@nessie.mcc.ac.uk "Ted Harding" .
-This is achieved by the following macros:
-.sp
-.nf
-\s-2\fC\&.MAILTO wl@gnu.org "Werner Lemberg"
-\&.MAILTO Ted.Harding@nessie.mcc.ac.uk "Ted Harding" .\s+2\fP
-.fi
-.sp
-Note that all the urls actually are treated as consuming no textual space
-in groff.
-This could be considered as a bug since it causes some problems.
-To circumvent this, \fCwww.tmac\fP inserts a zero-width character which
-expands to a harmless space (only if run with -Thtml).
-.TP
-.B FTP
-indicates that data can be obtained via ftp.
-The first argument is the browser text and the second is the url.
-A third argument, similar to the macros above, is intended for stuff printed
-immediately after the second argument.
-The second and the third parameter are optional.
-Hyphenation is disabled while printing the actual URL.
-As an example, here the location of the
-.FTP "current groff development distribution" \
-ftp://ftp.ffii.org/\:pub/\:groff/\:devel/\:groff-current.tar.gz .
-The macro example above was specified by:
-.sp
-.nf
-\s-2\fC\&.FTP "current groff development distribution" \\
-ftp://ftp.ffii.org/\e:pub/\e:groff/\e:devel/\e:groff-current.tar.gz .\fP\s+2
-.fi
-.sp
-.TP
-.B IMAGE
-allows the document to include pictures.
-The first argument is the image file.
-The second optional argument gives the horizontal location;
-.B l
-puts the image to the left border,
-.B r
-to the right.
-Any other value centers the image.
-The next two arguments are optional also:
-Argument three is the width in pixels (default is 400 pixels if absent).
-The fourth argument is the height in pixels (default is the width value if
-absent).
-.sp
-.TP
-.B HTML
-all text after this macro is treated as raw html.
-If the document is processed \fIwithout\fP \fC-Thtml\fP then
-the macro is ignored.
-This macro is a building block for other higher level macros.
-.sp
-For example, the \fCBACKGROUND\fP macro is defined as:
-.nf
-\fC\&.de BACKGROUND
-\&. HTML <body background=\\$1>
-\&..
-\fP
-.fi
-.TP
-.B TAG
-generates an html name tag from its argument.
-This can then be referenced using the
-.URL URL #URL
-macro.
-As you can see, you must precede the tag name with `\fC#\fP' since it is
-a local reference.
-This link was achieved via placing a TAG in the URL description above;
-the source looks like this:
-.sp
-.nf
-\s-2\fC\&.TP
-\&.B URL
-generates
-\&.TAG URL
-a URL using either two or three
-arguments.
-$1 is the name of the link, $2 is the actual URL.\fP\s+2
-.fi
-.sp
-.TP
-.B LINE
-generates a full width horizontal rule.
-Example:
-.sp
-.nf
-\fC\s-2\&.LINE\fP\s+2
-.fi
-.sp
-.TP
-.B LINKS
-.TAG LINK
-requests that grohtml place the automatically generated links at this position.
-For example:
-.LINKS
-.SH
-SECTION HEADING LINKS
-.LP
-By default
-.B grohtml
-generates links to all section headings and places these at the top of the
-html document. (See
-.URL LINKS #LINK
-for details of how to switch this off or alter the position.
-.SH
-LIMITATIONS OF GROHTML
-.LP
-Tbl information is currently rendered as a png image.
-.SH FILES
-@MACRODIR@/mwww.tmac (a wrapper for www.tmac)
-.br
-@MACRODIR@/www.tmac
-.SH "SEE ALSO"
-.BR groff (@MAN1EXT@),
-.BR @g@troff (@MAN1EXT@)
-.BR grohtml (@MAN1EXT@),
-.LP
-.SH AUTHOR
-.B Grohtml
-was written by
-.MAILTO gaius@glam.ac.uk "Gaius Mulley"
-.SH BUGS
-Report bugs to the
-.MAILTO bug-groff@gnu.org "Groff Bug Mailing List" .
-Include a complete, self-contained example that will allow the bug to be
-reproduced, and say which version of groff you are using.
-.
-.\" Local Variables:
-.\" mode: nroff
-.\" End:
diff --git a/contrib/groff/tmac/groff_tmac.man b/contrib/groff/tmac/groff_tmac.man
deleted file mode 100644
index e6f39bb..0000000
--- a/contrib/groff/tmac/groff_tmac.man
+++ /dev/null
@@ -1,451 +0,0 @@
-.ig /
-groff_tmac.5
-
-This file is part of groff, the GNU roff type-setting system.
-
-Copyright (C) 2000, 2001 Free Software Foundation, Inc.
-written by Bernd Warken <bwarken@mayn.de>
-
-Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.1 or
-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.
-./
-.
-.\" --------------------------------------------------------------------
-.\" Setup
-.\" --------------------------------------------------------------------
-.
-.if n \{\
-. mso tty-char.tmac
-. ftr CR R
-. ftr CI I
-. ftr CB B
-.\}
-.
-.\" text lines in macro definitions or bracketed sections \{...\}
-.de text
-. if 1 \&\\$*\&
-..
-.
-.de BIR
-. ie (\\n[.$] < 3) \
-. BI \\$@
-. el \{\
-. ds @tmp@ \fB\\$1\fP\fI\\$2\fP
-. shift 2
-. text \\*[@tmp@]\fR\\$*\fP
-. rm @tmp@
-. \}
-..
-.
-.de 'char
-. ds @tmp@ `\f(CB\\$1\fP'
-. shift
-. text \\*[@tmp@]\\$*
-. rm @tmp@
-..
-.
-.de option
-. ds @tmp@ \f(CB\\$1\fP
-. shift 1
-. text \\*[@tmp@]\\$*
-. rm @tmp@
-..
-.
-.als shellcommand option
-.
-.de argument
-. ds @tmp@ \f(CI\\$1\fP
-. shift 1
-. text \\*[@tmp@]\\$*
-. rm @tmp@
-..
-.
-.de request
-. ds @tmp@ \f(CB\\$1\fP
-. shift 1
-. text \\*[@tmp@]\\$*
-. rm @tmp@
-..
-.
-.\" --------------------------------------------------------------------
-.\" Title
-.\" --------------------------------------------------------------------
-.TH GROFF_TMAC @MAN5EXT@ "@MDATE@" "Groff Version @VERSION@"
-.SH NAME
-groff_tmac \- macro files in the roff typesetting system
-.\" --------------------------------------------------------------------
-.SH DESCRIPTION
-.\" --------------------------------------------------------------------
-The
-.BR roff (@MAN7EXT@)
-type-setting system provides a set of macro packages suitable for
-special kinds of documents. Each macro package stores its macros and
-definitions in a file called the package's
-.BR "tmac file" .
-The name is deduced from
-.RB ` T roff
-.BR MAC ros'.
-.LP
-The tmac files are normal roff source documents, except that they
-usually contain only definitions and setup commands, but no text. All
-tmac files are kept in a single or a small number of directories, the
-.B tmac
-directories.
-.\" --------------------------------------------------------------------
-.SH NAMING
-.\" --------------------------------------------------------------------
-In classical roff systems, there was a funny naming scheme.
-If the name of a macro package started with
-.'char m
-this letter was omitted, e.g., the macro package for the man pages
-.I man
-was called
-.I an
-and its macro file
-.I tmac.an
-(note that in recent versions of groff this file is called
-.I an.tmac
-instead).
-.LP
-By a similar reasoning, macro packages that did not start with an
-.'char m
-were often referred to by adding an
-.'char m ,
-e.g., the package corresponding to
-.I tmac.doc
-was called
-.I mdoc
-because the command-line for activating it reads
-.RS
-.LP
-.BIR "troff\ \-m" doc .
-.RE
-.LP
-Actual versions of
-.BR groff (@MAN1EXT@)
-provide both naming schemes for the inflicted macro packages, with and
-without the leading
-.'char m .
-So in
-.IR groff ,
-the
-.I man
-macro package may be specified as
-.RS
-.LP
-.BIR "groff\ \-m\ " man ,
-.br
-.BIR "groff\ \-m" an ,
-.br
-.BIR "groff\ \-m" man , or
-.br
-.BIR "groff\ \-m " an .
-.RE
-.LP
-The easiest way to find out which macro packages are available on a
-system is to check the contents of the
-.I tmac
-directories.
-For example, a file called
-.BI tmac. anything
-or
-.IB anything .tmac
-determines a macro package named
-.IR anything .
-.LP
-In
-.IR groff ,
-most macro packages are described in man pages called
-.BR groff_<name> (@MAN7EXT@),
-with a leading
-.'char m
-for the classical packages.
-.\" --------------------------------------------------------------------
-.SH INCLUSION
-.\" --------------------------------------------------------------------
-There are several ways to use a macro package in documents. At
-run-time, the groff option
-.option \-m \ \c
-.argument name
-makes the definitions in the macro file
-.IB name .tmac
-available as described in the section
-.BR NAMING .
-If this file isn't found,
-.BI tmac. name
-will be searched.
-.LP
-It is also possible to include the macro file into the document by using
-the groff requests
-.request .so
-or
-.request .mso .
-For
-.request .so
-the full filename of the macro file must be specified \(em including the
-directory where it is kept.
-If the macro file is stored in one of the tmac directories it is more
-convenient to use
-.request .mso
-instead because it searches the tmac path for the filename.
-Additionally, if the file name to be included has the form
-.IB name .tmac
-and it isn't found,
-.request .mso
-will try to open
-.BI tmac. name
-instead and vice versa.
-.LP
-Note that in order to resolve the
-.request .so
-and
-.request .mso
-requests the roff preprocessor
-.shellcommand soelim
-must be called if the files to be included needs preprocessing.
-This can be done either directly by a pipeline on the command line or by
-using the
-.option \-s
-option of
-.shellcommand groff .
-.LP
-You can also supply the letter
-.'char s
-in the preprocessor word as described in section
-.BR CONVENTION .
-.LP
-For example, suppose a macro file is stored as
-.I @MACRODIR@/macros.tmac
-and is used in some document called
-.IR docu.roff .
-.LP
-At run-time, the formatter call for this is
-.RS
-.LP
-.ft CR
-.shellcommand "groff\ \-m"
-.argument macros
-.argument docu.roff
-.ft P
-.RE
-.LP
-To include the macro file directly in the document either
-.RS
-.ft CR
-\&\.mso macros.tmac
-.ft P
-.RE
-is used or
-.RS
-.ft CR
-\&\.so @MACRODIR@/macros.tmac
-.ft P
-.RE
-.LP
-In both cases, the formatter is called with
-.ft CR
-.RS
-groff\ \-s docu.roff
-.RE
-.ft P
-.
-.\" --------------------------------------------------------------------
-.SH CONVENTION
-.\" --------------------------------------------------------------------
-.LP
-There is a convention that is supported by many modern roff
-type-setters: the
-.B preprocessor word
-described in the following.
-.LP
-If the first line in a document is a comment, the first word (after the
-comment characters and a blank) constitutes the
-.B preprocessor
-.BR word .
-That means that the letters of this word are interpreted as
-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,
-.'char e ,
-.'char G ,
-.'char g ,
-.'char p ,
-.'char R ,
-.'char s , and
-.'char t
-(see
-.BR roff (@MAN7EXT@)).
-.LP
-Besides being a good reminder for the user, some formatters (like the
-.BR man (1)
-program) are even able to automatically start the preprocessors
-specified in the preprocessor word, but do not bet on this.
-.\" --------------------------------------------------------------------
-.SH "WRITING A MACRO FILE"
-.\" --------------------------------------------------------------------
-Writing a groff macro file is easy. Design a set of macros, strings,
-registers, etc. Store them in a single file. Documents that use the
-macros include this macro file with the
-.request .so
-request as described in the
-.B INCLUSION
-section.
-.LP
-To use the tmac functionality, call the macro file
-.IB whatever .tmac
-(or
-.BI tmac. whatever\c
-) and put it in some directory of the tmac path, cf. section
-.BR FILES .
-Then documents can include it with the
-.request .mso
-request or the
-.shellcommand "groff\ \-m"
-option as described in the
-.B INCLUSION
-section.
-.LP
-If your macros might be of general usage contact the groff maintainers
-to have them included in the groff
-.I contrib
-source directory.
-.LP
-Some general guidelines might be helpful in writing macros.
-.IP \(bu 2m
-Double all functional backslashes,
-.'char \e
-->
-.'char \e\e .
-.IP \(bu 2m
-All printable backslashes must be written as
-.'char \ee .
-.IP \(bu 2m
-Escape all dots,
-.'char .
-->
-.'char \e. .
-.IP \(bu 2m
-Make ample use of the non-printable character
-.'char \e&
-in text parts, esp. before
-.'char \e
-and at the beginning of a line, but not before a delayed command.
-.IP \(bu 2m
-Use the character
-.'char @
-in temporary variable names.
-.IP \(bu 2m
-Test your macros for text and graphical devices, e.g.,
-.I latin1
-and
-.IR ps .
-.\" --------------------------------------------------------------------
-.SH FILES
-.\" --------------------------------------------------------------------
-All macro names must be named
-.IB name .tmac
-or
-.BI tmac. name
-to use the tmac mechanism.
-.LP
-The macro files are kept in the
-.B tmac
-.BR directories ,
-all of which constitute the
-.B tmac
-.BR path.
-.LP
-The elements of the search path for macro files are (in that order):
-.IP \(bu 4
-the directories specified with troff's resp. groff's
-.B \-M
-command line option
-.IP \(bu 4
-the directories given in the
-.B GROFF_TMAC_PATH
-environment variable
-.IP \(bu 4
-the current directory (only if in unsafe mode using the
-.B \-U
-command line switch)
-.IP \(bu 4
-the home directory
-.IP \(bu 4
-a site-specific (platform-independent) directory, a platform-specific
-directory, and the main tmac directory:
-.IP "" 6
-@LOCALMACRODIR@
-.br
-@SYSTEMMACRODIR@
-.br
-@MACRODIR@
-.\" --------------------------------------------------------------------
-.SH ENVIRONMENT
-.\" --------------------------------------------------------------------
-.TP
-.B GROFF_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 BUGS
-.\" --------------------------------------------------------------------
-The groff documentation is in evolution at the moment. It is possible
-that small inconsistencies between different documents exist
-temporarily.
-.\" --------------------------------------------------------------------
-.SH AUTHOR
-.\" --------------------------------------------------------------------
-This document is part of groff, the GNU roff distribution. It was
-written by Bernd Warken <bwarken@mayn.de>.
-.LP
-It is distributed under the terms of the FDL (GNU Free Documentation
-License) version 1.1 or later. You should have received a copy of the
-FDL on your system, it is also available on-line under
-.RS
-.LP
-.IR <http://www.gnu.org/copyleft/fdl.html> .
-.RE
-.\" --------------------------------------------------------------------
-.SH "SEE ALSO"
-.\" --------------------------------------------------------------------
-The authoritative source of information for all details of the groff
-system is the groff
-.BR info (1)
-file.
-.LP
-For a groff overview, see
-.BR roff (@MAN7EXT@)
-and the file
-.I README
-in the groff source package.
-.LP
-The groff tmac macro packages are
-.BR groff_man (@MAN7EXT@),
-.BR groff_mwww (@MAN7EXT@),
-.BR groff_mdoc (@MAN7EXT@),
-.BR groff_mdoc.samples (@MAN7EXT@),
-.BR groff_me (@MAN7EXT@),
-.BR groff_mm (@MAN7EXT@),
-.BR groff_mmroff (@MAN7EXT@),
-and
-.BR groff_ms (@MAN7EXT@).
-.LP
-The groff language is described in
-.BR groff (@MAN7EXT@)
-and the formatters in
-.BR groff (@MAN1EXT@),
-.BR troff (@MAN1EXT@).
-.LP
-The Filesystem Hierarchy Standard (FHS) is available at
-.BR http://www.pathname.com/fhs/ .
-.
-.\" Local Variables:
-.\" mode: nroff
-.\" End:
diff --git a/contrib/groff/tmac/mwww.tmac b/contrib/groff/tmac/mwww.tmac
deleted file mode 100644
index b258688..0000000
--- a/contrib/groff/tmac/mwww.tmac
+++ /dev/null
@@ -1,3 +0,0 @@
-.\" mwww.tmac
-.\"
-.do mso www.tmac
OpenPOWER on IntegriCloud