Pdf. Просмотр. Sioyek

Обновлено 2024-10-21 27 мин. для прочтения Computer-Science

Просмотрщик pdf Sioyek.

Содержание

1 Общая информация

2 Установка

2.1 Gentoo

3 Конфигурацию

3.1 Конфигурационный файл

  • Системная настройка клавиатуры: /etc/sioyek/keys.config.
  • Системные общие настройки: /etc/sioyek/prefs.config.

3.2 Установка как приложения по умолчанию

  • Приложение по умолчанию устанавливается с помощью xdg-utils (см. XDG. Приложения MIME):
    1xdg-mime default sioyek.desktop application/pdf

4 Привязка клавиш по умолчанию

4.1 Открытие файлов

  • o : открыть меню выбора файла (open_document);
  • Shift-o : открыть список недавно открытых файлов (open_prev_doc);
  • Ctrl-o : открыть встроенный броузер файловой системы (open_document_embedded);
  • Ctrl-Shift-o : открыть встроенный броузер файловой системы в папке текущего документа (open_document_embedded_from_current_path);
  • delete : удалить файл из списка (не удаляет файл в файловой системе);
  • Ctrl-t : открыть файл в новом окне;
  • параметр командной строки --new-window открывает новое окно изнутри;
  • команда goto_window позволяет переключаться между открытыми окнами.

4.1.1 Мои настройки

  • Мне удобнее открывать новое окно для каждого файла:
    1## If set, we open a new sioyek window when a new file is opened, otherwise we open the file in the previous window
2should_launch_new_window 1

4.2 Перемещение

  • Можно перемещаться с помощью клавиш со стрелками (команды: move_down, move_up, move_left, move_right);
  • можно использовать колесо мыши для прокрутки экрана;
  • gg : переход на первую страницу (goto_begining);
  • G : перехода на последнюю страницу (goto_end);
  • номер страницы и затем gg : перейти на нужную страницу (например, чтобы перейти на страницу 42, необходимо ввести 42gg);
  • нажать HOME, откроется меню, в котором вы можете ввести номер страницы : перейти на нужную страницу (goto_page_with_page_number);
  • space : переместиться на экран вниз (screen_down);
  • Shift-space : переместиться на экран вверх (screen_up);
  • Ctrl-PageDown, Ctrl-PageUp : переход к следующей или предыдущей странице (next_page, previous_page);
  • t : открыть оглавление с возможностью поиска (goto_toc);
  • gc : переход к следующей главе (next_chapter);
  • gC : переход к предыдущей главе (prev_chapter);
  • команда toggle_scrollbar переключает полосу прокрутки.

4.3 Масштабирование

4.3.1 Системные настройки

  • + : увеличить масштаб (zoom_in);
  • - : уменьшить масштаб (zoom_out);
  • можно использовать колесо мыши, удерживая Cntrl, для увеличения или уменьшения масштаба;
  • f9, = : подогнать страницу по ширине окна (fit_to_page_width);
  • f10 : подогнать страницу по ширине окна, игнорируя поля страницы (fit_to_page_width_smart).

4.3.2 Мои настройки

  • a: подогнать по высоте страницы:
    1## Similar to fit_to_page_width, but for height
2fit_to_page_height  a
  • Sift-a: подогнать по высоте страницы:
    1## Similar to fit_to_page_width_smart but for height
2fit_to_page_height_smart  S-a
  • s: подогнать страницу по ширине окна (fit_to_page_width):
    1## Fill the screen width
2fit_to_page_width  s
  • Визуально разделяю страницы:
    1## Configure the appearance of page separator
2page_separator_width 2
3page_separator_color	0.9 0.9 0.9

4.4 Навигация по истории

  • Хранится полная история местоположений.
  • backspace или Ctrl-LeftArrow : вернуться назад по истории (prev_state);
  • Shift-backspace или Ctrl-RightArrow : вернуться вперёд по истории (next_state).

4.5 Обзор

  • Можно щёлкнуть правой кнопкой мыши ссылку, чтобы открыть краткий обзор места назначения ссылки; перемещаться по этому обзору можно с помощью колесика мыши;
  • если в PDF-документе нет ссылок, можно щёлкнуть правой кнопкой мыши по элементам, и просмотрщик попытается открыть обзор места назначения элемента;
  • щёлкнуть средней кнопкой мыши по элементам, чтобы напрямую перейти к их местоположению, вместо того, чтобы открывать обзор.

4.6 Визуальная метка

  • Если вы щёлкнете правой кнопкой мыши по строке текста в PDF-файле, sioyek отобразит визуальную подсветку под этой строкой (визуальная метка).
  • Вы всегда можете вернуться к последнему местоположению визуальной метки, нажав ` и затем щелкнуть правой кнопкой мыши или нажать ` ещё раз.
  • Можно использовать для слежения за строкой.
  • Можно переместить визуальный знак на следующую или предыдущую строку, нажав j или k (move_visual_mark_down, move_visual_mark_up).
  • Вы можете переключить режим визуальной прокрутки, нажав F7 (toggle_visual_scroll). В этом режиме колесо мыши перемещает визуальную метку вверх и вниз.
  • Если установлено в prefs_user.config команда ruler_mode 0, строка просто подчёркивается.
  • Если установлено в prefs_user.config команда ruler_mode 1, рисуется прямоугольник вокруг текущей строки.
  • Пока строка выделена, вы можете нажать l (overview_definition), чтобы создать обзор ссылки в текущей строке.

