summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/lstaddons/README.txt
blob: 04cca2d3097a5ddb3417a9b4f39f7fd06400c310 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
LaTeX bundle 'lstaddons'
~~~~~~~~~~~~~~~~~~~~~~~~
Copyright (c) 2011-2022 by Martin Scharrer <martin.scharrer@web.de>
CTAN: http://www.ctan.org/pkg/lstaddons
Code repository: https://github.com/MartinScharrer/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.