diff options
| author | Daniel Eklöf <daniel@ekloef.se> | 2021-01-09 12:05:19 +0000 |
|---|---|---|
| committer | Daniel Eklöf <daniel@ekloef.se> | 2021-02-23 08:31:44 +0000 |
| commit | 38e2700f743f860981630d52431f23fa0af8e1a2 (patch) | |
| tree | 7e4ff7cefed11e3f74e761a3e8efe24c5d4d8f51 /doc | |
| parent | Merge branch 'dracula-theme' (diff) | |
doc: ctlseqs: document CC0 control sequences
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/foot-ctlseqs.5.scd | 45 | ||||
| -rw-r--r-- | doc/meson.build | 3 |
2 files changed, 47 insertions, 1 deletions
diff --git a/doc/foot-ctlseqs.5.scd b/doc/foot-ctlseqs.5.scd new file mode 100644 index 00000000..c6add65e --- /dev/null +++ b/doc/foot-ctlseqs.5.scd @@ -0,0 +1,45 @@ +foot-ctlseqs(5) + +# DESCRIPTION + +This document describes all the control sequences supported by foot. + +- CC0 - 7-bit control sequences +- CSI +- OSC +- DCS + +# CC0 - 7-bit control sequences + +[[ *Sequence* +:[ *Name* +:[ *Description* +| *\\a* +: BEL +: Depends on what *bell* in *foot.ini*(5) +| *\\b* +: BS +: Backspace; moves the cursor left one step. Wraps is _bw_ is enabled. +| *\\t* +: HT +: Horizontal tab; moves the cursor to the next tab stop. +| *\\n* +: LF +: Line feed; moves the cursor down one step, or scrolls content up if + at the bottom line. +| *\\v* +: VT +: Vertical tab; identical to _LF_. +| *\\f* +: FF +: Form feed; identical to _LF_. +| *\\r* +: CR +: Carriage ret; moves the cursor to the left most column. +| *\\x0E* +: SS0 +: Shift out; selects the _G1_ character set. +| *\\x0F* +: SS1 +: Shift in; selects the _G0_ character set. + diff --git a/doc/meson.build b/doc/meson.build index 1f017db4..4d5c7118 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -5,7 +5,8 @@ scdoc_prog = find_program(scdoc.get_pkgconfig_variable('scdoc'), native: true) foreach man_src : [{'name': 'foot', 'section' : 1}, {'name': 'foot.ini', 'section': 5}, - {'name': 'footclient', 'section': 1}] + {'name': 'footclient', 'section': 1}, + {'name': 'foot-ctlseqs', 'section': 5}] name = man_src['name'] section = man_src['section'] out = '@0@.@1@'.format(name, section) |
