Skip to content

Latest commit

 

History

History
76 lines (45 loc) · 1.89 KB

holorc.5.pod

File metadata and controls

76 lines (45 loc) · 1.89 KB
Raw

NAME

holorc, holorc.d - configuration file for holo(8)

SYNOPSIS

$HOLO_ROOT_DIR/etc/holorc

$HOLO_ROOT_DIR/etc/holorc.d/*

DESCRIPTION

The holorc file defines which plugins will be loaded and used by Holo, and in which order. Blank lines, and comment lines starting with a # character are ignored.

Non-blank and non-comment lines can be of one of two forms:

plugin $PLUGIN_ID
plugin $PLUGIN_ID=$PLUGIN_BINARY

where $PLUGIN_ID is the alphanumeric identifier of the plugin, and $PLUGIN_BINARY is the path to the plugin executable file. If the form without an explicit $PLUGIN_BINARY is given, then Holo will use a default value of

PLUGIN_BINARY=/usr/lib/holo/holo-$PLUGIN_ID

The plugin identifier is encoded in several paths that are relevant for the plugin:

/usr/lib/holo/holo-$PLUGIN_ID

Unless $PLUGIN_BINARY is explicitly specified, this is plugin executable is installed at.

$HOLO_ROOT_DIR/usr/share/holo/$PLUGIN_ID/

Configuration packages install resources for this plugin below this directory.

$HOLO_ROOT_DIR/var/lib/holo/$PLUGIN_ID/

The plugin stores its persistent state at in the directory.

The holorc file can also be provided as snippets in /etc/holorc.d/*. Snippets will be parsed in alphabetical order, before the actual /etc/holorc is parsed.

BEST PRACTICES

Plugins are encouraged to add themselves to /etc/holorc at install time by installing a holorc snippet. For example:

$ cat /etc/holorc.d/20-users-groups
# This file is part of the holo-users-groups package.
plugin users-groups

SEE ALSO

holo(8), holo-plugin-interface(7)

AUTHOR

Stefan Majewsky

Further documentation is available at the project homepage: http://holocm.org

Please report any issues and feature requests at GitHub: http://github.com/holocm/holo/issues