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