background_colorSpecifies the background color of the app (this is different from the background color of PDF page which is configured using :ref:`customcolor`, this color is only shown when the displayed page is smaller than the srceen). The syntax to set colors is:
\n\n\nbackground_color r g b\n\nwhere r,g and b red, green and blue values between 0 and 1. For example in order to set the background color to gray we can add the following to our prefs_user.config:
\nbackground_color 0.5 0.5 0.5\n\ndark_mode_background_colorSpecifies the background color when dark mode is enabled.
\ndark_mode_contrastWhite text in dark mode can be annoying for the eyes. This option allows us to dim the white colors when dark mode is enabled. Allowed values are between 0.0 and 1.0.
\ntext_highlight_colorHighlight color when text is selected using mouse.
\nvisual_mark_colorThis is the color of the transparent visual mark explained in :ref:`usage:Visual Mark` (this feature originally had an entirely different functionality which is why it is called vertical line even though there is nothing vertical about it!).\nAllowed values are RGBA colors between 0.0 and 1.0. For example, to set the color to a transparent red we add the following to our prefs_user.config:
\nvisual_mark_color 1.0 0.0 0.0 0.1\n\nruler_modeIf it is 1, we highlight a rectangle around the current line in visual mark mode. Otherwise, we highlight below the current line.
\n\nruler_mode 1\n\nruler_padding and ruler_x_paddingAdditional padding for ruler. Makes the ruler a little larger and more readable.
\n\nruler_padding 1.0\nruler_x_padding 5.0\n\nruler_padding and ruler_x_paddingAdditional padding for ruler. Makes the ruler a little larger and more readable.
\n\nruler_padding 1.0\nruler_x_padding 5.0\n\nvisual_mark_next_page_fractionWhen we go to the next page while in visual mark mode, this setting determines which location of screen the new line should be located at. The values are between -1 and 1. With 0 being the middle of the screen and 1 and -1 being the top and bottom of the screen respectively.
\n\nvisual_mark_next_page_fraction 0.5\n\nvisual_mark_next_page_thresholdDetermines at which point in screen we move to the next page. Acceptable range is between 0 and visual_mark_next_page_fraction.
search_highlight_colorThe color used to highlight search results.
\nlink_highlight_colorThe color used to highlight links in PDF files.
\nsynctex_highlight_colorHighlight color for synctex forward search highlights.
\nsearch_url_a to search_url_zThe web addresses used for performing external_search command. (see :ref:`usage:External Search`). Example:
\nsearch_url_g https://www.google.com/search?q=\n\nmiddle_click_search_engine and shift_middle_click_search_engineThe letter corresponding to search_url_* configs to use when middle clicking/shift-middle clicking on text.\nExample:
\nmiddle_click_search_engine g\n\nThis causes the search engine configures using search_url_g to be used when middle clicking on text.
middle_click_search_engine and shift_middle_click_search_engineThe letter corresponding to search_url_* configs to use when middle clicking/shift-middle clicking on text.\nExample:
\nmiddle_click_search_engine g\n\nThis causes the search engine configures using search_url_g to be used when middle clicking on text.
zoom_inc_factorThe fraction by which we enlarge the page when zooming in/out.
\nwheel_zoom_on_cursorIf set, when using mouse wheel to zoom we zoom in on mouse cursor instead of middle of screen.
\nvertical_move_amount and horizontal_move_amountHow many inches we move vertically/horizontally when performing move_* commands.
\nvertical_move_amount and horizontal_move_amountHow many inches we move vertically/horizontally when performing move_* commands.
\nmove_screen_ratioThe fraction of screen by which we move when executing screen_down and screen_up commands. (note that despite the name, the values are fractions between 0 and 1, not percentages)
flat_tocDisplays a simplified flat table of contents instead of a hierarchial one. This can improve performance for documents with very large number of table of contents entries (thousands).\nAcceptable values are 0 and 1.
\ncollapsed_tocIf set, we initially collapse all table of content entries.
\nshould_use_multiple_monitorsIf it is 1, when launching the application if we detect multiple monitors, we automatically launch the helper window in second monitor.\nAcceptable values are 0 and 1.
\nshould_load_tutorial_when_no_other_fileIf the last opened document is empty, load the tutorial pdf instead.
\nshould_launch_new_instanceWarning
\nThis is deprecated. Use should_launch_new_window instead.
\nIf it is 0, then we use the previous instance of sioyek when launching a new file, otherwise a new instance is launched every time we open a new file.
\nshould_launch_new_windowIf it is 0, then we use the previous window of sioyek when opening a new file, otherwise a new window is opened every time we open a new file.
\ninverse_search_commandThe command to use when trying to do inverse search into a LaTeX document. %1 expands to the name of the file and %2 expans to the line number. For example:
\n\ninverse_search_command "C:\\path\\to\\vscode\\Code.exe" -r -g %1:%2\n\nhighlight_color_a to highlight_color_zThe color to use for highlights of type a to z.
should_draw_unrendered_pagesIf set, we display a checkerboard pattern for unrendered pages (by default we display nothing).
\nrerender_overviewNormally we reuse the rendered page for overview window. This may cause the overview page to be blurry or too sharp if there is a significant difference between the zoom levels of the main window and overview window.\nIf rerender_overview is set, we rerender overview which solves this issue at the cost of some additional computation.
\nrerender_overview 1\n\ndefault_dark_modeUse dark mode by default.
\nsort_bookmarks_by_locationIf set, we sort the bookmarks by their location instead of their creation time.
\nfont_sizeSize of the UI font.
\nui_fontThe font to use for UI text.
\n\nui_font Segoe UI Emoji\n\nitem_list_prefixA prefix character to use before list of items (for example can be used to display a checkmark before each of the bookmarks).
\n\nitem_list_prefix \u2714\ufe0f\n\ncheck_for_updates_on_startupIf set, sioyek checkes for new versions on startup and notifies the user if a new version if available.
\n\ncheck_for_updates_on_startup 1\n\ncustom_background_color and custom_text_colorSpecify the background and text color when using custom color mode (by executing toggle_custom_color command).
\ncustom_background_color 0.18 0.20 0.25\ncustom_text_color 1.0 1.0 1.0\n\ncustom_background_color and custom_text_colorSpecify the background and text color when using custom color mode (by executing toggle_custom_color command).
\ncustom_background_color 0.18 0.20 0.25\ncustom_text_color 1.0 1.0 1.0\n\nstartup_commandsSemicolon-separated list of commands to execute on startup. For example, to start in custom color mode and in visual scroll mode, you can add the following (the command names are the same as the ones displayed when opening the command window using :):
\nstartup_commands toggle_custom_color;toggle_visual_scroll\n\nstatus_bar_color, status_bar_text_color and status_bar_font_sizeAllow you to customize the appearance of status bar.
\n\nstatus_bar_color 0 0 0\nstatus_bar_text_color 1 1 1\nstatus_bar_font_size 10\n\nstatus_bar_color, status_bar_text_color and status_bar_font_sizeAllow you to customize the appearance of status bar.
\n\nstatus_bar_color 0 0 0\nstatus_bar_text_color 1 1 1\nstatus_bar_font_size 10\n\nstatus_bar_color, status_bar_text_color and status_bar_font_sizeAllow you to customize the appearance of status bar.
\n\nstatus_bar_color 0 0 0\nstatus_bar_text_color 1 1 1\nstatus_bar_font_size 10\n\nexecute_command_a to execute_command_zPredefined shell commands to be executed using execute_predefined_command. %1 expands to the path of the current file, %2 expands to name of the current file and %3 expands to current selected text.\nFor example, suppose you have a command named ocr which takes a file path and produces an OCR'd version of the document. You can add the following to you prefs_user.config:
\nexecute_command_o ocr "%1"\n\nYou can later quickly invoke this command by executing execute_predefined_command and then pressing o.
Warning
\nThe command parsing code in sioyek is not very good. For example it can not handle multiple commands like command1 args;command2 or commands that include spaces. If you want to run a complex command, first put all commands in a script file and then run the script file using using sioyek like this: /path/to/script.sh %1 %2 %3.
papers_folder_pathPath to a directory on your computer. Sioyek monitors the changes in this directory and if a new file is added to this directory while we have a pending portal, this file is automatically used as the destination of the portal. This is useful when creating a portal from a reference in a paper to the actual reference file.
\ndisplay_resolution_scaleManual resolution scaling. Can be useful for some very high resolution displays which report the wrong resolution.
\nlinear_filterIf set, we use linear texture filtering instead of the normal nearest neighbour filtering. This is useful when using manual display resolution scale which causes the nearest neighbour filter to look bad.
\nmain_window_size, main_window_move, helper_window_size, helper_window_move, single_main_window_size and single_main_window_moveConfigures the size and position of the main window and the helper window. single_main_window_* is used when helper window is closed and the other configs are used when both windows are opened.\nThese values are automatically written to auto.cong file when sioyek exits but you can manually override them by setting them in your prefs_user.config.
\nsingle_main_window_size 1824 988\nsingle_main_window_move 22 21\nmain_window_size 1824 988\nmain_window_move 18 44\nhelper_window_size 1891 1033\nhelper_window_move 1951 0\n\nmain_window_size, main_window_move, helper_window_size, helper_window_move, single_main_window_size and single_main_window_moveConfigures the size and position of the main window and the helper window. single_main_window_* is used when helper window is closed and the other configs are used when both windows are opened.\nThese values are automatically written to auto.cong file when sioyek exits but you can manually override them by setting them in your prefs_user.config.
\nsingle_main_window_size 1824 988\nsingle_main_window_move 22 21\nmain_window_size 1824 988\nmain_window_move 18 44\nhelper_window_size 1891 1033\nhelper_window_move 1951 0\n\nmain_window_size, main_window_move, helper_window_size, helper_window_move, single_main_window_size and single_main_window_moveConfigures the size and position of the main window and the helper window. single_main_window_* is used when helper window is closed and the other configs are used when both windows are opened.\nThese values are automatically written to auto.cong file when sioyek exits but you can manually override them by setting them in your prefs_user.config.
\nsingle_main_window_size 1824 988\nsingle_main_window_move 22 21\nmain_window_size 1824 988\nmain_window_move 18 44\nhelper_window_size 1891 1033\nhelper_window_move 1951 0\n\nmain_window_size, main_window_move, helper_window_size, helper_window_move, single_main_window_size and single_main_window_moveConfigures the size and position of the main window and the helper window. single_main_window_* is used when helper window is closed and the other configs are used when both windows are opened.\nThese values are automatically written to auto.cong file when sioyek exits but you can manually override them by setting them in your prefs_user.config.
\nsingle_main_window_size 1824 988\nsingle_main_window_move 22 21\nmain_window_size 1824 988\nmain_window_move 18 44\nhelper_window_size 1891 1033\nhelper_window_move 1951 0\n\nmain_window_size, main_window_move, helper_window_size, helper_window_move, single_main_window_size and single_main_window_moveConfigures the size and position of the main window and the helper window. single_main_window_* is used when helper window is closed and the other configs are used when both windows are opened.\nThese values are automatically written to auto.cong file when sioyek exits but you can manually override them by setting them in your prefs_user.config.
\nsingle_main_window_size 1824 988\nsingle_main_window_move 22 21\nmain_window_size 1824 988\nmain_window_move 18 44\nhelper_window_size 1891 1033\nhelper_window_move 1951 0\n\nmain_window_size, main_window_move, helper_window_size, helper_window_move, single_main_window_size and single_main_window_moveConfigures the size and position of the main window and the helper window. single_main_window_* is used when helper window is closed and the other configs are used when both windows are opened.\nThese values are automatically written to auto.cong file when sioyek exits but you can manually override them by setting them in your prefs_user.config.
\nsingle_main_window_size 1824 988\nsingle_main_window_move 22 21\nmain_window_size 1824 988\nmain_window_move 18 44\nhelper_window_size 1891 1033\nhelper_window_move 1951 0\n\ntouchpad_sensitivityCan be used to adjust the sensitivity of the touchpad.
\n\ntouchpad_sensitivity 0.1\n\npage_separator_width and page_separator_colorUsed to adjust the appearance of page separator.
\n\npage_separator_width 2\npage_separator_color 0.5 0.5 0.5\n\npage_separator_width and page_separator_colorUsed to adjust the appearance of page separator.
\n\npage_separator_width 2\npage_separator_color 0.5 0.5 0.5\n\nfit_to_page_width_ratioRatio of screen width to use when using fit_to_screen_width_ratio command. Can be useful for very wide screens.
\nfit_to_page_width_ratio 0.75\n\ncreate_table_of_contents_if_not_existsIf set and the file doesn't have a table of contents, we use heuristic methods to create a table of contents. You can use max_created_toc_size to prevent creating very large table of contents.
\ncreate_table_of_contents_if_not_exists 1\nmax_created_toc_size 5000\n\nforce_custom_line_algorithmUse legacy line detection algorithm instead of the mupdf one.
\noverview_size and overview_offsetAdjust the size of overview window. The values are in normalized window coordinates between -1 and 1.
\n\noverview_size 0.852604 0.597729\noverview_offset -0.0119792 0.120151\n\noverview_size and overview_offsetAdjust the size of overview window. The values are in normalized window coordinates between -1 and 1.
\n\noverview_size 0.852604 0.597729\noverview_offset -0.0119792 0.120151\n\nshow_doc_pathShow the full document path instead of just the file name in list of recently opened documents.
\nshould_warn_about_user_key_overrideIf set, we warn the user in command line when overriding already degined keybinds.
\nsingle_click_selects_wordsIf set, single clicking and dragging mouse selects entire words rather than characters.
\nshift_click_command, control_click_command, alt_click_command, shift_right_click_command, control_right_click_command, and alt_right_click_commandCustom commands to run when mouse click is pressed while modifier keys are held down. For example:
\n\ncontrol_click_command overview_under_cursor\n\nIf set, single clicking and dragging mouse selects entire words rather than characters.
\nshift_click_command, control_click_command, alt_click_command, shift_right_click_command, control_right_click_command, and alt_right_click_commandCustom commands to run when mouse click is pressed while modifier keys are held down. For example:
\n\ncontrol_click_command overview_under_cursor\n\nIf set, single clicking and dragging mouse selects entire words rather than characters.
\nshift_click_command, control_click_command, alt_click_command, shift_right_click_command, control_right_click_command, and alt_right_click_commandCustom commands to run when mouse click is pressed while modifier keys are held down. For example:
\n\ncontrol_click_command overview_under_cursor\n\nIf set, single clicking and dragging mouse selects entire words rather than characters.
\nshift_click_command, control_click_command, alt_click_command, shift_right_click_command, control_right_click_command, and alt_right_click_commandCustom commands to run when mouse click is pressed while modifier keys are held down. For example:
\n\ncontrol_click_command overview_under_cursor\n\nIf set, single clicking and dragging mouse selects entire words rather than characters.
\nshift_click_command, control_click_command, alt_click_command, shift_right_click_command, control_right_click_command, and alt_right_click_commandCustom commands to run when mouse click is pressed while modifier keys are held down. For example:
\n\ncontrol_click_command overview_under_cursor\n\nIf set, single clicking and dragging mouse selects entire words rather than characters.
\nshift_click_command, control_click_command, alt_click_command, shift_right_click_command, control_right_click_command, and alt_right_click_commandCustom commands to run when mouse click is pressed while modifier keys are held down. For example:
\n\ncontrol_click_command overview_under_cursor\n\nIf set, single clicking and dragging mouse selects entire words rather than characters.
\nuse_legacy_keybindsBy default we use legacy keybindings which have some problems. For example to bind the % key, you would have to enter something like this:
\ncommand <S-%>\n\nwhich is a little weird. Also legacy keybinds don't work well with some keyboard layouts. If you set use_legacy_keybinds to 0, then we use a new method for keybind parsing which allows you to do something like this:
\ncommand %\n\nwhich also works with all keyboard layouts. Since this is a backwards incompatible change, use_legacy_keybinds is activated by default.
start_with_helper_windowOpen helper window when sioyek starts.
\nprerender_next_page_presentationWhen in presentation mode, we pre-render the next page to remove flickering when moving between pages.
\nhighlight_middle_clickIf enabled, highlights the selected text by middle clicking on it.
\nsmooth_scroll_speed and smooth_scroll_dragWhen smooth scrolling is enabled (using toggle_smooth_scroll command), these control the speed and slowdown of movement.
\nsmooth_scroll_speed 3\nsmooth_scroll_drag 3000\n\nsmooth_scroll_speed and smooth_scroll_dragWhen smooth scrolling is enabled (using toggle_smooth_scroll command), these control the speed and slowdown of movement.
\nsmooth_scroll_speed 3\nsmooth_scroll_drag 3000\n\nsuper_fast_searchIf enabled, indexes the document text and considerably speeds of searching. It also enables regex_search command which uses the index to search for regular expressions.
show_closest_bookmark_in_statusbarIf enabled, displays the text for closest bookmark in the statusbar.
\nshow_close_portal_in_statusbarIf enabled, it displays a statusbar message when we are close to a portal.
\nprerender_page_countThe number of pages to prerender. The larger it is, the more memory we use but there will be less flickering when quickly moving pages.
\ncase_sensitive_searchIt is enabled by default. If disabled, we use case-insensitive searching.
\nshow_document_name_in_statusbarDisplays the document name in sioyek's statusbar.
\nui_background_color and ui_text_colorThe background and text color of (unselected) UI elements.
\nui_background_color and ui_text_colorThe background and text color of (unselected) UI elements.
\nui_selected_background_color and ui_selected_text_colorThe background and text color of selected UI elements.
\nui_selected_background_color and ui_selected_text_colorThe background and text color of selected UI elements.
\nnumeric_tagsIf enabled we use numeric (instead of alphabetical) tags when executing keyboard_* commands.
sourceIncludes another config file, which is useful for themes and extensions.
\n\n# includes file.config in this configuration file\n\n