aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/man/cleanpath.12
-rw-r--r--docs/man/cleanpath_filter.330
-rw-r--r--docs/man/cleanpath_free.322
-rw-r--r--docs/man/cleanpath_init.341
-rw-r--r--docs/man/cleanpath_read.324
5 files changed, 117 insertions, 2 deletions
diff --git a/docs/man/cleanpath.1 b/docs/man/cleanpath.1
index 89f6fe0..ba3db63 100644
--- a/docs/man/cleanpath.1
+++ b/docs/man/cleanpath.1
@@ -1,5 +1,3 @@
-.\" Automatically generated by Pandoc 2.13
-.\"
.TH "CLEANPATH" "1" "" "" "Utility"
.hy
.SH NAME
diff --git a/docs/man/cleanpath_filter.3 b/docs/man/cleanpath_filter.3
new file mode 100644
index 0000000..696f683
--- /dev/null
+++ b/docs/man/cleanpath_filter.3
@@ -0,0 +1,30 @@
+.TH "CLEANPATH_FILTER" "3" "" "" "API"
+.SH NAME
+cleanpath_filter \- Remove paths from a \f[B]CleanPath\f[R] structure
+.SH SYNOPSIS
+\f[B]#include <cleanpath/cleanpath.h>\f[R]
+.PP
+\f[B]void cleanpath_filter(struct CleanPath *\f[I]path\f[B], unsigned \f[I]mode\f[B], const char *\f[I]pattern\f[B])\f[R]
+.SS MODE FLAGS
+.PP
+\f[B]CLEANPATH_FILTER_EXACT\f[R] \- Match pattern exactly
+.PP
+\f[B]CLEANPATH_FILTER_LOOSE\f[R] \- Match pattern as substring
+.PP
+\f[B]CLEANPATH_FILTER_REGEX\f[R] \- Use (Extended) Regular Expressions
+
+.PP
+.SH DESCRIPTION
+Filter elements in \f[I]path->part\f[R] array by \f[I]pattern\f[R]
+.PP
+.SH RETURNS
+N/A
+.PP
+.SH CONFORMING TO
+C99
+.PP
+.SH SEE ALSO
+\f[B]cleanpath_init(3)\f[R],
+\f[B]cleanpath_read(3)\f[R],
+\f[B]cleanpath_free(3)\f[R]
+.PP
diff --git a/docs/man/cleanpath_free.3 b/docs/man/cleanpath_free.3
new file mode 100644
index 0000000..39d2f04
--- /dev/null
+++ b/docs/man/cleanpath_free.3
@@ -0,0 +1,22 @@
+.TH "CLEANPATH_FREE" "3" "" "" "API"
+.SH NAME
+cleanpath_free
+.SH SYNOPSIS
+\f[B]#include <cleanpath/cleanpath.h>\f[R]
+.PP
+\f[B]void cleanpath_free(struct CleanPath *\f[I]path\f[B])\f[R]
+.PP
+.SH DESCRIPTION
+free a CleanPath pointer
+.PP
+.SH RETURNS
+N/A
+.PP
+.SH CONFORMING TO
+C99
+.PP
+.SH SEE ALSO
+\f[B]cleanpath_init(3)\f[R],
+\f[B]cleanpath_read(3)\f[R],
+\f[B]cleanpath_free(3)\f[R]
+.PP
diff --git a/docs/man/cleanpath_init.3 b/docs/man/cleanpath_init.3
new file mode 100644
index 0000000..fb65e30
--- /dev/null
+++ b/docs/man/cleanpath_init.3
@@ -0,0 +1,41 @@
+.TH "CLEANPATH_INIT" "3" "" "" "API"
+.SH NAME
+cleanpath_init \- Initialize a CleanPath structure
+.SH SYNOPSIS
+\f[B]#include <cleanpath/cleanpath.h>\f[R]
+.PP
+\f[B]struct CleanPath\f[R] {
+ // Pointer to the path string
+ \f[B]char *\f[I]data\f[R];
+
+ // Length of the path string
+ \f[B]size_t \f[I]data_len\f[R];
+
+ // Pointer to the separator used to split the data string
+ \f[B]char *\f[I]sep\f[R];
+
+ // Array of pointers to path elements
+ \f[B]char *\f[I]part[CLEANPATH_PART_MAX]\f[R];
+
+ // Total number of elements in part array
+ \f[B]size_t \f[I]part_nelem\f[R];
+
+};
+\f[R]
+.PP
+\f[B]struct CleanPath *cleanpath_init(const char *\f[I]path\f[B], const char *\f[I]sep\f[B])\f[R]
+.PP
+.SH DESCRIPTION
+Split string \f[I]path\f[R] into parts by string \f[I]sep\f[R]
+.PP
+.SH RETURN VALUE
+function returns a pointer to a \f[B]CleanPath\f[R] structure
+.PP
+.SH CONFORMING TO
+C99
+.PP
+.SH SEE ALSO
+\f[B]cleanpath_filter(3)\f[R],
+\f[B]cleanpath_read(3)\f[R],
+\f[B]cleanpath_free(3)\f[R]
+.PP
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