Synchronet v3.19b-Win32 (install) has been released (Jan-2022).

You can donate to the Synchronet project using PayPal.

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
util:scfg [2023/12/25 13:47] – [Command-line Usage] Latest usage (includes -host= option) digital manutil:scfg [2024/04/02 18:14] (current) – [Initial Setup Wizard] include SCFG wizard screenshots digital man
Line 3: Line 3:
 The Synchronet Configuration Utility (SCFG) is used for viewing and modifying the primary [[config:ini files]] in the Synchronet ''[[dir:ctrl]]'' directory. The Synchronet Configuration Utility (SCFG) is used for viewing and modifying the primary [[config:ini files]] in the Synchronet ''[[dir:ctrl]]'' directory.
  
-{{:util:scfg_main.png|SCFG Main Menu}}+{{:util:scfg.3.20.main.png?800|SCFG Main Menu}}
  
-===== Invoking =====+===== Invoke =====
  
 SCFG may be invoked from the [[:monitor:sbbsctrl|Synchronet Control Panel]] with the BBS->Configure menu option: SCFG may be invoked from the [[:monitor:sbbsctrl|Synchronet Control Panel]] with the BBS->Configure menu option:
Line 23: Line 23:
 On UNIX, the executable file is: ''[[dir:exec]]/scfg'' On UNIX, the executable file is: ''[[dir:exec]]/scfg''
  
-===== Command-line Usage =====+===== Command-line =====
  
 Help on the command-line usage can be displayed by executing the command: ''scfg -?'' or ''scfg --help'': Help on the command-line usage can be displayed by executing the command: ''scfg -?'' or ''scfg --help'':
