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

respect sphinx style guide to some extent

Browse Source 
see http://documentation-style-guide-sphinx.readthedocs.org/en/latest/style-guide.html
This commit is contained in:
Frank Morgner
2013-03-05 20:42:09 +01:00
parent 9be74c7886
commit 37e5f9d514
74 changed files with 488 additions and 264 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
pcsc-relay/README
View File

@@ -1 +1 @@
doc/README.rst
doc/README.txt

10
pcsc-relay/doc/Makefile.am
View File

@@ -16,13 +16,13 @@ do_subst = $(SED) \
-e 's,[@]abs_top_srcdir[@],$(abs_top_srcdir),g' \
-e 's,[@]top_srcdir[@],$(top_srcdir),g'
EXTRA_DIST = README.rst.in README.rst autotools.rst.in questions.rst.in autotools.rst questions.rst download.rst.in download.rst
EXTRA_DIST = README.txt.in README.txt autotools.txt.in questions.txt.in autotools.txt questions.txt download.txt.in download.txt
doc: *.in
$(do_subst) < autotools.rst.in > autotools.rst
$(do_subst) < questions.rst.in > questions.rst
$(do_subst) < download.rst.in > download.rst
$(do_subst) < README.rst.in > README.rst
$(do_subst) < autotools.txt.in > autotools.txt
$(do_subst) < questions.txt.in > questions.txt
$(do_subst) < download.txt.in > download.txt
$(do_subst) < README.txt.in > README.txt
touch doc
clean-local:

45
pcsc-relay/doc/README.rst → pcsc-relay/doc/README.txt
View File

@@ -1,14 +1,10 @@
.. highlight:: sh
.. _libnfc: http://www.libnfc.org/
.. _OpenPICC: http://www.openpcd.org/OpenPICC
.. _PCSC-lite: http://pcsclite.alioth.debian.org/
.. _pcsc-relay:
********************************************************************************
###########
PC/SC Relay
********************************************************************************
###########
:Authors:
- Frank Morgner <morgner@informatik.hu-berlin.de>
@@ -35,25 +31,24 @@ emulate an ISO/IEC 14443 smart card.
.. note::
This software can actually be used in a relay attack allowing full access
to the card. `We discussed the impact especially on the German identity
card
<http://media.ccc.de/browse/congress/2010/27c3-4297-de-die_gesamte_technik_ist_sicher.html>`_,
but it generally concerns *all* contact-less smart cards.
to the card. We discussed the impact especially on the `Relay attack
against the German ID card`_, but it generally concerns *all* contact-less
smart cards.
.. include:: download.rst
.. include:: download.txt
.. include:: autotools.rst
.. include:: autotools.txt
PC/SC Relay has the following dependencies:
- PC/SC middleware
- libnfc_
---------------
===============
Hints on libnfc
---------------
===============
PC/SC Relay links against libnfc_. Here is an example of how to get the standard
installation of the latter::
@@ -74,9 +69,9 @@ configure PC/SC Relay to use it::
./configure PKG_CONFIG_PATH=$PREFIX/lib/pkgconfig
-------------------------
=========================
Hints on PC/SC middleware
-------------------------
=========================
A PC/SC middleware is included by default in most modern operating systems. On
Unix-like systems (Linux, OS X, Sun OS) it is realized by PCSC-Lite_. To
@@ -88,11 +83,23 @@ Microsoft's developement environment Visual Studio includes all necessary data
for building PC/SC Relay.
=====
*****
Usage
=====
*****
.. program-output:: pcsc-relay --help
.. include:: questions.rst
.. include:: questions.txt
********************
Notes and References
********************
.. target-notes::
.. _libnfc: http://www.libnfc.org/
.. _OpenPICC: http://www.openpcd.org/OpenPICC
.. _PCSC-lite: http://pcsclite.alioth.debian.org/
.. _`Relay attack against the German ID card`: http://media.ccc.de/browse/congress/2010/27c3-4297-de-die_gesamte_technik_ist_sicher.html

65
pcsc-relay/doc/README.rst.in → pcsc-relay/doc/README.txt.in
View File

