User Tools

Site Tools


wiki:manual

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
wiki:manual [2011/06/19 17:00]
nandod Manual review - up to Template info files section
wiki:manual [2015/01/16 08:17] (current)
mariuz [Note]
Line 7: Line 7:
 ===== Help Us Help You ===== ===== Help Us Help You =====
  
-Lots of people have been using FlameRobin in day-to-day work for a long time now. Yet, it still has not reached feature-completeness,​ that's why we are not at release 1.0 yet. Meanwhile, we thank you for evaluating and using this software and encourage you to send comments, bug reports and feature requests back to us so we can make it better.+Lots of people have been using FlameRobin in day-to-day work for a long time now. There are still features to be completed ​. Meanwhile, we thank you for evaluating and using this software and encourage you to send comments, bug reports and feature requests back to us so we can make it better. ​Code contributions and patches are better :)
  
 ===== What FlameRobin is ===== ===== What FlameRobin is =====
Line 13: Line 13:
 FlameRobin is a GUI administration and data manipulation tool for Firebird databases. It is designed to be small, simple and cross-platform,​ yet offer all the basic features needed to administer Firebird servers and create/​maintain databases. FlameRobin is Open Source software and binaries are currently available for Windows, several GNU/Linux and BSD flavours and MacOS X. Ports to other platforms are possible, subject to the availability of maintainers for those platforms. FlameRobin is a GUI administration and data manipulation tool for Firebird databases. It is designed to be small, simple and cross-platform,​ yet offer all the basic features needed to administer Firebird servers and create/​maintain databases. FlameRobin is Open Source software and binaries are currently available for Windows, several GNU/Linux and BSD flavours and MacOS X. Ports to other platforms are possible, subject to the availability of maintainers for those platforms.
  
-===== What FlameRobin is NOT ===== 
  
-FlameRobin is not a full-featured administration tool with lots of bells and whistles, as there are plenty available for Firebird from several different parties. Our first goal with FlameRobin is to provide people not used to the command line with a GUI tool to get started with Firebird. Our longer-term goal is to develop a richer tool that is fully cross-platform;​ while there are several rich and mature GUI tools under Windows, some of them available for free or for a modest price, there isn't any for Linux and MacOS X. Another goal of the project is for a "​lite"​ edition of FlameRobin to be bundled with the Firebird server to serve as a starting kit for new users. This bundle may be distributed by the Firebird Project itself or by some third party. This particular subproject is currently waiting for someone to take it on. 
  
 ===== Who we are ===== ===== Who we are =====
  
-The home page of the FlameRobin project is located at http://www.flamerobin.org. The project itself is hosted on [[http://​sourceforge.net/​projects/​flamerobin|SourceForge]]. Please use our mailing list (flamerobin-devel) to contact the developers. Details and archives available [[http://​sourceforge.net/​mail/?group_id=124340|here]]. You are also encouraged to use our [[http://​sourceforge.net/​tracker/?​group_id=124340&​atid=699234|bugs]] and [[http://​sourceforge.net/​tracker/?​group_id=124340&​atid=699237|feature requests]] trackers to report back to us the results of your alpha testing. If you are a developer interested in joining the FlameRobin project, let us know. We always welcome contributors. +The home page of the FlameRobin project is located at http://​flamerobin.org. The project itself is hosted on [[http://​sourceforge.net/​projects/​flamerobin|SourceForge]]. Please use our mailing list (flamerobin-devel) to contact the developers. Details and archives available [[https://​sourceforge.net/​p/​flamerobin/​mailman/?source=navbar|here]]. You are also encouraged to use our [[https://​sourceforge.net/​p/​flamerobin/​bugs/|bugs]] and [[http://​sourceforge.net/​p/​flamerobin/​feature-requests/|feature requests]] trackers to report back to us the results of your alpha testing. If you are a developer interested in joining the FlameRobin project, let us know. We always welcome contributors.
 ===== License ===== ===== License =====
  
Line 35: Line 32:
 ==== General information ==== ==== General information ====
  
-If you have installed a previous ALPHA version of FlameRobin which is //less than 0.4.0//, it is recommended that you remove it before installing this version. 
- 
-You won't be able to keep a config.ini file from an earlier version, because the name and file format have changed in version 0.4.0. 
- 
-You might be able to keep your servers.xml file, provided that you rename it to fr_databases.conf and move it to your data folder. FlameRobin will tell you the exact path of this file (which changes with the platform) upon first startup, when it cannot find the file. 
  
 Here are the files used by FlameRobin to store configuration information:​ Here are the files used by FlameRobin to store configuration information:​
Line 53: Line 45:
 The location of these files changes with the platform, and it's usually a directory owned by the current user. FlameRobin needs write access to that folder. The location of these files changes with the platform, and it's usually a directory owned by the current user. FlameRobin needs write access to that folder.
  
-==== Windows ​(Win32) ​====+==== Windows ====
  
-To install FlameRobin under Windows you need the Firebird client (gds32.dll for Firebird 1.0, fbclient.dll for Firebird ​1.and up) installed and available, then just run the automatic installer of FlameRobin which will copy all required files in a directory of your choice and optionally create desktop and start menu shortcuts. It will also copy user configuration files to your user "​application data" folder (which changes depending on the Windows version ​+To install FlameRobin under Windows you need the Firebird client (fbclient.dll for Firebird ​2.and up) installed and available, then just run the automatic installer of FlameRobin which will copy all required files in a directory of your choice and optionally create desktop and start menu shortcuts. It will also copy user configuration files to your user "​application data" folder (which changes depending on the Windows version ​
 you are using; an example under Windows 7: C:​\Users\YourName\AppData\Local\flamerobin). you are using; an example under Windows 7: C:​\Users\YourName\AppData\Local\flamerobin).
 If you need to uninstall FlameRobin you can do so from the start menu icon (unless you told the installation program not to create one) or from the Control Panel. If you need to uninstall FlameRobin you can do so from the start menu icon (unless you told the installation program not to create one) or from the Control Panel.
