README-GCONF

   1 Deprecating GConf
   2 =================
   3
   4  Gnome is deprecating GConf in favour of GSettings. This is the short
   5  story. We so have to migrate several pool of datas.
   6
   7  Starting with 3.1.0, Nautilus-Actions has been distributed with the
   8  needed migration tools, whether the migration may occur automatically
   9  (for users items and preferences), or the system admin must run a
  10  script (for mandatory items).
  11
  12  Note that this does not break backward compatibility. The 3.1.x serie
  13  of Nautilus-Actions may still be run on a "old" platform. The oldest
  14  supported as of January 2011 was Ubuntu 8 LTS.
  15
  16  See README for the oldest supported platforms for the current version.
  17
  18  1. Items, menus and actions, stored in GConf backend
  19  ----------------------------------------------------
  20  Historically, actions, then menus, were stored in GConf. These are user
  21  items.
  22
  23  A system admin was free to define mandatory menus and actions, and to
  24  store them in the Mandatory pool of GConf. Such defined items are so
  25  available to all users, though as read-only items.
  26
  27    1a. Migrating user items
  28    ------------------------
  29    The good news is:
  30    user items are automatically migrated from GConf to .desktop files.
  31
  32    The migration happens when the user runs the FileManager-Actions
  33    Configuration Tool user interface, or when the FileManager-Actions
  34    menu plugin is loaded by the file-manager, or when the user runs one
  35    of the command-line tools fma-new or fma-run.
  36
  37    The fma-print command-line tool, along with fma-delete-xmltree,
  38    and fma-print-schemas installed in PKGLIBEXECDIR, have no effect on
  39    the migration process.
  40
  41    The new .desktop files are stored in HOME/.local/file-manager/actions.
  42
  43    When the migration of its items has occurred, the GConf I/O Provider
  44    is disabled, for both reading and writing.
  45
  46    1b. Migrating mandatory items
  47    -----------------------------
  48    The bad news is:
  49    the system admin has to manually run PKGLIBEXECDIR/fma-gconf2key.sh
  50    script as root in order to migrate existing mandatory items to
  51    .desktop files.
  52
  53    The new .desktop files default to be stored in /usr/share/file-manager/actions.
  54
  55    It is enough to run this script once, e.g. when installing for the
  56    first time a recent enough version (>= 3.1.0) of FileManager-Actions.
  57
  58    Command-line example:
  59    # /usr/libexec/file-manager-actions/fma-gconf2key.sh -delete -nodummy
  60
  61  2. User preferences stored in GConf
  62  -----------------------------------
  63  Mandatory and user preferences follow the same migration rules that
  64  items:
  65
  66  - user preferences are automatically migrated,
  67  - mandatory preferences have to be manually migrated by the system
  68    admin.
  69
  70  Preferences are renamed and reorganized:
  71
  72  GConf                                      Group      Key
  73  -----------------------------------------  ------     --------------------------------------
  74  add-capability-dialog = [720,263,384,246]  [nact]     capability-add-capability-wsp
  75  add-scheme-dialog = [720,263,352,271]      [nact]     scheme-add-scheme-wsp
  76  assistant-esc-confirm = true               [nact]     assistant-esc-confirm
  77  assistant-esc-quit = true                  [nact]     assistant-esc-quit
  78  auto-save-on = false                       [nact]     main-save-auto
  79  auto-save-period = 5                       [nact]     main-save-period
  80  export-assistant = [377,33,699,675]        [nact]     export-assistant-wsp
  81  export-ask-user = [377,33,699,675]         [nact]     export-ask-user-wsp
  82  export-ask-user-last-format = GConfEntry   [nact]     export-ask-user-last-format
  83                                             [nact]     export-ask-user-keep-last-choice
  84  export-folder-uri = file:///home/pierre..  [nact]     export-assistant-lfu
  85  export-format = Ask                        [nact]     export-preferred-format
  86  icommand-command-chooser                   [nact]     command-command-chooser-wsp
  87  icommand-folder-uri                        [nact]     command-command-chooser-lfu
  88  icommand-legend-dialog = [673,94,474,480]  [nact]     command-legend-wsp
  89  icommand-working-dir-dialog                [nact]     command-working-dir-chooser-wsp
  90  icommand-working-dir-uri = file:///home..  [nact]     command-working-dir-chooser-lfu
  91  icons-chooser = [425,124,839,539]          [nact]     item-icon-chooser-wsp
  92  icons-path = file:///usr/share/icons/hi..  [nact]     item-icon-chooser-last-file-uri
  93  ienvironment-show-if-running-dialog = [..  [nact]     environment-show-if-running-wsp
  94  ienvironment-show-if-running-uri = file..  [nact]     environment-show-if-running-lfu
  95  ienvironment-try-exec-dialog = [327,70,..  [nact]     environment-try-exec-wsp
  96  ienvironment-try-exec-uri = file:///bin    [nact]     environment-try-exec-lfu
  97  ifolders-chooser = [418,86,632,573]        [nact]     folder-chooser-wsp
  98  ifolders-path = /home/pierre/data/Pictures [nact]     folder-chooser-lfu
  99  import-ask-user                            [nact]     import-ask-user-wsp
 100  import-ask-user-last-mode                  [nact]     import-ask-user-last-mode
 101  import-assistant                           [nact]     import-assistant-wsp
 102  import-folder-uri                          [nact]     import-assistant-lfu
 103  import-keep-choice                         [nact]     import-ask-user-keep-last-choice
 104  import-mode = NoImport                     [nact]     import-preferred-mode
 105  io-providers-order = [..]                  [nact]     io-providers-write-order
 106  iprefs-add-about-item = true               [runtime]  items-add-about-item
 107  iprefs-alphabetical-order = ManualOrder    [runtime]  items-list-order-mode
 108  iprefs-create-root-menu = false            [runtime]  items-create-root-menu
 109  iprefs-level-zero = [my-first-na-menu,a1-mandatory2-action3,a-gconf-action]
 110                                             [runtime]  items-level-zero-order
 111  iprefs-relabel-actions = false             [nact]     relabel-when-duplicate-action
 112  iprefs-relabel-menus = false               [nact]     relabel-when-duplicate-menu
 113  iprefs-relabel-profiles = false            [nact]     relabel-when-duplicate-profile
 114  main-edit-toolbar = true                   [nact]     main-toolbar-edit-display
 115  main-file-toolbar = true                   [nact]     main-toolbar-file-display
 116  main-help-toolbar = true                   [nact]     main-toolbar-help-display
 117  main-paned = 211                           [nact]     main-paned-width
 118  main-window = [319,95,901,533]             [nact]     main-window-size
 119  preferences-editor = [548,218,497,392]     [nact]     preferences-wsp
 120  schemes = [dav|WebDAV files,file|Local files,ftp|FTP files,sftp|SSH files,smb|Windows files]
 121                                             [nact]     scheme-default-list
 122
 123  User preferences for I/O providers were stored as
 124  /apps/nautilus-actions/io-providers/<provider_id> keys. They are moved
 125  to [io-provider <provider_id>] group.
 126
 127  GConf                                                 Key
 128  -----------------------------------------             --------------------------------------
 129  read-at-startup                                       readable
 130  writable                                              writable
 131
 132  3. Sysadmin reserved mandatory keys
 133  -----------------------------------
 134  These were
 135    /apps/nautilus-actions/mandatory/
 136      all/locked
 137      na-desktop/locked
 138      na-gconf/locked
 139
 140  These keys are just ignored if they are not in the mandatory GConf
 141  pool, i.e. if they happens to be eventually editable by the user.
 142
 143  If these keys are actually in the system mandatory GConf pool, they
 144  are renamed in the following way:
 145
 146  GConf                                      Group      Key
 147  -----------------------------------------  ------     --------------------------------------
 148  /apps/nautilus-actions/mandatory/all/locked
 149                                             [nact]     preferences-locked
 150                                             [runtime]  io-providers-locked
 151
 152  /apps/nautilus-actions/mandatory/na-desktop/locked    <removed>
 153  /apps/nautilus-actions/mandatory/na-gconf/locked      <removed>
 154
 155 P. Wieser, last updated on sept. 2015