lib/doc/LFUNs.lyx

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