mined

Cursor and screen motion

^E or cursor-up

Move cursor 1 line up.

... with HOP:

Go to top of page.

^X or cursor-down

Move cursor 1 line down.

... with HOP:

Go to bottom of page.

^S or cursor-left

Move cursor 1 character left.

... with HOP or Ctrl-Home

Go to beginning of line.

^D or cursor-right

Move cursor 1 character right.

... with HOP or Ctrl-End

Go to end of line.

^A or Shift-cursor-left (on small keypad)

Move word left (to preceding beginning of a word).

... with HOP:

Go to beginning of sentence.

^F or Shift-cursor-right (on small keypad)

Move word right (to beginning of next word).

... with HOP:

Go to end of sentence.

Ctrl-Shift-cursor-up

Move backward to previous beginning of paragraph.

Ctrl-Shift-cursor-down

Move forward to next beginning of paragraph.

Shift-cursor-up (on small keypad)

Go to top of page.

Shift-cursor-down (on small keypad)

Go to bottom of page.

^R or PgUp or PrevScreen (vt100)

Scroll backward 1 page (Top line becomes bottom line).

... with HOP:

Go to beginning of text.

^C or PgDn or NextScreen (vt100)

Scroll forward 1 page (Bottom line becomes top line).

... with HOP:

Go to end of text.

Home (on small keypad)

Move to beginning of line. →NEW→ If already there, move to beginning of previous line. Only if keyboard is configured to emit different control sequences for the two keypads, see Keypad configuration hints below.

Ctrl-Home (on small keypad)

Move to beginning of line.

End (on small keypad)

Move to end of line. →NEW→ If already there, move to end of next line. Only if keyboard is configured to emit different control sequences for the two keypads, see Keypad configuration hints below.

Ctrl-End (on small keypad)

Move to end of line.

Navigation support for combined Unicode characters

Enabling partial editing of base character and combining characters (accents) in combined display mode.

Ctrl-cursor-right or ^V cursor-right

Micro movement: Move partial character right into Unicode combined character.

Ctrl-cursor-left or ^V cursor-left

Micro movement: Move partial character left over Unicode combining character.

^W or Ctrl-PgUp

Scroll screen backward 1 line.

... with HOP:

Scroll backward half a screen.

^Z or Ctrl-PgDn

Scroll screen forward 1 line.

... with HOP:

Scroll forward half a screen.

^G nn or ESC g nn

Move to a line (prompts for line number). (Terminate command with Enter or Space.)

^G nn % or ESC g nn %

Move to position in text determined by percentage.

^G nn p or ESC g nn p

Move to page in text (set page length with ESC P).

^G < command > or ESC g < command >

If not immediately followed by a digit, the positioning command works as an alternative HOP key.

^G N '

(N=0..9) Go to marker N. ("'", "g", "." may be used.)

ESC ' N (deprecated)

(N=0..9) Go to marker N.

HOP Home or ^G ^@ or ^G ^] or HOP ESC ^

Move to the position previously marked by Home/^@/^]/ESC ^

ESC Enter or Alt-Enter (Alt-Return)

Return backward to the previous position marked in the position stack.

HOP ESC Enter or HOP Alt-Enter (HOP Alt-Return)

Return forward to the next position marked in the position stack.

^Q or ^G or "5" (on keypad) or Menu (in Linux)

HOP key (except ^G followed by a digit).
In order to enable the "5" key to invoke the HOP function, or assign the HOP function to another key (e.g. on laptops which lack the numeric keypad), some configuration may be necessary; see Keypad configuration below.

left mouse button

move cursor to position

Entering text

< printable char >

Insert the character at cursor position.

< Enter > or < LF Linefeed char > or < CR Return char >

Insert a newline at cursor position, clone line end type. Apply auto-indentation if enabled.

< Shift-Enter >

Make a new line by inserting a Unicode paragraph separator at cursor position (unless disabled with +u-u). (See also Unicode line ends for key configuration.)

< Ctrl-Enter >

Make a new line by inserting a Unicode line separator at cursor position (unless disabled with +u-u). (See also Unicode line ends for key configuration.)

< Tab char >

Insert a Tab character at cursor position. with option -+4 or -+8: Tab expansion; insert as many space characters as needed to fill line up to the next Tab position.

^V < Tab char >

Insert a Tab character (even in Tab expansion mode).

