Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

gsettings (1)

Name

gsettings - GSettings configuration tool

Synopsis

gsettings get SCHEMA [:PATH]  KEY

gsettings monitor SCHEMA [:PATH]  [KEY]

gsettings writable SCHEMA [:PATH]  KEY

gsettings range SCHEMA [:PATH]  KEY

gsettings describe SCHEMA [:PATH]  KEY

gsettings set SCHEMA [:PATH]  KEY VALUE

gsettings reset SCHEMA [:PATH]  KEY

gsettings reset-recursively SCHEMA [:PATH]

gsettings list-schemas [--print-paths]

gsettings list-relocatable-schemas

gsettings list-keys SCHEMA [:PATH]

gsettings list-children SCHEMA [:PATH]

gsettings list-recursively [SCHEMA [:PATH]]

gsettings help [COMMAND]

Description

GSETTINGS(1)                     User Commands                    GSETTINGS(1)



NAME
       gsettings - GSettings configuration tool

SYNOPSIS
       gsettings get SCHEMA [:PATH]  KEY

       gsettings monitor SCHEMA [:PATH]  [KEY]

       gsettings writable SCHEMA [:PATH]  KEY

       gsettings range SCHEMA [:PATH]  KEY

       gsettings describe SCHEMA [:PATH]  KEY

       gsettings set SCHEMA [:PATH]  KEY VALUE

       gsettings reset SCHEMA [:PATH]  KEY

       gsettings reset-recursively SCHEMA [:PATH]

       gsettings list-schemas [--print-paths]

       gsettings list-relocatable-schemas

       gsettings list-keys SCHEMA [:PATH]

       gsettings list-children SCHEMA [:PATH]

       gsettings list-recursively [SCHEMA [:PATH]]

       gsettings help [COMMAND]

DESCRIPTION
       gsettings offers a simple commandline interface to GSettings. It lets
       you get, set or monitor an individual key for changes.

       The SCHEMA and KEY arguments are required for most commands to specify
       the schema id and the name of the key to operate on. The schema id may
       optionally have a :PATH suffix. Specifying the path is only needed if
       the schema does not have a fixed path.

       When setting a key, you also need specify a VALUE The format for the
       value is that of a serialized GVariant, so e.g. a string must include
       explicit quotes: "'foo'". This format is also used when printing out
       values.

       Note that gsettings needs a D-Bus session bus connection to write
       changes to the dconf database.

COMMANDS
       get
           Gets the value of KEY. The value is printed out as a serialized
           GVariant.

       monitor
           Monitors KEY for changes and prints the changed values. If no KEY
           is specified, all keys in the schema are monitored. Monitoring will
           continue until the process is terminated.

       writable
           Finds out whether KEY is writable.

       range
           Queries the range of valid values for KEY.

       describe
           Queries the description of valid values for KEY.

       set
           Sets the value of KEY to VALUE. The value is specified as a
           serialized GVariant.

       reset
           Resets KEY to its default value.

       reset-recursively
           Reset all keys under the given SCHEMA.

       list-schemas
           Lists the installed, non-relocatable schemas. See
           list-relocatable-schemas if you are interested in relocatable
           schemas. If [--print-paths] is given, the path where each schema is
           mapped is also printed.

       list-relocatable-schemas
           Lists the installed, relocatable schemas. See list-schemas if you
           are interested in non-relocatable schemas.

       list-keys
           Lists the keys in SCHEMA.

       list-children
           Lists the children of SCHEMA.

       list-recursively
           Lists keys and values, recursively. If no SCHEMA is given, list
           keys in all schemas.

       help
           Prints help and exits.



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/glib2    |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       https://download.gnome.org/sources/glib/2.70/glib-2.70.5.tar.xz.

       Further information about this software can be found on the open source
       community website at https://wiki.gnome.org/Projects/GLib/.



GIO                                                               GSETTINGS(1)