summaryrefslogtreecommitdiffstats
path: root/man/gpg-tui.1
blob: 0a1e0f2701358d8f274af1f0aa09c0ca48356177 (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
.\" Manpage for gpg-tui.
.TH GPG-TUI "1" "July 2021" "gpg-tui 0.7.0" "User Commands"
.SH NAME
gpg-tui \- manage your GnuPG keys with ease

.SH SYNOPSIS
.B gpg-tui
[FLAGS] [OPTIONS]

.SH DESCRIPTION
.PP
\f[B]gpg-tui\f[R] is a Terminal User Interface for GnuPG.
.PP
It aims to ease the key management operations such as
listing/exporting/signing by providing an interface along with the
command-line fallback for more complex operations.
It is not trying to be a full-fledged interface for all the features
that \f[B]gpg\f[R] provides but it tries to bring a more interactive
approach to key management.

.SH USAGE
.SS FLAGS
.TP
\fB\-a\fR, \fB\-\-armor\fR
Enables ASCII armored output
.TP
\fB\-\-splash\fR
Shows the splash screen on startup
.TP
\fB\-h\fR, \fB\-\-help\fR
Prints help information
.TP
\fB\-V\fR, \fB\-\-version\fR
Prints version information

.SS OPTIONS
.TP
\fB\-\-homedir\fR <dir>
Sets the GnuPG home directory [env: GNUPGHOME=]
.TP
\fB\-o\fR, \fB\-\-outdir\fR <dir>
Sets the output directory [env: OUTDIR=]
.TP
\fB\-d\fR, \fB\-\-default\-key\fR <key>
Sets the default key to sign with [env: DEFAULT_KEY=]
.TP
\fB\-t\fR, \fB\-\-tick\-rate\fR <ms>
Sets the tick rate of the terminal [env: TICK_RATE=]  [default: 250]
.TP
\fB\-c\fR, \fB\-\-color\fR <color>
Sets the accent color of the terminal [env: COLOR=]  [default: gray]
.TP
\fB\-s\fR, \fB\-\-style\fR <style>
Sets the style of the terminal [env: STYLE=]  [default: plain]  [possible values: plain, colored]
.TP
\fB\-\-select\fR <option>
Enables the selection mode [env: SELECT=]  [possible values: key_id, key_fpr, user_id, row1, row2]

.SH KEY BINDINGS
.SS USER INTERFACE
.PP
.TS
tab(@);
l l.
T{
Key Binding
T}@T{
Action
T}
_
T{
\f[C]?\f[R]
T}@T{
show help
T}
T{
\f[C]o,space,enter\f[R]
T}@T{
show options
T}
T{
\f[C]hjkl,arrows,pgkeys\f[R]
T}@T{
navigate
T}
T{
\f[C]n\f[R]
T}@T{
switch to normal mode
T}
T{
\f[C]v\f[R]
T}@T{
switch to visual mode
T}
T{
\f[C]c\f[R]
T}@T{
switch to copy mode
T}
T{
\f[C]p,C-v\f[R]
T}@T{
paste from clipboard
T}
T{
\f[C]a\f[R]
T}@T{
toggle armored output
T}
T{
\f[C]1,2,3\f[R]
T}@T{
set detail level
T}
T{
\f[C]t,tab\f[R]
T}@T{
toggle detail (all/selected)
T}
T{
\f[C]\[ga]\f[R]
T}@T{
toggle table margin
T}
T{
\f[C]m\f[R]
T}@T{
toggle table size
T}
T{
\f[C]C-s\f[R]
T}@T{
toggle style
T}
T{
\f[C]/\f[R]
T}@T{
search
T}
T{
\f[C]:\f[R]
T}@T{
run command
T}
T{
\f[C]r,f5\f[R]
T}@T{
refresh application
T}
T{
\f[C]q,C-c/d,escape\f[R]
T}@T{
quit application
T}
.TE

.SS KEY MANAGEMENT
.PP
.TS
tab(@);
l l.
T{
Key Binding
T}@T{
Action
T}
_
T{
\f[C]x\f[R]
T}@T{
export key
T}
T{
\f[C]s\f[R]
T}@T{
sign key
T}
T{
\f[C]e\f[R]
T}@T{
edit key
T}
T{
\f[C]i\f[R]
T}@T{
import key(s)
T}
T{
\f[C]f\f[R]
T}@T{
receive key
T}
T{
\f[C]u\f[R]
T}@T{
send key
T}
T{
\f[C]g\f[R]
T}@T{
generate key
T}
T{
\f[C]d,backspace\f[R]
T}@T{
delete key
T}
T{
\f[C]C-r\f[R]
T}@T{
refresh keys
T}
.TE

.SH BUGS
Report bugs at <https://github.com/orhun/gpg-tui/issues> or contact the author via email.

.SH AUTHOR
Orhun Parmaksız <orhunparmaksiz@gmail.com>

.SH ABOUT
.P
\f[I]gpg-tui\f[R] is maintained by Orhun Parmaksız, and released under the MIT license.
.PP
See the project homepage at <https://github.com/orhun/gpg-tui> for full documentation.