@@ -1,14 +1,10 @@
.. highlight:: sh
.. _libnfc: http://www.libnfc.org/
.. _OpenPICC: http://www.openpcd.org/OpenPICC
.. _PCSC-lite: http://pcsclite.alioth.debian.org/
.. _pcsc-relay:
********************************************************************************
@PACKAGE_NAME@
********************************************************************************
###########
PC/SC Relay
###########
:Authors:
- Frank Morgner <morgner@informatik.hu-berlin.de>
@@ -21,7 +17,7 @@
:Potential Platforms:
Unix-like operating systems (Mac OS, Solaris, BSD, ...)
Welcome to @PACKAGE_NAME@. The purpose of @PACKAGE_NAME@ is to relay a smart
Welcome to PC/SC Relay. The purpose of PC/SC Relay is to relay a smart
card using an contact-less interface. Currently the following contact-less
backends:
@@ -30,32 +26,31 @@ backends:
Command APDUs are received with the contact-less interface and forwarded to an
existing smart card via PC/SC. The Response APDUs are then sent back via RFID.
You can use @PACKAGE_NAME@ in combination with the :ref:`vicc` to completely
You can use PC/SC Relay in combination with the :ref:`vicc` to completely
emulate an ISO/IEC 14443 smart card.
.. note::
This software can actually be used in a relay attack allowing full access
to the card. `We discussed the impact especially on the German identity
card
<http://media.ccc.de/browse/congress/2010/27c3-4297-de-die_gesamte_technik_ist_sicher.html>`_,
but it generally concerns *all* contact-less smart cards.
to the card. We discussed the impact especially on the `Relay attack
against the German ID card`_, but it generally concerns *all* contact-less
smart cards.
.. include:: download.rst
.. include:: download.txt
.. include:: autotools.rst
.. include:: autotools.txt
@PACKAGE_NAME@ has the following dependencies:
PC/SC Relay has the following dependencies:
- PC/SC middleware
- libnfc_
---------------
===============
Hints on libnfc
---------------
===============
@PACKAGE_NAME@ links against libnfc_. Here is an example of how to get the standard
PC/SC Relay links against libnfc_. Here is an example of how to get the standard
installation of the latter::
PREFIX=/tmp/install
@@ -67,32 +62,44 @@ installation of the latter::
make
make install
Building @PACKAGE_NAME@ with libnfc_ is done best using :command:`pkg-config`. The file
Building PC/SC Relay with libnfc_ is done best using :command:`pkg-config`. The file
:file:`libnfc.pc` should be located in ``$INSTALL/lib/pkgconfig``. Here is how to
configure @PACKAGE_NAME@ to use it::
configure PC/SC Relay to use it::
./configure PKG_CONFIG_PATH=$PREFIX/lib/pkgconfig
-------------------------
=========================
Hints on PC/SC middleware
-------------------------
=========================
A PC/SC middleware is included by default in most modern operating systems. On
Unix-like systems (Linux, OS X, Sun OS) it is realized by PCSC-Lite_. To
compile @PACKAGE_NAME@ you will need to install the PCSC-Lite_ headers from
compile PC/SC Relay you will need to install the PCSC-Lite_ headers from
your distribution.
Windows also ships with a PC/SC middleware in form of the Winscard module.
Microsoft's developement environment Visual Studio includes all necessary data
for building @PACKAGE_NAME@.
for building PC/SC Relay.
=====
*****
Usage
=====
*****
.. program-output:: @PACKAGE@ --help
.. program-output:: pcsc-relay --help
.. include:: questions.rst
.. include:: questions.txt
********************
Notes and References
********************
.. target-notes::
.. _libnfc: http://www.libnfc.org/
.. _OpenPICC: http://www.openpcd.org/OpenPICC
.. _PCSC-lite: http://pcsclite.alioth.debian.org/
.. _`Relay attack against the German ID card`: http://media.ccc.de/browse/congress/2010/27c3-4297-de-die_gesamte_technik_ist_sicher.html

1
pcsc-relay/doc/autotools.rst.in
View File

@@ -1 +0,0 @@
../../doc/autotools.rst.in

4
pcsc-relay/doc/autotools.rst → pcsc-relay/doc/autotools.txt
View File

@@ -1,8 +1,8 @@
.. highlight:: sh
============
************
Installation
============
************
The PC/SC Relay uses the GNU Build System to compile and install. If you are
unfamiliar with it, please have a look at :file:`INSTALL`. If you have a look

1
pcsc-relay/doc/autotools.txt.in Symbolic link
View File

@@ -0,0 +1 @@
../../doc/autotools.txt.in

1
pcsc-relay/doc/download.rst.in
View File

@@ -1 +0,0 @@
../../doc/download.rst.in

4
pcsc-relay/doc/download.rst → pcsc-relay/doc/download.txt
View File

@@ -1,8 +1,8 @@
.. highlight:: sh
===============================================================================
********
Download
===============================================================================
********
You can find the latest release of PC/SC Relay `here
<http://sourceforge.net/projects/vsmartcard/files>`_.

1
pcsc-relay/doc/download.txt.in Symbolic link
View File

@@ -0,0 +1 @@
../../doc/download.txt.in

1
pcsc-relay/doc/questions.rst.in
View File

@@ -1 +0,0 @@
../../doc/questions.rst.in

4
pcsc-relay/doc/questions.rst → pcsc-relay/doc/questions.txt
View File

@@ -1,6 +1,6 @@
========
********
Question
========
********
Do you have questions, suggestions or contributions? Feedback of any kind is
more than welcome! Please use our `project trackers <http://sourceforge.net/projects/vsmartcard/support>`_.

1
pcsc-relay/doc/questions.txt.in Symbolic link
View File

@@ -0,0 +1 @@
../../doc/questions.txt.in