1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-05-22 17:25:07 +00:00
serenity/Base/usr/share/man/man1/TextEditor.md
electrikmilk 74238d0aba Base: Add icons to man pages for GUI applications
Differentiate GUI applications in man pages with icons.
2022-01-16 22:41:31 -08:00

31 lines
683 B
Markdown

## Name
![Icon](/res/icons/16x16/app-text-editor.png) TextEditor - SerenityOS text editor
[Open](file:///bin/TextEditor)
## Synopsis
```**sh
$ TextEditor [--preview-mode mode] [file[:line[:column]]]
```
## 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[:line[:column]]`: File to edit, with optional starting line and column number
## Examples
```sh
$ TextEditor /home/anon/Documents/emoji.txt
$ TextEditor /home/anon/Documents/emoji.txt:5:12
```