~~NOTOC~~
====== PCB @ MACROS ======

PCB "AT" Codes allow you to incorporate live variables into your static text, making more intelligent prompts and ANSI graphics.

===== Alphabetically =====

==== A ====

^ @ACTIVE@ ^ Number of nodes with users logged in. |
^ @ALIAS@ ^ Current Users Alias/Nickname. |
^ @ANODES@ ^ Available Nodes per License. |
^ @ATTRIBUTES@ ^ JAM Attributes for the current message. |
^ @AUTOMORE@ ^ Subsequent more prompts are treated as PAUSE. |

==== B ====

^ @BBS@ ^ The name of the bulletin board system. |
^ @BEEP@ ^ Send a beep to the caller terminal. |
^ @BOARDNAME@ ^ The name of the bulletin board system. |
^ @BPS@ ^ Communications Speed, 115200. |
^ @BLACK@ ^ Sends the ANSI sequence for Black Text and Background. |
^ @BUILD@ ^ The CodeRunner Compile Options and Build Number. |
^ @BOXTOP#@ ^ Draws a single lined top of a box, # characters wide. |
^ @BOXSIDE#@ ^ Draws a single lined left and right of a box, # characters wide. |
^ @BOXBOTTOM#@ ^ Draws a single lines bottom of a box, # characters wide. |

(todo list):
  BYTELIMIT = Number of bytes that can be downloaded on a daily basis.
  BYTERATION = Current byte ratio of caller.
  BYTESLEFT = Number of bytes user can download during current call.

==== C ====

