Debian Codegraph @

texmf-dist/doc/latex/lineno/README.md

raw
1 # lineno.sty v5.9, fnlineno.sty v0.55
2
3 2026/03/08
4
5 The LaTeX package lineno.sty provides line numbers on paragraphs. After TeX has
6 broken a paragraph into lines there will be line numbers attached to them, with
7 the possibility to make references through the LaTeX \ref, \pageref cross
8 reference mechanism.
9
10 - Copyright 1995--2003 Stephan I. Böttcher
11 - Copyright 2002--2005 Uwe Lück for versions 4.x and code from former Ednotes
12 - Copyright 2011 Uwe Lück for fnlineno.sty/tex/pdf
13 - Copyright 2021--2025 Karl Wette for versions 5.x
14
15 The files can be redistributed and/or modified under
16 the terms of the LaTeX Project Public License; either
17 version 1.3a of the License, or any later version.
18 The latest version of this license is in http://www.latex-project.org/lppl.txt.
19 We did our best to help you, but there is NO WARRANTY.
20
21 Home: http://mirror.ctan.org/macros/latex/contrib/lineno/
22
23 Authors:
24
25 - Stephan I. Böttcher
26 - Uwe Lück
27 - Karl Wette
28
29 ## Compatibility with other packages:
30
31 - `wrapfig.sty`: works since v2.05
32
33 - `multicol.sty`: works partly since 3.02. Do NOT use \linelabel. Do NOT put a
34 multicol in internal vertical mode {table}, {figure}, etc.
35
36 - `hyperref.sty`: \ref to a \linelabel works since v3.03.
37
38 - `longtable.sty`: broke with lineno.sty loaded, but not enabled. This is fixed
39 in v3.04.
40
41 - `amsmath.sty`: loadable, but not fully supported, with v4.41. Fully supported
42 with v5.0. Use LaTeX hooks to allow independent loading of `amsmath` and `lineno`
43 with v5.1. Support `amsmath` option `\allowdisplaybreaks` with v5.2.
44
45 ## Installation and usage (UL, v4.1):
46
47 For being able to use ALL the new `lineno.sty` options, the following files must
48 be "visible" to (La)TeX ("visible" explained below for beginners):
49
50 - `lineno.sty`, `edtable.sty`, `ednmath0.sty`, `ltabptch.sty` -- as above
51 ("Home", note that clicking on "entire directory" suffices);
52 - `longtable.sty` -- from the standard LaTeX Tools bundle.
53
54 Usage always starts with loading lineno.sty by `\usepackage`. The remaining
55 `.sty` files are loaded automatically on the `lineno.sty` options (and we
56 recommend not to load them through [the mandatory argument of] `\usepackage`).
57
58 For details, see `lineno.tex/pdf` and the `.sty` files mentioned above--search
59 especially for tabular and math mode. (+ `print` below here).
60
61 "Visible to (LaTeX)": Some users don't understand this "visibility" for a while,
62 and indeed it may be somewhat non-trivial. These users may find help in
63 https://mirrors.ctan.org/macros/latex/contrib/ednotes/visible.txt . E.g., former users of
64 lineno.sty may just put all the .sty files into the folder (at their workplace)
65 where they had placed lineno.sty before. (/UL, /v4.1)
66
67 To print the documented source: Take the style-file `lineno.sty`, and feed it to
68 a Un*x shell. (Or download the extracted source documentation `lineno.tex`.)
69 ```
70 csh> source ./lineno.sty
71 sh> . ./lineno.sty
72 ```
73 [ i.e., type `sh lineno.sty` (e.g.) as a UNIX command line. Problems with awk
74 may arise. I therefore switched to nawk in lineno.sty v4.00, but this may
75 trouble you as well. (UL) ] (Please ignore the error message at the beginning
76 about the iffalse.)
77
78 ## Files
79
80 (cf. `SRCFILEs.txt`):
81
82 - `README.txt`: This file. (v4.1: UL)
83 - `CHANGEs.txt`: Differences to previous versions. (v4.1: UL)
84 - `COPYING.txt`: The LPPL header.
85 - `SCRFILEs.txt`: Source file infos (UL 2011)
86 - `lineno.sty`: The package itself, ready to use.
87 - `edtable.sty`: Module for tabular environments. (UL, v4.1)
88 - `ednmath0.sty`: Module for \linelabel in math mode. (UL, v4.1)
89 - `fnlineno.sty`: Add-on for footnote line numbers (UL, v0.55)
90 - `lineno.tex`: The source for the documentation (generated)
91 - `lineno.pdf`: PDF deriving from the former. (v4.1: UL)
92 - `lnosuppl.pdf`: PDF listing of present non-PDF files
93 - `ulineno.tex`: The pathetic attempt of a users' manual. [Describes v3.1 currently.] (UL, v4.1)
94 - `ulineno.pdf`: PDF of former.
95 - `vplref.sty`: Conditionally include page number in line number references (UL, v4.2)
96 - `linenoamsmathdemo.tex`: Demo of making amsmath work with lineno (KW, v5.0)
97
98 As of version v3.00, the extension packages for lineno have all been
99 incorporated into `lineno.sty` itself. Except for `itemrule.sty`, which was
100 removed.
101
102 ## History
103
104 (Prior to my taking over maintenance of the package -- KW)
105
106 ** [ UL: A few festive words on history and responsibility **
107 ** are next preceding hard facts as to (see lower) **
108 ** o `Files' and **
109 ** o `Installation and usage'. ] **
110
111 2004-09-13 Uwe Lück [(UL)] is new maintainer for lineno.sty.
112
113 lineno.sty served the purpose for which I wrote it years ago. Uwe
114 Lück uses lineno.sty with his Ednotes package, which required quite a
115 few changes and fixes. His package depends on lineno, therefore
116 Uwe agreed to take over the maintenance of lineno.sty.
117
118 lineno.sty v4.0 includes most of the well tested changes that Uwe
119 needs for Ednotes. These changes blend well into the concepts of the
120 package, so I am happy to let it go.
121
122 From here on it is Uwe's, and he may proceed to mangle it as he likes.
123 Expect some radical changes. You may find him to be quite a bit
124 friendlier towards the poor souls who still use Windows :-).
125 Currently, you need some kind of Unix environment to extract the
126 source documentation from the sty file.
127
128 If some version 3 users run into difficulties with Uwe's newer
129 versions, but need a minor bug-fix in version 3, please do not
130 hesitate to ask me for help. But all requests for new features or
131 major changes shall go to Uwe.
132
133 Cheers
134 Stephan
135
136 [ Thanks! And please let me know as well should
137 compatibility problems arise! The announced radical
138 changes are postponed again this time (v4.1).
139 --Ednotes is in
140 http://mirror.ctan.org/macros/latex/contrib/ednotes.
141 Uwe ]
142
143 Please have a look at a similar work of Michal Jaegermann and James
144 Fortune:
145 http://mirror.ctan.org/obsolete/macros/latex/contrib/numline/