summaryrefslogtreecommitdiff
path: root/docs/man/polkit.xml
blob: 26ca53c0389d8f8a7c1967e380014fd2e220d5d0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
<refentry id="PolicyKit-1.8">
  <refentryinfo>
    <title>polkit-1</title>
    <date>January 2009</date>
    <productname>PolicyKit-1</productname>
  </refentryinfo>

  <refmeta>
    <refentrytitle>polkit-1</refentrytitle>
    <manvolnum>1</manvolnum>
    <refmiscinfo class="version"></refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>polkit-1</refname>
    <refpurpose>PolicyKit Authorization Tool</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>polkit-1</command>
      <arg><option>--version</option></arg>
      <arg><option>--help</option></arg>
    </cmdsynopsis>

    <cmdsynopsis>
      <command>polkit-1 list</command>
      <group>
        <arg choice="plain">
          actions
          <arg><option>--verbose</option></arg>
        </arg>
        <arg choice="plain">
          <sbr/>
          users
          <arg><option>--verbose</option></arg>
        </arg>
        <arg choice="plain">
          <sbr/>
          groups
          <arg><option>--verbose</option></arg>
        </arg>
        <arg choice="plain">
          <sbr/>
          authorizations
        </arg>
        <arg choice="plain">
          <sbr/>
          explicit-authorizations <replaceable>subject</replaceable>
          <arg><option>--verbose</option></arg>
        </arg>
      </group>
    </cmdsynopsis>

    <cmdsynopsis>
      <command>polkit-1 check</command>
      <arg choice="plain"><replaceable>subject</replaceable></arg>
      <arg choice="plain"><replaceable>action-id</replaceable></arg>
    </cmdsynopsis>

    <cmdsynopsis>
      <command>polkit-1 grant</command>
      <arg choice="plain"><replaceable>subject</replaceable></arg>
      <arg choice="plain"><replaceable>action-id</replaceable></arg>
    </cmdsynopsis>

    <cmdsynopsis>
      <command>polkit-1 revoke</command>
      <arg choice="plain"><replaceable>subject</replaceable></arg>
      <arg choice="plain"><replaceable>action-id</replaceable></arg>
    </cmdsynopsis>

    <cmdsynopsis>
      <command>polkit-1 action</command>
      <arg choice="plain"><replaceable>action-id</replaceable></arg>
      <sbr/>
      <group>
        <arg choice="plain">
          set-implicit-any
          <replaceable>value</replaceable>
        </arg>
        <arg choice="plain">
          <sbr/>
          set-implicit-inactive
          <replaceable>value</replaceable>
        </arg>
        <arg choice="plain">
          <sbr/>
          set-implicit-active
          <replaceable>value</replaceable>
        </arg>
        <arg choice="plain">
          <sbr/>
          reset-implicit
        </arg>
      </group>
    </cmdsynopsis>

    <cmdsynopsis>
      <command>polkit-1 run</command>
      <arg choice="plain"><replaceable>action-id</replaceable></arg>
      <arg choice="plain"><replaceable>PROGRAM</replaceable></arg>
      <group rep="repeat">
        <arg choice="plain"><replaceable>ARGUMENTS</replaceable></arg>
      </group>
    </cmdsynopsis>

  </refsynopsisdiv>

  <refsect1><title>DESCRIPTION</title>
    <para>
      Manage PolicyKit authorizations.
    </para>
  </refsect1>

  <refsect1>
    <title>OPTIONS</title>
    <variablelist>
      <varlistentry>
        <term><option>--version</option></term>
        <listitem>
          <para>
            Show version and exit.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--help</option></term>
        <listitem>
          <para>
            Show this information.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>

    <refsect2>
      <para>
        <command>polkit-1 list actions</command>
        <arg><option>--verbose</option></arg>
      </para>
      <para>
        Lists all identifiers for registered PolicyKit actions. The returned identifiers can be
        used as <replaceable>action-id</replaceable> parameters.
        Prints detailed information about each action if <option>--verbose</option> is given.
      </para>
    </refsect2>

    <refsect2>
      <para>
        <command>polkit-1 list users</command>
        <arg><option>--verbose</option></arg>
      </para>
      <para>
        Lists all users.
        The returned identifiers can be used as <replaceable>subject</replaceable> parameters.
        Prints detailed information about each user if <option>--verbose</option> is given.
      </para>
    </refsect2>

    <refsect2>
      <para>
        <command>polkit-1 list groups</command>
        <arg><option>--verbose</option></arg>
      </para>
      <para>
        Lists all groups.
        The returned identifiers can be used as <replaceable>subject</replaceable> parameters.
        Prints detailed information about each group if <option>--verbose</option> is given.
      </para>
    </refsect2>

    <refsect2>
      <para>
        <command>polkit-1 list authorizations</command>
      </para>
      <para>
        Lists all <replaceable>action-id</replaceable>s that the calling process is authorized for.
      </para>
    </refsect2>

    <refsect2>
      <para>
        <command>polkit-1 list explicit-authorizations <replaceable>subject</replaceable></command>
        <arg><option>--verbose</option></arg>
      </para>
      <para>
        Lists all explicit authorizations for <replaceable>subject</replaceable>.
        Prints detailed information about each authorization if <option>--verbose</option> is given.
      </para>
    </refsect2>

    <refsect2>
      <para>
        <command>polkit-1 check</command>
        <arg choice="plain"><replaceable>subject</replaceable></arg>
        <arg choice="plain"><replaceable>action-id</replaceable></arg>
      </para>
      <para>
        Checks if <replaceable>subject</replaceable> is authorized for <replaceable>action-id</replaceable>.
      </para>
    </refsect2>

    <refsect2>
      <para>
        <command>polkit-1 grant</command>
        <arg choice="plain"><replaceable>subject</replaceable></arg>
        <arg choice="plain"><replaceable>action-id</replaceable></arg>
      </para>
      <para>
        Grants an authorization to <replaceable>subject</replaceable> for <replaceable>action-id</replaceable>.
      </para>
    </refsect2>

    <refsect2>
      <para>
        <command>polkit-1 revoke</command>
        <arg choice="plain"><replaceable>subject</replaceable></arg>
        <arg choice="plain"><replaceable>action-id</replaceable></arg>
      </para>
      <para>
        Revokes an authorization from <replaceable>subject</replaceable> for <replaceable>action-id</replaceable>.
      </para>
    </refsect2>

    <refsect2>
      <para>
        <command>polkit-1 action</command>
        <arg choice="plain"><replaceable>action-id</replaceable></arg>
        <arg choice="plain">
          set-implicit-any
          <replaceable>value</replaceable>
        </arg>
      </para>
      <para>
        Sets the implicit authorizations on
        <replaceable>action-id</replaceable> to <replaceable>value</replaceable>.
      </para>
    </refsect2>

    <refsect2>
      <para>
        <command>polkit-1 action</command>
        <arg choice="plain"><replaceable>action-id</replaceable></arg>
        <arg choice="plain">
          set-implicit-inactive
          <replaceable>value</replaceable>
        </arg>
      </para>
      <para>
        Sets the implicit authorizations for local inactive sessions on
        <replaceable>action-id</replaceable> to <replaceable>value</replaceable>.
      </para>
    </refsect2>

    <refsect2>
      <para>
        <command>polkit-1 action</command>
        <arg choice="plain"><replaceable>action-id</replaceable></arg>
        <arg choice="plain">
          set-implicit-active
          <replaceable>value</replaceable>
        </arg>
      </para>
      <para>
        Sets the implicit authorizations for local active sessions on
        <replaceable>action-id</replaceable> to <replaceable>value</replaceable>.
      </para>
    </refsect2>

    <refsect2>
      <para>
        <command>polkit-1 action</command>
        <arg choice="plain"><replaceable>action-id</replaceable></arg>
        <arg choice="plain">
          reset-implicit
        </arg>
      </para>
      <para>
        Resets all implicit authorizations on <replaceable>action-id</replaceable> to factory defaults.
      </para>
    </refsect2>

    <refsect2>
      <para>
        <command>polkit-1 run</command>
        <arg choice="plain"><replaceable>action-id</replaceable></arg>
        <arg choice="plain"><replaceable>PROGRAM</replaceable></arg>
        <group rep="repeat">
          <arg choice="plain"><replaceable>ARGUMENTS</replaceable></arg>
        </group>
      </para>
      <para>
        Attempts to ensure that a PolicyKit authorization for <replaceable>action-id</replaceable>
        is available and runs the <replaceable>PROGRAM</replaceable> if an authorization is
        in place. This may involve having to make the user obtain the authorization through
        authentication. If an authorization cannot be obtained, <replaceable>PROGRAM</replaceable>
        will not be runned.
      </para>
    </refsect2>

  </refsect1>

  <refsect1><title>AUTHOR</title>
    <para>
      Written by David Zeuthen <email>davidz@redhat.com</email> with
      a lot of help from many others.
    </para>
  </refsect1>

  <refsect1>
    <title>BUGS</title>
    <para>
      Please send bug reports to either the distribution or the
      polkit-devel mailing list,
      see the link <ulink url="http://lists.freedesktop.org/mailman/listinfo/polkit-devel"/>
      on how to subscribe.
    </para>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>PolicyKit-1</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>
    </para>
  </refsect1>
</refentry>