card: Rename gpg-card-tool to gpg-card.
[gnupg.git] / doc / gpg-card.texi
1 @c card-tool.texi - man page for gpg-card-tool
2 @c Copyright (C) 2019 g10 Code GmbH
3 @c This is part of the GnuPG manual.
4 @c For copying conditions, see the file GnuPG.texi.
5
6 @include defs.inc
7
8 @node Smart Card Tool
9 @chapter Smart Card Tool
10
11 GnuPG comes with tool to administrate smart cards and USB tokens.  This
12 tool is an extension of the @option{--edit-key} command available with
13 @command{gpg}.
14
15 @menu
16 * gpg-card::             Administrate smart cards.
17 @end menu
18
19 @c
20 @c  GPG-CARD-TOOL
21 @c
22 @manpage gpg-card.1
23 @node gpg-card
24 @section Administrate smart cards.
25 @ifset manverb
26 .B gpg-card
27 \- Administrate Smart Cards
28 @end ifset
29
30 @mansect synopsis
31 @ifset manverb
32 .B gpg-card
33 .RI [ options ]
34 .br
35 .B gpg-card
36 .RI [ options ]
37 .I command
38 .RI {
39 .B --
40 .I command
41 .RI }
42 @end ifset
43
44 @mansect description
45 The @command{gpg-card} is used to administrate smart cards and USB
46 tokens.  It provides a superset of features from @command{gpg
47 --card-edit} an can be considered a frontend to @command{scdaemon}
48 which is a daemon started by @command{gpg-agent} to handle smart
49 cards.
50
51 If @command{gpg-card} is invoked without commands an interactive
52 mode is used.
53
54 If @command{gpg-card} is invoked with one or more commands the
55 same commands as available in the interactive mode are run from the
56 command line.  These commands need to be delimited with a double-dash.
57 If a double-dash or a shell specific character is required as part of
58 a command the entire command needs to be put in quotes.  If one of
59 those commands returns an error the remaining commands are mot anymore
60 run unless the command was prefixed with a single dash.
61
62 A list of commands is available by using the command @code{help} and a
63 detailed description of each command is printed by using @code{help
64 COMMAND}.
65
66
67 @mansect options
68 @noindent
69 @command{gpg-card} understands these options:
70
71 @table @gnupgtabopt
72
73 @item --with-colons
74 @opindex with-colons
75 This option has currently no effect.
76
77 @item --status-fd @var{n}
78 @opindex status-fd
79 Write special status strings to the file descriptor @var{n}.  This
80 program returns only the status messages SUCCESS or FAILURE which are
81 helpful when the caller uses a double fork approach and can't easily
82 get the return code of the process.
83
84 @item --verbose
85 @opindex verbose
86 Enable extra informational output.
87
88 @item --quiet
89 @opindex quiet
90 Disable almost all informational output.
91
92 @item --version
93 @opindex version
94 Print version of the program and exit.
95
96 @item --help
97 @opindex help
98 Display a brief help page and exit.
99
100 @item --no-autostart
101 @opindex no-autostart
102 Do not start the gpg-agent if it has not yet been started and its
103 service is required.  This option is mostly useful on machines where
104 the connection to gpg-agent has been redirected to another machines.
105
106 @item --agent-program @var{file}
107 @opindex agent-program
108 Specify the agent program to be started if none is running.  The
109 default value is determined by running @command{gpgconf} with the
110 option @option{--list-dirs}.
111
112 @item --gpg-program @var{file}
113 @opindex gpg-program
114 Specify a non-default gpg binary to be used by certain commands.
115
116 @item --gpgsm-program @var{file}
117 @opindex gpgsm-program
118 Specify a non-default gpgsm binary to be used by certain commands.
119
120 @end table
121
122
123 @mansect see also
124 @ifset isman
125 @command{scdaemon}(1)
126 @end ifset