From efd6734acd779898ee52ac30550fd7ec833430b2 Mon Sep 17 00:00:00 2001 From: Brent Smith Date: Sun, 19 Feb 2006 20:34:56 +0000 Subject: convert the Command Line Options table to a variable list, and changed 2006-02-19 Brent Smith * gconf.xml: convert the Command Line Options table to a variable list, and changed examples to use instead of so that the commands are not justified (which makes them hard to read) --- gnome2-system-admin-guide/C/ChangeLog | 7 + gnome2-system-admin-guide/C/gconf.xml | 750 +++++++++++++++------------------- 2 files changed, 335 insertions(+), 422 deletions(-) (limited to 'gnome2-system-admin-guide') diff --git a/gnome2-system-admin-guide/C/ChangeLog b/gnome2-system-admin-guide/C/ChangeLog index e30385b..cfef1b6 100644 --- a/gnome2-system-admin-guide/C/ChangeLog +++ b/gnome2-system-admin-guide/C/ChangeLog @@ -1,3 +1,10 @@ +2006-02-19 Brent Smith + + * gconf.xml: + convert the Command Line Options table to a variable list, and changed + examples to use instead of so that the commands + are not justified (which makes them hard to read) + 2006-02-15 Brent Smith * gconf.xml: diff --git a/gnome2-system-admin-guide/C/gconf.xml b/gnome2-system-admin-guide/C/gconf.xml index 0f848a8..6dc86a8 100644 --- a/gnome2-system-admin-guide/C/gconf.xml +++ b/gnome2-system-admin-guide/C/gconf.xml @@ -488,6 +488,7 @@ command: + GConf Command Line Tool gconftool-2 @@ -513,337 +514,274 @@ an application. For example, use the following command to display the values of all keys in the /desktop/gnome directory and subdirectories. - - # - gconftool-2 --recursive-list -/desktop/gnome - - lists some of the options that you can -use with the gconftool-2 command. - + # gconftool-2 --recursive-list /desktop/gnome + Below are listed some of the options that you can +use with the gconftool-2 command. For detailed command line options, +please see man:gconftool-2(1). + gconftool-2 Command Options - - - - - - - Option - - - Function - - - - - - - - --all-dirs - - - - Lists all subdirectories in a -directory that you specify. - - - - - - --all-entries - - - - Displays the values of all keys -in a directory that you specify. - - - - - - --config-source=configuration-source - - - - Use this option with the --direct option -to specify a configuration source to use. If you do not specify a configuration -source with this option, the command runs on all configuration sources in -the path file. - - - - - - --direct - - - - Use this option with the --config-source option to access a configuration source directly. -When you use this option, GConf bypasses the server. -Ensure that the GConf daemon, gconfd-2, is not running before you use this option. - - - - - - --dump - - - - Generates a list that contains all preference -keys in a GConf repository directory that you specify. -The list contains XML descriptions of all the keys. The list is contained -in a <gconfentryfile> element. - For example, -you can redirect the output from this option to generate a file that lists -all keys that are related to your panel configuration. You can use the --load option with this file. - - - - - - --get - - - - Displays the value of a preference key that you specify. -Also displays the values of the elements in the schema object for a schema -key that you specify. - - - - - - --help - - - - Displays a help message about the gconftool-2 command, and the options that you can use with the gconftool-2 command. - - - - - - --load=filename - - - - Use this option to sets the values of preference keys in the current directory -in a configuration source to the values in the file that you specify. The -file that you specify must contain XML descriptions of the keys, in a <gconfentryfile> element. - - - - - - --long-desc=description - - - - Use this option with the --set-schema -option to specify a long description for a schema key. - - - - - - --makefile-install-rule - - - - Installs schema definition files to applications. - - - - - - --owner=owner - - - - Use this option with the --set-schema option to specify -an owner for a schema key. - - - - - - --recursive-list - - - - Displays the values of all preference keys in all -subdirectories in a directory that you specify. - - - - + + + --all-dirs + + + Lists all subdirectories in a + directory that you specify. + + + + + --all-entries + + + Displays the values of all keys + in a directory that you specify. + + + + + --config-source=configuration-source + + + Use this option with the --direct option + to specify a configuration source to use. If you do not specify a configuration + source with this option, the command runs on all configuration sources in + the path file. + + + + + --direct + + + Use this option with the --config-source option to access a configuration source directly. + When you use this option, GConf bypasses the server. + Ensure that the GConf daemon, gconfd-2, is not running before you use this option. + + + + + --dump + + + Generates a list that contains all preference + keys in a GConf repository directory that you specify. + The list contains XML descriptions of all the keys. The list is contained + in a <gconfentryfile> element. + For example, + you can redirect the output from this option to generate a file that lists + all keys that are related to your panel configuration. You can use the --load option with this file. + + + + + --get + + + Displays the value of a preference key that you specify. + Also displays the values of the elements in the schema object for a schema + key that you specify. + + + + + --help + + + Displays a help message about the gconftool-2 command, and the options that you can use with the gconftool-2 command. + + + + + --load=filename + + + Use this option to sets the values of preference keys in the current directory + in a configuration source to the values in the file that you specify. The + file that you specify must contain XML descriptions of the keys, in a <gconfentryfile> element. + + + + + --long-desc=description + + + Use this option with the --set-schema + option to specify a long description for a schema key. + + + + + --makefile-install-rule + + + Installs schema definition files to applications. + + + + + --owner=owner + + + Use this option with the --set-schema option to specify + an owner for a schema key. + + + + + --recursive-list + + + Displays the values of all preference keys in all + subdirectories in a directory that you specify. + + + + + --recursive-unset + + + Resets + the values of all preference keys, in all subdirectories in a directory, from + the user setting to the setting in the default configuration source. + + + + + --set + + + Sets the value of a preference key, and writes the value + to the user configuration source. Use the --type option + with the --set option to specify the data type of the value + that you want to set. For example, the following command sets the value of + the /apps/gnome-terminal/profiles/Default/background_color + key in the user configuration source: + # gconftool-2 \ + --set "/apps/gnome-terminal/profiles/Default/background_color" \ + --type string "#000000" + You can also use the --direct option and the --config-source option + with the --set option to write a value to another configuration + source. + + + + + --set-schema + + + Sets the value of an attribute + in a schema key, and writes the value to the default configuration source. + Use the following options with the --set-schema + option to specify the attribute that you want to update: + + - --recursive-unset + --type - - - Resets -the values of all preference keys, in all subdirectories in a directory, from -the user setting to the setting in the default configuration source. - - - - + + - --set + --short-desc - - - Sets the value of a preference key, and writes the value -to the user configuration source. Use the --type option -with the --set option to specify the data type of the value -that you want to set. For example, the following command sets the value of -the /apps/gnome-terminal/profiles/Default/background_color -key in the user configuration source: + + - # - gconftool-2 --set "/apps/gnome-terminal/profiles/Default/background_color" ---type string "#000000" + --long-desc - You can also use the --direct option and the --config-source option -with the --set option to write a value to another configuration -source. - - - - + + - --set-schema + --owner - - - Sets the value of an attribute -in a schema key, and writes the value to the default configuration source. - Use the following options with the --set-schema -option to specify the attribute that you want to update: - - - - --type - - - - - --short-desc - - - - - --long-desc - - - - - --owner - - - - For example, the following command sets the short description -in the schema key for the /apps/gnome-terminal/profiles/Default/background_color key: + + + For example, the following command sets the short description + in the schema key for the /apps/gnome-terminal/profiles/Default/background_color key: + # gconftool-2 \ + --set-schema "/schemas/apps/gnome-terminal/profiles/Default/background_color" \ + --short-desc "Default background color of terminal" + + + + + --short-desc=description + + + Use this option with the --set-schema + option to specify a short description for a schema key. + + + + + --shutdown + + + Terminates the GConf daemon. + + + + + --type=data-type + + + Use this option to specify the data type when you set a + value of a preference key. You can also use this option when you set the value + of an attribute in a schema key. The following is a list of valid data types: + + - # - gconftool-2 --set-schema "/schemas/apps/gnome-terminal/profiles/Default/background_color" ---short-desc "Default background color of terminal" + bool - - - - + + - --short-desc=description + float - - - Use this option with the --set-schema -option to specify a short description for a schema key. - - - - + + - --shutdown + int - - - Terminates the GConf daemon. - - - - + + - --type=data-type + list - - - Use this option to specify the data type when you set a -value of a preference key. You can also use this option when you set the value -of an attribute in a schema key. The following is a list of valid data types: - - - - bool - - - - - float - - - - - int - - - - - list - - - - - pair - - - - - string - - - - - - - + + - --unset + pair - - - Resets the value of a preference -key from the user setting to the setting in the default configuration source. - - - - + + - --usage + string - - - Displays a brief help message -about the gconftool-2 command, and the options that you -can use with the gconftool-2 command. - - - - -
+ + + + + + + --unset + + + Resets the value of a preference + key from the user setting to the setting in the default configuration source. + + + + + --usage + + + Displays a brief help message + about the gconftool-2 command, and the options that you + can use with the gconftool-2 command. + + + To Set Preference Values @@ -862,29 +800,24 @@ values or default preference values for users, you must ensure that the To set a mandatory value or a default value for a preference key, use the gconftool-2 command, as follows: - - # - gconftool-2 --direct --config-source configuration-source --type data-type ---set preference-keyvalue - + # gconftool-2 --direct \ + --config-source configuration-source \ + --type data-type \ + --set preference-key value For example, to set wwwproxy.xyz.com as the mandatory HTTP proxy host, run the following command: - - # - gconftool-2 --direct --config-source -xml:readwrite:/etc/gconf/gconf.xml.mandatory --type string --set /system/http_proxy/host -wwwproxy.xyz.com - + # gconftool-2 --direct \ + --config-source xml:readwrite:/etc/gconf/gconf.xml.mandatory \ + --type string \ + --set /system/http_proxy/host wwwproxy.xyz.com The user cannot override this preference value. You can also use the gconftool-2 command to set default values. For example, to set the default number of workspaces to five, run the following command: - - # - gconftool-2 --direct --config-source -xml:readwrite:/etc/gconf/gconf.xml.defaults --type int --set /apps/metacity/general/num_workspaces -5 - + # gconftool-2 --direct \ + --config-source xml:readwrite:/etc/gconf/gconf.xml.defaults \ + --type int \ + --set /apps/metacity/general/num_workspaces 5 The user can override this preference value. Before you change mandatory preference values or default preference @@ -910,17 +843,15 @@ GConf the values of the preference keys in the /system/http_proxy/ location. For example, to set a mandatory value for the HTTP proxy host, run the following command: - - # - gconftool-2 --direct --config-source -xml:readwrite:/etc/gconf/gconf.xml.mandatory --type string --set /system/http_proxy/host proxy-name - + # gconftool-2 --direct \ + --config-source xml:readwrite:/etc/gconf/gconf.xml.mandatory \ + --type string \ + --set /system/http_proxy/host proxy-name To set a default value for the HTTP proxy host, run the following command: - - # - gconftool-2 --direct --config-source -xml:readwrite:/etc/gconf/gconf.xml.defaults --type string --set /system/http_proxy/host proxy-name - + # gconftool-2 --direct \ + --config-source xml:readwrite:/etc/gconf/gconf.xml.defaults \ + --type string \ + --set /system/http_proxy/host proxy-name You can also set other HTTP proxy-related preferences. For information on the other HTTP proxy preferences, see the system_http_proxy.schemas schema definition file. @@ -939,18 +870,15 @@ value as follows: setting with GConf - - # - gconftool-2 --direct --config-source xml:readwrite:/etc/gconf/gconf.xml.mandatory ---type bool --set /apps/gnome-print-manager/show_all_jobs false - + # gconftool-2 --direct \ + --config-source xml:readwrite:/etc/gconf/gconf.xml.mandatory \ + --type bool \ + --set /apps/gnome-print-manager/show_all_jobs false To set a default value for this preference, run the following command: - - # - gconftool-2 --direct --config-source -xml:readwrite:/etc/gconf/gconf.xml.defaults --type bool --set /apps/gnome-print-manager/show_all_jobs -false - + # gconftool-2 --direct \ + --config-source xml:readwrite:/etc/gconf/gconf.xml.defaults \ + --type bool \ + --set /apps/gnome-print-manager/show_all_jobs false You can also set other print manager preferences. For information on the other print manager preferences, see the gnome-print-manager.schemas schema definition file. @@ -967,17 +895,15 @@ the other print manager preferences, see the gnome-print-manager.schem To set a mandatory number of workspaces, use the following command: - - # - gconftool-2 --direct --config-source -xml:readwrite:/etc/gconf/gconf.xml.mandatory --type int --set /apps/metacity/general/num_workspaces integer - + # gconftool-2 --direct \ + --config-source xml:readwrite:/etc/gconf/gconf.xml.mandatory \ + --type int \ + --set /apps/metacity/general/num_workspaces integer To set a default number of workspaces, use the following command: - - # - gconftool-2 --direct --config-source -xml:readwrite:/etc/gconf/gconf.xml.defaults --type int --set /apps/metacity/general/num_workspaces integer - + # gconftool-2 --direct \ + --config-source xml:readwrite:/etc/gconf/gconf.xml.defaults \ + --type int \ + --set /apps/metacity/general/num_workspaces integer You can also set other window manager preferences. For information on the other window manager preferences, see the metacity.schemas schema definition file. @@ -996,19 +922,15 @@ schema definition file. keys in the /desktop/gnome/accessibility/keyboard location. For example, if you want to set a mandatory value so that keyboard accessibility features are enabled, run the following command: - - # - gconftool-2 --direct --config-source -xml:readwrite:/etc/gconf/gconf.xml.mandatory --type bool --set /desktop/gnome/accessibility/keyboard/enable -true - + # gconftool-2 --direct \ + --config-source xml:readwrite:/etc/gconf/gconf.xml.mandatory \ + --type bool \ + --set /desktop/gnome/accessibility/keyboard/enable true To set a default value for this preference, run the following command: - - # - gconftool-2 --direct --config-source -xml:readwrite:/etc/gconf/gconf.xml.defaults --type bool --set /desktop/gnome/accessibility/keyboard/enable -false - + # gconftool-2 --direct \ + --config-source xml:readwrite:/etc/gconf/gconf.xml.defaults \ + --type bool \ + --set /desktop/gnome/accessibility/keyboard/enable false You can also set other keyboard accessibility preferences. For information on the other keyboard accessibility preferences, see the desktop_gnome_accessibility_keyboard.schemas schema definition file. @@ -1027,12 +949,10 @@ keyboard shortcut preferences, you modify the values of preference keys in AltF3 keyboard shortcut to open the Run Application dialog. To set this mandatory value, run the following command: - - # - gconftool-2 --direct --config-source -xml:readwrite:/etc/gconf/gconf.xml.mandatory --type string --set /apps/metacity/global_keybindings -'<Alt>F3' - + # gconftool-2 --direct \ + --config-source xml:readwrite:/etc/gconf/gconf.xml.mandatory \ + --type string \ + --set /apps/metacity/global_keybindings '<Alt>F3' You can also set other keyboard shortcut preferences. For information on the other keyboard shortcut preferences, see the metacity.schemas schema definition file. @@ -1227,11 +1147,8 @@ XML description of your panel configuration. The --dump option generates a list that contains all preference keys in a GConf repository directory that you specify. For example, the following command creates an XML description of the default panel configuration in a file called my-panel-setup.entries: - - # - gconftool-2 --dump /apps/panel -> my-panel-setup.entries - + # gconftool-2 --dump /apps/panel > my-panel-setup.entries Open the my-panel-setup.entries file @@ -1260,11 +1177,9 @@ the right_stick key to true. source to the values in the my-panel-setup.entries file. For example, the following command sets the values of the keys in the default configuration source to the values of the corresponding keys in my-panel-setup.entries: - - # - gconftool-2 --direct --config-source -xml:readwrite:/etc/gconf/gconf.xml.defaults --load my-panel-setup.entries - + # gconftool-2 --direct \ + --config-source xml:readwrite:/etc/gconf/gconf.xml.defaults \ + --load my-panel-setup.entries @@ -1324,19 +1239,17 @@ Interface Component For example, to set Sans 12 as the mandatory application font, run the following command: - - # - gconftool-2 --direct --config-source -xml:readwrite:/etc/gconf/gconf.xml.mandatory --type string --set /desktop/gnome/interface/font_name "Sans 12" - + # gconftool-2 --direct \ + --config-source xml:readwrite:/etc/gconf/gconf.xml.mandatory \ + --type string \ + --set /desktop/gnome/interface/font_name "Sans 12" desktopfont preferences, setting with GConfTo set palatino 12 as the default desktop object font, run the following command: - - # - gconftool-2 --direct --config-source -xml:readwrite:/etc/gconf/gconf.xml.defaults --type string --set /apps/nautilus/preferences/desktop_font "palatino 12" - + # gconftool-2 --direct \ + --config-source xml:readwrite:/etc/gconf/gconf.xml.defaults \ + --type string \ + --set /apps/nautilus/preferences/desktop_font "palatino 12" To Set Background Preferences @@ -1352,17 +1265,15 @@ setting with GConf To set preferences for the desktop background, you modify the values of the preference keys in the /desktop/gnome/background location. For example, to set a mandatory image for the background, run the following command: - - # - gconftool-2 --direct --config-source -xml:readwrite:/etc/gconf/gconf.xml.mandatory --type string --set /desktop/gnome/background/picture_filename filename.png - + # gconftool-2 --direct \ + --config-source xml:readwrite:/etc/gconf/gconf.xml.mandatory \ + --type string \ + --set /desktop/gnome/background/picture_filename filename.png To set a default value for this preference, run the following command: - - # - gconftool-2 --direct --config-source -xml:readwrite:/etc/gconf/gconf.xml.defaults --type string --set /desktop/gnome/background/picture_filename filename.png - + # gconftool-2 --direct \ + --config-source xml:readwrite:/etc/gconf/gconf.xml.defaults \ + --type string \ + --set /desktop/gnome/background/picture_filename filename.png You can also set other background preferences. For information on the other background preferences, see the desktop_gnome_background.schemas schema definition file. @@ -1380,19 +1291,15 @@ with GConf To set splash image preferences, you modify the value of the preference keys in the /apps/gnome-session/options/ location. For example, if you do not want users ever to see a splash image, set a mandatory value as follows: - - # - gconftool-2 --direct --config-source -xml:readwrite:/etc/gconf/gconf.xml.mandatory --type bool --set /apps/gnome-session/options/show_splash_screen -false - + # gconftool-2 --direct \ + --config-source xml:readwrite:/etc/gconf/gconf.xml.mandatory \ + --type bool \ + --set /apps/gnome-session/options/show_splash_screen false To set a default value for this preference, run the following command: - - # - gconftool-2 --direct --config-source -xml:readwrite:/etc/gconf/gconf.xml.defaults --type bool --set /apps/gnome-session/options/show_splash_screen -false - + # gconftool-2 --direct \ + --config-source xml:readwrite:/etc/gconf/gconf.xml.defaults \ + --type bool \ + --set /apps/gnome-session/options/show_splash_screen false You can also set other splash image preferences. For information on the other splash image preferences, see the gnome-session.schemas schema definition file. @@ -1410,10 +1317,9 @@ values To restore the default preference values for a user, run the following command: - - # - gconftool-2 --direct --config-source user-configuration-source --recursive-unset - + # gconftool-2 --direct \ + --config-source user-configuration-source \ + --recursive-unset Replace user-configuration-source with the configuration source in the .gconf directory in the home directory of the user. -- cgit