Both sides previous revisionPrevious revisionNext revision | Previous revision |
config:cmdline [2018/03/01 12:10] – Links to util:binkit changed to module:binkit digital man | config:cmdline [2023/12/14 16:40] (current) – [Specifiers] Added %- (user's chat handle) digital man |
---|
====== Command Lines ====== | ====== Command Lines ====== |
| |
There are a number of places in [[module:binkit]] where a sysop may configure command-lines to be executed for certain features (e.g. doors, file transfer drivers, file archive/compression/test, etc.). | There are a number of places in [[:util:SCFG]] where a sysop may configure command-lines to be executed for certain features (e.g. doors, file transfer drivers, file archive/compression/test, etc.). |
| |
===== Modules ===== | ===== Modules ===== |
If the command-line is to be used to execute an internally evaluated module (either [[module:binkit]] or [[custom:JavaScript]]), the command line should begin with an asterisk (''*'') or question mark (''?'') character. An asterisk indicates that a ''.js'' file should be executed from either the ''[[dir:mods]]'' or ''[[dir:exec]]'' directory if it exists, otherwise, to execute a ''.bin'' (Baja compiled) file (from either the ''[[dir:mods]]'' or ''[[dir:exec]]'' directory) if it exists. A question mark indicates to execute a ''.js'' file only (do not fall back to ''.bin''). The module file extension (e.g. ''.js'' or ''.bin'') is optional. | If the command-line is to be used to execute an internally evaluated module (either [[:util:Baja]] or [[custom:JavaScript]]), the command line should begin with an asterisk (''*'') or question mark (''?'') character. An asterisk indicates that a ''.js'' file should be executed from either the ''[[dir:mods]]'' or ''[[dir:exec]]'' directory if it exists, otherwise, to execute a ''.bin'' (Baja compiled) file (from either the ''[[dir:mods]]'' or ''[[dir:exec]]'' directory) if it exists. A question mark indicates to execute a ''.js'' file only (do not fall back to ''.bin''). The module file extension (e.g. ''.js'' or ''.bin'') is optional. |
| |
In summary: | In summary: |
===== Specifiers ===== | ===== Specifiers ===== |
| |
Command lines configured in [[module:binkit]] may include //Command Line Specifiers// which are special sequences (macros) which will be replaced with useful dynamic values at the time the command line is executed by the BBS. | Command lines configured in [[:util:SCFG]] may include //Command Line Specifiers// which are special sequences (macros) which will be replaced with useful dynamic values at the time the command line is executed by the BBS. |
| |
//Command Line Specifiers// may also be used in many string-related Baja functions and with the JavaScript ''bbs.cmdstr()'' method. | //Command Line Specifiers// may also be used in many string-related Baja functions and with the JavaScript ''bbs.cmdstr()'' method. |
|''%O'' |Sysop's name | ''digital man'' || | |''%O'' |Sysop's name | ''digital man'' || |
|''%o'' |Sysop's name (auto-quoted) | ''%%"digital man"%%'' || | |''%o'' |Sysop's name (auto-quoted) | ''%%"digital man"%%'' || |
|''%p'' |Client protocol | ''Telnet'' || | |''%p'' |Client protocol (e.g. Telnet, RLogin, SSH), or "raw" | ''raw'' || |
|''%q'' |System's QWK ID (as specified in SCFG) | ''VERT'' || | |''%q'' |System's QWK ID (as specified in SCFG) | ''VERT'' || |
|''%r'' |Client's terminal height (in rows) | ''24'' || | |''%r'' |Client's terminal height (in rows) | ''24'' || |
|''%*'' |Current Node number (0 padded to 3 digits) | ''001'' || | |''%*'' |Current Node number (0 padded to 3 digits) | ''001'' || |
|''%$'' |User's credits | ''4534834'' || | |''%$'' |User's credits | ''4534834'' || |
| |''%+'' |User's real name (auto-quoted) | ''"Rob Swindell"'' || |
| |''%-'' |User's chat handle/call-sign (auto-quoted) | ''WX6YYZ'' || |
|''%%'' |Percent symbol | ''%'' || | |''%%'' |Percent symbol | ''%'' || |
|''%?'' |Platform/operating system | ''win32''|''linux''| | |''%?'' |Platform/operating system (build target) | ''win32''|''linux''| |
| |''%^'' |Processor architecture (build target) | ''i686''|''x64''| |
|''%1'' |Current user number | ''1'' || | |''%1'' |Current user number | ''1'' || |
|''%2'' |Current user number (0 padded to 2 digits) | ''01'' || | |''%2'' |Current user number (0 padded to 2 digits) | ''01'' || |
|''%3'' |Current user number (0 padded to 3 digits), etc. | ''001'' || | |''%3'' |Current user number (0 padded to 3 digits) | ''001'' || |
| |''%4'' |Current user number (0 padded to 4 digits) | ''0001'' || |
| |''%(5-9)'' |Current user number (0 padded to 5-9 digits) | ''00001'' || |
| |
==== Auto-quoting ==== | ==== Auto-quoting ==== |
| |
===== See Also ===== | ===== See Also ===== |
* [[module:binkit]] | * [[:util:SCFG]] |
* [[:config:|Configuration]] | |
| |
{{tag>command javascript}} | |
| |
| {{tag>configuration general_config scfg module door}} |