Browse Source

update man pages

master
Felix von Leitner 4 years ago
parent
commit
297abe28c7
  1. 2
      textcode/scan_base64.3
  2. 2
      textcode/scan_base64url.3
  3. 2
      textcode/scan_cescape.3
  4. 2
      textcode/scan_hexdump.3
  5. 2
      textcode/scan_jsonescape.3
  6. 6
      textcode/scan_ldapescape.3
  7. 2
      textcode/scan_urlencoded.3
  8. 2
      textcode/scan_urlencoded2.3
  9. 2
      textcode/scan_uuencoded.3

2
textcode/scan_base64.3

@ -20,7 +20,7 @@ Many base64 variants demand padding in the last block. Some don't. This
implementation will consume padding if it is there, but will not
complain if it is not.
dest can be NULL. destlen can be NULL.
dest can be NULL. destlen can be NULL. dest can be src.
.SH "RETURN VALUE"
scan_base64 returns the number of bytes successfully scanned and

2
textcode/scan_base64url.3

@ -20,7 +20,7 @@ Many base64 variants demand padding in the last block. Some don't. This
implementation will consume padding if it is there, but will not
complain if it is not.
dest can be NULL. destlen can be NULL.
dest can be NULL. destlen can be NULL. dest can be src.
.SH "RETURN VALUE"
scan_base64url returns the number of bytes successfully scanned and

2
textcode/scan_cescape.3

@ -18,7 +18,7 @@ supported and lead to UTF-8 sequences being output.
scan_cescape will then write the number of bytes in dest into *destlen,
and return the number of bytes decoded from src.
dest can be NULL. destlen can be NULL.
dest can be NULL. destlen can be NULL. dest can be src.
To make sure dest is large enough, either allocate strlen(src)+1 bytes
or call scan_cescape twice, the first time with dest == NULL (*destlen

2
textcode/scan_hexdump.3

@ -16,7 +16,7 @@ Note that real world hexdump data is sometimes permitted to
contain whitespace characters or new lines. This function will not allow
those and return the decoded data until then.
dest can be NULL. destlen can be NULL.
dest can be NULL. destlen can be NULL. dest can be src.
.SH "RETURN VALUE"
scan_hexdump returns the number of bytes successfully scanned and

2
textcode/scan_jsonescape.3

@ -14,7 +14,7 @@ characters or a double quote that was not escaped.
It will then write the number of bytes in dest into *destlen,
and return the number of bytes decoded from src.
dest can be NULL. destlen can be NULL.
dest can be NULL. destlen can be NULL. dest can be src.
To make sure dest is large enough, either allocate strlen(src)+1 bytes
or call scan_jsonescape twice, the first time with dest == NULL (*destlen

6
textcode/scan_ldapescape.3

@ -16,11 +16,9 @@ equivalent, i.e. \0a to new-line and \5c to backslash.
scan_cescape will then write the number of bytes in dest into *destlen,
and return the number of bytes decoded from src.
dest can be NULL. destlen can be NULL.
dest can be NULL. destlen can be NULL. dest can be src.
To make sure dest is large enough, either allocate strlen(src)+1 bytes
or call scan_ldapescape twice, the first time with dest == NULL (*destlen
will still be written).
The decoded data need at most as much space as the encoded data used.
.SH "RETURN VALUE"
scan_ldapescape returns the number of bytes successfully parsed

2
textcode/scan_urlencoded.3

@ -19,7 +19,7 @@ In "http://example.com/a+b?c+d", only the second plus can be decoded
as a space character. If you want + decoded to space, use
scan_urlencoded2.
dest can be NULL. destlen can be NULL.
dest can be NULL. destlen can be NULL. dest can be src.
.SH "RETURN VALUE"
scan_urlencoded returns the number of bytes successfully scanned and

2
textcode/scan_urlencoded2.3

@ -11,7 +11,7 @@ scan_urlencoded2 behaves like scan_urlencoded, but decodes '+' to ' '.
See scan_urlencoded(3) for details.
dest can be NULL. destlen can be NULL.
dest can be NULL. destlen can be NULL. dest can be src.
.SH "RETURN VALUE"
scan_urlencoded2 returns the number of bytes successfully scanned and

2
textcode/scan_uuencoded.3

@ -23,7 +23,7 @@ input, and it will decode all the bytes in it.
uuencoded data can contain bytes from 0x21 to 0x96, which means it is
not "string safe" (can contain single and double quotes and backslash).
dest can be NULL. destlen can be NULL.
dest can be NULL. destlen can be NULL. dest can be src.
.SH "RETURN VALUE"
scan_uuencoded returns the number of bytes successfully scanned and

Loading…
Cancel
Save