====== SUBS.INI ======

''*subs.ini'' is the [[wp>INI file|.ini]] format Synchronet v3.22 and later use to share message sub-board configuration between Synchronet BBSes. It replaces the older [[ref:subs.txt]], which it supersedes by carrying several settings that format cannot express.

[[util:SCFG]] imports and exports it from a message group's //Import Areas...// and //Export Areas...// format menus, listed as ''*subs.ini   Synchronet Shared Config''.

The ''*'' in the name is normally replaced with the message group's code prefix (''<prefix>subs.ini''), or with the group's short name when the group has no code prefix (''<short name>_subs.ini'', with spaces converted to underscores).

===== Format =====

A standard ''.ini'' file with one section per sub-board. The section name is the sub-board's internal code suffix:

<code ini>
[dovenet]
description = DOVE-Net General Discussion
name = General
qwk_name = GENERAL
ars =
read_ars =
post_ars =
settings = 8000018c
newsgroup = dovenet.general
max_msgs = 1000
max_age = 90
</code>

Keys that are absent take their default value, so a hand-written file need only carry the settings that matter.

^ Key ^ Value ^
| ''description'' | Long name |
| ''name'' | Short name |
| ''qwk_name'' | QWK name |
| ''data_dir'' | Data directory (blank for the default) |
| ''ars'' | Access requirements |
| ''read_ars'' | Reading requirements |
| ''post_ars'' | Posting requirements |
| ''operator_ars'' | Operator requirements |
| ''moderated_ars'' | Moderated posting requirements |
| ''settings'' | Toggle options, as a hexadecimal value |
| ''qwknet_tagline'' | QWK network tag line |
| ''fidonet_origin'' | FidoNet origin line |
| ''fidonet_addr'' | FidoNet address |
| ''post_sem'' | Post semaphore file |
| ''newsgroup'' | Newsgroup name |
| ''area_tag'' | Message area tag |
| ''qwk_conf'' | QWK conference number |
| ''max_msgs'' | Maximum messages |
| ''max_crcs'' | Maximum CRCs |
| ''max_age'' | Maximum age, in days |
| ''ptridx'' | Message pointer index |
| ''print_mode'' | Print mode flags, as a hexadecimal value |
| ''print_mode_neg'' | Print mode flags to clear, as a hexadecimal value |

===== Notes =====

  * ''area_tag'', ''qwk_conf'', ''print_mode'' and ''print_mode_neg'' are the settings this format carries that [[ref:subs.txt]] cannot, and are the main reason to prefer it.
  * As with ''subs.txt'', ''ptridx'' is written but **not applied on import** -- the exporting system's message pointer index has no meaning on the importing system, so local pointer linkage is preserved.
  * The section names here are bare internal code suffixes. This is not the same as the sub-board sections in the ''ctrl/msgs.ini'' configuration file, which are named ''sub:<group>:<code>''.
  * The matching format for file areas is ''*dirs.ini'', offered by the same menus in a file library.

===== See Also =====
  * [[:ref:|ref index]]
  * [[ref:subs.txt]]
  * [[config:message_areas]]

{{tag>format}}
