File: ApplicationDatabase.html

package info (click to toggle)
fvwm-crystal 3.4.1%2Bdfsg-1
links: PTS, VCS
area: main
in suites: buster, stretch
size: 21,700 kB
ctags: 1,494
sloc: sh: 3,265; cs: 1,335; python: 875; makefile: 214
file content (966 lines) | stat: -rw-r--r-- 29,626 bytes
parent folder | download | duplicates (2)
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.9" />
<title>ApplicationDatabase(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */

/* Default font. */
body {
  font-family: Georgia,serif;
}

/* Title font. */
h1, h2, h3, h4, h5, h6,
div.title, caption.title,
thead, p.table.header,
#toctitle,
#author, #revnumber, #revdate, #revremark,
#footer {
  font-family: Arial,Helvetica,sans-serif;
}

body {
  margin: 1em 5% 1em 5%;
}

a {
  color: blue;
  text-decoration: underline;
}
a:visited {
  color: fuchsia;
}

em {
  font-style: italic;
  color: navy;
}

strong {
  font-weight: bold;
  color: #083194;
}

h1, h2, h3, h4, h5, h6 {
  color: #527bbd;
  margin-top: 1.2em;
  margin-bottom: 0.5em;
  line-height: 1.3;
}

h1, h2, h3 {
  border-bottom: 2px solid silver;
}
h2 {
  padding-top: 0.5em;
}
h3 {
  float: left;
}
h3 + * {
  clear: left;
}
h5 {
  font-size: 1.0em;
}

div.sectionbody {
  margin-left: 0;
}

hr {
  border: 1px solid silver;
}

p {
  margin-top: 0.5em;
  margin-bottom: 0.5em;
}

ul, ol, li > p {
  margin-top: 0;
}
ul > li     { color: #aaa; }
ul > li > * { color: black; }

.monospaced, code, pre {
  font-family: "Courier New", Courier, monospace;
  font-size: inherit;
  color: navy;
  padding: 0;
  margin: 0;
}
pre {
  white-space: pre-wrap;
}

#author {
  color: #527bbd;
  font-weight: bold;
  font-size: 1.1em;
}
#email {
}
#revnumber, #revdate, #revremark {
}

#footer {
  font-size: small;
  border-top: 2px solid silver;
  padding-top: 0.5em;
  margin-top: 4.0em;
}
#footer-text {
  float: left;
  padding-bottom: 0.5em;
}
#footer-badges {
  float: right;
  padding-bottom: 0.5em;
}

#preamble {
  margin-top: 1.5em;
  margin-bottom: 1.5em;
}
div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
  margin-top: 1.0em;
  margin-bottom: 1.5em;
}
div.admonitionblock {
  margin-top: 2.0em;
  margin-bottom: 2.0em;
  margin-right: 10%;
  color: #606060;
}

div.content { /* Block element content. */
  padding: 0;
}

/* Block element titles. */
div.title, caption.title {
  color: #527bbd;
  font-weight: bold;
  text-align: left;
  margin-top: 1.0em;
  margin-bottom: 0.5em;
}
div.title + * {
  margin-top: 0;
}

td div.title:first-child {
  margin-top: 0.0em;
}
div.content div.title:first-child {
  margin-top: 0.0em;
}
div.content + div.title {
  margin-top: 0.0em;
}

div.sidebarblock > div.content {
  background: #ffffee;
  border: 1px solid #dddddd;
  border-left: 4px solid #f0f0f0;
  padding: 0.5em;
}

div.listingblock > div.content {
  border: 1px solid #dddddd;
  border-left: 5px solid #f0f0f0;
  background: #f8f8f8;
  padding: 0.5em;
}

div.quoteblock, div.verseblock {
  padding-left: 1.0em;
  margin-left: 1.0em;
  margin-right: 10%;
  border-left: 5px solid #f0f0f0;
  color: #888;
}

div.quoteblock > div.attribution {
  padding-top: 0.5em;
  text-align: right;
}

div.verseblock > pre.content {
  font-family: inherit;
  font-size: inherit;
}
div.verseblock > div.attribution {
  padding-top: 0.75em;
  text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
  text-align: left;
}

div.admonitionblock .icon {
  vertical-align: top;
  font-size: 1.1em;
  font-weight: bold;
  text-decoration: underline;
  color: #527bbd;
  padding-right: 0.5em;
}
div.admonitionblock td.content {
  padding-left: 0.5em;
  border-left: 3px solid #dddddd;
}

