Minimum Profit Configuration Directives
=======================================

The following configuration values can be set in the configuration files,
executed from the command line or from the `Execute MPSL code...' option in
the `Edit' menu. So, for example, if you always want automatic indentation,
word wrapping at column 75 and a special ispell command, you can add the
following MPSL code to `~/.mp.mpsl' or `/etc/mp.mpsl':

 mp.config.auto_indent = 1;
 mp.config.word_wrap = 75;
 mp.config.ispell_cmd = "aspell -a";

All configuration variables are in the `mp.config' hash.

mp.config.auto_indent
---------------------

Set to 1 if automatic indentation is wanted (default: 0, no indentation).

mp.config.auto_sessions
-----------------------

Set to 1 to automatically load / save sessions on startup / exit (default:
0, no automatic sessions).

mp.config.case_sensitive_search
-------------------------------

Set to 1 if searches are to be done in a case-sensitive way (default: 1).

mp.config.ctags_cmd
-------------------

The external command to be executed when a tag search is requested. By
default is `ctags *'. Other useful value is `ctags -R', that search for
tags recursively in subdirectories.

mp.config.eol
-------------

The end of line character (or characters). By default is "\n". Other useful
values are "\r\n" for MSDOS / Windows systems, or "\r" for legacy MacOS
systems.

mp.config.font_face
-------------------

The font face to be used in GUI environments. By default it's "Mono" on
KDE4 and GTK and "Lucida Console" on MS Windows.

mp.config.font_size
-------------------

The font size to be used in GUI environments. By defaults it's 12 on KDE
and GTK and 14 on MS Windows.

mp.config.global_replace
------------------------

Set to 1 if the _replace_ operation must be done to the end of the file
(default: 0, do it only once).

mp.config.ispell_cmd
--------------------

The external command to be executed as a pipe for spellchecking. It must be
compatible with `ispell', and by default it's "ispell -a". Other useful
values are "aspell -a", if you have `aspell' installed (a better
alternative), or "ispell -a -Tutf8", if you happen to be in an UTF-8
environment and must use `ispell'.

mp.config.local_sessions
------------------------

Set to 1 to store session information in the currently working directory
instead of in the home directory (default: 0, save sessions in the
home directory).

mp.config.mark_eol
------------------

If set to 1, end-of-line characters are marked with a special character,
instead of being invisible (default: 0, don't mark).

mp.config.maximize
------------------

Set to 1 if the GUI window must open maximized (default: 0, no maximize).

mp.config.move_seek_to_line
---------------------------

The line number to be set the cursor to when a successful search is hit
(default: 5). If set to 0, the position is not touched.

mp.config.preread_lines
-----------------------

The number of lines to read above the first visible line to calculate
syntax highlight in blocks (default: 60 lines). There is probably no
need to change this, unless using very big comment blocks or the like.

mp.config.recursive_grep
------------------------

If set, the `grep' action is done recursively (default: 0).

mp.config.rw_max_dist
---------------------

Used by the `seek_repeated_word' action as the maximum distance two
_similar_ words must be separated apart to be considered a repetition
(default: 40 words).

mp.config.rw_num_chars
----------------------

Used by the `seek_repeated_word' action as the number of characters
(from the start or the end) two words must match to be considered
_similar_ and taken into account for repetitions (default: 4
characters).

mp.config.status_format
-----------------------

The status format string to be shown in the status line. By default it's
"%m%n %x,%y [%l] %R%O %s %t", where each percent-value means:

 +----+---------------------------------------------------------+
 |Tag | Description                                             |
 +----+---------------------------------------------------------+
 | %V | Current MP version                                      |
 +----+---------------------------------------------------------+
 | %m | Modify flag (asterisk or the empty string)              |
 +----+---------------------------------------------------------+
 | %x | X coordinate (column)                                   |
 +----+---------------------------------------------------------+
 | %y | Y coordinate (line)                                     |
 +----+---------------------------------------------------------+
 | %l | Total number of lines in current document               |
 +----+---------------------------------------------------------+
 | %R | Macro recording flag (R or the empty string)            |
 +----+---------------------------------------------------------+
 | %O | Overwrite flag (O or the empty string if inserting)     |
 +----+---------------------------------------------------------+
 | %s | Syntax highlight in use                                 |
 +----+---------------------------------------------------------+
 | %t | Tag target over the cursor, or the empty string if none |
 +----+---------------------------------------------------------+
 | %n | Document name                                           |
 +----+---------------------------------------------------------+
 | %w | Number of words in the current document (or in the      |
 |    | current selection, if any). May be slow.                |
 +----+---------------------------------------------------------+
 | %% | A percent sign                                          |
 +----+---------------------------------------------------------+

mp.config.tabs_as_spaces
------------------------

Set to 1 if tabs must be converted to spaces (default: 0, no conversion).

mp.config.tab_size
------------------

Tab size in column spaces (default: 8).

mp.config.undo_levels
---------------------

Maximum number of undo levels per document (default: 100).

mp.config.unlink
----------------

Set to 1 if the file must be unlinked just before being overwritten
(default: 1, do it).

mp.config.word_wrap
-------------------

The column where word wrapping occurs (default: 0, no word wrapping).


----
Angel Ortega <angel@triptico.com>
