lib/doc/LFUNs.lyx

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