--- val.pod 2002/01/16 14:09:18 1.3
+++ val.pod 2002/01/16 20:47:56 1.4
@@ -36,13 +36,125 @@
=head1 SYNOPSIS
+=over 4
+
+=item B<Constants>
+
+C<VAL_MAXNAME>,
+C<VAL_TYPE_VAL>,
+C<VAL_TYPE_PTR>,
+C<VAL_TYPE_CHAR>,
+C<VAL_TYPE_SHORT>,
+C<VAL_TYPE_INT>,
+C<VAL_TYPE_LONG>,
+C<VAL_TYPE_FLOAT>,
+C<VAL_TYPE_DOUBLE>
+C<VAL_OK>,
+C<VAL_ERR_ARG>,
+C<VAL_ERR_USE>,
+C<VAL_ERR_MEM>,
+C<VAL_ERR_HSH>,
+C<VAL_ERR_INT>,
+C<VAL_ERR_SYS>.
+
+=item B<Data Types>
+
+C<val_t>,
+C<val_cb_t>,
+C<val_rc_t>.
+
+=item B<Functions>
+
+C<val_create>,
+C<val_destroy>,
+C<val_reg>,
+C<val_query>,
+C<val_set>,
+C<val_get>,
+C<val_vset>,
+C<val_vget>,
+C<val_apply>.
+
+=back
+
=head1 DESCRIPTION
-B<OSSP val> is ...
+B<OSSP val> is a flexible name to value mapping library for C variables.
+It allows one to access C variables through name strings, although
+the C language does neither provide such a dedicated facility nor an
+evaluation construct (which could be used to implement such a facility
+easily). In general, it is interesting whenevery you need access to C
+variable symbols without having to know the actual address/reference.
+The typical use cases are in combination with flexible configuration
+parsing and supporting loosly-coupled DSO-based module architectures.
+
+=head1 API CONSTANTS
+
+=over 4
+
+=item C<VAL_MAXNAME>
+
+=item C<VAL_TYPE_>I<ID>
+
+C<VAL_TYPE_VAL>,
+C<VAL_TYPE_PTR>,
+C<VAL_TYPE_CHAR>,
+C<VAL_TYPE_SHORT>,
+C<VAL_TYPE_INT>,
+C<VAL_TYPE_LONG>,
+C<VAL_TYPE_FLOAT>,
+C<VAL_TYPE_DOUBLE>
+
+=item C<VAL_OK>, C<VAL_ERR_>I<ID>
+
+C<VAL_ERR_ARG>,
+C<VAL_ERR_USE>,
+C<VAL_ERR_MEM>,
+C<VAL_ERR_HSH>,
+C<VAL_ERR_INT>,
+C<VAL_ERR_SYS>.
+
+=back
+
+=head1 API DATA TYPES
+
+=over 4
+
+=item C<val_t>
+
+=item C<val_cb_t>
+
+=item C<val_rc_t>
+
+=back
+
+=head1 API FUNCTIONS
+
+=over 4
+
+=item val_rc_t B<val_create>(val_t **I<pval>);
+
+=item val_rc_t B<val_destroy>(val_t *I<val>);
+
+=item val_rc_t B<val_reg>(val_t *I<val>, const char *I<name>, int I<type>, const char *I<desc>, void *I<storage>);
+
+=item val_rc_t B<val_query>(val_t *I<val>, const char *I<name>, int *I<ptype>, char **I<pdesc>, void **I<pstorage>);
+
+=item val_rc_t B<val_set>(val_t *I<val>, const char *I<name>, ...);
+
+=item val_rc_t B<val_get>(val_t *I<val>, const char *I<name>, ...);
+
+=item val_rc_t B<val_vset>(val_t *I<val>, const char *I<name>, va_list I<ap>);
+
+=item val_rc_t B<val_vget>(val_t *I<val>, const char *I<name>, va_list I<ap>);
+
+=item val_rc_t B<val_apply>(val_t *I<val>, const char *I<name>, int I<depth>, val_cb_t I<cb>, void *I<ctx>);
+
+=back
=head1 SEE ALSO
-...
+OSSP var.
=head1 HISTORY
|
