diff options
| author | Nakidai <nakidai@disroot.org> | 2024-12-14 18:38:43 +0300 |
|---|---|---|
| committer | Nakidai <nakidai@disroot.org> | 2024-12-14 18:38:43 +0300 |
| commit | efca9fa1b6deb6ac2767c782a3bfcec639ed9fc0 (patch) | |
| tree | 5c2c50c33665717733a1fde3e5beaae775275bf8 /man | |
| parent | 442bd0c92977b75c1fe712b271de0de13e6a604e (diff) | |
| download | libhttpc-efca9fa1b6deb6ac2767c782a3bfcec639ed9fc0.tar.gz libhttpc-efca9fa1b6deb6ac2767c782a3bfcec639ed9fc0.zip | |
Fix mans owO
Diffstat (limited to 'man')
| -rw-r--r-- | man/libhttpc-alloc.3 | 4 | ||||
| -rw-r--r-- | man/libhttpc.3 | 3 | ||||
| -rw-r--r-- | man/libhttpc_dumpheader.3 | 10 | ||||
| -rw-r--r-- | man/libhttpc_dumpmethod.3 | 10 | ||||
| -rw-r--r-- | man/libhttpc_dumpresponse.3 | 30 | ||||
| -rw-r--r-- | man/libhttpc_dumpstatus.3 | 4 | ||||
| -rw-r--r-- | man/libhttpc_loadheader.3 | 10 | ||||
| -rw-r--r-- | man/libhttpc_loadmethod.3 | 10 | ||||
| -rw-r--r-- | man/libhttpc_loadrequest.3 | 26 | ||||
| -rw-r--r-- | man/libhttpc_request.3 | 4 | ||||
| -rw-r--r-- | man/libhttpc_request_.3 | 20 |
11 files changed, 68 insertions, 63 deletions
diff --git a/man/libhttpc-alloc.3 b/man/libhttpc-alloc.3 index 4fed7e4..1a3f897 100644 --- a/man/libhttpc-alloc.3 +++ b/man/libhttpc-alloc.3 @@ -1,4 +1,4 @@ -.Dd December 13, 2024 +.Dd December 14, 2024 .Dt LIBHTTPC-ALLOC 3 .Os . @@ -25,7 +25,7 @@ for setting own malloc implementation. Set them using -.Ql LibHTTPC +.Xr libhttpc 3 . . .Sh SEE ALSO .Xr libhttpc 3 diff --git a/man/libhttpc.3 b/man/libhttpc.3 index 243e7b3..4c79fae 100644 --- a/man/libhttpc.3 +++ b/man/libhttpc.3 @@ -1,4 +1,4 @@ -.Dd December 13, 2024 +.Dd December 14, 2024 .Dt LIBHTTPC 3 .Os . @@ -43,7 +43,6 @@ then you need to call .Fn LibHTTPC at first. -.Xr . .Sh SEE ALSO .Xr libhttpc-alloc 3 , diff --git a/man/libhttpc_dumpheader.3 b/man/libhttpc_dumpheader.3 index f048976..cf4cdb2 100644 --- a/man/libhttpc_dumpheader.3 +++ b/man/libhttpc_dumpheader.3 @@ -1,4 +1,4 @@ -.Dd December 13, 2024 +.Dd December 14, 2024 .Dt LIBHTTPC_DUMPHEADER 3 .Os . @@ -14,14 +14,14 @@ to string .Fn LibHTTPC_dumpHeader "enum LibHTTPC_HeaderType header" . .Sh DESCRIPTION -.Nm +.Fn LibHTTPC_dumpHeader converts -.Ql enum LibHTTPC_HeaderType +.Vt enum LibHTTPC_HeaderType to -.Ql const char * . +.Vt const char * . To view all available headers, -check +read .Xr libhttpc_headertype 3 . . .Sh SEE ALSO diff --git a/man/libhttpc_dumpmethod.3 b/man/libhttpc_dumpmethod.3 index 9a71524..87f9115 100644 --- a/man/libhttpc_dumpmethod.3 +++ b/man/libhttpc_dumpmethod.3 @@ -1,4 +1,4 @@ -.Dd December 13, 2024 +.Dd December 14, 2024 .Dt LIBHTTPC_DUMPMETHOD 3 .Os . @@ -14,14 +14,14 @@ to string .Fn LibHTTPC_dumpMethod "enum LibHTTPC_Method header" . .Sh DESCRIPTION -.Nm +.Fn LibHTTPC_dumpMethod converts -.Ql enum LibHTTPC_Method +.Ft enum LibHTTPC_Method to -.Ql const char * . +.Ft const char * . To view all available methods, -check +read .Xr libhttpc_method 3 . . .Sh SEE ALSO diff --git a/man/libhttpc_dumpresponse.3 b/man/libhttpc_dumpresponse.3 index f9b53e1..81074ec 100644 --- a/man/libhttpc_dumpresponse.3 +++ b/man/libhttpc_dumpresponse.3 @@ -1,4 +1,4 @@ -.Dd December 13, 2024 +.Dd December 14, 2024 .Dt LIBHTTPC_DUMPRESPONSE 3 .Os . @@ -23,46 +23,46 @@ .Fc . .Sh DESCRIPTION -.Nm +.Fn LibHTTPC_dumpResponse combines contents of -.Ql response +.Fa response in the -.Ql buf . +.Fa buf . . .Pp -.Nm LibHTTPC_writeResponse -function writes -.Ql response +.Fn LibHTTPC_writeResponse +writes the +.Fa response to the -.Ql sockfd . +.Fa sockfd . . .Pp Both functions can autocomplete responses. If -.Ql version +.Fa response->version is -.Ql NULL , +.Dv NULL , then it will be set to .Ql "HTTP/1.1" . If -.Ql status +.Fa response->status is 0, then it will be set to 200. If -.Ql phrase +.Fa response->phrase is -.Ql NULL , +.Dv NULL , then it will be set to -.Ql LibHTTPC_dumpStatus(status) . +.Fn LibHTTPC_dumpStatus status . . .Sh RETURN VALUES -.Nm LibHTTPC_writeResponse +.Fn LibHTTPC_writeResponse will return 1 if cannot send response. diff --git a/man/libhttpc_dumpstatus.3 b/man/libhttpc_dumpstatus.3 index 2651ec8..b9c2a18 100644 --- a/man/libhttpc_dumpstatus.3 +++ b/man/libhttpc_dumpstatus.3 @@ -1,4 +1,4 @@ -.Dd December 13, 2024 +.Dd December 14, 2024 .Dt LIBHTTPC_DUMPSTATUS 3 .Os . @@ -13,7 +13,7 @@ to string .Fn LibHTTPC_dumpStatus "enum LibHTTPC_Status status" . .Sh DESCRIPTION -.Nm +.Fn LibHTTPC_dumpStatus returns usually used phrase diff --git a/man/libhttpc_loadheader.3 b/man/libhttpc_loadheader.3 index 8516834..8d8e97b 100644 --- a/man/libhttpc_loadheader.3 +++ b/man/libhttpc_loadheader.3 @@ -1,4 +1,4 @@ -.Dd December 13, 2024 +.Dd December 14, 2024 .Dt LIBHTTPC_LOADHEADER 3 .Os . @@ -14,14 +14,14 @@ string to .Fn LibHTTPC_loadHeader "const char *header" . .Sh DESCRIPTION -.Nm +.Fn LibHTTPC_loadHeader converts -.Ql const char * . +.Vt const char * . to -.Ql enum LibHTTPC_HeaderType +.Vt enum LibHTTPC_HeaderType To view all available headers, -check +read .Xr libhttpc_headertype 3 . . .Sh SEE ALSO diff --git a/man/libhttpc_loadmethod.3 b/man/libhttpc_loadmethod.3 index 9b25aa4..817c419 100644 --- a/man/libhttpc_loadmethod.3 +++ b/man/libhttpc_loadmethod.3 @@ -1,4 +1,4 @@ -.Dd December 13, 2024 +.Dd December 14, 2024 .Dt LIBHTTPC_LOADMETHOD 3 .Os . @@ -14,14 +14,14 @@ string to .Fn LibHTTPC_loadMethod "const char *header" . .Sh DESCRIPTION -.Nm +.Fn LibHTTPC_loadMethod converts -.Ql const char * . +.Vt const char * . to -.Ql enum LibHTTPC_Method +.Vt enum LibHTTPC_Method To view all available methods, -check +read .Xr libhttpc_method 3 . . .Sh SEE ALSO diff --git a/man/libhttpc_loadrequest.3 b/man/libhttpc_loadrequest.3 index d93a78a..affac5c 100644 --- a/man/libhttpc_loadrequest.3 +++ b/man/libhttpc_loadrequest.3 @@ -1,4 +1,4 @@ -.Dd December 13, 2024 +.Dd December 14, 2024 .Dt LIBHTTPC_LOADREQUEST 3 .Os . @@ -15,34 +15,34 @@ .Fc . .Sh DESCRIPTION -.Nm +.Fn LibHTTPC_loadRequest parses .Ql buf -and fills a -.Ql struct LibHTTPC_Request . +and fills +.Fa request_buf . If -.Ql request_buf +.Fa request_buf argument is -.Ql NULL , +.Dv NULL , then functon will allocate buffer itself. . .Sh RETURN VALUES -.Nm +.Fn LibHTTPC_loadRequest returns pointer to -.Ql request_buf +.Fa request_buf on success, or -.Ql NULL +.Dv NULL on error. . .Pp If -.Nm +.Fn LibHTTPC_loadRequest returned -.Ql NULL , +.Dv NULL , it could mean either: .Bl -bullet @@ -79,7 +79,7 @@ for more information. .An Nakidai Perumenei Aq Mt nakidai@disroot.org . .Sh CAVEATS -.Nm +.Fn LibHTTPC_loadRequest function will destroy the buffer while working. @@ -87,4 +87,4 @@ It sets 0 char on the end of every string in -.Ql struct LibHTTPC_Request . +.Fa request_buf . diff --git a/man/libhttpc_request.3 b/man/libhttpc_request.3 index 61c27cb..17b6f0b 100644 --- a/man/libhttpc_request.3 +++ b/man/libhttpc_request.3 @@ -1,4 +1,4 @@ -.Dd December 13, 2024 +.Dd December 14, 2024 .Dt LIBHTTPC_REQUEST 3 .Os . @@ -60,7 +60,7 @@ array Set by the .Xr libhttpc_loadrequest 3 function if -.Ql NULL +.Dv NULL was passed to request_buf argument. Used by diff --git a/man/libhttpc_request_.3 b/man/libhttpc_request_.3 index b1558f4..9005081 100644 --- a/man/libhttpc_request_.3 +++ b/man/libhttpc_request_.3 @@ -1,4 +1,4 @@ -.Dd December 13, 2024 +.Dd December 14, 2024 .Dt LIBHTTPC_REQUEST_ 3 .Os . @@ -17,16 +17,22 @@ destructor .Fc . .Sh DESCRIPTION -.Nm +.Fn LibHTTPC_Request_ is a destructor of .Xr libhttpc_request 3 . -It frees array -if header_selfalloc is set, -and then frees structure -if selfalloc is set. +It frees +.Fa request->headers +if +.Fa request->header_selfalloc +is set, +and then frees +.Fa request +if +.Fa request->selfalloc +is set. . .Sh RETURN VALUES -.Nm +.Fn LibHTTPC_Request_ returns either -1 if user hadn't set |