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