doc: ctlseqs: document CC0 control sequences

This commit is contained in:
Daniel Eklöf 2021-01-09 13:05:19 +01:00
parent e1dd1fe6e8
commit 38e2700f74
No known key found for this signature in database
GPG key ID: 5BBD4992C116573F
2 changed files with 47 additions and 1 deletions

45
doc/foot-ctlseqs.5.scd Normal file
View file

@ -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.

View file

@ -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)