pdf-simple-sign/README.adoc

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:

 $ go get janouch.name/pdf-simple-sign/cmd/pdf-simple-sign

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

 $ go get janouch.name/pdf-simple-sign/cmd/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.
Initial commit 2017-11-08 16:07:39 +01:00			`pdf-simple-sign`
			`===============`

Add a Go port It should be roughly at feature parity. 2018-10-02 23:19:38 +02:00			`'pdf-simple-sign' is a simple PDF signer intended for documents produced by`
Fix tests, document new limitation 2023-06-28 23:12:42 +02:00			`the Cairo library (≤ 1.17.4 or using PDF 1.4), GNU troff, ImageMagick,`
			`or similar.`
Initial commit 2017-11-08 16:07:39 +01:00
			`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.`

README.adoc: update package information 2023-07-01 22:03:14 +02:00			`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].`

Add an instructive man page 2020-09-05 20:03:10 +02:00			`Documentation`
			`-------------`
			`See the link:pdf-simple-sign.adoc[man page] for information about usage.`
			`The rest of this README will concern itself with externalities.`

README.adoc: add a PkgGoDev badge 2020-09-11 00:15:58 +02:00			`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"]`

Initial commit 2017-11-08 16:07:39 +01:00			`Building`
			`--------`
Add an instructive man page 2020-09-05 20:03:10 +02:00			`Build dependencies: Meson, Asciidoctor, a C++11 compiler, pkg-config +`
Clarify libcrypto API version in README 2018-08-03 19:58:36 +02:00			`Runtime dependencies: libcrypto (OpenSSL 1.1 API)`
Initial commit 2017-11-08 16:07:39 +01:00
Update README 2018-06-24 04:35:45 +02:00			`$ git clone https://git.janouch.name/p/pdf-simple-sign.git`
Initial commit 2017-11-08 16:07:39 +01:00			`$ cd pdf-simple-sign`
			`$ meson builddir`
			`$ cd builddir`
			`$ ninja`

Add a Go port It should be roughly at feature parity. 2018-10-02 23:19:38 +02:00			`In addition to the C++ version, also included is a native Go port:`

			`$ go get janouch.name/pdf-simple-sign/cmd/pdf-simple-sign`

Update documentation 2021-12-09 15:28:01 +01:00			`And a crude external VFS for Midnight Commander, that may be used to extract`
			`all streams from a given PDF file:`

			`$ go get janouch.name/pdf-simple-sign/cmd/extfs-pdf`

Initial commit 2017-11-08 16:07:39 +01:00			`Contributing and Support`
			`------------------------`
Update README 2018-06-24 04:35:45 +02:00			`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.`
Initial commit 2017-11-08 16:07:39 +01:00
Update README 2018-06-24 04:35:45 +02:00			`Bitcoin donations are accepted at: 12r5uEWEgcHC46xd64tt3hHt9EUvYYDHe9`
Initial commit 2017-11-08 16:07:39 +01:00
			`License`
			`-------`
Relicense to 0BSD, update mail address I've come to the conclusion that copyright mostly just stands in the way of software development. In my jurisdiction I cannot give up my own copyright and 0BSD seems to be the closest thing to public domain. The updated mail address, also used in my author/committer lines, is shorter and looks nicer. People rarely interact anyway. 2018-06-24 04:35:04 +02:00			`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.`