div.exampleblock > div.content {
  border-left: 3px solid #dddddd;
  padding-left: 0.5em;
}

div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; vertical-align: text-bottom; }
a.image:visited { color: white; }

dl {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
}
dt {
  margin-top: 0.5em;
  margin-bottom: 0;
  font-style: normal;
  color: navy;
}
dd > *:first-child {
  margin-top: 0.1em;
}

ul, ol {
    list-style-position: outside;
}
ol.arabic {
  list-style-type: decimal;
}
ol.loweralpha {
  list-style-type: lower-alpha;
}
ol.upperalpha {
  list-style-type: upper-alpha;
}
ol.lowerroman {
  list-style-type: lower-roman;
}
ol.upperroman {
  list-style-type: upper-roman;
}

div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
  margin-top: 0.1em;
  margin-bottom: 0.1em;
}

tfoot {
  font-weight: bold;
}
td > div.verse {
  white-space: pre;
}

div.hdlist {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
}
div.hdlist tr {
  padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
  font-weight: bold;
}
td.hdlist1 {
  vertical-align: top;
  font-style: normal;
  padding-right: 0.8em;
  color: navy;
}
td.hdlist2 {
  vertical-align: top;
}
div.hdlist.compact tr {
  margin: 0;
  padding-bottom: 0;
}

.comment {
  background: yellow;
}

.footnote, .footnoteref {
  font-size: 0.8em;
}

span.footnote, span.footnoteref {
  vertical-align: super;
}

#footnotes {
  margin: 20px 0 20px 0;
  padding: 7px 0 0 0;
}

#footnotes div.footnote {
  margin: 0 0 5px 0;
}

#footnotes hr {
  border: none;
  border-top: 1px solid silver;
  height: 1px;
  text-align: left;
  margin-left: 0;
  width: 20%;
  min-width: 100px;
}

div.colist td {
  padding-right: 0.5em;
  padding-bottom: 0.3em;
  vertical-align: top;
}
div.colist td img {
  margin-top: 0.3em;
}

@media print {
  #footer-badges { display: none; }
}

#toc {
  margin-bottom: 2.5em;
}

#toctitle {
  color: #527bbd;
  font-size: 1.1em;
  font-weight: bold;
  margin-top: 1.0em;
  margin-bottom: 0.1em;
}

div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
  margin-top: 0;
  margin-bottom: 0;
}
div.toclevel2 {
  margin-left: 2em;
  font-size: 0.9em;
}
div.toclevel3 {
  margin-left: 4em;
  font-size: 0.9em;
}
div.toclevel4 {
  margin-left: 6em;
  font-size: 0.9em;
}

span.aqua { color: aqua; }
span.black { color: black; }
span.blue { color: blue; }
span.fuchsia { color: fuchsia; }
span.gray { color: gray; }
span.green { color: green; }
span.lime { color: lime; }
span.maroon { color: maroon; }
span.navy { color: navy; }
span.olive { color: olive; }
span.purple { color: purple; }
span.red { color: red; }
span.silver { color: silver; }
span.teal { color: teal; }
span.white { color: white; }
span.yellow { color: yellow; }

span.aqua-background { background: aqua; }
span.black-background { background: black; }
span.blue-background { background: blue; }
span.fuchsia-background { background: fuchsia; }
span.gray-background { background: gray; }
span.green-background { background: green; }
span.lime-background { background: lime; }
span.maroon-background { background: maroon; }
span.navy-background { background: navy; }
span.olive-background { background: olive; }
span.purple-background { background: purple; }
span.red-background { background: red; }
span.silver-background { background: silver; }
span.teal-background { background: teal; }
span.white-background { background: white; }
span.yellow-background { background: yellow; }

span.big { font-size: 2em; }
span.small { font-size: 0.6em; }

span.underline { text-decoration: underline; }
span.overline { text-decoration: overline; }
span.line-through { text-decoration: line-through; }

div.unbreakable { page-break-inside: avoid; }


/*
 * xhtml11 specific
 *
 * */

div.tableblock {
  margin-top: 1.0em;
  margin-bottom: 1.5em;
}
div.tableblock > table {
  border: 3px solid #527bbd;
}
thead, p.table.header {
  font-weight: bold;
  color: #527bbd;
}
p.table {
  margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
  border-style: none;
}
div.tableblock > table[frame="hsides"] {
  border-left-style: none;
  border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
  border-top-style: none;
  border-bottom-style: none;
}


/*
 * html5 specific
 *
 * */

