adoc/llpp.adoc

   1 llpp(1)
   2 =======
   3
   4 == NAME
   5 llpp - a graphical document pager which aims to superficially resemble
   6 less
   7
   8 == SYNOPSIS
   9 llpp [-c path] [-css path] [-dest named-dest] [-f path] [-gc]
  10  [-help|--help] [-last] [-no-title] [-origin origin] [-p password]
  11  [-page page-number] [-remote path] [-tcf path] [-layout-height height]
  12  [-v] some.pdf
  13
  14 == DESCRIPTION
  15 *llpp* is a graphical document pager utilizing MuPDF
  16 (https://mupdf.com/) library. The default keybindings resemble those
  17 of less(1)
  18
  19 == OPTIONS
  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 list of options
  37
  38 -last::
  39 Open last visited 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 == KEY BINDINGS
  66 Open a document with llpp, then press `F1` or `h` to switch to help mode.
  67
  68 To remember all key bindings, an Anki deck has been made available:
  69
  70     https://ankiweb.net/shared/info/1547122548
  71
  72 == FILES
  73
  74 === ~/.config/llpp.conf
  75 This is the user specific configuration file. If $XDG_CONFIG_HOME is
  76 set $XDG_CONFIG_HOME/llpp.conf is used instead. It has an XML
  77 structure.
  78
  79 You can specify a custom path using the -c option.
  80
  81 .Configuration structure
  82 -------------------------------------------------------------
  83 <llppconfig>
  84 <ui-font size='20'/>
  85 <defaults
  86   width='1200'
  87   height='1000'
  88   ...
  89   use-document-css='true'/>
  90   <doc path='/some/path/file1.pdf'
  91     page='1'
  92     ...
  93     height='1000'/>
  94   <doc path='/some/path/file2.pdf'
  95     page='3'
  96     ...
  97     height='600'/>
  98   ...
  99 </llppconfig>
 100 -------------------------------------------------------------
 101
 102 ==== Some configuration tips
 103 - To change the user interface font:
 104 -------------------------------------------------------------
 105 <llppconfig>
 106   <ui-font size='16'>
 107     <![CDATA[/path/to/fonts/PTF55F.ttf]]>
 108   </ui-font>
 109   <defaults ... />
 110 </llppconfig>
 111 -------------------------------------------------------------
 112 - To change keybindings, add keymaps to the defaults element, for
 113 instance following example disables Escape key in the view mode:
 114
 115 -------------------------------------------------------------
 116 <llppconfig>
 117   <defaults ... >
 118     <keymap mode='view'>
 119       <map in='esc' out=/>
 120     </keymap>
 121   </defaults>
 122 </llppconfig>
 123 -------------------------------------------------------------
 124
 125 The different modes are _birdseye_, _global_, _help_, _info_,
 126 _listview_, _outline_, and _view_.
 127
 128 == SEE ALSO
 129 llppac(1), llpphtml(1)
 130
 131 == ENVIRONMENT
 132 === LLPP_ASKPASS
 133 Command to inquire user about the password (dmenu/rofi like)
 134
 135 == REPORTING BUGS
 136 https://github.com/moosotc/llpp/issues or mailto://moosotc@gmail.com
 137
 138 == macOS
 139 Nicolás Ojeda Bär contributed macOS port.