lib/doc/LFUNs.lyx

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