table.tableblock {
  margin-top: 1.0em;
  margin-bottom: 1.5em;
}
thead, p.tableblock.header {
  font-weight: bold;
  color: #527bbd;
}
p.tableblock {
  margin-top: 0;
}
table.tableblock {
  border-width: 3px;
  border-spacing: 0px;
  border-style: solid;
  border-color: #527bbd;
  border-collapse: collapse;
}
th.tableblock, td.tableblock {
  border-width: 1px;
  padding: 4px;
  border-style: solid;
  border-color: #527bbd;
}

table.tableblock.frame-topbot {
  border-left-style: hidden;
  border-right-style: hidden;
}
table.tableblock.frame-sides {
  border-top-style: hidden;
  border-bottom-style: hidden;
}
table.tableblock.frame-none {
  border-style: hidden;
}

th.tableblock.halign-left, td.tableblock.halign-left {
  text-align: left;
}
th.tableblock.halign-center, td.tableblock.halign-center {
  text-align: center;
}
th.tableblock.halign-right, td.tableblock.halign-right {
  text-align: right;
}

th.tableblock.valign-top, td.tableblock.valign-top {
  vertical-align: top;
}
th.tableblock.valign-middle, td.tableblock.valign-middle {
  vertical-align: middle;
}
th.tableblock.valign-bottom, td.tableblock.valign-bottom {
  vertical-align: bottom;
}


/*
 * manpage specific
 *
 * */

body.manpage h1 {
  padding-top: 0.5em;
  padding-bottom: 0.5em;
  border-top: 2px solid silver;
  border-bottom: 2px solid silver;
}
body.manpage h2 {
  border-style: none;
}
body.manpage div.sectionbody {
  margin-left: 3em;
}

@media print {
  body.manpage div#toc { display: none; }
}


</style>
<script type="text/javascript">
/*<![CDATA[*/
var asciidoc = {  // Namespace.

/////////////////////////////////////////////////////////////////////
// Table Of Contents generator
/////////////////////////////////////////////////////////////////////

/* Author: Mihai Bazon, September 2002
 * http://students.infoiasi.ro/~mishoo
 *
 * Table Of Content generator
 * Version: 0.4
 *
 * Feel free to use this script under the terms of the GNU General Public
 * License, as long as you do not remove or alter this notice.
 */

 /* modified by Troy D. Hanson, September 2006. License: GPL */
 /* modified by Stuart Rackham, 2006, 2009. License: GPL */

// toclevels = 1..4.
toc: function (toclevels) {

  function getText(el) {
    var text = "";
    for (var i = el.firstChild; i != null; i = i.nextSibling) {
      if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
        text += i.data;
      else if (i.firstChild != null)
        text += getText(i);
    }
    return text;
  }

  function TocEntry(el, text, toclevel) {
    this.element = el;
    this.text = text;
    this.toclevel = toclevel;
  }

  function tocEntries(el, toclevels) {
    var result = new Array;
    var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
    // Function that scans the DOM tree for header elements (the DOM2
    // nodeIterator API would be a better technique but not supported by all
    // browsers).
    var iterate = function (el) {
      for (var i = el.firstChild; i != null; i = i.nextSibling) {
        if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
          var mo = re.exec(i.tagName);
          if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
            result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
          }
          iterate(i);
        }
      }
    }
    iterate(el);
    return result;
  }

  var toc = document.getElementById("toc");
  if (!toc) {
    return;
  }

  // Delete existing TOC entries in case we're reloading the TOC.
  var tocEntriesToRemove = [];
  var i;
  for (i = 0; i < toc.childNodes.length; i++) {
    var entry = toc.childNodes[i];
    if (entry.nodeName.toLowerCase() == 'div'
     && entry.getAttribute("class")
     && entry.getAttribute("class").match(/^toclevel/))
      tocEntriesToRemove.push(entry);
  }
  for (i = 0; i < tocEntriesToRemove.length; i++) {
    toc.removeChild(tocEntriesToRemove[i]);
  }

  // Rebuild TOC entries.
  var entries = tocEntries(document.getElementById("content"), toclevels);
  for (var i = 0; i < entries.length; ++i) {
    var entry = entries[i];
    if (entry.element.id == "")
      entry.element.id = "_toc_" + i;
    var a = document.createElement("a");
    a.href = "#" + entry.element.id;
    a.appendChild(document.createTextNode(entry.text));
    var div = document.createElement("div");
    div.appendChild(a);
    div.className = "toclevel" + entry.toclevel;
    toc.appendChild(div);
  }
  if (entries.length == 0)
    toc.parentNode.removeChild(toc);
},


