Simplified C section delimiters even more.
[mp-5.x.git] / doc / mp_man.txt
blob75617cd96f57eebb8ed2f5e750d03561e863774e
1 NAME
2 ----
4  mp-5 - Minimum Profit Editor, a text editor for programmers
6 SYNOPSIS
7 --------
9  mp-5 [options] [+NNN] [file [file...]]
11 DESCRIPTION
12 -----------
14 Minimum Profit (mp) is a text editor for programmers. Among its features
15 are the following:
17  - Fully scriptable using a C-like scripting language.
18  - Unlimited undo levels.
19  - Complete Unicode support.
20  - Multiple files can be edited at the same time and blocks copied
21    and pasted among them.
22  - Syntax highlighting for many popular languages / file formats: C, C++,
23    Perl, Shell Scripts, Ruby, Php, Python, HTML...
24  - Creative use of tags: tags created by the external utility _ctags_
25    are used to move instantaneously to functions or variables inside
26    your current source tree. Tags are visually highlighted (underlined),
27    and symbol completion can be triggered to avoid typing your own function
28    names over and over.
29  - Intelligent help system: pressing F1 over any word of a text being edited
30    triggers the underlying system help (calling _man_ when editing C or Shell
31    files, _perldoc_ with Perl, _ri_ on Ruby, _winhelp_ on MS Windows...).
32  - Understandable interface: drop-down menus, reasonable default key bindings.
33  - Configurable keys, menus and colors.
34  - Text templates can be easily defined / accessed.
35  - Multiplatform: Console/curses, Qt4, GTK+, KDE4, MS Windows.
36  - Automatic indentation, word wrapping, internal _grep_, learning /
37    repeating functions.
38  - Spellchecking support (via the ispell package).
39  - Multilingual.
40  - Password-protected, encrypted text files (using the ARCFOUR algorithm).
41  - It helps you abandon vi, emacs and other six-legged freaks definitely.
43 OPTIONS
44 -------
46 The following options are avaiable:
48  * -t tag: Edits the file where tag is defined (see ctags(1)).
49  * -e mpsl_code: Executes MPSL code.
50  * -f mpsl_script: Executes an MPSL script.
51  * -d directory: Changes working directory.
52  * -x file: opens file in the hexadecimal viewer.
53  * NNN: Moves to line number NNN of last file.
55 MPSL
56 ----
58 MPSL (Minimum Profit Scripting Language) is a powerful programming
59 language embedded in the Minimum Profit Text Editor (a huge part of the
60 editor itself is written in MPSL). Its features are too large to be
61 inserted here; please read the documentation.
63 AUTHOR
64 ------
66 *Minimum Profit* has been written by Angel Ortega <angel@triptico.com> with
67 the help of others (see the AUTHORS file for a complete list).
69 FILES
70 -----
72  * /etc/mp.mpsl (system-wide configuration file).
73  * ~/.mp.mpsl (user configuration file).
74  * ~/.mp_templates (user text templates).
76 ENVIRONMENT VARIABLES
77 ---------------------
79  * HOME (user home directory).
80  * LANG, LC_ALL (language settings).
82 SEE ALSO
83 --------
85 ctags(1).
87 The Minimum Profit documentation in /usr/share/doc/mp-5.
89 AUTHORS, TODO, RELEASE_NOTES and README.
91 Home page: http://www.triptico.com/software/mp.html
93 Mailing list: mp-subscribe@lists.triptico.com
95 LICENSE
96 -------
98 This  program  is free software; you can redistribute it and/or
99 modify it under the terms of the GNU General Public License as
100 published by the Free Software  Foundation; either version 2
101 of the License, or (at your option) any later version.
103 This program is distributed in the hope that it will be useful, but
104 WITHOUT ANY WARRANTY; without even the implied warranty of
105 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
107 See the GNU General Public License for more details.