^ @CARRIER@ ^ Carrier speed of caller as reported by the modem. |
^ @CELLPHONE@ ^ The Primary Phone Number on File. |
^ @CITY@ ^ Information entered in the city field of user's record. |
^ @CLREOL ^ Clears the rest of the line using the current colors. |
^ @CLS@ ^ Clears the Screen and Homes the Cursor. |
^ @COMPILER@ ^ The CodeRunner Compile Options and Build Number. |
^ @CONFNAME@ ^ The current message group or conference. |
^ @CONFNUM@ ^ The number for the current message or conference room. |
^ @CONFPATH@ ^ Only Security Level 100+ can see, physical path and file for the current message area. |
^ @CONN@ ^ Carrier speed of caller as reported by the modem. |
^ @COPYRIGHT@ ^ Source code Copyright Notice. |
^ @CSI@ ^ Embeds the ESCAPE and [ part of an ANSI sequence. |
^ @CURMSGNUM@ ^ Current message number queued for reading. |
^ @CURMSGFROM@ ^ Current message From. |
^ @CURMSGTO@ ^ Current message To. |
^ @CURMSGSUBJ@ ^ Current message Subject. |


(todo list):

==== D ====

^ @DATETIME@ ^ Current Date Time dd-mmm-yyyy hh:nn:ss.zzz |
^ @DATEWRITTEN@ ^ Message Create Date Time dd-mmm-yyyy (hh:nn) |
^ @DATAPHONE@ ^ Information entered in the data phone field of user's record. |
^ @DAYBYTES@ ^ Number of bytes downloaded today. |
^ @DIR@ ^ Current File Directory. |
^ @DIRL@ ^ Current File Directory Description. |
^ @DIRNAME@ ^ Current File Directory. |
^ @DIRNUM@ ^ Current Directory ID Number. |
^ @DN@ ^ Current Directory ID Number. |
^ @DOMAIN@ ^ Reverse Callers IP to FQDN. |
^ @DOWN@ ^ Sends ANSI Down Sequence. |

(todo):

  DELAY = DELAY:nn Pause for the nn tenths of a second.
  DLBYTES = DLBYTES Total number of bytes downloaded by the caller.
  DLFILES = DLFILES Total number of files download by the caller.
  DAYBYTES = DAYBYTES Maximum number of bytes per day for this caller.
  
==== E ====

^ @ECHONAME@ ^ Displays the current Echo/Message Area Name. |
^ @ECHONUM@ ^ Displays the current Echo/Message Area ID Number. |
^ @ESC@ ^ Send the ESC key. |
^ @EXPERT@ ^ Displays callers current display mode Expert or Novice. |

(todo):

  EVENT = EVENT The time that the next event is scheduled to take place.
  EXPDATE = EXPDATE Expiration date of the caller.
  EXPDAYS = EXPDAYS Number of days until the user's subscription will expire
  EXPLEVEL = New Security Level after Subscription Expires.
  ENV=variable = Displays Environment Variable.
==== F ====

^ @FIRST@ ^ Callers First Name. |
^ @FIRSTU@ ^ Callers First Name in all Uppercase. |
^ @FREESPACE@ ^ Bytes available for uploading in the current conference. |

(todo):

  FILERATIO = FILERATIO Current file ratio of the caller.
  FNUM = Number of Files queued.
  FILECREDIT
  FFILES = # of files flagged for download.
  FBYTES = Bytes of files flagged for download.
  
==== G ====

^ @GOTOLINE#@ ^ Sends the ANSI sequence to go to the start of line #. |
^ @GOTOHEIGHT@ ^ Sends the ANSI sequence to go to the start of the bottom line. |

==== H ====

  HANGUP = {COMMENTED FOR OBVIOUS REASONS} HANGUP Disconnect the caller.
  HIGHMSGNUM = 41 High message number in message base.
  HOMEPHONE = 804-938-3325 Information entered in the home phone field of user record.

==== I ====

  INFILE = (ArakNet.ark_sysop Conference) Current conference number and name.
  IP = 172.241.27.198 IP Address of the caller.
  
==== K ====

  KBLEFT = KBLEFT BYTESLEFT expressed in kilobytes.
  KBLIMIT = KBLIMIT BYTELIMIT expressed in kilobytes.
  
==== L ====

  LASTCALLERNODE = LASTCALLERNODE The last user that called the current node.
  LASTCALLERSYSTEM = LASTCALLERSYSTEM The last user that called the system.
  LASTDATEON = 02-Jan-2020 Last date the caller called the system.
  LASTTIMEON = 12:25 Last time the caller called the system.
  LMR = 35 Last message read by user in the current conference.
  LOWMSGNUM = 1 Low message number in the message base.
  
==== M ====

  MINLEFT = 495 Minutes left on system (includes download time estimates).
  MORE = **(492 min. left), More?** Interrupt display asking caller if they wish to see more.
  MSGLEFT = 1 Total number of messages entered by the user.
  MSGREAD = 196 Total number of messages read by the user.
  
==== N ====

  NODE = 11 The current node number.
  NUMBLT = Soon to be Unlimited The number of bulletins defined in the current conference.                                                                        NUMCALLS = NUMCALLS Total number of calls answered by the BBS.
  NUMDIR = Unlimited Number of file directories in current conference.
  NUMTIMESON = 791 Number of times user has called the system.
  
==== O ====

  OFFHOURS = OFFHOURS Hours that lower speed callers can call into the system.
  OPTEXT = OPTEXT Used in PCBTEXT to transfer information by Legacy/X.
  
==== P ====

  PAUSE =  Same as MORE but auto-continues after 300 seconds.
  POS = POFF Disable normal more prompts when screen fills up.
  PON = PON Enable normal more prompting usage.
  POS = POS:nn Advance cursor to position nn.
  PRODESC = PRODESC Description of the default protocol selected.
  PROLTR = PROLTR Default protocol selected by the current caller.
  
==== Q ====

  QOFF = QOFF Do not allow the display of the file to be aborted.
  QONN = QON Allow the file display to be aborted.
  
==== R ====

^ @RESTORESCREEN@ ^ Sends the ANSI sequence to restore from 1,1,@WIDTH@,@GOTOHEIGHT@ |

==== S ====

  SECURITY = 100 Current security level of the caller.
  SYSDATE = 02-Jan-2020 The current system date.
  SYSOPIN = SYSOPIN Beginning time when the SysOp is available for chat.
  SYSOPOUT = SYSOPOUT Ending time when the SysOp is available for chat.
  SYSTIME = 12:52 The current system time.
  
==== T ====

  TIMELEFT = 490 Minutes left on system (excludes download time estimates).
  TIMELIMIT = TIMELIMIT The daily/session time limit of the caller.
  TIMEUSED = 11 Total number of minutes used during current call.
  TOTALTIME = TOTALTIME Total number of minutes used during current day.
  
==== U ====

  UPBYTES = UPBYTES Total number of bytes uploaded by the caller.
  UPFILES = UPFILES Total number of files uploaded by the caller.
  USER = OZZ NIXON The caller's name displayed in uppercase.
  
==== V ====

  VERSION = VERSION Display the current version of your Legacy/X software.
  
==== W ====

^ @WAIT@ ^ Interrupt display of file with a Press Enter prompt, after the rest of this line is processed. |
^ @WAITNOW@ ^ Interrupts display of file with Press Enter prompt right now, then processes the rest of the line after user presses Enter. |

(todo list):
  WHO = WHO Prints a list of who is currently online. (for all licensed nodes).
  
==== X ====

^ @XON@ ^ This is filtered out, not applicable to TCP communications. |
^ @XOFF@ ^ This is filtered out, not applicable to TCP communications. |