docs/reference/Makefile.am: fix version.dir.xml generation
[nautilus-actions.git] / README
blobc8115c7b377b504fdb114e65ceb97ae4175a9c38
1 FileManager-Actions
3   Nautilus-actions is an extension for Nautilus file manager which
4   allows the user to add arbitrary program to be launched through the
5   Nautilus file manager popup menu of selected files.
7 FileManager-Actions components.
9   FileManager-Actions has three sort of components:
11   - A user interface, nautilus-actions-config-tool (NACT), which let you
12     manage your actions. With NACT, you are able to create, modify and
13     delete actions, to define menus and submenus, to order and reorder
14     items.
15     Import/export functions are also managed via NACT.
17   - Nautilus extensions as dynamically loadable plugins. These extensions
18     are automatically loaded by Nautilus when it starts. For now, two
19     extensions are provided:
20     . libnautilus-actions-menu.so is a plugin which takes care of displaying
21       actions in Nautilus context menus;
22     . libnautilus-actions-tracker.so is a plugin which tracks the current
23       Nautilus selection, and sends it in response to a DBus request. 
25   - Command-line utilities:
26     a) installed in PREFIX/bin:
27        . nautilus-actions-new lets you create new actions from the command-line;
28        . nautilus-actions-run lets you execute a predefined action, taking
29          into account the current Nautilus selection via a DBus call to the
30          libnautilus-actions-tracker plugin;
31     b) installed in PKGLIBEXECDIR:
32        . na-print-schemas prints the full GConf schemas on stdout;
33        . na-delete-xmltree deletes a tree from a XML file;
34        . na-gconf2keys.sh migrates menus, actions and user preferences from
35          GConf to files.
37 FileManager-Actions plugins.
39   I/O Providers.
41     FileManager-Actions itself uses plugins to load menus and actions from
42     the storage space. These plugins are installed in PKGLIBDIR, usually
43     something as /usr/lib/nautilus-actions/.
45     Starting with 3.0.2, the preferred default I/O provider is 'na-desktop',
46     which means that newly created actions and menus will be stored on
47     disk as .desktop files, in accordance with DES-EMA specification [1].
49   Importers/Exporters.
51     FileManager-Actions also relies on plugins to import actions and menus,
52     and to export them, in several formats.
53     For now, FileManager-Actions is able to import/export its items as:
54     . GConf schemas;
55     . GConf dump;
56     . XML;
57     . .desktop files.
59 FileManager-Actions documentation.
61   Documentation is provided in several formats:
62   - developer documentation is provided as xml and html files, as generated
63     by gtk-doc;
64   - NACT user's manuals and general documentation is provided as xml, pdf
65     and html files, as generated by gnome-doc-utils, docbook-utils or dblatex
66     tools.
68 [1] http://www.nautilus-actions.org/?q=node/377