Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
custom:ctrl-a_codes [2019/04/02 00:41] – [Control] Document the Ctrl-A \ (back-slash) sequence digital man | custom:ctrl-a_codes [2020/05/11 18:02] – [Control] Add mouse hot-spot related Ctrl-A codes digital man |
---|
====== Ctrl-A (Attribute) Codes ====== | ====== Attribute (Ctrl-A) Codes ====== |
"Control A" codes (a.k.a. ^A codes) are terminal control sequences embedded in Synchronet text and menu display files. | //Attribute Codes// (a.k.a. ^A codes) are terminal control sequences embedded in Synchronet text and menu display files. |
| |
===== Background ===== | ===== Background ===== |
It can sometimes require a special purpose text editor to actually enter a Ctrl-A character into a text file. Some editors may require a special key sequence or use of a menu option to enter a Ctrl-A character into a file. The graphical representation of the character may be a happy face or any other non-alphanumeric symbol that the editor chooses to render to represent that character code. There are [[atcodes|@-Codes]] for the equivalent of many of the Ctrl-A codes, so may consider using them if they are more convenient for your text editor of choice. | It can sometimes require a special purpose text editor to actually enter a Ctrl-A character into a text file. Some editors may require a special key sequence or use of a menu option to enter a Ctrl-A character into a file. The graphical representation of the character may be a happy face or any other non-alphanumeric symbol that the editor chooses to render to represent that character code. There are [[atcodes|@-Codes]] for the equivalent of many of the Ctrl-A codes, so may consider using them if they are more convenient for your text editor of choice. |
| |
In the ''[[custom:text.dat]]'' and possibly some other files (e.g. [[JavaScript]] and [[:util:Baja]] source files), Ctrl-A characters may be included by using the escape sequence ''\1'' rather than having to insert an actual control character into the file. | In the ''[[custom:text.dat]]'' and possibly some other files (e.g. [[JavaScript]] and [[:util:Baja]] source files), Ctrl-A characters may be included by using the escape sequence ''\1'' (or ''\x01'') rather than having to insert an actual control character into the file. |
| |
The [[util:ANS2ASC]] utility may be used to convert files encoded with ANSI X3.64 terminal escape sequences (e.g. ''*.ans'') into Ctrl-A encoded output and the [[util:ASC2ANS]] utility can be used to perform the opposite operation (useful for editing Ctrl-A encoded files (e.g. ''*.msg'' or ''*.asc'') with an //[[resource:ansi editors|ANSI-BBS screen editor]]//). | The [[util:ANS2ASC]] utility may be used to convert files encoded with ANSI X3.64 terminal escape sequences (e.g. ''*.ans'') into Ctrl-A encoded output and the [[util:ASC2ANS]] utility can be used to perform the opposite operation (useful for editing Ctrl-A encoded files (e.g. ''*.msg'' or ''*.asc'') with an //[[resource:ansi editors|ANSI-BBS screen editor]]//). |
| |
^Attribute ^ Code ^Description ^ | ^Attribute ^ Code ^Description ^ |
|High | ''H'' |High Intensity (bright) foreground | | |Bright | ''H'' |High Intensity foreground | |
|Blink | ''I'' |Blinking (slow) or high intensity (bright) background (so-called iCE colors) when supported | | |Blink | ''I'' |Blinking (slow), when supported by the terminal | |
|Blink-Font | ''f'' |Set the //Blink// attribute **only** if a alternate [[config:fonts.ini|Blink-font]] has been activated in the terminal (new in v3.17) | | |Bright-Background | ''E'' |High intensity background (so-called iCE colors), when supported by the terminal (new in v3.17c) | |
|High-Blink-Font | ''F'' |Set the //Blink// attribute **only** if a alternate [[config:fonts.ini|High-intensity Blink-font]] has been activated in the terminal (new in v3.17) | | |Blink-Font | ''f'' |Set the //Blink// attribute **only** if a alternate [[config:fonts.ini|Blink-font]] has been activated in the terminal (new in v3.17) | |
|Normal | ''N'' |No Special Attributes (Normal, e.g. light-gray) | | |High-Blink-Font | ''F'' |Set the //Blink// attribute **only** if a alternate [[config:fonts.ini|High-intensity Blink-font]] has been activated in the terminal (new in v3.17) | |
|Optimized Normal | ''-'' |Only changes to //normal// if High Intensity, Blinking, or Background attribute is set (or pop attributes if pushed)| | |Normal | ''N'' |No Special Attributes (Normal, e.g. light-gray) - resets both //High// and //Blink// attributes | |
|Optimized Normal | ''_'' |Only changes to //normal// if the Blinking or Background attribute is set | | |Optimized Normal | ''-'' |Only changes to //normal// if High Intensity, Blinking, or Background attribute is set (or pop attributes if pushed)| |
| |Optimized Normal | ''_'' |Only changes to //normal// if the Blinking or Background attribute is set | |
| |
| ==== High Intensity and Blink ==== |
| The //High Intensity// console attribute behaves as it does with ANSI terminals: that is, once enabled, the current color and any subsequent new colors will be rendered in their "high intensity" (bright) version. To revert to normal/dark colors, a //Normal// (or //Optimized Normal//) Ctrl-A code must be specified. The //Normal// attribute code will reset both the //High Intensity// and the current color - back to the default, "light gray". |
| |
| The //Blink// console attribute behaves similarly: once set, all newly-printed characters will have the blink attribute until a //Normal// attribute code is encountered. |
===== Control ===== | ===== Control ===== |
| |
|Delay | '';'' |Delay for one half second| | |Delay | '';'' |Delay for one half second| |
|Delay | ''.'' |Delay for two seconds| | |Delay | ''.'' |Delay for two seconds| |
|Cls | ''L'' |Clear the screen and home the cursor| | |Cls | ''L'' |Clear the screen, clear any existing mouse hot-spots, and home the cursor | |
|Home | ''`'' |Home the cursor (without necessarily clearing the screen)| | |Home | ''''' |Home the cursor (without necessarily clearing the screen, used to be ''`'')| |
| |Hungry-hotspot | ''~'' |Precedes a single-character hungry mouse hot-spot command (CR if next character is a ctrl char or end of string) | |
| |Strict-hotspot | ''`'' |Precedes a single-character strict mouse hot-spot command (or "Home" if next character is a ctrl char or end of string) | |
|Clreos | ''J'' |Clear to end of screen (leave cursor in current position)| | |Clreos | ''J'' |Clear to end of screen (leave cursor in current position)| |
|Clreol | ''>'' |Clear to end of line (leave cursor in current position)| | |Clreol | ''>'' |Clear to end of line (leave cursor in current position)| |