adoc/llpp.adoc

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