Checking commit emails.
[dragonfly.git] / bin / mined / mined.1
1 .\" Copyright (c) 2005 The DragonFly Project.  All rights reserved.
2 .\"
3 .\" This manual page is derived from software contributed to The
4 .\" DragonFly Project by Matthew Dillon <dillon@backplane.com>
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\"
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in
14 .\"    the documentation and/or other materials provided with the
15 .\"    distribution.
16 .\" 3. Neither the name of The DragonFly Project nor the names of its
17 .\"    contributors may be used to endorse or promote products derived
18 .\"    from this software without specific, prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
24 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
26 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
30 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 .\" SUCH DAMAGE.
32 .\"
33 .\" $DragonFly: src/bin/mined/mined.1,v 1.7 2006/03/26 22:56:56 swildner Exp $
34 .\"
35 .Dd March 15, 2005
36 .Dt MINED 1
37 .Os
38 .Sh NAME
39 .Nm mined
40 .Nd emergency text editor
41 .Sh SYNOPSIS
42 .Nm
43 .Nm
44 .Op Ar file
45 .Sh DESCRIPTION
46 The
47 .Nm
48 utility is a simple text editor primarily designed for use when a
49 system is booted single-user and has no /usr (and thus no access to
50 vi).  Simple help can be obtained by hitting the F1 key while in
51 the editor.  Control-W writes out the file and Control-X exits
52 the editor.
53 .Sh KEY BINDINGS
54 .Bl -tag -width "Right arrow" -compact -offset indent
55 .It F1
56 HELP
57 .It F2
58 File status
59 .It F3
60 Forward search
61 .It F4
62 Global replace
63 .It Shift+F3
64 Backwards search
65 .It Shift+F4
66 Line replace
67 .It Up arrow
68 Move up one line
69 .It Down arrow
70 Move down one line
71 .It Left arrow
72 Move left one character
73 .It Right arrow
74 Move right one character
75 .It Home
76 File top
77 .It End
78 File bottom
79 .It Page Up
80 Scroll one page up
81 .It Page Down
82 Scroll one page down
83 .It Esc
84 Repeat last cmd # times
85 .It CTRL+A
86 Start of line
87 .It CTRL+B
88 Word backward
89 .It CTRL+C
90 Save from marked location to current cursor location
91 .It CTRL+D
92 Reverse scroll
93 .It CTRL+E
94 End of line
95 .It CTRL+F
96 Word forward
97 .It CTRL+G
98 Insert a file at cursor
99 .It CTRL+K
100 Delete from marked location to current cursor location
101 .It CTRL+L
102 Erase and redraw screen
103 .It CTRL+N
104 Delete next word
105 .It CTRL+P
106 Delete previous word
107 .It CTRL+Q
108 Insert the contents of the save file into new file
109 .It CTRL+S
110 Run shell
111 .It CTRL+T
112 Delete to end of line
113 .It CTRL+U
114 Forward scroll
115 .It CTRL+V
116 Visit another file
117 .It CTRL+W
118 Write current file
119 .It CTRL+X
120 Exit
121 .It CTRL+Y
122 Insert the contents of the save file at cursor
123 .It CTRL+\e\\&
124 Abort current operation
125 .It CTRL+@
126 Set mark
127 .It CTRL+^
128 Screen top
129 .It CTRL+_
130 Screen bottom
131 .It CTRL+]
132 Goto line #
133 .El
134 .Sh SEE ALSO
135 .Xr ed 1 ,
136 .Xr ee 1 ,
137 .Xr vi 1
138 .Sh CAVEATS
139 This utility is designed as an emergency editor for single-user mode
140 when /usr is not available.  The terminal type is hardwired to either
141 an xterm or cons25 (video console).  The editor understands stty
142 rows and columns but is otherwise meant to be fairly minimal in scope.
143 .Sh HISTORY
144 The
145 .Nm
146 utility first appeared in Minix .  It was brought into PicoBSD for a
147 time, and some work was done on it, then later brought into
148 .Dx
149 where some additional usability work was done on it.