Difference between revisions of "Configuration Files and Folders"
(→settings.xml) |
(→User's Data Path) |
||
| (10 intermediate revisions by the same user not shown) | |||
| Line 3: | Line 3: | ||
= Files = | = Files = | ||
| − | == <code>owl | + | == <code>[[owl.ini]]</code> == |
| − | The <code>owl | + | The <code>[[owl.ini]]</code> file stores user settings. |
| + | On startup, Owl will look for this file in the user's data path. If the file is not found then then the default version inside the application folder is copied to the user's data path. If the owl.ini file is specified with the "-i" switch on the command line, then Owl will attempt to load that file and exit with an error if unable. | ||
| + | |||
| + | Example: | ||
<source lang="bash">-i=C:\Test\Folder\owl-settings.ini</source> | <source lang="bash">-i=C:\Test\Folder\owl-settings.ini</source> | ||
| − | |||
| − | |||
== <code>settings.xml</code> == | == <code>settings.xml</code> == | ||
| − | The <code>settings.xml</code> file contains settings for Owl that typically do not change. This file should not be edited without first understanding its content | + | The <code>settings.xml</code> file contains settings for Owl that typically do not change. This file should not be edited without first understanding its content since an invalid configuration can cause Owl to malfunction. This file lives in the application folder but can be overridden with the <code>-s</code> command line option. |
| + | Example: | ||
<source lang="bash">-s=C:\Test\Folder\settings.xml</source> | <source lang="bash">-s=C:\Test\Folder\settings.xml</source> | ||
| + | |||
| + | == <code>.owlignore</code> == | ||
| + | |||
| + | '''<tt>.owlignore</tt>''' is a text file that allows users to specify a list of Lua [[Parsers]] that Owl should ignore when starting up. The file should contain one file name or parser name per line. | ||
| + | |||
| + | <source lang="ini">parser-phpbb3x.lua | ||
| + | vbulletin4x</source> | ||
| + | <br/> | ||
| + | Any parsers with the file name '''or''' parser-name "parser-phpbb3x.lua" or "vbulletin4x" will be ignored. | ||
= Folders = | = Folders = | ||
| Line 23: | Line 34: | ||
=== User's Data Path === | === User's Data Path === | ||
| − | Location of <code>owl | + | Location of <code>owl.ini</code> and <code>settings.xml</code>. |
; OS X | ; OS X | ||
| − | : $HOME/Library/Application Support/lulzapps/Owl/owl | + | : $HOME/Library/Application Support/lulzapps/Owl/owl.ini |
; Windows | ; Windows | ||
| − | : C:/Users/<USER>/AppData/Local/Owl/owl | + | : C:/Users/<USER>/AppData/Local/Owl/owl.ini |
| + | |||
| + | [[Category:Configuration Files]] | ||
Latest revision as of 20:48, 14 September 2014
Owl uses a number of files and folders. Some of these are in the personal configuration folders while others are maintained in the system areas.
Files
owl.ini
The owl.ini file stores user settings.
On startup, Owl will look for this file in the user's data path. If the file is not found then then the default version inside the application folder is copied to the user's data path. If the owl.ini file is specified with the "-i" switch on the command line, then Owl will attempt to load that file and exit with an error if unable.
Example: <source lang="bash">-i=C:\Test\Folder\owl-settings.ini</source>
settings.xml
The settings.xml file contains settings for Owl that typically do not change. This file should not be edited without first understanding its content since an invalid configuration can cause Owl to malfunction. This file lives in the application folder but can be overridden with the -s command line option.
Example: <source lang="bash">-s=C:\Test\Folder\settings.xml</source>
.owlignore
.owlignore is a text file that allows users to specify a list of Lua Parsers that Owl should ignore when starting up. The file should contain one file name or parser name per line.
<source lang="ini">parser-phpbb3x.lua
vbulletin4x</source>
Any parsers with the file name or parser-name "parser-phpbb3x.lua" or "vbulletin4x" will be ignored.
Folders
Owl uses standard folders configured for each OS. Most files are stored in the user specific
User's Data Path
Location of owl.ini and settings.xml.
- OS X
- $HOME/Library/Application Support/lulzapps/Owl/owl.ini
- Windows
- C:/Users/<USER>/AppData/Local/Owl/owl.ini
