Commands

All sioyek keybindings execute some command. You can open a searchable list of all sioyek commands by pressing : by default. Below is a list of all available sioyek commands.

`goto_begining`

Go to the beginning of the document. If prefixed with a number, it will go to that page number.

`goto_end`

Go to the end of the document. If prefixed with a number, it will go to that page number.

`goto_definition`

While the visual ruler is highlighting a line, executing goto_definition will jump to the location of reference in that line. For example, executing this command while a line containing “Figure 2.1” is highlighted will jump to the location of the figure in the document.

`overview_definition`

Similar to goto_definition, but instead of jumping to the location of the reference, it will show a small overview of the reference in the overview window.

`portal_to_definition`

Similar to goto_definition, but instead of jumping to the location of the reference, it will create a portal from current location to the location of the definition.

`next_item`

While a search is in progress, this command will jump to the next search result.

`previous_item`

While a search is in progress, this command will jump to the previous search result.

`set_mark`

Mark the location with the symbol entered following the set_mark command.

`goto_mark`

Go to the mark previously set using set_mark.

`goto_page_with_page_number`

Go to the page number corresponding to entered text.

`search`

Search for a text in document.

`regex_search`

Search for a regular expression in the document.

`move_down`, `move_up`, `move_left`, `move_right`

Move the document.

`zoom_in` and `zoom_out`

Change the zoom level.

`fit_to_page_width` and `fit_to_page_height`

Fit the current page to window width/height.

`fit_to_page_width_smart` and `fit_to_page_height_smart`

Fit the current page (ignoring white margins) to window width/height.

`next_page` and `previous_page`

Navigate to the next/previous page.

`open_document`

Open the file browser to open a document.

`add_bookmark`

Add a bookmark to the current location at the document with the entered text.

`add_highlight`

Add the selected text as a highlight with the type of following symbol.

`goto_toc`

Open the table of contents.

`goto_bookmark`

Open bookmark list of current document.

`goto_highlight`

Open highlight list of current document.

`goto_bookmark_g`

Open bookmark list of all documents.

`goto_highlight_g`

Open highlight list of all documents.

`portal`

Set the current location as the portal source. If a portal source is already set, then use the current location as the portal destination and create the portal.

`next_state`, `prev_state`

Go forward/backward in history.

`delete_bookmark`

Delete the closest bookmark to the current location.

`delete_highlight`

Delete the last highlight clicked on.

`delete_portal`

Delete the closest portal to the current location.

`goto_portal`

Go to the destination of the closest portal source to the current document location.

`edit_portal`

Jump to the destination of the closest portal. All the edits you do to the location/zoom is applied to the portal when you go back by executing prev_state.

`open_prev_doc`

Open a list of all opened document using sioyek.

`open_document_embedded`

Open an embedded file browser in sioyek.

`open_document_embedded_from_current_path`

Open an embedded file browser in sioyek. Initially, we are in the directory of current document.

`copy`

Copy the selected text into clipboard.

`toggle_fullscreen`

Toggle fullscreen mode.

`toggle_one_window`

Open/close the helper window.

`toggle_highlight`

Toggle whether we highlight PDF links.

`toggle_synctex`

Toggle synctex mode. In synctex mode, right clicking on a PDF file opens the corresponding location in the latex file using the configured text editor.

`command`

Open a list of all sioyek commands.

`external_search`

Search the selected text in the extenal search engine corresponding to the following symbol.

`open_selected_url`

Open the selected URL in a browser.

`screen_up` and `screen_down`

Move the screen up/down.

`next_chapter` and `prev_chapter`

Go to the next/previous chapter in the current document.

`toggle_dark_mode`

Switch between light/dark colorschemes.

`toggle_presentation_mode`

Toggle presentation mode. In presentation mode we only show one page at a time and the current page fills the entire window.

`toggle_mouse_drag_mode`

Toggle mouse drag mode. In mouse drag mode, clicking and dragging using mouse moves the document (instead of selecting text).

`close_window`

Close the current window.

`quit` and `q`

Quit sioyek (closes all windows).

`open_link`

Open the PDF links using keyboard. Each link will be shown with a label and the link corresponding to the entered label text will be opened.

`keyboard_select`

Select text using keyboard. Each word in the document will be shown with a label. You should enter the labels corresponding to the beginning and end of the selection (separated by a space).

`keyboard_smart_jump` and `keyboard_overview`

Perform a smartjump (or open an overview) using keyboard. Each word in the document will be shown with a label and we will smart jump to the location of the reference corresponding to the entered label.

`keys` and `prefs`

Open the keys.config / prefs.config file.

`keys_user` and `prefs_user`

Open the keys_user.config / prefs_user.config file.

`export` and `import`

Export/import sioyek data to/from a json file.

`enter_visual_mark_mode`

Place a visual mark at the center of screen.

`move_visual_mark_down` and `move_visual_mark_up`

Move the visual mark up and down which highlights the previous/next line.

`toggle_visual_scroll`

Toggle visual scroll mode. In visual scroll mode, mouse wheel moves the ruler (the visual mark) instead of scrolling the document.

`toggle_horizontal_scroll_lock`

Toggles the horizontal scroll lock which prevents scrolling in horizontal direction (useful for touchpad users).

`toggle_custom_color`

Toggle custom color mode. In this mode, we change the text/background color of the document to the colors specified in prefs_user.config.

