VM: full munmap
[minix.git] / man / man1x / mined.1x
blob368e536fbce3abfcb99adbcf5e5b9f56520282d4
1 .so mnx.mac
2 .TH MINED 1x
3 .CD "mined \(en \*(M2 editor"
4 .SX "mined\fR [\fIfile\fR]
5 .FL "\fR(none)"
6 .TP 20
7 .B mined /user/ast/book.3
8 # Edit an existing file
9 .TP 20
10 .B mined
11 # Call editor to create a new file
12 .TP 20
13 .B ls \(enl | mined
14 # Use \fImined\fR as a pager to inspect listing
15 .PP
16 \fIMined\fR is a simple screen editor.
17 At any instant, a window of 24 lines is visible on the screen.
18 The current position in the file is shown by the cursor.
19 Ordinary characters typed in are inserted at the cursor.
20 Control characters and keys on the numeric keypad (at the right-hand side
21 of the keyboard) are used to move the cursor and perform other functions.
22 .PP
23 Commands exist to move forward and backward a word, and delete words
24 either in front of the cursor or behind it.
25 A word in this context is a sequence of characters delimited on both ends by
26 white space (space, tab, line feed, start of file, or end of file).
27 The commands for deleting characters and words also work on line feeds, making
28 it possible to join two consecutive lines by deleting the line feed between them.
29 .PP
30 The editor maintains one save buffer (not displayed).
31 Commands are present to move text from the file to the buffer, from the buffer
32 to the file, and to write the buffer onto a new file.
33 If the edited text cannot be written out due to a full disk, it may still
34 be possible to copy the whole text to the save buffer and then write it to a
35 different file on a different disk with CTRL-Q.
36 It may also be possible to escape from the editor with CTRL-S and remove
37 some files.
38 .PP
39 Some of the commands prompt for arguments (file names, search patterns, etc.).
40 All commands that might result in loss of the file being edited prompt to ask
41 for confirmation.
42 .PP
43 A key (command or ordinary character) can be repeated
44 .I n
45 times by typing
46 .I "ESC n key"
47 where 
48 .I ESC
49 is the \*(OQescape\*(CQ key.
50 .PP
51 Forward and backward searching requires a regular expression as the search
52 pattern.
53 Regular expressions follow the same rules as in the 
54 .Ux
55 editor,
56 .I ed .
57 These rules can be stated as:
58 .LI
59 .IT
60 Any displayable character matches itself.
61 .IT
62 \&. (period) matches any character except line feed.
63 .IT
64 \&^ (circumflex) matches the start of the line.
65 .IT
66 \&$ (dollar sign) matches the end of the line.
67 .IT
68 \&\\c matches the character \fIc\fR (including period, circumflex, etc).
69 .IT
70 [\fIstring\fR] matches any of the characters in the string.
71 .IT
72 [^string] matches any of the characters except those in the string.
73 .IT
74 [\fIx\(eny\fR] matches any characters between \fIx\fR and \fIy\fR (e.g., [\fIa\(enz\fR]).
75 .IT
76 Pattern\(** matches any number of occurrences of \fIpattern\fR.
77 .LX
78 Some examples of regular expressions are:
79 .HS
80 .in +1.25i
81 .ta +1.0i
82 .ti -1.0i
83 The boy matches the string \*(OQThe boy\*(CQ
84 .ti -1.0i
85 ^$      matches any empty line.
86 .ti -1.0i
87 ^.$     matches any line containing exactly 1 character
88 .ti -1.0i
89 ^A.*\\.$        matches any line starting with an \fIA\fR, ending with a period.
90 .ti -1.0i
91 ^[A\(enZ]*$     matches any line containing only capital letters (or empty).
92 .ti -1.0i
93 [A\(enZ0\(en9]  matches any line containing either a capital letter or a digit.
94 .ti -1.0i
95 \&.*X$  matches any line ending in \*(OQX\*(CQ
96 .ti -1.0i
97 A.*B    matches any line containing an \*(OQA\*(CQ and then a \*(OQB\*(CQ
98 .in -1.25i
99 .sp
101 Control characters cannot be entered into a file simply by typing them because
102 all of them are editor commands.
103 To enter a control character, depress the ALT key, and then while holding it
104 down, hit the ESC key.
105 Release both ALT and ESC and type the control character.
106 Control characters are displayed in reverse video.
108 The 
109 .I mined
110 commands are as follows.
112 .in +1.25i
113 .ta +1.0i
114 .ti -1.25i
115 \fBCURSOR MOTION\fR
116 .ti -1.0i
117 \fBarrows\fR    Move the cursor in the indicated direction
118 .ti -1.0i
119 \fBCTRL-A\fR    Move cursor to start of current line
120 .ti -1.0i
121 \fBCTRL-Z\fR    Move cursor to end of current line
122 .ti -1.0i
123 \fBCTRL-^\fR    Move cursor to top of screen
124 .ti -1.0i
125 \fBCTRL-_\fR    Move cursor to end of screen
126 .ti -1.0i
127 \fBCTRL-F\fR    Move cursor forward to start of next word 
128 .ti -1.0i
129 \fBCTRL-B\fR    Move cursor backward to start of previous word 
131 .ti -1.25i
132 \fBSCREEN MOTION\fR
133 .ti -1.0i
134 \fBHome key\fR  Move to first character of the file
135 .ti -1.0i
136 \fBEnd key\fR   Move to last character of the file
137 .ti -1.0i
138 \fBPgUp key\fR  Scroll window up 23 lines (closer to start of the file)
139 .ti -1.0i
140 \fBPgDn key\fR  Scroll window down 23 lines (closer to end of the file)
141 .ti -1.0i
142 \fBCTRL-U\fR    Scroll window up 1 line
143 .ti -1.0i
144 \fBCTRL-D\fR    Scroll window down 1 line
146 .ti -1.25i
147 \fBMODIFYING TEXT\fR
148 .ti -1.0i
149 \fBDel key\fR   Delete the character under the cursor
150 .ti -1.0i
151 \fBBackspace\fR Delete the character to left of the cursor
152 .ti -1.0i
153 \fBCTRL-N\fR    Delete the next word
154 .ti -1.0i
155 \fBCTRL-P\fR    Delete the previous word
156 .ti -1.0i
157 \fBCTRL-T\fR    Delete tail of line (all characters from cursor to end of line)
158 .ti -1.0i
159 \fBCTRL-O\fR    Open up the line (insert line feed and back up)
160 .ti -1.0i
161 \fBCTRL-G\fR    Get and insert a file at the cursor position
163 .ti -1.25i
164 \fBBUFFER OPERATIONS\fR
165 .ti -1.0i
166 \fBCTRL-@\fR    Set mark at current position for use with CTRL-C and CTRL-K
167 .ti -1.0i
168 \fBCTRL-C\fR    Copy the text between the mark and the cursor into the buffer
169 .ti -1.0i
170 \fBCTRL-K\fR    Delete text between mark and cursor; also copy it to the buffer
171 .ti -1.0i
172 \fBCTRL-Y\fR    Yank contents of the buffer out and insert it at the cursor
173 .ti -1.0i
174 \fBCTRL-Q\fR    Write the contents of the buffer onto a file
176 .ti -1.25i
177 \fBMISCELLANEOUS\fR
178 .ti -1.0i
179 \fBnumeric +\fR Search forward (prompts for regular expression)
180 .ti -1.0i
181 \fBnumeric \(mi\fR      Search backward (prompts for regular expression)
182 .ti -1.0i
183 \fBnumeric 5\fR Display the file status
184 .ti -1.0i
185 \fBCTRL-]\fR    Go to specific line
186 .ti -1.0i
187 \fBCTRL-R\fR    Global replace \fIpattern\fR with \fIstring\fR (from cursor to end)
188 .ti -1.0i
189 \fBCTRL-L\fR    Line replace \fIpattern\fR with \fIstring\fR 
190 .ti -1.0i
191 \fBCTRL-W\fR    Write the edited file back to the disk
192 .ti -1.0i
193 \fBCTRL-X\fR    Exit the editor
194 .ti -1.0i
195 \fBCTRL-S\fR    Fork off a shell (use CTRL-D to get back to the editor)
196 .ti -1.0i
197 \fBCTRL-\\\fR   Abort whatever the editor was doing and wait for command
198 .ti -1.0i
199 \fBCTRL-E\fR    Erase screen and redraw it
200 .ti -1.0i
201 \fBCTRL-V\fR    Visit (edit) a new file
202 .in -1.25i
204 .SS "Author"
206 \fIMined\fR was designed by Andy Tanenbaum and written by Michiel Huisjes.