home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / scase.zip / SCASE.Z / CONFIG.TXT < prev    next >
Text File  |  1994-12-30  |  18KB  |  474 lines
  1.                            Configuring S-CASE
  2.                            ==================
  3.  
  4. S-CASE can be configured through the use of configuration files.
  5. Configuration files are simple text files, which specify values for
  6. several configuration parameters. Please keep in mind, that most of
  7. these parameters can be changed directly through S-CASE. So avoid
  8. hand editing of configuration files as far as possible.
  9.  
  10. Configuration Concepts
  11. ======================
  12. S-CASE uses the concept of global and local configurations files.
  13. Parameters specified in the global configuration file are applicable to
  14. all users of S-CASE. Individual users can however override these
  15. parameters by specifying them in their local configuration files. Every
  16. S-CASE user is assigned a local configuration file that stores his/her
  17. configuration information.
  18.  
  19. The install procedure described in chapter 1 of the User's Guide creates
  20. a default global configuration file. It also creates a local configuration
  21. file for the user who performs the install procedure. Whenever a new user
  22. uses S-CASE, his/her local configuration file is created automatically.
  23.  
  24. The user╒s configuration information is updated in the local configuration
  25. file when he/she exits S-CASE. However, there is no way to change the
  26. global configuration file through S-CASE. Changes to this file can be made
  27. only through a text editor. Be careful when you do this. Always make a
  28. backup copy of the original configuration file.
  29.  
  30. WARNING: Make sure that you do not edit your own local configuration file
  31. through S-CASE╒s text editor. As soon as you exit, S-CASE will overwrite
  32. this file wiping out all your changes. Use some other text editor to edit
  33. this file.
  34.  
  35. S-CASE performs the following steps to locate the global configuration
  36. file. The first step to succeed determines the location of the global
  37. configuration file.
  38.  
  39.      1. Check if the user╒s local configuration file specifies a path for
  40.         the global configuration file.
  41.         (via the variable [Config] GlobalConfig)
  42.  
  43.      2. For Macintosh, use the file
  44.            System Folder:Preferences:S-CASE¬:glblcfg:global.
  45.         For all other systems, use the file
  46.            scase_dir/cfg/glblcfg/global.
  47.  
  48. S-CASE performs the following steps to locate the user╒s local
  49. configuration file. The first step to succeed determines the location of
  50. the local configuration file.
  51.  
  52.      1. Check for the file .scase_cfg in user╒s home directory.
  53.         (UNIX only)
  54.      2. Check for the file pointed by the environment variable SCASE_CFG.
  55.         (all platforms except Macintosh)
  56.      3. For Macintosh, use the file
  57.            System Folder:Preferences:S-CASE¬:lclcfg:username.
  58.         For all other systems, use the file
  59.            scase_dir/cfg/lclcfg/username.
  60.         (username is the user╒s name as described in the User's Guide)
  61.  
  62. Configuration File Format
  63. =========================
  64. A configuration file consists of zero or more sections. Each section
  65. contains a group of related variables. The example below shows a section
  66. called Editor and two variables within this section called TextColor and
  67. BgndColor. The values of the two variables are 0 and FFFFFF (hex)
  68. respectively.
  69.  
  70. [Editor]
  71. l TextColor = 0x000000
  72. l BgndColor = 0xFFFFFF
  73.  
  74. The configuration file contains three types of lines:
  75.   1. Comment lines
  76.   2. Section definition lines
  77.   3. Variable definition lines
  78.  
  79. Comment Lines
  80. -------------
  81. A comment line has the following format:
  82.  
  83. [white space] [ // [comment] ]
  84.  
  85. Examples:
  86.  
  87.   1. A completely blank line:
  88.  
  89.   2. A line with some leading white space and a comment:
  90.             // This is a comment
  91.  
  92. Section Definition Lines
  93. ------------------------
  94. A section definition line has the following format:
  95.  
  96. [white space] "[" <section> "]" [ // [comment] ]
  97.  
  98. Example:
  99.  
  100. [Editor]
  101.  
  102. Here are some points to remember about section definition lines:
  103.  
  104. o Anything between the square brackets is considered to be the section
  105.   name.
  106. o Case is significant.
  107. o Only the first 63 characters are significant.
  108. o If the section name is encountered for the first time, then a new
  109.   section with that name is created, otherwise the previously defined
  110.   section is used when the following lines are read.
  111.  
  112. Variable Definition Lines
  113. -------------------------
  114. A variable definition line has the following format:
  115.  
  116. [white space] <type> <variable> = <value> [ // [comment] ]
  117.  
  118. Following types are recognized
  119.  
  120.     l = long (a 32 bit signed number)
  121.     f = floating point
  122.     s = character string
  123.     L = list of longs   (value indicates the length of the list)
  124.     F = list of floats  (value indicates the length of the list)
  125.     S = list of strings (value indicates the length of the list)
  126.  
  127. In case of lists, the elements of the list are specified on subsequent
  128. lines, one element per line.
  129.  
  130. The variable name is case sensitive and only the first 63 characters are
  131. significant.
  132.  
  133. Values can be specified as follows:
  134.     long:             1000, +1000, -1000, 0x00FF00FF (hex), 0777(octal)
  135.     floating point:   4.5, -3.5, 0.99, .99
  136.     character string: Hello world
  137.  
  138. If a variable has been previously defined in the current section, then
  139. the new definition overrides it.
  140.  
  141. Examples:
  142.  
  143. l WorldWindowX = -100
  144. f Magnification = 3.2
  145. s Title =Console// careful: string begins right after the "="
  146.                 // and stops at the beginning of the comment
  147. L WindowColors = 2
  148. 0x00FF00FF
  149. 0x000000FF
  150. S VersionDirs = 3
  151. sd3:proj:mq:SCCS
  152. sd3:proj:mqapp:global:SCCS
  153. sd3:proj:mqapp:mac.macos.macws.mpw:SCCS
  154.  
  155. Configuration File Variables
  156. ============================
  157. This section describes the configuration file variables recognized by
  158. S-CASE. The variables are grouped under their respective sections.
  159.  
  160. [CodeGen] Section
  161. -----------------
  162. This section controls various code generation options.
  163.  
  164.     Name:               AttributesFirst
  165.     Description:        Whether attributes should be generated before methods.
  166.     Type:               Long
  167.     Allowable values:   0(No), 1(Yes)
  168.     Default value:      0
  169.     Change via S-CASE:  Yes, through Options->AttributesFirst menu.
  170.  
  171.     Name:               BodyBackFileExtension
  172.     Description:        Extension for generating backups of body files.
  173.     Type:               String
  174.     Allowable values:   Extensions valid for the file system
  175.     Default value:      cc%
  176.     Change via S-CASE:  Yes, through Options->Source File Extensions menu.
  177.  
  178.     Name:               BodyCleanFileExtension
  179.     Description:        Extension for generating clean code body files.
  180.     Type:               String
  181.     Allowable values:   Extensions valid for the file system
  182.     Default value:      ccl
  183.     Change via S-CASE:  Yes, through Options->Source File Extensions menu.
  184.  
  185.     Name:               BodyCopyrightFile
  186.     Description:        File containing copyright message used in body files.
  187.     Type:               String
  188.     Allowable values:   Any valid filename
  189.     Default value:      cpyright.msg
  190.     Change via S-CASE:  Yes, through Options->Copyright Files menu.
  191.  
  192.     Name:               BodyFileExtension
  193.     Description:        Extension for body files.
  194.     Type:               String
  195.     Allowable values:   Extensions valid for the file system
  196.     Default value:      cc
  197.     Change via S-CASE:  Yes, through Options->Source File Extensions menu.
  198.  
  199.     Name:               BodyTempFileExtension
  200.     Description:        Extension for temporary body files during code generation.
  201.     Type:               String
  202.     Allowable values:   Extensions valid for the file system
  203.     Default value:      ctp
  204.     Change via S-CASE:  Yes, through Options->Source File Extensions menu.
  205.  
  206.     Name:               GenCleanCode
  207.     Description:        Whether clean code should be generated.
  208.     Type:               Long
  209.     Allowable values:   0(No), 1(Yes)
  210.     Default value:      0
  211.     Change via S-CASE:  Yes, through Options->Generate Clean Code menu.
  212.  
  213.     Name:               HeaderBackFileExtension
  214.     Description:        Extension for generating backups of header files.
  215.     Type:               String
  216.     Allowable values:   Extensions valid for the file system
  217.     Default value:      h%
  218.     Change via S-CASE:  Yes, through Options->Source File Extensions menu.
  219.  
  220.     Name:               HeaderCleanFileExtension
  221.     Description:        Extension for generating clean code header files.
  222.     Type:               String
  223.     Allowable values:   Extensions valid for the file system
  224.     Default value:      hcl
  225.     Change via S-CASE:  Yes, through Options->Source File Extensions menu.
  226.  
  227.     Name:               HeaderCopyrightFile
  228.     Description:        file containing copyright message used in header files.
  229.     Type:               String
  230.     Allowable values:   Any valid filename
  231.     Default value:      cpyright.msg
  232.     Change via S-CASE:  Yes, through Options->Copyright Files menu.
  233.  
  234.     Name:               HeaderFileExtension
  235.     Description:        Extension for header files.
  236.     Type:               String
  237.     Allowable values:   Extensions valid for the file system
  238.     Default value:      h
  239.     Change via S-CASE:  Yes, through Options->Source File Extensions menu.
  240.  
  241.     Name:               HeaderTempFileExtension
  242.     Description:        Extension for temporary header files during code generation.
  243.     Type:               String
  244.     Allowable values:   Extensions valid for the file system
  245.     Default value:      htp
  246.     Change via S-CASE:  Yes, through Options->Source File Extensions menu.
  247.  
  248.     Name:               MakeBackups
  249.     Description:        Whether backups should be created during code generation.
  250.     Type:               Long
  251.     Allowable values:   0(No), 1(Yes)
  252.     Default value:      1
  253.     Change via S-CASE:  Yes, through Options->Make Backups menu.
  254.  
  255. [Config] Section
  256. ----------------
  257. This section affects various configuration files.
  258.  
  259.     Name:               GlobalConfig
  260.     Description:        Pathname of the global configuration file.
  261.                         (valid only in local configuration file)
  262.     Type:               String
  263.     Allowable values:   Any valid pathname
  264.     Default value:      None
  265.     Change via S-CASE:  Yes, through Console╒s Options->Global Configuration menu.
  266.  
  267.     Name:               SaveOnExit
  268.     Description:        Should local configuration file be updated on exit.
  269.     Type:               Long
  270.     Allowable values:   0 (No), 1 (Yes)
  271.     Default value:      1
  272.     Change via S-CASE:  Yes, through Console╒s Options->Save Configuration On Exit menu.
  273.  
  274. [Console] and [Editor] Sections
  275. -------------------------------
  276. These two sections affect the Console and the Text Editor windows respectively.
  277.  
  278.     Name:               BgndColor
  279.     Description:        Background color of the window.
  280.     Type:               Long
  281.     Allowable values:   RGB color values
  282.     Default value:      0xFFFFFF (White)
  283.     Change via S-CASE:  Yes, through Options->Background Color menu.
  284.  
  285.     Name:               CnslAtStartup
  286.     Description:        Should console be brought up when app starts - Console only.
  287.     Type:               Long
  288.     Allowable values:   0(No), 1(Yes)
  289.     Default value:      0
  290.     Change via S-CASE:  Yes, through Options->Console At Startup menu.
  291.  
  292.     Name:               DebugLevel
  293.     Description:        Debug level - Console only.
  294.     Type:               Long
  295.     Allowable values:   1(Low), 2(High)
  296.     Default value:      1
  297.     Change via S-CASE:  Yes, through Options->Debug Level menu.
  298.  
  299.     Name:               FileType
  300.     Description:        Line termination style when writing to a file.
  301.     Type:               Long
  302.     Allowable values:   0(UNIX), 1(MS-DOS), 2(Macintosh)
  303.     Default value:      0
  304.     Change via S-CASE:  Yes, through Options->File Type menu.
  305.  
  306.     Name:               FontFamily
  307.     Description:        Font family of the text in the window.
  308.     Type:               Long
  309.     Allowable values:   0(System), 1(Fixed), 2(Times), 8(Helvetica)
  310.     Default value:      8
  311.     Change via S-CASE:  Yes, through Font menu.
  312.  
  313.     Name:               FontSize
  314.     Description:        Font size of the text in the window.
  315.     Type:               Long
  316.     Allowable values:   6,8,9,10,12,14,16,18,20,24,36,48,54,60,72
  317.     Default value:      12
  318.     Change via S-CASE:  Yes, through Style menu.
  319.  
  320.     Name:               FontStyle
  321.     Description:        Font style of the text in the window.
  322.     Type:               Long
  323.     Allowable values:   OR of the following three bits:
  324.                           0x01 Bold
  325.                           0x02 Italic
  326.                           0x08 Scalable
  327.     Default value:      0x08
  328.     Change via S-CASE:  Yes, through Style menu.
  329.  
  330.     Name:               MacFileType
  331.     Description:        Macintosh file type created by editor and code generator.
  332.                         (valid in Editor section only)
  333.     Type:               String
  334.     Allowable values:   Any string with 4 characters
  335.     Default value:      TEXT
  336.     Change via S-CASE:  No.
  337.  
  338.     Name:               Overtype
  339.     Description:        Turn overtype mode on or off.
  340.     Type:               Long
  341.     Allowable values:   0 (off), 1 (on)
  342.     Default value:      0
  343.     Change via S-CASE:  Yes, through Options->Overtype menu.
  344.  
  345.     Name:               TextColor
  346.     Description:        Foreground color of the text in the window.
  347.     Type:               Long
  348.     Allowable values:   RGB color values
  349.     Default value:      0x000000 (Black)
  350.     Change via S-CASE:  Yes, through Options->Text Color menu.
  351.  
  352.     Name:               Wrap
  353.     Description:        Turn wrap mode on or off.
  354.     Type:               Long
  355.     Allowable values:   0 (off), 1 (on)
  356.     Default value:      0
  357.     Change via S-CASE:  Yes, through Options->Wrap menu.
  358.  
  359. [DataSources] Section
  360. ---------------------
  361. This section is used to remember the data sources that are available to
  362. the user. Each data source, enumerated in this section, also has its own
  363. separate section. This separate section has the same name as that of the
  364. data source and is used to store attributes specific to the data source.
  365.  
  366. Example:
  367.  
  368. [DataSources]
  369. s Default=Projects
  370. S Names=2
  371. Projects
  372. Sample Projects
  373.  
  374. [Projects]
  375. s BTreeList=Generic
  376. s DatabaseDir=/usr/projects
  377. s DatabaseName=datasrc
  378. s PrjDir=/usr/projects
  379. s Type=MPID
  380.  
  381. [Sample Projects]
  382. s BTreeList=Generic
  383. s DatabaseDir=/tools/scase/db/sampledb
  384. s DatabaseName=datasrc
  385. s PrjDir=/tools/scase/db/sampledb
  386. S SrcDirs=2
  387. 00000003 /tools/scase/src/vce_mail
  388. 00000017 /tools/scase/src/ttt
  389. s Type=MPID
  390.  
  391. Variables:
  392.  
  393.     Name:               Default
  394.     Description:        The default data source that is opened when S-CASE starts.
  395.     Type:               String
  396.     Allowable values:   Any valid data source name
  397.     Default value:      None
  398.     Change via S-CASE:  Yes, whenever a new data source is opened, that
  399.                         data source becomes the default data source.
  400.  
  401.     Name:               Names
  402.     Description:        Names of the available data sources.
  403.     Type:               String list
  404.     Allowable values:   Any valid string list
  405.     Default value:      None
  406.     Change via S-CASE:  Yes, when the data source is created, located or removed.
  407.  
  408. NOTE: Following variables specify various attributes of individual data
  409. sources and are valid only in their respective sections.
  410.  
  411.     Name:               BTreeList
  412.     Description:        Name of the B-Tree collection used by the data source.
  413.     Type:               String
  414.     Allowable value:    Generic
  415.     Default value:      None
  416.     Change via S-CASE:  No, S-CASE forces this value to be Generic.
  417.  
  418.     Name:               DatabaseDir
  419.     Description:        Directory where the database is located.
  420.     Type:               String
  421.     Allowable value:    Any valid pathname
  422.     Default value:      None
  423.     Change via S-CASE:  Yes, when a data source is created or located.
  424.  
  425.     Name:               DatabaseName
  426.     Description:        Filename of the database, without the extension.
  427.     Type:               String
  428.     Allowable value:    datasrc
  429.     Default value:      None
  430.     Change via S-CASE:  No, S-CASE forces this value to be datasrc.
  431.  
  432.     Name:               PrjDir
  433.     Description:        Directory where the project documents are located.
  434.     Type:               String
  435.     Allowable value:    Any valid pathname
  436.     Default value:      None
  437.     Change via S-CASE:  Yes, when a data source is created or located.
  438.  
  439.     Name:               SrcDirs
  440.     Description:        Associations between categories and source directories.
  441.     Type:               String list
  442.     Allowable value:    A string list with CategoryId and Path pairs
  443.     Default value:      None
  444.     Change via S-CASE:  Yes, through Options->Source Directory menu.
  445.  
  446.     Name:               Type
  447.     Description:        Type of data source.
  448.     Type:               String
  449.     Allowable value:    MPID (MultiQuest Platform Independent Data-Source)
  450.     Default value:      None
  451.     Change via S-CASE:  No, S-CASE forces this value to be MPID.
  452.  
  453. [Document] Section
  454. ------------------
  455. This section controls various attributes of documents.
  456.  
  457.     Name:               SaveASCII
  458.     Description:        Save documents in ASCII or binary mode.
  459.     Type:               Long
  460.     Allowable values:   0 (Binary), 1 (ASCII)
  461.     Default value:      1
  462.     Change via S-CASE:  No.
  463.  
  464. [Extensions] Section
  465. --------------------
  466. This section defines extensions for various type of files.
  467.  
  468.     Name:               Text
  469.     Description:        Extensions for text files.
  470.     Type:               String List
  471.     Allowable values:   Any string list
  472.     Default value:      None
  473.     Change via S-CASE:  Yes, via text editor╒s Options->Text File Extensions menu.
  474.