adoc/llpp.adoc

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