Attribution
[llpp.git] / man / llpp.man
blobef2d93bff6573a039a7575d8d98d5e531573e97d
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] [-cxack] [-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] [-v] [-wtmode] 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 -cxack::
27 Cut corners.
29 -dest named-dest::
30 Set named destination.
32 -embed window-id::
33 Embed into window.
35 -f path::
36 Set path to the user interface font.
38 -gc::
39 Collect config garbage.
41 -help, --help::
42 Display this list of options.
44 -last::
45 Open last document.
47 -no-title::
48 ignore document title.
50 -origin origin::
51 <undocumented>.
53 -p password::
54 Set password.
56 -page page-number::
57 Jump to page.
59 -remote path::
60 Set path to the source of remote commands.
62 -tcf path::
63 Set path to the trim cache file.
65 -v::
66 Print version and exit.
68 -wtmode::
69 Operate in wt mode.
71 == FILES
73 === ~/.config/llpp.conf
75 This is the user specific configuration file. If $XDG_CONFIG_HOME is set
76 $XDG_CONFIG_HOME/llpp.conf is used instead. It has a XML structure
78 You can specify a custom path using the -c option.
80 .Configuration structure
81 -------------------------------------------------------------
82 <llppconfig>
83 <ui-font size='20'/>
84 <defaults
85   width='1200'
86   height='1000'
87   ...
88   use-document-css='true'/>
89   <doc path='/some/path/file1.pdf'
90     page='1'
91     ...
92     height='1000'/>
93   <doc path='/some/path/file2.pdf'
94     page='3'
95     ...
96     height='600'/>
97   ...
98 </llppconfig>
99 -------------------------------------------------------------
101 ==== Some configuration tips
102 - To change the user interface font add a ui-font in the followig way:
103 -------------------------------------------------------------
104 <llppconfig>
105   <ui-font size='16'>
106     <![CDATA[/usr/share/fonts/TTF/DejaVuSansMono.ttf]]>
107   </ui-font>
108   <defaults ... />
109 </llppconfig>
110 -------------------------------------------------------------
111 - To change the key bindings, add keymaps to the defaults element, e.g.
112 disable Escape key in the view mode:
113 -------------------------------------------------------------
114 <llppconfig>
115   <defaults ... >
116     <keymap mode='view'>
117       <map in='esc' out=/>
118     </keymap>
119   </defaults>
120 </llppconfig>
121 -------------------------------------------------------------
122 The different modes are _birdseye_, _global_, _help_, _info_, _listview_, _outline_, and _view_.
124 == TODO
126 There is still lot of work to do. Please check our bugtracker for up-to-date
127 information about tasks which are still not finished.
129 == SEE ALSO
131 llppac(1), llpphtml(1)
133 == REPORTING BUGS
135 https://github.com/moosotc/llpp/issues or mailto://moosotc@gmail.com
137 == macOS
139 Nicolás Ojeda Bär contributed macOS port.