lib/doc/LFUNs.lyx

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