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
|
.TH KEYRING "1"
.SH NAME
keyring \- Python\-Keyring command\-line utility
.SH SYNOPSIS
\fBkeyring\fR [\fIOPTIONS\fR] [\fI\,get|set|del|diagnose\/\fR] \fI\,SERVICE USERNAME\/\fR
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
Show the help message and exit.
.TP
\fB\-p\fR KEYRING_PATH, \fB\-\-keyring\-path\fR=\fI\,KEYRING_PATH\/\fR
Specify path to the keyring backend to use.
.TP
\fB\-b\fR KEYRING_BACKEND, \fB\-\-keyring\-backend\fR=\fI\,KEYRING_BACKEND\/\fR
Specify name of the keyring backend to use.
.TP
\fB\-\-list\-backends\fR
List the available keyring backends and exit.
.TP
\fB\-\-disable\fR
Create a configuration file disabling keyring and exit.
.TP
\fB\-\-mode\fR {password,creds}
Specify mode for \fBget\fP operation. \fBpassword\fP requires a username and
will return only the password. \fBcreds\fP does not require a username and
will return both the username and password separated by a newline. Default is
\fBpassword\fP.
.TP
\fB\-\-output\fR {plain,json}
Specify output format for \fBget\fP operation. Default is \fBplain\fP.
.TP
\fB\-\-print\-completion\fR {bash,zsh,tcsh}
Print shell completion script.
.SH DESCRIPTION
\fBkeyring\fR provides a way to store, lookup and delete passwords in various
backends supported by Python\-Keyring.
Usage example:
.EX
$ keyring set service username
Password for \(aqusername\(aq in \(aqservice\(aq:
$ keyring get service username
password
.EE
How the \fI\,SERVICE\/\fR and \fI\,USERNAME\/\fR parameters are handled
depends on the backend, with the default Secret Service backend they are
stored as item lookup attributes.
.SH SEE ALSO
.BR secret\-tool (1)
|
