Merge branch 'master' into dev-sizet

[libucw.git] / ucw / doc / basecode.txt

diff --git a/ucw/doc/basecode.txt b/ucw/doc/basecode.txt
index 94b4102eee13025248bc2a2771b7f2a7cb103891..d4e307e48cb9f88b35f6f7b89f547a982fdf49b1 100644 (file)
--- a/ucw/doc/basecode.txt
+++ b/ucw/doc/basecode.txt
@@ -3,7 +3,8 @@ Base64 and Base224 encodings
 
 These modules can be used to encode and decode data to and from
 base64 (described in RFC 3548) and base224 (not described in any
 
 These modules can be used to encode and decode data to and from
 base64 (described in RFC 3548) and base224 (not described in any

-standard, uses all non-control characters of ASCII).
+standard, uses all non-control characters, briefly described in
+a comment at the beginning of `ucw/base224.c`).

 
 - <<base64,Base64>>
 - <<base224,Base224>>
 
 - <<base64,Base64>>
 - <<base224,Base224>>


@@ -28,7 +29,7 @@ Usage
   output buffer and feed the data to the function.
 
   byte output[BASE64_ENC_LENGTH(input_size)];
   output buffer and feed the data to the function.
 
   byte output[BASE64_ENC_LENGTH(input_size)];

-  uns output_size = base64_encode(output, input, input_size);
+  uint output_size = base64_encode(output, input, input_size);

 
 - Decoding can be done in similar way. It is enough to have output
   buffer of the same size as the input one.
 
 - Decoding can be done in similar way. It is enough to have output
   buffer of the same size as the input one.


@@ -37,11 +38,11 @@ Usage
   chunks. The input chunk size must be multiple of `BASE64_IN_CHUNK`.
   The output will be corresponding multiple of `BASE64_OUT_CHUNK`.
 
   chunks. The input chunk size must be multiple of `BASE64_IN_CHUNK`.
   The output will be corresponding multiple of `BASE64_OUT_CHUNK`.
 

-  uns input_size;
+  uint input_size;

   byte input[BASE64_IN_CHUNK * 10];
   while(input_size = read_chunk(input, BASE64_IN_CHUNK * 10)) {
     byte output[BASE64_OUT_CHUNK * 10];
   byte input[BASE64_IN_CHUNK * 10];
   while(input_size = read_chunk(input, BASE64_IN_CHUNK * 10)) {
     byte output[BASE64_OUT_CHUNK * 10];

-    uns output_size = base64_encode(output, input, input_size);
+    uint output_size = base64_encode(output, input, input_size);

     use_chunk(output, output_size);
   }
 
     use_chunk(output, output_size);
   }
 


@@ -57,7 +58,7 @@ way as base64.
 The basecode utility
 --------------------
 You can use the encoding/decoding routines from command line, trough
 The basecode utility
 --------------------
 You can use the encoding/decoding routines from command line, trough

-`basecode` command. You have to specify the operation by a command
+`ucw-basecode` command. You have to specify the operation by a command

 line argument and give it the data on standard input. The arguments
 are:
 
 line argument and give it the data on standard input. The arguments
 are: