-# gen_lfuns.py generated this file. For more info see http://www.lyx.org/
-\lyxformat 509
+#LyX 2.4 created this file. For more info see https://www.lyx.org/
+\lyxformat 614
\begin_document
\begin_header
\save_transient_properties true
}
\end_preamble
\use_default_options false
-\maintain_unincluded_children false
+\maintain_unincluded_children no
\begin_local_layout
Style Description
LabelIndent MM
\end_local_layout
\language english
\language_package default
-\inputencoding auto
-\fontencoding global
+\inputencoding auto-legacy
+\fontencoding auto
\font_roman "default" "default"
\font_sans "default" "default"
\font_typewriter "default" "default"
\font_default_family default
\use_non_tex_fonts false
\font_sc false
-\font_osf false
+\font_sans_osf false
+\font_typewriter_osf false
+\font_roman_osf false
\font_sf_scale 100 100
\font_tt_scale 100 100
\use_microtype 0
\suppress_date false
\justification true
\use_refstyle 0
+\use_minted 0
+\use_lineno 0
\index Index
\shortcut idx
\color #008000
\tocdepth 3
\paragraph_separation indent
\paragraph_indentation default
-\quotes_language english
+\is_math_indent 0
+\math_numbering_side default
+\quotes_style english
\papercolumns 1
\papersides 1
\paperpagestyle default
\tracking_changes false
+\postpone_fragile_content false
\output_changes false
\html_math_output 0
\html_css_as_file 0
\end_layout
\begin_layout Standard
-This manual documents the
+This manual documents the
\begin_inset Quotes eld
\end_inset
So if you want to change\SpecialChar breakableslash
customize the user interface, you need to deal
with LFUNs.
- Furthermore, external programs can use LFUNs to communicate with and
+ Furthermore, external programs can use LFUNs to communicate with and
\begin_inset Quotes eld
\end_inset
\SpecialChar LyX
.
Finally, you can also issue LFUNs directly via the so called mini-buffer
- which can be opened via
+ which can be opened via
\begin_inset Info
type "shortcuts"
arg "command-execute"
Origin vermeer, 10 Jan 2002
\end_layout
+\begin_layout Subsection*
+font-nospellcheck
+\end_layout
+
+\begin_layout Description
+Action Toggles nospellcheck status in the font (selection-wise).
+\end_layout
+
+\begin_layout Description
+Syntax font-nospellcheck
+\end_layout
+
+\begin_layout Description
+Origin spitz, 5 March 2021
+\end_layout
+
\begin_layout Subsection*
font-noun
\end_layout
\end_layout
\begin_layout Description
-Syntax layout <LAYOUT> [ignorenests]
+Syntax layout <LAYOUT> [ignoreautonests]
\end_layout
\begin_layout Description
\begin_inset Newline newline
\end_inset
-ignorenests: If specified, nesting advices will be ignored.
+ignoreautonests: If specified, nesting advices will be ignored.
\end_layout
\begin_layout Subsection*
\end_layout
\begin_layout Description
-Syntax layout-toggle <LAYOUT> [ignorenests]
+Syntax layout-toggle <LAYOUT> [ignoreautonests]
\end_layout
\begin_layout Description
\begin_inset Newline newline
\end_inset
-ignorenests: If specified, nesting advices will be ignored.
+ignoreautonests: If specified, nesting advices will be ignored.
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Syntax char-delete-backward [force]
+Syntax char-delete-backward [confirm]
\end_layout
\begin_layout Description
-Params force: Delete big insets, do not only select them.
+Params confirm: Select big insets, do not directly delete them.
\end_layout
\begin_layout Subsection*
\end_layout
\begin_layout Description
-Syntax char-delete-forward [force]
+Syntax char-delete-forward [confirm]
\end_layout
\begin_layout Description
-Params force: Delete big insets, do not only select them.
+Params confirm: Select big insets, do not directly delete them.
\end_layout
\begin_layout Subsection*
Origin AAS, 97-02-23
\end_layout
+\begin_layout Subsection*
+citation-open
+\end_layout
+
+\begin_layout Description
+Action Opens the corresponding pdf/url for a given citation inset.
+\end_layout
+
+\begin_layout Description
+Syntax citation-open [EXTERNAL] TARGET
+\end_layout
+
+\begin_layout Description
+Params <TARGET>: URL (https:,file:) of the document.
+\begin_inset Newline newline
+\end_inset
+
+<EXTERNAL>: Use external executable script for finding target
+\begin_inset Newline newline
+\end_inset
+
+ and launching viewer. In this case TARGET consists of author and year
+\begin_inset Newline newline
+\end_inset
+
+ and will be passed as an input argument to the script.
+\end_layout
+
+\begin_layout Description
+Origin Sanda, 16 Aug 2020
+\end_layout
+
\begin_layout Subsection*
clipboard-paste
\end_layout
\begin_inset Newline newline
\end_inset
-compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
+compare|counter|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
\begin_inset Newline newline
\end_inset
Origin Lgb, 27 Feb 1997
\end_layout
+\begin_layout Subsection*
+index-tag-all
+\end_layout
+
+\begin_layout Description
+Action Tags all occurrences of the word before the cursor with the index inset at cursor.
+\end_layout
+
+\begin_layout Description
+Notion It automatically takes the word on the cursor position.
+\end_layout
+
+\begin_layout Description
+Syntax index-tag-all
+\end_layout
+
+\begin_layout Description
+Origin spitz, 5 Nov 2022
+\end_layout
+
+\begin_layout Subsection*
+indexmacro-insert
+\end_layout
+
+\begin_layout Description
+Action Inserts special Index macros into the document.
+\end_layout
+
+\begin_layout Description
+Syntax indexmacro-insert <type>
+\end_layout
+
+\begin_layout Description
+Params <type>: see, seealso, subentry, sortkey.
+\end_layout
+
+\begin_layout Description
+Origin spitz, 20 Feb 2022
+\end_layout
+
\begin_layout Subsection*
info-insert
\end_layout
\begin_inset Newline newline
\end_inset
-inset-forall Index char-delete-forward force
+inset-forall Index char-delete-forward
\begin_inset Newline newline
\end_inset
-Close all Notes (also works for a particular branch, for example):
+Close all Notes:
\begin_inset Newline newline
\end_inset
\begin_inset Newline newline
\end_inset
+Open all branch insets of branch "myBranch":
+\begin_inset Newline newline
+\end_inset
+
+inset-forall Branch:myBranch inset-toggle open
+\begin_inset Newline newline
+\end_inset
+
Transform all yellow notes to comments
\begin_inset Newline newline
\end_inset
formatted -- Formatted reference
\end_layout
+\begin_layout Subsection*
+inset-insert-copy
+\end_layout
+
+\begin_layout Description
+Action Inserts the inset's content (in ToC pane) at the position of the cursor.
+\end_layout
+
+\begin_layout Description
+Syntax inset-insert-copy
+\end_layout
+
+\begin_layout Description
+Origin spitz, 1 Nov 2022
+\end_layout
+
\begin_layout Subsection*
inset-modify
\end_layout
listings|note|phantom|ref|space|tabular|vspace|wrap>.
\end_layout
+\begin_layout Subsection*
+inset-split
+\end_layout
+
+\begin_layout Description
+Action Splits the current inset into two at current position.
+\end_layout
+
+\begin_layout Description
+Syntax inset-split [<INSET>]
+\end_layout
+
+\begin_layout Description
+Params <INSET>: this can be used to make sure the right kind of inset is dissolved. For example "split" entry in the charstyles sub-menu should only dissolve the charstyle inset, even if the cursor is inside several nested insets of different type.
+\begin_inset Newline newline
+\end_inset
+
+ For values see lyx::InsetLayout::lyxtype_ .
+\end_layout
+
+\begin_layout Description
+Origin spitz, 22 Dec 2020
+\end_layout
+
\begin_layout Subsection*
inset-toggle
\end_layout
\end_layout
\begin_layout Description
-Notion Primary selection mechanism is linux-only thing.
+Notion Primary selection mechanism is X11/Wayland-only thing.
\end_layout
\begin_layout Description
Origin Abdel, Dec 27 2007
\end_layout
+\begin_layout Subsection*
+search-string-set
+\end_layout
+
+\begin_layout Description
+Action Set search string buffer.
+\end_layout
+
+\begin_layout Description
+Syntax search-string-set [<DATA>]
+\end_layout
+
+\begin_layout Description
+Params <DATA>: string to search for. If no parameter is given, use (word under) selection.
+\end_layout
+
+\begin_layout Description
+Origin stwitt, spitz, Feb 12 2021
+\end_layout
+
\begin_layout Subsection*
section-select
\end_layout
Origin spitz, 18 Jan 2010
\end_layout
+\begin_layout Subsection*
+spelling-add-local
+\end_layout
+
+\begin_layout Description
+Action Add the word under the cursor to the document's local spell checker dictionary. The default for the language is retrieved from the cursor position.
+\end_layout
+
+\begin_layout Description
+Syntax spelling-add-local [<STRING>] [<LANG>]
+\end_layout
+
+\begin_layout Description
+Params <WORD>: word to add <LANG>: language name (see file languages)
+\end_layout
+
+\begin_layout Description
+Origin spitz, 6 Mar 2021
+\end_layout
+
\begin_layout Subsection*
spelling-continuously
\end_layout
Origin SWitt, 28 July 2010
\end_layout
+\begin_layout Subsection*
+spelling-remove-local
+\end_layout
+
+\begin_layout Description
+Action Remove the word under the cursor from the document's local spell checker dictionary. The default for the language is retrieved from the cursor position.
+\end_layout
+
+\begin_layout Description
+Syntax spelling-remove-local [<STRING>] [<LANG>]
+\end_layout
+
+\begin_layout Description
+Params <WORD>: word to remove <LANG>: language name (see file languages)
+\end_layout
+
+\begin_layout Description
+Origin spitz, 7 Mar 2021
+\end_layout
+
\begin_layout Subsection*
tab-delete
\end_layout
\begin_inset Newline newline
\end_inset
-reset-formal-default|set-all-lines|unset-all-lines|toggle-longtabular|
+reset-formal-default|set-all-lines|toggle-all-lines|unset-all-lines|
\begin_inset Newline newline
\end_inset
-set-longtabular|unset-longtabular|set-pwidth|
+toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|
\begin_inset Newline newline
\end_inset
\begin_inset Newline newline
\end_inset
-set-interline-space|set-border-lines|tabular-valign-top|
+set-interline-space|tabular-valign-top|tabular-valign-middle|
\begin_inset Newline newline
\end_inset
-tabular-valign-middle|tabular-valign-bottom|set-tabular-width|
+tabular-valign-bottom|set-tabular-width|toggle-varwidth-column|
\begin_inset Newline newline
\end_inset
-toggle-varwidth-column Various math-environment features are handled as well, e.g. add-vline-left/right for
+set-border-lines|toggle-border-lines|set-inner-lines|toggle-inner-lines Various math-environment features are handled as well, e.g. add-vline-left/right for
\begin_inset Newline newline
\end_inset
\end_layout
\begin_layout Description
-Syntax word-delete-backward [force]
+Syntax word-delete-backward [confirm]
\end_layout
\begin_layout Description
-Params force: Delete big insets, do not only select them.
+Params confirm: Select big insets, do not directly delete them.
\end_layout
\begin_layout Subsection*
\end_layout
\begin_layout Description
-Syntax word-delete-forward [force]
+Syntax word-delete-forward [confirm]
\end_layout
\begin_layout Description
-Params force: Delete big insets, do not only select them.
+Params confirm: Select big insets, do not directly delete them.
\end_layout
\begin_layout Subsection*
Origin spitz, 30 Sep 2012
\end_layout
+\begin_layout Subsection*
+branch-sync-all
+\end_layout
+
+\begin_layout Description
+Action Open/close all insets of selected branch (depending on its activation status).
+\end_layout
+
+\begin_layout Description
+Syntax branch-sync-all
+\end_layout
+
+\begin_layout Description
+Origin sanda, 15 April 2022
+\end_layout
+
\begin_layout Subsection*
branches-rename
\end_layout
\end_layout
\begin_layout Description
-Sample Close all Notes in buffers:
+Sample Close all Notes in all buffers:
\begin_inset Newline newline
\end_inset
Origin Asger, 2 Feb 1997
\end_layout
+\begin_layout Subsection*
+buffer-reset-export
+\end_layout
+
+\begin_layout Description
+Action Removes the auxiliary file before next export to assure export is done afresh.
+\end_layout
+
+\begin_layout Description
+Syntax buffer-reset-export
+\end_layout
+
+\begin_layout Description
+Origin spitz, 27 Dec 2019
+\end_layout
+
\begin_layout Subsection*
buffer-save-as-default
\end_layout
\end_layout
\begin_layout Description
-Params <FORMAT>: The format to display, where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog. If no format is given, the default format as specified in the same dialog is used.
+Params <FORMAT>: The format to display, where this is one of the formats defined in the Tools>Preferences>File Formats dialog, use the "Short name" field. If no format is given, the default format as specified in the same dialog is used.
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Syntax buffer-write
+Syntax buffer-write [force]
+\end_layout
+
+\begin_layout Description
+Params force: write even if buffer is not marked as modified.
\end_layout
\begin_layout Subsection*
Origin 11 July 2016
\end_layout
+\begin_layout Subsection*
+ifrelatives
+\end_layout
+
+\begin_layout Description
+Action Helper function for master-related actions
+\end_layout
+
+\begin_layout Description
+Notion In a buffer, the function will be disabled if the buffer has no master or children. It thus allows to enable actions only in documents with master/children
+\end_layout
+
+\begin_layout Description
+Syntax ifrelatives <ACTION>
+\end_layout
+
+\begin_layout Description
+Origin spitz, 2 January 2020
+\end_layout
+
\begin_layout Subsection*
lyx-quit
\end_layout
Syntax lyx-quit
\end_layout
+\begin_layout Subsection*
+lyxfiles-open
+\end_layout
+
+\begin_layout Description
+Action Open lyxfiles (templates/examples). Create a view if he have none.
+\end_layout
+
+\begin_layout Description
+Syntax lyxfiles-open [<TYPE>]
+\end_layout
+
+\begin_layout Description
+Params <TYPE>: templates or examples. Default is templates.
+\end_layout
+
+\begin_layout Description
+Origin spitz, 10 Feb 2021
+\end_layout
+
\begin_layout Subsection*
master-buffer-export
\end_layout
Origin rkh, 18 April 2018
\end_layout
+\begin_layout Subsection*
+master-buffer-forall
+\end_layout
+
+\begin_layout Description
+Action Applies a command to a buffer and all it children, starting from the master.
+\end_layout
+
+\begin_layout Description
+Syntax master-buffer-forall <LFUN-COMMAND>
+\end_layout
+
+\begin_layout Description
+Params <LFUN-COMMAND>: The command to be applied to the buffers.
+\end_layout
+
+\begin_layout Description
+Sample Close all Notes in buffers:
+\begin_inset Newline newline
+\end_inset
+
+ master-buffer-forall inset-forall Note inset-toggle close
+\begin_inset Newline newline
+\end_inset
+
+ Toggle change tracking on buffers:
+\begin_inset Newline newline
+\end_inset
+
+ master-buffer-forall changes-track
+\begin_inset Newline newline
+\end_inset
+
+ Toggle read-only for buffers:
+\begin_inset Newline newline
+\end_inset
+
+ master-buffer-forall buffer-toggle-read-only
+\begin_inset Newline newline
+\end_inset
+
+ Show statistics for individual buffers:
+\begin_inset Newline newline
+\end_inset
+
+ master-buffer-forall statistics
+\begin_inset Newline newline
+\end_inset
+
+ Activate the branch named "Solutions" in buffers:
+\begin_inset Newline newline
+\end_inset
+
+ master-buffer-forall branch-activate Solutions
+\begin_inset Newline newline
+\end_inset
+
+
+\end_layout
+
+\begin_layout Description
+Origin spitz, 31 Dec 2019
+\end_layout
+
\begin_layout Subsection*
master-buffer-update
\end_layout
Origin Abdel, 21 Feb 2008
\end_layout
+\begin_layout Subsection*
+tab-group-next
+\end_layout
+
+\begin_layout Description
+Action Switch to the next tab group in split view.
+\end_layout
+
+\begin_layout Description
+Syntax tab-group-next
+\end_layout
+
+\begin_layout Subsection*
+tab-group-previous
+\end_layout
+
+\begin_layout Description
+Action Switch to the previous tab group in split view.
+\end_layout
+
+\begin_layout Description
+Syntax tab-group-previous
+\end_layout
+
\begin_layout Subsection*
toolbar-movable
\end_layout
Origin daniel, 12 July 2016
\end_layout
+\begin_layout Subsection*
+toolbar-set
+\end_layout
+
+\begin_layout Description
+Action Sets visibility of a given toolbar to on, off, or auto.
+\end_layout
+
+\begin_layout Description
+Notion Skipping "auto" when allowauto is false.
+\end_layout
+
+\begin_layout Description
+Syntax toolbar-set <NAME> [on|off|auto]
+\end_layout
+
+\begin_layout Description
+Params <NAME>: standard|extra|table|math|mathmacrotemplate|
+\begin_inset Newline newline
+\end_inset
+
+ minibuffer|review|view/update|math_panels|vcs| view-others|update-others
+\end_layout
+
+\begin_layout Description
+Origin spitz, 17 Dec 2020
+\end_layout
+
\begin_layout Subsection*
toolbar-toggle
\end_layout
\end_layout
\begin_layout Description
-Params statusbar : Toggle visibility of the statusbar.
+Params statusbar : Toggle visibility of the statusbar.
+\begin_inset Newline newline
+\end_inset
+
+menubar : Toggle visibility of the menubar.
+\begin_inset Newline newline
+\end_inset
+
+scrollbar : Toggle visibility of the scrollbar.
+\begin_inset Newline newline
+\end_inset
+
+frame : Toggle visibility of the frames around editing window.
\begin_inset Newline newline
\end_inset
-menubar : Toggle visibility of the menubar.
+zoomslider : Toggle visibility of the zoom slider in statusbar.
\begin_inset Newline newline
\end_inset
-scrollbar : Toggle visibility of the scrollbar.
+zoomlevel : Toggle visibility of the zoom level display in statusbar.
\begin_inset Newline newline
\end_inset
-frame : Toggle visibility of the frames around editing window.
+statistics-w : Toggle visibility of the document word count in statusbar.
\begin_inset Newline newline
\end_inset
-fullscreen : Toggle fullscreen mode. This also covers calling the previous functions. However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should be used.
+statistics-cb : Toggle visibility of the document character count (incl. blanks) in statusbar.
+\begin_inset Newline newline
+\end_inset
+
+statistics-c : Toggle visibility of the document character count (excl. blanks) in statusbar.
+\begin_inset Newline newline
+\end_inset
+
+fullscreen : Toggle fullscreen mode. This also covers calling the previous functions. However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should be used.
\end_layout
\begin_layout Description
System Functions (Preferences, LyX Server etc.)
\end_layout
+\begin_layout Subsection*
+bibtex-database-list
+\end_layout
+
+\begin_layout Description
+Action Lists the available databases (separated by path separator common on the used OS).
+\end_layout
+
+\begin_layout Description
+Notion Used by bibliographic managers
+\end_layout
+
+\begin_layout Description
+Syntax bibtex-database-list
+\end_layout
+
+\begin_layout Description
+Origin bpiwowar, 18 December 2022
+\end_layout
+
\begin_layout Subsection*
buffer-toggle-output-sync
\end_layout
\end_layout
\begin_layout Description
-Params <type>: language|color|sectioning|font|series|shape|family|markup|underline|strike<value>: true|false
+Params <type>: language|color|sectioning|font|series|shape|family|markup|underline|strike|deleted|non-output-content
+\begin_inset Newline newline
+\end_inset
+
+<value>: true|false
\end_layout
\begin_layout Subsection*
\end_layout
\begin_layout Description
-Action Set the given LyX color to the color defined by the X11 name given.
+Action Set the given LyX color to the color defined by the X11 name given, and optionally a specific color for dark mode.
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Syntax set-color <LYX_NAME> <X11_NAME>
+Syntax set-color <LYX_NAME> <X11_NAME> [<X11_DARKNAME>]
\end_layout
\begin_layout Description
Syntax self-insert <STRING>
\end_layout
+\begin_layout Subsection*
+window-raise
+\end_layout
+
+\begin_layout Description
+Action Raises the LyX window.
+\end_layout
+
+\begin_layout Description
+Notion Brings the LyX window to the front. Such behavior is allowed on Windows only when no other application has focus. This action is used when LyX is in single instance mode.
+\end_layout
+
+\begin_layout Description
+Syntax window-raise
+\end_layout
+
+\begin_layout Description
+Origin forenr, 21 Apr 2020
+\end_layout
+
\end_body
\end_document
projects / lyx.git / blobdiff