help.ml

   1 let keys =
   2 {|-----Quitting-----
   3 escape/q                - quit
   4 Q                       - quit without saving the configuration or changes
   5 W                       - save changes
   6
   7 -----Movement-----
   8 up/down arrow           - scroll up/down
   9 j/k                     - scroll up/down
  10 left/right arrow        - pan left/right (when zoomed in)
  11 Ctrl-arrows             - scroll up/down, pan left/right (by half a screen width/height)
  12 space                   - go to the next page
  13 delete                  - go to the previous page
  14 pageup/pagedown         - go forward/backward one screen-full
  15 g, G                    - go to first/last page
  16 home/end                - go to first/last page
  17
  18 -----Advanced Movement / History-----
  19 backspace               - go back after jumping (clicking link and suchlike)[1]
  20 Alt-left/right arrow    - go backward/forward in history
  21 0..9                    - enter page number to jump to
  22 t                       - align top of the screen with the top of the page
  23 <,>                     - rotate
  24 Ctrl-pageup/pagedown    - align top of the screen with first/last visible page
  25 F                       - go to hinted link
  26 if auto scrolling is active:
  27     up/down arrows and mouse buttons 3/4 will make scrolling go faster/slower
  28
  29 -----Mouse-----
  30 primary mouse button    - click on link or select text[2]
  31   when shift is held    - execute "synctex command" with coordinates of the point[3]
  32   when control is held  - pan
  33   zoom to block         - when in block zoom mode
  34   otherwise             - pan if there's no text/link under the cursor
  35 mouse buttons 3/4       - scroll up/down (aka mouse wheel)
  36   when control is held  - zoom
  37 mouse buttons 5/6       - pan left/right (aka horizontal mouse wheel)
  38 secondary mouse button  - select rectangle to zoom to
  39   when shift is held    - add text annotation
  40
  41 Note:
  42   moving mouse while holding primary mouse button will pan the page,
  43   if the mouse is over selectable element (text/link) holding control
  44   will make the page pan instead of the default action (selecting text/
  45   clicking link)
  46
  47 -----Bookmarks-----
  48 m                       - create named bookmark
  49 ~                       - create quick bookmark
  50
  51 -----Zoom-----
  52 control + shift up/down - set previous zoom level
  53 B                       - toggle zoom block mode
  54 w                       - change height of the window to encompass all of the page
  55 Alt-c                   - center view
  56 Ctrl-+/Ctrl-=           - zoom in
  57 Ctrl--                  - zoom out
  58 Ctrl-0                  - reset zoom and panning
  59 Ctrl-1                  - fit tallest page
  60 Ctrl-2                  - fit tallest page height exactly
  61 Ctrl-3                  - cycle fit models
  62 Ctrl-4                  - 1:1 zoom
  63 Ctrl-9/F9               - enter bird's eye view
  64
  65 -----Actions-----
  66 u                       - dehighlight
  67 r                       - reload document[4]
  68 y                       - select link and paste its description to the clipboard
  69 |                       - pipe selection through specified command
  70 x                       - run pax command on selected region
  71 Ctrl-p                  - launch a command with the document path as an argument
  72 return                  - (in link navigation mode) follow link
  73 =                       - show current position
  74 e                       - view error log
  75
  76 -----Search-----
  77 /,?                     - enter text to search for (/ - forward, ? - backward)
  78 n                       - repeat last search (forward)
  79 p, N                    - repeat last search (backward)
  80 Ctrl-g                  - interrupt search
  81
  82 -----Settings / Modes-----
  83 [,]                     - decrease/increase page brightness
  84 +                       - set page bias
  85 -                       - toggle/set tunable
  86 b                       - toggle scroll bar
  87 l                       - toggle highlighting of the links
  88 f                       - toggle fullscreen
  89 insert                  - toggle link navigation mode
  90 o                       - switch to outline/table of contents mode
  91 '                       - switch to bookmark mode
  92 H                       - switch to history mode
  93 h,F1                    - switch to help mode
  94 i                       - switch to info mode
  95 P                       - switch to "presentation" mode
  96 c                       - switch to previous column layout
  97 a                       - auto scroll mode
  98 S                       - slide show mode
  99   (auto scroll step is interepreted as a delay (in seconds) between transitions)
 100
 101
 102 -----Tunables-----
 103 -i                      - toggle case sensitivity of searches
 104 -s<number>              - set scroll step (pixels)
 105 -S<number>              - set space between pages (pixels)
 106 -R<number>              - rotate
 107 -v                      - toggle verbosity
 108 -Z<number>              - set zoom (percent)
 109 -T                      - toggle trimming of margins
 110 -I                      - invert colors
 111 -M                      - toggle pax mode
 112 -C<number>              - set column count
 113 -x<string>              - set command to run on selection
 114 -f                      - toggle "what's under cursor" identification
 115                         - (or "what's currently selected" in link navigation mode)
 116                         -     (font name of the text under cursor or link target)
 117
 118 -----Bird's eye mode-----
 119 Ctrl-9,F9,esc           - leave bird's eye view
 120 Ctrl-l                  - center the view on the currently selected page
 121 (page)up/(page)down     - navigate
 122 home/end                - go to first/last page
 123 enter                   - select the page and leave bird's eye mode
 124 primary mouse button    - select the page under cursor and leave bird's eye mode
 125
 126 -----Outline/bookmark/help/info/history mode-----
 127 esc                     - leave outline/bookmark mode
 128 up/down                 - select previous/next item
 129 alpha-numeric           - quick search
 130 Ctrl-s                  - repeat search (forward)
 131 Ctrl-r                  - repeat search (backward)
 132 Ctrl-l                  - center on current item
 133 Ctrl-left/right         - pan text left/right
 134 Ctrl-up/down            - scroll view up/down
 135 Ctrl-insert             - copy active item's text to clipboard
 136
 137 -----Outline/history mode-----
 138 left/right              - go up/down a level
 139 Ctrl-a                  - toggle auto narrowing
 140 /                       - enter auto narrowing
 141 tab                     - begin nested narrowing
 142 Ctrl-n                  - narrow to search pattern
 143 Ctrl-u                  - undo narrowing
 144 Ctrl-S                  - synchronize
 145
 146 -----Info mode-----
 147 enter                   - toggle/enter new value for selected parameter
 148
 149 -----When entering search pattern/page number-----
 150 up/down arrow           - previous/next entered text
 151 enter                   - confirm
 152 Ctrl-g,esc              - cancel
 153
 154 double/triple/quadruple/quintuple clicks in view mode will pipe the
 155 word/line/block/page through pax command when control is held and
 156 selection command otherwise
 157
 158 [1] if the document was previously visited initial backspace will
 159     jump to the last visited place
 160
 161 [2] text selection requires
 162     X11     - xclip https://github.com/astrand/xclip
 163     macOS   - pbcopy ships with the system
 164
 165 [3] arguments to the command are:
 166     1 = path to the document
 167     2 = zero based page number
 168     3 = X coordinate within the page
 169     4 = Y …
 170
 171 [4] document will also be reloaded upon reception of the HUP signal
 172
 173 -----Caveat emptor-----
 174 o Text selection is limited to a single page
 175 o Text searching is very naive|};;
 176
 177 open Utils;;
 178
 179 external fz_version : unit -> string = "ml_fz_version";;
 180 external llpp_version : unit -> string = "ml_llpp_version";;
 181
 182 let gotourl launcher url =
 183   let command = Str.global_replace Utils.Re.percent url launcher in
 184   try ignore @@ spawn command []
 185   with exn -> dolog "failed to execute `%s': %s" command @@ exntos exn
 186 ;;
 187
 188 let gotouri launcher uri =
 189   if emptystr launcher
 190   then dolog "%s" uri
 191   else
 192     if nonemptystr @@ geturl uri
 193     then gotourl launcher uri
 194     else dolog "obtained empty url from uri %S" uri
 195 ;;
 196
 197 let version () =
 198   Printf.sprintf "llpp version %s, fitz %s, ocaml %s/%d bit"
 199     (llpp_version ()) (fz_version ()) Sys.ocaml_version Sys.word_size
 200 ;;
 201
 202 let fixup = let open Str in let gr = global_replace in
 203     let dash = regexp {|\([^ ]*\) +- +\(.*\)|}
 204     and head = regexp {|-----\(.*\)-----|} in
 205     fun s -> gr dash "\\1\t\\2" @@ gr head "\xc2\xb7\\1" s
 206 ;;
 207
 208 let makehelp launcher =
 209   version ()
 210   :: "(searching in this text works just by typing (i.e. no initial '/'))"
 211   :: E.s :: String.split_on_char '\n' keys |>
 212     List.map (fun s ->
 213         let s = fixup s in
 214         match geturl s with
 215         | "" -> (s, 0, Config.Noaction)
 216         | url ->  (s, 0, Config.Action (fun uioh -> gotourl launcher url; uioh))
 217       )
 218 ;;