= Аналогичным образом вы можете нажать ] (portal_to_definition) и Ctrl+] (goto_definition), чтобы создать портал или перейти к определению.

4.7 Поиск

  • / или Ctrl-f : открыть меню поиска (search);
  • после начала поиска можно нажать n для перехода к следующему совпадению или N для перехода к предыдущему совпадению (next_item и previous_item);
  • c/ : поиск только в текущей главе (chapter_search);
  • <begin,end>что искать : ограничить диапазон поиска определённым диапазоном страниц;
  • команды overview_next_item и overview_prev_item могут открыть обзор результатов поиска, а не переходить к ним.

4.7.1 Мои настройки

  • Включим быстрый поиск:
    1## Use a super fast index for search instead of the mupdf's implementation
2super_fast_search 1
  • При поиске не будем учитывать регистр символов:
    1## Use case-insensitive search
2case_sensitive_search 0

4.8 Метки

  • Иногда при чтении документа необходимо бросить взгляд на содержимое предыдущих страниц и быстро вернуться в исходное место.
  • С помощью меток вы можете отметить своё местоположение, прежде, чем просмотреть предыдущий контент, а затем быстро вернуться к местоположению метки.
  • Чтобы создать метку, сначала нажмите m (set_mark), а затем символ алфавита (этот символ будет названием метки, вы можете иметь несколько меток с разными именами).
  • Например, чтобы создать отметку с именем a вашего текущего местоположения, введите ma.
  • Вы можете перейти к метке, нажав ` и указав название метки.
  • Отметки постоянные (сохраняются даже при закрытии приложения).
  • Знаки нижнего регистра являются локальными для текущего документа, а знаки верхнего регистра являются глобальными для всех файлов приложения.

4.9 Закладки

  • Закладки аналогичны меткам, за исключением того, что вместо буквы алфавита в них используется текстовое описание.
  • Добавить закладку можно, нажав b (add_bookmark) и затем введя текстовое описание закладки в открывшемся меню.
  • Вы можете открыть список закладок текущего документа с возможностью поиска, введя gb (goto_bookmark).
  • Вы можете открыть список всех закладок во всех документах с возможностью поиска, введя gB (goto_bookmark_g).
  • Вы можете удалить ближайшую к текущему местоположению закладку, введя команду db (delete_bookmark).
  • Вы также можете удалить закладки непосредственно из списка закладок, выбрав закладку и затем нажав клавишу delete на клавиатуре.

4.10 Выделения

  • Вы можете выделить текст. Подобно меткам, вы можете назначить тип каждому выделению, используя строчную букву алфавита. Каждому типу присваивается свой цвет.
  • Выделите фрагмент текста, а затем нажмите, h, а затем букву, чтобы задать тип. Например, чтобы создать выделение с типом a, введите ha (add_highlight).
  • Если вы не хотите каждый раз указывать тип выделения, вы можете выполнить команду add_highlight_with_current_type, которая использует текущее имя выделения для выделенного текста.
  • Вы можете изменить текущий тип выделения, выполнив команду set_select_highlight_type.
  • Вы можете переключить режим выделения, выполнив команду toggle_select_highlight. В этом режиме весь выделенный текст будет выделен как выбранный тип выделения.
  • Нажмите gh, чтобы открыть список выделений в текущем документе с возможностью поиска (goto_highlight).
  • Нажмите gH, чтобы открыть список выделений во всех документах с возможностью поиска (goto_highlight_g).
  • Вы можете выполнить goto_next_highlight и goto_prev_highlight, чтобы перемещаться по выделенным моментам в текущем документе.
  • Если вы хотите перемещаться по выделенным объектам выбранного типа (имени), вы можете использовать команды goto_next_highlight_of_type и goto_prev_highlight_of_type.
  • Чтобы удалить выделение, сначала щёлкните его левой кнопкой мыши, а затем введите dh (delete_highlight).
  • Также вы можете нажать клавишу delete на клавиатуре в списке выделения.

4.11 Порталы

  • Иногда абзац полностью посвящен предыдущей части документа. Например, возможно, этот абзац объясняет данные предыдущей таблицы, описывает предыдущий рисунок или отвечает на предыдущее упражнение.
  • В таких ситуациях обычно очень раздражает постоянное переключение между абзацем и материалом, на который есть ссылка.
  • Используя порталы, вы можете связать расположение абзаца с местоположением ссылочного материала, и всякий раз, когда вы прокручиваете абзац до абзаца, содержимое ссылки автоматически отображается во вторичном окне.
  • Для того, чтобы создать портал, нажмите p (portal). Это создаёт неполный портал с текущим местоположением в качестве источника.
  • Теперь перейдите к местоположению указанного материала и нажмите p ещё раз. На этом портал завершается со вторым местом назначения.
  • Кроме того, вы можете создавать порталы, нажав p, а затем щёлкнув ссылку PDF. При этом автоматически создаётся портал от места ссылки до места назначения ссылки.
  • Также вы можете щелкнуть средней кнопкой мыши после нажатия p, что использует Smart Jump для определения пункта назначения.
  • Для просмотра портала необходимо открыть окно-помощник. Вы можете открыть или закрыть окно-помощник, нажав F12 (toggle_window_configuration).
  • В этом окне автоматически отображается пункт назначения портала с ближайшим к текущему местоположению источником.
  • Вы можете удалить ближайший портал, введя dp (delete_portal).
  • Вы можете перейти к месту назначения ближайшей ссылки, выполнив команду goto_portal.
  • Чтобы отредактировать назначение текущей ссылки, нажмите Shift-p (edit_portalbackspace). Это автоматически перенаправит вас к месту назначения ссылки. Теперь вы можете настроить экран или уровень масштабирования. Когда вы закончите, вернитесь в исходное местоположение, вернувшись в историю.
  • Вы также можете отредактировать место назначения ссылки, непосредственно перемещая окно помощника с помощью мыши или прокручивая колесо мыши.
  • Вы также можете настроить уровень масштабирования, используя колесо мыши, удерживая нажатой кнопку Ctrl.

4.12 Командное меню

4.12.1 Системные настройки

  • Меню команд можно открыть, нажав : (command).
  • Это доступный для поиска список всех команд, а также их текущие сочетания клавиш.

4.12.2 Мои настройки

  • M-x: вызвать меню команд:
    1## Open command line
2command  <A-x>

4.13 Внешний поиск

  • Выделите фрагмент текста и введите ss или sl (команда external_search, за которой следует буква a-z), чтобы выполнить поиск в Google Scholar или Library Genesis.
  • Вы также можете щелкнуть средней кнопкой мыши или щелкнуть средней кнопкой мыши по названию статей или книг (не нужно выделять текст), чтобы быстро найти их в Google Scholar или других поисковых системах.
  • Вы можете настроить поисковые системы, используя конфигурации search_url_* в файлах prefs_user.config.
  • Вы можете настроить, какие поисковые системы использовать для поиска средним щелчком или сдвигом-средним щелчком, используя конфигурации middle_click_search_engine и shift_middle_click_search_engine в prefs_user.config.
  • Значением этих конфигураций должна быть буква, соответствующая конфигурациям search_url_*.

4.14 SyncTeX

  • Нажмите F4, чтобы переключить режим синхронизации (toggle_synctex).
  • В этом режиме щелчок правой кнопкой мыши по любому тексту открывает соответствующий tex-файл в соответствующем месте.
  • Вы можете настроить команду обратного поиска synctex, используя конфигурация inverse_search_command в prefs.config.

4.15 Данные и синхронизация

  • Данные хранятся в двух файлах баз данных с именами local.db и shared.db.
  • local.db хранит специфичные для системы данные (например, расположение PDF-файлов в вашей файловой системе).
  • shared.db хранит все остальные данные, включая метки, закладки, порталы и т. д.
  • shared.db можно использовать на разных компьютерах.
  • Путь до разделяемой базы задаётся в конфигурации shared_database_path в файле prefs_user.config.
  • Можете экспортировать и импортировать данные из json-файла, выполнив команду export или import.

4.15.1 Мои настройки

  • Поместим разделяемую базу данных в папку, синхронизируемую между устройствами (см. Синхронизация файлов с помощью syncthing):
    1## Path to shared.db database file. If not set, we use the default path.
2## you can set this to be a file in a synced folder (e.g. dropbox folder) to automatically sync
3## sioyek across multiple computers
4shared_database_path    ~/Sync/local/sioyek/shared.db

4.16 Конфигурация окна

  • Переключите полноэкранный режим с помощью F12 (toggle_window_configuration).
  • Вы можете сохранить текущую конфигурацию окна командой copy_window_size_config.

4.17 Разное

  • Ctrl-c : копировать выделенный текст (copy).
  • Вы можете открыть ссылки в файлах PDF с клавиатуры, нажав f и введя номер рядом с нужной ссылкой (open_link).
  • Нажмите F8, чтобы переключить на тёмный режим (toggle_dark_mode).
  • Нажмите F5, чтобы переключить на режим презентации (toggle_presentation_mode).
  • Команда toggle_horizontal_scroll_lock запрещает горизонтальную прокрутку документа.
  • Команда toggle_custom_color переключает пользовательскую цветовую схему.
  • Команда execute открывает командную строку, в которой вы можете выполнять команды оболочки.
    • В этой командной строке %1 задаёт полный путь к текущему файлу, %2 — имя текущего файла, %3 — текущий выделенный текст.
    • Вы также можете заранее определить команды и быстро выполнять их, используя execute_predefined_command.
  • Вы можете экспортировать версию текущего PDF-файла со всеми встроенными в него закладками/выделениями (чтобы она была доступна для другого программного обеспечения PDF), выполнив команду embed_annotations.
  • Вы можете повернуть страницу, выполнив команды rotate_clockwise и rotate_counterclockwise.

5 Конфигурационные файлы

5.1 Общесистемный файл привязки клавиш

  • Файл /etc/sioyek/keys.config:
      1# you can edit this file to change keybindings lines that start with '#' are comments
  2# the syntax is pretty simple. Some examples:
  3#command        k             (command is executed when k is pressed)
  4#command        <C-k>         (command is executed when k is pressed while holding control)
  5#command        K             (command is executed when K is entered, which is shift+k)
  6#command        <A-k>         (command is executed when k is pressed while holding alt)
  7#command        +             (command is executed when = is pressed while holding shift)
  8#command        <C-S-k>       (command is executed when k is pressed while holding control and shift)
  9#command        gg            (command is executed when g is pressed twice)
 10#command        gt            (command is executed when g is pressed and then t is pressed)
 11#command        g<C-n>Dt  (command is executed when g is pressed and then n is pressed while holding\
 12#                               control and then d is pressed while holding shift and then t is pressed)
 13# you can execute multiple commands using the following syntax:
 14#command1;command2;command3        <keybinding>
 15# for more information see the documentation at https://sioyek-documentation.readthedocs.io/
 16
 17
 18# ---------- NAVIGATION AND ZOOM ----------
 19
 20# Goto the beginning of document. If prefixed with a number, it will go to that page.
 21# for example 150gg goes to page 150.
 22goto_beginning gg
 23goto_beginning <C-<home>>
 24
 25# Goto the end of the document
 26goto_end <end>
 27goto_end G
 28
 29# Opens a prompt to enter page number and jump to that page
 30goto_page_with_page_number <home>
 31
 32## Goto left/right/bottom/top side of the page
 33#goto_left <unbound>
 34#goto_right <unbound>
 35#goto_top_of_page <unbound>
 36#goto_bottom_of_page <unbound>
 37
 38# Goto left/right side of the page ignoring white margins
 39goto_left_smart ^
 40goto_right_smart $
 41
 42# Goto the top-right side of page. Useful for two column documents
 43goto_top_of_page;goto_right_smart zz
 44
 45# Movement (can be prefixed with a number)
 46# move_down           <down>
 47# move_up             <up>
 48move_left           <right>
 49move_right          <left>
 50
 51# Goto forward for one page width. (can be prefixed with a number)
 52# (note that going forward for one page width is not usually what you want because if
 53# the page is larger than the screen you will miss some content. What you usually want is screen_down)
 54next_page <C-<pagedown>>
 55previous_page <C-<pageup>>
 56
 57# Go down one screen width (can be prefixed with a number which tells how many screen widths should we go down)
 58screen_down <space>
 59screen_up <S-<space>>
 60screen_down <pagedown>
 61screen_up <pageup>
 62
 63# Goto the next/prev chapter
 64next_chapter gc
 65prev_chapter gC
 66
 67# Goto previous viewing state and delete the current (and future) state(s).
 68# pop_state w
 69
 70# Goto the previous history point
 71prev_state <backspace>
 72prev_state <C-<left>>
 73
 74# Create a new sioyek window
 75new_window <C-t>
 76
 77# Close the current sioyek window
 78close_window <C-w>
 79
 80## Search and switch between sioyek windows
 81#goto_window <unbound>
 82
 83# If we are not at the end of viewing history, goto the next history point
 84next_state <S-<backspace>>
 85next_state <C-<right>>
 86
 87# Open table of contents.
 88goto_toc t
 89
 90# Zoom
 91zoom_in  +
 92fit_to_page_width =
 93zoom_out -
 94
 95## Zoom in/out on the mouse cursor (instead of center of screen)
 96# zoom_in_cursor <unbound>
 97# zoom_out_cursor <unbound>
 98
 99# Rotate document
100rotate_clockwise r
101rotate_counterclockwise R
102
103# Automatically set the zoom level and horizontal offset such that the current page is centered horizontally and
104# it fills the screen width
105fit_to_page_width <f9>
106# Same as fit_to_page_with but ignores page margins
107fit_to_page_width_smart <f10>
108
109## Similar to fit_to_page_width, but for height
110#fit_to_page_height   <unbound>
111
112## Similar to fit_to_page_width_smart but for height
113#fit_to_page_height_smart   <unbound>
114
115## Same as fit_to_page_width, but instead of filling the screen width, it fills the ratio of screen that is
116## configured in `prefs_user.config` using `fit_to_page_width_ratio` config. See https://github.com/ahrm/sioyek/issues/162#issuecomment-1059738730.
117#fit_to_page_width_ratio <unbound>
118
119# Open a file dialog to select a document.
120open_document o
121# Open an embedded file dialog in sioyek
122open_document_embedded <C-o>
123# Open an embedded file dialog in sioyek rooted in the directory of current opened file
124open_document_embedded_from_current_path <C-S-o>
125
126# Open a searchable list of previously opened documents.
127open_prev_doc O
128
129## Opens the last document opened is sioyek. It is useful when you want to quickly toggle between two documents
130#open_last_document <unbound>
131
132## Keyboard shortcut to enter visual mark mode (instead of right clicking)
133#enter_visual_mark_mode <unbound>
134
135# Command the move the visual mark to the next/previous line
136# these keys only work when a visual mark is set (by right clicking or using `visual_mark_under_cursor` command)
137move_visual_mark_up k
138move_visual_mark_down j
139move_visual_mark_up <up>
140move_visual_mark_down <down>
141
142## lock horizontal scroll, useful when using laptop touchpads
143# toggle_horizontal_scroll_lock <unbound>
144
145# ---------- SEARCH ----------
146
147# Search the document.
148# example: /something                   (searches the document for 'something')
149# you can also specify a page range to search:
150# example: /<110,135>something          (searches pages 110 to 135 (inclusive) for 'something')
151search <C-f>
152search /
153
154# Searches the current chapter. This is essentially the same as search but the range prefix is autofilled
155# with the range of the current lowest level subchapter.
156chapter_search c<C-f>
157chapter_search c/
158
159# Goto the next search item. Can be prefixed with a number which is the same as performing the command n times
160# for example if we are on the 10th search result and we input 15n, we go to the 25th search result.
161next_item n
162# Goto the previous search result. Can be prefixed with a number with similar rules as next_item.
163previous_item N
164
165# ---------- BOOKMARKS ----------
166# Add a bookmark in the current location (opens a text input where you can specify the bookmark text)
167add_bookmark b
168delete_bookmark db
169
170# Open bookmarks menu of the current document.
171goto_bookmark gb
172
173# Open bookmarks menu of all documents.
174goto_bookmark_g gB
175
176# ---------- HIGHLIGHTS ----------
177# You can select a piece of text and press the `add_highlight` shortcut followed by a symbol (a character from a-z) to highlight
178# the text
179add_highlight h
180# Goto highlights of current document
181goto_highlight gh
182# Goto highlights of all documents
183goto_highlight_g gH
184# Left click on a highlight and then press the `delete_highlight` shortcut to delete it.
185delete_highlight dh
186
187# Sets the highlight type to be used for other operations (the default highlight type is 'a')
188#set_select_highlight_type
189
190## Same as `add_highlight` but uses the current selected highlight type as the type of highlight
191#add_highlight_with_current_type <unbound>
192
193## Toggle select highlight mode. In select highlight mode, all text selected using mouse will automatically be highlighted
194## with highlight type set using `set_select_highlight_type`
195#toggle_select_highlight <unbound>
196
197# Goto next/previous highlight in current document
198goto_next_highlight gnh
199goto_prev_highlight gNh
200
201## Goto next/previous highlight of the current selected highlight type
202#goto_next_highlight_of_type <unbound>
203#goto_prev_highlight_of_type <unbound>
204
205# ---------- MARKS ----------
206
207# Mark the current location. After pressing the mark button, you must enter a symbol (a letter from a-z or A-Z).
208# this marks the current location in the file with the entered symbol. Afterwards you will be able to return to
209# the locations of the marks using goto_mark command.
210# example:  mm      (marks the current location in the file with a mark named 'm')
211set_mark m
212# Goto a previously set mark. After pressing goto_mark you must enter a symbol associated with a previously set mark.
213# example:  `m      (goes to the location of the mark named m)
214goto_mark `
215
216# ---------- PORTALS ----------
217# If we are in default state, goto portal state with the current location in document as the portal source
218# if we are already in the portal state, create the portal with the current location as destination.
219portal p
220
221# Delete the portal with the closest source to current location
222delete_portal dp
223
224# Goto the position of the portal with the closest source to current location
225goto_portal gp
226goto_portal <tab>
227
228# Similar to goto_portal, except when prev_state is called, the destination of the portal is update to be the state
229# on which prev_state is called
230edit_portal P
231edit_portal <S-<tab>>
232
233# Open/Close the helper window for portals
234toggle_window_configuration <f12>
235
236## open/close helper window
237#toggle_one_window <unbound>
238
239# ---------- MISC ----------
240
241# Copy selected text
242copy <C-c>
243
244toggle_fullscreen <f11>
245
246# Toggles whether we highlight pdf links or not
247toggle_highlight <f1>
248
249# open command line
250command :
251
252# Search the selected text using one of the search engines defined using search_url_* settings in prefs.config (* can be any letter between 'a' and 'z')
253# see https://sioyek-documentation.readthedocs.io/en/latest/usage.html#external-search
254external_search s
255
256# opens the selected text as a url in the default browser
257# open_selected_url Q
258
259# Toggle dark mode (inverted colors)
260toggle_dark_mode <f8>
261
262## Toggle custom color mode. You can specify the text background color in your `prefs_user.config` file
263## see https://sioyek-documentation.readthedocs.io/en/latest/configuration.html#custom-background-color-and-custom-text-color
264#toggle_custom_color <f8>
265
266# Toggle synctex mode. When in synctex mode, right clicking on a pdf launches the corresponding latex page.
267toggle_synctex <f4>
268
269## Perform a synctex search under the mouse cursor
270#synctex_under_cursor <unbound>
271
272# While in mouse drag mode, instead of selecting text you can pan the screen using mouse
273toggle_mouse_drag_mode <f6>
274
275# In visual scroll mode, mouse wheel performs `move_visual_mark_up` and `move_visual_mark_down` commands
276toggle_visual_scroll <f7>
277
278# In visual scroll mode, create an overview to/go to/portal to the definition in highlighted line
279overview_definition l
280goto_definition <C-]>
281portal_to_definition ]
282
283# In presentation mode, we fit the pages to screen and movement keys move entire pages
284toggle_presentation_mode <f5>
285
286## Quit sioyek
287quit q
288
289# Open PDF links using keyboard
290open_link f
291
292# Select text using keyboard
293keyboard_select v
294
295# Smart jump using keyboard
296keyboard_smart_jump F
297
298## Open overview window using keyboard
299#keyboard_overview <unbound>
300
301## If the preview is not correct, jump to the next preview
302#next_preview <C-n>
303
304## If the preview is not correct, jump to the previous preview
305#previous_preview <C-N>
306
307## Jump to the location of the current overview
308#goto_overview <unbound>
309
310## Create a portal to the location of the current overview
311#portal_to_overview <unbound>
312
313## Center the window on selected text
314#goto_selected_text <unbound>
315
316## Focus the visual mark on the text matching the given string (useful when extensions want to focus on a text)
317#focus_text <unbound>
318
319## Smart jump to the location under mouse cursor
320#smart_jump_under_cursor <unbound>
321## Open overview window to the location under mouse cursor
322#overview_under_cursor <unbound>
323## Set a visual mark under mouse cursor
324#visual_mark_under_cursor <unbound>
325## Close the overview window
326#close_overview <unbound>
327## Exit visual mark mode
328#close_visual_mark <unbound>
329
330## Import sioyek data from an exported file
331#import <unbound>
332
333## Export sioyek data into a json file
334#export <unbound>
335
336## Execute shell commands. For example:
337## sioyek --new-instance %1
338## in the command %1 expands to the path of the current file and %2 expand to the file name of the current file
339#execute <unbound>
340
341## (deprecated see bottom of the page) Execute a predefined command. these commands are defined in `prefs_user.config` file using the following syntax:
342## --------prefs_user.config-----------
343## execute_command_a	some_command %1 %2
344## execute_command_x	another_command %2
345## ------------------------------------
346## now in order to execute the second command you can first execute `execute_predefined_command` and then press 'x'
347#execute_predefined_command <unbound>
348
349## Embed the annotations (highlights and bookmarks) into a new PDF file so they are visible to other PDF readers
350#embed_annotations <unbound>
351
352## Copy the current window configuration to clipboard so they can be used in `prefs_user.config`
353#copy_window_size_config <unbound>
354
355## Opens the default preference file
356#prefs <unbound>
357## Opens the user preference file with highest priority
358#prefs_user <unbound>
359## Opens a list of all user preference files
360#prefs_user_all <unbound>
361
362## Opens the default kwys file
363#keys <unbound>
364## Opens the user keys file with highest priority
365#keys_user <unbound>
366## Opens a list of all user keys files
367#keys_user_all <unbound>
368
369## Enter password for password protected documents
370#enter_password <unbound>
371
372## Toggle fastread mode. this is an experiental feature
373#toggle_fastread <unbound>
374
375## Toggle statusbar display
376#toggle_statusbar <unbound>
377
378## Reload sioyek window
379#reload <unbound>
380
381## Set the status string to be displayed in sioyek's statusbar (it is useful for extensions)
382#set_status_string <unbound>
383
384## Clears the status string set by `set_status_string`
385#clear_status_string <unbound>
386
387## Toggles the window titlebar
388#toggle_titlebar <unbound>
389
390## You can bind custom commands defined in `prefs_user.config` using the same syntax as the built-in commands
391## --------prefs_user.config-----------
392## new_command	_my_command_name python /path/to/script.py %{file_name} %{paper_name}
393## ------------------------------------
394## now you can bind _my_command_name to a keybind here:
395#_my_command_name <unbound>

5.2 Пользовательский файл привязки клавиш

  • Файл ~/.config/sioyek/keys_user.config.

5.3 Общесистемный файл предпочтений

  • Файл /etc/sioyek/prefs.config:
      1# For more information see the documentation at https://sioyek-documentation.readthedocs.io/
  2
  3# (can be 0 or 1) if set, shows a notification on startup if a new version of sioyek is available
  4check_for_updates_on_startup	0
  5
  6# Use old keybind parsing method (only for backwards compatibility)
  7use_legacy_keybinds 0
  8
  9# The color with which the screen is cleared before rendering the pdf (this is the background color of the application and not the PDF file)
 10background_color    0.97 0.97 0.97
 11dark_mode_background_color    0.0 0.0 0.0
 12
 13# Showing full white text on black background can be irritating for the eye, we can dim the whites a little bit using the contrast option
 14dark_mode_contrast			0.8
 15
 16# Highlight color when text is selected using mouse
 17text_highlight_color    1.0 1.0 0.0
 18
 19# The color of highlight ruler which is displayed when right click is pressed
 20visual_mark_color    0.0 0.0 0.0 0.1
 21
 22# Highlight color when text is a search match
 23search_highlight_color  0.0 1.0 0.0
 24
 25# Hihglight color for PDF links (note that highlight is off by default
 26# and can only be seen by performing a toggle_highlight command. See keys.config for more details)
 27link_highlight_color    0.0 0.0 1.0
 28
 29# Hihglight color for synctex forward search highlights
 30synctex_highlight_color    1.0 0.0 1.0
 31
 32# Urls to use when executing external_search commands
 33search_url_s	https://scholar.google.com/scholar?q=
 34search_url_g	https://www.google.com/search?q=
 35
 36# Which search url to choose when middle clicking or shift middle clicking on text (the values are the letters of corresponding search_url_* )
 37# for example if i set `middle_click_search_engine	s`, then we use the url associated with `search_url_s` to handle middle click searches
 38middle_click_search_engine			s
 39shift_middle_click_search_engine	l
 40
 41# The factor by which we increase/decrease zoom when performing zoom_in or zoom_out
 42zoom_inc_factor         1.2
 43
 44# How many inches we move vertically/horizontally when performing move_* commands
 45vertical_move_amount    1.0
 46horizontal_move_amount    1.0
 47
 48# When performing screen_down/screen_up we usually don't move a full screen because it causes the user to lose context
 49# Here we specify the fraction of the screen width by which we move when performing these commands
 50move_screen_ratio      0.5
 51
 52# If 0, Table of Contents is shown in a hierarchial tree, otherwise it is a flat list (can improve performance for extremely large table of contents)
 53flat_toc                            0
 54
 55# If it is 1, when launching the application if we detect multiple monitors, we automatically launch the helper window in second monitor
 56should_use_multiple_monitors        0
 57
 58# If the last opened document is empty, load the tutorial pdf instead
 59should_load_tutorial_when_no_other_file	1
 60
 61# (deprecated, use `should_launch_new_window` instead) If it is 0, then we use the previous instance of sioyek when launching a new file.
 62# otherwise a new instance is launched every time we open a new file.
 63should_launch_new_instance				0
 64
 65# If set, we open a new sioyek window when a new file is opened, otherwise we open the file in the previous window
 66should_launch_new_window				0
 67
 68# The command to use when trying to do inverse search into a LaTeX document. Uncomment and provide your own command.
 69# %1 expands to the name of the file and %2 expans to the line number.
 70#inverse_search_command 		"C:\path\to\vscode\Code.exe" -r -g %1:%2
 71
 72# you can specify the exact highlight color for each of 26 different highlight types
 73
 74# When moving to the next line using visual marker, this setting specifies the distance of the market to the top of the screen in fractions of screen size (center of the screen is zero, top of the screen is one)
 75visual_mark_next_page_fraction	0.75
 76
 77# When moving to the next line using visual marker, this setting determines at which point we move the screen (center of the screen is one, bottom of the screen is zero)
 78visual_mark_next_page_threshold	0.25
 79
 80# If set, we display a checkerboard pattern for unrendered pages (by default we display nothing)
 81should_draw_unrendered_pages	0
 82
 83# If 0, we use the previous renders for overview window which may cause it to be blurry
 84# if it is 1, we rerender with the proper resolution for overview window which looks better
 85# but may increase power consumption
 86rerender_overview 1
 87
 88## Size of the overview window (1 being as large as the window, valid range is [0, 1])
 89# overview_size 0.5 0.5
 90
 91## Offset of the center of the overview window ((0,0) being the center of the screen and valid raneg is [-1, 1])
 92# overview_offset 0.5 0.5
 93
 94# Use linear texture filtering instead of nearest-neighbor
 95# Can improve appearance in very high-resolution screens
 96# linear_filter 0
 97
 98# Use dark mode by default (deprecated, better add `toggle_dark_mode` to `startup_commands` )
 99default_dark_mode	0
100
101# If set, we sort the bookmarks by their location instead of their creation time
102sort_bookmarks_by_location	1
103
104## Path to shared.db database file. If not set, we use the default path.
105## you can set this to be a file in a synced folder (e.g. dropbox folder) to automatically sync
106## sioyek across multiple computers
107#shared_database_path    /some/path/shared.db
108
109## Name of the font to use for UI text
110#ui_font Some Font Name
111## Size of the UI font
112#font_size 20
113
114## Semicolon-separated list of command to execute upon sioyek startup
115#startup_commands    toggle_visual_scroll;toggle_dark_mode
116
117## Background color to use when executing `toggle_custom_color`
118custom_background_color 0.180 0.204 0.251
119## Text color to use when executing `toggle_custom_color`
120custom_text_color 0.847 0.871 0.914
121
122# Normally mouse wheel zooms in on the middle of the screen, but if this is set to 1, we zoom in on the cursor
123wheel_zoom_on_cursor 0
124
125## Color of status bar background
126#status_bar_color 0 0 0
127## Color of status bar text
128#status_bar_text_color 1 1 1
129## Font size of the status bar text
130#status_bar_font_size 20
131
132## The default size of main window when helper window is closed
133#single_main_window_size 800 600
134#single_main_window_move 100 100
135
136## The default size/offset of main/helper window when helper window is opened. You can copy the value of this config using `copy_window_size_config` command
137#main_window_size 800 600
138#main_window_move 100 100
139#helper_window_size 800 600
140#helper_window_move 100 100
141
142## Touchpad/scrollwhell sensitivity
143#touchpad_sensitivity 1.0
144
145## Configure the appearance of page separator
146#page_separator_width 2
147#page_separator_color	0.9 0.9 0.9
148
149# Ratio of page width to use for `fit_to_page_width_ratio` command
150fit_to_page_width_ratio 0.75
151
152# If set, we initially collapse table of content entries
153collapsed_toc 0
154
155# If set, we highlight the current line in visual_scroll_mode by masking above and below the current line
156# if not set, we only mask below the line
157ruler_mode 1
158
159# Additional ruler padding
160ruler_padding 1.0
161ruler_x_padding 5.0
162
163## We use mupdf to determine lines for visual mark. However, we do have a custom algorithm for image documents
164## if `force_custom_line_algorithm` is 1, then we use our custom algorithm instead of mupdf even for documents
165## that have lines.
166#force_custom_line_algorithm 0
167
168# A directory which sioyek watches for new papers. If a new paper added to this directory
169# while we are creating a portal from another document, this new document will automatically
170# be used as the destination of the portal.
171#paper_folder_path /some/path
172
173# Enable some experimental features, might not be stable
174#enable_experimental_features 0
175
176# Automatically create a table of contents for the document if it doesn't already have one
177create_table_of_contents_if_not_exists 1
178
179# Limits the maximum size of created table of contents
180max_created_toc_size 5000
181
182# Warn the user on the command line only when redefining keys inside
183# the same file. When set to 1, sioyek will warn when redefining keys
184# from other files also
185should_warn_about_user_key_override 1
186
187# Use double clicks to select entire words and single clicks for character-based selection
188single_click_selects_words 0
189
190# A prefix to prepend to items in lists (e.g. bookmark lists)
191#item_list_prefix >
192
193## In presentation mode, ignore whitespace when trying to determine the size of a page
194#ignore_whitespace_in_presentation_mode 0
195
196## In list of recent documents, show the entire document path rather than just the name
197#show_doc_path 0
198
199# Show long menu items in multiple lines instead of truncating the string, can reduce performance for
200#very large lists
201multiline_menus 1
202
203# While in present mode, prerender the next page to avoid flickering
204prerender_next_page_presentation 1
205
206## Custom commands to run when clicking or right clicking when modifier keys are pressed
207## the command can be any built-in sioyek command (e.g. overview_under_cursor) or user-defined
208## commands defined using `new_command`
209# shift_click_command some_command
210# control_click_command some_command
211# alt_click_command some_command
212# shift_right_click_command some_command
213# control_right_click_command some_command
214# alt_right_click_command some_command
215
216# Highlight on middle clicks when text is selected and no preview is open
217#highlight_middle_click 1
218
219# Use a super fast index for search instead of the mupdf's implementation
220#super_fast_search 1
221
222# Use case-insensitive search
223#case_sensitive_search 0
224
225#Amethyst
226highlight_color_a	0.94 0.64 1.00
227#Blue
228highlight_color_b	0.00 0.46 0.86
229#Caramel
230highlight_color_c	0.60 0.25 0.00
231#Damson
232highlight_color_d	0.30 0.00 0.36
233#Ebony
234highlight_color_e	0.10 0.10 0.10
235#Forest
236highlight_color_f	0.00 0.36 0.19
237#Green
238highlight_color_g	0.17 0.81 0.28
239#Honeydew
240highlight_color_h	1.00 0.80 0.60
241#Iron
242highlight_color_i	0.50 0.50 0.50
243#Jade
244highlight_color_j	0.58 1.00 0.71
245#Khaki
246highlight_color_k	0.56 0.49 0.00
247#Lime
248highlight_color_l	0.62 0.80 0.00
249#Mallow
250highlight_color_m	0.76 0.00 0.53
251#Navy
252highlight_color_n	0.00 0.20 0.50
253#Orpiment
254highlight_color_o	1.00 0.64 0.02
255#Pink
256highlight_color_p	1.00 0.66 0.73
257#Quagmire
258highlight_color_q	0.26 0.40 0.00
259#Red
260highlight_color_r	1.00 0.00 0.06
261#Sky
262highlight_color_s	0.37 0.95 0.95
263#Turquoise
264highlight_color_t	0.00 0.60 0.56
265#Uranium
266highlight_color_u	0.88 1.00 0.40
267#Violet
268highlight_color_v	0.45 0.04 1.00
269#Wine
270highlight_color_w	0.60 0.00 0.00
271#Xanthin
272highlight_color_x	1.00 1.00 0.50
273#Yellow
274highlight_color_y	1.00 1.00 0.00
275#Zinnia
276highlight_color_z	1.00 0.31 0.02

5.4 Пользовательский файл предпочтений

  • Файл ~/.config/sioyek/prefs_user.config.

Links to this note

Дмитрий Сергеевич Кулябов
Дмитрий Сергеевич Кулябов
Профессор кафедры теории вероятностей и кибербезопасности

Мои научные интересы включают физику, администрирование Unix и сетей.

Похожие