diff options
author | Simon Warta <[email protected]> | 2015-12-11 23:48:45 +0100 |
---|---|---|
committer | Simon Warta <[email protected]> | 2015-12-11 23:48:45 +0100 |
commit | 3e33c69a962f03a8ad97f9978df35fe704c26434 (patch) | |
tree | 0dcd2d883b53a53291797603f58e3ea6a2e8a4f5 | |
parent | 3e87697f03b5e3258c6ff9af0be11face0f57ce0 (diff) |
Replace path src/cmd/ by new src/cli/ in documentation
Closes #356.
[ci skip]
-rw-r--r-- | doc/manual/fpe.rst | 3 | ||||
-rw-r--r-- | doc/manual/passhash.rst | 3 | ||||
-rw-r--r-- | doc/manual/pubkey.rst | 7 | ||||
-rw-r--r-- | doc/manual/tls.rst | 6 | ||||
-rw-r--r-- | doc/manual/x509.rst | 7 |
5 files changed, 10 insertions, 16 deletions
diff --git a/doc/manual/fpe.rst b/doc/manual/fpe.rst index 9fbb27f7c..3eed7f4ce 100644 --- a/doc/manual/fpe.rst +++ b/doc/manual/fpe.rst @@ -1,4 +1,3 @@ - Format Preserving Encryption ======================================== @@ -54,4 +53,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:: ../../src/cmd/fpe.cpp +.. literalinclude:: ../../src/cli/fpe.cpp diff --git a/doc/manual/passhash.rst b/doc/manual/passhash.rst index 0d6721ddf..6d4dd22a0 100644 --- a/doc/manual/passhash.rst +++ b/doc/manual/passhash.rst @@ -1,4 +1,3 @@ - Password Hashing ======================================== @@ -97,7 +96,7 @@ outputs that look like this:: Here is an example of using bcrypt: -.. literalinclude:: ../../src/cmd/bcrypt.cpp +.. literalinclude:: ../../src/cli/bcrypt.cpp .. _passhash9: diff --git a/doc/manual/pubkey.rst b/doc/manual/pubkey.rst index 1b3ed305a..dc8645404 100644 --- a/doc/manual/pubkey.rst +++ b/doc/manual/pubkey.rst @@ -1,4 +1,3 @@ - Public Key Cryptography ================================= @@ -93,7 +92,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:: ../../src/cmd/keygen.cpp +.. literalinclude:: ../../src/cli/keygen.cpp .. _serializing_private_keys: @@ -481,11 +480,11 @@ Signatures are verified using Here is an example of DSA signature generation -.. literalinclude:: ../../src/cmd/dsa_sign.cpp +.. literalinclude:: ../../src/cli/dsa_sign.cpp Here is an example that verifies DSA signatures -.. literalinclude:: ../../src/cmd/dsa_ver.cpp +.. literalinclude:: ../../src/cli/dsa_ver.cpp Key Agreement --------------------------------- diff --git a/doc/manual/tls.rst b/doc/manual/tls.rst index 1926d5c08..5f96816a8 100644 --- a/doc/manual/tls.rst +++ b/doc/manual/tls.rst @@ -1,4 +1,3 @@ - Transport Layer Security (TLS) ======================================== @@ -278,7 +277,7 @@ TLS Clients resized as needed to process inputs). Otherwise some reasonable default is used. -Code for a TLS client using BSD sockets is in `src/cmd/tls_client.cpp` +Code for a TLS client using BSD sockets is in `src/cli/tls_client.cpp` TLS Servers ---------------------------------------- @@ -315,7 +314,7 @@ server; unlike clients, which know what type of protocol (TLS vs DTLS) they are negotiating from the start via the *offer_version*, servers would not until they actually received a hello without this parameter. -Code for a TLS server using asio is in `src/cmd/tls_proxy.cpp`. +Code for a TLS server using asio is in `src/cli/tls_proxy.cpp`. .. _tls_sessions: @@ -777,4 +776,3 @@ The ``TLS::Protocol_Version`` class represents a specific version: Returns the latest version of the DTLS protocol known to the library (currently DTLS v1.2) - diff --git a/doc/manual/x509.rst b/doc/manual/x509.rst index 84263ae3d..25f4a375d 100644 --- a/doc/manual/x509.rst +++ b/doc/manual/x509.rst @@ -1,4 +1,3 @@ - .. _x509_certificates: X.509 Certificates and CRLs @@ -349,7 +348,7 @@ new certificate: Here's an example: -.. literalinclude ../../src/cmd/ca.cpp +.. literalinclude ../../src/cli/ca.cpp Generating CRLs ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -416,7 +415,7 @@ protocols. The library provides a utility function for this: An example: -.. literalinclude:: ../../src/cmd/self_sig.cpp +.. literalinclude:: ../../src/cli/self_sig.cpp Creating PKCS #10 Requests ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -435,7 +434,7 @@ certificate. An example: -.. literalinclude:: ../../src/cmd/pkcs10.cpp +.. literalinclude:: ../../src/cli/pkcs10.cpp Certificate Options ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |