/usr/share/frei0r/html/group__pluglocations.html is in frei0r-plugins-doc 1.4-3build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>frei0r: Plugin Locations</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">frei0r
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__pluglocations.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">Plugin Locations</div> </div>
</div><!--header-->
<div class="contents">
<h1><a class="anchor" id="sec_pluglocations"></a>
Plugin Locations</h1>
<p>For Unix platforms there are rules for the location of frei0r plugins.</p>
<p>frei0r 1.x plugin files should be located in</p>
<ul>
<li>(1) /usr/lib/frei0r-1/<vendor></li>
<li>(2) /usr/local/lib/frei0r-1/<vendor></li>
<li>(3) $HOME/.frei0r-1/lib/<vendor></li>
</ul>
<p>Examples:</p>
<ul>
<li>/usr/lib/frei0r-1/mob/flippo.so</li>
<li>/usr/lib/frei0r-1/drone/flippo.so</li>
<li>/usr/local/lib/frei0r-1/gephex/coma/invert0r.so</li>
<li>/home/martin/.frei0r-1/lib/martin/test.so</li>
</ul>
<p>Like in these examples plugins should be placed in "vendor" subdirs to reduce name clashes. However, <vendor> is optional and may be left blank.</p>
<h2><a class="anchor" id="sec_order"></a>
Plugin Loading Order</h2>
<p>The application shall load plugins in the following order: 3, 2, 1. If a name clash occurs (two or more frei0r plugins with identical effect name), the plugins in directory 3 have precedence over plugins in directory 2, and those in directory 2 have precedence over plugins in directory 1.</p>
<p>This makes it possible for users to "override" effects that are installed in system wide directories by placing plugins in their home directory.</p>
<p>The order of loading plugins inside each of the directories 1, 2, and 3 is not defined.</p>
<h2><a class="anchor" id="sec_path"></a>
FREI0R_PATH Environment Variable</h2>
<p>If the environment variable FREI0R_PATH is defined, then it shall be considered a colon separated list of directories which replaces the default list.</p>
<p>For example:</p>
<p>FREI0R_PATH=/home/foo/frei0r-plugins:/usr/lib/frei0r-1:/etc/frei0r</p>
<p>On Windows platforms a semicolon ';' must be used instead of colon ':' to separate FREI0R_PATH entries (due to the way filenames are interpreted), hence a cross-platform host application should detect the platform running and adjust the parsed char accordingly, for example:</p>
<p>FREI0R_PATH=C: Files-1;%PROGRAMFILES%-1 </p>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
</ul>
</div>
</body>
</html>
|