lib/doc/LFUNs.lyx

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