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
Next revisionBoth sides next revision
util:scfg [2021/01/24 10:04] – [Command-line Usage] update scfg help mlongutil:scfg [2023/12/25 13:47] – [Command-line Usage] Latest usage (includes -host= option) 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 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_main.png|SCFG Main Menu}}
Line 21: Line 21:
 On Windows, the executable file is: ''[[dir:exec]]/scfg.exe'' On Windows, the executable file is: ''[[dir:exec]]/scfg.exe''
  
-On Unix, the executable file is: ''[[dir:exec]]/scfg''+On UNIX, the executable file is: ''[[dir:exec]]/scfg''
  
 ===== Command-line Usage ===== ===== Command-line Usage =====
Line 28: Line 28:
  
 <code> <code>
-usage: scfg [ctrl_dir] [options] 
- 
 options: options:
  
--f  =  force save of configuration files +-w                run initial setup wizard 
--a  =  update all message base status headers +-f                force save of configuration files 
--h  =  don't update message base status headers +-a                update all message base status headers 
--u# =  set file creation permissions mask (in octal) +-h                don't update message base status headers 
--k  =  keyboard mode only (no mouse support) +-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 
--insert enable keyboard insert mode by default +-e#               set escape delay to #msec 
--import=<filenameimport a message area list file +-insert           enable keyboard insert mode by default 
--faddr=<addr> specify your FTN address for imported subs +-import=<fname  import a message area list file 
--misc=<value> specify option flags for imported subs +-faddr=<addr>     specify your FTN address for imported subs 
--g# =  set group number (or name) to import into +-misc=<value>     specify option flags for imported subs 
--iX  set interface mode to X (default=auto) where X is one of: +-g#               set group number (or name) to import into 
-       X = X11 mode +-host=<name>      set hostname to use for alternate sbbs.ini file 
-       C = Curses mode +-iX               set interface mode to X (default=auto) where X is one of: 
-       F = Curses mode with forced IBM charset +                   X = X11 mode 
-       I = Curses mode with forced ASCII charset +                   C = Curses mode 
-       A = ANSI mode +                   F = Curses mode with forced IBM charset 
-       D = standard input/output/door mode +                   I = Curses mode with forced ASCII charset 
--v# =  set video mode to # (default=auto) +                   A = ANSI mode 
--l# =  set screen lines to # (default=auto-detect+                   D = standard input/output/door mode 
--b# =  set automatic back-up level (default=5+-A                use alternate (ASCII) characters for arrow symbols 
--y  =  automatically save changes (don't ask) +-v#               set video mode to # (default=auto) 
-</code>+-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 62: 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 and Help ===== 
 +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.
  
-FIXME+  * ''Up'' and ''Down'' arrows: Move the lightbar that highlights the desired item. 
 +  * ''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 =====
  
-===== Using SCFG =====+==== Initial Setup Wizard ==== 
 + 
 +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.
  
 ==== Standard I/O Mode ==== ==== Standard I/O Mode ====
Line 84: Line 92:
 ===== Configure ===== ===== Configure =====
  
-  * ''[[scfg:Nodes]]'' +  * ''[[util:scfg:Nodes]]'' 
-  * ''[[scfg:System]]'' +  * ''[[util:scfg:System]]'' 
-  * ''[[scfg:Networks]]'' +  * ''[[util:scfg:Networks]]'' 
-  * ''[[scfg:File Areas]]'' +  * ''[[util:scfg:File Areas]]'' 
-  * ''[[scfg:File Options]]'' +  * ''[[util:scfg:File Options]]'' 
-  * ''[[scfg:Chat Features]]'' +  * ''[[util:scfg:Chat Features]]'' 
-  * ''[[scfg:Message Areas]]'' +  * ''[[util:scfg:Message Areas]]'' 
-  * ''[[scfg:Message Options]]'' +  * ''[[util:scfg:Message Options]]'' 
-  * ''[[scfg:Command Shells]]'' +  * ''[[util:scfg:Command Shells]]'' 
-  * ''[[scfg:External Programs]]'' +  * ''[[util:scfg:External Programs]]'' 
-  * ''[[Text File Sections]]'' +  * ''[[util:scfg:Text File Sections]]'' 
 +  * ''[[config:cmdline|Command Lines]]''
  
 ===== See Also ===== ===== See Also =====