summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/fancyvrb
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2006-01-09 00:49:07 +0000
committerKarl Berry <karl@freefriends.org>2006-01-09 00:49:07 +0000
commit007f67a693e4d031fd3d792df8e4d5f43e2cb2e7 (patch)
tree90d17e00e572ecb1e24764b6f29c80e098b08d29 /Master/texmf-dist/doc/latex/fancyvrb
parent950209b26f70aa87ed07c54f82a95b6f03b7c3a0 (diff)
doc/latex
git-svn-id: svn://tug.org/texlive/trunk@84 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/fancyvrb')
-rw-r--r--Master/texmf-dist/doc/latex/fancyvrb/README66
-rw-r--r--Master/texmf-dist/doc/latex/fancyvrb/artistic2.txt192
-rw-r--r--Master/texmf-dist/doc/latex/fancyvrb/fancyvrb.pdfbin0 -> 189569 bytes
-rw-r--r--Master/texmf-dist/doc/latex/fancyvrb/t-fvrbex.tex220
4 files changed, 478 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/fancyvrb/README b/Master/texmf-dist/doc/latex/fancyvrb/README
new file mode 100644
index 00000000000..e074763c32a
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/fancyvrb/README
@@ -0,0 +1,66 @@
+
+ --------------------------------------------------
+ | `fancyvrb' |
+ | Version 2.6 |
+ | July 17, 1998 |
+ | |
+ | Timothy Van Zandt (Princeton University - USA) |
+ | <tvz@Princeton.EDU> |
+ | |
+ | Packaging, documentation and support |
+ | Denis Girou (CNRS/IDRIS - France) |
+ | <Denis.Girou@idris.fr> |
+ | Sebastian Rahtz (Elsevier - GB) |
+ | <s.rahtz@elsevier.co.uk> |
+ --------------------------------------------------
+
+
+ The `fancyvrb' package provides very sophisticated facilities for reading
+and writing verbatim TeX code. Users can perform common tasks like changing
+font family and size, numbering lines, framing code examples, colouring text
+and conditionally processing text.
+
+ `fancyvrb' was heavily used in the typesetting of the "LaTeX Graphics
+Companion", by Michel Goossens, Sebastian Rahtz and Frank Mittelbach, Addison
+Wesley, 1997.
+
+ It was presented March 31, 1998 for EuroTeX'98. The original paper is
+available on (courtesy "Cahiers GUTenberg"):
+http://www.univ-rennes1.fr/pub/GUTenberg/publicationsPS/28-29-girou.ps.gz
+The description part of `fancyvrb' is not up to date (it was the content
+of the version 2.5) but the additional paragraph about it usage to the
+typesetting of the "LaTeX Graphics Companion" provide in depth informations
+on some usages of `fancyvrb' not described elsewhere.
+
+ The "contrib" subdirectory contain the `fvrb-ex' package (from Denis Girou),
+built above `fancyvrb', which offer some "example" environments showing both
+the code in verbatim mode and the result of it normally formatted.
+
+ Warning!
+ --------
+
+ * Support is provided by Denis Girou and Sebastian Rahtz and not by
+Timothy Van Zandt. Do not bother him with questions relative to `fancyvrb'!
+
+ * The standard `color' package must be available, with a correct "color.cfg"
+file defining the dvi converter that must be used.
+
+ * If the `changebar' package is available on your platform, the changes
+since the preceding version will be marked by special gray bars printed
+in the margins. But the driver name must be hardcoded in the file.
+So, if you have `changebar' and are not using the "dvips" driver, change this
+name in the line
+ {\ChangeBartrue\usepackage[dvips,rightbars]{changebar}}{}
+in fancyvrb.dtx (the other drivers supported by this package are "dvitoln03",
+"dvitops" and "emtex").
+ If you really need to desactivate this feature (it must not be the case,
+as there will be no effect if you haven't `changebar', and, if you have it,
+it must work on your platform...) just change the two relevant lines to:
+\IfFileExists{changebar.sty}{}{}
+
+.............................................................................
+
+ Comments, suggestions and bug reports (with version number and the
+keyword "fancyvrb" in the subject of the message) to <Denis.Girou@idris.fr>
+and <s.rahtz@elsevier.co.uk>
+
diff --git a/Master/texmf-dist/doc/latex/fancyvrb/artistic2.txt b/Master/texmf-dist/doc/latex/fancyvrb/artistic2.txt
new file mode 100644
index 00000000000..24bd750dfaa
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/fancyvrb/artistic2.txt
@@ -0,0 +1,192 @@
+ The Artistic License
+ Version 2.0beta4, October 2000
+
+ Copyright (C) 2000, Larry Wall.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+This copyright license states the terms under which a given free software Package may be copied, modified and/or redistributed, while the Originator(s) maintain some artistic control over the future development of that Package (at least as much artistic control as can be given under copyright law while still making the Package open source and free software).
+
+This license is bound by copyright law, and thus it legally applies only to works which the copyright holder has permitted copying, distribution or modification under the terms of the Artistic License, Version 2.0.
+
+You are reminded that You are always permitted to make arrangements wholly outside of a given copyright license directly with the copyright holder(s) of a given Package. If the terms of this license impede your ability to make full use of the Package, You are encouraged to contact the copyright holder(s) and seek a different licensing arrangement.
+
+ Definitions
+
+"Package" refers to the collection of files distributed by the Originator(s), and derivatives of that collection of files created through textual modification.
+
+"Standard Version" refers to the Package if it has not been modified, or has been modified only in ways suggested by the Originator(s).
+
+"Modified Version" refers to the Package, if it has been changed by You via textual modification of the source code, and such changes were not suggested by the Originator(s).
+
+"Originator" refers to the author(s) and/or copyright holder(s) of the Standard Version of the Package.
+
+"You" and "Your" refers to any person who would like to copy, distribute, or modify the Package.
+
+"Distribution Fee" is any fee that You charge for providing a copy of this Package to another party. It does not refer to licensing fees.
+
+"Freely Available" means that:
+
+ (a) no fee is charged for the right to use the item (though a
+ Distribution Fee may be charged).
+
+ (b) recipients of the item may redistribute it under the same
+ conditions they received it.
+
+ (c) If the item is a binary, object code, bytecode, the complete
+ corresponding machine-readable source code is included with the
+ item.
+
+
+ Permission for Use and Modification Without Redistribution
+
+ (1) You are permitted to use the Standard Version and create and use
+ Modified Versions for any purpose without restriction, provided that
+ you do not redistribute the Modified Version to others outside of your
+ company or organization.
+
+
+ Permissions for Redistribution of the Standard Version
+
+ (2) You may make available verbatim copies of the source code of the
+ Standard Version of this Package in any medium without restriction,
+ either gratis or for a Distribution Fee, provided that you duplicate
+ all of the original copyright notices and associated disclaimers. At
+ Your discretion, such verbatim copies may or may not include compiled
+ bytecode, object code or binary versions of the corresponding source
+ code in the same medium.
+
+ (3) You may apply any bug fixes, portability changes, and other
+ modifications made available from any of the Originator(s). The
+ resulting modified Package will still be considered the Standard
+ Version, and may be copied, modified and redistributed under the terms
+ of the original license of the Standard Version as if it were the
+ Standard Version.
+
+
+ Permissions for Redistribution of Modified Versions of the Package as Source
+
+ (4) You may modify your copy of the source code of this Package in any way
+ and distribute that Modified Version (either gratis or for a
+ Distribution Fee, and with or without a corresponding binary, bytecode
+ or object code version of the Modified Version) provided that You
+ clearly indicate what changes You made to the Package, and provided
+ that You do at least ONE of the following:
+
+ (a) make the Modified Version available to the Originator(s) of the
+ Standard Version, under the exact license of the Standard
+ Version, so that the Originator(s) may include your modifications
+ into the Standard Version (at their discretion).
+
+ (b) modify any installation scripts and procedures so that
+ installation of the Modified Version will never conflict with an
+ installation of the Standard Version, include for each program
+ installed by the Modified Version clear documentation describing
+ how it differs from the Standard Version, and rename your
+ Modified Version so that the name is substantially different from
+ the Standard Version.
+
+ (c) permit and encourage anyone who receives a copy of the Modified
+ Version permission to make your modifications Freely Available in
+ some specific way.
+
+ If Your Modified Version is in turn derived from a Modified Version
+ made by a third party, then You are still required to ensure that Your
+ Modified Version complies with the requirements of this license.
+
+
+ Permissions for Redistribution of Non-Source Versions of Package
+
+ (5) You may distribute binary, object code, bytecode or other non-source
+ versions of the Standard Version of the Package, provided that you
+ include complete instructions on where to get the source code of the
+ Standard Version. Such instructions must be valid at the time of Your
+ distribution. If these instructions, at any time while You are
+ carrying our such distribution, become invalid, you must provide new
+ instructions on demand or cease further distribution. If You cease
+ distribution within thirty days after You become aware that the
+ instructions are invalid, then You do not forfeit any of Your rights
+ under this license.
+
+ (6) You may distribute binary, object code, bytecode or other non-source
+ versions of a Modified Version provided that You do at least ONE of
+ the following:
+
+ (a) include a copy of the corresponding source code for the Modified
+ Version under the terms indicated in (4).
+
+ (b) ensure that the installation of Your non-source Modified Version
+ does not conflict in any way with an installation of the Standard
+ Version, include for each program installed by the Modified
+ Version clear documentation describing how it differs from the
+ Standard Version, and rename your Modified Version so that the
+ name is substantially different from the Standard Version.
+
+ (c) ensure that the Modified Version includes notification of the
+ changes made from the Standard Version, and offer to provide
+ machine-readable source code (under a license that permits making
+ that source code Freely Available) of the Modified Version via
+ mail order.
+
+
+ Permissions for Inclusion of the Package in Aggregate Works
+
+ (7) You may aggregate this Package (either the Standard Version or
+ Modified Version) with other packages and distribute the resulting
+ aggregation provided that You do not charge a licensing fee for the
+ Package. Distribution Fees are permitted, and licensing fees for
+ other packages in the aggregation are permitted. Your permission to
+ distribute Standard or Modified Versions of the Package is still
+ subject to the other terms set forth in other sections of this
+ license.
+
+ (8) In addition to the permissions given elsewhere by this license, You
+ are also permitted to link Modified and Standard Versions of this
+ Package with other works and distribute the result without
+ restriction, provided You have produced binary program(s) that do not
+ overtly expose the interfaces of the Package. This includes
+ permission to embed the Package in a larger work of your own without
+ exposing a direct interface to the Package. This also includes
+ permission to build stand-alone binary or bytecode versions of your
+ scripts that require the Package, but do not otherwise give the casual
+ user direct access to the Package itself.
+
+
+ Items That are Never Considered Part of a Modified Version Package
+
+ (9) Works (including, but not limited to, subroutines and scripts) that
+ you have linked or aggregated with the Package that merely extend or
+ make use of the Package, but are not intended to cause the Package to
+ operate differently from the Standard Version, do not, by themselves,
+ cause the Package to be a Modified Version. In addition, such works
+ are not considered parts of the Package itself, and are not bound by
+ the terms of the Package's license.
+
+
+ Acceptance of License and Disclaimer of Warranty
+
+ (10) You are not required to accept this License, since you have not signed
+ it. However, nothing else grants you permission to copy, modify or
+ distribute the Standard or Modified Versions of the Package. These
+ actions are prohibited by copyright law if you do not accept this
+ License. Therefore, by copying, modifying or distributing Standard
+ and Modified Versions of the Package, you indicate your acceptance of
+ the license of the Package.
+
+
+ (11) Disclaimer of Warranty:
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT UNLESS REQUIRED BY
+ LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER OR CONTRIBUTOR
+ BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+ OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+ OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, PROFITS; OR
+ BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+ OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+ EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/Master/texmf-dist/doc/latex/fancyvrb/fancyvrb.pdf b/Master/texmf-dist/doc/latex/fancyvrb/fancyvrb.pdf
new file mode 100644
index 00000000000..7b71f1118b9
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/fancyvrb/fancyvrb.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/fancyvrb/t-fvrbex.tex b/Master/texmf-dist/doc/latex/fancyvrb/t-fvrbex.tex
new file mode 100644
index 00000000000..cc7a84ad372
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/fancyvrb/t-fvrbex.tex
@@ -0,0 +1,220 @@
+%%
+%% This is file `t-fvrbex.tex',
+%% generated with the docstrip utility.
+%%
+%% The original source files were:
+%%
+%% fvrb-ex.dtx (with options: `t-fvrbex')
+%%
+%% IMPORTANT NOTICE:
+%%
+%% For the copyright see the source file.
+%%
+%% Any modified versions of this file must be renamed
+%% with new filenames distinct from t-fvrbex.tex.
+%%
+%% For distribution of the original source see the terms
+%% for copying and modification in the file fvrb-ex.dtx.
+%%
+%% This generated file may be distributed as long as the
+%% original source files, as listed above, are part of the
+%% same distribution. (The sources need not necessarily be
+%% in the same archive or directory.)
+%%
+%% Package `fvrb-ex' (`fvrb-ex', `hbaw' and `hcolor')
+%%
+%% COPYING:
+%% The files of this package "fvrb-ex" are released under the Artistic
+%% License Version 2. A copy of that license is included in the file
+%% artistic2.txt inside the fancyvrb package. This package consists of
+%% the following files:
+%% README fvrb-ex.dtx fvrb-ex.ins
+%%
+%% Denis Girou (CNRS/IDRIS - France) <Denis.Girou@idris.fr>
+%% March 27, 1998
+%%
+%% File `t-fvrbex'
+%%
+\documentclass{article}
+
+\newif\ifpstricks
+\IfFileExists{pstricks.sty}
+{\usepackage[bawcolor,pstricks]{fvrb-ex}\pstrickstrue}
+{\usepackage[bawcolor]{fvrb-ex}}
+
+\begin{document}
+
+\title{Test file for the `\textsf{fvrb-ex}' package}
+\author{Denis Girou\\CNRS/IDRIS\\Orsay -- France\\
+ {\footnotesize email: Denis.Girou@idris.fr}}
+\date{Version 1.2\\March 27, 1998}
+
+\maketitle
+
+\RecustomVerbatimEnvironment{Verbatim}{Verbatim}
+ {gobble=2,commentchar=£,numbers=left,numbersep=3pt,frame=single}
+
+\section{\texttt{Example} environment}
+
+\begin{Verbatim}
+ \begin{Example}
+ First verbatim line.
+ Second verbatim line.
+ Third verbatim line.
+ \end{Example}
+\end{Verbatim}
+
+\begin{Example}
+ First verbatim line.
+ Second verbatim line.
+ Third verbatim line.
+\end{Example}
+
+\begin{Verbatim}
+ \begin{Example}[frame=lines,framerule=1mm,numbers=left]
+ First verbatim line.
+ Second verbatim line.
+ Third verbatim line.
+ \end{Example}
+\end{Verbatim}
+
+\begin{Example}[frame=lines,framerule=1mm,numbers=left]
+ First verbatim line.
+ Second verbatim line.
+ Third verbatim line.
+\end{Example}
+
+\section{\texttt{CenterExample} environment}
+
+\begin{Verbatim}
+ \begin{CenterExample}[frame=single,numbers=right]
+ First verbatim line.
+ Second verbatim line.
+ Third verbatim line.
+ \end{CenterExample}
+\end{Verbatim}
+
+\begin{CenterExample}[frame=single,numbers=right]
+ First verbatim line.
+ Second verbatim line.
+ Third verbatim line.
+\end{CenterExample}
+
+\begin{Verbatim}
+ \begin{CenterExample}[frame=lines,numbers=left]
+ §HLaµFirst¶ verbatim line.
+ §HLbµSecond¶ verbatim line.
+ §HLCBWzµThird¶ verbatim line.
+ \end{CenterExample}
+\end{Verbatim}
+
+\begin{CenterExample}[frame=lines,numbers=left]
+ §HLaµFirst¶ verbatim line.
+ §HLbµSecond¶ verbatim line.
+ §HLCBWzµThird¶ verbatim line.
+\end{CenterExample}
+
+\section{\texttt{SideBySideExample} environment}
+
+\begin{Verbatim}
+ \begin{SideBySideExample}[xrightmargin=5cm,frame=lines,
+ numbers=left]
+ First verbatim line.
+ Second verbatim line.
+ Third verbatim line.
+ \end{SideBySideExample}
+\end{Verbatim}
+
+\begin{SideBySideExample}[xrightmargin=5cm,frame=single,numbers=left]
+ First verbatim line.
+ Second verbatim line.
+ Third verbatim line.
+\end{SideBySideExample}
+
+\ifpstricks % If PSTricks is available
+
+\section{\texttt{PCenterExample} environment}
+
+\begin{Verbatim}
+ \fvset{frame=lines,framerule=0.5mm,numbers=left}
+
+ \begin{PCenterExample}(-0.5,-0.5)(0.5,0.5)
+ \setlength{\unitlength}{1cm}
+ \put(0,0){\circle{1}}
+ \end{PCenterExample}
+
+ \showgrid
+ \begin{PCenterExample}(-1,-1)(1,1)
+ \setlength{\unitlength}{1cm}
+ \put(0,0){\circle{1}}
+ \end{PCenterExample}
+\end{Verbatim}
+
+{\fvset{frame=lines,framerule=0.5mm,numbers=left}
+\begin{PCenterExample}(-0.5,-0.5)(0.5,0.5)
+ \setlength{\unitlength}{1cm}
+ \put(0,0){\circle{1}}
+\end{PCenterExample}
+\showgrid
+\begin{PCenterExample}(-1,-1)(1,1)
+ \setlength{\unitlength}{1cm}
+ \put(0,0){\circle{1}}
+\end{PCenterExample}
+}
+
+\section{\texttt{PSideBySideExample} environment}
+
+\begin{Verbatim}
+ \fvset{frame=single,xrightmargin=5cm}
+ \begin{PSideBySideExample}(-2,-1)(2,1)
+ \psellipse*[linecolor=yellow](2,1)
+ \end{PSideBySideExample}
+ \showgrid
+ \begin{PSideBySideExample}(-2,-1)(2,1)
+ \psellipse[linestyle=dashed](2,1)
+ \end{PSideBySideExample}
+\end{Verbatim}
+
+{\fvset{frame=single,xrightmargin=5cm}
+\begin{PSideBySideExample}(-2,-1)(2,1)
+ \psellipse*[linecolor=yellow](2,1)
+\end{PSideBySideExample}
+
+\showgrid
+\begin{PSideBySideExample}(-2,-1)(2,1)
+ \psellipse[linestyle=dashed](2,1)
+\end{PSideBySideExample}
+}
+
+\begin{Verbatim}
+ \fvset{frame=single,xrightmargin=5cm}
+ \begin{PSideBySideExample}(-2,-1)(2,1)
+ \psellipse[linestyle=§HLCBWeµdashed¶](2,1)
+ \end{PSideBySideExample}
+ \begin{PSideBySideExample}[numbers=right](-2,-1)(2,1)
+ \psellipse[linestyle=§HLeµdotted¶](2,1)
+ \end{PSideBySideExample}
+\end{Verbatim}
+
+{\fvset{frame=single,xrightmargin=5cm}
+\begin{PSideBySideExample}(-2,-1)(2,1)
+ \psellipse[linestyle=§HLCBWeµdashed¶](2,1)
+\end{PSideBySideExample}
+\begin{PSideBySideExample}[numbers=right](-2,-1)(2,1)
+ \psellipse[linestyle=§HLeµdotted¶](2,1)
+\end{PSideBySideExample}
+
+\else % If PSTricks is not available
+\begin{quote}
+ \section{\texttt{PCenterExample} and \texttt{PSideBySideExample}
+environments}
+
+ \textbf{\large Warning!} These two environments are not demonstrated here,
+because PSTricks was not found on this platform.
+\end{quote}
+\fi
+
+\end{document}
+\endinput
+%%
+%% End of file `t-fvrbex.tex'.