doc/mp_actions.txt

   1 Minimum Profit Action Reference
   2 ===============================
   3
   4 Minimum Profit _actions_ are editor commands that can be directly
   5 bound to the menu or a key.
   6
   7 about
   8 -----
   9
  10 _About..._
  11
  12 Shows the "About Minimum Profit" information.
  13
  14 build
  15 -----
  16
  17 _Build project..._ (`f2')
  18
  19 Invokes the building of a Make project. If the `Makefile' file exists in the
  20 working directory, all targets are extracted from it and shown in a list dialog
  21 for the user to select one. The selected one will be called as the only argument
  22 for the `make' program and its output read. All output will be catched and shown
  23 in a read-only document. Compiler errors and warnings will be highlighted and
  24 can be navigated by using the `seek_next' and `seek_prev' actions (keys `f3' and
  25 `ctrl-f3'). The `open_under_cursor' action can be used to edit each error or warning.
  26
  27 close
  28 -----
  29
  30 _Close_ (`ctrl-w')
  31
  32 Closes the active document. If there are unsaved changes, a confirmation dialog
  33 is shown.
  34
  35 close_all
  36 ---------
  37
  38 _Close all_
  39
  40 Closes all open documents.
  41
  42 complete
  43 --------
  44
  45 _Complete..._ (`ctrl-u')
  46
  47 Takes the (probably partial) word under the cursor and searches for words in
  48 the current document that start with it. If more than one is found, a list dialog
  49 is shown to make a selection. The word will be replaced with the selected one.
  50
  51 complete_symbol
  52 ---------------
  53
  54 _Symbol completion..._
  55
  56 Uses a similar approach than the `complete' action, but using the current _tags_
  57 file as the completion list. If no _tags_ file exist in the working directory,
  58 the *ctags* program is invoked to build it.
  59
  60 For other uses of the _tags_ file, see `find_tag'.
  61
  62 copy_mark
  63 ---------
  64
  65 _Copy block_ (`ctrl-c')
  66
  67 Copies the currently selected block to the clipboard.
  68
  69 cut_mark
  70 --------
  71
  72 _Cut block_ (`ctrl-x')
  73
  74 Copies the currently selected block to the clipboard and deletes the block.
  75
  76 delete
  77 ------
  78
  79 _Delete character_ (`delete')
  80
  81 Delete the character over the cursor.
  82
  83 delete_left
  84 -----------
  85
  86 _Delete character to the left_ (`backspace')
  87
  88 Deletes the character to the left of the cursor.
  89
  90 delete_line
  91 -----------
  92
  93 _Delete line_ (`ctrl-y')
  94
  95 Deletes the line under the cursor.
  96
  97 delete_mark
  98 -----------
  99
 100 _Delete block_
 101
 102 Deletes the currently selected block.
 103
 104 document_list
 105 -------------
 106
 107 _Document list_
 108
 109 Shows a dialog with the list of currently open documents. The list cursor will
 110 be over the active one and the documents with pending modifications will be
 111 prefixed with an asterisk. Selecting a different one will make it become the
 112 active.
 113
 114 encoding
 115 --------
 116
 117 _Set charset encoding..._
 118
 119 Shows a dialog asking for a string describing the charset encoding that will
 120 be used when saving or opening new documents. If an empty string is entered,
 121 the current locale will be used. the following set of character encodings are
 122 always available:
 123
 124  * utf8.
 125    Aliases are utf-8, UTF8 and UTF-8.
 126  * iso8859-1.
 127    Aliases are iso-8859-1, ISO-8859-1, ISO8859-1, latin1, latin-1, LATIN1 and LATIN-1.
 128  * utf16 (with endianness detection on input and local endianness on output).
 129    Aliases are utf-16, UTF16, UTF-16, ucs-2, UCS2, UCS-2.
 130  * utf16be (big endian).
 131    Aliases are utf-16be, UTF16BE, UTF-16BE, ucs2be, UCS2BE, ucs-2be and UCS-2BE.
 132  * utf16le (little endian).
 133    Aliases are utf-16le, UTF16LE, UTF-16LE, ucs2le, UCS2LE, ucs-2le and UCS-2LE.
 134  * utf32 (with endianness detection on input and local endianness on output).
 135    Aliases are utf-32, UTF32, UTF-32, ucs-4, ucs4, UCS-4 and UCS4.
 136  * utf32be (big endian).
 137    Aliases are utf-32be, UTF32BE, UTF-32BE, ucs4be, UCS4BE, ucs-4be and UCS-4BE.
 138  * utf32le (little endian).
 139    Aliases are utf-42le, UTF42LE, UTF-42LE, ucs4le, UCS4LE, ucs-4le and UCS-4LE.
 140
 141 If the 'iconv' library is available, there can be many more encodings.
 142
 143 eval
 144 ----
 145
 146 _Execute MPSL code..._ (`escape')
 147
 148 Shows a dialog asking for a string of MPSL code that will be executed.
 149
 150 eval_doc
 151 --------
 152
 153 _Execute document as MPSL_
 154
 155 Executes the active document as MPSL code.
 156
 157 exec_command
 158 ------------
 159
 160 _Run system command..._
 161
 162 Shows a dialog asking for a system command to execute. If the command is
 163 preceded by the pipe symbol (|), the active document will be fed as the
 164 standard input of the command; otherwise, the standard output of the command
 165 will be inserted in the cursor position.
 166
 167 exit
 168 ----
 169
 170 _Exit_ (`ctrl-q')
 171
 172 Closes all documents and exists Minimum Profit.
 173
 174 find_tag
 175 --------
 176
 177 _Search tag..._ (`ctrl-t')
 178
 179 Shows a dialog asking for a tag to search. The _tags_ file will be read from
 180 the working directory and the tag searched there; all symbols starting with it
 181 will be shown in a list dialog. When selecting a tag from that list, the file
 182 containing it will be open and the cursor moved to where the tag is.
 183 This is a useful way of finding where a function or variable is defined.
 184
 185 If no _tags_ file exist in the working directory, the *ctags* program is
 186 invoked to build it.
 187
 188 For other uses of the _tags_ file, see `complete_symbol'.
 189
 190 goto
 191 ----
 192
 193 _Go to line..._ (`ctrl-g')
 194
 195 Shows a dialog asking for a line number. If accepted, the current document
 196 cursor will move to that line (if existent).
 197
 198 grep
 199 ----
 200
 201 _Grep (find inside) files..._
 202
 203 Shows a dialog asking for a string to be searched, and an optional spec of
 204 files to search the string in. If no spec is given, all files in the working
 205 directory are scanned. Matches are shown in a read-only document, and each
 206 match can be directly open by using the 'open_under_cursor' action.
 207
 208 This is a useful way to find where a function or variable is used.
 209
 210 help
 211 ----
 212
 213 _Help on word over cursor_ (`f1')
 214
 215 Picks the word under the cursor and asks the underlying system for help
 216 about that term.
 217
 218 hex_view
 219 --------
 220
 221 _Hexadecimal viewer..._
 222
 223 Shows a dialog to open a read-only, hexadecimal view of a file.
 224
 225 ignore_last_misspell
 226 --------------------
 227
 228 _Ignore last misspelled word_
 229
 230 Ignores the last misspelled word found by `seek_misspelled' by adding it
 231 to a whitelist so it won't be found again.
 232
 233 insert_line
 234 -----------
 235
 236 _Insert line_ (`enter')
 237
 238 Inserts a new line. If the cursor is in the middle of a line,
 239 it's split in two.
 240
 241 insert_space
 242 ------------
 243
 244 _Insert space_ (`space')
 245
 246 Inserts a space, triggering word wrapping, if active.
 247
 248 insert_tab
 249 ----------
 250
 251 _Insert tab_ (`tab')
 252
 253 Inserts a tabulator, triggering word wrapping, if active.
 254
 255 insert_template
 256 ---------------
 257
 258 _Insert template..._
 259
 260 Shows a list dialog with the names of the templates for the user to
 261 select one, that will be inserted in the cursor position.
 262
 263 join_paragraph
 264 --------------
 265
 266 _Join a paragraph in one line_
 267
 268 Joins the text from the cursor position to the next empty line as one
 269 paragraph.
 270
 271 line_options
 272 ------------
 273
 274 _Line options..._
 275
 276 Shows a dialog asking for line configuration options, like word wrapping,
 277 end of line string, etc.
 278
 279 load_session
 280 ------------
 281
 282 _Load session_
 283
 284 Loads a session, previously saved by `save_session'.
 285
 286 mark
 287 ----
 288
 289 _Mark beginning/end of block_ (`f9')
 290
 291 Marks the beginning or the end of the block.
 292
 293 mark_vertical
 294 -------------
 295
 296 _Mark vertical block_ (`ctrl-b')
 297
 298 Marks the beginning or the end of a vertical (also known as
 299 rectangular) block.
 300
 301 menu
 302 ----
 303
 304 _Menu_ (`ctrl-a')
 305
 306 Calls the menu.
 307
 308 mouse_drag_mark
 309 ---------------
 310
 311 _Mark using mouse dragging_ (`mouse-drag')
 312
 313 This action is called by the underlying driver when the mouse is used to drag
 314 over text. It must not be called nor bound to a key.
 315
 316 move_bof
 317 --------
 318
 319 _Beginning of document_ (`ctrl-home')
 320
 321 Moves the cursor to the beginning of the document (first line, first column).
 322
 323 move_bol
 324 --------
 325
 326 _Beginning of line_ (`home')
 327
 328 Moves the cursor to the beginning of the current line (first column).
 329
 330 move_down
 331 ---------
 332
 333 _Line down_ (`cursor-down')
 334
 335 Moves the cursor to the next line.
 336
 337 move_eof
 338 --------
 339
 340 _End of document_ (`ctrl-end')
 341
 342 Moves the cursor to the last line of the document.
 343
 344 move_eol
 345 --------
 346
 347 _End of line_ (`end')
 348
 349 Moves the cursor to the end of the current line.
 350
 351 move_left
 352 ---------
 353
 354 _Character left_ (`cursor-left')
 355
 356 Moves the cursor one character to the left. If it's in the beginning of
 357 a line, moves to the last character of the previous line.
 358
 359 move_mouse_wheel_down
 360 ---------------------
 361
 362 _Mouse wheel down_ (`mouse-wheel-down')
 363
 364 Moves the cursor four lines down.
 365
 366 move_mouse_wheel_up
 367 -------------------
 368
 369 _Mouse wheel up_ (`mouse-wheel-up')
 370
 371 Moves the cursor four lines up.
 372
 373 move_pgdn
 374 ---------
 375
 376 _Page down_ (`page-down')
 377
 378 Moves the cursor a page down.
 379
 380 move_pgup
 381 ---------
 382
 383 _Page up_ (`page-up')
 384
 385 Moves the cursor a page up.
 386
 387 move_right
 388 ----------
 389
 390 _Character right_ (`cursor-right')
 391
 392 Moves the cursor one character to the right. If it's over the end of
 393 the line, moves to the first character of the next line.
 394
 395 move_to_mouse_position
 396 ----------------------
 397
 398 _Move cursor to mouse click_ (`mouse_left_button', `mouse_right_button', `mouse-middle-button')
 399
 400 Moves the cursor to where the mouse is. This action is called by the
 401 underlying system and must not be directly called nor bound to a key.
 402
 403 move_up
 404 -------
 405
 406 _Line up_ (`cursor-up')
 407
 408 Moves the cursor to the previous line.
 409
 410 move_word_left
 411 --------------
 412
 413 _Word left_ (`ctrl-cursor-left')
 414
 415 Moves the cursor to the beginning of the previous word.
 416
 417 move_word_right
 418 ---------------
 419
 420 _Word right_ (`ctrl-cursor-right')
 421
 422 Moves the cursor to the beginning of the next word.
 423
 424 new
 425 ---
 426
 427 _New_
 428
 429 Creates a new unnamed document.
 430
 431 next
 432 ----
 433
 434 _Next_ (`ctrl-n')
 435
 436 Select the next document as the active one. The list of documents
 437 is circular; if the active one is the last, the first one is selected.
 438
 439 open
 440 ----
 441
 442 _Open..._ (`ctrl-o')
 443
 444 Shows a dialog to open a file. Its behaviour and look are system-dependent.
 445
 446 If the document to be opened is password-protected, a dialog asking for the
 447 password will also appear.
 448
 449 open_config_file
 450 ----------------
 451
 452 _Edit configuration file_
 453
 454 Opens the user configuration file for editing. It doesn't have to exist.
 455
 456 open_dropped_files
 457 ------------------
 458
 459 _Open dropped files_ (`dropped-files')
 460
 461 Opens all files dropped by the user from an external file manager.
 462
 463 open_templates_file
 464 -------------------
 465
 466 _Edit templates file_
 467
 468 Opens the templates file for edition. Templates defined here can be later
 469 inserted by calling `insert_template'. See the `mp_templates.sample' file
 470 included in the documentation for an example of the accepted format.
 471
 472 open_under_cursor
 473 -----------------
 474
 475 _Open file under cursor_ (`ctrl-enter')
 476
 477 Picks the word in the current document under the cursor, accepts it as
 478 a document name and tries to open it. If it's in the format string:number,
 479 is accepted as a file name and a line number.
 480
 481 paste_mark
 482 ----------
 483
 484 _Paste block_ (`ctrl-v')
 485
 486 Pastes the text in the clipboard into the cursor position.
 487
 488 play_macro
 489 ----------
 490
 491 _Play macro_ (`f7')
 492
 493 Replays all keystrokes recorded during the previous _learning mode_,
 494 activated by a call to `record_macro'.
 495
 496 prev
 497 ----
 498
 499 _Previous_
 500
 501 Select the previous document as the active one. The list of documents
 502 is circular; if the active one is the first, the last one is selected.
 503
 504 record_macro
 505 ------------
 506
 507 _Record macro_ (`f10')
 508
 509 Toggles _learning mode_. When active, all keystrokes are recorded to
 510 further execute them by a call to `play_macro'.
 511
 512 redo
 513 ----
 514
 515 _Redo_
 516
 517 Redoes the previously undone operation, if any.
 518
 519 repeated_words_options
 520 ----------------------
 521
 522 _Repeated words options..._
 523
 524 Sets the options for the `seek_repeated_word' action.
 525
 526 replace
 527 -------
 528
 529 _Replace..._ (`ctrl-r')
 530
 531 Shows the search and replace dialog box.
 532
 533 revert
 534 ------
 535
 536 _Revert_
 537
 538 Reverts the active document to the state on disk.
 539
 540 save
 541 ----
 542
 543 _Save..._ (`ctrl-s')
 544
 545 Saves the active document. If it's unnamed, `save_as' is called instead.
 546
 547 save_as
 548 -------
 549
 550 _Save as..._
 551
 552 Shows a dialog asking for a file name to save the current document as.
 553 Its behaviour and look are system-dependent.
 554
 555 save_session
 556 ------------
 557
 558 _Save session_
 559
 560 Saves all documents and its positions as a session to be later loaded
 561 by `load_session'.
 562
 563 section_list
 564 ------------
 565
 566 _Section list..._ (`ctrl-d')
 567
 568 Shows a list with the sections found in the current document. Selecting
 569 one of them moves the cursor there.
 570
 571 seek
 572 ----
 573
 574 _Search text..._ (`ctrl-f')
 575
 576 Shows the search text dialog.
 577
 578 seek_misspelled
 579 ---------------
 580
 581 _Search misspelled word_ (`f5')
 582
 583 Searches for the next misspelled word in the current document. If one
 584 is found, the cursor is moved there. If it's a false positive, the
 585 `ignore_last_misspell' action can be called to add the recently found
 586 word to a whitelist so it won't be found again.
 587
 588 seek_next
 589 ---------
 590
 591 _Search next_ (`f3')
 592
 593 Searches the next occurrence of the string entered by the `seek' action.
 594
 595 seek_next_char
 596 --------------
 597
 598 _Move to next instance of current char_ (`ctrl-page-down')
 599
 600 Searches for the next occurrence of the char under the cursor. This is
 601 useful, for instance, to jump to the next paren or brace.
 602
 603 seek_prev
 604 ---------
 605
 606 _Search previous_ (`ctrl-f3')
 607
 608 Same as `seek_next', but searching backwards.
 609
 610 seek_prev_char
 611 --------------
 612
 613 _Move to previous instance of current char_ (`ctrl-page-up')
 614
 615 Searches for the previous occurrence of the char under the cursor. This is
 616 useful, for instance, to jump to the previous paren or brace.
 617
 618 seek_repeated_word
 619 ------------------
 620
 621 _Search repeated word_ (`f6')
 622
 623 Searches for repeated words. Controlled by the configuration directives
 624 `mp.config.rw_num_chars' and `mp.config.rw_max_dist'. A searching is done
 625 from the cursor position trying to find two words nearer from each
 626 other up to a maximum of the specified distance and that start or
 627 end with the same letters. If a pair is found, the words are
 628 highlighted as spelling errors and the cursor moved over the first
 629 one. Otherwise, a message marking the end is shown and nothing is done.
 630
 631 set_password
 632 ------------
 633
 634 _Password protect..._
 635
 636 Shows a dialog asking (twice) for a password to protect the active document with
 637 when it's saved. From that moment on, each time the document is tried to open
 638 the password will be asked for.
 639
 640 Minimum Profit encrypts documents using a variant of the ARCFOUR algorithm.
 641
 642 sync
 643 ----
 644
 645 _Save modified texts_
 646
 647 Saves all texts with pending modifications.
 648
 649 tab_options
 650 -----------
 651
 652 _Tab options..._
 653
 654 Shows a dialog asking for tabulator configuration options, like tab size,
 655 convert to spaces, etc.
 656
 657 toggle_spellcheck
 658 -----------------
 659
 660 _Toggle spellchecking_
 661
 662 toggles spellchecking. When active, misspelled words will be shown underlined.
 663
 664 undo
 665 ----
 666
 667 _Undo_ (`ctrl-z')
 668
 669 Undoes the last operation.
 670
 671 unmark
 672 ------
 673
 674 _Unmark block_ (`f8')
 675
 676 Unmarks the selected block.
 677
 678 word_count
 679 ----------
 680
 681 _Count words_
 682
 683 Counts the number of words and lines in the active document.
 684
 685 word_wrap_paragraph
 686 -------------------
 687
 688 _Word-wrap a paragraph_ (`f4')
 689
 690 Rebuilds the text from the cursor position to the following empty
 691 line using the wordwrapping setup. Wordwrapping must be set (see
 692 `line_options').
 693
 694 zoom_in
 695 -------
 696
 697 _Bigger font_ (`f12')
 698
 699 Selects a bigger font (only for GUIs).
 700
 701 zoom_out
 702 --------
 703
 704 _Smaller font_ (`f11')
 705
 706 Selects a smaller font (only for GUIs).
 707
 708
 709 ----
 710 Angel Ortega <angel@triptico.com>