diff options
| author | Joseph Hunkeler <jhunkeler@gmail.com> | 2021-05-13 01:30:43 -0400 |
|---|---|---|
| committer | Joseph Hunkeler <jhunkeler@gmail.com> | 2021-05-13 01:30:43 -0400 |
| commit | 6cdf18373905d12c776263fa0287126e3b0a9553 (patch) | |
| tree | 8a6cf1ee56e4e3e617b8e0340c176d2a6c28e387 /docs/man/cleanpath_read.3 | |
| parent | 89511934b805999e0c12071750c52c1c45d35536 (diff) | |
| download | cleanpath-6cdf18373905d12c776263fa0287126e3b0a9553.tar.gz | |
Add API docs
Diffstat (limited to 'docs/man/cleanpath_read.3')
| -rw-r--r-- | docs/man/cleanpath_read.3 | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/man/cleanpath_read.3 b/docs/man/cleanpath_read.3 new file mode 100644 index 0000000..cefb649 --- /dev/null +++ b/docs/man/cleanpath_read.3 @@ -0,0 +1,24 @@ +.TH "CLEANPATH_READ" "3" "" "" "API" +.SH NAME +cleanpath_read \- Obtain filtered path string +.SH SYNOPSIS +\f[B]#include <cleanpath/cleanpath.h>\f[R] +.PP +\f[B]void cleanpath_read(struct CleanPath *\f[I]path\f[B])\f[R] +.PP +.SH DESCRIPTION +Combine elements not filtered by \f[B]cleanpath_filter(3)\f[R] +.PP +.SH RETURNS +a pointer a filtered path string +.PP +(must be freed by caller) +.PP +.SH CONFORMING TO +C99 +.PP +.SH SEE ALSO +\f[B]cleanpath_init(3)\f[R], +\f[B]cleanpath_filter(3)\f[R], +\f[B]cleanpath_free(3)\f[R] +.PP |