Line 61: Line 53:
 ==== Linux ==== ==== Linux ====
  
-While some Linux distributions might provide installation packages suitable for specific versions of that distribuion,​ FlameRobin project provides generic compressed archives containing the executable and all needed files. ​There are two flavors, depending of your preferences. You can use Gtk1 version, which runs faster and has less dependencies. It is suitable for slower computers and should run out-of-the-box on most distributions. ​Gtk2 version uses Gtk2 toolkit, so it looks nicer on the screen and it also has Unicode support.+While some Linux distributions might provide installation packages suitable for specific versions of that distribuion,​ FlameRobin project provides generic compressed archives containing the executable and all needed files. ​The Gtk2 version uses Gtk2 toolkit, so it looks nicer on the screen and it also has Unicode support.
  
 To install FlameRobin, just unpack the chosen .tar.bz2 archive, cd into that directory and type "make install"​ as root. This will install FlameRobin and all the needed files to appropriate locations. After that, any user can type "​flamerobin"​ to run the program. If you need more detailed instructions,​ you can browse[[http://​flamerobin.org/​dokuwiki/​wiki/​howtobuildonubuntudebian|here]]. To install FlameRobin, just unpack the chosen .tar.bz2 archive, cd into that directory and type "make install"​ as root. This will install FlameRobin and all the needed files to appropriate locations. After that, any user can type "​flamerobin"​ to run the program. If you need more detailed instructions,​ you can browse[[http://​flamerobin.org/​dokuwiki/​wiki/​howtobuildonubuntudebian|here]].
Line 246: Line 238:
 ==== Note ==== ==== Note ====
  
-Since new options are added to FlameRobin ​daily, ​this section of the documentation will likely be out-of-date. Please refer to the tooltips for fresh descriptions of all the available options.+Since new options are added to FlameRobin this section of the documentation will likely be out-of-date. Please refer to the tooltips for fresh descriptions of all the available options.
  
 ==== General ==== ==== General ====
Line 520: Line 512:
 Locations: Locations:
  
-  * $frhome is FlameRobin'​s home path. FlameRobin will find html-templates,​ conf-defs and docs (which are immutable and integral part of the FlameRobin distribution) in its home path. The home path is usually the application folder (on Windows) and an otherwise fixed folder on POSIX platforms.==== Note ====Defining the environment variable FR_HOME will override this path.==== Note ====Passing -h <​path>​ on FlameRobin'​s command line will override this path and the environment variable as well. +  * $frhome is FlameRobin'​s home path. FlameRobin will find html-templates,​ conf-defs and docs (which are immutable and integral part of the FlameRobin distribution) in its home path. The home path is usually the application folder (on Windows) and an otherwise fixed folder on POSIX platforms. ​ 
-  * $fruserhome is FlameRobin'​s user home path. FlameRobin will find the conf files in its user home path. This path has to be writable and may be common to all users on the machine or different for each user. The user home path defaults to the user local data directory, which varies with the platform.==== Note ====Defining the environment variable FR_USER_HOME will override this path.==== Note ====Passing -uh <​path>​ on FlameRobin'​s command line will override this path and the environment variable as well.+=== Note === 
 +Defining the environment variable FR_HOME will override this path. 
 +== Note == 
 +Passing -h <​path>​ on FlameRobin'​s command line will override this path and the environment variable as well. 
 +  * $fruserhome is FlameRobin'​s user home path. FlameRobin will find the conf files in its user home path. This path has to be writable and may be common to all users on the machine or different for each user. The user home path defaults to the user local data directory, which varies with the platform. 
 +== Note == 
 +Defining the environment variable FR_USER_HOME will override this path. 
 +== Note == 
 +Passing -uh <​path>​ on FlameRobin'​s command line will override this path and the environment variable as well.
  
 Additionally,​ the <​path>​ specification in the command line parameters -h and -uh, or the value of the environment variables FR_HOME and FR_USER_HOME may be "​$app",​ which translates to the common data folder (the application folder on Windows and an otherwise fixed folder on POSIX platforms), or "​$user",​ which translates to the user local data directory. Otherwise, it has to be a path (without the trailing path delimiter). Additionally,​ the <​path>​ specification in the command line parameters -h and -uh, or the value of the environment variables FR_HOME and FR_USER_HOME may be "​$app",​ which translates to the common data folder (the application folder on Windows and an otherwise fixed folder on POSIX platforms), or "​$user",​ which translates to the user local data directory. Otherwise, it has to be a path (without the trailing path delimiter).
Line 551: Line 551:
 For more information on ISAAC see: For more information on ISAAC see:
  
-http://​en.wikipedia.org/​wiki/​ISAAC+[[http://​en.wikipedia.org/​wiki/​ISAAC_(cipher)]]
  
-http://​www.burtleburtle.net/​bob/​rand/​isaacafa.html+[[http://​www.burtleburtle.net/​bob/​rand/​isaacafa.html]]
wiki/manual.1308502821.txt.gz · Last modified: 2011/06/19 17:00 by nandod