summaryrefslogtreecommitdiff
path: root/docs/gnome-keyring-daemon.xml
blob: 72fb1aaf0c12d404db11b7b97a59646d6a1f3fc9 (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
<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
	"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">

<refentry id="adcli">

<refentryinfo>
	<title>gnome-keyring-daemon</title>
	<productname>gnome-keyring</productname>
	<authorgroup>
		<author>
			<contrib>Maintainer</contrib>
			<firstname>Stef</firstname>
			<surname>Walter</surname>
			<email>stefw@redhat.com</email>
		</author>
	</authorgroup>
</refentryinfo>

<refmeta>
	<refentrytitle>gnome-keyring-daemon</refentrytitle>
	<manvolnum>1</manvolnum>
	<refmiscinfo class="manual">User Commands</refmiscinfo>
</refmeta>

<refnamediv>
	<refname>gnome-keyring-daemon</refname>
	<refpurpose>The gnome-keyring daemon</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis>
		<command>gnome-keyring-daemon</command>
		<arg choice="opt" rep="repeat">OPTION</arg>
	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>Description</title>
	<para>The <command>gnome-keyring-daemon</command> is a service that stores
	your passwords and secrets. It is normally started automatically when
	a user logs into a desktop session.</para>

	<para>The <command>gnome-keyring-daemon</command> implements the DBus
	Secret Service API, and you can use tools like <command>seahorse</command>
	or <command>secret-tool</command> to interact with it.</para>

	<para>The daemon also implements a GnuPG and SSH agent both of which
	automatically load the user's keys, and prompt for passwords when necessary.</para>

	<para>The daemon will print out various environment variables which should
	be set in the user's environment, in order to interact with the daemon.</para>
</refsect1>

<refsect1>
	<title>Options</title>

	<para>The various startup arguments below can be used:</para>

	<variablelist>
		<varlistentry>
			<term><option>-c</option>, <option>--components=<parameter>ssh,secrets,pkcs11</parameter></option></term>
			<listitem>
			<para>Ask the daemon to only initialize certain components. Valid
				components are <literal>ssh</literal>,
				<literal>secrets</literal>, <literal>pkcs11</literal>.</para>
			<para>By default all components are initialized.</para>
			</listitem>
		</varlistentry>
		<varlistentry>
			<term><option>-C</option>, <option>--control-directory=<parameter>/path/to/directory</parameter></option></term>
			<listitem>
			<para>Use this directory for creating communication sockets. By default
				a temporary directory is automatically created.</para>
			</listitem>
		</varlistentry>
		<varlistentry>
			<term><option>-d</option>, <option>--daemonize</option></term>
			<listitem>
			<para>Run as a real daemon, disconnected from the terminal.</para>
			</listitem>
		</varlistentry>
		<varlistentry>
			<term><option>-f</option>, <option>--foreground</option></term>
			<listitem>
			<para>Run in the foreground, and do not fork or become
				a daemon.</para>
			</listitem>
		</varlistentry>
		<varlistentry>
			<term><option>-l</option>, <option>--login</option></term>
			<listitem>
			<para>This argument tells the daemon it is being run by PAM. It
				reads all of stdin (including any newlines) as a login
				password and does not complete actual initialization.</para>
			<para>The daemon should later be initialized with a
				<command>gnome-keyring-daemon</command>&nbsp;<option>--start</option>
				invocation.</para>
			<para>This option implies <option>--unlock</option>. It
				may not be used together with either the
				<option>--replace</option> or <option>--start</option>
				arguments.</para>
			</listitem>
		</varlistentry>
		<varlistentry>
			<term><option>-r</option>, <option>--replace</option></term>
			<listitem>
			<para>Try to replace a running keyring daemon, and assume its
				environment variables. A successful replacement depends
				on the <literal>GNOME_KEYRING_CONTROL</literal>
				environment variable being set by an earlier daemon.</para>
			<para>This option may not be used together with either the
				<option>--login</option> or <option>--start</option>
				arguments.</para>
			</listitem>
		</varlistentry>
		<varlistentry>
			<term><option>-s</option>, <option>--start</option></term>
			<listitem>
			<para>Connect to an already running daemon and  initialize it.
				This is often used to complete initialization of a daemon
				that was started by PAM using the <option>--login</option>
				argument.</para>
			<para>This option may not be used together with either the
				<option>--login</option> or <option>--replace</option>
				arguments.</para>
			</listitem>
		</varlistentry>
		<varlistentry>
			<term><option>--unlock</option></term>
			<listitem>
			<para>Read a password from stdin, and use it to unlock the
				login keyring or create it if the login keyring does not
				exist.</para>
			</listitem>
		</varlistentry>
		<varlistentry>
			<term><option>-V</option>, <option>--version</option></term>
			<listitem>
			<para>Print out the gnome-keyring version and then exit.</para>
			</listitem>
		</varlistentry>
		<varlistentry>
			<term><option>-h</option>, <option>--help</option></term>
			<listitem>
			<para>Show help options and exit.</para>
			</listitem>
		</varlistentry>
	</variablelist>

</refsect1>

<refsect1>
	<title>Bugs</title>
	<para>
		Please send bug reports to either the distribution bug tracker
		or the upstream bug tracker at
		<ulink url="https://bugzilla.gnome.org/enter_bug.cgi?product=gnome-keyring">https://bugzilla.gnome.org/enter_bug.cgi?product=gnome-keyring</ulink>
	</para>
</refsect1>

<refsect1>
	<title>See also</title>
	<simplelist type="inline">
		<member><citerefentry><refentrytitle>secret-tool</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
		<member><citerefentry><refentrytitle>seahorse</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
	</simplelist>
	<para>
		Further details available in the gnome-keyring online documentation at
		<ulink url="https://wiki.gnome.org/GnomeKeyring">https://wiki.gnome.org/GnomeKeyring</ulink>
		and in the secret-service online documentation at
		<ulink url="http://standards.freedesktop.org/secret-service/">http://standards.freedesktop.org/secret-service/</ulink>
	</para>
</refsect1>

</refentry>