/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////

/* Based on footnote generation code from:
 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 */

footnotes: function () {
  // Delete existing footnote entries in case we're reloading the footnodes.
  var i;
  var noteholder = document.getElementById("footnotes");
  if (!noteholder) {
    return;
  }
  var entriesToRemove = [];
  for (i = 0; i < noteholder.childNodes.length; i++) {
    var entry = noteholder.childNodes[i];
    if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
      entriesToRemove.push(entry);
  }
  for (i = 0; i < entriesToRemove.length; i++) {
    noteholder.removeChild(entriesToRemove[i]);
  }

  // Rebuild footnote entries.
  var cont = document.getElementById("content");
  var spans = cont.getElementsByTagName("span");
  var refs = {};
  var n = 0;
  for (i=0; i<spans.length; i++) {
    if (spans[i].className == "footnote") {
      n++;
      var note = spans[i].getAttribute("data-note");
      if (!note) {
        // Use [\s\S] in place of . so multi-line matches work.
        // Because JavaScript has no s (dotall) regex flag.
        note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
        spans[i].innerHTML =
          "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
          "' title='View footnote' class='footnote'>" + n + "</a>]";
        spans[i].setAttribute("data-note", note);
      }
      noteholder.innerHTML +=
        "<div class='footnote' id='_footnote_" + n + "'>" +
        "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
        n + "</a>. " + note + "</div>";
      var id =spans[i].getAttribute("id");
      if (id != null) refs["#"+id] = n;
    }
  }
  if (n == 0)
    noteholder.parentNode.removeChild(noteholder);
  else {
    // Process footnoterefs.
    for (i=0; i<spans.length; i++) {
      if (spans[i].className == "footnoteref") {
        var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
        href = href.match(/#.*/)[0];  // Because IE return full URL.
        n = refs[href];
        spans[i].innerHTML =
          "[<a href='#_footnote_" + n +
          "' title='View footnote' class='footnote'>" + n + "</a>]";
      }
    }
  }
},

install: function(toclevels) {
  var timerId;

  function reinstall() {
    asciidoc.footnotes();
    if (toclevels) {
      asciidoc.toc(toclevels);
    }
  }

  function reinstallAndRemoveTimer() {
    clearInterval(timerId);
    reinstall();
  }

  timerId = setInterval(reinstall, 500);
  if (document.addEventListener)
    document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
  else
    window.onload = reinstallAndRemoveTimer;
}

}
asciidoc.install();
/*]]>*/
</script>
</head>
<body class="manpage">
<div id="header">
<h1>
ApplicationDatabase(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
<p>ApplicationDatabase -
   provide "fvwm-crystal.apps" - a feature rich script that generate FVWM-Crystal applications menu from database entries and icons. It can be used in conjunction with "fvwm-crystal.generate-menu" - a script that generate the database entries and the icons used by fvwm-crystal.apps, by reading the desktop files provided by the applications, that with full support of the FreeDesktop additional categories.
</p>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="paragraph"><p>None</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph"><p>Application database (with fvwm-crystal.apps and fvwm-crystal.generate-menu scripts) is one of the most interesting elements of FVWM-Crystal desktop.
Thanks to these elements you can have a panel or the menu with applications currently installed on a given system.</p></div>
<div class="paragraph"><p>Database structure is very flexible, allowing you to combine several databases into one (system-wide and user-wide, for example), mask selected applications or even whole directories, so they won&#8217;t be visible, and so on.</p></div>
<div class="paragraph"><p>Application panel/menu generator also has many interesting features - you can create different panels and menu systems and easily blend them with your FVWM configuration.</p></div>
<div class="sect2">
<h3 id="_database_structure">Database structure</h3>
<div class="paragraph"><p>A database is a set of directories and scripts with special naming structure.
Each directory and subdirectory creates a <strong>category</strong> in which you can put
selected applications, for example <strong>Games</strong> or <strong>Office</strong>. Categories can be
nested, in turn creating subcategories, like <strong>FPP Games</strong> or <strong>OpenOffice.org</strong>.
In generation process each subdirectory is transformed into a submenu containg menu items specified in this subdirectory.</p></div>
<div class="paragraph"><p>Each directory and script have a special naming pattern. Here&#8217;s the list of possible names:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>entry_name
~entry_name
~~entry_name
~executable_name~entry_name
priority~entry_name
priority~~entry_name
priority~executable_name~entry_name</code></pre>
</div></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<em>entry_name</em>
</dt>
<dd>
<div class="paragraph"><p>is the name of the menu item or button on a panel. This is a required field. If it&#8217;s the only one present, generator assumes that this entry should be put in the menu or panel without checking if associated application is present.</p></div>
</dd>
<dt class="hdlist1">
<em>executable_name</em>
</dt>
<dd>
<div class="paragraph"><p>is used to specify a name of the executable file. It&#8217;s used to determine if
selected application is installed on the system, and in turn decide if this
entry should be put in the menu/panel or not. Applications are searched in the
directories specified using $PATH environment variable. This field is
optional, and is only tested, if <em>--check-exec</em> option is present.</p></div>
</dd>
<dt class="hdlist1">
<em>priority</em>
</dt>
<dd>
<div class="paragraph"><p>is a numeric only field (also optional). It is used in the sorting mechanism to determine, what <strong>importance</strong> has particular menu item. Entries with higher priorities will be put higher in the menu system (therefore closer to the mouse pointer), lower priorities will be pushed at the end of the menu.
By default an entry without priority field has priority set to 0.</p></div>
</dd>
</dl></div>
<div class="paragraph"><p>As you can see, each directory and script name is used to sort and create
menus and panels. Also attributes of the files and directories are used in
this process. Each directory and script has an executable (x) bit set, for
allowing execution (see below) or reading inside directories. This can be used
to exclude certain files or directories from the generated menus or panels. By
removing the executable bit (<em>chmod -x</em>) from a file or directory you can
prevent it to be seen by the generator and ommited in the generated menu. By
combining this ability with <strong>database merging</strong> (each database masks previous one) you can use, for example, user-side application database to remove certain programs from this users menu.</p></div>
<div class="paragraph"><p>Generator doesn&#8217;t put in the menu entry complete path to the binary it found - instead it puts the path to the script itself. In the end, what users do is not launching applications directly, but instead launching scripts located in the application database, which in turn launch the applications themselves.
That means, what&#8217;s inside of the script, is completely meaningless to the generator; you can write complex scripts which are shown in the menu system and easily launch them.</p></div>
<div class="paragraph"><p>Instead of using the scripts, you can also make symlinks to selected binaries (using the specified naming rules), they also will be checked and included in the menu system. Script automatically tests, if symlink is correct (ie. target is present), and if the target has an executable bit set.</p></div>
</div>
<div class="sect2">
<h3 id="_database_masking">Database masking</h3>
<div class="paragraph"><p>You can give <strong>fvwm-crystal.apps</strong> script several databases in one command, for example:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>fvwm-crystal.apps --database=/some/directory --database=/other/dir</code></pre>
</div></div>
<div class="paragraph"><p>When that happens, generator first reads first given database
(/some/directory), and after that adds next databases (/other/dir) to the
first one. You can use this feature to make changes in separate database that
affect generated menus and panels, but not modify the original database
itself. This mechanism is used in FVWM-Crystal by combining user-side database
located in <strong>~/.fvwm/Applications</strong> with system-wide, located in
<strong>/usr/share/fvwm-crystal/fvwm/Applications</strong> (by default).</p></div>
<div class="paragraph"><p>For successfull <strong>database masking</strong> you need to use the same directory
structure as the original database. That means, if you want to modify an entry
located in, for example, <strong>/Applications/Games/FPP</strong>, you need to create the
same directories in your <strong>local</strong> database. You can omit the <strong>priority</strong> field in directory/file names, or change it, thus moving selected menu entry in the menu hierarhy. For example:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>system-wide:    /Applications/20~Games/FPP/10~quake~Quake
user-wide:      /Applications/Games/FPP/30~quake~Quake</code></pre>
</div></div>
<div class="paragraph"><p>File attributes also can be masked. If you want to remove a menu entry (or
even entire submenu), you need to create all directories and a script which
lead to selected entry, and then remove the executable bit (chmod -x) from the
directory or script in your <strong>local</strong> database.</p></div>
<div class="paragraph"><p>Consequently, if you want to move a menu entry or submenu itself from one
place to another in the menu structure, you can create neccesary files in
desired location (or make symlinks to files/directories in original database),
then create the <strong>old</strong> files and directories, and remove their executable bit. Menu entries will disappear from their original locations and appear in those selected by your database.</p></div>
</div>
<div class="sect2">
<h3 id="_application_icons">Application icons</h3>
<div class="paragraph"><p>Each application has it&#8217;s own icon. Icon files are found using the entry or exectuable file name, like this:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>entry_name.png
executable_name.png</code></pre>
</div></div>
<div class="paragraph"><p>First <strong>entry_name</strong> is tested, if icon doesn&#8217;t exist, script looks for one with
<strong>executable_name</strong>.</p></div>
<div class="paragraph"><p>Icon directories can be specified using <strong>--search-icons-in</strong> option. You can specify more than one directory by separating them using : (colon) sign.</p></div>
<div class="paragraph"><p>There are two special file names:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>directory.png</strong>
</dt>
<dd>
<div class="paragraph"><p>is used for the <strong>categories</strong> which doesn&#8217;t have their own icon (it was not
found by the generator in specified directory). You can specify your own name
using <strong>--default-dir-icon</strong> option. For example:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>ImagePath $[FVWM_USERDIR]/icons/
fvwm-crystal.apps --search-icons-in=$[FVWM_USERDIR]/icons/ \
--default-dir-icon=22x22/dir.png</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><code>Result: &lt;ImagePath&gt;22x22/dir.png</code></pre>
</div></div>
</dd>
<dt class="hdlist1">
<strong>default.png</strong>
</dt>
<dd>
<div class="paragraph"><p>is used for applications which doesn&#8217;t have their own icon. You can use
<strong>--default-file-icon</strong> to change the name, in the same way
  <strong>--default-dir-icon</strong> can be used.</p></div>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="_panel_menu_generator">Panel/menu generator</h3>
