Merge branch 'vendor/FILE'
[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 .Dd March 15, 2005
34 .Dt MINED 1
35 .Os
36 .Sh NAME
37 .Nm mined
38 .Nd emergency text editor
39 .Sh SYNOPSIS
40 .Nm
41 .Op Ar file
42 .Sh DESCRIPTION
43 The
44 .Nm
45 utility is a simple text editor primarily designed for use when a
46 system is booted single-user and has no
47 .Pa /usr
48 (and thus no access to
49 .Xr vi 1 ) .
50 Simple help can be obtained by hitting the F1 key while in the editor.
51 CTRL+W writes out the file and CTRL+X exits the editor.
52 .Pp
53 The terminal type is hardwired to either an xterm or cons25 (video console).
54 The editor understands stty
55 rows and columns but is otherwise meant to be fairly minimal in scope.
56 .Sh KEY BINDINGS
57 .Bl -tag -width "Right arrow" -compact -offset indent
58 .It F1
59 HELP
60 .It F2
61 File status
62 .It F3
63 Forward search
64 .It F4
65 Global replace
66 .It Shift+F3
67 Backwards search
68 .It Shift+F4
69 Line replace
70 .It Up arrow
71 Move up one line
72 .It Down arrow
73 Move down one line
74 .It Left arrow
75 Move left one character
76 .It Right arrow
77 Move right one character
78 .It Home
79 File top
80 .It End
81 File bottom
82 .It Page Up
83 Scroll one page up
84 .It Page Down
85 Scroll one page down
86 .It Esc
87 Repeat last cmd # times
88 .It CTRL+A
89 Start of line
90 .It CTRL+B
91 Word backward
92 .It CTRL+C
93 Save from marked location to current cursor location
94 .It CTRL+D
95 Reverse scroll
96 .It CTRL+E
97 End of line
98 .It CTRL+F
99 Word forward
100 .It CTRL+G
101 Insert a file at cursor
102 .It CTRL+K
103 Delete from marked location to current cursor location
104 .It CTRL+L
105 Erase and redraw screen
106 .It CTRL+N
107 Delete next word
108 .It CTRL+P
109 Delete previous word
110 .It CTRL+Q
111 Insert the contents of the save file into new file
112 .It CTRL+S
113 Run shell
114 .It CTRL+T
115 Delete to end of line
116 .It CTRL+U
117 Forward scroll
118 .It CTRL+V
119 Visit another file
120 .It CTRL+W
121 Write current file
122 .It CTRL+X
123 Exit
124 .It CTRL+Y
125 Insert the contents of the save file at cursor
126 .It CTRL+\e\\&
127 Abort current operation
128 .It CTRL+@
129 Set mark
130 .It CTRL+^
131 Screen top
132 .It CTRL+_
133 Screen bottom
134 .It CTRL+]
135 Goto line #
136 .El
137 .Sh SEE ALSO
138 .Xr ed 1 ,
139 .Xr ee 1 ,
140 .Xr vi 1
141 .Sh HISTORY
142 The
143 .Nm
144 utility first appeared in Minix.
145 It was brought into PicoBSD for a
146 time, and some work was done on it, then later brought into
147 .Dx
148 where some additional usability work was done on it.