summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/lstaddons/README
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/lstaddons/README')
-rw-r--r--macros/latex/contrib/lstaddons/README50
1 files changed, 50 insertions, 0 deletions
diff --git a/macros/latex/contrib/lstaddons/README b/macros/latex/contrib/lstaddons/README
new file mode 100644
index 0000000000..7306f47deb
--- /dev/null
+++ b/macros/latex/contrib/lstaddons/README
@@ -0,0 +1,50 @@
+LaTeX bundle 'lstaddons'
+~~~~~~~~~~~~~~~~~~~~~~~~
+Copyright (c) 2011-2012 by Martin Scharrer <martin@scharrer-online.de>
+CTAN: http://www.ctan.org/pkg/lstaddons
+Code repository: https://bitbucket.org/martin_scharrer/lstaddons
+
+This bundle contains a small collections of add-on packages for
+the 'listings' package.
+These packages patch internal macros to provide additional features
+to 'listings'.
+
+The add-ons are so far:
+
+
+lstlinebgrd
+~~~~~~~~~~~
+Provides 'linebackground' options for 'lstlisting' which
+can be used to color the background of each line of the listing.
+The use of conditionals which depend on the line number is supported,
+which allows zebra-effects etc.
+
+This package was originally written in response to the question
+"Creating a zebra effect using listings"
+(http://tex.stackexchange.com/q/18969/2975).
+
+
+lstautogobble
+~~~~~~~~~~~~~
+Provides an 'autogobble=true|false' option for 'listing' which will set the
+standard 'gobble' option to the indention of the first line. This allows
+people to indent their listings code in the source file without having to
+use a suitable value for 'gobble' themselves.
+
+This package was originally written in response to the question
+"How to automatically skip leading white spaces in listings"
+(http://tex.stackexchange.com/q/19953/2975)
+
+
+INSTALLATION
+============
+Run 'tex lstaddons.ins' to extract all package files.
+Compile all .dtx files with pdflatex to produce the package manuals.
+Copy the files to the following subdirectories of your TEXMF tree:
+
+ *.sty => tex/latex/lstaddons/
+ *.dtx *.ins => source/latex/lstaddons/
+ *.pdf README => doc/latex/lstaddons/
+
+Finally update your TeX file list by running 'texhash' or similar tool.
+