aboutsummaryrefslogtreecommitdiffstats
path: root/ed.1
diff options
context:
space:
mode:
authornytpu <alex@nytpu.com>2021-05-26 12:33:03 -0600
committernytpu <alex@nytpu.com>2021-05-26 14:27:19 -0600
commit667f04b71a500ba2f794ed6325b2ad70d97b80e6 (patch)
tree5a1c3995502af84dafc9db344e546919eba5fbdf /ed.1
parentadd usage() (diff)
downloaded-667f04b71a500ba2f794ed6325b2ad70d97b80e6.tar.bz2
ed-667f04b71a500ba2f794ed6325b2ad70d97b80e6.zip
add (unfinished) ed(1) page
Diffstat (limited to 'ed.1')
-rw-r--r--ed.1135
1 files changed, 135 insertions, 0 deletions
diff --git a/ed.1 b/ed.1
new file mode 100644
index 0000000..0ec0e08
--- /dev/null
+++ b/ed.1
@@ -0,0 +1,135 @@
+.\" To view this file, use `man -l ed.1`
+.\" To view in other formats, look into mandoc(1) (recommended) or troff(1)
+.
+.\" Copyright (c) 2021 nytpu <alex@nytpu.com>
+.\" SPDX-License-Identifier: GPL-3.0-only
+.\" For more license details, see LICENSE or <https://www.gnu.org/licenses/gpl-3.0.html>.
+.Dd May 26, 2021
+.Dt ED 1
+.Os
+.
+.Sh NAME
+.Nm ed
+.Nd line editor
+.
+.Sh SYNOPSIS
+.Nm
+.Op Fl h
+.Op Fl p Ar string
+.Op Fl s
+.Op Fl v
+.Op Fl V
+.Op Ar file
+.
+.Sh DESCRIPTION
+The
+.Nm
+utility is a line-based text editor.
+It can be used create, display, modifiy, and otherwise manipulate text files
+interactively or via a script.
+.\" TODO
+.
+.Sh OPTIONS
+.Bl -tag -width indent
+.It Fl h
+Display simplified usage information.
+.It Fl p Ar string
+Use
+.Ar string
+as the prompt string when in command mode.
+It can be toggled on and off with the
+.Em P
+command.
+.It Fl s
+Suppress diagnostics (if enabled), byte counts displayed when reading and
+writing, and the
+.Dq \&!
+prompt.
+Should be used if
+.Nm Ns 's
+standard input is from a script.
+.It Fl v
+Output verbose error messages.
+Equivalent to the
+.Em H
+command.
+.It Fl V
+Display version and copyright information.
+.It Ar file
+Specify a filename to read into the buffer.
+The default filename will be set to
+.Ar file .
+Essentially, it will act as if the
+.Em e
+command had been provided on the given
+.Ar file
+before accepting commands from stdin.
+.El
+.
+.Sh LINE ADDRESSING
+.\" TODO
+.
+.Sh REGULAR EXPRESSIONS
+.\" TODO
+.
+.Sh COMMANDS
+.\" TODO
+.
+.Sh DIAGNOSTICS
+.\" TODO
+.
+.Sh FILES
+.\" TODO
+.
+.Sh SEE ALSO
+.Xr ed 1p
+.Rs
+.%A Michael W Lucas
+.%B Ed Mastery: The Standard Unix Text Editor
+.%D April 1, 2018
+.%I Tilted Windmill Press
+.Re
+.
+.Sh STANDARDS
+This implementation of
+.Nm
+conforms to
+.St -p1003.1-2008
+in all cases where said standard is applicable
+.Po
+See
+.Sx LIMITATIONS
+below
+.Pc .
+.
+.Sh AUTHORS
+Documentation and software by
+.An nytpu Aq Mt alex@nytpu.com
+.
+.Sh BUGS
+The upstream URL of this project is
+.Aq Lk https://git.nytpu.com/ed .
+Send suggestions, bugs, and other contributions to
+.Aq Mt alex@nytpu.com .
+For help sending a patch through email, see
+.Aq Lk https://git-send-email.io .
+.
+.Sh LIMITATIONS
+This implementation of
+.Nm
+does not implement the
+.Nm red
+restricted editor.
+It is the opinion of the author that the usefulness of
+.Nm red
+is obviated by modern security considerations and the fact that using
+.Nm
+as the default editor on a contemporary system is very unlikely.
+The author recommends using a
+.Xr chroot 1
+jail if preventing a user from running commands or editing outside the current
+directory is desired.
+This would then allow the user to use their editor of choice, such as
+.Xr vi 1
+as well as
+.Nm .