Line 65: Line 65:
 If the ''[[config:env#SBBSCTRL]]'' environment variable is **not** set and the ''[ctrl_dir]'' is not specified on the command-line, SCFG will look for the [[config:ini files]] in the current working directory. If the ''[[config:env#SBBSCTRL]]'' environment variable is **not** set and the ''[ctrl_dir]'' is not specified on the command-line, SCFG will look for the [[config:ini files]] in the current working directory.
  
-===== Usage and Help ===== +===== Usage =====
-At any time within SCFG, you can press the F1 key or click the ''?'' on a window to get online help about the section being edited.+
  
-  * ''Up'' and ''Down'' arrows: Move the lightbar that highlights the desired item. +==== Help ====
-  * ''Home'': highlight first option in the menu. +
-  * ''End'': highlight the last option in the menu. +
-  * '' Enter'': select the highlighted item. +
-  * ''Esc'' return to the previous menu, or if at the top-level menu, quit the SCFG application. +
-  * Pressing the first letter or number of an item in the menu will highlight that item. +
-===== Using SCFG =====+
  
-==== Initial Setup Wizard ====+At any time within SCFG, you can press the ''F1'' or ''?'' keys or click the ''?'' on a window to get online help about the list of options or items being viewed or the option being edited.
  
-When SCFG detects a new installation, or is invoked with the ''-w'' command-line options, it'll start the //Initial Setup Wizard// which will prompt for various import initial configuration settings.+==== Navigation keys: ====
  
-==== Standard I/O Mode ====+^ Key(s)                         ^ Action ^ 
 +| ''Up'' and ''Down'' arrows    | Move the lightbar that highlights the desired item| 
 +| ''Page Up'' and ''Page Down'' | Move the lightbar up or down one "screen full" at a time | 
 +| ''Home''                      | Highlight first option in the menu | 
 +| ''End''                       | Highlight the last option in the menu | 
 +| '' Enter''                    | Select the highlighted item | 
 +| ''Esc'' or ''Backspace''      | Return to the previous menu, or if at the top-level menu, quit the SCFG application | 
 +| ''F1'' or ''?''               | Display help text on current windows/dialog/list | 
 +| ''Ctrl-F''                    | Find an option or item in a list | 
 +| ''Ctrl-G''                    | Find next option or item in list (after use of ''Ctrl-F'') | 
 +| Letters/numbers               | Pressing the first letter or number of an item in the menu will highlight that item |
  
-FIXME+==== Editing keys: ====
  
-==== Full-screen Mode ====+^ Key(s)                                   ^ Action ^ 
 +| ''Insert'' or ''+''                      | Insert new items in lists | 
 +| ''Delete'' or ''-''                      | Delete items from lists | 
 +| ''Ctrl-C'' or ''F5'' or ''Ctrl-Insert''  | Copy item from list into clipboard | 
 +| ''Ctrl-X'' or '' Shift-Delete''          | Cut item from list into clipboard | 
 +| ''Ctrl-V'' or ''F6'' or ''Shift-Insert'' | Paste clipboard item into list (above highlighted item) |
  
-FIXME+==== Initial Setup Wizard ====
  
-=== Graphics vs. Text Mode ===+When SCFG detects a new Synchronet installation, it'll start its //Initial Setup Wizard// which will prompt the sysop for various important [[install:setup|initial configuration settings]].
  
 +<code>
 +╔═════════════════════════════════════════════════════╗
 +║ New install detected, starting Initial Setup Wizard ║
 +╠═════════════════════════════════════════════════════╣
 +║ │OK                                                 ║
 +╚═════════════════════════════════════════════════════╝
 +</code>
 +
 +The SCFG ''-w'' command-line option can also be used to force SCFG to execute its //Initial Setup Wizard//.
 +
 +<code>
 +┌─────────────────────────────┤ Setup Wizard ├─────────────────────────────┐
 +│                                                                          │
 +│                                  Welcome                                 │
 +│   _________                   .__                                __      │
 +│  /   _____/__.__. ____   ____ |  |_________  ____   ____   _____/  |_    │
 +│  \_____  <   |  |/    \_/ ___\|  |  \_  __ \/  _ \ /    \_/ __ \   __\   │
 +│  /        \___  |   |  \  \___|   Y  \  | \(  <_> )   |  \  ___/|  |     │
 +│ /_______  / ____|___|  /\___  >___|  /__|   \____/|___|  /\___  >__|     │
 +│         \/\/         \/     \/     \/                  \/     \/         │
 +│                                                                          │
 +│ This wizard will take you through the configuration of the basic         │
 +│ parameters required to run a Synchronet Bulletin Board System.  All of   │
 +│ these configuration parameters may be changed later if you choose.       │
 +│                                                                          │
 +│ Press  ENTER  to advance through the setup wizard or  ESC  to move       │
 +│ backward or abort the wizard.                                            │
 +│                                                                          │
 +│                                                                          │
 +│                                │Continue                                 │
 +└──────────────────────────────────────────────────────────────────────────┘
 +</code>
 ===== Configure ===== ===== Configure =====
  
   * ''[[util:scfg:Nodes]]''   * ''[[util:scfg:Nodes]]''
   * ''[[util:scfg:System]]''   * ''[[util:scfg:System]]''
 +  * ''[[server:|Servers]]''
   * ''[[util:scfg:Networks]]''   * ''[[util:scfg:Networks]]''
   * ''[[util:scfg:File Areas]]''   * ''[[util:scfg:File Areas]]''
Line 103: Line 144:
   * ''[[util:scfg:External Programs]]''   * ''[[util:scfg:External Programs]]''
   * ''[[util:scfg:Text File Sections]]''   * ''[[util:scfg:Text File Sections]]''
-  * ''[[config:cmdline|Command Lines]]'' 
  
 ===== See Also ===== ===== See Also =====
Line 110: Line 150:
   * [[config:env#SBBSCTRL]] environment variable   * [[config:env#SBBSCTRL]] environment variable
   * [[config:|Configuration]]   * [[config:|Configuration]]
 +  * [[config:cmdline|Command Lines]]
   * [[ref:uifc|User Interface Library (UIFC)]]   * [[ref:uifc|User Interface Library (UIFC)]]
  
 {{tag>configure scfg}} {{tag>configure scfg}}
  

Trace: