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