`execute`

Execute the entered text as a shell command.

`execute_predefined_command`

Execute the predefined command (in prefs_user.config) corresponding to the following symbol.

`embed_annotations`

Export a new version of the current document with all sioyek annotations embedded so that they are visible in other software.

`copy_window_size_config`

Copy the current window size configuration (useful when you want to set the configs in prefs_user.config).

`toggle_select_highlight`

Toggle select highlight mode. In this mode, just selecting the text automatically highlights it.

`set_select_highlight_type`

Set the highlight type used in select highlight mode.

`open_last_document`

Open the previous document.

`toggle_window_configuration`

Toggle between one window/two window configuration settings.

`prefs_user_all` and `keys_user_all`

Show a list of all prefs_user.config / keys_user.config files discovered by sioyek.

`fit_to_page_width_ratio`

Similar to fit_to_page_width but instead of fitting to the entire screen width, we fit to a ratio configured in prefs_user.config.

`smart_jump_under_cursor` and `overview_under_cursor`

Perform a smart jump (or open an overview) to the reference under the mouse cursor.

`close_overview`

Close the overview window.

`visual_mark_under_cursor`

Place a visual mark (ruler) under the mouse cursor.

`close_visual_mark`

Exit the visual mark (ruler) mode.

`zoom_in_cursor` and `zoom_out_cursor`

Zoom in/out on the mouse cursor.

`goto_left`, `goto_right`, `goto_top_of_page` and `goto_bottom_of_page`

Go to the left/right/top/bottom of the current page.

`goto_left_smart` and `goto_right_smart`

Go to the left/right side of the current page ignoring white margins.

`rotate_clockwise` and `rotate_counterclockwise`

Rotate the document.

`goto_next_highlight` and `goto_prev_highlight`

Go to the next/previous highlight in the current document.

`goto_next_highlight_of_type` and `goto_prev_highlight_of_type`

Go to the next/previous highlight in the current document with following symbol’s type.

`add_highlight_with_current_type`

Add a highlight with the type specified using set_select_highlight_type.

`enter_password`

Enter the password for password-protected documents.

`toggle_fastread`

Highlight the first few characters of each word. Supposedly it may increase reading speed (unconfirmed).

`new_window`

Open a new sioyek window.

`toggle_statusbar`

Toggle the statusbar at the bottom of the screen.

`reload`

Reload the current document.

`synctex_under_cursor`

Perform a synctex search for the location under mouse cursor.

`set_status_string`

Set a message to be displayed in sioyek’s statusbar.

`clear_status_string`

Clear the message in sioyek’s statusbar.

`toggle_titlebar`

Toggle the window titlebar.

`next_preview` and `previous_preview`

If there are multiple possible previews for the overview window, move to the next/previous preview.

`goto_overview` and `portal_to_overview`

Go to / create a portal to the location displayed in the overview window.

`goto_selected_text`

Jump to the location of current selected text.

`focus_text`

If in visual mark (ruler) mode, focus the ruler on the line corresponding to the entered text.

`goto_window`

Open a searchable list of sioyek windows.

`toggle_smooth_scroll_mode`

Toggle smooth scroll mode. In this mode, scrolling is done smoothly.

`toggle_scrollbar`

Toggle the scrollbar.

`overview_to_portal`

Open the overview window to the closest portal to current document location.

`select_rect`

Select a rectangle (can be used in extensions using %{selected_rectangle} variable).

`donate`

Open donation page.

`overview_next_item` and `overview_prev_item`

Open overviews to previous/next search items.

Commands

goto_begining

goto_end

goto_definition

overview_definition

portal_to_definition

next_item

previous_item

set_mark

goto_mark

goto_page_with_page_number

search

regex_search

move_down, move_up, move_left, move_right

zoom_in and zoom_out

fit_to_page_width and fit_to_page_height

fit_to_page_width_smart and fit_to_page_height_smart

next_page and previous_page

open_document

add_bookmark

add_highlight

goto_toc

goto_bookmark

goto_highlight

goto_bookmark_g

goto_highlight_g

portal

next_state, prev_state

delete_bookmark

delete_highlight

delete_portal

goto_portal

edit_portal

open_prev_doc

open_document_embedded

open_document_embedded_from_current_path

copy

toggle_fullscreen

toggle_one_window

toggle_highlight

toggle_synctex

command

external_search

open_selected_url

screen_up and screen_down

next_chapter and prev_chapter

toggle_dark_mode

toggle_presentation_mode

toggle_mouse_drag_mode

close_window

quit and q

open_link

keyboard_select

keyboard_smart_jump and keyboard_overview

keys and prefs

keys_user and prefs_user

export and import

enter_visual_mark_mode

move_visual_mark_down and move_visual_mark_up

toggle_visual_scroll

toggle_horizontal_scroll_lock

toggle_custom_color

execute

execute_predefined_command

embed_annotations

copy_window_size_config

toggle_select_highlight

set_select_highlight_type

open_last_document

toggle_window_configuration

prefs_user_all and keys_user_all

fit_to_page_width_ratio

smart_jump_under_cursor and overview_under_cursor

close_overview

visual_mark_under_cursor

close_visual_mark

zoom_in_cursor and zoom_out_cursor

goto_left, goto_right, goto_top_of_page and goto_bottom_of_page

goto_left_smart and goto_right_smart

rotate_clockwise and rotate_counterclockwise