HOP {, HOP (, HOP [, HOP <

Enter indented pair of matching parentheses.

HOP /

Enter an indented Javadoc comment frame.

HOP '

Enter an apostrophe.

HOP -

Underline the line that starts before the cursor position.

^O

Make new line at current position. If the current line has a "NUL" or "NONE" special line end type, it will be reproduced for the new line. (Entering a new-line key always produces a real line end.) If the current line is terminated by a Unicode paragraph separator, a line separator is inserted.
Auto-indentation is not applied.

HOP ^O

Split a line in two binary-transparently, i.e. enter a "NONE" virtual line end.

Accented character input support by accent prefix keys

Mined defines a number of function keys, modified function keys,

modifed digit keys, and →NEW→ modified punctuation keys for single and multiple accent composition with a subsequently entered character; for a detailed listing and description, see Accent prefix function keys above.
→NEW→ Up to three accent prefix keys can be combined by entering them in sequence in order to compose characters with multiple accents. These functions also work on the prompt line (e.g. to enter search expressions).

F5 < character >

Compose character with diaeresis (umlaut accent), e.g. a » ä

Shift-F5 < character >

Compose character with tilde, e.g. a » ã

Ctrl-F5 < character >

Compose character with ring or with cedilla, e.g. a » å , c » ç

Ctrl-Shift-F5 < character >

Compose character with ogonek.

Alt-Shift-F5 < character >

Compose character with breve.

F6 < character >

Compose character with acute accent (accent d'aigu), e.g. a » á

Shift-F6 < character >

Compose character with grave accent, e.g. a » à

Ctrl-F6 < character >

Compose character with circumflex accent, e.g. a » â

Ctrl-Shift-F6 < character >

Compose character with macron.

Alt-Shift-F6 < character >

Compose character with dot above.

Ctrl-0 ... Ctrl-9

Compose character with accent, esp. for Vietnamese accented characters.

(Ctrl-)Alt-1 ... (Ctrl-)Alt-5

Compose character with two accents, esp. for Vietnamese double accented characters.

(Ctrl-)Alt-6 ... (Ctrl-)Alt-8

Compose character with two accents for Greek multiple accented characters.

Ctrl-< punctuation key >

→NEW→ Compose character with accent (looking similar to the modified punctuation character, e.g. Ctrl-, composes with cedilla, Ctrl-: with diaeresis, Ctrl-minus with macron, Ctrl-( with breve, Ctrl-< with caron, Ctrl-/ with stroke, Ctrl-; with ogonek, etc; see Accent prefix function keys above for details).

Input support commands

Ctrl-V special input support

These functions also work on the prompt line (e.g. to enter search expressions).

^V < control character >

Enter control character.

^V [ or ^V \ or ^V ]

Enter one of the control characters ^[, ^\, ^].

^V ^ ^ or ^V _ _

Enter one of the control characters ^^, ^_.

^V ^ ' or ^V ^ "

Enter one of the plain quote marks ' or " (needed in smart quotes mode)

^V < accent > < character >

Compose accented character.

^V # xxxx < Space or Enter >

Enter character defined by a hexadecimal number being input (depending on applicable encoding, byte value, Unicode value, or valid CJK code is required).

^V # # xxxxxx < Space or Enter >

Like ^V # but using an octal number.

^V # = xxxxx < Space or Enter >

Like ^V # but using a decimal number.

^V # u or U or +

(followed by a numeric input as described above, with optional # or = for octal or decimal input) interprets the input as a numeric Unicode value which is converted into the current text encoding.

^V # ... Space ...

With numeric character input, mined supports successive multiple character entry according to ISO 14755 if the numeric code is terminated by a Space key.

^V < function key >

This is not an input support function but rather the function key is invoked as if pressed together with the control key.

Mnemonic character input support

Mnemonics recognised include the following:

•

RFC 1345 mnemos (except mappings to Unicode private use areas); in ambiguous cases, the RFC 1345 mnemos must be entered in long mnemonic input mode, e.g. with "^V pi " rather than "^Vpi".

•

HTML mnemos; in ambiguous cases, the HTML mnemos must be prepended with a "&".

•

TeX mnemos (macros) and substitutes, leaving out any "\".

•

Supplementary mnemos as listed on the mined character mnemos page.

Unless there is an ambiguous mapping, all two-letter mnemonics can also be entered in reverse order.

^V < Space > < name > < Space or Enter >

Lookup character mnemonic and enter character. RFC 1345 mnemonics take precedence in ambiguous cases.

^V < character > < character >

Compose two characters. Non-RFC 1345 mnemonics take precedence in ambiguous cases.

Note:

→NEW→ A number of mnemonics are defined with already precomposed base characters (especially for Vietnamese input) which can be used for further composition.
^V can be applied recursively to compose a character for further composition.
See examples with æ below for both cases.

Examples:

^V^A

Enter Ctrl-A.

^V^[ or ^V[

Enter the escape character.

^V__

Enter Ctrl-_.

^V'e

Enter é (e with accent d'aigu).

^Vae

Enter æ (the ae ligature).

^V ae' (terminated by Space or Enter)

Enter U+01FD (æ with acute).

^Væ'

Enter U+01FD (æ with acute).

^V ^Vae' (terminated by Space or Enter)

Enter U+01FD (æ with acute).

^V'^Vae

Enter U+01FD (æ with acute).

^VOK or ^Vcm

Enter the check mark &#10003; (U+2713)

^Vzz or ^V zigzag (terminated by Space or Enter)

Enter the downwards zigzag arrow &#8623; (U+21AF)

^V-,

Enter ¬ (the negation symbol).

^V neg (terminated by Space or Enter)

Enter ¬ (the negation symbol).

^Va* or ^V a* (terminated by Space or Enter)

Enter the Greek small letter alpha.

^V ae' (terminated by Space or Enter)

Enter the Latin ligature ae with acute accent.

^V euro (terminated by Space or Enter)

Enter the Euro character.

^V#20ac (terminated by Space or Enter)

Enter the character with hexadecimal value 20AC (which is the Euro character in UTF-8 encoding).

^V#U20ac (terminated by Space or Enter)

Enter the Euro character (which has the hexadecimal Unicode value 20AC) encoded in the currently selected text encoding.

^V#+20ac < Space > +20ac < Enter >

Enter two Euro characters in successive multiple character entry mode (ISO 14755).

Input method (Keyboard mapping) selection

ESC k or Alt-F12 or middle click on Input Method flag (mapping indication in flags area)

toggles between current and previously selected input method (or initially the configured standby input method) Note: (Alt-k or Alt-F12 also works on prompt line)

HOP ESC k

clears input method, i.e. resets keyboard mapping to none (unmapped input)

ESC I or ESC K or Ctrl-F12 or right click on Input Method flag (mapping indication in flags area)

opens the Input Method selection menu Note: (Alt-I or Alt-K or Ctrl-F12 also works on prompt line)

HOP ESC K

cycles through available keyboard mappings / input methods

Modifying text

Note on character deletion

In order to accommodate various common ways of assigning control character codes to the Del and Backarrow keyboard keys, mined adjusts its own function assignment to the environment setting of the terminal interface, see Automatic backspace mode adaptation. (The ASCII DEL control character can be enforced to delete a character left with the option -B.)

Note on the Del key

Many people expect the "Home" and "End" keys to move the cursor to the beginning or end of line, respectively, and the "Del" key to delete the next character. In the keyboard usage approach of mined, this is a waste of keyboard resources as these functions can easily and quite intuitively be invoked with "HOP left" and "HOP right", i.e. by pressing the keypad keys "5 4" or "5 6" in sequence, and all these keys are available twice on typical keyboards. So there is enough room left for mapping the most frequent paste-buffer functions to the keypad as described above which is considered much more useful. Use Alt-Del (or ESC Del, or Ctrl-Del) to delete the next character, or use the -k option to switch keypad key function assignments for the Home, End, and Del keys. See Keypad layout above for a motivating overview of the mined keypad assignment features and options.

Backarrow or ^H

Delete character left. If there is only blank space before the current position in the current line and the line above, the auto-undent function (Back-Tab) is performed instead, deleting multiple spaces back to the previous level of indentation. Note: Mined tries to map this function to the Backarrow key on the keyboard whether it is assigned to the Backspace or DEL control characters, see note above.

Ctrl-Backarrow (if key properly configured) or F5 Backarrow

"Delete single": Delete only right-most combining accent of combined character left of cursor position. If not next to a combined character: delete character left, avoiding auto-undent function.

Del (on numeric keypad)

Cut selected area to paste buffer.

Del (on small keypad, if properly configured to be distinguished)

Delete character right, including any combining characters.

→NEW→

Ctrl-Del (both keypads, if key properly configured) Delete character right, excluding any combining characters.

Shift-Del (if key properly configured)

Cut selected area to paste buffer.

HOP Backarrow

Delete beginning of line (left of current position).

^B

Delete character right (next character).

^T

Delete next word.

^^ (overridden when used as accent prefix, e.g. with newer xterm)

Delete previous word.

^K

Delete tail of line (from current position to line-end); if at end of line, delete line end (joining lines).

HOP ^K

Delete whole line.

Code conversion

ESC X

Insert hexadecimal representation of current character code. (In UTF-8 mode, this is the UTF-8 byte sequence of the character in hexadecimal notation.)

... with HOP:

Insert character with hexadecimal code scanned from text at current position.

ESC U

Insert (hexadecimal) Unicode value of current character (with either 4/6/8 hexadecimal digits, depending on the value); in CJK or mapped 8 bit encoding mode, the value is transformed from the current text encoding into Unicode.

... with HOP or Ctrl-Shift-F11

Insert character with hexadecimal Unicode value scanned from text at current position; in CJK or mapped 8 bit encoding mode, the value is transformed from Unicode into the current text encoding.

ESC A

Like ESC U but inserting an octal Unicode value.

... with HOP:

Like HOP ESC U but scanning an octal Unicode value.

ESC D

Like ESC U but inserting a decimal Unicode value.

... with HOP:

Like HOP ESC U but scanning a decimal Unicode value.

Alt-x

→NEW→ Toggle the preceding character and its hexadecimal code. The command detects a 2 to 6 hex digit character code with a valid Unicode value, or a non-digit Unicode character, respectively.

Case conversion

ESC C or F11

Exchange case (low/capital) of character under cursor. Case mapping is based on Unicode (but applicable in all text encodings). Special handling is applied for: Greek final s, Turkish "i" if the effective locale environment variable (LC_ALL, LC_CTYPE, LANG) begins with "tr" or "az", case mappings to multiple characters, Lithuanian special conditions. Japanese characters are toggled between Hiragana and Katakana.

... with HOP or Shift-F11

Apply case conversion to word from cursor.

Shift-F3

Cycle casing of a word between all small, title case, and all capitals (title case means the first letter is either capital or actually a Unicode title case, the following letters are small). For Japanese script, it toggles the word between Hiragana and Katakana.

Mnemonic and special conversion

ESC _ or Ctrl-F11

Mnemonic character substitution replaces the two characters at the cursor position with a suitable composite character (e.g. accented character) if possible. With Ctrl-F11, transformations are the same as with the ^V two-letter character input mnemonics. With ESC _, language-dependent preferences may take precedence (see variations below) according to the current locale environment.
Example: ae->æ

Special conversion features

•

If the text at the cursor position contains an HTML character tag (starting with "&" and optionally ending with ";"), it is replaced with the actual character it represents.
Example: &amp;not;->¬

•

→NEW→ If the text at the cursor position contains an HTML numeric character entity (starting with "&#" and optionally ending with ";"), it is replaced with the respective character it denotes.
Example: &#x40;->@
&#64;->@

•

→NEW→ If the text at the cursor position contains a URL numeric escape notation (starting with "%") it is replaced with the actual character it represents.
Example: %40->@

•

The command also transforms between Latin-1 and UTF-8 encoded characters if an accordingly encoded character is found at the current position; the current character encoding mode is used to determine the target character set.
Example: æ (Latin-1 encoding)->æ (current UTF-8 encoding) or
æ (UTF-8 encoding)->æ (current encoding)

As variations of ESC _, there are some commands ESC LETTER using national letters that occur on respective national keyboards. They apply basically the same transformations but with some national preferences taking precedence:

ESC ä or ESC ö or ESC ü or ESC ß

Similar to ESC _, but with German transformation preferences.
example: ae->ä, oe->ö

ESC é or ESC è or ESC à or ESC ù or ESC ç

Similar to ESC _, but with French transformation preferences.
example: oe->&#339; (oe ligature U+0153)

ESC æ or ESC å or ESC ø

Similar to ESC _, but with Danish transformation preferences.
example: ae->æ, oe->ø

Encoding conversion

HOP ESC ( or Alt-F11

Search for a character encoded in the "wrong encoding", i.e. a UTF-8 character in non-UTF-8 text mode, or a Latin-1 character in UTF-8 text mode.

ESC _ or ESC ö etc.

If invoked on a non-ASCII character, UTF-8 / →NEW→ non-UTF-8 character encoding conversion is applied: If the character is not encoded in the current text encoding it is converted into the current text encoding (from UTF-8 or from Latin-1).

Alt-Shift-F11

Convert Latin-1 / UTF-8, then search for the next "wrong encoded" character.

Paragraph formatting

ESC j

("Clever Justify") Format paragraph by word-wrapping according to the currently set right margin value; left margins are derived from the contents of the paragraph and line. Heuristic detection of numbered items automatically triggers appropriate indentation.
End-of-paragraph is a line without trailing blank space.

... with HOP:

Same, but end-of-paragraph is considered to be a blank line.

ESC J

("Normal Justify") Format paragraph by word-wrapping according to the currently set left and right margin values.
End-of-paragraph is a line without trailing blank space.

... with HOP:

Same, but end-of-paragraph is a blank line.

ESC <

Set left margin for justification.

ESC ;

Set left margin of first line of paragraph only.

ESC :

Set left margin of next lines of paragraph only.

ESC >

Set right margin for justification.

HTML support

ESC H (every first time)

Enter HTML tag (and remember for subsequent ESC H). (Note that Alt-Shift-H will do the same thing if your terminal is configured appropriately - see the example configuration file Xdefaults.mined in the Mined runtime support library.) The tag can be entered with attributes and values; these will not be repeated in the closing tag (see next entry on ESC H).

ESC H (every second time)

Enter closing HTML tag. Any tag attributes and values entered with the tag (see previous entry on ESC H) will be left out.

HOP ESC H

Put text between mark and current position in HTML tags. The "A" tag gets special treatment.

Text block and buffer operations

Note on the Home, End, and Del keys

Many people expect the "Home" and "End" keys to move the cursor to the beginning or end of line, respectively, and the "Del" key to delete the next character. In the keyboard usage approach of mined, this is a waste of keyboard resources as these functions can easily and quite intuitively be invoked with "HOP left" and "HOP right", i.e. by pressing the keypad keys "5 4" or "5 6" in sequence, and all these keys are available twice on typical keyboards. So there is enough room left for mapping the most frequent paste-buffer functions to the keypad as described above which is considered much more useful. Use Alt- (or Ctrl-) with the Home, End, or Del keys for the line positioning and character deletion functions, depending on terminal support and configuration; or use the -k option to switch keypad key function assignments for the Home, End, and Del keys. See Keypad layout above for a motivating overview of the mined keypad assignment features and options.

^@ (Ctrl-Space)

or Home (on right keypad) or Shift-Home

or ^] or ESC @ or ESC ^

or Stop (sun)or Select (vt100)

Set mark (to remember the current location).

... with HOP:

Goto mark.

^Y

or End (on right keypad) or Shift-End

or Copy (sun) or Do (vt100)

Copy selected text (between mark and current position) to paste buffer.

... with HOP:

Append to buffer.

^U

or Del (on right keypad) or Shift-Del

or Cut (sun) or Remove (vt100)

Cut selected text (between mark and current position) to paste buffer.

... with HOP:

Append to buffer.

^P or Ins or Ctrl-Ins

or Paste (sun) or InsertHere (vt100)

Paste contents of buffer to current position.
With ^P or Ctrl-Ins, the cursor is placed before the pasted region. With Ins, the cursor is placed behind the pasted region unless the option -V was used.
In rxvt, with Ins on the left keypad, the cursor is placed before (left of) the pasted region.

... with HOP: (e.g. HOP Ins or ^G^P)

Paste from inter-window buffer. Thus you can quickly copy text from one invocation of mined to another.

Alt-Ins or Ctrl-F4

Replace text just pasted with preceding paste buffer. This command uses a ring of paste buffers (like emacs "yank ring").

^G N m or ESC g N ,

(N=0..9) Set marker N. (^G N , also works.)

ESC m N

(N=0..9) Set marker N.

^G N ' or ESC g N '

(N=0..9) Go to marker N. (^G N g or ^G N . also works.)

ESC ' N (deprecated)

(N=0..9) Go to marker N.

ESC b or Shift-F4

Copy contents of paste buffer into a file.

... with HOP:

Append to file.

ESC i or F4

Insert file at current position.

Print from File menu

Print text being edited (to default printer).

HOP ESC ! or (deprecated) ESC c

Invoke operating system command (prompted for) with paste buffer as input.

Search

Note on case-insensitive searching

→NEW→ Mined applies case-insensitive search pattern matching where the search pattern contains small characters, unless when searching for an identifier (current identifier occurence, HOP F8, or identifier definition, Alt-t). For a case-sensitive search for a small letter, use a single-letter range expression like [x] or a backslash escape like \x (note, however, that \n and \r have special meaning).

ESC / or Find or F7 or F8

Search forward (prompt for regular expression).

... with HOP:

Search for current identifier.

ESC \ or Alt-F7 or Alt-F8

Search backward (prompt for regular expression).

HOP F8 or Shift-F9

Search for current identifier.

HOP Alt-F8 or Alt-Shift-F9

Search for current identifier backward.

HOP Shift-F8 or ESC t or Alt-t

Search for definition of current identifier (using tags file). See ESC t below for further description.

HOP Ctrl-Shift-F8

Search for identifier definition (prompts for identifier).

HOP Ctrl-F8 or Ctrl-Shift-F9

Search for current character.

^N or F9

Search for next occurence (using previous search expression and direction).

... with HOP:

Repeat last but one search; two alternating search expressions can be used with this command.

Alt-F9

Search again (for last expression) but in the opposite direction.

ESC , or Shift-F8

(Global) Substitute (prompt for search and replacement strings).

ESC r or Ctrl-F8

(Global) Replace with confirmation prompting (first prompt for strings).

ESC R or Ctrl-Shift-F8

(Line Replace) Substitute on current line (prompt for strings).

ESC ( or ESC ) or ESC { or ESC }

Perform one of the following matching searches, depending on text: Search for corresponding bracket matching the bracket at current position in one of the pairs (), [], {}, <>, «». (Nested matching bracket pairs are skipped.) In an HTML or XML file, search for matching tag (nesting considered). Search for matching /* */ comment delimiter. Search for matching #if #else/#elif #endif structures (nesting considered). On an #else or #elif directive, the search direction depends on the command character, i.e. ESC ( searches backward, ESC ) searches forward. In a mailbox file, on any mail header line, search for next or previous mail message, depending on the command character, i.e. ESC ( searches backward, ESC ) searches forward. In a mailbox file or saved mail message, on a MIME separator, search for next or previous MIME separator, depending on the command character, i.e. ESC ( searches backward, ESC ) searches forward.

ESC t or HOP Shift-F8

Search for and move to the location of the definition of identifier at the current cursor position. This command uses the tags file that can be generated with the ctags command (Unix). It opens another file if necessary and automatically saves the current file then.
Like with a number of positioning commands, ESC t places the current position on the position marker stack before going to the location of the identifier definition. The command ESC Enter (Alt-Enter) can move back to that position, even if edited files were changed with the command.

HOP ESC t

Similar, but prompts for identifier.

HOP ESC ( or Alt-F11

Search for a character encoded in the "wrong encoding", i.e. a UTF-8 character in Latin-1 mode, or a Latin-1 character in UTF-8 mode.

Special functions in a search string

matches any character.

^

(at begin of pattern) restricts match to the begin of a line.

$

(at end of pattern) restricts match to the end of a line.

[< character set >]

matches any one of a set of characters; the set may be given by listing elements, denoting a range < c1 >...< c2 >, or negating the whole set [^< character set >].

\< character >

matches the character literally (except n or r).

< pattern >*

(a star appended to any one of the defined patterns) matches a (zero or more times) repetition of this pattern. In a final position within the search expression, however, it matches one or more times this pattern.

^V^J or \n

(a linefeed character or its representation) searches for newline embedded in the search pattern

→NEW→ \r

searches for DOS/Windows newline (CRLF) embedded in the search pattern

Special functions in a replacement string

&

is replaced by the matched pattern to be replaced.

^V^J or \n

(a linefeed character) embeds a newline (LF character) in the replacement string

\r

(a carriage return character) embeds a CR character in the replacement string

File operations

ESC w or F2

Save (write back) current text to file (only if modified).

... with HOP:

saves current file position in marker file @mined.mar, so that subsequent editing sessions will start at the current position and remember formatting parameters.

ESC W or Shift-F2

Save (write back) current text to file (unconditionally).

Alt-F2

Save As; save current text to file with different name; →NEW→ file permissions (access modes) are preserved and cloned.

Ctrl-Shift-F2 or HOP Shift-F2

Save to file, and enable memory for file positions in current directory; current file positions will always be saved in marker file @mined.mar so that subsequent editing sessions will start at the current position and remember formatting parameters.

F3

Edit another file (prompt for save if current text changed).

Ctrl-F3 or ESC v

View another file (prompt for save if current text changed).

ESC V

Toggle between edit mode and view only mode.

ESC q

Quit the editor (prompt for save if current text changed).

ESC ESC or Ctrl-F2

Exit editing current text (save first if changed), continue with next file if multiple files are being edited, otherwise exit mined. Note: There is a small delay after typing ESC ESC. (This is in order to enable recognition of Alt-function key combinations which are implemented by some terminals or terminal modes by prefixing ESC to the function key escape sequence.) This delay can be avoided by using Ctrl-F2.

ESC +

Edit the next file in the list of files being edited.

... with HOP:

Edit the last file in the list.

ESC -

Edit the previous file in the list of files being edited.

... with HOP:

Edit the first file in the list.

ESC #

Ask for index into the list of files and edit that file.

^G N # or ESC g N #

Edit Nth file. (^G N f also works.)

ESC # #

Reload file currently being edited.

Menu

ESC Space or Alt-Space or Shift-F10

Open Popup menu.

Alt-F10 or Ctrl-F10

Open first flag menu (Info menu).

ESC f or Alt-f or F10

Open File menu.

ESC < letter > or Alt-< letter >

Open menu.

ESC I or Alt-I or ESC K or Alt-K or Ctrl-F12

opens the Input Method selection menu (Alt-I/Alt-K/Ctrl-F12 also works on prompt line)

ESC Q or Alt-Q

opens the Smart Quotes selection menu

ESC E or Alt-E

opens the Encoding selection menu

Miscellaneous

ESC = < count >

Repeat a command < count > times (prompts for count). Example: ESC=7< cursor down > moves the cursor 7 lines down. Note: If the function to be repeated is a character to be inserted and the input is keyboard mapped to a multi-character sequence, only the first character of the sequence is inserted repeatedly.

ESC < count >

Repeat a command < count > times (prompts for rest of count); this short form is only accepted, however, if the repeat count consists of at least two digits (this is to avoid confusion with function key escape sequences of certain terminals). Example: ESC77. enters a line of 77 dots, ESC07x enters "xxxxxxx".

^V < function key >

Invoke function as if pressed together with the control key. E.g. ^V < cursor-left > moves left into the parts of a combined character just like Ctrl-cursor-left would do (the latter may depend on proper terminal setup).

^\

Abort current command, e.g. while on prompt line.

ESC ?

Show the current status of the file (name, whether modified, current line, number of lines, characters, and bytes).

... with HOP:

Toggle permanent display of text status line. Note that when editing a file that does not fit completely in memory (e.g. large file on old system), this option may cause considerable swapping. In that case, do not use the feature.

ESC u

Display the character code of the current character in the bottom status line. (In UTF-8 encoded text mode, both the UTF-8 byte sequence and the Unicode value are displayed; in CJK or mapped 8 bit encoded text mode, Han or 8 bit character values and corresponding Unicode values are displayed when applicable.) In non-Latin-1 encoded text mode, additional Unicode information is included, indicating the script, character category, width, combining, and surrogate properties of the character.

... with HOP:

Toggle permanent character code display.

ESC T

Toggle Tab width. Alternates the width interpretation of Tab characters between 4 and 8.

... with HOP:

Toggle Tab expansion (input substitution with spaces).

ESC P

Set page length (number of lines that mined assumes to be on a page). (Useful for status display.)

ESC a

Toggle append mode (append to text buffer/file instead of overwriting).

ESC d

Show current directory / change to another one (also change drive in MSDOS version).
The assumed (relative) file path name →NEW→ as well as file permissions (access modes) are preserved.

ESC n or Set Name... from File menu

Change the file name associated with the text being edited; the file is not actually saved yet but only the new file name is used for saving the next time. The text is detached from the file previously loaded which is not affected.
All current text editing properties (assumed encoding, smart quotes style, margins, ...) →NEW→ as well as file permissions (access modes) are preserved.

ESC .

Redraw the screen.

ESC l

Make screen lower (decrease number of screen lines).

ESC L

Make screen higher (increase number of screen lines).

ESC %

Make screen smaller (decrease screen size).

ESC &

Make screen bigger (increase screen size).

ESC z

Suspend editor process; first write back file if modified (no write if HOPped or given empty file name on prompting).

ESC !

Fork off a shell and wait for it to finish.

... with HOP:

Invoke operating system command (prompted for) with paste buffer as input.

F1 or Help or Alt-h or ESC h

Online help function. Selection of help topics is offered and prompted; after entering the initial letter, the respective help section is shown.
If another (modified) F1 key, a modified digit key, or a Ctrl-modified punctuation key is entered, a corresponding key assignment help bar is displayed (see F1 F1 etc. below).
The online help file mined.hlp is installed with the Mined runtime support library. If this is not installed in one of the standard locations, the environment variable MINEDDIR should be set to point to the directory so mined can find its online help file.

... with HOP:

If followed by a topic selection (initial letter after prompt), view online help with mined (in read-only mode) by opening the online help file (instead of invoking the "less" viewer) and positioning to the selected help topic.
Before opening the help file, the text being edited is automatically saved (if it was modified) and any prompting required will be performed. The suspended editing session will automatically be restored after help viewing is finished.

F1 F1 or Shift-F1 or Ctrl-F1 or Alt-F1 or Ctrl-Shift-F1 or Alt-Shift-F1

Display a help bar (in the bottom status line) with short indications of the functions assigned to the function keys F2... in the corresponding modified mode (i.e. with Control, Shift, and Alt as requested for the help bar).

... with HOP:

Toggle permanent help bar display.

F1 Ctrl-1 or F1 Alt-1 or F1 Alt-Ctrl-1

→NEW→ Display a help bar (in the bottom status line) with short indications of the accent prefix functions assigned to the digit keys 1..9, 0 in the corresponding modified mode (i.e. with Control and Alt as requested for the help bar).

... with HOP:

Toggle permanent help bar display.

F1 Ctrl-< punctuation key > e.g. F1 Ctrl-,

→NEW→ Display a help bar (in the bottom status line) with short indications of the accent prefix functions assigned to the Ctrl-modified punctuation keys.

... with HOP:

Toggle permanent help bar display.

ESC

While a command is active and prompting (e.g. for a search expression), ESC aborts the current command.

ESC Space

Do nothing, so the Space key aborts the ESC command.

MSDOS only

Ctrl-Alt-Space

Set mark (to remember the current location).

F1 or ESC h

If followed by a topic selection (initial letter after prompt), view online help with mined (like HOP F1).

Screen size change functions

MSDOS screen size changes depend on a mode table contained in the source file keydefs.c.
In the presence of a TSR driver which can change fonts and screen modes while running a program (e.g. the excellent VGAMAX), the actual change effective may occasionally be unexpected. Mined does however recognise those changes and adjusts its conception of screen size appropriately, although only after the next character being input.

Alt\-\- (on keypad)

Change video lines mode to the mode with the next smaller number of lines but same number of columns. (The number of lines is first tried to be decreased within the current video mode. If it is already the lowest, the next video mode is chosen.)

Alt-+ (on keypad)

Change video lines mode to the mode with the next higher number of lines but same number of columns.

Ctrl\-\- (on keypad)

Change video mode to the mode with the next smaller total resolution (lines * columns).

Ctrl-+ (on keypad)

Change video mode to the mode with the next higher total resolution.

Alt-/ (on keypad)

Switch between highest and lowest line number modes within the current basic screen mode.

Ctrl-/ (on keypad)

Cycle through all line number modes within the current basic screen mode.

HOP Ctrl-/Alt- +/- (on keypad)

Several other video mode settings are prompted for (experimental).

emacs mode

•

The mined ESC commands can be reached via M-x. (Function keys remain unaffected.)

•

The Del key (on the small keypad) is configured to delete the previous character.

•

The control key insertion prefix is ^Q.

•

The quit character (e.g. for the prompt line) is ^G.

•

The emacs multiple buffer ring is fully enabled.

•

Paragraph justification mode is set to consider an empty line as paragraph separation by default.

•

Mined ESC commands can be reached via M-x (Alt-X).

•

^\ (Ctrl-\) is interpreted as an additional HOP key.

•

Keyboard mapping (input method) can be toggled with Alt-F12

Command overview:

^A, ^B, ^E, ^F, ^N, ^P, ^V, M-v, M-b, M-f, M-a, M-e, M-< , M->, ^X[, ^X]

cursor and screen movement

^D

delete character

^O

insert new line

^Q

insert literal character

^@

mark position

^W / M-w

cut / copy to buffer

^K

delete to end of line / delete line end, and append to buffer

M-d / M-k

delete word / delete end of sentence, and append to buffer

^Y

paste buffer

M-y

paste previous buffer, replacing text just pasted

M-u

transform word upper-case

M-l

transform word lower-case

M-c

transform word capitalised (initial upper-case)

^S, ^R

search forward / reverse

M-%

replace with confirmation

M-.

search for identifier definition (using tags file)

^X^S, ^Xs

save file

^X^W

save file as (using different name)

^X^F

edit other file (prompts for name)

^X^B

edit previous file (among those listed on command line)

^X^C

quit editor, prompt for saving text first

^Xk

discard current edit buffer (after confirmation), open new one

^Xi

insert file

^X=

display file statistics

^L

refresh display

^U, ^X^[

repeat (not as generic numeric command parameter)

^H

help

^Z, M-z, ^X^Z

suspend editor

^\ (mined add-on)

HOP (generic function amplifier / modifier)

M-x (Deprecated mined add-on)

invoke mined ESC command

ESC ESC (mined add-on)

invoke mined ESC command

WordStar mode

^S, ^D, ^E, ^X, ^A, ^F, ^R, ^C, ^W, ^Z, ^H

cursor and screen movement

^G

delete character

^T

delete word

^Y

delete line

^Q^Y

delete to end of line

^N

insert new line

^P

insert control character

^Q^W, ^Q^Z

scroll multiple screen lines

^Q^F

find

^Q^A

find and replace (with HOP: with confirm)

^L

repeat last search

^Q

HOP key

^Q, ^K, ^O

two-key command prefixes

^Q^Q

repeat following command

^B

paragraph justification (word wrap)

^OL

set left margins

^OG

set left margin for first line of paragraph

^OR

set right margin

^KB

set marker

^QB

goto marker

^Kn

(n=0..9) set marker n

^Qn

(n=0..9) goto marker n

^KK

copy between here and marker (not exactly WS function)

^KC

copy (paste) saved text here (not exactly WS function)

^KY

delete between here and marker (not exactly WS function)

^KV

copy (paste) saved text here (not exactly WS function)

^KW

write paste buffer to file

^KR

read (insert) file here

^KS

write (save) edited text to file

^KD

write (save) edited text to file, edit next file

^KX

exit (and save)

^KQ

quit (don't save)

^KL

change current directory

Environment interworking and configuration hints

Mined runtime support library

Mined runtime support includes the following files:  

Package documentation

package_doc/README

mined package overview and introduction

package_doc/VERSION

version of the installed mined release

package_doc/CHANGES

mined change log

package_doc/LICENSE.GNU

the GNU license applicable to mined

Web documentation

doc_user/*

copy of the web documentation including the HTML version of the mined manual page

Online help

help/mined.hlp

online help file

Example files: environment configuration patterns

conf_user/profile.mined

shell commands to set environment variables for mined, template for inclusion in $HOME/.profile

conf_user/Xdefaults.mined

xterm configuration entries suitable for mined, template for inclusion in $HOME/.Xdefaults or $HOME/.Xresources

conf_user/xinitrc.mined

shell commands to activate Xdefaults.mined, template for inclusion in $HOME/.profile

conf_user/kp5

shell script to assign the X key symbol Menu to the middle keypad key ("5") as a remedy to the inability of the KDE konsole terminal to recognise that key (due to a deficieny in the QT framework), thus enabling the HOP key in konsole

conf_user/mlterm/main

mlterm configuration to enable Alt-key detection, for inclusion in $HOME/.mlterm/main

conf_user/mlterm/key

mlterm configuration for modified (shifted etc) function keys, for inclusion in $HOME/.mlterm/key

conf_user/konsole/xterm-modified.keytab

KDE konsole keyboard configuration providing a terminal (called "xterm with key modifiers" in the konsole menu) with modified (shifted etc) function keys

Scripts to be used at runtime

bin/uprint

script for printing a Unicode file, using either paps or uniprint for formatting; under Windows, it can also use notepad /p for printing

bin/minedmar

script to clean up the @mined.mar file position file

bin/minedmar.bat

DOS/Windows version of minedmar

Scripts to start mined

bin/uterm

script to invoke xterm in UTF-8 mode; it should also be installed into the system binary path and has its own manual page

bin/mterm

script to invoke mlterm with suitable options (for bidi support)

bin/umined

script to start mined in a separate xterm window, using UTF-8 mode with most recent version of Unicode width data (specifying wide and combining characters) as built-in to xterm

bin/xmined

script to start mined in a separate xterm window, using same encoding mode as currently set

bin/wined

script to start mined in a separate terminal on Windows without X Window System (using MinTTY if available, or rxvt), applying Windows look-and-feel

bin/wined.bat

Windows command script version of wined

Files to setup a mined installation

setup_install/mined.desktop

KDE desktop entry to start mined in an xterm from a menu entry, using the uterm script

setup_install/mined.ico

Cygwin/X desktop icon for adding mined to the Cygwin-X Editors section in the Windows Start menu

Scripts to configure an environment for mined

setup_install/bin/configure-xterm

sample configuration script to build xterm with recommended configuration options

setup_install/bin/makeprint

script to search for or retrieve and build the uniprint program from the yudit package

setup_install/bin/installfonts

script for downloading the Unicode-enhanced X screen fonts and installing them with your X server

setup_install/bin/bdf18to20

script to transform an 18x18 pixel double-width screen font into a corresponding 20x20 pixel font matching the 10x20 single-width font (which is much nicer than the 9x18)

setup_install/bin/mkicon

script to install mined with Cygwin/X by creating an entry (with icon) in the Cygwin-X Editors section in the Windows Start menu

setup_install/bin/postinstall

script to invoke mkicon after installation on Cygwin

Terminal environment

Recognition of some special terminal features or restrictions is associated with the setting of TERM (xterm, linux, vt100, sun*, cygwin, rxvt, *ansi*, 9780*, hp*, xterm-hp, superbee*, sb*, microb*, scoansi*, xterm-sco, cons*, att605-pc, ti_ansi, mgterm). Non-trivial screen features (like scroll reverse, add/delete line, erase multiple characters) are used if their support is indicated in the termcap/terminfo description of the terminal unless other information is available (e.g. after terminal version detection, an older xterm is supposed not to support erase characters). Since colour support is often not configured within terminfo but modern terminals do support it, mined always tries to apply colour attributes (if the terminal at least supports ANSI control sequences). A number of other "best practice" approaches are taken to optimize the usage of terminal capabilities, esp. covering different methods of graphics display support (for menu borders).

For detection of function keys and cursor keys, the escape sequences being used by terminals are often not known to an operating system environment because they are poorly and incompletely configured. Because this does usually not work as expected (see this bug report just for an example), mined does not rely on the termcap/terminfo configuration of function key codes alone (which it considers however since mined 2000.14); rather it always accepts a wide variety of typical codes. A few ambiguous codes are resolved according to the TERM variable.

In an xterm, window headline and icon text are set to the current filename and "(*)" is added if the text has been modified.  

Locale configuration

•

For text encoding, mined checks the variables TEXTLANG, LC_ALL, LC_CTYPE, LANG in this order.

•

For terminal encoding, mined checks the variables LC_ALL, LC_CTYPE, LANG in this order.

•

Explicit command line parameters are available to specify either terminal encoding (+E) or text encoding (-E). They override environment variable settings.

•

UTF-8 terminal auto-detection overrides other terminal encoding settings.

•

Text encoding auto-detection overrides environment settings but not command line settings.

•

Assumed text encoding can be switched while editing.

For encoding recognition from locale environment variables, mined recognises locale specifications typically found in system installations, including those which do not include an explicit encoding suffix. Known character encoding suffixes ("codeset" component of locale name, starting with ".") are recognised regardless of whether the given locale is installed or not. Other encodings are recognised by region suffix (starting with "_") or full locale name or alias.
In addition to hard-coded locale recognition (especially for CJK), locale values and associated encodings are configured in the compile-time configuration file locales.cfg which especially lists locale names that do not have an explicit encoding suffix. You can use these settings (known locale name or generic locale name suffix) even on legacy systems without locale support to indicate the terminal environment properly to mined. For encoding recognition from command-line parameters, mined provides three options:

•

-EX or +EX with a single-letter encoding tag as listed with the description of the -E options; further encoding tags are configured in the compile-time configuration file charmaps.cfg.

•

-E=charmap or +E=charmap with a character encoding name (as reported by the locale charmap command).

•

-E.suffix or +E.suffix with a character encoding suffix ("codeset" of locale name).

•

-E:flag or +E:flag with a 2-letter indication used by mined to indicate the respective text encoding in the Encoding flag.

In each of these options, -E specifies

text encoding while +E would specify terminal encoding to be assumed.

The following table lists major encodings and generic locale suffix values by which they are recognised; in addition (as mentioned above), a large number of locale names without encoding suffix as found on various systems in known to mined and will cause it to assume the corresponding terminal encoding.

Unicode: UTF-8

suffixes: .UTF-8 / .utf8

Traditional Chinese (Hongkong): Big5 with HKSCS

suffixes: .BIG5* / .Big5* / .big5* / _HK / _TW (_TW ambiguous, following encoding overrides)

Simplified Chinese: GB18030 (includes GBK and GB2312)

suffixes: .GB* / .gb* / .EUC-CN / .euccn / _CN.EUC / _CN

Traditional Chinese (Taiwan): CNS (EUC-TW)

suffixes: .EUC-TW / .euctw / .eucTW / _TW.EUC

Japanese: JIS / EUC-JP

suffixes: .EUC-JP / .eucjp / .eucJP / .ujis / _JP.EUC / _JP / .euc (.euc ambiguous, more specific string overrides)

Japanese: Shift-JIS

suffixes: .Shift_JIS / .shiftjis / .sjis / .SJIS

Korean Unified Hangul: UHC (includes EUC-KR)

suffixes: .UHC / .EUC-KR / .euckr / .eucKR / _KR.EUC / _KR

Korean: Johab

suffixes: .JOHAB

Vietnamese: VISCII

suffixes: .viscii

Vietnamese: TCVN

suffixes: .tcvn

Thai: TIS-620

suffixes: .tis* / .TIS* / _TH / .iso8859[-]11 / .ISO8859[-]11

Latin-9: ISO 8859-15

suffixes: @euro / .iso8859[-]15 / .ISO8859[-]15

Cyrillic: ISO 8859-5

suffixes: @cyrillic (unless preceded by uz_UZ which indicates UTF-8)

Latin or other: ISO 8859 encodings

suffixes: .iso8859[-]N / .ISO8859[-]N (with number N)

Russian Cyrillic: KOI8-R

suffixes: .koi8r

Ukrainian Cyrillic: KOI8-U

suffixes: .koi8u

Tadjikistan Cyrillic: KOI8-T

suffixes: .koi8t

Russian, Ukrainian, Bjelorussian Cyrillic: KOI8-RU

suffixes: .koi

MacRoman:

suffixes: .roman

Windows Latin: CP1252

suffixes: .cp1252

Windows Cyrillic: CP1251

suffixes: .cp1251

PC Latin: CP850

suffixes: .cp850

Windows Hebrew: CP1255

suffixes: .cp1255

Georgian: Georgian-PS

suffixes: .georgianps

Kazachstan Cyrillic: PT154

suffixes: .pt154

Examples: To indicate that mined is running in a

LC_ALL=whatever.UTF-8 TEXTLANG=zh_CN.gbk mined

LC_CTYPE=whatever.UTF-8 TEXTLANG=chinese mined

LANG=whatever.UTF-8 mined -EG

LC_ALL=en_IN mined -E.gbk

mined +EU -E.EUC-CN

mined +EU -E=GB18030

mined +EU -E:GB

Selecting UTF-16 text mode: To tell mined to interpret a file (or make a new file) in UTF-16 encoding, use the following command line options (first two little endian, then big endian):

mined -E:61

mined -E=UTF-16LE

mined -E:16

mined -E=UTF-16BE

mined -E=UTF-16

Selecting ASCII terminal mode: To tell mined to assume that a terminal cannot display anything but ASCII characters, use the command line option +E:AS. Mined implicitly assumes this setting if the environment variable TERM indicates a VT52 terminal.  

PC terminals

The following assumptions are made based on environment variables or command-line parameters:

encoding ("codepage")

environment
option
examples

CP850 (PC mapping of Latin-1 character set)

TERM=ansi, ansi-nt, pcansi*, hpansi*, interix* or TERM=cygwin and CYGWIN contains "codepage:oem" or LC_*/LANG indicates ".CP850"
+EP

•

Windows console (DOS prompt) window

•

Windows console mode telnet (even if called from cygwin console, sets TERM=ansi)

CP437 (IBM PC VGA encoding)

TERM=nansi*, ansi.*, opennt*, *-emx* or LC_*/LANG indicates ".CP437"
+Ep

•

plain DOS

CP1252 (Windows ANSI extension of Latin-1)

TERM=cygwin (unless LC_*/LANG or CYGWIN indicates other encoding)
+EW

•

cygwin console (emulation in Windows console window)

•

cygwin telnet/rlogin called directly from Windows console window (see note below for remote setting)

•

cygwin mined called directly from Windows console window

•

older Windows GUI telnet (sets TERM=ansi)

UTF-8

LC_*/LANG indicates ".UTF-8" or (for cygwin 1.7 beta) TERM=cygwin and CYGWIN contains "codepage:utf8"
+U
→NEW→

•

cygwin 1.7 console or application configured for UTF-8 mode

•

Note: Windows console in UTF-8 mode provides extended Unicode font support if you select "Lucida Console" TrueType font from its Properties menu.

→NEW→ other codepages

LC_*/LANG indicates codepage, e.g. ".CP1250" or ".CP858"
or triggered by DOS codepage information (djgpp version, see note)
+E=CP1250 or other codepage, or respective shortcut
→NEW→

•

cygwin 1.7.0-45 console or cygwin 1.7.0-46 application configured for respective codepage

Note: It is not unlikely that the assumption about the terminal encoding taken by mined does not match the actual terminal encoding (e.g. mined cannot determine the encoding based on the ambiguous setting TERM=ansi). Environment variables that indicate the character encoding are unfortunately not maintained through telnet or remote login.
Explicitly setting TERM to a suitable value after remote login or explicitly setting the locale variables, e.g. LC_CTYPE, may help but may not always work either (e.g. pcansi is not a known terminal on SunOS; some systems like SunOS are dogmatic about interpreting locale variables which strictly need to be installed before; not all encodings, esp. PC "codepages", are known as a "locale charmap" on other systems).
In these cases, you can use the explicit +E option to force mined to assume a specific terminal encoding; see the option values listed above for the main DOS encodings.

Note: The encoding emulated by cygwin (as configured, by default Windows Latin codepage CP1252) is not the encoding natively applied by the Windows console window (by default DOS codepage CP850). This means that the effective encoding may be different if you invoke the cygwin-compiled mined version and the djgpp-compiled mined version alternatingly; you may notice this by a different range of characters that can be displayed when opening the same file with the two mined versions.
Some Windows Latin characters are poorly displayed by the Windows console in default configuration; mined 2000.13 introduced a workaround to indicate those character by a more suitable substitution instead. →NEW→ This workaround is withdrawn to support cygwin 1.7 which can display all characters properly if the Windows console font is configured to "Lucida Console" rather than "Raster Fonts".

Note: →NEW→ The following DOS codepages are supported; they are mainly provided as terminal codepages, they do not appear in the Encoding menu. However, if you need, you can ask mined to use them as either the assumed terminal encoding (e.g. +E=CP1250 or +E:WE) or even text encoding (e.g. -E=CP1250 or -E:WE) using the names or shortcuts from the list:

CP437

PC
DOS US

CP737

37
DOS Greek

CP775

75
DOS Baltic

CP850

PL
DOS Western European

CP852

52
DOS Central European

CP853

53
South European, Esperanto

CP855

55
DOS Cyrillic

CP857

57
DOS Turkish

CP858

58
DOS Western, CP850 with Euro symbol

CP860

60
DOS Portuguese

CP861

61
DOS Icelandic

CP862

62
DOS Hebrew

CP863

63
DOS French Canadian

CP864

64
DOS Arabic

CP865

65
DOS Nordic

CP866

66
DOS Russian

CP869

69
DOS Modern Greek

CP874

TI
Windows Thai, superset of ISO-8859-11/TIS-620

CP1125

25
DOS Ukraine

CP1250

WE
Windows Central European

CP1251

WC
Windows Cyrillic

CP1252

WL
Windows Western European

CP1253

WG
Windows Greek

CP1254

WT
Windows Turkish

CP1255

He
Windows Hebrew

CP1256

WA
Windows Arabic

CP1257

WB
Windows Baltic

Note: For the djgpp version of mined, even the font chosen for the Windows console window may affect the effective display encoding. Configure "Raster Fonts" (except of size "10 x 20"!), not "Lucida Console" in order to make sure the effective visual codepage is the same as the one selected with the respective DOS tools (e.g. chcp) and assumed by mined.

Note: The djgpp version of mined running in a UTF-8 mode console (e.g. with cygwin 1.7) cannot handle this and is confused by the according setting of locale variables.

Note: →NEW→ Mined (djgpp) tries to determine the DOS/Windows codepage using the DOS API; this can only work if the codepage was properly configured with DOS means (e.g. with CP858 using CHCP 858 or MODE CON CP SELECT=858, maybe enabled by DEVICE=...\DISPLAY.SYS CON=(EGA,858) on old DOS, or MODE CON CP PREP=((codepage list) ...\ega.cpi) ); if only the font is switched to a differently encoded one, there is no way to detect this.
Sub-Note: This feature has not yet been tested. If detection does not work, you can still use environment setting or the +E option as mentioned above to indicate the terminal encoding.

Note: Running mined (djgpp) in a dosemu session (DOS emulator on Linux) works fine, even in an xterm-embedded session although not perfectly in that case: ^S and ^Q are interpreted for flow control (thus ^S will hold all output until ^Q is entered), and the mined option -Qa should be used to tune menu borders right.  

Terminal setup

In some terminals, the cursor may not be well visible or not visible at all if the cursor is on a character with reverse background (control character, occurs e.g. in xterm) or highlighted background (invalid character code, occurs e.g. in xterm and rxvt). See the X resource parameters for "cursorColor" in the example configuration file Xdefaults.mined for remedy.

If your terminal scrolls down one line when you click the left mouse button in the text area, the terminal type is not properly set up. This occurs, e.g., when you run inside a cygwin or rxvt terminal but the environment variable TERM is incorrectly set to xterm. Set it to the correct value for remedy.

If mouse wheel movement moves more than expected, especially if it cannot move by single items in a menu, this is probably a configuration issue with your mouse driver. You are probably running a Windows-based X server which is (often by default) configured to generate multiple mouse wheel events on each actual mouse wheel movement. Often not even in the Control Panel mouse section, but only in a configuration menu of mouse-specific setup software (e.g. "Browser Mouse Settings"), configure the scroll unit to 1.  

Terminal interworking problems

any terminal: menu border display

•

If the borders of mined menus appear as letters rather than graphic borders, the terminal can unexpectedly not handle VT100 block graphics. Use the option -Qa to switch to ASCII borders, or -fff to limit font assumptions.
In a UTF-8 terminal, mined uses Unicode Box Drawing characters by default. If they don't display they are missing in the font used by the terminal. Use the option -Qv to switch to VT100 block graphics or -Qa to switch to ASCII graphics. If borders are visible but without corners, use -Qs to switch to rectangular borders.

any terminal: slow terminal feature auto-detection

•

Occasionally, when starting mined, you may receive a message "Late screen mode response - set ESCDELAY=2000 or higher for proper detection".
This happens if there is a large delay (> 700 ms) in the interaction mined uses to detect terminal properties. There are two possible reasons for this:

•

A slow remote terminal connection. In this case, set up your environment variable ESCDELAY to a value (in milliseconds) large enough to cover the anticipated delay, e.g.: export ESCDELAY; ESCDELAY=3000

•

Font loading. Especially with rxvt and mlterm, X fonts seem to be loaded partially on demand. While this speeds up initial terminal operation, it also results in unexpected delays of terminal responses. In this case, exiting mined and starting again will normally resolve the issue for one session of the terminal. For a more permanent remedy, also use the environment variable ESCDELAY when using those terminals, e.g.: export ESCDELAY; ESCDELAY=1200

Automatic handling of the situation is planned for the next release of mined.

mlterm

•

Bidirectional display handling of mlterm is based on the final display, not regarding any context (such as positioning control, that's why mined implements a workaround for menu display on mlterm). This also affects mouse cursor position reports which do not match over right-to-left text, so the cursor will be placed somewhere else in the line.

•

The Mined runtime support library includes a configuration file mlterm/key which defines enhanced escape sequences for function keys and other modified keys in order to enable the functionality described in this manual. It is essential to use this configuration especially for the HOP key (keypad "5") which is oppressed by mlterm by default, and also for Control-punctuation accent prefix functions, and some others.

•

Note: Mouse wheel scroll navigation in menus does not work seamlessly in mlterm because mlterm sends incorrect escape sequences on mouse wheel scrolling.

xterm

•

Although it is a waste of keyboard resources to have two indistinguishable sets of keypad keys, most terminals provide no means of distinguish them towards the applications, at least not by default. Especially for a text editor, it is highly desirable to distinguish them in order to have a rich intuitive function key mapping at disposition which mined tries to achieve.
Remapping keypad keys in a useful way is sensitive because it may create incompatibilities with other programs that rely strictly on installed terminfo information. Mined provides remapping recommendations for shifted keypad keys (with Shift, Control, Alt and combinations of them) in the configuration sample file Xdefaults.mined in the Mined runtime support library.
Due to the compatibility limitations mentioned above, however, the two Ins keys remain indistinguishable, and the two Del keys are only distinguishable if the xterm configuration resource *VT100*deleteIsDEL is set. Also, keypad and function key modification with the Alt is ensured with the xterm resource *VT100*metaSendsEscape. Both resources are set to true in the configuration sample file just mentioned.
These two resources can also be set dynamically with xterm. Mined can be told to do so with the command line option +D. (Unfortunately this handling cannot be enabled by default as it cannot be undone because the previous state cannot be detected.)

•

Mined determines the xterm version in order to apply certain workarounds conditionally.

•

If you run xterm in VT220 keyboard mode (using xterm option -kt vt220 or setting the configuration resource *keyboardType: vt220) you should make sure to also set the environment variable TERM=vt220 (e.g. using the xterm option -tn vt220 or setting the configuration resource *termName: vt220) so mined can properly set up the keypad functions.

•

If you run xterm with the resource modifyCursorKeys or modifyFunctionKeys set to value 1, mined will recognize the according keyboard sequences with the environment variable setting TERM=xterm-sco.

xterm on cygwin

•

On cygwin, as on other systems, the script uterm is recommended to invoke an xterm that is properly configured to run UTF-8, and also to use a best choice of fonts for optimal Unicode coverage. See README.cygwin for more detailed advice.

xterm legacy CJK width mode

•

Mined auto-detects and supports xterm legacy CJK width compatibility mode (xterm -cjk_width); character width and menu border layout are properly adjusted, stylish menu borders (-QQ) and fine-grained scroll bar display are disabled by default. (Note: In this mode, combining characters could unexpectedly change the width of a character by being substituted with its wide precomposed form (e.g. 'a' combined with U+0300) - which an application can hardly handle; this bug was fixed in xterm 224 with a patch contributed by the mined author.)

rxvt

•

When starting mined in a fresh rxvt terminal, and maybe even after starting your X server, some display (font?) initialization may take extremely long, resulting in an error message. Restart mined to ensure proper terminal properties auto-detection.

•

Rxvt does not distinguish between Shift-F1 and F11 / Shift-F2 and F12 / Ctrl-Shift-F1 and Ctrl-F11 / Ctrl-Shift-F2 and Ctrl-F12, so that the F1 and F2 keys modified with Shift cannot be recognised in rxvt by default. →NEW→ They can however be enabled with the keysym definitions in the file Xdefaults.mined in the Mined runtime support library.

•

In rxvt, the two keypad Del keys (small keypad, numeric keypad) are automatically distinguished from each other and invoke the Delete character (small keypad) and Cut (numeric keypad) functions, respectively (Ctrl-/Shift-/Alt- alternatives are supported as described in this manual). This works, however, only if mined can recognise rxvt; it is generally a bad idea to set TERM=xterm in rxvt, see also hint below.

•

Also in rxvt, the two keypad Ins keys (small keypad left, numeric keypad right) are distinguished. The left Ins key positions the cursor left of the pasted region, the right Ins key positions it right.

•

By setting rxvt in the mode that enables distinction between the two keypads, it can unfortunately not distinguish the right keypad modified with Ctrl- anymore, so Ctrl-Home/End/Del cannot work as desired.

•

Ctrl-modified punctuation keys can be enabled by following the configuration samples of the file Xdefaults.mined in the Mined runtime support library.
Note: Ctrl-modified and shifted punctuation keys interfere with ISO 14755 input mode of rxvt; if the following key is entered twice, that mode is aborted and the modified punctuation key becomes effective as an accent prefix in mined.

•

The recent rxvt-unicode release provides a CJK terminal emulation. CJK display is buggy for characters that rxvt thinks cannot be displayed, especially for GB18030 (LC_CTYPE=zh_CN.gb18030 rxvt) but also e.g. for JIS (LC_CTYPE=ja_JP.eucjp rxvt); single bytes are then interpreted instead which amounts to an unpredictable screen width and cannot be correctly handled. (This applies mainly to character codes that are not mapped to Unicode but also to many that are mapped.)
Moreover, CJK width handling is inconsistent for many characters in rxvt CJK mode (rxvt claims to adhere to the locale mechanism in this respect but that's not the case here - character widths are inconsistent with the locale, too).
Remedy: Don't use rxvt in CJK-encoded mode; mined CJK terminal support is tailored to native CJK terminals (such as cxterm, kterm, hanterm) where it works fine - if you use a UTF-8-capable terminal, use it in UTF-8 mode! Mined can edit CJK-encoded files well in a UTF-8-encoded terminal.

•

In rxvt, Unicode characters that are Not Assigned are always displayed as a single-width replacement character. This is not consistent with xterm behaviour which would display them as a double-width replacement if they are located within a double-width Unicode range (which sounds reasonable). This would cause display positioning inconsistencies. Mined has a workaround for some of these cases (assuming that rxvt runs the most recent Unicode width data version available; or actually the same as mined assumes - handling of multiple auto-detected terminal Unicode versions does not cover this special case).

•

If the X windows servers has duplicate fonts installed under a common name (e.g. if it comes with a 10x20 non-Unicode font and you install a 10x20 Unicode font in addition), rxvt seems to use the wrong (i.e., non-Unicode) version of the font and does not find special characters like the default marker used in the flags menus (this was observed since rxvt 7.5, rxvt 5.8 was finding the proper font). Use the mined option -F to adapt mined to limited font usage, or fix the X server installation. Or use the script uterm to start rxvt-unicode. To start rxvt-unicode from an xterm, use uterm -rx.

•

Due to the scrollbar display workaround for hanterm (see above), the scrollbar position may be shown as blank space instead of coloured (only in rxvt CJK mode with Korean encoding and if you explicitly set TERM=xterm which you shouldn't anyway in rxvt). In this case, coloured scrollbar foreground can be enabled with the environment variable MINEDSCROLLFG="44;36" or MINEDSCROLLFG="38;5;45".

•

As a workaround for an xterm bug on cygwin, mined applies terminal size re-adjustment. This may confuse rxvt (being resized to an unexpectedly large window) if it pretends to be xterm.
Remedy: in rxvt, make sure that the environment variable TERM=rxvt (or rxvt-unicode); the according X resource (Rxvt.termName: rxvt) is also listed in the file Xdefaults.mined in the Mined runtime support library.

•

Mined determines the rxvt version in order to use certain features conditionally.

•

CJK-mode rxvt: rxvt has some character width bugs when running in CJK encoding; e.g. when running rxvt in Big5 terminal encoding (locale zh_TW), U+FA18 is displayed with wrong screen width while in older version U+FFED was display with wrong screen width; when running rxvt in Shift-JIS terminal encoding, a number of character width bugs occur. Mined does not implement workarounds for those; in general UTF-8 terminal encoding is advisable to be on the safe side.

urxvt

•

This is rxvt-unicode as packaged for cygwin. Invoke it with a proper locale environment variable set to enable UTF-8. See also README.cygwin for more detailed hints.

cxterm

•

EUC-JP half-width characters (8EA1-8EDF) are not properly displayed by cxterm in EUC-JP mode (cxterm -JIS, not available in "classic" cxterm).

•

Due to the scrollbar display workaround for hanterm (see above), the scrollbar position may be shown as blank space instead of coloured (only in Korean encoding mode which is probably rarely used with cxterm anyway). In this case, coloured scrollbar foreground can be enabled with the environment variable MINEDSCROLLFG="44;36" or MINEDSCROLLFG="38;5;45".

kterm

•

Auto-detection of kterm as a CJK terminal works if the environment variable TERM indicates "kterm"; otherwise mined has to be told that it runs in a CJK terminal and which encoding to use:
For kterm -km sjis, set LC_CTYPE=ja_JP.sjis (or invoke mined +ES).
For kterm -km euc, set LC_CTYPE=ja_JP.eucjp (or invoke mined +EJ).

•

Note: Mouse wheel scroll navigation in menus does not work seamlessly in kterm because kterm sends incorrect escape sequences on mouse wheel scrolling.

•

Note: By default (i.e., without explicit -km option or corresponding *vt100.kanjiMode resource configured), kterm runs in ISO 2022 mode (yes, it does indeed) which is not supported by mined.

hanterm

•

CJK display is buggy at the line beginning or after a Tab, often only the second byte of the character code is displayed as an ASCII character instead of displaying the complete CJK character.

•

Character attributes in hanterm used to be all mapped to reverse, so there was a workaround to enable a visible position in the scrollbar which is displayed as blank space. The criteria for this workaround to apply are: CJK terminal (detected or configured), TERM=xterm, Korean encoding (UHC or Johab) configured with parameter or locale. Replaced to enable nicer colours in scrollbar. To reactive workaround for older hanterm, set environment variable MINEDSCROLLFG="0".

konsole

•

Due to the lack of decent Unicode font support in the default configuration of the KDE konsole terminal, menu appearance options -QQ and -Qr should not be used; rounded borders are disabled by default.

•

The Mined runtime support library includes a configuration file konsole/xterm-modified.keytab which defines enhanced escape sequences for function keys and other modified keys in order to enable the functionality described in this manual. Unfortunately, the qt framework used by konsole inhibits the use of some keys and many key combinations.

•

It is especially irritating that konsole disregards the middle keypad key ("5" in application mode) completely; so the mined HOP function has to be invoked by alternative means.
As a remedy, the HOP function is assigned to the "Menu" key (next to the "Windows" key on PC keyboards) in the configuration sample file mentioned above →NEW→ and is also assigned to the Menu key by default.
An additional remedy could reassign the middle keypad key to the X key symbol Menu (using xmodmap); →NEW→ invoke the script kp5 in the Mined runtime support library for this purpose.

gnome-terminal

•

The gnome-terminal captures a number of Alt-letter key combinations for its own menu access (which can however also be controlled with the mouse). To disable this unpleasant capturing, so e.g. mined can open its own menus with Alt-letter, configure as follows:
Open menu "Edit" - "Keyboard Shortcuts..." and check "Disable all menu access keys". Even then, however, F1 and Ctrl-F1 are suppressed by this quirky terminal.

•

This terminal does not supported modified keys (e.g. shifted keypad keys).

•

Mined implicitly assumes its -f option (for limited font usage with respect to graphic characters) when detecting gnome-terminal.

Linux console

•

Shifted function key codes are "shifted" by 2 as compared to other terminals' function key codes. →NEW→ Mined detects F11, F12, Shift-F1...Shift-F8 properly, further modified function keys are apparently not supported in the Linux console.

screen Screen, like luit (see below), is a middle layer between the actual terminal and the user terminal environment. Unfortunately, screen does not pass character width handling of its host terminal transparently to the application but apparently it maintains cursor position information with reference to the system-installed locale data. Which, however, does not always reflect the terminal properties! →NEW→ Yet mined detects the proper width properties of the host terminal (by using pass-through escape sequences of "screen") but only if the environment variable is set to "screen" (the default of "screen").

MinTTY MinTTY is a Windows-based (non-X) terminal running with cygwin. Mined auto-detects MinTTY and adjusts certain properties and features accordingly.

•

→NEW→ Mined detects font changes that change the CJK ambiguous character width properties of the terminal when notified by MinTTY (to be introduced in MinTTY 0.4 or above), if running in UTF-8 mode.

•

For good coverage of Unicode characters, recommended fonts for use with MinTTY are Lucida Console, Courier New, Andale Mono, SimSun. Discouraged are Lucida Sans Typewriter, Letter Gothic, Courier, Monaco, and older MS CJK fonts, at least for their lack of (proper) graphic characters (for menu borders).

•

For proper usage of Unix-like keyboards functions, the following settings are recommended for MinTTY: In Options - Keys, disable the Shortcuts "Window commands" and "Copy and paste". In Options - Text, disable "Show bold as bright".

•

Note: With the command script wined (also available as wined.bat), mined is invoked in a separate Windows terminal session, using MinTTY if available.

Cygwin console

•

The cygwin console terminal emulation does not support Shift-F1, Shift-F2 (which cannot be distinguished from F11, F12), Shift-F11, Shift-F12, nor any Control or Alt modified function keys.

•

→NEW→ Mined detects UTF-8 mode of cygwin 1.7 console (by LC_*/LANG setting or for cygwin 1.7 beta by CYGWIN containing "codepage:utf8").
Note: After rlogin from this console, UTF-8 indication has to be ensured explicitly, e.g. by environment setting, or by mined option +U.

•

Note: Cygwin console in UTF-8 mode provides extended Unicode font support if you select "Lucida Console" TrueType font from its Properties menu.

•

See also README.cygwin for more detailed hints on weird details about the Windows console in different modes.

•

See also PC terminals above.

Windows console window (DOS command prompt)

•

The Windows console window is normally configured to run in CP850 encoding; depending on Windows version or font, however, it may also turn out to use CP437 instead. In this case, some characters are replaced by graphic symbols, e.g. the sputnik symbol "¤" used by mined as a replacement character for non-displayable Unicode characters. This happens, e.g., with the 10 x 20 raster font. As a workaround, use a different font, e.g. 10 x 18 or Lucida Console. If you change the "active codepage", stay with "Raster Fonts" configuration and avoid the "10 x 20" size in order to make sure the effective visual codepage is the same as the selected one and the one assumed by mined.

•

With the djgpp-compiled version apparently there is a Ctrl-C problem on older Windows versions. Every first Ctrl-C will display ^C on the screen at the current position without mined noticing it, while every second Ctrl-C will be passed to mined. This problem does not occur on Windows XP. It does occur on Windows ME in a Windows console window. It does not occur with the cygwin-compiled version.

•

See also PC terminals above.

Poderosa

•

This Windows terminal emulator can be used for UTF-8 editing. To ensure proper function, do not use Terminal Type "kterm" or Encoding "euc-jp" or "shift-jis"

•

Mined auto-detection and terminal initialization can cause Poderosa to display warning popups. To avoid them, Select Tools - Options... - Terminal; for "Behavior in case of unexpected chars", disable "Display a message box". If you get a notice "Failed to decode characters by the current encoding utf-8.", click "Do not display this message from next time".

•

Poderosa does not provide mouse support for applications.

Terminator

•

In Edit - Preferences, enable "Use alt key as meta key".

•

Terminator does not provide mouse support for applications.

PuTTY

•

This Windows terminal emulation for remote login provides various keyboard (esp. keypad and function key) assignment emulations. In SCO mode, shifted function keys are different from those of xterm SCO function key emulation; both are supported.

luit

•

The locale support add-on for text terminals luit which applies encoding transformations (e.g. with LC_ALL=zh_CN.gb18030) often maps characters incorrectly, including using the wrong cell width.

Work-around support to enable 8-bit character set on weird terminals

Concerning some especially stupid terminal drivers

Keyboard mapping / Input method pre-selection

Smart Quotes style configuration

Han info configuration

M

show Mandarin pronunciation

C

show Cantonese pronunciation

J

show Japanese pronunciation

S

show Sino-Japanese pronunciation

H

show Hangul pronunciation

K

show Korean pronunciation

V

show Vietnamese pronunciation

P

show Hanyu Pinlu pronunciation

X

→NEW→ show XHC Hanyu Pinyin pronunciation

T

show Tang pronunciation

D

show character description

F

display full information (in popup-menu form); without F, the information will be shown on the status line where it is subject to truncation

Common paste buffer configuration

•

Set MINEDTMP to refer to a common mounted network directory on all machines which means that the value of $MINEDTMP may have to be different to reflect different mount points across the network.

•

Set MINEDUSER to the same name within the network even if using different user name accounts.

Keypad configuration

•

Alt key modifier for quicker entry of "ESC" commands.

•

Assignment of the HOP function to the middle keypad key ("5").

•

Assignment of the HOP function to other keys (especially for convenience on laptops which do not have the numeric keypad), e.g. the Pause or Scroll Lock key.

•

Distinguish "Home" and "End" keys of the two keypads in order to make use of this redundancy of typical keyboard layout (which is actually a waste of physical resources, causing unnecessary wrist strain because it increase the distance to be moved over for reaching to the mouse).

•

Enable control and shift modifiers for keypad and function keys.

•

Enable control and shift modifiers for digit keys (for use as accent prefix).

•

Enable control modifier for punctuation keys (for use as accent prefix).

Printing configuration

Display layout

Line ends

The indication of DOS line ends (CRLF) and Mac line ends (CR) may be configured with the variables MINEDDOSRET or MINEDUTFDOSRET, and MINEDMACRET or MINEDUTFMACRET, respectively. →NEW→ They are also distinguished by different colours.  

Paragraph ends

Tab characters

Long lines

Unicode characters

Display mode of indicators

Display mode of menu borders

Status line highlighting

Scrollbar colour

Menu colour and border style

Combining character display

Online Help access

Mined configuration

Script highlighting

Encodings and Encoding menu

Encodings recognised by locale names

Keyboard mapping (Input method)

path.../name.mim

a keyboard mapping file of the m17n-db multilingualization package

path.../name.kmap

a keyboard mapping file of the yudit text editor

path.../name.vim

a keyboard mapping file of the vim text editor

path.../name.cit

an input method mapping file of the cxterm terminal, binary form; only works if the cxterm binary/text conversion utility cit2tit is accessible

path.../name.tit

an input method mapping file of the cxterm terminal, text form; only works if the character set conversion utility iconv is accessible and works on the mapping file

path.../name.utf

an input method mapping file of the cxterm terminal, already converted to UTF-8 encoding (e.g. with iconv)

Cangjie [ < HKSCS Changjie table file name > ]

with this tag, a keyboard mapping for the Cangjie input method will be generated, taking information from the Unihan database (unicode.org);
with a second parameter, a Big5-encoded table of HKSCS Changjie input codes will be merged in, the parameter is either the file name or a + sign which is implicitly expanded to the relative path name etc/charmaps/hkscs/hkscs-2004-cj.txt; the HKSCS input codes file should be taken from http://info.gov.hk/digital21/eng/hkscs/

MainlandTelegraph , TaiwanTelegraph

with one of these tags, a keyboard mapping will be generated using one of these telegraph codes as an input method, taking information from the Unihan database (unicode.org)

Cantonese , HanyuPinlu , Mandarin , Tang

with one of these tags, a keyboard mapping will be generated using the according Chinese pronunciation as an input method, taking information from the Unihan database (unicode.org)

JapaneseKun , JapaneseOn

with one of these tags, a keyboard mapping will be generated using Japanese or Sino-Japanese pronunciation as an input method, taking information from the Unihan database (unicode.org)

Korean , Vietnamese

with one of these tags, a keyboard mapping will be generated using Korean or Vietnamese pronunciation as an input method, taking information from the Unihan database (unicode.org)

VIQR , VNI , Vtelex

with one of these tags, a keyboard mapping will be generated for the respective Vietnamese input methods, taking character information from the Unicode database (unicode.org)

script tag

for many scripts listed in the UnicodeData.txt database, character names listed there can build a useful keyboard mapping; mkkbmap will then generate an according keyboard mapping file, e.g. for Bopomofo

MSDOS-only notes

DOS binaries: Two DOS-based versions, compiled with djgpp and with cygwin, are available for download from the mined web site http://towo.net/mined/ for users who want a quick binary on DOS-based systems. The djgpp binary is a "dual-mode" executable which runs on plain DOS and also supports long file names in a Windows 98/2000/XP/... console window (not NT4.0). It does not run in an xterm, however.

Highlight mode: The ANSI codes for selecting normal and exposed display can be chosen with the environment variable MINEDCOL. The two selections are separated by a space. Each selection is a semicolon-separated list of the code values. The default behaviour corresponds to the setting

       set MINEDCOL=7 27

       set MINEDCOL=34;42 32;44

For command line options, "/" can be used instead of "-".

The "ESC -" command cannot go back within a group of files named by the same wildcard expression. It goes to the previous file name (or wildcard expression) instead.

Enabling the keypad HOP key: If you have a very old and crappy BIOS, you may have to enable use of the cursor block "5" key (for use as a HOP key) with a TSR driver (ENHKBD.COM) or an enhanced keyboard driver. (Older PC keyboard drivers were often so ignorant to forbid you to use that key.)

Immediate adjustment to changed window size does not work in the DOS version if the size change is caused by a TSR (e.g. VGAMAX using a hotkey); in that case, mined adjusts its screen display only after the next key is typed.

The cygwin terminal environment (cygwin in a Windows console window) provides an emulation of a Unix 8 bit character set so non-ASCII characters entered in this version are different from those entered in other DOS-based versions. Editing UTF-8 text, on the other hand, works transparently in all DOS-based versions. See PC terminals above for more details.

In order to enable mouse use in a Windows console window, deactivate "QuickEdit mode" in the properties menu.

       The following only applies if DOS ANSI driver output is used
which is currently not the case in any configuration:

       The default colour setting depends on an extended ANSI driver
(like NNANSI) as does the scroll down function anyway. Unfortunately, there is no way to find out the current colour setting nor is there an inverse video mode in many ANSI drivers (only a fixed black on white mode) so that it is impossible to implement just inverse display for highlighting. Therefore, if mined thinks to see an ANSI driver of the simpler kind, it will change its colour setting defaults. In any case, these can be overridden with the MINEDCOL variable. Recommended ANSI drivers:

        NNANSI by Tom Almy (very capable, but needs some

installation effort), or

        ANSI.COM by Michael J. Mefford (small, works well at

usual screen sizes).

Mined tries to analyse the ANSI drivers capabilities by checking some control sequences. This works, however, only if the ANSI driver is at least able to send cursor position reports. For primitive ANSI drivers that cannot even do that, mined's operation can be ensured with an emergency procedure: A faked pseudo-report should be stuffed into mined as its first input (with some key-stuffing program) and mined will use no further cursor position requests. It will also assume a simple ANSI driver then. The faked report should consist of the screen size in lines and columns, embedded at the positions of the ANSI cursor report sequence but with different surrounding characters. For an invocation of mined on a 25 lines and 80 columns screen a batch file for this would look like:

       keypress xx25x80xx

       mined %1 %2 %3 %4 %5 %6 %7 %8 %9

The remaining remarks apply to the Turbo-C version only
which is no longer supported (use djgpp instead):

•

The file size being edited is limited to 200KB to 500KB (depending on average line length and number of lines).

•

Typing of Ctrl-P while display output is active (i.e., during screen paging) can hang the system. Typing of Ctrl-C or Ctrl-Break while display output is active can at least leave some garbage on the screen. Ctrl-S may stop screen output until Ctrl-Q is typed. Typing of Ctrl-P, Ctrl-C, or Ctrl-Break while a search operation is active can be desastrous. (Can anyone tell me how to disable BIOS/MSDOS interpretation of these characters from Turbo-C?)

•

The Turbo-C version is configured to handle screen output using the "conio" module. (It used to use an ANSI driver.) The disadvantage of conio is that it doesn't handle arbitrary screen modes and sizes whereas good ANSI drivers support them all.

ENVIRONMENT VARIABLES

        HOME

       USER

       SHELL

       SYS$SCRATCH (VMS)

       TMPDIR

       TMP

       TEMP (MSDOS)

       TERM

Terminal type to be assumed.

        ESCDELAY

Delay after an ESCAPE character that mined waits for
recognition of a function key control sequence. Default is 450 ms.

        MAPDELAY (non-standard)

Similar delay that mined applies to wait for subsequent
input characters when applying keyboard mapping for an input method. Default is 900 ms.

        LINES, COLUMNS (MSDOS ANSI mode only)

Line / column count of terminal to be assumed.

        windir

Used to determine if it runs under MS Windows and set some
defaults (screen output delay) accordingly.

Environment variables to configure Printing

       MINEDPRINT

Print command to use instead of uprint; the value must
contain an embedded "%s" which is replaced with the file name.

        FONT

Name of a font file, e.g. LucidaBrightRegular or bodoni.ttf
for use with uprint/uniprint (the file must reside in the configured font path), or name of a font as specified with fontconfig (in $HOME/.fonts.conf or /etc/fonts/fonts.conf) for use with uprint/paps.

        FONTPATH

Directory search path (separate directory names with ":")
for use with uprint/uniprint which uses Truetype fonts.

        FONTSIZE

Font size to be used with uprint (paps or uniprint).

        LPR

Print spooling command to be used by uprint (or
mined itself if uprint does not work) instead of the system-specific print spooling command (e.g. lpr).

        PRINTER

Name of printer to spool to.

FILES

Unix

$MINEDDIR

directory in which the Mined runtime support library is installed, including the online help file mined.hlp and the printing script uprint

$MINEDDIR/help/mined.hlp

online help file, first attempt to find it

$0/mined.hlp

online help file in mined program directory, next attempt

/usr/share/mined/help/mined.hlp

online help file, next attempt

/usr/local/share/mined/help/mined.hlp

online help file, next attempt

/usr/share/lib/mined/help/mined.hlp

online help file, next attempt

/opt/mined/share/help/mined.hlp

online help file, next attempt

/usr/share/doc/packages/mined/help/mined.hlp

online help file, next attempt

$MINEDTMP

directory for auxiliary files, first attempt Using this variable and $MINEDUSER (see below), you can establish copy and paste among machines that share network directories but are normally configured to use separate (usually local) temporary directories.

$TMPDIR

directory for auxiliary files, next attempt

$TMP

directory for auxiliary files, next attempt

$TEMP

directory for auxiliary files, next attempt

/usr/tmp

directory for auxiliary files, next attempt

/tmp

directory for auxiliary files, next attempt

$MINEDUSER

user name assumed instead of $USER for building auxiliary file names; using this, common copy-and-paste buffers can be used on a network file system from different machines where the user possibly has different user names

$HOME/.fonts.conf

fonts configuration file for use with uprint/paps; for description, see http://fontconfig.org/fontconfig-user.html or man fonts.conf

minedbuf.< USER >.< PID >.< NN >

temporary file for paste buffer; USER is either $MINEDUSER or $USER

minedbuf.< USER >

file for inter-window paste buffer; USER is either $MINEDUSER or $USER; see descriptions of $MINEDTMP and $MINEDUSER above for how to set up a common inter-window paste buffer in a heterogeneous network

minedpanic.< USER >.< PID >

panic file to rescue text in case of crash or external signal caught

VMS

SYS$MINEDTMP:$MINEDBUF$user.pid.nn

paste buffer, first attempt

SYS$SCRATCH:$MINEDBUF$user.pid.nn

paste buffer, next attempt

SYS$SCRATCH:$MINEDPANIC$user.pid

panic file, first attempt

SYS$MINEDTMP:$MINEDBUF$user

inter-window paste buffer, first attempt

SYS$SCRATCH:$MINEDBUF$user

inter-window paste buffer, next attempt

SYS$SCRATCH:$MINEDPANIC$user.pid

panic file, next attempt

If SYS$SCRATCH is not available, SYS$LOGIN is used instead.

MSDOS / Windows

%MINEDDIR%\help\mined.hlp

online help file, first attempt (to find it)

mined.hlp (in mined program directory)

online help file, next attempt

%MINEDTMP%\minedbuf.nn

paste buffer

%MINEDTMP%\minedbuf

inter-window paste buffer

%MINEDTMP%\minedbuf.%MINEDUSER%

inter-window paste buffer, as configured to use the same file as other mined versions in a heterogeneous network; note, however, that %MINEDUSER% will be shortened to 3 characters in pure DOS

%MINEDTMP%\mined-pa.nic

panic file

If %MINEDTMP% is not available, %TEMP% or %TMP% or \ are used.

DIAGNOSTICS

BUGS

(Unix:) Mined cannot edit a pipe or device file and hangs if you try to do so. (But it can insert from, or write to, a pipe.)
This restriction does not refer to editing from standard input in a piped command like cmd | mined which works of course.

(MSDOS, Windows:) With non-cygwin versions (djgpp), piped editing from standard input does not work for unknown reason.

(Windows:) Non-cygwin versions (djgpp) do not work in xterm, rxvt, or MinTTY.

AUTHOR AND ACKNOWLEDGEMENTS

Mailing list

Acknowledgements

•

Thanks to Nadim Shaikli < shaikli @ yahoo.com > for discussion of right-to-left issues and interworking with mlterm.

•

Thanks to Mike Fabian < mfabian @ suse.de > for making the RPM package included in the SuSE distribution.

•

Thanks to Ziying Sherwin < sherwin @ nlm.nih.gov > and R. P. Channing Rodgers < rodgers @ nlm.nih.gov > for suggestions and information about CJK input method support and multiple choice handling (pick lists).

•

Thanks to Tobias Ernst < tobias_ernst @ eml.cc > for providing a Mac OS X makefile and suggestion and information to implement Emacs command mode.

•

Thanks to &#21556;&#21647;&#28828; (Wu Yongwei) < yongwei @ eastday.com > for suggestions and information about Pinyin input methods, for discussion about keyboard mappings for CJK punctuation, and for further maintaining the Pinyin input method.

•

Thanks to Ramakrishnan Muthukrishnan < rkrishnan @ debian.org > for making the Debian package.

•

Thanks to Thierry Thomas < thierry @ FreeBSD.org > for making the FreeBSD package.

•

Thanks to Tobias Nygren < tnn @ NetBSD.org > for making the NetBSD package.

•

Thanks to Jim Breen for suggesting better overview of input methods and more language-specific advice for non-techy persons which led to the new chapter on Language support.

Index

NAME

SYNTAX

DESCRIPTION

Good interactive features

Versatile character encoding support

Many useful text editing capabilities

Small-footprint operation and portability

Command line options

Examples

Startup options

Line end handling (transparent and transforming)

Character set and character handling

Terminal mode

Information display

Editing behaviour

Appearance

Further mode selection, interface and display behaviour

Editing text with mined

Keypad layout

The HOP function

Character-oriented navigation and editing

Mouse control and menus

Menus

Menu navigation

Hints

Inter-window paste buffer

Multiple paste buffers

Text position markers

Text position marker stack

Paragraph justification / word wrap

Auto indentation

Structure input commands

Back-Tab (Undent function / reverse indent)

Tab expansion

Search and replace multiple lines

Header line underlining

Automatic backspace mode adaptation

Overview: input support features

Character input

Structured input

Special features

Handling files with mined

Tags file support

Data security

Edited text

Files

File access permissions

Pipe output

Line end modes and binary-transparent editing

Memory of file position and editing style parameters

Page length

File names

Restricted mode (tool mode)

Version control integration

Printing

Working with mined

Mode indication flags

Scrollbar

Text position marker stack

Structured editing support

HTML support: syntax highlighting and tag entry/matching

Search structure match

Structure input

Password hiding

Long line splitting

Visible indication of line contents and display

Function key help bars

Menu display

Language support

Western languages

Character sets

Character input support

Language-specific mnemonic conversion support

Other Latin-based languages

Character sets

Character input support

Language-specific case conversion

Esperanto

Character sets

Input method

Accented character input support

Russian, Ukrainian, other Cyrillic-script languages

Character sets

Input method

Accented character input support

Script highlighting

Tadjik

Character sets

Input method

Accented character input support

Script highlighting

Kazakh

Character sets

Input method

Accented character input support

Script highlighting

Georgian

Character sets

Greek

Character sets

Input method

Accented character input support

Script highlighting

Language-specific case conversion

Amharic

Input method

Arabic

Character sets

Input method

Accented character input support

Bidi support

Hebrew

Character sets

Input method

Accented character input support

Bidi support

Smart replacement

Chinese

Character sets

Input method

Han character information display

Accented character input support

Japanese

Character sets

Input method

Han character information display

Accented character input support

Korean

Character sets

Input method

Han character information display

Vietnamese

Character sets

Input method

Character input support

Thai

Character sets

Input method

Accented character input support

Typographic quotation marks

Character handling support

Script highlighting

Combining characters

Character information display

Han character information display

Character conversion features

Case conversion

Numeric conversion

Numeric entity (HTML/URL) conversion

Mnemonic conversion

Encoding conversion support

Unicode Copy/Paste buffer

Smart quotes

Smart text replacements: smart dashes and arrows

Character input support

Accented and mnemonic input support

Accent prefix keys

Combining character input

Special character input shortcuts

Character input mnemonics

Keyboard Mapping and Input Methods

Pick lists

Input method selection

Character encoding support

Auto-detected character encodings

CJK and mapped 8 bit encoding support

Combining characters

Character code related commands

Terminal environment for CJK encoding support

Unicode support

Introduction: handling Unicode encodings

UTF-8 internal representation, transparent handling of other text

Character encoding indication

Character information display

Character input support

Encoding conversion support

Unicode Copy/Paste buffer conversion

Smart quotes and dashes

Bidirectional terminal support

Input support for right-to-left scripts (poor man's bidi mode)

Unicode line ends

Unicode display

Character substitution display

Combining and joining characters

Joining characters

Search expression limitations

UTF-8 preservation and byte-transparent editing

Terminal environment

CJK support (Chinese/Japanese/Korean Han character features)

CJK input method support

Radical/Stroke input method

CJK character display

Han character information display

Terminal encoding support

Terminal feature detection

Specific terminal properties

Mined Command reference (command and key function assignments)

Cursor and screen motion

Entering text

Accented character input support by accent prefix keys

Input support commands

Input method (Keyboard mapping) selection

Modifying text

Special conversion features

Text block and buffer operations

Search

Special functions in a search string

Special functions in a replacement string

File operations

Menu

Miscellaneous

MSDOS only

emacs mode

WordStar mode

Environment interworking and configuration hints

Mined runtime support library

Package documentation

Web documentation

Online help

Example files: environment configuration patterns

Scripts to be used at runtime

Scripts to start mined

Files to setup a mined installation

Scripts to configure an environment for mined

Terminal environment

Locale configuration

PC terminals

Terminal setup

Terminal interworking problems

Work-around support to enable 8-bit character set on weird terminals

Concerning some especially stupid terminal drivers

Keyboard mapping / Input method pre-selection

Smart Quotes style configuration

Han info configuration

Common paste buffer configuration

Keypad configuration

Printing configuration

Display layout

Line ends

Paragraph ends

Tab characters

Long lines

Unicode characters

Display mode of indicators

Display mode of menu borders

Status line highlighting

Scrollbar colour

Menu colour and border style

Combining character display

Online Help access

Mined configuration

Script highlighting

Encodings and Encoding menu

Encodings recognised by locale names

Keyboard mapping (Input method)

MSDOS-only notes

ENVIRONMENT VARIABLES

Environment variables to configure Printing

FILES

Unix

VMS

MSDOS / Windows

DIAGNOSTICS

BUGS

AUTHOR AND ACKNOWLEDGEMENTS

Mailing list

Acknowledgements