summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@gnutls.org>2011-08-20 23:57:41 +0200
committerNikos Mavrogiannopoulos <nmav@gnutls.org>2011-08-20 23:57:41 +0200
commit75c2c252204d55758de8dda5d27c80927be73ea0 (patch)
tree58a090980af04cec00a8dcd84f2bf8d08d06f0d2
parentf87eb04507cb399740ae1f66a4f1f13ffa2d9832 (diff)
downloadgnutls-75c2c252204d55758de8dda5d27c80927be73ea0.tar.gz
Use texinfo's word break.gnutls_3_0_1
-rw-r--r--doc/cha-cert-auth.texi28
-rw-r--r--doc/cha-internals.texi32
-rw-r--r--doc/cha-intro-tls.texi4
-rw-r--r--doc/cha-library.texi4
-rwxr-xr-xdoc/scripts/mytexi2latex1
5 files changed, 36 insertions, 33 deletions
diff --git a/doc/cha-cert-auth.texi b/doc/cha-cert-auth.texi
index cce8acc97f..c1c0ddf2d0 100644
--- a/doc/cha-cert-auth.texi
+++ b/doc/cha-cert-auth.texi
@@ -156,7 +156,7 @@ provided.
The verification function will verify a given certificate chain against a list of certificate
authorities and certificate revocation lists, and output
-a bit-wise OR of elements of the @code{gnutls_\-certificate_\-status_t}
+a bit-wise OR of elements of the @code{gnutls_@-certificate_@-status_t}
enumeration.
A detailed description of these elements can be found
in @ref{tab:cert-verify}. An example of certificate verification is shown in @ref{ex:verify2}.
@@ -218,42 +218,42 @@ flags are part of the enumeration
@multitable @columnfractions .5 .5
@headitem Flag @tab Description
-@item GNUTLS_VERIFY_\-DISABLE_CA_SIGN @tab
+@item GNUTLS_VERIFY_@-DISABLE_CA_SIGN @tab
If set a signer does not have to be a certificate authority. This
flag should normally be disabled, unless you know what this means.
-@item GNUTLS_VERIFY_\-ALLOW_X509_V1_CA_CRT @tab
+@item GNUTLS_VERIFY_@-ALLOW_X509_V1_CA_CRT @tab
Allow only trusted CA certificates that have version 1. This is
-safer than GNUTLS_VERIFY_\-ALLOW_ANY_X509_V1_CA_CRT, and should be
+safer than GNUTLS_VERIFY_@-ALLOW_ANY_X509_V1_CA_CRT, and should be
used instead. That way only signers in your trusted list will be
allowed to have certificates of version 1. This is the default.
-@item GNUTLS_VERIFY_\-DO_NOT_ALLOW_X509_V1_CA_CRT @tab
+@item GNUTLS_VERIFY_@-DO_NOT_ALLOW_X509_V1_CA_CRT @tab
Do not allow trusted version 1 CA certificates. This option is to be used
in order consider all V1 certificates as deprecated.
-@item GNUTLS_VERIFY_\-ALLOW_ANY_X509_V1_CA_CRT @tab
+@item GNUTLS_VERIFY_@-ALLOW_ANY_X509_V1_CA_CRT @tab
Allow CA certificates that have version 1 (both root and
intermediate). This is dangerous since those haven't the
basicConstraints extension. Must be used in combination with
-GNUTLS_VERIFY_\-ALLOW_X509_V1_CA_CRT.
+GNUTLS_VERIFY_@-ALLOW_X509_V1_CA_CRT.
-@item GNUTLS_VERIFY_\-DO_NOT_ALLOW_SAME @tab
+@item GNUTLS_VERIFY_@-DO_NOT_ALLOW_SAME @tab
If a certificate is not signed by anyone trusted but exists in
the trusted CA list do not treat it as trusted.
-@item GNUTLS_VERIFY_\-ALLOW_SIGN_RSA_MD2 @tab
+@item GNUTLS_VERIFY_@-ALLOW_SIGN_RSA_MD2 @tab
Allow certificates to be signed using the old MD2 algorithm.
-@item GNUTLS_VERIFY_\-ALLOW_SIGN_RSA_MD5 @tab
+@item GNUTLS_VERIFY_@-ALLOW_SIGN_RSA_MD5 @tab
Allow certificates to be signed using the broken MD5 algorithm.
-@item GNUTLS_VERIFY_\-DISABLE_TIME_CHECKS @tab
+@item GNUTLS_VERIFY_@-DISABLE_TIME_CHECKS @tab
Disable checking of activation
and expiration validity periods of certificate chains. Don't set
this unless you understand the security implications.
-@item GNUTLS_VERIFY_\-DISABLE_CRL_CHECKS @tab
+@item GNUTLS_VERIFY_@-DISABLE_CRL_CHECKS @tab
Disables checking for validity using certificate revocation lists.
@end multitable
@@ -574,9 +574,9 @@ private key.
With @acronym{GnuTLS} you can copy existing private keys and certificates
to a token. Note that when copying private keys it is recommended to mark
-them as sensitive using the @code{GNUTLS_\-PKCS11_OBJ_\-FLAG_\-MARK_\-SENSITIVE}
+them as sensitive using the @code{GNUTLS_@-PKCS11_OBJ_@-FLAG_@-MARK_@-SENSITIVE}
to prevent its extraction. An object can be marked as private using the flag
-@code{GNUTLS_\-PKCS11_OBJ_\-FLAG_\-MARK_\-PRIVATE}, to require PIN to be
+@code{GNUTLS_@-PKCS11_OBJ_@-FLAG_@-MARK_@-PRIVATE}, to require PIN to be
entered before accessing the object (for operations or otherwise).
@showfuncdesc{gnutls_pkcs11_delete_url}
diff --git a/doc/cha-internals.texi b/doc/cha-internals.texi
index c0380fc345..c442990d8b 100644
--- a/doc/cha-internals.texi
+++ b/doc/cha-internals.texi
@@ -101,10 +101,10 @@ such as certificates, usernames etc. to @code{auth_info_t} structures.
Simple examples of existing authentication methods can be seen in
-@code{auth/\-psk.c} for PSK ciphersuites and @code{auth/\-srp.c} for SRP
+@code{auth/@-psk.c} for PSK ciphersuites and @code{auth/@-srp.c} for SRP
ciphersuites. After implementing these functions the structure holding
-its pointers has to be registered in @code{gnutls_\-algorithms.c} in the
-@code{_gnutls_\-kx_\-algorithms} structure.
+its pointers has to be registered in @code{gnutls_@-algorithms.c} in the
+@code{_gnutls_@-kx_@-algorithms} structure.
@node TLS Extension Handling
@section TLS Extension Handling
@@ -123,7 +123,7 @@ and one for sending. These functions have to check internally whether
they operate in client or server side.
A simple example of an extension handler can be seen in
-@code{ext/\-srp.c} in GnuTLS' source code. After implementing these functions,
+@code{ext/@-srp.c} in GnuTLS' source code. After implementing these functions,
together with the extension number they handle, they have to be registered
using @funcintref{_gnutls_ext_register} in
@code{gnutls_extensions.c} typically within @funcintref{_gnutls_ext_init}.
@@ -192,7 +192,7 @@ A typical entry would be:
#endif
@end example
-Most likely you'll need to add an @code{#include "ext/\-foobar.h"}, that
+Most likely you'll need to add an @code{#include "ext/@-foobar.h"}, that
will contain something like
like:
@example
@@ -218,10 +218,12 @@ will be called to deinitialize the extension's private parameters, if any.
Note that the conditional @code{ENABLE_FOOBAR} definition should only be
used if step 1 with the @code{configure} options has taken place.
-@subsubsection Add new files @code{ext/\-foobar.c} and @code{ext/\-foobar.h} that implement the extension.
+@subsubsection Add new files that implement the extension.
The functions you are responsible to add are those mentioned in the
-previous step. As a starter, you could add this:
+previous step. They should be added in a file such as @code{ext/@-foobar.c}
+and headers should be placed in @code{ext/@-foobar.h}.
+As a starter, you could add this:
@example
int
@@ -259,15 +261,15 @@ The @funcintref{_foobar_send_params} function is responsible for
sending extension data (both in the client and server).
If you receive length fields that doesn't match, return
-@code{GNUTLS_E_\-UNEXPECTED_\-PACKET_\-LENGTH}. If you receive invalid
-data, return @code{GNUTLS_E_\-RECEIVED_\-ILLEGAL_\-PARAMETER}. You can use
+@code{GNUTLS_E_@-UNEXPECTED_@-PACKET_@-LENGTH}. If you receive invalid
+data, return @code{GNUTLS_E_@-RECEIVED_@-ILLEGAL_@-PARAMETER}. You can use
other error codes from the list in @ref{Error codes}. Return 0 on success.
An extension typically stores private information in the @code{session}
data for later usage. That can be done using the functions
@funcintref{_gnutls_ext_set_session_data} and
@funcintref{_gnutls_ext_get_session_data}. You can check simple examples
-at @code{ext/\-max_\-record.c} and @code{ext/\-server_\-name.c} extensions.
+at @code{ext/@-max_@-record.c} and @code{ext/@-server_@-name.c} extensions.
That private information can be saved and restored across session
resumption if the following functions are set:
@@ -308,7 +310,7 @@ _gnutls_foobar_send_params (gnutls_session_t session,
The functions used would be declared as @code{static} functions, of
the appropriate prototype, in the same file.
-When adding the files, you'll need to add them to @code{ext/\-Makefile.am}
+When adding the files, you'll need to add them to @code{ext/@-Makefile.am}
as well, for example:
@example
@@ -322,13 +324,13 @@ endif
It might be desirable to allow users of the extension to
request use of the extension, or set extension specific data.
This can be implemented by adding extension specific function calls
-that can be added to @code{includes/\-gnutls/\-gnutls.h},
+that can be added to @code{includes/@-gnutls/@-gnutls.h},
as long as the LGPLv3+ applies.
-The implementation of the function should lie in the @code{ext/\-foobar.c} file.
+The implementation of the function should lie in the @code{ext/@-foobar.c} file.
To make the API available in the shared library you need to add the
-symbol in @code{lib/\-libgnutls.map} or
-@code{libextra/\-libgnutls-\-extra.map} as appropriate, so that the symbol
+symbol in @code{lib/@-libgnutls.map} or
+@code{libextra/@-libgnutls-@-extra.map} as appropriate, so that the symbol
is exported properly.
When writing GTK-DOC style documentation for your new APIs, don't
diff --git a/doc/cha-intro-tls.texi b/doc/cha-intro-tls.texi
index 3cc7941deb..623ba07ffb 100644
--- a/doc/cha-intro-tls.texi
+++ b/doc/cha-intro-tls.texi
@@ -274,8 +274,8 @@ The alert protocol is there to allow signals to be sent between peers.
These signals are mostly used to inform the peer about the cause of a
protocol failure. Some of these signals are used internally by the
protocol and the application protocol does not have to cope with them
-(e.g. @code{GNUTLS_\-A_\-CLOSE_\-NOTIFY}), and others refer to the
-application protocol solely (e.g. @code{GNUTLS_\-A_\-USER_\-CANCELLED}). An
+(e.g. @code{GNUTLS_@-A_@-CLOSE_@-NOTIFY}), and others refer to the
+application protocol solely (e.g. @code{GNUTLS_@-A_@-USER_@-CANCELLED}). An
alert signal includes a level indication which may be either fatal or
warning. Fatal alerts always terminate the current connection, and
prevent future re-negotiations using the current session ID. All alert
diff --git a/doc/cha-library.texi b/doc/cha-library.texi
index c199439d49..2afaaa1916 100644
--- a/doc/cha-library.texi
+++ b/doc/cha-library.texi
@@ -116,10 +116,10 @@ to be taken. Thus negative error codes may be fatal or not.
Fatal errors terminate the connection immediately and further sends
and receives will be disallowed. Such an example is
-@code{GNUTLS_\-E_\-DECRYPTION_\-FAILED}. Non-fatal errors may warn about
+@code{GNUTLS_@-E_@-DECRYPTION_@-FAILED}. Non-fatal errors may warn about
something, i.e., a warning alert was received, or indicate the some
action has to be taken. This is the case with the error code
-@code{GNUTLS_\-E_\-REHANDSHAKE} returned by @funcref{gnutls_record_recv}.
+@code{GNUTLS_@-E_@-REHANDSHAKE} returned by @funcref{gnutls_record_recv}.
This error code indicates that the server requests a re-handshake. The
client may ignore this request, or may reply with an alert. You can
test if an error code is a fatal one by using the
diff --git a/doc/scripts/mytexi2latex b/doc/scripts/mytexi2latex
index 85ed327cd1..53f88de4bf 100755
--- a/doc/scripts/mytexi2latex
+++ b/doc/scripts/mytexi2latex
@@ -300,6 +300,7 @@ multitable:
$line =~ s/\~/\\~/g;
$line =~ s/\%(?!c)/\\%/g;
$line =~ s/\#/\\\#/g;
+ $line =~ s/\@-/\\-/g;
$line =~ s/\@verbatiminclude (.*)/\\examplefile{\.\.\/$1}/g;
$line =~ s/\@image\{($match+)\,($match+)\}/\\includegraphics\[width\=$2\]\{\.\.\/$1\.pdf\}/g;
$line =~ s/\@samp\{($spacematch+)\}/$1/g;