nexmon – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 '\" t
2 .\" Title: gsettings
3 .\" Author: Ryan Lortie
4 .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5 .\" Date: 04/27/2016
6 .\" Manual: User Commands
7 .\" Source: GIO
8 .\" Language: English
9 .\"
10 .TH "GSETTINGS" "1" "" "GIO" "User Commands"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 gsettings \- GSettings configuration tool
32 .SH "SYNOPSIS"
33 .HP \w'\fBgsettings\fR\ 'u
34 \fBgsettings\fR get \fISCHEMA\fR\ [:\fIPATH\fR] \fIKEY\fR
35 .HP \w'\fBgsettings\fR\ 'u
36 \fBgsettings\fR monitor \fISCHEMA\fR\ [:\fIPATH\fR] [\fIKEY\fR]
37 .HP \w'\fBgsettings\fR\ 'u
38 \fBgsettings\fR writable \fISCHEMA\fR\ [:\fIPATH\fR] \fIKEY\fR
39 .HP \w'\fBgsettings\fR\ 'u
40 \fBgsettings\fR range \fISCHEMA\fR\ [:\fIPATH\fR] \fIKEY\fR
41 .HP \w'\fBgsettings\fR\ 'u
42 \fBgsettings\fR set \fISCHEMA\fR\ [:\fIPATH\fR] \fIKEY\fR \fIVALUE\fR
43 .HP \w'\fBgsettings\fR\ 'u
44 \fBgsettings\fR reset \fISCHEMA\fR\ [:\fIPATH\fR] \fIKEY\fR
45 .HP \w'\fBgsettings\fR\ 'u
46 \fBgsettings\fR reset\-recursively \fISCHEMA\fR\ [:\fIPATH\fR]
47 .HP \w'\fBgsettings\fR\ 'u
48 \fBgsettings\fR list\-schemas
49 .HP \w'\fBgsettings\fR\ 'u
50 \fBgsettings\fR list\-relocatable\-schemas
51 .HP \w'\fBgsettings\fR\ 'u
52 \fBgsettings\fR list\-keys \fISCHEMA\fR\ [:\fIPATH\fR]
53 .HP \w'\fBgsettings\fR\ 'u
54 \fBgsettings\fR list\-children \fISCHEMA\fR\ [:\fIPATH\fR]
55 .HP \w'\fBgsettings\fR\ 'u
56 \fBgsettings\fR list\-recursively [\fISCHEMA\fR\ [:\fIPATH\fR]]
57 .HP \w'\fBgsettings\fR\ 'u
58 \fBgsettings\fR help [\fICOMMAND\fR]
59 .SH "DESCRIPTION"
60 .PP
61 \fBgsettings\fR
62 offers a simple commandline interface to
63 \fBGSettings\fR\&. It lets you get, set or monitor an individual key for changes\&.
64 .PP
65 The
66 \fISCHEMA\fR
67 and
68 \fIKEY\fR
69 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 :\fIPATH\fR
70 suffix\&. Specifying the path is only needed if the schema does not have a fixed path\&.
71 .PP
72 When setting a key, you also need specify a
73 \fIVALUE\fR
74 The format for the value is that of a serialized
75 \fBGVariant\fR, so e\&.g\&. a string must include explicit quotes: "\*(Aqfoo\*(Aq"\&. This format is also used when printing out values\&.
76 .PP
77 Note that gsettings needs a D\-Bus session bus connection to write changes to the dconf database\&.
78 .SH "COMMANDS"
79 .PP
80 \fBget\fR
81 .RS 4
82 Gets the value of
83 \fIKEY\fR\&. The value is printed out as a serialised
84 \fBGVariant\fR\&.
85 .RE
86 .PP
87 \fBmonitor\fR
88 .RS 4
89 Monitors
90 \fIKEY\fR
91 for changes and prints the changed values\&. If no
92 \fIKEY\fR
93 is specified, all keys in the schema are monitored\&. Monitoring will continue until the process is terminated\&.
94 .RE
95 .PP
96 \fBwritable\fR
97 .RS 4
98 Finds out whether
99 \fIKEY\fR
100 is writable\&.
101 .RE
102 .PP
103 \fBrange\fR
104 .RS 4
105 Queries the range of valid values for
106 \fIKEY\fR\&.
107 .RE
108 .PP
109 \fBset\fR
110 .RS 4
111 Sets the value of
112 \fIKEY\fR
113 to
114 \fIVALUE\fR\&. The value is specified as a serialised
115 \fBGVariant\fR\&.
116 .RE
117 .PP
118 \fBreset\fR
119 .RS 4
120 Resets
121 \fIKEY\fR
122 to its default value\&.
123 .RE
124 .PP
125 \fBreset\-recursively\fR
126 .RS 4
127 Reset all keys under the given
128 \fISCHEMA\fR\&.
129 .RE
130 .PP
131 \fBlist\-schemas\fR
132 .RS 4
133 Lists the installed, non\-relocatable schemas\&. See
134 \fBlist\-relocatable\-schemas\fR
135 if you are interested in relocatable schemas\&.
136 .RE
137 .PP
138 \fBlist\-relocatable\-schemas\fR
139 .RS 4
140 Lists the installed, relocatable schemas\&. See
141 \fBlist\-schemas\fR
142 if you are interested in non\-relocatable schemas\&.
143 .RE
144 .PP
145 \fBlist\-keys\fR
146 .RS 4
147 Lists the keys in
148 \fISCHEMA\fR\&.
149 .RE
150 .PP
151 \fBlist\-children\fR
152 .RS 4
153 Lists the children of
154 \fISCHEMA\fR\&.
155 .RE
156 .PP
157 \fBlist\-recursively\fR
158 .RS 4
159 Lists keys and values, recursively\&. If no
160 \fISCHEMA\fR
161 is given, list keys in all schemas\&.
162 .RE
163 .PP
164 \fBhelp\fR
165 .RS 4
166 Prints help and exits\&.
167 .RE