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