adoc/llpp.adoc

   1 // -*- mode: flyspell -*-
   2 llpp(1)
   3 =======
   4
   5 == NAME
   6 llpp - a graphical document pager which aims to superficially resemble
   7 less
   8
   9 == SYNOPSIS
  10 llpp [-c path] [-css path] [-dest name] [-f path] [-gc] [-help|--help]
  11  [-last] [-no-title] [-origin origin] [-p password] [-page page-number]
  12  [-remote path] [-flip-stderr-redirection] [-v] path-to-the-document
  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 -f path::
  27 Set path to the user interface font
  28
  29 -gc::
  30 Collect config garbage
  31
  32 -help, --help::
  33 Display list of options
  34
  35 -last::
  36 Open last visited document
  37
  38 -no-title::
  39 Ignore document title
  40
  41 -origin origin::
  42 <undocumented>
  43
  44 -p password::
  45 Set password
  46
  47 -page page-number::
  48 Jump to page
  49
  50 -remote path::
  51 Set path to the source of remote commands
  52
  53 -dest name::
  54 <undocumented>>
  55
  56 -dcf path::
  57 <undocumented>
  58
  59 -flip-stderr-redirection::
  60 <undocumented>
  61
  62 -v::
  63 Print version and exit
  64
  65 == KEY BINDINGS
  66 Open a document with llpp, then press `F1` or `alt-h` to switch to help mode.
  67
  68 == FILES
  69
  70 === $HOME/.config/llpp.conf
  71 This is the user specific configuration file. If $HOME/.config
  72 directory does not exist $HOME/llpp.conf is used instead. It has an
  73 XML structure.
  74
  75 .Configuration structure
  76 -------------------------------------------------------------
  77 <llppconfig>
  78 <ui-font size='20'/>
  79 <defaults
  80   width='1200'
  81   height='1000'
  82   ...
  83   use-document-css='true'/>
  84   <doc path='/some/path/file1.pdf'
  85     page='1'
  86     ...
  87     height='1000'/>
  88   <doc path='/some/path/file2.pdf'
  89     page='3'
  90     ...
  91     height='600'/>
  92   ...
  93 </llppconfig>
  94 -------------------------------------------------------------
  95
  96 ==== Some configuration tips
  97 - To change the user interface font:
  98 -------------------------------------------------------------
  99 <llppconfig>
 100   <ui-font size='32'> <![CDATA[/path/to/fonts/font.otf]]> </ui-font>
 101   <defaults ... />
 102 </llppconfig>
 103 -------------------------------------------------------------
 104 - To change keybindings, add keymaps to the defaults element, for
 105 instance following example disables Escape key in the view mode:
 106
 107 -------------------------------------------------------------
 108 <llppconfig>
 109   <defaults ... >
 110     <keymap mode='view'>
 111       <map in='esc' out=/>
 112     </keymap>
 113   </defaults>
 114 </llppconfig>
 115 -------------------------------------------------------------
 116
 117 The different modes are _birdseye_, _global_, _help_, _info_,
 118 _listview_, _outline_, and _view_.
 119
 120 == SEE ALSO
 121 llppac(1), llpphtml(1)
 122
 123 == ENVIRONMENT
 124 === LLPP_ASKPASS
 125 Command to inquire user about the password (dmenu/rofi like)
 126
 127 === LLPP_FALLBACK_FONT
 128
 129 Path to the substitution font
 130 (such as https://github.com/unicode-org/last-resort-font/ for instance)
 131
 132 == REPORTING BUGS
 133 https://github.com/moosotc/llpp/issues
 134
 135 == macOS
 136 Nicolás Ojeda Bär contributed macOS port.