ksgi

1
.\"	$Id$
2
.\"
3
.\" Copyright (c) 2014, 2017, 2020 Kristaps Dzonsons <kristaps@bsd.lv>
4
.\" Copyright (c) 2017 Ingo Schwarze <schwarze@openbsd.org>
5
.\"
6
.\" Permission to use, copy, modify, and distribute this software for any
7
.\" purpose with or without fee is hereby granted, provided that the above
8
.\" copyright notice and this permission notice appear in all copies.
9
.\"
10
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17
.\"
18
.Dd $Mdocdate$
19
.Dt KHTTP_URLENCODE 3
20
.Os
21
.Sh NAME
22
.Nm khttp_urlencode
23
.Nd URL encoding for kcgi
24
.Sh LIBRARY
25
.Lb libkcgi
26
.Sh SYNOPSIS
27
.In sys/types.h
28
.In stdarg.h
29
.In stdint.h
30
.In kcgi.h
31
.Ft "char *"
32
.Fo khttp_urlencode
33
.Fa "const char *cp"
34
.Fc
35
.Sh DESCRIPTION
36
Percent-encodes a string
37
.Fa cp ,
38
usually for embedding in a URL, and returns the allocated result.
39
If passed a
40
.Dv NULL ,
41
returns an allocated empty string.
42
.Pp
43
The encoding uses capital-letter hex encoding.
44
.Sh RETURN VALUES
45
Returns a newly-allocated string that must be freed with
46
.Xr free 3
47
or
48
.Dv NULL
49
if allocation fails.
50
.Pp
51
The deprecated form of this function,
52
.Fn kutil_urlencode ,
53
should no longer be used.
54
.Sh EXAMPLES
55
The following table shows strings pre- and post-encoding.
56
.Pp
57
.TS
58
l l.
59
foo bar	foo+bar
60
foo+bar	foo%2Bbar
61
.TE
62
.Sh AUTHORS
63
Written by
64
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
65