mirror of
git://git.gnupg.org/gnupg.git
synced 2025-01-03 12:11:33 +01:00
doc: Add basic man page for the gpg-card-tool.
--
This commit is contained in:
parent
e9e876cb55
commit
6c581cc468
@ -69,7 +69,7 @@ nobase_dist_doc_DATA = FAQ DETAILS HACKING DCO TRANSLATE OpenPGP KEYSERVER \
|
|||||||
gnupg_TEXINFOS = \
|
gnupg_TEXINFOS = \
|
||||||
gpg.texi gpgsm.texi gpg-agent.texi scdaemon.texi instguide.texi \
|
gpg.texi gpgsm.texi gpg-agent.texi scdaemon.texi instguide.texi \
|
||||||
tools.texi debugging.texi glossary.texi contrib.texi gpl.texi \
|
tools.texi debugging.texi glossary.texi contrib.texi gpl.texi \
|
||||||
sysnotes.texi dirmngr.texi wks.texi \
|
sysnotes.texi dirmngr.texi wks.texi card-tool.texi \
|
||||||
gnupg-module-overview.svg \
|
gnupg-module-overview.svg \
|
||||||
gnupg-card-architecture.fig \
|
gnupg-card-architecture.fig \
|
||||||
howtos.texi howto-create-a-server-cert.texi
|
howtos.texi howto-create-a-server-cert.texi
|
||||||
@ -89,12 +89,13 @@ YAT2M_OPTIONS = -I $(srcdir) \
|
|||||||
--release "GnuPG @PACKAGE_VERSION@" --source "GNU Privacy Guard 2.2"
|
--release "GnuPG @PACKAGE_VERSION@" --source "GNU Privacy Guard 2.2"
|
||||||
|
|
||||||
myman_sources = gnupg7.texi gpg.texi gpgsm.texi gpg-agent.texi \
|
myman_sources = gnupg7.texi gpg.texi gpgsm.texi gpg-agent.texi \
|
||||||
dirmngr.texi scdaemon.texi tools.texi wks.texi
|
dirmngr.texi scdaemon.texi tools.texi wks.texi \
|
||||||
|
card-tool.texi
|
||||||
myman_pages = gpgsm.1 gpg-agent.1 dirmngr.8 scdaemon.1 \
|
myman_pages = gpgsm.1 gpg-agent.1 dirmngr.8 scdaemon.1 \
|
||||||
watchgnupg.1 gpgconf.1 addgnupghome.8 gpg-preset-passphrase.1 \
|
watchgnupg.1 gpgconf.1 addgnupghome.8 gpg-preset-passphrase.1 \
|
||||||
gpg-connect-agent.1 gpgparsemail.1 symcryptrun.1 gpgtar.1 \
|
gpg-connect-agent.1 gpgparsemail.1 symcryptrun.1 gpgtar.1 \
|
||||||
applygnupgdefaults.8 gpg-wks-client.1 gpg-wks-server.1 \
|
applygnupgdefaults.8 gpg-wks-client.1 gpg-wks-server.1 \
|
||||||
dirmngr-client.1
|
dirmngr-client.1 gpg-card-tool.1
|
||||||
if USE_GPG2_HACK
|
if USE_GPG2_HACK
|
||||||
myman_pages += gpg2.1 gpgv2.1
|
myman_pages += gpg2.1 gpgv2.1
|
||||||
else
|
else
|
||||||
|
126
doc/card-tool.texi
Normal file
126
doc/card-tool.texi
Normal file
@ -0,0 +1,126 @@
|
|||||||
|
@c card-tool.texi - man page for gpg-card-tool
|
||||||
|
@c Copyright (C) 2019 g10 Code GmbH
|
||||||
|
@c This is part of the GnuPG manual.
|
||||||
|
@c For copying conditions, see the file GnuPG.texi.
|
||||||
|
|
||||||
|
@include defs.inc
|
||||||
|
|
||||||
|
@node Smart Card Tool
|
||||||
|
@chapter Smart Card Tool
|
||||||
|
|
||||||
|
GnuPG comes with tool to administrate smart cards and USB tokens. This
|
||||||
|
tool is an extension of the @option{--edit-key} command available with
|
||||||
|
@command{gpg}.
|
||||||
|
|
||||||
|
@menu
|
||||||
|
* gpg-card-tool:: Administrate smart cards.
|
||||||
|
@end menu
|
||||||
|
|
||||||
|
@c
|
||||||
|
@c GPG-CARD-TOOL
|
||||||
|
@c
|
||||||
|
@manpage gpg-card-tool.1
|
||||||
|
@node gpg-card-tool
|
||||||
|
@section Administrate smart cards.
|
||||||
|
@ifset manverb
|
||||||
|
.B gpg-card-tool
|
||||||
|
\- Administrate Smart Cards
|
||||||
|
@end ifset
|
||||||
|
|
||||||
|
@mansect synopsis
|
||||||
|
@ifset manverb
|
||||||
|
.B gpg-card-tool
|
||||||
|
.RI [ options ]
|
||||||
|
.br
|
||||||
|
.B gpg-card-tool
|
||||||
|
.RI [ options ]
|
||||||
|
.I command
|
||||||
|
.RI {
|
||||||
|
.B --
|
||||||
|
.I command
|
||||||
|
.RI }
|
||||||
|
@end ifset
|
||||||
|
|
||||||
|
@mansect description
|
||||||
|
The @command{gpg-card-tool} is used to administrate smart cards and USB
|
||||||
|
tokens. It provides a superset of features from @command{gpg
|
||||||
|
--card-edit} an can be considered a frontend to @command{scdaemon}
|
||||||
|
which is a daemon started by @command{gpg-agent} to handle smart
|
||||||
|
cards.
|
||||||
|
|
||||||
|
If @command{gpg-card-tool} is invoked without commands an interactive
|
||||||
|
mode is used.
|
||||||
|
|
||||||
|
If @command{gpg-card-tool} is invoked with one or more commands the
|
||||||
|
same commands as available in the interactive mode are run from the
|
||||||
|
command line. These commands need to be delimited with a double-dash.
|
||||||
|
If a double-dash or a shell specific character is required as part of
|
||||||
|
a command the entire command needs to be put in quotes. If one of
|
||||||
|
those commands returns an error the remaining commands are mot anymore
|
||||||
|
run unless the command was prefixed with a single dash.
|
||||||
|
|
||||||
|
A list of commands is available by using the command @code{help} and a
|
||||||
|
detailed description of each command is printed by using @code{help
|
||||||
|
COMMAND}.
|
||||||
|
|
||||||
|
|
||||||
|
@mansect options
|
||||||
|
@noindent
|
||||||
|
@command{gpg-card-tool} understands these options:
|
||||||
|
|
||||||
|
@table @gnupgtabopt
|
||||||
|
|
||||||
|
@item --with-colons
|
||||||
|
@opindex with-colons
|
||||||
|
This option has currently no effect.
|
||||||
|
|
||||||
|
@item --status-fd @var{n}
|
||||||
|
@opindex status-fd
|
||||||
|
Write special status strings to the file descriptor @var{n}. This
|
||||||
|
program returns only the status messages SUCCESS or FAILURE which are
|
||||||
|
helpful when the caller uses a double fork approach and can't easily
|
||||||
|
get the return code of the process.
|
||||||
|
|
||||||
|
@item --verbose
|
||||||
|
@opindex verbose
|
||||||
|
Enable extra informational output.
|
||||||
|
|
||||||
|
@item --quiet
|
||||||
|
@opindex quiet
|
||||||
|
Disable almost all informational output.
|
||||||
|
|
||||||
|
@item --version
|
||||||
|
@opindex version
|
||||||
|
Print version of the program and exit.
|
||||||
|
|
||||||
|
@item --help
|
||||||
|
@opindex help
|
||||||
|
Display a brief help page and exit.
|
||||||
|
|
||||||
|
@item --no-autostart
|
||||||
|
@opindex no-autostart
|
||||||
|
Do not start the gpg-agent if it has not yet been started and its
|
||||||
|
service is required. This option is mostly useful on machines where
|
||||||
|
the connection to gpg-agent has been redirected to another machines.
|
||||||
|
|
||||||
|
@item --agent-program @var{file}
|
||||||
|
@opindex agent-program
|
||||||
|
Specify the agent program to be started if none is running. The
|
||||||
|
default value is determined by running @command{gpgconf} with the
|
||||||
|
option @option{--list-dirs}.
|
||||||
|
|
||||||
|
@item --gpg-program @var{file}
|
||||||
|
@opindex gpg-program
|
||||||
|
Specify a non-default gpg binary to be used by certain commands.
|
||||||
|
|
||||||
|
@item --gpgsm-program @var{file}
|
||||||
|
@opindex gpgsm-program
|
||||||
|
Specify a non-default gpgsm binary to be used by certain commands.
|
||||||
|
|
||||||
|
@end table
|
||||||
|
|
||||||
|
|
||||||
|
@mansect see also
|
||||||
|
@ifset isman
|
||||||
|
@command{scdaemon}(1)
|
||||||
|
@end ifset
|
@ -142,15 +142,16 @@ the administration and the architecture.
|
|||||||
* Specify a User ID:: How to Specify a User Id.
|
* Specify a User ID:: How to Specify a User Id.
|
||||||
* Trust Values:: How GnuPG displays trust values.
|
* Trust Values:: How GnuPG displays trust values.
|
||||||
|
|
||||||
* Helper Tools:: Description of small helper tools
|
* Smart Card Tool:: Tool to administrate smart cards.
|
||||||
* Web Key Service:: Tools for the Web Key Service
|
* Helper Tools:: Description of small helper tools.
|
||||||
|
* Web Key Service:: Tools for the Web Key Service.
|
||||||
|
|
||||||
* Howtos:: How to do certain things.
|
* Howtos:: How to do certain things.
|
||||||
* System Notes:: Notes pertaining to certain OSes.
|
* System Notes:: Notes pertaining to certain OSes.
|
||||||
* Debugging:: How to solve problems
|
* Debugging:: How to solve problems.
|
||||||
|
|
||||||
* Copying:: GNU General Public License says
|
* Copying:: GNU General Public License says
|
||||||
how you can copy and share GnuPG
|
how you can copy and share GnuPG.
|
||||||
* Contributors:: People who have contributed to GnuPG.
|
* Contributors:: People who have contributed to GnuPG.
|
||||||
|
|
||||||
* Glossary:: Short description of terms used.
|
* Glossary:: Short description of terms used.
|
||||||
@ -186,6 +187,7 @@ the administration and the architecture.
|
|||||||
@cindex trust values
|
@cindex trust values
|
||||||
@include trust-values.texi
|
@include trust-values.texi
|
||||||
|
|
||||||
|
@include card-tool.texi
|
||||||
@include tools.texi
|
@include tools.texi
|
||||||
@include wks.texi
|
@include wks.texi
|
||||||
|
|
||||||
@ -237,5 +239,3 @@ the administration and the architecture.
|
|||||||
|
|
||||||
|
|
||||||
@bye
|
@bye
|
||||||
|
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user