aboutsummaryrefslogtreecommitdiff
path: root/README.adoc
blob: 10e581f22a69add48d3a4e6a1a4a144b3218a70c (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
67
68
69
70
pdf-simple-sign
===============

'pdf-simple-sign' is a simple PDF signer intended for documents produced by
the Cairo library (≤ 1.17.4 or using PDF 1.4), GNU troff, ImageMagick,
or similar.

I don't aim to extend the functionality any further.  The project is fairly
self-contained and it should be easy to grasp and change to suit to your needs.

Packages
--------
Regular releases are sporadic.  git master should be stable enough.
You can get a package with the latest development version using Arch Linux's
https://aur.archlinux.org/packages/pdf-simple-sign-git[AUR],
or as a https://git.janouch.name/p/nixexprs[Nix derivation].

Documentation
-------------
See the link:pdf-simple-sign.adoc[man page] for information about usage.
The rest of this README will concern itself with externalities.

image:https://pkg.go.dev/badge/janouch.name/pdf-simple-sign@master/pdf["PkgGoDev", link="https://pkg.go.dev/janouch.name/pdf-simple-sign@master/pdf"]

Building
--------
Build dependencies: Meson, Asciidoctor, a C++11 compiler, pkg-config +
Runtime dependencies: libcrypto (OpenSSL 1.1 API)

 $ git clone https://git.janouch.name/p/pdf-simple-sign.git
 $ cd pdf-simple-sign
 $ meson builddir
 $ cd builddir
 $ ninja

In addition to the C++ version, also included is a native Go port,
which has enhanced PDF 1.5 support:

----
$ go install janouch.name/pdf-simple-sign/cmd/pdf-simple-sign@master
----

and a crude external VFS for Midnight Commander, that may be used to extract
all streams from a given PDF file:

----
$ GOBIN=$HOME/.local/share/mc/extfs.d \
  go install janouch.name/pdf-simple-sign/cmd/extfs-pdf@master
----

To enable the VFS, edit your _~/.config/mc/mc.ext.ini_ to contain:

----
[pdf]
Type=^PDF
Open=%cd %p/extfs-pdf://
----

Contributing and Support
------------------------
Use https://git.janouch.name/p/pdf-simple-sign to report bugs, request features,
or submit pull requests.  `git send-email` is tolerated.  If you want to discuss
the project, feel free to join me at ircs://irc.janouch.name, channel #dev.

Bitcoin donations are accepted at: 12r5uEWEgcHC46xd64tt3hHt9EUvYYDHe9

License
-------
This software is released under the terms of the 0BSD license, the text of which
is included within the package along with the list of authors.