Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
custom:atcodes [2019/09/19 19:54] – [System Information] Added FILES and FILES:<code> digital man | custom:atcodes [2020/04/23 19:45] – [User Information] Added FIRSTON, FIRSTTIMEON, FIRSTDATEON digital man |
---|
==== Format Modifiers ==== | ==== Format Modifiers ==== |
| |
Most @-codes support an optional format modifier. Modifiers are appended to the end of the @-code variable name and before the terminating ''@'' character. Only one format modifier may be used per @-code instance; you cannot combine format modifiers. | Most @-codes support an optional format modifier. Modifiers are appended to the end of the @-code variable name and before the terminating ''@'' character, separated from the code itself with either a hyphen (''-'') or a pipe (''|'') character. |
| |
| When using the hyphen (''-'') modifier separator, only one format modifier may be used per @-code instance (you cannot combine format modifiers) and @-code arguments (separated from the code with a colon) are **not** supported). |
| |
| When using the pipe (''|'') modifier separator, some modifiers may be combined with others (e.g. ''|TR'') and @-code arguments (separated from the code with a colon) **are** supported. |
| |
^ Modifier ^ Purpose ^ | ^ Modifier ^ Purpose ^ |
| ''-L'' | Pad and left-justify an expanded @-code | | | ''L'' | Pad and left-justify an expanded @-code | |
| ''-R'' | Pad and right-justify an expanded @-code | | | ''R'' | Pad and right-justify an expanded @-code | |
| ''-C'' | Pad and center an expanded @-code (added in v3.17b) | | | ''C'' | Pad and center an expanded @-code (added in v3.17b) | |
| ''-W'' | Displays double-wide using "fullwidth" Unicode code points if possible, spaces between the characters otherwise | | | ''W'' | Displays double-wide using "fullwidth" Unicode code points if possible, spaces between the characters otherwise | |
| ''-Z'' | Zero-pad and right-justify an expanded @-code (added in v3.17b) | | | ''Z'' | Zero-pad and right-justify an expanded @-code (added in v3.17b) | |
| ''->'' | Allow the terminal to wrap (don't truncate) overly-long expanded @-codes (added in v3.17c) | | | ''T'' | Thousands-separated (e.g. with a comma) numeric values, may be combined with other modifiers (added in v3.17c) | |
| | ''>'' | Allow the terminal to wrap (don't truncate) overly-long expanded @-codes (added in v3.17c) | |
| |
=== Width Specificity === | === Width Specificity === |
A string //width//, specified as a positive decimal number, may immediately follow a format modifier. | A string //width//, specified as a positive decimal number, may immediately follow a format modifier. |
| |
Example: ''@NODE-L2@'' for a left-justified 2 character (space padded) node number or ''@NODE-Z2@'' for a right-justified 2 digit (zero-padded) node number. | Example: ''@NODE|L2@'' for a left-justified 2 character (space padded) node number or ''@NODE|Z2@'' for a right-justified 2 digit (zero-padded) node number. |
| |
Another method of specifying the width of an expanded @-code is to include non-numeric non-space characters between the modifier and the trailing ''@'' character. | Another method of specifying the width of an expanded @-code is to include non-numeric non-space characters between the modifier and the trailing ''@'' character. |
| |
Example: ''@ALIAS-R###########@'' for a right-justified 20 character user alias (any non-numeric non-space characters could have been used in place of the ''#'' characters). | Example: ''@ALIAS|R###########@'' for a right-justified 20 character user alias (any non-numeric non-space characters could have been used in place of the ''#'' characters). |
| |
=== Truncation === | === Truncation === |
When a //width// is specified, expanded @-code strings which are **longer** than the specified width will be truncated (shortened) to adhere to the requested width. The left-most characters are preserved/displayed while the right-most characters are truncated (lost). | When a //width// is specified, expanded @-code strings which are **longer** than the specified width will be truncated (shortened) to adhere to the requested width. The left-most characters are preserved/displayed while the right-most characters are truncated (lost). |
| |
By default, //most// expanded @-codes that would reach the last column of the terminal screen are truncated (shortened) so as to not cause an automatic line-wrap of the user's terminal. If you wish for an expanded @-code to be displayed in the last terminal column, or beyond ( possibly causing an automatic line-wrap of the terminal) use the ''->'' format modifier. | By default, //most// expanded @-codes that would reach the last column of the terminal screen are truncated (shortened) so as to not cause an automatic line-wrap of the user's terminal. If you wish for an expanded @-code to be displayed in the last terminal column, or beyond ( possibly causing an automatic line-wrap of the terminal) use the ''>'' format modifier. |
| |
=== Exceptions === | === Exceptions === |
@-codes that take an argument value, preceded by a colon ('':'') character cannot be used with format modifiers. | @-codes that take an argument value, preceded by a colon ('':'') character, cannot be used with format modifiers when using the hyphen (-) modifier separator; use the pipe (|) modifier separator instead. |
===== System Information ===== | ===== System Information ===== |
| |
|FILES | |Number of files in the user's currently selected file transfer directory | | |FILES | |Number of files in the user's currently selected file transfer directory | |
|FILES://<code>// | |Number of files in the file transfer directory specified by internal-//code// | | |FILES://<code>// | |Number of files in the file transfer directory specified by internal-//code// | |
| |FILES://<path>// | |Number of files in the directory specified by //path// | |
| |FILESIZE | |Total size of all files in the user's currently selected file transfer directory | |
| |FILESIZE://<code>//| |Total size of all files in the file transfer directory specified by internal-//code//| |
| |FILESIZE://<path>//| |Total size of all files matching the path/filespec specified in //path//| |
| |FILEKB | |Total size (in kibibytes) of all files in the user's currently selected file transfer directory | |
| |FILEKB://<code>// | |Total size (in kibibytes) of all files in the file transfer directory specified by internal-//code//| |
| |FILEKB://<path>// | |Total size (in kibibytes) of all files matching the path/filespec specified in //path//| |
| |FILEMB | |Total size (in mebibytes) of all files in the user's currently selected file transfer directory | |
| |FILEMB://<code>// | |Total size (in mebibytes) of all files in the file transfer directory specified by internal-//code//| |
| |FILEMB://<path>// | |Total size (in mebibytes) of all files matching the path/filespec specified in //path//| |
| |FILEGB | |Total size (in gibibytes) of all files in the user's currently selected file transfer directory | |
| |FILEGB://<code>// | |Total size (in gibibytes) of all files in the file transfer directory specified by internal-//code//| |
| |FILEGB://<path>// | |Total size (in gibibytes) of all files matching the path/filespec specified in //path//| |
|FREESPACE | |Free disk space available for uploads (in bytes) | | |FREESPACE | |Free disk space available for uploads (in bytes) | |
|FREESPACEK | |Free disk space available for uploads (in kilobytes) | | |FREESPACEK | |Free disk space available for uploads (in kibibytes) | |
|FULL_VER | |Synchronet full version number (e.g. "3.15a")| | |FULL_VER | |Synchronet full version number (e.g. "3.15a")| |
|GRP | |Current message group short description | | |GRP | |Current message group short description | |
|DLBYTES | |Total bytes downloaded by user | | |DLBYTES | |Total bytes downloaded by user | |
|DLFILES |DOWNS |Total files downloaded by user | | |DLFILES |DOWNS |Total files downloaded by user | |
|DLKLIMIT | |User's total credits (in kilobytes) | | |DLKLIMIT | |User's total credits (in kibibytes) | |
|DOWNK | |Total kilobytes downloaded by user | | |DOWNK | |Total kibibytes downloaded by user | |
|EMAILADDR | |User's Internet e-mail address on your system | | |EMAILADDR | |User's Internet e-mail address on your system | |
|EXPDATE |EXDATE |User's expiration date (in "MM/DD/YY" or "DD/MM/YY" format) | | |EXPDATE |EXDATE |User's expiration date (in "MM/DD/YY" or "DD/MM/YY" format) | |
|EXPDAYS | |Days left before user expires | | |EXPDAYS | |Days left before user expires | |
|FIRST | |First word of user's alias | | |FIRST | |First word of user's alias | |
| |FIRSTON | |Date and time of user's first logon | |
| |FIRSTDATEON |SINCE |Date of user's first logon (in "MM/DD/YY" or "DD/MM/YY" format) | |
| |FIRSTTIMEON | |Time of user's first logon (in "HH:MM am" format) | |
|FIRSTREAL |REAL |First word of user's real name | | |FIRSTREAL |REAL |First word of user's real name | |
|FROM | |User's location (e.g. "City, State") | | |FROM | |User's location (e.g. "City, State") | |
|LASTTIMEON | |Time of user's last logon (in "HH:MM am" format) | | |LASTTIMEON | |Time of user's last logon (in "HH:MM am" format) | |
|LASTREAL | |Last word of user's real name | | |LASTREAL | |Last word of user's real name | |
|KBLEFT | |User's total credits (in kilobytes) | | |KBLEFT | |User's total credits (in kibibytes) | |
|KBLIMIT |DLKLIMIT, MAXDK |User's free credits per day (in kilobytes) | | |KBLIMIT |DLKLIMIT, MAXDK |User's free credits per day (in kibibytes) | |
|MAILW | |Number of mail messages waiting for current user (includes SPAM)| | |MAILW | |Number of mail messages waiting for current user (includes SPAM)| |
|MAILW://x// |MAILW#//x// |Number of mail messages waiting for current user number //x// (x=0 for all users)| | |MAILW://x// |MAILW#//x// |Number of mail messages waiting for current user number //x// (x=0 for all users)| |
|PWDATE |MEMO |Date of user's last password modification (in "MM/DD/YY" or "DD/MM/YY" format) | | |PWDATE |MEMO |Date of user's last password modification (in "MM/DD/YY" or "DD/MM/YY" format) | |
|SEC |SECURITY |User's security level (0-99) | | |SEC |SECURITY |User's security level (0-99) | |
|SINCE | |Date of user's first call (in "MM/DD/YY" or "DD/MM/YY" format)| | |
|SPAMW | |Number of SPAM messages waiting | | |SPAMW | |Number of SPAM messages waiting | |
|SPAMW://x// |SPAMW#//x// |Number of SPAM messages waiting for user number //x// | | |SPAMW://x// |SPAMW#//x// |Number of SPAM messages waiting for user number //x// | |
|UPBYTES | |Total bytes uploaded by user | | |UPBYTES | |Total bytes uploaded by user | |
|UPFILES |UPS |Total files uploaded by user | | |UPFILES |UPS |Total files uploaded by user | |
|UPK | |Total kilobytes uploaded by user | | |UPK | |Total kibibytes uploaded by user | |
|USERNUM | |User's number (1-based index into user database) | | |USERNUM | |User's number (1-based index into user database) | |
|ZIP | |User's zip/postal code | | |ZIP | |User's zip/postal code | |
|EXEC:module |Execute an in-process module (Baja or JavaScript) from the ''[[dir:exec]]'' directory| | |EXEC:module |Execute an in-process module (Baja or JavaScript) from the ''[[dir:exec]]'' directory| |
|EXEC_XTRN:code |Execute an external online program (e.g. door) by specifying the internal code| | |EXEC_XTRN:code |Execute an external online program (e.g. door) by specifying the internal code| |
|SETSTR:str |Sets the current Baja command string to //str//| | |SETSTR:str |Sets the current Baja/PCMS command string to //str//| |
| |STR |Display the current Baja/PCMS command string value | |
| |
===== See Also ===== | ===== See Also ===== |