Start documenting shortcut functions in more detail

Signed-off-by: Sebastian Ramacher <sebastian+dev@ramacher.at>
This commit is contained in:
Sebastian Ramacher 2014-02-22 22:18:17 +01:00
parent ba917f174b
commit ab9f5515b5

View file

@ -206,35 +206,103 @@ Shortcut functions
^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^
The following shortcut functions can be mapped: The following shortcut functions can be mapped:
* ``abort``
:: Switch back to normal mode.
Function Description * ``adjust_window``
abort Switch back to normal mode Adjust page width. Possible arguments are ``best-fit`` and ``width``.
adjust_window Adjust page width
change_mode Change current mode * ``change_mode``
display_link Display link target
focus_inputbar Focus inputbar Change current mode. Pass the desired mode as argument.
follow Follow a link
goto Go to a certain page * ``display_link``:
jumplist Move forwards/backwards in the jumplist
navigate Navigate to the next/previous page Display link target.
navigate_index Navigate through the index
print Show the print dialog * ``focus_inputbar``
quit Quit zathura
recolor Recolor the pages Focus inputbar.
reload Reload the document
rotate Rotate the page * ``follow``
scroll Scroll
search Search next/previous item Follow a link.
set Set an option
toggle_fullscreen Toggle fullscreen * ``goto``
toggle_index Show or hide index
toggle_inputbar Show or hide inputbar Go to a certain page.
toggle_page_mode Toggle between one and multiple pages per row
toggle_statusbar Show or hide statusbar * ``jumplist``
zoom Zoom in or out
Move forwards/backwards in the jumplist.
* ``navigate``
Navigate to the next/previous page.
* ``navigate_index``
Navigate through the index.
* ``print``
Show the print dialog.
* ``quit``
Quit zathura.
* ``recolor``
Recolor pages.
* ``reload``
Reload the document.
* ``rotate``
Rotate the page. Pass ``rotate-ccw`` as argument for counterclockwise rotation
and ``rotate-cw`` for clockwise rotation.
* ``scroll``
Scroll.
* ``search``
Search next/previous item. Pass ``forward`` as argument to search for the next
hit and ``backward`` to search for the previous hit.
* ``set``
Set an option.
* ``toggle_fullscreen``
Toggle fullscreen.
* ``toggle_index``
Show or hide index.
* ``toggle_inputbar``
Show or hide inputbar.
* ``toggle_page_mode``
Toggle between one and multiple pages per row.
* ``toggle_statusbar``
Show or hide statusbar.
* ``zoom``
Zoom in or out.
Pass arguments Pass arguments
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^