aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorlloyd <[email protected]>2014-01-06 22:56:50 +0000
committerlloyd <[email protected]>2014-01-06 22:56:50 +0000
commit9fb5b47de44dfa3e2db45c5eab252c8af06c8de3 (patch)
tree454c95a35e42c39ebb5cfa61d6352a01c40165a1 /doc
parenta35ca25c6d1d6501ade8b405f4028819f39b150a (diff)
Fix include path of example sources in docs
Diffstat (limited to 'doc')
-rw-r--r--doc/firststep.rst2
-rw-r--r--doc/fpe.rst3
-rw-r--r--doc/passhash.rst2
-rw-r--r--doc/pubkey.rst18
-rw-r--r--doc/python.rst6
-rw-r--r--doc/relnotes/index.rst1
-rw-r--r--doc/tls.rst4
-rw-r--r--doc/x509.rst6
8 files changed, 15 insertions, 27 deletions
diff --git a/doc/firststep.rst b/doc/firststep.rst
index f1f0de11c..8010789d6 100644
--- a/doc/firststep.rst
+++ b/doc/firststep.rst
@@ -9,7 +9,7 @@ a ``using`` declaration in your code. All examples will assume a
All library headers are included like so::
- #include <botan/botan.h>
+ #include <botan/auto_rng.h>
Initializing the Library
----------------------------------------
diff --git a/doc/fpe.rst b/doc/fpe.rst
index 776189d4f..a2005e158 100644
--- a/doc/fpe.rst
+++ b/doc/fpe.rst
@@ -54,5 +54,4 @@ This example encrypts a credit card number with a valid
`Luhn checksum <http://en.wikipedia.org/wiki/Luhn_algorithm>`_ to
another number with the same format, including a correct checksum.
-.. literalinclude:: examples/fpe.cpp
-
+.. literalinclude:: ../src/apps/fpe.cpp
diff --git a/doc/passhash.rst b/doc/passhash.rst
index b40ac3d3f..a398369b5 100644
--- a/doc/passhash.rst
+++ b/doc/passhash.rst
@@ -97,7 +97,7 @@ outputs that look like this::
Here is an example of using bcrypt:
-.. literalinclude:: examples/bcrypt.cpp
+.. literalinclude:: ../src/apps/bcrypt.cpp
.. _passhash9:
diff --git a/doc/pubkey.rst b/doc/pubkey.rst
index 6e6bc6ed8..5fdcafc8d 100644
--- a/doc/pubkey.rst
+++ b/doc/pubkey.rst
@@ -93,15 +93,7 @@ into a pair of key files. One is the public key in X.509 format (PEM encoded),
the private key is in PKCS #8 format (also PEM encoded), either encrypted or
unencrypted depending on if a password was given.
-.. literalinclude:: examples/rsa_kgen.cpp
-
-Generate DSA keys
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-This example generates a 2048 bit DSA key
-
-.. literalinclude:: examples/dsa_kgen.cpp
-
+.. literalinclude:: ../src/apps/keygen.cpp
.. _serializing_private_keys:
@@ -489,11 +481,11 @@ Signatures are verified using
Here is an example of DSA signature generation
-.. literalinclude:: examples/dsa_sign.cpp
+.. literalinclude:: ../src/apps/dsa_sign.cpp
Here is an example that verifies DSA signatures
-.. literalinclude:: examples/dsa_ver.cpp
+.. literalinclude:: ../src/apps/dsa_ver.cpp
Key Agreement
---------------------------------
@@ -535,7 +527,3 @@ key agreement algorithm. It returns a ``secure_vector<byte>``.
in new applications. The X9.42 algorithm may be useful in some
circumstances, but unless you need X9.42 compatibility, KDF2 is easier
to use.
-
-An example of using Diffie-Hellman:
-
-.. literalinclude:: examples/dh.cpp
diff --git a/doc/python.rst b/doc/python.rst
index 32ffe3878..734d2c6f4 100644
--- a/doc/python.rst
+++ b/doc/python.rst
@@ -12,10 +12,10 @@ Python Binding
Botan includes a binding for Python, implemented using Boost.Python.
As you can see, it is not currently documented, though there are a few
-examples under `examples/python`, such as RSA
+examples under `src/scripts/examples`, such as RSA:
-.. literalinclude:: examples/python/rsa.py
+.. literalinclude:: ../src/scripts/examples/rsa.py
and EAX encryption using a passphrase:
-.. literalinclude:: examples/python/cipher.py
+.. literalinclude:: ../src/scripts/examples/cipher.py
diff --git a/doc/relnotes/index.rst b/doc/relnotes/index.rst
index 193bc39dd..9cc15689d 100644
--- a/doc/relnotes/index.rst
+++ b/doc/relnotes/index.rst
@@ -8,6 +8,7 @@ Series 1.11
.. toctree::
:maxdepth: 1
+ 1_11_7
1_11_6
1_11_5
1_11_4
diff --git a/doc/tls.rst b/doc/tls.rst
index c31a27ca0..f0de4320b 100644
--- a/doc/tls.rst
+++ b/doc/tls.rst
@@ -259,7 +259,7 @@ TLS Clients
A simple TLS client example:
-.. literalinclude:: examples/tls_client.cpp
+.. literalinclude:: ../src/apps/tls_client.cpp
TLS Servers
----------------------------------------
@@ -294,7 +294,7 @@ protocols the server is willing to advertise it supports.
A TLS server that can handle concurrent connections using asio:
-.. literalinclude:: examples/asio_tls_server.cpp
+.. literalinclude:: ../src/apps/tls_server_asio.cpp
.. _tls_sessions:
diff --git a/doc/x509.rst b/doc/x509.rst
index 48fe5637e..422912db3 100644
--- a/doc/x509.rst
+++ b/doc/x509.rst
@@ -277,7 +277,7 @@ new certificate:
Here's an example:
-.. literalinclude examples/ca.cpp
+.. literalinclude ../src/apps/ca.cpp
Generating CRLs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -344,7 +344,7 @@ protocols. The library provides a utility function for this:
An example:
-.. literalinclude:: examples/self_sig.cpp
+.. literalinclude:: ../src/apps/self_sig.cpp
Creating PKCS #10 Requests
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -363,7 +363,7 @@ certificate.
An example:
-.. literalinclude:: examples/pkcs10.cpp
+.. literalinclude:: ../src/apps/pkcs10.cpp
Certificate Options
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^