====== Auto-Message ======

The system's auto-message, if set, is displayed to users automatically, during logon to the [[server:terminal]] server.

Auto-messages are short (maximum 3 line) messages with no context (e.g. no reply/threading ability) and are generally used for announcements, shout-outs or advertisements.

Only a single auto-message can exist at a time; each new auto-message will over-write the current auto-message.

Users with the '''W''' [[:access:restrictions|restriction]] are not allowed to write an auto-message.

Users with the '''A''' [[:access:exemptions|exemption]] are allowed to write anonymous auto-messages.

Sysops can delete an auto-message without writing a new one.

The [[custom:JavaScript]] source code for the stock auto-message modules is in ''[[dir:exec]]/automsg.js''.

The module behavior can be customized via the ''[automsg]'' section in the ''[[dir:ctrl]]/[[config:modopts.ini]]'' file:

^ Option           ^ Default                         ^ Description ^
| ''prompt''       | ''[[custom:text.dat]] AutoMsg'' | User command prompt |
| ''sysop_prompt'' | See ''automsg.js''              | Sysop command prompt |
| ''intro''        | ""\r\nMaximum of 3 lines:\r\n"  | Introduction when writing |
| ''header_fmt''       | ''[[custom:text.dat]] AutoMsgBy'' | Header of auto-message text |
| ''user_fmt''      | "%s %d"                         | Message author name and number |
| ''line_fmt''      | " > %.79s\r\n"                 | Format of message line |
| ''max_line_len''  | 76                             | Maximum line length |
| ''backup_level''  | 10                             | Number of old auto-messages to retain (set to ''false'' or ''0'' to disable) |


===== See Also =====
  * [[:module:|module index]]

{{tag>}}