summaryrefslogtreecommitdiff
path: root/support/check-parens/README
blob: 8ed8e30a08dc4388cc9b2af8d56d1e826e110e3b (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
51
52
53
54
55
56
57
check-parens
============

Version: 2015.07.24

Description
-----------

Simple program to check LaTeX code for matching parentheses, etc.
It reports any errors/warnings with precise line:pos numbers to
ease finding LaTeX compilation problems as well as mismatches of
parentheses in mathematical formulas.

Licensing
---------

Copyright (C) 2012--2015  Jaap Eldering (jaap@jaapeldering.nl).

This program 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 3, or (at your option)
any later version.

This program 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 this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.

Installation
------------

Compilation requires a C++ compiler; GNU g++ versions >= 4.1 are known
to work. Running 'make' in the package directory without arguments
should produce the binary.

This binary should be copied to any place in your environment's PATH,
e.g. $HOME/bin or /usr/local/bin. The default search path for the
configuration file is $HOME/.check-parens.conf. Running 'make install'
as a regular user should normally do the job.

Usage
-----

Run 'check-parens --help' for an overview of all options.

Default use is 'check-parens <latexfile.tex>'.

Bugs/feedback
-------------

Any bug reports and other feedback is welcome.
Send me an email: <jaap@jaapeldering.nl>