File: README

package info (click to toggle)
djvubind 1.2.1-7
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,712 kB
  • sloc: python: 1,146; makefile: 2
file content (75 lines) | stat: -rw-r--r-- 2,004 bytes parent folder | download | duplicates (3)
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
71
72
73
74
75
djvubind

========
Dependencies

python3
djvulibre
imagemagick
tesseract

You could forgo having tesseract installed so long as you always use the --no-ocr option.

========
Recommendations

minidjvu
cuneiform

Minidjvu will get better compression on bitonal images than cjb2 (part of djvulibre)
currently can.  Some say that cuneiform is a better ocr engine, but in my experience it
has issues with buffer overflows.  If it crashes, tesseract will take over for that image.

========
Installation

Installation should be as simple as "./setup.py install" on Unix based systems.  You can
add --dry-run if you want to check what will happen before doing it, or just use --help
for all the details on options.  Those with debian based distros will probably be
insterest in --install-layout=deb.

Installation is not necessary, since djvubind can run straight from the unpacked source.
This is actually preferred in a Windows environment

N.b., at the moment most distributions are able to have python3 installed but do
not use that version by default.  If this is the case (and it probably is),
explicitly call python3 when installing (e.g. "python3 ./setup.py install")

========
Usage

Run djvubind in a directory that contains the files that should combined into the
djvu file.  Only files with .tif or .tiff extension will be included in the file.
Additionally, by default "bookmarks" and "metadata" files will be inserted if they
are present; they should be in the format used by djvused for print-outline and
print-meta.  A front or back cover image can also be provided in jpeg or tiff
formats.

---
An example directory:

cover_front.jpg
cover_back.jpg
bookmarks
metadata
page_0001.tif
page_0002.tif
...
page_n.tif

---
An example bookmarks file:

(bookmarks
 ("Cover" "#1" )
 ("Contents" "#7" )
)

Note the # symbol before the page number, and don't forget that if you have a cover
image, that will be page 1.

---
An example metadata file:

author "John Smith"
title "Creating Quality Documents"