misc/zathurarc.5.rst

   1 ===========
   2  zathurarc
   3 ===========
   4
   5 --------------------------
   6 zathura configuration file
   7 --------------------------
   8
   9 :Author: Sebastian Ramacher <s.ramacher@gmx.at>
  10 :Date: 19.8.2010
  11 :Manual section: 5
  12
  13 SYNOPOSIS
  14 =========
  15
  16 /etc/zathurarc, ~/.config/zathura/zathurarc
  17
  18 DESCRIPTION
  19 ===========
  20
  21 The zathurarc contains various options controlling the behavior of zathura. One
  22 can use the ``set`` and ``map`` commands:
  23
  24 * ``set`` [id] [value]
  25 * ``map`` [key] [function] [argument] [mode]
  26
  27 They behave the same as the ``set`` and ``map`` commands in zathura. Any line
  28 not starting with ``set`` or ``map`` will be ignored.
  29
  30 set
  31 ---
  32
  33 [id] and the corresponding [value] can be one of
  34
  35 * adjust_open [bestfit|width|noadjust] - adjust mode.
  36
  37   - bestfit: adjust to best fit
  38   - width: adjust to width
  39   - noadjust: don't adjust
  40
  41 * browser,
  42   uri_command [string] - command to open external URIs.
  43
  44   The string has to include a ``%s`` which will be replaced with the URI.
  45
  46 * completion_bgcolor,
  47   completion_fgcolor,
  48   completion_g_bgcolor,
  49   completion_g_fgcolor,
  50   completion_hl_bgcolor,
  51   completion_hl_fgcolor,
  52   default_bgcolor,
  53   default_fgcolor,
  54   inputbar_bgcolor,
  55   inputbar_fgcolor,
  56   notification_e_bgcolor,
  57   notification_e_fgcolor,
  58   notification_w_bgcolor,
  59   notification_w_fgcolor,
  60   recolor_darkcolor,
  61   recoler_lightcolor,
  62   statusbar_bgcolor,
  63   statusbar_fgcolor,
  64   search_highlight,
  65   select_text [color] -
  66   colors settings.
  67
  68   The color can be given as hex triplet (#rrggbb) or any color
  69   string understood by GTK+ (e.g. red, green, blue, black, ...).
  70
  71 * default_text [string] - text displayed in the statusbar if no file is opened.
  72
  73 * font [string] - the used font.
  74
  75 * height,
  76   width [int] - default height and width of the zathura window.
  77
  78 * labels [bool] - allow label mode.
  79
  80 * list_printer_command [string] - command to list all available printers.
  81
  82 * n_completion_items [int] - number of completion items to display.
  83
  84 * offset - page offset.
  85
  86 * print_command [string] - command to print the file.
  87
  88   The string has to include
  89   ``%s`` four times. The first occurence of ``%s`` will be replaced with the
  90   printer, the second with additional options given on the command line, the
  91   third with the pages to print and the fourth with the filename.
  92
  93 * recolor [bool] - invert the image.
  94
  95 * save_position, save_zoom_level [bool] - save current page and zoom level in
  96   bookmarks file.
  97
  98 * scroll_step [float] - scroll step.
  99
 100 * scroll_wrap [bool] - wrap scrolling at the end and beginning of the document.
 101
 102 * scrollbars,
 103   show_statusbar,
 104   show_inputbar [bool] -
 105   show statusbar, inputbar and scrollbars.
 106
 107 * smooth_scrolling [float] - smooth scrolling.
 108
 109 * transparency [float] - transparency of rectangles.
 110
 111 * zoom_max,
 112   zoom_min,
 113   zoom_step [float] - maximal and minimal zoom level and zoom step.
 114
 115 map
 116 ---
 117
 118 [key] can be a single character, ``<C-?>`` for ``Ctrl + ?`` like shortcuts,
 119 where ``?`` stands for some key (e.g. ``<C-q>``). Also it can be ``<S-?>`` for
 120 uppercase shortcuts or one of
 121
 122 ``<BackSpace>, <CapsLock>, <Down>, <Esc>, <F[1-12]>, <Left>, <PageDown>,
 123 <PageUp>, <Return>, <Right>, <Space>, <Super>, <Tab>, <Up>``.
 124
 125 [function] and the corresponding [argument] can be one of
 126
 127 * abort - clear command line and buffer.
 128 * adjust_window
 129 * change_buffer [delete_last]: change buffer.
 130
 131   - delete_last: delete last character
 132
 133 * change_mode [mode] - change mode.
 134
 135   For the possible modes see the list of modes below.
 136
 137 * focus_inputbar - focus the inputbar.
 138 * follow - follow a URI.
 139 * navigate [next|previous|left|right] - navigate the document.
 140 * navigate_index [up|down|expand|collapse|select] - nagivate the index.
 141 * quit - quit zathura.
 142 * recolor - toogle recolor setting.
 143 * reload - reload the file.
 144 * rotate - rotate by 90 degrees clockwise.
 145 * scroll [up|down|half_up|half_down|full_up|full_down|left|right] - scroll.
 146 * search [string] - search for the specified string.
 147 * switch_goto_mode - toogle goto mode.
 148 * toggle_fullscreen - toogle fullscreen mode.
 149 * toggle_index - toogle index mode.
 150 * toggle_inputbar - toogle inputbar display setting.
 151 * toogle_statusbar - toogle statusbar display setting.
 152 * zoom [in|out|float] - zoom in, out or to a specific zooming level.
 153
 154 [mode] can be one of
 155
 156 * all
 157 * fullscreen
 158 * index
 159 * normal
 160 * insert
 161 * visual
 162
 163 If [mode] is omitted, all will be used.
 164
 165 EXAMPLE
 166 =======
 167
 168 ::
 169
 170   # zathurarc
 171
 172   # colors
 173   set statusbar_bgcolor #00FF00
 174   set statusbar_fgcolor red
 175
 176   # settings
 177   set height 1024
 178   set width 768
 179   set adjust_open width
 180
 181   # key bindings
 182   map <PageUp> navigate previous
 183   map <PageDown> navigate next
 184
 185   map + zoom in
 186   map - zoom out
 187
 188   map <C-q> quit
 189
 190
 191 SEE ALSO
 192 ========
 193
 194 zathura(1)