Do everyone a favour...
[llpp.git] / man / llpp.man
blob828ddcd7117723979d339f8e2ae73a7836ff8aac
1 llpp(1)
2 =======
4 == NAME
6 llpp - a graphical PDF viewer which aims to superficially resemble less
8 == SYNOPSIS
10 llpp [-c path] [-css path] [-dest named-dest] [-embed window-id] [-f path] [-gc] [-help|--help] [-last] [-no-title] [-origin origin] [-p password] [-page page-number] [-remote path] [-tcf path] [-layout-height height] [-v] some.pdf
12 == DESCRIPTION
14 *llpp* is a graphical PDF viewer that can be totally controlled without a mouse.
15 Normally MuPDF (https://mupdf.com/) is used to render the document.
16 The default keybindings resemble those of less(1), but can be configured by the user.
18 == OPTIONS
20 -c path::
21 Set path to the configuration file.
23 -css path::
24 Set path to the style sheet to use with EPUB/HTML.
26 -dest named-dest::
27 Set named destination.
29 -embed window-id::
30 Embed into window.
32 -f path::
33 Set path to the user interface font.
35 -gc::
36 Collect config garbage.
38 -help, --help::
39 Display this list of options.
41 -last::
42 Open last document.
44 -no-title::
45 ignore document title.
47 -origin origin::
48 <undocumented>.
50 -p password::
51 Set password.
53 -page page-number::
54 Jump to page.
56 -remote path::
57 Set path to the source of remote commands.
59 -tcf path::
60 Set path to the trim cache file.
62 -layout-height height::
63 Set page height for reflowable documents (-1 == default, 0 == unlimited).
65 -v::
66 Print version and exit.
68 == FILES
70 === ~/.config/llpp.conf
72 This is the user specific configuration file. If $XDG_CONFIG_HOME is set
73 $XDG_CONFIG_HOME/llpp.conf is used instead. It has an XML structure.
75 You can specify a custom path using the -c option.
77 .Configuration structure
78 -------------------------------------------------------------
79 <llppconfig>
80 <ui-font size='20'/>
81 <defaults
82   width='1200'
83   height='1000'
84   ...
85   use-document-css='true'/>
86   <doc path='/some/path/file1.pdf'
87     page='1'
88     ...
89     height='1000'/>
90   <doc path='/some/path/file2.pdf'
91     page='3'
92     ...
93     height='600'/>
94   ...
95 </llppconfig>
96 -------------------------------------------------------------
98 ==== Some configuration tips
99 - To change the user interface font add a ui-font in the followig way:
100 -------------------------------------------------------------
101 <llppconfig>
102   <ui-font size='16'>
103     <![CDATA[/home/username/.fonts/PTF55F.ttf]]>
104   </ui-font>
105   <defaults ... />
106 </llppconfig>
107 -------------------------------------------------------------
108 - To change the key bindings, add keymaps to the defaults element, e.g.
109 disable Escape key in the view mode:
110 -------------------------------------------------------------
111 <llppconfig>
112   <defaults ... >
113     <keymap mode='view'>
114       <map in='esc' out=/>
115     </keymap>
116   </defaults>
117 </llppconfig>
118 -------------------------------------------------------------
119 The different modes are _birdseye_, _global_, _help_, _info_, _listview_, _outline_, and _view_.
121 == TODO
123 There is still lot of work to do. Please check our bugtracker for up-to-date
124 information about tasks which are still not finished.
126 == SEE ALSO
128 llppac(1), llpphtml(1)
130 == REPORTING BUGS
132 https://github.com/moosotc/llpp/issues or mailto://moosotc@gmail.com
134 == macOS
136 Nicolás Ojeda Bär contributed macOS port.