libgcrypt/doc (ChangeLog gcrypt.texi)

cvs user wk cvs at cvs.gnupg.org
Tue Jan 4 21:42:36 CET 2005


    Date: Tuesday, January 4, 2005 @ 21:49:00
  Author: wk
    Path: /cvs/libgcrypt/libgcrypt/doc

Modified: ChangeLog gcrypt.texi

Updated to use @copying.  Fixed list of copyright
years; we had real changes in 2004.  Fixed some formatting issues.


-------------+
 ChangeLog   |    5 ++
 gcrypt.texi |  129 +++++++++++++++++++++-------------------------------------
 2 files changed, 53 insertions(+), 81 deletions(-)


Index: libgcrypt/doc/ChangeLog
diff -u libgcrypt/doc/ChangeLog:1.41 libgcrypt/doc/ChangeLog:1.42
--- libgcrypt/doc/ChangeLog:1.41	Tue Aug 24 22:22:46 2004
+++ libgcrypt/doc/ChangeLog	Tue Jan  4 21:49:00 2005
@@ -1,3 +1,8 @@
+2005-01-04  Werner Koch  <wk at g10code.com>
+
+	* gcrypt.texi: Updated to use @copying.  Fixed list of copyright
+	years; we had real changes in 2004.  Fixed some formatting issues.
+
 2004-08-24  Moritz Schulte  <moritz at g10code.com>
 
 	* gcrypt.texi (Miscellaneous): Document gcry_mpi_randomize.
Index: libgcrypt/doc/gcrypt.texi
diff -u libgcrypt/doc/gcrypt.texi:1.43 libgcrypt/doc/gcrypt.texi:1.44
--- libgcrypt/doc/gcrypt.texi:1.43	Tue Oct 12 12:13:53 2004
+++ libgcrypt/doc/gcrypt.texi	Tue Jan  4 21:49:00 2005
@@ -1,88 +1,64 @@
 \input texinfo                  @c -*- Texinfo -*-
- at c Copyright (C) 2000, 2002, 2003 Free Software Foundation, Inc.
- at c 
- at c This file is part of the Libgcrypt.
- at c
- at c Permission is granted to copy, distribute and/or modify this document
- at c under the terms of the GNU General Public License as published by the
- at c Free Software Foundation; either version 2 of the License, or (at your
- at c option) any later version. A copy of the license is included in the 
- at c file 'gpl.texi'.
- at c
+ at c %**start of header
 @setfilename gcrypt.info