<div class="paragraph"><p>Here I will describe some example uses of the generator, if you want to see complete list of commandline options, you can use command:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>fvwm-crystal.apps --help | less</code></pre>
</div></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>Creating panels</strong>
</dt>
<dd>
<div class="paragraph"><p>Generator doesn&#8217;t create all panel options specified in <strong>man FvwmButtons</strong>,
just the button themselves. Therefore you can use FVWM configuration to decide
how the resulting panel will look and where it will be placed. For example,
you can create panels with swallowed windows and application buttons, by
putting PipeRead command with <strong>fvwm-crystal.apps</strong> in between the panel configuration, like this:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>*SomePanel: (1x1, Swallow FvwmPager)
PipeRead 'fvwm-crystal.apps --database=/some/base \
        --panel-name="SomePanel"'
*SomePanel: (1x1, Swallow xclock)</code></pre>
</div></div>
<div class="paragraph"><p>You can make application panels which will open app menus, with different icon size on the panel and in the menu (big on the panel, small in the menu), by using generator several times with different options. For example:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>PipeRead 'fvwm-crystal.apps --database=/some/base \
        --panel-action1=menu --search-icons-in=/icons/32x32/apps \
        --no-menus'
PipeRead 'fvwm-crystal.apps --database=/some/base \
        --search-icons-in=/icons/22x22/apps --no-panel'</code></pre>
