Add Library Configuration - Revision history

Manus at 12:20, 21 January 2016

2016-01-21T12:20:00Z

Paulb: /* Installation Files */

2008-07-31T16:58:51Z

‎Installation Files

Paulb: /* Installation Files */

2008-07-31T16:58:30Z

‎Installation Files

Paulb at 16:58, 31 July 2008

2008-07-31T16:58:12Z

Paulb: /* User Files */

2008-07-31T16:57:43Z

‎User Files

Peter gummer: /* Editing the Configuration Files */

2008-07-23T23:29:58Z

‎Editing the Configuration Files

Paulb at 20:12, 23 July 2008

2008-07-23T20:12:55Z

New page

[[Category:Extending EiffelStudio]]
[[Category:EiffelStudio User Files]]

As of [[:Category:EiffelStudio|EiffelStudio]] 6.3, the configuration's Add Library and Add Precompile Library dialogs can be customized to include user-specific locations, making it easier to add libraries quickly.

== Installation Files ==
The stock installation configuration files are found under the usual ''eifinit'' configuration folder under ''[[Environment Variables#Core Variables|ISE_EIFFEL]]/studio/eifinit''. For Add Library the configuration file is named ''libraries.cfg'' and for Add Precompile Library the file is named ''precompiles.cfg''. These are the standard configurations for known locations in the [[:Category:EiffelStudio|EiffelStudio]] installation. It is premittable to [[#Editing the Configuration Files|modify]] the contents of these files, if you have the privileges and can point to locations where all users will benefit.

== User Files ==
If you do not have permission to modify the installed configuration files, want to point to user-specific locations or just want a location to remain private to the user then a [[Replaceable User Files|user file]] can be used.

The library configuration dialogs configuration [[Replaceable User Files|user files]] should be located under ''[[Environment Variables#Optional Variables|ISE_USER_FILES]]/studio/eifinit''. See [[Replaceable User Files]] for more information about the resolved value of [[Environment Variables#Optional Variables|ISE_USER_FILES]] for each platform.

Simply create the necessary directory structure and create a '''new''' configuration file with the same name as the one installed. So for ''[[Environment Variables#Core Variables|ISE_EIFFEL]]/studio/eifinit/libraries.cfg'' you'd need to create ''[[Environment Variables#Optional Variables|ISE_USER_FILES]]/studio/eifinit/libraries.cfg''. There is not need to copy the installed configuration files because the contents of both are merged to build the complete list of available libraries, in the appropriate Add Library dialog.

== Editing the Configuration Files ==
The format of the library configuration files is very simplistic:

Each folder entry must be on a new line and may contain [[Environment Variables|environment]] or [[Configuration Variables|configuration file variables]] tokenized by using $NAME or ${NAME} where necessary. Paths should be declared using a back-slash ('\') separator and '''not''' a forward-slash ('/'), although it will function it is not recommended. A path declaration should be followed by a single TAB character and then an integer value, indicating the depth to search in the directory structure.

Search depths can be from 0 to any reasonable depth, respecting the larger the search depth the longer the search duration. A value of 0 will search the declared folder path only, 1 the declared folder and and sub-folder. Finally -1 may be used to search all sub-folders.

The following is an example, with ''<TAB>'' representing the TAB character.

Folder\SubFolder<TAB>3
AnotherFolder\SubFolder<TAB>2

A more concrete, and possible useful examples, is referencing the Eiffel source framework libraries:

$EIFFEL_SRC\framework 3

@@ Line 5: / Line 5: @@
 == Installation Files ==
-The stock installation configuration files are found under the usual ''eifinit'' configuration folder under ''[[Environment Variables#Core Variables $ISE_EIFFEL]]/studio/eifinit''. For Add Library the configuration file is named ''libraries.cfg'' and for Add Precompile Library the file is named ''precompiles.cfg''. These are the standard configurations for known locations in the [[:Category:EiffelStudio|EiffelStudio]] installation. It is premittable to [[#Editing the Configuration Files|modify]] the contents of these files, if you have the privileges and can point to locations where all users will benefit.
+The stock installation configuration files are found under the usual ''eifinit'' configuration folder under ''[[Environment Variables#Core Variables|$ISE_EIFFEL]]/studio/eifinit''. For Add Library the configuration file is named ''libraries.cfg'' and for Add Precompile Library the file is named ''precompiles.cfg''. These are the standard configurations for known locations in the [[:Category:EiffelStudio|EiffelStudio]] installation. It is premittable to [[#Editing the Configuration Files|modify]] the contents of these files, if you have the privileges and can point to locations where all users will benefit.
 == User Files ==

@@ Line 5: / Line 5: @@
 == Installation Files ==
-The stock installation configuration files are found under the usual ''eifinit'' configuration folder under ''[[Environment Variables#Core Variables$ISE_EIFFEL]]/studio/eifinit''. For Add Library the configuration file is named ''libraries.cfg'' and for Add Precompile Library the file is named ''precompiles.cfg''. These are the standard configurations for known locations in the [[:Category:EiffelStudio|EiffelStudio]] installation. It is premittable to [[#Editing the Configuration Files|modify]] the contents of these files, if you have the privileges and can point to locations where all users will benefit.
+The stock installation configuration files are found under the usual ''eifinit'' configuration folder under ''[[Environment Variables#Core Variables $ISE_EIFFEL]]/studio/eifinit''. For Add Library the configuration file is named ''libraries.cfg'' and for Add Precompile Library the file is named ''precompiles.cfg''. These are the standard configurations for known locations in the [[:Category:EiffelStudio|EiffelStudio]] installation. It is premittable to [[#Editing the Configuration Files|modify]] the contents of these files, if you have the privileges and can point to locations where all users will benefit.
 == User Files ==

@@ Line 5: / Line 5: @@
 == Installation Files ==
-The stock installation configuration files are found under the usual ''eifinit'' configuration folder under ''[[Environment Variables#Core Variables|ISE_EIFFEL]]/studio/eifinit''. For Add Library the configuration file is named ''libraries.cfg'' and for Add Precompile Library the file is named ''precompiles.cfg''. These are the standard configurations for known locations in the [[:Category:EiffelStudio|EiffelStudio]] installation. It is premittable to [[#Editing the Configuration Files|modify]] the contents of these files, if you have the privileges and can point to locations where all users will benefit.
+The stock installation configuration files are found under the usual ''eifinit'' configuration folder under ''[[Environment Variables#Core Variables$ISE_EIFFEL]]/studio/eifinit''. For Add Library the configuration file is named ''libraries.cfg'' and for Add Precompile Library the file is named ''precompiles.cfg''. These are the standard configurations for known locations in the [[:Category:EiffelStudio|EiffelStudio]] installation. It is premittable to [[#Editing the Configuration Files|modify]] the contents of these files, if you have the privileges and can point to locations where all users will benefit.
 == User Files ==
@@ Line 12: / Line 12: @@
 The library configuration dialogs configuration [[Replaceable User Files|user files]] should be located under ''[[Environment Variables#Optional Variables|$ISE_USER_FILES]]/studio/eifinit''. See [[Replaceable User Files]] for more information about the resolved value of [[Environment Variables#Optional Variables|ISE_USER_FILES]] for each platform.
-Simply create the necessary directory structure and create a '''new''' configuration file with the same name as the one installed. So for ''[[Environment Variables#Core Variables|$ISE_EIFFEL]]/studio/eifinit/libraries.cfg'' you'd need to create ''[[Environment Variables#Optional Variables|ISE_USER_FILES]]/studio/eifinit/libraries.cfg''. There is not need to copy the installed configuration files because the contents of both are merged to build the complete list of available libraries, in the appropriate Add Library dialog.
+Simply create the necessary directory structure and create a '''new''' configuration file with the same name as the one installed. So for ''[[Environment Variables#Core Variables|$ISE_EIFFEL]]/studio/eifinit/libraries.cfg'' you'd need to create ''[[Environment Variables#Optional Variables|$ISE_USER_FILES]]/studio/eifinit/libraries.cfg''. There is not need to copy the installed configuration files because the contents of both are merged to build the complete list of available libraries, in the appropriate Add Library dialog.
 == Editing the Configuration Files ==

@@ Line 1: / Line 1: @@
-[[Category:Extending EiffelStudio]]
+[[Category:EiffelStudio]]
-[[Category:EiffelStudio User Files]]
 As of [[:Category:EiffelStudio|EiffelStudio]] 6.3, the configuration's Add Library and Add Precompile Library dialogs can be customized to include user-specific locations, making it easier to add libraries quickly.

@@ Line 10: / Line 10: @@
 If you do not have permission to modify the installed configuration files, want to point to user-specific locations or just want a location to remain private to the user then a [[Replaceable User Files|user file]] can be used.
-The library configuration dialogs configuration [[Replaceable User Files|user files]] should be located under ''[[Environment Variables#Optional Variables|ISE_USER_FILES]]/studio/eifinit''. See [[Replaceable User Files]] for more information about the resolved value of [[Environment Variables#Optional Variables|ISE_USER_FILES]] for each platform.
+The library configuration dialogs configuration [[Replaceable User Files|user files]] should be located under ''[[Environment Variables#Optional Variables|$ISE_USER_FILES]]/studio/eifinit''. See [[Replaceable User Files]] for more information about the resolved value of [[Environment Variables#Optional Variables|ISE_USER_FILES]] for each platform.
-Simply create the necessary directory structure and create a '''new''' configuration file with the same name as the one installed. So for ''[[Environment Variables#Core Variables|ISE_EIFFEL]]/studio/eifinit/libraries.cfg'' you'd need to create ''[[Environment Variables#Optional Variables|ISE_USER_FILES]]/studio/eifinit/libraries.cfg''. There is not need to copy the installed configuration files because the contents of both are merged to build the complete list of available libraries, in the appropriate Add Library dialog.
+Simply create the necessary directory structure and create a '''new''' configuration file with the same name as the one installed. So for ''[[Environment Variables#Core Variables|$ISE_EIFFEL]]/studio/eifinit/libraries.cfg'' you'd need to create ''[[Environment Variables#Optional Variables|ISE_USER_FILES]]/studio/eifinit/libraries.cfg''. There is not need to copy the installed configuration files because the contents of both are merged to build the complete list of available libraries, in the appropriate Add Library dialog.
 == Editing the Configuration Files ==

@@ Line 17: / Line 17: @@
 The format of the library configuration files is very simplistic:
-Each folder entry must be on a new line and may contain [[Environment Variables|environment]] or [[Configuration Variables|configuration file variables]] tokenized by using $NAME or ${NAME} where necessary. Paths should be declared using a back-slash ('\') separator and '''not''' a forward-slash ('/'), although it will function it is not recommended. A path declaration should be followed by a single TAB character and then an integer value, indicating the depth to search in the directory structure.
+Each folder entry must be on a new line and may contain [[Environment Variables|environment]] or [[Configuration Variables|configuration file variables]] tokenized by using $NAME or ${NAME} where necessary. Paths should be declared using a back-slash ('\') separator and '''not''' a forward-slash ('/'); although it will function it is not recommended. A path declaration should be followed by a single TAB character and then an integer value, indicating the depth to search in the directory structure.
 Search depths can be from 0 to any reasonable depth, respecting the larger the search depth the longer the search duration. A value of 0 will search the declared folder path only, 1 the declared folder and and sub-folder. Finally -1 may be used to search all sub-folders.
@@ Line 26: / Line 26: @@
   AnotherFolder\SubFolder<TAB>2
-A more concrete, and possible useful examples, is referencing the Eiffel source framework libraries:
+A more concrete, and possible useful example, is referencing the Eiffel source framework libraries:
-  $EIFFEL_SRC\framework	3
+  $EIFFEL_SRC\framework<TAB>3