lib/doc/LFUNs.lyx

   1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
   2 \lyxformat 620
   3 \begin_document
   4 \begin_header
   5 \save_transient_properties true
   6 \origin /systemlyxdir/doc/
   7 \textclass article
   8 \begin_preamble
   9 \renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
  10 \renewenvironment{description}{\list{}{%
  11   \setlength{\itemsep}{-2pt}
  12   \advance\leftmargini6\p@ \itemindent-12\p@
  13   \labelwidth\z@ \let\makelabel\descriptionlabel}%
  14 }{
  15   \endlist
  16 }
  17 \end_preamble
  18 \use_default_options false
  19 \maintain_unincluded_children no
  20 \begin_local_layout
  21 Style Description
  22 LabelIndent           MM
  23 LeftMargin            MMMMMxx
  24 End
  25 \end_local_layout
  26 \language english
  27 \language_package default
  28 \inputencoding auto-legacy
  29 \fontencoding auto
  30 \font_roman "default" "default"
  31 \font_sans "default" "default"
  32 \font_typewriter "default" "default"
  33 \font_math "auto" "auto"
  34 \font_default_family default
  35 \use_non_tex_fonts false
  36 \font_sc false
  37 \font_roman_osf false
  38 \font_sans_osf false
  39 \font_typewriter_osf false
  40 \font_sf_scale 100 100
  41 \font_tt_scale 100 100
  42 \use_microtype false
  43 \use_dash_ligatures true
  44 \graphics default
  45 \default_output_format default
  46 \output_sync 0
  47 \bibtex_command default
  48 \index_command default
  49 \paperfontsize default
  50 \spacing single
  51 \use_hyperref false
  52 \papersize default
  53 \use_geometry true
  54 \use_package amsmath 1
  55 \use_package amssymb 1
  56 \use_package cancel 0
  57 \use_package esint 1
  58 \use_package mathdots 0
  59 \use_package mathtools 0
  60 \use_package mhchem 1
  61 \use_package stackrel 0
  62 \use_package stmaryrd 0
  63 \use_package undertilde 0
  64 \cite_engine basic
  65 \cite_engine_type default
  66 \biblio_style plain
  67 \use_bibtopic false
  68 \use_indices false
  69 \paperorientation portrait
  70 \suppress_date false
  71 \justification true
  72 \use_refstyle 0
  73 \use_formatted_ref 0
  74 \use_minted 0
  75 \use_lineno 0
  76 \index Index
  77 \shortcut idx
  78 \color #008000
  79 \end_index
  80 \leftmargin 2.5cm
  81 \topmargin 2cm
  82 \rightmargin 3cm
  83 \bottommargin 2.5cm
  84 \secnumdepth 3
  85 \tocdepth 3
  86 \paragraph_separation indent
  87 \paragraph_indentation default
  88 \is_math_indent 0
  89 \math_numbering_side default
  90 \quotes_style english
  91 \dynamic_quotes 0
  92 \papercolumns 1
  93 \papersides 1
  94 \paperpagestyle default
  95 \tablestyle default
  96 \tracking_changes true
  97 \output_changes false
  98 \change_bars false
  99 \postpone_fragile_content false
 100 \html_math_output 0
 101 \html_css_as_file 0
 102 \html_be_strict false
 103 \docbook_table_output 0
 104 \docbook_mathml_prefix 1
 105 \author -584632292 "Richard Kimberly Heck"
 106 \end_header
 107
 108 \begin_body
 109
 110 \begin_layout Title
 111 \SpecialChar LyX
 112  Functions (LFUNs)
 113 \end_layout
 114
 115 \begin_layout Author
 116 The \SpecialChar LyX
 117  Team
 118 \end_layout
 119
 120 \begin_layout Section*
 121 About this manual
 122 \end_layout
 123
 124 \begin_layout Standard
 125 This manual documents the
 126 \begin_inset Quotes eld
 127 \end_inset
 128
 129 LyX Functions
 130 \begin_inset Quotes erd
 131 \end_inset
 132
 133  (abbreviated LFUNs).
 134  These are commands that are used to make \SpecialChar LyX
 135  perform specific actions.
 136  \SpecialChar LyX
 137  itself uses these functions internally,
 138  and every internal action is bound to an LFUN.
 139 \end_layout
 140
 141 \begin_layout Standard
 142 LFUNs are also used in the files that define keyboard shortcuts,
 143  menu or toolbar items.
 144  So if you want to change\SpecialChar breakableslash
 145 customize the user interface,
 146  you need to deal with LFUNs.
 147  Furthermore,
 148  external programs can use LFUNs to communicate with and
 149 \begin_inset Quotes eld
 150 \end_inset
 151
 152 remote-control
 153 \begin_inset Quotes erd
 154 \end_inset
 155
 156  \SpecialChar LyX
 157  .
 158  Finally,
 159  you can also issue LFUNs directly via the so called mini-buffer which can be opened via
 160 \begin_inset Info
 161 type  "shortcuts"
 162 arg   "command-execute"
 163 \end_inset
 164
 165 .
 166 \change_inserted -584632292 1712005995
 167
 168 \end_layout
 169
 170 \begin_layout Standard
 171
 172 \change_inserted -584632292 1712006077
 173 Usually,
 174  when multiple optional arguments are shown,
 175  the earlier arguments must be given if later ones are to be given.
 176  So,
 177  for example,
 178  in quote-insert,
 179  <LEVEL> can be given alone,
 180  without <SIDE> and <STYLE>,
 181  but it must be given if <SIDE> is given,
 182  and all three must be given if <STYLE> is to be given.
 183 \change_unchanged
 184
 185 \end_layout
 186
 187 \begin_layout Standard
 188 In the following,
 189  all LFUNs are listed,
 190  categorized by function.
 191 \end_layout
 192
 193 \begin_layout Section
 194 Layout Functions (Font,
 195  Layout and Textclass related)
 196 \end_layout
 197
 198 \begin_layout Subsection*
 199 drop-layouts-choice
 200 \end_layout
 201
 202 \begin_layout Description
 203 Action Displays list of layout choices.
 204 \end_layout
 205
 206 \begin_layout Description
 207 Notion This LFUN opens the dropbox allowing for choice of layout.
 208 \end_layout
 209
 210 \begin_layout Description
 211 Syntax drop-layouts-choice
 212 \end_layout
 213
 214 \begin_layout Subsection*
 215 environment-split
 216 \end_layout
 217
 218 \begin_layout Description
 219 Action Splits the current environment with a Separator.
 220 \end_layout
 221
 222 \begin_layout Description
 223 Syntax environment-split [before|outer|previous]
 224 \end_layout
 225
 226 \begin_layout Description
 227 Params outer:
 228     If this is given,
 229  LyX will split the outermost environment in the current nesting hierarchy.
 230 \begin_inset Newline newline
 231 \end_inset
 232
 233 previous:
 234  If this is given,
 235  LyX will split the environment in the previous paragraph (if there is one).
 236 \begin_inset Newline newline
 237 \end_inset
 238
 239 before:
 240    If this is given,
 241  the new environment will be appended rather than prepended.
 242 \end_layout
 243
 244 \begin_layout Description
 245 Origin spitz,
 246  23 Dec 2012
 247 \end_layout
 248
 249 \begin_layout Subsection*
 250 font-bold
 251 \end_layout
 252
 253 \begin_layout Description
 254 Action Toggles the bold font (selection-wise) using mathbf in math.
 255 \end_layout
 256
 257 \begin_layout Description
 258 Syntax font-bold
 259 \end_layout
 260
 261 \begin_layout Subsection*
 262 font-boldsymbol
 263 \end_layout
 264
 265 \begin_layout Description
 266 Action Toggles the bold font (selection-wise) using boldsymbol in math.
 267 \end_layout
 268
 269 \begin_layout Description
 270 Syntax font-boldsymbol
 271 \end_layout
 272
 273 \begin_layout Subsection*
 274 font-crossout
 275 \end_layout
 276
 277 \begin_layout Description
 278 Action Toggles xout (cross-through) in the font (selection-wise).
 279 \end_layout
 280
 281 \begin_layout Description
 282 Syntax font-crossout
 283 \end_layout
 284
 285 \begin_layout Description
 286 Origin uwestoehr,
 287  4 April 2017
 288 \end_layout
 289
 290 \begin_layout Subsection*
 291 font-default
 292 \end_layout
 293
 294 \begin_layout Description
 295 Action Reverts the settings of the font to the default values (selection-wise).
 296 \end_layout
 297
 298 \begin_layout Description
 299 Syntax font-default
 300 \end_layout
 301
 302 \begin_layout Subsection*
 303 font-emph
 304 \end_layout
 305
 306 \begin_layout Description
 307 Action Toggles the emphasis font style (selection-wise).
 308 \end_layout
 309
 310 \begin_layout Description
 311 Syntax font-emph
 312 \end_layout
 313
 314 \begin_layout Subsection*
 315 font-frak
 316 \end_layout
 317
 318 \begin_layout Description
 319 Action Toggles Fraktur family font (math-mode,
 320  selection-wise).
 321 \end_layout
 322
 323 \begin_layout Description
 324 Syntax font-frak
 325 \end_layout
 326
 327 \begin_layout Description
 328 Origin vermeer,
 329  10 Jan 2002
 330 \end_layout
 331
 332 \begin_layout Subsection*
 333 font-ital
 334 \end_layout
 335
 336 \begin_layout Description
 337 Action Toggles Italics font shape (math-mode,
 338  selection-wise).
 339 \end_layout
 340
 341 \begin_layout Description
 342 Syntax font-ital
 343 \end_layout
 344
 345 \begin_layout Description
 346 Origin vermeer,
 347  10 Jan 2002
 348 \end_layout
 349
 350 \begin_layout Subsection*
 351 font-nospellcheck
 352 \end_layout
 353
 354 \begin_layout Description
 355 Action Toggles nospellcheck status in the font (selection-wise).
 356 \end_layout
 357
 358 \begin_layout Description
 359 Syntax font-nospellcheck
 360 \end_layout
 361
 362 \begin_layout Description
 363 Origin spitz,
 364  5 March 2021
 365 \end_layout
 366
 367 \begin_layout Subsection*
 368 font-noun
 369 \end_layout
 370
 371 \begin_layout Description
 372 Action Toggles Noun text style font (selection-wise).
 373 \end_layout
 374
 375 \begin_layout Description
 376 Syntax font-noun
 377 \end_layout
 378
 379 \begin_layout Subsection*
 380 font-roman
 381 \end_layout
 382
 383 \begin_layout Description
 384 Action Toggles Roman family font (selection-wise).
 385 \end_layout
 386
 387 \begin_layout Description
 388 Syntax font-roman
 389 \end_layout
 390
 391 \begin_layout Subsection*
 392 font-sans
 393 \end_layout
 394
 395 \begin_layout Description
 396 Action Toggles Sans Serif family font (selection-wise).
 397 \end_layout
 398
 399 \begin_layout Description
 400 Syntax font-sans
 401 \end_layout
 402
 403 \begin_layout Subsection*
 404 font-size
 405 \end_layout
 406
 407 \begin_layout Description
 408 Action Sets font size according to lyx format string.
 409 \end_layout
 410
 411 \begin_layout Description
 412 Syntax font-size <SIZE>
 413 \end_layout
 414
 415 \begin_layout Description
 416 Params <SIZE>:
 417  tiny|scriptsize|footnotesize|small|normal|large|larger|
 418 \begin_inset Newline newline
 419 \end_inset
 420
 421 largest|huge|giant|increase|decrease|default
 422 \end_layout
 423
 424 \begin_layout Subsection*
 425 font-state
 426 \end_layout
 427
 428 \begin_layout Description
 429 Action Returns the info about the current font.
 430 \end_layout
 431
 432 \begin_layout Description
 433 Syntax font-state
 434 \end_layout
 435
 436 \begin_layout Subsection*
 437 font-strikeout
 438 \end_layout
 439
 440 \begin_layout Description
 441 Action Toggles strikeout (strike-through) in the font (selection-wise).
 442 \end_layout
 443
 444 \begin_layout Description
 445 Syntax font-strikeout
 446 \end_layout
 447
 448 \begin_layout Description
 449 Origin sanda,
 450  3 May 2009
 451 \end_layout
 452
 453 \begin_layout Subsection*
 454 font-typewriter
 455 \end_layout
 456
 457 \begin_layout Description
 458 Action Toggles the typewriter family font (selection-wise).
 459 \end_layout
 460
 461 \begin_layout Description
 462 Syntax font-typewriter
 463 \end_layout
 464
 465 \begin_layout Subsection*
 466 font-underline
 467 \end_layout
 468
 469 \begin_layout Description
 470 Action Toggles underline in the font (selection-wise).
 471 \end_layout
 472
 473 \begin_layout Description
 474 Syntax font-underline
 475 \end_layout
 476
 477 \begin_layout Subsection*
 478 font-underunderline
 479 \end_layout
 480
 481 \begin_layout Description
 482 Action Toggles double underline in the font (selection-wise).
 483 \end_layout
 484
 485 \begin_layout Description
 486 Syntax font-underunderline
 487 \end_layout
 488
 489 \begin_layout Description
 490 Origin sanda,
 491  5 May 2009
 492 \end_layout
 493
 494 \begin_layout Subsection*
 495 font-underwave
 496 \end_layout
 497
 498 \begin_layout Description
 499 Action Toggles wavy underline in the font (selection-wise).
 500 \end_layout
 501
 502 \begin_layout Description
 503 Syntax font-underwave
 504 \end_layout
 505
 506 \begin_layout Description
 507 Origin sanda,
 508  5 May 2009
 509 \end_layout
 510
 511 \begin_layout Subsection*
 512 layout
 513 \end_layout
 514
 515 \begin_layout Description
 516 Action Sets the layout (that is,
 517  environment) for the current paragraph.
 518 \end_layout
 519
 520 \begin_layout Description
 521 Syntax layout <LAYOUT> [ignoreautonests]
 522 \end_layout
 523
 524 \begin_layout Description
 525 Params <LAYOUT>:
 526  the layout to use
 527 \begin_inset Newline newline
 528 \end_inset
 529
 530 ignoreautonests:
 531  If specified,
 532  nesting advices will be ignored.
 533 \end_layout
 534
 535 \begin_layout Subsection*
 536 layout-module-add
 537 \end_layout
 538
 539 \begin_layout Description
 540 Action Adds a module.
 541 \end_layout
 542
 543 \begin_layout Description
 544 Notion Adds a module to the list of included modules for the current buffer.
 545 \end_layout
 546
 547 \begin_layout Description
 548 Syntax layout-module-add <MODULE>
 549 \end_layout
 550
 551 \begin_layout Description
 552 Params <MODULE>:
 553  the module to be added
 554 \end_layout
 555
 556 \begin_layout Description
 557 Origin rgh,
 558  25 August 2007
 559 \end_layout
 560
 561 \begin_layout Subsection*
 562 layout-modules-clear
 563 \end_layout
 564
 565 \begin_layout Description
 566 Action Clears the module list.
 567 \end_layout
 568
 569 \begin_layout Description
 570 Notion Clears the list of included modules for the current buffer.
 571 \end_layout
 572
 573 \begin_layout Description
 574 Syntax layout-modules-clear
 575 \end_layout
 576
 577 \begin_layout Description
 578 Origin rgh,
 579  25 August 2007
 580 \end_layout
 581
 582 \begin_layout Subsection*
 583 layout-paragraph
 584 \end_layout
 585
 586 \begin_layout Description
 587 Action Launches the paragraph settings dialog.
 588 \end_layout
 589
 590 \begin_layout Description
 591 Syntax layout-paragraph
 592 \end_layout
 593
 594 \begin_layout Subsection*
 595 layout-reload
 596 \end_layout
 597
 598 \begin_layout Description
 599 Action Reloads layout information.
 600 \end_layout
 601
 602 \begin_layout Description
 603 Notion Reloads all layout information for the current buffer from disk,
 604  thus recognizing any changes that have been made to layout files on the fly.
 605  This is intended to be used only by layout developers and should not be used when one is trying to do actual work.
 606 \end_layout
 607
 608 \begin_layout Description
 609 Syntax layout-reload
 610 \end_layout
 611
 612 \begin_layout Description
 613 Origin rgh,
 614  3 September 2007
 615 \end_layout
 616
 617 \begin_layout Subsection*
 618 layout-tabular
 619 \end_layout
 620
 621 \begin_layout Description
 622 Action Launches the tabular settings dialog.
 623 \end_layout
 624
 625 \begin_layout Description
 626 Syntax layout-tabular
 627 \end_layout
 628
 629 \begin_layout Description
 630 Origin Jug,
 631  31 Jul 2000
 632 \end_layout
 633
 634 \begin_layout Subsection*
 635 layout-toggle
 636 \end_layout
 637
 638 \begin_layout Description
 639 Action Toggles the layout (that is,
 640  environment) for the current paragraph.
 641 \end_layout
 642
 643 \begin_layout Description
 644 Notion Contrary to `layout',
 645  this function resets the current (or selection) layout to the standard layout it already has the correct layout.
 646  Useful for toolbar icons.
 647 \end_layout
 648
 649 \begin_layout Description
 650 Syntax layout-toggle <LAYOUT> [ignoreautonests]
 651 \end_layout
 652
 653 \begin_layout Description
 654 Params <LAYOUT>:
 655  the layout to toggle
 656 \begin_inset Newline newline
 657 \end_inset
 658
 659 ignoreautonests:
 660  If specified,
 661  nesting advices will be ignored.
 662 \end_layout
 663
 664 \begin_layout Description
 665 Origin lasgouttes,
 666  14 May 2018
 667 \end_layout
 668
 669 \begin_layout Subsection*
 670 screen-font-update
 671 \end_layout
 672
 673 \begin_layout Description
 674 Action Update fonts and its metrics.
 675 \end_layout
 676
 677 \begin_layout Description
 678 Notion Automatically called after zoom,
 679  dpi,
 680  font names,
 681  or norm change.
 682 \end_layout
 683
 684 \begin_layout Description
 685 Syntax screen-font-update
 686 \end_layout
 687
 688 \begin_layout Description
 689 Origin ARRae,
 690  13 Aug 2000
 691 \end_layout
 692
 693 \begin_layout Subsection*
 694 textclass-apply
 695 \end_layout
 696
 697 \begin_layout Description
 698 Action Sets the text class for the current buffer.
 699 \end_layout
 700
 701 \begin_layout Description
 702 Syntax textclass-apply <TEXTCLASS>
 703 \end_layout
 704
 705 \begin_layout Description
 706 Params <TEXTCLASS>:
 707  the textclass to set.
 708  Note that this must be the filename,
 709  minus the ".layout" extension.
 710 \end_layout
 711
 712 \begin_layout Subsection*
 713 textclass-load
 714 \end_layout
 715
 716 \begin_layout Description
 717 Action Loads information for a textclass from disk.
 718 \end_layout
 719
 720 \begin_layout Description
 721 Syntax textclass-load <TEXTCLASS>
 722 \end_layout
 723
 724 \begin_layout Description
 725 Params <TEXTCLASS>:
 726  the textclass to load.
 727  Note that this must be the filename,
 728  minus the ".layout" extension.
 729 \end_layout
 730
 731 \begin_layout Subsection*
 732 textstyle-apply
 733 \end_layout
 734
 735 \begin_layout Description
 736 Action Apply last used text properties.
 737 \end_layout
 738
 739 \begin_layout Description
 740 Notion These properties are stored via LFUN_TEXTSTYLE_UPDATE,
 741  which is automatically triggered when using Text Style dialog.
 742 \end_layout
 743
 744 \begin_layout Description
 745 Syntax textstyle-apply [<NUM>]textstyle-apply
 746 \end_layout
 747
 748 \begin_layout Description
 749 Params <NUM>:
 750  number of the selection in the internal freefonts stack to be applied.
 751 \end_layout
 752
 753 \begin_layout Description
 754 Origin leeming,
 755  12 Mar 2003
 756 \end_layout
 757
 758 \begin_layout Subsection*
 759 textstyle-update
 760 \end_layout
 761
 762 \begin_layout Description
 763 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
 764 \end_layout
 765
 766 \begin_layout Description
 767 Syntax textstyle-update <FONT_INFO>
 768 \end_layout
 769
 770 \begin_layout Description
 771 Params <FONT_INFO>:
 772  specifies font attributes,
 773  e.g.
 774  family,
 775  series,
 776  shape,
 777  size,
 778  emph,
 779  noun,
 780  underbar,
 781  number,
 782  color,
 783  language,
 784  toggleall.
 785 \begin_inset Newline newline
 786 \end_inset
 787
 788 Use lyx -dbg action for exact syntax of text-style dialog parameters.
 789 \end_layout
 790
 791 \begin_layout Description
 792 Origin leeming,
 793  12 Mar 2003
 794 \end_layout
 795
 796 \begin_layout Section
 797 Editing Functions (Cursor and Mouse Movement,
 798  Copy/Paste etc.)
 799 \end_layout
 800
 801 \begin_layout Subsection*
 802 accent-acute
 803 \end_layout
 804
 805 \begin_layout Description
 806 Action Adds an acute accent to the next character typed.
 807 \end_layout
 808
 809 \begin_layout Description
 810 Syntax accent-acute
 811 \end_layout
 812
 813 \begin_layout Subsection*
 814 accent-breve
 815 \end_layout
 816
 817 \begin_layout Description
 818 Action Adds a breve accent to the next character typed.
 819 \end_layout
 820
 821 \begin_layout Description
 822 Syntax accent-breve
 823 \end_layout
 824
 825 \begin_layout Subsection*
 826 accent-caron
 827 \end_layout
 828
 829 \begin_layout Description
 830 Action Adds a caron to the next character typed.
 831 \end_layout
 832
 833 \begin_layout Description
 834 Syntax accent-caron
 835 \end_layout
 836
 837 \begin_layout Subsection*
 838 accent-cedilla
 839 \end_layout
 840
 841 \begin_layout Description
 842 Action Adds a cedilla to the next character typed.
 843 \end_layout
 844
 845 \begin_layout Description
 846 Syntax accent-cedilla
 847 \end_layout
 848
 849 \begin_layout Subsection*
 850 accent-circle
 851 \end_layout
 852
 853 \begin_layout Description
 854 Action Adds a circle accent to the next character typed.
 855 \end_layout
 856
 857 \begin_layout Description
 858 Syntax accent-circle
 859 \end_layout
 860
 861 \begin_layout Subsection*
 862 accent-circumflex
 863 \end_layout
 864
 865 \begin_layout Description
 866 Action Adds a circumflex to the next character typed.
 867 \end_layout
 868
 869 \begin_layout Description
 870 Syntax accent-circumflex
 871 \end_layout
 872
 873 \begin_layout Subsection*
 874 accent-dot
 875 \end_layout
 876
 877 \begin_layout Description
 878 Action Adds a dot accent to the next character typed.
 879 \end_layout
 880
 881 \begin_layout Description
 882 Syntax accent-dot
 883 \end_layout
 884
 885 \begin_layout Subsection*
 886 accent-grave
 887 \end_layout
 888
 889 \begin_layout Description
 890 Action Adds a grave accent to the next character typed.
 891 \end_layout
 892
 893 \begin_layout Description
 894 Syntax accent-grave
 895 \end_layout
 896
 897 \begin_layout Subsection*
 898 accent-hungarian-umlaut
 899 \end_layout
 900
 901 \begin_layout Description
 902 Action Adds a Hungarian umlaut to the next character typed.
 903 \end_layout
 904
 905 \begin_layout Description
 906 Syntax accent-grave
 907 \end_layout
 908
 909 \begin_layout Subsection*
 910 accent-macron
 911 \end_layout
 912
 913 \begin_layout Description
 914 Action Adds a macron to the next character typed.
 915 \end_layout
 916
 917 \begin_layout Description
 918 Syntax accent-macron
 919 \end_layout
 920
 921 \begin_layout Subsection*
 922 accent-ogonek
 923 \end_layout
 924
 925 \begin_layout Description
 926 Action Adds an ogonek accent to the next character typed.
 927 \end_layout
 928
 929 \begin_layout Description
 930 Syntax accent-ogonek
 931 \end_layout
 932
 933 \begin_layout Subsection*
 934 accent-perispomeni
 935 \end_layout
 936
 937 \begin_layout Description
 938 Action Adds a perispomeni (Greek circumflex) over the next character typed.
 939 \end_layout
 940
 941 \begin_layout Description
 942 Syntax accent-perispomeni
 943 \end_layout
 944
 945 \begin_layout Subsection*
 946 accent-tie
 947 \end_layout
 948
 949 \begin_layout Description
 950 Action Adds a tie over the next two character typed.
 951 \end_layout
 952
 953 \begin_layout Description
 954 Notion The following char will finish the tie.
 955 \end_layout
 956
 957 \begin_layout Description
 958 Syntax accent-tie
 959 \end_layout
 960
 961 \begin_layout Subsection*
 962 accent-tilde
 963 \end_layout
 964
 965 \begin_layout Description
 966 Action Adds a tilde over the next character typed.
 967 \end_layout
 968
 969 \begin_layout Description
 970 Syntax accent-tilde
 971 \end_layout
 972
 973 \begin_layout Subsection*
 974 accent-umlaut
 975 \end_layout
 976
 977 \begin_layout Description
 978 Action Adds an umlaut over the next character typed.
 979 \end_layout
 980
 981 \begin_layout Description
 982 Syntax accent-umlaut
 983 \end_layout
 984
 985 \begin_layout Subsection*
 986 accent-underbar
 987 \end_layout
 988
 989 \begin_layout Description
 990 Action Adds a bar under the next character typed.
 991 \end_layout
 992
 993 \begin_layout Description
 994 Syntax accent-underbar
 995 \end_layout
 996
 997 \begin_layout Subsection*
 998 accent-underdot
 999 \end_layout
1000
1001 \begin_layout Description
1002 Action Adds a dot under the next character typed.
1003 \end_layout
1004
1005 \begin_layout Description
1006 Syntax accent-underdot
1007 \end_layout
1008
1009 \begin_layout Subsection*
1010 all-changes-accept
1011 \end_layout
1012
1013 \begin_layout Description
1014 Action Accepts all tracked changes in the document.
1015 \end_layout
1016
1017 \begin_layout Description
1018 Syntax all-changes-accept
1019 \end_layout
1020
1021 \begin_layout Description
1022 Origin Levon,
1023  16 Oct 2002
1024 \end_layout
1025
1026 \begin_layout Subsection*
1027 all-changes-reject
1028 \end_layout
1029
1030 \begin_layout Description
1031 Action Rejects all tracked changes in the document.
1032 \end_layout
1033
1034 \begin_layout Description
1035 Notion Reject does not work recursively;
1036  the user may have to repeat the operation.
1037 \end_layout
1038
1039 \begin_layout Description
1040 Syntax all-changes-reject
1041 \end_layout
1042
1043 \begin_layout Description
1044 Origin Levon,
1045  16 Oct 2002
1046 \end_layout
1047
1048 \begin_layout Subsection*
1049 appendix
1050 \end_layout
1051
1052 \begin_layout Description
1053 Action Start (or remove) Appendix on the given cursor position.
1054 \end_layout
1055
1056 \begin_layout Description
1057 Syntax appendix
1058 \end_layout
1059
1060 \begin_layout Description
1061 Origin ettrich,
1062  5 May 1998
1063 \end_layout
1064
1065 \begin_layout Subsection*
1066 argument-insert
1067 \end_layout
1068
1069 \begin_layout Description
1070 Action Inserts an argument (short title) inset.
1071 \end_layout
1072
1073 \begin_layout Description
1074 Syntax argument-insert <argument nr>
1075 \end_layout
1076
1077 \begin_layout Description
1078 Params <argument nr>:
1079  see layout declarations
1080 \end_layout
1081
1082 \begin_layout Description
1083 Origin vermeer,
1084  12 Aug 2002
1085 \end_layout
1086
1087 \begin_layout Subsection*
1088 bibtex-database-add
1089 \end_layout
1090
1091 \begin_layout Description
1092 Action Adds database,
1093  which will be used for bibtex citations.
1094 \end_layout
1095
1096 \begin_layout Description
1097 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1098 \end_layout
1099
1100 \begin_layout Description
1101 Syntax bibtex-database-add <DATABASE-NAME>
1102 \end_layout
1103
1104 \begin_layout Description
1105 Origin Ale,
1106  30 May 1997
1107 \end_layout
1108
1109 \begin_layout Subsection*
1110 bibtex-database-del
1111 \end_layout
1112
1113 \begin_layout Description
1114 Action Adds database,
1115  which will be used for bibtex citations.
1116 \end_layout
1117
1118 \begin_layout Description
1119 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1120 \end_layout
1121
1122 \begin_layout Description
1123 Syntax bibtex-database-del <DATABASE-NAME>
1124 \end_layout
1125
1126 \begin_layout Description
1127 Origin Ale,
1128  30 May 1997
1129 \end_layout
1130
1131 \begin_layout Subsection*
1132 bookmark-clear
1133 \end_layout
1134
1135 \begin_layout Description
1136 Action Clears the list of saved bookmarks.
1137 \end_layout
1138
1139 \begin_layout Description
1140 Syntax bookmark-clear
1141 \end_layout
1142
1143 \begin_layout Description
1144 Origin bpeng,
1145  31 October 2006
1146 \end_layout
1147
1148 \begin_layout Subsection*
1149 bookmark-goto
1150 \end_layout
1151
1152 \begin_layout Description
1153 Action Moves the cursor to the numbered bookmark,
1154  opening the file if necessary.
1155  Note that bookmarks are saved per-session,
1156  not per file.
1157 \end_layout
1158
1159 \begin_layout Description
1160 Notion Bookmark 0 has a special purpose.
1161  It is automatically set
1162 \begin_inset Newline newline
1163 \end_inset
1164
1165 1.
1166  to the paragraph you are currently editing
1167 \begin_inset Newline newline
1168 \end_inset
1169
1170 2.
1171  to the paragraph from where you are jumping to the last-edited position (jump-back feature)
1172 \begin_inset Newline newline
1173 \end_inset
1174
1175 3.
1176  when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
1177 \end_layout
1178
1179 \begin_layout Description
1180 Syntax bookmark-goto <NUMBER>
1181 \end_layout
1182
1183 \begin_layout Description
1184 Params <NUMBER>:
1185  the number of the bookmark to restore.
1186 \end_layout
1187
1188 \begin_layout Description
1189 Origin Dekel,
1190  27 January 2001
1191 \end_layout
1192
1193 \begin_layout Subsection*
1194 bookmark-save
1195 \end_layout
1196
1197 \begin_layout Description
1198 Action Save a bookmark.
1199 \end_layout
1200
1201 \begin_layout Description
1202 Notion Saves a numbered bookmark to the sessions file.
1203  The number must be between 1 and 9,
1204  inclusive.
1205  Note that bookmarks are saved per-session,
1206  not per file.
1207 \end_layout
1208
1209 \begin_layout Description
1210 Syntax bookmark-save <NUMBER>
1211 \end_layout
1212
1213 \begin_layout Description
1214 Params <NUMBER>:
1215  the number of the bookmark to save.
1216 \end_layout
1217
1218 \begin_layout Description
1219 Origin Dekel,
1220  27 January 2001
1221 \end_layout
1222
1223 \begin_layout Subsection*
1224 box-insert
1225 \end_layout
1226
1227 \begin_layout Description
1228 Action Inserts Box inset.
1229 \end_layout
1230
1231 \begin_layout Description
1232 Syntax box-insert [<TYPE>]
1233 \end_layout
1234
1235 \begin_layout Description
1236 Params <TYPE>:
1237  Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
1238 \begin_inset Newline newline
1239 \end_inset
1240
1241 Framed is the default one.
1242 \end_layout
1243
1244 \begin_layout Description
1245 Origin vermeer,
1246  7 Oct 2003
1247 \end_layout
1248
1249 \begin_layout Subsection*
1250 branch-insert
1251 \end_layout
1252
1253 \begin_layout Description
1254 Action Inserts branch inset.
1255 \end_layout
1256
1257 \begin_layout Description
1258 Syntax branch-insert <BRANCH-NAME>
1259 \end_layout
1260
1261 \begin_layout Description
1262 Origin vermeer,
1263  17 Aug 2003
1264 \end_layout
1265
1266 \begin_layout Subsection*
1267 buffer-anonymize
1268 \end_layout
1269
1270 \begin_layout Description
1271 Action For debug purposes only.
1272  Convert all [a-zA-Z0-1] characters to single character.
1273  Useful when submitting docs to list or bugzilla.
1274 \end_layout
1275
1276 \begin_layout Description
1277 Syntax buffer-anonymize
1278 \end_layout
1279
1280 \begin_layout Description
1281 Origin sanda,
1282  Feb 1 2018
1283 \end_layout
1284
1285 \begin_layout Subsection*
1286 buffer-begin
1287 \end_layout
1288
1289 \begin_layout Description
1290 Action Move the cursor to the beginning of the document.
1291 \end_layout
1292
1293 \begin_layout Description
1294 Syntax buffer-begin
1295 \end_layout
1296
1297 \begin_layout Subsection*
1298 buffer-begin-select
1299 \end_layout
1300
1301 \begin_layout Description
1302 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1303 \end_layout
1304
1305 \begin_layout Description
1306 Syntax buffer-begin-select
1307 \end_layout
1308
1309 \begin_layout Subsection*
1310 buffer-end
1311 \end_layout
1312
1313 \begin_layout Description
1314 Action Move the cursor to the end of the document.
1315 \end_layout
1316
1317 \begin_layout Description
1318 Syntax buffer-end
1319 \end_layout
1320
1321 \begin_layout Subsection*
1322 buffer-end-select
1323 \end_layout
1324
1325 \begin_layout Description
1326 Action Move the cursor to the end of the document adding the traversed text to the selection.
1327 \end_layout
1328
1329 \begin_layout Description
1330 Syntax buffer-end-select
1331 \end_layout
1332
1333 \begin_layout Subsection*
1334 caption-insert
1335 \end_layout
1336
1337 \begin_layout Description
1338 Action Inserts a caption inset.
1339 \end_layout
1340
1341 \begin_layout Description
1342 Syntax caption-insert
1343 \end_layout
1344
1345 \begin_layout Description
1346 Origin Lgb,
1347  18 Jul 2000
1348 \end_layout
1349
1350 \begin_layout Subsection*
1351 cell-backward
1352 \end_layout
1353
1354 \begin_layout Description
1355 Action Moves the cursor to the previous cell inside the table.
1356 \end_layout
1357
1358 \begin_layout Description
1359 Syntax cell-backward
1360 \end_layout
1361
1362 \begin_layout Description
1363 Origin Jug,
1364  22 May 2000
1365 \end_layout
1366
1367 \begin_layout Subsection*
1368 cell-forward
1369 \end_layout
1370
1371 \begin_layout Description
1372 Action Moves the cursor to the next cell inside the table.
1373 \end_layout
1374
1375 \begin_layout Description
1376 Syntax cell-forward
1377 \end_layout
1378
1379 \begin_layout Subsection*
1380 cell-split
1381 \end_layout
1382
1383 \begin_layout Description
1384 Action Splits cell and shifts right part to the next cell (inside the math grid).
1385 \end_layout
1386
1387 \begin_layout Description
1388 Syntax cell-split
1389 \end_layout
1390
1391 \begin_layout Description
1392 Origin Ale,
1393  15 May 1997
1394 \end_layout
1395
1396 \begin_layout Subsection*
1397 change-accept
1398 \end_layout
1399
1400 \begin_layout Description
1401 Action Accepts tracked change inside the selection.
1402 \end_layout
1403
1404 \begin_layout Description
1405 Syntax change-accept
1406 \end_layout
1407
1408 \begin_layout Description
1409 Origin Levon,
1410  16 Oct 2002
1411 \end_layout
1412
1413 \begin_layout Subsection*
1414 change-next
1415 \end_layout
1416
1417 \begin_layout Description
1418 Action Moves the cursor to the position of the next change of the change tracking records.
1419 \end_layout
1420
1421 \begin_layout Description
1422 Syntax change-next
1423 \end_layout
1424
1425 \begin_layout Description
1426 Origin schmitt,
1427  4 Oct 2006
1428 \end_layout
1429
1430 \begin_layout Subsection*
1431 change-previous
1432 \end_layout
1433
1434 \begin_layout Description
1435 Action Moves the cursor to the position of the previous change of the change tracking records.
1436 \end_layout
1437
1438 \begin_layout Description
1439 Syntax change-previous
1440 \end_layout
1441
1442 \begin_layout Description
1443 Origin vfr,
1444  4 Apr 2009
1445 \end_layout
1446
1447 \begin_layout Subsection*
1448 change-reject
1449 \end_layout
1450
1451 \begin_layout Description
1452 Action Rejects tracked change inside the selection.
1453 \end_layout
1454
1455 \begin_layout Description
1456 Syntax change-reject
1457 \end_layout
1458
1459 \begin_layout Description
1460 Origin Levon,
1461  16 Oct 2002
1462 \end_layout
1463
1464 \begin_layout Subsection*
1465 changes-merge
1466 \end_layout
1467
1468 \begin_layout Description
1469 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
1470 \end_layout
1471
1472 \begin_layout Description
1473 Syntax changes-merge
1474 \end_layout
1475
1476 \begin_layout Description
1477 Origin Levon,
1478  16 Oct 2002
1479 \end_layout
1480
1481 \begin_layout Subsection*
1482 changes-output
1483 \end_layout
1484
1485 \begin_layout Description
1486 Action Toggles showing of change tracking in typeset output.
1487 \end_layout
1488
1489 \begin_layout Description
1490 Syntax changes-output
1491 \end_layout
1492
1493 \begin_layout Description
1494 Origin spitz,
1495  21 Jan 2005
1496 \end_layout
1497
1498 \begin_layout Subsection*
1499 changes-track
1500 \end_layout
1501
1502 \begin_layout Description
1503 Action Toggles change tracking to on/off.
1504 \end_layout
1505
1506 \begin_layout Description
1507 Syntax changes-track
1508 \end_layout
1509
1510 \begin_layout Description
1511 Origin levon,
1512  1 Oct 2002
1513 \end_layout
1514
1515 \begin_layout Subsection*
1516 char-backward
1517 \end_layout
1518
1519 \begin_layout Description
1520 Action Moves the cursor one position logically backwards.
1521 \end_layout
1522
1523 \begin_layout Description
1524 Notion This is not the action which should be bound to the arrow keys,
1525  because backwards may be left or right,
1526  depending on the language.
1527  The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1528  which in turn may employ this one.
1529 \end_layout
1530
1531 \begin_layout Description
1532 Syntax char-backward
1533 \end_layout
1534
1535 \begin_layout Subsection*
1536 char-backward-select
1537 \end_layout
1538
1539 \begin_layout Description
1540 Action Moves the cursor one position logically backwards,
1541  adding traversed position to the selection.
1542 \end_layout
1543
1544 \begin_layout Description
1545 Notion See also LFUN_CHAR_BACKWARD.
1546 \end_layout
1547
1548 \begin_layout Description
1549 Syntax char-backward-select
1550 \end_layout
1551
1552 \begin_layout Subsection*
1553 char-delete-backward
1554 \end_layout
1555
1556 \begin_layout Description
1557 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1558 \end_layout
1559
1560 \begin_layout Description
1561 Syntax char-delete-backward [confirm]
1562 \end_layout
1563
1564 \begin_layout Description
1565 Params confirm:
1566  Select big insets,
1567  do not directly delete them.
1568 \end_layout
1569
1570 \begin_layout Subsection*
1571 char-delete-forward
1572 \end_layout
1573
1574 \begin_layout Description
1575 Action Deletes one character in the backward direction (usually the "Delete" key).
1576 \end_layout
1577
1578 \begin_layout Description
1579 Syntax char-delete-forward [confirm]
1580 \end_layout
1581
1582 \begin_layout Description
1583 Params confirm:
1584  Select big insets,
1585  do not directly delete them.
1586 \end_layout
1587
1588 \begin_layout Subsection*
1589 char-forward
1590 \end_layout
1591
1592 \begin_layout Description
1593 Action Moves the cursor one position logically forward.
1594 \end_layout
1595
1596 \begin_layout Description
1597 Notion This is not the action which should be bound to the arrow keys,
1598  because forward may be left or right,
1599  depending on the language.
1600  The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1601  which in turn may employ this one.
1602 \end_layout
1603
1604 \begin_layout Description
1605 Syntax char-forward
1606 \end_layout
1607
1608 \begin_layout Subsection*
1609 char-forward-select
1610 \end_layout
1611
1612 \begin_layout Description
1613 Action Moves the cursor one position logically forward,
1614  adding traversed position to the selection.
1615 \end_layout
1616
1617 \begin_layout Description
1618 Notion See also LFUN_CHAR_FORWARD.
1619 \end_layout
1620
1621 \begin_layout Description
1622 Syntax char-forward-select
1623 \end_layout
1624
1625 \begin_layout Subsection*
1626 char-left
1627 \end_layout
1628
1629 \begin_layout Description
1630 Action Moves the cursor one position "to the left".
1631 \end_layout
1632
1633 \begin_layout Description
1634 Notion This is the action which should be taken when the "left" key is pressed.
1635  Generally,
1636  it moves the cursor one position to the left.
1637  However,
1638  in Bidi text this become slightly more complicated,
1639  and there are different modes of cursor movement.
1640  In "visual mode",
1641  this moves left,
1642  plain and simple.
1643  In "logical mode",
1644  movement is logically forward in RTL paragraphs,
1645  and logically backwards in LTR paragraphs.
1646 \end_layout
1647
1648 \begin_layout Description
1649 Syntax char-left
1650 \end_layout
1651
1652 \begin_layout Subsection*
1653 char-left-select
1654 \end_layout
1655
1656 \begin_layout Description
1657 Action Moves the cursor one position "to the left",
1658  adding traversed position to the selection.
1659 \end_layout
1660
1661 \begin_layout Description
1662 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1663 \end_layout
1664
1665 \begin_layout Description
1666 Syntax char-left-select
1667 \end_layout
1668
1669 \begin_layout Subsection*
1670 char-right
1671 \end_layout
1672
1673 \begin_layout Description
1674 Action Moves the cursor one position "to the right".
1675 \end_layout
1676
1677 \begin_layout Description
1678 Notion This is the action which should be taken when the "right" key is pressed.
1679  Generally,
1680  it moves the cursor one position to the right.
1681  However,
1682  in Bidi text this become slightly more complicated,
1683  and there are different modes of cursor movement.
1684  In "visual mode",
1685  this moves right,
1686  plain and simple.
1687  In "logical mode",
1688  movement is logically forward in LTR paragraphs,
1689  and logically backwards in RTL paragraphs.
1690 \end_layout
1691
1692 \begin_layout Description
1693 Syntax char-right
1694 \end_layout
1695
1696 \begin_layout Subsection*
1697 char-right-select
1698 \end_layout
1699
1700 \begin_layout Description
1701 Action Moves the cursor one position "to the right",
1702  adding traversed position to the selection.
1703 \end_layout
1704
1705 \begin_layout Description
1706 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1707 \end_layout
1708
1709 \begin_layout Description
1710 Syntax char-right-select
1711 \end_layout
1712
1713 \begin_layout Subsection*
1714 chars-transpose
1715 \end_layout
1716
1717 \begin_layout Description
1718 Action Transposes the character at the cursor with the one before it.
1719 \end_layout
1720
1721 \begin_layout Description
1722 Syntax chars-transpose
1723 \end_layout
1724
1725 \begin_layout Description
1726 Origin Lgb,
1727  25 Apr 2001
1728 \end_layout
1729
1730 \begin_layout Subsection*
1731 citation-insert
1732 \end_layout
1733
1734 \begin_layout Description
1735 Action Inserts citation from loaded citation database.
1736 \end_layout
1737
1738 \begin_layout Description
1739 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1740 \end_layout
1741
1742 \begin_layout Description
1743 Params <KEY>:
1744  Citation (shortcut listed in available citations).
1745 \begin_inset Newline newline
1746 \end_inset
1747
1748 <TEXT_BEFORE>:
1749  text which should appear before citation.
1750 \end_layout
1751
1752 \begin_layout Description
1753 Origin AAS,
1754  97-02-23
1755 \end_layout
1756
1757 \begin_layout Subsection*
1758 citation-open
1759 \end_layout
1760
1761 \begin_layout Description
1762 Action Opens the corresponding pdf/url for a given citation inset.
1763 \end_layout
1764
1765 \begin_layout Description
1766 Syntax citation-open [EXTERNAL] TARGET
1767 \end_layout
1768
1769 \begin_layout Description
1770 Params <TARGET>:
1771  URL (https:,file:) of the document.
1772 \begin_inset Newline newline
1773 \end_inset
1774
1775 <EXTERNAL>:
1776  Use external executable script for finding target
1777 \begin_inset Newline newline
1778 \end_inset
1779
1780                and launching viewer.
1781  In this case TARGET consists of author and year
1782 \begin_inset Newline newline
1783 \end_inset
1784
1785                and will be passed as an input argument to the script.
1786 \end_layout
1787
1788 \begin_layout Description
1789 Origin Sanda,
1790  16 Aug 2020
1791 \end_layout
1792
1793 \begin_layout Subsection*
1794 clipboard-paste
1795 \end_layout
1796
1797 \begin_layout Description
1798 Action Pastes text from the active clipboard (retains formatting if the clipboard contains formatted text).
1799  Pastes plain text if plain text is on the clipboard,
1800  but tries to interpret it in special ways for certain insets,
1801  e.g.
1802  converting csv data to rows and columns if the paste happens in a tabular inset.
1803 \end_layout
1804
1805 \begin_layout Description
1806 Notion Historically,
1807  LFUN_CLIPBOARD_PASTE was introduced as a counterpart of LFUN_PRIMARY_SELECTION_PASTE:
1808  It behaved exactly the same,
1809  but the source is the clipboard,
1810  not the selection.
1811 \end_layout
1812
1813 \begin_layout Description
1814 Syntax clipboard-paste [<ARG>]
1815 \end_layout
1816
1817 \begin_layout Description
1818 Params <ARG>:
1819  "paragraph" will cause pasting as one paragraph,
1820  i.e.
1821  "Join lines".
1822 \end_layout
1823
1824 \begin_layout Description
1825 Origin Georg,
1826  10 Jul 2006
1827 \end_layout
1828
1829 \begin_layout Subsection*
1830 clipboard-paste-simple
1831 \end_layout
1832
1833 \begin_layout Description
1834 Action Pastes plain text from the active clipboard even if formatted LyX content is in the clipboard.
1835  Pastes plain text if plain text is on the clipboard,
1836  without trying to interpret it in special ways for certain insets,
1837  e.g.
1838  converting csv data to rows and columns if the paste happens in a tabular inset.
1839 \end_layout
1840
1841 \begin_layout Description
1842 Syntax clipboard-paste-simple [<ARG>]
1843 \end_layout
1844
1845 \begin_layout Description
1846 Params <ARG>:
1847  "paragraph" will cause pasting as one paragraph,
1848  i.e.
1849  "Join lines".
1850 \end_layout
1851
1852 \begin_layout Subsection*
1853 command-execute
1854 \end_layout
1855
1856 \begin_layout Description
1857 Action Switches the focus to the minibuffer so that the user can type in there.
1858  If necessary,
1859  it opens the minibuffer toolbar.
1860 \end_layout
1861
1862 \begin_layout Description
1863 Notion Usually bound to M-x shortcut.
1864 \end_layout
1865
1866 \begin_layout Description
1867 Syntax command-execute
1868 \end_layout
1869
1870 \begin_layout Subsection*
1871 complete
1872 \end_layout
1873
1874 \begin_layout Description
1875 Action Try to complete the word or command at the cursor position.
1876 \end_layout
1877
1878 \begin_layout Description
1879 Syntax complete
1880 \end_layout
1881
1882 \begin_layout Description
1883 Origin sts,
1884  Feb 19 2008
1885 \end_layout
1886
1887 \begin_layout Subsection*
1888 completion-accept
1889 \end_layout
1890
1891 \begin_layout Description
1892 Action Accept suggested completion.
1893 \end_layout
1894
1895 \begin_layout Description
1896 Syntax completion-accept
1897 \end_layout
1898
1899 \begin_layout Description
1900 Origin sanda,
1901  Sep 08 2008
1902 \end_layout
1903
1904 \begin_layout Subsection*
1905 completion-cancel
1906 \end_layout
1907
1908 \begin_layout Description
1909 Action Try to cancel completion,
1910  either the popup or the inline completion.
1911 \end_layout
1912
1913 \begin_layout Description
1914 Syntax completion-cancel
1915 \end_layout
1916
1917 \begin_layout Description
1918 Origin sts,
1919  Sep 07 2008
1920 \end_layout
1921
1922 \begin_layout Subsection*
1923 completion-inline
1924 \end_layout
1925
1926 \begin_layout Description
1927 Action Show the inline completion at the cursor position.
1928 \end_layout
1929
1930 \begin_layout Description
1931 Syntax completion-inline
1932 \end_layout
1933
1934 \begin_layout Description
1935 Origin sts,
1936  Feb 19 2008
1937 \end_layout
1938
1939 \begin_layout Subsection*
1940 completion-popup
1941 \end_layout
1942
1943 \begin_layout Description
1944 Action Show the completion popup at the cursor position.
1945 \end_layout
1946
1947 \begin_layout Description
1948 Syntax completion-popup
1949 \end_layout
1950
1951 \begin_layout Description
1952 Origin sts,
1953  Feb 19 2008
1954 \end_layout
1955
1956 \begin_layout Subsection*
1957 copy
1958 \end_layout
1959
1960 \begin_layout Description
1961 Action Copies the current selection to the clipboard.
1962 \end_layout
1963
1964 \begin_layout Description
1965 Syntax copy
1966 \end_layout
1967
1968 \begin_layout Subsection*
1969 cut
1970 \end_layout
1971
1972 \begin_layout Description
1973 Action Cuts to the clipboard.
1974 \end_layout
1975
1976 \begin_layout Description
1977 Syntax cut
1978 \end_layout
1979
1980 \begin_layout Subsection*
1981 depth-decrement
1982 \end_layout
1983
1984 \begin_layout Description
1985 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1986 \end_layout
1987
1988 \begin_layout Description
1989 Syntax depth-decrement
1990 \end_layout
1991
1992 \begin_layout Subsection*
1993 depth-increment
1994 \end_layout
1995
1996 \begin_layout Description
1997 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1998 \end_layout
1999
2000 \begin_layout Description
2001 Syntax depth-increment
2002 \end_layout
2003
2004 \begin_layout Subsection*
2005 dialog-disconnect-inset
2006 \end_layout
2007
2008 \begin_layout Description
2009 Action Closes opened connection to opened inset.
2010 \end_layout
2011
2012 \begin_layout Description
2013 Notion Connection is used for apply functions.
2014 \end_layout
2015
2016 \begin_layout Description
2017 Syntax dialog-disconnect-inset <INSET-NAME>
2018 \end_layout
2019
2020 \begin_layout Description
2021 Origin leeming,
2022  25 Feb 2003
2023 \end_layout
2024
2025 \begin_layout Subsection*
2026 dialog-hide
2027 \end_layout
2028
2029 \begin_layout Description
2030 Action Hides showed dialog.
2031  Counterpart to LFUN_DIALOG_SHOW .
2032 \end_layout
2033
2034 \begin_layout Description
2035 Syntax dialog-hide <NAME>
2036 \end_layout
2037
2038 \begin_layout Description
2039 Params See LFUN_DIALOG_SHOW .
2040 \end_layout
2041
2042 \begin_layout Description
2043 Origin leeming,
2044  25 Feb 2003
2045 \end_layout
2046
2047 \begin_layout Subsection*
2048 dialog-show
2049 \end_layout
2050
2051 \begin_layout Description
2052 Action Shows hidden dialog or creates new one for a given function/inset settings etc.
2053 \end_layout
2054
2055 \begin_layout Description
2056 Syntax dialog-show <NAME> [<DATA>]
2057 \end_layout
2058
2059 \begin_layout Description
2060 Params <NAME>:
2061  aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
2062 \begin_inset Newline newline
2063 \end_inset
2064
2065 compare|counter|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
2066 \begin_inset Newline newline
2067 \end_inset
2068
2069 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
2070 \begin_inset Newline newline
2071 \end_inset
2072
2073 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
2074 \begin_inset Newline newline
2075 \end_inset
2076
2077 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
2078 \begin_inset Newline newline
2079 \end_inset
2080
2081 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
2082 \begin_inset Newline newline
2083 \end_inset
2084
2085 <SPECIAL>:
2086  latexlog|vclog
2087 \begin_inset Newline newline
2088 \end_inset
2089
2090 <DATA>:
2091  data,
2092  usually settings for the given dialog.
2093  Use debug mode for the details.
2094 \end_layout
2095
2096 \begin_layout Description
2097 Origin leeming,
2098  17 Jun 2003
2099 \end_layout
2100
2101 \begin_layout Subsection*
2102 dialog-show-new-inset
2103 \end_layout
2104
2105 \begin_layout Description
2106 Action Shows hidden dialog or create new one for a given inset settings etc.
2107 \end_layout
2108
2109 \begin_layout Description
2110 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
2111 \end_layout
2112
2113 \begin_layout Description
2114 Syntax dialog-show-new-inset <NAME> [<DATA>]
2115 \end_layout
2116
2117 \begin_layout Description
2118 Params See LFUN_DIALOG_SHOW .
2119 \end_layout
2120
2121 \begin_layout Description
2122 Origin leeming,
2123  25 Feb 2003
2124 \end_layout
2125
2126 \begin_layout Subsection*
2127 dialog-toggle
2128 \end_layout
2129
2130 \begin_layout Description
2131 Action Toggles dialog between showed/hidden state.
2132 \end_layout
2133
2134 \begin_layout Description
2135 Notion Internally uses LFUN_DIALOG_SHOW ,
2136  LFUN_DIALOG_HIDE .
2137 \end_layout
2138
2139 \begin_layout Description
2140 Syntax dialog-toggle <NAME> [<DATA>]
2141 \end_layout
2142
2143 \begin_layout Description
2144 Params See LFUN_DIALOG_SHOW .
2145 \end_layout
2146
2147 \begin_layout Description
2148 Origin spitz,
2149  30 Apr 2007
2150 \end_layout
2151
2152 \begin_layout Subsection*
2153 dialog-update
2154 \end_layout
2155
2156 \begin_layout Description
2157 Action Updates the dialog values from the inset/paragraph/document.
2158 \end_layout
2159
2160 \begin_layout Description
2161 Syntax dialog-update <NAME>
2162 \end_layout
2163
2164 \begin_layout Description
2165 Params <NAME>:
2166  paragraph|prefs|<INSET>
2167 \begin_inset Newline newline
2168 \end_inset
2169
2170 <INSET>:
2171  inset name
2172 \end_layout
2173
2174 \begin_layout Description
2175 Origin leeming,
2176  25 Feb 2003
2177 \end_layout
2178
2179 \begin_layout Subsection*
2180 down
2181 \end_layout
2182
2183 \begin_layout Description
2184 Action Moves the cursor one line in downward direction.
2185 \end_layout
2186
2187 \begin_layout Description
2188 Syntax down
2189 \end_layout
2190
2191 \begin_layout Subsection*
2192 down-select
2193 \end_layout
2194
2195 \begin_layout Description
2196 Action Moves the cursor one line in downward direction adding the current position to the selection.
2197 \end_layout
2198
2199 \begin_layout Description
2200 Syntax down-select
2201 \end_layout
2202
2203 \begin_layout Subsection*
2204 ert-insert
2205 \end_layout
2206
2207 \begin_layout Description
2208 Action Inserts an ERT inset.
2209 \end_layout
2210
2211 \begin_layout Description
2212 Syntax ert-insert
2213 \end_layout
2214
2215 \begin_layout Description
2216 Origin Jug,
2217  18 Feb 2000
2218 \end_layout
2219
2220 \begin_layout Subsection*
2221 escape
2222 \end_layout
2223
2224 \begin_layout Description
2225 Action Clears the selection.
2226  If no text is selected call LFUN_FINISHED_FORWARD.
2227  Inside math mode jumps out of the math inset.
2228 \end_layout
2229
2230 \begin_layout Description
2231 Syntax escape
2232 \end_layout
2233
2234 \begin_layout Description
2235 Origin Lgb,
2236  17 May 2001
2237 \end_layout
2238
2239 \begin_layout Subsection*
2240 export-cancel
2241 \end_layout
2242
2243 \begin_layout Description
2244 Action Cancel background export process.
2245 \end_layout
2246
2247 \begin_layout Description
2248 Syntax export-cancel
2249 \end_layout
2250
2251 \begin_layout Description
2252 Origin rgh,
2253  10 December 2017
2254 \end_layout
2255
2256 \begin_layout Subsection*
2257 file-insert
2258 \end_layout
2259
2260 \begin_layout Description
2261 Action Inserts another LyX file.
2262 \end_layout
2263
2264 \begin_layout Description
2265 Syntax file-insert [<FILE>] [ignorelang]
2266 \end_layout
2267
2268 \begin_layout Description
2269 Params <FILE>:
2270  Filename to be inserted.
2271  ignorelang:
2272  If given,
2273  the (main) language of the inserted file is ignored (the context language is used).
2274 \end_layout
2275
2276 \begin_layout Subsection*
2277 file-insert-plaintext
2278 \end_layout
2279
2280 \begin_layout Description
2281 Action Inserts plain text file.
2282 \end_layout
2283
2284 \begin_layout Description
2285 Syntax file-insert-plaintext [<FILE>]
2286 \end_layout
2287
2288 \begin_layout Description
2289 Params <FILE>:
2290  Filename to be inserted.
2291 \end_layout
2292
2293 \begin_layout Description
2294 Origin CFO-G,
2295  19 Nov 1997
2296 \end_layout
2297
2298 \begin_layout Subsection*
2299 file-insert-plaintext-para
2300 \end_layout
2301
2302 \begin_layout Description
2303 Action Inserts plain text file as paragraph (i.e.
2304  join lines).
2305 \end_layout
2306
2307 \begin_layout Description
2308 Syntax file-insert-plaintext-para [<FILE>]
2309 \end_layout
2310
2311 \begin_layout Description
2312 Params <FILE>:
2313  Filename to be inserted.
2314 \end_layout
2315
2316 \begin_layout Description
2317 Origin Levon,
2318  14 Feb 2001
2319 \end_layout
2320
2321 \begin_layout Subsection*
2322 flex-insert
2323 \end_layout
2324
2325 \begin_layout Description
2326 Action Inserts CharStyle,
2327  Custom inset or XML short element.
2328 \end_layout
2329
2330 \begin_layout Description
2331 Notion Look into the Customization manual for more information about these elements.
2332 \begin_inset Newline newline
2333 \end_inset
2334
2335 To make this command enabled the layout file for the document class you're using has to load the character styles.
2336  There are a few contained in the Logical Markup module.
2337  You can also of course create some yourself.
2338 \begin_inset Newline newline
2339 \end_inset
2340
2341 For dissolving the element see LFUN_INSET_DISSOLVE.
2342 \end_layout
2343
2344 \begin_layout Description
2345 Syntax flex-insert Name
2346 \end_layout
2347
2348 \begin_layout Description
2349 Params Name:
2350  This name must be defined either in your layout file or imported by some module.
2351  The definition is InsetLayout Name or InsetLayout <Flex:Name>.
2352  The Flex:
2353  prefix is optional.
2354 \end_layout
2355
2356 \begin_layout Description
2357 Sample flex-insert Code
2358 \end_layout
2359
2360 \begin_layout Subsection*
2361 float-insert
2362 \end_layout
2363
2364 \begin_layout Description
2365 Action Inserts a float inset.
2366 \end_layout
2367
2368 \begin_layout Description
2369 Syntax float-insert <TYPE>
2370 \end_layout
2371
2372 \begin_layout Description
2373 Params <TYPE>:
2374  type of float depends on the used textclass.
2375  Usually "algorithm",
2376  "table",
2377  "figure" parameters can be given.
2378 \end_layout
2379
2380 \begin_layout Description
2381 Origin Lgb,
2382  27 Jun 2000
2383 \end_layout
2384
2385 \begin_layout Subsection*
2386 float-list-insert
2387 \end_layout
2388
2389 \begin_layout Description
2390 Action Inserts the list of floats in the document.
2391 \end_layout
2392
2393 \begin_layout Description
2394 Syntax float-list-insert <TYPE>
2395 \end_layout
2396
2397 \begin_layout Description
2398 Params <TYPE>:
2399  type of float depends on the used textclass.
2400  Usually "algorithm",
2401  "table",
2402  "figure" parameters can be given.
2403 \end_layout
2404
2405 \begin_layout Description
2406 Origin Lgb,
2407  3 May 2001
2408 \end_layout
2409
2410 \begin_layout Subsection*
2411 float-wide-insert
2412 \end_layout
2413
2414 \begin_layout Description
2415 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
2416 \end_layout
2417
2418 \begin_layout Description
2419 Notion Corresponds to the starred floats (figure*,
2420  table*,
2421  etc.) in LaTeX.
2422 \end_layout
2423
2424 \begin_layout Description
2425 Syntax float-wide-insert <TYPE>
2426 \end_layout
2427
2428 \begin_layout Description
2429 Params <TYPE>:
2430  type of float depends on the used textclass.
2431  Usually "algorithm",
2432  "table",
2433  "figure" parameters can be given.
2434 \end_layout
2435
2436 \begin_layout Description
2437 Origin Lgb,
2438  31 Oct 2001
2439 \end_layout
2440
2441 \begin_layout Subsection*
2442 footnote-insert
2443 \end_layout
2444
2445 \begin_layout Description
2446 Action Inserts a footnote inset.
2447 \end_layout
2448
2449 \begin_layout Description
2450 Syntax footnote-insert
2451 \end_layout
2452
2453 \begin_layout Description
2454 Origin Jug,
2455  7 Mar 2000
2456 \end_layout
2457
2458 \begin_layout Subsection*
2459 graphics-reload
2460 \end_layout
2461
2462 \begin_layout Description
2463 Action Reloads the image if necessary.
2464 \end_layout
2465
2466 \begin_layout Description
2467 Syntax graphics-reload
2468 \end_layout
2469
2470 \begin_layout Description
2471 Origin vfr,
2472  10 Aug 2009
2473 \end_layout
2474
2475 \begin_layout Subsection*
2476 graphics-set-group
2477 \end_layout
2478
2479 \begin_layout Description
2480 Action Set the group for the graphics inset on the cursor position.
2481 \end_layout
2482
2483 \begin_layout Description
2484 Syntax graphics-set-group [<GROUP>]
2485 \end_layout
2486
2487 \begin_layout Description
2488 Params <GROUP>:
2489  Id for an existing group.
2490  In case the Id is an empty string,
2491  the graphics inset is removed from the current group.
2492 \end_layout
2493
2494 \begin_layout Description
2495 Origin sanda,
2496  6 May 2008
2497 \end_layout
2498
2499 \begin_layout Subsection*
2500 graphics-unify
2501 \end_layout
2502
2503 \begin_layout Description
2504 Action Set the same group for all graphics insets in the marked block.
2505 \end_layout
2506
2507 \begin_layout Description
2508 Syntax graphics-unify [<GROUP>]
2509 \end_layout
2510
2511 \begin_layout Description
2512 Params <GROUP>:
2513  Id for an existing group.
2514  In case the Id is an empty string,
2515  the group Id from the first graphics inset will be used.
2516 \end_layout
2517
2518 \begin_layout Description
2519 Origin sanda,
2520  7 Feb 2018
2521 \end_layout
2522
2523 \begin_layout Subsection*
2524 href-insert
2525 \end_layout
2526
2527 \begin_layout Description
2528 Action Inserts hyperlinks into the document (clickable in pdf output).
2529 \end_layout
2530
2531 \begin_layout Description
2532 Notion Hyperlink target can be set via selection + hyperlink-insert function.
2533 \end_layout
2534
2535 \begin_layout Description
2536 Syntax href-insert [<TARGET>]
2537 \end_layout
2538
2539 \begin_layout Description
2540 Origin CFO-G,
2541  21 Nov 1997
2542 \end_layout
2543
2544 \begin_layout Subsection*
2545 in-ipa
2546 \end_layout
2547
2548 \begin_layout Description
2549 Action Only active in IPA inset.
2550 \end_layout
2551
2552 \begin_layout Description
2553 Notion Dummy function which is only active in a IPA inset.
2554  It's used to toggle the IPA toolbar if the cursor moves into an IPA inset.
2555 \end_layout
2556
2557 \begin_layout Description
2558 Syntax in-ipa
2559 \end_layout
2560
2561 \begin_layout Description
2562 Origin spitz,
2563  20 May 2012
2564 \end_layout
2565
2566 \begin_layout Subsection*
2567 index-insert
2568 \end_layout
2569
2570 \begin_layout Description
2571 Action Inserts Index entry.
2572 \end_layout
2573
2574 \begin_layout Description
2575 Notion It automatically takes the word on the cursor position.
2576 \end_layout
2577
2578 \begin_layout Description
2579 Syntax index-insert [<TYPE:Name>]
2580 \end_layout
2581
2582 \begin_layout Description
2583 Params <TYPE:Name>:
2584  name of the index,
2585  if multiple indices are defined.
2586  With an empty argument,
2587  the default index is selected.
2588 \end_layout
2589
2590 \begin_layout Description
2591 Origin leeming,
2592  3 Aug 2000
2593 \end_layout
2594
2595 \begin_layout Subsection*
2596 index-print
2597 \end_layout
2598
2599 \begin_layout Description
2600 Action Inserts list of Index entries on a new page.
2601 \end_layout
2602
2603 \begin_layout Description
2604 Syntax index-print [<TYPE:Name>]
2605 \end_layout
2606
2607 \begin_layout Description
2608 Params <TYPE:Name>:
2609  name of the index,
2610  if multiple indices are defined.
2611  With an empty argument,
2612  the default index is selected.
2613 \end_layout
2614
2615 \begin_layout Description
2616 Origin Lgb,
2617  27 Feb 1997
2618 \end_layout
2619
2620 \begin_layout Subsection*
2621 index-tag-all
2622 \end_layout
2623
2624 \begin_layout Description
2625 Action Tags all occurrences of the word before the cursor with the index inset at cursor.
2626 \end_layout
2627
2628 \begin_layout Description
2629 Notion It automatically takes the word on the cursor position.
2630 \end_layout
2631
2632 \begin_layout Description
2633 Syntax index-tag-all
2634 \end_layout
2635
2636 \begin_layout Description
2637 Origin spitz,
2638  5 Nov 2022
2639 \end_layout
2640
2641 \begin_layout Subsection*
2642 indexmacro-insert
2643 \end_layout
2644
2645 \begin_layout Description
2646 Action Inserts special Index macros into the document.
2647 \end_layout
2648
2649 \begin_layout Description
2650 Syntax indexmacro-insert <type>
2651 \end_layout
2652
2653 \begin_layout Description
2654 Params <type>:
2655  see,
2656  seealso,
2657  subentry,
2658  sortkey.
2659 \end_layout
2660
2661 \begin_layout Description
2662 Origin spitz,
2663  20 Feb 2022
2664 \end_layout
2665
2666 \begin_layout Subsection*
2667 info-insert
2668 \end_layout
2669
2670 \begin_layout Description
2671 Action Displays shortcuts,
2672  lyxrc,
2673  package and textclass availability and menu information in a non-editable boxed InsetText.
2674 \end_layout
2675
2676 \begin_layout Description
2677 Notion Apart from lfun arguments you can use the following method:
2678 \begin_inset Newline newline
2679 \end_inset
2680
2681 1.
2682  input the type and argument of this inset,
2683  e.g.
2684  "menu paste",
2685  in the work area.
2686 \begin_inset Newline newline
2687 \end_inset
2688
2689 2.
2690  select the text and run info-insert lfun.
2691 \end_layout
2692
2693 \begin_layout Description
2694 Syntax info-insert <TYPE> <ARG>
2695 \end_layout
2696
2697 \begin_layout Description
2698 Params <TYPE>:
2699  date|moddate|fixdate|time|modtime|fixtime|shortcut|shortcuts|lyxrc| lyxinfo|package|textclass|menu|l7n|icon|buffer|vcs
2700 \begin_inset Newline newline
2701 \end_inset
2702
2703 <ARG>:
2704  argument for a given type.
2705  Look into InsetInfo.h for detailed description.
2706 \begin_inset Newline newline
2707 \end_inset
2708
2709 date:
2710  current date (formatted and localized)
2711 \begin_inset Newline newline
2712 \end_inset
2713
2714 moddate:
2715  date of last modification (saving) (formatted and localized)
2716 \begin_inset Newline newline
2717 \end_inset
2718
2719 fixdate:
2720  a static date (formatted and localized)
2721 \begin_inset Newline newline
2722 \end_inset
2723
2724 time:
2725  current time (formatted and localized)
2726 \begin_inset Newline newline
2727 \end_inset
2728
2729 modtime:
2730  time of last modification (saving) (formatted and localized)
2731 \begin_inset Newline newline
2732 \end_inset
2733
2734 fixtime:
2735  a static time (formatted and localized)
2736 \begin_inset Newline newline
2737 \end_inset
2738
2739 shortcut[s]:
2740  name of lfun (e.g math-insert
2741 \backslash
2742 alpha)
2743 \begin_inset Newline newline
2744 \end_inset
2745
2746 lyxrc:
2747  name of rc_entry (e.g.
2748  bind_file)
2749 \begin_inset Newline newline
2750 \end_inset
2751
2752 lyxinfo:
2753  "version" - used version of LyX
2754 \begin_inset Newline newline
2755 \end_inset
2756
2757 package:
2758  name of latex package (e.g.
2759  listings)
2760 \begin_inset Newline newline
2761 \end_inset
2762
2763 textclass:
2764  name of textclass (e.g.
2765  article)
2766 \begin_inset Newline newline
2767 \end_inset
2768
2769 menu:
2770  name of lfun used in menu
2771 \begin_inset Newline newline
2772 \end_inset
2773
2774 l7n:
2775  localizable string.
2776 \begin_inset Newline newline
2777 \end_inset
2778
2779 icon:
2780  icon of lfun used in toolbar or direct icon name
2781 \begin_inset Newline newline
2782 \end_inset
2783
2784 buffer:
2785  "name"|"name-noext"|"path"|"class" vcs:
2786  "tree-revision"|"revision"|"author"|"date"|"time"
2787 \end_layout
2788
2789 \begin_layout Description
2790 Sample command-sequence info-insert buffer path;
2791  info-insert buffer name
2792 \end_layout
2793
2794 \begin_layout Description
2795 Origin bpeng,
2796  7 Oct 2007
2797 \end_layout
2798
2799 \begin_layout Subsection*
2800 inset-apply
2801 \end_layout
2802
2803 \begin_layout Description
2804 Action Apply data for an inset.
2805 \end_layout
2806
2807 \begin_layout Description
2808 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be applied.
2809  This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending on the context where it is called.
2810 \end_layout
2811
2812 \begin_layout Description
2813 Syntax inset-apply <ARGS>
2814 \end_layout
2815
2816 \begin_layout Description
2817 Params See LFUN_INSET_INSERT .
2818 \end_layout
2819
2820 \begin_layout Subsection*
2821 inset-begin
2822 \end_layout
2823
2824 \begin_layout Description
2825 Action Move the cursor to the beginning of the current inset if it is not already there.
2826  If the cursor is already at the beginning of the current inset,
2827  move it to the beginning of the enclosing inset or the main work area,
2828  respectively,
2829  if there is no enclosing inset.
2830 \end_layout
2831
2832 \begin_layout Description
2833 Syntax inset-begin
2834 \end_layout
2835
2836 \begin_layout Description
2837 Origin lasgouttes,
2838  16 Mar 2009
2839 \end_layout
2840
2841 \begin_layout Subsection*
2842 inset-begin-select
2843 \end_layout
2844
2845 \begin_layout Description
2846 Action Move the cursor to the beginning of the current inset if it is not already there.
2847  If the cursor is already at the beginning of the current inset,
2848  move it to the beginning of the enclosing inset or the main work area,
2849  respectively,
2850  if there is no enclosing inset (adding the traversed text to the selection).
2851 \end_layout
2852
2853 \begin_layout Description
2854 Syntax inset-begin-select
2855 \end_layout
2856
2857 \begin_layout Description
2858 Origin lasgouttes,
2859  16 Mar 2009
2860 \end_layout
2861
2862 \begin_layout Subsection*
2863 inset-copy-as
2864 \end_layout
2865
2866 \begin_layout Description
2867 Action Copies the inset to the clipboard as a certain type.
2868 \end_layout
2869
2870 \begin_layout Description
2871 Notion Currently used only for InsetInfo where its content is copied as a text.
2872 \end_layout
2873
2874 \begin_layout Description
2875 Syntax inset-copy-as
2876 \end_layout
2877
2878 \begin_layout Description
2879 Origin vfr,
2880  18 Apr 2010
2881 \end_layout
2882
2883 \begin_layout Subsection*
2884 inset-dissolve
2885 \end_layout
2886
2887 \begin_layout Description
2888 Action Dissolve the current inset into text.
2889 \end_layout
2890
2891 \begin_layout Description
2892 Syntax inset-dissolve [<INSET>]
2893 \end_layout
2894
2895 \begin_layout Description
2896 Params <INSET>:
2897  this can be used to make sure the right kind of inset is dissolved.
2898  For example "dissolve" entry in the charstyles sub-menu should only dissolve the charstyle inset,
2899  even if the cursor is inside several nested insets of different type.
2900 \begin_inset Newline newline
2901 \end_inset
2902
2903 For values see lyx::InsetLayout::lyxtype_ .
2904 \end_layout
2905
2906 \begin_layout Description
2907 Origin JSpitz,
2908  7 Aug 2006
2909 \end_layout
2910
2911 \begin_layout Subsection*
2912 inset-edit
2913 \end_layout
2914
2915 \begin_layout Description
2916 Action Edit the inset at cursor with an external application,
2917  if one is attributed.
2918  If the inset is file based,
2919  the referenced file is edited.
2920  Otherwise,
2921  the inset contents is written to a temporary file,
2922  the inset is locked,
2923  and the temporary file is edited.
2924  In this case,
2925  LFUN_INSET_END_EDIT must be called to overtake the changes and unlock the inset after editing is finished.
2926 \end_layout
2927
2928 \begin_layout Description
2929 Syntax inset-edit [nogui] [<INSET_PARAMS>]
2930 \end_layout
2931
2932 \begin_layout Description
2933 Params <INSET_PARAMS>:
2934  Parameters for the inset.
2935 \begin_inset Newline newline
2936 \end_inset
2937
2938 Currently only the filename will be considered.
2939 \begin_inset Newline newline
2940 \end_inset
2941
2942 nogui:
2943  does not launch external editor,
2944  only returns filename to be processed.
2945 \end_layout
2946
2947 \begin_layout Description
2948 Origin spitz,
2949  27 Apr 2006
2950 \end_layout
2951
2952 \begin_layout Subsection*
2953 inset-end
2954 \end_layout
2955
2956 \begin_layout Description
2957 Action Move the cursor to the end of the current inset if it is not already there.
2958  If the cursor is already at the end of the current inset,
2959  move it to the end of the enclosing inset or the main work area,
2960  respectively,
2961  if there is no enclosing inset.
2962 \end_layout
2963
2964 \begin_layout Description
2965 Syntax inset-end
2966 \end_layout
2967
2968 \begin_layout Description
2969 Origin lasgouttes,
2970  16 Mar 2009
2971 \end_layout
2972
2973 \begin_layout Subsection*
2974 inset-end-edit
2975 \end_layout
2976
2977 \begin_layout Description
2978 Action End editing the inset at cursor with an external application.
2979  This replaces the inset contents with the contents of the temporary file,
2980  deletes the file and unlocks the inset.
2981 \end_layout
2982
2983 \begin_layout Description
2984 Syntax inset-end-edit
2985 \end_layout
2986
2987 \begin_layout Description
2988 Origin gb,
2989  11 Oct 2015
2990 \end_layout
2991
2992 \begin_layout Subsection*
2993 inset-end-select
2994 \end_layout
2995
2996 \begin_layout Description
2997 Action Move the cursor to the end of the current inset if it is not already there.
2998  If the cursor is already at the end of the current inset,
2999  move it to the end of the enclosing inset or the main work area,
3000  respectively,
3001  if there is no enclosing inset (adding the traversed text to the selection).
3002 \end_layout
3003
3004 \begin_layout Description
3005 Syntax inset-end-select
3006 \end_layout
3007
3008 \begin_layout Description
3009 Origin lasgouttes,
3010  16 Mar 2009
3011 \end_layout
3012
3013 \begin_layout Subsection*
3014 inset-forall
3015 \end_layout
3016
3017 \begin_layout Description
3018 Action Apply the given commands on insets of a given name.
3019 \end_layout
3020
3021 \begin_layout Description
3022 Notion WARNING:
3023  use at your own risks;
3024  this function gives you too many ways of shooting yourself in the foot.
3025  A typical example is inset-forall Note note-insert which starts an infinite loop.
3026  This is mitigated by the fact that the number of actions is arbitrarily limited to 100000.
3027  Note also that inset-forall does not update metrics between iterations,
3028  which can lead to bugs.
3029  This has to be eventually fixed.
3030 \end_layout
3031
3032 \begin_layout Description
3033 Syntax inset-forall <NAME> <LFUN-COMMAND>
3034 \begin_inset Newline newline
3035 \end_inset
3036
3037 <NAME>:
3038  Type of Inset.
3039  If <NAME> is *,
3040  all insets are matched.
3041  The name is used like for InsetLayout in layout files:
3042  "Note" matches all note insets,
3043  while "Note:Note" only matches LyX yellow note insets.
3044 \end_layout
3045
3046 \begin_layout Description
3047 Sample Remove all index insets:
3048 \begin_inset Newline newline
3049 \end_inset
3050
3051 inset-forall Index char-delete-forward
3052 \begin_inset Newline newline
3053 \end_inset
3054
3055 Close all Notes:
3056 \begin_inset Newline newline
3057 \end_inset
3058
3059 inset-forall Note inset-toggle close
3060 \begin_inset Newline newline
3061 \end_inset
3062
3063 Open all branch insets of branch "myBranch":
3064 \begin_inset Newline newline
3065 \end_inset
3066
3067 inset-forall Branch:myBranch inset-toggle open
3068 \begin_inset Newline newline
3069 \end_inset
3070
3071 Transform all yellow notes to comments
3072 \begin_inset Newline newline
3073 \end_inset
3074
3075 inset-forall Note:Note inset-modify note Note Comment
3076 \begin_inset Newline newline
3077 \end_inset
3078
3079 Try to put LyX in an infinite loop if there is at least a Note:
3080 \begin_inset Newline newline
3081 \end_inset
3082
3083 inset-forall Note char-backward
3084 \end_layout
3085
3086 \begin_layout Description
3087 Origin lasgouttes,
3088  27 Nov 2009
3089 \end_layout
3090
3091 \begin_layout Subsection*
3092 inset-insert
3093 \end_layout
3094
3095 \begin_layout Description
3096 Action Insert new inset (type given by the parameters).
3097 \end_layout
3098
3099 \begin_layout Description
3100 Syntax inset-insert <INSET> <ARGS>
3101 \end_layout
3102
3103 \begin_layout Description
3104 Params <INSET>:
3105  <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
3106 \begin_inset Newline newline
3107 \end_inset
3108
3109 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
3110 \begin_inset Newline newline
3111 \end_inset
3112
3113 <ARGS>:
3114  depends on the given inset.
3115  Use "lyx -dbg action" to explore.
3116 \end_layout
3117
3118 \begin_layout Description
3119 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
3120 \backslash
3121 end_inset
3122 \begin_inset Newline newline
3123 \end_inset
3124
3125 where <label name> is the name of the referenced label and <Format> is one of the following:
3126 \begin_inset Newline newline
3127 \end_inset
3128
3129 ref -- <reference>
3130 \begin_inset Newline newline
3131 \end_inset
3132
3133 eqref -- (<reference>)
3134 \begin_inset Newline newline
3135 \end_inset
3136
3137 pageref -- <page>
3138 \begin_inset Newline newline
3139 \end_inset
3140
3141 vpageref -- on <page>
3142 \begin_inset Newline newline
3143 \end_inset
3144
3145 vref -- <reference> on <page>
3146 \begin_inset Newline newline
3147 \end_inset
3148
3149 formatted -- Formatted reference
3150 \end_layout
3151
3152 \begin_layout Subsection*
3153 inset-insert-copy
3154 \end_layout
3155
3156 \begin_layout Description
3157 Action Inserts the inset's content (in ToC pane) at the position of the cursor.
3158 \end_layout
3159
3160 \begin_layout Description
3161 Syntax inset-insert-copy
3162 \end_layout
3163
3164 \begin_layout Description
3165 Origin spitz,
3166  1 Nov 2022
3167 \end_layout
3168
3169 \begin_layout Subsection*
3170 inset-modify
3171 \end_layout
3172
3173 \begin_layout Description
3174 Action Modify some properties of an inset.
3175 \end_layout
3176
3177 \begin_layout Description
3178 Notion Used for argument,
3179  bibitem,
3180  bibtex,
3181  box,
3182  branch,
3183  caption,
3184  citation,
3185  command,
3186  ert,
3187  external,
3188  float,
3189  graphics,
3190  include,
3191  index,
3192  info,
3193  label,
3194  line,
3195  listings,
3196  newline,
3197  newpage,
3198  nomencl,
3199  note,
3200  phantom,
3201  quotes,
3202  ref,
3203  script,
3204  separator,
3205  space,
3206  tabular,
3207  vspace and wrap insets.
3208 \end_layout
3209
3210 \begin_layout Description
3211 Syntax inset-modify <INSET> <ARGS>
3212 \begin_inset Newline newline
3213 \end_inset
3214
3215 inset-modify changetype <TYPE>
3216 \end_layout
3217
3218 \begin_layout Description
3219 Sample Change a Note inset into a Comment inset:
3220 \begin_inset Newline newline
3221 \end_inset
3222
3223 inset-modify note Note Comment
3224 \begin_inset Newline newline
3225 \end_inset
3226
3227 Change a Box into an Ovalbox:
3228 \begin_inset Newline newline
3229 \end_inset
3230
3231 inset-modify changetype Ovalbox
3232 \begin_inset Newline newline
3233 \end_inset
3234
3235 Change a quotation mark to e[nglish style],
3236  l[eft side = opening],
3237  s[ingle = inner,
3238  secondary]
3239 \begin_inset Newline newline
3240 \end_inset
3241
3242 inset-modify changetype els
3243 \begin_inset Newline newline
3244 \end_inset
3245
3246 Change only the style of a quotation mark,
3247  maintaining the other aspects (.
3248  = wildcard)
3249 \begin_inset Newline newline
3250 \end_inset
3251
3252 inset-modify changetype e..
3253 \begin_inset Newline newline
3254 \end_inset
3255
3256
3257 \end_layout
3258
3259 \begin_layout Subsection*
3260 inset-select-all
3261 \end_layout
3262
3263 \begin_layout Description
3264 Action Select all contents of an inset.
3265 \end_layout
3266
3267 \begin_layout Description
3268 Notion There are 3 successive levels:
3269  select current cell,
3270  select all cells of inset,
3271  select the inset from outside (in the enclosing inset).
3272 \end_layout
3273
3274 \begin_layout Description
3275 Syntax inset-select-all
3276 \end_layout
3277
3278 \begin_layout Description
3279 Origin vfr,
3280  22 Aug 2009;
3281  lasgouttes 1 Nov 2014
3282 \end_layout
3283
3284 \begin_layout Subsection*
3285 inset-settings
3286 \end_layout
3287
3288 \begin_layout Description
3289 Action Open the inset's properties dialog.
3290 \end_layout
3291
3292 \begin_layout Description
3293 Notion Used for bibitem,
3294  bibtex,
3295  box,
3296  branch,
3297  citation,
3298  ert,
3299  external,
3300  float,
3301  graphics,
3302  href,
3303  include,
3304  index,
3305  index_print,
3306  label,
3307  line,
3308  listings,
3309  note,
3310  phantom,
3311  ref,
3312  space,
3313  tabular,
3314  vspace,
3315  wrap insets.
3316 \end_layout
3317
3318 \begin_layout Description
3319 Syntax inset-settings <INSET>
3320 \end_layout
3321
3322 \begin_layout Description
3323 Params <INSET>:
3324  <bibitem|bibtex|box|branch|citation|ert|external|float|
3325 \begin_inset Newline newline
3326 \end_inset
3327
3328 graphics|href|include|index|index_print|label|line|
3329 \begin_inset Newline newline
3330 \end_inset
3331
3332 listings|note|phantom|ref|space|tabular|vspace|wrap>.
3333 \end_layout
3334
3335 \begin_layout Subsection*
3336 inset-split
3337 \end_layout
3338
3339 \begin_layout Description
3340 Action Splits the current inset into two at current position.
3341 \end_layout
3342
3343 \begin_layout Description
3344 Syntax inset-split [<INSET>]
3345 \end_layout
3346
3347 \begin_layout Description
3348 Params <INSET>:
3349  this can be used to make sure the right kind of inset is dissolved.
3350  For example "split" entry in the charstyles sub-menu should only dissolve the charstyle inset,
3351  even if the cursor is inside several nested insets of different type.
3352 \begin_inset Newline newline
3353 \end_inset
3354
3355 For values see lyx::InsetLayout::lyxtype_ .
3356 \end_layout
3357
3358 \begin_layout Description
3359 Origin spitz,
3360  22 Dec 2020
3361 \end_layout
3362
3363 \begin_layout Subsection*
3364 inset-toggle
3365 \end_layout
3366
3367 \begin_layout Description
3368 Action Toggles the collapsible inset at cursor position,
3369  or the inset we are currently in.
3370 \end_layout
3371
3372 \begin_layout Description
3373 Syntax inset-toggle [<ARG>]
3374 \end_layout
3375
3376 \begin_layout Description
3377 Params <ARG>:
3378  <open|close|toggle|assign>.
3379 \begin_inset Newline newline
3380 \end_inset
3381
3382 open/close/toggle are for collapsible insets.
3383  toggle is used when no argument is given.
3384 \begin_inset Newline newline
3385 \end_inset
3386
3387 assign synchronize the branch-inset with activation status of the branch.
3388  Used for global toggling when changed activation.
3389 \end_layout
3390
3391 \begin_layout Description
3392 Origin lasgouttes,
3393  19 Jul 2001
3394 \end_layout
3395
3396 \begin_layout Subsection*
3397 ipa-insert
3398 \end_layout
3399
3400 \begin_layout Description
3401 Action Inserts an IPA inset.
3402 \end_layout
3403
3404 \begin_layout Description
3405 Syntax ipa-insert
3406 \end_layout
3407
3408 \begin_layout Description
3409 Origin spitz,
3410  05 Mar 2012
3411 \end_layout
3412
3413 \begin_layout Subsection*
3414 ipamacro-insert
3415 \end_layout
3416
3417 \begin_layout Description
3418 Action Inserts special IPA macros into the document.
3419 \end_layout
3420
3421 \begin_layout Description
3422 Syntax ipamacro-insert <CHAR>
3423 \end_layout
3424
3425 \begin_layout Description
3426 Params <CHAR>:
3427  tone-falling,
3428  tone-rising,
3429  tone-high-rising,
3430  tone-low-rising,
3431  tone-high-rising-falling,
3432  deco bottomtiebar,
3433  deco toptiebar.
3434 \end_layout
3435
3436 \begin_layout Description
3437 Origin spitz,
3438  22 Aug 2012
3439 \end_layout
3440
3441 \begin_layout Subsection*
3442 keymap-off
3443 \end_layout
3444
3445 \begin_layout Description
3446 Action Turn off the loaded keyboard map.
3447 \end_layout
3448
3449 \begin_layout Description
3450 Syntax keymap-off
3451 \end_layout
3452
3453 \begin_layout Subsection*
3454 keymap-primary
3455 \end_layout
3456
3457 \begin_layout Description
3458 Action Turn on the primary keyboard map.
3459 \end_layout
3460
3461 \begin_layout Description
3462 Notion Maps were widely used in past,
3463  when X-windows didn't have nowadays keyboard support.
3464  They can be still used to maintain uniform keyboard layout across the various platforms.
3465 \begin_inset Newline newline
3466 \end_inset
3467
3468 The language is to be set in the Preferences dialog.
3469 \end_layout
3470
3471 \begin_layout Description
3472 Syntax keymap-primary
3473 \end_layout
3474
3475 \begin_layout Subsection*
3476 keymap-secondary
3477 \end_layout
3478
3479 \begin_layout Description
3480 Action Turn on the secondary keyboard map.
3481 \end_layout
3482
3483 \begin_layout Description
3484 Syntax keymap-secondary
3485 \end_layout
3486
3487 \begin_layout Subsection*
3488 keymap-toggle
3489 \end_layout
3490
3491 \begin_layout Description
3492 Action Toggles keyboard maps (first/second/off).
3493 \end_layout
3494
3495 \begin_layout Description
3496 Syntax keymap-toggle
3497 \end_layout
3498
3499 \begin_layout Description
3500 Origin leeming,
3501  30 Mar 2004
3502 \end_layout
3503
3504 \begin_layout Subsection*
3505 label-copy-as-reference
3506 \end_layout
3507
3508 \begin_layout Description
3509 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3510 \end_layout
3511
3512 \begin_layout Description
3513 Syntax copy-label-as-reference <LABEL>
3514 \end_layout
3515
3516 \begin_layout Description
3517 Params <LABEL>:
3518  The label to copy (for multi-line math)
3519 \end_layout
3520
3521 \begin_layout Description
3522 Origin sts,
3523  16 Nov 2008
3524 \end_layout
3525
3526 \begin_layout Subsection*
3527 label-goto
3528 \end_layout
3529
3530 \begin_layout Description
3531 Action Goto a label.
3532 \end_layout
3533
3534 \begin_layout Description
3535 Syntax label-goto [<LABEL>]
3536 \end_layout
3537
3538 \begin_layout Description
3539 Params <LABEL>:
3540  Requested label.
3541  If no label is given and reference is on cursor position,
3542  Bookmark 0 is saved and cursor moves to the position of referenced label.
3543 \end_layout
3544
3545 \begin_layout Description
3546 Origin Ale,
3547  6 Aug 1997
3548 \end_layout
3549
3550 \begin_layout Subsection*
3551 label-insert
3552 \end_layout
3553
3554 \begin_layout Description
3555 Action Inserts label to text or displayed formula.
3556 \end_layout
3557
3558 \begin_layout Description
3559 Syntax label-insert [<LABEL>]
3560 \end_layout
3561
3562 \begin_layout Description
3563 Params <LABEL>:
3564  Requested label.
3565  If no label is given dialog requesting name will be opened.
3566 \end_layout
3567
3568 \begin_layout Subsection*
3569 label-insert-as-reference
3570 \end_layout
3571
3572 \begin_layout Description
3573 Action Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
3574 \end_layout
3575
3576 \begin_layout Description
3577 Syntax label-insert-as-reference
3578 \end_layout
3579
3580 \begin_layout Description
3581 Origin vfr,
3582  7 Apr 2009
3583 \end_layout
3584
3585 \begin_layout Subsection*
3586 language
3587 \end_layout
3588
3589 \begin_layout Description
3590 Action Set language from the current cursor position.
3591 \end_layout
3592
3593 \begin_layout Description
3594 Syntax language <LANG> [set]
3595 \end_layout
3596
3597 \begin_layout Description
3598 Params <LANG>:
3599  Requested language.
3600  Look in lib/languages for the list.
3601  "language reset" or "language" (without param) reset to the document language.
3602  set:
3603  If used,
3604  the language will be set to the specified language.
3605  Otherwise,
3606  the language will be toggled (i.e.,
3607  if the current language is LANG,
3608  switch to the document language or the default language,
3609  if LANG is the document language).
3610 \end_layout
3611
3612 \begin_layout Description
3613 Origin Dekel,
3614  2 Mar 2000
3615 \end_layout
3616
3617 \begin_layout Subsection*
3618 line-begin
3619 \end_layout
3620
3621 \begin_layout Description
3622 Action Move the cursor to the beginning of the (screen) line.
3623 \end_layout
3624
3625 \begin_layout Description
3626 Syntax line-begin
3627 \end_layout
3628
3629 \begin_layout Subsection*
3630 line-begin-select
3631 \end_layout
3632
3633 \begin_layout Description
3634 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
3635 \end_layout
3636
3637 \begin_layout Description
3638 Syntax line-begin-select
3639 \end_layout
3640
3641 \begin_layout Subsection*
3642 line-delete-forward
3643 \end_layout
3644
3645 \begin_layout Description
3646 Action Deletes the letters to the end of the (screen) line or deletes the selection.
3647 \end_layout
3648
3649 \begin_layout Description
3650 Syntax line-delete-forward
3651 \end_layout
3652
3653 \begin_layout Subsection*
3654 line-end
3655 \end_layout
3656
3657 \begin_layout Description
3658 Action Move the cursor to the end of the (screen) line.
3659 \end_layout
3660
3661 \begin_layout Description
3662 Syntax line-end
3663 \end_layout
3664
3665 \begin_layout Subsection*
3666 line-end-select
3667 \end_layout
3668
3669 \begin_layout Description
3670 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
3671 \end_layout
3672
3673 \begin_layout Description
3674 Syntax line-end-select
3675 \end_layout
3676
3677 \begin_layout Subsection*
3678 listing-insert
3679 \end_layout
3680
3681 \begin_layout Description
3682 Action Inserts a new listings inset.
3683 \end_layout
3684
3685 \begin_layout Description
3686 Syntax listing-insert
3687 \end_layout
3688
3689 \begin_layout Description
3690 Origin Herbert,
3691  10 Nov 2001;
3692  bpeng,
3693  2 May 2007
3694 \end_layout
3695
3696 \begin_layout Subsection*
3697 marginalnote-insert
3698 \end_layout
3699
3700 \begin_layout Description
3701 Action Inserts a marginal note.
3702 \end_layout
3703
3704 \begin_layout Description
3705 Syntax marginalnote-insert
3706 \end_layout
3707
3708 \begin_layout Description
3709 Origin Lgb,
3710  26 Jun 2000
3711 \end_layout
3712
3713 \begin_layout Subsection*
3714 mark-off
3715 \end_layout
3716
3717 \begin_layout Description
3718 Action Disable selecting of text-region.
3719 \end_layout
3720
3721 \begin_layout Description
3722 Syntax mark-off
3723 \end_layout
3724
3725 \begin_layout Subsection*
3726 mark-on
3727 \end_layout
3728
3729 \begin_layout Description
3730 Action Enable selecting of text-region.
3731 \end_layout
3732
3733 \begin_layout Description
3734 Notion After enabling you can simply move arrow keys to get selected region.
3735 \end_layout
3736
3737 \begin_layout Description
3738 Syntax mark-on
3739 \end_layout
3740
3741 \begin_layout Subsection*
3742 mark-toggle
3743 \end_layout
3744
3745 \begin_layout Description
3746 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
3747 \end_layout
3748
3749 \begin_layout Description
3750 Syntax mark-toggle
3751 \end_layout
3752
3753 \begin_layout Description
3754 Origin Andre,
3755  May 5 2006
3756 \end_layout
3757
3758 \begin_layout Subsection*
3759 newline-insert
3760 \end_layout
3761
3762 \begin_layout Description
3763 Action Inserts a line break or new line.
3764 \end_layout
3765
3766 \begin_layout Description
3767 Syntax newline-insert [<ARG>]
3768 \end_layout
3769
3770 \begin_layout Description
3771 Params <ARG>:
3772  <newline|linebreak> default:
3773  newline
3774 \end_layout
3775
3776 \begin_layout Description
3777 Origin spitz,
3778  25 Mar 2008
3779 \end_layout
3780
3781 \begin_layout Subsection*
3782 newpage-insert
3783 \end_layout
3784
3785 \begin_layout Description
3786 Action Inserts a new page.
3787 \end_layout
3788
3789 \begin_layout Description
3790 Syntax newpage-insert <ARG>
3791 \end_layout
3792
3793 \begin_layout Description
3794 Params <ARG>:
3795  <newpage|pagebreak|clearpage|cleardoublepage> default:
3796  newpage
3797 \end_layout
3798
3799 \begin_layout Description
3800 Origin uwestoehr,
3801  24 Nov 2007
3802 \end_layout
3803
3804 \begin_layout Subsection*
3805 nomencl-insert
3806 \end_layout
3807
3808 \begin_layout Description
3809 Action Inserts Nomenclature entry.
3810 \end_layout
3811
3812 \begin_layout Description
3813 Notion It automatically takes the word on the cursor position if no symbol is given.
3814 \end_layout
3815
3816 \begin_layout Description
3817 Syntax nomencl-insert [<SYMBOL>]
3818 \end_layout
3819
3820 \begin_layout Description
3821 Origin Ugras,
3822  4 Nov 2006
3823 \end_layout
3824
3825 \begin_layout Subsection*
3826 nomencl-print
3827 \end_layout
3828
3829 \begin_layout Description
3830 Action Inserts list of Nomenclature entries.
3831 \end_layout
3832
3833 \begin_layout Description
3834 Syntax nomenclature-print
3835 \end_layout
3836
3837 \begin_layout Description
3838 Origin Ugras,
3839  4 Nov 2006
3840 \end_layout
3841
3842 \begin_layout Subsection*
3843 note-insert
3844 \end_layout
3845
3846 \begin_layout Description
3847 Action Inserts Note on the current cursor position,
3848  move selection inside the inset.
3849 \end_layout
3850
3851 \begin_layout Description
3852 Syntax note-insert [<TYPE>]
3853 \end_layout
3854
3855 \begin_layout Description
3856 Params <TYPE>:
3857  <Note|Greyedout|Comment> default:
3858  Note
3859 \end_layout
3860
3861 \begin_layout Subsection*
3862 note-next
3863 \end_layout
3864
3865 \begin_layout Description
3866 Action Moves the cursor to the beginning of next Note inset.
3867 \end_layout
3868
3869 \begin_layout Description
3870 Syntax note-next
3871 \end_layout
3872
3873 \begin_layout Subsection*
3874 outline-down
3875 \end_layout
3876
3877 \begin_layout Description
3878 Action Move the current group in the downward direction in the structure of the document.
3879 \end_layout
3880
3881 \begin_layout Description
3882 Notion The "group" can be Part/Chapter/Section/etc.
3883  It moves the whole substructure of the group.
3884 \end_layout
3885
3886 \begin_layout Description
3887 Syntax outline-down
3888 \end_layout
3889
3890 \begin_layout Description
3891 Origin Vermeer,
3892  23 Mar 2006
3893 \end_layout
3894
3895 \begin_layout Subsection*
3896 outline-in
3897 \end_layout
3898
3899 \begin_layout Description
3900 Action Moves the current group in the downward direction in the hierarchy of the document structure.
3901 \end_layout
3902
3903 \begin_layout Description
3904 Notion Part -> Chapter -> Section -> etc.
3905 \end_layout
3906
3907 \begin_layout Description
3908 Syntax outline-in [local]
3909 \end_layout
3910
3911 \begin_layout Description
3912 Params local:
3913  if given,
3914  only the current paragraph will be affected.
3915 \end_layout
3916
3917 \begin_layout Description
3918 Origin Vermeer,
3919  23 Mar 2006
3920 \end_layout
3921
3922 \begin_layout Subsection*
3923 outline-out
3924 \end_layout
3925
3926 \begin_layout Description
3927 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3928 \end_layout
3929
3930 \begin_layout Description
3931 Notion Part <- Chapter <- Section <- etc.
3932 \end_layout
3933
3934 \begin_layout Description
3935 Syntax outline-out [local]
3936 \end_layout
3937
3938 \begin_layout Description
3939 Params local:
3940  if given,
3941  only the current paragraph will be affected.
3942 \end_layout
3943
3944 \begin_layout Description
3945 Origin Vermeer,
3946  23 Mar 2006
3947 \end_layout
3948
3949 \begin_layout Subsection*
3950 outline-up
3951 \end_layout
3952
3953 \begin_layout Description
3954 Action Move the current group in the upward direction in the structure of the document.
3955 \end_layout
3956
3957 \begin_layout Description
3958 Notion The "group" can be Part/Chapter/Section/etc.
3959  It moves the whole substructure of the group.
3960 \end_layout
3961
3962 \begin_layout Description
3963 Syntax outline-up
3964 \end_layout
3965
3966 \begin_layout Description
3967 Origin Vermeer,
3968  23 Mar 2006
3969 \end_layout
3970
3971 \begin_layout Subsection*
3972 paragraph-break
3973 \end_layout
3974
3975 \begin_layout Description
3976 Action Breaks the current paragraph at the current location.
3977 \end_layout
3978
3979 \begin_layout Description
3980 Notion Removes the selection.
3981 \end_layout
3982
3983 \begin_layout Description
3984 Syntax paragraph-break [<LAYOUT>] [ignoresep]
3985 \end_layout
3986
3987 \begin_layout Description
3988 Params <LAYOUT>:
3989  "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
3990 \begin_inset Newline newline
3991 \end_inset
3992
3993 ignoresep:
3994  Do not account for paragraph separators while breaking.
3995 \end_layout
3996
3997 \begin_layout Subsection*
3998 paragraph-down
3999 \end_layout
4000
4001 \begin_layout Description
4002 Action Move the cursor to the next paragraph (or beginning of the current one) in downward direction.
4003 \end_layout
4004
4005 \begin_layout Description
4006 Syntax paragraph-down
4007 \end_layout
4008
4009 \begin_layout Description
4010 Origin Asger,
4011  1 Oct 1996
4012 \end_layout
4013
4014 \begin_layout Subsection*
4015 paragraph-down-select
4016 \end_layout
4017
4018 \begin_layout Description
4019 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in downward direction.
4020 \end_layout
4021
4022 \begin_layout Description
4023 Syntax paragraph-down-select
4024 \end_layout
4025
4026 \begin_layout Description
4027 Origin Asger,
4028  1 Oct 1996
4029 \end_layout
4030
4031 \begin_layout Subsection*
4032 paragraph-goto
4033 \end_layout
4034
4035 \begin_layout Description
4036 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
4037  If given four arguments id_start,
4038  pos_start,
4039  id_end,
4040  pos_end,
4041  perform a selection from start to end.
4042 \end_layout
4043
4044 \begin_layout Description
4045 Notion Note that id number of paragraph is not the sequential number of paragraph seen on the screen.
4046  Moreover the id is unique for all opened buffers (documents).
4047  Both ids must belong to the same buffer.
4048 \end_layout
4049
4050 \begin_layout Description
4051 Syntax paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
4052 \end_layout
4053
4054 \begin_layout Description
4055 Params <PAR_ID>:
4056   paragraph id
4057 \begin_inset Newline newline
4058 \end_inset
4059
4060 <POS_IN_PAR>:
4061  desired position within the paragraph
4062 \end_layout
4063
4064 \begin_layout Description
4065 Origin Dekel,
4066  26 Aug 2000 gmunch,
4067  5 Sep 2016
4068 \end_layout
4069
4070 \begin_layout Subsection*
4071 paragraph-move-down
4072 \end_layout
4073
4074 \begin_layout Description
4075 Action Moves the current paragraph downwards in the document.
4076 \end_layout
4077
4078 \begin_layout Description
4079 Syntax paragraph-move-down
4080 \end_layout
4081
4082 \begin_layout Description
4083 Origin Edwin,
4084  8 Apr 2006
4085 \end_layout
4086
4087 \begin_layout Subsection*
4088 paragraph-move-up
4089 \end_layout
4090
4091 \begin_layout Description
4092 Action Moves the current paragraph upwards in the document.
4093 \end_layout
4094
4095 \begin_layout Description
4096 Notion Movement through the document will possibly break the paragraph-depth (e.g.
4097  itemize structure).
4098 \end_layout
4099
4100 \begin_layout Description
4101 Syntax paragraph-move-up
4102 \end_layout
4103
4104 \begin_layout Description
4105 Origin Edwin,
4106  8 Apr 2006
4107 \end_layout
4108
4109 \begin_layout Subsection*
4110 paragraph-params
4111 \end_layout
4112
4113 \begin_layout Description
4114 Action Change paragraph settings.
4115 \end_layout
4116
4117 \begin_layout Description
4118 Notion Modifies the current paragraph,
4119  or currently selected paragraphs.
4120  This function only modifies,
4121  and does not override,
4122  existing settings.
4123  Note that the "leftindent" indent setting is deprecated.
4124 \end_layout
4125
4126 \begin_layout Description
4127 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
4128 \end_layout
4129
4130 \begin_layout Description
4131 Params <INDENT>:
4132
4133 \backslash
4134 noindent|
4135 \backslash
4136 indent|
4137 \backslash
4138 indent-toggle|
4139 \backslash
4140 leftindent LENGTH
4141 \begin_inset Newline newline
4142 \end_inset
4143
4144 <SPACING>:
4145
4146 \backslash
4147 paragraph_spacing default|single|onehalf|double|other SIZE
4148 \begin_inset Newline newline
4149 \end_inset
4150
4151 <ALIGN>:
4152
4153 \backslash
4154 align block|left|right|center|default
4155 \begin_inset Newline newline
4156 \end_inset
4157
4158 <OTHERS>:
4159
4160 \backslash
4161 labelwidthstring WIDTH|
4162 \backslash
4163 start_of_appendix
4164 \end_layout
4165
4166 \begin_layout Description
4167 Origin rgh,
4168  Aug 15 2007
4169 \end_layout
4170
4171 \begin_layout Subsection*
4172 paragraph-params-apply
4173 \end_layout
4174
4175 \begin_layout Description
4176 Action Change paragraph settings.
4177 \end_layout
4178
4179 \begin_layout Description
4180 Notion Overwrite all nonspecified settings to the default ones.
4181  Use paragraph-params lfun if you don't want to overwrite others settings.
4182 \end_layout
4183
4184 \begin_layout Description
4185 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
4186 \end_layout
4187
4188 \begin_layout Description
4189 Params For parameters see LFUN_PARAGRAPH_PARAMS
4190 \end_layout
4191
4192 \begin_layout Description
4193 Origin leeming,
4194  30 Mar 2004
4195 \end_layout
4196
4197 \begin_layout Subsection*
4198 paragraph-select
4199 \end_layout
4200
4201 \begin_layout Description
4202 Action Move cursor to beginning of current paragraph and select to the end in downward direction
4203 \end_layout
4204
4205 \begin_layout Description
4206 Notion This function is by default bound to triple mouse click
4207 \end_layout
4208
4209 \begin_layout Description
4210 Syntax paragraph-select
4211 \end_layout
4212
4213 \begin_layout Description
4214 Origin Kornel,
4215  16 Apr 2019
4216 \end_layout
4217
4218 \begin_layout Subsection*
4219 paragraph-up
4220 \end_layout
4221
4222 \begin_layout Description
4223 Action Move the cursor to the next paragraph (or beginning of the current one) in upward direction.
4224 \end_layout
4225
4226 \begin_layout Description
4227 Syntax paragraph-up
4228 \end_layout
4229
4230 \begin_layout Description
4231 Origin Asger,
4232  1 Oct 1996
4233 \end_layout
4234
4235 \begin_layout Subsection*
4236 paragraph-up-select
4237 \end_layout
4238
4239 \begin_layout Description
4240 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in upward direction.
4241 \end_layout
4242
4243 \begin_layout Description
4244 Syntax paragraph-up-select
4245 \end_layout
4246
4247 \begin_layout Description
4248 Origin Asger,
4249  1 Oct 1996
4250 \end_layout
4251
4252 \begin_layout Subsection*
4253 paste
4254 \end_layout
4255
4256 \begin_layout Description
4257 Action Pastes material (text or picture) from the active clipboard.
4258 \end_layout
4259
4260 \begin_layout Description
4261 Syntax paste [<TYPE>|<NUM>]
4262 \end_layout
4263
4264 \begin_layout Description
4265 Params <TYPE>:
4266  emf|pdf|png|jpeg|linkback|wmf|latex|html
4267 \begin_inset Newline newline
4268 \end_inset
4269
4270 <NUM>:
4271  number of the selection in the internal clipboard stack to be pasted.
4272 \end_layout
4273
4274 \begin_layout Subsection*
4275 phantom-insert
4276 \end_layout
4277
4278 \begin_layout Description
4279 Action Inserts phantom on the current cursor position,
4280  move selection inside the inset.
4281 \end_layout
4282
4283 \begin_layout Description
4284 Syntax phantom-insert [<TYPE>]
4285 \end_layout
4286
4287 \begin_layout Description
4288 Params <TYPE>:
4289  <Phantom|HPhantom|VPhantom> default:
4290  Phantom
4291 \end_layout
4292
4293 \begin_layout Description
4294 Origin uwestoehr,
4295  30 Jan 2009
4296 \end_layout
4297
4298 \begin_layout Subsection*
4299 preview-insert
4300 \end_layout
4301
4302 \begin_layout Description
4303 Action Inserts a new preview inset.
4304 \end_layout
4305
4306 \begin_layout Description
4307 Syntax preview-insert
4308 \end_layout
4309
4310 \begin_layout Description
4311 Origin vfr,
4312  28 Mar 2010
4313 \end_layout
4314
4315 \begin_layout Subsection*
4316 primary-selection-paste
4317 \end_layout
4318
4319 \begin_layout Description
4320 Action Pastes the currently selected text.
4321 \end_layout
4322
4323 \begin_layout Description
4324 Notion Primary selection mechanism is X11/Wayland-only thing.
4325 \end_layout
4326
4327 \begin_layout Description
4328 Syntax primary-selection-paste [<ARG>]
4329 \end_layout
4330
4331 \begin_layout Description
4332 Params <ARG>:
4333  "paragraph" will cause pasting as one paragraph,
4334  i.e.
4335  "Join lines".
4336 \end_layout
4337
4338 \begin_layout Subsection*
4339 quote-insert
4340 \end_layout
4341
4342 \begin_layout Description
4343 Action Inserts quotes according to the type and quote-language preference.
4344 \end_layout
4345
4346 \begin_layout Description
4347 Notion Currently 15 different quote styles are distinguished (see params).
4348 \end_layout
4349
4350 \begin_layout Description
4351 Syntax quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
4352 \end_layout
4353
4354 \begin_layout Description
4355 Params <LEVEL>:
4356  'inner' for (i.e.,
4357  secondary,
4358  usually single) quotes,
4359  otherwise outer (i.e.,
4360  primary,
4361  usually double) quotes will be used.
4362 \begin_inset Newline newline
4363 \end_inset
4364
4365 <SIDE>:
4366   'opening' for opening quotes,
4367  'closing' for closing quotes,
4368  otherwise the side will be guessed from the context.
4369
4370 \change_inserted -584632292 1712005910
4371  Use `auto' to force this default.
4372  (You will need to give this argument if you also want to give <STYLE>.)
4373 \change_unchanged
4374
4375 \begin_inset Newline newline
4376 \end_inset
4377
4378 <STYLE>:
4379  'british' for `British' quote style (with ``inner quotation'')
4380 \begin_inset Newline newline
4381 \end_inset
4382
4383 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks
4384 \begin_inset Newline newline
4385 \end_inset
4386
4387 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks
4388 \begin_inset Newline newline
4389 \end_inset
4390
4391 'danish' for >>Danish<< quote style (with >inner quotation<)
4392 \begin_inset Newline newline
4393 \end_inset
4394
4395 'english' for ``English'' quote style (with `inner quotation')
4396 \begin_inset Newline newline
4397 \end_inset
4398
4399 'french' for <<french>> quote style (with ``inner quotation'')
4400 \begin_inset Newline newline
4401 \end_inset
4402
4403 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]
4404 \begin_inset Newline newline
4405 \end_inset
4406
4407 'german' for ,,German`` quote style (with ,inner quotation`)
4408 \begin_inset Newline newline
4409 \end_inset
4410
4411                         'hebrew' for ''hebrew,,
4412  quote style (with 'inner quotation,)
4413 \begin_inset Newline newline
4414 \end_inset
4415
4416 'plain' for "Plain" quote style (with 'inner quotation')
4417 \begin_inset Newline newline
4418 \end_inset
4419
4420 'polish' for ,,Polish'' quote style (with ,inner quotation')
4421 \begin_inset Newline newline
4422 \end_inset
4423
4424 'swedish' for ''Swedish'' quote style (with 'inner quotation')
4425 \begin_inset Newline newline
4426 \end_inset
4427
4428 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]
4429 \begin_inset Newline newline
4430 \end_inset
4431
4432 'swiss' for <<Swiss>> quote style (with <inner quotation>)
4433 \begin_inset Newline newline
4434 \end_inset
4435
4436 'russian' for <<Russian>> quote style (with ,,inner quotation``)
4437 \begin_inset Newline newline
4438 \end_inset
4439
4440 'dynamic' for Dynamic quotation marks which inherit the global document style
4441 \begin_inset Newline newline
4442 \end_inset
4443
4444 If no quote style is specified,
4445  the document-wide will be used.
4446 \end_layout
4447
4448 \begin_layout Subsection*
4449 redo
4450 \end_layout
4451
4452 \begin_layout Description
4453 Action Redoes the last thing undone.
4454 \end_layout
4455
4456 \begin_layout Description
4457 Syntax redo
4458 \end_layout
4459
4460 \begin_layout Subsection*
4461 reference-next
4462 \end_layout
4463
4464 \begin_layout Description
4465 Action Go to the next label or cross-reference.
4466 \end_layout
4467
4468 \begin_layout Description
4469 Syntax reference-next
4470 \end_layout
4471
4472 \begin_layout Description
4473 Origin Dekel,
4474  14 Jan 2001
4475 \end_layout
4476
4477 \begin_layout Subsection*
4478 repeat
4479 \end_layout
4480
4481 \begin_layout Description
4482 Action Repeat the given command.
4483 \end_layout
4484
4485 \begin_layout Description
4486 Notion fails when the repeat count is greater than 10000.
4487 \end_layout
4488
4489 \begin_layout Description
4490 Syntax repeat <COUNT> <LFUN-COMMAND>
4491 \end_layout
4492
4493 \begin_layout Description
4494 Origin Andre,
4495  27 Oct 2003
4496 \end_layout
4497
4498 \begin_layout Subsection*
4499 screen-down
4500 \end_layout
4501
4502 \begin_layout Description
4503 Action Moves the cursor one page in downward direction.
4504 \end_layout
4505
4506 \begin_layout Description
4507 Syntax screen-down
4508 \end_layout
4509
4510 \begin_layout Subsection*
4511 screen-down-select
4512 \end_layout
4513
4514 \begin_layout Description
4515 Action Moves the cursor one screen in downward direction adding the current position to the selection.
4516 \end_layout
4517
4518 \begin_layout Description
4519 Syntax screen-down-select
4520 \end_layout
4521
4522 \begin_layout Subsection*
4523 screen-recenter
4524 \end_layout
4525
4526 \begin_layout Description
4527 Action Recenters the screen on the current cursor position.
4528 \end_layout
4529
4530 \begin_layout Description
4531 Syntax screen-recenter
4532 \end_layout
4533
4534 \begin_layout Subsection*
4535 screen-show-cursor
4536 \end_layout
4537
4538 \begin_layout Description
4539 Action Repositions the screen such that the cursor is visible.
4540 \end_layout
4541
4542 \begin_layout Description
4543 Syntax screen-show-cursor
4544 \end_layout
4545
4546 \begin_layout Description
4547 Origin vfr,
4548  25 Mar 2009
4549 \end_layout
4550
4551 \begin_layout Subsection*
4552 screen-up
4553 \end_layout
4554
4555 \begin_layout Description
4556 Action Moves the cursor one page in upward direction.
4557 \end_layout
4558
4559 \begin_layout Description
4560 Syntax screen-up
4561 \end_layout
4562
4563 \begin_layout Subsection*
4564 screen-up-select
4565 \end_layout
4566
4567 \begin_layout Description
4568 Action Moves the cursor one page in upward direction adding the current position to the selection.
4569 \end_layout
4570
4571 \begin_layout Description
4572 Syntax screen-up-select
4573 \end_layout
4574
4575 \begin_layout Subsection*
4576 script-insert
4577 \end_layout
4578
4579 \begin_layout Description
4580 Action Inserts a subscript or superscript inset.
4581 \end_layout
4582
4583 \begin_layout Description
4584 Syntax script-insert <TYPE>
4585 \end_layout
4586
4587 \begin_layout Description
4588 Params <TYPE>:
4589  subscript|superscript
4590 \end_layout
4591
4592 \begin_layout Description
4593 Origin Georg,
4594  23 Nov 2010
4595 \end_layout
4596
4597 \begin_layout Subsection*
4598 scroll
4599 \end_layout
4600
4601 \begin_layout Description
4602 Action Scroll the buffer view.
4603 \end_layout
4604
4605 \begin_layout Description
4606 Notion Only scrolls the screen up or down;
4607  does not move the cursor.
4608 \end_layout
4609
4610 \begin_layout Description
4611 Syntax scroll <TYPE> <QUANTITY>
4612 \end_layout
4613
4614 \begin_layout Description
4615 Params <TYPE>:
4616   line|page
4617 \begin_inset Newline newline
4618 \end_inset
4619
4620 <QUANTITY>:
4621  up|down|<number>
4622 \end_layout
4623
4624 \begin_layout Description
4625 Origin Abdel,
4626  Dec 27 2007
4627 \end_layout
4628
4629 \begin_layout Subsection*
4630 search-string-set
4631 \end_layout
4632
4633 \begin_layout Description
4634 Action Set search string buffer.
4635 \end_layout
4636
4637 \begin_layout Description
4638 Syntax search-string-set [<DATA>]
4639 \end_layout
4640
4641 \begin_layout Description
4642 Params <DATA>:
4643  string to search for.
4644  If no parameter is given,
4645  use (word under) selection.
4646 \end_layout
4647
4648 \begin_layout Description
4649 Origin stwitt,
4650  spitz,
4651  Feb 12 2021
4652 \end_layout
4653
4654 \begin_layout Subsection*
4655 section-select
4656 \end_layout
4657
4658 \begin_layout Description
4659 Action Select the whole section.
4660 \end_layout
4661
4662 \begin_layout Description
4663 Notion The cursor should be in a section heading before calling this lfun.
4664 \end_layout
4665
4666 \begin_layout Description
4667 Syntax section-select
4668 \end_layout
4669
4670 \begin_layout Description
4671 Origin vfr,
4672  05 May 2009
4673 \end_layout
4674
4675 \begin_layout Subsection*
4676 selection-paste
4677 \end_layout
4678
4679 \begin_layout Description
4680 Action Pastes the internal selection text in permanent selection.
4681 \end_layout
4682
4683 \begin_layout Description
4684 Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ;
4685  primary-selection-paste paragraph).
4686 \end_layout
4687
4688 \begin_layout Description
4689 Syntax selection-paste
4690 \end_layout
4691
4692 \begin_layout Description
4693 Origin lasgouttes,
4694  14 Jan 2009
4695 \end_layout
4696
4697 \begin_layout Subsection*
4698 separator-insert
4699 \end_layout
4700
4701 \begin_layout Description
4702 Action Inserts an environment separator or latex paragraph break.
4703 \end_layout
4704
4705 \begin_layout Description
4706 Syntax separator-insert [<ARG>]
4707 \end_layout
4708
4709 \begin_layout Description
4710 Params <ARG>:
4711  <plain|parbreak|latexpar> default:
4712  plain
4713 \end_layout
4714
4715 \begin_layout Description
4716 Origin ef,
4717  2 May 2014
4718 \end_layout
4719
4720 \begin_layout Subsection*
4721 space-insert
4722 \end_layout
4723
4724 \begin_layout Description
4725 Action Inserts one of horizontal space insets.
4726 \end_layout
4727
4728 \begin_layout Description
4729 Syntax space-insert <NAME> [<LEN>]
4730 \end_layout
4731
4732 \begin_layout Description
4733 Params <NAME>:
4734  normal,
4735  protected,
4736  visible,
4737  thin,
4738  quad,
4739  qquad,
4740  enspace,
4741  enskip,
4742  negthinspace,
4743  negmedspace,
4744  negthickspace,
4745  hfill,
4746  hfill*,
4747  dotfill,
4748  hrulefill,
4749  hspace,
4750  hspace*
4751 \begin_inset Newline newline
4752 \end_inset
4753
4754 Only in math mode:
4755  med and thick.
4756 \begin_inset Newline newline
4757 \end_inset
4758
4759 <LEN>:
4760  length for custom spaces (hspace,
4761  hspace* for protected)
4762 \end_layout
4763
4764 \begin_layout Description
4765 Origin spitz,
4766  20 May 2003,
4767  Mar 17 2008
4768 \end_layout
4769
4770 \begin_layout Subsection*
4771 specialchar-insert
4772 \end_layout
4773
4774 \begin_layout Description
4775 Action Inserts various characters into the document.
4776 \end_layout
4777
4778 \begin_layout Description
4779 Syntax specialchar-insert <CHAR>
4780 \end_layout
4781
4782 \begin_layout Description
4783 Params <CHAR>:
4784  hyphenation,
4785  allowbreak,
4786  ligature-break,
4787  slash,
4788  nobreakdash,
4789  dots,
4790  end-of-sentence,
4791  menu-separator,
4792  lyx,
4793  tex,
4794  latex,
4795  latex2e.
4796 \end_layout
4797
4798 \begin_layout Description
4799 Origin spitz,
4800  6 Dec 2007
4801 \end_layout
4802
4803 \begin_layout Subsection*
4804 spelling-add
4805 \end_layout
4806
4807 \begin_layout Description
4808 Action Add the word under the cursor to the respective spell checker dictionary.
4809  The default for the language is retrieved from the cursor position.
4810 \end_layout
4811
4812 \begin_layout Description
4813 Syntax spelling-add [<STRING>] [<LANG>]
4814 \end_layout
4815
4816 \begin_layout Description
4817 Params <WORD>:
4818  word to add
4819 \begin_inset Newline newline
4820 \end_inset
4821
4822 <LANG>:
4823  language name (see file languages)
4824 \end_layout
4825
4826 \begin_layout Description
4827 Origin spitz,
4828  18 Jan 2010
4829 \end_layout
4830
4831 \begin_layout Subsection*
4832 spelling-add-local
4833 \end_layout
4834
4835 \begin_layout Description
4836 Action Add the word under the cursor to the document's local spell checker dictionary.
4837  The default for the language is retrieved from the cursor position.
4838 \end_layout
4839
4840 \begin_layout Description
4841 Syntax spelling-add-local [<STRING>] [<LANG>]
4842 \end_layout
4843
4844 \begin_layout Description
4845 Params <WORD>:
4846  word to add
4847 \begin_inset Newline newline
4848 \end_inset
4849
4850 <LANG>:
4851  language name (see file languages)
4852 \end_layout
4853
4854 \begin_layout Description
4855 Origin spitz,
4856  6 Mar 2021
4857 \end_layout
4858
4859 \begin_layout Subsection*
4860 spelling-continuously
4861 \end_layout
4862
4863 \begin_layout Description
4864 Action Toggle continuous spell checking.
4865 \end_layout
4866
4867 \begin_layout Description
4868 Syntax spelling-continuously
4869 \end_layout
4870
4871 \begin_layout Description
4872 Origin vfr,
4873  24 March 2013
4874 \end_layout
4875
4876 \begin_layout Subsection*
4877 spelling-ignore
4878 \end_layout
4879
4880 \begin_layout Description
4881 Action Let the spell checker ignore the word under the cursor in the current session for the given language.
4882  The default for the language is retrieved from the cursor position.
4883 \end_layout
4884
4885 \begin_layout Description
4886 Syntax spelling-ignore [<WORD>] [<LANG>]
4887 \end_layout
4888
4889 \begin_layout Description
4890 Params <WORD>:
4891  word to ignore
4892 \begin_inset Newline newline
4893 \end_inset
4894
4895 <LANG>:
4896  language name (see file languages)
4897 \end_layout
4898
4899 \begin_layout Description
4900 Origin spitz,
4901  18 Jan 2010
4902 \end_layout
4903
4904 \begin_layout Subsection*
4905 spelling-remove
4906 \end_layout
4907
4908 \begin_layout Description
4909 Action Remove the word under the cursor from the respective spell checker dictionary.
4910  The default for the language is retrieved from the cursor position.
4911 \end_layout
4912
4913 \begin_layout Description
4914 Syntax spelling-remove [<STRING>] [<LANG>]
4915 \end_layout
4916
4917 \begin_layout Description
4918 Params <WORD>:
4919  word to remove
4920 \begin_inset Newline newline
4921 \end_inset
4922
4923 <LANG>:
4924  language name (see file languages)
4925 \end_layout
4926
4927 \begin_layout Description
4928 Origin SWitt,
4929  28 July 2010
4930 \end_layout
4931
4932 \begin_layout Subsection*
4933 spelling-remove-local
4934 \end_layout
4935
4936 \begin_layout Description
4937 Action Remove the word under the cursor from the document's local spell checker dictionary.
4938  The default for the language is retrieved from the cursor position.
4939 \end_layout
4940
4941 \begin_layout Description
4942 Syntax spelling-remove-local [<STRING>] [<LANG>]
4943 \end_layout
4944
4945 \begin_layout Description
4946 Params <WORD>:
4947  word to remove
4948 \begin_inset Newline newline
4949 \end_inset
4950
4951 <LANG>:
4952  language name (see file languages)
4953 \end_layout
4954
4955 \begin_layout Description
4956 Origin spitz,
4957  7 Mar 2021
4958 \end_layout
4959
4960 \begin_layout Subsection*
4961 tab-delete
4962 \end_layout
4963
4964 \begin_layout Description
4965 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
4966 \end_layout
4967
4968 \begin_layout Description
4969 Notion It also works on a selection - it removes a tab or spaces from the beginning of each line spanned by the selection.
4970  This is useful if you want to indent/unindent multiple lines in one action.
4971 \end_layout
4972
4973 \begin_layout Description
4974 Syntax tab-delete
4975 \end_layout
4976
4977 \begin_layout Description
4978 Origin vfr,
4979  Sep 30 2008
4980 \end_layout
4981
4982 \begin_layout Subsection*
4983 tab-insert
4984 \end_layout
4985
4986 \begin_layout Description
4987 Action Insert a tab into a listings inset.
4988 \end_layout
4989
4990 \begin_layout Description
4991 Notion It also works on a selection.
4992 \end_layout
4993
4994 \begin_layout Description
4995 Syntax tab-insert
4996 \end_layout
4997
4998 \begin_layout Description
4999 Origin vfr,
5000  Sep 30 2008
5001 \end_layout
5002
5003 \begin_layout Subsection*
5004 tabular-feature
5005 \end_layout
5006
5007 \begin_layout Description
5008 Action Modify properties of tabulars and table-like math environments.
5009 \end_layout
5010
5011 \begin_layout Description
5012 Syntax tabular-feature <FEATURE> [<ARG>]
5013 \end_layout
5014
5015 \begin_layout Description
5016 Params Generally see LFUN_INSET_INSERT for further details.
5017 \begin_inset Newline newline
5018 \end_inset
5019
5020 <FEATURE>:
5021  append-row|append-column|delete-row|delete-column|copy-row|
5022 \begin_inset Newline newline
5023 \end_inset
5024
5025 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
5026 \begin_inset Newline newline
5027 \end_inset
5028
5029 set-line-top|set-line-bottom|set-line-left|set-line-right|
5030 \begin_inset Newline newline
5031 \end_inset
5032
5033 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
5034 \begin_inset Newline newline
5035 \end_inset
5036
5037 set-ltrim-top|set-rtrim-top|set-ltrim-bottom|set-rtrim-bottom
5038 \begin_inset Newline newline
5039 \end_inset
5040
5041 toggle-ltrim-top|toggle-rtrim-top|toggle-ltrim-bottom|toggle-rtrim-bottom
5042 \begin_inset Newline newline
5043 \end_inset
5044
5045 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
5046 \begin_inset Newline newline
5047 \end_inset
5048
5049 valign-top|valign-bottom|valign-middle|longtabular-align-left|
5050 \begin_inset Newline newline
5051 \end_inset
5052
5053 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
5054 \begin_inset Newline newline
5055 \end_inset
5056
5057 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
5058 \begin_inset Newline newline
5059 \end_inset
5060
5061 reset-formal-default|set-all-lines|toggle-all-lines|unset-all-lines|
5062 \begin_inset Newline newline
5063 \end_inset
5064
5065 toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|
5066 \begin_inset Newline newline
5067 \end_inset
5068
5069 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
5070 \begin_inset Newline newline
5071 \end_inset
5072
5073 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
5074 \begin_inset Newline newline
5075 \end_inset
5076
5077 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
5078 \begin_inset Newline newline
5079 \end_inset
5080
5081 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
5082 \begin_inset Newline newline
5083 \end_inset
5084
5085 set-special-column|set-special-multicolumn|set-special-multirow|
5086 \begin_inset Newline newline
5087 \end_inset
5088
5089 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
5090 \begin_inset Newline newline
5091 \end_inset
5092
5093 set-interline-space|tabular-valign-top|tabular-valign-middle|
5094 \begin_inset Newline newline
5095 \end_inset
5096
5097 tabular-valign-bottom|set-tabular-width|toggle-varwidth-column|
5098 \begin_inset Newline newline
5099 \end_inset
5100
5101 set-border-lines|toggle-border-lines|set-inner-lines|toggle-inner-lines Various math-environment features are handled as well,
5102  e.g.
5103  add-vline-left/right for
5104 \begin_inset Newline newline
5105 \end_inset
5106
5107 the Grid/Array environment.
5108 \begin_inset Newline newline
5109 \end_inset
5110
5111 <ARG>:
5112  additional argument for some commands,
5113  use debug mode to explore its values.
5114 \end_layout
5115
5116 \begin_layout Description
5117 Origin gm,
5118  10 Dec 2015
5119 \end_layout
5120
5121 \begin_layout Subsection*
5122 tabular-insert
5123 \end_layout
5124
5125 \begin_layout Description
5126 Action Inserts table into the document.
5127 \end_layout
5128
5129 \begin_layout Description
5130 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
5131 \end_layout
5132
5133 \begin_layout Description
5134 Syntax tabular-insert [<ROWS> <COLUMNS>]
5135 \end_layout
5136
5137 \begin_layout Description
5138 Params In case no arguments are given show insert dialog.
5139 \end_layout
5140
5141 \begin_layout Description
5142 Origin Jug,
5143  12 Apr 2000
5144 \end_layout
5145
5146 \begin_layout Subsection*
5147 tabular-style-insert
5148 \end_layout
5149
5150 \begin_layout Description
5151 Action Inserts table of a given style into the document.
5152 \end_layout
5153
5154 \begin_layout Description
5155 Notion See LFUN_TABULAR_FEATURE for some more details          about tabular modifications.
5156 \end_layout
5157
5158 \begin_layout Description
5159 Syntax tabular-style-insert <style> <ROWS> <COLUMNS>
5160 \end_layout
5161
5162 \begin_layout Description
5163 Params Valid styles are the names of the files in lib/tabletemplates,
5164  minus _1x<n> and .lyx suffix.
5165 \end_layout
5166
5167 \begin_layout Description
5168 Origin spitz,
5169  25 Mar 2019
5170 \end_layout
5171
5172 \begin_layout Subsection*
5173 thesaurus-entry
5174 \end_layout
5175
5176 \begin_layout Description
5177 Action Look up thesaurus entries with respect to the word under the cursor.
5178 \end_layout
5179
5180 \begin_layout Description
5181 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
5182 \end_layout
5183
5184 \begin_layout Description
5185 Params <STRING>:
5186  word to look up
5187 \begin_inset Newline newline
5188 \end_inset
5189
5190 <LANG>:
5191  language (see file languages)
5192 \end_layout
5193
5194 \begin_layout Description
5195 Origin Levon,
5196  20 Jul 2001
5197 \end_layout
5198
5199 \begin_layout Subsection*
5200 undo
5201 \end_layout
5202
5203 \begin_layout Description
5204 Action Undoes the last edit.
5205 \end_layout
5206
5207 \begin_layout Description
5208 Syntax undo
5209 \end_layout
5210
5211 \begin_layout Subsection*
5212 unicode-insert
5213 \end_layout
5214
5215 \begin_layout Description
5216 Action Inserts a single unicode character.
5217 \end_layout
5218
5219 \begin_layout Description
5220 Syntax unicode-insert <CHAR1> <CHAR2> ...
5221 \end_layout
5222
5223 \begin_layout Description
5224 Params <CHARn>:
5225  The character to insert,
5226  given as its code point,
5227  in hexadecimal.
5228 \end_layout
5229
5230 \begin_layout Description
5231 Sample unicode-insert 0x0100 0x0259
5232 \end_layout
5233
5234 \begin_layout Description
5235 Origin Lgb,
5236  22 Oct 2006
5237 \end_layout
5238
5239 \begin_layout Subsection*
5240 up
5241 \end_layout
5242
5243 \begin_layout Description
5244 Action Moves the cursor one line in upward direction.
5245 \end_layout
5246
5247 \begin_layout Description
5248 Syntax up
5249 \end_layout
5250
5251 \begin_layout Subsection*
5252 up-select
5253 \end_layout
5254
5255 \begin_layout Description
5256 Action Moves the cursor one line in upward direction adding the current position to the selection.
5257 \end_layout
5258
5259 \begin_layout Description
5260 Syntax up-select
5261 \end_layout
5262
5263 \begin_layout Subsection*
5264 word-backward
5265 \end_layout
5266
5267 \begin_layout Description
5268 Action Moves the cursor to the logically previous beginning of a word.
5269 \end_layout
5270
5271 \begin_layout Description
5272 Notion This is not the action which should be bound to the arrow keys,
5273  because backwards may be left or right,
5274  depending on the language.
5275  The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
5276  which in turn may employ this one.
5277 \end_layout
5278
5279 \begin_layout Description
5280 Syntax word-backward
5281 \end_layout
5282
5283 \begin_layout Subsection*
5284 word-backward-select
5285 \end_layout
5286
5287 \begin_layout Description
5288 Action Moves the cursor to the logically previous beginning of a word,
5289  adding the logically traversed text to the selection.
5290 \end_layout
5291
5292 \begin_layout Description
5293 Notion See also LFUN_WORD_BACKWARD.
5294 \end_layout
5295
5296 \begin_layout Description
5297 Syntax word-backward-select
5298 \end_layout
5299
5300 \begin_layout Subsection*
5301 word-capitalize
5302 \end_layout
5303
5304 \begin_layout Description
5305 Action Capitalizes the words in the selection (i.e.
5306  the first letters) or the first letter of word at cursor position.
5307 \end_layout
5308
5309 \begin_layout Description
5310 Syntax word-capitalize [<SEL_TYPE>]
5311 \end_layout
5312
5313 \begin_layout Description
5314 Params <SEL_TYPE>:
5315  if this is equal to "partial",
5316  then the default word starts at cursor position (emacs-style).
5317  Otherwise,
5318  the whole word is considered.
5319 \end_layout
5320
5321 \begin_layout Subsection*
5322 word-delete-backward
5323 \end_layout
5324
5325 \begin_layout Description
5326 Action Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
5327 \end_layout
5328
5329 \begin_layout Description
5330 Syntax word-delete-backward [confirm]
5331 \end_layout
5332
5333 \begin_layout Description
5334 Params confirm:
5335  Select big insets,
5336  do not directly delete them.
5337 \end_layout
5338
5339 \begin_layout Subsection*
5340 word-delete-forward
5341 \end_layout
5342
5343 \begin_layout Description
5344 Action Deletes characters to the end of the word (usually the "C+Delete" key).
5345 \end_layout
5346
5347 \begin_layout Description
5348 Syntax word-delete-forward [confirm]
5349 \end_layout
5350
5351 \begin_layout Description
5352 Params confirm:
5353  Select big insets,
5354  do not directly delete them.
5355 \end_layout
5356
5357 \begin_layout Subsection*
5358 word-find
5359 \end_layout
5360
5361 \begin_layout Description
5362 Action Search for next occurrence of a string.
5363 \end_layout
5364
5365 \begin_layout Description
5366 Syntax word-find [<DATA>]
5367 \end_layout
5368
5369 \begin_layout Description
5370 Params <DATA>:
5371  data encoded from Find dialog (see lyx::find2string()).
5372  If no parameter is given,
5373  search with last find-dialog data is used for search (i.e.
5374  find-next).
5375 \end_layout
5376
5377 \begin_layout Description
5378 Origin Andre,
5379  Jan 7 2004
5380 \end_layout
5381
5382 \begin_layout Subsection*
5383 word-find-backward
5384 \end_layout
5385
5386 \begin_layout Description
5387 Action Search for a given string in backward direction.
5388 \end_layout
5389
5390 \begin_layout Description
5391 Notion Case sensitive,
5392  match words.
5393  If no argument given,
5394  last search repeated.
5395 \end_layout
5396
5397 \begin_layout Description
5398 Syntax word-find-backward [<STRING>]
5399 \end_layout
5400
5401 \begin_layout Description
5402 Origin Etienne,
5403  20 Feb 1998
5404 \end_layout
5405
5406 \begin_layout Subsection*
5407 word-find-forward
5408 \end_layout
5409
5410 \begin_layout Description
5411 Action Search for a given string in forward direction.
5412 \end_layout
5413
5414 \begin_layout Description
5415 Notion Case sensitive,
5416  match words.
5417  If no argument given,
5418  last search repeated.
5419 \end_layout
5420
5421 \begin_layout Description
5422 Syntax word-find-forward [<STRING>]
5423 \end_layout
5424
5425 \begin_layout Description
5426 Origin Etienne,
5427  16 Feb 1998
5428 \end_layout
5429
5430 \begin_layout Subsection*
5431 word-findadv
5432 \end_layout
5433
5434 \begin_layout Description
5435 Action Search for next occurrence of a pattern.
5436 \end_layout
5437
5438 \begin_layout Description
5439 Syntax word-findadv [<DATA>]
5440 \end_layout
5441
5442 \begin_layout Description
5443 Params <DATA>:
5444  data encoded from FindAdv dialog (see lyx::findadv2string()).
5445  If no parameter is given,
5446  search with last find-dialog data is used for search (i.e.
5447  find-next).
5448 \end_layout
5449
5450 \begin_layout Description
5451 Origin Tommaso,
5452  Nov 15 2007
5453 \end_layout
5454
5455 \begin_layout Subsection*
5456 word-forward
5457 \end_layout
5458
5459 \begin_layout Description
5460 Action Moves the cursor to the logically next beginning of a word.
5461 \end_layout
5462
5463 \begin_layout Description
5464 Notion This is not the action which should be bound to the arrow keys,
5465  because forward may be left or right,
5466  depending on the language.
5467  The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
5468  which in turn may employ this one.
5469 \end_layout
5470
5471 \begin_layout Description
5472 Syntax word-forward
5473 \end_layout
5474
5475 \begin_layout Subsection*
5476 word-forward-select
5477 \end_layout
5478
5479 \begin_layout Description
5480 Action Moves the cursor to the logically next beginning of a word,
5481  adding the logically traversed text to the selection.
5482 \end_layout
5483
5484 \begin_layout Description
5485 Notion See also LFUN_WORD_FORWARD.
5486 \end_layout
5487
5488 \begin_layout Description
5489 Syntax word-forward-select
5490 \end_layout
5491
5492 \begin_layout Subsection*
5493 word-left
5494 \end_layout
5495
5496 \begin_layout Description
5497 Action Moves the cursor to the next beginning of a word "on the left".
5498 \end_layout
5499
5500 \begin_layout Description
5501 Notion This is the action which should be taken when the (e.g.,
5502  ctrl-) "left" key is pressed.
5503  Generally,
5504  it moves the cursor to the next beginning of a word on the left.
5505  However,
5506  in Bidi text this become slightly more complicated,
5507  and there are different modes of cursor movement.
5508  In "visual mode",
5509  this moves left,
5510  plain and simple.
5511  In "logical mode",
5512  movement is logically forward in RTL paragraphs,
5513  and logically backwards in LTR paragraphs.
5514 \end_layout
5515
5516 \begin_layout Description
5517 Syntax word-left
5518 \end_layout
5519
5520 \begin_layout Description
5521 Origin dov,
5522  28 Oct 2007
5523 \end_layout
5524
5525 \begin_layout Subsection*
5526 word-left-select
5527 \end_layout
5528
5529 \begin_layout Description
5530 Action Moves the cursor to the next beginning of a word "on the left",
5531  adding *logically* traversed text to the selection.
5532 \end_layout
5533
5534 \begin_layout Description
5535 Notion See also LFUN_WORD_LEFT for exact details of the movement.
5536 \end_layout
5537
5538 \begin_layout Description
5539 Syntax word-left-select
5540 \end_layout
5541
5542 \begin_layout Description
5543 Origin dov,
5544  28 Oct 2007
5545 \end_layout
5546
5547 \begin_layout Subsection*
5548 word-lowcase
5549 \end_layout
5550
5551 \begin_layout Description
5552 Action Change the words in the selection or word at cursor position to lower case.
5553 \end_layout
5554
5555 \begin_layout Description
5556 Syntax word-lowcase [<SEL_TYPE>]
5557 \end_layout
5558
5559 \begin_layout Description
5560 Params <SEL_TYPE>:
5561  if this is equal to "partial",
5562  then the default word starts at cursor position (emacs-style).
5563  Otherwise,
5564  the whole word is considered.
5565 \end_layout
5566
5567 \begin_layout Subsection*
5568 word-replace
5569 \end_layout
5570
5571 \begin_layout Description
5572 Action Replace a string in the document.
5573 \end_layout
5574
5575 \begin_layout Description
5576 Syntax word-replace [<DATA>]
5577 \end_layout
5578
5579 \begin_layout Description
5580 Params <DATA>:
5581  data is of the form "<replacestring>
5582 \begin_inset Newline newline
5583 \end_inset
5584
5585 <searchstring>
5586 \begin_inset Newline newline
5587 \end_inset
5588
5589 <casesensitive> <matchword> <all> <forward> <findnext>"
5590 \end_layout
5591
5592 \begin_layout Description
5593 Origin Andre,
5594  Jan 7 2004
5595 \end_layout
5596
5597 \begin_layout Subsection*
5598 word-right
5599 \end_layout
5600
5601 \begin_layout Description
5602 Action Moves the cursor to the next beginning of a word "on the right".
5603 \end_layout
5604
5605 \begin_layout Description
5606 Notion This is the action which should be taken when the (e.g.,
5607  ctrl-) "right" key is pressed.
5608  Generally,
5609  it moves the cursor to the next beginning of a word on the right.
5610  However,
5611  in Bidi text this become slightly more complicated,
5612  and there are different modes of cursor movement.
5613  In "visual mode",
5614  this moves right,
5615  plain and simple.
5616  In "logical mode",
5617  movement is logically forward in LTR paragraphs,
5618  and logically backwards in RTL paragraphs.
5619 \end_layout
5620
5621 \begin_layout Description
5622 Syntax word-right
5623 \end_layout
5624
5625 \begin_layout Description
5626 Origin dov,
5627  28 Oct 2007
5628 \end_layout
5629
5630 \begin_layout Subsection*
5631 word-right-select
5632 \end_layout
5633
5634 \begin_layout Description
5635 Action Moves the cursor to the next beginning of a word "on the right",
5636  adding *logically* traversed text to the selection.
5637 \end_layout
5638
5639 \begin_layout Description
5640 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
5641 \end_layout
5642
5643 \begin_layout Description
5644 Syntax word-right-select
5645 \end_layout
5646
5647 \begin_layout Description
5648 Origin dov,
5649  28 Oct 2007
5650 \end_layout
5651
5652 \begin_layout Subsection*
5653 word-select
5654 \end_layout
5655
5656 \begin_layout Description
5657 Action Puts the word where the cursor stands into the selection.
5658 \end_layout
5659
5660 \begin_layout Description
5661 Syntax word-select
5662 \end_layout
5663
5664 \begin_layout Description
5665 Origin Andre,
5666  11 Sep 2002
5667 \end_layout
5668
5669 \begin_layout Subsection*
5670 word-upcase
5671 \end_layout
5672
5673 \begin_layout Description
5674 Action Change the words in the selection or word at cursor position to upper case.
5675 \end_layout
5676
5677 \begin_layout Description
5678 Syntax word-upcase [<SEL_TYPE>]
5679 \end_layout
5680
5681 \begin_layout Description
5682 Params <SEL_TYPE>:
5683  if this is equal to "partial",
5684  then the default word starts at cursor position (emacs-style).
5685  Otherwise,
5686  the whole word is considered.
5687 \end_layout
5688
5689 \begin_layout Subsection*
5690 wrap-insert
5691 \end_layout
5692
5693 \begin_layout Description
5694 Action Inserts floats wrapped by the text around.
5695 \end_layout
5696
5697 \begin_layout Description
5698 Syntax wrap-insert <TYPE>
5699 \end_layout
5700
5701 \begin_layout Description
5702 Params <TYPE>:
5703  table|figure
5704 \end_layout
5705
5706 \begin_layout Description
5707 Origin Dekel,
5708  7 Apr 2002
5709 \end_layout
5710
5711 \begin_layout Section
5712 Math Editor Functions
5713 \end_layout
5714
5715 \begin_layout Subsection*
5716 in-mathmacrotemplate
5717 \end_layout
5718
5719 \begin_layout Description
5720 Action Only active in Math Macro definition.
5721 \end_layout
5722
5723 \begin_layout Description
5724 Notion Dummy function which is only active in a Math Macro definition.
5725  It's used to toggle the Math Macro toolbar if the cursor moves into a Math Macro definition.
5726 \end_layout
5727
5728 \begin_layout Description
5729 Syntax in-mathmacrotemplate
5730 \end_layout
5731
5732 \begin_layout Description
5733 Origin sts,
5734  06 January 2008
5735 \end_layout
5736
5737 \begin_layout Subsection*
5738 math-ams-matrix
5739 \end_layout
5740
5741 \begin_layout Description
5742 Action Inserts an extended matrix as provided by the amsmath package.
5743 \end_layout
5744
5745 \begin_layout Description
5746 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
5747 \end_layout
5748
5749 \begin_layout Description
5750 Params <DECORATION>:
5751  Decoration determines the LaTeX name of the matrix that should be created.
5752  Possible values include pmatrix,
5753  bmatrix,
5754  Bmatrix,
5755  vmatrix,
5756  Vmatrix,
5757  smallmatrix,
5758  and matrix.
5759  The default is 'matrix'.
5760 \end_layout
5761
5762 \begin_layout Description
5763 Sample math-ams-matrix 3 3 bmatrix
5764 \end_layout
5765
5766 \begin_layout Subsection*
5767 math-bigdelim
5768 \end_layout
5769
5770 \begin_layout Description
5771 Action Inserts math fixed size delimiters (e.g.
5772  parentheses,
5773  brackets) enclosing expression.
5774 \end_layout
5775
5776 \begin_layout Description
5777 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
5778 \end_layout
5779
5780 \begin_layout Description
5781 Params <L/RSIZE>:
5782  bigl/r|Bigl/r|biggl/r|Biggl/r
5783 \begin_inset Newline newline
5784 \end_inset
5785
5786 <L/RDELIM>:
5787  TeX code for delimiter.
5788  See Delimiter dialog for delimiters to be used.
5789 \end_layout
5790
5791 \begin_layout Description
5792 Sample math-bigdelim "Bigl" "
5793 \backslash
5794 Downarrow" "Bigr" "
5795 \backslash
5796 }"
5797 \end_layout
5798
5799 \begin_layout Description
5800 Origin Enrico & Georg,
5801  7 May 2006
5802 \end_layout
5803
5804 \begin_layout Subsection*
5805 math-delim
5806 \end_layout
5807
5808 \begin_layout Description
5809 Action Inserts math delimiters (e.g.
5810  parentheses,
5811  brackets) enclosing expression.
5812 \end_layout
5813
5814 \begin_layout Description
5815 Syntax math-delim [<LEFT>] [<RIGHT>]
5816 \end_layout
5817
5818 \begin_layout Description
5819 Params <LEFT/RIGHT>:
5820  Delimiters to be used.
5821  Each delimiter can be specified by either a LaTeX name or a valid character.
5822  ( is the default letter.
5823 \end_layout
5824
5825 \begin_layout Description
5826 Sample math-delim { rangle
5827 \end_layout
5828
5829 \begin_layout Description
5830 Origin Alejandro,
5831  18 Jun 1996
5832 \end_layout
5833
5834 \begin_layout Subsection*
5835 math-display
5836 \end_layout
5837
5838 \begin_layout Description
5839 Action Creates a new displayed equation in text mode.
5840  Toggles inlined/display formula in math mode.
5841 \end_layout
5842
5843 \begin_layout Description
5844 Syntax math-display [<ARG>]
5845 \end_layout
5846
5847 \begin_layout Description
5848 Params <ARG>:
5849  this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
5850 \end_layout
5851
5852 \begin_layout Description
5853 Origin Alejandro,
5854  18 Jun 1996
5855 \end_layout
5856
5857 \begin_layout Subsection*
5858 math-extern
5859 \end_layout
5860
5861 \begin_layout Description
5862 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
5863 \end_layout
5864
5865 \begin_layout Description
5866 Notion Selection can be used to determine the input for the external program.
5867 \end_layout
5868
5869 \begin_layout Description
5870 Syntax math-extern <LANG> [<COMMAND>]
5871 \end_layout
5872
5873 \begin_layout Description
5874 Params <LANG>:
5875  octave|maxima|maple|mathematica|script
5876 \begin_inset Newline newline
5877 \end_inset
5878
5879 where "script" stands for the external script (normalized expression will be passed)
5880 \end_layout
5881
5882 \begin_layout Description
5883 Sample math-extern maple simplify
5884 \end_layout
5885
5886 \begin_layout Description
5887 Origin Andre,
5888  24 Apr 2001
5889 \end_layout
5890
5891 \begin_layout Subsection*
5892 math-font-style
5893 \end_layout
5894
5895 \begin_layout Description
5896 Action Changes the text style used in math.
5897 \end_layout
5898
5899 \begin_layout Description
5900 Syntax math-font-style <STYLE>
5901 \end_layout
5902
5903 \begin_layout Description
5904 Params <STYLE>:
5905  mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
5906 \begin_inset Newline newline
5907 \end_inset
5908
5909 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
5910 \end_layout
5911
5912 \begin_layout Description
5913 Origin vfr,
5914  9 jan 2009
5915 \end_layout
5916
5917 \begin_layout Subsection*
5918 math-insert
5919 \end_layout
5920
5921 \begin_layout Description
5922 Action Inserts math objects and symbols.
5923 \end_layout
5924
5925 \begin_layout Description
5926 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
5927 \backslash
5928 frac{x}{y}"),
5929  the content of cell(0) is replaced by the current selection (only works if the selection is in mathed).
5930  As an example,
5931  if "abc" is selected in mathed,
5932  "math-insert
5933 \backslash
5934 frac{x}{y}" replaces "abc" with "
5935 \backslash
5936 frac{abc}{y}",
5937  and "math-insert x_y^z" replaces "abc" with "abc_y^z".
5938  If nothing is selected (or the selection is not in mathed),
5939  math-insert works as expected.
5940 \end_layout
5941
5942 \begin_layout Description
5943 Syntax math-insert <ARG>
5944 \end_layout
5945
5946 \begin_layout Description
5947 Params <ARG>:
5948  Symbol or LaTeX code to be inserted.
5949 \end_layout
5950
5951 \begin_layout Subsection*
5952 math-limits
5953 \end_layout
5954
5955 \begin_layout Description
5956 Action Toggles the position of the limits from above/below to the right side an vice versa in integral symbol,
5957  a limit,
5958  a summation,
5959  etc.
5960 \end_layout
5961
5962 \begin_layout Description
5963 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
5964 \end_layout
5965
5966 \begin_layout Description
5967 Syntax math-limits [<STATE>]
5968 \end_layout
5969
5970 \begin_layout Description
5971 Params <STATE>:
5972  limits|nolimits
5973 \end_layout
5974
5975 \begin_layout Subsection*
5976 math-macro
5977 \end_layout
5978
5979 \begin_layout Description
5980 Action Inserts a math macro definition at the cursor position in the text.
5981 \end_layout
5982
5983 \begin_layout Description
5984 Syntax math-macro <NAME> [<NARGS>] [def]
5985 \end_layout
5986
5987 \begin_layout Description
5988 Params <NAME>:
5989  The name of the macro,
5990  e.g.
5991  "mymacro".
5992 \begin_inset Newline newline
5993 \end_inset
5994
5995 <NARGS>:
5996  The number of parameters of the macro.
5997  Default is 0.
5998  "def":
5999  Has no effect anymore,
6000  just for compatibility with former LyX versions.
6001 \end_layout
6002
6003 \begin_layout Description
6004 Origin ale,
6005  10 May 1997;
6006   sts,
6007  21 Dec 2007
6008 \end_layout
6009
6010 \begin_layout Subsection*
6011 math-macro-add-greedy-optional-param
6012 \end_layout
6013
6014 \begin_layout Description
6015 Action Add a greedy optional parameter.
6016 \end_layout
6017
6018 \begin_layout Description
6019 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
6020 \end_layout
6021
6022 \begin_layout Description
6023 Syntax math-macro-add-greedy-optional-param
6024 \end_layout
6025
6026 \begin_layout Description
6027 Origin sts,
6028  06 January 2008
6029 \end_layout
6030
6031 \begin_layout Subsection*
6032 math-macro-add-optional-param
6033 \end_layout
6034
6035 \begin_layout Description
6036 Action Add an optional parameter.
6037 \end_layout
6038
6039 \begin_layout Description
6040 Notion Insert an optional parameter just behind the already existing optional parameters.
6041 \end_layout
6042
6043 \begin_layout Description
6044 Syntax math-macro-add-optional-param
6045 \end_layout
6046
6047 \begin_layout Description
6048 Origin sts,
6049  06 January 2008
6050 \end_layout
6051
6052 \begin_layout Subsection*
6053 math-macro-add-param
6054 \end_layout
6055
6056 \begin_layout Description
6057 Action Add a parameter.
6058 \end_layout
6059
6060 \begin_layout Description
6061 Notion Add a parameter to a Math Macro.
6062 \end_layout
6063
6064 \begin_layout Description
6065 Syntax math-macro-add-param <NUM>
6066 \end_layout
6067
6068 \begin_layout Description
6069 Params <NUM>:
6070  The number of the parameter behind which the new one will be added (1 for the first,
6071  i.e.
6072  use 0 for add a parameter at the left),
6073  defaults to the last one.
6074 \end_layout
6075
6076 \begin_layout Description
6077 Origin sts,
6078  06 January 2008
6079 \end_layout
6080
6081 \begin_layout Subsection*
6082 math-macro-append-greedy-param
6083 \end_layout
6084
6085 \begin_layout Description
6086 Action Append a greedy parameter.
6087 \end_layout
6088
6089 \begin_layout Description
6090 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
6091 \end_layout
6092
6093 \begin_layout Description
6094 Syntax math-macro-append-greedy-param
6095 \end_layout
6096
6097 \begin_layout Description
6098 Origin sts,
6099  06 January 2008
6100 \end_layout
6101
6102 \begin_layout Subsection*
6103 math-macro-fold
6104 \end_layout
6105
6106 \begin_layout Description
6107 Action Fold a Math Macro.
6108 \end_layout
6109
6110 \begin_layout Description
6111 Notion Fold the Math Macro the cursor is in if it was unfolded,
6112  i.e.
6113  displayed as
6114 \backslash
6115 foo before.
6116 \end_layout
6117
6118 \begin_layout Description
6119 Syntax math-macro-fold
6120 \end_layout
6121
6122 \begin_layout Description
6123 Origin sts,
6124  06 January 2008
6125 \end_layout
6126
6127 \begin_layout Subsection*
6128 math-macro-make-nonoptional
6129 \end_layout
6130
6131 \begin_layout Description
6132 Action Make a parameter non-optional.
6133 \end_layout
6134
6135 \begin_layout Description
6136 Notion Turn the last optional parameter of a Math Macro into a non-optional parameter.
6137  The default value is remembered to be reused later if the user changes his mind.
6138 \end_layout
6139
6140 \begin_layout Description
6141 Syntax math-macro-make-nonoptional
6142 \end_layout
6143
6144 \begin_layout Description
6145 Origin sts,
6146  06 January 2008
6147 \end_layout
6148
6149 \begin_layout Subsection*
6150 math-macro-make-optional
6151 \end_layout
6152
6153 \begin_layout Description
6154 Action Make a parameter optional.
6155 \end_layout
6156
6157 \begin_layout Description
6158 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
6159 \end_layout
6160
6161 \begin_layout Description
6162 Syntax math-macro-make-optional
6163 \end_layout
6164
6165 \begin_layout Description
6166 Origin sts,
6167  06 January 2008
6168 \end_layout
6169
6170 \begin_layout Subsection*
6171 math-macro-remove-greedy-param
6172 \end_layout
6173
6174 \begin_layout Description
6175 Action Remove a greedy parameter.
6176 \end_layout
6177
6178 \begin_layout Description
6179 Notion Remove a greedy parameter of a Math Macro and spit out the values of it in every instance of the macro in the buffer.
6180  If it is an optional parameter the [valud] format is used.
6181 \end_layout
6182
6183 \begin_layout Description
6184 Syntax math-macro-remove-greedy-param
6185 \end_layout
6186
6187 \begin_layout Description
6188 Origin sts,
6189  06 January 2008
6190 \end_layout
6191
6192 \begin_layout Subsection*
6193 math-macro-remove-optional-param
6194 \end_layout
6195
6196 \begin_layout Description
6197 Action Remove the last optional parameter.
6198 \end_layout
6199
6200 \begin_layout Description
6201 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
6202 \end_layout
6203
6204 \begin_layout Description
6205 Syntax math-macro-remove-optional-param
6206 \end_layout
6207
6208 \begin_layout Description
6209 Origin sts,
6210  06 January 2008
6211 \end_layout
6212
6213 \begin_layout Subsection*
6214 math-macro-remove-param
6215 \end_layout
6216
6217 \begin_layout Description
6218 Action Remove the last parameter.
6219 \end_layout
6220
6221 \begin_layout Description
6222 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
6223 \end_layout
6224
6225 \begin_layout Description
6226 Syntax math-macro-remove-param <NUM>
6227 \end_layout
6228
6229 \begin_layout Description
6230 Params <NUM>:
6231  The number of the parameter to be deleted (1 for the first),
6232  defaults to the last one.
6233 \end_layout
6234
6235 \begin_layout Description
6236 Origin sts,
6237  06 January 2008
6238 \end_layout
6239
6240 \begin_layout Subsection*
6241 math-macro-unfold
6242 \end_layout
6243
6244 \begin_layout Description
6245 Action Unfold a Math Macro.
6246 \end_layout
6247
6248 \begin_layout Description
6249 Notion Unfold the Math Macro the cursor is in,
6250  i.e.
6251  display it as
6252 \backslash
6253 foo.
6254 \end_layout
6255
6256 \begin_layout Description
6257 Syntax math-macro-unfold
6258 \end_layout
6259
6260 \begin_layout Description
6261 Origin sts,
6262  06 January 2008
6263 \end_layout
6264
6265 \begin_layout Subsection*
6266 math-matrix
6267 \end_layout
6268
6269 \begin_layout Description
6270 Action Inserts a matrix.
6271 \end_layout
6272
6273 \begin_layout Description
6274 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
6275 \end_layout
6276
6277 \begin_layout Description
6278 Params <ALIGN>:
6279  Alignment is a word composed of the vertical alignment (b,
6280  c or t) (i.e.
6281  1 char) and the horizontal alignments (l,
6282  c or r) (i.e.
6283  <COL> chars).
6284 \end_layout
6285
6286 \begin_layout Description
6287 Sample math-matrix 3 3 bccc
6288 \end_layout
6289
6290 \begin_layout Subsection*
6291 math-mode
6292 \end_layout
6293
6294 \begin_layout Description
6295 Action In text mode enters math mode (i.e.
6296  puts math insets on the current cursor position),
6297  in math mode enters text mode inside math expression.
6298 \end_layout
6299
6300 \begin_layout Description
6301 Notion If there is some selected text,
6302  it puts the text inside created math box.
6303 \end_layout
6304
6305 \begin_layout Description
6306 Syntax math-mode [on|<ARG>]
6307 \end_layout
6308
6309 \begin_layout Description
6310 Params <ARG>:
6311  eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
6312 \begin_inset Newline newline
6313 \end_inset
6314
6315 "on":
6316  allow only entering of math mode from text mode.
6317 \end_layout
6318
6319 \begin_layout Description
6320 Origin Alejandro,
6321  4 Jun 1996
6322 \end_layout
6323
6324 \begin_layout Subsection*
6325 math-mutate
6326 \end_layout
6327
6328 \begin_layout Description
6329 Action Mutates the type of math inset to the newly selected one.
6330 \end_layout
6331
6332 \begin_layout Description
6333 Syntax math-mutate <TYPE>
6334 \end_layout
6335
6336 \begin_layout Description
6337 Params <TYPE>:
6338  none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
6339 \end_layout
6340
6341 \begin_layout Description
6342 Origin Andre,
6343  23 May 2001
6344 \end_layout
6345
6346 \begin_layout Subsection*
6347 math-number-line-toggle
6348 \end_layout
6349
6350 \begin_layout Description
6351 Action Toggles numbering of the current formula line.
6352 \end_layout
6353
6354 \begin_layout Description
6355 Notion Must be in display formula mode.
6356 \end_layout
6357
6358 \begin_layout Description
6359 Syntax math-number-line-toggle
6360 \end_layout
6361
6362 \begin_layout Description
6363 Origin Alejandro,
6364  18 Jun 1996
6365 \end_layout
6366
6367 \begin_layout Subsection*
6368 math-number-toggle
6369 \end_layout
6370
6371 \begin_layout Description
6372 Action Toggles numbering/labeling of the current formula.
6373 \end_layout
6374
6375 \begin_layout Description
6376 Notion Must be in display formula mode.
6377 \end_layout
6378
6379 \begin_layout Description
6380 Syntax math-number-toggle
6381 \end_layout
6382
6383 \begin_layout Description
6384 Origin Alejandro,
6385  4 Jun 1996
6386 \end_layout
6387
6388 \begin_layout Subsection*
6389 math-size
6390 \end_layout
6391
6392 \begin_layout Description
6393 Action Changes arbitrarily the size used by math fonts inside a context.
6394 \end_layout
6395
6396 \begin_layout Description
6397 Notion Provides an interface to the LaTeX math mode font size commands.
6398 \end_layout
6399
6400 \begin_layout Description
6401 Syntax math-size <STYLE>
6402 \end_layout
6403
6404 \begin_layout Description
6405 Params <STYLE>:
6406
6407 \backslash
6408 displaystyle|
6409 \backslash
6410 textstyle|
6411 \backslash
6412 scriptstyle|
6413 \backslash
6414 scriptscriptstyle
6415 \end_layout
6416
6417 \begin_layout Description
6418 Origin Alejandro,
6419  15 Aug 1996;
6420  sanda,
6421  14 Jun 2008
6422 \end_layout
6423
6424 \begin_layout Subsection*
6425 math-space
6426 \end_layout
6427
6428 \begin_layout Description
6429 Action Inserts space into math expression.
6430 \end_layout
6431
6432 \begin_layout Description
6433 Notion Use spacebar after entering this space to change type of space.
6434 \end_layout
6435
6436 \begin_layout Description
6437 Syntax math-space [<TYPE>] [<LEN>]
6438 \end_layout
6439
6440 \begin_layout Description
6441 Params <TYPE>:
6442  negative spaces:
6443  !|negthinspace|negmedspace|negthickspace
6444 \begin_inset Newline newline
6445 \end_inset
6446
6447 positive spaces:
6448  ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
6449 \begin_inset Newline newline
6450 \end_inset
6451
6452 custom space:
6453  hspace
6454 \begin_inset Newline newline
6455 \end_inset
6456
6457 "," used by default.
6458 \begin_inset Newline newline
6459 \end_inset
6460
6461 Note that !
6462  is equivalent to negthinspace,
6463  ,
6464  = thinspace,
6465  :
6466  = medspace,
6467  and ;
6468  = thickspace.
6469 \begin_inset Newline newline
6470 \end_inset
6471
6472 <LEN>:
6473  length for custom spaces (hspace)
6474 \end_layout
6475
6476 \begin_layout Description
6477 Origin Andre,
6478  25 Jul 2001;
6479  sanda,
6480  16 Jun 2008
6481 \end_layout
6482
6483 \begin_layout Subsection*
6484 math-subscript
6485 \end_layout
6486
6487 \begin_layout Description
6488 Action Enters subscript expression in math expression.
6489 \end_layout
6490
6491 \begin_layout Description
6492 Syntax math-subscript
6493 \end_layout
6494
6495 \begin_layout Description
6496 Origin vermeer,
6497  12 Dec 2001
6498 \end_layout
6499
6500 \begin_layout Subsection*
6501 math-superscript
6502 \end_layout
6503
6504 \begin_layout Description
6505 Action Enters superscript expression in math expression.
6506 \end_layout
6507
6508 \begin_layout Description
6509 Syntax math-superscript
6510 \end_layout
6511
6512 \begin_layout Description
6513 Origin vermeer,
6514  12 Dec 2001
6515 \end_layout
6516
6517 \begin_layout Subsection*
6518 regexp-mode
6519 \end_layout
6520
6521 \begin_layout Description
6522 Action Enters regexp mode (i.e.,
6523  puts regexp insets on the current cursor position).
6524  Used by the advanced search dialog.
6525 \end_layout
6526
6527 \begin_layout Description
6528 Notion If there is any selected text,
6529  then it is moved inside the created regexp inset.
6530 \end_layout
6531
6532 \begin_layout Description
6533 Syntax regexp-mode [<ARG>]
6534 \end_layout
6535
6536 \begin_layout Description
6537 Params <ARG>:
6538  eventual argument (regular expression).
6539 \end_layout
6540
6541 \begin_layout Description
6542 Origin Tommaso,
6543  4 Oct 2008
6544 \end_layout
6545
6546 \begin_layout Section
6547 Buffer Fuctions (File and Window related)
6548 \end_layout
6549
6550 \begin_layout Subsection*
6551 branch-activate
6552 \end_layout
6553
6554 \begin_layout Description
6555 Action Activate the branch.
6556 \end_layout
6557
6558 \begin_layout Description
6559 Syntax branch-activate <BRANCH>
6560 \end_layout
6561
6562 \begin_layout Description
6563 Params <BRANCH>:
6564  The branch to activate
6565 \end_layout
6566
6567 \begin_layout Description
6568 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
6569 \begin_inset Newline newline
6570 \end_inset
6571
6572 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
6573 \end_layout
6574
6575 \begin_layout Description
6576 Origin rgh,
6577  27 May 2008
6578 \end_layout
6579
6580 \begin_layout Subsection*
6581 branch-add
6582 \end_layout
6583
6584 \begin_layout Description
6585 Action Add a branch to the buffer's BranchList.
6586 \end_layout
6587
6588 \begin_layout Description
6589 Syntax branch-add <BRANCH>
6590 \end_layout
6591
6592 \begin_layout Description
6593 Params <BRANCH>:
6594  Name of the branch to add
6595 \end_layout
6596
6597 \begin_layout Description
6598 Origin spitz,
6599  7 Jul 2009
6600 \end_layout
6601
6602 \begin_layout Subsection*
6603 branch-add-insert
6604 \end_layout
6605
6606 \begin_layout Description
6607 Action Create new branch and directly put the branch inset into the document.
6608 \end_layout
6609
6610 \begin_layout Description
6611 Syntax branch-add-insert [<NAME>]
6612 \end_layout
6613
6614 \begin_layout Description
6615 Params <NAME>:
6616  Branch name.
6617  If it is not specified,
6618  you will be asked.
6619 \end_layout
6620
6621 \begin_layout Description
6622 Origin sanda,
6623  10 Jul 2009
6624 \end_layout
6625
6626 \begin_layout Subsection*
6627 branch-deactivate
6628 \end_layout
6629
6630 \begin_layout Description
6631 Action De-activate the branch.
6632 \end_layout
6633
6634 \begin_layout Description
6635 Syntax branch-deactivate <BRANCH>
6636 \end_layout
6637
6638 \begin_layout Description
6639 Params <BRANCH>:
6640  The branch to deactivate
6641 \end_layout
6642
6643 \begin_layout Description
6644 Origin rgh,
6645  27 May 2008
6646 \end_layout
6647
6648 \begin_layout Subsection*
6649 branch-invert
6650 \end_layout
6651
6652 \begin_layout Description
6653 Action Toggles inversion status of branch inset.
6654 \end_layout
6655
6656 \begin_layout Description
6657 Syntax branch-invert
6658 \end_layout
6659
6660 \begin_layout Description
6661 Origin rgheck,
6662  12 July 2016
6663 \end_layout
6664
6665 \begin_layout Subsection*
6666 branch-master-activate
6667 \end_layout
6668
6669 \begin_layout Description
6670 Action Activate the branch in the master buffer.
6671 \end_layout
6672
6673 \begin_layout Description
6674 Syntax branch-master-activate <BRANCH>
6675 \end_layout
6676
6677 \begin_layout Description
6678 Params <BRANCH>:
6679  The branch to activate
6680 \end_layout
6681
6682 \begin_layout Description
6683 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
6684 \begin_inset Newline newline
6685 \end_inset
6686
6687 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
6688 \end_layout
6689
6690 \begin_layout Description
6691 Origin spitz,
6692  30 Sep 2012
6693 \end_layout
6694
6695 \begin_layout Subsection*
6696 branch-master-deactivate
6697 \end_layout
6698
6699 \begin_layout Description
6700 Action De-activate the branch in the master buffer.
6701 \end_layout
6702
6703 \begin_layout Description
6704 Syntax branch-master-deactivate <BRANCH>
6705 \end_layout
6706
6707 \begin_layout Description
6708 Params <BRANCH>:
6709  The branch to deactivate
6710 \end_layout
6711
6712 \begin_layout Description
6713 Origin spitz,
6714  30 Sep 2012
6715 \end_layout
6716
6717 \begin_layout Subsection*
6718 branch-sync-all
6719 \end_layout
6720
6721 \begin_layout Description
6722 Action Open/close all insets of selected branch (depending on its activation status).
6723 \end_layout
6724
6725 \begin_layout Description
6726 Syntax branch-sync-all
6727 \end_layout
6728
6729 \begin_layout Description
6730 Origin sanda,
6731  15 April 2022
6732 \end_layout
6733
6734 \begin_layout Subsection*
6735 branches-rename
6736 \end_layout
6737
6738 \begin_layout Description
6739 Action Rename all branches of a given name in a document.
6740 \end_layout
6741
6742 \begin_layout Description
6743 Syntax branches-rename <OLDNAME> <NEWNAME>
6744 \end_layout
6745
6746 \begin_layout Description
6747 Params <OLDNAME>:
6748  Current name of the branch to be renamed <NEWNAME>:
6749  New name of the branch
6750 \end_layout
6751
6752 \begin_layout Description
6753 Origin spitz,
6754  9 Jul 2009
6755 \end_layout
6756
6757 \begin_layout Subsection*
6758 buffer-auto-save
6759 \end_layout
6760
6761 \begin_layout Description
6762 Action Saves the current buffer to a temporary file.
6763 \end_layout
6764
6765 \begin_layout Description
6766 Notion Saves the current buffer to a file named "#filename#".
6767  This LFUN is called automatically by LyX,
6768  to "autosave" the current buffer.
6769 \end_layout
6770
6771 \begin_layout Description
6772 Syntax buffer-auto-save
6773 \end_layout
6774
6775 \begin_layout Subsection*
6776 buffer-child-open
6777 \end_layout
6778
6779 \begin_layout Description
6780 Action Loads the given child document.
6781 \end_layout
6782
6783 \begin_layout Description
6784 Notion The current document is treated as a parent.
6785 \end_layout
6786
6787 \begin_layout Description
6788 Syntax buffer-child-open <FILE>
6789 \end_layout
6790
6791 \begin_layout Description
6792 Params <FILE>:
6793  Filename of the child.
6794  The directory of the parent is assumed by default.
6795 \end_layout
6796
6797 \begin_layout Description
6798 Origin Ale,
6799  28 May 1997
6800 \end_layout
6801
6802 \begin_layout Subsection*
6803 buffer-chktex
6804 \end_layout
6805
6806 \begin_layout Description
6807 Action Runs chktex for the current document.
6808 \end_layout
6809
6810 \begin_layout Description
6811 Syntax buffer-chktex
6812 \end_layout
6813
6814 \begin_layout Description
6815 Origin Asger,
6816  30 Oct 1997
6817 \end_layout
6818
6819 \begin_layout Subsection*
6820 buffer-close
6821 \end_layout
6822
6823 \begin_layout Description
6824 Action Closes the current buffer.
6825 \end_layout
6826
6827 \begin_layout Description
6828 Notion Closes the current buffer,
6829  asking whether to save it,
6830  etc,
6831  if the buffer has been modified.
6832 \end_layout
6833
6834 \begin_layout Description
6835 Syntax buffer-close
6836 \end_layout
6837
6838 \begin_layout Subsection*
6839 buffer-close-all
6840 \end_layout
6841
6842 \begin_layout Description
6843 Action Closes all buffers.
6844 \end_layout
6845
6846 \begin_layout Description
6847 Notion Closes all buffers,
6848  asking whether to save it,
6849  etc,
6850  if a buffer has been modified.
6851 \end_layout
6852
6853 \begin_layout Description
6854 Syntax buffer-close-all
6855 \end_layout
6856
6857 \begin_layout Subsection*
6858 buffer-export
6859 \end_layout
6860
6861 \begin_layout Description
6862 Action Exports the current buffer (document) to the given format.
6863 \end_layout
6864
6865 \begin_layout Description
6866 Syntax buffer-export [<FORMAT>] [<DEST>]
6867 \end_layout
6868
6869 \begin_layout Description
6870 Params <FORMAT> is either "custom" or one of the formats which you can find in Tools->Preferences->File formats->Format.
6871  Usual format you will enter is "pdf2" (pdflatex),
6872  "pdflatex" (plain tex for pdflatex) or "ps" for postscript.
6873 \begin_inset Newline newline
6874 \end_inset
6875
6876 In case of "custom" you will be asked for a format you want to start from and for the command that you want to apply to this format.
6877  Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
6878 \begin_inset Newline newline
6879 \end_inset
6880
6881 If absent or "default",
6882  then the default output format of the document is used.
6883 \begin_inset Newline newline
6884 \end_inset
6885
6886 <DEST>   If present,
6887  this argument provides the export destination filename.
6888  Its containing folder will also be the destination folder,
6889  where all the needed external files will be copied.
6890 \end_layout
6891
6892 \begin_layout Description
6893 Origin Lgb,
6894  29 Jul 1997
6895 \end_layout
6896
6897 \begin_layout Subsection*
6898 buffer-export-as
6899 \end_layout
6900
6901 \begin_layout Description
6902 Action Opens a dialog for exporting the current buffer.
6903 \end_layout
6904
6905 \begin_layout Description
6906 Syntax buffer-export-as [<FORMAT>]
6907 \end_layout
6908
6909 \begin_layout Description
6910 Params <FORMAT> is the export format initially selected in the dialog.
6911  You can pass any of the formats which you can find in Tools->Preferences->File formats->Format,
6912  provided it has the "document" flag set.
6913  If no format is specified the dialog will start with the default output format of the current document.
6914 \end_layout
6915
6916 \begin_layout Description
6917 Sample buffer-export-as pdf2
6918 \end_layout
6919
6920 \begin_layout Description
6921 Origin tommaso,
6922  6 Oct 2011
6923 \end_layout
6924
6925 \begin_layout Subsection*
6926 buffer-export-custom
6927 \end_layout
6928
6929 \begin_layout Description
6930 Action Exports the current buffer (document) from the given format using the given command on it.
6931 \end_layout
6932
6933 \begin_layout Description
6934 Syntax buffer-export-custom <FORMAT> <COMMAND>
6935 \end_layout
6936
6937 \begin_layout Description
6938 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
6939 \begin_inset Newline newline
6940 \end_inset
6941
6942 <COMMAND> this command will be launched on the file.
6943  Note that you can use "$$FName" string to qualify the intermediate file.
6944 \end_layout
6945
6946 \begin_layout Description
6947 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
6948 \end_layout
6949
6950 \begin_layout Description
6951 Origin leeming,
6952  27 Mar 2004
6953 \end_layout
6954
6955 \begin_layout Subsection*
6956 buffer-external-modification-clear
6957 \end_layout
6958
6959 \begin_layout Description
6960 Action Clear the external modification flag on the current buffer.
6961 \end_layout
6962
6963 \begin_layout Description
6964 Syntax buffer-external-modification-clear
6965 \end_layout
6966
6967 \begin_layout Description
6968 Origin gm,
6969  2 March 2017
6970 \end_layout
6971
6972 \begin_layout Subsection*
6973 buffer-forall
6974 \end_layout
6975
6976 \begin_layout Description
6977 Action Applies a command to all non-hidden buffers.
6978 \end_layout
6979
6980 \begin_layout Description
6981 Notion a buffer is `hidden' if it is internally open in LyX,
6982  but not visible in any window.
6983 \end_layout
6984
6985 \begin_layout Description
6986 Syntax buffer-forall <LFUN-COMMAND>
6987 \end_layout
6988
6989 \begin_layout Description
6990 Params <LFUN-COMMAND>:
6991  The command to be applied to the buffers.
6992 \end_layout
6993
6994 \begin_layout Description
6995 Sample Close all Notes in all buffers:
6996 \begin_inset Newline newline
6997 \end_inset
6998
6999 buffer-forall inset-forall Note inset-toggle close
7000 \begin_inset Newline newline
7001 \end_inset
7002
7003 Toggle change tracking on buffers:
7004 \begin_inset Newline newline
7005 \end_inset
7006
7007 buffer-forall changes-track
7008 \begin_inset Newline newline
7009 \end_inset
7010
7011 Toggle read-only for buffers:
7012 \begin_inset Newline newline
7013 \end_inset
7014
7015 buffer-forall buffer-toggle-read-only
7016 \begin_inset Newline newline
7017 \end_inset
7018
7019 Show statistics for individual buffers:
7020 \begin_inset Newline newline
7021 \end_inset
7022
7023 buffer-forall statistics
7024 \begin_inset Newline newline
7025 \end_inset
7026
7027 Activate the branch named "Solutions" in buffers:
7028 \begin_inset Newline newline
7029 \end_inset
7030
7031 buffer-forall branch-activate Solutions
7032 \begin_inset Newline newline
7033 \end_inset
7034
7035 Export buffers to PDF (pdflatex):
7036 \begin_inset Newline newline
7037 \end_inset
7038
7039 buffer-forall buffer-export pdf2
7040 \begin_inset Newline newline
7041 \end_inset
7042
7043
7044 \end_layout
7045
7046 \begin_layout Description
7047 Origin skostysh,
7048  20 Jul 2012
7049 \end_layout
7050
7051 \begin_layout Subsection*
7052 buffer-import
7053 \end_layout
7054
7055 \begin_layout Description
7056 Action Import a given file as a lyx document.
7057 \end_layout
7058
7059 \begin_layout Description
7060 Notion File can be imported iff lyx file format is (transitively) reachable via defined converters in preferences.
7061  Look in the File->Import menu to get an idea of the currently active import formats.
7062 \end_layout
7063
7064 \begin_layout Description
7065 Syntax buffer-import <FORMAT> [<FILE>]
7066 \end_layout
7067
7068 \begin_layout Description
7069 Origin Asger,
7070  24 Jul 1998
7071 \end_layout
7072
7073 \begin_layout Subsection*
7074 buffer-language
7075 \end_layout
7076
7077 \begin_layout Description
7078 Action Set language of the current document.
7079 \end_layout
7080
7081 \begin_layout Description
7082 Syntax buffer-language <LANG>
7083 \end_layout
7084
7085 \begin_layout Description
7086 Params <LANG>:
7087  language name.
7088  See lib/languages for list.
7089 \end_layout
7090
7091 \begin_layout Description
7092 Origin leeming,
7093  30 Mar 2004
7094 \end_layout
7095
7096 \begin_layout Subsection*
7097 buffer-move-next
7098 \end_layout
7099
7100 \begin_layout Description
7101 Action Moves the current tab one spot to the right.
7102 \end_layout
7103
7104 \begin_layout Description
7105 Syntax buffer-move-next
7106 \end_layout
7107
7108 \begin_layout Description
7109 Origin skostysh,
7110  7 Apr 2015
7111 \end_layout
7112
7113 \begin_layout Subsection*
7114 buffer-move-previous
7115 \end_layout
7116
7117 \begin_layout Description
7118 Action Moves the current tab one spot to the left.
7119 \end_layout
7120
7121 \begin_layout Description
7122 Syntax buffer-move-previous
7123 \end_layout
7124
7125 \begin_layout Description
7126 Origin skostysh,
7127  7 Apr 2015
7128 \end_layout
7129
7130 \begin_layout Subsection*
7131 buffer-new
7132 \end_layout
7133
7134 \begin_layout Description
7135 Action Creates a new buffer (that is,
7136  document) and switches to it.
7137 \end_layout
7138
7139 \begin_layout Description
7140 Notion Implicit path can be set in Preferences dialog.
7141 \end_layout
7142
7143 \begin_layout Description
7144 Syntax buffer-new [<FILE>]
7145 \end_layout
7146
7147 \begin_layout Description
7148 Params <FILE>:
7149  filename of created file with absolute path.
7150 \end_layout
7151
7152 \begin_layout Subsection*
7153 buffer-new-template
7154 \end_layout
7155
7156 \begin_layout Description
7157 Action Creates a new buffer (that is,
7158  document) from a template.
7159 \end_layout
7160
7161 \begin_layout Description
7162 Notion Path for new files and templates can be set in Preferences dialog.
7163  Template will be asked for via Open-dialog.
7164 \end_layout
7165
7166 \begin_layout Description
7167 Syntax buffer-new-template [<FILE>] [<TEMPLATE FILE>]
7168 \end_layout
7169
7170 \begin_layout Description
7171 Params <FILE>:
7172  filename of created file with absolute path.
7173  If empty or "newfile",
7174  a file with appropriate name is generated.
7175 \begin_inset Newline newline
7176 \end_inset
7177
7178 <TEMPLATE FILE>:
7179  filename of template with absolute path.
7180  If empty,
7181  a dialog is opened to select the new file.
7182 \end_layout
7183
7184 \begin_layout Subsection*
7185 buffer-next
7186 \end_layout
7187
7188 \begin_layout Description
7189 Action Switch to the next opened document.
7190 \end_layout
7191
7192 \begin_layout Description
7193 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
7194 \end_layout
7195
7196 \begin_layout Description
7197 Syntax buffer-next
7198 \end_layout
7199
7200 \begin_layout Subsection*
7201 buffer-params-apply
7202 \end_layout
7203
7204 \begin_layout Description
7205 Action Apply the given settings to the current document.
7206 \end_layout
7207
7208 \begin_layout Description
7209 Syntax buffer-params-apply [<ARGS>]
7210 \end_layout
7211
7212 \begin_layout Description
7213 Params <ARGS>:
7214  contains the particular settings to be saved.
7215  They obey the syntax you can find in document header of usual .lyx file.
7216 \end_layout
7217
7218 \begin_layout Description
7219 Origin leeming,
7220  30 Mar 2004
7221 \end_layout
7222
7223 \begin_layout Subsection*
7224 buffer-previous
7225 \end_layout
7226
7227 \begin_layout Description
7228 Action Switch to the previous opened document.
7229 \end_layout
7230
7231 \begin_layout Description
7232 Syntax buffer-previous
7233 \end_layout
7234
7235 \begin_layout Subsection*
7236 buffer-reload
7237 \end_layout
7238
7239 \begin_layout Description
7240 Action Reverts opened document.
7241 \end_layout
7242
7243 \begin_layout Description
7244 Syntax buffer-reload [dump]
7245 \end_layout
7246
7247 \begin_layout Description
7248 Params dump:
7249  do not ask for any confirmation,
7250  just reload.
7251  All changes will be lost.
7252 \end_layout
7253
7254 \begin_layout Description
7255 Origin Asger,
7256  2 Feb 1997
7257 \end_layout
7258
7259 \begin_layout Subsection*
7260 buffer-reset-export
7261 \end_layout
7262
7263 \begin_layout Description
7264 Action Removes the auxiliary file before next export to assure export is done afresh.
7265 \end_layout
7266
7267 \begin_layout Description
7268 Syntax buffer-reset-export
7269 \end_layout
7270
7271 \begin_layout Description
7272 Origin spitz,
7273  27 Dec 2019
7274 \end_layout
7275
7276 \begin_layout Subsection*
7277 buffer-save-as-default
7278 \end_layout
7279
7280 \begin_layout Description
7281 Action Save the current document settings as default.
7282 \end_layout
7283
7284 \begin_layout Description
7285 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
7286 \end_layout
7287
7288 \begin_layout Description
7289 Syntax buffer-save-as-default [<ARGS>]
7290 \end_layout
7291
7292 \begin_layout Description
7293 Params <ARGS>:
7294  contains the particular settings to be saved.
7295  They obey the syntax you can find in document header of usual .lyx file.
7296 \end_layout
7297
7298 \begin_layout Description
7299 Origin leeming,
7300  30 Mar 2004
7301 \end_layout
7302
7303 \begin_layout Subsection*
7304 buffer-switch
7305 \end_layout
7306
7307 \begin_layout Description
7308 Action Display and switch to the given buffer.
7309 \end_layout
7310
7311 \begin_layout Description
7312 Syntax buffer-switch <BUFFER>
7313 \end_layout
7314
7315 \begin_layout Description
7316 Params <BUFFER>:
7317  path and filename of already opened (but possibly hidden) document which is to be shown.
7318 \end_layout
7319
7320 \begin_layout Subsection*
7321 buffer-toggle-compression
7322 \end_layout
7323
7324 \begin_layout Description
7325 Action Toggles compression of the current document on/off.
7326 \end_layout
7327
7328 \begin_layout Description
7329 Syntax buffer-toggle-compression
7330 \end_layout
7331
7332 \begin_layout Description
7333 Origin bpeng,
7334  27 Apr 2006
7335 \end_layout
7336
7337 \begin_layout Subsection*
7338 buffer-toggle-read-only
7339 \end_layout
7340
7341 \begin_layout Description
7342 Action Toggle editing mode of the current document between read/write and read-only.
7343 \end_layout
7344
7345 \begin_layout Description
7346 Notion This function is not allowed if the file is under version control,
7347  since read-only flag is often used in version control file locking.
7348 \end_layout
7349
7350 \begin_layout Description
7351 Syntax buffer-toggle-read-only
7352 \end_layout
7353
7354 \begin_layout Description
7355 Origin Lgb,
7356  27 May 1997
7357 \end_layout
7358
7359 \begin_layout Subsection*
7360 buffer-update
7361 \end_layout
7362
7363 \begin_layout Description
7364 Action Exports the current document and put the result into the temporary directory.
7365 \end_layout
7366
7367 \begin_layout Description
7368 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VIEW) the output will be rewritten - updated.
7369  This is useful in case your viewer is able to detect such changes (e.g.
7370  ghostview for postscript).
7371 \end_layout
7372
7373 \begin_layout Description
7374 Syntax buffer-update [<FORMAT>]
7375 \end_layout
7376
7377 \begin_layout Description
7378 Params <FORMAT>:
7379  The format to display,
7380  where this is one of the formats defined in the Tools>Preferences>File Formats dialog,
7381  use the "Short name" field.
7382  If no format is given,
7383  the default format as specified in the same dialog is used.
7384 \end_layout
7385
7386 \begin_layout Description
7387 Origin Dekel,
7388  5 Aug 2000
7389 \end_layout
7390
7391 \begin_layout Subsection*
7392 buffer-view
7393 \end_layout
7394
7395 \begin_layout Description
7396 Action Displays current buffer in chosen format.
7397 \end_layout
7398
7399 \begin_layout Description
7400 Notion Displays the contents of the current buffer in the chosen format,
7401  for example,
7402  PDF or DVI.
7403  This runs the necessary converter,
7404  calls the defined viewer,
7405  and so forth.
7406 \end_layout
7407
7408 \begin_layout Description
7409 Syntax buffer-view [<FORMAT>]
7410 \end_layout
7411
7412 \begin_layout Description
7413 Params <FORMAT>:
7414  The format to display,
7415  where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
7416  If no format is given,
7417  the default format as specified in the same dialog is used.
7418 \end_layout
7419
7420 \begin_layout Subsection*
7421 buffer-view-cache
7422 \end_layout
7423
7424 \begin_layout Description
7425 Action Opens the file that was created from last preview of this buffer.
7426 \end_layout
7427
7428 \begin_layout Description
7429 Notion This LFUN is called by the "Show Output Anyway" button in the LaTeX Errors dialog.
7430  It can also be called by the user,
7431  which is useful if the document takes a long time to compile,
7432  and you just want to see the last previewed version.
7433 \end_layout
7434
7435 \begin_layout Description
7436 Syntax buffer-view-cache
7437 \end_layout
7438
7439 \begin_layout Subsection*
7440 buffer-write
7441 \end_layout
7442
7443 \begin_layout Description
7444 Action Saves the current buffer.
7445 \end_layout
7446
7447 \begin_layout Description
7448 Notion Saves the current buffer to disk,
7449  using the filename that is already associated with the buffer,
7450  asking for one if none is yet assigned.
7451 \end_layout
7452
7453 \begin_layout Description
7454 Syntax buffer-write [force]
7455 \end_layout
7456
7457 \begin_layout Description
7458 Params force:
7459  write even if buffer is not marked as modified.
7460 \end_layout
7461
7462 \begin_layout Subsection*
7463 buffer-write-all
7464 \end_layout
7465
7466 \begin_layout Description
7467 Action Save all changed documents.
7468 \end_layout
7469
7470 \begin_layout Description
7471 Syntax buffer-write-all
7472 \end_layout
7473
7474 \begin_layout Description
7475 Origin rgh,
7476  gpothier 6 Aug 2007
7477 \end_layout
7478
7479 \begin_layout Subsection*
7480 buffer-write-as
7481 \end_layout
7482
7483 \begin_layout Description
7484 Action Rename and save current buffer.
7485 \end_layout
7486
7487 \begin_layout Description
7488 Syntax buffer-write-as <FILENAME>
7489 \end_layout
7490
7491 \begin_layout Description
7492 Params <FILENAME>:
7493  New name of the buffer/file.
7494  A relative path is with respect to the original location of the buffer/file.
7495 \end_layout
7496
7497 \begin_layout Subsection*
7498 buffer-write-as-template
7499 \end_layout
7500
7501 \begin_layout Description
7502 Action Rename and save current buffer in the local templates directory.
7503 \end_layout
7504
7505 \begin_layout Description
7506 Syntax buffer-write-as-template <FILENAME>
7507 \end_layout
7508
7509 \begin_layout Description
7510 Params <FILENAME>:
7511  New name of the buffer/file.
7512  A relative path is with respect to the original location of the buffer/file.
7513 \end_layout
7514
7515 \begin_layout Subsection*
7516 buffer-zoom
7517 \end_layout
7518
7519 \begin_layout Description
7520 Action Sets the zoom of the screen fonts.
7521 \end_layout
7522
7523 \begin_layout Description
7524 Syntax buffer-zoom [<ZOOM>]
7525 \end_layout
7526
7527 \begin_layout Description
7528 Params <ZOOM>:
7529  The target zoom value in %;
7530  the default is the default zoom as saved in preferences.
7531 \end_layout
7532
7533 \begin_layout Description
7534 Origin daniel,
7535  28 Oct 2016
7536 \end_layout
7537
7538 \begin_layout Subsection*
7539 buffer-zoom-in
7540 \end_layout
7541
7542 \begin_layout Description
7543 Action Increases the zoom of the screen fonts.
7544 \end_layout
7545
7546 \begin_layout Description
7547 Syntax buffer-zoom-in [<ZOOM>]
7548 \end_layout
7549
7550 \begin_layout Description
7551 Params <ZOOM>:
7552  The zoom value addition in % (neg.
7553  or pos.);
7554  the default is 10% of the default zoom as saved in preferences.
7555 \end_layout
7556
7557 \begin_layout Description
7558 Origin vfr,
7559  30 Mar 2009
7560 \end_layout
7561
7562 \begin_layout Subsection*
7563 buffer-zoom-out
7564 \end_layout
7565
7566 \begin_layout Description
7567 Action Decreases the zoom of the screen fonts.
7568 \end_layout
7569
7570 \begin_layout Description
7571 Syntax buffer-zoom-out [<ZOOM>]
7572 \end_layout
7573
7574 \begin_layout Description
7575 Params <ZOOM>:
7576  The zoom value abstraction in % (neg.
7577  or pos.);
7578  the default is 10% of the default zoom as saved in preferences.
7579 \end_layout
7580
7581 \begin_layout Description
7582 Origin vfr,
7583  30 Mar 2009
7584 \end_layout
7585
7586 \begin_layout Subsection*
7587 build-program
7588 \end_layout
7589
7590 \begin_layout Description
7591 Action Generates the code (literate programming).
7592 \end_layout
7593
7594 \begin_layout Description
7595 Notion Latex file with extension
7596 \backslash
7597 literate_extension is generated.
7598  Then LyX invokes
7599 \backslash
7600 build_command (with a default of ``make'') to generate the code and
7601 \backslash
7602 build_error_filter to process the compilation error messages.
7603 \begin_inset Newline newline
7604 \end_inset
7605
7606 In case you want to process your literate file with a script,
7607  or some other program,
7608  just insert in your lyxrc file an entry with:
7609 \begin_inset Newline newline
7610 \end_inset
7611
7612
7613 \backslash
7614 build_command "my_script my_arguments"
7615 \begin_inset Newline newline
7616 \end_inset
7617
7618 The
7619 \backslash
7620 build_error_filter differs from the
7621 \backslash
7622 literate_error_filter only in that the former will identify error messages from your compiler.
7623 \end_layout
7624
7625 \begin_layout Description
7626 Syntax build-program
7627 \end_layout
7628
7629 \begin_layout Subsection*
7630 file-open
7631 \end_layout
7632
7633 \begin_layout Description
7634 Action Open LyX document.
7635 \end_layout
7636
7637 \begin_layout Description
7638 Syntax file-open [<FILE>]
7639 \end_layout
7640
7641 \begin_layout Description
7642 Params <FILE>:
7643  Filename to be opened.
7644 \end_layout
7645
7646 \begin_layout Subsection*
7647 help-open
7648 \end_layout
7649
7650 \begin_layout Description
7651 Action Open the given help file according to the language setting.
7652 \end_layout
7653
7654 \begin_layout Description
7655 Syntax help-open <FILE>[.lyx]
7656 \end_layout
7657
7658 \begin_layout Description
7659 Params <FILE>:
7660  any document from (/usr/share/)doc directory.
7661 \end_layout
7662
7663 \begin_layout Description
7664 Origin Jug,
7665  27 Jun 1999
7666 \end_layout
7667
7668 \begin_layout Subsection*
7669 icon-size
7670 \end_layout
7671
7672 \begin_layout Description
7673 Action Sets icon size of toolbars.
7674 \end_layout
7675
7676 \begin_layout Description
7677 Syntax icon-size [<SIZE>]
7678 \end_layout
7679
7680 \begin_layout Description
7681 Params <SIZE> :
7682  the icon size in px or one of the logical settings small|normal|big|huge|giant,
7683  the default is normal (whose size in px is icon set dependent).
7684 \end_layout
7685
7686 \begin_layout Description
7687 Origin 11 July 2016
7688 \end_layout
7689
7690 \begin_layout Subsection*
7691 ifrelatives
7692 \end_layout
7693
7694 \begin_layout Description
7695 Action Helper function for master-related actions
7696 \end_layout
7697
7698 \begin_layout Description
7699 Notion In a buffer,
7700  the function will be disabled if the buffer has no master or children.
7701  It thus allows to enable actions only in documents with master/children
7702 \end_layout
7703
7704 \begin_layout Description
7705 Syntax ifrelatives <ACTION>
7706 \end_layout
7707
7708 \begin_layout Description
7709 Origin spitz,
7710  2 January 2020
7711 \end_layout
7712
7713 \begin_layout Subsection*
7714 lyx-quit
7715 \end_layout
7716
7717 \begin_layout Description
7718 Action Terminates the current LyX instance.
7719 \end_layout
7720
7721 \begin_layout Description
7722 Notion Terminates the current LyX instance,
7723  asking whether to save modified documents,
7724  etc.
7725 \end_layout
7726
7727 \begin_layout Description
7728 Syntax lyx-quit
7729 \end_layout
7730
7731 \begin_layout Subsection*
7732 lyxfiles-open
7733 \end_layout
7734
7735 \begin_layout Description
7736 Action Open lyxfiles (templates/examples).
7737  Create a view if he have none.
7738 \end_layout
7739
7740 \begin_layout Description
7741 Syntax lyxfiles-open [<TYPE>]
7742 \end_layout
7743
7744 \begin_layout Description
7745 Params <TYPE>:
7746  templates or examples.
7747  Default is templates.
7748 \end_layout
7749
7750 \begin_layout Description
7751 Origin spitz,
7752  10 Feb 2021
7753 \end_layout
7754
7755 \begin_layout Subsection*
7756 master-buffer-export
7757 \end_layout
7758
7759 \begin_layout Description
7760 Action Exports the master buffer (document) to the given format.
7761 \end_layout
7762
7763 \begin_layout Description
7764 Syntax master-buffer-export [<FORMAT>] [<DEST>]
7765 \end_layout
7766
7767 \begin_layout Description
7768 Params <FORMAT> is one of the formats which you can find in Tools->Preferences->File formats->Format.
7769  Usual format you will enter is "pdf2" (pdflatex),
7770  "pdflatex" (plain tex for pdflatex) or "ps" for postscript.
7771 \begin_inset Newline newline
7772 \end_inset
7773
7774 Note that "custom" is not allowed in this case.
7775 \begin_inset Newline newline
7776 \end_inset
7777
7778 If absent or "default",
7779  then the default output format of the document is used.
7780 \begin_inset Newline newline
7781 \end_inset
7782
7783 <DEST>   If present,
7784  this argument provides the export destination filename.
7785  Its containing folder will also be the destination folder,
7786  where all the needed external files will be copied.
7787 \end_layout
7788
7789 \begin_layout Description
7790 Origin rkh,
7791  18 April 2018
7792 \end_layout
7793
7794 \begin_layout Subsection*
7795 master-buffer-forall
7796 \end_layout
7797
7798 \begin_layout Description
7799 Action Applies a command to a buffer and all it children,
7800  starting from the master.
7801 \end_layout
7802
7803 \begin_layout Description
7804 Syntax master-buffer-forall <LFUN-COMMAND>
7805 \end_layout
7806
7807 \begin_layout Description
7808 Params <LFUN-COMMAND>:
7809  The command to be applied to the buffers.
7810 \end_layout
7811
7812 \begin_layout Description
7813 Sample Close all Notes in buffers:
7814 \begin_inset Newline newline
7815 \end_inset
7816
7817                master-buffer-forall inset-forall Note inset-toggle close
7818 \begin_inset Newline newline
7819 \end_inset
7820
7821                Toggle change tracking on buffers:
7822 \begin_inset Newline newline
7823 \end_inset
7824
7825                master-buffer-forall changes-track
7826 \begin_inset Newline newline
7827 \end_inset
7828
7829                Toggle read-only for buffers:
7830 \begin_inset Newline newline
7831 \end_inset
7832
7833                master-buffer-forall buffer-toggle-read-only
7834 \begin_inset Newline newline
7835 \end_inset
7836
7837                Show statistics for individual buffers:
7838 \begin_inset Newline newline
7839 \end_inset
7840
7841                master-buffer-forall statistics
7842 \begin_inset Newline newline
7843 \end_inset
7844
7845                Activate the branch named "Solutions" in buffers:
7846 \begin_inset Newline newline
7847 \end_inset
7848
7849                master-buffer-forall branch-activate Solutions
7850 \begin_inset Newline newline
7851 \end_inset
7852
7853
7854 \end_layout
7855
7856 \begin_layout Description
7857 Origin spitz,
7858  31 Dec 2019
7859 \end_layout
7860
7861 \begin_layout Subsection*
7862 master-buffer-update
7863 \end_layout
7864
7865 \begin_layout Description
7866 Action Update (export) the document built from the master buffer,
7867  if the current buffer is part of a master/child document.
7868 \end_layout
7869
7870 \begin_layout Description
7871 Syntax master-buffer-update [<FORMAT>]
7872 \end_layout
7873
7874 \begin_layout Description
7875 Params <FORMAT>:
7876  The format to display,
7877  where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
7878  If no format is given,
7879  the default format as specified in the same dialog is used.
7880 \end_layout
7881
7882 \begin_layout Description
7883 Origin Tommaso,
7884  20 Sep 2007
7885 \end_layout
7886
7887 \begin_layout Subsection*
7888 master-buffer-view
7889 \end_layout
7890
7891 \begin_layout Description
7892 Action Show a preview built from the master buffer,
7893  if available.
7894  if the current buffer is part of a master/child document.
7895 \end_layout
7896
7897 \begin_layout Description
7898 Syntax master-buffer-view [<FORMAT>]
7899 \end_layout
7900
7901 \begin_layout Description
7902 Params <FORMAT>:
7903  The format to display,
7904  where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
7905  If no format is given,
7906  the default format as specified in the same dialog is used.
7907 \end_layout
7908
7909 \begin_layout Description
7910 Origin Tommaso,
7911  20 Sep 2007
7912 \end_layout
7913
7914 \begin_layout Subsection*
7915 menu-open
7916 \end_layout
7917
7918 \begin_layout Description
7919 Action Opens the menu given by its name.
7920 \end_layout
7921
7922 \begin_layout Description
7923 Syntax menu-open <NAME>
7924 \end_layout
7925
7926 \begin_layout Description
7927 Params <NAME>:
7928  menu name.
7929  See various .inc files in lib/ui for candidates.
7930 \end_layout
7931
7932 \begin_layout Subsection*
7933 tab-group-close
7934 \end_layout
7935
7936 \begin_layout Description
7937 Action Close the current tab group.
7938 \end_layout
7939
7940 \begin_layout Description
7941 Notion This only closes the work areas,
7942  not the buffers themselves.
7943  The still opened buffers can be visualized in another tab group.
7944 \end_layout
7945
7946 \begin_layout Description
7947 Syntax tab-group-close
7948 \end_layout
7949
7950 \begin_layout Description
7951 Origin Abdel,
7952  21 Feb 2008
7953 \end_layout
7954
7955 \begin_layout Subsection*
7956 tab-group-next
7957 \end_layout
7958
7959 \begin_layout Description
7960 Action Switch to the next tab group in split view.
7961 \end_layout
7962
7963 \begin_layout Description
7964 Syntax tab-group-next
7965 \end_layout
7966
7967 \begin_layout Subsection*
7968 tab-group-previous
7969 \end_layout
7970
7971 \begin_layout Description
7972 Action Switch to the previous tab group in split view.
7973 \end_layout
7974
7975 \begin_layout Description
7976 Syntax tab-group-previous
7977 \end_layout
7978
7979 \begin_layout Subsection*
7980 toolbar-movable
7981 \end_layout
7982
7983 \begin_layout Description
7984 Action Toggles movability of a given toolbar between true/false.
7985 \end_layout
7986
7987 \begin_layout Description
7988 Syntax toolbar-movable <NAME>
7989 \end_layout
7990
7991 \begin_layout Description
7992 Params <NAME>:
7993  *|standard|extra|table|math|mathmacrotemplate| minibuffer|review|view/update|math_panels|vcs| view-others|update-others
7994 \end_layout
7995
7996 \begin_layout Description
7997 Origin daniel,
7998  12 July 2016
7999 \end_layout
8000
8001 \begin_layout Subsection*
8002 toolbar-set
8003 \end_layout
8004
8005 \begin_layout Description
8006 Action Sets visibility of a given toolbar to on,
8007  off,
8008  or auto.
8009 \end_layout
8010
8011 \begin_layout Description
8012 Notion Skipping "auto" when allowauto is false.
8013 \end_layout
8014
8015 \begin_layout Description
8016 Syntax toolbar-set <NAME> [on|off|auto]
8017 \end_layout
8018
8019 \begin_layout Description
8020 Params <NAME>:
8021  standard|extra|table|math|mathmacrotemplate|
8022 \begin_inset Newline newline
8023 \end_inset
8024
8025 minibuffer|review|view/update|math_panels|vcs|
8026 \begin_inset Newline newline
8027 \end_inset
8028
8029 view-others|update-others
8030 \end_layout
8031
8032 \begin_layout Description
8033 Origin spitz,
8034  17 Dec 2020
8035 \end_layout
8036
8037 \begin_layout Subsection*
8038 toolbar-toggle
8039 \end_layout
8040
8041 \begin_layout Description
8042 Action Toggles visibility of a given toolbar between on/off/auto.
8043 \end_layout
8044
8045 \begin_layout Description
8046 Notion Skipping "auto" when allowauto is false.
8047 \end_layout
8048
8049 \begin_layout Description
8050 Syntax toolbar-toggle <NAME> [allowauto]
8051 \end_layout
8052
8053 \begin_layout Description
8054 Params <NAME>:
8055  standard|extra|table|math|mathmacrotemplate|
8056 \begin_inset Newline newline
8057 \end_inset
8058
8059 minibuffer|review|view/update|math_panels|vcs|
8060 \begin_inset Newline newline
8061 \end_inset
8062
8063 view-others|update-others
8064 \end_layout
8065
8066 \begin_layout Description
8067 Origin Edwin,
8068  21 May 2007
8069 \end_layout
8070
8071 \begin_layout Subsection*
8072 ui-toggle
8073 \end_layout
8074
8075 \begin_layout Description
8076 Action Various UI visibility-toggling actions.
8077 \end_layout
8078
8079 \begin_layout Description
8080 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
8081 \end_layout
8082
8083 \begin_layout Description
8084 Params statusbar     :
8085  Toggle visibility of the statusbar.
8086 \begin_inset Newline newline
8087 \end_inset
8088
8089 menubar       :
8090  Toggle visibility of the menubar.
8091 \begin_inset Newline newline
8092 \end_inset
8093
8094 scrollbar     :
8095  Toggle visibility of the scrollbar.
8096 \begin_inset Newline newline
8097 \end_inset
8098
8099 frame         :
8100  Toggle visibility of the frames around editing window.
8101 \begin_inset Newline newline
8102 \end_inset
8103
8104 zoomslider    :
8105  Toggle visibility of the zoom slider in statusbar.
8106 \begin_inset Newline newline
8107 \end_inset
8108
8109 zoomlevel     :
8110  Toggle visibility of the zoom level display in statusbar.
8111 \begin_inset Newline newline
8112 \end_inset
8113
8114 statistics-w  :
8115  Toggle visibility of the document word count in statusbar.
8116 \begin_inset Newline newline
8117 \end_inset
8118
8119 statistics-cb :
8120  Toggle visibility of the document character count (incl.
8121  blanks) in statusbar.
8122 \begin_inset Newline newline
8123 \end_inset
8124
8125 statistics-c  :
8126  Toggle visibility of the document character count (excl.
8127  blanks) in statusbar.
8128 \begin_inset Newline newline
8129 \end_inset
8130
8131 fullscreen    :
8132  Toggle fullscreen mode.
8133  This also covers calling the previous functions.
8134  However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should be used.
8135 \end_layout
8136
8137 \begin_layout Description
8138 Origin sanda,
8139  9 Feb 2007
8140 \end_layout
8141
8142 \begin_layout Subsection*
8143 view-close
8144 \end_layout
8145
8146 \begin_layout Description
8147 Action Close the current document work area.
8148 \end_layout
8149
8150 \begin_layout Description
8151 Notion Close the current work area.
8152  If no other work areas are showing the buffer,
8153  then close the associated buffer as well.
8154 \end_layout
8155
8156 \begin_layout Description
8157 Syntax view-close
8158 \end_layout
8159
8160 \begin_layout Description
8161 Origin Tommaso,
8162  15 Sep 2012
8163 \end_layout
8164
8165 \begin_layout Subsection*
8166 view-split
8167 \end_layout
8168
8169 \begin_layout Description
8170 Action Creates another split view of current buffer.
8171 \end_layout
8172
8173 \begin_layout Description
8174 Notion All split views act in the same way independently.
8175 \end_layout
8176
8177 \begin_layout Description
8178 Syntax view-split <vertical|horizontal>
8179 \end_layout
8180
8181 \begin_layout Description
8182 Params horizontal :
8183  The work areas are laid out side by side.
8184 \begin_inset Newline newline
8185 \end_inset
8186
8187 vertical   :
8188  The work areas laid out vertically.
8189 \end_layout
8190
8191 \begin_layout Description
8192 Origin Abdel,
8193  20 Feb 2008
8194 \end_layout
8195
8196 \begin_layout Subsection*
8197 window-close
8198 \end_layout
8199
8200 \begin_layout Description
8201 Action Closes the current LyX window.
8202 \end_layout
8203
8204 \begin_layout Description
8205 Syntax window-close
8206 \end_layout
8207
8208 \begin_layout Description
8209 Origin Abdel,
8210  23 Oct 2006
8211 \end_layout
8212
8213 \begin_layout Subsection*
8214 window-new
8215 \end_layout
8216
8217 \begin_layout Description
8218 Action Creates new empty LyX window.
8219 \end_layout
8220
8221 \begin_layout Description
8222 Notion Already opened documents from the previous window can be found under View menu.
8223 \end_layout
8224
8225 \begin_layout Description
8226 Syntax window-new [<GEOMETRY>]
8227 \end_layout
8228
8229 \begin_layout Description
8230 Params <GEOMETRY>:
8231  pass the geometry of the window.
8232  This parameter is currently accepted only on Windows platform.
8233 \end_layout
8234
8235 \begin_layout Description
8236 Origin Abdel,
8237  21 Oct 2006
8238 \end_layout
8239
8240 \begin_layout Section
8241 System Functions (Preferences,
8242  LyX Server etc.)
8243 \end_layout
8244
8245 \begin_layout Subsection*
8246 bibtex-database-list
8247 \end_layout
8248
8249 \begin_layout Description
8250 Action Lists the available databases (separated by path separator common on the used OS).
8251 \end_layout
8252
8253 \begin_layout Description
8254 Notion Used by bibliographic managers
8255 \end_layout
8256
8257 \begin_layout Description
8258 Syntax bibtex-database-list
8259 \end_layout
8260
8261 \begin_layout Description
8262 Origin bpiwowar,
8263  18 December 2022
8264 \end_layout
8265
8266 \begin_layout Subsection*
8267 buffer-toggle-output-sync
8268 \end_layout
8269
8270 \begin_layout Description
8271 Action Toggles including of resources for forward/reverse search of the given document.
8272 \end_layout
8273
8274 \begin_layout Description
8275 Notion When toggled on,
8276  SyncTeX is invoked for PDF,
8277  while srcltx package is used for DVI.
8278  Custom LaTeX macro can be defined in preferences.
8279 \end_layout
8280
8281 \begin_layout Description
8282 Syntax buffer-toggle-output-sync
8283 \end_layout
8284
8285 \begin_layout Description
8286 Origin sanda,
8287  25 May 2010
8288 \end_layout
8289
8290 \begin_layout Subsection*
8291 call
8292 \end_layout
8293
8294 \begin_layout Description
8295 Action Executes a command defined in a .def file.
8296 \end_layout
8297
8298 \begin_layout Description
8299 Notion The definitions are by default read from lib/commands/default.def.
8300 \begin_inset Newline newline
8301 \end_inset
8302
8303 A .def file allows to define a command with
8304 \backslash
8305 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and <LFUN> is the lfun code to be executed (see e.g.
8306  LFUN_COMMAND_SEQUENCE).
8307
8308 \backslash
8309 def_file "FileName" allows to include another .def file.
8310 \begin_inset Newline newline
8311 \end_inset
8312
8313 This is particularly useful in connection with toolbar buttons:
8314  Since the name of the button image for this lfun is lib/images/commands/<NAME>.png this is the way to assign an image to a complex command-sequence.
8315 \end_layout
8316
8317 \begin_layout Description
8318 Syntax call <NAME>
8319 \end_layout
8320
8321 \begin_layout Description
8322 Params <NAME>:
8323  Name of the command that must be called.
8324 \end_layout
8325
8326 \begin_layout Description
8327 Origin broider,
8328  2 Oct 2007
8329 \end_layout
8330
8331 \begin_layout Subsection*
8332 cancel
8333 \end_layout
8334
8335 \begin_layout Description
8336 Action Cancels sequence prepared by LFUN_META_PREFIX .
8337 \end_layout
8338
8339 \begin_layout Description
8340 Syntax cancel
8341 \end_layout
8342
8343 \begin_layout Subsection*
8344 command-alternatives
8345 \end_layout
8346
8347 \begin_layout Description
8348 Action Runs the first listed command that is enabled.
8349 \end_layout
8350
8351 \begin_layout Description
8352 Notion This can be used to bind multiple functions to a single key,
8353  and then which one is used will depend upon the context.
8354 \end_layout
8355
8356 \begin_layout Description
8357 Syntax command-alternatives <CMDS>
8358 \end_layout
8359
8360 \begin_layout Description
8361 Params <CMDS>:
8362  Sequence of commands separated by semicolons.
8363 \end_layout
8364
8365 \begin_layout Description
8366 Sample command-alternatives completion-accept;cell-forward
8367 \end_layout
8368
8369 \begin_layout Description
8370 Origin rgh,
8371  24 September 2008
8372 \end_layout
8373
8374 \begin_layout Subsection*
8375 command-sequence
8376 \end_layout
8377
8378 \begin_layout Description
8379 Action Run more commands (LFUN and its parameters) in a sequence.
8380 \end_layout
8381
8382 \begin_layout Description
8383 Syntax command-sequence <CMDS>
8384 \end_layout
8385
8386 \begin_layout Description
8387 Params <CMDS>:
8388  Sequence of commands separated by semicolons.
8389 \end_layout
8390
8391 \begin_layout Description
8392 Sample command-sequence cut;
8393  ert-insert;
8394  self-insert
8395 \backslash
8396 ;
8397  paste;
8398  self-insert {};
8399  inset-toggle;
8400 \end_layout
8401
8402 \begin_layout Description
8403 Origin Andre,
8404  11 Nov 1999
8405 \end_layout
8406
8407 \begin_layout Subsection*
8408 cursor-follows-scrollbar-toggle
8409 \end_layout
8410
8411 \begin_layout Description
8412 Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement.
8413 \end_layout
8414
8415 \begin_layout Description
8416 Syntax toggle-cursor-follows-scrollbar
8417 \end_layout
8418
8419 \begin_layout Description
8420 Origin ARRae,
8421  2 Dec 1997
8422 \end_layout
8423
8424 \begin_layout Subsection*
8425 debug-level-set
8426 \end_layout
8427
8428 \begin_layout Description
8429 Action Set debug output level.
8430 \end_layout
8431
8432 \begin_layout Description
8433 Syntax debug-level-set <LEVEL>
8434 \end_layout
8435
8436 \begin_layout Description
8437 Params <LEVEL>:
8438  comma separated list of levels or the correspondent number of their combination.
8439  0 is equivalent to disabling all debug events.
8440  See lyx -dbg for the current list of debug levels and their numbers.
8441 \end_layout
8442
8443 \begin_layout Description
8444 Origin sanda,
8445  28 Dec 2009
8446 \end_layout
8447
8448 \begin_layout Subsection*
8449 devel-mode-toggle
8450 \end_layout
8451
8452 \begin_layout Description
8453 Action toggle a mode where more information is given in UI
8454 \end_layout
8455
8456 \begin_layout Description
8457 Notion in so called "devel" mode,
8458  the information given in the status bar is more precise,
8459  and the help documents are open in editing mode.
8460 \end_layout
8461
8462 \begin_layout Description
8463 Syntax devel-mode-toggle
8464 \end_layout
8465
8466 \begin_layout Description
8467 Origin lasgouttes,
8468  23 Jul 2017
8469 \end_layout
8470
8471 \begin_layout Subsection*
8472 forward-search
8473 \end_layout
8474
8475 \begin_layout Description
8476 Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
8477 \end_layout
8478
8479 \begin_layout Description
8480 Notion The external program used for forward search call can be specified in LyX Output preferences.
8481  See Additional manual for details of these settings.
8482 \end_layout
8483
8484 \begin_layout Description
8485 Syntax forward-search
8486 \end_layout
8487
8488 \begin_layout Description
8489 Origin sanda,
8490  14 Apr 2010
8491 \end_layout
8492
8493 \begin_layout Subsection*
8494 lyxrc-apply
8495 \end_layout
8496
8497 \begin_layout Description
8498 Action Apply the given settings to user preferences.
8499 \end_layout
8500
8501 \begin_layout Description
8502 Syntax lyxrc-apply <SETTINGS>
8503 \end_layout
8504
8505 \begin_layout Description
8506 Params <SETTINGS>:
8507  settings which are to be set.
8508  Take a look into ~/.lyx/preferences to get an idea which commands to use and their syntax.
8509  lyx::LyXRC::LyXRCTags has the list of possible commands.
8510 \end_layout
8511
8512 \begin_layout Subsection*
8513 message
8514 \end_layout
8515
8516 \begin_layout Description
8517 Action Shows message in statusbar (for script purposes).
8518 \end_layout
8519
8520 \begin_layout Description
8521 Syntax message <STRING>
8522 \end_layout
8523
8524 \begin_layout Description
8525 Origin Lgb,
8526  8 Apr 2001
8527 \end_layout
8528
8529 \begin_layout Subsection*
8530 meta-prefix
8531 \end_layout
8532
8533 \begin_layout Description
8534 Action Simulate halting Meta key (Alt key on PCs).
8535 \end_layout
8536
8537 \begin_layout Description
8538 Notion Used for buffer edition not for GUI control.
8539 \end_layout
8540
8541 \begin_layout Description
8542 Syntax meta-prefix
8543 \end_layout
8544
8545 \begin_layout Subsection*
8546 preferences-save
8547 \end_layout
8548
8549 \begin_layout Description
8550 Action Save user preferences.
8551 \end_layout
8552
8553 \begin_layout Description
8554 Syntax preferences-save
8555 \end_layout
8556
8557 \begin_layout Description
8558 Origin Lgb,
8559  27 Nov 1999
8560 \end_layout
8561
8562 \begin_layout Subsection*
8563 reconfigure
8564 \end_layout
8565
8566 \begin_layout Description
8567 Action Reconfigure the automatic settings.
8568 \end_layout
8569
8570 \begin_layout Description
8571 Syntax reconfigure
8572 \end_layout
8573
8574 \begin_layout Description
8575 Origin Asger,
8576  14 Feb 1997
8577 \end_layout
8578
8579 \begin_layout Subsection*
8580 search-ignore
8581 \end_layout
8582
8583 \begin_layout Description
8584 Action Enables/disables searching for features in findadv
8585 \end_layout
8586
8587 \begin_layout Description
8588 Syntax search-ignore <type> <value>
8589 \end_layout
8590
8591 \begin_layout Description
8592 Params <type>:
8593  language|color|sectioning|font|series|shape|family|markup|underline|strike|deleted|non-output-content
8594 \begin_inset Newline newline
8595 \end_inset
8596
8597 <value>:
8598  true|false
8599 \end_layout
8600
8601 \begin_layout Subsection*
8602 server-get-filename
8603 \end_layout
8604
8605 \begin_layout Description
8606 Action Returns path and file name of the currently edited document.
8607 \end_layout
8608
8609 \begin_layout Description
8610 Syntax server-get-filename
8611 \end_layout
8612
8613 \begin_layout Subsection*
8614 server-get-layout
8615 \end_layout
8616
8617 \begin_layout Description
8618 Action Returns the current layout (that is environment) name on the cursor position.
8619 \end_layout
8620
8621 \begin_layout Description
8622 Syntax server-get-layout
8623 \end_layout
8624
8625 \begin_layout Subsection*
8626 server-get-statistics
8627 \end_layout
8628
8629 \begin_layout Description
8630 Action Returns the statistics (number of words and characters) in the document or in the given selection.
8631 \end_layout
8632
8633 \begin_layout Description
8634 Notion Note that this function gives the number of words/chars written,
8635  not the number of characters which will be typeset.
8636 \end_layout
8637
8638 \begin_layout Description
8639 Syntax server-get-statistics [<TYPE>]
8640 \end_layout
8641
8642 \begin_layout Description
8643 Params <TYPE>:
8644  <words|chars|chars-space> The requested count;
8645  if not specified,
8646  the three values are returned,
8647  separated by a space.
8648 \begin_inset Newline newline
8649 \end_inset
8650
8651 words:
8652  count words.
8653 \begin_inset Newline newline
8654 \end_inset
8655
8656 chars:
8657  count characters.
8658 \begin_inset Newline newline
8659 \end_inset
8660
8661 chars-space:
8662  count characters and spaces.
8663 \end_layout
8664
8665 \begin_layout Description
8666 Origin brokenclock,
8667  Oct 10 2014
8668 \end_layout
8669
8670 \begin_layout Subsection*
8671 server-get-xy
8672 \end_layout
8673
8674 \begin_layout Description
8675 Action Returns the coordinates of cursor position in the editing area.
8676 \end_layout
8677
8678 \begin_layout Description
8679 Syntax server-get-xy
8680 \end_layout
8681
8682 \begin_layout Subsection*
8683 server-goto-file-row
8684 \end_layout
8685
8686 \begin_layout Description
8687 Action Sets the cursor position in LyX based on the row number of generated TeX file.
8688 \end_layout
8689
8690 \begin_layout Description
8691 Notion This can be useful for DVI inverse-search or detection of the problematic line from LaTeX compilation.
8692  Note that before this function can be used export to LaTeX output must occur (in order to map the row numbers).
8693 \end_layout
8694
8695 \begin_layout Description
8696 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
8697 \end_layout
8698
8699 \begin_layout Description
8700 Params <FILE>:
8701  the path and filename.
8702  Environment variables are expanded in the path.
8703  In case this LFUN does not work make sure you are giving correct path to the file.
8704 \begin_inset Newline newline
8705 \end_inset
8706
8707 If the file is located inside LyX temporary directory it will be mapped back into the appropriate opened buffer (e.g.
8708  for the case of generated .tex file).
8709 \begin_inset Newline newline
8710 \end_inset
8711
8712 .ext:
8713  extensions will be automatically replaced by .lyx.
8714 \begin_inset Newline newline
8715 \end_inset
8716
8717 <ROW_NUMBER> The row number of the LaTeX file to which to go.
8718 \end_layout
8719
8720 \begin_layout Description
8721 Sample server-goto-file-row /home/user/example.lyx 41
8722 \begin_inset Newline newline
8723 \end_inset
8724
8725 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
8726 \end_layout
8727
8728 \begin_layout Description
8729 Origin Edmar,
8730  23 Dec 1998
8731 \end_layout
8732
8733 \begin_layout Subsection*
8734 server-notify
8735 \end_layout
8736
8737 \begin_layout Description
8738 Action Sends notify message about the last key-sequence to client.
8739 \end_layout
8740
8741 \begin_layout Description
8742 Notion This can be used to grab last key-sequence used inside the LyX window.
8743  See also Debug extensions section in Additional features manual.
8744 \end_layout
8745
8746 \begin_layout Description
8747 Syntax server-notify
8748 \end_layout
8749
8750 \begin_layout Subsection*
8751 server-set-xy
8752 \end_layout
8753
8754 \begin_layout Description
8755 Action Sets the cursor position based on the editing area coordinates (similar to clicking on that point with left mouse button).
8756 \end_layout
8757
8758 \begin_layout Description
8759 Syntax server-set-xy <X> <Y>
8760 \end_layout
8761
8762 \begin_layout Subsection*
8763 set-color
8764 \end_layout
8765
8766 \begin_layout Description
8767 Action Set the given LyX color to the color defined by the X11 name given,
8768  and optionally a specific color for dark mode.
8769 \end_layout
8770
8771 \begin_layout Description
8772 Notion A new color entry is created if the color is unknown.
8773  Color names can be stored as a part of user settings.
8774 \end_layout
8775
8776 \begin_layout Description
8777 Syntax set-color <LYX_NAME> <X11_NAME> [<X11_DARKNAME>]
8778 \end_layout
8779
8780 \begin_layout Description
8781 Origin SLior,
8782  11 Jun 2000
8783 \end_layout
8784
8785 \begin_layout Subsection*
8786 statistics
8787 \end_layout
8788
8789 \begin_layout Description
8790 Action Count the statistics (number of words and characters) in the document or in the given selection and display it in a dialog box.
8791 \end_layout
8792
8793 \begin_layout Description
8794 Notion Note that this function gives the number of words/chars written,
8795  not the number of characters which will be typeset.
8796 \end_layout
8797
8798 \begin_layout Description
8799 Syntax statistics
8800 \end_layout
8801
8802 \begin_layout Description
8803 Origin lasgouttes,
8804  Jan 27 2004;
8805  sanda,
8806  Jan 8 2008
8807 \end_layout
8808
8809 \begin_layout Subsection*
8810 vc-check-in
8811 \end_layout
8812
8813 \begin_layout Description
8814 Action Checks-in/commits the changes of the registered file to the repository.
8815 \end_layout
8816
8817 \begin_layout Description
8818 Notion In RCS case this also unlocks the file.
8819 \end_layout
8820
8821 \begin_layout Description
8822 Syntax vc-check-in
8823 \end_layout
8824
8825 \begin_layout Description
8826 Origin Lgb,
8827  1 Jul 1997
8828 \end_layout
8829
8830 \begin_layout Subsection*
8831 vc-check-out
8832 \end_layout
8833
8834 \begin_layout Description
8835 Action Checks-out the document for edit (and locks it in some cases).
8836 \end_layout
8837
8838 \begin_layout Description
8839 Syntax vc-check-out
8840 \end_layout
8841
8842 \begin_layout Description
8843 Origin Lgb,
8844  1 Jul 1997
8845 \end_layout
8846
8847 \begin_layout Subsection*
8848 vc-command
8849 \end_layout
8850
8851 \begin_layout Description
8852 Action Executes external command.
8853  This command is intended to support additional VCS commands.
8854 \end_layout
8855
8856 \begin_layout Description
8857 Syntax vc-command <FLAG> <PATH> <COMMAND>
8858 \end_layout
8859
8860 \begin_layout Description
8861 Params  <FLAG>:
8862  Flags for the command can be combined together.
8863 \begin_inset Newline newline
8864 \end_inset
8865
8866 U - dUmmy - no flags
8867 \begin_inset Newline newline
8868 \end_inset
8869
8870 D - Doc - need document loaded to proceed
8871 \begin_inset Newline newline
8872 \end_inset
8873
8874 I - dIrty - mark document dirty
8875 \begin_inset Newline newline
8876 \end_inset
8877
8878 R - Reload - ensure that the document is saved and reload it after command execution
8879 \begin_inset Newline newline
8880 \end_inset
8881
8882 M - Message - ask for input string (commit message)
8883 \begin_inset Newline newline
8884 \end_inset
8885
8886 <PATH>:
8887  path where to start.
8888  $$p will be replaced by the current document path.
8889 \begin_inset Newline newline
8890 \end_inset
8891
8892 <COMMAND>:
8893  command to execute.
8894  $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
8895 \end_layout
8896
8897 \begin_layout Description
8898 Sample vc-command DR $$p "svn up"
8899 \end_layout
8900
8901 \begin_layout Description
8902 Origin sanda,
8903  13 Jan 2009
8904 \end_layout
8905
8906 \begin_layout Subsection*
8907 vc-compare
8908 \end_layout
8909
8910 \begin_layout Description
8911 Action Compares two revisions of the same file under version control.
8912 \end_layout
8913
8914 \begin_layout Description
8915 Syntax vc-compare [<REV1>] [<REV2>]
8916 \end_layout
8917
8918 \begin_layout Description
8919 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
8920 \begin_inset Newline newline
8921 \end_inset
8922
8923 In RCS we subtract only in the last number of revision specification.
8924  Special case "0" is reserved for the last committed revision.
8925 \begin_inset Newline newline
8926 \end_inset
8927
8928 <REV1>:
8929  Older file.
8930 \begin_inset Newline newline
8931 \end_inset
8932
8933 <REV2>:
8934  Newer file.
8935  Used only if REV1 > 0.
8936 \begin_inset Newline newline
8937 \end_inset
8938
8939 If no parameter is given,
8940  interactive dialog will be shown.
8941 \end_layout
8942
8943 \begin_layout Description
8944 Sample Compare current document against last commit
8945 \begin_inset Newline newline
8946 \end_inset
8947
8948 vc-compare 0
8949 \begin_inset Newline newline
8950 \end_inset
8951
8952 Compare current document against current revision - 5 commits
8953 \begin_inset Newline newline
8954 \end_inset
8955
8956 vc-compare -5
8957 \begin_inset Newline newline
8958 \end_inset
8959
8960 Compare revisions 120 and 155
8961 \begin_inset Newline newline
8962 \end_inset
8963
8964 vc-compare 120 155
8965 \end_layout
8966
8967 \begin_layout Description
8968 Origin sanda,
8969  12 Feb 2010
8970 \end_layout
8971
8972 \begin_layout Subsection*
8973 vc-copy
8974 \end_layout
8975
8976 \begin_layout Description
8977 Action Copies the document to another name.
8978 \end_layout
8979
8980 \begin_layout Description
8981 Notion Copying with revision history is only supported by SVN.
8982  For RCS and CVS it is simulated by adding the document under a new name.
8983  Disabled if uncommitted changes exist.
8984 \end_layout
8985
8986 \begin_layout Description
8987 Syntax vc-copy <FILENAME>
8988 \end_layout
8989
8990 \begin_layout Description
8991 Params <FILENAME>:
8992  New name of the document.
8993 \begin_inset Newline newline
8994 \end_inset
8995
8996 A file dialog is opened if no filename is given.
8997 \end_layout
8998
8999 \begin_layout Description
9000 Origin gb,
9001  05 Feb 2013
9002 \end_layout
9003
9004 \begin_layout Subsection*
9005 vc-locking-toggle
9006 \end_layout
9007
9008 \begin_layout Description
9009 Action Toggles the locking property of the edited file.
9010 \end_layout
9011
9012 \begin_layout Description
9013 Notion This is currently implemented only for SVN.
9014 \end_layout
9015
9016 \begin_layout Description
9017 Syntax vc-locking-toggle
9018 \end_layout
9019
9020 \begin_layout Description
9021 Origin sanda,
9022  25 Jun 2009
9023 \end_layout
9024
9025 \begin_layout Subsection*
9026 vc-register
9027 \end_layout
9028
9029 \begin_layout Description
9030 Action Register the document as an file inside version control system.
9031 \end_layout
9032
9033 \begin_layout Description
9034 Notion File is registered inside cvs,
9035  svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
9036 \begin_inset Newline newline
9037 \end_inset
9038
9039 See LyX Additional Features Manual (Version Control Chapter) for additional information.
9040 \end_layout
9041
9042 \begin_layout Description
9043 Syntax vc-register
9044 \end_layout
9045
9046 \begin_layout Description
9047 Origin Lgb,
9048  1 Jul 1997
9049 \end_layout
9050
9051 \begin_layout Subsection*
9052 vc-rename
9053 \end_layout
9054
9055 \begin_layout Description
9056 Action Renames the document to another name.
9057 \end_layout
9058
9059 \begin_layout Description
9060 Notion Renaming with revision history is only supported by SVN.
9061  For CVS it is simulated by adding the document under a new name and deleting the old one.
9062  For RCS it is not supported.
9063  Disabled if uncommitted changes exist.
9064 \end_layout
9065
9066 \begin_layout Description
9067 Syntax vc-rename <FILENAME>
9068 \end_layout
9069
9070 \begin_layout Description
9071 Params <FILENAME>:
9072  New name of the document.
9073 \begin_inset Newline newline
9074 \end_inset
9075
9076 A file dialog is opened if no filename is given.
9077 \end_layout
9078
9079 \begin_layout Description
9080 Origin gb,
9081  05 Feb 2013
9082 \end_layout
9083
9084 \begin_layout Subsection*
9085 vc-repo-update
9086 \end_layout
9087
9088 \begin_layout Description
9089 Action Update the local archive directory in which resides the current document with the remote repository.
9090 \end_layout
9091
9092 \begin_layout Description
9093 Syntax vc-repo-update
9094 \end_layout
9095
9096 \begin_layout Description
9097 Origin sanda,
9098  16 Oct 2009
9099 \end_layout
9100
9101 \begin_layout Subsection*
9102 vc-revert
9103 \end_layout
9104
9105 \begin_layout Description
9106 Action Reverts the document to the last check-in/commit in VCS.
9107 \end_layout
9108
9109 \begin_layout Description
9110 Syntax vc-revert
9111 \end_layout
9112
9113 \begin_layout Description
9114 Origin Lgb,
9115  1 Jul 1997
9116 \end_layout
9117
9118 \begin_layout Subsection*
9119 vc-undo-last
9120 \end_layout
9121
9122 \begin_layout Description
9123 Action Undo last check-in.
9124 \end_layout
9125
9126 \begin_layout Description
9127 Notion This is currently implemented only for RCS.
9128 \end_layout
9129
9130 \begin_layout Description
9131 Syntax vc-check-out
9132 \end_layout
9133
9134 \begin_layout Description
9135 Origin Lgb,
9136  1 Jul 1997
9137 \end_layout
9138
9139 \begin_layout Section
9140 Hidden Functions (not listed for configuration)
9141 \end_layout
9142
9143 \begin_layout Subsection*
9144 command-prefix
9145 \end_layout
9146
9147 \begin_layout Description
9148 Action Return the current key sequence and available options as a string.
9149 \end_layout
9150
9151 \begin_layout Description
9152 Notion No options are added if no current map exists.
9153 \begin_inset Newline newline
9154 \end_inset
9155
9156 This is probably usable only with connection to lyxserver.
9157 \end_layout
9158
9159 \begin_layout Description
9160 Syntax command-prefix
9161 \end_layout
9162
9163 \begin_layout Subsection*
9164 lyx-activate
9165 \end_layout
9166
9167 \begin_layout Description
9168 Action Activates the LyX window.
9169 \end_layout
9170
9171 \begin_layout Description
9172 Notion On Linux and Mac OS,
9173  this action brings the LyX window into focus.
9174  Such behavior is not allowed by Windows OS so instead the color of the taskbar entry is changed to indicate that the window has changed in some way.
9175  This action is useful in combination with reverse search.
9176 \end_layout
9177
9178 \begin_layout Description
9179 Syntax lyx-activate
9180 \end_layout
9181
9182 \begin_layout Description
9183 Origin skostysh,
9184  4 Aug 2016
9185 \end_layout
9186
9187 \begin_layout Subsection*
9188 self-insert
9189 \end_layout
9190
9191 \begin_layout Description
9192 Action Inserts the given string (accordingly to the correct keymap).
9193 \end_layout
9194
9195 \begin_layout Description
9196 Notion Automatically replace the currently selected text.
9197  Depends on lyxrc settings "auto_region_delete".
9198 \end_layout
9199
9200 \begin_layout Description
9201 Syntax self-insert <STRING>
9202 \end_layout
9203
9204 \begin_layout Subsection*
9205 window-raise
9206 \end_layout
9207
9208 \begin_layout Description
9209 Action Raises the LyX window.
9210 \end_layout
9211
9212 \begin_layout Description
9213 Notion Brings the LyX window to the front.
9214  Such behavior is allowed on Windows only when no other application has focus.
9215  This action is used when LyX is in single instance mode.
9216 \end_layout
9217
9218 \begin_layout Description
9219 Syntax window-raise
9220 \end_layout
9221
9222 \begin_layout Description
9223 Origin forenr,
9224  21 Apr 2020
9225 \end_layout
9226
9227 \end_body
9228 \end_document