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 config_repeated_words
  63 ---------------------
  64
  65 _Search repeated words..._
  66
  67 To be written.
  68
  69 copy_mark
  70 ---------
  71
  72 _Copy block_ (`ctrl-c')
  73
  74 Copies the currently selected block to the clipboard.
  75
  76 cut_mark
  77 --------
  78
  79 _Cut block_ (`ctrl-x')
  80
  81 Copies the currently selected block to the clipboard and deletes the block.
  82
  83 delete
  84 ------
  85
  86 _Delete character_ (`delete')
  87
  88 Delete the character over the cursor.
  89
  90 delete_left
  91 -----------
  92
  93 _Delete character to the left_ (`backspace')
  94
  95 Deletes the character to the left of the cursor.
  96
  97 delete_line
  98 -----------
  99
 100 _Delete line_ (`ctrl-y')
 101
 102 Deletes the line under the cursor.
 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 ignore_last_misspell
 219 --------------------
 220
 221 _Ignore last misspelled word_
 222
 223 Ignores the last misspelled word found by `seek_misspelled' by adding it
 224 to a whitelist so it won't be found again.
 225
 226 insert_line
 227 -----------
 228
 229 _Insert line_ (`enter')
 230
 231 Inserts a new line. If the cursor is in the middle of a line,
 232 it's split in two.
 233
 234 insert_space
 235 ------------
 236
 237 _Insert space_ (`space')
 238
 239 Inserts a space, triggering word wrapping, if active.
 240
 241 insert_tab
 242 ----------
 243
 244 _Insert tab_ (`tab')
 245
 246 Inserts a tabulator, triggering word wrapping, if active.
 247
 248 insert_template
 249 ---------------
 250
 251 _Insert template..._
 252
 253 Shows a list dialog with the names of the templates for the user to
 254 select one, that will be inserted in the cursor position.
 255
 256 join_paragraph
 257 --------------
 258
 259 _Join a paragraph in one line_
 260
 261 Joins the text from the cursor position to the next empty line as one
 262 paragraph.
 263
 264 line_options
 265 ------------
 266
 267 _Line options..._
 268
 269 Shows a dialog asking for line configuration options, like word wrapping,
 270 end of line string, etc.
 271
 272 load_session
 273 ------------
 274
 275 _Load session_
 276
 277 Loads a session, previously saved by `save_session'.
 278
 279 mark
 280 ----
 281
 282 _Mark beginning/end of block_ (`f9')
 283
 284 Marks the beginning or the end of the block.
 285
 286 mark_vertical
 287 -------------
 288
 289 _Mark vertical block_ (`ctrl-b')
 290
 291 Marks the beginning or the end of a vertical (also known as
 292 rectangular) block.
 293
 294 menu
 295 ----
 296
 297 _Menu_ (`ctrl-a')
 298
 299 Calls the menu.
 300
 301 mouse_drag_mark
 302 ---------------
 303
 304 _Mark using mouse dragging_ (`mouse-drag')
 305
 306 This action is called by the underlying driver when the mouse is used to drag
 307 over text. It must not be called nor bound to a key.
 308
 309 move_bof
 310 --------
 311
 312 _Beginning of document_ (`ctrl-home')
 313
 314 Moves the cursor to the beginning of the document (first line, first column).
 315
 316 move_bol
 317 --------
 318
 319 _Beginning of line_ (`home')
 320
 321 Moves the cursor to the beginning of the current line (first column).
 322
 323 move_down
 324 ---------
 325
 326 _Line down_ (`cursor-down')
 327
 328 Moves the cursor to the next line.
 329
 330 move_eof
 331 --------
 332
 333 _End of document_ (`ctrl-end')
 334
 335 Moves the cursor to the last line of the document.
 336
 337 move_eol
 338 --------
 339
 340 _End of line_ (`end')
 341
 342 Moves the cursor to the end of the current line.
 343
 344 move_left
 345 ---------
 346
 347 _Character left_ (`cursor-left')
 348
 349 Moves the cursor one character to the left. If it's in the beginning of
 350 a line, moves to the last character of the previous line.
 351
 352 move_mouse_wheel_down
 353 ---------------------
 354
 355 _Mouse wheel down_ (`mouse-wheel-down')
 356
 357 Moves the cursor four lines down.
 358
 359 move_mouse_wheel_up
 360 -------------------
 361
 362 _Mouse wheel up_ (`mouse-wheel-up')
 363
 364 Moves the cursor four lines up.
 365
 366 move_pgdn
 367 ---------
 368
 369 _Page down_ (`page-down')
 370
 371 Moves the cursor a page down.
 372
 373 move_pgup
 374 ---------
 375
 376 _Page up_ (`page-up')
 377
 378 Moves the cursor a page up.
 379
 380 move_right
 381 ----------
 382
 383 _Character right_ (`cursor-right')
 384
 385 Moves the cursor one character to the right. If it's over the end of
 386 the line, moves to the first character of the next line.
 387
 388 move_to_mouse_position
 389 ----------------------
 390
 391 _Move cursor to mouse click_ (`mouse_left_button', `mouse_right_button', `mouse-middle-button')
 392
 393 Moves the cursor to where the mouse is. This action is called by the
 394 underlying system and must not be directly called nor bound to a key.
 395
 396 move_up
 397 -------
 398
 399 _Line up_ (`cursor-up')
 400
 401 Moves the cursor to the previous line.
 402
 403 move_word_left
 404 --------------
 405
 406 _Word left_ (`ctrl-cursor-left')
 407
 408 Moves the cursor to the beginning of the previous word.
 409
 410 move_word_right
 411 ---------------
 412
 413 _Word right_ (`ctrl-cursor-right')
 414
 415 Moves the cursor to the beginning of the next word.
 416
 417 new
 418 ---
 419
 420 _New_
 421
 422 Creates a new unnamed document.
 423
 424 next
 425 ----
 426
 427 _Next_ (`ctrl-n')
 428
 429 Select the next document as the active one. The list of documents
 430 is circular; if the active one is the last, the first one is selected.
 431
 432 open
 433 ----
 434
 435 _Open..._ (`ctrl-o')
 436
 437 Shows a dialog to open a file. Its behaviour and look are system-dependent.
 438
 439 If the document to be opened is password-protected, a dialog asking for the
 440 password will also appear.
 441
 442 open_config_file
 443 ----------------
 444
 445 _Edit configuration file_
 446
 447 Opens the user configuration file for editing. It doesn't have to exist.
 448
 449 open_templates_file
 450 -------------------
 451
 452 _Edit templates file_
 453
 454 Opens the templates file for edition. Templates defined here can be later
 455 inserted by calling `insert_template'. See the `mp_templates.sample' file
 456 included in the documentation for an example of the accepted format.
 457
 458 open_under_cursor
 459 -----------------
 460
 461 _Open file under cursor_ (`ctrl-enter')
 462
 463 Picks the word in the current document under the cursor, accepts it as
 464 a document name and tries to open it. If it's in the format string:number,
 465 is accepted as a file name and a line number.
 466
 467 paste_mark
 468 ----------
 469
 470 _Paste block_ (`ctrl-v')
 471
 472 Pastes the text in the clipboard into the cursor position.
 473
 474 play_macro
 475 ----------
 476
 477 _Play macro_ (`f7')
 478
 479 Replays all keystrokes recorded during the previous _learning mode_,
 480 activated by a call to `record_macro'.
 481
 482 prev
 483 ----
 484
 485 _Previous_
 486
 487 Select the previous document as the active one. The list of documents
 488 is circular; if the active one is the first, the last one is selected.
 489
 490 record_macro
 491 ------------
 492
 493 _Record macro_ (`f10')
 494
 495 Toggles _learning mode_. When active, all keystrokes are recorded to
 496 further execute them by a call to `play_macro'.
 497
 498 redo
 499 ----
 500
 501 _Redo_
 502
 503 Redoes the previously undone operation, if any.
 504
 505 replace
 506 -------
 507
 508 _Replace..._ (`ctrl-r')
 509
 510 Shows the search and replace dialog box.
 511
 512 revert
 513 ------
 514
 515 _Revert_
 516
 517 Reverts the active document to the state on disk.
 518
 519 save
 520 ----
 521
 522 _Save..._ (`ctrl-s')
 523
 524 Saves the active document. If it's unnamed, `save_as' is called instead.
 525
 526 save_as
 527 -------
 528
 529 _Save as..._
 530
 531 Shows a dialog asking for a file name to save the current document as.
 532 Its behaviour and look are system-dependent.
 533
 534 save_session
 535 ------------
 536
 537 _Save session_
 538
 539 Saves all documents and its positions as a session to be later loaded
 540 by `load_session'.
 541
 542 section_list
 543 ------------
 544
 545 _Section list..._ (`ctrl-d')
 546
 547 Shows a list with the sections found in the current document. Selecting
 548 one of them moves the cursor there.
 549
 550 seek
 551 ----
 552
 553 _Search text..._ (`ctrl-f')
 554
 555 Shows the search text dialog.
 556
 557 seek_misspelled
 558 ---------------
 559
 560 _Search misspelled word_ (`f5')
 561
 562 Searches for the next misspelled word in the current document. If one
 563 is found, the cursor is moved there. If it's a false positive, the
 564 `ignore_last_misspell' action can be called to add the recently found
 565 word to a whitelist so it won't be found again.
 566
 567 seek_next
 568 ---------
 569
 570 _Search next_ (`f3')
 571
 572 Searches the next occurrence of the string entered by the `seek' action.
 573
 574 seek_next_char
 575 --------------
 576
 577 _Move to next instance of current char_ (`ctrl-page-down')
 578
 579 Searches for the next occurrence of the char under the cursor. This is
 580 useful, for instance, to jump to the next paren or brace.
 581
 582 seek_prev
 583 ---------
 584
 585 _Search previous_ (`ctrl-f3')
 586
 587 Same as `seek_next', but searching backwards.
 588
 589 seek_prev_char
 590 --------------
 591
 592 _Move to previous instance of current char_ (`ctrl-page-up')
 593
 594 Searches for the previous occurrence of the char under the cursor. This is
 595 useful, for instance, to jump to the previous paren or brace.
 596
 597 seek_repeated_word
 598 ------------------
 599
 600 _Search repeated word_ (`f6')
 601
 602 Searches for repeated words. Controlled by the configuration directives
 603 `mp.config.rw_num_chars' and `mp.config.rw_max_dist'. A searching is done
 604 from the cursor position trying to find two words nearer from each
 605 other up to a maximum of the specified distance and that start or
 606 end with the same letters. If a pair is found, the words are
 607 highlighted as spelling errors and the cursor moved over the first
 608 one. Otherwise, a message marking the end is shown and nothing is done.
 609
 610 set_password
 611 ------------
 612
 613 _Password protect..._
 614
 615 Shows a dialog asking (twice) for a password to protect the active document with
 616 when it's saved. From that moment on, each time the document is tried to open
 617 the password will be asked for.
 618
 619 Minimum Profit encrypts documents using a variant of the ARCFOUR algorithm.
 620
 621 sync
 622 ----
 623
 624 _Save modified texts_
 625
 626 Saves all texts with pending modifications.
 627
 628 tab_options
 629 -----------
 630
 631 _Tab options..._
 632
 633 Shows a dialog asking for tabulator configuration options, like tab size,
 634 convert to spaces, etc.
 635
 636 toggle_spellcheck
 637 -----------------
 638
 639 _Toggle spellchecking_
 640
 641 toggles spellchecking. When active, misspelled words will be shown underlined.
 642
 643 undo
 644 ----
 645
 646 _Undo_ (`ctrl-z')
 647
 648 Undoes the last operation.
 649
 650 unmark
 651 ------
 652
 653 _Unmark block_ (`f8')
 654
 655 Unmarks the selected block.
 656
 657 word_count
 658 ----------
 659
 660 _Count words_
 661
 662 Counts the number of words and lines in the active document.
 663
 664 word_wrap_paragraph
 665 -------------------
 666
 667 _Word-wrap a paragraph_ (`f4')
 668
 669 Rebuilds the text from the cursor position to the following empty
 670 line using the wordwrapping setup. Wordwrapping must be set (see
 671 `line_options').
 672
 673 zoom_in
 674 -------
 675
 676 _Bigger font_ (`f12')
 677
 678 Selects a bigger font (only for GUIs).
 679
 680 zoom_out
 681 --------
 682
 683 _Smaller font_ (`f11')
 684
 685 Selects a smaller font (only for GUIs).
 686
 687
 688 ----
 689 Angel Ortega <angel@triptico.com>