lib/doc/LFUNs.lyx

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