VivoKey/vsmartcard
7
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

avoid sphinx's option warning

Browse Source
This commit is contained in:
Frank Morgner
2021-04-28 02:12:50 +02:00
parent 3b2b73bd22
commit 29a818c69a
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
virtualsmartcard/doc/README.txt.in
View File

@@ -102,10 +102,10 @@ responses via NFC to a contact-less smart card that signs the mail.
Depending on your usage of the |vpicc| you may need to install the following: Depending on your usage of the |vpicc| you may need to install the following:
- Python_ - Python_
- pyscard_ (relaying a local smart card with :option:`--type=relay`) - pyscard_ (relaying a local smart card with `--type=relay`)
- PyCrypto_, PBKDF2_, PIL_, readline_ or PyReadline_ (emulation of electronic - PyCrypto_, PBKDF2_, PIL_, readline_ or PyReadline_ (emulation of electronic
passport with :option:`--type=ePass`) passport with `--type=ePass`)
- OpenPACE_ (emulation of German identity card with :option:`--type=nPA`) - OpenPACE_ (emulation of German identity card with `--type=nPA`)
- libqrencode_ (to print a QR code on the command line for `vpcd-config`; an - libqrencode_ (to print a QR code on the command line for `vpcd-config`; an
URL will be printed if libqrencode is not available) URL will be printed if libqrencode is not available)
@@ -209,7 +209,7 @@ connections. The port to open should be specified in ``CHANNELID`` and
If the first part of the ``DEVICENAME`` is different from ``/dev/null``, |vpcd| If the first part of the ``DEVICENAME`` is different from ``/dev/null``, |vpcd|
will use this string as a hostname for connecting to a waiting |vpicc|. |vpicc| will use this string as a hostname for connecting to a waiting |vpicc|. |vpicc|
needs to be started with :option:`--reversed` in this case. needs to be started with `--reversed` in this case.
================================================================================ ================================================================================
Configuring |vpcd| on Mac OS X Configuring |vpcd| on Mac OS X
@@ -271,7 +271,7 @@ to open should be specified in ``TCP_PORT``:
:emphasize-lines: 8 :emphasize-lines: 8
Currently it is not possible to configure the Windows driver to connect to an Currently it is not possible to configure the Windows driver to connect to an
|vpicc| running with :option:`--reversed`. |vpicc| running with `--reversed`.
================================================================================ ================================================================================
Running |vpicc| Running |vpicc|
@@ -282,7 +282,7 @@ dependencies listed above need to be installed seperately. You can start the
|vpicc| via :command:`python.exe vicc.py`. On all other systems an executable |vpicc| via :command:`python.exe vicc.py`. On all other systems an executable
script :command:`vicc` is installed using the autotools. script :command:`vicc` is installed using the autotools.
The |vpicc| option :option:`--help` gives an overview about the command line The |vpicc| option `--help` gives an overview about the command line
switches: switches:
.. program-output:: vicc --help .. program-output:: vicc --help
@@ -290,7 +290,7 @@ switches:
.. versionadded:: 0.7 .. versionadded:: 0.7
We implemented :command:`vpcd-config` which tries to guess the local IP We implemented :command:`vpcd-config` which tries to guess the local IP
address and outputs |vpcd|'s configuration. |vpicc|'s options should be address and outputs |vpcd|'s configuration. |vpicc|'s options should be
chosen accordingly (:option:`--hostname` and :option:`--port`) chosen accordingly (`--hostname` and `--port`)
:command:`vpcd-config` also prints a QR code for configuration of the :command:`vpcd-config` also prints a QR code for configuration of the
:ref:`remote-reader`. :ref:`remote-reader`.