NAME

sued - the text editor of all time, a post-classic line editor

SYNOPSIS

sued [file]

DESCRIPTION

sued is a vector-oriented line editor written in Rust by Arsalan Kazmi in the image of the standard text editor, ed.

sued is not nearly as powerful as its inspiration, but it matches it in the terseness department, while at the same time being quite a bit more user-friendly.

It's worth noting that sued is not that fully-featured, and is still in early stages of development, however, it's still very usable!

OBTAINING

sued is available on crates.io - you can get it with cargo install sued.

Go to the GitHub page if you want to check out sued for yourself, or if you want to help me work on it.

OPTIONS

None yet, lmao. Maybe in the future, but not now.

COMMANDS

All commands start with ~. Run ~ by itself to see a list of commands.

~clear - Clear the buffer contents.

~save [filename] - Write the file buffer to the provided file name.

~open [filename] - Find or create a file and open its contents up in sued.

~show [start] [end] - Display the buffer contents, complete with line numbers. You can specify the start and end point if you wish.

~insert [line] - Interactively insert text into the chosen position in the buffer.

~replace [line] - Interactively replace the chosen line's contents in the buffer.

~swap [source] [target] - Swap two lines with each other in the buffer.

~delete [line] - Immediately remove a line from the buffer.

~substitute [line] [pattern]/[replacement] - Perform a regex substitution on the chosen line number, with the pattern and replacement.

~search [term] - Searches for the given term in the buffer and prints matching lines.

~indent [line] [level] - Indent the specified line by a number of spaces. A negative level will outdent.

~run [command] - Run the provided executable or shell builtin. Real executables will be prioritised over shell builtins.

~exit - Quit sued, discarding the buffer contents.

~help - Display the list of commands with descriptions.

~about - Display some information about sued onto the screen.

FAQ

• Why a line editor?
1. I like ed. I find it extremely pleasant to use, despite its terseness. I wanted to try my hand at writing a similar text editor, just a lot less complex.
2. I don't want to go insane trying to develop a Vim-like editor. Especially not when projects like Helix exist.
• If it's ed-like, why not copy ed's syntax?

sued is actually more modelled after my earlier attempt at a line editor, Streakline. In Streakline, editing is straightforward. You open the editor and start typing. It used commands prefixed with ~, so sued does too.

• What does sued stand for?

It stands for "shut up editor".

• How do you pronounce sued?

"soo-ed". Don't pronounce it "sood".

• "Post-classic"?

It's a play on words, since Helix describes itself as "post-modern" -- sued is "post-classic".

DIAGNOSTICS

When an error occurs that sued can't recover from, it will print an error message as follows and quit:

stop: ERROR_CODE: 0xXXXXXXXX (0xXXXXXXXX,0xXXXXXXXX,0xXXXXXXXX)

The currently implemented error codes are as follows:

• USER_IS_STUPID - The user manually initiated a crash.
• EDITOR_OVERFLOW - The editor tried to run itself and got stuck.

SEE ALSO

ed(1), streakline(1)

LIMITATIONS

sued can edit text just fine, but there's still quite a bit of functionality left to be implemented.

HISTORY

sued was, technically speaking, initially developed at the University of Hertfordshire (because I'm a student there), but practically speaking it wasn't developed under their watch or on their systems, or even for them. sued is a project by me, Arsalan Kazmi, first and foremost, no matter where it's worked on from, and UH holds no copyright over it.

BUGS

Yes.