- at settitle The `Libgcrypt' Reference Manual
-
- at dircategory GNU Libraries
- at direntry
-* libgcrypt: (gcrypt) Cryptographic function library.
- at end direntry
-
 @include version.texi
-
+ at settitle The Libgcrypt Reference Manual
 @c Unify some of the indices.
 @syncodeindex tp fn
 @syncodeindex pg fn
+ at c %**end of header
+ at copying
+This manual is for Libgcrypt
+(version @value{VERSION}, @value{UPDATED}),
+which is GNU's library of cryptographic building blocks.
 
- at ifinfo
-This file documents the `Libgcrypt' library.
-
-This is Edition @value{EDITION}, last updated @value{UPDATED}, of
- at cite{The `Libgcrypt' Reference Manual}, for Version
- at value{VERSION}.
-
-Copyright @copyright{} 2000, 2002, 2003 Free Software Foundation, Inc.
+Copyright @copyright{} 2000, 2002, 2003, 2004 Free Software Foundation, Inc.
 
+ at quotation
 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU General Public License as published by the
 Free Software Foundation; either version 2 of the License, or (at your
 option) any later version. The text of the license can be found in the
 section entitled ``Copying''.
- at end ifinfo
+ at end quotation
+ at end copying
 
- at c @iftex
- at c @shorttitlepage The `Libgcrypt' Reference Manual
- at c @end iftex
+ at dircategory GNU Libraries
+ at direntry
+* libgcrypt: (gcrypt) Cryptographic function library.
+ at end direntry
+
+
+
+ at c
+ at c Titlepage
+ at c
+ at setchapternewpage odd
 @titlepage
- at center @titlefont{The `Libgcrypt'}
- at sp 1
- at center @titlefont{Reference Manual}
- at sp 6
- at center Edition @value{EDITION}
- at sp 1
- at center last updated @value{UPDATED}
- at sp 1
- at center for version @value{VERSION}
+ at title The Libgcrypt Reference Manual
+ at subtitle Version @value{VERSION}
+ at subtitle @value{UPDATED}
+ at author Werner Koch (@email{wk@@gnupg.org})
+ at author Moritz Schulte (@email{mo@@g10code.com})
+
 @page
 @vskip 0pt plus 1filll
-Copyright @copyright{} 2000, 2002, 2003 Free Software Foundation, Inc.
-
-Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU General Public License as published by the
-Free Software Foundation; either version 2 of the License, or (at your
-option) any later version. The text of the license can be found in the
-section entitled ``Copying''.
+ at insertcopying
 @end titlepage
+
+
 @summarycontents
 @contents
 @page
 
+
 @ifnottex
 @node Top
- at top Main Menu
-This is Edition @value{EDITION}, last updated @value{UPDATED}, of
- at cite{The `Libgcrypt' Reference Manual}, for Version
- at value{VERSION} of the @acronym{Libgcrypt} library.
-
-Copyright @copyright{} 2000, 2002, 2003 Free Software Foundation, Inc.
-
-Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU General Public License as published by the
-Free Software Foundation; either version 2 of the License, or (at your
-option) any later version. The text of the license can be found in the
-section entitled ``Copying''.
-
+ at top The Libgcrypt Library
+ at insertcopying
 @end ifnottex
 
+
 @menu
 * Introduction::                 What is @acronym{Libgcrypt}.
 * Preparation::                  What you should do before using the library.
@@ -208,6 +184,7 @@
 interface (API).  All functions and data types provided by the library
 are explained.
 
+ at noindent
 The reader is assumed to possess basic knowledge about applied
 cryptography.
 
@@ -224,7 +201,6 @@
 @node Features
 @section Features
 
- at noindent
 `Libgcrypt' might have a couple of advantages over other libraries doing
 a similar job.
 
@@ -243,7 +219,6 @@
 
 @end table
 
-
 @node Overview
 @section Overview
 
@@ -1278,8 +1253,7 @@
 To use a cipher algorithm, you must first allocate an according
 handle.  This is to be done using the open function:
 
- at deftypefun gcry_error_t gcry_cipher_open (gcry_cipher_hd_t *@var{hd},
-int @var{algo}, int @var{mode}, unsigned int @var{flags})
+ at deftypefun gcry_error_t gcry_cipher_open (gcry_cipher_hd_t *@var{hd}, int @var{algo}, int @var{mode}, unsigned int @var{flags})
 
 This function creates the context handle required for most of the
 other cipher functions and returns a handle to it in `hd'.  In case of
@@ -1754,8 +1728,7 @@
 If the flag @code{GCRY_MD_FLAG_HMAC} was used, the key for the MAC must
 be set using the function:
 
- at deftypefun gcry_error_t gcry_md_setkey (gcry_md_hd_t @var{h}, const void *@var{key},
-size_t @var{keylen})
+ at deftypefun gcry_error_t gcry_md_setkey (gcry_md_hd_t @var{h}, const void *@var{key}, size_t @var{keylen})
 
 For use with the HMAC feature, set the MAC key to the value of @var{key}
 of length @var{keylen}.
@@ -2756,8 +2729,7 @@
 Destroys the data set @var{data}.
 @end deftypefun
 
- at deftypefun gcry_error_t gcry_ac_data_set (gcry_ac_data_t @var{data},
-unsigned int @var{flags}, char *@var{name}, gcry_mpi_t @var{mpi})
+ at deftypefun gcry_error_t gcry_ac_data_set (gcry_ac_data_t @var{data}, unsigned int @var{flags}, char *@var{name}, gcry_mpi_t @var{mpi})
 Add the value @var{mpi} to @var{data} with the label @var{name}.  If
 @var{flags} contains GCRY_AC_FLAG_DATA_COPY, the data set will contain
 copies of @var{name} and @var{mpi}.  If @var{flags} contains
@@ -2775,16 +2747,13 @@
 @var{data}.
 @end deftypefun
 
- at deftypefun gcry_error_t gcry_ac_data_get_name (gcry_ac_data_t @var{data},
-unsigned int @var{flags}, char *@var{name}, gcry_mpi_t *@var{mpi})
+ at deftypefun gcry_error_t gcry_ac_data_get_name (gcry_ac_data_t @var{data}, unsigned int @var{flags}, char *@var{name}, gcry_mpi_t *@var{mpi})
 Store the value labelled with @var{name} found in @var{data} in
 @var{mpi}.  If @var{flags} contains GCRY_AC_FLAG_COPY, store a copy of
 the @var{mpi} value contained in the data set.  @var{mpi} may be NULL.
 @end deftypefun
 
- at deftypefun gcry_error_t gcry_ac_data_get_index (gcry_ac_data_t @var{data},
-unsigned int flags, unsigned int @var{index},
-const char **@var{name}, gcry_mpi_t *@var{mpi})
+ at deftypefun gcry_error_t gcry_ac_data_get_index (gcry_ac_data_t @var{data}, unsigned int flags, unsigned int @var{index}, const char **@var{name}, gcry_mpi_t *@var{mpi})
 Stores in @var{name} and @var{mpi} the named @var{mpi} value contained
 in the data set @var{data} with the index @var{idx}.  If @var{flags}
 contains GCRY_AC_FLAG_COPY, store copies of the values contained in
@@ -2801,8 +2770,7 @@
 In order to use an algorithm, an according handle must be created.
 This is done using the following function:
 
- at deftypefun gcry_error_t gcry_ac_open (gcry_ac_handle_t *@var{handle},
-int @var{algorithm}, int @var{flags})
+ at deftypefun gcry_error_t gcry_ac_open (gcry_ac_handle_t *@var{handle}, int @var{algorithm}, int @var{flags})
 
 Creates a new handle for the algorithm @var{algorithm} and stores it
 in @var{handle}.  @var{flags} is not used yet.
@@ -2850,9 +2818,7 @@
 contained in the data set @var{data} and stores it in @var{key}.
 @end deftypefun
 
- at deftypefun gcry_error_t gcry_ac_key_pair_generate (gcry_ac_handle_t @var{handle},
-unsigned int @var{nbits}, void *@var{key_spec}, gcry_ac_key_pair_t *@var{key_pair},
-gcry_mpi_t **@var{misc_data})
+ at deftypefun gcry_error_t gcry_ac_key_pair_generate (gcry_ac_handle_t @var{handle}, unsigned int @var{nbits}, void *@var{key_spec}, gcry_ac_key_pair_t *@var{key_pair}, gcry_mpi_t **@var{misc_data})
 
 Generates a new key pair via the handle @var{handle} of @var{NBITS}
 bits and stores it in @var{key_pair}.
@@ -2925,13 +2891,11 @@
 Verifies that the private key @var{key} is sane via @var{handle}.
 @end deftypefun
 
- at deftypefun gcry_error_t gcry_ac_key_get_nbits (gcry_ac_handle_t @var{handle},
-gcry_ac_key_t @var{key}, unsigned int *@var{nbits})
+ at deftypefun gcry_error_t gcry_ac_key_get_nbits (gcry_ac_handle_t @var{handle}, gcry_ac_key_t @var{key}, unsigned int *@var{nbits})
 Stores the number of bits of the key @var{key} in @var{nbits} via @var{handle}.
 @end deftypefun
 
- at deftypefun gcry_error_t gcry_ac_key_get_grip (gcry_ac_handle_t @var{handle},
-gcry_ac_key_t @var{key}, unsigned char *@var{key_grip})
+ at deftypefun gcry_error_t gcry_ac_key_get_grip (gcry_ac_handle_t @var{handle}, gcry_ac_key_t @var{key}, unsigned char *@var{key_grip})
 Writes the 20 byte long key grip of the key @var{key} to
 @var{key_grip} via @var{handle}.
 @end deftypefun
@@ -3787,3 +3751,6 @@
 
 @c  LocalWords:  int HD
 
+
+
+




More information about the Gnupg-commits mailing list