</div></div>
</dd>
</dl></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_todo">TODO</h2>
<div class="sectionbody">
<div class="paragraph"><p>Add more examples here&#8230;</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_authors">AUTHORS</h2>
<div class="sectionbody">
<div class="paragraph"><p>Documentation written by Maciej Delmanowski &lt;<a href="mailto:harnir@berlios.de">harnir@berlios.de</a>&gt;
and ported to asciidoc by Dominique Michel</p></div>
<div class="paragraph"><p>fvwm-crystal.apps &#169; 2005 by Rafal Bisingier
bugfixes 2008-2013 by Dominique Michel</p></div>
<div class="paragraph"><p>fvwm-crystal.generate-menu &#169; 2008-2015 by Dominique Michel
&lt;<a href="mailto:dominique_libre@users.sourceforge.org">dominique_libre@users.sourceforge.org</a>&gt;</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_copyright">COPYRIGHT</h2>
<div class="sectionbody">
<div class="paragraph"><p><strong>FVWM-Crystal</strong> and all the scripts and other files coming with
the distribution are subject to the GNU General Public License (GPL).
Please refer to the COPYING file that came with <strong>FVWM-Crystal</strong> for details.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_bugs">BUGS</h2>
<div class="sectionbody">
<div class="paragraph"><p>Bug reports can be sent to the fvwm-crystal-users mailing list at
<a href="https://mail.gna.org/listinfo/fvwm-crystal-users/">https://mail.gna.org/listinfo/fvwm-crystal-users/</a>.</p></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2015-11-01 23:20:07 CET
</div>
</div>
</body>
</html>