summaryrefslogtreecommitdiff
path: root/support/pkgcheck/README.md
blob: 96d6b1671671af5ab0a5eaed260df35ec8deda0c (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
58
59
60
61
62
63
64
65
66
---
pkgcheck utility

Author: Manfred Lotz, <manfred@ctan.org>

License: Apache License, Version 2.0 or MIT License

---


# Overview

`pkgcheck` is a utility which the author uses to check uploaded packages to CTAN before
installing them. It is a binary running on Linux only. 

There is no Windows version planned.


# Dependencies

The `pkgcheck` binary is a 64-bit statically linked binary, and thus it should run also on 
older Linux versions.

It uses the following external programs:

- `pdfinfo` for checking pdf documents
- `unzip` for temporarily unpacking a TDS zip archive

# Installing the binary

Copy the binary from `bin/pkgcheck` to a suitable location on your hard disk, and 
(recommended) make sure the directory is in the `PATH` or call `pkgcheck` using an 
absolute path name.

# Documentation

The documentation is `docs/pkgcheck.pdf`. It contains 
a description of all fatal, error, warning and information messages.


# Build the documentation

Run either `xelatex` or `lualatex`. Note that `-shell-escape` is required.


```
cd docs 
lualatex -shell-escape pkgcheck.tex
```



# License 

Licensed under either of

-  Apache License, Version 2.0
    
   - See file LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0

-  MIT license
   
   - See file LICENSE-MIT or http://opensource.org/licenses/MIT

at your option.