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 [2010/03/06 19:06] – digitalmanutil:scfg [2024/04/02 18:14] (current) – [Initial Setup Wizard] include SCFG wizard screenshots digital man
Line 1: Line 1:
 ====== SCFG ====== ====== SCFG ======
  
-The Synchronet Configuration Utility (SCFG) is used for viewing and modifying the various [[config:CNF files]] in the ''[[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.
  
-===== Command-line Usage =====+{{:util:scfg.3.20.main.png?800|SCFG Main Menu}} 
 + 
 +===== Invoke ===== 
 + 
 +SCFG may be invoked from the [[:monitor:sbbsctrl|Synchronet Control Panel]] with the BBS->Configure menu option: 
 + 
 +{{:monitor:sbbsctrl_configure.png|}} 
 + 
 +Or by running ''scfg'' from a command prompt. 
 + 
 +:!: Note: If the Synchronet ''[[dir:exec]]'' directory is not in your search path, you may need to change the current working directory (e.g. using ''cd'') or specify the //full path// to ''scfg''.  
 + 
 +===== Executable ===== 
 + 
 +SCFG is a native executable program. 
 + 
 +On Windows, the executable file is: ''[[dir:exec]]/scfg.exe'' 
 + 
 +On UNIX, the executable file is: ''[[dir:exec]]/scfg'' 
 + 
 +===== 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'':
  
 <code> <code>
-usage: scfg [ctrl_dir] [options] 
- 
 options: options:
  
--s  =  don't check directories +-w                run initial setup wizard 
--f  =  force save of config files +-f                force save of configuration files 
--a  =  update all message base status headers +-a                update all message base status headers 
--h  =  don't update message base status headers +-h                don't update message base status headers 
--u# =  set file creation permissions mask (in octal) +-u#               set file creation permissions mask (in octal) 
--c  =  force color mode +-k                keyboard mode only (no mouse support) 
--m  =  force monochrome mode +-c                force color mode 
--e# =  set escape delay to #msec +-m                force monochrome mode 
--iX =  set interface mode to X (default=auto) where X is one of: +-e#               set escape delay to #msec 
-       X = X11 mode +-insert           enable keyboard insert mode by default 
-       C = Curses mode +-import=<fname>   import a message area list file 
-       F = Curses mode with forced IBM charset +-faddr=<addr>     specify your FTN address for imported subs 
-       W = Win32 native mode +-misc=<value>     specify option flags for imported subs 
-       A = ANSI mode +-g#               set group number (or name) to import into 
-       D = standard input/output/door mode +-host=<name>      set hostname to use for alternate sbbs.ini file 
--v# =  set video mode to # (default=auto) +-iX               set interface mode to X (default=auto) where X is one of: 
--l# =  set screen lines to # (default=auto-detect) +                   X = X11 mode 
--b# =  set automatic back-up level (default=5) +                   C = Curses mode 
--y  =  automatically save changes (don't ask) +                   F = Curses mode with forced IBM charset 
-</code>+                   I = Curses mode with forced ASCII charset 
 +                   A = ANSI mode 
 +                   D = standard input/output/door mode 
 +-A                use alternate (ASCII) characters for arrow symbols 
 +-v#               set video mode to # (default=auto) 
 +-l#               set screen lines to # (default=auto-detect) 
 +-y                automatically save changes (don't ask)</code>
  
 :!: Note: some of the interface mode values are only available on particular platforms/operating systems. :!: Note: some of the interface mode values are only available on particular platforms/operating systems.
Line 37: Line 61:
 ===== CTRL Directory ===== ===== CTRL Directory =====
  
-If the ''[[config:env#SBBSCTRL]]'' environment variable is set, then SCFG will find the [[config:CNF files]] without needing you to specify the path to the ''[[dir:ctrl]]'' directory  (''[ctrl_dir]'') on the command-line.+If the ''[[config:env#SBBSCTRL]]'' environment variable is set, then SCFG will find the [[config:ini files]] without needing you to specify the path to the ''[[dir:ctrl]]'' directory  (''[ctrl_dir]'') on the command-line.
  
-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:CNF 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.
  
-===== Help Files =====+===== Usage =====
  
-FIXME+==== Help ====
  
-===== Using SCFG =====+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.
  
-==== Standard I/O Mode ====+==== Navigation keys: ====
  
-FIXME+^ 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 |
  
-==== Full-screen Mode ====+==== Editing keys: ====
  
-FIXME+^ 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) |
  
-=== Graphics vs. Text Mode ===+==== Initial Setup Wizard ====
  
-===== Configure =====+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]].
  
-  * ''[[scfg:Nodes]]'' +<code> 
-  * ''[[scfg:System]]'' +╔═════════════════════════════════════════════════════╗ 
-  * ''[[scfg:Networks]]'' +║ New install detected, starting Initial Setup Wizard ║ 
-  * ''[[scfg:File Areas]]'' +╠═════════════════════════════════════════════════════╣ 
-  * ''[[scfg:File Options]]'' +║ │OK                                                 ║ 
-  * ''[[scfg:Chat Features]]'' +╚═════════════════════════════════════════════════════╝ 
-  * ''[[scfg:Message Areas]]'' +</code>
-  * ''[[scfg:Message Options]]'' +
-  * ''[[scfg:Command Shells]]'' +
-  * ''[[scfg:External Programs]]'' +
-  * ''[[Text File Sections]]''+
  
 +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 =====
 +
 +  * ''[[util:scfg:Nodes]]''
 +  * ''[[util:scfg:System]]''
 +  * ''[[server:|Servers]]''
 +  * ''[[util:scfg:Networks]]''
 +  * ''[[util:scfg:File Areas]]''
 +  * ''[[util:scfg:File Options]]''
 +  * ''[[util:scfg:Chat Features]]''
 +  * ''[[util:scfg:Message Areas]]''
 +  * ''[[util:scfg:Message Options]]''
 +  * ''[[util:scfg:Command Shells]]''
 +  * ''[[util:scfg:External Programs]]''
 +  * ''[[util:scfg:Text File Sections]]''
  
 ===== See Also ===== ===== See Also =====
 +  * [[util:|Utilities]]
   * [[dir:CTRL]] Directory   * [[dir:CTRL]] Directory
   * [[config:env#SBBSCTRL]] environment variable   * [[config:env#SBBSCTRL]] environment variable
   * [[config:|Configuration]]   * [[config:|Configuration]]
-  * [[util:|Utilities]]+  * [[config:cmdline|Command Lines]] 
 +  * [[ref:uifc|User Interface Library (UIFC)]] 
 + 
 +{{tag>configure scfg}}
  

Trace: