Ignore additional stty control characters like ^Y which interfere with
[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.2 2005/03/15 02:45:59 dillon 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 SEE ALSO
56 .Xr vi 1 ,
57 .Xr ed 1 ,
58 .Xr ee 1 
59 .Sh CAVEATS
60 This utility is designed as an emergency editor for single-user mode
61 when /usr is not available.  The terminal type is hardwired to either
62 an xterm or cons25 (video console).  The editor understands stty 
63 rows and columns but is otherwise meant to be fairly minimal in scope.
64 .Sh HISTORY
65 The
66 .Nm
67 utility first appeared in Minix .  It was brought into PicoBSD for a
68 time, and some work was done on it, then later brought into DragonFly
69 where some additional usability work was done on it.