lib/doc/LFUNs.lyx

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