1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
|
.\" (C) 2002 Ian Gulliver
.TH libfirestring 3 2002-03-31
.SH NAME
libfirestring \- library for safe, fast string handling
.SH SYNOPSIS
.B #include <firestring.h>
.br
.B -lfirestring
.SH DESCRIPTION
libfirestring is a string handling library that provides
maximum length aware string handling functions to programs.
Several functions provide saner interfaces than the standard
libc functions. libfirestring also provides functions that
are in most libc's but not provided for by ANSI C, enabling
programmers to write ANSI C-compliant code while using such
safe functions (strcasecmp, strncasecmp, snprintf).
libfirestring provides a set of functions for dealing with
EStrings. EStrings are binary-safe objects that, when used
with the firestring functions, are overflow safe, because
they include allocated memory size information with them.
libfirestring also includes functions for dealing with
reading configuration files in an easy to program fashion.
.HP
Miscellaneous functions:
.br
.BR firestring_malloc (3)
.br
.BR firestring_realloc (3)
.HP
Starting-letter keys (for String and EString functions):
.br
.I n
Length-safe (takes a
.B size
argument)
.br
.I e
EString (length-safe and binary-safe, takes a
.B struct firestring_estr_t
argument)
.br
.I i
Case-insensitive
.br
.I a
Automatically expands EString to correct size
(possible memory DoS attack in some cases)
.br
.I s
Writes into a provided instead of to a stream
.br
.I f
Writes into a specified stream instead of to standard output
.HP
Base library functions:
.br
.BR firestring_set_error_handler (3)
.HP
String functions:
.br
.BR firestring_strdup (3)
.br
.BR firestring_strncpy (3)
.br
.BR firestring_strncat (3)
.br
.BR firestring_snprintf (3)
.br
.BR firestring_strncasecmp (3)
.br
.BR firestring_strcasecmp (3)
.br
.BR firestring_concat (3)
.br
.BR firestring_chomp (3)
.br
.BR firestring_chug (3)
.br
.BR firestring_trim (3)
.br
.BR firestring_hextoi (3)
.HP
EString functions:
.br
.BR firestring_estr_alloc (3)
.br
.BR firestring_estr_expand (3)
.br
.BR firestring_estr_free (3)
.br
.BR firestring_estr_read (3)
.br
.BR firestring_estr_sprintf (3)
.br
.BR firestring_estr_sprintfe (3)
.br
.BR firestring_estr_vsprintf (3)
.br
.BR firestring_estr_vsprintfe (3)
.br
.BR firestring_estr_printf (3)
.br
.BR firestring_estr_printfe (3)
.br
.BR firestring_estr_fprintf (3)
.br
.BR firestring_estr_fprintfe (3)
.br
.BR firestring_estr_vfprintf (3)
.br
.BR firestring_estr_vfprintfe (3)
.br
.BR firestring_estr_strchr (3)
.br
.BR firestring_estr_strstr (3)
.br
.BR firestring_estr_stristr (3)
.br
.BR firestring_estr_starts (3)
.br
.BR firestring_estr_estarts (3)
.br
.BR firestring_estr_ends (3)
.br
.BR firestring_estr_eends (3)
.br
.BR firestring_estr_strcasecmp (3)
.br
.BR firestring_estr_strcmp (3)
.br
.BR firestring_estr_strcpy (3)
.br
.BR firestring_estr_astrcpy(3)
.br
.BR firestring_estr_strcat (3)
.br
.BR firestring_estr_astrcat(3)
.br
.BR firestring_estr_estrcasecmp (3)
.br
.BR firestring_estr_estrncasecmp (3)
.br
.BR firestring_estr_estrcpy (3)
.br
.BR firestring_estr_aestrcpy (3)
.br
.BR firestring_estr_estrcat (3)
.br
.BR firestring_estr_aestrcat (3)
.br
.BR firestring_estr_estrstr (3)
.br
.BR firestring_estr_estristr (3)
.br
.BR firestring_estr_replace (3)
.br
.BR firestring_estr_areplace (3)
.br
.BR firestring_estr_toupper (3)
.br
.BR firestring_estr_tolower (3)
.br
.BR firestring_estr_munch (3)
.br
.BR firestring_estr_chomp (3)
.br
.BR firestring_estr_chug (3)
.br
.BR firestring_estr_trim (3)
.br
.BR firestring_estr_0 (3)
.br
.BR firestring_estr_base64_encode (3)
.br
.BR firestring_estr_base64_decode (3)
.br
.BR firestring_estr_xml_encode (3)
.br
.BR firestring_estr_xml_decode (3)
.HP
Configuration file functions:
.br
.BR firestring_conf_parse (3)
.br
.BR firestring_conf_add (3)
.br
.BR firestring_conf_find (3)
.br
.BR firestring_conf_find_next (3)
.br
.BR firestring_conf_free (3)
.SH FILES
/usr/local/include/firestring.h
.br
/usr/local/lib/libfirestring.so
.br
/usr/local/lib/libfirestring.a
.SH AUTHOR
Ian Gulliver <ian@penguinhosting.net>
|