fbpdf: show a message and exit if redrawing fails
[fbpdf.git] / README
blobcf219b2c3073a5a24d960bbdecb438b1e5c4c4f0
1 FBPDF
2 =====
4 fbpdf is a framebuffer pdf/djvu file viewer.  It can use either
5 mupdf or poppler libraries for rendering pdf files and it uses
6 djvulibre library for rendering djvu files.  Note that fbpdf
7 creates different binaries for each library.  So if you want to
8 use fbpdf only for viewing pdf files using mupdf library you
9 can compile it using "make fbpdf".  See the Makefile for other
10 targets.  The following options can be specified when starting
11 fbpdf (or fbdjvu and fbpdf2):
13   fbpdf [-r rotation] [-z zoom x10] [-p page] filename
15 KEYS
16 ====
18 The following table describes the commands available in fbpdf.
19 Most of these commands accept a numerical prefix.  For instance,
20 '^F' tells fbpdf to go to the next page while '5^F' tells it to
21 move to the fifth next page.
23 ==============  ================================================
24 KEY             ACTION
25 ==============  ================================================
26 ^F/J            next page
27 ^B/K            previous page
28 G               go to page (the last page if no prefix)
29 o               set page number (for 'G' command only)
30 O               set page number and go to current page
31 z               zoom; prefix multiplied by 10 (i.e. '15z' = 150%)
32 r               set rotation in degrees
33 i               print info
34 q               quit
35 ^[              (escape) clear numerical prefix
36 mx              mark page as 'x' (or any other letter)
37 'x              jump to the page marked as 'x'
38 `x              jump to the page and position marked as 'x'
39 j               scroll down
40 k               scroll up
41 h               scroll left
42 l               scroll right
43 [               align with the left edge of the page
44 ]               align with the right edge of the page
45 {               align with the leftmost character on the page
46 }               align with the rightmost character on the page
47 H               show page top
48 M               center the page vertically
49 L               show page bottom
50 C               center the page horizontally
51 ' '/^D          (space) page down
52 ^H/^U           (backspace) page up
53 ^L              redraw
54 e               reload current file
55 f               zoom to fit page height
56 w               zoom to fit page width
57 W               zoom to fit page contents horizontally
58 Z               the default zoom level for 'z' command
59 d               sleep one second before the next command
60 ==============  ================================================