====== Synchronet User Documentation ======

This is the **end-user** documentation for [[https://synchro.net/|Synchronet BBS Software]] — the manual for people **calling** a Synchronet BBS, not for sysops running one. (Sysops, see the [[:start|wiki home page]] and the [[:config:|SCFG]], [[:custom:|customization]], and [[:howto:|how-to]] sections.)

What you actually see when you call a BBS depends on **which command shell, login module, message editor, and other loadable modules that BBS uses**. Synchronet is highly modular: the prompts and command keys you press are part of the **command shell**, but most of what those keys //invoke// — reading mail, posting messages, the user-settings menu, listing users online, and so on — is handled by separate **loadable modules** the sysop has configured in [[util:SCFG]] -> System -> Loadable Modules. Two BBSes running the same shell can still feel different if they've swapped out a module; two BBSes running different shells will often share the very same mail or chat interface once you press the key that opens it.

So this manual is organized along those module boundaries: a per-shell page for each shell's prompts and key bindings, a per-module page for each major loadable module that has its own UI, and a small set of universal pages for things Synchronet itself handles (Ctrl-key commands, Ctrl-A codes).

===== If you just want to use a BBS =====

Most BBSes you'll encounter run the stock **Synchronet Classic** command shell. If you don't know otherwise, start there:

  * [[user:shell:classic|Synchronet Classic Shell — User Guide]]

If your BBS uses a different shell — for example //Wildcat!//, //PCBoard//, //Renegade//, or //WWIV// style — see the index at [[user:shell:|Command Shells]] and pick the matching page.

===== Logging on =====

How you log on (matrix screen, ''NN:'' / ''PW:'' prompts, new-user signup flow, etc.) is controlled by the BBS's **login module**, not its shell. Login happens before the shell even starts.

  * [[user:login:|Login Modules]] — index
  * [[user:login:default|Default Login]]

===== Other loadable modules =====

These are modules with their own user-facing UIs that any shell may invoke. Your BBS may use the stock module or a customized replacement.

  * [[user:settings:|User Settings Menu]] — the //Account Defaults// / //Configuration// menu (default module: ''user_settings''). In the Classic shell, opened with ''D'' from the Main prompt.
  * [[user:editor:|Message Editors]] — line editor, [[user:editor:slyedit|SlyEdit]], [[user:editor:fseditor|FSEditor]], etc.
  * [[user:mail:|Mail Modules]] — Email Section, Read Mail, Private Msg
  * [[user:msgbase:|Message Base Modules]] — Scan Msgs, Scan Subs, List Msgs
  * [[user:chat:|Chat]] — Chat Section module (default: ''chat_sec'')
  * [[user:online:|Online User Listings]] — List Users, List Nodes, Who's Online
  * [[user:automsg|Auto Message]] (default module: ''automsg'')

===== Universal features =====

These work the **same in every shell** because Synchronet itself handles them, not the shell:

  * [[user:ctrl_keys|Control-key Commands]] — Ctrl-S/Q/C, Ctrl-U, Ctrl-P, Ctrl-K, Ctrl-T, etc.
  * [[user:ctrl-a|Ctrl-A Text Attribute Codes]] — the color/attribute codes you may see when reading messages or display files
  * [[user:qwk|QWK Mail Packet Menu]] — read and post messages offline (invoked from any shell)

===== Concepts =====

  * [[user:credits|Credits]] — the BBS credit economy from a user's perspective
  * [[user:glossary|Glossary]] — cross-linked to [[ref:glossary]]

===== Conventions used in this manual =====

  * **Carriage Return** (the //Enter// key) is referred to as ''<CR>''.
  * Where a key sequence is needed at a specific prompt (e.g. //"from the Main prompt"//, //"from the File Transfer prompt"//), the prompt is named explicitly. Each shell defines its own prompts and command keys — see the page for that shell.
  * IBM CP437 / ANSI escape sequences and Synchronet's [[custom:ctrl-a_codes|Ctrl-A]] color codes appear in many displays. Most modern terminals (e.g. [[https://syncterm.bbsdev.net/|SyncTERM]], [[https://www.mysticbbs.com/|NetRunner]]) handle these natively.

===== See Also =====

  * [[:start|Synchronet Wiki home]]
  * [[:custom:command_shell|Command Shell (sysop perspective)]]
  * [[:bbs:|Public Synchronet BBSes you can call]]

{{tag>user manual classic shell login editor}}