Update build for OpenSSL-0.9.8j upgrade.
[dragonfly.git] / secure / lib / libcrypto / man / des.3
index 01e60ca..bc0e07d 100644 (file)
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
+.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
 .\"
 .\" Standard preamble:
 .\" ========================================================================
 ..
 .\" Set up some character translations and predefined strings.  \*(-- will
 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote.  | will give a
-.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
-.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
-.\" expand to `' in nroff, nothing in troff, for use with C<>.
-.tr \(*W-|\(bv\*(Tr
+.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
+.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 .ie n \{\
 .    ds -- \(*W-
 .    ds R" ''
 'br\}
 .\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\"
 .\" If the F register is turned on, we'll generate index entries on stderr for
 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
 .\" entries marked with X<> in POD.  Of course, you'll have to process the
 .\" output yourself in some meaningful fashion.
-.if \nF \{\
+.ie \nF \{\
 .    de IX
 .    tm Index:\\$1\t\\n%\t"\\$2"
 ..
 .    nr % 0
 .    rr F
 .\}
-.\"
-.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
-.\" way too many mistakes in technical documents.
-.hy 0
-.if n .na
+.el \{\
+.    de IX
+..
+.\}
 .\"
 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
 .\" ========================================================================
 .\"
 .IX Title "des 3"
-.TH des 3 "2006-11-19" "0.9.8d" "OpenSSL"
+.TH des 3 "2009-01-11" "0.9.8j" "OpenSSL"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
 .SH "NAME"
 DES_random_key, DES_set_key, DES_key_sched, DES_set_key_checked,
 DES_set_key_unchecked, DES_set_odd_parity, DES_is_weak_key,
@@ -144,27 +151,19 @@ DES_fcrypt, DES_crypt, DES_enc_read, DES_enc_write \- DES encryption
 .IX Header "SYNOPSIS"
 .Vb 1
 \& #include <openssl/des.h>
-.Ve
-.PP
-.Vb 1
+\&
 \& void DES_random_key(DES_cblock *ret);
-.Ve
-.PP
-.Vb 6
+\&
 \& int DES_set_key(const_DES_cblock *key, DES_key_schedule *schedule);
 \& int DES_key_sched(const_DES_cblock *key, DES_key_schedule *schedule);
 \& int DES_set_key_checked(const_DES_cblock *key,
 \&        DES_key_schedule *schedule);
 \& void DES_set_key_unchecked(const_DES_cblock *key,
 \&        DES_key_schedule *schedule);
-.Ve
-.PP
-.Vb 2
+\&
 \& void DES_set_odd_parity(DES_cblock *key);
 \& int DES_is_weak_key(const_DES_cblock *key);
-.Ve
-.PP
-.Vb 7
+\&
 \& void DES_ecb_encrypt(const_DES_cblock *input, DES_cblock *output, 
 \&        DES_key_schedule *ks, int enc);
 \& void DES_ecb2_encrypt(const_DES_cblock *input, DES_cblock *output, 
@@ -172,9 +171,7 @@ DES_fcrypt, DES_crypt, DES_enc_read, DES_enc_write \- DES encryption
 \& void DES_ecb3_encrypt(const_DES_cblock *input, DES_cblock *output, 
 \&        DES_key_schedule *ks1, DES_key_schedule *ks2, 
 \&        DES_key_schedule *ks3, int enc);
-.Ve
-.PP
-.Vb 18
+\&
 \& void DES_ncbc_encrypt(const unsigned char *input, unsigned char *output, 
 \&        long length, DES_key_schedule *schedule, DES_cblock *ivec, 
 \&        int enc);
@@ -193,15 +190,11 @@ DES_fcrypt, DES_crypt, DES_enc_read, DES_enc_write \- DES encryption
 \& void DES_ofb64_encrypt(const unsigned char *in, unsigned char *out,
 \&        long length, DES_key_schedule *schedule, DES_cblock *ivec,
 \&        int *num);
-.Ve
-.PP
-.Vb 3
+\&
 \& void DES_xcbc_encrypt(const unsigned char *input, unsigned char *output, 
 \&        long length, DES_key_schedule *schedule, DES_cblock *ivec, 
 \&        const_DES_cblock *inw, const_DES_cblock *outw, int enc);
-.Ve
-.PP
-.Vb 9
+\&
 \& void DES_ede2_cbc_encrypt(const unsigned char *input,
 \&        unsigned char *output, long length, DES_key_schedule *ks1,
 \&        DES_key_schedule *ks2, DES_cblock *ivec, int enc);
@@ -211,9 +204,7 @@ DES_fcrypt, DES_crypt, DES_enc_read, DES_enc_write \- DES encryption
 \& void DES_ede2_ofb64_encrypt(const unsigned char *in,
 \&        unsigned char *out, long length, DES_key_schedule *ks1,
 \&        DES_key_schedule *ks2, DES_cblock *ivec, int *num);
-.Ve
-.PP
-.Vb 15
+\&
 \& void DES_ede3_cbc_encrypt(const unsigned char *input,
 \&        unsigned char *output, long length, DES_key_schedule *ks1,
 \&        DES_key_schedule *ks2, DES_key_schedule *ks3, DES_cblock *ivec,
@@ -229,9 +220,7 @@ DES_fcrypt, DES_crypt, DES_enc_read, DES_enc_write \- DES encryption
 \&        long length, DES_key_schedule *ks1, 
 \&        DES_key_schedule *ks2, DES_key_schedule *ks3, 
 \&        DES_cblock *ivec, int *num);
-.Ve
-.PP
-.Vb 8
+\&
 \& DES_LONG DES_cbc_cksum(const unsigned char *input, DES_cblock *output, 
 \&        long length, DES_key_schedule *schedule, 
 \&        const_DES_cblock *ivec);
@@ -240,14 +229,10 @@ DES_fcrypt, DES_crypt, DES_enc_read, DES_enc_write \- DES encryption
 \& void DES_string_to_key(const char *str, DES_cblock *key);
 \& void DES_string_to_2keys(const char *str, DES_cblock *key1,
 \&        DES_cblock *key2);
-.Ve
-.PP
-.Vb 2
+\&
 \& char *DES_fcrypt(const char *buf, const char *salt, char *ret);
 \& char *DES_crypt(const char *buf, const char *salt);
-.Ve
-.PP
-.Vb 4
+\&
 \& int DES_enc_read(int fd, void *buf, int len, DES_key_schedule *sched,
 \&        DES_cblock *iv);
 \& int DES_enc_write(int fd, const void *buf, int len,
@@ -279,7 +264,7 @@ is returned.  If the key is a weak key, then \-2 is returned.  If an
 error is returned, the key schedule is not generated.
 .PP
 \&\fIDES_set_key()\fR works like
-\&\fIDES_set_key_checked()\fR if the \fIDES_check_key\fR flag is non\-zero,
+\&\fIDES_set_key_checked()\fR if the \fIDES_check_key\fR flag is non-zero,
 otherwise like \fIDES_set_key_unchecked()\fR.  These functions are available
 for compatibility; it is recommended to use a function that does not
 depend on a global variable.
@@ -316,7 +301,7 @@ The macro \fIDES_ecb2_encrypt()\fR is provided to perform two-key Triple-DES
 encryption by using \fIks1\fR for the final encryption.
 .PP
 \&\fIDES_ncbc_encrypt()\fR encrypts/decrypts using the \fIcipher-block-chaining\fR
-(\s-1CBC\s0) mode of \s-1DES\s0.  If the \fIencrypt\fR argument is non\-zero, the
+(\s-1CBC\s0) mode of \s-1DES\s0.  If the \fIencrypt\fR argument is non-zero, the
 routine cipher-block-chain encrypts the cleartext data pointed to by
 the \fIinput\fR argument into the ciphertext pointed to by the \fIoutput\fR
 argument, using the key schedule provided by the \fIschedule\fR argument,
@@ -373,7 +358,7 @@ suggested for use when sending small numbers of characters.
 Feed Back mode.
 .PP
 \&\fIDES_ede3_ofb64_encrypt()\fR and \fIDES_ede2_ofb64_encrypt()\fR is the same as
-\&\fIDES_ofb64_encrypt()\fR, using Triple\-DES.
+\&\fIDES_ofb64_encrypt()\fR, using Triple-DES.
 .PP
 The following functions are included in the \s-1DES\s0 library for
 compatibility with the \s-1MIT\s0 Kerberos library.
@@ -387,7 +372,7 @@ used by Kerberos v4.  Other applications should use
 \&\fIDES_quad_cksum()\fR is a Kerberos v4 function.  It returns a 4 byte
 checksum from the input bytes.  The algorithm can be iterated over the
 input, depending on \fIout_count\fR, 1, 2, 3 or 4 times.  If \fIoutput\fR is
-non\-NULL, the 8 bytes generated by each pass are written into
+non-NULL, the 8 bytes generated by each pass are written into
 \&\fIoutput\fR.
 .PP
 The following are DES-based transformations: