diff options
| author | Brendan Coles <bcoles@gmail.com> | 2021-01-16 15:06:20 +0000 |
|---|---|---|
| committer | Andreas Kling <kling@serenityos.org> | 2021-01-16 19:35:08 +0100 |
| commit | aa8cb35b90899b0f7badd53b89d8bbda2d2b2cae (patch) | |
| tree | e9abc55c08f8b953a674850b2814123b0841673f /Base/usr | |
| parent | 20f53c746267dd24629eec27cfc34f4b648b62d3 (diff) | |
| download | serenity-aa8cb35b90899b0f7badd53b89d8bbda2d2b2cae.zip | |
TextEditor: Add help documentation
Diffstat (limited to 'Base/usr')
| -rw-r--r-- | Base/usr/share/man/man1/TextEditor.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/Base/usr/share/man/man1/TextEditor.md b/Base/usr/share/man/man1/TextEditor.md new file mode 100644 index 0000000000..6decf1cca5 --- /dev/null +++ b/Base/usr/share/man/man1/TextEditor.md @@ -0,0 +1,28 @@ +## Name + +TextEditor - SerenityOS text editor + +## Synopsis + +```**sh +$ TextEditor [--preview-mode mode] [file] +``` + +## Description + +TextEditor is a text document editor for SerenityOS featuring a preview mode +which allows automatic live rendering of HTML and Markdown documents. + +## Options + +* `--preview-mode mode`: Preview mode, one of 'none', 'html', 'markdown', 'auto' + +## Arguments: + +* file: File to edit + +## Examples + +```sh +$ TextEditor /home/anon/Documents/emoji.txt +``` |